Sourcery refactored master branch #1

sourcery-ai · 2023-01-02T12:45:41Z

Branch master refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the master branch, then run:

git fetch origin sourcery/master
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sourcery-ai · 2023-01-02T12:45:43Z

btclib_node/__init__.py

-        if config.p2p_port:
-            self.p2p_port = config.p2p_port
-        else:
-            self.p2p_port = None
+        self.p2p_port = config.p2p_port or None
        peer_db = PeerDB(self.chain, self.data_dir)
        self.p2p_manager = P2pManager(self, self.p2p_port, peer_db)

-        if config.rpc_port:
-            self.rpc_port = config.rpc_port
-        else:
-            self.rpc_port = None
+        self.rpc_port = config.rpc_port or None


Function Node.__init__ refactored with the following changes:

Replace if statement with if expression [×2] (assign-if-exp)

Simplify if expression by using or [×2] (or-if-exp-identity)

sourcery-ai · 2023-01-02T12:45:43Z

btclib_node/chainstate.py

-                    if prevout:
-                        prevout = TxOut.parse(prevout, check_validity=False)
-                        prev_outputs.append(prevout)
-                        self.removed_utxos.add(prevout_bytes)
-                    else:
+                    if not prevout:
                        raise Exception

+                    prevout = TxOut.parse(prevout, check_validity=False)
+                    prev_outputs.append(prevout)
+                    self.removed_utxos.add(prevout_bytes)


Function Chainstate.add_block refactored with the following changes:

Swap if/else branches (swap-if-else-branches)

Remove unnecessary else after guard condition (remove-unnecessary-else)

sourcery-ai · 2023-01-02T12:45:43Z

btclib_node/chainstate.py

+            elif self.db.get(out_point_bytes):
+                self.removed_utxos.add(out_point_bytes)
            else:
-                if self.db.get(out_point_bytes):
-                    self.removed_utxos.add(out_point_bytes)
-                else:
-                    raise Exception
+                raise Exception


Function Chainstate.apply_rev_block refactored with the following changes:

Merge else clause's nested if statement into elif (merge-else-if-into-elif)

sourcery-ai · 2023-01-02T12:45:43Z

btclib_node/config.py

-            data_dir = Path(data_dir)
-        else:
-            data_dir = Path.home() / ".btclib"
+        data_dir = Path(data_dir) if data_dir else Path.home() / ".btclib"


Function Config.__init__ refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-01-02T12:45:43Z

btclib_node/download.py

-    if node.status >= NodeStatus.HeaderSynced:
+    if node.status < NodeStatus.HeaderSynced:
+        return
+    if not node.download_window:
+        node.download_window = node.index.get_download_candidates()
+    node.download_window = [
+        x
+        for x in node.download_window
+        if not node.index.get_block_info(x).downloaded
+    ]
+    if not node.download_window:
+        return

-        if not node.download_window:
-            node.download_window = node.index.get_download_candidates()
-        node.download_window = [
-            x
-            for x in node.download_window
-            if not node.index.get_block_info(x).downloaded
+    connections = list(node.p2p_manager.connections.values())
+    pending = []
+    exit = True
+    for conn in connections:
+        conn_queue = conn.block_download_queue
+        new_queue = [
+            header
+            for header in conn_queue
+            if not node.index.get_block_info(header).downloaded
        ]
-        if not node.download_window:
-            return
+        conn.block_download_queue = new_queue
+        pending.extend(new_queue)
+        if not new_queue:
+            exit = False
+    if exit:
+        return

-        connections = list(node.p2p_manager.connections.values())
-        pending = []
-        exit = True
-        for conn in connections:
-            conn_queue = conn.block_download_queue
-            new_queue = []
-            for header in conn_queue:
-                if not node.index.get_block_info(header).downloaded:
-                    new_queue.append(header)
-            conn.block_download_queue = new_queue
-            pending.extend(new_queue)
-            if not new_queue:
-                exit = False
-        if exit:
-            return
+    waiting = [header for header in node.download_window if header not in pending]
+    pending = [x[0] for x in Counter(pending).most_common()[::-1]]

-        waiting = [header for header in node.download_window if header not in pending]
-        pending = [x[0] for x in Counter(pending).most_common()[::-1]]
-
-        for conn in connections:
-            if conn.block_download_queue == []:
-                if waiting:
-                    new = waiting[:16]
-                    waiting = waiting[16:]
-                elif pending:
-                    new = pending[:4]
-                    pending = pending[4:]
-                else:
-                    return
-                conn.block_download_queue = new
-                conn.send(Getdata([(0x40000002, hash) for hash in new]))
+    for conn in connections:
+        if conn.block_download_queue == []:
+            if waiting:
+                new = waiting[:16]
+                waiting = waiting[16:]
+            elif pending:
+                new = pending[:4]
+                pending = pending[4:]
+            else:
+                return
+            conn.block_download_queue = new
+            conn.send(Getdata([(0x40000002, hash) for hash in new]))


Function block_download refactored with the following changes:

Add guard clause (last-if-guard)

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2023-01-02T12:45:45Z

btclib_node/p2p/callbacks.py

-    transactions = [x[1] for x in inv.inventory if x[0] == 1 or x[0] == 0x40000001]
-    blocks = [x[1] for x in inv.inventory if x[0] == 2 or x[0] == 0x40000002]
-    if blocks:
+    transactions = [x[1] for x in inv.inventory if x[0] in [1, 0x40000001]]
+    if blocks := [x[1] for x in inv.inventory if x[0] in [2, 0x40000002]]:
        block_locators = node.index.get_block_locator_hashes()
        conn.send(Getheaders(ProtocolVersion, block_locators, blocks[-1]))

-    missing_tx = node.mempool.get_missing(transactions)
-    if missing_tx:
+    if missing_tx := node.mempool.get_missing(transactions):


Function inv refactored with the following changes:

Use named expression to simplify assignment and conditional [×2] (use-named-expression)

Replace multiple comparisons of same variable with in operator [×2] (merge-comparisons)

sourcery-ai · 2023-01-02T12:45:45Z

btclib_node/p2p/callbacks.py

-    transactions = [x[1] for x in getdata.inventory if x[0] == 1 or x[0] == 0x40000001]
-    blocks = [x[1] for x in getdata.inventory if x[0] == 2 or x[0] == 0x40000002]
+    transactions = [x[1] for x in getdata.inventory if x[0] in [1, 0x40000001]]
+    blocks = [x[1] for x in getdata.inventory if x[0] in [2, 0x40000002]]
    for txid in transactions:
-        tx = node.mempool.get_tx(txid)
-        if tx:
+        if tx := node.mempool.get_tx(txid):
            conn.send(TxMsg(tx))
    for block_hash in blocks:
-        block = node.block_db.get_block(block_hash)
-        if block:
+        if block := node.block_db.get_block(block_hash):


Function getdata refactored with the following changes:

Replace multiple comparisons of same variable with in operator [×2] (merge-comparisons)

Use named expression to simplify assignment and conditional [×2] (use-named-expression)

sourcery-ai · 2023-01-02T12:45:45Z

btclib_node/p2p/callbacks.py

-    else:
-        if node.status == NodeStatus.SyncingHeaders:
-            node.status = NodeStatus.HeaderSynced
+    elif node.status == NodeStatus.SyncingHeaders:
+        node.status = NodeStatus.HeaderSynced


Function headers refactored with the following changes:

Merge else clause's nested if statement into elif (merge-else-if-into-elif)

sourcery-ai · 2023-01-02T12:45:46Z

btclib_node/p2p/callbacks.py

-    headers = node.index.get_headers_from_locators(
+    if headers := node.index.get_headers_from_locators(
        getheaders.block_hashes, getheaders.hash_stop
-    )
-    if headers:
+    ):


Function getheaders refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2023-01-02T12:45:46Z

btclib_node/p2p/main.py

-            elif conn.status == P2pConnStatus.Closed:
-                pass
-            else:
+            elif conn.status != P2pConnStatus.Closed:


Function handle_p2p_handshake refactored with the following changes:

Remove empty elif clause (remove-pass-elif)

sourcery-ai · 2023-01-02T12:45:50Z

btclib_node/p2p/main.py

-                elif conn.status == P2pConnStatus.Closed:
-                    pass
-                else:
+                elif conn.status != P2pConnStatus.Closed:


Function handle_p2p refactored with the following changes:

Remove empty elif clause (remove-pass-elif)

sourcery-ai · 2023-01-02T12:45:50Z

btclib_node/p2p/manager.py

-                connection_num = 1
-            else:
-                connection_num = 10
+            connection_num = 1 if self.node.status < NodeStatus.HeaderSynced else 10


Function P2pManager.manage_connections refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-01-02T12:45:50Z

btclib_node/p2p/messages/address.py

-        addresses = []
-        for x in range(len_addresses):
-            addresses.append(NetworkAddress.deserialize(stream))
+        addresses = [NetworkAddress.deserialize(stream) for _ in range(len_addresses)]


Function Addr.deserialize refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

Replace unused for index with underscore (for-index-underscore)

sourcery-ai · 2023-01-02T12:45:50Z

btclib_node/p2p/messages/compact.py

-        short_ids = []
        short_ids_length = var_int.parse(stream)
-        for x in range(short_ids_length):
-            short_ids.append(stream.read(6)[::-1])
+        short_ids = [stream.read(6)[::-1] for _ in range(short_ids_length)]
        prefilled_tx_list = []
        prefilled_tx_num = var_int.parse(stream)
-        for x in range(prefilled_tx_num):
+        for _ in range(prefilled_tx_num):


Function Cmpctblock.deserialize refactored with the following changes:

Move assignment closer to its usage within a block (move-assign-in-block)

Replace unused for index with underscore [×2] (for-index-underscore)

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2023-01-02T12:45:51Z

btclib_node/p2p/messages/data.py

        headers_num = var_int.parse(stream)
        headers = []
-        for x in range(headers_num):
+        for _ in range(headers_num):


Function Headers.deserialize refactored with the following changes:

Replace unused for index with underscore (for-index-underscore)

sourcery-ai · 2023-01-02T12:45:53Z

btclib_node/rpc/connection.py

-        response = "HTTP/1.1 200 OK\n"
-        response += "Content-Type: application/json\n"
+        response = "HTTP/1.1 200 OK\n" + "Content-Type: application/json\n"


Function Connection.async_send refactored with the following changes:

Replace assignment and augmented assignment with single assignment (merge-assign-and-aug-assign)

sourcery-ai · 2023-01-02T12:45:53Z

btclib_node/rpc/main.py

    try:
-        conn = manager.connections[id]
-        return conn
+        return manager.connections[id]


Function get_connection refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-01-02T12:45:53Z

btclib_node/rpc/main.py

-    if "method" not in request:
-        return False
-    if "id" not in request:
-        return False
-    return True
+    return False if "method" not in request else "id" in request


Function is_valid_rpc refactored with the following changes:

Lift code into else after jump in control flow [×2] (reintroduce-else)

Replace if statement with if expression [×2] (assign-if-exp)

Simplify boolean if expression (boolean-if-exp-identity)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

sourcery-ai · 2023-01-02T12:45:53Z

btclib_node/rpc/main.py

-                if "params" in request:
-                    params = request["params"]
-                else:
-                    params = []
+                params = request["params"] if "params" in request else []


Function handle_rpc refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-01-02T12:45:53Z

tests/helpers.py

-            previous_block_hash = chain[-1].hash
-        else:
-            previous_block_hash = start
+        previous_block_hash = chain[-1].hash if chain else start


Function generate_random_header_chain refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-01-02T12:45:57Z

tests/unit/main.py

    for block in chain:
        node.block_db.add_block(block)
-    for x in range(len(chain)):
+    for _ in range(len(chain)):


Function test refactored with the following changes:

Replace unused for index with underscore (for-index-underscore)

sourcery-ai · 2023-01-02T12:45:59Z

Sourcery Code Quality Report

✅ Merging this PR will increase code quality in the affected files by 0.89%.

Quality metrics	Before	After	Change
Complexity	5.39 ⭐	4.64 ⭐	-0.75 👍
Method Length	59.30 ⭐	58.65 ⭐	-0.65 👍
Working memory	7.33 🙂	7.26 🙂	-0.07 👍
Quality	71.88% 🙂	72.77% 🙂	0.89% 👍

Other metrics	Before	After	Change
Lines	1772	1710	-62

Changed files	Quality Before	Quality After	Quality Change
btclib_node/__init__.py	57.78% 🙂	60.00% 🙂	2.22% 👍
btclib_node/chainstate.py	55.00% 🙂	55.64% 🙂	0.64% 👍
btclib_node/config.py	35.55% 😞	36.51% 😞	0.96% 👍
btclib_node/download.py	25.79% 😞	40.20% 😞	14.41% 👍
btclib_node/log.py	86.42% ⭐	86.77% ⭐	0.35% 👍
btclib_node/mempool.py	88.50% ⭐	89.43% ⭐	0.93% 👍
btclib_node/block_db/__init__.py	77.98% ⭐	78.06% ⭐	0.08% 👍
btclib_node/index/__init__.py	69.20% 🙂	69.24% 🙂	0.04% 👍
btclib_node/p2p/address.py	82.24% ⭐	82.72% ⭐	0.48% 👍
btclib_node/p2p/callbacks.py	72.24% 🙂	73.56% 🙂	1.32% 👍
btclib_node/p2p/main.py	59.11% 🙂	60.17% 🙂	1.06% 👍
btclib_node/p2p/manager.py	70.35% 🙂	71.29% 🙂	0.94% 👍
btclib_node/p2p/messages/address.py	90.62% ⭐	91.17% ⭐	0.55% 👍
btclib_node/p2p/messages/compact.py	75.43% ⭐	76.71% ⭐	1.28% 👍
btclib_node/p2p/messages/data.py	87.28% ⭐	87.47% ⭐	0.19% 👍
btclib_node/p2p/messages/errors.py	86.59% ⭐	86.59% ⭐	0.00%
btclib_node/p2p/messages/getdata.py	85.32% ⭐	85.41% ⭐	0.09% 👍
btclib_node/p2p/messages/ping.py	91.62% ⭐	92.63% ⭐	1.01% 👍
btclib_node/rpc/callbacks.py	70.59% 🙂	73.75% 🙂	3.16% 👍
btclib_node/rpc/connection.py	77.10% ⭐	76.25% ⭐	-0.85% 👎
btclib_node/rpc/main.py	72.80% 🙂	71.62% 🙂	-1.18% 👎
tests/helpers.py	72.25% 🙂	72.42% 🙂	0.17% 👍
tests/unit/main.py	63.96% 🙂	66.31% 🙂	2.35% 👍

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
btclib_node/chainstate.py	Chainstate.add_block	17 🙂	246 ⛔	17 ⛔	29.83% 😞	Try splitting into smaller methods. Extract out complex expressions
btclib_node/p2p/manager.py	P2pManager.manage_connections	29 😞	193 😞	10 😞	35.57% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
btclib_node/config.py	Config.__init__	16 🙂	176 😞	16 ⛔	36.51% 😞	Try splitting into smaller methods. Extract out complex expressions
btclib_node/download.py	block_download	15 🙂	207 ⛔	12 😞	40.20% 😞	Try splitting into smaller methods. Extract out complex expressions
btclib_node/index/__init__.py	BlockIndex.add_headers	10 🙂	171 😞	12 😞	47.50% 😞	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

⭐ excellent
🙂 good
😞 poor
⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

'Refactored by Sourcery'

6c6e9bd

sourcery-ai bot requested a review from fametrano January 2, 2023 12:45

sourcery-ai bot commented Jan 2, 2023

View reviewed changes

Uh oh!

Sourcery refactored master branch #1

Are you sure you want to change the base?

Sourcery refactored master branch #1

Uh oh!

Conversation

sourcery-ai bot commented Jan 2, 2023

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 2, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Jan 2, 2023

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone