fix bash completion with space (Sourcery refactored) #82

sourcery-ai · 2022-06-17T13:02:02Z

Pull Request #81 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 fix-spaces branch, then run:

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

Help us improve this pull request!

sourcery-ai · 2022-06-17T13:02:12Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	30.54 😞	30.27 😞	-0.27 👍
Method Length	87.98 🙂	89.62 🙂	1.64 👎
Working memory	15.03 😞	15.01 😞	-0.02 👍
Quality	43.25% 😞	43.29% 😞	0.04% 👍

Other metrics	Before	After	Change
Lines	1284	1339	55

Changed files	Quality Before	Quality After	Quality Change
shtab/init.py	29.55% 😞	29.52% 😞	-0.03% 👎
tests/test_shtab.py	78.96% ⭐	78.86% ⭐	-0.10% 👎

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 ⛔	527 ⛔	25 ⛔	2.91% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	complete_zsh	61 ⛔	756 ⛔	27 ⛔	3.11% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	get_bash_commands.recurse	58 ⛔	474 ⛔	25 ⛔	4.55% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
shtab/init.py	complete_tcsh	53 ⛔	407 ⛔	19 ⛔	8.68% ⛔	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!

sourcery-ai · 2022-06-17T13:31:18Z

shtab/__init__.py

@@ -161,7 +161,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)

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-17T13:31:18Z

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-17T13:31:18Z

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 "",
+            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 "",


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-17T13:31:19Z

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-17T13:31:19Z

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-17T13:31:19Z

shtab/__init__.py

-            yield "'{}/{}/({})/'".format(
-                arg_type,
-                arg_sel,
-                choice_strs,
-            )
+            yield f"'{arg_type}/{arg_sel}/({choice_strs})/'"
        elif hasattr(arg, "complete"):
-            complete_fn = complete2pattern(arg.complete, 'tcsh', choice_type2fn)
-            if complete_fn:
-                yield "'{}/{}/{}/'".format(
-                    arg_type,
-                    arg_sel,
-                    complete_fn,
-                )
+            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:

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

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

sourcery-ai · 2022-06-17T13:31:19Z

tests/test_shtab.py

-        assert (0 == proc.wait() and not stdout and not stderr), """\
+        assert (
+            proc.wait() == 0 and not stdout and not stderr
+        ), """\
 {}
 {}
 === stdout ===
 {}=== stderr ===
-{}""".format(failure_message, cmd, stdout or "", stderr or "")
+{}""".format(
+            failure_message, cmd, stdout or "", stderr or ""
+        )


Function Bash.test refactored with the following changes:

Ensure constant in comparison is on the right (flip-comparison)

sourcery-ai · 2022-06-17T13:31:19Z

tests/test_shtab.py

-            '"$(echo $(compgen {} -- "{}"))" = "{}"'.format(compgen_cmd, word,
-                                                            expected_completions),
+            f'"$(echo $(compgen {compgen_cmd} -- "{word}"))" = "{expected_completions}"',


Function Bash.compgen refactored with the following changes:

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

sourcery-ai bot requested a review from casperdcl June 17, 2022 13:02

casperdcl force-pushed the fix-spaces branch from 1f9af57 to 4eb2c0d Compare June 17, 2022 13:26

sourcery-ai bot force-pushed the sourcery/fix-spaces branch from dd16867 to 896d2f7 Compare June 17, 2022 13:27

casperdcl force-pushed the fix-spaces branch from 4eb2c0d to b0b6d53 Compare June 17, 2022 13:30

'Refactored by Sourcery'

ee900af

sourcery-ai bot force-pushed the sourcery/fix-spaces branch from 896d2f7 to ee900af Compare June 17, 2022 13:31

sourcery-ai bot commented Jun 17, 2022

View reviewed changes

casperdcl closed this Jun 17, 2022

casperdcl deleted the sourcery/fix-spaces branch November 2, 2022 15:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix bash completion with space (Sourcery refactored) #82

fix bash completion with space (Sourcery refactored) #82

sourcery-ai bot commented Jun 17, 2022 •

edited

Loading

sourcery-ai bot commented Jun 17, 2022 •

edited

Loading

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

sourcery-ai bot Jun 17, 2022

fix bash completion with space (Sourcery refactored) #82

fix bash completion with space (Sourcery refactored) #82

Conversation

sourcery-ai bot commented Jun 17, 2022 • edited Loading

sourcery-ai bot commented Jun 17, 2022 • edited Loading

Sourcery Code Quality Report

Legend and Explanation

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot Jun 17, 2022

Choose a reason for hiding this comment

sourcery-ai bot commented Jun 17, 2022 •

edited

Loading

sourcery-ai bot commented Jun 17, 2022 •

edited

Loading