MolarVerse / PQAnalysis

PQAnalysis is a API/CLI python package for the analysis of MD simulations
https://molarverse.github.io/PQAnalysis/
MIT License
4 stars 2 forks source link

Feature/pylint #28

Closed 97gamjak closed 2 months ago

97gamjak commented 2 months ago

Cleaned up the entire package - no circular dependencies anymore

github-actions[bot] commented 2 months ago

PYLINT REPORT

Your code has been rated at 9.87/10

Full report Raw metrics ########### |type |number |% |previous |difference | |----------|-------|------|---------|-----------| |code |6319 |38.57 |NC |NC | |docstring |7658 |46.74 |NC |NC | |comment |201 |1.23 |NC |NC | |empty |2206 |13.46 |NC |NC | Duplication ########### | |now |previous |difference | |-------------------------|------|---------|-----------| |nb duplicated lines |0 |NC |NC | |percent duplicated lines |0.000 |NC |NC | Messages by category #################### |type |number |previous |difference | |-----------|-------|---------|-----------| |convention |10 |NC |NC | |refactor |35 |NC |NC | |warning |6 |NC |NC | |error |0 |NC |NC | Messages ######## |message id |occurrences | |-----------------------------|------------| |too-many-arguments |17 | |too-many-instance-attributes |10 | |invalid-name |9 | |fixme |6 | |too-many-locals |3 | |duplicate-code |2 | |too-many-statements |1 | |too-many-return-statements |1 | |too-complex |1 | |missing-module-docstring |1 |
codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 85.54217% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 77.17%. Comparing base (4586f1c) to head (b1923bb). Report is 2 commits behind head on dev.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #28 +/- ## ========================================== + Coverage 76.98% 77.17% +0.19% ========================================== Files 118 118 Lines 4163 4154 -9 ========================================== + Hits 3205 3206 +1 + Misses 958 948 -10 ``` | [Flag](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | `77.17% <85.54%> (+0.19%)` | :arrow_up: | | [Files](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | Coverage Δ | | |---|---|---| | [PQAnalysis/analysis/rdf/rdf.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fanalysis%2Frdf%2Frdf.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hbmFseXNpcy9yZGYvcmRmLnB5) | `36.66% <100.00%> (ø)` | | | [PQAnalysis/atomic\_system/\_decorators.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fatomic_system%2F_decorators.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hdG9taWNfc3lzdGVtL19kZWNvcmF0b3JzLnB5) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/atomic\_system/\_properties.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fatomic_system%2F_properties.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hdG9taWNfc3lzdGVtL19wcm9wZXJ0aWVzLnB5) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/cli/\_argument\_parser.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fcli%2F_argument_parser.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9jbGkvX2FyZ3VtZW50X3BhcnNlci5weQ==) | `93.61% <100.00%> (ø)` | | | [PQAnalysis/core/atom/atom.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fcore%2Fatom%2Fatom.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9jb3JlL2F0b20vYXRvbS5weQ==) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/core/atom/element.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fcore%2Fatom%2Felement.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9jb3JlL2F0b20vZWxlbWVudC5weQ==) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/core/cell/cell.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fcore%2Fcell%2Fcell.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9jb3JlL2NlbGwvY2VsbC5weQ==) | `100.00% <ø> (ø)` | | | [PQAnalysis/core/residue.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fcore%2Fresidue.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9jb3JlL3Jlc2lkdWUucHk=) | `100.00% <ø> (ø)` | | | [PQAnalysis/io/\_\_init\_\_.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fio%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9pby9fX2luaXRfXy5weQ==) | `100.00% <ø> (ø)` | | | [PQAnalysis/io/base.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree&filepath=PQAnalysis%2Fio%2Fbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9pby9iYXNlLnB5) | `100.00% <100.00%> (ø)` | | | ... and [27 more](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/28/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse)