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

Nitpicky true and typing overhaul #135

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Nitpicky true and typing overhaul #135

wants to merge 8 commits into from

Conversation

JoshuaAppleby
Copy link
Contributor

@JoshuaAppleby JoshuaAppleby commented Apr 13, 2023

Nitpicky = True
Add typehinting where possible, including the addition of AugmentedType and AugmentedValue, modelled off of the responses from cothread.
Doc strings have been improved in some places.

Cast typing has been used alongside appropriate comments to reduce changes to code.

Currently does not work for python 3.7 due to SupportsIndex being added in 3.8. Attempts were made at importing SupportsIndex via typing_extensions, but this introduces a metaclass creation error when running CI.

Additionally, cothread_cs.py does not show in the API, as otherwise cothread would have to become a dependency.

@JoshuaAppleby JoshuaAppleby self-assigned this Apr 13, 2023
@codecov
Copy link

codecov bot commented Apr 13, 2023

Codecov Report

Merging #135 (2637548) into main (7411792) will decrease coverage by 0.26%.
Report is 2 commits behind head on main.
The diff coverage is 99.24%.

@@            Coverage Diff             @@
##             main     #135      +/-   ##
==========================================
- Coverage   99.47%   99.21%   -0.26%     
==========================================
  Files          12       12              
  Lines         764      895     +131     
==========================================
+ Hits          760      888     +128     
- Misses          4        7       +3     
Files Changed Coverage Δ
src/pytac/cs.py 93.75% <90.90%> (-6.25%) ⬇️
src/pytac/element.py 98.34% <97.67%> (-0.64%) ⬇️
src/pytac/cothread_cs.py 100.00% <100.00%> (ø)
src/pytac/data_source.py 100.00% <100.00%> (ø)
src/pytac/device.py 100.00% <100.00%> (ø)
src/pytac/lattice.py 99.50% <100.00%> (+0.06%) ⬆️
src/pytac/load_csv.py 100.00% <100.00%> (ø)
src/pytac/units.py 98.54% <100.00%> (+0.24%) ⬆️
src/pytac/utils.py 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@JoshuaAppleby JoshuaAppleby removed their assignment Aug 29, 2023
@JoshuaAppleby JoshuaAppleby changed the title Nitpicky true, update typing Nitpicky true and typing overhaul Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant