Sourcery refactored master branch #206

sourcery-ai · 2021-06-10T20:00:15Z

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 · 2021-06-10T20:01:38Z

src/Zoomba/APILibrary.py

-        if "FALSE" in suppress.upper():
-            self.suppress_warnings = False
-        else:
-            self.suppress_warnings = True
+        self.suppress_warnings = "FALSE" not in suppress.upper()


Function APILibrary.suppress_insecure_request_warnings refactored with the following changes:

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

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

sourcery-ai · 2021-06-10T20:01:38Z

src/Zoomba/APILibrary.py

-        elif isinstance(number_of_items, int):
-            pass
-        else:
+        elif not isinstance(number_of_items, int):


Function APILibrary.validate_response_contains_correct_number_of_items refactored with the following changes:

Remove empty elif clause (remove-pass-elif)

sourcery-ai · 2021-06-10T20:01:38Z

src/Zoomba/APILibrary.py

-    new_response = {}
-    for item in dir(response):
-        if item[0] != '_':
-            new_response[item] = getattr(response, item)
+    new_response = {
+        item: getattr(response, item)
+        for item in dir(response)
+        if item[0] != '_'
+    }
+


Function _convert_resp_to_dict refactored with the following changes:

Convert for loop into dictionary comprehension (dict-comprehension)

sourcery-ai · 2021-06-10T20:01:38Z

src/Zoomba/DesktopLibrary.py

-            stdout = open(os.devnull, 'w')
-            self.process = subprocess.Popen([path], stdout=stdout)
-            stdout.close()
+            with open(os.devnull, 'w') as stdout:
+                self.process = subprocess.Popen([path], stdout=stdout)


Function WinAppDriver.set_up_driver refactored with the following changes:

Use with when opening file to ensure closure (ensure-file-closed)

sourcery-ai · 2021-06-10T20:01:38Z

src/Zoomba/DesktopLibrary.py

+                    self._wait_until_page_contains_element(each, self.get_appium_timeout())
                    if count == 0:
-                        self._wait_until_page_contains_element(each, self.get_appium_timeout())
                        self.mouse_over_and_context_click_element(each)
                    else:
-                        self._wait_until_page_contains_element(each, self.get_appium_timeout())


Function DesktopLibrary.select_elements_from_context_menu refactored with the following changes:

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

sourcery-ai · 2021-06-10T20:01:39Z

src/Zoomba/MobileLibrary.py

-        for x in range(swipe_count):
+        for _ in range(swipe_count):


Function MobileLibrary.scroll_up_to_text refactored with the following changes:

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

sourcery-ai · 2021-06-10T20:01:39Z

src/Zoomba/SOAPLibrary.py

-            for x in range(number_of_types):
+            for _ in range(number_of_types):


Function _ObjectNamespacePlugin.loaded refactored with the following changes:

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

sourcery-ai · 2021-06-10T20:01:39Z

src/Zoomba/SOAPLibrary.py

-        response = suds_library.call_soap_method(action, *soap_object)
-        return response
+        return suds_library.call_soap_method(action, *soap_object)


Function SOAPLibrary.call_soap_method_with_list_object refactored with the following changes:

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

sourcery-ai · 2021-06-10T20:01:40Z

src/Zoomba/SOAPLibrary.py

-    for index in range(len(response_dictionary)):
+    for _ in range(len(response_dictionary)):


Function _build_dict_from_response refactored with the following changes:

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

sourcery-ai · 2021-06-10T20:01:40Z

test/Helpers/webdriverremotemock.py

-        if encode:
-            self._myData = base64.b64decode(data)
-        else:
-            self._myData = data
+        self._myData = base64.b64decode(data) if encode else data


Function WebdriverRemoteMock.push_file refactored with the following changes:

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

sourcery-ai · 2021-06-10T20:01:41Z

Sourcery Code Quality Report

❌ Merging this PR will decrease code quality in the affected files by 0.12%.

Quality metrics	Before	After	Change
Complexity	7.25 ⭐	7.27 ⭐	0.02 👎
Method Length	46.52 ⭐	46.28 ⭐	-0.24 👍
Working memory	8.06 🙂	8.09 🙂	0.03 👎
Quality	70.80% 🙂	70.68% 🙂	-0.12% 👎

Other metrics	Before	After	Change
Lines	2348	2333	-15

Changed files	Quality Before	Quality After	Quality Change
src/Zoomba/APILibrary.py	52.45% 🙂	51.74% 🙂	-0.71% 👎
src/Zoomba/DesktopLibrary.py	71.66% 🙂	71.72% 🙂	0.06% 👍
src/Zoomba/GUILibrary.py	88.72% ⭐	89.10% ⭐	0.38% 👍
src/Zoomba/MobileLibrary.py	86.08% ⭐	86.08% ⭐	0.00%
src/Zoomba/SOAPLibrary.py	66.14% 🙂	65.89% 🙂	-0.25% 👎
test/Helpers/webdriverremotemock.py	93.24% ⭐	93.65% ⭐	0.41% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
src/Zoomba/APILibrary.py	_unmatched_list_check	28 😞	314 ⛔	19 ⛔	18.30% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/Zoomba/APILibrary.py	APILibrary.key_by_key_validator	26 😞	259 ⛔	16 ⛔	24.08% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/Zoomba/APILibrary.py	APILibrary._key_by_key_list	19 😞	126 😞	16 ⛔	39.47% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/Zoomba/APILibrary.py	APILibrary.validate_response_contains_expected_response	25 😞	152 😞	11 😞	39.64% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/Zoomba/DesktopLibrary.py	DesktopLibrary.switch_application_by_name	12 🙂	248 ⛔	12 😞	40.24% 😞	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!

coveralls · 2021-06-10T20:03:35Z

Coverage remained the same at 100.0% when pulling 36992d5 on sourcery/master into d3a064d on master.

Wolfe1

Tested this out locally with the sample files and everything seems to be good. Each refactor made sense after reading through it. Coverage still at 100%.

neiljhowell

WHAT SORCERY IS THIS :D

sourcery-ai bot requested a review from Wolfe1 June 10, 2021 20:00

'Refactored by Sourcery'

36992d5

sourcery-ai bot force-pushed the sourcery/master branch from be1896c to 36992d5 Compare June 10, 2021 20:01

sourcery-ai bot commented Jun 10, 2021

View reviewed changes

Wolfe1 approved these changes Jun 11, 2021

View reviewed changes

Wolfe1 requested review from neiljhowell and mbozek83 June 11, 2021 15:15

Wolfe1 added the tech debt label Jun 11, 2021

Wolfe1 self-assigned this Jun 11, 2021

neiljhowell approved these changes Jun 11, 2021

View reviewed changes

Wolfe1 merged commit 8297e72 into master Jun 12, 2021

Wolfe1 deleted the sourcery/master branch June 12, 2021 15:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored master branch #206

Sourcery refactored master branch #206

sourcery-ai bot commented Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot Jun 10, 2021

sourcery-ai bot commented Jun 10, 2021

coveralls commented Jun 10, 2021 •

edited

Loading

Wolfe1 left a comment

neiljhowell left a comment

		for x in range(number_of_types):
		for _ in range(number_of_types):

		for index in range(len(response_dictionary)):
		for _ in range(len(response_dictionary)):

Sourcery refactored master branch #206

Sourcery refactored master branch #206

Conversation

sourcery-ai bot commented Jun 10, 2021

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2021

Choose a reason for hiding this comment

sourcery-ai bot commented Jun 10, 2021

Sourcery Code Quality Report

Legend and Explanation

coveralls commented Jun 10, 2021 • edited Loading

Wolfe1 left a comment

Choose a reason for hiding this comment

neiljhowell left a comment

Choose a reason for hiding this comment

coveralls commented Jun 10, 2021 •

edited

Loading