Sourcery refactored master branch #1

sourcery-ai · 2021-12-05T11:21:20Z

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!

height · 2021-12-05T11:21:21Z

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

sourcery-ai · 2021-12-05T11:21:22Z

src/robotkernel/builders_32.py

-    keywords = {}
-    for keyword in suite.resource.keywords:
-        keywords[keyword.name] = keyword
+    keywords = {keyword.name: keyword for keyword in suite.resource.keywords}
    suite.resource.keywords._items = list(keywords.values())

    # Strip duplicate variables
-    variables = {}
-    for variable in suite.resource.variables:
-        variables[variable.name] = variable
+    variables = {variable.name: variable for variable in suite.resource.variables}


Function build_suite refactored with the following changes:

Convert for loop into dictionary comprehension (dict-comprehension)

sourcery-ai · 2021-12-05T11:21:23Z

src/robotkernel/completion_finders.py

-    matches = []
-
-    for lib in list(STDLIBS) + list(get_root_modules()):
-        if needle in lib.lower():
-            matches.append(lib)
-
-    return matches
+    return [
+        lib
+        for lib in list(STDLIBS) + list(get_root_modules())
+        if needle in lib.lower()
+    ]


Function complete_libraries refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

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

sourcery-ai · 2021-12-05T11:21:23Z

src/robotkernel/executors.py

-    header = rpa and "Tasks" or "Test Cases"
+    header = "Tasks" if rpa else "Test Cases"


Function execute_python.execute_ipywidget refactored with the following changes:

Replace boolean ternary with inline if expression (ternary-to-if-expression)

sourcery-ai · 2021-12-05T11:21:23Z

src/robotkernel/listeners.py

-    remained = []
-    for driver in drivers:
-        if driver.get("type") != type_:
-            remained.append(driver)
+    remained = [driver for driver in drivers if driver.get("type") != type_]


Function clear_drivers refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2021-12-05T11:21:23Z

src/robotkernel/listeners.py

-        aliases = []
-        for alias, idx_ in cache._aliases.items():
-            if (idx + 1) == idx_:
-                aliases.append(alias)
+        aliases = [
+            alias
+            for alias, idx_ in cache._aliases.items()
+            if (idx + 1) == idx_
+        ]
+


Function get_webdrivers refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2021-12-05T11:21:24Z

src/robotkernel/selectors.py

-    results = []
    matches = []
    unresolved = []
-    if needle:
-        results = driver.find_elements_by_xpath(needle)
+    results = driver.find_elements_by_xpath(needle) if needle else []


Function get_selenium_xpath_selector_completions refactored with the following changes:

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

sourcery-ai · 2021-12-05T11:21:24Z

src/robotkernel/selectors_white.py

-        if as_bytes:
-            fp = MemoryStream()
-            screenshot.Save(fp, ImageFormat.Png)
-            return bytes(bytearray(fp.ToArray()))
-        else:
+        if not as_bytes:
            return screenshot
+        fp = MemoryStream()
+        screenshot.Save(fp, ImageFormat.Png)
+        return bytes(bytearray(fp.ToArray()))


Function PickSnipTool.take_screenshot refactored with the following changes:

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

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

sourcery-ai · 2021-12-05T11:21:24Z

src/robotkernel/utils.py

-    if s and not s.startswith("*") and not s.startswith("["):
-        if s.count("."):
-            library, name = s.rsplit(".", 1)
-            return library + "." + name[0].title() + name[1:].lower()
-        else:
-            return s[0].title() + s[1:].lower()
-    else:
+    if not s or s.startswith("*") or s.startswith("["):
        return s
+    if not s.count("."):
+        return s[0].title() + s[1:].lower()
+    library, name = s.rsplit(".", 1)
+    return library + "." + name[0].title() + name[1:].lower()


Function readable_keyword refactored with the following changes:

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

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

sourcery-ai · 2021-12-05T11:21:24Z

src/robotkernel/utils.py

+    context_name = context_parts[1].strip().lower()
+    if context_name == "settings":
+        return "__settings__"
+    elif line.lstrip() == line:
+        return "__root__"
+    elif context_name in ["tasks", "test cases"]:
+        return "__tasks__"
+    elif context_name == "keywords":
+        return "__keywords__"
    else:
-        context_name = context_parts[1].strip().lower()
-        if context_name == "settings":
-            return "__settings__"
-        elif line.lstrip() == line:
-            return "__root__"
-        elif context_name in ["tasks", "test cases"]:
-            return "__tasks__"
-        elif context_name == "keywords":
-            return "__keywords__"
-        else:
-            return "__root__"
+        return "__root__"


Function detect_robot_context refactored with the following changes:

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

sourcery-ai · 2021-12-05T11:21:24Z

src/robotkernel/utils.py

-        else:
-            data, metadata = JSON(data=obj, expanded=True)._repr_json_()
-            return (
-                {"application/json": data, "text/html": f"<pre>{to_html(obj)}</pre>"},
-                metadata,
-            )
+        data, metadata = JSON(data=obj, expanded=True)._repr_json_()
+        return (
+            {"application/json": data, "text/html": f"<pre>{to_html(obj)}</pre>"},
+            metadata,
+        )


Function to_mime_and_metadata refactored with the following changes:

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

sourcery-ai · 2021-12-05T11:21:37Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	8.48 ⭐	8.27 ⭐	-0.21 👍
Method Length	59.57 ⭐	59.24 ⭐	-0.33 👍
Working memory	8.71 🙂	8.66 🙂	-0.05 👍
Quality	65.50% 🙂	65.80% 🙂	0.30% 👍

Other metrics	Before	After	Change
Lines	1812	1790	-22

Changed files	Quality Before	Quality After	Quality Change
src/robotkernel/builders_32.py	63.67% 🙂	66.41% 🙂	2.74% 👍
src/robotkernel/completion_finders.py	88.23% ⭐	95.18% ⭐	6.95% 👍
src/robotkernel/executors.py	43.76% 😞	43.82% 😞	0.06% 👍
src/robotkernel/listeners.py	82.26% ⭐	82.89% ⭐	0.63% 👍
src/robotkernel/monkeypatches.py	67.00% 🙂	68.51% 🙂	1.51% 👍
src/robotkernel/selectors.py	66.58% 🙂	66.61% 🙂	0.03% 👍
src/robotkernel/selectors_white.py	69.42% 🙂	69.50% 🙂	0.08% 👍
src/robotkernel/utils.py	63.40% 🙂	64.67% 🙂	1.27% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
src/robotkernel/executors.py	execute_python.run_robot_suite	22 😞	331 ⛔	18 ⛔	22.19% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/robotkernel/executors.py	execute_python.process_screenshots	21 😞	273 ⛔	16 ⛔	26.62% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/robotkernel/selectors.py	get_autoit_control_selector_completions	31 😞	212 ⛔	13 😞	27.99% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/robotkernel/utils.py	to_mime_and_metadata	24 😞	262 ⛔	12 😞	30.50% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
src/robotkernel/selectors_white.py	PickSnipTool.pick	15 🙂	214 ⛔	12 😞	39.71% 😞	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'

9e21a81

sourcery-ai bot requested a review from admariner December 5, 2021 11:21

sourcery-ai bot commented Dec 5, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored master branch #1

Sourcery refactored master branch #1

sourcery-ai bot commented Dec 5, 2021

height bot commented Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot Dec 5, 2021

sourcery-ai bot commented Dec 5, 2021

		header = rpa and "Tasks" or "Test Cases"
		header = "Tasks" if rpa else "Test Cases"

Sourcery refactored master branch #1

Are you sure you want to change the base?

Sourcery refactored master branch #1

Conversation

sourcery-ai bot commented Dec 5, 2021

height bot commented Dec 5, 2021

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot Dec 5, 2021

Choose a reason for hiding this comment

sourcery-ai bot commented Dec 5, 2021

Sourcery Code Quality Report

Legend and Explanation