search

avendesora / pythonbible

A python library for validating, parsing, normalizing scripture references and retrieving scripture texts (for open source and public domain versions)
https://docs.python.bible
MIT License
60 stars 12 forks source link

Set up precommit (Sourcery refactored) #61

Closed sourcery-ai[bot] closed 2 years ago

sourcery-ai[bot] commented 2 years ago

Pull Request #59 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 set_up_precommit branch, then run:

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

Help us improve this pull request!

sourcery-ai[bot] commented 2 years ago

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 5.38 ⭐ 5.35 ⭐ -0.03 👍
Method Length 83.95 🙂 83.89 🙂 -0.06 👍
Working memory 7.06 🙂 7.03 🙂 -0.03 👍
Quality 76.18% ⭐ 76.34% ⭐ 0.16% 👍
Other metrics Before After Change
Lines 2135 2129 -6
Changed files Quality Before Quality After Quality Change
pythonbible/formatter.py 74.80% 🙂 74.97% 🙂 0.17% 👍
pythonbible/verses.py 86.26% ⭐ 86.26% ⭐ 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation
pythonbible/formatter.py _format_scripture_text_verse_by_verse 13 🙂 109 🙂 15 😞 47.54% 😞 Extract out complex expressions
pythonbible/formatter.py format_single_reference 9 🙂 101 🙂 11 😞 58.18% 🙂 Extract out complex expressions
pythonbible/verses.py __generate_verse_ids 0 ⭐ 58 ⭐ 14 😞 68.60% 🙂 Extract out complex expressions

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!