Sourcery refactored master branch by sourcery-ai[bot] · Pull Request #7 · dansan/zrsync

sourcery-ai · 2022-02-21T07:26:52Z

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 · 2022-02-21T07:26:54Z

zrsync/zrsync.py

-        self._error_tmp = dict()
-        self._move_tmp = dict()
-        self._previous_stat = dict()
+        self._error_tmp = {}
+        self._move_tmp = {}
+        self._previous_stat = {}


Function SyncClient.__init__ refactored with the following changes:

Replace dict() with {} (dict-literal)

sourcery-ai · 2022-02-21T07:26:54Z

zrsync/zrsync.py

-            if not handler in inotify.adapters._LOGGER.handlers:
+            if handler not in inotify.adapters._LOGGER.handlers:
                inotify.adapters._LOGGER.addHandler(handler)
                inotify.adapters._LOGGER.setLevel(self.logger.level)
        notifyier = inotify.adapters.InotifyTree(base_dir, mask=mask)
        for event in notifyier.event_gen():
            if event is not None:
                header, type_names, watch_path, filename = event
-                if not any([tn in HANDLE_EVENTS for tn in type_names]):
+                if all(tn not in HANDLE_EVENTS for tn in type_names):
                    self.logger.debug("ignoring event type_names=%r", type_names)
                    continue
-                if any([re.search(regex, filename) for regex in FILE_IGNORE_REGEX]):
+                if any(re.search(regex, filename) for regex in FILE_IGNORE_REGEX):


Function SyncClient.watch_dir refactored with the following changes:

Simplify logical expression using De Morgan identities (de-morgan)

Invert any/all to simplify comparisons (invert-any-all)

Replace unneeded comprehension with generator (comprehension-to-generator)

sourcery-ai · 2022-02-21T07:26:54Z

zrsync/zrsync.py

-        if "IN_ISDIR" in action:
-            if "IN_CREATE" in action:
+        if "IN_CREATE" in action:
+            if "IN_ISDIR" in action:


Function SyncClient.handle_fs_event refactored with the following changes:

Hoist repeated code outside conditional statement (hoist-statement-from-if)

This removes the following comments ( why? ):

# prevent unnecessary request by detecting IN_ATTRIB following # file was moved away, noticed by request.add_stat() above # IN_CREATE and IN_CLOSE_WRITE without stat change # moved in from outside of inotify-observed tree # prevent unnecessary request in case of an empty file

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsync.py

-    processes = list()
+    processes = []


Function main refactored with the following changes:

Replace list() with [] (list-literal)

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsyncd.py

-            self._request[key] = self.encode_binary(value)
-        else:
-            self._request[key] = value
+        self._request[key] = self.encode_binary(value) if key == "data" else value


Function ZRequest.__setitem__ refactored with the following changes:

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

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsyncd.py

-        self.diff_tree = dict()
+        self.diff_tree = {}


Function SyncServer.sync_tree refactored with the following changes:

Replace dict() with {} (dict-literal)

Replace list() with [] (list-literal)

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

Simplify logical expression using De Morgan identities (de-morgan)

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsyncd.py

+                        elif node["st_size"] == 0:
+                            self.logger.info("truncate %r", file_path)
+                            with open(file_path, "w") as fp:
+                                fp.truncate(0)
+                            warn = self.utime(file_path, node["st_atime"], node["st_mtime"])
+                            return dict(cmd="truncate", result="done", name=file_path, warn=warn)
+                        elif node["st_blocks"] < MIN_BLOCK_DIFF_SIZE:
+                            # not worth diffing on both ends and patching
+                            self.logger.info("req full %r", file_path)
+                            return dict(cmd="full", name=file_path)
                        else:
-                            if node["st_size"] == 0:
-                                self.logger.info("truncate %r", file_path)
-                                with open(file_path, "w") as fp:
-                                    fp.truncate(0)
-                                warn = self.utime(file_path, node["st_atime"], node["st_mtime"])
-                                return dict(cmd="truncate", result="done", name=file_path, warn=warn)
-                            elif node["st_blocks"] < MIN_BLOCK_DIFF_SIZE:
-                                # not worth diffing on both ends and patching
-                                self.logger.info("req full %r", file_path)
-                                return dict(cmd="full", name=file_path)
-                            else:
-                                self.logger.info("req diff %r", file_path)
-                                sig = self.get_signature(file_path)
-                                return dict(cmd="diff", name=file_path, data=ZRequest.encode_binary(sig.read()))
+                            self.logger.info("req diff %r", file_path)
+                            sig = self.get_signature(file_path)
+                            return dict(cmd="diff", name=file_path, data=ZRequest.encode_binary(sig.read()))
                    else:
                        raise RuntimeError("We should not be here.")
-                else:
-                    # src_st == dst_st
-                    pass


Function SyncServer.cmp_node refactored with the following changes:

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

Remove redundant pass statement (remove-redundant-pass)

This removes the following comments ( why? ):

# src_st == dst_st

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsyncd.py

-                if _node["cmd"] != "ignore":
-                    if (not all([isinstance(_node[x], int) for x in ["st_mode", "st_uid", "st_gid", "st_size"]]) or
-                            not isinstance(_node["st_mtime"], float)):
-                        return (False, "Bad src_tree _node {}. Item 'st_mode', 'st_uid', 'st_gid', 'st_mtime' or "
-                                       "'st_size' has wrong type.".format(_node))
+                if _node["cmd"] != "ignore" and (
+                    not all(
+                        isinstance(_node[x], int)
+                        for x in ["st_mode", "st_uid", "st_gid", "st_size"]
+                    )
+                    or not isinstance(_node["st_mtime"], float)
+                ):
+                    return (False, "Bad src_tree _node {}. Item 'st_mode', 'st_uid', 'st_gid', 'st_mtime' or "
+                                   "'st_size' has wrong type.".format(_node))


Function SyncServer.validate_tree_structure.validate_node refactored with the following changes:

Merge nested if conditions (merge-nested-ifs)

Replace unneeded comprehension with generator (comprehension-to-generator)

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsyncd.py

-                    if exc.errno == 2:
-                        pass
-                    else:
+                    if exc.errno != 2:


Function SyncServer.run refactored with the following changes:

Swap if/else to remove empty if body (remove-pass-body)

sourcery-ai · 2022-02-21T07:26:55Z

zrsync/zrsyncd.py

-        else:
-            self.logger.error("Checksum mismatch after patching %r.", request.name)
-            return {"status": 2, "reason": "Checksum mismatch for '{}'.".format(request.name)}
+        self.logger.error("Checksum mismatch after patching %r.", request.name)
+        return {"status": 2, "reason": "Checksum mismatch for '{}'.".format(request.name)}


Function SyncServer.post_file_write_action refactored with the following changes:

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

sourcery-ai · 2022-02-21T07:27:05Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	20.96 😞	15.75 🙂	-5.21 👍
Method Length	78.85 🙂	75.65 🙂	-3.20 👍
Working memory	11.56 😞	10.97 😞	-0.59 👍
Quality	52.26% 🙂	55.11% 🙂	2.85% 👍

Other metrics	Before	After	Change
Lines	1320	1272	-48

Changed files	Quality Before	Quality After	Quality Change
zrsync/zrsync.py	36.70% 😞	43.21% 😞	6.51% 👍
zrsync/zrsyncd.py	60.32% 🙂	60.69% 🙂	0.37% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
zrsync/zrsyncd.py	SyncServer.cmp_node	69 ⛔	597 ⛔	21 ⛔	4.78% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
zrsync/zrsyncd.py	SyncServer.run	29 😞	369 ⛔	22 ⛔	14.79% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
zrsync/zrsync.py	SyncClient.handle_fs_event	35 ⛔	344 ⛔	16 ⛔	16.96% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
zrsync/zrsync.py	SyncClient.stat_dir	25 😞	271 ⛔	14 😞	26.51% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
zrsync/zrsyncd.py	SyncServer.sync_tree	25 😞	263 ⛔	13 😞	28.28% 😞	Refactor to reduce nesting. 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'

434b551

sourcery-ai bot requested a review from dansan February 21, 2022 07:26

sourcery-ai bot commented Feb 21, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored master branch#7

Sourcery refactored master branch#7
sourcery-ai[bot] wants to merge 1 commit intomasterfrom
sourcery/master

sourcery-ai bot commented Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Uh oh!

sourcery-ai bot commented Feb 21, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

Conversation

sourcery-ai bot commented Feb 21, 2022

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Feb 21, 2022

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants