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

fix: harden typing in the code base; add pre-commit check; improve docs #383

Merged
merged 10 commits into from
Oct 12, 2023

Conversation

douglasdavis
Copy link
Collaborator

@douglasdavis douglasdavis commented Oct 9, 2023

  • fix various existing typing errors
  • require mypy check with pre-commit
  • add developer docs explaining that while typing is not a requirement in dask-awkward, if it's used in a signature we want to make sure it's checked

we've always had type hints throughout dask-awkward but it's never been formalized, this PR aims to clarify typing in the project.

@douglasdavis douglasdavis marked this pull request as draft October 9, 2023 18:02
@codecov-commenter
Copy link

codecov-commenter commented Oct 9, 2023

Codecov Report

Merging #383 (3d68678) into main (8c9ff67) will decrease coverage by 0.72%.
The diff coverage is 94.44%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##             main     #383      +/-   ##
==========================================
- Coverage   93.21%   92.50%   -0.72%     
==========================================
  Files          24       24              
  Lines        3038     3043       +5     
==========================================
- Hits         2832     2815      -17     
- Misses        206      228      +22     
Files Coverage Δ
src/dask_awkward/layers/layers.py 92.43% <100.00%> (ø)
src/dask_awkward/lib/core.py 92.71% <100.00%> (-0.01%) ⬇️
src/dask_awkward/lib/io/columnar.py 100.00% <100.00%> (ø)
src/dask_awkward/lib/io/json.py 88.70% <100.00%> (ø)
src/dask_awkward/lib/io/parquet.py 94.30% <100.00%> (ø)
src/dask_awkward/lib/optimize.py 96.41% <ø> (ø)
src/dask_awkward/lib/utils.py 87.50% <100.00%> (+0.14%) ⬆️
src/dask_awkward/lib/inspect.py 58.66% <71.42%> (+0.92%) ⬆️

... and 1 file with indirect coverage changes

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

@douglasdavis douglasdavis marked this pull request as ready for review October 12, 2023 15:11
@douglasdavis douglasdavis merged commit a1b24fc into dask-contrib:main Oct 12, 2023
18 of 21 checks passed
@douglasdavis douglasdavis deleted the misc-typing-fixes branch October 12, 2023 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants