iterative / shtab

↔️ Automagic shell tab completion for Python CLI applications
https://docs.iterative.ai/shtab
Other
375 stars 34 forks source link

Fix typos (Sourcery refactored) #97

Closed sourcery-ai[bot] closed 2 years ago

sourcery-ai[bot] commented 2 years ago

Pull Request #96 refactored by Sourcery.

Since the original Pull Request was opened as a fork in a contributor's repository, we are unable to create a Pull Request branching from it.

To incorporate these changes, you can either:

  1. Merge this Pull Request instead of the original, or

  2. Ask your contributor to locally incorporate these commits and push them to the original Pull Request

    Incorporate changes via command line
    git fetch https://github.com/iterative/shtab pull/96/head
    git merge --ff-only FETCH_HEAD
    git push

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:

Help us improve this pull request!

sourcery-ai[bot] commented 2 years ago

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 27.91 😞 27.91 😞 0.00
Method Length 101.07 πŸ™‚ 101.23 πŸ™‚ 0.16 πŸ‘Ž
Working memory 3.71 ⭐ 3.72 ⭐ 0.01 πŸ‘Ž
Quality 46.86% 😞 46.83% 😞 -0.03% πŸ‘Ž
Other metrics Before After Change
Lines 1044 1051 7
Changed files Quality Before Quality After Quality Change
shtab/init.py 25.89% 😞 25.88% 😞 -0.01% πŸ‘Ž
shtab/main.py 70.21% πŸ™‚ 70.17% πŸ™‚ -0.04% πŸ‘Ž
tests/test_shtab.py 76.67% ⭐ 76.60% ⭐ -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 β›” 590 β›” 1.22% β›” Refactor to reduce nesting. Try splitting into smaller methods
shtab/init.py complete_zsh 62 β›” 901 β›” 2.38% β›” Refactor to reduce nesting. Try splitting into smaller methods
shtab/init.py complete_tcsh 53 β›” 470 β›” 4.99% β›” Refactor to reduce nesting. Try splitting into smaller methods
tests/test_shtab.py test_add_argument_to_positional 1 ⭐ 171 😞 9 πŸ™‚ 61.90% πŸ™‚ Try splitting into smaller methods
shtab/main.py main 8 ⭐ 148 😞 7 πŸ™‚ 61.90% πŸ™‚ Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

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!

codecov-commenter commented 2 years ago

Codecov Report

Merging #97 (c553e4d) into master (4c0170c) will not change coverage. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master      #97   +/-   ##
=======================================
  Coverage   91.04%   91.04%           
=======================================
  Files           3        3           
  Lines         335      335           
=======================================
  Hits          305      305           
  Misses         30       30           
Impacted Files Coverage Ξ”
shtab/__init__.py 93.75% <100.00%> (ΓΈ)
shtab/main.py 87.50% <100.00%> (ΓΈ)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

peternewman commented 2 years ago

Preceded by @luzpaz #96