search

rec / safer

🧷 A safer writer 🧷
https://rec.github.io/safer/
MIT License
174 stars 9 forks source link

Work around mkdocstr issue (Sourcery refactored) #21

Closed sourcery-ai[bot] closed 1 year ago

sourcery-ai[bot] commented 1 year ago

Pull Request #20 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 front-page branch, then run:

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

Help us improve this pull request!

sourcery-ai[bot] commented 1 year ago

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 15.20 🙂 15.33 🙂 0.13 👎
Method Length 65.50 🙂 65.58 🙂 0.08 👎
Working memory 5.71 ⭐ 5.77 ⭐ 0.06 👎
Quality 55.58% 🙂 55.12% 🙂 -0.46% 👎
Other metrics Before After Change
Lines 684 683 -1
Changed files Quality Before Quality After Quality Change
safer.py 55.58% 🙂 55.12% 🙂 -0.46% 👎

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

File Function Complexity Length Working Memory Quality Recommendation
safer.py open 32 😞 329 ⛔ 16.74% ⛔ Refactor to reduce nesting. Try splitting into smaller methods
safer.py writer 28 😞 230 ⛔ 14 😞 26.91% 😞 Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
safer.py dump 24 😞 183 😞 9 🙂 41.27% 😞 Refactor to reduce nesting. Try splitting into smaller methods
safer.py _FileCloser._make_stream 7 ⭐ 137 😞 8 🙂 61.72% 🙂 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!