Add type hints to zarr.create

[dstansby]

This PR adds type hints to zarr.creation.create().

I couldn't find any discussion of adding type hints to zarr in the issues or discussion forums, so not sure if this is welcome - I would definitely personally find it helpful to have type hints throughout the codebase, and would be happy to chip away at adding them if they are. But definitely understand if it would be useful to have a wider discussion separate to this PR about adding type hinting to zarr before going any further.

TODO:

• Add unit tests and/or doctests in docstrings
• Add docstrings and API docs for any new/modified user-facing classes and functions
• New/modified features documented in docs/tutorial.rst
• Changes documented in docs/release.rst
• GitHub Actions have all passed
• Test coverage is 100% (Codecov passes)

[d-v-b]

I like this! I left some comments. Having started one of these "add types to zarr" endeavors before, I understand that it can feel unbounded, so I respect your restraint in only adding types where you did :)

[d-v-b]

👍

[d-v-b]

any objections to merging this?

[d-v-b]

I'm kicking off the gha workflows, assuming those pass I'm going to merge this unless there are any objections.

[codecov]

Codecov Report

Merging #1536 (73cedea) into main (cf32382) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1536      +/-   ##
==========================================
- Coverage   99.99%   99.99%   -0.01%     
==========================================
  Files          37       38       +1     
  Lines       14738    14599     -139     
==========================================
- Hits        14737    14598     -139     
  Misses          1        1              

Files	Coverage Δ
zarr/_storage/store.py	100.00% <100.00%> (ø)
zarr/creation.py	100.00% <100.00%> (ø)
zarr/storage.py	100.00% <100.00%> (ø)
zarr/sync.py	100.00% <100.00%> (ø)
zarr/tests/test_core.py	99.94% <100.00%> (-0.01%)	⬇️
zarr/types.py	100.00% <100.00%> (ø)
zarr/util.py	100.00% <100.00%> (ø)

... and 8 files with indirect coverage changes

[joshmoore]

I know that @d-v-b and I tend to be fans, but this feels like something that others may want to take a look. Anyone want us to hold merging, @zarr-developers/python-core-devs?

[d-v-b]

Since this doesnt affect runtime at all, I think its safe to merge this.

[joshmoore]

It is adding a new public module though. I would give it until next week following https://github.com/zarr-developers/governance/blob/main/GOVERNANCE.md#decision-making-process

[joshmoore]

Thoughts welcome on how to make codecov happy with these lines.

[d-v-b]

I couldn't find anything obvious in https://docs.codecov.com/docs/ignoring-paths, seems like it only has per-file granularity. Since we know the decrease in coverage isn't meaningful, I'd be fine ignoring it here. In the future maybe we put protocols in types.py (either a module-local one, or a zarr-wide one) and tell codecov to ignore it.

[dstansby]

I've updated the code coverage config to ignore lines that are "...".

[d-v-b]

good idea!

[jhamman]

@d-v-b - if you are happy here, would you mind giving this a merge?

Thanks @dstansby for the contribution here. FYI - we're planning much deeper type coverage for v3, if you are up to help in that effort, your contributions would be more than welcome (#1593, etc.).

[d-v-b]

thanks @dstansby! and please feel free to dive in to the v3 effort!