add `default_complete` option (Sourcery refactored) #84

sourcery-ai · 2022-06-21T16:01:38Z

Pull Request #83 refactored by Sourcery.

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

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

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 default_complete branch, then run:

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

Help us improve this pull request!

sourcery-ai · 2022-06-21T16:01:40Z

shtab/__init__.py

@@ -162,7 +162,6 @@ def get_option_strings(parser):
    def recurse(parser, prefix):
        """recurse through subparsers, appending to the return lists"""
        subparsers = []
-        option_strings = []


Function get_bash_commands.recurse refactored with the following changes:

Merge append into list declaration (merge-list-append)

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

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

Replace call to format with f-string [×10] (use-fstring-for-formatting)

Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)

This removes the following comments ( why? ):

# optional arguments

sourcery-ai · 2022-06-21T16:01:40Z

shtab/__init__.py

-        return (('{nargs}{options}"[{help}]"' if isinstance(
-            opt, FLAG_OPTION) else '{nargs}{options}"[{help}]:{dest}:{pattern}"').format(
-                nargs=('"(- :)"' if isinstance(opt, OPTION_END) else
-                       '"*"' if isinstance(opt, OPTION_MULTI) else ""),
-                options=("{{{}}}".format(",".join(opt.option_strings))
-                         if len(opt.option_strings) > 1 else '"{}"'.format("".join(
-                             opt.option_strings))),
+        return (
+            (
+                '{nargs}{options}"[{help}]"'
+                if isinstance(opt, FLAG_OPTION)
+                else '{nargs}{options}"[{help}]:{dest}:{pattern}"'
+            )
+            .format(
+                nargs=(
+                    '"(- :)"'
+                    if isinstance(opt, OPTION_END)
+                    else '"*"'
+                    if isinstance(opt, OPTION_MULTI)
+                    else ""
+                ),
+                options=(
+                    "{{{}}}".format(",".join(opt.option_strings))
+                    if len(opt.option_strings) > 1
+                    else '"{}"'.format("".join(opt.option_strings))
+                ),
                help=escape_zsh(opt.help or ""),
                dest=opt.dest,
-                pattern=complete2pattern(opt.complete, "zsh", choice_type2fn) if hasattr(
-                    opt, "complete") else
-                (choice_type2fn[opt.choices[0].type] if isinstance(opt.choices[0], Choice) else
-                 "({})".format(" ".join(map(str, opt.choices)))) if opt.choices else "",
-            ).replace('""', ""))
+                pattern=complete2pattern(opt.complete, "zsh", choice_type2fn)
+                if hasattr(opt, "complete")
+                else (
+                    choice_type2fn[opt.choices[0].type]
+                    if isinstance(opt.choices[0], Choice)
+                    else f'({" ".join(map(str, opt.choices))})'
+                )
+                if opt.choices
+                else "",
+            )
+            .replace('""', "")
+        )


Function complete_zsh.format_optional refactored with the following changes:

Replace call to format with f-string (use-fstring-for-formatting)

sourcery-ai · 2022-06-21T16:01:40Z

shtab/__init__.py

-            pattern=complete2pattern(opt.complete, "zsh", choice_type2fn) if hasattr(
-                opt, "complete") else
-            (choice_type2fn[opt.choices[0].type] if isinstance(opt.choices[0], Choice) else
-             "({})".format(" ".join(map(str, opt.choices)))) if opt.choices else default_complete,
+            pattern=complete2pattern(opt.complete, "zsh", choice_type2fn)
+            if hasattr(opt, "complete")
+            else (
+                choice_type2fn[opt.choices[0].type]
+                if isinstance(opt.choices[0], Choice)
+                else f'({" ".join(map(str, opt.choices))})'
+            )
+            if opt.choices
+            else default_complete,


Function complete_zsh.format_positional refactored with the following changes:

Replace call to format with f-string (use-fstring-for-formatting)

sourcery-ai · 2022-06-21T16:01:40Z

shtab/__init__.py

-            if not sub.choices or not isinstance(sub.choices, dict):
+            if not isinstance(sub.choices, dict):
                # positional argument
                all_commands[prefix]["arguments"].append(format_positional(sub))
            else:  # subparser
-                log.debug("choices:{}:{}".format(prefix, sorted(sub.choices)))
+                log.debug(f"choices:{prefix}:{sorted(sub.choices)}")


Function complete_zsh.recurse refactored with the following changes:

Remove redundant conditional (remove-redundant-if)

Replace call to format with f-string (use-fstring-for-formatting)

Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)

sourcery-ai · 2022-06-21T16:01:40Z

shtab/__init__.py

-        commands = "\n    ".join('"{}:{}"'.format(cmd, escape_zsh(opt["help"]))
-                                 for cmd, opt in sorted(options["commands"].items()))
+        commands = "\n    ".join(
+            f'"{cmd}:{escape_zsh(opt["help"])}"'
+            for cmd, opt in sorted(options["commands"].items())
+        )
+


Function complete_zsh.command_list refactored with the following changes:

Replace call to format with f-string (use-fstring-for-formatting)

sourcery-ai · 2022-06-21T16:01:41Z

shtab/__init__.py

-            yield "'{}/{}/({})/'".format(
-                arg_type,
-                arg_sel,
-                choice_strs,
-            )
-        else:
-            arg_complete = getattr(arg, "complete", default_complete)
-            if arg_complete:
-                complete_fn = complete2pattern(arg_complete, 'tcsh', choice_type2fn)
-                if complete_fn:
-                    yield "'{}/{}/{}/'".format(arg_type, arg_sel, complete_fn)
+            yield f"'{arg_type}/{arg_sel}/({choice_strs})/'"
+        elif arg_complete := getattr(arg, "complete", default_complete):
+            if complete_fn := complete2pattern(
+                arg_complete, 'tcsh', choice_type2fn
+            ):
+                yield f"'{arg_type}/{arg_sel}/{complete_fn}/'"


Function complete_tcsh.get_specials refactored with the following changes:

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

Replace call to format with f-string [×2] (use-fstring-for-formatting)

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

sourcery-ai · 2022-06-21T16:01:50Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	42.09 ⛔	41.26 ⛔	-0.83 👍
Method Length	112.03 🙂	114.41 🙂	2.38 👎
Working memory	18.28 ⛔	18.29 ⛔	0.01 👎
Quality	29.44% 😞	29.51% 😞	0.07% 👍

Other metrics	Before	After	Change
Lines	1068	1126	58

Changed files	Quality Before	Quality After	Quality Change
shtab/init.py	29.44% 😞	29.51% 😞	0.07% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
shtab/init.py	get_bash_commands	78 ⛔	532 ⛔	25 ⛔	2.89% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	complete_zsh	61 ⛔	758 ⛔	27 ⛔	3.11% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	get_bash_commands.recurse	58 ⛔	478 ⛔	25 ⛔	4.52% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	complete_tcsh	53 ⛔	411 ⛔	19 ⛔	8.63% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	complete_zsh.recurse	17 🙂	213 ⛔	16 ⛔	32.81% 😞	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'

6ed6d27

sourcery-ai bot requested a review from casperdcl June 21, 2022 16:01

sourcery-ai bot commented Jun 21, 2022

View reviewed changes

casperdcl closed this Jun 21, 2022

omesser deleted the sourcery/default_complete branch April 23, 2023 21:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add `default_complete` option (Sourcery refactored) #84

add `default_complete` option (Sourcery refactored) #84

sourcery-ai bot commented Jun 21, 2022

sourcery-ai bot Jun 21, 2022

sourcery-ai bot Jun 21, 2022

sourcery-ai bot Jun 21, 2022

sourcery-ai bot Jun 21, 2022

sourcery-ai bot Jun 21, 2022

sourcery-ai bot Jun 21, 2022

sourcery-ai bot commented Jun 21, 2022

add default_complete option (Sourcery refactored) #84

add default_complete option (Sourcery refactored) #84

Conversation

sourcery-ai bot commented Jun 21, 2022

sourcery-ai bot Jun 21, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 21, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 21, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 21, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 21, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 21, 2022

Choose a reason for hiding this comment

sourcery-ai bot commented Jun 21, 2022

Sourcery Code Quality Report

Legend and Explanation

add `default_complete` option (Sourcery refactored) #84

add `default_complete` option (Sourcery refactored) #84