Bitmessage/PyBitmessage-2025-02-22
Archived
2
0
Fork 0
Code Issues 167 Pull Requests 54 Actions Packages Projects Releases 5 Wiki Activity

Changes based on style and lint checks. Some empty docstrings remain … #1370

Merged
coffeedogs merged 1 commits from final_code_quality_12 into v0.6 2018-10-31 18:04:00 +01:00
Conversation 36 Commits 1 Files Changed 7 +216 -122
coffeedogs commented 2018-10-10 14:01:34 +02:00 (Migrated from github.com)
Copy Link

…to be completed in the future. (final_code_quality_12)

Repository contributions to the PyBitmessage project

  • You can get paid for merged commits if you register at Tip4Commit

Code

  • Try to refer to github issue tracker or other permanent sources of discussion about the issue.
  • It is clear from the diff what you have done, it may be less clear why you have done it so explain why this change is necessary rather than what it does

Documentation

  • If there has been a change to the code, there's a good possibility there should be a corresponding change to the documentation
  • If you can't run fab build_docs successfully, ask for someone to run it against your branch

Tests

  • If there has been a change to the code, there's a good possibility there should be a corresponding change to the tests
  • If you can't run fab tests successfully, ask for someone to run it against your branch

Translations

  • For helping with translations, please use Transifex.
  • There is no need to submit pull requests for translations.
  • For translating technical terms it is recommended to consult the Microsoft Language Portal.

Gitiquette

  • Make the pull request against the "v0.6" branch
  • PGP-sign the commits included in the pull request
  • Use references to tickets, e.g. addresses #123 or fixes #234 in your commit messages
  • Try to use a good editor that removes trailing whitespace, highlights potential python issues and uses unix line endings
  • If for some reason you don't want to use github, you can submit the patch using Bitmessage to the "bitmessage" chan, or to one of the developers.
…to be completed in the future. (final_code_quality_12) ## Repository contributions to the PyBitmessage project - You can get paid for merged commits if you register at [Tip4Commit](https://tip4commit.com/github/Bitmessage/PyBitmessage) ### Code - Try to refer to github issue tracker or other permanent sources of discussion about the issue. - It is clear from the diff *what* you have done, it may be less clear *why* you have done it so explain why this change is necessary rather than what it does ### Documentation - If there has been a change to the code, there's a good possibility there should be a corresponding change to the documentation - If you can't run `fab build_docs` successfully, ask for someone to run it against your branch ### Tests - If there has been a change to the code, there's a good possibility there should be a corresponding change to the tests - If you can't run `fab tests` successfully, ask for someone to run it against your branch ## Translations - For helping with translations, please use [Transifex](https://www.transifex.com/bitmessage-project/pybitmessage/). - There is no need to submit pull requests for translations. - For translating technical terms it is recommended to consult the [Microsoft Language Portal](https://www.microsoft.com/Language/en-US/Default.aspx). ### Gitiquette - Make the pull request against the ["v0.6" branch](https://github.com/Bitmessage/PyBitmessage/tree/v0.6) - PGP-sign the commits included in the pull request - Use references to tickets, e.g. `addresses #123` or `fixes #234` in your commit messages - Try to use a good editor that removes trailing whitespace, highlights potential python issues and uses unix line endings - If for some reason you don't want to use github, you can submit the patch using Bitmessage to the "bitmessage" chan, or to one of the developers.
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:33:16 +02:00
src/addresses.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:33:16 +02:00 
    """Convert integer into varint bytes"""
```suggestion """Convert integer into varint bytes""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:34:00 +02:00
src/addresses.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:34:00 +02:00 
    """Exception class for decoding varint data"""
```suggestion """Exception class for decoding varint data""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:34:47 +02:00
src/addresses.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:34:47 +02:00 
    """Calculate inventory hash from object data"""
```suggestion """Calculate inventory hash from object data""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:37:11 +02:00
src/addresses.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:37:11 +02:00 
    """Convert ripe to address"""
```suggestion """Convert ripe to address""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:38:36 +02:00
src/addresses.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:38:36 +02:00 
    """Prepend BM- to an address if it doesn't already have it"""
```suggestion """Prepend BM- to an address if it doesn't already have it""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:44:35 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:44:35 +02:00 
    """Base address validation class for QT UI"""
```suggestion """Base address validation class for QT UI""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:45:58 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:45:57 +02:00 
        """Address validation callback, performs validation and gives feedback"""
```suggestion """Address validation callback, performs validation and gives feedback""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:48:00 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:48:00 +02:00 
    """QDialog with Bitmessage address validation"""
```suggestion """QDialog with Bitmessage address validation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:49:14 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:49:14 +02:00 
        """Callback for QDIalog accepting value"""
```suggestion """Callback for QDIalog accepting value""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:49:56 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:49:55 +02:00 
    """QDialog for adding a new address, with validation and translation"""
```suggestion """QDialog for adding a new address, with validation and translation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:51:52 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:51:52 +02:00 
    """QDialog for generating a new address, with translation"""
```suggestion """QDialog for generating a new address, with translation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:52:08 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:52:08 +02:00 
        """accept callback"""
```suggestion """accept callback""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:52:40 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:52:40 +02:00 
    """QDialog for subscribing to an address, with validation and translation"""
```suggestion """QDialog for subscribing to an address, with validation and translation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:53:19 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:53:19 +02:00 
    """QDialog for regenerating deterministic addresses, with translation"""
```suggestion """QDialog for regenerating deterministic addresses, with translation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 07:53:49 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 07:53:49 +02:00 
    """QDialog for special address behaviour (e.g. mailing list functionality), with translation"""
```suggestion """QDialog for special address behaviour (e.g. mailing list functionality), with translation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:12:28 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:12:28 +02:00 
        """Accept callback"""
```suggestion """Accept callback""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:12:38 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:12:38 +02:00

just 4

just 4
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:13:23 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:13:23 +02:00 
    """QDialog for email gateway control, with translation"""
```suggestion """QDialog for email gateway control, with translation""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:13:42 +02:00
src/bitmessageqt/address_dialogs.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:13:42 +02:00 
        """Accept callback"""
```suggestion """Accept callback""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:14:24 +02:00
src/class_smtpDeliver.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:14:24 +02:00 
    """SMTP client thread for delivery"""
```suggestion """SMTP client thread for delivery""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:16:19 +02:00
src/class_smtpDeliver.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:16:19 +02:00 
        """(probably) Singleton functionality"""
```suggestion """(probably) Singleton functionality""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:21:26 +02:00
src/pyelliptic/ecc.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:21:26 +02:00 
        """Encryption object from curve name"""
```suggestion """Encryption object from curve name""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:22:02 +02:00
src/pyelliptic/ecc.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:22:02 +02:00 
        """Currently used curve"""
```suggestion """Currently used curve""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:22:42 +02:00
src/pyelliptic/ecc.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:22:42 +02:00 
        """ECDH key as binary data"""
```suggestion """ECDH key as binary data""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:23:53 +02:00
src/pyelliptic/ecc.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:23:53 +02:00 
        """Check key validity, key is supplied as binary data"""
```suggestion """Check key validity, key is supplied as binary data""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:25:18 +02:00
src/pyelliptic/ecc.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:25:18 +02:00 
        """ECHD encryption, keys supplied in binary data format"""
```suggestion """ECHD encryption, keys supplied in binary data format""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:38:41 +02:00
src/randomtrackingdict.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:38:41 +02:00 
    """Dict with randomised order and tracking. Keeps a track of how many items have been requested from the dict, and timeouts. Resets after all objects have been retrieved and timed out. The main purpose of this isn't as much putting related code together as performance optimisation and anonymisation of downloading of objects from other peers. If done using a standard dict or array, it takes too much CPU (and looks convoluted). Randomisation helps with anonymity"""
```suggestion """Dict with randomised order and tracking. Keeps a track of how many items have been requested from the dict, and timeouts. Resets after all objects have been retrieved and timed out. The main purpose of this isn't as much putting related code together as performance optimisation and anonymisation of downloading of objects from other peers. If done using a standard dict or array, it takes too much CPU (and looks convoluted). Randomisation helps with anonymity""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:41:14 +02:00
src/randomtrackingdict.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:41:14 +02:00 
        """Sets maximum number of objects that can be retrieved from the class simultaneously as long as there is no timeout"""
```suggestion """Sets maximum number of objects that can be retrieved from the class simultaneously as long as there is no timeout""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:42:05 +02:00
src/randomtrackingdict.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:42:05 +02:00 
        """Sets how long to wait for a timeout if max pending is reached (or all objects have been retrieved)"""
```suggestion """Sets how long to wait for a timeout if max pending is reached (or all objects have been retrieved)""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:42:57 +02:00
src/randomtrackingdict.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:42:57 +02:00 
        """Retrieve count random keys from the dict that haven't already been retrieved"""
```suggestion """Retrieve count random keys from the dict that haven't already been retrieved""" ```
PeterSurda (Migrated from github.com) reviewed 2018-10-18 08:44:12 +02:00
src/randomtrackingdict.py
PeterSurda (Migrated from github.com) commented 2018-10-18 08:44:12 +02:00 
        """helper function for tests, generates a random string"""
```suggestion """helper function for tests, generates a random string""" ```
PeterSurda (Migrated from github.com) requested changes 2018-10-18 08:46:50 +02:00
PeterSurda (Migrated from github.com) left a comment

Why remove src/api_client.py, did you move it to a different directory in another PR? If not, probably there should be a directory examplesor something, and it should be there.
Other than the docstrings and the octal 4 ok.

Why remove `src/api_client.py`, did you move it to a different directory in another PR? If not, probably there should be a directory `examples`or something, and it should be there. Other than the docstrings and the octal 4 ok.
coffeedogs commented 2018-10-19 17:15:31 +02:00 (Migrated from github.com)
Copy Link

Not sure why I deleted src/api_client.py but I've restored it and moved it to /dev /examples

Not sure why I deleted src/api_client.py but I've restored it and moved it to ~~/dev~~ /examples
PeterSurda commented 2018-10-27 10:02:09 +02:00 (Migrated from github.com)
Copy Link

Check don't handle renaming of files, creating false negatives. I'll work on fixing it.

Check don't handle renaming of files, creating false negatives. I'll work on fixing it.
PeterSurda commented 2018-10-27 10:32:05 +02:00 (Migrated from github.com)
Copy Link

Renames are now handled correctly.

Renames are now handled correctly.
PeterSurda (Migrated from github.com) approved these changes 2018-10-27 12:26:22 +02:00
This repo is archived. You cannot comment on pull requests.
Reviewers
No Reviewers
PeterSurda
Labels
Clear labels
bug
Something isn't working as it's supposed to
build
Related to building or build system
dependencies
Pull requests that update a dependency file
developers
The issue is relevant mainly for developers rather than users
documentation
duplicate
enhancement
New feature
formatting
Code or UI text formatting
invalid
legal
mobile
Frontend for mobile devices (kivy)
obsolete
packaging
performance
protocol
Protocol change
question
refactoring
regression
Some issue, fixed in the past, appears again
security
test
translation
usability
wontfix
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
PeterSurda
No Assignees
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Bitmessage/PyBitmessage-2025-02-22#1370
No description provided.
Delete Branch "final_code_quality_12"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?