Add stubs

[flying-sheep]

TODO:

• figure out how to automatically generate the stubs when building

Eventually we should also get Jij-Inc/pyo3-stub-gen#102 merged and released, but that’s not important, as we will publish to PyPI and not to crates.io

[flying-sheep]

I wonder why that worked. In #37, you made it so there are two Rust libraries called zarrs, which should be impossible.

[ilan-gold]

That's a good point.

[flying-sheep]

The generated file looks like this:

# This file is automatically generated by pyo3_stub_gen
# ruff: noqa: E501, F401

import numpy
import numpy.typing
import typing

class CodecPipelineImpl:
    def __new__(cls,metadata,validate_checksums = ...,store_empty_chunks = ...,concurrent_target = ...): ...
    def retrieve_chunks_and_apply_index(self, chunk_descriptions:typing.Sequence[tuple[tuple[str, typing.Sequence[int], str, typing.Sequence[int]], typing.Sequence[slice], typing.Sequence[slice]]], value:numpy.NDArray[typing.Any], chunk_concurrent_limit:int) -> None:
        ...

    def retrieve_chunks(self, chunk_descriptions:typing.Sequence[tuple[str, typing.Sequence[int], str, typing.Sequence[int]]], chunk_concurrent_limit:int) -> list[numpy.typing.NDArray[numpy.uint8]]:
        ...

    def store_chunks_with_indices(self, chunk_descriptions:typing.Sequence[tuple[tuple[str, typing.Sequence[int], str, typing.Sequence[int]], typing.Sequence[slice], typing.Sequence[slice]]], value:numpy.NDArray[typing.Any], chunk_concurrent_limit:int) -> None:
        ...

The type inference for __new__ doesn‘t work because we use #[pyo3(signature=...)]: Jij-Inc/pyo3-stub-gen#82

[ilan-gold]

Could you add to docs how to use this? In contributing.md?