sourcery-ai[bot]
commented
2 years ago Sourcery Code Quality Report
❌ Merging this PR will decrease code quality in the affected files by 0.37%.
| Quality metrics | Before | After | Change |
|---|---|---|---|
| Complexity | 1.55 ⭐ | 1.69 ⭐ | 0.14 👎 |
| Method Length | 53.30 ⭐ | 49.58 ⭐ | -3.72 👍 |
| Working memory | 5.80 ⭐ | 6.00 ⭐ | 0.20 👎 |
| Quality | 80.70% ⭐ | 80.33% ⭐ | -0.37% 👎 |
| Other metrics | Before | After | Change |
|---|---|---|---|
| Lines | 3959 | 3824 | -135 |
| Changed files | Quality Before | Quality After | Quality Change |
|---|---|---|---|
| dodo.py | 92.70% ⭐ | 92.70% ⭐ | 0.00% |
| noxfile.py | % | 86.69% ⭐ | % |
| .test_calcipy_project/dodo.py | 92.70% ⭐ | 92.70% ⭐ | 0.00% |
| calcipy/init.py | 96.68% ⭐ | 96.68% ⭐ | 0.00% |
| calcipy/code_tag_collector.py | 59.10% 🙂 | 57.97% 🙂 | -1.13% 👎 |
| calcipy/dot_dict.py | 93.59% ⭐ | 93.59% ⭐ | 0.00% |
| calcipy/file_helpers.py | 83.28% ⭐ | 83.29% ⭐ | 0.01% 👍 |
| calcipy/file_search.py | 81.08% ⭐ | 81.01% ⭐ | -0.07% 👎 |
| calcipy/log_helpers.py | 77.04% ⭐ | 72.66% 🙂 | -4.38% 👎 |
| calcipy/proc_helpers.py | 61.61% 🙂 | 59.68% 🙂 | -1.93% 👎 |
| calcipy/cli/main.py | 72.31% 🙂 | 72.31% 🙂 | 0.00% |
| calcipy/cli/controllers/code_tag_collector_controller.py | 66.13% 🙂 | 66.33% 🙂 | 0.20% 👍 |
| calcipy/cli/core/version.py | 96.79% ⭐ | 96.57% ⭐ | -0.22% 👎 |
| calcipy/dev/conftest.py | 89.39% ⭐ | 89.39% ⭐ | 0.00% |
| calcipy/dev/noxfile.py | 82.20% ⭐ | 81.97% ⭐ | -0.23% 👎 |
| calcipy/doit_tasks/init.py | 68.20% 🙂 | 79.31% ⭐ | 11.11% 👍 |
| calcipy/doit_tasks/base.py | 87.47% ⭐ | 87.44% ⭐ | -0.03% 👎 |
| calcipy/doit_tasks/code_tags.py | 84.55% ⭐ | 84.70% ⭐ | 0.15% 👍 |
| calcipy/doit_tasks/doc.py | 80.00% ⭐ | 80.27% ⭐ | 0.27% 👍 |
| calcipy/doit_tasks/doit_globals.py | 79.01% ⭐ | 79.18% ⭐ | 0.17% 👍 |
| calcipy/doit_tasks/lint.py | 78.95% ⭐ | 78.47% ⭐ | -0.48% 👎 |
| calcipy/doit_tasks/packaging.py | 79.87% ⭐ | 79.22% ⭐ | -0.65% 👎 |
| calcipy/doit_tasks/summary_reporter.py | 87.09% ⭐ | 86.51% ⭐ | -0.58% 👎 |
| calcipy/doit_tasks/test.py | 88.69% ⭐ | 87.43% ⭐ | -1.26% 👎 |
| scripts/check_imports.py | 89.49% ⭐ | 89.49% ⭐ | 0.00% |
| tests/conftest.py | 95.98% ⭐ | 96.16% ⭐ | 0.18% 👍 |
| tests/test_dot_dict.py | 83.94% ⭐ | 84.17% ⭐ | 0.23% 👍 |
| tests/test_doit_tasks/test_code_tags.py | 96.35% ⭐ | 98.67% ⭐ | 2.32% 👍 |
| tests/test_doit_tasks/test_doc.py | 84.84% ⭐ | 84.77% ⭐ | -0.07% 👎 |
| tests/test_doit_tasks/test_lint.py | 85.19% ⭐ | 97.21% ⭐ | 12.02% 👍 |
| tests/test_doit_tasks/test_packaging.py | 83.67% ⭐ | 83.73% ⭐ | 0.06% 👍 |
| tests/test_doit_tasks/test_test.py | 91.97% ⭐ | 99.00% ⭐ | 7.03% 👍 |
| tests/test_doit_tasks/test_wildcard.py | 87.49% ⭐ | 87.65% ⭐ | 0.16% 👍 |
Here are some functions in these files that still need a tune-up:
| File | Function | Complexity | Length | Working Memory | Quality | Recommendation |
|---|---|---|---|---|---|---|
| calcipy/code_tag_collector.py | _format_record | 8 ⭐ | 283 ⛔ | 16 ⛔ | 36.97% 😞 | Try splitting into smaller methods. Extract out complex expressions |
| calcipy/doit_tasks/doc.py | _ReplacementMachine._parse_line | 10 🙂 | 124 😞 | 13 😞 | 50.98% 🙂 | Try splitting into smaller methods. Extract out complex expressions |
| calcipy/code_tag_collector.py | _format_report | 9 🙂 | 160 😞 | 10 😞 | 53.11% 🙂 | Try splitting into smaller methods. Extract out complex expressions |
| calcipy/doit_tasks/doit_globals.py | PackageMeta.__post_init__ | 5 ⭐ | 174 😞 | 9 🙂 | 57.66% 🙂 | Try splitting into smaller methods |
| calcipy/doit_tasks/packaging.py | _check_for_stale_packages | 6 ⭐ | 164 😞 | 58.75% 🙂 | Try splitting into smaller methods |
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!
FIxes #102