search

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/beartype exceptions #48

Closed 97gamjak closed 1 month ago

97gamjak commented 1 month ago

Introduced runtime-checking for core and atomicSystem module.

Now tests work with pytest.sh for RELEASE and DEBUG version (including or excluding beartype)

Furthermore, now every PQAnalysis internal exception has to inherit from PQException

github-actions[bot] commented 1 month ago

PYLINT REPORT

Your code has been rated at 9.86/10 (previous run: 9.88/10, -0.02)

Full report Raw metrics =========== |type |number |% |previous |difference | |----------|-------|------|---------|-----------| |code |6789 |39.18 |6651 |+138.00 | |docstring |7921 |45.71 |7881 |+40.00 | |comment |269 |1.55 |265 |+4.00 | |empty |2349 |13.56 |2320 |+29.00 | Duplication =========== | |now |previous |difference | |-------------------------|------|---------|-----------| |nb duplicated lines |0 |0 |0 | |percent duplicated lines |0.000 |0.000 |= | Messages by category ==================== |type |number |previous |difference | |-----------|-------|---------|-----------| |convention |0 |0 |0 | |refactor |43 |42 |42 | |warning |16 |9 |9 | |error |0 |0 |0 | Messages ======== |message id |occurrences | |-----------------------------|------------| |too-many-arguments |18 | |too-many-instance-attributes |10 | |fixme |10 | |duplicate-code |4 | |too-many-locals |3 | |too-complex |3 | |unused-argument |2 | |too-many-branches |2 | |protected-access |2 | |unused-import |1 | |too-many-statements |1 | |too-many-return-statements |1 | |too-many-public-methods |1 | |broad-exception-raised |1 |
codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 80.23%. Comparing base (55bad1f) to head (84cb3a9). Report is 2 commits behind head on dev.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #48 +/- ## ========================================== + Coverage 78.58% 80.23% +1.64% ========================================== Files 119 119 Lines 4334 4411 +77 ========================================== + Hits 3406 3539 +133 + Misses 928 872 -56 ``` | [Flag](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48/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/48/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | `80.23% <95.90%> (+1.64%)` | :arrow_up: | | [Files](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?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/48?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) | `77.24% <ø> (ø)` | | | [PQAnalysis/atomic\_system/\_decorators.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?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/\_positions.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?src=pr&el=tree&filepath=PQAnalysis%2Fatomic_system%2F_positions.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hdG9taWNfc3lzdGVtL19wb3NpdGlvbnMucHk=) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/atomic\_system/\_properties.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?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%> (+2.12%)` | :arrow_up: | | [PQAnalysis/atomic\_system/\_standard\_properties.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?src=pr&el=tree&filepath=PQAnalysis%2Fatomic_system%2F_standard_properties.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hdG9taWNfc3lzdGVtL19zdGFuZGFyZF9wcm9wZXJ0aWVzLnB5) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/atomic\_system/atomic\_system.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?src=pr&el=tree&filepath=PQAnalysis%2Fatomic_system%2Fatomic_system.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hdG9taWNfc3lzdGVtL2F0b21pY19zeXN0ZW0ucHk=) | `67.85% <100.00%> (+1.69%)` | :arrow_up: | | [PQAnalysis/atomic\_system/exceptions.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?src=pr&el=tree&filepath=PQAnalysis%2Fatomic_system%2Fexceptions.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hdG9taWNfc3lzdGVtL2V4Y2VwdGlvbnMucHk=) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/core/api.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?src=pr&el=tree&filepath=PQAnalysis%2Fcore%2Fapi.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9jb3JlL2FwaS5weQ==) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/core/atom/atom.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?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%> (+1.88%)` | :arrow_up: | | [PQAnalysis/core/atom/element.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?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%> (ø)` | | | ... and [10 more](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | | ... and [30 files with indirect coverage changes](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/48/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse)