Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotating netsgiro 9/9: Make package PEP 561-compatible by adding py.typed #68

Merged
merged 2 commits into from
Apr 20, 2022

Conversation

sondrelg
Copy link
Contributor

@sondrelg sondrelg commented Apr 19, 2022

Relates to #14

https://peps.python.org/pep-0561/

https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages

Adding a py.typed file tells type checkers (e.g., mypy) to use the new type hints.

@codecov
Copy link

codecov bot commented Apr 19, 2022

Codecov Report

Merging #68 (490fe9e) into master (2637c29) will decrease coverage by 0.31%.
The diff coverage is 96.07%.

❗ Current head 490fe9e differs from pull request most recent head 2d252dd. Consider uploading reports for the commit 2d252dd to get more accurate results

@@            Coverage Diff             @@
##           master      #68      +/-   ##
==========================================
- Coverage   95.76%   95.45%   -0.32%     
==========================================
  Files           7        7              
  Lines         567      572       +5     
  Branches       94       94              
==========================================
+ Hits          543      546       +3     
- Misses         13       15       +2     
  Partials       11       11              
Impacted Files Coverage Δ
netsgiro/records.py 93.87% <94.52%> (ø)
netsgiro/objects.py 96.16% <96.92%> (+0.01%) ⬆️
netsgiro/converters.py 91.48% <100.00%> (-3.86%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 09d501e...2d252dd. Read the comment docs.

@sondrelg sondrelg changed the title chore: Make package PEP 561-compatible by adding py.typed Make package PEP 561-compatible by adding py.typed Apr 19, 2022
@sondrelg sondrelg changed the title Make package PEP 561-compatible by adding py.typed Annotating netsgiro 9/9: Make package PEP 561-compatible by adding py.typed Apr 19, 2022
@sondrelg sondrelg force-pushed the sondrelg/finish-type-checking branch from 29183e1 to ec6c708 Compare April 20, 2022 08:33
Base automatically changed from sondrelg/finish-type-checking to master April 20, 2022 08:34
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 20, 2022

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics Before After Change
Complexity 1.53 ⭐ 1.53 ⭐ 0.00
Method Length 18.40 ⭐ 18.40 ⭐ 0.00
Working memory 3.60 ⭐ 3.60 ⭐ 0.00
Quality 94.25% 94.25% 0.00%
Other metrics Before After Change
Lines 88 88 0
Changed files Quality Before Quality After Quality Change
netsgiro/converters.py 94.25% ⭐ 94.25% ⭐ 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation

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!

@sondrelg sondrelg merged commit 203ebc5 into master Apr 20, 2022
@sondrelg sondrelg deleted the sondrelg/typed branch April 20, 2022 08:35
@sondrelg sondrelg mentioned this pull request Apr 20, 2022
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant