(chore) Type hints for abc codec `codec_id` attribute by d-v-b · Pull Request #702 · zarr-developers/numcodecs · GitHub
Skip to content

(chore) Type hints for abc codec codec_id attribute#702

Open
d-v-b wants to merge 9 commits into
zarr-developers:mainfrom
d-v-b:chore/abc_type_hints
Open

(chore) Type hints for abc codec codec_id attribute#702
d-v-b wants to merge 9 commits into
zarr-developers:mainfrom
d-v-b:chore/abc_type_hints

Conversation

@d-v-b

@d-v-b d-v-b commented Feb 9, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

I'm not sure how to type the buffer parameters. As long as we have a pickle codec, I don't think it's possible to restrict the return type of decode to anything narrower than object.

  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Docstrings and API docs for any new/modified user-facing classes and functions
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@d-v-b d-v-b changed the title (chore) Type hints for abc codec (chore) Type hints for abc codec codec_id attribute Feb 12, 2025
@d-v-b

d-v-b commented Feb 12, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@codecov

codecov Bot commented Feb 12, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (a2bdbe5) to head (c22b97f).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #702   +/-   ##
=======================================
  Coverage   99.96%   99.96%           
=======================================
  Files          63       63           
  Lines        2754     2754           
=======================================
  Hits         2753     2753           
  Misses          1        1
Files with missing lines Coverage Δ
numcodecs/abc.py 100.00% <100.00%> (ø)
numcodecs/tests/test_registry.py 100.00% <ø> (ø)

dstansby
dstansby approved these changes Feb 14, 2025
View reviewed changes

@dstansby dstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 , just one suggestion, feel free to take or leave and then merge

Comment thread numcodecs/tests/test_registry.py Outdated
@dstansby

dstansby commented Mar 1, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@dstansby dstansby dstansby approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@d-v-b @dstansby