search

torressa / cspy

A collection of algorithms for the (Resource) Constrained Shortest Path problem in Python / C++ / C#
https://torressa.github.io/cspy/
MIT License
77 stars 24 forks source link

PSOLGENT improvements (Sourcery refactored) #84

Closed sourcery-ai[bot] closed 2 years ago

sourcery-ai[bot] commented 3 years ago

Pull Request #80 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/torressa/cspy pull/80/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 3 years ago

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 4.26 ⭐ 4.86 ⭐ 0.60 👎
Method Length 55.81 ⭐ 63.55 🙂 7.74 👎
Working memory 9.61 🙂 11.23 😞 1.62 👎
Quality 70.29% 🙂 65.09% 🙂 -5.20% 👎
Other metrics Before After Change
Lines 585 665 80
Changed files Quality Before Quality After Quality Change
src/python/algorithms/grasp.py 74.86% 🙂 70.37% 🙂 -4.49% 👎
src/python/algorithms/path_base.py 67.32% 🙂 67.39% 🙂 0.07% 👍
src/python/algorithms/psolgent.py 69.42% 🙂 61.37% 🙂 -8.05% 👎

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

File Function Complexity Length Working Memory Quality Recommendation
src/python/algorithms/psolgent.py PSOLGENT._update_best 4 ⭐ 240 ⛔ 22 ⛔ 38.47% 😞 Try splitting into smaller methods. Extract out complex expressions
src/python/algorithms/psolgent.py PSOLGENT.__init__ 1 ⭐ 172 😞 28 ⛔ 44.55% 😞 Try splitting into smaller methods. Extract out complex expressions
src/python/algorithms/path_base.py PathBase.get_simple_path 13 🙂 155 😞 12 😞 46.39% 😞 Try splitting into smaller methods. Extract out complex expressions
src/python/algorithms/psolgent.py PSOLGENT.run 10 🙂 191 😞 11 😞 47.50% 😞 Try splitting into smaller methods. Extract out complex expressions
src/python/algorithms/path_base.py PathBase.check_feasibility 12 🙂 156 😞 9 🙂 52.85% 🙂 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!