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 #38

Closed 97gamjak closed 2 months ago

97gamjak commented 2 months ago

A general runtime-type-checking decorator is now implemented

This PR just includes this feature into the dev branch - all single public functions have to be updated accordingly

codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 75.73%. Comparing base (9375045) to head (3585a95). Report is 23 commits behind head on dev.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #38 +/- ## ========================================== - Coverage 77.10% 75.73% -1.37% ========================================== Files 118 119 +1 Lines 4166 4237 +71 ========================================== - Hits 3212 3209 -3 - Misses 954 1028 +74 ``` | [Flag](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38/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/38/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse) | `75.73% <81.70%> (-1.37%)` | :arrow_down: | | [Files](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38?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/api.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38?src=pr&el=tree&filepath=PQAnalysis%2Fanalysis%2Frdf%2Fapi.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9hbmFseXNpcy9yZGYvYXBpLnB5) | `29.03% <100.00%> (+1.44%)` | :arrow_up: | | [PQAnalysis/traj/trajectory.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38?src=pr&el=tree&filepath=PQAnalysis%2Ftraj%2Ftrajectory.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy90cmFqL3RyYWplY3RvcnkucHk=) | `100.00% <100.00%> (ø)` | | | [PQAnalysis/\_\_init\_\_.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38?src=pr&el=tree&filepath=PQAnalysis%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy9fX2luaXRfXy5weQ==) | `82.14% <75.00%> (-1.86%)` | :arrow_down: | | [PQAnalysis/utils/custom\_logging.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38?src=pr&el=tree&filepath=PQAnalysis%2Futils%2Fcustom_logging.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy91dGlscy9jdXN0b21fbG9nZ2luZy5weQ==) | `76.53% <85.71%> (+5.56%)` | :arrow_up: | | [PQAnalysis/type\_checking.py](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38?src=pr&el=tree&filepath=PQAnalysis%2Ftype_checking.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse#diff-UFFBbmFseXNpcy90eXBlX2NoZWNraW5nLnB5) | `67.56% <67.56%> (ø)` | | ... and [34 files with indirect coverage changes](https://app.codecov.io/gh/MolarVerse/PQAnalysis/pull/38/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolarVerse)
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 |6473 |38.74 |NC |NC | |docstring |7755 |46.42 |NC |NC | |comment |226 |1.35 |NC |NC | |empty |2253 |13.49 |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 |36 |NC |NC | |warning |8 |NC |NC | |error |0 |NC |NC | Messages ======== |message id |occurrences | |-----------------------------|------------| |too-many-arguments |17 | |too-many-instance-attributes |10 | |invalid-name |9 | |fixme |7 | |too-many-locals |3 | |duplicate-code |2 | |too-many-statements |1 | |too-many-return-statements |1 | |too-many-branches |1 | |too-complex |1 | |missing-module-docstring |1 | |broad-exception-raised |1 |