pax_global_header00006660000000000000000000000064152326762000014515gustar00rootroot0000000000000052 comment=53e6dc66b834988912194985a1051ad4db4f0141 zarr-python-3.3.0/000077500000000000000000000000001523267620000140155ustar00rootroot00000000000000zarr-python-3.3.0/.git-blame-ignore-revs000066400000000000000000000002321523267620000201120ustar00rootroot00000000000000# lint codebase with black and ruff 4e348d6b80c96da461fd866576c971b8a659ba15 # migrate from black to ruff format 22cea005629913208a85799372e045f353744add zarr-python-3.3.0/.git_archival.txt000066400000000000000000000002011523267620000172610ustar00rootroot00000000000000node: 53e6dc66b834988912194985a1051ad4db4f0141 node-date: 2026-07-30T18:32:00+02:00 describe-name: v3.3.0 ref-names: tag: v3.3.0 zarr-python-3.3.0/.gitattributes000066400000000000000000000001341523267620000167060ustar00rootroot00000000000000*.py linguist-language=python *.ipynb linguist-documentation .git_archival.txt export-subst zarr-python-3.3.0/.github/000077500000000000000000000000001523267620000153555ustar00rootroot00000000000000zarr-python-3.3.0/.github/CODEOWNERS000066400000000000000000000000701523267620000167450ustar00rootroot00000000000000zarr/_storage/absstore.py @zarr-developers/azure-team zarr-python-3.3.0/.github/CONTRIBUTING.md000066400000000000000000000002621523267620000176060ustar00rootroot00000000000000Contributing ============ Please see the [project documentation](https://zarr.readthedocs.io/en/stable/developers/contributing.html) for information about contributing to Zarr. zarr-python-3.3.0/.github/ISSUE_TEMPLATE/000077500000000000000000000000001523267620000175405ustar00rootroot00000000000000zarr-python-3.3.0/.github/ISSUE_TEMPLATE/bug_report.yml000066400000000000000000000051331523267620000224350ustar00rootroot00000000000000name: Bug Report description: Report incorrect behaviour in the library. labels: ["bug"] body: - type: markdown attributes: value: | Please provide the following information. - type: input id: Zarr-version attributes: label: Zarr version description: Value of ``zarr.__version__`` placeholder: v2.10.2, v2.11.3, v2.12.0, etc. validations: required: true - type: input id: Numcodecs-version attributes: label: Numcodecs version description: Value of ``numcodecs.__version__`` placeholder: v0.8.1, v0.9.0, v0.10.0, etc. validations: required: true - type: input id: Python-version attributes: label: Python Version description: Version of Python interpreter placeholder: 3.10, 3.11, 3.12 etc. validations: required: true - type: input id: OS attributes: label: Operating System description: Operating System placeholder: (Linux/Windows/Mac) validations: required: true - type: input id: installation attributes: label: Installation description: How was Zarr installed? placeholder: e.g., "using pip into virtual environment", or "using conda" validations: required: true - type: textarea id: description attributes: label: Description description: Explain why the current behavior is a problem, what the expected output/behaviour is, and why the expected output/behaviour is a better solution. validations: required: true - type: textarea id: reproduce attributes: label: Steps to reproduce description: Minimal, reproducible code sample. Must list dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). When put in a file named `issue.py` calling `uv run issue.py` should show the issue. value: | ```python # /// script # requires-python = ">=3.12" # dependencies = [ # "zarr@git+https://github.com/zarr-developers/zarr-python.git@main", # ] # /// # # This script automatically imports the development branch of zarr to check for issues import zarr # your reproducer code # zarr.print_debug_info() ``` validations: required: true - type: textarea id: additional-output attributes: label: Additional output description: If you think it might be relevant, please provide the output from ``pip freeze`` or ``conda env export`` depending on which was used to install Zarr. zarr-python-3.3.0/.github/ISSUE_TEMPLATE/config.yml000066400000000000000000000012221523267620000215250ustar00rootroot00000000000000blank_issues_enabled: true contact_links: - name: Propose a new Zarr specification feature url: https://github.com/zarr-developers/zarr-specs about: A new feature for the Zarr storage specification should be opened on the zarr-specs repository. - name: Discuss something on ZulipChat url: https://ossci.zulipchat.com/ about: For questions like "How do I do X with Zarr?", consider posting your question to our developer chat. - name: Discuss something on GitHub Discussions url: https://github.com/zarr-developers/zarr-python/discussions about: For questions like "How do I do X with Zarr?", you can move to GitHub Discussions. zarr-python-3.3.0/.github/ISSUE_TEMPLATE/documentation.yml000066400000000000000000000012021523267620000231270ustar00rootroot00000000000000name: Documentation Improvement description: Report missing or wrong documentation. Alternatively, you can just open a pull request with the suggested change. title: "DOC: " labels: [documentation, help wanted] body: - type: textarea attributes: label: Describe the issue linked to the documentation description: > Please provide a description of what documentation you believe needs to be fixed/improved. validations: required: true - type: textarea attributes: label: Suggested fix for documentation description: > Please explain the suggested fix and why it's better than the existing documentation. zarr-python-3.3.0/.github/ISSUE_TEMPLATE/feature_request.yml000066400000000000000000000005111523267620000234630ustar00rootroot00000000000000name: Feature Request description: Request a new feature for zarr-python # labels: [] body: - type: textarea attributes: label: Describe the new feature you'd like description: > Please provide a description of what new feature or functionality you'd like to see in zarr-python. validations: required: true zarr-python-3.3.0/.github/ISSUE_TEMPLATE/release-checklist.md000066400000000000000000000057061523267620000234610ustar00rootroot00000000000000--- name: Zarr-Python release checklist about: Checklist for a new Zarr-Python release. [For project maintainers only!] title: Release Zarr-Python vX.Y.Z labels: release-checklist assignees: '' --- **Release**: [v3.x.x](https://github.com/zarr-developers/zarr-python/milestones/?) **Scheduled Date**: 20YY/MM/DD **Priority PRs/issues to complete prior to release** - [ ] Priority pull request #X **Before release**: - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/#support-window) to see if the minimum supported version of Python or NumPy needs bumping. - [ ] Verify that the latest CI workflows on `main` are passing: [Tests](https://github.com/zarr-developers/zarr-python/actions/workflows/test.yml), [GPU Tests](https://github.com/zarr-developers/zarr-python/actions/workflows/gpu_test.yml), [Hypothesis](https://github.com/zarr-developers/zarr-python/actions/workflows/hypothesis.yaml), [Docs](https://github.com/zarr-developers/zarr-python/actions/workflows/docs.yml), [Lint](https://github.com/zarr-developers/zarr-python/actions/workflows/lint.yml), [Wheels](https://github.com/zarr-developers/zarr-python/actions/workflows/releases.yml). - [ ] Run the [downstream tests](https://github.com/zarr-developers/zarr-python/actions/workflows/downstream.yml) against `main`: go to the workflow page, click "Run workflow", and select the `main` branch. Verify that the Xarray and numcodecs integration tests pass. - [ ] Open a release PR with the changelog entries for the upcoming release, generated with `uv run --only-group release towncrier build --version x.y.z`. - [ ] Review the release PR and verify the changelog in `docs/release-notes.md` looks correct. - [ ] Merge the release PR. **Release**: - [ ] [Draft a new GitHub Release](https://github.com/zarr-developers/zarr-python/releases/new) with tag `vX.Y.Z` targeting `main`. Use "Generate release notes" for the description. - [ ] Verify the release is published on [PyPI](https://pypi.org/project/zarr/) and [ReadTheDocs](https://zarr.readthedocs.io/en/stable/). **After release**: - [ ] Review and merge the pull request on the conda-forge [zarr-feedstock](https://github.com/conda-forge/zarr-feedstock) that will be automatically generated. --- - [ ] Party :tada: ---
Releasing from a branch other than main In rare cases (e.g. patch releases for an older minor version), you may need to release from a dedicated release branch (e.g. `3.1.x`): - Create the release branch from the appropriate tag if it doesn't already exist. - Cherry-pick or backport the necessary commits onto the branch. - Run `towncrier build --version x.y.z` and open the release PR against the release branch instead of `main`. - Run the downstream tests against the release branch instead of `main`. - When drafting the GitHub Release, set the target to the release branch instead of `main`. - After the release, ensure any relevant changelog updates are also reflected on `main`.
zarr-python-3.3.0/.github/PULL_REQUEST_TEMPLATE.md000066400000000000000000000025401523267620000211570ustar00rootroot00000000000000 ## Summary [Describe what this PR changes and why, in your own words.] ## For reviewers [What would you most value a second look at? What are you already confident in? For a refactor, say whether behavior is meant to be unchanged.] ## Author attestation - [ ] I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct. ## 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/user-guide/*.md` * [ ] Changes documented as a new file in `changes/` * [ ] GitHub Actions have all passed * [ ] Test coverage is 100% (Codecov passes) zarr-python-3.3.0/.github/dependabot.yml000066400000000000000000000016151523267620000202100ustar00rootroot00000000000000--- version: 2 updates: # Updates for main - package-ecosystem: "github-actions" directory: "/" schedule: interval: "weekly" groups: actions: patterns: - "*" cooldown: default-days: 7 # Keep the pinned dev tooling in pyproject.toml's [dependency-groups] and the # uv.lock current. Without this the exact pins (e.g. pytest) would never be # bumped automatically and would silently rot. # # `allow: dependency-type: direct` restricts updates to dependencies declared # in pyproject.toml. Transitive deps in uv.lock are then only updated as a # side effect of a direct bump, never via a standalone PR. - package-ecosystem: "uv" directory: "/" allow: - dependency-type: "direct" schedule: interval: "weekly" groups: python-dependencies: patterns: - "*" cooldown: default-days: 7 zarr-python-3.3.0/.github/labeler.yml000066400000000000000000000001431523267620000175040ustar00rootroot00000000000000needs release notes: - all: - changed-files: - all-globs-to-all-files: '!changes/*.md' zarr-python-3.3.0/.github/workflows/000077500000000000000000000000001523267620000174125ustar00rootroot00000000000000zarr-python-3.3.0/.github/workflows/check_changelogs.yml000066400000000000000000000014451523267620000234100ustar00rootroot00000000000000name: Check changelog entries on: pull_request: workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: check-changelogs: name: Check changelog entries runs-on: ubuntu-latest steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Check zarr-python changelog entries run: uv run --no-sync python ci/check_changelog_entries.py - name: Check zarr-metadata changelog entries run: uv run --no-sync python ci/check_changelog_entries.py packages/zarr-metadata/changes zarr-python-3.3.0/.github/workflows/codspeed.yml000066400000000000000000000021471523267620000217270ustar00rootroot00000000000000name: CodSpeed Benchmarks on: schedule: - cron: '0 9 * * 1' # Every Monday at 9am UTC pull_request: types: [labeled] workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: benchmarks: name: Run benchmarks runs-on: codspeed-macro if: | github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'benchmark')) steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 persist-credentials: false - name: Install Hatch uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc with: version: '1.16.5' - name: Run the benchmarks uses: CodSpeedHQ/action@f99becdce5e5d51fd556489ebef684f4ecfd6286 # v4.18.5 env: ZARR_BENCHMARK_CLEAR_CACHE: '1' with: mode: walltime run: hatch run test.py3.12-minimal:pytest tests/benchmarks --codspeed zarr-python-3.3.0/.github/workflows/docs.yml000066400000000000000000000025411523267620000210670ustar00rootroot00000000000000name: Docs on: push: branches: [main] pull_request: branches: [main] workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: docs: name: Check docs runs-on: ubuntu-latest steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - run: uv sync --group docs # Fast source-level guards that need no built site, so they run before the (slower) # build for a quick failure: every public export is in the API reference, and no # docstring/Markdown carries reStructuredText markup that MkDocs won't render. - run: uv run python ci/check_documented_exports.py docs/api - run: uv run python ci/lint_docs.py # --strict turns warnings into errors, so a docs code block that fails to execute # at build time (e.g. a non-exec python fence disrupting a later exec="true" block) # fails CI instead of merging as a silent warning. - run: uv run mkdocs build --strict env: DISABLE_MKDOCS_2_WARNING: "true" NO_MKDOCS_2_WARNING: "true" - run: uv run python ci/check_unlinked_types.py continue-on-error: true zarr-python-3.3.0/.github/workflows/downstream.yml000066400000000000000000000104551523267620000223250ustar00rootroot00000000000000name: Downstream on: workflow_dispatch: pull_request: types: [labeled, synchronize, opened, reopened] permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: xarray: name: Xarray zarr backend tests if: | github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run-downstream') runs-on: ubuntu-latest steps: - name: Check out zarr-python uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 persist-credentials: false - name: Check out xarray uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: repository: pydata/xarray path: xarray persist-credentials: false # We install xarray with plain pip/uv rather than pixi. pixi solves # xarray's entire manifest (it has no committed lockfile), which drags in # the `mypy-upstream` environment; that environment sources numcodecs from # git and fails to build under newer pixi with # `meson-python: error: Unknown option "pixi-conda-environment"`, breaking # the job before any test runs. Tests that need a backend we don't install # are skipped via xarray's `requires_*` markers, not failed. - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: '3.13' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install xarray and test dependencies working-directory: xarray run: | uv venv # xarray's pytest tooling lives in the PEP 735 `dev` dependency group; # the zarr-relevant backends come from the `io` and `parallel` extras. uv pip install --group dev ".[io,parallel,accel]" - name: Override zarr-python with branch version working-directory: xarray run: uv pip install --no-deps .. - name: Show versions working-directory: xarray run: | uv run python -c " import zarr; print(f'zarr {zarr.__version__}') import xarray; print(f'xarray {xarray.__version__}') " - name: Run xarray zarr backend tests working-directory: xarray run: | uv run python -m pytest --no-header -q \ xarray/tests/test_backends.py \ xarray/tests/test_backends_api.py \ xarray/tests/test_backends_datatree.py numcodecs: name: numcodecs zarr3 codec tests if: | github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run-downstream') runs-on: ubuntu-latest steps: - name: Check out zarr-python uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 persist-credentials: false - name: Check out numcodecs uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: repository: zarr-developers/numcodecs fetch-depth: 0 path: numcodecs submodules: recursive persist-credentials: false - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: '3.13' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install numcodecs with test-zarr-main group working-directory: numcodecs run: | uv venv uv pip install --group dev uv sync --group dev --group test-zarr-main uv pip install --no-build-isolation -e . - name: Override zarr-python with branch version working-directory: numcodecs run: uv pip install --no-deps .. - name: Show versions working-directory: numcodecs run: | uv run python -c " import zarr; print(f'zarr {zarr.__version__}') import numcodecs; print(f'numcodecs {numcodecs.__version__}') " - name: Run numcodecs zarr3 tests working-directory: numcodecs run: uv run python -m pytest -x --no-header -q tests/test_zarr3.py zarr-python-3.3.0/.github/workflows/gpu_test.yml000066400000000000000000000051631523267620000217740ustar00rootroot00000000000000# This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: GPU Test on: push: branches: [ main, 3.1.x ] pull_request: branches: [ main, 3.1.x ] workflow_dispatch: env: LD_LIBRARY_PATH: /usr/local/cuda/extras/CUPTI/lib64:/usr/local/cuda/lib64 # Use the uv from astral-sh/setup-uv instead of hatch's bundled (pyapp) uv. HATCH_ENV_TYPE_VIRTUAL_UV_PATH: uv permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: name: py=${{ matrix.python-version }} environment: name: codecov-upload deployment: false runs-on: gpu-runner strategy: matrix: python-version: ['3.12'] steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 # grab all branches and tags persist-credentials: false # - name: cuda-toolkit # uses: Jimver/cuda-toolkit@v0.2.16 # id: cuda-toolkit # with: # cuda: '12.4.1' - name: Set up CUDA run: | wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2004/x86_64/cuda-keyring_1.1-1_all.deb sudo dpkg -i cuda-keyring_1.1-1_all.deb sudo apt-get update sudo apt-get -y install cuda-toolkit-12-6 echo "/usr/local/cuda/bin" >> $GITHUB_PATH - name: GPU check run: | nvidia-smi echo $PATH echo $LD_LIBRARY_PATH nvcc -V - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install Hatch uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc with: version: '1.16.5' - name: Set Up Hatch Env env: HATCH_ENV: gputest.py${{ matrix.python-version }} run: | hatch env create "$HATCH_ENV" hatch env run -e "$HATCH_ENV" list-env - name: Run Tests env: HATCH_ENV: gputest.py${{ matrix.python-version }} run: | hatch env run --env "$HATCH_ENV" run-coverage - name: Upload coverage uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0 with: token: ${{ secrets.CODECOV_TOKEN }} flags: gpu verbose: true # optional (default = false) zarr-python-3.3.0/.github/workflows/hypothesis.yaml000066400000000000000000000073751523267620000225110ustar00rootroot00000000000000name: Slow Hypothesis CI on: push: branches: [main, 3.1.x] pull_request: branches: [main, 3.1.x] types: [opened, reopened, synchronize, labeled] schedule: - cron: "0 0 * * *" # Daily “At 00:00” UTC workflow_dispatch: # allows you to trigger manually permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true env: FORCE_COLOR: 3 # Use the uv from astral-sh/setup-uv instead of hatch's bundled (pyapp) uv. HATCH_ENV_TYPE_VIRTUAL_UV_PATH: uv jobs: hypothesis: name: Slow Hypothesis Tests environment: name: codecov-upload deployment: false runs-on: "ubuntu-latest" defaults: run: shell: bash -l {0} strategy: matrix: python-version: ['3.12'] dependency-set: ["optional"] steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Set HYPOTHESIS_PROFILE based on trigger env: EVENT_NAME: ${{ github.event_name }} run: | if [[ "$EVENT_NAME" == "schedule" || "$EVENT_NAME" == "workflow_dispatch" ]]; then echo "HYPOTHESIS_PROFILE=nightly" >> $GITHUB_ENV else echo "HYPOTHESIS_PROFILE=ci" >> $GITHUB_ENV fi - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install Hatch uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc with: version: '1.16.5' - name: Set Up Hatch Env env: HATCH_ENV: test.py${{ matrix.python-version }}-${{ matrix.dependency-set }} run: | hatch env create "$HATCH_ENV" hatch env run -e "$HATCH_ENV" list-env # https://github.com/actions/cache/blob/main/tips-and-workarounds.md#update-a-cache - name: Restore cached hypothesis directory id: restore-hypothesis-cache uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 with: path: .hypothesis/ key: cache-hypothesis-${{ runner.os }}-${{ github.run_id }} restore-keys: | cache-hypothesis- - name: Run slow Hypothesis tests if: success() id: status env: HATCH_ENV: test.py${{ matrix.python-version }}-${{ matrix.dependency-set }} run: | echo "Using Hypothesis profile: $HYPOTHESIS_PROFILE" hatch env run --env "$HATCH_ENV" run-hypothesis # explicitly save the cache so it gets updated, also do this even if it fails. - name: Save cached hypothesis directory id: save-hypothesis-cache if: always() && steps.status.outcome != 'skipped' uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 with: path: .hypothesis/ key: cache-hypothesis-${{ runner.os }}-${{ github.run_id }} - name: Upload coverage uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0 with: token: ${{ secrets.CODECOV_TOKEN }} flags: tests verbose: true # optional (default = false) - name: Generate and publish the report if: | failure() && steps.status.outcome == 'failure' && github.event_name == 'schedule' && github.repository_owner == 'zarr-developers' uses: scientific-python/issue-from-pytest-log-action@87351a8f864e969567cda22a25a2f214cbe2340f # v1.6.0 with: log-path: output-${{ matrix.python-version }}-log.jsonl issue-title: "Nightly Hypothesis tests failed" issue-label: "topic-hypothesis" zarr-python-3.3.0/.github/workflows/issue-metrics.yml000066400000000000000000000026731523267620000227410ustar00rootroot00000000000000name: Monthly issue metrics on: workflow_dispatch: schedule: - cron: '3 2 1 * *' permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build: name: issue metrics runs-on: ubuntu-latest permissions: issues: write # Required to create the metrics report issue pull-requests: read # Required to read PR metrics steps: - name: Get dates for last month shell: bash run: | # Calculate the first day of the previous month first_day=$(date -d "last month" +%Y-%m-01) # Calculate the last day of the previous month last_day=$(date -d "$first_day +1 month -1 day" +%Y-%m-%d) #Set an environment variable with the date range echo "$first_day..$last_day" echo "last_month=$first_day..$last_day" >> "$GITHUB_ENV" - name: Run issue-metrics tool uses: github-community-projects/issue-metrics@df8c49d20958f9345281fa2124858bd0ad227e1f # v5.0.0 env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} SEARCH_QUERY: 'repo:zarr-developers/zarr-python is:issue created:${{ env.last_month }} -reason:"not planned"' - name: Create issue uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710 # v6.0.0 with: title: Monthly issue metrics report token: ${{ secrets.GITHUB_TOKEN }} content-filepath: ./issue_metrics.md zarr-python-3.3.0/.github/workflows/links.yml000066400000000000000000000016401523267620000212560ustar00rootroot00000000000000name: Check links on: repository_dispatch: workflow_dispatch: # pull_request: schedule: - cron: "00 18 * * 1" # weekly, Mondays at 18:00 UTC jobs: linkChecker: runs-on: ubuntu-latest permissions: issues: write # required for peter-evans/create-issue-from-file steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Link Checker id: lychee uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2.9.0 with: fail: false - name: Create Issue From File if: steps.lychee.outputs.exit_code != 0 uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710 # v6.0.0 with: title: Link Checker Report content-filepath: ./lychee/out.md labels: report, automated issue zarr-python-3.3.0/.github/workflows/lint.yml000066400000000000000000000014771523267620000211140ustar00rootroot00000000000000name: Lint on: push: branches: [main, 3.1.x] pull_request: branches: [main, 3.1.x] workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: lint: name: Lint runs-on: ubuntu-latest steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: "3.12" - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 with: enable-cache: true - uses: j178/prek-action@e98a699c41eb69ab013a45817a0406469a748f8d # v2.0.5 zarr-python-3.3.0/.github/workflows/needs_release_notes.yml000066400000000000000000000016371523267620000241520ustar00rootroot00000000000000name: "Pull Request Labeler" on: # pull_request_target is needed to label PRs from forks. # This workflow only runs actions/labeler (no code checkout), so it's safe. pull_request_target: # zizmor: ignore[dangerous-triggers] types: [opened, reopened, synchronize] permissions: {} concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number }} cancel-in-progress: true jobs: labeler: name: Label pull request if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.user.login != 'pre-commit-ci[bot]' }} permissions: contents: read # Required to read label configuration pull-requests: write # Required to add labels to PRs runs-on: ubuntu-latest steps: - uses: actions/labeler@bf12e9b00b37c5c0ca2b87b79b2daf7891dbda13 # v7.0.0 with: repo-token: ${{ secrets.GITHUB_TOKEN }} sync-labels: true zarr-python-3.3.0/.github/workflows/nightly_wheels.yml000066400000000000000000000023151523267620000231630ustar00rootroot00000000000000name: Nightly Wheels on: schedule: # Run nightly at 2 AM UTC - cron: '0 2 * * *' workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build_and_upload_nightly: name: Build and upload nightly wheels environment: name: nightly-wheel-upload deployment: false runs-on: ubuntu-latest steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: submodules: true fetch-depth: 0 persist-credentials: false - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 name: Install Python with: python-version: '3.14' - name: Install Hatch uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc with: version: '1.16.5' - name: Build wheel and sdist run: hatch build - name: Upload nightly wheels uses: scientific-python/upload-nightly-action@e76cfec8a4611fd02808a801b0ff5a7d7c1b2d99 with: artifacts_path: dist anaconda_nightly_upload_token: ${{ secrets.ANACONDA_ORG_UPLOAD_TOKEN }} zarr-python-3.3.0/.github/workflows/releases.yml000066400000000000000000000044561523267620000217510ustar00rootroot00000000000000name: Wheels on: release: types: - published push: branches: [main] pull_request: branches: [main] workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build_artifacts: name: Build wheel on ubuntu-latest runs-on: ubuntu-latest strategy: fail-fast: false steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: submodules: true fetch-depth: 0 persist-credentials: false - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 name: Install Python with: python-version: '3.12' - name: Install Hatch uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc with: version: '1.16.5' - name: Build wheel and sdist run: hatch build - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: releases path: dist test_dist_pypi: name: Test distribution artifacts needs: [build_artifacts] runs-on: ubuntu-latest steps: - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: releases path: dist - name: test run: | ls ls dist upload_pypi: name: Upload to PyPI needs: [build_artifacts, test_dist_pypi] runs-on: ubuntu-latest if: github.event_name == 'release' environment: name: releases url: https://pypi.org/p/zarr permissions: id-token: write # Required for OIDC trusted publishing to PyPI attestations: write # Required for artifact attestation artifact-metadata: write # Required for artifact attestation metadata steps: - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: releases path: dist - name: Generate artifact attestation uses: actions/attest@f7c74d28b9d84cb8768d0b8ca14a4bac6ef463e6 # v4.2.0 with: subject-path: dist/* - name: Publish package to PyPI uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0 zarr-python-3.3.0/.github/workflows/test.yml000066400000000000000000000143331523267620000211200ustar00rootroot00000000000000# This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: Test on: push: branches: [ main, 3.1.x ] pull_request: branches: [ main, 3.1.x ] workflow_dispatch: permissions: contents: read env: # Use the uv from astral-sh/setup-uv; without an explicit path hatch # bootstraps its own (pyapp) uv, which fails on non-3.12 runners. HATCH_ENV_TYPE_VIRTUAL_UV_PATH: uv concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: name: os=${{ matrix.os }}, py=${{ matrix.python-version }}, deps=${{ matrix.dependency-set }} environment: name: codecov-upload deployment: false defaults: run: shell: bash strategy: matrix: python-version: ['3.12', '3.13', '3.14'] dependency-set: ["minimal", "optional"] os: ["ubuntu-latest"] include: - python-version: '3.12' dependency-set: 'optional' os: 'macos-latest' - python-version: '3.14' dependency-set: 'optional' os: 'macos-latest' - python-version: '3.12' dependency-set: 'optional' os: 'windows-latest' - python-version: '3.14' dependency-set: 'optional' os: 'windows-latest' runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 # grab all branches and tags persist-credentials: false - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install Hatch run: python -m pip install hatch==1.16.5 - name: Set Up Hatch Env env: HATCH_ENV: test.py${{ matrix.python-version }}-${{ matrix.dependency-set }} run: | hatch env create "$HATCH_ENV" hatch env run -e "$HATCH_ENV" list-env - name: Run Tests env: HYPOTHESIS_PROFILE: ci HATCH_ENV: test.py${{ matrix.python-version }}-${{ matrix.dependency-set }} run: | hatch env run --env "$HATCH_ENV" run-coverage - name: Upload coverage if: ${{ matrix.dependency-set == 'optional' && matrix.os == 'ubuntu-latest' }} uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0 with: token: ${{ secrets.CODECOV_TOKEN }} flags: tests verbose: true # optional (default = false) test-upstream-and-min-deps: name: py=${{ matrix.python-version }}-${{ matrix.dependency-set }} environment: name: codecov-upload deployment: false runs-on: ubuntu-latest strategy: matrix: python-version: ['3.12', "3.14"] dependency-set: ["upstream", "min_deps"] exclude: - python-version: "3.14" dependency-set: min_deps - python-version: "3.12" dependency-set: upstream steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 persist-credentials: false - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install Hatch run: python -m pip install hatch==1.16.5 - name: Set Up Hatch Env env: HATCH_ENV: ${{ matrix.dependency-set }} run: | hatch env create "$HATCH_ENV" hatch env run -e "$HATCH_ENV" list-env - name: Run Tests env: HATCH_ENV: ${{ matrix.dependency-set }} run: | hatch env run --env "$HATCH_ENV" run-coverage - name: Upload coverage uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0 with: token: ${{ secrets.CODECOV_TOKEN }} flags: tests verbose: true # optional (default = false) doctests: name: doctests runs-on: ubuntu-latest steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 # required for hatch version discovery, which is needed for numcodecs.zarr3 persist-credentials: false - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: '3.13' cache: 'pip' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install Hatch run: python -m pip install hatch==1.16.5 - name: Set Up Hatch Env run: | hatch run doctest:pip list - name: Run Tests run: | hatch run doctest:test benchmarks: name: Benchmark smoke test runs-on: ubuntu-latest steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 0 persist-credentials: false - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 with: python-version: '3.13' cache: 'pip' - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install Hatch run: python -m pip install hatch==1.16.5 - name: Run Benchmarks env: ZARR_BENCHMARK_CLEAR_CACHE: '1' run: | hatch env run --env "test.py3.13-minimal" run-benchmark test-complete: name: Test complete needs: [ test, test-upstream-and-min-deps, doctests, benchmarks ] if: always() runs-on: ubuntu-latest steps: - name: Check failure if: | contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') run: exit 1 - name: Success run: echo Success! zarr-python-3.3.0/.github/workflows/zarr-metadata-release.yml000066400000000000000000000067001523267620000243120ustar00rootroot00000000000000name: zarr-metadata release on: workflow_dispatch: push: tags: - 'zarr_metadata-v*' permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: false jobs: build: name: Build wheel and sdist runs-on: ubuntu-latest defaults: run: shell: bash working-directory: packages/zarr-metadata steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false fetch-depth: 0 # hatch-vcs needs full history + tags - name: Install Hatch uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc with: version: '1.16.5' - name: Build run: hatch build - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: zarr-metadata-dist path: packages/zarr-metadata/dist test_artifacts: name: Test built artifacts needs: [build] runs-on: ubuntu-latest steps: - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: zarr-metadata-dist path: dist - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 with: enable-cache: false - name: Set up Python run: uv python install 3.12 - name: Install built wheel and run import smoke test run: | wheel=$(ls dist/*.whl) uv run --with "${wheel}" --python 3.12 --no-project \ python -c "import zarr_metadata; print('zarr_metadata', zarr_metadata.__version__)" upload_pypi: name: Upload to PyPI needs: [build, test_artifacts] if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/zarr_metadata-v') runs-on: ubuntu-latest environment: name: zarr-metadata-releases url: https://pypi.org/p/zarr-metadata permissions: id-token: write # required for OIDC trusted publishing attestations: write # required for artifact attestations steps: - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: zarr-metadata-dist path: dist - name: Generate artifact attestation uses: actions/attest@f7c74d28b9d84cb8768d0b8ca14a4bac6ef463e6 # v4.2.0 with: subject-path: dist/* - name: Publish package to PyPI uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0 upload_testpypi: name: Upload to TestPyPI needs: [build, test_artifacts] if: github.event_name == 'workflow_dispatch' runs-on: ubuntu-latest environment: name: zarr-metadata-releases-test url: https://test.pypi.org/p/zarr-metadata permissions: id-token: write attestations: write steps: - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: zarr-metadata-dist path: dist - name: Generate artifact attestation uses: actions/attest@f7c74d28b9d84cb8768d0b8ca14a4bac6ef463e6 # v4.2.0 with: subject-path: dist/* - name: Publish package to TestPyPI uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0 with: repository-url: https://test.pypi.org/legacy/ zarr-python-3.3.0/.github/workflows/zarr-metadata.yml000066400000000000000000000072261523267620000227000ustar00rootroot00000000000000name: zarr-metadata # Job steps delegate to packages/zarr-metadata/justfile, the single source of # truth for this package's verbs; CI owns only the python matrix and caching. on: push: branches: [main] paths: - 'packages/zarr-metadata/**' - '.github/workflows/zarr-metadata.yml' pull_request: paths: - 'packages/zarr-metadata/**' - '.github/workflows/zarr-metadata.yml' workflow_dispatch: permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: name: pytest py=${{ matrix.python-version }} runs-on: ubuntu-latest defaults: run: shell: bash working-directory: packages/zarr-metadata strategy: fail-fast: false matrix: python-version: ['3.11', '3.12', '3.13', '3.14'] steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 with: enable-cache: true - name: Install just uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4 - name: Set up Python ${{ matrix.python-version }} run: uv python install ${{ matrix.python-version }} - name: Sync test dependency group run: uv sync --group test --python ${{ matrix.python-version }} - name: Run pytest run: just test ruff: name: ruff runs-on: ubuntu-latest defaults: run: shell: bash working-directory: packages/zarr-metadata steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Install just uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4 - name: Run ruff run: just lint pyright: name: pyright runs-on: ubuntu-latest defaults: run: shell: bash working-directory: packages/zarr-metadata steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 with: enable-cache: true - name: Install just uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4 - name: Run pyright # The pyright version and interpreter pins live in the justfile. run: just typecheck docs: name: docs runs-on: ubuntu-latest defaults: run: shell: bash working-directory: packages/zarr-metadata steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Install uv uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 with: enable-cache: true - name: Install just uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4 - name: Build docs run: just docs-check zarr-metadata-complete: name: zarr-metadata complete needs: [test, ruff, pyright, docs] if: always() runs-on: ubuntu-latest steps: - name: Check failure if: | contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') run: exit 1 - name: Success run: echo Success! zarr-python-3.3.0/.github/workflows/zizmor.yml000066400000000000000000000015021523267620000214650ustar00rootroot00000000000000name: GitHub Actions Security Analysis on: push: branches: [main] paths: - '.github/workflows/**' - '.github/actions/**' pull_request: branches: ["**"] paths: - '.github/workflows/**' - '.github/actions/**' workflow_dispatch: permissions: {} concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: zizmor: name: Run zizmor runs-on: ubuntu-latest permissions: security-events: write # Required by zizmor-action to upload SARIF files steps: - name: Checkout repository uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false - name: Run zizmor uses: zizmorcore/zizmor-action@6599ee8b7a49aef6a770f63d261d214911a7ce02 # v0.6.0 zarr-python-3.3.0/.gitignore000066400000000000000000000022341523267620000160060ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] # C extensions *.so # Distribution / packaging .Python env/ .venv/ build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ *.egg-info/ .installed.cfg *.egg # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .coverage .coverage.* .cache coverage.xml *,cover # Translations *.mo *.pot # Django stuff: *.log # Documentation site/ docs/_build/ docs/data data data.zip # PyBuilder target/ # PyCharm .idea # Jupyter .ipynb_checkpoints/ # VCS versioning src/zarr/_version.py # emacs *~ # VSCode .vscode/ # test data #*.zarr #*.zip #example* #doesnotexist #test_sync* data/* src/fixture/ fixture/ junit.xml .DS_Store tests/.hypothesis .hypothesis/ zarr/version.py zarr.egg-info/ # Local agent / planning notes (not versioned) .claude/ CLAUDE.md docs/superpowers/ # zarr-metadata package lockfile (a library, not an app) packages/zarr-metadata/uv.lock zarr-python-3.3.0/.markdownlint-cli2.jsonc000066400000000000000000000046651523267620000205040ustar00rootroot00000000000000// markdownlint-cli2 configuration for zarr-python docs. // // We keep the rules that catch real rendering/structure problems and disable those that // are pure style, conflict with house conventions, or fire false positives against our // MkDocs/mkdocstrings + pymdownx toolchain. Complementary, not overlapping, with // ci/lint_docs.py (RST residue + list-breaking fences) and `mkdocs build --strict`. { "config": { "default": true, // House style: Markdown paragraphs are single unwrapped lines, so line length is not // a meaningful constraint. "MD013": false, // Purely stylistic marker/emphasis choices -- not worth the churn across existing docs. "MD004": false, // ul bullet style (-, *, +) "MD007": false, // ul indentation width "MD050": false, // strong (bold) style "MD035": false, // hr style // False positives from our toolchain: // mkdocstrings cross-refs `[`X`][zarr.X]` read as undefined reference links (MD052); // pymdownx.magiclink auto-links bare URLs (MD034); // md_in_html lets us embed intentional raw HTML (MD033); // generated/included files (api stubs, snippets) need not open with an H1 (MD041). "MD052": false, "MD034": false, "MD033": false, "MD041": false, // Duplicate headings are legitimate under different sections (e.g. repeated // "Documentation"); only flag true sibling duplicates. "MD024": { "siblings_only": true }, // Opinionated table/link/command rules with low value for these docs. "MD055": false, // table pipe style "MD060": false, // table column style "MD059": false, // "descriptive" link text (no "click here") "MD014": false, // $ before commands without shown output // markdownlint does not understand MkDocs `!!!` admonitions, so it reads their // 4-space-indented bodies as indented code blocks and flags them (and, via inferred // file style, flags real fenced blocks too). Cannot coexist with our admonitions. "MD046": false // code block style (fenced vs indented) // Kept on (structural / real rendering bugs): MD012 (multiple blanks), MD022/MD031/MD032 // (blanks around headings/fences/lists), MD025 (single H1), MD029 (ordered-list prefix), // MD040 (fenced code language), MD042 (empty links), // MD047 (trailing newline), MD056 (table column count), among others. }, "globs": ["docs/**/*.md"], "ignores": [ "docs/api/**" // mkdocstrings stubs (`::: zarr.X`) ] } zarr-python-3.3.0/.pre-commit-config.yaml000066400000000000000000000046451523267620000203070ustar00rootroot00000000000000ci: autoupdate_commit_msg: "chore: update pre-commit hooks" autoupdate_schedule: "monthly" autofix_prs: false # mypy runs as a `language: system` hook via `uv run mypy`, which needs `uv` # and the repo checkout to resolve the dev environment from `uv.lock` — # unavailable on pre-commit.ci's runners. It is covered instead by the Lint # GitHub Actions workflow and by local prek runs. skip: [mypy] default_stages: [pre-commit, pre-push] default_language_version: python: python3.12 repos: - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.15.20 hooks: - id: ruff-check args: ["--fix", "--show-fixes"] - id: ruff-format - repo: https://github.com/codespell-project/codespell rev: v2.4.2 hooks: - id: codespell args: ["-L", "fo,ihs,kake,te", "-S", "fixture"] - repo: https://github.com/pre-commit/pre-commit-hooks rev: v6.0.0 hooks: - id: check-yaml exclude: mkdocs.yml - id: trailing-whitespace - repo: https://github.com/DavidAnson/markdownlint-cli2 rev: v0.22.1 hooks: # Markdown structure/hygiene. Rule selection and ignores are in # .markdownlint-cli2.jsonc; complements ci/lint_docs.py (RST residue, # list-breaking fences) and `mkdocs build --strict`. Scoped to docs/ to # match the config's globs (pre-commit passes filenames, which would # otherwise override that scoping and lint all repo Markdown). - id: markdownlint-cli2 files: ^docs/ - repo: local hooks: - id: mypy name: mypy language: system entry: uv run --frozen mypy pass_filenames: false always_run: true types_or: [python, pyi] - repo: https://github.com/scientific-python/cookie rev: 2026.06.18 hooks: - id: sp-repo-review - repo: https://github.com/numpy/numpydoc rev: v1.11.0rc0 hooks: - id: numpydoc-validation - repo: local hooks: - id: ban-lstrip-rstrip name: ban lstrip/rstrip language: pygrep # Matches .lstrip() or .rstrip() where the string argument is 2+ characters. entry: "\\.(lstrip|rstrip)\\([\"'][^\"']{2,}[\"']\\)" types: [python] files: ^(src|tests)/ - repo: https://github.com/zizmorcore/zizmor-pre-commit rev: v1.26.1 hooks: - id: zizmor - repo: https://github.com/twisted/towncrier rev: 25.8.0 hooks: - id: towncrier-check zarr-python-3.3.0/.python-version000066400000000000000000000000051523267620000170150ustar00rootroot000000000000003.12 zarr-python-3.3.0/.pyup.yml000066400000000000000000000005131523267620000156120ustar00rootroot00000000000000# pyup.io config file # see https://pyup.io/docs/configuration/ for all available options schedule: every month requirements: - requirements_dev_minimal.txt: pin: True update: all - requirements_dev_numpy.txt: pin: True update: all - requirements_dev_optional.txt: pin: True update: all zarr-python-3.3.0/.readthedocs.yaml000066400000000000000000000021401523267620000172410ustar00rootroot00000000000000version: 2 build: os: ubuntu-22.04 tools: python: "3.12" jobs: post_checkout: # Cancel pull request builds whose changes are confined to the # zarr-metadata package, which has its own Read the Docs project. Exit # code 183 cancels the build and reports success to the Git provider. # Scoped to PR builds ("external" versions) because origin/main is only # a meaningful diff base there. Read the Docs strips shell quoting from # commands, so the exclude pathspec must use the quote-free :! form, # not ':(exclude)'. - | if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- :!packages/zarr-metadata; then exit 183; fi install: - pip install --upgrade pip - pip install .[remote] --group docs pre_build: - | if [ "$READTHEDOCS_VERSION_TYPE" != "tag" ]; then towncrier build --version Unreleased --yes; fi build: html: - mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html mkdocs: configuration: mkdocs.yml zarr-python-3.3.0/FUNDING.yml000066400000000000000000000001031523267620000156240ustar00rootroot00000000000000github: [numfocus] custom: ['https://numfocus.org/donate-to-zarr'] zarr-python-3.3.0/LICENSE.txt000066400000000000000000000021441523267620000156410ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015-2025 Zarr Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. zarr-python-3.3.0/README.md000066400000000000000000000052061523267620000152770ustar00rootroot00000000000000

# Zarr [![Latest Release](https://badge.fury.io/py/zarr.svg)](https://pypi.org/project/zarr/) [![CondaForge](https://anaconda.org/conda-forge/zarr/badges/version.svg)](https://anaconda.org/anaconda/zarr/) [![Package Status](https://img.shields.io/pypi/status/zarr.svg)](https://pypi.org/project/zarr/) [![License](https://img.shields.io/pypi/l/zarr.svg)](https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt) [![Coverage](https://codecov.io/gh/zarr-developers/zarr-python/branch/main/graph/badge.svg)](https://app.codecov.io/gh/zarr-developers/zarr-python) [![Downloads](https://static.pepy.tech/badge/zarr)](https://zarr.readthedocs.io/en/stable/) [![Developer Chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://ossci.zulipchat.com/#narrow/channel/423692-Zarr-Python) [![Citation](https://zenodo.org/badge/DOI/10.5281/zenodo.3773450.svg)](https://doi.org/10.5281/zenodo.3773450) ## What is it? Zarr is a Python package providing an implementation of compressed, chunked, N-dimensional arrays, designed for use in parallel computing. See the [documentation](https://zarr.readthedocs.io/en/stable/) for more information. ## Main Features - [**Create**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#creating-an-array) N-dimensional arrays with any NumPy `dtype`. - [**Chunk arrays**](https://zarr.readthedocs.io/en/stable/user-guide/performance/#chunk-optimizations) along any dimension. - [**Compress**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#compressors) and/or filter chunks using any NumCodecs codec. - [**Store arrays**](https://zarr.readthedocs.io/en/stable/user-guide/storage/) in memory, on disk, inside a zip file, on S3, etc... - [**Read**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#reading-and-writing-data) an array [**concurrently**](https://zarr.readthedocs.io/en/stable/user-guide/performance/#parallel-computing-and-synchronization) from multiple threads or processes. - [**Write**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#reading-and-writing-data) to an array concurrently from multiple threads or processes. - Organize arrays into hierarchies via [**groups**](https://zarr.readthedocs.io/en/stable/quick-start/#hierarchical-groups). ## Where to get it Zarr can be installed from PyPI using `pip`: ```bash pip install zarr ``` or via `conda`: ```bash conda install -c conda-forge zarr ``` For more details, including how to install from source, see the [installation documentation](https://zarr.readthedocs.io/en/stable/#installation). zarr-python-3.3.0/TEAM.md000066400000000000000000000014031523267620000150630ustar00rootroot00000000000000## Active core-developers - @joshmoore (Josh Moore) - @jni (Juan Nunez-Iglesias) - @rabernat (Ryan Abernathey) - @jhamman (Joe Hamman) - @d-v-b (Davis Bennett) - @jakirkham (jakirkham) - @martindurant (Martin Durant) - @normanrz (Norman Rzepka) - @dstansby (David Stansby) - @dcherian (Deepak Cherian) - @TomAugspurger (Tom Augspurger) - @maxrjones (Max Jones) - @ilan-gold (Ilan Gold) ## Emeritus core-developers - @alimanfoo (Alistair Miles) - @shoyer (Stephan Hoyer) - @ryan-williams (Ryan Williams) - @jrbourbeau (James Bourbeau) - @mzjp2 (Zain Patel) - @grlee77 (Gregory Lee) ## Former core-developers - @jeromekelleher (Jerome Kelleher) - @tjcrone (Tim Crone) - @funkey (Jan Funke) - @shikharsg - @Carreau (Matthias Bussonnier) - @dazzag24 - @WardF (Ward Fisher) zarr-python-3.3.0/bench/000077500000000000000000000000001523267620000150745ustar00rootroot00000000000000zarr-python-3.3.0/bench/compress_normal.py000066400000000000000000000016551523267620000206600ustar00rootroot00000000000000import sys import timeit import blosc import line_profiler import numpy as np import zarr if __name__ == "__main__": sys.path.insert(0, "..") # setup a = np.random.normal(2000, 1000, size=200000000).astype("u2") z = zarr.empty_like( a, chunks=1000000, compression="blosc", compression_opts={"cname": "lz4", "clevel": 5, "shuffle": 2}, ) print(z) print("*" * 79) # time t = timeit.repeat("z[:] = a", repeat=10, number=1, globals=globals()) print(t) print(min(t)) print(z) # profile profile = line_profiler.LineProfiler(blosc.compress) profile.run("z[:] = a") profile.print_stats() print("*" * 79) # time t = timeit.repeat("z[:]", repeat=10, number=1, globals=globals()) print(t) print(min(t)) # profile profile = line_profiler.LineProfiler(blosc.decompress) profile.run("z[:]") profile.print_stats() zarr-python-3.3.0/bench/compress_normal.txt000066400000000000000000000252341523267620000210460ustar00rootroot00000000000000zarr.core.Array((200000000,), uint16, chunks=(1000000,), order=C) compression: blosc; compression_opts: {'clevel': 5, 'cname': 'lz4', 'shuffle': 2} nbytes: 381.5M; nbytes_stored: 294; ratio: 1360544.2; initialized: 0/200 store: builtins.dict ******************************************************************************* [0.27119584499996563, 0.2855067059999783, 0.2887747180002407, 0.3058794240005227, 0.3139041080003153, 0.3021271820007314, 0.31543190899992624, 0.31403100900024583, 0.3272544129995367, 0.31834129100025166] 0.27119584499996563 zarr.core.Array((200000000,), uint16, chunks=(1000000,), order=C) compression: blosc; compression_opts: {'clevel': 5, 'cname': 'lz4', 'shuffle': 2} nbytes: 381.5M; nbytes_stored: 314.1M; ratio: 1.2; initialized: 200/200 store: builtins.dict Timer unit: 1e-06 s Total time: 0.297223 s File: /home/aliman/code/github/alimanfoo/zarr/zarr/blosc.pyx Function: compress at line 137 Line # Hits Time Per Hit % Time Line Contents ============================================================== 137 def compress(source, char* cname, int clevel, int shuffle): 138 """Compress data in a numpy array. 139 140 Parameters 141 ---------- 142 source : array-like 143 Data to be compressed. 144 cname : bytes 145 Name of compression library to use. 146 clevel : int 147 Compression level. 148 shuffle : int 149 Shuffle filter. 150 151 Returns 152 ------- 153 dest : bytes-like 154 Compressed data. 155 156 """ 157 158 cdef: 159 char *source_ptr 160 char *dest_ptr 161 Py_buffer source_buffer 162 size_t nbytes, cbytes, itemsize 163 200 506 2.5 0.2 array.array char_array_template = array.array('b', []) 164 array.array dest 165 166 # setup source buffer 167 200 458 2.3 0.2 PyObject_GetBuffer(source, &source_buffer, PyBUF_ANY_CONTIGUOUS) 168 200 119 0.6 0.0 source_ptr = source_buffer.buf 169 170 # setup destination 171 200 239 1.2 0.1 nbytes = source_buffer.len 172 200 103 0.5 0.0 itemsize = source_buffer.itemsize 173 200 2286 11.4 0.8 dest = array.clone(char_array_template, nbytes + BLOSC_MAX_OVERHEAD, 174 zero=False) 175 200 129 0.6 0.0 dest_ptr = dest.data.as_voidptr 176 177 # perform compression 178 200 1734 8.7 0.6 if _get_use_threads(): 179 # allow blosc to use threads internally 180 200 167 0.8 0.1 compressor_set = blosc_set_compressor(cname) 181 200 94 0.5 0.0 if compressor_set < 0: 182 raise ValueError('compressor not supported: %r' % cname) 183 200 288570 1442.8 97.1 with nogil: 184 cbytes = blosc_compress(clevel, shuffle, itemsize, nbytes, 185 source_ptr, dest_ptr, 186 nbytes + BLOSC_MAX_OVERHEAD) 187 188 else: 189 with nogil: 190 cbytes = blosc_compress_ctx(clevel, shuffle, itemsize, nbytes, 191 source_ptr, dest_ptr, 192 nbytes + BLOSC_MAX_OVERHEAD, cname, 193 0, 1) 194 195 # release source buffer 196 200 616 3.1 0.2 PyBuffer_Release(&source_buffer) 197 198 # check compression was successful 199 200 120 0.6 0.0 if cbytes <= 0: 200 raise RuntimeError('error during blosc compression: %d' % cbytes) 201 202 # resize after compression 203 200 1896 9.5 0.6 array.resize(dest, cbytes) 204 205 200 186 0.9 0.1 return dest ******************************************************************************* [0.24293352799941204, 0.2324290420001489, 0.24935673900017719, 0.25716222699975333, 0.24246313799994823, 0.23272456500035332, 0.2636815870000646, 0.2576046349995522, 0.2781278639995435, 0.23824110699933954] 0.2324290420001489 Timer unit: 1e-06 s Total time: 0.240178 s File: /home/aliman/code/github/alimanfoo/zarr/zarr/blosc.pyx Function: decompress at line 75 Line # Hits Time Per Hit % Time Line Contents ============================================================== 75 def decompress(source, dest): 76 """Decompress data. 77 78 Parameters 79 ---------- 80 source : bytes-like 81 Compressed data, including blosc header. 82 dest : array-like 83 Object to decompress into. 84 85 Notes 86 ----- 87 Assumes that the size of the destination buffer is correct for the size of 88 the uncompressed data. 89 90 """ 91 cdef: 92 int ret 93 char *source_ptr 94 char *dest_ptr 95 Py_buffer source_buffer 96 array.array source_array 97 Py_buffer dest_buffer 98 size_t nbytes 99 100 # setup source buffer 101 200 573 2.9 0.2 if PY2 and isinstance(source, array.array): 102 # workaround fact that array.array does not support new-style buffer 103 # interface in PY2 104 release_source_buffer = False 105 source_array = source 106 source_ptr = source_array.data.as_voidptr 107 else: 108 200 112 0.6 0.0 release_source_buffer = True 109 200 144 0.7 0.1 PyObject_GetBuffer(source, &source_buffer, PyBUF_ANY_CONTIGUOUS) 110 200 98 0.5 0.0 source_ptr = source_buffer.buf 111 112 # setup destination buffer 113 200 552 2.8 0.2 PyObject_GetBuffer(dest, &dest_buffer, 114 PyBUF_ANY_CONTIGUOUS | PyBUF_WRITEABLE) 115 200 100 0.5 0.0 dest_ptr = dest_buffer.buf 116 200 84 0.4 0.0 nbytes = dest_buffer.len 117 118 # perform decompression 119 200 1856 9.3 0.8 if _get_use_threads(): 120 # allow blosc to use threads internally 121 200 235286 1176.4 98.0 with nogil: 122 ret = blosc_decompress(source_ptr, dest_ptr, nbytes) 123 else: 124 with nogil: 125 ret = blosc_decompress_ctx(source_ptr, dest_ptr, nbytes, 1) 126 127 # release buffers 128 200 754 3.8 0.3 if release_source_buffer: 129 200 326 1.6 0.1 PyBuffer_Release(&source_buffer) 130 200 165 0.8 0.1 PyBuffer_Release(&dest_buffer) 131 132 # handle errors 133 200 128 0.6 0.1 if ret <= 0: 134 raise RuntimeError('error during blosc decompression: %d' % ret) zarr-python-3.3.0/changes/000077500000000000000000000000001523267620000154255ustar00rootroot00000000000000zarr-python-3.3.0/changes/.gitignore000066400000000000000000000000141523267620000174100ustar00rootroot00000000000000!.gitignore zarr-python-3.3.0/changes/README.md000066400000000000000000000005751523267620000167130ustar00rootroot00000000000000Writing a changelog entry ------------------------- Please put a new file in this directory named `xxxx..md`, where - `xxxx` is the pull request number associated with this entry - `` is one of: - feature - bugfix - doc - removal - misc Inside the file, please write a short description of what you have changed, and how it impacts users of `zarr-python`. zarr-python-3.3.0/ci/000077500000000000000000000000001523267620000144105ustar00rootroot00000000000000zarr-python-3.3.0/ci/check_changelog_entries.py000066400000000000000000000043071523267620000216030ustar00rootroot00000000000000""" Check changelog entries have the correct filename structure. Usage: python check_changelog_entries.py [DIRECTORY] DIRECTORY defaults to the repo-root `changes/`. """ import sys from pathlib import Path VALID_CHANGELOG_TYPES = ["feature", "bugfix", "doc", "removal", "misc"] REPO_ROOT = Path(__file__).parent.parent.resolve() DEFAULT_DIRECTORY = REPO_ROOT / "changes" def is_int(s: str) -> bool: try: int(s) except ValueError: return False else: return True def check(directory: Path) -> int: print(f"Looking for changelog entries in {directory}") entries = list(directory.glob("*")) entries = [e for e in entries if e.name not in [".gitignore", "README.md"]] print(f"Found {len(entries)} entries") print() bad_suffix = [e for e in entries if e.suffix != ".md"] bad_issue_no = [e for e in entries if not is_int(e.name.split(".")[0])] # Only flag bad_type for files that have already passed the prior two # checks; otherwise `e.name.split(".")[1]` may raise IndexError on a # malformed name like `notes.md`. bad_type = [ e for e in entries if e.suffix == ".md" and is_int(e.name.split(".")[0]) and e.name.split(".")[1] not in VALID_CHANGELOG_TYPES ] if bad_suffix or bad_issue_no or bad_type: if bad_suffix: print("Changelog entries without .md suffix") print("-------------------------------------") print("\n".join(p.name for p in bad_suffix)) print() if bad_issue_no: print("Changelog entries without integer issue number") print("----------------------------------------------") print("\n".join(p.name for p in bad_issue_no)) print() if bad_type: print("Changelog entries without valid type") print("------------------------------------") print("\n".join(p.name for p in bad_type)) print(f"Valid types are: {VALID_CHANGELOG_TYPES}") print() return 1 return 0 if __name__ == "__main__": directory = Path(sys.argv[1]).resolve() if len(sys.argv) > 1 else DEFAULT_DIRECTORY sys.exit(check(directory)) zarr-python-3.3.0/ci/check_documented_exports.py000066400000000000000000000135301523267620000220340ustar00rootroot00000000000000"""Check that every public top-level export is in the API reference. The API reference is authored as explicit mkdocstrings directives (``::: target``) under ``docs/api/`` -- one per documented symbol -- rather than autodoc, so a newly added ``zarr.__all__`` entry will not appear in the docs until someone writes a page for it (or it becomes a rendered member of an already-documented module). This script catches that gap: it resolves every ``:::`` target, expands module directives into the members they render (honoring ``members: false``), and asserts each name in ``zarr.__all__`` resolves to a documented object. Usage: python ci/check_documented_exports.py [API_DOCS_DIR] API_DOCS_DIR defaults to the repo-root ``docs/api``. Exits non-zero (and prints the undocumented exports to stderr) if any public export is missing from the reference. """ from __future__ import annotations import importlib import re import sys from pathlib import Path from types import ModuleType from typing import TYPE_CHECKING, Any import zarr if TYPE_CHECKING: from collections.abc import Iterator REPO_ROOT = Path(__file__).parent.parent.resolve() DEFAULT_API_DOCS_ROOT = REPO_ROOT / "docs" / "api" # Names in zarr.__all__ that are intentionally absent from the API reference. # Keep this list short and justified -- it is the only escape hatch from the guard. EXEMPT_EXPORTS = { "__version__", # version string, not an API symbol "print_debug_info", # debugging helper, deliberately not in the reference } # A mkdocstrings autodoc directive: `::: some.dotted.target` at the start of a line. DIRECTIVE_RE = re.compile(r"^:::[ \t]+(?P\S+)") # `members: false` (or `members: []`) within a directive's option block disables # rendering of a module's members. MEMBERS_DISABLED_RE = re.compile(r"^\s+members:\s*(false|\[\s*\])\s*$") def resolve(target: str) -> Any: """Resolve a `:::` target (a dotted path) to the Python object it documents.""" try: return importlib.import_module(target) except ImportError: pass module_path, _, attr = target.rpartition(".") try: return getattr(importlib.import_module(module_path), attr) except (ImportError, AttributeError): return None def iter_directives(text: str) -> Iterator[tuple[str, bool]]: """Yield ``(target, members_enabled)`` for each ``:::`` directive in ``text``. The file is split into lines once; for each directive we scan its indented option block -- stopping at the first non-indented line, which ends the block -- so options belonging to a later directive are never consulted. ``members_enabled`` is False when that block sets ``members: false`` (or ``members: []``).""" lines = text.splitlines() i = 0 while i < len(lines): match = DIRECTIVE_RE.match(lines[i]) if match is None: i += 1 continue members_enabled = True i += 1 while i < len(lines): line = lines[i] if line.strip() == "": i += 1 continue if not line.startswith((" ", "\t")): break # non-indented line: end of this directive's option block if MEMBERS_DISABLED_RE.match(line): members_enabled = False i += 1 yield match.group("target"), members_enabled def module_member_ids(module: ModuleType) -> Iterator[int]: """Yield the id() of each public member a module directive renders. The rendered members are the module's ``__all__`` if defined, else its public (non-underscore) attributes.""" member_names = getattr(module, "__all__", None) or [ name for name in dir(module) if not name.startswith("_") ] for name in member_names: member = getattr(module, name, None) if member is not None: yield id(member) def documented_object_ids(api_docs_root: Path) -> set[int]: """Collect the id()s of every object rendered by a `:::` directive under api_docs_root. A directive pointing at an object documents that object. A directive pointing at a module documents the module's public members unless the directive sets ``members: false``.""" documented: set[int] = set() for md_file in sorted(api_docs_root.rglob("*.md")): for target, members_enabled in iter_directives(md_file.read_text(encoding="utf-8")): obj = resolve(target) if obj is None: continue documented.add(id(obj)) if isinstance(obj, ModuleType) and members_enabled: documented.update(module_member_ids(obj)) return documented def find_undocumented_exports(api_docs_root: Path) -> list[str]: documented = documented_object_ids(api_docs_root) return sorted( name for name in zarr.__all__ if name not in EXEMPT_EXPORTS and id(getattr(zarr, name)) not in documented ) def main() -> int: args = sys.argv[1:] api_docs_root = Path(args[0]).resolve() if args else DEFAULT_API_DOCS_ROOT if not api_docs_root.exists(): print(f"{api_docs_root} does not exist.", file=sys.stderr) return 1 missing = find_undocumented_exports(api_docs_root) if not missing: print(f"All {len(zarr.__all__)} public exports are documented.") return 0 print( f"Found {len(missing)} public export(s) in zarr.__all__ missing from the API " "reference (docs/api/):\n", file=sys.stderr, ) for name in missing: print(f" - zarr.{name}", file=sys.stderr) print( "\nAdd a `::: zarr.` page under docs/api/zarr/ (and register it in " "mkdocs.yml and docs/api/zarr/index.md), or -- if the export is intentionally " "undocumented -- add it to EXEMPT_EXPORTS in this script with a reason.", file=sys.stderr, ) return 1 if __name__ == "__main__": sys.exit(main()) zarr-python-3.3.0/ci/check_unlinked_types.py000066400000000000000000000055171523267620000211640ustar00rootroot00000000000000"""Check for unlinked type annotations in built documentation. mkdocstrings renders resolved types as links and unresolved types as Name without an anchor. This script finds all such unlinked types in the built HTML and reports them. Usage: python ci/check_unlinked_types.py [site_dir] Raises ValueError if unlinked types are found. """ from __future__ import annotations import re import sys from pathlib import Path # Matches the griffe/mkdocstrings pattern for unlinked cross-references: # Name UNLINKED_PATTERN = re.compile( r'(?P[^<]+)' ) # Patterns to exclude from the report EXCLUDE_PATTERNS = [ # TypeVars and type parameters (single brackets like Foo[T]) re.compile(r"\[.+\]$"), # Dataclass field / namedtuple field references (contain parens) re.compile(r"\("), # Private names re.compile(r"\._"), # Dunder attributes re.compile(r"\.__\w+__$"), # Testing utilities re.compile(r"^zarr\.testing\."), # Third-party types (hypothesis, pytest, etc.) re.compile(r"^(hypothesis|pytest|typing_extensions|builtins|dataclasses)\."), ] def should_exclude(qualname: str) -> bool: return any(p.search(qualname) for p in EXCLUDE_PATTERNS) def find_unlinked_types(site_dir: Path) -> dict[str, set[str]]: """Find all unlinked types in built HTML files. Returns a dict mapping qualified type names to the set of pages where they appear. """ api_dir = site_dir / "api" if not api_dir.exists(): raise FileNotFoundError(f"{api_dir} does not exist. Run 'mkdocs build' first.") unlinked: dict[str, set[str]] = {} for html_file in api_dir.rglob("*.html"): content = html_file.read_text(errors="replace") rel_path = str(html_file.relative_to(site_dir)) for match in UNLINKED_PATTERN.finditer(content): qualname = match.group("qualname") if not should_exclude(qualname): unlinked.setdefault(qualname, set()).add(rel_path) return unlinked def main() -> None: site_dir = Path(sys.argv[1]) if len(sys.argv) > 1 else Path("site") unlinked = find_unlinked_types(site_dir) if not unlinked: print("No unlinked types found.") return lines = [f"Found {len(unlinked)} unlinked types:\n"] for qualname in sorted(unlinked): pages = sorted(unlinked[qualname]) lines.append(f" {qualname}") lines.extend(f" - {page}" for page in pages) all_pages = {p for ps in unlinked.values() for p in ps} lines.append(f"\nTotal: {len(unlinked)} unlinked types across {len(all_pages)} pages") report = "\n".join(lines) raise ValueError(report) if __name__ == "__main__": main() zarr-python-3.3.0/ci/lint_docs.py000066400000000000000000000346161523267620000167520ustar00rootroot00000000000000"""Lint docstrings and Markdown for reStructuredText markup that won't render. This project renders API docs with mkdocstrings (``docstring_style: numpy``) and prose with MkDocs + Markdown -- not Sphinx/reStructuredText. RST constructs that survive from older docstrings (or muscle memory) are not interpreted: a Sphinx role passes through as literal text instead of becoming a link, an ``.. note::`` directive renders as a stray line, and a ``:param:`` field list never becomes a documented parameter. Crucially, none of this is caught by the rest of the docs CI. ``mkdocs build --strict`` sees the residue as ordinary prose (no warning), and ``ci/check_unlinked_types.py`` only finds cross-references mkdocstrings *attempted* to resolve -- a raw ``:class:`` role is never attempted, so it leaves no unlinked-type span. This linter fills that gap with a fast, source-level check that needs no docs build. Checks fall into two groups -- RST markup that silently fails under MkDocs/mkdocstrings, and Markdown structural problems that render as valid-but-wrong HTML (so `mkdocs build` emits no warning): sphinx-role :class:`X`, :func:`X`, :py:meth:`X` -> [`X`][zarr.X] rst-directive .. note:: / .. code-block:: python -> MkDocs admonition / fenced code rst-field :param x:, :returns:, :rtype: -> numpydoc Parameters/Returns/Raises rst-link `text `_ -> [text](https://example) list-break unindented code fence between list items -> indent the fence under its item list-indent continuation block indented < 4 spaces -> indent it 4 spaces list-blank list item directly after indented block -> blank line before the item The ``list-break`` check catches a fenced code block at column 0 placed *between* two list items: because the fence is not indented into the preceding item, Markdown ends the list at the fence and the following item starts a fresh list -- renumbering an ordered list (1, 1, 2 instead of 1, 2, 3) or breaking the grouping/spacing of any list. markdownlint's MD029 only notices this for sequentially-numbered ordered lists; lazily-numbered (1., 1.) and unordered lists slip past it, so this structural check covers the gap. The ``list-indent`` and ``list-blank`` checks catch the two halves of Python-Markdown's strict list-continuation rules, which differ from CommonMark. A blank-line-separated block (paragraph, nested list, table) belongs to a list item only when indented at least 4 spaces; at the 2-space indent other renderers accept, Python-Markdown ends the list and the block escapes to the top level (``list-indent``). And a new list item can not start directly after an indented continuation block: without a blank line first, the ``- `` line is lazily absorbed into the preceding paragraph as literal text (``list-blank``). Both produced silently-broken changelog rendering in ``docs/release-notes.md``. Usage: python ci/lint_docs.py [PATH ...] PATH defaults to the repo-root ``src/zarr`` and ``docs``. Each PATH may be a file or a directory (directories are searched for ``*.py`` and ``*.md``). Exits non-zero if any issues are found. """ from __future__ import annotations import ast import re import sys from dataclasses import dataclass from pathlib import Path from typing import NamedTuple REPO_ROOT = Path(__file__).parent.parent.resolve() DEFAULT_PATHS = (REPO_ROOT / "src" / "zarr", REPO_ROOT / "docs") # A Sphinx interpreted-text role: an optional domain, a role name, then a backtick # target -- e.g. :class:`Foo` or :py:meth:`Foo.bar`. Requires the trailing backtick so # plain "::" (RST literal markers, time strings, mkdocs-material :icon: shortcodes) and # URLs ("https://") never match. SPHINX_ROLE = re.compile(r":[a-zA-Z_]\w*(?::[a-zA-Z_]\w*)?:`[^`\n]+`") # An RST directive line: ".. name::" (with or without an argument after it). RST hyperlink # targets (".. _label:") and comments (".. text") lack the "::" and are not flagged. RST_DIRECTIVE = re.compile(r"^\s*\.\.[ \t]+[\w-]+::") # An RST field-list entry used for docstring fields. The role names above (class, func, # ...) are deliberately excluded so a role is reported as a role, not a field. RST_FIELD = re.compile( r"^\s*:(param|parameter|arg|argument|key|keyword|kwarg|type|returns?|rtype" r"|raises?|except|exception|yields?|ytype|var|cvar|ivar)\b[^:]*:" ) # An RST external hyperlink: `text `_ RST_LINK = re.compile(r"`[^`\n]+\n]+>`_") # A list item at column 0: an ordered marker (1. / 1)) or a bullet (-, *, +) followed by # whitespace and content. Leading-whitespace (nested/continuation) lines are intentionally # not matched -- the list-break check only fires on top-level items. LIST_ITEM = re.compile(r"^(?:\d+[.)]|[-*+])\s+\S") class Check(NamedTuple): """One docs-residue check: its category, the line pattern that flags it (None for a structural check matched outside ``_scan_line``), and the user-facing remediation shown by ``main()``. Keeping ``example``/``fix`` here makes this the single source for the help text, so adding a check can't leave the help out of date.""" category: str pattern: re.Pattern[str] | None example: str fix: str # The ``list-*`` checks carry no pattern -- they are detected structurally, not by scanning # a single line -- but they appear here so they share the remediation help. CHECKS = ( Check("sphinx-role", SPHINX_ROLE, ":class:`X`", "[`X`][zarr.X]"), Check("rst-directive", RST_DIRECTIVE, ".. note::", "MkDocs admonition (!!! note)"), Check("rst-field", RST_FIELD, ":param x:", "numpydoc Parameters/Returns/Raises section"), Check("rst-link", RST_LINK, "`text `_", "[text](url)"), Check("list-break", None, "fence between items", "indent the fence 4 spaces to nest it"), Check("list-indent", None, "2-space continuation", "indent the block 4 spaces under its item"), Check("list-blank", None, "item after indented block", "add a blank line before the item"), ) @dataclass(frozen=True) class Finding: path: Path line: int category: str snippet: str def format(self) -> str: try: location: Path | str = self.path.relative_to(REPO_ROOT) except ValueError: location = self.path return f" {location}:{self.line}: [{self.category}] {self.snippet.strip()}" def _scan_line(text: str) -> list[str]: """Return every RST-residue category found in a single line (a line can carry more than one, e.g. a role and an external link).""" return [c.category for c in CHECKS if c.pattern is not None and c.pattern.search(text)] def lint_python(path: Path) -> list[Finding]: """Scan the docstrings (module, classes, functions) of a Python file. Only docstrings are checked -- they are what mkdocstrings renders -- so RST-looking text inside ordinary code or string literals is never misreported.""" source = path.read_text(encoding="utf-8") try: tree = ast.parse(source) except SyntaxError as exc: # pragma: no cover - surfaced, not silently skipped return [Finding(path, exc.lineno or 0, "syntax-error", str(exc.msg))] doc_nodes = (ast.Module, ast.ClassDef, ast.FunctionDef, ast.AsyncFunctionDef) # node.body[0].value is the docstring literal; its lineno is the line the string opens # on, so content line i maps to source line (start + i). docstrings = [ (docstring, node.body[0].value.lineno) # type: ignore[attr-defined] for node in ast.walk(tree) if isinstance(node, doc_nodes) if (docstring := ast.get_docstring(node, clean=False)) ] return [ Finding(path, start + offset, category, line) for docstring, start in docstrings for offset, line in enumerate(docstring.splitlines()) for category in _scan_line(line) ] class Fence(NamedTuple): """A fenced code block, by 0-based line index. ``terminated`` is False when the fence has no closing delimiter before EOF, in which case ``close`` is the last line.""" open: int close: int terminated: bool def fenced_blocks(lines: list[str]) -> list[Fence]: """Index every fenced code block in ``lines``. An unterminated fence is malformed Markdown that `mkdocs build` surfaces anyway; it is still returned (with ``terminated=False``, ``close`` at the last line) so callers that skip code can skip to EOF.""" blocks: list[Fence] = [] fence: str | None = None open_idx = -1 for i, line in enumerate(lines): stripped = line.lstrip() if fence is None: if stripped.startswith(("```", "~~~")): fence, open_idx = stripped[:3], i elif stripped.startswith(fence): blocks.append(Fence(open_idx, i, terminated=True)) fence = None if fence is not None: blocks.append(Fence(open_idx, len(lines) - 1, terminated=False)) return blocks def find_list_breaking_fences(lines: list[str], blocks: list[Fence]) -> list[tuple[int, str]]: """Return ``(lineno, snippet)`` for each fenced code block at column 0 that splits a list -- i.e. one whose nearest non-blank neighbours on both sides are top-level list items. Such a fence is not indented into the preceding item, so Markdown closes the list at the fence and the following item starts a new one. The fix is to indent the fence (4 spaces) so it nests inside its list item. See the module docstring. Conservative on purpose: it requires a list item *directly* before and after (a continuation line or paragraph in between is not matched), keeping false positives low for a check that fails CI. Unterminated fences are ignored.""" def neighbour(start: int, step: int) -> str | None: j = start + step while 0 <= j < len(lines): if lines[j].strip(): return lines[j] j += step return None def splits_a_list(open_i: int, close_i: int) -> bool: if lines[open_i][:1].isspace(): return False # indented fence: already nested in the list item, not a break before = neighbour(open_i, -1) after = neighbour(close_i, +1) return bool(before and after and LIST_ITEM.match(before) and LIST_ITEM.match(after)) return [ (fence.open + 1, lines[fence.open]) for fence in blocks if fence.terminated and splits_a_list(fence.open, fence.close) ] def find_list_continuation_issues( lines: list[str], in_code: set[int] ) -> list[tuple[int, str, str]]: """Return ``(lineno, category, snippet)`` for list continuations Python-Markdown will mis-render (see the module docstring): - ``list-indent``: a blank-line-separated block inside a list item indented 1-3 spaces. Python-Markdown requires 4; at less, the block escapes the list. - ``list-blank``: a top-level list item directly after a line indented 4+ spaces. Without a blank line in between, the item is absorbed into the preceding paragraph as literal ``- `` text. Lazy continuations (an indented line with no blank line before it) are valid at any indent and are not flagged. Fenced-code lines are opaque: never flagged themselves, but they keep the item scope open and their indent feeds the ``list-blank`` check so an item directly after an indented fence is still caught.""" findings: list[tuple[int, str, str]] = [] in_item = False # inside a top-level list item's scope prev_blank = True prev_indent = 0 for i, line in enumerate(lines): stripped = line.strip() if not stripped: prev_blank = True continue indent = len(line) - len(line.lstrip(" ")) if i not in in_code: if indent == 0: is_item = bool(LIST_ITEM.match(line)) if is_item and in_item and not prev_blank and prev_indent >= 4: findings.append((i + 1, "list-blank", line)) in_item = is_item elif in_item and prev_blank and indent < 4: findings.append((i + 1, "list-indent", line)) prev_blank = False prev_indent = indent return findings def lint_markdown(path: Path) -> list[Finding]: """Scan a Markdown file: RST residue in prose (skipping fenced code blocks), plus list-structure problems (see find_list_breaking_fences and find_list_continuation_issues).""" lines = path.read_text(encoding="utf-8").splitlines() blocks = fenced_blocks(lines) in_code = {i for fence in blocks for i in range(fence.open, fence.close + 1)} prose = [ Finding(path, lineno, category, line) for lineno, line in enumerate(lines, start=1) if lineno - 1 not in in_code for category in _scan_line(line) ] breaks = [ Finding(path, lineno, "list-break", snippet) for lineno, snippet in find_list_breaking_fences(lines, blocks) ] continuations = [ Finding(path, lineno, category, snippet) for lineno, category, snippet in find_list_continuation_issues(lines, in_code) ] return prose + breaks + continuations def iter_files(paths: tuple[Path, ...]) -> list[Path]: files: list[Path] = [] for path in paths: if path.is_file(): files.append(path) elif path.is_dir(): files.extend(sorted(path.rglob("*.py"))) files.extend(sorted(path.rglob("*.md"))) else: raise FileNotFoundError(f"{path} does not exist") return files LINTERS = {".py": lint_python, ".md": lint_markdown} def lint(paths: tuple[Path, ...]) -> list[Finding]: return [ finding for file in iter_files(paths) if file.suffix in LINTERS for finding in LINTERS[file.suffix](file) ] def main() -> int: args = sys.argv[1:] paths = tuple(Path(a).resolve() for a in args) if args else DEFAULT_PATHS findings = lint(paths) if not findings: print("No reStructuredText residue or list-breaking fences found in docs.") return 0 print( f"Found {len(findings)} docs issue(s) -- RST markup that will not render under " "MkDocs/mkdocstrings, or Markdown that renders as valid-but-wrong HTML:\n", file=sys.stderr, ) for finding in findings: print(finding.format(), file=sys.stderr) remediation = "\n".join(f" {c.category:<13} {c.example:<19} -> {c.fix}" for c in CHECKS) print( f"\nFix each issue (see ci/lint_docs.py header):\n{remediation}", file=sys.stderr, ) return 1 if __name__ == "__main__": sys.exit(main()) zarr-python-3.3.0/codecov.yml000066400000000000000000000012771523267620000161710ustar00rootroot00000000000000coverage: status: patch: default: target: auto informational: true project: default: target: auto threshold: 0.1 flags: - tests flags: tests: paths: - src/ carryforward: true gpu: paths: - src/ carryforward: true codecov: notify: # 6 = test.yml: 3 (optional+ubuntu) + 2 (upstream + min_deps), hypothesis: 1 after_n_builds: 6 wait_for_ci: yes comment: layout: "diff, files" behavior: default require_changes: true # if true: only post the comment if coverage changes branches: # branch names that can post comment - "main" github_checks: annotations: false zarr-python-3.3.0/design/000077500000000000000000000000001523267620000152665ustar00rootroot00000000000000zarr-python-3.3.0/design/chunk-grid.md000066400000000000000000001335061523267620000176530ustar00rootroot00000000000000# Unified Chunk Grid Version: 6 Design document for adding rectilinear (variable) chunk grid support to **zarr-python**, conforming to the [rectilinear chunk grid extension spec](https://github.com/zarr-developers/zarr-extensions/pull/25). **Related:** - [#3750](https://github.com/zarr-developers/zarr-python/issues/3750) (single ChunkGrid proposal) - [#3534](https://github.com/zarr-developers/zarr-python/pull/3534) (rectilinear implementation) - [#3735](https://github.com/zarr-developers/zarr-python/pull/3735) (chunk grid module/registry) - [ZEP0003](https://github.com/zarr-developers/zeps/blob/main/draft/ZEP0003.md) (variable chunking spec) - [zarr-specs#370](https://github.com/zarr-developers/zarr-specs/pull/370) (sharding v1.1: non-divisible subchunks) - [zarr-extensions#25](https://github.com/zarr-developers/zarr-extensions/pull/25) (rectilinear extension) - [zarr-extensions#34](https://github.com/zarr-developers/zarr-extensions/issues/34) (sharding + rectilinear) ## Problem Chunk grids form a hierarchy — the rectilinear grid is strictly more general than the regular grid. Any regular grid is expressible as a rectilinear grid. There is no known chunk grid that is both (a) more general than rectilinear and (b) retains the axis-aligned tessellation properties Zarr assumes. All known grids are special cases: | Grid type | Description | Example | |---|---|---| | Regular | Uniform chunk size, boundary chunks padded with fill_value | `[10, 10, 10, 10]` | | Regular-bounded (zarrs) | Uniform chunk size, boundary chunks trimmed to array extent | `[10, 10, 10, 5]` | | HPC boundary-padded | Regular interior, larger boundary chunks ([VirtualiZarr#217](https://github.com/zarr-developers/VirtualiZarr/issues/217)) | `[10, 8, 8, 8, 10]` | | Fully variable | Arbitrary per-chunk sizes | `[5, 12, 3, 20]` | Prior iterations on the chunk grid design were based on the Zarr V3 spec's definition of chunk grids as an extension point alongside codecs, dtypes, etc. Therefore, we started designing the chunk grid implementation following a similar registry-based approach. However, in practice chunk grids are fundamentally different than codecs. Codecs are independent; supporting `zstd` tells you nothing about `gzip`. Chunk grids are not: every regular grid is a valid rectilinear grid. A registry-based plugin system makes sense for codecs but adds complexity without clear benefit for chunk grids. Here we start from some basic goals and propose a more fitting design for supporting different chunk grids in zarr-python. ## Goals 1. **Follow the zarr extension proposal.** The implementation should conform to the [rectilinear chunk grid spec](https://github.com/zarr-developers/zarr-extensions/tree/main/chunk-grids/rectilinear), not innovate on the metadata format. 2. **Minimize changes to the public API.** Users creating regular arrays should see no difference. Rectilinear is additive. 3. **Maintain backwards compatibility.** Existing code using `.chunks`, `isinstance` checks, or importing `RegularChunkGrid`/`RectilinearChunkGrid` from `zarr.core.chunk_grids` should continue to work where practical (with deprecation warnings where appropriate). Internal code paths/imports may be broken with justification. 4. **Design for future iteration.** The internal architecture should allow refactoring (e.g., metadata/array separation, new dimension types) without breaking the public API. 5. **Minimize downstream changes.** xarray, VirtualiZarr, Icechunk, Cubed, etc. should need minimal updates. 6. **Minimize time to stable release.** Ship behind a feature flag, stabilize through real-world usage, promote to stable API. 7. **The new API should be useful.** `read_chunk_sizes`/`write_chunk_sizes`, `ChunkGrid.__getitem__`, `is_regular` — these should solve real problems, not just expose internals. 8. **Extensible for other serialization structures.** The per-dimension design should support future encodings (tile, temporal) without changes to indexing or codecs. ## Design ### Design choices 1. **A chunk grid is a concrete arrangement of chunks.** Not an abstract tiling pattern. This means that the chunk grid is bound to specific array dimensions, which enables the chunk grid to answer any question about any chunk (offset, size, count) without external parameters. 2. **One implementation, multiple serialization forms.** A single `ChunkGrid` class handles all chunking logic. The serialization format (`"regular"` vs `"rectilinear"`) is chosen by the metadata layer, not the grid. 3. **No chunk grid registry.** Simple name-based dispatch in the metadata layer's `parse_chunk_grid()`. 4. **Fixed vs Varying per dimension.** `FixedDimension(size, extent)` for uniform chunks; `VaryingDimension(edges, extent)` for per-chunk edge lengths with precomputed prefix sums. Avoids expanding regular dimensions into lists of identical values. 5. **Transparent transitions.** Operations like `resize()` can move an array from regular to rectilinear chunking. ### Internal representation ```python @dataclass(frozen=True) class FixedDimension: """Uniform chunk size. Boundary chunks contain less data but are encoded at full size by the codec pipeline.""" size: int # chunk edge length (>= 0) extent: int # array dimension length def __post_init__(self) -> None: # validates size >= 0 and extent >= 0 @property def nchunks(self) -> int: if self.size == 0: return 0 return ceildiv(self.extent, self.size) def index_to_chunk(self, idx: int) -> int: return idx // self.size # raises IndexError if OOB def chunk_offset(self, chunk_ix: int) -> int: return chunk_ix * self.size # raises IndexError if OOB def chunk_size(self, chunk_ix: int) -> int: return self.size # always uniform; raises IndexError if OOB def data_size(self, chunk_ix: int) -> int: return max(0, min(self.size, self.extent - chunk_ix * self.size)) # raises IndexError if OOB @property def unique_edge_lengths(self) -> Iterable[int]: return (self.size,) # O(1) def indices_to_chunks(self, indices: NDArray) -> NDArray: return indices // self.size def with_extent(self, new_extent: int) -> FixedDimension: return FixedDimension(size=self.size, extent=new_extent) def resize(self, new_extent: int) -> FixedDimension: return FixedDimension(size=self.size, extent=new_extent) @dataclass(frozen=True) class VaryingDimension: """Explicit per-chunk sizes. The last chunk may extend past the array extent (extent < sum(edges)), in which case data_size clips to the valid region while chunk_size returns the full edge length for codec processing. This underflow is allowed to match how regular grids handle boundary chunks, and to support shrinking an array without rewriting chunk edges (the spec allows trailing edges beyond the extent).""" edges: tuple[int, ...] # per-chunk edge lengths (all > 0) cumulative: tuple[int, ...] # prefix sums for O(log n) lookup extent: int # array dimension length (may be < sum(edges)) def __init__(self, edges: Sequence[int], extent: int) -> None: # validates edges non-empty, all > 0, extent >= 0, extent <= sum(edges) # computes cumulative via itertools.accumulate # uses object.__setattr__ for frozen dataclass @property def nchunks(self) -> int: # number of chunks that overlap [0, extent) if extent == 0: return 0 return bisect.bisect_left(self.cumulative, extent) + 1 @property def ngridcells(self) -> int: return len(self.edges) def index_to_chunk(self, idx: int) -> int: return bisect.bisect_right(self.cumulative, idx) # raises IndexError if OOB def chunk_offset(self, chunk_ix: int) -> int: return self.cumulative[chunk_ix - 1] if chunk_ix > 0 else 0 # raises IndexError if OOB def chunk_size(self, chunk_ix: int) -> int: return self.edges[chunk_ix] # raises IndexError if OOB def data_size(self, chunk_ix: int) -> int: offset = self.chunk_offset(chunk_ix) return max(0, min(self.edges[chunk_ix], self.extent - offset)) # raises IndexError if OOB @property def unique_edge_lengths(self) -> Iterable[int]: # lazy generator: yields unseen values, short-circuits deduplication def indices_to_chunks(self, indices: NDArray) -> NDArray: return np.searchsorted(self.cumulative, indices, side='right') def with_extent(self, new_extent: int) -> VaryingDimension: # validates cumulative[-1] >= new_extent (O(1)), re-binds extent return VaryingDimension(self.edges, extent=new_extent) def resize(self, new_extent: int) -> VaryingDimension: # grow past edge sum: append chunk of size (new_extent - sum(edges)) # shrink or grow within edge sum: preserve all edges, re-bind extent ``` Both types implement the `DimensionGrid` protocol: `nchunks`, `extent`, `index_to_chunk`, `chunk_offset`, `chunk_size`, `data_size`, `indices_to_chunks`, `unique_edge_lengths`, `with_extent`, `resize`. Memory usage scales with the number of *varying* dimensions, not total chunks. All per-chunk methods (`chunk_offset`, `chunk_size`, `data_size`) raise `IndexError` for out-of-bounds chunk indices, providing consistent fail-fast behavior across both dimension types. The two size methods serve different consumers: | Method | Returns | Consumer | |---|---|---| | `chunk_size` | Buffer size for codec processing | Codec pipeline (`ArraySpec.shape`) | | `data_size` | Valid data region within the buffer | Indexing pipeline (`chunk_selection` slicing) | For `FixedDimension`, these differ only at the boundary. For `VaryingDimension`, these differ only when the last chunk extends past the extent (i.e., `extent < sum(edges)`). This matches current zarr-python behavior: `get_chunk_spec` passes the full `chunk_shape` to the codec for all chunks, and the indexer generates a `chunk_selection` that clips the decoded buffer. ### DimensionGrid Protocol ```python @runtime_checkable class DimensionGrid(Protocol): """Structural interface shared by FixedDimension and VaryingDimension.""" @property def nchunks(self) -> int: ... @property def ngridcells(self) -> int: ... @property def extent(self) -> int: ... def index_to_chunk(self, idx: int) -> int: ... def chunk_offset(self, chunk_ix: int) -> int: ... # raises IndexError if OOB def chunk_size(self, chunk_ix: int) -> int: ... # raises IndexError if OOB def data_size(self, chunk_ix: int) -> int: ... # raises IndexError if OOB def indices_to_chunks(self, indices: NDArray[np.intp]) -> NDArray[np.intp]: ... @property def unique_edge_lengths(self) -> Iterable[int]: ... def with_extent(self, new_extent: int) -> DimensionGrid: ... def resize(self, new_extent: int) -> DimensionGrid: ... ``` The protocol is `@runtime_checkable`, enabling polymorphic handling of both dimension types without `isinstance` checks. `nchunks` and `ngridcells` differ when `extent < sum(edges)`: `nchunks` counts only chunks that overlap `[0, extent)`, while `ngridcells` counts total defined grid cells (i.e., `len(edges)`). For `FixedDimension`, both are equal. For `VaryingDimension`, they differ after a resize that shrinks the extent below the edge sum. ### ChunkSpec ```python @dataclass(frozen=True) class ChunkSpec: slices: tuple[slice, ...] # valid data region in array coordinates codec_shape: tuple[int, ...] # buffer shape for codec processing @property def shape(self) -> tuple[int, ...]: return tuple(s.stop - s.start for s in self.slices) @property def is_boundary(self) -> bool: return self.shape != self.codec_shape ``` For interior chunks, `shape == codec_shape`. For boundary chunks of a regular grid, `codec_shape` is the full declared chunk size while `shape` is clipped. For rectilinear grids, `shape == codec_shape` unless the last chunk extends past the extent. ### API ```python # Creating arrays arr = zarr.create_array(shape=(100, 200), chunks=(10, 20)) # regular arr = zarr.create_array(shape=(60, 100), chunks=[[10, 20, 30], [25, 25, 25, 25]]) # rectilinear # ChunkGrid as a collection grid = arr._chunk_grid # ChunkGrid (bound to array shape) grid.grid_shape # (10, 10) — number of chunks per dimension grid.ndim # 2 grid.is_regular # True if all dimensions are Fixed spec = grid[0, 1] # ChunkSpec for chunk at grid position (0, 1) spec.slices # (slice(0, 10), slice(20, 40)) spec.shape # (10, 20) — data shape spec.codec_shape # (10, 20) — same for interior chunks boundary = grid[9, 0] # boundary chunk (extent=100, size=10) boundary.shape # (10, 20) — data shape boundary.codec_shape # (10, 20) — codec sees full buffer grid[99, 99] # None — out of bounds for spec in grid: # iterate all chunks ... # .chunks property: retained for regular grids, raises NotImplementedError for rectilinear arr.chunks # (10, 20) # .read_chunk_sizes / .write_chunk_sizes: works for all grids (dask-style) arr.write_chunk_sizes # ((10, 10, ..., 10), (20, 20, ..., 20)) ``` `ChunkGrid.__getitem__` constructs `ChunkSpec` using `chunk_size` for `codec_shape` and `data_size` for `slices`: ```python def __getitem__(self, coords: int | tuple[int, ...]) -> ChunkSpec | None: if isinstance(coords, int): coords = (coords,) slices = [] codec_shape = [] for dim, ix in zip(self.dimensions, coords): if ix < 0 or ix >= dim.nchunks: return None offset = dim.chunk_offset(ix) slices.append(slice(offset, offset + dim.data_size(ix))) codec_shape.append(dim.chunk_size(ix)) return ChunkSpec(tuple(slices), tuple(codec_shape)) ``` #### Construction `from_sizes` requires `array_shape`, binding the extent per dimension at construction time. This is a core design choice: a chunk grid is a concrete arrangement for a specific array, not an abstract tiling pattern. ```python # Regular grid — all FixedDimension grid = ChunkGrid.from_sizes(array_shape=(100, 200), chunk_sizes=(10, 20)) # Rectilinear grid — extent = sum(edges) when shape matches grid = ChunkGrid.from_sizes(array_shape=(60, 100), chunk_sizes=[[10, 20, 30], [25, 25, 25, 25]]) # Rectilinear grid with boundary clipping — last chunk extends past array extent # e.g., shape=(55, 90) but edges sum to (60, 100): data_size clips at extent grid = ChunkGrid.from_sizes(array_shape=(55, 90), chunk_sizes=[[10, 20, 30], [25, 25, 25, 25]]) # Direct construction grid = ChunkGrid(dimensions=(FixedDimension(10, 100), VaryingDimension([10, 20, 30], 55))) ``` When `extent < sum(edges)`, the dimension is always stored as `VaryingDimension` (even if all edges are identical) to preserve the explicit edge count. The last chunk's `chunk_size` returns the full declared edge (codec buffer) while `data_size` clips to the extent. This mirrors how `FixedDimension` handles boundary chunks in regular grids. #### Serialization ```python # Regular grid: {"name": "regular", "configuration": {"chunk_shape": [10, 20]}} # Rectilinear grid (with RLE compression and "kind" field): {"name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[10, 20, 30], [[25, 4]]]}} ``` Both names deserialize to the same `ChunkGrid` class. The serialized form does not include the array extent — that comes from `shape` in array metadata and is combined with the chunk grid when constructing a `ChunkGrid` via `ChunkGrid.from_metadata()`. **The `ChunkGrid` does not serialize itself.** The format choice (`"regular"` vs `"rectilinear"`) belongs to `ArrayV3Metadata`. Serialization and deserialization are handled by the metadata-layer chunk grid classes (`RegularChunkGridMetadata` and `RectilinearChunkGridMetadata` in `metadata/v3.py`), which provide `to_dict()` and `from_dict()` methods. For `create_array`, the format is inferred from the `chunks` argument: a flat tuple produces `"regular"`, a nested list produces `"rectilinear"`. The `_is_rectilinear_chunks()` helper detects nested sequences like `[[10, 20], [5, 5]]`. ##### Rectilinear spec compliance The rectilinear format requires `"kind": "inline"` (validated by `validate_rectilinear_kind()`). Per the spec, each element of `chunk_shapes` can be: - A bare integer `m`: repeated until `sum >= array_extent` - A list of bare integers: explicit per-chunk sizes - A mixed array of bare integers and `[value, count]` RLE pairs RLE compression is used when serializing: runs of identical sizes become `[value, count]` pairs, singletons stay as bare integers. ```python # compress_rle([10, 10, 10, 5]) -> [[10, 3], 5] # expand_rle([[10, 3], 5]) -> [10, 10, 10, 5] ``` For a single-element `chunk_shapes` tuple like `(10,)`, `RectilinearChunkGridMetadata.to_dict()` serializes it as a bare integer `10`. Per the rectilinear spec, a bare integer is repeated until the sum >= extent, preserving the full codec buffer size for boundary chunks. **Zero-extent handling:** Regular grids serialize zero-extent dimensions without issue (the format encodes only `chunk_shape`, no edges). Rectilinear grids cannot represent zero-extent dimensions because the spec requires at least one positive-integer edge length per axis. #### read_chunk_sizes / write_chunk_sizes The `read_chunk_sizes` and `write_chunk_sizes` properties provide universal access to per-dimension chunk data sizes, matching the dask `Array.chunks` convention. They work for both regular and rectilinear grids: - `write_chunk_sizes`: always returns outer (storage) chunk sizes - `read_chunk_sizes`: returns inner chunk sizes when sharding is used, otherwise same as `write_chunk_sizes` ```python >>> arr = zarr.create_array(store, shape=(100, 80), chunks=(30, 40)) >>> arr.write_chunk_sizes ((30, 30, 30, 10), (40, 40)) >>> arr = zarr.create_array(store, shape=(60, 100), chunks=[[10, 20, 30], [50, 50]]) >>> arr.write_chunk_sizes ((10, 20, 30), (50, 50)) ``` The underlying `ChunkGrid.chunk_sizes` property (on the grid, not the array) returns the same as `write_chunk_sizes`. #### Resize ```python arr.resize((80, 100)) # re-binds extent; FixedDimension stays fixed arr.resize((200, 100)) # VaryingDimension grows by appending a new chunk arr.resize((30, 100)) # VaryingDimension shrinks: preserves all edges, re-binds extent ``` Resize uses `ChunkGrid.update_shape(new_shape)`, which delegates to each dimension's `.resize()` method: - `FixedDimension.resize()`: simply re-binds the extent (identical to `with_extent`) - `VaryingDimension.resize()`: grow past `sum(edges)` appends a chunk covering the gap; shrink or grow within `sum(edges)` preserves all edges and re-binds the extent (the spec allows trailing edges beyond the array extent) **Known limitation (deferred):** When growing a `VaryingDimension`, the current implementation always appends a single chunk covering the new region. For example, `[10, 10, 10]` resized from 30 to 45 produces `[10, 10, 10, 15]` instead of the more natural `[10, 10, 10, 10, 10]`. A future improvement should add an optional `chunks` parameter to `resize()` that controls how the new region is partitioned, with a sane default (e.g., repeating the last chunk size). This is safely deferrable because: - `FixedDimension` already handles resize correctly (regular grids stay regular) - The single-chunk default produces valid state, just suboptimal chunk layout - Rectilinear arrays are behind an experimental feature flag - Adding an optional parameter is backwards-compatible Open design questions for the `chunks` parameter: - Does it describe the new region only, or the entire post-resize array? - Must the overlapping portion agree with existing chunks (no rechunking)? - What is the type? Same as `chunks` in `create_array`? #### from_array The `from_array()` function handles both regular and rectilinear source arrays: ```python src = zarr.create_array(store, shape=(60, 100), chunks=[[10, 20, 30], [50, 50]]) new = zarr.from_array(data=src, store=new_store, chunks="keep") # Preserves rectilinear structure: new.write_chunk_sizes == ((10, 20, 30), (50, 50)) ``` When `chunks="keep"`, the logic checks `data._chunk_grid.is_regular`: - Regular: extracts `data.chunks` (flat tuple) and preserves shards - Rectilinear: extracts `data.write_chunk_sizes` (nested tuples) and forces shards to None ### Indexing The indexing pipeline is coupled to regular grid assumptions — every per-dimension indexer takes a scalar `dim_chunk_len: int` and uses `//` and `*`: ```python dim_chunk_ix = self.dim_sel // self.dim_chunk_len # IntDimIndexer dim_offset = dim_chunk_ix * self.dim_chunk_len # SliceDimIndexer ``` Replace `dim_chunk_len: int` with the dimension object (`FixedDimension | VaryingDimension`). The shared interface means the indexer code structure stays the same — `dim_sel // dim_chunk_len` becomes `dim_grid.index_to_chunk(dim_sel)`. O(1) for regular, binary search for varying. ### Codec pipeline Today, `get_chunk_spec()` returns the same `ArraySpec(shape=chunk_grid.chunk_shape)` for every chunk. For rectilinear grids, each chunk has a different codec shape: ```python def get_chunk_spec(self, chunk_coords, array_config, prototype) -> ArraySpec: spec = self._chunk_grid[chunk_coords] return ArraySpec(shape=spec.codec_shape, ...) ``` Note `spec.codec_shape`, not `spec.shape`. For regular grids, `codec_shape` is uniform (preserving current behavior). The boundary clipping flow is unchanged: ``` Write: user data → pad to codec_shape with fill_value → encode → store Read: store → decode to codec_shape → slice via chunk_selection → user data ``` ### Sharding The `ShardingCodec` constructs a `ChunkGrid` per shard using the shard shape as extent and the subchunk shape as `FixedDimension`. Each shard is self-contained — it doesn't need to know whether the outer grid is regular or rectilinear. Validation checks that every unique edge length per dimension is divisible by the inner chunk size, using `dim.unique_edge_lengths` for efficient polymorphic iteration (O(1) for fixed dimensions, lazy-deduplicated for varying). ``` Level 1 — Outer chunk grid (shard boundaries): regular or rectilinear Level 2 — Inner subchunk grid (within each shard): always regular Level 3 — Shard index: ceil(shard_dim / subchunk_dim) entries per dimension ``` [zarr-specs#370](https://github.com/zarr-developers/zarr-specs/pull/370) lifts the requirement that subchunk shapes evenly divide the shard shape. With the proposed `ChunkGrid`, this just means removing the `shard_shape % subchunk_shape == 0` validation — `FixedDimension` already handles boundary clipping via `data_size`. | Outer grid | Subchunk divisibility | Required change | |---|---|---| | Regular | Evenly divides (v1.0) | None | | Regular | Non-divisible (v1.1) | Remove divisibility validation | | Rectilinear | Evenly divides | Remove "sharding incompatible" guard | | Rectilinear | Non-divisible | Both changes | ### What this replaces | Current | Proposed | |---|---| | `ChunkGrid` ABC + `RegularChunkGrid` subclass | Single concrete `ChunkGrid` with `is_regular` | | `RectilinearChunkGrid` (#3534) | Same `ChunkGrid` class | | Chunk grid registry + entrypoints (#3735) | Direct name dispatch | | `arr.chunks` | Retained for regular; `arr.read_chunk_sizes`/`arr.write_chunk_sizes` for general use | | `get_chunk_shape(shape, coord)` | `grid[coord].codec_shape` or `grid[coord].shape` | ## Design decisions ### Why store the extent in ChunkGrid? The chunk grid is a concrete arrangement, not an abstract tiling pattern. A finite collection naturally has an extent. Storing it enables `__getitem__`, eliminates `dim_len` parameters from every method, and makes the grid self-describing. This does *not* mean `ArrayV3Metadata.shape` should delegate to the grid. The array shape remains an independent field in metadata. The extent is passed into the grid at construction time so it can answer boundary questions without external parameters. It is **not** serialized as part of the chunk grid JSON — it comes from the `shape` field in array metadata and is combined with the chunk grid configuration in `ChunkGrid.from_metadata()`. ### Why distinguish chunk_size from data_size? A chunk in a regular grid has two sizes. `chunk_size` is the buffer size the codec processes — always `size` for `FixedDimension`, even at the boundary (padded with `fill_value`). `data_size` is the valid data region — clipped to `extent % size` at the boundary. The indexing layer uses `data_size` to generate `chunk_selection` slices. This matches current zarr-python behavior and matters for: 1. **Backward compatibility.** Existing stores have boundary chunks encoded at full `chunk_shape`. 2. **Codec simplicity.** Codecs assume uniform input shapes for regular grids. 3. **Shard index correctness.** The index assumes `subchunk_dim`-sized entries. For `VaryingDimension`, `chunk_size == data_size` when `extent == sum(edges)`. When `extent < sum(edges)` (e.g., after a resize that keeps the last chunk oversized), `data_size` clips the last chunk. This is the fundamental difference: `FixedDimension` has a declared size plus an extent that clips data; `VaryingDimension` has explicit sizes that normally *are* the extent but can also extend past it. ### Why not a chunk grid registry? There is no known chunk grid outside the rectilinear family that retains the tessellation properties zarr-python assumes. A `match` on the grid name is sufficient. ### Why a single ChunkGrid class instead of RegularChunkGrid + RectilinearChunkGrid? [Discussed in #3534.](https://github.com/zarr-developers/zarr-python/pull/3534) @d-v-b argued that `RegularChunkGrid` is unnecessary since rectilinear is more general; @dcherian argued that downstream libraries need a fast way to detect regular grids without inspecting potentially millions of chunk edges (see [xarray#9808](https://github.com/pydata/xarray/pull/9808)). The resolution: a single `ChunkGrid` class with an `is_regular` property (O(1), cached at construction). This gives downstream code the fast-path detection @dcherian needed without the class hierarchy complexity @d-v-b wanted to avoid. The metadata document's `name` field (`"regular"` vs `"rectilinear"`) is also available for clients who inspect JSON directly. A backwards-compatibility shim in `chunk_grids.py` preserves the old `RegularChunkGrid` / `RectilinearChunkGrid` import paths with deprecation warnings — see [Backwards compatibility](#backwards-compatibility). ### Why is ChunkGrid a concrete class instead of a Protocol/ABC? The old design had `ChunkGrid` as an ABC with `RegularChunkGrid` as its only subclass. #3534 added `RectilinearChunkGrid` as a second subclass. This branch makes `ChunkGrid` a single concrete class instead, with separate metadata DTOs (`RegularChunkGridMetadata` and `RectilinearChunkGridMetadata` in `metadata/v3.py`) for serialization. All known grids are special cases of rectilinear, so there's no need for a class hierarchy at the grid level. A `ChunkGrid` Protocol/ABC would mean every caller programs against an abstract interface and adding a grid type requires implementing ~15 methods. A single class is simpler. Note: the *dimension* types (`FixedDimension`, `VaryingDimension`) do use a `DimensionGrid` Protocol — that's where the polymorphism lives. The grid-level class is concrete; the dimension-level types are polymorphic. If a genuinely novel grid type emerges that can't be expressed as a combination of per-dimension types, a grid-level Protocol can be extracted. ### Why `.chunks` raises for rectilinear grids [Debated in #3534.](https://github.com/zarr-developers/zarr-python/pull/3534) @d-v-b suggested making `.chunks` return `tuple[tuple[int, ...], ...]` (dask-style) for all grids. @dcherian strongly objected: every downstream consumer expects `tuple[int, ...]`, and silently returning a different type would be worse than raising. Materializing O(10M) chunk edges into a Python tuple is also a real performance risk ([xarray#8902](https://github.com/pydata/xarray/issues/8902#issuecomment-2546127373)). The resolution: - `.chunks` is retained for regular grids (returns `tuple[int, ...]` as before) - `.chunks` raises `NotImplementedError` for rectilinear grids with a message pointing to `.read_chunk_sizes`/`.write_chunk_sizes` - `.read_chunk_sizes` and `.write_chunk_sizes` return `tuple[tuple[int, ...], ...]` (dask convention) for all grids @maxrjones noted in review that deprecating `.chunks` for regular grids was not desirable. The current branch does not deprecate it. ### User control over grid serialization format @d-v-b raised in #3534 that users need a way to say "these chunks are regular, but serialize as rectilinear" (e.g., to allow future append/extend workflows without format changes). @jhamman initially made nested-list input always produce `RectilinearChunkGridMetadata`. The current branch resolves this via the metadata-layer chunk grid classes. When metadata is deserialized, the original name (from `{"name": "regular"}` or `{"name": "rectilinear"}`) determines which metadata class is instantiated (`RegularChunkGridMetadata` or `RectilinearChunkGridMetadata`), and that class handles serialization via `to_dict()`. Current inference behavior for `create_array`: - `chunks=(10, 20)` (flat tuple) → infers `"regular"` - `chunks=[[10, 20], [5, 5]]` (nested lists with varying sizes) → infers `"rectilinear"` - `chunks=[[10, 10], [20, 20]]` (nested lists with uniform sizes) → `from_sizes` collapses to `FixedDimension`, so `is_regular=True` and infers `"regular"` **Open question:** Should uniform nested lists preserve `"rectilinear"` to support future append workflows without a format change? This could be addressed by checking the input form before collapsing, or by allowing users to pass `chunk_grid_name` explicitly through the `create_array` API. ### Deferred: Tiled/periodic chunk patterns [#3750 discussion](https://github.com/zarr-developers/zarr-python/issues/3750) identified periodic chunk patterns as a use case not efficiently served by RLE alone. RLE compresses runs of identical values (`np.repeat`), but periodic patterns like days-per-month (`[31, 28, 31, 30, ...]` repeated 30 years) need a tile encoding (`np.tile`). Real-world examples include: - **Oceanographic models** (ROMS): HPC boundary-padded chunks like `[10, 8, 8, 8, 10]` — handled by RLE - **Temporal axes**: days-per-month, hours-per-day — need tile encoding for compact metadata - **Temporal-aware grids**: date/time-aware chunk grids that layer over other axes (raised by @LDeakin) A `TiledDimension` prototype was built ([commit 9c0f582](https://github.com/maxrjones/zarr-python/commit/9c0f582f)) demonstrating that the per-dimension design supports this without changes to indexing or the codec pipeline. However, it was intentionally excluded from this release because: 1. **Metadata format must come first.** Tile encoding requires a new `kind` value in the rectilinear spec (currently only `"inline"` is defined). This should go through [zarr-extensions#25](https://github.com/zarr-developers/zarr-extensions/pull/25), not zarr-python unilaterally. 2. **The per-dimension architecture doesn't preclude it.** A future `TiledDimension` can implement the `DimensionGrid` protocol alongside `FixedDimension` and `VaryingDimension` with no changes to indexing, codecs, or the `ChunkGrid` class. 3. **RLE covers the MVP.** Most real-world variable chunk patterns (HPC boundaries, irregular partitions) are efficiently encoded with RLE. Tile encoding is an optimization for a specific (temporal) subset. ### Metadata / Array separation (partially implemented) An earlier design doc proposed decoupling `ChunkGrid` (runtime) from `ArrayV3Metadata` (serialization), so that metadata would store only a plain dict and the array layer would construct the `ChunkGrid`. The current implementation partially realizes this separation: - **Metadata DTOs** (`RegularChunkGridMetadata`, `RectilinearChunkGridMetadata` in `metadata/v3.py`): Pure data, frozen dataclasses, no array shape. These live on `ArrayV3Metadata.chunk_grid` and represent only what goes into `zarr.json`. - **`ChunkGrid`** (`chunk_grids.py`): Shape-bound, supports indexing, iteration, and chunk specs. Lives on `AsyncArray._chunk_grid`, constructed from metadata + `shape` via `ChunkGrid.from_metadata()`. This means `ArrayV3Metadata.chunk_grid` is now a `ChunkGridMetadata` (the DTO union type), **not** the runtime `ChunkGrid`. Code that previously accessed runtime methods on `metadata.chunk_grid` (e.g., `all_chunk_coords()`, `__getitem__`) must now use the grid from the array layer instead. The name controls serialization format; each metadata DTO class provides its own `to_dict()` method for serialization. The `ChunkGrid` handles all runtime queries. ## Prior art **zarrs (Rust):** Three independent grid types behind a `ChunkGridTraits` trait. Key patterns adopted: Fixed vs Varying per dimension, prefix sums + binary search, `Option` for out-of-bounds, `NonZeroU64` for chunk dimensions, separate subchunk grid per shard, array shape at construction. **TensorStore (C++):** Stores only `chunk_shape` — boundary clipping via `valid_data_bounds` at query time. Both `RegularGridRef` and `IrregularGrid` internally. No registry. ## Migration ### Public API compatibility The user-facing API is fully backward-compatible. Existing code that creates, opens, reads, and writes zarr arrays continues to work without changes: - `zarr.create_array`, `zarr.open`, `zarr.open_array`, `zarr.open_group` -- unchanged signatures. The `chunks` parameter type is *widened* (now also accepts nested sequences for rectilinear grids), but all existing call patterns still work. - `arr.chunks` -- returns `tuple[int, ...]` for regular arrays, same as before. - `arr.shape`, `arr.dtype`, `arr.ndim`, `arr.shards` -- unchanged. - Top-level `zarr` exports -- unchanged. - Rectilinear chunks are gated behind `zarr.config.set({'array.rectilinear_chunks': True})`, so they cannot be created accidentally. New additions (purely additive): `arr.read_chunk_sizes`, `arr.write_chunk_sizes`, `zarr.experimental.ChunkGrid`, `zarr.experimental.ChunkSpec`. The breaking changes discussed below are confined to **internal modules** (`zarr.core.chunk_grids`, `zarr.core.metadata.v3`, `zarr.core.indexing`) that downstream libraries like cubed and VirtualiZarr access directly. ### Internal API compatibility trade-off analysis This section analyzes the internal breaking changes from the metadata/array separation and evaluates two strategies: (A) add backward-compatibility shims in zarr-python, vs. (B) require downstream packages to update. The baseline is **no shims at all**. #### What breaks without any shims Three API changes affect downstream code: 1. **`RegularChunkGrid` class removed from `zarr.core.chunk_grids`.** On `main`, `RegularChunkGrid` is defined in `chunk_grids.py` as a `Metadata` subclass. This branch replaces it with `RegularChunkGridMetadata` in `metadata/v3.py`. Without a shim, `from zarr.core.chunk_grids import RegularChunkGrid` raises `ImportError`. 2. **`RegularChunkGrid` no longer available from `zarr.core.metadata.v3`.** On `main`, `v3.py` imports `RegularChunkGrid` from `chunk_grids.py` for internal use. VirtualiZarr imports it from this location (`from zarr.core.metadata.v3 import RegularChunkGrid`). Without the internal import, this raises `ImportError`. 3. **`OrthogonalIndexer` constructor expects `ChunkGrid`, not `RegularChunkGrid`/`RegularChunkGridMetadata`.** Even if the import shims above resolve to `RegularChunkGridMetadata`, the indexer constructors access `chunk_grid._dimensions`, which only exists on the runtime `ChunkGrid` class. Cubed constructs `OrthogonalIndexer(selection, shape, RegularChunkGrid(chunk_shape=chunks))` directly. #### Downstream impact without shims **VirtualiZarr** (5 line changes across 2 files): ```python # manifests/array.py (line 6): import - from zarr.core.metadata.v3 import ArrayV3Metadata, RegularChunkGrid + from zarr.core.metadata.v3 import ArrayV3Metadata, RegularChunkGridMetadata # manifests/array.py (line 53): isinstance check - if not isinstance(_metadata.chunk_grid, RegularChunkGrid): + if not isinstance(_metadata.chunk_grid, RegularChunkGridMetadata): # parsers/zarr.py (line 16): import - from zarr.core.chunk_grids import RegularChunkGrid + from zarr.core.metadata.v3 import RegularChunkGridMetadata # parsers/zarr.py (line 270): isinstance check - if not isinstance(array_v3_metadata.chunk_grid, RegularChunkGrid): + if not isinstance(array_v3_metadata.chunk_grid, RegularChunkGridMetadata): # parsers/zarr.py (line 390): cast - cast(RegularChunkGrid, metadata.chunk_grid).chunk_shape + cast(RegularChunkGridMetadata, metadata.chunk_grid).chunk_shape ``` The `manifests/array.py` import is from `zarr.core.metadata.v3` (never a documented export; VirtualiZarr relied on a transitive import). The `parsers/zarr.py` import is from `zarr.core.chunk_grids` (the canonical location on `main`). Both are straightforward renames. The `.chunk_shape` attribute is unchanged on the new class. If VirtualiZarr needs to support both old and new zarr-python, a version-conditional import adds ~5 more lines. **Cubed** (3 line changes in 1 file): ```python # core/ops.py (lines 626-631) def _create_zarr_indexer(selection, shape, chunks): if zarr.__version__[0] == "3": - from zarr.core.chunk_grids import RegularChunkGrid + from zarr.core.chunk_grids import ChunkGrid from zarr.core.indexing import OrthogonalIndexer - return OrthogonalIndexer(selection, shape, RegularChunkGrid(chunk_shape=chunks)) + return OrthogonalIndexer(selection, shape, ChunkGrid.from_sizes(shape, chunks)) ``` Note that `ChunkGrid` is *not* a renamed class. `RegularChunkGrid(chunk_shape=chunks)` took only chunk sizes; `ChunkGrid.from_sizes(shape, chunks)` also requires the array shape. The `shape` parameter is already available at this call site. If cubed needs to support both old and new zarr-python: ```python def _create_zarr_indexer(selection, shape, chunks): if zarr.__version__[0] == "3": from zarr.core.indexing import OrthogonalIndexer try: from zarr.core.chunk_grids import ChunkGrid return OrthogonalIndexer(selection, shape, ChunkGrid.from_sizes(shape, chunks)) except ImportError: from zarr.core.chunk_grids import RegularChunkGrid return OrthogonalIndexer(selection, shape, RegularChunkGrid(chunk_shape=chunks)) else: from zarr.indexing import OrthogonalIndexer return OrthogonalIndexer(selection, ZarrArrayIndexingAdaptor(shape, chunks)) ``` #### What shims can cover **Shim 1: `__getattr__` in `chunk_grids.py`** (~15 lines) Maps `RegularChunkGrid` to `RegularChunkGridMetadata` with a deprecation warning. Covers: - The `from zarr.core.chunk_grids import RegularChunkGrid` import pattern (used by cubed and VirtualiZarr's `parsers/zarr.py`) - `isinstance(x, RegularChunkGrid)` checks (because the name resolves to the actual class) - `RegularChunkGrid(chunk_shape=(...))` construction (because `RegularChunkGridMetadata` accepts the same arguments) Does **not** cover: passing the result to `OrthogonalIndexer`, because `RegularChunkGridMetadata` lacks `._dimensions`. **Shim 2: `__getattr__` in `metadata/v3.py`** (~12 lines) Same pattern, covers VirtualiZarr's import from `zarr.core.metadata.v3`. Mirrors Shim 1 for a different import path. **Shim 3: Auto-coerce `ChunkGridMetadata` in indexer constructors** (~30 lines) A helper function + 1-line insertion in each of `BasicIndexer`, `OrthogonalIndexer`, `CoordinateIndexer`, and `MaskIndexer`: ```python def _resolve_chunk_grid(chunk_grid, shape): """Coerce ChunkGridMetadata to runtime ChunkGrid if needed.""" from zarr.core.chunk_grids import ChunkGrid as _ChunkGrid from zarr.core.metadata.v3 import ChunkGridMetadata if isinstance(chunk_grid, _ChunkGrid): return chunk_grid if isinstance(chunk_grid, ChunkGridMetadata): warnings.warn( "Passing ChunkGridMetadata to indexers is deprecated. " "Use ChunkGrid.from_sizes() instead.", DeprecationWarning, stacklevel=2, ) if hasattr(chunk_grid, "chunk_shape"): return _ChunkGrid.from_sizes(shape, tuple(chunk_grid.chunk_shape)) return _ChunkGrid.from_sizes(shape, chunk_grid.chunk_shapes) raise TypeError(f"Expected ChunkGrid or ChunkGridMetadata, got {type(chunk_grid)}") ``` This covers cubed's `OrthogonalIndexer(selection, shape, RegularChunkGrid(...))` pattern end-to-end (combined with Shim 1). #### Comparison | | No shims | Shims 1+2 only | Shims 1+2+3 | |---|---|---|---| | **zarr-python additions** | 0 lines | ~27 lines | ~57 lines | | **VirtualiZarr changes** | 5 lines | 0 lines | 0 lines | | **Cubed changes** | 3 lines | 3 lines | 0 lines | | **Maintenance burden** | None | Low (deprecation shims are well-understood) | Medium (indexer coercion blurs metadata/runtime boundary) | | **API clarity** | Clean (metadata DTOs and runtime types are distinct) | Good (old names redirect to new names) | Weaker (indexers implicitly accept two type families) | With Shims 1+2 only, VirtualiZarr's `manifests/array.py` import from `zarr.core.metadata.v3` is covered by Shim 2, and the `parsers/zarr.py` import from `zarr.core.chunk_grids` is covered by Shim 1. The `isinstance` checks work because both shims resolve to `RegularChunkGridMetadata`. The `cast` works because `.chunk_shape` is unchanged. So VirtualiZarr needs 0 changes with Shims 1+2. The 3 lines for cubed remain because Shim 1 resolves the import but `OrthogonalIndexer` still needs a runtime `ChunkGrid`. ### Downstream migration Migration from `main` (where only `RegularChunkGrid` and the abstract `ChunkGrid` ABC exist): | Old pattern (on `main`) | New pattern | |---|---| | `from zarr.core.chunk_grids import RegularChunkGrid` | `from zarr.core.metadata.v3 import RegularChunkGridMetadata` | | `from zarr.core.chunk_grids import ChunkGrid` (ABC) | `from zarr.core.chunk_grids import ChunkGrid` (concrete class, different API) | | `isinstance(cg, RegularChunkGrid)` | `isinstance(cg, RegularChunkGridMetadata)` or `grid.is_regular` on the runtime `ChunkGrid` | | `cg.chunk_shape` on `RegularChunkGrid` | `cg.chunk_shape` on `RegularChunkGridMetadata` (unchanged) | | `ChunkGrid.from_dict(data)` | `parse_chunk_grid(data)` from `zarr.core.metadata.v3` | | `chunk_grid.all_chunk_coords(array_shape)` | `chunk_grid.all_chunk_coords()` (shape now stored in grid) | | `chunk_grid.get_nchunks(array_shape)` | `chunk_grid.get_nchunks()` (shape now stored in grid) | During the earlier [#3534](https://github.com/zarr-developers/zarr-python/pull/3534) effort (which used separate `RegularChunkGrid`/`RectilinearChunkGrid` classes), downstream PRs and issues were opened to explore compatibility: - xarray ([#10880](https://github.com/pydata/xarray/pull/10880)), VirtualiZarr ([#877](https://github.com/zarr-developers/VirtualiZarr/pull/877)), Icechunk ([#1338](https://github.com/earth-mover/icechunk/issues/1338)), cubed ([#876](https://github.com/cubed-dev/cubed/issues/876)) These target #3534's API, not this branch's unified `ChunkGrid` design. New downstream POC branches for this design are linked in [Proofs of concepts](#proofs-of-concepts). ### Credits This implementation builds on prior work: - **[#3534](https://github.com/zarr-developers/zarr-python/pull/3534)** (@jhamman) — RLE helpers, validation logic, test cases, and the review discussion that shaped the architecture. - **[#3737](https://github.com/zarr-developers/zarr-python/pull/3737)** — extent-in-grid idea (adopted per-dimension). - **[#1483](https://github.com/zarr-developers/zarr-python/pull/1483)** — original variable chunking POC. - **[#3736](https://github.com/zarr-developers/zarr-python/pull/3736)** — resolved by storing extent per-dimension. ## Open questions 1. **Resize defaults (deferred):** When growing a rectilinear array, should `resize()` accept an optional `chunks` parameter? See the [Resize section](#resize) for details and open design questions. Regular arrays already stay regular on resize. 2. **`ChunkSpec` complexity:** `ChunkSpec` carries both `slices` and `codec_shape`. Should the grid expose separate methods for codec vs data queries instead? 3. **`__getitem__` with slices:** Should `grid[0, :]` or `grid[0:3, :]` return a sub-grid or an iterator of `ChunkSpec`s? 4. **Uniform nested lists:** Should `chunks=[[10, 10], [20, 20]]` serialize as `"rectilinear"` (preserving user intent for future append) or `"regular"` (current behavior, collapses uniform edges)? See [User control over grid serialization format](#user-control-over-grid-serialization-format). 5. **`zarr.open` with rectilinear:** @tomwhite noted in #3534 that `zarr.open(mode="w")` doesn't support rectilinear chunks directly. This could be addressed in a follow-up. ## Proofs of concepts - Zarr-Python: - branch - https://github.com/maxrjones/zarr-python/tree/poc/unified-chunk-grid - diff - https://github.com/zarr-developers/zarr-python/compare/main...maxrjones:zarr-python:poc/unified-chunk-grid?expand=1 - Xarray: - branch - https://github.com/maxrjones/xarray/tree/poc/unified-zarr-chunk-grid - diff - https://github.com/pydata/xarray/compare/main...maxrjones:xarray:poc/unified-zarr-chunk-grid?expand=1 - VirtualiZarr: - branch - https://github.com/maxrjones/VirtualiZarr/tree/poc/unified-chunk-grid - diff - https://github.com/zarr-developers/VirtualiZarr/compare/main...maxrjones:VirtualiZarr:poc/unified-chunk-grid?expand=1 - Virtual TIFF: - branch - https://github.com/virtual-zarr/virtual-tiff/tree/poc/unified-chunk-grid - diff - https://github.com/virtual-zarr/virtual-tiff/compare/main...poc/unified-chunk-grid?expand=1 - Cubed: - branch - https://github.com/maxrjones/cubed/tree/poc/unified-chunk-grid - Microbenchmarks: - https://github.com/maxrjones/zarr-chunk-grid-tests/tree/unified-chunk-grid zarr-python-3.3.0/docs/000077500000000000000000000000001523267620000147455ustar00rootroot00000000000000zarr-python-3.3.0/docs/_static/000077500000000000000000000000001523267620000163735ustar00rootroot00000000000000zarr-python-3.3.0/docs/_static/favicon-96x96.png000066400000000000000000000306521523267620000213370ustar00rootroot00000000000000PNG  IHDR_`{` pHYsodtEXtSoftwarewww.inkscape.org< IDATx}y|Uι7&lU* Ep\@[kTlUYVZpׯ-l, [s}~$dAk|>瓛s3g33̼!_L;[wG4kڽ3>B~I Nj4!oPD1۔Ec.:Џ[O觎/B}J1 8]Q?~jkPp_zkg-~޽)1 Ժ\Q6e`HJܗ6s\3_|77=el0"d~z"oeOU05uम8?:ՑLs\E!A @*G`EG3nyv,Ƽy``JZ{SNJOV:sϏbgav LI++?j]-HL2 @m4Pe?  W=SRG*>s~RL+Wzh##yx(f'Ҥf3Uu(w"T<ʍ1qsR*ں|QQI]g̘Ƭxibhӭ 5ulɭOqJ[;;Ң*& g@TYU2yj,P>x{ xɩcֵʚ`?}6x )鷉Ӳ+\ [Ϙ:D$bU)+[0{qwE7pg#;HNCP@.' Y譠XKʜ/P/B8Am (9ɩ=a 8m/SJP@䌽i臦 ,ŰaN~RMI @9Tp&Ӧ4pĽPP6JP@: 5a Q2X qYsABj:X<.+cFK5*U(bjpWc?!}t'SNNnZOBL،!\*PxkO (,VhUTJAIDêKTh=]OO0j܂{Rn+f q/' ܝ:Vw *DX`ЗWǧ6i,}nS{{0* / UU (B 0ķ'VZר@AțT^ Zma ~-RYok{"|ܓr;STp8M1= N]xԩ^DJ4OǍkC~)ό,E6p nV+WT,b*5By D:Ú aJw05q1QO ;~q僸d51}b,VG0J??Dl7.2 ot@⪺ZyKlJ!U-zXBc}(A@8|FͣJKߕ:2Q [<6()2N8` sZ,)eq)缚;kȖJs|Zeו7*n2o7.7.E-lϩW%aŷ64 Hxq5 z8Фp>tQ$ d47&DLݿx4?)DZV "y6Xg( ~e<@ߙRYR "H FZwqoѲ*t|2W|Ci>F?0{vwzB7~/0*9h+0C ͡##)OhNT >w`h#% '`( DD!Pט+cP( 'xT*a_Z5e x'Zע;y6D4- ϪЮL|rOmiЂ;ҴᢶOM-/6?ߞziB9P*04S Eu[EG'T 6"ʩɇ4RBѾ@c |d!,T]CEd)W>Z/17=S.ʽl^pGڈcǛwFA `KڠȦd]?9 e< ($!.wΚy`9nP MAαl>Xt6)4(!BԪqwP0ɢʐ29R/0yPp|YhV9֬TV4)hZS FE,VGZ^ aè7rN6@S@h~"꧍JE&oP4!olʱFbTI`w礼a"bEzͅbN~ b(dTJZuN`IQ%~Im1aӞmܜ'x0[Ӯ0/9Pg:B՚MH*:٬c O|>TjoMPgO~NMy$5PGřlmo+w4gE:gPz*QxǧaQ((/pTLe!7ՎP&ݒr[ȴUWCT,#FNu8~3?EřTD<6:oTUNLFk>7W5`ѨuY[9OzaFaNC_B y<  "T=ϟ"F>2U`(+Ð!bJEWK@ ^PbaO Fv!haM1~sj]vuK[?X?2'h kB-nB4Ӓ⛩R0ECi,Fbj a: Tx9 ŹUv@nr1}N`JDOl']Ee+P@ c^\(^v*|V֌V[ ot8Qv-(1#(ڏtQTWVy^H{5,n9 _hcn"332 iDR +AѼTO+EDs?Ӳ-9EUcmeybǍV1< ࣇ]-b!D(1fsS GԀ } \!hy!^֎@?cRD!!1<:-$({“YK/]/ynq A5\c%a͑Yn44հxZ_ +jpt q`&irOF:w/~*\ 2WXz9M-^*pݣQȱy_?@zcf^N0hr86\)x[‚ugXZ_(e~ kS{Ѱ#do OCo4/{Mפ-=={>+n-I >6v̈́Nt|P : z>('9"*!  KoJHd)GE\S9fŽ YT: 9b~9;}Æ9y^N`EG']s6Wj%7匵Y;44Vϻ6/+ŏ Jc"JƊ3&K:pgm˽&9/lkTEIR\.}UCRA _5aW( RϘm]?lﶻl;ImVtd ux÷uO ax$r!jY2Hv5`DK(o—o.E_'dP!lTQ2kjw%{$6cg%W"WGp:aPdCؓsXSH a5*Q<Ab1mJ|E_0. r,Q$?P`(R_m DQbuTk0jḡř g &Lrx0P_!1jʹ&&&Ð(xD,C·X|*FQo AH>[N1Q ^-[FLO`̵ KcJAVN:q*_F~qu) [~?BcwxhI]q.B,(ixsyE9Z=[Rb|@C9(HX[l_&)]Ȁ7aGoi,:U\|dgH3Q =GV7{tP5 7~E֢WCAi ֬R;8A#Ty>MZ1s. |ǮFq}qYv qlr`с|EnRs!Q:Xf+xEx~u\1FH8(bǯ-iJIdR'D++prx8GI):.{ K__xXرaK"6 X9K^w߻ӰмE(AhXDT mOcbRQ|@8MD$ @ @b\$bt8״Pk& fOtBە~ո6-}W$_0&@1VeίJKSCŪhZJ.IJM5r3 U6F"ʭ\h`!?PDLZ_("\͸[gToP}KHKT嶫fm-zn;#6v@Ҫ̑'>r/NYrq1RUw|_Օ(P\t= H;Ϫ)Zճ1lS+Ix'ňK#]}6u6e;!du_C pX**kK! ⥊ CT.\/ f Ljoʏ+δ5u+z*H@L\xәG[gVgV铲5Y=>^1B!K|?MH^仔)iܾq 5B .O|?=}Kڛ蚤)\PĔ x8!ѫG@(3h ^!r}y@LB0 @O(e @  &nF0a]:^0bcdJ@e8u'^A+rW6볖$&R>ԛhfv^ \UZJU/۩Ԭ|%u A_cؔ r)aIiD4% ;J\[<_Ghx| aY1G@IBX,p։׋h*^A;aY̱'>䁹|7`3qmf6벖" & #2J %oj$|9Ǹq8m<}k3tBPgkάWi&~[ˡ ~`\[mȮm? 4ZE%RQyD-y+ ˡӫ19B0"==/#ȦUt4]G*e/XDZuygUP-&l=9cLwOy\y f'3I0y&;7_ ~ygϲI\T­q"T+`Z8*ēˡ;ib ]4ŠsP#ė;;ܳ'~!Z8B\2VnkCNipeE‡Y*9gJ>=8+쉷>kbg1/I,*-D\@=v;{mZ;*Uv/?g9,ļ'aFV\C :ʤL6Q1miZ dhaJ<,GYb5;_X ⨴X*VvM^(EPq|3b( @a/vgc"_fTšt= H_%m^ `uNKA?kXk7V T3_d|ܮ/hQ:6Uv[2Ƽ.)'M@FtMF?jqgАٱ <F@\<6$Y/,J ,!Ey%,σEZW><[Q"-l"X4wŚQ 5C{Q+v:g25dlX)DXv>9ּNą3/rD?P*th/9cmpVmV,PLcIb@ E),h Og2@b1w">*+iCz2h7lYxfb ,$]Nu$ V&^tGtvfΧE;%/NT^M{[pUcM=UxNW(QM(ׯM+@5>I 8Aܤ1՛UpQJ'C` g7 J#!JhL[(1 p !&7cs˹CL*NH9@nSwN,}hy92XptxP͵`PkRxl(( p˜/`uE=%bVLObBkZbU>AOg2@M>6SyQ-,z(-[Z|V8S_hKKP U`)[O򛤼&5f썟\U62 6qbU>"%kN [ZΟZ&7rZ{ZOnTR*]7N-OIO=c]sZyШ+IDATC/ez0jk&Q1Xl'7œpuPϱchx$i<#=LLbn5`F\*MdkU1ݱfHӊp6f= yֈ@?fTW=T8Y|V!6C }%mfX/]*QlX@oqB6]~~!"cU 9J6튲'9 E^''|0?x4I1K|7"'69wMy6)IۃY𼈳F;|o29 1EN y@rH845r@9MdQǻ ]y쨈l-%1nͤRxai}R R N1*qn1eNN;u<2wǤ& 3<#|#Ltb '#IK`Mvib"'q@>oS43J׭QEW $x-0 !v&LwERQ"tbα4_y[B^ IROF8eNns |3m ^~~G L}5' ؽ>|Jq\[¬`u7I0bgl&`˕>%1)n>s%?d.|hS]Q\z9|(no|a-9f+ʚK1,q՞;ɗU%*_Ew t]PV' C Sꞕp6-$ \-*;j! &8CWp=4ri6aM>Pó%c*h jΘ.|Q۵=9-YYs-o$ulC+e"¸=FĵPTx>l@a I^<I#K;2/uIjn,=&(XW)F<|xڢHkt8\wJ7w(̚-:#"먦l06"ozL]CKk!kO㼢YA7$|8^ jMLr.gԵ b8AN}pEYaszulI/;\U@JҫZf#\Xs$:f?4|`-Q,B޼Nز%6h#y}UU#ו7"hֹFQW8%"$h4 OA]㳏Յ}K@ Եp|;~=:Ʀ@5\-ƴH+Q-:N?@H:75z":Ŷش3}ug$n "5rК֯gj&.TDU\C]5o -άʲ56 @vDo8r8if4[KH*B:8`-6"\E]JH)(hSTAYu^ Z\$EꉾBy񱣱җ:ޢWu$Mgͨ1]2>V ^ojr#&K7 4II &]=}w5Zlp|C;(Dt й£a@m롚s(X `@zqf:8FL6*3[F8:KB+_$1\'|z90\}t_QK.qW* N)] JjTf, V䁮p&$h6G^/" o|yƷ3RR0oGt"sLrM| "za/xOD2IċJ0ӎ՘JFu}]4.< K57L#o B):N͖ `w](́J\aoZl} # M;9~{!}| (G+ Њ4mE00/Qrt zi3\ߤqYUfSlZ4D`rb ÜM1F V VpХh[HuG6ŤjU݋BPū$k(-(kec =\}a da"N*.2˻ɊP " "(pw?xe%Fw<:iPk.6.S0ad=•K闱G2ĹVZwK}@;7Lic<l;Q{wX%A_@ML ŀB]xc'FkTOAVSo M49ENUO1KC9f}t; /kf>wUo~MiK,"po $*ec&jTzhJ,Ö˻MIfa}6 }#qB,{F߂_&xUŴ<0@@Ǵu|{CɁ5V'Tn~/.K꿬롩l$BdgC@9@HK)>(oSG]m09_//l`ZAUC{i[3lAl`vEE3=~GĔ,":jƝ@@VO2.HLD\rNԢ#~'$Q8@|v56/Üc:'E;)籓Y='Y-O&9}yF~ $ho$J߳MZe10*b{p2NG /7G{?occ7V#Qğ퐠(3*D8GoI* G{C Ю_>V̥a@sϟs:+"Aa"U;~1AnkL~0Muwc$W}Chsw0ۧ}raCB A.@yWS?AdژJoRT>pMO'#ek"Hȫ :PRO)J!K޷Afm $xQRϢ{ߣ>Tom _WXڻhNN:Ax*)zʚ?ڷW!ekYн42E"T>?U>F~l/+ LS1:F+}KNKh:P XtQ| ?X;^A~(V/Wf%SVg7و_U y9D>wpIIk~FޟX;/[ˊ욹?[+*vZ_ %S^8P= 0+/-ӷ^Jч >i}r$S_Oi*2ފ"z%~qWbE>PP|EStEGIENDB`zarr-python-3.3.0/docs/_static/logo1.png000066400000000000000000001416141523267620000201310ustar00rootroot00000000000000PNG  IHDR[~gAMA a cHRMz&u0`:pQ<bKGD pHYs+tIME ~IDATxwUչ߾wfl%[4jb {5Qaf`W5k F{G`Ez{^}ff; 0{v9oﯬ $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A $H A ga lL4y L{pfD(4dUw3AU8$ɃI7 ejkJ 9 ] *Ab@ՠwAڌ퀓Dž4/`o#Uc`ȌA׭!$HRӨTaf)Ik4j`1QL JAbO/m7 ŗe$2+k#~~  QXF _W\ qH?R}d䝜0b"ua Qv@cP+wSM$!=&^43HCPsr~kT?9 /]5":]o!1 k1寗 !p1p m)kztNc& d`$C!-ֲH$@zUw A Χ}xE@:,룭jB0tKa9Sc(FoLF!mT]6KW4%H\HN kՠAU";: GU7[qpr@y'Q!!Ev6G|5M9.Ћp"8x9l&nJꑜT6r)Gxc\v8cW*qڛxp|`bcpzl(hsB[{ow3x{lOtvO>9ÙqHRPu-#|tsh < !xv΢~u!fK0'3e)ISE%Lt&ѸNEb0L).Fx2QD*S^[ryc >g+B`u7ҳ S>PV5p)T/x /ƛLϰi`0r񉪋K 46"<uL˓Ǩ0s& 3HCԁ,ZkI}RԱ`"EΏ-Fp{&܊Xg^23 UyE8ZcGp{0<1 BTat\RzTߓ.UD.!P)&Py* {O!I"Eb,3& ȃr&CHK<^\Ro`#nfp#ASaP=ӧ(PQ\LAN;hPՋnC8  E!gR<8C^WO0a^쟠?cTOF_oN\q ݇ [:K$!2E,H"N"4E{710 T6S*TDjJ2C;4qsa>ǘqW4 c>.cؐ)4q".0<хL>=|E7&z I\68l !ޣ0h#` \[WN⽪su1q6*i=<r֔x8v0`H` KqH,&ÈbQ0tYླྀNy: 9նgԅ5xħ{} ģ51G#` %Pg\FO-btkS4Z  `ıPq}CB`HJ LyFqb40 BuQ8tGH:̮){|x_đ@:5!<Sg< 'qbZek(k݇.6] J)ظj?Lz87`2PK&cSR$Pѯ@rI8qp*KBj)%"$<~N8Jϱ _bN([v|8>W}"Ӂv5@b\(ln=8[H89Ip+0 Qd5OH#x ~";[cJyT^PN7&5 "1Qy~ L5!݀ÄNClEKrdx>n: )8R;g j,0e`l |\VA`ԠH&,N};=:j"0y^S8TRG`*N6ϘƬ.gnz.nl}q"_b"K,ac-<LQfU `Ya\~\4 xy{0,?Ӊ| ^|Cg0{YQzy8 xgp\tK>-4N3m1h6pn:O?!>n&%\sL;עa'`#;yx8`WD~qYQfc1oÆ >OLYj,1傁L:?I&ݏEݺg̥`Z׌#:#zȆ <<s1e92P$w*EfTFOtk2RSnd_}=":5 ,l<  a'1!ӵNukn< 0}'V[8o* \<23cyYnSʱWK߄? ϼz >`< tm(^Xڒ!d#.3 `BF/k=)u5Qqz[ } {40: q"mG Zmq&"Tįs}iFl ӌQvn@M׳ efv>гֵǓs;*Ͻpsw!99*|":ΜhA !W|R ˁ ;Tp:!UwF!cf{35 qMV3)aYs.Wшj@*n{Ay(up30{1@C|܉:.U7NTigaKjcVJ3r6/ 4=*g΢=nq<?w$ 畢("QYۤ7 ˊ}o`v- * RBqW?l`$0!40f~ omh.)*,B^F6n Y A嗁*-AmfH,Ifp'rs dψϣ✁,]x!@$aw  FkV"O#c)z= \/#1#:9kӀ_ L5Ǭ_c bE+(DG}G%?F^5ǿ6&&0sS謁T}K?i &#B\J{HQq@ cfnpڔxFhq;!}yO-/KQq@ov,΋t( Qv9ʯSyN3j rTE5wz=Jd;yKɒ1c$[c.A؁֞r;wqV>pXaa>KlaP$KWc":p{誔)䡪!EG(e0*ϿBs8"-G2|OST`T\&2+^U ܄9p6y)Sjy &49 Rv?q0{y%HO!1c 56  ȝv4ߒٞέQ20ALBC|G[I1$ƝA8||X^>!n{M78"?^ bcBb|q];sDL$-9v-4BXk |INb1#Gx[[gɗe̟^&i/cl87JS<}m)1͇My3)kh1xΕ B?:q wk@5b-YD鱋Kn4f܍NO'].0TF Ƀ B }#E0 oc%oSEZ߬C.ho!DKح]݆gvOb^fSd=k0~PySby'Lj8(pVzg|DR0Qxb4'[!taA7mlQpN*F։> ZRHSsn;P<pJ`ݭ$ky&X$cieOt޸8BXd&;_9E]<Ů˨8Ix܏3G:0kk#+!ģ.q["7mǽC)w85CXWf9ۈ[na kXz7A5`$́Iae"|:,]j ;;0WXDdG3 Tw_!vA`CۈZ9xÀsÂƱ4Nx7E/"[u Sh Z&ޫ:(2jǸgY`+H`2p<&7^b@=﫯ʕ4En_v;#^JL_"[y]h1T@}Us|ȝ1  Fb,$d2S1SKq*p$aeB mH; ` Cו/Â[ft@ l{Twoiګ #9ܜh%ژ#zX9.|d{?P^y{W̝{IH2HϦ' 춣 pڐkD/\kĽj~cb#+e">^sk{tC=Q 5SNci'֥.$ DbV&$,`z~!ӿmv7ieEST*3/!}q:-iGy;0FYCƅEOk9/x jjb҃}O5lX]{15i 8?ZΌb9/Z6oC%mӪ6rwiLQR:a>ai7xJ+e(Wx=44 p)Gݍ]4Eń{G}91urbp.:z`;5x:*>k)?jT ep 3 Q&8c~w5[fڔI_2zO\@Qy3-"p#YW[ނpes'&XHʄZxR''\Z&#Am1406D/ߍaFsO$3 K3KYy_SiLmxz*, lL16%Чu/0^-=}+,^‡G}KBF#dYI({-?k8Ռ˛n:W=?@QpRY 5`o/NڡLr: am-Kf(RL< ϛkNbzo$#1+M_1 dqy5^W##T6߻a:P.ߛW|Ja++#HБ@K8,w6U%u<yd:ց# H)K^lGb8Ȅz[(;QKAO<v0 c{Dt[_[B_.~?} p0bnF)j4W->2cJp>-$dI`#?+Y_Sxӌ)aޤWmޟi; }#lgB-c c-`GTVeXl+( GqHI4 3(c4{#K^D\^z}l&ke S٧evIj3vrl^ D76LZ0j"R)^G3prwpL1ǺZ3ՍSct%lZE ,H&PT_P +r{|M5) L'#bV!?s5&*h:g64f_1q AaH 7;f/6j*Z;~/^PϿA$QU8|*к.>2xVIC`쵌կa.!vcdz:wˊ *G1Aʘ= lۣVoDЇK[m4M?Wkt2uJ*zLmVhtCVq`:N/جڧN t6Ǔ=a~n^ Q`|Xp|eL}bo']-fDwcdȦx 4l'~>=R`Z`_"61B <Ⱂ0Wx,dpx셬T,t7QR[4G A'6м.]DgQFv̶T=:.C]\acYELY'N+h,z :̳OSuhĺҜNLǠӂL_sn6q.a"b˘UmqZ1Si/'.w2S /x'hP42pJ' gwBo6_p?8? 6#, 7M7S;/ά1iLC/גw|lmQ 2u?SFp vہ#iHl-TQU8L, ^gQ=T`mo!pE-">u1z.VF7w;Bn+-X{-paI[spa#iC b+Mn]/x[08<[ek)G3 \ 7 vOQ8:n%J(| `'Lv=%BvTBϑK=8 x9x~4xHFiBsR;,B$aem/|(O,`~QX>0׭׶!b o@.X o5BGal FawnE bJYEL8jZr)mC-Ć+b:eu?!F&*_h[~֫[wD!=G/vɲs/}oB@D`5dxo)y6b;?xL0x!y>M Cl>>jߙ9jHֿ {aj (rQ/Z\˻,(7w1$^VINYs+n1$\ԎyKlRd#j Ȕ66D(7@m.C[wDHE1)z>m  ¥ !XxC] En%p9<AYߋIg c` \ωSjn&EBxx8GUN|$YJAQ V 2]c˵@5ؖb٩U_%0`hPg*p5M劁1 bs#o's&bXJv?=(RL6oL FaT0 ZcaZtӔbRd3Yȅ.`;w&Kns96#oKm8),ʻ>{R*dLٯ -~g~d}^(32@xEe4b\fU}Klb6 x"c<0 A>MIrA!1+-0A<3N7t=A-pjR2|=b4ʹ*;&=0 U#L: #Hal@2}Q5\fUFrF !>7LdvÒ\h<,dcQ0`7 dz&絟K^X{<{CŤT#K]OǙB}^^w Rzʾ%(MAT\Gbl85mA$ae++Ȧ8˸c?aՖe{`NHQlhW|Tgg2ĝC>.m…x~pPw (gji**rc .~Y-L:#Q дX ,5 p)nN'd:7`<}&e ohL몚( O",m @P4\@DQ{ dmD#$6KCܷLa X,#SkPs]"G0F>-RTV sK3nE/H^%dl;%~eyBf/*fFlAtI^O>%rHP/VM|2b2vK(l6%QK]f/WAwnQ+#;MPo#@tpVojBB8Yvo g,⼁#{l"Ȣ0h^^j\&MEc^\[ H|FH; q$(sm(S{iK0aB`gMܽ?T Z74 @@\ jLsU-gZHnKpf" 65i=! 8)g$>LGGט!LsY^%XF$aeBo9&1>b )m &N=`KSxQa ez, ^SܡȾB E=6$O)?6hPM޵p3!3=9܎`TiQfHeRBoK%pB*quy= ٳ}nI'b\)E۬7ka]@עs:ԜJ| +"W1-CQ\Qg)`AVÂwQ8tq|D=㼃GL$a%Ba%dZfP-`٬Z(YoK| j=M:]|My"OTZ,tcR;]i6xq(b=";Дs4dR a[+$%|g籴.z:&6OZod-N `{=_Ln%p ^V|<aNRJA^˵g8L, ^xq~<0!ϒoV3d0#Fk]qлsRW]*"h:< ښvt0~tKQk >P$Vsn|q]EMa2y6zᖥvbpuoOʨ0_>2u~Fy{,$;IJX1'>p !`U|^jD!,:q8QMpF`L-#凐mGѻU XHq:b2D֠A;V-lRL=ipj>C~ڨ4 *Jr!*NVs Yyϵp+lֿqQ-2v~Ck[׎>xL q!6Z^HȘ%cyWHU0@틸kP9=̙]4BA\xx *$R DKƶ.hHj)R!." ' y/~ \?kd|j!J#9,QJ<mNϥgM.KQ 4>=ߍǓ4ER'fNȟ@ { 4!+זܹZ/#ВE!;6J;H8-(nI2O Y@Z3jп4j06aG^RǙ{ WJ[LT";!yc(@1)s V!2T#'w!}=s'&[V3lg>f?&&HmuB=؎%N>CY7vGZ^ź;73H2Ls!ě|v3ʥyT#U+lwcKS]" B1^Ԙ`"1+N%(ԉE5n+;Кgܺ wF0 Ӫ6ኢRm1 {|[܂ B}#dWA7L<x}{Cú_ukEX^ğ`#v|U F^)u-U0qӆ {oN3ɤ] y7ܢ(ۺMb}y#!o_BhN &gFn\;Wλy͌彘cb|n}! :a V2!@ӊ2 H?ʳ){"~>-v74V Y1Rsy筁qp8Tl]3G#n2J(P D -n4oD䑒Ǎ C%AR؝yy3X* {x./ ȧ^EN3MQ[V㰨oW` lc< Enyd#ogl64ʹ*/9A8EG'OWUvvgЎB-Sb}Eh{`HDp,54 LxJ#,gO ^I`_5x.3FB<8et~dKQB#Gwbt"(mZom/s}cvn%O9+ ?I[F6f`U"1+疆Paiʄv1V,Ƨ\{x\.WAmoz"-BA [e/KHuRn#anQ-Jy4=S_T zQi9uROiujV` .7T!v}*RQ1>0pO<aGR܇k1eYn+ oQh0 Ήi8X8аc/^RC)ߪB"cap'Sf)K-6,Fa ƝonB1~Gc5ew?L1 B/tc8B@5B˫?SYM RTM'R]~ֱ-JP({s~}Kq4pbsy*X!_#ἱw5jt&Bisc'y3ݮZ$GϏ/ΫCQ&fol؏%(A(΂'NPe lF. jɘ,7@ ;p0bM*;6O>[vy6 4y]0#_-W@D%`"1+j'Qo  vBJ ̨U^~&=N]_9⽏0N0xI!a BwM 3Q]ܼXjL廍c 6Ax(#4 wfVgUd1 xυ_DzMEvi&bTm\ qQ]^``R\v ʣbbQTyc]uU4XHD_2Siv~^||GX#a)-o#K<+yL!khBl 8x"-յ3\;qh>ǺB@ZbLi'z,bR)z&P9Ra@SR.pC,ݼޕٮFBb$;MCPux&R}yk?y23xPEB o?H`6{)ʷ(faֱw[|ZG~'o}޵:ogwE*s8;>6r3ȬτΥ0;˶JBbV&φTn{8t4ぇ0Sn+*@r9>E<*e}d:&V8LU` b[;}k[!WNwoah6""ef#$#6Öh"CpG܊8թul0p(P |"VZb'- {cP!6IsC^G`B8m]eb9O/Clb$a&9p2ٵ2/#>Հ~x C7u5B c|ND7/fNrSM_B; B ܊Wk39Xcp THNF>OC b1bdm{M2'Xypo3pax<#F AtBqvTؗaD@܍.m0Ύ9tb 4K[B<;#ن@W<7?/FGx#Ղe^ .s f0\+bg!v^4U,-  A)"aApOlܠm,0;@RWtkJ[{ڄת#\Pa120h/q19|:* s]&~~8vlqPqtN!^73U8\hSb3Z~0]pJ%qM["*W}oAx?ίNS>>gj vg`"1+ !pM _Q38/xkת˾ 'pKd:Zxr ioXR"uF OXȖw`z=6arӋ\8c/k-Ac^981x}`_<a@Lܠ?6bIXiG:7jq;x4tP~zofd]afI}Żx F1>x-GN5~1r(FID:?#"P*p aC`"1+CPB𛯳]^ܳc#{ov-ֵѺvdq|8O(|mXQ4On0[jM:py(lh6PE ƕ\(~AMp^ lgxW*"aؚxbӳA?|]_ <׊êDbV&BuWt˟?NX\vIhK7cZ 8:v!mɊ r"Ǹ8ucY2 adz~tG]ֻ8796ה)F> vL c(4<ce+1ֿt|*oiZ٭lS]ЎY1?-B+'[+,޽ʆ6=940 K7V8{:Hi1,`OBbđmoׇ2Fw*2 1+zZop܉w`[d:K_10jvZa첵c [ :Tϖƍ='>⛱e{R ßJc A®g@eQ;7.ư L-o,^sҾW\63׻ʋ/Xqy3Y_Fu6A1gb!!v\u-2q-Tl$P+̰ą8{+7/d}0-D?$[ie"S[,ăAx5܃R^6 5r,!Fw] -4A@9}8_q) D> hsx*u`Ţad!;w6M*gQq{ ̤{-uךe /Ϣhb(+* H0'b.b$OP]x5z-BC{nDv{'C| Wx"aU)8sX^ ބ !oӴ܈^:6aHsm$XEHD[z0P9};_a\'xx@_3ΤhPi{;.죑xV.85N/k&f4\ggSE?F=+gn2#3ʂa_TJF+B`B-=5ADSE>SKB{04A{\k5&Ex>cS\K'* J˛t,7L^1b BlDpeuڍ+j$aeC^xJ> wz?ٶT};!^08 1FZv!M+)yu4s6we"_3g;iB eI׾|`⹐PKq9TR(|e+[0; $YGil 556@͒YZB`{"N'ɒ 4#S,S82{G$H$/~I @~p cScif͵AԼ\涎C ?Rg jL>?kFOy 1+j=]e3T@!p3AH]m )|i0nE 4SQ (|XyOL8I/S_#~"8^5os$mq Pj8C,$JlEvi'㍅1zO B2]M g'`̍ Qn?>|F {g)R9py6xGZᘰ^)zM B9׽_j0w;.[!ŠCRyM\4姾x*Z@+hڐ̯9 2A/,ػ救<)3WQ`&SB*zȕMh_❻8. 5致gxrU51׈?sx|R_fLvaB3BbV&Z^ Fw5ΥFje K#, xn"{b3 BB c_R_%`{bHl`Ʌ~ڧ} >:0ĺK9zMi̝4q~d"q*r`&Ns_ Խ?rF<6xcm g w^Y?Z|L/ڛЭ?d}2EB"^la.GE5hהz]ȚK-tB1ٵ ,f'{qXh+%Pfثz"t%dNWx0vwAx-RvA=Q`gk"ޥ zՖ֋Dr hMnZz1So{u9 ЁgďD3`~'ɹaW![h&_)fUޞ"J,%; J47 {xqUk>u0fa<8?_=_8)P=5kV3'|G}U>%p8bH !1#( lLS(R@ -p,yLmƴ6- V8aYPBXlz-q̑ HpJp7R-kC$g"R+0k{B; AeTq#ufehMMnXA |D G+ p|1s_J:م)<lfɆ#D"{؞>8^K}7kͅ@K䙈 e*fw#G"nr n>ڧ>o(b1A9Úo/aRH)ˈVvֽ ' q@~sAW|ץ3ͼ gV g,n3󎓫.33PRh *~EERE+4`)HZCSDDAH $dC%ےl9sfɦl5MB3gf}nGb@wġNa3щ/@#6>u4>d+ۉԩ^~< B'>K8JCZf2|TT1b JP-f}›d<߼e'sLb#?o@D-lK&*&yXܢؿ}cɈ)HSb_ 24V81O ܭ:<8N) c{AVט7&74V"2q~c*KPє=s\.M1uW7f}px)(s>պ#0xbrb2K%ǮΡ%^GD`NS5@/ġٗ Yܯh\7Nadk y]Dl49JvHTMᇱ%zU"ج&'Nى8^ANWkʻ 1J[D5 ZEThѵװdȪh*A> z&p)orFz_mSyp)͗ 2XsՄ|ă^f2wM&!b#d]01<zUfvmmY@,{;Mn{Z"GYA8"뀙8]g..4Hy9; qʞW`q6Wh]Zw,ږ^"/QlT\n;Փկ L>y^3Ox8M] }@ zӋ˹Iљ; Td'&/晊iypǃ< ڞg'(jm=^,BwxdѲ']ӜE.[ZDbOk"{$:QlZl6ߤf;LͱH#f9>0k"e&sQQ]Y] s׹޹A>;4pYmj{?Jj*'SJ<޷ xTbMG8xa{ڛn{K}qA&Xu˯ʛ:qx`= ؓ/yFЃ š -Vt^BF> zt SEu9ijYɋjZ1LAY۱:)7U;Xu$]cV` wj @oJEh]E>e?jOslu92Pث5=Jov ;hEPNp{ |׀YB~&fc9 ^; jr@ϠudrҟZOŊfs|[E5A:>-qAomqA#; ਰFΜ}I?O՞؊6]pZ'pCE/$8q=UNɈ@BDػG;z`P~!h@a9#Q5jIv2 ʞu?oǦ,VƼr9 !D=/EQyMT|8 m"2([o`G{bRGGTiB@%1gd=vGL|0TTg(~w/ʧ'1(7tU@Hoi)kI$1~}NDaPj$ާtENUfh0-Uťٕ ?Igo|8GNWe(y]ky9Oݠv"h:U'A |INпa"q,eP: اMbQ6"UY'o"50lU-@ Ѓ=Ewb_*'ۓ?Oc֗_عE*uMygAOrk4E6T{uo%yhoR&I#A. ^圕y^ 2\RT%0a}yjMf`d>qC$ EQ<"[@uį Zh1 ~M;i U'yQkm"Ź,]۝JAH<4p(%V *Y( ]>0:~ qBTp@BgbA&${ = i% BJIDAT'5RO?76`mMr[:O'adnV` Nb; EJ![fo6j/P[J/-2hPЎUSQWp],^~;p8š-t.u'ڼr qMuT> 4µ}T%ay` ;ྜ^W]$ prݫ<=۫qf/~av￸d<rS}d/.-}zpT5>[޾EBG-*V5Yzпo(P8ɈdmžEQ-oPChQ Lj:F6r{oGR[ yvZIL*(܀.Z{S`V.R^iuaêx'cQU5]Nc-Q=-MrX՘3 ,ġ Ѓ_RPcFag0֜ζ27&湤PBZ{*_ B"f 7(ށh1vgZD5w#j0-OLVܿy IJgWy6r3g'02 oNvn-m9pez RI,MQjns8ܧ*"}ZK;_B%rf{#|ߍ^fqI|}B=fQFW ЧlW# pD'b~AI<*rw7%" ~NJ<ny'g\ݶ-#8+|/p5g5X6,Z٪:Ǎ(3ii̴oow)P4w >7>Eu{23vU'R禴˃[hn-ge.et0;X[(H5D~O\i'w^oo|Yα_qו K:XU7Z;vc7?0>W@٠%Pr8(oG^@tʯA!= c[oߦD^90GEAǩ7 w ܁7@p$x{n"%&/+. Kחˈ% ^U?y?Dh&(y7Í? Z CA֡/sO>CCe~0pA,[AtDpe^lk^/ M_)A V) 7{ME~"*0{=dN g}iS8m>"rZ[X F{ M`M*f~i8 [ڐk@Qd0wy{jAnt0NB3)D1x޵۶nR#fPoan~v^ձL2Ix+7 Xo͂^8pn/?c^uX˩5T;XYo=CZt8Z[z)6"Qa+X?) wH:ǾuWT0HD2!DUT *rWhFdp yu m!@8!B3S۱@CD8$|fUvߑo]80+ThA$M|Stb,b7y P 'c]B-2kS[QP`K1Um~~~,[?*S\g#9LDT|?>6A7n/"E7jێ߹7rp6;!R@zx氼ŵI]o& MDPx D&ϝiހQox^Eϯ@ȭrD 7",A8]ac:^>xPVAz5͝ V4/Y8g¸z {f~g,1~Ғ ݿ)LQj MXq/g6 æ 8 r6ҸV,[/фq W HԛHm c~ 8T3pܟZh|e50S>l%+X xi:O\ӛUE  gzך3h>C<U# `\])a_Q`oh[_Cε!QA?T6ϸ Ce"Ҫh#>RK\/S).e1*ܱǬ,UY"~udNߠ !  N`6X^<,dVqg~ۡuZܠ>Q~>EfyabŻ3,'=|8'%>yJ]l|h웖NGRA"9IU r=ss,'6z =f ~}Z io_-7!_F9$p+ȟ}[PegnKvHUi O\Dyor1..! E4bUd?/75]d$E' K.ն7-;0IZ\3MQo}X~T5& Wt\Jpӂ\1B]ntp3 po_я+.V1׸q7k7|*K9)ޖ,Ĭߡ%<0ُgNDȄ=Dġ)~aIכ5'¥_t ѯ%o5M]:!H{GnBSK8}`w,֣*Xhh9$(lHNG~h"~i4l,QZGDs-N i j;ҙjMrjN(S0DvcQxP! s#37IU1qix"}cbieIKUSirW \r=yUnCX@mïj^$Cϓ[zAw`Y1Zq[*09! X]WUA  xqGU2": 89ʪB'薌Zyr р Yp`M5k b;Vu>!Vʋcld'ĵk9Gb&u1E|" }mUxOe[36"RT$4+T*Q-$;i2V\Cv¼ *~1BY 1&'c9@/ġ';TAE6p:;~K4qoYa44D琺[z 8q $Prb9 ʻEfnP*2]|'爵_9ׂwaLE{X7*lF_z?UM&<2+Tڭ/i3<g{c^/3A\5̫<#Ng^n P@^CXiExǎL$]>&"SfA+ՓE0n>ő 'u݌wNE@ Xp㓘m*9XGCKe%x`lXbؿ]iiڔ`1F{AQ߆|iZpDۚr&) đgUC9l讫N؛J  m+.pz!/zi5,_< ѦpOhns+T9?qM8͝c& 'zertupWrPۀTFxsv)mS^$C҉f߁.U\c;V `:y~ivQ\jbUZ %)(1wv5a9Ǚj3DѤ6I2UcF_82fS͈l+y_Wʭ&'\DYlU(yItZ]8 cOD AuHG -2r՟׽}[F7*MCEդG/8u25QVAzDA%wp@m Gn%B"rСD4=: XR ,\tġ'~>pE| 0Zj\'isT;_Jz_;Mݳ(IM>DʿVq-,Z_JY`(Ǫp&p6:W"*o ,2Q(^."WjNBSc /ǩ̀('DġX́FDGʷ/:k.x_%Q$։ؐIk-Е3>?\V*t.9CP-moDq>û{sj p"(,w"W&JF+I"!WHŒ'ߏlz =V!#P W(CX7Zx6`$9GDiU|yxI,XuN;웭M=  П7N^(xU^QK4{GHHp4)2eմIq=f$yHPҽKG^N~~giu~`BV $*^7kvDh[$Ip3<$xl 9R%P?| 8Փs7(tx@g Ѓh!΀Qh})w`ڃy.@N P(TX4EU)$yy(_W7Z^sd{Q @2˱ă+-N}tc"H1+y|UO'|]Z a] X]Vnzg[gsڒ g(qq}>h:qY% Z榳e?̓L9T?|Ua%pWɻ,%8 墳+r/u {"6e @=_ma;C=Jdın>_Om%v BN`7,\w:6MJahO gNnɻB'f-#|zr*O0 m{ (1;gsQ| pe˥ЊeJ:A`pN<.q$!t9]s1p#]!|cM7YO'0BD&͘Ź}BM (@.q~.B937XUDbgO H3PS|[լu1g"Œe fѭڰS)NkfFv6 Qq<ഭl"Gb]@(*mUTw#PG+~BnGUDAAAz)(Wm#Ao\m)Pq#8F;ӵUz&;W;~( &D{`kNA`?-gN8J.w nNA%B?$C?\b1Qjep^k|d㇬ \ۧ5J򠎺8/qt\:HEAڅ;!([8SMéC2X'WY8ciN;Y| r W5b A?A9TMkGEՌUܯpK좗 ꋾFDIAս}>ʓ .DAۉb]Q0q <]yEld! D"TpXCB md8h* >hs!xP}40XŃ=ES1[bomҤ~'sPV(@6#mB,A( IE$I<;t;ǀ]Cv50Ww0|%5l;(xq؁x"w>m*!ΡXu)!HUh j$"R(w `_(Q D|* .,7$pKhqgsNBOA?\5G>#E* zQAvhhnRb;C}I"(&CWW:ji);|EQqy,7L ;98Ys "nwBA8G}xچ)ц;fiZqh(kqj\챥 Oy/׫3ؼ!Dָ#ޞۗHy<[My 4W;QȚ\{Qȯ~8$нql^l:XP0I<RGT'MjVmdDqf-M!If"hjJ7E NPMS?\WۗCx цL\Ql -rg3<Zb/$lBBU/&?D[y<[M>oI,l8c$a Ai~EkuDuSb*z"I`1p 9t"޾j\;Qvng#/K38 'rBB^2Q#(JL@yl}1#e8m&!IDqsR_WK.WUGωO n#Cx4Wx&y'%@p!քV9nY]LT)ĶSt } (z n\5"#-P4z? ܤ#q#_m()8OG#Cx${;\ *3d [P7zC'l(!Q8A=Σ q) 8[G֝C/}nvbˡ8du6iyQpПp;&AUj3sCt'Afܮ+!A 4ת.y mPtIMzN!o #{1v)Hmj$;(A;,d/Ft$@ @ @ @ @ @ @ @ @ @ @ @ @ @ fHo'ˆD!@mpؽ޾@ E޾@>x A{B@ =HzzΝ/&t ]C (@e 00p}yОD!@`!q@8@A@ Ё @ @@ t C :!q@8t/v@peb8B_5%>nm { vQT ]8Q&c\hp A@:c(|.ϟT`LUj@ Y(+'[}K|׀o=_z (!!=@"  :¤aAD+ @&z@+O ׷{(DJDc&(躾.dYCmꋟ1} A5'^yFn6pF7n2VFw]Y6qlEV@)c!p`K co_kZXhdhJOMnPTzlAl;ou/ˎGȪ#"<~`W`l(#ܹeV[Go!&7NTH2UDtDzFC2l#AK8[>%K]0x[]Z5BF!FypW`,3eCA8dXɭNJZIEA;鍝MN0B@bׁex'R,!p0ša=?۫k"^U/vGń}'UQa q ,$?gعħy "akJZe'zTD``7b+ sWS ,izcOG 5(B5^V׌p:m`{ʁ#`60q_(E98 8([g[ܤJPؓ`|c/M<X3 7] \#aQjKgϏ(?8؇ -g#`&sZ-TM`tKv߅=o/+h1$#J(ӰSמ>otaIn>﬊U:jؾahMM](Sj`n_]i_P Yr1p%ӡC8/J~H&F +فe'"*Dr+p })qg,3S .Eց|K47!.Faq Ϙ=#GcOJ|d`%(!i(VΈ󎓁G71%*d׵ "1gBA,Θ}iG%C rv-jsjƛ$K~%:~N>_p ~o_. CBzRvd8SK$j))W:ԕ.J]$q5d݁F^?g_2J_8 ,E8C VP0)5ǧ&^YJ⭁@c=!&rfjr(ڲ_/fa?'qgc!P:VW1vc%o׊b{t}F8;EWgY(p xJs޾@~IH%*zJW:d,& ,#VFUuUnmݍ9/cU`YUi0/1R (8+\)YTRrWO Q 0fuo೪ kEVCzfl˙MX ',-ð*[ \ۥXGws*c҇$M#GUA!Q"NۍV&592,Bc1=ŒXOiy(nq[?Uzml_} }WxD<:( pB2ny-Km蚏P{fTec[q BPPU^PHl'Ҳ j }e٩$@X/@ħY Ld##VލF(,FUSQ WƞU@ S(˭<=גUP|N>J+bKͮXtME^Zt+[{OSPV=< ŒQ맼i2 T ;{ϋ^i$3-o21Yl 5؜yL 2\*,ދ>I>ʲx@PePj%pL7W uZ * f5c*%>fvoEx?` WZ+ʟ-ki0qR;E9#خi  ռD  QyKX_p"4-a#2LD[g Y-FZ`KiU Լt=O^yahϘWrYmEBQ"^TY6j&Tw`8MzZvh82Nb% 6;J|:\TFa +6bw b#1*,<l/-s.ײ=,uٳ.*U8˲Q֙[?@#2[M$A}bPr:Ox/V0&PYbf]o_v ;m5P$C,;Cb R8`2ʲ2Cۼ,;Q+ B'`Пgo^/Ç˼}j 0T ^:c1163rBB<+N9S@AKXi達1mb_Y 09lAzeU_KCJ| Ĝ Fw Ksh1o-o|@Xw %?B =ҜD|_R,GMaXkKk0f8kUIi>zTMAQu_~9jOz3i{p΃CdcWirס@,CAC#xTC)}bu%0Yх+I_ݘeWsg>ﲭĵ_~UCJHMͺa7,]&"7=ʆǪ^= DO{r[hJ~v\}>4d9z H!r:Bn8ͯA0P B?\B C3Vp?>/+('o$V忀4*¨ھUj}sÆ@ K@ħp~P2o9ӹ KU4 5ى2֚h*XqMĹ~:3؈ Ad8H/A~ۀ^:65Q'%8k݀<ഀzQ rl4i?blsՉ_f>K8:xe?=All5"ۨ@'JtMD_OTSXص?i#M\͋Uꆗu} neU/a!w~F5Q7H"EE2 Oq'{8z CKp0HAV냈wyd97us 8B>򵑗)83u&9:&v܉u.5{z_ 'vF#]}=a-j1wB@"y5H_ au,'4u9,@0=+h Gmu Ч%Vg+$rM1y+VM!C]we`=Auoǀ4JnװXC]T'CGi#PAxǤszF,ua)ĈĭIi C^ =ġkt^{8iDq Slx)`SJM݋Á#D$tK}(t鯳xJ1 Q5 k%6 ׋&hg\{?ܓmIҵR )yMD8lf:Tնlqٖ]w%˪&~Unek{#*+T֦rʇ41z5@2 {b` tnM?xΕAKKy=Q+= 6a)EwF{Mn40vmS?@ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ .[cȫL%tEXtdate:create2022-05-20T13:22:18+00:00Kc%tEXtdate:modify2022-05-20T13:22:18+00:00:>tEXtSoftwarewww.inkscape.org<IENDB`zarr-python-3.3.0/docs/_static/logo_bw.png000066400000000000000000001302301523267620000205300ustar00rootroot00000000000000PNG  IHDR;' pHYsodtEXtSoftwarewww.inkscape.org< IDATxweſ'*z/JE$XAPDP,"EcB'$T@swݛ[vw&a3;3LfO;Mm| i`S} p x #:~O\I@G>"lO}0&!3@҂fk-mhA$_9|\VOg;$D/V}8bʬےfOFO!\F?pgRFDaڡfm-mLhA=%\ '`U%m/nJNnCkafFDd~XAZgI Mmt IHpq&َdugr1{Jr "aljTN :5†>`;*02j;Hon* e{퇳6Npm' a n "h|mVCl-=cI>&96@4@((؜ WCIH&@5l?j{o"Ev Q5N~~ĹDk!=^3*ʮ6ʇ6 %]O [mOg֖t%Q}Av2;W$%%V"%Q{y=*Kfj-mm"#ͪ$|emDEp'HZ]߁ZnU ؾ gˀ%)ٽL'b oo!ۻ"@[ʹҖ6ʅ?֐4wh{vw%$b½;U*ؾvD@e"PbV:f2 83Q0hq@{D>eHn+(Ǡz? m_ߑ_J?Hپ6DK*%sA;rj>&V3O2ydžO؟HZS?Aw( 1nD CI%͞a?Dr$/i1= 4z=牂zPjm"zpJ9QEڶi; `" lntl?b{wo?ptw"42+ߵճr۷؜eETM3$ S/ؾ$G(AO$*r? կ/}H׏/IkBfD?{%}Նھd_9&m"A#]2T]?ARC ukcny J "69)#m"!ipJ o0gٞ i>I?&V'ja*y,~Ib:v[;+$ݚ ]}uG`:%]@^˒Z"`yg`I)'j$yo=IPҠt̵D#]@Ds"p /k$),mm" izY/CϘWTϰ$ 'V+'hc~MJTz?.bI;p*bg &TؖxOP^M KT<t0տhNopgyG%#iDWph.o V++$N;~&#|rVvtLt2MaDLpe6;F؏StES϶oYVi/b;p$mJ[=DPRHZJ9 @~JO耤Y$} s% |pyu o 2:Hŝ$4I ?Ib[mD^B- Fm@JT\+b`:rֿKo }ۯf;$C+)Ⱦ}SmN̾ W1"sm+>̹S#B[moDc}"%]/iVƴ&@b$*fWZgyߵRcV%ϲ}4%N_y8C$R;X81<.\I-%+QDTUA+mi>DP0rյ2W}nyIRbFU"N?+N+UO=Is~=O'dAV3Ոt笪*IҖ6Mv΢ !f f߰ tمh\7hi Y]7t 04/iY\Dp`%}w{,Dq&I:"rޱ}*q?!fAVgcۗ+ɃehA!iy>&WOf;$KQy=B&nm?퐴BfOw8-N9H!NeH*[ 矑SCp:jپ4.:E4 PY|&Բֵ}IHP-Ⱦ*nAu3q5?afrE~Y"|BY*ꨡ~IIJ*oG*})ؖO Dd(hv*Pwkjl͒6bfYf6{%%_TTz !OA%imD<.o"S(< 54ۯ8<*n &qDѽFJZ@[>hA 3N Oy\g{wۏdJP("fQ[logCIJ xhΘ,NE' }๞aOT֕ڣHGnKR"XI^X|xc$]*ilTM Fr  2 CII1nS6}[%ܓ&Ni$A[?7ڎО Bc%Yۇ߉zBB)7D 췉>V%JYhD (:l~ SkMmoo{tB=_̸Z@G Wтm*%%i۴ k 7\PC |pYΫm#^E:jHBkc&~B) άJ@eFD)^%T" M !.!(t"eKJ5諔 5tY!oßTu/Wo&{]^:"[.HL"X{I[iˌ6Gi?Jv9we*$,/ 'S>TN%~PJ@'!I>w:A#Jӻ7!ZRMg+K=sKWeu7qDr6;=̃B`8i:`=W#`SSvrhAp.!(#ђsmܷ%P5`:۟%rnǁnJDo%-J[g`P&1%1+#:e9~$&*yW};gY)G#. f$"iṱ7'Խ>tߊ|!;hSNJ#D $-H(OYҢt/-%rć>Q{q"B(C])TJ^7"gsٴHC]fqؾM[ vj*}o-DPI`s'$zìl?(WzxH\9,nN)ˣOaT%z.e90%eFHZ" "Chs._}:9꩒pE~S Y{nM~Wbu71* _}4B8f{Jfhfx"HѾ$\e†i|OFPzMbt<#neZuM&+TvqH좟P?]U1^F-!HE[Typ K"ݭ,%|@K ZLGei{gCxa.xT?R8%."bGS$+i4>3qJRDgÈ(eJex 8P҅` 3?N$mlPQɹ;AP:28G_ee|uv7&k]s~o)7DJw9s&ί׼8?~؏-DBND3E\ߧ{%Dc[1r+܀H F L,IS`Ԓu쾩A\~k4|D aʄAD /%GwbaG;P"ȝw!6uoRA-k5r]X!  M:"yJ6L%s(V x A5g3޹sOlݍ&1+wMO={I:G/4r_9KYryTk4r? {O:>"3/SYU/֋7r[d[Mt#PZd-ˀmSI;/gaBd-~,!iI)δ^?ƶwtgq%U( ?ۇI $!,m<{r:WRpG1Ht>BDږm_'ދ&+OL\h#>!ҫ>l$ \IyVm_6` ؾ3PjFk;X< ih"L~%:"s%[5Y~&GDҟȉKHc}oJ]_''EދU 7F%(HFҹEQBkI[H h[f\Omqu$]In`;ۛپ%PJ.%{ucI:D[\m\8{?LRJiU؅8#W9l]VW&4A%j5?$7D"<{K*~FHRҭ(`âJ`{}(icI!^M gWt9ک0z/CED ɾ}fu pOCtZ, jwf+R},WsM OHru4yG,%X,Nؤ;DNe Dζ>BvJqY~%IQnmqDKZFA(qf!tn8{};fBZ!T\߈Ⱦa´+˄2fDCgNn#'%f%𴤣LkD!"ZÍ&}O$]AUu=h`9z iDcLR fu(Akؾ̎tIK@p3>K<!\JX{.Ljb1$$͞Kt(n/iaIlߢY 8ʹ}+s7)`AW+Ժzί*cVLdD{&E%]Md{l_-2 >#-JA,nx=O$RJL ?hZ,nNIJ*itL^Kθ"~vI)ؾǡE|lWK!ym'lo)j=Jk $B^JURv,†:C;usI-" Db\L8Z/?S .$ t*TcnF[nVIrt1/?$zť&Ky#b<[%m^uDZZ] }ǒ]㊲eIJ2ɝ~'eUA@#'왻FZLda"PV;#[LdW{Zr_N IYG[#iBd:h"xh-Хg `{h85pAlе㬈:c5uL w ծHj=1pHزi8T=磓}˥:fC(Lvԋk4r2&\BhkHʒ.#L9S*/q%I3)>[cb0Ii qm_DpE |䟳klGZ%mYdI7B{~/͟*2UB.gyNI!{|^]={ A)wWqL(x8h=. KWZ 8/$-JjWqI!<9ϓl:"go]yk%_ #ϑ=i$ T4K Ot=N1ˊwslCʶ~:ܟ>W%~ؙP޳K*]v#N퓈GkRtL̾7&ۑeq{ *y({+{$"b#Enۛ1C}]!jW4&JS"f%ճY%}hA0.+'V)t=?FgCl`{ tD+m !(#IG*T;O"N DrJDs~$iUΑ6ȗ/r!TV9%2V9;꟱}-NI#"4HBuf3K2[IXYk}G@$DR@*)>'>O6t RN lL\OΚuaDjLz8I~? Srg5өr~Ba:۟#3)t4zv-(:SOu?Um i&I_"rEClf0Nˈ[0 %m-p|aM17PQ:D,_}<1PJJG[#cG ߓ4WZpH[!2&K:9V9W}} DȆڙ00m7DxbWvShy'$>Db++>" H :f5[oZhT6= z晴hڞh7}',>? +&1XpLmI~|'Jsg5 <漶fq0"+y6IwJƮDOHE`ݹyieOo_~'}@WD]'JodKysߚ56Zg!8Թ˛`3zB&C3N`ihV"?&ɇP"ȝwM\תڿ Y`>^D;`"po Rq{NuN5103dh/"ȝgh6TM8iM W\N'\RELxֶuV&*Eonp31{9q6!Te}Cۏ;J+8L~3=:Thzn3$m,?RXOT6 b87cx*]ew+AdRyλH9y%*LyDϨ$( ˕yqys\Ūp:4J-+܊cV:a74Օ$*1CCv%^Jc SWzHPBQ Yn];"M4.YP^ }9R{pZ"2ȶ=I+4 Rs&n]Lص59X0& qZxX`7,DpE'`00pTt]Ev'n&B܊ n~9T q*D68b%Qpc( Rg̻(6L+ad-DH-s/KhI;lHrnݒ=LqʥaP @{^L/Yhd!wEm>I?&ϣ e"|PZG?i(bvZ/QU#(:v71`ygvG5bBL8lEbQķ}Ʊ"=+Dͫ%DйfHHMUԂl?nv3i= Nq y@7=,L;&v-!r_&dų+ON :jM=r.^",?1X ݥhx>O_爕ڜ=vB't|&1AP,Nm9{4p^/128QO"s,O#]> gMwVMlε7]L'^%bKk7s bD!{ N3`f[ N3E`:캿h6Nvď0krߝ*HN&~'RKQh԰gX7Ib;[zY~DPu?q]]++,Wڅ{mH:^}^È`<1뙩EFg[3f|105A}Mgs YDP1nԵFsGtAdX>%zve.@ -vcܱ?=ǵFUe:fӯQ)MB'8f#edb%17L!zg\ubQG[#ۆ\4h~k$NU͆\DDo4Ca p"ȝkA |؟!QǞ@ gc{Ufn TV9 'ܹf%T͒/t̿DPtnLO lߋܗ` Um_`#I+zМԇs׃ eGPM 6l!n)s*kW_Q_},`."qay2^ j>ù4VAl%V;9̒ftBcۗ_%R鉖y(s = ¾+"Gv_xr:ۛ^dA瞠7DQ9WRthZVO>q% 'f?iel!yQ  > C:^s" /0ۥ?kFS`I$_z$a,TI :d@dJ+JXRf&'[IK%B;^IT(/uTմ!tI&=9".olWwt,A'K߲-b2I߂qC /)H^xך=Ol/ ʊw኶ t.}$>]B\GdVђ" `NIG+B DI?V`{Qkq _km7UgIZQ@x)Qu.|PHIe{'Idժi(FLntvwz>W~*l_:kBY~Mmb\fI߭oBY~M Sg[DTM>T;T(3|L ٶoT(3 a Sz/Qʍp '#M69aBCTbf<jԴA:_]a{q4J>;[8+w7Mss2NdqQzu]Q.KdAS?U)5@?u9Y"d QP]Ki-M@ɛteљޢB1^G#yrˆ wשLa2B7A9k<%sQDl IOV$Ot!\{x"#D;ih"EBT҃kvJkfp?,P]}D.yt&7FhOqy#e%[BƎZ J@c]1 {FJ}tB wluMt& WFjYQ!oP ʔ^ FD1yp][{z"f^9rT/QJ"CZHxM" "}gc#jU1JB`UޔsTִ 2?Ϫ +?nk%Gq{:z&jCOg[Dpף~nzw[XUOde:_`bN`/Oo z"'>/rͷy1Ι۟/T=矦fz?ـê_|%[_VAe5ZI\@=Wo$ eMKwUm bUѝy@ Ltܶ͏ "ȝcUBѩp4D;Dzw̞?o{3T=_7]>ӥEfoV5:& zkᏤmEQĤHVV 8b `abV]-x<F w]Od0y9=~WY"ȝkyCGD5~oQ]Jo"ȝkq"e!uκ5jk|BH>,"YNg\5qC7:$T1.:} `Qn`~^'O"ȝs}B*SJ7w.1~ȕkιדI~pyA>\aD;T@~d&uM4nΏxE "ةqzm5'J5[?Z-,I 0:BBk8Ν|jy>\D;jD|u~gM!{xA܇Cz mdê*2@snc{ wϫNmE969T ө}IKX-[ݗ́ԖHJxgJߦ5jsw4 7d!J'>p5BO5G~,7,imI"~!=.=PNy[v>ˁ+3Ǹ!١,$i sّ _eNIKH:Xz,[e%w_.6t qw_"N$eR[tm&P"᭪G( =D5&,#Fc$!IqoTWY<$ T m2TfϷe*4\Bvܳ燉fP8Uz =O$3VWW9tf" 2ysE3 /$af0 "$":[!&bf}-0YDP tlQ ;pG>*i?Ie2L< ih"'m:(PIݖq91fDǿy qZxN(z6N !A\!y!8 IDAT `DEVt1ޗ?loݠ0"0 . o"c1+cms{آ쭅1ߙ(+rKnj=Qk<熢D+Ξt 1{>(R)+'f$?{87 $ϿI9:-_4S."fx \H}C4^@}@t %DBI1#[UnVO娵ؚHIoM ~l!cdBY_1F/[XU0 B{BY_s|{I,JFmD3S2E8 Y*_o5Gޑ#eF bJS sܫJ^5sݺ e}ݺO7zof֙a6B# aof;(?O/h6LJ )]+k؝DDO=#VKec#OKI*]FÄi좣UTTmA~BZ7TB`53b?w+y?o@5.Oa6rhdT?3=ښA)isfk|@F#_k{pIQi\Wk{H\({y?y"x&}}z FʈX]^ :DE8Sh$UY9YzRtQo"x`ߺM(^~Z[)iK9맵M~MNj&,K6üt/iր؃Ӧt6X(x_] /&Hy\hT%]gJ>&ӆM,N*Mf?gI! {zaзs2xw#xxʢ);#ʻW#x2gd=}A4l27f@ۓ>&:~nPY7ǁTCJHRM|d2m -5p+in>I4R$~pt@%$i~G|D|йh8һ lIK8RkB FKR_[>)R~Zov{@'y'"TxLܾ<j˰&XH/X i*Yq^:E;yߟ2(v :k*U6:STabB,%F;'ǷI)\"xG;qsz-zswc4`*) z"e" j_0@TKgD0 eDK Bx2#!bpz a~&0"4%I}rNFgEm`"s/o,t!>مXd(+ؚh"ڳӾi Dp `U"]`7 9,A)t#UILt'r$\,SeR"ڲϚ??p21~p,J | NԎRks>AaSB7(C Y8Dp7}{XwsLEsL7<;.L2s?/*v=,&N=Jϋӿ@$7L/꼫Sk*g #˃ҾB|$W9ྡFu $D+KD:5sm_j" آ=FD{+n_ϋ:+OGׄ,0g6^%ēzyaU.'ܗYm`bJ‰ Ust],JGɈs0ߤVpK$ZIԸu込'[+KӞ=Okk%lFR{g$Q4DW Ù{q/˧OyA#.IzLuƔ/T4D;ZTzFZ,IrGS!.>AsSSAyl"K]ql"حt[F5aIyjBwZ/o36"@op(U}ʶٞDYqԮ 5Ν2lWHnݏ{7ΕuYc6o"ȝ+Br{AşרYDpU[+}=ښE}˳,pgϽݚI 2&Y5m I+{q/u>F?ݪ:6zAg"]cGt. t~(Џ5r׼Z@%*}w^z #:y< $L`:7?{5R{]^h"k칯[3` UAt;uW4dySIcmѽETdךsJW?_7dY*j:% ?Շk5rޜ jW.M^"ȝ{з^CCYeJ+h-HW2aL]H'u*I Ve mI`(Z`U@'Ś/ΡT$q>l= $]At_ݝRwMzYl^%/9&lY6s/wƃv)-TzL 2ۤ?$&ƏJb{סia18c gSi$=PzlKYg>_y=sDG@Ҽk2yJ)a0{R^D*qAlV HXҵ|(1F?q?.C""Ë;HF|#%]5LstmK̾ Hڱ$"i3=Ah <"iIKaDB\s}RB~|;۟LQ#h&nmON򜓉xh"C"Ck 9%};+"h]q;j" M-$HvGٞ؏kOW]߯;Ɂ$Mjo9E!p;w ,pK"OůIڭUN _-n8Q"]VdXC칖Z=pTLevwT%ixLjk/#k߱A&n WFzف HY# 9Ջńnm$NloDI[fmmlAL>C~Q "")kt_0ř8MdxuWqc{, B^X1-Cd$qCO}uqtvt7QXXk@{ppr#N%G4Y+/<!/#Dђ)it@ڊhY1K6"x=dyÞHIY͞>"xL9ED̯:î^A `8 ,\1ll`$Jخ$jIt^ ؙhi]4lHmeb2&D;u56x>:x;RK5+B6ğԓ_FDd܍I@1[=*I!VOa*fu]L`FM[ݷc+󋘚f/R2._:70ϡk.l5=Ap" N U){6 P sx@58 o)0 ~l=#Y}d*dFR'*'J\>Ͽ cVagc4E<4 :3`0D5?c &`6< 1 < )y .;PyK œ,`s@0ػK ˍ;Z ؤ뀍n;œxX`t5ɘ | $a>󆑰t X$1 F=s,my[cj/ONtṖ޽Ԓ 6sA"`YnJ/"7vJ/92>[XKD~h94~;ƹAֶzY0UʁԯQNu}#nKkf}Մ,]Ǒp,_31Kle^=j:smD`הv}#:N}M@45ihVe/2?^=EkWyj] O`klJQv`8aJ-hb;gǩ:5!'y)&(C ߺotsA=,TOP< /y. :i @$fǥzkT4OW`-&u%vR ?vExڤ>y'mf}t;m\xAAY|3{pNF193asDuw Sɳne"ۙ<&%o;0۸hV:ҙs5 - g]C+gx:y}@(J>w6LM{ֹWT\G61zbS*9oM^]=gL/8B3:  O1&/#4#? ZNYscҙ|ys]֍F;0Vݻ)ST6?7-4`j0aXI?갎4 Ob!m3ԬS/^#=G]7:( sݎZr}o^1X6 trfeq.|=:@pSDѨHhU`zQ0ؤ>o ;+>^ 1 @:]Jjd1;Q"j,-Ldqձt~ ̍#R{QI7Kq&@ib!&mOk`+fe;Sa%*I[Ž3hBE[?DFaoKuQO6>JR#mܗǗ 8gu9a69 I1cA9T{G W`v>F`D=A٪>`˔{hܾ@uNب~/1}7fg-O~\zc]V!,k㫐LcowJ!f7|)y? _i;$R΢nE=gi@0:à"9{U0wKv^~T*QGs F`;bQ\`#2T5&_FD.G9Xؚ1hζM{Rnrvt[\¾Cqrgk`:PW2ԹfeOUy{*jrƃ-UD-"sBrэk+NTuOq"rl?a^{Ն>{3|‹Yѭe[D#KAۯs&Qh-=ϰҾXBxDd]}Z(|9܋l*_ZU/P眘A8/S+38@SS|3hHYrܩDn*%"wzMXUw8KU.U<.66?!"r)zn**ZU$P~rm"%1-RED6aδ$lt݉7cYdLwE1)\Tum/"W#`"rl6U@w[q܄ƞ#!ߦ(.XTVU=;X*`5Uc?ueEp5~sY;rgv" ni1/ߡ\ȳ?i=owwb~uebϻ`ܤFN%VDn t$nW̑n&8^Un?_D\DDUoP 1­˼xN]YUx\DB2S~rFg)쎥- xՐ|ADnż?6M9R/bdI-`goϩOs`7"2n>_cQ;aEDVMSUט ,0Yȝ/̠5E&^D6(uv9`}DD>)"sPa}|wM%(*G!zݬ, "ce70eU4M\e@#܅%ZrۘzNcc.L $MKw*g`n^&'߉ )]Tu *PDd-8p,{f(c?J0cm\)HWs AD1[}6]FUG"2 S̕ee#pu,՘671ak~EGUC}ܔI_]T u~  evl?^DVO%"lmP< "r|"RDlVYA2yLD~#"PkUj"" @S_d[Dʧ> =L׶{3l"f8K\63JOv"2DD+6=װ~|XW1<9/~o\K)qvEhWU0я1{S"r,EO-`!"GF睱\[IQ~`m0PZ >z~3'beHeT("+O4e)X׃JYEd{؄˘}foL[lE-sgU}3b襃v&Y3!pt3TVeb_YeǕU|9H\-V|cq$b*Tɍdmjwϐ}^#矩\C>vI*bgEd]U)e"" w.qҹ)\*qy}XҒMV%ލx P;NúvMly4WI1gȍT`nآy'$aoߐˠy4r0xύ \qQlBI@-9FݱI:Wi1sN uR?Qad{L}r!v^VN^QUwW`XIQE= dłnR]"6KAv"2W`':tH n6뤝@NTջ6U[OSTS2Tf|TTuoˆW]DdV]}jrv^E)j#10+[z`p3EUvrz}ʹy`ێ}|$n;:X,=D9_Ի2 m ^.Ŏ آ2 p"o\i00[]9}p.R똼UC̰HNa+4ͨR'̻ظ`/lXjձNVP,yMj\s;E}iדL#yAFHXEΙSx9sxV`;˝u+C۫{؂Pl15$o܀3O`zsh#,0I|!IE^W@p-ٔ{X [=y@mn༅&܁}\+ar}Nd)kD̹ KFuٯp;k 4Բt- MTu];C+>,y&$oPU{> 9Ey. BF.%o XA?у+MF 0Y=7*uX Mx0ZتzNKDm|Té7OQO9vC:uWot#MQUb;ϰ8rswCU͘3N͂ǿ~8a݌:"Ra~2 6<xπ hV`? , r?c`m(Ẹ(Z(6^t5XTu[U}b~G_&h>wEdu+F?WakO~JTm(p<:FUl wajDdj9L|CDDU_R=1OIb-ȡEdg .vD(⤥'N 8Kڬ펠9E^I'N5d'oU^YUN1P``gJ-x+Q^:ק^MtN?vioo!ro4 MO;Q׻ uѹESzr1A ɓ1!hsGp=nEd-ڽ2N{iz~8UTې'w93|SUM7vqW/Wv [zW:7qK\P\0j(eiK64;9{K}}|@UǪ6,3"qM1 Q# q$)Fv&?[h/Fn T0z^O."b.rSnvgU3m "Ww0X-f;ޫSռs`;c/lFap(ˋHsyj0[곆'@UP/Ӏ47XGx6sǟR`1/'Ed)Xr%zX=9lHDf @p'nEd%6nC 9iyd|U V8]jUU&ȩy#TXt7{<^y ˅dn軬s jIrԵ1p$"u[0oTjx4-"2^FI}('@USo`;'.X)4 s~skw|&7`jرW 0o Tz_y>y `ҟJVkD珹X \=)~%UDvEDl3>&/aY䗘q<9DdI5 [ٕFx.ƀOl+sF ە螳{5<z9T:ф~Kla1IU6[?hX:)Zg|NyROƂ[^{ =Lu1Ot0p{6:^5F\07УgI:}~ |,8l6{ kȍ1GD +߂5vQl]L0Kñzt&S khAws܉cvu/K5fo+h {Sa4KNPLB6?\?l\ Surl)ob.g<+#'[@1[INԄi՗$FQ=/nK-~1u[QףwFZf>]ds),eXm^(II{ Q3˯BoM {~FybapM\6h'@?.t] |6z0u#>-> e,z 3FzTsyUGU_la6>-LR0{8\Px6Deչ$"si-i11]Tml?D$YHGQqXD|VEI*FN,kGLm7;9}+)G"UT]*"ct?V 0X%q6A{K>--duy|LVS3T#j5':?P|؊Y_DZX9]D84DX_lr/a RG2 SȢjRrIDV.P x8#U-."u.T}71/ae^EUwVXqrYr>I9CUn.+"{0U}GUD"" n^r5f=#DdUg`p8.LY׮=]Gz!s>*"8HߤH nd˫mEԧ4. {Kl% ],( 9:K/~#LQlS^#rN;܆IԅᣱLyDs fG#Ryck ωߝTuo#Hujap4?ʢ1x[US!9/v9`ivOȟEl@`YU=Z={ß\Vnc\DV.m֪QD61~M\ӛ&"},/d?Ezy9oZnݱ03"X7Tl2= MTLPvϊNhvAgbk8=slLLe~[UDd# PPڕU˪zQD>-/qY6U1CmY,$7q=bǼ\t9 S IVՋQՇׯ9^\馷st˥4J!~$aڙ<n}fC8zQWTul¿|VDK1j@oL?"r'N7>dk6:MD>+`zמCYV~0ض9O(716w6똧G9$uIT>`x&"ϩ.)Ɋ:U}BU=H0RDfqc;;T^xex+"?tиmr.3MdѠ51pR^JPD=svR¤sQ>aYLwbmq SsCuPNC_3SUbovtX;׀2WgfJjɧ'_׾Lm U%c !; mӷnem)cWx+܄ֈ!"TY[S;U}-眡RUB0]jn""C05f^4INS6j-tMIU?ݕcDj,] 'I_d8Xs, 9cމr v9ޙC,-7鐜er(0F51yWj4̟<<2feU㨝ȸΉ|SYpۤ 3֟V{=<1,dHm/? 4`]w`A;P}:u~$uӁ"  pNH9gL߶i㯍r0qNJir. ލǗvS4ߩ :ԟI5Mu[zo,lg|Pl UBH15)=g^UO)* nƶƹ V\UO:B?TZ5_ñ08*lz[t/sB+~4йn7")!/}AYdXqwMBé^ $cgqr/ȭ"RLwIZ_Hܷz r1Ꝫ%$d :YD@/GWxڀ^D vo^,:'uCOE%\l4>>4էM?|!A Ys<: e_U}.ώ-hבX,w:8F;@ΡC )p\."hy*ޯK&`1"7u">[rH,.'0yZON+,A͌&ǰTuFgYʭuj)瓱ޔ5ZrE`lpɄ1X`ap^9uZ?EUPʩzx( F(ux#1qsbtʐ\mOlGX~TzUY.`y[U g鿈ccٶDp,DYr5Xn!͈8fHBΠxHc SSLI^X<r>XY{,S0='ՠ«U=cmU'ۖ*P19oay޾'4i7ƿ77XkJLy`q 7zj,vu$q&yu~c 0IJu8Z/EA; kV A\=̉yDq) >|OEm}MlK\>SfsbiI?ckn6np$`; +^Ԓzr 'Q|R0Db'l0 s_%:$^H>W)gs5)@,F1kt"X NWUr Qm( x3Xvv SiFQ }04l낼>1sh:SǶz0{a/:gg6s"S!vf.@?ph4&n~w ͎Ss C7Lt/.54i=c%o Ixɩ_)6ű'0% IDAT#ð߷9KDFtoo<*m2N\QC0/'iJ}bf2"Iw}n@1lE=x8 :>'5wΙSo\ 7BHZϩՕ z~~} &aa 1ف`{ÛCvcx$n zFEmu.Y'OֹSN^vaʶv4ZM+1>w $fd{X`nI/1a_ѹ6z\@!]"_ ႣR8j2Ap:pF/-dHiܤGyyfǢ:̡~7mȦF<rG@$rǜXv\ 5 5 c-ژ` oC4,J)|sMQ/CY;@Jd=$U P{Y^_%\S:'!;z3ECbF= C15 9fR@1\sc7HMQ$@V֘,<@0ծ З75c5k>Π%I|L.FotYww5s}c1Liiw^?B-m"+(`a [?A,n|65L~ҹ/ >2Z)>$횢]8t3Z DɬVIiCRELHzy3x 7gӤ_+`oܗrcc 8cI$,]qZ`ie1q .'1:LWY {ݢmD|b>SkحY$b`6IrxqB .)=4X5vPQ>8rфB_\tB^aWz&$j+qG$Ĥ6{~puh|)F#Ra .V`I,tfkyXXӀM3ֹ%mQY$]{ S;7*Apl]ȭÝ2UJP j;"b~0H. ^baEmL&۸@5Z$DL8vyqژ sZ:>b65y Koy\Ӄ?P  B?@=9rXG$;X@\YƦcIj % ?6Hi|-L=MIYaܾo@d,%m"e;Sj<U5 9$zOw:9H7|AV}M6uj`Tu)ouHlG! ,/px@jn>iT u4Lw1f^wm8:>L.-,~8l܃vVvJN:=hɓm=cN'"{ xG=dԍ- RWMQ?ek{'M`.|a5Lډ]ʩS--!y@P }KMJJw\A$;Sˆ19HP5-Ap|V,CxX%^w-8m>8υ:otð#(v`y,l[خlF`WUB:b❽@ϳo ys`>-{*(?!a+lhuX1/i)5$wn׻ygLp/&M}raicrmh6ha,[Е^gWy[`m:סqAC,Emw_ G_m9^:ݍ:w  rP IR/,V (ՂI7Y8Y1?nM^M̨=_/? 5ޝ]ڣvA:5KD ߐѣ@6~l!ݮVGiIxpDM-9} z}"8>.T|0lgZ,+@zp7},Km &c9Buq\Fo`hK s Em#NX[ F) `.yjMٝ׷)yR}G;O`ޯr/ ׇc|,&^# nG6}- <|Z z3{%9v?IIkaPj>>R@пL@3f OM;? 1 <oos<\D~Zs!!q`nH1^,ݜl( hVƬ~BzSו/zN県̓y:3:h&Lr}g_H/6vBR[+C<isb>!ߙdd#g2j126y AҞ_f Y_ǼVe-BJs XYg~dm@e!5?;QU!$S>`*Ȯ>U%@azFP4x> n$6>4NmJC>rަ_Z=J8bǀp-s@01c19O]JNF] Jfyh a!Do>{H_:s!jc4S9(,Z ز< 4I=(|!gGa`~rg&0u,#V6`TZ/6&$/zޙUO$[a_Ƒn̍vRAb>B do8KӔ>G6>SMcr"`zL*azLͲ,ALAbAEa;es u,.MkŔTf\ A!HVvCj3!!OD,@pNJ/ 7a{|nCo2^V=a.|jAp4̮/OsChH2w yv1,khHNS1oq Kz4+azC?``M,㢟 _P}<^TY fd ?̉ޚ'R,Z5|<灎KSf !# q=H>΋r]Ӏ;jwoApFM27va`);%xka^eJ֠aA|\zţk8|Fie6*Qv>T[ Ga\tt}p;nL-92@;6DEXyTxhStY99jxtX.Z_CByBi˧LQbI`B"p0{%mPql}F?AÈ}% --,|6vgs`ѫ{NMoppZ@i ~>t ^< qtިu09xNT^d2ps6Ki'F@qz/3yM'ȟC;sQ-vu2o >8i"ӱE:E3=z..qYf@ Gb}xՑFN?kM>ϲkbrLnp*nhev`>1=qoQ;gE\Q7b0}z:D<`ǐFFB & eJ;S$ ZtNHN ]f%' xK6A#e 4gt}O_B}@`.҄:F?97~dVxT*RH8c'28=1w@lW+fk(ރ@")cev`]}e*KVb =PSDlQ;!Xj a@N, ac@1 WƖ@9gǂT[:~2 hLbhL=jҨ27;< \rkdBw2,12Ņg:0ƂI&%ȨQyѹ濍@@&!& PeX,Ѧ/{1Cw6jΞ#c">lr ziF*[r֜|g*6~,UtkjIb-^vϔl2Sk._ |AmO4_tlԇp|lkq >hp?fy5`v0%-t6i!@O (cpR=@:25c+Iks7_@sWB8JI2c0OxB!Ā:-݇Es  N>WjaG[߁ 8/$X880nA }pw_3Z<C~@ijjwyo$jv>N@1vEu~tWƂEOƈ3E`W/{9@?NM#rOGG%@pf<UQ09m)s\:q^-y1;X8]@p׬mv؏PSK6[78>;>wtaMLv,6rtk$ح*3۷g?뻡0+M>-aғw'ΦN [q*G,ƍgC;+'=Rv`tpͳ5@>NmꁏβԦ3V*2NR,Vt?g@ [ITs <BV Y3} iP(yD7l׌v(LG5yK,nX3p^2]F:'{hU-Bmd76= /|)&$ ?vAOꝌsd]"Va}7!}.{OTgKm +;^K4! IM 6vyAP$Aot\@#7V@KF3c}"ى@~#N,U>R)91a 3 \}ׇ(l}1JP{d1,˽-ޙ//:P( `/I7f 6 ˛Xg?U;^ ޻+5C؝Z`h6z/j =yn ~_ s+ *wk[!d Pl 3v6aX^wϩATOa:a0AKqS,yxUji@$p6qF?$벯0Vh&`.|Ϫt ,mz$Ir=GCXm0/,A=Ob*@+x޷q1_Un H*`T! 4eHLI!Vtd˫!z|ј`L;NU3NVꙪ111K;eTOٺY~ EjleyUN{+)LTUK2/𜈜'"KDOQ1ϜK#hY/\fT%JI|szVRQg),a/39QU uIh<!;}rKOva"܉YVSߧ]SI$T|U; C8]D5S^@0DtY "܅0|X^?TPtjS2\gCy3/gw#!Q pS},)hG!ZDҗ@/>!he(RzVq|+ y Vt; *i[T5U=R3b@p;`po@Iq*(?/ (zJ!)8$`vB@)Kt bK2Cy-þwA+ ,ͷ8@X<: NN=$cTPvvxȻ6^+)KΨ6B]@ N3T0@0l"2|::۵*/f1) 4 niPy_fm{.ʮUIi$ J @/ fxm&"bju#҃:K#YEd$XP([WI+a솒NC@_GD2&IDAT~R X5X[U.L%v"ҿ3ƅ6RտVc2>{b w; 1*X#C| u^x*K hPv"2qY\mCKf5+h/; u~pB.!zT obpv?Fp^U},B@DȞl =<:.`KU]WUt%YT9Uй8 /"NjȂSU"`a ~UX"p vc1PJ*UFc*aO3mG]2vn1PU{+lb6oC8@X;?=8A-F "sXʇ0Pn6QT2I`gsc0NDYP0k܉`B%=#p/f9F Tu3U_̅9Dl~R,╪Q͊PUoWխ1k01&+@t2 @Dv0Gr;u*-NuTuku<UZxsœJz. Dd9GAznU?*S 7Cpۋo2 l ,r=nw~% 9;/mMu+DdVU鸾<DdX{XD(U}+sL`?3ډ+[,%w"ӱ-Ѫd+d0 RJ ,?cT3^LDvf%S|FKDdj=ŗ\7uLmM4TvJ fߋaY!x@\)$7KDdML=}'h0ފKUu|vK?:qlT QI%^RK<`F; !"ñ~wL>p!pڳ+EDd>,oQ,ӁX;EERHWP3|ʇW(U}]#.}nc * _DrQYs6aLtǩޡJ:@m/LwSU})UR`pIT޾,Ӂ׈7V6 HW.J*) ORXU}ȾUҾ 1o1ATVI%e~h,2NRY%K534UPp*PIl>lhR* "" cʷJ*pR@,/".MTէ[%TRI#i1SnKSJJ(ITYZ2 ̃%G;M_%$J ^x g<C%TRI^2ˀ/m,Z-#_%TRI4#"]/ epl/sTRI%386 hY/\$:ZTR ^xiuPJ*?""CP c6 X2(K/ TT*rKGaia40܎!._TRIdf/3x |K>ZUo(cTRI2 /H۱ WֱJ*T Xe/ 8X\B% rVfj UX|'p){%T26`/qJ燀+@)4 R$c'PB% i` 4[aQT2U^T*R@gRA""|.\3w:URI%TНT@Ёpq*@¤`mH]l?~zET7iUhRAFqpN_EJz%K* (Xpׁ_;EJ )LDd5 ,Yv}nrK%Ys;.pTPɀfG* (*۩0(U}ȾURI#iW@I"",CNQ7[%x``JLDdla"pZd*y- P0}B̆Jq=dfppbG* ""KPT"V T@0HDDvf>.VЧ p`,w'?aǿA̴y!MN lH1/;knc bah ;*14mj166hC?{S:~哪[om7s {OK+`58$k}u 5pLw.ҤFJ>A @3( WM>D'.}smR] @(-af7w l".}smR @;)-cf7 Zw,$Bƀ3Xh r-A.E`o˹633b$3ES0\OI> vSZF!lz}FAx8Cؒsm; LG!I AX,w7d Lc@@J~5 Qw'd @fdfo<=nkr ̅B Rr4Vl IJx7 RdNl/*`8:ǁ!w+Z`I+2+ ̋ \ Ǥqk6 B R*4 Cx5׺N^R'R.'K .l k 3XG7Rd^)38C8>'ӴqF B }QpBN쩬 AIv]&H_]o6l5@E!(| ա.m(2h T!ci'^?wgG=(g dQV>Zv!ϸ&HV%w.4@HU(R ӽ6 UHLsxɶRt\ F_AxNAH9i  HR9+  uHm FQwߙk]S)R7 N (pI}ls?3KZRRwl3 L]'ĥ+@jA!3 =;AxUi 3;xbـ3z@F!1D.crtK\F 4B ef+G`6ϙ O( 4F Owuߛ Hk٩2J`wg!`RT6Ruqx0=`p~mD6 @L!2SN;gxH(zfv @?v[()[ IENDB`zarr-python-3.3.0/docs/_static/logo_horizontal.svg000066400000000000000000000351061523267620000223320ustar00rootroot00000000000000 zarr-python-3.3.0/docs/api/000077500000000000000000000000001523267620000155165ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/000077500000000000000000000000001523267620000164745ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/abc/000077500000000000000000000000001523267620000172215ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/abc/buffer.md000066400000000000000000000002321523267620000210110ustar00rootroot00000000000000--- title: buffer --- ::: zarr.abc options: show_root_heading: true show_root_toc_entry: true members: false ::: zarr.abc.buffer zarr-python-3.3.0/docs/api/zarr/abc/codec.md000066400000000000000000000000511523267620000206140ustar00rootroot00000000000000--- title: codec --- ::: zarr.abc.codec zarr-python-3.3.0/docs/api/zarr/abc/index.md000066400000000000000000000012661523267620000206570ustar00rootroot00000000000000--- title: zarr.abc --- # zarr.abc Abstract base classes for extending Zarr-Python. - **[zarr.abc.buffer](./buffer.md)** - Providing access to underlying memory via [buffers](https://docs.python.org/3/c-api/buffer.html) - **[zarr.abc.codec](./codec.md)** - Expressing [zarr codecs](https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-encoding) - **[zarr.abc.metadata](./metadata.md)** - Creating metadata classes compatible with the Zarr API - **[zarr.abc.numcodec](./numcodec.md)** - Protocols and classes for modeling codec interface used by numcodecs - **[zarr.abc.store](./store.md)** - ABC for implementing Zarr stores and managing getting and setting bytes in a store zarr-python-3.3.0/docs/api/zarr/abc/metadata.md000066400000000000000000000000571523267620000213250ustar00rootroot00000000000000--- title: metadata --- ::: zarr.abc.metadata zarr-python-3.3.0/docs/api/zarr/abc/numcodec.md000066400000000000000000000000571523267620000213420ustar00rootroot00000000000000--- title: numcodec --- ::: zarr.abc.numcodec zarr-python-3.3.0/docs/api/zarr/abc/store.md000066400000000000000000000000511523267620000206730ustar00rootroot00000000000000--- title: store --- ::: zarr.abc.store zarr-python-3.3.0/docs/api/zarr/api/000077500000000000000000000000001523267620000172455ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/api/asynchronous.md000066400000000000000000000000661523267620000223240ustar00rootroot00000000000000--- title: asynchronous --- ::: zarr.api.asynchronouszarr-python-3.3.0/docs/api/zarr/api/index.md000066400000000000000000000002341523267620000206750ustar00rootroot00000000000000--- title: zarr.api --- # zarr.api Zarr provides both an [async](./asynchronous.md) and a [sync](./synchronous.md) API. See those pages for more details. zarr-python-3.3.0/docs/api/zarr/api/synchronous.md000066400000000000000000000002421523267620000221570ustar00rootroot00000000000000--- title: synchronous --- ::: zarr.api options: show_root_heading: true show_root_toc_entry: true members: false ::: zarr.api.synchronouszarr-python-3.3.0/docs/api/zarr/array.md000066400000000000000000000000431523267620000201310ustar00rootroot00000000000000::: zarr.Array ::: zarr.AsyncArray zarr-python-3.3.0/docs/api/zarr/buffer/000077500000000000000000000000001523267620000177455ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/buffer/cpu.md000066400000000000000000000000241523267620000210520ustar00rootroot00000000000000::: zarr.buffer.cpu zarr-python-3.3.0/docs/api/zarr/buffer/gpu.md000066400000000000000000000000241523267620000210560ustar00rootroot00000000000000::: zarr.buffer.gpu zarr-python-3.3.0/docs/api/zarr/buffer/index.md000066400000000000000000000002611523267620000213750ustar00rootroot00000000000000--- title: zarr.buffer --- Zarr provides buffer classes for both the [cpu](./cpu.md) and [gpu](./gpu.md). Generic buffer functionality is also detailed below. ::: zarr.buffer zarr-python-3.3.0/docs/api/zarr/codecs.md000066400000000000000000000000471523267620000202570ustar00rootroot00000000000000--- title: codecs --- ::: zarr.codecs zarr-python-3.3.0/docs/api/zarr/codecs/000077500000000000000000000000001523267620000177345ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/codecs/numcodecs.md000066400000000000000000000000641523267620000222360ustar00rootroot00000000000000--- title: numcodecs --- ::: zarr.codecs.numcodecs zarr-python-3.3.0/docs/api/zarr/config.md000066400000000000000000000000471523267620000202640ustar00rootroot00000000000000--- title: config --- ::: zarr.config zarr-python-3.3.0/docs/api/zarr/dtype.md000066400000000000000000000000451523267620000201420ustar00rootroot00000000000000--- title: dtype --- ::: zarr.dtype zarr-python-3.3.0/docs/api/zarr/errors.md000066400000000000000000000000461523267620000203320ustar00rootroot00000000000000--- title: errors --- ::: zarr.errorszarr-python-3.3.0/docs/api/zarr/experimental.md000066400000000000000000000002401523267620000215070ustar00rootroot00000000000000--- title: experimental --- Experimental functionality is not stable and may change or be removed at any point. ## Classes ::: zarr.experimental.cache_store zarr-python-3.3.0/docs/api/zarr/functions/000077500000000000000000000000001523267620000205045ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/functions/array.md000066400000000000000000000000521523267620000221410ustar00rootroot00000000000000--- title: zarr.array --- ::: zarr.array zarr-python-3.3.0/docs/api/zarr/functions/consolidate_metadata.md000066400000000000000000000001101523267620000251620ustar00rootroot00000000000000--- title: zarr.consolidate_metadata --- ::: zarr.consolidate_metadata zarr-python-3.3.0/docs/api/zarr/functions/create.md000066400000000000000000000000541523267620000222700ustar00rootroot00000000000000--- title: zarr.create --- ::: zarr.create zarr-python-3.3.0/docs/api/zarr/functions/create_array.md000066400000000000000000000000701523267620000234640ustar00rootroot00000000000000--- title: zarr.create_array --- ::: zarr.create_array zarr-python-3.3.0/docs/api/zarr/functions/create_group.md000066400000000000000000000000701523267620000235020ustar00rootroot00000000000000--- title: zarr.create_group --- ::: zarr.create_group zarr-python-3.3.0/docs/api/zarr/functions/create_hierarchy.md000066400000000000000000000001001523267620000243160ustar00rootroot00000000000000--- title: zarr.create_hierarchy --- ::: zarr.create_hierarchy zarr-python-3.3.0/docs/api/zarr/functions/empty.md000066400000000000000000000000521523267620000221610ustar00rootroot00000000000000--- title: zarr.empty --- ::: zarr.empty zarr-python-3.3.0/docs/api/zarr/functions/empty_like.md000066400000000000000000000000641523267620000231700ustar00rootroot00000000000000--- title: zarr.empty_like --- ::: zarr.empty_like zarr-python-3.3.0/docs/api/zarr/functions/from_array.md000066400000000000000000000000641523267620000231670ustar00rootroot00000000000000--- title: zarr.from_array --- ::: zarr.from_array zarr-python-3.3.0/docs/api/zarr/functions/full.md000066400000000000000000000000501523267620000217630ustar00rootroot00000000000000--- title: zarr.full --- ::: zarr.full zarr-python-3.3.0/docs/api/zarr/functions/full_like.md000066400000000000000000000000621523267620000227720ustar00rootroot00000000000000--- title: zarr.full_like --- ::: zarr.full_like zarr-python-3.3.0/docs/api/zarr/functions/group.md000066400000000000000000000000521523267620000221570ustar00rootroot00000000000000--- title: zarr.group --- ::: zarr.group zarr-python-3.3.0/docs/api/zarr/functions/load.md000066400000000000000000000000501523267620000217400ustar00rootroot00000000000000--- title: zarr.load --- ::: zarr.load zarr-python-3.3.0/docs/api/zarr/functions/ones.md000066400000000000000000000000501523267620000217650ustar00rootroot00000000000000--- title: zarr.ones --- ::: zarr.ones zarr-python-3.3.0/docs/api/zarr/functions/ones_like.md000066400000000000000000000000621523267620000227740ustar00rootroot00000000000000--- title: zarr.ones_like --- ::: zarr.ones_like zarr-python-3.3.0/docs/api/zarr/functions/open.md000066400000000000000000000000501523267620000217620ustar00rootroot00000000000000--- title: zarr.open --- ::: zarr.open zarr-python-3.3.0/docs/api/zarr/functions/open_array.md000066400000000000000000000000641523267620000231650ustar00rootroot00000000000000--- title: zarr.open_array --- ::: zarr.open_array zarr-python-3.3.0/docs/api/zarr/functions/open_consolidated.md000066400000000000000000000001021523267620000245100ustar00rootroot00000000000000--- title: zarr.open_consolidated --- ::: zarr.open_consolidated zarr-python-3.3.0/docs/api/zarr/functions/open_group.md000066400000000000000000000000641523267620000232030ustar00rootroot00000000000000--- title: zarr.open_group --- ::: zarr.open_group zarr-python-3.3.0/docs/api/zarr/functions/open_like.md000066400000000000000000000000621523267620000227710ustar00rootroot00000000000000--- title: zarr.open_like --- ::: zarr.open_like zarr-python-3.3.0/docs/api/zarr/functions/print_debug_info.md000066400000000000000000000001001523267620000243320ustar00rootroot00000000000000--- title: zarr.print_debug_info --- ::: zarr.print_debug_info zarr-python-3.3.0/docs/api/zarr/functions/save.md000066400000000000000000000000501523267620000217570ustar00rootroot00000000000000--- title: zarr.save --- ::: zarr.save zarr-python-3.3.0/docs/api/zarr/functions/save_array.md000066400000000000000000000000641523267620000231620ustar00rootroot00000000000000--- title: zarr.save_array --- ::: zarr.save_array zarr-python-3.3.0/docs/api/zarr/functions/save_group.md000066400000000000000000000000641523267620000232000ustar00rootroot00000000000000--- title: zarr.save_group --- ::: zarr.save_group zarr-python-3.3.0/docs/api/zarr/functions/zeros.md000066400000000000000000000000521523267620000221650ustar00rootroot00000000000000--- title: zarr.zeros --- ::: zarr.zeros zarr-python-3.3.0/docs/api/zarr/functions/zeros_like.md000066400000000000000000000000641523267620000231740ustar00rootroot00000000000000--- title: zarr.zeros_like --- ::: zarr.zeros_like zarr-python-3.3.0/docs/api/zarr/group.md000066400000000000000000000000431523267620000201470ustar00rootroot00000000000000::: zarr.Group ::: zarr.AsyncGroup zarr-python-3.3.0/docs/api/zarr/index.md000066400000000000000000000043571523267620000201360ustar00rootroot00000000000000# API Reference Complete reference documentation for the Zarr-Python API. ::: zarr options: show_root_heading: true show_root_toc_entry: true members: false ## Core API ### Essential Classes and Functions - **[Array](array.md)** - The main Zarr array class for N-dimensional data - **[Group](group.md)** - Hierarchical organization of arrays and subgroups - **[create_array](functions/create_array.md)** and **[create_group](functions/create_group.md)** - Creating new arrays and groups - **[open](functions/open.md)**, **[open_array](functions/open_array.md)**, and **[open_group](functions/open_group.md)** - Opening existing Zarr stores, arrays, and groups ### Data Operations - **[load](functions/load.md)** - Loading data from Zarr stores - **[save](functions/save.md)** - Saving data to Zarr format ### Data Types and Configuration - **[Data Types](dtype.md)** - Supported NumPy data types and type handling - **[Configuration](config.md)** - Runtime configuration and settings ## Storage and Compression - **[Codecs](codecs.md)** - Compression and filtering codecs - **[Storage](storage.md)** - Storage backend implementations and interfaces - **[Registry](registry.md)** - Codec and storage backend registry ## API Variants Zarr-Python provides both synchronous and asynchronous APIs: - **[Async API](./api/asynchronous.md)** - Asynchronous operations for concurrent access - **[Sync API](./api/synchronous.md)** - Synchronous operations for simple usage ## Abstract Base Classes The ABC module defines interfaces for extending Zarr: - **[Codec ABC](abc/codec.md)** - Interface for custom compression codecs - **[Metadata ABC](abc/metadata.md)** - Interface for metadata handling - **[Store ABC](abc/store.md)** - Interface for custom storage backends ## Utilities - **[Errors](errors.md)** - Exception classes and error handling - **[Testing](testing/index.md)** - Utilities for testing Zarr-based code ## Getting Help - Check the [User Guide](../../user-guide/index.md) for tutorials and examples - Browse function signatures and docstrings in the API reference - Report issues on [GitHub](https://github.com/zarr-developers/zarr-python) - Join discussions on the [Zarr community forum](https://github.com/zarr-developers/community) zarr-python-3.3.0/docs/api/zarr/metadata.md000066400000000000000000000001101523267620000205660ustar00rootroot00000000000000--- title: metadata --- ::: zarr.metadata ::: zarr.metadata.migrate_v3 zarr-python-3.3.0/docs/api/zarr/registry.md000066400000000000000000000000521523267620000206630ustar00rootroot00000000000000--- title: registry --- ::: zarr.registryzarr-python-3.3.0/docs/api/zarr/storage.md000066400000000000000000000001401523267620000204550ustar00rootroot00000000000000--- title: storage --- ## Attributes ::: zarr.storage.StoreLike ## Classes ::: zarr.storage zarr-python-3.3.0/docs/api/zarr/testing/000077500000000000000000000000001523267620000201515ustar00rootroot00000000000000zarr-python-3.3.0/docs/api/zarr/testing/buffer.md000066400000000000000000000000431523267620000217410ustar00rootroot00000000000000## Buffer ::: zarr.testing.buffer zarr-python-3.3.0/docs/api/zarr/testing/index.md000066400000000000000000000004161523267620000216030ustar00rootroot00000000000000--- title: zarr.testing --- # zarr.testing See the following sub-modules: - [zarr.testing.buffer](./buffer.md) - [zarr.testing.stateful](./stateful.md) - [zarr.testing.store](./store.md) - [zarr.testing.strategies](./strategies.md) - [zarr.testing.utils](./utils.md) zarr-python-3.3.0/docs/api/zarr/testing/stateful.md000066400000000000000000000000471523267620000223230ustar00rootroot00000000000000## Stateful ::: zarr.testing.stateful zarr-python-3.3.0/docs/api/zarr/testing/store.md000066400000000000000000000000421523267620000216230ustar00rootroot00000000000000 ## Store ::: zarr.testing.store zarr-python-3.3.0/docs/api/zarr/testing/strategies.md000066400000000000000000000000541523267620000226440ustar00rootroot00000000000000 ## Strategies ::: zarr.testing.strategies zarr-python-3.3.0/docs/api/zarr/testing/utils.md000066400000000000000000000000411523267620000216260ustar00rootroot00000000000000## Utils ::: zarr.testing.utils zarr-python-3.3.0/docs/blog/000077500000000000000000000000001523267620000156705ustar00rootroot00000000000000zarr-python-3.3.0/docs/blog/.authors.yml000066400000000000000000000002251523267620000201550ustar00rootroot00000000000000authors: d-v-b: name: Davis Bennett description: Core developer avatar: https://github.com/d-v-b.png url: https://github.com/d-v-b zarr-python-3.3.0/docs/blog/index.md000066400000000000000000000001241523267620000173160ustar00rootroot00000000000000# Blog News, release highlights, and design notes from the Zarr-Python developers. zarr-python-3.3.0/docs/blog/posts/000077500000000000000000000000001523267620000170405ustar00rootroot00000000000000zarr-python-3.3.0/docs/blog/posts/3.3.0-release.md000066400000000000000000000265001523267620000214440ustar00rootroot00000000000000--- date: 2026-07-30 authors: - d-v-b categories: - Release --- # Zarr-Python 3.3.0 We're happy to announce the release of version 3.3.0 of Zarr-Python. It's been a while since our last release ([3.2.1](https://github.com/zarr-developers/zarr-python/releases/tag/v3.2.1) dropped in May of this year), and we're bringing some exciting additions to the latest version. For the full release notes, see the [3.3.0 release notes](../../release-notes.md), otherwise stick around for an overview of two performance-centric highlights of this release. ## Faster low-latency storage Relevant issues and pull requests: - [#3524](https://github.com/zarr-developers/zarr-python/issues/3524) -- the performance report that started this work - [#3885](https://github.com/zarr-developers/zarr-python/pull/3885) -- synchronous codec APIs and the `FusedCodecPipeline` ### The cost of async overhead Zarr-Python 3.x uses async routines for fetching data and decoding chunks. In terms of code, this means our store (data fetching) and codec (chunk decoding) APIs are both async. This makes I/O against high-latency storage backends like cloud object storage efficient. But for *low-latency* storage, like in-process memory or the file system, async routines add measurable overhead and offer no benefit. Async only adds value when there's work to be done while waiting for I/O to complete, but when I/O latency is low, it completes too quickly to run anything while waiting, and we are left paying the performance bill for obligatory async task scheduling that offered no value. This performance problem became acute when Zarr-Python users reported that in-memory array indexing workloads ran *slower* in Zarr-Python 3.1.3 relative to Zarr-Python 2.18.7 ([#3524](https://github.com/zarr-developers/zarr-python/issues/3524)). Fortunately this performance regression had a straightforward fix (I don't say "easy" because it was a lot of work). ### Synchronous execution restores performance If async overhead makes low-latency storage slow, does *removing* that overhead restore performance? Yes, it does! In [#3885](https://github.com/zarr-developers/zarr-python/pull/3885) we defined synchronous versions of our storage and codec APIs -- the `SyncByteGetter` and `SyncByteSetter` protocols, plus a `get_ranges_sync` method on the `Store` ABC -- and then combined them in a new codec orchestration class called `FusedCodecPipeline`. The `FusedCodecPipeline` is an opt-in alternative to the default (the `BatchedCodecPipeline`) that gives large speedups for low-latency storage. It is currently marked [experimental](../../user-guide/experimental.md), so we may change it as we learn more; the default pipeline is untouched, and existing code keeps working unless you opt in. The win here is *not* a faster compressor. It is the removal of async scheduling overhead (including some [nasty `asyncio.to_thread` overhead](https://github.com/python/cpython/issues/136084)), plus a few vectorized fast paths for dense, uncompressed shards. And we only expect this new pipeline to accelerate workloads targeting a subset of storage backends, namely any store with methods that advertise low latency. On this author's 10-core Apple M4 laptop, the `FusedCodecPipeline` delivers the following results against memory-backed arrays: - uncompressed writes are *~4 times faster* - uncompressed reads are *~5 times faster* - compressed writes are *~2 times faster* - compressed reads are *~2 times faster* These numbers came from a [runnable example](../../user-guide/examples/codec_pipeline_performance.md) that ships with the documentation. Run it yourself to get a sense of how the `FusedCodecPipeline` behaves on your system -- when and how you use it depends on your hardware, your array layout, and how your chunks are compressed. What's certain is that for in-memory arrays, and arrays saved to the local file system, the `FusedCodecPipeline` is worth a try. Getting good numbers requires choosing the right level of thread-based parallelism for your workload, which is part of the configuration of the `FusedCodecPipeline`. For uncompressed chunks there's no CPU-bound work to do after fetching a chunk and so thread-based parallelism is worse than useless and slows things down. But for compressed chunks, threading offers a substantial payoff. ### How to use it Select the pipeline through the [runtime configuration](../../user-guide/config.md) by setting `codec_pipeline.path`. Set it globally to affect every array created or opened afterwards: ```python exec="true" session="blog-330" source="above" import zarr zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} ) ``` Or scope it to a block of code by using `zarr.config.set` as a context manager, which is the safer choice if you only want the new pipeline for part of your program: ```python exec="true" session="blog-330" source="above" result="ansi" import numpy as np import zarr from zarr.storage import MemoryStore with zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} ): arr = zarr.create_array( store=MemoryStore(), shape=(1000, 1000), chunks=(100, 100), shards=(1000, 1000), dtype="float32", ) arr[:] = np.random.random((1000, 1000)).astype("float32") result = arr[:] print(result.shape) ``` Thread-based parallelism is configured separately, via `codec_pipeline.max_workers`. It defaults to `None`, meaning a pool sized to `os.cpu_count()`. Note that this setting is read *only* by the `FusedCodecPipeline` -- the default `BatchedCodecPipeline` ignores it, so tuning it without opting in above does nothing. As noted, memory-backed and uncompressed workloads often do better with a single worker, which runs everything inline on the calling thread: ```python exec="true" session="blog-330" source="above" import zarr # No thread pool: run codec compute inline. Often best for uncompressed, # memory-backed arrays, where there's no CPU-bound work to overlap. zarr.config.set({"codec_pipeline.max_workers": 1}) # A fixed-size thread pool, which pays off once compression is in play. zarr.config.set({"codec_pipeline.max_workers": 8}) # Or back to the default, sized to the number of CPUs. zarr.config.set({"codec_pipeline.max_workers": None}) ``` To return to the default pipeline, set `codec_pipeline.path` back to the batched implementation: ```python exec="true" session="blog-330" source="above" import zarr zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.BatchedCodecPipeline"} ) ``` ## Faster sharded reads Relevant issues and pull requests: - [#3004](https://github.com/zarr-developers/zarr-python/pull/3004) -- optimize partial shard reads - [#3925](https://github.com/zarr-developers/zarr-python/pull/3925) -- `Store.get_ranges` for concurrent, coalesced multi-range reads - [#3987](https://github.com/zarr-developers/zarr-python/pull/3987) -- control coalescing through `ArrayConfig` and the runtime config ### How sharding works Chunks encoded with the `sharding_indexed` codec contain a secondary level of chunking, called subchunks. For example, if the `chunk_grid` field of the array metadata declares an "outer chunk" size of, say `(10, 10)`, a `sharding_indexed` codec in the `codecs` field could declare an "inner chunk" size of `(5, 5)`. Readers accessing such a chunk will observe a stored object (a stream of bytes) that decodes to an array with size `(10, 10)` (the "outer chunk"), which is comprised of four separate, contiguous byte ranges that each decode to a `(5, 5)` inner chunk. Each inner chunk occupies its own byte range in the outer chunk. A reader can satisfy a request for all four inner chunks by issuing four separate byte-range requests, or by making a *single* request for a byte range that spans all four inner chunks. The latter option is nice because it cuts down on the number of requests we need. Historically Zarr-Python used this optimization when reading entire outer chunks; in 3.3.0, we use this optimization in more cases, resulting in more efficient I/O patterns for sharded reads. ### Interval equivalence Byte ranges, being intervals, obey some combination rules: the values in two half-open intervals `[a, b), [b, c)` can be captured by the single interval `[a, c)`. That means a reader can get multiple inner chunks with *one* byte-range request by requesting a range of bytes starting with the first byte of the first subchunk and ending with the last byte of the last subchunk. When individual requests are expensive, this kind of optimization is worth a lot. The requested inner chunks are not necessarily contiguous -- there might be a byte range gap between them. As long as that gap is not too big, its often efficient to fetch the entire byte range, gap included, and pick out the inner chunk byte ranges after I/O is done. ### Byte range coalescing We call this procedure -- merging adjacent byte ranges -- "byte range coalescing", and it's a new performance optimization shipping in Zarr-Python 3.3.0. Unlike the `FusedCodecPipeline`, this one is on by default with base settings we think are good, so most users won't need to tune anything. Two knobs control it, both documented in the [runtime configuration guide](../../user-guide/config.md). Nearby byte ranges in the same shard are merged into a single request when the gap between them is no larger than `array.sharding_coalesce_max_gap_bytes` (default 1 MiB) and the merged read stays within `array.sharding_coalesce_max_bytes` (default 16 MiB). The gap threshold is what trades wasted bytes against saved requests: raising it reads more data you didn't ask for, in exchange for fewer requests. For a runnable demonstration -- counting the store requests saved and timing them against a store with simulated latency -- see the [sharded read coalescing example](../../user-guide/examples/sharding_coalescing.md). You can set them globally, or per array by passing `config={...}` to [`zarr.create_array`][]: ```python exec="true" session="blog-330" source="above" result="ansi" import zarr from zarr.storage import MemoryStore arr = zarr.create_array( store=MemoryStore(), shape=(1000, 1000), chunks=(100, 100), shards=(1000, 1000), dtype="float32", config={ "sharding_coalesce_max_gap_bytes": 4 * 1024**2, # 4 MiB "sharding_coalesce_max_bytes": 64 * 1024**2, # 64 MiB }, ) print(arr.shape) ``` ## Tell us what you think We hope these new features are helpful, and we would appreciate any feedback that helps us improve them, or any other aspect of Zarr-Python. ## Going faster The updates in this release are just the first step of a larger performance-oriented direction for Zarr-Python. Landing these two enhancements taught us a *lot* about the performance-sensitive areas of the library. We can and will invest more time in performance tuning, e.g. by adding or changing abstractions, writing code for special cases, etc. We plan to consider including compiled code that should enable significant performance improvements. The [`zarrs`](https://zarrs.dev/) project is an ecosystem of Zarr tools written in Rust, with [extremely high performance](https://book.zarrs.dev/#-zarrs-is-fast-). Is there a `zarrs` binding in Zarr-Python's future? I hope so! We are keenly observing development of [`zarrista`](https://developmentseed.org/zarrista/latest/) as a proof-of-concept for what a Python-`zarrs` binding layer might look like. Stay tuned! zarr-python-3.3.0/docs/contributing.md000066400000000000000000000637371523267620000200160ustar00rootroot00000000000000# Contributing Zarr is a community maintained project. We welcome contributions in the form of bug reports, bug fixes, documentation, enhancement proposals and more. This page provides information on how best to contribute. ## Asking for help If you have a question about how to use Zarr, please post your question on StackOverflow using the ["zarr" tag](https://stackoverflow.com/questions/tagged/zarr). If you don't get a response within a day or two, feel free to raise a [GitHub issue](https://github.com/zarr-developers/zarr-python/issues/new) including a link to your StackOverflow question. We will try to respond to questions as quickly as possible, but please bear in mind that there may be periods where we have limited time to answer questions due to other commitments. ## Bug reports If you find a bug, please raise a [GitHub issue](https://github.com/zarr-developers/zarr-python/issues/new). Please include the following items in a bug report: 1. A minimal, self-contained snippet of Python code reproducing the problem. You can format the code nicely using markdown, e.g.: ```python exec="false" reason="illustrative pseudocode with a '# etc.' placeholder, not runnable" import zarr g = zarr.group() # etc. ``` 2. An explanation of why the current behavior is wrong/not desired, and what you expect instead. 3. Information about the version of Zarr, along with versions of dependencies and the Python interpreter, and installation information. The version of Zarr can be obtained from the `zarr.__version__` attribute. Please also state how Zarr was installed, e.g., "installed via pip into a virtual environment", or "installed using conda". Information about other packages installed can be obtained by executing `pip freeze` (if using pip to install packages) or `conda env export` (if using conda to install packages) from the operating system command prompt. The version of the Python interpreter can be obtained by running a Python interactive session, e.g.: ```console python ``` ```ansi Python 3.12.7 | packaged by conda-forge | (main, Oct 4 2024, 15:57:01) [Clang 17.0.6 ] on darwin ``` ## Enhancement proposals If you have an idea about a new feature or some other improvement to Zarr, please raise a [GitHub issue](https://github.com/zarr-developers/zarr-python/issues/new) first to discuss. We very much welcome ideas and suggestions for how to improve Zarr, but please bear in mind that we are likely to be conservative in accepting proposals for new features. The reasons for this are that we would like to keep the Zarr code base lean and focused on a core set of functionalities, and available time for development, review and maintenance of new features is limited. But if you have a great idea, please don't let that stop you from posting it on GitHub, just please don't be offended if we respond cautiously. ## AI-assisted contributions AI coding tools are increasingly common in open source development. These tools are welcome in Zarr-Python, but the same standards apply to all contributions regardless of how they were produced — whether written by hand, with AI assistance, or generated entirely by an AI tool. ### You are responsible for your changes If you submit a pull request, you are responsible for understanding and having fully reviewed the changes. You must be able to explain why each change is correct and how it fits into the project. ### Communication must be your own PR descriptions, issue comments, and review responses must be in your own words. The substance and reasoning must come from you. Using AI to polish grammar or phrasing is fine, but do not paste AI-generated text as comments or review responses. ### Review every line You must have personally reviewed and understood all changes before submitting. If you used AI to generate code, you are expected to have read it critically and tested it. The PR description should explain the approach and reasoning — do not leave it to reviewers to figure out what the code does and why. ### Keep PRs reviewable Generating code with AI is fast; reviewing it is not. A large diff shifts the burden from the contributor to the reviewer. PRs that cannot be reviewed in reasonable time with reasonable effort may be closed, regardless of their potential usefulness or correctness. Use AI tools not only to write code but to prepare better, more reviewable PRs — well-structured commits, clear descriptions, and minimal scope. If you are planning a large AI-assisted contribution (e.g., a significant refactor or a new subsystem), **open an issue first** to discuss the scope and approach with maintainers. Maintainers may also request that large changes be broken into smaller, reviewable pieces. ### Documentation The same principles apply to documentation. Zarr has domain-specific semantics (chunked storage, codec pipelines, Zarr v2/v3 format details) that AI tools frequently get wrong. Do not submit documentation that you haven't carefully read and verified. ## Contributing code and/or documentation ### Forking the repository The Zarr source code is hosted on GitHub at the following location: * [https://github.com/zarr-developers/zarr-python](https://github.com/zarr-developers/zarr-python) You will need your own fork to work on the code. Go to the link above and hit the ["Fork"](https://github.com/zarr-developers/zarr-python/fork) button. Then clone your fork to your local machine: ```bash git clone git@github.com:your-user-name/zarr-python.git cd zarr-python git remote add upstream git@github.com:zarr-developers/zarr-python.git ``` ### Creating a development environment To work with the Zarr source code, it is recommended to use [hatch](https://hatch.pypa.io/latest/index.html) to create and manage development environments. Hatch will automatically install all Zarr dependencies using the same versions as are used by the core developers and continuous integration services. Assuming you have a Python 3 interpreter already installed, and you have cloned the Zarr source code and your current working directory is the root of the repository, you can do something like the following: ```bash pip install hatch hatch env show # list all available environments ``` To verify that your development environment is working, you can run the unit tests for one of the test environments, e.g.: ```bash hatch env run --env test.py3.12-optional run ``` ### Creating a branch Before you do any new work or submit a pull request, please open an issue on GitHub to report the bug or propose the feature you'd like to add. It's best to synchronize your fork with the upstream repository, then create a new, separate branch for each piece of work you want to do. E.g.: ```bash git checkout main git fetch upstream git checkout -b shiny-new-feature upstream/main git push -u origin shiny-new-feature ``` This changes your working directory to the 'shiny-new-feature' branch. Keep any changes in this branch specific to one bug or feature so it is clear what the branch brings to Zarr. To update this branch with latest code from Zarr, you can retrieve the changes from the main branch and perform a rebase: ```bash git fetch upstream git rebase upstream/main ``` This will replay your commits on top of the latest Zarr git main. If this leads to merge conflicts, these need to be resolved before submitting a pull request. Alternatively, you can merge the changes in from upstream/main instead of rebasing, which can be simpler: ```bash git pull upstream main ``` Again, any conflicts need to be resolved before submitting a pull request. ### Running the test suite Zarr includes a suite of unit tests. The simplest way to run the unit tests is to activate your development environment (see [creating a development environment](#creating-a-development-environment) above) and invoke: ```bash hatch env run --env test.py3.12-optional run ``` All tests are automatically run via GitHub Actions for every pull request and must pass before code can be accepted. Test coverage is also collected automatically via the Codecov service. ### Code standards - using prek All code must conform to the PEP8 standard. Regarding line length, lines up to 100 characters are allowed, although please try to keep under 90 wherever possible. `Zarr` uses a set of git hooks managed by [`prek`](https://github.com/j178/prek), a fast, Rust-based pre-commit hook manager that is fully compatible with `.pre-commit-config.yaml` files. `prek` can be installed locally by running: ```bash uv tool install prek ``` or: ```bash pip install prek ``` The hooks can be installed locally by running: ```bash prek install ``` This will run the checks every time a commit is created locally. The checks will by default only run on the files modified by a commit, but the checks can be triggered for all the files by running: ```bash prek run --all-files ``` You can also run hooks only for files in a specific directory: ```bash prek run --directory src/zarr ``` Or run hooks for files changed in the last commit: ```bash prek run --last-commit ``` To list all available hooks: ```bash prek list ``` If you would like to skip the failing checks and push the code for further discussion, use the `--no-verify` option with `git commit`. ### Test coverage > **Note:** Test coverage for Zarr-Python 3 is currently not at 100%. This is a known issue and help is welcome to bring test coverage back to 100%. See issue #2613 for more details. Zarr strives to maintain 100% test coverage under the latest Python stable release. Both unit tests and docstring doctests are included when computing coverage. Running: ```bash hatch env run --env test.py3.12-optional run-coverage ``` will automatically run the test suite with coverage and produce an XML coverage report. This should be 100% before code can be accepted into the main code base. You can also generate an HTML coverage report by running: ```bash hatch env run --env test.py3.12-optional run-coverage-html ``` When submitting a pull request, coverage will also be collected across all supported Python versions via the Codecov service, and will be reported back within the pull request. Codecov coverage must also be 100% before code can be accepted. ### Documentation Docstrings for user-facing classes and functions should follow the [numpydoc](https://numpydoc.readthedocs.io/en/stable/format.html#docstring-standard) standard, including sections for Parameters and Examples. All examples should run and pass as doctests under Python 3.12. Zarr uses mkdocs for documentation, hosted on readthedocs.org. Documentation is written in the Markdown markup language (.md files) in the `docs` folder. The documentation consists both of prose and API documentation. All user-facing classes and functions are included in the API documentation, under the `docs/api` folder using the [mkdocstrings](https://mkdocstrings.github.io/) extension. Add any new public functions or classes to the relevant markdown file in `docs/api/*.md`. Any new features or important usage information should be included in the user-guide (`docs/user-guide`). Any changes should also be included as a new file in the `changes` directory. The documentation can be built locally by running: ```bash hatch --env docs run build ``` The resulting built documentation will be available in the `site` folder. Hatch can also be used to serve continuously updating version of the documentation during development at [http://127.0.0.1:8000/](http://127.0.0.1:8000/). This can be done by running: ```bash hatch --env docs run serve ``` #### Adding executable code blocks in the documentation Zarr uses [Markdown Exec](https://pawamoy.github.io/markdown-exec/usage/) to execute code blocks in Markdown files. Add `exec="true"` to a code block header for it to be executed when the docs are built. For example: ````md ```python exec="true" print("Hello world") ``` ```` Below are other useful options that can be added to the code block. See [Markdown Exec's documentation](https://pawamoy.github.io/markdown-exec/usage/#options-summary) for a full list: - `source="above"` makes sure the code within the code block is also rendered in the documentation (rather than just the output). - `session=""` executes code blocks in a named session reusing previously defined variables. - `result="ansi"` or `result="html"` to render the output. If the code does not produce output, you should leave off the `result` option to prevent an empty cell from rendering in the docs. For example: ````md ```python exec="true" session="contributing" source="above" result="ansi" print("Hello world") ``` ```` renders as: ```python exec="true" session="contributing" source="above" result="ansi" print("Hello world") ``` #### Validating code blocks: `exec` vs `test` Every Python code block in the documentation is checked by a test (`tests/test_docs.py`) so that examples cannot quietly rot — the bug that motivated this was an example calling `zarr.create_array(..., mode="w")`, an argument that does not exist, which went unnoticed because nothing ran it. A block declares *how* it is validated using one of two independent attributes: - **`exec="true"`** — Markdown Exec runs the block **at docs-build time to render its output** into the page. This is the attribute described above; it is also what the test suite executes. Use it for ordinary examples whose output should appear in the docs. - **`test="true"`** — the block is **run by the test suite only**, *not* at build time. Use this for an example that should be validated but cannot run in the docs-build environment — for example one that needs a GPU or a cloud backend. Markdown Exec leaves a `test="true"` block as a static, syntax-highlighted snippet (it never executes it), while the test suite still runs it (see the marker note below). A block may carry both (`exec="true" test="true"`), though in practice `exec="true"` already implies it is tested, so you rarely need `test="true"` alongside it. The two attributes are kept separate on purpose: `exec=` controls *build-time rendering* and `test=` controls *test-time validation*. Tagging a GPU/cloud example `exec="true"` would make `mkdocs build` try to run it on a machine without that infrastructure and fail the build; `test="true"` lets it be validated without being built. ##### Opting a block out of validation A handful of blocks genuinely cannot run and are not executable Python — a REPL transcript, a deliberately-incorrect "before" snippet, a `--8<--` file include. Mark these explicitly by opening the fence with `exec="false" reason="REPL output transcript, not executable source"` (supply a reason that fits the block). `exec="false"` with a non-empty `reason` is an explicit, greppable opt-out. A test (`test_no_unvalidated_blocks`) requires **every** Python block to be either `exec="true"`, `test="true"`, or `exec="false"` with a reason — so a block can never silently skip validation. A bare ` ```python ` fence, or a typo like `exec="on"`, fails that test. Markdown Exec only renders `exec="true"` fences; the `mkdocs_hooks.py` hook at the repository root makes `test="true"` and `exec="false"` fences render as ordinary highlighted code blocks. Without it, these fences would fail superfences parsing and their contents would spill into the page as raw markdown. ##### Marker-bound blocks (GPU, S3) A `test="true"` block that needs special infrastructure declares a pytest marker with `markers="..."`, which binds it to that infrastructure in the test suite: - `markers="gpu"` — run only under `pytest -m gpu` (the GPU CI environment); skipped elsewhere via `importorskip("cupy")`. - `markers="s3"` — run against a mock S3 (moto) backend supplied by a test fixture, so the example can use a bare `s3://…` URL with no test-only connection details on show. ##### Placement of `test="true"` blocks Because Markdown Exec does not execute a `test="true"` (or `exec="false"`) block, placing one *before* an `exec="true"` block on the same page can disrupt the build-time execution of that later block. Put `test="true"` blocks **after** all `exec="true"` blocks on the page (or on a page where they are the only Python block). The `test_test_only_blocks_come_last` test enforces this, and the CI docs build runs with `--strict` so any such breakage fails the build rather than passing as a warning. #### Building documentation without executing code blocks Sometimes, you may want the documentation to build quicker. You can disable code block execution by commenting out the [markdown-exec plugin](https://github.com/zarr-developers/zarr-python/blob/884a8c91afcc3efe28b3da952be3b85125c453cb/mkdocs.yml#L132) in the mkdocs configuration file. This will make code blocks and cross references render incorrectly (i.e., expect build warnings), but also reduces build time by ~3x. Be sure to undo the commenting out before opening your pull request. ### Changelog zarr-python uses [towncrier](https://towncrier.readthedocs.io/en/stable/tutorial.html) to manage release notes. Most pull requests should include at least one news fragment describing the changes. To add a release note, you'll need the GitHub issue or pull request number and the type of your change (`feature`, `bugfix`, `doc`, `removal`, `misc`). With that, run `towncrier create` with your development environment, which will prompt you for the issue number, change type, and the news text: ```bash towncrier create ``` Alternatively, you can manually create the files in the `changes` directory using the naming convention `{issue-number}.{change-type}.md`. See the [towncrier](https://towncrier.readthedocs.io/en/stable/tutorial.html) docs for more. ## Project governance This section documents the processes that core developers follow to maintain the project. The current core developers are listed in [`TEAM.md`](https://github.com/zarr-developers/zarr-python/blob/main/TEAM.md). ### Merging pull requests Pull requests submitted by an external contributor should be reviewed and approved by at least one core developer before being merged. Ideally, pull requests submitted by a core developer should be reviewed and approved by at least one other core developer before being merged. Pull requests should not be merged until all CI checks have passed (GitHub Actions, Codecov) against code that has had the latest main merged in. Before merging, the milestone must be set to decide whether a PR will be in the next patch, minor, or major release. The next section explains which types of changes go in each release. ### Self-merging pull requests The default is that a pull request opened by a core developer is reviewed and approved by at least one other core developer before it is merged. We trust core developers to use their judgment, though, and we would rather bias toward action than make routine changes wait on review they do not really need. So a core developer may merge their own pull request whenever they judge the change to be low-risk, provided the standard merge requirements are met — CI is green against code that has had the latest `main` merged in, a changelog fragment has been added, and the milestone is set — and other core developers have had a fair chance to weigh in. As a rule of thumb, leave the pull request open for a few days before self-merging, unless it is genuinely trivial or time-sensitive. If you are confident a change is fine, merge it; if you have real doubts, ask for a review. It is generally advisable to ping another developer in the PR description for awareness about the direction, even if you choose not to request a formal review. Some changes warrant more caution, and a second reviewer is usually worth seeking even when you could self-merge: changes to the public API, anything touching data-format or on-disk compatibility, and performance-sensitive code. These are the most expensive to get wrong and the hardest to reverse. Reverts, by contrast, are cheap — if a self-merged change turns out to be a mistake, reverting it is itself a low-risk change that any core developer can make, and the reworked version can go through normal review. When something recently merged is actively causing harm — a broken `main`, a release blocker, or data corruption — fix it fast and request review after the fact rather than waiting. This policy exists to lower the cost of routine work and to help newer core developers grow comfortable merging changes. It is not a license to merge past an unresolved objection: if another core developer asks to review a change, give them that chance. ### Release procedure To give the release visibility and a single place to track progress, open an issue on GitHub announcing the release using the [release checklist template](https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md). The release checklist includes all steps necessary for the release. ## Compatibility and versioning policies ### Versioning Versions of this library are identified by a triplet of integers with the form `..`, for example `3.0.4`. A release of `zarr-python` is associated with a new version identifier. That new identifier is generated by incrementing exactly one of the components of the previous version identifier by 1. When incrementing the `major` component of the version identifier, the `minor` and `patch` components are reset to 0. When incrementing the minor component, the patch component is reset to 0. Releases are classified by the library changes contained in that release. This classification determines which component of the version identifier is incremented on release. * **major** releases (for example, `2.18.0` -> `3.0.0`) are for changes that will require extensive adaptation efforts from many users and downstream projects. For example, breaking changes to widely-used user-facing APIs should only be applied in a major release. Users and downstream projects should carefully consider the impact of a major release before adopting it. In advance of a major release, developers should communicate the scope of the upcoming changes, and help users prepare for them. * **minor** releases (for example, `3.0.0` -> `3.1.0`) are for changes that do not require significant effort from most users or downstream projects to respond to. API changes are possible in minor releases if the burden on users imposed by those changes is sufficiently small. For example, a recently released API may need fixes or refinements that are breaking, but low impact due to the recency of the feature. Such API changes are permitted in a minor release. Minor releases are safe for most users and downstream projects to adopt. * **patch** releases (for example, `3.1.0` -> `3.1.1`) are for changes that contain no breaking or behavior changes for downstream projects or users. Examples of changes suitable for a patch release are bugfixes and documentation improvements. Users should always feel safe upgrading to the latest patch release. Note that this versioning scheme is not consistent with [Semantic Versioning](https://semver.org/). Contrary to SemVer, the Zarr library may release breaking changes in `minor` releases, or even `patch` releases under exceptional circumstances. But we should strive to avoid doing so. A better model for our versioning scheme is [Intended Effort Versioning](https://jacobtomlinson.dev/effver/), or "EffVer". The guiding principle of EffVer is to categorize releases based on the *expected effort required to upgrade to that release*. Zarr developers should make changes as smooth as possible for users. This means making backwards-compatible changes wherever possible. When a backwards-incompatible change is necessary, users should be notified well in advance, e.g. via informative deprecation warnings. ### Data format compatibility The Zarr library is an implementation of a file format standard defined externally -- see the [Zarr specifications website](https://zarr-specs.readthedocs.io) for the list of Zarr file format specifications. If an existing Zarr format version changes, or a new version of the Zarr format is released, then the Zarr library will generally require changes. It is very likely that a new Zarr format will require extensive breaking changes to the Zarr library, and so support for a new Zarr format in the Zarr library will almost certainly come in a new `major` release. When the Zarr library adds support for a new Zarr format, there may be a period of accelerated changes as developers refine newly added APIs and deprecate old APIs. In such a transitional phase breaking changes may be more frequent than usual. ## Experimental API policy The `zarr.experimental` namespace contains features that are under active development and may change without notice. When contributing to or depending on experimental features, please keep the following in mind: ### For contributors When adding a new feature to `zarr.experimental`: 1. Place the feature under `src/zarr/experimental/` and export it from `src/zarr/experimental/__init__.py`. 2. Document the feature in `docs/user-guide/experimental.md` and note clearly that it is experimental. 3. Add a changelog entry categorized as `feature`. We aim to either **promote** or **remove** experimental features within **6 months** of their addition. To promote a feature to stable: 1. Move it from `zarr.experimental` to the appropriate stable module. 2. Keep a deprecated re-export in `zarr.experimental` for one minor release. 3. Update the documentation to reflect the stable location. ### For users Features in `zarr.experimental` carry no stability guarantees. They may be changed or removed in any release, including patch releases. If you depend on an experimental feature, pin your `zarr-python` version accordingly. ## Benchmarks Zarr uses [pytest-benchmark](https://pytest-benchmark.readthedocs.io/en/latest/) for running performance benchmarks as part of our test suite. The benchmarks are found in `tests/benchmarks`. By default pytest is configured to run these benchmarks as plain tests (i.e., no benchmarking). To run a benchmark with timing measurements, use the `--benchmark-enable` when invoking `pytest`. The benchmarks are run as part of the continuous integration suite through [codspeed](https://app.codspeed.io/zarr-developers/zarr-python). zarr-python-3.3.0/docs/index.md000066400000000000000000000054501523267620000164020ustar00rootroot00000000000000# Zarr-Python **Useful links**: [Source Repository](https://github.com/zarr-developers/zarr-python) | [Issue Tracker](https://github.com/zarr-developers/zarr-python/issues) | [Developer Chat](https://ossci.zulipchat.com/) | [Zarr specifications](https://zarr-specs.readthedocs.io) Zarr is a powerful library for storage of n-dimensional arrays, supporting chunking, compression, and various backends, making it a versatile choice for scientific and large-scale data. Zarr-Python is a Python library for reading and writing Zarr groups and arrays. Highlights include: * Specification support for both Zarr format 2 and 3. * Create and read from N-dimensional arrays using NumPy-like semantics. * Flexible storage enables reading and writing from local, cloud and in-memory stores. * High performance: Enables fast I/O with support for asynchronous I/O and multi-threading. * Extensible: Customizable with user-defined codecs and stores. ## Installation Zarr requires Python 3.12 or higher. You can install it via `pip`: ```bash pip install zarr ``` or `conda`: ```bash conda install -c conda-forge zarr ``` ## Navigating the documentation
- [:material-clock-fast:{ .lg .middle } __Quick start__](quick-start.md) --- New to Zarr? Check out the quick start guide. It contains a brief introduction to Zarr's main concepts and links to additional tutorials. - [:material-book-open:{ .lg .middle } __User guide__](user-guide/index.md) --- A detailed guide for how to use Zarr-Python. - [:material-api:{ .lg .middle } __API Reference__](api/zarr/index.md) --- The reference guide contains a detailed description of the functions, modules, and objects included in Zarr. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts. - [:material-account-group:{ .lg .middle } __Contributor's Guide__](contributing.md) --- Want to contribute to Zarr? We welcome contributions in the form of bug reports, bug fixes, documentation, enhancement proposals and more. The contributing guidelines will guide you through the process of improving Zarr.
## Project Status More information about the Zarr format can be found on the [main website](https://zarr.dev). If you are using Zarr-Python, we would [love to hear about it](https://github.com/zarr-developers/community/issues/19). ### Funding and Support The project is fiscally sponsored by [NumFOCUS](https://numfocus.org/), a US 501(c)(3) public charity, and development has been supported by the [MRC Centre for Genomics and Global Health](https://github.com/cggh/) and the [Chan Zuckerberg Initiative](https://chanzuckerberg.com/). [Donate to Zarr](https://numfocus.org/donate-to-zarr) to support the project! zarr-python-3.3.0/docs/overrides/000077500000000000000000000000001523267620000167475ustar00rootroot00000000000000zarr-python-3.3.0/docs/overrides/main.html000066400000000000000000000003051523267620000205570ustar00rootroot00000000000000 {% extends "base.html" %} {% block outdated %} You're not viewing the latest version. Click here to go to latest. {% endblock %} zarr-python-3.3.0/docs/overrides/stylesheets/000077500000000000000000000000001523267620000213235ustar00rootroot00000000000000zarr-python-3.3.0/docs/overrides/stylesheets/extra.css000066400000000000000000000111711523267620000231610ustar00rootroot00000000000000:root { --gradient-start: #e58077; --gradient-mid-1: #e57a77; --gradient-mid-2: #e46876; --gradient-mid-3: #e34b75; --gradient-mid-4: #e12374; --gradient-mid-5: #e01073; --gradient-end: #bb1085; /* Primary theme colors --md-primary-fg-color: #e34b75; --md-primary-fg-color--light: #e57a77; --md-primary-fg-color--dark: #bb1085; /* Accent colors */ --md-accent-fg-color: #e01073; --md-accent-fg-color--transparent: rgba(224, 16, 115, 0.1); /* Text colors that work well with the palette */ --md-text-color: #333333; --md-text-color--light: #666666; } /* Dark mode color adjustments */ [data-md-color-scheme="slate"] { --md-primary-fg-color: #e57a77; --md-primary-fg-color--light: #e58077; --md-primary-fg-color--dark: #bb1085; --md-accent-fg-color: #e46876; --md-accent-fg-color--transparent: rgba(228, 104, 118, 0.1); } /* Header styling with gradient background */ .md-header { background: linear-gradient( 135deg, var(--gradient-start) 0%, var(--gradient-mid-1) 16.66%, var(--gradient-mid-2) 33.33%, var(--gradient-mid-3) 50%, var(--gradient-mid-4) 66.66%, var(--gradient-mid-5) 83.33%, var(--gradient-end) 100% ); box-shadow: 0 2px 8px rgba(187, 16, 133, 0.15); } /* Ensure header text is readable over gradient */ .md-header__title, .md-header__button, .md-header .md-icon { color: white; } /* Search box styling in the header */ .md-header .md-search__input { background-color: rgba(255, 255, 255, 0.15); border: 1px solid rgba(255, 255, 255, 0.2); } /* Navigation tabs */ .md-tabs { background: linear-gradient( 90deg, var(--gradient-mid-3) 0%, var(--gradient-mid-4) 50%, var(--gradient-mid-5) 100% ); } .md-tabs__link { color: rgba(255, 255, 255, 0.9); } .md-tabs__link--active, .md-tabs__link:hover { color: white; opacity: 1; } /* Sidebar navigation */ .md-nav__link--active { color: var(--md-primary-fg-color); font-weight: 500; } .md-nav__link:hover { color: var(--md-accent-fg-color); } /* Code blocks */ .highlight { border-left: 4px solid var(--md-accent-fg-color); background-color: rgba(228, 104, 118, 0.05); } /* Admonitions */ .md-typeset .admonition.note { border-color: var(--md-primary-fg-color); } .md-typeset .admonition.note > .admonition-title { background-color: rgba(227, 75, 117, 0.1); border-color: var(--md-primary-fg-color); } .md-typeset .admonition.tip { border-color: var(--gradient-mid-1); } .md-typeset .admonition.tip > .admonition-title { background-color: rgba(229, 122, 119, 0.1); border-color: var(--gradient-mid-1); } .md-typeset .admonition.warning { border-color: var(--gradient-end); } .md-typeset .admonition.warning > .admonition-title { background-color: rgba(187, 16, 133, 0.1); border-color: var(--gradient-end); } /* Links */ .md-content a { color: var(--md-accent-fg-color); } .md-content a:hover { color: var(--gradient-end); } /* Table of contents */ .md-nav--secondary .md-nav__link--active { color: var(--md-accent-fg-color); border-left: 2px solid var(--md-accent-fg-color); padding-left: calc(1rem - 2px); } /* Footer */ .md-footer { background-color: var(--gradient-end); } /* Buttons and interactive elements */ .md-button { background: linear-gradient(135deg, var(--md-primary-fg-color), var(--md-accent-fg-color)); border: none; color: white; transition: all 0.3s ease; } .md-button:hover { transform: translateY(-2px); box-shadow: 0 4px 12px rgba(187, 16, 133, 0.3); } /* Scrollbar styling */ ::-webkit-scrollbar { width: 8px; } ::-webkit-scrollbar-track { background: rgba(187, 16, 133, 0.1); } ::-webkit-scrollbar-thumb { background: linear-gradient( 180deg, var(--md-primary-fg-color), var(--md-accent-fg-color) ); border-radius: 4px; } ::-webkit-scrollbar-thumb:hover { background: linear-gradient( 180deg, var(--md-accent-fg-color), var(--gradient-end) ); } /* Search results highlighting */ .md-search-result__title { color: var(--md-primary-fg-color); } .md-search-result__teaser mark { background-color: rgba(224, 16, 115, 0.2); color: var(--gradient-end); } .md-header__button.md-logo img, .md-header__button.md-logo svg { height: 42px !important; /* Increase from default ~24px */ width: auto !important; max-height: none !important; padding: 0 0 0 16px !important; /* Keep left padding, remove others */ margin: 0 !important; /* Remove any margin */ } /* Also remove padding from the logo button container except left */ .md-header__button.md-logo { padding: 0 0 0 8px !important; /* Keep some left padding on container */ margin: 0 !important; min-width: auto !important; } zarr-python-3.3.0/docs/quick-start.md000066400000000000000000000131641523267620000175430ustar00rootroot00000000000000# Quick start This page will help you get up and running with the Zarr library in Python to efficiently manage and analyze multi-dimensional arrays. Zarr must be installed first -- see the [installation guide](user-guide/installation.md) if you have not installed it yet. ## Creating an Array To get started, you can create a simple Zarr array: ```python exec="true" session="quickstart" import shutil shutil.rmtree('data', ignore_errors=True) import numpy as np from pprint import pprint import io import warnings warnings.filterwarnings( "ignore", message="Numcodecs codecs are not in the Zarr version 3 specification*", category=UserWarning ) np.random.seed(0) ``` ```python exec="true" session="quickstart" source="above" result="ansi" import zarr import numpy as np # Create a 2D Zarr array z = zarr.create_array( store="data/example-1.zarr", shape=(100, 100), chunks=(10, 10), dtype="f4" ) # Assign data to the array z[:, :] = np.random.random((100, 100)) print(z.info) ``` Here, we created a 2D array of shape `(100, 100)`, chunked into blocks of `(10, 10)`, and filled it with random floating-point data. This array was written to a `LocalStore` in the `data/example-1.zarr` directory. ### Compression and Filters Zarr supports data compression and filters. For example, to use Blosc compression: ```python exec="true" session="quickstart" source="above" result="ansi" # Create a 2D Zarr array with Blosc compression z = zarr.create_array( store="data/example-2.zarr", shape=(100, 100), chunks=(10, 10), dtype="f4", compressors=zarr.codecs.BloscCodec( cname="zstd", clevel=3, shuffle="shuffle" ) ) # Assign data to the array z[:, :] = np.random.random((100, 100)) print(z.info) ``` This compresses the data using the Blosc codec with shuffle enabled for better compression. ## Hierarchical Groups Zarr allows you to create hierarchical groups, similar to directories: ```python exec="true" session="quickstart" source="above" result="ansi" # Create nested groups and add arrays root = zarr.group("data/example-3.zarr") foo = root.create_group(name="foo") bar = root.create_array( name="bar", shape=(100, 10), chunks=(10, 10), dtype="f4" ) spam = foo.create_array(name="spam", shape=(10,), dtype="i4") # Assign values bar[:, :] = np.random.random((100, 10)) spam[:] = np.arange(10) # print the hierarchy print(root.tree()) ``` This creates a group hierarchy with a group (`foo`) and two arrays (`bar` and `spam`). ### Batch Hierarchy Creation Zarr provides tools for creating a collection of arrays and groups with a single function call. Suppose we want to copy existing groups and arrays into a new storage backend: ```python exec="true" session="quickstart" source="above" result="code" # Create nested groups and add arrays root = zarr.group("data/example-4.zarr", attributes={'name': 'root'}) foo = root.create_group(name="foo") bar = root.create_array( name="bar", shape=(100, 10), chunks=(10, 10), dtype="f4" ) nodes = {'': root.metadata} | {k: v.metadata for k,v in root.members()} # Report nodes output = io.StringIO() pprint(nodes, stream=output, width=60, depth=3) result = output.getvalue() print(result) # Create new hierarchy from nodes new_nodes = dict(zarr.create_hierarchy(store=zarr.storage.MemoryStore(), nodes=nodes)) new_root = new_nodes[''] assert new_root.attrs == root.attrs ``` Note that [`zarr.create_hierarchy`][] will only initialize arrays and groups -- copying array data must be done in a separate step. ## Persistent Storage Zarr supports persistent storage to disk or cloud-compatible backends. While examples above utilized a [`zarr.storage.LocalStore`][], a number of other storage options are available. A single-file store can also be created using the [`zarr.storage.ZipStore`][]: ```python exec="true" session="quickstart" source="above" # Store the array in a ZIP file store = zarr.storage.ZipStore("data/example-5.zip", mode="w") z = zarr.create_array( store=store, shape=(100, 100), chunks=(10, 10), dtype="f4" ) # write to the array z[:, :] = np.random.random((100, 100)) # the ZipStore must be explicitly closed store.close() ``` To open an existing array from a ZIP file: ```python exec="true" session="quickstart" source="above" result="ansi" # Open the ZipStore in read-only mode store = zarr.storage.ZipStore("data/example-5.zip", read_only=True) z = zarr.open_array(store, mode='r') # read the data as a NumPy Array print(z[:]) ``` Zarr also integrates seamlessly with cloud object storage such as Amazon S3 and Google Cloud Storage using external libraries like [s3fs](https://s3fs.readthedocs.io/en/latest/) or [gcsfs](https://gcsfs.readthedocs.io/en/latest/). Remote storage support requires the `remote` optional dependencies (`pip install "zarr[remote]"`) as well as a filesystem library for your storage service, such as `s3fs` for S3: ```python test="true" session="s3demo" markers="s3" source="above" import zarr import numpy as np z = zarr.create_array( "s3://example-bucket/foo", shape=(100, 100), chunks=(10, 10), dtype="f4" ) z[:, :] = np.random.random((100, 100)) ``` See the [Remote Store](user-guide/storage.md#remote-store) section of the storage guide for more detail, including how to configure the underlying filesystem with `storage_options`. ## Next steps This page only scratches the surface. Continue with the [User Guide](user-guide/index.md), in particular: - **[Arrays](user-guide/arrays.md)** - creating, reading, and writing arrays in depth - **[Groups](user-guide/groups.md)** - organizing arrays into hierarchies - **[Storage](user-guide/storage.md)** - the full range of local, remote, and in-memory storage options zarr-python-3.3.0/docs/release-notes.md000066400000000000000000002277511523267620000200530ustar00rootroot00000000000000# Release notes ## 3.3.0 (2026-07-30) ### Features - Optimizes reading multiple chunks from a shard. Serial calls to `Store.get()` in the sharding codec have been replaced with a single call to `Store.get_ranges()`, which coalesces nearby byte ranges and fetches them concurrently. ([#3004](https://github.com/zarr-developers/zarr-python/pull/3004)) - Added a `subchunk_write_order` option to `ShardingCodec` to control the physical order of subchunks within a shard. Supported values are `morton`, `unordered`, `lexicographic`, and `colexicographic`. `unordered` makes no guarantee about subchunk layout. This setting affects only on-disk layout, not the data read back, and is not persisted in array metadata: it applies per codec instance and is not recovered when reopening a sharded array. ([#3826](https://github.com/zarr-developers/zarr-python/pull/3826)) - Added `SyncByteGetter` and `SyncByteSetter` runtime-checkable protocols and a `get_ranges_sync` method on the `Store` ABC. These let custom byte getters/setters opt into the synchronous codec pipeline's fast path for in-memory IO, which the sharding codec uses for its inner chunks. ([#3885](https://github.com/zarr-developers/zarr-python/pull/3885)) - Added `FusedCodecPipeline`, an opt-in codec pipeline that runs codec compute synchronously and in bulk (avoiding the per-chunk async scheduling overhead of the default `BatchedCodecPipeline`), giving large speedups for sharded arrays. The default `BatchedCodecPipeline` is unchanged for standard configurations, so existing code keeps working unless you opt in; enable the new pipeline with `zarr.config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"})`. ([#3885](https://github.com/zarr-developers/zarr-python/pull/3885)) - Add `zarr.abc.store.Store.get_ranges` for concurrent, coalesced multi-range reads from a single key. The method is defined on the `Store` ABC with a default implementation built on `Store.get`, so every store inherits a working version; stores with native multi-range backends (e.g. `FsspecStore`) can override for efficiency. Coalescing knobs (`max_concurrency`, `max_gap_bytes`, `max_coalesced_bytes`) are passed as keyword arguments to `get_ranges`. Failures from underlying fetches surface as a `BaseExceptionGroup` (PEP 654); callers should use `except*` to filter for specific exception types such as `FileNotFoundError`. ([#3925](https://github.com/zarr-developers/zarr-python/pull/3925)) - Two new fields on `ArrayConfig` control how the sharding codec coalesces partial-shard reads: `sharding_coalesce_max_gap_bytes` (default 1 MiB) and `sharding_coalesce_max_bytes` (default 16 MiB). When reading multiple chunks from the same shard, nearby byte ranges are merged into a single request to the store if separated by no more than `sharding_coalesce_max_gap_bytes` and the merged read stays within `sharding_coalesce_max_bytes`. Defaults are seeded from the matching `array.sharding_coalesce_max_gap_bytes` / `array.sharding_coalesce_max_bytes` keys in [`zarr.config`][] at array-creation time, and can be overridden per array by passing `config={...}` to [`zarr.create_array`][]. ([#3987](https://github.com/zarr-developers/zarr-python/pull/3987)) - Added `Group.get_array`, `Group.get_group`, `AsyncGroup.get_array`, and `AsyncGroup.get_group`: type-safe accessors that return the child array or group at a given path, raising `ArrayNotFoundError` / `GroupNotFoundError` if no node exists there, and `ContainsGroupError` / `ContainsArrayError` if the node is not of the requested kind. Unlike `Group.__getitem__`, which returns `Array | Group`, these methods have precise return types. Nested paths like `"subgroup/subarray"` are supported. ([#4128](https://github.com/zarr-developers/zarr-python/pull/4128)) - `ZipStore` now accepts an open binary file-like object in place of a path, enabling zip archives on remote storage (e.g. a file opened with `fsspec` or an `obstore.ReadableFile`). Operations that require a filesystem location (`clear`, `move`) raise `NotImplementedError` for file-object-backed stores. ([#4187](https://github.com/zarr-developers/zarr-python/pull/4187)) ### Bugfixes - Stop emitting an `UnstableSpecificationWarning` when serializing the `struct` data type to Zarr V3 metadata. The `struct` data type now has a stable Zarr V3 specification. The legacy `structured` alias and the unspecified `null_terminated_bytes`, `raw_bytes`, and `variable_length_bytes` data types continue to warn. ([#4100](https://github.com/zarr-developers/zarr-python/pull/4100)) - Fix equality comparison of `ArrayV2Metadata` and `ArrayV3Metadata` objects with a `NaN` fill value. Such objects are now compared by their JSON-serialized form, so two otherwise-identical metadata objects with a `NaN` (or infinite) fill value compare equal. ([#2929](https://github.com/zarr-developers/zarr-python/issues/2929)) - Fixed `BytesCodec.from_dict` so that `BytesCodec` instances roundtrip to / from their dict representation. `BytesCodec.from_dict` now interprets a missing `endian` configuration as `endian=None` (matching what `BytesCodec.to_dict` emits), instead of falling back to the system's native byte order. ([#3417](https://github.com/zarr-developers/zarr-python/pull/3417)) - Fixed `save_array`, `Group.__setitem__`, and `load` for 0-dimensional arrays. ([#3469](https://github.com/zarr-developers/zarr-python/issues/3469)) - Fixed inner-codec spec evolution for sharded arrays. The sharding codec now threads the array spec through its inner codec chain when evolving codecs, so a codec that changes the dtype upstream of `BytesCodec` no longer leaves the inner chain evolved against the wrong spec (which previously failed at decode time). This runs on the default `BatchedCodecPipeline` as well. Standard inner chains (`[BytesCodec]`, `[BytesCodec, ZstdCodec]`, transpose + bytes) are byte-identical to before. Restores the behavior of #2179. ([#3885](https://github.com/zarr-developers/zarr-python/pull/3885)) - Make chunk normalization properly handle `-1` as a compact representation of the length of an entire axis. Reject several previously-accepted but ill-defined chunk specifications: `chunks=True` (previously silently produced size-1 chunks), chunk tuples shorter than the array's number of dimensions (previously padded to the array's shape), and `None` as a per-dimension chunk size. These all now raise informative errors. Also fix chunk handling for 0-length array dimensions, and add explicit rejection of 0-length chunks. ([#3899](https://github.com/zarr-developers/zarr-python/pull/3899)) - Handle missing consolidated metadata in leaf Group nodes. ([#3954](https://github.com/zarr-developers/zarr-python/issues/3954)) - Corrected the JSON type definitions for the `numpy.datetime64` and `numpy.timedelta64` data types in Zarr V3 metadata: the `configuration` object (holding `unit` and `scale_factor`) is now required, matching the published specifications for these data types. Also updated the specification links in the docstrings to point to the zarr-extensions repository. ([#3955](https://github.com/zarr-developers/zarr-python/pull/3955)) - Fixed writing to 0-dimensional arrays that use the sharding codec. Previously assigning to a 0-dimensional sharded array raised an error. ([#3966](https://github.com/zarr-developers/zarr-python/pull/3966)) - Fix flaky stateful test bookkeeping when `delete_dir` matches string prefixes instead of true directory descendants. Previously a path such as `6/faNT…` could be incorrectly removed when deleting `6/f`. (See [issue #3977](https://github.com/zarr-developers/zarr-python/issues/3977).) ([#3977](https://github.com/zarr-developers/zarr-python/issues/3977)) - `FsspecStore.close()` no longer closes the underlying fsspec filesystem or its network session. fsspec caches and shares filesystem instances across callers, so the store cannot know whether it is the only user, and closing a shared session would break other stores; the filesystem's lifecycle belongs to whoever created it. ([#4165](https://github.com/zarr-developers/zarr-python/pull/4165)) - Fixed an invalid `zarr.create_array` example in the quick-start documentation (it passed an unsupported `mode` argument) and made the cloud-storage example execute against a mock S3 backend in CI. Added a test ensuring every Python code block in the documentation is either executed or explicitly opted out with a documented reason, so an invalid example can no longer go untested. ([#4016](https://github.com/zarr-developers/zarr-python/issues/4016)) - Fixed `ObjectStore.list_dir` for object-store listings that include a directory-marker object matching the requested non-root prefix. ([#4032](https://github.com/zarr-developers/zarr-python/issues/4032)) - Prevents mutation of the attributes dict provided by the user by copying them instead of keeping the reference ([#4059](https://github.com/zarr-developers/zarr-python/issues/4059)) - Fixed several storage and codec bugs: - Reading a value with a `SuffixByteRequest` larger than the value now correctly returns the whole value (matching HTTP `bytes=-N` suffix-range semantics), instead of silently returning incorrect data for `MemoryStore`. - `LoggingStore.get_partial_values` and `FsspecStore.get_partial_values` no longer return empty results when `key_ranges` is passed as a one-shot iterable (e.g. a generator). - `Store.getsize_prefix` no longer over-counts sibling keys that merely share a string prefix (e.g. `getsize_prefix("foo")` no longer includes keys under `foobar/`). - `ZipStore.close()` no longer raises `AttributeError` when the store was created but never opened (including when used as a context manager without any I/O). - `codecs_from_list` now raises a descriptive `TypeError` when a `BytesBytesCodec` immediately follows an `ArrayArrayCodec`, instead of a misleading "Required ArrayBytesCodec was not found" `ValueError`. ([#4074](https://github.com/zarr-developers/zarr-python/pull/4074)) - Fixed writing Fortran-ordered (F-contiguous) arrays through the variable-length string and bytes codecs and through numcodecs array-array filters such as `Delta`, `FixedScaleOffset` and `PackBits`. Chunks are now passed to numcodecs as C-contiguous arrays, so elements are no longer stored in transposed order. ([#4116](https://github.com/zarr-developers/zarr-python/pull/4116)) - Fix silent byte-order corruption for structured dtypes with the `bytes` codec: multi-byte fields are now byte-swapped to the codec's configured `endian` on write and decoded honoring it on read, so non-native-endian structured data (e.g. big-endian fields, as produced by virtual references to external data) round-trips correctly. ([#4141](https://github.com/zarr-developers/zarr-python/issues/4141)) - Fix `zarr.api.asynchronous.open_like` so it can create a new array by default when the target path does not already exist. It now defaults to `mode="a"`; when using a read-only store to open an existing array, pass `mode="r"` explicitly. ([#3352](https://github.com/zarr-developers/zarr-python/pull/3352)) - `MemoryStore` now copies buffers as they are written, so it never retains the caller's memory. Previously an uncompressed write handed the store a zero-copy view of the user's array, and mutating that array afterwards would silently rewrite chunks already committed to the store. Only `MemoryStore` is affected: stores that serialize on write, such as `LocalStore` and `ZipStore`, never aliased the caller's memory. Uncompressed writes to a `MemoryStore` are correspondingly slower, since the copy that makes the stored data independent is now actually performed; compressed writes are unchanged. Buffers supplied through the `store_dict` argument remain the caller's responsibility and are stored as-is. ([#4157](https://github.com/zarr-developers/zarr-python/pull/4157)) - Fixed the opt-in `FusedCodecPipeline` for sharded arrays whose inner or index codec chain contains a codec implementing only the async codec interface (no `SupportsSyncCodec`). Such arrays previously raised `TypeError: All codecs must implement SupportsSyncCodec` on both read and write; the pipeline now declines its synchronous fast path for them and falls back to the async path, matching the behavior of the default `BatchedCodecPipeline`. Fully sync-capable codec chains keep the fast path unchanged. ([#4179](https://github.com/zarr-developers/zarr-python/pull/4179)) - Fixed `TypeError: unhashable type: 'writeable void-scalar'` when writing to sharded arrays whose fill value is a `np.void` scalar, e.g. arrays with a structured dtype. `ArraySpec` equality and hashing now compare the fill value by its byte representation rather than numeric equality. As a result, two specs with a `NaN` (or `NaT`) fill value now compare equal, while fill values of `-0.0` and `0.0` now compare unequal. This also restores the sharding codec's per-chunk spec cache, which had been disabled because of this bug. ([#4183](https://github.com/zarr-developers/zarr-python/pull/4183)) - `FusedCodecPipeline` no longer runs chunk IO and codec compute on the thread driving zarr's internal event loop. Previously each read/write executed its synchronous fast path inline on that loop thread, and because every sync-API call from every user thread is serviced by the same loop, concurrent operations serialized behind each other's codec work — reported as the fused pipeline being slower than `BatchedCodecPipeline` for zstd-compressed data under multi-threaded (e.g. dask) access. The synchronous batch now runs on a worker thread (one hop per batch, not per chunk), keeping the loop free. Multi-threaded single-chunk reads of compressed data now scale with reader threads; single-threaded performance is unchanged. ([#4194](https://github.com/zarr-developers/zarr-python/pull/4194)) - The end-to-end benchmarks no longer invoke `sudo` to drop the OS page cache during a regular `pytest` run. Cache clearing is now opt-in via the `ZARR_BENCHMARK_CLEAR_CACHE` environment variable, which the benchmark CI jobs set. ([#4199](https://github.com/zarr-developers/zarr-python/pull/4199)) - Fixed the opt-in `FusedCodecPipeline` for serializers that advertise the partial-decode/encode mixins with only the documented async partial methods: the partial dispatch previously asserted on the private `_decode_partial_sync`/`_encode_partial_sync` hooks (an `AssertionError`, or an `AttributeError` mid-IO under `python -O`); such codecs now take the full-chunk sync path. ([#4201](https://github.com/zarr-developers/zarr-python/pull/4201)) - Fixed `FusedCodecPipeline` (the opt-in synchronous pipeline) silently skipping array-array/bytes-bytes codecs placed outside a sharding serializer on its partial-decode/partial-encode fast paths. With an outer compressor (e.g. `compressors=[GzipCodec()]` around a `ShardingCodec` serializer), the fused pipeline wrote non-conforming stored bytes that `BatchedCodecPipeline` (and any other conforming reader) could not read, and could fail to read data that `BatchedCodecPipeline` had written. With an outer array-array codec (e.g. `TransposeCodec`), it silently returned wrong data in both directions with no error. Only the opt-in `FusedCodecPipeline` was affected; the default `BatchedCodecPipeline` was never impacted. ([#4202](https://github.com/zarr-developers/zarr-python/pull/4202)) - Fixed silent data corruption in the experimental `FusedCodecPipeline`: reordering or duplicating fancy-index reads (e.g. `arr[perm, :]`, `arr.oindex[[0, 0, 1], :]`) on uncompressed, crc-free sharded arrays could return the shard in natural order because the vectorized whole-shard decode accepted any selection whose output shape matched the shard shape. The bulk decode now fires only for identity full-shard reads, declines structured dtypes (whose byte-order handling it lacks), and requires shard-index offsets to exactly tile the data section, so corrupt indexes with overlapping or out-of-range offsets can no longer be served as array data. ([#4203](https://github.com/zarr-developers/zarr-python/pull/4203)) - `ManagedMemoryStore.get_sync`/`set_sync`/`delete_sync` now apply the store's `path` prefix, matching the async `get`/`set`/`delete` methods. Previously the sync methods were inherited unchanged from `MemoryStore` and used the raw key, so code that takes the sync fast path (e.g. `FusedCodecPipeline`) would read and write chunks outside the store's `path` prefix, silently returning fill values when the data was re-read through a fresh handle. `GpuMemoryStore.set_sync` now converts its value to a `gpu.Buffer`, matching `set`, so writes through the sync API keep the store's all-values-are-GPU invariant. Also fixed `ManagedMemoryStore.get_partial_values` applying its `path` prefix twice whenever `path` is non-empty, which made it always return `None` for every requested key. The shared store test suite (`zarr.testing.store.StoreTests`) gained sync/async parity checks — comparing sync and async observations of the same key on the same store instance, including with a `byte_range` — so every store subclass now exercises this invariant. The suite's former `test_get_bytes`/`test_get_json` methods (and their `_sync` variants) were folded into these parity tests and no longer exist as separate methods. ([#4204](https://github.com/zarr-developers/zarr-python/pull/4204)) - Fixed several small correctness issues from the codec-pipeline performance work: construction-time codec warnings (e.g. sharding's "disables partial reads" warning) no longer fire twice per array open — including for `FusedCodecPipeline`, which previously re-warned via its own codec-chain reconstruction and, on the async fallback path, on every decode/encode call; `concurrent_iter` now schedules its tasks eagerly, matching its documented contract; an invalid `codec_pipeline.max_workers` config/environment value now warns and falls back to the default instead of raising mid-read; and `FusedCodecPipeline`'s async fallback helpers now cancel already-spawned fetch/decode/write tasks instead of abandoning them in the background when one fails. ([#4205](https://github.com/zarr-developers/zarr-python/pull/4205)) - Fixed `FusedCodecPipeline`'s gating of its synchronous fast paths: stores exposing only part of the sync surface (e.g. `set_sync` without `get_sync`) now fall back cleanly to the async path instead of failing mid-write, and `WrapperStore` now forwards `get_sync`/`set_sync`/`delete_sync` to the wrapped store so wrapped sync-capable stores keep the fast path. The capability decision uses a private, interim convention (`zarr.abc.store._store_supports_sync_io`) rather than new public API, pending a formal sync/async store architecture. Also fixed `LatencyStore`: synchronous reads and writes now pay the configured latency, `get_ranges`/`get_partial_values` no longer bypass latency injection, and derived stores (e.g. from `with_read_only`) keep a stochastic `(loc, scale)` latency configuration instead of freezing a single sample. ([#4206](https://github.com/zarr-developers/zarr-python/pull/4206)) - `DefaultChunkKeyEncoding.decode_chunk_key` now validates that a chunk key starts with the configured `c` prefix and raises `ValueError` for malformed keys, instead of silently decoding them incorrectly. ([#4219](https://github.com/zarr-developers/zarr-python/pull/4219)) ### Improved Documentation - Document the changes to `zarr.errors` in the 3.0 migration guide, including the removal of v2 exception classes and the introduction of `NodeNotFoundError`. ([#3009](https://github.com/zarr-developers/zarr-python/issues/3009)) - Clarify the difference between `zarr.load` and `zarr.open` in their docstrings. `load` eagerly reads data into an in-memory array, while `open` returns a lazy `Array` or `Group` backed by the store, with `See Also` cross-references linking the two. ([#3984](https://github.com/zarr-developers/zarr-python/pull/3984)) - Updated the custom dtype example in `examples/custom_dtype/custom_dtype.py` to use only the public API, eliminating all non-public imports, illustrating what users should do. To better support this, the following types and functions were made available from public modules: | Type/Function | Non-public module | Public module | | ------------------------- | ------------------------ | ------------- | | `DataTypeValidationError` | `zarr.core.dtype.common` | `zarr.errors` | | `JSON` | `zarr.core.common` | `zarr.types` | | `ZarrFormat` | `zarr.core.common` | `zarr.types` | | `DTypeConfig_V2` | `zarr.core.dtype.common` | `zarr.types` | | `DTypeJSON` | `zarr.core.dtype.common` | `zarr.types` | | `DTypeSpec_V2` | `zarr.core.dtype.common` | `zarr.dtype` | | `check_dtype_spec_v2` | `zarr.core.dtype.common` | `zarr.dtype` | `DataTypeValidationError` was *moved* to `zarr.errors`. Importing it from `zarr.core.dtype.common` (its original location), `zarr.core.dtype`, or `zarr.dtype` still works but now raises a `ZarrDeprecationWarning`. The remaining types and functions are simply re-exported from the listed public module. ([#4052](https://github.com/zarr-developers/zarr-python/pull/4052)) - Document a self-merge policy in the contributor guide, describing when a core developer may merge their own pull request without a second reviewer and which changes warrant more caution. ([#4053](https://github.com/zarr-developers/zarr-python/pull/4053)) - Fixed many documentation errors found in a full review of the user guide, including prose contradicted by rendered example output on the performance page, invisible code blocks, an incorrect S3 example, stale "not yet implemented" claims in the v3 migration guide, and undocumented optional dependency groups. Also improved navigation order, cross-linking between pages, and coverage of group member enumeration, bulk attribute updates, and the `use_consolidated` keyword. ([#4132](https://github.com/zarr-developers/zarr-python/pull/4132)) - Fixed the documented default of ``max_age_seconds`` in the ``CacheStore`` docstring: the default is ``"infinity"`` (no expiration), not ``None``, which is rejected. Also noted that ``cache_store`` must support deletes. ([#4133](https://github.com/zarr-developers/zarr-python/pull/4133)) - Added a blog section to the documentation, with a post covering two performance highlights of the 3.3.0 release: the opt-in `FusedCodecPipeline` and byte-range coalescing for partial reads of sharded arrays. Added two runnable examples that accompany the post: `examples/codec_pipeline_performance` compares the `BatchedCodecPipeline` and `FusedCodecPipeline` on a sharded array across two stores and two codec regimes, showing when the fused pipeline's thread pool helps and when it does not, and `examples/sharding_coalescing` demonstrates how read coalescing reduces the number of store requests when reading subregions of a sharded array. Also removed the hardware-specific speedup figures from the `FusedCodecPipeline` release note, since they depend on the array layout, codec, and machine. ([#4191](https://github.com/zarr-developers/zarr-python/pull/4191)) ### Deprecations and Removals - The ``BloscShuffle`` and ``BloscCname`` enums (``zarr.codecs.BloscShuffle``, ``zarr.codecs.BloscCname``) are now deprecated. Pass the equivalent literal string (e.g. ``"zstd"``, ``"bitshuffle"``) when constructing a ``BloscCodec``. The enum classes remain importable but emit ``DeprecationWarning`` on member access, and will be removed in a future release. They are no longer ``Enum`` subclasses: constructor calls (e.g. ``BloscCname("zstd")``), iteration, and ``.value`` access no longer work. ``BloscCodec.cname`` and ``BloscCodec.shuffle`` are now plain strings rather than enum members. Additional renames in ``zarr.codecs.blosc`` from the same change: the type aliases ``Shuffle`` and ``CName`` are now ``BloscShuffleLiteral`` and ``BloscCnameLiteral``, the constant ``SHUFFLE`` is now ``BLOSC_SHUFFLE`` (with a new ``BLOSC_CNAME`` alongside it), and ``BloscShuffle.from_int`` now returns a literal string rather than an enum member. ([#3963](https://github.com/zarr-developers/zarr-python/pull/3963)) - The ``Endian`` (``zarr.codecs.bytes.Endian``) and ``ShardingCodecIndexLocation`` (``zarr.codecs.ShardingCodecIndexLocation``) enums are now deprecated. Pass the equivalent literal string instead (e.g. ``"little"`` / ``"big"``, ``"start"`` / ``"end"``). The enum classes remain importable but emit ``DeprecationWarning`` on member access, and will be removed in a future release. ``BytesCodec.endian`` and ``ShardingCodec.index_location`` are now plain strings rather than enum members. Two follow-on changes from this deprecation: - ``NDBuffer.byteorder`` now returns a literal string (``"little"`` or ``"big"``) rather than an ``Endian`` member. Subclasses overriding this property should update their return type. - The module-level binding ``zarr.codecs.bytes.default_system_endian`` was removed. ``BytesCodec()`` continues to default to ``sys.byteorder``; external callers that imported ``default_system_endian`` should use ``sys.byteorder`` directly. Additionally, the module-level function ``zarr.codecs.sharding.parse_index_location`` was made private as part of this change. ([#3968](https://github.com/zarr-developers/zarr-python/pull/3968)) - Removed the NumPy 1.x implementation of the `VariableLengthUTF8` data type because NumPy 1.x is no longer supported under [SPEC0](https://scientific-python.org/specs/spec-0000/). ([#3973](https://github.com/zarr-developers/zarr-python/pull/3973)) ### Misc - [#4139](https://github.com/zarr-developers/zarr-python/pull/4139), [#4140](https://github.com/zarr-developers/zarr-python/pull/4140), [#3908](https://github.com/zarr-developers/zarr-python/pull/3908), [#3972](https://github.com/zarr-developers/zarr-python/pull/3972), [#3975](https://github.com/zarr-developers/zarr-python/pull/3975), [#3979](https://github.com/zarr-developers/zarr-python/pull/3979), [#3990](https://github.com/zarr-developers/zarr-python/pull/3990), [#3998](https://github.com/zarr-developers/zarr-python/pull/3998), [#4000](https://github.com/zarr-developers/zarr-python/pull/4000), [#4001](https://github.com/zarr-developers/zarr-python/pull/4001), [#4012](https://github.com/zarr-developers/zarr-python/pull/4012), [#4046](https://github.com/zarr-developers/zarr-python/pull/4046), [#4054](https://github.com/zarr-developers/zarr-python/pull/4054), [#4073](https://github.com/zarr-developers/zarr-python/issues/4073), [#4086](https://github.com/zarr-developers/zarr-python/issues/4086), [#4138](https://github.com/zarr-developers/zarr-python/pull/4138) - [#4172](https://github.com/zarr-developers/zarr-python/pull/4172) ## 3.2.1 (2026-05-05) ### Bugfixes - Fixed a `CastValue` validation bug where the "can we use an out-of-range mode" check inspected the source dtype instead of the target dtype. This meant arrays with a float source dtype and an integer target dtype incorrectly raised a `ValueError` when configured with a `wrap` out-of-range mode. ([#3938](https://github.com/zarr-developers/zarr-python/pull/3938)) - Fixed a bug where the codec pipeline evolved each codec against the original array spec instead of the spec produced by upstream array-to-array codecs. This caused failures whenever an upstream codec changed the dtype between codec boundaries — e.g. arrays using `CastValue` to convert a single-byte source dtype (`int8`) to a multi-byte target dtype (`int16`) raised a `ValueError` from `BytesCodec` about a missing `endian` configuration. ([#3941](https://github.com/zarr-developers/zarr-python/pull/3941)) - Fixed breakage in existing fsspec-dependent workflows caused by associating the "memory" URL scheme with instances of `ManagedMemoryStore` instead of fsspec's memory-backed store. After this change, store URLs with a "memory" scheme are handled differently when `fsspec` is installed: with `fsspec`, a `FsspecStore` backed by a `MemoryFileSystem` is used. Without `fsspec`, a `ManagedMemoryStore` is used. ([#3944](https://github.com/zarr-developers/zarr-python/pull/3944)) ## 3.2.0 (2026-04-30) ### Features - Adds a new in-memory storage backend called `ManagedMemoryStore`. Instances of `ManagedMemoryStore` function similarly to `MemoryStore`, but instances of `ManagedMemoryStore` can be constructed from a URL like `memory://store`. ([#3679](https://github.com/zarr-developers/zarr-python/pull/3679)) - Added `array.read_missing_chunks` configuration option. When set to `False`, reading missing chunks raises a `ChunkNotFoundError` instead of filling them with the array's fill value. ([#3748](https://github.com/zarr-developers/zarr-python/pull/3748)) - Added `Struct` class (subclass of `Structured`) implementing the zarr-extensions `struct` dtype spec. Uses object-style field format and dict fill values. Legacy `Structured` remains available for backward compatibility. ([#3781](https://github.com/zarr-developers/zarr-python/pull/3781)) - Add support for rectilinear (variable-sized) chunk grids. This feature is experimental and must be explicitly enabled via `zarr.config.set({'array.rectilinear_chunks': True})`. Rectilinear chunks can be used through: - **Creating arrays**: Pass nested sequences (e.g., `[[10, 20, 30], [50, 50]]`) to `chunks` in `zarr.create_array`, `zarr.from_array`, `zarr.zeros`, `zarr.ones`, `zarr.full`, `zarr.open`, and related functions, or to `chunk_shape` in `zarr.create`. - **Opening existing arrays**: Arrays stored with the `rectilinear` chunk grid are read transparently via `zarr.open` and `zarr.open_array`. - **Rectilinear sharding**: Shard boundaries can be rectilinear while inner chunks remain regular. **Breaking change**: The `validate` method on `BaseCodec` and `CodecPipeline` now receives a `ChunkGridMetadata` instance instead of a `ChunkGrid` instance for the `chunk_grid` parameter. Third-party codecs that override `validate` and inspect the chunk grid will need to update their type annotations. No known downstream packages were using this parameter. ([#3802](https://github.com/zarr-developers/zarr-python/pull/3802)) - Add `cast_value` and `scale_offset` codecs. ([#3874](https://github.com/zarr-developers/zarr-python/pull/3874)) ### Bugfixes - Fix `SyncError` raised when assigning a `zarr.Array` as the value in a `__setitem__` call (e.g. `dst[:] = src` where `src` is a zarr array). The source array is now converted to a NumPy array before entering the async codec pipeline. ([#3611](https://github.com/zarr-developers/zarr-python/issues/3611)) - Fix an issue that prevents the correct parsing of special NumPy `uint32` dtypes resulting e.g. from bit wise operations on `uint32` arrays on Windows. ([#3797](https://github.com/zarr-developers/zarr-python/pull/3797)) - Fix `ZipStore.list()`, `list_dir()`, and `exists()` to auto-open the zip file when called before `open()`, consistent with the existing behavior of `get()` and `set()`. ([#3846](https://github.com/zarr-developers/zarr-python/issues/3846)) - Fix handling of `NaT` default fill values for `datetime64` and `timedelta64` data types. Equality checks now use `numpy.isnat` so that the default fill value compares correctly against `NaT`. ([#3863](https://github.com/zarr-developers/zarr-python/pull/3863)) - Use the unit associated with the `Datetime64` data type when creating the default `Nat` scalar value. ([#3920](https://github.com/zarr-developers/zarr-python/pull/3920)) ### Improved Documentation - Document removal of `zarr.storage.init_group` in v3 migration guide, with replacement using `zarr.open_group`/`zarr.create_group`. ([#2720](https://github.com/zarr-developers/zarr-python/issues/2720)) - Document the `threading.max_workers` configuration option in the performance guide. ([#3492](https://github.com/zarr-developers/zarr-python/issues/3492)) - Corrects the type annotation reported for the `batch_info` parameter in the `CodecPipeline.write` method docstring. ([#3836](https://github.com/zarr-developers/zarr-python/pull/3836)) - Remove result="ansi" from code blocks in the user guide that were causing empty output cells in the rendered documentation. ([#3845](https://github.com/zarr-developers/zarr-python/pull/3845)) ### Deprecations and Removals - Remove deprecated `zarr.convenience` and `zarr.creation` modules. ([#3900](https://github.com/zarr-developers/zarr-python/pull/3900)) - Remove the deprecated `zarr_version` parameter from several functions and methods. That parameter is replaced with `zarr_format`. ([#3901](https://github.com/zarr-developers/zarr-python/pull/3901)) - Remove deprecated `Group` methods `array`, `require_dataset`, and `create_dataset`. ([#3902](https://github.com/zarr-developers/zarr-python/pull/3902)) - Remove deprecated `AsyncArray.create` and `Array.create` methods. ([#3903](https://github.com/zarr-developers/zarr-python/pull/3903)) ### Misc - [#3546](https://github.com/zarr-developers/zarr-python/issues/3546), [#3793](https://github.com/zarr-developers/zarr-python/pull/3793), [#3800](https://github.com/zarr-developers/zarr-python/pull/3800), [#3828](https://github.com/zarr-developers/zarr-python/pull/3828), [#3830](https://github.com/zarr-developers/zarr-python/pull/3830), [#3833](https://github.com/zarr-developers/zarr-python/pull/3833), [#3837](https://github.com/zarr-developers/zarr-python/pull/3837), [#3897](https://github.com/zarr-developers/zarr-python/pull/3897) ## 3.1.6 (2026-03-19) ### Features - Exposes the array runtime configuration as an attribute called `config` on the `Array` and `AsyncArray` classes. The previous `AsyncArray._config` attribute is now a deprecated alias for `AsyncArray.config`. ([#3668](https://github.com/zarr-developers/zarr-python/pull/3668)) - Adds a method for creating a new `Array` / `AsyncArray` instance with a new runtime configuration, and fixes inaccurate documentation about the `write_empty_chunks` configuration parameter. ([#3668](https://github.com/zarr-developers/zarr-python/pull/3668)) - Adds synchronous methods to stores that do not benefit from an async event loop. The shape of these methods is defined by protocol classes to support structural subtyping. ([#3725](https://github.com/zarr-developers/zarr-python/pull/3725)) - Fix near-miss penalty in `_morton_order` with hybrid ceiling+argsort strategy. ([#3718](https://github.com/zarr-developers/zarr-python/pull/3718)) ### Bugfixes - Correct the target bytes number for auto-chunking when auto-sharding. ([#3603](https://github.com/zarr-developers/zarr-python/pull/3603)) - Fixed a bug in the sharding codec that prevented nested shard reads in certain cases. ([#3655](https://github.com/zarr-developers/zarr-python/pull/3655)) - Fix obstore `_transform_list_dir` implementation to correctly relativize paths (removing `lstrip` usage). ([#3657](https://github.com/zarr-developers/zarr-python/pull/3657)) - Raise error when trying to encode `numpy.dtypes.StringDType` with `na_object` set. ([#3695](https://github.com/zarr-developers/zarr-python/pull/3695)) - `CacheStore`, `LoggingStore` and `LatencyStore` now support with_read_only. ([#3700](https://github.com/zarr-developers/zarr-python/pull/3700)) - Skip chunk coordinate enumeration in resize when the array is only growing, avoiding unbounded memory usage for large arrays. ([#3702](https://github.com/zarr-developers/zarr-python/pull/3702)) - Fix a performance bug in morton curve generation. ([#3705](https://github.com/zarr-developers/zarr-python/pull/3705)) - Add a dedicated in-memory cache for byte-range requests to the experimental `CacheStore`. ([#3710](https://github.com/zarr-developers/zarr-python/pull/3710)) - `BaseFloat._check_scalar` rejects invalid string values. ([#3586](https://github.com/zarr-developers/zarr-python/issues/3586)) - Apply drop_axes squeeze in partial decode path for sharding. ([#3763](https://github.com/zarr-developers/zarr-python/pull/3763)) - Set `copy=False` in reshape operation. ([#3649](https://github.com/zarr-developers/zarr-python/pull/3649)) - Validate that dask-style chunks have regular shapes. ([#3779](https://github.com/zarr-developers/zarr-python/pull/3779)) ### Improved Documentation - Add documentation example for creating uncompressed arrays in the Compression section of the user guide. ([#3464](https://github.com/zarr-developers/zarr-python/issues/3464)) - Add AI-assisted code policy to the contributing guide. ([#3769](https://github.com/zarr-developers/zarr-python/pull/3769)) - Added a glossary. ([#3767](https://github.com/zarr-developers/zarr-python/pull/3767)) ### Misc - [#3562](https://github.com/zarr-developers/zarr-python/pull/3562), [#3605](https://github.com/zarr-developers/zarr-python/pull/3605), [#3619](https://github.com/zarr-developers/zarr-python/pull/3619), [#3623](https://github.com/zarr-developers/zarr-python/pull/3623), [#3636](https://github.com/zarr-developers/zarr-python/pull/3636), [#3648](https://github.com/zarr-developers/zarr-python/pull/3648), [#3656](https://github.com/zarr-developers/zarr-python/pull/3656), [#3658](https://github.com/zarr-developers/zarr-python/pull/3658), [#3673](https://github.com/zarr-developers/zarr-python/pull/3673), [#3704](https://github.com/zarr-developers/zarr-python/pull/3704), [#3706](https://github.com/zarr-developers/zarr-python/pull/3706), [#3708](https://github.com/zarr-developers/zarr-python/pull/3708), [#3712](https://github.com/zarr-developers/zarr-python/pull/3712), [#3713](https://github.com/zarr-developers/zarr-python/pull/3713), [#3717](https://github.com/zarr-developers/zarr-python/pull/3717), [#3721](https://github.com/zarr-developers/zarr-python/pull/3721), [#3728](https://github.com/zarr-developers/zarr-python/pull/3728), [#3778](https://github.com/zarr-developers/zarr-python/pull/3778) ## 3.1.5 (2025-11-21) ### Bugfixes - Fix formatting errors in the release notes section of the docs. ([#3594](https://github.com/zarr-developers/zarr-python/pull/3594)) ## 3.1.4 (2025-11-20) ### Features - The `Array` class can now also be parametrized in the same manner as the `AsyncArray` class, allowing Zarr format v2 and v3 `Array`s to be distinguished. New types have been added to `zarr.types` to help with this. ([#3304](https://github.com/zarr-developers/zarr-python/pull/3304)) - Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. ([#3366](https://github.com/zarr-developers/zarr-python/pull/3366)) - Adds a `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/pull/3490)) - Add a `array.target_shard_size_bytes` to [`zarr.config`][] to allow users to set a maximum number of bytes per-shard when `shards="auto"` in, for example, [`zarr.create_array`][]. ([#3547](https://github.com/zarr-developers/zarr-python/pull/3547)) - Make `async_array` on the [`zarr.Array`][] class public (`_async_array` will remain untouched, but its stability is not guaranteed). ([#3556](https://github.com/zarr-developers/zarr-python/pull/3556)) ### Bugfixes - Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/pull/3483)) - Fixed a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). ([#3530](https://github.com/zarr-developers/zarr-python/pull/3530)) - Fixed a bug where the `"consolidated_metadata"` key was written to metadata documents even when consolidated metadata was not used, resulting in invalid metadata documents. ([#3535](https://github.com/zarr-developers/zarr-python/pull/3535)) - Improve write performance to large shards by up to 10x. ([#3560](https://github.com/zarr-developers/zarr-python/issues/3560)) ### Improved Documentation - Use mkdocs-material for Zarr-Python documentation ([#3118](https://github.com/zarr-developers/zarr-python/pull/3118)) - Document different values of StoreLike with examples in the user guide. ([#3303](https://github.com/zarr-developers/zarr-python/issues/3303)) - Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. ([#3502](https://github.com/zarr-developers/zarr-python/pull/3502)) - Updated 3.0 Migration Guide to include function signature change to zarr.Array.resize function. ([#3536](https://github.com/zarr-developers/zarr-python/issues/3536)) ### Misc - [#3515](https://github.com/zarr-developers/zarr-python/pull/3515), [#3532](https://github.com/zarr-developers/zarr-python/pull/3532), [#3533](https://github.com/zarr-developers/zarr-python/pull/3533), [#3553](https://github.com/zarr-developers/zarr-python/pull/3553) ## 3.1.3 (2025-09-18) ### Features - Add a command-line interface to migrate v2 Zarr metadata to v3. Corresponding functions are also provided under zarr.metadata. ([#1798](https://github.com/zarr-developers/zarr-python/issues/1798)) - Add obstore implementation of delete_dir. ([#3310](https://github.com/zarr-developers/zarr-python/pull/3310)) - Adds a registry for chunk key encodings for extensibility. This allows users to implement a custom `ChunkKeyEncoding`, which can be registered via `register_chunk_key_encoding` or as an entry point under `zarr.chunk_key_encoding`. ([#3436](https://github.com/zarr-developers/zarr-python/pull/3436)) - Trying to open a group at a path where an array already exists now raises a helpful error. ([#3444](https://github.com/zarr-developers/zarr-python/pull/3444)) ### Bugfixes - Prevents creation of groups (.create_group) or arrays (.create_array) as children of an existing array. ([#2582](https://github.com/zarr-developers/zarr-python/issues/2582)) - Fix a bug preventing `ones_like`, `full_like`, `empty_like`, `zeros_like` and `open_like` functions from accepting an explicit specification of array attributes like shape, dtype, chunks etc. The functions `full_like`, `empty_like`, and `open_like` now also more consistently infer a `fill_value` parameter from the provided array. ([#2992](https://github.com/zarr-developers/zarr-python/pull/2992)) - LocalStore now uses atomic writes, which should prevent some cases of corrupted data. ([#3411](https://github.com/zarr-developers/zarr-python/issues/3411)) - Fix a potential race condition when using `zarr.create_array` with the `data` parameter set to a NumPy array. Previously Zarr was iterating over the newly created array with a granularity that was too low. Now Zarr chooses a granularity that matches the size of the stored objects for that array. ([#3422](https://github.com/zarr-developers/zarr-python/pull/3422)) - Fix ChunkGrid definition (broken in 3.1.2) ([#3425](https://github.com/zarr-developers/zarr-python/pull/3425)) - Ensure syntax like `root['/subgroup']` works equivalently to `root['subgroup']` when using consolidated metadata. ([#3428](https://github.com/zarr-developers/zarr-python/pull/3428)) - Creating a new group with `zarr.group` no longer errors. This fixes a regression introduced in version 3.1.2. ([#3431](https://github.com/zarr-developers/zarr-python/pull/3431)) - Setting `fill_value` to a float like `0.0` when the data type of the array is an integer is a common mistake. This change lets Zarr Python read arrays with this erroneous metadata, although Zarr Python will not create such arrays. ([#3448](https://github.com/zarr-developers/zarr-python/pull/3448)) ### Deprecations and Removals - The `Store.set_partial_writes` method, which was not used by Zarr-Python, has been removed. `store.supports_partial_writes` is now always `False`. ([#2859](https://github.com/zarr-developers/zarr-python/issues/2859)) ### Misc - [#3376](https://github.com/zarr-developers/zarr-python/pull/3376), [#3390](https://github.com/zarr-developers/zarr-python/pull/3390), [#3403](https://github.com/zarr-developers/zarr-python/pull/3403), [#3449](https://github.com/zarr-developers/zarr-python/pull/3449) ## 3.1.2 (2025-08-25) ### Features - Added support for async vectorized and orthogonal indexing. ([#3083](https://github.com/zarr-developers/zarr-python/pull/3083)) - Make config param optional in init_array ([#3391](https://github.com/zarr-developers/zarr-python/pull/3391)) ### Bugfixes - Ensure that -0.0 is not considered equal to 0.0 when checking if all the values in a chunk are equal to an array's fill value. ([#3144](https://github.com/zarr-developers/zarr-python/issues/3144)) - Fix a bug in `create_array` caused by iterating over chunk-aligned regions instead of shard-aligned regions when writing data. Additionally, the behavior of `nchunks_initialized` has been adjusted. This function consistently reports the number of chunks present in stored objects, even when the array uses the sharding codec. ([#3299](https://github.com/zarr-developers/zarr-python/pull/3299)) - Opening an array or group with `mode="r+"` will no longer create new arrays or groups. ([#3307](https://github.com/zarr-developers/zarr-python/pull/3307)) - Added `zarr.errors.ArrayNotFoundError`, which is raised when attempting to open a zarr array that does not exist, and `zarr.errors.NodeNotFoundError`, which is raised when failing to open an array or a group in a context where either an array or a group was expected. ([#3367](https://github.com/zarr-developers/zarr-python/pull/3367)) - Ensure passing `config` is handled properly when `open`ing an existing array. ([#3378](https://github.com/zarr-developers/zarr-python/pull/3378)) - Raise a Zarr-specific error class when a codec can't be found by name when deserializing the given codecs. This avoids hiding this error behind a "not part of a zarr hierarchy" warning. ([#3395](https://github.com/zarr-developers/zarr-python/pull/3395)) ### Misc - [#3098](https://github.com/zarr-developers/zarr-python/pull/3098), [#3288](https://github.com/zarr-developers/zarr-python/pull/3288), [#3318](https://github.com/zarr-developers/zarr-python/pull/3318), [#3368](https://github.com/zarr-developers/zarr-python/issues/3368), [#3371](https://github.com/zarr-developers/zarr-python/pull/3371), [#3372](https://github.com/zarr-developers/zarr-python/pull/3372), [#3374](https://github.com/zarr-developers/zarr-python/pull/3374) ## 3.1.1 (2025-07-28) ### Features - Add lightweight implementations of `.getsize()` and `.getsize_prefix()` for ObjectStore. ([#3227](https://github.com/zarr-developers/zarr-python/pull/3227)) ### Bugfixes - Creating a Zarr format 2 array with the `order` keyword argument no longer raises a warning. ([#3112](https://github.com/zarr-developers/zarr-python/pull/3112)) - Fixed the error message when passing both `config` and `write_empty_chunks` arguments to reflect the current behaviour (`write_empty_chunks` takes precedence). ([#3112](https://github.com/zarr-developers/zarr-python/pull/3112)) - Creating a Zarr format 3 array with the `order` argument now consistently ignores this argument and raises a warning. ([#3112](https://github.com/zarr-developers/zarr-python/pull/3112)) - When using [`from_array`][zarr.api.asynchronous.from_array] to copy a Zarr format 2 array to a Zarr format 3 array, if the memory order of the input array is `"F"` a warning is raised and the order ignored. This is because Zarr format 3 arrays are always stored in "C" order. ([#3112](https://github.com/zarr-developers/zarr-python/pull/3112)) - The `config` argument to [`zarr.create`][zarr.create] (and functions that create arrays) is now used - previously it had no effect. ([#3112](https://github.com/zarr-developers/zarr-python/pull/3112)) - Ensure that all abstract methods of [`ZDType`][zarr.core.dtype.ZDType] raise a `NotImplementedError` when invoked. ([#3251](https://github.com/zarr-developers/zarr-python/pull/3251)) - Register 'gpu' marker with pytest for downstream StoreTests. ([#3258](https://github.com/zarr-developers/zarr-python/pull/3258)) - Expand the range of types accepted by `parse_data_type` to include strings and Sequences. - Move the functionality of `zarr.core.dtype.parse_data_type` to a new function called `zarr.dtype.parse_dtype`. This change ensures that nomenclature is consistent across the codebase. `zarr.core.dtype.parse_data_type` remains, so this change is not breaking. ([#3264](https://github.com/zarr-developers/zarr-python/pull/3264)) - Fix a regression introduced in 3.1.0 that prevented `inf`, `-inf`, and `nan` values from being stored in `attributes`. ([#3280](https://github.com/zarr-developers/zarr-python/pull/3280)) - Fixes [`Group.nmembers()`][zarr.Group.nmembers] ignoring depth when using consolidated metadata. ([#3287](https://github.com/zarr-developers/zarr-python/pull/3287)) ### Improved Documentation - Expand the data type docs to include a demonstration of the `parse_data_type` function. Expand the docstring for the `parse_data_type` function. ([#3249](https://github.com/zarr-developers/zarr-python/pull/3249)) - Add a section on codecs to the migration guide. ([#3273](https://github.com/zarr-developers/zarr-python/pull/3273)) ### Misc - Remove warnings about vlen-utf8 and vlen-bytes codecs ([#3268](https://github.com/zarr-developers/zarr-python/pull/3268)) ## 3.1.0 (2025-07-14) ### Features - Ensure that invocations of `create_array` use consistent keyword arguments, with consistent defaults. [`zarr.api.synchronous.create_array`][] now takes a `write_data` keyword argument The `Group.create_array` method takes `data` and `write_data` keyword arguments. The functions [`zarr.api.asynchronous.create`][], [`zarr.api.asynchronous.create_array`] and the methods `Group.create_array`, `Group.array`, had the default `fill_value` changed from `0` to the `DEFAULT_FILL_VALUE` value, which instructs Zarr to use the default scalar value associated with the array's data type as the fill value. These are all functions or methods for array creation that mirror, wrap or are wrapped by, another function that already has a default `fill_value` set to `DEFAULT_FILL_VALUE`. This change is necessary to make these functions consistent across the entire codebase, but as this changes default values, new data might have a different fill value than expected after this change. For data types where 0 is meaningful, like integers or floats, the default scalar is 0, so this change should not be noticeable. For data types where 0 is ambiguous, like fixed-length unicode strings, the default fill value might be different after this change. Users who were relying on how Zarr interpreted `0` as a non-numeric scalar value should set their desired fill value explicitly after this change. - Added public API for Buffer ABCs and implementations. Use `zarr.buffer` to access buffer implementations, and `zarr.abc.buffer` for the interface to implement new buffer types. Users previously importing buffer from `zarr.core.buffer` should update their imports to use `zarr.buffer`. As a reminder, all of `zarr.core` is considered a private API that's not covered by zarr-python's versioning policy. ([#2871](https://github.com/zarr-developers/zarr-python/issues/2871)) - Adds zarr-specific data type classes. This change adds a `ZDType` base class for Zarr V2 and Zarr V3 data types. Child classes are defined for each NumPy data type. Each child class defines routines for `JSON` serialization. New data types can be created and registered dynamically. Prior to this change, Zarr Python had two streams for handling data types. For Zarr V2 arrays, we used NumPy data type identifiers. For Zarr V3 arrays, we used a fixed set of string enums. Both of these systems proved hard to extend. This change is largely internal, but it does change the type of the `dtype` and `data_type` fields on the `ArrayV2Metadata` and `ArrayV3Metadata` classes. Previously, `ArrayV2Metadata.dtype` was a NumPy `dtype` object, and `ArrayV3Metadata.data_type` was an internally-defined `enum`. After this change, both `ArrayV2Metadata.dtype` and `ArrayV3Metadata.data_type` are instances of `ZDType`. A NumPy data type can be generated from a `ZDType` via the `ZDType.to_native_dtype()` method. The internally-defined Zarr V3 `enum` class is gone entirely, but the `ZDType.to_json(zarr_format=3)` method can be used to generate either a string, or dictionary that has a string `name` field, that represents the string value previously associated with that `enum`. For more on this new feature, see the [documentation](user-guide/data_types.md) ([#2874](https://github.com/zarr-developers/zarr-python/pull/2874)) - Added `NDBuffer.empty` method for faster ndbuffer initialization. ([#3191](https://github.com/zarr-developers/zarr-python/pull/3191)) - The minimum version of NumPy has increased to 1.26. ([#3226](https://github.com/zarr-developers/zarr-python/pull/3226)) - Add an alternate `from_array_metadata_and_store` constructor to `CodecPipeline`. ([#3233](https://github.com/zarr-developers/zarr-python/pull/3233)) ### Bugfixes - Fixes a variety of issues related to string data types. - Brings the `VariableLengthUTF8` data type Zarr V3 identifier in alignment with Zarr Python 3.0.8 - Disallows creation of 0-length fixed-length data types - Adds a regression test for the `VariableLengthUTF8` data type that checks against version 3.0.8 - Allows users to request the `VariableLengthUTF8` data type with `str`, `"str"`, or `"string"`. ([#3170](https://github.com/zarr-developers/zarr-python/pull/3170)) - Add human readable size for No. bytes stored to `info_complete` ([#3190](https://github.com/zarr-developers/zarr-python/pull/3190)) - Restores the ability to create a Zarr V2 array with a `null` fill value by introducing a new class `DefaultFillValue`, and setting the default value of the `fill_value` parameter in array creation routines to an instance of `DefaultFillValue`. For Zarr V3 arrays, `None` will act as an alias for a `DefaultFillValue` instance, thus preserving compatibility with existing code. ([#3198](https://github.com/zarr-developers/zarr-python/pull/3198)) - Fix the type of `ArrayV2Metadata.codec` to constrain it to `numcodecs.abc.Codec | None`. Previously the type was more permissive, allowing objects that can be parsed into Codecs (e.g., the codec name). The constructor of `ArrayV2Metadata` still allows the permissive input when creating new objects. ([#3232](https://github.com/zarr-developers/zarr-python/pull/3232)) ### Improved Documentation - Add a self-contained example of data type extension to the `examples` directory, and expanded the documentation for data types. ([#3157](https://github.com/zarr-developers/zarr-python/pull/3157)) - Add a description on how to create a RemoteStore of a specific filesystem to the `Remote Store` section in `docs/user-guide/storage.md`. State in the docstring of `FsspecStore.from_url` that the filesystem type is inferred from the URL scheme. It should help a user handling the case when the type of FsspecStore doesn't match the URL scheme. ([#3212](https://github.com/zarr-developers/zarr-python/pull/3212)) ### Deprecations and Removals - Removes default chunk encoding settings (filters, serializer, compressors) from the global configuration object. This removal is justified on the basis that storing chunk encoding settings in the config required a brittle, confusing, and inaccurate categorization of array data types, which was particularly unsuitable after the recent addition of new data types that didn't fit naturally into the pre-existing categories. The default chunk encoding is the same (Zstandard compression, and the required object codecs for variable length data types), but the chunk encoding is now generated by functions that cannot be reconfigured at runtime. Users who relied on setting the default chunk encoding via the global configuration object should instead specify the desired chunk encoding explicitly when creating an array. This change also adds an extra validation step to the creation of Zarr V2 arrays, which ensures that arrays with a `VariableLengthUTF8` or `VariableLengthBytes` data type cannot be created without the correct "object codec". ([#3228](https://github.com/zarr-developers/zarr-python/pull/3228)) - Removes support for passing keyword-only arguments positionally to the following functions and methods: `save_array`, `open`, `group`, `open_group`, `create`, `get_basic_selection`, `set_basic_selection`, `get_orthogonal_selection`, `set_orthogonal_selection`, `get_mask_selection`, `set_mask_selection`, `get_coordinate_selection`, `set_coordinate_selection`, `get_block_selection`, `set_block_selection`, `Group.create_array`, `Group.empty`, `Group.zeroes`, `Group.ones`, `Group.empty_like`, `Group.full`, `Group.zeros_like`, `Group.ones_like`, `Group.full_like`, `Group.array`. Prior to this change, passing a keyword-only argument positionally to one of these functions or methods would raise a deprecation warning. That warning is now gone. Passing keyword-only arguments to these functions and methods positionally is now an error. ## 3.0.10 (2025-07-03) ### Bugfixes - Removed an unnecessary check from `_fsspec._make_async` that would raise an exception when creating a read-only store backed by a local file system with `auto_mkdir` set to `False`. ([#3193](https://github.com/zarr-developers/zarr-python/pull/3193)) - Add missing import for AsyncFileSystemWrapper for _make_async in _fsspec.py ([#3195](https://github.com/zarr-developers/zarr-python/pull/3195)) ## 3.0.9 (2025-06-30) ### Features - Add `zarr.storage.FsspecStore.from_mapper()` so that `zarr.open()` supports stores of type `fsspec.mapping.FSMap`. ([#2774](https://github.com/zarr-developers/zarr-python/pull/2774)) - Implemented `move` for `LocalStore` and `ZipStore`. This allows users to move the store to a different root path. ([#3021](https://github.com/zarr-developers/zarr-python/pull/3021)) - Added `zarr.errors.GroupNotFoundError`, which is raised when attempting to open a group that does not exist. ([#3066](https://github.com/zarr-developers/zarr-python/pull/3066)) - Adds `fill_value` to the list of attributes displayed in the output of the `AsyncArray.info()` method. ([#3081](https://github.com/zarr-developers/zarr-python/pull/3081)) - Use `numpy.zeros` instead of `np.full` for a performance speedup when creating a `zarr.core.buffer.NDBuffer` with `fill_value=0`. ([#3082](https://github.com/zarr-developers/zarr-python/pull/3082)) - Port more stateful testing actions from [Icechunk](https://icechunk.io/en/stable/). ([#3130](https://github.com/zarr-developers/zarr-python/pull/3130)) - Adds a `with_read_only` convenience method to the `Store` abstract base class (raises `NotImplementedError`) and implementations to the `MemoryStore`, `ObjectStore`, `LocalStore`, and `FsspecStore` classes. ([#3138](https://github.com/zarr-developers/zarr-python/pull/3138)) ### Bugfixes - Ignore stale child metadata when reconsolidating metadata. ([#2921](https://github.com/zarr-developers/zarr-python/issues/2921)) - For Zarr format 2, allow fixed-length string arrays to be created without automatically inserting a `Vlen-UT8` codec in the array of filters. Fixed-length string arrays do not need this codec. This change fixes a regression where fixed-length string arrays created with Zarr Python 3 could not be read with Zarr Python 2.18. ([#3100](https://github.com/zarr-developers/zarr-python/pull/3100)) - When creating arrays without explicitly specifying a chunk size using `zarr.create` and other array creation routines, the chunk size will now set automatically instead of defaulting to the data shape. For large arrays this will result in smaller default chunk sizes. To retain previous behaviour, explicitly set the chunk shape to the data shape. This fix matches the existing chunking behaviour of `zarr.save_array` and `zarr.api.asynchronous.AsyncArray.create`. ([#3103](https://github.com/zarr-developers/zarr-python/pull/3103)) - When `zarr.save` has an argument `path=some/path/` and multiple arrays in `args`, the path resulted in `some/path/some/path` due to using the `path` argument twice while building the array path. This is now fixed. ([#3127](https://github.com/zarr-developers/zarr-python/pull/3127)) - Fix `zarr.open` default for argument `mode` when `store` is `read_only` ([#3128](https://github.com/zarr-developers/zarr-python/pull/3128)) - Suppress `FileNotFoundError` when deleting non-existent keys in the `obstore` adapter. When writing empty chunks (i.e. chunks where all values are equal to the array's fill value) to a zarr array, zarr will delete those chunks from the underlying store. For zarr arrays backed by the `obstore` adapter, this will potentially raise a `FileNotFoundError` if the chunk doesn't already exist. Since whether or not a delete of a non-existing object raises an error depends on the behavior of the underlying store, suppressing the error in all cases results in consistent behavior across stores, and is also what `zarr` seems to expect from the store. ([#3140](https://github.com/zarr-developers/zarr-python/pull/3140)) - Trying to open a StorePath/Array with `mode='r'` when the store is not read-only creates a read-only copy of the store. ([#3156](https://github.com/zarr-developers/zarr-python/pull/3156)) ## 3.0.8 (2025-05-19) !!! warning In versions 3.0.0 to 3.0.7 opening arrays or groups with `mode='a'` (the default for many builtin functions) would cause any existing paths in the store to be deleted. This is fixed in 3.0.8, and we recommend all users upgrade to avoid this bug that could cause unintentional data loss. ### Features - Added a `print_debug_info` function for bug reports. ([#2913](https://github.com/zarr-developers/zarr-python/pull/2913)) ### Bugfixes - Fix a bug that prevented the number of initialized chunks being counted properly. ([#2862](https://github.com/zarr-developers/zarr-python/pull/2862)) - Fixed sharding with GPU buffers. ([#2978](https://github.com/zarr-developers/zarr-python/pull/2978)) - Fix structured `dtype` fill value serialization for consolidated metadata ([#2998](https://github.com/zarr-developers/zarr-python/issues/2998)) - It is now possible to specify no compressor when creating a zarr format 2 array. This can be done by passing `compressor=None` to the various array creation routines. The default behaviour of automatically choosing a suitable default compressor remains if the compressor argument is not given. To reproduce the behaviour in previous zarr-python versions when `compressor=None` was passed, pass `compressor='auto'` instead. ([#3039](https://github.com/zarr-developers/zarr-python/pull/3039)) - Fixed the typing of `dimension_names` arguments throughout so that it now accepts iterables that contain `None` alongside `str`. ([#3045](https://github.com/zarr-developers/zarr-python/pull/3045)) - Using various functions to open data with `mode='a'` no longer deletes existing data in the store. ([#3062](https://github.com/zarr-developers/zarr-python/pull/3062)) - Internally use `typesize` constructor parameter for `numcodecs.blosc.Blosc` to improve compression ratios back to the v2-package levels. ([#2962](https://github.com/zarr-developers/zarr-python/pull/2962)) - Specifying the memory order of Zarr format 2 arrays using the `order` keyword argument has been fixed. ([#2950](https://github.com/zarr-developers/zarr-python/issues/2950)) ### Misc - [#2972](https://github.com/zarr-developers/zarr-python/pull/2972), [#3027](https://github.com/zarr-developers/zarr-python/pull/3027), [#3049](https://github.com/zarr-developers/zarr-python/pull/3049) ## 3.0.7 (2025-04-22) ### Features - Add experimental ObjectStore storage class based on obstore. ([#1661](https://github.com/zarr-developers/zarr-python/pull/1661)) - Add `zarr.from_array` using concurrent streaming of source data ([#2622](https://github.com/zarr-developers/zarr-python/pull/2622)) ### Bugfixes - 0-dimensional arrays are now returning a scalar. Therefore, the return type of `__getitem__` changed to NDArrayLikeOrScalar. This change is to make the behavior of 0-dimensional arrays consistent with `numpy` scalars. ([#2718](https://github.com/zarr-developers/zarr-python/pull/2718)) - Fix `fill_value` serialization for `NaN` in `ArrayV2Metadata` and add property-based testing of round-trip serialization ([#2802](https://github.com/zarr-developers/zarr-python/pull/2802)) - Fixes `ConsolidatedMetadata` serialization of `nan`, `inf`, and `-inf` to be consistent with the behavior of `ArrayMetadata`. ([#2996](https://github.com/zarr-developers/zarr-python/pull/2996)) ### Improved Documentation - Updated the 3.0 migration guide to include the removal of "." syntax for getting group members. ([#2991](https://github.com/zarr-developers/zarr-python/issues/2991), [#2997](https://github.com/zarr-developers/zarr-python/pull/2997)) ### Misc - Define a new versioning policy based on Effective Effort Versioning. This replaces the old Semantic Versioning-based policy. ([#2924](https://github.com/zarr-developers/zarr-python/issues/2924), [#2910](https://github.com/zarr-developers/zarr-python/pull/2910)) - Make warning filters in the tests more specific, so warnings emitted by tests added in the future are more likely to be caught instead of ignored. ([#2714](https://github.com/zarr-developers/zarr-python/pull/2714)) - Avoid an unnecessary memory copy when writing Zarr to a local file ([#2944](https://github.com/zarr-developers/zarr-python/pull/2944)) ## 3.0.6 (2025-03-20) ### Bugfixes - Restore functionality of `del z.attrs['key']` to actually delete the key. ([#2908](https://github.com/zarr-developers/zarr-python/pull/2908)) ## 3.0.5 (2025-03-07) ### Bugfixes - Fixed a bug where `StorePath` creation would not apply standard path normalization to the `path` parameter, which led to the creation of arrays and groups with invalid keys. ([#2850](https://github.com/zarr-developers/zarr-python/pull/2850)) - Prevent update_attributes calls from deleting old attributes ([#2870](https://github.com/zarr-developers/zarr-python/pull/2870)) ### Misc - [#2796](https://github.com/zarr-developers/zarr-python/pull/2796) ## 3.0.4 (2025-02-23) ### Features - Adds functions for concurrently creating multiple arrays and groups. ([#2665](https://github.com/zarr-developers/zarr-python/pull/2665)) ### Bugfixes - Fixed a bug where `ArrayV2Metadata` could save `filters` as an empty array. ([#2847](https://github.com/zarr-developers/zarr-python/pull/2847)) - Fix a bug when setting values of a smaller last chunk. ([#2851](https://github.com/zarr-developers/zarr-python/pull/2851)) ### Misc - [#2828](https://github.com/zarr-developers/zarr-python/pull/2828) ## 3.0.3 (2025-02-14) ### Features - Improves performance of FsspecStore.delete_dir for remote filesystems supporting concurrent/batched deletes, e.g., s3fs. ([#2661](https://github.com/zarr-developers/zarr-python/pull/2661)) - Added `zarr.config.enable_gpu` to update Zarr's configuration to use GPUs. ([#2751](https://github.com/zarr-developers/zarr-python/pull/2751)) - Avoid reading chunks during writes where possible. [#757](https://github.com/zarr-developers/zarr-python/issues/757) ([#2784](https://github.com/zarr-developers/zarr-python/pull/2784)) - `LocalStore` learned to `delete_dir`. This makes array and group deletes more efficient. ([#2804](https://github.com/zarr-developers/zarr-python/pull/2804)) - Add `zarr.testing.strategies.array_metadata` to generate ArrayV2Metadata and ArrayV3Metadata instances. ([#2813](https://github.com/zarr-developers/zarr-python/pull/2813)) - Add arbitrary `shards` to Hypothesis strategy for generating arrays. ([#2822](https://github.com/zarr-developers/zarr-python/pull/2822)) ### Bugfixes - Fixed bug with Zarr using device memory, instead of host memory, for storing metadata when using GPUs. ([#2751](https://github.com/zarr-developers/zarr-python/pull/2751)) - The array returned by `zarr.empty` and an empty `zarr.core.buffer.cpu.NDBuffer` will now be filled with the specified fill value, or with zeros if no fill value is provided. This fixes a bug where Zarr format 2 data with no fill value was written with un-predictable chunk sizes. ([#2755](https://github.com/zarr-developers/zarr-python/pull/2755)) - Fix zip-store path checking for stores with directories listed as files. ([#2758](https://github.com/zarr-developers/zarr-python/pull/2758)) - Use removeprefix rather than replace when removing filename prefixes in `FsspecStore.list` ([#2778](https://github.com/zarr-developers/zarr-python/pull/2778)) - Enable automatic removal of `needs release notes` with labeler action ([#2781](https://github.com/zarr-developers/zarr-python/pull/2781)) - Use the proper label config ([#2785](https://github.com/zarr-developers/zarr-python/pull/2785)) - Alters the behavior of `create_array` to ensure that any groups implied by the array's name are created if they do not already exist. Also simplifies the type signature for any function that takes an ArrayConfig-like object. ([#2795](https://github.com/zarr-developers/zarr-python/pull/2795)) - Enitialise empty chunks to the default fill value during writing and add default fill values for datetime, timedelta, structured, and other (void* fixed size) data types ([#2799](https://github.com/zarr-developers/zarr-python/pull/2799)) - Ensure utf8 compliant strings are used to construct numpy arrays in property-based tests ([#2801](https://github.com/zarr-developers/zarr-python/pull/2801)) - Fix pickling for ZipStore ([#2807](https://github.com/zarr-developers/zarr-python/pull/2807)) - Update numcodecs to not overwrite codec configuration ever. Closes [#2800](https://github.com/zarr-developers/zarr-python/issues/2800). ([#2811](https://github.com/zarr-developers/zarr-python/pull/2811)) - Fix fancy indexing (e.g. arr[5, [0, 1]]) with the sharding codec ([#2817](https://github.com/zarr-developers/zarr-python/pull/2817)) ### Improved Documentation - Added new user guide on GPU. ([#2751](https://github.com/zarr-developers/zarr-python/pull/2751)) ## 3.0.2 (2025-01-31) ### Features - Test `getsize()` and `getsize_prefix()` in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Test that a `ValueError` is raised for invalid byte range syntax in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Separate instantiating and opening a store in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Add a test for using Stores as context managers in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Implemented `LoggingStore.open()`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - `LoggingStore` is now a generic class. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Change StoreTest's `test_store_repr`, `test_store_supports_writes`, `test_store_supports_partial_writes`, and `test_store_supports_listing` to be implemented using `@abstractmethod`, rather than raising `NotImplementedError`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Test the error raised for invalid buffer arguments in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Test that data can be written to a store that's not yet open using the store.set method in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Adds a new function `init_array` for initializing an array in storage, and refactors `create_array` to use `init_array`. `create_array` takes two new parameters: `data`, an optional array-like object, and `write_data`, a bool which defaults to `True`. If `data` is given to `create_array`, then the `dtype` and `shape` attributes of `data` are used to define the corresponding attributes of the resulting Zarr array. Additionally, if `data` is given and `write_data` is `True`, then the values in `data` will be written to the newly created array. ([#2761](https://github.com/zarr-developers/zarr-python/pull/2761)) ### Bugfixes - Wrap sync fsspec filesystems with `AsyncFileSystemWrapper`. ([#2533](https://github.com/zarr-developers/zarr-python/pull/2533)) - Added backwards compatibility for Zarr format 2 structured arrays. ([#2681](https://github.com/zarr-developers/zarr-python/pull/2681)) - Update equality for `LoggingStore` and `WrapperStore` such that 'other' must also be a `LoggingStore` or `WrapperStore` respectively, rather than only checking the types of the stores they wrap. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Ensure that `ZipStore` is open before getting or setting any values. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Use stdout rather than stderr as the default stream for `LoggingStore`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Match the errors raised by read only stores in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/pull/2693)) - Fixed `ZipStore` to make sure the correct attributes are saved when instances are pickled. This fixes a previous bug that prevented using `ZipStore` with a `ProcessPoolExecutor`. ([#2762](https://github.com/zarr-developers/zarr-python/pull/2762)) - Updated the optional test dependencies to include `botocore` and `fsspec`. ([#2768](https://github.com/zarr-developers/zarr-python/pull/2768)) - Fixed the fsspec tests to skip if `botocore` is not installed. Previously they would have failed with an import error. ([#2768](https://github.com/zarr-developers/zarr-python/pull/2768)) - Optimize full chunk writes. ([#2782](https://github.com/zarr-developers/zarr-python/pull/2782)) ### Improved Documentation - Changed the machinery for creating changelog entries. Now individual entries should be added as files to the `changes` directory in the `zarr-python` repository, instead of directly to the changelog file. ([#2736](https://github.com/zarr-developers/zarr-python/pull/2736)) ### Other - Created a type alias `ChunkKeyEncodingLike` to model the union of `ChunkKeyEncoding` instances and the dict form of the parameters of those instances. `ChunkKeyEncodingLike` should be used by high-level functions to provide a convenient way for creating `ChunkKeyEncoding` objects. ([#2763](https://github.com/zarr-developers/zarr-python/pull/2763)) ## 3.0.1 (2025-01-17) * Implement `zarr.from_array` using concurrent streaming ([#2622](https://github.com/zarr-developers/zarr-python/pull/2622)). ### Bug fixes * Fixes `order` argument for Zarr format 2 arrays ([#2679](https://github.com/zarr-developers/zarr-python/pull/2679)). * Fixes a bug that prevented reading Zarr format 2 data with consolidated metadata written using `zarr-python` version 2 ([#2694](https://github.com/zarr-developers/zarr-python/issues/2694)). * Ensure that compressor=None results in no compression when writing Zarr format 2 data ([#2708](https://github.com/zarr-developers/zarr-python/issues/2708)). * Fix for empty consolidated metadata dataset: backwards compatibility with Zarr-Python 2 ([#2695](https://github.com/zarr-developers/zarr-python/pull/2695)). ### Documentation * Add v3.0.0 release announcement banner ([#2677](https://github.com/zarr-developers/zarr-python/pull/2677)). * Quickstart guide alignment with V3 API ([#2697](https://github.com/zarr-developers/zarr-python/pull/2697)). * Fix doctest failures related to numcodecs 0.15 ([#2727](https://github.com/zarr-developers/zarr-python/pull/2727)). ### Other * Removed some unnecessary files from the source distribution to reduce its size. ([#2686](https://github.com/zarr-developers/zarr-python/pull/2686)). * Enable codecov in GitHub actions ([#2682](https://github.com/zarr-developers/zarr-python/pull/2682)). * Speed up hypothesis tests ([#2650](https://github.com/zarr-developers/zarr-python/pull/2650)). * Remove multiple imports for an import name ([#2723](https://github.com/zarr-developers/zarr-python/pull/2723)). ## 3.0.0 (2025-01-09) 3.0.0 is a new major release of Zarr-Python, with many breaking changes. See the [v3 migration guide](user-guide/v3_migration.md) for a listing of what's changed. Normal release note service will resume with further releases in the 3.0.0 series. Release notes for the zarr-python 2.x and 1.x releases can be found here: https://zarr.readthedocs.io/en/support-v2/release.html zarr-python-3.3.0/docs/user-guide/000077500000000000000000000000001523267620000170165ustar00rootroot00000000000000zarr-python-3.3.0/docs/user-guide/arrays.md000066400000000000000000000703171523267620000206510ustar00rootroot00000000000000# Working with arrays ## Creating an array Zarr has several functions for creating arrays. For example: ```python exec="true" session="arrays" import shutil shutil.rmtree('data', ignore_errors=True) import numpy as np ``` ```python exec="true" session="arrays" source="above" result="ansi" import zarr z = zarr.create_array(store="memory://arrays-demo", shape=(10000, 10000), chunks=(1000, 1000), dtype='int32') print(z) ``` The code above creates a 2-dimensional array of 32-bit integers with 10000 rows and 10000 columns, divided into chunks where each chunk has 1000 rows and 1000 columns (and so there will be 100 chunks in total). The data is written to an in-memory store: when `fsspec` is installed, a `memory://` URL resolves to a [`zarr.storage.FsspecStore`][] backed by fsspec's in-memory filesystem; otherwise a [`zarr.storage.ManagedMemoryStore`][] is used. See the [Storage guide](storage.md) for more details on stores, and [Persistent arrays](#persistent-arrays) for details on storing arrays in other stores. See [Data types](data_types.md) for an in-depth look at the data types supported by Zarr, and [Chunk size and shape](performance.md#chunk-size-and-shape) in the performance guide for guidance on choosing chunk shapes. See the [`zarr.create_array`][] API documentation for more detailed information about creating arrays. ## Reading and writing data Zarr arrays support a similar interface to [NumPy](https://numpy.org/doc/stable/) arrays for reading and writing data. For example, the entire array can be filled with a scalar value: ```python exec="true" session="arrays" source="above" z[:] = 42 ``` Regions of the array can also be written to, e.g.: ```python exec="true" session="arrays" source="above" import numpy as np z[0, :] = np.arange(10000) z[:, 0] = np.arange(10000) ``` The contents of the array can be retrieved by slicing, which will load the requested region into memory as a NumPy array, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" print(z[0, 0]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z[-1, -1]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z[0, :]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z[:, 0]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z[:]) ``` More information about NumPy-style indexing can be found in the [NumPy documentation](https://numpy.org/doc/stable/user/basics.indexing.html). ## Persistent arrays In the examples above, compressed data for each chunk of the array was stored in main memory. Zarr arrays can also be stored on a file system, enabling persistence of data between sessions. To do this, we can change the store argument to point to a filesystem path: ```python exec="true" session="arrays" source="above" z1 = zarr.create_array(store='data/example-1.zarr', shape=(10000, 10000), chunks=(1000, 1000), dtype='int32') ``` The array above will store its configuration metadata and all compressed chunk data in a directory called `'data/example-1.zarr'` relative to the current working directory. The [`zarr.create_array`][] function provides a convenient way to create a new persistent array or continue working with an existing array. Note, there is no need to close an array: data are automatically flushed to disk, and files are automatically closed whenever an array is modified. Persistent arrays support the same interface for reading and writing data, e.g.: ```python exec="true" session="arrays" source="above" z1[:] = 42 z1[0, :] = np.arange(10000) z1[:, 0] = np.arange(10000) ``` Check that the data have been written and can be read again: ```python exec="true" session="arrays" source="above" result="ansi" z2 = zarr.open_array('data/example-1.zarr', mode='r') print(np.all(z1[:] == z2[:])) ``` If you are just looking for a fast and convenient way to save NumPy arrays to disk then load back into memory later, the functions [`zarr.save`][] and [`zarr.load`][] may be useful. E.g.: ```python exec="true" session="arrays" source="above" result="ansi" a = np.arange(10) zarr.save('data/example-2.zarr', a) print(zarr.load('data/example-2.zarr')) ``` Please note that there are a number of other options for persistent array storage, see the [Storage Guide](storage.md) for more details. ## Resizing and appending A Zarr array can be resized, which means that any of its dimensions can be increased or decreased in length. For example: ```python exec="true" session="arrays" source="above" result="ansi" z = zarr.create_array(store='data/example-3.zarr', shape=(10000, 10000), dtype='int32', chunks=(1000, 1000)) z[:] = 42 print(f"Original shape: {z.shape}") z.resize((20000, 10000)) print(f"New shape: {z.shape}") ``` Note that when an array is resized, the underlying data are not rearranged in any way. If one or more dimensions are shrunk, any chunks falling outside the new array shape will be deleted from the underlying store. [`zarr.Array.append`][] is provided as a convenience function, which can be used to append data to any axis. E.g.: ```python exec="true" session="arrays" source="above" result="ansi" a = np.arange(10000000, dtype='int32').reshape(10000, 1000) z = zarr.create_array(store='data/example-4.zarr', shape=a.shape, dtype=a.dtype, chunks=(1000, 100)) z[:] = a print(f"Original shape: {z.shape}") z.append(a) print(f"Shape after first append: {z.shape}") z.append(np.vstack([a, a]), axis=1) print(f"Shape after second append: {z.shape}") ``` ## Runtime configuration Zarr arrays are parametrized with a configuration that determines certain aspects of array behavior. We currently support five configuration options for arrays: `order`, `write_empty_chunks`, `read_missing_chunks`, `sharding_coalesce_max_gap_bytes`, and `sharding_coalesce_max_bytes`. | field | type | default | description | | - | - | - | - | | `order` | `Literal["C", "F"]` | `"C"` | The memory layout of arrays returned when reading data from the store. | `write_empty_chunks` | `bool` | `False` | Controls whether empty chunks are written to storage. See [Empty chunks](performance.md#empty-chunks). | `read_missing_chunks` | `bool` | `True` | Controls whether missing chunks are filled with the array's fill value on read. If `False`, reading missing chunks raises a [`ChunkNotFoundError`][zarr.errors.ChunkNotFoundError]. | `sharding_coalesce_max_gap_bytes` | `int` | `1048576` (1 MiB) | When reading multiple chunks from the same shard, nearby byte ranges separated by no more than this many bytes are coalesced into a single request to the store. | `sharding_coalesce_max_bytes` | `int` | `16777216` (16 MiB) | Requests will not be coalesced if doing so would exceed this byte size. !!! info The Zarr V3 spec states that readers should interpret an uninitialized chunk as containing the array's `fill_value`. By default, Zarr-Python follows this behavior: a missing chunk is treated as uninitialized and filled with the array's `fill_value`. However, if you know that all chunks have been written (i.e., are initialized), you may want to treat a missing chunk as an error. Set `read_missing_chunks=False` to raise a [`ChunkNotFoundError`][zarr.errors.ChunkNotFoundError] instead. !!! note `write_empty_chunks=False` skips writing chunks that are entirely the array's fill value. If `read_missing_chunks=False`, attempting to read these missing chunks will raise a [`ChunkNotFoundError`][zarr.errors.ChunkNotFoundError]. You can specify the configuration when you create an array with the `config` keyword argument. `config` can be passed as either a `dict` or an `ArrayConfig` object. ```python exec="true" session="arrays" source="above" result="ansi" arr = zarr.create_array({}, shape=(10,), dtype='int8', config={"write_empty_chunks": True}) print(arr.config) ``` To get an array view with a different config, use the `with_config` method. ```python exec="true" session="arrays" source="above" result="ansi" arr_f = arr.with_config({"order": "F"}) print(arr_f.config) ``` ## Compressors A number of different compressors can be used with Zarr. Zarr includes Blosc, Zstandard and Gzip compressors. Additional compressors are available through a separate package called [NumCodecs](https://numcodecs.readthedocs.io/en/stable/) which provides various compressor libraries including LZ4, Zlib, BZ2 and LZMA. Different compressors can be provided via the `compressors` keyword argument accepted by all array creation functions. For example: ```python exec="true" session="arrays" source="above" result="ansi" compressors = zarr.codecs.BloscCodec(cname='zstd', clevel=3, shuffle='bitshuffle') data = np.arange(100000000, dtype='int32').reshape(10000, 10000) z = zarr.create_array(store='data/example-5.zarr', shape=data.shape, dtype=data.dtype, chunks=(1000, 1000), compressors=compressors) z[:] = data print(z.compressors) ``` This array above will use Blosc as the primary compressor, using the Zstandard algorithm (compression level 3) internally within Blosc, and with the bit-shuffle filter applied. When using a compressor, it can be useful to get some diagnostics on the compression ratio. Zarr arrays provide the [`zarr.Array.info`][] property which can be used to print useful diagnostics, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" print(z.info) ``` The [`zarr.Array.info_complete`][] method inspects the underlying store and prints additional diagnostics, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" print(z.info_complete()) ``` !!! note [`zarr.Array.info_complete`][] will inspect the underlying store and may be slow for large arrays. Use [`zarr.Array.info`][] if detailed storage statistics are not needed. If you don't specify a compressor, by default Zarr uses the Zstandard compressor. To create an array without any compression, set `compressors=None`: ```python exec="true" session="arrays" source="above" result="ansi" z_no_compress = zarr.create_array(store='data/example-uncompressed.zarr', shape=(10000, 10000), chunks=(1000, 1000), dtype='int32', compressors=None) print(f"Compressors: {z_no_compress.compressors}") ``` In addition to Blosc and Zstandard, other compression libraries can also be used. For example, here is an array using Gzip compression, level 1: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(100000000, dtype='int32').reshape(10000, 10000) z = zarr.create_array(store='data/example-6.zarr', shape=data.shape, dtype=data.dtype, chunks=(1000, 1000), compressors=zarr.codecs.GzipCodec(level=1)) z[:] = data print(f"Compressors: {z.compressors}") ``` Here is an example using LZMA from [NumCodecs](https://numcodecs.readthedocs.io/en/stable/) with a custom filter pipeline including LZMA's built-in delta filter: ```python exec="true" session="arrays" source="above" result="ansi" import lzma from zarr.codecs.numcodecs import LZMA lzma_filters = [dict(id=lzma.FILTER_DELTA, dist=4), dict(id=lzma.FILTER_LZMA2, preset=1)] compressors = LZMA(filters=lzma_filters) data = np.arange(100000000, dtype='int32').reshape(10000, 10000) z = zarr.create_array(store='data/example-7.zarr', shape=data.shape, dtype=data.dtype, chunks=(1000, 1000), compressors=compressors) print(f"Compressors: {z.compressors}") ``` ## Filters In some cases, compression can be improved by transforming the data in some way. For example, if nearby values tend to be correlated, then shuffling the bytes within each numerical value or storing the difference between adjacent values may increase compression ratio. Some compressors provide built-in filters that apply transformations to the data prior to compression. For example, the Blosc compressor has built-in implementations of byte- and bit-shuffle filters, and the LZMA compressor has a built-in implementation of a delta filter. However, to provide additional flexibility for implementing and using filters in combination with different compressors, Zarr also provides a mechanism for configuring filters outside of the primary compressor. Here is an example using a delta filter with the Blosc compressor: ```python exec="true" session="arrays" source="above" result="ansi" from zarr.codecs.numcodecs import Delta filters = [Delta(dtype='int32')] compressors = zarr.codecs.BloscCodec(cname='zstd', clevel=1, shuffle='shuffle') data = np.arange(100000000, dtype='int32').reshape(10000, 10000) z = zarr.create_array(store='data/example-9.zarr', shape=data.shape, dtype=data.dtype, chunks=(1000, 1000), filters=filters, compressors=compressors) print(z.info_complete()) ``` For more information about available filter codecs, see the [Numcodecs](https://numcodecs.readthedocs.io/en/stable/) documentation. ## Advanced indexing Zarr arrays support several methods for advanced or "fancy" indexing, which enable a subset of data items to be extracted or updated in an array without loading the entire array into memory. Note that although this functionality is similar to some of the advanced indexing capabilities available on NumPy arrays and on h5py datasets, **the Zarr API for advanced indexing is different from both NumPy and h5py**, so please read this section carefully. For a complete description of the indexing API, see the documentation for the [`zarr.Array`][] class. ### Indexing with coordinate arrays Items from a Zarr array can be extracted by providing an integer array of coordinates. E.g.: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(10) ** 2 z = zarr.create_array(store='data/example-10.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(z[:]) print(z.get_coordinate_selection([2, 5])) ``` Coordinate arrays can also be used to update data, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" z.set_coordinate_selection([2, 5], [-1, -2]) print(z[:]) ``` For multidimensional arrays, coordinates must be provided for each dimension, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(15).reshape(3, 5) z = zarr.create_array(store='data/example-11.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(z[:]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z.get_coordinate_selection(([0, 2], [1, 3]))) ``` ```python exec="true" session="arrays" source="above" result="ansi" z.set_coordinate_selection(([0, 2], [1, 3]), [-1, -2]) print(z[:]) ``` For convenience, coordinate indexing is also available via the `vindex` property, as well as the square bracket operator, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" print(z.vindex[[0, 2], [1, 3]]) z.vindex[[0, 2], [1, 3]] = [-3, -4] ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z[:]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z[[0, 2], [1, 3]]) ``` When the indexing arrays have different shapes, they are broadcast together. That is, the following two calls are equivalent: ```python exec="true" session="arrays" source="above" result="ansi" print(z[1, [1, 3]]) print(z[[1, 1], [1, 3]]) ``` ### Indexing with a mask array Items can also be extracted by providing a Boolean mask. E.g.: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(10) ** 2 z = zarr.create_array(store='data/example-12.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(z[:]) ``` ```python exec="true" session="arrays" source="above" result="ansi" sel = np.zeros_like(z, dtype=bool) sel[2] = True sel[5] = True print(z.get_mask_selection(sel)) ``` ```python exec="true" session="arrays" source="above" result="ansi" z.set_mask_selection(sel, [-1, -2]) print(z[:]) ``` Here's a multidimensional example: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(15).reshape(3, 5) z = zarr.create_array(store='data/example-13.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(z[:]) ``` ```python exec="true" session="arrays" source="above" result="ansi" sel = np.zeros_like(z, dtype=bool) sel[0, 1] = True sel[2, 3] = True print(z.get_mask_selection(sel)) ``` ```python exec="true" session="arrays" source="above" result="ansi" z.set_mask_selection(sel, [-1, -2]) print(z[:]) ``` For convenience, mask indexing is also available via the `vindex` property, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" print(z.vindex[sel]) ``` ```python exec="true" session="arrays" source="above" result="ansi" z.vindex[sel] = [-3, -4] print(z[:]) ``` Mask indexing is conceptually the same as coordinate indexing, and is implemented internally via the same machinery. Both styles of indexing allow selecting arbitrary items from an array, also known as point selection. ### Orthogonal indexing Zarr arrays also support methods for orthogonal indexing, which allows selections to be made along each dimension of an array independently. For example, this allows selecting a subset of rows and/or columns from a 2-dimensional array. E.g.: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(15).reshape(3, 5) z = zarr.create_array(store='data/example-14.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(z[:]) ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z.get_orthogonal_selection(([0, 2], slice(None)))) # select first and third rows ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z.get_orthogonal_selection((slice(None), [1, 3]))) # select second and fourth columns ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z.get_orthogonal_selection(([0, 2], [1, 3]))) # select rows [0, 2] and columns [1, 3] ``` Data can also be modified, e.g.: ```python exec="true" session="arrays" source="above" z.set_orthogonal_selection(([0, 2], [1, 3]), [[-1, -2], [-3, -4]]) ``` For convenience, the orthogonal indexing functionality is also available via the `oindex` property, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(15).reshape(3, 5) z = zarr.create_array(store='data/example-15.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(z.oindex[[0, 2], :]) # select first and third rows ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z.oindex[:, [1, 3]]) # select second and fourth columns ``` ```python exec="true" session="arrays" source="above" result="ansi" print(z.oindex[[0, 2], [1, 3]]) # select rows [0, 2] and columns [1, 3] ``` ```python exec="true" session="arrays" source="above" result="ansi" z.oindex[[0, 2], [1, 3]] = [[-1, -2], [-3, -4]] print(z[:]) ``` Any combination of integer, slice, 1D integer array and/or 1D Boolean array can be used for orthogonal indexing. If the index contains at most one iterable, and otherwise contains only slices and integers, orthogonal indexing is also available directly on the array: ```python exec="true" session="arrays" source="above" result="ansi" data = np.arange(15).reshape(3, 5) z = zarr.create_array(store='data/example-16.zarr', shape=data.shape, dtype=data.dtype) z[:] = data print(np.all(z.oindex[[0, 2], :] == z[[0, 2], :])) ``` ### Block indexing Zarr also supports block indexing, which allows selections of whole chunks based on their logical indices along each dimension of an array. For example, this allows selecting a subset of chunk aligned rows and/or columns from a 2-dimensional array. E.g.: ```python exec="true" session="arrays" source="above" data = np.arange(100).reshape(10, 10) z = zarr.create_array(store='data/example-17.zarr', shape=data.shape, dtype=data.dtype, chunks=(3, 3)) z[:] = data ``` Retrieve items by specifying their block coordinates: ```python exec="true" session="arrays" source="above" result="ansi" print(z.get_block_selection(1)) ``` Equivalent slicing: ```python exec="true" session="arrays" source="above" result="ansi" print(z[3:6]) ``` For convenience, the block selection functionality is also available via the `blocks` property, e.g.: ```python exec="true" session="arrays" source="above" result="ansi" print(z.blocks[1]) ``` Block index arrays may be multidimensional to index multidimensional arrays. For example: ```python exec="true" session="arrays" source="above" result="ansi" print(z.blocks[0, 1:3]) ``` Data can also be modified. Let's start by a simple 2D array: ```python exec="true" session="arrays" source="above" z = zarr.create_array(store='data/example-18.zarr', shape=(6, 6), dtype=int, chunks=(2, 2)) ``` Set data for a selection of items: ```python exec="true" session="arrays" source="above" result="ansi" z.set_block_selection((1, 0), 1) print(z[...]) ``` For convenience, this functionality is also available via the `blocks` property. E.g.: ```python exec="true" session="arrays" source="above" result="ansi" z.blocks[:, 2] = 7 print(z[...]) ``` Any combination of integer and slice can be used for block indexing: ```python exec="true" session="arrays" source="above" result="ansi" print(z.blocks[2, 1:3]) ``` ## Sharding Using small chunk shapes in very large arrays can lead to a very large number of chunks. This can become a performance issue for file systems and object storage. With Zarr format 3, a new sharding feature has been added to address this issue. With sharding, multiple chunks can be stored in a single storage object (e.g. a file). Within a shard, chunks are compressed and serialized separately. This allows individual chunks to be read independently. However, when writing data, a full shard must be written in one go for optimal performance and to avoid concurrency issues. That means that shards are the units of writing and chunks are the units of reading. Users need to configure the chunk and shard shapes accordingly. For guidance on choosing chunk and shard shapes, see [Sharding](performance.md#sharding) in the performance guide. Sharded arrays can be created by providing the `shards` parameter to [`zarr.create_array`][]. ```python exec="true" session="arrays" source="above" result="ansi" a = zarr.create_array('data/example-20.zarr', shape=(10000, 10000), shards=(1000, 1000), chunks=(100, 100), dtype='uint8') a[:] = (np.arange(10000 * 10000) % 256).astype('uint8').reshape(10000, 10000) print(a.info_complete()) ``` In this example a shard shape of (1000, 1000) and a chunk shape of (100, 100) is used. This means that `10*10` chunks are stored in each shard, and there are `10*10` shards in total. Without the `shards` argument, there would be 10,000 chunks stored as individual files. ## Rectilinear (variable) chunk grids !!! warning "Experimental" Rectilinear chunk grids are an experimental feature and may change in future releases. This feature is expected to stabilize in Zarr version 3.3. Because the feature is still stabilizing, it is disabled by default and must be explicitly enabled: ```python exec="true" session="arrays" source="above" import zarr zarr.config.set({"array.rectilinear_chunks": True}) ``` Or via the environment variable `ZARR_ARRAY__RECTILINEAR_CHUNKS=True`. The examples below assume this config has been set. By default, Zarr arrays use a regular chunk grid where every chunk along a given dimension has the same size (except possibly the final boundary chunk). Rectilinear chunk grids allow each chunk along a dimension to have a different size. This is useful when the natural partitioning of the data is not uniform — for example, satellite swaths of varying width, time series with irregular intervals, or spatial tiles of different extents. ### Creating arrays with rectilinear chunks To create an array with rectilinear chunks, pass a nested list to the `chunks` parameter where each inner list gives the chunk sizes along one dimension: ```python exec="true" session="arrays" source="above" result="ansi" z = zarr.create_array( store=zarr.storage.MemoryStore(), shape=(60, 100), chunks=[[10, 20, 30], [50, 50]], dtype='int32', ) print(z.info) ``` In this example the first dimension is split into three chunks of sizes 10, 20, and 30, while the second dimension is split into two equal chunks of size 50. ### Reading and writing data Rectilinear arrays support the same indexing interface as regular arrays. Reads and writes that cross chunk boundaries of different sizes are handled automatically: ```python exec="true" session="arrays" source="above" result="ansi" import numpy as np data = np.arange(60 * 100, dtype='int32').reshape(60, 100) z[:] = data # Read a slice that spans the first two chunks (sizes 10 and 20) along axis 0 print(z[5:25, 0:5]) ``` ### Inspecting chunk sizes The `.write_chunk_sizes` property returns the actual data size of each storage chunk along every dimension. It works for both regular and rectilinear arrays and returns a tuple of tuples (matching the dask `Array.chunks` convention). When sharding is used, `.read_chunk_sizes` returns the inner chunk sizes instead: ```python exec="true" session="arrays" source="above" result="ansi" print(z.write_chunk_sizes) ``` For regular arrays, this includes the boundary chunk: ```python exec="true" session="arrays" source="above" result="ansi" z_regular = zarr.create_array( store=zarr.storage.MemoryStore(), shape=(100, 80), chunks=(30, 40), dtype='int32', ) print(z_regular.write_chunk_sizes) ``` Note that the `.chunks` property is only available for regular chunk grids. For rectilinear arrays, use `.write_chunk_sizes` (or `.read_chunk_sizes`) instead. ### Resizing and appending Rectilinear arrays can be resized. When growing past the current edge sum, a new chunk is appended covering the additional extent. When shrinking, the chunk edges are preserved and the extent is re-bound (chunks beyond the new extent simply become inactive): ```python exec="true" session="arrays" source="above" result="ansi" z = zarr.create_array( store=zarr.storage.MemoryStore(), shape=(30,), chunks=[[10, 20]], dtype='float64', ) z[:] = np.arange(30, dtype='float64') print(f"Before resize: chunk_sizes={z.write_chunk_sizes}") z.resize((50,)) print(f"After resize: chunk_sizes={z.write_chunk_sizes}") ``` The `append` method also works with rectilinear arrays: ```python exec="true" session="arrays" source="above" result="ansi" z.append(np.arange(10, dtype='float64')) print(f"After append: shape={z.shape}, chunk_sizes={z.write_chunk_sizes}") ``` ### Compressors and filters Rectilinear arrays work with all codecs — compressors, filters, and checksums. Since each chunk may have a different size, the codec pipeline processes each chunk independently: ```python exec="true" session="arrays" source="above" result="ansi" z = zarr.create_array( store=zarr.storage.MemoryStore(), shape=(60, 100), chunks=[[10, 20, 30], [50, 50]], dtype='float64', filters=[zarr.codecs.TransposeCodec(order=(1, 0))], compressors=[zarr.codecs.BloscCodec(cname='zstd', clevel=3)], ) z[:] = np.arange(60 * 100, dtype='float64').reshape(60, 100) np.testing.assert_array_equal(z[:], np.arange(60 * 100, dtype='float64').reshape(60, 100)) print("Roundtrip OK") ``` ### Rectilinear shard boundaries Rectilinear chunk grids can also be used for shard boundaries when combined with sharding. In this case, the outer grid (shards) is rectilinear while the inner chunks remain regular. Each shard dimension must be divisible by the corresponding inner chunk size: ```python exec="true" session="arrays" source="above" result="ansi" z = zarr.create_array( store=zarr.storage.MemoryStore(), shape=(120, 100), chunks=(10, 10), shards=[[60, 40, 20], [50, 50]], dtype='int32', ) z[:] = np.arange(120 * 100, dtype='int32').reshape(120, 100) print(z[50:70, 40:60]) ``` Note that rectilinear inner chunks with sharding are not supported — only the shard boundaries can be rectilinear. ### Metadata format Rectilinear chunk grid metadata uses run-length encoding (RLE) for compact serialization. When reading metadata, both bare integers and `[value, count]` pairs are accepted: - `[10, 20, 30]` — three chunks with explicit sizes - `[[10, 3]]` — three chunks of size 10 (RLE shorthand) - `[[10, 3], 5]` — three chunks of size 10, then one chunk of size 5 When writing, Zarr automatically compresses repeated values into RLE format. ## Features not yet ported to Zarr-Python 3 The following Zarr-Python 2 features are not yet available in Zarr-Python 3. ### Copying and migrating data See the Zarr-Python 2 documentation on [Copying and migrating data](https://zarr.readthedocs.io/en/support-v2/tutorial.html#copying-migrating-data) for more details. zarr-python-3.3.0/docs/user-guide/attributes.md000066400000000000000000000040011523267620000215210ustar00rootroot00000000000000# Working with attributes Zarr arrays and groups support custom key/value attributes, which can be useful for storing application-specific metadata. For example: ```python exec="true" session="attributes" source="above" result="ansi" import zarr root = zarr.create_group(store="memory://attributes-demo") root.attrs['foo'] = 'bar' z = root.create_array(name='zzz', shape=(10000, 10000), dtype='int32') z.attrs['baz'] = 42 z.attrs['qux'] = [1, 4, 7, 12] print(sorted(root.attrs)) ``` ```python exec="true" session="attributes" source="above" result="ansi" print('foo' in root.attrs) ``` ```python exec="true" session="attributes" source="above" result="ansi" print(root.attrs['foo']) ``` ```python exec="true" session="attributes" source="above" result="ansi" print(sorted(z.attrs)) ``` ```python exec="true" session="attributes" source="above" result="ansi" print(z.attrs['baz']) ``` ```python exec="true" session="attributes" source="above" result="ansi" print(z.attrs['qux']) ``` Attributes can be deleted with the `del` operator: ```python exec="true" session="attributes" source="above" result="ansi" del z.attrs['baz'] print(sorted(z.attrs)) ``` Note that each attribute assignment or deletion writes the node's metadata document back to the store. To change several attributes in a single write, use [`zarr.Array.update_attributes`][] (or [`zarr.Group.update_attributes`][] for groups), which merges the given dict into the existing attributes and returns the updated array or group: ```python exec="true" session="attributes" source="above" result="ansi" z = z.update_attributes({'baz': 43, 'quux': True}) print(sorted(z.attrs)) ``` Internally Zarr uses JSON to store array and group attributes, so attribute values must be JSON serializable. When working with hierarchies that contain many arrays and groups, reading the attributes of each node separately can be slow. See [Consolidated metadata](consolidated_metadata.md) for a way to store the metadata (including attributes) of all nodes in a hierarchy in a single document. zarr-python-3.3.0/docs/user-guide/cli.md000066400000000000000000000065551523267620000201220ustar00rootroot00000000000000# Command-line interface Zarr-Python provides a command-line interface that enables: - migration of Zarr v2 metadata to v3 (see the [3.0 Migration Guide](v3_migration.md) for migrating your *code* from the Zarr-Python 2 API to the Zarr-Python 3 API) - removal of v2 or v3 metadata ## Installation The command-line interface requires the `cli` optional dependencies. Install them with: ```bash pip install "zarr[cli]" ``` Without this extra, running `zarr` in a terminal will fail with `ModuleNotFoundError`. ## Getting help To see available commands run the following in a terminal: ```bash zarr --help ``` or to get help on individual commands: ```bash zarr migrate --help zarr remove-metadata --help ``` ## Migrate metadata from v2 to v3 ### Migrate to a separate location To migrate a Zarr array/group's metadata from v2 to v3 run: ```bash zarr migrate v3 path/to/input.zarr path/to/output.zarr ``` This will write new `zarr.json` files to `output.zarr`, leaving `input.zarr` un-touched. Note - this will migrate the entire Zarr hierarchy, so if `input.zarr` contains multiple groups/arrays, new `zarr.json` will be made for all of them. ### Migrate in-place If you'd prefer to migrate the metadata in-place run: ```bash zarr migrate v3 path/to/input.zarr ``` This will write new `zarr.json` files to `input.zarr`, leaving the existing v2 metadata un-touched. To open the array/group using the new metadata use: ```python exec="true" session="cli-open" source="above" import zarr # create a small array to open (stands in for the migrated store) zarr.create_array("data/cli-demo.zarr", shape=(4, 4), chunks=(2, 2), dtype="i4", overwrite=True) zarr_with_v3_metadata = zarr.open("data/cli-demo.zarr", zarr_format=3) ``` Once you are happy with the conversion, you can run the following to remove the old v2 metadata: ```bash zarr remove-metadata v2 path/to/input.zarr ``` Note there is also a shortcut to migrate and remove v2 metadata in one step: ```bash zarr migrate v3 path/to/input.zarr --remove-v2-metadata ``` ## Remove metadata Remove v2 metadata using: ```bash zarr remove-metadata v2 path/to/input.zarr ``` or v3 with: ```bash zarr remove-metadata v3 path/to/input.zarr ``` By default, this will only allow removal of metadata if a valid alternative exists. For example, you can't remove v2 metadata unless v3 metadata exists at that location. To override this behavior use `--force`: ```bash zarr remove-metadata v3 path/to/input.zarr --force ``` ## Dry run All commands provide a `--dry-run` option that will log changes that would be made on a real run, without creating or modifying any files. ```bash zarr migrate v3 path/to/input.zarr --dry-run Dry run enabled - no new files will be created or changed. Log of files that would be created on a real run: Saving metadata to file://path/to/input.zarr/zarr.json ``` ## Verbose You can also add `--verbose` **before** any command, to see a full log of its actions: ```bash zarr --verbose migrate v3 path/to/input.zarr zarr --verbose remove-metadata v2 path/to/input.zarr ``` ## Equivalent functions All features of the command-line interface are also available as functions in the `zarr.metadata.migrate_v3` module: [`migrate_v2_to_v3`][zarr.metadata.migrate_v3.migrate_v2_to_v3] and [`remove_metadata`][zarr.metadata.migrate_v3.remove_metadata]. See the [`zarr.metadata` API reference](../api/zarr/metadata.md) for details. zarr-python-3.3.0/docs/user-guide/config.md000066400000000000000000000053071523267620000206120ustar00rootroot00000000000000# Runtime configuration [`zarr.config`][] is responsible for managing the configuration of zarr and is based on the [donfig](https://github.com/pytroll/donfig) Python library. Configuration values can be set using code like the following: ```python exec="true" session="config" source="above" result="ansi" import zarr zarr.config.set({'array.order': 'F'}) print(zarr.config.get('array.order')) ``` `zarr.config.set` can also be used as a context manager, which restores the previous configuration on exit, and `zarr.config.reset` restores the default configuration: ```python exec="true" session="config" source="above" result="ansi" zarr.config.reset() with zarr.config.set({'array.order': 'F'}): print(zarr.config.get('array.order')) print(zarr.config.get('array.order')) ``` Alternatively, configuration values can be set using environment variables, e.g. `ZARR_ARRAY__ORDER=F`. The configuration can also be read from a YAML file in standard locations. For more information, see the [donfig documentation](https://donfig.readthedocs.io/en/latest/). Configuration options include the following: - Default Zarr format `default_zarr_format` - Default array order in memory `array.order` - Whether empty chunks are written to storage `array.write_empty_chunks` - Enable experimental rectilinear chunks `array.rectilinear_chunks` - Whether missing chunks are filled with the array's fill value on read `array.read_missing_chunks` (default `True`). Set to `False` to raise a [`ChunkNotFoundError`][zarr.errors.ChunkNotFoundError] instead. - Async and threading options, e.g. `async.concurrency` and `threading.max_workers` - Selections of implementations of codecs, codec pipelines and buffers - Enabling GPU support with `zarr.config.enable_gpu()`. See [GPU support](gpu.md) for more. - Control request merging when reading multiple chunks from the same shard with `array.sharding_coalesce_max_gap_bytes` and `array.sharding_coalesce_max_bytes`. Reads of nearby chunks are coalesced into a single request to the store when separated by at most `sharding_coalesce_max_gap_bytes` and the resulting merged read is no larger than `sharding_coalesce_max_bytes`. For selecting custom implementations of codecs, pipelines, buffers and ndbuffers, first register the implementations in the registry and then select them in the config. For example, an implementation of the bytes codec in a class `'custompackage.NewBytesCodec'`, requires the value of `codecs.bytes` to be `'custompackage.NewBytesCodec'`. This is the current default configuration: ```python exec="true" session="config" source="above" result="ansi" from pprint import pprint import io output = io.StringIO() zarr.config.pprint(stream=output, width=60) print(output.getvalue()) ``` zarr-python-3.3.0/docs/user-guide/consolidated_metadata.md000066400000000000000000000140501523267620000236500ustar00rootroot00000000000000# Consolidated metadata !!! warning The Consolidated Metadata feature in Zarr-Python is considered experimental for v3 stores. [zarr-specs#309](https://github.com/zarr-developers/zarr-specs/pull/309) has proposed a formal extension to the v3 specification to support consolidated metadata. Zarr-Python implements the Consolidated Metadata feature for both the v2 and v3 formats. Consolidated metadata can reduce the time needed to load the metadata for an entire hierarchy, especially when the metadata is being served over a network. Consolidated metadata essentially stores all the metadata for a hierarchy in the metadata of the root Group. ## Usage If consolidated metadata is present in a Zarr Group's metadata then it is used by default. The initial read to open the group will need to communicate with the store (reading from a file for a [`zarr.storage.LocalStore`][], making a network request for a [`zarr.storage.FsspecStore`][]). After that, any subsequent metadata reads to get child Group or Array nodes will *not* require reads from the store. In Python, the consolidated metadata is available on the `.consolidated_metadata` attribute of the `GroupMetadata` object. ```python exec="true" session="consolidated_metadata" source="above" result="ansi" import zarr import warnings warnings.filterwarnings("ignore", category=UserWarning) group = zarr.create_group(store="memory://consolidated-metadata-demo") print(group) array = group.create_array(shape=(1,), name='a', dtype='float64') print(array) ``` ```python exec="true" session="consolidated_metadata" source="above" result="ansi" array = group.create_array(shape=(2, 2), name='b', dtype='float64') print(array) ``` ```python exec="true" session="consolidated_metadata" source="above" result="ansi" array = group.create_array(shape=(3, 3, 3), name='c', dtype='float64') print(array) ``` ```python exec="true" session="consolidated_metadata" source="above" result="ansi" result = zarr.consolidate_metadata("memory://consolidated-metadata-demo") print(result) ``` If we open that group, the Group's metadata includes a `ConsolidatedMetadata` object holding the metadata for every child node, which can be used: ```python exec="true" session="consolidated_metadata" source="above" result="ansi" from pprint import pprint import io consolidated = zarr.open_group(store="memory://consolidated-metadata-demo") consolidated_metadata = consolidated.metadata.consolidated_metadata.metadata output = io.StringIO() pprint(dict(sorted(consolidated_metadata.items())), stream=output, width=60) print(output.getvalue()) ``` Operations on the group to get children automatically use the consolidated metadata: ```python exec="true" session="consolidated_metadata" source="above" result="ansi" print(consolidated['a']) # no read / HTTP request to the Store is required ``` With nested groups, the consolidated metadata is available on the children, recursively: ```python exec="true" session="consolidated_metadata" source="above" result="ansi" child = group.create_group('child', attributes={'kind': 'child'}) grandchild = child.create_group('grandchild', attributes={'kind': 'grandchild'}) consolidated = zarr.consolidate_metadata("memory://consolidated-metadata-demo") output = io.StringIO() pprint(consolidated['child'].metadata.consolidated_metadata, stream=output, width=60) print(output.getvalue()) ``` !!! info "Added in version 3.1.1" The keys in the consolidated metadata are sorted prior to writing. Keys are sorted in ascending order by path depth, where a path is defined as a sequence of strings joined by `"/"`. For keys with the same path length, lexicographic order is used to break the tie. This behavior ensures deterministic metadata output for a given group. ### Controlling the use of consolidated metadata By default, [`zarr.open_group`][] uses consolidated metadata if it is present, and falls back to reading metadata from the store otherwise. This behavior can be controlled with the `use_consolidated` keyword. Pass `use_consolidated=False` to ignore consolidated metadata and always read the metadata of child nodes directly from the store: ```python exec="true" session="consolidated_metadata" source="above" result="ansi" group = zarr.open_group(store="memory://consolidated-metadata-demo", use_consolidated=False) print(group.metadata.consolidated_metadata) ``` Passing `use_consolidated=True` instead raises an error if consolidated metadata is not found, which is useful when reading over a network, where relying on many per-node metadata requests would be slow. ## Synchronization and Concurrency Consolidated metadata is intended for read-heavy use cases on slowly changing hierarchies. For hierarchies where new nodes are constantly being added, removed, or modified, consolidated metadata may not be desirable. 1. It will add some overhead to each update operation, since the metadata would need to be re-consolidated to keep it in sync with the store. 2. Readers using consolidated metadata will regularly see a "past" version of the metadata, at the time they read the root node with its consolidated metadata. Readers who need the latest view of a changing hierarchy can pass `use_consolidated=False` to [`zarr.open_group`][] to always read child metadata directly from the store. ## Stores Without Support for Consolidated Metadata Some stores may want to opt out of the consolidated metadata mechanism. This may be for several reasons like: * They want to maintain read-write consistency, which is challenging with consolidated metadata. * They have their own consolidated metadata mechanism. * They offer good enough performance without need for consolidation. This type of store can declare it doesn't want consolidation by implementing `Store.supports_consolidated_metadata` and returning `False`. For stores that don't support consolidation, Zarr will: * Raise an error on `consolidate_metadata` calls, maintaining the store in its unconsolidated state. * Raise an error in `AsyncGroup.open(..., use_consolidated=True)` * Not use consolidated metadata in `AsyncGroup.open(..., use_consolidated=None)` zarr-python-3.3.0/docs/user-guide/data_types.md000066400000000000000000000463631523267620000215110ustar00rootroot00000000000000# Array data types ## Zarr's data type model Zarr is designed for interoperability with NumPy, so if you are familiar with NumPy or any other N-dimensional array library, Zarr's model for array data types should seem familiar. However, Zarr data types have some unique features that are described in this document. Zarr arrays operate under an essential design constraint: unlike NumPy arrays, Zarr arrays are designed to be stored and accessed by other Zarr implementations. This means that, among other things, Zarr data types must be serializable to metadata documents in accordance with the Zarr specifications, which adds some unique aspects to the Zarr data type model. The following sections explain Zarr's data type model in greater detail and demonstrate the Zarr Python APIs for working with Zarr data types. ### Array data types Every Zarr array has a data type, which defines the meaning of the array's elements. An array's data type is encoded in the JSON metadata for the array. This means that the data type of an array must be JSON-serializable. In Zarr V2, the data type of an array is stored in the `dtype` field in array metadata. Zarr V3 changed the name of this field to `data_type` and also defined new rules for the values that can be assigned to the `data_type` field. For example, in Zarr V2, the boolean array data type was represented in array metadata as the string `"|b1"`. In Zarr V3, the same type is represented as the string `"bool"`. ### Scalars Zarr also specifies how array elements, i.e., scalars, are encoded in array metadata. This is necessary because Zarr uses a field in array metadata to define a default value for chunks that are not stored. This field, called `fill_value` in both Zarr V2 and Zarr V3 metadata documents, contains a JSON value that can be decoded to a scalar value compatible with the array's data type. For the boolean data type, the scalar encoding is simple—booleans are natively supported by JSON, so Zarr saves booleans as JSON booleans. Other scalars, like floats or raw bytes, have more elaborate encoding schemes, and in some cases, this scheme depends on the Zarr format version. ## Data types in Zarr version 2 Version 2 of the Zarr format defined its data types relative to [NumPy's data types](https://numpy.org/doc/stable/reference/arrays.dtypes.html#data-type-objects-dtype), and added a few non-NumPy data types as well. With one exception ([structured data types](#structured-data-type)), the Zarr V2 JSON identifier for a data type is just the NumPy `str` attribute of that data type: ```python exec="true" session="data_types" source="above" result="ansi" import zarr import numpy as np import json store = {} np_dtype = np.dtype('int64') print(np_dtype.str) ``` ```python exec="true" session="data_types" source="above" result="ansi" z = zarr.create_array(store=store, shape=(1,), dtype=np_dtype, zarr_format=2) dtype_meta = json.loads(store['.zarray'].to_bytes())["dtype"] print(dtype_meta) ``` !!! note The `<` character in the data type metadata encodes the [endianness](https://numpy.org/doc/stable/reference/generated/numpy.dtype.byteorder.html), or "byte order," of the data type. As per the NumPy model, in Zarr version 2 each data type has an endianness where applicable. However, Zarr version 3 data types do not store endianness information. There are two special cases to consider: ["structured" data types](#structured-data-type), and ["object"](#object-data-type) data types. ### Structured data type NumPy allows the construction of a so-called "structured" data types comprised of ordered collections of named fields, where each field is itself a distinct NumPy data type. See the NumPy documentation [here](https://numpy.org/doc/stable/user/basics.rec.html). Crucially, NumPy does not use a special data type for structured data types—instead, NumPy implements structured data types as an optional feature of the so-called "Void" data type, which models arbitrary fixed-size byte strings. The `str` attribute of a regular NumPy void data type is the same as the `str` of a NumPy structured data type. This means that the `str` attribute does not convey information about the fields contained in a structured data type. For these reasons, Zarr V2 uses a special data type encoding for structured data types. They are stored in JSON as lists of pairs, where the first element is a string, and the second element is a Zarr V2 data type specification. This representation supports recursion. For example: ```python exec="true" session="data_types" source="above" result="ansi" store = {} np_dtype = np.dtype([('field_a', '>i2'), ('field_b', [('subfield_c', '>f4'), ('subfield_d', 'i2')])]) print(np_dtype.str) ``` ```python exec="true" session="data_types" source="above" result="ansi" z = zarr.create_array(store=store, shape=(1,), dtype=np_dtype, zarr_format=2) dtype_meta = json.loads(store['.zarray'].to_bytes())["dtype"] print(dtype_meta) ``` ### Object data type The NumPy "object" type is essentially an array of references to arbitrary Python objects. It can model arrays of variable-length UTF-8 strings, arrays of variable-length byte strings, or even arrays of variable-length arrays, each with a distinct data type. This makes the "object" data type expressive, but also complicated to store. Zarr Python cannot persistently store references to arbitrary Python objects. But if each of those Python objects has a consistent type, then we can use a special encoding procedure to store the array. This is how Zarr Python stores variable-length UTF-8 strings, or variable-length byte strings. Although these are separate data types in this library, they are both "object" arrays in NumPy, which means they have the *same* Zarr V2 string representation: `"|O"`. So for Zarr V2 we have to disambiguate different "object" data type arrays on the basis of their encoding procedure, i.e., the codecs declared in the `filters` and `compressor` attributes of array metadata. If an array with data type "object" used the `"vlen-utf8"` codec, then it was interpreted as an array of variable-length strings. If an array with data type "object" used the `"vlen-bytes"` codec, then it was interpreted as an array of variable-length byte strings. This all means that the `dtype` field alone does not fully specify a data type in Zarr V2. The name of the object codec used, if one was used, is also required. Although this fact can be ignored for many simple numeric data types, any comprehensive approach to Zarr V2 data types must either reject the "object" data types or include the "object codec" identifier in the JSON form of the basic data type model. ## Data types in Zarr version 3 The NumPy-based Zarr V2 data type representation was effective for simple data types but struggled with more complex data types, like "object" and "structured" data types. To address these limitations, Zarr V3 introduced several key changes to how data types are represented: - Instead of copying NumPy character codecs, Zarr V3 defines an identifier for each data type. The basic data types are identified by strings like `"int8"`, `"int16"`, etc., and data types that require a configuration can be identified by a JSON object. For example, this JSON object declares a datetime data type: ```json { "name": "numpy.datetime64", "configuration": { "unit": "s", "scale_factor": 10 } } ``` - Zarr V3 data types do not have endianness. This is a departure from Zarr V2, where multi-byte data types are defined with endianness information. Instead, Zarr V3 requires that the endianness of encoded array chunks is specified in the `codecs` attribute of array metadata. The Zarr V3 specification leaves the in-memory endianness of decoded array chunks as an implementation detail. For more about data types in Zarr V3, see the [V3 specification](https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html). ## Data types in Zarr Python The two Zarr formats that Zarr Python supports specify data types in different ways: data types in Zarr version 2 are encoded as NumPy-compatible strings (or lists, in the case of structured data types), while data types in Zarr V3 are encoded as either strings or JSON objects. Zarr V3 data types do not have any associated endianness information, unlike Zarr V2 data types. Zarr Python needs to support both Zarr V2 and V3, which means we need to abstract over these differences. We do this with an abstract Zarr data type class: [ZDType][zarr.dtype.ZDType] which provides Zarr V2 and Zarr V3 compatibility routines for "native" data types. In this context, a "native" data type is a Python class, typically defined in another library, that models an array's data type. For example, [`numpy.dtypes.UInt8DType`][] is a native data type defined in NumPy. Zarr Python wraps the NumPy `uint8` with a [ZDType][zarr.dtype.ZDType] instance called [UInt8][zarr.dtype.UInt8]. As of this writing, the only native data types Zarr Python supports are NumPy data types. We could avoid the "native data type" jargon and just say "NumPy data type," but we do not want to rule out the possibility of using non-NumPy array backends in the future. Each data type supported by Zarr Python is modeled by a [ZDType][zarr.dtype.ZDType] subclass, which provides an API for the following operations: - Encoding and decoding a native data type - Encoding and decoding a data type to and from Zarr V2 and Zarr V3 array metadata - Encoding and decoding a scalar value to and from Zarr V2 and Zarr V3 array metadata - Casting a Python object to a scalar value consistent with the data type ### List of data types The following section lists the data types built in to Zarr Python. With a few exceptions, Zarr Python supports nearly all of the data types in NumPy. If you need a data type that is not listed here, it's possible to create it yourself: see [Adding new data types](#adding-new-data-types). #### Boolean - [Boolean][zarr.dtype.Bool] #### Integral - [Signed 8-bit integer][zarr.dtype.Int8] - [Signed 16-bit integer][zarr.dtype.Int16] - [Signed 32-bit integer][zarr.dtype.Int32] - [Signed 64-bit integer][zarr.dtype.Int64] - [Unsigned 8-bit integer][zarr.dtype.UInt8] - [Unsigned 16-bit integer][zarr.dtype.UInt16] - [Unsigned 32-bit integer][zarr.dtype.UInt32] - [Unsigned 64-bit integer][zarr.dtype.UInt64] #### Floating-point - [16-bit floating-point][zarr.dtype.Float16] - [32-bit floating-point][zarr.dtype.Float32] - [64-bit floating-point][zarr.dtype.Float64] - [64-bit complex floating-point][zarr.dtype.Complex64] - [128-bit complex floating-point][zarr.dtype.Complex128] #### String - [Fixed-length UTF-32 string][zarr.dtype.FixedLengthUTF32] - [Variable-length UTF-8 string][zarr.dtype.VariableLengthUTF8] #### Bytes - [Fixed-length null-terminated bytes][zarr.dtype.NullTerminatedBytes] - [Fixed-length raw bytes][zarr.dtype.RawBytes] - [Variable-length bytes][zarr.dtype.VariableLengthBytes] #### Temporal - [DateTime64][zarr.dtype.DateTime64] - [TimeDelta64][zarr.dtype.TimeDelta64] #### Struct-like - [Structured][zarr.dtype.Structured] !!! note "Zarr V3 Structured Data Types" In Zarr V3, structured data types are specified using the `struct` extension defined in the [zarr-extensions repository](https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/struct). The JSON representation uses an object format for fields: ```json { "name": "struct", "configuration": { "fields": [ {"name": "x", "data_type": "float32"}, {"name": "y", "data_type": "int64"} ] } } ``` For backward compatibility, Zarr Python also accepts the legacy `structured` name with tuple-format fields when reading existing data. Fill values for structured types are represented as JSON objects mapping field names to values: ```json {"x": 1.5, "y": 42} ``` When using structured types with multi-byte fields, the `bytes` codec must specify an explicit `endian` parameter. If omitted, Zarr Python assumes little-endian for legacy compatibility but emits a warning. ### Example usage This section will demonstrate the basic usage of Zarr data types. Create a `ZDType` from a native data type: ```python exec="true" session="data_types" source="above" from zarr.dtype import Int8 import numpy as np int8 = Int8.from_native_dtype(np.dtype('int8')) ``` Convert back to a native data type: ```python exec="true" session="data_types" source="above" native_dtype = int8.to_native_dtype() assert native_dtype == np.dtype('int8') ``` Get the default scalar value for the data type: ```python exec="true" session="data_types" source="above" default_value = int8.default_scalar() assert default_value == np.int8(0) ``` Serialize to JSON for Zarr V2: ```python exec="true" session="data_types" source="above" result="ansi" json_v2 = int8.to_json(zarr_format=2) print(json_v2) ``` !!! note The representation returned by `to_json(zarr_format=2)` is more abstract than the literal contents of Zarr V2 array metadata, because the JSON representation used by the `ZDType` classes must be distinct across different data types. As noted [earlier](#object-data-type), Zarr V2 identifies multiple distinct data types with the "object" data type identifier `"|O"`. Extra information is needed to disambiguate these data types from one another. That's the reason for the `object_codec_id` field you see here. And for V3: ```python exec="true" session="data_types" source="above" result="ansi" json_v3 = int8.to_json(zarr_format=3) print(json_v3) ``` Serialize a scalar value to JSON: ```python exec="true" session="data_types" source="above" result="ansi" json_value = int8.to_json_scalar(42, zarr_format=3) print(json_value) ``` Deserialize a scalar value from JSON: ```python exec="true" session="data_types" source="above" scalar_value = int8.from_json_scalar(42, zarr_format=3) assert scalar_value == np.int8(42) ``` ### Adding new data types Each Zarr data type is a separate Python class that inherits from [ZDType][zarr.dtype.ZDType]. You can define a custom data type by writing your own subclass of [ZDType][zarr.dtype.ZDType] and adding your data type to the data type registry. To see an executable demonstration of this process, see the [`custom_dtype` example](../user-guide/examples/custom_dtype.md). ### Data type resolution Although Zarr Python uses a different data type model from NumPy, you can still define a Zarr array with a NumPy data type object: ```python exec="true" session="data_types" source="above" result="ansi" from zarr import create_array import numpy as np a = create_array({}, shape=(10,), dtype=np.dtype('int')) print(a) ``` Or a string representation of a NumPy data type: ```python exec="true" session="data_types" source="above" result="ansi" a = create_array({}, shape=(10,), dtype=' ``` This example illustrates a general problem Zarr Python has to solve: how can we allow users to specify a data type as a string or a NumPy `dtype` object, and produce the right Zarr data type from that input? We call this process "data type resolution." Zarr Python also performs data type resolution when reading stored arrays, although in this case the input is a JSON value instead of a NumPy data type. For simple data types like `int`, the solution could be extremely simple: just maintain a lookup table that maps a NumPy data type to the Zarr data type equivalent. But not all data types are so simple. Consider this case: ```python exec="true" session="data_types" source="above" result="ansi" from zarr import create_array import numpy as np a = create_array({}, shape=(10,), dtype=[('a', 'f8'), ('b', 'i8')]) print(a.dtype) # this is the NumPy data type ``` ```python exec="true" session="data_types" source="above" result="ansi" print(a.metadata.data_type) # this is the Zarr data type ``` In this example, we created a [NumPy structured data type](https://numpy.org/doc/stable/user/basics.rec.html#structured-datatypes). This data type is a container that can hold any NumPy data type, which makes it recursive. It is not possible to make a lookup table that relates all NumPy structured data types to their Zarr equivalents, as there is a nearly unbounded number of different structured data types. So instead of a static lookup table, Zarr Python relies on a dynamic approach to data type resolution. Zarr Python defines a collection of Zarr data types. This collection, called a "data type registry," is essentially a dictionary where the keys are strings (a canonical name for each data type), and the values are the data type classes themselves. Dynamic data type resolution entails iterating over these data type classes, invoking that class' [from_native_dtype][zarr.dtype.ZDType.from_native_dtype] method, and returning a concrete data type instance if and only if exactly one of those constructor invocations is successful. In plain language, we take some user input, like a NumPy data type, offer it to all the known data type classes, and return an instance of the one data type class that can accept that user input. We want to avoid a situation where the same native data type matches multiple Zarr data types; that is, a NumPy data type should *uniquely* specify a single Zarr data type. But data type resolution is dynamic, so it's not possible to statically guarantee this uniqueness constraint. Therefore, we attempt data type resolution against *every* data type class, and if, for some reason, a native data type matches multiple Zarr data types, we treat this as an error and raise an exception. If you have a NumPy data type and you want to get the corresponding `ZDType` instance, you can use the `parse_dtype` function, which will use the dynamic resolution described above. `parse_dtype` handles a range of input types: - NumPy data types: ```python exec="true" session="data_types" source="above" result="ansi" import numpy as np from zarr.dtype import parse_dtype my_dtype = np.dtype('>M8[10s]') print(parse_dtype(my_dtype, zarr_format=2)) ``` - NumPy data type-compatible strings: ```python exec="true" session="data_types" source="above" result="ansi" dtype_str = '>M8[10s]' print(parse_dtype(dtype_str, zarr_format=2)) ``` - `ZDType` instances: ```python exec="true" session="data_types" source="above" result="ansi" from zarr.dtype import DateTime64 zdt = DateTime64(endianness='big', scale_factor=10, unit='s') print(parse_dtype(zdt, zarr_format=2)) # Use a ZDType (this is a no-op) ``` - Python dictionaries (requires `zarr_format=3`). These dictionaries must be consistent with the `JSON` form of the data type: ```python exec="true" session="data_types" source="above" result="ansi" dt_dict = {"name": "numpy.datetime64", "configuration": {"unit": "s", "scale_factor": 10}} print(parse_dtype(dt_dict, zarr_format=3)) ``` ```python exec="true" session="data_types" source="above" result="ansi" print(parse_dtype(dt_dict, zarr_format=3).to_json(zarr_format=3)) ``` zarr-python-3.3.0/docs/user-guide/examples/000077500000000000000000000000001523267620000206345ustar00rootroot00000000000000zarr-python-3.3.0/docs/user-guide/examples/codec_pipeline_performance.md000066400000000000000000000003551523267620000265040ustar00rootroot00000000000000--8<-- "examples/codec_pipeline_performance/README.md" ## Source Code ```python exec="false" reason="pymdownx snippet include directive, not python source" --8<-- "examples/codec_pipeline_performance/codec_pipeline_performance.py" ``` zarr-python-3.3.0/docs/user-guide/examples/custom_dtype.md000066400000000000000000000003031523267620000236710ustar00rootroot00000000000000--8<-- "examples/custom_dtype/README.md" ## Source Code ```python exec="false" reason="pymdownx snippet include directive, not python source" --8<-- "examples/custom_dtype/custom_dtype.py" ``` zarr-python-3.3.0/docs/user-guide/examples/rectilinear_chunks.md000066400000000000000000000175731523267620000250470ustar00rootroot00000000000000# Rectilinear Chunk Grids This example demonstrates rectilinear (variable-sized) chunk grids, introduced in [#3802](https://github.com/zarr-developers/zarr-python/pull/3802). Rectilinear grids allow different chunk sizes along each dimension, which is useful for data that doesn't partition evenly — for example, sparse HEALPix cells grouped by parent tile, boundary-padded HPC arrays, or ingesting existing variable-chunked datasets via VirtualiZarr. See [Rectilinear (variable) chunk grids](../arrays.md#rectilinear-variable-chunk-grids) in the arrays guide for an introduction to the feature. The example chunks a HEALPix dataset by parent tile, writes it as a Zarr v3 array with a rectilinear chunk grid, and verifies the round trip through [Xarray](https://xarray.dev). !!! warning "Experimental" Rectilinear chunk grids are an experimental feature and may change in future releases. In addition, this example currently requires [a fork of Xarray](https://github.com/maxrjones/xarray/tree/poc/unified-zarr-chunk-grid) with rectilinear chunk grid support (this will ideally be incorporated into a future Xarray release), as well as the `dask`, `healpix-geo`, and `obstore` packages, and it reads an example dataset from a remote server. For these reasons the code on this page is not executed when the documentation is built; the outputs shown were captured from a live run. ## Setup Rectilinear chunk grids are disabled by default and must be explicitly enabled via the `array.rectilinear_chunks` configuration option: ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" import json import tempfile from pathlib import Path import numpy as np import xarray as xr from healpix_geo import nested from obstore.store import HTTPStore import zarr from zarr.storage import ObjectStore # Increase concurrency for better performance with obstore zarr.config.set({'async.concurrency': 128}) # Opt in to rectilinear chunks zarr.config.set({'array.rectilinear_chunks': True}) ``` ## Inspect the HEALPix dataset Load the remote Zarr store to understand the data structure before chunking it: ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" ob_store = HTTPStore.from_url("https://data-taos.ifremer.fr/GRID4EARTH/no_chunk_healpix.zarr") store = ObjectStore(ob_store) g = zarr.open_group(store, mode="r", zarr_format=2, use_consolidated=True) arr = g['da'] print("Members:", list(g.members())) print("Attrs:", dict(g.attrs)) print("Write chunk sizes:", arr.write_chunk_sizes) ``` ```text Members: [('cell_ids', ), ('da', )] Attrs: {} Write chunk sizes: ((55611, 55611, 55611, 55609),) ``` ## HEALPix-style variable chunking Inspired by [this use case](https://github.com/zarr-developers/zarr-python/pull/3534#issuecomment-3848669859): HEALPix grids where cells are grouped by parent tile at a coarser resolution level, producing variable-sized chunks along the cell dimension when accounting for sparsity. ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" da = xr.open_zarr( store, zarr_format=2, consolidated=True, ) depth = da.cell_ids.attrs['level'] new_depth = depth - 6 parents = nested.zoom_to(da.cell_ids, depth=depth, new_depth=new_depth) _, chunk_sizes = np.unique(parents, return_counts=True) print(chunk_sizes) ``` ```text [ 25 645 1510 2363 3203 74 769 3963 4096 233 1603 2450 4096 4096 3327 4047 4096 4096 1278 2113 4096 3879 4096 3842 2173 983 4046 2187 4095 1369 4096 4096 4096 4096 3515 1395 4096 3622 4096 4096 3875 4096 4096 4096 4096 4096 2034 4096 358 3991 4096 4096 4096 4096 2714 1210 4096 4096 4096 4096 92 3826 4096 2629 4096 1438 4096 353 4078 3410 2407 226 132 2738 1223 23] ``` Rechunk the dataset with these variable-sized chunks: ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" da = da.chunk({"cell_ids": tuple(chunk_sizes.tolist())}) print(da.chunks) ``` ```text Frozen({'cell_ids': (25, 645, 1510, 2363, 3203, 74, 769, 3963, 4096, 233, 1603, 2450, 4096, 4096, 3327, 4047, 4096, 4096, 1278, 2113, 4096, 3879, 4096, 3842, 2173, 983, 4046, 2187, 4095, 1369, 4096, 4096, 4096, 4096, 3515, 1395, 4096, 3622, 4096, 4096, 3875, 4096, 4096, 4096, 4096, 4096, 2034, 4096, 358, 3991, 4096, 4096, 4096, 4096, 2714, 1210, 4096, 4096, 4096, 4096, 92, 3826, 4096, 2629, 4096, 1438, 4096, 353, 4078, 3410, 2407, 226, 132, 2738, 1223, 23)}) ``` ## Write as rectilinear Zarr v3 Write the variable-chunked dataset to a local Zarr v3 store with rectilinear chunk grids enabled: ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" output_path = Path(tempfile.mkdtemp()) / "healpix_rectilinear.zarr" encoding = { "da": {"chunks": [chunk_sizes.tolist()]}, "cell_ids": {"chunks": [chunk_sizes.tolist()]}, } da.to_zarr(output_path, zarr_format=3, mode="w", encoding=encoding, consolidated=False) print(f"Written to: {output_path}") ``` ```text Written to: /var/folders/.../T/tmp6dibcrho/healpix_rectilinear.zarr ``` ## Verify the rectilinear metadata Inspect the output store to confirm the chunk grid is serialized as `"rectilinear"` in `zarr.json`, following the [rectilinear chunk grid extension spec](https://github.com/zarr-developers/zarr-extensions/tree/main/chunk-grids/rectilinear). Key things to look for in `chunk_grid`: - **`name`**: `"rectilinear"` (the extension identifier) - **`configuration.kind`**: `"inline"` (edge lengths stored directly in metadata) - **`configuration.chunk_shapes`**: one entry per dimension — here a single list for the 1D `cell_ids` axis. Each element is either: - a **bare integer** for a unique edge length (e.g., `25`, `645`) - a **`[value, count]` array** using [run-length encoding](https://github.com/zarr-developers/zarr-extensions/tree/main/chunk-grids/rectilinear#run-length-encoding) for consecutive repeated sizes (e.g., `[4096, 4]` means four consecutive chunks of size 4096) ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" # Read the zarr.json for the 'da' array da_meta_path = output_path / "da" / "zarr.json" meta = json.loads(da_meta_path.read_text()) print(meta['chunk_grid']) ``` ```text {'name': 'rectilinear', 'configuration': {'kind': 'inline', 'chunk_shapes': [[25, 645, 1510, 2363, 3203, 74, 769, 3963, 4096, 233, 1603, 2450, [4096, 2], 3327, 4047, [4096, 2], 1278, 2113, 4096, 3879, 4096, 3842, 2173, 983, 4046, 2187, 4095, 1369, [4096, 4], 3515, 1395, 4096, 3622, [4096, 2], 3875, [4096, 5], 2034, 4096, 358, 3991, [4096, 4], 2714, 1210, [4096, 4], 92, 3826, 4096, 2629, 4096, 1438, 4096, 353, 4078, 3410, 2407, 226, 132, 2738, 1223, 23]]}} ``` ## Round-trip verification Read the rectilinear store back and confirm the chunk sizes are preserved: ```python exec="false" reason="requires an xarray fork with rectilinear chunk grid support and remote example data" roundtrip = xr.open_zarr(output_path, zarr_format=3, consolidated=False) print("Round-trip chunk sizes:", roundtrip.chunks) ``` ```text Round-trip chunk sizes: Frozen({'cell_ids': (25, 645, 1510, 2363, 3203, 74, 769, 3963, 4096, 233, 1603, 2450, 4096, 4096, 3327, 4047, 4096, 4096, 1278, 2113, 4096, 3879, 4096, 3842, 2173, 983, 4046, 2187, 4095, 1369, 4096, 4096, 4096, 4096, 3515, 1395, 4096, 3622, 4096, 4096, 3875, 4096, 4096, 4096, 4096, 4096, 2034, 4096, 358, 3991, 4096, 4096, 4096, 4096, 2714, 1210, 4096, 4096, 4096, 4096, 92, 3826, 4096, 2629, 4096, 1438, 4096, 353, 4078, 3410, 2407, 226, 132, 2738, 1223, 23)}) ``` zarr-python-3.3.0/docs/user-guide/examples/sharding_coalescing.md000066400000000000000000000003301523267620000251400ustar00rootroot00000000000000--8<-- "examples/sharding_coalescing/README.md" ## Source Code ```python exec="false" reason="pymdownx snippet include directive, not python source" --8<-- "examples/sharding_coalescing/sharding_coalescing.py" ``` zarr-python-3.3.0/docs/user-guide/experimental.md000066400000000000000000000321171523267620000220410ustar00rootroot00000000000000# Experimental features This section contains documentation for experimental Zarr Python features. The features described here are exciting and potentially useful, but also volatile -- we might change them at any time. Take this into account if you consider depending on these features. See the [experimental API policy](../contributing.md#experimental-api-policy) for the stability guarantees (or lack thereof) that apply to everything documented on this page. ## `FusedCodecPipeline` A *codec pipeline* is the machinery that turns chunks of array data into stored bytes and back, by running the configured codecs (filters, serializer, compressors) and performing the storage IO. The default pipeline, `BatchedCodecPipeline`, schedules both the IO and codec work asynchronously -- roughly one coroutine per chunk operation. `FusedCodecPipeline` is an experimental alternative that runs codec compute and synchronous IO *synchronously*, avoiding that per-chunk async scheduling overhead and nasty [`asyncio.to_thread` overhead](https://github.com/python/cpython/issues/136084). On real workloads the scheduling cost can dominate the actual codec work, so removing it is a significant speedup -- especially for **sharded arrays**, where a single shard read or write involves many inner chunks. > **Note:** The win is *not* a faster compressor or a different on-disk format -- the bytes written are > identical. It is purely the removal of async scheduling overhead, plus a few vectorized fast paths > for dense, uncompressed shards i.e., removing compute where it is not needed. ### When it helps There are two main benefits in this new pipeline: 1. When storage IO is fast enough that the *scheduling* overhead, not the IO itself, is the bottleneck. That means **low-latency stores** that are themselves synchronous -- in particular [`zarr.storage.MemoryStore`][] and [`zarr.storage.LocalStore`][]. 2. Whenever codec work that is truly synchronous will not need the overhead of `async` scheduling i.e., inner-chunk codec work in sharding using something like `zstd`. We also now make use of `asyncio.as_completed` so that IO from asynchronous sources can begin decompression immediately. ### Opting in `FusedCodecPipeline` is opt-in: the default pipeline is unchanged, so existing code behaves exactly as before. Select it through the [runtime configuration](config.md), by setting `codec_pipeline.path`: ```python exec="true" session="experimental-fused" source="above" result="ansi" import zarr zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} ) ``` You can set this globally as above (affecting every array created or opened afterwards), or scope it to a block of code using `zarr.config.set` as a context manager: ```python exec="true" session="experimental-fused" source="above" import numpy as np import zarr from zarr.storage import MemoryStore with zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} ): # A sharded array on an in-memory store -- the low-latency case the # synchronous pipeline targets. arr = zarr.create_array( store=MemoryStore(), shape=(1000, 1000), chunks=(100, 100), shards=(1000, 1000), dtype="float32", ) arr[:] = np.random.random((1000, 1000)).astype("float32") result = arr[:] print(result.shape) ``` To return to the default pipeline, set `codec_pipeline.path` back to the batched implementation: ```python exec="true" session="experimental-fused" source="above" import zarr zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.BatchedCodecPipeline"} ) ``` ### Threading By default the synchronous pipeline runs fully threaded i.e., `os.cpu_count()`. For memory-backed workflows, you may find that setting `max_workers` to 1 helps (since requests for data from the store are GIL-locked, unlike, say, file-backed i/o). ```python exec="true" session="experimental-fused" source="above" import zarr # Use a fixed-size thread pool for codec compute. zarr.config.set({"codec_pipeline.max_workers": 8}) # Or "auto", sized to the number of CPUs. zarr.config.set({"codec_pipeline.max_workers": None}) ``` On many-core nodes a pool sized to `cpu_count` can oversubscribe workloads that already parallelize at a higher level (e.g. Dask). `codec_pipeline.max_workers` only affects `FusedCodecPipeline`; the default `BatchedCodecPipeline` ignores it. ## `CacheStore` Zarr Python 3.1.4 adds [`zarr.experimental.cache_store.CacheStore`][], which provides a dual-store caching implementation that can be wrapped around any Zarr store to improve performance for repeated data access. This is particularly useful when working with remote stores (e.g., S3, HTTP) where network latency can significantly impact data access speed. The CacheStore implements a cache that uses a separate Store instance as the cache backend, providing persistent caching capabilities with time-based expiration, size-based eviction, and flexible cache storage options. It automatically evicts the least recently used items when the cache reaches its maximum size. Because the `CacheStore` uses an ordinary Zarr `Store` object as the caching layer, you can reuse the data stored in the cache later. !!! note The CacheStore is a wrapper store that maintains compatibility with the full `zarr.abc.store.Store` API while adding transparent caching functionality. ### Basic Usage Creating a CacheStore requires both a source store and a cache store. The cache store can be any Store implementation, providing flexibility in cache persistence: ```python exec="true" session="experimental" source="above" import zarr from zarr.storage import LocalStore import numpy as np from tempfile import mkdtemp from zarr.experimental.cache_store import CacheStore # Create a local store and a separate cache store local_store_path = mkdtemp(suffix='.zarr') source_store = LocalStore(local_store_path) cache_store = zarr.storage.MemoryStore() # In-memory cache cached_store = CacheStore( store=source_store, cache_store=cache_store, max_size=256*1024*1024 # 256MB cache ) # Create an array using the cached store zarr_array = zarr.zeros((100, 100), chunks=(10, 10), dtype='f8', store=cached_store, mode='w') # Write some data to force chunk creation zarr_array[:] = np.random.random((100, 100)) ``` The dual-store architecture allows you to use different store types for source and cache, such as a remote store for source data and a local store for persistent caching. ### Performance Benefits The CacheStore provides significant performance improvements for repeated data access: ```python exec="true" session="experimental" source="above" import time # Benchmark reading with cache start = time.time() for _ in range(100): _ = zarr_array[:] elapsed_cache = time.time() - start # Compare with direct store access (without cache) zarr_array_nocache = zarr.open(local_store_path, mode='r') start = time.time() for _ in range(100): _ = zarr_array_nocache[:] elapsed_nocache = time.time() - start # Cache provides speedup for repeated access speedup = elapsed_nocache / elapsed_cache print(f"Speedup is {speedup}") ``` Cache effectiveness is particularly pronounced with repeated access to the same data chunks. ### Cache Configuration The CacheStore can be configured with several parameters: **max_size**: Controls the maximum size of cached data in bytes. The [Basic Usage](#basic-usage) example above sets a 256MB limit with `max_size=256*1024*1024`: ```python exec="true" session="experimental" source="above" # Unlimited cache size (use with caution) cache = CacheStore( store=source_store, cache_store=cache_store, max_size=None ) ``` **max_age_seconds**: Controls time-based cache expiration ```python exec="true" session="experimental" source="above" # Cache expires after 1 hour cache = CacheStore( store=source_store, cache_store=cache_store, max_age_seconds=3600 ) # Cache never expires cache = CacheStore( store=source_store, cache_store=cache_store, max_age_seconds="infinity" ) ``` **cache_set_data**: Controls whether written data is cached ```python exec="true" session="experimental" source="above" # Cache data when writing (default) cache = CacheStore( store=source_store, cache_store=cache_store, cache_set_data=True ) # Don't cache written data (read-only cache) cache = CacheStore( store=source_store, cache_store=cache_store, cache_set_data=False ) ``` ### Cache Statistics The CacheStore provides statistics to monitor cache performance and state: ```python exec="true" session="experimental" source="above" # Access some data to generate cache activity # (these chunks were already cached by the reads above, so both accesses are cache hits) data = zarr_array[0:50, 0:50] data = zarr_array[0:50, 0:50] # Get comprehensive cache information info = cached_store.cache_info() print(info['cache_store_type']) # e.g., 'MemoryStore' print(info['max_age_seconds']) print(info['max_size']) print(info['current_size']) print(info['tracked_keys']) print(info['cached_keys']) print(info['cache_set_data']) ``` The `cache_info()` method returns a dictionary with detailed information about the cache state. ### Cache Management The CacheStore provides methods for manual cache management: ```python exec="true" session="experimental" source="above" # Clear all cached data and tracking information import asyncio asyncio.run(cached_store.clear_cache()) # Check cache info after clearing info = cached_store.cache_info() assert info['tracked_keys'] == 0 assert info['current_size'] == 0 ``` The `clear_cache()` method is an async method that clears both the cache store (if it supports the `clear` method) and all internal tracking data. ### Best Practices 1. **Choose appropriate cache store**: Use MemoryStore for fast temporary caching or LocalStore for persistent caching 2. **Size the cache appropriately**: Set `max_size` based on available storage and expected data access patterns 3. **Use with remote stores**: The cache provides the most benefit when wrapping slow remote stores 4. **Monitor cache statistics**: Use `cache_info()` to tune cache size and access patterns 5. **Consider data locality**: Group related data accesses together to improve cache efficiency 6. **Set appropriate expiration**: Use `max_age_seconds` for time-sensitive data or "infinity" for static data ### Working with Different Store Types The CacheStore can wrap any store that implements the `zarr.abc.store.Store` interface and use any store type for the cache backend: #### Local Store with Memory Cache ```python exec="true" session="experimental-memory-cache" source="above" from zarr.storage import LocalStore, MemoryStore from zarr.experimental.cache_store import CacheStore from tempfile import mkdtemp local_store_path = mkdtemp(suffix='.zarr') source_store = LocalStore(local_store_path) cache_store = MemoryStore() cached_store = CacheStore( store=source_store, cache_store=cache_store, max_size=128*1024*1024 ) ``` #### Memory Store with Persistent Cache ```python exec="true" session="experimental-local-cache" source="above" from tempfile import mkdtemp from zarr.storage import MemoryStore, LocalStore from zarr.experimental.cache_store import CacheStore memory_store = MemoryStore() local_store_path = mkdtemp(suffix='.zarr') persistent_cache = LocalStore(local_store_path) cached_store = CacheStore( store=memory_store, cache_store=persistent_cache, max_size=256*1024*1024 ) ``` The dual-store architecture provides flexibility in choosing the best combination of source and cache stores for your specific use case. ### Examples from Real Usage Here's a complete example demonstrating cache effectiveness: ```python exec="true" session="experimental-final" source="above" import numpy as np import time from tempfile import mkdtemp import zarr import zarr.storage from zarr.experimental.cache_store import CacheStore # Create test data with dual-store cache local_store_path = mkdtemp(suffix='.zarr') source_store = zarr.storage.LocalStore(local_store_path) cache_store = zarr.storage.MemoryStore() cached_store = CacheStore( store=source_store, cache_store=cache_store, max_size=256*1024*1024 ) zarr_array = zarr.zeros((100, 100), chunks=(10, 10), dtype='f8', store=cached_store, mode='w') zarr_array[:] = np.random.random((100, 100)) # Demonstrate cache effectiveness with repeated access start = time.time() data = zarr_array[20:30, 20:30] # First access (cache miss) first_access = time.time() - start print(f"First access took {first_access}") start = time.time() data = zarr_array[20:30, 20:30] # Second access (cache hit) second_access = time.time() - start print(f"Second access took {second_access}") # Check cache statistics info = cached_store.cache_info() assert info['cached_keys'] > 0 # Should have cached keys assert info['current_size'] > 0 # Should have cached data print(f"Cache contains {info['cached_keys']} keys with {info['current_size']} bytes") ``` This example shows how the CacheStore can significantly reduce access times for repeated data reads, particularly important when working with remote data sources. The dual-store architecture allows for flexible cache persistence and management. zarr-python-3.3.0/docs/user-guide/extending.md000066400000000000000000000114471523267620000213340ustar00rootroot00000000000000# Extending Zarr Zarr-Python 3 was designed to be extensible. This means that you can extend the library by writing custom classes and plugins. Currently, Zarr can be extended in the following ways: ## Custom codecs !!! note This section explains how custom codecs can be created for Zarr format 3 arrays. For Zarr format 2, codecs should subclass the [numcodecs.abc.Codec](https://numcodecs.readthedocs.io/en/stable/abc.html#numcodecs.abc.Codec) base class and register through [numcodecs.registry.register_codec](https://numcodecs.readthedocs.io/en/stable/registry.html#numcodecs.registry.register_codec). There are three types of codecs in Zarr: - array-to-array - array-to-bytes - bytes-to-bytes Array-to-array codecs are used to transform the array data before serializing to bytes. Examples include delta encoding or scaling codecs. Array-to-bytes codecs are used for serializing the array data to bytes. In Zarr, the main codec to use for numeric arrays is the [`zarr.codecs.BytesCodec`][]. Bytes-to-bytes codecs transform the serialized bytestreams of the array data. Examples include compression codecs, such as [`zarr.codecs.GzipCodec`][], [`zarr.codecs.BloscCodec`][] or [`zarr.codecs.ZstdCodec`][], and codecs that add a checksum to the bytestream, such as [`zarr.codecs.Crc32cCodec`][]. Custom codecs for Zarr are implemented by subclassing the relevant base class, see [`zarr.abc.codec.ArrayArrayCodec`][], [`zarr.abc.codec.ArrayBytesCodec`][] and [`zarr.abc.codec.BytesBytesCodec`][]. Most custom codecs should implement the `_encode_single` and `_decode_single` methods. These methods operate on single chunks of the array data. Alternatively, custom codecs can implement the `encode` and `decode` methods, which operate on batches of chunks, in case the codec is intended to implement its own batch processing. Custom codecs should also implement the following methods: - `compute_encoded_size`, which returns the byte size of the encoded data given the byte size of the original data. It should raise `NotImplementedError` for codecs with variable-sized outputs, such as compression codecs. - `validate` (optional), which can be used to check that the codec metadata is compatible with the array metadata. It should raise errors if not. - `resolve_metadata` (optional), which is important for codecs that change the shape, dtype or fill value of a chunk. - `evolve_from_array_spec` (optional), which can be useful for automatically filling in codec configuration metadata from the array metadata. To use custom codecs in Zarr, they need to be registered using the [entrypoint mechanism](https://packaging.python.org/en/latest/specifications/entry-points/). Commonly, entrypoints are declared in the `pyproject.toml` of your package under the `[project.entry-points."zarr.codecs"]` section. Zarr will automatically discover all codecs registered via the entrypoint mechanism in installed packages. ```toml [project.entry-points."zarr.codecs"] "custompackage.fancy_codec" = "custompackage:FancyCodec" ``` New codecs need to have their own unique identifier. To avoid naming collisions, it is strongly recommended to prefix the codec identifier with a unique name. For example, the codecs from `numcodecs` are prefixed with `numcodecs.`, e.g. `numcodecs.delta`. !!! note Note that the extension mechanism for the Zarr format 3 is still under development. Requirements for custom codecs including the choice of codec identifiers might change in the future. It is also possible to register codecs as replacements for existing codecs. This might be useful for providing specialized implementations, such as GPU-based codecs. In case of multiple codecs, the [`zarr.config`][] mechanism can be used to select the preferred implementation. ## Custom stores Custom stores can be created by implementing the [`zarr.abc.store.Store`][] interface. See [developing custom stores](storage.md#developing-custom-stores) for more information. ## Custom array buffers Zarr-python provides control over where and how arrays are stored in memory through [`zarr.abc.buffer.Buffer`][]. Currently both CPU (the default) and GPU implementations are provided (see [Using GPUs with Zarr](gpu.md) for more information). You can implement your own buffer classes by implementing the interface defined in [`zarr.abc.buffer.BufferPrototype`][]. Like codecs, custom buffer implementations can be registered via entrypoints, using the `zarr.buffer` and `zarr.ndbuffer` entrypoint groups. ## Custom data types Zarr supports user-defined data types. See the [data types documentation](data_types.md) for an explanation of how Zarr Python models data types and how to write your own, and the [custom data type example](examples/custom_dtype.md) for a complete worked example. ## Other extensions In the future, Zarr will support writing custom chunk grids. zarr-python-3.3.0/docs/user-guide/glossary.md000066400000000000000000000145121523267620000212060ustar00rootroot00000000000000# Glossary This page defines key terms used throughout the zarr-python documentation and API. ## Array Structure ### Array An N-dimensional typed array stored in a Zarr [store](#store). An array's [metadata](#metadata) defines its shape, data type, chunk layout, and codecs. ### Group A container for [arrays](#array) and other groups, enabling hierarchical organization of data — similar to directories in a file system, or groups in HDF5. Like arrays, each group has its own [metadata](#metadata) and [attributes](#attributes). See the [groups documentation](groups.md). ### Chunk The fundamental unit of data in a Zarr array. An array is divided into chunks along each dimension according to the [chunk grid](#chunk-grid). Each chunk is independently compressed and encoded through the array's [codec](#codec) pipeline. When [sharding](#shard) is used, "chunk" refers to the inner chunks within each shard, because those are the compressible units. The chunks are the smallest units that can be read independently. !!! warning "Convention specific to zarr-python" The use of "chunk" to mean the inner sub-chunk within a shard is a convention adopted by zarr-python's `Array` API. In the Zarr V3 specification and in other Zarr implementations, "chunk" may refer to the top-level grid cells (which zarr-python calls "shards" when the sharding codec is used). Be aware of this distinction when working across libraries. **API**: [`Array.chunks`][zarr.Array.chunks] returns the chunk shape. When sharding is used, this is the inner chunk shape. ### Chunk Grid The partitioning of an array's elements into [chunks](#chunk). In Zarr V3, the chunk grid is defined in the array [metadata](#metadata) and determines the boundaries of each storage object. Zarr V3 supports two chunk grid types: - **Regular**: All chunks have the same shape (the last chunk along each dimension may be smaller than the declared size). - **Rectilinear** *(experimental)*: Each dimension can have different chunk sizes, specified as a list of edge lengths per dimension. Enable with `zarr.config.set({'array.rectilinear_chunks': True})`. When sharding is used, the chunk grid defines the [shard](#shard) boundaries, not the inner chunk boundaries. The inner chunk shape is defined within the [sharding codec](#shard). **API**: The `chunk_grid` field in array metadata contains the storage-level grid. [`Array.chunks`][zarr.Array.chunks] returns the chunk shape for regular grids. For all grid types, `Array.read_chunk_sizes` and `Array.write_chunk_sizes` return the per-dimension chunk sizes in dask-style `tuple[tuple[int, ...], ...]` format. Note that while the chunk grid is a public concept of the Zarr format, the classes zarr-python uses to model chunk grids are currently private API. ### Shard A storage object that contains one or more [chunks](#chunk). Sharding reduces the number of objects in a [store](#store) by grouping chunks together, which improves performance on file systems and object storage. Within each shard, chunks are compressed independently and can be read individually. However, writing requires updating the full shard for consistency, making shards the unit of writing and chunks the unit of reading. Sharding is implemented as a [codec](#codec) (the sharding indexed codec). When sharding is used: - The [chunk grid](#chunk-grid) in metadata defines the shard boundaries - The sharding codec's `chunk_shape` defines the inner chunk size - Each shard contains `shard_shape / chunk_shape` chunks per dimension **API**: [`Array.shards`][zarr.Array.shards] returns the shard shape, or `None` if sharding is not used. [`Array.chunks`][zarr.Array.chunks] returns the inner chunk shape. ## Storage ### Store A key-value storage backend that holds Zarr data and metadata. Stores implement the [`zarr.abc.store.Store`][] interface. Examples include local file systems, cloud object storage (S3, GCS, Azure), zip files, and in-memory dictionaries. Each [chunk](#chunk) or [shard](#shard) is stored as a single value (object or file) in the store, addressed by a key derived from its grid coordinates. ### Metadata The JSON document that describes an [array](#array) or [group](#group). In Zarr format 3 this is a single `zarr.json` document; Zarr format 2 stores the equivalent information in separate `.zarray`, `.zgroup`, and `.zattrs` documents. For arrays, metadata includes the shape, data type, [chunk grid](#chunk-grid), fill value, and [codec](#codec) pipeline. Metadata is stored alongside the data in the [store](#store). Zarr-Python does not yet expose its internal metadata representation as part of its public API. ### Attributes User-defined key-value pairs (any JSON-serializable values) attached to an [array](#array) or [group](#group). Attributes are stored in the [metadata](#metadata) document. See the [attributes documentation](attributes.md). ### Consolidated Metadata A copy of the [metadata](#metadata) of every array and group in a hierarchy, stored in the metadata of the root group so that the entire hierarchy can be inspected with a single read from the [store](#store). See the [consolidated metadata documentation](consolidated_metadata.md). ## Codecs ### Codec A transformation applied to array data during reading and writing. Codecs are chained into a pipeline and come in three types: - **Array-to-array**: Transforms like transpose that rearrange array elements - **Array-to-bytes**: Serialization that converts an array to a byte sequence (exactly one required) - **Bytes-to-bytes**: Compression or checksums applied to the serialized bytes The [sharding indexed codec](#shard) is a special array-to-bytes codec that groups multiple [chunks](#chunk) into a single storage object. ## API Properties The following properties are available on [`zarr.Array`][]: | Property | Description | |----------|-------------| | `.chunks` | Chunk shape — the inner chunk shape when sharding is used. Raises for rectilinear grids | | `.shards` | Shard shape, or `None` if no sharding | | `.read_chunk_sizes` | Per-dimension chunk data sizes (`tuple[tuple[int, ...], ...]`). Works for all grid types | | `.write_chunk_sizes` | Per-dimension storage chunk sizes (`tuple[tuple[int, ...], ...]`). Works for all grid types | | `.nchunks` | Total number of independently compressible units across the array | | `.cdata_shape` | Number of independently compressible units per dimension | zarr-python-3.3.0/docs/user-guide/gpu.md000066400000000000000000000043201523267620000201320ustar00rootroot00000000000000# Using GPUs with Zarr Zarr can use GPUs to accelerate your workload by running `zarr.config.enable_gpu()`. !!! note `zarr-python` currently supports reading the ndarray data into device (GPU) memory as the final stage of the codec pipeline. Data will still be read into or copied to host (CPU) memory for encoding and decoding. In the future, codecs will be available for compressing and decompressing data on the GPU, avoiding the need to move data between the host and device for compression and decompression. ## Installation Zarr's GPU support requires [CuPy](https://cupy.dev), which in turn requires a CUDA-compatible NVIDIA GPU. CuPy can be installed alongside Zarr with the `gpu` extra (see [Installation](installation.md) for the other optional dependency groups): ```console pip install "zarr[gpu]" ``` This installs the `cupy-cuda12x` package. If you need a CuPy build for a different CUDA version, see the [CuPy installation guide](https://docs.cupy.dev/en/stable/install.html) and install the appropriate package yourself. ## Reading data into device memory Calling `zarr.config.enable_gpu()` configures Zarr to use GPU memory for the data buffers used internally by Zarr: ```python test="true" session="gpu-demo" markers="gpu" source="above" import zarr import cupy as cp zarr.config.enable_gpu() z = zarr.create_array( store="memory://gpu-demo", shape=(100, 100), chunks=(10, 10), dtype="float32", ) assert isinstance(z[:10, :10], cp.ndarray) ``` Note that the arrays returned by reads are of type `cupy.ndarray` rather than NumPy arrays. `zarr.config.enable_gpu()` returns a [donfig](https://donfig.readthedocs.io/en/latest/) `ConfigSet`, which can be used as a context manager to enable GPU support for a limited scope: ```python test="true" session="gpu-demo" markers="gpu" source="above" with zarr.config.enable_gpu(): data = z[:10, :10] assert isinstance(data, cp.ndarray) ``` Under the hood, `enable_gpu()` selects the GPU-backed buffer classes `zarr.buffer.gpu.Buffer` and `zarr.buffer.gpu.NDBuffer` via the `buffer` and `ndbuffer` configuration keys. See [Custom array buffers](extending.md#custom-array-buffers) for more on Zarr's buffer classes, including how to implement your own. zarr-python-3.3.0/docs/user-guide/groups.md000066400000000000000000000154431523267620000206660ustar00rootroot00000000000000# Working with groups Zarr supports hierarchical organization of arrays via groups. As with arrays, groups can be stored in memory, on disk, or via other storage systems that support a similar interface. To create a group, use the [`zarr.create_group`][] function: ```python exec="true" session="groups" source="above" result="ansi" import zarr root = zarr.create_group(store="memory://groups-demo") print(root) ``` Zarr-Python provides three related functions for making groups: [`zarr.create_group`][] creates a new group; [`zarr.open_group`][] creates or re-opens a group depending on its `mode` argument (see below); and [`zarr.group`][], which is kept for compatibility with Zarr-Python 2, is equivalent to calling [`zarr.open_group`][] with `mode='a'` (or `mode='w'` when `overwrite=True`). Groups have a similar API to the Group class from [h5py](https://www.h5py.org/). For example, groups can contain other groups: ```python exec="true" session="groups" source="above" foo = root.create_group('foo') bar = foo.create_group('bar') ``` Groups can also contain arrays, e.g.: ```python exec="true" session="groups" source="above" result="ansi" z1 = bar.create_array(name='baz', shape=(10000, 10000), chunks=(1000, 1000), dtype='int32') print(z1) ``` Members of a group can be accessed with square-bracket item access, like a Python `dict`, e.g.: ```python exec="true" session="groups" source="above" result="ansi" print(root['foo']) ``` The '/' character can be used to access multiple levels of the hierarchy in one call, e.g.: ```python exec="true" session="groups" source="above" result="ansi" print(root['foo/bar']) ``` ```python exec="true" session="groups" source="above" result="ansi" print(root['foo/bar/baz']) ``` Accessing a member with `[]` returns either an [`zarr.Array`][] or a [`zarr.Group`][], depending on what is stored at the given path. When you expect a node of a particular kind, use [`zarr.Group.get_array`][] or [`zarr.Group.get_group`][] instead. These methods accept the same paths as `[]`, but they have precise return types and raise an error if no node exists at the given path, or if the node is not of the expected kind: ```python exec="true" session="groups" source="above" result="ansi" print(root.get_group('foo')) ``` ```python exec="true" session="groups" source="above" result="ansi" print(root.get_array('foo/bar/baz')) ``` ```python exec="true" session="groups" source="above" result="ansi" from zarr.errors import ContainsGroupError try: root.get_array('foo') except ContainsGroupError as e: print(e) ``` The [`zarr.Group.tree`][] method can be used to print a tree representation of the hierarchy, e.g.: ```python exec="true" session="groups" source="above" result="ansi" print(root.tree()) ``` The [`zarr.open_group`][] function provides a convenient way to create or re-open a group stored in a directory on the file-system, with sub-groups stored in sub-directories, e.g.: ```python exec="true" session="groups" source="above" result="ansi" root = zarr.open_group('data/group.zarr', mode='w') print(root) ``` ```python exec="true" session="groups" source="above" result="ansi" z = root.create_array(name='foo/bar/baz', shape=(10000, 10000), chunks=(1000, 1000), dtype='int32') print(z) ``` For more information on groups see the [`zarr.Group` API docs](../api/zarr/group.md). ## Exploring group contents Groups also support a dict-like interface for enumerating their contents. The [`zarr.Group.keys`][] method iterates over member names, and the `in` operator tests for membership: ```python exec="true" session="groups" source="above" result="ansi" print(list(root.keys())) print('foo' in root) ``` The [`zarr.Group.members`][] method returns `(name, member)` pairs for the arrays and groups contained in a group: ```python exec="true" session="groups" source="above" result="ansi" for name, member in root.members(): print(name, member) ``` By default only immediate members are returned. Pass `max_depth=None` to recursively traverse the whole hierarchy below a group: ```python exec="true" session="groups" source="above" result="ansi" for name, member in root.members(max_depth=None): print(name, member) ``` Members can be deleted with the `del` operator, which removes the member's metadata and data from the store: ```python exec="true" session="groups" source="above" result="ansi" del root['foo/bar/baz'] for name, member in root.members(max_depth=None): print(name, member) ``` ## Batch group creation You can also create multiple groups concurrently with a single function call. [`zarr.create_hierarchy`][] takes a [`Store`](../api/zarr/storage.md) instance and a dict of `key : metadata` pairs, parses that dict, and writes metadata documents to storage: ```python exec="true" session="groups" source="above" result="ansi" from zarr import create_hierarchy from zarr.core.group import GroupMetadata from zarr.storage import LocalStore from pprint import pprint import io node_spec = {'a/b/c': GroupMetadata()} nodes_created = dict(create_hierarchy(store=LocalStore(root='data'), nodes=node_spec)) # Report nodes (pprint is used for cleaner rendering in the docs) output = io.StringIO() pprint(nodes_created, stream=output, width=60) print(output.getvalue()) ``` Note that we only specified a single group named `a/b/c`, but 4 groups were created. These additional groups were created to ensure that the desired node `a/b/c` is connected to the root group `''` by a sequence of intermediate groups. [`zarr.create_hierarchy`][] normalizes the `nodes` keyword argument to ensure that the resulting hierarchy is complete, i.e. all groups or arrays are connected to the root of the hierarchy via intermediate groups. Because [`zarr.create_hierarchy`][] concurrently creates metadata documents, it's more efficient than repeated calls to [`create_group`][zarr.create_group] or [`create_array`][zarr.create_array], provided you can statically define the metadata for the groups and arrays you want to create. ## Array and group diagnostics Diagnostic information about arrays and groups is available via the `info` property. E.g.: ```python exec="true" session="groups" source="above" result="ansi" root = zarr.group(store="memory://diagnostics-demo") foo = root.create_group('foo') bar = foo.create_array(name='bar', shape=1000000, chunks=100000, dtype='int64') bar[:] = 42 baz = foo.create_array(name='baz', shape=(1000, 1000), chunks=(100, 100), dtype='float32') baz[:] = 4.2 print(root.info) ``` ```python exec="true" session="groups" source="above" result="ansi" print(foo.info) ``` ```python exec="true" session="groups" source="above" result="ansi" print(bar.info_complete()) ``` ```python exec="true" session="groups" source="above" result="ansi" print(baz.info) ``` Groups also have the [`zarr.Group.tree`][] method, e.g.: ```python exec="true" session="groups" source="above" result="ansi" print(root.tree()) ``` zarr-python-3.3.0/docs/user-guide/index.md000066400000000000000000000037561523267620000204620ustar00rootroot00000000000000# User Guide Welcome to the user guide, where you can learn more about using Zarr-Python! ## Getting Started New to Zarr-Python? Start here: - **[Installation](installation.md)** - Install Zarr-Python - **[Quick start](../quick-start.md)** - Quick overview of core functionality ## Core Concepts Learn the essential building blocks: - **[Arrays](arrays.md)** - Learn the fundamentals of working with arrays - **[Groups](groups.md)** - Organize your data with groups - **[Attributes](attributes.md)** - Attach metadata to your arrays and groups - **[Storage](storage.md)** - Learn how data is stored and accessed ## Configuration & Setup Customize your experience: - **[Runtime Configuration](config.md)** - Configure Zarr-Python for your needs - **[Command-Line Interface](cli.md)** - Migrate and manage Zarr metadata from the terminal - **[V3 Migration](v3_migration.md)** - Upgrading from version 2 to version 3 ## Advanced Topics Take your skills to the next level: - **[Data Types](data_types.md)** - Learn about supported and extensible data types - **[Performance](performance.md)** - Optimize for speed and efficiency - **[GPU](gpu.md)** - Leverage GPU acceleration - **[Extending](extending.md)** - Extend functionality with custom code - **[Consolidated Metadata](consolidated_metadata.md)** - Advanced metadata management - **[Experimental Features](experimental.md)** - Preview features that may change at any time ## Examples Worked, end-to-end examples: - **[Custom Data Type](examples/custom_dtype.md)** - Extend Zarr-Python with a user-defined data type - **[Rectilinear Chunk Grids](examples/rectilinear_chunks.md)** - Use variable-sized chunks along each dimension ## Reference - **[Glossary](glossary.md)** - Definitions of key terms (chunks, shards, codecs, etc.) ## Need Help? - Browse the [API Reference](../api/zarr/index.md) for detailed function documentation - Report issues on [GitHub](https://github.com/zarr-developers/zarr-python/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) zarr-python-3.3.0/docs/user-guide/installation.md000066400000000000000000000044271523267620000220500ustar00rootroot00000000000000# Installation ## Required dependencies Required dependencies include: - [Python](https://docs.python.org/3/) (3.12 or later) - [packaging](https://packaging.pypa.io/en/stable/) (22.0 or later) - [numpy](https://numpy.org) (2.0 or later) - [numcodecs](https://numcodecs.readthedocs.io/en/stable/) (0.14 or later) - [google-crc32c](https://github.com/googleapis/python-crc32c) (1.5 or later) - [typing_extensions](https://typing-extensions.readthedocs.io/en/latest/) (4.14 or later) - [donfig](https://donfig.readthedocs.io/en/latest/) (0.8 or later) ## pip Zarr is available on [PyPI](https://pypi.org/project/zarr/). Install it using `pip`: ```console pip install zarr ``` There are a number of optional dependency groups you can install for extra functionality. These can be installed using `pip install "zarr[]"`, e.g. `pip install "zarr[gpu]"` - `remote`: support for reading/writing to remote data stores (fsspec, obstore) - `gpu`: support for GPUs (cupy) - `cli`: support for the `zarr` [command-line interface](cli.md) (typer) - `optional`: support for path-like access to local and remote stores (universal-pathlib) - `cast-value-rs`: support for the `cast_value` codec (cast-value-rs) ## conda Zarr is also published to [conda-forge](https://conda-forge.org). Install it using `conda`: ```console conda install -c conda-forge zarr ``` Conda does not support optional dependencies, so you will have to manually install any packages needed to enable extra functionality. ## Nightly wheels Development wheels are built nightly and published to the [scientific-python-nightly-wheels](https://anaconda.org/scientific-python-nightly-wheels) index. To install the latest nightly build: ```console pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple zarr ``` Note that nightly wheels may be unstable and are intended for testing purposes. ## Dependency support Zarr has endorsed [Scientific-Python SPEC 0](https://scientific-python.org/specs/spec-0000/) and now follows the version support window as outlined below: - Python: 36 months after initial release - Core package dependencies (e.g. NumPy): 24 months after initial release ## Development To install the latest development version of Zarr, see the [contributing guide](../contributing.md). zarr-python-3.3.0/docs/user-guide/performance.md000066400000000000000000000362431523267620000216510ustar00rootroot00000000000000# Optimizing performance ## Chunk optimizations ### Chunk size and shape In general, chunks of at least 1 megabyte (1M) uncompressed size seem to provide better performance, at least when using the Blosc compression library. The optimal chunk shape will depend on how you want to access the data. E.g., for a 2-dimensional array, if you only ever take slices along the first dimension, then chunk across the second dimension. If you know you want to chunk across an entire dimension you can use the full size of that dimension within the `chunks` argument, e.g.: ```python exec="true" session="performance" source="above" result="ansi" import zarr z1 = zarr.create_array(store={}, shape=(10000, 10000), chunks=(100, 10000), dtype='int32') print(z1.chunks) ``` Alternatively, if you only ever take slices along the second dimension, then chunk across the first dimension, e.g.: ```python exec="true" session="performance" source="above" result="ansi" z2 = zarr.create_array(store={}, shape=(10000, 10000), chunks=(10000, 100), dtype='int32') print(z2.chunks) ``` If you require reasonable performance for both access patterns then you need to find a compromise, e.g.: ```python exec="true" session="performance" source="above" result="ansi" z3 = zarr.create_array(store={}, shape=(10000, 10000), chunks=(1000, 1000), dtype='int32') print(z3.chunks) ``` If you are feeling lazy, you can let Zarr guess a chunk shape for your data by providing `chunks='auto'`, although please note that the algorithm for guessing a chunk shape is based on simple heuristics and may be far from optimal. E.g.: ```python exec="true" session="performance" source="above" result="ansi" z4 = zarr.create_array(store={}, shape=(10000, 10000), chunks='auto', dtype='int32') print(z4.chunks) ``` If you know you are always going to be loading the entire array into memory, you can turn off chunks by providing `chunks` equal to `shape`, in which case there will be one single chunk for the array: ```python exec="true" session="performance" source="above" result="ansi" z5 = zarr.create_array(store={}, shape=(10000, 10000), chunks=(10000, 10000), dtype='int32') print(z5.chunks) ``` ### Sharding If you have large arrays but need small chunks to efficiently access the data, you can use sharding. Sharding provides a mechanism to store multiple chunks in a single storage object or file. This can be useful because traditional file systems and object storage systems may have performance issues storing and accessing many files. Additionally, small files can be inefficient to store if they are smaller than the block size of the file system. Picking a good combination of chunk shape and shard shape is important for performance. The chunk shape determines what unit of your data can be read independently, while the shard shape determines what unit of your data can be written efficiently. For an example, consider you have a 100 GB array and need to read small chunks of 1 MB. Without sharding, each chunk would be one file resulting in 100,000 files. That can already cause performance issues on some file systems. With sharding, you could use a shard size of 1 GB. This would result in 1000 chunks per file and 100 files in total, which seems manageable for most storage systems. You would still be able to read each 1 MB chunk independently, but you would need to write your data in 1 GB increments. To use sharding, you need to specify the `shards` parameter when creating the array. ```python exec="true" session="performance" source="above" result="ansi" z6 = zarr.create_array(store={}, shape=(10000, 10000, 1000), shards=(1000, 1000, 1000), chunks=(100, 100, 100), dtype='uint8') print(z6.info) ``` `shards` can be `"auto"` as well, in which case Zarr chooses a shard shape for you. The `array.target_shard_size_bytes` configuration setting controls this choice: the cumulative uncompressed size of the chunks within each shard will be as close as possible to, without exceeding, that target. If the setting is `None` (the default), Zarr falls back to a built-in heuristic for choosing the shard shape. ### Chunk memory layout The memory layout of the in-memory arrays that Zarr produces and consumes can be changed via the `order` config option, to use either C or Fortran layout. This can matter for performance when the data is passed to other libraries that expect a particular memory layout. E.g.: ```python exec="true" session="performance" source="above" result="ansi" import numpy as np c = zarr.create_array(store={}, shape=(10000, 10000), chunks=(1000, 1000), dtype='int32', config={'order': 'C'}) print(c[:100, :100].flags.c_contiguous) ``` ```python exec="true" session="performance" source="above" result="ansi" with zarr.config.set({'array.order': 'F'}): f = zarr.create_array(store={}, shape=(10000, 10000), chunks=(1000, 1000), dtype='int32') print(f[:100, :100].flags.f_contiguous) ``` Note that for Zarr format 3 arrays the `order` option only affects the in-memory layout: the bytes written to storage are identical for both settings. The layout of the serialized data is instead determined by the array's codecs (e.g. the transpose codec), which can change how well the data compresses depending on the correlation structure within the data and which compression filters (e.g., byte-shuffle) have been applied. ### Subchunk memory layout The order of chunks **within each shard** can be changed via the `subchunk_write_order` parameter of the `ShardingCodec`. That parameter is a string which must be one of `["morton", "unordered", "lexicographic", "colexicographic"]`. By default [`morton`](https://en.wikipedia.org/wiki/Z-order_curve) order provides good spatial locality. [`lexicographic` (i.e., row-major)](https://en.wikipedia.org/wiki/Row-_and_column-major_order), for example, may be better suited to "batched" workflows where some form of sequential reading through a fixed number of outer dimensions is desired, and `colexicographic` is its reverse. `unordered` makes no guarantee about the order in which subchunks are laid out within a shard. ### Empty chunks It is possible to configure how Zarr handles the storage of chunks that are "empty" (i.e., every element in the chunk is equal to the array's fill value). When creating an array with `write_empty_chunks=False`, Zarr will check whether a chunk is empty before compression and storage. If a chunk is empty, then Zarr does not store it, and instead deletes the chunk from storage if the chunk had been previously stored. This optimization prevents storing redundant objects and can speed up reads, but the cost is added computation during array writes, since the contents of each chunk must be compared to the fill value, and these advantages are contingent on the content of the array. If you know that your data will form chunks that are almost always non-empty, then there is no advantage to the optimization described above. In this case, creating an array with `write_empty_chunks=True` will instruct Zarr to write every chunk without checking for emptiness. The default value of `write_empty_chunks` is `False`: ```python exec="true" session="performance" source="above" result="ansi" arr = zarr.create_array(store={}, shape=(1,), dtype='uint8') assert arr.config.write_empty_chunks == False ``` The following example illustrates the effect of the `write_empty_chunks` flag on the time required to write an array with different values: ```python exec="true" session="performance" source="above" result="ansi" import zarr import numpy as np import time def timed_write(write_empty_chunks): """ Measure the time required and number of objects created when writing to a Zarr array with random ints or fill value. """ chunks = (8192,) shape = (chunks[0] * 1024,) data = np.random.randint(0, 255, shape) dtype = 'uint8' arr = zarr.create_array( f'data/example-{write_empty_chunks}.zarr', shape=shape, chunks=chunks, dtype=dtype, fill_value=0, config={'write_empty_chunks': write_empty_chunks} ) # initialize all chunks arr[:] = 100 result = [] for value in (data, arr.fill_value): start = time.time() arr[:] = value elapsed = time.time() - start result.append((elapsed, arr.nchunks_initialized)) return result # log results for write_empty_chunks in (True, False): full, empty = timed_write(write_empty_chunks) print(f'\nwrite_empty_chunks={write_empty_chunks}:\n\tRandom Data: {full[0]:.4f}s, {full[1]} objects stored\n\t Empty Data: {empty[0]:.4f}s, {empty[1]} objects stored\n') ``` In this example, writing random data is slightly slower with `write_empty_chunks=False`, because every chunk must be checked for emptiness before it is stored. Writing empty data with `write_empty_chunks=False` is substantially faster, however, and stores no objects at all. ### Changing chunk shapes (rechunking) Zarr-Python does not yet provide a built-in way to change the chunk shape of an existing array in place. Arrays can, however, be resized and appended to along any dimension — see [Resizing and appending](arrays.md#resizing-and-appending) — and data can be copied to a new array created with the desired chunk shape. ## Parallel computing and synchronization Zarr is designed to support parallel computing and enables concurrent reads and writes to arrays. This section covers how to optimize Zarr's concurrency settings for different parallel computing scenarios. ### Concurrent I/O operations Zarr uses asynchronous I/O internally to enable concurrent reads and writes across multiple chunks. The level of concurrency is controlled by the `async.concurrency` configuration setting, which determines the maximum number of concurrent I/O operations. The default value is 10, which is a conservative value. You may get improved performance by tuning the concurrency limit. You can adjust this value based on your specific needs: ```python exec="true" session="perf-concurrency" source="above" import zarr # Set concurrency for the current session zarr.config.set({'async.concurrency': 128}) # Or use environment variable # export ZARR_ASYNC_CONCURRENCY=128 ``` Higher concurrency values can improve throughput when: - Working with remote storage (e.g., S3, GCS) where network latency is high - Reading/writing many small chunks in parallel - The storage backend can handle many concurrent requests Lower concurrency values may be beneficial when: - Working with local storage with limited I/O bandwidth - Memory is constrained (each concurrent operation requires buffer space) - Using Zarr within a parallel computing framework (see below) ### Thread pool size (`threading.max_workers`) When synchronous Zarr code calls async operations internally, Zarr uses a `ThreadPoolExecutor` to run those coroutines. The `threading.max_workers` configuration option controls the maximum number of worker threads in that pool. By default it is `None`, which lets Python choose the pool size (typically `min(32, os.cpu_count() + 4)`). You can set it explicitly when you want more predictable resource usage: ```python exec="true" session="perf-workers" source="above" import zarr zarr.config.set({'threading.max_workers': 8}) ``` Reducing this value can help avoid overloading the event loop when Zarr is used inside a parallel computing framework such as Dask that already manages its own thread pool (see the Dask section below). Increasing it may improve throughput in CPU-bound workloads where many synchronous-to-async dispatches happen concurrently. ### Using Zarr with Dask [Dask](https://www.dask.org/) is a popular parallel computing library that works well with Zarr for processing large arrays. When using Zarr with Dask, it's important to consider the interaction between Dask's thread pool and Zarr's concurrency settings. **Important**: When using many Dask threads, you may need to reduce both Zarr's `async.concurrency` and `threading.max_workers` settings to avoid creating too many concurrent operations. The total number of concurrent I/O operations can be roughly estimated as: ```text total_concurrency ≈ dask_threads × zarr_async_concurrency ``` For example, if you're running Dask with 10 threads and Zarr's default concurrency of 10, you could potentially have up to 100 concurrent operations, which may overwhelm your storage system or cause memory issues. **Recommendation**: When using Dask with many threads, configure Zarr's concurrency settings: ```python exec="false" reason="requires dask, which is not in the docs test environment" import zarr import dask.array as da # If using Dask with many threads (e.g., 8-16), reduce Zarr's concurrency settings zarr.config.set({ 'async.concurrency': 4, # Limit concurrent async operations 'threading.max_workers': 4, # Limit Zarr's internal thread pool }) # Open Zarr array z = zarr.open_array('data/large_array.zarr', mode='r') # Create Dask array from Zarr array arr = da.from_array(z, chunks=z.chunks) # Process with Dask result = arr.mean(axis=0).compute() ``` **Configuration guidelines for Dask workloads**: - `async.concurrency`: Controls the maximum number of concurrent async I/O operations. Start with a lower value (e.g., 4-8) when using many Dask threads. - `threading.max_workers`: Controls Zarr's internal thread pool size for blocking operations (defaults to `None`, letting Python choose the pool size). Reduce this to avoid thread contention with Dask's scheduler. You may need to experiment with different values to find the optimal balance for your workload. Monitor your system's resource usage and adjust these settings based on whether your storage system or CPU is the bottleneck. ### Thread safety and process safety Zarr arrays are designed to be thread-safe for concurrent reads and writes from multiple threads within the same process. However, proper synchronization is required when writing to overlapping regions from multiple threads. For multi-process parallelism, Zarr provides safe concurrent writes as long as: - Different processes write to different chunks - The storage backend supports atomic writes (most do) When writing to the same chunks from multiple processes, you should use external synchronization mechanisms or ensure that writes are coordinated to avoid race conditions. ## Pickle support Zarr arrays and groups can be pickled, as long as the underlying store object can be pickled. All of the storage classes provided in the `zarr.storage` module can be pickled. If an array or group is backed by a persistent store such as a `zarr.storage.LocalStore`, `zarr.storage.ZipStore` or `zarr.storage.FsspecStore` then the store data **are not** pickled. The only thing that is pickled is the necessary parameters to allow the store to re-open any underlying files or databases upon being unpickled. Note that pickling a `zarr.storage.MemoryStore` copies the data it holds into the pickle stream: unpickling produces an independent in-memory copy, so a `MemoryStore` cannot be used to share data between processes. E.g., pickle/unpickle a local store array: ```python exec="true" session="performance" source="above" result="ansi" import pickle data = np.arange(100000) z1 = zarr.create_array(store='data/perf-example-2.zarr', shape=data.shape, chunks=data.shape, dtype=data.dtype) z1[:] = data s = pickle.dumps(z1) z2 = pickle.loads(s) assert z1 == z2 print(np.all(z1[:] == z2[:])) ``` zarr-python-3.3.0/docs/user-guide/storage.md000066400000000000000000000203751523267620000210130ustar00rootroot00000000000000# Storage guide Zarr-Python supports multiple storage backends, including: local file systems, Zip files, remote stores via [fsspec](https://filesystem-spec.readthedocs.io/en/latest/) (S3, HTTP, etc.), and in-memory stores. In Zarr-Python 3, stores must implement the abstract store API from [`zarr.abc.store.Store`][]. !!! note Unlike Zarr-Python 2 where the store interface was built around a generic `MutableMapping` API, Zarr-Python 3 utilizes a custom store API that utilizes Python's AsyncIO library. ## Implicit Store Creation In most cases, it is not required to create a `Store` object explicitly. Passing a string (or other [StoreLike value](#user-guide-store-like)) to Zarr's top level API will result in the store being created automatically: ```python exec="true" session="storage" source="above" result="ansi" import zarr # Implicitly creates a writable LocalStore group = zarr.create_group(store='data/foo/bar') print(group) ``` ```python exec="true" session="storage" source="above" result="ansi" # Implicitly creates a read-only FsspecStore # Note: requires s3fs to be installed group = zarr.open_group( store='s3://noaa-nwm-retro-v2-zarr-pds', mode='r', storage_options={'anon': True} ) print(group) ``` ```python exec="true" session="storage" source="above" result="ansi" # Implicitly creates a MemoryStore data = {} group = zarr.create_group(store=data) print(group) ``` ### StoreLike {#user-guide-store-like} `StoreLike` values can be: - a `Path` or string indicating a location on the local file system. This will create a [local store](#local-store): ```python exec="true" session="storage" source="above" result="ansi" group = zarr.open_group(store='data/foo/bar') print(group) ``` ```python exec="true" session="storage" source="above" result="ansi" from pathlib import Path group = zarr.open_group(store=Path('data/foo/bar')) print(group) ``` - an FSSpec URI string, indicating a [remote store](#remote-store) location: ```python exec="true" session="storage" source="above" result="ansi" # Note: requires s3fs to be installed group = zarr.open_group( store='s3://noaa-nwm-retro-v2-zarr-pds', mode='r', storage_options={'anon': True} ) print(group) ``` - an empty dictionary or None, which will create a new [memory store](#memory-store): ```python exec="true" session="storage" source="above" result="ansi" group = zarr.create_group(store={}) print(group) ``` ```python exec="true" session="storage" source="above" result="ansi" group = zarr.create_group(store=None) print(group) ``` - a dictionary of string to [`Buffer`][zarr.abc.buffer.Buffer] mappings. This will create a [memory store](#memory-store), using this dictionary as the [`store_dict` argument][zarr.storage.MemoryStore]. - an FSSpec [FSMap object](https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.FSMap), which will create an [FsspecStore](#remote-store). - a [`Store`][zarr.abc.store.Store] or [`StorePath`][zarr.storage.StorePath] - see explicit store creation below. ## Explicit Store Creation In some cases, it may be helpful to create a store instance directly. Zarr-Python offers built-in stores: [`zarr.storage.LocalStore`][], [`zarr.storage.FsspecStore`][], [`zarr.storage.ZipStore`][], [`zarr.storage.MemoryStore`][], and [`zarr.storage.ObjectStore`][]. ### Local Store The [`zarr.storage.LocalStore`][] stores data in a nested set of directories on a local filesystem: ```python exec="true" session="storage" source="above" result="ansi" store = zarr.storage.LocalStore('data/foo/bar', read_only=True) group = zarr.open_group(store=store, mode='r') print(group) ``` ### Zip Store The [`zarr.storage.ZipStore`][] stores the contents of a Zarr hierarchy in a single Zip file. The [Zip Store specification](https://github.com/zarr-developers/zarr-specs/pull/311) is currently in draft form: ```python exec="true" session="storage" source="above" result="ansi" store = zarr.storage.ZipStore('data.zip', mode='w') array = zarr.create_array(store=store, shape=(2,), dtype='float64') print(array) ``` In place of a path, `ZipStore` also accepts an open binary file object (for example a file opened with `fsspec`, or an `obstore` reader), enabling zip archives on remote storage. The file must stay open for as long as the store is in use: ```python exec="true" session="storage" source="above" result="ansi" store.close() f = open('data.zip', mode='rb') # must stay open while the store is used array = zarr.open_array(store=zarr.storage.ZipStore(f), mode='r') print(array[:]) f.close() ``` ### Remote Store The [`zarr.storage.FsspecStore`][] stores the contents of a Zarr hierarchy following the same logical layout as the [`LocalStore`][zarr.storage.LocalStore], except the store is assumed to be on a remote storage system such as cloud object storage (e.g. AWS S3, Google Cloud Storage, Azure Blob Store). The [`zarr.storage.FsspecStore`][] is backed by [fsspec](https://filesystem-spec.readthedocs.io/en/latest/) and can support any backend that implements the [AbstractFileSystem](https://filesystem-spec.readthedocs.io/en/stable/api.html#fsspec.spec.AbstractFileSystem) API. `storage_options` can be used to configure the fsspec backend: ```python exec="true" session="storage" source="above" result="ansi" # Note: requires s3fs to be installed store = zarr.storage.FsspecStore.from_url( 's3://noaa-nwm-retro-v2-zarr-pds', read_only=True, storage_options={'anon': True} ) group = zarr.open_group(store=store, mode='r') print(group) ``` The type of filesystem (e.g. S3, https, etc..) is inferred from the scheme of the url (e.g. s3 for "**s3**://noaa-nwm-retro-v2-zarr-pds"). In case a specific filesystem is needed, one can explicitly create it. For example to create an S3 filesystem (note that the filesystem must be created with `asynchronous=True`): ```python exec="true" session="storage" source="above" result="ansi" # Note: requires s3fs to be installed import fsspec fs = fsspec.filesystem('s3', anon=True, asynchronous=True) store = zarr.storage.FsspecStore(fs, path='noaa-nwm-retro-v2-zarr-pds', read_only=True) print(store) ``` When using an S3-compatible service other than AWS, pass the service endpoint to the filesystem via `client_kwargs={'endpoint_url': 'https://...'}`. ### Memory Store The [`zarr.storage.MemoryStore`][] stores Zarr data (metadata and chunks) in an in-memory dictionary: ```python exec="true" session="storage" source="above" result="ansi" data = {} store = zarr.storage.MemoryStore(data) array = zarr.create_array(store=store, shape=(2,), dtype='float64') print(array) ``` ### Object Store [`zarr.storage.ObjectStore`][] stores the contents of the Zarr hierarchy using any ObjectStore [storage implementation](https://developmentseed.org/obstore/latest/api/store/), including AWS S3 ([`obstore.store.S3Store`][]), Google Cloud Storage ([`obstore.store.GCSStore`][]), and Azure Blob Storage ([`obstore.store.AzureStore`][]). This store is backed by [obstore](https://developmentseed.org/obstore/latest/), which builds on the production quality Rust library [object_store](https://docs.rs/object_store/latest/object_store/). ```python exec="true" session="storage" source="above" result="ansi" from zarr.storage import ObjectStore from obstore.store import MemoryStore store = ObjectStore(MemoryStore()) array = zarr.create_array(store=store, shape=(2,), dtype='float64') print(array) ``` Here's an example of using ObjectStore for accessing remote data: ```python exec="true" session="storage" source="above" result="ansi" from zarr.storage import ObjectStore from obstore.store import S3Store s3_store = S3Store('noaa-nwm-retro-v2-zarr-pds', skip_signature=True, region="us-west-2") store = zarr.storage.ObjectStore(store=s3_store, read_only=True) group = zarr.open_group(store=store, mode='r') print(group.info) ``` !!! warning The [`zarr.storage.ObjectStore`][] class is experimental. ## Developing custom stores Zarr-Python [`zarr.abc.store.Store`][] API is meant to be extended. The Store Abstract Base Class includes all of the methods needed to be a fully operational store in Zarr Python. Zarr also provides a test harness for custom stores: [`zarr.testing.store.StoreTests`][]. See the [Custom stores](extending.md#custom-stores) section of the extending guide for more on implementing your own store. zarr-python-3.3.0/docs/user-guide/v3_migration.md000066400000000000000000000265311523267620000217500ustar00rootroot00000000000000# 3.0 Migration Guide Zarr-Python 3 represents a major refactor of the Zarr-Python codebase. Some of the goals motivating this refactor included: * adding support for the Zarr format 3 specification (along with the Zarr format 2 specification) * cleaning up internal and user facing APIs * improving performance (particularly in high latency storage environments like cloud object stores) To accommodate this, Zarr-Python 3 introduces a number of changes to the API, including a number of significant breaking changes and deprecations. This page provides a guide explaining breaking changes and deprecations to help you migrate your code from version 2 to version 3. If we have missed anything, please open a [GitHub issue](https://github.com/zarr-developers/zarr-python/issues/new) so we can improve this guide. !!! tip This page is about migrating your *code* from the Zarr-Python 2 API to the Zarr-Python 3 API. If you want to migrate the *metadata* of stored data from Zarr format 2 to Zarr format 3, see the `zarr migrate` command described in the [command-line interface documentation](cli.md). ## Compatibility target The goals described above necessitated some breaking changes to the API (hence the major version update), but where possible we have maintained backwards compatibility in the most widely used parts of the API. This includes the [`zarr.Array`][] and [`zarr.Group`][] classes and the "top-level API" (e.g. [`zarr.open_array`][] and [`zarr.open_group`][]). ## Getting ready for 3.0 Before migrating to Zarr-Python 3, we suggest projects that depend on Zarr-Python take the following actions in order: 1. Pin the supported Zarr-Python version to `zarr>=2,<3`. This is a best practice and will protect your users from any incompatibilities that may arise during the release of Zarr-Python 3. This pin can be removed after migrating to Zarr-Python 3. 2. Limit your imports from the Zarr-Python package. Most of the primary API `zarr.*` will be compatible in Zarr-Python 3. However, the following breaking API changes are planned: - `numcodecs.*` will no longer be available in `zarr.*`. To migrate, import codecs directly from `numcodecs`: ```python exec="false" reason="intentionally shows the old/incorrect import for contrast" from numcodecs import Blosc # instead of: # from zarr import Blosc ``` - The `zarr.v3_api_available` feature flag is being removed. In Zarr-Python 3 the v3 API is always available, so you shouldn't need to use this flag. - `zarr.errors` has been consolidated. Several exception classes from Zarr-Python 2 (such as `zarr.errors.PathNotFoundError`) have been removed or replaced. For example, missing nodes now raise `zarr.errors.NodeNotFoundError` (which subclasses both `BaseZarrError` and `FileNotFoundError`) instead of `zarr.errors.PathNotFoundError`. Review any code that catches exceptions from `zarr.errors` after migrating. - The following internal modules are being removed or significantly changed. If your application relies on imports from any of the below modules, you will need to either a) modify your application to no longer rely on these imports or b) vendor the parts of the specific modules that you need. * `zarr.attrs` has gone, with no replacement * `zarr.codecs` has changed, see "Codecs" section below for more information * `zarr.context` has gone, with no replacement * `zarr.core` remains but should be considered private API * `zarr.hierarchy` has gone, with no replacement (use `zarr.Group` in place of `zarr.hierarchy.Group`) * `zarr.indexing` has gone, with no replacement * `zarr.meta` has gone, with no replacement * `zarr.meta_v1` has gone, with no replacement * `zarr.sync` has gone, with no replacement * `zarr.types` has gone, with no replacement * `zarr.util` has gone, with no replacement * `zarr.n5` has gone, see below for an alternative N5 option 3. Test that your package works with version 3. 4. Update the pin to include `zarr>=3,<4`. ## Zarr-Python 2 support window Zarr-Python 2.x is still available, though we recommend migrating to Zarr-Python 3 for its performance improvements and new features. Security and bug fixes were made to the 2.x series for six months following the first Zarr-Python 3 release (January 2025); the 2.x series is no longer actively maintained. If you need to use the latest Zarr-Python 2 release, you can install it with: ```console $ pip install "zarr==2.*" ``` !!! note Development and maintenance of the 2.x release series has moved to the [support/v2](https://github.com/zarr-developers/zarr-python/tree/support/v2) branch. Issues and pull requests related to this branch are tagged with the [V2](https://github.com/zarr-developers/zarr-python/labels/V2) label. ## Migrating to Zarr-Python 3 The following sections provide details on breaking changes in Zarr-Python 3. ### The Array class 1. Disallow direct construction - the signature for initializing the `Array` class has changed significantly. Please use [`zarr.create_array`][] or [`zarr.open_array`][] instead of directly constructing the [`zarr.Array`][] class. 2. Defaulting to `zarr_format=3` - newly created arrays will use the version 3 of the Zarr specification. To continue using version 2, set `zarr_format=2` when creating arrays or set `default_zarr_format=2` in Zarr's runtime configuration. 3. Function signature change to [`zarr.Array.resize`][] - the `resize` function now takes a `zarr.core.common.ShapeLike` input rather than separate arguments for each dimension. Use `resize((10,10))` in place of `resize(10,10)`. ### The Group class 1. Disallow direct construction - use [`zarr.open_group`][] or [`zarr.create_group`][] instead of directly constructing the `zarr.Group` class. 2. The h5py compatibility methods `create_dataset` and `require_dataset` have been removed. Use the following replacements: - [`zarr.Group.create_array`][] in place of `Group.create_dataset` - [`zarr.Group.require_array`][] in place of `Group.require_dataset` 3. Disallow "." syntax for getting group members. To get a member of a group named `foo`, use `group["foo"]` in place of `group.foo`. 4. The `zarr.storage.init_group` low-level helper function has been removed. Use [`zarr.open_group`][] or [`zarr.create_group`][] instead: ```diff - from zarr.storage import init_group - init_group(store, overwrite=True, path="my/path") + import zarr + zarr.open_group(store, mode="w", path="my/path") ``` ### The Store class The Store API has changed significantly in Zarr-Python 3. #### The base store class The `MutableMapping` base class has been replaced in favor of a custom abstract base class ([`zarr.abc.store.Store`][]). An asynchronous interface is used for all store methods that use I/O. This change ensures that these store methods are non-blocking and are as performant as possible. #### Store implementations Store implementations have moved from the top-level module to `zarr.storage`: ```diff title="Store import changes from v2 to v3" # Before (v2) - from zarr import MemoryStore + from zarr.storage import MemoryStore ``` The following stores have been renamed or changed: | v2 | v3 | |------------------------|------------------------------------| | `DirectoryStore` | [`zarr.storage.LocalStore`][] | | `FSStore` | [`zarr.storage.FsspecStore`][] | | `TempStore` | Use [`tempfile.TemporaryDirectory`][] with [`LocalStore`][zarr.storage.LocalStore] | A number of deprecated stores were also removed. See [issue #1274](https://github.com/zarr-developers/zarr-python/issues/1274) for more details on the removal of these stores. - `N5Store` - see https://github.com/zarr-developers/n5py for an alternative interface to N5 formatted data. - `ABSStore` - use the [`zarr.storage.FsspecStore`][] instead along with fsspec's [adlfs backend](https://github.com/fsspec/adlfs). - `DBMStore` - `LMDBStore` - `SQLiteStore` - `MongoDBStore` - `RedisStore` The latter five stores in this list do not have an equivalent in Zarr-Python 3. If you are interested in developing a custom store that targets these backends, see [developing custom stores](storage.md#developing-custom-stores) or open an [issue](https://github.com/zarr-developers/zarr-python/issues) to discuss your use case. ### Codecs Codecs defined in ``numcodecs`` (and also imported into the ``zarr.codecs`` namespace in Zarr-Python 2) should still be used when creating Zarr format 2 arrays. Codecs for creating Zarr format 3 arrays are available in two locations: - `zarr.codecs` contains Zarr format 3 codecs that are defined in the [codecs section of the Zarr format 3 specification](https://zarr-specs.readthedocs.io/en/latest/v3/codecs/index.html). - `numcodecs.zarr3` contains codecs from `numcodecs` that can be used to create Zarr format 3 arrays, but are not necessarily part of the Zarr format 3 specification. ### Dependencies When installing using `pip`: - The new `remote` dependency group can be used to install a supported version of `fsspec`, required for remote data access. - The new `gpu` dependency group can be used to install a supported version of `cuda`, required for GPU functionality. - The `jupyter` optional dependency group has been removed, since v3 contains no jupyter specific functionality. ### Miscellaneous - The keyword argument `zarr_version` in most creation functions in `zarr` (e.g. [`zarr.create`][], [`zarr.open`][], [`zarr.group`][], [`zarr.array`][]) has been removed. Use `zarr_format` instead. ## Unimplemented Zarr-Python 2 features A few features of Zarr-Python 2 remain unimplemented in Zarr-Python 3. If any of the features listed below are important to your use case of Zarr-Python, please open (or comment on) a [GitHub issue](https://github.com/zarr-developers/zarr-python/issues/new). The following functions / methods have not been ported to Zarr-Python 3: - `zarr.copy` ([issue #2407](https://github.com/zarr-developers/zarr-python/issues/2407)) - `zarr.copy_all` ([issue #2407](https://github.com/zarr-developers/zarr-python/issues/2407)) - `zarr.copy_store` ([issue #2407](https://github.com/zarr-developers/zarr-python/issues/2407)) The following features (corresponding to function arguments to functions in `zarr`) have not been ported to Zarr-Python 3. Using these features will raise a warning or a `NotImplementedError`: - `cache_attrs` - `cache_metadata` - `chunk_store` ([issue #2495](https://github.com/zarr-developers/zarr-python/issues/2495)) - `meta_array` - `object_codec` ([issue #2617](https://github.com/zarr-developers/zarr-python/issues/2617)) - `synchronizer` ([issue #1596](https://github.com/zarr-developers/zarr-python/issues/1596)) The following features that were supported by Zarr-Python 2 have not been ported to Zarr-Python 3: - Object dtypes ([issue #2616](https://github.com/zarr-developers/zarr-python/issues/2616)) - Ragged arrays ([issue #2618](https://github.com/zarr-developers/zarr-python/issues/2618)) - Groups and Arrays do not implement `__enter__` and `__exit__` protocols ([issue #2619](https://github.com/zarr-developers/zarr-python/issues/2619)) - Default filters for object dtypes for Zarr format 2 arrays ([issue #2627](https://github.com/zarr-developers/zarr-python/issues/2627)) zarr-python-3.3.0/examples/000077500000000000000000000000001523267620000156335ustar00rootroot00000000000000zarr-python-3.3.0/examples/README.md000066400000000000000000000023411523267620000171120ustar00rootroot00000000000000# Zarr Python Examples This directory contains complete, runnable examples demonstrating various features and use cases of Zarr Python. ## Directory Structure Each example is organized in its own subdirectory with the following structure: ``` examples/ ├── example_name/ │ ├── README.md # Documentation for the example │ └── example_name.py # Python source code └── ... ``` ## Adding New Examples To add a new example: 1. Create a new subdirectory: `examples/my_example/` 2. Add your Python code: `examples/my_example/my_example.py` 3. Create documentation: `examples/my_example/README.md` 4. Create a documentation page at `docs/user-guide/examples/my_example.md`. The documentation page should simply link to the `README.md` and the source code, e.g.: ```` # docs/user-guide/examples/my_example.md --8<-- "examples/my_example/README.md" ## Source Code ```python --8<-- "examples/my_example/my_example.py" ``` ```` 5. Update `mkdocs.yml` to include the new example in the navigation. ### Example README.md Format Your README.md should include: - A title (`# Example Name`) - Description of what the example demonstrates - Instructions for running the example zarr-python-3.3.0/examples/codec_pipeline_performance/000077500000000000000000000000001523267620000231565ustar00rootroot00000000000000zarr-python-3.3.0/examples/codec_pipeline_performance/README.md000066400000000000000000000055421523267620000244430ustar00rootroot00000000000000# Codec Pipeline Performance This example compares the default `BatchedCodecPipeline` against the opt-in `FusedCodecPipeline` on a sharded array, across two stores (memory and local) and two codec regimes (uncompressed and gzip), at one worker and at `cpu_count`. A *codec pipeline* turns chunks of array data into stored bytes and back, running the configured codecs and performing the storage IO. The default `BatchedCodecPipeline` schedules both asynchronously -- roughly one coroutine per chunk operation. That model pays off for high-latency stores, where there is useful work to do while waiting on IO. For low-latency stores (in-process memory, the local filesystem) the IO completes too quickly for the overlap to be worth its cost, and the async scheduling becomes pure overhead. `FusedCodecPipeline` runs codec compute and synchronous IO synchronously, removing that overhead. It is [experimental](https://zarr.readthedocs.io/en/stable/user-guide/experimental/) and opt-in; the default pipeline is unchanged. ## What it shows - How to select a pipeline with `zarr.config.set`, and why the array must be *created* inside the config block: the pipeline class is resolved at array construction time and then travels with the array. - That the benefit depends strongly on layout and on whether compression is in play. Some configurations are slower under the fused pipeline -- the script reports speedups below 1.00x rather than hiding them. - That `codec_pipeline.max_workers` is read only by `FusedCodecPipeline`; the default pipeline ignores it entirely. ## Running ```bash uv run codec_pipeline_performance.py ``` The script has no arguments and writes only to an in-memory store. ## Interpreting the output The numbers are specific to your CPU, your Python build, and the workload chosen here. They are a measurement of your machine, not a published benchmark -- treat a single run as indicative and re-measure against your own data and store before switching pipelines in production. Two effects are worth watching for: - **The two codec regimes tell opposite stories about `max_workers`.** Uncompressed IO is dominated by per-chunk *scheduling*, so `Fused (1 worker)` is already fastest and a thread pool only adds overhead. gzip is genuinely CPU-bound: a single worker compresses chunk after chunk sequentially and can be *slower than the default*, while a thread pool spreads that compression over cores and reclaims the win. That flip is why the fused pipeline is threaded by default, and why pinning `max_workers=1` is worth it for memory-backed uncompressed data. - **Chunk size decides whether threading can help at all.** The 64×64 inner chunks here are small enough that per-chunk scheduling dominates uncompressed IO, yet large enough that per-chunk gzip is real work to parallelize. Much coarser chunks leave the pool with too few items to spread. zarr-python-3.3.0/examples/codec_pipeline_performance/codec_pipeline_performance.py000066400000000000000000000203711523267620000310560ustar00rootroot00000000000000# /// script # requires-python = ">=3.11" # dependencies = [ # "zarr @ git+https://github.com/zarr-developers/zarr-python.git@main", # "numpy", # ] # /// """ Compare the `BatchedCodecPipeline` and the `FusedCodecPipeline`. The default `BatchedCodecPipeline` schedules storage IO and codec compute asynchronously -- roughly one coroutine per chunk operation. For a *sharded* array that means one coroutine per inner chunk inside every shard. That is the right model for high-latency stores, where there is useful work to do while waiting for IO. For low-latency stores (in-process memory, the local filesystem) the IO completes too quickly for the overlap to pay for itself, and the scheduling becomes pure overhead. The `FusedCodecPipeline` runs codec compute and synchronous IO synchronously, removing that overhead. Whether it wins, and whether its thread pool helps, depends on which resource is actually scarce: * Uncompressed IO is dominated by per-chunk *scheduling*, not compute. There is nothing for a thread pool to parallelize, so a single worker is already fastest and extra workers only add overhead. * gzip is genuinely CPU-bound. A single worker compresses every chunk sequentially and can be *slower than the default*, while a thread pool spreads that compression across cores and reclaims the win. This is when `max_workers > 1` earns its keep. Run it with: uv run codec_pipeline_performance.py Numbers are hardware-, layout-, and codec-dependent. Treat the output as a measurement of *your* machine, not as a published benchmark. """ from __future__ import annotations import operator import os import statistics import tempfile import timeit from pathlib import Path from typing import TYPE_CHECKING import numpy as np import zarr from zarr.storage import LocalStore, MemoryStore if TYPE_CHECKING: from collections.abc import Callable from zarr.abc.store import Store BATCHED = "zarr.core.codec_pipeline.BatchedCodecPipeline" FUSED = "zarr.core.codec_pipeline.FusedCodecPipeline" # gzip is CPU-bound to encode, which is exactly the regime where the thread # pool matters. Level 6 is gzip's own default. GZIP = {"name": "gzip", "configuration": {"level": 6}} # 4096x4096 int32 = 64 MiB, split into 16 shards of 1024x1024, each holding # 16x16 = 256 inner chunks of 64x64 -> 4096 inner chunks in total. The chunks # are small enough that per-chunk coroutine scheduling dominates uncompressed # IO, yet large enough that per-chunk gzip is real work to spread over cores. SHAPE = (4096, 4096) SHARDS = (1024, 1024) CHUNKS = (64, 64) DTYPE = "int32" CONFIGS: tuple[tuple[str, dict[str, object]], ...] = ( ("Batched (default)", {"codec_pipeline.path": BATCHED}), ("Fused (1 worker)", {"codec_pipeline.path": FUSED, "codec_pipeline.max_workers": 1}), ("Fused (cpu_count)", {"codec_pipeline.path": FUSED, "codec_pipeline.max_workers": None}), ) def time_call(fn: Callable[[], object], repeat: int = 3) -> float: """Median wall-clock seconds for one call to `fn`. `timeit.Timer` supplies `perf_counter` and disables the cyclic garbage collector during each run, so a collection triggered by earlier work cannot land inside a measurement. `number=1` because a single call here already moves 64 MiB -- the per-call overhead `timeit` amortizes is irrelevant at this scale. """ return statistics.median(timeit.Timer(fn).repeat(repeat=repeat, number=1)) def measure( settings: dict[str, object], store: Store, data: np.ndarray, compressors: object, ) -> tuple[float, float]: """Time one full write and one full read of `data` under `settings`. The whole operation runs inside `zarr.config.set`, not just the array construction. The pipeline class is resolved when the array is built, but `codec_pipeline.max_workers` is read *per operation*, so a timed call made outside the config block would silently use whatever worker count was globally in effect -- which makes every configuration look identical. """ everything = slice(None) def write_once() -> None: with zarr.config.set(settings): array = zarr.create_array( store=store, shape=SHAPE, chunks=CHUNKS, shards=SHARDS, dtype=DTYPE, compressors=compressors, fill_value=0, overwrite=True, ) operator.setitem(array, everything, data) write = time_call(write_once) # The bytes on disk are identical whichever pipeline wrote them, so reading # back what we just wrote isolates read performance on the same data. def read_once() -> object: with zarr.config.set(settings): return zarr.open_array(store=store, mode="r")[everything] read = time_call(read_once) if not np.array_equal(read_once(), data): raise AssertionError("round trip mismatch") return write, read def make_store(kind: str, tmp: Path) -> Store: if kind == "memory": return MemoryStore() return LocalStore(tmp / f"demo_{kind}_{os.getpid()}.zarr") def main() -> None: n_cpu = os.cpu_count() or 1 # Each regime gets the data that actually exercises it. `arange` is # trivially compressible, which is fine when nothing compresses it, but it # would make gzip finish almost instantly and hide the CPU-bound behavior # this example is about. The noisy array keeps gzip genuinely busy. n = int(np.prod(SHAPE)) plain_data = np.arange(n, dtype=DTYPE).reshape(SHAPE) noisy_data = np.random.default_rng(0).integers(0, 2**24, size=SHAPE, dtype=DTYPE) n_shards = int(np.prod([s // c for s, c in zip(SHAPE, SHARDS, strict=True)])) per_shard = int(np.prod([s // c for s, c in zip(SHARDS, CHUNKS, strict=True)])) print(f"zarr {zarr.__version__} | {n_cpu} CPUs") print( f"array {SHAPE} {DTYPE} = {plain_data.nbytes / 2**20:.0f} MiB | " f"{n_shards} shards x {per_shard} inner chunks = {n_shards * per_shard} chunks\n" ) with tempfile.TemporaryDirectory() as tmp: for store_kind in ("memory", "local"): for codec_label, compressors, data in ( ("uncompressed", None, plain_data), ("gzip-6 (CPU-bound)", GZIP, noisy_data), ): print(f"=== {store_kind} store / {codec_label} ===") print( f"{'pipeline':<22}{'write (s)':>11}{'vs base':>10}" f"{'read (s)':>12}{'vs base':>10}" ) results: dict[str, tuple[float, float]] = {} for label, settings in CONFIGS: store = make_store(store_kind, Path(tmp)) results[label] = measure(settings, store, data, compressors) base_write, base_read = results[CONFIGS[0][0]] for label, (write, read) in results.items(): print( f"{label:<22}{write:>10.3f}{base_write / write:>9.1f}x" f"{read:>11.3f}{base_read / read:>9.1f}x" ) # The headline comparison: does the thread pool earn its keep? single_write, single_read = results["Fused (1 worker)"] pool_write, pool_read = results["Fused (cpu_count)"] print( f" workers (cpu_count vs 1 worker): " f"write {single_write / pool_write:.1f}x " f"read {single_read / pool_read:.1f}x" ) print() print( "Reading it:\n" " * Uncompressed IO is scheduling-bound, so Fused (1 worker) is already\n" " fastest -- a thread pool has nothing to parallelize and only adds\n" " overhead.\n" " * gzip is CPU-bound, so Fused (1 worker) can be *slower* than the\n" " default, while Fused (cpu_count) spreads compression across cores\n" " and reclaims the win. That flip is why the fused pipeline is\n" " threaded by default, and why pinning max_workers=1 is worth it for\n" " memory-backed uncompressed data.\n" " * `codec_pipeline.max_workers` is read only by the FusedCodecPipeline;\n" " the default BatchedCodecPipeline ignores it." ) if __name__ == "__main__": main() zarr-python-3.3.0/examples/custom_dtype/000077500000000000000000000000001523267620000203525ustar00rootroot00000000000000zarr-python-3.3.0/examples/custom_dtype/README.md000066400000000000000000000016161523267620000216350ustar00rootroot00000000000000# Custom Data Type This example demonstrates how to extend Zarr Python by defining a new data type. The example shows how to: - Define a custom `ZDType` class for the `int2` data type from [`ml_dtypes`](https://pypi.org/project/ml-dtypes/) - Implement all required methods for serialization and deserialization - Register the custom data type with Zarr's registry - Create and use arrays with the custom data type in both Zarr v2 and v3 formats ## Running the Example The script declares its dependencies inline ([PEP 723](https://peps.python.org/pep-0723/)), so the easiest way to run it is with [uv](https://docs.astral.sh/uv/), which installs them automatically: ```bash uv run examples/custom_dtype/custom_dtype.py ``` Alternatively, run it with plain Python, in which case you must first install `zarr`, `ml_dtypes`, and `pytest` yourself: ```bash python examples/custom_dtype/custom_dtype.py ``` zarr-python-3.3.0/examples/custom_dtype/custom_dtype.py000066400000000000000000000220211523267620000234400ustar00rootroot00000000000000# /// script # requires-python = ">=3.12" # dependencies = [ # "zarr @ git+https://github.com/zarr-developers/zarr-python.git@main", # "ml_dtypes==0.5.4", # "pytest==8.4.1" # ] # /// # """ Demonstrate how to extend Zarr Python by defining a new data type """ import json import sys from pathlib import Path from typing import ClassVar, Literal, Self, TypeGuard, overload import ml_dtypes # necessary to add extra dtypes to NumPy import numpy as np import pytest import zarr from zarr.dtype import ZDType, check_dtype_spec_v2, data_type_registry from zarr.errors import DataTypeValidationError from zarr.types import JSON, DTypeConfig_V2, DTypeJSON, ZarrFormat # This is the int2 array data type int2_dtype_cls = type(np.dtype("int2")) # This is the int2 scalar type int2_scalar_cls = ml_dtypes.int2 class Int2(ZDType[int2_dtype_cls, int2_scalar_cls]): """ This class provides a Zarr compatibility layer around the int2 data type (the ``dtype`` of a NumPy array of type int2) and the int2 scalar type (the ``dtype`` of the scalar value inside an int2 array). """ # This field is as the key for the data type in the internal data type registry, and also # as the identifier for the data type when serializaing the data type to disk for zarr v3 _zarr_v3_name: ClassVar[Literal["int2"]] = "int2" # this field will be used internally _zarr_v2_name: ClassVar[Literal["int2"]] = "int2" # we bind a class variable to the native data type class so we can create instances of it dtype_cls = int2_dtype_cls @classmethod def from_native_dtype(cls, dtype: np.dtype) -> Self: """Create an instance of this ZDType from a native dtype.""" if cls._check_native_dtype(dtype): return cls() raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self: Self) -> int2_dtype_cls: """Create an int2 dtype instance from this ZDType""" return self.dtype_cls() @classmethod def _check_json_v2(cls, data: DTypeJSON) -> TypeGuard[DTypeConfig_V2[Literal["|b1"], None]]: """ Type check for Zarr v2-flavored JSON. This will check that the input is a dict like this: .. code-block:: json { "name": "int2", "object_codec_id": None } Note that this representation differs from the ``dtype`` field looks like in zarr v2 metadata. Specifically, whatever goes into the ``dtype`` field in metadata is assigned to the ``name`` field here. See the Zarr docs for more information about the JSON encoding for data types. """ return ( check_dtype_spec_v2(data) and data["name"] == "int2" and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[Literal["int2"]]: """ Type check for Zarr V3-flavored JSON. Checks that the input is the string "int2". """ return data == cls._zarr_v3_name @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this ZDType from Zarr V3-flavored JSON. """ if cls._check_json_v2(data): return cls() # This first does a type check on the input, and if that passes we create an instance of the ZDType. msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v2_name!r}" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls: type[Self], data: DTypeJSON) -> Self: """ Create an instance of this ZDType from Zarr V3-flavored JSON. This first does a type check on the input, and if that passes we create an instance of the ZDType. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal["int2"], None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> Literal["int2"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal["int2"], None] | Literal["int2"]: """ Serialize this ZDType to v2- or v3-flavored JSON If the zarr_format is 2, then return a dict like this: .. code-block:: json { "name": "int2", "object_codec_id": None } If the zarr_format is 3, then return the string "int2" """ if zarr_format == 2: return {"name": "int2", "object_codec_id": None} if zarr_format == 3: return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[int | ml_dtypes.int2]: """ Check if a python object is a valid int2-compatible scalar The strictness of this type check is an implementation degree of freedom. You could be strict here, and only accept int2 values, or be open and accept any integer or any object and rely on exceptions from the int2 constructor that will be called in cast_scalar. """ return isinstance(data, (int, int2_scalar_cls)) def cast_scalar(self, data: object) -> ml_dtypes.int2: """ Attempt to cast a python object to an int2. We first perform a type check to ensure that the input type is appropriate, and if that passes we call the int2 scalar constructor. """ if self._check_scalar(data): return ml_dtypes.int2(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> ml_dtypes.int2: """ Get the default scalar value. This will be used when automatically selecting a fill value. """ return ml_dtypes.int2(0) def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> int: """ Convert a python object to a JSON representation of an int2 scalar. This is necessary for taking user input for the ``fill_value`` attribute in array metadata. In this implementation, we optimistically convert the input to an int, and then check that it lies in the acceptable range for this data type. """ # We could add a type check here, but we don't need to for this example val: int = int(data) # type: ignore[call-overload] if val in {-2, -1, 0, 1}: return val raise ValueError("Invalid value. Expected -2, -1, 0, or 1.") def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> ml_dtypes.int2: """ Read a JSON-serializable value as an int2 scalar. We first perform a type check to ensure that the JSON value is well-formed, then call the int2 scalar constructor. The base definition of this method requires that it take a zarr_format parameter because other data types serialize scalars differently in zarr v2 and v3, but we don't use this here. """ if self._check_scalar(data): return ml_dtypes.int2(data) raise TypeError(f"Invalid type: {data}. Expected an int.") # after defining dtype class, it must be registered with the data type registry so zarr can use it data_type_registry.register(Int2._zarr_v3_name, Int2) # this parametrized function will create arrays in zarr v2 and v3 using our new data type @pytest.mark.parametrize("zarr_format", [2, 3]) def test_custom_dtype(tmp_path: Path, zarr_format: ZarrFormat) -> None: # create array and write values z_w = zarr.create_array( store=tmp_path, shape=(4,), dtype="int2", zarr_format=zarr_format, compressors=None, ) z_w[:] = [-1, -2, 0, 1] # open the array z_r = zarr.open_array(tmp_path, mode="r") print(z_r.info_complete()) # look at the array metadata meta_file = tmp_path / (".zarray" if zarr_format == 2 else "zarr.json") print(json.dumps(json.loads(meta_file.read_text()), indent=2)) if __name__ == "__main__": # Run the example with printed output, and a dummy pytest configuration file specified. # Without the dummy configuration file, at test time pytest will attempt to use the # configuration file in the project root, which will error because Zarr is using some # plugins that are not installed in this example. sys.exit( pytest.main( [ "-s", __file__, f"-c {__file__}", # Suppress: "PytestAssertRewriteWarning: Module already imported so # cannot be rewritten; zarr" "-W", "ignore::pytest.PytestAssertRewriteWarning", ] ) ) zarr-python-3.3.0/examples/sharding_coalescing/000077500000000000000000000000001523267620000216215ustar00rootroot00000000000000zarr-python-3.3.0/examples/sharding_coalescing/README.md000066400000000000000000000057021523267620000231040ustar00rootroot00000000000000# Sharded Read Coalescing This example demonstrates byte-range coalescing for partial reads of sharded arrays, a performance optimization added in Zarr-Python 3.3.0 and enabled by default. A shard is one stored object containing many inner chunks, each occupying its own byte range. Reading N inner chunks could mean N separate byte-range requests. Because byte ranges are intervals, nearby ranges can be merged: `[a, b)` and `[b, c)` together cover `[a, c)`, so a single request can serve both. Merging trades reading some bytes you did not ask for against issuing fewer requests -- worthwhile whenever a request is expensive, as with object storage. ## What it shows - Reading scattered inner chunks from one shard with coalescing **off** issues one store request per inner chunk; with the **default** settings the same read collapses to a single request. - The resulting wall-clock difference against a store with simulated latency. - That coalescing changes only *how* data is fetched, never *what* is returned -- the script asserts both configurations produce identical arrays. - A case where coalescing changes nothing: a contiguous selection already has adjacent byte ranges, so it merges under any setting. ## Running ```bash uv run sharding_coalescing.py ``` ## How the comparison is set up Two details make the effect observable, and both are worth understanding if you adapt this script: - **The selection must have gaps.** A contiguous read produces adjacent byte ranges that merge regardless of configuration. The strided selections skip inner chunks, creating the gaps that the `sharding_coalesce_max_gap_bytes` budget decides whether to bridge. - **Latency must be charged per merged fetch.** The example defines a small `WrapperStore` subclass that sleeps in `get`. It deliberately does *not* keep `WrapperStore.get_ranges`, which forwards straight to the wrapped store and would bypass the latency entirely; inheriting the `Store` ABC's `get_ranges` instead runs the coalescer over its own `get`, so each merged fetch pays once. `zarr.testing.store` ships a ready-made `LatencyStore`, but importing it pulls in `pytest`. Defining the wrapper inline keeps the example runnable with only `zarr` and `numpy` installed. ## Configuration Two settings control the behavior, both settable globally via `zarr.config` or per array via `config=` on `zarr.create_array` / `Array.with_config`: | Setting | Default | Meaning | | --- | --- | --- | | `sharding_coalesce_max_gap_bytes` | 1 MiB | Merge two ranges only if the gap between them is no larger than this | | `sharding_coalesce_max_bytes` | 16 MiB | Never let a merged read exceed this size | Setting the gap to `0` merges only exactly-adjacent ranges, which approximates the pre-3.3.0 behavior; that is how the example emulates the old path. Raising the gap reads more unwanted bytes in exchange for fewer round trips -- the right value depends on how expensive a request is against how fast your link is. zarr-python-3.3.0/examples/sharding_coalescing/sharding_coalescing.py000066400000000000000000000205211523267620000261610ustar00rootroot00000000000000# /// script # requires-python = ">=3.11" # dependencies = [ # "zarr @ git+https://github.com/zarr-developers/zarr-python.git@main", # "numpy", # ] # /// """ Demonstrate byte-range coalescing for partial reads of sharded arrays. A shard is a single stored object holding many inner chunks, each occupying its own byte range. Reading N inner chunks could mean issuing N separate byte-range requests to the store. Because byte ranges are intervals, a reader can instead merge nearby ranges: `[a, b)` and `[b, c)` together cover `[a, c)`, so one request can serve both. Merging trades reading some bytes you did not ask for against issuing fewer requests -- a good trade whenever a request is expensive, which is the normal case for object storage. Zarr-Python 3.3.0 does this automatically. Two settings control it: * `sharding_coalesce_max_gap_bytes` (default 1 MiB) -- merge two ranges only if the gap between them is no larger than this. * `sharding_coalesce_max_bytes` (default 16 MiB) -- never let a merged read exceed this size. Setting the gap to 0 disables merging of non-adjacent ranges, which approximates the pre-3.3.0 behavior. This script compares the two, counting store requests and measuring wall-clock time against a store with simulated latency. Run it with: uv run sharding_coalescing.py """ from __future__ import annotations import asyncio import operator import statistics import timeit from contextlib import contextmanager from functools import partial from typing import TYPE_CHECKING import numpy as np import zarr import zarr.core._coalesce as coalesce_module from zarr.abc.store import ByteRequest, RangeByteRequest, Store from zarr.storage import MemoryStore, WrapperStore if TYPE_CHECKING: from collections.abc import Callable, Iterator, Sequence from zarr.core.buffer import Buffer, BufferPrototype # Emulates the pre-3.3.0 behavior: with a zero gap budget, only ranges that are # exactly adjacent get merged, so scattered inner chunks are fetched one by one. NO_COALESCING = {"sharding_coalesce_max_gap_bytes": 0} # The shipped defaults. Spelled out here so the comparison is explicit rather # than relying on whatever the global config happens to be. DEFAULT_COALESCING = { "sharding_coalesce_max_gap_bytes": 1 << 20, # 1 MiB "sharding_coalesce_max_bytes": 16 << 20, # 16 MiB } GET_LATENCY_S = 0.005 # 5 ms per request, a modest stand-in for object storage class PerRequestLatencyStore(WrapperStore[Store]): """Wraps a store, charging a fixed latency per byte-range fetch. `zarr.testing.store` ships a `LatencyStore`, but importing it pulls in `pytest`; defining the wrapper here keeps this example runnable with only zarr and numpy installed. Two details matter for the measurement: * The latency is applied in `get`, which is what an individual fetch costs. * `get_ranges` is explicitly *not* overridden to forward to the wrapped store. `WrapperStore.get_ranges` does forward, which would skip this class's `get` entirely and make every configuration look identical. Inheriting the `Store` ABC's implementation instead runs the coalescer over `self.get`, so each *merged* fetch pays the latency once -- which is exactly the cost coalescing exists to reduce. """ get_ranges = Store.get_ranges def __init__(self, store: Store, *, get_latency: float) -> None: super().__init__(store) self.get_latency = get_latency def _with_store(self, store: Store) -> PerRequestLatencyStore: # `WrapperStore` rebuilds the wrapper when opening read-only, so the # latency setting has to be carried across. return type(self)(store, get_latency=self.get_latency) async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: await asyncio.sleep(self.get_latency) return await self._store.get(key, prototype, byte_range) @contextmanager def counting_requests() -> Iterator[Callable[[], int]]: """Count the store fetches issued inside the block. Wraps the coalescing planner rather than the store: every merged group it returns, plus every range it declined to merge, becomes exactly one fetch. Counting here rather than at the store means the number reported is the planner's decision, which is precisely what the settings control. """ original = coalesce_module.coalesce_ranges total = 0 def counting_coalesce_ranges( byte_ranges: Sequence[ByteRequest | None], *, max_gap_bytes: int, max_coalesced_bytes: int, ) -> tuple[ list[list[tuple[int, RangeByteRequest]]], list[tuple[int, ByteRequest | None]], ]: nonlocal total groups, uncoalescable = original( byte_ranges, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ) total += len(groups) + len(uncoalescable) return groups, uncoalescable coalesce_module.coalesce_ranges = counting_coalesce_ranges try: yield lambda: total finally: coalesce_module.coalesce_ranges = original def measure_read(array: zarr.Array, selection: slice) -> tuple[int, float]: """Return (store fetches, median seconds) for reading `selection`.""" read = partial(operator.getitem, array, selection) with counting_requests() as fetches: result = read() requests = fetches() # `timeit.Timer` supplies the loop, `perf_counter`, and GC handling. The # median of several runs keeps one unlucky run from dominating. elapsed = statistics.median(timeit.Timer(read).repeat(repeat=5, number=1)) assert result.size > 0 # a read that returned nothing would time as "fast" return requests, elapsed def main() -> None: n = 8192 chunk = 64 inner_chunks = n // chunk base = MemoryStore() source = (np.arange(n, dtype="uint64") % 251).astype("uint8") # One shard holding every inner chunk, uncompressed so inner-chunk byte # offsets stay predictable and the demonstration is easy to reason about. writable = zarr.create_array( store=base, shape=(n,), chunks=(chunk,), shards=(n,), dtype="uint8", compressors=None ) writable[:] = source store = PerRequestLatencyStore(base, get_latency=GET_LATENCY_S) print(f"zarr {zarr.__version__}") print(f"array: {n} uint8 values, {inner_chunks} inner chunks of {chunk} in a single shard") print(f"store: MemoryStore wrapped with {GET_LATENCY_S * 1000:.0f} ms of latency per request\n") # A strided selection touches inner chunks with unread chunks in between, # so there are real gaps for the coalescer to bridge. A contiguous # selection would merge under any setting, since its ranges are adjacent. selections = { "every 2nd inner chunk": slice(None, None, chunk * 2), "every 4th inner chunk": slice(None, None, chunk * 4), "contiguous quarter": slice(0, n // 4), } header = f"{'selection':<24} {'coalescing':<12} {'requests':>9} {'time':>10}" print(header) print("-" * len(header)) for label, selection in selections.items(): results = {} for mode, config in (("off", NO_COALESCING), ("default", DEFAULT_COALESCING)): array = zarr.open_array(store=store, mode="r").with_config(config) requests, elapsed = measure_read(array, selection) results[mode] = (requests, elapsed) print(f"{label:<24} {mode:<12} {requests:>9} {elapsed * 1000:>9.1f}ms") off_requests, off_time = results["off"] on_requests, on_time = results["default"] if on_requests < off_requests: print( f"{'':<24} {'->':<12} " f"{off_requests // on_requests:>8}x fewer {off_time / on_time:>9.1f}x faster" ) else: print(f"{'':<24} {'->':<12} {'no change (ranges already adjacent)':>30}") print() # Correctness is the point: coalescing must not change what you read back. for mode, config in (("off", NO_COALESCING), ("default", DEFAULT_COALESCING)): array = zarr.open_array(store=store, mode="r").with_config(config) assert np.array_equal(array[::128], source[::128]), mode print("Both configurations return identical data; coalescing only changes how it is fetched.") if __name__ == "__main__": main() zarr-python-3.3.0/lychee.toml000066400000000000000000000017541523267620000161720ustar00rootroot00000000000000# Configuration for the lychee link checker (https://lychee.cli.rs/). # Auto-discovered as ./lychee.toml by the lychee GitHub Action. # Treat redirect status codes as success rather than failures. accept = ["200..=299"] # Files lychee should not scan for links. exclude_path = [ # mkdocs-material theme overrides: hrefs are Jinja expressions like # `{{ '../' ~ base_url }}`, not real URLs, so lychee cannot resolve them. "docs/overrides", # Design notes: working records that point at transient artifacts (commits, # fork branches, compare URLs) which are expected to disappear over time. "design", ] # URL patterns to ignore (regex, matched against the full URL). exclude = [ # Local docs preview server shown in the contributing guide ("hatch run serve"), # documentation of a command rather than a reachable link. '^https?://0\.0\.0\.0', '^https?://(localhost|127\.0\.0\.1)(:\d+)?', # SPEC 0 page times out but is valid. '^https://scientific-python\.org/specs/spec-0000', ] zarr-python-3.3.0/mkdocs.yml000066400000000000000000000367501523267620000160330ustar00rootroot00000000000000# Based on https://github.com/developmentseed/obspec/blob/main/mkdocs.yml site_name: zarr-python repo_name: zarr-developers/zarr-python repo_url: https://github.com/zarr-developers/zarr-python site_description: An implementation of chunked, compressed, N-dimensional arrays for Python. site_author: Alistair Miles site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://zarr.readthedocs.io/'] docs_dir: docs use_directory_urls: true nav: - "index.md" - "quick-start.md" - User Guide: - user-guide/index.md - user-guide/installation.md - user-guide/arrays.md - user-guide/groups.md - user-guide/attributes.md - user-guide/data_types.md - user-guide/storage.md - user-guide/config.md - user-guide/performance.md - user-guide/cli.md - user-guide/extending.md - user-guide/gpu.md - user-guide/consolidated_metadata.md - user-guide/experimental.md - user-guide/v3_migration.md - user-guide/glossary.md - Examples: - user-guide/examples/custom_dtype.md - user-guide/examples/rectilinear_chunks.md - user-guide/examples/codec_pipeline_performance.md - user-guide/examples/sharding_coalescing.md - API Reference: - api/zarr/index.md - ' zarr.abc': - api/zarr/abc/index.md - ' zarr.abc.buffer': api/zarr/abc/buffer.md - ' zarr.abc.codec': api/zarr/abc/codec.md - ' zarr.abc.metadata': api/zarr/abc/metadata.md - ' zarr.abc.numcodec': api/zarr/abc/numcodec.md - ' zarr.abc.store': api/zarr/abc/store.md - ' zarr.api': - api/zarr/api/index.md - ' zarr.api.asynchronous': api/zarr/api/asynchronous.md - ' zarr.api.synchronous': api/zarr/api/synchronous.md - ' zarr.Array': api/zarr/array.md - ' zarr.array': api/zarr/functions/array.md - ' zarr.buffer': - api/zarr/buffer/index.md - ' zarr.buffer.cpu': api/zarr/buffer/cpu.md - ' zarr.buffer.gpu': api/zarr/buffer/gpu.md - ' zarr.codecs': api/zarr/codecs.md - ' zarr.codecs.numcodecs': api/zarr/codecs/numcodecs.md - ' zarr.config': api/zarr/config.md - ' zarr.consolidate_metadata': api/zarr/functions/consolidate_metadata.md - ' zarr.create': api/zarr/functions/create.md - ' zarr.create_array': api/zarr/functions/create_array.md - ' zarr.create_group': api/zarr/functions/create_group.md - ' zarr.create_hierarchy': api/zarr/functions/create_hierarchy.md - ' zarr.dtype': api/zarr/dtype.md - ' zarr.empty': api/zarr/functions/empty.md - ' zarr.empty_like': api/zarr/functions/empty_like.md - ' zarr.errors': api/zarr/errors.md - ' zarr.experimental': api/zarr/experimental.md - ' zarr.from_array': api/zarr/functions/from_array.md - ' zarr.full': api/zarr/functions/full.md - ' zarr.full_like': api/zarr/functions/full_like.md - ' zarr.Group': api/zarr/group.md - ' zarr.group': api/zarr/functions/group.md - ' zarr.load': api/zarr/functions/load.md - ' zarr.metadata': api/zarr/metadata.md - ' zarr.ones': api/zarr/functions/ones.md - ' zarr.ones_like': api/zarr/functions/ones_like.md - ' zarr.open': api/zarr/functions/open.md - ' zarr.open_array': api/zarr/functions/open_array.md - ' zarr.open_consolidated': api/zarr/functions/open_consolidated.md - ' zarr.open_group': api/zarr/functions/open_group.md - ' zarr.open_like': api/zarr/functions/open_like.md - ' zarr.print_debug_info': api/zarr/functions/print_debug_info.md - ' zarr.registry': api/zarr/registry.md - ' zarr.save': api/zarr/functions/save.md - ' zarr.save_array': api/zarr/functions/save_array.md - ' zarr.save_group': api/zarr/functions/save_group.md - ' zarr.storage': api/zarr/storage.md - ' zarr.testing': - api/zarr/testing/index.md - ' zarr.testing.buffer': api/zarr/testing/buffer.md - ' zarr.testing.stateful': api/zarr/testing/stateful.md - ' zarr.testing.store': api/zarr/testing/store.md - ' zarr.testing.strategies': api/zarr/testing/strategies.md - ' zarr.testing.utils': api/zarr/testing/utils.md - ' zarr.zeros': api/zarr/functions/zeros.md - ' zarr.zeros_like': api/zarr/functions/zeros_like.md - 'zarr-metadata ↪': https://zarr-metadata.readthedocs.io/ - release-notes.md - contributing.md - Blog: - blog/index.md hooks: - mkdocs_hooks.py watch: - src/zarr - docs theme: language: en name: material custom_dir: docs/overrides logo: _static/logo_bw.png favicon: _static/favicon-96x96.png palette: # Light mode - media: "(prefers-color-scheme: light)" scheme: default primary: custom accent: custom toggle: icon: material/brightness-7 name: Switch to dark mode # Dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: custom accent: custom toggle: icon: material/brightness-4 name: Switch to light mode font: text: Roboto code: Roboto Mono features: - content.code.annotate - content.code.copy - navigation.indexes - navigation.instant - navigation.tracking - search.suggest - search.share extra: social: - icon: fontawesome/brands/mastodon link: https://fosstodon.org/@zarr - icon: fontawesome/brands/bluesky link: https://bsky.app/profile/zarr.dev extra_css: - overrides/stylesheets/extra.css plugins: - autorefs - blog: blog_dir: blog post_dir: "{blog}/posts" post_url_format: "{slug}" # The blog is a simple reverse-chronological list of posts; the archive # and category indexes add navigation we don't have the volume to justify. archive: false categories: false - search - markdown-exec - mkdocstrings: enable_inventory: true handlers: python: paths: [src/zarr] options: allow_inspection: true docstring_section_style: list docstring_style: numpy inherited_members: true line_length: 60 separate_signature: true show_root_heading: true show_signature_annotations: true show_source: true show_symbol_type_toc: true signature_crossrefs: true show_if_no_docstring: true extensions: - griffe_inherited_docstrings inventories: - https://docs.python.org/3/objects.inv - https://docs.xarray.dev/en/stable/objects.inv - https://numpy.org/doc/stable/objects.inv - https://numcodecs.readthedocs.io/en/stable/objects.inv - https://developmentseed.org/obstore/latest/objects.inv - https://filesystem-spec.readthedocs.io/en/latest/objects.inv - https://requests.readthedocs.io/en/latest/objects.inv - https://docs.aiohttp.org/en/stable/objects.inv - https://s3fs.readthedocs.io/en/latest/objects.inv - https://docs.h5py.org/en/stable/objects.inv - https://icechunk.io/en/stable/objects.inv - https://lithops-cloud.github.io/docs/objects.inv - https://docs.dask.org/en/stable/objects.inv - redirects: redirect_maps: 'spec/index.md': 'https://zarr-specs.readthedocs.io' 'spec/v1.md': 'https://zarr-specs.readthedocs.io/en/latest/v1/v1.0.html' 'spec/v2.md': 'https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html' 'spec/v3.md': 'https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html' 'license.md': 'https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt' 'genindex.html.md': 'index.md' 'py-modindex.html.md': 'index.md' 'search.html.md': 'index.md' 'tutorial.md': 'user-guide/installation.md' 'getting-started.md': 'quick-start.md' 'roadmap.md': 'https://zarr.readthedocs.io/en/v3.0.8/developers/roadmap.html' 'installation.md': 'user-guide/installation.md' 'release.md': 'release-notes.md' 'about.html.md': 'index.md' 'arrays.html.md': 'user-guide/arrays.md' 'attributes.html.md': 'user-guide/attributes.md' 'cli.html.md': 'user-guide/cli.md' 'config.html.md': 'user-guide/config.md' 'consolidated_metadata.html.md': 'user-guide/consolidated_metadata.md' 'data_types.html.md': 'user-guide/data_types.md' 'extending.html.md': 'user-guide/extending.md' 'gpu.html.md': 'user-guide/gpu.md' 'groups.html.md': 'user-guide/groups.md' 'installation.html.md': 'user-guide/installation.md' 'performance.html.md': 'user-guide/performance.md' 'quickstart.html.md': 'quick-start.md' 'release-notes.html.md': 'release-notes.md' 'storage.html.md': 'user-guide/storage.md' 'v3_migration.html.md': 'user-guide/v3_migration.md' 'user-guide/arrays.html.md': 'user-guide/arrays.md' 'user-guide/attributes.html.md': 'user-guide/attributes.md' 'user-guide/cli.html.md': 'user-guide/cli.md' 'user-guide/config.html.md': 'user-guide/config.md' 'user-guide/consolidated_metadata.html.md': 'user-guide/consolidated_metadata.md' 'user-guide/data_types.html.md': 'user-guide/data_types.md' 'user-guide/extending.html.md': 'user-guide/extending.md' 'user-guide/gpu.html.md': 'user-guide/gpu.md' 'user-guide/groups.html.md': 'user-guide/groups.md' 'user-guide/installation.html.md': 'user-guide/installation.md' 'user-guide/performance.html.md': 'user-guide/performance.md' 'user-guide/storage.html.md': 'user-guide/storage.md' 'user-guide/v3_migration.html.md': 'user-guide/v3_migration.md' 'developers/contributing.html.md': 'contributing.md' 'developers/index.html.md': 'contributing.md' 'developers/roadmap.html.md': 'https://zarr.readthedocs.io/en/v3.0.8/developers/roadmap.html' 'api.md': 'api/zarr/index.md' 'api/zarr/create.md': 'api/zarr/functions/create.md' 'api/zarr/open.md': 'api/zarr/functions/open.md' 'api/zarr/save.md': 'api/zarr/functions/save.md' 'api/zarr/load.md': 'api/zarr/functions/load.md' 'api/zarr/metadata/migrate_v3.md': 'api/zarr/metadata.md' # Based on https://github.com/developmentseed/titiler/blob/50934c929cca2fa8d3c408d239015f8da429c6a8/docs/mkdocs.yml#L115-L140 markdown_extensions: - admonition - attr_list - codehilite: guess_lang: false - def_list - footnotes - md_in_html - pymdownx.arithmatex - pymdownx.betterem - pymdownx.caret: insert: false - pymdownx.details - pymdownx.escapeall: hardbreak: true nbsp: true - pymdownx.magiclink: hide_protocol: true repo_url_shortener: true - pymdownx.smartsymbols - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg - toc: permalink: true - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.snippets zarr-python-3.3.0/mkdocs_hooks.py000066400000000000000000000052741523267620000170620ustar00rootroot00000000000000"""MkDocs hook that renders validation-marked code fences as ordinary code blocks. The docs validation convention (see ``tests/test_docs.py`` and the contributing guide) requires every python fence to carry ``exec="true"``, ``test="true"``, or ``exec="false" reason="..."``. Markdown Exec's superfences fence only claims ``exec="true"`` blocks; without this hook the remaining marked fences fail superfences validation and their contents spill into the page as raw markdown (e.g. the PEP 723 header of the custom dtype example rendered as headings). This hook registers a second ``python`` fence, tried when Markdown Exec's declines, that strips the validation attributes and delegates to the standard superfences highlighter so the block renders exactly like a plain code fence. """ from __future__ import annotations from typing import TYPE_CHECKING, Any if TYPE_CHECKING: from markdown import Markdown from mkdocs.config.defaults import MkDocsConfig # Mirrors markdown_exec's _to_bool: everything but these means "true". _FALSY = {"", "no", "off", "false", "0"} def _validator( language: str, inputs: dict[str, str], options: dict[str, Any], attrs: dict[str, Any], md: Markdown, ) -> bool: """Claim fences marked test="true" or exec="false"; leave the rest alone.""" if "exec" not in inputs and "test" not in inputs: # Plain fence: let the default superfences pathway highlight it. return False if str(inputs.get("exec", "false")).lower() not in _FALSY: # Executable fence: Markdown Exec's own custom fence handles it. return False # Consume the validation attributes so they don't leak into the output. inputs.clear() return True def _formatter( source: str, language: str, css_class: str, options: dict[str, Any], md: Markdown, classes: list[str] | None = None, id_value: str = "", attrs: dict[str, Any] | None = None, **kwargs: Any, ) -> str: """Render with the same highlighter superfences uses for plain fences.""" fenced = md.preprocessors["fenced_code_block"] fenced.get_hl_settings() return fenced.highlight( src=source, language=language, options={}, md=md, classes=classes, id_value=id_value, attrs=attrs or {}, ) def on_config(config: MkDocsConfig) -> MkDocsConfig: superfences = config.setdefault("mdx_configs", {}).setdefault("pymdownx.superfences", {}) custom_fences = superfences.setdefault("custom_fences", []) custom_fences.append( { "name": "python", "class": "python", "validator": _validator, "format": _formatter, } ) return config zarr-python-3.3.0/packages/000077500000000000000000000000001523267620000155735ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/000077500000000000000000000000001523267620000203275ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/.readthedocs.yaml000066400000000000000000000021441523267620000235570ustar00rootroot00000000000000# Read the Docs configuration for the zarr-metadata docs site, separate from # the zarr-python site configured by the repo-root .readthedocs.yaml. The RTD # project for zarr-metadata must set its configuration-file path to # packages/zarr-metadata/.readthedocs.yaml. version: 2 build: os: ubuntu-22.04 tools: python: "3.12" jobs: post_checkout: # Cancel pull request builds that do not touch this package. Exit code # 183 cancels the build and reports success to the Git provider. Scoped # to PR builds ("external" versions) because origin/main is only a # meaningful diff base there. - | if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- packages/zarr-metadata; then exit 183; fi install: - pip install --upgrade pip - pip install ./packages/zarr-metadata --group packages/zarr-metadata/pyproject.toml:docs build: html: - mkdocs build --strict -f packages/zarr-metadata/mkdocs.yml --site-dir $READTHEDOCS_OUTPUT/html mkdocs: configuration: packages/zarr-metadata/mkdocs.yml zarr-python-3.3.0/packages/zarr-metadata/CHANGELOG.md000066400000000000000000000352541523267620000221510ustar00rootroot00000000000000# Release notes ## 0.4.0 (2026-07-29) ### Features - Added `zarr_metadata.model`: frozen-dataclass models (`ZarrV2ArrayMetadata`, `ZarrV3ArrayMetadata`, `ZarrV2GroupMetadata`, `ZarrV3GroupMetadata`, `ZarrV2ConsolidatedMetadata`, `ZarrV3ConsolidatedMetadata`, `ZarrV3NamedConfig`) that are canonical, semantically lossless representations of Zarr metadata documents, plus structural validators (`validate_*` / `is_*` / `parse_*`). Every v3 extension point (data type, chunk grid, chunk key encoding, codecs, storage transformers) is held as `ZarrV3NamedConfig`: a name, configuration, and `must_understand` obligation; nothing is interpreted. On the wire, an empty configuration with the default obligation uses the spec's plain-string shorthand. Model fields are annotated with the role alias `ZarrV3MetadataField` (today exactly `ZarrV3NamedConfig`), so annotations convey the logical meaning and stay put if the spec adds another field form. Validation is strict about what the types declare: v2 `dtype` / `order` / `compressor` / `filters` / `dimension_separator` shapes and the fixed `zarr_format` / `node_type` literals are all enforced. Every `ValidationProblem` carries a machine-readable `kind` (`missing_key` / `invalid_type` / `invalid_value` / `invalid_json`) so consumers can dispatch on the failure mode without matching message strings, and every ingestion failure — including missing store keys and undecodable bytes in `from_key_value` — surfaces as `MetadataValidationError`. An adversarial review added further structural checks: JSON booleans are not accepted as dimension lengths, dimensions are non-negative, `dimension_names` must have one entry per dimension of `shape`, `attributes` and `configuration` values are JSON-checked recursively (like `fill_value`), non-finite floats and non-standard JSON constants are rejected, abstract mappings and sequences normalize to encoder-safe canonical containers, v2 `shape` and `chunks` must have the same rank, non-null v2 filter pipelines contain at least one filter, document `TypeIs` guards only narrow values that already use the declared canonical containers, and the inline consolidated-metadata envelope and entries are deep-validated so the group validator's verdict always agrees with the model constructor. The v3 models expose `must_understand_fields`: the subset of `extra_fields` not explicitly waived with `must_understand: false` (fields are implicitly must-understand per the spec). Readers discharge the spec's fail-to-open duty by subtracting the extension names they recognize; the model only partitions by obligation, since recognition is reader-specific. Optional pydantic integration ships as `zarr_metadata.pydantic` (importing it requires pydantic 2.13 or newer; the core package does not depend on it): one `Annotated` field type per model, validating raw documents through `from_json`, passing core-model instances through unchanged, serializing via `to_json`, and publishing JSON Schemas derived from private constrained document types that mirror the independently expressible runtime rules. Cross-field cardinality relations still require runtime validation. The instances are the core model classes, so values interoperate freely with non-pydantic code. `create_default` keeps its output self-consistent: overriding `shape` without a chunk grid derives one regular chunk covering the array (v3 `chunk_shape == shape`; v2 `chunks == shape`) instead of silently keeping the scalar default's 0-d grid. A v2 `.zarray` that omits `dimension_separator` is interpreted with the v2 convention's default `"."` (the model previously normalized absence to `"/"`, which would misaddress the chunks of real-world default-separator arrays). The value is never null: absent, `"."`, or `"/"` are the only spellings. Optional document keys use `UNSET` — a PEP 661 sentinel (`typing_extensions.Sentinel`), usable directly in type expressions — never `None`: in a model, `None` always corresponds to a JSON `null` in the document (a v2 `compressor`, an unnamed dimension inside `dimension_names`), and `UNSET` always means the key is absent. Checker note: ty types the sentinel exactly; pyright needs `<= 1.1.404` until microsoft/pyright#11115 is fixed (this package's CI pins it); mypy users need a `cast` or `type: ignore` at narrowing sites until python/mypy#21647 merges. This keeps semantically distinct spellings distinct — an absent `dimension_names` ("there are no dimension names") and an explicit `[null, null]` ("every dimension has a name, which is null") are different documents and round-trip as such. The `consolidated_metadata: null` written by a historical zarr-python bug is the one deliberate exception to faithful round-tripping: those stores remain readable, but the bug spelling is repaired to absence on read and never written back. The v2 models treat the `.zattrs` file's presence as part of the store: `attributes` is `UNSET` when no `.zattrs` file exists (and `to_key_value` emits none), while an explicit empty `.zattrs` is `{}` and round-trips as a file. Previously `to_key_value` always emitted `.zattrs`, silently adding a file to stores that never had one. The store-key `Literal` aliases (`ZarrV2ArrayMetadataStoreKey`, `ZarrV2AttributesStoreKey`, ...) are exported from `zarr_metadata.model` alongside their constants, and each `to_key_value` return type is keyed by them, so the set of store keys a model can emit is visible in its signature. `from_key_value` deliberately keeps `Mapping[str, bytes]` input: it accepts any string-keyed store mapping and ignores unrelated keys. `to_json` returns a document that shares no mutable state with the model: every value that can hold a mutable container (attributes, configurations, extra fields, v2 codec configurations, fill values, consolidated entries) is deep-copied on the way out, so editing a serialized document can never silently mutate the frozen model that produced it. ([#4119](https://github.com/zarr-developers/zarr-python/issues/4119)) ### Improved Documentation - `zarr-metadata` now has a standalone documentation site at , with a comprehensive API reference covering every public module, versioned by this package's release tags. The package also gained a `justfile` collecting its development commands (`test`, `lint`, `typecheck`, `docs-check`, `docs-serve`, `changelog-draft`), which the package CI workflow now delegates to. ([#4208](https://github.com/zarr-developers/zarr-python/issues/4208)) ### Deprecations and Removals - The document (TypedDict) types are renamed to put the format version at the front of the name and to mark the JSON-document form with a `JSON` suffix, so a format version can never be misread as a class revision and the bare entity names are reserved for the `zarr_metadata.model` dataclasses: - `ArrayMetadataV2` → `ZarrV2ArrayMetadataJSON` (and `...Partial` accordingly) - `ArrayMetadataV3` → `ZarrV3ArrayMetadataJSON` (and `...Partial` accordingly) - `GroupMetadataV2` → `ZarrV2GroupMetadataJSON` (and `...Partial` accordingly) - `GroupMetadataV3` → `ZarrV3GroupMetadataJSON` (and `...Partial` accordingly) - `ConsolidatedMetadataV2` → `ZarrV2ConsolidatedMetadataJSON` - `ConsolidatedMetadataV3` → `ZarrV3ConsolidatedMetadataJSON` - `NamedConfigV3` → `ZarrV3NamedConfigJSON` - `MetadataV3` → `ZarrV3MetadataFieldJSON` (the union of the bare-name and named-configuration spellings of one metadata field) - `ExtensionFieldV3` → `ZarrV3ExtensionField` - `CodecMetadataV2` → `ZarrV2CodecMetadata` - `DataTypeMetadataV2` → `ZarrV2DataTypeMetadata` - `ArrayOrderV2` → `ZarrV2ArrayOrder` - `ArrayDimensionSeparatorV2` → `ZarrV2ArrayDimensionSeparator` - `ZArrayMetadata` → `ZarrV2ZArrayJSON` (the strict on-disk `.zarray` document) - `ZGroupMetadata` → `ZarrV2ZGroupJSON` (the strict on-disk `.zgroup` document) - `ZAttrsMetadata` → `ZarrV2ZAttrsJSON` (the `.zattrs` document) The old names are removed, not aliased. The `zarr_metadata.pydantic` field types take the bare entity names (`ZarrV3ArrayMetadata`, ...), matching the model classes they validate into. The conventions, stated once for future additions: CamelCase type names put the format version first (`ZarrV2ArrayMetadataJSON`, `ZarrV3ArrayMetadataStoreKey`), while SCREAMING_SNAKE constants and snake_case functions put it last (`ARRAY_METADATA_STORE_KEY_V2`, `validate_array_metadata_v3`). The `JSON` suffix marks a raw-document type whose bare name is taken by (or reserved for) a `zarr_metadata.model` dataclass; raw field-level types the models hold verbatim (`ZarrV2CodecMetadata`, `ZarrV3ExtensionField`) keep their bare names. Extension-entity types put the registered entity name first and end in exactly one role suffix (`BloscCodecMetadata`, `Uint8DataTypeName`) — the `V2` in `V2ChunkKeyEncodingMetadata` is that encoding's entity name, not a format version, which is always spelled `ZarrV2`/`ZarrV3`. Every public type name is checked against this grammar by `tests/test_public_api.py::test_public_type_names_comply_with_naming_grammar`. ([#4119](https://github.com/zarr-developers/zarr-python/issues/4119)) ## 0.3.0 (2026-06-19) ### Deprecations and Removals - Introduces a new `JSONValue` type that models python objects that serialize directly to JSON. This type is used to annotate the contents of `attributes` and `fill_value` fields, replacing the use of the overly wide `object` type. This is technically a breaking change. ([#4037](https://github.com/zarr-developers/zarr-python/pull/4037)) - Promoted a curated "front door" of names to the top-level `zarr_metadata` namespace, so consumers can write e.g. `from zarr_metadata import ArrayMetadataV3, ShardingIndexLocation, BLOSC_CNAME` instead of importing from deep submodule paths. The front door covers every metadata-document TypedDict, each codec/chunk-grid/chunk-key-encoding canonical type, the full data-type trio for every dtype, and every constant + `Literal` pair. Deep submodule paths continue to work unchanged. Several promoted names were given clearer, less ambiguous spellings than their deep-module names, since they now appear bare at the top level: `Endian`/`ENDIAN` → `Endianness`/`ENDIANNESS`, `IndexLocation`/`INDEX_LOCATION` → `ShardingIndexLocation`/`SHARDING_INDEX_LOCATION`, `RoundingMode`/`ROUNDING_MODE` → `CastRoundingMode`/`CAST_ROUNDING_MODE`, `OutOfRangeMode`/`OUT_OF_RANGE_MODE` → `CastOutOfRangeMode`/`CAST_OUT_OF_RANGE_MODE`, `DateTimeUnit` → `NumpyTimeUnit`, `NamedConfig` → `NamedConfigV3`, and `MetadataFieldV3` → `MetadataV3` (matching the name `zarrs` uses for this `name`-or-`{name, configuration}` shape). Also added the `NUMPY_TIME_UNIT` runtime constant (a `Final` tuple paired with the `NumpyTimeUnit` Literal) in `zarr_metadata.v3.data_type.numpy_timedelta64`. ([#4083](https://github.com/zarr-developers/zarr-python/pull/4083)) ## 0.2.0 (2026-05-19) ### Bugfixes - `GzipCodecConfiguration.level` is now required, and `GzipCodecMetadata` no longer accepts the bare-string `"gzip"` form. The codec's compressed output depends on `level`, so metadata that omits it cannot reproducibly identify the chunk bytes produced by a writer. **Breaking** for consumers that previously typed gzip codec metadata as the bare string or constructed a `GzipCodecConfiguration` without `level`. ([#3978](https://github.com/zarr-developers/zarr-python/pull/3978)) - `BytesCodecObject.configuration` is now `NotRequired`. The configuration has no required keys (`endian` is conditionally required at runtime based on data type), so the object form may omit it entirely — matching the bare-string short-hand. **Soft-breaking** for consumers that previously relied on `configuration` always being present. ([#3978](https://github.com/zarr-developers/zarr-python/pull/3978)) - Better modelling of Zarr v2 stored metadata. Zarr v2 splits a node's metadata across two JSON documents (`.zarray`/`.zgroup` and `.zattrs`), but `GroupMetadataV2` had no `attributes` field while `ArrayMetadataV2` did — an inconsistency. `GroupMetadataV2` now also has an optional `attributes` field, and `ArrayMetadataV2.attributes` is now `NotRequired` for symmetry. **Soft-breaking** for consumers that relied on `ArrayMetadataV2.attributes` always being present. ([#3962](https://github.com/zarr-developers/zarr-python/pull/3962)) ### Features - Added `ArrayMetadataV3Partial`, `GroupMetadataV3Partial`, `ArrayMetadataV2Partial`, and `GroupMetadataV2Partial` — sibling TypedDicts to the existing full metadata types, declared with `total=False` so every field is `NotRequired`. Use these when typing dicts that intentionally hold a subset of a complete metadata document (test fixtures, fragment templates, in-progress builders). An equivalence test pins each `Partial` to the keys and value types of its full sibling so the two cannot drift. ([#3982](https://github.com/zarr-developers/zarr-python/pull/3982)) - Added three new top-level types modelling the **strict on-disk** shape of Zarr v2 metadata documents: `ZArrayMetadata` (the `.zarray` file), `ZGroupMetadata` (the `.zgroup` file), and `ZAttrsMetadata` (the `.zattrs` file). Use these when you want a type that faithfully matches what's stored on disk; use the merged `ArrayMetadataV2`/`GroupMetadataV2` when you want the in-memory representation a Python program typically works with. ([#3962](https://github.com/zarr-developers/zarr-python/pull/3962)) - Added typed constants exposing the spec-permitted values of constrained Literal fields, importable at the per-codec module level. For example, `from zarr_metadata.v3.codec.bytes import ENDIAN` provides `("little", "big")` as a tuple, enabling runtime iteration or validator generation without re-stating the Literal values by hand. ([#3978](https://github.com/zarr-developers/zarr-python/pull/3978)) ## 0.1.1 (2026-05-06) ### Misc - First usable release on PyPI. Version 0.1.0 was uploaded then deleted to reserve the project name; this version is the first one PyPI will install. No source changes from 0.1.0. ([#3949](https://github.com/zarr-developers/zarr-python/pull/3949)) ## 0.1.0 (2026-05-01) ### Features - Initial release. Provides `TypedDict` definitions and `Literal` aliases for the JSON shapes specified by Zarr v2 and v3 metadata, plus a subset of `zarr-extensions` types and the un-specified-but-widely-used consolidated metadata documents. Pair with a runtime validator like `pydantic` to check JSON loaded from disk. ([#3919](https://github.com/zarr-developers/zarr-python/pull/3919)) zarr-python-3.3.0/packages/zarr-metadata/LICENSE.txt000066400000000000000000000021441523267620000221530ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015-2025 Zarr Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. zarr-python-3.3.0/packages/zarr-metadata/README.md000066400000000000000000000125761523267620000216210ustar00rootroot00000000000000# zarr-metadata Python types, models, and validators for Zarr v2 and v3 metadata. Documentation: ## What this is Two layers and an optional integration: - **Typed JSON shapes**: `TypedDict` definitions and `Literal` aliases for the JSON documents specified by the [Zarr v2](https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html) and [Zarr v3](https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html) specifications, plus types for [`zarr-extensions`](https://github.com/zarr-developers/zarr-extensions/) and a few widely-used-but-unspecified entities (e.g. consolidated metadata). - **Document models** (`zarr_metadata.model`): canonical frozen-dataclass models of whole metadata documents, with structural validators, loc-aware parsers, and store-key (de)serialization. A document produced by `to_json` shares no mutable state with the model that produced it. - **Optional Pydantic integration** (`zarr_metadata.pydantic`, requires Pydantic 2.13 or newer): each model as a Pydantic field type that validates raw documents through the same strict parser. ## What this is for The public `TypedDict` definitions describe the static JSON shape of Zarr metadata. For strict, loc-aware validation of JSON loaded from disk, use the model parser: ```python import json from zarr_metadata.model import ZarrV3ArrayMetadata with open("zarr.json", "rb") as f: raw = json.load(f) metadata = ZarrV3ArrayMetadata.from_json(raw) ``` The optional Pydantic integration delegates raw input to the same strict parser and returns the same normalized model class: ```python from pydantic import TypeAdapter import zarr_metadata.pydantic as zmp metadata = TypeAdapter(zmp.ZarrV3ArrayMetadata).validate_python(raw) encoded = metadata.to_key_value()["zarr.json"] ``` A bare `TypeAdapter` over a public document `TypedDict` is a coercive shape adapter, not a Zarr conformance validator; it may coerce values or discard members that the strict model parser rejects. ## Validation boundary The model validators enforce the declared document structure and a small set of context-free consistency rules, including fixed format literals, finite JSON numbers, non-negative dimensions, non-empty v3 codec pipelines, and one `dimension_names` entry per array dimension. They do not interpret extension names or configurations, resolve codec pipelines, or decide whether a data type, chunk grid, codec, or storage transformer is supported. Those decisions belong to consumer implementations. The Pydantic integration's generated JSON Schemas express independently checkable document structure and field constraints, but they are not a replacement for runtime model validation. Standard JSON Schema treats a mathematically integral number such as `1.0` as an integer, while the runtime boundary requires Python `int` values, and it cannot express arbitrary same-length relations such as `dimension_names` versus `shape` or v2 `chunks` versus `shape`. Consumers should run the model parser after schema validation. ## Scope At minimum, this library supports what Zarr-Python needs: the complete Zarr v2 and v3 specs, consolidated metadata, and a subset of the metadata defined in `zarr-extensions`. We are generally open to contributions that add types, models, or structural validation for Zarr metadata with a published spec. Runtime array behavior is out of scope: nothing here encodes or decodes chunks, resolves codec or data type names to implementations, or performs store I/O. The models begin and end at the metadata documents themselves — `from_key_value` / `to_key_value` map documents to store keys and bytes, and everything past that belongs to consumer libraries. ## Developing Package-scoped development commands live in the [`justfile`](./justfile) (requires [just](https://github.com/casey/just)): ``` just test # run the test suite (extra args go to pytest) just lint # ruff, same invocation as CI just typecheck # pyright, pinned to the version CI uses just docs-check # strict build of the docs site just check # all of the above just docs-serve # serve the docs site locally ``` Run them from this directory, or from anywhere in the repository as `just packages/zarr-metadata/`. ## Releasing The package version is derived from git tags by `hatch-vcs`. Tags must match the pattern `zarr_metadata-v` (e.g. `zarr_metadata-v0.2.0`) so they do not collide with the main `zarr-python` release tags. To cut a release: 1. Create and push a tag of the form `zarr_metadata-v` on the commit you want to publish, e.g.: ``` git tag zarr_metadata-v0.2.0 git push origin zarr_metadata-v0.2.0 ``` 2. Pushing the tag fires the `zarr-metadata release` workflow, which builds the wheel/sdist (version resolved from the tag), runs an install smoke test, and publishes to PyPI via OIDC trusted publishing. We intentionally do *not* create a GitHub Release for `zarr-metadata` versions — GitHub Releases live at the repo level, and a zarr-metadata release would surface in the zarr-python repo's Releases UI as if it were a zarr-python release. To dry-run a build against TestPyPI, dispatch the workflow manually (`Actions` → `zarr-metadata release` → `Run workflow`). Manual dispatches build from the current commit; with no recent tag the version will look like `0.1.devN`, which is fine for TestPyPI. ## License [MIT](./LICENSE.txt) zarr-python-3.3.0/packages/zarr-metadata/changes/000077500000000000000000000000001523267620000217375ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/changes/README.md000066400000000000000000000016661523267620000232270ustar00rootroot00000000000000Writing a changelog entry for `zarr-metadata` --------------------------------------------- Fragments in **this** directory are released notes for the `zarr-metadata` package only — kept separate from the parent zarr-python `changes/` directory so a PR touching only `packages/zarr-metadata/` produces a release note for this package only. Please put a new file in this directory named `xxxx..md`, where - `xxxx` is the pull request number associated with this entry - `` is one of: - feature - bugfix - doc - removal - misc Inside the file, please write a short description of what you have changed, and how it impacts users of `zarr-metadata`. A `zarr-metadata` release runs `towncrier build` in `packages/zarr-metadata/`, which consumes the fragments here and updates `CHANGELOG.md`. Fragments that describe parent zarr-python changes (not the metadata package) belong in the top-level `changes/` directory, not here. zarr-python-3.3.0/packages/zarr-metadata/docs/000077500000000000000000000000001523267620000212575ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/docs/_static/000077500000000000000000000000001523267620000227055ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/docs/_static/favicon-96x96.png000066400000000000000000000306521523267620000256510ustar00rootroot00000000000000PNG  IHDR_`{` pHYsodtEXtSoftwarewww.inkscape.org< IDATx}y|Uι7&lU* Ep\@[kTlUYVZpׯ-l, [s}~$dAk|>瓛s3g33̼!_L;[wG4kڽ3>B~I Nj4!oPD1۔Ec.:Џ[O觎/B}J1 8]Q?~jkPp_zkg-~޽)1 Ժ\Q6e`HJܗ6s\3_|77=el0"d~z"oeOU05uम8?:ՑLs\E!A @*G`EG3nyv,Ƽy``JZ{SNJOV:sϏbgav LI++?j]-HL2 @m4Pe?  W=SRG*>s~RL+Wzh##yx(f'Ҥf3Uu(w"T<ʍ1qsR*ں|QQI]g̘Ƭxibhӭ 5ulɭOqJ[;;Ң*& g@TYU2yj,P>x{ xɩcֵʚ`?}6x )鷉Ӳ+\ [Ϙ:D$bU)+[0{qwE7pg#;HNCP@.' Y譠XKʜ/P/B8Am (9ɩ=a 8m/SJP@䌽i臦 ,ŰaN~RMI @9Tp&Ӧ4pĽPP6JP@: 5a Q2X qYsABj:X<.+cFK5*U(bjpWc?!}t'SNNnZOBL،!\*PxkO (,VhUTJAIDêKTh=]OO0j܂{Rn+f q/' ܝ:Vw *DX`ЗWǧ6i,}nS{{0* / UU (B 0ķ'VZר@AțT^ Zma ~-RYok{"|ܓr;STp8M1= N]xԩ^DJ4OǍkC~)ό,E6p nV+WT,b*5By D:Ú aJw05q1QO ;~q僸d51}b,VG0J??Dl7.2 ot@⪺ZyKlJ!U-zXBc}(A@8|FͣJKߕ:2Q [<6()2N8` sZ,)eq)缚;kȖJs|Zeו7*n2o7.7.E-lϩW%aŷ64 Hxq5 z8Фp>tQ$ d47&DLݿx4?)DZV "y6Xg( ~e<@ߙRYR "H FZwqoѲ*t|2W|Ci>F?0{vwzB7~/0*9h+0C ͡##)OhNT >w`h#% '`( DD!Pט+cP( 'xT*a_Z5e x'Zע;y6D4- ϪЮL|rOmiЂ;ҴᢶOM-/6?ߞziB9P*04S Eu[EG'T 6"ʩɇ4RBѾ@c |d!,T]CEd)W>Z/17=S.ʽl^pGڈcǛwFA `KڠȦd]?9 e< ($!.wΚy`9nP MAαl>Xt6)4(!BԪqwP0ɢʐ29R/0yPp|YhV9֬TV4)hZS FE,VGZ^ aè7rN6@S@h~"꧍JE&oP4!olʱFbTI`w礼a"bEzͅbN~ b(dTJZuN`IQ%~Im1aӞmܜ'x0[Ӯ0/9Pg:B՚MH*:٬c O|>TjoMPgO~NMy$5PGřlmo+w4gE:gPz*QxǧaQ((/pTLe!7ՎP&ݒr[ȴUWCT,#FNu8~3?EřTD<6:oTUNLFk>7W5`ѨuY[9OzaFaNC_B y<  "T=ϟ"F>2U`(+Ð!bJEWK@ ^PbaO Fv!haM1~sj]vuK[?X?2'h kB-nB4Ӓ⛩R0ECi,Fbj a: Tx9 ŹUv@nr1}N`JDOl']Ee+P@ c^\(^v*|V֌V[ ot8Qv-(1#(ڏtQTWVy^H{5,n9 _hcn"332 iDR +AѼTO+EDs?Ӳ-9EUcmeybǍV1< ࣇ]-b!D(1fsS GԀ } \!hy!^֎@?cRD!!1<:-$({“YK/]/ynq A5\c%a͑Yn44հxZ_ +jpt q`&irOF:w/~*\ 2WXz9M-^*pݣQȱy_?@zcf^N0hr86\)x[‚ugXZ_(e~ kS{Ѱ#do OCo4/{Mפ-=={>+n-I >6v̈́Nt|P : z>('9"*!  KoJHd)GE\S9fŽ YT: 9b~9;}Æ9y^N`EG']s6Wj%7匵Y;44Vϻ6/+ŏ Jc"JƊ3&K:pgm˽&9/lkTEIR\.}UCRA _5aW( RϘm]?lﶻl;ImVtd ux÷uO ax$r!jY2Hv5`DK(o—o.E_'dP!lTQ2kjw%{$6cg%W"WGp:aPdCؓsXSH a5*Q<Ab1mJ|E_0. r,Q$?P`(R_m DQbuTk0jḡř g &Lrx0P_!1jʹ&&&Ð(xD,C·X|*FQo AH>[N1Q ^-[FLO`̵ KcJAVN:q*_F~qu) [~?BcwxhI]q.B,(ixsyE9Z=[Rb|@C9(HX[l_&)]Ȁ7aGoi,:U\|dgH3Q =GV7{tP5 7~E֢WCAi ֬R;8A#Ty>MZ1s. |ǮFq}qYv qlr`с|EnRs!Q:Xf+xEx~u\1FH8(bǯ-iJIdR'D++prx8GI):.{ K__xXرaK"6 X9K^w߻ӰмE(AhXDT mOcbRQ|@8MD$ @ @b\$bt8״Pk& fOtBە~ո6-}W$_0&@1VeίJKSCŪhZJ.IJM5r3 U6F"ʭ\h`!?PDLZ_("\͸[gToP}KHKT嶫fm-zn;#6v@Ҫ̑'>r/NYrq1RUw|_Օ(P\t= H;Ϫ)Zճ1lS+Ix'ňK#]}6u6e;!du_C pX**kK! ⥊ CT.\/ f Ljoʏ+δ5u+z*H@L\xәG[gVgV铲5Y=>^1B!K|?MH^仔)iܾq 5B .O|?=}Kڛ蚤)\PĔ x8!ѫG@(3h ^!r}y@LB0 @O(e @  &nF0a]:^0bcdJ@e8u'^A+rW6볖$&R>ԛhfv^ \UZJU/۩Ԭ|%u A_cؔ r)aIiD4% ;J\[<_Ghx| aY1G@IBX,p։׋h*^A;aY̱'>䁹|7`3qmf6벖" & #2J %oj$|9Ǹq8m<}k3tBPgkάWi&~[ˡ ~`\[mȮm? 4ZE%RQyD-y+ ˡӫ19B0"==/#ȦUt4]G*e/XDZuygUP-&l=9cLwOy\y f'3I0y&;7_ ~ygϲI\T­q"T+`Z8*ēˡ;ib ]4ŠsP#ė;;ܳ'~!Z8B\2VnkCNipeE‡Y*9gJ>=8+쉷>kbg1/I,*-D\@=v;{mZ;*Uv/?g9,ļ'aFV\C :ʤL6Q1miZ dhaJ<,GYb5;_X ⨴X*VvM^(EPq|3b( @a/vgc"_fTšt= H_%m^ `uNKA?kXk7V T3_d|ܮ/hQ:6Uv[2Ƽ.)'M@FtMF?jqgАٱ <F@\<6$Y/,J ,!Ey%,σEZW><[Q"-l"X4wŚQ 5C{Q+v:g25dlX)DXv>9ּNą3/rD?P*th/9cmpVmV,PLcIb@ E),h Og2@b1w">*+iCz2h7lYxfb ,$]Nu$ V&^tGtvfΧE;%/NT^M{[pUcM=UxNW(QM(ׯM+@5>I 8Aܤ1՛UpQJ'C` g7 J#!JhL[(1 p !&7cs˹CL*NH9@nSwN,}hy92XptxP͵`PkRxl(( p˜/`uE=%bVLObBkZbU>AOg2@M>6SyQ-,z(-[Z|V8S_hKKP U`)[O򛤼&5f썟\U62 6qbU>"%kN [ZΟZ&7rZ{ZOnTR*]7N-OIO=c]sZyШ+IDATC/ez0jk&Q1Xl'7œpuPϱchx$i<#=LLbn5`F\*MdkU1ݱfHӊp6f= yֈ@?fTW=T8Y|V!6C }%mfX/]*QlX@oqB6]~~!"cU 9J6튲'9 E^''|0?x4I1K|7"'69wMy6)IۃY𼈳F;|o29 1EN y@rH845r@9MdQǻ ]y쨈l-%1nͤRxai}R R N1*qn1eNN;u<2wǤ& 3<#|#Ltb '#IK`Mvib"'q@>oS43J׭QEW $x-0 !v&LwERQ"tbα4_y[B^ IROF8eNns |3m ^~~G L}5' ؽ>|Jq\[¬`u7I0bgl&`˕>%1)n>s%?d.|hS]Q\z9|(no|a-9f+ʚK1,q՞;ɗU%*_Ew t]PV' C Sꞕp6-$ \-*;j! &8CWp=4ri6aM>Pó%c*h jΘ.|Q۵=9-YYs-o$ulC+e"¸=FĵPTx>l@a I^<I#K;2/uIjn,=&(XW)F<|xڢHkt8\wJ7w(̚-:#"먦l06"ozL]CKk!kO㼢YA7$|8^ jMLr.gԵ b8AN}pEYaszulI/;\U@JҫZf#\Xs$:f?4|`-Q,B޼Nز%6h#y}UU#ו7"hֹFQW8%"$h4 OA]㳏Յ}K@ Եp|;~=:Ʀ@5\-ƴH+Q-:N?@H:75z":Ŷش3}ug$n "5rК֯gj&.TDU\C]5o -άʲ56 @vDo8r8if4[KH*B:8`-6"\E]JH)(hSTAYu^ Z\$EꉾBy񱣱җ:ޢWu$Mgͨ1]2>V ^ojr#&K7 4II &]=}w5Zlp|C;(Dt й£a@m롚s(X `@zqf:8FL6*3[F8:KB+_$1\'|z90\}t_QK.qW* N)] JjTf, V䁮p&$h6G^/" o|yƷ3RR0oGt"sLrM| "za/xOD2IċJ0ӎ՘JFu}]4.< K57L#o B):N͖ `w](́J\aoZl} # M;9~{!}| (G+ Њ4mE00/Qrt zi3\ߤqYUfSlZ4D`rb ÜM1F V VpХh[HuG6ŤjU݋BPū$k(-(kec =\}a da"N*.2˻ɊP " "(pw?xe%Fw<:iPk.6.S0ad=•K闱G2ĹVZwK}@;7Lic<l;Q{wX%A_@ML ŀB]xc'FkTOAVSo M49ENUO1KC9f}t; /kf>wUo~MiK,"po $*ec&jTzhJ,Ö˻MIfa}6 }#qB,{F߂_&xUŴ<0@@Ǵu|{CɁ5V'Tn~/.K꿬롩l$BdgC@9@HK)>(oSG]m09_//l`ZAUC{i[3lAl`vEE3=~GĔ,":jƝ@@VO2.HLD\rNԢ#~'$Q8@|v56/Üc:'E;)籓Y='Y-O&9}yF~ $ho$J߳MZe10*b{p2NG /7G{?occ7V#Qğ퐠(3*D8GoI* G{C Ю_>V̥a@sϟs:+"Aa"U;~1AnkL~0Muwc$W}Chsw0ۧ}raCB A.@yWS?AdژJoRT>pMO'#ek"Hȫ :PRO)J!K޷Afm $xQRϢ{ߣ>Tom _WXڻhNN:Ax*)zʚ?ڷW!ekYн42E"T>?U>F~l/+ LS1:F+}KNKh:P XtQ| ?X;^A~(V/Wf%SVg7و_U y9D>wpIIk~FޟX;/[ˊ욹?[+*vZ_ %S^8P= 0+/-ӷ^Jч >i}r$S_Oi*2ފ"z%~qWbE>PP|EStEGIENDB`zarr-python-3.3.0/packages/zarr-metadata/docs/_static/logo_bw.png000066400000000000000000001302301523267620000250420ustar00rootroot00000000000000PNG  IHDR;' pHYsodtEXtSoftwarewww.inkscape.org< IDATxweſ'*z/JE$XAPDP,"EcB'$T@swݛ[vw&a3;3LfO;Mm| i`S} p x #:~O\I@G>"lO}0&!3@҂fk-mhA$_9|\VOg;$D/V}8bʬےfOFO!\F?pgRFDaڡfm-mLhA=%\ '`U%m/nJNnCkafFDd~XAZgI Mmt IHpq&َdugr1{Jr "aljTN :5†>`;*02j;Hon* e{퇳6Npm' a n "h|mVCl-=cI>&96@4@((؜ WCIH&@5l?j{o"Ev Q5N~~ĹDk!=^3*ʮ6ʇ6 %]O [mOg֖t%Q}Av2;W$%%V"%Q{y=*Kfj-mm"#ͪ$|emDEp'HZ]߁ZnU ؾ gˀ%)ٽL'b oo!ۻ"@[ʹҖ6ʅ?֐4wh{vw%$b½;U*ؾvD@e"PbV:f2 83Q0hq@{D>eHn+(Ǡz? m_ߑ_J?Hپ6DK*%sA;rj>&V3O2ydžO؟HZS?Aw( 1nD CI%͞a?Dr$/i1= 4z=牂zPjm"zpJ9QEڶi; `" lntl?b{wo?ptw"42+ߵճr۷؜eETM3$ S/ؾ$G(AO$*r? կ/}H׏/IkBfD?{%}Նھd_9&m"A#]2T]?ARC ukcny J "69)#m"!ipJ o0gٞ i>I?&V'ja*y,~Ib:v[;+$ݚ ]}uG`:%]@^˒Z"`yg`I)'j$yo=IPҠt̵D#]@Ds"p /k$),mm" izY/CϘWTϰ$ 'V+'hc~MJTz?.bI;p*bg &TؖxOP^M KT<t0տhNopgyG%#iDWph.o V++$N;~&#|rVvtLt2MaDLpe6;F؏StES϶oYVi/b;p$mJ[=DPRHZJ9 @~JO耤Y$} s% |pyu o 2:Hŝ$4I ?Ib[mD^B- Fm@JT\+b`:rֿKo }ۯf;$C+)Ⱦ}SmN̾ W1"sm+>̹S#B[moDc}"%]/iVƴ&@b$*fWZgyߵRcV%ϲ}4%N_y8C$R;X81<.\I-%+QDTUA+mi>DP0rյ2W}nyIRbFU"N?+N+UO=Is~=O'dAV3Ոt笪*IҖ6Mv΢ !f f߰ tمh\7hi Y]7t 04/iY\Dp`%}w{,Dq&I:"rޱ}*q?!fAVgcۗ+ɃehA!iy>&WOf;$KQy=B&nm?퐴BfOw8-N9H!NeH*[ 矑SCp:jپ4.:E4 PY|&Բֵ}IHP-Ⱦ*nAu3q5?afrE~Y"|BY*ꨡ~IIJ*oG*})ؖO Dd(hv*Pwkjl͒6bfYf6{%%_TTz !OA%imD<.o"S(< 54ۯ8<*n &qDѽFJZ@[>hA 3N Oy\g{wۏdJP("fQ[logCIJ xhΘ,NE' }๞aOT֕ڣHGnKR"XI^X|xc$]*ilTM Fr  2 CII1nS6}[%ܓ&Ni$A[?7ڎО Bc%Yۇ߉zBB)7D 췉>V%JYhD (:l~ SkMmoo{tB=_̸Z@G Wтm*%%i۴ k 7\PC |pYΫm#^E:jHBkc&~B) άJ@eFD)^%T" M !.!(t"eKJ5諔 5tY!oßTu/Wo&{]^:"[.HL"X{I[iˌ6Gi?Jv9we*$,/ 'S>TN%~PJ@'!I>w:A#Jӻ7!ZRMg+K=sKWeu7qDr6;=̃B`8i:`=W#`SSvrhAp.!(#ђsmܷ%P5`:۟%rnǁnJDo%-J[g`P&1%1+#:e9~$&*yW};gY)G#. f$"iṱ7'Խ>tߊ|!;hSNJ#D $-H(OYҢt/-%rć>Q{q"B(C])TJ^7"gsٴHC]fqؾM[ vj*}o-DPI`s'$zìl?(WzxH\9,nN)ˣOaT%z.e90%eFHZ" "Chs._}:9꩒pE~S Y{nM~Wbu71* _}4B8f{Jfhfx"HѾ$\e†i|OFPzMbt<#neZuM&+TvqH좟P?]U1^F-!HE[Typ K"ݭ,%|@K ZLGei{gCxa.xT?R8%."bGS$+i4>3qJRDgÈ(eJex 8P҅` 3?N$mlPQɹ;AP:28G_ee|uv7&k]s~o)7DJw9s&ί׼8?~؏-DBND3E\ߧ{%Dc[1r+܀H F L,IS`Ԓu쾩A\~k4|D aʄAD /%GwbaG;P"ȝw!6uoRA-k5r]X!  M:"yJ6L%s(V x A5g3޹sOlݍ&1+wMO={I:G/4r_9KYryTk4r? {O:>"3/SYU/֋7r[d[Mt#PZd-ˀmSI;/gaBd-~,!iI)δ^?ƶwtgq%U( ?ۇI $!,m<{r:WRpG1Ht>BDږm_'ދ&+OL\h#>!ҫ>l$ \IyVm_6` ؾ3PjFk;X< ih"L~%:"s%[5Y~&GDҟȉKHc}oJ]_''EދU 7F%(HFҹEQBkI[H h[f\Omqu$]In`;ۛپ%PJ.%{ucI:D[\m\8{?LRJiU؅8#W9l]VW&4A%j5?$7D"<{K*~FHRҭ(`âJ`{}(icI!^M gWt9ک0z/CED ɾ}fu pOCtZ, jwf+R},WsM OHru4yG,%X,Nؤ;DNe Dζ>BvJqY~%IQnmqDKZFA(qf!tn8{};fBZ!T\߈Ⱦa´+˄2fDCgNn#'%f%𴤣LkD!"ZÍ&}O$]AUu=h`9z iDcLR fu(Akؾ̎tIK@p3>K<!\JX{.Ljb1$$͞Kt(n/iaIlߢY 8ʹ}+s7)`AW+Ժzί*cVLdD{&E%]Md{l_-2 >#-JA,nx=O$RJL ?hZ,nNIJ*itL^Kθ"~vI)ؾǡE|lWK!ym'lo)j=Jk $B^JURv,†:C;usI-" Db\L8Z/?S .$ t*TcnF[nVIrt1/?$zť&Ky#b<[%m^uDZZ] }ǒ]㊲eIJ2ɝ~'eUA@#'왻FZLda"PV;#[LdW{Zr_N IYG[#iBd:h"xh-Хg `{h85pAlе㬈:c5uL w ծHj=1pHزi8T=磓}˥:fC(Lvԋk4r2&\BhkHʒ.#L9S*/q%I3)>[cb0Ii qm_DpE |䟳klGZ%mYdI7B{~/͟*2UB.gyNI!{|^]={ A)wWqL(x8h=. KWZ 8/$-JjWqI!<9ϓl:"go]yk%_ #ϑ=i$ T4K Ot=N1ˊwslCʶ~:ܟ>W%~ؙP޳K*]v#N퓈GkRtL̾7&ۑeq{ *y({+{$"b#Enۛ1C}]!jW4&JS"f%ճY%}hA0.+'V)t=?FgCl`{ tD+m !(#IG*T;O"N DrJDs~$iUΑ6ȗ/r!TV9%2V9;꟱}-NI#"4HBuf3K2[IXYk}G@$DR@*)>'>O6t RN lL\OΚuaDjLz8I~? Srg5өr~Ba:۟#3)t4zv-(:SOu?Um i&I_"rEClf0Nˈ[0 %m-p|aM17PQ:D,_}<1PJJG[#cG ߓ4WZpH[!2&K:9V9W}} DȆڙ00m7DxbWvShy'$>Db++>" H :f5[oZhT6= z晴hڞh7}',>? +&1XpLmI~|'Jsg5 <漶fq0"+y6IwJƮDOHE`ݹyieOo_~'}@WD]'JodKysߚ56Zg!8Թ˛`3zB&C3N`ihV"?&ɇP"ȝwM\תڿ Y`>^D;`"po Rq{NuN5103dh/"ȝgh6TM8iM W\N'\RELxֶuV&*Eonp31{9q6!Te}Cۏ;J+8L~3=:Thzn3$m,?RXOT6 b87cx*]ew+AdRyλH9y%*LyDϨ$( ˕yqys\Ūp:4J-+܊cV:a74Օ$*1CCv%^Jc SWzHPBQ Yn];"M4.YP^ }9R{pZ"2ȶ=I+4 Rs&n]Lص59X0& qZxX`7,DpE'`00pTt]Ev'n&B܊ n~9T q*D68b%Qpc( Rg̻(6L+ad-DH-s/KhI;lHrnݒ=LqʥaP @{^L/Yhd!wEm>I?&ϣ e"|PZG?i(bvZ/QU#(:v71`ygvG5bBL8lEbQķ}Ʊ"=+Dͫ%DйfHHMUԂl?nv3i= Nq y@7=,L;&v-!r_&dų+ON :jM=r.^",?1X ݥhx>O_爕ڜ=vB't|&1AP,Nm9{4p^/128QO"s,O#]> gMwVMlε7]L'^%bKk7s bD!{ N3`f[ N3E`:캿h6Nvď0krߝ*HN&~'RKQh԰gX7Ib;[zY~DPu?q]]++,Wڅ{mH:^}^È`<1뙩EFg[3f|105A}Mgs YDP1nԵFsGtAdX>%zve.@ -vcܱ?=ǵFUe:fӯQ)MB'8f#edb%17L!zg\ubQG[#ۆ\4h~k$NU͆\DDo4Ca p"ȝkA |؟!QǞ@ gc{Ufn TV9 'ܹf%T͒/t̿DPtnLO lߋܗ` Um_`#I+zМԇs׃ eGPM 6l!n)s*kW_Q_},`."qay2^ j>ù4VAl%V;9̒ftBcۗ_%R鉖y(s = ¾+"Gv_xr:ۛ^dA瞠7DQ9WRthZVO>q% 'f?iel!yQ  > C:^s" /0ۥ?kFS`I$_z$a,TI :d@dJ+JXRf&'[IK%B;^IT(/uTմ!tI&=9".olWwt,A'K߲-b2I߂qC /)H^xך=Ol/ ʊw኶ t.}$>]B\GdVђ" `NIG+B DI?V`{Qkq _km7UgIZQ@x)Qu.|PHIe{'Idժi(FLntvwz>W~*l_:kBY~Mmb\fI߭oBY~M Sg[DTM>T;T(3|L ٶoT(3 a Sz/Qʍp '#M69aBCTbf<jԴA:_]a{q4J>;[8+w7Mss2NdqQzu]Q.KdAS?U)5@?u9Y"d QP]Ki-M@ɛteљޢB1^G#yrˆ wשLa2B7A9k<%sQDl IOV$Ot!\{x"#D;ih"EBT҃kvJkfp?,P]}D.yt&7FhOqy#e%[BƎZ J@c]1 {FJ}tB wluMt& WFjYQ!oP ʔ^ FD1yp][{z"f^9rT/QJ"CZHxM" "}gc#jU1JB`UޔsTִ 2?Ϫ +?nk%Gq{:z&jCOg[Dpף~nzw[XUOde:_`bN`/Oo z"'>/rͷy1Ι۟/T=矦fz?ـê_|%[_VAe5ZI\@=Wo$ eMKwUm bUѝy@ Ltܶ͏ "ȝcUBѩp4D;Dzw̞?o{3T=_7]>ӥEfoV5:& zkᏤmEQĤHVV 8b `abV]-x<F w]Od0y9=~WY"ȝkyCGD5~oQ]Jo"ȝkq"e!uκ5jk|BH>,"YNg\5qC7:$T1.:} `Qn`~^'O"ȝs}B*SJ7w.1~ȕkιדI~pyA>\aD;T@~d&uM4nΏxE "ةqzm5'J5[?Z-,I 0:BBk8Ν|jy>\D;jD|u~gM!{xA܇Cz mdê*2@snc{ wϫNmE969T ө}IKX-[ݗ́ԖHJxgJߦ5jsw4 7d!J'>p5BO5G~,7,imI"~!=.=PNy[v>ˁ+3Ǹ!١,$i sّ _eNIKH:Xz,[e%w_.6t qw_"N$eR[tm&P"᭪G( =D5&,#Fc$!IqoTWY<$ T m2TfϷe*4\Bvܳ燉fP8Uz =O$3VWW9tf" 2ysE3 /$af0 "$":[!&bf}-0YDP tlQ ;pG>*i?Ie2L< ih"'m:(PIݖq91fDǿy qZxN(z6N !A\!y!8 IDAT `DEVt1ޗ?loݠ0"0 . o"c1+cms{آ쭅1ߙ(+rKnj=Qk<熢D+Ξt 1{>(R)+'f$?{87 $ϿI9:-_4S."fx \H}C4^@}@t %DBI1#[UnVO娵ؚHIoM ~l!cdBY_1F/[XU0 B{BY_s|{I,JFmD3S2E8 Y*_o5Gޑ#eF bJS sܫJ^5sݺ e}ݺO7zof֙a6B# aof;(?O/h6LJ )]+k؝DDO=#VKec#OKI*]FÄi좣UTTmA~BZ7TB`53b?w+y?o@5.Oa6rhdT?3=ښA)isfk|@F#_k{pIQi\Wk{H\({y?y"x&}}z FʈX]^ :DE8Sh$UY9YzRtQo"x`ߺM(^~Z[)iK9맵M~MNj&,K6üt/iր؃Ӧt6X(x_] /&Hy\hT%]gJ>&ӆM,N*Mf?gI! {zaзs2xw#xxʢ);#ʻW#x2gd=}A4l27f@ۓ>&:~nPY7ǁTCJHRM|d2m -5p+in>I4R$~pt@%$i~G|D|йh8һ lIK8RkB FKR_[>)R~Zov{@'y'"TxLܾ<j˰&XH/X i*Yq^:E;yߟ2(v :k*U6:STabB,%F;'ǷI)\"xG;qsz-zswc4`*) z"e" j_0@TKgD0 eDK Bx2#!bpz a~&0"4%I}rNFgEm`"s/o,t!>مXd(+ؚh"ڳӾi Dp `U"]`7 9,A)t#UILt'r$\,SeR"ڲϚ??p21~p,J | NԎRks>AaSB7(C Y8Dp7}{XwsLEsL7<;.L2s?/*v=,&N=Jϋӿ@$7L/꼫Sk*g #˃ҾB|$W9ྡFu $D+KD:5sm_j" آ=FD{+n_ϋ:+OGׄ,0g6^%ēzyaU.'ܗYm`bJ‰ Ust],JGɈs0ߤVpK$ZIԸu込'[+KӞ=Okk%lFR{g$Q4DW Ù{q/˧OyA#.IzLuƔ/T4D;ZTzFZ,IrGS!.>AsSSAyl"K]ql"حt[F5aIyjBwZ/o36"@op(U}ʶٞDYqԮ 5Ν2lWHnݏ{7ΕuYc6o"ȝ+Br{AşרYDpU[+}=ښE}˳,pgϽݚI 2&Y5m I+{q/u>F?ݪ:6zAg"]cGt. t~(Џ5r׼Z@%*}w^z #:y< $L`:7?{5R{]^h"k칯[3` UAt;uW4dySIcmѽETdךsJW?_7dY*j:% ?Շk5rޜ jW.M^"ȝ{з^CCYeJ+h-HW2aL]H'u*I Ve mI`(Z`U@'Ś/ΡT$q>l= $]At_ݝRwMzYl^%/9&lY6s/wƃv)-TzL 2ۤ?$&ƏJb{סia18c gSi$=PzlKYg>_y=sDG@Ҽk2yJ)a0{R^D*qAlV HXҵ|(1F?q?.C""Ë;HF|#%]5LstmK̾ Hڱ$"i3=Ah <"iIKaDB\s}RB~|;۟LQ#h&nmON򜓉xh"C"Ck 9%};+"h]q;j" M-$HvGٞ؏kOW]߯;Ɂ$Mjo9E!p;w ,pK"OůIڭUN _-n8Q"]VdXC칖Z=pTLevwT%ixLjk/#k߱A&n WFzف HY# 9Ջńnm$NloDI[fmmlAL>C~Q "")kt_0ř8MdxuWqc{, B^X1-Cd$qCO}uqtvt7QXXk@{ppr#N%G4Y+/<!/#Dђ)it@ڊhY1K6"x=dyÞHIY͞>"xL9ED̯:î^A `8 ,\1ll`$Jخ$jIt^ ؙhi]4lHmeb2&D;u56x>:x;RK5+B6ğԓ_FDd܍I@1[=*I!VOa*fu]L`FM[ݷc+󋘚f/R2._:70ϡk.l5=Ap" N U){6 P sx@58 o)0 ~l=#Y}d*dFR'*'J\>Ͽ cVagc4E<4 :3`0D5?c &`6< 1 < )y .;PyK œ,`s@0ػK ˍ;Z ؤ뀍n;œxX`t5ɘ | $a>󆑰t X$1 F=s,my[cj/ONtṖ޽Ԓ 6sA"`YnJ/"7vJ/92>[XKD~h94~;ƹAֶzY0UʁԯQNu}#nKkf}Մ,]Ǒp,_31Kle^=j:smD`הv}#:N}M@45ihVe/2?^=EkWyj] O`klJQv`8aJ-hb;gǩ:5!'y)&(C ߺotsA=,TOP< /y. :i @$fǥzkT4OW`-&u%vR ?vExڤ>y'mf}t;m\xAAY|3{pNF193asDuw Sɳne"ۙ<&%o;0۸hV:ҙs5 - g]C+gx:y}@(J>w6LM{ֹWT\G61zbS*9oM^]=gL/8B3:  O1&/#4#? ZNYscҙ|ys]֍F;0Vݻ)ST6?7-4`j0aXI?갎4 Ob!m3ԬS/^#=G]7:( sݎZr}o^1X6 trfeq.|=:@pSDѨHhU`zQ0ؤ>o ;+>^ 1 @:]Jjd1;Q"j,-Ldqձt~ ̍#R{QI7Kq&@ib!&mOk`+fe;Sa%*I[Ž3hBE[?DFaoKuQO6>JR#mܗǗ 8gu9a69 I1cA9T{G W`v>F`D=A٪>`˔{hܾ@uNب~/1}7fg-O~\zc]V!,k㫐LcowJ!f7|)y? _i;$R΢nE=gi@0:à"9{U0wKv^~T*QGs F`;bQ\`#2T5&_FD.G9Xؚ1hζM{Rnrvt[\¾Cqrgk`:PW2ԹfeOUy{*jrƃ-UD-"sBrэk+NTuOq"rl?a^{Ն>{3|‹Yѭe[D#KAۯs&Qh-=ϰҾXBxDd]}Z(|9܋l*_ZU/P眘A8/S+38@SS|3hHYrܩDn*%"wzMXUw8KU.U<.66?!"r)zn**ZU$P~rm"%1-RED6aδ$lt݉7cYdLwE1)\Tum/"W#`"rl6U@w[q܄ƞ#!ߦ(.XTVU=;X*`5Uc?ueEp5~sY;rgv" ni1/ߡ\ȳ?i=owwb~uebϻ`ܤFN%VDn t$nW̑n&8^Un?_D\DDUoP 1­˼xN]YUx\DB2S~rFg)쎥- xՐ|ADnż?6M9R/bdI-`goϩOs`7"2n>_cQ;aEDVMSUט ,0Yȝ/̠5E&^D6(uv9`}DD>)"sPa}|wM%(*G!zݬ, "ce70eU4M\e@#܅%ZrۘzNcc.L $MKw*g`n^&'߉ )]Tu *PDd-8p,{f(c?J0cm\)HWs AD1[}6]FUG"2 S̕ee#pu,՘671ak~EGUC}ܔI_]T u~  evl?^DVO%"lmP< "r|"RDlVYA2yLD~#"PkUj"" @S_d[Dʧ> =L׶{3l"f8K\63JOv"2DD+6=װ~|XW1<9/~o\K)qvEhWU0я1{S"r,EO-`!"GF睱\[IQ~`m0PZ >z~3'beHeT("+O4e)X׃JYEd{؄˘}foL[lE-sgU}3b襃v&Y3!pt3TVeb_YeǕU|9H\-V|cq$b*Tɍdmjwϐ}^#矩\C>vI*bgEd]U)e"" w.qҹ)\*qy}XҒMV%ލx P;NúvMly4WI1gȍT`nآy'$aoߐˠy4r0xύ \qQlBI@-9FݱI:Wi1sN uR?Qad{L}r!v^VN^QUwW`XIQE= dłnR]"6KAv"2W`':tH n6뤝@NTջ6U[OSTS2Tf|TTuoˆW]DdV]}jrv^E)j#10+[z`p3EUvrz}ʹy`ێ}|$n;:X,=D9_Ի2 m ^.Ŏ آ2 p"o\i00[]9}p.R똼UC̰HNa+4ͨR'̻ظ`/lXjձNVP,yMj\s;E}iדL#yAFHXEΙSx9sxV`;˝u+C۫{؂Pl15$o܀3O`zsh#,0I|!IE^W@p-ٔ{X [=y@mn༅&܁}\+ar}Nd)kD̹ KFuٯp;k 4Բt- MTu];C+>,y&$oPU{> 9Ey. BF.%o XA?у+MF 0Y=7*uX Mx0ZتzNKDm|Té7OQO9vC:uWot#MQUb;ϰ8rswCU͘3N͂ǿ~8a݌:"Ra~2 6<xπ hV`? , r?c`m(Ẹ(Z(6^t5XTu[U}b~G_&h>wEdu+F?WakO~JTm(p<:FUl wajDdj9L|CDDU_R=1OIb-ȡEdg .vD(⤥'N 8Kڬ펠9E^I'N5d'oU^YUN1P``gJ-x+Q^:ק^MtN?vioo!ro4 MO;Q׻ uѹESzr1A ɓ1!hsGp=nEd-ڽ2N{iz~8UTې'w93|SUM7vqW/Wv [zW:7qK\P\0j(eiK64;9{K}}|@UǪ6,3"qM1 Q# q$)Fv&?[h/Fn T0z^O."b.rSnvgU3m "Ww0X-f;ޫSռs`;c/lFap(ˋHsyj0[곆'@UP/Ӏ47XGx6sǟR`1/'Ed)Xr%zX=9lHDf @p'nEd%6nC 9iyd|U V8]jUU&ȩy#TXt7{<^y ˅dn軬s jIrԵ1p$"u[0oTjx4-"2^FI}('@USo`;'.X)4 s~skw|&7`jرW 0o Tz_y>y `ҟJVkD珹X \=)~%UDvEDl3>&/aY䗘q<9DdI5 [ٕFx.ƀOl+sF ە螳{5<z9T:ф~Kla1IU6[?hX:)Zg|NyROƂ[^{ =Lu1Ot0p{6:^5F\07УgI:}~ |,8l6{ kȍ1GD +߂5vQl]L0Kñzt&S khAws܉cvu/K5fo+h {Sa4KNPLB6?\?l\ Surl)ob.g<+#'[@1[INԄi՗$FQ=/nK-~1u[QףwFZf>]ds),eXm^(II{ Q3˯BoM {~FybapM\6h'@?.t] |6z0u#>-> e,z 3FzTsyUGU_la6>-LR0{8\Px6Deչ$"si-i11]Tml?D$YHGQqXD|VEI*FN,kGLm7;9}+)G"UT]*"ct?V 0X%q6A{K>--duy|LVS3T#j5':?P|؊Y_DZX9]D84DX_lr/a RG2 SȢjRrIDV.P x8#U-."u.T}71/ae^EUwVXqrYr>I9CUn.+"{0U}GUD"" n^r5f=#DdUg`p8.LY׮=]Gz!s>*"8HߤH nd˫mEԧ4. {Kl% ],( 9:K/~#LQlS^#rN;܆IԅᣱLyDs fG#Ryck ωߝTuo#Hujap4?ʢ1x[US!9/v9`ivOȟEl@`YU=Z={ß\Vnc\DV.m֪QD61~M\ӛ&"},/d?Ezy9oZnݱ03"X7Tl2= MTLPvϊNhvAgbk8=slLLe~[UDd# PPڕU˪zQD>-/qY6U1CmY,$7q=bǼ\t9 S IVՋQՇׯ9^\馷st˥4J!~$aڙ<n}fC8zQWTul¿|VDK1j@oL?"r'N7>dk6:MD>+`zמCYV~0ض9O(716w6똧G9$uIT>`x&"ϩ.)Ɋ:U}BU=H0RDfqc;;T^xex+"?tиmr.3MdѠ51pR^JPD=svR¤sQ>aYLwbmq SsCuPNC_3SUbovtX;׀2WgfJjɧ'_׾Lm U%c !; mӷnem)cWx+܄ֈ!"TY[S;U}-眡RUB0]jn""C05f^4INS6j-tMIU?ݕcDj,] 'I_d8Xs, 9cމr v9ޙC,-7鐜er(0F51yWj4̟<<2feU㨝ȸΉ|SYpۤ 3֟V{=<1,dHm/? 4`]w`A;P}:u~$uӁ"  pNH9gL߶i㯍r0qNJir. ލǗvS4ߩ :ԟI5Mu[zo,lg|Pl UBH15)=g^UO)* nƶƹ V\UO:B?TZ5_ñ08*lz[t/sB+~4йn7")!/}AYdXqwMBé^ $cgqr/ȭ"RLwIZ_Hܷz r1Ꝫ%$d :YD@/GWxڀ^D vo^,:'uCOE%\l4>>4էM?|!A Ys<: e_U}.ώ-hבX,w:8F;@ΡC )p\."hy*ޯK&`1"7u">[rH,.'0yZON+,A͌&ǰTuFgYʭuj)瓱ޔ5ZrE`lpɄ1X`ap^9uZ?EUPʩzx( F(ux#1qsbtʐ\mOlGX~TzUY.`y[U g鿈ccٶDp,DYr5Xn!͈8fHBΠxHc SSLI^X<r>XY{,S0='ՠ«U=cmU'ۖ*P19oay޾'4i7ƿ77XkJLy`q 7zj,vu$q&yu~c 0IJu8Z/EA; kV A\=̉yDq) >|OEm}MlK\>SfsbiI?ckn6np$`; +^Ԓzr 'Q|R0Db'l0 s_%:$^H>W)gs5)@,F1kt"X NWUr Qm( x3Xvv SiFQ }04l낼>1sh:SǶz0{a/:gg6s"S!vf.@?ph4&n~w ͎Ss C7Lt/.54i=c%o Ixɩ_)6ű'0% IDAT#ð߷9KDFtoo<*m2N\QC0/'iJ}bf2"Iw}n@1lE=x8 :>'5wΙSo\ 7BHZϩՕ z~~} &aa 1ف`{ÛCvcx$n zFEmu.Y'OֹSN^vaʶv4ZM+1>w $fd{X`nI/1a_ѹ6z\@!]"_ ႣR8j2Ap:pF/-dHiܤGyyfǢ:̡~7mȦF<rG@$rǜXv\ 5 5 c-ژ` oC4,J)|sMQ/CY;@Jd=$U P{Y^_%\S:'!;z3ECbF= C15 9fR@1\sc7HMQ$@V֘,<@0ծ З75c5k>Π%I|L.FotYww5s}c1Liiw^?B-m"+(`a [?A,n|65L~ҹ/ >2Z)>$횢]8t3Z DɬVIiCRELHzy3x 7gӤ_+`oܗrcc 8cI$,]qZ`ie1q .'1:LWY {ݢmD|b>SkحY$b`6IrxqB .)=4X5vPQ>8rфB_\tB^aWz&$j+qG$Ĥ6{~puh|)F#Ra .V`I,tfkyXXӀM3ֹ%mQY$]{ S;7*Apl]ȭÝ2UJP j;"b~0H. ^baEmL&۸@5Z$DL8vyqژ sZ:>b65y Koy\Ӄ?P  B?@=9rXG$;X@\YƦcIj % ?6Hi|-L=MIYaܾo@d,%m"e;Sj<U5 9$zOw:9H7|AV}M6uj`Tu)ouHlG! ,/px@jn>iT u4Lw1f^wm8:>L.-,~8l܃vVvJN:=hɓm=cN'"{ xG=dԍ- RWMQ?ek{'M`.|a5Lډ]ʩS--!y@P }KMJJw\A$;Sˆ19HP5-Ap|V,CxX%^w-8m>8υ:otð#(v`y,l[خlF`WUB:b❽@ϳo ys`>-{*(?!a+lhuX1/i)5$wn׻ygLp/&M}raicrmh6ha,[Е^gWy[`m:סqAC,Emw_ G_m9^:ݍ:w  rP IR/,V (ՂI7Y8Y1?nM^M̨=_/? 5ޝ]ڣvA:5KD ߐѣ@6~l!ݮVGiIxpDM-9} z}"8>.T|0lgZ,+@zp7},Km &c9Buq\Fo`hK s Em#NX[ F) `.yjMٝ׷)yR}G;O`ޯr/ ׇc|,&^# nG6}- <|Z z3{%9v?IIkaPj>>R@пL@3f OM;? 1 <oos<\D~Zs!!q`nH1^,ݜl( hVƬ~BzSו/zN県̓y:3:h&Lr}g_H/6vBR[+C<isb>!ߙdd#g2j126y AҞ_f Y_ǼVe-BJs XYg~dm@e!5?;QU!$S>`*Ȯ>U%@azFP4x> n$6>4NmJC>rަ_Z=J8bǀp-s@01c19O]JNF] Jfyh a!Do>{H_:s!jc4S9(,Z ز< 4I=(|!gGa`~rg&0u,#V6`TZ/6&$/zޙUO$[a_Ƒn̍vRAb>B do8KӔ>G6>SMcr"`zL*azLͲ,ALAbAEa;es u,.MkŔTf\ A!HVvCj3!!OD,@pNJ/ 7a{|nCo2^V=a.|jAp4̮/OsChH2w yv1,khHNS1oq Kz4+azC?``M,㢟 _P}<^TY fd ?̉ޚ'R,Z5|<灎KSf !# q=H>΋r]Ӏ;jwoApFM27va`);%xka^eJ֠aA|\zţk8|Fie6*Qv>T[ Ga\tt}p;nL-92@;6DEXyTxhStY99jxtX.Z_CByBi˧LQbI`B"p0{%mPql}F?AÈ}% --,|6vgs`ѫ{NMoppZ@i ~>t ^< qtިu09xNT^d2ps6Ki'F@qz/3yM'ȟC;sQ-vu2o >8i"ӱE:E3=z..qYf@ Gb}xՑFN?kM>ϲkbrLnp*nhev`>1=qoQ;gE\Q7b0}z:D<`ǐFFB & eJ;S$ ZtNHN ]f%' xK6A#e 4gt}O_B}@`.҄:F?97~dVxT*RH8c'28=1w@lW+fk(ރ@")cev`]}e*KVb =PSDlQ;!Xj a@N, ac@1 WƖ@9gǂT[:~2 hLbhL=jҨ27;< \rkdBw2,12Ņg:0ƂI&%ȨQyѹ濍@@&!& PeX,Ѧ/{1Cw6jΞ#c">lr ziF*[r֜|g*6~,UtkjIb-^vϔl2Sk._ |AmO4_tlԇp|lkq >hp?fy5`v0%-t6i!@O (cpR=@:25c+Iks7_@sWB8JI2c0OxB!Ā:-݇Es  N>WjaG[߁ 8/$X880nA }pw_3Z<C~@ijjwyo$jv>N@1vEu~tWƂEOƈ3E`W/{9@?NM#rOGG%@pf<UQ09m)s\:q^-y1;X8]@p׬mv؏PSK6[78>;>wtaMLv,6rtk$ح*3۷g?뻡0+M>-aғw'ΦN [q*G,ƍgC;+'=Rv`tpͳ5@>NmꁏβԦ3V*2NR,Vt?g@ [ITs <BV Y3} iP(yD7l׌v(LG5yK,nX3p^2]F:'{hU-Bmd76= /|)&$ ?vAOꝌsd]"Va}7!}.{OTgKm +;^K4! IM 6vyAP$Aot\@#7V@KF3c}"ى@~#N,U>R)91a 3 \}ׇ(l}1JP{d1,˽-ޙ//:P( `/I7f 6 ˛Xg?U;^ ޻+5C؝Z`h6z/j =yn ~_ s+ *wk[!d Pl 3v6aX^wϩATOa:a0AKqS,yxUji@$p6qF?$벯0Vh&`.|Ϫt ,mz$Ir=GCXm0/,A=Ob*@+x޷q1_Un H*`T! 4eHLI!Vtd˫!z|ј`L;NU3NVꙪ111K;eTOٺY~ EjleyUN{+)LTUK2/𜈜'"KDOQ1ϜK#hY/\fT%JI|szVRQg),a/39QU uIh<!;}rKOva"܉YVSߧ]SI$T|U; C8]D5S^@0DtY "܅0|X^?TPtjS2\gCy3/gw#!Q pS},)hG!ZDҗ@/>!he(RzVq|+ y Vt; *i[T5U=R3b@p;`po@Iq*(?/ (zJ!)8$`vB@)Kt bK2Cy-þwA+ ,ͷ8@X<: NN=$cTPvvxȻ6^+)KΨ6B]@ N3T0@0l"2|::۵*/f1) 4 niPy_fm{.ʮUIi$ J @/ fxm&"bju#҃:K#YEd$XP([WI+a솒NC@_GD2&IDAT~R X5X[U.L%v"ҿ3ƅ6RտVc2>{b w; 1*X#C| u^x*K hPv"2qY\mCKf5+h/; u~pB.!zT obpv?Fp^U},B@DȞl =<:.`KU]WUt%YT9Uй8 /"NjȂSU"`a ~UX"p vc1PJ*UFc*aO3mG]2vn1PU{+lb6oC8@X;?=8A-F "sXʇ0Pn6QT2I`gsc0NDYP0k܉`B%=#p/f9F Tu3U_̅9Dl~R,╪Q͊PUoWխ1k01&+@t2 @Dv0Gr;u*-NuTuku<UZxsœJz. Dd9GAznU?*S 7Cpۋo2 l ,r=nw~% 9;/mMu+DdVU鸾<DdX{XD(U}+sL`?3ډ+[,%w"ӱ-Ѫd+d0 RJ ,?cT3^LDvf%S|FKDdj=ŗ\7uLmM4TvJ fߋaY!x@\)$7KDdML=}'h0ފKUu|vK?:qlT QI%^RK<`F; !"ñ~wL>p!pڳ+EDd>,oQ,ӁX;EERHWP3|ʇW(U}]#.}nc * _DrQYs6aLtǩޡJ:@m/LwSU})UR`pIT޾,Ӂ׈7V6 HW.J*) ORXU}ȾUҾ 1o1ATVI%e~h,2NRY%K534UPp*PIl>lhR* "" cʷJ*pR@,/".MTէ[%TRI#i1SnKSJJ(ITYZ2 ̃%G;M_%$J ^x g<C%TRI^2ˀ/m,Z-#_%TRI4#"]/ epl/sTRI%386 hY/\$:ZTR ^xiuPJ*?""CP c6 X2(K/ TT*rKGaia40܎!._TRIdf/3x |K>ZUo(cTRI2 /H۱ WֱJ*T Xe/ 8X\B% rVfj UX|'p){%T26`/qJ燀+@)4 R$c'PB% i` 4[aQT2U^T*R@gRA""|.\3w:URI%TНT@Ёpq*@¤`mH]l?~zET7iUhRAFqpN_EJz%K* (Xpׁ_;EJ )LDd5 ,Yv}nrK%Ys;.pTPɀfG* (*۩0(U}ȾURI#iW@I"",CNQ7[%x``JLDdla"pZd*y- P0}B̆Jq=dfppbG* ""KPT"V T@0HDDvf>.VЧ p`,w'?aǿA̴y!MN lH1/;knc bah ;*14mj166hC?{S:~哪[om7s {OK+`58$k}u 5pLw.ҤFJ>A @3( WM>D'.}smR] @(-af7w l".}smR @;)-cf7 Zw,$Bƀ3Xh r-A.E`o˹633b$3ES0\OI> vSZF!lz}FAx8Cؒsm; LG!I AX,w7d Lc@@J~5 Qw'd @fdfo<=nkr ̅B Rr4Vl IJx7 RdNl/*`8:ǁ!w+Z`I+2+ ̋ \ Ǥqk6 B R*4 Cx5׺N^R'R.'K .l k 3XG7Rd^)38C8>'ӴqF B }QpBN쩬 AIv]&H_]o6l5@E!(| ա.m(2h T!ci'^?wgG=(g dQV>Zv!ϸ&HV%w.4@HU(R ӽ6 UHLsxɶRt\ F_AxNAH9i  HR9+  uHm FQwߙk]S)R7 N (pI}ls?3KZRRwl3 L]'ĥ+@jA!3 =;AxUi 3;xbـ3z@F!1D.crtK\F 4B ef+G`6ϙ O( 4F Owuߛ Hk٩2J`wg!`RT6Ruqx0=`p~mD6 @L!2SN;gxH(zfv @?v[()[ IENDB`zarr-python-3.3.0/packages/zarr-metadata/docs/api/000077500000000000000000000000001523267620000220305ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/docs/api/index.md000066400000000000000000000021241523267620000234600ustar00rootroot00000000000000--- title: API reference --- # API reference The package is organized to mirror the structure of the Zarr specifications: - [`zarr_metadata.model`](model.md) — frozen-dataclass document models, structural validators, loc-aware parsers, and the `UNSET` sentinel - [`zarr_metadata.pydantic`](pydantic.md) — optional Pydantic field types over the models - [`zarr_metadata.v2`](v2.md) — `TypedDict` shapes for Zarr v2 documents (`.zarray`, `.zgroup`, `.zattrs`, `.zmetadata`) - [`zarr_metadata.v3`](v3/index.md) — `TypedDict` shapes for Zarr v3 documents, with subpackages for [chunk grids](v3/chunk_grid.md), [chunk key encodings](v3/chunk_key_encoding.md), [codecs](v3/codec.md), and [data types](v3/data_type.md) Every public name is also re-exported at the top level, so `from zarr_metadata import ZarrV3ArrayMetadataJSON` and `from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON` are equivalent. ## Common types A few cross-cutting aliases are exported only from the top-level `zarr_metadata` namespace: ::: zarr_metadata.JSONValue ::: zarr_metadata.ZarrV3NamedConfigJSON zarr-python-3.3.0/packages/zarr-metadata/docs/api/model.md000066400000000000000000000000561523267620000234530ustar00rootroot00000000000000--- title: model --- ::: zarr_metadata.model zarr-python-3.3.0/packages/zarr-metadata/docs/api/pydantic.md000066400000000000000000000000641523267620000241650ustar00rootroot00000000000000--- title: pydantic --- ::: zarr_metadata.pydantic zarr-python-3.3.0/packages/zarr-metadata/docs/api/v2.md000066400000000000000000000003421523267620000227000ustar00rootroot00000000000000--- title: v2 --- ::: zarr_metadata.v2 options: members: false ::: zarr_metadata.v2.array ::: zarr_metadata.v2.group ::: zarr_metadata.v2.attributes ::: zarr_metadata.v2.codec ::: zarr_metadata.v2.consolidated zarr-python-3.3.0/packages/zarr-metadata/docs/api/v3/000077500000000000000000000000001523267620000223605ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/docs/api/v3/chunk_grid.md000066400000000000000000000002631523267620000250200ustar00rootroot00000000000000--- title: chunk_grid --- ::: zarr_metadata.v3.chunk_grid options: members: false ::: zarr_metadata.v3.chunk_grid.regular ::: zarr_metadata.v3.chunk_grid.rectilinear zarr-python-3.3.0/packages/zarr-metadata/docs/api/v3/chunk_key_encoding.md000066400000000000000000000003121523267620000265240ustar00rootroot00000000000000--- title: chunk_key_encoding --- ::: zarr_metadata.v3.chunk_key_encoding options: members: false ::: zarr_metadata.v3.chunk_key_encoding.default ::: zarr_metadata.v3.chunk_key_encoding.v2 zarr-python-3.3.0/packages/zarr-metadata/docs/api/v3/codec.md000066400000000000000000000006371523267620000237650ustar00rootroot00000000000000--- title: codec --- ::: zarr_metadata.v3.codec options: members: false ::: zarr_metadata.v3.codec.blosc ::: zarr_metadata.v3.codec.bytes ::: zarr_metadata.v3.codec.cast_value ::: zarr_metadata.v3.codec.crc32c ::: zarr_metadata.v3.codec.gzip ::: zarr_metadata.v3.codec.scale_offset ::: zarr_metadata.v3.codec.sharding_indexed ::: zarr_metadata.v3.codec.transpose ::: zarr_metadata.v3.codec.zstd zarr-python-3.3.0/packages/zarr-metadata/docs/api/v3/data_type.md000066400000000000000000000015231523267620000246550ustar00rootroot00000000000000--- title: data_type --- ::: zarr_metadata.v3.data_type options: members: false ::: zarr_metadata.v3.data_type.bool ::: zarr_metadata.v3.data_type.int8 ::: zarr_metadata.v3.data_type.int16 ::: zarr_metadata.v3.data_type.int32 ::: zarr_metadata.v3.data_type.int64 ::: zarr_metadata.v3.data_type.uint8 ::: zarr_metadata.v3.data_type.uint16 ::: zarr_metadata.v3.data_type.uint32 ::: zarr_metadata.v3.data_type.uint64 ::: zarr_metadata.v3.data_type.float16 ::: zarr_metadata.v3.data_type.float32 ::: zarr_metadata.v3.data_type.float64 ::: zarr_metadata.v3.data_type.complex64 ::: zarr_metadata.v3.data_type.complex128 ::: zarr_metadata.v3.data_type.raw ::: zarr_metadata.v3.data_type.bytes ::: zarr_metadata.v3.data_type.string ::: zarr_metadata.v3.data_type.numpy_datetime64 ::: zarr_metadata.v3.data_type.numpy_timedelta64 zarr-python-3.3.0/packages/zarr-metadata/docs/api/v3/index.md000066400000000000000000000003231523267620000240070ustar00rootroot00000000000000--- title: v3 --- ::: zarr_metadata.v3 options: members: false ::: zarr_metadata.v3.ZarrV3MetadataFieldJSON ::: zarr_metadata.v3.array ::: zarr_metadata.v3.group ::: zarr_metadata.v3.consolidated zarr-python-3.3.0/packages/zarr-metadata/docs/index.md000066400000000000000000000077011523267620000227150ustar00rootroot00000000000000# zarr-metadata Basic tools for modelling Zarr metadata, with minimal dependencies. `zarr-metadata` is developed in the [zarr-python repository](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata) and released independently of `zarr` itself. Install it with: ``` pip install zarr-metadata ``` ## Who needs this This library might be useful to you if your software interacts with Zarr metadata documents. ## What this is This library is *not* a full Zarr implementation. Instead, it's a collection of data structures and routines that closely model the content of the Zarr specifications, such as: - **Typed JSON shapes** ([`zarr_metadata.v2`](api/v2.md) and [`zarr_metadata.v3`](api/v3/index.md)): `TypedDict` definitions and `Literal` aliases for the JSON documents specified by the [Zarr v2](https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html) and [Zarr v3](https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html) specifications, plus types for [zarr-extensions](https://github.com/zarr-developers/zarr-extensions/) and a few widely-used-but-unspecified entities (e.g. consolidated metadata). - **Document models** ([`zarr_metadata.model`](api/model.md)): canonical frozen-dataclass models of whole metadata documents, with structural validators, loc-aware parsers, and store-key (de)serialization. A document produced by `to_json` shares no mutable state with the model that produced it. - **Optional Pydantic integration** ([`zarr_metadata.pydantic`](api/pydantic.md), requires Pydantic 2.13 or newer): each model as a Pydantic field type that validates raw documents through the same strict parser. ## What this is for The public `TypedDict` definitions describe the static JSON shape of Zarr metadata. For strict, loc-aware validation of JSON loaded from disk, use the model parser: ```python import json from zarr_metadata.model import ZarrV3ArrayMetadata with open("zarr.json", "rb") as f: raw = json.load(f) metadata = ZarrV3ArrayMetadata.from_json(raw) ``` The optional Pydantic integration delegates raw input to the same strict parser and returns the same normalized model class: ```python from pydantic import TypeAdapter import zarr_metadata.pydantic as zmp metadata = TypeAdapter(zmp.ZarrV3ArrayMetadata).validate_python(raw) encoded = metadata.to_key_value()["zarr.json"] ``` A bare `TypeAdapter` over a public document `TypedDict` is a coercive shape adapter, not a Zarr conformance validator; it may coerce values or discard members that the strict model parser rejects. ## Validation boundary The model validators enforce the declared document structure and a small set of context-free consistency rules, including fixed format literals, finite JSON numbers, non-negative dimensions, non-empty v3 codec pipelines, and one `dimension_names` entry per array dimension. They do not interpret extension names or configurations, resolve codec pipelines, or decide whether a data type, chunk grid, codec, or storage transformer is supported. Those decisions belong to consumer implementations. ## Scope At minimum, this library supports what Zarr-Python needs: the complete Zarr v2 and v3 specs, consolidated metadata, and a subset of the metadata defined in `zarr-extensions`. We are generally open to contributions that add types, models, or structural validation for Zarr metadata with a published spec. Runtime array behavior is out of scope: nothing here encodes or decodes chunks, resolves codec or data type names to implementations, or performs store I/O. The models begin and end at the metadata documents themselves — `from_key_value` / `to_key_value` map documents to store keys and bytes, and everything past that belongs to consumer libraries. ## Reference - [API reference](api/index.md) - [Changelog](https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-metadata/CHANGELOG.md) - [License (MIT)](https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-metadata/LICENSE.txt) zarr-python-3.3.0/packages/zarr-metadata/justfile000066400000000000000000000035621523267620000221050ustar00rootroot00000000000000# Development verbs for the zarr-metadata package. Recipes run with this # directory as the working directory regardless of where `just` is invoked. # List available recipes default: @just --list # Run the test suite; extra args are passed to pytest test *args: uv run --group test pytest tests {{ args }} # Lint with the same invocation CI uses lint: uvx ruff check . # Pinned to the last pyright that types PEP 661 sentinels in class attributes # correctly; 1.1.405+ regressed (microsoft/pyright#11115). Unpin when fixed. pyright_version := "1.1.404" # CI runs pyright on python 3.11; the pinned pyright predates 3.14, whose # stdlib it cannot parse, so pin the interpreter to match CI. # Type-check the package sources typecheck: uv run --python 3.11 --group test --with 'pyright=={{ pyright_version }}' pyright src # Run everything CI runs for this package check: lint typecheck test docs-check # Preview the changelog that the next release would generate changelog-draft: uvx towncrier build --draft --version Unreleased # Build this package's documentation site, warnings as errors docs-check: env DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs build --strict # With no argument, uses port 8000 if free, otherwise an ephemeral free port; # an explicitly requested port is used as-is so a conflict fails loudly. # Serve this package's documentation site docs-serve port="": #!/usr/bin/env bash set -euo pipefail port="{{ port }}" if [ -z "$port" ]; then port=$(uv run --group docs python -c ' import socket s = socket.socket() try: s.bind(("127.0.0.1", 8000)) except OSError: s.close() s = socket.socket() s.bind(("127.0.0.1", 0)) print(s.getsockname()[1]) s.close() ') fi exec env DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs serve -a "localhost:$port" zarr-python-3.3.0/packages/zarr-metadata/mkdocs.yml000066400000000000000000000072521523267620000223400ustar00rootroot00000000000000site_name: zarr-metadata # The package lives in the zarr-python monorepo; point the header source # widget at the package directory rather than the repository root. repo_name: zarr-python/packages/zarr-metadata repo_url: https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata # Absolute because mkdocs would otherwise append this to repo_url's subpath. edit_uri: https://github.com/zarr-developers/zarr-python/edit/main/packages/zarr-metadata/docs/ site_description: Spec-defined metadata types, models, and validators for Zarr v2 and v3. site_author: Davis Bennett site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://zarr-metadata.readthedocs.io/'] docs_dir: docs use_directory_urls: true nav: - index.md - API Reference: - api/index.md - ' zarr_metadata.model': api/model.md - ' zarr_metadata.pydantic': api/pydantic.md - ' zarr_metadata.v2': api/v2.md - ' zarr_metadata.v3': - api/v3/index.md - ' zarr_metadata.v3.chunk_grid': api/v3/chunk_grid.md - ' zarr_metadata.v3.chunk_key_encoding': api/v3/chunk_key_encoding.md - ' zarr_metadata.v3.codec': api/v3/codec.md - ' zarr_metadata.v3.data_type': api/v3/data_type.md - Changelog: https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-metadata/CHANGELOG.md watch: - src theme: language: en name: material logo: _static/logo_bw.png favicon: _static/favicon-96x96.png palette: # Light mode - media: "(prefers-color-scheme: light)" scheme: default toggle: icon: material/brightness-7 name: Switch to dark mode # Dark mode - media: "(prefers-color-scheme: dark)" scheme: slate toggle: icon: material/brightness-4 name: Switch to light mode font: text: Roboto code: Roboto Mono features: - content.code.annotate - content.code.copy - navigation.indexes - navigation.instant - navigation.tracking - search.suggest - search.share plugins: - autorefs - search - mkdocstrings: enable_inventory: true handlers: python: paths: [src] options: allow_inspection: true docstring_section_style: list docstring_style: numpy inherited_members: true line_length: 60 separate_signature: true show_root_heading: true show_signature_annotations: true show_source: true show_symbol_type_toc: true signature_crossrefs: true show_if_no_docstring: true extensions: - griffe_inherited_docstrings inventories: - https://docs.python.org/3/objects.inv - https://zarr.readthedocs.io/en/stable/objects.inv markdown_extensions: - admonition - attr_list - def_list - footnotes - md_in_html - pymdownx.details - pymdownx.superfences - toc: permalink: true - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite zarr-python-3.3.0/packages/zarr-metadata/pyproject.toml000066400000000000000000000104651523267620000232510ustar00rootroot00000000000000[build-system] requires = ["hatchling>=1.29.0", "hatch-vcs"] build-backend = "hatchling.build" [project] name = "zarr-metadata" dynamic = ["version"] description = "Spec-defined metadata types, models, and validators for Zarr v2 and v3." readme = "README.md" requires-python = ">=3.11" license = "MIT" license-files = ["LICENSE.txt"] authors = [ { name = "Davis Bennett", email = "davis.v.bennett@gmail.com" }, ] classifiers = [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14", "Topic :: Scientific/Engineering", "Topic :: Software Development :: Libraries :: Python Modules", "Typing :: Typed", ] keywords = ["zarr"] dependencies = [ # >=4.16: first release where `Sentinel` pickles by reference # (`__reduce__` returns the sentinel's name), so `UNSET` — and any model # holding it — can cross process boundaries and be deep-copied with its # singleton identity intact. 4.15 and earlier refuse to pickle sentinels. "typing_extensions>=4.16", ] [project.urls] Homepage = "https://github.com/zarr-developers/zarr-python" Source = "https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata" Issues = "https://github.com/zarr-developers/zarr-python/issues" Changelog = "https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-metadata/CHANGELOG.md" Documentation = "https://zarr-metadata.readthedocs.io/" [dependency-groups] test = ["pytest", "pydantic>=2.13", "jsonschema"] docs = [ # Pins match the zarr-python docs environment in the repo-root # pyproject.toml so the two sites render with the same toolchain. "mkdocs-material==9.7.6", "mkdocs==1.6.1", "mkdocstrings==1.0.4", "mkdocstrings-python==2.0.5", "griffe-inherited-docstrings==1.1.3", # mkdocstrings uses ruff to format rendered signatures "ruff==0.15.20", ] [tool.hatch.version] source = "vcs" tag-pattern = '^zarr_metadata-v(?P.+)$' # `git_describe_command` ensures we get the zarr_metadata tags instead of latest. # `local_scheme` strips the git commit info so the appending info is just a counter from latest tag. # test-pypi doesn't accept git commit info in tags, and the count should be enough to distinguish unique runs. raw-options = { root = "../..", git_describe_command = "git describe --dirty --tags --long --match zarr_metadata-v*", local_scheme = "no-local-version" } [tool.hatch.build.targets.wheel] packages = ["src/zarr_metadata"] [tool.ruff] extend = "../../pyproject.toml" target-version = "py311" [tool.pytest.ini_options] minversion = "7" testpaths = ["tests"] xfail_strict = true addopts = ["-ra", "--strict-config", "--strict-markers"] filterwarnings = [ "error", # Pydantic validates these public immutable-shape TypedDicts correctly but # cannot enforce the type checker's ReadOnly mutation restriction. "ignore:Items? .* using the `ReadOnly` qualifier.*:UserWarning:pydantic._internal._generate_schema", ] [tool.numpydoc_validation] checks = [ "GL10", "SS04", "PR02", "PR03", "PR05", "PR06", ] # CI pins pyright==1.1.404: later versions regress PEP 661 sentinel typing in # class attributes (microsoft/pyright#11115), which zarr_metadata.model._sentinel # relies on. Use the same pin locally; unpin when the fix lands. [tool.pyright] include = ["src"] enableExperimentalFeatures = true typeCheckingMode = "strict" pythonVersion = "3.11" [tool.towncrier] # Fragments for this package live alongside the package source, separate # from the parent zarr-python `changes/` directory, so a PR touching only # `packages/zarr-metadata/` produces a release note for this package only. directory = "changes" filename = "CHANGELOG.md" package = "zarr_metadata" underlines = ["", "", ""] title_format = "## {version} ({project_date})" issue_format = "[#{issue}](https://github.com/zarr-developers/zarr-python/pull/{issue})" start_string = "\n" zarr-python-3.3.0/packages/zarr-metadata/src/000077500000000000000000000000001523267620000211165ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/000077500000000000000000000000001523267620000237345ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/__init__.py000066400000000000000000000244171523267620000260550ustar00rootroot00000000000000from importlib.metadata import version from zarr_metadata._common import JSONValue, ZarrV3NamedConfigJSON from zarr_metadata.model import ( UNSET, MetadataValidationError, ProblemKind, ValidationProblem, ZarrV2ArrayMetadata, ZarrV2ArrayMetadataPartial, ZarrV2ConsolidatedMetadata, ZarrV2GroupMetadata, ZarrV2GroupMetadataPartial, ZarrV3ArrayMetadata, ZarrV3ArrayMetadataPartial, ZarrV3ConsolidatedMetadata, ZarrV3GroupMetadata, ZarrV3GroupMetadataPartial, ZarrV3MetadataField, ZarrV3NamedConfig, ) from zarr_metadata.v2.array import ( ARRAY_DIMENSION_SEPARATOR_V2, ARRAY_ORDER_V2, ZarrV2ArrayDimensionSeparator, ZarrV2ArrayMetadataJSON, ZarrV2ArrayMetadataJSONPartial, ZarrV2ArrayOrder, ZarrV2DataTypeMetadata, ZarrV2ZArrayJSON, ) from zarr_metadata.v2.attributes import ZarrV2ZAttrsJSON from zarr_metadata.v2.codec import ZarrV2CodecMetadata from zarr_metadata.v2.consolidated import ZarrV2ConsolidatedMetadataJSON from zarr_metadata.v2.group import ( ZarrV2GroupMetadataJSON, ZarrV2GroupMetadataJSONPartial, ZarrV2ZGroupJSON, ) from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON from zarr_metadata.v3.array import ( ZarrV3ArrayMetadataJSON, ZarrV3ArrayMetadataJSONPartial, ZarrV3ExtensionField, ) from zarr_metadata.v3.chunk_grid.rectilinear import ( RECTILINEAR_CHUNK_GRID_NAME, RectilinearChunkGridMetadata, RectilinearChunkGridName, ) from zarr_metadata.v3.chunk_grid.regular import ( REGULAR_CHUNK_GRID_NAME, RegularChunkGridMetadata, RegularChunkGridName, ) from zarr_metadata.v3.chunk_key_encoding.default import ( DEFAULT_CHUNK_KEY_ENCODING_NAME, DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR, DefaultChunkKeyEncodingMetadata, DefaultChunkKeyEncodingName, DefaultChunkKeyEncodingSeparator, ) from zarr_metadata.v3.chunk_key_encoding.v2 import ( V2_CHUNK_KEY_ENCODING_NAME, V2_CHUNK_KEY_ENCODING_SEPARATOR, V2ChunkKeyEncodingMetadata, V2ChunkKeyEncodingName, V2ChunkKeyEncodingSeparator, ) from zarr_metadata.v3.codec.blosc import ( BLOSC_CNAME, BLOSC_CODEC_NAME, BLOSC_SHUFFLE, BloscCName, BloscCodecMetadata, BloscCodecName, BloscShuffle, ) from zarr_metadata.v3.codec.bytes import ( BYTES_CODEC_NAME, ENDIANNESS, BytesCodecMetadata, BytesCodecName, Endianness, ) from zarr_metadata.v3.codec.cast_value import ( CAST_OUT_OF_RANGE_MODE, CAST_ROUNDING_MODE, CAST_VALUE_CODEC_NAME, CastOutOfRangeMode, CastRoundingMode, CastValueCodecMetadata, CastValueCodecName, ) from zarr_metadata.v3.codec.crc32c import CRC32C_CODEC_NAME, Crc32cCodecMetadata, Crc32cCodecName from zarr_metadata.v3.codec.gzip import GZIP_CODEC_NAME, GzipCodecMetadata, GzipCodecName from zarr_metadata.v3.codec.scale_offset import ( SCALE_OFFSET_CODEC_NAME, ScaleOffsetCodecMetadata, ScaleOffsetCodecName, ) from zarr_metadata.v3.codec.sharding_indexed import ( SHARDING_INDEX_LOCATION, SHARDING_INDEXED_CODEC_NAME, ShardingIndexedCodecMetadata, ShardingIndexedCodecName, ShardingIndexLocation, ) from zarr_metadata.v3.codec.transpose import ( TRANSPOSE_CODEC_NAME, TransposeCodecMetadata, TransposeCodecName, ) from zarr_metadata.v3.codec.zstd import ZSTD_CODEC_NAME, ZstdCodecMetadata, ZstdCodecName from zarr_metadata.v3.consolidated import ZarrV3ConsolidatedMetadataJSON from zarr_metadata.v3.data_type.bool import ( BOOL_DATA_TYPE_NAME, BoolDataTypeName, BoolFillValue, ) from zarr_metadata.v3.data_type.bytes import ( BYTES_DATA_TYPE_NAME, BytesDataTypeName, BytesFillValue, ) from zarr_metadata.v3.data_type.complex64 import ( COMPLEX64_DATA_TYPE_NAME, Complex64DataTypeName, Complex64FillValue, ) from zarr_metadata.v3.data_type.complex128 import ( COMPLEX128_DATA_TYPE_NAME, Complex128DataTypeName, Complex128FillValue, ) from zarr_metadata.v3.data_type.float16 import ( FLOAT16_DATA_TYPE_NAME, Float16DataTypeName, Float16FillValue, ) from zarr_metadata.v3.data_type.float32 import ( FLOAT32_DATA_TYPE_NAME, Float32DataTypeName, Float32FillValue, ) from zarr_metadata.v3.data_type.float64 import ( FLOAT64_DATA_TYPE_NAME, Float64DataTypeName, Float64FillValue, ) from zarr_metadata.v3.data_type.int8 import ( INT8_DATA_TYPE_NAME, Int8DataTypeName, Int8FillValue, ) from zarr_metadata.v3.data_type.int16 import ( INT16_DATA_TYPE_NAME, Int16DataTypeName, Int16FillValue, ) from zarr_metadata.v3.data_type.int32 import ( INT32_DATA_TYPE_NAME, Int32DataTypeName, Int32FillValue, ) from zarr_metadata.v3.data_type.int64 import ( INT64_DATA_TYPE_NAME, Int64DataTypeName, Int64FillValue, ) from zarr_metadata.v3.data_type.numpy_datetime64 import ( NUMPY_DATETIME64_DATA_TYPE_NAME, NumpyDatetime64DataTypeName, NumpyDatetime64FillValue, ) from zarr_metadata.v3.data_type.numpy_timedelta64 import ( NUMPY_TIME_UNIT, NUMPY_TIMEDELTA64_DATA_TYPE_NAME, NumpyTimedelta64DataTypeName, NumpyTimedelta64FillValue, NumpyTimeUnit, ) from zarr_metadata.v3.data_type.raw import RawBytesDataTypeName, RawBytesFillValue from zarr_metadata.v3.data_type.string import ( STRING_DATA_TYPE_NAME, StringDataTypeName, StringFillValue, ) from zarr_metadata.v3.data_type.struct import ( STRUCT_DATA_TYPE_NAME, StructDataTypeName, StructFillValue, ) from zarr_metadata.v3.data_type.uint8 import ( UINT8_DATA_TYPE_NAME, Uint8DataTypeName, Uint8FillValue, ) from zarr_metadata.v3.data_type.uint16 import ( UINT16_DATA_TYPE_NAME, Uint16DataTypeName, Uint16FillValue, ) from zarr_metadata.v3.data_type.uint32 import ( UINT32_DATA_TYPE_NAME, Uint32DataTypeName, Uint32FillValue, ) from zarr_metadata.v3.data_type.uint64 import ( UINT64_DATA_TYPE_NAME, Uint64DataTypeName, Uint64FillValue, ) from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON, ZarrV3GroupMetadataJSONPartial __version__ = version("zarr-metadata") __all__ = [ "ARRAY_DIMENSION_SEPARATOR_V2", "ARRAY_ORDER_V2", "BLOSC_CNAME", "BLOSC_CODEC_NAME", "BLOSC_SHUFFLE", "BOOL_DATA_TYPE_NAME", "BYTES_CODEC_NAME", "BYTES_DATA_TYPE_NAME", "CAST_OUT_OF_RANGE_MODE", "CAST_ROUNDING_MODE", "CAST_VALUE_CODEC_NAME", "COMPLEX64_DATA_TYPE_NAME", "COMPLEX128_DATA_TYPE_NAME", "CRC32C_CODEC_NAME", "DEFAULT_CHUNK_KEY_ENCODING_NAME", "DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR", "ENDIANNESS", "FLOAT16_DATA_TYPE_NAME", "FLOAT32_DATA_TYPE_NAME", "FLOAT64_DATA_TYPE_NAME", "GZIP_CODEC_NAME", "INT8_DATA_TYPE_NAME", "INT16_DATA_TYPE_NAME", "INT32_DATA_TYPE_NAME", "INT64_DATA_TYPE_NAME", "NUMPY_DATETIME64_DATA_TYPE_NAME", "NUMPY_TIMEDELTA64_DATA_TYPE_NAME", "NUMPY_TIME_UNIT", "RECTILINEAR_CHUNK_GRID_NAME", "REGULAR_CHUNK_GRID_NAME", "SCALE_OFFSET_CODEC_NAME", "SHARDING_INDEXED_CODEC_NAME", "SHARDING_INDEX_LOCATION", "STRING_DATA_TYPE_NAME", "STRUCT_DATA_TYPE_NAME", "TRANSPOSE_CODEC_NAME", "UINT8_DATA_TYPE_NAME", "UINT16_DATA_TYPE_NAME", "UINT32_DATA_TYPE_NAME", "UINT64_DATA_TYPE_NAME", "UNSET", "V2_CHUNK_KEY_ENCODING_NAME", "V2_CHUNK_KEY_ENCODING_SEPARATOR", "ZSTD_CODEC_NAME", "BloscCName", "BloscCodecMetadata", "BloscCodecName", "BloscShuffle", "BoolDataTypeName", "BoolFillValue", "BytesCodecMetadata", "BytesCodecName", "BytesDataTypeName", "BytesFillValue", "CastOutOfRangeMode", "CastRoundingMode", "CastValueCodecMetadata", "CastValueCodecName", "Complex64DataTypeName", "Complex64FillValue", "Complex128DataTypeName", "Complex128FillValue", "Crc32cCodecMetadata", "Crc32cCodecName", "DefaultChunkKeyEncodingMetadata", "DefaultChunkKeyEncodingName", "DefaultChunkKeyEncodingSeparator", "Endianness", "Float16DataTypeName", "Float16FillValue", "Float32DataTypeName", "Float32FillValue", "Float64DataTypeName", "Float64FillValue", "GzipCodecMetadata", "GzipCodecName", "Int8DataTypeName", "Int8FillValue", "Int16DataTypeName", "Int16FillValue", "Int32DataTypeName", "Int32FillValue", "Int64DataTypeName", "Int64FillValue", "JSONValue", "MetadataValidationError", "NumpyDatetime64DataTypeName", "NumpyDatetime64FillValue", "NumpyTimeUnit", "NumpyTimedelta64DataTypeName", "NumpyTimedelta64FillValue", "ProblemKind", "RawBytesDataTypeName", "RawBytesFillValue", "RectilinearChunkGridMetadata", "RectilinearChunkGridName", "RegularChunkGridMetadata", "RegularChunkGridName", "ScaleOffsetCodecMetadata", "ScaleOffsetCodecName", "ShardingIndexLocation", "ShardingIndexedCodecMetadata", "ShardingIndexedCodecName", "StringDataTypeName", "StringFillValue", "StructDataTypeName", "StructFillValue", "TransposeCodecMetadata", "TransposeCodecName", "Uint8DataTypeName", "Uint8FillValue", "Uint16DataTypeName", "Uint16FillValue", "Uint32DataTypeName", "Uint32FillValue", "Uint64DataTypeName", "Uint64FillValue", "V2ChunkKeyEncodingMetadata", "V2ChunkKeyEncodingName", "V2ChunkKeyEncodingSeparator", "ValidationProblem", "ZarrV2ArrayDimensionSeparator", "ZarrV2ArrayMetadata", "ZarrV2ArrayMetadataJSON", "ZarrV2ArrayMetadataJSONPartial", "ZarrV2ArrayMetadataPartial", "ZarrV2ArrayOrder", "ZarrV2CodecMetadata", "ZarrV2ConsolidatedMetadata", "ZarrV2ConsolidatedMetadataJSON", "ZarrV2DataTypeMetadata", "ZarrV2GroupMetadata", "ZarrV2GroupMetadataJSON", "ZarrV2GroupMetadataJSONPartial", "ZarrV2GroupMetadataPartial", "ZarrV2ZArrayJSON", "ZarrV2ZAttrsJSON", "ZarrV2ZGroupJSON", "ZarrV3ArrayMetadata", "ZarrV3ArrayMetadataJSON", "ZarrV3ArrayMetadataJSONPartial", "ZarrV3ArrayMetadataPartial", "ZarrV3ConsolidatedMetadata", "ZarrV3ConsolidatedMetadataJSON", "ZarrV3ExtensionField", "ZarrV3GroupMetadata", "ZarrV3GroupMetadataJSON", "ZarrV3GroupMetadataJSONPartial", "ZarrV3GroupMetadataPartial", "ZarrV3MetadataField", "ZarrV3MetadataFieldJSON", "ZarrV3NamedConfig", "ZarrV3NamedConfigJSON", "ZstdCodecMetadata", "ZstdCodecName", "__version__", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/_common.py000066400000000000000000000023121523267620000257330ustar00rootroot00000000000000""" Top-level cross-version primitives for Zarr metadata. Version-specific types live under `zarr_metadata.v2` and `zarr_metadata.v3`. Codec and dtype spec types live under `zarr_metadata.v3.codec` and `zarr_metadata.v3.data_type`. """ from collections.abc import Mapping from typing import NotRequired from typing_extensions import TypeAliasType, TypedDict JSONValue = TypeAliasType( "JSONValue", int | float | bool | str | list["JSONValue"] | tuple["JSONValue", ...] | Mapping[str, "JSONValue"] | None, ) """A recursive type alias for JSON-encodable values. Defined via `TypeAliasType` (rather than a plain `TypeAlias`) so the self-reference is a named recursion point that pydantic can resolve when building a `TypeAdapter`; a bare recursive `TypeAlias` raises `PydanticUserError`/`RecursionError` at validation time. """ class ZarrV3NamedConfigJSON(TypedDict): """ Externally-tagged union member for a metadata field. The optional `configuration` mapping holds arbitrary JSON-encodable values. `must_understand` is implicitly true when absent. """ name: str configuration: NotRequired[Mapping[str, JSONValue]] must_understand: NotRequired[bool] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/_pydantic_schema.py000066400000000000000000000075171523267620000276120ustar00rootroot00000000000000"""Private input types used only to generate accurate Pydantic JSON schemas.""" from __future__ import annotations from collections.abc import Mapping # noqa: TC003 # resolved by Pydantic at runtime from typing import Annotated, Literal, NotRequired from pydantic import Field from typing_extensions import TypedDict from zarr_metadata._common import JSONValue from zarr_metadata.v2.array import ( # noqa: TC001 # resolved by Pydantic at runtime ZarrV2DataTypeMetadata, ) from zarr_metadata.v2.codec import ( # resolved by Pydantic at runtime ZarrV2CodecMetadata, ) NonNegativeInt = Annotated[int, Field(ge=0)] class ZarrV3NamedConfigJSON(TypedDict, closed=True): """Closed v3 named configuration accepted at optional extension points.""" name: str configuration: NotRequired[Mapping[str, JSONValue]] must_understand: NotRequired[bool] class ZarrV3MandatoryNamedConfigJSON(TypedDict, closed=True): """Closed named configuration accepted where understanding is mandatory.""" name: str configuration: NotRequired[Mapping[str, JSONValue]] must_understand: NotRequired[Literal[True]] ZarrV3MetadataFieldJSON = str | ZarrV3NamedConfigJSON ZarrV3MandatoryMetadataFieldJSON = str | ZarrV3MandatoryNamedConfigJSON ZarrV3CodecPipelineJSON = Annotated[tuple[ZarrV3MetadataFieldJSON, ...], Field(min_length=1)] ZarrV2FilterPipelineJSON = Annotated[tuple[ZarrV2CodecMetadata, ...], Field(min_length=1)] class ZarrV3ArrayMetadataJSON(TypedDict, extra_items=JSONValue): """Schema input for a v3 array document, including arbitrary extensions.""" zarr_format: Literal[3] node_type: Literal["array"] data_type: ZarrV3MandatoryMetadataFieldJSON shape: tuple[NonNegativeInt, ...] chunk_grid: ZarrV3MandatoryMetadataFieldJSON chunk_key_encoding: ZarrV3MandatoryMetadataFieldJSON fill_value: JSONValue codecs: ZarrV3CodecPipelineJSON attributes: NotRequired[Mapping[str, JSONValue]] storage_transformers: NotRequired[tuple[ZarrV3MetadataFieldJSON, ...]] dimension_names: NotRequired[tuple[str | None, ...]] class ZarrV3ConsolidatedMetadataJSON(TypedDict, closed=True): """Schema input for the closed inline consolidated-metadata envelope.""" kind: Literal["inline"] must_understand: Literal[False] metadata: Mapping[str, ZarrV3ArrayMetadataJSON | ZarrV3GroupMetadataJSON] class ZarrV3GroupMetadataJSON(TypedDict, extra_items=JSONValue): """Schema input for a v3 group document, including arbitrary extensions.""" zarr_format: Literal[3] node_type: Literal["group"] attributes: NotRequired[Mapping[str, JSONValue]] consolidated_metadata: NotRequired[ZarrV3ConsolidatedMetadataJSON | None] class ZarrV2ArrayMetadataJSON(TypedDict, closed=True): """Schema input for the closed, merged v2 array representation.""" zarr_format: Literal[2] shape: tuple[NonNegativeInt, ...] chunks: tuple[NonNegativeInt, ...] dtype: ZarrV2DataTypeMetadata compressor: ZarrV2CodecMetadata | None fill_value: JSONValue order: Literal["C", "F"] filters: ZarrV2FilterPipelineJSON | None dimension_separator: NotRequired[Literal[".", "/"]] attributes: NotRequired[Mapping[str, JSONValue]] class ZarrV2GroupMetadataJSON(TypedDict, closed=True): """Schema input for the closed, merged v2 group representation.""" zarr_format: Literal[2] attributes: NotRequired[Mapping[str, JSONValue]] class ZarrV2ConsolidatedMetadataJSON(TypedDict, closed=True): """Schema input matching the v2 consolidated model's structural parser.""" zarr_consolidated_format: Literal[1] metadata: Mapping[str, JSONValue] __all__ = [ "ZarrV2ArrayMetadataJSON", "ZarrV2ConsolidatedMetadataJSON", "ZarrV2GroupMetadataJSON", "ZarrV3ArrayMetadataJSON", "ZarrV3ConsolidatedMetadataJSON", "ZarrV3GroupMetadataJSON", "ZarrV3MetadataFieldJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/model/000077500000000000000000000000001523267620000250345ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/model/__init__.py000066400000000000000000000102601523267620000271440ustar00rootroot00000000000000"""In-memory models for Zarr metadata documents. Models are frozen dataclasses that hold a canonical, semantically lossless representation of the JSON documents; they never interpret extension points (codecs, chunk grids, data types). Validators check JSON structure, not domain validity. Each document concept gets a `validate_*` function returning every problem found (a `list[ValidationProblem]`, each with a machine-readable `kind`), an `is_*` type guard, and a `parse_*` function that narrows or raises `MetadataValidationError`. Model `from_json` / `from_key_value` constructors raise `MetadataValidationError` for every ingestion failure, including missing store keys and undecodable bytes. """ from zarr_metadata.model._array import ( ARRAY_METADATA_STORE_KEY_V2, ARRAY_METADATA_STORE_KEY_V3, ATTRIBUTES_STORE_KEY_V2, ZarrV2ArrayMetadata, ZarrV2ArrayMetadataPartial, ZarrV2ArrayMetadataStoreKey, ZarrV2AttributesStoreKey, ZarrV3ArrayMetadata, ZarrV3ArrayMetadataPartial, ZarrV3ArrayMetadataStoreKey, ZarrV3MetadataField, ZarrV3NamedConfig, ) from zarr_metadata.model._group import ( CONSOLIDATED_METADATA_KEY_V3, CONSOLIDATED_METADATA_STORE_KEY_V2, GROUP_METADATA_STORE_KEY_V2, GROUP_METADATA_STORE_KEY_V3, ZarrV2ConsolidatedMetadata, ZarrV2ConsolidatedMetadataStoreKey, ZarrV2GroupMetadata, ZarrV2GroupMetadataPartial, ZarrV2GroupMetadataStoreKey, ZarrV3ConsolidatedMetadata, ZarrV3GroupMetadata, ZarrV3GroupMetadataPartial, ZarrV3GroupMetadataStoreKey, ) from zarr_metadata.model._sentinel import UNSET from zarr_metadata.model._validation import ( ARRAY_METADATA_OPTIONAL_KEYS_V3, ARRAY_METADATA_REQUIRED_KEYS_V2, ARRAY_METADATA_REQUIRED_KEYS_V3, ARRAY_METADATA_STANDARD_KEYS_V3, GROUP_METADATA_OPTIONAL_KEYS_V3, GROUP_METADATA_REQUIRED_KEYS_V2, GROUP_METADATA_REQUIRED_KEYS_V3, GROUP_METADATA_STANDARD_KEYS_V3, MetadataValidationError, ProblemKind, ValidationProblem, is_array_metadata_v2, is_array_metadata_v3, is_group_metadata_v2, is_group_metadata_v3, is_json, is_metadata_field_v3, parse_array_metadata_v2, parse_array_metadata_v3, parse_group_metadata_v2, parse_group_metadata_v3, parse_json, parse_metadata_field_v3, validate_array_metadata_v2, validate_array_metadata_v3, validate_group_metadata_v2, validate_group_metadata_v3, validate_json, validate_metadata_field_v3, ) __all__ = [ "ARRAY_METADATA_OPTIONAL_KEYS_V3", "ARRAY_METADATA_REQUIRED_KEYS_V2", "ARRAY_METADATA_REQUIRED_KEYS_V3", "ARRAY_METADATA_STANDARD_KEYS_V3", "ARRAY_METADATA_STORE_KEY_V2", "ARRAY_METADATA_STORE_KEY_V3", "ATTRIBUTES_STORE_KEY_V2", "CONSOLIDATED_METADATA_KEY_V3", "CONSOLIDATED_METADATA_STORE_KEY_V2", "GROUP_METADATA_OPTIONAL_KEYS_V3", "GROUP_METADATA_REQUIRED_KEYS_V2", "GROUP_METADATA_REQUIRED_KEYS_V3", "GROUP_METADATA_STANDARD_KEYS_V3", "GROUP_METADATA_STORE_KEY_V2", "GROUP_METADATA_STORE_KEY_V3", "UNSET", "MetadataValidationError", "ProblemKind", "ValidationProblem", "ZarrV2ArrayMetadata", "ZarrV2ArrayMetadataPartial", "ZarrV2ArrayMetadataStoreKey", "ZarrV2AttributesStoreKey", "ZarrV2ConsolidatedMetadata", "ZarrV2ConsolidatedMetadataStoreKey", "ZarrV2GroupMetadata", "ZarrV2GroupMetadataPartial", "ZarrV2GroupMetadataStoreKey", "ZarrV3ArrayMetadata", "ZarrV3ArrayMetadataPartial", "ZarrV3ArrayMetadataStoreKey", "ZarrV3ConsolidatedMetadata", "ZarrV3GroupMetadata", "ZarrV3GroupMetadataPartial", "ZarrV3GroupMetadataStoreKey", "ZarrV3MetadataField", "ZarrV3NamedConfig", "is_array_metadata_v2", "is_array_metadata_v3", "is_group_metadata_v2", "is_group_metadata_v3", "is_json", "is_metadata_field_v3", "parse_array_metadata_v2", "parse_array_metadata_v3", "parse_group_metadata_v2", "parse_group_metadata_v3", "parse_json", "parse_metadata_field_v3", "validate_array_metadata_v2", "validate_array_metadata_v3", "validate_group_metadata_v2", "validate_group_metadata_v3", "validate_json", "validate_metadata_field_v3", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/model/_array.py000066400000000000000000000523031523267620000266660ustar00rootroot00000000000000"""In-memory models for Zarr array metadata documents.""" from __future__ import annotations import copy import dataclasses from collections.abc import Mapping from dataclasses import dataclass, field from typing import TYPE_CHECKING, Final, Literal, TypeAlias, cast from typing_extensions import TypedDict, Unpack from zarr_metadata.model._sentinel import UNSET from zarr_metadata.model._validation import ( ARRAY_METADATA_STANDARD_KEYS_V3, MetadataValidationError, ValidationProblem, arrays_to_tuples, dump_store_json, load_store_json, parse_array_metadata_v2, parse_array_metadata_v3, parse_metadata_field_v3, ) if TYPE_CHECKING: from zarr_metadata._common import JSONValue, ZarrV3NamedConfigJSON from zarr_metadata.v2.array import ( ZarrV2ArrayDimensionSeparator, ZarrV2ArrayMetadataJSON, ZarrV2ArrayOrder, ZarrV2DataTypeMetadata, ) from zarr_metadata.v2.codec import ZarrV2CodecMetadata from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON, ZarrV3ExtensionField ZarrV3ArrayMetadataStoreKey = Literal["zarr.json"] ARRAY_METADATA_STORE_KEY_V3: Final[ZarrV3ArrayMetadataStoreKey] = "zarr.json" ZarrV2ArrayMetadataStoreKey = Literal[".zarray"] ARRAY_METADATA_STORE_KEY_V2: Final[ZarrV2ArrayMetadataStoreKey] = ".zarray" ZarrV2AttributesStoreKey = Literal[".zattrs"] ATTRIBUTES_STORE_KEY_V2: Final[ZarrV2AttributesStoreKey] = ".zattrs" @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV3NamedConfig: """A normalized v3 metadata field with its reader obligation. Bare names and missing configurations normalize to an empty configuration. Bare names and missing `must_understand` members normalize to the spec's implicit `True` value. """ name: str configuration: dict[str, JSONValue] must_understand: bool = True def to_json(self) -> ZarrV3MetadataFieldJSON: if not self.configuration and self.must_understand: return self.name out: ZarrV3NamedConfigJSON = {"name": self.name} if self.configuration: # to_json output shares no mutable state with the model. out["configuration"] = copy.deepcopy(self.configuration) if not self.must_understand: out["must_understand"] = False return out @classmethod def from_json(cls, data: object) -> ZarrV3NamedConfig: field = parse_metadata_field_v3(data) if isinstance(field, str): return cls(name=field, configuration={}, must_understand=True) # Sound cast: parse_metadata_field_v3 checked the configuration is a # string-keyed mapping of JSON values; arrays_to_tuples only converts # lists to tuples within that shape. configuration = cast( "dict[str, JSONValue]", arrays_to_tuples(dict(field.get("configuration", {}))) ) return cls( name=field["name"], configuration=configuration, must_understand=field.get("must_understand", True), ) ZarrV3MetadataField: TypeAlias = ZarrV3NamedConfig """The in-memory model of one field of a v3 metadata document. This is the role-named alias for annotation positions: model fields and consumer signatures should say `ZarrV3MetadataField` (the logical meaning) rather than `ZarrV3NamedConfig` (the serialized form the field currently takes). Today every metadata field normalizes to a named configuration plus its reader obligation, so the alias is exactly `ZarrV3NamedConfig`; if a future spec revision adds a field form that cannot be normalized to those values, this alias widens to a union and annotation sites do not change. Mirrors the raw-layer split between `ZarrV3NamedConfigJSON` (shape) and `ZarrV3MetadataFieldJSON` (field union). """ def must_understand_subset( extra_fields: Mapping[str, ZarrV3ExtensionField], ) -> dict[str, ZarrV3ExtensionField]: """The subset of `extra_fields` the reader is obligated to understand. Per the v3 spec, an extension field is implicitly `must_understand: True` unless it explicitly says otherwise, and an implementation MUST fail to open a group or array carrying fields it does not recognize that are not explicitly `must_understand: false`. A non-mapping field value cannot carry the explicit waiver, so it always requires understanding (the runtime isinstance check defends against values looser than the declared `ZarrV3ExtensionField`). """ fields = cast("Mapping[str, object]", extra_fields) return cast( "dict[str, ZarrV3ExtensionField]", { name: value for name, value in fields.items() if not ( isinstance(value, Mapping) and cast("Mapping[str, object]", value).get("must_understand") is False ) }, ) class ZarrV3ArrayMetadataPartial(TypedDict, total=False): """ Partial form of the constructor-settable fields of `ZarrV3ArrayMetadata`. Every key is optional and typed with the model's own (not serialized) value types, so it describes valid keyword arguments to `ZarrV3ArrayMetadata.update`. The `init=False` fields `zarr_format` and `node_type` are intentionally excluded, since they cannot be passed to `dataclasses.replace`. Drift between this type and the model's settable fields is prevented by `tests/model/test_array.py::test_partial_keys_match_settable_model_fields`. """ shape: tuple[int, ...] fill_value: JSONValue data_type: ZarrV3MetadataField chunk_grid: ZarrV3MetadataField codecs: tuple[ZarrV3MetadataField, ...] chunk_key_encoding: ZarrV3MetadataField dimension_names: tuple[str | None, ...] | UNSET attributes: dict[str, JSONValue] storage_transformers: tuple[ZarrV3MetadataField, ...] extra_fields: dict[str, ZarrV3ExtensionField] @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV3ArrayMetadata: """In-memory model of a v3 array metadata document. A canonical, semantically lossless representation of the `zarr.json` content for an array. Extension points (`data_type`, `chunk_grid`, `chunk_key_encoding`, `codecs`, `storage_transformers`) are held as `ZarrV3MetadataField` values (currently `ZarrV3NamedConfig` name, configuration, and obligation records) and are never interpreted; `fill_value` is held verbatim in its JSON form. Equivalent extension spellings normalize to shorthand strings when configuration is empty and understanding is required. """ zarr_format: Literal[3] = field(default=3, init=False) node_type: Literal["array"] = field(default="array", init=False) shape: tuple[int, ...] fill_value: JSONValue data_type: ZarrV3MetadataField chunk_grid: ZarrV3MetadataField codecs: tuple[ZarrV3MetadataField, ...] chunk_key_encoding: ZarrV3MetadataField dimension_names: tuple[str | None, ...] | UNSET attributes: dict[str, JSONValue] storage_transformers: tuple[ZarrV3MetadataField, ...] extra_fields: dict[str, ZarrV3ExtensionField] @classmethod def create_default(cls, **overrides: Unpack[ZarrV3ArrayMetadataPartial]) -> ZarrV3ArrayMetadata: """ Create a default (empty) v3 array metadata model, with optional overrides. The default is a structurally-valid scalar `uint8` array — the array analog of `list()` returning `[]`. Any field can be overridden by keyword (the same fields accepted by `update`). Overriding `shape` without `chunk_grid` derives a consistent default grid: one regular chunk covering the array (`chunk_shape` equal to `shape`). The derivation is deliberately one-way. A user-supplied `chunk_grid` is an extension point and is taken verbatim — deriving `shape` from it would require interpreting the grid's configuration, which this layer never does (and cannot do for unrecognized grid names). So overriding `chunk_grid` without `shape` keeps the scalar default `shape=()`, and consistency between the two is the caller's responsibility. """ if "shape" in overrides and "chunk_grid" not in overrides: overrides["chunk_grid"] = ZarrV3NamedConfig( name="regular", configuration={"chunk_shape": tuple(overrides["shape"])} ) default = cls( shape=(), fill_value=0, data_type=ZarrV3NamedConfig(name="uint8", configuration={}), chunk_grid=ZarrV3NamedConfig(name="regular", configuration={"chunk_shape": ()}), codecs=(ZarrV3NamedConfig(name="bytes", configuration={}),), chunk_key_encoding=ZarrV3NamedConfig(name="default", configuration={}), dimension_names=UNSET, attributes={}, storage_transformers=(), extra_fields={}, ) return default.update(**overrides) def update(self, **kwargs: Unpack[ZarrV3ArrayMetadataPartial]) -> ZarrV3ArrayMetadata: """ Return a new `ZarrV3ArrayMetadata` with the given fields updated. Only the constructor-settable fields listed in `ZarrV3ArrayMetadataPartial` can be updated; any attempt to update other fields (including the fixed `zarr_format` / `node_type`) is rejected at the type level. Each given field fully replaces its previous value, including `extra_fields`. This is useful for test fixtures that want to override a few fields of a base template without having to re-specify the entire document. No re-validation is performed (`update` is `dataclasses.replace`), so a repair or edit can produce an invalid document; validity is checked on `from_json`, not on field replacement. """ return dataclasses.replace(self, **kwargs) def __post_init__(self) -> None: overlap = set(self.extra_fields.keys()).intersection(ARRAY_METADATA_STANDARD_KEYS_V3) if overlap: raise MetadataValidationError( [ ValidationProblem( ("extra_fields",), "Extra fields cannot overlap with standard Zarr V3 array metadata fields", "invalid_value", ) ] ) def to_json(self) -> ZarrV3ArrayMetadataJSON: # to_json output shares no mutable state with the model: every value # that can hold a mutable container is deep-copied. out: ZarrV3ArrayMetadataJSON = { "zarr_format": self.zarr_format, "node_type": self.node_type, "shape": self.shape, "fill_value": copy.deepcopy(self.fill_value), "data_type": self.data_type.to_json(), "chunk_grid": self.chunk_grid.to_json(), "codecs": tuple(codec.to_json() for codec in self.codecs), "chunk_key_encoding": self.chunk_key_encoding.to_json(), } if self.dimension_names is not UNSET: out["dimension_names"] = self.dimension_names if len(self.attributes) > 0: out["attributes"] = copy.deepcopy(self.attributes) if len(self.storage_transformers) > 0: out["storage_transformers"] = tuple( transformer.to_json() for transformer in self.storage_transformers ) # Extra fields are the TypedDict's `extra_items` (PEP 728). Assign them # by key rather than `out.update(**...)`: type checkers understand the # indexed-write path against `extra_items`, but not the `update(**...)` # overload. for key, value in self.extra_fields.items(): out[key] = copy.deepcopy(value) return out @classmethod def from_json(cls, data: object) -> ZarrV3ArrayMetadata: parsed = parse_array_metadata_v3(arrays_to_tuples(data)) # Sound cast: the TypedDict types all non-standard keys as its # `extra_items` (`ZarrV3ExtensionField`); the comprehension's inferred value # type is the union over ALL keys because the key filter cannot narrow it. extra_fields = cast( "dict[str, ZarrV3ExtensionField]", {k: v for k, v in parsed.items() if k not in ARRAY_METADATA_STANDARD_KEYS_V3}, ) return cls( shape=parsed["shape"], fill_value=parsed["fill_value"], data_type=ZarrV3NamedConfig.from_json(parsed["data_type"]), chunk_grid=ZarrV3NamedConfig.from_json(parsed["chunk_grid"]), codecs=tuple(ZarrV3NamedConfig.from_json(c) for c in parsed["codecs"]), chunk_key_encoding=ZarrV3NamedConfig.from_json(parsed["chunk_key_encoding"]), dimension_names=parsed.get("dimension_names", UNSET), attributes=dict(parsed.get("attributes", {})), storage_transformers=tuple( ZarrV3NamedConfig.from_json(t) for t in parsed.get("storage_transformers", ()) ), extra_fields=extra_fields, ) @property def must_understand_fields(self) -> dict[str, ZarrV3ExtensionField]: """Extra fields the reader is obligated to understand. Everything in `extra_fields` not explicitly waived with `must_understand: false` (the spec's implicit-true rule). A compliant reader MUST fail to open the array if this contains any field it does not recognize; the model layer only partitions by obligation, since recognition is reader-specific. """ return must_understand_subset(self.extra_fields) @classmethod def from_key_value(cls, mapping: Mapping[str, bytes]) -> ZarrV3ArrayMetadata: return cls.from_json(load_store_json(mapping, ARRAY_METADATA_STORE_KEY_V3)) def to_key_value( self, *, indent: int | str | None = None ) -> Mapping[ZarrV3ArrayMetadataStoreKey, bytes]: return {ARRAY_METADATA_STORE_KEY_V3: dump_store_json(self.to_json(), indent=indent)} class ZarrV2ArrayMetadataPartial(TypedDict, total=False): """ Partial form of the constructor-settable fields of `ZarrV2ArrayMetadata`. Every key is optional and typed with the model's own value types, so it describes valid keyword arguments to `ZarrV2ArrayMetadata.update` and `create_default`. The `init=False` field `zarr_format` is intentionally excluded, since it cannot be passed to `dataclasses.replace`. Drift between this type and the model's settable fields is prevented by `tests/model/test_array.py::test_v2_partial_keys_match_settable_model_fields`. """ shape: tuple[int, ...] dtype: ZarrV2DataTypeMetadata chunks: tuple[int, ...] fill_value: JSONValue order: ZarrV2ArrayOrder compressor: ZarrV2CodecMetadata | None filters: tuple[ZarrV2CodecMetadata, ...] | None dimension_separator: ZarrV2ArrayDimensionSeparator attributes: dict[str, JSONValue] | UNSET @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV2ArrayMetadata: """In-memory model of a v2 array metadata document. A canonical, lossless representation of the `.zarray` content plus the sibling `.zattrs` attributes. `dtype`, `compressor`, and `filters` are held in their raw JSON forms and are never interpreted; `fill_value` is held verbatim in its JSON form. `attributes` is `UNSET` when no `.zattrs` file (or merged `attributes` key) exists — distinct from an explicit empty `.zattrs`, which is `{}` and round-trips as a file. One spelling normalization: a `.zarray` that omits `dimension_separator` means `"."` by the v2 convention, and the model holds and re-emits that value explicitly. """ zarr_format: Literal[2] = field(default=2, init=False) shape: tuple[int, ...] dtype: ZarrV2DataTypeMetadata chunks: tuple[int, ...] fill_value: JSONValue order: ZarrV2ArrayOrder compressor: ZarrV2CodecMetadata | None filters: tuple[ZarrV2CodecMetadata, ...] | None # "." is the v2 convention's default for an ABSENT dimension_separator key; # from_json normalizes absence to it (a semantics-preserving spelling # normalization, like the v3 bare-string metadata-field form). The value # is never None: the document grammar has no null spelling for this field. dimension_separator: ZarrV2ArrayDimensionSeparator = field(default=".") attributes: dict[str, JSONValue] | UNSET def update(self, **kwargs: Unpack[ZarrV2ArrayMetadataPartial]) -> ZarrV2ArrayMetadata: """ Return a new `ZarrV2ArrayMetadata` with the given fields updated. Only the constructor-settable fields listed in `ZarrV2ArrayMetadataPartial` can be updated; the fixed `zarr_format` is rejected at the type level. Each given field fully replaces its previous value. """ return dataclasses.replace(self, **kwargs) @classmethod def create_default(cls, **overrides: Unpack[ZarrV2ArrayMetadataPartial]) -> ZarrV2ArrayMetadata: """ Create a default (empty) v2 array metadata model, with optional overrides. The default is a structurally-valid scalar `uint8` (`"|u1"`) array — the array analog of `list()` returning `[]`. Any field can be overridden by keyword (the same fields accepted by `update`). Overriding `shape` without `chunks` derives `chunks` equal to `shape` (one chunk covering the array). The derivation is deliberately one-way, matching the v3 model: overriding `chunks` without `shape` keeps the scalar default `shape=()`, and consistency between the two is the caller's responsibility. """ if "shape" in overrides and "chunks" not in overrides: overrides["chunks"] = tuple(overrides["shape"]) default = cls( shape=(), dtype="|u1", chunks=(), fill_value=0, order="C", compressor=None, filters=None, attributes=UNSET, ) return default.update(**overrides) def to_json(self) -> ZarrV2ArrayMetadataJSON: """Return the merged in-memory document form. `attributes` is included when set (even empty). This is not the on-disk `.zarray` content: a conforming `.zarray` must exclude `attributes` (they live in the sibling `.zattrs` file). Use `to_key_value` to produce the spec-conforming split for storage. """ # to_json output shares no mutable state with the model: every value # that can hold a mutable container is deep-copied. out: ZarrV2ArrayMetadataJSON = { "zarr_format": self.zarr_format, "shape": self.shape, "dtype": self.dtype, "order": self.order, "chunks": self.chunks, "fill_value": copy.deepcopy(self.fill_value), "dimension_separator": self.dimension_separator, "compressor": copy.deepcopy(self.compressor), "filters": copy.deepcopy(self.filters), } if self.attributes is not UNSET: out["attributes"] = copy.deepcopy(self.attributes) return out @classmethod def from_json(cls, data: object) -> ZarrV2ArrayMetadata: parsed = parse_array_metadata_v2(arrays_to_tuples(data)) return cls( shape=parsed["shape"], dtype=parsed["dtype"], chunks=parsed["chunks"], fill_value=parsed["fill_value"], order=parsed["order"], compressor=parsed["compressor"], filters=parsed["filters"], dimension_separator=parsed.get("dimension_separator", "."), attributes=(dict(parsed["attributes"]) if "attributes" in parsed else UNSET), ) @classmethod def from_key_value(cls, mapping: Mapping[str, bytes]) -> ZarrV2ArrayMetadata: zarray_raw = cast("object", load_store_json(mapping, ARRAY_METADATA_STORE_KEY_V2)) if not isinstance(zarray_raw, Mapping): return cls.from_json(zarray_raw) zarray = cast("Mapping[str, object]", zarray_raw) if "attributes" in zarray: raise MetadataValidationError( [ ValidationProblem( ("attributes",), "unexpected document member", "invalid_value", ) ] ) if ATTRIBUTES_STORE_KEY_V2 in mapping: zattrs = cast("object", load_store_json(mapping, ATTRIBUTES_STORE_KEY_V2)) return cls.from_json({**zarray, "attributes": zattrs}) return cls.from_json(zarray) def to_key_value( self, *, indent: int | str | None = None ) -> Mapping[ZarrV2ArrayMetadataStoreKey | ZarrV2AttributesStoreKey, bytes]: # Attributes live only in the sibling `.zattrs` file; the `.zarray` # document must exclude them. The `.zattrs` key is present exactly # when attributes are set (even empty) — UNSET emits no file. zarray = {k: v for k, v in self.to_json().items() if k != "attributes"} out: dict[ZarrV2ArrayMetadataStoreKey | ZarrV2AttributesStoreKey, bytes] = { ARRAY_METADATA_STORE_KEY_V2: dump_store_json(zarray, indent=indent) } if self.attributes is not UNSET: out[ATTRIBUTES_STORE_KEY_V2] = dump_store_json(self.attributes, indent=indent) return out zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/model/_group.py000066400000000000000000000454031523267620000267070ustar00rootroot00000000000000"""In-memory models for Zarr group and consolidated metadata documents.""" from __future__ import annotations import copy import dataclasses from collections.abc import Mapping from dataclasses import dataclass, field from typing import TYPE_CHECKING, Final, Literal, cast from typing_extensions import TypedDict, Unpack from zarr_metadata.model._array import ( ATTRIBUTES_STORE_KEY_V2, ZarrV3ArrayMetadata, must_understand_subset, ) from zarr_metadata.model._sentinel import UNSET from zarr_metadata.model._validation import ( GROUP_METADATA_STANDARD_KEYS_V3, MetadataValidationError, ValidationProblem, arrays_to_tuples, dump_store_json, load_store_json, parse_group_metadata_v2, parse_group_metadata_v3, validate_consolidated_metadata_v3, validate_json, ) if TYPE_CHECKING: from zarr_metadata._common import JSONValue from zarr_metadata.model._array import ZarrV2AttributesStoreKey from zarr_metadata.v2.group import ZarrV2GroupMetadataJSON from zarr_metadata.v3.array import ZarrV3ExtensionField from zarr_metadata.v3.consolidated import ZarrV3ConsolidatedMetadataJSON from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON ZarrV3GroupMetadataStoreKey = Literal["zarr.json"] GROUP_METADATA_STORE_KEY_V3: Final[ZarrV3GroupMetadataStoreKey] = "zarr.json" ZarrV2GroupMetadataStoreKey = Literal[".zgroup"] GROUP_METADATA_STORE_KEY_V2: Final[ZarrV2GroupMetadataStoreKey] = ".zgroup" ZarrV2ConsolidatedMetadataStoreKey = Literal[".zmetadata"] CONSOLIDATED_METADATA_STORE_KEY_V2: Final[ZarrV2ConsolidatedMetadataStoreKey] = ".zmetadata" # The key under which consolidated metadata is embedded in a v3 group document. # This is a reference-implementation convention (not a spec artifact), stored # as an extension field on the group's `zarr.json`. CONSOLIDATED_METADATA_KEY_V3: Final = "consolidated_metadata" class ZarrV3GroupMetadataPartial(TypedDict, total=False): """ Partial form of the constructor-settable fields of `ZarrV3GroupMetadata`. Every key is optional and typed with the model's own value types, so it describes valid keyword arguments to `ZarrV3GroupMetadata.update` and `create_default`. The `init=False` fields `zarr_format` and `node_type` are intentionally excluded, since they cannot be passed to `dataclasses.replace`. Drift between this type and the model's settable fields is prevented by `tests/model/test_group.py::test_group_partial_keys_match_settable_model_fields`. """ attributes: dict[str, JSONValue] consolidated_metadata: ZarrV3ConsolidatedMetadata | UNSET extra_fields: dict[str, ZarrV3ExtensionField] @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV3GroupMetadata: """In-memory model of a v3 group metadata document. A canonical, semantically lossless representation of the `zarr.json` content for a group. The `consolidated_metadata` reference-implementation convention is modeled as a typed field holding thin child models; every other unknown top-level key lands in `extra_fields` verbatim. """ zarr_format: Literal[3] = field(default=3, init=False) node_type: Literal["group"] = field(default="group", init=False) attributes: dict[str, JSONValue] consolidated_metadata: ZarrV3ConsolidatedMetadata | UNSET extra_fields: dict[str, ZarrV3ExtensionField] def __post_init__(self) -> None: reserved = GROUP_METADATA_STANDARD_KEYS_V3 | {CONSOLIDATED_METADATA_KEY_V3} if set(self.extra_fields.keys()).intersection(reserved): raise MetadataValidationError( [ ValidationProblem( ("extra_fields",), "Extra fields cannot overlap with standard Zarr V3 group metadata fields", "invalid_value", ) ] ) @classmethod def create_default(cls, **overrides: Unpack[ZarrV3GroupMetadataPartial]) -> ZarrV3GroupMetadata: """ Create a default (empty) v3 group metadata model, with optional overrides. The default is a structurally-valid group with no attributes — the group analog of `list()` returning `[]`. Any field can be overridden by keyword (the same fields accepted by `update`). """ default = cls(attributes={}, consolidated_metadata=UNSET, extra_fields={}) return default.update(**overrides) def update(self, **kwargs: Unpack[ZarrV3GroupMetadataPartial]) -> ZarrV3GroupMetadata: """ Return a new `ZarrV3GroupMetadata` with the given fields updated. Only the constructor-settable fields listed in `ZarrV3GroupMetadataPartial` can be updated; the fixed `zarr_format` / `node_type` are rejected at the type level. Each given field fully replaces its previous value, including `extra_fields`. """ return dataclasses.replace(self, **kwargs) def to_json(self) -> ZarrV3GroupMetadataJSON: # to_json output shares no mutable state with the model: every value # that can hold a mutable container is deep-copied. out: ZarrV3GroupMetadataJSON = { "zarr_format": self.zarr_format, "node_type": self.node_type, } if len(self.attributes) > 0: out["attributes"] = copy.deepcopy(self.attributes) if self.consolidated_metadata is not UNSET: # Consolidated metadata is a known non-core top-level JSON field. out[CONSOLIDATED_METADATA_KEY_V3] = cast( "ZarrV3ExtensionField", self.consolidated_metadata.to_json() ) for key, value in self.extra_fields.items(): out[key] = copy.deepcopy(value) return out @classmethod def from_json(cls, data: object) -> ZarrV3GroupMetadata: parsed = parse_group_metadata_v3(arrays_to_tuples(data)) # Cast for narrowing across standard and arbitrary extra TypedDict items. consolidated_raw = cast("object", parsed.get(CONSOLIDATED_METADATA_KEY_V3, UNSET)) consolidated: ZarrV3ConsolidatedMetadata | UNSET if consolidated_raw is UNSET or consolidated_raw is None: # consolidated_metadata: null was written by a historical # zarr-python bug; it gets no model representation. It is read as # absence and never written back — repaired, not preserved. consolidated = UNSET else: consolidated = ZarrV3ConsolidatedMetadata.from_json(consolidated_raw) # Sound cast: the TypedDict types all non-standard keys as its # `extra_items` (`ZarrV3ExtensionField`); the comprehension's inferred value # type is the union over ALL keys because the key filter cannot narrow it. extra_fields = cast( "dict[str, ZarrV3ExtensionField]", { k: v for k, v in parsed.items() if k not in GROUP_METADATA_STANDARD_KEYS_V3 and k != CONSOLIDATED_METADATA_KEY_V3 }, ) return cls( attributes=dict(parsed.get("attributes", {})), consolidated_metadata=consolidated, extra_fields=extra_fields, ) @property def must_understand_fields(self) -> dict[str, ZarrV3ExtensionField]: """Extra fields the reader is obligated to understand. Everything in `extra_fields` not explicitly waived with `must_understand: false` (the spec's implicit-true rule). A compliant reader MUST fail to open the group if this contains any field it does not recognize; the model layer only partitions by obligation, since recognition is reader-specific. """ return must_understand_subset(self.extra_fields) @classmethod def from_key_value(cls, mapping: Mapping[str, bytes]) -> ZarrV3GroupMetadata: return cls.from_json(load_store_json(mapping, GROUP_METADATA_STORE_KEY_V3)) def to_key_value( self, *, indent: int | str | None = None ) -> Mapping[ZarrV3GroupMetadataStoreKey, bytes]: return {GROUP_METADATA_STORE_KEY_V3: dump_store_json(self.to_json(), indent=indent)} @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV3ConsolidatedMetadata: """In-memory model of v3 inline consolidated metadata. Models the reference-implementation convention where consolidated metadata is embedded as an extension field on a group's `zarr.json`. Each entry in `metadata` is a complete child document, held as a thin array or group model. `must_understand` is typed permissively as `bool` to mirror the document shape, but only `False` is valid; this is enforced at runtime. """ kind: Literal["inline"] = field(default="inline", init=False) must_understand: bool = False metadata: dict[str, ZarrV3ArrayMetadata | ZarrV3GroupMetadata] def __post_init__(self) -> None: if self.must_understand is not False: raise MetadataValidationError( [ ValidationProblem( ("must_understand",), f"Invalid value for 'must_understand'. Expected False. " f"Got {self.must_understand!r}.", "invalid_value", ) ] ) def to_json(self) -> ZarrV3ConsolidatedMetadataJSON: # `must_understand` is emitted as the literal False: the field is typed # permissively as `bool`, but `__post_init__` guarantees the value. return { "kind": self.kind, "must_understand": False, "metadata": {key: node.to_json() for key, node in self.metadata.items()}, } @classmethod def from_json(cls, data: object) -> ZarrV3ConsolidatedMetadata: normalized = arrays_to_tuples(data) problems = validate_consolidated_metadata_v3(normalized) if problems: raise MetadataValidationError(problems) env = cast("Mapping[str, object]", normalized) entries: dict[str, ZarrV3ArrayMetadata | ZarrV3GroupMetadata] = {} for key, entry in cast("Mapping[str, object]", env["metadata"]).items(): node_type = cast("Mapping[str, object]", entry).get("node_type") if node_type == "array": entries[key] = ZarrV3ArrayMetadata.from_json(entry) else: entries[key] = ZarrV3GroupMetadata.from_json(entry) return cls(metadata=entries) class ZarrV2GroupMetadataPartial(TypedDict, total=False): """ Partial form of the constructor-settable fields of `ZarrV2GroupMetadata`. Every key is optional and typed with the model's own value types, so it describes valid keyword arguments to `ZarrV2GroupMetadata.update` and `create_default`. The `init=False` field `zarr_format` is intentionally excluded, since it cannot be passed to `dataclasses.replace`. Drift between this type and the model's settable fields is prevented by `tests/model/test_group.py::test_group_partial_keys_match_settable_model_fields`. """ attributes: dict[str, JSONValue] | UNSET @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV2GroupMetadata: """In-memory model of a v2 group metadata document. A canonical, lossless representation of the `.zgroup` content plus the sibling `.zattrs` attributes, folded into a single in-memory value (mirroring the merged `ZarrV2GroupMetadataJSON` document form). `attributes` is `UNSET` when no `.zattrs` file (or merged `attributes` key) exists — distinct from an explicit empty `.zattrs`, which is `{}` and round-trips as a file. """ zarr_format: Literal[2] = field(default=2, init=False) attributes: dict[str, JSONValue] | UNSET @classmethod def create_default(cls, **overrides: Unpack[ZarrV2GroupMetadataPartial]) -> ZarrV2GroupMetadata: """ Create a default (empty) v2 group metadata model, with optional overrides. The default is a structurally-valid group with no attributes — the group analog of `list()` returning `[]`. Any field can be overridden by keyword (the same fields accepted by `update`). """ default = cls(attributes=UNSET) return default.update(**overrides) def update(self, **kwargs: Unpack[ZarrV2GroupMetadataPartial]) -> ZarrV2GroupMetadata: """ Return a new `ZarrV2GroupMetadata` with the given fields updated. Only the constructor-settable fields listed in `ZarrV2GroupMetadataPartial` can be updated; the fixed `zarr_format` is rejected at the type level. Each given field fully replaces its previous value. """ return dataclasses.replace(self, **kwargs) def to_json(self) -> ZarrV2GroupMetadataJSON: """Return the merged in-memory document form. `attributes` is included when set (even empty). This is not the on-disk `.zgroup` content: a conforming `.zgroup` must exclude `attributes` (they live in the sibling `.zattrs` file). Use `to_key_value` to produce the spec-conforming split for storage. """ # to_json output shares no mutable state with the model. out: ZarrV2GroupMetadataJSON = {"zarr_format": self.zarr_format} if self.attributes is not UNSET: out["attributes"] = copy.deepcopy(self.attributes) return out @classmethod def from_json(cls, data: object) -> ZarrV2GroupMetadata: parsed = parse_group_metadata_v2(arrays_to_tuples(data)) return cls(attributes=(dict(parsed["attributes"]) if "attributes" in parsed else UNSET)) @classmethod def from_key_value(cls, mapping: Mapping[str, bytes]) -> ZarrV2GroupMetadata: zgroup_raw = cast("object", load_store_json(mapping, GROUP_METADATA_STORE_KEY_V2)) if not isinstance(zgroup_raw, Mapping): return cls.from_json(zgroup_raw) zgroup = cast("Mapping[str, object]", zgroup_raw) if "attributes" in zgroup: raise MetadataValidationError( [ ValidationProblem( ("attributes",), "unexpected document member", "invalid_value", ) ] ) if ATTRIBUTES_STORE_KEY_V2 in mapping: zattrs = cast("object", load_store_json(mapping, ATTRIBUTES_STORE_KEY_V2)) return cls.from_json({**zgroup, "attributes": zattrs}) return cls.from_json(zgroup) def to_key_value( self, *, indent: int | str | None = None ) -> Mapping[ZarrV2GroupMetadataStoreKey | ZarrV2AttributesStoreKey, bytes]: # Attributes live only in the sibling `.zattrs` file; the `.zgroup` # document must exclude them. The `.zattrs` key is present exactly # when attributes are set (even empty) — UNSET emits no file. zgroup = {k: v for k, v in self.to_json().items() if k != "attributes"} out: dict[ZarrV2GroupMetadataStoreKey | ZarrV2AttributesStoreKey, bytes] = { GROUP_METADATA_STORE_KEY_V2: dump_store_json(zgroup, indent=indent) } if self.attributes is not UNSET: out[ATTRIBUTES_STORE_KEY_V2] = dump_store_json(self.attributes, indent=indent) return out @dataclass(frozen=True, slots=True, kw_only=True) class ZarrV2ConsolidatedMetadata: """In-memory model of a v2 `.zmetadata` document. The `metadata` map holds the flat file-keyed entries (`"path/.zarray"`, `"path/.zattrs"`, ...) verbatim, preserving the normalized JSON tree. Entries are deliberately NOT merged into per-node models: which nodes had a `.zattrs` file at all is information the canonical representation must keep. Interpreting entries into node models is consumer work. """ zarr_consolidated_format: Literal[1] = field(default=1, init=False) metadata: dict[str, JSONValue] def to_json(self) -> dict[str, JSONValue]: # to_json output shares no mutable state with the model. return { "zarr_consolidated_format": self.zarr_consolidated_format, "metadata": copy.deepcopy(self.metadata), } @classmethod def from_json(cls, data: object) -> ZarrV2ConsolidatedMetadata: normalized = arrays_to_tuples(data) if not isinstance(normalized, Mapping): raise MetadataValidationError( [ValidationProblem((), "expected a mapping", "invalid_type")] ) doc = cast("Mapping[str, object]", normalized) problems: list[ValidationProblem] = [ ValidationProblem((key,), "missing required key", "missing_key") for key in ("zarr_consolidated_format", "metadata") if key not in doc ] problems.extend( ValidationProblem((key,), "unexpected document member", "invalid_value") for key in doc.keys() - {"zarr_consolidated_format", "metadata"} ) if "zarr_consolidated_format" in doc and ( not isinstance(doc["zarr_consolidated_format"], int) or isinstance(doc["zarr_consolidated_format"], bool) or doc["zarr_consolidated_format"] != 1 ): problems.append( ValidationProblem( ("zarr_consolidated_format",), f"expected 1, got {doc['zarr_consolidated_format']!r}", "invalid_value", ) ) if "metadata" in doc: entries = doc["metadata"] if not isinstance(entries, Mapping) or not all( isinstance(k, str) for k in cast("Mapping[object, object]", entries) ): problems.append( ValidationProblem( ("metadata",), "expected a mapping with string keys", "invalid_type" ) ) else: for key, value in cast("Mapping[str, object]", entries).items(): problems.extend( ValidationProblem( ("metadata", key, *problem.loc), problem.message, problem.kind ) for problem in validate_json(value) ) if problems: raise MetadataValidationError(problems) entries_tupled = cast( "dict[str, JSONValue]", arrays_to_tuples(dict(cast("Mapping[str, object]", doc["metadata"]))), ) return cls(metadata=entries_tupled) @classmethod def from_key_value(cls, mapping: Mapping[str, bytes]) -> ZarrV2ConsolidatedMetadata: return cls.from_json(load_store_json(mapping, CONSOLIDATED_METADATA_STORE_KEY_V2)) def to_key_value( self, *, indent: int | str | None = None ) -> Mapping[ZarrV2ConsolidatedMetadataStoreKey, bytes]: return {CONSOLIDATED_METADATA_STORE_KEY_V2: dump_store_json(self.to_json(), indent=indent)} zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/model/_sentinel.py000066400000000000000000000036201523267620000273670ustar00rootroot00000000000000"""The absence sentinel for optional metadata-document keys. The models observe one invariant: `None` in a model always corresponds to a JSON `null` in the document (a v2 `compressor`/`filters` value, an unnamed dimension inside `dimension_names`), and `UNSET` always means the document key is absent. The two are never interchangeable, so a model value can never leak into a document as a spelling the writer did not intend. Check with identity: `if model.dimension_names is UNSET: ...`. Because the contract is identity, the sentinel must never be reconstructed from state: pickling and copying work by *reference* (typing_extensions >= 4.16 implements `Sentinel.__reduce__` as a lookup of the sentinel's name on its defining module), so `pickle.loads(pickle.dumps(UNSET)) is UNSET` holds across process boundaries, and models holding `UNSET` pickle and deep-copy freely. Earlier typing_extensions releases refused to pickle sentinels outright — hence the `>=4.16` floor in this package's dependencies. Checker support (PEP 661 is Final; stdlib `sentinel` arrives in Python 3.15): ty types this spelling exactly, including `is`/`is not` narrowing. Pyright supports it but a regression (1.1.405+, tracked as https://github.com/microsoft/pyright/issues/11115) degrades class-attribute reads to `Unknown`, so this package pins pyright to the last good version until the fix lands. Mypy support is in review (https://github.com/python/mypy/pull/21647); until it merges, mypy-checked consumers of these fields need a `cast` or `type: ignore` at narrowing sites. This is a deliberate short-term cost: the sentinel is the standard, and the checkers are converging on it. """ from __future__ import annotations from typing_extensions import Sentinel UNSET = Sentinel("UNSET") """Marks a metadata-document key as absent (PEP 661 sentinel; usable directly in type expressions, e.g. `tuple[str, ...] | UNSET`). Test with `is UNSET`.""" zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/model/_validation.py000066400000000000000000001066151523267620000277100ustar00rootroot00000000000000"""Structural validation for Zarr metadata documents. Validators check JSON structure (key presence, value shapes, and fixed literals like `zarr_format`), not domain validity. Each concept gets a `validate_*` function returning every problem found, an `is_*` type guard, and a `parse_*` function that narrows or raises `MetadataValidationError`. Every `ValidationProblem` carries a machine-readable `kind` alongside its human-readable `message`, so consumers can dispatch on the failure mode (`missing_key`, `invalid_type`, `invalid_value`, `invalid_json`) without string-matching messages. """ from __future__ import annotations import json import math from collections.abc import Mapping, Sequence from dataclasses import dataclass from typing import Any, Final, Literal, NoReturn, cast from typing_extensions import TypeIs from zarr_metadata._common import JSONValue from zarr_metadata.v2.array import ZarrV2ArrayMetadataJSON from zarr_metadata.v2.group import ZarrV2GroupMetadataJSON from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON ProblemKind = Literal["missing_key", "invalid_type", "invalid_value", "invalid_json"] """Machine-readable classification of a `ValidationProblem`. - `missing_key`: a required key (document key or store key) is absent. - `invalid_type`: a value has the wrong structural type (e.g. a string where a mapping is required, a non-JSON-serializable object). - `invalid_value`: a value has an acceptable type but an invalid content (e.g. `zarr_format: 2` in a v3 document, `order: "Q"`). - `invalid_json`: bytes that do not decode as JSON. """ @dataclass(frozen=True, slots=True) class ValidationProblem: """A single structural problem found while validating a metadata document. `loc` is the path from the document root to the offending value, e.g. `("codecs", 0, "name")`. An empty `loc` refers to the document as a whole. `kind` classifies the failure mode for programmatic dispatch; `message` is the human-readable description. """ loc: tuple[str | int, ...] message: str kind: ProblemKind def __str__(self) -> str: location = ".".join(str(part) for part in self.loc) if self.loc else "" return f"{location}: {self.message}" class MetadataValidationError(ValueError): """Raised when a value fails structural metadata validation. Carries every problem found (not just the first) in `.problems`. """ def __init__(self, problems: list[ValidationProblem]) -> None: self.problems = problems super().__init__("\n".join(str(problem) for problem in problems)) def _prefix(loc_head: str | int, problems: list[ValidationProblem]) -> list[ValidationProblem]: """Prepend `loc_head` to the `loc` of every problem (for nested validators).""" return [ValidationProblem((loc_head, *p.loc), p.message, p.kind) for p in problems] def validate_json(value: object) -> list[ValidationProblem]: """Return every reason `value` is not JSON-serializable (recursively).""" if isinstance(value, float): if math.isfinite(value): return [] return [ValidationProblem((), f"non-finite float {value!r} is not JSON", "invalid_value")] if isinstance(value, (str, int, bool)) or value is None: return [] problems: list[ValidationProblem] = [] if isinstance(value, Mapping): for key, item in cast("Mapping[object, object]", value).items(): if not isinstance(key, str): problems.append( ValidationProblem((), f"non-string key {key!r} in JSON object", "invalid_type") ) continue problems.extend(_prefix(key, validate_json(item))) return problems if isinstance(value, Sequence) and not isinstance(value, (bytes, bytearray)): for index, item in enumerate(cast("Sequence[object]", value)): problems.extend(_prefix(index, validate_json(item))) return problems return [ValidationProblem((), f"not a JSON-serializable value: {value!r}", "invalid_type")] def _is_canonical_json(value: object) -> TypeIs[JSONValue]: """Whether `value` already uses the concrete containers in `JSONValue`.""" if isinstance(value, float): return math.isfinite(value) if isinstance(value, (str, int, bool)) or value is None: return True if isinstance(value, (list, tuple)): sequence = cast("list[object] | tuple[object, ...]", value) return all(_is_canonical_json(item) for item in sequence) if isinstance(value, dict): mapping = cast("dict[object, object]", value) return all( isinstance(key, str) and _is_canonical_json(item) for key, item in mapping.items() ) return False def is_json(value: object) -> TypeIs[JSONValue]: """Whether `value` is a canonical JSON structure (recursively).""" return _is_canonical_json(value) def parse_json(value: object) -> JSONValue: """Return a canonical `JSONValue`, or raise `MetadataValidationError`.""" normalized = arrays_to_tuples(value) problems = validate_json(normalized) if problems: raise MetadataValidationError(problems) return cast(JSONValue, normalized) # The standard top-level keys of a v3 array metadata document. Anything outside # this set is an extension field. Built from the TypedDict's required/optional # key sets (which resolve inherited keys, unlike `__annotations__`). ARRAY_METADATA_REQUIRED_KEYS_V3: Final[frozenset[str]] = frozenset( ZarrV3ArrayMetadataJSON.__required_keys__ ) ARRAY_METADATA_OPTIONAL_KEYS_V3: Final[frozenset[str]] = frozenset( ZarrV3ArrayMetadataJSON.__optional_keys__ ) ARRAY_METADATA_STANDARD_KEYS_V3: Final[frozenset[str]] = ( ARRAY_METADATA_REQUIRED_KEYS_V3 | ARRAY_METADATA_OPTIONAL_KEYS_V3 ) ARRAY_METADATA_REQUIRED_KEYS_V2: Final[frozenset[str]] = frozenset( ZarrV2ArrayMetadataJSON.__required_keys__ ) ARRAY_METADATA_OPTIONAL_KEYS_V2: Final[frozenset[str]] = frozenset( ZarrV2ArrayMetadataJSON.__optional_keys__ ) ARRAY_METADATA_STANDARD_KEYS_V2: Final[frozenset[str]] = ( ARRAY_METADATA_REQUIRED_KEYS_V2 | ARRAY_METADATA_OPTIONAL_KEYS_V2 ) # The standard top-level keys of a v3 group metadata document. Anything outside # this set is an extension field. GROUP_METADATA_REQUIRED_KEYS_V3: Final[frozenset[str]] = frozenset( ZarrV3GroupMetadataJSON.__required_keys__ ) GROUP_METADATA_OPTIONAL_KEYS_V3: Final[frozenset[str]] = frozenset( ZarrV3GroupMetadataJSON.__optional_keys__ ) GROUP_METADATA_STANDARD_KEYS_V3: Final[frozenset[str]] = ( GROUP_METADATA_REQUIRED_KEYS_V3 | GROUP_METADATA_OPTIONAL_KEYS_V3 ) GROUP_METADATA_REQUIRED_KEYS_V2: Final[frozenset[str]] = frozenset( ZarrV2GroupMetadataJSON.__required_keys__ ) GROUP_METADATA_OPTIONAL_KEYS_V2: Final[frozenset[str]] = frozenset( ZarrV2GroupMetadataJSON.__optional_keys__ ) GROUP_METADATA_STANDARD_KEYS_V2: Final[frozenset[str]] = ( GROUP_METADATA_REQUIRED_KEYS_V2 | GROUP_METADATA_OPTIONAL_KEYS_V2 ) def _missing_keys(required: frozenset[str], doc: Mapping[str, object]) -> list[ValidationProblem]: """One `missing_key` problem per required key absent from `doc`.""" return [ ValidationProblem((key,), "missing required key", "missing_key") for key in sorted(required - doc.keys()) ] def _unexpected_keys( allowed: frozenset[str], doc: Mapping[object, object] ) -> list[ValidationProblem]: """One problem per member outside a closed document's declared shape.""" problems: list[ValidationProblem] = [] for key in doc: if not isinstance(key, str): problems.append( ValidationProblem((), f"non-string document key {key!r}", "invalid_type") ) elif key not in allowed: problems.append( ValidationProblem((key,), "unexpected document member", "invalid_value") ) return problems def _check_literal( doc: Mapping[str, object], key: str, expected: object ) -> list[ValidationProblem]: """One `invalid_value` problem if `doc[key]` is present but not `expected`.""" if key in doc and (type(doc[key]) is not type(expected) or doc[key] != expected): return [ ValidationProblem((key,), f"expected {expected!r}, got {doc[key]!r}", "invalid_value") ] return [] def _validate_extension_fields_v3( doc: Mapping[object, object], standard_keys: frozenset[str], *, additional_reserved_keys: frozenset[str] = frozenset(), ) -> list[ValidationProblem]: """Validate v3 top-level key types and unknown-field JSON payloads.""" problems: list[ValidationProblem] = [] reserved_keys = standard_keys | additional_reserved_keys for key, value in doc.items(): if not isinstance(key, str): problems.append( ValidationProblem((), f"non-string top-level key {key!r}", "invalid_type") ) continue if key in reserved_keys: continue problems.extend(_prefix(key, validate_json(value))) return problems def validate_metadata_field_v3( value: object, *, allow_must_understand_false: bool = True ) -> list[ValidationProblem]: """Return every reason `value` is not a v3 metadata field. A metadata field is a bare name string or a mapping containing `name` and optional `configuration` and `must_understand` members. """ if isinstance(value, str): return [] if not isinstance(value, Mapping): return [ ValidationProblem( (), "expected a metadata field (string or extension object)", "invalid_type", ) ] field = cast("Mapping[object, object]", value) problems: list[ValidationProblem] = [] allowed_keys = frozenset({"name", "configuration", "must_understand"}) for key in field: if not isinstance(key, str): problems.append( ValidationProblem((), f"non-string metadata field key {key!r}", "invalid_type") ) elif key not in allowed_keys: problems.append( ValidationProblem((key,), "unexpected metadata field member", "invalid_value") ) if not isinstance(field.get("name"), str): problems.append(ValidationProblem(("name",), "expected a string name", "invalid_type")) if "configuration" in field: configuration = field["configuration"] if not isinstance(configuration, Mapping): problems.append( ValidationProblem(("configuration",), "expected a mapping", "invalid_type") ) elif not all(isinstance(k, str) for k in cast("Mapping[object, object]", configuration)): problems.append( ValidationProblem(("configuration",), "expected string keys", "invalid_type") ) else: for key, item in cast("Mapping[str, object]", configuration).items(): problems.extend(_prefix("configuration", _prefix(key, validate_json(item)))) if "must_understand" in field: must_understand = field["must_understand"] if not isinstance(must_understand, bool): problems.append( ValidationProblem(("must_understand",), "expected a boolean", "invalid_type") ) elif not allow_must_understand_false and not must_understand: problems.append( ValidationProblem( ("must_understand",), "false is not supported at this extension point", "invalid_value", ) ) return problems def is_metadata_field_v3(value: object) -> TypeIs[ZarrV3MetadataFieldJSON]: """Whether `value` is a v3 metadata field: a bare name or a named config.""" if isinstance(value, str): return True if not isinstance(value, dict): return False field = cast("dict[object, object]", value) return _is_canonical_json(field) and not validate_metadata_field_v3(field) def parse_metadata_field_v3(value: object) -> ZarrV3MetadataFieldJSON: """Return `value` narrowed to `ZarrV3MetadataFieldJSON`, or raise `MetadataValidationError`.""" normalized = arrays_to_tuples(value) problems = validate_metadata_field_v3(normalized) if problems: raise MetadataValidationError(problems) return cast(ZarrV3MetadataFieldJSON, normalized) def _is_int_sequence(value: object) -> bool: """Whether `value` is a non-string sequence of integers. JSON booleans decode to `bool`, which is an `int` subclass in Python but is not an integer in a metadata document, so booleans are excluded. """ return ( not isinstance(value, (str, bytes, bytearray)) and isinstance(value, Sequence) and all( isinstance(item, int) and not isinstance(item, bool) for item in cast("Sequence[object]", value) ) ) def _validate_dim_sequence(doc: Mapping[str, object], key: str) -> list[ValidationProblem]: """Validate a dimension sequence (`shape` / `chunks`) if present in `doc`. Dimension lengths are non-negative integers. """ if key not in doc: return [] value = doc[key] if not _is_int_sequence(value): return [ValidationProblem((key,), "expected a sequence of int", "invalid_type")] if any(item < 0 for item in cast("Sequence[int]", value)): return [ValidationProblem((key,), "expected non-negative integers", "invalid_value")] return [] def _is_dtype_v2(value: object) -> bool: """Whether `value` is shaped like a v2 dtype: a string or field records. A field record is a `(name, dtype)` or `(name, dtype, shape)` sequence, where `dtype` is itself a string or nested field records and `shape` is a sequence of int. The string content is NOT interpreted — whether the string names a real dtype is domain validity, not structure. """ if isinstance(value, str): return True if not isinstance(value, Sequence): return False for record in cast("Sequence[object]", value): if isinstance(record, str) or not isinstance(record, Sequence): return False fields = cast("Sequence[object]", record) if len(fields) not in (2, 3): return False if not isinstance(fields[0], str): return False if not _is_dtype_v2(fields[1]): return False if len(fields) == 3 and not _is_int_sequence(fields[2]): return False return True def _is_canonical_dtype_v2(value: object) -> bool: """Whether a validated v2 dtype uses the tuple-backed public representation.""" if isinstance(value, str): return True if not isinstance(value, tuple): return False for record in cast("tuple[object, ...]", value): if not isinstance(record, tuple): return False fields = cast("tuple[object, ...]", record) if not _is_canonical_dtype_v2(fields[1]): return False if len(fields) == 3 and not isinstance(fields[2], tuple): return False return True def _is_canonical_metadata_field_v3(value: object) -> bool: """Whether a validated v3 metadata field has its declared runtime container type.""" return isinstance(value, (str, dict)) def _is_canonical_array_metadata_v3(value: object) -> bool: """Whether a validated v3 array document matches `ZarrV3ArrayMetadataJSON` at runtime.""" if not isinstance(value, dict): return False doc = cast("dict[str, object]", value) if not isinstance(doc["shape"], tuple) or not isinstance(doc["codecs"], tuple): return False if "storage_transformers" in doc and not isinstance(doc["storage_transformers"], tuple): return False if "dimension_names" in doc and not isinstance(doc["dimension_names"], tuple): return False if not all( _is_canonical_metadata_field_v3(doc[key]) for key in ("data_type", "chunk_grid", "chunk_key_encoding") ): return False if not all( _is_canonical_metadata_field_v3(item) for item in cast("tuple[object, ...]", doc["codecs"]) ): return False return "storage_transformers" not in doc or all( _is_canonical_metadata_field_v3(item) for item in cast("tuple[object, ...]", doc["storage_transformers"]) ) def _is_canonical_array_metadata_v2(value: object) -> bool: """Whether a validated v2 array document matches `ZarrV2ArrayMetadataJSON` at runtime.""" if not isinstance(value, dict): return False doc = cast("dict[str, object]", value) if not isinstance(doc["shape"], tuple) or not isinstance(doc["chunks"], tuple): return False if not _is_canonical_dtype_v2(doc["dtype"]): return False compressor = doc["compressor"] if compressor is not None and not isinstance(compressor, dict): return False filters = doc["filters"] return filters is None or ( isinstance(filters, tuple) and all(isinstance(item, dict) for item in cast("tuple[object, ...]", filters)) ) def _is_codec_v2(value: object) -> bool: """Whether `value` is shaped like a v2 codec config: a mapping with a string `id`.""" return isinstance(value, Mapping) and isinstance( cast("Mapping[object, object]", value).get("id"), str ) def _validate_codec_v2(value: object) -> list[ValidationProblem]: """Validate a v2 codec's required shape and JSON-valued configuration.""" if not _is_codec_v2(value): return [ ValidationProblem( (), "expected a codec configuration with a string 'id'", "invalid_type" ) ] return validate_json(value) def _validate_attributes(value: object) -> list[ValidationProblem]: """Validate an `attributes` value: a mapping with string keys. Returns a problem at `("attributes",)` if it is not, else `[]`. Shared by the v2 and v3 validators. Unlike the other `validate_*` functions (which return value-relative locs for the caller to `_prefix`), this emits the already-parent-relative `("attributes",)` loc, since it is only ever called with a document's `attributes` value. """ if not isinstance(value, Mapping) or not all( isinstance(k, str) for k in cast("Mapping[object, object]", value) ): return [ ValidationProblem( ("attributes",), "expected a mapping with string keys", "invalid_type" ) ] problems: list[ValidationProblem] = [] for key, item in cast("Mapping[str, object]", value).items(): problems.extend(_prefix("attributes", _prefix(key, validate_json(item)))) return problems def validate_array_metadata_v3(value: object) -> list[ValidationProblem]: """Return every reason `value` is not a structurally-valid v3 array doc. Checks structure, not domain validity. Unknown top-level keys are allowed (they map to `extra_fields`). """ if not isinstance(value, Mapping): return [ValidationProblem((), "expected a mapping", "invalid_type")] doc = cast("Mapping[str, object]", value) problems: list[ValidationProblem] = _missing_keys(ARRAY_METADATA_REQUIRED_KEYS_V3, doc) problems.extend( _validate_extension_fields_v3( cast("Mapping[object, object]", value), ARRAY_METADATA_STANDARD_KEYS_V3 ) ) problems.extend(_check_literal(doc, "zarr_format", 3)) problems.extend(_check_literal(doc, "node_type", "array")) problems.extend(_validate_dim_sequence(doc, "shape")) if "fill_value" in doc: problems.extend(_prefix("fill_value", validate_json(doc["fill_value"]))) for key in ("data_type", "chunk_grid", "chunk_key_encoding"): if key in doc: problems.extend( _prefix( key, validate_metadata_field_v3(doc[key], allow_must_understand_false=False), ) ) for key in ("codecs", "storage_transformers"): if key in doc: entries = doc[key] if isinstance(entries, str) or not isinstance(entries, Sequence): problems.append(ValidationProblem((key,), "expected a sequence", "invalid_type")) else: if key == "codecs" and len(cast("Sequence[object]", entries)) == 0: problems.append( ValidationProblem( ("codecs",), "expected at least one codec", "invalid_value" ) ) for index, entry in enumerate(cast("Sequence[object]", entries)): problems.extend(_prefix(key, _prefix(index, validate_metadata_field_v3(entry)))) if "attributes" in doc: problems.extend(_validate_attributes(doc["attributes"])) if "dimension_names" in doc: # Simple typed sequences (dimension_names, shape, chunks) report a single # field-level loc, not per-bad-item locs; per-index locs are reserved for # the metadata-field lists (codecs, storage_transformers). names = doc["dimension_names"] if isinstance(names, str) or not isinstance(names, Sequence): problems.append( ValidationProblem(("dimension_names",), "expected a sequence", "invalid_type") ) elif not all( item is None or isinstance(item, str) for item in cast("Sequence[object]", names) ): problems.append( ValidationProblem( ("dimension_names",), "expected items of str or None", "invalid_type" ) ) elif _is_int_sequence(doc.get("shape")) and len(cast("Sequence[object]", names)) != len( cast("Sequence[int]", doc["shape"]) ): problems.append( ValidationProblem( ("dimension_names",), "expected one name per dimension of shape", "invalid_value", ) ) return problems def is_array_metadata_v3(value: object) -> TypeIs[ZarrV3ArrayMetadataJSON]: """Whether `value` is a structurally-valid v3 array metadata document.""" return ( _is_canonical_json(value) and not validate_array_metadata_v3(value) and _is_canonical_array_metadata_v3(value) ) def parse_array_metadata_v3(value: object) -> ZarrV3ArrayMetadataJSON: """Return `value` as `ZarrV3ArrayMetadataJSON`, or raise `MetadataValidationError`.""" normalized = arrays_to_tuples(value) problems = validate_array_metadata_v3(normalized) if problems: raise MetadataValidationError(problems) return cast("ZarrV3ArrayMetadataJSON", normalized) def validate_array_metadata_v2(value: object) -> list[ValidationProblem]: """Return every reason `value` is not a structurally-valid v2 array doc. Checks structure, not domain validity: `dtype` must be a string or field records, but the string content is not interpreted; `compressor` and `filters` are required keys that may be `None`, and otherwise must be codec configurations (mappings with a string `id`). """ if not isinstance(value, Mapping): return [ValidationProblem((), "expected a mapping", "invalid_type")] doc = cast("Mapping[str, object]", value) problems: list[ValidationProblem] = _missing_keys(ARRAY_METADATA_REQUIRED_KEYS_V2, doc) problems.extend( _unexpected_keys(ARRAY_METADATA_STANDARD_KEYS_V2, cast("Mapping[object, object]", value)) ) problems.extend(_check_literal(doc, "zarr_format", 2)) shape_problems = _validate_dim_sequence(doc, "shape") chunks_problems = _validate_dim_sequence(doc, "chunks") problems.extend(shape_problems) problems.extend(chunks_problems) if ( not shape_problems and not chunks_problems and _is_int_sequence(doc.get("shape")) and _is_int_sequence(doc.get("chunks")) ): shape = cast("Sequence[int]", doc["shape"]) chunks = cast("Sequence[int]", doc["chunks"]) if len(shape) != len(chunks): problems.append( ValidationProblem( ("chunks",), "expected the same number of dimensions as shape", "invalid_value", ) ) if "dtype" in doc and not _is_dtype_v2(doc["dtype"]): problems.append( ValidationProblem( ("dtype",), "expected a v2 dtype string or a sequence of field records", "invalid_type", ) ) if "order" in doc and doc["order"] not in ("C", "F"): problems.append( ValidationProblem( ("order",), f"expected 'C' or 'F', got {doc['order']!r}", "invalid_value" ) ) if "compressor" in doc: compressor = doc["compressor"] if compressor is not None: problems.extend(_prefix("compressor", _validate_codec_v2(compressor))) if "filters" in doc: filters = doc["filters"] if filters is not None and ( isinstance(filters, str) or not isinstance(filters, Sequence) or not all(_is_codec_v2(item) for item in cast("Sequence[object]", filters)) ): problems.append( ValidationProblem( ("filters",), "expected null or a sequence of codec configurations with string 'id's", "invalid_type", ) ) elif filters is not None: if len(cast("Sequence[object]", filters)) == 0: problems.append( ValidationProblem(("filters",), "expected at least one filter", "invalid_value") ) for index, item in enumerate(cast("Sequence[object]", filters)): problems.extend(_prefix("filters", _prefix(index, validate_json(item)))) if "dimension_separator" in doc and doc["dimension_separator"] not in (".", "/"): problems.append( ValidationProblem( ("dimension_separator",), f"expected '.' or '/', got {doc['dimension_separator']!r}", "invalid_value", ) ) if "fill_value" in doc: problems.extend(_prefix("fill_value", validate_json(doc["fill_value"]))) if "attributes" in doc: problems.extend(_validate_attributes(doc["attributes"])) return problems def is_array_metadata_v2(value: object) -> TypeIs[ZarrV2ArrayMetadataJSON]: """Whether `value` is a structurally-valid v2 array metadata document.""" return ( _is_canonical_json(value) and not validate_array_metadata_v2(value) and _is_canonical_array_metadata_v2(value) ) def parse_array_metadata_v2(value: object) -> ZarrV2ArrayMetadataJSON: """Return `value` as `ZarrV2ArrayMetadataJSON`, or raise `MetadataValidationError`.""" normalized = arrays_to_tuples(value) problems = validate_array_metadata_v2(normalized) if problems: raise MetadataValidationError(problems) return cast("ZarrV2ArrayMetadataJSON", normalized) def validate_consolidated_metadata_v3(value: object) -> list[ValidationProblem]: """Return every reason `value` is not a valid inline consolidated envelope. Locs are value-relative (the caller prefixes with `consolidated_metadata` where appropriate). Entries recurse into the array and group document validators, so a validator verdict always agrees with what `ZarrV3ConsolidatedMetadata.from_json` accepts. """ if not isinstance(value, Mapping): return [ValidationProblem((), "expected a mapping", "invalid_type")] env = cast("Mapping[str, object]", value) problems: list[ValidationProblem] = [ ValidationProblem((key,), "missing required key", "missing_key") for key in ("kind", "must_understand", "metadata") if key not in env ] problems.extend( _unexpected_keys( frozenset({"kind", "must_understand", "metadata"}), cast("Mapping[object, object]", value), ) ) problems.extend(_check_literal(env, "kind", "inline")) if "must_understand" in env and env["must_understand"] is not False: problems.append(ValidationProblem(("must_understand",), "expected False", "invalid_value")) if "metadata" in env: entries = env["metadata"] if not isinstance(entries, Mapping): problems.append(ValidationProblem(("metadata",), "expected a mapping", "invalid_type")) else: for key, entry in cast("Mapping[object, object]", entries).items(): if not isinstance(key, str): problems.append( ValidationProblem(("metadata",), f"non-string key {key!r}", "invalid_type") ) continue entry_obj: object = entry node_type: object = None if isinstance(entry, Mapping): node_type = cast("Mapping[str, object]", entry).get("node_type") if node_type == "array": problems.extend( _prefix("metadata", _prefix(key, validate_array_metadata_v3(entry_obj))) ) elif node_type == "group": problems.extend( _prefix("metadata", _prefix(key, validate_group_metadata_v3(entry_obj))) ) else: problems.append( ValidationProblem( ("metadata", key, "node_type"), "expected 'array' or 'group'", "invalid_value", ) ) return problems def validate_group_metadata_v3(value: object) -> list[ValidationProblem]: """Return every reason `value` is not a structurally-valid v3 group doc. Checks structure, not domain validity. Unknown top-level keys are allowed (they map to `extra_fields`); a `consolidated_metadata` key, if present, is deep-validated (envelope and entries) via `validate_consolidated_metadata_v3`. """ if not isinstance(value, Mapping): return [ValidationProblem((), "expected a mapping", "invalid_type")] doc = cast("Mapping[str, object]", value) problems: list[ValidationProblem] = _missing_keys(GROUP_METADATA_REQUIRED_KEYS_V3, doc) problems.extend( _validate_extension_fields_v3( cast("Mapping[object, object]", value), GROUP_METADATA_STANDARD_KEYS_V3, additional_reserved_keys=frozenset({"consolidated_metadata"}), ) ) problems.extend(_check_literal(doc, "zarr_format", 3)) problems.extend(_check_literal(doc, "node_type", "group")) if "attributes" in doc: problems.extend(_validate_attributes(doc["attributes"])) if "consolidated_metadata" in doc and doc["consolidated_metadata"] is not None: # consolidated_metadata: null (a historical zarr-python bug) is # structurally accepted so those stores remain readable, but the model # repairs it to absence on read and never writes it back. problems.extend( _prefix( "consolidated_metadata", validate_consolidated_metadata_v3(doc["consolidated_metadata"]), ) ) return problems def is_group_metadata_v3(value: object) -> TypeIs[ZarrV3GroupMetadataJSON]: """Whether `value` is a structurally-valid v3 group metadata document.""" return _is_canonical_json(value) and not validate_group_metadata_v3(value) def parse_group_metadata_v3(value: object) -> ZarrV3GroupMetadataJSON: """Return `value` narrowed to `ZarrV3GroupMetadataJSON`, or raise `MetadataValidationError`.""" normalized = arrays_to_tuples(value) problems = validate_group_metadata_v3(normalized) if problems: raise MetadataValidationError(problems) return cast(ZarrV3GroupMetadataJSON, normalized) def validate_group_metadata_v2(value: object) -> list[ValidationProblem]: """Return every reason `value` is not a structurally-valid v2 group doc. Validates the in-memory merged form: the `.zgroup` fields plus an optional `attributes` mapping folded in from `.zattrs`. """ if not isinstance(value, Mapping): return [ValidationProblem((), "expected a mapping", "invalid_type")] doc = cast("Mapping[str, object]", value) problems: list[ValidationProblem] = _missing_keys(GROUP_METADATA_REQUIRED_KEYS_V2, doc) problems.extend( _unexpected_keys(GROUP_METADATA_STANDARD_KEYS_V2, cast("Mapping[object, object]", value)) ) problems.extend(_check_literal(doc, "zarr_format", 2)) if "attributes" in doc: problems.extend(_validate_attributes(doc["attributes"])) return problems def is_group_metadata_v2(value: object) -> TypeIs[ZarrV2GroupMetadataJSON]: """Whether `value` is a structurally-valid v2 group metadata document.""" return _is_canonical_json(value) and not validate_group_metadata_v2(value) def parse_group_metadata_v2(value: object) -> ZarrV2GroupMetadataJSON: """Return `value` narrowed to `ZarrV2GroupMetadataJSON`, or raise `MetadataValidationError`.""" normalized = arrays_to_tuples(value) problems = validate_group_metadata_v2(normalized) if problems: raise MetadataValidationError(problems) return cast(ZarrV2GroupMetadataJSON, normalized) def _reject_json_constant(constant: str) -> NoReturn: """Reject the JavaScript constants accepted by Python's JSON decoder.""" raise ValueError(f"non-standard JSON constant {constant!r}") def load_store_json(mapping: Mapping[str, bytes], key: str) -> Any: """Decode the JSON document stored at `key` in `mapping`. Every ingestion failure surfaces as `MetadataValidationError`: a missing store key is a `missing_key` problem and undecodable bytes are an `invalid_json` problem, rather than leaking `KeyError` / `json.JSONDecodeError` to callers. """ if key not in mapping: raise MetadataValidationError( [ValidationProblem((key,), "missing store key", "missing_key")] ) try: return json.loads(mapping[key], parse_constant=_reject_json_constant) except (UnicodeDecodeError, ValueError) as exc: raise MetadataValidationError( [ValidationProblem((key,), f"invalid JSON: {exc}", "invalid_json")] ) from exc def dump_store_json(value: object, *, indent: int | str | None = None) -> bytes: """Encode a metadata document as strict RFC 8259 JSON bytes.""" return json.dumps(value, indent=indent, allow_nan=False).encode("utf-8") def arrays_to_tuples(obj: object) -> object: """Recursively materialize mappings and convert array-like values to tuples.""" if isinstance(obj, Sequence) and not isinstance(obj, (str, bytes, bytearray)): sequence = cast("Sequence[object]", obj) converted_sequence = tuple(arrays_to_tuples(item) for item in sequence) if isinstance(obj, tuple) and all( converted is original for converted, original in zip(converted_sequence, sequence, strict=True) ): return cast("tuple[object, ...]", obj) return converted_sequence if isinstance(obj, Mapping): mapping = cast("Mapping[object, object]", obj) converted: dict[object, object] = { key: arrays_to_tuples(value) for key, value in mapping.items() } if isinstance(obj, dict) and all(converted[key] is value for key, value in mapping.items()): return cast("object", obj) return converted return obj zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/py.typed000066400000000000000000000000001523267620000254210ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/pydantic.py000066400000000000000000000147161523267620000261320ustar00rootroot00000000000000"""Optional pydantic (v2) integration: field types over the core models. Importing this module requires pydantic; the core package deliberately does not depend on it, so this module is never imported by `zarr_metadata` itself. Each exported name is an `Annotated` field type over the corresponding core model class — the instances ARE the core classes, so values interoperate freely with non-pydantic code (equality, isinstance, nesting). Validation delegates to the library: a raw document routes through `from_json` (the single source of truth for structural validation and normalization, so pydantic's field-level coercion can never bypass it), an existing model instance passes through unchanged, and serialization emits the canonical document via `to_json`. `MetadataValidationError` subclasses `ValueError`, so a failed parse surfaces as a pydantic `ValidationError` carrying the loc-annotated problem messages. Usage: import zarr_metadata.pydantic as zmp class ArrayManifest(BaseModel): path: str metadata: zmp.ZarrV3ArrayMetadata Static type checkers see each field type as its core model class, so `manifest.metadata` is a `zarr_metadata.model.ZarrV3ArrayMetadata`. """ from __future__ import annotations from typing import TYPE_CHECKING, Annotated, TypeVar from pydantic import BeforeValidator, InstanceOf, PlainSerializer from zarr_metadata import model as _model from zarr_metadata._pydantic_schema import ( ZarrV2ArrayMetadataJSON as _ZarrV2ArrayMetadataSchema, ) from zarr_metadata._pydantic_schema import ( ZarrV2ConsolidatedMetadataJSON as _ZarrV2ConsolidatedMetadataSchema, ) from zarr_metadata._pydantic_schema import ( ZarrV2GroupMetadataJSON as _ZarrV2GroupMetadataSchema, ) from zarr_metadata._pydantic_schema import ( ZarrV3ArrayMetadataJSON as _ZarrV3ArrayMetadataSchema, ) from zarr_metadata._pydantic_schema import ( ZarrV3ConsolidatedMetadataJSON as _ZarrV3ConsolidatedMetadataSchema, ) from zarr_metadata._pydantic_schema import ( ZarrV3GroupMetadataJSON as _ZarrV3GroupMetadataSchema, ) from zarr_metadata._pydantic_schema import ( ZarrV3MetadataFieldJSON as _ZarrV3MetadataFieldSchema, ) from zarr_metadata.v2.array import ZarrV2ArrayMetadataJSON as _ZarrV2ArrayMetadataJSON from zarr_metadata.v2.consolidated import ( ZarrV2ConsolidatedMetadataJSON as _ZarrV2ConsolidatedMetadataJSON, ) from zarr_metadata.v2.group import ZarrV2GroupMetadataJSON as _ZarrV2GroupMetadataJSON from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON as _ZarrV3MetadataFieldJSON from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON as _ZarrV3ArrayMetadataJSON from zarr_metadata.v3.consolidated import ( ZarrV3ConsolidatedMetadataJSON as _ZarrV3ConsolidatedMetadataJSON, ) from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON as _ZarrV3GroupMetadataJSON if TYPE_CHECKING: from collections.abc import Callable _M = TypeVar("_M") def _coerce_to(cls: type[_M], parse: Callable[[object], _M]) -> Callable[[object], _M]: """A validator that passes instances of `cls` through and parses anything else.""" def coerce(value: object) -> _M: if isinstance(value, cls): return value return parse(value) return coerce ZarrV3ArrayMetadata = Annotated[ InstanceOf[_model.ZarrV3ArrayMetadata], BeforeValidator( _coerce_to(_model.ZarrV3ArrayMetadata, _model.ZarrV3ArrayMetadata.from_json), json_schema_input_type=_ZarrV3ArrayMetadataSchema, ), PlainSerializer(_model.ZarrV3ArrayMetadata.to_json, return_type=_ZarrV3ArrayMetadataJSON), ] """Field type for a v3 array metadata document (`zarr.json` content).""" ZarrV2ArrayMetadata = Annotated[ InstanceOf[_model.ZarrV2ArrayMetadata], BeforeValidator( _coerce_to(_model.ZarrV2ArrayMetadata, _model.ZarrV2ArrayMetadata.from_json), json_schema_input_type=_ZarrV2ArrayMetadataSchema, ), PlainSerializer(_model.ZarrV2ArrayMetadata.to_json, return_type=_ZarrV2ArrayMetadataJSON), ] """Field type for a v2 array metadata document (merged `.zarray` + `.zattrs` form).""" ZarrV3GroupMetadata = Annotated[ InstanceOf[_model.ZarrV3GroupMetadata], BeforeValidator( _coerce_to(_model.ZarrV3GroupMetadata, _model.ZarrV3GroupMetadata.from_json), json_schema_input_type=_ZarrV3GroupMetadataSchema, ), PlainSerializer(_model.ZarrV3GroupMetadata.to_json, return_type=_ZarrV3GroupMetadataJSON), ] """Field type for a v3 group metadata document (`zarr.json` content).""" ZarrV2GroupMetadata = Annotated[ InstanceOf[_model.ZarrV2GroupMetadata], BeforeValidator( _coerce_to(_model.ZarrV2GroupMetadata, _model.ZarrV2GroupMetadata.from_json), json_schema_input_type=_ZarrV2GroupMetadataSchema, ), PlainSerializer(_model.ZarrV2GroupMetadata.to_json, return_type=_ZarrV2GroupMetadataJSON), ] """Field type for a v2 group metadata document (merged `.zgroup` + `.zattrs` form).""" ZarrV3ConsolidatedMetadata = Annotated[ InstanceOf[_model.ZarrV3ConsolidatedMetadata], BeforeValidator( _coerce_to( _model.ZarrV3ConsolidatedMetadata, _model.ZarrV3ConsolidatedMetadata.from_json, ), json_schema_input_type=_ZarrV3ConsolidatedMetadataSchema, ), PlainSerializer( _model.ZarrV3ConsolidatedMetadata.to_json, return_type=_ZarrV3ConsolidatedMetadataJSON, ), ] """Field type for v3 inline consolidated metadata.""" ZarrV2ConsolidatedMetadata = Annotated[ InstanceOf[_model.ZarrV2ConsolidatedMetadata], BeforeValidator( _coerce_to( _model.ZarrV2ConsolidatedMetadata, _model.ZarrV2ConsolidatedMetadata.from_json, ), json_schema_input_type=_ZarrV2ConsolidatedMetadataSchema, ), PlainSerializer( _model.ZarrV2ConsolidatedMetadata.to_json, return_type=_ZarrV2ConsolidatedMetadataJSON, ), ] """Field type for a v2 `.zmetadata` document.""" ZarrV3MetadataField = Annotated[ InstanceOf[_model.ZarrV3NamedConfig], BeforeValidator( _coerce_to(_model.ZarrV3NamedConfig, _model.ZarrV3NamedConfig.from_json), json_schema_input_type=_ZarrV3MetadataFieldSchema, ), PlainSerializer(_model.ZarrV3NamedConfig.to_json, return_type=_ZarrV3MetadataFieldJSON), ] """Field type for one normalized v3 metadata extension envelope.""" __all__ = [ "ZarrV2ArrayMetadata", "ZarrV2ConsolidatedMetadata", "ZarrV2GroupMetadata", "ZarrV3ArrayMetadata", "ZarrV3ConsolidatedMetadata", "ZarrV3GroupMetadata", "ZarrV3MetadataField", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/000077500000000000000000000000001523267620000242635ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/__init__.py000066400000000000000000000014051523267620000263740ustar00rootroot00000000000000"""Zarr v2 metadata types.""" from zarr_metadata.v2.array import ( ZarrV2ArrayDimensionSeparator, ZarrV2ArrayMetadataJSON, ZarrV2ArrayOrder, ZarrV2DataTypeMetadata, ZarrV2ZArrayJSON, ) from zarr_metadata.v2.attributes import ZarrV2ZAttrsJSON from zarr_metadata.v2.codec import ZarrV2CodecMetadata from zarr_metadata.v2.consolidated import ZarrV2ConsolidatedMetadataJSON from zarr_metadata.v2.group import ZarrV2GroupMetadataJSON, ZarrV2ZGroupJSON __all__ = [ "ZarrV2ArrayDimensionSeparator", "ZarrV2ArrayMetadataJSON", "ZarrV2ArrayOrder", "ZarrV2CodecMetadata", "ZarrV2ConsolidatedMetadataJSON", "ZarrV2DataTypeMetadata", "ZarrV2GroupMetadataJSON", "ZarrV2ZArrayJSON", "ZarrV2ZAttrsJSON", "ZarrV2ZGroupJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/array.py000066400000000000000000000134171523267620000257610ustar00rootroot00000000000000"""Zarr v2 array metadata types.""" from collections.abc import Mapping from typing import Final, Literal, NotRequired from typing_extensions import TypeAliasType, TypedDict from zarr_metadata._common import JSONValue from zarr_metadata.v2.codec import ZarrV2CodecMetadata ZarrV2DataTypeMetadata = TypeAliasType( "ZarrV2DataTypeMetadata", str | tuple[ tuple[str, "ZarrV2DataTypeMetadata"] | tuple[str, "ZarrV2DataTypeMetadata", tuple[int, ...]], ..., ], ) """The v2 dtype representation. Either a numpy-style dtype string (e.g. `"/.zarray` for a v2 array. User attributes live in a sibling `.zattrs` file and are NOT part of this type; see `ZarrV2ZAttrsJSON`. See https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ zarr_format: Literal[2] shape: tuple[int, ...] chunks: tuple[int, ...] dtype: ZarrV2DataTypeMetadata compressor: ZarrV2CodecMetadata | None fill_value: JSONValue order: ZarrV2ArrayOrder filters: tuple[ZarrV2CodecMetadata, ...] | None dimension_separator: NotRequired[ZarrV2ArrayDimensionSeparator] class ZarrV2ArrayMetadataJSON(TypedDict): """ Zarr v2 array metadata document, in-memory merged form. Models the union of `.zarray` (the spec-defined fields) and `.zattrs` (user attributes). On disk, attributes live in a sibling `.zattrs` file and are not part of `.zarray`; this type folds them in as the `attributes` field so a single TypedDict represents the complete in-memory state of a v2 array node. Consumers that read or write a real `.zarray` file should split / merge `attributes` accordingly, or use `ZarrV2ZArrayJSON` (strict on-disk) plus `ZarrV2ZAttrsJSON` directly. See https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ zarr_format: Literal[2] shape: tuple[int, ...] chunks: tuple[int, ...] dtype: ZarrV2DataTypeMetadata compressor: ZarrV2CodecMetadata | None fill_value: JSONValue order: ZarrV2ArrayOrder filters: tuple[ZarrV2CodecMetadata, ...] | None dimension_separator: NotRequired[ZarrV2ArrayDimensionSeparator] attributes: NotRequired[Mapping[str, JSONValue]] """User attributes from the sibling `.zattrs` file (not part of `.zarray`). See the class docstring for the rationale behind the merged representation. """ class ZarrV2ArrayMetadataJSONPartial(TypedDict, total=False): """ Partial form of `ZarrV2ArrayMetadataJSON`: every field is `NotRequired`. Field annotations mirror `ZarrV2ArrayMetadataJSON` exactly. The only difference is `total=False`, which makes every key optional at the type level. Use this when typing dicts that intentionally hold a subset of a complete v2 array metadata document — e.g. test fixtures that override only a few fields of a base template, or callers that build a fragment to be merged into a complete document elsewhere. The `NotRequired[...]` wrappers on `dimension_separator` and `attributes` are intentional: keeping them preserves byte-identical `__annotations__` with `ZarrV2ArrayMetadataJSON` so the `==` check in `tests/test_partial_equivalence.py` passes without special-casing those fields (PEP 655 explicitly permits `NotRequired` inside `total=False`). Note: v2 array metadata has no `extra_items` setting (the v2 spec has no extension-field concept), so this partial inherits the same closed shape. Drift between this type and `ZarrV2ArrayMetadataJSON` is prevented by `tests/test_partial_equivalence.py`. """ zarr_format: Literal[2] shape: tuple[int, ...] chunks: tuple[int, ...] dtype: ZarrV2DataTypeMetadata compressor: ZarrV2CodecMetadata | None fill_value: JSONValue order: ZarrV2ArrayOrder filters: tuple[ZarrV2CodecMetadata, ...] | None dimension_separator: NotRequired[ZarrV2ArrayDimensionSeparator] attributes: NotRequired[Mapping[str, JSONValue]] """User attributes from the sibling `.zattrs` file (not part of `.zarray`). See the class docstring for the rationale behind the merged representation. """ __all__ = [ "ARRAY_DIMENSION_SEPARATOR_V2", "ARRAY_ORDER_V2", "ZarrV2ArrayDimensionSeparator", "ZarrV2ArrayMetadataJSON", "ZarrV2ArrayMetadataJSONPartial", "ZarrV2ArrayOrder", "ZarrV2DataTypeMetadata", "ZarrV2ZArrayJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/attributes.py000066400000000000000000000011231523267620000270200ustar00rootroot00000000000000"""Zarr v2 user-attributes file content. See https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ from collections.abc import Mapping from zarr_metadata._common import JSONValue ZarrV2ZAttrsJSON = Mapping[str, JSONValue] """On-disk `.zattrs` file content. A JSON object holding user-defined attributes for a v2 array or group. Spec-defined keys for arrays / groups live in sibling `.zarray` / `.zgroup` files (modeled by `ZarrV2ZArrayJSON` / `ZarrV2ZGroupJSON`). This type does not constrain the keys or values of the attributes mapping. """ __all__ = [ "ZarrV2ZAttrsJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/codec.py000066400000000000000000000013361523267620000257150ustar00rootroot00000000000000""" Zarr v2 codec configuration shape. In v2, compressors and filters are numcodecs configuration dicts: a required `id` field naming the codec, plus arbitrary codec-specific extra fields. """ from typing_extensions import TypedDict from zarr_metadata._common import JSONValue class ZarrV2CodecMetadata(TypedDict, extra_items=JSONValue): """ A numcodecs configuration dict, used as a v2 compressor or filter. The required `id` field names the codec; codec-specific parameters (e.g. `cname`, `clevel` for blosc) appear as extra fields. See the "compressor" and "filters" sections of https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ id: str __all__ = [ "ZarrV2CodecMetadata", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/consolidated.py000066400000000000000000000026071523267620000273120ustar00rootroot00000000000000"""Zarr v2 consolidated metadata (`.zmetadata` file). This module models the de-facto `.zmetadata` file used by the reference Python implementation of Zarr v2. **This is NOT a spec artifact.** There is no Zarr v2 specification that defines `.zmetadata`; it is a canonical-implementation convention. """ from collections.abc import Mapping from typing_extensions import TypedDict from zarr_metadata.v2.array import ZarrV2ZArrayJSON from zarr_metadata.v2.attributes import ZarrV2ZAttrsJSON from zarr_metadata.v2.group import ZarrV2ZGroupJSON class ZarrV2ConsolidatedMetadataJSON(TypedDict): """ `.zmetadata` file contents. The `metadata` map uses flat path keys (`"foo/bar/.zarray"`, `"foo/.zattrs"`, etc.) pointing to the JSON contents of the file at that path. The keys include the filename suffix, not just the node path; the value's shape is determined by which file the key points at: - `/.zarray` -> `ZarrV2ZArrayJSON` - `/.zgroup` -> `ZarrV2ZGroupJSON` - `/.zattrs` -> `ZarrV2ZAttrsJSON` The TypedDict cannot discriminate the value shape on the key suffix at the type level; consumers should narrow at runtime by inspecting `key.endswith(".zarray")` etc. """ zarr_consolidated_format: int metadata: Mapping[str, ZarrV2ZArrayJSON | ZarrV2ZGroupJSON | ZarrV2ZAttrsJSON] __all__ = [ "ZarrV2ConsolidatedMetadataJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v2/group.py000066400000000000000000000054671523267620000260050ustar00rootroot00000000000000"""Zarr v2 group metadata types. See https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ from collections.abc import Mapping from typing import Literal, NotRequired from typing_extensions import TypedDict from zarr_metadata._common import JSONValue class ZarrV2ZGroupJSON(TypedDict): """ On-disk `.zgroup` file content. Strict shape of the JSON document persisted at `/.zgroup` for a v2 group. The spec defines exactly one field. User attributes live in a sibling `.zattrs` file and are NOT part of this type; see `ZarrV2ZAttrsJSON`. See https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ zarr_format: Literal[2] class ZarrV2GroupMetadataJSON(TypedDict): """ Zarr v2 group metadata document, in-memory merged form. Models the union of `.zgroup` (the spec-defined `zarr_format` field) and `.zattrs` (user attributes). On disk these are persisted as two separate files; this type folds them so a single TypedDict represents the complete in-memory state of a v2 group node. Consumers that read or write the real on-disk files should use `ZarrV2ZGroupJSON` (strict `.zgroup`) plus `ZarrV2ZAttrsJSON` directly. See https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html """ zarr_format: Literal[2] attributes: NotRequired[Mapping[str, JSONValue]] class ZarrV2GroupMetadataJSONPartial(TypedDict, total=False): """ Partial form of `ZarrV2GroupMetadataJSON`: every field is `NotRequired`. Field annotations mirror `ZarrV2GroupMetadataJSON` exactly. The only difference is `total=False`, which makes every key optional at the type level. Use this when typing dicts that intentionally hold a subset of a complete v2 group metadata document — e.g. test fixtures that override only a few fields of a base template, or callers that build a fragment to be merged into a complete document elsewhere. Provided for symmetry with the other `*Partial` types; the practical effect is that `zarr_format` becomes optional. The `NotRequired[...]` wrapper on `attributes` is intentional: keeping it preserves byte-identical `__annotations__` with `ZarrV2GroupMetadataJSON` so the `==` check in `tests/test_partial_equivalence.py` passes without special-casing that field (PEP 655 explicitly permits `NotRequired` inside `total=False`). Note: v2 group metadata has no `extra_items` setting (the v2 spec has no extension-field concept), so this partial inherits the same closed shape. Drift between this type and `ZarrV2GroupMetadataJSON` is prevented by `tests/test_partial_equivalence.py`. """ zarr_format: Literal[2] attributes: NotRequired[Mapping[str, JSONValue]] __all__ = [ "ZarrV2GroupMetadataJSON", "ZarrV2GroupMetadataJSONPartial", "ZarrV2ZGroupJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/000077500000000000000000000000001523267620000242645ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/__init__.py000066400000000000000000000007371523267620000264040ustar00rootroot00000000000000"""Zarr v3 metadata types.""" from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON, ZarrV3ExtensionField from zarr_metadata.v3.consolidated import ZarrV3ConsolidatedMetadataJSON from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON __all__ = [ "ZarrV3ArrayMetadataJSON", "ZarrV3ConsolidatedMetadataJSON", "ZarrV3ExtensionField", "ZarrV3GroupMetadataJSON", "ZarrV3MetadataFieldJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/_common.py000066400000000000000000000014651523267620000262730ustar00rootroot00000000000000"""Internal cross-cutting aliases for Zarr v3 metadata. This module is private (underscore-prefixed) and exists to avoid circular imports between leaf modules and sub-package `__init__.py` re-exports. Public consumers should import `ZarrV3MetadataFieldJSON` from `zarr_metadata.v3`. """ from zarr_metadata._common import ZarrV3NamedConfigJSON ZarrV3MetadataFieldJSON = str | ZarrV3NamedConfigJSON """The JSON shape of any v3 metadata extension-point entry: either a bare short-hand name string or a `{name, configuration, must_understand}` envelope. Used for `data_type`, `chunk_grid`, `chunk_key_encoding`, individual codec entries, and `storage_transformers` in v3 array metadata, and for the inner `codecs` / `index_codecs` lists of the `sharding_indexed` codec. """ __all__ = [ "ZarrV3MetadataFieldJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/array.py000066400000000000000000000060461523267620000257620ustar00rootroot00000000000000"""Zarr v3 array metadata types.""" from collections.abc import Mapping from typing import Literal, NotRequired, TypeAlias from typing_extensions import TypedDict from zarr_metadata._common import JSONValue from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON ZarrV3ExtensionField: TypeAlias = JSONValue """The JSON value of an unknown top-level v3 metadata field. An object carrying the literal member `must_understand: false` may be ignored. Every other JSON shape implicitly requires understanding; recognition itself belongs to the reader rather than this structural type. """ class ZarrV3ArrayMetadataJSON(TypedDict, extra_items=ZarrV3ExtensionField): """ Zarr v3 array metadata document (the `zarr.json` content for an array). Extra keys may contain arbitrary JSON values. See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#array-metadata """ zarr_format: Literal[3] node_type: Literal["array"] data_type: ZarrV3MetadataFieldJSON shape: tuple[int, ...] chunk_grid: ZarrV3MetadataFieldJSON chunk_key_encoding: ZarrV3MetadataFieldJSON fill_value: JSONValue codecs: tuple[ZarrV3MetadataFieldJSON, ...] attributes: NotRequired[Mapping[str, JSONValue]] storage_transformers: NotRequired[tuple[ZarrV3MetadataFieldJSON, ...]] dimension_names: NotRequired[tuple[str | None, ...]] class ZarrV3ArrayMetadataJSONPartial(TypedDict, total=False, extra_items=ZarrV3ExtensionField): """ Partial form of `ZarrV3ArrayMetadataJSON`: every field is `NotRequired`. Field annotations and `extra_items=` mirror `ZarrV3ArrayMetadataJSON` exactly. The only difference is `total=False`, which makes every key optional at the type level. Use this when typing dicts that intentionally hold a subset of a complete v3 array metadata document — e.g. test fixtures that override only a few fields of a base template, or callers that build a fragment to be merged into a complete document elsewhere. The `NotRequired[...]` wrappers on `attributes`, `storage_transformers`, and `dimension_names` are intentional: keeping them preserves byte-identical `__annotations__` with `ZarrV3ArrayMetadataJSON` so the `==` check in `tests/test_partial_equivalence.py` passes without special-casing those fields (PEP 655 explicitly permits `NotRequired` inside `total=False`). Drift between this type and `ZarrV3ArrayMetadataJSON` is prevented by `tests/test_partial_equivalence.py`. """ zarr_format: Literal[3] node_type: Literal["array"] data_type: ZarrV3MetadataFieldJSON shape: tuple[int, ...] chunk_grid: ZarrV3MetadataFieldJSON chunk_key_encoding: ZarrV3MetadataFieldJSON fill_value: JSONValue codecs: tuple[ZarrV3MetadataFieldJSON, ...] attributes: NotRequired[Mapping[str, JSONValue]] storage_transformers: NotRequired[tuple[ZarrV3MetadataFieldJSON, ...]] dimension_names: NotRequired[tuple[str | None, ...]] __all__ = [ "ZarrV3ArrayMetadataJSON", "ZarrV3ArrayMetadataJSONPartial", "ZarrV3ExtensionField", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_grid/000077500000000000000000000000001523267620000264015ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_grid/__init__.py000066400000000000000000000013021523267620000305060ustar00rootroot00000000000000""" Zarr v3 chunk grid metadata types. Each chunk grid lives in its own submodule: - `regular` -- core v3 spec - `rectilinear` -- zarr-extensions The `ChunkGridMetadata` aliases re-exported here are the canonical type for each grid's permitted JSON shapes. For the underlying `ChunkGridObject`, `ChunkGridConfiguration`, etc., import directly from the leaf submodule. See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-grids """ from zarr_metadata.v3.chunk_grid.rectilinear import RectilinearChunkGridMetadata from zarr_metadata.v3.chunk_grid.regular import RegularChunkGridMetadata __all__ = [ "RectilinearChunkGridMetadata", "RegularChunkGridMetadata", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_grid/rectilinear.py000066400000000000000000000030651523267620000312600ustar00rootroot00000000000000""" Rectilinear chunk grid (zarr-extensions). See https://github.com/zarr-developers/zarr-extensions/tree/main/chunk-grids/rectilinear """ from typing import Final, Literal from typing_extensions import TypedDict RECTILINEAR_CHUNK_GRID_NAME: Final = "rectilinear" """The `name` field value of the rectilinear chunk grid.""" RectilinearChunkGridName = Literal["rectilinear"] """Literal type of the `name` field of the rectilinear chunk grid.""" RectilinearDimSpec = int | tuple[int | tuple[int, int], ...] """JSON shape for one dimension's rectilinear spec. Either a bare integer (uniform shorthand for a regular dimension within a rectilinear grid), or a tuple of integers and/or `[value, count]` RLE pairs. """ class RectilinearChunkGridConfiguration(TypedDict): """Configuration for the rectilinear chunk grid.""" kind: Literal["inline"] chunk_shapes: tuple[RectilinearDimSpec, ...] class RectilinearChunkGridObject(TypedDict): """Rectilinear chunk grid metadata in object form.""" name: RectilinearChunkGridName configuration: RectilinearChunkGridConfiguration RectilinearChunkGridMetadata = RectilinearChunkGridObject """Permitted JSON shape for rectilinear chunk grid metadata. `kind` and `chunk_shapes` are required, so only the object form is valid; the short-hand-name form is not permitted by the spec for this grid. """ __all__ = [ "RECTILINEAR_CHUNK_GRID_NAME", "RectilinearChunkGridConfiguration", "RectilinearChunkGridMetadata", "RectilinearChunkGridName", "RectilinearChunkGridObject", "RectilinearDimSpec", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_grid/regular.py000066400000000000000000000022151523267620000304140ustar00rootroot00000000000000""" Regular chunk grid (Zarr v3 core spec). See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#regular-grids """ from typing import Final, Literal from typing_extensions import TypedDict REGULAR_CHUNK_GRID_NAME: Final = "regular" """The `name` field value of the regular chunk grid.""" RegularChunkGridName = Literal["regular"] """Literal type of the `name` field of the regular chunk grid.""" class RegularChunkGridConfiguration(TypedDict): """Configuration for the regular chunk grid.""" chunk_shape: tuple[int, ...] class RegularChunkGridObject(TypedDict): """Regular chunk grid metadata in object form.""" name: RegularChunkGridName configuration: RegularChunkGridConfiguration RegularChunkGridMetadata = RegularChunkGridObject """Permitted JSON shape for regular chunk grid metadata. `chunk_shape` is required and has no default, so only the object form is valid; the short-hand-name form is not permitted by the spec for this grid. """ __all__ = [ "REGULAR_CHUNK_GRID_NAME", "RegularChunkGridConfiguration", "RegularChunkGridMetadata", "RegularChunkGridName", "RegularChunkGridObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_key_encoding/000077500000000000000000000000001523267620000301125ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_key_encoding/__init__.py000066400000000000000000000015361523267620000322300ustar00rootroot00000000000000""" Zarr v3 chunk key encoding metadata types. Each chunk key encoding lives in its own submodule: - `default` -- v3 default encoding (`/`-separated) - `v2` -- v2-compatibility encoding (`.`-separated by default) Both are defined by the v3 core spec. The `ChunkKeyEncodingMetadata` aliases re-exported here are the canonical type for each encoding's permitted JSON shapes. For the underlying `ChunkKeyEncodingObject`, `ChunkKeyEncodingConfiguration`, etc., import directly from the leaf submodule. See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-key-encoding """ from zarr_metadata.v3.chunk_key_encoding.default import DefaultChunkKeyEncodingMetadata from zarr_metadata.v3.chunk_key_encoding.v2 import V2ChunkKeyEncodingMetadata __all__ = [ "DefaultChunkKeyEncodingMetadata", "V2ChunkKeyEncodingMetadata", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_key_encoding/default.py000066400000000000000000000037311523267620000321140ustar00rootroot00000000000000""" Default chunk key encoding (Zarr v3 core spec). The chunk key for a chunk with grid index `(k, j, i, ...)` is formed by appending `ckji...` (where `` is `separator`). See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-key-encoding """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict DEFAULT_CHUNK_KEY_ENCODING_NAME: Final = "default" """The `name` field value of the default chunk key encoding.""" DefaultChunkKeyEncodingName = Literal["default"] """Literal type of the `name` field of the default chunk key encoding.""" DefaultChunkKeyEncodingSeparator = Literal["/", "."] """Literal type of permitted `separator` values for the default chunk key encoding. Defaults to `"/"` if absent. """ DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR: Final = ("/", ".") """Tuple of permitted values for the `separator` field of the default chunk key encoding.""" class DefaultChunkKeyEncodingConfiguration(TypedDict): """Configuration for the default chunk key encoding. `separator` is optional and defaults to `"/"` per spec. """ separator: NotRequired[DefaultChunkKeyEncodingSeparator] class DefaultChunkKeyEncodingObject(TypedDict): """Default chunk key encoding metadata in object form.""" name: DefaultChunkKeyEncodingName configuration: NotRequired[DefaultChunkKeyEncodingConfiguration] DefaultChunkKeyEncodingMetadata = DefaultChunkKeyEncodingObject | DefaultChunkKeyEncodingName """Permitted JSON shapes for the default chunk-key encoding metadata. The configuration has no required keys (`separator` defaults to `"/"`), so the short-hand-name form is permitted in addition to the object form. """ __all__ = [ "DEFAULT_CHUNK_KEY_ENCODING_NAME", "DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR", "DefaultChunkKeyEncodingConfiguration", "DefaultChunkKeyEncodingMetadata", "DefaultChunkKeyEncodingName", "DefaultChunkKeyEncodingObject", "DefaultChunkKeyEncodingSeparator", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/chunk_key_encoding/v2.py000066400000000000000000000042211523267620000310120ustar00rootroot00000000000000""" v2-compatibility chunk key encoding (Zarr v3 core spec). Intended only to allow existing v2 arrays to be converted to v3 without having to rename chunks. Not recommended for new arrays. Naming note: these are Zarr **v3** types. The leading `V2` in `V2ChunkKeyEncodingMetadata` (and friends) is the encoding's registered *entity name* (`"v2"`), not the format-version marker that `ZarrV2...` names carry — this package's version-prefixed names always spell it `ZarrV2` / `ZarrV3`. See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-key-encoding """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict V2_CHUNK_KEY_ENCODING_NAME: Final = "v2" """The `name` field value of the v2 chunk key encoding.""" V2ChunkKeyEncodingName = Literal["v2"] """Literal type of the `name` field of the v2 chunk key encoding.""" V2ChunkKeyEncodingSeparator = Literal["/", "."] """Literal type of permitted `separator` values for the v2 chunk key encoding. Defaults to `"."` if absent. """ V2_CHUNK_KEY_ENCODING_SEPARATOR: Final = ("/", ".") """Tuple of permitted values for the `separator` field of the v2 chunk key encoding.""" class V2ChunkKeyEncodingConfiguration(TypedDict): """Configuration for the v2 chunk key encoding. `separator` is optional and defaults to `"."` per spec. """ separator: NotRequired[V2ChunkKeyEncodingSeparator] class V2ChunkKeyEncodingObject(TypedDict): """v2-compatibility chunk key encoding metadata in object form.""" name: V2ChunkKeyEncodingName configuration: NotRequired[V2ChunkKeyEncodingConfiguration] V2ChunkKeyEncodingMetadata = V2ChunkKeyEncodingObject | V2ChunkKeyEncodingName """Permitted JSON shapes for the v2-compatibility chunk-key encoding metadata. The configuration has no required keys (`separator` defaults to `"."`), so the short-hand-name form is permitted in addition to the object form. """ __all__ = [ "V2_CHUNK_KEY_ENCODING_NAME", "V2_CHUNK_KEY_ENCODING_SEPARATOR", "V2ChunkKeyEncodingConfiguration", "V2ChunkKeyEncodingMetadata", "V2ChunkKeyEncodingName", "V2ChunkKeyEncodingObject", "V2ChunkKeyEncodingSeparator", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/000077500000000000000000000000001523267620000253415ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/__init__.py000066400000000000000000000031301523267620000274470ustar00rootroot00000000000000""" Zarr v3 codec spec types. Each codec defined by the spec or by zarr-extensions has its own submodule (`blosc`, `bytes`, `cast_value`, `crc32c`, `gzip`, `scale_offset`, `sharding_indexed`, `transpose`, `zstd`). The `CodecMetadata` aliases re-exported here are the canonical type for each codec's permitted JSON shapes (object form plus, where the spec allows, a bare-string short-hand form). For the underlying `CodecObject`, `CodecConfiguration`, etc., import directly from the leaf submodule. For the field-level "any codec entry" alias (used in array metadata's `codecs` list and in sharding's inner pipelines), import `ZarrV3MetadataFieldJSON` from `zarr_metadata.v3`. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/index.html """ from zarr_metadata.v3.codec.blosc import BloscCodecMetadata from zarr_metadata.v3.codec.bytes import BytesCodecMetadata from zarr_metadata.v3.codec.cast_value import CastValueCodecMetadata from zarr_metadata.v3.codec.crc32c import Crc32cCodecMetadata from zarr_metadata.v3.codec.gzip import GzipCodecMetadata from zarr_metadata.v3.codec.scale_offset import ScaleOffsetCodecMetadata from zarr_metadata.v3.codec.sharding_indexed import ShardingIndexedCodecMetadata from zarr_metadata.v3.codec.transpose import TransposeCodecMetadata from zarr_metadata.v3.codec.zstd import ZstdCodecMetadata __all__ = [ "BloscCodecMetadata", "BytesCodecMetadata", "CastValueCodecMetadata", "Crc32cCodecMetadata", "GzipCodecMetadata", "ScaleOffsetCodecMetadata", "ShardingIndexedCodecMetadata", "TransposeCodecMetadata", "ZstdCodecMetadata", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/blosc.py000066400000000000000000000033701523267620000270200ustar00rootroot00000000000000""" Blosc codec types. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/blosc/index.html """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict BLOSC_CODEC_NAME: Final = "blosc" """The `name` field value of the `blosc` codec.""" BloscCodecName = Literal["blosc"] """Literal type of the `name` field of the `blosc` codec.""" BloscShuffle = Literal["noshuffle", "shuffle", "bitshuffle"] """Literal type of blosc shuffle mode names.""" BLOSC_SHUFFLE: Final = ("noshuffle", "shuffle", "bitshuffle") """Tuple of permitted values for the `shuffle` field of the `blosc` codec.""" BloscCName = Literal["lz4", "lz4hc", "blosclz", "snappy", "zlib", "zstd"] """Literal type of blosc compressor identifiers.""" BLOSC_CNAME: Final = ("lz4", "lz4hc", "blosclz", "snappy", "zlib", "zstd") """Tuple of permitted values for the `cname` field of the `blosc` codec.""" class BloscCodecConfiguration(TypedDict): """Configuration for the Zarr v3 `blosc` codec.""" cname: BloscCName clevel: int shuffle: BloscShuffle blocksize: int typesize: NotRequired[int] class BloscCodecObject(TypedDict): """`blosc` codec metadata in object form.""" name: BloscCodecName configuration: BloscCodecConfiguration BloscCodecMetadata = BloscCodecObject """Permitted JSON shape for `blosc` codec metadata. The configuration has multiple required keys (`cname`, `clevel`, `shuffle`, `blocksize`), so only the object form is valid; the short-hand-name form is not permitted by the spec for this codec. """ __all__ = [ "BLOSC_CNAME", "BLOSC_CODEC_NAME", "BLOSC_SHUFFLE", "BloscCName", "BloscCodecConfiguration", "BloscCodecMetadata", "BloscCodecName", "BloscCodecObject", "BloscShuffle", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/bytes.py000066400000000000000000000034231523267620000270430ustar00rootroot00000000000000""" Bytes codec types. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/bytes/index.html """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict BYTES_CODEC_NAME: Final = "bytes" """The `name` field value of the `bytes` codec.""" BytesCodecName = Literal["bytes"] """Literal type of the `name` field of the `bytes` codec.""" Endianness = Literal["little", "big"] """Literal type of byte order of multi-byte numeric data.""" ENDIANNESS: Final = ("little", "big") """Tuple of permitted values for the `endian` field of the `bytes` codec.""" class BytesCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `bytes` codec. The `endian` field is required for multi-byte data types. """ endian: NotRequired[Endianness] class BytesCodecObject(TypedDict): """`bytes` codec metadata in object form. `configuration` is itself optional — when no configuration fields are set, the entire `configuration` key may be omitted. This matches the bare-string short-hand form (`BytesCodecName`) at the canonical data level; both encodings describe a `bytes` codec with default settings. """ name: BytesCodecName configuration: NotRequired[BytesCodecConfiguration] BytesCodecMetadata = BytesCodecObject | BytesCodecName """Permitted JSON shapes for `bytes` codec metadata. The configuration has no required keys (`endian` is conditionally required at runtime based on data type), so the spec's short-hand-name form is permitted in addition to the object form, and the object form may itself omit `configuration` entirely. """ __all__ = [ "BYTES_CODEC_NAME", "ENDIANNESS", "BytesCodecConfiguration", "BytesCodecMetadata", "BytesCodecName", "BytesCodecObject", "Endianness", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/cast_value.py000066400000000000000000000057251523267620000300520ustar00rootroot00000000000000""" Cast-value codec types. See https://github.com/zarr-developers/zarr-extensions/tree/main/codecs/cast_value """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict from zarr_metadata._common import JSONValue from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON CAST_VALUE_CODEC_NAME: Final = "cast_value" """The `name` field value of the `cast_value` codec.""" CastValueCodecName = Literal["cast_value"] """Literal type of the `name` field of the `cast_value` codec.""" CastRoundingMode = Literal[ "nearest-even", "towards-zero", "towards-positive", "towards-negative", "nearest-away", ] """Literal type of permitted values for the `rounding` configuration field. Defaults to `"nearest-even"` if absent. """ CAST_ROUNDING_MODE: Final = ( "nearest-even", "towards-zero", "towards-positive", "towards-negative", "nearest-away", ) """Tuple of permitted values for the `rounding` field of the `cast_value` codec.""" CastOutOfRangeMode = Literal["clamp", "wrap"] """Literal type of permitted values for the `out_of_range` configuration field. If absent, out-of-range values are an encoding/decoding error. """ CAST_OUT_OF_RANGE_MODE: Final = ("clamp", "wrap") """Tuple of permitted values for the `out_of_range` field of the `cast_value` codec.""" ScalarMapEntry = tuple[JSONValue, JSONValue] """A single `[input, output]` mapping in a `scalar_map` direction. Each scalar is JSON-encoded per its data type's fill-value rules (so e.g. `"NaN"` and `"+Infinity"` are permitted). """ class ScalarMap(TypedDict): """Optional encode/decode scalar overrides for the cast_value codec.""" encode: NotRequired[tuple[ScalarMapEntry, ...]] decode: NotRequired[tuple[ScalarMapEntry, ...]] class CastValueCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `cast_value` codec. `data_type` is the target data type that input values are cast to. It is the same shape as the top-level array `data_type` field: either a bare-string primitive name or a `{name, configuration}` envelope. """ data_type: ZarrV3MetadataFieldJSON rounding: NotRequired[CastRoundingMode] out_of_range: NotRequired[CastOutOfRangeMode] scalar_map: NotRequired[ScalarMap] class CastValueCodecObject(TypedDict): """`cast_value` codec metadata in object form.""" name: CastValueCodecName configuration: CastValueCodecConfiguration CastValueCodecMetadata = CastValueCodecObject """Permitted JSON shape for `cast_value` codec metadata. `configuration.data_type` is required, so only the object form is valid; the short-hand-name form is not permitted by the spec for this codec. """ __all__ = [ "CAST_OUT_OF_RANGE_MODE", "CAST_ROUNDING_MODE", "CAST_VALUE_CODEC_NAME", "CastOutOfRangeMode", "CastRoundingMode", "CastValueCodecConfiguration", "CastValueCodecMetadata", "CastValueCodecName", "CastValueCodecObject", "ScalarMap", "ScalarMapEntry", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/crc32c.py000066400000000000000000000023421523267620000267730ustar00rootroot00000000000000""" CRC32C codec types. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/crc32c/index.html The CRC32C codec has no configuration fields, so the `configuration` key is absent from the metadata. """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict CRC32C_CODEC_NAME: Final = "crc32c" """The `name` field value of the `crc32c` codec.""" Crc32cCodecName = Literal["crc32c"] """Literal type of the `name` field of the `crc32c` codec.""" class Empty(TypedDict, closed=True): """An empty mapping""" class Crc32cCodecObject(TypedDict): """`crc32c` codec metadata in object form. Per spec the codec has no configuration fields. `configuration` is optional and, if present, should be an empty mapping. """ name: Crc32cCodecName configuration: NotRequired[Empty] Crc32cCodecMetadata = Crc32cCodecObject | Crc32cCodecName """Permitted JSON shapes for `crc32c` codec metadata. The spec's Extension definition allows extensions with no required configuration to be encoded as a bare short-hand name. CRC32C has no configuration, so both forms are valid. """ __all__ = [ "CRC32C_CODEC_NAME", "Crc32cCodecMetadata", "Crc32cCodecName", "Crc32cCodecObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/gzip.py000066400000000000000000000027521523267620000266720ustar00rootroot00000000000000""" Gzip codec types. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/gzip/index.html """ from typing import Final, Literal from typing_extensions import TypedDict GZIP_CODEC_NAME: Final = "gzip" """The `name` field value of the `gzip` codec.""" GzipCodecName = Literal["gzip"] """Literal type of the `name` field of the `gzip` codec.""" class GzipCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `gzip` codec. `level` is an integer in the range 0-9; 0 disables compression and 9 is slowest with the best compression ratio. The codec's compressed output depends on `level`, so metadata that omits it cannot reproducibly identify the chunk bytes produced by a writer — `level` is required for the metadata to fulfill its reproducibility role, even though the spec text does not mark it required with RFC 2119 keywords. """ level: int class GzipCodecObject(TypedDict): """`gzip` codec metadata in object form.""" name: GzipCodecName configuration: GzipCodecConfiguration GzipCodecMetadata = GzipCodecObject """Permitted JSON shape for `gzip` codec metadata. `configuration.level` is required (it determines the codec's output bytes and is therefore part of the metadata's reproducibility contract), so only the object form is valid; the short-hand-name form is not permitted. """ __all__ = [ "GZIP_CODEC_NAME", "GzipCodecConfiguration", "GzipCodecMetadata", "GzipCodecName", "GzipCodecObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/scale_offset.py000066400000000000000000000035551523267620000303600ustar00rootroot00000000000000""" Scale-offset codec types. See https://github.com/zarr-developers/zarr-extensions/tree/main/codecs/scale_offset """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict from zarr_metadata._common import JSONValue SCALE_OFFSET_CODEC_NAME: Final = "scale_offset" """The `name` field value of the `scale_offset` codec.""" ScaleOffsetCodecName = Literal["scale_offset"] """Literal type of the `name` field of the `scale_offset` codec.""" class ScaleOffsetCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `scale_offset` codec. Both fields are optional. A missing `offset` is the additive identity (e.g. 0 for numeric types); a missing `scale` is the multiplicative identity (e.g. 1). Each scalar is JSON-encoded per the input array's fill-value rules, so `"NaN"` and `"+Infinity"` style strings are permitted in addition to numbers. """ offset: NotRequired[JSONValue] scale: NotRequired[JSONValue] class ScaleOffsetCodecObject(TypedDict): """`scale_offset` codec metadata in object form. `configuration` is itself optional per spec — when both `offset` and `scale` are at their identity defaults, the codec is a no-op and the entire `configuration` field may be omitted. """ name: ScaleOffsetCodecName configuration: NotRequired[ScaleOffsetCodecConfiguration] ScaleOffsetCodecMetadata = ScaleOffsetCodecObject | ScaleOffsetCodecName """Permitted JSON shapes for `scale_offset` codec metadata. The configuration has no required keys (both `offset` and `scale` are optional, and the configuration itself is optional), so the short-hand-name form is permitted in addition to the object form. """ __all__ = [ "SCALE_OFFSET_CODEC_NAME", "ScaleOffsetCodecConfiguration", "ScaleOffsetCodecMetadata", "ScaleOffsetCodecName", "ScaleOffsetCodecObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/sharding_indexed.py000066400000000000000000000044001523267620000312100ustar00rootroot00000000000000""" Sharding-indexed codec types. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/sharding-indexed/index.html """ from typing import Final, Literal, NotRequired from typing_extensions import TypedDict from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON SHARDING_INDEXED_CODEC_NAME: Final = "sharding_indexed" """The `name` field value of the `sharding_indexed` codec.""" ShardingIndexedCodecName = Literal["sharding_indexed"] """Literal type of the `name` field of the `sharding_indexed` codec.""" ShardingIndexLocation = Literal["start", "end"] """Literal type of the position of the shard index within the encoded shard.""" SHARDING_INDEX_LOCATION: Final = ("start", "end") """Tuple of permitted values for the `index_location` field of the `sharding_indexed` codec.""" class ShardingIndexedCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `sharding_indexed` codec. `chunk_shape` is the shape of inner chunks along each dimension; it must evenly divide the shard shape. `codecs` is the codec pipeline applied to each inner chunk; exactly one array-to-bytes codec is required. `index_codecs` is the codec pipeline applied to the shard index; it must be deterministic (no variable-size compression). `index_location` defaults to `"end"` per the spec. """ chunk_shape: tuple[int, ...] codecs: tuple[ZarrV3MetadataFieldJSON, ...] index_codecs: tuple[ZarrV3MetadataFieldJSON, ...] index_location: NotRequired[ShardingIndexLocation] class ShardingIndexedCodecObject(TypedDict): """`sharding_indexed` codec metadata in object form.""" name: ShardingIndexedCodecName configuration: ShardingIndexedCodecConfiguration ShardingIndexedCodecMetadata = ShardingIndexedCodecObject """Permitted JSON shape for `sharding_indexed` codec metadata. The configuration has multiple required keys (`chunk_shape`, `codecs`, `index_codecs`), so only the object form is valid; the short-hand-name form is not permitted by the spec for this codec. """ __all__ = [ "SHARDING_INDEXED_CODEC_NAME", "SHARDING_INDEX_LOCATION", "ShardingIndexLocation", "ShardingIndexedCodecConfiguration", "ShardingIndexedCodecMetadata", "ShardingIndexedCodecName", "ShardingIndexedCodecObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/transpose.py000066400000000000000000000023241523267620000277320ustar00rootroot00000000000000""" Transpose codec types. See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/transpose/index.html """ from typing import Final, Literal from typing_extensions import TypedDict TRANSPOSE_CODEC_NAME: Final = "transpose" """The `name` field value of the `transpose` codec.""" TransposeCodecName = Literal["transpose"] """Literal type of the `name` field of the `transpose` codec.""" class TransposeCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `transpose` codec. `order` is a permutation of the dimension indices 0..n-1 that specifies the dimension reordering applied during encoding. """ order: tuple[int, ...] class TransposeCodecObject(TypedDict): """`transpose` codec metadata in object form.""" name: TransposeCodecName configuration: TransposeCodecConfiguration TransposeCodecMetadata = TransposeCodecObject """Permitted JSON shape for `transpose` codec metadata. `order` is required, so only the object form is valid; the short-hand-name form is not permitted by the spec for this codec. """ __all__ = [ "TRANSPOSE_CODEC_NAME", "TransposeCodecConfiguration", "TransposeCodecMetadata", "TransposeCodecName", "TransposeCodecObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/codec/zstd.py000066400000000000000000000022251523267620000267000ustar00rootroot00000000000000""" Zstandard codec types. See https://github.com/zarr-developers/zarr-specs/pull/256 (unmerged at time of writing; the configuration shape below reflects the proposed specification). """ from typing import Final, Literal from typing_extensions import TypedDict ZSTD_CODEC_NAME: Final = "zstd" """The `name` field value of the `zstd` codec.""" ZstdCodecName = Literal["zstd"] """Literal type of the `name` field of the `zstd` codec.""" class ZstdCodecConfiguration(TypedDict): """ Configuration for the Zarr v3 `zstd` codec. Both fields are required per the proposed specification. """ level: int checksum: bool class ZstdCodecObject(TypedDict): """`zstd` codec metadata in object form.""" name: ZstdCodecName configuration: ZstdCodecConfiguration ZstdCodecMetadata = ZstdCodecObject """Permitted JSON shape for `zstd` codec metadata. Both `level` and `checksum` are required, so only the object form is valid; the short-hand-name form is not permitted by the spec for this codec. """ __all__ = [ "ZSTD_CODEC_NAME", "ZstdCodecConfiguration", "ZstdCodecMetadata", "ZstdCodecName", "ZstdCodecObject", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/consolidated.py000066400000000000000000000024431523267620000273110ustar00rootroot00000000000000"""Zarr v3 consolidated metadata types. There is no Zarr v3 specification for consolidated metadata. This module models the inline-on-group convention used by the reference Python implementation (and zarrs), where consolidated metadata is embedded as an extension field on a group's `zarr.json`. This is a known non-core interoperability extension. Its `{kind, must_understand, metadata}` payload is an unknown top-level JSON value to the core document model; implementations that recognize the convention may interpret it through this dedicated type. """ from collections.abc import Mapping from typing import Literal from typing_extensions import TypedDict from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON class ZarrV3ConsolidatedMetadataJSON(TypedDict): """ Inline consolidated metadata embedded in a v3 group. The `metadata` map contains only v3 array and group entries. V2 entries are excluded from this interoperability convention by design; the v3 core specification does not define consolidated metadata. """ kind: Literal["inline"] must_understand: Literal[False] metadata: Mapping[str, ZarrV3ArrayMetadataJSON | ZarrV3GroupMetadataJSON] __all__ = [ "ZarrV3ConsolidatedMetadataJSON", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/000077500000000000000000000000001523267620000262365ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/__init__.py000066400000000000000000000074021523267620000303520ustar00rootroot00000000000000""" Zarr v3 data type spec types. Each v3 data type has its own submodule: - Core primitives: `bool`, `int8`/`16`/`32`/`64`, `uint8`/`16`/`32`/`64`, `float16`/`32`/`64`, `complex64`/`128`, `raw` (for `r`) - zarr-extensions: `bytes`, `string`, `numpy_datetime64`, `numpy_timedelta64`, `struct` The two canonical types per dtype are re-exported here: - `DataTypeName` -- the literal type of the dtype's `data_type` string (or, for named-config dtypes, the literal value of their `name` field) - `FillValue` -- the permitted JSON shape of the `fill_value` field Named-config dtypes (`numpy_datetime64`, `numpy_timedelta64`, `struct`) also expose their envelope TypedDict here. For configuration TypedDicts, branded `HexFloat` / `Base64Bytes` types, and the corresponding validator functions, import directly from the leaf submodule. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from zarr_metadata.v3.data_type.bool import BoolDataTypeName, BoolFillValue from zarr_metadata.v3.data_type.bytes import BytesDataTypeName, BytesFillValue from zarr_metadata.v3.data_type.complex64 import Complex64DataTypeName, Complex64FillValue from zarr_metadata.v3.data_type.complex128 import ( Complex128DataTypeName, Complex128FillValue, ) from zarr_metadata.v3.data_type.float16 import Float16DataTypeName, Float16FillValue from zarr_metadata.v3.data_type.float32 import Float32DataTypeName, Float32FillValue from zarr_metadata.v3.data_type.float64 import Float64DataTypeName, Float64FillValue from zarr_metadata.v3.data_type.int8 import Int8DataTypeName, Int8FillValue from zarr_metadata.v3.data_type.int16 import Int16DataTypeName, Int16FillValue from zarr_metadata.v3.data_type.int32 import Int32DataTypeName, Int32FillValue from zarr_metadata.v3.data_type.int64 import Int64DataTypeName, Int64FillValue from zarr_metadata.v3.data_type.numpy_datetime64 import ( NumpyDatetime64, NumpyDatetime64DataTypeName, NumpyDatetime64FillValue, ) from zarr_metadata.v3.data_type.numpy_timedelta64 import ( NumpyTimedelta64, NumpyTimedelta64DataTypeName, NumpyTimedelta64FillValue, ) from zarr_metadata.v3.data_type.raw import RawBytesDataTypeName, RawBytesFillValue from zarr_metadata.v3.data_type.string import StringDataTypeName, StringFillValue from zarr_metadata.v3.data_type.struct import ( Struct, StructDataTypeName, StructFillValue, ) from zarr_metadata.v3.data_type.uint8 import Uint8DataTypeName, Uint8FillValue from zarr_metadata.v3.data_type.uint16 import Uint16DataTypeName, Uint16FillValue from zarr_metadata.v3.data_type.uint32 import Uint32DataTypeName, Uint32FillValue from zarr_metadata.v3.data_type.uint64 import Uint64DataTypeName, Uint64FillValue __all__ = [ "BoolDataTypeName", "BoolFillValue", "BytesDataTypeName", "BytesFillValue", "Complex64DataTypeName", "Complex64FillValue", "Complex128DataTypeName", "Complex128FillValue", "Float16DataTypeName", "Float16FillValue", "Float32DataTypeName", "Float32FillValue", "Float64DataTypeName", "Float64FillValue", "Int8DataTypeName", "Int8FillValue", "Int16DataTypeName", "Int16FillValue", "Int32DataTypeName", "Int32FillValue", "Int64DataTypeName", "Int64FillValue", "NumpyDatetime64", "NumpyDatetime64DataTypeName", "NumpyDatetime64FillValue", "NumpyTimedelta64", "NumpyTimedelta64DataTypeName", "NumpyTimedelta64FillValue", "RawBytesDataTypeName", "RawBytesFillValue", "StringDataTypeName", "StringFillValue", "Struct", "StructDataTypeName", "StructFillValue", "Uint8DataTypeName", "Uint8FillValue", "Uint16DataTypeName", "Uint16FillValue", "Uint32DataTypeName", "Uint32FillValue", "Uint64DataTypeName", "Uint64FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/bool.py000066400000000000000000000010001523267620000275320ustar00rootroot00000000000000""" Zarr v3 `bool` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal BOOL_DATA_TYPE_NAME: Final = "bool" """The `data_type` value for the `bool` type.""" BoolDataTypeName = Literal["bool"] """Literal type of the `data_type` field for `bool`.""" BoolFillValue = bool """Permitted JSON shape of the `fill_value` field for `bool`: a JSON boolean.""" __all__ = [ "BOOL_DATA_TYPE_NAME", "BoolDataTypeName", "BoolFillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/bytes.py000066400000000000000000000026041523267620000277400ustar00rootroot00000000000000""" Zarr `bytes` data type (variable-length raw bytes, zarr-extensions). See https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/bytes """ import re from typing import Final, Literal, NewType BYTES_DATA_TYPE_NAME: Final = "bytes" """The `data_type` value for the variable-length `bytes` type.""" BytesDataTypeName = Literal["bytes"] """Literal type of the `data_type` field for `bytes`.""" Base64Bytes = NewType("Base64Bytes", str) """A standard-alphabet base64-encoded byte sequence.""" _BASE64_RE: Final = re.compile(r"^[A-Za-z0-9+/]*={0,2}$") def base64_bytes(value: str) -> Base64Bytes: """Validate `value` as a Base64Bytes and brand it. Raises ValueError if `value` is not standard-alphabet base64 (length must be a multiple of 4 once padded; only `A-Z`, `a-z`, `0-9`, `+`, `/`, and trailing `=` padding are permitted). """ if len(value) % 4 != 0 or not _BASE64_RE.fullmatch(value): raise ValueError(f"Expected standard-alphabet base64, got {value!r}") return Base64Bytes(value) BytesFillValue = tuple[int, ...] | Base64Bytes """Permitted JSON shape of the `fill_value` field for `bytes`. Either a JSON array of integers in `[0, 255]` (one per byte), or a `Base64Bytes` string encoding the byte sequence. """ __all__ = [ "BYTES_DATA_TYPE_NAME", "Base64Bytes", "BytesDataTypeName", "BytesFillValue", "base64_bytes", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/complex128.py000066400000000000000000000017511523267620000305160ustar00rootroot00000000000000""" Zarr v3 `complex128` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal from zarr_metadata.v3.data_type.float64 import Float64FillValue COMPLEX128_DATA_TYPE_NAME: Final = "complex128" """The `data_type` value for the `complex128` type.""" Complex128DataTypeName = Literal["complex128"] """Literal type of the `data_type` field for `complex128`.""" Complex128Component = Float64FillValue """One real or imaginary component of a `complex128` fill value. Same shape as a `float64` fill value: a JSON number, a named sentinel, or a `HexFloat64` string. """ Complex128FillValue = tuple[Complex128Component, Complex128Component] """Permitted JSON shape of the `fill_value` field for `complex128`. A two-element JSON array `[real, imag]` where each component is a `Complex128Component`. """ __all__ = [ "COMPLEX128_DATA_TYPE_NAME", "Complex128Component", "Complex128DataTypeName", "Complex128FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/complex64.py000066400000000000000000000017271523267620000304400ustar00rootroot00000000000000""" Zarr v3 `complex64` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal from zarr_metadata.v3.data_type.float32 import Float32FillValue COMPLEX64_DATA_TYPE_NAME: Final = "complex64" """The `data_type` value for the `complex64` type.""" Complex64DataTypeName = Literal["complex64"] """Literal type of the `data_type` field for `complex64`.""" Complex64Component = Float32FillValue """One real or imaginary component of a `complex64` fill value. Same shape as a `float32` fill value: a JSON number, a named sentinel, or a `HexFloat32` string. """ Complex64FillValue = tuple[Complex64Component, Complex64Component] """Permitted JSON shape of the `fill_value` field for `complex64`. A two-element JSON array `[real, imag]` where each component is a `Complex64Component`. """ __all__ = [ "COMPLEX64_DATA_TYPE_NAME", "Complex64Component", "Complex64DataTypeName", "Complex64FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/float16.py000066400000000000000000000044021523267620000300640ustar00rootroot00000000000000""" Zarr v3 `float16` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ import re from typing import Final, Literal, NewType FLOAT16_DATA_TYPE_NAME: Final = "float16" """The `data_type` value for the `float16` type.""" Float16DataTypeName = Literal["float16"] """Literal type of the `data_type` field for `float16`.""" Float16SpecialFillValue = Literal["NaN", "Infinity", "-Infinity"] """Named non-finite fill values permitted by the spec for IEEE 754 floats.""" HexFloat16 = NewType("HexFloat16", str) """A 6-character hex string (`0x` + 4 hex digits) encoding the unsigned-integer representation of a float16.""" _HEX_FLOAT16_RE: Final = re.compile(r"^0x[0-9a-fA-F]{4}$") def hex_float16(value: str) -> HexFloat16: """Validate `value` as a HexFloat16 and brand it. Raises ValueError if `value` is not exactly `0x` followed by 4 hex digits. """ if not _HEX_FLOAT16_RE.fullmatch(value): raise ValueError(f"Expected '0x' followed by 4 hex digits, got {value!r}") return HexFloat16(value) Float16FillValue = float | int | Float16SpecialFillValue | HexFloat16 """Permitted JSON shape of the `fill_value` field for `float16`. Either a JSON number, one of the named non-finite sentinels (`"NaN"`, `"Infinity"`, `"-Infinity"`), or a `HexFloat16` (`0xYYYY` string encoding the unsigned-integer representation of the IEEE 754 value). """ CANONICAL_NAN_HEX_FLOAT16: Final = "0x7e00" """Canonical hex form of the float16 NaN sentinel `"NaN"`. Per spec the named `"NaN"` sentinel denotes the float with sign=0, the most significant mantissa bit set, and all other mantissa bits zero (the IEEE 754 default quiet NaN). Other NaN bit patterns must be encoded with the explicit hex-string form. """ CANONICAL_POSITIVE_INFINITY_HEX_FLOAT16: Final = "0x7c00" """Canonical hex form of the float16 `"Infinity"` sentinel.""" CANONICAL_NEGATIVE_INFINITY_HEX_FLOAT16: Final = "0xfc00" """Canonical hex form of the float16 `"-Infinity"` sentinel.""" __all__ = [ "CANONICAL_NAN_HEX_FLOAT16", "CANONICAL_NEGATIVE_INFINITY_HEX_FLOAT16", "CANONICAL_POSITIVE_INFINITY_HEX_FLOAT16", "FLOAT16_DATA_TYPE_NAME", "Float16DataTypeName", "Float16FillValue", "Float16SpecialFillValue", "HexFloat16", "hex_float16", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/float32.py000066400000000000000000000044231523267620000300650ustar00rootroot00000000000000""" Zarr v3 `float32` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ import re from typing import Final, Literal, NewType FLOAT32_DATA_TYPE_NAME: Final = "float32" """The `data_type` value for the `float32` type.""" Float32DataTypeName = Literal["float32"] """Literal type of the `data_type` field for `float32`.""" Float32SpecialFillValue = Literal["NaN", "Infinity", "-Infinity"] """Named non-finite fill values permitted by the spec for IEEE 754 floats.""" HexFloat32 = NewType("HexFloat32", str) """A 10-character hex string (`0x` + 8 hex digits) encoding the unsigned-integer representation of a float32.""" _HEX_FLOAT32_RE: Final = re.compile(r"^0x[0-9a-fA-F]{8}$") def hex_float32(value: str) -> HexFloat32: """Validate `value` as a HexFloat32 and brand it. Raises ValueError if `value` is not exactly `0x` followed by 8 hex digits. """ if not _HEX_FLOAT32_RE.fullmatch(value): raise ValueError(f"Expected '0x' followed by 8 hex digits, got {value!r}") return HexFloat32(value) Float32FillValue = float | int | Float32SpecialFillValue | HexFloat32 """Permitted JSON shape of the `fill_value` field for `float32`. Either a JSON number, one of the named non-finite sentinels (`"NaN"`, `"Infinity"`, `"-Infinity"`), or a `HexFloat32` (`0xYYYYYYYY` string encoding the unsigned-integer representation of the IEEE 754 value). """ CANONICAL_NAN_HEX_FLOAT32: Final = "0x7fc00000" """Canonical hex form of the float32 NaN sentinel `"NaN"`. Per spec the named `"NaN"` sentinel denotes the float with sign=0, the most significant mantissa bit set, and all other mantissa bits zero (the IEEE 754 default quiet NaN). Other NaN bit patterns must be encoded with the explicit hex-string form. """ CANONICAL_POSITIVE_INFINITY_HEX_FLOAT32: Final = "0x7f800000" """Canonical hex form of the float32 `"Infinity"` sentinel.""" CANONICAL_NEGATIVE_INFINITY_HEX_FLOAT32: Final = "0xff800000" """Canonical hex form of the float32 `"-Infinity"` sentinel.""" __all__ = [ "CANONICAL_NAN_HEX_FLOAT32", "CANONICAL_NEGATIVE_INFINITY_HEX_FLOAT32", "CANONICAL_POSITIVE_INFINITY_HEX_FLOAT32", "FLOAT32_DATA_TYPE_NAME", "Float32DataTypeName", "Float32FillValue", "Float32SpecialFillValue", "HexFloat32", "hex_float32", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/float64.py000066400000000000000000000044701523267620000300740ustar00rootroot00000000000000""" Zarr v3 `float64` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ import re from typing import Final, Literal, NewType FLOAT64_DATA_TYPE_NAME: Final = "float64" """The `data_type` value for the `float64` type.""" Float64DataTypeName = Literal["float64"] """Literal type of the `data_type` field for `float64`.""" Float64SpecialFillValue = Literal["NaN", "Infinity", "-Infinity"] """Named non-finite fill values permitted by the spec for IEEE 754 floats.""" HexFloat64 = NewType("HexFloat64", str) """An 18-character hex string (`0x` + 16 hex digits) encoding the unsigned-integer representation of a float64.""" _HEX_FLOAT64_RE: Final = re.compile(r"^0x[0-9a-fA-F]{16}$") def hex_float64(value: str) -> HexFloat64: """Validate `value` as a HexFloat64 and brand it. Raises ValueError if `value` is not exactly `0x` followed by 16 hex digits. """ if not _HEX_FLOAT64_RE.fullmatch(value): raise ValueError(f"Expected '0x' followed by 16 hex digits, got {value!r}") return HexFloat64(value) Float64FillValue = float | int | Float64SpecialFillValue | HexFloat64 """Permitted JSON shape of the `fill_value` field for `float64`. Either a JSON number, one of the named non-finite sentinels (`"NaN"`, `"Infinity"`, `"-Infinity"`), or a `HexFloat64` (`0xYYYYYYYYYYYYYYYY` string encoding the unsigned-integer representation of the IEEE 754 value). """ CANONICAL_NAN_HEX_FLOAT64: Final = "0x7ff8000000000000" """Canonical hex form of the float64 NaN sentinel `"NaN"`. Per spec the named `"NaN"` sentinel denotes the float with sign=0, the most significant mantissa bit set, and all other mantissa bits zero (the IEEE 754 default quiet NaN). Other NaN bit patterns must be encoded with the explicit hex-string form. """ CANONICAL_POSITIVE_INFINITY_HEX_FLOAT64: Final = "0x7ff0000000000000" """Canonical hex form of the float64 `"Infinity"` sentinel.""" CANONICAL_NEGATIVE_INFINITY_HEX_FLOAT64: Final = "0xfff0000000000000" """Canonical hex form of the float64 `"-Infinity"` sentinel.""" __all__ = [ "CANONICAL_NAN_HEX_FLOAT64", "CANONICAL_NEGATIVE_INFINITY_HEX_FLOAT64", "CANONICAL_POSITIVE_INFINITY_HEX_FLOAT64", "FLOAT64_DATA_TYPE_NAME", "Float64DataTypeName", "Float64FillValue", "Float64SpecialFillValue", "HexFloat64", "hex_float64", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/int16.py000066400000000000000000000010361523267620000275510ustar00rootroot00000000000000""" Zarr v3 `int16` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal INT16_DATA_TYPE_NAME: Final = "int16" """The `data_type` value for the `int16` type.""" Int16DataTypeName = Literal["int16"] """Literal type of the `data_type` field for `int16`.""" Int16FillValue = int """Permitted JSON shape of the `fill_value` field for `int16`: a JSON integer in [-32768, 32767].""" __all__ = [ "INT16_DATA_TYPE_NAME", "Int16DataTypeName", "Int16FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/int32.py000066400000000000000000000010421523267620000275440ustar00rootroot00000000000000""" Zarr v3 `int32` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal INT32_DATA_TYPE_NAME: Final = "int32" """The `data_type` value for the `int32` type.""" Int32DataTypeName = Literal["int32"] """Literal type of the `data_type` field for `int32`.""" Int32FillValue = int """Permitted JSON shape of the `fill_value` field for `int32`: a JSON integer in [-2**31, 2**31 - 1].""" __all__ = [ "INT32_DATA_TYPE_NAME", "Int32DataTypeName", "Int32FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/int64.py000066400000000000000000000010421523267620000275510ustar00rootroot00000000000000""" Zarr v3 `int64` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal INT64_DATA_TYPE_NAME: Final = "int64" """The `data_type` value for the `int64` type.""" Int64DataTypeName = Literal["int64"] """Literal type of the `data_type` field for `int64`.""" Int64FillValue = int """Permitted JSON shape of the `fill_value` field for `int64`: a JSON integer in [-2**63, 2**63 - 1].""" __all__ = [ "INT64_DATA_TYPE_NAME", "Int64DataTypeName", "Int64FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/int8.py000066400000000000000000000010161523267620000274700ustar00rootroot00000000000000""" Zarr v3 `int8` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal INT8_DATA_TYPE_NAME: Final = "int8" """The `data_type` value for the `int8` type.""" Int8DataTypeName = Literal["int8"] """Literal type of the `data_type` field for `int8`.""" Int8FillValue = int """Permitted JSON shape of the `fill_value` field for `int8`: a JSON integer in [-128, 127].""" __all__ = [ "INT8_DATA_TYPE_NAME", "Int8DataTypeName", "Int8FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/numpy_datetime64.py000066400000000000000000000031451523267620000320110ustar00rootroot00000000000000""" Zarr `numpy.datetime64` data type (zarr-extensions). See https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/numpy.datetime64 """ from typing import Final, Literal from typing_extensions import ReadOnly, TypedDict NUMPY_DATETIME64_DATA_TYPE_NAME: Final = "numpy.datetime64" """The `name` field value of the `numpy.datetime64` data type.""" NumpyDatetime64DataTypeName = Literal["numpy.datetime64"] """Literal type of the `name` field of the `numpy.datetime64` data type.""" NumpyTimeUnit = Literal[ "Y", "M", "W", "D", "h", "m", "s", "ms", "us", "μs", "ns", "ps", "fs", "as", "generic" ] """Time unit codes used by numpy.datetime64.""" class NumpyDatetime64Configuration(TypedDict): """ Configuration for the `numpy.datetime64` data type. Attributes ---------- unit A string encoding a unit of time. scale_factor The multiplier relative to the unit. """ unit: ReadOnly[NumpyTimeUnit] scale_factor: ReadOnly[int] class NumpyDatetime64(TypedDict): """`numpy.datetime64` data type metadata.""" name: NumpyDatetime64DataTypeName configuration: NumpyDatetime64Configuration NumpyDatetime64FillValue = int | Literal["NaT"] """Permitted JSON shape of the `fill_value` field for `numpy.datetime64`. Either a JSON integer (count of `unit * scale_factor` since the epoch), or the string `"NaT"` (equivalent to the integer `-2**63`). """ __all__ = [ "NUMPY_DATETIME64_DATA_TYPE_NAME", "NumpyDatetime64", "NumpyDatetime64Configuration", "NumpyDatetime64DataTypeName", "NumpyDatetime64FillValue", "NumpyTimeUnit", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/numpy_timedelta64.py000066400000000000000000000036211523267620000321640ustar00rootroot00000000000000""" Zarr `numpy.timedelta64` data type (zarr-extensions). See https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/numpy.timedelta64 """ from typing import Final, Literal from typing_extensions import ReadOnly, TypedDict NUMPY_TIMEDELTA64_DATA_TYPE_NAME: Final = "numpy.timedelta64" """The `name` field value of the `numpy.timedelta64` data type.""" NumpyTimedelta64DataTypeName = Literal["numpy.timedelta64"] """Literal type of the `name` field of the `numpy.timedelta64` data type.""" NumpyTimeUnit = Literal[ "Y", "M", "W", "D", "h", "m", "s", "ms", "us", "μs", "ns", "ps", "fs", "as", "generic" ] """Time unit codes used by numpy.timedelta64.""" NUMPY_TIME_UNIT: Final = ( "Y", "M", "W", "D", "h", "m", "s", "ms", "us", "μs", "ns", "ps", "fs", "as", "generic", ) """Runtime tuple of the permitted `numpy.timedelta64`/`numpy.datetime64` unit strings.""" class NumpyTimedelta64Configuration(TypedDict): """ Configuration for the `numpy.timedelta64` data type. Attributes ---------- unit A string encoding a unit of time. scale_factor The multiplier relative to the unit. """ unit: ReadOnly[NumpyTimeUnit] scale_factor: ReadOnly[int] class NumpyTimedelta64(TypedDict): """`numpy.timedelta64` data type metadata.""" name: NumpyTimedelta64DataTypeName configuration: NumpyTimedelta64Configuration NumpyTimedelta64FillValue = int | Literal["NaT"] """Permitted JSON shape of the `fill_value` field for `numpy.timedelta64`. Either a JSON integer (a count of `unit * scale_factor`), or the string `"NaT"` (equivalent to the integer `-2**63`). """ __all__ = [ "NUMPY_TIMEDELTA64_DATA_TYPE_NAME", "NUMPY_TIME_UNIT", "NumpyTimeUnit", "NumpyTimedelta64", "NumpyTimedelta64Configuration", "NumpyTimedelta64DataTypeName", "NumpyTimedelta64FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/raw.py000066400000000000000000000024531523267620000274050ustar00rootroot00000000000000""" Zarr v3 `r` raw-bytes data type (parameterised by bit count). The `data_type` value is a string of the form `r` where `N` is a positive multiple of 8 (e.g. `r8`, `r16`, `r24`). See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html """ import re from typing import Final, NewType RawBytesDataTypeName = NewType("RawBytesDataTypeName", str) """A spec-conformant `r` raw-bytes name (e.g. `"r8"`, `"r16"`).""" _RAW_BYTES_RE: Final = re.compile(r"^r(\d+)$") def raw_bytes_dtype_name(value: str) -> RawBytesDataTypeName: """Validate `value` as a `r` raw-bytes name and brand it. Raises ValueError if `value` is not `r` followed by a positive multiple of 8. """ match = _RAW_BYTES_RE.fullmatch(value) if match is None: raise ValueError(f"Expected 'r' followed by a positive integer, got {value!r}") bits = int(match.group(1)) if bits == 0 or bits % 8 != 0: raise ValueError(f"Expected 'r' where N is a positive multiple of 8, got {value!r}") return RawBytesDataTypeName(value) RawBytesFillValue = tuple[int, ...] """Permitted JSON shape of the `fill_value` field for `r`. A JSON array of N/8 integers in `[0, 255]` (one per byte). """ __all__ = [ "RawBytesDataTypeName", "RawBytesFillValue", "raw_bytes_dtype_name", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/string.py000066400000000000000000000011161523267620000301150ustar00rootroot00000000000000""" Zarr `string` data type (variable-length utf-8, zarr-extensions). See https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/string """ from typing import Final, Literal STRING_DATA_TYPE_NAME: Final = "string" """The `data_type` value for the `string` type.""" StringDataTypeName = Literal["string"] """Literal type of the `data_type` field for `string`.""" StringFillValue = str """Permitted JSON shape of the `fill_value` field for `string`: a JSON unicode string.""" __all__ = [ "STRING_DATA_TYPE_NAME", "StringDataTypeName", "StringFillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/struct.py000066400000000000000000000032711523267620000301370ustar00rootroot00000000000000""" Zarr `struct` data type (heterogeneous record, zarr-extensions). See https://github.com/zarr-developers/zarr-extensions/blob/main/data-types/struct/README.md """ from collections.abc import Mapping from typing import Final, Literal from typing_extensions import ReadOnly, TypedDict from zarr_metadata._common import JSONValue from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON STRUCT_DATA_TYPE_NAME: Final = "struct" """The `name` field value of the `struct` data type.""" StructDataTypeName = Literal["struct"] """Literal type of the `name` field of the `struct` data type.""" class StructField(TypedDict): """ A single field entry inside a structured dtype. Attributes ---------- name The field name (must be unique within a struct and non-empty). data_type The field's data type. Recursive: may be a bare-string primitive or a named-config envelope including another `struct`. """ name: ReadOnly[str] data_type: ReadOnly[ZarrV3MetadataFieldJSON] class StructConfiguration(TypedDict): """Configuration for the `struct` data type.""" fields: ReadOnly[tuple[StructField, ...]] class Struct(TypedDict): """`struct` data type metadata.""" name: StructDataTypeName configuration: StructConfiguration StructFillValue = Mapping[str, JSONValue] """Permitted JSON shape of the `fill_value` field for `struct`. A JSON object mapping each field name to that field's fill value. Field fill values are themselves shaped per the field's `data_type`, recursively. """ __all__ = [ "STRUCT_DATA_TYPE_NAME", "Struct", "StructConfiguration", "StructDataTypeName", "StructField", "StructFillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/uint16.py000066400000000000000000000010451523267620000277360ustar00rootroot00000000000000""" Zarr v3 `uint16` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal UINT16_DATA_TYPE_NAME: Final = "uint16" """The `data_type` value for the `uint16` type.""" Uint16DataTypeName = Literal["uint16"] """Literal type of the `data_type` field for `uint16`.""" Uint16FillValue = int """Permitted JSON shape of the `fill_value` field for `uint16`: a JSON integer in [0, 65535].""" __all__ = [ "UINT16_DATA_TYPE_NAME", "Uint16DataTypeName", "Uint16FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/uint32.py000066400000000000000000000010511523267620000277310ustar00rootroot00000000000000""" Zarr v3 `uint32` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal UINT32_DATA_TYPE_NAME: Final = "uint32" """The `data_type` value for the `uint32` type.""" Uint32DataTypeName = Literal["uint32"] """Literal type of the `data_type` field for `uint32`.""" Uint32FillValue = int """Permitted JSON shape of the `fill_value` field for `uint32`: a JSON integer in [0, 2**32 - 1].""" __all__ = [ "UINT32_DATA_TYPE_NAME", "Uint32DataTypeName", "Uint32FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/uint64.py000066400000000000000000000010511523267620000277360ustar00rootroot00000000000000""" Zarr v3 `uint64` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal UINT64_DATA_TYPE_NAME: Final = "uint64" """The `data_type` value for the `uint64` type.""" Uint64DataTypeName = Literal["uint64"] """Literal type of the `data_type` field for `uint64`.""" Uint64FillValue = int """Permitted JSON shape of the `fill_value` field for `uint64`: a JSON integer in [0, 2**64 - 1].""" __all__ = [ "UINT64_DATA_TYPE_NAME", "Uint64DataTypeName", "Uint64FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/data_type/uint8.py000066400000000000000000000010271523267620000276570ustar00rootroot00000000000000""" Zarr v3 `uint8` data type. See https://zarr-specs.readthedocs.io/en/latest/v3/data-types/index.html """ from typing import Final, Literal UINT8_DATA_TYPE_NAME: Final = "uint8" """The `data_type` value for the `uint8` type.""" Uint8DataTypeName = Literal["uint8"] """Literal type of the `data_type` field for `uint8`.""" Uint8FillValue = int """Permitted JSON shape of the `fill_value` field for `uint8`: a JSON integer in [0, 255].""" __all__ = [ "UINT8_DATA_TYPE_NAME", "Uint8DataTypeName", "Uint8FillValue", ] zarr-python-3.3.0/packages/zarr-metadata/src/zarr_metadata/v3/group.py000066400000000000000000000040051523267620000257710ustar00rootroot00000000000000"""Zarr v3 group metadata types. See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#group-metadata """ from collections.abc import Mapping from typing import Literal, NotRequired from typing_extensions import TypedDict from zarr_metadata._common import JSONValue from zarr_metadata.v3.array import ZarrV3ExtensionField class ZarrV3GroupMetadataJSON(TypedDict, extra_items=ZarrV3ExtensionField): """ Zarr v3 group metadata document (the `zarr.json` content for a group). Extra keys may contain arbitrary JSON values. See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#group-metadata """ zarr_format: Literal[3] node_type: Literal["group"] attributes: NotRequired[Mapping[str, JSONValue]] class ZarrV3GroupMetadataJSONPartial(TypedDict, total=False, extra_items=ZarrV3ExtensionField): """ Partial form of `ZarrV3GroupMetadataJSON`: every field is `NotRequired`. Field annotations and `extra_items=` mirror `ZarrV3GroupMetadataJSON` exactly. The only difference is `total=False`, which makes every key optional at the type level. Use this when typing dicts that intentionally hold a subset of a complete v3 group metadata document — e.g. test fixtures that override only a few fields of a base template, or callers that build a fragment to be merged into a complete document elsewhere. The `NotRequired[...]` wrapper on `attributes` is intentional: keeping it preserves byte-identical `__annotations__` with `ZarrV3GroupMetadataJSON` so the `==` check in `tests/test_partial_equivalence.py` passes without special-casing that field (PEP 655 explicitly permits `NotRequired` inside `total=False`). Drift between this type and `ZarrV3GroupMetadataJSON` is prevented by `tests/test_partial_equivalence.py`. """ zarr_format: Literal[3] node_type: Literal["group"] attributes: NotRequired[Mapping[str, JSONValue]] __all__ = [ "ZarrV3GroupMetadataJSON", "ZarrV3GroupMetadataJSONPartial", ] zarr-python-3.3.0/packages/zarr-metadata/tests/000077500000000000000000000000001523267620000214715ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/__init__.py000066400000000000000000000000371523267620000236020ustar00rootroot00000000000000"""Tests for zarr-metadata.""" zarr-python-3.3.0/packages/zarr-metadata/tests/model/000077500000000000000000000000001523267620000225715ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/model/__init__.py000066400000000000000000000000001523267620000246700ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/model/_cases.py000066400000000000000000000037331523267620000244060ustar00rootroot00000000000000from __future__ import annotations import re from dataclasses import dataclass from typing import TYPE_CHECKING, Generic, TypeVar import pytest if TYPE_CHECKING: from contextlib import AbstractContextManager TIn = TypeVar("TIn") TOut = TypeVar("TOut") @dataclass(frozen=True) class Expect(Generic[TIn, TOut]): """A test case with explicit input, expected output, and a human-readable id.""" input: TIn output: TOut id: str @dataclass(frozen=True) class ExpectFail(Generic[TIn]): """A test case that should raise an exception. `msg` is a regex matched against the exception text (pytest's native `match=` semantics). Leave it `None` to assert only the exception type. Set `escape=True` when `msg` is a literal that contains regex metacharacters such as `(`, `[`, or `.`; `escape` has no effect when `msg` is `None`. """ input: TIn exception: type[Exception] id: str msg: str | None = None escape: bool = False def raises(self) -> AbstractContextManager[pytest.ExceptionInfo[Exception]]: if self.msg is None: return pytest.raises(self.exception) pattern = re.escape(self.msg) if self.escape else self.msg return pytest.raises(self.exception, match=pattern) def mutate_nested_containers(value: object) -> None: """Recursively mutate every mutable container reachable inside `value`. Adds a marker key to every dict and appends a marker to every list, descending through tuples. Used to prove a `to_json` document shares no mutable state with the model that produced it. """ if isinstance(value, dict): for item in value.values(): mutate_nested_containers(item) value["__mutated__"] = "__mutated__" elif isinstance(value, list): for item in value: mutate_nested_containers(item) value.append("__mutated__") elif isinstance(value, tuple): for item in value: mutate_nested_containers(item) zarr-python-3.3.0/packages/zarr-metadata/tests/model/test_array.py000066400000000000000000002106441523267620000253270ustar00rootroot00000000000000"""Tests for the metadata models in ``zarr_metadata.model``.""" import copy import dataclasses import json from collections import UserDict from collections.abc import Callable from typing import TYPE_CHECKING, get_args import pytest from typing_extensions import Unpack from tests.model._cases import Expect, ExpectFail, mutate_nested_containers from zarr_metadata.model import ( ARRAY_METADATA_OPTIONAL_KEYS_V3, ARRAY_METADATA_REQUIRED_KEYS_V3, ARRAY_METADATA_STANDARD_KEYS_V3, UNSET, MetadataValidationError, ValidationProblem, ZarrV2ArrayMetadata, ZarrV2ArrayMetadataPartial, ZarrV3ArrayMetadata, ZarrV3ArrayMetadataPartial, ZarrV3MetadataField, ZarrV3NamedConfig, is_array_metadata_v2, is_array_metadata_v3, is_json, is_metadata_field_v3, parse_array_metadata_v2, parse_array_metadata_v3, parse_json, parse_metadata_field_v3, validate_array_metadata_v2, validate_array_metadata_v3, validate_json, validate_metadata_field_v3, ) from zarr_metadata.model._validation import _prefix, arrays_to_tuples if TYPE_CHECKING: from zarr_metadata._common import JSONValue from zarr_metadata.v2 import ZarrV2CodecMetadata # --- public exports -------------------------------------------------------- def test_guards_exported_from_package() -> None: """The wire-type guard/parser functions are exported from the package.""" import zarr_metadata.model for name in ( "is_json", "parse_json", "is_metadata_field_v3", "parse_metadata_field_v3", "is_array_metadata_v3", "parse_array_metadata_v3", "is_array_metadata_v2", "parse_array_metadata_v2", ): assert name in zarr_metadata.model.__all__ assert hasattr(zarr_metadata.model, name) def test_store_key_pairs_exported_from_package() -> None: """Each store-key constant is exported together with its Literal type alias, and the pair cannot drift apart.""" import zarr_metadata.model as m pairs = [ ("ARRAY_METADATA_STORE_KEY_V2", "ZarrV2ArrayMetadataStoreKey"), ("ARRAY_METADATA_STORE_KEY_V3", "ZarrV3ArrayMetadataStoreKey"), ("ATTRIBUTES_STORE_KEY_V2", "ZarrV2AttributesStoreKey"), ("GROUP_METADATA_STORE_KEY_V2", "ZarrV2GroupMetadataStoreKey"), ("GROUP_METADATA_STORE_KEY_V3", "ZarrV3GroupMetadataStoreKey"), ("CONSOLIDATED_METADATA_STORE_KEY_V2", "ZarrV2ConsolidatedMetadataStoreKey"), ] for const_name, alias_name in pairs: assert const_name in m.__all__ assert alias_name in m.__all__ assert (getattr(m, const_name),) == get_args(getattr(m, alias_name)) def test_validation_diagnostics_exported_from_package() -> None: """The validation-diagnostic types and validators are exported from the package.""" import zarr_metadata.model for name in ( "ValidationProblem", "MetadataValidationError", "validate_json", "validate_metadata_field_v3", "validate_array_metadata_v3", "validate_array_metadata_v2", ): assert name in zarr_metadata.model.__all__ assert hasattr(zarr_metadata.model, name) def test_expect_expectfail_smoke() -> None: """The Expect/ExpectFail test-case dataclasses behave as expected.""" e = Expect(input=1, output=2, id="x") assert (e.input, e.output, e.id) == (1, 2, "x") f = ExpectFail(input=1, exception=ValueError, id="y", msg="boom") with f.raises(): raise ValueError("boom") def test_v3_from_json_error_lists_all_problems() -> None: """A malformed v3 document surfaces every problem via MetadataValidationError.problems.""" doc: dict[str, object] = dict(ZarrV3ArrayMetadata.create_default().to_json()) del doc["shape"] doc["data_type"] = 5 with pytest.raises(MetadataValidationError) as exc_info: ZarrV3ArrayMetadata.from_json(doc) locs = {p.loc for p in exc_info.value.problems} assert ("shape",) in locs assert ("data_type",) in locs # --- JSON type / fill_value contract --------------------------------------- def test_json_value_type_accepts_json_shapes() -> None: # JSONValue is the package's public JSON type alias; assigning JSON-shaped # values to it is valid. """The JSONValue type alias accepts JSON-shaped values.""" value: JSONValue = {"a": [1, 2.0, "x", True, None]} assert value == {"a": [1, 2.0, "x", True, None]} def test_string_nan_fill_value_roundtrips() -> None: # Non-finite floats are represented as the spec strings ("NaN", "Infinity", # "-Infinity") by the caller — the metadata layer does not interpret dtypes. # The string form round-trips cleanly under default dataclass equality, # unlike a raw float('nan') (which is an invalid fill_value the caller must # not pass). """A string 'NaN' fill_value round-trips cleanly (non-finite floats are the caller's responsibility).""" m = ZarrV3ArrayMetadata.create_default(fill_value="NaN") assert ZarrV3ArrayMetadata.from_json(m.to_json()) == m assert ZarrV3ArrayMetadata.from_json(m.to_json()).fill_value == "NaN" # --- ZarrV3NamedConfig.to_json ------------------------------------------------ ZARR_TO_JSON_CASES = [ Expect( ZarrV3NamedConfig(name="regular", configuration={"chunk_shape": [1]}), {"name": "regular", "configuration": {"chunk_shape": [1]}}, id="with-configuration", ), Expect( ZarrV3NamedConfig(name="bytes", configuration={}), "bytes", id="empty-configuration-shorthand", ), ] @pytest.mark.parametrize("case", ZARR_TO_JSON_CASES, ids=lambda c: c.id) def test_zarr_metadata_v3_to_json(case: Expect[ZarrV3NamedConfig, object]) -> None: """ZarrV3NamedConfig.to_json emits the canonical extension form.""" assert case.input.to_json() == case.output def test_zarr_metadata_v3_to_json_preserves_false_obligation() -> None: """An empty optional extension stays an object so false is not lost.""" model = ZarrV3NamedConfig(name="optional", configuration={}, must_understand=False) assert model.to_json() == {"name": "optional", "must_understand": False} # --- ZarrV3NamedConfig.from_json ----------------------------------------------- ZARR_FROM_JSON_CASES = [ Expect("bytes", ZarrV3NamedConfig(name="bytes", configuration={}), id="bare-string"), Expect( {"name": "regular", "configuration": {"chunk_shape": [1]}}, ZarrV3NamedConfig(name="regular", configuration={"chunk_shape": (1,)}), id="object-with-config", ), Expect( {"name": "bytes"}, ZarrV3NamedConfig(name="bytes", configuration={}), id="object-without-config", ), ] @pytest.mark.parametrize("case", ZARR_FROM_JSON_CASES, ids=lambda c: c.id) def test_zarr_metadata_v3_from_json(case: Expect[object, ZarrV3NamedConfig]) -> None: """ZarrV3NamedConfig.from_json parses both the bare-string and object forms.""" assert ZarrV3NamedConfig.from_json(case.input) == case.output def test_zarr_metadata_v3_from_json_preserves_false_obligation() -> None: """Explicit false is represented on the normalized model.""" model = ZarrV3NamedConfig.from_json({"name": "optional", "must_understand": False}) assert model.must_understand is False # --- V3 baseline ----------------------------------------------------------- def test_v3_to_json_emits_canonical_document() -> None: """V3 to_json emits exactly the expected document (which covers every spec-required key by construction).""" out = ZarrV3ArrayMetadata.create_default( shape=(10,), data_type=ZarrV3NamedConfig(name="int32", configuration={}) ).to_json() assert out == { "zarr_format": 3, "node_type": "array", "shape": (10,), "fill_value": 0, "data_type": "int32", "chunk_grid": {"name": "regular", "configuration": {"chunk_shape": (10,)}}, "codecs": ("bytes",), "chunk_key_encoding": "default", } def test_v3_dimension_names_included_when_present() -> None: """V3 to_json includes dimension_names when they are set.""" out: dict[str, object] = dict( ZarrV3ArrayMetadata.create_default(dimension_names=("x",)).to_json() ) assert out["dimension_names"] == ("x",) def test_v3_dimension_names_omitted_when_none() -> None: """V3 to_json omits dimension_names when they are UNSET.""" out = ZarrV3ArrayMetadata.create_default(dimension_names=UNSET).to_json() assert "dimension_names" not in out # --- BUG 1: attributes gated on dimension_names ---------------------------- def test_v3_attributes_included_when_dimension_names_is_none() -> None: """Attributes must be emitted regardless of dimension_names. Regression: attributes were gated on ``dimension_names is not None``, so non-empty attributes were silently dropped when there were no dimension names. """ out: dict[str, object] = dict( ZarrV3ArrayMetadata.create_default( dimension_names=UNSET, attributes={"foo": "bar"} ).to_json() ) assert out["attributes"] == {"foo": "bar"} # --- BUG 2: single storage transformer dropped ----------------------------- def test_v3_single_storage_transformer_included() -> None: """A single storage transformer must be emitted. Regression: the guard used ``> 1`` instead of ``> 0``, dropping a lone storage transformer. """ st = ZarrV3NamedConfig(name="some_transformer", configuration={}) out: dict[str, object] = dict( ZarrV3ArrayMetadata.create_default(storage_transformers=(st,)).to_json() ) assert out["storage_transformers"] == ("some_transformer",) def test_v3_no_storage_transformers_omitted() -> None: """V3 to_json omits storage_transformers when empty.""" out = ZarrV3ArrayMetadata.create_default(storage_transformers=()).to_json() assert "storage_transformers" not in out # --- V3 extra fields ------------------------------------------------------- def test_v3_extra_fields_merged() -> None: """V3 to_json merges extra_fields into the top-level document.""" out = ZarrV3ArrayMetadata.create_default( extra_fields={"my_ext": {"must_understand": False}} ).to_json() assert out["my_ext"] == {"must_understand": False} def test_v3_extra_fields_overlapping_standard_field_rejected() -> None: """Constructing a V3 model with an extra field that collides with a standard key is rejected.""" with pytest.raises(ValueError): ZarrV3ArrayMetadata.create_default(extra_fields={"shape": {"must_understand": False}}) # --- V3 key/value ---------------------------------------------------------- def test_v3_to_key_value_is_valid_json_under_zarr_json() -> None: """V3 to_key_value produces valid JSON bytes under the zarr.json key.""" kv = ZarrV3ArrayMetadata.create_default(attributes={"a": 1}).to_key_value() assert set(kv) == {"zarr.json"} parsed = json.loads(kv["zarr.json"].decode("utf-8")) assert parsed["zarr_format"] == 3 assert parsed["attributes"] == {"a": 1} # --- V3 standard-key sets -------------------------------------------------- def test_standard_keys_is_union_of_required_and_optional() -> None: """The standard-key set is the union of the required and optional key sets.""" assert ( ARRAY_METADATA_STANDARD_KEYS_V3 == ARRAY_METADATA_REQUIRED_KEYS_V3 | ARRAY_METADATA_OPTIONAL_KEYS_V3 ) def test_standard_keys_contains_known_fields_and_excludes_extensions() -> None: """The standard-key set contains known fields and excludes extension keys.""" assert { "zarr_format", "node_type", "shape", "codecs", } <= ARRAY_METADATA_STANDARD_KEYS_V3 assert "my_ext" not in ARRAY_METADATA_STANDARD_KEYS_V3 # --- create_default -------------------------------------------------------- def test_v3_create_default_is_valid_empty_array() -> None: """V3 create_default builds a structurally valid empty array that round-trips.""" m = ZarrV3ArrayMetadata.create_default() assert m.shape == () assert m.data_type == ZarrV3NamedConfig(name="uint8", configuration={}) assert m.fill_value == 0 assert m.attributes == {} assert m.extra_fields == {} # the default document is structurally valid and round-trips assert validate_array_metadata_v3(m.to_json()) == [] assert ZarrV3ArrayMetadata.from_json(m.to_json()) == m def test_v3_create_default_applies_overrides() -> None: """V3 create_default applies keyword overrides over the defaults.""" m = ZarrV3ArrayMetadata.create_default(shape=(4, 4), attributes={"a": 1}) assert m.shape == (4, 4) assert m.attributes == {"a": 1} # un-overridden fields keep their defaults assert m.data_type == ZarrV3NamedConfig(name="uint8", configuration={}) def test_v2_create_default_is_valid_empty_array() -> None: """V2 create_default builds a structurally valid empty array that round-trips.""" m = ZarrV2ArrayMetadata.create_default() assert m.shape == () assert m.chunks == () assert m.fill_value == 0 assert m.compressor is None assert m.filters is None assert m.attributes is UNSET assert validate_array_metadata_v2(m.to_json()) == [] assert ZarrV2ArrayMetadata.from_json(m.to_json()) == m def test_v2_create_default_applies_overrides() -> None: """V2 create_default applies keyword overrides over the defaults.""" m = ZarrV2ArrayMetadata.create_default(shape=(8,), attributes={"k": "v"}) assert m.shape == (8,) assert m.attributes == {"k": "v"} assert m.dtype == "|u1" # default dtype unchanged # --- V3 update ------------------------------------------------------------- # Cluster 3: update same-shape pairs across versions — parametrized UPDATE_NEW_INSTANCE_PARAMS = [ pytest.param(ZarrV3ArrayMetadata, id="v3"), pytest.param(ZarrV2ArrayMetadata, id="v2"), ] @pytest.mark.parametrize("model_cls", UPDATE_NEW_INSTANCE_PARAMS) def test_update_returns_new_instance( model_cls: type[ZarrV3ArrayMetadata | ZarrV2ArrayMetadata], ) -> None: """update returns a new instance with the field replaced, leaving the original unchanged.""" base = model_cls.create_default(shape=(10,)) updated = base.update(shape=(20,)) assert updated.shape == (20,) assert base.shape == (10,) # original unchanged assert isinstance(updated, model_cls) UPDATE_NO_ARGS_PARAMS = [ pytest.param(ZarrV3ArrayMetadata, id="v3"), pytest.param(ZarrV2ArrayMetadata, id="v2"), ] @pytest.mark.parametrize("model_cls", UPDATE_NO_ARGS_PARAMS) def test_update_no_args_returns_equal_model( model_cls: type[ZarrV3ArrayMetadata | ZarrV2ArrayMetadata], ) -> None: """update with no arguments returns a model equal to the original.""" base = model_cls.create_default() assert base.update() == base # V3-only update tests — kept direct (extra_fields is v3-specific) def test_update_can_replace_extra_fields() -> None: """update can replace the extra_fields mapping.""" base = ZarrV3ArrayMetadata.create_default(extra_fields={}) updated = base.update(extra_fields={"my_ext": {"must_understand": False}}) assert updated.extra_fields == {"my_ext": {"must_understand": False}} def test_update_replaces_extra_fields_rather_than_merging() -> None: """update replaces extra_fields wholesale rather than merging.""" base = ZarrV3ArrayMetadata.create_default(extra_fields={"a": {"must_understand": False}}) updated = base.update(extra_fields={"b": {"must_understand": True}}) assert updated.extra_fields == {"b": {"must_understand": True}} def test_partial_keys_match_settable_model_fields() -> None: """The partial TypedDict must list exactly the constructor-settable fields. Guards against drift: adding/removing a settable field on the model without updating ``ZarrV3ArrayMetadataPartial`` fails here. """ settable = {f.name for f in dataclasses.fields(ZarrV3ArrayMetadata) if f.init} assert set(ZarrV3ArrayMetadataPartial.__annotations__) == settable # --- V2 model -------------------------------------------------------------- def test_v2_partial_keys_match_settable_model_fields() -> None: """The v2 partial TypedDict must list exactly the settable fields.""" settable = {f.name for f in dataclasses.fields(ZarrV2ArrayMetadata) if f.init} assert set(ZarrV2ArrayMetadataPartial.__annotations__) == settable def test_v2_to_key_value_splits_zarray_and_zattrs() -> None: """V2 to_key_value splits the document into .zarray and .zattrs.""" kv = ZarrV2ArrayMetadata.create_default(attributes={"a": 1}).to_key_value() assert set(kv) == {".zarray", ".zattrs"} zarray = json.loads(kv[".zarray"].decode("utf-8")) zattrs = json.loads(kv[".zattrs"].decode("utf-8")) assert zarray["zarr_format"] == 2 assert zattrs == {"a": 1} def test_v2_zarray_excludes_attributes() -> None: """The on-disk ``.zarray`` document must not contain user attributes. In v2, attributes live only in the sibling ``.zattrs`` file. The bundled ``ZarrV2ArrayMetadataJSON`` / ``to_json()`` carry attributes for convenience, but ``to_key_value()`` must split them out. """ kv = ZarrV2ArrayMetadata.create_default(attributes={"a": 1}).to_key_value() zarray = json.loads(kv[".zarray"].decode("utf-8")) assert "attributes" not in zarray def test_v2_to_json_still_includes_attributes() -> None: """``to_json()`` is the bundled in-memory form and keeps attributes.""" out: dict[str, object] = dict(ZarrV2ArrayMetadata.create_default(attributes={"a": 1}).to_json()) assert out["attributes"] == {"a": 1} # --- arrays_to_tuples helper ---------------------------------------------- ARRAYS_TO_TUPLES_CASES = [ Expect([1, 2, 3], (1, 2, 3), id="top-level-list"), Expect({"a": [1, [2, 3]], "b": "x"}, {"a": (1, (2, 3)), "b": "x"}, id="nested-in-dict"), Expect(5, 5, id="scalar-int"), Expect("s", "s", id="scalar-str"), Expect(None, None, id="scalar-none"), Expect( {"name": "bytes", "configuration": {"nums": [1, 2]}}, {"name": "bytes", "configuration": {"nums": (1, 2)}}, id="dict-keys-preserved", ), ] @pytest.mark.parametrize("case", ARRAYS_TO_TUPLES_CASES, ids=lambda c: c.id) def test_arrays_to_tuples(case: Expect[object, object]) -> None: """arrays_to_tuples recursively converts JSON arrays to tuples.""" assert arrays_to_tuples(case.input) == case.output # --- ZarrV3ArrayMetadata.from_json ---------------------------------------- def test_v3_from_json_reconstructs_required_fields() -> None: """V3 from_json reconstructs the required fields from a document.""" doc = ZarrV3ArrayMetadata.create_default( shape=(7,), attributes={"a": 1}, data_type=ZarrV3NamedConfig(name="int32", configuration={}), ).to_json() model = ZarrV3ArrayMetadata.from_json(doc) assert model.shape == (7,) assert model.data_type == ZarrV3NamedConfig(name="int32", configuration={}) assert model.attributes == {"a": 1} def test_v3_from_json_defaults_for_omitted_optionals() -> None: """V3 from_json supplies defaults for omitted optional fields.""" doc = ZarrV3ArrayMetadata.create_default( attributes={}, storage_transformers=(), dimension_names=UNSET ).to_json() # to_json omits these entirely; from_json must restore defaults model = ZarrV3ArrayMetadata.from_json(doc) assert model.attributes == {} assert model.storage_transformers == () assert model.dimension_names is UNSET def test_v3_from_json_routes_unknown_keys_to_extra_fields() -> None: """V3 from_json routes unknown top-level keys into extra_fields.""" doc = ZarrV3ArrayMetadata.create_default( extra_fields={"my_ext": {"must_understand": False}} ).to_json() model = ZarrV3ArrayMetadata.from_json(doc) assert model.extra_fields == {"my_ext": {"must_understand": False}} def test_v3_from_json_standard_keys_not_in_extra_fields() -> None: """V3 from_json keeps standard keys out of extra_fields.""" doc = ZarrV3ArrayMetadata.create_default( shape=(10,), attributes={"a": 1}, dimension_names=("x",) ).to_json() model = ZarrV3ArrayMetadata.from_json(doc) assert model.extra_fields == {} def test_v3_from_json_nested_arrays_in_attributes_become_tuples() -> None: """V3 from_json converts nested arrays in attributes into tuples.""" doc = ZarrV3ArrayMetadata.create_default(attributes={"scale": [[1, 2], [3, 4]]}).to_json() model = ZarrV3ArrayMetadata.from_json(doc) assert model.attributes == {"scale": ((1, 2), (3, 4))} # --- ZarrV3ArrayMetadata.from_key_value ---------------------------------- def test_v3_from_key_value_parses_zarr_json() -> None: """V3 from_key_value parses the zarr.json entry into a model.""" kv = ZarrV3ArrayMetadata.create_default(shape=(3,)).to_key_value() model = ZarrV3ArrayMetadata.from_key_value(kv) assert model.shape == (3,) # --- Cluster 2: from_key_value missing-key raises (parametrized) ----------- FROM_KEY_VALUE_MISSING_PARAMS = [ pytest.param( ZarrV3ArrayMetadata, ExpectFail({}, MetadataValidationError, id="v3-missing-zarr-json", msg="missing store key"), id="v3-missing-zarr-json", ), pytest.param( ZarrV2ArrayMetadata, ExpectFail({}, MetadataValidationError, id="v2-missing-zarray", msg="missing store key"), id="v2-missing-zarray", ), ] @pytest.mark.parametrize(("model_cls", "case"), FROM_KEY_VALUE_MISSING_PARAMS) def test_from_key_value_missing_key_raises( model_cls: type[ZarrV3ArrayMetadata | ZarrV2ArrayMetadata], case: ExpectFail[dict[str, bytes]], ) -> None: """from_key_value raises MetadataValidationError when the required store key is absent.""" with case.raises(): model_cls.from_key_value(case.input) # --- Cluster 1: round-trips (model → json → model, parametrized) ----------- ROUNDTRIP_MODEL_JSON_PARAMS = [ pytest.param( ZarrV3ArrayMetadata, ZarrV3ArrayMetadata.create_default( shape=(10,), attributes={"a": 1}, dimension_names=("x",), storage_transformers=(ZarrV3NamedConfig(name="t", configuration={}),), extra_fields={"ext": {"must_understand": False}}, ), id="v3-full", ), pytest.param( ZarrV3ArrayMetadata, ZarrV3ArrayMetadata.create_default( attributes={}, dimension_names=UNSET, storage_transformers=(), extra_fields={}, ), id="v3-empty-optionals", ), pytest.param( ZarrV2ArrayMetadata, ZarrV2ArrayMetadata.create_default(attributes={"a": 1}, filters=None, compressor=None), id="v2-basic", ), ] @pytest.mark.parametrize(("model_cls", "model"), ROUNDTRIP_MODEL_JSON_PARAMS) def test_roundtrip_model_json_model( model_cls: type[ZarrV3ArrayMetadata | ZarrV2ArrayMetadata], model: ZarrV3ArrayMetadata | ZarrV2ArrayMetadata, ) -> None: """A model round-trips through to_json/from_json back to an equal model.""" assert model_cls.from_json(model.to_json()) == model # --- Round-trips (model → key_value → model, parametrized) ----------------- ROUNDTRIP_KEY_VALUE_PARAMS = [ pytest.param( ZarrV3ArrayMetadata, ZarrV3ArrayMetadata.create_default(attributes={"a": 1}), id="v3", ), pytest.param( ZarrV2ArrayMetadata, ZarrV2ArrayMetadata.create_default(attributes={"a": 1}), id="v2", ), ] @pytest.mark.parametrize(("model_cls", "model"), ROUNDTRIP_KEY_VALUE_PARAMS) def test_roundtrip_via_key_value( model_cls: type[ZarrV3ArrayMetadata | ZarrV2ArrayMetadata], model: ZarrV3ArrayMetadata | ZarrV2ArrayMetadata, ) -> None: """A model round-trips through to_key_value/from_key_value back to an equal model.""" assert model_cls.from_key_value(model.to_key_value()) == model # --- Round-trips (json → model → json, direction distinct — kept direct) --- def test_v3_roundtrip_json_model_json() -> None: """A v3 document round-trips through from_json/to_json back to an equal document.""" doc = ZarrV3ArrayMetadata.create_default( shape=(10,), attributes={"a": 1}, dimension_names=("x",) ).to_json() assert ZarrV3ArrayMetadata.from_json(doc).to_json() == doc def test_v2_roundtrip_json_model_json() -> None: """A v2 document round-trips through from_json/to_json back to an equal document.""" doc = ZarrV2ArrayMetadata.create_default(attributes={"a": 1}).to_json() assert ZarrV2ArrayMetadata.from_json(doc).to_json() == doc # --- to_json shares no mutable state with the model ------------------------ TO_JSON_NO_ALIASING_PARAMS = [ pytest.param( ZarrV3ArrayMetadata.create_default( shape=(2,), attributes={"a": {"b": [1]}}, codecs=(ZarrV3NamedConfig(name="blosc", configuration={"opts": {"level": 1}}),), extra_fields={"ext": {"must_understand": False, "cfg": {"x": [1]}}}, ), id="v3", ), pytest.param( ZarrV2ArrayMetadata.create_default( attributes={"a": {"b": [1]}}, compressor={"id": "zstd", "opts": {"level": 1}}, filters=({"id": "delta", "cfg": [1]},), fill_value=[0, 0], ), id="v2", ), ] @pytest.mark.parametrize("model", TO_JSON_NO_ALIASING_PARAMS) def test_to_json_shares_no_mutable_state_with_model( model: ZarrV3ArrayMetadata | ZarrV2ArrayMetadata, ) -> None: """Mutating a document returned by to_json leaves the model unchanged.""" baseline = copy.deepcopy(model.to_json()) mutate_nested_containers(model.to_json()) assert model.to_json() == baseline def test_v3_parser_accepts_bare_string_data_type() -> None: """V3 from_json accepts a bare-string data_type and re-serializes it canonically.""" doc = ZarrV3ArrayMetadata.create_default().to_json() doc["data_type"] = "int32" model = ZarrV3ArrayMetadata.from_json(doc) assert model.data_type == ZarrV3NamedConfig(name="int32", configuration={}) assert model.to_json()["data_type"] == "int32" @pytest.mark.parametrize("name", ["bytes", "ANY string", "urn:example:codec"]) def test_metadata_field_accepts_any_string_name(name: str) -> None: """The structural layer checks the name type, not syntax or registration.""" assert validate_metadata_field_v3({"name": name}) == [] @pytest.mark.parametrize("value", [0, 1, "false", None]) def test_metadata_field_must_understand_must_be_boolean(value: object) -> None: """must_understand is a JSON boolean, not a truthy scalar.""" problems = validate_metadata_field_v3({"name": "x", "must_understand": value}) assert [(problem.loc, problem.kind) for problem in problems] == [ (("must_understand",), "invalid_type") ] def test_metadata_field_rejects_unknown_envelope_member() -> None: """Unknown envelope keys cannot be silently discarded during normalization.""" problems = validate_metadata_field_v3({"name": "x", "typo": 1}) assert [(problem.loc, problem.kind) for problem in problems] == [(("typo",), "invalid_value")] @pytest.mark.parametrize("field", ["codecs", "storage_transformers"]) def test_optional_extension_points_allow_must_understand_false(field: str) -> None: """Codecs and storage transformers may be explicitly ignorable.""" doc: dict[str, object] = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc[field] = ({"name": "optional", "must_understand": False},) assert validate_array_metadata_v3(doc) == [] @pytest.mark.parametrize("field", ["data_type", "chunk_grid", "chunk_key_encoding"]) def test_required_extension_points_reject_must_understand_false(field: str) -> None: """Core extension points needed to locate or decode chunks cannot be ignored.""" doc: dict[str, object] = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc[field] = {"name": "optional", "must_understand": False} assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v3(doc)] == [ ((field, "must_understand"), "invalid_value") ] def test_v3_codecs_cannot_be_empty() -> None: """The core document requires at least one array-to-bytes codec.""" doc: dict[str, object] = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc["codecs"] = () assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v3(doc)] == [ (("codecs",), "invalid_value") ] def test_v2_roundtrip_with_compressor_and_filters() -> None: # Non-None compressor/filters must round-trip; extra assertion on .compressor. """A v2 model with non-None compressor and filters round-trips.""" compressor: ZarrV2CodecMetadata = {"id": "blosc", "clevel": 5} filters: tuple[ZarrV2CodecMetadata, ...] = ({"id": "delta"},) m = ZarrV2ArrayMetadata.create_default(compressor=compressor, filters=filters) restored = ZarrV2ArrayMetadata.from_json(m.to_json()) assert restored == m assert restored.compressor == {"id": "blosc", "clevel": 5} # --- ZarrV2ArrayMetadata.from_json ---------------------------------------- def test_v2_from_json_reconstructs_fields() -> None: """V2 from_json reconstructs the fields from a document.""" doc = ZarrV2ArrayMetadata.create_default(shape=(4,), attributes={"a": 1}, dtype=" None: """V2 from_json reads an absent attributes key as UNSET, distinct from an explicit empty mapping.""" absent = ZarrV2ArrayMetadata.from_json(ZarrV2ArrayMetadata.create_default().to_json()) explicit = ZarrV2ArrayMetadata.from_json( ZarrV2ArrayMetadata.create_default(attributes={}).to_json() ) assert absent.attributes is UNSET assert explicit.attributes == {} assert absent != explicit # --- ZarrV2ArrayMetadata.from_key_value -------------------------------- def test_v2_from_key_value_remerges_zattrs() -> None: """V2 from_key_value re-merges .zattrs back into attributes.""" kv = ZarrV2ArrayMetadata.create_default(attributes={"a": 1}, shape=(10,)).to_key_value() model = ZarrV2ArrayMetadata.from_key_value(kv) assert model.attributes == {"a": 1} assert model.shape == (10,) @pytest.mark.parametrize("extra_key", ["attributes", "vendor_extension"]) def test_v2_from_key_value_rejects_zarray_extra_members(extra_key: str) -> None: """Raw `.zarray` documents reject every non-spec member.""" doc: dict[str, object] = dict(ZarrV2ArrayMetadata.create_default().to_json()) doc.pop("attributes", None) doc[extra_key] = {} with pytest.raises(MetadataValidationError) as exc_info: ZarrV2ArrayMetadata.from_key_value({".zarray": json.dumps(doc).encode()}) assert [(problem.loc, problem.kind) for problem in exc_info.value.problems] == [ ((extra_key,), "invalid_value") ] def test_v2_zattrs_presence_round_trips() -> None: """The .zattrs file's presence is part of the store: an absent file reads as UNSET and emits no .zattrs; an explicit empty file reads as {} and emits .zattrs — the two stores stay distinct through a round-trip.""" explicit_kv = dict(ZarrV2ArrayMetadata.create_default(attributes={}).to_key_value()) assert ".zattrs" in explicit_kv absent_kv = dict(explicit_kv) del absent_kv[".zattrs"] absent = ZarrV2ArrayMetadata.from_key_value(absent_kv) explicit = ZarrV2ArrayMetadata.from_key_value(explicit_kv) assert absent.attributes is UNSET assert explicit.attributes == {} assert ".zattrs" not in absent.to_key_value() assert ".zattrs" in explicit.to_key_value() def test_v2_from_json_nested_arrays_in_attributes_become_tuples() -> None: """V2 from_json converts nested arrays in attributes into tuples.""" doc = ZarrV2ArrayMetadata.create_default(attributes={"axes": [[0, 1], [2, 3]]}).to_json() model = ZarrV2ArrayMetadata.from_json(doc) assert model.attributes == {"axes": ((0, 1), (2, 3))} # --- scalar wire-type guards (is_/validate_/parse_) ------------------------ # # Each value is modelled once as Expect[object, frozenset[tuple[str | int, ...]]] # where `output` is the set of expected problem locs validate_* must report — # frozenset() means VALID. Valid iff output == frozenset(). JSON_VALIDATE_CASES: list[Expect[object, frozenset[tuple[str | int, ...]]]] = [ Expect("s", frozenset(), id="str"), Expect(1, frozenset(), id="int"), Expect(1.5, frozenset(), id="float"), Expect(True, frozenset(), id="bool"), Expect(None, frozenset(), id="none"), Expect({"a": [1, {"b": None}], "c": "x"}, frozenset(), id="nested-containers"), Expect((1, 2, 3), frozenset(), id="tuple-array"), Expect(float("nan"), frozenset({()}), id="nan"), Expect(float("inf"), frozenset({()}), id="inf"), Expect(float("-inf"), frozenset({()}), id="negative-inf"), Expect(object(), frozenset({()}), id="object"), Expect(b"abc", frozenset({()}), id="bytes"), Expect(bytearray(b"abc"), frozenset({()}), id="bytearray"), Expect({1: "x"}, frozenset({()}), id="non-str-key"), Expect([1, object()], frozenset({(1,)}), id="non-json-list-item"), Expect({"ok": object()}, frozenset({("ok",)}), id="non-json-value"), ] @pytest.mark.parametrize("case", JSON_VALIDATE_CASES, ids=lambda c: c.id) def test_is_json(case: Expect[object, frozenset[tuple[str | int, ...]]]) -> None: """is_json reports whether a value is JSON-serializable.""" assert is_json(case.input) is (case.output == frozenset()) @pytest.mark.parametrize("case", JSON_VALIDATE_CASES, ids=lambda c: c.id) def test_validate_json(case: Expect[object, frozenset[tuple[str | int, ...]]]) -> None: """validate_json reports the problems (and their locs) for a value.""" problems = validate_json(case.input) assert (problems == []) is (case.output == frozenset()) assert {p.loc for p in problems} >= case.output @pytest.mark.parametrize("case", JSON_VALIDATE_CASES, ids=lambda c: c.id) def test_parse_json(case: Expect[object, frozenset[tuple[str | int, ...]]]) -> None: """parse_json returns valid JSON values and raises on invalid ones.""" if case.output == frozenset(): parsed = parse_json(case.input) assert arrays_to_tuples(parsed) == arrays_to_tuples(case.input) else: with pytest.raises(MetadataValidationError): parse_json(case.input) def test_parse_json_materializes_abstract_containers() -> None: """Accepted Mapping and Sequence values normalize to JSON encoder containers.""" value = UserDict({"values": range(3)}) parsed = parse_json(value) assert parsed == {"values": (0, 1, 2)} assert type(parsed) is dict assert type(parsed["values"]) is tuple json.dumps(parsed, allow_nan=False) def test_json_type_guard_rejects_abstract_sequence() -> None: """A guard cannot narrow an abstract sequence that only the parser materializes.""" assert not is_json(range(3)) assert parse_json(range(3)) == (0, 1, 2) def test_parse_metadata_field_materializes_abstract_containers() -> None: """Named-config parsing produces canonical containers at every nesting level.""" value = UserDict({"name": "example", "configuration": UserDict({"values": range(2)})}) parsed = parse_metadata_field_v3(value) assert isinstance(parsed, dict) assert parsed == {"name": "example", "configuration": {"values": (0, 1)}} assert type(parsed["configuration"]) is dict def test_metadata_field_type_guard_rejects_abstract_mapping() -> None: """A metadata-field guard only narrows concrete TypedDict-shaped objects.""" value = UserDict({"name": "bytes"}) assert not is_metadata_field_v3(value) assert parse_metadata_field_v3(value) == {"name": "bytes"} def test_validate_json_reports_json_in_message() -> None: """validate_json's message for a non-JSON value mentions JSON.""" problems = validate_json(object()) assert problems[0].loc == () assert "JSON" in problems[0].message METADATA_FIELD_VALIDATE_CASES: list[Expect[object, frozenset[tuple[str | int, ...]]]] = [ Expect("bytes", frozenset(), id="bare-string"), Expect({"name": "x", "configuration": {"a": 1}}, frozenset(), id="named-config"), Expect({"name": "bytes"}, frozenset(), id="name-only"), Expect(5, frozenset({()}), id="not-str-or-mapping"), Expect({"configuration": {}}, frozenset({("name",)}), id="missing-name"), Expect({"name": 3}, frozenset({("name",)}), id="non-str-name"), Expect( {"name": "x", "configuration": [1]}, frozenset({("configuration",)}), id="config-not-mapping", ), Expect( {"name": "x", "configuration": {1: "y"}}, frozenset({("configuration",)}), id="config-non-str-key", ), ] @pytest.mark.parametrize("case", METADATA_FIELD_VALIDATE_CASES, ids=lambda c: c.id) def test_is_metadata_field_v3(case: Expect[object, frozenset[tuple[str | int, ...]]]) -> None: """is_metadata_field_v3 reports whether a value is a v3 metadata field.""" assert is_metadata_field_v3(case.input) is (case.output == frozenset()) @pytest.mark.parametrize("case", METADATA_FIELD_VALIDATE_CASES, ids=lambda c: c.id) def test_validate_metadata_field_v3( case: Expect[object, frozenset[tuple[str | int, ...]]], ) -> None: """validate_metadata_field_v3 reports the problems for a metadata-field value.""" problems = validate_metadata_field_v3(case.input) assert (problems == []) is (case.output == frozenset()) assert {p.loc for p in problems} >= case.output @pytest.mark.parametrize("case", METADATA_FIELD_VALIDATE_CASES, ids=lambda c: c.id) def test_parse_metadata_field_v3( case: Expect[object, frozenset[tuple[str | int, ...]]], ) -> None: """parse_metadata_field_v3 returns valid fields and raises on invalid ones.""" if case.output == frozenset(): assert parse_metadata_field_v3(case.input) is case.input else: with pytest.raises(MetadataValidationError): parse_metadata_field_v3(case.input) # --- array-document wire-type guards (is_/validate_/parse_) ---------------- # # Each case starts from a valid document (built by `make`) and applies a # mutation. `expected_locs` are loc paths `validate_*` must report for the # invalid cases (a subset check, so accumulation of OTHER problems is allowed). def _build_v3(**overrides: Unpack[ZarrV3ArrayMetadataPartial]) -> dict[str, object]: return dict(ZarrV3ArrayMetadata.create_default(**overrides).to_json()) def _build_v2(**overrides: Unpack[ZarrV2ArrayMetadataPartial]) -> dict[str, object]: return dict(ZarrV2ArrayMetadata.create_default(**overrides).to_json()) def _mutate(build: Callable[[], dict], mutate: Callable[[dict], object]) -> Callable[[], dict]: def _factory() -> dict: doc = build() mutate(doc) return doc return _factory def _del(key: str) -> Callable[[dict], object]: return lambda doc: doc.pop(key) def _set(key: str, value: object) -> Callable[[dict], object]: return lambda doc: doc.__setitem__(key, value) V3_DOC_CASES: list[Expect[Callable[[], object], frozenset[tuple[str | int, ...]]]] = [ Expect(_build_v3, frozenset(), id="valid"), Expect( lambda: _build_v3(shape=(10,), attributes={"a": 1}, dimension_names=("x",)), frozenset(), id="valid-with-attributes-and-dim-names", ), Expect( lambda: _build_v3(extra_fields={"my_ext": {"must_understand": False}}), frozenset(), id="valid-with-extra-fields", ), Expect(_mutate(_build_v3, _del("shape")), frozenset({("shape",)}), id="missing-shape"), Expect( _mutate(_build_v3, _set("data_type", 5)), frozenset({("data_type",)}), id="bad-data-type", ), Expect( _mutate(_build_v3, _set("shape", "not-a-shape")), frozenset({("shape",)}), id="shape-not-sequence", ), Expect( _mutate(_build_v3, _set("shape", [1, "x"])), frozenset({("shape",)}), id="shape-non-int-item", ), Expect( _mutate(_build_v3, _set("codecs", (5,))), frozenset({("codecs", 0)}), id="bad-codec-entry", ), Expect(lambda: [1, 2, 3], frozenset({()}), id="non-mapping-list"), Expect(lambda: "nope", frozenset({()}), id="non-mapping-str"), Expect( _mutate(_mutate(_build_v3, _del("shape")), _set("data_type", 5)), frozenset({("shape",), ("data_type",)}), id="missing-shape-and-bad-data-type", ), ] V2_DOC_CASES: list[Expect[Callable[[], object], frozenset[tuple[str | int, ...]]]] = [ Expect(_build_v2, frozenset(), id="valid"), Expect(lambda: _build_v2(attributes={"a": 1}), frozenset(), id="valid-with-attributes"), Expect( lambda: _build_v2(compressor=None, filters=None), frozenset(), id="valid-none-compressor-filters", ), Expect( _mutate(_build_v2, _del("chunks")), frozenset({("chunks",)}), id="missing-chunks", ), Expect( _mutate(_build_v2, _set("shape", [1, "x"])), frozenset({("shape",)}), id="bad-shape", ), Expect( _mutate(_mutate(_build_v2, _del("chunks")), _set("shape", [1, "x"])), frozenset({("chunks",), ("shape",)}), id="missing-chunks-and-bad-shape", ), ] ALL_DOC_CASES = [ *( pytest.param( is_array_metadata_v3, validate_array_metadata_v3, parse_array_metadata_v3, c, id=f"v3-{c.id}", ) for c in V3_DOC_CASES ), *( pytest.param( is_array_metadata_v2, validate_array_metadata_v2, parse_array_metadata_v2, c, id=f"v2-{c.id}", ) for c in V2_DOC_CASES ), ] @pytest.mark.parametrize(("is_fn", "validate_fn", "parse_fn", "case"), ALL_DOC_CASES) def test_array_metadata_guards( is_fn: Callable[[object], bool], validate_fn: Callable[[object], list[ValidationProblem]], parse_fn: Callable[[object], object], case: Expect[Callable[[], object], frozenset[tuple[str | int, ...]]], ) -> None: """is_/validate_/parse_ array-metadata guards agree on validity and locs for each case.""" doc = case.input() valid = case.output == frozenset() assert is_fn(doc) is valid problems = validate_fn(doc) assert (problems == []) is valid assert {p.loc for p in problems} >= case.output if valid: assert parse_fn(doc) is doc else: with pytest.raises(MetadataValidationError): parse_fn(doc) # --- strict from_json validation ------------------------------------------- FROM_JSON_REJECT_PARAMS = [ pytest.param( ZarrV3ArrayMetadata, ExpectFail(lambda: {"zarr_format": 3}, MetadataValidationError, id="x"), id="v3-missing-required", ), pytest.param( ZarrV3ArrayMetadata, ExpectFail(_mutate(_build_v3, _set("data_type", 5)), MetadataValidationError, id="x"), id="v3-bad-field-type", ), pytest.param( ZarrV2ArrayMetadata, ExpectFail(lambda: {"zarr_format": 2}, MetadataValidationError, id="x"), id="v2-missing-required", ), pytest.param( ZarrV3NamedConfig, ExpectFail(lambda: 5, MetadataValidationError, id="x"), id="zarr-metadata-bad-input", ), ] @pytest.mark.parametrize(("model", "case"), FROM_JSON_REJECT_PARAMS) def test_from_json_rejects_malformed( model: type[ZarrV3ArrayMetadata | ZarrV2ArrayMetadata | ZarrV3NamedConfig], case: ExpectFail[Callable[[], object]], ) -> None: """from_json raises MetadataValidationError on a malformed document.""" with case.raises(): model.from_json(case.input()) # --- ValidationProblem / MetadataValidationError / _prefix ----------------- # Small structural tests — not "parametrize over inputs" shaped, kept direct. def test_validation_problem_str_with_loc() -> None: """ValidationProblem.__str__ renders a non-empty loc as a dotted path.""" p = ValidationProblem(loc=("codecs", 0, "name"), message="expected str", kind="invalid_type") assert str(p) == "codecs.0.name: expected str" def test_validation_problem_str_empty_loc() -> None: """ValidationProblem.__str__ renders an empty loc as .""" p = ValidationProblem(loc=(), message="not a mapping", kind="invalid_type") assert str(p) == ": not a mapping" def test_validation_problem_is_frozen() -> None: """ValidationProblem is immutable (frozen dataclass).""" p = ValidationProblem(loc=("shape",), message="x", kind="invalid_type") with pytest.raises(dataclasses.FrozenInstanceError): # setattr: assigning to a frozen field is an intentional runtime error, # spelled dynamically so it is not also a static type error. setattr(p, "message", "y") # noqa: B010 def test_metadata_validation_error_holds_problems() -> None: """MetadataValidationError carries its problem list and renders them in its message.""" problems = [ ValidationProblem(loc=("shape",), message="missing required key", kind="missing_key"), ValidationProblem( loc=("data_type",), message="expected a metadata field", kind="invalid_type" ), ] err = MetadataValidationError(problems) assert err.problems == problems assert "shape: missing required key" in str(err) assert "data_type: expected a metadata field" in str(err) def test_prefix_prepends_loc_head() -> None: """_prefix prepends a loc head to each problem's loc.""" problems = [ValidationProblem(loc=("name",), message="expected str", kind="invalid_type")] prefixed = _prefix(0, problems) assert prefixed == [ ValidationProblem(loc=(0, "name"), message="expected str", kind="invalid_type") ] # --- Stricter v2/v3 field validation and error kinds ------------------------- def test_v2_dtype_must_be_string_or_records() -> None: """A non-string, non-records v2 dtype is rejected with an invalid_type problem.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"dtype": 42} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("dtype",), "invalid_type")] def test_v2_structured_dtype_records_accepted() -> None: """A structured v2 dtype (field records, optionally nested/shaped) validates.""" dtype = (("a", " None: """A field record with the wrong arity is rejected.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"dtype": (("a",),)} problems = validate_array_metadata_v2(doc) assert [p.loc for p in problems] == [("dtype",)] def test_v2_order_literal_enforced() -> None: """An order other than 'C' or 'F' is rejected with an invalid_value problem.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"order": "Q"} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("order",), "invalid_value")] def test_v2_compressor_must_be_codec_or_none() -> None: """A compressor that is not null or a codec config mapping is rejected.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"compressor": "zlib"} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("compressor",), "invalid_type")] def test_v2_compressor_requires_string_id() -> None: """A compressor mapping without a string id is rejected.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"compressor": {"level": 3}} problems = validate_array_metadata_v2(doc) assert [p.loc for p in problems] == [("compressor",)] def test_v2_filters_must_be_codec_sequence_or_none() -> None: """Filters that are not null or a sequence of codec configs are rejected.""" for bad in (7, (5,), "gzip"): doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"filters": bad} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("filters",), "invalid_type")], bad def test_v2_shape_and_chunks_must_have_equal_rank() -> None: """Raw v2 metadata requires one chunk length per array dimension.""" doc = dict(ZarrV2ArrayMetadata.create_default(shape=(2, 3)).to_json()) doc["chunks"] = (1,) assert [(p.loc, p.kind) for p in validate_array_metadata_v2(doc)] == [ (("chunks",), "invalid_value") ] with pytest.raises(MetadataValidationError, match="same number of dimensions"): ZarrV2ArrayMetadata.from_key_value({".zarray": json.dumps(doc).encode()}) def test_v2_filters_must_be_nonempty_when_present() -> None: """A non-null v2 filter sequence contains one or more codec configurations.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) doc["filters"] = () assert [(p.loc, p.kind) for p in validate_array_metadata_v2(doc)] == [ (("filters",), "invalid_value") ] with pytest.raises(MetadataValidationError, match="at least one filter"): ZarrV2ArrayMetadata.from_key_value({".zarray": json.dumps(doc).encode()}) def test_v2_dimension_separator_literal_enforced() -> None: """A dimension_separator other than '.' or '/' is rejected.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"dimension_separator": "-"} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("dimension_separator",), "invalid_value")] def test_v2_zarr_format_literal_enforced() -> None: """A v2 document claiming zarr_format 3 is rejected with an invalid_value problem.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"zarr_format": 3} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("zarr_format",), "invalid_value")] def test_v3_zarr_format_literal_enforced() -> None: """A v3 document claiming zarr_format 2 is rejected with an invalid_value problem.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"zarr_format": 2} problems = validate_array_metadata_v3(doc) assert [(p.loc, p.kind) for p in problems] == [(("zarr_format",), "invalid_value")] @pytest.mark.parametrize( ("document", "validate"), [ pytest.param( dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"zarr_format": 2.0}, validate_array_metadata_v2, id="v2", ), pytest.param( dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"zarr_format": 3.0}, validate_array_metadata_v3, id="v3", ), ], ) def test_array_zarr_format_rejects_float( document: object, validate: Callable[[object], list[ValidationProblem]] ) -> None: """Integer-valued floats do not satisfy integer format literals.""" assert [(p.loc, p.kind) for p in validate(document)] == [(("zarr_format",), "invalid_value")] def test_array_v2_rejects_unknown_document_member() -> None: """The closed v2 merged-document shape rejects undeclared members.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"unexpected": 1} assert [(p.loc, p.kind) for p in validate_array_metadata_v2(doc)] == [ (("unexpected",), "invalid_value") ] def test_array_v3_from_json_materializes_abstract_containers() -> None: """A flexible input mapping becomes the canonical dict/tuple model shape.""" doc = UserDict(dict(ZarrV3ArrayMetadata.create_default(shape=(2,)).to_json())) doc["shape"] = range(2) model = ZarrV3ArrayMetadata.from_json(doc) assert model.shape == (0, 1) assert type(model.shape) is tuple def test_from_key_value_rejects_non_standard_json_constant() -> None: """Store JSON decoding rejects JavaScript NaN/Infinity constants.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc["fill_value"] = float("nan") raw = json.dumps(doc) with pytest.raises(MetadataValidationError, match="invalid JSON"): ZarrV3ArrayMetadata.from_key_value({"zarr.json": raw.encode()}) def test_to_key_value_rejects_non_finite_model_value() -> None: """Strict encoding prevents directly-constructed models from writing invalid JSON.""" model = ZarrV3ArrayMetadata.create_default(fill_value=float("nan")) with pytest.raises(ValueError, match="JSON compliant"): model.to_key_value() def test_v3_node_type_literal_enforced() -> None: """A v3 array document claiming node_type 'group' is rejected.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"node_type": "group"} problems = validate_array_metadata_v3(doc) assert [(p.loc, p.kind) for p in problems] == [(("node_type",), "invalid_value")] def test_missing_key_kind_is_machine_readable() -> None: """A missing required key is distinguishable by kind, without message matching.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) del doc["chunk_key_encoding"] problems = validate_array_metadata_v3(doc) assert problems == [ ValidationProblem(("chunk_key_encoding",), "missing required key", "missing_key") ] # --- Unified error channels --------------------------------------------------- def test_from_key_value_invalid_json_raises_metadata_error() -> None: """Undecodable store bytes raise MetadataValidationError (kind invalid_json), not JSONDecodeError.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV3ArrayMetadata.from_key_value({"zarr.json": b"{not json"}) assert [p.kind for p in exc_info.value.problems] == ["invalid_json"] def test_from_key_value_invalid_utf8_raises_metadata_error() -> None: """Invalid UTF-8 store bytes use the same invalid_json error channel.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV3ArrayMetadata.from_key_value({"zarr.json": b"\x80"}) assert [p.kind for p in exc_info.value.problems] == ["invalid_json"] def test_v2_from_key_value_scalar_root_raises_metadata_error() -> None: """A scalar .zarray document fails through the unified metadata error channel.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV2ArrayMetadata.from_key_value({".zarray": b"null"}) assert [(problem.loc, problem.kind) for problem in exc_info.value.problems] == [ ((), "invalid_type") ] def test_from_key_value_missing_key_kind() -> None: """A missing store key surfaces as a missing_key problem at the store-key loc.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV2ArrayMetadata.from_key_value({}) assert exc_info.value.problems == [ ValidationProblem((".zarray",), "missing store key", "missing_key") ] def test_extra_fields_overlap_raises_metadata_error() -> None: """The extra-fields overlap invariant raises MetadataValidationError (a ValueError).""" with pytest.raises(MetadataValidationError, match="Extra fields") as exc_info: ZarrV3ArrayMetadata.create_default(extra_fields={"shape": {"must_understand": False}}) assert [p.kind for p in exc_info.value.problems] == ["invalid_value"] def test_extension_point_fields_annotated_with_role_alias() -> None: """Extension-point fields are annotated with ZarrV3MetadataField (the logical role), not ZarrV3NamedConfig (the current serialized form), so a future widening of the field union does not move annotation sites.""" assert ZarrV3MetadataField is ZarrV3NamedConfig annotations = ZarrV3ArrayMetadata.__annotations__ for field_name in ("data_type", "chunk_grid", "chunk_key_encoding"): assert annotations[field_name] == "ZarrV3MetadataField" for field_name in ("codecs", "storage_transformers"): assert annotations[field_name] == "tuple[ZarrV3MetadataField, ...]" # --- Adversarial-probe fixes: documents that used to pass validation --------- def test_shape_rejects_json_booleans() -> None: """JSON booleans are not integers: shape/chunks containing true/false are rejected (bool is an int subclass in Python, so isinstance alone passes).""" v3 = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"shape": (True, True)} assert [p.loc for p in validate_array_metadata_v3(v3)] == [("shape",)] v2 = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"chunks": (True,)} assert [p.loc for p in validate_array_metadata_v2(v2)] == [("chunks",)] def test_shape_rejects_negative_dimensions() -> None: """Dimension lengths must be non-negative; a negative entry is invalid_value.""" v3 = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"shape": (-1,)} assert [(p.loc, p.kind) for p in validate_array_metadata_v3(v3)] == [ (("shape",), "invalid_value") ] v2 = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"chunks": (-5,)} assert [(p.loc, p.kind) for p in validate_array_metadata_v2(v2)] == [ (("chunks",), "invalid_value") ] def test_dimension_names_length_must_match_shape() -> None: """dimension_names must have one entry per dimension of shape.""" doc = dict(ZarrV3ArrayMetadata.create_default(shape=(10,)).to_json()) | { "dimension_names": ("x", "y", "z") } assert [(p.loc, p.kind) for p in validate_array_metadata_v3(doc)] == [ (("dimension_names",), "invalid_value") ] def test_attributes_values_must_be_json() -> None: """Attribute values are JSON-checked recursively (like fill_value), so a non-serializable value is a validation problem, not a later TypeError.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"attributes": {"a": {1, 2}}} problems = validate_array_metadata_v3(doc) assert [(p.loc, p.kind) for p in problems] == [(("attributes", "a"), "invalid_type")] def test_configuration_values_must_be_json() -> None: """Configuration values are JSON-checked recursively, so an int-keyed dict cannot pass validation and be silently rewritten by json.dumps.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) | { "chunk_grid": {"name": "regular", "configuration": {"chunk_shape": {1: 2}}} } problems = validate_array_metadata_v3(doc) assert [(p.loc, p.kind) for p in problems] == [ (("chunk_grid", "configuration", "chunk_shape"), "invalid_type") ] def test_v3_extension_keys_must_be_strings() -> None: """A non-string top-level key cannot be represented by a v3 document type.""" doc: dict[object, object] = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc[1] = {"must_understand": False} assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v3(doc)] == [ ((), "invalid_type") ] def test_v3_extension_values_must_be_json() -> None: """Extension payloads are JSON-checked before a model is constructed.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc["ext"] = {"must_understand": False, "payload": object()} assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v3(doc)] == [ (("ext", "payload"), "invalid_type") ] def test_v3_json_extension_without_waiver_is_preserved_as_must_understand() -> None: """A JSON extension without an explicit false waiver remains must-understand.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) doc["ext"] = 1 parsed = parse_array_metadata_v3(doc) assert is_array_metadata_v3(parsed) model = ZarrV3ArrayMetadata.from_json(doc) assert model.extra_fields["ext"] == 1 assert model.must_understand_fields == {"ext": 1} def test_v2_codec_configuration_values_must_be_json() -> None: """Non-JSON codec parameters are rejected for compressors and filters.""" for field, value, expected_loc in ( ("compressor", {"id": "x", "payload": object()}, ("compressor", "payload")), ("filters", ({"id": "x", "payload": object()},), ("filters", 0, "payload")), ): doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) doc[field] = value assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v2(doc)] == [ (expected_loc, "invalid_type") ] def test_dimension_sequences_reject_binary_values() -> None: """Binary buffers are not JSON arrays even though they are integer sequences.""" v3 = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"shape": b"\x02"} v2 = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"chunks": b"\x02"} assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v3(v3)] == [ (("shape",), "invalid_type") ] assert [(problem.loc, problem.kind) for problem in validate_array_metadata_v2(v2)] == [ (("chunks",), "invalid_type") ] def test_array_parsers_normalize_json_lists_before_narrowing() -> None: """Parsers return tuple-backed document types while guards reject raw list forms.""" v3_raw = json.loads(json.dumps(ZarrV3ArrayMetadata.create_default(shape=(2,)).to_json())) v2_raw = json.loads(json.dumps(ZarrV2ArrayMetadata.create_default(shape=(2,)).to_json())) assert validate_array_metadata_v3(v3_raw) == [] assert validate_array_metadata_v2(v2_raw) == [] assert not is_array_metadata_v3(v3_raw) assert not is_array_metadata_v2(v2_raw) v3_parsed = parse_array_metadata_v3(v3_raw) v2_parsed = parse_array_metadata_v2(v2_raw) assert isinstance(v3_parsed["shape"], tuple) assert isinstance(v3_parsed["codecs"], tuple) assert isinstance(v2_parsed["shape"], tuple) assert isinstance(v2_parsed["chunks"], tuple) def test_array_guards_reject_noncanonical_nested_json() -> None: """Document guards cannot narrow values that only parsers can materialize.""" v3 = dict(ZarrV3ArrayMetadata.create_default().to_json()) v3["fill_value"] = range(2) v2 = dict(ZarrV2ArrayMetadata.create_default().to_json()) v2["fill_value"] = range(2) assert not is_array_metadata_v3(v3) assert not is_array_metadata_v2(v2) assert parse_array_metadata_v3(v3)["fill_value"] == (0, 1) assert parse_array_metadata_v2(v2)["fill_value"] == (0, 1) # --- must_understand partition (spec: MUST fail to open unrecognized fields) -- def test_must_understand_fields_partition() -> None: """must_understand_fields contains every extra field not explicitly waived with must_understand: false, including implicitly-true and non-mapping fields, so a reader can discharge the spec's fail-to-open duty by subtracting the extensions it recognizes.""" model = ZarrV3ArrayMetadata.create_default( extra_fields={ "ext_a": {"name": "a", "must_understand": False}, "ext_b": {"name": "b"}, "ext_c": {"name": "c", "must_understand": True}, "ext_d": 123, } ) assert set(model.must_understand_fields) == {"ext_b", "ext_c", "ext_d"} recognized = {"ext_b"} assert model.must_understand_fields.keys() - recognized == {"ext_c", "ext_d"} def test_must_understand_fields_empty_when_all_waived() -> None: """must_understand_fields is empty when every extra field is explicitly waived.""" model = ZarrV3ArrayMetadata.create_default( extra_fields={"ext_a": {"name": "a", "must_understand": False}} ) assert model.must_understand_fields == {} def test_dimension_names_null_field_rejected() -> None: """A dimension_names field whose VALUE is null is invalid: the spec permits null as an element (an unnamed dimension), never as the field value — "not specified" is spelled by omitting the key. Consumers bridging from an in-memory None sentinel must drop the key, not write null.""" doc = dict(ZarrV3ArrayMetadata.create_default().to_json()) | {"dimension_names": None} problems = validate_array_metadata_v3(doc) assert [(p.loc, p.kind) for p in problems] == [(("dimension_names",), "invalid_type")] # and the model's own None spelling correctly maps to key absence assert ( "dimension_names" not in ZarrV3ArrayMetadata.create_default(dimension_names=UNSET).to_json() ) # --- create_default derives the chunk grid from shape ------------------------ def test_v3_create_default_chunk_grid_follows_shape() -> None: """Overriding shape without chunk_grid derives a consistent default grid: one chunk covering the array (chunk_shape == shape), instead of silently keeping the scalar default's 0-d grid.""" model = ZarrV3ArrayMetadata.create_default(shape=(100, 100)) assert model.chunk_grid == ZarrV3NamedConfig( name="regular", configuration={"chunk_shape": (100, 100)} ) def test_v3_create_default_explicit_chunk_grid_respected() -> None: """An explicit chunk_grid override wins over the shape-derived default.""" grid = ZarrV3NamedConfig(name="regular", configuration={"chunk_shape": (10, 10)}) model = ZarrV3ArrayMetadata.create_default(shape=(100, 100), chunk_grid=grid) assert model.chunk_grid == grid def test_v2_create_default_chunks_follow_shape() -> None: """Overriding shape without chunks derives chunks == shape.""" model = ZarrV2ArrayMetadata.create_default(shape=(100, 100)) assert model.chunks == (100, 100) def test_v2_create_default_explicit_chunks_respected() -> None: """An explicit chunks override wins over the shape-derived default.""" model = ZarrV2ArrayMetadata.create_default(shape=(100, 100), chunks=(10, 10)) assert model.chunks == (10, 10) def test_v3_create_default_zero_length_dimensions() -> None: """chunk_shape == shape is spec-sound even with zero-length dimensions: 'The chunk shape elements are non-zero when the corresponding dimensions of the arrays have non-zero length' — the constraint is conditional, so a zero chunk length is permitted exactly where the dimension is empty.""" model = ZarrV3ArrayMetadata.create_default(shape=(0, 3)) assert model.chunk_grid.configuration["chunk_shape"] == (0, 3) def test_create_default_derivation_is_one_way() -> None: """Overriding the chunk grid (v3) or chunks (v2) without shape leaves the scalar default shape=() untouched: a user-supplied chunk_grid is an extension point taken verbatim, and deriving shape from it would require interpreting grid configurations, which the model layer never does.""" grid = ZarrV3NamedConfig(name="regular", configuration={"chunk_shape": (10, 10)}) v3 = ZarrV3ArrayMetadata.create_default(chunk_grid=grid) assert v3.shape == () assert v3.chunk_grid == grid v2 = ZarrV2ArrayMetadata.create_default(chunks=(10, 10)) assert v2.shape == () assert v2.chunks == (10, 10) # --- v2 dimension_separator default (roborev job 426) ------------------------- def test_v2_absent_dimension_separator_means_dot() -> None: """A .zarray that omits dimension_separator uses the v2 convention default '.', not '/': chunk keys of real-world default-separator v2 arrays look like '0.0'. The model normalizes the absent key to an explicit '.' — a semantics-preserving spelling normalization.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) del doc["dimension_separator"] model = ZarrV2ArrayMetadata.from_json(doc) assert model.dimension_separator == "." assert model.to_json()["dimension_separator"] == "." def test_v2_from_key_value_without_separator_means_dot() -> None: """The .zarray store-file path applies the same '.' default for an absent dimension_separator key.""" doc = { k: v for k, v in ZarrV2ArrayMetadata.create_default().to_json().items() if k not in ("dimension_separator", "attributes") } import json as _json model = ZarrV2ArrayMetadata.from_key_value({".zarray": _json.dumps(doc).encode()}) assert model.dimension_separator == "." def test_v2_null_dimension_separator_rejected() -> None: """dimension_separator may be absent, '.', or '/' — never null: the document grammar has no null spelling for this field.""" doc = dict(ZarrV2ArrayMetadata.create_default().to_json()) | {"dimension_separator": None} problems = validate_array_metadata_v2(doc) assert [(p.loc, p.kind) for p in problems] == [(("dimension_separator",), "invalid_value")] def test_dimension_names_absent_and_all_null_are_distinct() -> None: """An absent dimension_names field and an explicit all-null one are semantically different documents: the explicit form says every dimension has a name, which is null; absence says there are no dimension names. The model preserves the distinction (UNSET vs a tuple of Nones), and both spellings round-trip faithfully.""" absent_doc = dict(ZarrV3ArrayMetadata.create_default(shape=(2, 3)).to_json()) explicit_doc = absent_doc | {"dimension_names": (None, None)} absent = ZarrV3ArrayMetadata.from_json(absent_doc) explicit = ZarrV3ArrayMetadata.from_json(explicit_doc) assert absent.dimension_names is UNSET assert explicit.dimension_names == (None, None) assert absent != explicit assert "dimension_names" not in absent.to_json() assert absent.to_json() == absent_doc assert explicit.to_json() == explicit_doc zarr-python-3.3.0/packages/zarr-metadata/tests/model/test_group.py000066400000000000000000000526301523267620000253440ustar00rootroot00000000000000"""Tests for the group and consolidated metadata models in `zarr_metadata.model`.""" import copy import dataclasses import json from collections import UserDict from collections.abc import Callable import pytest from tests.model._cases import mutate_nested_containers from zarr_metadata.model import UNSET from zarr_metadata.model._array import ZarrV3ArrayMetadata from zarr_metadata.model._group import ( ZarrV2ConsolidatedMetadata, ZarrV2GroupMetadata, ZarrV2GroupMetadataPartial, ZarrV3ConsolidatedMetadata, ZarrV3GroupMetadata, ZarrV3GroupMetadataPartial, ) from zarr_metadata.model._validation import ( MetadataValidationError, ValidationProblem, is_group_metadata_v2, is_group_metadata_v3, parse_group_metadata_v2, parse_group_metadata_v3, validate_group_metadata_v2, validate_group_metadata_v3, ) # --- ZarrV3GroupMetadata --------------------------------------------------- def test_group_v3_roundtrip() -> None: """A v3 group document round-trips through the model unchanged.""" doc = {"zarr_format": 3, "node_type": "group", "attributes": {"a": (1, 2)}} model = ZarrV3GroupMetadata.from_json(doc) assert model.to_json() == doc def test_group_v3_omits_empty_attributes() -> None: """to_json omits the attributes key when attributes is empty.""" model = ZarrV3GroupMetadata.create_default() assert "attributes" not in model.to_json() def test_group_v3_lists_become_tuples() -> None: """from_json converts JSON arrays in attributes to tuples.""" doc = {"zarr_format": 3, "node_type": "group", "attributes": {"a": [1, 2]}} model = ZarrV3GroupMetadata.from_json(doc) assert model.attributes == {"a": (1, 2)} def test_group_v3_extra_fields_roundtrip() -> None: """Unknown top-level keys land in extra_fields and reappear in to_json.""" doc = { "zarr_format": 3, "node_type": "group", "my_extension": {"name": "thing", "must_understand": False}, } model = ZarrV3GroupMetadata.from_json(doc) assert model.extra_fields == {"my_extension": {"name": "thing", "must_understand": False}} assert model.to_json() == doc def test_group_v3_json_extra_field_roundtrips_as_must_understand() -> None: """A non-object extra field is preserved and implicitly requires understanding.""" doc = {"zarr_format": 3, "node_type": "group", "ext": [1, 2]} model = ZarrV3GroupMetadata.from_json(doc) assert model.to_json()["ext"] == (1, 2) assert model.must_understand_fields == {"ext": (1, 2)} def test_group_v3_extra_fields_overlap_rejected() -> None: """Constructing a v3 group model with extra_fields shadowing a standard key raises.""" with pytest.raises(ValueError, match="Extra fields"): ZarrV3GroupMetadata( attributes={}, consolidated_metadata=UNSET, extra_fields={"node_type": {"name": "x", "must_understand": False}}, ) def test_group_v3_consolidated_extra_field_rejected() -> None: """extra_fields may not shadow the consolidated_metadata convention key.""" with pytest.raises(ValueError, match="Extra fields"): ZarrV3GroupMetadata( attributes={}, consolidated_metadata=UNSET, extra_fields={"consolidated_metadata": {"name": "x", "must_understand": False}}, ) def test_group_v3_missing_required_key() -> None: """parse_group_metadata_v3 reports each missing required key.""" with pytest.raises(MetadataValidationError, match="node_type"): parse_group_metadata_v3({"zarr_format": 3}) def test_group_v3_bad_attributes() -> None: """parse_group_metadata_v3 rejects a non-mapping attributes value.""" with pytest.raises(MetadataValidationError, match="attributes"): parse_group_metadata_v3({"zarr_format": 3, "node_type": "group", "attributes": 5}) @pytest.mark.parametrize( ("document", "validate"), [ pytest.param( {"zarr_format": 2.0}, validate_group_metadata_v2, id="v2", ), pytest.param( {"zarr_format": 3.0, "node_type": "group"}, validate_group_metadata_v3, id="v3", ), ], ) def test_group_zarr_format_rejects_float( document: object, validate: Callable[[object], list[ValidationProblem]] ) -> None: """Integer-valued floats do not satisfy integer format literals.""" assert [(p.loc, p.kind) for p in validate(document)] == [(("zarr_format",), "invalid_value")] def test_group_v2_rejects_unknown_document_member() -> None: """The closed v2 merged-document shape rejects undeclared members.""" assert [(p.loc, p.kind) for p in validate_group_metadata_v2({"zarr_format": 2, "x": 1})] == [ (("x",), "invalid_value") ] @pytest.mark.parametrize( ("parse", "document"), [ pytest.param(parse_group_metadata_v2, {"zarr_format": 2}, id="v2"), pytest.param( parse_group_metadata_v3, {"zarr_format": 3, "node_type": "group"}, id="v3", ), ], ) def test_group_parser_materializes_abstract_mapping( parse: Callable[[object], object], document: dict[str, object] ) -> None: """A successful group parser always returns the declared concrete TypedDict shape.""" parsed = parse(UserDict(document)) assert type(parsed) is dict assert parsed == document def test_group_guards_reject_noncanonical_nested_json() -> None: """Document guards cannot narrow values that only parsers can materialize.""" v3 = {"zarr_format": 3, "node_type": "group", "extension": range(2)} v2 = {"zarr_format": 2, "attributes": {"values": range(2)}} assert not is_group_metadata_v3(v3) assert not is_group_metadata_v2(v2) assert parse_group_metadata_v3(v3)["extension"] == (0, 1) assert parse_group_metadata_v2(v2)["attributes"] == {"values": (0, 1)} def test_group_v3_extension_fields_are_validated() -> None: """Group extension payloads must be JSON values with a must-understand flag.""" doc = { "zarr_format": 3, "node_type": "group", "ext": {"must_understand": False, "payload": object()}, } assert [(problem.loc, problem.kind) for problem in validate_group_metadata_v3(doc)] == [ (("ext", "payload"), "invalid_type") ] def test_group_v3_key_value_roundtrip() -> None: """from_key_value(to_key_value()) is the identity for v3 groups.""" model = ZarrV3GroupMetadata.create_default(attributes={"a": 1}) assert ZarrV3GroupMetadata.from_key_value(model.to_key_value()) == model def test_group_v3_update() -> None: """update replaces the given fields and returns a new instance.""" base = ZarrV3GroupMetadata.create_default() updated = base.update(attributes={"a": 1}) assert updated.attributes == {"a": 1} assert base.attributes == {} # --- ZarrV2GroupMetadata --------------------------------------------------- def test_group_v2_key_value_split() -> None: """v2 to_key_value writes .zgroup and .zattrs; from_key_value merges them.""" model = ZarrV2GroupMetadata.create_default(attributes={"a": 1}) kv = model.to_key_value() assert set(kv) == {".zgroup", ".zattrs"} assert json.loads(kv[".zgroup"]) == {"zarr_format": 2} assert ZarrV2GroupMetadata.from_key_value(kv) == model @pytest.mark.parametrize("extra_key", ["attributes", "vendor_extension"]) def test_v2_group_from_key_value_rejects_zgroup_extra_members(extra_key: str) -> None: """Raw `.zgroup` documents reject every non-spec member.""" doc: dict[str, object] = {"zarr_format": 2, extra_key: {}} with pytest.raises(MetadataValidationError) as exc_info: ZarrV2GroupMetadata.from_key_value({".zgroup": json.dumps(doc).encode()}) assert [(problem.loc, problem.kind) for problem in exc_info.value.problems] == [ ((extra_key,), "invalid_value") ] def test_group_v2_zattrs_presence_round_trips() -> None: """A v2 group with no .zattrs file parses with UNSET attributes and emits no .zattrs; an explicit empty .zattrs stays a file — the stores remain distinct through a round-trip.""" absent = ZarrV2GroupMetadata.from_key_value({".zgroup": b'{"zarr_format": 2}'}) assert absent.attributes is UNSET assert ".zattrs" not in absent.to_key_value() explicit = ZarrV2GroupMetadata.from_key_value( {".zgroup": b'{"zarr_format": 2}', ".zattrs": b"{}"} ) assert explicit.attributes == {} assert ".zattrs" in explicit.to_key_value() assert absent != explicit def test_group_v2_json_roundtrip() -> None: """A merged-form v2 group document round-trips through the model unchanged.""" doc = {"zarr_format": 2, "attributes": {"a": 1}} model = ZarrV2GroupMetadata.from_json(doc) assert model.to_json() == doc def test_group_v2_omits_empty_attributes() -> None: """to_json omits the attributes key when attributes is empty.""" assert "attributes" not in ZarrV2GroupMetadata.create_default().to_json() def test_group_v2_not_a_mapping() -> None: """parse_group_metadata_v2 rejects a non-mapping document.""" with pytest.raises(MetadataValidationError, match="expected a mapping"): parse_group_metadata_v2([1, 2, 3]) def test_group_v2_missing_required_key() -> None: """parse_group_metadata_v2 reports a missing zarr_format key.""" with pytest.raises(MetadataValidationError, match="zarr_format"): parse_group_metadata_v2({}) # --- Partial TypedDict drift guards ----------------------------------------- def test_group_partial_keys_match_settable_model_fields() -> None: """Each group partial TypedDict must list exactly the settable model fields. Guards against drift: adding/removing a settable field on a group model without updating its `*Partial` TypedDict fails here. """ for model_cls, partial_cls in ( (ZarrV3GroupMetadata, ZarrV3GroupMetadataPartial), (ZarrV2GroupMetadata, ZarrV2GroupMetadataPartial), ): settable = {f.name for f in dataclasses.fields(model_cls) if f.init} assert set(partial_cls.__annotations__) == settable # --- ZarrV3ConsolidatedMetadata -------------------------------------------- def test_consolidated_v3_roundtrip() -> None: """A v3 group with inline consolidated metadata round-trips, with child entries parsed into array/group models.""" child = ZarrV3ArrayMetadata.create_default(shape=(2,)).to_json() doc = { "zarr_format": 3, "node_type": "group", "consolidated_metadata": { "kind": "inline", "must_understand": False, "metadata": {"a": child, "g": {"zarr_format": 3, "node_type": "group"}}, }, } model = ZarrV3GroupMetadata.from_json(doc) assert isinstance(model.consolidated_metadata, ZarrV3ConsolidatedMetadata) assert isinstance(model.consolidated_metadata.metadata["a"], ZarrV3ArrayMetadata) assert isinstance(model.consolidated_metadata.metadata["g"], ZarrV3GroupMetadata) assert model.to_json() == doc def test_consolidated_v3_must_understand_true_rejected() -> None: """ZarrV3ConsolidatedMetadata enforces must_understand=False at runtime.""" with pytest.raises(ValueError, match="must_understand"): ZarrV3ConsolidatedMetadata(must_understand=True, metadata={}) def test_consolidated_v3_from_json_must_understand_true_rejected() -> None: """from_json rejects a consolidated document carrying must_understand=true.""" with pytest.raises(MetadataValidationError, match="must_understand"): ZarrV3ConsolidatedMetadata.from_json( {"kind": "inline", "must_understand": True, "metadata": {}} ) def test_consolidated_v3_entry_without_node_type_rejected() -> None: """from_json rejects a consolidated entry lacking a recognizable node_type.""" with pytest.raises(MetadataValidationError, match="node_type"): ZarrV3ConsolidatedMetadata.from_json( {"kind": "inline", "must_understand": False, "metadata": {"a": {"zarr_format": 3}}} ) def test_consolidated_v3_not_a_mapping() -> None: """from_json rejects a non-mapping consolidated document.""" with pytest.raises(MetadataValidationError, match="expected a mapping"): ZarrV3ConsolidatedMetadata.from_json(5) # --- ZarrV2ConsolidatedMetadata -------------------------------------------- def test_consolidated_v2_verbatim_roundtrip() -> None: """The v2 .zmetadata model holds the flat file-keyed map verbatim, including nodes that have no .zattrs entry.""" doc = { "zarr_consolidated_format": 1, "metadata": { ".zgroup": {"zarr_format": 2}, "a/.zarray": { "zarr_format": 2, "shape": (2,), "chunks": (2,), "dtype": "|u1", "fill_value": 0, "order": "C", "compressor": None, "filters": None, }, }, } model = ZarrV2ConsolidatedMetadata.from_json(doc) assert model.to_json() == doc def test_consolidated_v2_key_value_roundtrip() -> None: """from_key_value(to_key_value()) is the identity for .zmetadata documents.""" model = ZarrV2ConsolidatedMetadata.from_json( {"zarr_consolidated_format": 1, "metadata": {".zgroup": {"zarr_format": 2}}} ) assert ZarrV2ConsolidatedMetadata.from_key_value(model.to_key_value()) == model def test_consolidated_v2_lists_become_tuples() -> None: """from_json converts JSON arrays inside entries to tuples.""" doc = { "zarr_consolidated_format": 1, "metadata": {"a/.zarray": {"shape": [2, 3]}}, } model = ZarrV2ConsolidatedMetadata.from_json(doc) assert model.metadata == {"a/.zarray": {"shape": (2, 3)}} def test_consolidated_v2_envelope_validation() -> None: """from_json rejects a .zmetadata document missing the metadata key.""" with pytest.raises(MetadataValidationError, match="metadata"): ZarrV2ConsolidatedMetadata.from_json({"zarr_consolidated_format": 1}) def test_consolidated_v2_not_a_mapping() -> None: """from_json rejects a non-mapping .zmetadata document.""" with pytest.raises(MetadataValidationError, match="expected a mapping"): ZarrV2ConsolidatedMetadata.from_json([1]) def test_consolidated_v2_format_literal_enforced() -> None: """A .zmetadata document must declare consolidated format 1.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV2ConsolidatedMetadata.from_json({"zarr_consolidated_format": 2, "metadata": {}}) assert [(problem.loc, problem.kind) for problem in exc_info.value.problems] == [ (("zarr_consolidated_format",), "invalid_value") ] def test_consolidated_v2_metadata_values_must_be_json() -> None: """Non-JSON values in the flat metadata map are rejected during ingestion.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV2ConsolidatedMetadata.from_json( {"zarr_consolidated_format": 1, "metadata": {".zgroup": object()}} ) assert [(problem.loc, problem.kind) for problem in exc_info.value.problems] == [ (("metadata", ".zgroup"), "invalid_type") ] def test_group_v2_from_key_value_scalar_root_raises_metadata_error() -> None: """A scalar .zgroup document fails through the unified metadata error channel.""" with pytest.raises(MetadataValidationError) as exc_info: ZarrV2GroupMetadata.from_key_value({".zgroup": b"null"}) assert [(problem.loc, problem.kind) for problem in exc_info.value.problems] == [ ((), "invalid_type") ] # --- Literal-value enforcement ----------------------------------------------- def test_group_v3_literals_enforced() -> None: """A v3 group doc with wrong zarr_format or node_type is rejected with invalid_value.""" base = ZarrV3GroupMetadata.create_default().to_json() for key, bad in (("zarr_format", 2), ("node_type", "array")): problems = validate_group_metadata_v3(dict(base) | {key: bad}) assert [(p.loc, p.kind) for p in problems] == [((key,), "invalid_value")], key def test_group_v2_zarr_format_literal_enforced() -> None: """A v2 group doc claiming zarr_format 3 is rejected with invalid_value.""" problems = validate_group_metadata_v2({"zarr_format": 3}) assert [(p.loc, p.kind) for p in problems] == [(("zarr_format",), "invalid_value")] # --- Consolidated envelope validated by the group validator ------------------ def test_group_v3_validator_agrees_with_from_json_on_consolidated() -> None: """The group validator validates the consolidated envelope and entries, so is_group_metadata_v3 never vouches for a document from_json would reject.""" bad_docs = ( # empty envelope: missing kind/must_understand/metadata {"zarr_format": 3, "node_type": "group", "consolidated_metadata": {}}, # entry without a recognizable node_type { "zarr_format": 3, "node_type": "group", "consolidated_metadata": { "kind": "inline", "must_understand": False, "metadata": {"a": {"zarr_format": 3}}, }, }, # must_understand: true { "zarr_format": 3, "node_type": "group", "consolidated_metadata": { "kind": "inline", "must_understand": True, "metadata": {}, }, }, ) for doc in bad_docs: assert validate_group_metadata_v3(doc) != [], doc with pytest.raises(MetadataValidationError): ZarrV3GroupMetadata.from_json(doc) def test_group_v3_valid_consolidated_passes_validator() -> None: """A well-formed consolidated group validates cleanly (control case).""" child = ZarrV3ArrayMetadata.create_default(shape=(2,)).to_json() doc = { "zarr_format": 3, "node_type": "group", "consolidated_metadata": { "kind": "inline", "must_understand": False, "metadata": {"a": child, "g": {"zarr_format": 3, "node_type": "group"}}, }, } assert validate_group_metadata_v3(doc) == [] def test_v3_consolidated_rejects_unknown_envelope_member() -> None: """The inline consolidated envelope is closed and never drops accepted members.""" doc = { "kind": "inline", "must_understand": False, "metadata": {}, "unexpected": 1, } with pytest.raises(MetadataValidationError, match="unexpected"): ZarrV3ConsolidatedMetadata.from_json(doc) def test_v2_consolidated_rejects_unknown_document_member() -> None: """The v2 consolidated document is closed and never drops accepted members.""" doc = {"zarr_consolidated_format": 1, "metadata": {}, "unexpected": 1} with pytest.raises(MetadataValidationError, match="unexpected"): ZarrV2ConsolidatedMetadata.from_json(doc) # --- must_understand partition ------------------------------------------------ def test_group_must_understand_fields_partition() -> None: """The group model partitions extra fields by the spec's implicit-true rule, like the array model.""" model = ZarrV3GroupMetadata.create_default( extra_fields={ "waived": {"name": "w", "must_understand": False}, "implicit": {"name": "i"}, } ) assert set(model.must_understand_fields) == {"implicit"} def test_group_v3_null_consolidated_metadata_repaired_to_absence() -> None: """consolidated_metadata: null was written by a historical zarr-python bug. Those stores must remain readable, but the bug spelling is not honored: it is read as absence (UNSET) and never written back — the round-trip deliberately repairs the document rather than preserving the bug.""" null_doc = {"zarr_format": 3, "node_type": "group", "consolidated_metadata": None} assert validate_group_metadata_v3(null_doc) == [] model = ZarrV3GroupMetadata.from_json(null_doc) assert model.consolidated_metadata is UNSET assert "consolidated_metadata" not in model.to_json() assert model == ZarrV3GroupMetadata.from_json({"zarr_format": 3, "node_type": "group"}) # --- to_json shares no mutable state with the model ------------------------ TO_JSON_NO_ALIASING_PARAMS = [ pytest.param( ZarrV3GroupMetadata.create_default( attributes={"a": {"b": [1]}}, consolidated_metadata=ZarrV3ConsolidatedMetadata( metadata={ "child": ZarrV3ArrayMetadata.create_default(attributes={"x": {"y": 1}}), "grp": ZarrV3GroupMetadata.create_default(attributes={"x": {"y": 1}}), } ), extra_fields={"ext": {"must_understand": False, "cfg": {"x": [1]}}}, ), id="v3-group", ), pytest.param( ZarrV2GroupMetadata.create_default(attributes={"a": {"b": [1]}}), id="v2-group", ), pytest.param( ZarrV3ConsolidatedMetadata( metadata={"child": ZarrV3ArrayMetadata.create_default(attributes={"x": {"y": 1}})} ), id="v3-consolidated", ), pytest.param( ZarrV2ConsolidatedMetadata(metadata={"a/.zarray": {"nested": {"x": [1]}}}), id="v2-consolidated", ), ] @pytest.mark.parametrize("model", TO_JSON_NO_ALIASING_PARAMS) def test_to_json_shares_no_mutable_state_with_model( model: ZarrV3GroupMetadata | ZarrV2GroupMetadata | ZarrV3ConsolidatedMetadata | ZarrV2ConsolidatedMetadata, ) -> None: """Mutating a document returned by to_json leaves the model unchanged.""" baseline = copy.deepcopy(model.to_json()) mutate_nested_containers(model.to_json()) assert model.to_json() == baseline zarr-python-3.3.0/packages/zarr-metadata/tests/model/test_pydantic.py000066400000000000000000000304411523267620000260170ustar00rootroot00000000000000"""Executable example: integrating the metadata models with pydantic (v2). Pydantic's native dataclass introspection CAN be made to work (see `test_native_dataclass_introspection_is_possible_but_diverges`): the models keep their annotation-only imports behind `TYPE_CHECKING`, so a bare `TypeAdapter(ZarrV3ArrayMetadata)` raises `class-not-fully-defined`, but `rebuild(_types_namespace=...)` with the names supplied resolves the schema. It is still the wrong tool: it validates the MODEL SHAPE, not the DOCUMENT — no `from_json` normalization (a bare-string `data_type` is rejected), and pydantic's lax coercion silently re-opens holes the library's validators close (`shape=[True, -5]` coerces to `(1, -5)`; a wrong `dimension_names` count passes). The recommended integration delegates wholesale — treat the model as an opaque value: - `InstanceOf` makes pydantic's core schema an is-instance check (no field introspection), - validation goes through `from_json` (the single source of truth for what a well-formed document is, including normalization: bare-string metadata fields, arrays-to-tuples), - serialization goes through `to_json` (the canonical document form). `MetadataValidationError` subclasses `ValueError`, so pydantic converts a failed parse into its own `ValidationError` with the loc-annotated problem messages intact. """ from collections.abc import Mapping from typing import Annotated, Generic, TypeVar import pytest from pydantic import ( BaseModel, BeforeValidator, ConfigDict, InstanceOf, PlainSerializer, PydanticSchemaGenerationError, PydanticUserError, TypeAdapter, ValidationError, model_validator, ) from zarr_metadata import JSONValue from zarr_metadata.model import ZarrV3ArrayMetadata, ZarrV3NamedConfig # --- the integration (this is the example) ----------------------------------- def _as_array_metadata_v3(value: object) -> ZarrV3ArrayMetadata: """Accept an existing model instance or a raw metadata document.""" if isinstance(value, ZarrV3ArrayMetadata): return value return ZarrV3ArrayMetadata.from_json(value) # return_type is explicit because to_json's own annotation (`ZarrV3ArrayMetadataJSON`) # is a TYPE_CHECKING-only name pydantic cannot resolve at runtime. ArrayMetadataV3Field = Annotated[ InstanceOf[ZarrV3ArrayMetadata], BeforeValidator(_as_array_metadata_v3), PlainSerializer(ZarrV3ArrayMetadata.to_json, return_type=dict), ] """A pydantic-ready field type for v3 array metadata. Validates raw documents via `from_json`, passes model instances through, and serializes to the canonical document form via `to_json`. """ class ArrayManifest(BaseModel): """Example consumer model: a named array with its metadata document.""" path: str metadata: ArrayMetadataV3Field # --- tests pinning the example ------------------------------------------------ VALID_DOC = { "zarr_format": 3, "node_type": "array", "shape": [10], "data_type": "uint8", "fill_value": 0, "chunk_grid": {"name": "regular", "configuration": {"chunk_shape": [5]}}, "chunk_key_encoding": {"name": "default"}, "codecs": [{"name": "bytes"}], } def test_raw_document_is_validated_into_a_model() -> None: """A raw metadata document on a pydantic field is parsed by from_json, with the library's normalization applied (tuples, canonical field form).""" manifest = ArrayManifest.model_validate({"path": "a/b", "metadata": VALID_DOC}) assert isinstance(manifest.metadata, ZarrV3ArrayMetadata) assert manifest.metadata.shape == (10,) assert manifest.metadata.data_type.name == "uint8" def test_model_instance_passes_through() -> None: """An already-constructed model instance is accepted unchanged.""" model = ZarrV3ArrayMetadata.from_json(VALID_DOC) manifest = ArrayManifest(path="a/b", metadata=model) assert manifest.metadata is model def test_invalid_document_surfaces_problems_in_validation_error() -> None: """A structurally-invalid document fails pydantic validation, carrying the loc-annotated problem messages from MetadataValidationError.""" doc = dict(VALID_DOC) del doc["chunk_key_encoding"] with pytest.raises(ValidationError) as exc_info: ArrayManifest.model_validate({"path": "a/b", "metadata": doc}) assert "chunk_key_encoding: missing required key" in str(exc_info.value) def test_dump_emits_canonical_document() -> None: """model_dump serializes the field via to_json — the canonical document, not pydantic's field-by-field view of the dataclass.""" manifest = ArrayManifest.model_validate({"path": "a/b", "metadata": VALID_DOC}) dumped = manifest.model_dump() assert dumped["metadata"] == manifest.metadata.to_json() # Empty configurations use the extension-definition shorthand form. assert dumped["metadata"]["data_type"] == "uint8" def test_json_roundtrip_through_pydantic() -> None: """model_dump_json output re-validates to an equal manifest (JSON emits tuples as arrays; from_json converts them back).""" manifest = ArrayManifest.model_validate({"path": "a/b", "metadata": VALID_DOC}) revived = ArrayManifest.model_validate_json(manifest.model_dump_json()) assert revived == manifest def test_type_adapter_standalone() -> None: """The annotated alias also works without a BaseModel, via TypeAdapter.""" adapter = TypeAdapter(ArrayMetadataV3Field) model = adapter.validate_python(VALID_DOC) assert isinstance(model, ZarrV3ArrayMetadata) assert adapter.dump_python(model) == model.to_json() # --- the road not taken: native dataclass introspection ---------------------- def test_native_dataclass_introspection_is_not_supported() -> None: """Pydantic cannot field-introspect the model dataclasses: the UNSET sentinel (PEP 661, typing_extensions.Sentinel) in the optional-field annotations has no pydantic schema (as of pydantic 2.13), so even the rebuild-with-namespace recipe fails. Introspection was already the wrong tool before the sentinel existed — it validated the model shape rather than the document, and its lax coercion re-opened validator holes (e.g. shape=[True, -5] coerced to (1, -5)) — so the delegation patterns above are the only supported integrations. If this test ever fails because pydantic learned to handle sentinels, revisit whether the introspection path needs its divergences documented again.""" from zarr_metadata._common import JSONValue from zarr_metadata.model import UNSET from zarr_metadata.v3._common import ZarrV3MetadataFieldJSON from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON, ZarrV3ExtensionField def build_and_use() -> None: adapter = TypeAdapter(ZarrV3ArrayMetadata) adapter.rebuild( force=True, _types_namespace={ "JSONValue": JSONValue, "ZarrV3ExtensionField": ZarrV3ExtensionField, "ZarrV3MetadataFieldJSON": ZarrV3MetadataFieldJSON, "ZarrV3ArrayMetadataJSON": ZarrV3ArrayMetadataJSON, "ZarrV3NamedConfig": ZarrV3NamedConfig, "ZarrV3MetadataField": ZarrV3NamedConfig, "UNSET": UNSET, }, ) adapter.validate_python({}) with pytest.raises((AttributeError, PydanticSchemaGenerationError, PydanticUserError)): build_and_use() # --- a first-class pydantic model, engine-backed (the pydantic-zarr pattern) -- # # When a consumer wants a real BaseModel — JSON schema generation, and # generics for typed attributes, as in pydantic-zarr's ArraySpec — the model # fields are pydantic-native, but validation and serialization still route # through the library: a mode="before" validator canonicalizes every input # document with from_json(...).to_json(), so the structural validators and # normalization run BEFORE pydantic parses fields (no coercion divergence), # and the document form is the bridge in both directions. AttrsT = TypeVar("AttrsT") class NamedConfig(BaseModel): """Pydantic mirror of a normalized metadata extension envelope.""" name: str configuration: dict[str, JSONValue] = {} must_understand: bool = True class ArrayMetadataV3Spec(BaseModel, Generic[AttrsT]): """A pydantic-native, attribute-typed view of a v3 array metadata document. The library is the engine: every input is canonicalized and structurally validated by `ZarrV3ArrayMetadata.from_json` before pydantic sees the fields, and `to_document` / `to_metadata_model` emit through the library. """ model_config = ConfigDict(frozen=True) zarr_format: int = 3 node_type: str = "array" shape: tuple[int, ...] data_type: NamedConfig chunk_grid: NamedConfig chunk_key_encoding: NamedConfig fill_value: JSONValue codecs: tuple[NamedConfig, ...] attributes: AttrsT dimension_names: tuple[str | None, ...] | None = None storage_transformers: tuple[NamedConfig, ...] = () @model_validator(mode="before") @classmethod def _canonicalize(cls, data: object) -> object: """Route every input document through the library's validation and normalization; pydantic then parses only canonical documents.""" if isinstance(data, Mapping): doc = dict(ZarrV3ArrayMetadata.from_json(data).to_json()) for key in ("data_type", "chunk_grid", "chunk_key_encoding"): if isinstance(doc[key], str): doc[key] = {"name": doc[key]} for key in ("codecs", "storage_transformers"): doc[key] = tuple( {"name": item} if isinstance(item, str) else item for item in doc.get(key, ()) ) doc.setdefault("attributes", {}) return doc return data def to_metadata_model(self) -> ZarrV3ArrayMetadata: """Bridge back to the canonical model, via the document form. In the document, "no dimension names" is key-absence, not null; the pydantic-side None translates to dropping the key. """ doc = self.model_dump() if doc["dimension_names"] is None: del doc["dimension_names"] return ZarrV3ArrayMetadata.from_json(doc) def to_document(self) -> dict[str, object]: """The canonical document (omit-empty conventions applied).""" return dict(self.to_metadata_model().to_json()) class MicroscopyAttrs(BaseModel): """Example of consumer-typed attributes, pydantic-zarr style.""" resolution_um: float def test_spec_typed_attributes() -> None: """The generic parameter types the attributes, so consumers get validated, attribute-level access — the pydantic-zarr ArraySpec pattern.""" doc = dict(VALID_DOC) | {"attributes": {"resolution_um": 0.5}} spec = ArrayMetadataV3Spec[MicroscopyAttrs].model_validate(doc) assert spec.attributes.resolution_um == 0.5 assert spec.data_type == NamedConfig(name="uint8") def test_spec_engine_validates_before_pydantic() -> None: """The library's structural validation runs before pydantic's parsing, so coercion cannot re-open validator holes (contrast with the native introspection test above, where [True, -5] coerced to (1, -5)).""" with pytest.raises(ValidationError, match="shape"): ArrayMetadataV3Spec[MicroscopyAttrs].model_validate( dict(VALID_DOC) | {"shape": [True, -5], "attributes": {"resolution_um": 0.5}} ) def test_spec_bridges_to_canonical_model_and_document() -> None: """to_metadata_model / to_document round-trip through the document form, and the emitted document matches what the library itself would emit.""" doc = dict(VALID_DOC) | {"attributes": {"resolution_um": 0.5}} spec = ArrayMetadataV3Spec[MicroscopyAttrs].model_validate(doc) model = spec.to_metadata_model() assert isinstance(model, ZarrV3ArrayMetadata) assert spec.to_document() == dict(model.to_json()) # and back: the document revalidates to an equal spec assert ArrayMetadataV3Spec[MicroscopyAttrs].model_validate(spec.to_document()) == spec def test_spec_json_schema_generation() -> None: """A real BaseModel means model_json_schema works — the capability the opaque InstanceOf pattern cannot provide.""" schema = ArrayMetadataV3Spec[MicroscopyAttrs].model_json_schema() assert schema["properties"]["shape"]["type"] == "array" assert "MicroscopyAttrs" in schema["$defs"] zarr-python-3.3.0/packages/zarr-metadata/tests/model/test_pydantic_module.py000066400000000000000000000230151523267620000273630ustar00rootroot00000000000000"""Tests for `zarr_metadata.pydantic`, the optional pydantic field-type module. The hand-rolled recipes in `test_pydantic.py` document how the integration works; this module ships it. Instances are the CORE model classes (no parallel hierarchy), so values interoperate freely with non-pydantic code. """ import json import warnings import pytest from jsonschema import Draft202012Validator from pydantic import BaseModel, TypeAdapter, ValidationError import zarr_metadata.pydantic as zmp from zarr_metadata.model import ( ZarrV2ArrayMetadata, ZarrV2ConsolidatedMetadata, ZarrV2GroupMetadata, ZarrV3ArrayMetadata, ZarrV3ConsolidatedMetadata, ZarrV3GroupMetadata, ZarrV3NamedConfig, ) V3_ARRAY_DOC = dict(ZarrV3ArrayMetadata.create_default(shape=(4,)).to_json()) V2_ARRAY_DOC = dict(ZarrV2ArrayMetadata.create_default(shape=(4,), chunks=(2,)).to_json()) V3_GROUP_DOC = {"zarr_format": 3, "node_type": "group", "attributes": {"a": 1}} V2_GROUP_DOC = {"zarr_format": 2, "attributes": {"a": 1}} V3_CONSOLIDATED_DOC = { "kind": "inline", "must_understand": False, "metadata": {"a": dict(V3_ARRAY_DOC)}, } V2_CONSOLIDATED_DOC = { "zarr_consolidated_format": 1, "metadata": {".zgroup": {"zarr_format": 2}}, } FIELD_CASES = [ pytest.param(zmp.ZarrV3ArrayMetadata, ZarrV3ArrayMetadata, V3_ARRAY_DOC, id="array-v3"), pytest.param(zmp.ZarrV2ArrayMetadata, ZarrV2ArrayMetadata, V2_ARRAY_DOC, id="array-v2"), pytest.param(zmp.ZarrV3GroupMetadata, ZarrV3GroupMetadata, V3_GROUP_DOC, id="group-v3"), pytest.param(zmp.ZarrV2GroupMetadata, ZarrV2GroupMetadata, V2_GROUP_DOC, id="group-v2"), pytest.param( zmp.ZarrV3ConsolidatedMetadata, ZarrV3ConsolidatedMetadata, V3_CONSOLIDATED_DOC, id="consolidated-v3", ), pytest.param( zmp.ZarrV2ConsolidatedMetadata, ZarrV2ConsolidatedMetadata, V2_CONSOLIDATED_DOC, id="consolidated-v2", ), pytest.param(zmp.ZarrV3MetadataField, ZarrV3NamedConfig, {"name": "bytes"}, id="field-v3"), ] @pytest.mark.parametrize(("field_type", "model_cls", "doc"), FIELD_CASES) def test_field_type_validates_and_dumps_canonically( field_type: object, model_cls: type, doc: dict[str, object] ) -> None: """Each field type parses its raw document into the CORE model class, passes existing instances through unchanged, and dumps the canonical document via to_json.""" adapter = TypeAdapter(field_type) model = adapter.validate_python(doc) assert type(model) is model_cls assert adapter.validate_python(model) is model assert adapter.dump_python(model) == model.to_json() def test_core_instances_interoperate() -> None: """A core model instance (e.g. handed out by zarr-python) drops straight into a pydantic field — the reason the module ships Annotated aliases over the core classes rather than pydantic-aware subclasses.""" class Manifest(BaseModel): metadata: zmp.ZarrV3ArrayMetadata core = ZarrV3ArrayMetadata.from_json(V3_ARRAY_DOC) manifest = Manifest(metadata=core) assert manifest.metadata is core def test_validation_error_carries_problems() -> None: """A defective document fails with the library's loc-annotated messages.""" class Manifest(BaseModel): metadata: zmp.ZarrV3ArrayMetadata doc = dict(V3_ARRAY_DOC) del doc["chunk_key_encoding"] with pytest.raises(ValidationError, match="chunk_key_encoding: missing required key"): Manifest.model_validate({"metadata": doc}) def test_json_schema_generation() -> None: """model_json_schema works, describing the document form each field accepts.""" class Manifest(BaseModel): metadata: zmp.ZarrV3ArrayMetadata codec: zmp.ZarrV3MetadataField schema = Manifest.model_json_schema() metadata_schema = schema["$defs"]["ZarrV3ArrayMetadataJSON"] assert schema["properties"]["metadata"]["$ref"] == "#/$defs/ZarrV3ArrayMetadataJSON" assert metadata_schema["required"] == [ "zarr_format", "node_type", "data_type", "shape", "chunk_grid", "chunk_key_encoding", "fill_value", "codecs", ] assert metadata_schema["properties"]["zarr_format"] == { "const": 3, "title": "Zarr Format", "type": "integer", } assert schema["properties"]["codec"]["anyOf"] == [ {"type": "string"}, {"$ref": "#/$defs/ZarrV3NamedConfigJSON"}, ] def test_json_schema_generation_emits_no_warnings() -> None: """Consumers can generate every public integration schema without warning filters.""" field_types = ( zmp.ZarrV3ArrayMetadata, zmp.ZarrV2ArrayMetadata, zmp.ZarrV3GroupMetadata, zmp.ZarrV2GroupMetadata, zmp.ZarrV3ConsolidatedMetadata, zmp.ZarrV2ConsolidatedMetadata, zmp.ZarrV3MetadataField, ) with warnings.catch_warnings(): warnings.simplefilter("error") for field_type in field_types: TypeAdapter(field_type).json_schema() def test_v2_recursive_structured_dtype_is_in_pydantic_schema() -> None: """The schema accepts nested structured dtypes supported by the v2 specification.""" doc = json.loads(json.dumps(V2_ARRAY_DOC)) doc["dtype"] = [["outer", [["inner", " None: adapter = TypeAdapter(field_type) with pytest.raises(ValidationError): adapter.validate_python(document) assert list(Draft202012Validator(adapter.json_schema()).iter_errors(document)) def test_v3_array_schema_rejects_empty_codecs() -> None: """The generated schema mirrors the runtime non-empty codec pipeline rule.""" doc = json.loads(json.dumps(V3_ARRAY_DOC)) doc["codecs"] = [] _assert_runtime_and_schema_reject(zmp.ZarrV3ArrayMetadata, doc) def test_array_schemas_reject_negative_dimensions() -> None: """Both array schemas mirror the runtime non-negative dimension rule.""" for field_type, source in ( (zmp.ZarrV3ArrayMetadata, V3_ARRAY_DOC), (zmp.ZarrV2ArrayMetadata, V2_ARRAY_DOC), ): doc = json.loads(json.dumps(source)) doc["shape"] = [-1] _assert_runtime_and_schema_reject(field_type, doc) def test_v2_array_schema_rejects_empty_filters() -> None: """The v2 schema mirrors the runtime one-or-more filter rule.""" doc = json.loads(json.dumps(V2_ARRAY_DOC)) doc["filters"] = [] _assert_runtime_and_schema_reject(zmp.ZarrV2ArrayMetadata, doc) @pytest.mark.parametrize("field", ["data_type", "chunk_grid", "chunk_key_encoding"]) def test_v3_array_schema_rejects_false_at_mandatory_extension_points(field: str) -> None: """Mandatory v3 extension points cannot opt out of understanding.""" doc = json.loads(json.dumps(V3_ARRAY_DOC)) doc[field] = {"name": "example", "must_understand": False} _assert_runtime_and_schema_reject(zmp.ZarrV3ArrayMetadata, doc) def test_metadata_field_schema_rejects_unknown_members() -> None: """Named-configuration envelopes are closed in both runtime and schema validation.""" _assert_runtime_and_schema_reject( zmp.ZarrV3MetadataField, {"name": "example", "unexpected": 1}, ) @pytest.mark.parametrize( ("field_type", "source"), [ (zmp.ZarrV2ArrayMetadata, V2_ARRAY_DOC), (zmp.ZarrV2GroupMetadata, V2_GROUP_DOC), (zmp.ZarrV2ConsolidatedMetadata, V2_CONSOLIDATED_DOC), ], ) def test_v2_schema_rejects_unknown_document_members( field_type: object, source: dict[str, object] ) -> None: """Closed v2 merged documents expose their runtime boundary in JSON Schema.""" doc = json.loads(json.dumps(source)) doc["unexpected"] = 1 _assert_runtime_and_schema_reject(field_type, doc) def test_v3_array_schema_allows_unknown_extension_fields() -> None: """Schema constraints do not close the v3 top-level extension namespace.""" doc = json.loads(json.dumps(V3_ARRAY_DOC)) doc["vendor_extension"] = {"anything": [1, 2]} adapter = TypeAdapter(zmp.ZarrV3ArrayMetadata) assert adapter.validate_python(doc).extra_fields == {"vendor_extension": {"anything": (1, 2)}} assert Draft202012Validator(adapter.json_schema()).is_valid(doc) def test_json_roundtrip() -> None: """model_dump_json output re-validates to an equal pydantic model.""" class Manifest(BaseModel): metadata: zmp.ZarrV3ArrayMetadata manifest = Manifest.model_validate({"metadata": V3_ARRAY_DOC}) assert Manifest.model_validate_json(manifest.model_dump_json()) == manifest def test_metadata_field_serializes_shorthand_and_false_object() -> None: """The optional integration exposes the core model's canonical extension form.""" adapter = TypeAdapter(zmp.ZarrV3MetadataField) assert adapter.dump_python(adapter.validate_python({"name": "bytes"})) == "bytes" assert adapter.dump_python( adapter.validate_python({"name": "optional", "must_understand": False}) ) == {"name": "optional", "must_understand": False} def test_core_package_does_not_import_pydantic() -> None: """Importing zarr_metadata (in a fresh interpreter) must not import pydantic: the integration is opt-in via zarr_metadata.pydantic.""" import subprocess import sys code = "import sys, zarr_metadata; assert 'pydantic' not in sys.modules, 'leaked'" subprocess.run([sys.executable, "-c", code], check=True) zarr-python-3.3.0/packages/zarr-metadata/tests/model/test_sentinel.py000066400000000000000000000070751523267620000260340ustar00rootroot00000000000000"""Tests for the pickling and copying behavior of the `UNSET` sentinel. The sentinel's contract is identity, so it must never be reconstructed from state. typing_extensions >= 4.16 pickles sentinels by reference (a lookup of the sentinel's name on its defining module), which preserves the singleton across process boundaries; these tests pin that behavior, since models hold `UNSET` as field values and must survive pickling and deep-copying. The model round-trip tests compare whole structures: dataclass equality compares every field, and `UNSET` compares by identity, so an impostor sentinel produced by state-based pickling would fail the equality check. """ from __future__ import annotations import copy import pickle import pytest from typing_extensions import Sentinel from zarr_metadata.model import ( UNSET, ZarrV2ArrayMetadata, ZarrV2GroupMetadata, ZarrV3ArrayMetadata, ZarrV3ConsolidatedMetadata, ZarrV3GroupMetadata, ) # Whole-model cases covering the states we know are problematic for # serialization: every optional-key field in the UNSET (absent) state, the # same fields in the present state (including present-but-empty, which must # stay distinct from absent), and UNSET nested inside consolidated metadata. MODEL_CASES = { "array-v3-dimension-names-unset": ZarrV3ArrayMetadata.create_default(shape=(4,)), "array-v3-dimension-names-set": ZarrV3ArrayMetadata.create_default(shape=(2, 2)).update( dimension_names=("x", None) ), "array-v2-attributes-unset": ZarrV2ArrayMetadata.create_default(shape=(4,)), "array-v2-attributes-empty": ZarrV2ArrayMetadata.create_default(shape=(4,), attributes={}), "group-v2-attributes-unset": ZarrV2GroupMetadata.create_default(), "group-v2-attributes-set": ZarrV2GroupMetadata.create_default(attributes={"a": 1}), "group-v3-consolidated-unset": ZarrV3GroupMetadata.create_default(), "group-v3-consolidated-with-unset-inside": ZarrV3GroupMetadata.create_default( consolidated_metadata=ZarrV3ConsolidatedMetadata( metadata={ "child": ZarrV3ArrayMetadata.create_default(shape=(4,)), "subgroup": ZarrV3GroupMetadata.create_default(), } ) ), } def test_unset_pickle_round_trip_preserves_identity() -> None: restored = pickle.loads(pickle.dumps(UNSET)) assert restored is UNSET def test_unset_copy_preserves_identity() -> None: assert copy.copy(UNSET) is UNSET assert copy.deepcopy(UNSET) is UNSET @pytest.mark.parametrize("model", MODEL_CASES.values(), ids=MODEL_CASES.keys()) def test_model_pickle_round_trip( model: ZarrV2ArrayMetadata | ZarrV3ArrayMetadata | ZarrV2GroupMetadata | ZarrV3GroupMetadata, ) -> None: restored = pickle.loads(pickle.dumps(model)) assert restored == model @pytest.mark.parametrize("model", MODEL_CASES.values(), ids=MODEL_CASES.keys()) def test_model_deepcopy( model: ZarrV2ArrayMetadata | ZarrV3ArrayMetadata | ZarrV2GroupMetadata | ZarrV3GroupMetadata, ) -> None: assert copy.deepcopy(model) == model def test_non_importable_sentinel_fails_to_pickle() -> None: """Sentinels pickle by reference, never by state. A sentinel that is not an importable attribute of its module has no reference to pickle, so dumping it must fail loudly — a successful dump here would mean the implementation regressed to state-based pickling, which would produce identity-breaking impostor objects on the receiving side.""" local_sentinel = Sentinel("local_sentinel") with pytest.raises((pickle.PicklingError, TypeError)): pickle.dumps(local_sentinel) zarr-python-3.3.0/packages/zarr-metadata/tests/test_partial_equivalence.py000066400000000000000000000037751523267620000271330ustar00rootroot00000000000000"""Drift-prevention tests for Partial* TypedDict variants. Each *Partial TypedDict in the package must declare the same fields (with the same annotations) and the same extra_items setting as its full counterpart. The only intentional difference is total=False (i.e. every field becomes NotRequired). This test enforces that invariant so adding a field to the full type without mirroring it on the partial fails CI. """ from __future__ import annotations from typing import Any import pytest from zarr_metadata.v2.array import ZarrV2ArrayMetadataJSON, ZarrV2ArrayMetadataJSONPartial from zarr_metadata.v2.group import ZarrV2GroupMetadataJSON, ZarrV2GroupMetadataJSONPartial from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON, ZarrV3ArrayMetadataJSONPartial from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON, ZarrV3GroupMetadataJSONPartial # (full, partial) pairs to check. Add new pairs here as more are introduced. PAIRS: list[tuple[type, type]] = [ (ZarrV3ArrayMetadataJSON, ZarrV3ArrayMetadataJSONPartial), (ZarrV3GroupMetadataJSON, ZarrV3GroupMetadataJSONPartial), (ZarrV2ArrayMetadataJSON, ZarrV2ArrayMetadataJSONPartial), (ZarrV2GroupMetadataJSON, ZarrV2GroupMetadataJSONPartial), ] @pytest.mark.parametrize(("full", "partial"), PAIRS, ids=lambda p: p.__name__) def test_partial_matches_full(full: Any, partial: Any) -> None: """Partial TypedDict has identical fields and extra_items, only total differs.""" assert full.__annotations__ == partial.__annotations__, ( f"{partial.__name__} fields drifted from {full.__name__}: " f"full={set(full.__annotations__)}, partial={set(partial.__annotations__)}" ) assert getattr(full, "__extra_items__", None) == getattr(partial, "__extra_items__", None), ( f"{partial.__name__} extra_items differs from {full.__name__}" ) assert full.__total__ is True, f"{full.__name__} must be declared with total=True (default)" assert partial.__total__ is False, f"{partial.__name__} must be declared with total=False" zarr-python-3.3.0/packages/zarr-metadata/tests/test_public_api.py000066400000000000000000000247201523267620000252160ustar00rootroot00000000000000"""Test that the curated front-door names are accessible from the top-level zarr_metadata package.""" import importlib import pkgutil import re from typing import get_args import zarr_metadata as zm def _group_rank(s: str) -> int: """RUF022 groups `__all__` as: SCREAMING_SNAKE (0), then TitleCase (1), then dunders (2). The exact intra-group ordering is ruff's own natural sort and is enforced by ruff itself (pre-commit + CI); this test only asserts the grouping, not the fragile tie-breaking, so it can't drift out of sync with ruff's implementation. """ if s.startswith("__") and s.endswith("__"): return 2 stripped = re.sub(r"[\d_]", "", s) return 0 if stripped.isupper() else 1 EXPECTED = [ # Category A — metadata-document types "ZarrV2ArrayMetadataJSON", "ZarrV2ArrayMetadataJSONPartial", "ZarrV2ZArrayJSON", "ZarrV2GroupMetadataJSON", "ZarrV2GroupMetadataJSONPartial", "ZarrV2ZGroupJSON", "ZarrV2ConsolidatedMetadataJSON", "ZarrV2ZAttrsJSON", "ZarrV2CodecMetadata", "ZarrV3ArrayMetadataJSON", "ZarrV3ArrayMetadataJSONPartial", "ZarrV3ExtensionField", "ZarrV3GroupMetadataJSON", "ZarrV3GroupMetadataJSONPartial", "ZarrV3ConsolidatedMetadataJSON", "ZarrV3NamedConfigJSON", "ZarrV3MetadataFieldJSON", "JSONValue", # Category A' — metadata models (in-memory dataclasses over the documents) "ZarrV2ArrayMetadata", "ZarrV2ArrayMetadataPartial", "ZarrV3ArrayMetadata", "ZarrV3ArrayMetadataPartial", "ZarrV2GroupMetadata", "ZarrV2GroupMetadataPartial", "ZarrV3GroupMetadata", "ZarrV3GroupMetadataPartial", "ZarrV2ConsolidatedMetadata", "ZarrV3ConsolidatedMetadata", "ZarrV3NamedConfig", "ZarrV3MetadataField", "ValidationProblem", "MetadataValidationError", "ProblemKind", "UNSET", # v2 data-type encoding union "ZarrV2DataTypeMetadata", # Category B — codec canonical unions "BloscCodecMetadata", "BytesCodecMetadata", "CastValueCodecMetadata", "Crc32cCodecMetadata", "GzipCodecMetadata", "ScaleOffsetCodecMetadata", "ShardingIndexedCodecMetadata", "TransposeCodecMetadata", "ZstdCodecMetadata", # Category C — grid/key canonical unions "RegularChunkGridMetadata", "RectilinearChunkGridMetadata", "DefaultChunkKeyEncodingMetadata", "V2ChunkKeyEncodingMetadata", # Category D — dtype trios # bool "BoolDataTypeName", "BOOL_DATA_TYPE_NAME", "BoolFillValue", # int8/16/32/64 "Int8DataTypeName", "INT8_DATA_TYPE_NAME", "Int8FillValue", "Int16DataTypeName", "INT16_DATA_TYPE_NAME", "Int16FillValue", "Int32DataTypeName", "INT32_DATA_TYPE_NAME", "Int32FillValue", "Int64DataTypeName", "INT64_DATA_TYPE_NAME", "Int64FillValue", # uint8/16/32/64 (actual casing is Uint, not UInt) "Uint8DataTypeName", "UINT8_DATA_TYPE_NAME", "Uint8FillValue", "Uint16DataTypeName", "UINT16_DATA_TYPE_NAME", "Uint16FillValue", "Uint32DataTypeName", "UINT32_DATA_TYPE_NAME", "Uint32FillValue", "Uint64DataTypeName", "UINT64_DATA_TYPE_NAME", "Uint64FillValue", # float16/32/64 "Float16DataTypeName", "FLOAT16_DATA_TYPE_NAME", "Float16FillValue", "Float32DataTypeName", "FLOAT32_DATA_TYPE_NAME", "Float32FillValue", "Float64DataTypeName", "FLOAT64_DATA_TYPE_NAME", "Float64FillValue", # complex64/128 "Complex64DataTypeName", "COMPLEX64_DATA_TYPE_NAME", "Complex64FillValue", "Complex128DataTypeName", "COMPLEX128_DATA_TYPE_NAME", "Complex128FillValue", # bytes "BytesDataTypeName", "BYTES_DATA_TYPE_NAME", "BytesFillValue", # string "StringDataTypeName", "STRING_DATA_TYPE_NAME", "StringFillValue", # numpy_datetime64 "NumpyDatetime64DataTypeName", "NUMPY_DATETIME64_DATA_TYPE_NAME", "NumpyDatetime64FillValue", # numpy_timedelta64 "NumpyTimedelta64DataTypeName", "NUMPY_TIMEDELTA64_DATA_TYPE_NAME", "NumpyTimedelta64FillValue", # struct "StructDataTypeName", "STRUCT_DATA_TYPE_NAME", "StructFillValue", # raw (no _DATA_TYPE_NAME constant) "RawBytesDataTypeName", "RawBytesFillValue", # Category E — constant+Literal pairs "ARRAY_ORDER_V2", "ZarrV2ArrayOrder", "ARRAY_DIMENSION_SEPARATOR_V2", "ZarrV2ArrayDimensionSeparator", "ENDIANNESS", "Endianness", "BYTES_CODEC_NAME", "BytesCodecName", "BLOSC_CODEC_NAME", "BloscCodecName", "BLOSC_CNAME", "BloscCName", "BLOSC_SHUFFLE", "BloscShuffle", "CAST_ROUNDING_MODE", "CastRoundingMode", "CAST_OUT_OF_RANGE_MODE", "CastOutOfRangeMode", "CAST_VALUE_CODEC_NAME", "CastValueCodecName", "CRC32C_CODEC_NAME", "Crc32cCodecName", "GZIP_CODEC_NAME", "GzipCodecName", "SCALE_OFFSET_CODEC_NAME", "ScaleOffsetCodecName", "SHARDING_INDEX_LOCATION", "ShardingIndexLocation", "SHARDING_INDEXED_CODEC_NAME", "ShardingIndexedCodecName", "TRANSPOSE_CODEC_NAME", "TransposeCodecName", "ZSTD_CODEC_NAME", "ZstdCodecName", "REGULAR_CHUNK_GRID_NAME", "RegularChunkGridName", "RECTILINEAR_CHUNK_GRID_NAME", "RectilinearChunkGridName", "DEFAULT_CHUNK_KEY_ENCODING_NAME", "DefaultChunkKeyEncodingName", "DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR", "DefaultChunkKeyEncodingSeparator", "V2_CHUNK_KEY_ENCODING_NAME", "V2ChunkKeyEncodingName", "V2_CHUNK_KEY_ENCODING_SEPARATOR", "V2ChunkKeyEncodingSeparator", "NUMPY_TIME_UNIT", "NumpyTimeUnit", ] def test_front_door_names_public() -> None: missing = [n for n in EXPECTED if n not in zm.__all__ or not hasattr(zm, n)] assert not missing, f"missing from top-level API: {missing}" def test_front_door_is_exactly_expected() -> None: """`__all__` must contain exactly the curated names (plus `__version__`). Guards against a name being promoted to the front door without a corresponding, deliberate entry in `EXPECTED` — i.e. an accidental addition to the public API surface. """ assert set(zm.__all__) - {"__version__"} == set(EXPECTED) def test_all_is_grouped_and_unique() -> None: ranks = [_group_rank(n) for n in zm.__all__] assert ranks == sorted(ranks), "`__all__` groups out of order (SCREAMING, TitleCase, dunder)" assert len(zm.__all__) == len(set(zm.__all__)) # --- naming grammar --------------------------------------------------------- # Core document/model names: the format version comes first (`ZarrV2` / # `ZarrV3`), then the CamelCase entity, then an optional role suffix # (`JSON`, `JSONPartial`, `Partial`, `StoreKey`) — validated loosely here # because `JSON` decomposes into single-letter words under any strict # word-splitting regex. _CORE_NAME = re.compile(r"^ZarrV[23](?:[A-Z][a-z0-9]*)+$") # Zarr v3 extension-entity names: the registered entity comes first (`Blosc`, # `Uint8`, ... — `V2` here is the *entity name* of the v2-compatibility chunk # key encoding, not a format-version marker, which is always spelled # `ZarrV2`/`ZarrV3`), followed by exactly one role suffix. _EXTENSION_ROLES = ( "CodecConfiguration", "CodecMetadata", "CodecName", "CodecObject", "ChunkGridConfiguration", "ChunkGridMetadata", "ChunkGridName", "ChunkGridObject", "ChunkKeyEncodingConfiguration", "ChunkKeyEncodingMetadata", "ChunkKeyEncodingName", "ChunkKeyEncodingObject", "ChunkKeyEncodingSeparator", "DataTypeName", "FillValue", "Configuration", "Component", ) _EXTENSION_NAME = re.compile(r"^(?:[A-Z][a-z0-9]*)+?(?:" + "|".join(_EXTENSION_ROLES) + r")$") # Standalone vocabulary: scalar Literal aliases, structural helper shapes, and # the validation diagnostics. Closed by hand — a new name belongs here only if # it is genuinely role-less; anything document- or entity-shaped must fit the # grammars above instead. _STANDALONE_VOCAB = frozenset( { "Base64Bytes", "BloscCName", "BloscShuffle", "CastOutOfRangeMode", "CastRoundingMode", "Endianness", "HexFloat16", "HexFloat32", "HexFloat64", "JSONValue", "MetadataValidationError", "NumpyDatetime64", "NumpyTimeUnit", "NumpyTimedelta64", "ProblemKind", "RectilinearDimSpec", "ScalarMap", "ScalarMapEntry", "ShardingIndexLocation", "Struct", "StructField", "ValidationProblem", } ) def _public_type_names() -> set[tuple[str, str]]: """Every (module, CamelCase name) pair exported via a public `__all__`.""" module_names = {"zarr_metadata"} for info in pkgutil.walk_packages(zm.__path__, prefix="zarr_metadata."): if not any(part.startswith("_") for part in info.name.split(".")[1:]): module_names.add(info.name) out: set[tuple[str, str]] = set() for module_name in module_names: module = importlib.import_module(module_name) for name in getattr(module, "__all__", ()): if name.startswith("_") or name.isupper() or name.islower(): continue out.add((module_name, name)) return out def test_public_type_names_comply_with_naming_grammar() -> None: """Every public type name parses against the package naming grammar: version-first core names, entity-plus-role extension names, or the closed standalone vocabulary.""" exported = _public_type_names() violations = [ f"{module}.{name}" for module, name in sorted(exported) if name not in _STANDALONE_VOCAB and not _CORE_NAME.match(name) and not _EXTENSION_NAME.match(name) ] assert not violations, f"names outside the naming grammar: {violations}" def test_standalone_vocab_is_not_stale() -> None: """Every allowlisted vocabulary name is still actually exported.""" exported_names = {name for _, name in _public_type_names()} assert exported_names >= _STANDALONE_VOCAB def test_promoted_pairs_drift() -> None: pairs = [ (zm.ENDIANNESS, zm.Endianness), (zm.BLOSC_CNAME, zm.BloscCName), (zm.BLOSC_SHUFFLE, zm.BloscShuffle), (zm.SHARDING_INDEX_LOCATION, zm.ShardingIndexLocation), (zm.NUMPY_TIME_UNIT, zm.NumpyTimeUnit), (zm.CAST_ROUNDING_MODE, zm.CastRoundingMode), (zm.CAST_OUT_OF_RANGE_MODE, zm.CastOutOfRangeMode), (zm.ARRAY_ORDER_V2, zm.ZarrV2ArrayOrder), ] for const, lit in pairs: assert set(const) == set(get_args(lit)) zarr-python-3.3.0/packages/zarr-metadata/tests/v2/000077500000000000000000000000001523267620000220205ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v2/__init__.py000066400000000000000000000000001523267620000241170ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v2/array/000077500000000000000000000000001523267620000231365ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v2/array/__init__.py000066400000000000000000000000001523267620000252350ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v2/array/blosc_compressor_with_filters.json000066400000000000000000000004741523267620000321770ustar00rootroot00000000000000{ "zarr_format": 2, "shape": [200], "chunks": [50], "dtype": " None: ADAPTER.validate_python(json.loads(fixture.read_text())) zarr-python-3.3.0/packages/zarr-metadata/tests/v2/consolidated/000077500000000000000000000000001523267620000244705ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v2/consolidated/__init__.py000066400000000000000000000000001523267620000265670ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v2/consolidated/minimal.json000066400000000000000000000000661523267620000270130ustar00rootroot00000000000000{ "zarr_consolidated_format": 1, "metadata": {} } zarr-python-3.3.0/packages/zarr-metadata/tests/v2/consolidated/test_fixtures.py000066400000000000000000000010711523267620000277510ustar00rootroot00000000000000"""Decode v2 consolidated metadata fixtures via pydantic.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v2.consolidated import ZarrV2ConsolidatedMetadataJSON FIXTURES_DIR = Path(__file__).parent FIXTURES = sorted(FIXTURES_DIR.glob("*.json")) ADAPTER = TypeAdapter(ZarrV2ConsolidatedMetadataJSON) @pytest.mark.parametrize("fixture", FIXTURES, ids=lambda p: p.stem) def test_validate(fixture: Path) -> None: ADAPTER.validate_python(json.loads(fixture.read_text())) zarr-python-3.3.0/packages/zarr-metadata/tests/v2/consolidated/with_array_and_group.json000066400000000000000000000006121523267620000315710ustar00rootroot00000000000000{ "zarr_consolidated_format": 1, "metadata": { ".zgroup": {"zarr_format": 2}, ".zattrs": {"description": "root group attrs"}, "data/.zarray": { "zarr_format": 2, "shape": [100], "chunks": [10], "dtype": " None: ADAPTER.validate_python(json.loads(fixture.read_text())) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/000077500000000000000000000000001523267620000220215ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/__init__.py000066400000000000000000000000001523267620000241200ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/000077500000000000000000000000001523267620000231375ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/__init__.py000066400000000000000000000000001523267620000252360ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/blosc_codec.json000066400000000000000000000010131523267620000262640ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [1024], "data_type": "int32", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [256]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, { "name": "blosc", "configuration": { "cname": "zstd", "clevel": 5, "shuffle": "shuffle", "blocksize": 0, "typesize": 4 } } ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/datatype_named_config.json000066400000000000000000000006361523267620000303430ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [10], "data_type": { "name": "numpy.datetime64", "configuration": {"unit": "ns", "scale_factor": 1} }, "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [10]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/gzip_codec.json000066400000000000000000000006001523267620000261340ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [128], "data_type": "uint16", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [64]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "gzip", "configuration": {"level": 5}} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/rectilinear_grid.json000066400000000000000000000006461523267620000273460ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [100, 100], "data_type": "float64", "chunk_grid": { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": [ [10, 20, 30, 40], 50 ] } }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0.0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/rectilinear_grid_with_rle.json000066400000000000000000000007161523267620000312410ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [60, 30], "data_type": "int16", "chunk_grid": { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": [ [[10, 5], 5, 5], [15, 15] ] } }, "chunk_key_encoding": { "name": "default", "configuration": {"separator": "/"} }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/regular_grid_default_encoding.json000066400000000000000000000005741523267620000320600ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [100, 100], "data_type": "int32", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [10, 10]} }, "chunk_key_encoding": { "name": "default", "configuration": {"separator": "/"} }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/regular_grid_v2_encoding.json000066400000000000000000000005061523267620000307560ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [50], "data_type": "uint8", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [25]} }, "chunk_key_encoding": { "name": "v2", "configuration": {"separator": "."} }, "fill_value": 0, "codecs": [ {"name": "bytes"} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/sharding_indexed_codec.json000066400000000000000000000013161523267620000304670ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [1024, 1024], "data_type": "uint16", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [256, 256]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ { "name": "sharding_indexed", "configuration": { "chunk_shape": [64, 64], "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "gzip", "configuration": {"level": 1}} ], "index_codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "crc32c"} ], "index_location": "end" } } ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/test_fixtures.py000066400000000000000000000015241523267620000264230ustar00rootroot00000000000000"""Decode v3 array metadata fixtures via pydantic. Each `*.json` file in this directory is a representative on-disk `zarr.json` that should validate cleanly as `ZarrV3ArrayMetadataJSON`. Fixtures are named for the variant they exercise (regular vs rectilinear grid, blosc/gzip/zstd/sharding_indexed codecs, named-config dtypes, optional fields, extra fields). """ from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.array import ZarrV3ArrayMetadataJSON FIXTURES_DIR = Path(__file__).parent FIXTURES = sorted(FIXTURES_DIR.glob("*.json")) ADAPTER = TypeAdapter(ZarrV3ArrayMetadataJSON) @pytest.mark.parametrize("fixture", FIXTURES, ids=lambda p: p.stem) def test_validate(fixture: Path) -> None: ADAPTER.validate_python(json.loads(fixture.read_text())) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/transpose_and_crc32c_codecs.json000066400000000000000000000006701523267620000313540ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [10, 20, 30], "data_type": "float32", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [5, 10, 15]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": "NaN", "codecs": [ {"name": "transpose", "configuration": {"order": [2, 1, 0]}}, {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "crc32c"} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/with_extra_field.json000066400000000000000000000007131523267620000273540ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [10], "data_type": "int32", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [10]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ], "my_custom_extension": { "must_understand": false, "purpose": "exercise the extra_items=ZarrV3ExtensionField path" } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/with_optionals.json000066400000000000000000000010741523267620000270770ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [10, 20, 30], "data_type": "float64", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [5, 10, 15]} }, "chunk_key_encoding": { "name": "default", "configuration": {"separator": "/"} }, "fill_value": "NaN", "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ], "attributes": { "description": "fixture exercising optional fields", "tags": ["test", "metadata"] }, "dimension_names": ["t", "y", "x"], "storage_transformers": [] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/array/zstd_codec.json000066400000000000000000000005521523267620000261550ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "array", "shape": [128], "data_type": "int8", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [64]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ {"name": "bytes"}, {"name": "zstd", "configuration": {"level": 3, "checksum": false}} ] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/000077500000000000000000000000001523267620000241365ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/__init__.py000066400000000000000000000000001523267620000262350ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/rectilinear/000077500000000000000000000000001523267620000264375ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/rectilinear/__init__.py000066400000000000000000000000001523267620000305360ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/rectilinear/cases.json000066400000000000000000000010421523267620000304250ustar00rootroot00000000000000{ "explicit_per_dim": { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": [ [10, 20, 30, 40], [50] ] } }, "uniform_dim_shorthand": { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": [ [10, 20, 30, 40], 50 ] } }, "with_rle_pair": { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": [ [[10, 5], 5, 5], [15, 15] ] } } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/rectilinear/test_fixtures.py000066400000000000000000000010121523267620000317130ustar00rootroot00000000000000"""Validate rectilinear chunk grid fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.chunk_grid.rectilinear import RectilinearChunkGridMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_chunk_grid(case: object) -> None: TypeAdapter(RectilinearChunkGridMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/regular/000077500000000000000000000000001523267620000255775ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/regular/__init__.py000066400000000000000000000000001523267620000276760ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/regular/cases.json000066400000000000000000000004011523267620000275630ustar00rootroot00000000000000{ "1d": { "name": "regular", "configuration": {"chunk_shape": [10]} }, "2d": { "name": "regular", "configuration": {"chunk_shape": [10, 20]} }, "3d": { "name": "regular", "configuration": {"chunk_shape": [5, 10, 15]} } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_grid/regular/test_fixtures.py000066400000000000000000000007721523267620000310670ustar00rootroot00000000000000"""Validate regular chunk grid fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.chunk_grid.regular import RegularChunkGridMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_chunk_grid(case: object) -> None: TypeAdapter(RegularChunkGridMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/000077500000000000000000000000001523267620000256475ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/__init__.py000066400000000000000000000000001523267620000277460ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/default/000077500000000000000000000000001523267620000272735ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/default/__init__.py000066400000000000000000000000001523267620000313720ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/default/cases.json000066400000000000000000000004121523267620000312610ustar00rootroot00000000000000{ "no_configuration": { "name": "default" }, "slash_separator": { "name": "default", "configuration": {"separator": "/"} }, "dot_separator": { "name": "default", "configuration": {"separator": "."} }, "short_hand_name": "default" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/default/test_fixtures.py000066400000000000000000000010401523267620000325500ustar00rootroot00000000000000"""Validate default chunk-key encoding fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.chunk_key_encoding.default import DefaultChunkKeyEncodingMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_chunk_key_encoding(case: object) -> None: TypeAdapter(DefaultChunkKeyEncodingMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/v2/000077500000000000000000000000001523267620000261765ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/v2/__init__.py000066400000000000000000000000001523267620000302750ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/v2/cases.json000066400000000000000000000003661523267620000301740ustar00rootroot00000000000000{ "no_configuration": { "name": "v2" }, "dot_separator": { "name": "v2", "configuration": {"separator": "."} }, "slash_separator": { "name": "v2", "configuration": {"separator": "/"} }, "short_hand_name": "v2" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/chunk_key_encoding/v2/test_fixtures.py000066400000000000000000000010321523267620000314540ustar00rootroot00000000000000"""Validate v2-compatibility chunk-key encoding fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.chunk_key_encoding.v2 import V2ChunkKeyEncodingMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_chunk_key_encoding(case: object) -> None: TypeAdapter(V2ChunkKeyEncodingMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/000077500000000000000000000000001523267620000230765ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/__init__.py000066400000000000000000000000001523267620000251750ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/blosc/000077500000000000000000000000001523267620000242005ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/blosc/__init__.py000066400000000000000000000000001523267620000262770ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/blosc/cases.json000066400000000000000000000005451523267620000261750ustar00rootroot00000000000000{ "with_typesize": { "name": "blosc", "configuration": { "cname": "zstd", "clevel": 5, "shuffle": "shuffle", "blocksize": 0, "typesize": 4 } }, "no_typesize": { "name": "blosc", "configuration": { "cname": "lz4", "clevel": 1, "shuffle": "noshuffle", "blocksize": 0 } } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/blosc/test_fixtures.py000066400000000000000000000007331523267620000274650ustar00rootroot00000000000000"""Validate blosc codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.blosc import BloscCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(BloscCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/bytes/000077500000000000000000000000001523267620000242245ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/bytes/__init__.py000066400000000000000000000000001523267620000263230ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/bytes/cases.json000066400000000000000000000005011523267620000262110ustar00rootroot00000000000000{ "little_endian": { "name": "bytes", "configuration": {"endian": "little"} }, "big_endian": { "name": "bytes", "configuration": {"endian": "big"} }, "no_endian": { "name": "bytes", "configuration": {} }, "no_configuration": { "name": "bytes" }, "short_hand_name": "bytes" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/bytes/test_fixtures.py000066400000000000000000000007331523267620000275110ustar00rootroot00000000000000"""Validate bytes codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.bytes import BytesCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(BytesCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/cast_value/000077500000000000000000000000001523267620000252245ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/cast_value/__init__.py000066400000000000000000000000001523267620000273230ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/cast_value/cases.json000066400000000000000000000023361523267620000272210ustar00rootroot00000000000000{ "minimal": { "name": "cast_value", "configuration": {"data_type": "uint8"} }, "named_config_dtype": { "name": "cast_value", "configuration": { "data_type": { "name": "numpy.datetime64", "configuration": {"unit": "ns", "scale_factor": 1} } } }, "with_rounding": { "name": "cast_value", "configuration": { "data_type": "int16", "rounding": "towards-zero" } }, "with_out_of_range_clamp": { "name": "cast_value", "configuration": { "data_type": "int8", "out_of_range": "clamp" } }, "with_out_of_range_wrap": { "name": "cast_value", "configuration": { "data_type": "uint8", "out_of_range": "wrap" } }, "with_scalar_map_encode_only": { "name": "cast_value", "configuration": { "data_type": "uint8", "scalar_map": { "encode": [["NaN", 0]] } } }, "numpy_compat_full_example": { "name": "cast_value", "configuration": { "data_type": "uint8", "rounding": "towards-zero", "out_of_range": "wrap", "scalar_map": { "encode": [ ["NaN", 0], ["+Infinity", 0], ["-Infinity", 0] ] } } } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/cast_value/test_fixtures.py000066400000000000000000000007551523267620000305150ustar00rootroot00000000000000"""Validate cast_value codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.cast_value import CastValueCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(CastValueCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/crc32c/000077500000000000000000000000001523267620000241555ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/crc32c/__init__.py000066400000000000000000000000001523267620000262540ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/crc32c/cases.json000066400000000000000000000002421523267620000261440ustar00rootroot00000000000000{ "no_configuration": { "name": "crc32c" }, "empty_configuration": { "name": "crc32c", "configuration": {} }, "short_hand_name": "crc32c" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/crc32c/test_fixtures.py000066400000000000000000000007371523267620000274460ustar00rootroot00000000000000"""Validate crc32c codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.crc32c import Crc32cCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(Crc32cCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/gzip/000077500000000000000000000000001523267620000240475ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/gzip/__init__.py000066400000000000000000000000001523267620000261460ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/gzip/cases.json000066400000000000000000000001201523267620000260310ustar00rootroot00000000000000{ "with_level": { "name": "gzip", "configuration": {"level": 5} } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/gzip/test_fixtures.py000066400000000000000000000007271523267620000273370ustar00rootroot00000000000000"""Validate gzip codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.gzip import GzipCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(GzipCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/scale_offset/000077500000000000000000000000001523267620000255335ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/scale_offset/__init__.py000066400000000000000000000000001523267620000276320ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/scale_offset/cases.json000066400000000000000000000010611523267620000275220ustar00rootroot00000000000000{ "no_configuration": { "name": "scale_offset" }, "empty_configuration": { "name": "scale_offset", "configuration": {} }, "offset_only": { "name": "scale_offset", "configuration": {"offset": 5} }, "scale_only": { "name": "scale_offset", "configuration": {"scale": 0.1} }, "scale_and_offset": { "name": "scale_offset", "configuration": {"offset": 5, "scale": 0.1} }, "string_encoded_scalar": { "name": "scale_offset", "configuration": {"offset": "NaN"} }, "short_hand_name": "scale_offset" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/scale_offset/test_fixtures.py000066400000000000000000000007651523267620000310250ustar00rootroot00000000000000"""Validate scale_offset codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.scale_offset import ScaleOffsetCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(ScaleOffsetCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/sharding_indexed/000077500000000000000000000000001523267620000263755ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/sharding_indexed/__init__.py000066400000000000000000000000001523267620000304740ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/sharding_indexed/cases.json000066400000000000000000000014001523267620000303610ustar00rootroot00000000000000{ "with_index_location": { "name": "sharding_indexed", "configuration": { "chunk_shape": [64, 64], "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "gzip", "configuration": {"level": 1}} ], "index_codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "crc32c"} ], "index_location": "end" } }, "no_index_location": { "name": "sharding_indexed", "configuration": { "chunk_shape": [128], "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ], "index_codecs": [ {"name": "bytes", "configuration": {"endian": "little"}}, {"name": "crc32c"} ] } } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/sharding_indexed/test_fixtures.py000066400000000000000000000010051523267620000316530ustar00rootroot00000000000000"""Validate sharding_indexed codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.sharding_indexed import ShardingIndexedCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(ShardingIndexedCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/transpose/000077500000000000000000000000001523267620000251145ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/transpose/__init__.py000066400000000000000000000000001523267620000272130ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/transpose/cases.json000066400000000000000000000001361523267620000271050ustar00rootroot00000000000000{ "reversed_3d": { "name": "transpose", "configuration": {"order": [2, 1, 0]} } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/transpose/test_fixtures.py000066400000000000000000000007531523267620000304030ustar00rootroot00000000000000"""Validate transpose codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.transpose import TransposeCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(TransposeCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/zstd/000077500000000000000000000000001523267620000240625ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/zstd/__init__.py000066400000000000000000000000001523267620000261610ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/zstd/cases.json000066400000000000000000000001401523267620000260460ustar00rootroot00000000000000{ "default": { "name": "zstd", "configuration": {"level": 3, "checksum": false} } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/codec/zstd/test_fixtures.py000066400000000000000000000007271523267620000273520ustar00rootroot00000000000000"""Validate zstd codec fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.codec.zstd import ZstdCodecMetadata CASES: dict[str, object] = json.loads((Path(__file__).parent / "cases.json").read_text()) @pytest.mark.parametrize("case", CASES.values(), ids=list(CASES)) def test_codec(case: object) -> None: TypeAdapter(ZstdCodecMetadata).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/consolidated/000077500000000000000000000000001523267620000244715ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/consolidated/__init__.py000066400000000000000000000000001523267620000265700ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/consolidated/minimal.json000066400000000000000000000001051523267620000270060ustar00rootroot00000000000000{ "kind": "inline", "must_understand": false, "metadata": {} } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/consolidated/test_fixtures.py000066400000000000000000000010711523267620000277520ustar00rootroot00000000000000"""Decode v3 consolidated metadata fixtures via pydantic.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.consolidated import ZarrV3ConsolidatedMetadataJSON FIXTURES_DIR = Path(__file__).parent FIXTURES = sorted(FIXTURES_DIR.glob("*.json")) ADAPTER = TypeAdapter(ZarrV3ConsolidatedMetadataJSON) @pytest.mark.parametrize("fixture", FIXTURES, ids=lambda p: p.stem) def test_validate(fixture: Path) -> None: ADAPTER.validate_python(json.loads(fixture.read_text())) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/consolidated/with_array_and_group.json000066400000000000000000000010631523267620000315730ustar00rootroot00000000000000{ "kind": "inline", "must_understand": false, "metadata": { "child_group": { "zarr_format": 3, "node_type": "group" }, "child_array": { "zarr_format": 3, "node_type": "array", "shape": [10], "data_type": "int32", "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [10]} }, "chunk_key_encoding": { "name": "default" }, "fill_value": 0, "codecs": [ {"name": "bytes", "configuration": {"endian": "little"}} ] } } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/000077500000000000000000000000001523267620000237735ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/__init__.py000066400000000000000000000000001523267620000260720ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bool/000077500000000000000000000000001523267620000247265ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bool/__init__.py000066400000000000000000000000001523267620000270250ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bool/fill_values.json000066400000000000000000000000451523267620000301250ustar00rootroot00000000000000{ "true": true, "false": false } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bool/test_fixtures.py000066400000000000000000000007731523267620000302170ustar00rootroot00000000000000"""Validate bool fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.bool import BoolFillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(BoolFillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bytes/000077500000000000000000000000001523267620000251215ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bytes/__init__.py000066400000000000000000000000001523267620000272200ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bytes/fill_values.json000066400000000000000000000000551523267620000303210ustar00rootroot00000000000000{ "tuple": [1, 2, 3], "base64": "AQID" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bytes/test_fixtures.py000066400000000000000000000010171523267620000304020ustar00rootroot00000000000000"""Validate variable-length bytes fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.bytes import BytesFillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(BytesFillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/bytes/test_validators.py000066400000000000000000000022321523267620000307010ustar00rootroot00000000000000"""Cover the `base64_bytes` brand validator. The pydantic-driven fixture tests don't enforce the base64 alphabet or length-multiple-of-4 constraint because `Base64Bytes` is a `NewType`, which pydantic treats as plain `str`. Direct coverage of the validator function lives here. """ from __future__ import annotations import pytest from zarr_metadata.v3.data_type.bytes import base64_bytes VALID = [ "", # empty is valid base64 (length 0, multiple of 4) "AQID", # [1, 2, 3] "AAAA", # [0, 0, 0] "////", # [255, 255, 255] "abcd", "AB==", # padding "ABC=", # padding ] INVALID = [ "AB", # length 2, not multiple of 4 "ABC", # length 3, not multiple of 4 "ABCDE", # length 5 "AB-D", # url-safe alphabet, not standard "AB_D", # url-safe alphabet, not standard "AB!D", # not base64 char "AB CD", # whitespace ] @pytest.mark.parametrize("value", VALID) def test_valid(value: str) -> None: assert base64_bytes(value) == value @pytest.mark.parametrize("value", INVALID) def test_invalid(value: str) -> None: with pytest.raises(ValueError, match="standard-alphabet base64"): base64_bytes(value) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex128/000077500000000000000000000000001523267620000256755ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex128/__init__.py000066400000000000000000000000001523267620000277740ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex128/fill_values.json000066400000000000000000000003401523267620000310720ustar00rootroot00000000000000{ "numeric": [1.5, 2.5], "zero": [0.0, 0.0], "with_sentinel_components": ["-Infinity", "NaN"], "mixed_numeric_and_sentinel": [1.0, "Infinity"], "with_hex_components": ["0x7ff8000000000000", "0x0000000000000000"] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex128/test_fixtures.py000066400000000000000000000014361523267620000311630ustar00rootroot00000000000000"""Validate complex128 fill-value fixtures. A v3 complex fill_value is a two-element JSON array `[real, imag]` where each component is shaped per the corresponding float's fill value: a number, one of the named sentinels (`"NaN"`, `"Infinity"`, `"-Infinity"`), or a hex string of the underlying float's bits. """ from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.complex128 import Complex128FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Complex128FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex64/000077500000000000000000000000001523267620000256145ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex64/__init__.py000066400000000000000000000000001523267620000277130ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex64/fill_values.json000066400000000000000000000003201523267620000310070ustar00rootroot00000000000000{ "numeric": [1.5, 2.5], "zero": [0.0, 0.0], "with_sentinel_components": ["-Infinity", "NaN"], "mixed_numeric_and_sentinel": [1.0, "Infinity"], "with_hex_components": ["0x7fc00000", "0x00000000"] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/complex64/test_fixtures.py000066400000000000000000000014321523267620000310760ustar00rootroot00000000000000"""Validate complex64 fill-value fixtures. A v3 complex fill_value is a two-element JSON array `[real, imag]` where each component is shaped per the corresponding float's fill value: a number, one of the named sentinels (`"NaN"`, `"Infinity"`, `"-Infinity"`), or a hex string of the underlying float's bits. """ from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.complex64 import Complex64FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Complex64FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float16/000077500000000000000000000000001523267620000252475ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float16/__init__.py000066400000000000000000000000001523267620000273460ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float16/fill_values.json000066400000000000000000000002241523267620000304450ustar00rootroot00000000000000{ "zero": 0.0, "nan": "NaN", "infinity": "Infinity", "neg_infinity": "-Infinity", "hex_zero": "0x0000", "hex_signaling_nan": "0x7d00" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float16/test_fixtures.py000066400000000000000000000013401523267620000305270ustar00rootroot00000000000000"""Validate float16 fill-value fixtures. A v3 float fill_value is a JSON number, one of the named non-finite sentinels (`"NaN"`, `"Infinity"`, `"-Infinity"`), or a hex string (`"0xYYYY"`) encoding the unsigned-integer representation of the IEEE 754 value. """ from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.float16 import Float16FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Float16FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float16/test_validators.py000066400000000000000000000016011523267620000310260ustar00rootroot00000000000000"""Cover the `hex_float16` brand validator. The pydantic-driven fixture tests don't enforce hex format because `HexFloat16` is a `NewType`, which pydantic treats as plain `str`. Direct coverage of the validator function lives here. """ from __future__ import annotations import pytest from zarr_metadata.v3.data_type.float16 import hex_float16 VALID = ["0x0000", "0x7c00", "0x7d00", "0xffff", "0xFFFF", "0xAbCd"] INVALID = [ "", "0000", # missing 0x "0x000", # too short "0x00000", # too long "0x000g", # non-hex char "0X0000", # uppercase X " 0x0000 ", # whitespace ] @pytest.mark.parametrize("value", VALID) def test_valid(value: str) -> None: assert hex_float16(value) == value @pytest.mark.parametrize("value", INVALID) def test_invalid(value: str) -> None: with pytest.raises(ValueError, match="Expected '0x'"): hex_float16(value) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float32/000077500000000000000000000000001523267620000252455ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float32/__init__.py000066400000000000000000000000001523267620000273440ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float32/fill_values.json000066400000000000000000000003011523267620000304370ustar00rootroot00000000000000{ "zero": 0.0, "nan": "NaN", "infinity": "Infinity", "neg_infinity": "-Infinity", "hex_zero": "0x00000000", "hex_canonical_nan": "0x7fc00000", "hex_signaling_nan": "0x7fa00000" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float32/test_fixtures.py000066400000000000000000000010071523267620000305250ustar00rootroot00000000000000"""Validate float32 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.float32 import Float32FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Float32FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float32/test_validators.py000066400000000000000000000017561523267620000310370ustar00rootroot00000000000000"""Cover the `hex_float32` brand validator. The pydantic-driven fixture tests don't enforce hex format because `HexFloat32` is a `NewType`, which pydantic treats as plain `str`. Direct coverage of the validator function lives here. """ from __future__ import annotations import pytest from zarr_metadata.v3.data_type.float32 import hex_float32 VALID = [ "0x00000000", "0x7fc00000", # canonical NaN "0x7fa00000", # signaling NaN "0xffffffff", "0xFFFFFFFF", "0xDeadBeef", ] INVALID = [ "", "00000000", # missing 0x "0x0000000", # too short "0x000000000", # too long "0x0000000g", # non-hex char "0X00000000", # uppercase X " 0x00000000 ", # whitespace ] @pytest.mark.parametrize("value", VALID) def test_valid(value: str) -> None: assert hex_float32(value) == value @pytest.mark.parametrize("value", INVALID) def test_invalid(value: str) -> None: with pytest.raises(ValueError, match="Expected '0x'"): hex_float32(value) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float64/000077500000000000000000000000001523267620000252525ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float64/__init__.py000066400000000000000000000000001523267620000273510ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float64/fill_values.json000066400000000000000000000003311523267620000304470ustar00rootroot00000000000000{ "zero": 0.0, "nan": "NaN", "infinity": "Infinity", "neg_infinity": "-Infinity", "hex_zero": "0x0000000000000000", "hex_canonical_nan": "0x7ff8000000000000", "hex_signaling_nan": "0x7ff4000000000000" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float64/test_fixtures.py000066400000000000000000000010071523267620000305320ustar00rootroot00000000000000"""Validate float64 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.float64 import Float64FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Float64FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/float64/test_validators.py000066400000000000000000000021161523267620000310330ustar00rootroot00000000000000"""Cover the `hex_float64` brand validator. The pydantic-driven fixture tests don't enforce hex format because `HexFloat64` is a `NewType`, which pydantic treats as plain `str`. Direct coverage of the validator function lives here. """ from __future__ import annotations import pytest from zarr_metadata.v3.data_type.float64 import hex_float64 VALID = [ "0x0000000000000000", "0x7ff8000000000000", # canonical NaN "0x7ff4000000000000", # signaling NaN "0xffffffffffffffff", "0xFFFFFFFFFFFFFFFF", "0xDeadBeefCafeBabe", ] INVALID = [ "", "0000000000000000", # missing 0x "0x000000000000000", # too short "0x00000000000000000", # too long "0x000000000000000g", # non-hex char "0X0000000000000000", # uppercase X " 0x0000000000000000 ", # whitespace ] @pytest.mark.parametrize("value", VALID) def test_valid(value: str) -> None: assert hex_float64(value) == value @pytest.mark.parametrize("value", INVALID) def test_invalid(value: str) -> None: with pytest.raises(ValueError, match="Expected '0x'"): hex_float64(value) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int16/000077500000000000000000000000001523267620000247345ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int16/__init__.py000066400000000000000000000000001523267620000270330ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int16/fill_values.json000066400000000000000000000001031523267620000301260ustar00rootroot00000000000000{ "zero": 0, "min": -32768, "max": 32767, "negative": -1 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int16/test_fixtures.py000066400000000000000000000007771523267620000302310ustar00rootroot00000000000000"""Validate int16 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.int16 import Int16FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Int16FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int32/000077500000000000000000000000001523267620000247325ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int32/__init__.py000066400000000000000000000000001523267620000270310ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int32/fill_values.json000066400000000000000000000001151523267620000301270ustar00rootroot00000000000000{ "zero": 0, "min": -2147483648, "max": 2147483647, "negative": -1 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int32/test_fixtures.py000066400000000000000000000007771523267620000302270ustar00rootroot00000000000000"""Validate int32 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.int32 import Int32FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Int32FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int64/000077500000000000000000000000001523267620000247375ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int64/__init__.py000066400000000000000000000000001523267620000270360ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int64/fill_values.json000066400000000000000000000001371523267620000301400ustar00rootroot00000000000000{ "zero": 0, "min": -9223372036854775808, "max": 9223372036854775807, "negative": -1 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int64/test_fixtures.py000066400000000000000000000007771523267620000302340ustar00rootroot00000000000000"""Validate int64 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.int64 import Int64FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Int64FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int8/000077500000000000000000000000001523267620000246555ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int8/__init__.py000066400000000000000000000000001523267620000267540ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int8/fill_values.json000066400000000000000000000000771523267620000300610ustar00rootroot00000000000000{ "zero": 0, "min": -128, "max": 127, "negative": -1 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/int8/test_fixtures.py000066400000000000000000000007731523267620000301460ustar00rootroot00000000000000"""Validate int8 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.int8 import Int8FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Int8FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_datetime64/000077500000000000000000000000001523267620000271715ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_datetime64/__init__.py000066400000000000000000000000001523267620000312700ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_datetime64/data_type.json000066400000000000000000000001431523267620000320340ustar00rootroot00000000000000{ "name": "numpy.datetime64", "configuration": { "unit": "ns", "scale_factor": 1 } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_datetime64/fill_values.json000066400000000000000000000000431523267620000323660ustar00rootroot00000000000000{ "int": 12345, "nat": "NaT" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_datetime64/test_fixtures.py000066400000000000000000000013361523267620000324560ustar00rootroot00000000000000"""Validate numpy.datetime64 dtype value and fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.numpy_datetime64 import ( NumpyDatetime64, NumpyDatetime64FillValue, ) DIR = Path(__file__).parent FILL_VALUES: dict[str, object] = json.loads((DIR / "fill_values.json").read_text()) def test_data_type() -> None: TypeAdapter(NumpyDatetime64).validate_python(json.loads((DIR / "data_type.json").read_text())) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(NumpyDatetime64FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_timedelta64/000077500000000000000000000000001523267620000273455ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_timedelta64/__init__.py000066400000000000000000000000001523267620000314440ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_timedelta64/data_type.json000066400000000000000000000001431523267620000322100ustar00rootroot00000000000000{ "name": "numpy.timedelta64", "configuration": { "unit": "s", "scale_factor": 1 } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_timedelta64/fill_values.json000066400000000000000000000000401523267620000325370ustar00rootroot00000000000000{ "int": 42, "nat": "NaT" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/numpy_timedelta64/test_fixtures.py000066400000000000000000000016411523267620000326310ustar00rootroot00000000000000"""Validate numpy.timedelta64 dtype value and fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path from typing import get_args import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.numpy_timedelta64 import ( NUMPY_TIME_UNIT, NumpyTimedelta64, NumpyTimedelta64FillValue, NumpyTimeUnit, ) DIR = Path(__file__).parent FILL_VALUES: dict[str, object] = json.loads((DIR / "fill_values.json").read_text()) def test_data_type() -> None: TypeAdapter(NumpyTimedelta64).validate_python(json.loads((DIR / "data_type.json").read_text())) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(NumpyTimedelta64FillValue).validate_python(case) def test_time_unit_constant_matches_literal() -> None: assert set(NUMPY_TIME_UNIT) == set(get_args(NumpyTimeUnit)) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/raw/000077500000000000000000000000001523267620000245645ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/raw/__init__.py000066400000000000000000000000001523267620000266630ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/raw/fill_values.json000066400000000000000000000000471523267620000277650ustar00rootroot00000000000000{ "all_zero_4_bytes": [0, 0, 0, 0] } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/raw/test_fixtures.py000066400000000000000000000010201523267620000300370ustar00rootroot00000000000000"""Validate raw-bytes (`r`) fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.raw import RawBytesFillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(RawBytesFillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/raw/test_validators.py000066400000000000000000000020661523267620000303510ustar00rootroot00000000000000"""Cover the `raw_bytes_dtype_name` brand validator. The pydantic-driven fixture tests don't enforce the `r` shape because `RawBytesDataTypeName` is a `NewType`, which pydantic treats as plain `str`. Direct coverage of the validator function lives here. """ from __future__ import annotations import pytest from zarr_metadata.v3.data_type.raw import raw_bytes_dtype_name VALID = ["r8", "r16", "r24", "r256", "r1024"] INVALID_FORMAT = ["", "8", "R8", "r", "r-8", "r8 ", " r8", "r8r8"] INVALID_BITS = ["r0", "r1", "r7", "r9", "r15", "r17"] @pytest.mark.parametrize("value", VALID) def test_valid(value: str) -> None: assert raw_bytes_dtype_name(value) == value @pytest.mark.parametrize("value", INVALID_FORMAT) def test_invalid_format(value: str) -> None: with pytest.raises(ValueError, match="Expected 'r' followed by"): raw_bytes_dtype_name(value) @pytest.mark.parametrize("value", INVALID_BITS) def test_invalid_bit_count(value: str) -> None: with pytest.raises(ValueError, match="positive multiple of 8"): raw_bytes_dtype_name(value) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/string/000077500000000000000000000000001523267620000253015ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/string/__init__.py000066400000000000000000000000001523267620000274000ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/string/fill_values.json000066400000000000000000000001621523267620000305000ustar00rootroot00000000000000{ "empty": "", "ascii": "hello", "unicode": "héllo 世界", "with_escapes": "line1\nline2\t\"quoted\"" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/string/test_fixtures.py000066400000000000000000000010031523267620000305550ustar00rootroot00000000000000"""Validate string fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.string import StringFillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(StringFillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/struct/000077500000000000000000000000001523267620000253175ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/struct/__init__.py000066400000000000000000000000001523267620000274160ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/struct/data_type.json000066400000000000000000000005151523267620000301650ustar00rootroot00000000000000{ "name": "struct", "configuration": { "fields": [ {"name": "x", "data_type": "float32"}, {"name": "y", "data_type": "float32"}, { "name": "when", "data_type": { "name": "numpy.datetime64", "configuration": {"unit": "ns", "scale_factor": 1} } } ] } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/struct/fill_values.json000066400000000000000000000001041523267620000305120ustar00rootroot00000000000000{ "all_fields": { "x": 0.0, "y": 1.0, "when": 0 } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/struct/test_fixtures.py000066400000000000000000000012311523267620000305760ustar00rootroot00000000000000"""Validate struct dtype value and fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.struct import Struct, StructFillValue DIR = Path(__file__).parent FILL_VALUES: dict[str, object] = json.loads((DIR / "fill_values.json").read_text()) def test_data_type() -> None: TypeAdapter(Struct).validate_python(json.loads((DIR / "data_type.json").read_text())) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(StructFillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/test_dtype_names.py000066400000000000000000000062001523267620000277120ustar00rootroot00000000000000"""Validate every primitive Zarr v3 data-type name string. Primitive dtypes are encoded as bare strings in the `data_type` field of a v3 array metadata document (e.g. `"int32"`, `"float64"`). Each must validate as its declared per-dtype `*Name` literal type. """ from __future__ import annotations import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.bool import BOOL_DATA_TYPE_NAME, BoolDataTypeName from zarr_metadata.v3.data_type.bytes import BYTES_DATA_TYPE_NAME, BytesDataTypeName from zarr_metadata.v3.data_type.complex64 import COMPLEX64_DATA_TYPE_NAME, Complex64DataTypeName from zarr_metadata.v3.data_type.complex128 import COMPLEX128_DATA_TYPE_NAME, Complex128DataTypeName from zarr_metadata.v3.data_type.float16 import FLOAT16_DATA_TYPE_NAME, Float16DataTypeName from zarr_metadata.v3.data_type.float32 import FLOAT32_DATA_TYPE_NAME, Float32DataTypeName from zarr_metadata.v3.data_type.float64 import FLOAT64_DATA_TYPE_NAME, Float64DataTypeName from zarr_metadata.v3.data_type.int8 import INT8_DATA_TYPE_NAME, Int8DataTypeName from zarr_metadata.v3.data_type.int16 import INT16_DATA_TYPE_NAME, Int16DataTypeName from zarr_metadata.v3.data_type.int32 import INT32_DATA_TYPE_NAME, Int32DataTypeName from zarr_metadata.v3.data_type.int64 import INT64_DATA_TYPE_NAME, Int64DataTypeName from zarr_metadata.v3.data_type.raw import raw_bytes_dtype_name from zarr_metadata.v3.data_type.string import STRING_DATA_TYPE_NAME, StringDataTypeName from zarr_metadata.v3.data_type.uint8 import UINT8_DATA_TYPE_NAME, Uint8DataTypeName from zarr_metadata.v3.data_type.uint16 import UINT16_DATA_TYPE_NAME, Uint16DataTypeName from zarr_metadata.v3.data_type.uint32 import UINT32_DATA_TYPE_NAME, Uint32DataTypeName from zarr_metadata.v3.data_type.uint64 import UINT64_DATA_TYPE_NAME, Uint64DataTypeName # (name_string, per-dtype literal type) PRIMITIVE_DTYPES = [ (BOOL_DATA_TYPE_NAME, BoolDataTypeName), (INT8_DATA_TYPE_NAME, Int8DataTypeName), (INT16_DATA_TYPE_NAME, Int16DataTypeName), (INT32_DATA_TYPE_NAME, Int32DataTypeName), (INT64_DATA_TYPE_NAME, Int64DataTypeName), (UINT8_DATA_TYPE_NAME, Uint8DataTypeName), (UINT16_DATA_TYPE_NAME, Uint16DataTypeName), (UINT32_DATA_TYPE_NAME, Uint32DataTypeName), (UINT64_DATA_TYPE_NAME, Uint64DataTypeName), (FLOAT16_DATA_TYPE_NAME, Float16DataTypeName), (FLOAT32_DATA_TYPE_NAME, Float32DataTypeName), (FLOAT64_DATA_TYPE_NAME, Float64DataTypeName), (COMPLEX64_DATA_TYPE_NAME, Complex64DataTypeName), (COMPLEX128_DATA_TYPE_NAME, Complex128DataTypeName), (STRING_DATA_TYPE_NAME, StringDataTypeName), (BYTES_DATA_TYPE_NAME, BytesDataTypeName), ] @pytest.mark.parametrize(("name", "literal_type"), PRIMITIVE_DTYPES, ids=lambda x: str(x)) def test_primitive_against_literal(name: str, literal_type: object) -> None: """The dtype name validates against its declared Literal type.""" TypeAdapter(literal_type).validate_python(name) @pytest.mark.parametrize("raw_name", ["r8", "r16", "r24", "r256", "r1024"], ids=str) def test_raw_bytes_name(raw_name: str) -> None: """`r` names pass the raw_bytes_dtype_name validator.""" raw_bytes_dtype_name(raw_name) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint16/000077500000000000000000000000001523267620000251215ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint16/__init__.py000066400000000000000000000000001523267620000272200ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint16/fill_values.json000066400000000000000000000000401523267620000303130ustar00rootroot00000000000000{ "zero": 0, "max": 65535 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint16/test_fixtures.py000066400000000000000000000010031523267620000303750ustar00rootroot00000000000000"""Validate uint16 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.uint16 import Uint16FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Uint16FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint32/000077500000000000000000000000001523267620000251175ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint32/__init__.py000066400000000000000000000000001523267620000272160ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint32/fill_values.json000066400000000000000000000000451523267620000303160ustar00rootroot00000000000000{ "zero": 0, "max": 4294967295 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint32/test_fixtures.py000066400000000000000000000010031523267620000303730ustar00rootroot00000000000000"""Validate uint32 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.uint32 import Uint32FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Uint32FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint64/000077500000000000000000000000001523267620000251245ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint64/__init__.py000066400000000000000000000000001523267620000272230ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint64/fill_values.json000066400000000000000000000000571523267620000303260ustar00rootroot00000000000000{ "zero": 0, "max": 18446744073709551615 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint64/test_fixtures.py000066400000000000000000000010031523267620000304000ustar00rootroot00000000000000"""Validate uint64 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.uint64 import Uint64FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Uint64FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint8/000077500000000000000000000000001523267620000250425ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint8/__init__.py000066400000000000000000000000001523267620000271410ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint8/fill_values.json000066400000000000000000000000361523267620000302410ustar00rootroot00000000000000{ "zero": 0, "max": 255 } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/data_type/uint8/test_fixtures.py000066400000000000000000000007771523267620000303370ustar00rootroot00000000000000"""Validate uint8 fill-value fixtures.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.data_type.uint8 import Uint8FillValue FILL_VALUES: dict[str, object] = json.loads( (Path(__file__).parent / "fill_values.json").read_text() ) @pytest.mark.parametrize("case", FILL_VALUES.values(), ids=list(FILL_VALUES)) def test_fill_value(case: object) -> None: TypeAdapter(Uint8FillValue).validate_python(case) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/group/000077500000000000000000000000001523267620000231555ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/group/__init__.py000066400000000000000000000000001523267620000252540ustar00rootroot00000000000000zarr-python-3.3.0/packages/zarr-metadata/tests/v3/group/minimal.json000066400000000000000000000000571523267620000255000ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "group" } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/group/test_fixtures.py000066400000000000000000000010351523267620000264360ustar00rootroot00000000000000"""Decode v3 group metadata fixtures via pydantic.""" from __future__ import annotations import json from pathlib import Path import pytest from pydantic import TypeAdapter from zarr_metadata.v3.group import ZarrV3GroupMetadataJSON FIXTURES_DIR = Path(__file__).parent FIXTURES = sorted(FIXTURES_DIR.glob("*.json")) ADAPTER = TypeAdapter(ZarrV3GroupMetadataJSON) @pytest.mark.parametrize("fixture", FIXTURES, ids=lambda p: p.stem) def test_validate(fixture: Path) -> None: ADAPTER.validate_python(json.loads(fixture.read_text())) zarr-python-3.3.0/packages/zarr-metadata/tests/v3/group/with_attributes.json000066400000000000000000000002031523267620000272640ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "group", "attributes": { "label": "root", "spatial_units": ["meter", "meter"] } } zarr-python-3.3.0/packages/zarr-metadata/tests/v3/group/with_extra_field.json000066400000000000000000000002301523267620000273640ustar00rootroot00000000000000{ "zarr_format": 3, "node_type": "group", "consolidated_metadata": { "must_understand": false, "kind": "inline", "metadata": {} } } zarr-python-3.3.0/pyproject.toml000066400000000000000000000400341523267620000167320ustar00rootroot00000000000000[build-system] requires = ["hatchling>=1.29.0", "hatch-vcs"] build-backend = "hatchling.build" [tool.hatch.build.targets.sdist] exclude = [ "/.github", "/bench", "/docs", ] [project] name = "zarr" description = "An implementation of chunked, compressed, N-dimensional arrays for Python" readme = { file = "README.md", content-type = "text/markdown" } authors = [ { name = "Alistair Miles", email = "alimanfoo@googlemail.com" }, ] maintainers = [ { name = "Davis Bennett", email = "davis.v.bennett@gmail.com" }, { name = "jakirkham" }, { name = "Josh Moore", email = "josh@openmicroscopy.org" }, { name = "Joe Hamman", email = "joe@earthmover.io" }, { name = "Juan Nunez-Iglesias", email = "juan.nunez-iglesias@monash.edu" }, { name = "Martin Durant", email = "mdurant@anaconda.com" }, { name = "Norman Rzepka" }, { name = "Ryan Abernathey" }, { name = "David Stansby" }, { name = "Tom Augspurger", email = "tom.w.augspurger@gmail.com" }, { name = "Deepak Cherian" } ] requires-python = ">=3.12" dependencies = [ 'packaging>=22.0', 'numpy>=2', 'numcodecs>=0.14', 'google-crc32c>=1.5', 'typing_extensions>=4.14', 'donfig>=0.8', ] dynamic = [ "version", ] classifiers = [ 'Development Status :: 6 - Mature', 'Intended Audience :: Developers', 'Intended Audience :: Information Technology', 'Intended Audience :: Science/Research', 'Programming Language :: Python', 'Topic :: Software Development :: Libraries :: Python Modules', 'Operating System :: Unix', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.12', 'Programming Language :: Python :: 3.13', 'Programming Language :: Python :: 3.14', ] license = "MIT" license-files = ["LICENSE.txt"] keywords = ["Python", "compressed", "ndimensional-arrays", "zarr"] [project.optional-dependencies] # User-facing extras (shipped in package metadata) remote = [ "fsspec>=2023.10.0", "obstore>=0.5.1", ] gpu = [ "cupy-cuda12x; sys_platform != 'darwin'", ] cast-value-rs = ["cast-value-rs"] cli = ["typer"] optional = ["universal-pathlib"] [project.scripts] zarr = "zarr._cli.cli:app" [project.urls] issues = "https://github.com/zarr-developers/zarr-python/issues" changelog = "https://zarr.readthedocs.io/en/stable/release-notes.html" Discussions = "https://github.com/zarr-developers/zarr-python/discussions" documentation = "https://zarr.readthedocs.io/" homepage = "https://github.com/zarr-developers/zarr-python" # Dev *tooling* is pinned to exact versions for reproducible CI: the hatch envs # (see `tool.hatch.envs.*`) and bare `uv run` resolve these groups fresh from # PyPI and do NOT consult uv.lock, so an unrelated tooling release can break CI # without any change on our side (e.g. the pytest 9.1.0 `duplicate # parametrization` regression). Runtime/integration deps (fsspec, obstore, s3fs, # botocore, numcodecs, universal-pathlib) are intentionally left floating so the # `optional` test matrix keeps exercising their latest releases; their floor and # bleeding edge are covered by the `min_deps` and `upstream` hatch envs. Bump the # pins deliberately, e.g. via dependabot or `uv lock --upgrade`. [dependency-groups] test = [ "coverage==7.15.2", "pytest==9.1.1", "pytest-asyncio==1.4.0", "pytest-cov==7.1.0", "pytest-accept==0.3.0", "numpydoc==1.10.0", "hypothesis==6.160.0", "pytest-xdist==3.8.0", "pytest-benchmark==5.2.3", "pytest-codspeed==5.0.3", "tomlkit==0.15.1", "uv==0.11.31", ] remote-tests = [ {include-group = "test"}, "fsspec>=2023.10.0", "obstore>=0.5.1", "botocore", "s3fs>=2023.10.0", "moto[s3,server]==5.2.2", "requests==2.34.2", ] release = [ "towncrier==25.8.0", ] docs = [ # Doc building "mkdocs-material[imaging]==9.7.7", "mkdocs==1.6.1", "mkdocstrings==1.0.6", "mkdocstrings-python==2.0.5", "mike==2.2.0", "mkdocs-redirects==1.2.3", "markdown-exec[ansi]==1.12.3", "griffe-inherited-docstrings==1.1.3", "ruff==0.15.22", # Changelog generation {include-group = "release"}, # Optional dependencies to run examples "numcodecs[msgpack]", "s3fs>=2023.10.0", "astroid==4.1.2", "pytest==9.1.1", ] dev = [ {include-group = "test"}, {include-group = "remote-tests"}, {include-group = "docs"}, "universal-pathlib", "mypy==2.3.0", ] [tool.coverage.report] exclude_also = [ 'if TYPE_CHECKING:', ] [tool.coverage.run] omit = [ "bench/compress_normal.py", ] [tool.hatch] version.source = "vcs" # Only consider zarr-python's own `v*` tags when deriving the version. Without # this filter `git describe` matches the most recent tag of any shape, # including the `zarr_metadata-v*` tags used to release the zarr-metadata # subpackage — which would make a from-source build report a `0.2.x` version # instead of `3.x`. version.raw-options = { git_describe_command = "git describe --dirty --tags --long --match v*" } [tool.hatch.build] hooks.vcs.version-file = "src/zarr/_version.py" [tool.hatch.envs.dev] dependency-groups = ["dev"] [tool.hatch.envs.test] dependency-groups = ["test"] [tool.hatch.envs.test.env-vars] [[tool.hatch.envs.test.matrix]] python = ["3.12", "3.13", "3.14"] deps = ["minimal", "optional"] [tool.hatch.envs.test.overrides] matrix.deps.features = [ {value = "remote", if = ["optional"]}, {value = "optional", if = ["optional"]}, {value = "cli", if = ["optional"]}, {value = "cast-value-rs", if = ["optional"]}, ] matrix.deps.dependency-groups = [ {value = "remote-tests", if = ["optional"]}, ] [tool.hatch.envs.test.scripts] run-coverage = [ "coverage run --source=src -m pytest --ignore tests/benchmarks --junitxml=junit.xml -o junit_family=legacy {args:}", "coverage xml", ] run-coverage-html = [ "coverage run --source=src -m pytest --ignore tests/benchmarks {args:}", "coverage html", ] run = "pytest --ignore tests/benchmarks" run-verbose = "run-coverage --verbose" run-hypothesis = [ "coverage run --source=src -m pytest -nauto --run-slow-hypothesis tests/test_properties.py tests/test_store/test_stateful* {args:}", "coverage xml", ] run-benchmark = "pytest --benchmark-enable tests/benchmarks" serve-coverage-html = "python -m http.server -d htmlcov 8000" list-env = "pip list" [tool.hatch.envs.gputest] template = "test" extra-dependencies = [ "universal_pathlib", # Needed so tests/test_docs.py is collectable under `pytest -m gpu`; otherwise its # module-level importorskip("pytest_examples") skips the whole module and the gpu # docs example is never executed on GPU hardware. "pytest-examples", ] features = ["gpu"] [[tool.hatch.envs.gputest.matrix]] python = ["3.12", "3.13"] [tool.hatch.envs.gputest.scripts] run-coverage = [ "coverage run --source=src -m pytest -m gpu --junitxml=junit.xml -o junit_family=legacy --ignore tests/benchmarks {args:}", "coverage xml", ] run = "pytest -m gpu --ignore tests/benchmarks" [tool.hatch.envs.upstream] template = 'test' python = "3.14" extra-dependencies = [ 'packaging @ git+https://github.com/pypa/packaging', 'numpy', # from scientific-python-nightly-wheels 'numcodecs @ git+https://github.com/zarr-developers/numcodecs', 's3fs @ git+https://github.com/fsspec/s3fs', 'universal_pathlib @ git+https://github.com/fsspec/universal_pathlib', 'typing_extensions @ git+https://github.com/python/typing_extensions', 'donfig @ git+https://github.com/pytroll/donfig', 'obstore @ git+https://github.com/developmentseed/obstore@main#subdirectory=obstore', ] [tool.hatch.envs.upstream.env-vars] PIP_INDEX_URL = "https://pypi.anaconda.org/scientific-python-nightly-wheels/simple/" PIP_EXTRA_INDEX_URL = "https://pypi.org/simple/" PIP_PRE = "1" [tool.hatch.envs.min_deps] description = """Test environment for minimum supported dependencies See Spec 0000 for details and drop schedule: https://scientific-python.org/specs/spec-0000/ """ template = "test" python = "3.12" features = ["remote"] dependency-groups = ["remote-tests"] extra-dependencies = [ 'packaging==22.*', 'numpy==2.0.*', 'numcodecs==0.14.*', # 0.14 needed for zarr3 codecs 'fsspec==2023.10.0', 's3fs==2023.10.0', 'universal_pathlib==0.2.0', 'typing_extensions==4.14.*', 'donfig==0.8.*', 'obstore==0.5.*', ] [tool.hatch.envs.default] installer = "uv" [tool.hatch.envs.docs] features = ['remote'] dependency-groups = ['docs'] [tool.hatch.envs.docs.env-vars] DISABLE_MKDOCS_2_WARNING = "true" NO_MKDOCS_2_WARNING = "true" [tool.hatch.envs.docs.scripts] serve = "mkdocs serve --watch src" build = "mkdocs build" check = "mkdocs build --strict" readthedocs = "rm -rf $READTHEDOCS_OUTPUT/html && cp -r site $READTHEDOCS_OUTPUT/html" [tool.hatch.envs.doctest] description = "Test environment for validating executable code blocks in documentation" features = ['remote'] dependency-groups = ['remote-tests'] extra-dependencies = [ "pytest-examples", ] [tool.hatch.envs.doctest.scripts] test = "pytest tests/test_docs.py -v" list-env = "pip list" [tool.ruff] line-length = 100 force-exclude = true extend-exclude = [ ".bzr", ".direnv", ".eggs", ".git", ".mypy_cache", ".nox", ".pants.d", ".ruff_cache", ".venv", "__pypackages__", "_build", "buck-out", "build", "dist", "venv", "docs", "tests/test_regression/scripts/", # these are scripts that use a different version of python "src/zarr/v2/", "tests/v2/", ] [tool.ruff.lint] extend-select = [ "ANN", # flake8-annotations "B", # flake8-bugbear "C4", # flake8-comprehensions "EXE", # flake8-executable "FA", # flake8-future-annotations "FLY", # flynt "FURB", # refurb "G", # flake8-logging-format "I", # isort "ISC", # flake8-implicit-str-concat "LOG", # flake8-logging "PERF", # Perflint "PIE", # flake8-pie "PGH", # pygrep-hooks "PT", # flake8-pytest-style "PYI", # flake8-pyi "RET", # flake8-return "RSE", # flake8-raise "RUF", "SIM", # flake8-simplify "SLOT", # flake8-slots "TC", # flake8-type-checking "TRY", # tryceratops "UP", # pyupgrade "W", # pycodestyle warnings ] ignore = [ "ANN401", "PT011", # TODO: apply this rule "RET505", "RET506", "RUF005", "RUF043", "SIM108", "TRY003", # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules "W191", "E111", "E114", "E117", "D206", "D300", "Q000", "Q001", "Q002", "Q003", "COM812", "COM819", "TC006", ] [tool.ruff.lint.extend-per-file-ignores] "tests/**" = ["ANN001", "ANN201", "RUF029", "SIM117", "SIM300"] [tool.mypy] files = ["src", "tests"] python_version = "3.12" ignore_missing_imports = true namespace_packages = false pretty = true show_error_code_links = true show_error_context = true strict = true warn_unreachable = true enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool", "truthy-iterable"] [[tool.mypy.overrides]] module = [ "tests.package_with_entrypoint.*", "zarr.testing.stateful", "tests.test_codecs.test_transpose", "tests.test_config", "tests.test_store.test_zip", "tests.test_store.test_local", "tests.test_store.test_memory", "tests.test_codecs.test_codecs", "tests.test_metadata.*", "tests.test_store.test_core", "tests.test_store.test_logging", "tests.test_store.test_object", "tests.test_store.test_stateful", "tests.test_store.test_wrapper", ] strict = false # TODO: Move the next modules up to the strict = false section # and fix the errors [[tool.mypy.overrides]] module = [ "tests.test_store.test_fsspec", "tests.test_group", "tests.test_indexing", "tests.test_properties", "tests.test_sync", "tests.test_regression.scripts.*" ] ignore_errors = true [tool.pytest.ini_options] minversion = "9" testpaths = ["src", "tests", "docs/user-guide"] log_cli_level = "INFO" log_level = "INFO" # Enables strict_config, strict_markers, strict_xfail, strict_parametrization_ids, and # any strictness options added in future pytest releases. Note that the equivalent # `--strict-config`/`--strict-markers` flags were silently ignored when passed via # addopts before pytest 9.1 (pytest#14442), so this option is the reliable spelling. strict = true # Turn deadlocks into loud failures: if a single test exceeds this many seconds, dump # every thread's traceback and kill the run (exit_on_timeout is new in pytest 9). Sized # far above the slowest legitimate test (~20s locally; slower under coverage/Windows/ # nightly stateful-hypothesis runs) so only a genuine hang can trip it. faulthandler_timeout = 600 faulthandler_exit_on_timeout = true asyncio_mode = "auto" asyncio_default_fixture_loop_scope = "function" doctest_optionflags = [ "NORMALIZE_WHITESPACE", "ELLIPSIS", "IGNORE_EXCEPTION_DETAIL", ] addopts = [ "--benchmark-columns", "min,mean,stddev,outliers,rounds,iterations", "--benchmark-disable", # benchmark routines run as tests without benchmarking instrumentation "--durations", "10", "-ra", "--doctest-modules", "--ignore=tests/test_regression/scripts", "--ignore=src/zarr/_cli", ] filterwarnings = [ "error", "ignore:Unclosed client session None: """ Print version info for use in bug reports. """ import platform from importlib.metadata import version def print_packages(packages: list[str]) -> None: not_installed = [] for package in packages: try: print(f"{package}: {version(package)}") except ModuleNotFoundError: not_installed.append(package) if not_installed: print("\n**Not Installed:**") for package in not_installed: print(package) required = [ "packaging", "numpy", "numcodecs", "typing_extensions", "donfig", ] optional = [ "botocore", "cupy-cuda12x", "fsspec", "numcodecs", "s3fs", "gcsfs", "universal-pathlib", "obstore", ] print(f"platform: {platform.platform()}") print(f"python: {platform.python_version()}") print(f"zarr: {__version__}\n") print("**Required dependencies:**") print_packages(required) print("\n**Optional dependencies:**") print_packages(optional) # The decorator ensures this always returns the same handler (and it is only # attached once). @functools.cache def _ensure_handler() -> logging.Handler: """ The first time this function is called, attach a `StreamHandler` using the same format as `logging.basicConfig` to the Zarr-Python root logger. Return this handler every time this function is called. """ handler = logging.StreamHandler() handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT)) _logger.addHandler(handler) return handler def set_log_level( level: Literal["NOTSET", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], ) -> None: """Set the logging level for Zarr-Python. Zarr-Python uses the standard library `logging` framework under the root logger 'zarr'. This is a helper function to: - set Zarr-Python's root logger level - set the root logger handler's level, creating the handler if it does not exist yet Parameters ---------- level : str The logging level to set. """ _logger.setLevel(level) _ensure_handler().setLevel(level) def set_format(log_format: str) -> None: """Set the format of logging messages from Zarr-Python. Zarr-Python uses the standard library `logging` framework under the root logger 'zarr'. This sets the format of log messages from the root logger's StreamHandler. Parameters ---------- log_format : str A string determining the log format (as defined in the standard library's `logging` module for logging.Formatter) """ _ensure_handler().setFormatter(logging.Formatter(fmt=log_format)) __all__ = [ "Array", "AsyncArray", "AsyncGroup", "Group", "__version__", "array", "config", "consolidate_metadata", "copy", "copy_all", "copy_store", "create", "create_array", "create_group", "create_hierarchy", "empty", "empty_like", "from_array", "full", "full_like", "group", "load", "ones", "ones_like", "open", "open_array", "open_consolidated", "open_group", "open_like", "print_debug_info", "save", "save_array", "save_group", "tree", "zeros", "zeros_like", ] zarr-python-3.3.0/src/zarr/_cli/000077500000000000000000000000001523267620000164705ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/_cli/__init__.py000066400000000000000000000000001523267620000205670ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/_cli/cli.py000066400000000000000000000133341523267620000176150ustar00rootroot00000000000000import logging from enum import StrEnum from typing import Annotated, Literal, cast import typer import zarr import zarr.metadata.migrate_v3 as migrate_metadata from zarr.core.common import ZarrFormat from zarr.core.sync import sync from zarr.storage._common import make_store app = typer.Typer() logger = logging.getLogger(__name__) def _set_logging_level(*, verbose: bool) -> None: if verbose: lvl = "INFO" else: lvl = "WARNING" zarr.set_log_level(cast(Literal["INFO", "WARNING"], lvl)) zarr.set_format("%(message)s") class CLIZarrFormat(StrEnum): v2 = "v2" v3 = "v3" class CLIZarrFormatV3(StrEnum): """Limit CLI choice to only v3""" v3 = "v3" @app.command() # type: ignore[untyped-decorator] def migrate( zarr_format: Annotated[ CLIZarrFormatV3, typer.Argument( help="Zarr format to migrate to. Currently only 'v3' is supported.", ), ], input_store: Annotated[ str, typer.Argument( help=( "Input Zarr to migrate - should be a store, path to directory in file system or name of zip file " "e.g. 'data/example-1.zarr', 's3://example-bucket/example'..." ) ), ], output_store: Annotated[ str | None, typer.Argument( help=( "Output location to write generated metadata (no array data will be copied). If not provided, " "metadata will be written to input_store. Should be a store, path to directory in file system " "or name of zip file e.g. 'data/example-1.zarr', 's3://example-bucket/example'..." ) ), ] = None, dry_run: Annotated[ bool, typer.Option( help="Enable a dry-run: files that would be converted are logged, but no new files are created or changed." ), ] = False, overwrite: Annotated[ bool, typer.Option( help="Remove any existing v3 metadata at the output location, before migration starts." ), ] = False, force: Annotated[ bool, typer.Option( help=( "Only used when --overwrite is given. Allows v3 metadata to be removed when no valid " "v2 metadata exists at the output location." ) ), ] = False, remove_v2_metadata: Annotated[ bool, typer.Option( help="Remove v2 metadata (if any) from the output location, after migration is complete." ), ] = False, ) -> None: """Migrate all v2 metadata in a zarr hierarchy to v3. This will create a zarr.json file for each level (every group / array). v2 files (.zarray, .zattrs etc.) will be left as-is. """ if dry_run: _set_logging_level(verbose=True) logger.info( "Dry run enabled - no new files will be created or changed. Log of files that would be created on a real run:" ) input_zarr_store = sync(make_store(input_store, mode="r+")) if output_store is not None: output_zarr_store = sync(make_store(output_store, mode="w-")) write_store = output_zarr_store else: output_zarr_store = None write_store = input_zarr_store if overwrite: sync(migrate_metadata.remove_metadata(write_store, 3, force=force, dry_run=dry_run)) migrate_metadata.migrate_v2_to_v3( input_store=input_zarr_store, output_store=output_zarr_store, dry_run=dry_run ) if remove_v2_metadata: # There should always be valid v3 metadata at the output location after migration, so force=False sync(migrate_metadata.remove_metadata(write_store, 2, force=False, dry_run=dry_run)) @app.command() # type: ignore[untyped-decorator] def remove_metadata( zarr_format: Annotated[ CLIZarrFormat, typer.Argument(help="Which format's metadata to remove - v2 or v3."), ], store: Annotated[ str, typer.Argument( help="Store or path to directory in file system or name of zip file e.g. 'data/example-1.zarr', 's3://example-bucket/example'..." ), ], force: Annotated[ bool, typer.Option( help=( "Allow metadata to be deleted when no valid alternative exists e.g. allow deletion of v2 metadata, " "when no v3 metadata is present." ) ), ] = False, dry_run: Annotated[ bool, typer.Option( help="Enable a dry-run: files that would be deleted are logged, but no files are removed or changed." ), ] = False, ) -> None: """Remove all v2 (.zarray, .zattrs, .zgroup, .zmetadata) or v3 (zarr.json) metadata files from the given Zarr. Note - this will remove metadata files at all levels of the hierarchy (every group and array). """ if dry_run: _set_logging_level(verbose=True) logger.info( "Dry run enabled - no files will be deleted or changed. Log of files that would be deleted on a real run:" ) input_zarr_store = sync(make_store(store, mode="r+")) sync( migrate_metadata.remove_metadata( store=input_zarr_store, zarr_format=cast(ZarrFormat, int(zarr_format[1:])), force=force, dry_run=dry_run, ) ) @app.callback() # type: ignore[untyped-decorator] def main( verbose: Annotated[ bool, typer.Option( help="enable verbose logging - will print info about metadata files being deleted / saved." ), ] = False, ) -> None: """ See available commands below - access help for individual commands with zarr COMMAND --help. """ _set_logging_level(verbose=verbose) if __name__ == "__main__": app() zarr-python-3.3.0/src/zarr/_compat.py000066400000000000000000000066771523267620000175760ustar00rootroot00000000000000import warnings from collections.abc import Callable from functools import wraps from inspect import Parameter, signature from typing import TYPE_CHECKING, Any import numpy as np from packaging.version import Version from zarr.errors import ZarrFutureWarning if TYPE_CHECKING: from numpy.typing import NDArray # Based off https://github.com/scikit-learn/scikit-learn/blob/e87b32a81c70abed8f2e97483758eb64df8255e9/sklearn/utils/validation.py#L63 def _deprecate_positional_args[T]( func: Callable[..., T] | None = None, *, version: str = "3.1.0" ) -> Callable[..., T]: """Decorator for methods that issues warnings for positional arguments. Using the keyword-only argument syntax in pep 3102, arguments after the * will issue a warning when passed as a positional argument. Parameters ---------- func : callable, default=None Function to check arguments on. version : callable, default="3.1.0" The version when positional arguments will result in error. """ def _inner_deprecate_positional_args(f: Callable[..., T]) -> Callable[..., T]: sig = signature(f) kwonly_args = [] all_args = [] for name, param in sig.parameters.items(): if param.kind == Parameter.POSITIONAL_OR_KEYWORD: all_args.append(name) elif param.kind == Parameter.KEYWORD_ONLY: kwonly_args.append(name) @wraps(f) def inner_f(*args: Any, **kwargs: Any) -> T: extra_args = len(args) - len(all_args) if extra_args <= 0: return f(*args, **kwargs) # extra_args > 0 args_msg = [ f"{name}={arg}" for name, arg in zip(kwonly_args[:extra_args], args[-extra_args:], strict=False) ] formatted_args_msg = ", ".join(args_msg) warnings.warn( ( f"Pass {formatted_args_msg} as keyword args. From version " f"{version} passing these as positional arguments " "will result in an error" ), ZarrFutureWarning, stacklevel=2, ) kwargs.update(zip(sig.parameters, args, strict=False)) return f(**kwargs) return inner_f if func is not None: return _inner_deprecate_positional_args(func) return _inner_deprecate_positional_args # type: ignore[return-value] def _reshape_view(arr: "NDArray[Any]", shape: tuple[int, ...]) -> "NDArray[Any]": """Reshape an array without copying data. This function provides compatibility across NumPy versions for reshaping arrays as views. On NumPy >= 2.1, it uses ``reshape(copy=False)`` which explicitly fails if a view cannot be created. On older versions, it uses direct shape assignment which has the same behavior but is deprecated in 2.5+. Parameters ---------- arr : NDArray The array to reshape. shape : tuple of int The new shape. Returns ------- NDArray A reshaped view of the array. Raises ------ AttributeError If a view cannot be created (the array is not contiguous) on NumPy < 2.1. ValueError If a view cannot be created (the array is not contiguous) on NumPy >= 2.1. """ if Version(np.__version__) >= Version("2.1"): return arr.reshape(shape, copy=False) else: arr.shape = shape return arr zarr-python-3.3.0/src/zarr/abc/000077500000000000000000000000001523267620000163075ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/abc/__init__.py000066400000000000000000000000001523267620000204060ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/abc/buffer.py000066400000000000000000000003041523267620000201270ustar00rootroot00000000000000from zarr.core.buffer.core import ArrayLike, Buffer, BufferPrototype, NDArrayLike, NDBuffer __all__ = [ "ArrayLike", "Buffer", "BufferPrototype", "NDArrayLike", "NDBuffer", ] zarr-python-3.3.0/src/zarr/abc/codec.py000066400000000000000000000426301523267620000177430ustar00rootroot00000000000000from __future__ import annotations from abc import abstractmethod from collections.abc import Mapping from typing import TYPE_CHECKING, Literal, Protocol, TypeGuard, runtime_checkable from typing_extensions import ReadOnly, TypedDict from zarr.abc.metadata import Metadata from zarr.core.buffer import Buffer, NDBuffer from zarr.core.common import NamedConfig, concurrent_map from zarr.core.config import config if TYPE_CHECKING: from collections.abc import Awaitable, Callable, Iterable from typing import Self from zarr.abc.store import ByteGetter, ByteSetter, Store from zarr.core.array_spec import ArraySpec from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.core.indexing import SelectorTuple from zarr.core.metadata import ArrayMetadata from zarr.core.metadata.v3 import ChunkGridMetadata __all__ = [ "ArrayArrayCodec", "ArrayBytesCodec", "ArrayBytesCodecPartialDecodeMixin", "ArrayBytesCodecPartialEncodeMixin", "BaseCodec", "BytesBytesCodec", "CodecInput", "CodecOutput", "CodecPipeline", "GetResult", "SupportsSyncCodec", ] class GetResult(TypedDict): """Metadata about a store get operation.""" status: Literal["present", "missing"] type CodecInput = NDBuffer | Buffer type CodecOutput = NDBuffer | Buffer class CodecJSON_V2[TName: str](TypedDict): """The JSON representation of a codec for Zarr V2""" id: ReadOnly[TName] def _check_codecjson_v2(data: object) -> TypeGuard[CodecJSON_V2[str]]: return isinstance(data, Mapping) and "id" in data and isinstance(data["id"], str) CodecJSON_V3 = str | NamedConfig[str, Mapping[str, object]] """The JSON representation of a codec for Zarr V3.""" # The widest type we will *accept* for a codec JSON # This covers v2 and v3 CodecJSON = str | Mapping[str, object] """The widest type of JSON-like input that could specify a codec.""" @runtime_checkable class SupportsSyncCodec[CI: CodecInput, CO: CodecOutput](Protocol): """Protocol for codecs that support synchronous encode/decode. Codecs implementing this protocol provide `_decode_sync` and `_encode_sync` methods that perform encoding/decoding without requiring an async event loop. The type parameters mirror `BaseCodec`: `CI` is the decoded type and `CO` is the encoded type. """ def _decode_sync(self, chunk_data: CO, chunk_spec: ArraySpec) -> CI: ... def _encode_sync(self, chunk_data: CI, chunk_spec: ArraySpec) -> CO | None: ... def _codec_supports_sync(codec: object) -> bool: """Whether `codec` can actually run on a synchronous (no event loop) path. Structural membership in `SupportsSyncCodec` is necessary but not always sufficient: a codec can provide `_decode_sync`/`_encode_sync` whose ability to run depends on runtime configuration the type system cannot see. `ShardingCodec` is the canonical case — its sync methods delegate to its configured inner and index codec chains, so they only work when every codec in those chains is itself sync-capable. Such codecs opt out dynamically via a `_sync_capable` attribute/property (absent means capable). """ return isinstance(codec, SupportsSyncCodec) and getattr(codec, "_sync_capable", True) class BaseCodec[CI: CodecInput, CO: CodecOutput](Metadata): """Generic base class for codecs. Codecs can be registered via zarr.codecs.registry. Warnings -------- This class is not intended to be directly, please use ArrayArrayCodec, ArrayBytesCodec or BytesBytesCodec for subclassing. """ # Whether this codec's encoded output is a fixed size given a fixed input # size. Defaults to False (the conservative answer): a codec that does not # explicitly opt in is treated as variable-size, which only disables # size-dependent fast paths (e.g. the sharding bulk-decode), never # correctness. Codecs with genuinely fixed-size output (BytesCodec, # TransposeCodec, ...) override this with True. The default also keeps # third-party / variable-length codecs (VLenUTF8, numcodecs wrappers) that # never set the attribute from raising AttributeError where it is read. is_fixed_size: bool = False @abstractmethod def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: """Given an input byte length, this method returns the output byte length. Raises a NotImplementedError for codecs with variable-sized outputs (e.g. compressors). Parameters ---------- input_byte_length : int chunk_spec : ArraySpec Returns ------- int """ ... def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: """Computed the spec of the chunk after it has been encoded by the codec. This is important for codecs that change the shape, data type or fill value of a chunk. The spec will then be used for subsequent codecs in the pipeline. Parameters ---------- chunk_spec : ArraySpec Returns ------- ArraySpec """ return chunk_spec def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: """Fills in codec configuration parameters that can be automatically inferred from the array metadata. Parameters ---------- array_spec : ArraySpec Returns ------- Self """ return self def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: """Validates that the codec configuration is compatible with the array metadata. Raises errors when the codec configuration is not compatible. Parameters ---------- shape : tuple[int, ...] The array shape dtype : np.dtype[Any] The array data type chunk_grid : ChunkGridMetadata The array chunk grid metadata """ async def _decode_single(self, chunk_data: CO, chunk_spec: ArraySpec) -> CI: raise NotImplementedError # pragma: no cover async def decode( self, chunks_and_specs: Iterable[tuple[CO | None, ArraySpec]], ) -> Iterable[CI | None]: """Decodes a batch of chunks. Chunks can be None in which case they are ignored by the codec. Parameters ---------- chunks_and_specs : Iterable[tuple[CodecOutput | None, ArraySpec]] Ordered set of encoded chunks with their accompanying chunk spec. Returns ------- Iterable[CI | None] """ return await _batching_helper(self._decode_single, chunks_and_specs) async def _encode_single(self, chunk_data: CI, chunk_spec: ArraySpec) -> CO | None: raise NotImplementedError # pragma: no cover async def encode( self, chunks_and_specs: Iterable[tuple[CI | None, ArraySpec]], ) -> Iterable[CO | None]: """Encodes a batch of chunks. Chunks can be None in which case they are ignored by the codec. Parameters ---------- chunks_and_specs : Iterable[tuple[CI | None, ArraySpec]] Ordered set of to-be-encoded chunks with their accompanying chunk spec. Returns ------- Iterable[CodecOutput | None] """ return await _batching_helper(self._encode_single, chunks_and_specs) class ArrayArrayCodec(BaseCodec[NDBuffer, NDBuffer]): """Base class for array-to-array codecs.""" class ArrayBytesCodec(BaseCodec[NDBuffer, Buffer]): """Base class for array-to-bytes codecs.""" class BytesBytesCodec(BaseCodec[Buffer, Buffer]): """Base class for bytes-to-bytes codecs.""" Codec = ArrayArrayCodec | ArrayBytesCodec | BytesBytesCodec class ArrayBytesCodecPartialDecodeMixin: """Mixin for array-to-bytes codecs that implement partial decoding.""" async def _decode_partial_single( self, byte_getter: ByteGetter, selection: SelectorTuple, chunk_spec: ArraySpec ) -> NDBuffer | None: raise NotImplementedError async def decode_partial( self, batch_info: Iterable[tuple[ByteGetter, SelectorTuple, ArraySpec]], ) -> Iterable[NDBuffer | None]: """Partially decodes a batch of chunks. This method determines parts of a chunk from the slice selection, fetches these parts from the store (via ByteGetter) and decodes them. Parameters ---------- batch_info : Iterable[tuple[ByteGetter, SelectorTuple, ArraySpec]] Ordered set of information about slices of encoded chunks. The slice selection determines which parts of the chunk will be fetched. The ByteGetter is used to fetch the necessary bytes. The chunk spec contains information about the construction of an array from the bytes. Returns ------- Iterable[NDBuffer | None] """ return await concurrent_map( list(batch_info), self._decode_partial_single, config.get("async.concurrency"), ) class ArrayBytesCodecPartialEncodeMixin: """Mixin for array-to-bytes codecs that implement partial encoding.""" async def _encode_partial_single( self, byte_setter: ByteSetter, chunk_array: NDBuffer, selection: SelectorTuple, chunk_spec: ArraySpec, ) -> None: raise NotImplementedError # pragma: no cover async def encode_partial( self, batch_info: Iterable[tuple[ByteSetter, NDBuffer, SelectorTuple, ArraySpec]], ) -> None: """Partially encodes a batch of chunks. This method determines parts of a chunk from the slice selection, encodes them and writes these parts to the store (via ByteSetter). If merging with existing chunk data in the store is necessary, this method will read from the store first and perform the merge. Parameters ---------- batch_info : Iterable[tuple[ByteSetter, NDBuffer, SelectorTuple, ArraySpec]] Ordered set of information about slices of to-be-encoded chunks. The slice selection determines which parts of the chunk will be encoded. The ByteSetter is used to write the necessary bytes and fetch bytes for existing chunk data. The chunk spec contains information about the chunk. """ await concurrent_map( list(batch_info), self._encode_partial_single, config.get("async.concurrency"), ) class CodecPipeline: """Base class for implementing CodecPipeline. A CodecPipeline implements the read and write paths for chunk data. On the read path, it is responsible for fetching chunks from a store (via ByteGetter), decoding them and assembling an output array. On the write path, it encodes the chunks and writes them to a store (via ByteSetter).""" @abstractmethod def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: """Fills in codec configuration parameters that can be automatically inferred from the array metadata. Parameters ---------- array_spec : ArraySpec Returns ------- Self """ ... @classmethod @abstractmethod def from_codecs(cls, codecs: Iterable[Codec]) -> Self: """Creates a codec pipeline from an iterable of codecs. Parameters ---------- codecs : Iterable[Codec] Returns ------- Self """ ... @classmethod def from_array_metadata_and_store(cls, array_metadata: ArrayMetadata, store: Store) -> Self: """Creates a codec pipeline from array metadata and a store path. Raises NotImplementedError by default, indicating the CodecPipeline must be created with from_codecs instead. Parameters ---------- array_metadata : ArrayMetadata store : Store Returns ------- Self """ raise NotImplementedError( f"'{type(cls).__name__}' does not implement CodecPipeline.from_array_metadata_and_store." ) @property @abstractmethod def supports_partial_decode(self) -> bool: ... @property @abstractmethod def supports_partial_encode(self) -> bool: ... @abstractmethod def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: """Validates that all codec configurations are compatible with the array metadata. Raises errors when a codec configuration is not compatible. Parameters ---------- shape : tuple[int, ...] The array shape dtype : np.dtype[Any] The array data type chunk_grid : ChunkGridMetadata The array chunk grid metadata """ ... @abstractmethod def compute_encoded_size(self, byte_length: int, array_spec: ArraySpec) -> int: """Given an input byte length, this method returns the output byte length. Raises a NotImplementedError for codecs with variable-sized outputs (e.g. compressors). Parameters ---------- byte_length : int array_spec : ArraySpec Returns ------- int """ ... @abstractmethod async def decode( self, chunk_bytes_and_specs: Iterable[tuple[Buffer | None, ArraySpec]], ) -> Iterable[NDBuffer | None]: """Decodes a batch of chunks. Chunks can be None in which case they are ignored by the codec. Parameters ---------- chunk_bytes_and_specs : Iterable[tuple[Buffer | None, ArraySpec]] Ordered set of encoded chunks with their accompanying chunk spec. Returns ------- Iterable[NDBuffer | None] """ ... @abstractmethod async def encode( self, chunk_arrays_and_specs: Iterable[tuple[NDBuffer | None, ArraySpec]], ) -> Iterable[Buffer | None]: """Encodes a batch of chunks. Chunks can be None in which case they are ignored by the codec. Parameters ---------- chunk_arrays_and_specs : Iterable[tuple[NDBuffer | None, ArraySpec]] Ordered set of to-be-encoded chunks with their accompanying chunk spec. Returns ------- Iterable[Buffer | None] """ ... @abstractmethod async def read( self, batch_info: Iterable[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], out: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> tuple[GetResult, ...]: """Reads chunk data from the store, decodes it and writes it into an output array. Partial decoding may be utilized if the codecs and stores support it. Parameters ---------- batch_info : Iterable[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]] Ordered set of information about the chunks. The first slice selection determines which parts of the chunk will be fetched. The second slice selection determines where in the output array the chunk data will be written. The ByteGetter is used to fetch the necessary bytes. The chunk spec contains information about the construction of an array from the bytes. If the Store returns ``None`` for a chunk, then the chunk was not written and the implementation must set the values of that chunk (or ``out``) to the fill value for the array. out : NDBuffer Returns ------- tuple[GetResult, ...] One result per chunk in ``batch_info``. """ ... @abstractmethod async def write( self, batch_info: Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> None: """Encodes chunk data and writes it to the store. Merges with existing chunk data by reading first, if necessary. Partial encoding may be utilized if the codecs and stores support it. Parameters ---------- batch_info : Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]] Ordered set of information about the chunks. The first slice selection determines which parts of the chunk will be encoded. The second slice selection determines where in the value array the chunk data is located. The ByteSetter is used to fetch and write the necessary bytes. The chunk spec contains information about the chunk. value : NDBuffer """ ... async def _batching_helper[CI: CodecInput, CO: CodecOutput]( func: Callable[[CI, ArraySpec], Awaitable[CO | None]], batch_info: Iterable[tuple[CI | None, ArraySpec]], ) -> list[CO | None]: return await concurrent_map( list(batch_info), _noop_for_none(func), config.get("async.concurrency"), ) def _noop_for_none[CI: CodecInput, CO: CodecOutput]( func: Callable[[CI, ArraySpec], Awaitable[CO | None]], ) -> Callable[[CI | None, ArraySpec], Awaitable[CO | None]]: async def wrap(chunk: CI | None, chunk_spec: ArraySpec) -> CO | None: if chunk is None: return None return await func(chunk, chunk_spec) return wrap zarr-python-3.3.0/src/zarr/abc/metadata.py000066400000000000000000000025751523267620000204520ustar00rootroot00000000000000from __future__ import annotations from collections.abc import Sequence from typing import TYPE_CHECKING if TYPE_CHECKING: from typing import Self from zarr.core.common import JSON from dataclasses import dataclass, fields __all__ = ["Metadata"] @dataclass(frozen=True) class Metadata: def to_dict(self) -> dict[str, JSON]: """ Recursively serialize this model to a dictionary. This method inspects the fields of self and calls `x.to_dict()` for any fields that are instances of `Metadata`. Sequences of `Metadata` are similarly recursed into, and the output of that recursion is collected in a list. """ out_dict = {} for field in fields(self): key = field.name value = getattr(self, key) if isinstance(value, Metadata): out_dict[field.name] = getattr(self, field.name).to_dict() elif isinstance(value, str): out_dict[key] = value elif isinstance(value, Sequence): out_dict[key] = tuple(v.to_dict() if isinstance(v, Metadata) else v for v in value) else: out_dict[key] = value return out_dict @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: """ Create an instance of the model from a dictionary """ return cls(**data) zarr-python-3.3.0/src/zarr/abc/numcodec.py000066400000000000000000000053401523267620000204600ustar00rootroot00000000000000from typing import Any, Protocol, Self, TypeGuard class Numcodec(Protocol): """ A protocol that models the ``numcodecs.abc.Codec`` interface. This protocol should be considered experimental. Expect the type annotations for ``buf`` and ``out`` to narrow in the future. """ codec_id: str def encode(self, buf: Any) -> Any: """Encode data from ``buf``. Parameters ---------- buf : Any Data to be encoded. Returns ------- enc: Any Encoded data. """ ... def decode(self, buf: Any, out: Any | None = None) -> Any: """ Decode data in ``buf``. Parameters ---------- buf : Any Encoded data. out : Any Writeable buffer to store decoded data. If provided, this buffer must be exactly the right size to store the decoded data. Returns ------- dec : Any Decoded data. """ ... def get_config(self) -> Any: """ Return a JSON-serializable configuration dictionary for this codec. Must include an ``'id'`` field with the codec identifier. """ ... @classmethod def from_config(cls, config: Any) -> Self: """ Instantiate a codec from a configuration dictionary. Parameters ---------- config : Any A configuration dictionary for this codec. """ ... def _is_numcodec_cls(obj: object) -> TypeGuard[type[Numcodec]]: """ Check if the given object is a class implements the Numcodec protocol. The @runtime_checkable decorator does not allow issubclass checks for protocols with non-method members (i.e., attributes), so we use this function to manually check for the presence of the required attributes and methods on a given object. """ return ( isinstance(obj, type) and hasattr(obj, "codec_id") and isinstance(obj.codec_id, str) and hasattr(obj, "encode") and callable(obj.encode) and hasattr(obj, "decode") and callable(obj.decode) and hasattr(obj, "get_config") and callable(obj.get_config) and hasattr(obj, "from_config") and callable(obj.from_config) ) def _is_numcodec(obj: object) -> TypeGuard[Numcodec]: """ Check if the given object implements the Numcodec protocol. The @runtime_checkable decorator does not allow issubclass checks for protocols with non-method members (i.e., attributes), so we use this function to manually check for the presence of the required attributes and methods on a given object. """ return _is_numcodec_cls(type(obj)) zarr-python-3.3.0/src/zarr/abc/store.py000066400000000000000000000600141523267620000200160ustar00rootroot00000000000000from __future__ import annotations import asyncio from abc import ABC, abstractmethod from dataclasses import dataclass from functools import partial from itertools import starmap from typing import TYPE_CHECKING, Literal, Protocol, runtime_checkable if TYPE_CHECKING: from collections.abc import AsyncGenerator, AsyncIterator, Iterable, Sequence from types import TracebackType from typing import Any, Self from zarr.core.buffer import Buffer, BufferPrototype __all__ = [ "ByteGetter", "ByteSetter", "Store", "SupportsDeleteSync", "SupportsGetSync", "SupportsSetSync", "SupportsSyncStore", "SyncByteGetter", "SyncByteSetter", "set_or_delete", ] @dataclass(frozen=True, slots=True) class RangeByteRequest: """Request a specific byte range""" start: int """The start of the byte range request (inclusive).""" end: int """The end of the byte range request (exclusive).""" @dataclass(frozen=True, slots=True) class OffsetByteRequest: """Request all bytes starting from a given byte offset""" offset: int """The byte offset for the offset range request.""" @dataclass(frozen=True, slots=True) class SuffixByteRequest: """Request up to the last `n` bytes""" suffix: int """The number of bytes from the suffix to request.""" type ByteRequest = RangeByteRequest | OffsetByteRequest | SuffixByteRequest class Store(ABC): """ Abstract base class for Zarr stores. """ _read_only: bool _is_open: bool def __init__(self, *, read_only: bool = False) -> None: self._is_open = False self._read_only = read_only @classmethod async def open(cls, *args: Any, **kwargs: Any) -> Self: """ Create and open the store. Parameters ---------- *args : Any Positional arguments to pass to the store constructor. **kwargs : Any Keyword arguments to pass to the store constructor. Returns ------- Store The opened store instance. """ store = cls(*args, **kwargs) await store._open() return store def with_read_only(self, read_only: bool = False) -> Store: """ Return a new store with a new read_only setting. The new store points to the same location with the specified new read_only state. The returned Store is not automatically opened, and this store is not automatically closed. Parameters ---------- read_only If True, the store will be created in read-only mode. Defaults to False. Returns ------- A new store of the same type with the new read only attribute. """ raise NotImplementedError( f"with_read_only is not implemented for the {type(self)} store type." ) def __enter__(self) -> Self: """Enter a context manager that will close the store upon exiting.""" return self def __exit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, ) -> None: """Close the store.""" self.close() async def _open(self) -> None: """ Open the store. Raises ------ ValueError If the store is already open. """ if self._is_open: raise ValueError("store is already open") self._is_open = True async def _ensure_open(self) -> None: """Open the store if it is not already open.""" if not self._is_open: await self._open() async def is_empty(self, prefix: str) -> bool: """ Check if the directory is empty. Parameters ---------- prefix : str Prefix of keys to check. Returns ------- bool True if the store is empty, False otherwise. """ if not self.supports_listing: raise NotImplementedError if prefix != "" and not prefix.endswith("/"): prefix += "/" async for _ in self.list_prefix(prefix): return False return True async def clear(self) -> None: """ Clear the store. Remove all keys and values from the store. """ if not self.supports_deletes: raise NotImplementedError if not self.supports_listing: raise NotImplementedError self._check_writable() await self.delete_dir("") @property def read_only(self) -> bool: """Is the store read-only?""" return self._read_only def _check_writable(self) -> None: """Raise an exception if the store is not writable.""" if self.read_only: raise ValueError("store was opened in read-only mode and does not support writing") @abstractmethod def __eq__(self, value: object) -> bool: """Equality comparison.""" ... @abstractmethod async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: """Retrieve the value associated with a given key. Parameters ---------- key : str prototype : BufferPrototype The prototype of the output buffer. Stores may support a default buffer prototype. byte_range : ByteRequest, optional ByteRequest may be one of the following. If not provided, all data associated with the key is retrieved. - RangeByteRequest(int, int): Request a specific range of bytes in the form (start, end). The end is exclusive. If the given range is zero-length or starts after the end of the object, an error will be returned. Additionally, if the range ends after the end of the object, the entire remainder of the object will be returned. Otherwise, the exact requested range will be returned. - OffsetByteRequest(int): Request all bytes starting from a given byte offset. This is equivalent to bytes={int}- as an HTTP header. - SuffixByteRequest(int): Request the last int bytes. Note that here, int is the size of the request, not the byte offset. This is equivalent to bytes=-{int} as an HTTP header. Returns ------- Buffer """ ... @abstractmethod async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: """Retrieve possibly partial values from given key_ranges. Parameters ---------- prototype : BufferPrototype The prototype of the output buffer. Stores may support a default buffer prototype. key_ranges : Iterable[tuple[str, tuple[int | None, int | None]]] Ordered set of key, range pairs, a key may occur multiple times with different ranges Returns ------- list of values, in the order of the key_ranges, may contain null/none for missing keys """ ... @abstractmethod async def exists(self, key: str) -> bool: """Check if a key exists in the store. Parameters ---------- key : str Returns ------- bool """ ... @property @abstractmethod def supports_writes(self) -> bool: """Does the store support writes?""" ... @abstractmethod async def set(self, key: str, value: Buffer) -> None: """Store a (key, value) pair. Parameters ---------- key : str value : Buffer """ ... async def set_if_not_exists(self, key: str, value: Buffer) -> None: """ Store a key to ``value`` if the key is not already present. Parameters ---------- key : str value : Buffer """ # Note for implementers: the default implementation provided here # is not safe for concurrent writers. There's a race condition between # the `exists` check and the `set` where another writer could set some # value at `key` or delete `key`. if not await self.exists(key): await self.set(key, value) async def _set_many(self, values: Iterable[tuple[str, Buffer]]) -> None: """ Insert multiple (key, value) pairs into storage. """ await asyncio.gather(*starmap(self.set, values)) @property def supports_consolidated_metadata(self) -> bool: """ Does the store support consolidated metadata?. If it doesn't an error will be raised on requests to consolidate the metadata. Returning `False` can be useful for stores which implement their own consolidation mechanism outside of the zarr-python implementation. """ return True @property @abstractmethod def supports_deletes(self) -> bool: """Does the store support deletes?""" ... @abstractmethod async def delete(self, key: str) -> None: """Remove a key from the store Parameters ---------- key : str """ ... @property def supports_partial_writes(self) -> Literal[False]: """Does the store support partial writes? Partial writes are no longer used by Zarr, so this is always false. """ return False @property @abstractmethod def supports_listing(self) -> bool: """Does the store support listing?""" ... @abstractmethod def list(self) -> AsyncIterator[str]: """Retrieve all keys in the store. Returns ------- AsyncIterator[str] """ # This method should be async, like overridden methods in child classes. # However, that's not straightforward: # https://stackoverflow.com/questions/68905848 @abstractmethod def list_prefix(self, prefix: str) -> AsyncIterator[str]: """ Retrieve all keys in the store that begin with a given prefix. Keys are returned relative to the root of the store. Parameters ---------- prefix : str Returns ------- AsyncIterator[str] """ # This method should be async, like overridden methods in child classes. # However, that's not straightforward: # https://stackoverflow.com/questions/68905848 @abstractmethod def list_dir(self, prefix: str) -> AsyncIterator[str]: """ Retrieve all keys and prefixes with a given prefix and which do not contain the character “/” after the given prefix. Parameters ---------- prefix : str Returns ------- AsyncIterator[str] """ # This method should be async, like overridden methods in child classes. # However, that's not straightforward: # https://stackoverflow.com/questions/68905848 async def delete_dir(self, prefix: str) -> None: """ Remove all keys and prefixes in the store that begin with a given prefix. """ if not self.supports_deletes: raise NotImplementedError if not self.supports_listing: raise NotImplementedError self._check_writable() if prefix != "" and not prefix.endswith("/"): prefix += "/" async for key in self.list_prefix(prefix): await self.delete(key) def close(self) -> None: """Close the store.""" self._is_open = False async def _get_many( self, requests: Iterable[tuple[str, BufferPrototype, ByteRequest | None]] ) -> AsyncGenerator[tuple[str, Buffer | None], None]: """ Retrieve a collection of objects from storage. In general this method does not guarantee that objects will be retrieved in the order in which they were requested, so this method yields tuple[str, Buffer | None] instead of just Buffer | None """ for req in requests: yield (req[0], await self.get(*req)) async def get_ranges( self, key: str, byte_ranges: Sequence[ByteRequest | None], *, prototype: BufferPrototype, max_concurrency: int = 10, max_gap_bytes: int = 1 << 20, # 1 MiB max_coalesced_bytes: int = 16 << 20, # 16 MiB ) -> AsyncIterator[Sequence[tuple[int, Buffer | None]]]: """Read many byte ranges from `key`. Yields one batch per underlying I/O operation, each a sequence of `(input_index, Buffer | None)` tuples. Batches across yields arrive in completion order, not input order. The default implementation built into `Store` runs the coalescer over `self.get`, so subclasses get a working implementation for free; stores that have a more efficient backend (e.g. ranged HTTP, S3 byte-range fetches) should override. Parameters ---------- key Storage key to read from. byte_ranges Input ranges. `None` means "the whole value". prototype Buffer prototype, forwarded to `self.get`. max_concurrency Maximum number of merged fetches in flight at once. max_gap_bytes Two `RangeByteRequest`s separated by at most this many bytes may be merged into one fetch. max_coalesced_bytes Upper bound on the size of a single merged fetch. Raises ------ BaseExceptionGroup Failures from underlying fetches are reported as a `BaseExceptionGroup` (PEP 654) and should be handled with `except*`. Inner exceptions include `FileNotFoundError` if any fetch returns `None` (i.e. `key` is absent), and any exception raised by `self.get` for the corresponding range. Pending fetches are cancelled as soon as one task fails, so the group typically contains a single non-`CancelledError` exception even under high concurrency. """ # Local import: zarr.core._coalesce imports symbols from this module. from zarr.core._coalesce import coalesced_get fetch = partial(self.get, key, prototype) async for group in coalesced_get( fetch, byte_ranges, max_concurrency=max_concurrency, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ): yield group def get_ranges_sync( self, key: str, byte_ranges: Sequence[ByteRequest | None], *, prototype: BufferPrototype, max_gap_bytes: int = 1 << 20, # 1 MiB max_coalesced_bytes: int = 16 << 20, # 16 MiB ) -> Sequence[tuple[int, Buffer | None]]: """Synchronous, coalescing counterpart of `get_ranges`. Plans merged fetches with the same `coalesce_ranges` policy as the async path, then issues one synchronous `get_sync` per merged group (or per uncoalescable request) and slices results back into per-input buffers. Used by the sync codec pipeline's partial-shard reads so they get the same byte-range coalescing as the async path, without an event loop. Returns a list of `(input_index, Buffer | None)`. Raises `BaseExceptionGroup` containing a `FileNotFoundError` if the key is absent (matching `get_ranges`), so callers can handle a deleted shard uniformly across the sync and async paths. Requires the store to implement `get_sync` (`SupportsGetSync`). """ from zarr.core._coalesce import coalesce_ranges if not isinstance(self, SupportsGetSync): raise TypeError(f"{type(self).__name__} does not support synchronous reads") groups, uncoalescable = coalesce_ranges( byte_ranges, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes ) results: list[tuple[int, Buffer | None]] = [] errors: list[BaseException] = [] def _get(req: ByteRequest | None) -> Buffer | None: return self.get_sync(key, prototype=prototype, byte_range=req) for idx, req in uncoalescable: buf = _get(req) if buf is None: errors.append(FileNotFoundError(key)) else: results.append((idx, buf)) for members in groups: if len(members) == 1: solo_idx, solo_req = members[0] buf = _get(solo_req) if buf is None: errors.append(FileNotFoundError(key)) else: results.append((solo_idx, buf)) continue start = members[0][1].start end = max(r.end for _, r in members) big = _get(RangeByteRequest(start, end)) if big is None: errors.append(FileNotFoundError(key)) continue for member_idx, r in members: results.append((member_idx, big[r.start - start : r.end - start])) if errors: raise BaseExceptionGroup("chunk read failed", errors) return results async def getsize(self, key: str) -> int: """ Return the size, in bytes, of a value in a Store. Parameters ---------- key : str Returns ------- nbytes : int The size of the value (in bytes). Raises ------ FileNotFoundError When the given key does not exist in the store. """ # Note to implementers: this default implementation is very inefficient since # it requires reading the entire object. Many systems will have ways to get the # size of an object without reading it. # avoid circular import from zarr.core.buffer.core import default_buffer_prototype value = await self.get(key, prototype=default_buffer_prototype()) if value is None: raise FileNotFoundError(key) return len(value) async def getsize_prefix(self, prefix: str) -> int: """ Return the size, in bytes, of all values under a prefix. Parameters ---------- prefix : str The prefix of the directory to measure. Returns ------- nbytes : int The sum of the sizes of the values in the directory (in bytes). See Also -------- zarr.Array.nbytes_stored Store.getsize Notes ----- ``getsize_prefix`` is just provided as a potentially faster alternative to listing all the keys under a prefix calling [`Store.getsize`][zarr.abc.store.Store.getsize] on each. In general, ``prefix`` should be the path of an Array or Group in the Store. Implementations may differ on the behavior when some other ``prefix`` is provided. """ # TODO: Overlap listing keys with getsize calls. # Currently, we load the list of keys into memory and only then move # on to getting sizes. Ideally we would overlap those two, which should # improve tail latency and might reduce memory pressure (since not all keys # would be in memory at once). # avoid circular import from zarr.core.common import concurrent_map from zarr.core.config import config if prefix != "" and not prefix.endswith("/"): prefix += "/" keys = [(x,) async for x in self.list_prefix(prefix)] limit = config.get("async.concurrency") sizes = await concurrent_map(keys, self.getsize, limit=limit) return sum(sizes) @runtime_checkable class ByteGetter(Protocol): async def get( self, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: ... @runtime_checkable class ByteSetter(Protocol): async def get( self, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: ... async def set(self, value: Buffer) -> None: ... async def delete(self) -> None: ... async def set_if_not_exists(self, default: Buffer) -> None: ... @runtime_checkable class SyncByteGetter(Protocol): """A `ByteGetter` that can also fetch synchronously, without an event loop. Non-StorePath byte getters (e.g. the sharding codec's in-memory `_ShardingByteGetter`) implement this so a synchronous codec pipeline can take its sync fast path on them instead of scheduling one coroutine per chunk. Note that `StorePath` also *has* a `get_sync` method (so it matches this protocol structurally) but it only works when its store supports synchronous IO — callers gate `StorePath` on the store's `SupportsGetSync` instead of on this protocol. """ def get_sync( self, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None ) -> Buffer | None: ... @runtime_checkable class SyncByteSetter(SyncByteGetter, Protocol): """A `ByteSetter` that can also write synchronously. See `SyncByteGetter`.""" def set_sync(self, value: Buffer) -> None: ... def delete_sync(self) -> None: ... @runtime_checkable class SupportsGetSync(Protocol): """Store protocol for synchronous reads (`get_sync`). The store sync surface is all-or-nothing: a store implementing any of the `*_sync` methods must implement all of them (`SupportsSyncStore`), because consumers mix sync reads, writes, and deletes within one operation. Capability-gated callers consult `_store_supports_sync_io` rather than the individual protocols. """ def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: ... @runtime_checkable class SupportsSetSync(Protocol): """Store protocol for synchronous writes (`set_sync`). See `SupportsGetSync` for the all-or-nothing contract on the store sync surface. """ def set_sync(self, key: str, value: Buffer) -> None: ... @runtime_checkable class SupportsDeleteSync(Protocol): """Store protocol for synchronous deletes (`delete_sync`). See `SupportsGetSync` for the all-or-nothing contract on the store sync surface. """ def delete_sync(self, key: str) -> None: ... @runtime_checkable class SupportsSyncStore(SupportsGetSync, SupportsSetSync, SupportsDeleteSync, Protocol): """The full store sync surface: `get_sync`, `set_sync`, and `delete_sync`.""" def _store_supports_sync_io(store: object) -> bool: """Whether `store` can serve the full synchronous IO surface right now. Structural membership in `SupportsSyncStore` is necessary but not always sufficient: a store can present the `*_sync` methods while its ability to run them depends on runtime state the type system cannot see. Wrapper stores are the canonical case — `WrapperStore` delegates the sync methods to the store it wraps, so they only work when the wrapped store is itself sync-capable. Such stores opt out dynamically via a `_supports_sync_io` attribute/property (absent means capable). This is an interim, private convention pending a formal sync/async store architecture — the store-side twin of the codec-side `_sync_capable` convention consulted by `zarr.abc.codec._codec_supports_sync`. Synchronous IO is all-or-nothing: consumers such as the fused codec pipeline mix synchronous reads, writes, and deletes within one batch (e.g. a partial-chunk write reads existing bytes and an all-fill chunk is deleted), so a partial sync surface never satisfies this predicate. """ return isinstance(store, SupportsSyncStore) and getattr(store, "_supports_sync_io", True) async def set_or_delete(byte_setter: ByteSetter, value: Buffer | None) -> None: """Set or delete a value in a byte setter Parameters ---------- byte_setter : ByteSetter value : Buffer | None Notes ----- If value is None, the key will be deleted. """ if value is None: await byte_setter.delete() else: await byte_setter.set(value) zarr-python-3.3.0/src/zarr/api/000077500000000000000000000000001523267620000163335ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/api/__init__.py000066400000000000000000000000001523267620000204320ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/api/asynchronous.py000066400000000000000000001354741523267620000214560ustar00rootroot00000000000000from __future__ import annotations import asyncio import dataclasses import warnings from typing import TYPE_CHECKING, Any, Literal, NotRequired, TypedDict, cast import numpy as np import numpy.typing as npt from typing_extensions import deprecated from zarr.abc.store import Store from zarr.core.array import ( DEFAULT_FILL_VALUE, Array, AsyncArray, CompressorLike, create_array, from_array, get_array_metadata, ) from zarr.core.array_spec import ArrayConfigLike, parse_array_config from zarr.core.buffer import NDArrayLike from zarr.core.common import ( JSON, AccessModeLiteral, DimensionNamesLike, MemoryOrder, ZarrFormat, _default_zarr_format, _warn_write_empty_chunks_kwarg, ) from zarr.core.dtype import ZDTypeLike, get_data_type_from_native_dtype from zarr.core.group import ( AsyncGroup, ConsolidatedMetadata, GroupMetadata, create_hierarchy, ) from zarr.core.metadata import ArrayMetadataDict, ArrayV2Metadata from zarr.errors import ( ArrayNotFoundError, GroupNotFoundError, NodeTypeValidationError, ZarrDeprecationWarning, ZarrRuntimeWarning, ZarrUserWarning, ) from zarr.storage import StorePath from zarr.storage._common import make_store_path if TYPE_CHECKING: from collections.abc import Iterable from zarr.abc.codec import Codec from zarr.abc.numcodec import Numcodec from zarr.core.buffer import NDArrayLikeOrScalar from zarr.core.chunk_key_encodings import ChunkKeyEncoding from zarr.core.metadata.v2 import CompressorLikev2 from zarr.storage import StoreLike from zarr.types import AnyArray, AnyAsyncArray # TODO: this type could use some more thought type ArrayLike = AnyAsyncArray | AnyArray | npt.NDArray[Any] PathLike = str __all__ = [ "array", "consolidate_metadata", "copy", "copy_all", "copy_store", "create", "create_array", "create_hierarchy", "empty", "empty_like", "from_array", "full", "full_like", "group", "load", "ones", "ones_like", "open", "open_array", "open_consolidated", "open_group", "open_like", "save", "save_array", "save_group", "tree", "zeros", "zeros_like", ] _READ_MODES: tuple[AccessModeLiteral, ...] = ("r", "r+", "a") _CREATE_MODES: tuple[AccessModeLiteral, ...] = ("a", "w", "w-") _OVERWRITE_MODES: tuple[AccessModeLiteral, ...] = ("w",) def _infer_overwrite(mode: AccessModeLiteral) -> bool: """ Check that an ``AccessModeLiteral`` is compatible with overwriting an existing Zarr node. """ return mode in _OVERWRITE_MODES def _warn_unimplemented_kwargs(kwargs: dict[str, Any]) -> None: """ Emit a "not yet implemented" warning for each provided keyword argument that is not None. ``kwargs`` maps a keyword argument name to its supplied value. The ``stacklevel`` is chosen so the warning points at the caller of the public API function (the same location as an inline ``warnings.warn(..., stacklevel=2)`` would). """ for name, value in kwargs.items(): if value is not None: warnings.warn(f"{name} is not yet implemented", ZarrRuntimeWarning, stacklevel=3) def _get_shape_chunks(a: ArrayLike | Any) -> tuple[tuple[int, ...] | None, tuple[int, ...] | None]: """Helper function to get the shape and chunks from an array-like object""" shape = None chunks = None if hasattr(a, "shape") and isinstance(a.shape, tuple): shape = a.shape if hasattr(a, "chunks") and isinstance(a.chunks, tuple) and (len(a.chunks) == len(a.shape)): chunks = a.chunks elif hasattr(a, "chunklen"): # bcolz carray chunks = (a.chunklen,) + a.shape[1:] return shape, chunks class _LikeArgs(TypedDict): shape: NotRequired[tuple[int, ...]] chunks: NotRequired[tuple[int, ...]] dtype: NotRequired[np.dtype[np.generic]] order: NotRequired[Literal["C", "F"]] filters: NotRequired[tuple[Numcodec, ...] | None] compressor: NotRequired[CompressorLikev2] codecs: NotRequired[tuple[Codec, ...]] fill_value: NotRequired[Any] def _like_args(a: ArrayLike) -> _LikeArgs: """Set default values for shape and chunks if they are not present in the array-like object""" new: _LikeArgs = {} shape, chunks = _get_shape_chunks(a) if shape is not None: new["shape"] = shape if chunks is not None: new["chunks"] = chunks if hasattr(a, "dtype"): new["dtype"] = a.dtype if isinstance(a, AsyncArray | Array): new["fill_value"] = a.metadata.fill_value if isinstance(a.metadata, ArrayV2Metadata): new["order"] = a.order new["compressor"] = a.metadata.compressor new["filters"] = a.metadata.filters else: # TODO: Remove type: ignore statement when type inference improves. # mypy cannot correctly infer the type of a.metadata here for some reason. new["codecs"] = a.metadata.codecs else: # TODO: set default values compressor/codecs # to do this, we may need to evaluate if this is a v2 or v3 array # new["compressor"] = "default" pass return new async def consolidate_metadata( store: StoreLike, path: str | None = None, zarr_format: ZarrFormat | None = None, ) -> AsyncGroup: """ Consolidate the metadata of all nodes in a hierarchy. Upon completion, the metadata of the root node in the Zarr hierarchy will be updated to include all the metadata of child nodes. For Stores that do not support consolidated metadata, this operation raises a ``TypeError``. Parameters ---------- store : StoreLike The store-like object whose metadata you wish to consolidate. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str, optional A path to a group in the store to consolidate at. Only children below that group will be consolidated. By default, the root node is used so all the metadata in the store is consolidated. zarr_format : {2, 3, None}, optional The zarr format of the hierarchy. By default the zarr format is inferred. Returns ------- group: AsyncGroup The group, with the ``consolidated_metadata`` field set to include the metadata of each child node. If the Store doesn't support consolidated metadata, this function raises a `TypeError`. See ``Store.supports_consolidated_metadata``. """ store_path = await make_store_path(store, path=path) if not store_path.store.supports_consolidated_metadata: store_name = type(store_path.store).__name__ raise TypeError( f"The Zarr Store in use ({store_name}) doesn't support consolidated metadata", ) group = await AsyncGroup.open(store_path, zarr_format=zarr_format, use_consolidated=False) group.store_path.store._check_writable() members_metadata = { k: v.metadata async for k, v in group.members(max_depth=None, use_consolidated_for_children=False) } # While consolidating, we want to be explicit about when child groups # are empty by inserting an empty dict for consolidated_metadata.metadata for k, v in members_metadata.items(): if isinstance(v, GroupMetadata) and v.consolidated_metadata is None: v = dataclasses.replace(v, consolidated_metadata=ConsolidatedMetadata(metadata={})) members_metadata[k] = v if any(m.zarr_format == 3 for m in members_metadata.values()): warnings.warn( "Consolidated metadata is currently not part in the Zarr format 3 specification. It " "may not be supported by other zarr implementations and may change in the future.", category=ZarrUserWarning, stacklevel=1, ) ConsolidatedMetadata._flat_to_nested(members_metadata) consolidated_metadata = ConsolidatedMetadata(metadata=members_metadata) metadata = dataclasses.replace(group.metadata, consolidated_metadata=consolidated_metadata) group = dataclasses.replace( group, metadata=metadata, ) await group._save_metadata() return group async def copy(*args: Any, **kwargs: Any) -> tuple[int, int, int]: """ Not implemented. """ raise NotImplementedError async def copy_all(*args: Any, **kwargs: Any) -> tuple[int, int, int]: """ Not implemented. """ raise NotImplementedError async def copy_store(*args: Any, **kwargs: Any) -> tuple[int, int, int]: """ Not implemented. """ raise NotImplementedError async def load( *, store: StoreLike, path: str | None = None, zarr_format: ZarrFormat | None = None, ) -> NDArrayLikeOrScalar | dict[str, NDArrayLikeOrScalar]: """Load data from an array or group into memory. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str or None, optional The path within the store from which to load. Returns ------- out If the path contains an array, out will be a numpy array. If the path contains a group, out will be a dict-like object where keys are array names and values are numpy arrays. See Also -------- save, open Notes ----- If loading data from a group of arrays, data will not be immediately loaded into memory. Rather, arrays will be loaded into memory as they are requested. Unlike [`open`][zarr.open], which returns a lazy [`Array`][zarr.Array] or [`Group`][zarr.Group] backed by the store, `load` eagerly reads the data and returns it as an in-memory array (or a dict of arrays for a group). The array type is NumPy by default, but follows the configured buffer prototype (for example, CuPy for GPU use cases). Use `open` when you want to read or write data incrementally without loading it all into memory. """ obj = await open(store=store, path=path, zarr_format=zarr_format) if isinstance(obj, AsyncArray): return await obj.getitem(Ellipsis) else: raise NotImplementedError("loading groups not yet supported") async def open( *, store: StoreLike | None = None, mode: AccessModeLiteral | None = None, zarr_format: ZarrFormat | None = None, path: str | None = None, storage_options: dict[str, Any] | None = None, **kwargs: Any, # TODO: type kwargs as valid args to open_array ) -> AnyAsyncArray | AsyncGroup: """Convenience function to open a group or array using file-mode-like semantics. Parameters ---------- store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. mode : {'r', 'r+', 'a', 'w', 'w-'}, optional Persistence mode: 'r' means read only (must exist); 'r+' means read/write (must exist); 'a' means read/write (create if doesn't exist); 'w' means create (overwrite if exists); 'w-' means create (fail if exists). If the store is read-only, the default is 'r'; otherwise, it is 'a'. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str or None, optional The path within the store to open. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs Additional parameters are passed through to `zarr.open_array` or `zarr.open_group`. Returns ------- z : array or group Return type depends on what exists in the given store. See Also -------- load Notes ----- `open` returns a lazy [`Array`][zarr.Array] or [`Group`][zarr.Group] backed by the store, so data is read and written incrementally. Use [`load`][zarr.load] instead when you want the data eagerly read into an in-memory array (a NumPy array by default). """ if mode is None: if isinstance(store, (Store, StorePath)) and store.read_only: mode = "r" else: mode = "a" store_path = await make_store_path(store, mode=mode, path=path, storage_options=storage_options) # TODO: the mode check below seems wrong! if "shape" not in kwargs and mode in {"a", "r", "r+", "w"}: try: metadata_dict = await get_array_metadata(store_path, zarr_format=zarr_format) # TODO: remove this cast when we fix typing for array metadata dicts _metadata_dict = cast("ArrayMetadataDict", metadata_dict) # for v2, the above would already have raised an exception if not an array zarr_format = _metadata_dict["zarr_format"] is_v3_array = zarr_format == 3 and _metadata_dict.get("node_type") == "array" if is_v3_array or zarr_format == 2: return AsyncArray( store_path=store_path, metadata=_metadata_dict, config=kwargs.get("config") ) except (AssertionError, FileNotFoundError, NodeTypeValidationError): pass return await open_group(store=store_path, zarr_format=zarr_format, mode=mode, **kwargs) try: return await open_array(store=store_path, zarr_format=zarr_format, mode=mode, **kwargs) except (KeyError, NodeTypeValidationError): # KeyError for a missing key # NodeTypeValidationError for failing to parse node metadata as an array when it's # actually a group return await open_group(store=store_path, zarr_format=zarr_format, mode=mode, **kwargs) async def open_consolidated( *args: Any, use_consolidated: Literal[True] = True, **kwargs: Any ) -> AsyncGroup: """ Alias for [`open_group`][zarr.api.asynchronous.open_group] with ``use_consolidated=True``. """ if use_consolidated is not True: raise TypeError( "'use_consolidated' must be 'True' in 'open_consolidated'. Use 'open' with " "'use_consolidated=False' to bypass consolidated metadata." ) return await open_group(*args, use_consolidated=use_consolidated, **kwargs) async def save( store: StoreLike, *args: NDArrayLike, zarr_format: ZarrFormat | None = None, path: str | None = None, **kwargs: Any, # TODO: type kwargs as valid args to save ) -> None: """Convenience function to save an array or group of arrays to the local file system. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. *args : ndarray NumPy arrays with data to save. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str or None, optional The path within the group where the arrays will be saved. **kwargs NumPy arrays with data to save. """ if len(args) == 0 and len(kwargs) == 0: raise ValueError("at least one array must be provided") if len(args) == 1 and len(kwargs) == 0: await save_array(store, args[0], zarr_format=zarr_format, path=path) else: await save_group(store, *args, zarr_format=zarr_format, path=path, **kwargs) async def save_array( store: StoreLike, arr: NDArrayLike, *, zarr_format: ZarrFormat | None = None, path: str | None = None, storage_options: dict[str, Any] | None = None, **kwargs: Any, # TODO: type kwargs as valid args to create ) -> None: """Convenience function to save a NumPy array to the local file system, following a similar API to the NumPy save() function. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. arr : ndarray NumPy array with data to save. zarr_format : {2, 3, None}, optional The zarr format to use when saving. The default is ``None``, which will use the default Zarr format defined in the global configuration object. path : str or None, optional The path within the store where the array will be saved. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs Passed through to [`create`][zarr.api.asynchronous.create], e.g., compressor. """ if zarr_format is None: zarr_format = _default_zarr_format() if not isinstance(arr, NDArrayLike): raise TypeError("arr argument must be numpy or other NDArrayLike array") mode = kwargs.pop("mode", "a") store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options) if np.isscalar(arr): arr = np.array(arr) shape = arr.shape chunks = getattr(arr, "chunks", None) # for array-likes with chunks attribute overwrite = kwargs.pop("overwrite", None) or _infer_overwrite(mode) zarr_dtype = get_data_type_from_native_dtype(arr.dtype) new = await AsyncArray._create( store_path, zarr_format=zarr_format, shape=shape, dtype=zarr_dtype, chunks=chunks, overwrite=overwrite, **kwargs, ) await new.setitem(Ellipsis, arr) async def save_group( store: StoreLike, *args: NDArrayLike, zarr_format: ZarrFormat | None = None, path: str | None = None, storage_options: dict[str, Any] | None = None, **kwargs: NDArrayLike, ) -> None: """Convenience function to save several NumPy arrays to the local file system, following a similar API to the NumPy savez()/savez_compressed() functions. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. *args : ndarray NumPy arrays with data to save. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str or None, optional Path within the store where the group will be saved. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs NumPy arrays with data to save. """ store_path = await make_store_path(store, path=path, mode="w", storage_options=storage_options) if zarr_format is None: zarr_format = _default_zarr_format() for arg in args: if not isinstance(arg, NDArrayLike): raise TypeError( "All arguments must be numpy or other NDArrayLike arrays (except store, path, storage_options, and zarr_format)" ) for k, v in kwargs.items(): if not isinstance(v, NDArrayLike): raise TypeError(f"Keyword argument '{k}' must be a numpy or other NDArrayLike array") if len(args) == 0 and len(kwargs) == 0: raise ValueError("at least one array must be provided") aws = [] for i, arr in enumerate(args): aws.append( save_array( store_path, arr, zarr_format=zarr_format, path=f"arr_{i}", storage_options=storage_options, ) ) for k, arr in kwargs.items(): aws.append(save_array(store_path, arr, zarr_format=zarr_format, path=k)) await asyncio.gather(*aws) @deprecated("Use AsyncGroup.tree instead.", category=ZarrDeprecationWarning) async def tree(grp: AsyncGroup, expand: bool | None = None, level: int | None = None) -> Any: """Provide a rich display of the hierarchy. !!! warning "Deprecated" `zarr.tree()` is deprecated since v3.0.0 and will be removed in a future release. Use `group.tree()` instead. Parameters ---------- grp : Group Zarr or h5py group. expand : bool, optional Only relevant for HTML representation. If True, tree will be fully expanded. level : int, optional Maximum depth to descend into hierarchy. Returns ------- TreeRepr A pretty-printable object displaying the hierarchy. """ return await grp.tree(expand=expand, level=level) async def array(data: npt.ArrayLike | AnyArray, **kwargs: Any) -> AnyAsyncArray: """Create an array filled with `data`. Parameters ---------- data : array_like The data to fill the array with. **kwargs Passed through to [`create`][zarr.api.asynchronous.create]. Returns ------- array : array The new array. """ if isinstance(data, Array): return await from_array(data=data, **kwargs) # ensure data is array-like if not hasattr(data, "shape") or not hasattr(data, "dtype"): data = np.asanyarray(data) # setup dtype kw_dtype = kwargs.get("dtype") if kw_dtype is None and hasattr(data, "dtype"): kwargs["dtype"] = data.dtype else: kwargs["dtype"] = kw_dtype # setup shape and chunks data_shape, data_chunks = _get_shape_chunks(data) kwargs["shape"] = data_shape kw_chunks = kwargs.get("chunks") if kw_chunks is None: kwargs["chunks"] = data_chunks else: kwargs["chunks"] = kw_chunks read_only = kwargs.pop("read_only", False) if read_only: raise ValueError("read_only=True is no longer supported when creating new arrays") # instantiate array z = await create(**kwargs) # fill with data await z.setitem(Ellipsis, data) return z async def group( *, # Note: this is a change from v2 store: StoreLike | None = None, overwrite: bool = False, chunk_store: StoreLike | None = None, # not used cache_attrs: bool | None = None, # not used, default changed synchronizer: Any | None = None, # not used path: str | None = None, zarr_format: ZarrFormat | None = None, meta_array: Any | None = None, # not used attributes: dict[str, JSON] | None = None, storage_options: dict[str, Any] | None = None, ) -> AsyncGroup: """Create a group. Parameters ---------- store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. overwrite : bool, optional If True, delete any pre-existing data in `store` at `path` before creating the group. chunk_store : StoreLike or None, default=None Separate storage for chunks. Not implemented. cache_attrs : bool, optional If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations. synchronizer : object, optional Array synchronizer. path : str, optional Group path within store. meta_array : array-like, optional An array instance to use for determining arrays to create and return to users. Use `numpy.empty(())` by default. zarr_format : {2, 3, None}, optional The zarr format to use when saving. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. Returns ------- g : group The new group. """ mode: AccessModeLiteral if overwrite: mode = "w" else: mode = "a" return await open_group( store=store, mode=mode, chunk_store=chunk_store, cache_attrs=cache_attrs, synchronizer=synchronizer, path=path, zarr_format=zarr_format, meta_array=meta_array, attributes=attributes, storage_options=storage_options, ) async def create_group( *, store: StoreLike, path: str | None = None, overwrite: bool = False, zarr_format: ZarrFormat | None = None, attributes: dict[str, Any] | None = None, storage_options: dict[str, Any] | None = None, ) -> AsyncGroup: """Create a group. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str, optional Group path within store. overwrite : bool, optional If True, pre-existing data at ``path`` will be deleted before creating the group. zarr_format : {2, 3, None}, optional The zarr format to use when saving. If no ``zarr_format`` is provided, the default format will be used. This default can be changed by modifying the value of ``default_zarr_format`` in [`zarr.config`][zarr.config]. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. Returns ------- AsyncGroup The new group. """ if zarr_format is None: zarr_format = _default_zarr_format() mode: Literal["a"] = "a" store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options) return await AsyncGroup.from_store( store=store_path, zarr_format=zarr_format, overwrite=overwrite, attributes=attributes, ) async def open_group( store: StoreLike | None = None, *, # Note: this is a change from v2 mode: AccessModeLiteral = "a", cache_attrs: bool | None = None, # not used, default changed synchronizer: Any = None, # not used path: str | None = None, chunk_store: StoreLike | None = None, # not used storage_options: dict[str, Any] | None = None, zarr_format: ZarrFormat | None = None, meta_array: Any | None = None, # not used attributes: dict[str, JSON] | None = None, use_consolidated: bool | str | None = None, ) -> AsyncGroup: """Open a group using file-mode-like semantics. Parameters ---------- store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. mode : {'r', 'r+', 'a', 'w', 'w-'}, optional Persistence mode: 'r' means read only (must exist); 'r+' means read/write (must exist); 'a' means read/write (create if doesn't exist); 'w' means create (overwrite if exists); 'w-' means create (fail if exists). cache_attrs : bool, optional If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations. synchronizer : object, optional Array synchronizer. path : str, optional Group path within store. chunk_store : StoreLike or None, default=None Separate storage for chunks. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. meta_array : array-like, optional An array instance to use for determining arrays to create and return to users. Use `numpy.empty(())` by default. attributes : dict A dictionary of JSON-serializable values with user-defined attributes. use_consolidated : bool or str, default None Whether to use consolidated metadata. By default, consolidated metadata is used if it's present in the store (in the ``zarr.json`` for Zarr format 3 and in the ``.zmetadata`` file for Zarr format 2). To explicitly require consolidated metadata, set ``use_consolidated=True``, which will raise an exception if consolidated metadata is not found. To explicitly *not* use consolidated metadata, set ``use_consolidated=False``, which will fall back to using the regular, non consolidated metadata. Zarr format 2 allowed configuring the key storing the consolidated metadata (``.zmetadata`` by default). Specify the custom key as ``use_consolidated`` to load consolidated metadata from a non-default key. Returns ------- g : group The new group. """ _warn_unimplemented_kwargs( { "cache_attrs": cache_attrs, "synchronizer": synchronizer, "meta_array": meta_array, "chunk_store": chunk_store, } ) store_path = await make_store_path(store, mode=mode, storage_options=storage_options, path=path) if attributes is None: attributes = {} try: if mode in _READ_MODES: return await AsyncGroup.open( store_path, zarr_format=zarr_format, use_consolidated=use_consolidated ) except (KeyError, FileNotFoundError): pass if mode in _CREATE_MODES: overwrite = _infer_overwrite(mode) _zarr_format = zarr_format or _default_zarr_format() return await AsyncGroup.from_store( store_path, zarr_format=_zarr_format, overwrite=overwrite, attributes=attributes, ) msg = f"No group found in store {store!r} at path {store_path.path!r}" raise GroupNotFoundError(msg) async def create( shape: tuple[int, ...] | int, *, # Note: this is a change from v2 chunks: tuple[int, ...] | int | bool | None = None, dtype: ZDTypeLike | None = None, compressor: CompressorLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, store: StoreLike | None = None, synchronizer: Any | None = None, overwrite: bool = False, path: PathLike | None = None, chunk_store: StoreLike | None = None, filters: Iterable[dict[str, JSON] | Numcodec] | None = None, cache_metadata: bool | None = None, cache_attrs: bool | None = None, read_only: bool | None = None, object_codec: Codec | None = None, # TODO: type has changed dimension_separator: Literal[".", "/"] | None = None, write_empty_chunks: bool | None = None, zarr_format: ZarrFormat | None = None, meta_array: Any | None = None, # TODO: need type attributes: dict[str, JSON] | None = None, # v3 only chunk_shape: tuple[int, ...] | int | None = None, chunk_key_encoding: ( ChunkKeyEncoding | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None ) = None, codecs: Iterable[Codec | dict[str, JSON]] | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, config: ArrayConfigLike | None = None, **kwargs: Any, ) -> AnyAsyncArray: """Create an array. Parameters ---------- shape : int or tuple of ints Array shape. chunks : int or tuple of ints, optional Chunk shape. If True, will be guessed from ``shape`` and ``dtype``. If False, will be set to ``shape``, i.e., single chunk for the whole array. If an int, the chunk size in each dimension will be given by the value of ``chunks``. Default is True. dtype : str or dtype, optional NumPy dtype. compressor : Codec, optional Primary compressor to compress chunk data. Zarr format 2 only. Zarr format 3 arrays should use ``codecs`` instead. If neither ``compressor`` nor ``filters`` are provided, the default compressor [`zarr.codecs.ZstdCodec`][] is used. If ``compressor`` is set to ``None``, no compression is used. fill_value : Any, optional Fill value for the array. order : {'C', 'F'}, optional Deprecated in favor of the ``config`` keyword argument. Pass ``{'order': }`` to ``create`` instead of using this parameter. Memory layout to be used within each chunk. If not specified, the ``array.order`` parameter in the global config will be used. store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. synchronizer : object, optional Array synchronizer. overwrite : bool, optional If True, delete all pre-existing data in ``store`` at ``path`` before creating the array. path : str, optional Path under which array is stored. chunk_store : StoreLike or None, default=None Separate storage for chunks. If not provided, ``store`` will be used for storage of both chunks and metadata. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. cache_metadata : bool, optional If True, array configuration metadata will be cached for the lifetime of the object. If False, array metadata will be reloaded prior to all data access and modification operations (may incur overhead depending on storage and data access pattern). cache_attrs : bool, optional If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations. read_only : bool, optional True if array should be protected against modification. object_codec : Codec, optional A codec to encode object arrays, only needed if dtype=object. dimension_separator : {'.', '/'}, optional Separator placed between the dimensions of a chunk. Zarr format 2 only. Zarr format 3 arrays should use ``chunk_key_encoding`` instead. write_empty_chunks : bool, optional Deprecated in favor of the ``config`` keyword argument. Pass ``{'write_empty_chunks': }`` to ``create`` instead of using this parameter. If True, all chunks will be stored regardless of their contents. If False, each chunk is compared to the array's fill value prior to storing. If a chunk is uniformly equal to the fill value, then that chunk is not be stored, and the store entry for that chunk's key is deleted. zarr_format : {2, 3, None}, optional The Zarr format to use when creating an array. The default is ``None``, which instructs Zarr to choose the default Zarr format value defined in the runtime configuration. meta_array : array-like, optional Not implemented. attributes : dict[str, JSON], optional A dictionary of user attributes to store with the array. chunk_shape : int or tuple of ints, optional The shape of the Array's chunks (default is None). Zarr format 3 only. Zarr format 2 arrays should use `chunks` instead. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. Zarr format 3 only. Zarr format 2 arrays should use `dimension_separator` instead. Default is ``("default", "/")``. codecs : Sequence of Codecs or dicts, optional An iterable of Codec or dict serializations of Codecs. Zarr V3 only. The elements of ``codecs`` specify the transformation from array values to stored bytes. Zarr format 3 only. Zarr format 2 arrays should use ``filters`` and ``compressor`` instead. If no codecs are provided, default codecs will be used based on the data type of the array. For most data types, the default codecs are the tuple ``(BytesCodec(), ZstdCodec())``; data types that require a special [`zarr.abc.codec.ArrayBytesCodec`][], like variable-length strings or bytes, will use the [`zarr.abc.codec.ArrayBytesCodec`][] required for the data type instead of [`zarr.codecs.BytesCodec`][]. dimension_names : Iterable[str | None] | None = None An iterable of dimension names. Zarr format 3 only. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. config : ArrayConfigLike, optional Runtime configuration of the array. If provided, will override the default values from `zarr.config.array`. Returns ------- z : array The array. """ if zarr_format is None: zarr_format = _default_zarr_format() _warn_unimplemented_kwargs( { "synchronizer": synchronizer, "chunk_store": chunk_store, "cache_metadata": cache_metadata, "cache_attrs": cache_attrs, "object_codec": object_codec, "read_only": read_only, "meta_array": meta_array, } ) if write_empty_chunks is not None: _warn_write_empty_chunks_kwarg() mode = kwargs.pop("mode", None) if mode is None: mode = "a" store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options) config_parsed = parse_array_config(config) if write_empty_chunks is not None: if config is not None: msg = ( "Both write_empty_chunks and config keyword arguments are set. " "This is redundant. When both are set, write_empty_chunks will be used instead " "of the value in config." ) warnings.warn(ZarrUserWarning(msg), stacklevel=1) config_parsed = dataclasses.replace(config_parsed, write_empty_chunks=write_empty_chunks) return await AsyncArray._create( store_path, shape=shape, chunks=chunks, # Legacy v2 behavior: an unspecified dtype defaults to float64. dtype="float64" if dtype is None else dtype, compressor=compressor, fill_value=fill_value, overwrite=overwrite, filters=filters, dimension_separator=dimension_separator, order=order, zarr_format=zarr_format, chunk_shape=chunk_shape, chunk_key_encoding=chunk_key_encoding, codecs=codecs, dimension_names=dimension_names, attributes=attributes, config=config_parsed, **kwargs, ) async def empty(shape: tuple[int, ...], **kwargs: Any) -> AnyAsyncArray: """Create an empty array with the specified shape. The contents will be filled with the specified fill value or zeros if no fill value is provided. Parameters ---------- shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ return await create(shape=shape, **kwargs) async def empty_like(a: ArrayLike, **kwargs: Any) -> AnyAsyncArray: """Create an empty array like `a`. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ like_kwargs = _like_args(a) | kwargs return await empty(**like_kwargs) # type: ignore[arg-type] # TODO: add type annotations for fill_value and kwargs async def full(shape: tuple[int, ...], fill_value: Any, **kwargs: Any) -> AnyAsyncArray: """Create an array, with `fill_value` being used as the default value for uninitialized portions of the array. Parameters ---------- shape : int or tuple of int Shape of the empty array. fill_value : scalar Fill value. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. """ return await create(shape=shape, fill_value=fill_value, **kwargs) # TODO: add type annotations for kwargs async def full_like(a: ArrayLike, **kwargs: Any) -> AnyAsyncArray: """Create a filled array like `a`. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ like_kwargs = _like_args(a) | kwargs return await full(**like_kwargs) # type: ignore[arg-type] async def ones(shape: tuple[int, ...], **kwargs: Any) -> AnyAsyncArray: """Create an array, with one being used as the default value for uninitialized portions of the array. Parameters ---------- shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ return await create(shape=shape, fill_value=1, **kwargs) async def ones_like(a: ArrayLike, **kwargs: Any) -> AnyAsyncArray: """Create an array of ones like `a`. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ like_args = _like_args(a) # `ones` supplies its own fill_value, so drop any inherited from `a`. like_args.pop("fill_value", None) like_kwargs = like_args | kwargs return await ones(**like_kwargs) # type: ignore[arg-type] async def open_array( *, # note: this is a change from v2 store: StoreLike | None = None, zarr_format: ZarrFormat | None = None, path: PathLike = "", storage_options: dict[str, Any] | None = None, **kwargs: Any, # TODO: type kwargs as valid args to save ) -> AnyAsyncArray: """Open an array using file-mode-like semantics. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str, optional Path in store to array. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs Any keyword arguments to pass to [`create`][zarr.api.asynchronous.create]. Returns ------- AsyncArray The opened array. """ mode = kwargs.pop("mode", None) store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options) if "write_empty_chunks" in kwargs: _warn_write_empty_chunks_kwarg() try: return await AsyncArray.open(store_path, zarr_format=zarr_format) except FileNotFoundError as err: if not store_path.read_only and mode in _CREATE_MODES: overwrite = _infer_overwrite(mode) _zarr_format = zarr_format or _default_zarr_format() return await create( store=store_path, zarr_format=_zarr_format, overwrite=overwrite, **kwargs, ) msg = f"No array found in store {store_path.store} at path {store_path.path}" raise ArrayNotFoundError(msg) from err async def open_like(a: ArrayLike, path: str, **kwargs: Any) -> AnyAsyncArray: """Open a persistent array like `a`. Parameters ---------- a : Array The shape and data-type of a define these same attributes of the returned array. path : str The path to the new array. **kwargs Additional keyword arguments passed to `open_array`. If `mode` is omitted or `None`, it defaults to `"a"`. Pass `mode="r"` when opening an existing array from a read-only store. Returns ------- AsyncArray The opened array. """ like_kwargs = _like_args(a) | kwargs if like_kwargs.get("mode") is None: like_kwargs["mode"] = "a" return await open_array(path=path, **like_kwargs) # type: ignore[arg-type] async def zeros(shape: tuple[int, ...], **kwargs: Any) -> AnyAsyncArray: """Create an array, with zero being used as the default value for uninitialized portions of the array. Parameters ---------- shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ return await create(shape=shape, fill_value=0, **kwargs) async def zeros_like(a: ArrayLike, **kwargs: Any) -> AnyAsyncArray: """Create an array of zeros like `a`. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. """ like_args = _like_args(a) # `zeros` supplies its own fill_value, so drop any inherited from `a`. like_args.pop("fill_value", None) like_kwargs = like_args | kwargs return await zeros(**like_kwargs) # type: ignore[arg-type] zarr-python-3.3.0/src/zarr/api/synchronous.py000066400000000000000000001531361523267620000213100ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Any, Literal from typing_extensions import deprecated import zarr.api.asynchronous as async_api import zarr.core.array from zarr.core.array import DEFAULT_FILL_VALUE, Array, AsyncArray, CompressorLike from zarr.core.group import Group from zarr.core.sync import sync from zarr.core.sync_group import create_hierarchy from zarr.errors import ZarrDeprecationWarning if TYPE_CHECKING: from collections.abc import Iterable import numpy as np import numpy.typing as npt from zarr.abc.codec import Codec from zarr.abc.numcodec import Numcodec from zarr.api.asynchronous import ArrayLike, PathLike from zarr.core.array import ( CompressorsLike, FiltersLike, SerializerLike, ShardsLike, ) from zarr.core.array_spec import ArrayConfigLike from zarr.core.buffer import NDArrayLike, NDArrayLikeOrScalar from zarr.core.chunk_key_encodings import ChunkKeyEncoding, ChunkKeyEncodingLike from zarr.core.common import ( JSON, AccessModeLiteral, ChunksLike, DimensionNamesLike, MemoryOrder, ShapeLike, ZarrFormat, ) from zarr.core.dtype import ZDTypeLike from zarr.storage import StoreLike from zarr.types import AnyArray __all__ = [ "array", "consolidate_metadata", "copy", "copy_all", "copy_store", "create", "create_array", "create_hierarchy", "empty", "empty_like", "from_array", "full", "full_like", "group", "load", "ones", "ones_like", "open", "open_array", "open_consolidated", "open_group", "open_like", "save", "save_array", "save_group", "tree", "zeros", "zeros_like", ] def consolidate_metadata( store: StoreLike, path: str | None = None, zarr_format: ZarrFormat | None = None, ) -> Group: """ Consolidate the metadata of all nodes in a hierarchy. Upon completion, the metadata of the root node in the Zarr hierarchy will be updated to include all the metadata of child nodes. For Stores that do not use consolidated metadata, this operation raises a `TypeError`. Parameters ---------- store : StoreLike The store-like object whose metadata you wish to consolidate. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str, optional A path to a group in the store to consolidate at. Only children below that group will be consolidated. By default, the root node is used so all the metadata in the store is consolidated. zarr_format : {2, 3, None}, optional The zarr format of the hierarchy. By default the zarr format is inferred. Returns ------- group: Group The group, with the ``consolidated_metadata`` field set to include the metadata of each child node. If the Store doesn't support consolidated metadata, this function raises a `TypeError`. See ``Store.supports_consolidated_metadata``. """ return Group(sync(async_api.consolidate_metadata(store, path=path, zarr_format=zarr_format))) def copy(*args: Any, **kwargs: Any) -> tuple[int, int, int]: """ Not implemented. """ return sync(async_api.copy(*args, **kwargs)) def copy_all(*args: Any, **kwargs: Any) -> tuple[int, int, int]: """ Not implemented. """ return sync(async_api.copy_all(*args, **kwargs)) def copy_store(*args: Any, **kwargs: Any) -> tuple[int, int, int]: """ Not implemented. """ return sync(async_api.copy_store(*args, **kwargs)) def load( store: StoreLike, path: str | None = None, zarr_format: ZarrFormat | None = None, ) -> NDArrayLikeOrScalar | dict[str, NDArrayLikeOrScalar]: """Load data from an array or group into memory. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str or None, optional The path within the store from which to load. Returns ------- out If the path contains an array, out will be a numpy array. If the path contains a group, out will be a dict-like object where keys are array names and values are numpy arrays. See Also -------- save, savez, open Notes ----- If loading data from a group of arrays, data will not be immediately loaded into memory. Rather, arrays will be loaded into memory as they are requested. Unlike [`open`][zarr.open], which returns a lazy [`Array`][zarr.Array] or [`Group`][zarr.Group] backed by the store, `load` eagerly reads the data and returns it as an in-memory array (or a dict of arrays for a group). The array type is NumPy by default, but follows the configured buffer prototype (for example, CuPy for GPU use cases). Use `open` when you want to read or write data incrementally without loading it all into memory. """ return sync(async_api.load(store=store, zarr_format=zarr_format, path=path)) def open( store: StoreLike | None = None, *, mode: AccessModeLiteral | None = None, zarr_format: ZarrFormat | None = None, path: str | None = None, storage_options: dict[str, Any] | None = None, **kwargs: Any, # TODO: type kwargs as valid args to async_api.open ) -> AnyArray | Group: """Open a group or array using file-mode-like semantics. Parameters ---------- store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. mode : {'r', 'r+', 'a', 'w', 'w-'}, optional Persistence mode: 'r' means read only (must exist); 'r+' means read/write (must exist); 'a' means read/write (create if doesn't exist); 'w' means create (overwrite if exists); 'w-' means create (fail if exists). If the store is read-only, the default is 'r'; otherwise, it is 'a'. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str or None, optional The path within the store to open. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs Additional parameters are passed through to `zarr.open_array` or `zarr.open_group`. Returns ------- z : array or group Return type depends on what exists in the given store. See Also -------- load Notes ----- `open` returns a lazy [`Array`][zarr.Array] or [`Group`][zarr.Group] backed by the store, so data is read and written incrementally. Use [`load`][zarr.load] instead when you want the data eagerly read into an in-memory array (a NumPy array by default). """ obj = sync( async_api.open( store=store, mode=mode, zarr_format=zarr_format, path=path, storage_options=storage_options, **kwargs, ) ) if isinstance(obj, AsyncArray): return Array(obj) else: return Group(obj) def open_consolidated(*args: Any, use_consolidated: Literal[True] = True, **kwargs: Any) -> Group: """ Alias for [`open_group`][zarr.api.synchronous.open_group] with ``use_consolidated=True``. """ return Group( sync(async_api.open_consolidated(*args, use_consolidated=use_consolidated, **kwargs)) ) def save( store: StoreLike, *args: NDArrayLike, zarr_format: ZarrFormat | None = None, path: str | None = None, **kwargs: Any, # TODO: type kwargs as valid args to async_api.save ) -> None: """Save an array or group of arrays to the local file system. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. *args : ndarray NumPy arrays with data to save. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str or None, optional The path within the group where the arrays will be saved. **kwargs NumPy arrays with data to save. """ return sync(async_api.save(store, *args, zarr_format=zarr_format, path=path, **kwargs)) def save_array( store: StoreLike, arr: NDArrayLike, *, zarr_format: ZarrFormat | None = None, path: str | None = None, storage_options: dict[str, Any] | None = None, **kwargs: Any, # TODO: type kwargs as valid args to async_api.save_array ) -> None: """Save a NumPy array to the local file system. Follows a similar API to the NumPy save() function. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. arr : ndarray NumPy array with data to save. zarr_format : {2, 3, None}, optional The zarr format to use when saving. The default is ``None``, which will use the default Zarr format defined in the global configuration object. path : str or None, optional The path within the store where the array will be saved. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs Passed through to [`create`][zarr.api.asynchronous.create], e.g., compressor. """ return sync( async_api.save_array( store=store, arr=arr, zarr_format=zarr_format, path=path, storage_options=storage_options, **kwargs, ) ) def save_group( store: StoreLike, *args: NDArrayLike, zarr_format: ZarrFormat | None = None, path: str | None = None, storage_options: dict[str, Any] | None = None, **kwargs: NDArrayLike, ) -> None: """Save several NumPy arrays to the local file system. Follows a similar API to the NumPy savez()/savez_compressed() functions. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. *args : ndarray NumPy arrays with data to save. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str or None, optional Path within the store where the group will be saved. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs NumPy arrays with data to save. """ return sync( async_api.save_group( store, *args, zarr_format=zarr_format, path=path, storage_options=storage_options, **kwargs, ) ) @deprecated("Use Group.tree instead.", category=ZarrDeprecationWarning) def tree(grp: Group, expand: bool | None = None, level: int | None = None) -> Any: """Provide a rich display of the hierarchy. !!! warning "Deprecated" `zarr.tree()` is deprecated since v3.0.0 and will be removed in a future release. Use `group.tree()` instead. Parameters ---------- grp : Group Zarr or h5py group. expand : bool, optional Only relevant for HTML representation. If True, tree will be fully expanded. level : int, optional Maximum depth to descend into hierarchy. Returns ------- TreeRepr A pretty-printable object displaying the hierarchy. """ return sync(async_api.tree(grp._async_group, expand=expand, level=level)) # TODO: add type annotations for kwargs def array(data: npt.ArrayLike | AnyArray, **kwargs: Any) -> AnyArray: """Create an array filled with `data`. Parameters ---------- data : array_like The data to fill the array with. **kwargs Passed through to [`create`][zarr.api.asynchronous.create]. Returns ------- array : Array The new array. """ return Array(sync(async_api.array(data=data, **kwargs))) def group( store: StoreLike | None = None, *, overwrite: bool = False, chunk_store: StoreLike | None = None, # not used cache_attrs: bool | None = None, # not used, default changed synchronizer: Any | None = None, # not used path: str | None = None, zarr_format: ZarrFormat | None = None, meta_array: Any | None = None, # not used attributes: dict[str, JSON] | None = None, storage_options: dict[str, Any] | None = None, ) -> Group: """Create a group. Parameters ---------- store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. overwrite : bool, optional If True, delete any pre-existing data in `store` at `path` before creating the group. chunk_store : StoreLike or None, default=None Separate storage for chunks. Not implemented. cache_attrs : bool, optional If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations. synchronizer : object, optional Array synchronizer. path : str, optional Group path within store. meta_array : array-like, optional An array instance to use for determining arrays to create and return to users. Use `numpy.empty(())` by default. zarr_format : {2, 3, None}, optional The zarr format to use when saving. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. Returns ------- g : Group The new group. """ return Group( sync( async_api.group( store=store, overwrite=overwrite, chunk_store=chunk_store, cache_attrs=cache_attrs, synchronizer=synchronizer, path=path, zarr_format=zarr_format, meta_array=meta_array, attributes=attributes, storage_options=storage_options, ) ) ) def open_group( store: StoreLike | None = None, *, mode: AccessModeLiteral = "a", cache_attrs: bool | None = None, # default changed, not used in async api synchronizer: Any = None, # not used in async api path: str | None = None, chunk_store: StoreLike | None = None, # not used in async api storage_options: dict[str, Any] | None = None, # not used in async api zarr_format: ZarrFormat | None = None, meta_array: Any | None = None, # not used in async api attributes: dict[str, JSON] | None = None, use_consolidated: bool | str | None = None, ) -> Group: """Open a group using file-mode-like semantics. Parameters ---------- store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. mode : {'r', 'r+', 'a', 'w', 'w-'}, optional Persistence mode: 'r' means read only (must exist); 'r+' means read/write (must exist); 'a' means read/write (create if doesn't exist); 'w' means create (overwrite if exists); 'w-' means create (fail if exists). cache_attrs : bool, optional If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations. synchronizer : object, optional Array synchronizer. path : str, optional Group path within store. chunk_store : StoreLike or None, default=None Separate storage for chunks. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. meta_array : array-like, optional An array instance to use for determining arrays to create and return to users. Use `numpy.empty(())` by default. attributes : dict A dictionary of JSON-serializable values with user-defined attributes. use_consolidated : bool or str, default None Whether to use consolidated metadata. By default, consolidated metadata is used if it's present in the store (in the ``zarr.json`` for Zarr format 3 and in the ``.zmetadata`` file for Zarr format 2). To explicitly require consolidated metadata, set ``use_consolidated=True``, which will raise an exception if consolidated metadata is not found. To explicitly *not* use consolidated metadata, set ``use_consolidated=False``, which will fall back to using the regular, non consolidated metadata. Zarr format 2 allowed configuring the key storing the consolidated metadata (``.zmetadata`` by default). Specify the custom key as ``use_consolidated`` to load consolidated metadata from a non-default key. Returns ------- g : Group The new group. """ return Group( sync( async_api.open_group( store=store, mode=mode, cache_attrs=cache_attrs, synchronizer=synchronizer, path=path, chunk_store=chunk_store, storage_options=storage_options, zarr_format=zarr_format, meta_array=meta_array, attributes=attributes, use_consolidated=use_consolidated, ) ) ) def create_group( store: StoreLike, *, path: str | None = None, zarr_format: ZarrFormat | None = None, overwrite: bool = False, attributes: dict[str, Any] | None = None, storage_options: dict[str, Any] | None = None, ) -> Group: """Create a group. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str, optional Group path within store. overwrite : bool, optional If True, pre-existing data at ``path`` will be deleted before creating the group. zarr_format : {2, 3, None}, optional The zarr format to use when saving. If no ``zarr_format`` is provided, the default format will be used. This default can be changed by modifying the value of ``default_zarr_format`` in [`zarr.config`][zarr.config]. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. Returns ------- Group The new group. """ return Group( sync( async_api.create_group( store=store, path=path, overwrite=overwrite, storage_options=storage_options, zarr_format=zarr_format, attributes=attributes, ) ) ) # TODO: add type annotations for kwargs def create( shape: tuple[int, ...] | int, *, # Note: this is a change from v2 chunks: tuple[int, ...] | int | bool | None = None, dtype: ZDTypeLike | None = None, compressor: CompressorLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, # TODO: need type order: MemoryOrder | None = None, store: StoreLike | None = None, synchronizer: Any | None = None, overwrite: bool = False, path: PathLike | None = None, chunk_store: StoreLike | None = None, filters: Iterable[dict[str, JSON] | Numcodec] | None = None, cache_metadata: bool | None = None, cache_attrs: bool | None = None, read_only: bool | None = None, object_codec: Codec | None = None, # TODO: type has changed dimension_separator: Literal[".", "/"] | None = None, write_empty_chunks: bool | None = None, # TODO: default has changed zarr_format: ZarrFormat | None = None, meta_array: Any | None = None, # TODO: need type attributes: dict[str, JSON] | None = None, # v3 only chunk_shape: tuple[int, ...] | int | None = None, chunk_key_encoding: ( ChunkKeyEncoding | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None ) = None, codecs: Iterable[Codec | dict[str, JSON]] | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, config: ArrayConfigLike | None = None, **kwargs: Any, ) -> AnyArray: """Create an array. Parameters ---------- shape : int or tuple of ints Array shape. chunks : int or tuple of ints, optional Chunk shape. If True, will be guessed from ``shape`` and ``dtype``. If False, will be set to ``shape``, i.e., single chunk for the whole array. If an int, the chunk size in each dimension will be given by the value of ``chunks``. Default is True. dtype : str or dtype, optional NumPy dtype. compressor : Codec, optional Primary compressor to compress chunk data. Zarr format 2 only. Zarr format 3 arrays should use ``codecs`` instead. If neither ``compressor`` nor ``filters`` are provided, the default compressor [`zarr.codecs.ZstdCodec`][] is used. If ``compressor`` is set to ``None``, no compression is used. fill_value : Any, optional Fill value for the array. order : {'C', 'F'}, optional Deprecated in favor of the ``config`` keyword argument. Pass ``{'order': }`` to ``create`` instead of using this parameter. Memory layout to be used within each chunk. If not specified, the ``array.order`` parameter in the global config will be used. store : StoreLike or None, default=None StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. synchronizer : object, optional Array synchronizer. overwrite : bool, optional If True, delete all pre-existing data in ``store`` at ``path`` before creating the array. path : str, optional Path under which array is stored. chunk_store : StoreLike or None, default=None Separate storage for chunks. If not provided, ``store`` will be used for storage of both chunks and metadata. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. cache_metadata : bool, optional If True, array configuration metadata will be cached for the lifetime of the object. If False, array metadata will be reloaded prior to all data access and modification operations (may incur overhead depending on storage and data access pattern). cache_attrs : bool, optional If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations. read_only : bool, optional True if array should be protected against modification. object_codec : Codec, optional A codec to encode object arrays, only needed if dtype=object. dimension_separator : {'.', '/'}, optional Separator placed between the dimensions of a chunk. Zarr format 2 only. Zarr format 3 arrays should use ``chunk_key_encoding`` instead. write_empty_chunks : bool, optional Deprecated in favor of the ``config`` keyword argument. Pass ``{'write_empty_chunks': }`` to ``create`` instead of using this parameter. If True, all chunks will be stored regardless of their contents. If False, each chunk is compared to the array's fill value prior to storing. If a chunk is uniformly equal to the fill value, then that chunk is not be stored, and the store entry for that chunk's key is deleted. zarr_format : {2, 3, None}, optional The Zarr format to use when creating an array. The default is ``None``, which instructs Zarr to choose the default Zarr format value defined in the runtime configuration. meta_array : array-like, optional Not implemented. attributes : dict[str, JSON], optional A dictionary of user attributes to store with the array. chunk_shape : int or tuple of ints, optional The shape of the Array's chunks (default is None). Zarr format 3 only. Zarr format 2 arrays should use `chunks` instead. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. Zarr format 3 only. Zarr format 2 arrays should use `dimension_separator` instead. Default is ``("default", "/")``. codecs : Sequence of Codecs or dicts, optional An iterable of Codec or dict serializations of Codecs. Zarr V3 only. The elements of ``codecs`` specify the transformation from array values to stored bytes. Zarr format 3 only. Zarr format 2 arrays should use ``filters`` and ``compressor`` instead. If no codecs are provided, default codecs will be used based on the data type of the array. For most data types, the default codecs are the tuple ``(BytesCodec(), ZstdCodec())``; data types that require a special [`zarr.abc.codec.ArrayBytesCodec`][], like variable-length strings or bytes, will use the [`zarr.abc.codec.ArrayBytesCodec`][] required for the data type instead of [`zarr.codecs.BytesCodec`][]. dimension_names : Iterable[str | None] | None = None An iterable of dimension names. Zarr format 3 only. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. config : ArrayConfigLike, optional Runtime configuration of the array. If provided, will override the default values from `zarr.config.array`. Returns ------- z : Array The array. """ return Array( sync( async_api.create( shape=shape, chunks=chunks, dtype=dtype, compressor=compressor, fill_value=fill_value, order=order, store=store, synchronizer=synchronizer, overwrite=overwrite, path=path, chunk_store=chunk_store, filters=filters, cache_metadata=cache_metadata, cache_attrs=cache_attrs, read_only=read_only, object_codec=object_codec, dimension_separator=dimension_separator, write_empty_chunks=write_empty_chunks, zarr_format=zarr_format, meta_array=meta_array, attributes=attributes, chunk_shape=chunk_shape, chunk_key_encoding=chunk_key_encoding, codecs=codecs, dimension_names=dimension_names, storage_options=storage_options, config=config, **kwargs, ) ) ) def create_array( store: StoreLike, *, name: str | None = None, shape: ShapeLike | None = None, dtype: ZDTypeLike | None = None, data: np.ndarray[Any, np.dtype[Any]] | None = None, chunks: ChunksLike | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", serializer: SerializerLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, zarr_format: ZarrFormat | None = 3, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, write_data: bool = True, ) -> AnyArray: """Create an array. This function wraps [zarr.core.array.create_array][]. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. name : str or None, optional The name of the array within the store. If ``name`` is ``None``, the array will be located at the root of the store. shape : ShapeLike, optional Shape of the array. Must be ``None`` if ``data`` is provided. dtype : ZDTypeLike | None Data type of the array. Must be ``None`` if ``data`` is provided. data : np.ndarray, optional Array-like data to use for initializing the array. If this parameter is provided, the ``shape`` and ``dtype`` parameters must be ``None``. chunks : tuple[int, ...] | Sequence[Sequence[int]] | Literal["auto"], default="auto" Chunk shape of the array. If chunks is "auto", a chunk shape is guessed based on the shape of the array and the dtype. A nested list of per-dimension edge sizes creates a rectilinear grid. Rectilinear chunk grids are experimental and must be explicitly enabled with ``zarr.config.set({'array.rectilinear_chunks': True})`` while the feature is stabilizing. shards : tuple[int, ...], optional Shard shape of the array. The default value of ``None`` results in no sharding at all. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec], optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. If no ``compressors`` are provided, a default set of compressors will be used. These defaults can be changed by modifying the value of ``array.v3_default_compressors`` in [`zarr.config`][zarr.config]. Use ``None`` to omit default compressors. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no ``compressor`` is provided, a default compressor will be used. in [`zarr.config`][zarr.config]. Use ``None`` to omit the default compressor. serializer : dict[str, JSON] | ArrayBytesCodec, optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no ``serializer`` is provided, a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][zarr.config]. fill_value : Any, optional Fill value for the array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If no ``order`` is provided, a default order will be used. This default can be changed by modifying the value of ``array.order`` in [`zarr.config`][zarr.config]. zarr_format : {2, 3}, optional The zarr format to use when saving. attributes : dict, optional Attributes for the array. chunk_key_encoding : ChunkKeyEncodingLike, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. dimension_names : Iterable[str], optional The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. If ``True``, all existing paths in the store will be deleted. config : ArrayConfigLike, optional Runtime configuration for the array. write_data : bool If a pre-existing array-like object was provided to this function via the ``data`` parameter then ``write_data`` determines whether the values in that array-like object should be written to the Zarr array created by this function. If ``write_data`` is ``False``, then the array will be left empty. Returns ------- Array The array. Examples -------- ```python import zarr store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(100,100), chunks=(10,10), dtype='i4', fill_value=0) # ``` """ return Array( sync( zarr.core.array.create_array( store, name=name, shape=shape, dtype=dtype, data=data, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, storage_options=storage_options, overwrite=overwrite, config=config, write_data=write_data, ) ) ) def from_array( store: StoreLike, *, data: AnyArray | npt.ArrayLike, write_data: bool = True, name: str | None = None, chunks: ChunksLike | Literal["auto", "keep"] = "keep", shards: ShardsLike | None | Literal["keep"] = "keep", filters: FiltersLike | Literal["keep"] = "keep", compressors: CompressorsLike | Literal["keep"] = "keep", serializer: SerializerLike | Literal["keep"] = "keep", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, zarr_format: ZarrFormat | None = None, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, ) -> AnyArray: """Create an array from an existing array or array-like. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. data : Array | array-like The array to copy. write_data : bool, default True Whether to copy the data from the input array to the new array. If ``write_data`` is ``False``, the new array will be created with the same metadata as the input array, but without any data. name : str or None, optional The name of the array within the store. If ``name`` is ``None``, the array will be located at the root of the store. chunks : tuple[int, ...] or Sequence[Sequence[int]] or "auto" or "keep", optional Chunk shape of the array. Following values are supported: - "auto": Automatically determine the chunk shape based on the array's shape and dtype. - "keep": Retain the chunk grid of the data array if it is a zarr Array. - tuple[int, ...]: A tuple of integers representing the chunk shape (regular grid). - Sequence[Sequence[int]]: Per-dimension chunk edge lists (rectilinear grid). Rectilinear chunk grids are experimental and must be explicitly enabled with ``zarr.config.set({'array.rectilinear_chunks': True})`` while the feature is stabilizing. If not specified, defaults to "keep" if data is a zarr Array, otherwise "auto". shards : tuple[int, ...], optional Shard shape of the array. Following values are supported: - "auto": Automatically determine the shard shape based on the array's shape and chunk shape. - "keep": Retain the shard shape of the data array if it is a zarr Array. - tuple[int, ...]: A tuple of integers representing the shard shape. - None: No sharding. If not specified, defaults to "keep" if data is a zarr Array, otherwise None. filters : Iterable[Codec] | Literal["auto", "keep"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"keep"`` instructs Zarr to infer ``filters`` from ``data``. If that inference is not possible, Zarr will fall back to the behavior specified by ``"auto"``, which is to choose default filters based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are the empty tuple ``()``. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters is a tuple with a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec] or "auto" or "keep", optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. Following values are supported: - Iterable[Codec]: List of compressors to apply to the array. - "auto": Automatically determine the compressors based on the array's dtype. - "keep": Retain the compressors of the input array if it is a zarr Array. If no ``compressors`` are provided, defaults to "keep" if data is a zarr Array, otherwise "auto". serializer : dict[str, JSON] | ArrayBytesCodec or "auto" or "keep", optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. Following values are supported: - dict[str, JSON]: A dict representation of an ``ArrayBytesCodec``. - ArrayBytesCodec: An instance of ``ArrayBytesCodec``. - "auto": a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][zarr.config]. - "keep": Retain the serializer of the input array if it is a zarr Array. fill_value : Any, optional Fill value for the array. If not specified, defaults to the fill value of the data array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If not specified, defaults to the memory order of the data array. zarr_format : {2, 3}, optional The zarr format to use when saving. If not specified, defaults to the zarr format of the data array. attributes : dict, optional Attributes for the array. If not specified, defaults to the attributes of the data array. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. If not specified and the data array has the same zarr format as the target array, the chunk key encoding of the data array is used. dimension_names : Iterable[str | None] | None The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. If not specified, defaults to the dimension names of the data array. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. config : ArrayConfig or ArrayConfigLike, optional Runtime configuration for the array. Returns ------- Array The array. Examples -------- Create an array from an existing Array: >>> import asyncio >>> import zarr >>> store = zarr.storage.LocalStore("example_from_array.zarr") >>> arr = zarr.create_array( ... store={}, ... shape=(100,100), ... chunks=(10,10), ... dtype="int32", ... fill_value=0 ... ) >>> arr2 = zarr.from_array(store, data=arr, overwrite=True) >>> arr2 >>> asyncio.run(store.clear()) # Remove files generated by test Create an array from an existing NumPy array: >>> import numpy as np >>> zarr.from_array({}, data=np.arange(10000, dtype="i4").reshape(100, 100)) Create an array from any array-like object: >>> arr3 = zarr.from_array({}, data=[[1, 2], [3, 4]]) >>> arr3 >>> arr3[...] array([[1, 2], [3, 4]]) Create an array from an existing Array without copying the data: >>> arr4 = zarr.from_array({}, data=[[1, 2], [3, 4]]) >>> arr5 = zarr.from_array({}, data=arr4, write_data=False) >>> arr5 >>> arr5[...] array([[0, 0], [0, 0]]) """ return Array( sync( zarr.core.array.from_array( store, data=data, write_data=write_data, name=name, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, storage_options=storage_options, overwrite=overwrite, config=config, ) ) ) # TODO: add type annotations for kwargs def empty(shape: tuple[int, ...], **kwargs: Any) -> AnyArray: """Create an empty array with the specified shape. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ return Array(sync(async_api.empty(shape, **kwargs))) # TODO: move ArrayLike to common module # TODO: add type annotations for kwargs def empty_like(a: ArrayLike, **kwargs: Any) -> AnyArray: """Create an empty array like another array. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ return Array(sync(async_api.empty_like(a, **kwargs))) # TODO: add type annotations for kwargs and fill_value def full(shape: tuple[int, ...], fill_value: Any, **kwargs: Any) -> AnyArray: """Create an array with a default fill value. Parameters ---------- shape : int or tuple of int Shape of the empty array. fill_value : scalar Fill value. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. """ return Array(sync(async_api.full(shape=shape, fill_value=fill_value, **kwargs))) # TODO: move ArrayLike to common module # TODO: add type annotations for kwargs def full_like(a: ArrayLike, **kwargs: Any) -> AnyArray: """Create a filled array like another array. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ return Array(sync(async_api.full_like(a, **kwargs))) # TODO: add type annotations for kwargs def ones(shape: tuple[int, ...], **kwargs: Any) -> AnyArray: """Create an array with a fill value of one. Parameters ---------- shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ return Array(sync(async_api.ones(shape, **kwargs))) # TODO: add type annotations for kwargs def ones_like(a: ArrayLike, **kwargs: Any) -> AnyArray: """Create an array of ones like another array. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ return Array(sync(async_api.ones_like(a, **kwargs))) # TODO: update this once async_api.open_array is fully implemented def open_array( store: StoreLike | None = None, *, zarr_format: ZarrFormat | None = None, path: PathLike = "", storage_options: dict[str, Any] | None = None, **kwargs: Any, ) -> AnyArray: """Open an array using file-mode-like semantics. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. zarr_format : {2, 3, None}, optional The zarr format to use when saving. path : str, optional Path in store to array. storage_options : dict If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs Any keyword arguments to pass to [`create`][zarr.api.asynchronous.create]. Returns ------- AsyncArray The opened array. """ return Array( sync( async_api.open_array( store=store, zarr_format=zarr_format, path=path, storage_options=storage_options, **kwargs, ) ) ) # TODO: add type annotations for kwargs def open_like(a: ArrayLike, path: str, **kwargs: Any) -> AnyArray: """Open a persistent array like another array. Parameters ---------- a : Array The shape and data-type of a define these same attributes of the returned array. path : str The path to the new array. **kwargs Additional keyword arguments passed to `open_array`. If `mode` is omitted or `None`, it defaults to `"a"`. Pass `mode="r"` when opening an existing array from a read-only store. Returns ------- Array The opened array. """ return Array(sync(async_api.open_like(a, path=path, **kwargs))) # TODO: add type annotations for kwargs def zeros(shape: tuple[int, ...], **kwargs: Any) -> AnyArray: """Create an array with a fill value of zero. Parameters ---------- shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [`zarr.api.asynchronous.create`][]. Returns ------- Array The new array. """ return Array(sync(async_api.zeros(shape=shape, **kwargs))) # TODO: add type annotations for kwargs def zeros_like(a: ArrayLike, **kwargs: Any) -> AnyArray: """Create an array of zeros like another array. Parameters ---------- a : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [`create`][zarr.api.asynchronous.create]. Returns ------- Array The new array. """ return Array(sync(async_api.zeros_like(a, **kwargs))) zarr-python-3.3.0/src/zarr/buffer/000077500000000000000000000000001523267620000170335ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/buffer/__init__.py000066400000000000000000000004331523267620000211440ustar00rootroot00000000000000""" Implementations of the Zarr Buffer interface. See Also ======== zarr.abc.buffer: Abstract base class for the Zarr Buffer interface. """ from zarr.buffer import cpu, gpu from zarr.core.buffer import default_buffer_prototype __all__ = ["cpu", "default_buffer_prototype", "gpu"] zarr-python-3.3.0/src/zarr/buffer/cpu.py000066400000000000000000000004161523267620000201750ustar00rootroot00000000000000from zarr.core.buffer.cpu import ( Buffer, NDBuffer, as_numpy_array_wrapper, buffer_prototype, numpy_buffer_prototype, ) __all__ = [ "Buffer", "NDBuffer", "as_numpy_array_wrapper", "buffer_prototype", "numpy_buffer_prototype", ] zarr-python-3.3.0/src/zarr/buffer/gpu.py000066400000000000000000000002111523267620000201720ustar00rootroot00000000000000from zarr.core.buffer.gpu import Buffer, NDBuffer, buffer_prototype __all__ = [ "Buffer", "NDBuffer", "buffer_prototype", ] zarr-python-3.3.0/src/zarr/codecs/000077500000000000000000000000001523267620000170225ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/codecs/__init__.py000066400000000000000000000071261523267620000211410ustar00rootroot00000000000000from __future__ import annotations from zarr.codecs.blosc import BloscCname, BloscCodec, BloscShuffle from zarr.codecs.bytes import BytesCodec, Endian from zarr.codecs.cast_value import CastValue from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.numcodecs import ( BZ2, CRC32, CRC32C, LZ4, LZMA, ZFPY, Adler32, AsType, BitRound, Blosc, Delta, FixedScaleOffset, Fletcher32, GZip, JenkinsLookup3, PackBits, PCodec, Quantize, Shuffle, Zlib, Zstd, ) from zarr.codecs.scale_offset import ScaleOffset from zarr.codecs.sharding import ShardingCodec, ShardingCodecIndexLocation, SubchunkWriteOrder from zarr.codecs.transpose import TransposeCodec from zarr.codecs.vlen_utf8 import VLenBytesCodec, VLenUTF8Codec from zarr.codecs.zstd import ZstdCodec from zarr.registry import register_codec __all__ = [ "BloscCname", "BloscCodec", "BloscShuffle", "BytesCodec", "CastValue", "Crc32cCodec", "Endian", "GzipCodec", "ScaleOffset", "ShardingCodec", "ShardingCodecIndexLocation", "SubchunkWriteOrder", "TransposeCodec", "VLenBytesCodec", "VLenUTF8Codec", "ZstdCodec", ] register_codec("blosc", BloscCodec) register_codec("cast_value", CastValue) register_codec("bytes", BytesCodec) # compatibility with earlier versions of ZEP1 register_codec("endian", BytesCodec) register_codec("crc32c", Crc32cCodec) register_codec("gzip", GzipCodec) register_codec("scale_offset", ScaleOffset) register_codec("sharding_indexed", ShardingCodec) register_codec("zstd", ZstdCodec) register_codec("vlen-utf8", VLenUTF8Codec) register_codec("vlen-bytes", VLenBytesCodec) register_codec("transpose", TransposeCodec) # Register all the codecs formerly contained in numcodecs.zarr3 register_codec("numcodecs.bz2", BZ2, qualname="zarr.codecs.numcodecs.BZ2") register_codec("numcodecs.crc32", CRC32, qualname="zarr.codecs.numcodecs.CRC32") register_codec("numcodecs.crc32c", CRC32C, qualname="zarr.codecs.numcodecs.CRC32C") register_codec("numcodecs.lz4", LZ4, qualname="zarr.codecs.numcodecs.LZ4") register_codec("numcodecs.lzma", LZMA, qualname="zarr.codecs.numcodecs.LZMA") register_codec("numcodecs.zfpy", ZFPY, qualname="zarr.codecs.numcodecs.ZFPY") register_codec("numcodecs.adler32", Adler32, qualname="zarr.codecs.numcodecs.Adler32") register_codec("numcodecs.astype", AsType, qualname="zarr.codecs.numcodecs.AsType") register_codec("numcodecs.bitround", BitRound, qualname="zarr.codecs.numcodecs.BitRound") register_codec("numcodecs.blosc", Blosc, qualname="zarr.codecs.numcodecs.Blosc") register_codec("numcodecs.delta", Delta, qualname="zarr.codecs.numcodecs.Delta") register_codec( "numcodecs.fixedscaleoffset", FixedScaleOffset, qualname="zarr.codecs.numcodecs.FixedScaleOffset", ) register_codec("numcodecs.fletcher32", Fletcher32, qualname="zarr.codecs.numcodecs.Fletcher32") register_codec("numcodecs.gzip", GZip, qualname="zarr.codecs.numcodecs.GZip") register_codec( "numcodecs.jenkins_lookup3", JenkinsLookup3, qualname="zarr.codecs.numcodecs.JenkinsLookup3" ) register_codec("numcodecs.pcodec", PCodec, qualname="zarr.codecs.numcodecs.PCodec") register_codec("numcodecs.packbits", PackBits, qualname="zarr.codecs.numcodecs.PackBits") register_codec("numcodecs.quantize", Quantize, qualname="zarr.codecs.numcodecs.Quantize") register_codec("numcodecs.shuffle", Shuffle, qualname="zarr.codecs.numcodecs.Shuffle") register_codec("numcodecs.zlib", Zlib, qualname="zarr.codecs.numcodecs.Zlib") register_codec("numcodecs.zstd", Zstd, qualname="zarr.codecs.numcodecs.Zstd") zarr-python-3.3.0/src/zarr/codecs/_deprecated_enum.py000066400000000000000000000044521523267620000226640ustar00rootroot00000000000000"""Helpers for deprecating string-valued enums in favor of literal strings. See PR #3963 for context on the deprecation pattern. """ from __future__ import annotations import warnings from enum import Enum class _DeprecatedStrEnumMeta(type): """ Metaclass for legacy enum-like classes. Accessing a member name on the class (e.g. `LegacyShim.foo`) emits a `DeprecationWarning` and returns the equivalent string. Members are declared by setting a `_members` class attribute mapping each member name to its string value. """ _members: dict[str, str] def __getattr__(cls, name: str) -> str: members: dict[str, str] = type.__getattribute__(cls, "_members") if name in members: warnings.warn( f"{cls.__name__}.{name} is deprecated; pass the string {members[name]!r} instead.", DeprecationWarning, stacklevel=2, ) return members[name] raise AttributeError(name) def _coerce_enum_input(value: object, param_name: str, codec_name: str) -> object: """ If `value` is a real `enum.Enum` instance, emit a deprecation warning naming `codec_name` and return `value.value`. Otherwise return `value` unchanged. The third argument lets the warning text name the actual codec (e.g. `BloscCodec`, `BytesCodec`, `ShardingCodec`). Note that zarr's own legacy classes (e.g. `ShardingCodecIndexLocation`) never reach the `Enum` branch here: they no longer inherit from `Enum`, and member access on them already returns a plain string (with its own warning) via `_DeprecatedStrEnumMeta`. This branch exists for enum instances defined *outside* zarr — in particular `str`-mixin enums that downstream code defined to mirror zarr's old enums, which the old `parse_enum`-based codepath accepted because they are `str` instances. Coercing them to `value.value` keeps the stored attribute a plain string and gives those callers a migration warning. """ if isinstance(value, Enum): warnings.warn( f"Passing an enum to {codec_name}(..., {param_name}=...) is deprecated; " "pass the equivalent literal string instead.", DeprecationWarning, stacklevel=3, ) return value.value return value zarr-python-3.3.0/src/zarr/codecs/_v2.py000066400000000000000000000075621523267620000200740ustar00rootroot00000000000000from __future__ import annotations import asyncio from dataclasses import dataclass from typing import TYPE_CHECKING import numpy as np from numcodecs.compat import ensure_bytes, ensure_ndarray_like from zarr.abc.codec import ArrayBytesCodec from zarr.registry import get_ndbuffer_class if TYPE_CHECKING: from zarr.abc.numcodec import Numcodec from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer, NDBuffer @dataclass(frozen=True) class V2Codec(ArrayBytesCodec): filters: tuple[Numcodec, ...] | None compressor: Numcodec | None is_fixed_size = False def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: cdata = chunk_bytes.as_array_like() # decompress if self.compressor: chunk = self.compressor.decode(cdata) else: chunk = cdata # apply filters if self.filters: for f in reversed(self.filters): chunk = f.decode(chunk) # view as numpy array with correct dtype chunk = ensure_ndarray_like(chunk) # special case object dtype, because incorrect handling can lead to # segfaults and other bad things happening if chunk_spec.dtype.dtype_cls is not np.dtypes.ObjectDType: try: chunk = chunk.view(chunk_spec.dtype.to_native_dtype()) except TypeError: # this will happen if the dtype of the chunk # does not match the dtype of the array spec i.g. if # the dtype of the chunk_spec is a string dtype, but the chunk # is an object array. In this case, we need to convert the object # array to the correct dtype. chunk = np.array(chunk).astype(chunk_spec.dtype.to_native_dtype()) elif chunk.dtype != object: # If we end up here, someone must have hacked around with the filters. # We cannot deal with object arrays unless there is an object # codec in the filter chain, i.e., a filter that converts from object # array to something else during encoding, and converts back to object # array during decoding. raise RuntimeError("cannot read object array without object codec") # ensure correct chunk shape chunk = chunk.reshape(-1, order="A") chunk = chunk.reshape(chunk_spec.shape, order=chunk_spec.order) return get_ndbuffer_class().from_ndarray_like(chunk) def _encode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: chunk = chunk_array.as_ndarray_like() # ensure contiguous and correct order chunk = chunk.astype(chunk_spec.dtype.to_native_dtype(), order=chunk_spec.order, copy=False) # apply filters if self.filters: for f in self.filters: chunk = f.encode(chunk) # check object encoding if ensure_ndarray_like(chunk).dtype == object: raise RuntimeError("cannot write object array without object codec") # compress if self.compressor: cdata = self.compressor.encode(chunk) else: cdata = chunk cdata = ensure_bytes(cdata) return chunk_spec.prototype.buffer.from_bytes(cdata) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: return await asyncio.to_thread(self._decode_sync, chunk_bytes, chunk_spec) async def _encode_single( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: return await asyncio.to_thread(self._encode_sync, chunk_array, chunk_spec) def compute_encoded_size(self, _input_byte_length: int, _chunk_spec: ArraySpec) -> int: raise NotImplementedError zarr-python-3.3.0/src/zarr/codecs/blosc.py000066400000000000000000000272701523267620000205060ustar00rootroot00000000000000from __future__ import annotations import asyncio from dataclasses import dataclass, field, replace from functools import cached_property from typing import TYPE_CHECKING, ClassVar, Final, Literal, NotRequired, TypedDict import numcodecs from numcodecs.blosc import Blosc from packaging.version import Version from zarr.abc.codec import BytesBytesCodec from zarr.codecs._deprecated_enum import _coerce_enum_input, _DeprecatedStrEnumMeta from zarr.core.buffer.cpu import as_numpy_array_wrapper from zarr.core.common import JSON, NamedRequiredConfig, parse_named_configuration from zarr.core.dtype.common import HasItemSize if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer BloscShuffleLiteral = Literal["noshuffle", "shuffle", "bitshuffle"] """The shuffle values permitted for the blosc codec""" BLOSC_SHUFFLE: Final = ("noshuffle", "shuffle", "bitshuffle") BloscCnameLiteral = Literal["lz4", "lz4hc", "blosclz", "snappy", "zlib", "zstd"] """The codec identifiers used in the blosc codec""" BLOSC_CNAME: Final = ("lz4", "lz4hc", "blosclz", "snappy", "zlib", "zstd") class BloscConfigV2(TypedDict): """Configuration for the V2 Blosc codec""" cname: BloscCnameLiteral clevel: int shuffle: int blocksize: int typesize: NotRequired[int] class BloscConfigV3(TypedDict): """Configuration for the V3 Blosc codec""" cname: BloscCnameLiteral clevel: int shuffle: BloscShuffleLiteral blocksize: int typesize: int class BloscJSON_V3(NamedRequiredConfig[Literal["blosc"], BloscConfigV3]): """ The JSON form of the Blosc codec in Zarr V3. """ class BloscShuffle(metaclass=_DeprecatedStrEnumMeta): """ Deprecated. Pass a literal string (`"noshuffle"`, `"shuffle"`, or `"bitshuffle"`) directly to `BloscCodec` instead. """ _members: ClassVar[dict[str, str]] = { "noshuffle": "noshuffle", "shuffle": "shuffle", "bitshuffle": "bitshuffle", } @staticmethod def from_int(num: int) -> BloscShuffleLiteral: mapping: dict[int, BloscShuffleLiteral] = { 0: "noshuffle", 1: "shuffle", 2: "bitshuffle", } if num not in mapping: raise ValueError(f"Value must be between 0 and 2. Got {num}.") return mapping[num] class BloscCname(metaclass=_DeprecatedStrEnumMeta): """ Deprecated. Pass a literal string (one of `"lz4"`, `"lz4hc"`, `"blosclz"`, `"snappy"`, `"zlib"`, `"zstd"`) directly to `BloscCodec` instead. """ _members: ClassVar[dict[str, str]] = { "lz4": "lz4", "lz4hc": "lz4hc", "blosclz": "blosclz", "snappy": "snappy", "zstd": "zstd", "zlib": "zlib", } # See https://zarr.readthedocs.io/en/stable/user-guide/performance.html#configuring-blosc numcodecs.blosc.use_threads = False def parse_typesize(data: JSON) -> int: if isinstance(data, int): if data > 0: return data else: raise ValueError( f"Value must be greater than 0. Got {data}, which is less or equal to 0." ) raise TypeError(f"Value must be an int. Got {type(data)} instead.") # todo: real validation def parse_clevel(data: JSON) -> int: if isinstance(data, int): return data raise TypeError(f"Value should be an int. Got {type(data)} instead.") def parse_blocksize(data: JSON) -> int: if isinstance(data, int): return data raise TypeError(f"Value should be an int. Got {type(data)} instead.") def _parse_cname(data: object) -> BloscCnameLiteral: if isinstance(data, str) and data in BLOSC_CNAME: return data # type: ignore[return-value] raise ValueError(f"cname must be one of {list(BLOSC_CNAME)!r}. Got {data!r}.") def _parse_shuffle(data: object) -> BloscShuffleLiteral: if isinstance(data, str) and data in BLOSC_SHUFFLE: return data # type: ignore[return-value] raise ValueError(f"shuffle must be one of {list(BLOSC_SHUFFLE)!r}. Got {data!r}.") @dataclass(frozen=True) class BloscCodec(BytesBytesCodec): """ Blosc compression codec for zarr. Blosc is a high-performance compressor optimized for binary data. It uses a combination of blocking, shuffling, and fast compression algorithms to achieve excellent compression ratios and speed. Attributes ---------- is_fixed_size : bool Always False for Blosc codec, as compression produces variable-sized output. typesize : int The data type size in bytes used for shuffle filtering. cname : BloscCnameLiteral The compression algorithm being used; one of "lz4", "lz4hc", "blosclz", "snappy", "zlib", or "zstd". clevel : int The compression level (0-9). shuffle : BloscShuffleLiteral The shuffle filter mode; one of "noshuffle", "shuffle", or "bitshuffle". blocksize : int The size of compressed blocks in bytes (0 for automatic). Parameters ---------- typesize : int, optional The data type size in bytes. This affects how the shuffle filter processes the data. If None, defaults to 1 and the attribute is marked as tunable. Default: 1. cname : BloscCnameLiteral, optional The compression algorithm to use; one of "lz4", "lz4hc", "blosclz", "snappy", "zlib", or "zstd". Default is "zstd". Passing a `BloscCname` enum is deprecated. clevel : int, optional The compression level, from 0 (no compression) to 9 (maximum compression). Higher values provide better compression at the cost of speed. Default: 5. shuffle : BloscShuffleLiteral or None, optional The shuffle filter to apply before compression; one of "noshuffle", "shuffle", or "bitshuffle": - 'noshuffle': No shuffling - 'shuffle': Byte shuffling (better for typesize > 1) - 'bitshuffle': Bit shuffling (better for typesize == 1) If None, defaults to 'bitshuffle' and the attribute is marked as tunable. Default: 'bitshuffle'. blocksize : int, optional The requested size of compressed blocks in bytes. A value of 0 means automatic block size selection. Default: 0. Notes ----- **Tunable attributes**: If `typesize` or `shuffle` are set to None during initialization, they are marked as tunable attributes. This means they can be adjusted later based on the data type of the array being compressed. **Thread Safety**: This codec sets `numcodecs.blosc.use_threads = False` at module import time to avoid threading issues in asyncio contexts. Examples -------- Create a Blosc codec with default settings: >>> codec = BloscCodec() >>> codec.typesize 1 >>> codec.shuffle 'bitshuffle' Create a codec with specific compression settings: >>> codec = BloscCodec(cname='zstd', clevel=9, shuffle='shuffle') >>> codec.cname 'zstd' """ # This attribute tracks parameters were set to None at init time, and thus tunable _tunable_attrs: set[Literal["typesize", "shuffle"]] = field(init=False) is_fixed_size = False typesize: int cname: BloscCnameLiteral clevel: int shuffle: BloscShuffleLiteral blocksize: int def __init__( self, *, typesize: int | None = None, cname: BloscCname | BloscCnameLiteral = "zstd", clevel: int = 5, shuffle: BloscShuffle | BloscShuffleLiteral | None = None, blocksize: int = 0, ) -> None: object.__setattr__(self, "_tunable_attrs", set()) if typesize is None: typesize = 1 self._tunable_attrs.update({"typesize"}) if shuffle is None: shuffle = "bitshuffle" self._tunable_attrs.update({"shuffle"}) cname = _coerce_enum_input(cname, "cname", "BloscCodec") # type: ignore[assignment] shuffle = _coerce_enum_input(shuffle, "shuffle", "BloscCodec") # type: ignore[assignment] typesize_parsed = parse_typesize(typesize) cname_parsed = _parse_cname(cname) clevel_parsed = parse_clevel(clevel) shuffle_parsed = _parse_shuffle(shuffle) blocksize_parsed = parse_blocksize(blocksize) object.__setattr__(self, "typesize", typesize_parsed) object.__setattr__(self, "cname", cname_parsed) object.__setattr__(self, "clevel", clevel_parsed) object.__setattr__(self, "shuffle", shuffle_parsed) object.__setattr__(self, "blocksize", blocksize_parsed) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration(data, "blosc") return cls(**configuration_parsed) # type: ignore[arg-type] def to_dict(self) -> dict[str, JSON]: result: BloscJSON_V3 = { "name": "blosc", "configuration": { "typesize": self.typesize, "cname": self.cname, "clevel": self.clevel, "shuffle": self.shuffle, "blocksize": self.blocksize, }, } return result # type: ignore[return-value] def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: """ Create a new codec with typesize and shuffle parameters adjusted according to the size of each element in the data type associated with array_spec. Parameters are only updated if they were set to None when self.__init__ was called. """ item_size = 1 if isinstance(array_spec.dtype, HasItemSize): item_size = array_spec.dtype.item_size new_codec = self if "typesize" in self._tunable_attrs: new_codec = replace(new_codec, typesize=item_size) if "shuffle" in self._tunable_attrs: new_codec = replace( new_codec, shuffle=("bitshuffle" if item_size == 1 else "shuffle"), ) return new_codec @cached_property def _blosc_codec(self) -> Blosc: map_shuffle_str_to_int: dict[BloscShuffleLiteral, int] = { "noshuffle": 0, "shuffle": 1, "bitshuffle": 2, } config_dict: BloscConfigV2 = { "cname": self.cname, "clevel": self.clevel, "shuffle": map_shuffle_str_to_int[self.shuffle], "blocksize": self.blocksize, } # See https://github.com/zarr-developers/numcodecs/pull/713 if Version(numcodecs.__version__) >= Version("0.16.0"): config_dict["typesize"] = self.typesize return Blosc.from_config(config_dict) def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return as_numpy_array_wrapper(self._blosc_codec.decode, chunk_bytes, chunk_spec.prototype) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return await asyncio.to_thread(self._decode_sync, chunk_bytes, chunk_spec) def _encode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: # Since blosc only support host memory, we convert the input and output of the encoding # between numpy array and buffer return chunk_spec.prototype.buffer.from_bytes( self._blosc_codec.encode(chunk_bytes.as_numpy_array()) ) async def _encode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: return await asyncio.to_thread(self._encode_sync, chunk_bytes, chunk_spec) def compute_encoded_size(self, _input_byte_length: int, _chunk_spec: ArraySpec) -> int: raise NotImplementedError zarr-python-3.3.0/src/zarr/codecs/bytes.py000066400000000000000000000146141523267620000205300ustar00rootroot00000000000000from __future__ import annotations import sys import warnings from dataclasses import dataclass, replace from typing import TYPE_CHECKING, ClassVar, Final, Literal from zarr.abc.codec import ArrayBytesCodec from zarr.codecs._deprecated_enum import _coerce_enum_input, _DeprecatedStrEnumMeta from zarr.core.buffer import Buffer, NDBuffer from zarr.core.common import JSON, parse_named_configuration from zarr.core.dtype.common import HasEndianness from zarr.core.dtype.npy.structured import Struct if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec EndianLiteral = Literal["little", "big"] """Byte order of multi-byte numeric data.""" ENDIAN: Final = ("little", "big") class Endian(metaclass=_DeprecatedStrEnumMeta): """ Deprecated. Pass a literal string (`"little"` or `"big"`) directly to `BytesCodec` instead. """ _members: ClassVar[dict[str, str]] = {"little": "little", "big": "big"} def _parse_endian(data: object) -> EndianLiteral: if isinstance(data, str) and data in ENDIAN: return data # type: ignore[return-value] raise ValueError(f"endian must be one of {list(ENDIAN)!r}. Got {data!r}.") @dataclass(frozen=True) class BytesCodec(ArrayBytesCodec): """bytes codec""" is_fixed_size = True endian: EndianLiteral | None def __init__(self, *, endian: Endian | EndianLiteral | None = sys.byteorder) -> None: if endian is None: endian_parsed: EndianLiteral | None = None else: coerced = _coerce_enum_input(endian, "endian", "BytesCodec") endian_parsed = _parse_endian(coerced) object.__setattr__(self, "endian", endian_parsed) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration( data, "bytes", require_configuration=False ) configuration_parsed = configuration_parsed or {} configuration_parsed.setdefault("endian", None) return cls(**configuration_parsed) # type: ignore[arg-type] def to_dict(self) -> dict[str, JSON]: if self.endian is None: return {"name": "bytes"} else: return {"name": "bytes", "configuration": {"endian": self.endian}} def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: if isinstance(array_spec.dtype, Struct): if array_spec.dtype.has_multi_byte_fields(): if self.endian is None: warnings.warn( "Missing 'endian' for structured dtype with multi-byte fields. " "Assuming little-endian for legacy compatibility.", UserWarning, stacklevel=2, ) return replace(self, endian="little") else: if self.endian is not None: return replace(self, endian=None) elif not isinstance(array_spec.dtype, HasEndianness): if self.endian is not None: return replace(self, endian=None) elif self.endian is None: raise ValueError( "The `endian` configuration needs to be specified for multi-byte data types." ) return self def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: endian_str = self.endian dtype = chunk_spec.dtype.to_native_dtype() # The byte order of the stored data is set by this codec's `endian` # configuration; the byte order of the decoded array is set by the array's # data type. The two are independent: the raw bytes are viewed with a dtype # in the stored byte order, then converted to the declared dtype if needed. if isinstance(chunk_spec.dtype, HasEndianness): view_dtype = replace(chunk_spec.dtype, endianness=endian_str).to_native_dtype() # type: ignore[call-arg] elif isinstance(chunk_spec.dtype, Struct) and endian_str is not None: # Per the struct data type spec, all multi-byte fields are stored in the # byte order configured on this codec. view_dtype = dtype.newbyteorder(endian_str) else: view_dtype = dtype as_array_like = chunk_bytes.as_array_like() chunk_array = chunk_spec.prototype.nd_buffer.from_ndarray_like( as_array_like.view(dtype=view_dtype) # type: ignore[attr-defined] ) if view_dtype != dtype: # This byte-swapping conversion copies the chunk. The dtype inequality # guard keeps the common case, where the stored and declared byte orders # already match, on the zero-copy view path above. chunk_array = chunk_array.astype(dtype) # ensure correct chunk shape if chunk_array.shape != chunk_spec.shape: chunk_array = chunk_array.reshape( chunk_spec.shape, ) return chunk_array async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: return self._decode_sync(chunk_bytes, chunk_spec) def _encode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: assert isinstance(chunk_array, NDBuffer) if chunk_array.dtype.itemsize > 1 and self.endian is not None: # Compare full dtypes rather than the top-level byteorder: numpy reports # byteorder '|' for structured dtypes even when their fields are # byte-order-sensitive, so newbyteorder is the only reliable way to # detect (and normalize) a byte-order mismatch. new_dtype = chunk_array.dtype.newbyteorder(self.endian) if new_dtype != chunk_array.dtype: chunk_array = chunk_array.astype(new_dtype) nd_array = chunk_array.as_ndarray_like() # Flatten the nd-array (only copy if needed) and reinterpret as bytes nd_array = nd_array.ravel().view(dtype="B") return chunk_spec.prototype.buffer.from_array_like(nd_array) async def _encode_single( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: return self._encode_sync(chunk_array, chunk_spec) def compute_encoded_size(self, input_byte_length: int, _chunk_spec: ArraySpec) -> int: return input_byte_length zarr-python-3.3.0/src/zarr/codecs/cast_value.py000066400000000000000000000347721523267620000215370ustar00rootroot00000000000000"""Cast-value array-to-array codec. Value-converts array elements to a new data type during encoding, and back to the original data type during decoding, with configurable rounding, out-of-range handling, and explicit scalar mappings. Requires the optional ``cast-value-rs`` package for the actual casting logic. Install it with: ``pip install cast-value-rs``. """ from __future__ import annotations from collections.abc import Mapping from dataclasses import dataclass, replace from typing import TYPE_CHECKING, Final, Literal, TypedDict, cast import numpy as np from zarr.abc.codec import ArrayArrayCodec from zarr.core.common import JSON, parse_named_configuration from zarr.core.dtype import get_data_type_from_json if TYPE_CHECKING: from typing import NotRequired, Self from zarr.core.array_spec import ArraySpec from zarr.core.buffer import NDBuffer from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.core.metadata.v3 import ChunkGridMetadata class ScalarMapJSON(TypedDict): encode: NotRequired[list[tuple[object, object]]] decode: NotRequired[list[tuple[object, object]]] RoundingMode = Literal[ "nearest-even", "towards-zero", "towards-positive", "towards-negative", "nearest-away", ] OutOfRangeMode = Literal["clamp", "wrap"] class ScalarMap(TypedDict, total=False): """ The normalized, in-memory form of a scalar map. """ encode: Mapping[str | float | int, str | float | int] decode: Mapping[str | float | int, str | float | int] # see https://github.com/zarr-developers/zarr-extensions/tree/main/codecs/cast_value CAST_VALUE_INT_DTYPES: Final[set[str]] = { # signed "int2", "int4", "int8", "int16", "int32", "int64", # unsigned "uint2", "uint4", "uint8", "uint16", "uint32", "uint64", } """Integer dtype identifiers permitted as the source or target of `cast_value`. Membership in this set drives the `out_of_range="wrap"` rule, which the spec restricts to integral targets that use two's-complement representation for modular arithmetic. """ CAST_VALUE_FLOAT_DTYPES: Final[set[str]] = { "float4_e2m1fn", "float6_e2m3fn", "float6_e3m2fn", "float8_e3m4", "float8_e4m3", "float8_e4m3b11fnuz", "float8_e4m3fnuz", "float8_e5m2", "float8_e5m2fnuz", "float8_e8m0fnu", "bfloat16", "float16", "float32", "float64", } """Floating-point dtype identifiers permitted as the source or target of `cast_value`.""" PERMITTED_DATA_TYPE_NAMES: Final[set[str]] = CAST_VALUE_INT_DTYPES | CAST_VALUE_FLOAT_DTYPES """All dtype identifiers the `cast_value` codec is defined for.""" def parse_scalar_map(obj: ScalarMapJSON | ScalarMap) -> ScalarMap: """ Parse a scalar map into its normalized dict-of-dicts form. Accepts either the JSON form (lists of tuples) or an already-normalized form (dicts). For example, ``{"encode": [("NaN", 0)]}`` becomes ``{"encode": {"NaN": 0}}``. """ result: ScalarMap = {} for direction in ("encode", "decode"): if direction in obj: entries = obj[direction] if entries is not None: if isinstance(entries, Mapping): result[direction] = entries else: result[direction] = dict(entries) # type: ignore[arg-type] return result # --------------------------------------------------------------------------- # Backend: cast-value-rs # --------------------------------------------------------------------------- try: from cast_value_rs import cast_array as cast_array_rs _HAS_RUST_BACKEND = True except ModuleNotFoundError: _HAS_RUST_BACKEND = False def _check_representable( value: JSON, zdtype: ZDType[TBaseDType, TBaseScalar], label: str, ) -> None: """Raise ``ValueError`` if *value* cannot be parsed by *zdtype*.""" try: zdtype.from_json_scalar(value, zarr_format=3) except (TypeError, ValueError, OverflowError) as e: raise ValueError( f"{label} {value!r} is not representable in dtype {zdtype.to_native_dtype()}." ) from e # --------------------------------------------------------------------------- # Codec # --------------------------------------------------------------------------- @dataclass(frozen=True) class CastValue(ArrayArrayCodec): """Cast-value array-to-array codec. Value-converts array elements to a new data type during encoding, and back to the original data type during decoding. Requires the `cast-value-rs` package for the actual casting logic. Parameters ---------- data_type : str or ZDType Target zarr v3 data type. Strings are looked up by spec name (e.g. "uint8", "float32"); a `ZDType` instance is used as-is. rounding : RoundingMode How to round when exact representation is impossible. Default is "nearest-even". out_of_range : OutOfRangeMode or None What to do when a value is outside the target's range. `None` means error; "clamp" clips to range; "wrap" uses modular arithmetic (only valid for integer types). Default is `None`. scalar_map : ScalarMap, ScalarMapJSON, or None Explicit mapping from input scalars to output scalars. Default is `None`. Attributes ---------- dtype : ZDType Resolved target data type (a `ZDType` instance, regardless of whether the constructor received a string or a `ZDType`). rounding : RoundingMode The rounding mode, as supplied to the constructor. out_of_range : OutOfRangeMode or None The out-of-range behaviour, as supplied to the constructor. scalar_map : ScalarMap or None Parsed scalar map (always normalized to `ScalarMap` form). References ---------- - The `cast_value` codec spec: https://github.com/zarr-developers/zarr-extensions/tree/main/codecs/cast_value """ is_fixed_size = True dtype: ZDType[TBaseDType, TBaseScalar] rounding: RoundingMode out_of_range: OutOfRangeMode | None scalar_map: ScalarMap | None def __init__( self, *, data_type: str | ZDType[TBaseDType, TBaseScalar], rounding: RoundingMode = "nearest-even", out_of_range: OutOfRangeMode | None = None, scalar_map: ScalarMapJSON | ScalarMap | None = None, ) -> None: if isinstance(data_type, str): zdtype = get_data_type_from_json(data_type, zarr_format=3) else: zdtype = data_type if zdtype.to_json(zarr_format=3) not in PERMITTED_DATA_TYPE_NAMES: raise ValueError( f"Invalid target data type {data_type!r}. " f"cast_value codec only supports integer and floating-point data types. " f"Got {zdtype}." ) object.__setattr__(self, "dtype", zdtype) object.__setattr__(self, "rounding", rounding) object.__setattr__(self, "out_of_range", out_of_range) if scalar_map is not None: parsed = parse_scalar_map(scalar_map) else: parsed = None object.__setattr__(self, "scalar_map", parsed) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration( data, "cast_value", require_configuration=True ) return cls(**configuration_parsed) # type: ignore[arg-type] def to_dict(self) -> dict[str, JSON]: config: dict[str, JSON] = {"data_type": cast("JSON", self.dtype.to_json(zarr_format=3))} if self.rounding != "nearest-even": config["rounding"] = self.rounding if self.out_of_range is not None: config["out_of_range"] = self.out_of_range if self.scalar_map is not None: json_map: dict[str, list[tuple[object, object]]] = {} for direction in ("encode", "decode"): if direction in self.scalar_map: json_map[direction] = [(k, v) for k, v in self.scalar_map[direction].items()] config["scalar_map"] = cast("JSON", json_map) return {"name": "cast_value", "configuration": config} def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: # `dtype` is the source (the array's dtype); `self.dtype` is the # cast target. The spec requires both to be permitted, and rules # like `out_of_range="wrap"` apply to the target. source_name = dtype.to_json(zarr_format=3) target_name = self.dtype.to_json(zarr_format=3) for role, name in (("source", source_name), ("target", target_name)): if name not in PERMITTED_DATA_TYPE_NAMES: raise ValueError( f"The cast_value codec only supports integer and floating-point data types. " f"Got {role} dtype {name}." ) if self.out_of_range == "wrap" and target_name not in CAST_VALUE_INT_DTYPES: raise ValueError( f"out_of_range='wrap' is only valid for integer target types. " f"Got target dtype {target_name}." ) if self.scalar_map is not None: self._validate_scalar_map(dtype, self.dtype) def _validate_scalar_map( self, source_zdtype: ZDType[TBaseDType, TBaseScalar], target_zdtype: ZDType[TBaseDType, TBaseScalar], ) -> None: """Validate that scalar map entries are compatible with source/target dtypes.""" assert self.scalar_map is not None # For encode: keys are source values, values are target values. # For decode: keys are target values, values are source values. direction_dtypes: dict[ str, tuple[ZDType[TBaseDType, TBaseScalar], ZDType[TBaseDType, TBaseScalar]] ] = { "encode": (source_zdtype, target_zdtype), "decode": (target_zdtype, source_zdtype), } for direction, (key_zdtype, val_zdtype) in direction_dtypes.items(): if direction not in self.scalar_map: continue sub_map = self.scalar_map[direction] # type: ignore[literal-required] for k, v in sub_map.items(): _check_representable(k, key_zdtype, f"scalar_map {direction} key") _check_representable(v, val_zdtype, f"scalar_map {direction} value") def _do_cast( self, arr: np.ndarray, *, target_dtype: np.dtype, scalar_map: Mapping[str | float | int, str | float | int] | None, ) -> np.ndarray: if not _HAS_RUST_BACKEND: raise ImportError( "The cast_value codec requires the 'cast-value-rs' package. " "Install it with: pip install cast-value-rs" ) scalar_map_entries: dict[float | int, float | int] | None = None if scalar_map is not None: src_dtype = arr.dtype to_src = int if np.issubdtype(src_dtype, np.integer) else float to_tgt = int if np.issubdtype(target_dtype, np.integer) else float scalar_map_entries = {to_src(k): to_tgt(v) for k, v in scalar_map.items()} return cast_array_rs( # type: ignore[no-any-return] arr, target_dtype=target_dtype, rounding_mode=self.rounding, out_of_range_mode=self.out_of_range, scalar_map_entries=scalar_map_entries, ) def _get_scalar_map( self, direction: str ) -> Mapping[str | float | int, str | float | int] | None: """Extract the encode or decode mapping from scalar_map, or None.""" if self.scalar_map is None: return None return self.scalar_map.get(direction) # type: ignore[return-value] def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: """ Update the fill value of the output spec by applying casting procedure. """ target_zdtype = self.dtype target_native = target_zdtype.to_native_dtype() source_native = chunk_spec.dtype.to_native_dtype() fill = chunk_spec.fill_value fill_arr = np.array([fill], dtype=source_native) new_fill_arr = self._do_cast( fill_arr, target_dtype=target_native, scalar_map=self._get_scalar_map("encode") ) new_fill = target_native.type(new_fill_arr[0]) return replace(chunk_spec, dtype=target_zdtype, fill_value=new_fill) def _encode_sync( self, chunk_array: NDBuffer, _chunk_spec: ArraySpec, ) -> NDBuffer | None: arr = chunk_array.as_ndarray_like() target_native = self.dtype.to_native_dtype() result = self._do_cast( np.asarray(arr), target_dtype=target_native, scalar_map=self._get_scalar_map("encode") ) return chunk_array.__class__.from_ndarray_like(result) async def _encode_single( self, chunk_data: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer | None: return self._encode_sync(chunk_data, chunk_spec) def _decode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer: arr = chunk_array.as_ndarray_like() target_native = chunk_spec.dtype.to_native_dtype() result = self._do_cast( np.asarray(arr), target_dtype=target_native, scalar_map=self._get_scalar_map("decode") ) return chunk_array.__class__.from_ndarray_like(result) async def _decode_single( self, chunk_data: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer: return self._decode_sync(chunk_data, chunk_spec) def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: dtype_name = chunk_spec.dtype.to_json(zarr_format=3) if dtype_name not in PERMITTED_DATA_TYPE_NAMES: raise ValueError( "cast_value codec only supports fixed-size integer and floating-point data types. " f"Got source dtype: {chunk_spec.dtype}." ) source_itemsize = chunk_spec.dtype.to_native_dtype().itemsize target_itemsize = self.dtype.to_native_dtype().itemsize if source_itemsize == 0 or target_itemsize == 0: raise ValueError( "cast_value codec requires fixed-size data types. " f"Got source itemsize={source_itemsize}, target itemsize={target_itemsize}." ) num_elements = input_byte_length // source_itemsize return num_elements * target_itemsize zarr-python-3.3.0/src/zarr/codecs/crc32c_.py000066400000000000000000000047251523267620000206220ustar00rootroot00000000000000from __future__ import annotations from collections.abc import Buffer as ABCBuffer from dataclasses import dataclass from typing import TYPE_CHECKING, cast import google_crc32c import numpy as np from zarr.abc.codec import BytesBytesCodec from zarr.core.common import JSON, parse_named_configuration if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer @dataclass(frozen=True) class Crc32cCodec(BytesBytesCodec): """crc32c codec""" is_fixed_size = True @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: parse_named_configuration(data, "crc32c", require_configuration=False) return cls() def to_dict(self) -> dict[str, JSON]: return {"name": "crc32c"} def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: data = chunk_bytes.as_numpy_array() crc32_bytes = data[-4:] inner_bytes = data[:-4] # Need to do a manual cast until https://github.com/numpy/numpy/issues/26783 is resolved computed_checksum = np.uint32(google_crc32c.value(cast(ABCBuffer, inner_bytes))).tobytes() stored_checksum = bytes(crc32_bytes) if computed_checksum != stored_checksum: raise ValueError( f"Stored and computed checksum do not match. Stored: {stored_checksum!r}. Computed: {computed_checksum!r}." ) return chunk_spec.prototype.buffer.from_array_like(inner_bytes) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return self._decode_sync(chunk_bytes, chunk_spec) def _encode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: data = chunk_bytes.as_numpy_array() # Calculate the checksum and "cast" it to a numpy array checksum = np.array([google_crc32c.value(cast(ABCBuffer, data))], dtype=np.uint32) # Append the checksum (as bytes) to the data return chunk_spec.prototype.buffer.from_array_like(np.append(data, checksum.view("B"))) async def _encode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: return self._encode_sync(chunk_bytes, chunk_spec) def compute_encoded_size(self, input_byte_length: int, _chunk_spec: ArraySpec) -> int: return input_byte_length + 4 zarr-python-3.3.0/src/zarr/codecs/gzip.py000066400000000000000000000047071523267620000203550ustar00rootroot00000000000000from __future__ import annotations import asyncio from dataclasses import dataclass from functools import cached_property from typing import TYPE_CHECKING from numcodecs.gzip import GZip from zarr.abc.codec import BytesBytesCodec from zarr.core.buffer.cpu import as_numpy_array_wrapper from zarr.core.common import JSON, parse_named_configuration if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer def parse_gzip_level(data: JSON) -> int: if not isinstance(data, (int)): raise TypeError(f"Expected int, got {type(data)}") if data not in range(10): raise ValueError( f"Expected an integer from the inclusive range (0, 9). Got {data} instead." ) return data @dataclass(frozen=True) class GzipCodec(BytesBytesCodec): """gzip codec""" is_fixed_size = False level: int = 5 def __init__(self, *, level: int = 5) -> None: level_parsed = parse_gzip_level(level) object.__setattr__(self, "level", level_parsed) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration(data, "gzip") return cls(**configuration_parsed) # type: ignore[arg-type] def to_dict(self) -> dict[str, JSON]: return {"name": "gzip", "configuration": {"level": self.level}} @cached_property def _gzip_codec(self) -> GZip: return GZip(self.level) def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return as_numpy_array_wrapper(self._gzip_codec.decode, chunk_bytes, chunk_spec.prototype) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return await asyncio.to_thread(self._decode_sync, chunk_bytes, chunk_spec) def _encode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: return as_numpy_array_wrapper(self._gzip_codec.encode, chunk_bytes, chunk_spec.prototype) async def _encode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: return await asyncio.to_thread(self._encode_sync, chunk_bytes, chunk_spec) def compute_encoded_size( self, _input_byte_length: int, _chunk_spec: ArraySpec, ) -> int: raise NotImplementedError zarr-python-3.3.0/src/zarr/codecs/numcodecs/000077500000000000000000000000001523267620000210025ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/codecs/numcodecs/__init__.py000066400000000000000000000016051523267620000231150ustar00rootroot00000000000000from __future__ import annotations from zarr.codecs.numcodecs._codecs import ( BZ2, CRC32, CRC32C, LZ4, LZMA, ZFPY, Adler32, AsType, BitRound, Blosc, Delta, FixedScaleOffset, Fletcher32, GZip, JenkinsLookup3, PackBits, PCodec, Quantize, Shuffle, Zlib, Zstd, _NumcodecsArrayArrayCodec, _NumcodecsArrayBytesCodec, _NumcodecsBytesBytesCodec, _NumcodecsCodec, ) __all__ = [ "BZ2", "CRC32", "CRC32C", "LZ4", "LZMA", "ZFPY", "Adler32", "AsType", "BitRound", "Blosc", "Delta", "FixedScaleOffset", "Fletcher32", "GZip", "JenkinsLookup3", "PCodec", "PackBits", "Quantize", "Shuffle", "Zlib", "Zstd", "_NumcodecsArrayArrayCodec", "_NumcodecsArrayBytesCodec", "_NumcodecsBytesBytesCodec", "_NumcodecsCodec", ] zarr-python-3.3.0/src/zarr/codecs/numcodecs/_codecs.py000066400000000000000000000305641523267620000227630ustar00rootroot00000000000000""" This module provides compatibility for [numcodecs][] in Zarr version 3. These codecs were previously defined in [numcodecs][], and have now been moved to `zarr`. ```python import numpy as np import zarr import zarr.codecs.numcodecs as numcodecs store = zarr.storage.MemoryStore() array = zarr.create_array( store=store, shape=(1024, 1024), chunks=(64, 64), dtype="uint32", filters=[numcodecs.Delta(dtype="uint32")], compressors=[numcodecs.BZ2(level=5)], overwrite=True ) array[:] = np.arange(np.prod(array.shape), dtype=array.dtype).reshape(*array.shape) ``` !!! note Please note that the codecs in [zarr.codecs.numcodecs][] are not part of the Zarr version 3 specification. Using these codecs might cause interoperability issues with other Zarr implementations. """ from __future__ import annotations import asyncio import math from dataclasses import dataclass, replace from functools import cached_property from typing import TYPE_CHECKING, Any, Self import numpy as np from zarr.abc.codec import ArrayArrayCodec, ArrayBytesCodec, BytesBytesCodec from zarr.abc.metadata import Metadata from zarr.core.buffer.cpu import as_numpy_array_wrapper from zarr.core.common import JSON, parse_named_configuration, product from zarr.dtype import UInt8, ZDType, parse_dtype from zarr.registry import get_numcodec if TYPE_CHECKING: from zarr.abc.numcodec import Numcodec from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer, NDBuffer CODEC_PREFIX = "numcodecs." def _expect_name_prefix(codec_name: str) -> str: if not codec_name.startswith(CODEC_PREFIX): raise ValueError( f"Expected name to start with '{CODEC_PREFIX}'. Got {codec_name} instead." ) # pragma: no cover return codec_name.removeprefix(CODEC_PREFIX) def _parse_codec_configuration(data: dict[str, JSON]) -> dict[str, JSON]: parsed_name, parsed_configuration = parse_named_configuration(data) if not parsed_name.startswith(CODEC_PREFIX): raise ValueError( f"Expected name to start with '{CODEC_PREFIX}'. Got {parsed_name} instead." ) # pragma: no cover id = _expect_name_prefix(parsed_name) return {"id": id, **parsed_configuration} @dataclass(frozen=True) class _NumcodecsCodec(Metadata): codec_name: str codec_config: dict[str, JSON] def __init_subclass__(cls, *, codec_name: str | None = None, **kwargs: Any) -> None: """To be used only when creating the actual public-facing codec class.""" super().__init_subclass__(**kwargs) if codec_name is not None: namespace = codec_name cls_name = f"{CODEC_PREFIX}{namespace}.{cls.__name__}" cls.codec_name = f"{CODEC_PREFIX}{namespace}" cls.__doc__ = f""" See [{cls_name}][] for more details and parameters. """ def __init__(self, **codec_config: JSON) -> None: if not self.codec_name: raise ValueError( "The codec name needs to be supplied through the `codec_name` attribute." ) # pragma: no cover unprefixed_codec_name = _expect_name_prefix(self.codec_name) if "id" not in codec_config: codec_config = {"id": unprefixed_codec_name, **codec_config} elif codec_config["id"] != unprefixed_codec_name: raise ValueError( f"Codec id does not match {unprefixed_codec_name}. Got: {codec_config['id']}." ) # pragma: no cover object.__setattr__(self, "codec_config", codec_config) @cached_property def _codec(self) -> Numcodec: return get_numcodec(self.codec_config) # type: ignore[arg-type] @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: codec_config = _parse_codec_configuration(data) return cls(**codec_config) def to_dict(self) -> dict[str, JSON]: codec_config = self.codec_config.copy() codec_config.pop("id", None) return { "name": self.codec_name, "configuration": codec_config, } def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: raise NotImplementedError # pragma: no cover # Override __repr__ because dynamically constructed classes don't seem to work otherwise def __repr__(self) -> str: codec_config = self.codec_config.copy() codec_config.pop("id", None) return f"{self.__class__.__name__}(codec_name={self.codec_name!r}, codec_config={codec_config!r})" class _NumcodecsBytesBytesCodec(_NumcodecsCodec, BytesBytesCodec): def __init__(self, **codec_config: JSON) -> None: super().__init__(**codec_config) def _decode_sync(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> Buffer: return as_numpy_array_wrapper(self._codec.decode, chunk_data, chunk_spec.prototype) def _encode_sync(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> Buffer: encoded = self._codec.encode(chunk_data.as_array_like()) if isinstance(encoded, np.ndarray): # Required for checksum codecs return chunk_spec.prototype.buffer.from_bytes(encoded.tobytes()) return chunk_spec.prototype.buffer.from_bytes(encoded) async def _decode_single(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> Buffer: return await asyncio.to_thread(self._decode_sync, chunk_data, chunk_spec) async def _encode_single(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> Buffer: return await asyncio.to_thread(self._encode_sync, chunk_data, chunk_spec) class _NumcodecsArrayArrayCodec(_NumcodecsCodec, ArrayArrayCodec): def __init__(self, **codec_config: JSON) -> None: super().__init__(**codec_config) def _decode_sync(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> NDBuffer: chunk_ndarray = chunk_data.as_ndarray_like() out = self._codec.decode(chunk_ndarray) return chunk_spec.prototype.nd_buffer.from_ndarray_like(out.reshape(chunk_spec.shape)) def _encode_sync(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> NDBuffer: # numcodecs codecs flatten with order="A", so an F-contiguous chunk # would be encoded in transposed element order (gh-3558) chunk_ndarray = np.ascontiguousarray(chunk_data.as_ndarray_like()) out = self._codec.encode(chunk_ndarray) return chunk_spec.prototype.nd_buffer.from_ndarray_like(out) async def _encode_single(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> NDBuffer: return await asyncio.to_thread(self._encode_sync, chunk_data, chunk_spec) async def _decode_single(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> NDBuffer: return await asyncio.to_thread(self._decode_sync, chunk_data, chunk_spec) class _NumcodecsArrayBytesCodec(_NumcodecsCodec, ArrayBytesCodec): def __init__(self, **codec_config: JSON) -> None: super().__init__(**codec_config) def _decode_sync(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> NDBuffer: chunk_bytes = chunk_data.to_bytes() out = self._codec.decode(chunk_bytes) return chunk_spec.prototype.nd_buffer.from_ndarray_like(out.reshape(chunk_spec.shape)) def _encode_sync(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> Buffer: # numcodecs codecs flatten with order="A", so an F-contiguous chunk # would be encoded in transposed element order (gh-3558) chunk_ndarray = np.ascontiguousarray(chunk_data.as_ndarray_like()) out = self._codec.encode(chunk_ndarray) return chunk_spec.prototype.buffer.from_bytes(out) async def _encode_single(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> Buffer: return await asyncio.to_thread(self._encode_sync, chunk_data, chunk_spec) async def _decode_single(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> NDBuffer: return await asyncio.to_thread(self._decode_sync, chunk_data, chunk_spec) # bytes-to-bytes codecs class Blosc(_NumcodecsBytesBytesCodec, codec_name="blosc"): pass class LZ4(_NumcodecsBytesBytesCodec, codec_name="lz4"): pass class Zstd(_NumcodecsBytesBytesCodec, codec_name="zstd"): pass class Zlib(_NumcodecsBytesBytesCodec, codec_name="zlib"): pass class GZip(_NumcodecsBytesBytesCodec, codec_name="gzip"): pass class BZ2(_NumcodecsBytesBytesCodec, codec_name="bz2"): pass class LZMA(_NumcodecsBytesBytesCodec, codec_name="lzma"): pass class Shuffle(_NumcodecsBytesBytesCodec, codec_name="shuffle"): def evolve_from_array_spec(self, array_spec: ArraySpec) -> Shuffle: if self.codec_config.get("elementsize") is None: dtype = array_spec.dtype.to_native_dtype() return Shuffle(**{**self.codec_config, "elementsize": dtype.itemsize}) return self # pragma: no cover # array-to-array codecs ("filters") class Delta(_NumcodecsArrayArrayCodec, codec_name="delta"): def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: if astype := self.codec_config.get("astype"): dtype = parse_dtype(np.dtype(astype), zarr_format=3) # type: ignore[call-overload] return replace(chunk_spec, dtype=dtype) return chunk_spec class BitRound(_NumcodecsArrayArrayCodec, codec_name="bitround"): pass class FixedScaleOffset(_NumcodecsArrayArrayCodec, codec_name="fixedscaleoffset"): def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: if astype := self.codec_config.get("astype"): dtype = parse_dtype(np.dtype(astype), zarr_format=3) # type: ignore[call-overload] return replace(chunk_spec, dtype=dtype) return chunk_spec def evolve_from_array_spec(self, array_spec: ArraySpec) -> FixedScaleOffset: if self.codec_config.get("dtype") is None: dtype = array_spec.dtype.to_native_dtype() return FixedScaleOffset(**{**self.codec_config, "dtype": str(dtype)}) return self class Quantize(_NumcodecsArrayArrayCodec, codec_name="quantize"): def __init__(self, **codec_config: JSON) -> None: super().__init__(**codec_config) def evolve_from_array_spec(self, array_spec: ArraySpec) -> Quantize: if self.codec_config.get("dtype") is None: dtype = array_spec.dtype.to_native_dtype() return Quantize(**{**self.codec_config, "dtype": str(dtype)}) return self class PackBits(_NumcodecsArrayArrayCodec, codec_name="packbits"): def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: return replace( chunk_spec, shape=(1 + math.ceil(product(chunk_spec.shape) / 8),), dtype=UInt8(), ) # todo: remove this type: ignore when this class can be defined w.r.t. # a single zarr dtype API def validate(self, *, dtype: ZDType[Any, Any], **_kwargs: Any) -> None: # this is bugged and will fail _dtype = dtype.to_native_dtype() if _dtype != np.dtype("bool"): raise ValueError(f"Packbits filter requires bool dtype. Got {dtype}.") class AsType(_NumcodecsArrayArrayCodec, codec_name="astype"): def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: dtype = parse_dtype(np.dtype(self.codec_config["encode_dtype"]), zarr_format=3) # type: ignore[arg-type] return replace(chunk_spec, dtype=dtype) def evolve_from_array_spec(self, array_spec: ArraySpec) -> AsType: if self.codec_config.get("decode_dtype") is None: # TODO: remove these coverage exemptions the correct way, i.e. with tests dtype = array_spec.dtype.to_native_dtype() # pragma: no cover return AsType(**{**self.codec_config, "decode_dtype": str(dtype)}) # pragma: no cover return self # bytes-to-bytes checksum codecs class _NumcodecsChecksumCodec(_NumcodecsBytesBytesCodec): def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: return input_byte_length + 4 # pragma: no cover class CRC32(_NumcodecsChecksumCodec, codec_name="crc32"): pass class CRC32C(_NumcodecsChecksumCodec, codec_name="crc32c"): pass class Adler32(_NumcodecsChecksumCodec, codec_name="adler32"): pass class Fletcher32(_NumcodecsChecksumCodec, codec_name="fletcher32"): pass class JenkinsLookup3(_NumcodecsChecksumCodec, codec_name="jenkins_lookup3"): pass # array-to-bytes codecs class PCodec(_NumcodecsArrayBytesCodec, codec_name="pcodec"): pass class ZFPY(_NumcodecsArrayBytesCodec, codec_name="zfpy"): pass zarr-python-3.3.0/src/zarr/codecs/scale_offset.py000066400000000000000000000435441523267620000220430ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass, replace from typing import TYPE_CHECKING, Any, cast import numpy as np import numpy.typing as npt from zarr.abc.codec import ArrayArrayCodec from zarr.core.common import JSON, parse_named_configuration if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec from zarr.core.buffer import NDBuffer from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.core.metadata.v3 import ChunkGridMetadata _WIDE_INT = np.dtype(np.int64) def _encode_fits_natively(dtype: np.dtype[Any], offset: int, scale: int) -> bool: """Static range proof: is ``(x - offset) * scale`` always in range for every ``x`` in dtype? Uses Python ints (unbounded) to avoid overflow in the proof itself. """ info = np.iinfo(dtype) d_lo = int(info.min) - offset d_hi = int(info.max) - offset # Taking min/max of both products handles negative scale without a sign branch. products = (d_lo * scale, d_hi * scale) lo, hi = min(products), max(products) return info.min <= lo and hi <= info.max def _decode_fits_natively(dtype: np.dtype[Any], offset: int, scale: int) -> bool: """Static range proof for decode: is ``x // scale + offset`` always in range?""" info = np.iinfo(dtype) # x // scale is bounded by the extremes of x / scale (integer division stays within that range) if scale > 0: q_lo, q_hi = int(info.min) // scale, int(info.max) // scale else: q_lo, q_hi = int(info.max) // scale, int(info.min) // scale lo, hi = q_lo + offset, q_hi + offset return info.min <= lo and hi <= info.max def _check_int_range( values: npt.NDArray[np.integer[Any]], target: np.dtype[np.integer[Any]] ) -> None: """Raise if any value is outside the representable range of ``target``. Uses a single min/max pass instead of two ``np.any`` passes. """ info = np.iinfo(target) lo, hi = values.min(), values.max() if lo < info.min or hi > info.max: raise ValueError( f"scale_offset produced a value outside the range of dtype {target} " f"[{info.min}, {info.max}]." ) def _check_exact_division( arr: npt.NDArray[np.integer[Any]], scale: np.integer[Any], scale_repr: object ) -> None: """Raise ValueError if ``arr`` has any element not exactly divisible by ``scale``.""" if np.any(arr % scale): raise ValueError( f"scale_offset decode produced a non-zero remainder when dividing by " f"scale={scale_repr!r}; result is not exactly representable in dtype {arr.dtype}." ) def _encode_int_native( arr: npt.NDArray[np.integer[Any]], offset: np.integer[Any], scale: np.integer[Any] ) -> npt.NDArray[np.integer[Any]]: """Compute ``(arr - offset) * scale`` directly in ``arr.dtype``. This is the fast path; it exists only as a separate function to make the contract with ``_encode_fits_natively`` explicit: the caller must have already proved that no ``x`` in ``arr.dtype``'s range can overflow, so we can skip widening and range-checking entirely. Using it without that proof would silently wrap on overflow. """ return cast("npt.NDArray[np.integer[Any]]", (arr - offset) * scale) def _encode_int_widened( arr: npt.NDArray[np.integer[Any]], offset: np.integer[Any], scale: np.integer[Any] ) -> npt.NDArray[np.integer[Any]]: """Overflow-checked integer encode for int8..int64 and uint8..uint32. Exists because numpy integer arithmetic silently wraps on overflow, which the spec forbids. We widen to int64, perform the arithmetic there (int64 holds the product of any two values from these dtypes), range-check against the target dtype, then cast back. uint64 cannot use this path because its range exceeds int64 — see ``_encode_uint64``. """ wide_arr = arr.astype(_WIDE_INT, copy=False) result = (wide_arr - _WIDE_INT.type(offset)) * _WIDE_INT.type(scale) _check_int_range(result, arr.dtype) return result.astype(arr.dtype, copy=False) def _encode_float( arr: npt.NDArray[np.floating[Any]], offset: np.floating[Any], scale: np.floating[Any] ) -> npt.NDArray[np.floating[Any]]: """Encode float arrays in-dtype, guarding only against silent promotion. Float arithmetic doesn't need widening — float64 is already the widest supported dtype, and ``inf``/``nan`` from overflow are representable IEEE 754 values, so no range check is required by the spec. The one thing that can still go wrong is numpy promoting the result to a wider float dtype (e.g. float32 * float64 scalar -> float64), which would violate the spec's "arithmetic semantics of the input array's data type" clause. """ result = cast("npt.NDArray[np.floating[Any]]", (arr - offset) * scale) if result.dtype != arr.dtype: raise ValueError( f"scale_offset changed dtype from {arr.dtype} to {result.dtype}. " f"Arithmetic must preserve the data type." ) return result def _check_py_int_range( result: np.ndarray[tuple[Any, ...], np.dtype[Any]], target: np.dtype[np.unsignedinteger[Any]], ) -> None: """Range-check an ``object``-dtype ndarray holding Python ints against ``target``'s iinfo. Exists as a uint64-specific counterpart to ``_check_int_range``. That one compares numpy integers against ``iinfo``; here the values are unbounded Python ints produced by ``_encode_uint64`` / ``_decode_uint64``, so we rely on Python's arbitrary-precision comparison to detect values outside the target dtype's range. """ info = np.iinfo(target) # np.min/np.max on an object array returns a Python int (which compares correctly with iinfo). # Works uniformly for 0-d arrays where .flat iteration is awkward. lo = np.min(result) hi = np.max(result) if lo < int(info.min) or hi > int(info.max): raise ValueError( f"scale_offset produced a value outside the range of dtype {target} " f"[{info.min}, {info.max}]." ) def _encode_uint64( arr: npt.NDArray[np.unsignedinteger[Any]], offset: int, scale: int ) -> npt.NDArray[np.unsignedinteger[Any]]: """Encode uint64 via Python-int arithmetic in an ``object``-dtype array. Exists because uint64's range [0, 2**64) exceeds int64, so the int64 widening used by ``_encode_int_widened`` would itself overflow. Python ints are unbounded, so computing via ``object`` dtype is correct by construction. The trade-off is speed: object-dtype arithmetic is interpreted per element and is roughly 10x slower than ufunc paths. """ obj = arr.astype(object, copy=False) # np.asarray restores ndarray-ness in the 0-d/scalar edge case. result = np.asarray((obj - offset) * scale, dtype=object) _check_py_int_range(result, arr.dtype) return cast("npt.NDArray[np.unsignedinteger[Any]]", result.astype(arr.dtype, copy=False)) def _decode_uint64( arr: npt.NDArray[np.unsignedinteger[Any]], offset: int, scale: int ) -> npt.NDArray[np.unsignedinteger[Any]]: """Decode uint64 via Python-int arithmetic. See ``_encode_uint64`` for why.""" obj = arr.astype(object, copy=False) result = np.asarray((obj // scale) + offset, dtype=object) _check_py_int_range(result, arr.dtype) return cast("npt.NDArray[np.unsignedinteger[Any]]", result.astype(arr.dtype, copy=False)) def _decode_int_native( arr: npt.NDArray[np.integer[Any]], offset: np.integer[Any], scale: np.integer[Any] ) -> npt.NDArray[np.integer[Any]]: """Compute ``arr // scale + offset`` directly in ``arr.dtype``. Fast-path counterpart to ``_encode_int_native``; same contract. Caller must have proved via ``_decode_fits_natively`` that the result can't overflow. Divisibility is checked upstream in ``_decode`` before this is called, so ``//`` is exact here. """ return cast("npt.NDArray[np.integer[Any]]", (arr // scale) + offset) def _decode_int_widened( arr: npt.NDArray[np.integer[Any]], offset: np.integer[Any], scale: np.integer[Any] ) -> npt.NDArray[np.integer[Any]]: """Overflow-checked integer decode for int8..int64 and uint8..uint32. Counterpart to ``_encode_int_widened``. Widens to int64 so the addition of ``offset`` after division can't silently wrap, then range-checks against the target dtype. """ wide_arr = arr.astype(_WIDE_INT, copy=False) result = (wide_arr // _WIDE_INT.type(scale)) + _WIDE_INT.type(offset) _check_int_range(result, arr.dtype) return result.astype(arr.dtype, copy=False) def _decode_float( arr: npt.NDArray[np.floating[Any]], offset: np.floating[Any], scale: np.floating[Any] ) -> npt.NDArray[np.floating[Any]]: """Decode float arrays in-dtype, guarding only against silent promotion. Counterpart to ``_encode_float``; same reasoning. ``arr / scale`` is true division and always well-defined for floats (including ``0/0 = nan`` and ``x/0 = ±inf``), so no range or exactness check is needed. """ result = cast("npt.NDArray[np.floating[Any]]", (arr / scale) + offset) if result.dtype != arr.dtype: raise ValueError( f"scale_offset changed dtype from {arr.dtype} to {result.dtype}. " f"Arithmetic must preserve the data type." ) return result def _encode( arr: np.ndarray[tuple[Any, ...], np.dtype[Any]], offset: np.generic, scale: np.generic, ) -> np.ndarray[tuple[Any, ...], np.dtype[Any]]: """Compute ``(arr - offset) * scale`` without silent overflow, returning ``arr.dtype``.""" # uint64 is split out first because its full range (up to 2**64-1) doesn't fit in int64, # so the widening strategy used for every other integer dtype would itself overflow. if arr.dtype == np.uint64: u_arr = cast("npt.NDArray[np.unsignedinteger[Any]]", arr) return _encode_uint64(u_arr, int(offset), int(scale)) if np.issubdtype(arr.dtype, np.integer): i_arr = cast("npt.NDArray[np.integer[Any]]", arr) i_offset = cast("np.integer[Any]", offset) i_scale = cast("np.integer[Any]", scale) # Fast path: if a static proof shows no ``x`` in the dtype's range can overflow, # skip the int64 widening and run the arithmetic directly in the input dtype. if _encode_fits_natively(arr.dtype, int(offset), int(scale)): return _encode_int_native(i_arr, i_offset, i_scale) return _encode_int_widened(i_arr, i_offset, i_scale) # Float path: arithmetic stays in-dtype (no widening); only guard against numpy # silently promoting a narrower float to a wider one via scalar type mismatch. f_arr = cast("npt.NDArray[np.floating[Any]]", arr) f_offset = cast("np.floating[Any]", offset) f_scale = cast("np.floating[Any]", scale) return _encode_float(f_arr, f_offset, f_scale) def _decode( arr: np.ndarray[tuple[Any, ...], np.dtype[Any]], offset: np.generic, scale: np.generic, *, scale_repr: object, ) -> np.ndarray[tuple[Any, ...], np.dtype[Any]]: """Compute ``arr / scale + offset`` without silent overflow, returning ``arr.dtype``.""" # uint64: same reasoning as _encode — its range exceeds int64, so the Python-int path is the # only correct option. Exactness check runs first so non-divisible inputs fail before the # slower object-dtype arithmetic. if arr.dtype == np.uint64: u_arr = cast("npt.NDArray[np.unsignedinteger[Any]]", arr) _check_exact_division(u_arr, cast("np.integer[Any]", scale), scale_repr) return _decode_uint64(u_arr, int(offset), int(scale)) if np.issubdtype(arr.dtype, np.integer): i_arr = cast("npt.NDArray[np.integer[Any]]", arr) i_offset = cast("np.integer[Any]", offset) i_scale = cast("np.integer[Any]", scale) # The spec requires decode to use true division and error if the result isn't # representable. For integers that means the remainder must be zero; if any element # isn't exactly divisible we fail here rather than silently truncating via //. _check_exact_division(i_arr, i_scale, scale_repr) # Fast path mirrors _encode: static proof that ``x // scale + offset`` stays in dtype. if _decode_fits_natively(arr.dtype, int(offset), int(scale)): return _decode_int_native(i_arr, i_offset, i_scale) return _decode_int_widened(i_arr, i_offset, i_scale) # Float path: division is well-defined; only guard against dtype promotion. f_arr = cast("npt.NDArray[np.floating[Any]]", arr) f_offset = cast("np.floating[Any]", offset) f_scale = cast("np.floating[Any]", scale) return _decode_float(f_arr, f_offset, f_scale) @dataclass(frozen=True) class ScaleOffset(ArrayArrayCodec): """Scale-offset array-to-array codec. Encodes values with `out = (in - offset) * scale` and decodes with `out = (in / scale) + offset`, using the input array's data type semantics. Intermediate or final values that are not representable in that dtype are reported as errors (integer overflow, unsigned underflow, non-exact integer division). Parameters ---------- offset : int, float, or str Value subtracted during encoding. Strings preserve the exact JSON representation when round-tripping metadata. Default is 0. scale : int, float, or str Value multiplied during encoding (after offset subtraction). Strings preserve the exact JSON representation when round-tripping metadata. Default is 1. Attributes ---------- offset : int, float, or str The offset value, as supplied to the constructor. scale : int, float, or str The scale value, as supplied to the constructor. References ---------- - The `scale_offset` codec spec: https://github.com/zarr-developers/zarr-extensions/tree/main/codecs/scale_offset """ is_fixed_size = True offset: int | float | str scale: int | float | str def __init__(self, *, offset: object = 0, scale: object = 1) -> None: if not isinstance(offset, int | float | str): raise TypeError(f"offset must be a number or string, got {type(offset).__name__}") if not isinstance(scale, int | float | str): raise TypeError(f"scale must be a number or string, got {type(scale).__name__}") object.__setattr__(self, "offset", offset) object.__setattr__(self, "scale", scale) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration( data, "scale_offset", require_configuration=False ) configuration_parsed = configuration_parsed or {} return cls(**configuration_parsed) def to_dict(self) -> dict[str, JSON]: if self.offset == 0 and self.scale == 1: return {"name": "scale_offset"} config: dict[str, JSON] = {} if self.offset != 0: config["offset"] = self.offset if self.scale != 1: config["scale"] = self.scale return {"name": "scale_offset", "configuration": config} def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: native = dtype.to_native_dtype() if not np.issubdtype(native, np.integer) and not np.issubdtype(native, np.floating): raise ValueError( f"scale_offset codec only supports integer and floating-point data types. " f"Got {dtype}." ) if self.scale == 0: raise ValueError("scale_offset scale must be non-zero.") for name, value in [("offset", self.offset), ("scale", self.scale)]: try: dtype.from_json_scalar(value, zarr_format=3) except (TypeError, ValueError, OverflowError) as e: raise ValueError( f"scale_offset {name} value {value!r} is not representable in dtype {native}." ) from e def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: zdtype = chunk_spec.dtype fill = np.asarray(zdtype.cast_scalar(chunk_spec.fill_value)) offset = cast("np.generic", zdtype.from_json_scalar(self.offset, zarr_format=3)) scale = cast("np.generic", zdtype.from_json_scalar(self.scale, zarr_format=3)) new_fill = _encode(fill, offset, scale) return replace(chunk_spec, fill_value=new_fill.reshape(()).item()) def _decode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer: arr = cast("np.ndarray[tuple[Any, ...], np.dtype[Any]]", chunk_array.as_ndarray_like()) zdtype = chunk_spec.dtype offset = cast("np.generic", zdtype.from_json_scalar(self.offset, zarr_format=3)) scale = cast("np.generic", zdtype.from_json_scalar(self.scale, zarr_format=3)) result = _decode(arr, offset, scale, scale_repr=self.scale) return chunk_spec.prototype.nd_buffer.from_ndarray_like(result) async def _decode_single( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer: return self._decode_sync(chunk_array, chunk_spec) def _encode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer | None: arr = cast("np.ndarray[tuple[Any, ...], np.dtype[Any]]", chunk_array.as_ndarray_like()) zdtype = chunk_spec.dtype offset = cast("np.generic", zdtype.from_json_scalar(self.offset, zarr_format=3)) scale = cast("np.generic", zdtype.from_json_scalar(self.scale, zarr_format=3)) result = _encode(arr, offset, scale) return chunk_spec.prototype.nd_buffer.from_ndarray_like(result) async def _encode_single( self, chunk_array: NDBuffer, _chunk_spec: ArraySpec, ) -> NDBuffer | None: return self._encode_sync(chunk_array, _chunk_spec) def compute_encoded_size(self, input_byte_length: int, _chunk_spec: ArraySpec) -> int: return input_byte_length zarr-python-3.3.0/src/zarr/codecs/sharding.py000066400000000000000000002223461523267620000212040ustar00rootroot00000000000000from __future__ import annotations from collections.abc import Iterable, Mapping, MutableMapping, Sequence from dataclasses import dataclass, replace from functools import lru_cache from typing import TYPE_CHECKING, Any, ClassVar, Final, Literal, NamedTuple import numpy as np import numpy.typing as npt from zarr.abc.codec import ( ArrayBytesCodec, ArrayBytesCodecPartialDecodeMixin, ArrayBytesCodecPartialEncodeMixin, Codec, CodecPipeline, _codec_supports_sync, ) from zarr.abc.store import ( ByteGetter, ByteRequest, ByteSetter, RangeByteRequest, Store, SuffixByteRequest, _store_supports_sync_io, ) from zarr.codecs._deprecated_enum import _coerce_enum_input, _DeprecatedStrEnumMeta from zarr.codecs.bytes import BytesCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import ( Buffer, BufferPrototype, NDBuffer, default_buffer_prototype, numpy_buffer_prototype, ) from zarr.core.chunk_grids import ChunkGrid from zarr.core.chunk_utils import ( ChunkTransform, decode_and_scatter_chunk, encode_or_elide_chunk, evolve_codecs, merge_and_encode_chunk, ) from zarr.core.common import ( ShapeLike, parse_named_configuration, parse_shapelike, product, ) from zarr.core.config import config as zarr_config from zarr.core.dtype.common import HasEndianness from zarr.core.dtype.npy.int import UInt64 from zarr.core.dtype.npy.structured import Struct from zarr.core.indexing import ( BasicIndexer, ChunkProjection, SelectorTuple, SliceDimIndexer, _lexicographic_order, colexicographic_order_coords, get_indexer, lexicographic_order_coords, morton_order_coords, ) from zarr.core.metadata.v3 import ( ChunkGridMetadata, RectilinearChunkGridMetadata, RegularChunkGridMetadata, parse_codecs, ) from zarr.registry import get_ndbuffer_class, get_pipeline_class from zarr.storage._common import StorePath from zarr.storage._utils import _normalize_byte_range_index if TYPE_CHECKING: from collections.abc import Iterator from typing import Self from zarr.core.common import JSON from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType MAX_UINT_64 = 2**64 - 1 ShardMapping = Mapping[tuple[int, ...], Buffer | None] ShardMutableMapping = MutableMapping[tuple[int, ...], Buffer | None] IndexLocation = Literal["start", "end"] """Position of the shard index within the encoded shard.""" INDEX_LOCATION: Final = ("start", "end") class ShardingCodecIndexLocation(metaclass=_DeprecatedStrEnumMeta): """ Deprecated. Pass a literal string (`"start"` or `"end"`) directly to `ShardingCodec` instead. """ _members: ClassVar[dict[str, str]] = {"start": "start", "end": "end"} SubchunkWriteOrder = Literal["morton", "unordered", "lexicographic", "colexicographic"] SUBCHUNK_WRITE_ORDER: Final[tuple[str, str, str, str]] = ( "morton", "unordered", "lexicographic", "colexicographic", ) def _is_identity_full_read(indexer: Any, shard_shape: tuple[int, ...]) -> bool: """True when `indexer` selects every element of a `shard_shape` array in natural order: one whole-dimension, step-1 `SliceDimIndexer` per dimension. Structural on purpose, not `isinstance(indexer, BasicIndexer)`: a full `arr[:]` read reaches the shard as an `OrthogonalIndexer`, so a type gate would silently disable the bulk fast path for the most common case. Any gather (integer-array / boolean / coordinate selection), subset, strided, or integer-scalar selection fails the per-dimension check — output shape alone is not enough, because a reordering or duplicating selection can have the same shape as the shard while requiring `chunk_selection` / `out_selection` to be honored. """ dim_indexers = getattr(indexer, "dim_indexers", None) if dim_indexers is None or len(dim_indexers) != len(shard_shape): return False return all( isinstance(dim_indexer, SliceDimIndexer) and dim_indexer.dim_len == dim_len and dim_indexer.start == 0 and dim_indexer.stop == dim_len and dim_indexer.step == 1 for dim_indexer, dim_len in zip(dim_indexers, shard_shape, strict=True) ) def _parse_index_location(data: object) -> IndexLocation: if isinstance(data, str) and data in INDEX_LOCATION: return data # type: ignore[return-value] raise ValueError(f"index_location must be one of {list(INDEX_LOCATION)!r}. Got {data!r}.") @dataclass(frozen=True) class _ShardingByteGetter(ByteGetter): """In-memory byte getter for one inner chunk of a shard. Implements `SyncByteGetter` (dict access needs no event loop), so the synchronous codec pipeline takes its sync fast path on inner chunks instead of scheduling one coroutine per chunk; the async `get` simply delegates to `get_sync`. """ shard_dict: ShardMapping chunk_coords: tuple[int, ...] def get_sync( self, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None ) -> Buffer | None: assert prototype is None or prototype == default_buffer_prototype(), ( f"prototype is not supported within shards currently. diff: {prototype} != {default_buffer_prototype()}" ) value = self.shard_dict.get(self.chunk_coords) if value is None: return None if byte_range is None: return value start, stop = _normalize_byte_range_index(value, byte_range) return value[start:stop] async def get( self, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: return self.get_sync(prototype, byte_range) @dataclass(frozen=True) class _ShardingByteSetter(_ShardingByteGetter, ByteSetter): """In-memory byte setter for one inner chunk of a shard. Implements `SyncByteSetter`; the async methods delegate to the sync ones. """ shard_dict: ShardMutableMapping def set_sync(self, value: Buffer) -> None: self.shard_dict[self.chunk_coords] = value def delete_sync(self) -> None: del self.shard_dict[self.chunk_coords] async def set(self, value: Buffer, byte_range: ByteRequest | None = None) -> None: assert byte_range is None, "byte_range is not supported within shards" self.set_sync(value) async def delete(self) -> None: self.delete_sync() async def set_if_not_exists(self, default: Buffer) -> None: self.shard_dict.setdefault(self.chunk_coords, default) class _ShardIndex(NamedTuple): # the chunk grid shape of a single shard chunks_per_shard: tuple[int, ...] # dtype uint64, shape (chunks_per_shard_0, chunks_per_shard_1, ..., 2) offsets_and_lengths: npt.NDArray[np.uint64] def _localize_chunk(self, chunk_coords: tuple[int, ...]) -> tuple[int, ...]: return tuple( chunk_i % shard_i for chunk_i, shard_i in zip(chunk_coords, self.chunks_per_shard, strict=False) ) def is_all_empty(self) -> bool: return bool(np.array_equiv(self.offsets_and_lengths, MAX_UINT_64)) def get_full_chunk_map(self) -> npt.NDArray[np.bool_]: return np.not_equal(self.offsets_and_lengths[..., 0], MAX_UINT_64) def is_dense(self, chunk_byte_length: int, *, data_section_start: int) -> bool: """True when the chunk payloads exactly tile the shard's data section. Every chunk must be present with length `chunk_byte_length`, and the sorted offsets must be exactly `data_section_start + i * chunk_byte_length` for `i` in `0..n_chunks-1`: no gaps, no overlaps, and nothing outside the data section (a corrupt index could otherwise point chunks into the index region or out of the blob). Used to gate the vectorized whole-shard decode: a dense fixed-size shard is a regular grid of equal-length payloads, so it can be reshaped/scattered in bulk rather than decoded chunk-by-chunk. """ offsets = self.offsets_and_lengths[..., 0].reshape(-1) lengths = self.offsets_and_lengths[..., 1].reshape(-1) # all present if bool(np.any(offsets == MAX_UINT_64)): return False # all the same fixed length if not bool(np.all(lengths == chunk_byte_length)): return False expected = np.uint64(data_section_start) + np.arange( offsets.size, dtype=np.uint64 ) * np.uint64(chunk_byte_length) return bool(np.array_equal(np.sort(offsets), expected)) def get_chunk_slice(self, chunk_coords: tuple[int, ...]) -> tuple[int, int] | None: localized_chunk = self._localize_chunk(chunk_coords) chunk_start, chunk_len = self.offsets_and_lengths[localized_chunk] if (chunk_start, chunk_len) == (MAX_UINT_64, MAX_UINT_64): return None else: return (int(chunk_start), int(chunk_start + chunk_len)) def get_chunk_slices_vectorized( self, chunk_coords_array: npt.NDArray[np.integer[Any]] ) -> tuple[npt.NDArray[np.uint64], npt.NDArray[np.uint64], npt.NDArray[np.bool_]]: """Get chunk slices for multiple coordinates at once. Parameters ---------- chunk_coords_array : ndarray of shape (n_chunks, n_dims) Array of chunk coordinates to look up. Returns ------- starts : ndarray of shape (n_chunks,) Start byte positions for each chunk. ends : ndarray of shape (n_chunks,) End byte positions for each chunk. valid : ndarray of shape (n_chunks,) Boolean mask indicating which chunks are non-empty. """ # Handle 0-dimensional arrays (n_dims == 0): the shard holds a single # chunk, so every coordinate maps to the same flat entry. if chunk_coords_array.shape[1] == 0: offsets_and_lengths = self.offsets_and_lengths.reshape(-1, 2) offsets_and_lengths = np.broadcast_to( offsets_and_lengths, (chunk_coords_array.shape[0], 2) ) else: # Localize coordinates via modulo (vectorized) shard_shape = np.array(self.chunks_per_shard, dtype=np.uint64) localized = chunk_coords_array.astype(np.uint64) % shard_shape # Build index tuple for advanced indexing index_tuple = tuple(localized[:, i] for i in range(localized.shape[1])) # Fetch all offsets and lengths at once offsets_and_lengths = self.offsets_and_lengths[index_tuple] starts = offsets_and_lengths[:, 0] lengths = offsets_and_lengths[:, 1] # Check for valid (non-empty) chunks valid = starts != MAX_UINT_64 # Compute end positions ends = starts + lengths return starts, ends, valid def set_chunk_slice(self, chunk_coords: tuple[int, ...], chunk_slice: slice | None) -> None: localized_chunk = self._localize_chunk(chunk_coords) if chunk_slice is None: self.offsets_and_lengths[localized_chunk] = (MAX_UINT_64, MAX_UINT_64) else: self.offsets_and_lengths[localized_chunk] = ( chunk_slice.start, chunk_slice.stop - chunk_slice.start, ) @classmethod def create_empty(cls, chunks_per_shard: tuple[int, ...]) -> _ShardIndex: offsets_and_lengths = np.zeros(chunks_per_shard + (2,), dtype=" _ShardReader: shard_index_size = codec._shard_index_size(chunks_per_shard) obj = cls() obj.buf = buf if codec.index_location == "start": shard_index_bytes = obj.buf[:shard_index_size] else: shard_index_bytes = obj.buf[-shard_index_size:] obj.index = await codec._decode_shard_index(shard_index_bytes, chunks_per_shard) return obj @classmethod def create_empty( cls, chunks_per_shard: tuple[int, ...], buffer_prototype: BufferPrototype | None = None ) -> _ShardReader: if buffer_prototype is None: buffer_prototype = default_buffer_prototype() index = _ShardIndex.create_empty(chunks_per_shard) obj = cls() obj.buf = buffer_prototype.buffer.create_zero_length() obj.index = index return obj def __getitem__(self, chunk_coords: tuple[int, ...]) -> Buffer: chunk_byte_slice = self.index.get_chunk_slice(chunk_coords) if chunk_byte_slice: return self.buf[chunk_byte_slice[0] : chunk_byte_slice[1]] raise KeyError def __len__(self) -> int: return int(self.index.offsets_and_lengths.size / 2) def __iter__(self) -> Iterator[tuple[int, ...]]: return iter(lexicographic_order_coords(self.index.chunks_per_shard)) def to_dict_vectorized(self) -> dict[tuple[int, ...], Buffer | None]: """Build a dict of chunk coordinates to buffers using vectorized lookup. The full per-shard chunk coordinate grid (both the array used for the vectorized index lookup and the plain tuples used as dict keys) is cached on `chunks_per_shard`, so neither is rebuilt on every call. For a shard with tens of thousands of chunks this avoids reconstructing that many tuples on every partial write. Returns ------- dict mapping chunk coordinate tuples to Buffer or None """ chunks_per_shard = self.index.chunks_per_shard # The same chunk-grid coordinates are needed in two forms, and neither can # stand in for the other: # - `chunk_coords_array`: an (n_chunks, n_dims) numpy array, fed to the # vectorized index lookup, which does modulo + advanced indexing on it. # A list of tuples can't be used for that without first being arrayified. # - `chunk_coords_keys`: the same coordinates as hashable Python tuples, # used as the result dict's keys. numpy array rows are unhashable # (mutable), so they can't key a dict. # Both are cached per shape (see indexing.py), so neither is rebuilt here; # row i of the array and key i refer to the same chunk. chunk_coords_array = _lexicographic_order(chunks_per_shard) chunk_coords_keys = lexicographic_order_coords(chunks_per_shard) starts, ends, valid = self.index.get_chunk_slices_vectorized(chunk_coords_array) result: dict[tuple[int, ...], Buffer | None] = {} for i, coords in enumerate(chunk_coords_keys): if valid[i]: result[coords] = self.buf[int(starts[i]) : int(ends[i])] else: result[coords] = None return result @dataclass(frozen=True) class ShardingCodec( ArrayBytesCodec, ArrayBytesCodecPartialDecodeMixin, ArrayBytesCodecPartialEncodeMixin ): """Sharding codec. `subchunk_write_order` controls the physical order of subchunks within a shard. It is a write-time setting only: it is not stored in array metadata, so reopening a sharded array does not recover it (the setting reverts to the `morton` default per codec instance). """ is_fixed_size = False chunk_shape: tuple[int, ...] codecs: tuple[Codec, ...] index_codecs: tuple[Codec, ...] index_location: IndexLocation = "end" subchunk_write_order: SubchunkWriteOrder = "morton" def __init__( self, *, chunk_shape: ShapeLike, codecs: Iterable[Codec | dict[str, JSON]] = (BytesCodec(),), index_codecs: Iterable[Codec | dict[str, JSON]] = (BytesCodec(), Crc32cCodec()), index_location: ShardingCodecIndexLocation | IndexLocation = "end", subchunk_write_order: SubchunkWriteOrder = "morton", ) -> None: chunk_shape_parsed = parse_shapelike(chunk_shape) codecs_parsed = parse_codecs(codecs) index_codecs_parsed = parse_codecs(index_codecs) index_location_coerced = _coerce_enum_input( index_location, "index_location", "ShardingCodec" ) index_location_parsed = _parse_index_location(index_location_coerced) if subchunk_write_order not in SUBCHUNK_WRITE_ORDER: raise ValueError( f"Unrecognized subchunk write order: {subchunk_write_order}. Only {SUBCHUNK_WRITE_ORDER} are allowed." ) object.__setattr__(self, "chunk_shape", chunk_shape_parsed) object.__setattr__(self, "codecs", codecs_parsed) object.__setattr__(self, "index_codecs", index_codecs_parsed) object.__setattr__(self, "index_location", index_location_parsed) object.__setattr__(self, "subchunk_write_order", subchunk_write_order) # Use instance-local lru_cache to avoid memory leaks object.__setattr__(self, "_get_chunk_spec", lru_cache()(self._get_chunk_spec)) object.__setattr__(self, "_get_index_chunk_spec", lru_cache()(self._get_index_chunk_spec)) object.__setattr__(self, "_get_chunks_per_shard", lru_cache()(self._get_chunks_per_shard)) object.__setattr__(self, "_shard_index_size", lru_cache()(self._shard_index_size)) object.__setattr__( self, "_get_inner_chunk_transform", lru_cache()(self._get_inner_chunk_transform) ) object.__setattr__( self, "_get_index_chunk_transform", lru_cache()(self._get_index_chunk_transform) ) # todo: typedict return type def __getstate__(self) -> dict[str, Any]: # `subchunk_write_order` is not part of codec metadata (`to_dict`), so carry it # explicitly to survive a pickle round-trip (otherwise it reverts to `morton`). return {"subchunk_write_order": self.subchunk_write_order, **self.to_dict()} def __setstate__(self, state: dict[str, Any]) -> None: config = state["configuration"] object.__setattr__(self, "chunk_shape", parse_shapelike(config["chunk_shape"])) object.__setattr__(self, "codecs", parse_codecs(config["codecs"])) object.__setattr__(self, "index_codecs", parse_codecs(config["index_codecs"])) object.__setattr__(self, "index_location", _parse_index_location(config["index_location"])) object.__setattr__(self, "subchunk_write_order", state["subchunk_write_order"]) # Use instance-local lru_cache to avoid memory leaks object.__setattr__(self, "_get_chunk_spec", lru_cache()(self._get_chunk_spec)) object.__setattr__(self, "_get_index_chunk_spec", lru_cache()(self._get_index_chunk_spec)) object.__setattr__(self, "_get_chunks_per_shard", lru_cache()(self._get_chunks_per_shard)) object.__setattr__(self, "_shard_index_size", lru_cache()(self._shard_index_size)) object.__setattr__( self, "_get_inner_chunk_transform", lru_cache()(self._get_inner_chunk_transform) ) object.__setattr__( self, "_get_index_chunk_transform", lru_cache()(self._get_index_chunk_transform) ) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration(data, "sharding_indexed") return cls(**configuration_parsed) # type: ignore[arg-type] @property def codec_pipeline(self) -> CodecPipeline: return get_pipeline_class().from_codecs(self.codecs) def _get_inner_pipeline(self, shard_spec: ArraySpec) -> CodecPipeline: """The nested pipeline for inner-chunk IO, evolved against the inner chunk spec. Evolving matters for two reasons: it threads the spec through the inner codec chain (spec-changing codecs see the spec they will actually operate on), and — for a synchronous pipeline — it builds the sync transform, so inner-chunk IO over the (sync-capable) sharding byte getters takes the pipeline's sync fast path instead of scheduling one coroutine per inner chunk. The bare `codec_pipeline` property returns an unevolved pipeline, which a synchronous pipeline can only run through its async fallback. Memoized per (pipeline class, batch size, shard_spec): evolving builds a ChunkTransform, which is wasteful to redo on every shard operation. The pipeline class and batch size participate in the key so the `codec_pipeline.path` and `codec_pipeline.batch_size` configs are still honored after the first use (`from_codecs` captures batch_size at construction). A benign construction race between threads is possible (last writer wins) — same as the other caches here. """ cache: dict[tuple[type[CodecPipeline], int, ArraySpec], CodecPipeline] | None = getattr( self, "_inner_pipeline_cache", None ) if cache is None: cache = {} object.__setattr__(self, "_inner_pipeline_cache", cache) key = (get_pipeline_class(), zarr_config.get("codec_pipeline.batch_size"), shard_spec) pipeline = cache.get(key) if pipeline is None: chunk_spec = self._get_chunk_spec(shard_spec) pipeline = self.codec_pipeline.evolve_from_array_spec(chunk_spec) cache[key] = pipeline return pipeline def to_dict(self) -> dict[str, JSON]: return { "name": "sharding_indexed", "configuration": { "chunk_shape": self.chunk_shape, "codecs": tuple(s.to_dict() for s in self.codecs), "index_codecs": tuple(s.to_dict() for s in self.index_codecs), "index_location": self.index_location, }, } def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: """Thread the spec through the inner chain. Each codec is evolved against the spec produced by the previous one. Evolving every codec against the same unthreaded spec is the bug shape that strips `BytesCodec.endian` behind a dtype-changing codec — and this method runs on the real array-creation path, baking the damaged chain into the evolved instance before the transform builders ever run. Parameters ---------- array_spec The base spec to be evolved as we thread it. Returns ------- This codec with the evolved code chain. """ from zarr.core.chunk_utils import evolve_codecs shard_spec = self._get_chunk_spec(array_spec) evolved_codecs = evolve_codecs(self.codecs, shard_spec) if evolved_codecs != self.codecs: return replace(self, codecs=evolved_codecs) return self def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: if len(self.chunk_shape) != len(shape): raise ValueError( "The shard's `chunk_shape` and array's `shape` need to have the same number of dimensions." ) if isinstance(chunk_grid, RegularChunkGridMetadata): edges_per_dim: tuple[tuple[int, ...], ...] = tuple((s,) for s in chunk_grid.chunk_shape) elif isinstance(chunk_grid, RectilinearChunkGridMetadata): edges_per_dim = tuple( (s,) if isinstance(s, int) else s for s in chunk_grid.chunk_shapes ) else: raise TypeError( f"Sharding is only compatible with regular and rectilinear chunk grids, " f"got {type(chunk_grid)}" ) for i, (edges, inner) in enumerate(zip(edges_per_dim, self.chunk_shape, strict=False)): for edge in set(edges): if edge % inner != 0: raise ValueError( f"Chunk edge length {edge} in dimension {i} is not " f"divisible by the shard's inner chunk size {inner}." ) def _get_inner_chunk_transform(self, shard_spec: ArraySpec) -> Any: """The synchronous transform for the inner codec chain. Memoized by the instance-local `lru_cache` wrapping installed in `__init__`/`__setstate__` (the single cache mechanism for these builders — do not add another layer inside the body). Codecs are evolved with the spec THREADED forward (`evolve_codecs`): each inner codec is evolved against the spec produced by the previous one, not the original chunk spec. Evolving every codec against the same unthreaded spec is the bug shape that stripped `BytesCodec.endian` at the pipeline level (see `evolve_codecs`) — the inner chain must use the same single source of truth. """ chunk_spec = self._get_chunk_spec(shard_spec) return ChunkTransform(codecs=evolve_codecs(self.codecs, chunk_spec)) def _get_index_chunk_transform(self, chunks_per_shard: tuple[int, ...]) -> Any: """The synchronous transform for the index codec chain. Memoized via instance-local `lru_cache`. """ index_spec = self._get_index_chunk_spec(chunks_per_shard) return ChunkTransform(codecs=evolve_codecs(self.index_codecs, index_spec)) def _decode_shard_index_sync( self, index_bytes: Buffer, chunks_per_shard: tuple[int, ...] ) -> _ShardIndex: """Decode shard index synchronously using ChunkTransform.""" index_transform = self._get_index_chunk_transform(chunks_per_shard) index_spec = self._get_index_chunk_spec(chunks_per_shard) index_array = index_transform.decode_chunk(index_bytes, index_spec) return _ShardIndex(chunks_per_shard, index_array.as_numpy_array()) def _encode_shard_index_sync(self, index: _ShardIndex) -> Buffer: """Encode shard index synchronously using ChunkTransform.""" index_transform = self._get_index_chunk_transform(index.chunks_per_shard) index_spec = self._get_index_chunk_spec(index.chunks_per_shard) index_nd = get_ndbuffer_class().from_numpy_array(index.offsets_and_lengths) result: Buffer | None = index_transform.encode_chunk(index_nd, index_spec) assert result is not None return result def _shard_reader_from_bytes_sync( self, buf: Buffer, chunks_per_shard: tuple[int, ...] ) -> _ShardReader: """Sync version of _ShardReader.from_bytes.""" shard_index_size = self._shard_index_size(chunks_per_shard) if self.index_location == "start": shard_index_bytes = buf[:shard_index_size] else: shard_index_bytes = buf[-shard_index_size:] index = self._decode_shard_index_sync(shard_index_bytes, chunks_per_shard) reader = _ShardReader() reader.buf = buf reader.index = index return reader def _decode_sync( self, shard_bytes: Buffer, shard_spec: ArraySpec, ) -> NDBuffer: """Decode a full shard synchronously. Sync counterpart to `_decode_single`. Same semantics (decode every inner chunk and assemble the full shard array) but routes through `ChunkTransform` instead of the async codec pipeline, so it can run on the sync codec-pipeline fast path without an event loop. For a partial read where the caller only needs a slice of the shard, use `_decode_partial_sync` instead — it fetches only the byte ranges that overlap the selection. This method does not parallelize decompression, but should. See TODO: make issue for handling subchunk parallelism """ shard_shape = shard_spec.shape chunk_shape = self.chunk_shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) inner_transform = self._get_inner_chunk_transform(shard_spec) indexer = BasicIndexer( tuple(slice(0, s) for s in shard_shape), shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, chunk_shape), ) out = chunk_spec.prototype.nd_buffer.empty( shape=shard_shape, dtype=shard_spec.dtype.to_native_dtype(), order=shard_spec.order, ) shard_dict = self._shard_reader_from_bytes_sync(shard_bytes, chunks_per_shard) if shard_dict.index.is_all_empty(): out.fill(shard_spec.fill_value) return out for chunk_coords, chunk_selection, out_selection, _ in indexer: # the GetResult status is discarded: missing INNER chunks of a # present shard always fill (read_missing_chunks is a store-key # level promise, applied to top-level statuses at the array layer) decode_and_scatter_chunk( shard_dict.get(chunk_coords), out, chunk_spec=chunk_spec, chunk_selection=chunk_selection, out_selection=out_selection, drop_axes=(), decode=inner_transform.decode_chunk, ) return out def _encode_sync( self, shard_array: NDBuffer, shard_spec: ArraySpec, ) -> Buffer | None: """Encode a full shard synchronously. Sync counterpart to `_encode_single`. This is reached when a `ShardingCodec` is an *inner* codec of another sharding codec (nested sharding): the outer codec encodes each inner chunk through its `ChunkTransform`, which calls this method on the inner `ShardingCodec`. Each inner chunk is encoded through the inner `ChunkTransform` and collected into an intermediate `dict`. The dict's key order is immaterial — the physical on-disk layout is decided downstream by the `subchunk_write_order` loop in `_encode_shard_dict_sync` (this method does NOT impose a layout). Empty inner chunks become `None` entries when `write_empty_chunks` is False, signalling `_encode_shard_dict_sync` to elide them from the data section and mark them empty in the shard index. Returns `None` if every inner chunk was elided (an all-empty shard) — callers treat that as "delete the shard key". This method does not parallelize compression, but should. See TODO: make issue for handling subchunk parallelism For a partial write that only touches some inner chunks, use `_encode_partial_sync` instead. """ shard_shape = shard_spec.shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) inner_transform = self._get_inner_chunk_transform(shard_spec) indexer = BasicIndexer( tuple(slice(0, s) for s in shard_shape), shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, self.chunk_shape), ) # Key order here is immaterial; _encode_shard_dict_sync lays the present # chunks out in subchunk_write_order. shard_builder: dict[tuple[int, ...], Buffer | None] = dict.fromkeys( lexicographic_order_coords(chunks_per_shard) ) for chunk_coords, _chunk_selection, out_selection, _ in indexer: # None = chunk normalized to missing (see encode_or_elide_chunk) shard_builder[chunk_coords] = encode_or_elide_chunk( shard_array[out_selection], chunk_spec, inner_transform.encode_chunk ) return self._encode_shard_dict_sync( shard_builder, chunks_per_shard=chunks_per_shard, buffer_prototype=default_buffer_prototype(), ) def _encode_partial_sync( self, byte_setter: Any, value: NDBuffer, selection: SelectorTuple, shard_spec: ArraySpec, ) -> None: """Sync equivalent of `_encode_partial_single`. Receives the source data for the written region (not a pre-merged shard array) and the selection within the shard, matching the calling convention of the async partial-encode path used by `BatchedCodecPipeline`. This method does not parallelize compression, but should. See TODO: make issue for handling subchunk parallelism Loads the existing shard, merges the written region into the affected inner chunks, and rewrites the whole shard. """ shard_shape = shard_spec.shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) inner_transform = self._get_inner_chunk_transform(shard_spec) indexer = list( get_indexer( selection, shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, self.chunk_shape), ) ) is_complete = self._is_complete_shard_write(indexer, chunks_per_shard) is_scalar = len(value.shape) == 0 # Load existing inner-chunk bytes into a dict (same structure as # the async path's shard_dict). if is_complete: shard_dict: dict[tuple[int, ...], Buffer | None] = dict.fromkeys( lexicographic_order_coords(chunks_per_shard) ) else: existing_bytes = byte_setter.get_sync(prototype=shard_spec.prototype) if existing_bytes is not None: shard_reader_fb = self._shard_reader_from_bytes_sync( existing_bytes, chunks_per_shard ) # Build the dict with one vectorized index lookup over all chunks, # matching the async _encode_partial_single path. A per-coordinate # __getitem__ loop here is O(n_chunks) Python overhead that dominates # partial writes into shards with many inner chunks. The coordinate # array and keys are cached on the reader, so neither is rebuilt here. shard_dict = shard_reader_fb.to_dict_vectorized() else: shard_dict = dict.fromkeys(lexicographic_order_coords(chunks_per_shard)) # Merge, encode, and store each affected inner chunk into shard_dict via # the canonical merge_and_encode_chunk (None = normalized to missing). # # Scalar fast path: when the written value is a scalar broadcast, every # *complete* inner chunk is byte-for-byte identical — same fill, same # empty-check, same encoded bytes. Compute that outcome once and reuse it # for all complete chunks instead of re-merging, re-checking, and # re-encoding tens of thousands of identical chunks. Incomplete (edge) # chunks still merge against their own existing data individually. # `_sentinel` distinguishes "not computed yet" from a memoized `None` # (an empty chunk). _sentinel = object() scalar_complete_result: Buffer | None | object = _sentinel for chunk_coords, chunk_sel, out_sel, is_complete_chunk in indexer: if is_scalar and is_complete_chunk: if scalar_complete_result is _sentinel: scalar_complete_result = merge_and_encode_chunk( None, value, chunk_spec=chunk_spec, chunk_selection=chunk_sel, out_selection=out_sel, is_complete=is_complete_chunk, drop_axes=(), decode=inner_transform.decode_chunk, encode=inner_transform.encode_chunk, ) shard_dict[chunk_coords] = scalar_complete_result # type: ignore[assignment] continue # A complete chunk fully overwrites: skip decoding what it replaces. existing_raw = None if is_complete_chunk else shard_dict.get(chunk_coords) shard_dict[chunk_coords] = merge_and_encode_chunk( existing_raw, value, chunk_spec=chunk_spec, chunk_selection=chunk_sel, out_selection=out_sel, is_complete=is_complete_chunk, drop_axes=(), decode=inner_transform.decode_chunk, encode=inner_transform.encode_chunk, ) blob = self._encode_shard_dict_sync( shard_dict, chunks_per_shard=chunks_per_shard, buffer_prototype=default_buffer_prototype(), ) if blob is None: byte_setter.delete_sync() else: byte_setter.set_sync(blob) def _build_shard_layout( self, shard_dict: ShardMapping, chunks_per_shard: tuple[int, ...], ) -> tuple[_ShardIndex, list[Buffer]] | None: """Lay out the present inner chunks of a shard. Pure compute, no IO. Packs the encoded inner chunks (in the codec's `subchunk_write_order`) into a contiguous data section and builds a shard index pointing each present chunk at its ABSOLUTE byte offset within the final blob: when the index is stored at the start, offsets are pre-shifted by the index size (known without encoding — the index codecs are fixed-size, which every index read path already relies on), so the index can be encoded exactly once by the caller. Returns `(index, data_buffers)`, or `None` for an all-empty shard (no chunks present). Shared by the sync and async `_encode_shard_dict*` so the layout/offset logic cannot drift between them. """ index = _ShardIndex.create_empty(chunks_per_shard) buffers: list[Buffer] = [] chunk_start = ( self._shard_index_size(chunks_per_shard) if self.index_location == "start" else 0 ) for chunk_coords in self._subchunk_order_iter(chunks_per_shard, self.subchunk_write_order): value = shard_dict.get(chunk_coords) if value is None or len(value) == 0: continue chunk_length = len(value) buffers.append(value) index.set_chunk_slice(chunk_coords, slice(chunk_start, chunk_start + chunk_length)) chunk_start += chunk_length if len(buffers) == 0: return None return index, buffers def _assemble_shard( self, index_bytes: Buffer, buffers: list[Buffer], buffer_prototype: BufferPrototype, *, chunks_per_shard: tuple[int, ...], ) -> Buffer: """Concatenate the encoded index and data buffers into the shard blob. The layout from `_build_shard_layout` already assumes the index size, so the encoded index length must match `_shard_index_size` exactly — guard that assumption rather than silently corrupt offsets. The guard lives here, once, for both the sync and async encode paths. """ if len(index_bytes) != self._shard_index_size(chunks_per_shard): raise RuntimeError( "encoded shard index size does not match _shard_index_size; " "variable-size index codecs are not supported" ) if self.index_location == "start": buffers.insert(0, index_bytes) else: buffers.append(index_bytes) template = buffer_prototype.buffer.create_zero_length() return template.combine(buffers) def _encode_shard_dict_sync( self, shard_dict: ShardMapping, chunks_per_shard: tuple[int, ...], buffer_prototype: BufferPrototype, ) -> Buffer | None: """Sync version of _encode_shard_dict. Layout via the shared `_build_shard_layout` (offsets already absolute), then a single index encode and concatenation. Returns `None` for an all-empty shard (no chunks present). """ layout = self._build_shard_layout(shard_dict, chunks_per_shard) if layout is None: return None index, buffers = layout index_bytes = self._encode_shard_index_sync(index) return self._assemble_shard( index_bytes, buffers, buffer_prototype, chunks_per_shard=chunks_per_shard ) async def _decode_single( self, shard_bytes: Buffer, shard_spec: ArraySpec, ) -> NDBuffer: shard_shape = shard_spec.shape chunk_shape = self.chunk_shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) indexer = BasicIndexer( tuple(slice(0, s) for s in shard_shape), shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, chunk_shape), ) # setup output array out = chunk_spec.prototype.nd_buffer.empty( shape=shard_shape, dtype=shard_spec.dtype.to_native_dtype(), order=shard_spec.order, ) shard_dict = await _ShardReader.from_bytes(shard_bytes, self, chunks_per_shard) if shard_dict.index.is_all_empty(): out.fill(shard_spec.fill_value) return out # decoding chunks and writing them into the output buffer await self._get_inner_pipeline(shard_spec).read( [ ( _ShardingByteGetter(shard_dict, chunk_coords), chunk_spec, chunk_selection, out_selection, is_complete_shard, ) for chunk_coords, chunk_selection, out_selection, is_complete_shard in indexer ], out, ) return out async def _decode_partial_single( self, byte_getter: ByteGetter, selection: SelectorTuple, shard_spec: ArraySpec, ) -> NDBuffer | None: shard_shape = shard_spec.shape chunk_shape = self.chunk_shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) indexer = get_indexer( selection, shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, chunk_shape), ) # setup output array out = shard_spec.prototype.nd_buffer.empty( shape=indexer.shape, dtype=shard_spec.dtype.to_native_dtype(), order=shard_spec.order, ) indexed_chunks = list(indexer) all_chunk_coords = {chunk_coords for chunk_coords, *_ in indexed_chunks} # reading bytes of all requested chunks shard_dict_maybe: ShardMapping | None if self._is_total_shard(all_chunk_coords, chunks_per_shard): # read entire shard shard_dict_maybe = await self._load_full_shard_maybe( byte_getter=byte_getter, prototype=chunk_spec.prototype, chunks_per_shard=chunks_per_shard, ) else: # read some chunks within the shard shard_dict_maybe = await self._load_partial_shard_maybe( byte_getter, chunk_spec.prototype, chunks_per_shard, all_chunk_coords, max_gap_bytes=shard_spec.config.sharding_coalesce_max_gap_bytes, max_coalesced_bytes=shard_spec.config.sharding_coalesce_max_bytes, ) if shard_dict_maybe is None: return None shard_dict = shard_dict_maybe # decoding chunks and writing them into the output buffer await self._get_inner_pipeline(shard_spec).read( [ ( _ShardingByteGetter(shard_dict, chunk_coords), chunk_spec, chunk_selection, out_selection, is_complete_shard, ) for chunk_coords, chunk_selection, out_selection, is_complete_shard in indexer ], out, ) if hasattr(indexer, "sel_shape"): return out.reshape(indexer.sel_shape) else: return out def _subchunk_order_iter( self, chunks_per_shard: tuple[int, ...], subchunk_write_order: SubchunkWriteOrder ) -> Iterable[tuple[int, ...]]: subchunk_iter: Iterable[tuple[int, ...]] match subchunk_write_order: case "morton": subchunk_iter = morton_order_coords(chunks_per_shard) case "lexicographic": subchunk_iter = lexicographic_order_coords(chunks_per_shard) case "colexicographic": subchunk_iter = colexicographic_order_coords(chunks_per_shard) case "unordered": # "unordered" promises no particular layout; today it happens to be # lexicographic, but callers must not rely on that. subchunk_iter = np.ndindex(chunks_per_shard) case _: raise ValueError(f"Unrecognized subchunk write order: {subchunk_write_order!r}.") return subchunk_iter def _decode_full_shard_bulk_if_uncompressed( self, shard_bytes: Buffer, shard_spec: ArraySpec, indexer: Any, ) -> NDBuffer | None: """Vectorized whole-shard decode for dense, fixed-size, uncompressed shards. Returns the assembled shard array, or None if the fast path does not apply (so the caller falls back to the per-chunk loop). Conditions: - inner codec chain is fixed-size (no compression / variable-length); - the inner codec chain is exactly a single BytesCodec — decode is a dtype/endian view with no reordering. A trailing crc32c is NOT accepted (the bulk path can't verify per-chunk checksums, so crc shards keep the per-chunk path's corruption detection); - the data type is not structured (the byte-order handling below has no `Struct` branch); - `indexer` is an identity full-shard read (`_is_identity_full_read`); - the stored index is dense (every chunk present, equal fixed length, exactly tiling the data section) so the data section is a regular grid of chunk payloads. Chunk positions are read from the stored index, so this is correct for any `subchunk_write_order` (morton / lexicographic / colexicographic / unordered). The on-disk byte order is taken from the BytesCodec's `endian`, so big- and little-endian shards both decode correctly. """ # --- gate on a trivial, fixed-size inner codec chain --- if not self._inner_codecs_fixed_size: return None # The inner chain must be exactly a single BytesCodec (a dtype/endian # view, no reordering). A trailing Crc32cCodec is excluded on purpose: # the bulk path would have to strip-and-discard the per-chunk checksum # bytes, silently dropping the corruption detection the per-chunk path # enforces (Crc32cCodec._decode_sync raises on mismatch). crc-protected # shards therefore fall through to the per-chunk path. if len(self.codecs) != 1 or not isinstance(self.codecs[0], BytesCodec): return None ab_codec = self.codecs[0] # The byte-order handling below lacks the structured-dtype branch of # `BytesCodec._decode_sync` (which applies `newbyteorder` to multi-byte # struct fields), so structured dtypes must take the per-chunk path. if isinstance(shard_spec.dtype, Struct): return None chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) n_chunks = product(chunks_per_shard) if n_chunks == 0: return None # Only valid for an identity full-shard read, where each chunk lands at # its natural grid position. The per-dimension check is load-bearing: # a gather selection (an `OrthogonalIndexer` with an integer-array or # boolean dimension, from `arr[perm, :]` / `arr.oindex[...]`, or a # `CoordinateIndexer` from vindex) can have an output `.shape` equal to # the shard shape while reordering or duplicating points — serving it # from the bulk path would return the shard in natural order, silently # dropping the reordering. Anything that is not a full-slice-per- # dimension read falls through to the per-chunk path so # chunk_selection / out_selection are honored. if not _is_identity_full_read(indexer, shard_spec.shape): return None chunk_byte_length = self._inner_chunk_byte_length(chunk_spec) shard_index_size = self._shard_index_size(chunks_per_shard) if len(shard_bytes) != n_chunks * chunk_byte_length + shard_index_size: return None # not a dense fixed-size shard # --- decode the index; require dense layout --- if self.index_location == "start": index_bytes = shard_bytes[:shard_index_size] else: index_bytes = shard_bytes[-shard_index_size:] index = self._decode_shard_index_sync(index_bytes, chunks_per_shard) data_section_start = shard_index_size if self.index_location == "start" else 0 if not index.is_dense(chunk_byte_length, data_section_start=data_section_start): return None # --- bulk reconstruct --- # The index gives each chunk's absolute byte offset within the blob; with # a dense, crc-free, fixed-size layout the payload length is exactly the # encoded item-bytes of one chunk. native_dtype = shard_spec.dtype.to_native_dtype() raw = shard_bytes.as_numpy_array().view(np.uint8) payload = chunk_byte_length cs = self.chunk_shape # On-disk byte order is carried by the BytesCodec's `endian`, NOT by the # data type (zarr v3). Build the read-view dtype from the codec's endian # exactly as BytesCodec._decode_sync does, so a big-endian shard read on a # little-endian host (or vice versa) is interpreted correctly. Assigning # into the native-dtype `out` then performs any needed byteswap. `endian` # is now a plain Literal['little', 'big'] | None string (no longer an enum). endian_str = ab_codec.endian if isinstance(chunk_spec.dtype, HasEndianness): stored_dtype = replace(chunk_spec.dtype, endianness=endian_str).to_native_dtype() # type: ignore[call-arg] else: stored_dtype = chunk_spec.dtype.to_native_dtype() offsets = index.offsets_and_lengths[..., 0].reshape(-1) # localized coords, C-order coords_c = list(np.ndindex(chunks_per_shard)) out = shard_spec.prototype.nd_buffer.empty( shape=indexer.shape, dtype=native_dtype, order=shard_spec.order ) for flat, coord in enumerate(coords_c): start = int(offsets[flat]) chunk = raw[start : start + payload].view(stored_dtype).reshape(cs) sel = tuple(slice(c * s, c * s + s) for c, s in zip(coord, cs, strict=True)) out[sel] = chunk return out def _decode_partial_sync( self, byte_getter: Any, selection: SelectorTuple, shard_spec: ArraySpec, ) -> NDBuffer | None: """Sync equivalent of `_decode_partial_single`. Reads only the inner-chunk byte ranges that overlap `selection` (plus the shard index) and decodes them through the inner codec chain. The store must support `get_sync` with byte ranges. This method does not parallelize decompression, but should. See TODO: make issue for handling subchunk parallelism Two sub-paths: - If `selection` covers the entire shard, just fetch the whole blob — that's strictly cheaper than two round trips (index, then data) plus the per-chunk overhead of partial fetches. - Otherwise fetch the index alone, look up only the byte slices of the inner chunks the selection touches, fetch those, and decode. """ shard_shape = shard_spec.shape chunk_shape = self.chunk_shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) inner_transform = self._get_inner_chunk_transform(shard_spec) indexer = get_indexer( selection, shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, chunk_shape), ) out = shard_spec.prototype.nd_buffer.empty( shape=indexer.shape, dtype=shard_spec.dtype.to_native_dtype(), order=shard_spec.order, ) indexed_chunks = list(indexer) all_chunk_coords = {chunk_coords for chunk_coords, *_ in indexed_chunks} # Read just the inner chunks we need. if self._is_total_shard(all_chunk_coords, chunks_per_shard): shard_bytes = byte_getter.get_sync(prototype=chunk_spec.prototype) if shard_bytes is None: return None bulk = self._decode_full_shard_bulk_if_uncompressed(shard_bytes, shard_spec, indexer) if bulk is not None: # The bulk path only fires for an identity full-shard read # (`_is_identity_full_read`), so the result is already # shard-shaped and in natural order — no reshape needed. return bulk shard_reader = self._shard_reader_from_bytes_sync(shard_bytes, chunks_per_shard) shard_dict: ShardMapping = shard_reader else: # Partial read: fetch only the touched inner chunks, coalescing # adjacent byte ranges (mirrors the async _load_partial_shard_maybe # / #3004). Returns None if the shard is absent. partial = self._load_partial_shard_maybe_sync( byte_getter, chunk_spec.prototype, chunks_per_shard, all_chunk_coords, max_gap_bytes=shard_spec.config.sharding_coalesce_max_gap_bytes, max_coalesced_bytes=shard_spec.config.sharding_coalesce_max_bytes, ) if partial is None: return None shard_dict = partial # Decode each needed inner chunk and scatter into out (statuses # discarded: missing inner chunks fill, see _decode_sync). for chunk_coords, chunk_selection, out_selection, _ in indexed_chunks: decode_and_scatter_chunk( shard_dict.get(chunk_coords), out, chunk_spec=chunk_spec, chunk_selection=chunk_selection, out_selection=out_selection, drop_axes=(), decode=inner_transform.decode_chunk, ) if hasattr(indexer, "sel_shape"): return out.reshape(indexer.sel_shape) return out async def _encode_single( self, shard_array: NDBuffer, shard_spec: ArraySpec, ) -> Buffer | None: shard_shape = shard_spec.shape chunk_shape = self.chunk_shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) indexer = list( BasicIndexer( tuple(slice(0, s) for s in shard_shape), shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, chunk_shape), ) ) shard_builder = dict.fromkeys(lexicographic_order_coords(chunks_per_shard)) await self._get_inner_pipeline(shard_spec).write( [ ( _ShardingByteSetter(shard_builder, chunk_coords), chunk_spec, chunk_selection, out_selection, is_complete_shard, ) for chunk_coords, chunk_selection, out_selection, is_complete_shard in indexer ], shard_array, ) return await self._encode_shard_dict( shard_builder, chunks_per_shard=chunks_per_shard, buffer_prototype=default_buffer_prototype(), ) async def _encode_partial_single( self, byte_setter: ByteSetter, shard_array: NDBuffer, selection: SelectorTuple, shard_spec: ArraySpec, ) -> None: shard_shape = shard_spec.shape chunk_shape = self.chunk_shape chunks_per_shard = self._get_chunks_per_shard(shard_spec) chunk_spec = self._get_chunk_spec(shard_spec) indexer = list( get_indexer( selection, shape=shard_shape, chunk_grid=ChunkGrid.from_sizes(shard_shape, chunk_shape), ) ) if self._is_complete_shard_write(indexer, chunks_per_shard): shard_dict = dict.fromkeys(lexicographic_order_coords(chunks_per_shard)) else: shard_reader = await self._load_full_shard_maybe( byte_getter=byte_setter, prototype=chunk_spec.prototype, chunks_per_shard=chunks_per_shard, ) shard_reader = shard_reader or _ShardReader.create_empty(chunks_per_shard) # Use vectorized lookup for better performance. The lexicographic # coordinate array and keys are cached, so neither is rebuilt on # every write. shard_dict = shard_reader.to_dict_vectorized() await self._get_inner_pipeline(shard_spec).write( [ ( _ShardingByteSetter(shard_dict, chunk_coords), chunk_spec, chunk_selection, out_selection, is_complete_shard, ) for chunk_coords, chunk_selection, out_selection, is_complete_shard in indexer ], shard_array, ) buf = await self._encode_shard_dict( shard_dict, chunks_per_shard=chunks_per_shard, buffer_prototype=default_buffer_prototype(), ) if buf is None: await byte_setter.delete() else: await byte_setter.set(buf) async def _encode_shard_dict( self, map: ShardMapping, chunks_per_shard: tuple[int, ...], buffer_prototype: BufferPrototype, ) -> Buffer | None: """Layout via the shared `_build_shard_layout` (offsets already absolute), then a single index encode and concatenation. Async twin of `_encode_shard_dict_sync`.""" layout = self._build_shard_layout(map, chunks_per_shard) if layout is None: return None index, buffers = layout index_bytes = await self._encode_shard_index(index) return self._assemble_shard( index_bytes, buffers, buffer_prototype, chunks_per_shard=chunks_per_shard ) def _is_total_shard( self, all_chunk_coords: set[tuple[int, ...]], chunks_per_shard: tuple[int, ...] ) -> bool: # `all_chunk_coords` comes from an indexer over this shard's chunk grid, so # it is always a subset of that grid (`validate` requires the shard shape to # be divisible by the inner chunk shape, so the indexer cannot produce an # out-of-grid coordinate). A subset whose size equals the grid's is the # whole grid, so the count check alone proves totality — no need to build # and membership-test the full coordinate set on this hot path. return len(all_chunk_coords) == product(chunks_per_shard) def _is_complete_shard_write( self, indexed_chunks: Sequence[ChunkProjection], chunks_per_shard: tuple[int, ...], ) -> bool: all_chunk_coords = {chunk_coords for chunk_coords, *_ in indexed_chunks} return self._is_total_shard(all_chunk_coords, chunks_per_shard) and all( is_complete_chunk for *_, is_complete_chunk in indexed_chunks ) @property def _sync_capable(self) -> bool: """Dynamic opt-out consulted by `_codec_supports_sync` / `ChunkTransform`. This codec structurally satisfies `SupportsSyncCodec`, but every sync method (`_decode_sync`, `_encode_sync`, `_decode_partial_sync`, `_encode_partial_sync`) delegates to the inner and index codec chains through `ChunkTransform`, so it can only run synchronously when every codec in BOTH chains is itself sync-capable. Reporting False here makes `ChunkTransform` construction raise, which in turn makes `FusedCodecPipeline.evolve_from_array_spec` set `sync_transform=None` — the whole pipeline then declines the sync fast path and routes through the async paths (partial shard decode / async fallback write), exactly as it does for an async-only TOP-level codec or a non-sync store. """ return self._inner_codecs_sync_capable() and self._index_codecs_sync_capable() def _inner_codecs_sync_capable(self) -> bool: # _codec_supports_sync (not bare isinstance) so a nested sharding codec # with an async-only inner chain propagates its opt-out outward. return all(_codec_supports_sync(c) for c in self.codecs) def _index_codecs_sync_capable(self) -> bool: return all(_codec_supports_sync(c) for c in self.index_codecs) async def _decode_shard_index( self, index_bytes: Buffer, chunks_per_shard: tuple[int, ...] ) -> _ShardIndex: # Pure compute (the bytes are already in hand): delegate to the sync # implementation instead of spinning up a pipeline + per-call # AsyncChunkTransform for a tiny fixed-size decode. The default # (bytes + crc32c) index chain is sync-capable; an async-only # third-party index codec falls back to the full async pipeline, which # the synchronous read paths cannot use but this async path still can. if self._index_codecs_sync_capable(): return self._decode_shard_index_sync(index_bytes, chunks_per_shard) index_array = next( iter( await get_pipeline_class() .from_codecs(self.index_codecs) .decode([(index_bytes, self._get_index_chunk_spec(chunks_per_shard))]) ) ) assert index_array is not None # the bytes are already in hand return _ShardIndex(chunks_per_shard, index_array.as_numpy_array()) async def _encode_shard_index(self, index: _ShardIndex) -> Buffer: # Pure compute: delegate to the sync implementation, with the same # async-pipeline fallback as _decode_shard_index. if self._index_codecs_sync_capable(): return self._encode_shard_index_sync(index) index_bytes = next( iter( await get_pipeline_class() .from_codecs(self.index_codecs) .encode( [ ( get_ndbuffer_class().from_numpy_array(index.offsets_and_lengths), self._get_index_chunk_spec(index.chunks_per_shard), ) ] ) ) ) assert index_bytes is not None return index_bytes def _shard_index_size(self, chunks_per_shard: tuple[int, ...]) -> int: return ( get_pipeline_class() .from_codecs(self.index_codecs) .compute_encoded_size( 16 * product(chunks_per_shard), self._get_index_chunk_spec(chunks_per_shard) ) ) def _get_index_chunk_spec(self, chunks_per_shard: tuple[int, ...]) -> ArraySpec: return ArraySpec( shape=chunks_per_shard + (2,), dtype=UInt64(endianness="little"), fill_value=MAX_UINT_64, config=ArrayConfig( order="C", write_empty_chunks=False ), # Note: this is hard-coded for simplicity -- it is not surfaced into user code, prototype=default_buffer_prototype(), ) def _get_chunk_spec(self, shard_spec: ArraySpec) -> ArraySpec: return ArraySpec( shape=self.chunk_shape, dtype=shard_spec.dtype, fill_value=shard_spec.fill_value, config=shard_spec.config, prototype=shard_spec.prototype, ) def _get_chunks_per_shard(self, shard_spec: ArraySpec) -> tuple[int, ...]: return tuple( s // c for s, c in zip( shard_spec.shape, self.chunk_shape, strict=False, ) ) def _shard_index_byte_range( self, chunks_per_shard: tuple[int, ...] ) -> RangeByteRequest | SuffixByteRequest: """Byte range of the shard index within the shard blob. Single source of truth for the index-location arithmetic, shared by the sync and async index loaders so they cannot drift. """ shard_index_size = self._shard_index_size(chunks_per_shard) if self.index_location == "start": return RangeByteRequest(0, shard_index_size) return SuffixByteRequest(shard_index_size) @staticmethod def _pair_chunks_with_byte_ranges( shard_index: _ShardIndex, all_chunk_coords: set[tuple[int, ...]] ) -> list[tuple[tuple[int, ...], RangeByteRequest]]: """Pair each requested chunk coord with its byte range in the shard. Coords whose chunk is absent from the index are omitted. Shared by the sync and async partial-shard loaders. """ chunk_coord_byte_ranges: list[tuple[tuple[int, ...], RangeByteRequest]] = [] for chunk_coord in all_chunk_coords: chunk_byte_slice = shard_index.get_chunk_slice(chunk_coord) if chunk_byte_slice is not None: chunk_coord_byte_ranges.append( (chunk_coord, RangeByteRequest(chunk_byte_slice[0], chunk_byte_slice[1])) ) return chunk_coord_byte_ranges async def _load_shard_index_maybe( self, byte_getter: ByteGetter, chunks_per_shard: tuple[int, ...] ) -> _ShardIndex | None: index_bytes = await byte_getter.get( prototype=numpy_buffer_prototype(), byte_range=self._shard_index_byte_range(chunks_per_shard), ) if index_bytes is not None: return await self._decode_shard_index(index_bytes, chunks_per_shard) return None async def _load_full_shard_maybe( self, byte_getter: ByteGetter, prototype: BufferPrototype, chunks_per_shard: tuple[int, ...] ) -> _ShardReader | None: shard_bytes = await byte_getter.get(prototype=prototype) return ( await _ShardReader.from_bytes(shard_bytes, self, chunks_per_shard) if shard_bytes else None ) @property def _inner_codecs_fixed_size(self) -> bool: """True when all inner codecs produce fixed-size output (no compression).""" return all(c.is_fixed_size for c in self.codecs) def _inner_chunk_byte_length(self, chunk_spec: ArraySpec) -> int: """Encoded byte length of a single inner chunk. Only valid when _inner_codecs_fixed_size.""" raw_byte_length = 1 for s in self.chunk_shape: raw_byte_length *= s raw_byte_length *= chunk_spec.dtype.item_size # type: ignore[attr-defined] return int(self.codec_pipeline.compute_encoded_size(raw_byte_length, chunk_spec)) async def _load_partial_shard_maybe( self, byte_getter: ByteGetter, prototype: BufferPrototype, chunks_per_shard: tuple[int, ...], all_chunk_coords: set[tuple[int, ...]], max_gap_bytes: int, max_coalesced_bytes: int, ) -> ShardMapping | None: """ Read chunks from `byte_getter` for the case where the read is less than a full shard. Returns a mapping of chunk coordinates to bytes or None. `max_gap_bytes` and `max_coalesced_bytes` are forwarded to `Store.get_ranges` to control byte-range coalescing across the requested chunks. """ shard_index = await self._load_shard_index_maybe(byte_getter, chunks_per_shard) if shard_index is None: return None chunk_coord_byte_ranges = self._pair_chunks_with_byte_ranges(shard_index, all_chunk_coords) if not chunk_coord_byte_ranges: return {} shard_dict: ShardMutableMapping = {} if isinstance(byte_getter, StorePath): # External store: use Store.get_ranges for coalescing + concurrency. byte_ranges = [byte_range for _, byte_range in chunk_coord_byte_ranges] try: async for group in byte_getter.store.get_ranges( byte_getter.path, byte_ranges, prototype=prototype, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ): for idx, buf in group: if buf is not None: chunk_coord, _ = chunk_coord_byte_ranges[idx] shard_dict[chunk_coord] = buf except BaseExceptionGroup as eg: # `Store.get_ranges` raises FileNotFoundError (wrapped in a # BaseExceptionGroup) if any underlying fetch indicates the key is # absent. The shard index loaded above, so this typically means a # race where the shard was deleted mid-read; treat it as "shard # gone" to match the index-missing branch (return None). Anything # else in the group (e.g. IO errors) is re-raised. _, rest = eg.split(FileNotFoundError) if rest is not None: raise rest from None return None else: # Any other ByteGetter. In practice only `_ShardingByteGetter` for # nested sharding, which slices an in-memory buffer (no I/O to coalesce). for chunk_coord, byte_range in chunk_coord_byte_ranges: buf = await byte_getter.get(prototype, byte_range) if buf is not None: shard_dict[chunk_coord] = buf return shard_dict def _load_shard_index_maybe_sync( self, byte_getter: Any, chunks_per_shard: tuple[int, ...] ) -> _ShardIndex | None: """Sync counterpart of `_load_shard_index_maybe`.""" index_bytes = byte_getter.get_sync( prototype=numpy_buffer_prototype(), byte_range=self._shard_index_byte_range(chunks_per_shard), ) if index_bytes is not None: return self._decode_shard_index_sync(index_bytes, chunks_per_shard) return None def _load_partial_shard_maybe_sync( self, byte_getter: Any, prototype: BufferPrototype, chunks_per_shard: tuple[int, ...], all_chunk_coords: set[tuple[int, ...]], *, max_gap_bytes: int, max_coalesced_bytes: int, ) -> ShardMapping | None: """Sync counterpart of `_load_partial_shard_maybe` (the #3004 read path). Reads the shard index, then fetches only the touched inner chunks via the store's coalescing `get_ranges_sync` (merging adjacent ranges into fewer reads), matching the async path's IO shape without an event loop. `max_gap_bytes` and `max_coalesced_bytes` control the coalescing, forwarded from the array's `sharding_coalesce_*` config exactly as the async path. """ shard_index = self._load_shard_index_maybe_sync(byte_getter, chunks_per_shard) if shard_index is None: return None chunk_coord_byte_ranges = self._pair_chunks_with_byte_ranges(shard_index, all_chunk_coords) if not chunk_coord_byte_ranges: return {} shard_dict: ShardMutableMapping = {} store = byte_getter.store if hasattr(byte_getter, "store") else None if isinstance(store, Store) and _store_supports_sync_io(store): # External store: coalesce via get_ranges_sync (mirrors get_ranges). byte_ranges = [byte_range for _, byte_range in chunk_coord_byte_ranges] try: for idx, buf in store.get_ranges_sync( byte_getter.path, byte_ranges, prototype=prototype, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ): if buf is not None: chunk_coord, _ = chunk_coord_byte_ranges[idx] shard_dict[chunk_coord] = buf except BaseExceptionGroup as eg: # Mirror the async path: a FileNotFoundError means the shard was # deleted mid-read -> treat as "gone" (None). Re-raise anything else. _, rest = eg.split(FileNotFoundError) if rest is not None: raise rest from None return None else: # Nested sharding: an in-memory _ShardingByteGetter, no IO to coalesce. for chunk_coord, byte_range in chunk_coord_byte_ranges: buf = byte_getter.get_sync(prototype=prototype, byte_range=byte_range) if buf is not None: shard_dict[chunk_coord] = buf return shard_dict def compute_encoded_size(self, input_byte_length: int, shard_spec: ArraySpec) -> int: chunks_per_shard = self._get_chunks_per_shard(shard_spec) return input_byte_length + self._shard_index_size(chunks_per_shard) zarr-python-3.3.0/src/zarr/codecs/transpose.py000066400000000000000000000105771523267620000214240ustar00rootroot00000000000000from __future__ import annotations from collections.abc import Iterable from dataclasses import dataclass, replace from typing import TYPE_CHECKING, cast import numpy as np from zarr.abc.codec import ArrayArrayCodec from zarr.core.array_spec import ArraySpec from zarr.core.common import JSON, parse_named_configuration if TYPE_CHECKING: from typing import Self from zarr.core.buffer import NDBuffer from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.core.metadata.v3 import ChunkGridMetadata def parse_transpose_order(data: JSON | Iterable[int]) -> tuple[int, ...]: if not isinstance(data, Iterable): raise TypeError(f"Expected an iterable. Got {data} instead.") if not all(isinstance(a, int) for a in data): raise TypeError(f"Expected an iterable of integers. Got {data} instead.") return tuple(cast("Iterable[int]", data)) @dataclass(frozen=True) class TransposeCodec(ArrayArrayCodec): """Transpose codec""" is_fixed_size = True order: tuple[int, ...] def __init__(self, *, order: Iterable[int]) -> None: order_parsed = parse_transpose_order(order) object.__setattr__(self, "order", order_parsed) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration(data, "transpose") return cls(**configuration_parsed) # type: ignore[arg-type] def to_dict(self) -> dict[str, JSON]: return {"name": "transpose", "configuration": {"order": tuple(self.order)}} def validate( self, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: if len(self.order) != len(shape): raise ValueError( f"The `order` tuple must have as many entries as there are dimensions in the array. Got {self.order}." ) if len(self.order) != len(set(self.order)): raise ValueError( f"There must not be duplicates in the `order` tuple. Got {self.order}." ) if not all(0 <= x < len(shape) for x in self.order): raise ValueError( f"All entries in the `order` tuple must be between 0 and the number of dimensions in the array. Got {self.order}." ) def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: ndim = array_spec.ndim if len(self.order) != ndim: raise ValueError( f"The `order` tuple must have as many entries as there are dimensions in the array. Got {self.order}." ) if len(self.order) != len(set(self.order)): raise ValueError( f"There must not be duplicates in the `order` tuple. Got {self.order}." ) if not all(0 <= x < ndim for x in self.order): raise ValueError( f"All entries in the `order` tuple must be between 0 and the number of dimensions in the array. Got {self.order}." ) order = tuple(self.order) if order != self.order: return replace(self, order=order) return self def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: return ArraySpec( shape=tuple(chunk_spec.shape[self.order[i]] for i in range(chunk_spec.ndim)), dtype=chunk_spec.dtype, fill_value=chunk_spec.fill_value, config=chunk_spec.config, prototype=chunk_spec.prototype, ) def _decode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer: inverse_order = tuple(int(i) for i in np.argsort(self.order)) return chunk_array.transpose(inverse_order) async def _decode_single( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> NDBuffer: return self._decode_sync(chunk_array, chunk_spec) def _encode_sync( self, chunk_array: NDBuffer, _chunk_spec: ArraySpec, ) -> NDBuffer | None: return chunk_array.transpose(self.order) async def _encode_single( self, chunk_array: NDBuffer, _chunk_spec: ArraySpec, ) -> NDBuffer | None: return self._encode_sync(chunk_array, _chunk_spec) def compute_encoded_size(self, input_byte_length: int, _chunk_spec: ArraySpec) -> int: return input_byte_length zarr-python-3.3.0/src/zarr/codecs/vlen_utf8.py000066400000000000000000000114101523267620000213030ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass from typing import TYPE_CHECKING import numpy as np from numcodecs.vlen import VLenBytes, VLenUTF8 from zarr._compat import _reshape_view from zarr.abc.codec import ArrayBytesCodec from zarr.core.buffer import Buffer, NDBuffer from zarr.core.common import JSON, parse_named_configuration if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec # can use a global because there are no parameters _vlen_utf8_codec = VLenUTF8() _vlen_bytes_codec = VLenBytes() @dataclass(frozen=True) class VLenUTF8Codec(ArrayBytesCodec): """Variable-length UTF8 codec""" @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration( data, "vlen-utf8", require_configuration=False ) configuration_parsed = configuration_parsed or {} return cls(**configuration_parsed) def to_dict(self) -> dict[str, JSON]: return {"name": "vlen-utf8", "configuration": {}} def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: return self def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: assert isinstance(chunk_bytes, Buffer) raw_bytes = chunk_bytes.as_array_like() decoded = _vlen_utf8_codec.decode(raw_bytes) assert decoded.dtype == np.object_ decoded = _reshape_view(decoded, chunk_spec.shape) as_string_dtype = decoded.astype(chunk_spec.dtype.to_native_dtype(), copy=False) return chunk_spec.prototype.nd_buffer.from_numpy_array(as_string_dtype) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: return self._decode_sync(chunk_bytes, chunk_spec) def _encode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: assert isinstance(chunk_array, NDBuffer) # numcodecs vlen codecs flatten with order="A", so an F-contiguous chunk # would be encoded in transposed element order (gh-3558) return chunk_spec.prototype.buffer.from_bytes( _vlen_utf8_codec.encode(np.ascontiguousarray(chunk_array.as_numpy_array())) ) async def _encode_single( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: return self._encode_sync(chunk_array, chunk_spec) def compute_encoded_size(self, input_byte_length: int, _chunk_spec: ArraySpec) -> int: # what is input_byte_length for an object dtype? raise NotImplementedError("compute_encoded_size is not implemented for VLen codecs") @dataclass(frozen=True) class VLenBytesCodec(ArrayBytesCodec): @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration( data, "vlen-bytes", require_configuration=False ) configuration_parsed = configuration_parsed or {} return cls(**configuration_parsed) def to_dict(self) -> dict[str, JSON]: return {"name": "vlen-bytes", "configuration": {}} def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: return self def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: assert isinstance(chunk_bytes, Buffer) raw_bytes = chunk_bytes.as_array_like() decoded = _vlen_bytes_codec.decode(raw_bytes) assert decoded.dtype == np.object_ decoded = _reshape_view(decoded, chunk_spec.shape) return chunk_spec.prototype.nd_buffer.from_numpy_array(decoded) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> NDBuffer: return self._decode_sync(chunk_bytes, chunk_spec) def _encode_sync( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: assert isinstance(chunk_array, NDBuffer) # numcodecs vlen codecs flatten with order="A", so an F-contiguous chunk # would be encoded in transposed element order (gh-3558) return chunk_spec.prototype.buffer.from_bytes( _vlen_bytes_codec.encode(np.ascontiguousarray(chunk_array.as_numpy_array())) ) async def _encode_single( self, chunk_array: NDBuffer, chunk_spec: ArraySpec, ) -> Buffer | None: return self._encode_sync(chunk_array, chunk_spec) def compute_encoded_size(self, input_byte_length: int, _chunk_spec: ArraySpec) -> int: # what is input_byte_length for an object dtype? raise NotImplementedError("compute_encoded_size is not implemented for VLen codecs") zarr-python-3.3.0/src/zarr/codecs/zstd.py000066400000000000000000000063741523267620000203720ustar00rootroot00000000000000from __future__ import annotations import asyncio from dataclasses import dataclass from functools import cached_property from typing import TYPE_CHECKING import numcodecs from numcodecs.zstd import Zstd from packaging.version import Version from zarr.abc.codec import BytesBytesCodec from zarr.core.buffer.cpu import as_numpy_array_wrapper from zarr.core.common import JSON, parse_named_configuration if TYPE_CHECKING: from typing import Self from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer def parse_zstd_level(data: JSON) -> int: if isinstance(data, int): if data >= 23: raise ValueError(f"Value must be less than or equal to 22. Got {data} instead.") return data raise TypeError(f"Got value with type {type(data)}, but expected an int.") def parse_checksum(data: JSON) -> bool: if isinstance(data, bool): return data raise TypeError(f"Expected bool. Got {type(data)}.") @dataclass(frozen=True) class ZstdCodec(BytesBytesCodec): """zstd codec""" is_fixed_size = False level: int = 0 checksum: bool = False def __init__(self, *, level: int = 0, checksum: bool = False) -> None: # numcodecs 0.13.0 introduces the checksum attribute for the zstd codec _numcodecs_version = Version(numcodecs.__version__) if _numcodecs_version < Version("0.13.0"): raise RuntimeError( "numcodecs version >= 0.13.0 is required to use the zstd codec. " f"Version {_numcodecs_version} is currently installed." ) level_parsed = parse_zstd_level(level) checksum_parsed = parse_checksum(checksum) object.__setattr__(self, "level", level_parsed) object.__setattr__(self, "checksum", checksum_parsed) @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, configuration_parsed = parse_named_configuration(data, "zstd") return cls(**configuration_parsed) # type: ignore[arg-type] def to_dict(self) -> dict[str, JSON]: return {"name": "zstd", "configuration": {"level": self.level, "checksum": self.checksum}} @cached_property def _zstd_codec(self) -> Zstd: config_dict = {"level": self.level, "checksum": self.checksum} return Zstd.from_config(config_dict) def _decode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return as_numpy_array_wrapper(self._zstd_codec.decode, chunk_bytes, chunk_spec.prototype) async def _decode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer: return await asyncio.to_thread(self._decode_sync, chunk_bytes, chunk_spec) def _encode_sync( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: return as_numpy_array_wrapper(self._zstd_codec.encode, chunk_bytes, chunk_spec.prototype) async def _encode_single( self, chunk_bytes: Buffer, chunk_spec: ArraySpec, ) -> Buffer | None: return await asyncio.to_thread(self._encode_sync, chunk_bytes, chunk_spec) def compute_encoded_size(self, _input_byte_length: int, _chunk_spec: ArraySpec) -> int: raise NotImplementedError zarr-python-3.3.0/src/zarr/core/000077500000000000000000000000001523267620000165125ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/core/__init__.py000066400000000000000000000004331523267620000206230ustar00rootroot00000000000000""" The ``zarr.core`` module is considered private API and should not be imported directly by 3rd-party code. """ from __future__ import annotations from zarr.core.buffer import Buffer, NDBuffer # noqa: F401 from zarr.core.codec_pipeline import BatchedCodecPipeline # noqa: F401 zarr-python-3.3.0/src/zarr/core/_coalesce.py000066400000000000000000000203361523267620000210050ustar00rootroot00000000000000# src/zarr/core/_coalesce.py from __future__ import annotations import asyncio from typing import TYPE_CHECKING, NamedTuple from zarr.abc.store import RangeByteRequest if TYPE_CHECKING: from collections.abc import AsyncGenerator, Awaitable, Callable, Sequence from zarr.abc.store import ByteRequest from zarr.core.buffer import Buffer class _WorkerCtx(NamedTuple): """Shared state passed to the per-task worker coroutines. Bundling these lets the workers declare their dependencies as one parameter instead of capturing them implicitly via closure. """ fetch: Callable[[ByteRequest | None], Awaitable[Buffer | None]] semaphore: asyncio.Semaphore async def _fetch_single( ctx: _WorkerCtx, idx: int, req: ByteRequest | None ) -> Sequence[tuple[int, Buffer | None]]: """Fetch one byte range. Raises FileNotFoundError if the key is absent.""" async with ctx.semaphore: buf = await ctx.fetch(req) if buf is None: raise FileNotFoundError return ((idx, buf),) async def _fetch_group( ctx: _WorkerCtx, members: list[tuple[int, RangeByteRequest]] ) -> Sequence[tuple[int, Buffer | None]]: """Fetch one merged byte range and slice it back into per-input buffers. `members` must already be sorted by `start`; callers in this module build it from the sorted mergeable list. Raises `FileNotFoundError` if the key is absent. """ if len(members) == 1: solo_idx, solo_req = members[0] return await _fetch_single(ctx, solo_idx, solo_req) start = members[0][1].start end = max(r.end for _, r in members) async with ctx.semaphore: big = await ctx.fetch(RangeByteRequest(start, end)) if big is None: raise FileNotFoundError sliced = [(idx, big[r.start - start : r.end - start]) for idx, r in members] return tuple(sliced) def coalesce_ranges( byte_ranges: Sequence[ByteRequest | None], *, max_gap_bytes: int, max_coalesced_bytes: int, ) -> tuple[ list[list[tuple[int, RangeByteRequest]]], list[tuple[int, ByteRequest | None]], ]: """Plan a set of byte-range fetches: which inputs merge, which stand alone. Pure (no I/O). The result is the I/O plan a caller would execute: each group corresponds to one fetch of a coalesced byte range, and each uncoalescable item corresponds to one fetch of the original request. All tuning knobs are required keyword arguments. `Store.get_ranges` is the public entry point and owns the canonical default values; this function takes them explicitly to avoid duplicating policy. Parameters ---------- byte_ranges Input ranges. `None` means "the whole value". max_gap_bytes Two `RangeByteRequest`s separated by at most this many bytes may be merged into one fetch. max_coalesced_bytes Upper bound on the size of a single merged fetch. Returns ------- groups List of merged groups. Each group is a list of `(input_index, RangeByteRequest)` pairs sorted by `start`. A single-element group represents a `RangeByteRequest` that did not merge with any neighbor. uncoalescable List of `(input_index, request)` pairs for inputs that are not `RangeByteRequest` (`OffsetByteRequest`, `SuffixByteRequest`, `None`). Indices are preserved from the input order. Notes ----- Only `RangeByteRequest` inputs participate in coalescing. Two ranges merge when both: their gap (next `start` minus current group's running `end`) is `<= max_gap_bytes`, and the resulting merged span is `<= max_coalesced_bytes`. """ indexed = list(enumerate(byte_ranges)) mergeable = [(i, r) for i, r in indexed if isinstance(r, RangeByteRequest)] uncoalescable: list[tuple[int, ByteRequest | None]] = [ (i, r) for i, r in indexed if not isinstance(r, RangeByteRequest) ] # Sort mergeables by start offset, then merge. Track running start/end of the # current group so each merge step is O(1) instead of O(group size). mergeable.sort(key=lambda pair: pair[1].start) groups: list[list[tuple[int, RangeByteRequest]]] = [] group_start = 0 group_end = 0 for pair in mergeable: _i, r = pair if groups and r.start - group_end <= max_gap_bytes: prospective_end = max(group_end, r.end) if prospective_end - group_start <= max_coalesced_bytes: groups[-1].append(pair) group_end = prospective_end continue groups.append([pair]) group_start = r.start group_end = r.end return groups, uncoalescable async def coalesced_get( fetch: Callable[[ByteRequest | None], Awaitable[Buffer | None]], byte_ranges: Sequence[ByteRequest | None], *, max_concurrency: int, max_gap_bytes: int, max_coalesced_bytes: int, ) -> AsyncGenerator[Sequence[tuple[int, Buffer | None]]]: """Read many byte ranges through `fetch` with coalescing and concurrency. Nearby ranges are merged into a single underlying I/O, and merged fetches are run concurrently. Each yield corresponds to exactly one underlying I/O operation: a sequence of `(input_index, result)` tuples for all input ranges served by that I/O. Tuples within a yielded sequence are ordered by start offset. Yields across groups are in completion order, not input order. All tuning knobs are required keyword arguments. `Store.get_ranges` is the public entry point and owns the canonical default values; this function takes them explicitly to avoid duplicating policy. Parameters ---------- fetch Callable that reads one byte range and returns a `Buffer` (or `None` if the underlying key does not exist). Typically constructed via `functools.partial(store.get, key, prototype)`. byte_ranges Input ranges. `None` means "the whole value". max_concurrency Maximum number of merged fetches in flight at once. max_gap_bytes Forwarded to `coalesce_ranges`. max_coalesced_bytes Forwarded to `coalesce_ranges`. Yields ------ Sequence[tuple[int, Buffer | None]] Per-I/O batch of `(input_index, result)` tuples. Notes ----- - Only `RangeByteRequest` inputs are coalesced. `OffsetByteRequest`, `SuffixByteRequest`, and `None` are each treated as uncoalescable (one fetch, one single-tuple yield per input). - Failures from underlying fetches surface as a `BaseExceptionGroup` (PEP 654). Inner exceptions include `FileNotFoundError` if a fetch returns `None`, plus any exception `fetch` raises. Pending fetches are cancelled as soon as one task fails, so the group typically contains a single non-`CancelledError` exception even under high concurrency. - Groups completed before the failure remain observable on the yields preceding the raise. - `GeneratorExit` raised by `aclose()` is filtered out so the iterator closes cleanly; callers don't see a group containing only it. """ if not byte_ranges: return groups, singles = coalesce_ranges( byte_ranges, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ) ctx = _WorkerCtx(fetch=fetch, semaphore=asyncio.Semaphore(max_concurrency)) # Launch all work as tasks. The semaphore bounds actual I/O concurrency. # TaskGroup wraps task exceptions in BaseExceptionGroup; we propagate the # group unchanged as part of the public contract (callers handle batch # failures via `except*` / PEP 654). GeneratorExit (raised when the # consumer calls aclose()) is filtered out so close completes cleanly. try: async with asyncio.TaskGroup() as tg: tasks = [ *(tg.create_task(_fetch_group(ctx, group)) for group in groups), *(tg.create_task(_fetch_single(ctx, i, single)) for i, single in singles), ] for fut in asyncio.as_completed(tasks): yield await fut except BaseExceptionGroup as eg: # Strip GeneratorExits (consumer aclose()) and propagate whatever remains. _, other_errors = eg.split(GeneratorExit) if other_errors is not None: raise other_errors from None zarr-python-3.3.0/src/zarr/core/_info.py000066400000000000000000000116301523267620000201570ustar00rootroot00000000000000from __future__ import annotations import dataclasses import textwrap from typing import TYPE_CHECKING, Literal if TYPE_CHECKING: from zarr.abc.codec import ArrayArrayCodec, ArrayBytesCodec, BytesBytesCodec from zarr.abc.numcodec import Numcodec from zarr.core.common import ZarrFormat from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType @dataclasses.dataclass(kw_only=True) class GroupInfo: """ Visual summary for a Group. Note that this method and its properties is not part of Zarr's public API. """ _name: str _type: Literal["Group"] = "Group" _zarr_format: ZarrFormat _read_only: bool _store_type: str _count_members: int | None = None _count_arrays: int | None = None _count_groups: int | None = None def __repr__(self) -> str: template = textwrap.dedent("""\ Name : {_name} Type : {_type} Zarr format : {_zarr_format} Read-only : {_read_only} Store type : {_store_type}""") if self._count_members is not None: template += "\nNo. members : {_count_members}" if self._count_arrays is not None: template += "\nNo. arrays : {_count_arrays}" if self._count_groups is not None: template += "\nNo. groups : {_count_groups}" return template.format(**dataclasses.asdict(self)) def human_readable_size(size: int) -> str: if size < 2**10: return f"{size}" elif size < 2**20: return f"{size / float(2**10):.1f}K" elif size < 2**30: return f"{size / float(2**20):.1f}M" elif size < 2**40: return f"{size / float(2**30):.1f}G" elif size < 2**50: return f"{size / float(2**40):.1f}T" else: return f"{size / float(2**50):.1f}P" def byte_info(size: int) -> str: if size < 2**10: return str(size) else: return f"{size} ({human_readable_size(size)})" @dataclasses.dataclass(kw_only=True, frozen=True, slots=True) class ArrayInfo: """ Visual summary for an Array. Note that this method and its properties is not part of Zarr's public API. """ _type: Literal["Array"] = "Array" _zarr_format: ZarrFormat _data_type: ZDType[TBaseDType, TBaseScalar] _fill_value: object _shape: tuple[int, ...] _shard_shape: tuple[int, ...] | None = None _chunk_shape: tuple[int, ...] | None = None _order: Literal["C", "F"] _read_only: bool _store_type: str _filters: tuple[Numcodec, ...] | tuple[ArrayArrayCodec, ...] = () _serializer: ArrayBytesCodec | None = None _compressors: tuple[Numcodec, ...] | tuple[BytesBytesCodec, ...] = () _count_bytes: int | None = None _count_bytes_stored: int | None = None _count_chunks_initialized: int | None = None def __repr__(self) -> str: template = textwrap.dedent("""\ Type : {_type} Zarr format : {_zarr_format} Data type : {_data_type} Fill value : {_fill_value} Shape : {_shape}""") if self._shard_shape is not None: template += textwrap.dedent(""" Shard shape : {_shard_shape}""") template += textwrap.dedent(""" Chunk shape : {_chunk_shape} Order : {_order} Read-only : {_read_only} Store type : {_store_type}""") # We can't use dataclasses.asdict, because we only want a shallow dict kwargs = {field.name: getattr(self, field.name) for field in dataclasses.fields(self)} if self._chunk_shape is None: # for non-regular chunk grids kwargs["_chunk_shape"] = "" template += "\nFilters : {_filters}" if self._serializer is not None: template += "\nSerializer : {_serializer}" template += "\nCompressors : {_compressors}" if self._count_bytes is not None: template += "\nNo. bytes : {_count_bytes}" kwargs["_count_bytes"] = byte_info(self._count_bytes) if self._count_bytes_stored is not None: template += "\nNo. bytes stored : {_count_bytes_stored}" kwargs["_count_bytes_stored"] = byte_info(self._count_bytes_stored) if ( self._count_bytes is not None and self._count_bytes_stored is not None and self._count_bytes_stored > 0 ): template += "\nStorage ratio : {_storage_ratio}" kwargs["_storage_ratio"] = f"{self._count_bytes / self._count_bytes_stored:.1f}" if self._count_chunks_initialized is not None: if self._shard_shape is not None: template += "\nShards Initialized : {_count_chunks_initialized}" else: template += "\nChunks Initialized : {_count_chunks_initialized}" return template.format(**kwargs) zarr-python-3.3.0/src/zarr/core/_json.py000066400000000000000000000105041523267620000201740ustar00rootroot00000000000000"""Helpers for moving JSON documents in and out of zarr stores. These are free functions, deliberately not methods on the ``Store`` ABC: reading and writing JSON is a composition of the store's ``get``/``set`` primitives with a buffer/JSON conversion, not part of the store contract. Keeping them as functions means stores cannot (and need not) override them, and the ``Store`` definition stays free of any dependency on the buffer prototype. These functions are pure: the JSON encoding parameters (``indent``, ``allow_nan``) are explicit arguments rather than read from the global config. Callers that want zarr's configured indentation pass ``indent=config.get("json_indent")``. Two layers: - ``buffer_to_json`` / ``json_to_buffer`` convert between a ``Buffer`` and a parsed JSON value. The buffer prototype lives here, at buffer construction, where it is meaningful. - ``get_json`` / ``set_json`` compose those with ``Store.get`` / ``Store.set``. ``get_json`` returns ``None`` for a missing key (the contract most callers want); callers that require presence check for ``None`` themselves. """ from __future__ import annotations import json from typing import TYPE_CHECKING, cast from zarr.core.buffer import default_buffer_prototype if TYPE_CHECKING: from zarr.abc.store import ByteRequest, Store from zarr.core.buffer import Buffer, BufferPrototype from zarr.core.common import JSON def buffer_to_json(buffer: Buffer) -> JSON: """Parse the contents of a `Buffer` as a JSON value.""" # json.loads is typed as returning Any; the result is by definition JSON. return cast("JSON", json.loads(buffer.to_bytes())) def buffer_to_json_object(buffer: Buffer) -> dict[str, JSON]: """Parse the contents of a `Buffer` as a JSON object (a `dict`). Every metadata document zarr reads is a JSON object, so this narrows the `JSON` union to `dict[str, JSON]` once, here, instead of at each call site. Parameters ---------- buffer The buffer whose contents are parsed as a JSON object. Raises ------ TypeError If the parsed value is not a JSON object. """ obj = buffer_to_json(buffer) if not isinstance(obj, dict): raise TypeError(f"Expected a JSON object, got {type(obj).__name__}.") return obj def json_to_buffer( obj: JSON, *, prototype: BufferPrototype | None = None, indent: int | None = None, allow_nan: bool = True, ) -> Buffer: """Serialize a JSON value into a `Buffer`. Parameters ---------- obj The JSON-serializable value to encode. prototype The buffer prototype to construct the result with. Defaults to `default_buffer_prototype()`. indent Indentation passed to `json.dumps`. `None` (the default) writes without newline indentation, using json's default separators. Callers that want zarr's configured indentation pass `indent=config.get("json_indent")`. allow_nan Whether to permit `NaN`/`Infinity` in the output, passed to `json.dumps`. """ if prototype is None: prototype = default_buffer_prototype() return prototype.buffer.from_bytes(json.dumps(obj, indent=indent, allow_nan=allow_nan).encode()) async def get_json(store: Store, key: str, *, byte_range: ByteRequest | None = None) -> JSON | None: """Read and parse the JSON document at `key`, or `None` if it is absent. Parameters ---------- store The store to read from. key The key identifying the JSON document. byte_range If given, read only this portion of the value. Note that a partial read of a JSON document may not be valid JSON. Returns ------- JSON or None The parsed JSON value, or `None` if `key` does not exist. """ buffer = await store.get(key, default_buffer_prototype(), byte_range) return None if buffer is None else buffer_to_json(buffer) async def set_json( store: Store, key: str, obj: JSON, *, prototype: BufferPrototype | None = None, indent: int | None = None, allow_nan: bool = True, ) -> None: """Serialize `obj` as JSON and write it to `key` in `store`. `indent` and `allow_nan` are forwarded to `json_to_buffer`. """ await store.set( key, json_to_buffer(obj, prototype=prototype, indent=indent, allow_nan=allow_nan) ) zarr-python-3.3.0/src/zarr/core/_tree.py000066400000000000000000000117221523267620000201650ustar00rootroot00000000000000import sys from collections import deque from collections.abc import Sequence from html import escape as html_escape from typing import Any from zarr.core.group import AsyncGroup class TreeRepr: """ A simple object with a tree-like repr for the Zarr Group. Note that this object and it's implementation isn't considered part of Zarr's public API. """ def __init__(self, text: str, html: str, truncated: str = "") -> None: self._text = text self._html = html self._truncated = truncated def __repr__(self) -> str: if self._truncated: return self._truncated + self._text return self._text def _repr_mimebundle_( self, include: Sequence[str] | None = None, exclude: Sequence[str] | None = None, **kwargs: Any, ) -> dict[str, str]: text = self._truncated + self._text if self._truncated else self._text # For jupyter support. html_body = self._truncated + self._html if self._truncated else self._html html = ( '
"
            f"{html_body}
\n" ) return {"text/plain": text, "text/html": html} async def group_tree_async( group: AsyncGroup, max_depth: int | None = None, *, max_nodes: int = 500, plain: bool = False, ) -> TreeRepr: members: list[tuple[str, Any]] = [] truncated = False async for item in group.members(max_depth=max_depth): if len(members) == max_nodes: truncated = True break members.append(item) members.sort(key=lambda key_node: key_node[0]) # Set up styling tokens: ANSI bold for terminals, HTML for Jupyter, # or empty strings when plain=True (useful for LLMs, logging, files). if plain: ansi_open = ansi_close = html_open = html_close = "" else: # Avoid emitting ANSI escape codes when output is piped or in CI. use_ansi = sys.stdout.isatty() ansi_open = "\x1b[1m" if use_ansi else "" ansi_close = "\x1b[0m" if use_ansi else "" html_open = "" html_close = "" # Group members by parent key so we can render the tree level by level. nodes: dict[str, list[tuple[str, Any]]] = {} for key, node in members: if key.count("/") == 0: parent_key = "" else: parent_key = key.rsplit("/", 1)[0] nodes.setdefault(parent_key, []).append((key, node)) # Render the tree iteratively (not recursively) to avoid hitting # Python's recursion limit on deeply nested hierarchies. # Each stack frame is (prefix_string, remaining_children_at_this_level). text_lines = [f"{ansi_open}{group.name}{ansi_close}"] html_lines = [f"{html_open}{html_escape(group.name)}{html_close}"] stack = [("", deque(nodes.get("", [])))] while stack: prefix, remaining = stack[-1] if not remaining: stack.pop() continue key, node = remaining.popleft() name = key.rsplit("/")[-1] escaped_name = html_escape(name) # if we popped the last item then remaining will # now be empty - that's how we got past the if not remaining # above, but this can still be true. is_last = not remaining connector = "└── " if is_last else "├── " if isinstance(node, AsyncGroup): text_lines.append(f"{prefix}{connector}{ansi_open}{name}{ansi_close}") html_lines.append(f"{prefix}{connector}{html_open}{escaped_name}{html_close}") else: text_lines.append( f"{prefix}{connector}{ansi_open}{name}{ansi_close} {node.shape} {node.dtype}" ) html_lines.append( f"{prefix}{connector}{html_open}{escaped_name}{html_close}" f" {html_escape(str(node.shape))} {html_escape(str(node.dtype))}" ) # Descend into children with an accumulated prefix: # Example showing how prefix accumulates: # / # ├── a prefix = "" # │ ├── b prefix = "" + "│ " # │ │ └── x prefix = "" + "│ " + "│ " # │ └── c prefix = "" + "│ " # └── d prefix = "" # └── e prefix = "" + " " if children := nodes.get(key, []): if is_last: child_prefix = prefix + " " else: child_prefix = prefix + "│ " stack.append((child_prefix, deque(children))) text = "\n".join(text_lines) + "\n" html = "\n".join(html_lines) + "\n" note = ( f"Truncated at max_nodes={max_nodes}, some nodes and their children may be missing\n" if truncated else "" ) return TreeRepr(text, html, truncated=note) zarr-python-3.3.0/src/zarr/core/array.py000066400000000000000000006414771523267620000202250ustar00rootroot00000000000000from __future__ import annotations import math import warnings from asyncio import gather from collections.abc import Iterable, Mapping, Sequence from dataclasses import dataclass, field, replace from itertools import starmap from logging import getLogger from typing import ( TYPE_CHECKING, Any, Literal, TypedDict, cast, overload, ) from warnings import warn import numpy as np from typing_extensions import Sentinel, deprecated import zarr from zarr.abc.codec import ArrayArrayCodec, ArrayBytesCodec, BytesBytesCodec, Codec from zarr.abc.numcodec import Numcodec, _is_numcodec from zarr.codecs._v2 import V2Codec from zarr.codecs.bytes import BytesCodec from zarr.codecs.vlen_utf8 import VLenBytesCodec, VLenUTF8Codec from zarr.codecs.zstd import ZstdCodec from zarr.core._info import ArrayInfo from zarr.core._json import buffer_to_json_object from zarr.core.array_spec import ArrayConfig, ArrayConfigLike, ArraySpec, parse_array_config from zarr.core.attributes import Attributes from zarr.core.buffer import ( BufferPrototype, NDArrayLike, NDArrayLikeOrScalar, NDBuffer, default_buffer_prototype, ) from zarr.core.buffer.cpu import buffer_prototype as cpu_buffer_prototype from zarr.core.chunk_grids import ( SHARDED_INNER_CHUNK_MAX_BYTES, ChunkGrid, _is_rectilinear_chunks, as_regular_shape, guess_chunks, normalize_chunks_nd, resolve_outer_and_inner_chunks, ) from zarr.core.chunk_key_encodings import ( ChunkKeyEncoding, ChunkKeyEncodingLike, DefaultChunkKeyEncoding, V2ChunkKeyEncoding, parse_chunk_key_encoding, ) from zarr.core.common import ( JSON, ZARR_JSON, ZARRAY_JSON, ZATTRS_JSON, ChunksLike, DimensionNamesLike, MemoryOrder, ShapeLike, ZarrFormat, _default_zarr_format, _warn_order_kwarg, ceildiv, concurrent_map, parse_shapelike, product, ) from zarr.core.config import config as zarr_config from zarr.core.dtype import ( Structured, VariableLengthBytes, VariableLengthUTF8, ZDType, ZDTypeLike, parse_dtype, ) from zarr.core.dtype.common import HasEndianness, HasItemSize, HasObjectCodec from zarr.core.indexing import ( AsyncOIndex, AsyncVIndex, BasicIndexer, BasicSelection, BlockIndex, BlockIndexer, CoordinateIndexer, CoordinateSelection, Fields, Indexer, MaskIndexer, MaskSelection, OIndex, OrthogonalIndexer, OrthogonalSelection, Selection, VIndex, _iter_grid, _iter_regions, check_fields, check_no_multi_fields, is_pure_fancy_indexing, is_pure_orthogonal_indexing, is_scalar, pop_fields, ) from zarr.core.metadata import ( ArrayMetadata, ArrayMetadataDict, ArrayMetadataJSON_V3, ArrayV2Metadata, ArrayV2MetadataDict, ArrayV3Metadata, ) from zarr.core.metadata.io import save_metadata from zarr.core.metadata.v2 import ( CompressorLikev2, get_object_codec_id, parse_compressor, parse_filters, ) from zarr.core.metadata.v3 import ( ChunkGridMetadata, create_chunk_grid_metadata, parse_node_type_array, ) from zarr.core.sync import sync from zarr.errors import ( ArrayNotFoundError, ChunkNotFoundError, MetadataValidationError, ZarrDeprecationWarning, ZarrUserWarning, ) from zarr.registry import ( _parse_array_array_codec, _parse_array_bytes_codec, _parse_bytes_bytes_codec, get_pipeline_class, ) from zarr.storage._common import StorePath, ensure_no_existing_node, make_store_path from zarr.storage._utils import _relativize_path if TYPE_CHECKING: from collections.abc import Iterator from typing import Self import numpy.typing as npt from zarr.abc.codec import CodecPipeline from zarr.abc.store import Store from zarr.codecs.sharding import IndexLocation from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar from zarr.storage import StoreLike from zarr.types import AnyArray, AnyAsyncArray, ArrayV2, ArrayV3, AsyncArrayV2, AsyncArrayV3 # Array and AsyncArray are defined in the base ``zarr`` namespace __all__ = [ "DEFAULT_FILL_VALUE", "create_codec_pipeline", "parse_array_metadata", ] logger = getLogger(__name__) DEFAULT_FILL_VALUE = Sentinel("DEFAULT_FILL_VALUE") """ Sentinel indicating that the default fill value should be used. This sentinel exists because conventional values used to convey "defaultness" like `None` or `"auto"` are ambiguous when specifying the fill value parameter of a Zarr array. The value `None` is ambiguous because it is a valid fill value for Zarr V2 (resulting in `"fill_value": null` in array metadata). A string like `"auto"` is ambiguous because such a string is a valid fill value for an array with a string data type. This sentinel lies outside the space of valid fill values, which means it can unambiguously express that the default fill value should be used. """ def _chunk_sizes_from_shape( array_shape: tuple[int, ...], chunk_shape: tuple[int, ...] ) -> tuple[tuple[int, ...], ...]: """Compute dask-style chunk sizes from an array shape and uniform chunk shape.""" result: list[tuple[int, ...]] = [] for s, c in zip(array_shape, chunk_shape, strict=True): nchunks = ceildiv(s, c) sizes = tuple(min(c, s - i * c) for i in range(nchunks)) result.append(sizes) return tuple(result) def parse_array_metadata(data: Any) -> ArrayMetadata: if isinstance(data, ArrayMetadata): return data elif isinstance(data, dict): zarr_format = data.get("zarr_format") if zarr_format == 3: meta_out = ArrayV3Metadata.from_dict(data) if len(meta_out.storage_transformers) > 0: msg = ( f"Array metadata contains storage transformers: {meta_out.storage_transformers}." "Arrays with storage transformers are not supported in zarr-python at this time." ) raise ValueError(msg) return meta_out elif zarr_format == 2: return ArrayV2Metadata.from_dict(data) else: raise ValueError(f"Invalid zarr_format: {zarr_format}. Expected 2 or 3") raise TypeError # pragma: no cover def create_codec_pipeline(metadata: ArrayMetadata, *, store: Store | None = None) -> CodecPipeline: if store is not None: try: return get_pipeline_class().from_array_metadata_and_store( array_metadata=metadata, store=store ) except NotImplementedError: pass if isinstance(metadata, ArrayV3Metadata): # The pipeline built here is a throwaway: `evolve_from_array_spec` below # reconstructs codecs against the evolved spec. `from_codecs` is the # chain's first construction, so its advisory warnings (e.g. sharding's # "disables partial reads" warning) fire here; `evolve_from_array_spec` # re-splits the same already-warned-about chain via # `codecs_from_list_unchecked`, so it does not re-emit them. pipeline = get_pipeline_class().from_codecs(metadata.codecs) from zarr.core.metadata.v3 import RegularChunkGridMetadata # Use the regular chunk shape if available, otherwise use a # placeholder. The ChunkTransform is shape-agnostic — the actual # chunk shape is passed per-call at decode/encode time. if isinstance(metadata.chunk_grid, RegularChunkGridMetadata): chunk_shape = metadata.chunk_grid.chunk_shape else: chunk_shape = (1,) * len(metadata.shape) chunk_spec = ArraySpec( shape=chunk_shape, dtype=metadata.data_type, fill_value=metadata.fill_value, config=ArrayConfig.from_dict({}), prototype=default_buffer_prototype(), ) return pipeline.evolve_from_array_spec(chunk_spec) elif isinstance(metadata, ArrayV2Metadata): v2_codec = V2Codec(filters=metadata.filters, compressor=metadata.compressor) pipeline = get_pipeline_class().from_codecs([v2_codec]) chunk_spec = ArraySpec( shape=metadata.chunks, dtype=metadata.dtype, fill_value=metadata.fill_value, config=ArrayConfig.from_dict({"order": metadata.order}), prototype=default_buffer_prototype(), ) return pipeline.evolve_from_array_spec(chunk_spec) raise TypeError # pragma: no cover async def get_array_metadata( store_path: StorePath, zarr_format: ZarrFormat | None = 3 ) -> dict[str, JSON]: if zarr_format == 2: zarray_bytes, zattrs_bytes = await gather( (store_path / ZARRAY_JSON).get(prototype=cpu_buffer_prototype), (store_path / ZATTRS_JSON).get(prototype=cpu_buffer_prototype), ) if zarray_bytes is None: msg = ( "A Zarr V2 array metadata document was not found in store " f"{store_path.store!r} at path {store_path.path!r}." ) raise ArrayNotFoundError(msg) elif zarr_format == 3: zarr_json_bytes = await (store_path / ZARR_JSON).get(prototype=cpu_buffer_prototype) if zarr_json_bytes is None: msg = ( "A Zarr V3 array metadata document was not found in store " f"{store_path.store!r} at path {store_path.path!r}." ) raise ArrayNotFoundError(msg) elif zarr_format is None: zarr_json_bytes, zarray_bytes, zattrs_bytes = await gather( (store_path / ZARR_JSON).get(prototype=cpu_buffer_prototype), (store_path / ZARRAY_JSON).get(prototype=cpu_buffer_prototype), (store_path / ZATTRS_JSON).get(prototype=cpu_buffer_prototype), ) if zarr_json_bytes is not None and zarray_bytes is not None: # warn and favor v3 msg = f"Both zarr.json (Zarr format 3) and .zarray (Zarr format 2) metadata objects exist at {store_path}. Zarr v3 will be used." warnings.warn(msg, category=ZarrUserWarning, stacklevel=1) if zarr_json_bytes is None and zarray_bytes is None: msg = ( f"Neither Zarr V3 nor Zarr V2 array metadata documents " f"were found in store {store_path.store!r} at path {store_path.path!r}." ) raise ArrayNotFoundError(msg) # set zarr_format based on which keys were found if zarr_json_bytes is not None: zarr_format = 3 else: zarr_format = 2 else: msg = f"Invalid value for 'zarr_format'. Expected 2, 3, or None. Got '{zarr_format}'." # type: ignore[unreachable] raise MetadataValidationError(msg) metadata_dict: dict[str, JSON] if zarr_format == 2: # V2 arrays are comprised of a .zarray and .zattrs objects assert zarray_bytes is not None metadata_dict = buffer_to_json_object(zarray_bytes) zattrs_dict = buffer_to_json_object(zattrs_bytes) if zattrs_bytes is not None else {} metadata_dict["attributes"] = zattrs_dict else: # V3 arrays are comprised of a zarr.json object assert zarr_json_bytes is not None metadata_dict = buffer_to_json_object(zarr_json_bytes) parse_node_type_array(metadata_dict.get("node_type")) return metadata_dict async def _prepare_overwrite( store_path: StorePath, *, zarr_format: ZarrFormat, overwrite: bool ) -> None: """ Prepare a store path for writing a new node. If ``overwrite`` is true and the store supports deletes, any existing node at ``store_path`` is deleted. Otherwise, the absence of an existing node is enforced (raising if one is present). """ if overwrite and store_path.store.supports_deletes: await store_path.delete_dir() else: await ensure_no_existing_node(store_path, zarr_format=zarr_format) @dataclass(frozen=True) class AsyncArray[T_ArrayMetadata: (ArrayV2Metadata, ArrayV3Metadata)]: """ An asynchronous array class representing a chunked array stored in a Zarr store. Parameters ---------- metadata : ArrayMetadata The metadata of the array. store_path : StorePath The path to the Zarr store. config : ArrayConfigLike, optional The runtime configuration of the array, by default None. Attributes ---------- metadata : ArrayMetadata The metadata of the array. store_path : StorePath The path to the Zarr store. codec_pipeline : CodecPipeline The codec pipeline used for encoding and decoding chunks. config : ArrayConfig The runtime configuration of the array. """ metadata: T_ArrayMetadata store_path: StorePath codec_pipeline: CodecPipeline = field(init=False) _chunk_grid: ChunkGrid = field(init=False) config: ArrayConfig @overload def __init__( self: AsyncArrayV2, metadata: ArrayV2Metadata | ArrayV2MetadataDict, store_path: StorePath, config: ArrayConfigLike | None = None, ) -> None: ... @overload def __init__( self: AsyncArrayV3, metadata: ArrayV3Metadata | ArrayMetadataJSON_V3, store_path: StorePath, config: ArrayConfigLike | None = None, ) -> None: ... def __init__( self, metadata: ArrayMetadata | ArrayMetadataDict, store_path: StorePath, config: ArrayConfigLike | None = None, ) -> None: metadata_parsed = parse_array_metadata(metadata) config_parsed = parse_array_config(config) object.__setattr__(self, "metadata", metadata_parsed) object.__setattr__(self, "store_path", store_path) object.__setattr__(self, "config", config_parsed) object.__setattr__(self, "_chunk_grid", ChunkGrid.from_metadata(metadata_parsed)) object.__setattr__( self, "codec_pipeline", create_codec_pipeline(metadata=metadata_parsed, store=store_path.store), ) @classmethod async def _create( cls, store: StoreLike, *, # v2 and v3 shape: ShapeLike, dtype: ZDTypeLike | ZDType[TBaseDType, TBaseScalar], zarr_format: ZarrFormat = 3, fill_value: Any | None = DEFAULT_FILL_VALUE, attributes: dict[str, JSON] | None = None, # v3 only chunk_shape: ShapeLike | None = None, chunk_key_encoding: ( ChunkKeyEncodingLike | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None ) = None, codecs: Iterable[Codec | dict[str, JSON]] | None = None, dimension_names: DimensionNamesLike = None, # v2 only chunks: ShapeLike | None = None, dimension_separator: Literal[".", "/"] | None = None, order: MemoryOrder | None = None, filters: Iterable[dict[str, JSON] | Numcodec] | None = None, compressor: CompressorLike = "auto", # runtime overwrite: bool = False, data: npt.ArrayLike | None = None, config: ArrayConfigLike | None = None, ) -> AnyAsyncArray: """Method to create a new asynchronous array instance. Deprecated in favor of [`zarr.api.asynchronous.create_array`][]. """ dtype_parsed = parse_dtype(dtype, zarr_format=zarr_format) store_path = await make_store_path(store) shape = parse_shapelike(shape) if chunks is not None and chunk_shape is not None: raise ValueError("Only one of chunk_shape or chunks can be provided.") # Unify the v2 (chunks) and v3 (chunk_shape) parameter names _raw_chunks = chunks if chunks is not None else chunk_shape config_parsed = parse_array_config(config) result: AnyAsyncArray if zarr_format == 3: if dimension_separator is not None: raise ValueError( "dimension_separator cannot be used for arrays with zarr_format 3. Use chunk_key_encoding instead." ) if filters is not None: raise ValueError( "filters cannot be used for arrays with zarr_format 3. Use array-to-array codecs instead." ) if compressor != "auto": raise ValueError( "compressor cannot be used for arrays with zarr_format 3. Use bytes-to-bytes codecs instead." ) if order is not None: _warn_order_kwarg() item_size = 1 if isinstance(dtype_parsed, HasItemSize): item_size = dtype_parsed.item_size if _raw_chunks is None: outer_chunks = guess_chunks(shape, item_size) else: outer_chunks = normalize_chunks_nd(_raw_chunks, shape) chunk_grid = create_chunk_grid_metadata(outer_chunks) result = await cls._create_v3( store_path, shape=shape, dtype=dtype_parsed, fill_value=fill_value, chunk_key_encoding=chunk_key_encoding, codecs=codecs, dimension_names=dimension_names, attributes=attributes, overwrite=overwrite, config=config_parsed, chunk_grid=chunk_grid, ) elif zarr_format == 2: if codecs is not None: raise ValueError( "codecs cannot be used for arrays with zarr_format 2. Use filters and compressor instead." ) if chunk_key_encoding is not None: raise ValueError( "chunk_key_encoding cannot be used for arrays with zarr_format 2. Use dimension_separator instead." ) if dimension_names is not None: raise ValueError("dimension_names cannot be used for arrays with zarr_format 2.") if _is_rectilinear_chunks(_raw_chunks): raise ValueError("Zarr format 2 does not support rectilinear chunk grids.") item_size = 1 if isinstance(dtype_parsed, HasItemSize): item_size = dtype_parsed.item_size _raw = chunks or chunk_shape if _raw is None: outer_chunks = guess_chunks(shape, item_size) else: outer_chunks = normalize_chunks_nd(_raw, shape) _chunks = as_regular_shape(outer_chunks) if order is None: order_parsed = config_parsed.order else: order_parsed = order config_parsed = replace(config_parsed, order=order) result = await cls._create_v2( store_path, shape=shape, dtype=dtype_parsed, chunks=_chunks, dimension_separator=dimension_separator, fill_value=fill_value, order=order_parsed, config=config_parsed, filters=filters, compressor=compressor, attributes=attributes, overwrite=overwrite, ) else: raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover if data is not None: # insert user-provided data await result.setitem(..., data) return result @staticmethod def _create_metadata_v3( shape: ShapeLike, dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, fill_value: Any | None = DEFAULT_FILL_VALUE, chunk_key_encoding: ChunkKeyEncodingLike | None = None, codecs: Iterable[Codec | dict[str, JSON]] | None = None, dimension_names: DimensionNamesLike = None, attributes: dict[str, JSON] | None = None, ) -> ArrayV3Metadata: """Create an instance of ArrayV3Metadata.""" filters: tuple[ArrayArrayCodec, ...] compressors: tuple[BytesBytesCodec, ...] shape = parse_shapelike(shape) if codecs is None: # no data types have default filters filters = () serializer = default_serializer_v3(dtype) compressors = default_compressors_v3(dtype) codecs_parsed = (*filters, serializer, *compressors) else: codecs_parsed = tuple(codecs) chunk_key_encoding_parsed: ChunkKeyEncodingLike if chunk_key_encoding is None: chunk_key_encoding_parsed = {"name": "default", "separator": "/"} else: chunk_key_encoding_parsed = chunk_key_encoding if fill_value is DEFAULT_FILL_VALUE or fill_value is None: # Use dtype's default scalar for the DEFAULT_FILL_VALUE sentinel # For v3, None is converted to DEFAULT_FILL_VALUE behavior fill_value_parsed = dtype.default_scalar() else: fill_value_parsed = fill_value return ArrayV3Metadata( shape=shape, data_type=dtype, chunk_grid=chunk_grid, chunk_key_encoding=chunk_key_encoding_parsed, fill_value=fill_value_parsed, codecs=codecs_parsed, # type: ignore[arg-type] dimension_names=tuple(dimension_names) if dimension_names else None, attributes=attributes or {}, ) @classmethod async def _create_v3( cls, store_path: StorePath, *, shape: ShapeLike, dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, config: ArrayConfig, fill_value: Any | None = DEFAULT_FILL_VALUE, chunk_key_encoding: ( ChunkKeyEncodingLike | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None ) = None, codecs: Iterable[Codec | dict[str, JSON]] | None = None, dimension_names: DimensionNamesLike = None, attributes: dict[str, JSON] | None = None, overwrite: bool = False, ) -> AsyncArrayV3: await _prepare_overwrite(store_path, zarr_format=3, overwrite=overwrite) if isinstance(chunk_key_encoding, tuple): chunk_key_encoding = ( V2ChunkKeyEncoding(separator=chunk_key_encoding[1]) if chunk_key_encoding[0] == "v2" else DefaultChunkKeyEncoding(separator=chunk_key_encoding[1]) ) metadata = cls._create_metadata_v3( shape=shape, dtype=dtype, chunk_grid=chunk_grid, fill_value=fill_value, chunk_key_encoding=chunk_key_encoding, codecs=codecs, dimension_names=dimension_names, attributes=attributes, ) array = cls(metadata=metadata, store_path=store_path, config=config) await array._save_metadata(metadata, ensure_parents=True) return array @staticmethod def _create_metadata_v2( shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunks: tuple[int, ...], order: MemoryOrder, dimension_separator: Literal[".", "/"] | None = None, fill_value: Any | None = DEFAULT_FILL_VALUE, filters: Iterable[dict[str, JSON] | Numcodec] | None = None, compressor: CompressorLikev2 = None, attributes: dict[str, JSON] | None = None, ) -> ArrayV2Metadata: if dimension_separator is None: dimension_separator = "." # Handle the DEFAULT_FILL_VALUE sentinel if fill_value is DEFAULT_FILL_VALUE: fill_value_parsed: Any = dtype.default_scalar() else: # For v2, preserve None as-is (backward compatibility) fill_value_parsed = fill_value return ArrayV2Metadata( shape=shape, dtype=dtype, chunks=chunks, order=order, dimension_separator=dimension_separator, fill_value=fill_value_parsed, compressor=compressor, filters=filters, attributes=attributes, ) @classmethod async def _create_v2( cls, store_path: StorePath, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunks: tuple[int, ...], order: MemoryOrder, config: ArrayConfig, dimension_separator: Literal[".", "/"] | None = None, fill_value: Any | None = DEFAULT_FILL_VALUE, filters: Iterable[dict[str, JSON] | Numcodec] | None = None, compressor: CompressorLike = "auto", attributes: dict[str, JSON] | None = None, overwrite: bool = False, ) -> AsyncArrayV2: await _prepare_overwrite(store_path, zarr_format=2, overwrite=overwrite) compressor_parsed: CompressorLikev2 if compressor == "auto": compressor_parsed = default_compressor_v2(dtype) elif isinstance(compressor, BytesBytesCodec): raise ValueError( "Cannot use a BytesBytesCodec as a compressor for zarr v2 arrays. " "Use a numcodecs codec directly instead." ) else: compressor_parsed = compressor if filters is None: filters = default_filters_v2(dtype) metadata = cls._create_metadata_v2( shape=shape, dtype=dtype, chunks=chunks, order=order, dimension_separator=dimension_separator, fill_value=fill_value, filters=filters, compressor=compressor_parsed, attributes=attributes, ) array = cls(metadata=metadata, store_path=store_path, config=config) await array._save_metadata(metadata, ensure_parents=True) return array @classmethod def from_dict( cls, store_path: StorePath, data: dict[str, JSON], ) -> AnyAsyncArray: """ Create a Zarr array from a dictionary, with support for both Zarr format 2 and 3 metadata. Parameters ---------- store_path : StorePath The path within the store where the array should be created. data : dict A dictionary representing the array data. This dictionary should include necessary metadata for the array, such as shape, dtype, and other attributes. The format of the metadata will determine whether a Zarr format 2 or 3 array is created. Returns ------- AsyncArrayV3 or AsyncArrayV2 The created Zarr array, either using Zarr format 2 or 3 metadata based on the provided data. Raises ------ ValueError If the dictionary data is invalid or incompatible with either Zarr format 2 or 3 array creation. """ metadata = parse_array_metadata(data) return cls(metadata=metadata, store_path=store_path) @classmethod async def open( cls, store: StoreLike, zarr_format: ZarrFormat | None = 3, ) -> AnyAsyncArray: """ Async method to open an existing Zarr array from a given store. Parameters ---------- store : StoreLike The store containing the Zarr array. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. zarr_format : ZarrFormat | None, optional The Zarr format version (default is 3). Returns ------- AsyncArray The opened Zarr array. Examples -------- ```python import asyncio import zarr from zarr.core.array import AsyncArray async def example(): store = zarr.storage.MemoryStore() # First create an array to open await zarr.api.asynchronous.create_array( store=store, shape=(100, 100), dtype="int32" ) # Now open it async_arr = await AsyncArray.open(store) return async_arr async_arr = asyncio.run(example()) # ``` """ store_path = await make_store_path(store) metadata_dict = await get_array_metadata(store_path, zarr_format=zarr_format) # TODO: remove this cast when we have better type hints _metadata_dict = cast("ArrayMetadataJSON_V3", metadata_dict) return cls(store_path=store_path, metadata=_metadata_dict) @property def store(self) -> Store: return self.store_path.store @property @deprecated("Use AsyncArray.config instead.", category=ZarrDeprecationWarning) def _config(self) -> ArrayConfig: return self.config @property def ndim(self) -> int: """Returns the number of dimensions in the Array. Returns ------- int The number of dimensions in the Array. """ return len(self.metadata.shape) @property def shape(self) -> tuple[int, ...]: """Returns the shape of the Array. Returns ------- tuple The shape of the Array. """ return self.metadata.shape @property def chunks(self) -> tuple[int, ...]: """Returns the chunk shape of the Array. If sharding is used the inner chunk shape is returned. Only defined for arrays using a regular chunk grid. If array uses a rectilinear chunk grid, `NotImplementedError` is raised. Returns ------- tuple[int, ...]: The chunk shape of the Array. """ # TODO: move sharding awareness out of metadata return self.metadata.chunks @property def read_chunk_sizes(self) -> tuple[tuple[int, ...], ...]: """Per-dimension data sizes of chunks used for reading, clipped to the array extent. Boundary chunks that extend past the array shape are clipped, so the last size along a dimension may be smaller than the declared chunk size. This matches the dask ``Array.chunks`` convention. When sharding is used, returns the inner chunk sizes. Otherwise, returns the outer chunk sizes (same as ``write_chunk_sizes``). Returns ------- tuple[tuple[int, ...], ...] One inner tuple per dimension containing the data size of each chunk (not the encoded buffer size). Examples -------- >>> arr = zarr.create_array({}, dtype="i1", shape=(100, 80), chunks=(30, 40)) >>> arr.read_chunk_sizes ((30, 30, 30, 10), (40, 40)) """ from zarr.codecs.sharding import ShardingCodec codecs: tuple[Codec, ...] = getattr(self.metadata, "codecs", ()) if len(codecs) == 1 and isinstance(codecs[0], ShardingCodec): inner_chunk_shape = codecs[0].chunk_shape return _chunk_sizes_from_shape(self.shape, inner_chunk_shape) return self._chunk_grid.chunk_sizes @property def write_chunk_sizes(self) -> tuple[tuple[int, ...], ...]: """Per-dimension data sizes of storage chunks, clipped to the array extent. Always returns the outer chunk sizes, regardless of sharding. Boundary chunks that extend past the array shape are clipped, so the last size along a dimension may be smaller than the declared chunk size. This matches the dask ``Array.chunks`` convention. Returns ------- tuple[tuple[int, ...], ...] One inner tuple per dimension containing the data size of each chunk (not the encoded buffer size). Examples -------- >>> import zarr.storage >>> arr = zarr.create_array({}, dtype="i1", shape=(100, 80), chunks=(30, 40)) >>> arr.write_chunk_sizes ((30, 30, 30, 10), (40, 40)) """ return self._chunk_grid.chunk_sizes @property def shards(self) -> tuple[int, ...] | None: """Returns the shard shape of the Array. Returns None if sharding is not used. Only defined for arrays using a regular chunk grid. If array uses a rectilinear chunk grid, `NotImplementedError` is raised. Returns ------- tuple[int, ...]: The shard shape of the Array. """ return self.metadata.shards @property def size(self) -> int: """Returns the total number of elements in the array Returns ------- int Total number of elements in the array """ return math.prod(self.metadata.shape) @property def filters(self) -> tuple[Numcodec, ...] | tuple[ArrayArrayCodec, ...]: """ Filters that are applied to each chunk of the array, in order, before serializing that chunk to bytes. """ if self.metadata.zarr_format == 2: filters = self.metadata.filters if filters is None: return () return filters return tuple( codec for codec in self.metadata.inner_codecs if isinstance(codec, ArrayArrayCodec) ) @property def serializer(self) -> ArrayBytesCodec | None: """ Array-to-bytes codec to use for serializing the chunks into bytes. """ if self.metadata.zarr_format == 2: return None return next( codec for codec in self.metadata.inner_codecs if isinstance(codec, ArrayBytesCodec) ) @property @deprecated("Use AsyncArray.compressors instead.", category=ZarrDeprecationWarning) def compressor(self) -> Numcodec | None: """ Compressor that is applied to each chunk of the array. !!! warning "Deprecated" `Array.compressor` is deprecated since v3.0.0 and will be removed in a future release. Use [`Array.compressors`][zarr.AsyncArray.compressors] instead. """ if self.metadata.zarr_format == 2: return self.metadata.compressor raise TypeError("`compressor` is not available for Zarr format 3 arrays.") @property def compressors(self) -> tuple[Numcodec, ...] | tuple[BytesBytesCodec, ...]: """ Compressors that are applied to each chunk of the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. """ if self.metadata.zarr_format == 2: if self.metadata.compressor is not None: return (self.metadata.compressor,) return () return tuple( codec for codec in self.metadata.inner_codecs if isinstance(codec, BytesBytesCodec) ) @property def _zdtype(self) -> ZDType[TBaseDType, TBaseScalar]: """ The zarr-specific representation of the array data type """ # `dtype` returns the zarr dtype object for both v2 and v3 metadata # (on v3 it is an alias for `data_type`). return self.metadata.dtype @property def dtype(self) -> TBaseDType: """Returns the data type of the array. Returns ------- np.dtype Data type of the array """ return self._zdtype.to_native_dtype() @property def order(self) -> MemoryOrder: """Returns the memory order of the array. Returns ------- bool Memory order of the array """ if self.metadata.zarr_format == 2: return self.metadata.order else: return self.config.order @property def attrs(self) -> dict[str, JSON]: """Returns the attributes of the array. Returns ------- dict Attributes of the array """ return self.metadata.attributes @property def read_only(self) -> bool: """Returns True if the array is read-only. Returns ------- bool True if the array is read-only """ # Backwards compatibility for 2.x return self.store_path.read_only @property def path(self) -> str: """Storage path. Returns ------- str The path to the array in the Zarr store. """ return self.store_path.path @property def name(self) -> str: """Array name following h5py convention. Returns ------- str The name of the array. """ # follow h5py convention: add leading slash name = self.path if not name.startswith("/"): name = "/" + name return name @property def basename(self) -> str: """Final component of name. Returns ------- str The basename or final component of the array name. """ return self.name.split("/")[-1] @property def cdata_shape(self) -> tuple[int, ...]: """ The number of chunks along each dimension. When sharding is used, this counts inner chunks (not shards) per dimension. Returns ------- tuple[int, ...] The number of chunks along each dimension. """ return self._chunk_grid_shape @property def _chunk_grid_shape(self) -> tuple[int, ...]: """ The number of chunks along each dimension. When sharding is used, this counts inner chunks (not shards) per dimension. Returns ------- tuple[int, ...] The number of chunks along each dimension. """ # TODO: refactor — extract a sharding_codec property on ArrayV3Metadata # to replace the repeated `len == 1 and isinstance` pattern. from zarr.codecs.sharding import ShardingCodec codecs: tuple[Codec, ...] = getattr(self.metadata, "codecs", ()) if len(codecs) == 1 and isinstance(codecs[0], ShardingCodec): # When sharding, count inner chunks across the whole array chunk_shape = codecs[0].chunk_shape return tuple(starmap(ceildiv, zip(self.shape, chunk_shape, strict=True))) return self._chunk_grid.grid_shape @property def _shard_grid_shape(self) -> tuple[int, ...]: """ The shape of the shard grid for this array. When no shards are present this will automatically fall back to the chunk grid. Returns ------- tuple[int, ...] The shape of the shard grid for this array. """ if self.shards is None: shard_shape = self.chunks else: shard_shape = self.shards return tuple(starmap(ceildiv, zip(self.shape, shard_shape, strict=True))) @property def nchunks(self) -> int: """ The number of chunks in this array. Note that if a sharding codec is used, then the number of chunks may exceed the number of stored objects supporting this array. Returns ------- int The total number of chunks in the array. """ return product(self._chunk_grid_shape) @property def _nshards(self) -> int: """ The number of shards in this array. If no shards are present this will fall back to giving the number of chunks Returns ------- int The total number of shards or if absent, chunks in the array. """ return product(self._shard_grid_shape) @overload def with_config(self: AsyncArrayV2, config: ArrayConfigLike) -> AsyncArrayV2: ... @overload def with_config(self: AsyncArrayV3, config: ArrayConfigLike) -> AsyncArrayV3: ... def with_config(self, config: ArrayConfigLike) -> Self: """ Return a copy of this Array with a new runtime configuration. Parameters ---------- config : ArrayConfigLike The runtime config for the new Array. Any keys not specified will be inherited from the current array's config. Returns ------- A new Array """ if isinstance(config, ArrayConfig): new_config = config else: # Merge new config with existing config, so missing keys are inherited # from the current array rather than from global defaults new_config = ArrayConfig(**{**self.config.to_dict(), **config}) # type: ignore[arg-type] return type(self)(metadata=self.metadata, store_path=self.store_path, config=new_config) async def nchunks_initialized(self) -> int: """ Calculate the number of chunks that have been initialized in storage. This value is calculated as the product of the number of initialized shards and the number of chunks per shard. For arrays that do not use sharding, the number of chunks per shard is effectively 1, and in that case the number of chunks initialized is the same as the number of stored objects associated with an array. Returns ------- nchunks_initialized : int The number of chunks that have been initialized. Notes ----- On [`AsyncArray`][zarr.AsyncArray] this is an asynchronous method, unlike the (synchronous) property [`Array.nchunks_initialized`][zarr.Array.nchunks_initialized]. Examples -------- ```python import asyncio import zarr.api.asynchronous async def example(): arr = await zarr.api.asynchronous.create(shape=(10,), chunks=(1,)) count = await arr.nchunks_initialized() print(f"Initial: {count}") #> Initial: 0 await arr.setitem(slice(5), 1) count = await arr.nchunks_initialized() print(f"After write: {count}") #> After write: 5 return count result = asyncio.run(example()) ``` """ return await _nchunks_initialized(self) async def _nshards_initialized(self) -> int: """ Calculate the number of shards that have been initialized in storage. This is the number of shards that have been persisted to the storage backend. Returns ------- nshards_initialized : int The number of shards that have been initialized. Notes ----- On [`AsyncArray`][zarr.AsyncArray] this is an asynchronous method, unlike the (synchronous) property [`Array._nshards_initialized`][zarr.Array._nshards_initialized]. Examples -------- ```python import asyncio import zarr.api.asynchronous async def example(): arr = await zarr.api.asynchronous.create(shape=(10,), chunks=(2,)) count = await arr._nshards_initialized() print(f"Initial: {count}") #> Initial: 0 await arr.setitem(slice(5), 1) count = await arr._nshards_initialized() print(f"After write: {count}") #> After write: 3 return count result = asyncio.run(example()) ``` """ return await _nshards_initialized(self) async def nbytes_stored(self) -> int: return await _nbytes_stored(self.store_path) def _iter_chunk_coords( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[int, ...]]: """ Create an iterator over the coordinates of chunks in chunk grid space. If the `origin` keyword is used, iteration will start at the chunk index specified by `origin`. The default behavior is to start at the origin of the grid coordinate space. If the `selection_shape` keyword is used, iteration will be bounded over a contiguous region ranging from `[origin, origin selection_shape]`, where the upper bound is exclusive as per python indexing conventions. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's chunk grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in chunk grid coordinates. Yields ------ chunk_coords: tuple[int, ...] The coordinates of each chunk in the selection. """ return _iter_chunk_coords( array=self, origin=origin, selection_shape=selection_shape, ) def _iter_shard_coords( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[int, ...]]: """ Create an iterator over the coordinates of shards in shard grid space. This will fall back to chunk grid space in case no shards are present. Note that If the `origin` keyword is used, iteration will start at the shard index specified by `origin`. The default behavior is to start at the origin of the grid coordinate space. If the `selection_shape` keyword is used, iteration will be bounded over a contiguous region ranging from `[origin, origin selection_shape]`, where the upper bound is exclusive as per python indexing conventions. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's shard grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in shard grid coordinates. Yields ------ chunk_coords: tuple[int, ...] The coordinates of each shard in the selection or chunk in case of no shard being present. """ return _iter_shard_coords( array=self, origin=origin, selection_shape=selection_shape, ) def _iter_shard_keys( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[str]: """ Iterate over the keys of the stored objects supporting this array. Although only stored objects, e.g. shards should have keys, in case no shards are present this automatically falls back to chunks. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's chunk grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in shard grid coordinates. Yields ------ key: str The storage key of each shard in the selection or in case of no shard present of each chunk although the latter case is technically incorrect. """ # Iterate over the coordinates of chunks in chunk grid space. return _iter_shard_keys( array=self, origin=origin, selection_shape=selection_shape, ) def _iter_chunk_regions( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[slice, ...]]: """ Iterate over the regions spanned by each chunk. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's chunk grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in chunk grid coordinates. Yields ------ region: tuple[slice, ...] A tuple of slice objects representing the region spanned by each chunk in the selection. """ return _iter_chunk_regions( array=self, origin=origin, selection_shape=selection_shape, ) def _iter_shard_regions( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[slice, ...]]: """ Iterate over the regions spanned by each shard. This will automatically fall back to chunks if no shards are present. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's shard grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in shard grid coordinates. Yields ------ region: tuple[slice, ...] A tuple of slice objects representing the region spanned by each shard in the selection or chunk in the absence of shards. """ return _iter_shard_regions(array=self, origin=origin, selection_shape=selection_shape) @property def nbytes(self) -> int: """ The total number of bytes that can be stored in the chunks of this array. Notes ----- This value is calculated by multiplying the number of elements in the array and the size of each element, the latter of which is determined by the dtype of the array. For this reason, ``nbytes`` will likely be inaccurate for arrays with variable-length dtypes. It is not possible to determine the size of an array with variable-length elements from the shape and dtype alone. """ return self.size * self.dtype.itemsize async def _get_selection( self, indexer: Indexer, *, prototype: BufferPrototype, out: NDBuffer | None = None, fields: Fields | None = None, ) -> NDArrayLikeOrScalar: return await _get_selection( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, indexer, prototype=prototype, out=out, fields=fields, ) async def getitem( self, selection: BasicSelection, *, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: """ Asynchronous function that retrieves a subset of the array's data based on the provided selection. Parameters ---------- selection : BasicSelection A selection object specifying the subset of data to retrieve. prototype : BufferPrototype, optional A buffer prototype to use for the retrieved data (default is None). Returns ------- NDArrayLikeOrScalar The retrieved subset of the array's data. Examples -------- >>> async def example(): ... import zarr.api.asynchronous ... import zarr.storage ... ... async_arr = await zarr.api.asynchronous.create_array( ... store={}, ... shape=(100,100), ... chunks=(10,10), ... dtype="i4", ... fill_value=0, ... ) ... ... return await async_arr.getitem((0, 1)) >>> import asyncio >>> asyncio.run(example()) np.int32(0) """ return await _getitem( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, selection, prototype=prototype, ) async def get_orthogonal_selection( self, selection: OrthogonalSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: if prototype is None: prototype = default_buffer_prototype() indexer = OrthogonalIndexer(selection, self.metadata.shape, self._chunk_grid) return await _get_selection( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, indexer=indexer, out=out, fields=fields, prototype=prototype, ) async def get_mask_selection( self, mask: MaskSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: if prototype is None: prototype = default_buffer_prototype() indexer = MaskIndexer(mask, self.metadata.shape, self._chunk_grid) return await _get_selection( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, indexer=indexer, out=out, fields=fields, prototype=prototype, ) async def get_coordinate_selection( self, selection: CoordinateSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: if prototype is None: prototype = default_buffer_prototype() indexer = CoordinateIndexer(selection, self.metadata.shape, self._chunk_grid) out_array = await _get_selection( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, indexer=indexer, out=out, fields=fields, prototype=prototype, ) if hasattr(out_array, "shape"): # restore shape out_array = cast("NDArrayLikeOrScalar", np.array(out_array).reshape(indexer.sel_shape)) return out_array async def _save_metadata(self, metadata: ArrayMetadata, ensure_parents: bool = False) -> None: """ Asynchronously save the array metadata. """ await save_metadata(self.store_path, metadata, ensure_parents=ensure_parents) async def _set_selection( self, indexer: Indexer, value: npt.ArrayLike, *, prototype: BufferPrototype, fields: Fields | None = None, ) -> None: return await _set_selection( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, indexer, value, prototype=prototype, fields=fields, ) async def setitem( self, selection: BasicSelection, value: npt.ArrayLike, prototype: BufferPrototype | None = None, ) -> None: """ Asynchronously set values in the array using basic indexing. Parameters ---------- selection : BasicSelection The selection defining the region of the array to set. value : numpy.typing.ArrayLike The values to be written into the selected region of the array. prototype : BufferPrototype or None, optional A prototype buffer that defines the structure and properties of the array chunks being modified. If None, the default buffer prototype is used. Default is None. Returns ------- None This method does not return any value. Raises ------ IndexError If the selection is out of bounds for the array. ValueError If the values are not compatible with the array's dtype or shape. Notes ----- - This method is asynchronous and should be awaited. - Supports basic indexing, where the selection is contiguous and does not involve advanced indexing. """ return await _setitem( self.store_path, self.metadata, self.codec_pipeline, self.config, self._chunk_grid, selection, value, prototype=prototype, ) @property def oindex(self) -> AsyncOIndex[T_ArrayMetadata]: """Shortcut for orthogonal (outer) indexing, see [get_orthogonal_selection][zarr.Array.get_orthogonal_selection] and [set_orthogonal_selection][zarr.Array.set_orthogonal_selection] for documentation and examples.""" return AsyncOIndex(self) @property def vindex(self) -> AsyncVIndex[T_ArrayMetadata]: """Shortcut for vectorized (inner) indexing, see [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_mask_selection][zarr.Array.get_mask_selection] and [set_mask_selection][zarr.Array.set_mask_selection] for documentation and examples.""" return AsyncVIndex(self) async def resize(self, new_shape: ShapeLike, delete_outside_chunks: bool = True) -> None: """ Asynchronously resize the array to a new shape. Parameters ---------- new_shape : tuple[int, ...] The desired new shape of the array. delete_outside_chunks : bool, optional If True (default), chunks that fall outside the new shape will be deleted. If False, the data in those chunks will be preserved. Returns ------- AsyncArray The resized array. Raises ------ ValueError If the new shape is incompatible with the current array's chunking configuration. Notes ----- - This method is asynchronous and should be awaited. """ return await _resize(self, new_shape, delete_outside_chunks) async def append(self, data: npt.ArrayLike, axis: int = 0) -> tuple[int, ...]: """Append `data` to `axis`. Parameters ---------- data : array-like Data to be appended. axis : int Axis along which to append. Returns ------- new_shape : tuple Notes ----- The size of all dimensions other than `axis` must match between this array and `data`. """ return await _append(self, data, axis) async def update_attributes(self, new_attributes: dict[str, JSON]) -> Self: """ Asynchronously update the array's attributes. Parameters ---------- new_attributes : dict of str to JSON A dictionary of new attributes to update or add to the array. The keys represent attribute names, and the values must be JSON-compatible. Returns ------- AsyncArray The array with the updated attributes. Raises ------ ValueError If the attributes are invalid or incompatible with the array's metadata. Notes ----- - This method is asynchronous and should be awaited. - The updated attributes will be merged with existing attributes, and any conflicts will be overwritten by the new values. """ await _update_attributes(self, new_attributes) return self def __repr__(self) -> str: return f"" @property def info(self) -> Any: """ Return the statically known information for an array. Returns ------- ArrayInfo Related ------- [zarr.AsyncArray.info_complete][] - All information about a group, including dynamic information like the number of bytes and chunks written. Examples -------- >>> import asyncio >>> arr = asyncio.run( ... zarr.api.asynchronous.create( ... path="array", shape=(3, 4, 5), chunks=(2, 2, 2) ... ) ... ) >>> arr.info Type : Array Zarr format : 3 Data type : Float64(endianness='little') Fill value : 0.0 Shape : (3, 4, 5) Chunk shape : (2, 2, 2) Order : C Read-only : False Store type : MemoryStore Filters : () Serializer : BytesCodec(endian='little') Compressors : (ZstdCodec(level=0, checksum=False),) No. bytes : 480 """ return self._info() async def info_complete(self) -> Any: """ Return all the information for an array, including dynamic information like a storage size. In addition to the static information, this provides - The count of chunks initialized - The sum of the bytes written Returns ------- ArrayInfo Related ------- [zarr.AsyncArray.info][] - A property giving just the statically known information about an array. """ return await _info_complete(self) def _info( self, count_chunks_initialized: int | None = None, count_bytes_stored: int | None = None ) -> Any: chunk_shape = self.chunks if self._chunk_grid.is_regular else None return ArrayInfo( _zarr_format=self.metadata.zarr_format, _data_type=self._zdtype, _fill_value=self.metadata.fill_value, _shape=self.shape, _order=self.order, _shard_shape=self.shards, _chunk_shape=chunk_shape, _read_only=self.read_only, _compressors=self.compressors, _filters=self.filters, _serializer=self.serializer, _store_type=type(self.store_path.store).__name__, _count_bytes=self.nbytes, _count_bytes_stored=count_bytes_stored, _count_chunks_initialized=count_chunks_initialized, ) # TODO: Array can be a frozen data class again once property setters (e.g. shape) are removed @dataclass(frozen=False) class Array[T_ArrayMetadata: (ArrayV2Metadata, ArrayV3Metadata)]: """ A Zarr array. """ _async_array: AsyncArray[T_ArrayMetadata] @property def async_array(self) -> AsyncArray[T_ArrayMetadata]: """An asynchronous version of the current array. Useful for batching requests. Returns ------- An asynchronous array whose metadata + store matches that of this synchronous array. """ return self._async_array @property def config(self) -> ArrayConfig: """ The runtime configuration for this array. This is a read-only property. To modify the runtime configuration, use `Array.with_config` to create a new `Array` with the modified configuration. Returns ------- An `ArrayConfig` object that defines the runtime configuration for the array. """ return self.async_array.config @property def _chunk_grid(self) -> ChunkGrid: """The chunk grid for this array, bound to the array's shape.""" return self.async_array._chunk_grid @classmethod def _create( cls, store: StoreLike, *, # v2 and v3 shape: tuple[int, ...], dtype: ZDTypeLike, zarr_format: ZarrFormat = 3, fill_value: Any | None = DEFAULT_FILL_VALUE, attributes: dict[str, JSON] | None = None, # v3 only chunk_shape: tuple[int, ...] | None = None, chunk_key_encoding: ( ChunkKeyEncoding | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None ) = None, codecs: Iterable[Codec | dict[str, JSON]] | None = None, dimension_names: DimensionNamesLike = None, # v2 only chunks: tuple[int, ...] | None = None, dimension_separator: Literal[".", "/"] | None = None, order: MemoryOrder | None = None, filters: list[dict[str, JSON]] | None = None, compressor: CompressorLike = "auto", # runtime overwrite: bool = False, config: ArrayConfigLike | None = None, ) -> Self: """Creates a new Array instance from an initialized store. Deprecated in favor of [`zarr.create_array`][]. """ async_array = sync( AsyncArray._create( store=store, shape=shape, dtype=dtype, zarr_format=zarr_format, attributes=attributes, fill_value=fill_value, chunk_shape=chunk_shape, chunk_key_encoding=chunk_key_encoding, codecs=codecs, dimension_names=dimension_names, chunks=chunks, dimension_separator=dimension_separator, order=order, filters=filters, compressor=compressor, overwrite=overwrite, config=config, ), ) return cls(async_array) @classmethod def from_dict( cls, store_path: StorePath, data: dict[str, JSON], ) -> Self: """ Create a Zarr array from a dictionary. Parameters ---------- store_path : StorePath The path within the store where the array should be created. data : dict A dictionary representing the array data. This dictionary should include necessary metadata for the array, such as shape, dtype, fill value, and attributes. Returns ------- Array The created Zarr array. Raises ------ ValueError If the dictionary data is invalid or missing required fields for array creation. """ async_array = AsyncArray.from_dict(store_path=store_path, data=data) return cls(async_array) @classmethod def open( cls, store: StoreLike, ) -> Self: """Opens an existing Array from a store. Parameters ---------- store : StoreLike Store containing the Array. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. Returns ------- Array Array opened from the store. """ async_array = sync(AsyncArray.open(store)) return cls(async_array) @property def store(self) -> Store: return self.async_array.store @property def ndim(self) -> int: """Returns the number of dimensions in the array. Returns ------- int The number of dimensions in the array. """ return self.async_array.ndim @property def shape(self) -> tuple[int, ...]: """Returns the shape of the array. Returns ------- tuple[int, ...] The shape of the array. """ return self.async_array.shape @shape.setter def shape(self, value: tuple[int, ...]) -> None: """Sets the shape of the array by calling resize.""" self.resize(value) @property def chunks(self) -> tuple[int, ...]: """Returns a tuple of integers describing the length of each dimension of a chunk of the array. If sharding is used the inner chunk shape is returned. Only defined for arrays using a regular chunk grid. If array uses a rectilinear chunk grid, `NotImplementedError` is raised. Returns ------- tuple A tuple of integers representing the length of each dimension of a chunk. """ return self.async_array.chunks @property def read_chunk_sizes(self) -> tuple[tuple[int, ...], ...]: """Per-dimension data sizes of chunks used for reading, clipped to the array extent. Boundary chunks that extend past the array shape are clipped, so the last size along a dimension may be smaller than the declared chunk size. This matches the dask ``Array.chunks`` convention. When sharding is used, returns the inner chunk sizes. Otherwise, returns the outer chunk sizes (same as ``write_chunk_sizes``). Returns ------- tuple[tuple[int, ...], ...] One inner tuple per dimension containing the data size of each chunk (not the encoded buffer size). Examples -------- >>> import zarr >>> arr = zarr.create_array({}, dtype="i1", shape=(100, 80), chunks=(30, 40)) >>> arr.read_chunk_sizes ((30, 30, 30, 10), (40, 40)) """ return self.async_array.read_chunk_sizes @property def write_chunk_sizes(self) -> tuple[tuple[int, ...], ...]: """Per-dimension data sizes of storage chunks, clipped to the array extent. Always returns the outer chunk sizes, regardless of sharding. Boundary chunks that extend past the array shape are clipped, so the last size along a dimension may be smaller than the declared chunk size. This matches the dask ``Array.chunks`` convention. Returns ------- tuple[tuple[int, ...], ...] One inner tuple per dimension containing the data size of each chunk (not the encoded buffer size). Examples -------- >>> import zarr >>> arr = zarr.create_array({}, dtype="i1", shape=(100, 80), chunks=(30, 40)) >>> arr.write_chunk_sizes ((30, 30, 30, 10), (40, 40)) """ return self.async_array.write_chunk_sizes @property def shards(self) -> tuple[int, ...] | None: """Returns a tuple of integers describing the length of each dimension of a shard of the array. Returns None if sharding is not used. Only defined for arrays using a regular chunk grid. If array uses a rectilinear chunk grid, `NotImplementedError` is raised. Returns ------- tuple | None A tuple of integers representing the length of each dimension of a shard or None if sharding is not used. """ return self.async_array.shards @property def size(self) -> int: """Returns the total number of elements in the array. Returns ------- int Total number of elements in the array. """ return self.async_array.size @property def dtype(self) -> np.dtype[Any]: """Returns the NumPy data type. Returns ------- np.dtype The NumPy data type. """ return self.async_array.dtype @property def attrs(self) -> Attributes: """Returns a [MutableMapping][collections.abc.MutableMapping] containing user-defined attributes. Returns ------- attrs A [MutableMapping][collections.abc.MutableMapping] object containing user-defined attributes. Notes ----- Note that attribute values must be JSON serializable. """ return Attributes(self) @property def path(self) -> str: """Storage path.""" return self.async_array.path @property def name(self) -> str: """Array name following h5py convention.""" return self.async_array.name @property def basename(self) -> str: """Final component of name.""" return self.async_array.basename @property def metadata(self) -> ArrayMetadata: return self.async_array.metadata @property def store_path(self) -> StorePath: return self.async_array.store_path @property def order(self) -> MemoryOrder: return self.async_array.order @property def read_only(self) -> bool: return self.async_array.read_only @property def fill_value(self) -> Any: return self.metadata.fill_value @property def filters(self) -> tuple[Numcodec, ...] | tuple[ArrayArrayCodec, ...]: """ Filters that are applied to each chunk of the array, in order, before serializing that chunk to bytes. """ return self.async_array.filters @property def serializer(self) -> None | ArrayBytesCodec: """ Array-to-bytes codec to use for serializing the chunks into bytes. """ return self.async_array.serializer @property @deprecated("Use Array.compressors instead.", category=ZarrDeprecationWarning) def compressor(self) -> Numcodec | None: """ Compressor that is applied to each chunk of the array. !!! warning "Deprecated" `array.compressor` is deprecated since v3.0.0 and will be removed in a future release. Use [`array.compressors`][zarr.Array.compressors] instead. """ return self.async_array.compressor @property def compressors(self) -> tuple[Numcodec, ...] | tuple[BytesBytesCodec, ...]: """ Compressors that are applied to each chunk of the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. """ return self.async_array.compressors @property def cdata_shape(self) -> tuple[int, ...]: """ The number of chunks along each dimension. When sharding is used, this counts inner chunks (not shards) per dimension. """ return self._chunk_grid_shape @property def _chunk_grid_shape(self) -> tuple[int, ...]: """ The number of chunks along each dimension. When sharding is used, this counts inner chunks (not shards) per dimension. Returns ------- tuple[int, ...] The number of chunks along each dimension. """ return self.async_array._chunk_grid_shape @property def _shard_grid_shape(self) -> tuple[int, ...]: """ The shape of the shard grid for this array. """ return self.async_array._shard_grid_shape @property def nchunks(self) -> int: """ The number of chunks in this array. Note that if a sharding codec is used, then the number of chunks may exceed the number of stored objects supporting this array. """ return self.async_array.nchunks @property def _nshards(self) -> int: """ The number of shards in the stored representation of this array. """ return self.async_array._nshards @overload def with_config(self: ArrayV2, config: ArrayConfigLike) -> ArrayV2: ... @overload def with_config(self: ArrayV3, config: ArrayConfigLike) -> ArrayV3: ... def with_config(self, config: ArrayConfigLike) -> Self: """ Return a copy of this Array with a new runtime configuration. Parameters ---------- config : ArrayConfigLike The runtime config for the new Array. Any keys not specified will be inherited from the current array's config. Returns ------- A new Array """ return type(self)(self._async_array.with_config(config)) @property def nbytes(self) -> int: """ The total number of bytes that can be stored in the chunks of this array. Notes ----- This value is calculated by multiplying the number of elements in the array and the size of each element, the latter of which is determined by the dtype of the array. For this reason, ``nbytes`` will likely be inaccurate for arrays with variable-length dtypes. It is not possible to determine the size of an array with variable-length elements from the shape and dtype alone. """ return self.async_array.nbytes @property def nchunks_initialized(self) -> int: """ Calculate the number of chunks that have been initialized in storage. This value is calculated as the product of the number of initialized shards and the number of chunks per shard. For arrays that do not use sharding, the number of chunks per shard is effectively 1, and in that case the number of chunks initialized is the same as the number of stored objects associated with an array. For a direct count of the number of initialized stored objects, see ``nshards_initialized``. Returns ------- nchunks_initialized : int The number of chunks that have been initialized. Examples -------- >>> arr = zarr.create_array(store={}, dtype="i1", shape=(10,), chunks=(1,), shards=(2,)) >>> arr.nchunks_initialized 0 >>> arr[:5] = 1 >>> arr.nchunks_initialized 6 """ return sync(self.async_array.nchunks_initialized()) @property def _nshards_initialized(self) -> int: """ Calculate the number of shards that have been initialized, i.e. the number of shards that have been persisted to the storage backend. Returns ------- nshards_initialized : int The number of shards that have been initialized. Examples -------- >>> arr = zarr.create(shape=(10,), chunks=(2,)) >>> arr._nshards_initialized 0 >>> arr[:5] = 1 >>> arr._nshards_initialized 3 """ return sync(self.async_array._nshards_initialized()) def nbytes_stored(self) -> int: """ Determine the size, in bytes, of the array actually written to the store. Returns ------- size : int """ return sync(self.async_array.nbytes_stored()) def _iter_shard_keys( self, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[str]: """ Iterate over the storage keys of each shard, relative to an optional origin, and optionally limited to a contiguous region in chunk grid coordinates. If no shards are present this falls back to chunks, though in this case these are then actually not storage keys. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's shard grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in shard grid coordinates. Yields ------ str The storage key of each shard in the selection or chunk though chunks technically do not have storage keys. """ return self.async_array._iter_shard_keys(origin=origin, selection_shape=selection_shape) def _iter_chunk_coords( self, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[int, ...]]: """ Create an iterator over the coordinates of chunks in chunk grid space. If the `origin` keyword is used, iteration will start at the chunk index specified by `origin`. The default behavior is to start at the origin of the grid coordinate space. If the `selection_shape` keyword is used, iteration will be bounded over a contiguous region ranging from `[origin, origin + selection_shape]`, where the upper bound is exclusive as per python indexing conventions. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's chunk grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in chunk grid coordinates. Yields ------ tuple[int, ...] The coordinates of each chunk in the selection. """ return self.async_array._iter_chunk_coords(origin=origin, selection_shape=selection_shape) def _iter_shard_coords( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[int, ...]]: """ Create an iterator over the coordinates of shards in shard grid space. If the `origin` keyword is used, iteration will start at the shard index specified by `origin`. The default behavior is to start at the origin of the grid coordinate space. If the `selection_shape` keyword is used, iteration will be bounded over a contiguous region ranging from `[origin, origin selection_shape]`, where the upper bound is exclusive as per python indexing conventions. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's shard grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in shard grid coordinates. Yields ------ tuple[int, ...] The coordinates of each shard in the selection. """ return self.async_array._iter_shard_coords(origin=origin, selection_shape=selection_shape) def _iter_chunk_regions( self, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[slice, ...]]: """ Iterate over the regions spanned by each chunk. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's chunk grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in chunk grid coordinates. Yields ------ tuple[slice, ...] A tuple of slice objects representing the region spanned by each chunk in the selection. """ return self.async_array._iter_chunk_regions(origin=origin, selection_shape=selection_shape) def _iter_shard_regions( self, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None ) -> Iterator[tuple[slice, ...]]: """ Iterate over the regions spanned by each shard or chunk if no shard is present. Parameters ---------- origin : Sequence[int] | None, default=None The origin of the selection relative to the array's chunk grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in chunk grid coordinates. Yields ------ tuple[slice, ...] A tuple of slice objects representing the region spanned by each shard or if no shard is present, chunk in the selection. """ return self.async_array._iter_shard_regions(origin=origin, selection_shape=selection_shape) def __array__( self, dtype: npt.DTypeLike | None = None, copy: bool | None = None ) -> NDArrayLike: """ This method is used by numpy when converting zarr.Array into a numpy array. For more information, see https://numpy.org/devdocs/user/basics.interoperability.html#the-array-method """ if copy is False: msg = "`copy=False` is not supported. This method always creates a copy." raise ValueError(msg) arr = self[...] arr_np = np.array(arr, dtype=dtype) if dtype is not None: arr_np = arr_np.astype(dtype) return arr_np def __getitem__(self, selection: Selection) -> NDArrayLikeOrScalar: """Retrieve data for an item or region of the array. Parameters ---------- selection : tuple An integer index or slice or tuple of int/slice objects specifying the requested item or region for each dimension of the array. Returns ------- NDArrayLikeOrScalar An array-like or scalar containing the data for the requested region. Examples -------- Setup a 1-dimensional array: >>> import zarr >>> import numpy as np >>> data = np.arange(100, dtype="uint16") >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=(10,), ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve a single item: >>> z[5] array(5, dtype=uint16) Retrieve a region via slicing: >>> z[:5] array([0, 1, 2, 3, 4], dtype=uint16) >>> z[-5:] array([95, 96, 97, 98, 99], dtype=uint16) >>> z[5:10] array([5, 6, 7, 8, 9], dtype=uint16) >>> z[5:10:2] array([5, 7, 9], dtype=uint16) >>> z[::2] array([ 0, 2, 4, ..., 94, 96, 98], dtype=uint16) Load the entire array into memory: >>> z[...] array([ 0, 1, 2, ..., 97, 98, 99], dtype=uint16) Setup a 2-dimensional array: >>> data = np.arange(100, dtype="uint16").reshape(10, 10) >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=(10, 10), ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve an item: >>> z[2, 2] array(22, dtype=uint16) Retrieve a region via slicing: >>> z[1:3, 1:3] array([[11, 12], [21, 22]], dtype=uint16) >>> z[1:3, :] array([[10, 11, 12, 13, 14, 15, 16, 17, 18, 19], [20, 21, 22, 23, 24, 25, 26, 27, 28, 29]], dtype=uint16) >>> z[:, 1:3] array([[ 1, 2], [11, 12], [21, 22], [31, 32], [41, 42], [51, 52], [61, 62], [71, 72], [81, 82], [91, 92]], dtype=uint16) >>> z[0:5:2, 0:5:2] array([[ 0, 2, 4], [20, 22, 24], [40, 42, 44]], dtype=uint16) >>> z[::2, ::2] array([[ 0, 2, 4, 6, 8], [20, 22, 24, 26, 28], [40, 42, 44, 46, 48], [60, 62, 64, 66, 68], [80, 82, 84, 86, 88]], dtype=uint16) Load the entire array into memory: >>> z[...] array([[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [10, 11, 12, 13, 14, 15, 16, 17, 18, 19], [20, 21, 22, 23, 24, 25, 26, 27, 28, 29], [30, 31, 32, 33, 34, 35, 36, 37, 38, 39], [40, 41, 42, 43, 44, 45, 46, 47, 48, 49], [50, 51, 52, 53, 54, 55, 56, 57, 58, 59], [60, 61, 62, 63, 64, 65, 66, 67, 68, 69], [70, 71, 72, 73, 74, 75, 76, 77, 78, 79], [80, 81, 82, 83, 84, 85, 86, 87, 88, 89], [90, 91, 92, 93, 94, 95, 96, 97, 98, 99]], dtype=uint16) Notes ----- Slices with step > 1 are supported, but slices with negative step are not. For arrays with a structured dtype, see Zarr format 2 for examples of how to use fields Currently the implementation for __getitem__ is provided by [`vindex`][zarr.Array.vindex] if the indexing is pure fancy indexing (ie a broadcast-compatible tuple of integer array indices), or by [`set_basic_selection`][zarr.Array.set_basic_selection] otherwise. Effectively, this means that the following indexing modes are supported: - integer indexing - slice indexing - mixed slice and integer indexing - boolean indexing - fancy indexing (vectorized list of integers) For specific indexing options including outer indexing, see the methods listed under Related. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection] [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__setitem__][zarr.Array.__setitem__] """ fields, pure_selection = pop_fields(selection) if is_pure_fancy_indexing(pure_selection, self.ndim): return self.vindex[cast("CoordinateSelection | MaskSelection", selection)] elif is_pure_orthogonal_indexing(pure_selection, self.ndim): return self.get_orthogonal_selection(pure_selection, fields=fields) else: return self.get_basic_selection(cast("BasicSelection", pure_selection), fields=fields) def __setitem__(self, selection: Selection, value: npt.ArrayLike) -> None: """Modify data for an item or region of the array. Parameters ---------- selection : tuple An integer index or slice or tuple of int/slice specifying the requested region for each dimension of the array. value : npt.ArrayLike An array-like containing the data to be stored in the selection. Examples -------- Setup a 1-dimensional array: >>> import zarr >>> z = zarr.zeros( ... shape=(100,), ... store={}, ... chunk_shape=(5,), ... dtype="i4", ... ) Set all array elements to the same scalar value: >>> z[...] = 42 >>> z[...] array([42, 42, 42, ..., 42, 42, 42], dtype=int32) Set a portion of the array: >>> z[:10] = np.arange(10) >>> z[-10:] = np.arange(10)[::-1] >>> z[...] array([ 0, 1, 2, ..., 2, 1, 0], dtype=int32) Setup a 2-dimensional array: >>> z = zarr.zeros( ... shape=(5, 5), ... store={}, ... chunk_shape=(5, 5), ... dtype="i4", ... ) Set all array elements to the same scalar value: >>> z[...] = 42 Set a portion of the array: >>> z[0, :] = np.arange(z.shape[1]) >>> z[:, 0] = np.arange(z.shape[0]) >>> z[...] array([[ 0, 1, 2, 3, 4], [ 1, 42, 42, 42, 42], [ 2, 42, 42, 42, 42], [ 3, 42, 42, 42, 42], [ 4, 42, 42, 42, 42]], dtype=int32) Notes ----- Slices with step > 1 are supported, but slices with negative step are not. For arrays with a structured dtype, see Zarr format 2 for examples of how to use fields Currently the implementation for __setitem__ is provided by [`vindex`][zarr.Array.vindex] if the indexing is pure fancy indexing (ie a broadcast-compatible tuple of integer array indices), or by [`set_basic_selection`][zarr.Array.set_basic_selection] otherwise. Effectively, this means that the following indexing modes are supported: - integer indexing - slice indexing - mixed slice and integer indexing - boolean indexing - fancy indexing (vectorized list of integers) For specific indexing options including outer indexing, see the methods listed under Related. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__] """ # Converting a zarr Array to numpy here avoids a SyncError that occurs when # value.__getitem__ is called inside the async codec pipeline (which already # runs within a running event loop). np.asarray triggers Array.__array__, # which reads the data synchronously before we enter the async context. if isinstance(value, Array): value = np.asarray(value) fields, pure_selection = pop_fields(selection) if is_pure_fancy_indexing(pure_selection, self.ndim): self.vindex[cast("CoordinateSelection | MaskSelection", selection)] = value elif is_pure_orthogonal_indexing(pure_selection, self.ndim): self.set_orthogonal_selection(pure_selection, value, fields=fields) else: self.set_basic_selection(cast("BasicSelection", pure_selection), value, fields=fields) def get_basic_selection( self, selection: BasicSelection = Ellipsis, *, out: NDBuffer | None = None, prototype: BufferPrototype | None = None, fields: Fields | None = None, ) -> NDArrayLikeOrScalar: """Retrieve data for an item or region of the array. Parameters ---------- selection : BasicSelection A selection specifying the requested item or region for each dimension of the array. May be any combination of int and/or slice or ellipsis for multidimensional arrays. out : NDBuffer, optional If given, load the selected data directly into this buffer. prototype : BufferPrototype, optional The prototype of the buffer to use for the output data. If not provided, the default buffer prototype is used. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to extract data for. Returns ------- NDArrayLikeOrScalar An array-like or scalar containing the data for the requested region. Examples -------- Setup a 1-dimensional array: >>> import zarr >>> import numpy as np >>> data = np.arange(100, dtype="uint16") >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=(3,), ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve a single item: >>> z.get_basic_selection(5) np.uint16(5) Retrieve a region via slicing: >>> z.get_basic_selection(slice(5)) array([0, 1, 2, 3, 4], dtype=uint16) >>> z.get_basic_selection(slice(-5, None)) array([95, 96, 97, 98, 99], dtype=uint16) >>> z.get_basic_selection(slice(5, 10)) array([5, 6, 7, 8, 9], dtype=uint16) >>> z.get_basic_selection(slice(5, 10, 2)) array([5, 7, 9], dtype=uint16) >>> z.get_basic_selection(slice(None, None, 2)) array([ 0, 2, 4, ..., 94, 96, 98], dtype=uint16) Setup a 3-dimensional array: >>> data = np.arange(1000).reshape(10, 10, 10) >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=(5, 5, 5), ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve an item: >>> z.get_basic_selection((1, 2, 3)) np.int64(123) Retrieve a region via slicing and Ellipsis: >>> z.get_basic_selection((slice(1, 3), slice(1, 3), 0)) array([[110, 120], [210, 220]]) >>> z.get_basic_selection((0, slice(1, 3), slice(None))) array([[10, 11, 12, 13, 14, 15, 16, 17, 18, 19], [20, 21, 22, 23, 24, 25, 26, 27, 28, 29]]) >>> z.get_basic_selection((..., 2)) array([[ 2, 12, 22, 32, 42, 52, 62, 72, 82, 92], [102, 112, 122, 132, 142, 152, 162, 172, 182, 192], ... [802, 812, 822, 832, 842, 852, 862, 872, 882, 892], [902, 912, 922, 932, 942, 952, 962, 972, 982, 992]]) Notes ----- Slices with step > 1 are supported, but slices with negative step are not. For arrays with a structured dtype, see Zarr format 2 for examples of how to use the `fields` parameter. This method provides the implementation for accessing data via the square bracket notation (__getitem__). See [`__getitem__`][zarr.Array.__getitem__] for examples using the alternative notation. Related ------- [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() return sync( self.async_array._get_selection( BasicIndexer(selection, self.shape, self._chunk_grid), out=out, fields=fields, prototype=prototype, ) ) def set_basic_selection( self, selection: BasicSelection, value: npt.ArrayLike, *, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> None: """Modify data for an item or region of the array. Parameters ---------- selection : tuple A tuple specifying the requested item or region for each dimension of the array. May be any combination of int and/or slice or ellipsis for multidimensional arrays. value : npt.ArrayLike An array-like containing values to be stored into the array. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to set data for. prototype : BufferPrototype, optional The prototype of the buffer used for setting the data. If not provided, the default buffer prototype is used. Examples -------- Setup a 1-dimensional array: >>> import zarr >>> z = zarr.zeros( ... shape=(100,), ... store={}, ... chunk_shape=(100,), ... dtype="i4", ... ) Set all array elements to the same scalar value: >>> z.set_basic_selection(..., 42) >>> z[...] array([42, 42, 42, ..., 42, 42, 42], dtype=int32) Set a portion of the array: >>> z.set_basic_selection(slice(10), np.arange(10)) >>> z.set_basic_selection(slice(-10, None), np.arange(10)[::-1]) >>> z[...] array([ 0, 1, 2, ..., 2, 1, 0], dtype=int32) Setup a 2-dimensional array: >>> z = zarr.zeros( ... shape=(5, 5), ... store={}, ... chunk_shape=(5, 5), ... dtype="i4", ... ) Set all array elements to the same scalar value: >>> z.set_basic_selection(..., 42) Set a portion of the array: >>> z.set_basic_selection((0, slice(None)), np.arange(z.shape[1])) >>> z.set_basic_selection((slice(None), 0), np.arange(z.shape[0])) >>> z[...] array([[ 0, 1, 2, 3, 4], [ 1, 42, 42, 42, 42], [ 2, 42, 42, 42, 42], [ 3, 42, 42, 42, 42], [ 4, 42, 42, 42, 42]], dtype=int32) Notes ----- For arrays with a structured dtype, see Zarr format 2 for examples of how to use the `fields` parameter. This method provides the underlying implementation for modifying data via square bracket notation, see [`__setitem__`][zarr.Array.__setitem__] for equivalent examples using the alternative notation. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = BasicIndexer(selection, self.shape, self._chunk_grid) sync(self.async_array._set_selection(indexer, value, fields=fields, prototype=prototype)) def get_orthogonal_selection( self, selection: OrthogonalSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: """Retrieve data by making a selection for each dimension of the array. For example, if an array has 2 dimensions, allows selecting specific rows and/or columns. The selection for each dimension can be either an integer (indexing a single item), a slice, an array of integers, or a Boolean array where True values indicate a selection. Parameters ---------- selection : tuple A selection for each dimension of the array. May be any combination of int, slice, integer array or Boolean array. out : NDBuffer, optional If given, load the selected data directly into this buffer. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to extract data for. prototype : BufferPrototype, optional The prototype of the buffer to use for the output data. If not provided, the default buffer prototype is used. Returns ------- NDArrayLikeOrScalar An array-like or scalar containing the data for the requested selection. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> import numpy as np >>> data = np.arange(100).reshape(10, 10) >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=data.shape, ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve rows and columns via any combination of int, slice, integer array and/or Boolean array: >>> z.get_orthogonal_selection(([1, 4], slice(None))) array([[10, 11, 12, 13, 14, 15, 16, 17, 18, 19], [40, 41, 42, 43, 44, 45, 46, 47, 48, 49]]) >>> z.get_orthogonal_selection((slice(None), [1, 4])) array([[ 1, 4], [11, 14], [21, 24], [31, 34], [41, 44], [51, 54], [61, 64], [71, 74], [81, 84], [91, 94]]) >>> z.get_orthogonal_selection(([1, 4], [1, 4])) array([[11, 14], [41, 44]]) >>> sel = np.zeros(z.shape[0], dtype=bool) >>> sel[1] = True >>> sel[4] = True >>> z.get_orthogonal_selection((sel, sel)) array([[11, 14], [41, 44]]) For convenience, the orthogonal selection functionality is also available via the `oindex` property, e.g.: >>> z.oindex[[1, 4], :] array([[10, 11, 12, 13, 14, 15, 16, 17, 18, 19], [40, 41, 42, 43, 44, 45, 46, 47, 48, 49]]) >>> z.oindex[:, [1, 4]] array([[ 1, 4], [11, 14], [21, 24], [31, 34], [41, 44], [51, 54], [61, 64], [71, 74], [81, 84], [91, 94]]) >>> z.oindex[[1, 4], [1, 4]] array([[11, 14], [41, 44]]) >>> sel = np.zeros(z.shape[0], dtype=bool) >>> sel[1] = True >>> sel[4] = True >>> z.oindex[sel, sel] array([[11, 14], [41, 44]]) Notes ----- Orthogonal indexing is also known as outer indexing. Slices with step > 1 are supported, but slices with negative step are not. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = OrthogonalIndexer(selection, self.shape, self._chunk_grid) return sync( self.async_array._get_selection( indexer=indexer, out=out, fields=fields, prototype=prototype ) ) def set_orthogonal_selection( self, selection: OrthogonalSelection, value: npt.ArrayLike, *, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> None: """Modify data via a selection for each dimension of the array. Parameters ---------- selection : tuple A selection for each dimension of the array. May be any combination of int, slice, integer array or Boolean array. value : npt.ArrayLike An array-like array containing the data to be stored in the array. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to set data for. prototype : BufferPrototype, optional The prototype of the buffer used for setting the data. If not provided, the default buffer prototype is used. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> z = zarr.zeros( ... shape=(5, 5), ... store={}, ... chunk_shape=(5, 5), ... dtype="i4", ... ) Set data for a selection of rows: >>> z.set_orthogonal_selection(([1, 4], slice(None)), 1) >>> z[...] array([[0, 0, 0, 0, 0], [1, 1, 1, 1, 1], [0, 0, 0, 0, 0], [0, 0, 0, 0, 0], [1, 1, 1, 1, 1]], dtype=int32) Set data for a selection of columns: >>> z.set_orthogonal_selection((slice(None), [1, 4]), 2) >>> z[...] array([[0, 2, 0, 0, 2], [1, 2, 1, 1, 2], [0, 2, 0, 0, 2], [0, 2, 0, 0, 2], [1, 2, 1, 1, 2]], dtype=int32) Set data for a selection of rows and columns: >>> z.set_orthogonal_selection(([1, 4], [1, 4]), 3) >>> z[...] array([[0, 2, 0, 0, 2], [1, 3, 1, 1, 3], [0, 2, 0, 0, 2], [0, 2, 0, 0, 2], [1, 3, 1, 1, 3]], dtype=int32) Set data from a 2D array: >>> values = np.arange(10).reshape(2, 5) >>> z.set_orthogonal_selection(([0, 3], ...), values) >>> z[...] array([[0, 1, 2, 3, 4], [1, 3, 1, 1, 3], [0, 2, 0, 0, 2], [5, 6, 7, 8, 9], [1, 3, 1, 1, 3]], dtype=int32) For convenience, this functionality is also available via the `oindex` property: >>> z.oindex[[1, 4], [1, 4]] = 4 >>> z[...] array([[0, 1, 2, 3, 4], [1, 4, 1, 1, 4], [0, 2, 0, 0, 2], [5, 6, 7, 8, 9], [1, 4, 1, 1, 4]], dtype=int32) Notes ----- Orthogonal indexing is also known as outer indexing. Slices with step > 1 are supported, but slices with negative step are not. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = OrthogonalIndexer(selection, self.shape, self._chunk_grid) return sync( self.async_array._set_selection(indexer, value, fields=fields, prototype=prototype) ) def get_mask_selection( self, mask: MaskSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: """Retrieve a selection of individual items, by providing a Boolean array of the same shape as the array against which the selection is being made, where True values indicate a selected item. Parameters ---------- mask : ndarray, bool A Boolean array of the same shape as the array against which the selection is being made. out : NDBuffer, optional If given, load the selected data directly into this buffer. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to extract data for. prototype : BufferPrototype, optional The prototype of the buffer to use for the output data. If not provided, the default buffer prototype is used. Returns ------- NDArrayLikeOrScalar An array-like or scalar containing the data for the requested selection. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> import numpy as np >>> data = np.arange(100).reshape(10, 10) >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=data.shape, ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve items by specifying a mask: >>> sel = np.zeros_like(z, dtype=bool) >>> sel[1, 1] = True >>> sel[4, 4] = True >>> z.get_mask_selection(sel) array([11, 44]) For convenience, the mask selection functionality is also available via the `vindex` property: >>> z.vindex[sel] array([11, 44]) Notes ----- Mask indexing is a form of vectorized or inner indexing, and is equivalent to coordinate indexing. Internally the mask array is converted to coordinate arrays by calling `np.nonzero`. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = MaskIndexer(mask, self.shape, self._chunk_grid) return sync( self.async_array._get_selection( indexer=indexer, out=out, fields=fields, prototype=prototype ) ) def set_mask_selection( self, mask: MaskSelection, value: npt.ArrayLike, *, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> None: """Modify a selection of individual items, by providing a Boolean array of the same shape as the array against which the selection is being made, where True values indicate a selected item. Parameters ---------- mask : ndarray, bool A Boolean array of the same shape as the array against which the selection is being made. value : npt.ArrayLike An array-like containing values to be stored into the array. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to set data for. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> z = zarr.zeros( ... shape=(5, 5), ... store={}, ... chunk_shape=(5, 5), ... dtype="i4", ... ) Set data for a selection of items: >>> sel = np.zeros_like(z, dtype=bool) >>> sel[1, 1] = True >>> sel[4, 4] = True >>> z.set_mask_selection(sel, 1) >>> z[...] array([[0, 0, 0, 0, 0], [0, 1, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 1]], dtype=int32) For convenience, this functionality is also available via the `vindex` property: >>> z.vindex[sel] = 2 >>> z[...] array([[0, 0, 0, 0, 0], [0, 2, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 2]], dtype=int32) Notes ----- Mask indexing is a form of vectorized or inner indexing, and is equivalent to coordinate indexing. Internally the mask array is converted to coordinate arrays by calling `np.nonzero`. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = MaskIndexer(mask, self.shape, self._chunk_grid) sync(self.async_array._set_selection(indexer, value, fields=fields, prototype=prototype)) def get_coordinate_selection( self, selection: CoordinateSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: """Retrieve a selection of individual items, by providing the indices (coordinates) for each selected item. Parameters ---------- selection : tuple An integer (coordinate) array for each dimension of the array. out : NDBuffer, optional If given, load the selected data directly into this buffer. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to extract data for. prototype : BufferPrototype, optional The prototype of the buffer to use for the output data. If not provided, the default buffer prototype is used. Returns ------- NDArrayLikeOrScalar An array-like or scalar containing the data for the requested coordinate selection. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> import numpy as np >>> data = np.arange(0, 100, dtype="uint16").reshape((10, 10)) >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=(3, 3), ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve items by specifying their coordinates: >>> z.get_coordinate_selection(([1, 4], [1, 4])) array([11, 44], dtype=uint16) For convenience, the coordinate selection functionality is also available via the `vindex` property: >>> z.vindex[[1, 4], [1, 4]] array([11, 44], dtype=uint16) Notes ----- Coordinate indexing is also known as point selection, and is a form of vectorized or inner indexing. Slices are not supported. Coordinate arrays must be provided for all dimensions of the array. Coordinate arrays may be multidimensional, in which case the output array will also be multidimensional. Coordinate arrays are broadcast against each other before being applied. The shape of the output will be the same as the shape of each coordinate array after broadcasting. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = CoordinateIndexer(selection, self.shape, self._chunk_grid) out_array = sync( self.async_array._get_selection( indexer=indexer, out=out, fields=fields, prototype=prototype ) ) if hasattr(out_array, "shape"): # restore shape out_array = np.array(out_array).reshape(indexer.sel_shape) return out_array def set_coordinate_selection( self, selection: CoordinateSelection, value: npt.ArrayLike, *, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> None: """Modify a selection of individual items, by providing the indices (coordinates) for each item to be modified. Parameters ---------- selection : tuple An integer (coordinate) array for each dimension of the array. value : npt.ArrayLike An array-like containing values to be stored into the array. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to set data for. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> z = zarr.zeros( ... shape=(5, 5), ... store={}, ... chunk_shape=(5, 5), ... dtype="i4", ... ) Set data for a selection of items: >>> z.set_coordinate_selection(([1, 4], [1, 4]), 1) >>> z[...] array([[0, 0, 0, 0, 0], [0, 1, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 1]], dtype=int32) For convenience, this functionality is also available via the `vindex` property: >>> z.vindex[[1, 4], [1, 4]] = 2 >>> z[...] array([[0, 0, 0, 0, 0], [0, 2, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 0], [0, 0, 0, 0, 2]], dtype=int32) Notes ----- Coordinate indexing is also known as point selection, and is a form of vectorized or inner indexing. Slices are not supported. Coordinate arrays must be provided for all dimensions of the array. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() # setup indexer indexer = CoordinateIndexer(selection, self.shape, self._chunk_grid) # handle value - need ndarray-like flatten value if not is_scalar(value, self.dtype): try: from numcodecs.compat import ensure_ndarray_like value = ensure_ndarray_like(value) # TODO replace with agnostic except TypeError: # Handle types like `list` or `tuple` value = np.array(value) # TODO replace with agnostic if hasattr(value, "shape") and len(value.shape) > 1: value = np.array(value).reshape(-1) if not is_scalar(value, self.dtype) and ( isinstance(value, NDArrayLike) and indexer.shape != value.shape ): raise ValueError( f"Attempting to set a selection of {indexer.sel_shape[0]} " f"elements with an array of {value.shape[0]} elements." ) sync(self.async_array._set_selection(indexer, value, fields=fields, prototype=prototype)) def get_block_selection( self, selection: BasicSelection, *, out: NDBuffer | None = None, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: """Retrieve a selection of individual items, by providing the indices (coordinates) for each selected item. Parameters ---------- selection : int or slice or tuple of int or slice An integer (coordinate) or slice for each dimension of the array. out : NDBuffer, optional If given, load the selected data directly into this buffer. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to extract data for. prototype : BufferPrototype, optional The prototype of the buffer to use for the output data. If not provided, the default buffer prototype is used. Returns ------- NDArrayLikeOrScalar An array-like or scalar containing the data for the requested block selection. Examples -------- Setup a 2-dimensional array: >>> import zarr >>> import numpy as np >>> data = np.arange(0, 100, dtype="uint16").reshape((10, 10)) >>> z = zarr.create_array( ... {}, ... shape=data.shape, ... chunks=(3, 3), ... dtype=data.dtype, ... ) >>> z[:] = data Retrieve items by specifying their block coordinates: >>> z.get_block_selection((1, slice(None))) array([[30, 31, 32, 33, 34, 35, 36, 37, 38, 39], [40, 41, 42, 43, 44, 45, 46, 47, 48, 49], [50, 51, 52, 53, 54, 55, 56, 57, 58, 59]], dtype=uint16) Which is equivalent to: >>> z[3:6, :] array([[30, 31, 32, 33, 34, 35, 36, 37, 38, 39], [40, 41, 42, 43, 44, 45, 46, 47, 48, 49], [50, 51, 52, 53, 54, 55, 56, 57, 58, 59]], dtype=uint16) For convenience, the block selection functionality is also available via the `blocks` property: >>> z.blocks[1] array([[30, 31, 32, 33, 34, 35, 36, 37, 38, 39], [40, 41, 42, 43, 44, 45, 46, 47, 48, 49], [50, 51, 52, 53, 54, 55, 56, 57, 58, 59]], dtype=uint16) Notes ----- Block indexing is a convenience indexing method to work on individual chunks with chunk index slicing. It has the same concept as Dask's `Array.blocks` indexing. Slices are supported. However, only with a step size of one. Block index arrays may be multidimensional to index multidimensional arrays: >>> z.blocks[0, 1:3] array([[ 3, 4, 5, 6, 7, 8], [13, 14, 15, 16, 17, 18], [23, 24, 25, 26, 27, 28]], dtype=uint16) Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = BlockIndexer(selection, self.shape, self._chunk_grid) return sync( self.async_array._get_selection( indexer=indexer, out=out, fields=fields, prototype=prototype ) ) def set_block_selection( self, selection: BasicSelection, value: npt.ArrayLike, *, fields: Fields | None = None, prototype: BufferPrototype | None = None, ) -> None: """Modify a selection of individual blocks, by providing the chunk indices (coordinates) for each block to be modified. Parameters ---------- selection : tuple An integer (coordinate) or slice for each dimension of the array. value : npt.ArrayLike An array-like containing the data to be stored in the block selection. fields : str or sequence of str, optional For arrays with a structured dtype, one or more fields can be specified to set data for. prototype : BufferPrototype, optional The prototype of the buffer used for setting the data. If not provided, the default buffer prototype is used. Examples -------- Set up a 2-dimensional array: >>> import zarr >>> z = zarr.zeros( ... shape=(6, 6), ... store={}, ... chunk_shape=(2, 2), ... dtype="i4", ... ) Set data for a selection of items: >>> z.set_block_selection((1, 0), 1) >>> z[...] array([[0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0], [1, 1, 0, 0, 0, 0], [1, 1, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0]], dtype=int32) For convenience, this functionality is also available via the `blocks` property: >>> z.blocks[2, 1] = 4 >>> z[...] array([[0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0], [1, 1, 0, 0, 0, 0], [1, 1, 0, 0, 0, 0], [0, 0, 4, 4, 0, 0], [0, 0, 4, 4, 0, 0]], dtype=int32) >>> z.blocks[:, 2] = 7 >>> z[...] array([[0, 0, 0, 0, 7, 7], [0, 0, 0, 0, 7, 7], [1, 1, 0, 0, 7, 7], [1, 1, 0, 0, 7, 7], [0, 0, 4, 4, 7, 7], [0, 0, 4, 4, 7, 7]], dtype=int32) Notes ----- Block indexing is a convenience indexing method to work on individual chunks with chunk index slicing. It has the same concept as Dask's `Array.blocks` indexing. Slices are supported. However, only with a step size of one. Related ------- [get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection], [get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection], [get_orthogonal_selection][zarr.Array.get_orthogonal_selection], [set_orthogonal_selection][zarr.Array.set_orthogonal_selection], [get_coordinate_selection][zarr.Array.get_coordinate_selection], [get_block_selection][zarr.Array.get_block_selection], [set_block_selection][zarr.Array.set_block_selection], [vindex][zarr.Array.vindex], [oindex][zarr.Array.oindex], [blocks][zarr.Array.blocks], [__getitem__][zarr.Array.__getitem__], [__setitem__][zarr.Array.__setitem__] """ if prototype is None: prototype = default_buffer_prototype() indexer = BlockIndexer(selection, self.shape, self._chunk_grid) sync(self.async_array._set_selection(indexer, value, fields=fields, prototype=prototype)) @property def vindex(self) -> VIndex: """Shortcut for vectorized (inner) indexing, see [get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection], [get_mask_selection][zarr.Array.get_mask_selection] and [set_mask_selection][zarr.Array.set_mask_selection] for documentation and examples.""" return VIndex(self) @property def oindex(self) -> OIndex: """Shortcut for orthogonal (outer) indexing, see [get_orthogonal_selection][zarr.Array.get_orthogonal_selection] and [set_orthogonal_selection][zarr.Array.set_orthogonal_selection] for documentation and examples.""" return OIndex(self) @property def blocks(self) -> BlockIndex: """Shortcut for blocked chunked indexing, see [get_block_selection][zarr.Array.get_block_selection] and [set_block_selection][zarr.Array.set_block_selection] for documentation and examples.""" return BlockIndex(self) def resize(self, new_shape: ShapeLike) -> None: """ Change the shape of the array by growing or shrinking one or more dimensions. This is an in-place operation that modifies the array. Parameters ---------- new_shape : tuple New shape of the array. Notes ----- If one or more dimensions are shrunk, any chunks falling outside the new array shape will be deleted from the underlying store. However, it is noteworthy that the chunks partially falling inside the new array (i.e. boundary chunks) will remain intact, and therefore, the data falling outside the new array but inside the boundary chunks would be restored by a subsequent resize operation that grows the array size. Examples -------- ```python import zarr z = zarr.zeros(shape=(10000, 10000), chunk_shape=(1000, 1000), dtype="int32",) z.shape #> (10000, 10000) z.resize((20000, 1000)) z.shape #> (20000, 1000) z.resize((50, 50)) z.shape #>(50, 50) ``` """ sync(self.async_array.resize(new_shape)) def append(self, data: npt.ArrayLike, axis: int = 0) -> tuple[int, ...]: """Append `data` to `axis`. Parameters ---------- data : array-like Data to be appended. axis : int Axis along which to append. Returns ------- new_shape : tuple Notes ----- The size of all dimensions other than `axis` must match between this array and `data`. Examples -------- >>> import numpy as np >>> import zarr >>> a = np.arange(10000000, dtype="i4").reshape(10000, 1000) >>> z = zarr.array(a, chunks=(1000, 100)) >>> z.shape (10000, 1000) >>> z.append(a) (20000, 1000) >>> z.append(np.vstack([a, a]), axis=1) (20000, 2000) >>> z.shape (20000, 2000) """ return sync(self.async_array.append(data, axis=axis)) def update_attributes(self, new_attributes: dict[str, JSON]) -> Self: """ Update the array's attributes. Parameters ---------- new_attributes : dict A dictionary of new attributes to update or add to the array. The keys represent attribute names, and the values must be JSON-compatible. Returns ------- Array The array with the updated attributes. Raises ------ ValueError If the attributes are invalid or incompatible with the array's metadata. Notes ----- - The updated attributes will be merged with existing attributes, and any conflicts will be overwritten by the new values. """ new_array = sync(self.async_array.update_attributes(new_attributes)) return type(self)(new_array) def __repr__(self) -> str: return f"" @property def info(self) -> Any: """ Return the statically known information for an array. Returns ------- ArrayInfo Related ------- [zarr.Array.info_complete][] - All information about a group, including dynamic information like the number of bytes and chunks written. Examples -------- >>> arr = zarr.create(shape=(10,), chunks=(2,), dtype="float32") >>> arr.info Type : Array Zarr format : 3 Data type : Float32(endianness='little') Fill value : 0.0 Shape : (10,) Chunk shape : (2,) Order : C Read-only : False Store type : MemoryStore Filters : () Serializer : BytesCodec(endian='little') Compressors : (ZstdCodec(level=0, checksum=False),) No. bytes : 40 """ return self.async_array.info def info_complete(self) -> Any: """ Returns all the information about an array, including information from the Store. In addition to the statically known information like ``name`` and ``zarr_format``, this includes additional information like the size of the array in bytes and the number of chunks written. Note that this method will need to read metadata from the store. Returns ------- ArrayInfo Related ------- [zarr.Array.info][] - The statically known subset of metadata about an array. """ return sync(self.async_array.info_complete()) async def _shards_initialized( array: AnyAsyncArray, ) -> tuple[str, ...]: """ Return the keys of the shards that have been persisted to the storage backend. This will fall back to chunks in case no shards are present. Parameters ---------- array : AsyncArray The array to inspect. Returns ------- chunks_initialized : tuple[str, ...] The keys of the shards or if these are not present, chunks that have been initialized. Related ------- [nchunks_initialized][zarr.Array.nchunks_initialized] """ store_contents = [ x async for x in array.store_path.store.list_prefix(prefix=array.store_path.path) ] store_contents_relative = [ _relativize_path(path=key, prefix=array.store_path.path) for key in store_contents # obstore can include a directory marker whose key matches the listed prefix; # it is not an initialized shard and must be excluded before relativizing. if array.store_path.path == "" or key != array.store_path.path ] return tuple( chunk_key for chunk_key in array._iter_shard_keys() if chunk_key in store_contents_relative ) type FiltersLike = ( Iterable[dict[str, JSON] | ArrayArrayCodec | Numcodec] | ArrayArrayCodec | Iterable[Numcodec] | Numcodec | Literal["auto"] | None ) # Union of acceptable types for users to pass in for both v2 and v3 compressors type CompressorLike = dict[str, JSON] | BytesBytesCodec | Numcodec | Literal["auto"] | None type CompressorsLike = ( Iterable[dict[str, JSON] | BytesBytesCodec | Numcodec] | Mapping[str, JSON] | BytesBytesCodec | Numcodec | Literal["auto"] | None ) type SerializerLike = dict[str, JSON] | ArrayBytesCodec | Literal["auto"] class ShardsConfigParam(TypedDict): shape: tuple[int, ...] index_location: IndexLocation | None type ShardsLike = tuple[int, ...] | Sequence[Sequence[int]] | ShardsConfigParam | Literal["auto"] async def from_array( store: StoreLike, *, data: AnyArray | npt.ArrayLike, write_data: bool = True, name: str | None = None, chunks: ChunksLike | Literal["auto", "keep"] = "keep", shards: ShardsLike | None | Literal["keep"] = "keep", filters: FiltersLike | Literal["keep"] = "keep", compressors: CompressorsLike | Literal["keep"] = "keep", serializer: SerializerLike | Literal["keep"] = "keep", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, zarr_format: ZarrFormat | None = None, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, ) -> AnyAsyncArray: """Create an array from an existing array or array-like. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. data : Array | array-like The array to copy. write_data : bool, default True Whether to copy the data from the input array to the new array. If ``write_data`` is ``False``, the new array will be created with the same metadata as the input array, but without any data. name : str or None, optional The name of the array within the store. If ``name`` is ``None``, the array will be located at the root of the store. chunks : tuple[int, ...] or Sequence[Sequence[int]] or "auto" or "keep", optional Chunk shape of the array. Following values are supported: - "auto": Automatically determine the chunk shape based on the array's shape and dtype. - "keep": Retain the chunk grid of the data array if it is a zarr Array. - tuple[int, ...]: A tuple of integers representing the chunk shape (regular grid). - Sequence[Sequence[int]]: Per-dimension chunk edge lists (rectilinear grid). Rectilinear chunk grids are experimental and must be explicitly enabled with ``zarr.config.set({'array.rectilinear_chunks': True})`` while the feature is stabilizing. If not specified, defaults to "keep" if data is a zarr Array, otherwise "auto". shards : tuple[int, ...], optional Shard shape of the array. Following values are supported: - "auto": Automatically determine the shard shape based on the array's shape and chunk shape. - "keep": Retain the shard shape of the data array if it is a zarr Array. - tuple[int, ...]: A tuple of integers representing the shard shape. - None: No sharding. If not specified, defaults to "keep" if data is a zarr Array, otherwise None. filters : Iterable[Codec] | Literal["auto", "keep"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"keep"`` instructs Zarr to infer ``filters`` from ``data``. If that inference is not possible, Zarr will fall back to the behavior specified by ``"auto"``, which is to choose default filters based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are the empty tuple ``()``. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters is a tuple with a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec] or "auto" or "keep", optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. Following values are supported: - Iterable[Codec]: List of compressors to apply to the array. - "auto": Automatically determine the compressors based on the array's dtype. - "keep": Retain the compressors of the input array if it is a zarr Array. If no ``compressors`` are provided, defaults to "keep" if data is a zarr Array, otherwise "auto". serializer : dict[str, JSON] | ArrayBytesCodec or "auto" or "keep", optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. Following values are supported: - dict[str, JSON]: A dict representation of an ``ArrayBytesCodec``. - ArrayBytesCodec: An instance of ``ArrayBytesCodec``. - "auto": a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][zarr.config]. - "keep": Retain the serializer of the input array if it is a zarr Array. fill_value : Any, optional Fill value for the array. If not specified, defaults to the fill value of the data array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If not specified, defaults to the memory order of the data array. zarr_format : {2, 3}, optional The zarr format to use when saving. If not specified, defaults to the zarr format of the data array. attributes : dict, optional Attributes for the array. If not specified, defaults to the attributes of the data array. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. If not specified and the data array has the same zarr format as the target array, the chunk key encoding of the data array is used. dimension_names : Iterable[str | None] | None The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. If not specified, defaults to the dimension names of the data array. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. config : ArrayConfig or ArrayConfigLike, optional Runtime configuration for the array. Returns ------- AsyncArray The array. Examples -------- Create an array from an existing Array: >>> import asyncio >>> import zarr >>> store = zarr.storage.LocalStore("example.zarr") >>> arr = zarr.create_array( ... store={}, ... shape=(100,100), ... chunks=(10,10), ... dtype="int32", ... fill_value=0, ... ) >>> arr2 = asyncio.run(from_array(store, data=arr, overwrite=True)) >>> arr2 >>> asyncio.run(store.clear()) # Remove files generated by test Create an array from an existing NumPy array: >>> arr3 = asyncio.run( ... from_array({}, data=np.arange(10000, dtype="i4").reshape(100, 100)) ... ) >>> arr3 Create an array from any array-like object: >>> arr4 = asyncio.run(from_array({}, data=[[1, 2], [3, 4]])) >>> arr4 >>> asyncio.run(arr4.getitem(...)) array([[1, 2], [3, 4]]) Create an array from an existing Array without copying the data: >>> arr5 = asyncio.run(from_array({}, data=Array(arr4), write_data=False)) >>> arr5 >>> asyncio.run(arr5.getitem(...)) array([[0, 0], [0, 0]]) """ mode: Literal["a"] = "a" config_parsed = parse_array_config(config) store_path = await make_store_path(store, path=name, mode=mode, storage_options=storage_options) ( chunks, shards, filters, compressors, serializer, fill_value, order, zarr_format, chunk_key_encoding, dimension_names, ) = _parse_keep_array_attr( data=data, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, ) if not hasattr(data, "dtype") or not hasattr(data, "shape"): data = np.array(data) result = await init_array( store_path=store_path, shape=data.shape, dtype=data.dtype, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, overwrite=overwrite, config=config_parsed, ) if write_data: if isinstance(data, Array): async def _copy_array_region( chunk_coords: tuple[int, ...] | slice, _data: AnyArray ) -> None: arr = await _data.async_array.getitem(chunk_coords) await result.setitem(chunk_coords, arr) # Stream data from the source array to the new array await concurrent_map( [(region, data) for region in result._iter_shard_regions()], _copy_array_region, zarr.core.config.config.get("async.concurrency"), ) else: async def _copy_arraylike_region(chunk_coords: slice, _data: NDArrayLike) -> None: await result.setitem(chunk_coords, _data[chunk_coords]) # Stream data from the source array to the new array await concurrent_map( [(region, data) for region in result._iter_shard_regions()], _copy_arraylike_region, zarr.core.config.config.get("async.concurrency"), ) return result async def init_array( *, store_path: StorePath, shape: ShapeLike, dtype: ZDTypeLike, chunks: ChunksLike | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", serializer: SerializerLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, zarr_format: ZarrFormat | None = 3, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, overwrite: bool = False, config: ArrayConfigLike | None = None, ) -> AnyAsyncArray: """Create and persist an array metadata document. Parameters ---------- store_path : StorePath StorePath instance. The path attribute is the name of the array to initialize. shape : tuple[int, ...] Shape of the array. dtype : ZDTypeLike Data type of the array. chunks : tuple[int, ...], optional Chunk shape of the array. If not specified, default are guessed based on the shape and dtype. shards : tuple[int, ...], optional Shard shape of the array. The default value of ``None`` results in no sharding at all. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec] | Literal["auto"], optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. The default value of ``"auto"`` instructs Zarr to use a default of [`zarr.codecs.ZstdCodec`][]. To create an array with no compressors, provide an empty iterable or the value ``None``. serializer : dict[str, JSON] | ArrayBytesCodec | Literal["auto"], optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. The default value of ``"auto"`` instructs Zarr to use a default codec based on the data type of the array. For most data types this default codec is [`zarr.codecs.BytesCodec`][]. For [`zarr.dtype.VariableLengthUTF8`][], the default codec is [`zarr.codecs.VlenUTF8Codec`][]. For [`zarr.dtype.VariableLengthBytes`][], the default codec is [`zarr.codecs.VlenBytesCodec`][]. fill_value : Any, optional Fill value for the array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If no ``order`` is provided, a default order will be used. This default can be changed by modifying the value of ``array.order`` in [`zarr.config`][zarr.config]. zarr_format : {2, 3}, optional The zarr format to use when saving. attributes : dict, optional Attributes for the array. chunk_key_encoding : ChunkKeyEncodingLike, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. dimension_names : Iterable[str], optional The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. config : ArrayConfigLike or None, default=None Configuration for this array. If ``None``, the default array runtime configuration will be used. This default is stored in the global configuration object. Returns ------- AsyncArray The AsyncArray. """ if zarr_format is None: zarr_format = _default_zarr_format() from zarr.codecs.sharding import ShardingCodec zdtype = parse_dtype(dtype, zarr_format=zarr_format) shape_parsed = parse_shapelike(shape) item_size = zdtype.item_size if isinstance(zdtype, HasItemSize) else 1 chunk_key_encoding_parsed = _parse_chunk_key_encoding( chunk_key_encoding, zarr_format=zarr_format ) await _prepare_overwrite(store_path, zarr_format=zarr_format, overwrite=overwrite) # Validate rectilinear chunks constraints if _is_rectilinear_chunks(chunks): if zarr_format == 2: raise ValueError("Zarr format 2 does not support rectilinear chunk grids.") if shards is not None: raise ValueError( "Rectilinear chunks with sharding is not supported. " "Use rectilinear shards instead: " "chunks=(inner_size, ...), shards=[[shard_sizes], ...]" ) # Normalize the user's chunks into canonical ChunksTuple form if chunks == "auto": max_bytes = None if shards is None else SHARDED_INNER_CHUNK_MAX_BYTES chunks_normalized = guess_chunks(shape_parsed, item_size, max_bytes=max_bytes) else: chunks_normalized = normalize_chunks_nd(chunks, shape_parsed) # Resolve chunks + shards into outer_chunks (grid metadata) and # inner (sub-chunk structure for ShardingCodec, None if no sharding) outer_chunks, inner = resolve_outer_and_inner_chunks( array_shape=shape_parsed, chunks=chunks_normalized, shard_shape=shards, item_size=item_size, ) meta: ArrayV2Metadata | ArrayV3Metadata if zarr_format == 2: if inner is not None: msg = ( "Zarr format 2 arrays can only be created with `shard_shape` set to `None`. " f"Got `shard_shape={shards}` instead." ) raise ValueError(msg) if serializer != "auto": raise ValueError("Zarr format 2 arrays do not support `serializer`.") filters_parsed, compressor_parsed = _parse_chunk_encoding_v2( compressor=compressors, filters=filters, dtype=zdtype ) if dimension_names is not None: raise ValueError("Zarr format 2 arrays do not support dimension names.") if order is None: order_parsed = zarr_config.get("array.order") else: order_parsed = order chunk_key_encoding_parsed = cast("V2ChunkKeyEncoding", chunk_key_encoding_parsed) meta = AsyncArray._create_metadata_v2( shape=shape_parsed, dtype=zdtype, chunks=as_regular_shape(outer_chunks), dimension_separator=chunk_key_encoding_parsed.separator, fill_value=fill_value, order=order_parsed, filters=filters_parsed, compressor=compressor_parsed, attributes=attributes, ) else: array_array, array_bytes, bytes_bytes = _parse_chunk_encoding_v3( compressors=compressors, filters=filters, serializer=serializer, dtype=zdtype, ) sub_codecs = cast("tuple[Codec, ...]", (*array_array, array_bytes, *bytes_bytes)) grid = create_chunk_grid_metadata(outer_chunks) codecs_out: tuple[Codec, ...] if inner is not None: inner_chunks_flat = as_regular_shape(inner.outer_chunks) index_location: IndexLocation = "end" if isinstance(shards, dict): index_location = cast("IndexLocation", shards.get("index_location", "end")) sharding_codec = ShardingCodec( chunk_shape=inner_chunks_flat, codecs=sub_codecs, index_location=index_location ) sharding_codec.validate( shape=inner_chunks_flat, dtype=zdtype, chunk_grid=grid, ) codecs_out = (sharding_codec,) else: codecs_out = sub_codecs if order is not None: _warn_order_kwarg() meta = AsyncArray._create_metadata_v3( shape=shape_parsed, dtype=zdtype, fill_value=fill_value, chunk_grid=grid, chunk_key_encoding=chunk_key_encoding_parsed, codecs=codecs_out, dimension_names=dimension_names, attributes=attributes, ) arr = AsyncArray(metadata=meta, store_path=store_path, config=config) await arr._save_metadata(meta, ensure_parents=True) return arr async def create_array( store: StoreLike, *, name: str | None = None, shape: ShapeLike | None = None, dtype: ZDTypeLike | None = None, data: np.ndarray[Any, np.dtype[Any]] | None = None, chunks: ChunksLike | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", serializer: SerializerLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, zarr_format: ZarrFormat | None = 3, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, write_data: bool = True, ) -> AnyAsyncArray: """Create an array. Parameters ---------- store : StoreLike StoreLike object to open. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. name : str or None, optional The name of the array within the store. If ``name`` is ``None``, the array will be located at the root of the store. shape : ShapeLike, optional Shape of the array. Must be ``None`` if ``data`` is provided. dtype : ZDTypeLike | None Data type of the array. Must be ``None`` if ``data`` is provided. data : np.ndarray, optional Array-like data to use for initializing the array. If this parameter is provided, the ``shape`` and ``dtype`` parameters must be ``None``. chunks : tuple[int, ...] | Sequence[Sequence[int]] | Literal["auto"], default="auto" Chunk shape of the array. If chunks is "auto", a chunk shape is guessed based on the shape of the array and the dtype. A nested list of per-dimension edge sizes creates a rectilinear grid. Rectilinear chunk grids are experimental and must be explicitly enabled with ``zarr.config.set({'array.rectilinear_chunks': True})`` while the feature is stabilizing. shards : tuple[int, ...], optional Shard shape of the array. The default value of ``None`` results in no sharding at all. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec], optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. If no ``compressors`` are provided, a default set of compressors will be used. These defaults can be changed by modifying the value of ``array.v3_default_compressors`` in [`zarr.config`][zarr.config]. Use ``None`` to omit default compressors. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no ``compressor`` is provided, a default compressor will be used. in [`zarr.config`][zarr.config]. Use ``None`` to omit the default compressor. serializer : dict[str, JSON] | ArrayBytesCodec, optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no ``serializer`` is provided, a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][zarr.config]. fill_value : Any, optional Fill value for the array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If no ``order`` is provided, a default order will be used. This default can be changed by modifying the value of ``array.order`` in [`zarr.config`][zarr.config]. zarr_format : {2, 3}, optional The zarr format to use when saving. attributes : dict, optional Attributes for the array. chunk_key_encoding : ChunkKeyEncodingLike, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. dimension_names : Iterable[str], optional The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. If ``True``, all existing paths in the store will be deleted. config : ArrayConfigLike, optional Runtime configuration for the array. write_data : bool If a pre-existing array-like object was provided to this function via the ``data`` parameter then ``write_data`` determines whether the values in that array-like object should be written to the Zarr array created by this function. If ``write_data`` is ``False``, then the array will be left empty. Returns ------- AsyncArray The array. Examples -------- >>> import asyncio >>> import zarr >>> asyncio.run( ... zarr.api.asynchronous.create_array( ... store={}, ... shape=(100,100), ... chunks=(10,10), ... dtype="i4", ... fill_value=0 ... ) ... ) """ data_parsed, shape_parsed, dtype_parsed = _parse_data_params( data=data, shape=shape, dtype=dtype ) if data_parsed is not None: return await from_array( store, data=data_parsed, write_data=write_data, name=name, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, storage_options=storage_options, overwrite=overwrite, config=config, ) else: mode: Literal["a"] = "a" store_path = await make_store_path( store, path=name, mode=mode, storage_options=storage_options ) return await init_array( store_path=store_path, shape=shape_parsed, dtype=dtype_parsed, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, overwrite=overwrite, config=config, ) def _parse_keep_array_attr( data: AnyArray | npt.ArrayLike, chunks: ChunksLike | Literal["auto", "keep"], shards: ShardsLike | None | Literal["keep"], filters: FiltersLike | Literal["keep"], compressors: CompressorsLike | Literal["keep"], serializer: SerializerLike | Literal["keep"], fill_value: Any | None, order: MemoryOrder | None, zarr_format: ZarrFormat | None, chunk_key_encoding: ChunkKeyEncodingLike | None, dimension_names: DimensionNamesLike, ) -> tuple[ ChunksLike | Literal["auto"], ShardsLike | None, FiltersLike, CompressorsLike, SerializerLike, Any | None, MemoryOrder | None, ZarrFormat, ChunkKeyEncodingLike | None, DimensionNamesLike, ]: if isinstance(data, Array): if chunks == "keep": if data._chunk_grid.is_regular: chunks = data.chunks else: chunks = data.write_chunk_sizes if shards == "keep": shards = data.shards if data._chunk_grid.is_regular else None if zarr_format is None: zarr_format = data.metadata.zarr_format if filters == "keep": if zarr_format == data.metadata.zarr_format: filters = data.filters or None else: filters = "auto" if compressors == "keep": if zarr_format == data.metadata.zarr_format: compressors = data.compressors or None else: compressors = "auto" if serializer == "keep": if zarr_format == 3 and data.metadata.zarr_format == 3: serializer = cast("SerializerLike", data.serializer) else: serializer = "auto" if fill_value is None: fill_value = data.fill_value if data.metadata.zarr_format == 2 and zarr_format == 3 and data.order == "F": # Can't set order="F" for v3 arrays warnings.warn( "The 'order' attribute of a Zarr format 2 array does not have a direct analogue in Zarr format 3. " "The existing order='F' of the source Zarr format 2 array will be ignored.", ZarrUserWarning, stacklevel=2, ) elif order is None and zarr_format == 2: order = data.order if chunk_key_encoding is None and zarr_format == data.metadata.zarr_format: if isinstance(data.metadata, ArrayV2Metadata): chunk_key_encoding = {"name": "v2", "separator": data.metadata.dimension_separator} elif isinstance(data.metadata, ArrayV3Metadata): chunk_key_encoding = data.metadata.chunk_key_encoding if dimension_names is None and data.metadata.zarr_format == 3: dimension_names = data.metadata.dimension_names else: if chunks == "keep": chunks = "auto" if shards == "keep": shards = None if zarr_format is None: zarr_format = 3 if filters == "keep": filters = "auto" if compressors == "keep": compressors = "auto" if serializer == "keep": serializer = "auto" # After resolving "keep" above, chunks is never "keep" at this point. chunks_out: ChunksLike | Literal["auto"] = chunks return ( chunks_out, shards, filters, compressors, serializer, fill_value, order, zarr_format, chunk_key_encoding, dimension_names, ) def _parse_chunk_key_encoding( data: ChunkKeyEncodingLike | None, zarr_format: ZarrFormat ) -> ChunkKeyEncoding: """ Take an implicit specification of a chunk key encoding and parse it into a ChunkKeyEncoding object. """ if data is None: if zarr_format == 2: data = {"name": "v2", "configuration": {"separator": "."}} else: data = {"name": "default", "configuration": {"separator": "/"}} result = parse_chunk_key_encoding(data) if zarr_format == 2 and result.name != "v2": msg = ( "Invalid chunk key encoding. For Zarr format 2 arrays, the `name` field of the " f"chunk key encoding must be 'v2'. Got `name` = {result.name} instead." ) raise ValueError(msg) return result def default_compressors_v3(dtype: ZDType[Any, Any]) -> tuple[BytesBytesCodec, ...]: """ Given a data type, return the default compressors for that data type. This is just a tuple containing ``ZstdCodec`` """ return (ZstdCodec(),) def default_serializer_v3(dtype: ZDType[Any, Any]) -> ArrayBytesCodec: """ Given a data type, return the default serializer for that data type. The default serializer for most data types is the ``BytesCodec``, which may or may not be parameterized with an endianness, depending on whether the data type has endianness. Variable length strings and variable length bytes have hard-coded serializers -- ``VLenUTF8Codec`` and ``VLenBytesCodec``, respectively. Structured data types with multi-byte fields use ``BytesCodec`` with little-endian encoding. """ serializer: ArrayBytesCodec = BytesCodec(endian=None) if isinstance(dtype, HasEndianness) or ( isinstance(dtype, Structured) and dtype.has_multi_byte_fields() ): serializer = BytesCodec(endian="little") elif isinstance(dtype, HasObjectCodec): if dtype.object_codec_id == "vlen-bytes": serializer = VLenBytesCodec() elif dtype.object_codec_id == "vlen-utf8": serializer = VLenUTF8Codec() else: msg = f"Data type {dtype} requires an unknown object codec: {dtype.object_codec_id!r}." raise ValueError(msg) return serializer def default_filters_v2(dtype: ZDType[Any, Any]) -> tuple[Numcodec] | None: """ Given a data type, return the default filters for that data type. For data types that require an object codec, namely variable length data types, this is a tuple containing the object codec. Otherwise it's ``None``. """ if isinstance(dtype, HasObjectCodec): if dtype.object_codec_id == "vlen-bytes": from numcodecs import VLenBytes return (VLenBytes(),) elif dtype.object_codec_id == "vlen-utf8": from numcodecs import VLenUTF8 return (VLenUTF8(),) else: msg = f"Data type {dtype} requires an unknown object codec: {dtype.object_codec_id!r}." raise ValueError(msg) return None def default_compressor_v2(dtype: ZDType[Any, Any]) -> Numcodec: """ Given a data type, return the default compressors for that data type. This is just the numcodecs ``Zstd`` codec. """ from numcodecs import Zstd return Zstd(level=0, checksum=False) # type: ignore[no-any-return] def _parse_chunk_encoding_v2( *, compressor: CompressorsLike, filters: FiltersLike, dtype: ZDType[TBaseDType, TBaseScalar], ) -> tuple[tuple[Numcodec, ...] | None, Numcodec | None]: """ Generate chunk encoding classes for Zarr format 2 arrays with optional defaults. """ _filters: tuple[Numcodec, ...] | None _compressor: Numcodec | None if compressor is None or compressor == (): _compressor = None elif compressor == "auto": _compressor = default_compressor_v2(dtype) elif isinstance(compressor, tuple | list) and len(compressor) == 1: _compressor = parse_compressor(compressor[0]) else: if isinstance(compressor, Iterable) and not isinstance(compressor, dict): msg = f"For Zarr format 2 arrays, the `compressor` must be a single codec. Got an iterable with type {type(compressor)} instead." raise TypeError(msg) _compressor = parse_compressor(compressor) if filters is None: _filters = None elif filters == "auto": _filters = default_filters_v2(dtype) else: if isinstance(filters, Iterable): for idx, f in enumerate(filters): if not _is_numcodec(f): msg = ( "For Zarr format 2 arrays, all elements of `filters` must be numcodecs codecs. " f"Element at index {idx} has type {type(f)}, which is not a numcodecs codec." ) raise TypeError(msg) _filters = parse_filters(filters) if isinstance(dtype, HasObjectCodec): # check the filters and the compressor for the object codec required for this data type if _filters is None: if _compressor is None: object_codec_id = None else: object_codec_id = get_object_codec_id((_compressor.get_config(),)) else: object_codec_id = get_object_codec_id( ( *[f.get_config() for f in _filters], _compressor.get_config() if _compressor is not None else None, ) ) if object_codec_id is None: if isinstance(dtype, VariableLengthUTF8): # type: ignore[unreachable] codec_name = "the numcodecs.VLenUTF8 codec" # type: ignore[unreachable] elif isinstance(dtype, VariableLengthBytes): # type: ignore[unreachable] codec_name = "the numcodecs.VLenBytes codec" # type: ignore[unreachable] else: codec_name = f"an unknown object codec with id {dtype.object_codec_id!r}" msg = ( f"Data type {dtype} requires {codec_name}, " "but no such codec was specified in the filters or compressor parameters for " "this array. " ) raise ValueError(msg) return _filters, _compressor def _parse_chunk_encoding_v3( *, compressors: CompressorsLike, filters: FiltersLike, serializer: SerializerLike, dtype: ZDType[TBaseDType, TBaseScalar], ) -> tuple[tuple[ArrayArrayCodec, ...], ArrayBytesCodec, tuple[BytesBytesCodec, ...]]: """ Generate chunk encoding classes for v3 arrays with optional defaults. """ if filters is None: out_array_array: tuple[ArrayArrayCodec, ...] = () elif filters == "auto": # no data types have default filters out_array_array = () else: maybe_array_array: Iterable[Codec | dict[str, JSON]] if isinstance(filters, dict | Codec): maybe_array_array = (filters,) else: maybe_array_array = cast("Iterable[Codec | dict[str, JSON]]", filters) out_array_array = tuple(_parse_array_array_codec(c) for c in maybe_array_array) if serializer == "auto": out_array_bytes = default_serializer_v3(dtype) else: # TODO: ensure that the serializer is compatible with the ndarray produced by the # array-array codecs. For example, if a sequence of array-array codecs produces an # array with a single-byte data type, then the serializer should not specify endiannesss. out_array_bytes = _parse_array_bytes_codec(serializer) if compressors is None: out_bytes_bytes: tuple[BytesBytesCodec, ...] = () elif compressors == "auto": out_bytes_bytes = default_compressors_v3(dtype) else: maybe_bytes_bytes: Iterable[Codec | dict[str, JSON]] if isinstance(compressors, dict | Codec): maybe_bytes_bytes = (compressors,) else: maybe_bytes_bytes = cast("Iterable[Codec | dict[str, JSON]]", compressors) out_bytes_bytes = tuple(_parse_bytes_bytes_codec(c) for c in maybe_bytes_bytes) # TODO: ensure that the serializer is compatible with the ndarray produced by the # array-array codecs. For example, if a sequence of array-array codecs produces an # array with a single-byte data type, then the serializer should not specify endiannesss. # TODO: add checks to ensure that the right serializer is used for vlen data types return out_array_array, out_array_bytes, out_bytes_bytes def _parse_deprecated_compressor( compressor: CompressorLike | None, compressors: CompressorsLike, zarr_format: int = 3 ) -> CompressorsLike | None: if compressor != "auto": if compressors != "auto": raise ValueError("Cannot specify both `compressor` and `compressors`.") if zarr_format == 3: warn( "The `compressor` argument is deprecated. Use `compressors` instead.", category=ZarrUserWarning, stacklevel=2, ) if compressor is None: # "no compression" compressors = () else: compressors = (compressor,) elif zarr_format == 2 and compressor == compressors == "auto": compressors = ({"id": "blosc"},) return compressors def _parse_data_params( *, data: np.ndarray[Any, np.dtype[Any]] | None, shape: ShapeLike | None, dtype: ZDTypeLike | None, ) -> tuple[np.ndarray[Any, np.dtype[Any]] | None, ShapeLike, ZDTypeLike]: """ Ensure an array-like ``data`` parameter is consistent with the ``dtype`` and ``shape`` parameters. """ if data is None: if shape is None: msg = ( "The data parameter was set to None, but shape was not specified. " "Either provide a value for data, or specify shape." ) raise ValueError(msg) shape_out = shape if dtype is None: msg = ( "The data parameter was set to None, but dtype was not specified. " "Either provide an array-like value for data, or specify dtype." ) raise ValueError(msg) dtype_out = dtype else: if shape is not None: msg = ( "The data parameter was used, but the shape parameter was also " "used. This is an error. Either use the data parameter, or the shape parameter, " "but not both." ) raise ValueError(msg) shape_out = data.shape if dtype is not None: msg = ( "The data parameter was used, but the dtype parameter was also " "used. This is an error. Either use the data parameter, or the dtype parameter, " "but not both." ) raise ValueError(msg) dtype_out = data.dtype return data, shape_out, dtype_out def _iter_chunk_coords( array: AnyArray | AnyAsyncArray, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[tuple[int, ...]]: """ Create an iterator over the coordinates of chunks in chunk grid space. If the `origin` keyword is used, iteration will start at the chunk index specified by `origin`. The default behavior is to start at the origin of the grid coordinate space. If the `selection_shape` keyword is used, iteration will be bounded over a contiguous region ranging from `[origin, origin selection_shape]`, where the upper bound is exclusive as per python indexing conventions. Parameters ---------- array : Array | AsyncArray The array to iterate over. origin : Sequence[int] | None, default=None The origin of the selection in grid coordinates. selection_shape : Sequence[int] | None, default=None The shape of the selection in grid coordinates. Yields ------ chunk_coords: tuple[int, ...] The coordinates of each chunk in the selection. """ return _iter_grid(array._chunk_grid_shape, origin=origin, selection_shape=selection_shape) def _iter_shard_coords( array: AnyArray | AnyAsyncArray, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[tuple[int, ...]]: """ Create an iterator over the coordinates of shards in shard grid space. If the `origin` keyword is used, iteration will start at the shard index specified by `origin`. The default behavior is to start at the origin of the grid coordinate space. If the `selection_shape` keyword is used, iteration will be bounded over a contiguous region ranging from `[origin, origin selection_shape]`, where the upper bound is exclusive as per python indexing conventions. If no shards are present this will iterate over the coordinates of chunks in chunk grid space instead. Parameters ---------- array : Array | AsyncArray The array to iterate over. origin : Sequence[int] | None, default=None The origin of the selection in grid coordinates. selection_shape : Sequence[int] | None, default=None The shape of the selection in grid coordinates. Yields ------ chunk_coords: tuple[int, ...] The coordinates of each shard in the selection or chunks if no shards are present. """ return _iter_grid(array._shard_grid_shape, origin=origin, selection_shape=selection_shape) def _iter_shard_keys( array: AnyArray | AnyAsyncArray, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[str]: """ Iterate over the storage keys of each shard, relative to an optional origin, and optionally limited to a contiguous region in shard grid coordinates. This automatically falls back to chunks when no shards are present. Parameters ---------- array : Array | AsyncArray The array to iterate over. origin : Sequence[int] | None, default=None The origin of the selection in grid coordinates. selection_shape : Sequence[int] | None, default=None The shape of the selection in grid coordinates. Yields ------ key: str The storage key of each shard in the selection or chunk when no shards are present. """ # Iterate over the coordinates of chunks in chunk grid space. _iter = _iter_grid(array._shard_grid_shape, origin=origin, selection_shape=selection_shape) return (array.metadata.encode_chunk_key(k) for k in _iter) def _iter_shard_regions( array: AnyArray | AnyAsyncArray, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[tuple[slice, ...]]: """ Iterate over the regions spanned by each shard. These are the smallest regions of the array that are safe to write concurrently. When no shards are present this will fall back to chunks. Parameters ---------- array : Array | AsyncArray The array to iterate over. origin : Sequence[int] | None, default=None The origin of the selection relative to the array's shard grid. selection_shape : Sequence[int] | None, default=None The shape of the selection in shard grid coordinates. Yields ------ region: tuple[slice, ...] A tuple of slice objects representing the region spanned by each shard in the selection or chunk when no shards are present. """ if array.shards is None: shard_shape = array.chunks else: shard_shape = array.shards return _iter_regions( array.shape, shard_shape, origin=origin, selection_shape=selection_shape, trim_excess=True ) def _iter_chunk_regions( array: AnyArray | AnyAsyncArray, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[tuple[slice, ...]]: """ Iterate over the regions spanned by each shard. These are the smallest regions of the array that are efficient to read concurrently. Parameters ---------- array : Array | AsyncArray The array to iterate over. origin : Sequence[int] | None, default=None The origin of the selection in grid coordinates. selection_shape : Sequence[int] | None, default=None The shape of the selection in grid coordinates. Returns ------- region: tuple[slice, ...] A tuple of slice objects representing the region spanned by each shard in the selection. """ return array._chunk_grid.iter_chunk_regions(origin=origin, selection_shape=selection_shape) async def _nchunks_initialized( array: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata], ) -> int: """ Calculate the number of chunks that have been initialized in storage. This value is calculated as the product of the number of initialized shards and the number of chunks per shard. For arrays that do not use sharding, the number of chunks per shard is effectively 1, and in that case the number of chunks initialized is the same as the number of stored objects associated with an array. Parameters ---------- array : AsyncArray The array to inspect. Returns ------- nchunks_initialized : int The number of chunks that have been initialized. """ if array.shards is None: chunks_per_shard = 1 else: chunks_per_shard = product( tuple(a // b for a, b in zip(array.shards, array.chunks, strict=True)) ) return (await _nshards_initialized(array)) * chunks_per_shard async def _nshards_initialized( array: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata], ) -> int: """ Calculate the number of shards that have been initialized in storage. This is the number of shards that have been persisted to the storage backend. Parameters ---------- array : AsyncArray The array to inspect. Returns ------- nshards_initialized : int The number of shards that have been initialized. """ return len(await _shards_initialized(array)) async def _nbytes_stored( store_path: StorePath, ) -> int: """ Calculate the number of bytes stored for an array. Parameters ---------- store_path : StorePath The store path of the array. Returns ------- nbytes_stored : int The number of bytes stored. """ return await store_path.store.getsize_prefix(store_path.path) def _get_chunk_spec( metadata: ArrayMetadata, chunk_grid: ChunkGrid, chunk_coords: tuple[int, ...], array_config: ArrayConfig, prototype: BufferPrototype, ) -> ArraySpec: """Build an ArraySpec for a single chunk using the ChunkGrid.""" spec = chunk_grid[chunk_coords] if spec is None: raise IndexError(f"Chunk coordinates {chunk_coords} are out of bounds.") return ArraySpec( shape=spec.codec_shape, dtype=metadata.dtype, fill_value=metadata.fill_value, config=array_config, prototype=prototype, ) async def _get_selection( store_path: StorePath, metadata: ArrayMetadata, codec_pipeline: CodecPipeline, config: ArrayConfig, chunk_grid: ChunkGrid, indexer: Indexer, *, prototype: BufferPrototype, out: NDBuffer | None = None, fields: Fields | None = None, ) -> NDArrayLikeOrScalar: """ Get a selection from an array. Parameters ---------- store_path : StorePath The store path of the array. metadata : ArrayMetadata The array metadata. codec_pipeline : CodecPipeline The codec pipeline for encoding/decoding. config : ArrayConfig The array configuration. indexer : Indexer The indexer specifying the selection. prototype : BufferPrototype A buffer prototype to use for the retrieved data. out : NDBuffer | None, optional An output buffer to write the data to. fields : Fields | None, optional Fields to select from structured arrays. Returns ------- NDArrayLikeOrScalar The selected data. """ # `dtype` returns the zarr dtype object for both v2 and v3 metadata. zdtype = metadata.dtype dtype = zdtype.to_native_dtype() # Determine memory order if metadata.zarr_format == 2: order = metadata.order else: order = config.order # check fields are sensible out_dtype = check_fields(fields, dtype) # setup output buffer if out is not None: if isinstance(out, NDBuffer): out_buffer = out else: raise TypeError(f"out argument needs to be an NDBuffer. Got {type(out)!r}") if out_buffer.shape != indexer.shape: raise ValueError( f"shape of out argument doesn't match. Expected {indexer.shape}, got {out.shape}" ) else: out_buffer = prototype.nd_buffer.empty( shape=indexer.shape, dtype=out_dtype, order=order, ) if product(indexer.shape) > 0: # need to use the order from the metadata for v2 _config = config if metadata.zarr_format == 2: _config = replace(_config, order=order) # reading chunks and decoding them indexed_chunks = list(indexer) # For regular grids, all chunks share the same ArraySpec, so build it once # and reuse it to avoid per-chunk ChunkGrid lookups and ArraySpec construction. regular_grid = chunk_grid.is_regular if regular_grid: regular_chunk_spec = ArraySpec( shape=chunk_grid.chunk_shape, dtype=metadata.dtype, fill_value=metadata.fill_value, config=_config, prototype=prototype, ) results = await codec_pipeline.read( [ ( store_path / metadata.encode_chunk_key(chunk_coords), regular_chunk_spec if regular_grid else _get_chunk_spec(metadata, chunk_grid, chunk_coords, _config, prototype), chunk_selection, out_selection, is_complete_chunk, ) for chunk_coords, chunk_selection, out_selection, is_complete_chunk in indexed_chunks ], out_buffer, drop_axes=indexer.drop_axes, ) if _config.read_missing_chunks is False: missing_info = [] for i, result in enumerate(results): if result["status"] == "missing": coords = indexed_chunks[i][0] key = metadata.encode_chunk_key(coords) missing_info.append(f" chunk '{key}' (grid position {coords})") if missing_info: chunks_str = "\n".join(missing_info) raise ChunkNotFoundError( f"{len(missing_info)} chunk(s) not found in store '{store_path}'.\n" f"Set the 'array.read_missing_chunks' config to True to fill " f"missing chunks with the fill value.\n" f"Missing chunks:\n{chunks_str}" ) if isinstance(indexer, BasicIndexer) and indexer.shape == (): return out_buffer.as_scalar() return out_buffer.as_ndarray_like() async def _getitem( store_path: StorePath, metadata: ArrayMetadata, codec_pipeline: CodecPipeline, config: ArrayConfig, chunk_grid: ChunkGrid, selection: BasicSelection, *, prototype: BufferPrototype | None = None, ) -> NDArrayLikeOrScalar: """ Retrieve a subset of the array's data based on the provided selection. Parameters ---------- store_path : StorePath The store path of the array. metadata : ArrayMetadata The array metadata. codec_pipeline : CodecPipeline The codec pipeline for encoding/decoding. config : ArrayConfig The array configuration. chunk_grid : ChunkGrid The chunk grid. selection : BasicSelection A selection object specifying the subset of data to retrieve. prototype : BufferPrototype, optional A buffer prototype to use for the retrieved data (default is None). Returns ------- NDArrayLikeOrScalar The retrieved subset of the array's data. """ if prototype is None: prototype = default_buffer_prototype() indexer = BasicIndexer( selection, shape=metadata.shape, chunk_grid=chunk_grid, ) return await _get_selection( store_path, metadata, codec_pipeline, config, chunk_grid, indexer, prototype=prototype ) async def _set_selection( store_path: StorePath, metadata: ArrayMetadata, codec_pipeline: CodecPipeline, config: ArrayConfig, chunk_grid: ChunkGrid, indexer: Indexer, value: npt.ArrayLike, *, prototype: BufferPrototype, fields: Fields | None = None, ) -> None: """ Set a selection in an array. Parameters ---------- store_path : StorePath The store path of the array. metadata : ArrayMetadata The array metadata. codec_pipeline : CodecPipeline The codec pipeline for encoding/decoding. config : ArrayConfig The array configuration. chunk_grid : ChunkGrid The chunk grid. indexer : Indexer The indexer specifying the selection. value : npt.ArrayLike The values to write. prototype : BufferPrototype A buffer prototype to use. fields : Fields | None, optional Fields to select from structured arrays. """ # `dtype` returns the zarr dtype object for both v2 and v3 metadata. zdtype = metadata.dtype dtype = zdtype.to_native_dtype() # check fields are sensible check_fields(fields, dtype) fields = check_no_multi_fields(fields) # check value shape if np.isscalar(value): array_like = prototype.buffer.create_zero_length().as_array_like() if isinstance(array_like, np._typing._SupportsArrayFunc): # TODO: need to handle array types that don't support __array_function__ # like PyTorch and JAX array_like_ = cast("np._typing._SupportsArrayFunc", array_like) value = np.asanyarray(value, dtype=dtype, like=array_like_) else: if not hasattr(value, "shape"): value = np.asarray(value, dtype) # assert ( # value.shape == indexer.shape # ), f"shape of value doesn't match indexer shape. Expected {indexer.shape}, got {value.shape}" if not hasattr(value, "dtype") or value.dtype.name != dtype.name: if hasattr(value, "astype"): # Handle things that are already NDArrayLike more efficiently value = value.astype(dtype=dtype, order="A") else: value = np.array(value, dtype=dtype, order="A") value = cast("NDArrayLike", value) # We accept any ndarray like object from the user and convert it # to an NDBuffer (or subclass). From this point onwards, we only pass # Buffer and NDBuffer between components. value_buffer = prototype.nd_buffer.from_ndarray_like(value) # Determine memory order if metadata.zarr_format == 2: order = metadata.order else: order = config.order # need to use the order from the metadata for v2 _config = config if metadata.zarr_format == 2: _config = replace(_config, order=order) # merging with existing data and encoding chunks # For regular grids, all chunks share the same ArraySpec, so build it once # and reuse it to avoid per-chunk ChunkGrid lookups and ArraySpec construction. regular_grid = chunk_grid.is_regular if regular_grid: regular_chunk_spec = ArraySpec( shape=chunk_grid.chunk_shape, dtype=metadata.dtype, fill_value=metadata.fill_value, config=_config, prototype=prototype, ) await codec_pipeline.write( [ ( store_path / metadata.encode_chunk_key(chunk_coords), regular_chunk_spec if regular_grid else _get_chunk_spec(metadata, chunk_grid, chunk_coords, _config, prototype), chunk_selection, out_selection, is_complete_chunk, ) for chunk_coords, chunk_selection, out_selection, is_complete_chunk in indexer ], value_buffer, drop_axes=indexer.drop_axes, ) async def _setitem( store_path: StorePath, metadata: ArrayMetadata, codec_pipeline: CodecPipeline, config: ArrayConfig, chunk_grid: ChunkGrid, selection: BasicSelection, value: npt.ArrayLike, prototype: BufferPrototype | None = None, ) -> None: """ Set values in the array using basic indexing. Parameters ---------- store_path : StorePath The store path of the array. metadata : ArrayMetadata The array metadata. codec_pipeline : CodecPipeline The codec pipeline for encoding/decoding. config : ArrayConfig The array configuration. chunk_grid : ChunkGrid The chunk grid. selection : BasicSelection The selection defining the region of the array to set. value : npt.ArrayLike The values to be written into the selected region of the array. prototype : BufferPrototype or None, optional A prototype buffer that defines the structure and properties of the array chunks being modified. If None, the default buffer prototype is used. """ if prototype is None: prototype = default_buffer_prototype() indexer = BasicIndexer( selection, shape=metadata.shape, chunk_grid=chunk_grid, ) return await _set_selection( store_path, metadata, codec_pipeline, config, chunk_grid, indexer, value, prototype=prototype, ) async def _resize( array: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata], new_shape: ShapeLike, delete_outside_chunks: bool = True, ) -> None: """ Resize an array to a new shape. Parameters ---------- array : AsyncArray The array to resize. new_shape : ShapeLike The desired new shape of the array. delete_outside_chunks : bool, optional If True (default), chunks that fall outside the new shape will be deleted. If False, the data in those chunks will be preserved. """ new_shape = parse_shapelike(new_shape) assert len(new_shape) == len(array.metadata.shape) new_metadata = array.metadata.update_shape(new_shape) new_chunk_grid = ChunkGrid.from_metadata(new_metadata) # ensure deletion is only run if array is shrinking as the delete_outside_chunks path is unbounded in memory only_growing = all(new >= old for new, old in zip(new_shape, array.metadata.shape, strict=True)) if delete_outside_chunks and not only_growing: # Remove all chunks outside of the new shape old_chunk_coords = set(array._chunk_grid.all_chunk_coords()) new_chunk_coords = set(new_chunk_grid.all_chunk_coords()) async def _delete_key(key: str) -> None: await (array.store_path / key).delete() await concurrent_map( [ (array.metadata.encode_chunk_key(chunk_coords),) for chunk_coords in old_chunk_coords.difference(new_chunk_coords) ], _delete_key, zarr_config.get("async.concurrency"), ) # Write new metadata await save_metadata(array.store_path, new_metadata) # Update metadata and chunk_grid (in place) object.__setattr__(array, "metadata", new_metadata) object.__setattr__(array, "_chunk_grid", new_chunk_grid) async def _append( array: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata], data: npt.ArrayLike, axis: int = 0, ) -> tuple[int, ...]: """ Append data to an array along the specified axis. Parameters ---------- array : AsyncArray The array to append to. data : npt.ArrayLike Data to be appended. axis : int Axis along which to append. Returns ------- new_shape : tuple[int, ...] The new shape of the array after appending. Notes ----- The size of all dimensions other than `axis` must match between the array and `data`. """ # ensure data is array-like if not hasattr(data, "shape"): data = np.asanyarray(data) self_shape_preserved = tuple(s for i, s in enumerate(array.shape) if i != axis) data_shape_preserved = tuple(s for i, s in enumerate(data.shape) if i != axis) if self_shape_preserved != data_shape_preserved: raise ValueError( f"shape of data to append is not compatible with the array. " f"The shape of the data is ({data_shape_preserved})" f"and the shape of the array is ({self_shape_preserved})." "All dimensions must match except for the dimension being " "appended." ) # remember old shape old_shape = array.shape # determine new shape new_shape = tuple( array.shape[i] if i != axis else array.shape[i] + data.shape[i] for i in range(len(array.shape)) ) # resize await _resize(array, new_shape) # store data append_selection = tuple( slice(None) if i != axis else slice(old_shape[i], new_shape[i]) for i in range(len(array.shape)) ) await _setitem( array.store_path, array.metadata, array.codec_pipeline, array.config, array._chunk_grid, append_selection, data, ) return new_shape async def _update_attributes( array: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata], new_attributes: dict[str, JSON], ) -> AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata]: """ Update the array's attributes. Parameters ---------- array : AsyncArray The array whose attributes to update. new_attributes : dict[str, JSON] A dictionary of new attributes to update or add to the array. Returns ------- AsyncArray The array with the updated attributes. """ array.metadata.attributes.update(new_attributes) # Write new metadata await save_metadata(array.store_path, array.metadata) return array async def _info_complete( array: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata], ) -> Any: """ Return all the information for an array, including dynamic information like storage size. Parameters ---------- array : AsyncArray The array to get info for. Returns ------- ArrayInfo Complete information about the array including: - The count of chunks initialized - The sum of the bytes written """ return array._info( await _nshards_initialized(array), await array.store_path.store.getsize_prefix(array.store_path.path), ) zarr-python-3.3.0/src/zarr/core/array_spec.py000066400000000000000000000150421523267620000212160ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass, fields from typing import TYPE_CHECKING, Any, Literal, Self, TypedDict, cast import numpy as np from zarr.core.common import ( MemoryOrder, parse_bool, parse_fill_value, parse_int, parse_order, parse_shapelike, ) from zarr.core.config import config as zarr_config if TYPE_CHECKING: from typing import NotRequired from zarr.core.buffer import BufferPrototype from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType class ArrayConfigParams(TypedDict): """ A TypedDict model of the attributes of an ArrayConfig class, but with no required fields. This allows for partial construction of an ArrayConfig, with the assumption that the unset keys will be taken from a global configuration. """ order: NotRequired[MemoryOrder] write_empty_chunks: NotRequired[bool] read_missing_chunks: NotRequired[bool] sharding_coalesce_max_gap_bytes: NotRequired[int] sharding_coalesce_max_bytes: NotRequired[int] @dataclass(frozen=True) class ArrayConfig: """ A model of the runtime configuration of an array. Parameters ---------- order : MemoryOrder The memory layout of the arrays returned when reading data from the store. write_empty_chunks : bool If True, empty chunks will be written to the store. read_missing_chunks : bool If True, missing chunks will be filled with the array's fill value on read. If False, reading missing chunks will raise a ``ChunkNotFoundError``. sharding_coalesce_max_gap_bytes : int When reading multiple chunks from the same shard, nearby byte ranges separated by no more than this many bytes are coalesced into a single request to the store. sharding_coalesce_max_bytes : int Requests will not be coalesced if doing so would exceed this byte size. """ order: MemoryOrder write_empty_chunks: bool read_missing_chunks: bool sharding_coalesce_max_gap_bytes: int sharding_coalesce_max_bytes: int def __init__( self, order: MemoryOrder, write_empty_chunks: bool, *, read_missing_chunks: bool = True, sharding_coalesce_max_gap_bytes: int = 1 << 20, # 1 MiB sharding_coalesce_max_bytes: int = 16 << 20, # 16 MiB ) -> None: order_parsed = parse_order(order) write_empty_chunks_parsed = parse_bool(write_empty_chunks) read_missing_chunks_parsed = parse_bool(read_missing_chunks) sharding_coalesce_max_gap_bytes_parsed = parse_int(sharding_coalesce_max_gap_bytes) sharding_coalesce_max_bytes_parsed = parse_int(sharding_coalesce_max_bytes) object.__setattr__(self, "order", order_parsed) object.__setattr__(self, "write_empty_chunks", write_empty_chunks_parsed) object.__setattr__(self, "read_missing_chunks", read_missing_chunks_parsed) object.__setattr__( self, "sharding_coalesce_max_gap_bytes", sharding_coalesce_max_gap_bytes_parsed ) object.__setattr__(self, "sharding_coalesce_max_bytes", sharding_coalesce_max_bytes_parsed) @classmethod def from_dict(cls, data: ArrayConfigParams) -> Self: """ Create an ArrayConfig from a dict. The keys of that dict are a subset of the attributes of the ArrayConfig class. Any keys missing from that dict will be set to the the values in the ``array`` namespace of ``zarr.config``. """ kwargs_out: ArrayConfigParams = {} for f in fields(ArrayConfig): field_name = cast( "Literal['order', 'write_empty_chunks', 'read_missing_chunks', 'sharding_coalesce_max_gap_bytes', 'sharding_coalesce_max_bytes']", f.name, ) if field_name not in data: kwargs_out[field_name] = zarr_config.get(f"array.{field_name}") else: kwargs_out[field_name] = data[field_name] return cls(**kwargs_out) def to_dict(self) -> ArrayConfigParams: """ Serialize an instance of this class to a dict. """ return { "order": self.order, "write_empty_chunks": self.write_empty_chunks, "read_missing_chunks": self.read_missing_chunks, "sharding_coalesce_max_gap_bytes": self.sharding_coalesce_max_gap_bytes, "sharding_coalesce_max_bytes": self.sharding_coalesce_max_bytes, } ArrayConfigLike = ArrayConfig | ArrayConfigParams def parse_array_config(data: ArrayConfigLike | None) -> ArrayConfig: """ Convert various types of data to an ArrayConfig. """ if data is None: return ArrayConfig.from_dict({}) elif isinstance(data, ArrayConfig): return data else: return ArrayConfig.from_dict(data) @dataclass(frozen=True, eq=False) class ArraySpec: shape: tuple[int, ...] dtype: ZDType[TBaseDType, TBaseScalar] fill_value: Any config: ArrayConfig prototype: BufferPrototype def __init__( self, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], fill_value: Any, config: ArrayConfig, prototype: BufferPrototype, ) -> None: shape_parsed = parse_shapelike(shape) fill_value_parsed = parse_fill_value(fill_value) object.__setattr__(self, "shape", shape_parsed) object.__setattr__(self, "dtype", dtype) object.__setattr__(self, "fill_value", fill_value_parsed) object.__setattr__(self, "config", config) object.__setattr__(self, "prototype", prototype) def _key(self) -> tuple[object, ...]: """Returns the tuple used for equality/hash identity.""" fill_value = self.fill_value if isinstance(fill_value, np.generic): # fill_values should be byte-identical, otherwise they correspond to different values in memory / on disk. # Importantly, this ensures np.nan == np.nan, NaT == NaT, and -0.0 != 0.0. # It also fixes np.void fill_values being unhashable (#3054). fill_value = fill_value.tobytes() return (self.shape, self.dtype, fill_value, self.config, self.prototype) def __eq__(self, other: object) -> bool: if not isinstance(other, ArraySpec): return NotImplemented return self._key() == other._key() def __hash__(self) -> int: return hash(self._key()) @property def ndim(self) -> int: return len(self.shape) @property def order(self) -> MemoryOrder: return self.config.order zarr-python-3.3.0/src/zarr/core/attributes.py000066400000000000000000000032271523267620000212560ustar00rootroot00000000000000from __future__ import annotations from collections.abc import MutableMapping from typing import TYPE_CHECKING from zarr.core.common import JSON if TYPE_CHECKING: from collections.abc import Iterator from zarr.core.group import Group from zarr.types import AnyArray class Attributes(MutableMapping[str, JSON]): def __init__(self, obj: AnyArray | Group) -> None: # key=".zattrs", read_only=False, cache=True, synchronizer=None self._obj = obj def __getitem__(self, key: str) -> JSON: return self._obj.metadata.attributes[key] def __setitem__(self, key: str, value: JSON) -> None: new_attrs = dict(self._obj.metadata.attributes) new_attrs[key] = value self._obj = self._obj.update_attributes(new_attrs) def __delitem__(self, key: str) -> None: new_attrs = dict(self._obj.metadata.attributes) del new_attrs[key] self.put(new_attrs) def __iter__(self) -> Iterator[str]: return iter(self._obj.metadata.attributes) def __len__(self) -> int: return len(self._obj.metadata.attributes) def put(self, d: dict[str, JSON]) -> None: """ Overwrite all attributes with the values from `d`. Equivalent to the following pseudo-code, but performed atomically. ```python attrs = {"a": 1, "b": 2} attrs.clear() attrs.update({"a": "3", "c": 4}) print(attrs) #> {'a': '3', 'c': 4} ``` """ self._obj.metadata.attributes.clear() self._obj = self._obj.update_attributes(d) def asdict(self) -> dict[str, JSON]: return dict(self._obj.metadata.attributes) zarr-python-3.3.0/src/zarr/core/buffer/000077500000000000000000000000001523267620000177635ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/core/buffer/__init__.py000066400000000000000000000006451523267620000221010ustar00rootroot00000000000000from zarr.core.buffer.core import ( ArrayLike, Buffer, BufferPrototype, NDArrayLike, NDArrayLikeOrScalar, NDBuffer, default_buffer_prototype, ) from zarr.core.buffer.cpu import numpy_buffer_prototype __all__ = [ "ArrayLike", "Buffer", "BufferPrototype", "NDArrayLike", "NDArrayLikeOrScalar", "NDBuffer", "default_buffer_prototype", "numpy_buffer_prototype", ] zarr-python-3.3.0/src/zarr/core/buffer/core.py000066400000000000000000000435261523267620000212770ustar00rootroot00000000000000from __future__ import annotations import sys from abc import ABC, abstractmethod from collections.abc import Iterable from typing import ( TYPE_CHECKING, Any, Literal, NamedTuple, Protocol, SupportsIndex, cast, runtime_checkable, ) import numpy as np import numpy.typing as npt if TYPE_CHECKING: from collections.abc import Iterable, Sequence from typing import Self from zarr.codecs.bytes import EndianLiteral from zarr.core.common import BytesLike # Everything here is imported into ``zarr.core.buffer`` namespace. __all__: list[str] = [] @runtime_checkable class ArrayLike(Protocol): """Protocol for the array-like type that underlie Buffer""" @property def dtype(self) -> np.dtype[Any]: ... @property def ndim(self) -> int: ... @property def size(self) -> int: ... def __getitem__(self, key: slice) -> Self: ... def __setitem__(self, key: slice, value: Any) -> None: ... def copy(self) -> Self: ... @runtime_checkable class NDArrayLike(Protocol): """Protocol for the nd-array-like type that underlie NDBuffer""" @property def dtype(self) -> np.dtype[Any]: ... @property def ndim(self) -> int: ... @property def size(self) -> int: ... @property def shape(self) -> tuple[int, ...]: ... def __len__(self) -> int: ... def __getitem__(self, key: slice) -> Self: ... def __setitem__(self, key: slice, value: Any) -> None: ... def __array__(self) -> npt.NDArray[Any]: ... def reshape( self, shape: tuple[int, ...], /, *, order: Literal["A", "C", "F"] | None = ..., copy: bool | None = ..., ) -> NDArrayLike: ... def view(self, dtype: npt.DTypeLike) -> Self: ... def astype( self, dtype: npt.DTypeLike, order: Literal["K", "A", "C", "F"] = ..., *, copy: bool = ..., ) -> Self: ... def fill(self, value: Any) -> None: ... def copy(self) -> Self: ... def transpose(self, axes: SupportsIndex | Sequence[SupportsIndex] | None) -> Self: ... def ravel(self, order: Literal["K", "A", "C", "F"] = ...) -> Self: ... def all(self) -> np.bool_: ... def __eq__(self, other: object) -> Self: # type: ignore[override] """Element-wise equal Notes ----- Type checkers such as mypy complains because the return type isn't a bool like its supertype "object", which violates the Liskov substitution principle. This is true, but since NumPy's ndarray is defined as an element-wise equal, our hands are tied. """ ScalarType = int | float | complex | bytes | str | bool | np.generic NDArrayLikeOrScalar = ScalarType | NDArrayLike def check_item_key_is_1d_contiguous(key: Any) -> None: """Raises error if `key` isn't a 1d contiguous slice""" if not isinstance(key, slice): raise TypeError( f"Item key has incorrect type (expected slice, got {key.__class__.__name__})" ) if not (key.step is None or key.step == 1): raise ValueError("slice must be contiguous") class Buffer(ABC): """A flat contiguous memory block We use Buffer throughout Zarr to represent a contiguous block of memory. A Buffer is backed by an underlying array-like instance that represents the memory. The memory type is unspecified; can be regular host memory, CUDA device memory, or something else. The only requirement is that the array-like instance can be copied/converted to a regular Numpy array (host memory). Notes ----- This buffer is untyped, so all indexing and sizes are in bytes. Parameters ---------- array_like array-like object that must be 1-dim, contiguous, and byte dtype. """ def __init__(self, array_like: ArrayLike) -> None: if array_like.ndim != 1: raise ValueError("array_like: only 1-dim allowed") if array_like.dtype != np.dtype("B"): raise ValueError("array_like: only byte dtype allowed") self._data = array_like @classmethod @abstractmethod def create_zero_length(cls) -> Self: """Create an empty buffer with length zero Returns ------- New empty 0-length buffer """ if cls is Buffer: raise NotImplementedError("Cannot call abstract method on the abstract class 'Buffer'") return cls( cast("ArrayLike", None) ) # This line will never be reached, but it satisfies the type checker @classmethod def from_array_like(cls, array_like: ArrayLike) -> Self: """Create a new buffer of an array-like object Parameters ---------- array_like array-like object that must be 1-dim, contiguous, and byte dtype. Returns ------- New buffer representing `array_like` """ return cls(array_like) @classmethod @abstractmethod def from_buffer(cls, buffer: Buffer) -> Self: """Create a new buffer of an existing Buffer This is useful if you want to ensure that an existing buffer is of the correct subclass of Buffer. E.g., MemoryStore uses this to return a buffer instance of the subclass specified by its BufferPrototype argument. Typically, this only copies data if the data has to be moved between memory types, such as from host to device memory. Parameters ---------- buffer buffer object. Returns ------- A new buffer representing the content of the input buffer Notes ----- Subclasses of `Buffer` must override this method to implement more optimal conversions that avoid copies where possible """ if cls is Buffer: raise NotImplementedError("Cannot call abstract method on the abstract class 'Buffer'") return cls( cast("ArrayLike", None) ) # This line will never be reached, but it satisfies the type checker @classmethod @abstractmethod def from_bytes(cls, bytes_like: BytesLike) -> Self: """Create a new buffer of a bytes-like object (host memory) Parameters ---------- bytes_like bytes-like object Returns ------- New buffer representing `bytes_like` """ if cls is Buffer: raise NotImplementedError("Cannot call abstract method on the abstract class 'Buffer'") return cls( cast("ArrayLike", None) ) # This line will never be reached, but it satisfies the type checker def as_array_like(self) -> ArrayLike: """Returns the underlying array (host or device memory) of this buffer This will never copy data. Returns ------- The underlying 1d array such as a NumPy or CuPy array. """ return self._data @abstractmethod def as_numpy_array(self) -> npt.NDArray[Any]: """Returns the buffer as a NumPy array (host memory). Notes ----- Might have to copy data, consider using `.as_array_like()` instead. Returns ------- NumPy array of this buffer (might be a data copy) """ ... def as_buffer_like(self) -> BytesLike: """Returns the buffer as an object that implements the Python buffer protocol. Notes ----- Might have to copy data, since the implementation uses `.as_numpy_array()`. Returns ------- An object that implements the Python buffer protocol """ return memoryview(self.as_numpy_array()) def to_bytes(self) -> bytes: """Returns the buffer as `bytes` (host memory). Warnings -------- Will always copy data, only use this method for small buffers such as metadata buffers. If possible, use `.as_numpy_array()` or `.as_array_like()` instead. Returns ------- `bytes` of this buffer (data copy) """ return bytes(self.as_numpy_array()) def __getitem__(self, key: slice) -> Self: check_item_key_is_1d_contiguous(key) return self.__class__(self._data.__getitem__(key)) def __setitem__(self, key: slice, value: Any) -> None: check_item_key_is_1d_contiguous(key) self._data.__setitem__(key, value) def __len__(self) -> int: return self._data.size @abstractmethod def combine(self, others: Iterable[Buffer]) -> Self: """Concatenate many buffers""" ... def __add__(self, other: Buffer) -> Self: """Concatenate two buffers""" return self.combine([other]) def __eq__(self, other: object) -> bool: # Another Buffer class can override this to choose a more efficient path return isinstance(other, Buffer) and np.array_equal( self.as_numpy_array(), other.as_numpy_array() ) class NDBuffer: """An n-dimensional memory block We use NDBuffer throughout Zarr to represent a n-dimensional memory block. An NDBuffer is backed by an underlying ndarray-like instance that represents the memory. The memory type is unspecified; can be regular host memory, CUDA device memory, or something else. The only requirement is that the ndarray-like instance can be copied/converted to a regular Numpy array (host memory). Notes ----- The two buffer classes Buffer and NDBuffer are very similar. In fact, Buffer is a special case of NDBuffer where dim=1, stride=1, and dtype="B". However, in order to use Python's type system to differentiate between the contiguous Buffer and the n-dim (non-contiguous) NDBuffer, we keep the definition of the two classes separate. Parameters ---------- array : ndarray_like ndarray-like object that is convertible to a regular Numpy array. """ def __init__(self, array: NDArrayLike) -> None: self._data = array @classmethod @abstractmethod def create( cls, *, shape: Iterable[int], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C", fill_value: Any | None = None, ) -> Self: """Create a new buffer and its underlying ndarray-like object Parameters ---------- shape The shape of the buffer and its underlying ndarray-like object dtype The datatype of the buffer and its underlying ndarray-like object order Whether to store multi-dimensional data in row-major (C-style) or column-major (Fortran-style) order in memory. fill_value If not None, fill the new buffer with a scalar value. Returns ------- New buffer representing a new ndarray_like object Notes ----- A subclass can overwrite this method to create an ndarray-like object other then the default Numpy array. """ if cls is NDBuffer: raise NotImplementedError( "Cannot call abstract method on the abstract class 'NDBuffer'" ) return cls( cast("NDArrayLike", None) ) # This line will never be reached, but it satisfies the type checker @classmethod def empty( cls, shape: tuple[int, ...], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C" ) -> Self: """ Create an empty buffer with the given shape, dtype, and order. This method can be faster than ``NDBuffer.create`` because it doesn't have to initialize the memory used by the underlying ndarray-like object. Parameters ---------- shape The shape of the buffer and its underlying ndarray-like object dtype The datatype of the buffer and its underlying ndarray-like object order Whether to store multi-dimensional data in row-major (C-style) or column-major (Fortran-style) order in memory. Returns ------- buffer New buffer representing a new ndarray_like object with empty data. See Also -------- NDBuffer.create Create a new buffer with some initial fill value. """ # Implementations should override this method if they have a faster way # to allocate an empty buffer. return cls.create(shape=shape, dtype=dtype, order=order) @classmethod def from_ndarray_like(cls, ndarray_like: NDArrayLike) -> Self: """Create a new buffer of an ndarray-like object Parameters ---------- ndarray_like ndarray-like object Returns ------- New buffer representing `ndarray_like` """ return cls(ndarray_like) @classmethod @abstractmethod def from_numpy_array(cls, array_like: npt.ArrayLike) -> Self: """Create a new buffer of Numpy array-like object Parameters ---------- array_like Object that can be coerced into a Numpy array Returns ------- New buffer representing `array_like` """ if cls is NDBuffer: raise NotImplementedError( "Cannot call abstract method on the abstract class 'NDBuffer'" ) return cls( cast("NDArrayLike", None) ) # This line will never be reached, but it satisfies the type checker def as_ndarray_like(self) -> NDArrayLike: """Returns the underlying array (host or device memory) of this buffer This will never copy data. Returns ------- The underlying array such as a NumPy or CuPy array. """ return self._data @abstractmethod def as_numpy_array(self) -> npt.NDArray[Any]: """Returns the buffer as a NumPy array (host memory). Warnings -------- Might have to copy data, consider using `.as_ndarray_like()` instead. Returns ------- NumPy array of this buffer (might be a data copy) """ ... def as_scalar(self) -> ScalarType: """Returns the buffer as a scalar value""" if self._data.size != 1: raise ValueError("Buffer does not contain a single scalar value") return cast("ScalarType", self.as_numpy_array()[()]) @property def dtype(self) -> np.dtype[Any]: return self._data.dtype @property def shape(self) -> tuple[int, ...]: return self._data.shape @property def byteorder(self) -> EndianLiteral: if self.dtype.byteorder == "<": return "little" elif self.dtype.byteorder == ">": return "big" else: return sys.byteorder def reshape(self, newshape: tuple[int, ...] | Literal[-1]) -> Self: # numpy accepts a bare -1, but the NDArrayLike protocol only types the # tuple form; normalize so the forwarded value matches the protocol. shape = (newshape,) if newshape == -1 else newshape return self.__class__(self._data.reshape(shape)) def squeeze(self, axis: tuple[int, ...]) -> Self: newshape = tuple(a for i, a in enumerate(self.shape) if i not in axis) return self.__class__(self._data.reshape(newshape)) def astype(self, dtype: npt.DTypeLike, order: Literal["K", "A", "C", "F"] = "K") -> Self: return self.__class__(self._data.astype(dtype=dtype, order=order)) @abstractmethod def __getitem__(self, key: Any) -> Self: ... @abstractmethod def __setitem__(self, key: Any, value: Any) -> None: ... def __len__(self) -> int: return self._data.__len__() def __repr__(self) -> str: return f"" def all_equal(self, other: Any, equal_nan: bool = True) -> bool: """Compare to `other` using np.array_equal.""" if other is None: # Handle None fill_value for Zarr V2 return False # Handle positive and negative zero by comparing bit patterns: if ( np.asarray(other).dtype.kind == "f" and other == 0.0 and self._data.dtype.kind not in ("U", "S", "T", "O", "V") ): _data, other = np.broadcast_arrays(self._data, np.asarray(other, self._data.dtype)) void_dtype = f"V{_data.dtype.itemsize}" return np.array_equal(_data.view(void_dtype), other.view(void_dtype)) # use array_equal to obtain equal_nan=True functionality # Since fill-value is a scalar, isn't there a faster path than allocating a new array for fill value # every single time we have to write data? _data, other = np.broadcast_arrays(self._data, other) return np.array_equal( _data, other, equal_nan=equal_nan if self._data.dtype.kind not in ("U", "S", "T", "O", "V") else False, ) def fill(self, value: Any) -> None: self._data.fill(value) def copy(self) -> Self: return self.__class__(self._data.copy()) def transpose(self, axes: SupportsIndex | Sequence[SupportsIndex] | None) -> Self: return self.__class__(self._data.transpose(axes)) class BufferPrototype(NamedTuple): """Prototype of the Buffer and NDBuffer class The protocol must be pickable. Attributes ---------- buffer The Buffer class to use when Zarr needs to create new Buffer. nd_buffer The NDBuffer class to use when Zarr needs to create new NDBuffer. """ buffer: type[Buffer] nd_buffer: type[NDBuffer] # The default buffer prototype used throughout the Zarr codebase. def default_buffer_prototype() -> BufferPrototype: from zarr.registry import ( get_buffer_class, get_ndbuffer_class, ) return BufferPrototype(buffer=get_buffer_class(), nd_buffer=get_ndbuffer_class()) zarr-python-3.3.0/src/zarr/core/buffer/cpu.py000066400000000000000000000170121523267620000211250ustar00rootroot00000000000000from __future__ import annotations from typing import ( TYPE_CHECKING, Any, Literal, ) import numpy as np import numpy.typing as npt from zarr.core.buffer import core from zarr.registry import ( register_buffer, register_ndbuffer, ) if TYPE_CHECKING: from collections.abc import Callable, Iterable from typing import Self from zarr.core.buffer.core import ArrayLike, NDArrayLike from zarr.core.common import BytesLike class Buffer(core.Buffer): """A flat contiguous memory block We use Buffer throughout Zarr to represent a contiguous block of memory. A Buffer is backed by an underlying array-like instance that represents the memory. The memory type is unspecified; can be regular host memory, CUDA device memory, or something else. The only requirement is that the array-like instance can be copied/converted to a regular Numpy array (host memory). Notes ----- This buffer is untyped, so all indexing and sizes are in bytes. Parameters ---------- array_like array-like object that must be 1-dim, contiguous, and byte dtype. """ def __init__(self, array_like: ArrayLike) -> None: super().__init__(array_like) @classmethod def create_zero_length(cls) -> Self: return cls(np.array([], dtype="B")) @classmethod def from_buffer(cls, buffer: core.Buffer) -> Self: """Create a new buffer of an existing Buffer This is useful if you want to ensure that an existing buffer is of the correct subclass of Buffer. E.g., MemoryStore uses this to return a buffer instance of the subclass specified by its BufferPrototype argument. Typically, this only copies data if the data has to be moved between memory types, such as from host to device memory. Parameters ---------- buffer buffer object. Returns ------- A new buffer representing the content of the input buffer Notes ----- Subclasses of `Buffer` must override this method to implement more optimal conversions that avoid copies where possible """ return cls.from_array_like(buffer.as_numpy_array()) @classmethod def from_bytes(cls, bytes_like: BytesLike) -> Self: """Create a new buffer of a bytes-like object (host memory) Parameters ---------- bytes_like bytes-like object Returns ------- New buffer representing `bytes_like` """ return cls.from_array_like(np.frombuffer(bytes_like, dtype="B")) def as_numpy_array(self) -> npt.NDArray[Any]: """Returns the buffer as a NumPy array (host memory). Notes ----- Might have to copy data, consider using `.as_array_like()` instead. Returns ------- NumPy array of this buffer (might be a data copy) """ return np.asanyarray(self._data) def combine(self, others: Iterable[core.Buffer]) -> Self: data = [np.asanyarray(self._data)] for buf in others: other_array = buf.as_array_like() assert other_array.dtype == np.dtype("B") data.append(np.asanyarray(other_array)) return self.__class__(np.concatenate(data)) class NDBuffer(core.NDBuffer): """An n-dimensional memory block We use NDBuffer throughout Zarr to represent a n-dimensional memory block. An NDBuffer is backed by an underlying ndarray-like instance that represents the memory. The memory type is unspecified; can be regular host memory, CUDA device memory, or something else. The only requirement is that the ndarray-like instance can be copied/converted to a regular Numpy array (host memory). Notes ----- The two buffer classes Buffer and NDBuffer are very similar. In fact, Buffer is a special case of NDBuffer where dim=1, stride=1, and dtype="B". However, in order to use Python's type system to differentiate between the contiguous Buffer and the n-dim (non-contiguous) NDBuffer, we keep the definition of the two classes separate. Parameters ---------- array ndarray-like object that is convertible to a regular Numpy array. """ def __init__(self, array: NDArrayLike) -> None: super().__init__(array) @classmethod def create( cls, *, shape: Iterable[int], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C", fill_value: Any | None = None, ) -> Self: # np.zeros is much faster than np.full, and therefore using it when possible is better. if fill_value is None or (isinstance(fill_value, int) and fill_value == 0): return cls(np.zeros(shape=tuple(shape), dtype=dtype, order=order)) else: return cls(np.full(shape=tuple(shape), fill_value=fill_value, dtype=dtype, order=order)) @classmethod def empty( cls, shape: tuple[int, ...], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C" ) -> Self: return cls(np.empty(shape=shape, dtype=dtype, order=order)) @classmethod def from_numpy_array(cls, array_like: npt.ArrayLike) -> Self: return cls.from_ndarray_like(np.asanyarray(array_like)) def as_numpy_array(self) -> npt.NDArray[Any]: """Returns the buffer as a NumPy array (host memory). Warnings -------- Might have to copy data, consider using `.as_ndarray_like()` instead. Returns ------- NumPy array of this buffer (might be a data copy) """ return np.asanyarray(self._data) def __getitem__(self, key: Any) -> Self: return self.__class__(np.asanyarray(self._data.__getitem__(key))) def __setitem__(self, key: Any, value: Any) -> None: if isinstance(value, NDBuffer): value = value._data self._data.__setitem__(key, value) def as_numpy_array_wrapper( func: Callable[[npt.NDArray[Any]], bytes], buf: core.Buffer, prototype: core.BufferPrototype ) -> core.Buffer: """Converts the input of `func` to a numpy array and the output back to `Buffer`. This function is useful when calling a `func` that only support host memory such as `GZip.decode` and `Blosc.decode`. In this case, use this wrapper to convert the input `buf` to a Numpy array and convert the result back into a `Buffer`. Parameters ---------- func The callable that will be called with the converted `buf` as input. `func` must return bytes, which will be converted into a `Buffer` before returned. buf The buffer that will be converted to a Numpy array before given as input to `func`. prototype The prototype of the output buffer. Returns ------- The result of `func` converted to a `Buffer` """ return prototype.buffer.from_bytes(func(buf.as_numpy_array())) # CPU buffer prototype using numpy arrays buffer_prototype = core.BufferPrototype(buffer=Buffer, nd_buffer=NDBuffer) # default_buffer_prototype = buffer_prototype # The numpy prototype used for E.g. when reading the shard index def numpy_buffer_prototype() -> core.BufferPrototype: return core.BufferPrototype(buffer=Buffer, nd_buffer=NDBuffer) register_buffer(Buffer, qualname="zarr.buffer.cpu.Buffer") register_ndbuffer(NDBuffer, qualname="zarr.buffer.cpu.NDBuffer") # backwards compatibility register_buffer(Buffer, qualname="zarr.core.buffer.cpu.Buffer") register_ndbuffer(NDBuffer, qualname="zarr.core.buffer.cpu.NDBuffer") zarr-python-3.3.0/src/zarr/core/buffer/gpu.py000066400000000000000000000171411523267620000211340ustar00rootroot00000000000000from __future__ import annotations import warnings from typing import ( TYPE_CHECKING, Any, Literal, cast, ) import numpy as np import numpy.typing as npt from zarr.core.buffer import core from zarr.core.buffer.core import ArrayLike, BufferPrototype, NDArrayLike from zarr.errors import ZarrUserWarning from zarr.registry import ( register_buffer, register_ndbuffer, ) if TYPE_CHECKING: from collections.abc import Iterable from typing import Self from zarr.core.common import BytesLike try: import cupy as cp except ImportError: cp = None class Buffer(core.Buffer): """A flat contiguous memory block on the GPU We use Buffer throughout Zarr to represent a contiguous block of memory. A Buffer is backed by an underlying array-like instance that represents the memory. The memory type is unspecified; can be regular host memory, CUDA device memory, or something else. The only requirement is that the array-like instance can be copied/converted to a regular Numpy array (host memory). Notes ----- This buffer is untyped, so all indexing and sizes are in bytes. Parameters ---------- array_like array-like object that must be 1-dim, contiguous, and byte dtype. """ def __init__(self, array_like: ArrayLike) -> None: if cp is None: raise ImportError( "Cannot use zarr.buffer.gpu.Buffer without cupy. Please install cupy." ) if array_like.ndim != 1: raise ValueError("array_like: only 1-dim allowed") if array_like.dtype != np.dtype("B"): raise ValueError("array_like: only byte dtype allowed") if not hasattr(array_like, "__cuda_array_interface__"): # Slow copy based path for arrays that don't support the __cuda_array_interface__ # TODO: Add a fast zero-copy path for arrays that support the dlpack protocol msg = ( "Creating a zarr.buffer.gpu.Buffer with an array that does not support the " "__cuda_array_interface__ for zero-copy transfers, " "falling back to slow copy based path" ) warnings.warn( msg, category=ZarrUserWarning, stacklevel=2, ) self._data = cp.asarray(array_like) @classmethod def create_zero_length(cls) -> Self: """Create an empty buffer with length zero Returns ------- New empty 0-length buffer """ return cls(cp.array([], dtype="B")) @classmethod def from_buffer(cls, buffer: core.Buffer) -> Self: """Create a GPU Buffer given an arbitrary Buffer This will try to be zero-copy if `buffer` is already on the GPU and will trigger a copy if not. Returns ------- New GPU Buffer constructed from `buffer` """ return cls(buffer.as_array_like()) @classmethod def from_bytes(cls, bytes_like: BytesLike) -> Self: return cls.from_array_like(cp.frombuffer(bytes_like, dtype="B")) def as_numpy_array(self) -> npt.NDArray[Any]: return cast("npt.NDArray[Any]", cp.asnumpy(self._data)) def combine(self, others: Iterable[core.Buffer]) -> Self: data = [cp.asanyarray(self._data)] for other in others: other_array = other.as_array_like() assert other_array.dtype == np.dtype("B") gpu_other = Buffer(other_array) gpu_other_array = gpu_other.as_array_like() data.append(cp.asanyarray(gpu_other_array)) return self.__class__(cp.concatenate(data)) class NDBuffer(core.NDBuffer): """A n-dimensional memory block on the GPU We use NDBuffer throughout Zarr to represent a n-dimensional memory block. An NDBuffer is backed by an underlying ndarray-like instance that represents the memory. The memory type is unspecified; can be regular host memory, CUDA device memory, or something else. The only requirement is that the ndarray-like instance can be copied/converted to a regular Numpy array (host memory). Notes ----- The two buffer classes Buffer and NDBuffer are very similar. In fact, Buffer is a special case of NDBuffer where dim=1, stride=1, and dtype="B". However, in order to use Python's type system to differentiate between the contiguous Buffer and the n-dim (non-contiguous) NDBuffer, we keep the definition of the two classes separate. Parameters ---------- array ndarray-like object that is convertible to a regular Numpy array. """ def __init__(self, array: NDArrayLike) -> None: if cp is None: raise ImportError( "Cannot use zarr.buffer.gpu.NDBuffer without cupy. Please install cupy." ) # assert array.ndim > 0 assert array.dtype != object self._data = array if not hasattr(array, "__cuda_array_interface__"): # Slow copy based path for arrays that don't support the __cuda_array_interface__ # TODO: Add a fast zero-copy path for arrays that support the dlpack protocol msg = ( "Creating a zarr.buffer.gpu.NDBuffer with an array that does not support the " "__cuda_array_interface__ for zero-copy transfers, " "falling back to slow copy based path" ) warnings.warn( msg, stacklevel=2, ) self._data = cp.asarray(array) @classmethod def create( cls, *, shape: Iterable[int], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C", fill_value: Any | None = None, ) -> Self: ret = cls(cp.empty(shape=tuple(shape), dtype=dtype, order=order)) if fill_value is not None: ret.fill(fill_value) return ret @classmethod def empty( cls, shape: tuple[int, ...], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C" ) -> Self: return cls(cp.empty(shape=shape, dtype=dtype, order=order)) @classmethod def from_numpy_array(cls, array_like: npt.ArrayLike) -> Self: """Create a new buffer of Numpy array-like object Parameters ---------- array_like Object that can be coerced into a Numpy array Returns ------- New buffer representing `array_like` """ return cls(cp.asarray(array_like)) def as_numpy_array(self) -> npt.NDArray[Any]: """Returns the buffer as a NumPy array (host memory). Warnings -------- Might have to copy data, consider using `.as_ndarray_like()` instead. Returns ------- NumPy array of this buffer (might be a data copy) """ return cast("npt.NDArray[Any]", cp.asnumpy(self._data)) def __getitem__(self, key: Any) -> Self: return self.__class__(self._data.__getitem__(key)) def __setitem__(self, key: Any, value: Any) -> None: if isinstance(value, NDBuffer): value = value._data elif isinstance(value, core.NDBuffer): gpu_value = NDBuffer(value.as_ndarray_like()) value = gpu_value._data self._data.__setitem__(key, value) buffer_prototype = BufferPrototype(buffer=Buffer, nd_buffer=NDBuffer) register_buffer(Buffer, qualname="zarr.buffer.gpu.Buffer") register_ndbuffer(NDBuffer, qualname="zarr.buffer.gpu.NDBuffer") # backwards compatibility register_buffer(Buffer, qualname="zarr.core.buffer.gpu.Buffer") register_ndbuffer(NDBuffer, qualname="zarr.core.buffer.gpu.NDBuffer") zarr-python-3.3.0/src/zarr/core/chunk_grids.py000066400000000000000000001056431523267620000213750ustar00rootroot00000000000000from __future__ import annotations import bisect import itertools import math import numbers import operator import warnings from dataclasses import dataclass, field from functools import reduce from typing import ( TYPE_CHECKING, Any, NamedTuple, NewType, Protocol, TypeGuard, cast, runtime_checkable, ) import numpy as np import numpy.typing as npt import zarr from zarr.core.common import ( ShapeLike, ceildiv, parse_shapelike, ) from zarr.errors import ZarrUserWarning if TYPE_CHECKING: from collections.abc import Iterable, Iterator, Sequence from zarr.core.array import ShardsLike from zarr.core.metadata import ArrayMetadata SHARDED_INNER_CHUNK_MAX_BYTES: int = 1048576 """Target ceiling in bytes for the auto-chunking heuristic when sharding is active (1 MiB). Applied when `chunks` is left to auto-chunking (`None` or `"auto"`) and `shards` is not `None`. Explicit chunk sizes are not affected by this value. """ ChunksTuple = NewType("ChunksTuple", tuple[np.ndarray[tuple[int], np.dtype[np.int64]], ...]) """Normalized chunk specification: one 1D int64 array of chunk sizes per dimension. Produced exclusively by `normalize_chunks_nd` and `guess_chunks`. Consumers should use this type to ensure they receive validated, canonical chunk specifications rather than raw user input. """ class ChunkLayout(NamedTuple): """Result of resolving user `chunks`/`shards` into grid metadata inputs. outer_chunks Chunk sizes for the chunk grid metadata. When sharding is active these are the shard sizes; otherwise they are the user's chunk sizes. inner Recursive sub-structure inside each chunk. `None` means the chunk is opaque (no sharding). When present, `inner.outer_chunks` gives the sub-chunk sizes passed to `ShardingCodec`, and `inner.inner` gives the next level of nesting (for nested sharding), or `None`. """ outer_chunks: ChunksTuple inner: ChunkLayout | None = None @dataclass(frozen=True) class FixedDimension: """Uniform chunk size. Boundary chunks contain less data but are encoded at full size by the codec pipeline.""" size: int # chunk edge length (>= 0) extent: int # array dimension length nchunks: int = field(init=False, repr=False) ngridcells: int = field(init=False, repr=False) def __post_init__(self) -> None: if self.size < 0: raise ValueError(f"FixedDimension size must be >= 0, got {self.size}") if self.extent < 0: raise ValueError(f"FixedDimension extent must be >= 0, got {self.extent}") if self.size == 0: n = 0 else: n = ceildiv(self.extent, self.size) object.__setattr__(self, "nchunks", n) object.__setattr__(self, "ngridcells", n) def index_to_chunk(self, idx: int) -> int: if idx < 0: raise IndexError(f"Negative index {idx} is not allowed") if idx >= self.extent: raise IndexError(f"Index {idx} is out of bounds for extent {self.extent}") if self.size == 0: return 0 return idx // self.size def chunk_offset(self, chunk_ix: int) -> int: """Byte-aligned start position of chunk *chunk_ix* in array coordinates. Does not validate *chunk_ix* — callers must ensure it is in ``[0, nchunks)``. Use ``ChunkGrid.__getitem__`` for safe access. """ return chunk_ix * self.size def chunk_size(self, chunk_ix: int) -> int: """Buffer size for codec processing — always uniform. Does not validate *chunk_ix* — callers must ensure it is in ``[0, nchunks)``. Use ``ChunkGrid.__getitem__`` for safe access. """ return self.size def data_size(self, chunk_ix: int) -> int: """Valid data region within the buffer — clipped at extent. Does not validate *chunk_ix* — callers must ensure it is in ``[0, nchunks)``. Use ``ChunkGrid.__getitem__`` for safe access. """ if self.size == 0: return 0 return max(0, min(self.size, self.extent - chunk_ix * self.size)) @property def _unique_edge_lengths(self) -> Iterable[int]: """Distinct chunk edge lengths for this dimension. Used by shard validation to check that every unique edge length is divisible by the inner chunk size. O(1) for fixed dimensions since there is only one edge length. """ return (self.size,) def indices_to_chunks(self, indices: npt.NDArray[np.intp]) -> npt.NDArray[np.intp]: if self.size == 0: return np.zeros_like(indices) return indices // self.size def with_extent(self, new_extent: int) -> FixedDimension: """Re-bind to *new_extent* without modifying edges. Used when constructing a grid from existing metadata where edges are already correct. Raises on ``VaryingDimension`` if edges don't cover the new extent. """ return FixedDimension(size=self.size, extent=new_extent) def resize(self, new_extent: int) -> FixedDimension: """Adapt for a user-initiated array resize, growing edges if needed. For ``FixedDimension`` this is identical to ``with_extent`` since regular grids don't store explicit edges. """ return FixedDimension(size=self.size, extent=new_extent) @property def _size_repr(self) -> str: return str(self.size) @dataclass(frozen=True) class VaryingDimension: """Explicit per-chunk sizes. The last chunk may extend past the array extent (``extent < sum(edges)``), in which case ``data_size`` clips to the valid region while ``chunk_size`` returns the full edge length for codec processing. This underflow is allowed to match how regular grids handle boundary chunks, and to support shrinking an array without rewriting chunk edges (the spec allows trailing edges beyond the extent).""" edges: tuple[int, ...] # per-chunk edge lengths (all > 0) cumulative: tuple[int, ...] # prefix sums for O(log n) lookup extent: int # array dimension length (may be < sum(edges) after resize) nchunks: int = field(init=False, repr=False) # cached at construction ngridcells: int = field(init=False, repr=False) # cached at construction # TODO(perf): for long dimensions (O(million chunks)): # - with_extent/resize recompute cumulative sums and nchunks from scratch; # add a fast path that reuses the existing cumulative tuple. # - Consider storing cumulative as ndarray so bisect calls can use # np.searchsorted. Scalar lookups (chunk_offset, index_to_chunk) # would need benchmarking to confirm no regression. def __init__(self, edges: Sequence[int], extent: int) -> None: edges_tuple = tuple(edges) if not edges_tuple: raise ValueError("VaryingDimension edges must not be empty") if any(e <= 0 for e in edges_tuple): raise ValueError(f"All edge lengths must be > 0, got {edges_tuple}") cumulative = tuple(itertools.accumulate(edges_tuple)) if extent < 0: raise ValueError(f"VaryingDimension extent must be >= 0, got {extent}") if extent > cumulative[-1]: raise ValueError( f"VaryingDimension extent {extent} exceeds sum of edges {cumulative[-1]}" ) object.__setattr__(self, "edges", edges_tuple) object.__setattr__(self, "cumulative", cumulative) object.__setattr__(self, "extent", extent) # Cache nchunks: number of chunks that overlap [0, extent) if extent == 0: n = 0 else: n = bisect.bisect_left(cumulative, extent) + 1 object.__setattr__(self, "nchunks", n) object.__setattr__(self, "ngridcells", len(edges_tuple)) def index_to_chunk(self, idx: int) -> int: if idx < 0 or idx >= self.extent: raise IndexError(f"Index {idx} out of bounds for dimension with extent {self.extent}") return bisect.bisect_right(self.cumulative, idx) def chunk_offset(self, chunk_ix: int) -> int: """Start position of chunk *chunk_ix* in array coordinates. Does not validate *chunk_ix* — callers must ensure it is in ``[0, ngridcells)``. Use ``ChunkGrid.__getitem__`` for safe access. """ return self.cumulative[chunk_ix - 1] if chunk_ix > 0 else 0 def chunk_size(self, chunk_ix: int) -> int: """Buffer size for codec processing. Does not validate *chunk_ix* — callers must ensure it is in ``[0, ngridcells)``. Use ``ChunkGrid.__getitem__`` for safe access. """ return self.edges[chunk_ix] def data_size(self, chunk_ix: int) -> int: """Valid data region within the buffer — clipped at extent. Does not validate *chunk_ix* — callers must ensure it is in ``[0, ngridcells)``. Use ``ChunkGrid.__getitem__`` for safe access. """ offset = self.cumulative[chunk_ix - 1] if chunk_ix > 0 else 0 return max(0, min(self.edges[chunk_ix], self.extent - offset)) @property def _unique_edge_lengths(self) -> Iterable[int]: """Distinct chunk edge lengths for this dimension (lazily deduplicated). Used by shard validation to check that every unique edge length is divisible by the inner chunk size. Lazy deduplication avoids materializing all edges for dimensions with many repeated sizes. """ seen: set[int] = set() for e in self.edges: if e not in seen: seen.add(e) yield e def indices_to_chunks(self, indices: npt.NDArray[np.intp]) -> npt.NDArray[np.intp]: return np.searchsorted(self.cumulative, indices, side="right") def with_extent(self, new_extent: int) -> VaryingDimension: """Re-bind to *new_extent* without modifying edges. Used when constructing a grid from existing metadata where edges are already correct. Raises if the existing edges don't cover *new_extent*. """ edge_sum = self.cumulative[-1] if edge_sum < new_extent: raise ValueError( f"VaryingDimension edge sum {edge_sum} is less than new extent {new_extent}" ) return VaryingDimension(self.edges, extent=new_extent) def resize(self, new_extent: int) -> VaryingDimension: """Adapt for a user-initiated array resize, growing edges if needed. Unlike ``with_extent``, this never fails — if *new_extent* exceeds the current edge sum, a new chunk is appended to cover the gap. Shrinking preserves all edges (the spec allows trailing edges beyond the array extent). """ if new_extent == self.extent: return self elif new_extent > self.cumulative[-1]: expanded_edges = list(self.edges) + [new_extent - self.cumulative[-1]] return VaryingDimension(expanded_edges, extent=new_extent) else: return VaryingDimension(self.edges, extent=new_extent) @property def _size_repr(self) -> str: return repr(tuple(self.edges)) @runtime_checkable class DimensionGrid(Protocol): """Structural interface shared by FixedDimension and VaryingDimension.""" @property def nchunks(self) -> int: ... @property def ngridcells(self) -> int: ... @property def extent(self) -> int: ... def index_to_chunk(self, idx: int) -> int: ... def chunk_offset(self, chunk_ix: int) -> int: ... def chunk_size(self, chunk_ix: int) -> int: ... def data_size(self, chunk_ix: int) -> int: ... def indices_to_chunks(self, indices: npt.NDArray[np.intp]) -> npt.NDArray[np.intp]: ... @property def _unique_edge_lengths(self) -> Iterable[int]: ... def with_extent(self, new_extent: int) -> DimensionGrid: ... def resize(self, new_extent: int) -> DimensionGrid: ... @property def _size_repr(self) -> str: ... @dataclass(frozen=True) class ChunkSpec: """Specification of a single chunk's location and size. ``slices`` gives the valid data region in array coordinates. ``codec_shape`` gives the buffer shape for codec processing. For interior chunks these are equal. For boundary chunks of a regular grid, ``codec_shape`` is the full declared chunk size while ``shape`` is clipped. For rectilinear grids, ``shape == codec_shape`` unless the last chunk extends past the array extent. """ slices: tuple[slice, ...] codec_shape: tuple[int, ...] @property def shape(self) -> tuple[int, ...]: return tuple(s.stop - s.start for s in self.slices) @property def is_boundary(self) -> bool: return self.shape != self.codec_shape # A single dimension's rectilinear chunk spec: bare int (uniform shorthand), # list of ints (explicit edges), or mixed RLE (e.g. [[10, 3], 5]). def _is_rectilinear_chunks(chunks: Any) -> TypeGuard[Sequence[Sequence[int]]]: """Check if chunks is a nested sequence (e.g. [[10, 20], [5, 5]]). Returns True for inputs like [[10, 20], [5, 5]] or [(10, 20), (5, 5)]. Returns False for flat sequences like (10, 10) or [10, 10]. """ if isinstance(chunks, (str, int, ChunkGrid)): return False if not hasattr(chunks, "__iter__"): return False try: first_elem = next(iter(chunks), None) if first_elem is None: return False return hasattr(first_elem, "__iter__") and not isinstance(first_elem, (str, bytes, int)) except (TypeError, StopIteration): return False def is_regular_1d( dim_chunks: Sequence[int] | np.ndarray[tuple[int], np.dtype[np.int64]], ) -> bool: """Check if a single dimension's chunk sizes represent a regular grid. A regular dimension has either all chunks the same size, or all but the last chunk the same size with the last chunk smaller (boundary chunk). """ if len(dim_chunks) <= 1: return True first = dim_chunks[0] if isinstance(dim_chunks, np.ndarray): # Vectorized comparison avoids per-element Python iteration over int64 arrays. return bool((dim_chunks[1:-1] == first).all() and dim_chunks[-1] <= first) for c in dim_chunks[1:-1]: if c != first: return False # Last chunk must be the same size or a smaller boundary chunk return dim_chunks[-1] <= first def is_regular_nd( chunks: Iterable[Sequence[int] | np.ndarray[tuple[int], np.dtype[np.int64]]], ) -> bool: """Check if an N-dimensional chunk specification represents a regular grid.""" return all(is_regular_1d(d) for d in chunks) def as_regular_shape(chunks: ChunksTuple) -> tuple[int, ...]: """Flatten a regular ChunksTuple to one int per dimension.""" assert is_regular_nd(chunks), f"expected regular chunks, got {chunks}" return tuple(int(dim[0]) for dim in chunks) @dataclass(frozen=True) class ChunkGrid: """ Unified chunk grid supporting both regular and rectilinear chunking. A chunk grid is a concrete arrangement of chunks for a specific array. It stores the extent (array dimension length) per dimension, enabling ``grid[coords]`` to return a ``ChunkSpec`` without external parameters. Internally represents each dimension as either FixedDimension (uniform chunks) or VaryingDimension (per-chunk edge lengths with prefix sums). """ _dimensions: tuple[DimensionGrid, ...] _is_regular: bool def __init__(self, *, dimensions: tuple[DimensionGrid, ...]) -> None: object.__setattr__(self, "_dimensions", dimensions) object.__setattr__( self, "_is_regular", all(isinstance(d, FixedDimension) for d in dimensions) ) def __repr__(self) -> str: sizes = ", ".join(d._size_repr for d in self._dimensions) shape = tuple(d.extent for d in self._dimensions) return f"ChunkGrid(chunk_sizes=({sizes}), array_shape={shape})" @classmethod def from_metadata(cls, metadata: ArrayMetadata) -> ChunkGrid: """Construct a ChunkGrid from array metadata. For v2 metadata, builds from shape and chunks. For v3 metadata, dispatches on the chunk grid type. """ from zarr.core.metadata import ArrayV2Metadata from zarr.core.metadata.v3 import RectilinearChunkGridMetadata, RegularChunkGridMetadata if isinstance(metadata, ArrayV2Metadata): return cls.from_sizes(metadata.shape, tuple(metadata.chunks)) chunk_grid_meta = metadata.chunk_grid if isinstance(chunk_grid_meta, RegularChunkGridMetadata): return cls.from_sizes(metadata.shape, tuple(chunk_grid_meta.chunk_shape)) elif isinstance(chunk_grid_meta, RectilinearChunkGridMetadata): return cls.from_sizes(metadata.shape, chunk_grid_meta.chunk_shapes) else: raise TypeError(f"Unknown chunk grid metadata type: {type(chunk_grid_meta)}") @classmethod def from_sizes( cls, array_shape: ShapeLike, chunk_sizes: Sequence[int | Sequence[int]], ) -> ChunkGrid: """Create a ChunkGrid from per-dimension chunk size specifications. Parameters ---------- array_shape The array shape (one extent per dimension). chunk_sizes Per-dimension chunk sizes. Each element is either: - An ``int`` — regular (fixed) chunk size for that dimension. - A ``Sequence[int]`` — explicit per-chunk edge lengths. If all edges are identical and cover the extent, the dimension is stored as ``FixedDimension``; otherwise as ``VaryingDimension``. """ extents = parse_shapelike(array_shape) if len(extents) != len(chunk_sizes): raise ValueError( f"array_shape has {len(extents)} dimensions but chunk_sizes " f"has {len(chunk_sizes)} dimensions" ) dims: list[DimensionGrid] = [] for dim_spec, extent in zip(chunk_sizes, extents, strict=True): if isinstance(dim_spec, int): dims.append(FixedDimension(size=dim_spec, extent=extent)) else: edges_list = list(dim_spec) if not edges_list: raise ValueError("Each dimension must have at least one chunk") edge_sum = sum(edges_list) if ( edges_list[0] > 0 and all(e == edges_list[0] for e in edges_list) and (extent == edge_sum or len(edges_list) == ceildiv(extent, edges_list[0])) ): dims.append(FixedDimension(size=edges_list[0], extent=extent)) else: dims.append(VaryingDimension(edges_list, extent=extent)) return cls(dimensions=tuple(dims)) # -- Properties -- @property def ndim(self) -> int: return len(self._dimensions) @property def is_regular(self) -> bool: return self._is_regular @property def grid_shape(self) -> tuple[int, ...]: """Number of chunks per dimension.""" return tuple(d.nchunks for d in self._dimensions) @property def chunk_shape(self) -> tuple[int, ...]: """Return the uniform chunk shape. Raises if grid is not regular.""" if not self.is_regular: raise ValueError( "chunk_shape is only available for regular chunk grids. " "Use grid[coords] for per-chunk sizes." ) return tuple(d.size for d in self._dimensions if isinstance(d, FixedDimension)) @property def chunk_sizes(self) -> tuple[tuple[int, ...], ...]: """Per-dimension chunk sizes, including the final boundary chunk. Returns the actual data size of each chunk (clipped at the array extent), matching the dask ``Array.chunks`` convention. Works for both regular and rectilinear grids. Returns ------- tuple[tuple[int, ...], ...] One inner tuple per dimension, each containing the data size of every chunk along that dimension. """ return tuple(tuple(d.data_size(i) for i in range(d.nchunks)) for d in self._dimensions) # -- Collection interface -- def __getitem__(self, coords: int | tuple[int, ...]) -> ChunkSpec | None: """Return the ChunkSpec for a chunk at the given grid position, or None if OOB.""" if isinstance(coords, int): coords = (coords,) if len(coords) != self.ndim: raise ValueError( f"Expected {self.ndim} coordinate(s) for a {self.ndim}-d chunk grid, " f"got {len(coords)}." ) slices: list[slice] = [] codec_shape: list[int] = [] for dim, ix in zip(self._dimensions, coords, strict=True): if ix < 0 or ix >= dim.nchunks: return None offset = dim.chunk_offset(ix) slices.append(slice(offset, offset + dim.data_size(ix), 1)) codec_shape.append(dim.chunk_size(ix)) return ChunkSpec(tuple(slices), tuple(codec_shape)) def __iter__(self) -> Iterator[ChunkSpec]: """Iterate all chunks, yielding ChunkSpec for each.""" for coords in itertools.product(*(range(d.nchunks) for d in self._dimensions)): spec = self[coords] if spec is not None: yield spec def all_chunk_coords( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[tuple[int, ...]]: """Iterate over chunk coordinates, optionally restricted to a subregion. Parameters ---------- origin : Sequence[int] | None The first chunk coordinate to return. Defaults to the grid origin. selection_shape : Sequence[int] | None The number of chunks per dimension to iterate. Defaults to the remaining extent from origin. """ if origin is None: origin_parsed = (0,) * self.ndim else: origin_parsed = tuple(origin) if selection_shape is None: selection_shape_parsed = tuple( g - o for o, g in zip(origin_parsed, self.grid_shape, strict=True) ) else: selection_shape_parsed = tuple(selection_shape) ranges = tuple( range(o, o + s) for o, s in zip(origin_parsed, selection_shape_parsed, strict=True) ) return itertools.product(*ranges) def iter_chunk_regions( self, *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, ) -> Iterator[tuple[slice, ...]]: """Iterate over the data regions (slices) spanned by each chunk. Parameters ---------- origin : Sequence[int] | None The first chunk coordinate to return. Defaults to the grid origin. selection_shape : Sequence[int] | None The number of chunks per dimension to iterate. Defaults to the remaining extent from origin. """ for coords in self.all_chunk_coords(origin=origin, selection_shape=selection_shape): spec = self[coords] if spec is not None: yield spec.slices def get_nchunks(self) -> int: return reduce(operator.mul, (d.nchunks for d in self._dimensions), 1) # -- Resize -- def update_shape(self, new_shape: tuple[int, ...]) -> ChunkGrid: """Return a new ChunkGrid adjusted for *new_shape*. For regular (FixedDimension) axes the extent is simply re-bound. For varying (VaryingDimension) axes: * **grow**: a new chunk whose size equals the growth is appended. * **shrink**: trailing chunks that lie entirely beyond *new_shape* are dropped; the last retained chunk is the one whose cumulative offset first reaches or exceeds the new extent. * **no change**: the dimension is kept as-is. Raises ------ ValueError If *new_shape* has the wrong number of dimensions. """ if len(new_shape) != self.ndim: raise ValueError( f"new_shape has {len(new_shape)} dimensions but " f"chunk grid has {self.ndim} dimensions" ) dims = tuple( dim.resize(new_extent) for dim, new_extent in zip(self._dimensions, new_shape, strict=True) ) return ChunkGrid(dimensions=dims) def _guess_regular_chunks( shape: tuple[int, ...] | int, typesize: int, *, increment_bytes: int = 256 * 1024, min_bytes: int = 128 * 1024, max_bytes: int = 64 * 1024 * 1024, ) -> tuple[int, ...]: """ Iteratively guess an appropriate chunk layout for an array, given its shape and the size of each element in bytes, and size constraints expressed in bytes. This logic is adapted from h5py. Parameters ---------- shape : tuple[int, ...] The chunk shape. typesize : int The size, in bytes, of each element of the chunk. increment_bytes : int = 256 * 1024 The number of bytes used to increment or decrement the target chunk size in bytes. min_bytes : int = 128 * 1024 The soft lower bound on the final chunk size in bytes. max_bytes : int = 64 * 1024 * 1024 The hard upper bound on the final chunk size in bytes. Returns ------- tuple[int, ...] """ if min_bytes >= max_bytes: raise ValueError(f"Cannot have more min_bytes ({min_bytes}) than max_bytes ({max_bytes})") if isinstance(shape, int): shape = (shape,) if typesize == 0: return shape ndims = len(shape) # require chunks to have non-zero length for all dimensions chunks = np.maximum(np.array(shape, dtype="=f8"), 1) # Determine the optimal chunk size in bytes using a PyTables expression. # This is kept as a float. dset_size = np.prod(chunks) * typesize target_size = increment_bytes * (2 ** np.log10(dset_size / (1024.0 * 1024))) if target_size > max_bytes: target_size = max_bytes elif target_size < min_bytes: target_size = min_bytes idx = 0 while True: # Repeatedly loop over the axes, dividing them by 2. Stop when: # 1a. We're smaller than the target chunk size, OR # 1b. We're within 50% of the target chunk size, AND # 2. The chunk is smaller than the maximum chunk size chunk_bytes = np.prod(chunks) * typesize if ( chunk_bytes < target_size or abs(chunk_bytes - target_size) / target_size < 0.5 ) and chunk_bytes < max_bytes: break if np.prod(chunks) == 1: break # Element size larger than max_bytes chunks[idx % ndims] = math.ceil(chunks[idx % ndims] / 2.0) idx += 1 return tuple(int(x) for x in chunks) def normalize_chunks_1d( chunks: int | Iterable[object], span: int ) -> np.ndarray[tuple[int], np.dtype[np.int64]]: """ Normalize a one-dimensional chunk specification into a 1D int64 array of chunk sizes that cover the span. `-1` means "one chunk covering the entire span." For an integer chunk size, all chunks are uniform — the last chunk may overhang the span. The actual data extent of each chunk is determined by the chunk grid at runtime, not by this function. """ if chunks == -1: return np.array([span], dtype=np.int64) if isinstance(chunks, int): if chunks <= 0: raise ValueError(f"Chunk size must be positive, got {chunks}") if span == 0: return np.array([chunks], dtype=np.int64) n = ceildiv(span, chunks) return np.full(n, chunks, dtype=np.int64) else: chunk_list = list(chunks) if not chunk_list: raise ValueError("Chunk specification must not be empty") non_int = [ (idx, c) for idx, c in enumerate(chunk_list) if not isinstance(c, numbers.Integral) ] if non_int: non_int_idxs, non_int_vals = [*zip(*non_int, strict=False)] raise TypeError( f"Each chunk size must be an integer; got non-integer element(s) {non_int_vals!r} " f"at indices {non_int_idxs!r}. Chunk sizes must be declared as a flat sequence of " f"positive integers (e.g. [3, 3, 1])." ) ints: list[int] = [int(c) for c in chunk_list] # type: ignore[call-overload] if any(c <= 0 for c in ints): raise ValueError(f"All chunk sizes must be positive, got {ints}") if sum(ints) != span: raise ValueError(f"Chunk sizes {ints} do not sum to span {span}") return np.asarray(ints, dtype=np.int64) def normalize_chunks_nd( chunks: Any, shape: tuple[int, ...], ) -> ChunksTuple: """ Normalize a chunk specification into a `ChunksTuple`. This is a mechanical transformation — no heuristics, no guessing. Handles `False` ("all data in one chunk"), scalar ints, `-1` sentinels (one chunk per dimension covering the full span), and explicit per-dimension lists of chunk sizes (regular or rectilinear). For auto-chunking, use `guess_chunks` which returns a `ChunksTuple` directly. `chunks=None` and `chunks=True` are rejected here — the caller is responsible for choosing between explicit sizes and auto-chunking. """ if chunks is None or chunks is True: raise ValueError( f'{chunks!r} is not a valid chunk input. Use chunks=None or chunks="auto" from the top-level API for auto-chunking, or pass an int / tuple of ints.' ) # handle no chunking if chunks is False: return ChunksTuple(tuple(np.array([s], dtype=np.int64) for s in shape)) # handle 1D convenience form. bool is excluded above so this only catches actual ints. if isinstance(chunks, numbers.Integral): chunks = tuple(int(chunks) for _ in shape) # handle bad dimensionality if len(chunks) != len(shape): raise ValueError( f"chunks has {len(chunks)} dimensions but shape has {len(shape)} dimensions" ) return ChunksTuple( tuple(normalize_chunks_1d(c, span=s) for c, s in zip(chunks, shape, strict=True)) ) def guess_chunks( shape: tuple[int, ...], typesize: int, *, max_bytes: int | None = None ) -> ChunksTuple: """ Heuristically determine chunk sizes for an array. This is the policy function — it makes opinionated choices about chunk sizes based on array shape and element size, and returns a normalized `ChunksTuple`. Parameters ---------- shape : tuple[int, ...] Array shape. typesize : int Size of one element in bytes. max_bytes : int or None Target maximum chunk size in bytes. If None, uses the default heuristic from `_guess_regular_chunks`. """ if max_bytes is not None: flat = _guess_regular_chunks(shape, typesize, max_bytes=max_bytes) else: flat = _guess_regular_chunks(shape, typesize) return normalize_chunks_nd(flat, shape) def _guess_num_chunks_per_axis_shard( chunk_shape: tuple[int, ...], item_size: int, max_bytes: int, array_shape: tuple[int, ...] ) -> int: """Generate the number of chunks per axis to hit a target max byte size for a shard. For example, for a (2,2,2) chunk size and item size 4, maximum bytes of 256 would return 2. In other words the shard would be a (2,2,2) grid of (2,2,2) chunks i.e., prod(chunk_shape) * (returned_val * len(chunk_shape)) * item_size = 256 bytes. Parameters ---------- chunk_shape The shape of the (inner) chunks. item_size The item size of the data i.e., 2 for uint16. max_bytes The maximum number of bytes per shard to allow. array_shape The shape of the underlying array. Returns ------- The number of chunks per axis. """ bytes_per_chunk = math.prod(chunk_shape) * item_size if max_bytes < bytes_per_chunk: return 1 num_axes = len(chunk_shape) chunks_per_shard = 1 # First check for byte size, second check to make sure we don't go bigger than the array shape while (bytes_per_chunk * ((chunks_per_shard + 1) ** num_axes)) <= max_bytes and all( c * (chunks_per_shard + 1) <= a for c, a in zip(chunk_shape, array_shape, strict=True) ): chunks_per_shard += 1 return chunks_per_shard def resolve_outer_and_inner_chunks( *, array_shape: tuple[int, ...], chunks: ChunksTuple, shard_shape: ShardsLike | None, item_size: int, ) -> ChunkLayout: """Resolve user `chunks`/`shards` into outer and inner chunk specs. Parameters ---------- array_shape The array shape. chunks Normalized chunk specification (the user's `chunks=`). shard_shape Raw shard specification (the user's `shards=`). `None` means no sharding, `"auto"` triggers heuristic inference, a nested sequence is treated as rectilinear shard boundaries, and anything else is used as a regular shard shape. item_size Element size in bytes. Returns ------- ChunkLayout `outer_chunks` is the `ChunksTuple` for chunk grid metadata. `inner` holds the sub-chunk structure for `ShardingCodec`, or is `None` when sharding is not active. """ if shard_shape is None: return ChunkLayout(outer_chunks=chunks) # Rectilinear shards: normalize the nested sequence directly. if _is_rectilinear_chunks(shard_shape): outer = normalize_chunks_nd(shard_shape, array_shape) return ChunkLayout(outer_chunks=outer, inner=ChunkLayout(outer_chunks=chunks)) # Extract the flat chunk shape (first size per dimension) for arithmetic. chunk_shape_flat = as_regular_shape(chunks) if shard_shape == "auto": warnings.warn( "Automatic shard shape inference is experimental and may change without notice.", ZarrUserWarning, stacklevel=2, ) _shards_out: tuple[int, ...] = () target_shard_size_bytes = zarr.config.get("array.target_shard_size_bytes", None) num_chunks_per_shard_axis = ( _guess_num_chunks_per_axis_shard( chunk_shape=chunk_shape_flat, item_size=item_size, max_bytes=target_shard_size_bytes, array_shape=array_shape, ) if (has_auto_shard := (target_shard_size_bytes is not None)) else 2 ) for a_shape, c_shape in zip(array_shape, chunk_shape_flat, strict=True): can_shard_axis = a_shape // c_shape > 8 if not has_auto_shard else True if can_shard_axis: _shards_out += (c_shape * num_chunks_per_shard_axis,) else: _shards_out += (c_shape,) shard_flat = _shards_out elif isinstance(shard_shape, dict): shard_flat = tuple(shard_shape["shape"]) else: shard_flat = cast("tuple[int, ...]", shard_shape) outer = normalize_chunks_nd(shard_flat, array_shape) return ChunkLayout(outer_chunks=outer, inner=ChunkLayout(outer_chunks=chunks)) zarr-python-3.3.0/src/zarr/core/chunk_key_encodings.py000066400000000000000000000110051523267620000230720ustar00rootroot00000000000000from __future__ import annotations from abc import ABC, abstractmethod from dataclasses import dataclass from typing import TYPE_CHECKING, Any, ClassVar, Literal, TypedDict, cast if TYPE_CHECKING: from typing import NotRequired, Self from zarr.abc.metadata import Metadata from zarr.core.common import ( JSON, NamedConfig, parse_named_configuration, ) from zarr.registry import get_chunk_key_encoding_class, register_chunk_key_encoding SeparatorLiteral = Literal[".", "/"] def parse_separator(data: JSON) -> SeparatorLiteral: if data not in (".", "/"): raise ValueError(f"Expected an '.' or '/' separator. Got {data} instead.") return cast("SeparatorLiteral", data) class ChunkKeyEncodingParams(TypedDict): name: Literal["v2", "default"] separator: NotRequired[SeparatorLiteral] @dataclass(frozen=True) class ChunkKeyEncoding(ABC, Metadata): """ Defines how chunk coordinates are mapped to store keys. Subclasses must define a class variable `name` and implement `encode_chunk_key`. """ name: ClassVar[str] @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: _, config_parsed = parse_named_configuration(data, require_configuration=False) return cls(**config_parsed or {}) def to_dict(self) -> dict[str, JSON]: return {"name": self.name, "configuration": super().to_dict()} def decode_chunk_key(self, chunk_key: str) -> tuple[int, ...]: """ Optional: decode a chunk key string into chunk coordinates. Not required for normal operation; override if needed for testing or debugging. """ raise NotImplementedError(f"{self.__class__.__name__} does not implement decode_chunk_key.") @abstractmethod def encode_chunk_key(self, chunk_coords: tuple[int, ...]) -> str: """ Encode chunk coordinates into a chunk key string. Must be implemented by subclasses. """ type ChunkKeyEncodingLike = ( dict[str, JSON] | ChunkKeyEncodingParams | ChunkKeyEncoding | NamedConfig[str, Any] ) @dataclass(frozen=True) class DefaultChunkKeyEncoding(ChunkKeyEncoding): name: ClassVar[Literal["default"]] = "default" separator: SeparatorLiteral = "/" def __post_init__(self) -> None: separator_parsed = parse_separator(self.separator) object.__setattr__(self, "separator", separator_parsed) def decode_chunk_key(self, chunk_key: str) -> tuple[int, ...]: if chunk_key == "c": return () # Strip the "c" prefix (e.g. "c/" or "c.") before splitting. prefix = "c" + self.separator if chunk_key.startswith(prefix): return tuple(map(int, chunk_key[len(prefix) :].split(self.separator))) raise ValueError(f"Invalid chunk key for default encoding: {chunk_key!r}") def encode_chunk_key(self, chunk_coords: tuple[int, ...]) -> str: return self.separator.join(map(str, ("c",) + chunk_coords)) @dataclass(frozen=True) class V2ChunkKeyEncoding(ChunkKeyEncoding): name: ClassVar[Literal["v2"]] = "v2" separator: SeparatorLiteral = "." def __post_init__(self) -> None: separator_parsed = parse_separator(self.separator) object.__setattr__(self, "separator", separator_parsed) def decode_chunk_key(self, chunk_key: str) -> tuple[int, ...]: return tuple(map(int, chunk_key.split(self.separator))) def encode_chunk_key(self, chunk_coords: tuple[int, ...]) -> str: chunk_identifier = self.separator.join(map(str, chunk_coords)) return "0" if chunk_identifier == "" else chunk_identifier def parse_chunk_key_encoding(data: ChunkKeyEncodingLike) -> ChunkKeyEncoding: """ Take an implicit specification of a chunk key encoding and parse it into a ChunkKeyEncoding object. """ if isinstance(data, ChunkKeyEncoding): return data # handle ChunkKeyEncodingParams if "name" in data and "separator" in data: data = {"name": data["name"], "configuration": {"separator": data["separator"]}} # type: ignore[typeddict-item] # Now must be a named config data = cast("dict[str, JSON]", data) name_parsed, _ = parse_named_configuration(data, require_configuration=False) try: chunk_key_encoding = get_chunk_key_encoding_class(name_parsed).from_dict(data) except KeyError as e: raise ValueError(f"Unknown chunk key encoding: {e.args[0]!r}") from e return chunk_key_encoding register_chunk_key_encoding("default", DefaultChunkKeyEncoding) register_chunk_key_encoding("v2", V2ChunkKeyEncoding) zarr-python-3.3.0/src/zarr/core/chunk_utils.py000066400000000000000000000362631523267620000214260ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass, field from typing import TYPE_CHECKING, Any, cast from zarr.abc.codec import GetResult, SupportsSyncCodec, _codec_supports_sync from zarr.core.indexing import is_scalar if TYPE_CHECKING: from collections.abc import Callable, Iterable from zarr.abc.codec import Codec from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer, NDBuffer from zarr.core.indexing import SelectorTuple def evolve_codecs(codecs: Iterable[Codec], array_spec: ArraySpec) -> tuple[Codec, ...]: """Evolve a codec chain against ``array_spec``, threading the spec forward. Each codec is evolved against the spec produced by the previous one — NOT the original ``array_spec`` — because earlier array->array codecs may transform the chunk spec (e.g. ``cast_value`` widening int8 -> int16). A later codec (notably the array->bytes serializer) must be evolved against the spec it will actually see at run time; evolving every codec against the unthreaded original spec would, for example, strip a ``BytesCodec``'s ``endian`` (it sees the single-byte source dtype) and then fail at decode time on the multi-byte target. This is the single source of truth for pipeline-construction-time codec evolution, shared by every ``CodecPipeline.evolve_from_array_spec``. (The per-chunk decode/encode counterpart is ``resolve_aa_specs``.) """ evolved: list[Codec] = [] spec = array_spec for codec in codecs: evolved_codec = codec.evolve_from_array_spec(array_spec=spec) evolved.append(evolved_codec) spec = evolved_codec.resolve_metadata(spec) return tuple(evolved) def encode_or_elide_chunk( chunk_array: NDBuffer, chunk_spec: ArraySpec, encode: Callable[[NDBuffer, ArraySpec], Buffer | None], ) -> Buffer | None: """Encode a merged chunk, normalizing empties to missing. Returns the bytes to store, or ``None`` meaning the chunk must NOT be stored (either it normalized to empty per `chunk_is_empty`, or the codec chain elided it). ``None`` is the single "missing" convention shared by the chunk write paths and the shard dicts. """ if chunk_is_empty(chunk_array, chunk_spec): return None return encode(chunk_array, chunk_spec) def fill_value_or_default(chunk_spec: ArraySpec) -> Any: fill_value = chunk_spec.fill_value if fill_value is None: # Zarr V2 allowed `fill_value` to be null in the metadata. # Zarr V3 requires it to be set. This has already been # validated when decoding the metadata, but we support reading # Zarr V2 data and need to support the case where fill_value # is None. return chunk_spec.dtype.default_scalar() else: return fill_value def chunk_is_empty(chunk_array: NDBuffer, chunk_spec: ArraySpec) -> bool: """THE empty-chunk normalization rule, in one place. With ``write_empty_chunks=False`` (the default), a chunk whose decoded content equals the fill value normalizes to *missing*: it must not be stored, and readers reconstruct it from the fill value. Every write path (fused, async fallback, shard inner chunks) must apply this same rule — scattering inline ``all_equal`` checks is how the rule drifts. """ return not chunk_spec.config.write_empty_chunks and chunk_array.all_equal( fill_value_or_default(chunk_spec) ) def scatter_chunk( selected: NDBuffer | None, out: NDBuffer, *, chunk_spec: ArraySpec, out_selection: SelectorTuple, drop_axes: tuple[int, ...], ) -> GetResult: """Scatter one chunk's (already-selected) decoded region into ``out``. ``None`` = the chunk is missing: the fill value is scattered instead and a ``missing`` status is returned. POLICY-FREE by design: whether a missing chunk is an error (``read_missing_chunks=False``) is decided by the array layer from the returned statuses — which is also what makes missing INNER chunks of a present shard fill rather than raise (the sharding codec discards the nested read's statuses; only top-level statuses reach the array layer). """ if selected is None: out[out_selection] = fill_value_or_default(chunk_spec) return GetResult(status="missing") if drop_axes: selected = selected.squeeze(axis=drop_axes) out[out_selection] = selected return GetResult(status="present") def _merge_chunk_array( existing_chunk_array: NDBuffer | None, value: NDBuffer, out_selection: SelectorTuple, chunk_spec: ArraySpec, chunk_selection: SelectorTuple, is_complete_chunk: bool, drop_axes: tuple[int, ...], ) -> NDBuffer: """Merge `value` into a full-chunk-shaped NDBuffer at `chunk_selection`. If `is_complete_chunk` and `value[out_selection]` is exactly chunk-shaped, that VIEW of the caller's `value` is returned without copying — callers (and the codecs they pass it to) must treat it as read-only, since mutating it would corrupt the user's source array. Otherwise, a writable buffer is materialized — either from `existing_chunk_array.copy()` if one was read from the store, or freshly allocated and filled with the chunk's fill value — and the relevant slice of `value` is written into it. """ if is_complete_chunk and value.shape != (): selected = value[out_selection] # The shape check guards against a partial edge chunk arriving with # is_complete_chunk=True, and against dropped axes (size-1 integer # dims), where the selection is not exactly chunk-shaped. if selected.shape == chunk_spec.shape: return selected if existing_chunk_array is None: chunk_array = chunk_spec.prototype.nd_buffer.create( shape=chunk_spec.shape, dtype=chunk_spec.dtype.to_native_dtype(), order=chunk_spec.order, fill_value=fill_value_or_default(chunk_spec), ) else: chunk_array = existing_chunk_array.copy() if chunk_selection == () or is_scalar( value.as_ndarray_like(), chunk_spec.dtype.to_native_dtype() ): chunk_value = value else: chunk_value = value[out_selection] if drop_axes: item = tuple( None if idx in drop_axes else slice(None) for idx in range(chunk_spec.ndim) ) chunk_value = chunk_value[item] chunk_array[chunk_selection] = chunk_value return chunk_array def merge_and_encode_chunk( existing_bytes: Buffer | None, value: NDBuffer, *, chunk_spec: ArraySpec, chunk_selection: SelectorTuple, out_selection: SelectorTuple, is_complete: bool, drop_axes: tuple[int, ...], decode: Callable[[Buffer, ArraySpec], NDBuffer], encode: Callable[[NDBuffer, ArraySpec], Buffer | None], ) -> Buffer | None: """The canonical single-chunk write: merge, normalize, encode. decode existing (``None`` = chunk currently missing) -> merge ``value`` at ``chunk_selection`` -> normalize empties to missing -> encode. Returns the bytes to store or ``None`` = do not store / delete. This is the one state-transition every per-chunk write path expresses; only the IO around it (where ``existing_bytes`` comes from, where the result goes) differs. """ existing_array = decode(existing_bytes, chunk_spec) if existing_bytes is not None else None merged = _merge_chunk_array( existing_array, value, out_selection, chunk_spec, chunk_selection, is_complete, drop_axes ) return encode_or_elide_chunk(merged, chunk_spec, encode) def decode_and_scatter_chunk( chunk_bytes: Buffer | None, out: NDBuffer, *, chunk_spec: ArraySpec, chunk_selection: SelectorTuple, out_selection: SelectorTuple, drop_axes: tuple[int, ...], decode: Callable[[Buffer, ArraySpec], NDBuffer], ) -> GetResult: """The canonical single-chunk read: decode stored bytes (``None`` = missing), select, and scatter into ``out`` via `scatter_chunk`. The read twin of `merge_and_encode_chunk`. """ if chunk_bytes is None: return scatter_chunk( None, out, chunk_spec=chunk_spec, out_selection=out_selection, drop_axes=drop_axes ) selected = decode(chunk_bytes, chunk_spec)[chunk_selection] return scatter_chunk( selected, out, chunk_spec=chunk_spec, out_selection=out_selection, drop_axes=drop_axes ) @dataclass(slots=True, kw_only=True) class ChunkTransform: """A synchronous codec chain. Provides `encode_chunk` and `decode_chunk` for pure-compute codec operations (no IO, no threading, no batching). The `chunk_spec` is supplied per call so the same transform can be reused across chunks with different shapes, prototypes, etc. All codecs must implement `SupportsSyncCodec`. Construction will raise `TypeError` if any codec does not. """ codecs: tuple[Codec, ...] _aa_codecs: tuple[SupportsSyncCodec[NDBuffer, NDBuffer], ...] = field( init=False, repr=False, compare=False ) _ab_codec: SupportsSyncCodec[NDBuffer, Buffer] = field(init=False, repr=False, compare=False) _bb_codecs: tuple[SupportsSyncCodec[Buffer, Buffer], ...] = field( init=False, repr=False, compare=False ) def __post_init__(self) -> None: from zarr.core.codec_pipeline import codecs_from_list_unchecked # _codec_supports_sync, not a bare isinstance check: a codec can satisfy # the SupportsSyncCodec protocol structurally yet be unable to run # synchronously (ShardingCodec whose inner/index chain contains an # async-only codec). Such codecs opt out via `_sync_capable`, and the # TypeError here is what makes FusedCodecPipeline.evolve_from_array_spec # decline the sync fast path and fall back to the async pipeline. non_sync = [c for c in self.codecs if not _codec_supports_sync(c)] if non_sync: names = ", ".join(type(c).__name__ for c in non_sync) raise TypeError( f"All codecs must implement SupportsSyncCodec. The following do not: {names}" ) # `ChunkTransform` is built from a codec chain that already went # through `codecs_from_list` when the owning pipeline was constructed # (see `FusedCodecPipeline.evolve_from_array_spec`), so re-splitting it # here must not re-emit that chain's advisory warnings. aa, ab, bb = codecs_from_list_unchecked(list(self.codecs)) # SupportsSyncCodec was verified above; the cast is purely for mypy. self._aa_codecs = cast("tuple[SupportsSyncCodec[NDBuffer, NDBuffer], ...]", tuple(aa)) self._ab_codec = cast("SupportsSyncCodec[NDBuffer, Buffer]", ab) self._bb_codecs = cast("tuple[SupportsSyncCodec[Buffer, Buffer], ...]", tuple(bb)) # The whole cache entry — (key, aa_specs, ab_spec) — is stored as ONE field # and replaced with a single attribute write. A `ChunkTransform` is shared # across thread-pool workers (read_sync/write_sync with max_workers > 1), and # storing the key separately from the specs would race: a worker could read a # freshly-set key while the matching specs were still the previous (or None) # value. A single tuple assignment is atomic under the GIL, so a reader sees # either the complete old entry or the complete new one — never a torn mix. _cache: tuple[ArraySpec, tuple[ArraySpec, ...], ArraySpec] | None = field( init=False, repr=False, compare=False, default=None ) def _resolve_specs(self, chunk_spec: ArraySpec) -> tuple[tuple[ArraySpec, ...], ArraySpec]: """Return per-AA-codec input specs and the AB spec for `chunk_spec`. The resolved chain depends only on the value of `chunk_spec`, so we cache it keyed on `chunk_spec` itself (ArraySpec is a frozen, hashable dataclass — value identity). Keying on `id(chunk_spec)` would be unsafe: ids are recycled after garbage collection, so a freed spec's id reused by a different spec (same shape, different prototype/dtype/config) could yield a stale hit. Value identity avoids that entirely. Thread-safety: a benign construction race is possible (two workers with different specs may each compute and overwrite the single-entry cache — last writer wins), but a torn read is not, because the entry is written atomically as one tuple. Worst case is a recompute, never a wrong result. """ from zarr.core.codec_pipeline import resolve_aa_specs if not self._aa_codecs: return (), chunk_spec cache = self._cache if cache is not None and cache[0] == chunk_spec: return cache[1], cache[2] aa_specs_t, spec = resolve_aa_specs(cast("tuple[Codec, ...]", self._aa_codecs), chunk_spec) self._cache = (chunk_spec, aa_specs_t, spec) return aa_specs_t, spec def decode_chunk(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> NDBuffer: """Decode a single chunk through the full codec chain, synchronously. Pure compute -- no IO. Parameters ---------- chunk_bytes : Buffer The encoded chunk bytes. chunk_spec : ArraySpec The array spec describing shape, dtype, fill value, and codec configuration for this chunk. """ aa_specs, ab_spec = self._resolve_specs(chunk_spec) data: Buffer = chunk_bytes for bb_codec in reversed(self._bb_codecs): data = bb_codec._decode_sync(data, ab_spec) chunk_array: NDBuffer = self._ab_codec._decode_sync(data, ab_spec) for aa_codec, aa_spec in zip(reversed(self._aa_codecs), reversed(aa_specs), strict=True): chunk_array = aa_codec._decode_sync(chunk_array, aa_spec) return chunk_array def encode_chunk(self, chunk_array: NDBuffer, chunk_spec: ArraySpec) -> Buffer | None: """Encode a single chunk through the full codec chain, synchronously. Pure compute -- no IO. Parameters ---------- chunk_array : NDBuffer The chunk data to encode. chunk_spec : ArraySpec The array spec describing shape, dtype, fill value, and codec configuration for this chunk. """ aa_specs, ab_spec = self._resolve_specs(chunk_spec) aa_data: NDBuffer = chunk_array for aa_codec, aa_spec in zip(self._aa_codecs, aa_specs, strict=True): aa_result = aa_codec._encode_sync(aa_data, aa_spec) if aa_result is None: return None aa_data = aa_result ab_result = self._ab_codec._encode_sync(aa_data, ab_spec) if ab_result is None: return None bb_data: Buffer = ab_result for bb_codec in self._bb_codecs: bb_result = bb_codec._encode_sync(bb_data, ab_spec) if bb_result is None: return None bb_data = bb_result return bb_data def compute_encoded_size(self, byte_length: int, array_spec: ArraySpec) -> int: for codec in self.codecs: byte_length = codec.compute_encoded_size(byte_length, array_spec) array_spec = codec.resolve_metadata(array_spec) return byte_length zarr-python-3.3.0/src/zarr/core/codec_pipeline.py000066400000000000000000001563051523267620000220400ustar00rootroot00000000000000from __future__ import annotations import asyncio import threading from concurrent.futures import ThreadPoolExecutor from dataclasses import dataclass, field from itertools import batched, chain, pairwise from typing import TYPE_CHECKING, Any, cast from warnings import warn from zarr.abc.codec import ( ArrayArrayCodec, ArrayBytesCodec, ArrayBytesCodecPartialDecodeMixin, ArrayBytesCodecPartialEncodeMixin, BytesBytesCodec, Codec, CodecPipeline, GetResult, ) from zarr.core.chunk_utils import ( ChunkTransform, _merge_chunk_array, chunk_is_empty, decode_and_scatter_chunk, evolve_codecs, fill_value_or_default, merge_and_encode_chunk, scatter_chunk, ) from zarr.core.common import concurrent_iter, concurrent_map from zarr.core.config import config from zarr.errors import ZarrUserWarning from zarr.registry import register_pipeline if TYPE_CHECKING: from collections.abc import Iterable, Iterator, Sequence from typing import Self from zarr.abc.store import ByteGetter, ByteSetter from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer, BufferPrototype, NDBuffer from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.core.indexing import SelectorTuple from zarr.core.metadata.v3 import ChunkGridMetadata _pool: ThreadPoolExecutor | None = None _pool_size: int = 0 _pool_lock = threading.Lock() def _resolve_max_workers() -> int: """Helper for getting the maximum number of workers available to the `FusedCodecPipeline`""" import os as _os default = _os.cpu_count() or 1 cfg = config.get("codec_pipeline.max_workers", default=None) if cfg is None: return default try: return max(1, int(cfg)) except (TypeError, ValueError): # This value arrives via the config/env layer (e.g. # `ZARR_CODEC_PIPELINE__MAX_WORKERS`), so tolerate bad input here # instead of raising mid-read. warn( f"Ignoring invalid `codec_pipeline.max_workers` config value {cfg!r}; " f"falling back to {default}.", category=ZarrUserWarning, stacklevel=2, ) return default def _get_pool(max_workers: int) -> ThreadPoolExecutor: """Get or create the module-level thread pool, sized to `max_workers`. The pool grows on demand — if a request arrives for more workers than the current pool has, it is replaced with a larger one. The previous pool is NOT shut down here: another thread may be holding a reference to it and about to submit (`shutdown` would make its `pool.map` raise "cannot schedule new futures after shutdown"). The orphaned pool finishes its in-flight tasks and is garbage-collected once no caller references it. The pool only grows, never shrinks (a shrink request reuses the larger pool, leaving workers idle). Callers that want sequential execution should not call this — they should run the task list inline. `max_workers` must be >= 1. """ global _pool, _pool_size if max_workers < 1: raise ValueError(f"max_workers must be >= 1, got {max_workers}") if _pool is None or _pool_size < max_workers: with _pool_lock: if _pool is None or _pool_size < max_workers: # Replace without shutting down the old pool (see docstring): # avoids a race with a concurrent in-flight pool.map on it. _pool = ThreadPoolExecutor(max_workers=max_workers) _pool_size = max_workers return _pool def _unzip2[T, U](iterable: Iterable[tuple[T, U]]) -> tuple[list[T], list[U]]: out0: list[T] = [] out1: list[U] = [] for item0, item1 in iterable: out0.append(item0) out1.append(item1) return (out0, out1) def resolve_batched(codec: Codec, chunk_specs: Iterable[ArraySpec]) -> Iterable[ArraySpec]: return [codec.resolve_metadata(chunk_spec) for chunk_spec in chunk_specs] def resolve_aa_specs( aa_codecs: tuple[Codec, ...], chunk_spec: ArraySpec ) -> tuple[tuple[ArraySpec, ...], ArraySpec]: """Resolve the per-stage chunk specs for a single chunk's codec chain. Threads `chunk_spec` forward through the array->array codecs via `resolve_metadata` (each codec sees the spec produced by the previous one), returning `(aa_specs, ab_spec)`: * `aa_specs[i]` is the spec the i-th AA codec operates on (its *input* on encode / *output* on decode); * `ab_spec` is the spec after all AA codecs — what the array->bytes codec and the bytes->bytes codecs operate on. This is the single source of truth for per-stage spec evolution, shared by the synchronous `ChunkTransform` and the asynchronous `AsyncChunkTransform`. It is pure metadata (only `resolve_metadata`), so it places no synchronous-codec requirement on the codecs. """ aa_specs: list[ArraySpec] = [] spec = chunk_spec for aa_codec in aa_codecs: aa_specs.append(spec) spec = aa_codec.resolve_metadata(spec) return tuple(aa_specs), spec def pipeline_supports_partial_decode( array_bytes_codec: ArrayBytesCodec, *, array_array_codecs: tuple[ArrayArrayCodec, ...], bytes_bytes_codecs: tuple[BytesBytesCodec, ...], require_no_aa_bb: bool, ) -> bool: """Whether a codec pipeline can decode a partial selection without a full read. Requires the array->bytes codec to implement ``ArrayBytesCodecPartialDecodeMixin``. When ``require_no_aa_bb`` is True it additionally requires no array->array / bytes->bytes codecs, because those can change the slice<->byte-range correspondence (an AA codec can make the selection non-contiguous, a BB codec can rewrite the bytes), making partial decode infeasible. Both pipelines pass `require_no_aa_bb=True`: an outer AA/BB codec (e.g. a compressor wrapping a sharding serializer) must see every byte of the chunk, so a partial branch that only re-decodes/re-encodes the inner sharding codec would silently bypass it. """ if require_no_aa_bb and (len(array_array_codecs) + len(bytes_bytes_codecs)) != 0: return False return isinstance(array_bytes_codec, ArrayBytesCodecPartialDecodeMixin) def pipeline_supports_partial_encode( array_bytes_codec: ArrayBytesCodec, *, array_array_codecs: tuple[ArrayArrayCodec, ...], bytes_bytes_codecs: tuple[BytesBytesCodec, ...], require_no_aa_bb: bool, ) -> bool: """Whether a codec pipeline can encode a partial selection without a full rewrite. Mirror of `pipeline_supports_partial_decode` for encoding. """ if require_no_aa_bb and (len(array_array_codecs) + len(bytes_bytes_codecs)) != 0: return False return isinstance(array_bytes_codec, ArrayBytesCodecPartialEncodeMixin) async def _cancel_and_drain(futures: Iterable[asyncio.Future[Any]]) -> None: """Cancel every not-yet-done future/task and await its outcome. Used to clean up work spawned by a drain loop (`asyncio.as_completed` + `await`) when the loop exits early via exception. Without this, tasks already spawned keep running unattended after the caller has moved on, and an eventual failure surfaces as an unraisable "exception was never retrieved" warning instead of being observed here. """ pending = [f for f in futures if not f.done()] if len(pending) == 0: return for f in pending: f.cancel() await asyncio.gather(*pending, return_exceptions=True) async def _fetch_and_decode_as_completed( batch: Sequence[tuple[ByteGetter | None, ArraySpec]], transform: ChunkTransform, ) -> list[NDBuffer | None]: """Concurrently fetch each chunk's bytes and decode it as fetches complete. Decoding overlaps with in-flight fetches: each chunk is decoded the moment its bytes arrive (in a thread pool when one is available, otherwise inline) rather than waiting for the whole batch to land. A `None` byte getter fetches nothing and decodes to `None`. Results are returned in input order. """ max_workers = _resolve_max_workers() pool = _get_pool(max_workers) if max_workers > 1 else None loop = asyncio.get_running_loop() decode_futures: list[asyncio.Future[NDBuffer | None]] = [loop.create_future() for _ in batch] async def _fetch( idx: int, byte_getter: ByteGetter | None, prototype: BufferPrototype ) -> tuple[int, Buffer | None]: return idx, None if byte_getter is None else await byte_getter.get(prototype) def _decode(buffer: Buffer | None, chunk_spec: ArraySpec) -> NDBuffer | None: return None if buffer is None else transform.decode_chunk(buffer, chunk_spec) fetch_tasks = concurrent_iter( [ (idx, byte_getter, chunk_spec.prototype) for idx, (byte_getter, chunk_spec) in enumerate(batch) ], _fetch, config.get("async.concurrency"), ) try: for fetch_coro in asyncio.as_completed(fetch_tasks): idx, buffer = await fetch_coro chunk_spec = batch[idx][1] # Bridge both paths to asyncio.Future so the final collection loop # can `await` uniformly without blocking the event loop. For the # pool path that means `wrap_future` (not `pool.submit(...).result()`, # which would block the loop thread for the duration of every decode # — freezing any unrelated coroutines sharing this loop). if pool is None: decode_futures[idx].set_result(_decode(buffer, chunk_spec)) else: decode_futures[idx] = asyncio.wrap_future(pool.submit(_decode, buffer, chunk_spec)) return await asyncio.gather(*decode_futures) finally: # On the happy path every future here is already done, so this is a # no-op; on failure it stops abandoned fetches/decodes from # continuing to run unattended after this function has raised. A # single call over both iterables (not two sequential calls) so that # outer-task cancellation during the first drain can't skip the # second, leaving its futures/tasks unobserved. await _cancel_and_drain(chain(fetch_tasks, decode_futures)) async def _encode_and_write_as_completed( batch: Sequence[tuple[ByteSetter, NDBuffer | None, ArraySpec]], transform: ChunkTransform, ) -> None: """Encode each chunk and write it out as encodes complete. The reverse of `_fetch_and_decode_as_completed`: each chunk is encoded (in a thread pool when one is available, otherwise inline) and its write is launched the moment that chunk's encode finishes — overlapping IO writes with still-running encodes rather than waiting for the whole batch to encode. A `None` chunk array encodes to `None` and is `delete`d. Writes are bounded by `async.concurrency`. """ max_workers = _resolve_max_workers() pool = _get_pool(max_workers) if max_workers > 1 else None loop = asyncio.get_running_loop() semaphore = asyncio.Semaphore(config.get("async.concurrency")) def _encode( idx: int, chunk_array: NDBuffer | None, chunk_spec: ArraySpec ) -> tuple[int, Buffer | None]: return idx, None if chunk_array is None else transform.encode_chunk(chunk_array, chunk_spec) async def _write(idx: int, chunk_bytes: Buffer | None) -> None: byte_setter = batch[idx][0] async with semaphore: if chunk_bytes is None: await byte_setter.delete() else: await byte_setter.set(chunk_bytes) # Submit every encode up front. The pool path bridges to asyncio.Future via # `wrap_future` (not `pool.submit(...).result()`, which would block the loop # thread); the inline path resolves immediately. encode_futures: list[asyncio.Future[tuple[int, Buffer | None]]] = [] for idx, (_, chunk_array, chunk_spec) in enumerate(batch): if pool is None: fut: asyncio.Future[tuple[int, Buffer | None]] = loop.create_future() fut.set_result(_encode(idx, chunk_array, chunk_spec)) else: fut = asyncio.wrap_future(pool.submit(_encode, idx, chunk_array, chunk_spec)) encode_futures.append(fut) # Kick off each chunk's write the instant its encode lands, so writes of # already-compressed chunks proceed while the rest are still encoding. write_tasks: list[asyncio.Task[None]] = [] try: for encode_coro in asyncio.as_completed(encode_futures): idx, chunk_bytes = await encode_coro write_tasks.append(asyncio.ensure_future(_write(idx, chunk_bytes))) await asyncio.gather(*write_tasks) finally: # On the happy path every future here is already done, so this is a # no-op; on failure (an encode or a write raising) it stops # already-spawned writes from continuing in the background after # this function has raised. A single call over both iterables (not # two sequential calls) so that outer-task cancellation during the # first drain can't skip the second, leaving its futures/tasks # unobserved. await _cancel_and_drain(chain(write_tasks, encode_futures)) async def _async_read_fallback( pipeline: CodecPipeline, batch: list[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], out: NDBuffer, drop_axes: tuple[int, ...], ) -> tuple[GetResult, ...]: """Async fallback read used when no fast-path is available. Fetches every chunk's bytes via `concurrent_map` (sized by `async.concurrency`), decodes the batch through `pipeline.decode`, then scatters each decoded chunk into `out` at its `out_selection`. Used by both `BatchedCodecPipeline.read_batch` (non-partial-decode branch) and `FusedCodecPipeline.read` (when the store does not advertise sync IO / sync transform is unavailable). """ chunk_array_batch: list[NDBuffer | None] if isinstance(pipeline, FusedCodecPipeline) and pipeline.sync_transform is not None: chunk_array_batch = await _fetch_and_decode_as_completed( [(byte_getter, chunk_spec) for byte_getter, chunk_spec, *_ in batch], pipeline.sync_transform, ) else: chunk_bytes_batch = await concurrent_map( [(byte_getter, array_spec.prototype) for byte_getter, array_spec, *_ in batch], lambda byte_getter, prototype: byte_getter.get(prototype), config.get("async.concurrency"), ) chunk_array_batch = list( await pipeline.decode( [ (chunk_bytes, chunk_spec) for chunk_bytes, (_, chunk_spec, *_) in zip( chunk_bytes_batch, batch, strict=False ) ], ) ) results: list[GetResult] = [] for chunk_array, (_, chunk_spec, chunk_selection, out_selection, _) in zip( chunk_array_batch, batch, strict=True ): selected = None if chunk_array is None else chunk_array[chunk_selection] results.append( scatter_chunk( selected, out, chunk_spec=chunk_spec, out_selection=out_selection, drop_axes=drop_axes, ) ) return tuple(results) async def _async_write_fallback( pipeline: CodecPipeline, batch: list[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...], ) -> None: """Async fallback write used when no fast-path is available. For each chunk in `batch`: read its existing bytes from the store (skipping the read for complete chunks), decode the batch via `pipeline.decode`, merge `value` into each decoded chunk via `_merge_chunk_array`, drop chunks that are all-fill when `write_empty_chunks` is False, encode the surviving chunks via `pipeline.encode`, then `set` the encoded bytes (or `delete` if encoding produced `None` or the chunk dropped). Used by both `BatchedCodecPipeline.write_batch` (non-partial-encode branch) and `FusedCodecPipeline.write` (when the store does not advertise sync IO / sync transform is unavailable). """ if use_sync := ( isinstance(pipeline, FusedCodecPipeline) and pipeline.sync_transform is not None ): # Read each chunk's existing bytes (skipping complete chunks) and decode # as fetches complete, overlapping the sync decode with in-flight reads. chunk_array_decoded: Iterable[NDBuffer | None] = await _fetch_and_decode_as_completed( [ (None if is_complete_chunk else byte_setter, chunk_spec) for byte_setter, chunk_spec, _, _, is_complete_chunk in batch ], pipeline.sync_transform, ) else: async def _read_key( byte_setter: ByteSetter | None, prototype: BufferPrototype ) -> Buffer | None: if byte_setter is None: return None return await byte_setter.get(prototype=prototype) chunk_bytes_batch: Iterable[Buffer | None] = await concurrent_map( [ ( None if is_complete_chunk else byte_setter, chunk_spec.prototype, ) for byte_setter, chunk_spec, chunk_selection, _, is_complete_chunk in batch ], _read_key, config.get("async.concurrency"), ) chunk_array_decoded = await pipeline.decode( [ (chunk_bytes, chunk_spec) for chunk_bytes, (_, chunk_spec, *_) in zip(chunk_bytes_batch, batch, strict=False) ], ) chunk_array_merged = [ _merge_chunk_array( chunk_array, value, out_selection, chunk_spec, chunk_selection, is_complete_chunk, drop_axes, ) for chunk_array, ( _, chunk_spec, chunk_selection, out_selection, is_complete_chunk, ) in zip(chunk_array_decoded, batch, strict=False) ] # _merge_chunk_array always returns a real NDBuffer (never None), so the only # way a chunk drops to None here is the empty-chunk normalization. chunk_array_batch: list[NDBuffer | None] = [ None if chunk_is_empty(chunk_array, chunk_spec) else chunk_array for chunk_array, (_, chunk_spec, *_) in zip(chunk_array_merged, batch, strict=False) ] if use_sync: sync_transform = cast(FusedCodecPipeline, pipeline).sync_transform assert sync_transform is not None await _encode_and_write_as_completed( [ (byte_setter, chunk_array, chunk_spec) for chunk_array, (byte_setter, chunk_spec, *_) in zip( chunk_array_batch, batch, strict=False ) ], sync_transform, ) else: chunk_bytes_batch = await pipeline.encode( [ (chunk_array, chunk_spec) for chunk_array, (_, chunk_spec, *_) in zip(chunk_array_batch, batch, strict=False) ], ) async def _write_key(byte_setter: ByteSetter, chunk_bytes: Buffer | None) -> None: if chunk_bytes is None: await byte_setter.delete() else: await byte_setter.set(chunk_bytes) await concurrent_map( [ (byte_setter, chunk_bytes) for chunk_bytes, (byte_setter, *_) in zip(chunk_bytes_batch, batch, strict=False) ], _write_key, config.get("async.concurrency"), ) @dataclass(slots=True, kw_only=True) class AsyncChunkTransform: """A per-chunk asynchronous codec chain — the async mirror of ChunkTransform. Decodes/encodes a SINGLE chunk through the full codec chain, awaiting each codec's per-chunk async method (`_decode_single`/`_encode_single`) with the correctly-evolved per-stage spec (via the shared `resolve_aa_specs`). Unlike ChunkTransform it places no `SupportsSyncCodec` requirement on the codecs, so it works for async-only codecs. Unlike the batched codec API it operates on one chunk at a time — the mini-batch fan-out is a BatchedCodecPipeline concern and deliberately not reintroduced here. """ codecs: tuple[Codec, ...] _aa_codecs: tuple[ArrayArrayCodec, ...] = field(init=False, repr=False, compare=False) _ab_codec: ArrayBytesCodec = field(init=False, repr=False, compare=False) _bb_codecs: tuple[BytesBytesCodec, ...] = field(init=False, repr=False, compare=False) def __post_init__(self) -> None: # `AsyncChunkTransform` is (re)constructed per decode/encode call from a # codec chain that already went through `codecs_from_list` when the # pipeline itself was built, so re-splitting it here must not re-emit # that chain's advisory warnings on every call. aa, ab, bb = codecs_from_list_unchecked(list(self.codecs)) self._aa_codecs = aa self._ab_codec = ab self._bb_codecs = bb async def decode_chunk(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> NDBuffer: """Decode one chunk through the chain (bb -> ab -> aa), async.""" aa_specs, ab_spec = resolve_aa_specs(self._aa_codecs, chunk_spec) data: Buffer = chunk_bytes for bb_codec in reversed(self._bb_codecs): data = await bb_codec._decode_single(data, ab_spec) chunk_array: NDBuffer = await self._ab_codec._decode_single(data, ab_spec) for aa_codec, aa_spec in zip(reversed(self._aa_codecs), reversed(aa_specs), strict=True): chunk_array = await aa_codec._decode_single(chunk_array, aa_spec) return chunk_array async def encode_chunk(self, chunk_array: NDBuffer, chunk_spec: ArraySpec) -> Buffer | None: """Encode one chunk through the chain (aa -> ab -> bb), async. Returns None if any stage drops the chunk (e.g. an all-fill chunk under write_empty_chunks=False), matching ChunkTransform.encode_chunk. """ aa_specs, ab_spec = resolve_aa_specs(self._aa_codecs, chunk_spec) aa_data: NDBuffer = chunk_array for aa_codec, aa_spec in zip(self._aa_codecs, aa_specs, strict=True): aa_result = await aa_codec._encode_single(aa_data, aa_spec) if aa_result is None: return None aa_data = aa_result ab_result = await self._ab_codec._encode_single(aa_data, ab_spec) if ab_result is None: return None bb_data: Buffer = ab_result for bb_codec in self._bb_codecs: bb_result = await bb_codec._encode_single(bb_data, ab_spec) if bb_result is None: return None bb_data = bb_result return bb_data @dataclass(frozen=True) class BatchedCodecPipeline(CodecPipeline): """Default codec pipeline. This batched codec pipeline divides the chunk batches into batches of a configurable batch size ("mini-batch"). Fetching, decoding, encoding and storing are performed in lock step for each mini-batch. Multiple mini-batches are processing concurrently. """ array_array_codecs: tuple[ArrayArrayCodec, ...] array_bytes_codec: ArrayBytesCodec bytes_bytes_codecs: tuple[BytesBytesCodec, ...] batch_size: int def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: # Re-splits an already-`codecs_from_list`-validated (and warned-about) # chain against the evolved spec, so this uses the quiet variant rather # than routing through `from_codecs` (which would re-warn). evolved_codecs = evolve_codecs(self, array_spec) array_array_codecs, array_bytes_codec, bytes_bytes_codecs = codecs_from_list_unchecked( evolved_codecs ) return type(self)( array_array_codecs=array_array_codecs, array_bytes_codec=array_bytes_codec, bytes_bytes_codecs=bytes_bytes_codecs, batch_size=self.batch_size, ) @classmethod def from_codecs(cls, codecs: Iterable[Codec], *, batch_size: int | None = None) -> Self: array_array_codecs, array_bytes_codec, bytes_bytes_codecs = codecs_from_list(codecs) return cls( array_array_codecs=array_array_codecs, array_bytes_codec=array_bytes_codec, bytes_bytes_codecs=bytes_bytes_codecs, batch_size=batch_size or config.get("codec_pipeline.batch_size"), ) @property def supports_partial_decode(self) -> bool: # Only a single ArrayBytesCodec that supports partial decoding, and no # AA/BB codecs (they break the slice<->byte-range correspondence). return pipeline_supports_partial_decode( self.array_bytes_codec, array_array_codecs=self.array_array_codecs, bytes_bytes_codecs=self.bytes_bytes_codecs, require_no_aa_bb=True, ) @property def supports_partial_encode(self) -> bool: return pipeline_supports_partial_encode( self.array_bytes_codec, array_array_codecs=self.array_array_codecs, bytes_bytes_codecs=self.bytes_bytes_codecs, require_no_aa_bb=True, ) def __iter__(self) -> Iterator[Codec]: yield from self.array_array_codecs yield self.array_bytes_codec yield from self.bytes_bytes_codecs def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: for codec in self: codec.validate(shape=shape, dtype=dtype, chunk_grid=chunk_grid) def compute_encoded_size(self, byte_length: int, array_spec: ArraySpec) -> int: for codec in self: byte_length = codec.compute_encoded_size(byte_length, array_spec) array_spec = codec.resolve_metadata(array_spec) return byte_length def _codecs_with_resolved_metadata_batched( self, chunk_specs: Iterable[ArraySpec] ) -> tuple[ list[tuple[ArrayArrayCodec, list[ArraySpec]]], tuple[ArrayBytesCodec, list[ArraySpec]], list[tuple[BytesBytesCodec, list[ArraySpec]]], ]: aa_codecs_with_spec: list[tuple[ArrayArrayCodec, list[ArraySpec]]] = [] chunk_specs = list(chunk_specs) for aa_codec in self.array_array_codecs: aa_codecs_with_spec.append((aa_codec, chunk_specs)) chunk_specs = [aa_codec.resolve_metadata(chunk_spec) for chunk_spec in chunk_specs] ab_codec_with_spec = (self.array_bytes_codec, chunk_specs) chunk_specs = [ self.array_bytes_codec.resolve_metadata(chunk_spec) for chunk_spec in chunk_specs ] bb_codecs_with_spec: list[tuple[BytesBytesCodec, list[ArraySpec]]] = [] for bb_codec in self.bytes_bytes_codecs: bb_codecs_with_spec.append((bb_codec, chunk_specs)) chunk_specs = [bb_codec.resolve_metadata(chunk_spec) for chunk_spec in chunk_specs] return (aa_codecs_with_spec, ab_codec_with_spec, bb_codecs_with_spec) async def decode_batch( self, chunk_bytes_and_specs: Iterable[tuple[Buffer | None, ArraySpec]], ) -> Iterable[NDBuffer | None]: chunk_bytes_batch: Iterable[Buffer | None] chunk_bytes_batch, chunk_specs = _unzip2(chunk_bytes_and_specs) ( aa_codecs_with_spec, ab_codec_with_spec, bb_codecs_with_spec, ) = self._codecs_with_resolved_metadata_batched(chunk_specs) for bb_codec, chunk_spec_batch in bb_codecs_with_spec[::-1]: chunk_bytes_batch = await bb_codec.decode( zip(chunk_bytes_batch, chunk_spec_batch, strict=False) ) ab_codec, chunk_spec_batch = ab_codec_with_spec chunk_array_batch = await ab_codec.decode( zip(chunk_bytes_batch, chunk_spec_batch, strict=False) ) for aa_codec, chunk_spec_batch in aa_codecs_with_spec[::-1]: chunk_array_batch = await aa_codec.decode( zip(chunk_array_batch, chunk_spec_batch, strict=False) ) return chunk_array_batch async def decode_partial_batch( self, batch_info: Iterable[tuple[ByteGetter, SelectorTuple, ArraySpec]], ) -> Iterable[NDBuffer | None]: assert self.supports_partial_decode assert isinstance(self.array_bytes_codec, ArrayBytesCodecPartialDecodeMixin) return await self.array_bytes_codec.decode_partial(batch_info) async def encode_batch( self, chunk_arrays_and_specs: Iterable[tuple[NDBuffer | None, ArraySpec]], ) -> Iterable[Buffer | None]: chunk_array_batch: Iterable[NDBuffer | None] chunk_specs: Iterable[ArraySpec] chunk_array_batch, chunk_specs = _unzip2(chunk_arrays_and_specs) for aa_codec in self.array_array_codecs: chunk_array_batch = await aa_codec.encode( zip(chunk_array_batch, chunk_specs, strict=False) ) chunk_specs = resolve_batched(aa_codec, chunk_specs) chunk_bytes_batch = await self.array_bytes_codec.encode( zip(chunk_array_batch, chunk_specs, strict=False) ) chunk_specs = resolve_batched(self.array_bytes_codec, chunk_specs) for bb_codec in self.bytes_bytes_codecs: chunk_bytes_batch = await bb_codec.encode( zip(chunk_bytes_batch, chunk_specs, strict=False) ) chunk_specs = resolve_batched(bb_codec, chunk_specs) return chunk_bytes_batch async def encode_partial_batch( self, batch_info: Iterable[tuple[ByteSetter, NDBuffer, SelectorTuple, ArraySpec]], ) -> None: assert self.supports_partial_encode assert isinstance(self.array_bytes_codec, ArrayBytesCodecPartialEncodeMixin) await self.array_bytes_codec.encode_partial(batch_info) async def read_batch( self, batch_info: Iterable[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], out: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> tuple[GetResult, ...]: if self.supports_partial_decode: results: list[GetResult] = [] batch_info_list = list(batch_info) chunk_array_batch = await self.decode_partial_batch( [ (byte_getter, chunk_selection, chunk_spec) for byte_getter, chunk_spec, chunk_selection, *_ in batch_info_list ] ) for chunk_array, (_, chunk_spec, _, out_selection, _) in zip( chunk_array_batch, batch_info_list, strict=False ): if chunk_array is not None: if drop_axes: chunk_array = chunk_array.squeeze(axis=drop_axes) out[out_selection] = chunk_array results.append(GetResult(status="present")) else: out[out_selection] = fill_value_or_default(chunk_spec) results.append(GetResult(status="missing")) return tuple(results) return await _async_read_fallback(self, list(batch_info), out, drop_axes) async def write_batch( self, batch_info: Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> None: if self.supports_partial_encode: # Pass scalar values as is if len(value.shape) == 0: await self.encode_partial_batch( [ (byte_setter, value, chunk_selection, chunk_spec) for byte_setter, chunk_spec, chunk_selection, out_selection, _ in batch_info ], ) else: await self.encode_partial_batch( [ (byte_setter, value[out_selection], chunk_selection, chunk_spec) for byte_setter, chunk_spec, chunk_selection, out_selection, _ in batch_info ], ) return await _async_write_fallback(self, list(batch_info), value, drop_axes) async def decode( self, chunk_bytes_and_specs: Iterable[tuple[Buffer | None, ArraySpec]], ) -> Iterable[NDBuffer | None]: output: list[NDBuffer | None] = [] for batch_info in batched(chunk_bytes_and_specs, self.batch_size): output.extend(await self.decode_batch(batch_info)) return output async def encode( self, chunk_arrays_and_specs: Iterable[tuple[NDBuffer | None, ArraySpec]], ) -> Iterable[Buffer | None]: output: list[Buffer | None] = [] for single_batch_info in batched(chunk_arrays_and_specs, self.batch_size): output.extend(await self.encode_batch(single_batch_info)) return output async def read( self, batch_info: Iterable[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], out: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> tuple[GetResult, ...]: batch_results = await concurrent_map( [ (single_batch_info, out, drop_axes) for single_batch_info in batched(batch_info, self.batch_size) ], self.read_batch, config.get("async.concurrency"), ) results: list[GetResult] = [] for batch in batch_results: results.extend(batch) return tuple(results) async def write( self, batch_info: Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> None: await concurrent_map( [ (single_batch_info, value, drop_axes) for single_batch_info in batched(batch_info, self.batch_size) ], self.write_batch, config.get("async.concurrency"), ) def codecs_from_list( codecs: Iterable[Codec], ) -> tuple[tuple[ArrayArrayCodec, ...], ArrayBytesCodec, tuple[BytesBytesCodec, ...]]: """Split `codecs` into `(array_array, array_bytes, bytes_bytes)`, validating order. Emits user-facing advisory warnings about the codec chain (e.g. sharding's "disables partial reads" warning). Use this for the FIRST construction of a codec chain from user-supplied codecs. Use `codecs_from_list_unchecked` when re-splitting a chain that was already validated and warned about by a prior `codecs_from_list` call (e.g. `evolve_from_array_spec` re-splitting the same codecs against an evolved spec) — re-warning there would fire the same advisory once per reconstruction instead of once per user-facing chain. """ from zarr.codecs.sharding import ShardingCodec codecs = tuple(codecs) # materialize to avoid generator consumption issues if any(isinstance(codec, ShardingCodec) for codec in codecs) and len(codecs) > 1: warn( "Combining a `sharding_indexed` codec disables partial reads and " "writes, which may lead to inefficient performance.", category=ZarrUserWarning, stacklevel=3, ) return codecs_from_list_unchecked(codecs) def codecs_from_list_unchecked( codecs: Iterable[Codec], ) -> tuple[tuple[ArrayArrayCodec, ...], ArrayBytesCodec, tuple[BytesBytesCodec, ...]]: """Split `codecs` into `(array_array, array_bytes, bytes_bytes)`, validating order. Same structural validation as `codecs_from_list` (raises on bad codec ordering or a missing/duplicate array-bytes codec) but does NOT emit user-facing advisory warnings. See `codecs_from_list` for when to use each. """ codecs = tuple(codecs) # materialize to avoid generator consumption issues array_array: tuple[ArrayArrayCodec, ...] = () array_bytes_maybe: ArrayBytesCodec | None = None bytes_bytes: tuple[BytesBytesCodec, ...] = () for prev_codec, cur_codec in pairwise((None, *codecs)): if isinstance(cur_codec, ArrayArrayCodec): if isinstance(prev_codec, ArrayBytesCodec | BytesBytesCodec): msg = ( f"Invalid codec order. ArrayArrayCodec {cur_codec}" "must be preceded by another ArrayArrayCodec. " f"Got {type(prev_codec)} instead." ) raise TypeError(msg) array_array += (cur_codec,) elif isinstance(cur_codec, ArrayBytesCodec): if isinstance(prev_codec, BytesBytesCodec): msg = ( f"Invalid codec order. ArrayBytes codec {cur_codec}" f" must be preceded by an ArrayArrayCodec. Got {type(prev_codec)} instead." ) raise TypeError(msg) if array_bytes_maybe is not None: msg = ( f"Got two instances of ArrayBytesCodec: {array_bytes_maybe} and {cur_codec}. " "Only one array-to-bytes codec is allowed." ) raise ValueError(msg) array_bytes_maybe = cur_codec elif isinstance(cur_codec, BytesBytesCodec): if isinstance(prev_codec, ArrayArrayCodec): msg = ( f"Invalid codec order. BytesBytesCodec {cur_codec}" "must be preceded by either another BytesBytesCodec, or an ArrayBytesCodec. " f"Got {type(prev_codec)} instead." ) raise TypeError(msg) bytes_bytes += (cur_codec,) else: raise TypeError if array_bytes_maybe is None: raise ValueError("Required ArrayBytesCodec was not found.") else: return array_array, array_bytes_maybe, bytes_bytes register_pipeline(BatchedCodecPipeline) @dataclass(frozen=True) class FusedCodecPipeline(CodecPipeline): """Codec pipeline that runs codec compute synchronously, in bulk. This is an opt-in alternative to `BatchedCodecPipeline`. The win is NOT "separating IO from compute" — the codecs (notably `ShardingCodec`) still perform their own storage IO. The win is replacing the batched pipeline's per-chunk *async scheduling* (≈one coroutine per chunk, which dominates real codec work) with synchronous, batched/coalesced execution: 1. When every codec implements `SupportsSyncCodec`, a `ChunkTransform` runs the codec chain synchronously (no event loop, no per-chunk coroutine) — optionally across a thread pool for CPU-heavy decode/encode. 2. Sharded reads use the codec's synchronous IO methods: byte-range reads coalesced via `Store.get_ranges_sync`, and a vectorized whole-shard bulk decode for dense, fixed-size, uncompressed shards. Sharded writes go through the codec's synchronous full-shard-rewrite path. 3. When the store lacks synchronous IO (e.g. ZipStore) the pipeline falls back to the async path, equivalent to `BatchedCodecPipeline`. IO ownership: the sharding codec holds the byte getter/setter and reads/ writes storage directly (the same model as zarrs; unlike tensorstore, which keeps codecs storage-free). A storage-free codec is a possible future direction (see the pure-codec design notes) but is explicitly NOT what this pipeline does. """ codecs: tuple[Codec, ...] array_array_codecs: tuple[ArrayArrayCodec, ...] array_bytes_codec: ArrayBytesCodec bytes_bytes_codecs: tuple[BytesBytesCodec, ...] sync_transform: ChunkTransform | None batch_size: int @classmethod def from_codecs(cls, codecs: Iterable[Codec], *, batch_size: int | None = None) -> Self: codec_list = tuple(codecs) aa, ab, bb = codecs_from_list(codec_list) if batch_size is None: batch_size = config.get("codec_pipeline.batch_size") return cls( codecs=codec_list, array_array_codecs=aa, array_bytes_codec=ab, bytes_bytes_codecs=bb, sync_transform=None, batch_size=batch_size, ) def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self: # Re-splits an already-`codecs_from_list`-validated (and warned-about) # chain against the evolved spec, so this uses the quiet variant to # avoid re-emitting the same advisory warning on every array open. evolved_codecs = evolve_codecs(self.codecs, array_spec) aa, ab, bb = codecs_from_list_unchecked(evolved_codecs) try: sync_transform: ChunkTransform | None = ChunkTransform(codecs=evolved_codecs) except TypeError: sync_transform = None return type(self)( codecs=evolved_codecs, array_array_codecs=aa, array_bytes_codec=ab, bytes_bytes_codecs=bb, sync_transform=sync_transform, batch_size=self.batch_size, ) def __iter__(self) -> Iterator[Codec]: return iter(self.codecs) @property def supports_partial_decode(self) -> bool: return pipeline_supports_partial_decode( self.array_bytes_codec, array_array_codecs=self.array_array_codecs, bytes_bytes_codecs=self.bytes_bytes_codecs, require_no_aa_bb=True, ) @property def supports_partial_encode(self) -> bool: return pipeline_supports_partial_encode( self.array_bytes_codec, array_array_codecs=self.array_array_codecs, bytes_bytes_codecs=self.bytes_bytes_codecs, require_no_aa_bb=True, ) def validate( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunk_grid: ChunkGridMetadata, ) -> None: for codec in self.codecs: codec.validate(shape=shape, dtype=dtype, chunk_grid=chunk_grid) def compute_encoded_size(self, byte_length: int, array_spec: ArraySpec) -> int: for codec in self: byte_length = codec.compute_encoded_size(byte_length, array_spec) array_spec = codec.resolve_metadata(array_spec) return byte_length # -- async decode/encode (required by ABC) and sync versions -- async def decode( self, chunk_bytes_and_specs: Iterable[tuple[Buffer | None, ArraySpec]], ) -> Iterable[NDBuffer | None]: # Decode each chunk through AsyncChunkTransform, which threads the # per-stage spec correctly (via resolve_aa_specs). This is the single # source of truth for async per-chunk decode; earlier this method # reused one flat `chunk_specs` across every codec stage, which silently # corrupted/crashed spec-changing codecs (transpose/cast/scale_offset) # on the async fallback path. async_transform = AsyncChunkTransform(codecs=self.codecs) out: list[NDBuffer | None] = [] for chunk_bytes, chunk_spec in chunk_bytes_and_specs: if chunk_bytes is None: out.append(None) else: out.append(await async_transform.decode_chunk(chunk_bytes, chunk_spec)) return out async def encode( self, chunk_arrays_and_specs: Iterable[tuple[NDBuffer | None, ArraySpec]], ) -> Iterable[Buffer | None]: async_transform = AsyncChunkTransform(codecs=self.codecs) out: list[Buffer | None] = [] for chunk_array, chunk_spec in chunk_arrays_and_specs: if chunk_array is None: out.append(None) else: out.append(await async_transform.encode_chunk(chunk_array, chunk_spec)) return out # -- sync read/write -- def read_sync( self, batch_info: Iterable[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], out: NDBuffer, drop_axes: tuple[int, ...] = (), max_workers: int = 1, ) -> tuple[GetResult, ...]: """Synchronous read: fetch -> decode -> scatter, per chunk. When `max_workers > 1` and there are multiple chunks, each chunk's full lifecycle (fetch + decode + scatter) runs as one task on a thread pool sized to `max_workers` — overlapping IO of one chunk with decode/scatter of another. Scatter is thread-safe because the chunks have non-overlapping output selections. `max_workers=1` runs everything sequentially in the calling thread (no pool involvement). Mirrors `BatchedCodecPipeline.read_batch`: when the AB codec supports partial decoding (e.g. sharding), the codec handles its own IO and only fetches the inner-chunk byte ranges that overlap the read selection. Otherwise the pipeline fetches the full blob and decodes the whole chunk. """ assert self.sync_transform is not None transform = self.sync_transform batch = list(batch_info) if not batch: return () # Partial-decode fast path: the AB codec owns IO (read only the # byte ranges needed for the requested selection). Same condition # and dispatch as BatchedCodecPipeline.read_batch, plus a gate on the # sync partial method: the public partial-decode contract # (`ArrayBytesCodecPartialDecodeMixin`) only requires the async # `_decode_partial_single`, so a codec may support partial decode # without `_decode_partial_sync` — such codecs take the full-chunk # path below instead. codec = self.array_bytes_codec if self.supports_partial_decode and hasattr(codec, "_decode_partial_sync"): def _read_one( item: tuple[Any, ArraySpec, SelectorTuple, SelectorTuple, bool], ) -> GetResult: byte_getter, chunk_spec, chunk_selection, out_selection, _ = item # the partial decode returns the already-selected region decoded = codec._decode_partial_sync(byte_getter, chunk_selection, chunk_spec) return scatter_chunk( decoded, out, chunk_spec=chunk_spec, out_selection=out_selection, drop_axes=drop_axes, ) else: # Per-chunk fused path: fetch + decode + scatter as one task. def _read_one( item: tuple[Any, ArraySpec, SelectorTuple, SelectorTuple, bool], ) -> GetResult: byte_getter, chunk_spec, chunk_selection, out_selection, _ = item raw = byte_getter.get_sync(prototype=chunk_spec.prototype) return decode_and_scatter_chunk( raw, out, chunk_spec=chunk_spec, chunk_selection=chunk_selection, out_selection=out_selection, drop_axes=drop_axes, decode=transform.decode_chunk, ) if max_workers > 1 and len(batch) > 1: pool = _get_pool(max_workers) return tuple(pool.map(_read_one, batch)) return tuple(_read_one(item) for item in batch) def write_sync( self, batch_info: Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...] = (), max_workers: int = 1, ) -> None: """Synchronous write: fetch existing -> merge+encode -> store. When `max_workers > 1` and there are multiple chunks, each chunk's full lifecycle (get-existing + merge + encode + set/delete) runs as one task on a thread pool sized to `max_workers` — overlapping IO of one chunk with compute of another. `max_workers=1` runs everything sequentially in the calling thread (no pool involvement). When the codec pipeline supports partial encoding (e.g. a sharding codec with no outer AA/BB codecs), the AB codec handles the full write cycle — reading existing data, merging, encoding, and writing — matching the async `BatchedCodecPipeline` path. """ assert self.sync_transform is not None transform = self.sync_transform batch = list(batch_info) if not batch: return # Partial-encode path: the AB codec owns IO (read, merge, encode, # write). Same condition and calling convention as # BatchedCodecPipeline.write_batch, plus a gate on the sync partial # method: the public partial-encode contract # (`ArrayBytesCodecPartialEncodeMixin`) only requires the async # `_encode_partial_single`, so a codec may support partial encode # without `_encode_partial_sync` — such codecs take the full-chunk # path below instead. codec = self.array_bytes_codec if self.supports_partial_encode and hasattr(codec, "_encode_partial_sync"): scalar = len(value.shape) == 0 def _write_one( item: tuple[Any, ArraySpec, SelectorTuple, SelectorTuple, bool], ) -> None: bs, chunk_spec, chunk_selection, out_selection, _is_complete = item chunk_value = value if scalar else value[out_selection] codec._encode_partial_sync(bs, chunk_value, chunk_selection, chunk_spec) else: # Per-chunk fused path: get-existing + merge + encode + set/delete as one task. def _write_one( item: tuple[Any, ArraySpec, SelectorTuple, SelectorTuple, bool], ) -> None: bs, chunk_spec, chunk_selection, out_selection, is_complete = item existing_bytes: Buffer | None = None if not is_complete: existing_bytes = bs.get_sync(prototype=chunk_spec.prototype) encoded = merge_and_encode_chunk( existing_bytes, value, chunk_spec=chunk_spec, chunk_selection=chunk_selection, out_selection=out_selection, is_complete=is_complete, drop_axes=drop_axes, decode=transform.decode_chunk, encode=transform.encode_chunk, ) if encoded is None: bs.delete_sync() else: bs.set_sync(encoded) if max_workers > 1 and len(batch) > 1: pool = _get_pool(max_workers) list(pool.map(_write_one, batch)) else: for item in batch: _write_one(item) # -- async read/write -- async def read( self, batch_info: Iterable[tuple[ByteGetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], out: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> tuple[GetResult, ...]: batch = list(batch_info) if not batch: return () # Fast path: sync transform plus synchronous IO. For StorePath the gate # is the STORE's sync-IO capability (`_store_supports_sync_io`) (StorePath always has a # get_sync method, but it only works when its store implements the full # sync surface); for other byte getters (e.g. the sharding codec's # in-memory _ShardingByteGetter) the SyncByteGetter protocol is the # gate. from zarr.abc.store import SyncByteGetter, _store_supports_sync_io from zarr.storage._common import StorePath first_bg = batch[0][0] if self.sync_transform is not None and ( (isinstance(first_bg, StorePath) and _store_supports_sync_io(first_bg.store)) or (not isinstance(first_bg, StorePath) and isinstance(first_bg, SyncByteGetter)) ): # One thread hop for the WHOLE batch — not per chunk, so the fused # design's win over per-chunk async scheduling is preserved. Running # read_sync inline here would block the event loop for the duration # of the batch's IO+compute; every sync-API call from every user # thread shares this one loop, so inline execution serializes # concurrent callers behind each other's codec compute. return await asyncio.to_thread( self.read_sync, batch, out, drop_axes, max_workers=_resolve_max_workers() ) # Non-sync store (e.g. ZipStore): can't use the sync fast path. But if the # array-bytes codec supports partial decoding (sharding), still route # through the async partial-decode path — it fetches only the needed # inner-chunk byte ranges (coalesced via get_ranges), matching # BatchedCodecPipeline. Without this, the whole-shard _async_read_fallback # below would over-read and diverge from the batched pipeline's IO. if self.supports_partial_decode: assert isinstance(self.array_bytes_codec, ArrayBytesCodecPartialDecodeMixin) chunk_array_batch = await self.array_bytes_codec.decode_partial( [ (byte_getter, chunk_selection, chunk_spec) for byte_getter, chunk_spec, chunk_selection, *_ in batch ] ) results: list[GetResult] = [] for chunk_array, (_, chunk_spec, _, out_selection, _) in zip( chunk_array_batch, batch, strict=False ): if chunk_array is not None: if drop_axes: chunk_array = chunk_array.squeeze(axis=drop_axes) out[out_selection] = chunk_array results.append(GetResult(status="present")) else: out[out_selection] = fill_value_or_default(chunk_spec) results.append(GetResult(status="missing")) return tuple(results) return await _async_read_fallback(self, batch, out, drop_axes) async def write( self, batch_info: Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> None: batch = list(batch_info) if not batch: return # Fast path: sync transform plus synchronous IO. Mirrors `read`: gate # StorePath on the store's sync-IO capability (`_store_supports_sync_io`) — write_sync # needs the FULL sync surface (get_sync for partial-chunk # read-modify-write, delete_sync for all-fill chunks), not just # set_sync — and other byte setters (e.g. the sharding codec's # in-memory _ShardingByteSetter) on SyncByteSetter. from zarr.abc.store import SyncByteSetter, _store_supports_sync_io from zarr.storage._common import StorePath first_bs = batch[0][0] if self.sync_transform is not None and ( (isinstance(first_bs, StorePath) and _store_supports_sync_io(first_bs.store)) or (not isinstance(first_bs, StorePath) and isinstance(first_bs, SyncByteSetter)) ): # One thread hop for the whole batch; see the matching comment in # `read` for why write_sync must not run inline on the event loop. await asyncio.to_thread( self.write_sync, batch, value, drop_axes, max_workers=_resolve_max_workers() ) return await _async_write_fallback(self, batch, value, drop_axes) register_pipeline(FusedCodecPipeline) zarr-python-3.3.0/src/zarr/core/common.py000066400000000000000000000275431523267620000203670ustar00rootroot00000000000000from __future__ import annotations import asyncio import math import warnings from collections.abc import Iterable, Mapping, Sequence from enum import Enum from typing import ( TYPE_CHECKING, Any, Final, Literal, NotRequired, TypedDict, cast, overload, ) import numpy as np from typing_extensions import ReadOnly from zarr.core.config import config as zarr_config from zarr.errors import ZarrRuntimeWarning if TYPE_CHECKING: from collections.abc import Awaitable, Callable, Iterator ZARR_JSON = "zarr.json" ZARRAY_JSON = ".zarray" ZGROUP_JSON = ".zgroup" ZATTRS_JSON = ".zattrs" ZMETADATA_V2_JSON = ".zmetadata" BytesLike = bytes | bytearray | memoryview ShapeLike = Iterable[int | np.integer[Any]] | int | np.integer[Any] ChunksLike = ShapeLike | Iterable[Iterable[int]] # For backwards compatibility ChunkCoords = tuple[int, ...] ZarrFormat = Literal[2, 3] NodeType = Literal["array", "group"] JSON = str | int | float | bool | Mapping[str, "JSON"] | Sequence["JSON"] | None MemoryOrder = Literal["C", "F"] AccessModeLiteral = Literal["r", "r+", "a", "w", "w-"] ANY_ACCESS_MODE: Final = "r", "r+", "a", "w", "w-" DimensionNamesLike = Iterable[str | None] | None DimensionNames = DimensionNamesLike # for backwards compatibility class NamedConfig[TName: str, TConfig: Mapping[str, object]](TypedDict): """ A typed dictionary representing an object with a name and configuration, where the configuration is an optional mapping of string keys to values, e.g. another typed dictionary or a JSON object. This class is generic with two type parameters: the type of the name (``TName``) and the type of the configuration (``TConfig``). """ name: ReadOnly[TName] """The name of the object.""" configuration: NotRequired[ReadOnly[TConfig]] """The configuration of the object. Not required.""" class NamedRequiredConfig[TName: str, TConfig: Mapping[str, object]](TypedDict): """ A typed dictionary representing an object with a name and configuration, where the configuration is a mapping of string keys to values, e.g. another typed dictionary or a JSON object. This class is generic with two type parameters: the type of the name (``TName``) and the type of the configuration (``TConfig``). """ name: ReadOnly[TName] """The name of the object.""" configuration: ReadOnly[TConfig] """The configuration of the object.""" def product(tup: tuple[int, ...]) -> int: return math.prod(tup) def ceildiv(a: float, b: float) -> int: if a == 0: return 0 return math.ceil(a / b) def concurrent_iter[T: tuple[Any, ...], V]( items: Iterable[T], func: Callable[..., Awaitable[V]], limit: int | None = None, ) -> list[asyncio.Task[V]]: """Launch `func(*item)` for each item concurrently, returning the tasks. When `limit` is set, no more than `limit` calls are in flight at once. Tasks are returned in input order; callers that want completion order should wrap the result in `asyncio.as_completed`. Every task is scheduled (via `ensure_future`) before this function returns, not on first iteration of the result. That matters for callers that await the returned tasks one at a time — without eager scheduling, each coroutine would only start when individually awaited, serializing the work and defeating the semaphore. It also makes the return type honest (real `Task`s support `.cancel()`, `.done()`, callbacks) rather than bare coroutines. See https://docs.python.org/3/library/asyncio-task.html#coroutines: "Note that simply calling a coroutine will not schedule it to be executed:" """ if limit is None: return [asyncio.ensure_future(func(*item)) for item in items] sem = asyncio.Semaphore(limit) async def run(item: T) -> V: async with sem: return await func(*item) return [asyncio.ensure_future(run(item)) for item in items] async def concurrent_map[T: tuple[Any, ...], V]( items: Iterable[T], func: Callable[..., Awaitable[V]], limit: int | None = None, ) -> list[V]: return await asyncio.gather(*concurrent_iter(items, func, limit)) def enum_names[E: Enum](enum: type[E]) -> Iterator[str]: for item in enum: yield item.name def parse_enum[E: Enum](data: object, cls: type[E]) -> E: if isinstance(data, cls): return data if not isinstance(data, str): raise TypeError(f"Expected str, got {type(data)}") if data in enum_names(cls): return cls(data) raise ValueError(f"Value must be one of {list(enum_names(cls))!r}. Got {data} instead.") def parse_name(data: JSON, expected: str | None = None) -> str: if isinstance(data, str): if expected is None or data == expected: return data raise ValueError(f"Expected '{expected}'. Got {data} instead.") else: raise TypeError(f"Expected a string, got an instance of {type(data)}.") def parse_configuration(data: JSON) -> JSON: if not isinstance(data, dict): raise TypeError(f"Expected dict, got {type(data)}") return data @overload def parse_named_configuration( data: JSON | NamedConfig[str, Any], expected_name: str | None = None ) -> tuple[str, dict[str, JSON]]: ... @overload def parse_named_configuration( data: JSON | NamedConfig[str, Any], expected_name: str | None = None, *, require_configuration: bool = True, ) -> tuple[str, dict[str, JSON] | None]: ... def parse_named_configuration( data: JSON | NamedConfig[str, Any], expected_name: str | None = None, *, require_configuration: bool = True, ) -> tuple[str, JSON | None]: if not isinstance(data, dict): raise TypeError(f"Expected dict, got {type(data)}") if "name" not in data: raise ValueError(f"Named configuration does not have a 'name' key. Got {data}.") name_parsed = parse_name(data["name"], expected_name) if "configuration" in data: configuration_parsed = parse_configuration(data["configuration"]) elif require_configuration: raise ValueError(f"Named configuration does not have a 'configuration' key. Got {data}.") else: configuration_parsed = None return name_parsed, configuration_parsed def parse_shapelike(data: ShapeLike) -> tuple[int, ...]: """ Parse a shape-like input into an explicit shape. """ if isinstance(data, int | np.integer): if data < 0: raise ValueError(f"Expected a non-negative integer. Got {data} instead") return (int(data),) try: data_tuple = tuple(data) except TypeError as e: msg = f"Expected an integer or an iterable of integers. Got {data} instead." raise TypeError(msg) from e if not all(isinstance(v, int | np.integer) for v in data_tuple): msg = f"Expected an iterable of integers. Got {data} instead." raise TypeError(msg) if not all(v > -1 for v in data_tuple): msg = f"Expected all values to be non-negative. Got {data} instead." raise ValueError(msg) # cast NumPy scalars to plain python ints return tuple(int(x) for x in data_tuple) def parse_fill_value(data: Any) -> Any: # todo: real validation return data def parse_order(data: Any) -> Literal["C", "F"]: if data in ("C", "F"): return cast("Literal['C', 'F']", data) raise ValueError(f"Expected one of ('C', 'F'), got {data} instead.") def parse_bool(data: Any) -> bool: if isinstance(data, bool): return data raise ValueError(f"Expected bool, got {data} instead.") def parse_int(data: Any) -> int: if isinstance(data, int) and not isinstance(data, bool): return data raise ValueError(f"Expected int, got {data} instead.") def _warn_write_empty_chunks_kwarg() -> None: # TODO: link to docs page on array configuration in this message msg = ( "The `write_empty_chunks` keyword argument is deprecated and will be removed in future versions. " "To control whether empty chunks are written to storage, either use the `config` keyword " "argument, as in `config={'write_empty_chunks': True}`," "or change the global 'array.write_empty_chunks' configuration variable." ) warnings.warn(msg, ZarrRuntimeWarning, stacklevel=2) def _warn_order_kwarg() -> None: # TODO: link to docs page on array configuration in this message msg = ( "The `order` keyword argument has no effect for Zarr format 3 arrays. " "To control the memory layout of the array, either use the `config` keyword " "argument, as in `config={'order': 'C'}`," "or change the global 'array.order' configuration variable." ) warnings.warn(msg, ZarrRuntimeWarning, stacklevel=2) def _default_zarr_format() -> ZarrFormat: """Return the default zarr_format.""" return cast("ZarrFormat", int(zarr_config.get("default_zarr_format", 3))) def expand_rle(data: Sequence[int | list[int]]) -> list[int]: """Expand a mixed array of bare integers and RLE pairs. Per the rectilinear chunk grid spec, each element can be: - a bare integer (an explicit edge length) - a two-element array ``[value, count]`` (run-length encoded) """ result: list[int] = [] for item in data: if isinstance(item, (int, float)) and not isinstance(item, bool): val = int(item) if val < 1: raise ValueError(f"Chunk edge length must be >= 1, got {val}") result.append(val) elif isinstance(item, list) and len(item) == 2: size, count = int(item[0]), int(item[1]) if size < 1: raise ValueError(f"Chunk edge length must be >= 1, got {size}") if count < 1: raise ValueError(f"RLE repeat count must be >= 1, got {count}") result.extend([size] * count) else: raise ValueError(f"RLE entries must be an integer or [size, count], got {item}") return result def compress_rle(sizes: Sequence[int]) -> list[int | list[int]]: """Compress chunk sizes to mixed RLE format per the rectilinear spec. Runs of length > 1 are emitted as ``[value, count]`` pairs; runs of length 1 are emitted as bare integers:: [10, 10, 10, 5] -> [[10, 3], 5] """ if not sizes: return [] result: list[int | list[int]] = [] current = sizes[0] count = 1 for s in sizes[1:]: if s == current: count += 1 else: result.append([current, count] if count > 1 else current) current = s count = 1 result.append([current, count] if count > 1 else current) return result def validate_rectilinear_kind(kind: str | None) -> None: """Validate the ``kind`` field of a rectilinear chunk grid configuration. The rectilinear spec requires ``kind: "inline"``. """ if kind is None: raise ValueError( "Rectilinear chunk grid configuration requires a 'kind' field. " "Only 'inline' is currently supported." ) if kind != "inline": raise ValueError( f"Unsupported rectilinear chunk grid kind: {kind!r}. " "Only 'inline' is currently supported." ) def validate_rectilinear_edges( chunk_shapes: Sequence[int | Sequence[int]], array_shape: Sequence[int] ) -> None: """Validate that rectilinear chunk edges cover the array extent per dimension. Bare-int dimensions (regular step) always cover any extent, so they are skipped. Explicit edge lists must sum to at least the array extent. """ for i, (dim_spec, extent) in enumerate(zip(chunk_shapes, array_shape, strict=True)): if isinstance(dim_spec, int): continue edge_sum = sum(dim_spec) if edge_sum < extent: raise ValueError( f"Rectilinear chunk edges for dimension {i} sum to {edge_sum} " f"but array shape extent is {extent} (edge sum must be >= extent)" ) zarr-python-3.3.0/src/zarr/core/config.py000066400000000000000000000155261523267620000203420ustar00rootroot00000000000000""" The config module is responsible for managing the configuration of zarr and is based on the Donfig python library. For selecting custom implementations of codecs, pipelines, buffers and ndbuffers, first register the implementations in the registry and then select them in the config. Example: An implementation of the bytes codec in a class ``your.module.NewBytesCodec`` requires the value of ``codecs.bytes`` to be ``your.module.NewBytesCodec``. Donfig can be configured programmatically, by environment variables, or from YAML files in standard locations. ```python from your.module import NewBytesCodec from zarr.core.config import register_codec, config register_codec("bytes", NewBytesCodec) config.set({"codecs.bytes": "your.module.NewBytesCodec"}) ``` Instead of setting the value programmatically with ``config.set``, you can also set the value with an environment variable. The environment variable ``ZARR_CODECS__BYTES`` can be set to ``your.module.NewBytesCodec``. The double underscore ``__`` is used to indicate nested access. ```bash export ZARR_CODECS__BYTES="your.module.NewBytesCodec" ``` For more information, see the Donfig documentation at https://github.com/pytroll/donfig. """ from __future__ import annotations from typing import TYPE_CHECKING, Any, Literal, cast from donfig import Config as DConfig if TYPE_CHECKING: from donfig.config_obj import ConfigSet class BadConfigError(ValueError): _msg = "bad Config: %r" class Config(DConfig): # type: ignore[misc] """The Config will collect configuration from config files and environment variables Example environment variables: Grabs environment variables of the form "ZARR_FOO__BAR_BAZ=123" and turns these into config variables of the form ``{"foo": {"bar-baz": 123}}`` It transforms the key and value in the following way: - Lower-cases the key text - Treats ``__`` (double-underscore) as nested access - Calls ``ast.literal_eval`` on the value """ def reset(self) -> None: self.clear() self.refresh() def enable_gpu(self) -> ConfigSet: """ Configure Zarr to use GPUs where possible. """ return self.set( {"buffer": "zarr.buffer.gpu.Buffer", "ndbuffer": "zarr.buffer.gpu.NDBuffer"} ) # these keys were removed from the config as part of the 3.1.0 release. # these deprecations should be removed in 3.1.1 or thereabouts. deprecations = { "array.v2_default_compressor.numeric": None, "array.v2_default_compressor.string": None, "array.v2_default_compressor.bytes": None, "array.v2_default_filters.string": None, "array.v2_default_filters.bytes": None, "array.v3_default_filters.numeric": None, "array.v3_default_filters.raw": None, "array.v3_default_filters.bytes": None, "array.v3_default_serializer.numeric": None, "array.v3_default_serializer.string": None, "array.v3_default_serializer.bytes": None, "array.v3_default_compressors.string": None, "array.v3_default_compressors.bytes": None, "array.v3_default_compressors": None, } # The default configuration for zarr config = Config( "zarr", defaults=[ { "default_zarr_format": 3, "array": { "order": "C", "write_empty_chunks": False, "read_missing_chunks": True, "target_shard_size_bytes": None, "rectilinear_chunks": False, "sharding_coalesce_max_gap_bytes": 1 << 20, # 1 MiB "sharding_coalesce_max_bytes": 16 << 20, # 16 MiB }, "async": {"concurrency": 10, "timeout": None}, "threading": {"max_workers": None}, "json_indent": 2, "codec_pipeline": { # FusedCodecPipeline is the faster synchronous pipeline, but it stays # opt-in for now so behavior is unchanged for existing users. Early # adopters can switch with # zarr.config.set( # {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} # ) "path": "zarr.core.codec_pipeline.BatchedCodecPipeline", "batch_size": 1, # Only read by FusedCodecPipeline (BatchedCodecPipeline ignores it). "max_workers": None, }, "codecs": { "blosc": "zarr.codecs.blosc.BloscCodec", "gzip": "zarr.codecs.gzip.GzipCodec", "zstd": "zarr.codecs.zstd.ZstdCodec", "bytes": "zarr.codecs.bytes.BytesCodec", "endian": "zarr.codecs.bytes.BytesCodec", # compatibility with earlier versions of ZEP1 "crc32c": "zarr.codecs.crc32c_.Crc32cCodec", "sharding_indexed": "zarr.codecs.sharding.ShardingCodec", "transpose": "zarr.codecs.transpose.TransposeCodec", "vlen-utf8": "zarr.codecs.vlen_utf8.VLenUTF8Codec", "vlen-bytes": "zarr.codecs.vlen_utf8.VLenBytesCodec", "numcodecs.bz2": "zarr.codecs.numcodecs.BZ2", "numcodecs.crc32": "zarr.codecs.numcodecs.CRC32", "numcodecs.crc32c": "zarr.codecs.numcodecs.CRC32C", "numcodecs.lz4": "zarr.codecs.numcodecs.LZ4", "numcodecs.lzma": "zarr.codecs.numcodecs.LZMA", "numcodecs.zfpy": "zarr.codecs.numcodecs.ZFPY", "numcodecs.adler32": "zarr.codecs.numcodecs.Adler32", "numcodecs.astype": "zarr.codecs.numcodecs.AsType", "numcodecs.bitround": "zarr.codecs.numcodecs.BitRound", "numcodecs.blosc": "zarr.codecs.numcodecs.Blosc", "numcodecs.delta": "zarr.codecs.numcodecs.Delta", "numcodecs.fixedscaleoffset": "zarr.codecs.numcodecs.FixedScaleOffset", "numcodecs.fletcher32": "zarr.codecs.numcodecs.Fletcher32", "numcodecs.gzip": "zarr.codecs.numcodecs.GZip", "numcodecs.jenkins_lookup3": "zarr.codecs.numcodecs.JenkinsLookup3", "numcodecs.pcodec": "zarr.codecs.numcodecs.PCodec", "numcodecs.packbits": "zarr.codecs.numcodecs.PackBits", "numcodecs.shuffle": "zarr.codecs.numcodecs.Shuffle", "numcodecs.quantize": "zarr.codecs.numcodecs.Quantize", "numcodecs.zlib": "zarr.codecs.numcodecs.Zlib", "numcodecs.zstd": "zarr.codecs.numcodecs.Zstd", }, "buffer": "zarr.buffer.cpu.Buffer", "ndbuffer": "zarr.buffer.cpu.NDBuffer", } ], deprecations=deprecations, ) def parse_indexing_order(data: Any) -> Literal["C", "F"]: if data in ("C", "F"): return cast("Literal['C', 'F']", data) msg = f"Expected one of ('C', 'F'), got {data} instead." raise ValueError(msg) zarr-python-3.3.0/src/zarr/core/dtype/000077500000000000000000000000001523267620000176375ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/core/dtype/__init__.py000066400000000000000000000226301523267620000217530ustar00rootroot00000000000000from __future__ import annotations from collections.abc import Sequence from typing import TYPE_CHECKING, Final from zarr.core.dtype.npy.bool import Bool from zarr.core.dtype.npy.bytes import ( NullTerminatedBytes, NullterminatedBytesJSON_V2, NullTerminatedBytesJSON_V3, RawBytes, RawBytesJSON_V2, RawBytesJSON_V3, VariableLengthBytes, VariableLengthBytesJSON_V2, ) from zarr.core.dtype.npy.complex import Complex64, Complex128 from zarr.core.dtype.npy.float import Float16, Float32, Float64 from zarr.core.dtype.npy.int import Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64 from zarr.core.dtype.npy.structured import ( Struct, StructJSON_V3, Structured, StructuredJSON_V2, StructuredJSON_V3, ) from zarr.core.dtype.npy.time import ( DateTime64, DateTime64JSON_V2, DateTime64JSON_V3, TimeDelta64, TimeDelta64JSON_V2, TimeDelta64JSON_V3, ) if TYPE_CHECKING: from zarr.core.common import ZarrFormat from zarr.core.dtype.common import DTypeJSON from collections.abc import Mapping import numpy as np import numpy.typing as npt from zarr.core.common import JSON from zarr.core.dtype.npy.string import ( FixedLengthUTF32, FixedLengthUTF32JSON_V2, FixedLengthUTF32JSON_V3, VariableLengthUTF8, VariableLengthUTF8JSON_V2, ) from zarr.core.dtype.registry import DataTypeRegistry from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType __all__ = [ "Bool", "Complex64", "Complex128", "DataTypeRegistry", "DateTime64", "DateTime64JSON_V2", "DateTime64JSON_V3", "FixedLengthUTF32", "FixedLengthUTF32JSON_V2", "FixedLengthUTF32JSON_V3", "Float16", "Float32", "Float64", "Int8", "Int16", "Int32", "Int64", "NullTerminatedBytes", "NullTerminatedBytesJSON_V3", "NullterminatedBytesJSON_V2", "RawBytes", "RawBytesJSON_V2", "RawBytesJSON_V3", "Struct", "StructJSON_V3", "Structured", "StructuredJSON_V2", "StructuredJSON_V3", "TBaseDType", "TBaseScalar", "TimeDelta64", "TimeDelta64JSON_V2", "TimeDelta64JSON_V3", "UInt8", "UInt16", "UInt32", "UInt64", "VariableLengthBytes", "VariableLengthBytesJSON_V2", "VariableLengthUTF8", "VariableLengthUTF8JSON_V2", "ZDType", "data_type_registry", "parse_data_type", "parse_dtype", ] data_type_registry = DataTypeRegistry() IntegerDType = Int8 | Int16 | Int32 | Int64 | UInt8 | UInt16 | UInt32 | UInt64 INTEGER_DTYPE: Final = Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64 FloatDType = Float16 | Float32 | Float64 FLOAT_DTYPE: Final = Float16, Float32, Float64 ComplexFloatDType = Complex64 | Complex128 COMPLEX_FLOAT_DTYPE: Final = Complex64, Complex128 StringDType = FixedLengthUTF32 | VariableLengthUTF8 STRING_DTYPE: Final = FixedLengthUTF32, VariableLengthUTF8 TimeDType = DateTime64 | TimeDelta64 TIME_DTYPE: Final = DateTime64, TimeDelta64 BytesDType = RawBytes | NullTerminatedBytes | VariableLengthBytes BYTES_DTYPE: Final = RawBytes, NullTerminatedBytes, VariableLengthBytes AnyDType = ( Bool | IntegerDType | FloatDType | ComplexFloatDType | StringDType | BytesDType | Struct | TimeDType | VariableLengthBytes ) # mypy has trouble inferring the type of variablelengthstring dtype, because its class definition # depends on the installed numpy version. That's why the type: ignore statement is needed here. ANY_DTYPE: Final = ( Bool, *INTEGER_DTYPE, *FLOAT_DTYPE, *COMPLEX_FLOAT_DTYPE, *STRING_DTYPE, *BYTES_DTYPE, Struct, *TIME_DTYPE, VariableLengthBytes, ) # These are aliases for variable-length UTF-8 strings # We handle them when a user requests a data type instead of using NumPy's dtype inferece because # the default NumPy behavior -- to inspect the user-provided array data and choose # an appropriately sized U dtype -- is unworkable for Zarr. VLEN_UTF8_ALIAS: Final = ("str", str, "string") # This type models inputs that can be coerced to a ZDType type ZDTypeLike = npt.DTypeLike | ZDType[TBaseDType, TBaseScalar] | Mapping[str, JSON] | str for dtype in ANY_DTYPE: # mypy does not know that all the elements of ANY_DTYPE are subclasses of ZDType data_type_registry.register(dtype._zarr_v3_name, dtype) # type: ignore[arg-type] # TODO: find a better name for this function def get_data_type_from_native_dtype(dtype: npt.DTypeLike) -> ZDType[TBaseDType, TBaseScalar]: """ Get a data type wrapper (an instance of ``ZDType``) from a native data type, e.g. a numpy dtype. """ if not isinstance(dtype, np.dtype): na_dtype: np.dtype[np.generic] if isinstance(dtype, list): # this is a valid _VoidDTypeLike check na_dtype = np.dtype([tuple(d) for d in dtype]) else: na_dtype = np.dtype(dtype) else: na_dtype = dtype return data_type_registry.match_dtype(dtype=na_dtype) def get_data_type_from_json( dtype_spec: DTypeJSON, *, zarr_format: ZarrFormat ) -> ZDType[TBaseDType, TBaseScalar]: """ Given a JSON representation of a data type and a Zarr format version, attempt to create a ZDType instance from the registered ZDType classes. """ return data_type_registry.match_json(dtype_spec, zarr_format=zarr_format) def parse_data_type( dtype_spec: ZDTypeLike, *, zarr_format: ZarrFormat, ) -> ZDType[TBaseDType, TBaseScalar]: """ Interpret the input as a ZDType. This function wraps ``parse_dtype``. The only difference is the function name. This function may be deprecated in a future version of Zarr Python in favor of ``parse_dtype``. Parameters ---------- dtype_spec : ZDTypeLike The input to be interpreted as a ZDType. This could be a ZDType, which will be returned directly, or a JSON representation of a ZDType, or a native dtype, or a python object that can be converted into a native dtype. zarr_format : ZarrFormat The Zarr format version. This parameter is required because this function will attempt to parse the JSON representation of a data type, and the JSON representation of data types varies between Zarr 2 and Zarr 3. Returns ------- ZDType[TBaseDType, TBaseScalar] The ZDType corresponding to the input. Examples -------- ```python from zarr.dtype import parse_data_type import numpy as np parse_data_type("int32", zarr_format=2) # Int32(endianness='little') parse_data_type(np.dtype('S10'), zarr_format=2) # NullTerminatedBytes(length=10) parse_data_type({"name": "numpy.datetime64", "configuration": {"unit": "s", "scale_factor": 10}}, zarr_format=3) # DateTime64(endianness='little', scale_factor=10, unit='s') ``` """ return parse_dtype(dtype_spec, zarr_format=zarr_format) def parse_dtype( dtype_spec: ZDTypeLike, *, zarr_format: ZarrFormat, ) -> ZDType[TBaseDType, TBaseScalar]: """ Convert the input as a ZDType. Parameters ---------- dtype_spec : ZDTypeLike The input to be converted to a ZDType. This could be a ZDType, which will be returned directly, or a JSON representation of a ZDType, or a numpy dtype, or a python object that can be converted into a native dtype. zarr_format : ZarrFormat The Zarr format version. This parameter is required because this function will attempt to parse the JSON representation of a data type, and the JSON representation of data types varies between Zarr 2 and Zarr 3. Returns ------- ZDType[TBaseDType, TBaseScalar] The ZDType corresponding to the input. Examples -------- ```python from zarr.dtype import parse_dtype import numpy as np parse_dtype("int32", zarr_format=2) # Int32(endianness='little') parse_dtype(np.dtype('S10'), zarr_format=2) # NullTerminatedBytes(length=10) parse_dtype({"name": "numpy.datetime64", "configuration": {"unit": "s", "scale_factor": 10}}, zarr_format=3) # DateTime64(endianness='little', scale_factor=10, unit='s') ``` """ if isinstance(dtype_spec, ZDType): return dtype_spec # First attempt to interpret the input as JSON if isinstance(dtype_spec, Mapping | str | Sequence): try: return get_data_type_from_json(dtype_spec, zarr_format=zarr_format) except ValueError: # no data type matched this JSON-like input pass if dtype_spec in VLEN_UTF8_ALIAS: # If the dtype request is one of the aliases for variable-length UTF-8 strings, # return that dtype. return VariableLengthUTF8() # type: ignore[return-value] # otherwise, we have either a numpy dtype string, or a zarr v3 dtype string, and in either case # we can create a native dtype from it, and do the dtype inference from that return get_data_type_from_native_dtype(dtype_spec) # type: ignore[arg-type] def __getattr__(name: str) -> object: if name == "DataTypeValidationError": import warnings from zarr.errors import DataTypeValidationError, ZarrDeprecationWarning warnings.warn( "Importing DataTypeValidationError from zarr.core.dtype is deprecated. " "Use zarr.errors.DataTypeValidationError instead.", ZarrDeprecationWarning, stacklevel=2, ) return DataTypeValidationError raise AttributeError(f"module {__name__!r} has no attribute {name!r}") zarr-python-3.3.0/src/zarr/core/dtype/common.py000066400000000000000000000214571523267620000215120ustar00rootroot00000000000000from __future__ import annotations import warnings from collections.abc import Mapping, Sequence from dataclasses import dataclass from typing import ( ClassVar, Final, Literal, TypedDict, TypeGuard, ) from typing_extensions import ReadOnly from zarr.core.common import NamedConfig from zarr.errors import UnstableSpecificationWarning EndiannessStr = Literal["little", "big"] ENDIANNESS_STR: Final = "little", "big" SpecialFloatStrings = Literal["NaN", "Infinity", "-Infinity"] SPECIAL_FLOAT_STRINGS: Final = ("NaN", "Infinity", "-Infinity") JSONFloatV2 = float | SpecialFloatStrings JSONFloatV3 = float | SpecialFloatStrings | str ObjectCodecID = Literal["vlen-utf8", "vlen-bytes", "vlen-array", "pickle", "json2", "msgpack2"] # These are the ids of the known object codecs for zarr v2. OBJECT_CODEC_IDS: Final = ("vlen-utf8", "vlen-bytes", "vlen-array", "pickle", "json2", "msgpack2") # This is a wider type than our standard JSON type because we need # to work with typeddict objects which are assignable to Mapping[str, object] DTypeJSON = str | int | float | Sequence["DTypeJSON"] | None | Mapping[str, object] # The DTypeJSON_V2 type exists because ZDType.from_json takes a single argument, which must contain # all the information necessary to decode the data type. Zarr v2 supports multiple distinct # data types that all used the "|O" data type identifier. These data types can only be # discriminated on the basis of their "object codec", i.e. a special data type specific # compressor or filter. So to figure out what data type a zarr v2 array has, we need the # data type identifier from metadata, as well as an object codec id if the data type identifier # is "|O". # So we will pack the name of the dtype alongside the name of the object codec id, if applicable, # in a single dict, and pass that to the data type inference logic. # These type variables have a very wide bound because the individual zdtype # classes can perform a very specific type check. # This is the JSON representation of a structured dtype in zarr v2 StructuredName_V2 = Sequence["str | StructuredName_V2"] # This models the type of the name a dtype might have in zarr v2 array metadata DTypeName_V2 = StructuredName_V2 | str class DTypeConfig_V2[TDTypeNameV2: DTypeName_V2, TObjectCodecID: None | str](TypedDict): name: ReadOnly[TDTypeNameV2] object_codec_id: ReadOnly[TObjectCodecID] DTypeSpec_V2 = DTypeConfig_V2[DTypeName_V2, None | str] def check_structured_dtype_v2_inner(data: object) -> TypeGuard[StructuredName_V2]: """ A type guard for the inner elements of a structured dtype. This is a recursive check because the type is itself recursive. This check ensures that all the elements are 2-element sequences beginning with a string and ending with either another string or another 2-element sequence beginning with a string and ending with another instance of that type. """ if isinstance(data, (str, Mapping)): return False if not isinstance(data, Sequence): return False if len(data) != 2: return False if not (isinstance(data[0], str)): return False if isinstance(data[-1], str): return True elif isinstance(data[-1], Sequence): return check_structured_dtype_v2_inner(data[-1]) return False def check_structured_dtype_name_v2(data: Sequence[object]) -> TypeGuard[StructuredName_V2]: """ Check that all the elements of a sequence are valid zarr v2 structured dtype identifiers """ return all(check_structured_dtype_v2_inner(d) for d in data) def check_dtype_name_v2(data: object) -> TypeGuard[DTypeName_V2]: """ Type guard for narrowing the type of a python object to a valid zarr v2 dtype name. """ if isinstance(data, str): return True elif isinstance(data, Sequence): return check_structured_dtype_name_v2(data) return False def check_dtype_spec_v2(data: object) -> TypeGuard[DTypeSpec_V2]: """ Type guard for narrowing a python object to an instance of DTypeSpec_V2 """ if not isinstance(data, Mapping): return False if set(data.keys()) != {"name", "object_codec_id"}: return False if not check_dtype_name_v2(data["name"]): return False return isinstance(data["object_codec_id"], str | None) # By comparison, The JSON representation of a dtype in zarr v3 is much simpler. # It's either a string, or a structured dict DTypeSpec_V3 = str | NamedConfig[str, Mapping[str, object]] def check_dtype_spec_v3(data: object) -> TypeGuard[DTypeSpec_V3]: """ Type guard for narrowing the type of a python object to an instance of DTypeSpec_V3, i.e either a string or a dict with a "name" field that's a string and a "configuration" field that's a mapping with string keys. """ if isinstance(data, str) or ( # noqa: SIM103 isinstance(data, Mapping) and set(data.keys()) == {"name", "configuration"} and isinstance(data["configuration"], Mapping) and all(isinstance(k, str) for k in data["configuration"]) ): return True return False def unpack_dtype_json(data: DTypeSpec_V2 | DTypeSpec_V3) -> DTypeJSON: """ Return the array metadata form of the dtype JSON representation. For the Zarr V3 form of dtype metadata, this is a no-op. For the Zarr V2 form of dtype metadata, this unpacks the dtype name. """ if isinstance(data, Mapping) and set(data.keys()) == {"name", "object_codec_id"}: return data["name"] return data def __getattr__(name: str) -> object: if name == "DataTypeValidationError": import warnings from zarr.errors import DataTypeValidationError, ZarrDeprecationWarning warnings.warn( "Importing DataTypeValidationError from zarr.core.dtype.common is deprecated. " "Use zarr.errors.DataTypeValidationError or zarr.dtype.DataTypeValidationError instead.", ZarrDeprecationWarning, stacklevel=2, ) return DataTypeValidationError raise AttributeError(f"module {__name__!r} has no attribute {name!r}") class ScalarTypeValidationError(ValueError): ... @dataclass(frozen=True, kw_only=True) class HasLength: """ A mix-in class for data types with a length attribute, such as fixed-size collections of unicode strings, or bytes. Attributes ---------- length : int The length of the scalars belonging to this data type. Note that this class does not assign a unit to the length. Child classes may assign units. """ length: int @dataclass(frozen=True, kw_only=True) class HasEndianness: """ A mix-in class for data types with an endianness attribute """ endianness: EndiannessStr = "little" @dataclass(frozen=True, kw_only=True) class HasItemSize: """ A mix-in class for data types with an item size attribute. This mix-in bears a property ``item_size``, which denotes the size of each element of the data type, in bytes. """ @property def item_size(self) -> int: raise NotImplementedError @dataclass(frozen=True, kw_only=True) class HasObjectCodec: """ A mix-in class for data types that require an object codec id. This class bears the property ``object_codec_id``, which is the string name of an object codec that is required to encode and decode the data type. In zarr-python 2.x certain data types like variable-length strings or variable-length arrays used the catch-all numpy "object" data type for their in-memory representation. But these data types cannot be stored as numpy object data types, because the object data type does not define a fixed memory layout. So these data types required a special codec, called an "object codec", that effectively defined a compact representation for the data type, which was used to encode and decode the data type. Zarr-python 2.x would not allow the creation of arrays with the "object" data type if an object codec was not specified, and thus the name of the object codec is effectively part of the data type model. """ object_codec_id: ClassVar[str] def v3_unstable_dtype_warning(dtype: object) -> None: """ Emit this warning when a data type does not have a stable zarr v3 spec """ msg = ( f"The data type ({dtype}) does not have a Zarr V3 specification. " "That means that the representation of arrays saved with this data type may change without " "warning in a future version of Zarr Python. " "Arrays stored with this data type may be unreadable by other Zarr libraries. " "Use this data type at your own risk! " "Check https://github.com/zarr-developers/zarr-extensions/tree/main/data-types for the " "status of data type specifications for Zarr V3." ) warnings.warn(msg, category=UnstableSpecificationWarning, stacklevel=2) zarr-python-3.3.0/src/zarr/core/dtype/npy/000077500000000000000000000000001523267620000204455ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/core/dtype/npy/__init__.py000066400000000000000000000000001523267620000225440ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/core/dtype/npy/bool.py000066400000000000000000000213371523267620000217600ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass from typing import TYPE_CHECKING, ClassVar, Literal, Self, TypeGuard, overload import numpy as np from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasItemSize, check_dtype_spec_v2, ) from zarr.core.dtype.wrapper import TBaseDType, ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat @dataclass(frozen=True, kw_only=True, slots=True) class Bool(ZDType[np.dtypes.BoolDType, np.bool_], HasItemSize): """ A Zarr data type for arrays containing booleans. Wraps the [`np.dtypes.BoolDType`][numpy.dtypes.BoolDType] data type. Scalars for this data type are instances of [`np.bool_`][numpy.bool_]. Attributes ---------- _zarr_v3_name : Literal["bool"] = "bool" The Zarr v3 name of the dtype. _zarr_v2_name : ``Literal["|b1"]`` = ``"|b1"`` The Zarr v2 name of the dtype, which is also a string representation of the boolean dtype used by NumPy. dtype_cls : ClassVar[type[np.dtypes.BoolDType]] = np.dtypes.BoolDType The NumPy dtype class. References ---------- This class implements the boolean data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding)and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ _zarr_v3_name: ClassVar[Literal["bool"]] = "bool" _zarr_v2_name: ClassVar[Literal["|b1"]] = "|b1" dtype_cls = np.dtypes.BoolDType @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of Bool from an instance of np.dtypes.BoolDType. Parameters ---------- dtype : TBaseDType The NumPy boolean dtype instance to convert. Returns ------- Bool An instance of Bool. Raises ------ DataTypeValidationError If the provided dtype is not compatible with this ZDType. """ if cls._check_native_dtype(dtype): return cls() raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self: Self) -> np.dtypes.BoolDType: """ Create a NumPy boolean dtype instance from this ZDType. Returns ------- np.dtypes.BoolDType The NumPy boolean dtype. """ return self.dtype_cls() @classmethod def _check_json_v2( cls, data: DTypeJSON, ) -> TypeGuard[DTypeConfig_V2[Literal["|b1"], None]]: """ Check that the input is a valid JSON representation of a Bool. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- ``TypeGuard[DTypeConfig_V2[Literal["|b1"], None]]`` True if the input is a valid JSON representation, False otherwise. """ return ( check_dtype_spec_v2(data) and data["name"] == cls._zarr_v2_name and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[Literal["bool"]]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- bool True if the input is a valid JSON representation, False otherwise. """ return data == cls._zarr_v3_name @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of Bool from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Bool An instance of Bool. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v2_name!r}" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls: type[Self], data: DTypeJSON) -> Self: """ Create an instance of Bool from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Bool An instance of Bool. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal["|b1"], None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> Literal["bool"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal["|b1"], None] | Literal["bool"]: """ Serialize this Bool instance to JSON. Parameters ---------- zarr_format : ZarrFormat The Zarr format version (2 or 3). Returns ------- ``DTypeConfig_V2[Literal["|b1"], None] | Literal["bool"]`` The JSON representation of the Bool instance. Raises ------ ValueError If the zarr_format is not 2 or 3. """ if zarr_format == 2: return {"name": self._zarr_v2_name, "object_codec_id": None} elif zarr_format == 3: return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> bool: """ Check if the input can be cast to a boolean scalar. Parameters ---------- data : object The data to check. Returns ------- bool True if the input can be cast to a boolean scalar, False otherwise. """ return True def cast_scalar(self, data: object) -> np.bool_: """ Cast the input to a numpy boolean scalar. Parameters ---------- data : object The data to cast. Returns ------- bool : np.bool_ The numpy boolean scalar. Raises ------ TypeError If the input cannot be converted to a numpy boolean. """ if self._check_scalar(data): return np.bool_(data) msg = ( # pragma: no cover f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) # pragma: no cover def default_scalar(self) -> np.bool_: """ Get the default value for the boolean dtype. Returns ------- bool : np.bool_ The default value. """ return np.False_ def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> bool: """ Convert a scalar to a python bool. Parameters ---------- data : object The value to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- bool The JSON-serializable format. """ return bool(data) def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bool_: """ Read a JSON-serializable value as a numpy boolean scalar. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The zarr format version. Returns ------- bool : np.bool_ The numpy boolean scalar. Raises ------ TypeError If the input is not a valid boolean type. """ if self._check_scalar(data): return np.bool_(data) raise TypeError(f"Invalid type: {data}. Expected a boolean.") # pragma: no cover @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 1 zarr-python-3.3.0/src/zarr/core/dtype/npy/bytes.py000066400000000000000000001160701523267620000221520ustar00rootroot00000000000000from __future__ import annotations import base64 import re from dataclasses import dataclass from typing import ClassVar, Literal, Self, TypedDict, TypeGuard, cast, overload import numpy as np from zarr.core.common import JSON, NamedConfig, ZarrFormat from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasItemSize, HasLength, HasObjectCodec, check_dtype_spec_v2, v3_unstable_dtype_warning, ) from zarr.core.dtype.npy.common import check_json_str from zarr.core.dtype.wrapper import TBaseDType, ZDType from zarr.errors import DataTypeValidationError BytesLike = np.bytes_ | str | bytes | int class FixedLengthBytesConfig(TypedDict): """ A configuration for a data type that takes a ``length_bytes`` parameter. Attributes ---------- length_bytes : int The length in bytes of the data associated with this configuration. Examples -------- ```python { "length_bytes": 12 } ``` """ length_bytes: int class NullterminatedBytesJSON_V2(DTypeConfig_V2[str, None]): """ A wrapper around the JSON representation of the ``NullTerminatedBytes`` data type in Zarr V2. The ``name`` field of this class contains the value that would appear under the ``dtype`` field in Zarr V2 array metadata. References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": "|S10", "object_codec_id": None } ``` """ class NullTerminatedBytesJSON_V3( NamedConfig[Literal["null_terminated_bytes"], FixedLengthBytesConfig] ): """ The JSON representation of the ``NullTerminatedBytes`` data type in Zarr V3. References ---------- This representation is not currently defined in an external specification. Examples -------- ```python { "name": "null_terminated_bytes", "configuration": { "length_bytes": 12 } } ``` """ class RawBytesJSON_V2(DTypeConfig_V2[str, None]): """ A wrapper around the JSON representation of the ``RawBytes`` data type in Zarr V2. The ``name`` field of this class contains the value that would appear under the ``dtype`` field in Zarr V2 array metadata. References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": "|V10", "object_codec_id": None } ``` """ class RawBytesJSON_V3(NamedConfig[Literal["raw_bytes"], FixedLengthBytesConfig]): """ The JSON representation of the ``RawBytes`` data type in Zarr V3. References ---------- This representation is not currently defined in an external specification. Examples -------- ```python { "name": "raw_bytes", "configuration": { "length_bytes": 12 } } ``` """ class VariableLengthBytesJSON_V2(DTypeConfig_V2[Literal["|O"], Literal["vlen-bytes"]]): """ A wrapper around the JSON representation of the ``VariableLengthBytes`` data type in Zarr V2. The ``name`` field of this class contains the value that would appear under the ``dtype`` field in Zarr V2 array metadata. The ``object_codec_id`` field is always ``"vlen-bytes"`` References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": "|O", "object_codec_id": "vlen-bytes" } ``` """ @dataclass(frozen=True, kw_only=True) class NullTerminatedBytes(ZDType[np.dtypes.BytesDType[int], np.bytes_], HasLength, HasItemSize): """ A Zarr data type for arrays containing fixed-length null-terminated byte sequences. Wraps the [`np.dtypes.BytesDType`][numpy.dtypes.BytesDType] data type. Scalars for this data type are instances of [`np.bytes_`][numpy.bytes_]. This data type is parametrized by an integral length which specifies size in bytes of each scalar. Because this data type uses null-terminated semantics, indexing into NumPy arrays with this data type may return fewer than ``length`` bytes. Attributes ---------- dtype_cls: ClassVar[type[np.dtypes.BytesDType[int]]] = np.dtypes.BytesDType The NumPy data type wrapped by this ZDType. _zarr_v3_name : ClassVar[Literal["null_terminated_bytes"]] length : int The length of the bytes. Notes ----- This data type is designed for compatibility with NumPy arrays that use the NumPy ``bytes`` data type. It may not be desirable for usage outside of that context. If compatibility with the NumPy ``bytes`` data type is not essential, consider using the ``RawBytes`` or ``VariableLengthBytes`` data types instead. """ dtype_cls = np.dtypes.BytesDType _zarr_v3_name: ClassVar[Literal["null_terminated_bytes"]] = "null_terminated_bytes" def __post_init__(self) -> None: """ We don't allow instances of this class with length less than 1 because there is no way such a data type can contain actual data. """ if self.length < 1: raise ValueError(f"length must be >= 1, got {self.length}.") @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of NullTerminatedBytes from an instance of np.dtypes.BytesDType. This method checks if the provided data type is an instance of np.dtypes.BytesDType. If so, it returns a new instance of NullTerminatedBytes with a length equal to the length of input data type. Parameters ---------- dtype : TBaseDType The native dtype to convert. Returns ------- NullTerminatedBytes An instance of NullTerminatedBytes with the specified length. Raises ------ DataTypeValidationError If the dtype is not compatible with NullTerminatedBytes. """ if cls._check_native_dtype(dtype): return cls(length=dtype.itemsize) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.BytesDType[int]: """ Create a NumPy bytes dtype from this NullTerminatedBytes ZDType. Returns ------- np.dtypes.BytesDType[int] A NumPy data type object representing null-terminated bytes with a specified length. """ return self.dtype_cls(self.length) @classmethod def _check_json_v2(cls, data: DTypeJSON) -> TypeGuard[NullterminatedBytesJSON_V2]: """ Check that the input is a valid JSON representation of NullTerminatedBytes in Zarr V2. The input data must be a mapping that contains a "name" key that matches the pattern "|S" and an "object_codec_id" key that is None. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- bool True if the input data is a valid representation, False otherwise. """ return ( check_dtype_spec_v2(data) and isinstance(data["name"], str) and re.match(r"^\|S\d+$", data["name"]) is not None and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[NullTerminatedBytesJSON_V3]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[NullTerminatedBytesJSON_V3] True if the input is a valid representation of this class in Zarr V3, False otherwise. """ return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] == cls._zarr_v3_name and isinstance(data["configuration"], dict) and "length_bytes" in data["configuration"] and isinstance(data["configuration"]["length_bytes"], int) ) @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this class from Zarr V2-flavored JSON. This method checks if the input data is a valid representation of this class in Zarr V2. If so, it returns a new instance of this class with a ``length`` as specified in the input data. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data is not a valid representation of this class. """ if cls._check_json_v2(data): name = data["name"] return cls(length=int(name[2:])) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a string like '|S1', '|S2', etc" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this class from Zarr V3-flavored JSON. This method checks if the input data is a valid representation of this class in Zarr V3. If so, it returns a new instance of this class with a ``length`` as specified in the input data. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data is not a valid representation of this class. """ if cls._check_json_v3(data): return cls(length=data["configuration"]["length_bytes"]) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> NullterminatedBytesJSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> NullTerminatedBytesJSON_V3: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[str, None] | NullTerminatedBytesJSON_V3: """ Generate a JSON representation of this data type. Parameters ---------- zarr_format : ZarrFormat The zarr format version. Returns ------- NullterminatedBytesJSON_V2 | NullTerminatedBytesJSON_V3 The JSON-serializable representation of the data type """ if zarr_format == 2: return {"name": self.to_native_dtype().str, "object_codec_id": None} elif zarr_format == 3: v3_unstable_dtype_warning(self) return { "name": self._zarr_v3_name, "configuration": {"length_bytes": self.length}, } raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[BytesLike]: """ Check if the provided data is of type BytesLike. This method is used to verify if the input data can be considered as a scalar of bytes-like type, which includes NumPy bytes, strings, bytes, and integers. Parameters ---------- data : object The data to check. Returns ------- TypeGuard[BytesLike] True if the data is bytes-like, False otherwise. """ return isinstance(data, BytesLike) def _cast_scalar_unchecked(self, data: BytesLike) -> np.bytes_: """ Cast the provided scalar data to [`np.bytes_`][numpy.bytes_], truncating if necessary. Parameters ---------- data : BytesLike The data to cast. Returns ------- bytes : [`np.bytes_`][numpy.bytes_] The casted data as a NumPy bytes scalar. Notes ----- This method does not perform any type checking. The input data must be bytes-like. """ if isinstance(data, int): return self.to_native_dtype().type(str(data)[: self.length]) else: return self.to_native_dtype().type(data[: self.length]) def cast_scalar(self, data: object) -> np.bytes_: """ Attempt to cast a given object to a NumPy bytes scalar. This method first checks if the provided data is a valid scalar that can be converted to a NumPy bytes scalar. If the check succeeds, the unchecked casting operation is performed. If the data is not valid, a TypeError is raised. Parameters ---------- data : object The data to be cast to a NumPy bytes scalar. Returns ------- bytes : [`np.bytes_`][numpy.bytes_] The data cast as a NumPy bytes scalar. Raises ------ TypeError If the data cannot be converted to a NumPy bytes scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> np.bytes_: """ Return a default scalar value, which for this data type is an empty byte string. Returns ------- bytes : [`np.bytes_`][numpy.bytes_] The default scalar value. """ return np.bytes_(b"") def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str: """ Convert a scalar to a JSON-serializable string representation. This method encodes the given scalar as a NumPy bytes scalar and then encodes the bytes as a base64-encoded string. Parameters ---------- data : object The scalar to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- str A string representation of the scalar. """ as_bytes = self.cast_scalar(data) return base64.standard_b64encode(as_bytes).decode("ascii") def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bytes_: """ Read a JSON-serializable value as [`np.bytes_`][numpy.bytes_]. Parameters ---------- data : JSON The JSON-serializable base64-encoded string. zarr_format : ZarrFormat The zarr format version. Returns ------- bytes : [`np.bytes_`][numpy.bytes_] The NumPy bytes scalar obtained from decoding the base64 string. Raises ------ TypeError If the input data is not a base64-encoded string. """ if check_json_str(data): return self.to_native_dtype().type(base64.standard_b64decode(data.encode("ascii"))) raise TypeError( f"Invalid type: {data}. Expected a base64-encoded string." ) # pragma: no cover @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return self.length @dataclass(frozen=True, kw_only=True) class RawBytes(ZDType[np.dtypes.VoidDType[int], np.void], HasLength, HasItemSize): """ A Zarr data type for arrays containing fixed-length sequences of raw bytes. Wraps the NumPy ``void`` data type. Scalars for this data type are instances of [`np.void`][numpy.void]. This data type is parametrized by an integral length which specifies size in bytes of each scalar belonging to this data type. Attributes ---------- dtype_cls: ClassVar[type[np.dtypes.VoidDType[int]]] = np.dtypes.VoidDtype The NumPy data type wrapped by this ZDType. _zarr_v3_name : ClassVar[Literal["raw_bytes"]] length : int The length of the bytes. Notes ----- Although the NumPy "Void" data type is used to create "structured" data types in NumPy, this class does not support structured data types. See the ``Structured`` data type for this functionality. """ # np.dtypes.VoidDType is specified in an odd way in NumPy # it cannot be used to create instances of the dtype # so we have to tell mypy to ignore this here dtype_cls = np.dtypes.VoidDType # type: ignore[assignment] _zarr_v3_name: ClassVar[Literal["raw_bytes"]] = "raw_bytes" def __post_init__(self) -> None: """ We don't allow instances of this class with length less than 1 because there is no way such a data type can contain actual data. """ if self.length < 1: raise ValueError(f"length must be >= 1, got {self.length}.") @classmethod def _check_native_dtype( cls: type[Self], dtype: TBaseDType ) -> TypeGuard[np.dtypes.VoidDType[int]]: """ Check that the input is a NumPy void dtype with no fields. Numpy void dtype comes in two forms: * If the ``fields`` attribute is ``None``, then the dtype represents N raw bytes. * If the ``fields`` attribute is not ``None``, then the dtype represents a structured dtype, In this check we ensure that ``fields`` is ``None``. Parameters ---------- dtype : TDBaseDType The dtype to check. Returns ------- Bool True if the dtype is an instance of np.dtypes.VoidDType with no fields, False otherwise. """ return cls.dtype_cls is type(dtype) and dtype.fields is None @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of RawBytes from an instance of np.dtypes.VoidDType. This method checks if the provided data type is compatible with RawBytes. The input must be an instance of np.dtypes.VoidDType, and have no fields. If the input is compatible, this method returns an instance of RawBytes with the specified length. Parameters ---------- dtype : TBaseDType The native dtype to convert. Returns ------- RawBytes An instance of RawBytes with the specified length. Raises ------ DataTypeValidationError If the dtype is not compatible with RawBytes. """ if cls._check_native_dtype(dtype): return cls(length=dtype.itemsize) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.VoidDType[int]: """ Create a NumPy void dtype from this RawBytes ZDType. Returns ------- np.dtypes.VoidDType[int] A NumPy data type object representing raw bytes with a specified length. """ # Numpy does not allow creating a void type # by invoking np.dtypes.VoidDType directly return cast("np.dtypes.VoidDType[int]", np.dtype(f"V{self.length}")) @classmethod def _check_json_v2(cls, data: DTypeJSON) -> TypeGuard[RawBytesJSON_V2]: """ Check that the input is a valid representation of this class in Zarr V2. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- True if the input is a valid representation of this class in Zarr V3, False otherwise. """ return ( check_dtype_spec_v2(data) and isinstance(data["name"], str) and re.match(r"^\|V\d+$", data["name"]) is not None and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[RawBytesJSON_V3]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[RawBytesJSON_V3] True if the input is a valid representation of this class in Zarr V3, False otherwise. """ return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] == cls._zarr_v3_name and isinstance(data["configuration"], dict) and set(data["configuration"].keys()) == {"length_bytes"} and isinstance(data["configuration"]["length_bytes"], int) ) @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of RawBytes from Zarr V2-flavored JSON. This method checks if the input data is a valid representation of RawBytes in Zarr V2. If so, it returns a new instance of RawBytes with a ``length`` as specified in the input data. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data is not a valid representation of this class. """ if cls._check_json_v2(data): name = data["name"] return cls(length=int(name[2:])) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a string like '|V1', '|V2', etc" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of RawBytes from Zarr V3-flavored JSON. This method checks if the input data is a valid representation of RawBytes in Zarr V3. If so, it returns a new instance of RawBytes with a ``length`` as specified in the input data. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- RawBytes An instance of RawBytes. Raises ------ DataTypeValidationError If the input data is not a valid representation of this class. """ if cls._check_json_v3(data): return cls(length=data["configuration"]["length_bytes"]) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> RawBytesJSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> RawBytesJSON_V3: ... def to_json(self, zarr_format: ZarrFormat) -> RawBytesJSON_V2 | RawBytesJSON_V3: """ Generate a JSON representation of this data type. Parameters ---------- zarr_format : ZarrFormat The zarr format version. Returns ------- RawBytesJSON_V2 | RawBytesJSON_V3 The JSON-serializable representation of the data type. """ if zarr_format == 2: return {"name": self.to_native_dtype().str, "object_codec_id": None} elif zarr_format == 3: v3_unstable_dtype_warning(self) return {"name": self._zarr_v3_name, "configuration": {"length_bytes": self.length}} raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[np.bytes_ | str | bytes | np.void]: """ Check if the provided data can be cast to np.void. This method is used to verify if the input data can be considered as a scalar of bytes-like type, which includes np.bytes_, np.void, strings, and bytes objects. Parameters ---------- data : object The data to check. Returns ------- TypeGuard[np.bytes_ | str | bytes | np.void] True if the data is void-scalar-like, False otherwise. """ return isinstance(data, np.bytes_ | str | bytes | np.void) def _cast_scalar_unchecked(self, data: object) -> np.void: """ Cast the provided scalar data to np.void. Parameters ---------- data : BytesLike The data to cast. Returns ------- np.void The casted data as a NumPy void scalar. Notes ----- This method does not perform any type checking. The input data must be castable to np.void. """ native_dtype = self.to_native_dtype() # Without the second argument, NumPy will return a void scalar for dtype V1. # The second argument ensures that, if native_dtype is something like V10, # the result will actually be a V10 scalar. return native_dtype.type(data, native_dtype) def cast_scalar(self, data: object) -> np.void: """ Attempt to cast a given object to a NumPy void scalar. This method first checks if the provided data is a valid scalar that can be converted to a NumPy void scalar. If the check succeeds, the unchecked casting operation is performed. If the data is not valid, a TypeError is raised. Parameters ---------- data : object The data to be cast to a NumPy void scalar. Returns ------- np.void The data cast as a NumPy void scalar. Raises ------ TypeError If the data cannot be converted to a NumPy void scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> np.void: """ Return the default scalar value for this data type. The default scalar is a NumPy void scalar of the same length as the data type, filled with zero bytes. Returns ------- np.void The default scalar value. """ return self.to_native_dtype().type(("\x00" * self.length).encode("ascii")) def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str: """ Convert a scalar to a JSON-serializable string representation. This method converts the given scalar to bytes and then encodes the bytes as a base64-encoded string. Parameters ---------- data : object The scalar to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- str A string representation of the scalar. """ as_bytes = self.cast_scalar(data) return base64.standard_b64encode(as_bytes.tobytes()).decode("ascii") def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.void: """ Read a JSON-serializable value as an np.void. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The zarr format version. Returns ------- np.void The NumPy void scalar. Raises ------ TypeError If the data is not a string, or if the string is not a valid base64 encoding. """ if check_json_str(data): return self.to_native_dtype().type(base64.standard_b64decode(data)) raise TypeError(f"Invalid type: {data}. Expected a string.") # pragma: no cover @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return self.length @dataclass(frozen=True, kw_only=True) class VariableLengthBytes(ZDType[np.dtypes.ObjectDType, bytes], HasObjectCodec): """ A Zarr data type for arrays containing variable-length sequences of bytes. Wraps the NumPy "object" data type. Scalars for this data type are instances of ``bytes``. Attributes ---------- dtype_cls: ClassVar[type[np.dtypes.ObjectDType]] = np.dtypes.ObjectDType The NumPy data type wrapped by this ZDType. _zarr_v3_name: ClassVar[Literal["variable_length_bytes"]] = "variable_length_bytes" The name of this data type in Zarr V3. object_codec_id: ClassVar[Literal["vlen-bytes"]] = "vlen-bytes" The object codec ID for this data type. Notes ----- Because this data type uses the NumPy "object" data type, it does not guarantee a compact memory representation of array data. Therefore a "vlen-bytes" codec is needed to ensure that the array data can be persisted to storage. """ dtype_cls = np.dtypes.ObjectDType _zarr_v3_name: ClassVar[Literal["variable_length_bytes"]] = "variable_length_bytes" object_codec_id: ClassVar[Literal["vlen-bytes"]] = "vlen-bytes" @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of VariableLengthBytes from an instance of np.dtypes.ObjectDType. This method checks if the provided data type is an instance of np.dtypes.ObjectDType. If so, it returns an instance of VariableLengthBytes. Parameters ---------- dtype : TBaseDType The native dtype to convert. Returns ------- VariableLengthBytes An instance of VariableLengthBytes. Raises ------ DataTypeValidationError If the dtype is not compatible with VariableLengthBytes. """ if cls._check_native_dtype(dtype): return cls() raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.ObjectDType: """ Create a NumPy object dtype from this VariableLengthBytes ZDType. Returns ------- np.dtypes.ObjectDType A NumPy data type object representing variable-length bytes. """ return self.dtype_cls() @classmethod def _check_json_v2( cls, data: DTypeJSON, ) -> TypeGuard[VariableLengthBytesJSON_V2]: """ Check that the input is a valid JSON representation of a NumPy O dtype, and that the object codec id is appropriate for variable-length bytes strings. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- True if the input is a valid representation of this class in Zarr V2, False otherwise. """ # Check that the input is a valid JSON representation of a Zarr v2 data type spec. if not check_dtype_spec_v2(data): return False # Check that the object codec id is appropriate for variable-length bytes strings. if data["name"] != "|O": return False return data["object_codec_id"] == cls.object_codec_id @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[Literal["variable_length_bytes"]]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[Literal["variable_length_bytes"]] True if the input is a valid representation of this class in Zarr V3, False otherwise. """ return data in (cls._zarr_v3_name, "bytes") @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this VariableLengthBytes from Zarr V2-flavored JSON. This method checks if the input data is a valid representation of this class in Zarr V2. If so, it returns a new instance this class. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data is not a valid representation of this class. """ if cls._check_json_v2(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string '|O' and an object_codec_id of {cls.object_codec_id}" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of VariableLengthBytes from Zarr V3-flavored JSON. This method checks if the input data is a valid representation of VariableLengthBytes in Zarr V3. If so, it returns a new instance of VariableLengthBytes. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- VariableLengthBytes An instance of VariableLengthBytes. Raises ------ DataTypeValidationError If the input data is not a valid representation of this class. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> VariableLengthBytesJSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> Literal["variable_length_bytes"]: ... def to_json( self, zarr_format: ZarrFormat ) -> VariableLengthBytesJSON_V2 | Literal["variable_length_bytes"]: """ Convert the variable-length bytes data type to a JSON-serializable form. Parameters ---------- zarr_format : ZarrFormat The zarr format version. Accepted values are 2 and 3. Returns ------- ``DTypeConfig_V2[Literal["|O"], Literal["vlen-bytes"]] | Literal["variable_length_bytes"]`` The JSON-serializable representation of the variable-length bytes data type. For zarr_format 2, returns a dictionary with "name" and "object_codec_id". For zarr_format 3, returns a string identifier "variable_length_bytes". Raises ------ ValueError If zarr_format is not 2 or 3. """ if zarr_format == 2: return {"name": "|O", "object_codec_id": self.object_codec_id} elif zarr_format == 3: v3_unstable_dtype_warning(self) return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def default_scalar(self) -> bytes: """ Return the default scalar value for the variable-length bytes data type. Returns ------- bytes The default scalar value, which is an empty byte string. """ return b"" def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str: """ Convert a scalar to a JSON-serializable string representation. This method encodes the given scalar as bytes and then encodes the bytes as a base64-encoded string. Parameters ---------- data : object The scalar to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- str A string representation of the scalar. """ return base64.standard_b64encode(data).decode("ascii") # type: ignore[arg-type] def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> bytes: """ Decode a base64-encoded JSON string to bytes. Parameters ---------- data : JSON The JSON-serializable base64-encoded string. zarr_format : ZarrFormat The zarr format version. Returns ------- bytes The decoded bytes from the base64 string. Raises ------ TypeError If the input data is not a base64-encoded string. """ if check_json_str(data): return base64.standard_b64decode(data.encode("ascii")) raise TypeError(f"Invalid type: {data}. Expected a string.") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[BytesLike]: """ Check if the provided data is of type BytesLike. This method is used to verify if the input data can be considered as a scalar of bytes-like type, which includes NumPy bytes, strings, bytes, and integers. Parameters ---------- data : object The data to check. Returns ------- TypeGuard[BytesLike] True if the data is bytes-like, False otherwise. """ return isinstance(data, BytesLike) def _cast_scalar_unchecked(self, data: BytesLike) -> bytes: """ Cast the provided scalar data to bytes. Parameters ---------- data : BytesLike The data to cast. Returns ------- bytes The casted data as bytes. Notes ----- This method does not perform any type checking. The input data must be bytes-like. """ if isinstance(data, str): return bytes(data, encoding="utf-8") return bytes(data) def cast_scalar(self, data: object) -> bytes: """ Attempt to cast a given object to a bytes scalar. This method first checks if the provided data is a valid scalar that can be converted to a bytes scalar. If the check succeeds, the unchecked casting operation is performed. If the data is not valid, a TypeError is raised. Parameters ---------- data : object The data to be cast to a bytes scalar. Returns ------- bytes The data cast as a bytes scalar. Raises ------ TypeError If the data cannot be converted to a bytes scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) zarr-python-3.3.0/src/zarr/core/dtype/npy/common.py000066400000000000000000000327541523267620000223220ustar00rootroot00000000000000from __future__ import annotations import base64 import struct import sys from collections.abc import Sequence from typing import ( TYPE_CHECKING, Any, Final, Literal, NewType, SupportsComplex, SupportsFloat, SupportsIndex, SupportsInt, TypeGuard, ) import numpy as np from zarr.core.dtype.common import ( ENDIANNESS_STR, SPECIAL_FLOAT_STRINGS, EndiannessStr, JSONFloatV2, JSONFloatV3, ) if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat IntLike = SupportsInt | SupportsIndex | bytes | str FloatLike = SupportsIndex | SupportsFloat | bytes | str ComplexLike = SupportsFloat | SupportsIndex | SupportsComplex | bytes | str | None DateTimeUnit = Literal[ "Y", "M", "W", "D", "h", "m", "s", "ms", "us", "μs", "ns", "ps", "fs", "as", "generic" ] DATETIME_UNIT: Final = ( "Y", "M", "W", "D", "h", "m", "s", "ms", "us", "μs", "ns", "ps", "fs", "as", "generic", ) IntishFloat = NewType("IntishFloat", float) """A type for floats that represent integers, like 1.0 (but not 1.1).""" IntishStr = NewType("IntishStr", str) """A type for strings that represent integers, like "0" or "42".""" FloatishStr = NewType("FloatishStr", str) """A type for strings that represent floats, like "3.14" or "-2.5".""" NumpyEndiannessStr = Literal[">", "<", "="] NUMPY_ENDIANNESS_STR: Final = ">", "<", "=" def endianness_from_numpy_str(endianness: NumpyEndiannessStr) -> EndiannessStr: """ Convert a numpy endianness string literal to a human-readable literal value. Parameters ---------- endianness : Literal[">", "<", "="] The numpy string representation of the endianness. Returns ------- Endianness The human-readable representation of the endianness. Raises ------ ValueError If the endianness is invalid. """ match endianness: case "=": # Use the local system endianness return sys.byteorder case "<": return "little" case ">": return "big" raise ValueError(f"Invalid endianness: {endianness!r}. Expected one of {NUMPY_ENDIANNESS_STR}") def endianness_to_numpy_str(endianness: EndiannessStr) -> NumpyEndiannessStr: """ Convert an endianness literal to its numpy string representation. Parameters ---------- endianness : Endianness The endianness to convert. Returns ------- Literal[">", "<"] The numpy string representation of the endianness. Raises ------ ValueError If the endianness is invalid. """ match endianness: case "little": return "<" case "big": return ">" raise ValueError( f"Invalid endianness: {endianness!r}. Expected one of {ENDIANNESS_STR} or None" ) def get_endianness_from_numpy_dtype(dtype: np.dtype[np.generic]) -> EndiannessStr: """ Gets the endianness from a numpy dtype that has an endianness. This function will raise a ValueError if the numpy data type does not have a concrete endianness. """ endianness = dtype.byteorder if dtype.byteorder in NUMPY_ENDIANNESS_STR: return endianness_from_numpy_str(endianness) # type: ignore [arg-type] raise ValueError(f"The dtype {dtype} has an unsupported endianness: {endianness}") def float_from_json_v2(data: JSONFloatV2) -> float: """ Convert a JSON float to a float (Zarr v2). Parameters ---------- data : JSONFloat The JSON float to convert. Returns ------- float The float value. """ match data: case "NaN": return float("nan") case "Infinity": return float("inf") case "-Infinity": return float("-inf") case _: return float(data) def float_from_json_v3(data: JSONFloatV3) -> float: """ Convert a JSON float to a float (v3). Parameters ---------- data : JSONFloat The JSON float to convert. Returns ------- float The float value. Notes ----- Zarr V3 allows floats to be stored as hex strings. To quote the spec: "...for float32, "NaN" is equivalent to "0x7fc00000". This representation is the only way to specify a NaN value other than the specific NaN value denoted by "NaN"." """ if isinstance(data, str): if data in SPECIAL_FLOAT_STRINGS: return float_from_json_v2(data) # type: ignore[arg-type] if not data.startswith("0x"): msg = ( f"Invalid float value: {data!r}. Expected a string starting with the hex prefix" " '0x', or one of 'NaN', 'Infinity', or '-Infinity'." ) raise ValueError(msg) if len(data[2:]) == 4: dtype_code = ">e" elif len(data[2:]) == 8: dtype_code = ">f" elif len(data[2:]) == 16: dtype_code = ">d" else: msg = ( f"Invalid hexadecimal float value: {data!r}. " "Expected the '0x' prefix to be followed by 4, 8, or 16 numeral characters" ) raise ValueError(msg) return float(struct.unpack(dtype_code, bytes.fromhex(data[2:]))[0]) return float_from_json_v2(data) def bytes_from_json(data: str, *, zarr_format: ZarrFormat) -> bytes: """ Convert a JSON string to bytes Parameters ---------- data : str The JSON string to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- bytes The bytes. """ if zarr_format == 2: return base64.b64decode(data.encode("ascii")) # TODO: differentiate these as needed. This is a spec question. if zarr_format == 3: return base64.b64decode(data.encode("ascii")) raise ValueError(f"Invalid zarr format: {zarr_format}. Expected 2 or 3.") # pragma: no cover def bytes_to_json(data: bytes, zarr_format: ZarrFormat) -> str: """ Convert bytes to JSON. Parameters ---------- data : bytes The bytes to store. zarr_format : ZarrFormat The zarr format version. Returns ------- str The bytes encoded as ascii using the base64 alphabet. """ # TODO: decide if we are going to make this implementation zarr format-specific return base64.b64encode(data).decode("ascii") def float_to_json_v2(data: float | np.floating[Any]) -> JSONFloatV2: """ Convert a float to JSON (v2). Parameters ---------- data : float or np.floating The float value to convert. Returns ------- JSONFloat The JSON representation of the float. """ if np.isnan(data): return "NaN" elif np.isinf(data): return "Infinity" if data > 0 else "-Infinity" return float(data) def float_to_json_v3(data: float | np.floating[Any]) -> JSONFloatV3: """ Convert a float to JSON (v3). Parameters ---------- data : float or np.floating The float value to convert. Returns ------- JSONFloat The JSON representation of the float. """ # v3 can in principle handle distinct NaN values, but numpy does not represent these explicitly # so we just reuse the v2 routine here return float_to_json_v2(data) def complex_float_to_json_v3( data: complex | np.complexfloating[Any, Any], ) -> tuple[JSONFloatV3, JSONFloatV3]: """ Convert a complex number to JSON as defined by the Zarr V3 spec. Parameters ---------- data : complex or np.complexfloating The complex value to convert. Returns ------- tuple[JSONFloat, JSONFloat] The JSON representation of the complex number. """ return float_to_json_v3(data.real), float_to_json_v3(data.imag) def complex_float_to_json_v2( data: complex | np.complexfloating[Any, Any], ) -> tuple[JSONFloatV2, JSONFloatV2]: """ Convert a complex number to JSON as defined by the Zarr V2 spec. Parameters ---------- data : complex | np.complexfloating The complex value to convert. Returns ------- tuple[JSONFloat, JSONFloat] The JSON representation of the complex number. """ return float_to_json_v2(data.real), float_to_json_v2(data.imag) def complex_float_from_json_v2(data: tuple[JSONFloatV2, JSONFloatV2]) -> complex: """ Convert a JSON complex float to a complex number (v2). Parameters ---------- data : tuple[JSONFloat, JSONFloat] The JSON complex float to convert. Returns ------- np.complexfloating The complex number. """ return complex(float_from_json_v2(data[0]), float_from_json_v2(data[1])) def complex_float_from_json_v3(data: tuple[JSONFloatV3, JSONFloatV3]) -> complex: """ Convert a JSON complex float to a complex number (v3). Parameters ---------- data : tuple[JSONFloat, JSONFloat] The JSON complex float to convert. Returns ------- np.complexfloating The complex number. """ return complex(float_from_json_v3(data[0]), float_from_json_v3(data[1])) def check_json_float_v2(data: JSON) -> TypeGuard[JSONFloatV2]: """ Check if a JSON value represents a float (v2). Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is a float, False otherwise. """ return data in ("NaN", "Infinity", "-Infinity") or isinstance(data, float | int) def check_json_float_v3(data: JSON) -> TypeGuard[JSONFloatV3]: """ Check if a JSON value represents a float (v3). Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is a float, False otherwise. """ return check_json_float_v2(data) or (isinstance(data, str) and data.startswith("0x")) def check_json_complex_float_v2(data: JSON) -> TypeGuard[tuple[JSONFloatV2, JSONFloatV2]]: """ Check if a JSON value represents a complex float, as per the behavior of zarr-python 2.x Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is a complex float, False otherwise. """ return ( not isinstance(data, str) and isinstance(data, Sequence) and len(data) == 2 and check_json_float_v2(data[0]) and check_json_float_v2(data[1]) ) def check_json_complex_float_v3(data: JSON) -> TypeGuard[tuple[JSONFloatV3, JSONFloatV3]]: """ Check if a JSON value represents a complex float, as per the zarr v3 spec Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is a complex float, False otherwise. """ return ( not isinstance(data, str) and isinstance(data, Sequence) and len(data) == 2 and check_json_float_v3(data[0]) and check_json_float_v3(data[1]) ) def check_json_int(data: JSON) -> TypeGuard[int]: """ Check if a JSON value is an integer. Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is an integer, False otherwise. """ return bool(isinstance(data, int)) def check_json_intish_float(data: JSON) -> TypeGuard[IntishFloat]: """ Check if a JSON value is an "intish float", i.e. a float that represents an integer, like 0.0. Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is an intish float, False otherwise. """ return isinstance(data, float) and data.is_integer() def check_json_intish_str(data: JSON) -> TypeGuard[IntishStr]: """ Check if a JSON value is a string that represents an integer, like "0", "42", or "-5". Parameters ---------- data : JSON The JSON value to check. Returns ------- bool True if the data is a string representing an integer, False otherwise. """ if not isinstance(data, str): return False try: int(data) except ValueError: return False else: return True def check_json_floatish_str(data: JSON) -> TypeGuard[FloatishStr]: """ Check if a JSON value is a string that represents a float, like "3.14", "-2.5", or "0.0". Note: This function is intended to be used AFTER check_json_float_v2/v3, so it only handles regular string representations that those functions don't cover. Parameters ---------- data : JSON The JSON value to check. Returns ------- bool True if the data is a string representing a regular float, False otherwise. """ if not isinstance(data, str): return False try: float(data) except ValueError: return False else: return True def check_json_str(data: JSON) -> TypeGuard[str]: """ Check if a JSON value is a string. Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is a string, False otherwise. """ return bool(isinstance(data, str)) def check_json_bool(data: JSON) -> TypeGuard[bool]: """ Check if a JSON value is a boolean. Parameters ---------- data : JSON The JSON value to check. Returns ------- Bool True if the data is a boolean, False otherwise. """ return isinstance(data, bool) zarr-python-3.3.0/src/zarr/core/dtype/npy/complex.py000066400000000000000000000311611523267620000224700ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass from typing import ( TYPE_CHECKING, ClassVar, Literal, Self, TypeGuard, overload, ) import numpy as np from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasEndianness, HasItemSize, check_dtype_spec_v2, ) from zarr.core.dtype.npy.common import ( ComplexLike, check_json_complex_float_v2, check_json_complex_float_v3, complex_float_from_json_v2, complex_float_from_json_v3, complex_float_to_json_v2, complex_float_to_json_v3, endianness_to_numpy_str, get_endianness_from_numpy_dtype, ) from zarr.core.dtype.wrapper import TBaseDType, ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat @dataclass(frozen=True) class BaseComplex[ DType: np.dtypes.Complex64DType | np.dtypes.Complex128DType, Scalar: np.complex64 | np.complex128, ](ZDType[DType, Scalar], HasEndianness, HasItemSize): """ A base class for Zarr data types that wrap NumPy complex float data types. """ # This attribute holds the possible zarr v2 JSON names for the data type _zarr_v2_names: ClassVar[tuple[str, ...]] @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of this data type from a NumPy complex dtype. Parameters ---------- dtype : TBaseDType The native dtype to convert. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the dtype is not compatible with this data type. """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> DType: """ Convert this class to a NumPy complex dtype with the appropriate byte order. Returns ------- DType A NumPy data type object representing the complex data type with the specified byte order. """ byte_order = endianness_to_numpy_str(self.endianness) return self.dtype_cls().newbyteorder(byte_order) # type: ignore[no-any-return,call-overload] @classmethod def _check_json_v2(cls, data: DTypeJSON) -> TypeGuard[DTypeConfig_V2[str, None]]: """ Check that the input is a valid JSON representation of this data type. The input data must be a mapping that contains a "name" key that is one of the strings from cls._zarr_v2_names and an "object_codec_id" key that is None. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- bool True if the input is a valid JSON representation, False otherwise. """ return ( check_dtype_spec_v2(data) and data["name"] in cls._zarr_v2_names and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[str]: """ Check that the input is a valid JSON representation of this data type in Zarr V3. This method verifies that the provided data matches the expected Zarr V3 representation, which is the string specified by the class-level attribute _zarr_v3_name. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[str] True if the input is a valid representation of this class in Zarr V3, False otherwise. """ return data == cls._zarr_v3_name @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this class from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this class. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): # Going via numpy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this class from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected {cls._zarr_v3_name}." raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[str, None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> str: ... def to_json(self, zarr_format: ZarrFormat) -> DTypeConfig_V2[str, None] | str: """ Serialize this object to a JSON-serializable representation. Parameters ---------- zarr_format : ZarrFormat The Zarr format version. Supported values are 2 and 3. Returns ------- DTypeConfig_V2[str, None] | str If ``zarr_format`` is 2, a dictionary with ``"name"`` and ``"object_codec_id"`` keys is returned. If ``zarr_format`` is 3, a string representation of the complex data type is returned. Raises ------ ValueError If `zarr_format` is not 2 or 3. """ if zarr_format == 2: return {"name": self.to_native_dtype().str, "object_codec_id": None} elif zarr_format == 3: return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[ComplexLike]: """ Check that the input is a scalar complex value. Parameters ---------- data : object The value to check. Returns ------- TypeGuard[ComplexLike] True if the input is a scalar complex value, False otherwise. """ return isinstance(data, ComplexLike) def _cast_scalar_unchecked(self, data: ComplexLike) -> Scalar: """ Cast the provided scalar data to the native scalar type of this class. Parameters ---------- data : ComplexLike The data to cast. Returns ------- Scalar The casted data as a numpy complex scalar. Notes ----- This method does not perform any type checking. The input data must be a scalar complex value. """ return self.to_native_dtype().type(data) # type: ignore[return-value] def cast_scalar(self, data: object) -> Scalar: """ Attempt to cast a given object to a numpy complex scalar. Parameters ---------- data : object The data to be cast to a numpy complex scalar. Returns ------- Scalar The data cast as a numpy complex scalar. Raises ------ TypeError If the data cannot be converted to a numpy complex scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> Scalar: """ Get the default value, which is 0 cast to this dtype Returns ------- Int scalar The default value. """ return self._cast_scalar_unchecked(0) def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> Scalar: """ Read a JSON-serializable value as a numpy float. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The zarr format version. Returns ------- Scalar The numpy float. """ if zarr_format == 2: if check_json_complex_float_v2(data): return self._cast_scalar_unchecked(complex_float_from_json_v2(data)) raise TypeError( f"Invalid type: {data}. Expected a float or a special string encoding of a float." ) elif zarr_format == 3: if check_json_complex_float_v3(data): return self._cast_scalar_unchecked(complex_float_from_json_v3(data)) raise TypeError( f"Invalid type: {data}. Expected a float or a special string encoding of a float." ) raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> JSON: """ Convert an object to a JSON-serializable float. Parameters ---------- data : _BaseScalar The value to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- JSON The JSON-serializable form of the complex number, which is a list of two floats, each of which is encoding according to a zarr-format-specific encoding. """ if zarr_format == 2: return complex_float_to_json_v2(self.cast_scalar(data)) elif zarr_format == 3: return complex_float_to_json_v3(self.cast_scalar(data)) raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @dataclass(frozen=True, kw_only=True) class Complex64(BaseComplex[np.dtypes.Complex64DType, np.complex64]): """ A Zarr data type for arrays containing 64 bit complex floats. Wraps the [`np.dtypes.Complex64DType`][numpy.dtypes.Complex64DType] data type. Scalars for this data type are instances of [`np.complex64`][numpy.complex64]. Attributes ---------- dtype_cls : Type[np.dtypes.Complex64DType] The numpy dtype class for this data type. _zarr_v3_name : ClassVar[Literal["complex64"]] The name of this data type in Zarr V3. _zarr_v2_names : ClassVar[tuple[Literal[">c8"], Literal["c8"], Literal["c8", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 8 @dataclass(frozen=True, kw_only=True) class Complex128(BaseComplex[np.dtypes.Complex128DType, np.complex128], HasEndianness): """ A Zarr data type for arrays containing 64 bit complex floats. Wraps the [`np.dtypes.Complex128DType`][numpy.dtypes.Complex128DType] data type. Scalars for this data type are instances of [`np.complex128`][numpy.complex128]. Attributes ---------- dtype_cls : Type[np.dtypes.Complex128DType] The numpy dtype class for this data type. _zarr_v3_name : ClassVar[Literal["complex128"]] The name of this data type in Zarr V3. _zarr_v2_names : ClassVar[tuple[Literal[">c16"], Literal["c16"], Literal["c16", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 16 zarr-python-3.3.0/src/zarr/core/dtype/npy/float.py000066400000000000000000000325261523267620000221340ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass from typing import TYPE_CHECKING, ClassVar, Literal, Self, TypeGuard, overload import numpy as np from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasEndianness, HasItemSize, check_dtype_spec_v2, ) from zarr.core.dtype.npy.common import ( FloatLike, check_json_float_v2, check_json_float_v3, check_json_floatish_str, endianness_to_numpy_str, float_from_json_v2, float_from_json_v3, float_to_json_v2, float_to_json_v3, get_endianness_from_numpy_dtype, ) from zarr.core.dtype.wrapper import TBaseDType, ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat @dataclass(frozen=True) class BaseFloat[ DType: np.dtypes.Float16DType | np.dtypes.Float32DType | np.dtypes.Float64DType, Scalar: np.float16 | np.float32 | np.float64, ](ZDType[DType, Scalar], HasEndianness, HasItemSize): """ A base class for Zarr data types that wrap NumPy float data types. """ # This attribute holds the possible zarr v2 JSON names for the data type _zarr_v2_names: ClassVar[tuple[str, ...]] @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of this ZDType from a NumPy data type. Parameters ---------- dtype : TBaseDType The NumPy data type. Returns ------- Self An instance of this data type. """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> DType: """ Convert the wrapped data type to a NumPy data type. Returns ------- DType The NumPy data type. """ byte_order = endianness_to_numpy_str(self.endianness) return self.dtype_cls().newbyteorder(byte_order) # type: ignore[no-any-return,call-overload] @classmethod def _check_json_v2(cls, data: DTypeJSON) -> TypeGuard[DTypeConfig_V2[str, None]]: """ Check that the input is a valid JSON representation of this data type. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- TypeGuard[DTypeConfig_V2[str, None]] True if the input is a valid JSON representation of this data type, False otherwise. """ return ( check_dtype_spec_v2(data) and data["name"] in cls._zarr_v2_names and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[str]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- TypeGuard[str] True if the input is a valid JSON representation of this class, False otherwise. """ return data == cls._zarr_v3_name @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this ZDType from Zarr v2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this ZDType from Zarr v3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected {cls._zarr_v3_name}." raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[str, None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> str: ... def to_json(self, zarr_format: ZarrFormat) -> DTypeConfig_V2[str, None] | str: """ Convert the wrapped data type to a JSON-serializable form. Parameters ---------- zarr_format : ZarrFormat The zarr format version. Returns ------- DTypeConfig_V2[str, None] or str The JSON-serializable representation of the wrapped data type. Raises ------ ValueError If zarr_format is not 2 or 3. """ if zarr_format == 2: return {"name": self.to_native_dtype().str, "object_codec_id": None} elif zarr_format == 3: return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[FloatLike]: """ Check that the input is a valid scalar value. Parameters ---------- data : object The input to check. Returns ------- TypeGuard[FloatLike] True if the input is a valid scalar value, False otherwise. """ if isinstance(data, str): # Only accept strings that are valid float representations (e.g. "NaN", "inf"). # Plain strings that cannot be converted should return False so that cast_scalar # raises TypeError rather than a confusing ValueError. try: self.to_native_dtype().type(data) except (ValueError, OverflowError): return False else: return True return isinstance(data, FloatLike) def _cast_scalar_unchecked(self, data: FloatLike) -> Scalar: """ Cast a scalar value to a NumPy float scalar. Parameters ---------- data : FloatLike The scalar value to cast. Returns ------- Scalar The NumPy float scalar. """ return self.to_native_dtype().type(data) # type: ignore[return-value] def cast_scalar(self, data: object) -> Scalar: """ Cast a scalar value to a NumPy float scalar. Parameters ---------- data : object The scalar value to cast. Returns ------- Scalar The NumPy float scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> Scalar: """ Get the default value, which is 0 cast to this zdtype. Returns ------- Scalar The default value. """ return self._cast_scalar_unchecked(0) def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> Scalar: """ Read a JSON-serializable value as a NumPy float scalar. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The zarr format version. Returns ------- Scalar The NumPy float scalar. """ if zarr_format == 2: if check_json_float_v2(data): return self._cast_scalar_unchecked(float_from_json_v2(data)) elif check_json_floatish_str(data): return self._cast_scalar_unchecked(float(data)) else: raise TypeError( f"Invalid type: {data}. Expected a float or a special string encoding of a float." ) elif zarr_format == 3: if check_json_float_v3(data): return self._cast_scalar_unchecked(float_from_json_v3(data)) elif check_json_floatish_str(data): return self._cast_scalar_unchecked(float(data)) else: raise TypeError( f"Invalid type: {data}. Expected a float or a special string encoding of a float." ) else: raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> float | str: """ Convert an object to a JSON-serializable float. Parameters ---------- data : _BaseScalar The value to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- JSON The JSON-serializable form of the float, which is potentially a number or a string. See the zarr specifications for details on the JSON encoding for floats. """ if zarr_format == 2: return float_to_json_v2(self.cast_scalar(data)) elif zarr_format == 3: return float_to_json_v3(self.cast_scalar(data)) else: raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @dataclass(frozen=True, kw_only=True) class Float16(BaseFloat[np.dtypes.Float16DType, np.float16]): """ A Zarr data type for arrays containing 16-bit floating point numbers. Wraps the [`np.dtypes.Float16DType`][numpy.dtypes.Float16DType] data type. Scalars for this data type are instances of [`np.float16`][numpy.float16]. Attributes ---------- dtype_cls : Type[np.dtypes.Float16DType] The NumPy dtype class for this data type. References ---------- This class implements the float16 data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Float16DType _zarr_v3_name = "float16" _zarr_v2_names: ClassVar[tuple[Literal[">f2"], Literal["f2", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 2 @dataclass(frozen=True, kw_only=True) class Float32(BaseFloat[np.dtypes.Float32DType, np.float32]): """ A Zarr data type for arrays containing 32-bit floating point numbers. Wraps the [`np.dtypes.Float32DType`][numpy.dtypes.Float32DType] data type. Scalars for this data type are instances of [`np.float32`][numpy.float32]. Attributes ---------- dtype_cls : Type[np.dtypes.Float32DType] The NumPy dtype class for this data type. References ---------- This class implements the float32 data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Float32DType _zarr_v3_name = "float32" _zarr_v2_names: ClassVar[tuple[Literal[">f4"], Literal["f4", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 4 @dataclass(frozen=True, kw_only=True) class Float64(BaseFloat[np.dtypes.Float64DType, np.float64]): """ A Zarr data type for arrays containing 64-bit floating point numbers. Wraps the [`np.dtypes.Float64DType`][numpy.dtypes.Float64DType] data type. Scalars for this data type are instances of [`np.float64`][numpy.float64]. Attributes ---------- dtype_cls : Type[np.dtypes.Float64DType] The NumPy dtype class for this data type. References ---------- This class implements the float64 data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Float64DType _zarr_v3_name = "float64" _zarr_v2_names: ClassVar[tuple[Literal[">f8"], Literal["f8", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 8 zarr-python-3.3.0/src/zarr/core/dtype/npy/int.py000066400000000000000000001371531523267620000216230ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass from typing import ( TYPE_CHECKING, ClassVar, Literal, Self, SupportsIndex, SupportsInt, TypeGuard, overload, ) import numpy as np from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasEndianness, HasItemSize, check_dtype_spec_v2, ) from zarr.core.dtype.npy.common import ( check_json_int, check_json_intish_float, check_json_intish_str, endianness_to_numpy_str, get_endianness_from_numpy_dtype, ) from zarr.core.dtype.wrapper import TBaseDType, ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat _NumpyIntDType = ( np.dtypes.Int8DType | np.dtypes.Int16DType | np.dtypes.Int32DType | np.dtypes.Int64DType | np.dtypes.UInt8DType | np.dtypes.UInt16DType | np.dtypes.UInt32DType | np.dtypes.UInt64DType ) _NumpyIntScalar = ( np.int8 | np.int16 | np.int32 | np.int64 | np.uint8 | np.uint16 | np.uint32 | np.uint64 ) IntLike = SupportsInt | SupportsIndex | bytes | str @dataclass(frozen=True) class BaseInt[ DType: _NumpyIntDType, Scalar: np.int8 | np.int16 | np.int32 | np.int64 | np.uint8 | np.uint16 | np.uint32 | np.uint64, ](ZDType[DType, Scalar], HasItemSize): """ A base class for integer data types in Zarr. This class provides methods for serialization and deserialization of integer types in both Zarr v2 and v3 formats, as well as methods for checking and casting scalars. """ _zarr_v2_names: ClassVar[tuple[str, ...]] @classmethod def _check_json_v2(cls, data: object) -> TypeGuard[DTypeConfig_V2[str, None]]: """ Check that the input is a valid JSON representation of this integer data type in Zarr V2. This method verifies that the provided data matches the expected Zarr V2 representation for this data type. The input data must be a mapping that contains a "name" key that is one of the strings from cls._zarr_v2_names and an "object_codec_id" key that is None. Parameters ---------- data : object The JSON data to check. Returns ------- TypeGuard[DTypeConfig_V2[str, None]] True if the input is a valid representation of this class in Zarr V2, False otherwise. """ return ( check_dtype_spec_v2(data) and data["name"] in cls._zarr_v2_names and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: object) -> TypeGuard[str]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : object The JSON data to check. Returns ------- TypeGuard[str] True if the input is a valid representation of this class in Zarr v3, False otherwise. """ return data == cls._zarr_v3_name def _check_scalar(self, data: object) -> TypeGuard[IntLike]: """ Check if the input object is of an IntLike type. This method verifies whether the provided data can be considered as an integer-like value, which includes objects supporting integer conversion. Parameters ---------- data : object The data to check. Returns ------- TypeGuard[IntLike] True if the data is IntLike, False otherwise. """ return isinstance(data, IntLike) def _cast_scalar_unchecked(self, data: IntLike) -> Scalar: """ Casts a given scalar value to the native integer scalar type without type checking. Parameters ---------- data : IntLike The scalar value to cast. Returns ------- Scalar The casted integer scalar of the native dtype. """ return self.to_native_dtype().type(data) # type: ignore[return-value] def cast_scalar(self, data: object) -> Scalar: """ Attempt to cast a given object to a NumPy integer scalar. Parameters ---------- data : object The data to be cast to a NumPy integer scalar. Returns ------- Scalar The data cast as a NumPy integer scalar. Raises ------ TypeError If the data cannot be converted to a NumPy integer scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> Scalar: """ Get the default value, which is 0 cast to this dtype. Returns ------- Scalar The default value. """ return self._cast_scalar_unchecked(0) def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> Scalar: """ Read a JSON-serializable value as a NumPy int scalar. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The Zarr format version. Returns ------- Scalar The NumPy int scalar. Raises ------ TypeError If the input is not a valid integer type. """ if check_json_int(data): return self._cast_scalar_unchecked(data) if check_json_intish_float(data): return self._cast_scalar_unchecked(int(data)) if check_json_intish_str(data): return self._cast_scalar_unchecked(int(data)) raise TypeError(f"Invalid type: {data}. Expected an integer.") def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> int: """ Convert an object to a JSON serializable scalar. For the integer data types, the JSON form is a plain integer. Parameters ---------- data : object The value to convert. zarr_format : ZarrFormat The Zarr format version. Returns ------- int The JSON-serializable form of the scalar. """ return int(self.cast_scalar(data)) @dataclass(frozen=True, kw_only=True) class Int8(BaseInt[np.dtypes.Int8DType, np.int8]): """ A Zarr data type for arrays containing 8-bit signed integers. Wraps the [`np.dtypes.Int8DType`][numpy.dtypes.Int8DType] data type. Scalars for this data type are instances of [`np.int8`][numpy.int8]. Attributes ---------- dtype_cls : np.dtypes.Int8DType The class of the underlying NumPy dtype. References ---------- This class implements the 8-bit signed integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Int8DType _zarr_v3_name: ClassVar[Literal["int8"]] = "int8" _zarr_v2_names: ClassVar[tuple[Literal["|i1"]]] = ("|i1",) @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an Int8 from an np.dtype('int8') instance. Parameters ---------- dtype : TBaseDType The np.dtype('int8') instance. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data type is not a valid representation of this class Int8. """ if cls._check_native_dtype(dtype): return cls() raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self: Self) -> np.dtypes.Int8DType: """ Convert the Int8 instance to an np.dtype('int8') instance. Returns ------- np.dtypes.Int8DType The np.dtype('int8') instance. """ return self.dtype_cls() @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an Int8 from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class Int8. """ if cls._check_json_v2(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v2_names[0]!r}" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an Int8 from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class Int8. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal["|i1"], None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> Literal["int8"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal["|i1"], None] | Literal["int8"]: """ Convert the data type to a JSON-serializable form. Parameters ---------- zarr_format : ZarrFormat The Zarr format version. Returns ------- ``DTypeConfig_V2[Literal["|i1"], None] | Literal["int8"]`` The JSON-serializable representation of the data type. Raises ------ ValueError If the zarr_format is not 2 or 3. """ if zarr_format == 2: return {"name": self._zarr_v2_names[0], "object_codec_id": None} elif zarr_format == 3: return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 1 @dataclass(frozen=True, kw_only=True) class UInt8(BaseInt[np.dtypes.UInt8DType, np.uint8]): """ A Zarr data type for arrays containing 8-bit unsigned integers. Wraps the [`np.dtypes.UInt8DType`][numpy.dtypes.UInt8DType] data type. Scalars for this data type are instances of [`np.uint8`][numpy.uint8]. Attributes ---------- dtype_cls : np.dtypes.UInt8DType The class of the underlying NumPy dtype. References ---------- This class implements the 8-bit unsigned integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.UInt8DType _zarr_v3_name: ClassVar[Literal["uint8"]] = "uint8" _zarr_v2_names: ClassVar[tuple[Literal["|u1"]]] = ("|u1",) @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create a UInt8 from an np.dtype('uint8') instance. """ if cls._check_native_dtype(dtype): return cls() raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self: Self) -> np.dtypes.UInt8DType: """ Create a NumPy unsigned 8-bit integer dtype instance from this UInt8 ZDType. Returns ------- np.dtypes.UInt8DType The NumPy unsigned 8-bit integer dtype. """ return self.dtype_cls() @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v2_names[0]!r}" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal["|u1"], None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> Literal["uint8"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal["|u1"], None] | Literal["uint8"]: """ Convert the data type to a JSON-serializable form. Parameters ---------- zarr_format : ZarrFormat The Zarr format version. Supported values are 2 and 3. Returns ------- ``DTypeConfig_V2[Literal["|u1"], None] | Literal["uint8"]`` The JSON-serializable representation of the data type. Raises ------ ValueError If `zarr_format` is not 2 or 3. """ if zarr_format == 2: # For Zarr format version 2, return a dictionary with the name and object codec ID. return {"name": self._zarr_v2_names[0], "object_codec_id": None} elif zarr_format == 3: # For Zarr format version 3, return the v3 name as a string. return self._zarr_v3_name # Raise an error if the zarr_format is neither 2 nor 3. raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 1 @dataclass(frozen=True, kw_only=True) class Int16(BaseInt[np.dtypes.Int16DType, np.int16], HasEndianness): """ A Zarr data type for arrays containing 16-bit signed integers. Wraps the [`np.dtypes.Int16DType`][numpy.dtypes.Int16DType] data type. Scalars for this data type are instances of [`np.int16`][numpy.int16]. Attributes ---------- dtype_cls : np.dtypes.Int16DType The class of the underlying NumPy dtype. References ---------- This class implements the 16-bit signed integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Int16DType _zarr_v3_name: ClassVar[Literal["int16"]] = "int16" _zarr_v2_names: ClassVar[tuple[Literal[">i2"], Literal["i2", " Self: """ Create an instance of this data type from an np.dtype('int16') instance. Parameters ---------- dtype : np.dtype The instance of np.dtype('int16') to create from. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data type is not an instance of np.dtype('int16'). """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.Int16DType: """ Convert the data type to an np.dtype('int16') instance. Returns ------- np.dtype The np.dtype('int16') instance. """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls().newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names!r}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal[">i2", " Literal["int16"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal[">i2", "i2", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 2 @dataclass(frozen=True, kw_only=True) class UInt16(BaseInt[np.dtypes.UInt16DType, np.uint16], HasEndianness): """ A Zarr data type for arrays containing 16-bit unsigned integers. Wraps the [`np.dtypes.UInt16DType`][numpy.dtypes.UInt16DType] data type. Scalars for this data type are instances of [`np.uint16`][numpy.uint16]. Attributes ---------- dtype_cls : np.dtypes.UInt16DType The class of the underlying NumPy dtype. References ---------- This class implements the unsigned 16-bit unsigned integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.UInt16DType _zarr_v3_name: ClassVar[Literal["uint16"]] = "uint16" _zarr_v2_names: ClassVar[tuple[Literal[">u2"], Literal["u2", " Self: """ Create an instance of this data type from an np.dtype('uint16') instance. Parameters ---------- dtype : np.dtype The NumPy data type. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data type is not an instance of np.dtype('uint16'). """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.UInt16DType: """ Convert the data type to an np.dtype('uint16') instance. Returns ------- np.dtype The np.dtype('uint16') instance. """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls().newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of UInt16. Got {data!r}, expected one of the strings {cls._zarr_v2_names}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of UInt16. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal[">u2", " Literal["uint16"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal[">u2", "u2", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 2 @dataclass(frozen=True, kw_only=True) class Int32(BaseInt[np.dtypes.Int32DType, np.int32], HasEndianness): """ A Zarr data type for arrays containing 32-bit signed integers. Wraps the [`np.dtypes.Int32DType`][numpy.dtypes.Int32DType] data type. Scalars for this data type are instances of [`np.int32`][numpy.int32]. Attributes ---------- dtype_cls : np.dtypes.Int32DType The class of the underlying NumPy dtype. References ---------- This class implements the 32-bit signed integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Int32DType _zarr_v3_name: ClassVar[Literal["int32"]] = "int32" _zarr_v2_names: ClassVar[tuple[Literal[">i4"], Literal["i4", " TypeGuard[np.dtypes.Int32DType]: """ A type guard that checks if the input is assignable to the type of ``cls.dtype_class`` This method is overridden for this particular data type because of a Windows-specific issue where np.dtype('i') creates an instance of ``np.dtypes.IntDType``, rather than an instance of ``np.dtypes.Int32DType``, even though both represent 32-bit signed integers. Parameters ---------- dtype : TDType The dtype to check. Returns ------- Bool True if the dtype matches, False otherwise. """ return super()._check_native_dtype(dtype) or dtype == np.dtypes.Int32DType() @classmethod def from_native_dtype(cls: type[Self], dtype: TBaseDType) -> Self: """ Create an Int32 from an np.dtype('int32') instance. Parameters ---------- dtype : TBaseDType The np.dtype('int32') instance. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class Int32. """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self: Self) -> np.dtypes.Int32DType: """ Convert the Int32 instance to an np.dtype('int32') instance. Returns ------- np.dtypes.Int32DType The np.dtype('int32') instance. """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls().newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an Int32 from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class Int32. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names!r}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an Int32 from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class Int32. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal[">i4", " Literal["int32"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal[">i4", "i4", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 4 @dataclass(frozen=True, kw_only=True) class UInt32(BaseInt[np.dtypes.UInt32DType, np.uint32], HasEndianness): """ A Zarr data type for arrays containing 32-bit unsigned integers. Wraps the [`np.dtypes.UInt32DType`][numpy.dtypes.UInt32DType] data type. Scalars for this data type are instances of [`np.uint32`][numpy.uint32]. Attributes ---------- dtype_cls : np.dtypes.UInt32DType The class of the underlying NumPy dtype. References ---------- This class implements the 32-bit unsigned integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.UInt32DType _zarr_v3_name: ClassVar[Literal["uint32"]] = "uint32" _zarr_v2_names: ClassVar[tuple[Literal[">u4"], Literal["u4", " TypeGuard[np.dtypes.UInt32DType]: """ A type guard that checks if the input is assignable to the type of ``cls.dtype_class`` This method is overridden for this particular data type because of a Windows-specific issue where ``np.array([1], dtype=np.uint32) & 1`` creates an instance of ``np.dtypes.UIntDType``, rather than an instance of ``np.dtypes.UInt32DType``, even though both represent 32-bit unsigned integers. (In contrast to ``np.dtype('i')``, ``np.dtype('u')`` raises an error.) Parameters ---------- dtype : TDType The dtype to check. Returns ------- Bool True if the dtype matches, False otherwise. """ return super()._check_native_dtype(dtype) or dtype == np.dtypes.UInt32DType() @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create a UInt32 from an np.dtype('uint32') instance. Parameters ---------- dtype : TBaseDType The NumPy data type. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data type is not a valid representation of this class 32-bit unsigned integer. """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.UInt32DType: """ Create a NumPy unsigned 32-bit integer dtype instance from this UInt32 ZDType. Returns ------- np.dtypes.UInt32DType The NumPy unsigned 32-bit integer dtype. """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls().newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class 32-bit unsigned integer. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class 32-bit unsigned integer. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal[">u4", " Literal["uint32"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal[">u4", "u4", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 4 @dataclass(frozen=True, kw_only=True) class Int64(BaseInt[np.dtypes.Int64DType, np.int64], HasEndianness): """ A Zarr data type for arrays containing 64-bit signed integers. Wraps the [`np.dtypes.Int64DType`][numpy.dtypes.Int64DType] data type. Scalars for this data type are instances of [`np.int64`][numpy.int64]. Attributes ---------- dtype_cls : np.dtypes.Int64DType The class of the underlying NumPy dtype. References ---------- This class implements the 64-bit signed integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.Int64DType _zarr_v3_name: ClassVar[Literal["int64"]] = "int64" _zarr_v2_names: ClassVar[tuple[Literal[">i8"], Literal["i8", " Self: """ Create an Int64 from an np.dtype('int64') instance. Parameters ---------- dtype : TBaseDType The NumPy data type. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data type is not a valid representation of this class 64-bit signed integer. """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.Int64DType: """ Create a NumPy signed 64-bit integer dtype instance from this Int64 ZDType. Returns ------- np.dtypes.Int64DType The NumPy signed 64-bit integer dtype. """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls().newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class 64-bit signed integer. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class 64-bit signed integer. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal[">i8", " Literal["int64"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal[">i8", "i8", " int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 8 @dataclass(frozen=True, kw_only=True) class UInt64(BaseInt[np.dtypes.UInt64DType, np.uint64], HasEndianness): """ A Zarr data type for arrays containing 64-bit unsigned integers. Wraps the [`np.dtypes.UInt64DType`][numpy.dtypes.UInt64DType] data type. Scalars for this data type are instances of [`np.uint64`][numpy.uint64]. Attributes ---------- dtype_cls: np.dtypes.UInt64DType The class of the underlying NumPy dtype. References ---------- This class implements the unsigned 64-bit integer data type defined in Zarr V2 and V3. See the [Zarr V2](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding) and [Zarr V3](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/data-types/index.rst) specification documents for details. """ dtype_cls = np.dtypes.UInt64DType _zarr_v3_name: ClassVar[Literal["uint64"]] = "uint64" _zarr_v2_names: ClassVar[tuple[Literal[">u8"], Literal["u8", " np.dtypes.UInt64DType: """ Convert the data type to a native NumPy dtype. Returns ------- np.dtypes.UInt64DType The native NumPy dtype.eeeeeeeeeeeeeeeee """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls().newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class unsigned 64-bit integer. """ if cls._check_json_v2(data): # Going via NumPy ensures that we get the endianness correct without # annoying string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected one of the strings {cls._zarr_v2_names}." raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from Zarr V3-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class unsigned 64-bit integer. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[Literal[">u8", " Literal["uint64"]: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[Literal[">u8", "u8", " Self: """ Create an instance of this data type from a native NumPy dtype. Parameters ---------- dtype : TBaseDType The native NumPy dtype. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input dtype is not a valid representation of this class unsigned 64-bit integer. """ if cls._check_native_dtype(dtype): return cls(endianness=get_endianness_from_numpy_dtype(dtype)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 8 zarr-python-3.3.0/src/zarr/core/dtype/npy/string.py000066400000000000000000000532521523267620000223340ustar00rootroot00000000000000from __future__ import annotations import re from dataclasses import dataclass from typing import ( TYPE_CHECKING, ClassVar, Literal, Protocol, Self, TypedDict, TypeGuard, overload, runtime_checkable, ) import numpy as np from zarr.core.common import NamedConfig from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasEndianness, HasItemSize, HasLength, HasObjectCodec, check_dtype_spec_v2, ) from zarr.core.dtype.npy.common import ( check_json_str, endianness_to_numpy_str, get_endianness_from_numpy_dtype, ) from zarr.core.dtype.wrapper import ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat from zarr.core.dtype.wrapper import TBaseDType @runtime_checkable class SupportsStr(Protocol): def __str__(self) -> str: ... class LengthBytesConfig(TypedDict): """ Configuration for a fixed-length string data type in Zarr V3. Attributes ---------- length_bytes : int The length in bytes of the data associated with this configuration. """ length_bytes: int class FixedLengthUTF32JSON_V2(DTypeConfig_V2[str, None]): """ A wrapper around the JSON representation of the ``FixedLengthUTF32`` data type in Zarr V2. The ``name`` field of this class contains the value that would appear under the ``dtype`` field in Zarr V2 array metadata. References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": " None: """ We don't allow instances of this class with length less than 1 because there is no way such a data type can contain actual data. """ if self.length < 1: raise ValueError(f"length must be >= 1, got {self.length}.") @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create a FixedLengthUTF32 from a NumPy data type. Parameters ---------- dtype : TBaseDType The NumPy data type. Returns ------- Self An instance of this data type. """ if cls._check_native_dtype(dtype): endianness = get_endianness_from_numpy_dtype(dtype) return cls( length=dtype.itemsize // (cls.code_point_bytes), endianness=endianness, ) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.StrDType[int]: """ Convert the FixedLengthUTF32 instance to a NumPy data type. Returns ------- np.dtypes.StrDType[int] The NumPy data type. """ byte_order = endianness_to_numpy_str(self.endianness) # numpy 2.x stub: newbyteorder widens to base dtype, runtime preserves the concrete subclass return self.dtype_cls(self.length).newbyteorder(byte_order) # type: ignore[return-value] @classmethod def _check_json_v2(cls, data: DTypeJSON) -> TypeGuard[FixedLengthUTF32JSON_V2]: """ Check that the input is a valid JSON representation of a NumPy U dtype. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- TypeGuard[FixedLengthUTF32JSON_V2] Whether the input is a valid JSON representation of a NumPy U dtype. """ return ( check_dtype_spec_v2(data) and isinstance(data["name"], str) and re.match(r"^[><]U\d+$", data["name"]) is not None and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[FixedLengthUTF32JSON_V3]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- TypeGuard[FixedLengthUTF32JSONV3] Whether the input is a valid JSON representation of a NumPy U dtype. """ return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] == cls._zarr_v3_name and "configuration" in data and isinstance(data["configuration"], dict) and set(data["configuration"].keys()) == {"length_bytes"} and isinstance(data["configuration"]["length_bytes"], int) ) @overload def to_json(self, zarr_format: Literal[2]) -> DTypeConfig_V2[str, None]: ... @overload def to_json(self, zarr_format: Literal[3]) -> FixedLengthUTF32JSON_V3: ... def to_json( self, zarr_format: ZarrFormat ) -> DTypeConfig_V2[str, None] | FixedLengthUTF32JSON_V3: """ Convert the FixedLengthUTF32 instance to a JSON representation. Parameters ---------- zarr_format : ZarrFormat The Zarr format to use. Returns ------- DTypeConfig_V2[str, None] | FixedLengthUTF32JSON_V3 The JSON representation of the data type. """ if zarr_format == 2: return {"name": self.to_native_dtype().str, "object_codec_id": None} elif zarr_format == 3: return { "name": self._zarr_v3_name, "configuration": {"length_bytes": self.length * self.code_point_bytes}, } raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create a FixedLengthUTF32 from a JSON representation of a NumPy U dtype. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. """ if cls._check_json_v2(data): # Construct the NumPy dtype instead of string parsing. name = data["name"] return cls.from_native_dtype(np.dtype(name)) raise DataTypeValidationError( f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a string representation of a NumPy U dtype." ) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create a FixedLengthUTF32 from a JSON representation of a NumPy U dtype. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- Self An instance of this data type. """ if cls._check_json_v3(data): return cls(length=data["configuration"]["length_bytes"] // cls.code_point_bytes) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected {cls._zarr_v3_name}." raise DataTypeValidationError(msg) def default_scalar(self) -> np.str_: """ Return the default scalar value for this data type. Returns ------- ``np.str_`` The default scalar value. """ return np.str_("") def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str: """ Convert the scalar value to a JSON representation. Parameters ---------- data : object The scalar value. zarr_format : ZarrFormat The Zarr format to use. Returns ------- str The JSON representation of the scalar value. """ return str(data) def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.str_: """ Convert the JSON representation of a scalar value to the native scalar value. Parameters ---------- data : JSON The JSON data. zarr_format : ZarrFormat The Zarr format to use. Returns ------- ``np.str_`` The native scalar value. """ if check_json_str(data): return self.to_native_dtype().type(data) raise TypeError(f"Invalid type: {data}. Expected a string.") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[SupportsStr]: """ Check that the input is a valid scalar value for this data type. Parameters ---------- data : object The scalar value. Returns ------- TypeGuard[SupportsStr] Whether the input is a valid scalar value for this data type. """ # this is generous for backwards compatibility return isinstance(data, SupportsStr) def cast_scalar(self, data: object) -> np.str_: """ Cast the scalar value to the native scalar value. Parameters ---------- data : object The scalar value. Returns ------- ``np.str_`` The native scalar value. """ if self._check_scalar(data): # We explicitly truncate before casting because of the following NumPy behavior: # >>> x = np.dtype('U3').type('hello world') # >>> x # np.str_('hello world') # >>> x.dtype # dtype('U11') return self.to_native_dtype().type(str(data)[: self.length]) msg = ( # pragma: no cover f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) # pragma: no-cover @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return self.length * self.code_point_bytes def check_vlen_string_json_scalar(data: object) -> TypeGuard[int | str | float]: """ Check if the input is a valid JSON scalar for a variable-length string. This function is generous for backwards compatibility, as Zarr Python v2 would use ints for variable-length string fill values. Parameters ---------- data : object The JSON value to check. Returns ------- TypeGuard[int | str | float] True if the input is a valid scalar for a variable-length string. """ return isinstance(data, int | str | float) class VariableLengthUTF8JSON_V2(DTypeConfig_V2[Literal["|O"], Literal["vlen-utf8"]]): """ A wrapper around the JSON representation of the ``VariableLengthUTF8`` data type in Zarr V2. The ``name`` field of this class contains the value that would appear under the ``dtype`` field in Zarr V2 array metadata. The ``object_codec_id`` field is always ``"vlen-utf8"``. References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": "|O", "object_codec_id": "vlen-utf8" } ``` """ @dataclass(frozen=True, kw_only=True) class VariableLengthUTF8(ZDType[np.dtypes.StringDType, str], HasObjectCodec): # type: ignore[type-var] """ A Zarr data type for arrays containing variable-length UTF-8 strings. Wraps the ``np.dtypes.StringDType`` data type. Scalars for this data type are instances of ``str``. Attributes ---------- dtype_cls : Type[np.dtypes.StringDType] The NumPy dtype class for this data type. _zarr_v3_name : ClassVar[Literal["variable_length_utf8"]] = "variable_length_utf8" The name of this data type in Zarr V3. object_codec_id : ClassVar[Literal["vlen-utf8"]] = "vlen-utf8" The object codec ID for this data type. References ---------- https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/string """ dtype_cls = np.dtypes.StringDType # type: ignore[assignment] _zarr_v3_name: ClassVar[Literal["string"]] = "string" object_codec_id: ClassVar[Literal["vlen-utf8"]] = "vlen-utf8" @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of this data type from a compatible NumPy data type. We reject NumPy StringDType instances that have the `na_object` field set, because this is not representable by the Zarr `string` data type. Parameters ---------- dtype : TBaseDType The native data type. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input is not compatible with this data type. ValueError If the input is `numpy.dtypes.StringDType` and has `na_object` set. """ if cls._check_native_dtype(dtype): if hasattr(dtype, "na_object"): msg = ( f"Zarr data type resolution from {dtype} failed. " "Attempted to resolve a zarr data type from a `numpy.dtypes.StringDType` " "with `na_object` set, which is not supported." ) raise ValueError(msg) return cls() raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.StringDType: """ Create a NumPy string dtype from this VariableLengthUTF8 ZDType. Returns ------- np.dtypes.StringDType The NumPy string dtype. """ return self.dtype_cls() @classmethod def _check_json_v2( cls, data: DTypeJSON, ) -> TypeGuard[VariableLengthUTF8JSON_V2]: """ "Check if the input is a valid JSON representation of a variable-length UTF-8 string dtype for Zarr v2." Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- ``TypeGuard[VariableLengthUTF8JSON_V2]`` Whether the input is a valid JSON representation of a NumPy "object" data type, and that the object codec id is appropriate for variable-length UTF-8 strings. """ return ( check_dtype_spec_v2(data) and data["name"] == "|O" and data["object_codec_id"] == cls.object_codec_id ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[Literal["variable_length_utf8"]]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[Literal["variable_length_utf8"]] Whether the input is a valid JSON representation of a variable length UTF-8 string data type. """ return data == cls._zarr_v3_name @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this class from a JSON representation of a NumPy "object" dtype. Parameters ---------- data : DTypeJSON The JSON data to create an instance from. Returns ------- Self An instance of this data type. """ if cls._check_json_v2(data): return cls() msg = ( f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected the string '|O'" ) raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this class from a JSON representation of a variable length UTF-8 string data type. Parameters ---------- data : DTypeJSON The JSON data to create an instance from. Returns ------- Self An instance of this data type. """ if cls._check_json_v3(data): return cls() msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected {cls._zarr_v3_name}." raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> VariableLengthUTF8JSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> Literal["string"]: ... def to_json(self, zarr_format: ZarrFormat) -> VariableLengthUTF8JSON_V2 | Literal["string"]: """ Convert this data type to a JSON representation. Parameters ---------- zarr_format : int The zarr format to use for the JSON representation. Returns ------- ``VariableLengthUTF8JSON_V2 | Literal["string"]`` The JSON representation of this data type. """ if zarr_format == 2: return {"name": "|O", "object_codec_id": self.object_codec_id} elif zarr_format == 3: return self._zarr_v3_name raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def default_scalar(self) -> str: """ Return the default scalar value for this data type. Returns ------- str The default scalar value. """ return "" def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str: """ Convert a scalar value to a JSON representation. Parameters ---------- data : object The scalar value to convert. zarr_format : int The zarr format to use for the JSON representation. Returns ------- str The JSON representation of the scalar value. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) raise TypeError(f"Invalid type: {data}. Expected a string.") def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> str: """ Convert a JSON representation of a scalar value to the native scalar type. Parameters ---------- data : JSON The JSON representation of the scalar value. zarr_format : int The zarr format to use for the JSON representation. Returns ------- str The native scalar type of the scalar value. """ if not check_vlen_string_json_scalar(data): raise TypeError(f"Invalid type: {data}. Expected a string or number.") return str(data) def _check_scalar(self, data: object) -> TypeGuard[SupportsStr]: """ Check that the input is a valid scalar value for this data type. Parameters ---------- data : object The scalar value to check. Returns ------- TypeGuard[SupportsStr] Whether the input is a valid scalar value for this data type. """ return isinstance(data, SupportsStr) def _cast_scalar_unchecked(self, data: SupportsStr) -> str: """ Cast a scalar value to a string. Parameters ---------- data : object The scalar value to cast. Returns ------- str The string representation of the scalar value. """ return str(data) def cast_scalar(self, data: object) -> str: """ Cast an object to a string. Parameters ---------- data : object The value to cast. Returns ------- str The input cast to str. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( # pragma: no cover f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) # pragma: no cover zarr-python-3.3.0/src/zarr/core/dtype/npy/structured.py000066400000000000000000000547611523267620000232400ustar00rootroot00000000000000from __future__ import annotations from collections.abc import Sequence from dataclasses import dataclass from typing import TYPE_CHECKING, ClassVar, Literal, Self, TypeGuard, cast, overload import numpy as np from zarr.core.common import NamedConfig from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasItemSize, StructuredName_V2, check_dtype_spec_v2, check_structured_dtype_name_v2, v3_unstable_dtype_warning, ) from zarr.core.dtype.npy.common import ( bytes_from_json, bytes_to_json, check_json_str, ) from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat StructuredScalarLike = list[object] | tuple[object, ...] | bytes | int class StructuredJSON_V2(DTypeConfig_V2[StructuredName_V2, None]): """ A wrapper around the JSON representation of the ``Structured`` data type in Zarr V2. The ``name`` field is a sequence of sequences, where each inner sequence has two values: the field name and the data type name for that field (which could be another sequence). The data type names are strings, and the object codec ID is always None. References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": [ ["f0", " None: if len(self.fields) < 1: raise ValueError(f"must have at least one field. Got {self.fields!r}") @classmethod def _check_native_dtype(cls, dtype: TBaseDType) -> TypeGuard[np.dtypes.VoidDType[int]]: """ Check that this dtype is a numpy structured dtype Parameters ---------- dtype : np.dtypes.DTypeLike The dtype to check. Returns ------- TypeGuard[np.dtypes.VoidDType] True if the dtype matches, False otherwise. """ return isinstance(dtype, cls.dtype_cls) and dtype.fields is not None @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create a Structured ZDType from a native NumPy data type. Parameters ---------- dtype : TBaseDType The native data type. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input data type is not an instance of np.dtypes.VoidDType with a non-null ``fields`` attribute. Notes ----- This method attempts to resolve the fields of the structured dtype using the data type registry. """ from zarr.core.dtype import get_data_type_from_native_dtype fields: list[tuple[str, ZDType[TBaseDType, TBaseScalar]]] = [] if cls._check_native_dtype(dtype): # fields of a structured numpy dtype are either 2-tuples or 3-tuples. we only # care about the first element in either case. for key, (dtype_instance, *_) in dtype.fields.items(): # type: ignore[union-attr] dtype_wrapped = get_data_type_from_native_dtype(dtype_instance) fields.append((key, dtype_wrapped)) return cls(fields=tuple(fields)) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> np.dtypes.VoidDType[int]: """ Convert the structured Zarr data type to a native NumPy void dtype. This method constructs a NumPy dtype with fields corresponding to the fields of the structured Zarr data type, by converting each field's data type to its native dtype representation. Returns ------- np.dtypes.VoidDType[int] The native NumPy void dtype representing the structured data type. """ return cast( "np.dtypes.VoidDType[int]", np.dtype([(key, dtype.to_native_dtype()) for (key, dtype) in self.fields]), ) @classmethod def _check_json_v2( cls, data: DTypeJSON, ) -> TypeGuard[StructuredJSON_V2]: """ Check if the input is a valid JSON representation of a Structured data type for Zarr V2. The input data must be a mapping that contains a "name" key that is not a str, and an "object_codec_id" key that is None. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[StructuredJSON_V2] True if the input is a valid JSON representation of a Structured data type for Zarr V2, False otherwise. """ return ( check_dtype_spec_v2(data) and not isinstance(data["name"], str) and check_structured_dtype_name_v2(data["name"]) and data["object_codec_id"] is None ) @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[StructuredJSON_V3]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[StructuredJSON_V3] True if the input is a valid JSON representation of a structured data type for Zarr V3, False otherwise. """ return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] == cls._zarr_v3_name and isinstance(data["configuration"], dict) and set(data["configuration"].keys()) == {"fields"} ) @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: # avoid circular import from zarr.core.dtype import get_data_type_from_json if cls._check_json_v2(data): # structured dtypes are constructed directly from a list of lists # note that we do not handle the object codec here! this will prevent structured # dtypes from containing object dtypes. name = data["name"] return cls( fields=tuple( # type: ignore[str-unpack] ( # type: ignore[misc] f_name, get_data_type_from_json( {"name": f_dtype, "object_codec_id": None}, zarr_format=2 ), ) for f_name, f_dtype in name ) ) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a JSON array of arrays" raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: from zarr.core.dtype import get_data_type_from_json if cls._check_json_v3(data): config = data["configuration"] meta_fields = config["fields"] return cls( fields=tuple( (f_name, get_data_type_from_json(f_dtype, zarr_format=3)) # type: ignore[misc] for f_name, f_dtype in meta_fields ) ) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a JSON object with the key {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> StructuredJSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> StructuredJSON_V3: ... def to_json(self, zarr_format: ZarrFormat) -> StructuredJSON_V2 | StructuredJSON_V3: """ Convert the structured data type to a JSON-serializable form. Parameters ---------- zarr_format : ZarrFormat The Zarr format version. Accepted values are 2 and 3. Returns ------- StructuredJSON_V2 | StructuredJSON_V3 The JSON representation of the structured data type. Raises ------ ValueError If the zarr_format is not 2 or 3. """ if zarr_format == 2: fields = [ [f_name, f_dtype.to_json(zarr_format=zarr_format)["name"]] for f_name, f_dtype in self.fields ] return {"name": fields, "object_codec_id": None} elif zarr_format == 3: v3_unstable_dtype_warning(self) fields = [ [f_name, f_dtype.to_json(zarr_format=zarr_format)] # type: ignore[list-item] for f_name, f_dtype in self.fields ] base_dict = { "name": self._zarr_v3_name, "configuration": {"fields": fields}, } return cast("StructuredJSON_V3", base_dict) raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[StructuredScalarLike]: # TODO: implement something more precise here! """ Check that the input is a valid scalar value for this structured data type. Parameters ---------- data : object The scalar value to check. Returns ------- TypeGuard[StructuredScalarLike] Whether the input is a valid scalar value for this structured data type. """ return isinstance(data, (bytes, list, tuple, int, np.void)) def _cast_scalar_unchecked(self, data: StructuredScalarLike) -> np.void: """ Cast a python object to a numpy structured scalar without type checking. Parameters ---------- data : StructuredScalarLike The data to cast. Returns ------- np.void The casted data as a numpy structured scalar. Notes ----- This method does not perform any type checking. The input data must be castable to a numpy structured scalar. """ na_dtype = self.to_native_dtype() if isinstance(data, bytes): res = np.frombuffer(data, dtype=na_dtype)[0] elif isinstance(data, list | tuple): res = np.array([tuple(data)], dtype=na_dtype)[0] else: res = np.array([data], dtype=na_dtype)[0] return cast("np.void", res) def cast_scalar(self, data: object) -> np.void: """ Cast a Python object to a NumPy structured scalar. This function attempts to cast the provided data to a NumPy structured scalar. If the data is compatible with the structured scalar type, it is cast without type checking. Otherwise, a TypeError is raised. Parameters ---------- data : object The data to be cast to a NumPy structured scalar. Returns ------- np.void The data cast as a NumPy structured scalar. Raises ------ TypeError If the data cannot be converted to a NumPy structured scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> np.void: """ Get the default scalar value for this structured data type. Returns ------- np.void The default scalar value, which is the scalar representation of 0 cast to this structured data type. """ return self._cast_scalar_unchecked(0) def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.void: """ Read a JSON-serializable value as a NumPy structured scalar. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The zarr format version. Returns ------- np.void The NumPy structured scalar. Raises ------ TypeError If the input is not a base64-encoded string. """ if check_json_str(data): as_bytes = bytes_from_json(data, zarr_format=zarr_format) dtype = self.to_native_dtype() return cast("np.void", np.array([as_bytes]).view(dtype)[0]) raise TypeError(f"Invalid type: {data}. Expected a string.") def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str | dict[str, JSON]: """ Convert a scalar to a JSON-serializable string representation. Parameters ---------- data : object The scalar to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- str | dict[str, JSON] A string representation of the scalar, which is a base64-encoded string of the bytes that make up the scalar. Subclasses may return a dict for V3 format. """ return bytes_to_json(self.cast_scalar(data).tobytes(), zarr_format) @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return self.to_native_dtype().itemsize def has_multi_byte_fields(self) -> bool: """ Check if this structured dtype has any fields with item_size > 1. Returns ------- bool True if any field has item_size > 1, False otherwise. """ return any( isinstance(field_dtype, HasItemSize) and field_dtype.item_size > 1 for _, field_dtype in self.fields ) @dataclass(frozen=True, kw_only=True) class Struct(Structured): """ A Zarr data type for arrays containing structured scalars, AKA "record arrays". Wraps the NumPy `np.dtypes.VoidDType` if the data type has fields. Scalars for this data type are instances of `np.void`, with a ``fields`` attribute. This is the canonical data type registered for structured arrays. It reads both the canonical ``"struct"`` format (object-style fields) and the legacy ``"structured"`` format (tuple-style fields), but always writes the canonical ``"struct"`` format. Attributes ---------- fields : Sequence[tuple[str, ZDType]] The fields of the structured dtype. References ---------- The Zarr V3 specification for this data type is defined in the zarr-extensions repository: https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/struct The Zarr V2 data type specification can be found [here](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). """ _zarr_v3_name: ClassVar[Literal["struct"]] = "struct" # type: ignore[assignment] @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[StructJSON_V3]: # type: ignore[override] return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] in ("struct", "structured") and isinstance(data["configuration"], dict) and set(data["configuration"].keys()) == {"fields"} ) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: from zarr.core.dtype import get_data_type_from_json if cls._check_json_v3(data): config = data["configuration"] meta_fields = config["fields"] parsed_fields: list[tuple[str, ZDType[TBaseDType, TBaseScalar]]] = [] for field in meta_fields: if isinstance(field, dict): f_name = field["name"] f_dtype = field["data_type"] else: # Legacy tuple-style field format from "structured" dtype f_name, f_dtype = field # type: ignore[unreachable] parsed_fields.append((f_name, get_data_type_from_json(f_dtype, zarr_format=3))) # type: ignore[arg-type] return cls(fields=tuple(parsed_fields)) msg = f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a JSON object with the key {cls._zarr_v3_name!r}" raise DataTypeValidationError(msg) @overload # type: ignore[override] def to_json(self, zarr_format: Literal[2]) -> StructuredJSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> StructJSON_V3: ... def to_json(self, zarr_format: ZarrFormat) -> StructuredJSON_V2 | StructJSON_V3: if zarr_format == 2: fields_v2 = [ [f_name, f_dtype.to_json(zarr_format=zarr_format)["name"]] for f_name, f_dtype in self.fields ] return {"name": fields_v2, "object_codec_id": None} elif zarr_format == 3: # The "struct" data type has a stable Zarr V3 specification # (https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/struct), # so unlike the legacy "structured" alias it does not emit an unstable-spec warning. fields_v3 = [ {"name": f_name, "data_type": f_dtype.to_json(zarr_format=zarr_format)} for f_name, f_dtype in self.fields ] return cast( "StructJSON_V3", {"name": self._zarr_v3_name, "configuration": {"fields": fields_v3}}, ) raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.void: """ Read a JSON-serializable value as a NumPy structured scalar. Parameters ---------- data : JSON The JSON-serializable value. Can be either: - A dict mapping field names to values (primary format for V3) - A base64-encoded string (legacy format, for backward compatibility) zarr_format : ZarrFormat The zarr format version. Returns ------- np.void The NumPy structured scalar. Raises ------ TypeError If the input is not a dict or base64-encoded string. """ if isinstance(data, dict): field_values = [] for field_name, field_dtype in self.fields: if field_name in data: field_values.append( field_dtype.from_json_scalar(data[field_name], zarr_format=zarr_format) ) else: field_values.append(field_dtype.default_scalar()) return self._cast_scalar_unchecked(tuple(field_values)) elif check_json_str(data): as_bytes = bytes_from_json(data, zarr_format=zarr_format) dtype = self.to_native_dtype() return cast("np.void", np.array([as_bytes]).view(dtype)[0]) raise TypeError(f"Invalid type: {data}. Expected a dict or base64-encoded string.") def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str | dict[str, JSON]: """ Convert a scalar to a JSON-serializable representation. Parameters ---------- data : object The scalar to convert. zarr_format : ZarrFormat The zarr format version. Returns ------- str | dict[str, JSON] For V2: A base64-encoded string of the bytes that make up the scalar. For V3: A dict mapping field names to their JSON-serialized values. """ scalar = self.cast_scalar(data) if zarr_format == 2: return bytes_to_json(scalar.tobytes(), zarr_format) result: dict[str, JSON] = {} for field_name, field_dtype in self.fields: result[field_name] = field_dtype.to_json_scalar( scalar[field_name], zarr_format=zarr_format ) return result zarr-python-3.3.0/src/zarr/core/dtype/npy/time.py000066400000000000000000000703271523267620000217660ustar00rootroot00000000000000from __future__ import annotations from dataclasses import dataclass from datetime import datetime, timedelta from typing import ( TYPE_CHECKING, ClassVar, Literal, Self, TypedDict, TypeGuard, cast, get_args, overload, ) import numpy as np from typing_extensions import ReadOnly from zarr.core.common import NamedRequiredConfig from zarr.core.dtype.common import ( DTypeConfig_V2, DTypeJSON, HasEndianness, HasItemSize, check_dtype_spec_v2, ) from zarr.core.dtype.npy.common import ( DATETIME_UNIT, DateTimeUnit, check_json_int, endianness_to_numpy_str, get_endianness_from_numpy_dtype, ) from zarr.core.dtype.wrapper import TBaseDType, ZDType from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat TimeDeltaLike = str | int | bytes | np.timedelta64 | timedelta | None DateTimeLike = str | int | bytes | np.datetime64 | datetime | None def datetime_from_int(data: int, *, unit: DateTimeUnit, scale_factor: int) -> np.datetime64: """ Convert an integer to a datetime64. Parameters ---------- data : int The integer to convert. unit : DateTimeUnit The unit of the datetime64. scale_factor : int The scale factor of the datetime64. Returns ------- numpy.datetime64 The datetime64 value. """ dtype_name = f"datetime64[{scale_factor}{unit}]" return cast("np.datetime64", np.int64(data).view(dtype_name)) def datetimelike_to_int(data: np.datetime64 | np.timedelta64) -> int: """ Convert a datetime64 or a timedelta64 to an integer. Parameters ---------- data : np.datetime64 | numpy.timedelta64 The value to convert. Returns ------- int An integer representation of the scalar. """ return data.view(np.int64).item() def check_json_time(data: JSON) -> TypeGuard[Literal["NaT"] | int]: """ Type guard to check if the input JSON data is the literal string "NaT" or an integer. """ return check_json_int(data) or data == "NaT" class TimeConfig(TypedDict): """ The configuration for the numpy.timedelta64 or numpy.datetime64 data type in Zarr V3. Attributes ---------- unit : ReadOnly[DateTimeUnit] A string encoding a unit of time. scale_factor : ReadOnly[int] A scale factor. Examples -------- ```python {"unit": "ms", "scale_factor": 1} ``` """ unit: ReadOnly[DateTimeUnit] scale_factor: ReadOnly[int] class DateTime64JSON_V3(NamedRequiredConfig[Literal["numpy.datetime64"], TimeConfig]): """ The JSON representation of the ``numpy.datetime64`` data type in Zarr V3. References ---------- This representation is defined in the ``numpy.datetime64`` [specification document](https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/numpy.datetime64). Examples -------- ```python { "name": "numpy.datetime64", "configuration": { "unit": "ms", "scale_factor": 1 } } ``` """ class TimeDelta64JSON_V3(NamedRequiredConfig[Literal["numpy.timedelta64"], TimeConfig]): """ The JSON representation of the ``TimeDelta64`` data type in Zarr V3. References ---------- This representation is defined in the numpy.timedelta64 [specification document](https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/numpy.timedelta64). Examples -------- ```python { "name": "numpy.timedelta64", "configuration": { "unit": "ms", "scale_factor": 1 } } ``` """ class TimeDelta64JSON_V2(DTypeConfig_V2[str, None]): """ A wrapper around the JSON representation of the ``TimeDelta64`` data type in Zarr V2. The ``name`` field of this class contains the value that would appear under the ``dtype`` field in Zarr V2 array metadata. References ---------- The structure of the ``name`` field is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). Examples -------- ```python { "name": " None: if self.scale_factor < 1: raise ValueError(f"scale_factor must be > 0, got {self.scale_factor}.") if self.scale_factor >= 2**31: raise ValueError(f"scale_factor must be < 2147483648, got {self.scale_factor}.") if self.unit not in get_args(DateTimeUnit): raise ValueError(f"unit must be one of {get_args(DateTimeUnit)}, got {self.unit!r}.") @classmethod def from_native_dtype(cls, dtype: TBaseDType) -> Self: """ Create an instance of this class from a native NumPy data type. Parameters ---------- dtype : TBaseDType The native NumPy dtype to convert. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the dtype is not a valid representation of this class. """ if cls._check_native_dtype(dtype): unit, scale_factor = np.datetime_data(dtype.name) unit = cast("DateTimeUnit", unit) return cls( unit=unit, scale_factor=scale_factor, endianness=get_endianness_from_numpy_dtype(dtype), ) raise DataTypeValidationError( f"Invalid data type: {dtype}. Expected an instance of {cls.dtype_cls}" ) def to_native_dtype(self) -> DType: # Numpy does not allow creating datetime64 or timedelta64 via # np.dtypes.{dtype_name}() # so we use np.dtype with a formatted string. """ Convert this data type to a NumPy temporal data type with the appropriate unit and scale factor. Returns ------- DType A NumPy data type object representing the time data type with the specified unit, scale factor, and byte order. """ dtype_string = f"{self._numpy_name}[{self.scale_factor}{self.unit}]" return np.dtype(dtype_string).newbyteorder(endianness_to_numpy_str(self.endianness)) # type: ignore[return-value] def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> int: """ Convert a python object to a JSON representation of a datetime64 or timedelta64 scalar. Parameters ---------- data : object The python object to convert. zarr_format : ZarrFormat The Zarr format version (2 or 3). Returns ------- int The JSON representation of the scalar. """ return datetimelike_to_int(data) # type: ignore[arg-type] @property def item_size(self) -> int: """ The size of a single scalar in bytes. Returns ------- int The size of a single scalar in bytes. """ return 8 @dataclass(frozen=True, kw_only=True, slots=True) class TimeDelta64(TimeDTypeBase[np.dtypes.TimeDelta64DType, np.timedelta64], HasEndianness): """ A Zarr data type for arrays containing NumPy TimeDelta64 data. Wraps the ``np.dtypesTimeDelta64DType`` data type. Scalars for this data type are instances of `np.timedelta64`. Attributes ---------- dtype_cls : Type[np.dtypesTimeDelta64DType] The NumPy dtype class for this data type. scale_factor : int The scale factor for this data type. unit : DateTimeUnit The unit for this data type. References ---------- The Zarr V2 representation of this data type is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). The Zarr V3 representation of this data type is defined in the ``numpy.timedelta64`` [specification document](https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/numpy.timedelta64) """ # mypy infers the type of np.dtypes.TimeDelta64DType to be # "Callable[[Literal['Y', 'M', 'W', 'D'] | Literal['h', 'm', 's', 'ms', 'us', 'ns', 'ps', 'fs', 'as']], Never]" dtype_cls = np.dtypes.TimeDelta64DType # type: ignore[assignment] unit: DateTimeUnit = "generic" scale_factor: int = 1 _zarr_v3_name: ClassVar[Literal["numpy.timedelta64"]] = "numpy.timedelta64" _zarr_v2_names: ClassVar[tuple[Literal[">m8"], Literal["m8", " TypeGuard[TimeDelta64JSON_V2]: """ Validate that the provided JSON input accurately represents a NumPy timedelta64 data type, which could be in the form of strings like "m8[10s]". This method serves as a type guard, helping to refine the type of unknown JSON input by confirming its adherence to the expected format for NumPy timedelta64 data types. The JSON input should contain a "name" key with a value that matches the expected string pattern for NumPy timedelta64 data types. The pattern includes an optional unit enclosed within square brackets, following the base type identifier. Returns ------- bool True if the JSON input is a valid representation of this class, otherwise False. """ if not check_dtype_spec_v2(data): return False name = data["name"] # match m[M], etc # consider making this a standalone function if not isinstance(name, str): return False if not name.startswith(cls._zarr_v2_names): return False if len(name) == 3: # no unit, and # we already checked that this string is either m8 return True else: return name[4:-1].endswith(DATETIME_UNIT) and name[-1] == "]" @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[DateTime64JSON_V3]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Returns ------- TypeGuard[DateTime64JSON_V3] True if the JSON input is a valid representation of this class, otherwise False. """ return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] == cls._zarr_v3_name and isinstance(data["configuration"], dict) and set(data["configuration"].keys()) == {"unit", "scale_factor"} ) @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create a TimeDelta64 from a Zarr V2-flavored JSON. Parameters ---------- data : DTypeJSON The JSON data. Returns ------- TimeDelta64 An instance of TimeDelta64. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = ( f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a string " f"representation of an instance of {cls.dtype_cls}" ) raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create a TimeDelta64 from a Zarr V3-flavored JSON. The JSON representation of a TimeDelta64 in Zarr V3 is a dict with a 'name' key with the value 'numpy.timedelta64', and a 'configuration' key with a value of a dict with a 'unit' key and a 'scale_factor' key. For example: ```json { "name": "numpy.timedelta64", "configuration": { "unit": "generic", "scale_factor": 1 } } ``` """ if cls._check_json_v3(data): unit = data["configuration"]["unit"] scale_factor = data["configuration"]["scale_factor"] return cls(unit=unit, scale_factor=scale_factor) msg = ( f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a dict " f"with a 'name' key with the value 'numpy.timedelta64', " "and a 'configuration' key with a value of a dict with a 'unit' key and a " "'scale_factor' key" ) raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> TimeDelta64JSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> TimeDelta64JSON_V3: ... def to_json(self, zarr_format: ZarrFormat) -> TimeDelta64JSON_V2 | TimeDelta64JSON_V3: """ Serialize this data type to JSON. Parameters ---------- zarr_format : ZarrFormat The Zarr format version (2 or 3). Returns ------- TimeDelta64JSON_V2 | TimeDelta64JSON_V3 The JSON representation of the data type. Raises ------ ValueError If the zarr_format is not 2 or 3. """ if zarr_format == 2: name = self.to_native_dtype().str return {"name": name, "object_codec_id": None} elif zarr_format == 3: return { "name": self._zarr_v3_name, "configuration": {"unit": self.unit, "scale_factor": self.scale_factor}, } raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[TimeDeltaLike]: """ Check if the input is a scalar of this data type. Parameters ---------- data : object The object to check. Returns ------- TypeGuard[TimeDeltaLike] True if the input is a scalar of this data type, False otherwise. """ if data is None: return True return isinstance(data, str | int | bytes | np.timedelta64 | timedelta) def _cast_scalar_unchecked(self, data: TimeDeltaLike) -> np.timedelta64: """ Cast the provided scalar input to a numpy timedelta64 without any type checking. This method assumes that the input data is already a valid scalar of this data type, and does not perform any validation or type checks. It directly casts the input to a numpy timedelta64 scalar using the unit and scale factor defined in the class. Parameters ---------- data : TimeDeltaLike The scalar input data to cast. Returns ------- numpy.timedelta64 The input data cast as a numpy timedelta64 scalar. """ # numpy 2.x stub: timedelta64(scalar, formatted_unit_str) is runtime-valid # but no overload matches the dynamic f-string unit argument. return self.to_native_dtype().type(data, f"{self.scale_factor}{self.unit}") # type: ignore[call-overload, no-any-return] def cast_scalar(self, data: object) -> np.timedelta64: """ Cast the input to a numpy timedelta64 scalar. If the input is not a scalar of this data type, raise a TypeError. """ if self._check_scalar(data): if isinstance(data, np.timedelta64) and np.isnat(data): # numpy 2.x stub: 'generic' is a runtime-valid unit but not in the Literal overload. return np.timedelta64("NaT", self.unit) # type: ignore[arg-type] return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> np.timedelta64: """ Return a default scalar of this data type. This method provides a default value for the timedelta64 scalar, which is a 'Not-a-Time' (NaT) value. """ # numpy 2.x stub: 'generic' is a runtime-valid unit but not in the Literal overload. return np.timedelta64("NaT", self.unit) # type: ignore[arg-type] def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.timedelta64: """ Create a scalar of this data type from JSON input. Parameters ---------- data : JSON The JSON representation of the scalar value. zarr_format : int The zarr format to use for the JSON representation. Returns ------- numpy.timedelta64 The scalar value of this data type. Raises ------ TypeError If the input JSON is not a valid representation of a scalar for this data type. """ if check_json_time(data): # numpy 2.x stub: timedelta64(scalar, formatted_unit_str) is runtime-valid # but no overload matches the dynamic f-string unit argument. return self.to_native_dtype().type(data, f"{self.scale_factor}{self.unit}") # type: ignore[call-overload, no-any-return] raise TypeError(f"Invalid type: {data}. Expected an integer.") # pragma: no cover @dataclass(frozen=True, kw_only=True, slots=True) class DateTime64(TimeDTypeBase[np.dtypes.DateTime64DType, np.datetime64], HasEndianness): """ A Zarr data type for arrays containing NumPy Datetime64 data. Wraps the ``np.dtypes.TimeDelta64DType`` data type. Scalars for this data type are instances of ``np.datetime64``. Attributes ---------- dtype_cls : Type[np.dtypesTimeDelta64DType] The numpy dtype class for this data type. unit : DateTimeUnit The unit of time for this data type. scale_factor : int The scale factor for the time unit. References ---------- The Zarr V2 representation of this data type is defined in the Zarr V2 [specification document](https://github.com/zarr-developers/zarr-specs/blob/main/docs/v2/v2.0.rst#data-type-encoding). The Zarr V3 representation of this data type is defined in the ``numpy.datetime64`` [specification document](https://github.com/zarr-developers/zarr-extensions/tree/main/data-types/numpy.datetime64) """ dtype_cls = np.dtypes.DateTime64DType # type: ignore[assignment] _zarr_v3_name: ClassVar[Literal["numpy.datetime64"]] = "numpy.datetime64" _zarr_v2_names: ClassVar[tuple[Literal[">M8"], Literal["M8", " TypeGuard[DateTime64JSON_V2]: """ Check that the input is a valid JSON representation of this data type. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[DateTime64JSON_V2] True if the input is a valid JSON representation of a NumPy datetime64 data type, otherwise False. """ if not check_dtype_spec_v2(data): return False name = data["name"] if not isinstance(name, str): return False if not name.startswith(cls._zarr_v2_names): return False if len(name) == 3: # no unit, and # we already checked that this string is either M8 return True else: return name[4:-1].endswith(DATETIME_UNIT) and name[-1] == "]" @classmethod def _check_json_v3(cls, data: DTypeJSON) -> TypeGuard[DateTime64JSON_V3]: """ Check that the input is a valid JSON representation of this class in Zarr V3. Parameters ---------- data : DTypeJSON The JSON data to check. Returns ------- TypeGuard[DateTime64JSON_V3] True if the input is a valid JSON representation of a numpy datetime64 data type in Zarr V3, False otherwise. """ return ( isinstance(data, dict) and set(data.keys()) == {"name", "configuration"} and data["name"] == cls._zarr_v3_name and isinstance(data["configuration"], dict) and set(data["configuration"].keys()) == {"unit", "scale_factor"} ) @classmethod def _from_json_v2(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from a Zarr V2-flavored JSON representation. This method checks if the provided JSON data is a valid representation of this class. If valid, it creates an instance using the native NumPy dtype. Otherwise, it raises a DataTypeValidationError. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v2(data): name = data["name"] return cls.from_native_dtype(np.dtype(name)) msg = ( f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a string " f"representation of an instance of {cls.dtype_cls}" ) raise DataTypeValidationError(msg) @classmethod def _from_json_v3(cls, data: DTypeJSON) -> Self: """ Create an instance of this data type from a Zarr V3-flavored JSON representation. This method checks if the provided JSON data is a valid representation of this class. If valid, it creates an instance using the native NumPy dtype. Otherwise, it raises a DataTypeValidationError. Parameters ---------- data : DTypeJSON The JSON data to parse. Returns ------- Self An instance of this data type. Raises ------ DataTypeValidationError If the input JSON is not a valid representation of this class. """ if cls._check_json_v3(data): unit = data["configuration"]["unit"] scale_factor = data["configuration"]["scale_factor"] return cls(unit=unit, scale_factor=scale_factor) msg = ( f"Invalid JSON representation of {cls.__name__}. Got {data!r}, expected a dict " f"with a 'name' key with the value 'numpy.datetime64', " "and a 'configuration' key with a value of a dict with a 'unit' key and a " "'scale_factor' key" ) raise DataTypeValidationError(msg) @overload def to_json(self, zarr_format: Literal[2]) -> DateTime64JSON_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> DateTime64JSON_V3: ... def to_json(self, zarr_format: ZarrFormat) -> DateTime64JSON_V2 | DateTime64JSON_V3: """ Serialize this data type to JSON. Parameters ---------- zarr_format : ZarrFormat The Zarr format version (2 or 3). Returns ------- DateTime64JSON_V2 | DateTime64JSON_V3 The JSON representation of the data type. Raises ------ ValueError If the zarr_format is not 2 or 3. """ if zarr_format == 2: name = self.to_native_dtype().str return {"name": name, "object_codec_id": None} elif zarr_format == 3: return { "name": self._zarr_v3_name, "configuration": {"unit": self.unit, "scale_factor": self.scale_factor}, } raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def _check_scalar(self, data: object) -> TypeGuard[DateTimeLike]: """ Check if the input is convertible to a scalar of this data type. Parameters ---------- data : object The object to check. Returns ------- TypeGuard[DateTimeLike] True if the input is a scalar of this data type, False otherwise. """ if data is None: return True return isinstance(data, str | int | bytes | np.datetime64 | datetime) def _cast_scalar_unchecked(self, data: DateTimeLike) -> np.datetime64: """ Cast the input to a scalar of this data type without any type checking. Parameters ---------- data : DateTimeLike The scalar data to cast. Returns ------- numpy.datetime64 The input cast to a NumPy datetime scalar. """ # numpy 2.x stub: datetime64(scalar, formatted_unit_str) is runtime-valid # but no overload matches the dynamic f-string unit argument. return self.to_native_dtype().type(data, f"{self.scale_factor}{self.unit}") # type: ignore[call-overload, no-any-return] def cast_scalar(self, data: object) -> np.datetime64: """ Cast the input to a scalar of this data type after a type check. Parameters ---------- data : object The scalar value to cast. Returns ------- numpy.datetime64 The input cast to a NumPy datetime scalar. Raises ------ TypeError If the data cannot be converted to a numpy datetime scalar. """ if self._check_scalar(data): return self._cast_scalar_unchecked(data) msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {self}." ) raise TypeError(msg) def default_scalar(self) -> np.datetime64: """ Return the default scalar value for this data type. Returns ------- numpy.datetime64 The default scalar value, which is a 'Not-a-Time' (NaT) value """ # numpy 2.x stub: 'generic' is a runtime-valid unit but not in the Literal overload. return np.datetime64("NaT", self.unit) # type: ignore[arg-type] def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.datetime64: """ Read a JSON-serializable value as a scalar. Parameters ---------- data : JSON The JSON-serializable value. zarr_format : ZarrFormat The zarr format version. Returns ------- numpy.datetime64 The numpy datetime scalar. Raises ------ TypeError If the input is not a valid integer type. """ if check_json_time(data): return self._cast_scalar_unchecked(data) raise TypeError(f"Invalid type: {data}. Expected an integer.") # pragma: no cover zarr-python-3.3.0/src/zarr/core/dtype/registry.py000066400000000000000000000163621523267620000220710ustar00rootroot00000000000000from __future__ import annotations import contextlib from dataclasses import dataclass, field from typing import TYPE_CHECKING, Self import numpy as np from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from importlib.metadata import EntryPoint from zarr.core.common import ZarrFormat from zarr.core.dtype.common import DTypeJSON from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType # This class is different from the other registry classes, which inherit from # dict. IMO it's simpler to just do a dataclass. But long-term we should # have just 1 registry class in use. @dataclass(frozen=True, kw_only=True) class DataTypeRegistry: """ A registry for ZDType classes. This registry is a mapping from Zarr data type names to their corresponding ZDType classes. Attributes ---------- contents : dict[str, type[ZDType[TBaseDType, TBaseScalar]]] The mapping from Zarr data type names to their corresponding ZDType classes. """ contents: dict[str, type[ZDType[TBaseDType, TBaseScalar]]] = field( default_factory=dict, init=False ) _lazy_load_list: list[EntryPoint] = field(default_factory=list, init=False) def _lazy_load(self) -> None: """ Load all data types from the lazy load list and register them with the registry. After loading, clear the lazy load list. """ for e in self._lazy_load_list: self.register(e.load()._zarr_v3_name, e.load()) self._lazy_load_list.clear() def register(self: Self, key: str, cls: type[ZDType[TBaseDType, TBaseScalar]]) -> None: """ Register a data type with the registry. Parameters ---------- key : str The Zarr V3 name of the data type. cls : type[ZDType[TBaseDType, TBaseScalar]] The class of the data type to register. Notes ----- This method is idempotent. If the data type is already registered, this method does nothing. """ if key not in self.contents or self.contents[key] != cls: self.contents[key] = cls def unregister(self, key: str) -> None: """ Unregister a data type from the registry. Parameters ---------- key : str The key associated with the ZDType class to be unregistered. Returns ------- None Raises ------ KeyError If the data type is not found in the registry. """ if key in self.contents: del self.contents[key] else: raise KeyError(f"Data type '{key}' not found in registry.") def get(self, key: str) -> type[ZDType[TBaseDType, TBaseScalar]]: """ Retrieve a registered ZDType class by its key. Parameters ---------- key : str The key associated with the desired ZDType class. Returns ------- type[ZDType[TBaseDType, TBaseScalar]] The ZDType class registered under the given key. Raises ------ KeyError If the key is not found in the registry. """ return self.contents[key] def match_dtype(self, dtype: TBaseDType) -> ZDType[TBaseDType, TBaseScalar]: """ Match a native data type, e.g. a NumPy data type, to a registered ZDType. Parameters ---------- dtype : TBaseDType The native data type to match. Returns ------- ZDType[TBaseDType, TBaseScalar] The matched ZDType corresponding to the provided NumPy data type. Raises ------ ValueError If the data type is a NumPy "Object" type, which is ambiguous, or if multiple or no Zarr data types are found that match the provided dtype. Notes ----- This function attempts to resolve a Zarr data type from a given native data type. If the dtype is a NumPy "Object" data type, it raises a ValueError, as this type can represent multiple Zarr data types. In such cases, a specific Zarr data type should be explicitly constructed instead of relying on dynamic resolution. If multiple matches are found, it will also raise a ValueError. In this case conflicting data types must be unregistered, or the Zarr data type should be explicitly constructed. """ if dtype == np.dtype("O"): msg = ( f"Zarr data type resolution from {dtype} failed. " 'Attempted to resolve a zarr data type from a numpy "Object" data type, which is ' 'ambiguous, as multiple zarr data types can be represented by the numpy "Object" ' "data type. " "In this case you should construct your array by providing a specific Zarr data " 'type. For a list of Zarr data types that are compatible with the numpy "Object"' "data type, see https://github.com/zarr-developers/zarr-python/issues/3117" ) raise ValueError(msg) matched: list[ZDType[TBaseDType, TBaseScalar]] = [] for val in self.contents.values(): # DataTypeValidationError means "this dtype doesn't match me", which is # expected and suppressed. Other exceptions (e.g. ValueError for a dtype # that matches the type but has an invalid configuration) are propagated # to the caller. with contextlib.suppress(DataTypeValidationError): matched.append(val.from_native_dtype(dtype)) if len(matched) == 1: return matched[0] elif len(matched) > 1: msg = ( f"Zarr data type resolution from {dtype} failed. " f"Multiple data type wrappers found that match dtype '{dtype}': {matched}. " "You should unregister one of these data types, or avoid Zarr data type inference " "entirely by providing a specific Zarr data type when creating your array." "For more information, see https://github.com/zarr-developers/zarr-python/issues/3117" ) raise ValueError(msg) raise ValueError(f"No Zarr data type found that matches dtype '{dtype!r}'") def match_json( self, data: DTypeJSON, *, zarr_format: ZarrFormat ) -> ZDType[TBaseDType, TBaseScalar]: """ Match a JSON representation of a data type to a registered ZDType. Parameters ---------- data : DTypeJSON The JSON representation of a data type to match. zarr_format : ZarrFormat The Zarr format version to consider when matching data types. Returns ------- ZDType[TBaseDType, TBaseScalar] The matched ZDType corresponding to the JSON representation. Raises ------ ValueError If no matching Zarr data type is found for the given JSON data. """ for val in self.contents.values(): try: return val.from_json(data, zarr_format=zarr_format) except DataTypeValidationError: pass raise ValueError(f"No Zarr data type found that matches {data!r}") zarr-python-3.3.0/src/zarr/core/dtype/wrapper.py000066400000000000000000000223131523267620000216720ustar00rootroot00000000000000""" Wrapper for native array data types. The ``ZDType`` class is an abstract base class for wrapping native array data types, e.g. NumPy dtypes. ``ZDType`` provides a common interface for working with data types in a way that is independent of the underlying data type system. The wrapper class encapsulates a native data type. Instances of the class can be created from a native data type instance, and a native data type instance can be created from an instance of the wrapper class. The wrapper class is responsible for: - Serializing and deserializing a native data type to Zarr V2 or Zarr V3 metadata. This ensures that the data type can be properly stored and retrieved from array metadata. - Serializing and deserializing scalar values to Zarr V2 or Zarr V3 metadata. This is important for storing a fill value for an array in a manner that is valid for the data type. You can add support for a new data type in Zarr by subclassing ``ZDType`` wrapper class and adapt its methods to support your native data type. The wrapper class must be added to a data type registry (defined elsewhere) before array creation routines or array reading routines can use your new data type. """ from __future__ import annotations from abc import ABC, abstractmethod from dataclasses import dataclass from typing import ( TYPE_CHECKING, ClassVar, Literal, Self, TypeGuard, overload, ) import numpy as np if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat from zarr.core.dtype.common import DTypeJSON, DTypeSpec_V2, DTypeSpec_V3 # This the upper bound for the scalar types we support. It's numpy scalars + str, # because the new variable-length string dtype in numpy does not have a corresponding scalar type type TBaseScalar = np.generic | str | bytes # This is the bound for the dtypes that we support. If we support non-numpy dtypes, # then this bound will need to be widened. type TBaseDType = np.dtype[np.generic] @dataclass(frozen=True, kw_only=True, slots=True) class ZDType[DType: TBaseDType, Scalar: TBaseScalar](ABC): """ Abstract base class for wrapping native array data types, e.g. numpy dtypes Attributes ---------- dtype_cls : ClassVar[type[TDType]] The wrapped dtype class. This is a class variable. _zarr_v3_name : ClassVar[str] The name given to the data type by a Zarr v3 data type specification. This is a class variable, and it should generally be unique across different data types. """ # this class will create a native data type dtype_cls: ClassVar[type[TBaseDType]] _zarr_v3_name: ClassVar[str] @classmethod def _check_native_dtype(cls: type[Self], dtype: TBaseDType) -> TypeGuard[DType]: """ Check that a native data type matches the dtype_cls class attribute. Used as a type guard. Parameters ---------- dtype : TDType The dtype to check. Returns ------- Bool True if the dtype matches, False otherwise. """ return type(dtype) is cls.dtype_cls @classmethod @abstractmethod def from_native_dtype(cls: type[Self], dtype: TBaseDType) -> Self: """ Create a ZDType instance from a native data type. This method is used when taking a user-provided native data type, like a NumPy data type, and creating the corresponding ZDType instance from them. Parameters ---------- dtype : TDType The native data type object to wrap. Returns ------- Self The ZDType that wraps the native data type. Raises ------ TypeError If the native data type is not consistent with the wrapped data type. """ raise NotImplementedError # pragma: no cover @abstractmethod def to_native_dtype(self: Self) -> DType: """ Return an instance of the wrapped data type. This operation inverts ``from_native_dtype``. Returns ------- TDType The native data type wrapped by this ZDType. """ raise NotImplementedError # pragma: no cover @classmethod @abstractmethod def _from_json_v2(cls: type[Self], data: DTypeJSON) -> Self: raise NotImplementedError # pragma: no cover @classmethod @abstractmethod def _from_json_v3(cls: type[Self], data: DTypeJSON) -> Self: raise NotImplementedError # pragma: no cover @classmethod def from_json(cls: type[Self], data: DTypeJSON, *, zarr_format: ZarrFormat) -> Self: """ Create an instance of this ZDType from JSON data. Parameters ---------- data : DTypeJSON The JSON representation of the data type. zarr_format : ZarrFormat The zarr format version. Returns ------- Self An instance of this data type. """ if zarr_format == 2: return cls._from_json_v2(data) if zarr_format == 3: return cls._from_json_v3(data) raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @overload def to_json(self, zarr_format: Literal[2]) -> DTypeSpec_V2: ... @overload def to_json(self, zarr_format: Literal[3]) -> DTypeSpec_V3: ... @abstractmethod def to_json(self, zarr_format: ZarrFormat) -> DTypeSpec_V2 | DTypeSpec_V3: """ Serialize this ZDType to JSON. Parameters ---------- zarr_format : ZarrFormat The zarr format version. Returns ------- DTypeJSON_V2 | DTypeJSON_V3 The JSON-serializable representation of the wrapped data type """ raise NotImplementedError # pragma: no cover @abstractmethod def _check_scalar(self, data: object) -> bool: """ Check that a python object is a valid scalar value for the wrapped data type. Parameters ---------- data : object A value to check. Returns ------- Bool True if the object is valid, False otherwise. """ raise NotImplementedError # pragma: no cover @abstractmethod def cast_scalar(self, data: object) -> Scalar: """ Cast a python object to the wrapped scalar type. The type of the provided scalar is first checked for compatibility. If it's incompatible with the associated scalar type, a ``TypeError`` will be raised. Parameters ---------- data : object The python object to cast. Returns ------- TScalar The cast value. """ raise NotImplementedError # pragma: no cover @abstractmethod def default_scalar(self) -> Scalar: """ Get the default scalar value for the wrapped data type. This is a method, rather than an attribute, because the default value for some data types depends on parameters that are not known until a concrete data type is wrapped. For example, data types parametrized by a length like fixed-length strings or bytes will generate scalars consistent with that length. Returns ------- TScalar The default value for this data type. """ raise NotImplementedError # pragma: no cover @abstractmethod def from_json_scalar(self: Self, data: JSON, *, zarr_format: ZarrFormat) -> Scalar: """ Read a JSON-serializable value as a scalar. Parameters ---------- data : JSON A JSON representation of a scalar value. zarr_format : ZarrFormat The zarr format version. This is specified because the JSON serialization of scalars differs between Zarr V2 and Zarr V3. Returns ------- TScalar The deserialized scalar value. """ raise NotImplementedError # pragma: no cover @abstractmethod def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> JSON: """ Serialize a python object to the JSON representation of a scalar. The value will first be cast to the scalar type associated with this ZDType, then serialized to JSON. Parameters ---------- data : object The value to convert. zarr_format : ZarrFormat The zarr format version. This is specified because the JSON serialization of scalars differs between Zarr V2 and Zarr V3. Returns ------- JSON The JSON-serialized scalar. """ raise NotImplementedError # pragma: no cover def scalar_failed_type_check_msg( cls_instance: ZDType[TBaseDType, TBaseScalar], bad_scalar: object ) -> str: """ Generate an error message reporting that a particular value failed a type check when attempting to cast that value to a scalar. """ return ( f"The value {bad_scalar!r} failed a type check. " f"It cannot be safely cast to a scalar compatible with {cls_instance}. " f"Consult the documentation for {cls_instance} to determine the possible values that can " "be cast to scalars of the wrapped data type." ) zarr-python-3.3.0/src/zarr/core/group.py000066400000000000000000004264651523267620000202410ustar00rootroot00000000000000from __future__ import annotations import asyncio import itertools import logging import unicodedata import warnings from collections import defaultdict from dataclasses import asdict, dataclass, field, fields, replace from itertools import accumulate from typing import TYPE_CHECKING, Literal, assert_never, cast, overload import numpy as np import numpy.typing as npt import zarr.api.asynchronous as async_api from zarr.abc.metadata import Metadata from zarr.abc.store import Store, set_or_delete from zarr.core._info import GroupInfo from zarr.core._json import buffer_to_json_object, json_to_buffer from zarr.core.array import ( DEFAULT_FILL_VALUE, Array, AsyncArray, CompressorLike, CompressorsLike, FiltersLike, SerializerLike, ShardsLike, _parse_deprecated_compressor, create_array, ) from zarr.core.attributes import Attributes from zarr.core.buffer import default_buffer_prototype from zarr.core.common import ( JSON, ZARR_JSON, ZARRAY_JSON, ZATTRS_JSON, ZGROUP_JSON, ZMETADATA_V2_JSON, ChunksLike, DimensionNamesLike, NodeType, ShapeLike, ZarrFormat, parse_shapelike, ) from zarr.core.config import config from zarr.core.metadata import ArrayV2Metadata, ArrayV3Metadata from zarr.core.metadata.io import save_metadata from zarr.core.sync import SyncMixin, sync from zarr.errors import ( ArrayNotFoundError, ContainsArrayError, ContainsGroupError, GroupNotFoundError, MetadataValidationError, ZarrUserWarning, ) from zarr.storage import StoreLike, StorePath from zarr.storage._common import ensure_no_existing_node, make_store_path from zarr.storage._utils import _join_paths, _normalize_path_keys, normalize_path if TYPE_CHECKING: from collections.abc import ( AsyncGenerator, AsyncIterator, Coroutine, Generator, Iterable, Iterator, Mapping, ) from typing import Any from zarr.core.array_spec import ArrayConfigLike from zarr.core.buffer import Buffer, BufferPrototype from zarr.core.chunk_key_encodings import ChunkKeyEncodingLike from zarr.core.common import MemoryOrder from zarr.core.dtype import ZDTypeLike from zarr.types import AnyArray, AnyAsyncArray, ArrayV2, ArrayV3, AsyncArrayV2, AsyncArrayV3 logger = logging.getLogger("zarr.group") def parse_zarr_format(data: Any) -> ZarrFormat: """Parse the zarr_format field from metadata.""" if data in (2, 3): return cast("ZarrFormat", data) msg = f"Invalid zarr_format. Expected one of 2 or 3. Got {data}." raise ValueError(msg) def parse_node_type(data: Any) -> NodeType: """Parse the node_type field from metadata.""" if data in ("array", "group"): return cast("Literal['array', 'group']", data) msg = f"Invalid value for 'node_type'. Expected 'array' or 'group'. Got '{data}'." raise MetadataValidationError(msg) # todo: convert None to empty dict def parse_attributes(data: Any) -> dict[str, Any]: """Parse the attributes field from metadata.""" if data is None: return {} elif isinstance(data, dict) and all(isinstance(k, str) for k in data): return dict(data) msg = f"Expected dict with string keys. Got {type(data)} instead." raise TypeError(msg) @overload def _parse_async_node(node: AsyncArrayV3) -> ArrayV3: ... @overload def _parse_async_node(node: AsyncArrayV2) -> ArrayV2: ... @overload def _parse_async_node(node: AsyncGroup) -> Group: ... def _parse_async_node( node: AnyAsyncArray | AsyncGroup, ) -> AnyArray | Group: """Wrap an AsyncArray in an Array, or an AsyncGroup in a Group.""" if isinstance(node, AsyncArray): return Array(node) elif isinstance(node, AsyncGroup): return Group(node) else: raise TypeError(f"Unknown node type, got {type(node)}") @dataclass(frozen=True) class ConsolidatedMetadata: """ Consolidated Metadata for this Group. This stores the metadata of child nodes below this group. Any child groups will have their consolidated metadata set appropriately. """ metadata: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata] kind: Literal["inline"] = "inline" must_understand: Literal[False] = False def to_dict(self) -> dict[str, JSON]: return { "kind": self.kind, "must_understand": self.must_understand, "metadata": { k: v.to_dict() for k, v in sorted( self.flattened_metadata.items(), key=lambda item: ( item[0].count("/"), unicodedata.normalize("NFKC", item[0]).casefold(), ), ) }, } @classmethod def from_dict(cls, data: dict[str, JSON]) -> ConsolidatedMetadata: data = dict(data) kind = data.get("kind") if kind != "inline": raise ValueError(f"Consolidated metadata kind='{kind}' is not supported.") raw_metadata = data.get("metadata") if not isinstance(raw_metadata, dict): raise TypeError(f"Unexpected type for 'metadata': {type(raw_metadata)}") metadata: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata] = {} if raw_metadata: for k, v in raw_metadata.items(): if not isinstance(v, dict): raise TypeError( f"Invalid value for metadata items. key='{k}', type='{type(v).__name__}'" ) # zarr_format is present in v2 and v3. zarr_format = parse_zarr_format(v["zarr_format"]) if zarr_format == 3: node_type = parse_node_type(v.get("node_type", None)) if node_type == "group": metadata[k] = GroupMetadata.from_dict(v) elif node_type == "array": metadata[k] = ArrayV3Metadata.from_dict(v) else: assert_never(node_type) elif zarr_format == 2: if "shape" in v: metadata[k] = ArrayV2Metadata.from_dict(v) else: metadata[k] = GroupMetadata.from_dict(v) else: assert_never(zarr_format) cls._flat_to_nested(metadata) return cls(metadata=metadata) @staticmethod def _flat_to_nested( metadata: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata], ) -> None: """ Convert a flat metadata representation to a nested one. Notes ----- Flat metadata is used when persisting the consolidated metadata. The keys include the full path, not just the node name. The key prefixes can be used to determine which nodes are children of which other nodes. Nested metadata is used in-memory. The outermost level will only have the *immediate* children of the Group. All nested child groups will be stored under the consolidated metadata of their immediate parent. """ # We have a flat mapping from {k: v} where the keys include the *full* # path segment: # { # "/a/b": { group_metadata }, # "/a/b/array-0": { array_metadata }, # "/a/b/array-1": { array_metadata }, # } # # We want to reorganize the metadata such that each Group contains the # array metadata of its immediate children. # In the example, the group at `/a/b` will have consolidated metadata # for its children `array-0` and `array-1`. keys = sorted(metadata, key=lambda k: k.count("/")) grouped = { k: list(v) for k, v in itertools.groupby(keys, key=lambda k: k.rsplit("/", 1)[0]) } # we go top down and directly manipulate metadata. for key, children_keys in grouped.items(): # key is a key like "a", "a/b", "a/b/c" # The basic idea is to find the immediate parent (so "", "a", or "a/b") # and update that node's consolidated metadata to include the metadata # in children_keys *prefixes, name = key.split("/") parent = metadata while prefixes: # e.g. a/b/c has a parent "a/b". Walk through to get # metadata["a"]["b"] part = prefixes.pop(0) # we can assume that parent[part] here is a group # otherwise we wouldn't have a node with this `part` prefix. # We can also assume that the parent node will have consolidated metadata, # because we're walking top to bottom. parent = parent[part].consolidated_metadata.metadata # type: ignore[union-attr] node = parent[name] children_keys = list(children_keys) if isinstance(node, ArrayV2Metadata | ArrayV3Metadata): # These are already present, either thanks to being an array in the # root, or by being collected as a child in the else clause continue children: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata] = {} # We pop from metadata, since we're *moving* this under group. # While doing this, normalize leaf groups to carry empty consolidated metadata. for child_key in children_keys: if child_key == key: continue child = metadata.pop(child_key) if isinstance(child, GroupMetadata) and child.consolidated_metadata is None: child = replace(child, consolidated_metadata=ConsolidatedMetadata(metadata={})) children[child_key.split("/")[-1]] = child parent[name] = replace( node, consolidated_metadata=ConsolidatedMetadata(metadata=children) ) @property def flattened_metadata(self) -> dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata]: """ Return the flattened representation of Consolidated Metadata. The returned dictionary will have a key for each child node in the hierarchy under this group. Under the default (nested) representation available through ``self.metadata``, the dictionary only contains keys for immediate children. The keys of the dictionary will include the full path to a child node from the current group, where segments are joined by ``/``. Examples -------- ```python from zarr.core.group import ConsolidatedMetadata, GroupMetadata cm = ConsolidatedMetadata( metadata={ "group-0": GroupMetadata( consolidated_metadata=ConsolidatedMetadata( { "group-0-0": GroupMetadata(), } ) ), "group-1": GroupMetadata(), } ) # {'group-0': GroupMetadata(attributes={}, zarr_format=3, consolidated_metadata=None, node_type='group'), # 'group-0/group-0-0': GroupMetadata(attributes={}, zarr_format=3, consolidated_metadata=None, node_type='group'), # 'group-1': GroupMetadata(attributes={}, zarr_format=3, consolidated_metadata=None, node_type='group')} ``` """ metadata = {} def flatten( key: str, group: GroupMetadata | ArrayV2Metadata | ArrayV3Metadata ) -> dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata]: children: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata] = {} if isinstance(group, ArrayV2Metadata | ArrayV3Metadata): children[key] = group else: if group.consolidated_metadata and group.consolidated_metadata.metadata is not None: children[key] = replace( group, consolidated_metadata=ConsolidatedMetadata(metadata={}) ) for name, val in group.consolidated_metadata.metadata.items(): full_key = f"{key}/{name}" if isinstance(val, GroupMetadata): children.update(flatten(full_key, val)) else: children[full_key] = val else: children[key] = replace(group, consolidated_metadata=None) return children for k, v in self.metadata.items(): metadata.update(flatten(k, v)) return metadata @dataclass(frozen=True) class GroupMetadata(Metadata): """ Metadata for a Group. """ attributes: dict[str, Any] = field(default_factory=dict) zarr_format: ZarrFormat = 3 consolidated_metadata: ConsolidatedMetadata | None = None node_type: Literal["group"] = field(default="group", init=False) def to_buffer_dict(self, prototype: BufferPrototype) -> dict[str, Buffer]: indent = config.get("json_indent") if self.zarr_format == 3: return {ZARR_JSON: json_to_buffer(self.to_dict(), prototype=prototype, indent=indent)} else: items = { ZGROUP_JSON: json_to_buffer( {"zarr_format": self.zarr_format}, prototype=prototype, indent=indent ), ZATTRS_JSON: json_to_buffer(self.attributes, prototype=prototype, indent=indent), } if self.consolidated_metadata: d = { ZGROUP_JSON: {"zarr_format": self.zarr_format}, ZATTRS_JSON: self.attributes, } consolidated_metadata = self.consolidated_metadata.to_dict()["metadata"] assert isinstance(consolidated_metadata, dict) for k, v in consolidated_metadata.items(): attrs = v.pop("attributes", {}) d[f"{k}/{ZATTRS_JSON}"] = attrs if "shape" in v: # it's an array d[f"{k}/{ZARRAY_JSON}"] = v else: d[f"{k}/{ZGROUP_JSON}"] = { "zarr_format": self.zarr_format, "consolidated_metadata": { "metadata": {}, "must_understand": False, "kind": "inline", }, } # The consolidated metadata blob is written compactly (no indent). items[ZMETADATA_V2_JSON] = json_to_buffer( {"metadata": d, "zarr_consolidated_format": 1}, prototype=prototype ) return items def __init__( self, attributes: dict[str, Any] | None = None, zarr_format: ZarrFormat = 3, consolidated_metadata: ConsolidatedMetadata | None = None, ) -> None: attributes_parsed = parse_attributes(attributes) zarr_format_parsed = parse_zarr_format(zarr_format) object.__setattr__(self, "attributes", attributes_parsed) object.__setattr__(self, "zarr_format", zarr_format_parsed) object.__setattr__(self, "consolidated_metadata", consolidated_metadata) @classmethod def from_dict(cls, data: dict[str, Any]) -> GroupMetadata: data = dict(data) assert data.pop("node_type", None) in ("group", None) consolidated_metadata = data.pop("consolidated_metadata", None) if consolidated_metadata: data["consolidated_metadata"] = ConsolidatedMetadata.from_dict(consolidated_metadata) zarr_format = data.get("zarr_format") if zarr_format == 2 or zarr_format is None: # zarr v2 allowed arbitrary keys here. # We don't want the GroupMetadata constructor to fail just because someone put an # extra key in the metadata. expected = {x.name for x in fields(cls)} data = {k: v for k, v in data.items() if k in expected} return cls(**data) def to_dict(self) -> dict[str, Any]: result = asdict(replace(self, consolidated_metadata=None)) if self.consolidated_metadata is not None: result["consolidated_metadata"] = self.consolidated_metadata.to_dict() else: # Leave consolidated metadata unset if it's None result.pop("consolidated_metadata") return result @dataclass(frozen=True) class ImplicitGroupMarker(GroupMetadata): """ Marker for an implicit group. Instances of this class are only used in the context of group creation as a placeholder to represent groups that should only be created if they do not already exist in storage """ @dataclass(frozen=True) class AsyncGroup: """ Asynchronous Group object. """ metadata: GroupMetadata store_path: StorePath # TODO: make this correct and work # TODO: ensure that this can be bound properly to subclass of AsyncGroup @classmethod async def from_store( cls, store: StoreLike, *, attributes: dict[str, Any] | None = None, overwrite: bool = False, zarr_format: ZarrFormat = 3, ) -> AsyncGroup: store_path = await make_store_path(store) if overwrite: if store_path.store.supports_deletes: await store_path.delete_dir() else: await ensure_no_existing_node(store_path, zarr_format=zarr_format) else: await ensure_no_existing_node(store_path, zarr_format=zarr_format) attributes = attributes or {} group = cls( metadata=GroupMetadata(attributes=attributes, zarr_format=zarr_format), store_path=store_path, ) await group._save_metadata(ensure_parents=True) return group @classmethod async def open( cls, store: StoreLike, zarr_format: ZarrFormat | None = 3, use_consolidated: bool | str | None = None, ) -> AsyncGroup: """Open a new AsyncGroup Parameters ---------- store : StoreLike zarr_format : {2, 3}, optional use_consolidated : bool or str, default None Whether to use consolidated metadata. By default, consolidated metadata is used if it's present in the store (in the ``zarr.json`` for Zarr format 3 and in the ``.zmetadata`` file for Zarr format 2) and the Store supports it. To explicitly require consolidated metadata, set ``use_consolidated=True``. In this case, if the Store doesn't support consolidation or consolidated metadata is not found, a ``ValueError`` exception is raised. To explicitly *not* use consolidated metadata, set ``use_consolidated=False``, which will fall back to using the regular, non consolidated metadata. Zarr format 2 allowed configuring the key storing the consolidated metadata (``.zmetadata`` by default). Specify the custom key as ``use_consolidated`` to load consolidated metadata from a non-default key. """ store_path = await make_store_path(store) if not store_path.store.supports_consolidated_metadata: # Fail if consolidated metadata was requested but the Store doesn't support it if use_consolidated: store_name = type(store_path.store).__name__ raise ValueError( f"The Zarr store in use ({store_name}) doesn't support consolidated metadata." ) # if use_consolidated was None (optional), the Store dictates it doesn't want consolidation use_consolidated = False consolidated_key = ZMETADATA_V2_JSON if (zarr_format == 2 or zarr_format is None) and isinstance(use_consolidated, str): consolidated_key = use_consolidated if zarr_format == 2: paths = [store_path / ZGROUP_JSON, store_path / ZATTRS_JSON] if use_consolidated or use_consolidated is None: paths.append(store_path / consolidated_key) zgroup_bytes, zattrs_bytes, *rest = await asyncio.gather( *[path.get() for path in paths] ) if zgroup_bytes is None: raise FileNotFoundError(store_path) if use_consolidated or use_consolidated is None: maybe_consolidated_metadata_bytes = rest[0] else: maybe_consolidated_metadata_bytes = None elif zarr_format == 3: zarr_json_bytes = await (store_path / ZARR_JSON).get() if zarr_json_bytes is None: raise FileNotFoundError(store_path) elif zarr_format is None: ( zarr_json_bytes, zgroup_bytes, zattrs_bytes, maybe_consolidated_metadata_bytes, ) = await asyncio.gather( (store_path / ZARR_JSON).get(), (store_path / ZGROUP_JSON).get(), (store_path / ZATTRS_JSON).get(), (store_path / str(consolidated_key)).get(), ) if zarr_json_bytes is not None and zgroup_bytes is not None: # warn and favor v3 msg = f"Both zarr.json (Zarr format 3) and .zgroup (Zarr format 2) metadata objects exist at {store_path}. Zarr format 3 will be used." warnings.warn(msg, category=ZarrUserWarning, stacklevel=1) if zarr_json_bytes is None and zgroup_bytes is None: raise FileNotFoundError( f"could not find zarr.json or .zgroup objects in {store_path}" ) # set zarr_format based on which keys were found if zarr_json_bytes is not None: zarr_format = 3 else: zarr_format = 2 else: msg = f"Invalid value for 'zarr_format'. Expected 2, 3, or None. Got '{zarr_format}'." # type: ignore[unreachable] raise MetadataValidationError(msg) if zarr_format == 2: # this is checked above, asserting here for mypy assert zgroup_bytes is not None if use_consolidated and maybe_consolidated_metadata_bytes is None: # the user requested consolidated metadata, but it was missing raise ValueError(consolidated_key) elif use_consolidated is False: # the user explicitly opted out of consolidated_metadata. # Discard anything we might have read. maybe_consolidated_metadata_bytes = None return cls._from_bytes_v2( store_path, zgroup_bytes, zattrs_bytes, maybe_consolidated_metadata_bytes ) else: # V3 groups are comprised of a zarr.json object assert zarr_json_bytes is not None if not isinstance(use_consolidated, bool | None): raise TypeError("use_consolidated must be a bool or None for Zarr format 3.") return cls._from_bytes_v3( store_path, zarr_json_bytes, use_consolidated=use_consolidated, ) @classmethod def _from_bytes_v2( cls, store_path: StorePath, zgroup_bytes: Buffer, zattrs_bytes: Buffer | None, consolidated_metadata_bytes: Buffer | None, ) -> AsyncGroup: # V2 groups are comprised of a .zgroup and .zattrs objects zgroup = buffer_to_json_object(zgroup_bytes) zattrs = buffer_to_json_object(zattrs_bytes) if zattrs_bytes is not None else {} group_metadata: dict[str, Any] = {**zgroup, "attributes": zattrs} if consolidated_metadata_bytes is not None: v2_consolidated_doc = buffer_to_json_object(consolidated_metadata_bytes) v2_consolidated_metadata = cast("dict[str, Any]", v2_consolidated_doc["metadata"]) # We already read zattrs and zgroup. Should we ignore these? v2_consolidated_metadata.pop(".zattrs", None) v2_consolidated_metadata.pop(".zgroup", None) consolidated_metadata: defaultdict[str, dict[str, Any]] = defaultdict(dict) # keys like air/.zarray, air/.zattrs for k, v in v2_consolidated_metadata.items(): path, kind = k.rsplit("/.", 1) if kind == "zarray": consolidated_metadata[path].update(v) elif kind == "zattrs": consolidated_metadata[path]["attributes"] = v elif kind == "zgroup": consolidated_metadata[path].update(v) else: raise ValueError(f"Invalid file type '{kind}' at path '{path}") group_metadata["consolidated_metadata"] = { "metadata": dict(consolidated_metadata), "kind": "inline", "must_understand": False, } return cls.from_dict(store_path, group_metadata) @classmethod def _from_bytes_v3( cls, store_path: StorePath, zarr_json_bytes: Buffer, use_consolidated: bool | None, ) -> AsyncGroup: group_metadata = buffer_to_json_object(zarr_json_bytes) if use_consolidated and group_metadata.get("consolidated_metadata") is None: msg = f"Consolidated metadata requested with 'use_consolidated=True' but not found in '{store_path.path}'." raise ValueError(msg) elif use_consolidated is False: # Drop consolidated metadata if it's there. group_metadata.pop("consolidated_metadata", None) return cls.from_dict(store_path, group_metadata) @classmethod def from_dict( cls, store_path: StorePath, data: dict[str, Any], ) -> AsyncGroup: node_type = data.pop("node_type", None) if node_type == "array": msg = f"An array already exists in store {store_path.store} at path {store_path.path}." raise ContainsArrayError(msg) elif node_type not in ("group", None): msg = f"Node type in metadata ({node_type}) is not 'group'" raise GroupNotFoundError(msg) return cls( metadata=GroupMetadata.from_dict(data), store_path=store_path, ) async def setitem(self, key: str, value: Any) -> None: """ Fastpath for creating a new array New arrays will be created with default array settings for the array type. Parameters ---------- key : str Array name value : array-like Array data """ path = self.store_path / key await async_api.save_array( store=path, arr=value, zarr_format=self.metadata.zarr_format, overwrite=True ) async def getitem( self, key: str, ) -> AnyAsyncArray | AsyncGroup: """ Get a subarray or subgroup from the group. Parameters ---------- key : str Array or group name Returns ------- AsyncArray or AsyncGroup """ store_path = self.store_path / key logger.debug("key=%s, store_path=%s", key, store_path) # Consolidated metadata lets us avoid some I/O operations so try that first. if self.metadata.consolidated_metadata is not None: return self._getitem_consolidated(store_path, key, prefix=self.name) try: return await get_node( store=store_path.store, path=store_path.path, zarr_format=self.metadata.zarr_format ) except FileNotFoundError as e: raise KeyError(key) from e def _getitem_consolidated( self, store_path: StorePath, key: str, prefix: str ) -> AnyAsyncArray | AsyncGroup: # getitem, in the special case where we have consolidated metadata. # Note that this is a regular def (non async) function. # This shouldn't do any additional I/O. # the caller needs to verify this! assert self.metadata.consolidated_metadata is not None # we support nested getitems like group/subgroup/array indexers = normalize_path(key).split("/") indexers.reverse() metadata: ArrayV2Metadata | ArrayV3Metadata | GroupMetadata = self.metadata while indexers: indexer = indexers.pop() if isinstance(metadata, ArrayV2Metadata | ArrayV3Metadata): # we've indexed into an array with group["array/subarray"]. Invalid. raise KeyError(key) if metadata.consolidated_metadata is None: # we've indexed into a group without consolidated metadata. # This isn't normal; typically, consolidated metadata # will include explicit markers for when there are no child # nodes as metadata={}. # We have some freedom in exactly how we interpret this case. # For now, we treat None as the same as {}, i.e. we don't # have any children. raise KeyError(key) try: metadata = metadata.consolidated_metadata.metadata[indexer] except KeyError as e: # The Group Metadata has consolidated metadata, but the key # isn't present. We trust this to mean that the key isn't in # the hierarchy, and *don't* fall back to checking the store. msg = f"'{key}' not found in consolidated metadata." raise KeyError(msg) from e # update store_path to ensure that AsyncArray/Group.name is correct if prefix != "/": key = "/".join([prefix.lstrip("/"), key]) store_path = StorePath(store=store_path.store, path=key) if isinstance(metadata, GroupMetadata): return AsyncGroup(metadata=metadata, store_path=store_path) else: return AsyncArray(metadata=metadata, store_path=store_path) async def delitem(self, key: str) -> None: """Delete a group member. Parameters ---------- key : str Array or group name """ store_path = self.store_path / key await store_path.delete_dir() if self.metadata.consolidated_metadata: self.metadata.consolidated_metadata.metadata.pop(key, None) await self._save_metadata() async def get[DefaultT]( self, key: str, default: DefaultT | None = None ) -> AnyAsyncArray | AsyncGroup | DefaultT | None: """Obtain a group member, returning default if not found. Parameters ---------- key : str Group member name. default : object Default value to return if key is not found (default: None). Returns ------- object Group member (AsyncArray or AsyncGroup) or default if not found. """ try: return await self.getitem(key) except KeyError: return default async def get_array(self, path: str) -> AnyAsyncArray: """Obtain an array member of this group, raising if it is absent or not an array. Parameters ---------- path : str Path of the array relative to this group. May contain `/` to reference a member of a subgroup, e.g. `subgroup/subarray`. Returns ------- AsyncArray The array at the given path. Raises ------ ArrayNotFoundError If no node exists at the given path. ContainsGroupError If the node at the given path is a group rather than an array. """ store_path = self.store_path / path try: node = await self.getitem(path) except KeyError as e: msg = f"No array found in store {store_path.store!r} at path {store_path.path!r}" raise ArrayNotFoundError(msg) from e if isinstance(node, AsyncGroup): msg = f"A group exists in store {store_path.store!r} at path {store_path.path!r}." raise ContainsGroupError(msg) return node async def get_group(self, path: str) -> AsyncGroup: """Obtain a group member of this group, raising if it is absent or not a group. Parameters ---------- path : str Path of the group relative to this group. May contain `/` to reference a member of a subgroup, e.g. `subgroup/subsubgroup`. Returns ------- AsyncGroup The group at the given path. Raises ------ GroupNotFoundError If no node exists at the given path. ContainsArrayError If the node at the given path is an array rather than a group. """ store_path = self.store_path / path try: node = await self.getitem(path) except KeyError as e: msg = f"No group found in store {store_path.store!r} at path {store_path.path!r}" raise GroupNotFoundError(msg) from e if isinstance(node, AsyncArray): msg = f"An array exists in store {store_path.store!r} at path {store_path.path!r}." raise ContainsArrayError(msg) return node async def _save_metadata(self, ensure_parents: bool = False) -> None: await save_metadata(self.store_path, self.metadata, ensure_parents=ensure_parents) @property def path(self) -> str: """Storage path.""" return self.store_path.path @property def name(self) -> str: """Group name following h5py convention.""" if self.path: # follow h5py convention: add leading slash name = self.path if name[0] != "/": name = f"/{name}" return name return "/" @property def basename(self) -> str: """Final component of name.""" return self.name.split("/")[-1] @property def attrs(self) -> dict[str, Any]: return self.metadata.attributes @property def info(self) -> Any: """ Return a visual representation of the statically known information about a group. Note that this doesn't include dynamic information, like the number of child Groups or Arrays. Returns ------- GroupInfo Related ------- [zarr.AsyncGroup.info_complete][] All information about a group, including dynamic information """ if self.metadata.consolidated_metadata: members = list(self.metadata.consolidated_metadata.flattened_metadata.values()) else: members = None return self._info(members=members) async def info_complete(self) -> Any: """ Return all the information for a group. This includes dynamic information like the number of child Groups or Arrays. If this group doesn't contain consolidated metadata then this will need to read from the backing Store. Returns ------- GroupInfo Related ------- [zarr.AsyncGroup.info][] """ members = [x[1].metadata async for x in self.members(max_depth=None)] return self._info(members=members) def _info( self, members: list[ArrayV2Metadata | ArrayV3Metadata | GroupMetadata] | None = None ) -> Any: kwargs = {} if members is not None: kwargs["_count_members"] = len(members) count_arrays = 0 count_groups = 0 for member in members: if isinstance(member, GroupMetadata): count_groups += 1 else: count_arrays += 1 kwargs["_count_arrays"] = count_arrays kwargs["_count_groups"] = count_groups return GroupInfo( _name=self.store_path.path, _read_only=self.read_only, _store_type=type(self.store_path.store).__name__, _zarr_format=self.metadata.zarr_format, # maybe do a typeddict **kwargs, # type: ignore[arg-type] ) @property def store(self) -> Store: return self.store_path.store @property def read_only(self) -> bool: # Backwards compatibility for 2.x return self.store_path.read_only @property def synchronizer(self) -> None: # Backwards compatibility for 2.x # Not implemented in 3.x yet. return None async def create_group( self, name: str, *, overwrite: bool = False, attributes: dict[str, Any] | None = None, ) -> AsyncGroup: """Create a sub-group. Parameters ---------- name : str Group name. overwrite : bool, optional If True, do not raise an error if the group already exists. attributes : dict, optional Group attributes. Returns ------- g : AsyncGroup """ attributes = attributes or {} return await type(self).from_store( self.store_path / name, attributes=attributes, overwrite=overwrite, zarr_format=self.metadata.zarr_format, ) async def require_group(self, name: str, overwrite: bool = False) -> AsyncGroup: """Obtain a sub-group, creating one if it doesn't exist. Parameters ---------- name : str Group name. overwrite : bool, optional Overwrite any existing group with given `name` if present. Returns ------- g : AsyncGroup """ if overwrite: # TODO: check that overwrite=True errors if an array exists where the group is being created grp = await self.create_group(name, overwrite=True) else: try: item: AsyncGroup | AnyAsyncArray = await self.getitem(name) if not isinstance(item, AsyncGroup): raise TypeError( f"Incompatible object ({item.__class__.__name__}) already exists" ) assert isinstance(item, AsyncGroup) # make mypy happy grp = item except KeyError: grp = await self.create_group(name) return grp async def require_groups(self, *names: str) -> tuple[AsyncGroup, ...]: """Convenience method to require multiple groups in a single call. Parameters ---------- *names : str Group names. Returns ------- Tuple[AsyncGroup, ...] """ if not names: return () return tuple(await asyncio.gather(*(self.require_group(name) for name in names))) async def create_array( self, name: str, *, shape: ShapeLike | None = None, dtype: ZDTypeLike | None = None, data: np.ndarray[Any, np.dtype[Any]] | None = None, chunks: ChunksLike | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", compressor: CompressorLike = "auto", serializer: SerializerLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, write_data: bool = True, ) -> AnyAsyncArray: """Create an array within this group. This method lightly wraps [zarr.core.array.create_array][]. Parameters ---------- name : str The name of the array relative to the group. If ``path`` is ``None``, the array will be located at the root of the store. shape : tuple[int, ...] Shape of the array. dtype : npt.DTypeLike Data type of the array. chunks : tuple[int, ...], optional Chunk shape of the array. If not specified, default are guessed based on the shape and dtype. shards : tuple[int, ...], optional Shard shape of the array. The default value of ``None`` results in no sharding at all. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec], optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. If no ``compressors`` are provided, a default set of compressors will be used. These defaults can be changed by modifying the value of ``array.v3_default_compressors`` in [`zarr.config`][zarr.config]. Use ``None`` to omit default compressors. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no ``compressor`` is provided, a default compressor will be used. in [`zarr.config`][zarr.config]. Use ``None`` to omit the default compressor. compressor : Codec, optional Deprecated in favor of ``compressors``. serializer : dict[str, JSON] | ArrayBytesCodec, optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no ``serializer`` is provided, a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][zarr.config]. fill_value : Any, optional Fill value for the array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If no ``order`` is provided, a default order will be used. This default can be changed by modifying the value of ``array.order`` in [`zarr.config`][zarr.config]. attributes : dict, optional Attributes for the array. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. dimension_names : Iterable[str], optional The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. config : ArrayConfig or ArrayConfigLike, optional Runtime configuration for the array. write_data : bool If a pre-existing array-like object was provided to this function via the ``data`` parameter then ``write_data`` determines whether the values in that array-like object should be written to the Zarr array created by this function. If ``write_data`` is ``False``, then the array will be left empty. Returns ------- AsyncArray """ compressors = _parse_deprecated_compressor( compressor, compressors, zarr_format=self.metadata.zarr_format ) return await create_array( store=self.store_path, name=name, shape=shape, dtype=dtype, data=data, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=self.metadata.zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, storage_options=storage_options, overwrite=overwrite, config=config, write_data=write_data, ) async def require_array( self, name: str, *, shape: ShapeLike, dtype: npt.DTypeLike | None = None, exact: bool = False, **kwargs: Any, ) -> AnyAsyncArray: """Obtain an array, creating if it doesn't exist. Other `kwargs` are as per [zarr.AsyncGroup.create_array][]. Parameters ---------- name : str Array name. shape : int or tuple of ints Array shape. dtype : str or dtype, optional NumPy dtype. exact : bool, optional If True, require `dtype` to match exactly. If false, require `dtype` can be cast from array dtype. Returns ------- a : AsyncArray """ try: ds = await self.getitem(name) if not isinstance(ds, AsyncArray): raise TypeError(f"Incompatible object ({ds.__class__.__name__}) already exists") shape = parse_shapelike(shape) if shape != ds.shape: raise TypeError(f"Incompatible shape ({ds.shape} vs {shape})") dtype = np.dtype(dtype) if exact: if ds.dtype != dtype: raise TypeError(f"Incompatible dtype ({ds.dtype} vs {dtype})") else: if not np.can_cast(ds.dtype, dtype): raise TypeError(f"Incompatible dtype ({ds.dtype} vs {dtype})") except KeyError: ds = await self.create_array(name, shape=shape, dtype=dtype, **kwargs) return ds async def update_attributes(self, new_attributes: dict[str, Any]) -> AsyncGroup: """Update group attributes. Parameters ---------- new_attributes : dict New attributes to set on the group. Returns ------- self : AsyncGroup """ self.metadata.attributes.update(new_attributes) # Write new metadata await self._save_metadata() return self def __repr__(self) -> str: return f"" async def nmembers( self, max_depth: int | None = 0, ) -> int: """Count the number of members in this group. Parameters ---------- max_depth : int, default 0 The maximum number of levels of the hierarchy to include. By default, (``max_depth=0``) only immediate children are included. Set ``max_depth=None`` to include all nodes, and some positive integer to consider children within that many levels of the root Group. Returns ------- count : int """ # check if we can use consolidated metadata, which requires that we have non-None # consolidated metadata at all points in the hierarchy. if self.metadata.consolidated_metadata is not None: if max_depth is not None and max_depth < 0: raise ValueError(f"max_depth must be None or >= 0. Got '{max_depth}' instead") if max_depth is None: return len(self.metadata.consolidated_metadata.flattened_metadata) else: return len( [ x for x in self.metadata.consolidated_metadata.flattened_metadata if x.count("/") <= max_depth ] ) # TODO: consider using aioitertools.builtins.sum for this # return await aioitertools.builtins.sum((1 async for _ in self.members()), start=0) n = 0 async for _ in self.members(max_depth=max_depth): n += 1 return n async def members( self, max_depth: int | None = 0, *, use_consolidated_for_children: bool = True, ) -> AsyncGenerator[ tuple[str, AnyAsyncArray | AsyncGroup], None, ]: """ Returns an AsyncGenerator over the arrays and groups contained in this group. This method requires that `store_path.store` supports directory listing. The results are not guaranteed to be ordered. Parameters ---------- max_depth : int, default 0 The maximum number of levels of the hierarchy to include. By default, (``max_depth=0``) only immediate children are included. Set ``max_depth=None`` to include all nodes, and some positive integer to consider children within that many levels of the root Group. use_consolidated_for_children : bool, default True Whether to use the consolidated metadata of child groups loaded from the store. Note that this only affects groups loaded from the store. If the current Group already has consolidated metadata, it will always be used. Returns ------- path: A string giving the path to the target, relative to the Group ``self``. value: AsyncArray or AsyncGroup The AsyncArray or AsyncGroup that is a child of ``self``. """ if max_depth is not None and max_depth < 0: raise ValueError(f"max_depth must be None or >= 0. Got '{max_depth}' instead") async for item in self._members( max_depth=max_depth, use_consolidated_for_children=use_consolidated_for_children ): yield item def _members_consolidated( self, max_depth: int | None, prefix: str = "" ) -> Generator[ tuple[str, AnyAsyncArray | AsyncGroup], None, ]: consolidated_metadata = self.metadata.consolidated_metadata do_recursion = max_depth is None or max_depth > 0 # we kind of just want the top-level keys. if consolidated_metadata is not None: for key in consolidated_metadata.metadata: obj = self._getitem_consolidated( self.store_path, key, prefix=self.name ) # Metadata -> Group/Array key = f"{prefix}/{key}".lstrip("/") yield key, obj if do_recursion and isinstance(obj, AsyncGroup): if max_depth is None: new_depth = None else: new_depth = max_depth - 1 yield from obj._members_consolidated(new_depth, prefix=key) async def _members( self, max_depth: int | None, *, use_consolidated_for_children: bool = True ) -> AsyncGenerator[tuple[str, AnyAsyncArray | AsyncGroup], None]: skip_keys: tuple[str, ...] if self.metadata.zarr_format == 2: skip_keys = (".zattrs", ".zgroup", ".zarray", ".zmetadata") elif self.metadata.zarr_format == 3: skip_keys = ("zarr.json",) else: raise ValueError(f"Unknown Zarr format: {self.metadata.zarr_format}") if self.metadata.consolidated_metadata is not None: members = self._members_consolidated(max_depth=max_depth) for member in members: yield member return if not self.store_path.store.supports_listing: msg = ( f"The store associated with this group ({type(self.store_path.store)}) " "does not support listing, " "specifically via the `list_dir` method. " "This function requires a store that supports listing." ) raise ValueError(msg) # enforce a concurrency limit by passing a semaphore to all the recursive functions semaphore = asyncio.Semaphore(config.get("async.concurrency")) async for member in _iter_members_deep( self, max_depth=max_depth, skip_keys=skip_keys, semaphore=semaphore, use_consolidated_for_children=use_consolidated_for_children, ): yield member async def create_hierarchy( self, nodes: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata], *, overwrite: bool = False, ) -> AsyncIterator[tuple[str, AsyncGroup | AnyAsyncArray]]: """ Create a hierarchy of arrays or groups rooted at this group. This function will parse its input to ensure that the hierarchy is complete. Any implicit groups will be inserted as needed. For example, an input like ```{'a/b': GroupMetadata}``` will be parsed to ```{'': GroupMetadata, 'a': GroupMetadata, 'b': Groupmetadata}```. Explicitly specifying a root group, e.g. with ``nodes = {'': GroupMetadata()}`` is an error because this group instance is the root group. After input parsing, this function then creates all the nodes in the hierarchy concurrently. Arrays and Groups are yielded in the order they are created. This order is not stable and should not be relied on. Parameters ---------- nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, relative to the path of the group. The values are instances of ``GroupMetadata`` or ``ArrayMetadata``. Note that all values must have the same ``zarr_format`` as the parent group -- it is an error to mix zarr versions in the same hierarchy. Leading "/" characters from keys will be removed. overwrite : bool Whether to overwrite existing nodes. Defaults to ``False``, in which case an error is raised instead of overwriting an existing array or group. This function will not erase an existing group unless that group is explicitly named in ``nodes``. If ``nodes`` defines implicit groups, e.g. ``{`'a/b/c': GroupMetadata}``, and a group already exists at path ``a``, then this function will leave the group at ``a`` as-is. Yields ------ tuple[str, AsyncArray | AsyncGroup]. """ # check that all the nodes have the same zarr_format as Self prefix = self.path nodes_parsed = {} for key, value in nodes.items(): if value.zarr_format != self.metadata.zarr_format: msg = ( "The zarr_format of the nodes must be the same as the parent group. " f"The node at {key} has zarr_format {value.zarr_format}, but the parent group" f" has zarr_format {self.metadata.zarr_format}." ) raise ValueError(msg) if normalize_path(key) == "": msg = ( "The input defines a root node, but a root node already exists, namely this Group instance." "It is an error to use this method to create a root node. " "Remove the root node from the input dict, or use a function like " "create_rooted_hierarchy to create a rooted hierarchy." ) raise ValueError(msg) else: nodes_parsed[_join_paths([prefix, key])] = value async for key, node in create_hierarchy( store=self.store, nodes=nodes_parsed, overwrite=overwrite, ): if prefix == "": out_key = key else: out_key = key.removeprefix(prefix + "/") yield out_key, node async def keys(self) -> AsyncGenerator[str, None]: """Iterate over member names.""" async for key, _ in self.members(): yield key async def contains(self, member: str) -> bool: """Check if a member exists in the group. Parameters ---------- member : str Member name. Returns ------- bool """ # TODO: this can be made more efficient. try: await self.getitem(member) except KeyError: return False else: return True async def groups(self) -> AsyncGenerator[tuple[str, AsyncGroup], None]: """Iterate over subgroups.""" async for name, value in self.members(): if isinstance(value, AsyncGroup): yield name, value async def group_keys(self) -> AsyncGenerator[str, None]: """Iterate over group names.""" async for key, _ in self.groups(): yield key async def group_values(self) -> AsyncGenerator[AsyncGroup, None]: """Iterate over group values.""" async for _, group in self.groups(): yield group async def arrays( self, ) -> AsyncGenerator[tuple[str, AnyAsyncArray], None]: """Iterate over arrays.""" async for key, value in self.members(): if isinstance(value, AsyncArray): yield key, value async def array_keys(self) -> AsyncGenerator[str, None]: """Iterate over array names.""" async for key, _ in self.arrays(): yield key async def array_values( self, ) -> AsyncGenerator[AnyAsyncArray, None]: """Iterate over array values.""" async for _, array in self.arrays(): yield array async def tree( self, expand: bool | None = None, level: int | None = None, *, max_nodes: int = 500, plain: bool = False, ) -> Any: """ Return a tree-like representation of a hierarchy. Parameters ---------- expand : bool, optional This keyword is not yet supported. A NotImplementedError is raised if it's used. level : int, optional The maximum depth below this Group to display in the tree. max_nodes : int Maximum number of nodes to display before truncating. Default is 500. plain : bool, optional If True, return a plain-text tree without ANSI styling. This is useful when the output will be consumed by an LLM or written to a file. Default is False. Returns ------- TreeRepr A pretty-printable object displaying the hierarchy. """ from zarr.core._tree import group_tree_async if expand is not None: raise NotImplementedError("'expand' is not yet implemented.") return await group_tree_async(self, max_depth=level, max_nodes=max_nodes, plain=plain) async def empty(self, *, name: str, shape: tuple[int, ...], **kwargs: Any) -> AnyAsyncArray: """Create an empty array with the specified shape in this Group. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ return await async_api.empty(shape=shape, store=self.store_path, path=name, **kwargs) async def zeros(self, *, name: str, shape: tuple[int, ...], **kwargs: Any) -> AnyAsyncArray: """Create an array, with zero being used as the default value for uninitialized portions of the array. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.zeros(shape=shape, store=self.store_path, path=name, **kwargs) async def ones(self, *, name: str, shape: tuple[int, ...], **kwargs: Any) -> AnyAsyncArray: """Create an array, with one being used as the default value for uninitialized portions of the array. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.ones(shape=shape, store=self.store_path, path=name, **kwargs) async def full( self, *, name: str, shape: tuple[int, ...], fill_value: Any | None, **kwargs: Any ) -> AnyAsyncArray: """Create an array, with "fill_value" being used as the default value for uninitialized portions of the array. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. fill_value : scalar Value to fill the array with. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.full( shape=shape, fill_value=fill_value, store=self.store_path, path=name, **kwargs, ) async def empty_like( self, *, name: str, data: async_api.ArrayLike, **kwargs: Any ) -> AnyAsyncArray: """Create an empty sub-array like `data`. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- name : str Name of the array. data : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.empty_like(a=data, store=self.store_path, path=name, **kwargs) async def zeros_like( self, *, name: str, data: async_api.ArrayLike, **kwargs: Any ) -> AnyAsyncArray: """Create a sub-array of zeros like `data`. Parameters ---------- name : str Name of the array. data : array-like The array to create the new array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.zeros_like(a=data, store=self.store_path, path=name, **kwargs) async def ones_like( self, *, name: str, data: async_api.ArrayLike, **kwargs: Any ) -> AnyAsyncArray: """Create a sub-array of ones like `data`. Parameters ---------- name : str Name of the array. data : array-like The array to create the new array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.ones_like(a=data, store=self.store_path, path=name, **kwargs) async def full_like( self, *, name: str, data: async_api.ArrayLike, **kwargs: Any ) -> AnyAsyncArray: """Create a sub-array like `data` filled with the `fill_value` of `data` . Parameters ---------- name : str Name of the array. data : array-like The array to create the new array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- AsyncArray The new array. """ return await async_api.full_like(a=data, store=self.store_path, path=name, **kwargs) async def move(self, source: str, dest: str) -> None: """Move a sub-group or sub-array from one path to another. Notes ----- Not implemented """ raise NotImplementedError @dataclass(frozen=True) class Group(SyncMixin): """ A Zarr group. """ _async_group: AsyncGroup @classmethod def from_store( cls, store: StoreLike, *, attributes: dict[str, Any] | None = None, zarr_format: ZarrFormat = 3, overwrite: bool = False, ) -> Group: """Instantiate a group from an initialized store. Parameters ---------- store : StoreLike StoreLike containing the Group. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. attributes : dict, optional A dictionary of JSON-serializable values with user-defined attributes. zarr_format : {2, 3}, optional Zarr storage format version. overwrite : bool, optional If True, do not raise an error if the group already exists. Returns ------- Group Group instantiated from the store. Raises ------ ContainsArrayError, ContainsGroupError, ContainsArrayAndGroupError """ attributes = attributes or {} obj = sync( AsyncGroup.from_store( store, attributes=attributes, overwrite=overwrite, zarr_format=zarr_format, ), ) return cls(obj) @classmethod def open( cls, store: StoreLike, zarr_format: ZarrFormat | None = 3, ) -> Group: """Open a group from an initialized store. Parameters ---------- store : StoreLike Store containing the Group. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. zarr_format : {2, 3, None}, optional Zarr storage format version. Returns ------- Group Group instantiated from the store. """ obj = sync(AsyncGroup.open(store, zarr_format=zarr_format)) return cls(obj) def __getitem__(self, path: str) -> AnyArray | Group: """Obtain a group member. Parameters ---------- path : str Group member name. Returns ------- Array | Group Group member (Array or Group) at the specified key Examples -------- ```python import zarr from zarr.core.group import Group group = Group.from_store(zarr.storage.MemoryStore()) group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="float64") group.create_group(name="subgroup").create_array(name="subarray", shape=(10,), chunks=(10,), dtype="float64") group["subarray"] # group["subgroup"] # group["subgroup"]["subarray"] # ``` """ obj = self._sync(self._async_group.getitem(path)) if isinstance(obj, AsyncArray): return Array(obj) else: return Group(obj) def get[DefaultT]( self, path: str, default: DefaultT | None = None ) -> AnyArray | Group | DefaultT | None: """Obtain a group member, returning default if not found. Parameters ---------- path : str Group member name. default : object Default value to return if key is not found (default: None). Returns ------- object Group member (Array or Group) or default if not found. Examples -------- ```python import zarr from zarr.core.group import Group group = Group.from_store(zarr.storage.MemoryStore()) group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="float64") group.create_group(name="subgroup") group.get("subarray") # group.get("subgroup") # group.get("nonexistent", None) # None ``` """ try: return self[path] except KeyError: return default def get_array(self, path: str) -> AnyArray: """Obtain an array member of this group, raising if it is absent or not an array. Parameters ---------- path : str Path of the array relative to this group. May contain `/` to reference a member of a subgroup, e.g. `subgroup/subarray`. Returns ------- Array The array at the given path. Raises ------ ArrayNotFoundError If no node exists at the given path. ContainsGroupError If the node at the given path is a group rather than an array. Examples -------- ```python import zarr from zarr.core.group import Group group = Group.from_store(zarr.storage.MemoryStore()) group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="float64") group.get_array("subarray") # ``` """ return Array(self._sync(self._async_group.get_array(path))) def get_group(self, path: str) -> Group: """Obtain a group member of this group, raising if it is absent or not a group. Parameters ---------- path : str Path of the group relative to this group. May contain `/` to reference a member of a subgroup, e.g. `subgroup/subsubgroup`. Returns ------- Group The group at the given path. Raises ------ GroupNotFoundError If no node exists at the given path. ContainsArrayError If the node at the given path is an array rather than a group. Examples -------- ```python import zarr from zarr.core.group import Group group = Group.from_store(zarr.storage.MemoryStore()) group.create_group(name="subgroup") group.get_group("subgroup") # ``` """ return Group(self._sync(self._async_group.get_group(path))) def __delitem__(self, key: str) -> None: """Delete a group member. Parameters ---------- key : str Group member name. Examples -------- >>> import zarr >>> group = Group.from_store(zarr.storage.MemoryStore()) >>> a = group.create_array(name="subarray", dtype="i1", shape=(10,), chunks=(10,)) >>> del group["subarray"] >>> "subarray" in group False """ self._sync(self._async_group.delitem(key)) def __iter__(self) -> Iterator[str]: """Return an iterator over group member names. Examples -------- >>> import zarr >>> g1 = zarr.group() >>> g2 = g1.create_group('foo') >>> g3 = g1.create_group('bar') >>> d1 = g1.create_array('baz', dtype="i1", shape=(10,), chunks=(10,)) >>> d2 = g1.create_array('quux', dtype="i1", shape=(10,), chunks=(10,)) >>> sorted(g1) ['bar', 'baz', 'foo', 'quux'] """ yield from self.keys() def __len__(self) -> int: """Number of members.""" return self.nmembers() def __setitem__(self, key: str, value: Any) -> None: """Fastpath for creating a new array. New arrays will be created using default settings for the array type. If you need to create an array with custom settings, use the `create_array` method. Parameters ---------- key : str Array name. value : Any Array data. Examples -------- >>> import numpy as np >>> import zarr >>> group = zarr.group() >>> group["foo"] = np.array(zarr.zeros((10,))) >>> group["foo"] """ self._sync(self._async_group.setitem(key, value)) def __repr__(self) -> str: return f"" async def update_attributes_async(self, new_attributes: dict[str, Any]) -> Group: """Update the attributes of this group. Examples -------- >>> async def example(): ... import zarr ... ... group = zarr.group() ... new_group = await group.update_attributes_async({"foo": "bar"}) ... return new_group.attrs.asdict() >>> import asyncio >>> asyncio.run(example()) {'foo': 'bar'} """ new_metadata = replace(self.metadata, attributes=new_attributes) # Write new metadata to_save = new_metadata.to_buffer_dict(default_buffer_prototype()) awaitables = [set_or_delete(self.store_path / key, value) for key, value in to_save.items()] await asyncio.gather(*awaitables) async_group = replace(self._async_group, metadata=new_metadata) return replace(self, _async_group=async_group) @property def store_path(self) -> StorePath: """Path-like interface for the Store.""" return self._async_group.store_path @property def metadata(self) -> GroupMetadata: """Group metadata.""" return self._async_group.metadata @property def path(self) -> str: """Storage path.""" return self._async_group.path @property def name(self) -> str: """Group name following h5py convention.""" return self._async_group.name @property def basename(self) -> str: """Final component of name.""" return self._async_group.basename @property def attrs(self) -> Attributes: """Attributes of this Group""" return Attributes(self) @property def info(self) -> Any: """ Return the statically known information for a group. Returns ------- GroupInfo Related ------- [zarr.Group.info_complete][] All information about a group, including dynamic information like the children members. """ return self._async_group.info def info_complete(self) -> Any: """ Return information for a group. If this group doesn't contain consolidated metadata then this will need to read from the backing Store. Returns ------- GroupInfo Related ------- [zarr.Group.info][] """ return self._sync(self._async_group.info_complete()) @property def store(self) -> Store: # Backwards compatibility for 2.x return self._async_group.store @property def read_only(self) -> bool: # Backwards compatibility for 2.x return self._async_group.read_only @property def synchronizer(self) -> None: # Backwards compatibility for 2.x # Not implemented in 3.x yet. return self._async_group.synchronizer def update_attributes(self, new_attributes: dict[str, Any]) -> Group: """Update the attributes of this group. Examples -------- >>> import zarr >>> group = zarr.group().update_attributes({"foo": "bar"}) >>> group.attrs.asdict() {'foo': 'bar'} """ self._sync(self._async_group.update_attributes(new_attributes)) return self def nmembers(self, max_depth: int | None = 0) -> int: """Count the number of members in this group. Parameters ---------- max_depth : int, default 0 The maximum number of levels of the hierarchy to include. By default, (``max_depth=0``) only immediate children are included. Set ``max_depth=None`` to include all nodes, and some positive integer to consider children within that many levels of the root Group. Returns ------- count : int """ return self._sync(self._async_group.nmembers(max_depth=max_depth)) def members( self, max_depth: int | None = 0, *, use_consolidated_for_children: bool = True ) -> tuple[tuple[str, AnyArray | Group], ...]: """ Returns an AsyncGenerator over the arrays and groups contained in this group. This method requires that `store_path.store` supports directory listing. The results are not guaranteed to be ordered. Parameters ---------- max_depth : int, default 0 The maximum number of levels of the hierarchy to include. By default, (``max_depth=0``) only immediate children are included. Set ``max_depth=None`` to include all nodes, and some positive integer to consider children within that many levels of the root Group. use_consolidated_for_children : bool, default True Whether to use the consolidated metadata of child groups loaded from the store. Note that this only affects groups loaded from the store. If the current Group already has consolidated metadata, it will always be used. Returns ------- path: A string giving the path to the target, relative to the Group ``self``. value: AsyncArray or AsyncGroup The AsyncArray or AsyncGroup that is a child of ``self``. """ _members = self._sync_iter(self._async_group.members(max_depth=max_depth)) return tuple((kv[0], _parse_async_node(kv[1])) for kv in _members) def create_hierarchy( self, nodes: dict[str, ArrayV2Metadata | ArrayV3Metadata | GroupMetadata], *, overwrite: bool = False, ) -> Iterator[tuple[str, Group | AnyArray]]: """ Create a hierarchy of arrays or groups rooted at this group. This function will parse its input to ensure that the hierarchy is complete. Any implicit groups will be inserted as needed. For example, an input like ```{'a/b': GroupMetadata}``` will be parsed to ```{'': GroupMetadata, 'a': GroupMetadata, 'b': Groupmetadata}```. Explicitly specifying a root group, e.g. with ``nodes = {'': GroupMetadata()}`` is an error because this group instance is the root group. After input parsing, this function then creates all the nodes in the hierarchy concurrently. Arrays and Groups are yielded in the order they are created. This order is not stable and should not be relied on. Parameters ---------- nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, relative to the path of the group. The values are instances of ``GroupMetadata`` or ``ArrayMetadata``. Note that all values must have the same ``zarr_format`` as the parent group -- it is an error to mix zarr versions in the same hierarchy. Leading "/" characters from keys will be removed. overwrite : bool Whether to overwrite existing nodes. Defaults to ``False``, in which case an error is raised instead of overwriting an existing array or group. This function will not erase an existing group unless that group is explicitly named in ``nodes``. If ``nodes`` defines implicit groups, e.g. ``{`'a/b/c': GroupMetadata}``, and a group already exists at path ``a``, then this function will leave the group at ``a`` as-is. Yields ------ tuple[str, Array | Group]. Examples -------- >>> import zarr >>> from zarr.core.group import GroupMetadata >>> root = zarr.create_group(store={}) >>> sorted(root.create_hierarchy({'a/b/c': GroupMetadata()})) [('a', ), ('a/b', ), ('a/b/c', )] """ for key, node in self._sync_iter( self._async_group.create_hierarchy(nodes, overwrite=overwrite) ): yield (key, _parse_async_node(node)) def keys(self) -> Generator[str]: """Return an iterator over group member names. Examples -------- >>> import zarr >>> g1 = zarr.group() >>> g2 = g1.create_group('foo') >>> g3 = g1.create_group('bar') >>> d1 = g1.create_array('baz', dtype="i1", shape=(10,), chunks=(10,)) >>> d2 = g1.create_array('quux', dtype="i1", shape=(10,), chunks=(10,)) >>> sorted(g1.keys()) ['bar', 'baz', 'foo', 'quux'] """ yield from self._sync_iter(self._async_group.keys()) def __contains__(self, member: str) -> bool: """Test for group membership. Examples -------- >>> import zarr >>> g1 = zarr.group() >>> g2 = g1.create_group('foo') >>> d1 = g1.create_array('bar', dtype="i1", shape=(10,), chunks=(10,)) >>> 'foo' in g1 True >>> 'bar' in g1 True >>> 'baz' in g1 False """ return self._sync(self._async_group.contains(member)) def groups(self) -> Generator[tuple[str, Group], None]: """Return the sub-groups of this group as a generator of (name, group) pairs. Examples -------- >>> import zarr >>> group = zarr.group() >>> subgroup = group.create_group("subgroup") >>> list(group.groups()) [('subgroup', )] """ for name, async_group in self._sync_iter(self._async_group.groups()): yield name, Group(async_group) def group_keys(self) -> Generator[str, None]: """Return an iterator over group member names. Examples -------- >>> import zarr >>> group = zarr.group() >>> subgroup = group.create_group("subgroup") >>> list(group.group_keys()) ['subgroup'] """ for name, _ in self.groups(): yield name def group_values(self) -> Generator[Group, None]: """Return an iterator over group members. Examples -------- >>> import zarr >>> group = zarr.group() >>> subgroup = group.create_group("subgroup") >>> list(group.group_values()) [] """ for _, group in self.groups(): yield group def arrays(self) -> Generator[tuple[str, AnyArray], None]: """Return the sub-arrays of this group as a generator of (name, array) pairs Examples -------- >>> import zarr >>> group = zarr.group() >>> subarray = group.create_array("subarray", dtype="i1", shape=(10,), chunks=(10,)) >>> list(group.arrays()) [('subarray', )] """ for name, async_array in self._sync_iter(self._async_group.arrays()): yield name, Array(async_array) def array_keys(self) -> Generator[str, None]: """Return an iterator over group member names. Examples -------- >>> import zarr >>> group = zarr.group() >>> subarray = group.create_array("subarray", dtype="i1", shape=(10,), chunks=(10,)) >>> list(group.array_keys()) ['subarray'] """ for name, _ in self.arrays(): yield name def array_values(self) -> Generator[AnyArray, None]: """Return an iterator over group members. Examples -------- >>> import zarr >>> group = zarr.group() >>> subarray = group.create_array("subarray", dtype="i1", shape=(10,), chunks=(10,)) >>> list(group.array_values()) [] """ for _, array in self.arrays(): yield array def tree( self, expand: bool | None = None, level: int | None = None, *, max_nodes: int = 500, plain: bool = False, ) -> Any: """ Return a tree-like representation of a hierarchy. Parameters ---------- expand : bool, optional This keyword is not yet supported. A NotImplementedError is raised if it's used. level : int, optional The maximum depth below this Group to display in the tree. max_nodes : int Maximum number of nodes to display before truncating. Default is 500. plain : bool, optional If True, return a plain-text tree without ANSI styling. This is useful when the output will be consumed by an LLM or written to a file. Default is False. Returns ------- TreeRepr A pretty-printable object displaying the hierarchy. """ return self._sync( self._async_group.tree(expand=expand, level=level, max_nodes=max_nodes, plain=plain) ) def create_group(self, name: str, **kwargs: Any) -> Group: """Create a sub-group. Parameters ---------- name : str Name of the new subgroup. Returns ------- Group Examples -------- >>> import zarr >>> group = zarr.group() >>> subgroup = group.create_group("subgroup") >>> subgroup """ return Group(self._sync(self._async_group.create_group(name, **kwargs))) def require_group(self, name: str, **kwargs: Any) -> Group: """Obtain a sub-group, creating one if it doesn't exist. Parameters ---------- name : str Group name. Returns ------- g : Group """ return Group(self._sync(self._async_group.require_group(name, **kwargs))) def require_groups(self, *names: str) -> tuple[Group, ...]: """Convenience method to require multiple groups in a single call. Parameters ---------- *names : str Group names. Returns ------- groups : tuple of Groups """ return tuple(map(Group, self._sync(self._async_group.require_groups(*names)))) def create( self, name: str, *, shape: ShapeLike | None = None, dtype: ZDTypeLike | None = None, data: np.ndarray[Any, np.dtype[Any]] | None = None, chunks: ChunksLike | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", compressor: CompressorLike = "auto", serializer: SerializerLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, write_data: bool = True, ) -> AnyArray: """Create an array within this group. This method lightly wraps [`zarr.core.array.create_array`][]. Parameters ---------- name : str The name of the array relative to the group. If ``path`` is ``None``, the array will be located at the root of the store. shape : ShapeLike, optional Shape of the array. Must be ``None`` if ``data`` is provided. dtype : npt.DTypeLike | None Data type of the array. Must be ``None`` if ``data`` is provided. data : Array-like data to use for initializing the array. If this parameter is provided, the ``shape`` and ``dtype`` parameters must be ``None``. chunks : tuple[int, ...], optional Chunk shape of the array. If not specified, default are guessed based on the shape and dtype. shards : tuple[int, ...], optional Shard shape of the array. The default value of ``None`` results in no sharding at all. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec], optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. If no ``compressors`` are provided, a default set of compressors will be used. These defaults can be changed by modifying the value of ``array.v3_default_compressors`` in [`zarr.config`][]. Use ``None`` to omit default compressors. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no ``compressor`` is provided, a default compressor will be used. in [`zarr.config`][]. Use ``None`` to omit the default compressor. compressor : Codec, optional Deprecated in favor of ``compressors``. serializer : dict[str, JSON] | ArrayBytesCodec, optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no ``serializer`` is provided, a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][]. fill_value : Any, optional Fill value for the array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If no ``order`` is provided, a default order will be used. This default can be changed by modifying the value of ``array.order`` in [`zarr.config`][]. attributes : dict, optional Attributes for the array. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. dimension_names : Iterable[str], optional The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. config : ArrayConfig or ArrayConfigLike, optional Runtime configuration for the array. write_data : bool If a pre-existing array-like object was provided to this function via the ``data`` parameter then ``write_data`` determines whether the values in that array-like object should be written to the Zarr array created by this function. If ``write_data`` is ``False``, then the array will be left empty. Returns ------- AsyncArray """ return self.create_array( name, shape=shape, dtype=dtype, data=data, chunks=chunks, shards=shards, filters=filters, compressors=compressors, compressor=compressor, serializer=serializer, fill_value=fill_value, order=order, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, storage_options=storage_options, overwrite=overwrite, config=config, write_data=write_data, ) def create_array( self, name: str, *, shape: ShapeLike | None = None, dtype: ZDTypeLike | None = None, data: np.ndarray[Any, np.dtype[Any]] | None = None, chunks: ChunksLike | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", compressor: CompressorLike = "auto", serializer: SerializerLike = "auto", fill_value: Any | None = DEFAULT_FILL_VALUE, order: MemoryOrder | None = None, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, storage_options: dict[str, Any] | None = None, overwrite: bool = False, config: ArrayConfigLike | None = None, write_data: bool = True, ) -> AnyArray: """Create an array within this group. This method lightly wraps [zarr.core.array.create_array][]. Parameters ---------- name : str The name of the array relative to the group. If ``path`` is ``None``, the array will be located at the root of the store. shape : ShapeLike, optional Shape of the array. Must be ``None`` if ``data`` is provided. dtype : npt.DTypeLike | None Data type of the array. Must be ``None`` if ``data`` is provided. data : Array-like data to use for initializing the array. If this parameter is provided, the ``shape`` and ``dtype`` parameters must be ``None``. chunks : tuple[int, ...], optional Chunk shape of the array. If not specified, default are guessed based on the shape and dtype. shards : tuple[int, ...], optional Shard shape of the array. The default value of ``None`` results in no sharding at all. filters : Iterable[Codec] | Literal["auto"], optional Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes. For Zarr format 3, a "filter" is a codec that takes an array and returns an array, and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a dict representations of [`zarr.abc.codec.ArrayArrayCodec`][]. For Zarr format 2, a "filter" can be any numcodecs codec; you should ensure that the order of your filters is consistent with the behavior of each filter. The default value of ``"auto"`` instructs Zarr to use a default based on the data type of the array and the Zarr format specified. For all data types in Zarr V3, and most data types in Zarr V2, the default filters are empty. The only cases where default filters are not empty is when the Zarr format is 2, and the data type is a variable-length data type like [`zarr.dtype.VariableLengthUTF8`][] or [`zarr.dtype.VariableLengthUTF8`][]. In these cases, the default filters contains a single element which is a codec specific to that particular data type. To create an array with no filters, provide an empty iterable or the value ``None``. compressors : Iterable[Codec], optional List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes. For Zarr format 3, a "compressor" is a codec that takes a bytestream, and returns another bytestream. Multiple compressors may be provided for Zarr format 3. If no ``compressors`` are provided, a default set of compressors will be used. These defaults can be changed by modifying the value of ``array.v3_default_compressors`` in [`zarr.config`][zarr.config]. Use ``None`` to omit default compressors. For Zarr format 2, a "compressor" can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no ``compressor`` is provided, a default compressor will be used. in [`zarr.config`][zarr.config]. Use ``None`` to omit the default compressor. compressor : Codec, optional Deprecated in favor of ``compressors``. serializer : dict[str, JSON] | ArrayBytesCodec, optional Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no ``serializer`` is provided, a default serializer will be used. These defaults can be changed by modifying the value of ``array.v3_default_serializer`` in [`zarr.config`][zarr.config]. fill_value : Any, optional Fill value for the array. order : {"C", "F"}, optional The memory order of the array (default is "C"). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the ``config`` parameter, e.g. ``{'config': 'C'}``. If no ``order`` is provided, a default order will be used. This default can be changed by modifying the value of ``array.order`` in [`zarr.config`][zarr.config]. attributes : dict, optional Attributes for the array. chunk_key_encoding : ChunkKeyEncoding, optional A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is ``{"name": "default", "separator": "/"}}``. For Zarr format 2, the default is ``{"name": "v2", "separator": "."}}``. dimension_names : Iterable[str], optional The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter. storage_options : dict, optional If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. overwrite : bool, default False Whether to overwrite an array with the same name in the store, if one exists. config : ArrayConfig or ArrayConfigLike, optional Runtime configuration for the array. write_data : bool If a pre-existing array-like object was provided to this function via the ``data`` parameter then ``write_data`` determines whether the values in that array-like object should be written to the Zarr array created by this function. If ``write_data`` is ``False``, then the array will be left empty. Returns ------- AsyncArray """ compressors = _parse_deprecated_compressor( compressor, compressors, zarr_format=self.metadata.zarr_format ) return Array( self._sync( self._async_group.create_array( name=name, shape=shape, dtype=dtype, data=data, chunks=chunks, shards=shards, fill_value=fill_value, attributes=attributes, chunk_key_encoding=chunk_key_encoding, compressors=compressors, serializer=serializer, dimension_names=dimension_names, order=order, filters=filters, overwrite=overwrite, storage_options=storage_options, config=config, write_data=write_data, ) ) ) def require_array(self, name: str, *, shape: ShapeLike, **kwargs: Any) -> AnyArray: """Obtain an array, creating if it doesn't exist. Other `kwargs` are as per [zarr.Group.create_array][]. Parameters ---------- name : str Array name. **kwargs : See [zarr.Group.create_array][]. Returns ------- a : Array """ return Array(self._sync(self._async_group.require_array(name, shape=shape, **kwargs))) def empty(self, *, name: str, shape: tuple[int, ...], **kwargs: Any) -> AnyArray: """Create an empty array with the specified shape in this Group. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ return Array(self._sync(self._async_group.empty(name=name, shape=shape, **kwargs))) def zeros(self, *, name: str, shape: tuple[int, ...], **kwargs: Any) -> AnyArray: """Create an array, with zero being used as the default value for uninitialized portions of the array. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. """ return Array(self._sync(self._async_group.zeros(name=name, shape=shape, **kwargs))) def ones(self, *, name: str, shape: tuple[int, ...], **kwargs: Any) -> AnyArray: """Create an array, with one being used as the default value for uninitialized portions of the array. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. """ return Array(self._sync(self._async_group.ones(name=name, shape=shape, **kwargs))) def full( self, *, name: str, shape: tuple[int, ...], fill_value: Any | None, **kwargs: Any ) -> AnyArray: """Create an array, with "fill_value" being used as the default value for uninitialized portions of the array. Parameters ---------- name : str Name of the array. shape : int or tuple of int Shape of the empty array. fill_value : scalar Value to fill the array with. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. """ return Array( self._sync( self._async_group.full(name=name, shape=shape, fill_value=fill_value, **kwargs) ) ) def empty_like(self, *, name: str, data: async_api.ArrayLike, **kwargs: Any) -> AnyArray: """Create an empty sub-array like `data`. The contents will be filled with the array's fill value or zeros if no fill value is provided. Parameters ---------- name : str Name of the array. data : array-like The array to create an empty array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. Notes ----- The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next. """ return Array(self._sync(self._async_group.empty_like(name=name, data=data, **kwargs))) def zeros_like(self, *, name: str, data: async_api.ArrayLike, **kwargs: Any) -> AnyArray: """Create a sub-array of zeros like `data`. Parameters ---------- name : str Name of the array. data : array-like The array to create the new array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. """ return Array(self._sync(self._async_group.zeros_like(name=name, data=data, **kwargs))) def ones_like(self, *, name: str, data: async_api.ArrayLike, **kwargs: Any) -> AnyArray: """Create a sub-array of ones like `data`. Parameters ---------- name : str Name of the array. data : array-like The array to create the new array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. """ return Array(self._sync(self._async_group.ones_like(name=name, data=data, **kwargs))) def full_like(self, *, name: str, data: async_api.ArrayLike, **kwargs: Any) -> AnyArray: """Create a sub-array like `data` filled with the `fill_value` of `data` . Parameters ---------- name : str Name of the array. data : array-like The array to create the new array like. **kwargs Keyword arguments passed to [zarr.api.asynchronous.create][]. Returns ------- Array The new array. """ return Array(self._sync(self._async_group.full_like(name=name, data=data, **kwargs))) def move(self, source: str, dest: str) -> None: """Move a sub-group or sub-array from one path to another. Notes ----- Not implemented """ return self._sync(self._async_group.move(source, dest)) async def create_hierarchy( *, store: Store, nodes: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], overwrite: bool = False, ) -> AsyncIterator[tuple[str, AsyncGroup | AnyAsyncArray]]: """ Create a complete zarr hierarchy from a collection of metadata objects. This function will parse its input to ensure that the hierarchy is complete. Any implicit groups will be inserted as needed. For example, an input like ```{'a/b': GroupMetadata}``` will be parsed to ```{'': GroupMetadata, 'a': GroupMetadata, 'b': Groupmetadata}``` After input parsing, this function then creates all the nodes in the hierarchy concurrently. Arrays and Groups are yielded in the order they are created. This order is not stable and should not be relied on. Parameters ---------- store : Store The storage backend to use. nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, relative to the root of the ``Store``. The root of the store can be specified with the empty string ``''``. The values are instances of ``GroupMetadata`` or ``ArrayMetadata``. Note that all values must have the same ``zarr_format`` -- it is an error to mix zarr versions in the same hierarchy. Leading "/" characters from keys will be removed. overwrite : bool Whether to overwrite existing nodes. Defaults to ``False``, in which case an error is raised instead of overwriting an existing array or group. This function will not erase an existing group unless that group is explicitly named in ``nodes``. If ``nodes`` defines implicit groups, e.g. ``{`'a/b/c': GroupMetadata}``, and a group already exists at path ``a``, then this function will leave the group at ``a`` as-is. Yields ------ tuple[str, AsyncGroup | AsyncArray] Yields (path, node) pairs, in the order the nodes were created. Examples -------- >>> async def example(): ... from zarr.api.asynchronous import create_hierarchy ... from zarr.core.group import GroupMetadata ... from zarr.storage import MemoryStore ... ... store = MemoryStore() ... nodes = {'a': GroupMetadata(attributes={'name': 'leaf'})} ... return sorted([x async for x in create_hierarchy(store=store, nodes=nodes)]) >>> import asyncio >>> asyncio.run(example()) [('', ), ('a', )] """ # normalize the keys to be valid paths nodes_normed_keys = _normalize_path_keys(nodes) # ensure that all nodes have the same zarr_format, and add implicit groups as needed nodes_parsed = _parse_hierarchy_dict(data=nodes_normed_keys) redundant_implicit_groups = [] # empty hierarchies should be a no-op if len(nodes_parsed) > 0: # figure out which zarr format we are using zarr_format = next(iter(nodes_parsed.values())).zarr_format # check which implicit groups will require materialization implicit_group_keys = tuple( filter(lambda k: isinstance(nodes_parsed[k], ImplicitGroupMarker), nodes_parsed) ) # read potential group metadata for each implicit group maybe_extant_group_coros = ( _read_group_metadata(store, k, zarr_format=zarr_format) for k in implicit_group_keys ) maybe_extant_groups = await asyncio.gather( *maybe_extant_group_coros, return_exceptions=True ) for key, value in zip(implicit_group_keys, maybe_extant_groups, strict=True): if isinstance(value, BaseException): if isinstance(value, FileNotFoundError): # this is fine -- there was no group there, so we will create one pass else: raise value else: # a loop exists already at ``key``, so we can avoid creating anything there redundant_implicit_groups.append(key) if overwrite: # we will remove any nodes that collide with arrays and non-implicit groups defined in # nodes # track the keys of nodes we need to delete to_delete_keys = [] to_delete_keys.extend( [k for k, v in nodes_parsed.items() if k not in implicit_group_keys] ) await asyncio.gather(*(store.delete_dir(key) for key in to_delete_keys)) else: # This type is long. coros: ( Generator[Coroutine[Any, Any, ArrayV2Metadata | GroupMetadata], None, None] | Generator[Coroutine[Any, Any, ArrayV3Metadata | GroupMetadata], None, None] ) if zarr_format == 2: coros = (_read_metadata_v2(store=store, path=key) for key in nodes_parsed) elif zarr_format == 3: coros = (_read_metadata_v3(store=store, path=key) for key in nodes_parsed) else: # pragma: no cover raise ValueError(f"Invalid zarr_format: {zarr_format}") # pragma: no cover extant_node_query = dict( zip( nodes_parsed.keys(), await asyncio.gather(*coros, return_exceptions=True), strict=False, ) ) # iterate over the existing arrays / groups and figure out which of them conflict # with the arrays / groups we want to create for key, extant_node in extant_node_query.items(): proposed_node = nodes_parsed[key] if isinstance(extant_node, BaseException): if isinstance(extant_node, FileNotFoundError): # ignore FileNotFoundError, because they represent nodes we can safely create pass else: # Any other exception is a real error raise extant_node else: # this is a node that already exists, but a node with the same key was specified # in nodes_parsed. if isinstance(extant_node, GroupMetadata): # a group already exists where we want to create a group if isinstance(proposed_node, ImplicitGroupMarker): # we have proposed an implicit group, which is OK -- we will just skip # creating this particular metadata document redundant_implicit_groups.append(key) else: # we have proposed an explicit group, which is an error, given that a # group already exists. msg = f"A group exists in store {store!r} at path {key!r}." raise ContainsGroupError(msg) elif isinstance(extant_node, ArrayV2Metadata | ArrayV3Metadata): # we are trying to overwrite an existing array. this is an error. msg = f"An array exists in store {store!r} at path {key!r}." raise ContainsArrayError(msg) nodes_explicit: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata] = {} for k, v in nodes_parsed.items(): if k not in redundant_implicit_groups: if isinstance(v, ImplicitGroupMarker): nodes_explicit[k] = GroupMetadata(zarr_format=v.zarr_format) else: nodes_explicit[k] = v async for key, node in create_nodes(store=store, nodes=nodes_explicit): yield key, node async def create_nodes( *, store: Store, nodes: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], ) -> AsyncIterator[tuple[str, AsyncGroup | AnyAsyncArray]]: """Create a collection of arrays and / or groups concurrently. Note: no attempt is made to validate that these arrays and / or groups collectively form a valid Zarr hierarchy. It is the responsibility of the caller of this function to ensure that the ``nodes`` parameter satisfies any correctness constraints. Parameters ---------- store : Store The storage backend to use. nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, and the values are the metadata of the nodes. The metadata must be either an instance of GroupMetadata, ArrayV3Metadata or ArrayV2Metadata. Yields ------ AsyncGroup | AsyncArray The created nodes in the order they are created. """ # Note: the only way to alter this value is via the config. If that's undesirable for some reason, # then we should consider adding a keyword argument to this function semaphore = asyncio.Semaphore(config.get("async.concurrency")) create_tasks: list[Coroutine[None, None, str]] = [] for key, value in nodes.items(): # make the key absolute create_tasks.extend(_persist_metadata(store, key, value, semaphore=semaphore)) created_object_keys = [] for coro in asyncio.as_completed(create_tasks): created_key = await coro # we need this to track which metadata documents were written so that we can yield a # complete v2 Array / Group class after both .zattrs and the metadata JSON was created. created_object_keys.append(created_key) # get the node name from the object key if len(created_key.split("/")) == 1: # this is the root node meta_out = nodes[""] node_name = "" else: # turn "foo/" into "foo" node_name = created_key[: created_key.rfind("/")] meta_out = nodes[node_name] if meta_out.zarr_format == 3: yield node_name, _build_node(store=store, path=node_name, metadata=meta_out) else: # For zarr v2 # we only want to yield when both the metadata and attributes are created # so we track which keys have been created, and wait for both the meta key and # the attrs key to be created before yielding back the AsyncArray / AsyncGroup attrs_done = _join_paths([node_name, ZATTRS_JSON]) in created_object_keys if isinstance(meta_out, GroupMetadata): meta_done = _join_paths([node_name, ZGROUP_JSON]) in created_object_keys else: meta_done = _join_paths([node_name, ZARRAY_JSON]) in created_object_keys if meta_done and attrs_done: yield node_name, _build_node(store=store, path=node_name, metadata=meta_out) continue def _get_roots( data: Iterable[str], ) -> tuple[str, ...]: """ Return the keys of the root(s) of the hierarchy. A root is a key with the fewest number of path segments. """ if "" in data: return ("",) keys_split = sorted((key.split("/") for key in data), key=len) groups: defaultdict[int, list[str]] = defaultdict(list) for key_split in keys_split: groups[len(key_split)].append("/".join(key_split)) return tuple(groups[min(groups.keys())]) def _parse_hierarchy_dict( *, data: Mapping[str, ImplicitGroupMarker | GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], ) -> dict[str, ImplicitGroupMarker | GroupMetadata | ArrayV2Metadata | ArrayV3Metadata]: """ Take an input with type Mapping[str, ArrayMetadata | GroupMetadata] and parse it into a dict of str: node pairs that models a valid, complete Zarr hierarchy. If the input represents a complete Zarr hierarchy, i.e. one with no implicit groups, then return a dict with the exact same data as the input. Otherwise, return a dict derived from the input with GroupMetadata inserted as needed to make the hierarchy complete. For example, an input of {'a/b': ArrayMetadata} is incomplete, because it references two groups (the root group '' and a group at 'a') that are not specified in the input. Applying this function to that input will result in a return value of {'': GroupMetadata, 'a': GroupMetadata, 'a/b': ArrayMetadata}, i.e. the implied groups were added. The input is also checked for the following conditions; an error is raised if any are violated: - No arrays can contain group or arrays (i.e., all arrays must be leaf nodes). - All arrays and groups must have the same ``zarr_format`` value. This function ensures that the input is transformed into a specification of a complete and valid Zarr hierarchy. """ # ensure that all nodes have the same zarr format data_purified = _ensure_consistent_zarr_format(data) # ensure that keys are normalized to zarr paths data_normed_keys = _normalize_path_keys(data_purified) # insert an implicit root group if a root was not specified # but not if an empty dict was provided, because any empty hierarchy has no nodes if len(data_normed_keys) > 0 and "" not in data_normed_keys: z_format = next(iter(data_normed_keys.values())).zarr_format data_normed_keys = data_normed_keys | {"": ImplicitGroupMarker(zarr_format=z_format)} out: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata] = {**data_normed_keys} for k, v in data_normed_keys.items(): key_split = k.split("/") # get every parent path *subpaths, _ = accumulate(key_split, lambda a, b: _join_paths([a, b])) for subpath in subpaths: # If a component is not already in the output dict, add ImplicitGroupMetadata if subpath not in out: out[subpath] = ImplicitGroupMarker(zarr_format=v.zarr_format) else: if not isinstance(out[subpath], GroupMetadata | ImplicitGroupMarker): msg = ( f"The node at {subpath} contains other nodes, but it is not a Zarr group. " "This is invalid. Only Zarr groups can contain other nodes." ) raise ValueError(msg) return out def _ensure_consistent_zarr_format( data: Mapping[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], ) -> Mapping[str, GroupMetadata | ArrayV2Metadata] | Mapping[str, GroupMetadata | ArrayV3Metadata]: """ Ensure that all values of the input dict have the same zarr format. If any do not, then a value error is raised. """ observed_zarr_formats: dict[ZarrFormat, list[str]] = {2: [], 3: []} for k, v in data.items(): observed_zarr_formats[v.zarr_format].append(k) if len(observed_zarr_formats[2]) > 0 and len(observed_zarr_formats[3]) > 0: msg = ( "Got data with both Zarr v2 and Zarr v3 nodes, which is invalid. " f"The following keys map to Zarr v2 nodes: {observed_zarr_formats.get(2)}. " f"The following keys map to Zarr v3 nodes: {observed_zarr_formats.get(3)}." "Ensure that all nodes have the same Zarr format." ) raise ValueError(msg) return cast( "Mapping[str, GroupMetadata | ArrayV2Metadata] | Mapping[str, GroupMetadata | ArrayV3Metadata]", data, ) async def _getitem_semaphore( node: AsyncGroup, key: str, semaphore: asyncio.Semaphore | None ) -> AnyAsyncArray | AsyncGroup: """ Wrap Group.getitem with an optional semaphore. If the semaphore parameter is an asyncio.Semaphore instance, then the getitem operation is performed inside an async context manager provided by that semaphore. If the semaphore parameter is None, then getitem is invoked without a context manager. """ if semaphore is not None: async with semaphore: return await node.getitem(key) else: return await node.getitem(key) async def _iter_members( node: AsyncGroup, skip_keys: tuple[str, ...], semaphore: asyncio.Semaphore | None, ) -> AsyncGenerator[tuple[str, AnyAsyncArray | AsyncGroup], None]: """ Iterate over the arrays and groups contained in a group. Parameters ---------- node : AsyncGroup The group to traverse. skip_keys : tuple[str, ...] A tuple of keys to skip when iterating over the possible members of the group. semaphore : asyncio.Semaphore | None An optional semaphore to use for concurrency control. Yields ------ tuple[str, AnyAsyncArray | AsyncGroup] """ # retrieve keys from storage keys = [key async for key in node.store.list_dir(node.path)] keys_filtered = tuple(filter(lambda v: v not in skip_keys, keys)) node_tasks = tuple( asyncio.create_task(_getitem_semaphore(node, key, semaphore), name=key) for key in keys_filtered ) for fetched_node_coro in asyncio.as_completed(node_tasks): try: fetched_node = await fetched_node_coro except KeyError as e: # keyerror is raised when `key` names an object (in the object storage sense), # as opposed to a prefix, in the store under the prefix associated with this group # in which case `key` cannot be the name of a sub-array or sub-group. warnings.warn( f"Object at {e.args[0]} is not recognized as a component of a Zarr hierarchy.", ZarrUserWarning, stacklevel=1, ) continue match fetched_node: case AsyncArray() | AsyncGroup(): yield fetched_node.basename, fetched_node case _: raise ValueError(f"Unexpected type: {type(fetched_node)}") async def _iter_members_deep( group: AsyncGroup, *, max_depth: int | None, skip_keys: tuple[str, ...], semaphore: asyncio.Semaphore | None = None, use_consolidated_for_children: bool = True, ) -> AsyncGenerator[tuple[str, AnyAsyncArray | AsyncGroup], None]: """ Iterate over the arrays and groups contained in a group, and optionally the arrays and groups contained in those groups. Parameters ---------- group : AsyncGroup The group to traverse. max_depth : int | None The maximum depth of recursion. skip_keys : tuple[str, ...] A tuple of keys to skip when iterating over the possible members of the group. semaphore : asyncio.Semaphore | None An optional semaphore to use for concurrency control. use_consolidated_for_children : bool, default True Whether to use the consolidated metadata of child groups loaded from the store. Note that this only affects groups loaded from the store. If the current Group already has consolidated metadata, it will always be used. Yields ------ tuple[str, AnyAsyncArray | AsyncGroup] """ to_recurse = {} do_recursion = max_depth is None or max_depth > 0 if max_depth is None: new_depth = None else: new_depth = max_depth - 1 async for name, node in _iter_members(group, skip_keys=skip_keys, semaphore=semaphore): is_group = isinstance(node, AsyncGroup) if ( is_group and not use_consolidated_for_children and node.metadata.consolidated_metadata is not None ): node = cast("AsyncGroup", node) # We've decided not to trust consolidated metadata at this point, because we're # reconsolidating the metadata, for example. node = replace(node, metadata=replace(node.metadata, consolidated_metadata=None)) yield name, node if is_group and do_recursion: node = cast("AsyncGroup", node) to_recurse[name] = _iter_members_deep( node, max_depth=new_depth, skip_keys=skip_keys, semaphore=semaphore ) for prefix, subgroup_iter in to_recurse.items(): async for name, node in subgroup_iter: key = f"{prefix}/{name}".lstrip("/") yield key, node async def _read_metadata_v3(store: Store, path: str) -> ArrayV3Metadata | GroupMetadata: """ Given a store_path, return ArrayV3Metadata or GroupMetadata defined by the metadata document stored at store_path.path / zarr.json. If no such document is found, raise a FileNotFoundError. """ zarr_json_bytes = await store.get( _join_paths([path, ZARR_JSON]), prototype=default_buffer_prototype() ) if zarr_json_bytes is None: raise FileNotFoundError(path) return _build_metadata_v3(buffer_to_json_object(zarr_json_bytes)) async def _read_metadata_v2(store: Store, path: str) -> ArrayV2Metadata | GroupMetadata: """ Given a store_path, return ArrayV2Metadata or GroupMetadata defined by the metadata document stored at store_path.path / (.zgroup | .zarray). If no such document is found, raise a FileNotFoundError. """ # TODO: consider first fetching array metadata, and only fetching group metadata when we don't # find an array zarray_bytes, zgroup_bytes, zattrs_bytes = await asyncio.gather( store.get(_join_paths([path, ZARRAY_JSON]), prototype=default_buffer_prototype()), store.get(_join_paths([path, ZGROUP_JSON]), prototype=default_buffer_prototype()), store.get(_join_paths([path, ZATTRS_JSON]), prototype=default_buffer_prototype()), ) zattrs: dict[str, JSON] if zattrs_bytes is None: zattrs = {} else: zattrs = buffer_to_json_object(zattrs_bytes) # TODO: decide how to handle finding both array and group metadata. The spec does not seem to # consider this situation. A practical approach would be to ignore that combination, and only # return the array metadata. if zarray_bytes is not None: zmeta = buffer_to_json_object(zarray_bytes) else: if zgroup_bytes is None: # neither .zarray or .zgroup were found results in KeyError raise FileNotFoundError(path) else: zmeta = buffer_to_json_object(zgroup_bytes) return _build_metadata_v2(zmeta, zattrs) async def _read_group_metadata_v2(store: Store, path: str) -> GroupMetadata: """ Read group metadata or error """ meta = await _read_metadata_v2(store=store, path=path) if not isinstance(meta, GroupMetadata): raise FileNotFoundError(f"Group metadata was not found in {store} at {path}") return meta async def _read_group_metadata_v3(store: Store, path: str) -> GroupMetadata: """ Read group metadata or error """ meta = await _read_metadata_v3(store=store, path=path) if not isinstance(meta, GroupMetadata): raise FileNotFoundError(f"Group metadata was not found in {store} at {path}") return meta async def _read_group_metadata( store: Store, path: str, *, zarr_format: ZarrFormat ) -> GroupMetadata: if zarr_format == 2: return await _read_group_metadata_v2(store=store, path=path) return await _read_group_metadata_v3(store=store, path=path) def _build_metadata_v3(zarr_json: dict[str, JSON]) -> ArrayV3Metadata | GroupMetadata: """ Convert a dict representation of Zarr V3 metadata into the corresponding metadata class. """ if "node_type" not in zarr_json: msg = "Required key 'node_type' is missing from the provided metadata document." raise MetadataValidationError(msg) match zarr_json: case {"node_type": "array"}: return ArrayV3Metadata.from_dict(zarr_json) case {"node_type": "group"}: return GroupMetadata.from_dict(zarr_json) case _: # pragma: no cover raise ValueError( "invalid value for `node_type` key in metadata document" ) # pragma: no cover def _build_metadata_v2( zarr_json: dict[str, JSON], attrs_json: dict[str, JSON] ) -> ArrayV2Metadata | GroupMetadata: """ Convert a dict representation of Zarr V2 metadata into the corresponding metadata class. """ match zarr_json: case {"shape": _}: return ArrayV2Metadata.from_dict(zarr_json | {"attributes": attrs_json}) case _: # pragma: no cover return GroupMetadata.from_dict(zarr_json | {"attributes": attrs_json}) @overload def _build_node(*, store: Store, path: str, metadata: ArrayV2Metadata) -> AsyncArrayV2: ... @overload def _build_node(*, store: Store, path: str, metadata: ArrayV3Metadata) -> AsyncArrayV3: ... @overload def _build_node(*, store: Store, path: str, metadata: GroupMetadata) -> AsyncGroup: ... def _build_node( *, store: Store, path: str, metadata: ArrayV3Metadata | ArrayV2Metadata | GroupMetadata ) -> AnyAsyncArray | AsyncGroup: """ Take a metadata object and return a node (AsyncArray or AsyncGroup). """ store_path = StorePath(store=store, path=path) match metadata: case ArrayV2Metadata() | ArrayV3Metadata(): return AsyncArray(metadata, store_path=store_path) case GroupMetadata(): return AsyncGroup(metadata, store_path=store_path) case _: # pragma: no cover raise ValueError(f"Unexpected metadata type: {type(metadata)}") # pragma: no cover async def _get_node_v2(store: Store, path: str) -> AsyncArrayV2 | AsyncGroup: """ Read a Zarr v2 AsyncArray or AsyncGroup from a path in a Store. Parameters ---------- store : Store The store-like object to read from. path : str The path to the node to read. Returns ------- AsyncArray | AsyncGroup """ metadata = await _read_metadata_v2(store=store, path=path) return _build_node(store=store, path=path, metadata=metadata) async def _get_node_v3(store: Store, path: str) -> AsyncArrayV3 | AsyncGroup: """ Read a Zarr v3 AsyncArray or AsyncGroup from a path in a Store. Parameters ---------- store : Store The store-like object to read from. path : str The path to the node to read. Returns ------- AsyncArray | AsyncGroup """ metadata = await _read_metadata_v3(store=store, path=path) return _build_node(store=store, path=path, metadata=metadata) async def get_node(store: Store, path: str, zarr_format: ZarrFormat) -> AnyAsyncArray | AsyncGroup: """ Get an AsyncArray or AsyncGroup from a path in a Store. Parameters ---------- store : Store The store-like object to read from. path : str The path to the node to read. zarr_format : {2, 3} The zarr format of the node to read. Returns ------- AsyncArray | AsyncGroup """ match zarr_format: case 2: return await _get_node_v2(store=store, path=path) case 3: return await _get_node_v3(store=store, path=path) case _: # pragma: no cover raise ValueError(f"Unexpected zarr format: {zarr_format}") # pragma: no cover async def _set_return_key( *, store: Store, key: str, value: Buffer, semaphore: asyncio.Semaphore | None = None ) -> str: """ Write a value to storage at the given key. The key is returned. Useful when saving values via routines that return results in execution order, like asyncio.as_completed, because in this case we need to know which key was saved in order to yield the right object to the caller. Parameters ---------- store : Store The store to save the value to. key : str The key to save the value to. value : Buffer The value to save. semaphore : asyncio.Semaphore | None An optional semaphore to use to limit the number of concurrent writes. """ if semaphore is not None: async with semaphore: await store.set(key, value) else: await store.set(key, value) return key def _persist_metadata( store: Store, path: str, metadata: ArrayV2Metadata | ArrayV3Metadata | GroupMetadata, semaphore: asyncio.Semaphore | None = None, ) -> tuple[Coroutine[None, None, str], ...]: """ Prepare to save a metadata document to storage, returning a tuple of coroutines that must be awaited. """ to_save = metadata.to_buffer_dict(default_buffer_prototype()) return tuple( _set_return_key(store=store, key=_join_paths([path, key]), value=value, semaphore=semaphore) for key, value in to_save.items() ) async def create_rooted_hierarchy( *, store: Store, nodes: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], overwrite: bool = False, ) -> AsyncGroup | AnyAsyncArray: """ Create an ``AsyncGroup`` or ``AsyncArray`` from a store and a dict of metadata documents. This function ensures that its input contains a specification of a root node, calls ``create_hierarchy`` to create nodes, and returns the root node of the hierarchy. """ roots = _get_roots(nodes.keys()) if len(roots) != 1: msg = ( "The input does not specify a root node. " "This function can only create hierarchies that contain a root node, which is " "defined as a group that is ancestral to all the other arrays and " "groups in the hierarchy, or a single array." ) raise ValueError(msg) else: root_key = roots[0] nodes_created = [ x async for x in create_hierarchy(store=store, nodes=nodes, overwrite=overwrite) ] return dict(nodes_created)[root_key] zarr-python-3.3.0/src/zarr/core/indexing.py000066400000000000000000002016011523267620000206710ustar00rootroot00000000000000from __future__ import annotations import itertools import math import numbers from collections.abc import Iterator, Sequence from dataclasses import dataclass from enum import Enum from functools import lru_cache from types import EllipsisType from typing import ( TYPE_CHECKING, Any, Literal, NamedTuple, Protocol, TypeGuard, cast, runtime_checkable, ) import numpy as np import numpy.typing as npt from zarr.core.chunk_grids import FixedDimension from zarr.core.common import ceildiv, product from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.core.metadata.v3 import ArrayV3Metadata from zarr.errors import ( ArrayIndexError, BoundsCheckError, NegativeStepError, VindexInvalidSelectionError, ) if TYPE_CHECKING: from zarr.core.array import AsyncArray from zarr.core.buffer import NDArrayLikeOrScalar from zarr.core.chunk_grids import ChunkGrid, DimensionGrid from zarr.types import AnyArray IntSequence = list[int] | npt.NDArray[np.intp] ArrayOfIntOrBool = npt.NDArray[np.intp] | npt.NDArray[np.bool_] BasicSelector = int | slice | EllipsisType Selector = BasicSelector | ArrayOfIntOrBool BasicSelection = BasicSelector | tuple[BasicSelector, ...] # also used for BlockIndex CoordinateSelection = IntSequence | tuple[IntSequence, ...] MaskSelection = npt.NDArray[np.bool_] OrthogonalSelection = Selector | tuple[Selector, ...] Selection = BasicSelection | CoordinateSelection | MaskSelection | OrthogonalSelection CoordinateSelectionNormalized = tuple[npt.NDArray[np.intp], ...] SelectionNormalized = tuple[Selector, ...] | ArrayOfIntOrBool SelectionWithFields = Selection | str | Sequence[str] SelectorTuple = tuple[Selector, ...] | npt.NDArray[np.intp] | slice Fields = str | list[str] | tuple[str, ...] def err_too_many_indices(selection: Any, shape: tuple[int, ...]) -> None: raise IndexError(f"too many indices for array; expected {len(shape)}, got {len(selection)}") def _zarr_array_to_int_or_bool_array(arr: AnyArray) -> npt.NDArray[np.intp] | npt.NDArray[np.bool_]: if arr.dtype.kind in ("i", "b"): return np.asarray(arr) else: raise IndexError( f"Invalid array dtype: {arr.dtype}. Arrays used as indices must be of integer or boolean type" ) @runtime_checkable class Indexer(Protocol): shape: tuple[int, ...] drop_axes: tuple[int, ...] def __iter__(self) -> Iterator[ChunkProjection]: ... type _ArrayIndexingOrder = Literal["lexicographic"] def _iter_grid( grid_shape: Sequence[int], *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, order: _ArrayIndexingOrder = "lexicographic", ) -> Iterator[tuple[int, ...]]: """ Iterate over the elements of grid of integers, with the option to restrict the domain of iteration to a contiguous subregion of that grid. Parameters ---------- grid_shape : Sequence[int] The size of the domain to iterate over. origin : Sequence[int] | None, default=None The first coordinate of the domain to return. selection_shape : Sequence[int] | None, default=None The shape of the selection. order : Literal["lexicographic"], default="lexicographic" The linear indexing order to use. Returns ------- Iterator[tuple[int, ...]] An iterator over tuples of integers Examples -------- ```python from zarr.core.indexing import _iter_grid tuple(_iter_grid((1,))) # ((0,),) tuple(_iter_grid((2,3))) # ((0, 0), (0, 1), (0, 2), (1, 0), (1, 1), (1, 2)) tuple(_iter_grid((2,3), origin=(1,1))) # ((1, 1), (1, 2)) tuple(_iter_grid((2,3), origin=(0,0), selection_shape=(2,2))) # ((0, 0), (0, 1), (1, 0), (1, 1)) ``` """ if origin is None: origin_parsed = (0,) * len(grid_shape) else: if len(origin) != len(grid_shape): msg = ( "Shape and origin parameters must have the same length." f"Got {len(grid_shape)} elements in shape, but {len(origin)} elements in origin." ) raise ValueError(msg) origin_parsed = tuple(origin) if selection_shape is None: selection_shape_parsed = tuple( g - o for o, g in zip(origin_parsed, grid_shape, strict=True) ) else: selection_shape_parsed = tuple(selection_shape) if order == "lexicographic": dimensions: tuple[range, ...] = () for idx, (o, gs, ss) in enumerate( zip(origin_parsed, grid_shape, selection_shape_parsed, strict=True) ): if o + ss > gs: raise IndexError( f"Invalid selection shape ({ss}) for origin ({o}) and grid shape ({gs}) at axis {idx}." ) dimensions += (range(o, o + ss),) return itertools.product(*(dimensions)) else: msg = f"Indexing order {order} is not supported at this time." # type: ignore[unreachable] # pragma: no cover raise NotImplementedError(msg) # pragma: no cover def _iter_regions( domain_shape: Sequence[int], region_shape: Sequence[int], *, origin: Sequence[int] | None = None, selection_shape: Sequence[int] | None = None, order: _ArrayIndexingOrder = "lexicographic", trim_excess: bool = True, ) -> Iterator[tuple[slice, ...]]: """ Iterate over contiguous regions on a grid of integers, with the option to restrict the domain of iteration to a contiguous subregion of that grid. Parameters ---------- domain_shape : Sequence[int] The size of the domain to iterate over. region_shape : Sequence[int] The shape of the region to iterate over. origin : Sequence[int] | None, default=None The location, in grid coordinates, of the first region to return. selection_shape : Sequence[int] | None, default=None The shape of the selection, in grid coordinates. order : Literal["lexicographic"], default="lexicographic" The linear indexing order to use. Yields ------ Iterator[tuple[slice, ...]] An iterator over tuples of slices, where each slice spans a separate contiguous region Examples -------- ```python from zarr.core.indexing import _iter_regions tuple(_iter_regions((1,), (1,))) # ((slice(0, 1, 1),),) tuple(_iter_regions((2, 3), (1, 2))) # ((slice(0, 1, 1), slice(0, 2, 1)), (slice(1, 2, 1), slice(0, 2, 1))) tuple(_iter_regions((2,3), (1,2), origin=(1,1))) # ((slice(1, 2, 1), slice(1, 3, 1)), (slice(2, 3, 1), slice(1, 3, 1))) tuple(_iter_regions((2,3), (1,2), origin=(0,0), selection_shape=(2,2))) # ((slice(0, 1, 1), slice(0, 2, 1)), (slice(1, 2, 1), slice(0, 2, 1))) ``` """ grid_shape = tuple(itertools.starmap(ceildiv, zip(domain_shape, region_shape, strict=True))) for grid_position in _iter_grid( grid_shape=grid_shape, origin=origin, selection_shape=selection_shape, order=order ): out: list[slice] = [] for g_pos, r_shape, d_shape in zip(grid_position, region_shape, domain_shape, strict=True): start = g_pos * r_shape stop = start + r_shape if trim_excess: stop = min(stop, d_shape) out.append(slice(start, stop, 1)) yield tuple(out) def is_integer(x: Any) -> TypeGuard[int]: """True if x is an integer (both pure Python or NumPy).""" return isinstance(x, numbers.Integral) and not is_bool(x) def is_bool(x: Any) -> TypeGuard[bool | np.bool_]: """True if x is a boolean (both pure Python or NumPy).""" return type(x) in [bool, np.bool_] def is_integer_list(x: Any) -> TypeGuard[list[int]]: """True if x is a list of integers.""" return isinstance(x, list) and len(x) > 0 and all(is_integer(i) for i in x) def is_bool_list(x: Any) -> TypeGuard[list[bool | np.bool_]]: """True if x is a list of boolean.""" return isinstance(x, list) and len(x) > 0 and all(is_bool(i) for i in x) def is_integer_array(x: Any, ndim: int | None = None) -> TypeGuard[npt.NDArray[np.intp]]: t = not np.isscalar(x) and hasattr(x, "shape") and hasattr(x, "dtype") and x.dtype.kind in "ui" if ndim is not None: t = t and hasattr(x, "shape") and len(x.shape) == ndim return t def is_bool_array(x: Any, ndim: int | None = None) -> TypeGuard[npt.NDArray[np.bool_]]: t = hasattr(x, "shape") and hasattr(x, "dtype") and x.dtype == bool if ndim is not None: t = t and hasattr(x, "shape") and len(x.shape) == ndim return t def is_int_or_bool_iterable(x: Any) -> bool: return is_integer_list(x) or is_integer_array(x) or is_bool_array(x) or is_bool_list(x) def is_scalar(value: Any, dtype: np.dtype[Any]) -> bool: if np.isscalar(value): return True if hasattr(value, "shape") and value.shape == (): return True return isinstance(value, tuple) and dtype.names is not None and len(value) == len(dtype.names) def is_pure_fancy_indexing(selection: Any, ndim: int) -> bool: """Check whether a selection contains only scalars or integer/bool array-likes. Parameters ---------- selection : tuple, slice, or scalar A valid selection value for indexing into arrays. Returns ------- is_pure : bool True if the selection is a pure fancy indexing expression (ie not mixed with boolean or slices). """ if is_bool_array(selection): # is mask selection return True if ndim == 1 and ( is_integer_list(selection) or is_integer_array(selection) or is_bool_list(selection) ): return True # if not, we go through the normal path below, because a 1-tuple # of integers is also allowed. no_slicing = ( isinstance(selection, tuple) and len(selection) == ndim and not (any(isinstance(elem, slice) or elem is Ellipsis for elem in selection)) ) return ( no_slicing and all( is_integer(elem) or is_integer_list(elem) or is_integer_array(elem) for elem in selection ) and any(is_integer_list(elem) or is_integer_array(elem) for elem in selection) ) def is_pure_orthogonal_indexing(selection: Selection, ndim: int) -> TypeGuard[OrthogonalSelection]: if not ndim: return False selection_normalized = (selection,) if not isinstance(selection, tuple) else selection # Case 1: Selection contains of iterable of integers or boolean if len(selection_normalized) == ndim and all( is_int_or_bool_iterable(s) for s in selection_normalized ): return True # Case 2: selection contains either zero or one integer iterables. # All other selection elements are slices or integers return ( len(selection_normalized) <= ndim and sum(is_int_or_bool_iterable(s) for s in selection_normalized) <= 1 and all( is_int_or_bool_iterable(s) or isinstance(s, int | slice) for s in selection_normalized ) ) def normalize_integer_selection(dim_sel: int, dim_len: int) -> int: # normalize type to int dim_sel = int(dim_sel) # handle wraparound if dim_sel < 0: dim_sel = dim_len + dim_sel # handle out of bounds if dim_sel >= dim_len or dim_sel < 0: msg = f"index out of bounds for dimension with length {dim_len}" raise BoundsCheckError(msg) return dim_sel class ChunkDimProjection(NamedTuple): """A mapping from chunk to output array for a single dimension. Attributes ---------- dim_chunk_ix Index of chunk. dim_chunk_sel Selection of items from chunk array. dim_out_sel Selection of items in target (output) array. """ dim_chunk_ix: int dim_chunk_sel: Selector dim_out_sel: Selector | None is_complete_chunk: bool @dataclass(frozen=True) class IntDimIndexer: dim_sel: int dim_len: int dim_grid: DimensionGrid nitems: int = 1 def __init__(self, dim_sel: int, dim_len: int, dim_grid: DimensionGrid) -> None: object.__setattr__(self, "dim_sel", normalize_integer_selection(dim_sel, dim_len)) object.__setattr__(self, "dim_len", dim_len) object.__setattr__(self, "dim_grid", dim_grid) def __iter__(self) -> Iterator[ChunkDimProjection]: g = self.dim_grid dim_chunk_ix = g.index_to_chunk(self.dim_sel) dim_offset = g.chunk_offset(dim_chunk_ix) dim_chunk_sel = self.dim_sel - dim_offset dim_out_sel = None is_complete_chunk = g.data_size(dim_chunk_ix) == 1 yield ChunkDimProjection(dim_chunk_ix, dim_chunk_sel, dim_out_sel, is_complete_chunk) @dataclass(frozen=True) class SliceDimIndexer: dim_len: int nitems: int nchunks: int dim_grid: DimensionGrid start: int stop: int step: int def __init__( self, dim_sel: slice, dim_len: int, dim_grid: DimensionGrid, ) -> None: # normalize start, stop, step = dim_sel.indices(dim_len) if step < 1: raise NegativeStepError("only slices with step >= 1 are supported.") object.__setattr__(self, "start", start) object.__setattr__(self, "stop", stop) object.__setattr__(self, "step", step) object.__setattr__(self, "dim_len", dim_len) object.__setattr__(self, "dim_grid", dim_grid) object.__setattr__(self, "nitems", max(0, ceildiv((stop - start), step))) object.__setattr__(self, "nchunks", dim_grid.nchunks) def __iter__(self) -> Iterator[ChunkDimProjection]: # figure out the range of chunks we need to visit if self.start >= self.stop: return # empty slice g = self.dim_grid dim_chunk_ix_from = g.index_to_chunk(self.start) if self.start > 0 else 0 dim_chunk_ix_to = g.index_to_chunk(self.stop - 1) + 1 if self.stop > 0 else 0 # iterate over chunks in range for dim_chunk_ix in range(dim_chunk_ix_from, dim_chunk_ix_to): # compute offsets for chunk within overall array dim_offset = g.chunk_offset(dim_chunk_ix) # determine chunk length, accounting for trailing chunk dim_chunk_len = g.data_size(dim_chunk_ix) dim_limit = dim_offset + dim_chunk_len if self.start < dim_offset: # selection starts before current chunk dim_chunk_sel_start = 0 remainder = (dim_offset - self.start) % self.step if remainder: dim_chunk_sel_start += self.step - remainder # compute number of previous items, provides offset into output array dim_out_offset = ceildiv((dim_offset - self.start), self.step) else: # selection starts within current chunk dim_chunk_sel_start = self.start - dim_offset dim_out_offset = 0 if self.stop > dim_limit: # selection ends after current chunk dim_chunk_sel_stop = dim_chunk_len else: # selection ends within current chunk dim_chunk_sel_stop = self.stop - dim_offset dim_chunk_sel = slice(dim_chunk_sel_start, dim_chunk_sel_stop, self.step) dim_chunk_nitems = ceildiv((dim_chunk_sel_stop - dim_chunk_sel_start), self.step) # If there are no elements on the selection within this chunk, then skip if dim_chunk_nitems == 0: continue dim_out_sel = slice(dim_out_offset, dim_out_offset + dim_chunk_nitems) is_complete_chunk = ( dim_chunk_sel_start == 0 and (self.stop >= dim_limit) and self.step in [1, None] ) yield ChunkDimProjection(dim_chunk_ix, dim_chunk_sel, dim_out_sel, is_complete_chunk) def check_selection_length(selection: SelectionNormalized, shape: tuple[int, ...]) -> None: if len(selection) > len(shape): err_too_many_indices(selection, shape) def replace_ellipsis(selection: Any, shape: tuple[int, ...]) -> SelectionNormalized: selection = ensure_tuple(selection) # count number of ellipsis present n_ellipsis = sum(1 for i in selection if i is Ellipsis) if n_ellipsis > 1: # more than 1 is an error raise IndexError("an index can only have a single ellipsis ('...')") elif n_ellipsis == 1: # locate the ellipsis, count how many items to left and right n_items_l = selection.index(Ellipsis) # items to left of ellipsis n_items_r = len(selection) - (n_items_l + 1) # items to right of ellipsis n_items = len(selection) - 1 # all non-ellipsis items if n_items >= len(shape): # ellipsis does nothing, just remove it selection = tuple(i for i in selection if i != Ellipsis) else: # replace ellipsis with as many slices are needed for number of dims new_item = selection[:n_items_l] + ((slice(None),) * (len(shape) - n_items)) if n_items_r: new_item += selection[-n_items_r:] selection = new_item # fill out selection if not completely specified if len(selection) < len(shape): selection += (slice(None),) * (len(shape) - len(selection)) # check selection not too long check_selection_length(selection, shape) return cast("SelectionNormalized", selection) def replace_lists(selection: SelectionNormalized) -> SelectionNormalized: return tuple( cast("ArrayOfIntOrBool", np.asarray(dim_sel)) if isinstance(dim_sel, list) else dim_sel for dim_sel in selection ) def ensure_tuple(v: Any) -> SelectionNormalized: if not isinstance(v, tuple): v = (v,) return cast("SelectionNormalized", v) class ChunkProjection(NamedTuple): """A mapping of items from chunk to output array. Can be used to extract items from the chunk array for loading into an output array. Can also be used to extract items from a value array for setting/updating in a chunk array. Attributes ---------- chunk_coords Indices of chunk. chunk_selection Selection of items from chunk array. out_selection Selection of items in target (output) array. is_complete_chunk: True if a complete chunk is indexed """ chunk_coords: tuple[int, ...] chunk_selection: tuple[Selector, ...] | npt.NDArray[np.intp] out_selection: tuple[Selector, ...] | npt.NDArray[np.intp] | slice is_complete_chunk: bool def is_slice(s: Any) -> TypeGuard[slice]: return isinstance(s, slice) def is_contiguous_slice(s: Any) -> TypeGuard[slice]: return is_slice(s) and (s.step is None or s.step == 1) def is_positive_slice(s: Any) -> TypeGuard[slice]: return is_slice(s) and (s.step is None or s.step >= 1) def is_contiguous_selection(selection: Any) -> TypeGuard[slice]: selection = ensure_tuple(selection) return all((is_integer_array(s) or is_contiguous_slice(s) or s == Ellipsis) for s in selection) def is_basic_selection(selection: Any) -> TypeGuard[BasicSelection]: selection = ensure_tuple(selection) return all(is_integer(s) or is_positive_slice(s) for s in selection) @dataclass(frozen=True) class BasicIndexer(Indexer): dim_indexers: list[IntDimIndexer | SliceDimIndexer] shape: tuple[int, ...] drop_axes: tuple[int, ...] def __init__( self, selection: BasicSelection, shape: tuple[int, ...], chunk_grid: ChunkGrid, ) -> None: dim_grids = chunk_grid._dimensions # handle ellipsis selection_normalized = replace_ellipsis(selection, shape) # setup per-dimension indexers dim_indexers: list[IntDimIndexer | SliceDimIndexer] = [] for dim_sel, dim_len, dim_grid in zip(selection_normalized, shape, dim_grids, strict=True): dim_indexer: IntDimIndexer | SliceDimIndexer if is_integer(dim_sel): dim_indexer = IntDimIndexer(dim_sel, dim_len, dim_grid) elif is_slice(dim_sel): dim_indexer = SliceDimIndexer(dim_sel, dim_len, dim_grid) else: raise IndexError( "unsupported selection item for basic indexing; " f"expected integer or slice, got {type(dim_sel)!r}" ) dim_indexers.append(dim_indexer) object.__setattr__(self, "dim_indexers", dim_indexers) object.__setattr__( self, "shape", tuple(s.nitems for s in self.dim_indexers if not isinstance(s, IntDimIndexer)), ) object.__setattr__(self, "drop_axes", ()) def __iter__(self) -> Iterator[ChunkProjection]: for dim_projections in itertools.product(*self.dim_indexers): chunk_coords = tuple(p.dim_chunk_ix for p in dim_projections) chunk_selection = tuple(p.dim_chunk_sel for p in dim_projections) out_selection = tuple( p.dim_out_sel for p in dim_projections if p.dim_out_sel is not None ) is_complete_chunk = all(p.is_complete_chunk for p in dim_projections) yield ChunkProjection(chunk_coords, chunk_selection, out_selection, is_complete_chunk) @dataclass(frozen=True) class BoolArrayDimIndexer: dim_sel: npt.NDArray[np.bool_] dim_len: int dim_grid: DimensionGrid nchunks: int chunk_nitems: npt.NDArray[Any] chunk_nitems_cumsum: npt.NDArray[Any] nitems: int dim_chunk_ixs: npt.NDArray[np.intp] def __init__( self, dim_sel: npt.NDArray[np.bool_], dim_len: int, dim_grid: DimensionGrid, ) -> None: # check number of dimensions if not is_bool_array(dim_sel, 1): raise IndexError("Boolean arrays in an orthogonal selection must be 1-dimensional only") # check shape if dim_sel.shape[0] != dim_len: raise IndexError( f"Boolean array has the wrong length for dimension; expected {dim_len}, got {dim_sel.shape[0]}" ) g = dim_grid nchunks = g.nchunks # precompute number of selected items for each chunk chunk_nitems = np.zeros(nchunks, dtype="i8") for dim_chunk_ix in range(nchunks): dim_offset = g.chunk_offset(dim_chunk_ix) chunk_len = g.data_size(dim_chunk_ix) chunk_nitems[dim_chunk_ix] = np.count_nonzero( dim_sel[dim_offset : dim_offset + chunk_len] ) chunk_nitems_cumsum = np.cumsum(chunk_nitems) nitems = chunk_nitems_cumsum[-1] dim_chunk_ixs = np.nonzero(chunk_nitems)[0] # store attributes object.__setattr__(self, "dim_sel", dim_sel) object.__setattr__(self, "dim_len", dim_len) object.__setattr__(self, "dim_grid", dim_grid) object.__setattr__(self, "nchunks", nchunks) object.__setattr__(self, "chunk_nitems", chunk_nitems) object.__setattr__(self, "chunk_nitems_cumsum", chunk_nitems_cumsum) object.__setattr__(self, "nitems", nitems) object.__setattr__(self, "dim_chunk_ixs", dim_chunk_ixs) def __iter__(self) -> Iterator[ChunkDimProjection]: g = self.dim_grid # iterate over chunks with at least one item for dim_chunk_ix in self.dim_chunk_ixs: # find region in chunk dim_offset = g.chunk_offset(dim_chunk_ix) chunk_len = g.data_size(dim_chunk_ix) dim_chunk_sel = self.dim_sel[dim_offset : dim_offset + chunk_len] # pad out if boundary chunk (codec buffer may be larger than valid data region) codec_size = g.chunk_size(dim_chunk_ix) if dim_chunk_sel.shape[0] < codec_size: tmp = np.zeros(codec_size, dtype=bool) tmp[: dim_chunk_sel.shape[0]] = dim_chunk_sel dim_chunk_sel = tmp # find region in output if dim_chunk_ix == 0: start = 0 else: start = self.chunk_nitems_cumsum[dim_chunk_ix - 1] stop = self.chunk_nitems_cumsum[dim_chunk_ix] dim_out_sel = slice(start, stop) is_complete_chunk = False # TODO yield ChunkDimProjection(dim_chunk_ix, dim_chunk_sel, dim_out_sel, is_complete_chunk) class Order(Enum): """ Enum for indexing order. """ UNKNOWN = 0 INCREASING = 1 DECREASING = 2 UNORDERED = 3 @staticmethod def check(a: npt.NDArray[Any]) -> Order: diff = np.diff(a) diff_positive = diff >= 0 n_diff_positive = np.count_nonzero(diff_positive) all_increasing = n_diff_positive == len(diff_positive) any_increasing = n_diff_positive > 0 if all_increasing: order = Order.INCREASING elif any_increasing: order = Order.UNORDERED else: order = Order.DECREASING return order def wraparound_indices(x: npt.NDArray[Any], dim_len: int) -> None: loc_neg = x < 0 if np.any(loc_neg): x[loc_neg] += dim_len def boundscheck_indices(x: npt.NDArray[Any], dim_len: int) -> None: if np.any(x < 0) or np.any(x >= dim_len): msg = f"index out of bounds for dimension with length {dim_len}" raise BoundsCheckError(msg) @dataclass(frozen=True) class IntArrayDimIndexer: """Integer array selection against a single dimension.""" dim_len: int dim_grid: DimensionGrid nchunks: int nitems: int order: Order dim_sel: npt.NDArray[np.intp] dim_out_sel: npt.NDArray[np.intp] chunk_nitems: int dim_chunk_ixs: npt.NDArray[np.intp] chunk_nitems_cumsum: npt.NDArray[np.intp] def __init__( self, dim_sel: npt.NDArray[np.intp], dim_len: int, dim_grid: DimensionGrid, wraparound: bool = True, boundscheck: bool = True, order: Order = Order.UNKNOWN, ) -> None: # ensure 1d array dim_sel = np.asanyarray(dim_sel) if not is_integer_array(dim_sel, 1): raise IndexError("integer arrays in an orthogonal selection must be 1-dimensional only") nitems = len(dim_sel) g = dim_grid nchunks = g.nchunks # handle wraparound if wraparound: wraparound_indices(dim_sel, dim_len) # handle out of bounds if boundscheck: boundscheck_indices(dim_sel, dim_len) # determine which chunk is needed for each selection item # note: for dense integer selections, the division operation here is the # bottleneck dim_sel_chunk = g.indices_to_chunks(dim_sel) # determine order of indices if order == Order.UNKNOWN: order = Order.check(dim_sel) order = Order(order) if order == Order.INCREASING: dim_out_sel = None elif order == Order.DECREASING: dim_sel = dim_sel[::-1] # TODO should be possible to do this without creating an arange dim_out_sel = np.arange(nitems - 1, -1, -1) else: # sort indices to group by chunk dim_out_sel = np.argsort(dim_sel_chunk) dim_sel = np.take(dim_sel, dim_out_sel) # precompute number of selected items for each chunk chunk_nitems = np.bincount(dim_sel_chunk, minlength=nchunks) # find chunks that we need to visit dim_chunk_ixs = np.nonzero(chunk_nitems)[0] # compute offsets into the output array chunk_nitems_cumsum = np.cumsum(chunk_nitems) # store attributes object.__setattr__(self, "dim_len", dim_len) object.__setattr__(self, "dim_grid", dim_grid) object.__setattr__(self, "nchunks", nchunks) object.__setattr__(self, "nitems", nitems) object.__setattr__(self, "order", order) object.__setattr__(self, "dim_sel", dim_sel) object.__setattr__(self, "dim_out_sel", dim_out_sel) object.__setattr__(self, "chunk_nitems", chunk_nitems) object.__setattr__(self, "dim_chunk_ixs", dim_chunk_ixs) object.__setattr__(self, "chunk_nitems_cumsum", chunk_nitems_cumsum) def __iter__(self) -> Iterator[ChunkDimProjection]: g = self.dim_grid for dim_chunk_ix in self.dim_chunk_ixs: dim_out_sel: slice | npt.NDArray[np.intp] # find region in output if dim_chunk_ix == 0: start = 0 else: start = self.chunk_nitems_cumsum[dim_chunk_ix - 1] stop = self.chunk_nitems_cumsum[dim_chunk_ix] if self.order == Order.INCREASING: dim_out_sel = slice(start, stop) else: dim_out_sel = self.dim_out_sel[start:stop] # find region in chunk dim_offset = g.chunk_offset(dim_chunk_ix) dim_chunk_sel = self.dim_sel[start:stop] - dim_offset is_complete_chunk = False # TODO yield ChunkDimProjection(dim_chunk_ix, dim_chunk_sel, dim_out_sel, is_complete_chunk) def slice_to_range(s: slice, length: int) -> range: return range(*s.indices(length)) def ix_(selection: Any, shape: tuple[int, ...]) -> npt.NDArray[np.intp]: """Convert an orthogonal selection to a numpy advanced (fancy) selection, like ``numpy.ix_`` but with support for slices and single ints.""" # normalisation selection = replace_ellipsis(selection, shape) # replace slice and int as these are not supported by numpy.ix_ selection = [ slice_to_range(dim_sel, dim_len) if isinstance(dim_sel, slice) else [dim_sel] if is_integer(dim_sel) else dim_sel for dim_sel, dim_len in zip(selection, shape, strict=True) ] # now get numpy to convert to a coordinate selection selection = np.ix_(*selection) return cast("npt.NDArray[np.intp]", selection) def oindex(a: npt.NDArray[Any], selection: Selection) -> npt.NDArray[Any]: """Implementation of orthogonal indexing with slices and ints.""" selection = replace_ellipsis(selection, a.shape) drop_axes = tuple(i for i, s in enumerate(selection) if is_integer(s)) selection = ix_(selection, a.shape) result = a[selection] if drop_axes: result = result.squeeze(axis=drop_axes) return result def oindex_set(a: npt.NDArray[Any], selection: Selection, value: Any) -> None: selection = replace_ellipsis(selection, a.shape) drop_axes = tuple(i for i, s in enumerate(selection) if is_integer(s)) selection = ix_(selection, a.shape) if not np.isscalar(value) and drop_axes: value = np.asanyarray(value) value_selection: list[Selector | None] = [slice(None)] * len(a.shape) for i in drop_axes: value_selection[i] = np.newaxis value = value[tuple(value_selection)] a[selection] = value @dataclass(frozen=True) class OrthogonalIndexer(Indexer): dim_indexers: list[IntDimIndexer | SliceDimIndexer | IntArrayDimIndexer | BoolArrayDimIndexer] dim_grids: tuple[DimensionGrid, ...] shape: tuple[int, ...] is_advanced: bool drop_axes: tuple[int, ...] def __init__(self, selection: Selection, shape: tuple[int, ...], chunk_grid: ChunkGrid) -> None: dim_grids = chunk_grid._dimensions # handle ellipsis selection = replace_ellipsis(selection, shape) # normalize list to array selection = replace_lists(selection) # setup per-dimension indexers dim_indexers: list[ IntDimIndexer | SliceDimIndexer | IntArrayDimIndexer | BoolArrayDimIndexer ] = [] for dim_sel, dim_len, dim_grid in zip(selection, shape, dim_grids, strict=True): dim_indexer: IntDimIndexer | SliceDimIndexer | IntArrayDimIndexer | BoolArrayDimIndexer if is_integer(dim_sel): dim_indexer = IntDimIndexer(dim_sel, dim_len, dim_grid) elif isinstance(dim_sel, slice): dim_indexer = SliceDimIndexer(dim_sel, dim_len, dim_grid) elif is_integer_array(dim_sel): dim_indexer = IntArrayDimIndexer(dim_sel, dim_len, dim_grid) elif is_bool_array(dim_sel): dim_indexer = BoolArrayDimIndexer(dim_sel, dim_len, dim_grid) else: raise IndexError( "unsupported selection item for orthogonal indexing; " "expected integer, slice, integer array or Boolean " f"array, got {type(dim_sel)!r}" ) dim_indexers.append(dim_indexer) shape = tuple(s.nitems for s in dim_indexers if not isinstance(s, IntDimIndexer)) is_advanced = not is_basic_selection(selection) if is_advanced: drop_axes = tuple( i for i, dim_indexer in enumerate(dim_indexers) if isinstance(dim_indexer, IntDimIndexer) ) else: drop_axes = () object.__setattr__(self, "dim_indexers", dim_indexers) object.__setattr__(self, "dim_grids", dim_grids) object.__setattr__(self, "shape", shape) object.__setattr__(self, "is_advanced", is_advanced) object.__setattr__(self, "drop_axes", drop_axes) def __iter__(self) -> Iterator[ChunkProjection]: for dim_projections in itertools.product(*self.dim_indexers): chunk_coords = tuple(p.dim_chunk_ix for p in dim_projections) chunk_selection: tuple[Selector, ...] | npt.NDArray[Any] = tuple( p.dim_chunk_sel for p in dim_projections ) out_selection: tuple[Selector, ...] | npt.NDArray[Any] = tuple( p.dim_out_sel for p in dim_projections if p.dim_out_sel is not None ) # handle advanced indexing arrays orthogonally if self.is_advanced: # NumPy can handle a single array-indexed dimension directly, # which preserves full slices and avoids an # unnecessary advanced-indexing copy. Integer-indexed # dimensions still need the ix_ path for downstream squeezing. # Example: we skip `ix_` for array[:, :, [1, 2, 3]] n_array_dims = sum(isinstance(sel, np.ndarray) for sel in chunk_selection) if n_array_dims > 1 or self.drop_axes: # N.B., numpy doesn't support orthogonal indexing directly # for multiple array-indexed dimensions, so we need to # convert the orthogonal selection into coordinate arrays. chunk_shape = tuple( g.chunk_size(p.dim_chunk_ix) for g, p in zip(self.dim_grids, dim_projections, strict=True) ) chunk_selection = ix_(chunk_selection, chunk_shape) # special case for non-monotonic indices if not is_basic_selection(out_selection): out_selection = ix_(out_selection, self.shape) is_complete_chunk = all(p.is_complete_chunk for p in dim_projections) yield ChunkProjection(chunk_coords, chunk_selection, out_selection, is_complete_chunk) @dataclass(frozen=True) class OIndex: array: AnyArray # TODO: develop Array generic and move zarr.Array[np.intp] | zarr.Array[np.bool_] to ArrayOfIntOrBool def __getitem__(self, selection: OrthogonalSelection | AnyArray) -> NDArrayLikeOrScalar: from zarr.core.array import Array # if input is a Zarr array, we materialize it now. if isinstance(selection, Array): selection = _zarr_array_to_int_or_bool_array(selection) fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) return self.array.get_orthogonal_selection( cast("OrthogonalSelection", new_selection), fields=fields ) def __setitem__(self, selection: OrthogonalSelection, value: npt.ArrayLike) -> None: fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) return self.array.set_orthogonal_selection( cast("OrthogonalSelection", new_selection), value, fields=fields ) @dataclass(frozen=True) class AsyncOIndex[T_ArrayMetadata: (ArrayV2Metadata, ArrayV3Metadata)]: array: AsyncArray[T_ArrayMetadata] async def getitem(self, selection: OrthogonalSelection | AnyArray) -> NDArrayLikeOrScalar: from zarr.core.array import Array # if input is a Zarr array, we materialize it now. if isinstance(selection, Array): selection = _zarr_array_to_int_or_bool_array(selection) fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) return await self.array.get_orthogonal_selection( cast(OrthogonalSelection, new_selection), fields=fields ) @dataclass(frozen=True) class BlockIndexer(Indexer): dim_indexers: list[SliceDimIndexer] shape: tuple[int, ...] drop_axes: tuple[int, ...] def __init__( self, selection: BasicSelection, shape: tuple[int, ...], chunk_grid: ChunkGrid ) -> None: dim_grids = chunk_grid._dimensions # handle ellipsis selection_normalized = replace_ellipsis(selection, shape) # normalize list to array selection_normalized = replace_lists(selection_normalized) # setup per-dimension indexers dim_indexers = [] for dim_sel, dim_len, dim_grid in zip(selection_normalized, shape, dim_grids, strict=True): dim_numchunks = dim_grid.nchunks if is_integer(dim_sel): if dim_sel < 0: dim_sel = dim_numchunks + dim_sel if dim_sel < 0 or dim_sel >= dim_numchunks: raise BoundsCheckError( f"block index out of bounds for dimension with {dim_numchunks} chunk(s)" ) start = dim_grid.chunk_offset(dim_sel) stop = start + dim_grid.chunk_size(dim_sel) slice_ = slice(start, stop) elif is_slice(dim_sel): start = dim_sel.start if dim_sel.start is not None else 0 stop = dim_sel.stop if dim_sel.stop is not None else dim_numchunks if dim_sel.step not in {1, None}: raise IndexError( "unsupported selection item for block indexing; " f"expected integer or slice with step=1, got {type(dim_sel)!r}" ) # Can't reuse wraparound_indices because it expects a numpy array # We have integers here. if start < 0: start = dim_numchunks + start if stop < 0: stop = dim_numchunks + stop start = dim_grid.chunk_offset(start) if start < dim_numchunks else dim_len stop = dim_grid.chunk_offset(stop) if stop < dim_numchunks else dim_len slice_ = slice(start, stop) else: raise IndexError( "unsupported selection item for block indexing; " f"expected integer or slice, got {type(dim_sel)!r}" ) dim_indexer = SliceDimIndexer(slice_, dim_len, dim_grid) dim_indexers.append(dim_indexer) if slice_.start >= dim_len or slice_.start < 0: msg = f"index out of bounds for dimension with length {dim_len}" raise BoundsCheckError(msg) shape = tuple(s.nitems for s in dim_indexers) object.__setattr__(self, "dim_indexers", dim_indexers) object.__setattr__(self, "shape", shape) object.__setattr__(self, "drop_axes", ()) def __iter__(self) -> Iterator[ChunkProjection]: for dim_projections in itertools.product(*self.dim_indexers): chunk_coords = tuple(p.dim_chunk_ix for p in dim_projections) chunk_selection = tuple(p.dim_chunk_sel for p in dim_projections) out_selection = tuple( p.dim_out_sel for p in dim_projections if p.dim_out_sel is not None ) is_complete_chunk = all(p.is_complete_chunk for p in dim_projections) yield ChunkProjection(chunk_coords, chunk_selection, out_selection, is_complete_chunk) @dataclass(frozen=True) class BlockIndex: array: AnyArray def __getitem__(self, selection: BasicSelection) -> NDArrayLikeOrScalar: fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) return self.array.get_block_selection(cast("BasicSelection", new_selection), fields=fields) def __setitem__(self, selection: BasicSelection, value: npt.ArrayLike) -> None: fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) return self.array.set_block_selection( cast("BasicSelection", new_selection), value, fields=fields ) def is_coordinate_selection( selection: SelectionNormalized, shape: tuple[int, ...] ) -> TypeGuard[CoordinateSelectionNormalized]: return ( isinstance(selection, tuple) and len(selection) == len(shape) and all(is_integer(dim_sel) or is_integer_array(dim_sel) for dim_sel in selection) ) def is_mask_selection(selection: Selection, shape: tuple[int, ...]) -> TypeGuard[MaskSelection]: return ( isinstance(selection, tuple) and len(selection) == 1 and is_bool_array(selection[0]) and selection[0].shape == shape ) @dataclass(frozen=True) class CoordinateIndexer(Indexer): sel_shape: tuple[int, ...] selection: CoordinateSelectionNormalized sel_sort: npt.NDArray[np.intp] | None chunk_nitems_cumsum: npt.NDArray[np.intp] chunk_rixs: npt.NDArray[np.intp] chunk_mixs: tuple[npt.NDArray[np.intp], ...] shape: tuple[int, ...] dim_grids: tuple[DimensionGrid, ...] drop_axes: tuple[int, ...] def __init__( self, selection: CoordinateSelection, shape: tuple[int, ...], chunk_grid: ChunkGrid ) -> None: dim_grids = chunk_grid._dimensions cdata_shape: tuple[int, ...] if shape == (): cdata_shape = (1,) else: cdata_shape = tuple(g.nchunks for g in dim_grids) nchunks = math.prod(cdata_shape) # some initial normalization selection_normalized = cast("CoordinateSelectionNormalized", ensure_tuple(selection)) selection_normalized = tuple( np.asarray([i], dtype=np.intp) if is_integer(i) else i for i in selection_normalized ) selection_normalized = cast( "CoordinateSelectionNormalized", replace_lists(selection_normalized) ) # validation if not is_coordinate_selection(selection_normalized, shape): raise IndexError( "invalid coordinate selection; expected one integer " "(coordinate) array per dimension of the target array, " f"got {selection!r}" ) # Optimization for a single sorted, in-bounds, 1-D integer coordinate array over a # regular (fixed-size) chunk grid. The general path below makes several full passes over # the flat selection. For sufficiently dense selections, locating the internal chunk # boundaries with searchsorted is cheaper. if len(selection_normalized) == 1: (coords,) = selection_normalized g0 = dim_grids[0] # coords is an integer ndarray here: is_coordinate_selection() validated above, and # the normalization turned ints/lists into arrays. Only the sorted-1D-over-regular-grid # shape is special-cased; everything else falls through to the general path below. if ( isinstance(g0, FixedDimension) and g0.size > 0 # guard the divide below and coords.ndim == 1 and coords.size > 0 and coords[0] >= 0 and coords[-1] < shape[0] and coords[0] <= coords[-1] ): size = g0.size first = int(coords[0]) // size last = int(coords[-1]) // size chunk_span = last - first + 1 # searchsorted does O(log n) work per chunk in the spanned range. Fall through # when directly processing the coordinates is expected to be cheaper. if ( chunk_span * coords.size.bit_length() < coords.size and bool((coords[:-1] <= coords[1:]).all()) # sorted -> grouped by chunk ): # Search only internal boundaries. Derive the first and last counts from the # selection bounds so that the boundary after the last chunk cannot overflow. if first == last: counts = np.array([coords.size], dtype=np.intp) else: edges = np.arange(first + 1, last + 1, dtype=coords.dtype) * size cuts = np.searchsorted(coords, edges) counts = np.diff(cuts, prepend=0, append=coords.size) chunk_rixs = (first + np.nonzero(counts)[0]).astype(np.intp) chunk_nitems = np.zeros(nchunks, dtype=np.intp) chunk_nitems[first : last + 1] = counts chunk_nitems_cumsum = np.cumsum(chunk_nitems) object.__setattr__(self, "sel_shape", coords.shape) object.__setattr__(self, "selection", (coords,)) object.__setattr__(self, "sel_sort", None) object.__setattr__(self, "chunk_nitems_cumsum", chunk_nitems_cumsum) object.__setattr__(self, "chunk_rixs", chunk_rixs) object.__setattr__(self, "chunk_mixs", (chunk_rixs,)) object.__setattr__(self, "dim_grids", dim_grids) object.__setattr__(self, "shape", coords.shape) object.__setattr__(self, "drop_axes", ()) return # handle wraparound, boundscheck for dim_sel, dim_len in zip(selection_normalized, shape, strict=True): # handle wraparound wraparound_indices(dim_sel, dim_len) # handle out of bounds boundscheck_indices(dim_sel, dim_len) # compute chunk index for each point in the selection chunks_multi_index = tuple( g.indices_to_chunks(dim_sel) for (dim_sel, g) in zip(selection_normalized, dim_grids, strict=True) ) # broadcast selection - this will raise error if array dimensions don't match selection_broadcast = tuple(np.broadcast_arrays(*selection_normalized)) chunks_multi_index_broadcast = np.broadcast_arrays(*chunks_multi_index) # remember shape of selection, because we will flatten indices for processing sel_shape = selection_broadcast[0].shape or (1,) # flatten selection selection_broadcast = tuple(dim_sel.reshape(-1) for dim_sel in selection_broadcast) chunks_multi_index_broadcast = tuple( dim_chunks.reshape(-1) for dim_chunks in chunks_multi_index_broadcast ) # ravel chunk indices chunks_raveled_indices = np.ravel_multi_index( chunks_multi_index_broadcast, dims=cdata_shape ) # group points by chunk if np.any(np.diff(chunks_raveled_indices) < 0): # optimisation, only sort if needed sel_sort = np.argsort(chunks_raveled_indices) selection_broadcast = tuple(dim_sel[sel_sort] for dim_sel in selection_broadcast) else: sel_sort = None shape = selection_broadcast[0].shape or (1,) # precompute number of selected items for each chunk chunk_nitems = np.bincount(chunks_raveled_indices, minlength=nchunks) chunk_nitems_cumsum = np.cumsum(chunk_nitems) # locate the chunks we need to process chunk_rixs = np.nonzero(chunk_nitems)[0] # unravel chunk indices chunk_mixs = np.unravel_index(chunk_rixs, cdata_shape) object.__setattr__(self, "sel_shape", sel_shape) object.__setattr__(self, "selection", selection_broadcast) object.__setattr__(self, "sel_sort", sel_sort) object.__setattr__(self, "chunk_nitems_cumsum", chunk_nitems_cumsum) object.__setattr__(self, "chunk_rixs", chunk_rixs) object.__setattr__(self, "chunk_mixs", chunk_mixs) object.__setattr__(self, "dim_grids", dim_grids) object.__setattr__(self, "shape", shape) object.__setattr__(self, "drop_axes", ()) def __iter__(self) -> Iterator[ChunkProjection]: # iterate over chunks for i, chunk_rix in enumerate(self.chunk_rixs): chunk_coords = tuple(m[i] for m in self.chunk_mixs) if chunk_rix == 0: start = 0 else: start = self.chunk_nitems_cumsum[chunk_rix - 1] stop = self.chunk_nitems_cumsum[chunk_rix] out_selection: slice | npt.NDArray[np.intp] if self.sel_sort is None: out_selection = slice(start, stop) else: out_selection = self.sel_sort[start:stop] chunk_offsets = tuple( g.chunk_offset(dim_chunk_ix) for dim_chunk_ix, g in zip(chunk_coords, self.dim_grids, strict=True) ) chunk_selection = tuple( dim_sel[start:stop] - dim_chunk_offset for (dim_sel, dim_chunk_offset) in zip(self.selection, chunk_offsets, strict=True) ) is_complete_chunk = False # TODO yield ChunkProjection(chunk_coords, chunk_selection, out_selection, is_complete_chunk) @dataclass(frozen=True) class MaskIndexer(CoordinateIndexer): def __init__( self, selection: MaskSelection, shape: tuple[int, ...], chunk_grid: ChunkGrid ) -> None: # some initial normalization selection_normalized = cast("tuple[MaskSelection]", ensure_tuple(selection)) selection_normalized = cast("tuple[MaskSelection]", replace_lists(selection_normalized)) # validation if not is_mask_selection(selection_normalized, shape): raise IndexError( "invalid mask selection; expected one Boolean (mask)" f"array with the same shape as the target array, got {selection_normalized!r}" ) # convert to indices selection_indices = np.nonzero(selection_normalized[0]) # delegate the rest to superclass super().__init__(selection_indices, shape, chunk_grid) @dataclass(frozen=True) class VIndex: array: AnyArray # TODO: develop Array generic and move zarr.Array[np.intp] | zarr.Array[np.bool_] to ArrayOfIntOrBool def __getitem__( self, selection: CoordinateSelection | MaskSelection | AnyArray ) -> NDArrayLikeOrScalar: from zarr.core.array import Array # if input is a Zarr array, we materialize it now. if isinstance(selection, Array): selection = _zarr_array_to_int_or_bool_array(selection) fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) if is_coordinate_selection(new_selection, self.array.shape): return self.array.get_coordinate_selection(new_selection, fields=fields) elif is_mask_selection(new_selection, self.array.shape): return self.array.get_mask_selection(new_selection, fields=fields) else: msg = ( "unsupported selection type for vectorized indexing; only " "coordinate selection (tuple of integer arrays) and mask selection " f"(single Boolean array) are supported; got {new_selection!r}" ) raise VindexInvalidSelectionError(msg) def __setitem__( self, selection: CoordinateSelection | MaskSelection, value: npt.ArrayLike ) -> None: fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) if is_coordinate_selection(new_selection, self.array.shape): self.array.set_coordinate_selection(new_selection, value, fields=fields) elif is_mask_selection(new_selection, self.array.shape): self.array.set_mask_selection(new_selection, value, fields=fields) else: msg = ( "unsupported selection type for vectorized indexing; only " "coordinate selection (tuple of integer arrays) and mask selection " f"(single Boolean array) are supported; got {new_selection!r}" ) raise VindexInvalidSelectionError(msg) @dataclass(frozen=True) class AsyncVIndex[T_ArrayMetadata: (ArrayV2Metadata, ArrayV3Metadata)]: array: AsyncArray[T_ArrayMetadata] # TODO: develop Array generic and move zarr.Array[np.intp] | zarr.Array[np.bool_] to ArrayOfIntOrBool async def getitem( self, selection: CoordinateSelection | MaskSelection | AnyArray ) -> NDArrayLikeOrScalar: # TODO deduplicate these internals with the sync version of getitem # TODO requires solving this circular sync issue: https://github.com/zarr-developers/zarr-python/pull/3083#discussion_r2230737448 from zarr.core.array import Array # if input is a Zarr array, we materialize it now. if isinstance(selection, Array): selection = _zarr_array_to_int_or_bool_array(selection) fields, new_selection = pop_fields(selection) new_selection = ensure_tuple(new_selection) new_selection = replace_lists(new_selection) if is_coordinate_selection(new_selection, self.array.shape): return await self.array.get_coordinate_selection(new_selection, fields=fields) elif is_mask_selection(new_selection, self.array.shape): return await self.array.get_mask_selection(new_selection, fields=fields) else: msg = ( "unsupported selection type for vectorized indexing; only " "coordinate selection (tuple of integer arrays) and mask selection " f"(single Boolean array) are supported; got {new_selection!r}" ) raise VindexInvalidSelectionError(msg) def check_fields(fields: Fields | None, dtype: np.dtype[Any]) -> np.dtype[Any]: # early out if fields is None: return dtype # check type if not isinstance(fields, str | list | tuple): raise IndexError( f"'fields' argument must be a string or list of strings; found {type(fields)!r}" ) if fields: if dtype.names is None: raise IndexError("invalid 'fields' argument, array does not have any fields") try: if isinstance(fields, str): # single field selection out_dtype = dtype[fields] else: # multiple field selection out_dtype = np.dtype([(f, dtype[f]) for f in fields]) except KeyError as e: raise IndexError(f"invalid 'fields' argument, field not found: {e!r}") from e else: return out_dtype else: return dtype def check_no_multi_fields(fields: Fields | None) -> Fields | None: if isinstance(fields, list): if len(fields) == 1: return fields[0] elif len(fields) > 1: raise IndexError("multiple fields are not supported for this operation") return fields def pop_fields(selection: SelectionWithFields) -> tuple[Fields | None, Selection]: if isinstance(selection, str): # single field selection return selection, () elif not isinstance(selection, tuple): # single selection item, no fields # leave selection as-is return None, cast("Selection", selection) else: # multiple items, split fields from selection items fields: Fields = [f for f in selection if isinstance(f, str)] fields = fields[0] if len(fields) == 1 else fields selection_tuple = tuple(s for s in selection if not isinstance(s, str)) selection = cast( "Selection", selection_tuple[0] if len(selection_tuple) == 1 else selection_tuple ) return fields, selection def make_slice_selection(selection: Any) -> list[slice]: ls: list[slice] = [] for dim_selection in selection: if is_integer(dim_selection): ls.append(slice(int(dim_selection), int(dim_selection) + 1, 1)) elif isinstance(dim_selection, np.ndarray): if len(dim_selection) == 1: ls.append(slice(int(dim_selection[0]), int(dim_selection[0]) + 1, 1)) else: raise ArrayIndexError else: ls.append(dim_selection) return ls def decode_morton(z: int, chunk_shape: tuple[int, ...]) -> tuple[int, ...]: # Inspired by compressed morton code as implemented in Neuroglancer # https://github.com/google/neuroglancer/blob/master/src/neuroglancer/datasource/precomputed/volume.md#compressed-morton-code bits = tuple((c - 1).bit_length() for c in chunk_shape) max_coords_bits = max(bits) input_bit = 0 input_value = z out = [0] * len(chunk_shape) for coord_bit in range(max_coords_bits): for dim in range(len(chunk_shape)): if coord_bit < bits[dim]: bit = (input_value >> input_bit) & 1 out[dim] |= bit << coord_bit input_bit += 1 return tuple(out) def decode_morton_vectorized( z: npt.NDArray[np.intp], chunk_shape: tuple[int, ...] ) -> npt.NDArray[np.intp]: """Vectorized Morton code decoding for multiple z values. Parameters ---------- z : ndarray 1D array of Morton codes to decode. chunk_shape : tuple of int Shape defining the coordinate space. Returns ------- ndarray 2D array of shape (len(z), len(chunk_shape)) containing decoded coordinates. """ n_dims = len(chunk_shape) bits = tuple((c - 1).bit_length() for c in chunk_shape) max_coords_bits = max(bits) if bits else 0 out = np.zeros((len(z), n_dims), dtype=np.intp) input_bit = 0 for coord_bit in range(max_coords_bits): for dim in range(n_dims): if coord_bit < bits[dim]: # Extract bit at position input_bit from all z values bit_values = (z >> input_bit) & 1 # Place bit at coord_bit position in dimension dim out[:, dim] |= bit_values << coord_bit input_bit += 1 return out @lru_cache(maxsize=16) def _morton_order(shape: tuple[int, ...]) -> npt.NDArray[np.intp]: n_total = product(shape) n_dims = len(shape) if n_total == 0: out = np.empty((0, n_dims), dtype=np.intp) out.flags.writeable = False return out # Ceiling hypercube: smallest power-of-2 hypercube whose Morton codes span # all valid coordinates in shape. (c-1).bit_length() gives the number # of bits needed to index c values (0 for singleton dims). n_z = 2**total_bits # is the size of this hypercube. total_bits = sum((c - 1).bit_length() for c in shape) n_z = 1 << total_bits if total_bits > 0 else 1 # Decode all Morton codes in the ceiling hypercube, then filter to valid coords. # This is fully vectorized. For shapes with n_z >> n_total (e.g. (33,33,33): # n_z=262144, n_total=35937), consider the argsort strategy below. order: npt.NDArray[np.intp] if n_z <= 4 * n_total: # Ceiling strategy: decode all n_z codes vectorized, filter in-bounds. # Works well when the overgeneration ratio n_z/n_total is small (≤4). z_values = np.arange(n_z, dtype=np.intp) all_coords = decode_morton_vectorized(z_values, shape) shape_arr = np.array(shape, dtype=np.intp) valid_mask = np.all(all_coords < shape_arr, axis=1) order = all_coords[valid_mask] else: # Argsort strategy: enumerate all n_total valid coordinates directly, # encode each to a Morton code, then sort by code. Avoids the 8x or # larger overgeneration penalty for near-miss shapes like (33,33,33). # Cost: O(n_total * bits) encode + O(n_total log n_total) sort, # vs O(n_z * bits) = O(8 * n_total * bits) for ceiling. grids = np.meshgrid(*[np.arange(c, dtype=np.intp) for c in shape], indexing="ij") all_coords = np.stack([g.ravel() for g in grids], axis=1) # Encode all coordinates to Morton codes (vectorized). bits_per_dim = tuple((c - 1).bit_length() for c in shape) max_coord_bits = max(bits_per_dim) z_codes = np.zeros(n_total, dtype=np.intp) output_bit = 0 for coord_bit in range(max_coord_bits): for dim in range(n_dims): if coord_bit < bits_per_dim[dim]: z_codes |= ((all_coords[:, dim] >> coord_bit) & 1) << output_bit output_bit += 1 sort_idx: npt.NDArray[np.intp] = np.argsort(z_codes, kind="stable") order = np.asarray(all_coords[sort_idx], dtype=np.intp) order.flags.writeable = False return order @lru_cache(maxsize=16) def morton_order_coords(shape: tuple[int, ...]) -> tuple[tuple[int, ...], ...]: # The grid coordinates in Morton (Z) order, as a cached sequence. The # coordinate set of a finite grid has a known length and is reused in full on # every shard write, so it is built once (vectorized, via `_morton_order`) and # cached per shape rather than recomputed. Indexable and `len`-able; iterate it # directly where an iterator is needed. # # `.tolist()` converts the whole array to native Python ints in one C-level # call; building the tuples row-by-row with `int(x)` is ~9x slower. return tuple(map(tuple, _morton_order(shape).tolist())) @lru_cache(maxsize=16) def _lexicographic_order(shape: tuple[int, ...]) -> npt.NDArray[np.intp]: # Lexicographic (C-order) coordinates, computed vectorized and cached so that # the sharding codec's per-shard chunk grid is not rebuilt on every call. # Equivalent to `np.array(list(np.ndindex(shape)))` but without the # Python-level iteration over every coordinate. n_dims = len(shape) if n_dims == 0: # A 0-d shard holds a single chunk addressed by the empty coordinate, so # the coordinate array has one row and zero columns. np.indices(()) cannot # express this, so build it directly. Matches list(np.ndindex(())) == [()]. order = np.empty((1, 0), dtype=np.intp) else: order = np.indices(shape, dtype=np.intp).reshape(n_dims, -1).T order.flags.writeable = False return order @lru_cache(maxsize=16) def lexicographic_order_coords(shape: tuple[int, ...]) -> tuple[tuple[int, ...], ...]: # The grid coordinates in lexicographic (row-major / C) order, as a cached # sequence. The coordinate set of a finite grid has a known length and is # reused in full on every shard write, so it is built once (vectorized, via # `_lexicographic_order`) and cached per shape. Indexable and `len`-able; # iterate it directly where an iterator is needed. # # `.tolist()` converts the whole array to native Python ints in one C-level # call; building the tuples row-by-row with `int(x)` is ~9x slower. return tuple(map(tuple, _lexicographic_order(shape).tolist())) @lru_cache(maxsize=16) def colexicographic_order_coords(shape: tuple[int, ...]) -> tuple[tuple[int, ...], ...]: # The grid coordinates in colexicographic (column-major / F) order, as a cached # sequence: the first axis varies fastest. Equivalent to reversing each axis, # taking lexicographic order, and reversing the coordinates back. Cached per # shape like its siblings so shard writes don't rebuild it. return tuple(c[::-1] for c in lexicographic_order_coords(shape[::-1])) def get_indexer( selection: SelectionWithFields, shape: tuple[int, ...], chunk_grid: ChunkGrid ) -> Indexer: _, pure_selection = pop_fields(selection) if is_pure_fancy_indexing(pure_selection, len(shape)): new_selection = ensure_tuple(selection) new_selection = replace_lists(new_selection) if is_coordinate_selection(new_selection, shape): return CoordinateIndexer(cast("CoordinateSelection", selection), shape, chunk_grid) elif is_mask_selection(new_selection, shape): return MaskIndexer(cast("MaskSelection", selection), shape, chunk_grid) else: msg = ( "unsupported selection type for vectorized indexing; only " "coordinate selection (tuple of integer arrays) and mask selection " f"(single Boolean array) are supported; got {new_selection!r}" ) raise VindexInvalidSelectionError(msg) elif is_pure_orthogonal_indexing(pure_selection, len(shape)): return OrthogonalIndexer(cast("OrthogonalSelection", selection), shape, chunk_grid) else: return BasicIndexer(cast("BasicSelection", selection), shape, chunk_grid) zarr-python-3.3.0/src/zarr/core/metadata/000077500000000000000000000000001523267620000202725ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/core/metadata/__init__.py000066400000000000000000000006041523267620000224030ustar00rootroot00000000000000from .v2 import ArrayV2Metadata, ArrayV2MetadataDict from .v3 import ArrayMetadataJSON_V3, ArrayV3Metadata ArrayMetadata = ArrayV2Metadata | ArrayV3Metadata type ArrayMetadataDict = ArrayV2MetadataDict | ArrayMetadataJSON_V3 __all__ = [ "ArrayMetadata", "ArrayMetadataDict", "ArrayMetadataJSON_V3", "ArrayV2Metadata", "ArrayV2MetadataDict", "ArrayV3Metadata", ] zarr-python-3.3.0/src/zarr/core/metadata/common.py000066400000000000000000000004051523267620000221330ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING if TYPE_CHECKING: from zarr.core.common import JSON def parse_attributes(data: dict[str, JSON] | None) -> dict[str, JSON]: if data is None: return {} return dict(data) zarr-python-3.3.0/src/zarr/core/metadata/io.py000066400000000000000000000061721523267620000212610ustar00rootroot00000000000000from __future__ import annotations import asyncio from typing import TYPE_CHECKING from zarr.abc.store import set_or_delete from zarr.core.buffer.core import default_buffer_prototype from zarr.errors import ContainsArrayError from zarr.storage._common import StorePath, ensure_no_existing_node if TYPE_CHECKING: from zarr.core.common import ZarrFormat from zarr.core.group import GroupMetadata from zarr.core.metadata import ArrayMetadata def _build_parents(store_path: StorePath, zarr_format: ZarrFormat) -> dict[str, GroupMetadata]: from zarr.core.group import GroupMetadata path = store_path.path if not path: return {} required_parts = path.split("/")[:-1] # the root group parents = {"": GroupMetadata(zarr_format=zarr_format)} for i, part in enumerate(required_parts): parent_path = "/".join(required_parts[:i] + [part]) parents[parent_path] = GroupMetadata(zarr_format=zarr_format) return parents async def save_metadata( store_path: StorePath, metadata: ArrayMetadata | GroupMetadata, ensure_parents: bool = False ) -> None: """Asynchronously save the array or group metadata. Parameters ---------- store_path : StorePath Location to save metadata. metadata : ArrayMetadata | GroupMetadata Metadata to save. ensure_parents : bool, optional Create any missing parent groups, and check no existing parents are arrays. Raises ------ ValueError """ to_save = metadata.to_buffer_dict(default_buffer_prototype()) set_awaitables = [set_or_delete(store_path / key, value) for key, value in to_save.items()] if ensure_parents: # To enable zarr.create(store, path="a/b/c"), we need to create all the intermediate groups. parents = _build_parents(store_path, metadata.zarr_format) ensure_array_awaitables = [] for parent_path, parent_metadata in parents.items(): parent_store_path = StorePath(store_path.store, parent_path) # Error if an array already exists at any parent location. Only groups can have child nodes. ensure_array_awaitables.append( ensure_no_existing_node( parent_store_path, parent_metadata.zarr_format, node_type="array" ) ) set_awaitables.extend( [ (parent_store_path / key).set_if_not_exists(value) for key, value in parent_metadata.to_buffer_dict( default_buffer_prototype() ).items() ] ) # Checks for parent arrays must happen first, before any metadata is modified try: await asyncio.gather(*ensure_array_awaitables) except ContainsArrayError as e: # clear awaitables to avoid RuntimeWarning: coroutine was never awaited for awaitable in set_awaitables: awaitable.close() raise ValueError( f"A parent of {store_path} is an array - only groups may have child nodes." ) from e await asyncio.gather(*set_awaitables) zarr-python-3.3.0/src/zarr/core/metadata/v2.py000066400000000000000000000324531523267620000212020ustar00rootroot00000000000000from __future__ import annotations import json import warnings from collections.abc import Iterable, Sequence from functools import cached_property from typing import TYPE_CHECKING, Any, TypedDict, cast from zarr.abc.metadata import Metadata from zarr.abc.numcodec import Numcodec, _is_numcodec from zarr.core.dtype import get_data_type_from_json from zarr.core.dtype.common import OBJECT_CODEC_IDS, DTypeSpec_V2 from zarr.errors import ZarrUserWarning from zarr.registry import get_numcodec if TYPE_CHECKING: from typing import Literal, Self import numpy.typing as npt from zarr.core.buffer import Buffer, BufferPrototype from zarr.core.chunk_grids import ChunkGrid from zarr.core.dtype.wrapper import ( TBaseDType, TBaseScalar, ZDType, ) from dataclasses import dataclass, field, fields, replace import numpy as np from zarr.core._json import json_to_buffer from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.chunk_key_encodings import parse_separator from zarr.core.common import ( JSON, ZARRAY_JSON, ZATTRS_JSON, MemoryOrder, parse_shapelike, ) from zarr.core.config import config, parse_indexing_order from zarr.core.metadata.common import parse_attributes class ArrayV2MetadataDict(TypedDict): """ A typed dictionary model for Zarr format 2 metadata. """ zarr_format: Literal[2] attributes: dict[str, JSON] # Union of acceptable types for v2 compressors type CompressorLikev2 = dict[str, JSON] | Numcodec | None @dataclass(frozen=True, kw_only=True) class ArrayV2Metadata(Metadata): shape: tuple[int, ...] chunks: tuple[int, ...] dtype: ZDType[TBaseDType, TBaseScalar] fill_value: int | float | str | bytes | None = None order: MemoryOrder = "C" filters: tuple[Numcodec, ...] | None = None dimension_separator: Literal[".", "/"] = "." compressor: Numcodec | None attributes: dict[str, JSON] = field(default_factory=dict) zarr_format: Literal[2] = field(init=False, default=2) def __init__( self, *, shape: tuple[int, ...], dtype: ZDType[TBaseDType, TBaseScalar], chunks: tuple[int, ...], fill_value: Any, order: MemoryOrder, dimension_separator: Literal[".", "/"] = ".", compressor: CompressorLikev2 = None, filters: Iterable[Numcodec | dict[str, JSON]] | None = None, attributes: dict[str, JSON] | None = None, ) -> None: """ Metadata for a Zarr format 2 array. """ shape_parsed = parse_shapelike(shape) chunks_parsed = parse_shapelike(chunks) compressor_parsed = parse_compressor(compressor) order_parsed = parse_indexing_order(order) dimension_separator_parsed = parse_separator(dimension_separator) filters_parsed = parse_filters(filters) fill_value_parsed: TBaseScalar | None if fill_value is not None: fill_value_parsed = dtype.cast_scalar(fill_value) else: fill_value_parsed = fill_value attributes_parsed = parse_attributes(attributes) object.__setattr__(self, "shape", shape_parsed) object.__setattr__(self, "dtype", dtype) object.__setattr__(self, "chunks", chunks_parsed) object.__setattr__(self, "compressor", compressor_parsed) object.__setattr__(self, "order", order_parsed) object.__setattr__(self, "dimension_separator", dimension_separator_parsed) object.__setattr__(self, "filters", filters_parsed) object.__setattr__(self, "fill_value", fill_value_parsed) object.__setattr__(self, "attributes", attributes_parsed) # ensure that the metadata document is consistent _ = parse_metadata(self) @property def ndim(self) -> int: return len(self.shape) @cached_property def chunk_grid(self) -> ChunkGrid: """Backwards-compatible chunk grid property. !!! warning "Deprecated" Access the chunk grid via the array layer instead. This property will be removed in a future release. """ from zarr.core.chunk_grids import ChunkGrid warnings.warn( "ArrayV2Metadata.chunk_grid is deprecated. " "Use ChunkGrid.from_metadata(metadata) instead.", DeprecationWarning, stacklevel=2, ) return ChunkGrid.from_sizes(self.shape, tuple(self.chunks)) @property def shards(self) -> tuple[int, ...] | None: return None def to_buffer_dict(self, prototype: BufferPrototype) -> dict[str, Buffer]: zarray_dict = self.to_dict() zattrs_dict = zarray_dict.pop("attributes", {}) indent = config.get("json_indent") return { ZARRAY_JSON: json_to_buffer(zarray_dict, prototype=prototype, indent=indent), ZATTRS_JSON: json_to_buffer(zattrs_dict, prototype=prototype, indent=indent), } @classmethod def from_dict(cls, data: dict[str, Any]) -> ArrayV2Metadata: # Make a copy to protect the original from modification. _data = data.copy() # Check that the zarr_format attribute is correct. _ = parse_zarr_format(_data.pop("zarr_format")) # To resolve a numpy object dtype array, we need to search for an object codec, # which could be in filters or as a compressor. # we will reference a hard-coded collection of object codec ids for this search. _filters, _compressor = (data.get("filters"), data.get("compressor")) if _filters is not None: _filters = cast("tuple[dict[str, JSON], ...]", _filters) object_codec_id = get_object_codec_id(tuple(_filters) + (_compressor,)) else: object_codec_id = get_object_codec_id((_compressor,)) # we add a layer of indirection here around the dtype attribute of the array metadata # because we also need to know the object codec id, if any, to resolve the data type dtype_spec: DTypeSpec_V2 = { "name": data["dtype"], "object_codec_id": object_codec_id, } dtype = get_data_type_from_json(dtype_spec, zarr_format=2) _data["dtype"] = dtype fill_value_encoded = _data.get("fill_value") if fill_value_encoded is not None: fill_value = dtype.from_json_scalar(fill_value_encoded, zarr_format=2) _data["fill_value"] = fill_value # zarr v2 allowed arbitrary keys here. # We don't want the ArrayV2Metadata constructor to fail just because someone put an # extra key in the metadata. expected = {x.name for x in fields(cls)} expected |= {"dtype", "chunks"} # check if `filters` is an empty sequence; if so use None instead and raise a warning filters = _data.get("filters") if ( isinstance(filters, Sequence) and not isinstance(filters, (str, bytes)) and len(filters) == 0 ): msg = ( "Found an empty list of filters in the array metadata document. " "This is contrary to the Zarr V2 specification, and will cause an error in the future. " "Use None (or Null in a JSON document) instead of an empty list of filters." ) warnings.warn(msg, ZarrUserWarning, stacklevel=1) _data["filters"] = None _data = {k: v for k, v in _data.items() if k in expected} return cls(**_data) def to_dict(self) -> dict[str, JSON]: zarray_dict = super().to_dict() if _is_numcodec(zarray_dict["compressor"]): codec_config = zarray_dict["compressor"].get_config() # Hotfix for https://github.com/zarr-developers/zarr-python/issues/2647 if codec_config["id"] == "zstd" and not codec_config.get("checksum", False): codec_config.pop("checksum") zarray_dict["compressor"] = codec_config if zarray_dict["filters"] is not None: raw_filters = zarray_dict["filters"] # TODO: remove this when we can stratically type the output JSON data structure # entirely if not isinstance(raw_filters, list | tuple): raise TypeError("Invalid type for filters. Expected a list or tuple.") new_filters = [] for f in raw_filters: if _is_numcodec(f): new_filters.append(f.get_config()) else: new_filters.append(f) zarray_dict["filters"] = new_filters # serialize the fill value after dtype-specific JSON encoding if self.fill_value is not None: fill_value = self.dtype.to_json_scalar(self.fill_value, zarr_format=2) zarray_dict["fill_value"] = fill_value # pull the "name" attribute out of the dtype spec returned by self.dtype.to_json zarray_dict["dtype"] = self.dtype.to_json(zarr_format=2)["name"] return zarray_dict def __eq__(self, other: object) -> bool: # The default dataclass __eq__ compares fields directly, which is wrong for a NaN # fill_value: NaN != NaN under IEEE 754. Comparing the JSON-serialized form instead # treats matching NaN (and inf) fill values as equal. See issue #2929. if not isinstance(other, ArrayV2Metadata): return NotImplemented return self.to_dict() == other.to_dict() def __hash__(self) -> int: # Hash the JSON-serialized form to stay consistent with __eq__: equal metadata # must hash equally, which a field-based hash violates for a NaN fill_value. return hash(json.dumps(self.to_dict(), sort_keys=True)) def get_chunk_spec( self, _chunk_coords: tuple[int, ...], array_config: ArrayConfig, prototype: BufferPrototype ) -> ArraySpec: return ArraySpec( shape=self.chunks, dtype=self.dtype, fill_value=self.fill_value, config=array_config, prototype=prototype, ) def encode_chunk_key(self, chunk_coords: tuple[int, ...]) -> str: chunk_identifier = self.dimension_separator.join(map(str, chunk_coords)) return "0" if chunk_identifier == "" else chunk_identifier def update_shape(self, shape: tuple[int, ...]) -> Self: return replace(self, shape=shape) def update_attributes(self, attributes: dict[str, JSON]) -> Self: return replace(self, attributes=attributes) def parse_dtype(data: npt.DTypeLike) -> np.dtype[Any]: if isinstance(data, list): # this is a valid _VoidDTypeLike check data = [tuple(d) for d in data] return np.dtype(data) def parse_zarr_format(data: object) -> Literal[2]: if data == 2: return 2 raise ValueError(f"Invalid value. Expected 2. Got {data}.") def parse_filters(data: object) -> tuple[Numcodec, ...] | None: """ Parse a potential tuple of filters """ out: list[Numcodec] = [] if data is None: return data if isinstance(data, Iterable): for idx, val in enumerate(data): if _is_numcodec(val): out.append(val) elif isinstance(val, dict): out.append(get_numcodec(val)) # type: ignore[arg-type] else: msg = f"Invalid filter at index {idx}. Expected a numcodecs.abc.Codec or a dict representation of numcodecs.abc.Codec. Got {type(val)} instead." raise TypeError(msg) if len(out) == 0: # Per the v2 spec, an empty tuple is not allowed -- use None to express "no filters" return None else: return tuple(out) # take a single codec instance and wrap it in a tuple if _is_numcodec(data): return (data,) msg = f"Invalid filters. Expected None, an iterable of numcodecs.abc.Codec or dict representations of numcodecs.abc.Codec. Got {type(data)} instead." raise TypeError(msg) def parse_compressor(data: object) -> Numcodec | None: """ Parse a potential compressor. """ if data is None or _is_numcodec(data): return data if isinstance(data, dict): return get_numcodec(data) # type: ignore[arg-type] msg = f"Invalid compressor. Expected None, a numcodecs.abc.Codec, or a dict representation of a numcodecs.abc.Codec. Got {type(data)} instead." raise ValueError(msg) def parse_metadata(data: ArrayV2Metadata) -> ArrayV2Metadata: if (l_chunks := len(data.chunks)) != (l_shape := len(data.shape)): msg = ( f"The `shape` and `chunks` attributes must have the same length. " f"`chunks` has length {l_chunks}, but `shape` has length {l_shape}." ) raise ValueError(msg) return data def get_object_codec_id(maybe_object_codecs: Sequence[JSON]) -> str | None: """ Inspect a sequence of codecs / filters for an "object codec", i.e. a codec that can serialize object arrays to contiguous bytes. Zarr python maintains a hard-coded set of object codec ids. If any element from the input has an id that matches one of the hard-coded object codec ids, that id is returned immediately. """ object_codec_id = None for maybe_object_codec in maybe_object_codecs: if ( isinstance(maybe_object_codec, dict) and maybe_object_codec.get("id") in OBJECT_CODEC_IDS ): return cast("str", maybe_object_codec["id"]) return object_codec_id zarr-python-3.3.0/src/zarr/core/metadata/v3.py000066400000000000000000000700321523267620000211760ustar00rootroot00000000000000from __future__ import annotations import json from collections.abc import Iterable, Mapping, Sequence from dataclasses import dataclass, field, replace from typing import TYPE_CHECKING, Any, Final, Literal, NotRequired, TypeGuard, cast from typing_extensions import TypedDict from zarr.abc.codec import ArrayArrayCodec, ArrayBytesCodec, BytesBytesCodec, Codec from zarr.abc.metadata import Metadata from zarr.core._json import json_to_buffer from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer.core import default_buffer_prototype from zarr.core.chunk_grids import is_regular_nd from zarr.core.chunk_key_encodings import ( ChunkKeyEncoding, ChunkKeyEncodingLike, parse_chunk_key_encoding, ) from zarr.core.common import ( JSON, ZARR_JSON, DimensionNamesLike, NamedConfig, NamedRequiredConfig, compress_rle, expand_rle, parse_named_configuration, parse_shapelike, validate_rectilinear_edges, validate_rectilinear_kind, ) from zarr.core.config import config from zarr.core.dtype import VariableLengthUTF8, ZDType, get_data_type_from_json from zarr.core.dtype.common import check_dtype_spec_v3 from zarr.core.metadata.common import parse_attributes from zarr.errors import MetadataValidationError, NodeTypeValidationError, UnknownCodecError from zarr.registry import get_codec_class if TYPE_CHECKING: from typing import Self from zarr.core.buffer import Buffer, BufferPrototype from zarr.core.chunk_grids import ChunksTuple from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar def parse_zarr_format(data: object) -> Literal[3]: if data == 3: return 3 msg = f"Invalid value for 'zarr_format'. Expected '3'. Got '{data}'." raise MetadataValidationError(msg) def parse_node_type_array(data: object) -> Literal["array"]: if data == "array": return "array" msg = f"Invalid value for 'node_type'. Expected 'array'. Got '{data}'." raise NodeTypeValidationError(msg) def parse_codecs(data: object) -> tuple[Codec, ...]: out: tuple[Codec, ...] = () if not isinstance(data, Iterable): raise TypeError(f"Expected iterable, got {type(data)}") for c in data: if isinstance( c, ArrayArrayCodec | ArrayBytesCodec | BytesBytesCodec ): # Can't use Codec here because of mypy limitation out += (c,) else: name_parsed, _ = parse_named_configuration(c, require_configuration=False) try: out += (get_codec_class(name_parsed).from_dict(c),) except KeyError as e: raise UnknownCodecError(f"Unknown codec: {e.args[0]!r}") from e return out def validate_array_bytes_codec(codecs: tuple[Codec, ...]) -> ArrayBytesCodec: # ensure that we have at least one ArrayBytesCodec abcs: list[ArrayBytesCodec] = [codec for codec in codecs if isinstance(codec, ArrayBytesCodec)] if len(abcs) == 0: raise ValueError("At least one ArrayBytesCodec is required.") elif len(abcs) > 1: raise ValueError("Only one ArrayBytesCodec is allowed.") return abcs[0] def validate_codecs(codecs: tuple[Codec, ...], dtype: ZDType[TBaseDType, TBaseScalar]) -> None: """Check that the codecs are valid for the given dtype""" from zarr.codecs.sharding import ShardingCodec abc = validate_array_bytes_codec(codecs) # Recursively resolve array-bytes codecs within sharding codecs while isinstance(abc, ShardingCodec): abc = validate_array_bytes_codec(abc.codecs) # we need to have special codecs if we are decoding vlen strings or bytestrings # TODO: use codec ID instead of class name codec_class_name = abc.__class__.__name__ # TODO: Fix typing here if isinstance(dtype, VariableLengthUTF8) and not codec_class_name == "VLenUTF8Codec": # type: ignore[unreachable] raise ValueError( f"For string dtype, ArrayBytesCodec must be `VLenUTF8Codec`, got `{codec_class_name}`." ) def parse_dimension_names(data: object) -> tuple[str | None, ...] | None: if data is None: return data elif isinstance(data, Iterable) and all(isinstance(x, type(None) | str) for x in data): return tuple(data) else: msg = f"Expected either None or an iterable of str, got {type(data)}" raise TypeError(msg) def parse_storage_transformers(data: object) -> tuple[dict[str, JSON], ...]: """ Parse storage_transformers. Zarr python cannot use storage transformers at this time, so this function doesn't attempt to validate them. """ if data is None: return () if isinstance(data, Iterable): if len(tuple(data)) >= 1: return data # type: ignore[return-value] else: return () raise TypeError( f"Invalid storage_transformers. Expected an iterable of dicts. Got {type(data)} instead." ) class AllowedExtraField(TypedDict, extra_items=JSON): # type: ignore[call-arg] """ This class models allowed extra fields in array metadata. They must have ``must_understand`` set to ``False``, and may contain arbitrary additional JSON data. """ must_understand: Literal[False] def check_allowed_extra_field(data: object) -> TypeGuard[AllowedExtraField]: """ Check if the extra field is allowed according to the Zarr v3 spec. The object must be a mapping with a "must_understand" key set to `False`. """ return isinstance(data, Mapping) and data.get("must_understand") is False def parse_extra_fields( data: Mapping[str, AllowedExtraField] | None, ) -> dict[str, AllowedExtraField]: if data is None: return {} else: conflict_keys = ARRAY_METADATA_KEYS & set(data.keys()) if len(conflict_keys) > 0: msg = ( "Invalid extra fields. " "The following keys: " f"{sorted(conflict_keys)} " "are invalid because they collide with keys reserved for use by the " "array metadata document." ) raise ValueError(msg) return dict(data) # JSON type for a single dimension's rectilinear spec: # bare int (uniform shorthand), or list of ints / [value, count] RLE pairs. RectilinearDimSpecJSON = int | list[int | list[int]] class RegularChunkGridMetadataConfig(TypedDict): chunk_shape: Sequence[int] class RectilinearChunkGridMetadataConfig(TypedDict): kind: Literal["inline"] chunk_shapes: Sequence[RectilinearDimSpecJSON] RegularChunkGridMetadataJSON = NamedRequiredConfig[ Literal["regular"], RegularChunkGridMetadataConfig ] RectilinearChunkGridMetadataJSON = NamedRequiredConfig[ Literal["rectilinear"], RectilinearChunkGridMetadataConfig ] def _parse_chunk_shape(chunk_shape: Iterable[int]) -> tuple[int, ...]: """Validate and normalize a regular chunk shape. Delegates to ``_validate_chunk_shapes`` — a regular chunk shape is just a sequence of bare ints (one per dimension), each of which must be >= 1. """ result = _validate_chunk_shapes(tuple(chunk_shape)) # Regular grids only have bare ints — cast is safe after validation return cast(tuple[int, ...], result) def _validate_chunk_shapes( chunk_shapes: Sequence[int | Sequence[int]], ) -> tuple[int | tuple[int, ...], ...]: """Validate per-dimension chunk specifications. Each element is either a bare ``int`` (regular step size, must be >= 1) or a sequence of explicit edge lengths (all must be >= 1, non-empty). """ result: list[int | tuple[int, ...]] = [] for dim_idx, dim_spec in enumerate(chunk_shapes): if isinstance(dim_spec, int): if dim_spec < 1: raise ValueError( f"Dimension {dim_idx}: integer chunk edge length must be >= 1, got {dim_spec}" ) result.append(dim_spec) else: edges = tuple(dim_spec) if not edges: raise ValueError(f"Dimension {dim_idx} has no chunk edges.") bad = [i for i, e in enumerate(edges) if e < 1] if bad: raise ValueError( f"Dimension {dim_idx} has invalid edge lengths at indices {bad}: " f"{[edges[i] for i in bad]}" ) result.append(edges) return tuple(result) @dataclass(frozen=True, kw_only=True) class RegularChunkGridMetadata(Metadata): """Metadata-only description of a regular chunk grid. Stores just the chunk shape — no array extent, no runtime logic. This is what lives on ``ArrayV3Metadata.chunk_grid``. """ chunk_shape: tuple[int, ...] def __post_init__(self) -> None: chunk_shape_parsed = _parse_chunk_shape(self.chunk_shape) object.__setattr__(self, "chunk_shape", chunk_shape_parsed) @property def ndim(self) -> int: return len(self.chunk_shape) def to_dict(self) -> RegularChunkGridMetadataJSON: # type: ignore[override] return { "name": "regular", "configuration": {"chunk_shape": self.chunk_shape}, } @classmethod def from_dict(cls, data: RegularChunkGridMetadataJSON) -> Self: # type: ignore[override] parse_named_configuration(data, "regular") # validate name configuration = data["configuration"] return cls(chunk_shape=_parse_chunk_shape(configuration["chunk_shape"])) @dataclass(frozen=True, kw_only=True) class RectilinearChunkGridMetadata(Metadata): """Metadata-only description of a rectilinear chunk grid. Each element of ``chunk_shapes`` is either: - A bare ``int`` — a regular step size that repeats to cover the axis (the spec's single-integer shorthand). - A ``tuple[int, ...]`` — explicit per-chunk edge lengths (already expanded from any RLE encoding). This distinction matters for faithful round-tripping: a bare int serializes back as a bare int, while a single-element tuple serializes as a list. """ chunk_shapes: tuple[int | tuple[int, ...], ...] def __post_init__(self) -> None: if not config.get("array.rectilinear_chunks"): raise ValueError( "Rectilinear chunk grids are experimental and disabled by default. " "Enable them with: zarr.config.set({'array.rectilinear_chunks': True}) " "or set the environment variable ZARR_ARRAY__RECTILINEAR_CHUNKS=True" ) object.__setattr__(self, "chunk_shapes", _validate_chunk_shapes(self.chunk_shapes)) @property def ndim(self) -> int: return len(self.chunk_shapes) def to_dict(self) -> RectilinearChunkGridMetadataJSON: # type: ignore[override] serialized_dims: list[RectilinearDimSpecJSON] = [] for dim_spec in self.chunk_shapes: if isinstance(dim_spec, int): # Bare int shorthand — serialize as-is serialized_dims.append(dim_spec) else: rle = compress_rle(dim_spec) # Use RLE only if it's actually shorter if len(rle) < len(dim_spec): serialized_dims.append(rle) else: serialized_dims.append(list(dim_spec)) return { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": tuple(serialized_dims), }, } def update_shape( self, old_shape: tuple[int, ...], new_shape: tuple[int, ...] ) -> RectilinearChunkGridMetadata: """Return a new RectilinearChunkGridMetadata with edges adjusted for *new_shape*. - Bare-int dimensions stay as bare ints (they cover any extent). - Explicit-edge dimensions: if the new extent exceeds the sum of edges, a new chunk is appended to cover the additional extent. Otherwise edges are kept as-is (the spec allows trailing edges beyond the array extent). """ new_chunk_shapes: list[int | tuple[int, ...]] = [] for dim_spec, new_ext in zip(self.chunk_shapes, new_shape, strict=True): if isinstance(dim_spec, int): # Bare int covers any extent — no change needed new_chunk_shapes.append(dim_spec) else: edge_sum = sum(dim_spec) if new_ext > edge_sum: new_chunk_shapes.append((*dim_spec, new_ext - edge_sum)) else: new_chunk_shapes.append(dim_spec) return RectilinearChunkGridMetadata(chunk_shapes=tuple(new_chunk_shapes)) @classmethod def from_dict(cls, data: RectilinearChunkGridMetadataJSON) -> Self: # type: ignore[override] parse_named_configuration(data, "rectilinear") # validate name configuration = data["configuration"] validate_rectilinear_kind(configuration.get("kind")) raw_shapes = configuration["chunk_shapes"] parsed: list[int | tuple[int, ...]] = [] for dim_spec in raw_shapes: if isinstance(dim_spec, int): if dim_spec < 1: raise ValueError(f"Integer chunk edge length must be >= 1, got {dim_spec}") parsed.append(dim_spec) elif isinstance(dim_spec, list): parsed.append(tuple(expand_rle(dim_spec))) else: raise TypeError( f"Invalid chunk_shapes entry: expected int or list, got {type(dim_spec)}" ) return cls(chunk_shapes=tuple(parsed)) ChunkGridMetadata = RegularChunkGridMetadata | RectilinearChunkGridMetadata def create_chunk_grid_metadata( chunks: ChunksTuple, ) -> ChunkGridMetadata: """Construct a chunk grid metadata object from a normalized `ChunksTuple`. Regular chunks produce a `RegularChunkGridMetadata`. Rectilinear chunks produce a `RectilinearChunkGridMetadata`. Parameters ---------- chunks : ChunksTuple Normalized chunk specification, as returned by `normalize_chunks_nd` or `guess_chunks`. See Also -------- parse_chunk_grid : Deserialize a chunk grid from stored JSON metadata. """ if is_regular_nd(chunks): # If we know the chunks specification is regular, then we can take the first # chunk size for each dimension as the chunk shape. chunk_shape = tuple(int(dim_chunks[0]) for dim_chunks in chunks) return RegularChunkGridMetadata(chunk_shape=chunk_shape) else: return RectilinearChunkGridMetadata( chunk_shapes=tuple(tuple(int(x) for x in d) for d in chunks) ) def parse_chunk_grid( data: dict[str, JSON] | ChunkGridMetadata | NamedConfig[str, Any], ) -> ChunkGridMetadata: """Deserialize a chunk grid from stored JSON metadata or pass through an existing instance. See Also -------- create_chunk_grid_metadata : Construct a chunk grid from user-facing input. """ if isinstance(data, (RegularChunkGridMetadata, RectilinearChunkGridMetadata)): return data name, _ = parse_named_configuration(data) if name == "regular": return RegularChunkGridMetadata.from_dict(data) # type: ignore[arg-type] if name == "rectilinear": return RectilinearChunkGridMetadata.from_dict(data) # type: ignore[arg-type] raise ValueError(f"Unknown chunk grid name: {name!r}") class ArrayMetadataJSON_V3(TypedDict, extra_items=AllowedExtraField): # type: ignore[call-arg] """ A typed dictionary model for zarr v3 array metadata. Extra keys are permitted if they conform to ``AllowedExtraField`` (i.e. they are mappings with ``must_understand: false``). """ zarr_format: Literal[3] node_type: Literal["array"] data_type: str | NamedConfig[str, Mapping[str, JSON]] shape: tuple[int, ...] chunk_grid: str | NamedConfig[str, Mapping[str, JSON]] chunk_key_encoding: str | NamedConfig[str, Mapping[str, JSON]] fill_value: JSON codecs: tuple[str | NamedConfig[str, Mapping[str, JSON]], ...] attributes: NotRequired[Mapping[str, JSON]] storage_transformers: NotRequired[tuple[str | NamedConfig[str, Mapping[str, JSON]], ...]] dimension_names: NotRequired[tuple[str | None, ...]] """ The names of the fields of the array metadata document defined in the zarr V3 spec. """ ARRAY_METADATA_KEYS: Final[set[str]] = { "zarr_format", "node_type", "data_type", "shape", "chunk_grid", "chunk_key_encoding", "fill_value", "codecs", "attributes", "storage_transformers", "dimension_names", } @dataclass(frozen=True, kw_only=True) class ArrayV3Metadata(Metadata): shape: tuple[int, ...] data_type: ZDType[TBaseDType, TBaseScalar] chunk_grid: ChunkGridMetadata chunk_key_encoding: ChunkKeyEncoding fill_value: Any codecs: tuple[Codec, ...] attributes: dict[str, Any] = field(default_factory=dict) dimension_names: tuple[str | None, ...] | None = None zarr_format: Literal[3] = field(default=3, init=False) node_type: Literal["array"] = field(default="array", init=False) storage_transformers: tuple[dict[str, JSON], ...] extra_fields: dict[str, AllowedExtraField] def __init__( self, *, shape: Iterable[int], data_type: ZDType[TBaseDType, TBaseScalar], chunk_grid: dict[str, JSON] | ChunkGridMetadata | NamedConfig[str, Any], chunk_key_encoding: ChunkKeyEncodingLike, fill_value: object, codecs: Iterable[Codec | dict[str, JSON] | NamedConfig[str, Any] | str], attributes: dict[str, JSON] | None, dimension_names: DimensionNamesLike, storage_transformers: Iterable[dict[str, JSON]] | None = None, extra_fields: Mapping[str, AllowedExtraField] | None = None, ) -> None: """ Because the class is a frozen dataclass, we set attributes using object.__setattr__ """ shape_parsed = parse_shapelike(shape) chunk_grid_parsed = parse_chunk_grid(chunk_grid) chunk_key_encoding_parsed = parse_chunk_key_encoding(chunk_key_encoding) dimension_names_parsed = parse_dimension_names(dimension_names) # Note: relying on a type method is numpy-specific fill_value_parsed = data_type.cast_scalar(fill_value) attributes_parsed = parse_attributes(attributes) codecs_parsed_partial = parse_codecs(codecs) storage_transformers_parsed = parse_storage_transformers(storage_transformers) extra_fields_parsed = parse_extra_fields(extra_fields) array_spec = ArraySpec( shape=shape_parsed, dtype=data_type, fill_value=fill_value_parsed, config=ArrayConfig.from_dict({}), # TODO: config is not needed here. prototype=default_buffer_prototype(), # TODO: prototype is not needed here. ) # Thread the spec through evolution: each codec must be evolved against # the spec it will actually see at run-time, not the original array spec. # Earlier array->array codecs may transform the dtype (e.g. cast_value), # so the spec passed to later codecs must reflect those transformations. # Per-codec validate() must run before resolve_metadata(), since the # latter may rely on invariants the former checks (e.g. cast_value # rejects complex source dtypes that would otherwise crash _do_cast). evolved: list[Codec] = [] spec = array_spec for c in codecs_parsed_partial: evolved_codec = c.evolve_from_array_spec(spec) evolved_codec.validate(shape=spec.shape, dtype=spec.dtype, chunk_grid=chunk_grid_parsed) evolved.append(evolved_codec) spec = evolved_codec.resolve_metadata(spec) codecs_parsed = tuple(evolved) validate_codecs(codecs_parsed_partial, data_type) object.__setattr__(self, "shape", shape_parsed) object.__setattr__(self, "data_type", data_type) object.__setattr__(self, "chunk_grid", chunk_grid_parsed) object.__setattr__(self, "chunk_key_encoding", chunk_key_encoding_parsed) object.__setattr__(self, "codecs", codecs_parsed) object.__setattr__(self, "dimension_names", dimension_names_parsed) object.__setattr__(self, "fill_value", fill_value_parsed) object.__setattr__(self, "attributes", attributes_parsed) object.__setattr__(self, "storage_transformers", storage_transformers_parsed) object.__setattr__(self, "extra_fields", extra_fields_parsed) self._validate_metadata() def _validate_metadata(self) -> None: if len(self.shape) != self.chunk_grid.ndim: raise ValueError("`chunk_grid` and `shape` need to have the same number of dimensions.") if isinstance(self.chunk_grid, RectilinearChunkGridMetadata): validate_rectilinear_edges(self.chunk_grid.chunk_shapes, self.shape) if self.dimension_names is not None and len(self.shape) != len(self.dimension_names): raise ValueError( "`dimension_names` and `shape` need to have the same number of dimensions." ) if self.fill_value is None: raise ValueError("`fill_value` is required.") for codec in self.codecs: codec.validate(shape=self.shape, dtype=self.data_type, chunk_grid=self.chunk_grid) @property def ndim(self) -> int: return len(self.shape) @property def dtype(self) -> ZDType[TBaseDType, TBaseScalar]: return self.data_type # TODO: move these properties to the Array class. # They require knowledge of codecs (ShardingCodec) and don't belong on a metadata DTO. @property def chunks(self) -> tuple[int, ...]: if not isinstance(self.chunk_grid, RegularChunkGridMetadata): msg = ( "The `chunks` attribute is only defined for arrays using regular chunk grids. " "This array has a rectilinear chunk grid. Use `read_chunk_sizes` for general access." ) raise NotImplementedError(msg) from zarr.codecs.sharding import ShardingCodec if len(self.codecs) == 1 and isinstance(self.codecs[0], ShardingCodec): return self.codecs[0].chunk_shape return self.chunk_grid.chunk_shape @property def shards(self) -> tuple[int, ...] | None: from zarr.codecs.sharding import ShardingCodec if len(self.codecs) == 1 and isinstance(self.codecs[0], ShardingCodec): if not isinstance(self.chunk_grid, RegularChunkGridMetadata): msg = ( "The `shards` attribute is only defined for arrays using regular chunk grids. " "This array has a rectilinear chunk grid. Use `write_chunk_sizes` for general access." ) raise NotImplementedError(msg) return self.chunk_grid.chunk_shape return None @property def inner_codecs(self) -> tuple[Codec, ...]: from zarr.codecs.sharding import ShardingCodec if len(self.codecs) == 1 and isinstance(self.codecs[0], ShardingCodec): return self.codecs[0].codecs return self.codecs def encode_chunk_key(self, chunk_coords: tuple[int, ...]) -> str: return self.chunk_key_encoding.encode_chunk_key(chunk_coords) def to_buffer_dict(self, prototype: BufferPrototype) -> dict[str, Buffer]: indent = config.get("json_indent") return {ZARR_JSON: json_to_buffer(self.to_dict(), prototype=prototype, indent=indent)} @classmethod def from_dict(cls, data: dict[str, JSON]) -> Self: # make a copy because we are modifying the dict _data = data.copy() # check that the zarr_format attribute is correct _ = parse_zarr_format(_data.pop("zarr_format")) # check that the node_type attribute is correct _ = parse_node_type_array(_data.pop("node_type")) data_type_json = _data.pop("data_type") if not check_dtype_spec_v3(data_type_json): raise ValueError(f"Invalid data_type: {data_type_json!r}") data_type = get_data_type_from_json(data_type_json, zarr_format=3) # check that the fill value is consistent with the data type try: fill = _data.pop("fill_value") fill_value_parsed = data_type.from_json_scalar(fill, zarr_format=3) except ValueError as e: raise TypeError(f"Invalid fill_value: {fill!r}") from e # check if there are extra keys extra_keys = set(_data.keys()) - ARRAY_METADATA_KEYS allowed_extra_fields: dict[str, AllowedExtraField] = {} invalid_extra_fields = {} for key in extra_keys: val = _data[key] if check_allowed_extra_field(val): allowed_extra_fields[key] = val else: invalid_extra_fields[key] = val if len(invalid_extra_fields) > 0: msg = ( "Got a Zarr V3 metadata document with the following disallowed extra fields:" f"{sorted(invalid_extra_fields.keys())}." 'Extra fields are not allowed unless they are a dict with a "must_understand" key' "which is assigned the value `False`." ) raise MetadataValidationError(msg) # TODO: replace this with a real type check! _data_typed = cast(ArrayMetadataJSON_V3, _data) return cls( shape=_data_typed["shape"], chunk_grid=_data_typed["chunk_grid"], # type: ignore[arg-type] chunk_key_encoding=_data_typed["chunk_key_encoding"], # type: ignore[arg-type] codecs=_data_typed["codecs"], attributes=_data_typed.get("attributes", {}), # type: ignore[arg-type] dimension_names=_data_typed.get("dimension_names", None), fill_value=fill_value_parsed, data_type=data_type, extra_fields=allowed_extra_fields, storage_transformers=_data_typed.get("storage_transformers", ()), # type: ignore[arg-type] ) def to_dict(self) -> dict[str, JSON]: out_dict = super().to_dict() extra_fields = out_dict.pop("extra_fields") out_dict = out_dict | extra_fields # type: ignore[operator] out_dict["chunk_grid"] = self.chunk_grid.to_dict() out_dict["fill_value"] = self.data_type.to_json_scalar( self.fill_value, zarr_format=self.zarr_format ) if not isinstance(out_dict, dict): raise TypeError(f"Expected dict. Got {type(out_dict)}.") # if `dimension_names` is `None`, we do not include it in # the metadata document if out_dict["dimension_names"] is None: out_dict.pop("dimension_names") # TODO: replace the `to_dict` / `from_dict` on the `Metadata`` class with # to_json, from_json, and have ZDType inherit from `Metadata` # until then, we have this hack here, which relies on the fact that to_dict will pass through # any non-`Metadata` fields as-is. dtype_meta = out_dict["data_type"] if isinstance(dtype_meta, ZDType): out_dict["data_type"] = dtype_meta.to_json(zarr_format=3) # type: ignore[unreachable] return out_dict def __eq__(self, other: object) -> bool: # The default dataclass __eq__ compares fields directly, which is wrong for a NaN # fill_value: NaN != NaN under IEEE 754. Comparing the JSON-serialized form instead # treats matching NaN (and inf) fill values as equal. See issue #2929. if not isinstance(other, ArrayV3Metadata): return NotImplemented return self.to_dict() == other.to_dict() def __hash__(self) -> int: # Hash the JSON-serialized form to stay consistent with __eq__: equal metadata # must hash equally, which a field-based hash violates for a NaN fill_value. return hash(json.dumps(self.to_dict(), sort_keys=True)) def update_shape(self, shape: tuple[int, ...]) -> Self: chunk_grid = self.chunk_grid if isinstance(chunk_grid, RectilinearChunkGridMetadata): chunk_grid = chunk_grid.update_shape(self.shape, shape) return replace(self, shape=shape, chunk_grid=chunk_grid) def update_attributes(self, attributes: dict[str, JSON]) -> Self: return replace(self, attributes=attributes) zarr-python-3.3.0/src/zarr/core/sync.py000066400000000000000000000161221523267620000200420ustar00rootroot00000000000000from __future__ import annotations import asyncio import atexit import logging import os import threading from concurrent.futures import ThreadPoolExecutor, wait from typing import TYPE_CHECKING from zarr.core.config import config if TYPE_CHECKING: from collections.abc import AsyncIterator, Awaitable, Callable, Coroutine from typing import Any logger = logging.getLogger(__name__) # From https://github.com/fsspec/filesystem_spec/blob/master/fsspec/asyn.py iothread: list[threading.Thread | None] = [None] # dedicated IO thread loop: list[asyncio.AbstractEventLoop | None] = [ None ] # global event loop for any non-async instance _lock: threading.Lock | None = None # global lock placeholder _executor: ThreadPoolExecutor | None = None # global executor placeholder class SyncError(Exception): pass def _get_lock() -> threading.Lock: """Allocate or return a threading lock. The lock is allocated on first use to allow setting one lock per forked process. """ global _lock if not _lock: _lock = threading.Lock() return _lock def _get_executor() -> ThreadPoolExecutor: """Return Zarr Thread Pool Executor The executor is allocated on first use. """ global _executor if not _executor: max_workers = config.get("threading.max_workers", None) logger.debug("Creating Zarr ThreadPoolExecutor with max_workers=%s", max_workers) _executor = ThreadPoolExecutor(max_workers=max_workers, thread_name_prefix="zarr_pool") _get_loop().set_default_executor(_executor) return _executor def cleanup_resources() -> None: global _executor if _executor: _executor.shutdown(wait=True, cancel_futures=True) _executor = None if loop[0] is not None: with _get_lock(): # Stop the event loop safely loop[0].call_soon_threadsafe(loop[0].stop) # Stop loop from another thread if iothread[0] is not None: iothread[0].join(timeout=0.2) # Add a timeout to avoid hanging if iothread[0].is_alive(): logger.warning( "Thread did not finish cleanly; forcefully closing the event loop." ) # Forcefully close the event loop to release resources loop[0].close() # dereference the loop and iothread loop[0] = None iothread[0] = None atexit.register(cleanup_resources) def reset_resources_after_fork() -> None: """ Ensure that global resources are reset after a fork. Without this function, forked processes will retain invalid references to the parent process's resources. """ global loop, iothread, _executor # These lines are excluded from coverage because this function only runs in a child process, # which is not observed by the test coverage instrumentation. Despite the apparent lack of # test coverage, this function should be adequately tested by any test that uses Zarr IO with # multiprocessing. loop[0] = None # pragma: no cover iothread[0] = None # pragma: no cover _executor = None # pragma: no cover # this is only available on certain operating systems if hasattr(os, "register_at_fork"): os.register_at_fork(after_in_child=reset_resources_after_fork) async def _runner[T](coro: Coroutine[Any, Any, T]) -> T | BaseException: """ Await a coroutine and return the result of running it. If awaiting the coroutine raises an exception, the exception will be returned. """ try: return await coro except Exception as ex: return ex def sync[T]( coro: Coroutine[Any, Any, T], loop: asyncio.AbstractEventLoop | None = None, timeout: float | None = None, ) -> T: """ Make loop run coroutine until it returns. Runs in other thread """ if loop is None: # NB: if the loop is not running *yet*, it is OK to submit work # and we will wait for it loop = _get_loop() if _executor is None and config.get("threading.max_workers", None) is not None: # trigger executor creation and attach to loop _ = _get_executor() if not isinstance(loop, asyncio.AbstractEventLoop): raise TypeError(f"loop cannot be of type {type(loop)}") if loop.is_closed(): raise RuntimeError("Loop is not running") try: loop0 = asyncio.events.get_running_loop() if loop0 is loop: raise SyncError("Calling sync() from within a running loop") except RuntimeError: pass future = asyncio.run_coroutine_threadsafe(_runner(coro), loop) finished, unfinished = wait([future], return_when=asyncio.ALL_COMPLETED, timeout=timeout) if len(unfinished) > 0: raise TimeoutError(f"Coroutine {coro} failed to finish within {timeout} s") assert len(finished) == 1 return_result = next(iter(finished)).result() if isinstance(return_result, BaseException): raise return_result else: return return_result def _get_loop() -> asyncio.AbstractEventLoop: """Create or return the default fsspec IO loop The loop will be running on a separate thread. """ if loop[0] is None: with _get_lock(): # repeat the check just in case the loop got filled between the # previous two calls from another thread if loop[0] is None: logger.debug("Creating Zarr event loop") new_loop = asyncio.new_event_loop() loop[0] = new_loop iothread[0] = threading.Thread(target=new_loop.run_forever, name="zarr_io") assert iothread[0] is not None iothread[0].daemon = True iothread[0].start() assert loop[0] is not None return loop[0] async def _collect_aiterator[T](data: AsyncIterator[T]) -> tuple[T, ...]: """ Collect an entire async iterator into a tuple """ result = [x async for x in data] return tuple(result) def collect_aiterator[T](data: AsyncIterator[T]) -> tuple[T, ...]: """ Synchronously collect an entire async iterator into a tuple. """ return sync(_collect_aiterator(data)) class SyncMixin: def _sync[T](self, coroutine: Coroutine[Any, Any, T]) -> T: # TODO: refactor this to take *args and **kwargs and pass those to the method # this should allow us to better type the sync wrapper return sync( coroutine, timeout=config.get("async.timeout"), ) def _sync_iter[T](self, async_iterator: AsyncIterator[T]) -> list[T]: async def iter_to_list() -> list[T]: return [item async for item in async_iterator] return self._sync(iter_to_list()) async def _with_semaphore[T]( func: Callable[[], Awaitable[T]], semaphore: asyncio.Semaphore | None = None ) -> T: """ Await the result of invoking the no-argument-callable ``func`` within the context manager provided by a Semaphore, if one is provided. Otherwise, just await the result of invoking ``func``. """ if semaphore is None: return await func() async with semaphore: return await func() zarr-python-3.3.0/src/zarr/core/sync_group.py000066400000000000000000000136571523267620000212700ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING from zarr.core.group import Group, GroupMetadata, _parse_async_node from zarr.core.group import create_hierarchy as create_hierarchy_async from zarr.core.group import create_nodes as create_nodes_async from zarr.core.group import create_rooted_hierarchy as create_rooted_hierarchy_async from zarr.core.group import get_node as get_node_async from zarr.core.sync import _collect_aiterator, sync if TYPE_CHECKING: from collections.abc import Iterator from zarr.abc.store import Store from zarr.core.common import ZarrFormat from zarr.core.metadata import ArrayV2Metadata, ArrayV3Metadata from zarr.types import AnyArray def create_nodes( *, store: Store, nodes: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata] ) -> Iterator[tuple[str, Group | AnyArray]]: """Create a collection of arrays and / or groups concurrently. Note: no attempt is made to validate that these arrays and / or groups collectively form a valid Zarr hierarchy. It is the responsibility of the caller of this function to ensure that the ``nodes`` parameter satisfies any correctness constraints. Parameters ---------- store : Store The storage backend to use. nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, and the values are the metadata of the nodes. The metadata must be either an instance of GroupMetadata, ArrayV3Metadata or ArrayV2Metadata. Yields ------ Group | Array The created nodes. """ coro = create_nodes_async(store=store, nodes=nodes) for key, value in sync(_collect_aiterator(coro)): yield key, _parse_async_node(value) def create_hierarchy( *, store: Store, nodes: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], overwrite: bool = False, ) -> Iterator[tuple[str, Group | AnyArray]]: """ Create a complete zarr hierarchy from a collection of metadata objects. This function will parse its input to ensure that the hierarchy is complete. Any implicit groups will be inserted as needed. For example, an input like ```{'a/b': GroupMetadata}``` will be parsed to ```{'': GroupMetadata, 'a': GroupMetadata, 'b': Groupmetadata}``` After input parsing, this function then creates all the nodes in the hierarchy concurrently. Arrays and Groups are yielded in the order they are created. This order is not stable and should not be relied on. Parameters ---------- store : Store The storage backend to use. nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, relative to the root of the ``Store``. The root of the store can be specified with the empty string ``''``. The values are instances of ``GroupMetadata`` or ``ArrayMetadata``. Note that all values must have the same ``zarr_format`` -- it is an error to mix zarr versions in the same hierarchy. Leading "/" characters from keys will be removed. overwrite : bool Whether to overwrite existing nodes. Defaults to ``False``, in which case an error is raised instead of overwriting an existing array or group. This function will not erase an existing group unless that group is explicitly named in ``nodes``. If ``nodes`` defines implicit groups, e.g. ``{`'a/b/c': GroupMetadata}``, and a group already exists at path ``a``, then this function will leave the group at ``a`` as-is. Yields ------ tuple[str, Group | Array] This function yields (path, node) pairs, in the order the nodes were created. Examples -------- ```python from zarr import create_hierarchy from zarr.storage import MemoryStore from zarr.core.group import GroupMetadata store = MemoryStore() nodes = {'a': GroupMetadata(attributes={'name': 'leaf'})} nodes_created = dict(create_hierarchy(store=store, nodes=nodes)) print(nodes) # {'a': GroupMetadata(attributes={'name': 'leaf'}, zarr_format=3, consolidated_metadata=None, node_type='group')} ``` """ coro = create_hierarchy_async(store=store, nodes=nodes, overwrite=overwrite) for key, value in sync(_collect_aiterator(coro)): yield key, _parse_async_node(value) def create_rooted_hierarchy( *, store: Store, nodes: dict[str, GroupMetadata | ArrayV2Metadata | ArrayV3Metadata], overwrite: bool = False, ) -> Group | AnyArray: """ Create a Zarr hierarchy with a root, and return the root node, which could be a ``Group`` or ``Array`` instance. Parameters ---------- store : Store The storage backend to use. nodes : dict[str, GroupMetadata | ArrayV3Metadata | ArrayV2Metadata] A dictionary defining the hierarchy. The keys are the paths of the nodes in the hierarchy, and the values are the metadata of the nodes. The metadata must be either an instance of GroupMetadata, ArrayV3Metadata or ArrayV2Metadata. overwrite : bool Whether to overwrite existing nodes. Default is ``False``. Returns ------- Group | Array """ async_node = sync(create_rooted_hierarchy_async(store=store, nodes=nodes, overwrite=overwrite)) return _parse_async_node(async_node) def get_node(store: Store, path: str, zarr_format: ZarrFormat) -> AnyArray | Group: """ Get an Array or Group from a path in a Store. Parameters ---------- store : Store The store-like object to read from. path : str The path to the node to read. zarr_format : {2, 3} The zarr format of the node to read. Returns ------- Array | Group """ return _parse_async_node(sync(get_node_async(store=store, path=path, zarr_format=zarr_format))) zarr-python-3.3.0/src/zarr/dtype.py000066400000000000000000000046731523267620000172730ustar00rootroot00000000000000from zarr.core.dtype import ( Bool, Complex64, Complex128, DateTime64, DateTime64JSON_V2, DateTime64JSON_V3, FixedLengthUTF32, FixedLengthUTF32JSON_V2, FixedLengthUTF32JSON_V3, Float16, Float32, Float64, Int8, Int16, Int32, Int64, NullTerminatedBytes, NullterminatedBytesJSON_V2, NullTerminatedBytesJSON_V3, RawBytes, RawBytesJSON_V2, RawBytesJSON_V3, Struct, StructJSON_V3, Structured, StructuredJSON_V2, StructuredJSON_V3, TimeDelta64, TimeDelta64JSON_V2, TimeDelta64JSON_V3, UInt8, UInt16, UInt32, UInt64, VariableLengthBytes, VariableLengthBytesJSON_V2, VariableLengthUTF8, VariableLengthUTF8JSON_V2, ZDType, data_type_registry, # Import for backwards compatibility, but not included in __all__ # so it doesn't show up in the docs parse_data_type, # noqa: F401 parse_dtype, ) from zarr.core.dtype.common import DTypeSpec_V2, check_dtype_spec_v2 __all__ = [ "Bool", "Complex64", "Complex128", "DTypeSpec_V2", "DateTime64", "DateTime64JSON_V2", "DateTime64JSON_V3", "FixedLengthUTF32", "FixedLengthUTF32JSON_V2", "FixedLengthUTF32JSON_V3", "Float16", "Float32", "Float64", "Int8", "Int16", "Int32", "Int64", "NullTerminatedBytes", "NullTerminatedBytesJSON_V3", "NullterminatedBytesJSON_V2", "RawBytes", "RawBytesJSON_V2", "RawBytesJSON_V3", "Struct", "StructJSON_V3", "Structured", "StructuredJSON_V2", "StructuredJSON_V3", "TimeDelta64", "TimeDelta64JSON_V2", "TimeDelta64JSON_V3", "UInt8", "UInt16", "UInt32", "UInt64", "VariableLengthBytes", "VariableLengthBytesJSON_V2", "VariableLengthUTF8", "VariableLengthUTF8JSON_V2", "ZDType", "check_dtype_spec_v2", "data_type_registry", "parse_dtype", ] def __getattr__(name: str) -> object: if name == "DataTypeValidationError": import warnings from zarr.errors import DataTypeValidationError, ZarrDeprecationWarning warnings.warn( "Importing DataTypeValidationError from zarr.dtype is deprecated. " "Use zarr.errors.DataTypeValidationError instead.", ZarrDeprecationWarning, stacklevel=2, ) return DataTypeValidationError raise AttributeError(f"module {__name__!r} has no attribute {name!r}") zarr-python-3.3.0/src/zarr/errors.py000066400000000000000000000075421523267620000174600ustar00rootroot00000000000000__all__ = [ "ArrayIndexError", "ArrayNotFoundError", "BaseZarrError", "BoundsCheckError", "ChunkNotFoundError", "ContainsArrayAndGroupError", "ContainsArrayError", "ContainsGroupError", "DataTypeValidationError", "GroupNotFoundError", "MetadataValidationError", "NegativeStepError", "NodeTypeValidationError", "UnstableSpecificationWarning", "VindexInvalidSelectionError", "ZarrDeprecationWarning", "ZarrFutureWarning", "ZarrRuntimeWarning", ] class BaseZarrError(ValueError): """ Base error which all zarr errors are sub-classed from. """ _msg: str = "{}" def __init__(self, *args: object) -> None: """ If a single argument is passed, treat it as a pre-formatted message. If multiple arguments are passed, they are used as arguments for a template string class variable. This behavior is deprecated. """ if len(args) == 1: super().__init__(args[0]) else: super().__init__(self._msg.format(*args)) class NodeNotFoundError(BaseZarrError, FileNotFoundError): """ Raised when a node (array or group) is not found at a certain path. """ class ArrayNotFoundError(NodeNotFoundError): """ Raised when an array isn't found at a certain path. """ _msg = "No array found in store {!r} at path {!r}" class GroupNotFoundError(NodeNotFoundError): """ Raised when a group isn't found at a certain path. """ _msg = "No group found in store {!r} at path {!r}" class ContainsGroupError(BaseZarrError): """Raised when a group already exists at a certain path.""" _msg = "A group exists in store {!r} at path {!r}." class ContainsArrayError(BaseZarrError): """Raised when an array already exists at a certain path.""" _msg = "An array exists in store {!r} at path {!r}." class ContainsArrayAndGroupError(BaseZarrError): """Raised when both array and group metadata are found at the same path.""" _msg = ( "Array and group metadata documents (.zarray and .zgroup) were both found in store " "{!r} at path {!r}. " "Only one of these files may be present in a given directory / prefix. " "Remove the .zarray file, or the .zgroup file, or both." ) class DataTypeValidationError(ValueError): ... class MetadataValidationError(BaseZarrError): """Raised when the Zarr metadata is invalid in some way""" _msg = "Invalid value for '{}'. Expected '{}'. Got '{}'." class UnknownCodecError(BaseZarrError): """ Raised when an unknown codec was used. """ class NodeTypeValidationError(MetadataValidationError): """ Specialized exception when the node_type of the metadata document is incorrect. This can be raised when the value is invalid or unexpected given the context, for example an 'array' node when we expected a 'group'. """ class ZarrFutureWarning(FutureWarning): """ A warning intended for end users raised to indicate deprecated features. """ class UnstableSpecificationWarning(ZarrFutureWarning): """ A warning raised to indicate that a feature is outside the Zarr specification. """ class ZarrDeprecationWarning(DeprecationWarning): """ A warning raised to indicate that a feature will be removed in a future release. """ class ZarrUserWarning(UserWarning): """ A warning raised to report problems with user code. """ class ZarrRuntimeWarning(RuntimeWarning): """ A warning for dubious runtime behavior. """ class VindexInvalidSelectionError(IndexError): ... class NegativeStepError(IndexError): ... class BoundsCheckError(IndexError): ... class ArrayIndexError(IndexError): ... class ChunkNotFoundError(BaseZarrError): """ Raised when a chunk that was expected to exist in storage was not retrieved successfully. """ zarr-python-3.3.0/src/zarr/experimental/000077500000000000000000000000001523267620000202575ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/experimental/__init__.py000066400000000000000000000002671523267620000223750ustar00rootroot00000000000000"""The experimental module is a site for exporting new or experimental Zarr features.""" from zarr.core.chunk_grids import ChunkGrid, ChunkSpec __all__ = ["ChunkGrid", "ChunkSpec"] zarr-python-3.3.0/src/zarr/experimental/cache_store.py000066400000000000000000000427051523267620000231200ustar00rootroot00000000000000from __future__ import annotations import asyncio import logging import time from collections import OrderedDict from dataclasses import dataclass, field from typing import TYPE_CHECKING, Any, Literal, Self from zarr.abc.store import ByteRequest, Store from zarr.storage._wrapper import WrapperStore logger = logging.getLogger(__name__) if TYPE_CHECKING: from zarr.core.buffer.core import Buffer, BufferPrototype # A cache entry identifier. Plain ``str`` for full-key entries that live in # the Store-backed cache; ``(str, ByteRequest)`` for byte-range entries that # live in the in-memory range cache. _CacheEntryKey = str | tuple[str, ByteRequest] @dataclass(slots=True) class _CacheState: cache_order: OrderedDict[_CacheEntryKey, None] = field(default_factory=OrderedDict) current_size: int = 0 key_sizes: dict[_CacheEntryKey, int] = field(default_factory=dict) lock: asyncio.Lock = field(default_factory=asyncio.Lock) hits: int = 0 misses: int = 0 evictions: int = 0 key_insert_times: dict[_CacheEntryKey, float] = field(default_factory=dict) range_cache: dict[str, dict[ByteRequest, Buffer]] = field(default_factory=dict) class CacheStore(WrapperStore[Store]): """ A dual-store caching implementation for Zarr stores. This cache wraps any Store implementation and uses a separate Store instance as the cache backend. This provides persistent caching capabilities with time-based expiration, size-based eviction, and flexible cache storage options. Full-key reads are cached in the Store-backed cache. Byte-range reads are cached in a separate in-memory dictionary so that partial reads never pollute the filesystem (or other persistent backend). Both caches share the same ``max_size`` budget and LRU eviction policy. Parameters ---------- store : Store The underlying store to wrap with caching cache_store : Store The store to use for caching (can be any Store implementation that supports deletes) max_age_seconds : int or "infinity", optional Maximum age of cached entries in seconds. The string "infinity" means entries never expire. Default is "infinity". max_size : int | None, optional Maximum size of the cache in bytes. When exceeded, least recently used items are evicted. None means unlimited size. Default is None. Note: Individual values larger than max_size will not be cached. cache_set_data : bool, optional Whether to cache data when it's written to the store. Default is True. Examples -------- ```python import zarr from zarr.storage import MemoryStore from zarr.experimental.cache_store import CacheStore # Create a cached store source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( store=source_store, cache_store=cache_store, max_age_seconds=60, max_size=1024*1024 ) # Use it like any other store array = zarr.create(shape=(100,), store=cached_store) array[:] = 42 ``` """ _cache: Store max_age_seconds: int | Literal["infinity"] max_size: int | None cache_set_data: bool _state: _CacheState def __init__( self, store: Store, *, cache_store: Store, max_age_seconds: int | str = "infinity", max_size: int | None = None, cache_set_data: bool = True, ) -> None: super().__init__(store) if not cache_store.supports_deletes: msg = ( f"The provided cache store {cache_store} does not support deletes. " "The cache_store must support deletes for CacheStore to function properly." ) raise ValueError(msg) self._cache = cache_store # Validate and set max_age_seconds if isinstance(max_age_seconds, str): if max_age_seconds != "infinity": raise ValueError("max_age_seconds string value must be 'infinity'") self.max_age_seconds = "infinity" else: self.max_age_seconds = max_age_seconds self.max_size = max_size self.cache_set_data = cache_set_data self._state = _CacheState() def _with_store(self, store: Store) -> Self: # Cannot support this operation because it would share a cache, but have a new store # So cache keys would conflict raise NotImplementedError("CacheStore does not support this operation.") def with_read_only(self, read_only: bool = False) -> Self: # Create a new cache store that shares the same cache and mutable state store = type(self)( store=self._store.with_read_only(read_only), cache_store=self._cache, max_age_seconds=self.max_age_seconds, max_size=self.max_size, cache_set_data=self.cache_set_data, ) store._state = self._state return store def _is_key_fresh(self, entry_key: _CacheEntryKey) -> bool: """Check if a cached entry is still fresh based on max_age_seconds. Uses monotonic time for accurate elapsed time measurement. """ if self.max_age_seconds == "infinity": return True now = time.monotonic() elapsed = now - self._state.key_insert_times.get(entry_key, 0) return elapsed < self.max_age_seconds async def _accommodate_value(self, value_size: int) -> None: """Ensure there is enough space in the cache for a new value. Must be called while holding self._state.lock. """ if self.max_size is None: return # Remove least recently used items until we have enough space while self._state.current_size + value_size > self.max_size and self._state.cache_order: # Get the least recently used key (first in OrderedDict) lru_key = next(iter(self._state.cache_order)) await self._evict_key(lru_key) async def _evict_key(self, entry_key: _CacheEntryKey) -> None: """Evict a cache entry. Must be called while holding self._state.lock. For ``str`` keys the entry is deleted from the Store-backed cache. For ``(str, ByteRequest)`` keys the entry is removed from the in-memory range cache. """ key_size = self._state.key_sizes.get(entry_key, 0) if isinstance(entry_key, str): await self._cache.delete(entry_key) else: base_key, byte_range = entry_key per_key = self._state.range_cache.get(base_key) if per_key is not None: per_key.pop(byte_range, None) if not per_key: del self._state.range_cache[base_key] self._state.cache_order.pop(entry_key, None) self._state.key_insert_times.pop(entry_key, None) self._state.key_sizes.pop(entry_key, None) self._state.current_size = max(0, self._state.current_size - key_size) self._state.evictions += 1 async def _track_entry(self, entry_key: _CacheEntryKey, value: Buffer) -> bool: """Register *entry_key* in the shared size / LRU tracking. Returns ``True`` if the entry was tracked, ``False`` if the value exceeds ``max_size`` and was skipped. Callers should roll back any data they already stored when this returns ``False``. This method holds the lock for the entire operation to ensure atomicity. """ value_size = len(value) # Check if value exceeds max size if self.max_size is not None and value_size > self.max_size: return False async with self._state.lock: # If key already exists, subtract old size first if entry_key in self._state.key_sizes: old_size = self._state.key_sizes[entry_key] self._state.current_size -= old_size # Make room for the new value await self._accommodate_value(value_size) # Update tracking atomically self._state.cache_order[entry_key] = None self._state.current_size += value_size self._state.key_sizes[entry_key] = value_size self._state.key_insert_times[entry_key] = time.monotonic() return True async def _update_access_order(self, entry_key: _CacheEntryKey) -> None: """Update the access order for LRU tracking.""" if entry_key in self._state.cache_order: async with self._state.lock: self._state.cache_order.move_to_end(entry_key) def _remove_from_tracking(self, entry_key: _CacheEntryKey) -> None: """Remove an entry from all tracking structures. Must be called while holding self._state.lock. """ self._state.cache_order.pop(entry_key, None) self._state.key_insert_times.pop(entry_key, None) self._state.key_sizes.pop(entry_key, None) def _invalidate_range_entries(self, key: str) -> None: """Remove all byte-range entries for *key* from the range cache and tracking. Must be called while holding self._state.lock. """ per_key = self._state.range_cache.pop(key, None) if per_key is not None: for byte_range in per_key: entry_key: _CacheEntryKey = (key, byte_range) entry_size = self._state.key_sizes.pop(entry_key, 0) self._state.cache_order.pop(entry_key, None) self._state.key_insert_times.pop(entry_key, None) self._state.current_size = max(0, self._state.current_size - entry_size) # ------------------------------------------------------------------ # get helpers # ------------------------------------------------------------------ async def _cache_miss( self, key: str, byte_range: ByteRequest | None, result: Buffer | None ) -> None: """Handle a cache miss by storing or cleaning up after a source-store fetch.""" if result is None: if byte_range is None: await self._cache.delete(key) async with self._state.lock: self._remove_from_tracking(key) else: entry_key: _CacheEntryKey = (key, byte_range) async with self._state.lock: per_key = self._state.range_cache.get(key) if per_key is not None: per_key.pop(byte_range, None) if not per_key: del self._state.range_cache[key] self._remove_from_tracking(entry_key) else: if byte_range is None: await self._cache.set(key, result) await self._track_entry(key, result) else: entry_key = (key, byte_range) self._state.range_cache.setdefault(key, {})[byte_range] = result tracked = await self._track_entry(entry_key, result) if not tracked: # Value too large for the cache — roll back the insertion per_key = self._state.range_cache.get(key) if per_key is not None: per_key.pop(byte_range, None) if not per_key: del self._state.range_cache[key] async def _get_try_cache( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: """Try to get data from cache first, falling back to source store.""" if byte_range is None: # Full-key read — use Store-backed cache maybe_cached = await self._cache.get(key, prototype) if maybe_cached is not None: self._state.hits += 1 await self._update_access_order(key) return maybe_cached else: # Byte-range read — use in-memory range cache entry_key: _CacheEntryKey = (key, byte_range) per_key = self._state.range_cache.get(key) if per_key is not None: cached_buf = per_key.get(byte_range) if cached_buf is not None: self._state.hits += 1 await self._update_access_order(entry_key) return cached_buf # Cache miss — fetch from source store self._state.misses += 1 result = await super().get(key, prototype, byte_range) await self._cache_miss(key, byte_range, result) return result async def _get_no_cache( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: """Get data directly from source store and update cache.""" self._state.misses += 1 result = await super().get(key, prototype, byte_range) await self._cache_miss(key, byte_range, result) return result @property def _supports_sync_io(self) -> bool: # The caching logic lives only in the async get/set/delete overrides; # the sync methods inherited from `WrapperStore` delegate straight to # the source store, so a sync-capable consumer (the fused codec # pipeline) would write and delete around the cache, leaving stale # entries that later async reads serve as current data. Opt out of # sync IO until the sync surface is cache-aware. return False async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: """ Retrieve data from the store, using cache when appropriate. Parameters ---------- key : str The key to retrieve prototype : BufferPrototype Buffer prototype for creating the result buffer byte_range : ByteRequest, optional Byte range to retrieve Returns ------- Buffer | None The retrieved data, or None if not found """ entry_key: _CacheEntryKey = (key, byte_range) if byte_range is not None else key if not self._is_key_fresh(entry_key): return await self._get_no_cache(key, prototype, byte_range) else: return await self._get_try_cache(key, prototype, byte_range) async def set(self, key: str, value: Buffer) -> None: """ Store data in the underlying store and optionally in cache. Parameters ---------- key : str The key to store under value : Buffer The data to store """ await super().set(key, value) # Invalidate all cached byte-range entries (source data changed) async with self._state.lock: self._invalidate_range_entries(key) if self.cache_set_data: await self._cache.set(key, value) await self._track_entry(key, value) else: await self._cache.delete(key) async with self._state.lock: self._remove_from_tracking(key) async def delete(self, key: str) -> None: """ Delete data from both the underlying store and cache. Parameters ---------- key : str The key to delete """ await super().delete(key) # Invalidate all cached byte-range entries async with self._state.lock: self._invalidate_range_entries(key) await self._cache.delete(key) async with self._state.lock: self._remove_from_tracking(key) def cache_info(self) -> dict[str, Any]: """Return information about the cache state.""" return { "cache_store_type": type(self._cache).__name__, "max_age_seconds": "infinity" if self.max_age_seconds == "infinity" else self.max_age_seconds, "max_size": self.max_size, "current_size": self._state.current_size, "cache_set_data": self.cache_set_data, "tracked_keys": len(self._state.key_insert_times), "cached_keys": len(self._state.cache_order), } def cache_stats(self) -> dict[str, Any]: """Return cache performance statistics.""" total_requests = self._state.hits + self._state.misses hit_rate = self._state.hits / total_requests if total_requests > 0 else 0.0 return { "hits": self._state.hits, "misses": self._state.misses, "evictions": self._state.evictions, "total_requests": total_requests, "hit_rate": hit_rate, } async def clear_cache(self) -> None: """Clear all cached data and tracking information.""" # Clear the cache store if it supports clear if hasattr(self._cache, "clear"): await self._cache.clear() # Reset tracking async with self._state.lock: self._state.key_insert_times.clear() self._state.cache_order.clear() self._state.key_sizes.clear() self._state.range_cache.clear() self._state.current_size = 0 def __repr__(self) -> str: """Return string representation of the cache store.""" return ( f"{self.__class__.__name__}(" f"store={self._store!r}, " f"cache_store={self._cache!r}, " f"max_age_seconds={self.max_age_seconds}, " f"max_size={self.max_size}, " f"current_size={self._state.current_size}, " f"cached_keys={len(self._state.cache_order)})" ) zarr-python-3.3.0/src/zarr/metadata/000077500000000000000000000000001523267620000173425ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/metadata/__init__.py000066400000000000000000000000001523267620000214410ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/metadata/migrate_v3.py000066400000000000000000000244211523267620000217570ustar00rootroot00000000000000import asyncio import logging from typing import cast import numcodecs.abc import zarr from zarr import Group from zarr.abc.codec import ArrayArrayCodec, BytesBytesCodec, Codec from zarr.abc.store import Store from zarr.codecs.blosc import BloscCodec, BloscShuffle from zarr.codecs.bytes import BytesCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.transpose import TransposeCodec from zarr.codecs.zstd import ZstdCodec from zarr.core.buffer.core import default_buffer_prototype from zarr.core.chunk_key_encodings import V2ChunkKeyEncoding from zarr.core.common import ( ZARR_JSON, ZARRAY_JSON, ZATTRS_JSON, ZGROUP_JSON, ZMETADATA_V2_JSON, ZarrFormat, ) from zarr.core.dtype.common import HasEndianness from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType from zarr.core.group import GroupMetadata from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.core.metadata.v3 import ArrayV3Metadata, RegularChunkGridMetadata from zarr.core.sync import sync from zarr.registry import get_codec_class from zarr.storage import StorePath from zarr.types import AnyArray _logger = logging.getLogger(__name__) def migrate_v2_to_v3( *, input_store: Store, output_store: Store | None = None, dry_run: bool = False, ) -> None: """Migrate all v2 metadata in a Zarr store to v3. This will create a zarr.json file at each level of a Zarr hierarchy (for every group / array). v2 files (.zarray, .zattrs etc.) will be left as-is. Parameters ---------- input_store : Store Input Zarr to migrate. output_store : Store, optional Output location to write v3 metadata (no array data will be copied). If not provided, v3 metadata will be written to input_store. dry_run : bool, optional Enable a 'dry run' - files that would be created are logged, but no files are created or changed. """ zarr_v2 = zarr.open(store=input_store, mode="r+") if output_store is not None: # w- access to not allow overwrite of existing data output_path = sync(StorePath.open(output_store, path="", mode="w-")) else: output_path = zarr_v2.store_path migrate_to_v3(zarr_v2, output_path, dry_run=dry_run) def migrate_to_v3(zarr_v2: AnyArray | Group, output_path: StorePath, dry_run: bool = False) -> None: """Migrate all v2 metadata in a Zarr array/group to v3. Note - if a group is provided, then all arrays / groups within this group will also be converted. A zarr.json file will be created for each level and written to output_path, with any v2 files (.zarray, .zattrs etc.) left as-is. Parameters ---------- zarr_v2 : Array | Group An array or group with zarr_format = 2 output_path : StorePath The store path to write generated v3 metadata to. dry_run : bool, optional Enable a 'dry run' - files that would be created are logged, but no files are created or changed. """ if not zarr_v2.metadata.zarr_format == 2: raise TypeError("Only arrays / groups with zarr v2 metadata can be converted") if isinstance(zarr_v2.metadata, GroupMetadata): _convert_group(zarr_v2, output_path, dry_run) else: _convert_array(zarr_v2, output_path, dry_run) async def remove_metadata( store: Store, zarr_format: ZarrFormat, force: bool = False, dry_run: bool = False, ) -> None: """Remove all v2 (.zarray, .zattrs, .zgroup, .zmetadata) or v3 (zarr.json) metadata files from the given Zarr. Note - this will remove metadata files at all levels of the hierarchy (every group and array). Parameters ---------- store : Store Zarr to remove metadata from. zarr_format : ZarrFormat Which format's metadata to remove - 2 or 3. force : bool, optional When False, metadata can only be removed if a valid alternative exists e.g. deletion of v2 metadata will only be allowed when v3 metadata is also present. When True, metadata can be removed when there is no alternative. dry_run : bool, optional Enable a 'dry run' - files that would be deleted are logged, but no files are removed or changed. """ if not store.supports_deletes: raise ValueError("Store must support deletes to remove metadata") store_path = await StorePath.open(store, path="", mode="r+") metadata_files_all = { 2: [ZARRAY_JSON, ZATTRS_JSON, ZGROUP_JSON, ZMETADATA_V2_JSON], 3: [ZARR_JSON], } if zarr_format == 2: alternative_metadata = 3 else: alternative_metadata = 2 awaitables = [] async for file_path in store.list(): parent_path, _, file_name = file_path.rpartition("/") if file_name not in metadata_files_all[zarr_format]: continue if force or await _metadata_exists( cast(ZarrFormat, alternative_metadata), store_path / parent_path ): _logger.info("Deleting metadata at %s", store_path / file_path) if not dry_run: awaitables.append((store_path / file_path).delete()) else: raise ValueError( f"Cannot remove v{zarr_format} metadata at {store_path / file_path} - no v{alternative_metadata} " "metadata exists. To delete anyway, use the 'force' option." ) await asyncio.gather(*awaitables) def _convert_group(zarr_v2: Group, output_path: StorePath, dry_run: bool) -> None: if zarr_v2.metadata.consolidated_metadata is not None: raise NotImplementedError("Migration of consolidated metadata isn't supported.") # process members of the group for key in zarr_v2: migrate_to_v3(zarr_v2[key], output_path=output_path / key, dry_run=dry_run) # write group's converted metadata group_metadata_v3 = GroupMetadata( attributes=zarr_v2.metadata.attributes, zarr_format=3, consolidated_metadata=None ) sync(_save_v3_metadata(group_metadata_v3, output_path, dry_run=dry_run)) def _convert_array(zarr_v2: AnyArray, output_path: StorePath, dry_run: bool) -> None: array_metadata_v3 = _convert_array_metadata(cast(ArrayV2Metadata, zarr_v2.metadata)) sync(_save_v3_metadata(array_metadata_v3, output_path, dry_run=dry_run)) async def _metadata_exists(zarr_format: ZarrFormat, store_path: StorePath) -> bool: metadata_files_required = {2: [ZARRAY_JSON, ZGROUP_JSON], 3: [ZARR_JSON]} for metadata_file in metadata_files_required[zarr_format]: if await (store_path / metadata_file).exists(): return True return False def _convert_array_metadata(metadata_v2: ArrayV2Metadata) -> ArrayV3Metadata: chunk_key_encoding = V2ChunkKeyEncoding(separator=metadata_v2.dimension_separator) codecs: list[Codec] = [] # array-array codecs if metadata_v2.order == "F": # F is equivalent to order: n-1, ... 1, 0 codecs.append(TransposeCodec(order=list(range(len(metadata_v2.shape) - 1, -1, -1)))) if metadata_v2.filters is not None: codecs.extend(_convert_filters(metadata_v2.filters)) # array-bytes codecs if not isinstance(metadata_v2.dtype, HasEndianness): codecs.append(BytesCodec(endian=None)) else: codecs.append(BytesCodec(endian=metadata_v2.dtype.endianness)) # bytes-bytes codecs if metadata_v2.compressor is not None: bytes_bytes_codec = _convert_compressor(metadata_v2.compressor, metadata_v2.dtype) codecs.append(bytes_bytes_codec) return ArrayV3Metadata( shape=metadata_v2.shape, data_type=metadata_v2.dtype, chunk_grid=RegularChunkGridMetadata(chunk_shape=metadata_v2.chunks), chunk_key_encoding=chunk_key_encoding, fill_value=metadata_v2.fill_value, codecs=codecs, attributes=metadata_v2.attributes, dimension_names=None, storage_transformers=None, ) def _convert_filters(filters: tuple[numcodecs.abc.Codec, ...]) -> list[ArrayArrayCodec]: filters_codecs = [_find_numcodecs_zarr3(filter) for filter in filters] for codec in filters_codecs: if not isinstance(codec, ArrayArrayCodec): raise TypeError(f"Filter {type(codec)} is not an ArrayArrayCodec") return cast(list[ArrayArrayCodec], filters_codecs) def _convert_compressor( compressor: numcodecs.abc.Codec, dtype: ZDType[TBaseDType, TBaseScalar] ) -> BytesBytesCodec: match compressor.codec_id: case "blosc": return BloscCodec( typesize=dtype.to_native_dtype().itemsize, cname=compressor.cname, clevel=compressor.clevel, shuffle=BloscShuffle.from_int(compressor.shuffle), blocksize=compressor.blocksize, ) case "zstd": return ZstdCodec( level=compressor.level, checksum=compressor.checksum, ) case "gzip": return GzipCodec(level=compressor.level) case _: # If possible, find matching zarr.codecs.numcodecs codec compressor_codec = _find_numcodecs_zarr3(compressor) if not isinstance(compressor_codec, BytesBytesCodec): raise TypeError(f"Compressor {type(compressor_codec)} is not a BytesBytesCodec") return compressor_codec def _find_numcodecs_zarr3(numcodecs_codec: numcodecs.abc.Codec) -> Codec: """Find matching zarr.codecs.numcodecs codec (if it exists)""" numcodec_name = f"numcodecs.{numcodecs_codec.codec_id}" numcodec_dict = { "name": numcodec_name, "configuration": numcodecs_codec.get_config(), } try: codec_v3 = get_codec_class(numcodec_name) except KeyError as exc: raise ValueError( f"Couldn't find corresponding zarr.codecs.numcodecs codec for {numcodecs_codec.codec_id}" ) from exc return codec_v3.from_dict(numcodec_dict) async def _save_v3_metadata( metadata_v3: ArrayV3Metadata | GroupMetadata, output_path: StorePath, dry_run: bool = False ) -> None: zarr_json_path = output_path / ZARR_JSON if await zarr_json_path.exists(): raise ValueError(f"{ZARR_JSON} already exists at {zarr_json_path}") _logger.info("Saving metadata to %s", zarr_json_path) to_save = metadata_v3.to_buffer_dict(default_buffer_prototype()) if not dry_run: await zarr_json_path.set_if_not_exists(to_save[ZARR_JSON]) zarr-python-3.3.0/src/zarr/py.typed000066400000000000000000000000001523267620000172470ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/registry.py000066400000000000000000000262111523267620000200060ustar00rootroot00000000000000from __future__ import annotations import warnings from collections import defaultdict from importlib.metadata import entry_points as get_entry_points from typing import TYPE_CHECKING, Any from zarr.core.config import BadConfigError, config from zarr.core.dtype import data_type_registry from zarr.errors import ZarrUserWarning if TYPE_CHECKING: from importlib.metadata import EntryPoint from zarr.abc.codec import ( ArrayArrayCodec, ArrayBytesCodec, BytesBytesCodec, Codec, CodecJSON_V2, CodecPipeline, ) from zarr.abc.numcodec import Numcodec from zarr.core.buffer import Buffer, NDBuffer from zarr.core.chunk_key_encodings import ChunkKeyEncoding from zarr.core.common import JSON __all__ = [ "Registry", "get_buffer_class", "get_chunk_key_encoding_class", "get_codec_class", "get_ndbuffer_class", "get_pipeline_class", "register_buffer", "register_chunk_key_encoding", "register_codec", "register_ndbuffer", "register_pipeline", ] class Registry[T](dict[str, type[T]]): def __init__(self) -> None: super().__init__() self.lazy_load_list: list[EntryPoint] = [] def lazy_load(self, use_entrypoint_name: bool = False) -> None: for e in self.lazy_load_list: self.register(e.load(), qualname=e.name if use_entrypoint_name else None) self.lazy_load_list.clear() def register(self, cls: type[T], qualname: str | None = None) -> None: if qualname is None: qualname = fully_qualified_name(cls) self[qualname] = cls _codec_registries: dict[str, Registry[Codec]] = defaultdict(Registry) _pipeline_registry: Registry[CodecPipeline] = Registry() _buffer_registry: Registry[Buffer] = Registry() _ndbuffer_registry: Registry[NDBuffer] = Registry() _chunk_key_encoding_registry: Registry[ChunkKeyEncoding] = Registry() """ The registry module is responsible for managing implementations of codecs, pipelines, buffers, ndbuffers, and chunk key encodings and collecting them from entrypoints. The implementation used is determined by the config. The registry module is also responsible for managing dtypes. """ def _collect_entrypoints() -> list[Registry[Any]]: """ Collects codecs, pipelines, dtypes, buffers and ndbuffers from entrypoints. Entry points can either be single items or groups of items. Allowed syntax for entry_points.txt is e.g. [zarr.codecs] gzip = package:EntrypointGzipCodec1 [zarr.codecs.gzip] some_name = package:EntrypointGzipCodec2 another = package:EntrypointGzipCodec3 [zarr] buffer = package:TestBuffer1 [zarr.buffer] xyz = package:TestBuffer2 abc = package:TestBuffer3 ... """ entry_points = get_entry_points() _buffer_registry.lazy_load_list.extend(entry_points.select(group="zarr.buffer")) _buffer_registry.lazy_load_list.extend(entry_points.select(group="zarr", name="buffer")) _ndbuffer_registry.lazy_load_list.extend(entry_points.select(group="zarr.ndbuffer")) _ndbuffer_registry.lazy_load_list.extend(entry_points.select(group="zarr", name="ndbuffer")) data_type_registry._lazy_load_list.extend(entry_points.select(group="zarr.data_type")) data_type_registry._lazy_load_list.extend(entry_points.select(group="zarr", name="data_type")) _chunk_key_encoding_registry.lazy_load_list.extend( entry_points.select(group="zarr.chunk_key_encoding") ) _chunk_key_encoding_registry.lazy_load_list.extend( entry_points.select(group="zarr", name="chunk_key_encoding") ) _pipeline_registry.lazy_load_list.extend(entry_points.select(group="zarr.codec_pipeline")) _pipeline_registry.lazy_load_list.extend( entry_points.select(group="zarr", name="codec_pipeline") ) for e in entry_points.select(group="zarr.codecs"): _codec_registries[e.name].lazy_load_list.append(e) for group in entry_points.groups: if group.startswith("zarr.codecs."): codec_name = group.split(".")[2] _codec_registries[codec_name].lazy_load_list.extend(entry_points.select(group=group)) return [ *_codec_registries.values(), _pipeline_registry, _buffer_registry, _ndbuffer_registry, _chunk_key_encoding_registry, ] def _reload_config() -> None: config.refresh() def fully_qualified_name(cls: type) -> str: module = cls.__module__ return f"{module}.{cls.__qualname__}" def register_codec(key: str, codec_cls: type[Codec], *, qualname: str | None = None) -> None: if key not in _codec_registries: _codec_registries[key] = Registry() _codec_registries[key].register(codec_cls, qualname=qualname) def register_pipeline(pipe_cls: type[CodecPipeline]) -> None: _pipeline_registry.register(pipe_cls) def register_ndbuffer(cls: type[NDBuffer], qualname: str | None = None) -> None: _ndbuffer_registry.register(cls, qualname) def register_buffer(cls: type[Buffer], qualname: str | None = None) -> None: _buffer_registry.register(cls, qualname) def register_chunk_key_encoding(key: str, cls: type) -> None: _chunk_key_encoding_registry.register(cls, key) def get_codec_class(key: str, reload_config: bool = False) -> type[Codec]: if reload_config: _reload_config() if key in _codec_registries: # logger.debug("Auto loading codec '%s' from entrypoint", codec_id) _codec_registries[key].lazy_load() codec_classes = _codec_registries[key] if not codec_classes: raise KeyError(key) config_entry = config.get("codecs", {}).get(key) if config_entry is None: if len(codec_classes) == 1: return next(iter(codec_classes.values())) warnings.warn( f"Codec '{key}' not configured in config. Selecting any implementation.", stacklevel=2, category=ZarrUserWarning, ) return list(codec_classes.values())[-1] selected_codec_cls = codec_classes[config_entry] if selected_codec_cls: return selected_codec_cls raise KeyError(key) def _resolve_codec(data: dict[str, JSON]) -> Codec: """ Get a codec instance from a dict representation of that codec. """ # TODO: narrow the type of the input to only those dicts that map on to codec class instances. return get_codec_class(data["name"]).from_dict(data) # type: ignore[arg-type] def _parse_bytes_bytes_codec(data: dict[str, JSON] | Codec) -> BytesBytesCodec: """ Normalize the input to a ``BytesBytesCodec`` instance. If the input is already a ``BytesBytesCodec``, it is returned as is. If the input is a dict, it is converted to a ``BytesBytesCodec`` instance via the ``_resolve_codec`` function. """ from zarr.abc.codec import BytesBytesCodec if isinstance(data, dict): result = _resolve_codec(data) if not isinstance(result, BytesBytesCodec): msg = f"Expected a dict representation of a BytesBytesCodec; got a dict representation of a {type(result)} instead." raise TypeError(msg) else: if not isinstance(data, BytesBytesCodec): raise TypeError(f"Expected a BytesBytesCodec. Got {type(data)} instead.") result = data return result def _parse_array_bytes_codec(data: dict[str, JSON] | Codec) -> ArrayBytesCodec: """ Normalize the input to a ``ArrayBytesCodec`` instance. If the input is already a ``ArrayBytesCodec``, it is returned as is. If the input is a dict, it is converted to a ``ArrayBytesCodec`` instance via the ``_resolve_codec`` function. """ from zarr.abc.codec import ArrayBytesCodec if isinstance(data, dict): result = _resolve_codec(data) if not isinstance(result, ArrayBytesCodec): msg = f"Expected a dict representation of an ArrayBytesCodec; got a dict representation of a {type(result)} instead." raise TypeError(msg) else: if not isinstance(data, ArrayBytesCodec): raise TypeError(f"Expected an ArrayBytesCodec. Got {type(data)} instead.") result = data return result def _parse_array_array_codec(data: dict[str, JSON] | Codec) -> ArrayArrayCodec: """ Normalize the input to a ``ArrayArrayCodec`` instance. If the input is already a ``ArrayArrayCodec``, it is returned as is. If the input is a dict, it is converted to a ``ArrayArrayCodec`` instance via the ``_resolve_codec`` function. """ from zarr.abc.codec import ArrayArrayCodec if isinstance(data, dict): result = _resolve_codec(data) if not isinstance(result, ArrayArrayCodec): msg = f"Expected a dict representation of an ArrayArrayCodec; got a dict representation of a {type(result)} instead." raise TypeError(msg) else: if not isinstance(data, ArrayArrayCodec): raise TypeError(f"Expected an ArrayArrayCodec. Got {type(data)} instead.") result = data return result def get_pipeline_class(reload_config: bool = False) -> type[CodecPipeline]: if reload_config: _reload_config() _pipeline_registry.lazy_load() path = config.get("codec_pipeline.path") pipeline_class = _pipeline_registry.get(path) if pipeline_class: return pipeline_class raise BadConfigError( f"Pipeline class '{path}' not found in registered pipelines: {list(_pipeline_registry)}." ) def get_buffer_class(reload_config: bool = False) -> type[Buffer]: if reload_config: _reload_config() _buffer_registry.lazy_load() path = config.get("buffer") buffer_class = _buffer_registry.get(path) if buffer_class: return buffer_class raise BadConfigError( f"Buffer class '{path}' not found in registered buffers: {list(_buffer_registry)}." ) def get_ndbuffer_class(reload_config: bool = False) -> type[NDBuffer]: if reload_config: _reload_config() _ndbuffer_registry.lazy_load() path = config.get("ndbuffer") ndbuffer_class = _ndbuffer_registry.get(path) if ndbuffer_class: return ndbuffer_class raise BadConfigError( f"NDBuffer class '{path}' not found in registered buffers: {list(_ndbuffer_registry)}." ) def get_chunk_key_encoding_class(key: str) -> type[ChunkKeyEncoding]: _chunk_key_encoding_registry.lazy_load(use_entrypoint_name=True) if key not in _chunk_key_encoding_registry: raise KeyError( f"Chunk key encoding '{key}' not found in registered chunk key encodings: {list(_chunk_key_encoding_registry)}." ) return _chunk_key_encoding_registry[key] _collect_entrypoints() def get_numcodec(data: CodecJSON_V2[str]) -> Numcodec: """ Resolve a numcodec codec from the numcodecs registry. This requires the Numcodecs package to be installed. Parameters ---------- data : CodecJSON_V2 The JSON metadata for the codec. Returns ------- codec : Numcodec Examples -------- ```python from zarr.registry import get_numcodec codec = get_numcodec({'id': 'zlib', 'level': 1}) codec # Zlib(level=1) ``` """ from numcodecs.registry import get_codec return get_codec(data) # type: ignore[no-any-return] zarr-python-3.3.0/src/zarr/storage/000077500000000000000000000000001523267620000172265ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/storage/__init__.py000066400000000000000000000025411523267620000213410ustar00rootroot00000000000000import sys import warnings from types import ModuleType from typing import Any from zarr.errors import ZarrDeprecationWarning from zarr.storage._common import StoreLike, StorePath from zarr.storage._fsspec import FsspecStore from zarr.storage._local import LocalStore from zarr.storage._logging import LoggingStore from zarr.storage._memory import GpuMemoryStore, ManagedMemoryStore, MemoryStore from zarr.storage._obstore import ObjectStore from zarr.storage._wrapper import WrapperStore from zarr.storage._zip import ZipStore __all__ = [ "FsspecStore", "GpuMemoryStore", "LocalStore", "LoggingStore", "ManagedMemoryStore", "MemoryStore", "ObjectStore", "StoreLike", "StorePath", "WrapperStore", "ZipStore", ] class VerboseModule(ModuleType): def __setattr__(self, attr: str, value: Any) -> None: if attr == "default_compressor": warnings.warn( "setting zarr.storage.default_compressor is deprecated, use " "zarr.config to configure array.v2_default_compressor " "e.g. config.set({'codecs.zstd':'numcodecs.Zstd', 'array.v2_default_compressor.numeric': 'zstd'})", ZarrDeprecationWarning, stacklevel=1, ) else: super().__setattr__(attr, value) sys.modules[__name__].__class__ = VerboseModule zarr-python-3.3.0/src/zarr/storage/_common.py000066400000000000000000000543441523267620000212410ustar00rootroot00000000000000from __future__ import annotations import importlib.util from pathlib import Path from typing import TYPE_CHECKING, Any, Literal, Self from zarr.abc.store import ( ByteRequest, Store, SupportsDeleteSync, SupportsGetSync, SupportsSetSync, ) from zarr.core._json import buffer_to_json_object, get_json from zarr.core.buffer import Buffer, default_buffer_prototype from zarr.core.common import ( ANY_ACCESS_MODE, ZARR_JSON, ZARRAY_JSON, ZGROUP_JSON, AccessModeLiteral, ZarrFormat, ) from zarr.errors import ContainsArrayAndGroupError, ContainsArrayError, ContainsGroupError from zarr.storage._local import LocalStore from zarr.storage._memory import ManagedMemoryStore, MemoryStore from zarr.storage._utils import _join_paths, normalize_path, parse_store_url _has_fsspec = importlib.util.find_spec("fsspec") if _has_fsspec: from fsspec.mapping import FSMap else: FSMap = None if TYPE_CHECKING: from zarr.core.buffer import BufferPrototype from zarr.core.common import JSON class StorePath: """ Path-like interface for a Store. Parameters ---------- store : Store The store to use. path : str The path within the store. """ store: Store path: str def __init__(self, store: Store, path: str = "") -> None: self.store = store self.path = normalize_path(path) @property def read_only(self) -> bool: return self.store.read_only @classmethod async def _create_open_instance(cls, store: Store, path: str) -> Self: """Helper to create and return a StorePath instance.""" await store._ensure_open() return cls(store, path) @classmethod async def open(cls, store: Store, path: str, mode: AccessModeLiteral | None = None) -> Self: """ Open StorePath based on the provided mode. * If the mode is None, return an opened version of the store with no changes. * If the mode is 'r+', 'w-', 'w', or 'a' and the store is read-only, raise a ValueError. * If the mode is 'r' and the store is not read-only, return a copy of the store with read_only set to True. * If the mode is 'w-' and the store is not read-only and the StorePath contains keys, raise a FileExistsError. * If the mode is 'w' and the store is not read-only, delete all keys nested within the StorePath. Parameters ---------- mode : AccessModeLiteral The mode to use when initializing the store path. The accepted values are: - ``'r'``: read only (must exist) - ``'r+'``: read/write (must exist) - ``'a'``: read/write (create if doesn't exist) - ``'w'``: read/write (overwrite if exists) - ``'w-'``: read/write (create if doesn't exist). Raises ------ FileExistsError If the mode is 'w-' and the store path already exists. ValueError If the mode is not "r" and the store is read-only, or """ # fastpath if mode is None if mode is None: return await cls._create_open_instance(store, path) if mode not in ANY_ACCESS_MODE: raise ValueError(f"Invalid mode: {mode}, expected one of {ANY_ACCESS_MODE}") if store.read_only: # Don't allow write operations on a read-only store if mode != "r": raise ValueError( f"Store is read-only but mode is {mode!r}. Create a writable store or use 'r' mode." ) self = await cls._create_open_instance(store, path) elif mode == "r": # Create read-only copy for read mode on writable store try: read_only_store = store.with_read_only(True) except NotImplementedError as e: raise ValueError( "Store is not read-only but mode is 'r'. Unable to create a read-only copy of the store. " "Please use a read-only store or a storage class that implements .with_read_only()." ) from e self = await cls._create_open_instance(read_only_store, path) else: # writable store and writable mode self = await cls._create_open_instance(store, path) # Handle mode-specific operations match mode: case "w-": if not await self.is_empty(): raise FileExistsError( f"Cannot create '{path}' with mode 'w-' because it already contains data. " f"Use mode 'w' to overwrite or 'a' to append." ) case "w": await self.delete_dir() return self async def get( self, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: """ Read bytes from the store. Parameters ---------- prototype : BufferPrototype, optional The buffer prototype to use when reading the bytes. byte_range : ByteRequest, optional The range of bytes to read. Returns ------- buffer : Buffer or None The read bytes, or None if the key does not exist. """ if prototype is None: prototype = default_buffer_prototype() return await self.store.get(self.path, prototype=prototype, byte_range=byte_range) async def get_json(self, *, byte_range: ByteRequest | None = None) -> JSON | None: """ Read and parse the JSON document at this path, or None if it is absent. Parameters ---------- byte_range : ByteRequest, optional If given, read only this portion of the value. Note that a partial read of a JSON document may not be valid JSON. Returns ------- JSON or None The parsed JSON value, or None if this path does not exist. """ return await get_json(self.store, self.path, byte_range=byte_range) async def set(self, value: Buffer) -> None: """ Write bytes to the store. Parameters ---------- value : Buffer The buffer to write. """ await self.store.set(self.path, value) async def delete(self) -> None: """ Delete the key from the store. Raises ------ NotImplementedError If the store does not support deletion. """ await self.store.delete(self.path) async def delete_dir(self) -> None: """ Delete all keys with the given prefix from the store. """ await self.store.delete_dir(self.path) async def set_if_not_exists(self, default: Buffer) -> None: """ Store a key to ``value`` if the key is not already present. Parameters ---------- default : Buffer The buffer to store if the key is not already present. """ await self.store.set_if_not_exists(self.path, default) async def exists(self) -> bool: """ Check if the key exists in the store. Returns ------- bool True if the key exists in the store, False otherwise. """ return await self.store.exists(self.path) async def is_empty(self) -> bool: """ Check if any keys exist in the store with the given prefix. Returns ------- bool True if no keys exist in the store with the given prefix, False otherwise. """ return await self.store.is_empty(self.path) # ------------------------------------------------------------------- # Synchronous IO delegation # ------------------------------------------------------------------- def get_sync( self, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: """Synchronous read — delegates to ``self.store.get_sync(self.path, ...)``.""" if not isinstance(self.store, SupportsGetSync): raise TypeError(f"Store {type(self.store).__name__} does not support synchronous get.") if prototype is None: prototype = default_buffer_prototype() return self.store.get_sync(self.path, prototype=prototype, byte_range=byte_range) def set_sync(self, value: Buffer) -> None: """Synchronous write — delegates to ``self.store.set_sync(self.path, value)``.""" if not isinstance(self.store, SupportsSetSync): raise TypeError(f"Store {type(self.store).__name__} does not support synchronous set.") self.store.set_sync(self.path, value) def delete_sync(self) -> None: """Synchronous delete — delegates to ``self.store.delete_sync(self.path)``.""" if not isinstance(self.store, SupportsDeleteSync): raise TypeError( f"Store {type(self.store).__name__} does not support synchronous delete." ) self.store.delete_sync(self.path) def __truediv__(self, other: str) -> StorePath: """Combine this store path with another path""" return self.__class__(self.store, _join_paths([self.path, other])) def __str__(self) -> str: return _join_paths([str(self.store), self.path]) def __repr__(self) -> str: return f"StorePath({self.store.__class__.__name__}, '{self}')" def __eq__(self, other: object) -> bool: """ Check if two StorePath objects are equal. Returns ------- bool True if the two objects are equal, False otherwise. Notes ----- Two StorePath objects are considered equal if their stores are equal and their paths are equal. """ try: return self.store == other.store and self.path == other.path # type: ignore[attr-defined, no-any-return] except Exception: pass return False type StoreLike = Store | StorePath | FSMap | Path | str | dict[str, Buffer] async def make_store( store_like: StoreLike | None, *, mode: AccessModeLiteral | None = None, storage_options: dict[str, Any] | None = None, ) -> Store: """ Convert a `StoreLike` object into a Store object. `StoreLike` objects are converted to `Store` as follows: - `Store` or `StorePath` = `Store` object. - `Path` or `str` = `LocalStore` object. - `str` that starts with a protocol = `FsspecStore` object. - `dict[str, Buffer]` = `MemoryStore` object. - `None` = `MemoryStore` object. - `FSMap` = `FsspecStore` object. Parameters ---------- store_like : StoreLike | None The `StoreLike` object to convert to a `Store` object. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. mode : StoreAccessMode | None, optional The mode to use when creating the `Store` object. If None, the default mode is 'r'. storage_options : dict[str, Any] | None, optional The storage options to use when creating the `RemoteStore` object. If None, the default storage options are used. Returns ------- Store The converted Store object. Raises ------ TypeError If the StoreLike object is not one of the supported types, or if storage_options is provided but not used. """ from zarr.storage._fsspec import FsspecStore # circular import # Parse URL early so we can reuse the result for both validation and routing parsed = parse_store_url(store_like) if isinstance(store_like, str) else None # Check if storage_options is valid for this store_like if storage_options is not None: is_fsspec_uri = parsed is not None and parsed.scheme not in ("", "memory", "file") if not is_fsspec_uri: raise TypeError( "'storage_options' was provided but unused. " "'storage_options' is only used when the store is passed as an FSSpec URI string.", ) assert mode in (None, "r", "r+", "a", "w", "w-") _read_only = mode == "r" if isinstance(store_like, StorePath): # Get underlying store return store_like.store elif isinstance(store_like, Store): # Already a Store return store_like elif isinstance(store_like, dict): # Already a dictionary that can be a MemoryStore # # We deliberate only consider dict[str, Buffer] here, and not arbitrary mutable mappings. # By only allowing dictionaries, which are in-memory, we know that MemoryStore appropriate. return await MemoryStore.open(store_dict=store_like, read_only=_read_only) elif store_like is None: # Create a new in-memory store return await make_store({}, mode=mode, storage_options=storage_options) elif isinstance(store_like, Path): # Create a new LocalStore return await LocalStore.open(root=store_like, mode=mode, read_only=_read_only) elif isinstance(store_like, str) and parsed is not None: if parsed.scheme == "memory" and not _has_fsspec: # Create or get a ManagedMemoryStore return ManagedMemoryStore(name=parsed.name, path=parsed.path, read_only=_read_only) elif parsed.scheme == "file" or not parsed.scheme: # Local filesystem path — use parsed.path to strip the file:// scheme return await make_store(Path(parsed.path), mode=mode, storage_options=storage_options) else: # Assume fsspec can handle it (s3://, gs://, http://, etc.) return FsspecStore.from_url( store_like, storage_options=storage_options, read_only=_read_only ) elif _has_fsspec and isinstance(store_like, FSMap): return FsspecStore.from_mapper(store_like, read_only=_read_only) else: raise TypeError(f"Unsupported type for store_like: '{type(store_like).__name__}'") async def make_store_path( store_like: StoreLike | None, *, path: str | None = "", mode: AccessModeLiteral | None = None, storage_options: dict[str, Any] | None = None, ) -> StorePath: """ Convert a `StoreLike` object into a StorePath object. This function takes a `StoreLike` object and returns a `StorePath` object. See `make_store` for details of which `Store` is used for each type of `store_like` object. Parameters ---------- store_like : StoreLike or None, default=None The `StoreLike` object to convert to a `StorePath` object. See the [storage documentation in the user guide][user-guide-store-like] for a description of all valid StoreLike values. path : str | None, optional The path to use when creating the `StorePath` object. If None, the default path is the empty string. mode : StoreAccessMode | None, optional The mode to use when creating the `StorePath` object. If None, the default mode is 'r'. storage_options : dict[str, Any] | None, optional The storage options to use when creating the `RemoteStore` object. If None, the default storage options are used. Returns ------- StorePath The converted StorePath object. Raises ------ TypeError If the StoreLike object is not one of the supported types, or if storage_options is provided but not used. ValueError If path is provided for a store that does not support it. See Also -------- make_store """ path_normalized = normalize_path(path) if isinstance(store_like, StorePath): # Already a StorePath if storage_options: raise TypeError( "'storage_options' was provided but unused. " "'storage_options' is only used when the store is passed as an FSSpec URI string.", ) return store_like / path_normalized elif _has_fsspec and isinstance(store_like, FSMap) and path: raise ValueError( "'path' was provided but is not used for FSMap store_like objects. Specify the path when creating the FSMap instance instead." ) else: store = await make_store(store_like, mode=mode, storage_options=storage_options) return await StorePath.open(store, path=path_normalized, mode=mode) async def ensure_no_existing_node( store_path: StorePath, zarr_format: ZarrFormat, node_type: Literal["array", "group"] | None = None, ) -> None: """ Check if a store_path is safe for array / group creation. Returns `None` or raises an exception. Parameters ---------- store_path : StorePath The storage location to check. zarr_format : ZarrFormat The Zarr format to check. node_type : str | None, optional Raise an error if an "array", or "group" exists. By default (when None), raises an error for either. Raises ------ ContainsArrayError, ContainsGroupError, ContainsArrayAndGroupError """ if zarr_format == 2: extant_node = await _contains_node_v2(store_path) elif zarr_format == 3: extant_node = await _contains_node_v3(store_path) match extant_node: case "array": if node_type != "group": msg = f"An array exists in store {store_path.store!r} at path {store_path.path!r}." raise ContainsArrayError(msg) case "group": if node_type != "array": msg = f"A group exists in store {store_path.store!r} at path {store_path.path!r}." raise ContainsGroupError(msg) case "nothing": return case _: msg = f"Invalid value for extant_node: {extant_node}" # type: ignore[unreachable] raise ValueError(msg) async def _contains_node_v3(store_path: StorePath) -> Literal["array", "group", "nothing"]: """ Check if a store_path contains nothing, an array, or a group. This function returns the string "array", "group", or "nothing" to denote containing an array, a group, or nothing. Parameters ---------- store_path : StorePath The location in storage to check. Returns ------- Literal["array", "group", "nothing"] A string representing the zarr node found at store_path. """ result: Literal["array", "group", "nothing"] = "nothing" extant_meta_bytes = await (store_path / ZARR_JSON).get() # if no metadata document could be loaded, then we just return "nothing" if extant_meta_bytes is not None: try: extant_meta_json = buffer_to_json_object(extant_meta_bytes) # avoid constructing a full metadata document here in the name of speed. if extant_meta_json["node_type"] == "array": result = "array" elif extant_meta_json["node_type"] == "group": result = "group" except (KeyError, TypeError, ValueError): # any of these errors is consistent with no array or group present. `ValueError` # covers both malformed JSON (`json.JSONDecodeError`) and non-UTF-8 bytes # (`UnicodeDecodeError`), each a `ValueError` subclass. pass return result async def _contains_node_v2(store_path: StorePath) -> Literal["array", "group", "nothing"]: """ Check if a store_path contains nothing, an array, a group, or both. If both an array and a group are detected, a `ContainsArrayAndGroup` exception is raised. Otherwise, this function returns the string "array", "group", or "nothing" to denote containing an array, a group, or nothing. Parameters ---------- store_path : StorePath The location in storage to check. Returns ------- Literal["array", "group", "nothing"] A string representing the zarr node found at store_path. """ _array = await contains_array(store_path=store_path, zarr_format=2) _group = await contains_group(store_path=store_path, zarr_format=2) if _array and _group: msg = ( "Array and group metadata documents (.zarray and .zgroup) were both found in store " f"{store_path.store!r} at path {store_path.path!r}. " "Only one of these files may be present in a given directory / prefix. " "Remove the .zarray file, or the .zgroup file, or both." ) raise ContainsArrayAndGroupError(msg) elif _array: return "array" elif _group: return "group" else: return "nothing" async def contains_array(store_path: StorePath, zarr_format: ZarrFormat) -> bool: """ Check if an array exists at a given StorePath. Parameters ---------- store_path : StorePath The StorePath to check for an existing group. zarr_format : The zarr format to check for. Returns ------- bool True if the StorePath contains a group, False otherwise. """ if zarr_format == 3: extant_meta_bytes = await (store_path / ZARR_JSON).get() if extant_meta_bytes is None: return False else: try: extant_meta_json = buffer_to_json_object(extant_meta_bytes) # we avoid constructing a full metadata document here in the name of speed. if extant_meta_json["node_type"] == "array": return True except (ValueError, KeyError, TypeError): return False elif zarr_format == 2: return await (store_path / ZARRAY_JSON).exists() msg = f"Invalid zarr_format provided. Got {zarr_format}, expected 2 or 3" raise ValueError(msg) async def contains_group(store_path: StorePath, zarr_format: ZarrFormat) -> bool: """ Check if a group exists at a given StorePath. Parameters ---------- store_path : StorePath The StorePath to check for an existing group. zarr_format : The zarr format to check for. Returns ------- bool True if the StorePath contains a group, False otherwise """ if zarr_format == 3: return (await _contains_node_v3(store_path)) == "group" elif zarr_format == 2: return await (store_path / ZGROUP_JSON).exists() msg = f"Invalid zarr_format provided. Got {zarr_format}, expected 2 or 3" # type: ignore[unreachable] raise ValueError(msg) zarr-python-3.3.0/src/zarr/storage/_fsspec.py000066400000000000000000000354651523267620000212370ustar00rootroot00000000000000from __future__ import annotations import json import warnings from contextlib import suppress from typing import TYPE_CHECKING, Any from packaging.version import parse as parse_version from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, ) from zarr.core.buffer import Buffer from zarr.errors import ZarrUserWarning from zarr.storage._utils import _dereference_path if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable from fsspec import AbstractFileSystem from fsspec.asyn import AsyncFileSystem from fsspec.mapping import FSMap from zarr.core.buffer import BufferPrototype ALLOWED_EXCEPTIONS: tuple[type[Exception], ...] = ( FileNotFoundError, IsADirectoryError, NotADirectoryError, ) def _make_async(fs: AbstractFileSystem) -> AsyncFileSystem: """Convert a sync FSSpec filesystem to an async FFSpec filesystem If the filesystem class supports async operations, a new async instance is created from the existing instance. If the filesystem class does not support async operations, the existing instance is wrapped with AsyncFileSystemWrapper. """ import fsspec fsspec_version = parse_version(fsspec.__version__) if fs.async_impl and fs.asynchronous: # Already an async instance of an async filesystem, nothing to do return fs if fs.async_impl: # Convert sync instance of an async fs to an async instance fs_dict = json.loads(fs.to_json()) fs_dict["asynchronous"] = True return fsspec.AbstractFileSystem.from_json(json.dumps(fs_dict)) if fsspec_version < parse_version("2024.12.0"): raise ImportError( f"The filesystem '{fs}' is synchronous, and the required " "AsyncFileSystemWrapper is not available. Upgrade fsspec to version " "2024.12.0 or later to enable this functionality." ) from fsspec.implementations.asyn_wrapper import AsyncFileSystemWrapper return AsyncFileSystemWrapper(fs, asynchronous=True) class FsspecStore(Store): """ Store for remote data based on FSSpec. Parameters ---------- fs : AsyncFileSystem The Async FSSpec filesystem to use with this store. read_only : bool Whether the store is read-only path : str The root path of the store. This should be a relative path and must not include the filesystem scheme. allowed_exceptions : tuple[type[Exception], ...] When fetching data, these cases will be deemed to correspond to missing keys. Attributes ---------- fs allowed_exceptions supports_writes supports_deletes supports_listing Raises ------ TypeError If the Filesystem does not support async operations. ValueError If the path argument includes a scheme. Warns ----- ZarrUserWarning If the file system (fs) was not created with `asynchronous=True`. Notes ----- Closing the store does not close the underlying filesystem or its network session. fsspec caches and shares filesystem instances across callers, so the store cannot know whether it is the only user, and closing a shared session would break other stores. The filesystem's lifecycle belongs to whoever created it; use fsspec's own tools (e.g. `clear_instance_cache`) to release it. See Also -------- FsspecStore.from_upath FsspecStore.from_url """ # based on FSSpec supports_writes: bool = True supports_deletes: bool = True supports_listing: bool = True fs: AsyncFileSystem allowed_exceptions: tuple[type[Exception], ...] path: str def __init__( self, fs: AsyncFileSystem, read_only: bool = False, path: str = "/", allowed_exceptions: tuple[type[Exception], ...] = ALLOWED_EXCEPTIONS, ) -> None: super().__init__(read_only=read_only) self.fs = fs self.path = path self.allowed_exceptions = allowed_exceptions if not self.fs.async_impl: raise TypeError("Filesystem needs to support async operations.") if not self.fs.asynchronous: warnings.warn( f"fs ({fs}) was not created with `asynchronous=True`, this may lead to surprising behavior", category=ZarrUserWarning, stacklevel=2, ) @classmethod def from_upath( cls, upath: Any, read_only: bool = False, allowed_exceptions: tuple[type[Exception], ...] = ALLOWED_EXCEPTIONS, ) -> FsspecStore: """ Create an FsspecStore from a upath object. Parameters ---------- upath : UPath The upath to the root of the store. read_only : bool Whether the store is read-only, defaults to False. allowed_exceptions : tuple, optional The exceptions that are allowed to be raised when accessing the store. Defaults to ALLOWED_EXCEPTIONS. Returns ------- FsspecStore """ return cls( fs=upath.fs, path=upath.path.rstrip("/"), read_only=read_only, allowed_exceptions=allowed_exceptions, ) @classmethod def from_mapper( cls, fs_map: FSMap, read_only: bool = False, allowed_exceptions: tuple[type[Exception], ...] = ALLOWED_EXCEPTIONS, ) -> FsspecStore: """ Create an FsspecStore from an FSMap object. Parameters ---------- fs_map : FSMap Fsspec mutable mapping object. read_only : bool Whether the store is read-only, defaults to False. allowed_exceptions : tuple, optional The exceptions that are allowed to be raised when accessing the store. Defaults to ALLOWED_EXCEPTIONS. Returns ------- FsspecStore """ fs = _make_async(fs_map.fs) return cls( fs=fs, path=fs_map.root, read_only=read_only, allowed_exceptions=allowed_exceptions, ) @classmethod def from_url( cls, url: str, storage_options: dict[str, Any] | None = None, read_only: bool = False, allowed_exceptions: tuple[type[Exception], ...] = ALLOWED_EXCEPTIONS, ) -> FsspecStore: """ Create an FsspecStore from a URL. The type of store is determined from the URL scheme. Parameters ---------- url : str The URL to the root of the store. storage_options : dict, optional The options to pass to fsspec when creating the filesystem. read_only : bool Whether the store is read-only, defaults to False. allowed_exceptions : tuple, optional The exceptions that are allowed to be raised when accessing the store. Defaults to ALLOWED_EXCEPTIONS. Returns ------- FsspecStore """ try: from fsspec import url_to_fs except ImportError: # before fsspec==2024.3.1 from fsspec.core import url_to_fs opts = storage_options or {} opts = {"asynchronous": True, **opts} fs, path = url_to_fs(url, **opts) if not fs.async_impl: fs = _make_async(fs) return cls(fs=fs, path=path, read_only=read_only, allowed_exceptions=allowed_exceptions) def with_read_only(self, read_only: bool = False) -> FsspecStore: # docstring inherited return type(self)( fs=self.fs, path=self.path, allowed_exceptions=self.allowed_exceptions, read_only=read_only, ) async def clear(self) -> None: # docstring inherited try: for subpath in await self.fs._find(self.path, withdirs=True): if subpath != self.path: await self.fs._rm(subpath, recursive=True) except FileNotFoundError: pass def __repr__(self) -> str: return f"" def __eq__(self, other: object) -> bool: return ( isinstance(other, type(self)) and self.path == other.path and self.read_only == other.read_only and self.fs == other.fs ) async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited if not self._is_open: await self._open() path = _dereference_path(self.path, key) try: if byte_range is None: value = prototype.buffer.from_bytes(await self.fs._cat_file(path)) elif isinstance(byte_range, RangeByteRequest): value = prototype.buffer.from_bytes( await self.fs._cat_file( path, start=byte_range.start, end=byte_range.end, ) ) elif isinstance(byte_range, OffsetByteRequest): value = prototype.buffer.from_bytes( await self.fs._cat_file(path, start=byte_range.offset, end=None) ) elif isinstance(byte_range, SuffixByteRequest): value = prototype.buffer.from_bytes( await self.fs._cat_file(path, start=-byte_range.suffix, end=None) ) else: raise ValueError(f"Unexpected byte_range, got {byte_range}.") except self.allowed_exceptions: return None except OSError as e: if "not satisfiable" in str(e): # this is an s3-specific condition we probably don't want to leak return prototype.buffer.from_bytes(b"") raise else: return value async def set( self, key: str, value: Buffer, byte_range: tuple[int, int] | None = None, ) -> None: # docstring inherited if not self._is_open: await self._open() self._check_writable() if not isinstance(value, Buffer): raise TypeError( f"FsspecStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) path = _dereference_path(self.path, key) # write data if byte_range: raise NotImplementedError await self.fs._pipe_file(path, value.to_bytes()) async def delete(self, key: str) -> None: # docstring inherited self._check_writable() path = _dereference_path(self.path, key) try: await self.fs._rm(path) except FileNotFoundError: pass except self.allowed_exceptions: pass async def delete_dir(self, prefix: str) -> None: # docstring inherited if not self.supports_deletes: raise NotImplementedError( "This method is only available for stores that support deletes." ) self._check_writable() path_to_delete = _dereference_path(self.path, prefix) with suppress(*self.allowed_exceptions): await self.fs._rm(path_to_delete, recursive=True) async def exists(self, key: str) -> bool: # docstring inherited path = _dereference_path(self.path, key) exists: bool = await self.fs._exists(path) return exists async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: # docstring inherited # Materialise first: key_ranges may be a one-shot iterable, so a bare # truthiness check (e.g. `if key_ranges`) would be unreliable for an # empty generator. _cat_ranges also expects lists of paths/starts/stops. key_ranges = list(key_ranges) if not key_ranges: return [] paths: list[str] = [] starts: list[int | None] = [] stops: list[int | None] = [] for key, byte_range in key_ranges: paths.append(_dereference_path(self.path, key)) if byte_range is None: starts.append(None) stops.append(None) elif isinstance(byte_range, RangeByteRequest): starts.append(byte_range.start) stops.append(byte_range.end) elif isinstance(byte_range, OffsetByteRequest): starts.append(byte_range.offset) stops.append(None) elif isinstance(byte_range, SuffixByteRequest): starts.append(-byte_range.suffix) stops.append(None) else: raise ValueError(f"Unexpected byte_range, got {byte_range}.") # TODO: expectations for exceptions or missing keys? res = await self.fs._cat_ranges(paths, starts, stops, on_error="return") # the following is an s3-specific condition we probably don't want to leak res = [b"" if (isinstance(r, OSError) and "not satisfiable" in str(r)) else r for r in res] for r in res: if isinstance(r, Exception) and not isinstance(r, self.allowed_exceptions): raise r return [None if isinstance(r, Exception) else prototype.buffer.from_bytes(r) for r in res] async def list(self) -> AsyncIterator[str]: # docstring inherited allfiles = await self.fs._find(self.path, detail=False, withdirs=False) for onefile in (a.removeprefix(f"{self.path}/") for a in allfiles): yield onefile async def list_dir(self, prefix: str) -> AsyncIterator[str]: # docstring inherited prefix = f"{self.path}/{prefix.rstrip('/')}" try: allfiles = await self.fs._ls(prefix, detail=False) except FileNotFoundError: return for onefile in (a.replace(f"{prefix}/", "") for a in allfiles): yield onefile.removeprefix(self.path).removeprefix("/") async def list_prefix(self, prefix: str) -> AsyncIterator[str]: # docstring inherited for onefile in await self.fs._find( f"{self.path}/{prefix}", detail=False, maxdepth=None, withdirs=False ): yield onefile.removeprefix(f"{self.path}/") async def getsize(self, key: str) -> int: path = _dereference_path(self.path, key) info = await self.fs._info(path) size = info.get("size") if size is None: # Not all filesystems support size. Fall back to reading the entire object return await super().getsize(key) else: # fsspec doesn't have typing. We'll need to assume or verify this is true return int(size) zarr-python-3.3.0/src/zarr/storage/_local.py000066400000000000000000000274201523267620000210360ustar00rootroot00000000000000from __future__ import annotations import asyncio import contextlib import io import os import shutil import sys import uuid from pathlib import Path from typing import TYPE_CHECKING, BinaryIO, Literal, Self from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, ) from zarr.core.buffer import Buffer from zarr.core.buffer.core import default_buffer_prototype from zarr.core.common import AccessModeLiteral, concurrent_map if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable, Iterator from zarr.core.buffer import BufferPrototype def _get(path: Path, prototype: BufferPrototype, byte_range: ByteRequest | None) -> Buffer: if byte_range is None: return prototype.buffer.from_bytes(path.read_bytes()) with path.open("rb") as f: size = f.seek(0, io.SEEK_END) if isinstance(byte_range, RangeByteRequest): f.seek(byte_range.start) return prototype.buffer.from_bytes(f.read(byte_range.end - f.tell())) elif isinstance(byte_range, OffsetByteRequest): f.seek(byte_range.offset) elif isinstance(byte_range, SuffixByteRequest): f.seek(max(0, size - byte_range.suffix)) else: raise TypeError(f"Unexpected byte_range, got {byte_range}.") return prototype.buffer.from_bytes(f.read()) if sys.platform == "win32": # Per the os.rename docs: # On Windows, if dst exists a FileExistsError is always raised. _safe_move = os.rename else: # On Unix, os.rename silently replace files, so instead we use os.link like # atomicwrites: # https://github.com/untitaker/python-atomicwrites/blob/1.4.1/atomicwrites/__init__.py#L59-L60 # This also raises FileExistsError if dst exists. def _safe_move(src: Path, dst: Path) -> None: os.link(src, dst) os.unlink(src) @contextlib.contextmanager def _atomic_write( path: Path, mode: Literal["r+b", "wb"], exclusive: bool = False, ) -> Iterator[BinaryIO]: tmp_path = path.with_suffix(f".{uuid.uuid4().hex}.partial") try: with tmp_path.open(mode) as f: yield f if exclusive: _safe_move(tmp_path, path) else: tmp_path.replace(path) except Exception: tmp_path.unlink(missing_ok=True) raise def _put(path: Path, value: Buffer, exclusive: bool = False) -> int: path.parent.mkdir(parents=True, exist_ok=True) # write takes any object supporting the buffer protocol view = value.as_buffer_like() with _atomic_write(path, "wb", exclusive=exclusive) as f: return f.write(view) class LocalStore(Store): """ Store for the local file system. Parameters ---------- root : str or Path Directory to use as root of store. read_only : bool Whether the store is read-only Attributes ---------- supports_writes supports_deletes supports_listing root """ supports_writes: bool = True supports_deletes: bool = True supports_listing: bool = True root: Path def __init__(self, root: Path | str, *, read_only: bool = False) -> None: super().__init__(read_only=read_only) if isinstance(root, str): root = Path(root) if not isinstance(root, Path): raise TypeError( f"'root' must be a string or Path instance. Got an instance of {type(root)} instead." ) self.root = root def with_read_only(self, read_only: bool = False) -> Self: # docstring inherited return type(self)( root=self.root, read_only=read_only, ) @classmethod async def open( cls, root: Path | str, *, read_only: bool = False, mode: AccessModeLiteral | None = None ) -> Self: """ Create and open the store. Parameters ---------- root : str or Path Directory to use as root of store. read_only : bool Whether the store is read-only mode : Mode in which to create the store. This only affects opening the store, and the final read-only state of the store is controlled through the read_only parameter. Returns ------- Store The opened store instance. """ # If mode = 'r+', want to open in read only mode (fail if exists), # but return a writeable store if mode is not None: read_only_creation = mode in ["r", "r+"] else: read_only_creation = read_only store = cls(root, read_only=read_only_creation) await store._open() # Set read_only state store = store.with_read_only(read_only) await store._open() return store async def _open(self, *, mode: AccessModeLiteral | None = None) -> None: if not self.read_only: self.root.mkdir(parents=True, exist_ok=True) if not self.root.exists(): raise FileNotFoundError(f"{self.root} does not exist") return await super()._open() async def clear(self) -> None: # docstring inherited self._check_writable() shutil.rmtree(self.root) self.root.mkdir() def __str__(self) -> str: return f"file://{self.root.as_posix()}" def __repr__(self) -> str: return f"LocalStore('{self}')" def __eq__(self, other: object) -> bool: return isinstance(other, type(self)) and self.root == other.root # ------------------------------------------------------------------- # Synchronous store methods # ------------------------------------------------------------------- def _ensure_open_sync(self) -> None: if not self._is_open: if not self.read_only: self.root.mkdir(parents=True, exist_ok=True) if not self.root.exists(): raise FileNotFoundError(f"{self.root} does not exist") self._is_open = True def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: if prototype is None: prototype = default_buffer_prototype() self._ensure_open_sync() assert isinstance(key, str) path = self.root / key try: return _get(path, prototype, byte_range) except (FileNotFoundError, IsADirectoryError, NotADirectoryError): return None def set_sync(self, key: str, value: Buffer) -> None: self._ensure_open_sync() self._check_writable() assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"LocalStore.set(): `value` must be a Buffer instance. " f"Got an instance of {type(value)} instead." ) path = self.root / key _put(path, value) def delete_sync(self, key: str) -> None: self._ensure_open_sync() self._check_writable() path = self.root / key if path.is_dir(): shutil.rmtree(path) else: path.unlink(missing_ok=True) async def get( self, key: str, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited if prototype is None: prototype = default_buffer_prototype() if not self._is_open: await self._open() assert isinstance(key, str) path = self.root / key try: return await asyncio.to_thread(_get, path, prototype, byte_range) except (FileNotFoundError, IsADirectoryError, NotADirectoryError): return None async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: # docstring inherited args = [] for key, byte_range in key_ranges: assert isinstance(key, str) path = self.root / key args.append((_get, path, prototype, byte_range)) return await concurrent_map(args, asyncio.to_thread, limit=None) # TODO: fix limit async def set(self, key: str, value: Buffer) -> None: # docstring inherited return await self._set(key, value) async def set_if_not_exists(self, key: str, value: Buffer) -> None: # docstring inherited try: return await self._set(key, value, exclusive=True) except FileExistsError: pass async def _set(self, key: str, value: Buffer, exclusive: bool = False) -> None: if not self._is_open: await self._open() self._check_writable() assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"LocalStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) path = self.root / key await asyncio.to_thread(_put, path, value, exclusive=exclusive) async def delete(self, key: str) -> None: """ Remove a key from the store. Parameters ---------- key : str Notes ----- If ``key`` is a directory within this store, the entire directory at ``store.root / key`` is deleted. """ # docstring inherited self._check_writable() path = self.root / key if path.is_dir(): # TODO: support deleting directories? shutil.rmtree? shutil.rmtree(path) else: await asyncio.to_thread(path.unlink, True) # Q: we may want to raise if path is missing async def delete_dir(self, prefix: str) -> None: # docstring inherited self._check_writable() path = self.root / prefix if path.is_dir(): shutil.rmtree(path) elif path.is_file(): raise ValueError(f"delete_dir was passed a {prefix=!r} that is a file") else: # Non-existent directory # This path is tested by test_group:test_create_creates_parents for one pass async def exists(self, key: str) -> bool: # docstring inherited path = self.root / key return await asyncio.to_thread(path.is_file) async def list(self) -> AsyncIterator[str]: # docstring inherited to_strip = self.root.as_posix() + "/" for p in list(self.root.rglob("*")): if p.is_file(): yield p.as_posix().replace(to_strip, "") async def list_prefix(self, prefix: str) -> AsyncIterator[str]: # docstring inherited to_strip = self.root.as_posix() + "/" prefix = prefix.rstrip("/") for p in (self.root / prefix).rglob("*"): if p.is_file(): yield p.as_posix().replace(to_strip, "") async def list_dir(self, prefix: str) -> AsyncIterator[str]: # docstring inherited base = self.root / prefix try: key_iter = base.iterdir() for key in key_iter: yield key.relative_to(base).as_posix() except (FileNotFoundError, NotADirectoryError): pass async def move(self, dest_root: Path | str) -> None: """ Move the store to another path. The old root directory is deleted. """ if isinstance(dest_root, str): dest_root = Path(dest_root) os.makedirs(dest_root.parent, exist_ok=True) if dest_root.exists(): raise FileExistsError(f"Destination root {dest_root} already exists.") shutil.move(self.root, dest_root) self.root = dest_root async def getsize(self, key: str) -> int: return (self.root / key).stat().st_size zarr-python-3.3.0/src/zarr/storage/_logging.py000066400000000000000000000177341523267620000214010ustar00rootroot00000000000000from __future__ import annotations import inspect import logging import sys import time from collections import defaultdict from contextlib import contextmanager from typing import TYPE_CHECKING, Any, Self from zarr.abc.store import Store from zarr.storage._wrapper import WrapperStore if TYPE_CHECKING: from collections.abc import AsyncGenerator, Generator, Iterable from zarr.abc.store import ByteRequest from zarr.core.buffer import Buffer, BufferPrototype counter: defaultdict[str, int] class LoggingStore[T_Store: Store](WrapperStore[T_Store]): """ Store that logs all calls to another wrapped store. Parameters ---------- store : Store Store to wrap log_level : str Log level log_handler : logging.Handler Log handler Attributes ---------- counter : dict Counter of number of times each method has been called """ counter: defaultdict[str, int] def __init__( self, store: T_Store, log_level: str = "DEBUG", log_handler: logging.Handler | None = None, ) -> None: super().__init__(store) self.counter = defaultdict(int) self.log_level = log_level self.log_handler = log_handler self._configure_logger(log_level, log_handler) def _configure_logger( self, log_level: str = "DEBUG", log_handler: logging.Handler | None = None ) -> None: self.log_level = log_level self.logger = logging.getLogger(f"LoggingStore({self._store})") self.logger.setLevel(log_level) if not self.logger.hasHandlers(): if not log_handler: log_handler = self._default_handler() # Add handler to logger self.logger.addHandler(log_handler) def _default_handler(self) -> logging.Handler: """Define a default log handler""" handler = logging.StreamHandler(stream=sys.stdout) handler.setLevel(self.log_level) handler.setFormatter( logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") ) return handler def _with_store(self, store: T_Store) -> Self: return type(self)(store=store, log_level=self.log_level, log_handler=self.log_handler) @contextmanager def log(self, hint: Any = "") -> Generator[None, None, None]: """Context manager to log method calls Each call to the wrapped store is logged to the configured logger and added to the counter dict. """ method = inspect.stack()[2].function op = f"{type(self._store).__name__}.{method}" if hint: op = f"{op}({hint})" self.logger.info(" Calling %s", op) start_time = time.time() try: self.counter[method] += 1 yield finally: end_time = time.time() self.logger.info("Finished %s [%.2f s]", op, end_time - start_time) @classmethod async def open(cls: type[Self], store_cls: type[T_Store], *args: Any, **kwargs: Any) -> Self: log_level = kwargs.pop("log_level", "DEBUG") log_handler = kwargs.pop("log_handler", None) store = store_cls(*args, **kwargs) await store._open() return cls(store=store, log_level=log_level, log_handler=log_handler) @property def supports_writes(self) -> bool: with self.log(): return self._store.supports_writes @property def supports_deletes(self) -> bool: with self.log(): return self._store.supports_deletes @property def supports_listing(self) -> bool: with self.log(): return self._store.supports_listing @property def read_only(self) -> bool: with self.log(): return self._store.read_only @property def _is_open(self) -> bool: with self.log(): return self._store._is_open @_is_open.setter def _is_open(self, value: bool) -> None: raise NotImplementedError("LoggingStore must be opened via the `_open` method") async def _open(self) -> None: with self.log(): return await self._store._open() async def _ensure_open(self) -> None: with self.log(): return await self._store._ensure_open() async def is_empty(self, prefix: str = "") -> bool: # docstring inherited with self.log(): return await self._store.is_empty(prefix=prefix) async def clear(self) -> None: # docstring inherited with self.log(): return await self._store.clear() def __str__(self) -> str: return f"logging-{self._store}" def __repr__(self) -> str: return f"LoggingStore({self._store.__class__.__name__}, '{self._store}')" def __eq__(self, other: object) -> bool: with self.log(other): return type(self) is type(other) and self._store.__eq__(other._store) async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited with self.log(key): return await self._store.get(key=key, prototype=prototype, byte_range=byte_range) async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: # docstring inherited key_ranges = list(key_ranges) keys = ",".join([k[0] for k in key_ranges]) with self.log(keys): return await self._store.get_partial_values(prototype=prototype, key_ranges=key_ranges) async def exists(self, key: str) -> bool: # docstring inherited with self.log(key): return await self._store.exists(key) async def set(self, key: str, value: Buffer) -> None: # docstring inherited with self.log(key): return await self._store.set(key=key, value=value) async def set_if_not_exists(self, key: str, value: Buffer) -> None: # docstring inherited with self.log(key): return await self._store.set_if_not_exists(key=key, value=value) async def delete(self, key: str) -> None: # docstring inherited with self.log(key): return await self._store.delete(key=key) def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited with self.log(key): return super().get_sync(key, prototype=prototype, byte_range=byte_range) def set_sync(self, key: str, value: Buffer) -> None: # docstring inherited with self.log(key): return super().set_sync(key, value) def delete_sync(self, key: str) -> None: # docstring inherited with self.log(key): return super().delete_sync(key) async def list(self) -> AsyncGenerator[str, None]: # docstring inherited with self.log(): async for key in self._store.list(): yield key async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]: # docstring inherited with self.log(prefix): async for key in self._store.list_prefix(prefix=prefix): yield key async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]: # docstring inherited with self.log(prefix): async for key in self._store.list_dir(prefix=prefix): yield key async def delete_dir(self, prefix: str) -> None: # docstring inherited with self.log(prefix): await self._store.delete_dir(prefix=prefix) async def getsize(self, key: str) -> int: with self.log(key): return await self._store.getsize(key) async def getsize_prefix(self, prefix: str) -> int: with self.log(prefix): return await self._store.getsize_prefix(prefix) zarr-python-3.3.0/src/zarr/storage/_memory.py000066400000000000000000000601031523267620000212470ustar00rootroot00000000000000from __future__ import annotations import os import threading import weakref from logging import getLogger from typing import TYPE_CHECKING, Any, Self from zarr.abc.store import ByteRequest, Store from zarr.core.buffer import Buffer, gpu from zarr.core.buffer.core import default_buffer_prototype from zarr.core.common import concurrent_map from zarr.storage._utils import ( _join_paths, _normalize_byte_range_index, normalize_path, parse_store_url, ) if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable, MutableMapping from zarr.core.buffer import BufferPrototype logger = getLogger(__name__) def _copy_buffer(value: Buffer) -> Buffer: """Copy `value` so the store does not retain the caller's memory. Encoding a chunk can hand the store a zero-copy view of the user's array (an uncompressed write is the common case), and unlike stores that serialize on write, this one keeps whatever it is given alive in a dict. Without this copy a later mutation of the user's array would rewrite chunks already committed to the store. """ return type(value).from_array_like(value.as_array_like().copy()) class MemoryStore(Store): """ Store for local memory. Parameters ---------- store_dict : dict Initial data read_only : bool Whether the store is read-only Attributes ---------- supports_writes supports_deletes supports_listing Notes ----- Writes copy the buffer they are given, so the store never aliases the caller's memory. Buffers passed via `store_dict` are the caller's responsibility and are stored as-is. """ supports_writes: bool = True supports_deletes: bool = True supports_listing: bool = True _store_dict: MutableMapping[str, Buffer] def __init__( self, store_dict: MutableMapping[str, Buffer] | None = None, *, read_only: bool = False, ) -> None: super().__init__(read_only=read_only) if store_dict is None: store_dict = {} self._store_dict = store_dict def with_read_only(self, read_only: bool = False) -> MemoryStore: # docstring inherited return type(self)( store_dict=self._store_dict, read_only=read_only, ) async def clear(self) -> None: # docstring inherited self._store_dict.clear() def __str__(self) -> str: return f"memory://{id(self._store_dict)}" def __repr__(self) -> str: return f"MemoryStore('{self}')" def __eq__(self, other: object) -> bool: return ( isinstance(other, type(self)) and self._store_dict == other._store_dict and self.read_only == other.read_only ) # ------------------------------------------------------------------- # Synchronous store methods # ------------------------------------------------------------------- def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: if prototype is None: prototype = default_buffer_prototype() if not self._is_open: self._is_open = True assert isinstance(key, str) try: value = self._store_dict[key] start, stop = _normalize_byte_range_index(value, byte_range) return prototype.buffer.from_buffer(value[start:stop]) except KeyError: return None def set_sync(self, key: str, value: Buffer) -> None: self._check_writable() if not self._is_open: self._is_open = True assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"MemoryStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) self._store_dict[key] = _copy_buffer(value) def delete_sync(self, key: str) -> None: self._check_writable() if not self._is_open: self._is_open = True try: del self._store_dict[key] except KeyError: logger.debug("Key %s does not exist.", key) async def get( self, key: str, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited if prototype is None: prototype = default_buffer_prototype() if not self._is_open: await self._open() assert isinstance(key, str) try: value = self._store_dict[key] start, stop = _normalize_byte_range_index(value, byte_range) return prototype.buffer.from_buffer(value[start:stop]) except KeyError: return None async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: # docstring inherited # All the key-ranges arguments goes with the same prototype async def _get(key: str, byte_range: ByteRequest | None) -> Buffer | None: return await self.get(key, prototype=prototype, byte_range=byte_range) return await concurrent_map(key_ranges, _get, limit=None) async def exists(self, key: str) -> bool: # docstring inherited return key in self._store_dict async def set(self, key: str, value: Buffer, byte_range: tuple[int, int] | None = None) -> None: # docstring inherited self._check_writable() await self._ensure_open() assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"MemoryStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) if byte_range is not None: buf = self._store_dict[key] buf[byte_range[0] : byte_range[1]] = value self._store_dict[key] = buf else: self._store_dict[key] = _copy_buffer(value) async def set_if_not_exists(self, key: str, value: Buffer) -> None: # docstring inherited self._check_writable() await self._ensure_open() self._store_dict.setdefault(key, _copy_buffer(value)) async def delete(self, key: str) -> None: # docstring inherited self._check_writable() try: del self._store_dict[key] except KeyError: logger.debug("Key %s does not exist.", key) async def list(self) -> AsyncIterator[str]: # docstring inherited for key in self._store_dict: yield key async def list_prefix(self, prefix: str) -> AsyncIterator[str]: # docstring inherited # note: we materialize all dict keys into a list here so we can mutate the dict in-place (e.g. in delete_prefix) for key in list(self._store_dict): if key.startswith(prefix): yield key async def list_dir(self, prefix: str) -> AsyncIterator[str]: # docstring inherited prefix = prefix.rstrip("/") if prefix == "": keys_unique = {k.split("/")[0] for k in self._store_dict} else: # Our dictionary doesn't contain directory markers, but we want to include # a pseudo directory when there's a nested item and we're listing an # intermediate level. keys_unique = { key.removeprefix(f"{prefix}/").split("/")[0] for key in self._store_dict if key.startswith(f"{prefix}/") and key not in {prefix, f"{prefix}/"} } for key in keys_unique: yield key class GpuMemoryStore(MemoryStore): """ Store for GPU memory. Stores every chunk in GPU memory irrespective of the original location. The dictionary of buffers to initialize this memory store with *must* be GPU Buffers. Writing data to this store through ``.set`` will move the buffer to the GPU if necessary. Parameters ---------- store_dict : MutableMapping, optional A mutable mapping with string keys and [zarr.core.buffer.gpu.Buffer][] values. read_only : bool Whether to open the store in read-only mode. """ _store_dict: MutableMapping[str, gpu.Buffer] # type: ignore[assignment] def __init__( self, store_dict: MutableMapping[str, gpu.Buffer] | None = None, *, read_only: bool = False, ) -> None: super().__init__(store_dict=store_dict, read_only=read_only) # type: ignore[arg-type] def __str__(self) -> str: return f"gpumemory://{id(self._store_dict)}" def __repr__(self) -> str: return f"GpuMemoryStore('{self}')" @classmethod def from_dict(cls, store_dict: MutableMapping[str, Buffer]) -> Self: """ Create a GpuMemoryStore from a dictionary of buffers at any location. The dictionary backing the newly created ``GpuMemoryStore`` will not be the same as ``store_dict``. Parameters ---------- store_dict : mapping A mapping of strings keys to arbitrary Buffers. The buffer data will be moved into a [`gpu.Buffer`][zarr.core.buffer.gpu.Buffer]. Returns ------- GpuMemoryStore """ gpu_store_dict = {k: gpu.Buffer.from_buffer(v) for k, v in store_dict.items()} return cls(gpu_store_dict) async def set(self, key: str, value: Buffer, byte_range: tuple[int, int] | None = None) -> None: # docstring inherited self._check_writable() assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"GpuMemoryStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) # Convert to gpu.Buffer gpu_value = value if isinstance(value, gpu.Buffer) else gpu.Buffer.from_buffer(value) await super().set(key, gpu_value, byte_range=byte_range) def set_sync(self, key: str, value: Buffer) -> None: # docstring inherited self._check_writable() assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"GpuMemoryStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) # Convert to gpu.Buffer, mirroring `set` above: every value in this store's # backing dict must be a gpu.Buffer, regardless of which API wrote it. gpu_value = value if isinstance(value, gpu.Buffer) else gpu.Buffer.from_buffer(value) super().set_sync(key, gpu_value) # ----------------------------------------------------------------------------- # ManagedMemoryStore and its registry # ----------------------------------------------------------------------------- # ManagedMemoryStore owns the lifecycle of its backing dict, enabling proper # weakref-based tracking. This allows memory:// URLs to be resolved back to # the store's dict within the same process. class _ManagedStoreDict(dict[str, Buffer]): """ A dict subclass that supports weak references. Regular dicts don't support weakrefs, but we need to track managed store dicts in a WeakValueDictionary so they can be garbage collected when no longer referenced. This subclass adds the necessary __weakref__ slot. """ __slots__ = ("__weakref__",) class _ManagedStoreDictRegistry: """ Registry for managed store dicts. This registry is the source of truth for managed store dicts. It creates new dicts, tracks them via weak references, and looks them up by name. """ def __init__(self) -> None: self._registry: weakref.WeakValueDictionary[str, _ManagedStoreDict] = ( weakref.WeakValueDictionary() ) self._counter = 0 self._lock = threading.Lock() def _generate_name(self) -> str: """Generate a unique name for a store. Must be called while holding `self._lock`. """ name = str(self._counter) self._counter += 1 return name def get_or_create(self, name: str | None = None) -> tuple[_ManagedStoreDict, str]: """ Get an existing managed dict by name, or create a new one. Thread-safe: uses a lock to prevent TOCTOU races between checking for an existing entry and inserting a new one. Parameters ---------- name : str | None The name for the store. If None, a unique name is auto-generated. If a store with this name already exists, returns the existing store. Names cannot contain '/' characters. Returns ------- tuple[_ManagedStoreDict, str] The store dict and its name. Raises ------ ValueError If the name contains '/' characters. """ with self._lock: if name is None: name = self._generate_name() elif "/" in name: raise ValueError( f"Store name cannot contain '/': {name!r}. " "Use the 'path' parameter to specify a path within the store." ) existing = self._registry.get(name) if existing is not None: return existing, name store_dict = _ManagedStoreDict() self._registry[name] = store_dict return store_dict, name def get(self, name: str) -> _ManagedStoreDict | None: """ Look up a managed store dict by name. Parameters ---------- name : str The name of the store. Returns ------- _ManagedStoreDict | None The store dict if found, None otherwise. """ return self._registry.get(name) _managed_store_dict_registry = _ManagedStoreDictRegistry() class ManagedMemoryStore(MemoryStore): """ A memory store that owns and manages the lifecycle of its backing dict. Unlike ``MemoryStore`` which accepts any ``MutableMapping``, this store creates and owns its backing dict internally. This enables proper lifecycle management and allows the store to be looked up by its ``memory://`` URL within the same process. Parameters ---------- name : str | None The name for this store, used in the ``memory://`` URL. If None, a unique name is auto-generated. If a store with this name already exists, the new store will share the same backing dict. path : str The root path for this store. All keys will be prefixed with this path. read_only : bool Whether the store is read-only. Attributes ---------- name : str The name of this store. path : str The root path of this store. Notes ----- The backing dict is tracked via weak references and will be garbage collected when no ``ManagedMemoryStore`` instances reference it. URLs pointing to a garbage-collected store will fail to resolve. See Also -------- MemoryStore : A memory store that accepts any MutableMapping. Examples -------- >>> store = ManagedMemoryStore(name="my-data") >>> str(store) 'memory://my-data' >>> # Later, resolve the URL back to the store's dict >>> store2 = ManagedMemoryStore.from_url("memory://my-data") >>> store2._store_dict is store._store_dict True >>> # Create a store with a path prefix >>> store3 = ManagedMemoryStore.from_url("memory://my-data/subdir") >>> store3.path 'subdir' """ _store_dict: _ManagedStoreDict _name: str path: str def __init__(self, name: str | None = None, *, path: str = "", read_only: bool = False) -> None: # Skip MemoryStore.__init__ and call Store.__init__ directly # because we manage _store_dict via the registry, not via a user-supplied # MutableMapping. If MemoryStore.__init__ ever adds logic beyond setting # _store_dict, that logic must be replicated here. Store.__init__(self, read_only=read_only) # Get or create a managed dict from the registry self._store_dict, self._name = _managed_store_dict_registry.get_or_create(name) self.path = normalize_path(path) def __str__(self) -> str: return _join_paths([f"memory://{self._name}", self.path]) def __repr__(self) -> str: return f"ManagedMemoryStore('{self}')" def __eq__(self, other: object) -> bool: return ( isinstance(other, type(self)) and self._store_dict is other._store_dict and self.path == other.path and self.read_only == other.read_only ) @property def name(self) -> str: """The name of this store, used in the memory:// URL.""" return self._name @classmethod def _from_managed_dict( cls, managed_dict: _ManagedStoreDict, name: str, *, path: str = "", read_only: bool = False, ) -> ManagedMemoryStore: """Internal: create a store from an existing managed dict.""" store = object.__new__(cls) Store.__init__(store, read_only=read_only) store._store_dict = managed_dict store._name = name store.path = normalize_path(path) return store def with_read_only(self, read_only: bool = False) -> ManagedMemoryStore: # docstring inherited return type(self)._from_managed_dict( self._store_dict, self._name, path=self.path, read_only=read_only ) @classmethod def from_url(cls, url: str, *, read_only: bool = False) -> ManagedMemoryStore: """ Create a ManagedMemoryStore from a memory:// URL. This looks up the backing dict in the process-wide registry and creates a new store instance that shares the same dict. Parameters ---------- url : str A URL like "memory://my-store" or "memory://my-store/path/to/data" identifying the store and optional path prefix. read_only : bool Whether the new store should be read-only. Returns ------- ManagedMemoryStore A store sharing the same backing dict as the original. Raises ------ ValueError If the URL is not a valid memory:// URL or the store has been garbage collected. """ parsed = parse_store_url(url) if parsed.scheme != "memory": raise ValueError( f"Expected a 'memory://' URL, got scheme {parsed.scheme!r} in '{url}'." ) name = parsed.name or "" managed_dict = _managed_store_dict_registry.get(name) if managed_dict is None: raise ValueError( f"Memory store not found for URL '{url}'. " "The store may have been garbage collected." ) return cls._from_managed_dict(managed_dict, name, path=parsed.path, read_only=read_only) # Override MemoryStore methods to use path prefix and check process def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited return super().get_sync( _join_paths([self.path, key]), prototype=prototype, byte_range=byte_range ) def set_sync(self, key: str, value: Buffer) -> None: # docstring inherited super().set_sync(_join_paths([self.path, key]), value) def delete_sync(self, key: str) -> None: # docstring inherited super().delete_sync(_join_paths([self.path, key])) async def get( self, key: str, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited return await super().get( _join_paths([self.path, key]), prototype=prototype, byte_range=byte_range ) # get_partial_values is intentionally NOT overridden here: MemoryStore.get_partial_values # dispatches per-key through `self.get`, which already resolves to the override above. # Re-prefixing the keys here as well would apply `self.path` twice. async def exists(self, key: str) -> bool: # docstring inherited return await super().exists(_join_paths([self.path, key])) async def set(self, key: str, value: Buffer, byte_range: tuple[int, int] | None = None) -> None: # docstring inherited return await super().set(_join_paths([self.path, key]), value, byte_range=byte_range) async def set_if_not_exists(self, key: str, value: Buffer) -> None: # docstring inherited return await super().set_if_not_exists(_join_paths([self.path, key]), value) async def delete(self, key: str) -> None: # docstring inherited return await super().delete(_join_paths([self.path, key])) async def list(self) -> AsyncIterator[str]: # docstring inherited prefix = f"{self.path}/" if self.path else "" async for key in super().list(): if key.startswith(prefix): yield key.removeprefix(prefix) async def list_prefix(self, prefix: str) -> AsyncIterator[str]: # docstring inherited # Manual concatenation instead of _join_paths because we need "path/" # as the prefix when prefix is empty (to list all keys under self.path) full_prefix = f"{self.path}/{prefix}" if self.path else prefix path_prefix = f"{self.path}/" if self.path else "" async for key in super().list_prefix(full_prefix): yield key.removeprefix(path_prefix) async def list_dir(self, prefix: str) -> AsyncIterator[str]: # docstring inherited full_prefix = _join_paths([self.path, prefix]) async for key in super().list_dir(full_prefix): yield key def __reduce__( self, ) -> tuple[type[ManagedMemoryStore], tuple[str | None], dict[str, Any]]: """ Support pickling of ManagedMemoryStore. On unpickle, the store will reconnect to an existing store with the same name if one exists in the registry, or create a new empty store otherwise. Note that the backing dict data is NOT serialized - only the store's identity (name, path, read_only) is preserved. If the original store has been garbage collected, the unpickled store will have an empty dict. The current process ID is preserved so that cross-process unpickling can be detected and will raise an error at unpickle time. """ return ( self.__class__, (self._name,), { "path": self.path, "read_only": self.read_only, "created_pid": os.getpid(), }, ) def __setstate__(self, state: dict[str, Any]) -> None: """Restore state after unpickling. The pickle protocol calls ``cls(name)`` (via ``__reduce__``'s args) then ``__setstate__(state)``. ``__init__`` already set up ``_store_dict`` and ``_name`` from the registry — we just restore path and read_only here. """ # Check for cross-process usage first, before mutating state created_pid = state.get("created_pid") if created_pid is not None and created_pid != os.getpid(): raise RuntimeError( f"ManagedMemoryStore '{self._name}' was created in process {created_pid} " f"but is being unpickled in process {os.getpid()}. " "ManagedMemoryStore instances cannot be shared across processes because " "their backing dict is not serialized. Use a persistent store (e.g., " "LocalStore, ZipStore) for cross-process data sharing." ) self.path = normalize_path(state.get("path", "")) # Use the Store-level _read_only attribute directly because # Store.__init__ was already called by __init__ during unpickling self._read_only = state.get("read_only", False) zarr-python-3.3.0/src/zarr/storage/_obstore.py000066400000000000000000000422241523267620000214200ustar00rootroot00000000000000from __future__ import annotations import asyncio import contextlib import pickle from collections import defaultdict from itertools import chain from operator import itemgetter from typing import TYPE_CHECKING, Self, TypedDict from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, ) from zarr.core.common import concurrent_map from zarr.core.config import config from zarr.storage._utils import _relativize_path if TYPE_CHECKING: from collections.abc import AsyncGenerator, Coroutine, Iterable, Sequence from typing import Any from obstore import ListResult, ListStream, ObjectMeta, OffsetRange, SuffixRange from obstore.store import ObjectStore as _UpstreamObjectStore from zarr.core.buffer import Buffer, BufferPrototype __all__ = ["ObjectStore"] _ALLOWED_EXCEPTIONS: tuple[type[Exception], ...] = ( FileNotFoundError, IsADirectoryError, NotADirectoryError, ) class ObjectStore[T_Store: "_UpstreamObjectStore"](Store): """ Store that uses obstore for fast read/write from AWS, GCP, Azure. Parameters ---------- store : obstore.store.ObjectStore An obstore store instance that is set up with the proper credentials. read_only : bool Whether to open the store in read-only mode. Warnings -------- ObjectStore is experimental and subject to API changes without notice. Please raise an issue with any comments/concerns about the store. """ store: T_Store """The underlying obstore instance.""" def __eq__(self, value: object) -> bool: if not isinstance(value, ObjectStore): return False if not self.read_only == value.read_only: return False return self.store == value.store # type: ignore[no-any-return] def __init__(self, store: T_Store, *, read_only: bool = False) -> None: if not store.__class__.__module__.startswith("obstore"): raise TypeError(f"expected ObjectStore class, got {store!r}") super().__init__(read_only=read_only) self.store = store def with_read_only(self, read_only: bool = False) -> Self: # docstring inherited return type(self)( store=self.store, read_only=read_only, ) def __str__(self) -> str: return f"object_store://{self.store}" def __repr__(self) -> str: return f"{type(self).__name__}({self})" def __getstate__(self) -> dict[Any, Any]: state = self.__dict__.copy() state["store"] = pickle.dumps(self.store) return state def __setstate__(self, state: dict[Any, Any]) -> None: state["store"] = pickle.loads(state["store"]) self.__dict__.update(state) async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: # docstring inherited import obstore as obs try: if byte_range is None: resp = await obs.get_async(self.store, key) return prototype.buffer.from_bytes(await resp.bytes_async()) # type: ignore[arg-type] elif isinstance(byte_range, RangeByteRequest): bytes = await obs.get_range_async( self.store, key, start=byte_range.start, end=byte_range.end ) return prototype.buffer.from_bytes(bytes) # type: ignore[arg-type] elif isinstance(byte_range, OffsetByteRequest): resp = await obs.get_async( self.store, key, options={"range": {"offset": byte_range.offset}} ) return prototype.buffer.from_bytes(await resp.bytes_async()) # type: ignore[arg-type] elif isinstance(byte_range, SuffixByteRequest): # some object stores (Azure) don't support suffix requests. In this # case, our workaround is to first get the length of the object and then # manually request the byte range at the end. try: resp = await obs.get_async( self.store, key, options={"range": {"suffix": byte_range.suffix}} ) return prototype.buffer.from_bytes(await resp.bytes_async()) # type: ignore[arg-type] except obs.exceptions.NotSupportedError: head_resp = await obs.head_async(self.store, key) file_size = head_resp["size"] suffix_len = byte_range.suffix buffer = await obs.get_range_async( self.store, key, start=file_size - suffix_len, length=suffix_len, ) return prototype.buffer.from_bytes(buffer) # type: ignore[arg-type] else: raise ValueError(f"Unexpected byte_range, got {byte_range}") except _ALLOWED_EXCEPTIONS: return None async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: # docstring inherited return await _get_partial_values(self.store, prototype=prototype, key_ranges=key_ranges) async def exists(self, key: str) -> bool: # docstring inherited import obstore as obs try: await obs.head_async(self.store, key) except FileNotFoundError: return False else: return True @property def supports_writes(self) -> bool: # docstring inherited return True async def set(self, key: str, value: Buffer) -> None: # docstring inherited import obstore as obs self._check_writable() buf = value.as_buffer_like() await obs.put_async(self.store, key, buf) async def set_if_not_exists(self, key: str, value: Buffer) -> None: # docstring inherited import obstore as obs self._check_writable() buf = value.as_buffer_like() with contextlib.suppress(obs.exceptions.AlreadyExistsError): await obs.put_async(self.store, key, buf, mode="create") @property def supports_deletes(self) -> bool: # docstring inherited return True async def delete(self, key: str) -> None: # docstring inherited import obstore as obs self._check_writable() # Some obstore stores such as local filesystems, GCP and Azure raise an error # when deleting a non-existent key, while others such as S3 and in-memory do # not. We suppress the error to make the behavior consistent across all obstore # stores. This is also in line with the behavior of the other Zarr store adapters. with contextlib.suppress(FileNotFoundError): await obs.delete_async(self.store, key) async def delete_dir(self, prefix: str) -> None: # docstring inherited import obstore as obs self._check_writable() if prefix != "" and not prefix.endswith("/"): prefix += "/" metas = await obs.list(self.store, prefix).collect_async() keys = [(m["path"],) for m in metas] await concurrent_map(keys, self.delete, limit=config.get("async.concurrency")) @property def supports_listing(self) -> bool: # docstring inherited return True async def _list(self, prefix: str | None = None) -> AsyncGenerator[ObjectMeta, None]: import obstore as obs objects: ListStream[Sequence[ObjectMeta]] = obs.list(self.store, prefix=prefix) async for batch in objects: for item in batch: yield item def list(self) -> AsyncGenerator[str, None]: # docstring inherited return (obj["path"] async for obj in self._list()) def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]: # docstring inherited return (obj["path"] async for obj in self._list(prefix)) def list_dir(self, prefix: str) -> AsyncGenerator[str, None]: # docstring inherited import obstore as obs coroutine = obs.list_with_delimiter_async(self.store, prefix=prefix) return _transform_list_dir(coroutine, prefix) async def getsize(self, key: str) -> int: # docstring inherited import obstore as obs resp = await obs.head_async(self.store, key) return resp["size"] async def getsize_prefix(self, prefix: str) -> int: # docstring inherited sizes = [obj["size"] async for obj in self._list(prefix=prefix)] return sum(sizes) async def _transform_list_dir( list_result_coroutine: Coroutine[Any, Any, ListResult[Sequence[ObjectMeta]]], prefix: str ) -> AsyncGenerator[str, None]: """ Transform the result of list_with_delimiter into an async generator of paths. """ list_result = await list_result_coroutine # We assume that the underlying object-store implementation correctly handles the # prefix, so we don't double-check that the returned results actually start with the # given prefix. prefix = prefix.rstrip("/") for path in chain( list_result["common_prefixes"], map(itemgetter("path"), list_result["objects"]) ): if prefix != "" and path == prefix: continue relpath = _relativize_path(path=path, prefix=prefix) if relpath: yield relpath class _BoundedRequest(TypedDict): """Range request with a known start and end byte. These requests can be multiplexed natively on the Rust side with `obstore.get_ranges_async`. """ original_request_index: int """The positional index in the original key_ranges input""" start: int """Start byte offset.""" end: int """End byte offset.""" class _OtherRequest(TypedDict): """Offset or suffix range requests. These requests cannot be concurrent on the Rust side, and each need their own call to `obstore.get_async`, passing in the `range` parameter. """ original_request_index: int """The positional index in the original key_ranges input""" path: str """The path to request from.""" range: OffsetRange | None # Note: suffix requests are handled separately because some object stores (Azure) # don't support them """The range request type.""" class _SuffixRequest(TypedDict): """Offset or suffix range requests. These requests cannot be concurrent on the Rust side, and each need their own call to `obstore.get_async`, passing in the `range` parameter. """ original_request_index: int """The positional index in the original key_ranges input""" path: str """The path to request from.""" range: SuffixRange """The suffix range.""" class _Response(TypedDict): """A response buffer associated with the original index that it should be restored to.""" original_request_index: int """The positional index in the original key_ranges input""" buffer: Buffer """The buffer returned from obstore's range request.""" async def _make_bounded_requests( store: _UpstreamObjectStore, path: str, requests: list[_BoundedRequest], prototype: BufferPrototype, semaphore: asyncio.Semaphore, ) -> list[_Response]: """Make all bounded requests for a specific file. `obstore.get_ranges_async` allows for making concurrent requests for multiple ranges within a single file, and will e.g. merge concurrent requests. This only uses one single Python coroutine. """ import obstore as obs starts = [r["start"] for r in requests] ends = [r["end"] for r in requests] async with semaphore: responses = await obs.get_ranges_async(store, path=path, starts=starts, ends=ends) buffer_responses: list[_Response] = [] for request, response in zip(requests, responses, strict=True): buffer_responses.append( { "original_request_index": request["original_request_index"], "buffer": prototype.buffer.from_bytes(response), # type: ignore[arg-type] } ) return buffer_responses async def _make_other_request( store: _UpstreamObjectStore, request: _OtherRequest, prototype: BufferPrototype, semaphore: asyncio.Semaphore, ) -> list[_Response]: """Make offset or full-file requests. We return a `list[_Response]` for symmetry with `_make_bounded_requests` so that all futures can be gathered together. """ import obstore as obs async with semaphore: if request["range"] is None: resp = await obs.get_async(store, request["path"]) else: resp = await obs.get_async(store, request["path"], options={"range": request["range"]}) buffer = await resp.bytes_async() return [ { "original_request_index": request["original_request_index"], "buffer": prototype.buffer.from_bytes(buffer), # type: ignore[arg-type] } ] async def _make_suffix_request( store: _UpstreamObjectStore, request: _SuffixRequest, prototype: BufferPrototype, semaphore: asyncio.Semaphore, ) -> list[_Response]: """Make suffix requests. This is separated out from `_make_other_request` because some object stores (Azure) don't support suffix requests. In this case, our workaround is to first get the length of the object and then manually request the byte range at the end. We return a `list[_Response]` for symmetry with `_make_bounded_requests` so that all futures can be gathered together. """ import obstore as obs async with semaphore: try: resp = await obs.get_async(store, request["path"], options={"range": request["range"]}) buffer = await resp.bytes_async() except obs.exceptions.NotSupportedError: head_resp = await obs.head_async(store, request["path"]) file_size = head_resp["size"] suffix_len = request["range"]["suffix"] buffer = await obs.get_range_async( store, request["path"], start=file_size - suffix_len, length=suffix_len, ) return [ { "original_request_index": request["original_request_index"], "buffer": prototype.buffer.from_bytes(buffer), # type: ignore[arg-type] } ] async def _get_partial_values( store: _UpstreamObjectStore, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: """Make multiple range requests. ObjectStore has a `get_ranges` method that will additionally merge nearby ranges, but it's _per_ file. So we need to split these key_ranges into **per-file** key ranges, and then reassemble the results in the original order. We separate into different requests: - One call to `obstore.get_ranges_async` **per target file** - One call to `obstore.get_async` for each other request. """ key_ranges = list(key_ranges) per_file_bounded_requests: dict[str, list[_BoundedRequest]] = defaultdict(list) other_requests: list[_OtherRequest] = [] suffix_requests: list[_SuffixRequest] = [] for idx, (path, byte_range) in enumerate(key_ranges): if byte_range is None: other_requests.append( { "original_request_index": idx, "path": path, "range": None, } ) elif isinstance(byte_range, RangeByteRequest): per_file_bounded_requests[path].append( {"original_request_index": idx, "start": byte_range.start, "end": byte_range.end} ) elif isinstance(byte_range, OffsetByteRequest): other_requests.append( { "original_request_index": idx, "path": path, "range": {"offset": byte_range.offset}, } ) elif isinstance(byte_range, SuffixByteRequest): suffix_requests.append( { "original_request_index": idx, "path": path, "range": {"suffix": byte_range.suffix}, } ) else: raise ValueError(f"Unsupported range input: {byte_range}") semaphore = asyncio.Semaphore(config.get("async.concurrency")) futs: list[Coroutine[Any, Any, list[_Response]]] = [] for path, bounded_ranges in per_file_bounded_requests.items(): futs.append( _make_bounded_requests(store, path, bounded_ranges, prototype, semaphore=semaphore) ) for request in other_requests: futs.append(_make_other_request(store, request, prototype, semaphore=semaphore)) # noqa: PERF401 for suffix_request in suffix_requests: futs.append(_make_suffix_request(store, suffix_request, prototype, semaphore=semaphore)) # noqa: PERF401 buffers: list[Buffer | None] = [None] * len(key_ranges) for responses in await asyncio.gather(*futs): for resp in responses: buffers[resp["original_request_index"]] = resp["buffer"] return buffers zarr-python-3.3.0/src/zarr/storage/_utils.py000066400000000000000000000225361523267620000211070ustar00rootroot00000000000000from __future__ import annotations import importlib import re from pathlib import Path, PureWindowsPath from urllib.parse import urlparse if importlib.util.find_spec("upath"): from upath.core import UPath else: class UPath: # type: ignore[no-redef] pass import sys from typing import TYPE_CHECKING, NamedTuple from zarr.abc.store import OffsetByteRequest, RangeByteRequest, SuffixByteRequest if TYPE_CHECKING: from collections.abc import Iterable, Mapping from zarr.abc.store import ByteRequest from zarr.core.buffer import Buffer class ParsedStoreUrl(NamedTuple): """ Parsed components of a store URL. Attributes ---------- scheme : str The URL scheme (e.g., "memory", "file", "s3"). Empty string for local paths. name : str | None The store name/host component. For memory:// URLs this is the store name. None if empty. path : str The path component within the store. raw : str The original URL string. """ scheme: str name: str | None path: str raw: str def parse_store_url(url: str) -> ParsedStoreUrl: """ Parse a store URL into its components. Parameters ---------- url : str A URL like "memory://store-name/path" or "s3://bucket/key" or a local path. Returns ------- ParsedStoreUrl Named tuple with scheme, name, path, and raw URL. Examples -------- >>> parse_store_url("memory://mystore") ParsedStoreUrl(scheme='memory', name='mystore', path='', raw='memory://mystore') >>> parse_store_url("memory://mystore/path/to/data") ParsedStoreUrl(scheme='memory', name='mystore', path='path/to/data', raw='memory://mystore/path/to/data') >>> parse_store_url("s3://bucket/key") ParsedStoreUrl(scheme='s3', name='bucket', path='key', raw='s3://bucket/key') >>> parse_store_url("/local/path") ParsedStoreUrl(scheme='', name=None, path='/local/path', raw='/local/path') Note that ``memory://name/path`` and ``memory:///path`` are different: the first has ``name="name"`` and ``path="path"``, while the second has ``name=None`` and ``path="/path"`` (no host component between ``//`` and ``/``). """ # On Windows, bare paths like "C:\foo" or "C:/foo" cause urlparse to # misinterpret the drive letter as a URL scheme. Detect this early and # return a local-path result without going through urlparse. if sys.platform == "win32" and PureWindowsPath(url).drive: return ParsedStoreUrl(scheme="", name=None, path=url, raw=url) parsed = urlparse(url) # netloc is the "host" part (store name for memory://, bucket for s3://, etc.) name = parsed.netloc or None # For URLs with a scheme and netloc (like memory://store/path or s3://bucket/key), # strip the leading slash from the path component. # For local paths (no scheme), preserve the path as-is. if parsed.scheme and parsed.netloc: path = parsed.path.lstrip("/") else: path = parsed.path return ParsedStoreUrl(scheme=parsed.scheme, name=name, path=path, raw=url) def normalize_path(path: str | bytes | Path | None) -> str: if path is None: result = "" elif isinstance(path, bytes): result = str(path, "ascii") # handle pathlib.Path elif isinstance(path, Path | UPath): result = str(path) elif isinstance(path, str): result = path else: raise TypeError(f'Object {path} has an invalid type for "path": {type(path).__name__}') # convert backslash to forward slash result = result.replace("\\", "/") # remove leading and trailing slashes result = result.strip("/") # collapse any repeated slashes pat = re.compile(r"//+") result = pat.sub("/", result) # disallow path segments with just '.' or '..' segments = result.split("/") if any(s in {".", ".."} for s in segments): raise ValueError( f"The path {path!r} is invalid because its string representation contains '.' or '..' segments." ) return result def _normalize_byte_range_index(data: Buffer, byte_range: ByteRequest | None) -> tuple[int, int]: """ Convert a ByteRequest into an explicit start and stop """ if byte_range is None: start = 0 stop = len(data) + 1 elif isinstance(byte_range, RangeByteRequest): start = byte_range.start stop = byte_range.end elif isinstance(byte_range, OffsetByteRequest): start = byte_range.offset stop = len(data) + 1 elif isinstance(byte_range, SuffixByteRequest): start = max(0, len(data) - byte_range.suffix) stop = len(data) + 1 else: raise ValueError(f"Unexpected byte_range, got {byte_range}.") return (start, stop) def _join_paths(paths: Iterable[str]) -> str: """ Filter out instances of '' and join the remaining strings with '/'. Parameters ---------- paths : Iterable[str] Returns ------- str Examples -------- ```python from zarr.storage._utils import _join_paths _join_paths(["", "a", "b"]) # 'a/b' _join_paths(["a", "b", "c"]) # 'a/b/c' ``` """ return "/".join(filter(lambda v: v != "", paths)) def _dereference_path(root: str, path: str) -> str: """ Combine a store-side root with a key into a single fully-qualified path. Unlike `_join_paths`, this is purpose-built for the case where `root` is an opaque backend-side prefix that may use `"/"` as a sentinel for "root of the filesystem" (notably for fsspec's `ReferenceFileSystem`). A trailing `"/"` is stripped from `root` before joining; if `root` is then empty, the bare `path` is returned so that joining `"/"` with `"key"` yields `"key"` rather than `"//key"`. A trailing `"/"` on the result is also stripped. Leading slashes on `root` are preserved -- a backend-side path like `"/home/foo/data.zarr"` is an absolute filesystem path for `LocalFileSystem` and must not lose its leading separator. Parameters ---------- root : str The backend-side root of a store. May be `""`, `"/"`, an absolute filesystem path, or a backend-specific prefix. path : str The key within the store, typically a zarr key like `"zarr.json"` or `"a/b/c/zarr.json"`. Returns ------- str `root` and `path` joined by a single `"/"`, with the `"/"` sentinel collapsed and trailing slashes removed. Examples -------- ```python from zarr.storage._utils import _dereference_path _dereference_path("/", "zarr.json") # 'zarr.json' _dereference_path("", "zarr.json") # 'zarr.json' _dereference_path("/home/foo", "zarr.json") # '/home/foo/zarr.json' _dereference_path("/home/foo/", "zarr.json") # '/home/foo/zarr.json' _dereference_path("bucket/p", "zarr.json") # 'bucket/p/zarr.json' ``` """ root = root.rstrip("/") path = f"{root}/{path}" if root else path return path.rstrip("/") def _relativize_path(*, path: str, prefix: str) -> str: """ Make a "/"-delimited path relative to some prefix. If the prefix is '', then the path is returned as-is. Otherwise, the prefix is removed from the path as well as the separator string "/". If ``prefix`` is not the empty string and ``path`` does not start with ``prefix`` followed by a "/" character, then an error is raised. This function assumes that the prefix does not end with "/". Parameters ---------- path : str The path to make relative to the prefix. prefix : str The prefix to make the path relative to. Returns ------- str Examples -------- ```python from zarr.storage._utils import _relativize_path _relativize_path(path="a/b", prefix="") # 'a/b' _relativize_path(path="a/b/c", prefix="a/b") # 'c' ``` """ if prefix == "": return path else: _prefix = f"{prefix}/" if not path.startswith(_prefix): raise ValueError(f"The first component of {path} does not start with {prefix}.") return path.removeprefix(_prefix) def _normalize_paths(paths: Iterable[str]) -> tuple[str, ...]: """ Normalize the input paths according to the normalization scheme used for zarr node paths. If any two paths normalize to the same value, raise a ValueError. """ path_map: dict[str, str] = {} for path in paths: parsed = normalize_path(path) if parsed in path_map: msg = ( f"After normalization, the value '{path}' collides with '{path_map[parsed]}'. " f"Both '{path}' and '{path_map[parsed]}' normalize to the same value: '{parsed}'. " f"You should use either '{path}' or '{path_map[parsed]}', but not both." ) raise ValueError(msg) path_map[parsed] = path return tuple(path_map.keys()) def _normalize_path_keys[T](data: Mapping[str, T]) -> dict[str, T]: """ Normalize the keys of the input dict according to the normalization scheme used for zarr node paths. If any two keys in the input normalize to the same value, raise a ValueError. Returns a dict where the keys are the elements of the input and the values are the normalized form of each key. """ parsed_keys = _normalize_paths(data.keys()) return dict(zip(parsed_keys, data.values(), strict=True)) zarr-python-3.3.0/src/zarr/storage/_wrapper.py000066400000000000000000000165711523267620000214310ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, cast if TYPE_CHECKING: from collections.abc import AsyncGenerator, AsyncIterator, Iterable, Sequence from types import TracebackType from typing import Any, Self from zarr.abc.buffer import Buffer from zarr.abc.store import ByteRequest from zarr.core.buffer import BufferPrototype from zarr.abc.store import ( Store, SupportsDeleteSync, SupportsGetSync, SupportsSetSync, _store_supports_sync_io, ) class WrapperStore[T_Store: Store](Store): """ Store that wraps an existing Store. By default all of the store methods are delegated to the wrapped store instance, which is accessible via the ``._store`` attribute of this class. Use this class to modify or extend the behavior of the other store classes. """ _store: T_Store def __init__(self, store: T_Store) -> None: self._store = store def _with_store(self, store: T_Store) -> Self: """ Constructs a new instance of the wrapper store with the same details but a new store. """ return type(self)(store=store) @classmethod async def open(cls: type[Self], store_cls: type[T_Store], *args: Any, **kwargs: Any) -> Self: store = store_cls(*args, **kwargs) await store._open() return cls(store=store) def with_read_only(self, read_only: bool = False) -> Self: return self._with_store(cast(T_Store, self._store.with_read_only(read_only))) def __enter__(self) -> Self: return self._with_store(self._store.__enter__()) def __exit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, ) -> None: return self._store.__exit__(exc_type, exc_value, traceback) async def _open(self) -> None: await self._store._open() async def _ensure_open(self) -> None: await self._store._ensure_open() async def is_empty(self, prefix: str) -> bool: return await self._store.is_empty(prefix) @property def _is_open(self) -> bool: return self._store._is_open @_is_open.setter def _is_open(self, value: bool) -> None: raise NotImplementedError("WrapperStore must be opened via the `_open` method") async def clear(self) -> None: return await self._store.clear() @property def read_only(self) -> bool: return self._store.read_only def _check_writable(self) -> None: return self._store._check_writable() def __eq__(self, value: object) -> bool: return type(self) is type(value) and self._store.__eq__(value._store) def __str__(self) -> str: return f"wrapping-{self._store}" def __repr__(self) -> str: return f"WrapperStore({self._store.__class__.__name__}, '{self._store}')" async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: return await self._store.get(key, prototype, byte_range) async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: return await self._store.get_partial_values(prototype, key_ranges) async def get_ranges( self, key: str, byte_ranges: Sequence[ByteRequest | None], *, prototype: BufferPrototype, max_concurrency: int | None = None, max_gap_bytes: int | None = None, max_coalesced_bytes: int | None = None, ) -> AsyncIterator[Sequence[tuple[int, Buffer | None]]]: """Forward `get_ranges` to the wrapped store. Default values for the coalescing kwargs are not declared here; the wrapped store decides them. `None` means "don't override the wrapped store's default". """ kwargs: dict[str, int] = {} if max_concurrency is not None: kwargs["max_concurrency"] = max_concurrency if max_gap_bytes is not None: kwargs["max_gap_bytes"] = max_gap_bytes if max_coalesced_bytes is not None: kwargs["max_coalesced_bytes"] = max_coalesced_bytes async for group in self._store.get_ranges(key, byte_ranges, prototype=prototype, **kwargs): yield group async def exists(self, key: str) -> bool: return await self._store.exists(key) async def set(self, key: str, value: Buffer) -> None: await self._store.set(key, value) async def set_if_not_exists(self, key: str, value: Buffer) -> None: return await self._store.set_if_not_exists(key, value) async def _set_many(self, values: Iterable[tuple[str, Buffer]]) -> None: await self._store._set_many(values) @property def supports_writes(self) -> bool: return self._store.supports_writes @property def supports_deletes(self) -> bool: return self._store.supports_deletes @property def _supports_sync_io(self) -> bool: # The delegating `*_sync` methods below make every wrapper structurally # satisfy `SupportsSyncStore`; whether they can actually run depends on # the wrapped store, so forward its capability (see # `zarr.abc.store._store_supports_sync_io`). return _store_supports_sync_io(self._store) def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: """Forward `get_sync` to the wrapped store.""" if not isinstance(self._store, SupportsGetSync): raise TypeError(f"Store {type(self._store).__name__} does not support synchronous get.") return self._store.get_sync(key, prototype=prototype, byte_range=byte_range) # type: ignore[unreachable] def set_sync(self, key: str, value: Buffer) -> None: """Forward `set_sync` to the wrapped store.""" if not isinstance(self._store, SupportsSetSync): raise TypeError(f"Store {type(self._store).__name__} does not support synchronous set.") self._store.set_sync(key, value) # type: ignore[unreachable] def delete_sync(self, key: str) -> None: """Forward `delete_sync` to the wrapped store.""" if not isinstance(self._store, SupportsDeleteSync): raise TypeError( f"Store {type(self._store).__name__} does not support synchronous delete." ) self._store.delete_sync(key) # type: ignore[unreachable] async def delete(self, key: str) -> None: await self._store.delete(key) @property def supports_listing(self) -> bool: return self._store.supports_listing def list(self) -> AsyncIterator[str]: return self._store.list() def list_prefix(self, prefix: str) -> AsyncIterator[str]: return self._store.list_prefix(prefix) def list_dir(self, prefix: str) -> AsyncIterator[str]: return self._store.list_dir(prefix) async def delete_dir(self, prefix: str) -> None: return await self._store.delete_dir(prefix) def close(self) -> None: self._store.close() async def _get_many( self, requests: Iterable[tuple[str, BufferPrototype, ByteRequest | None]] ) -> AsyncGenerator[tuple[str, Buffer | None], None]: async for req in self._store._get_many(requests): yield req zarr-python-3.3.0/src/zarr/storage/_zip.py000066400000000000000000000322111523267620000205400ustar00rootroot00000000000000from __future__ import annotations import io import os import shutil import threading import time import zipfile from pathlib import Path from typing import IO, TYPE_CHECKING, Any, Literal from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, ) from zarr.core.buffer import Buffer, BufferPrototype if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable ZipStoreAccessModeLiteral = Literal["r", "w", "a"] class _RawReaderAdapter(io.RawIOBase): """ Adapt a minimal seekable reader to the `io` interface `zipfile` needs. Some file-like objects (e.g. `obstore.ReadableFile`) implement `read`/`seek`/`tell` but are not `io.IOBase` instances, and their `read` may return a buffer-protocol object rather than `bytes`. Wrapping in this adapter plus `io.BufferedReader` yields real `bytes`. Reads are clamped to the bytes remaining before EOF: some readers (obstore < 0.6) raise on short reads rather than returning fewer bytes. The size is cached, which is safe because the adapter is only used for read-only access. """ def __init__(self, fileobj: IO[bytes]) -> None: self._fileobj = fileobj self._size: int | None = None def _get_size(self) -> int: if self._size is None: pos = self._fileobj.tell() self._size = self._fileobj.seek(0, os.SEEK_END) self._fileobj.seek(pos) return self._size def readable(self) -> bool: return True def seekable(self) -> bool: return True def seek(self, pos: int, whence: int = 0) -> int: return self._fileobj.seek(pos, whence) def tell(self) -> int: return self._fileobj.tell() def readinto(self, b: Any) -> int: n_requested = min(len(b), self._get_size() - self._fileobj.tell()) if n_requested <= 0: return 0 data = self._fileobj.read(n_requested) n = len(data) b[:n] = memoryview(data) return n class ZipStore(Store): """ Store using a ZIP file. Parameters ---------- path : str, Path, or IO[bytes] Location of file, or an open binary file object. A file object must support `read`, `seek`, and `tell`; objects that are not `io.IOBase` instances (e.g. an `obstore` reader) are adapted automatically but can only be used for reading (`mode="r"`). The file object must stay open for the lifetime of the store, and operations that require a filesystem location (`clear`, `move`, pickling) are not supported. mode : str, optional One of 'r' to read an existing file, 'w' to truncate and write a new file, 'a' to append to an existing file, or 'x' to exclusively create and write a new file. compression : int, optional Compression method to use when writing to the archive. allowZip64 : bool, optional If True (the default) will create ZIP files that use the ZIP64 extensions when the zipfile is larger than 2 GiB. If False will raise an exception when the ZIP file would require ZIP64 extensions. Attributes ---------- allowed_exceptions supports_writes supports_deletes supports_listing path compression allowZip64 """ supports_writes: bool = True supports_deletes: bool = False supports_listing: bool = True path: Path | None compression: int allowZip64: bool _zf: zipfile.ZipFile _lock: threading.RLock _fileobj: IO[bytes] | None def __init__( self, path: Path | str | IO[bytes], *, mode: ZipStoreAccessModeLiteral = "r", read_only: bool | None = None, compression: int = zipfile.ZIP_STORED, allowZip64: bool = True, ) -> None: if read_only is None: read_only = mode == "r" super().__init__(read_only=read_only) if isinstance(path, str): path = Path(path) if isinstance(path, Path): self.path = path # root? self._fileobj = None else: self.path = None if not isinstance(path, io.IOBase): if not all( callable(getattr(path, attr, None)) for attr in ("read", "seek", "tell") ): raise TypeError( f"expected a path or an open binary file object supporting " f"read/seek/tell, got {type(path).__name__}" ) if mode != "r": raise TypeError( f"a file object that is not an io.IOBase instance can only be " f"opened for reading (mode='r', got mode={mode!r})" ) # e.g. an obstore ReadableFile: readable and seekable, but # not an io object and reads may not return bytes path = io.BufferedReader(_RawReaderAdapter(path)) self._fileobj = path self._zmode = mode self.compression = compression self.allowZip64 = allowZip64 def _sync_open(self) -> None: if self._is_open: raise ValueError("store is already open") self._lock = threading.RLock() self._zf = zipfile.ZipFile( self.path if self.path is not None else self._fileobj, # type: ignore[arg-type] mode=self._zmode, compression=self.compression, allowZip64=self.allowZip64, ) self._is_open = True async def _open(self) -> None: self._sync_open() def __getstate__(self) -> dict[str, Any]: if self.path is None: # A path-backed store pickles its path and reopens the file on # unpickling; an open file object cannot be serialized that way. raise TypeError( "cannot pickle a ZipStore backed by a file-like object; " "construct the store from a path instead" ) # We need a copy to not modify the state of the original store state = self.__dict__.copy() for attr in ["_zf", "_lock"]: state.pop(attr, None) return state def __setstate__(self, state: dict[str, Any]) -> None: self.__dict__ = state self._is_open = False self._sync_open() def close(self) -> None: # docstring inherited if not self._is_open: return super().close() with self._lock: self._zf.close() async def clear(self) -> None: # docstring inherited with self._lock: self._check_writable() if self.path is None: raise NotImplementedError( "clear() is not supported for a ZipStore backed by a file-like object" ) self._zf.close() os.remove(self.path) self._zf = zipfile.ZipFile( self.path, mode="w", compression=self.compression, allowZip64=self.allowZip64 ) def __str__(self) -> str: if self.path is None: return f"zip://{self._fileobj!r}" return f"zip://{self.path}" def __repr__(self) -> str: return f"ZipStore('{self}')" def __eq__(self, other: object) -> bool: return ( isinstance(other, type(self)) and self.path == other.path and self._fileobj is other._fileobj ) def _get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: if not self._is_open: self._sync_open() # docstring inherited try: with self._zf.open(key) as f: # will raise KeyError if byte_range is None: return prototype.buffer.from_bytes(f.read()) elif isinstance(byte_range, RangeByteRequest): f.seek(byte_range.start) return prototype.buffer.from_bytes(f.read(byte_range.end - f.tell())) size = f.seek(0, os.SEEK_END) if isinstance(byte_range, OffsetByteRequest): f.seek(byte_range.offset) elif isinstance(byte_range, SuffixByteRequest): f.seek(max(0, size - byte_range.suffix)) else: raise TypeError(f"Unexpected byte_range, got {byte_range}.") return prototype.buffer.from_bytes(f.read()) except KeyError: return None async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None, ) -> Buffer | None: # docstring inherited assert isinstance(key, str) with self._lock: return self._get(key, prototype=prototype, byte_range=byte_range) async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: # docstring inherited out = [] with self._lock: for key, byte_range in key_ranges: out.append(self._get(key, prototype=prototype, byte_range=byte_range)) return out def _set(self, key: str, value: Buffer) -> None: if not self._is_open: self._sync_open() # generally, this should be called inside a lock keyinfo = zipfile.ZipInfo(filename=key, date_time=time.localtime(time.time())[:6]) keyinfo.compress_type = self.compression if keyinfo.filename[-1] == os.sep: keyinfo.external_attr = 0o40775 << 16 # drwxrwxr-x keyinfo.external_attr |= 0x10 # MS-DOS directory flag else: keyinfo.external_attr = 0o644 << 16 # ?rw-r--r-- self._zf.writestr(keyinfo, value.to_bytes()) async def set(self, key: str, value: Buffer) -> None: # docstring inherited self._check_writable() if not self._is_open: self._sync_open() assert isinstance(key, str) if not isinstance(value, Buffer): raise TypeError( f"ZipStore.set(): `value` must be a Buffer instance. Got an instance of {type(value)} instead." ) with self._lock: self._set(key, value) async def set_if_not_exists(self, key: str, value: Buffer) -> None: self._check_writable() with self._lock: members = self._zf.namelist() if key not in members: self._set(key, value) async def delete_dir(self, prefix: str) -> None: # only raise NotImplementedError if any keys are found self._check_writable() if prefix != "" and not prefix.endswith("/"): prefix += "/" async for _ in self.list_prefix(prefix): raise NotImplementedError async def delete(self, key: str) -> None: # docstring inherited # we choose to only raise NotImplementedError here if the key exists # this allows the array/group APIs to avoid the overhead of existence checks self._check_writable() if await self.exists(key): raise NotImplementedError async def exists(self, key: str) -> bool: # docstring inherited if not self._is_open: self._sync_open() with self._lock: try: self._zf.getinfo(key) except KeyError: return False else: return True async def list(self) -> AsyncIterator[str]: # docstring inherited if not self._is_open: self._sync_open() with self._lock: for key in self._zf.namelist(): yield key async def list_prefix(self, prefix: str) -> AsyncIterator[str]: # docstring inherited async for key in self.list(): if key.startswith(prefix): yield key async def list_dir(self, prefix: str) -> AsyncIterator[str]: # docstring inherited if not self._is_open: self._sync_open() prefix = prefix.rstrip("/") keys = self._zf.namelist() seen = set() if prefix == "": keys_unique = {k.split("/")[0] for k in keys} for key in keys_unique: if key not in seen: seen.add(key) yield key else: for key in keys: if key.startswith(f"{prefix}/") and key.strip("/") != prefix: k = key.removeprefix(f"{prefix}/").split("/")[0] if k not in seen: seen.add(k) yield k async def move(self, path: Path | str) -> None: """ Move the store to another path. """ if self.path is None: raise NotImplementedError( "move() is not supported for a ZipStore backed by a file-like object" ) if isinstance(path, str): path = Path(path) self.close() os.makedirs(path.parent, exist_ok=True) shutil.move(self.path, path) self.path = path await self._open() zarr-python-3.3.0/src/zarr/testing/000077500000000000000000000000001523267620000172375ustar00rootroot00000000000000zarr-python-3.3.0/src/zarr/testing/__init__.py000066400000000000000000000016721523267620000213560ustar00rootroot00000000000000import importlib.util import warnings from typing import TYPE_CHECKING from zarr.errors import ZarrUserWarning if importlib.util.find_spec("pytest") is not None: from zarr.testing.store import StoreTests from zarr.testing.utils import assert_bytes_equal else: warnings.warn( "pytest not installed, skipping test suite", category=ZarrUserWarning, stacklevel=2 ) if TYPE_CHECKING: import pytest def pytest_configure(config: "pytest.Config") -> None: # The tests in zarr.testing are intended to be run by downstream projects. # To allow those downstream projects to run with `--strict-markers`, we need # to register an entry point with pytest11 and register our "plugin" with it, # which just registers the markers used in zarr.testing config.addinivalue_line("markers", "gpu: mark a test as requiring CuPy and GPU") # TODO: import public buffer tests? __all__ = ["StoreTests", "assert_bytes_equal"] zarr-python-3.3.0/src/zarr/testing/buffer.py000066400000000000000000000063251523267620000210700ustar00rootroot00000000000000# mypy: ignore-errors from __future__ import annotations from typing import TYPE_CHECKING, Any, Literal import numpy as np import numpy.typing as npt from zarr.core.buffer import Buffer, BufferPrototype, cpu from zarr.storage import MemoryStore if TYPE_CHECKING: from collections.abc import Iterable from typing import Self from zarr.abc.store import ByteRequest __all__ = [ "NDBufferUsingTestNDArrayLike", "StoreExpectingTestBuffer", "TestBuffer", ] class TestNDArrayLike(np.ndarray): """An example of an ndarray-like class""" __test__ = False class TestBuffer(cpu.Buffer): """Example of a custom Buffer that handles ArrayLike""" __test__ = False class NDBufferUsingTestNDArrayLike(cpu.NDBuffer): """Example of a custom NDBuffer that handles MyNDArrayLike""" @classmethod def create( cls, *, shape: Iterable[int], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C", fill_value: Any | None = None, ) -> Self: """Overwrite `NDBuffer.create` to create a TestNDArrayLike instance""" ret = cls(TestNDArrayLike(shape=shape, dtype=dtype, order=order)) if fill_value is not None: ret.fill(fill_value) return ret @classmethod def empty( cls, shape: tuple[int, ...], dtype: npt.DTypeLike, order: Literal["C", "F"] = "C", ) -> Self: return super(cpu.NDBuffer, cls).empty(shape=shape, dtype=dtype, order=order) class StoreExpectingTestBuffer(MemoryStore): """Example of a custom Store that expect MyBuffer for all its non-metadata We assume that keys containing "json" is metadata """ async def set(self, key: str, value: Buffer, byte_range: tuple[int, int] | None = None) -> None: if "json" not in key: assert isinstance(value, TestBuffer) await super().set(key, value, byte_range) def set_sync(self, key: str, value: Buffer) -> None: # Synchronous counterpart of `set`, used by FusedCodecPipeline. Mirror the # same buffer-type guard so the invariant holds whichever pipeline writes. if "json" not in key: assert isinstance(value, TestBuffer) super().set_sync(key, value) async def get( self, key: str, prototype: BufferPrototype, byte_range: tuple[int, int | None] | None = None, ) -> Buffer | None: if "json" not in key: assert prototype.buffer is TestBuffer ret = await super().get(key=key, prototype=prototype, byte_range=byte_range) if ret is not None: assert isinstance(ret, prototype.buffer) return ret def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: # Synchronous counterpart of `get`, used by FusedCodecPipeline. if "json" not in key and prototype is not None: assert prototype.buffer is TestBuffer ret = super().get_sync(key=key, prototype=prototype, byte_range=byte_range) if ret is not None and prototype is not None: assert isinstance(ret, prototype.buffer) return ret zarr-python-3.3.0/src/zarr/testing/stateful.py000066400000000000000000000652501523267620000214500ustar00rootroot00000000000000import builtins import functools from collections.abc import Callable, Iterable from typing import Any, cast import hypothesis.extra.numpy as npst import hypothesis.strategies as st import numpy as np from hypothesis import assume, note from hypothesis.stateful import ( RuleBasedStateMachine, initialize, invariant, precondition, rule, ) from hypothesis.strategies import DataObject import zarr from zarr import Array from zarr.abc.store import ( OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, ) from zarr.codecs.bytes import BytesCodec from zarr.core.buffer import Buffer, BufferPrototype, cpu, default_buffer_prototype from zarr.core.sync import SyncMixin from zarr.storage import LocalStore, MemoryStore from zarr.testing.strategies import ( arrays as zarr_arrays, ) from zarr.testing.strategies import ( basic_indices, chunk_paths, key_ranges, node_names, orthogonal_indices, ) from zarr.testing.strategies import keys as zarr_keys MAX_BINARY_SIZE = 100 def with_frequency[F: Callable[..., Any]](frequency: float) -> Callable[[F], F]: """This needs to be deterministic for hypothesis replaying""" def decorator(func: F) -> F: counter_attr = f"__{func.__name__}_counter" @functools.wraps(func) def wrapper(*args: Any, **kwargs: Any) -> Any: return func(*args, **kwargs) @precondition def frequency_check(f: Any) -> Any: if not hasattr(f, counter_attr): setattr(f, counter_attr, 0) current_count = getattr(f, counter_attr) + 1 setattr(f, counter_attr, current_count) return (current_count * frequency) % 1.0 >= (1.0 - frequency) return cast(F, frequency_check(wrapper)) return decorator def split_prefix_name(path: str) -> tuple[str, str]: split = path.rsplit("/", maxsplit=1) if len(split) > 1: prefix, name = split else: prefix = "" (name,) = split return prefix, name class ZarrHierarchyStateMachine(SyncMixin, RuleBasedStateMachine): """ This state machine models operations that modify a zarr store's hierarchy. That is, user actions that modify arrays/groups as well as list operations. It is intended to be used by external stores, and compares their results to a MemoryStore that is assumed to be perfect. """ def __init__(self, store: Store) -> None: super().__init__() self.store = store self.model = MemoryStore() zarr.group(store=self.model) # Track state of the hierarchy, these should contain fully qualified paths self.all_groups: set[str] = set() self.all_arrays: set[str] = set() @initialize() def init_store(self) -> None: # This lets us reuse the fixture provided store. self._sync(self.store.clear()) zarr.group(store=self.store) def can_add(self, path: str) -> bool: return path not in self.all_groups and path not in self.all_arrays # -------------------- store operations ----------------------- @rule(name=node_names, data=st.data()) def add_group(self, name: str, data: DataObject) -> None: # Handle possible case-insensitive file systems (e.g. MacOS) if isinstance(self.store, LocalStore): name = name.lower() if self.all_groups: parent = data.draw(st.sampled_from(sorted(self.all_groups)), label="Group parent") else: parent = "" path = f"{parent}/{name}".lstrip("/") assume(self.can_add(path)) note(f"Adding group: path='{path}'") self.all_groups.add(path) zarr.group(store=self.store, path=path) zarr.group(store=self.model, path=path) @rule(data=st.data(), name=node_names) def add_array(self, data: DataObject, name: str) -> None: # Handle possible case-insensitive file systems (e.g. MacOS) if isinstance(self.store, LocalStore): name = name.lower() if self.all_groups: parent = data.draw(st.sampled_from(sorted(self.all_groups)), label="Array parent") else: parent = "" # TODO: support creating deeper paths # TODO: support overwriting potentially by just skipping `self.can_add` path = f"{parent}/{name}".lstrip("/") assume(self.can_add(path)) # Generate array on the model store using the arrays strategy a = data.draw( zarr_arrays( stores=st.just(self.model), paths=st.just(parent), array_names=st.just(name), zarr_formats=st.just(3), compressors=st.just(BytesCodec()), open_mode="a", ), label="generated array", ) note(f"Adding array: path='{path}' shape={a.shape} chunks={a.metadata.chunk_grid}") # Recreate the same array in the store under test from zarr.core.metadata.v3 import RectilinearChunkGridMetadata, RegularChunkGridMetadata chunk_grid = a.metadata.chunk_grid chunks_param: tuple[int, ...] | list[list[int]] if isinstance(chunk_grid, RectilinearChunkGridMetadata): chunks_param = [ list(dim) if isinstance(dim, tuple) else [dim] for dim in chunk_grid.chunk_shapes ] elif isinstance(chunk_grid, RegularChunkGridMetadata): chunks_param = chunk_grid.chunk_shape else: chunks_param = a.chunks root = zarr.open_group(store=self.store, mode="a") arr = root.create_array( path, shape=a.shape, chunks=chunks_param, dtype=a.dtype, fill_value=a.fill_value, dimension_names=a.metadata.dimension_names, # type: ignore[union-attr] compressors=None, ) arr[:] = a[:] self.all_arrays.add(path) @rule() @with_frequency(0.25) def clear(self) -> None: note("clearing") import zarr self._sync(self.store.clear()) self._sync(self.model.clear()) assert self._sync(self.store.is_empty("/")) assert self._sync(self.model.is_empty("/")) self.all_groups.clear() self.all_arrays.clear() zarr.group(store=self.store) zarr.group(store=self.model) # TODO: MemoryStore is broken? # assert not self._sync(self.store.is_empty("/")) # assert not self._sync(self.model.is_empty("/")) def draw_directory(self, data: DataObject) -> str: group_st = st.sampled_from(sorted(self.all_groups)) if self.all_groups else st.nothing() array_st = st.sampled_from(sorted(self.all_arrays)) if self.all_arrays else st.nothing() array_or_group = data.draw(st.one_of(group_st, array_st)) if data.draw(st.booleans()) and array_or_group in self.all_arrays: arr = zarr.open_array(path=array_or_group, store=self.model) path = data.draw( st.one_of( st.sampled_from([array_or_group]), chunk_paths(ndim=arr.ndim, numblocks=arr.cdata_shape).map( lambda x: f"{array_or_group}/c/" ), ) ) else: path = array_or_group return path @precondition(lambda self: bool(self.all_groups)) @rule(data=st.data()) def check_list_dir(self, data: DataObject) -> None: path = self.draw_directory(data) note(f"list_dir for {path=!r}") # Consider .list_dir("path/to/array") for an array with a single chunk. # The MemoryStore model will return `"c", "zarr.json"` only if the chunk exists # If that chunk was deleted, then `"c"` is not returned. # LocalStore will not have this behaviour :/ # There are similar consistency issues with delete_dir("/path/to/array/c/0/0") assume(not isinstance(self.store, LocalStore)) model_ls = sorted(self._sync_iter(self.model.list_dir(path))) store_ls = sorted(self._sync_iter(self.store.list_dir(path))) assert model_ls == store_ls, (model_ls, store_ls) @precondition(lambda self: bool(self.all_arrays)) @rule(data=st.data()) def delete_chunk(self, data: DataObject) -> None: array = data.draw(st.sampled_from(sorted(self.all_arrays))) arr = zarr.open_array(path=array, store=self.model) chunk_path = data.draw(chunk_paths(ndim=arr.ndim, numblocks=arr.cdata_shape, subset=False)) path = f"{array}/c/{chunk_path}" note(f"deleting chunk {path=!r}") self._sync(self.model.delete(path)) self._sync(self.store.delete(path)) @precondition(lambda self: bool(self.all_arrays)) @rule(data=st.data()) def check_array(self, data: DataObject) -> None: path = data.draw(st.sampled_from(sorted(self.all_arrays))) actual = zarr.open_array(self.store, path=path)[:] expected = zarr.open_array(self.model, path=path)[:] np.testing.assert_equal(actual, expected) @precondition(lambda self: bool(self.all_arrays)) @rule(data=st.data()) def overwrite_array_basic_indexing(self, data: DataObject) -> None: array = data.draw(st.sampled_from(sorted(self.all_arrays))) model_array = zarr.open_array(path=array, store=self.model) store_array = zarr.open_array(path=array, store=self.store) slicer = data.draw(basic_indices(shape=model_array.shape)) note(f"overwriting array with basic indexer: {slicer=}") new_data = data.draw( npst.arrays(shape=np.shape(model_array[slicer]), dtype=model_array.dtype) ) model_array[slicer] = new_data store_array[slicer] = new_data @precondition(lambda self: bool(self.all_arrays)) @rule(data=st.data()) def overwrite_array_orthogonal_indexing(self, data: DataObject) -> None: array = data.draw(st.sampled_from(sorted(self.all_arrays))) model_array = zarr.open_array(path=array, store=self.model) store_array = zarr.open_array(path=array, store=self.store) indexer, _ = data.draw(orthogonal_indices(shape=model_array.shape)) note(f"overwriting array orthogonal {indexer=}") new_data = data.draw( npst.arrays(shape=model_array.oindex[indexer].shape, dtype=model_array.dtype) # type: ignore[union-attr] ) model_array.oindex[indexer] = new_data store_array.oindex[indexer] = new_data @precondition(lambda self: bool(self.all_arrays)) @rule(data=st.data()) def resize_array(self, data: DataObject) -> None: array = data.draw(st.sampled_from(sorted(self.all_arrays))) model_array = zarr.open_array(path=array, store=self.model) store_array = zarr.open_array(path=array, store=self.store) ndim = model_array.ndim new_shape = tuple( 0 if oldsize == 0 else newsize for newsize, oldsize in zip( data.draw(npst.array_shapes(max_dims=ndim, min_dims=ndim, min_side=0)), model_array.shape, strict=True, ) ) note(f"resizing array from {model_array.shape} to {new_shape}") model_array.resize(new_shape) store_array.resize(new_shape) @precondition(lambda self: bool(self.all_arrays) or bool(self.all_groups)) @rule(data=st.data()) def delete_dir(self, data: DataObject) -> None: path = self.draw_directory(data) note(f"delete_dir with {path=!r}") self._sync(self.model.delete_dir(path)) self._sync(self.store.delete_dir(path)) matches = set() for node in self.all_groups | self.all_arrays: if node == path or node.startswith(path + "/"): matches.add(node) self.all_groups = self.all_groups - matches self.all_arrays = self.all_arrays - matches # @precondition(lambda self: bool(self.all_groups)) # @precondition(lambda self: bool(self.all_arrays)) # @rule(data=st.data()) # def move_array(self, data): # array_path = data.draw(st.sampled_from(self.all_arrays), label="Array move source") # to_group = data.draw(st.sampled_from(self.all_groups), label="Array move destination") # # fixme renaming to self? # array_name = os.path.basename(array_path) # assume(self.model.can_add(to_group, array_name)) # new_path = f"{to_group}/{array_name}".lstrip("/") # note(f"moving array '{array_path}' -> '{new_path}'") # self.model.rename(array_path, new_path) # self.repo.store.rename(array_path, new_path) # @precondition(lambda self: len(self.all_groups) >= 2) # @rule(data=st.data()) # def move_group(self, data): # from_group = data.draw(st.sampled_from(self.all_groups), label="Group move source") # to_group = data.draw(st.sampled_from(self.all_groups), label="Group move destination") # assume(not to_group.startswith(from_group)) # from_group_name = os.path.basename(from_group) # assume(self.model.can_add(to_group, from_group_name)) # # fixme renaming to self? # new_path = f"{to_group}/{from_group_name}".lstrip("/") # note(f"moving group '{from_group}' -> '{new_path}'") # self.model.rename(from_group, new_path) # self.repo.store.rename(from_group, new_path) @precondition(lambda self: self.store.supports_deletes) @precondition(lambda self: len(self.all_arrays) >= 1) @rule(data=st.data()) def delete_array_using_del(self, data: DataObject) -> None: array_path = data.draw( st.sampled_from(sorted(self.all_arrays)), label="Array deletion target" ) prefix, array_name = split_prefix_name(array_path) note(f"Deleting array '{array_path}' ({prefix=!r}, {array_name=!r}) using del") for store in [self.model, self.store]: group = zarr.open_group(path=prefix, store=store) group[array_name] # check that it exists del group[array_name] self.all_arrays.remove(array_path) @precondition(lambda self: self.store.supports_deletes) @precondition(lambda self: bool(self.all_groups)) @rule(data=st.data()) def delete_group_using_del(self, data: DataObject) -> None: group_path = data.draw( st.sampled_from(sorted(self.all_groups)), label="Group deletion target", ) prefix, group_name = split_prefix_name(group_path) note(f"Deleting group '{group_path=!r}', {prefix=!r}, {group_name=!r} using delete") members = zarr.open_group(store=self.model, path=group_path).members(max_depth=None) for _, obj in members: if isinstance(obj, Array): self.all_arrays.remove(obj.path) else: self.all_groups.remove(obj.path) for store in [self.store, self.model]: group = zarr.open_group(store=store, path=prefix) group[group_name] # check that it exists del group[group_name] self.all_groups.remove(group_path) # # --------------- assertions ----------------- # def check_group_arrays(self, group): # # note(f"Checking arrays of '{group}'") # g1 = self.model.get_group(group) # g2 = zarr.open_group(path=group, mode="r", store=self.repo.store) # model_arrays = sorted(g1.arrays(), key=itemgetter(0)) # our_arrays = sorted(g2.arrays(), key=itemgetter(0)) # for (n1, a1), (n2, a2) in zip_longest(model_arrays, our_arrays): # assert n1 == n2 # assert_array_equal(a1, a2) # def check_subgroups(self, group_path): # g1 = self.model.get_group(group_path) # g2 = zarr.open_group(path=group_path, mode="r", store=self.repo.store) # g1_children = [name for (name, _) in g1.groups()] # g2_children = [name for (name, _) in g2.groups()] # # note(f"Checking {len(g1_children)} subgroups of group '{group_path}'") # assert g1_children == g2_children # def check_list_prefix_from_group(self, group): # prefix = f"meta/root/{group}" # model_list = sorted(self.model.list_prefix(prefix)) # al_list = sorted(self.repo.store.list_prefix(prefix)) # # note(f"Checking {len(model_list)} keys under '{prefix}'") # assert model_list == al_list # prefix = f"data/root/{group}" # model_list = sorted(self.model.list_prefix(prefix)) # al_list = sorted(self.repo.store.list_prefix(prefix)) # # note(f"Checking {len(model_list)} keys under '{prefix}'") # assert model_list == al_list # @precondition(lambda self: self.model.is_persistent_session()) # @rule(data=st.data()) # def check_group_path(self, data): # t0 = time.time() # group = data.draw(st.sampled_from(self.all_groups)) # self.check_list_prefix_from_group(group) # self.check_subgroups(group) # self.check_group_arrays(group) # t1 = time.time() # note(f"Checks took {t1 - t0} sec.") @invariant() def check_list_prefix_from_root(self) -> None: model_list = self._sync_iter(self.model.list_prefix("")) store_list = self._sync_iter(self.store.list_prefix("")) note(f"Checking {len(model_list)} expected keys vs {len(store_list)} actual keys") assert sorted(model_list) == sorted(store_list), ( sorted(model_list), sorted(store_list), ) # check that our internal state matches that of the store and model assert all(f"{path}/zarr.json" in model_list for path in self.all_groups | self.all_arrays) assert all(f"{path}/zarr.json" in store_list for path in self.all_groups | self.all_arrays) class SyncStoreWrapper(zarr.core.sync.SyncMixin): def __init__(self, store: Store) -> None: """Synchronous Store wrapper This class holds synchronous methods that map to async methods of Store classes. The synchronous wrapper is needed because hypothesis' stateful testing infra does not support asyncio so we redefine sync versions of the Store API. https://github.com/HypothesisWorks/hypothesis/issues/3712#issuecomment-1668999041 """ self.store = store @property def read_only(self) -> bool: return self.store.read_only def set(self, key: str, data_buffer: Buffer) -> None: return self._sync(self.store.set(key, data_buffer)) def list(self) -> builtins.list[str]: return self._sync_iter(self.store.list()) def get(self, key: str, prototype: BufferPrototype) -> Buffer | None: return self._sync(self.store.get(key, prototype=prototype)) def get_partial_values( self, key_ranges: Iterable[Any], prototype: BufferPrototype ) -> builtins.list[Buffer | None]: return self._sync(self.store.get_partial_values(prototype=prototype, key_ranges=key_ranges)) def delete(self, path: str) -> None: return self._sync(self.store.delete(path)) def is_empty(self, prefix: str) -> bool: return self._sync(self.store.is_empty(prefix=prefix)) def clear(self) -> None: return self._sync(self.store.clear()) def exists(self, key: str) -> bool: return self._sync(self.store.exists(key)) def getsize_prefix(self, prefix: str) -> int: return self._sync(self.store.getsize_prefix(prefix)) def list_dir(self, prefix: str) -> None: raise NotImplementedError def list_prefix(self, prefix: str) -> None: raise NotImplementedError @property def supports_listing(self) -> bool: return self.store.supports_listing @property def supports_writes(self) -> bool: return self.store.supports_writes @property def supports_deletes(self) -> bool: return self.store.supports_deletes class ZarrStoreStateMachine(RuleBasedStateMachine): """ " Zarr store state machine This is a subclass of a Hypothesis RuleBasedStateMachine. It is testing a framework to ensure that the state of a Zarr store matches an expected state after a set of random operations. It contains a store (currently, a Zarr MemoryStore) and a model, a simplified version of a zarr store (in this case, a dict). It also contains rules which represent actions that can be applied to a zarr store. Rules apply an action to both the store and the model, and invariants assert that the state of the model is equal to the state of the store. Hypothesis then generates sequences of rules, running invariants after each rule. It raises an error if a sequence produces discontinuity between state of the model and state of the store (ie. an invariant is violated). https://hypothesis.readthedocs.io/en/latest/stateful.html """ def __init__(self, store: Store) -> None: super().__init__() self.model: dict[str, Buffer] = {} self.store = SyncStoreWrapper(store) self.prototype = default_buffer_prototype() @initialize() def init_store(self) -> None: self.store.clear() @rule(key=zarr_keys(), data=st.binary(min_size=0, max_size=MAX_BINARY_SIZE)) def set(self, key: str, data: bytes) -> None: note(f"(set) Setting {key!r} with {data!r}") assert not self.store.read_only data_buf = cpu.Buffer.from_bytes(data) self.store.set(key, data_buf) self.model[key] = data_buf @precondition(lambda self: len(self.model.keys()) > 0) @rule(key=zarr_keys(), data=st.data()) def get(self, key: str, data: DataObject) -> None: key = data.draw( st.sampled_from(sorted(self.model.keys())) ) # hypothesis wants to sample from sorted list note("(get)") store_value = self.store.get(key, self.prototype) # to bytes here necessary because data_buf set to model in set() assert self.model[key] == store_value @rule(key=zarr_keys(), data=st.data()) def get_invalid_zarr_keys(self, key: str, data: DataObject) -> None: note("(get_invalid)") assume(key not in self.model) assert self.store.get(key, self.prototype) is None @precondition(lambda self: len(self.model.keys()) > 0) @rule(data=st.data()) def get_partial_values(self, data: DataObject) -> None: key_range = data.draw( key_ranges(keys=st.sampled_from(sorted(self.model.keys())), max_size=MAX_BINARY_SIZE) ) note(f"(get partial) {key_range=}") # Pass a one-shot generator rather than a list: stores (and wrappers such # as LoggingStore) must not exhaust the iterable before using it. obs_maybe = self.store.get_partial_values((kr for kr in key_range), self.prototype) observed = [] for obs in obs_maybe: assert obs is not None observed.append(obs.to_bytes()) model_vals_ls = [] for key, byte_range in key_range: # Independently model each ByteRequest variant (do NOT reuse the # store's _normalize_byte_range_index helper, so this stays an # independent oracle). Bounds may exceed the value length. value = self.model[key] n = len(value) if byte_range is None: expected = value[:] elif isinstance(byte_range, RangeByteRequest): expected = value[byte_range.start : byte_range.end] elif isinstance(byte_range, OffsetByteRequest): expected = value[byte_range.offset :] elif isinstance(byte_range, SuffixByteRequest): # "last suffix bytes"; suffix > n means the whole value. expected = value[max(0, n - byte_range.suffix) :] else: raise AssertionError(f"unexpected byte_range {byte_range!r}") model_vals_ls.append(expected) assert all( obs == exp.to_bytes() for obs, exp in zip(observed, model_vals_ls, strict=True) ), ( observed, model_vals_ls, ) @precondition(lambda self: self.store.supports_deletes) @precondition(lambda self: len(self.model.keys()) > 0) @rule(data=st.data()) def delete(self, data: DataObject) -> None: key = data.draw(st.sampled_from(sorted(self.model.keys()))) note(f"(delete) Deleting {key=}") self.store.delete(key) del self.model[key] @rule() def clear(self) -> None: assert not self.store.read_only note("(clear)") self.store.clear() self.model.clear() assert self.store.is_empty("") assert len(self.model.keys()) == len(list(self.store.list())) == 0 @rule() # Local store can be non-empty when there are subdirectories but no files @precondition(lambda self: not isinstance(self.store.store, LocalStore)) def is_empty(self) -> None: note("(is_empty)") # make sure they either both are or both aren't empty (same state) assert self.store.is_empty("") == (not self.model) @rule(key=zarr_keys()) def exists(self, key: str) -> None: note("(exists)") assert self.store.exists(key) == (key in self.model) @precondition(lambda self: len(self.model.keys()) > 0) @rule(data=st.data()) def getsize_prefix(self, data: DataObject) -> None: # Measure the size under the first path segment of some existing key. # getsize_prefix(node) must count only keys under the directory "node/", # not sibling keys that merely share the string prefix (e.g. measuring # "a" must not include a sibling key "ab/..."). key = data.draw(st.sampled_from(sorted(self.model.keys()))) node = key.split("/")[0] note(f"(getsize_prefix) {node=}") observed = self.store.getsize_prefix(node) expected = sum(len(value) for k, value in self.model.items() if k.startswith(node + "/")) assert observed == expected, (observed, expected, node) @invariant() def check_paths_equal(self) -> None: note("Checking that paths are equal") paths = sorted(self.store.list()) assert sorted(self.model.keys()) == paths @invariant() def check_vals_equal(self) -> None: note("Checking values equal") for key, val in self.model.items(): store_item = self.store.get(key, self.prototype) assert val == store_item @invariant() def check_num_zarr_keys_equal(self) -> None: note("check num zarr_keys equal") assert len(self.model) == len(list(self.store.list())) @invariant() def check_zarr_keys(self) -> None: keys = list(self.store.list()) if not keys: assert self.store.is_empty("") is True else: assert self.store.is_empty("") is False for key in keys: assert self.store.exists(key) is True note("checking keys / exists / empty") zarr-python-3.3.0/src/zarr/testing/store.py000066400000000000000000001012521523267620000207460ustar00rootroot00000000000000from __future__ import annotations import asyncio import pickle import time from abc import abstractmethod from typing import TYPE_CHECKING, Self import numpy as np from zarr.storage import WrapperStore if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable, Sequence from typing import Any from zarr.core.buffer.core import BufferPrototype import pytest from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, SupportsDeleteSync, SupportsGetSync, SupportsSetSync, ) from zarr.core.buffer import Buffer, default_buffer_prototype from zarr.core.sync import _collect_aiterator, sync from zarr.storage._utils import _normalize_byte_range_index from zarr.testing.utils import assert_bytes_equal __all__ = ["StoreTests"] class StoreTests[S: Store, B: Buffer]: store_cls: type[S] buffer_cls: type[B] @staticmethod def _require_get_sync(store: S) -> SupportsGetSync: """Skip unless *store* implements [`SupportsGetSync`][zarr.abc.store.SupportsGetSync].""" if not isinstance(store, SupportsGetSync): pytest.skip("store does not implement SupportsGetSync") return store # type: ignore[unreachable] @staticmethod def _require_set_sync(store: S) -> SupportsSetSync: """Skip unless *store* implements [`SupportsSetSync`][zarr.abc.store.SupportsSetSync].""" if not isinstance(store, SupportsSetSync): pytest.skip("store does not implement SupportsSetSync") return store # type: ignore[unreachable] @staticmethod def _require_delete_sync(store: S) -> SupportsDeleteSync: """Skip unless *store* implements [`SupportsDeleteSync`][zarr.abc.store.SupportsDeleteSync].""" if not isinstance(store, SupportsDeleteSync): pytest.skip("store does not implement SupportsDeleteSync") return store # type: ignore[unreachable] @abstractmethod async def set(self, store: S, key: str, value: Buffer) -> None: """ Insert a value into a storage backend, with a specific key. This should not use any store methods. Bypassing the store methods allows them to be tested. """ ... @abstractmethod async def get(self, store: S, key: str) -> Buffer: """ Retrieve a value from a storage backend, by key. This should not use any store methods. Bypassing the store methods allows them to be tested. """ ... @abstractmethod @pytest.fixture def store_kwargs(self, *args: Any, **kwargs: Any) -> dict[str, Any]: """Kwargs for instantiating a store""" ... @abstractmethod def test_store_repr(self, store: S) -> None: ... @abstractmethod def test_store_supports_writes(self, store: S) -> None: ... def test_store_supports_partial_writes(self, store: S) -> None: assert not store.supports_partial_writes @abstractmethod def test_store_supports_listing(self, store: S) -> None: ... @pytest.fixture def open_kwargs(self, store_kwargs: dict[str, Any]) -> dict[str, Any]: return store_kwargs @pytest.fixture async def store(self, open_kwargs: dict[str, Any]) -> Store: return await self.store_cls.open(**open_kwargs) @pytest.fixture async def store_not_open(self, store_kwargs: dict[str, Any]) -> Store: return self.store_cls(**store_kwargs) def test_store_type(self, store: S) -> None: assert isinstance(store, Store) assert isinstance(store, self.store_cls) def test_store_eq(self, store: S, store_kwargs: dict[str, Any]) -> None: # check self equality assert store == store # check store equality with same inputs # asserting this is important for being able to compare (de)serialized stores store2 = self.store_cls(**store_kwargs) assert store == store2 async def test_serializable_store(self, store: S) -> None: new_store: S = pickle.loads(pickle.dumps(store)) assert new_store == store assert new_store.read_only == store.read_only # quickly roundtrip data to a key to test that new store works data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "foo" await store.set(key, data_buf) observed = await store.get(key, prototype=default_buffer_prototype()) assert_bytes_equal(observed, data_buf) def test_store_read_only(self, store: S) -> None: assert not store.read_only with pytest.raises(AttributeError): store.read_only = False # type: ignore[misc] @pytest.mark.parametrize("read_only", [True, False]) async def test_store_open_read_only(self, open_kwargs: dict[str, Any], read_only: bool) -> None: open_kwargs["read_only"] = read_only store = await self.store_cls.open(**open_kwargs) assert store._is_open assert store.read_only == read_only async def test_store_context_manager(self, open_kwargs: dict[str, Any]) -> None: # Test that the context manager closes the store with await self.store_cls.open(**open_kwargs) as store: assert store._is_open # Test trying to open an already open store with pytest.raises(ValueError, match="store is already open"): await store._open() assert not store._is_open async def test_read_only_store_raises(self, open_kwargs: dict[str, Any]) -> None: kwargs = {**open_kwargs, "read_only": True} store = await self.store_cls.open(**kwargs) assert store.read_only # set with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await store.set("foo", self.buffer_cls.from_bytes(b"bar")) # delete with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await store.delete("foo") async def test_with_read_only_store(self, open_kwargs: dict[str, Any]) -> None: kwargs = {**open_kwargs, "read_only": True} store = await self.store_cls.open(**kwargs) assert store.read_only # Test that you cannot write to a read-only store with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await store.set("foo", self.buffer_cls.from_bytes(b"bar")) # Check if the store implements with_read_only try: writer = store.with_read_only(read_only=False) except NotImplementedError: # Test that stores that do not implement with_read_only raise NotImplementedError with the correct message with pytest.raises( NotImplementedError, match=f"with_read_only is not implemented for the {type(store)} store type.", ): store.with_read_only(read_only=False) return # Test that you can write to a new store copy assert not writer._is_open assert not writer.read_only await writer.set("foo", self.buffer_cls.from_bytes(b"bar")) await writer.delete("foo") # Test that you cannot write to the original store assert store.read_only with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await store.set("foo", self.buffer_cls.from_bytes(b"bar")) with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await store.delete("foo") # Test that you cannot write to a read-only store copy reader = store.with_read_only(read_only=True) assert reader.read_only with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await reader.set("foo", self.buffer_cls.from_bytes(b"bar")) with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await reader.delete("foo") @pytest.mark.parametrize("key", ["c/0", "foo/c/0.0", "foo/0/0"]) @pytest.mark.parametrize( ("data", "byte_range"), [ (b"\x01\x02\x03\x04", None), (b"\x01\x02\x03\x04", RangeByteRequest(1, 4)), (b"\x01\x02\x03\x04", OffsetByteRequest(1)), (b"\x01\x02\x03\x04", SuffixByteRequest(1)), (b"", None), ], ) async def test_get(self, store: S, key: str, data: bytes, byte_range: ByteRequest) -> None: """ Ensure that data can be read from the store using the store.get method. """ data_buf = self.buffer_cls.from_bytes(data) await self.set(store, key, data_buf) observed = await store.get(key, prototype=default_buffer_prototype(), byte_range=byte_range) start, stop = _normalize_byte_range_index(data_buf, byte_range=byte_range) expected = data_buf[start:stop] assert_bytes_equal(observed, expected) async def test_get_not_open(self, store_not_open: S) -> None: """ Ensure that data can be read from the store that isn't yet open using the store.get method. """ assert not store_not_open._is_open data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "c/0" await self.set(store_not_open, key, data_buf) observed = await store_not_open.get(key, prototype=default_buffer_prototype()) assert_bytes_equal(observed, data_buf) async def test_get_raises(self, store: S) -> None: """ Ensure that a ValueError is raise for invalid byte range syntax """ data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") await self.set(store, "c/0", data_buf) with pytest.raises((ValueError, TypeError), match=r"Unexpected byte_range, got.*"): await store.get("c/0", prototype=default_buffer_prototype(), byte_range=(0, 2)) # type: ignore[arg-type] async def test_get_many(self, store: S) -> None: """ Ensure that multiple keys can be retrieved at once with the _get_many method. """ keys = tuple(map(str, range(10))) values = tuple(f"{k}".encode() for k in keys) for k, v in zip(keys, values, strict=False): await self.set(store, k, self.buffer_cls.from_bytes(v)) observed_buffers = await _collect_aiterator( store._get_many( zip( keys, (default_buffer_prototype(),) * len(keys), (None,) * len(keys), strict=False, ) ) ) observed_kvs = sorted(((k, b.to_bytes()) for k, b in observed_buffers)) # type: ignore[union-attr] expected_kvs = sorted(((k, b) for k, b in zip(keys, values, strict=False))) assert observed_kvs == expected_kvs @pytest.mark.parametrize("key", ["c/0", "foo/c/0.0", "foo/0/0"]) @pytest.mark.parametrize("data", [b"\x01\x02\x03\x04", b""]) async def test_getsize(self, store: S, key: str, data: bytes) -> None: """ Test the result of store.getsize(). """ data_buf = self.buffer_cls.from_bytes(data) expected = len(data_buf) await self.set(store, key, data_buf) observed = await store.getsize(key) assert observed == expected async def test_getsize_prefix(self, store: S) -> None: """ Test the result of store.getsize_prefix(). Includes a sibling key ("cc/0") that shares the string prefix "c" but belongs to a different directory: getsize_prefix("c") must not count it, i.e. the prefix is matched as a directory ("c/...") not a raw substring. """ data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") keys = ["c/0/0", "c/0/1", "c/1/0", "c/1/1"] # Sibling directory sharing the "c" string prefix; must be excluded. sibling_keys = ["cc/0"] keys_values = [(k, data_buf) for k in keys + sibling_keys] await store._set_many(keys_values) expected = len(data_buf) * len(keys) observed = await store.getsize_prefix("c") assert observed == expected async def test_getsize_raises(self, store: S) -> None: """ Test that getsize() raise a FileNotFoundError if the key doesn't exist. """ with pytest.raises(FileNotFoundError): await store.getsize("c/1000") @pytest.mark.parametrize("key", ["zarr.json", "c/0", "foo/c/0.0", "foo/0/0"]) @pytest.mark.parametrize("data", [b"\x01\x02\x03\x04", b""]) async def test_set(self, store: S, key: str, data: bytes) -> None: """ Ensure that data can be written to the store using the store.set method. """ assert not store.read_only data_buf = self.buffer_cls.from_bytes(data) await store.set(key, data_buf) observed = await self.get(store, key) assert_bytes_equal(observed, data_buf) async def test_set_not_open(self, store_not_open: S) -> None: """ Ensure that data can be written to the store that's not yet open using the store.set method. """ assert not store_not_open._is_open data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "c/0" await store_not_open.set(key, data_buf) observed = await self.get(store_not_open, key) assert_bytes_equal(observed, data_buf) async def test_set_many(self, store: S) -> None: """ Test that a dict of key : value pairs can be inserted into the store via the `_set_many` method. """ keys = ["zarr.json", "c/0", "foo/c/0.0", "foo/0/0"] data_buf = [self.buffer_cls.from_bytes(k.encode()) for k in keys] store_dict = dict(zip(keys, data_buf, strict=True)) await store._set_many(store_dict.items()) for k, v in store_dict.items(): assert (await self.get(store, k)).to_bytes() == v.to_bytes() @pytest.mark.parametrize( "key_ranges", [ [], [("zarr.json", RangeByteRequest(0, 2))], [("c/0", RangeByteRequest(0, 2)), ("zarr.json", None)], [ ("c/0/0", RangeByteRequest(0, 2)), ("c/0/1", SuffixByteRequest(2)), ("c/0/2", OffsetByteRequest(2)), ], ], ) async def test_get_partial_values( self, store: S, key_ranges: list[tuple[str, ByteRequest]] ) -> None: # put all of the data for key, _ in key_ranges: await self.set(store, key, self.buffer_cls.from_bytes(bytes(key, encoding="utf-8"))) # read back just part of it. Pass key_ranges as a one-shot generator # (a valid Iterable per the method signature) to ensure stores and # wrappers do not exhaust the iterable before handing it to the backend. observed_maybe = await store.get_partial_values( prototype=default_buffer_prototype(), key_ranges=(kr for kr in key_ranges), ) # One result must be returned per requested key range. Checking this # explicitly guards against a store/wrapper exhausting the key_ranges # iterable early and silently returning fewer (or no) results. assert len(observed_maybe) == len(key_ranges) observed: list[Buffer] = [] expected: list[Buffer] = [] for obs in observed_maybe: assert obs is not None observed.append(obs) for key, byte_range in key_ranges: result = await store.get( key, prototype=default_buffer_prototype(), byte_range=byte_range ) assert result is not None expected.append(result) assert all( obs.to_bytes() == exp.to_bytes() for obs, exp in zip(observed, expected, strict=True) ) async def test_exists(self, store: S) -> None: assert not await store.exists("foo") await store.set("foo/zarr.json", self.buffer_cls.from_bytes(b"bar")) assert await store.exists("foo/zarr.json") async def test_delete(self, store: S) -> None: if not store.supports_deletes: pytest.skip("store does not support deletes") await store.set("foo/zarr.json", self.buffer_cls.from_bytes(b"bar")) assert await store.exists("foo/zarr.json") await store.delete("foo/zarr.json") assert not await store.exists("foo/zarr.json") async def test_delete_dir(self, store: S) -> None: if not store.supports_deletes: pytest.skip("store does not support deletes") await store.set("zarr.json", self.buffer_cls.from_bytes(b"root")) await store.set("foo-bar/zarr.json", self.buffer_cls.from_bytes(b"root")) await store.set("foo/zarr.json", self.buffer_cls.from_bytes(b"bar")) await store.set("foo/c/0", self.buffer_cls.from_bytes(b"chunk")) await store.delete_dir("foo") assert await store.exists("zarr.json") assert await store.exists("foo-bar/zarr.json") assert not await store.exists("foo/zarr.json") assert not await store.exists("foo/c/0") async def test_delete_nonexistent_key_does_not_raise(self, store: S) -> None: if not store.supports_deletes: pytest.skip("store does not support deletes") await store.delete("nonexistent_key") async def test_is_empty(self, store: S) -> None: assert await store.is_empty("") await self.set( store, "foo/bar", self.buffer_cls.from_bytes(bytes("something", encoding="utf-8")) ) assert not await store.is_empty("") assert await store.is_empty("fo") assert not await store.is_empty("foo/") assert not await store.is_empty("foo") assert await store.is_empty("spam/") async def test_clear(self, store: S) -> None: await self.set( store, "key", self.buffer_cls.from_bytes(bytes("something", encoding="utf-8")) ) await store.clear() assert await store.is_empty("") async def test_list(self, store: S) -> None: assert await _collect_aiterator(store.list()) == () prefix = "foo" data = self.buffer_cls.from_bytes(b"") store_dict = { f"{prefix}/zarr.json": data, **{f"{prefix}/c/{idx}": data for idx in range(10)}, } await store._set_many(store_dict.items()) expected_sorted = sorted(store_dict.keys()) observed = await _collect_aiterator(store.list()) observed_sorted = sorted(observed) assert observed_sorted == expected_sorted async def test_list_prefix(self, store: S) -> None: """ Test that the `list_prefix` method works as intended. Given a prefix, it should return all the keys in storage that start with this prefix. """ prefixes = ("", "a/", "a/b/", "a/b/c/") data = self.buffer_cls.from_bytes(b"") fname = "zarr.json" store_dict = {p + fname: data for p in prefixes} await store._set_many(store_dict.items()) for prefix in prefixes: observed = tuple(sorted(await _collect_aiterator(store.list_prefix(prefix)))) expected: tuple[str, ...] = () for key in store_dict: if key.startswith(prefix): expected += (key,) expected = tuple(sorted(expected)) assert observed == expected async def test_list_empty_path(self, store: S) -> None: """ Verify that list and list_prefix work correctly when path is an empty string, i.e. no unwanted replacement occurs. """ data = self.buffer_cls.from_bytes(b"") store_dict = { "foo/bar/zarr.json": data, "foo/bar/c/1": data, "foo/baz/c/0": data, } await store._set_many(store_dict.items()) # Test list() observed_list = await _collect_aiterator(store.list()) observed_list_sorted = sorted(observed_list) expected_list_sorted = sorted(store_dict.keys()) assert observed_list_sorted == expected_list_sorted # Test list_prefix() with an empty prefix observed_prefix_empty = await _collect_aiterator(store.list_prefix("")) observed_prefix_empty_sorted = sorted(observed_prefix_empty) expected_prefix_empty_sorted = sorted(store_dict.keys()) assert observed_prefix_empty_sorted == expected_prefix_empty_sorted # Test list_prefix() with a non-empty prefix observed_prefix = await _collect_aiterator(store.list_prefix("foo/bar/")) observed_prefix_sorted = sorted(observed_prefix) expected_prefix_sorted = sorted(k for k in store_dict if k.startswith("foo/bar/")) assert observed_prefix_sorted == expected_prefix_sorted async def test_list_dir(self, store: S) -> None: roots_and_keys: list[tuple[str, dict[str, Buffer]]] = [ ( "foo", { "foo/zarr.json": self.buffer_cls.from_bytes(b"bar"), "foo/c/1": self.buffer_cls.from_bytes(b"\x01"), }, ), ( "foo/bar", { "foo/bar/foobar_first_child": self.buffer_cls.from_bytes(b"1"), "foo/bar/foobar_second_child/zarr.json": self.buffer_cls.from_bytes(b"2"), }, ), ] assert await _collect_aiterator(store.list_dir("")) == () for root, store_dict in roots_and_keys: assert await _collect_aiterator(store.list_dir(root)) == () await store._set_many(store_dict.items()) keys_observed = await _collect_aiterator(store.list_dir(root)) keys_expected = {k.removeprefix(f"{root}/").split("/")[0] for k in store_dict} assert sorted(keys_observed) == sorted(keys_expected) keys_observed = await _collect_aiterator(store.list_dir(f"{root}/")) assert sorted(keys_expected) == sorted(keys_observed) async def test_set_if_not_exists(self, store: S) -> None: key = "k" data_buf = self.buffer_cls.from_bytes(b"0000") await self.set(store, key, data_buf) new = self.buffer_cls.from_bytes(b"1111") await store.set_if_not_exists("k", new) # no error result = await store.get(key, default_buffer_prototype()) assert result == data_buf await store.set_if_not_exists("k2", new) # no error result = await store.get("k2", default_buffer_prototype()) assert result == new # ------------------------------------------------------------------- # Synchronous store methods (SupportsSyncStore protocol) # ------------------------------------------------------------------- def test_get_sync(self, store: S) -> None: getter = self._require_get_sync(store) data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "sync_get" sync(self.set(store, key, data_buf)) result = getter.get_sync(key) assert result is not None assert_bytes_equal(result, data_buf) def test_get_sync_missing(self, store: S) -> None: getter = self._require_get_sync(store) result = getter.get_sync("nonexistent") assert result is None def test_set_sync(self, store: S) -> None: setter = self._require_set_sync(store) data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "sync_set" setter.set_sync(key, data_buf) result = sync(self.get(store, key)) assert_bytes_equal(result, data_buf) def test_delete_sync(self, store: S) -> None: setter = self._require_set_sync(store) deleter = self._require_delete_sync(store) getter = self._require_get_sync(store) if not store.supports_deletes: pytest.skip("store does not support deletes") data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "sync_delete" setter.set_sync(key, data_buf) deleter.delete_sync(key) result = getter.get_sync(key) assert result is None def test_delete_sync_missing(self, store: S) -> None: deleter = self._require_delete_sync(store) if not store.supports_deletes: pytest.skip("store does not support deletes") # should not raise deleter.delete_sync("nonexistent_sync") # ------------------------------------------------------------------- # Sync/async parity laws # ------------------------------------------------------------------- # A store's sync and async methods must observe the same key the same # way. This is stronger than the individual test_get_sync/test_set_sync/ # test_delete_sync tests above: those write and read back through the # *same* API (sync-only or, via `self.set`/`self.get`, bypassing the # store entirely), so a sync method that skips logic the async method # applies (e.g. a path prefix) can still pass them. These laws write # through one API and observe through the other. @pytest.mark.parametrize("direction", ["set_async_get_sync", "set_sync_get_async"]) async def test_sync_async_set_get_parity(self, store: S, direction: str) -> None: setter = self._require_set_sync(store) getter = self._require_get_sync(store) data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "parity_set_get" if direction == "set_async_get_sync": await store.set(key, data_buf) result = getter.get_sync(key) else: setter.set_sync(key, data_buf) result = await store.get(key, prototype=default_buffer_prototype()) assert result is not None assert_bytes_equal(result, data_buf) async def test_delete_sync_visible_to_async_get(self, store: S) -> None: deleter = self._require_delete_sync(store) if not store.supports_deletes: pytest.skip("store does not support deletes") data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "parity_delete" await store.set(key, data_buf) deleter.delete_sync(key) result = await store.get(key, prototype=default_buffer_prototype()) assert result is None @pytest.mark.parametrize( "byte_range", [ None, RangeByteRequest(1, 4), OffsetByteRequest(1), SuffixByteRequest(1), RangeByteRequest(10, 20), ], ids=["none", "range", "offset", "suffix", "range-past-eof"], ) async def test_get_sync_byte_range_parity( self, store: S, byte_range: ByteRequest | None ) -> None: getter = self._require_get_sync(store) data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "parity_byte_range" await store.set(key, data_buf) sync_result = getter.get_sync(key, byte_range=byte_range) async_result = await store.get( key, prototype=default_buffer_prototype(), byte_range=byte_range ) if async_result is None: assert sync_result is None else: assert sync_result is not None assert_bytes_equal(sync_result, async_result) class LatencyStore(WrapperStore[Store]): """ A wrapper class that takes any store class in its constructor and adds latency to the `set` and `get` methods. This can be used for performance testing. """ _get_latency: float | tuple[float, float] _set_latency: float | tuple[float, float] def __init__( self, store: Store, *, get_latency: float | tuple[float, float] = 0, set_latency: float | tuple[float, float] = 0, ) -> None: super().__init__(store) self._get_latency = get_latency if isinstance(get_latency, tuple) else float(get_latency) self._set_latency = set_latency if isinstance(set_latency, tuple) else float(set_latency) @property def get_latency(self) -> float: if isinstance(self._get_latency, float): return self._get_latency return max(0.0, np.random.normal(loc=self._get_latency[0], scale=self._get_latency[1])) @property def set_latency(self) -> float: if isinstance(self._set_latency, float): return self._set_latency return max(0.0, np.random.normal(loc=self._set_latency[0], scale=self._set_latency[1])) def _with_store(self, store: Store) -> Self: # Pass the raw latency config, not the sampled `get_latency`/`set_latency` # properties — sampling would freeze a `(loc, scale)` distribution into # one fixed float on derived stores (e.g. via `with_read_only`). return type(self)(store, get_latency=self._get_latency, set_latency=self._set_latency) async def set(self, key: str, value: Buffer) -> None: """ Add latency to the ``set`` method. Calls ``asyncio.sleep(self.set_latency)`` before invoking the wrapped ``set`` method. Parameters ---------- key : str The key to set value : Buffer The value to set Returns ------- None """ await asyncio.sleep(self.set_latency) await self._store.set(key, value) async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: """ Add latency to the ``get`` method. Calls ``asyncio.sleep(self.get_latency)`` before invoking the wrapped ``get`` method. Parameters ---------- key : str The key to get prototype : BufferPrototype The BufferPrototype to use. byte_range : ByteRequest, optional An optional byte range. Returns ------- buffer : Buffer or None """ await asyncio.sleep(self.get_latency) return await self._store.get(key, prototype=prototype, byte_range=byte_range) def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: """Add latency to `get_sync`. Sleeps `self.get_latency` on the calling thread (the sync path runs on worker threads, not the event loop) before delegating to the wrapped store. """ time.sleep(self.get_latency) return super().get_sync(key, prototype=prototype, byte_range=byte_range) def set_sync(self, key: str, value: Buffer) -> None: """Add latency to `set_sync`. Sleeps `self.set_latency` on the calling thread (the sync path runs on worker threads, not the event loop) before delegating to the wrapped store. """ time.sleep(self.set_latency) super().set_sync(key, value) async def get_ranges( self, key: str, byte_ranges: Sequence[ByteRequest | None], *, prototype: BufferPrototype, max_concurrency: int | None = None, max_gap_bytes: int | None = None, max_coalesced_bytes: int | None = None, ) -> AsyncIterator[Sequence[tuple[int, Buffer | None]]]: """Byte-range reads built on `self.get`, so each fetch pays latency. Routes through the coalescing `Store.get_ranges` default instead of the `WrapperStore` delegation, which would bypass this wrapper's `get` and therefore the synthetic latency. `None` for a coalescing kwarg means "use the `Store` default". """ kwargs: dict[str, int] = {} if max_concurrency is not None: kwargs["max_concurrency"] = max_concurrency if max_gap_bytes is not None: kwargs["max_gap_bytes"] = max_gap_bytes if max_coalesced_bytes is not None: kwargs["max_coalesced_bytes"] = max_coalesced_bytes async for group in Store.get_ranges(self, key, byte_ranges, prototype=prototype, **kwargs): yield group async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: """Partial-value reads built on `self.get`, so each fetch pays latency. Issues one `self.get` per `(key, byte_range)` pair instead of the `WrapperStore` delegation, which would bypass this wrapper's `get` and therefore the synthetic latency. """ return list( await asyncio.gather( *( self.get(key, prototype=prototype, byte_range=byte_range) for key, byte_range in key_ranges ) ) ) zarr-python-3.3.0/src/zarr/testing/strategies.py000066400000000000000000000756221523267620000217770ustar00rootroot00000000000000import itertools import math import sys from collections.abc import Callable, Mapping from typing import Any, Literal import hypothesis.extra.numpy as npst import hypothesis.strategies as st import numpy as np import numpy.typing as npt from hypothesis import event from hypothesis.strategies import SearchStrategy import zarr from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, Store, SuffixByteRequest, ) from zarr.codecs.bytes import BytesCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.sharding import SUBCHUNK_WRITE_ORDER, ShardingCodec, SubchunkWriteOrder from zarr.codecs.zstd import ZstdCodec from zarr.core.array import Array, CompressorsLike, SerializerLike from zarr.core.chunk_key_encodings import DefaultChunkKeyEncoding from zarr.core.common import JSON, AccessModeLiteral, ZarrFormat from zarr.core.dtype import get_data_type_from_native_dtype from zarr.core.metadata import ArrayV2Metadata, ArrayV3Metadata from zarr.core.metadata.v3 import RectilinearChunkGridMetadata, RegularChunkGridMetadata from zarr.core.sync import sync from zarr.storage import MemoryStore, StoreLike from zarr.storage._utils import _join_paths, normalize_path from zarr.types import AnyArray TrueOrFalse = Literal[True, False] # Copied from Xarray _attr_keys = st.text(st.characters(), min_size=1) _attr_values = st.recursive( st.none() | st.booleans() | st.text(st.characters(), max_size=5), lambda children: st.lists(children) | st.dictionaries(_attr_keys, children), max_leaves=3, ) @st.composite def keys(draw: st.DrawFn, *, max_num_nodes: int | None = None) -> str: return draw(st.lists(node_names, min_size=1, max_size=max_num_nodes).map("/".join)) @st.composite def paths(draw: st.DrawFn, *, max_num_nodes: int | None = None) -> str: return draw(st.just("/") | keys(max_num_nodes=max_num_nodes)) def dtypes() -> st.SearchStrategy[np.dtype[Any]]: return ( npst.boolean_dtypes() | npst.integer_dtypes(endianness="=") | npst.unsigned_integer_dtypes(endianness="=") | npst.floating_dtypes(endianness="=") | npst.complex_number_dtypes(endianness="=") | npst.byte_string_dtypes(endianness="=") | npst.unicode_string_dtypes(endianness="=") | npst.datetime64_dtypes(endianness="=") | npst.timedelta64_dtypes(endianness="=") ) def v3_dtypes() -> st.SearchStrategy[np.dtype[Any]]: return dtypes() def v2_dtypes() -> st.SearchStrategy[np.dtype[Any]]: return dtypes() def safe_unicode_for_dtype(dtype: np.dtype[np.str_]) -> st.SearchStrategy[str]: """Generate UTF-8-safe text constrained to max_len of dtype.""" # account for utf-32 encoding (i.e. 4 bytes/character) max_len = max(1, dtype.itemsize // 4) return st.text( alphabet=st.characters( exclude_categories=["Cs"], # Avoid *technically allowed* surrogates min_codepoint=32, ), min_size=1, max_size=max_len, ) def clear_store(x: Store) -> Store: sync(x.clear()) return x # From https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html#node-names # 1. must not be the empty string ("") # 2. must not include the character "/" # 3. must not be a string composed only of period characters, e.g. "." or ".." # 4. must not start with the reserved prefix "__" zarr_key_chars = st.sampled_from( ".-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz" ) node_names = ( st.text(zarr_key_chars, min_size=1) .filter(lambda t: t not in (".", "..") and not t.startswith("__")) .filter(lambda name: name.lower() != "zarr.json") ) short_node_names = ( st.text(zarr_key_chars, max_size=3, min_size=1) .filter(lambda t: t not in (".", "..") and not t.startswith("__")) .filter(lambda name: name.lower() != "zarr.json") ) array_names = node_names attrs: st.SearchStrategy[Mapping[str, JSON] | None] = st.none() | st.dictionaries( _attr_keys, _attr_values ) # st.builds will only call a new store constructor for different keyword arguments # i.e. stores.examples() will always return the same object per Store class. # So we map a clear to reset the store. stores = st.builds(MemoryStore, st.just({})).map(clear_store) compressors = st.sampled_from([None, "default"]) zarr_formats: st.SearchStrategy[ZarrFormat] = st.sampled_from([3, 2]) # We de-prioritize arrays having dim sizes 0, 1, 2 array_shapes = npst.array_shapes(max_dims=4, min_side=3, max_side=5) | npst.array_shapes( max_dims=4, min_side=0 ) @st.composite def dimension_names(draw: st.DrawFn, *, ndim: int | None = None) -> list[None | str] | None: simple_text = st.text(zarr_key_chars, min_size=0) return draw(st.none() | st.lists(st.none() | simple_text, min_size=ndim, max_size=ndim)) # type: ignore[arg-type] subchunk_write_orders: st.SearchStrategy[SubchunkWriteOrder] = st.sampled_from(SUBCHUNK_WRITE_ORDER) # Inner codec chains for a ShardingCodec. We MUST sample the uncompressed, # single-BytesCodec configuration (no Zstd) — that is the only configuration in # which the FusedCodecPipeline's vectorized whole-shard "bulk decode" fast path # engages, so it is the only one that can exercise (and regress-guard) that path # against arbitrary indexing. Freezing the inner codecs to [BytesCodec, ZstdCodec] # silently disables the fast path under every property test. sharding_inner_codecs: st.SearchStrategy[list[BytesCodec | ZstdCodec]] = st.sampled_from( [ [BytesCodec()], [BytesCodec(), ZstdCodec()], ] ) @st.composite def array_metadata( draw: st.DrawFn, *, array_shapes: Callable[..., st.SearchStrategy[tuple[int, ...]]] = npst.array_shapes, zarr_formats: st.SearchStrategy[ZarrFormat] = zarr_formats, attributes: SearchStrategy[Mapping[str, JSON] | None] = attrs, ) -> ArrayV2Metadata | ArrayV3Metadata: zarr_format = draw(zarr_formats) # separator = draw(st.sampled_from(['/', '\\'])) shape = draw(array_shapes()) ndim = len(shape) np_dtype = draw(dtypes()) dtype = get_data_type_from_native_dtype(np_dtype) fill_value = draw(npst.from_dtype(np_dtype)) if zarr_format == 2: chunk_shape = draw(array_shapes(min_dims=ndim, max_dims=ndim, min_side=1)) return ArrayV2Metadata( shape=shape, chunks=chunk_shape, dtype=dtype, fill_value=fill_value, order=draw(st.sampled_from(["C", "F"])), attributes=draw(attributes), # type: ignore[arg-type] dimension_separator=draw(st.sampled_from([".", "/"])), filters=None, compressor=None, ) else: chunk_grid = draw(chunk_grids(shape=shape)) return ArrayV3Metadata( shape=shape, data_type=dtype, chunk_grid=chunk_grid, fill_value=fill_value, attributes=draw(attributes), # type: ignore[arg-type] dimension_names=draw(dimension_names(ndim=ndim)), chunk_key_encoding=DefaultChunkKeyEncoding(separator="/"), # FIXME codecs=[BytesCodec()], storage_transformers=(), ) @st.composite def numpy_arrays( draw: st.DrawFn, *, shapes: st.SearchStrategy[tuple[int, ...]] = array_shapes, dtype: np.dtype[Any] | None = None, ) -> npt.NDArray[Any]: """ Generate numpy arrays that can be saved in the provided Zarr format. """ if dtype is None: dtype = draw(dtypes()) if np.issubdtype(dtype, np.str_): safe_unicode_strings = safe_unicode_for_dtype(dtype) return draw(npst.arrays(dtype=dtype, shape=shapes, elements=safe_unicode_strings)) return draw(npst.arrays(dtype=dtype, shape=shapes)) @st.composite def chunk_shapes(draw: st.DrawFn, *, shape: tuple[int, ...]) -> tuple[int, ...]: # We want this strategy to shrink towards arrays with smaller number of chunks # 1. st.integers() shrinks towards smaller values. So we use that to generate number of chunks numchunks = draw( st.tuples( *[ st.integers(min_value=0 if size == 0 else 1, max_value=max(size, 1)) for size in shape ] ) ) # 2. and now generate the chunks tuple # Chunk sizes must be >= 1 per spec; for zero-extent dimensions use 1. chunks = tuple( max(1, size // nchunks) if nchunks > 0 else 1 for size, nchunks in zip(shape, numchunks, strict=True) ) for c in chunks: event("chunk size", c) if any((c != 0 and s % c != 0) for s, c in zip(shape, chunks, strict=True)): event("smaller last chunk") return chunks @st.composite def shard_shapes( draw: st.DrawFn, *, shape: tuple[int, ...], chunk_shape: tuple[int, ...] ) -> tuple[int, ...]: # We want this strategy to shrink towards arrays with smaller number of shards # shards must be an integral number of chunks assert all(c != 0 for c in chunk_shape) numchunks = tuple(s // c for s, c in zip(shape, chunk_shape, strict=True)) multiples = tuple(draw(st.integers(min_value=1, max_value=nc)) for nc in numchunks) return tuple(m * c for m, c in zip(multiples, chunk_shape, strict=True)) @st.composite def np_array_and_chunks( draw: st.DrawFn, *, arrays: st.SearchStrategy[npt.NDArray[Any]] = numpy_arrays(), # noqa: B008 ) -> tuple[np.ndarray[Any, Any], tuple[int, ...]]: """A hypothesis strategy to generate small sized random arrays. Returns: a tuple of the array and a suitable random chunking for it. """ array = draw(arrays) return (array, draw(chunk_shapes(shape=array.shape))) @st.composite def arrays( draw: st.DrawFn, *, shapes: st.SearchStrategy[tuple[int, ...]] = array_shapes, compressors: st.SearchStrategy = compressors, stores: st.SearchStrategy[StoreLike] = stores, paths: st.SearchStrategy[str] = paths(), # noqa: B008 array_names: st.SearchStrategy = array_names, arrays: st.SearchStrategy | None = None, attrs: st.SearchStrategy = attrs, zarr_formats: st.SearchStrategy = zarr_formats, subchunk_write_orders: SearchStrategy[SubchunkWriteOrder] = subchunk_write_orders, open_mode: AccessModeLiteral = "w", ) -> AnyArray: store = draw(stores, label="store") path = draw(paths, label="array parent") name = draw(array_names, label="array name") attributes = draw(attrs, label="attributes") zarr_format = draw(zarr_formats, label="zarr format") if arrays is None: arrays = numpy_arrays(shapes=shapes) nparray = draw(arrays, label="array data") dim_names: None | list[str | None] = None serializer: SerializerLike = "auto" compressors_unsearched: CompressorsLike = "auto" # For v3 arrays, optionally use RectilinearChunkGridMetadata chunk_grid_meta: RegularChunkGridMetadata | RectilinearChunkGridMetadata | None = None # test that None works too. fill_value = draw(st.one_of([st.none(), npst.from_dtype(nparray.dtype)])) # compressor = draw(compressors) expected_attrs = {} if attributes is None else attributes array_path = _join_paths([path, name]) root = zarr.open_group(store, mode=open_mode, zarr_format=zarr_format) # Convert chunk grid metadata to a form create_array accepts: # - RegularChunkGridMetadata -> flat tuple of ints # - RectilinearChunkGridMetadata -> nested list of ints (triggers rectilinear path) # - v2 -> flat tuple of ints chunks_param: tuple[int, ...] | list[list[int]] shard_shape = None dim_names = None if zarr_format == 3: chunk_grid_meta = draw(st.none() | chunk_grids(shape=nparray.shape), label="chunk grid") dim_names = draw(dimension_names(ndim=nparray.ndim), label="dimension names") if isinstance(chunk_grid_meta, RectilinearChunkGridMetadata): chunks_param = [ list(dim) if isinstance(dim, tuple) else [dim] for dim in chunk_grid_meta.chunk_shapes ] elif isinstance(chunk_grid_meta, RegularChunkGridMetadata): chunks_param = chunk_grid_meta.chunk_shape else: chunks_param = draw(chunk_shapes(shape=nparray.shape), label="chunk shape") if all(s > c and c > 1 for s, c in zip(nparray.shape, chunks_param, strict=True)): shard_shape = draw( st.none() | shard_shapes(shape=nparray.shape, chunk_shape=chunks_param), label="shard shape", ) if shard_shape is not None: subchunk_write_order = draw(subchunk_write_orders) inner_codecs = draw(sharding_inner_codecs, label="sharding inner codecs") serializer = ShardingCodec( subchunk_write_order=subchunk_write_order, codecs=inner_codecs, index_codecs=[BytesCodec(), Crc32cCodec()], chunk_shape=chunks_param, ) compressors_unsearched = None else: chunks_param = draw(chunk_shapes(shape=nparray.shape), label="chunk shape") a = root.create_array( array_path, shape=nparray.shape, chunks=chunks_param, shards=shard_shape, dtype=nparray.dtype, attributes=attributes, compressors=compressors_unsearched, # FIXME fill_value=fill_value, dimension_names=dim_names, serializer=serializer, ) assert isinstance(a, Array) if a.metadata.zarr_format == 3: assert a.fill_value is not None assert a.name is not None assert a.path == normalize_path(array_path) assert a.name == f"/{a.path}" assert isinstance(root[array_path], Array) assert nparray.shape == a.shape # Verify chunks — for rectilinear grids, .chunks raises if zarr_format == 3: assert shard_shape == a.shards if isinstance(a.metadata.chunk_grid, RegularChunkGridMetadata): assert a.metadata.chunk_grid.chunk_shape == ( a.shards if shard_shape is not None else a.chunks ) assert shard_shape == a.shards else: assert isinstance(a.metadata.chunk_grid, RectilinearChunkGridMetadata) assert shard_shape is None assert a.basename == name, (a.basename, name) assert dict(a.attrs) == expected_attrs a[:] = nparray return a @st.composite def simple_arrays( draw: st.DrawFn, *, shapes: st.SearchStrategy[tuple[int, ...]] = array_shapes, ) -> Any: return draw( arrays( shapes=shapes, paths=paths(max_num_nodes=2), array_names=short_node_names, attrs=st.none(), compressors=st.sampled_from([None, "default"]), ) ) @st.composite def rectilinear_chunks(draw: st.DrawFn, *, shape: tuple[int, ...]) -> list[list[int]]: """Generate valid rectilinear chunk shapes for a given array shape. Uses two modes per dimension: - "expanded": random divider points create arbitrary chunk sizes - "rle": uniform chunks with optional remainder, optionally shuffled Keeps max chunks per dimension <= 20 to avoid performance issues in property tests. With higher dimensions, the total chunk count grows multiplicatively. """ chunk_shapes: list[list[int]] = [] for size in shape: assert size > 0 if size > 1: mode = draw(st.sampled_from(["expanded", "rle"])) if mode == "expanded": event("rectilinear expanded") max_chunks = min(size - 1, 20) nchunks = draw(st.integers(min_value=1, max_value=max_chunks)) dividers = sorted( draw( st.lists( st.integers(min_value=1, max_value=size - 1), min_size=nchunks - 1, max_size=nchunks - 1, unique=True, ) ) ) chunk_shapes.append( [a - b for a, b in zip(dividers + [size], [0] + dividers, strict=False)] ) else: # RLE mode: uniform chunks with optional remainder max_chunk_size = min(size, 20) chunk_size = draw(st.integers(min_value=1, max_value=max_chunk_size)) n_full = size // chunk_size remainder = size % chunk_size chunks_list = [chunk_size] * n_full if remainder > 0: chunks_list.append(remainder) # Optionally shuffle to create non-contiguous duplicate patterns if draw(st.booleans()): event("rectilinear rle shuffled") chunks_list = draw(st.permutations(chunks_list)) else: event("rectilinear rle") chunk_shapes.append(list(chunks_list)) else: chunk_shapes.append([1]) return chunk_shapes @st.composite def chunk_grids( draw: st.DrawFn, *, shape: tuple[int, ...] ) -> RegularChunkGridMetadata | RectilinearChunkGridMetadata: """Generate either a RegularChunkGridMetadata or RectilinearChunkGridMetadata. This strategy depends on the global state of the config having rectilinear chunk grids enabled or not. This means that it may be a possible source of a hypothesis FlakyStrategy error due dependence on global state. However, in practice this seems unlikely to happen. This allows property tests to exercise both chunk grid types. """ # RectilinearChunkGridMetadata doesn't support zero-sized dimensions, # so use RegularChunkGridMetadata if any dimension is 0 if any(s == 0 for s in shape): event("using RegularChunkGridMetadata (zero-sized dimensions)") return RegularChunkGridMetadata(chunk_shape=draw(chunk_shapes(shape=shape))) if zarr.config.get("array.rectilinear_chunks") and draw(st.booleans()): chunks = draw(rectilinear_chunks(shape=shape)) event("using RectilinearChunkGridMetadata") return RectilinearChunkGridMetadata(chunk_shapes=tuple(tuple(dim) for dim in chunks)) else: event("using RegularChunkGridMetadata") return RegularChunkGridMetadata(chunk_shape=draw(chunk_shapes(shape=shape))) # Rectilinear arrays need min_side >= 1 so every dimension has at least one element _rectilinear_shapes = npst.array_shapes(max_dims=3, min_side=1, max_side=20) @st.composite def rectilinear_arrays( draw: st.DrawFn, *, shapes: st.SearchStrategy[tuple[int, ...]] = _rectilinear_shapes, ) -> Any: """Generate a zarr v3 array with rectilinear (variable) chunk grid.""" shape = draw(shapes) chunk_shapes = draw(rectilinear_chunks(shape=shape)) np_dtype = draw(dtypes()) nparray = draw(numpy_arrays(shapes=st.just(shape), dtype=np_dtype)) fill_value = draw(st.one_of([st.none(), npst.from_dtype(np_dtype)])) dim_names = draw(dimension_names(ndim=len(shape))) store = MemoryStore() with zarr.config.set({"array.rectilinear_chunks": True}): a = zarr.create_array( store=store, shape=shape, chunks=chunk_shapes, dtype=np_dtype, fill_value=fill_value, dimension_names=dim_names, ) a[:] = nparray return a def is_negative_slice(idx: Any) -> bool: return isinstance(idx, slice) and idx.step is not None and idx.step < 0 @st.composite def end_slices(draw: st.DrawFn, *, shape: tuple[int, ...]) -> Any: """ A strategy that slices ranges that include the last chunk. This is intended to stress-test handling of a possibly smaller last chunk. """ slicers = [] for size in shape: start = draw(st.integers(min_value=size // 2, max_value=size - 1)) length = draw(st.integers(min_value=0, max_value=size - start)) slicers.append(slice(start, start + length)) event("drawing end slice") return tuple(slicers) @st.composite def basic_indices( draw: st.DrawFn, *, shape: tuple[int, ...], min_dims: int = 0, max_dims: int | None = None, allow_newaxis: TrueOrFalse = False, allow_ellipsis: TrueOrFalse = True, ) -> Any: """Basic indices without unsupported negative slices.""" strategy = npst.basic_indices( shape=shape, min_dims=min_dims, max_dims=max_dims, allow_newaxis=allow_newaxis, allow_ellipsis=allow_ellipsis, ).filter( lambda idxr: ( not ( is_negative_slice(idxr) or (isinstance(idxr, tuple) and any(is_negative_slice(idx) for idx in idxr)) ) ) ) if math.prod(shape) >= 3: strategy = end_slices(shape=shape) | strategy return draw(strategy) @st.composite def orthogonal_indices( draw: st.DrawFn, *, shape: tuple[int, ...] ) -> tuple[tuple[np.ndarray[Any, Any], ...], tuple[np.ndarray[Any, Any], ...]]: """ Strategy that returns (1) a tuple of integer arrays used for orthogonal indexing of Zarr arrays. (2) a tuple of integer arrays that can be used for equivalent indexing of numpy arrays """ zindexer = [] npindexer = [] ndim = len(shape) for axis, size in enumerate(shape): if size != 0: strategy = npst.integer_array_indices( shape=(size,), result_shape=npst.array_shapes(min_side=1, max_side=size, max_dims=1) ) | basic_indices(min_dims=1, shape=(size,), allow_ellipsis=False) else: strategy = basic_indices(min_dims=1, shape=(size,), allow_ellipsis=False) val = draw( strategy # bare ints, slices .map(lambda x: (x,) if not isinstance(x, tuple) else x) # skip empty tuple .filter(bool) ) (idxr,) = val if isinstance(idxr, int): idxr = np.array([idxr]) zindexer.append(idxr) if isinstance(idxr, slice): idxr = np.arange(*idxr.indices(size)) elif isinstance(idxr, (tuple, int)): idxr = np.array(idxr) newshape = [1] * ndim newshape[axis] = idxr.size npindexer.append(idxr.reshape(newshape)) # casting the output of broadcast_arrays is needed for numpy < 2 return tuple(zindexer), tuple(np.broadcast_arrays(*npindexer)) @st.composite def block_indices( draw: st.DrawFn, *, chunk_sizes: tuple[tuple[int, ...], ...] ) -> tuple[tuple[int | slice, ...], tuple[slice, ...]]: """ Strategy for block-selection indexers over a chunk grid. Block indexing is basic indexing applied to the block grid (the grid of chunks), so each axis is drawn with ``basic_indices`` over that axis's chunk count, mirroring how ``orthogonal_indices`` reuses ``basic_indices`` per axis. ``chunk_sizes`` gives the per-chunk data sizes of the array's *outer* (block) grid for every axis — i.e. ``Array.write_chunk_sizes``, the grid that ``Array.blocks`` addresses (the shard grid when sharding is used). For example ``(3, 3, 3, 1)`` for a length-10 axis with a regular chunk size of 3, or the explicit edges of a rectilinear axis; ``nchunks`` for an axis is ``len(chunk_sizes[axis])``. The array-space translation uses the cumulative sum of those sizes, matching ``BlockIndexer``'s use of ``dim_grid.chunk_offset``. Because the sizes are clipped to the array extent, the final offset equals the extent and the translation is exact for regular (uniform), rectilinear, and sharded grids alike. Block indexing only supports integers and step-1 slices whose start references an existing chunk, so strided slices and slices starting at the grid edge are filtered out. Returns ------- block_indexer A per-axis tuple of ints / step-1 slices addressing whole chunks, suitable for ``Array.blocks`` / ``get_block_selection`` / ``set_block_selection``. array_indexer The equivalent array-space selection (a tuple of slices) for indexing the corresponding numpy array, used as the comparison oracle. """ def supported(nchunks: int) -> Callable[[tuple[Any, ...]], bool]: # Block indexing only accepts step-1 slices whose start references an # existing chunk (a slice starting at nchunks raises, unlike numpy). def predicate(value: tuple[Any, ...]) -> bool: dim_sel = value[0] if isinstance(dim_sel, slice): if dim_sel.step not in (None, 1): return False start = dim_sel.start or 0 return 0 <= (start + nchunks if start < 0 else start) < nchunks return True return predicate block_indexer: list[int | slice] = [] array_indexer: list[slice] = [] for sizes in chunk_sizes: nchunks = len(sizes) # offsets[i] is the array-space start of chunk i; length nchunks + 1. offsets = list(itertools.accumulate(sizes, initial=0)) dim_strategy = ( basic_indices(min_dims=1, shape=(nchunks,), allow_ellipsis=False) # normalize bare ints / slices to a 1-tuple, skip the empty tuple .map(lambda x: (x,) if not isinstance(x, tuple) else x) .filter(bool) .filter(supported(nchunks)) ) # basic_indices draws slices far more often than bare integers, so the # integer (single-block) branch below would only be hit on rare draws. # Union in an explicit integer so it is reliably exercised — keeping # coverage deterministic under the derandomized ``ci`` Hypothesis profile. (dim_sel,) = draw( dim_strategy | st.integers(min_value=0, max_value=nchunks - 1).map(lambda i: (i,)) ) block_indexer.append(dim_sel) if isinstance(dim_sel, slice): start, stop, _ = dim_sel.indices(nchunks) array_indexer.append(slice(offsets[start], offsets[stop])) else: block = dim_sel % nchunks array_indexer.append(slice(offsets[block], offsets[block + 1])) return tuple(block_indexer), tuple(array_indexer) @st.composite def block_test_arrays( draw: st.DrawFn, ) -> tuple[Array[Any], np.ndarray[Any, Any]]: """Draw an array for block-indexing property tests, with its source contents. Two arms, selected with equal probability: - **regular**: a regular chunk grid, optionally wrapped in sharding. - **rectilinear**: a variable (rectilinear) chunk grid, always unsharded. Returns ``(zarray, nparray)``. The per-axis block sizes the oracle needs are ``zarray.write_chunk_sizes`` — the array's *outer* (block / shard) grid, which is exactly the grid ``Array.blocks`` addresses; the caller reads it directly. """ chunks: tuple[int, ...] | list[list[int]] if draw(st.booleans()): # regular arm, optionally sharded nparray, chunks = draw( np_array_and_chunks( arrays=numpy_arrays(shapes=npst.array_shapes(max_dims=4, min_side=1)) ) ) # min_side=1 chunking guarantees shape // chunk >= 1 on every axis, which # shard_shapes requires. shards = draw(st.none() | shard_shapes(shape=nparray.shape, chunk_shape=chunks)) event("block regular sharded" if shards is not None else "block regular unsharded") rectilinear = False else: # rectilinear arm, always unsharded event("block rectilinear") shape = draw(_rectilinear_shapes) chunks = draw(rectilinear_chunks(shape=shape)) nparray = draw(numpy_arrays(shapes=st.just(shape), dtype=draw(dtypes()))) shards, rectilinear = None, True store = draw(stores) with zarr.config.set({"array.rectilinear_chunks": rectilinear}): zarray = zarr.create_array( store=store, shape=nparray.shape, chunks=chunks, shards=shards, dtype=nparray.dtype, ) zarray[...] = nparray return zarray, nparray def key_ranges( keys: SearchStrategy[str] = node_names, max_size: int = sys.maxsize ) -> SearchStrategy[list[tuple[str, ByteRequest | None]]]: """ Function to generate key_ranges strategy for get_partial_values() returns list strategy w/ form:: [(key, byte_request), (key, byte_request),...] where ``byte_request`` is ``None`` or any of the concrete ``ByteRequest`` subtypes. The bounds are drawn independently of each value's length, so the offsets/suffixes routinely exceed the data and exercise the clamping logic in ``_normalize_byte_range_index``. """ def make_range(start: int, length: int) -> RangeByteRequest: return RangeByteRequest(start, end=min(start + length, max_size)) bound = st.integers(min_value=0, max_value=max_size) byte_ranges: SearchStrategy[ByteRequest | None] = st.one_of( st.none(), st.builds(make_range, start=bound, length=bound), st.builds(OffsetByteRequest, offset=bound), st.builds(SuffixByteRequest, suffix=bound), ) key_tuple = st.tuples(keys, byte_ranges) return st.lists(key_tuple, min_size=1, max_size=10) @st.composite def complex_rectilinear_arrays( draw: st.DrawFn, *, stores: st.SearchStrategy[StoreLike] = stores, paths: st.SearchStrategy[str] = paths(), # noqa: B008 array_names: st.SearchStrategy = array_names, attrs: st.SearchStrategy = attrs, ) -> tuple[npt.NDArray[Any], AnyArray]: """Generate a rectilinear array with many small chunks. The shape is derived from the chunk edges (5-10 chunks per dim, sizes 1-5), exercising higher chunk counts than ``rectilinear_arrays``. """ ndim = draw(st.integers(min_value=1, max_value=3)) nchunks = draw(st.integers(min_value=5, max_value=10)) dim_chunks = st.lists(st.integers(min_value=1, max_value=5), min_size=nchunks, max_size=nchunks) chunk_shapes = draw(st.lists(dim_chunks, min_size=ndim, max_size=ndim)) shape = tuple(sum(dim) for dim in chunk_shapes) nparray = draw(numpy_arrays(shapes=st.just(shape))) dim_names = draw(dimension_names(ndim=ndim)) fill_value = draw(st.one_of([st.none(), npst.from_dtype(nparray.dtype)])) attributes = draw(attrs) store = draw(stores, label="store") path = draw(paths, label="array parent") name = draw(array_names, label="array name") array_path = _join_paths([path, name]) root = zarr.open_group(store, mode="w", zarr_format=3) with zarr.config.set({"array.rectilinear_chunks": True}): a = root.create_array( array_path, shape=shape, chunks=chunk_shapes, dtype=nparray.dtype, fill_value=fill_value, dimension_names=dim_names, attributes=attributes, ) a[:] = nparray return nparray, a @st.composite def chunk_paths(draw: st.DrawFn, ndim: int, numblocks: tuple[int, ...], subset: bool = True) -> str: blockidx = draw( st.tuples(*tuple(st.integers(min_value=0, max_value=max(0, b - 1)) for b in numblocks)) ) subset_slicer = slice(draw(st.integers(min_value=0, max_value=ndim))) if subset else slice(None) return "/".join(map(str, blockidx[subset_slicer])) zarr-python-3.3.0/src/zarr/testing/utils.py000066400000000000000000000021101523267620000207430ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, cast import pytest from zarr.core.buffer import Buffer if TYPE_CHECKING: from zarr.core.common import BytesLike __all__ = ["assert_bytes_equal"] def assert_bytes_equal(b1: Buffer | BytesLike | None, b2: Buffer | BytesLike | None) -> None: """Help function to assert if two bytes-like or Buffers are equal Warnings -------- Always copies data, only use for testing and debugging """ if isinstance(b1, Buffer): b1 = b1.to_bytes() if isinstance(b2, Buffer): b2 = b2.to_bytes() assert b1 == b2 def has_cupy() -> bool: try: import cupy return cast("bool", cupy.cuda.runtime.getDeviceCount() > 0) except ImportError: return False except cupy.cuda.runtime.CUDARuntimeError: return False gpu_mark = pytest.mark.gpu skip_if_no_gpu = pytest.mark.skipif(not has_cupy(), reason="CuPy not installed or no GPU available") # Decorator for GPU tests def gpu_test[T](func: T) -> T: return cast(T, gpu_mark(skip_if_no_gpu(func))) zarr-python-3.3.0/src/zarr/types.py000066400000000000000000000016231523267620000173020ustar00rootroot00000000000000from typing import Any from zarr.core.array import Array, AsyncArray from zarr.core.common import JSON, ZarrFormat from zarr.core.dtype.common import DTypeConfig_V2, DTypeJSON from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.core.metadata.v3 import ArrayV3Metadata type AnyAsyncArray = AsyncArray[Any] """A Zarr format 2 or 3 `AsyncArray`""" type AsyncArrayV2 = AsyncArray[ArrayV2Metadata] """A Zarr format 2 `AsyncArray`""" type AsyncArrayV3 = AsyncArray[ArrayV3Metadata] """A Zarr format 3 `AsyncArray`""" type AnyArray = Array[Any] """A Zarr format 2 or 3 `Array`""" type ArrayV2 = Array[ArrayV2Metadata] """A Zarr format 2 `Array`""" type ArrayV3 = Array[ArrayV3Metadata] """A Zarr format 3 `Array`""" __all__ = ( "JSON", "AnyArray", "AnyAsyncArray", "ArrayV2", "ArrayV3", "AsyncArrayV2", "AsyncArrayV3", "DTypeConfig_V2", "DTypeJSON", "ZarrFormat", ) zarr-python-3.3.0/tests/000077500000000000000000000000001523267620000151575ustar00rootroot00000000000000zarr-python-3.3.0/tests/__init__.py000066400000000000000000000000001523267620000172560ustar00rootroot00000000000000zarr-python-3.3.0/tests/benchmarks/000077500000000000000000000000001523267620000172745ustar00rootroot00000000000000zarr-python-3.3.0/tests/benchmarks/__init__.py000066400000000000000000000000001523267620000213730ustar00rootroot00000000000000zarr-python-3.3.0/tests/benchmarks/common.py000066400000000000000000000002621523267620000211360ustar00rootroot00000000000000from dataclasses import dataclass @dataclass(kw_only=True, frozen=True) class Layout: shape: tuple[int, ...] chunks: tuple[int, ...] shards: tuple[int, ...] | None zarr-python-3.3.0/tests/benchmarks/conftest.py000066400000000000000000000007441523267620000215000ustar00rootroot00000000000000"""Pytest configuration for benchmark tests.""" import pytest # Filter CodSpeed instrumentation warnings that can occur intermittently # when registering benchmark results. This is a known issue with the # CodSpeed walltime instrumentation hooks. # See: https://github.com/CodSpeedHQ/pytest-codspeed def pytest_configure(config: pytest.Config) -> None: config.addinivalue_line( "filterwarnings", "ignore:Failed to set executed benchmark:RuntimeWarning", ) zarr-python-3.3.0/tests/benchmarks/test_e2e.py000066400000000000000000000215721523267620000213670ustar00rootroot00000000000000""" Benchmarks for end-to-end read/write performance of Zarr """ from __future__ import annotations import os import platform import subprocess import warnings from functools import lru_cache from operator import getitem, setitem from typing import TYPE_CHECKING, Any, Literal import numpy as np import pytest import zarr from tests.benchmarks.common import Layout from zarr import create_array from zarr.core.config import config as zarr_config from zarr.testing.store import LatencyStore def clear_cache() -> None: """Drop the OS page cache between benchmark rounds. Requires passwordless sudo, so it is opt-in: set `ZARR_BENCHMARK_CLEAR_CACHE=1` to enable it (as the benchmark CI jobs do). By default this is a no-op, so a plain `pytest` run never prompts for a sudo password (see issue #4199). `sudo -n` guarantees we fail instead of blocking on a password prompt even when the variable is set. """ if os.environ.get("ZARR_BENCHMARK_CLEAR_CACHE", "") not in ("1", "true"): return if platform.system() == "Darwin": subprocess.call(["sync"]) subprocess.call(["sudo", "-n", "purge"]) elif platform.system() == "Linux": subprocess.call(["sudo", "-n", "sh", "-c", "sync; echo 3 > /proc/sys/vm/drop_caches"]) else: warnings.warn( f"ZARR_BENCHMARK_CLEAR_CACHE is set but cache clearing is not supported on " f"{platform.system()}; skipping.", stacklevel=2, ) if TYPE_CHECKING: from collections.abc import Callable, Iterator from types import EllipsisType from pytest_benchmark.fixture import BenchmarkFixture from zarr.abc.store import Store from zarr.core.common import NamedConfig @lru_cache def _data(shape: tuple[int]) -> np.ndarray: n = shape[0] period = 256 noise_level = 1 pattern = (np.sin(np.linspace(0, 2 * np.pi, period)) * 50 + 128).round().astype(np.uint8) data = np.tile(pattern, int(np.ceil(n / period)))[:n].astype(np.int16) rng = np.random.default_rng(0) data += rng.integers(-noise_level, noise_level + 1, size=n, dtype=np.int16) return np.clip(data, 0, 255).astype(np.uint8) CompressorName = Literal["zstd"] | None compressors: dict[CompressorName, NamedConfig[Any, Any] | None] = { None: None, # Default v3 "zstd": {"name": "zstd", "configuration": {"level": 0, "checksum": False}}, } layouts: tuple[Layout, ...] = ( # No shards, just 1000 chunks Layout(shape=(100_000_000,), chunks=(100_000,), shards=None), # 1:1 chunk:shard shape, should measure overhead of sharding Layout(shape=(100_000_000,), chunks=(100_000,), shards=(100_000,)), # One shard with all the chunks, should measure over/under-head of handling inner shard chunks Layout(shape=(100_000_000,), chunks=(100_000,), shards=(100_000 * 1_000,)), # Mixed layout balancing inner vs. outer concurrency (likely the most real-world case) Layout(shape=(1_000_000_000,), chunks=(100_000,), shards=(100_000 * 100,)), ) _PIPELINE_SETTINGS = { "batched": {"codec_pipeline.path": "zarr.core.codec_pipeline.BatchedCodecPipeline"}, "fused_full_threaded": { "codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline", "codec_pipeline.max_workers": None, }, "fused_single_threaded": { "codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline", "codec_pipeline.max_workers": 1, }, } _LATENCY_VALUES = (0, 0.03) @pytest.fixture(params=_LATENCY_VALUES, ids=lambda v: f"latency={v}") def latency(request: pytest.FixtureRequest) -> float: return request.param # type: ignore[no-any-return] @pytest.fixture def bench_store(store: Store, latency: float, request: pytest.FixtureRequest) -> Store: """Wraps the underlying store in LatencyStore when latency > 0. Local-store cases skip nonzero latency — synthetic latency on top of a real LocalStore is double-counting; latency simulation only applies to the in-process memory store. """ callspec = getattr(request.node, "callspec", None) store_kind = callspec.params.get("store", "memory") if callspec is not None else "memory" if latency > 0: if store_kind == "local": pytest.skip("latency injection only applies to in-memory store") return LatencyStore( store, get_latency=(latency, latency * 1.2), set_latency=(latency, latency * 1.2) ) if store_kind == "memory": pytest.skip("memory store doesn't offer much over local without latency") return store @pytest.fixture(params=["batched"]) # , "fused_full_threaded", "fused_single_threaded"]) def pipeline(request: pytest.FixtureRequest) -> Iterator[str]: """Set ``codec_pipeline.path`` for the duration of the benchmark. Yields the pipeline name so each parametrize cell has a distinct benchmark id. """ name = request.param with zarr_config.set(_PIPELINE_SETTINGS[name]): yield name @pytest.mark.parametrize( "get_data", [lambda shape: 1, lambda shape: _data(shape)], ids=["repeated", "semi_random"] ) @pytest.mark.parametrize("compression_name", ["zstd", None]) @pytest.mark.parametrize("layout", layouts, ids=str) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_write_array( bench_store: Store, layout: Layout, compression_name: CompressorName, pipeline: str, benchmark: BenchmarkFixture, get_data: Callable[[tuple[int]], np.ndarray | int], ) -> None: """ Test the time required to fill an array with a single value """ arr = create_array( bench_store, dtype="uint8", shape=layout.shape, chunks=layout.chunks, shards=layout.shards, compressors=compressors[compression_name], # type: ignore[arg-type] fill_value=0, ) def setup() -> tuple[tuple[zarr.Array, EllipsisType, int | np.ndarray], dict]: # type: ignore[type-arg] clear_cache() return (arr, Ellipsis, get_data(layout.shape)), {} # type: ignore[arg-type] benchmark.pedantic(setitem, setup=setup, rounds=3) # type: ignore[no-untyped-call] @pytest.mark.parametrize( "get_data", [lambda shape: 1, lambda shape: _data(shape)], ids=["repeated", "semi_random"] ) @pytest.mark.parametrize("compression_name", ["zstd", None]) @pytest.mark.parametrize("layout", layouts, ids=str) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_read_array( bench_store: Store, layout: Layout, compression_name: CompressorName, pipeline: str, benchmark: BenchmarkFixture, get_data: Callable[[tuple[int]], np.ndarray | int], ) -> None: """ Test the time required to read the entirety of an array """ arr = create_array( bench_store, dtype="uint8", shape=layout.shape, chunks=layout.chunks, shards=layout.shards, compressors=compressors[compression_name], # type: ignore[arg-type] fill_value=0, ) arr[:] = get_data(layout.shape) # type: ignore[arg-type] def setup() -> tuple[tuple[zarr.Array, EllipsisType], dict]: # type: ignore[type-arg] clear_cache() return (arr, Ellipsis), {} benchmark.pedantic(getitem, setup=setup, rounds=3) # type: ignore[no-untyped-call] _CONCURRENT_READ_THREADS = 8 _concurrent_layout = Layout(shape=(64_000_000,), chunks=(4_000_000,), shards=None) @pytest.mark.parametrize("pipeline", ["batched", "fused_full_threaded"], indirect=True) @pytest.mark.parametrize("compression_name", ["zstd", None]) @pytest.mark.parametrize("store", ["local"], indirect=["store"]) def test_read_array_concurrent( bench_store: Store, compression_name: CompressorName, pipeline: str, benchmark: BenchmarkFixture, ) -> None: """Dask-style access: several user threads each reading one chunk per call. All sync-API calls are serviced by the one global event loop, so this measures how much of each read's IO+compute the pipeline runs while holding the loop: anything inline serializes the readers. """ from concurrent.futures import ThreadPoolExecutor layout = _concurrent_layout arr = create_array( bench_store, dtype="uint8", shape=layout.shape, chunks=layout.chunks, shards=layout.shards, compressors=compressors[compression_name], # type: ignore[arg-type] fill_value=0, ) arr[:] = _data(layout.shape) selections = [ slice(start, start + layout.chunks[0]) for start in range(0, layout.shape[0], layout.chunks[0]) ] def read_all_chunks_concurrently() -> None: with ThreadPoolExecutor(max_workers=_CONCURRENT_READ_THREADS) as executor: list(executor.map(lambda sel: arr[sel], selections)) def setup() -> tuple[tuple[()], dict]: # type: ignore[type-arg] clear_cache() return (), {} benchmark.pedantic(read_all_chunks_concurrently, setup=setup, rounds=3) # type: ignore[no-untyped-call] zarr-python-3.3.0/tests/benchmarks/test_indexing.py000066400000000000000000000255341523267620000225230ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING if TYPE_CHECKING: from pytest_benchmark.fixture import BenchmarkFixture from zarr.abc.store import Store from operator import getitem import pytest from zarr import create_array indexers = ( (0,) * 3, (slice(None),) * 3, (slice(0, None, 4),) * 3, (slice(10),) * 3, (slice(10, -10, 4),) * 3, (slice(None), slice(0, 3, 2), slice(0, 10)), ) shards = ( None, (50,) * 3, ) @pytest.mark.parametrize("store", ["memory", "memory_get_latency"], indirect=["store"]) @pytest.mark.parametrize("indexer", indexers, ids=str) @pytest.mark.parametrize("shards", shards, ids=str) def test_slice_indexing( store: Store, indexer: tuple[int | slice], shards: tuple[int, ...] | None, benchmark: BenchmarkFixture, ) -> None: data = create_array( store=store, shape=(105,) * 3, dtype="uint8", chunks=(10,) * 3, shards=shards, compressors=None, filters=None, fill_value=0, ) data[:] = 1 benchmark(getitem, data, indexer) # Benchmark for Morton order optimization with power-of-2 shards # Morton order is used internally by sharding codec for chunk iteration morton_shards = ( (16,) * 3, # With 2x2x2 chunks: 8x8x8 = 512 chunks per shard (32,) * 3, # With 2x2x2 chunks: 16x16x16 = 4096 chunks per shard ) @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) @pytest.mark.parametrize("shards", morton_shards, ids=str) def test_sharded_morton_indexing( store: Store, shards: tuple[int, ...], benchmark: BenchmarkFixture, ) -> None: """Benchmark sharded array indexing with power-of-2 chunks per shard. This benchmark exercises the Morton order iteration path in the sharding codec, which benefits from the hypercube and vectorization optimizations. The Morton order cache is cleared before each iteration to measure the full computation cost. """ from zarr.core.indexing import _morton_order, morton_order_coords # Create array where each shard contains many small chunks # e.g., shards=(32,32,32) with chunks=(2,2,2) means 16x16x16 = 4096 chunks per shard shape = tuple(s * 2 for s in shards) # 2 shards per dimension chunks = (2,) * 3 # Small chunks to maximize chunks per shard data = create_array( store=store, shape=shape, dtype="uint8", chunks=chunks, shards=shards, compressors=None, filters=None, fill_value=0, ) data[:] = 1 # Read a sub-shard region to exercise Morton order iteration indexer = (slice(shards[0]),) * 3 def read_with_cache_clear() -> None: _morton_order.cache_clear() morton_order_coords.cache_clear() getitem(data, indexer) benchmark(read_with_cache_clear) # Benchmark with larger chunks_per_shard to make Morton order impact more visible large_morton_shards = ( (32,) * 3, # With 1x1x1 chunks: 32x32x32 = 32768 chunks per shard (power-of-2) (30,) * 3, # With 1x1x1 chunks: 30x30x30 = 27000 chunks per shard (non-power-of-2) (33,) * 3, # With 1x1x1 chunks: 33x33x33 = 35937 chunks per shard (near-miss: just above power-of-2) ) @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) @pytest.mark.parametrize("shards", large_morton_shards, ids=str) def test_sharded_morton_indexing_large( store: Store, shards: tuple[int, ...], benchmark: BenchmarkFixture, ) -> None: """Benchmark sharded array indexing with large chunks_per_shard. Uses 1x1x1 chunks to maximize chunks_per_shard (32^3 = 32768), making the Morton order computation a more significant portion of total time. The Morton order cache is cleared before each iteration. """ from zarr.core.indexing import _morton_order, morton_order_coords # 1x1x1 chunks means chunks_per_shard equals shard shape shape = tuple(s * 2 for s in shards) # 2 shards per dimension chunks = (1,) * 3 # 1x1x1 chunks: chunks_per_shard = shards data = create_array( store=store, shape=shape, dtype="uint8", chunks=chunks, shards=shards, compressors=None, filters=None, fill_value=0, ) data[:] = 1 # Read one full shard indexer = (slice(shards[0]),) * 3 def read_with_cache_clear() -> None: _morton_order.cache_clear() morton_order_coords.cache_clear() getitem(data, indexer) benchmark(read_with_cache_clear) @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) @pytest.mark.parametrize("shards", large_morton_shards, ids=str) def test_sharded_morton_single_chunk( store: Store, shards: tuple[int, ...], benchmark: BenchmarkFixture, ) -> None: """Benchmark reading a single chunk from a large shard. This isolates the Morton order computation overhead by minimizing I/O. Reading one chunk from a shard with 32^3 = 32768 chunks still requires computing the full Morton order, making the optimization impact clear. The Morton order cache is cleared before each iteration. """ from zarr.core.indexing import _morton_order, morton_order_coords # 1x1x1 chunks means chunks_per_shard equals shard shape shape = tuple(s * 2 for s in shards) # 2 shards per dimension chunks = (1,) * 3 # 1x1x1 chunks: chunks_per_shard = shards data = create_array( store=store, shape=shape, dtype="uint8", chunks=chunks, shards=shards, compressors=None, filters=None, fill_value=0, ) data[:] = 1 # Read only a single chunk (1x1x1) from the shard indexer = (slice(1),) * 3 def read_with_cache_clear() -> None: _morton_order.cache_clear() morton_order_coords.cache_clear() getitem(data, indexer) benchmark(read_with_cache_clear) # Benchmark for morton_order_coords directly (no I/O) morton_iter_shapes = ( (8, 8, 8), # 512 elements (power-of-2) (10, 10, 10), # 1000 elements (non-power-of-2) (16, 16, 16), # 4096 elements (power-of-2) (20, 20, 20), # 8000 elements (non-power-of-2) (32, 32, 32), # 32768 elements (power-of-2) (30, 30, 30), # 27000 elements (non-power-of-2) (33, 33, 33), # 35937 elements (near-miss: just above power-of-2, n_z=262144) ) @pytest.mark.parametrize("shape", morton_iter_shapes, ids=str) def test_morton_order( shape: tuple[int, ...], benchmark: BenchmarkFixture, ) -> None: """Benchmark morton_order_coords directly without I/O. This isolates the Morton order computation to measure the optimization impact without array read/write overhead. The cache is cleared before each iteration. """ from zarr.core.indexing import _morton_order, morton_order_coords def compute_morton_order() -> None: _morton_order.cache_clear() morton_order_coords.cache_clear() # Build the full sequence to force computation list(morton_order_coords(shape)) benchmark(compute_morton_order) @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) @pytest.mark.parametrize("shards", large_morton_shards, ids=str) def test_sharded_morton_write_single_chunk( store: Store, shards: tuple[int, ...], benchmark: BenchmarkFixture, ) -> None: """Benchmark writing a single chunk to a large shard. This is the clearest end-to-end demonstration of Morton order optimization. Writing a single chunk to a shard with 32^3 = 32768 chunks requires computing the full Morton order, but minimizes I/O overhead. Expected improvement: ~160ms (matching Morton computation speedup of ~178ms). The Morton order cache is cleared before each iteration. """ import numpy as np from zarr.core.indexing import ( _lexicographic_order, _morton_order, lexicographic_order_coords, morton_order_coords, ) # 1x1x1 chunks means chunks_per_shard equals shard shape shape = tuple(s * 2 for s in shards) # 2 shards per dimension chunks = (1,) * 3 # 1x1x1 chunks: chunks_per_shard = shards data = create_array( store=store, shape=shape, dtype="uint8", chunks=chunks, shards=shards, compressors=None, filters=None, fill_value=0, ) # Write data for a single chunk write_data = np.ones((1, 1, 1), dtype="uint8") indexer = (slice(1), slice(1), slice(1)) def write_with_cache_clear() -> None: # Clear every coordinate cache the write path touches, not just morton: # the sharded write also builds the lexicographic grid (dict.fromkeys / # to_dict_vectorized), so a partial clear would leave that path warm and # under-report the cold build cost. _morton_order.cache_clear() morton_order_coords.cache_clear() _lexicographic_order.cache_clear() lexicographic_order_coords.cache_clear() data[indexer] = write_data benchmark(write_with_cache_clear) @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) @pytest.mark.parametrize("shards", large_morton_shards, ids=str) def test_sharded_morton_write_single_chunk_warm_cache( store: Store, shards: tuple[int, ...], benchmark: BenchmarkFixture, ) -> None: """Benchmark a single-chunk shard write with the chunk-order cache warm. Unlike ``test_sharded_morton_write_single_chunk``, this does NOT clear the order cache between iterations: it warms the cache once, then repeatedly writes the same single chunk. This isolates the amortized per-write cost the cache exists to optimize — the regime where the coordinate grid was already built (by an earlier write to this shard, or to any same-shaped shard) and is reused rather than rebuilt. Repeated writes to one shard and writes spread across many same-shaped shards exercise that cache reuse identically. This is the regime the cold benchmark cannot see. A regression that rebuilds the per-shard coordinate tuples on every write (rather than reusing the cached sequence) is invisible to the cold benchmark but shows up here. """ import numpy as np from zarr.core.indexing import _morton_order, morton_order_coords shape = tuple(s * 2 for s in shards) # 2 shards per dimension chunks = (1,) * 3 # 1x1x1 chunks: chunks_per_shard = shards data = create_array( store=store, shape=shape, dtype="uint8", chunks=chunks, shards=shards, compressors=None, filters=None, fill_value=0, ) write_data = np.ones((1, 1, 1), dtype="uint8") indexer = (slice(1), slice(1), slice(1)) # Warm the cache once up front; the timed writes then hit the warm path. _morton_order.cache_clear() morton_order_coords.cache_clear() data[indexer] = write_data def write_warm() -> None: data[indexer] = write_data benchmark(write_warm) zarr-python-3.3.0/tests/conftest.py000066400000000000000000000436301523267620000173640ustar00rootroot00000000000000from __future__ import annotations import math import os import pathlib import re import sys from collections.abc import Mapping, Sequence from dataclasses import dataclass, field from typing import TYPE_CHECKING, cast import numpy as np import numpy.typing as npt import pytest from hypothesis import HealthCheck, Verbosity, settings import zarr.registry from zarr import AsyncGroup, config from zarr.abc.store import Store from zarr.codecs.sharding import IndexLocation, ShardingCodec from zarr.core.array import ( _parse_chunk_encoding_v2, _parse_chunk_encoding_v3, _parse_chunk_key_encoding, ) from zarr.core.chunk_grids import ( SHARDED_INNER_CHUNK_MAX_BYTES, as_regular_shape, guess_chunks, normalize_chunks_nd, resolve_outer_and_inner_chunks, ) from zarr.core.common import ( JSON, DimensionNamesLike, MemoryOrder, ShapeLike, ZarrFormat, parse_shapelike, ) from zarr.core.config import config as zarr_config from zarr.core.dtype import ( get_data_type_from_native_dtype, ) from zarr.core.dtype.common import HasItemSize from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.core.metadata.v3 import ArrayV3Metadata, create_chunk_grid_metadata from zarr.core.sync import sync from zarr.storage import FsspecStore, LocalStore, MemoryStore, StorePath, ZipStore from zarr.testing.store import LatencyStore if TYPE_CHECKING: from collections.abc import Generator from contextlib import AbstractContextManager from typing import Any, Literal from zarr.abc.codec import Codec from zarr.core.array import CompressorsLike, FiltersLike, SerializerLike, ShardsLike from zarr.core.chunk_key_encodings import ( ChunkKeyEncoding, ChunkKeyEncodingLike, V2ChunkKeyEncoding, ) from zarr.core.dtype.wrapper import ZDType @dataclass(frozen=True) class Expect[TIn, TOut]: """A test case with explicit input, expected output, and a human-readable id.""" input: TIn output: TOut id: str @dataclass(frozen=True) class ExpectFail[TIn]: """A test case that should raise an exception. `msg` is a regex matched against the exception text (pytest's native `match=` semantics). Leave it `None` to assert only the exception type. Set `escape=True` when `msg` is a literal that contains regex metacharacters such as `(`, `[`, or `.`; `escape` has no effect when `msg` is `None`. """ input: TIn exception: type[Exception] id: str msg: str | None = None escape: bool = False def raises(self) -> AbstractContextManager[pytest.ExceptionInfo[Exception]]: if self.msg is None: return pytest.raises(self.exception) pattern = re.escape(self.msg) if self.escape else self.msg return pytest.raises(self.exception, match=pattern) async def parse_store( store: Literal["local", "memory", "fsspec", "zip", "memory_get_latency"], path: str ) -> LocalStore | MemoryStore | FsspecStore | ZipStore | LatencyStore: if store == "local": return await LocalStore.open(path) if store == "memory": return await MemoryStore.open() if store == "fsspec": return await FsspecStore.open(url=path) if store == "zip": return await ZipStore.open(f"{path}/zarr.zip", mode="w") if store == "memory_get_latency": return LatencyStore(MemoryStore(), get_latency=0.0001, set_latency=0.0) raise AssertionError @pytest.fixture(params=[str, pathlib.Path]) def path_type(request: pytest.FixtureRequest) -> Any: return request.param # todo: harmonize this with local_store fixture @pytest.fixture async def store_path(tmp_path: pathlib.Path) -> StorePath: store = await LocalStore.open(str(tmp_path)) return StorePath(store) @pytest.fixture async def local_store(tmp_path: pathlib.Path) -> LocalStore: return await LocalStore.open(str(tmp_path)) @pytest.fixture async def remote_store(url: str) -> FsspecStore: return await FsspecStore.open(url) @pytest.fixture async def memory_store() -> MemoryStore: return await MemoryStore.open() @pytest.fixture async def zip_store(tmp_path: pathlib.Path) -> ZipStore: return await ZipStore.open(str(tmp_path / "zarr.zip"), mode="w") @pytest.fixture async def store(request: pytest.FixtureRequest, tmp_path: pathlib.Path) -> Store: param = request.param return await parse_store(param, str(tmp_path)) @pytest.fixture async def store2(request: pytest.FixtureRequest, tmp_path: pathlib.Path) -> Store: """Fixture to create a second store for testing copy operations between stores""" param = request.param store2_path = tmp_path / "store2" store2_path.mkdir() return await parse_store(param, str(store2_path)) @pytest.fixture(params=["local", "memory", "zip"]) def sync_store(request: pytest.FixtureRequest, tmp_path: pathlib.Path) -> Store: result = sync(parse_store(request.param, str(tmp_path))) if not isinstance(result, Store): raise TypeError(f"Wrong store class returned by test fixture! got {result} instead") return result @dataclass class AsyncGroupRequest: zarr_format: ZarrFormat store: Literal["local", "fsspec", "memory", "zip"] attributes: dict[str, Any] = field(default_factory=dict) @pytest.fixture async def async_group(request: pytest.FixtureRequest, tmp_path: pathlib.Path) -> AsyncGroup: param: AsyncGroupRequest = request.param store = await parse_store(param.store, str(tmp_path)) return await AsyncGroup.from_store( store, attributes=param.attributes, zarr_format=param.zarr_format, overwrite=False, ) @pytest.fixture(params=["numpy", "cupy"]) def xp(request: pytest.FixtureRequest) -> Any: """Fixture to parametrize over numpy-like libraries""" if request.param == "cupy": request.node.add_marker(pytest.mark.gpu) return pytest.importorskip(request.param) @pytest.fixture(autouse=True) def reset_config() -> Generator[None, None, None]: config.reset() yield config.reset() @dataclass class ArrayRequest: shape: tuple[int, ...] dtype: str order: MemoryOrder @pytest.fixture def array_fixture(request: pytest.FixtureRequest) -> npt.NDArray[Any]: array_request: ArrayRequest = request.param return ( np.arange(np.prod(array_request.shape)) .reshape(array_request.shape, order=array_request.order) .astype(array_request.dtype) ) @pytest.fixture(params=(2, 3), ids=["zarr2", "zarr3"]) def zarr_format(request: pytest.FixtureRequest) -> ZarrFormat: if request.param == 2: return 2 elif request.param == 3: return 3 msg = f"Invalid zarr format requested. Got {request.param}, expected on of (2,3)." raise ValueError(msg) def _clear_registries() -> None: registries = zarr.registry._collect_entrypoints() for registry in registries: registry.lazy_load_list.clear() @pytest.fixture def set_path() -> Generator[None, None, None]: tests_dir = str(pathlib.Path(__file__).parent.absolute()) sys.path.append(tests_dir) _clear_registries() zarr.registry._collect_entrypoints() yield sys.path.remove(tests_dir) _clear_registries() zarr.registry._collect_entrypoints() config.reset() def pytest_addoption(parser: Any) -> None: parser.addoption( "--run-slow-hypothesis", action="store_true", default=False, help="run slow hypothesis tests", ) def pytest_collection_modifyitems(config: Any, items: Any) -> None: if config.getoption("--run-slow-hypothesis"): return skip_slow_hyp = pytest.mark.skip(reason="need --run-slow-hypothesis option to run") for item in items: if "slow_hypothesis" in item.keywords: item.add_marker(skip_slow_hyp) settings.register_profile( "default", parent=settings.get_profile("default"), max_examples=300, suppress_health_check=[HealthCheck.filter_too_much, HealthCheck.too_slow], deadline=None, verbosity=Verbosity.verbose, ) settings.register_profile( "ci", parent=settings.get_profile("ci"), max_examples=300, derandomize=True, # more like regression testing deadline=None, suppress_health_check=[HealthCheck.filter_too_much, HealthCheck.too_slow], ) settings.register_profile( "nightly", max_examples=500, parent=settings.get_profile("ci"), derandomize=False, stateful_step_count=100, ) settings.load_profile(os.getenv("HYPOTHESIS_PROFILE", "default")) # TODO: uncomment these overrides when we can get mypy to accept them """ @overload def create_array_metadata( *, shape: ShapeLike, dtype: npt.DTypeLike, chunks: tuple[int, ...] | Literal["auto"], shards: None, filters: FiltersLike, compressors: CompressorsLike, serializer: SerializerLike, fill_value: Any | None, order: MemoryOrder | None, zarr_format: Literal[2], attributes: dict[str, JSON] | None, chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None, dimension_names: None, ) -> ArrayV2Metadata: ... @overload def create_array_metadata( *, shape: ShapeLike, dtype: npt.DTypeLike, chunks: tuple[int, ...] | Literal["auto"], shards: ShardsLike | None, filters: FiltersLike, compressors: CompressorsLike, serializer: SerializerLike, fill_value: Any | None, order: None, zarr_format: Literal[3], attributes: dict[str, JSON] | None, chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None, dimension_names: Iterable[str] | None, ) -> ArrayV3Metadata: ... """ def create_array_metadata( *, shape: ShapeLike, dtype: npt.DTypeLike, chunks: tuple[int, ...] | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", serializer: SerializerLike = "auto", fill_value: Any = 0, order: MemoryOrder | None = None, zarr_format: ZarrFormat, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, ) -> ArrayV2Metadata | ArrayV3Metadata: """ Create array metadata """ dtype_parsed = get_data_type_from_native_dtype(dtype) shape_parsed = parse_shapelike(shape) chunk_key_encoding_parsed = _parse_chunk_key_encoding( chunk_key_encoding, zarr_format=zarr_format ) item_size = 1 if isinstance(dtype_parsed, HasItemSize): item_size = dtype_parsed.item_size if chunks == "auto": chunks_normalized = guess_chunks( shape_parsed, item_size, max_bytes=SHARDED_INNER_CHUNK_MAX_BYTES if shards is not None else None, ) else: chunks_normalized = normalize_chunks_nd(chunks, shape_parsed) outer_chunks, inner = resolve_outer_and_inner_chunks( array_shape=shape_parsed, chunks=chunks_normalized, shard_shape=shards, item_size=item_size, ) if order is None: order_parsed = zarr_config.get("array.order") else: order_parsed = order if zarr_format == 2: filters_parsed, compressor_parsed = _parse_chunk_encoding_v2( compressor=compressors, filters=filters, dtype=dtype_parsed ) chunk_key_encoding_parsed = cast("V2ChunkKeyEncoding", chunk_key_encoding_parsed) return ArrayV2Metadata( shape=shape_parsed, dtype=dtype_parsed, chunks=as_regular_shape(outer_chunks), order=order_parsed, dimension_separator=chunk_key_encoding_parsed.separator, fill_value=fill_value, compressor=compressor_parsed, filters=filters_parsed, attributes=attributes, ) elif zarr_format == 3: array_array, array_bytes, bytes_bytes = _parse_chunk_encoding_v3( compressors=compressors, filters=filters, serializer=serializer, dtype=dtype_parsed, ) sub_codecs: tuple[Codec, ...] = (*array_array, array_bytes, *bytes_bytes) codecs_out: tuple[Codec, ...] if inner is not None: inner_chunks_flat = as_regular_shape(inner.outer_chunks) index_location: IndexLocation = "end" if isinstance(shards, dict): index_location = cast("IndexLocation", shards.get("index_location", "end")) sharding_codec = ShardingCodec( chunk_shape=inner_chunks_flat, codecs=sub_codecs, index_location=index_location, ) validation_grid = create_chunk_grid_metadata(outer_chunks) sharding_codec.validate( shape=inner_chunks_flat, dtype=dtype_parsed, chunk_grid=validation_grid, ) codecs_out = (sharding_codec,) else: codecs_out = sub_codecs return ArrayV3Metadata( shape=shape_parsed, data_type=dtype_parsed, chunk_grid=create_chunk_grid_metadata(outer_chunks), chunk_key_encoding=chunk_key_encoding_parsed, fill_value=fill_value, codecs=codecs_out, attributes=attributes, dimension_names=dimension_names, ) raise ValueError(f"Invalid Zarr format: {zarr_format}") # TODO: uncomment these overrides when we can get mypy to accept them """ @overload def meta_from_array( array: np.ndarray[Any, Any], chunks: tuple[int, ...] | Literal["auto"], shards: None, filters: FiltersLike, compressors: CompressorsLike, serializer: SerializerLike, fill_value: Any | None, order: MemoryOrder | None, zarr_format: Literal[2], attributes: dict[str, JSON] | None, chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None, dimension_names: Iterable[str] | None, ) -> ArrayV2Metadata: ... @overload def meta_from_array( array: np.ndarray[Any, Any], chunks: tuple[int, ...] | Literal["auto"], shards: ShardsLike | None, filters: FiltersLike, compressors: CompressorsLike, serializer: SerializerLike, fill_value: Any | None, order: None, zarr_format: Literal[3], attributes: dict[str, JSON] | None, chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None, dimension_names: Iterable[str] | None, ) -> ArrayV3Metadata: ... """ def meta_from_array( array: np.ndarray[Any, Any], *, chunks: tuple[int, ...] | Literal["auto"] = "auto", shards: ShardsLike | None = None, filters: FiltersLike = "auto", compressors: CompressorsLike = "auto", serializer: SerializerLike = "auto", fill_value: Any = 0, order: MemoryOrder | None = None, zarr_format: ZarrFormat = 3, attributes: dict[str, JSON] | None = None, chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None = None, dimension_names: DimensionNamesLike = None, ) -> ArrayV3Metadata | ArrayV2Metadata: """ Create array metadata from an array """ return create_array_metadata( shape=array.shape, dtype=array.dtype, chunks=chunks, shards=shards, filters=filters, compressors=compressors, serializer=serializer, fill_value=fill_value, order=order, zarr_format=zarr_format, attributes=attributes, chunk_key_encoding=chunk_key_encoding, dimension_names=dimension_names, ) def skip_object_dtype(dtype: ZDType[Any, Any]) -> None: if dtype.dtype_cls is type(np.dtype("O")): msg = ( f"{dtype} uses the numpy object data type, which is not a valid target for data " "type resolution" ) pytest.skip(msg) def nan_equal(a: object, b: object) -> bool: """ Convenience function for equality comparison between two values ``a`` and ``b``, that might both be NaN. Returns True if both ``a`` and ``b`` are NaN, otherwise returns a == b """ if math.isnan(a) and math.isnan(b): # type: ignore[arg-type] return True return a == b def deep_nan_equal(a: object, b: object) -> bool: if isinstance(a, Mapping) and isinstance(b, Mapping): return all(deep_nan_equal(a[k], b[k]) for k in a) if isinstance(a, Sequence) and isinstance(b, Sequence): return all(deep_nan_equal(a[i], b[i]) for i in range(len(a))) return nan_equal(a, b) # Shared mock-S3 (moto) backend. A single server is reused across the whole test session by # every test that needs S3 -- both the fsspec store tests and the documentation examples -- # instead of each module standing up its own. Consumers create their own buckets and choose # how the endpoint reaches the client (explicit storage_options vs. the AWS_ENDPOINT_URL # env var) on top of this fixture. @pytest.fixture(scope="session") def moto_server() -> Generator[str, None, None]: """Start a session-scoped moto S3 server and yield its endpoint URL. The server binds an ephemeral port (port=0), so the endpoint is only known at runtime; consumers must take it from this fixture rather than a constant. A fixed port deadlocks under pytest-xdist: session-scoped fixtures run once per *worker*, so concurrent workers race to bind the same port, and the losers block forever inside ThreadedMotoServer.start(), whose server thread dies on "Address already in use" before ever setting the ready event that start() waits on. importorskip lives inside the fixture so moto is only required when a test actually requests an S3 backend, not for the whole test session.""" moto_server_mod = pytest.importorskip("moto.moto_server.threaded_moto_server") server = moto_server_mod.ThreadedMotoServer(ip_address="127.0.0.1", port=0) server.start() host, port = server.get_host_and_port() # moto needs *some* credentials present; use throwaway values if the environment has none. os.environ.setdefault("AWS_SECRET_ACCESS_KEY", "foo") os.environ.setdefault("AWS_ACCESS_KEY_ID", "foo") try: yield f"http://{host}:{port}/" finally: server.stop() zarr-python-3.3.0/tests/package_with_entrypoint-0.1.dist-info/000077500000000000000000000000001523267620000242675ustar00rootroot00000000000000zarr-python-3.3.0/tests/package_with_entrypoint-0.1.dist-info/entry_points.txt000066400000000000000000000012371523267620000275700ustar00rootroot00000000000000[zarr.codecs] test = package_with_entrypoint:TestEntrypointCodec [zarr.codecs.test] another_codec = package_with_entrypoint:TestEntrypointGroup.Codec [zarr] codec_pipeline = package_with_entrypoint:TestEntrypointCodecPipeline ndbuffer = package_with_entrypoint:TestEntrypointNDBuffer buffer = package_with_entrypoint:TestEntrypointBuffer [zarr.buffer] another_buffer = package_with_entrypoint:TestEntrypointGroup.Buffer [zarr.ndbuffer] another_ndbuffer = package_with_entrypoint:TestEntrypointGroup.NDBuffer [zarr.codec_pipeline] another_pipeline = package_with_entrypoint:TestEntrypointGroup.Pipeline [zarr.data_type] new_data_type = package_with_entrypoint:TestDataTypezarr-python-3.3.0/tests/package_with_entrypoint/000077500000000000000000000000001523267620000221005ustar00rootroot00000000000000zarr-python-3.3.0/tests/package_with_entrypoint/__init__.py000066400000000000000000000054671523267620000242250ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING import numpy as np import numpy.typing as npt import zarr.core.buffer from zarr.abc.codec import ArrayBytesCodec, CodecInput, CodecPipeline from zarr.codecs import BytesCodec from zarr.core.buffer import Buffer, NDBuffer from zarr.core.dtype.npy.bool import Bool from zarr.errors import DataTypeValidationError if TYPE_CHECKING: from collections.abc import Iterable from typing import Any, ClassVar, Literal, Self from zarr.core.array_spec import ArraySpec from zarr.core.common import ZarrFormat from zarr.core.dtype.common import DTypeJSON, DTypeSpec_V2 class TestEntrypointCodec(ArrayBytesCodec): is_fixed_size = True async def encode( self, chunks_and_specs: Iterable[tuple[CodecInput | None, ArraySpec]], ) -> Iterable[Buffer | None]: return [None] async def decode( self, chunks_and_specs: Iterable[tuple[CodecInput | None, ArraySpec]], ) -> npt.NDArray[Any]: return np.array(1) def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: return input_byte_length class TestEntrypointCodecPipeline(CodecPipeline): def __init__(self, batch_size: int = 1) -> None: pass async def encode( self, chunks_and_specs: Iterable[tuple[CodecInput | None, ArraySpec]] ) -> Iterable[Buffer | None]: return [None] async def decode( self, chunks_and_specs: Iterable[tuple[CodecInput | None, ArraySpec]] ) -> Iterable[NDBuffer | None]: return np.array(1) class TestEntrypointBuffer(Buffer): pass class TestEntrypointNDBuffer(NDBuffer): pass class TestEntrypointGroup: class Codec(BytesCodec): pass class Buffer(zarr.core.buffer.Buffer): pass class NDBuffer(zarr.core.buffer.NDBuffer): pass class Pipeline(CodecPipeline): pass class TestDataType(Bool): """ This is a "data type" that serializes to "test" """ _zarr_v3_name: ClassVar[Literal["test"]] = "test" # type: ignore[assignment] @classmethod def from_json(cls, data: DTypeJSON, *, zarr_format: ZarrFormat) -> Self: if zarr_format == 2 and data == {"name": cls._zarr_v3_name, "object_codec_id": None}: return cls() if zarr_format == 3 and data == cls._zarr_v3_name: return cls() raise DataTypeValidationError( f"Invalid JSON representation of {cls.__name__}. Got {data!r}" ) def to_json(self, zarr_format: ZarrFormat) -> str | DTypeSpec_V2: # type: ignore[override] if zarr_format == 2: return {"name": self._zarr_v3_name, "object_codec_id": None} if zarr_format == 3: return self._zarr_v3_name raise ValueError("zarr_format must be 2 or 3") zarr-python-3.3.0/tests/test_abc/000077500000000000000000000000001523267620000167435ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_abc/__init__.py000066400000000000000000000000001523267620000210420ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_abc/test_codec.py000066400000000000000000000005221523267620000214300ustar00rootroot00000000000000from __future__ import annotations from zarr.abc.codec import _check_codecjson_v2 def test_check_codecjson_v2_valid() -> None: """ Test that the _check_codecjson_v2 function works """ assert _check_codecjson_v2({"id": "gzip"}) assert not _check_codecjson_v2({"id": 10}) assert not _check_codecjson_v2([10, 11]) zarr-python-3.3.0/tests/test_api.py000066400000000000000000001567141523267620000173570ustar00rootroot00000000000000from __future__ import annotations import inspect import re from typing import TYPE_CHECKING, Any import zarr.codecs import zarr.storage from zarr.core.array import AsyncArray, init_array from zarr.storage import LocalStore, ZipStore from zarr.storage._common import StorePath if TYPE_CHECKING: from collections.abc import Callable from pathlib import Path from zarr.abc.store import Store from zarr.core.common import JSON, MemoryOrder, ZarrFormat from zarr.types import AnyArray import contextlib from typing import Literal import numpy as np import pytest from numpy.testing import assert_array_equal import zarr import zarr.api.asynchronous import zarr.api.synchronous import zarr.core.group from zarr import Array, Group from zarr.api.synchronous import ( create, create_array, create_group, from_array, group, load, open_group, save, save_array, save_group, ) from zarr.core.buffer import NDArrayLike from zarr.errors import ( ArrayNotFoundError, MetadataValidationError, ZarrDeprecationWarning, ZarrUserWarning, ) from zarr.storage import MemoryStore from zarr.storage._utils import normalize_path from zarr.testing.utils import gpu_test def test_create(memory_store: Store) -> None: store = memory_store # create array z = create(shape=100, store=store) assert isinstance(z, Array) assert z.shape == (100,) # create array, overwrite, specify chunk shape z = create(shape=200, chunk_shape=20, store=store, overwrite=True) assert isinstance(z, Array) assert z.shape == (200,) assert z.chunks == (20,) # create array, overwrite, specify chunk shape via chunks param z = create(shape=400, chunks=40, store=store, overwrite=True) assert isinstance(z, Array) assert z.shape == (400,) assert z.chunks == (40,) # create array with float shape with pytest.raises(TypeError, match="Expected an iterable of integers"): z = create(shape=(400.5, 100), store=store, overwrite=True) # type: ignore[arg-type] # create array with float chunk shape with pytest.raises(TypeError, match="'float' object is not iterable"): z = create(shape=(400, 100), chunks=(16, 16.5), store=store, overwrite=True) # type: ignore[arg-type] @pytest.mark.parametrize( "func", [ zarr.api.asynchronous.zeros_like, zarr.api.asynchronous.ones_like, zarr.api.asynchronous.empty_like, zarr.api.asynchronous.full_like, zarr.api.asynchronous.open_like, ], ) @pytest.mark.parametrize("out_shape", ["keep", (10, 10)]) @pytest.mark.parametrize("out_chunks", ["keep", (10, 10)]) @pytest.mark.parametrize("out_dtype", ["keep", "int8"]) @pytest.mark.parametrize("out_fill", ["keep", 4]) async def test_array_like_creation( zarr_format: ZarrFormat, func: Callable[[Any], Any], out_shape: Literal["keep"] | tuple[int, ...], out_chunks: Literal["keep"] | tuple[int, ...], out_dtype: str, out_fill: Literal["keep"] | int, ) -> None: """ Test zeros_like, ones_like, empty_like, full_like, ensuring that we can override the shape, chunks, dtype and fill_value of the array-like object provided to these functions with appropriate keyword arguments """ ref_fill = 100 ref_arr = zarr.create_array( store={}, shape=(11, 12), dtype="uint8", chunks=(11, 12), zarr_format=zarr_format, fill_value=ref_fill, ) kwargs: dict[str, object] = {} if func is zarr.api.asynchronous.full_like: if out_fill == "keep": expect_fill = ref_fill else: expect_fill = out_fill kwargs["fill_value"] = expect_fill elif func is zarr.api.asynchronous.zeros_like: expect_fill = 0 elif func is zarr.api.asynchronous.ones_like: expect_fill = 1 elif func is zarr.api.asynchronous.empty_like: if out_fill == "keep": expect_fill = ref_fill else: kwargs["fill_value"] = out_fill expect_fill = out_fill elif func is zarr.api.asynchronous.open_like: # type: ignore[comparison-overlap] if out_fill == "keep": # type: ignore[unreachable] expect_fill = ref_fill else: kwargs["fill_value"] = out_fill expect_fill = out_fill kwargs["mode"] = "w" else: raise AssertionError if out_shape != "keep": kwargs["shape"] = out_shape expect_shape = out_shape else: expect_shape = ref_arr.shape if out_chunks != "keep": kwargs["chunks"] = out_chunks expect_chunks = out_chunks else: expect_chunks = ref_arr.chunks if out_dtype != "keep": kwargs["dtype"] = out_dtype expect_dtype = out_dtype else: expect_dtype = ref_arr.dtype # type: ignore[assignment] new_arr = await func(ref_arr, path="foo", zarr_format=zarr_format, **kwargs) assert new_arr.shape == expect_shape assert new_arr.chunks == expect_chunks assert new_arr.dtype == expect_dtype assert np.all(Array(new_arr)[:] == expect_fill) @pytest.mark.parametrize("mode_kwargs", [{}, {"mode": None}]) async def test_open_like_creates_array_by_default( zarr_format: ZarrFormat, mode_kwargs: dict[str, None] ) -> None: ref_arr = zarr.create_array( store={}, shape=(11, 12), dtype="uint8", chunks=(11, 12), zarr_format=zarr_format, fill_value=100, ) new_arr = await zarr.api.asynchronous.open_like( ref_arr, path="foo", store={}, zarr_format=zarr_format, **mode_kwargs, ) assert new_arr.shape == ref_arr.shape assert new_arr.chunks == ref_arr.chunks assert new_arr.dtype == ref_arr.dtype assert np.all(Array(new_arr)[:] == ref_arr.fill_value) async def test_open_like_default_mode_rejects_read_only_store( zarr_format: ZarrFormat, ) -> None: ref_arr = zarr.create_array( store={}, shape=(11, 12), dtype="uint8", chunks=(11, 12), zarr_format=zarr_format, ) with pytest.raises(ValueError, match="Store is read-only but mode is 'a'"): await zarr.api.asynchronous.open_like( ref_arr, path="foo", store=MemoryStore(read_only=True), zarr_format=zarr_format, ) # TODO: parametrize over everything this function takes @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_create_array(store: Store, zarr_format: ZarrFormat) -> None: attrs: dict[str, JSON] = {"foo": 100} # explicit type annotation to avoid mypy error shape = (10, 10) path = "foo" data_val = 1 array_w = create_array( store, name=path, shape=shape, attributes=attrs, chunks=shape, dtype="uint8", zarr_format=zarr_format, ) array_w[:] = data_val assert array_w.shape == shape assert array_w.attrs == attrs assert np.array_equal(array_w[:], np.zeros(shape, dtype=array_w.dtype) + data_val) # type: ignore[unreachable] @pytest.mark.parametrize("write_empty_chunks", [True, False]) def test_write_empty_chunks_warns(write_empty_chunks: bool, zarr_format: ZarrFormat) -> None: """ Test that using the `write_empty_chunks` kwarg on array access will raise a warning. """ match = "The `write_empty_chunks` keyword argument .*" with pytest.warns(RuntimeWarning, match=match): _ = zarr.array( data=np.arange(10), shape=(10,), dtype="uint8", write_empty_chunks=write_empty_chunks, zarr_format=zarr_format, ) with pytest.warns(RuntimeWarning, match=match): _ = zarr.create( shape=(10,), dtype="uint8", write_empty_chunks=write_empty_chunks, zarr_format=zarr_format, ) @pytest.mark.parametrize("zarr_format", [2, 3]) def test_open_array_respects_write_empty_chunks_config(zarr_format: ZarrFormat) -> None: """Test that zarr.open() respects write_empty_chunks config.""" store = MemoryStore() _ = zarr.create( store=store, path="test_array", shape=(10,), chunks=(5,), dtype="f8", fill_value=0.0, zarr_format=zarr_format, ) arr2 = zarr.open(store=store, path="test_array", config={"write_empty_chunks": True}) assert isinstance(arr2, zarr.Array) assert arr2.async_array.config.write_empty_chunks is True arr2[0:5] = np.zeros(5) assert arr2.nchunks_initialized == 1 @pytest.mark.parametrize("path", ["foo", "/", "/foo", "///foo/bar"]) @pytest.mark.parametrize("node_type", ["array", "group"]) def test_open_normalized_path( memory_store: MemoryStore, path: str, node_type: Literal["array", "group"] ) -> None: node: Group | AnyArray if node_type == "group": node = group(store=memory_store, path=path) elif node_type == "array": node = create(store=memory_store, path=path, shape=(2,)) assert node.path == normalize_path(path) async def test_open_array(memory_store: MemoryStore, zarr_format: ZarrFormat) -> None: store = memory_store # open array, create if doesn't exist z = zarr.api.synchronous.open(store=store, shape=100, zarr_format=zarr_format) assert isinstance(z, Array) assert z.shape == (100,) # open array, overwrite # store._store_dict = {} store = MemoryStore() z = zarr.api.synchronous.open(store=store, shape=200, zarr_format=zarr_format) assert isinstance(z, Array) assert z.shape == (200,) # open array, read-only store_cls = type(store) ro_store = await store_cls.open(store_dict=store._store_dict, read_only=True) z = zarr.api.synchronous.open(store=ro_store, mode="r") assert isinstance(z, Array) assert z.shape == (200,) assert z.read_only # path not found with pytest.raises(FileNotFoundError): zarr.api.synchronous.open(store="doesnotexist", mode="r", zarr_format=zarr_format) def test_open_array_rectilinear_chunks(tmp_path: Path) -> None: """zarr.open with rectilinear (dask-style) chunks preserves the chunk grid.""" from zarr.core.metadata.v3 import RectilinearChunkGridMetadata chunks = ((3, 3, 4), (5, 5)) with zarr.config.set({"array.rectilinear_chunks": True}): z = zarr.open(store=tmp_path, shape=(10, 10), dtype="float64", chunks=chunks, mode="w") assert isinstance(z, Array) assert z.shape == (10, 10) assert isinstance(z.metadata.chunk_grid, RectilinearChunkGridMetadata) assert z.read_chunk_sizes == ((3, 3, 4), (5, 5)) async def test_async_array_open_array_not_found() -> None: """Test that AsyncArray.open raises ArrayNotFoundError when array doesn't exist""" store = MemoryStore() # Try to open an array that does not exist with pytest.raises(ArrayNotFoundError): await AsyncArray.open(store, zarr_format=2) def test_array_open_array_not_found_sync() -> None: """Test that Array.open raises ArrayNotFoundError when array doesn't exist""" store = MemoryStore() # Try to open an array that does not exist with pytest.raises(ArrayNotFoundError): Array.open(store) @pytest.mark.parametrize("store", ["memory", "local", "zip"], indirect=True) def test_v2_and_v3_exist_at_same_path(store: Store) -> None: zarr.create_array(store, shape=(10,), dtype="uint8", zarr_format=3) zarr.create_array(store, shape=(10,), dtype="uint8", zarr_format=2) msg = f"Both zarr.json (Zarr format 3) and .zarray (Zarr format 2) metadata objects exist at {store}. Zarr v3 will be used." with pytest.warns(ZarrUserWarning, match=re.escape(msg)): zarr.open(store=store) @pytest.mark.parametrize("store", ["memory"], indirect=True) async def test_create_group(store: Store, zarr_format: ZarrFormat) -> None: attrs = {"foo": 100} path = "node" node = create_group(store, path=path, attributes=attrs, zarr_format=zarr_format) assert isinstance(node, Group) assert node.attrs == attrs assert node.metadata.zarr_format == zarr_format # type: ignore[unreachable] async def test_open_group(memory_store: MemoryStore) -> None: store = memory_store # open group, create if doesn't exist g = open_group(store=store) g.create_group("foo") assert isinstance(g, Group) assert "foo" in g # open group, overwrite g = open_group(store=store, mode="w") assert isinstance(g, Group) assert "foo" not in g # open group, read-only store_cls = type(store) ro_store = await store_cls.open(store_dict=store._store_dict, read_only=True) g = open_group(store=ro_store, mode="r") assert isinstance(g, Group) assert g.read_only @pytest.mark.parametrize("zarr_format", [None, 2, 3]) async def test_open_group_unspecified_version(tmp_path: Path, zarr_format: ZarrFormat) -> None: """Regression test for https://github.com/zarr-developers/zarr-python/issues/2175""" # create a group with specified zarr format (could be 2, 3, or None) _ = await zarr.api.asynchronous.open_group( store=str(tmp_path), mode="w", zarr_format=zarr_format, attributes={"foo": "bar"} ) # now open that group without specifying the format g2 = await zarr.api.asynchronous.open_group(store=str(tmp_path), mode="r") assert g2.attrs == {"foo": "bar"} if zarr_format is not None: assert g2.metadata.zarr_format == zarr_format @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("n_args", [10, 1, 0]) @pytest.mark.parametrize("n_kwargs", [10, 1, 0]) @pytest.mark.parametrize("path", [None, "some_path"]) def test_save(store: Store, n_args: int, n_kwargs: int, path: None | str) -> None: data = np.arange(10) args = [np.arange(10) for _ in range(n_args)] kwargs = {f"arg_{i}": data for i in range(n_kwargs)} if n_kwargs == 0 and n_args == 0: with pytest.raises(ValueError, match="at least one array must be provided"): save(store, path=path) elif n_args == 1 and n_kwargs == 0: save(store, *args, path=path) array = zarr.api.synchronous.open(store, path=path) assert isinstance(array, Array) assert_array_equal(array[:], data) else: save(store, *args, path=path, **kwargs) # type: ignore[arg-type] group = zarr.api.synchronous.open(store, path=path) assert isinstance(group, Group) for array in group.array_values(): assert_array_equal(array[:], data) for k in kwargs: assert k in group assert group.nmembers() == n_args + n_kwargs @pytest.mark.parametrize( "data", [ np.array(42, dtype=np.int64), np.array("teststr", dtype=np.bytes_), ], ) @pytest.mark.filterwarnings("ignore::zarr.errors.UnstableSpecificationWarning") def test_group_setitem_loads_scalar_arrays(sync_store: Store, data: np.ndarray) -> None: root = zarr.open_group(store=sync_store) root["test"] = data assert_array_equal(root["test"][...], data) assert_array_equal(zarr.load(store=sync_store, path="test"), data) def test_save_errors() -> None: with pytest.raises(ValueError, match="at least one array must be provided"): # no arrays provided save_group("data/group.zarr") with pytest.raises(TypeError, match="missing 1 required positional argument: 'arr'"): # no array provided save_array("data/group.zarr") # type: ignore[call-arg] with pytest.raises(ValueError, match="at least one array must be provided"): # no arrays provided save("data/group.zarr") a = np.arange(10) with pytest.raises( TypeError, match="Keyword argument 'mode' must be a numpy or other NDArrayLike array" ): # mode is no valid argument and would get handled as an array zarr.save("data/example.zarr", a, mode="w") def test_open_with_mode_r(tmp_path: Path) -> None: # 'r' means read only (must exist) with pytest.raises(FileNotFoundError): zarr.open(store=tmp_path, mode="r") z1 = zarr.ones(store=tmp_path, shape=(3, 3)) assert z1.fill_value == 1 z2 = zarr.open(store=tmp_path, mode="r") assert isinstance(z2, Array) assert z2.fill_value == 1 result = z2[:] assert isinstance(result, NDArrayLike) assert (result == 1).all() with pytest.raises(ValueError): z2[:] = 3 def test_open_with_mode_r_plus(tmp_path: Path) -> None: # 'r+' means read/write (must exist) new_store_path = tmp_path / "new_store.zarr" assert not new_store_path.exists(), "Test should operate on non-existent directory" with pytest.raises(FileNotFoundError): zarr.open(store=new_store_path, mode="r+") assert not new_store_path.exists(), "mode='r+' should not create directory" zarr.ones(store=tmp_path, shape=(3, 3)) z2 = zarr.open(store=tmp_path, mode="r+") assert isinstance(z2, Array) result = z2[:] assert isinstance(result, NDArrayLike) assert (result == 1).all() z2[:] = 3 async def test_open_with_mode_a(tmp_path: Path) -> None: # Open without shape argument should default to group g = zarr.open(store=tmp_path, mode="a") assert isinstance(g, Group) await g.store_path.delete() # 'a' means read/write (create if doesn't exist) arr = zarr.open(store=tmp_path, mode="a", shape=(3, 3)) assert isinstance(arr, Array) arr[...] = 1 z2 = zarr.open(store=tmp_path, mode="a") assert isinstance(z2, Array) result = z2[:] assert isinstance(result, NDArrayLike) assert (result == 1).all() z2[:] = 3 def test_open_with_mode_w(tmp_path: Path) -> None: # 'w' means create (overwrite if exists); arr = zarr.open(store=tmp_path, mode="w", shape=(3, 3)) assert isinstance(arr, Array) arr[...] = 3 z2 = zarr.open(store=tmp_path, mode="w", shape=(3, 3)) assert isinstance(z2, Array) result = z2[:] assert isinstance(result, NDArrayLike) assert not (result == 3).all() z2[:] = 3 def test_open_with_mode_w_minus(tmp_path: Path) -> None: # 'w-' means create (fail if exists) arr = zarr.open(store=tmp_path, mode="w-", shape=(3, 3)) assert isinstance(arr, Array) arr[...] = 1 with pytest.raises(FileExistsError): zarr.open(store=tmp_path, mode="w-") @pytest.mark.parametrize("order", ["C", "F", None]) @pytest.mark.parametrize("config", [{"order": "C"}, {"order": "F"}, {}], ids=["C", "F", "None"]) def test_array_order( order: MemoryOrder | None, config: dict[str, MemoryOrder | None], zarr_format: ZarrFormat ) -> None: """ Check that: - For v2, memory order is taken from the `order` keyword argument. - For v3, memory order is taken from `config`, and when order is passed a warning is raised - The numpy array returned has the expected order - For v2, the order metadata is set correctly """ default_order = zarr.config.get("array.order") ctx: contextlib.AbstractContextManager # type: ignore[type-arg] if zarr_format == 3: if order is None: ctx = contextlib.nullcontext() else: ctx = pytest.warns( RuntimeWarning, match="The `order` keyword argument has no effect for Zarr format 3 arrays", ) expected_order = config.get("order", default_order) if zarr_format == 2: ctx = contextlib.nullcontext() expected_order = order or config.get("order", default_order) with ctx: arr = zarr.ones(shape=(2, 2), order=order, zarr_format=zarr_format, config=config) assert arr.order == expected_order vals = np.asarray(arr) if expected_order == "C": assert vals.flags.c_contiguous elif expected_order == "F": assert vals.flags.f_contiguous else: raise AssertionError if zarr_format == 2: assert arr.metadata.zarr_format == 2 assert arr.metadata.order == expected_order async def test_init_order_warns() -> None: with pytest.warns( RuntimeWarning, match="The `order` keyword argument has no effect for Zarr format 3 arrays" ): await init_array( store_path=StorePath(store=MemoryStore()), shape=(1,), dtype="uint8", zarr_format=3, order="F", ) # def test_lazy_loader(): # foo = np.arange(100) # bar = np.arange(100, 0, -1) # store = "data/group.zarr" # save(store, foo=foo, bar=bar) # loader = load(store) # assert "foo" in loader # assert "bar" in loader # assert "baz" not in loader # assert len(loader) == 2 # assert sorted(loader) == ["bar", "foo"] # assert_array_equal(foo, loader["foo"]) # assert_array_equal(bar, loader["bar"]) # assert "LazyLoader: " in repr(loader) def test_load_array(sync_store: Store) -> None: store = sync_store foo = np.arange(100) bar = np.arange(100, 0, -1) save(store, foo=foo, bar=bar) # can also load arrays directly into a numpy array for array_name in ["foo", "bar"]: array = load(store, path=array_name) assert isinstance(array, np.ndarray) if array_name == "foo": assert_array_equal(foo, array) else: assert_array_equal(bar, array) @pytest.mark.parametrize("path", ["data", None]) @pytest.mark.parametrize("load_read_only", [True, False, None]) def test_load_zip(tmp_path: Path, path: str | None, load_read_only: bool | None) -> None: file = tmp_path / "test.zip" data = np.arange(100).reshape(10, 10) with ZipStore(file, mode="w", read_only=False) as zs: save(zs, data, path=path) with ZipStore(file, mode="r", read_only=load_read_only) as zs: result = zarr.load(store=zs, path=path) assert isinstance(result, np.ndarray) assert np.array_equal(result, data) with ZipStore(file, read_only=load_read_only) as zs: result = zarr.load(store=zs, path=path) assert isinstance(result, np.ndarray) assert np.array_equal(result, data) @pytest.mark.parametrize("path", ["data", None]) @pytest.mark.parametrize("load_read_only", [True, False]) def test_load_local(tmp_path: Path, path: str | None, load_read_only: bool) -> None: file = tmp_path / "test.zip" data = np.arange(100).reshape(10, 10) with LocalStore(file, read_only=False) as zs: save(zs, data, path=path) with LocalStore(file, read_only=load_read_only) as zs: result = zarr.load(store=zs, path=path) assert isinstance(result, np.ndarray) assert np.array_equal(result, data) def test_tree() -> None: g1 = zarr.group() g1.create_group("foo") g3 = g1.create_group("bar") g3.create_group("baz") g5 = g3.create_group("qux") g5.create_array("baz", shape=(100,), chunks=(10,), dtype="float64") with pytest.warns(ZarrDeprecationWarning, match=r"Group\.tree instead\."): # noqa: PT031 assert repr(zarr.tree(g1)) == repr(g1.tree()) assert str(zarr.tree(g1)) == str(g1.tree()) # @pytest.mark.parametrize("stores_from_path", [False, True]) # @pytest.mark.parametrize( # "with_chunk_store,listable", # [(False, True), (True, True), (False, False)], # ids=["default-listable", "with_chunk_store-listable", "default-unlistable"], # ) # def test_consolidate_metadata(with_chunk_store, listable, monkeypatch, stores_from_path): # # setup initial data # if stores_from_path: # store = tempfile.mkdtemp() # atexit.register(atexit_rmtree, store) # if with_chunk_store: # chunk_store = tempfile.mkdtemp() # atexit.register(atexit_rmtree, chunk_store) # else: # chunk_store = None # else: # store = MemoryStore() # chunk_store = MemoryStore() if with_chunk_store else None # path = None # z = group(store, chunk_store=chunk_store, path=path) # # Reload the actual store implementation in case str # store_to_copy = z.store # z.create_group("g1") # g2 = z.create_group("g2") # g2.attrs["hello"] = "world" # arr = g2.create_array("arr", shape=(20, 20), chunks=(5, 5), dtype="f8") # assert 16 == arr.nchunks # assert 0 == arr.nchunks_initialized # arr.attrs["data"] = 1 # arr[:] = 1.0 # assert 16 == arr.nchunks_initialized # if stores_from_path: # # get the actual store class for use with consolidate_metadata # store_class = z._store # else: # store_class = store # # perform consolidation # out = consolidate_metadata(store_class, path=path) # assert isinstance(out, Group) # assert ["g1", "g2"] == list(out) # if not stores_from_path: # assert isinstance(out._store, ConsolidatedMetadataStore) # assert ".zmetadata" in store # meta_keys = [ # ".zgroup", # "g1/.zgroup", # "g2/.zgroup", # "g2/.zattrs", # "g2/arr/.zarray", # "g2/arr/.zattrs", # ] # for key in meta_keys: # del store[key] # # https://github.com/zarr-developers/zarr-python/issues/993 # # Make sure we can still open consolidated on an unlistable store: # if not listable: # fs_memory = pytest.importorskip("fsspec.implementations.memory") # monkeypatch.setattr(fs_memory.MemoryFileSystem, "isdir", lambda x, y: False) # monkeypatch.delattr(fs_memory.MemoryFileSystem, "ls") # fs = fs_memory.MemoryFileSystem() # store_to_open = FSStore("", fs=fs) # # copy original store to new unlistable store # store_to_open.update(store_to_copy) # else: # store_to_open = store # # open consolidated # z2 = open_consolidated(store_to_open, chunk_store=chunk_store, path=path) # assert ["g1", "g2"] == list(z2) # assert "world" == z2.g2.attrs["hello"] # assert 1 == z2.g2.arr.attrs["data"] # assert (z2.g2.arr[:] == 1.0).all() # assert 16 == z2.g2.arr.nchunks # if listable: # assert 16 == z2.g2.arr.nchunks_initialized # else: # with pytest.raises(NotImplementedError): # _ = z2.g2.arr.nchunks_initialized # if stores_from_path: # # path string is note a BaseStore subclass so cannot be used to # # initialize a ConsolidatedMetadataStore. # with pytest.raises(ValueError): # cmd = ConsolidatedMetadataStore(store) # else: # # tests del/write on the store # cmd = ConsolidatedMetadataStore(store) # with pytest.raises(PermissionError): # del cmd[".zgroup"] # with pytest.raises(PermissionError): # cmd[".zgroup"] = None # # test getsize on the store # assert isinstance(getsize(cmd), Integral) # # test new metadata are not writeable # with pytest.raises(PermissionError): # z2.create_group("g3") # with pytest.raises(PermissionError): # z2.create_dataset("spam", shape=42, chunks=7, dtype="i4") # with pytest.raises(PermissionError): # del z2["g2"] # # test consolidated metadata are not writeable # with pytest.raises(PermissionError): # z2.g2.attrs["hello"] = "universe" # with pytest.raises(PermissionError): # z2.g2.arr.attrs["foo"] = "bar" # # test the data are writeable # z2.g2.arr[:] = 2 # assert (z2.g2.arr[:] == 2).all() # # test invalid modes # with pytest.raises(ValueError): # open_consolidated(store, chunk_store=chunk_store, mode="a", path=path) # with pytest.raises(ValueError): # open_consolidated(store, chunk_store=chunk_store, mode="w", path=path) # with pytest.raises(ValueError): # open_consolidated(store, chunk_store=chunk_store, mode="w-", path=path) # # make sure keyword arguments are passed through without error # open_consolidated( # store, # chunk_store=chunk_store, # path=path, # cache_attrs=True, # synchronizer=None, # ) # @pytest.mark.parametrize( # "options", # ( # {"dimension_separator": "/"}, # {"dimension_separator": "."}, # {"dimension_separator": None}, # ), # ) # def test_save_array_separator(tmpdir, options): # data = np.arange(6).reshape((3, 2)) # url = tmpdir.join("test.zarr") # save_array(url, data, **options) # class TestCopyStore(unittest.TestCase): # _version = 2 # def setUp(self): # source = dict() # source["foo"] = b"xxx" # source["bar/baz"] = b"yyy" # source["bar/qux"] = b"zzz" # self.source = source # def _get_dest_store(self): # return dict() # def test_no_paths(self): # source = self.source # dest = self._get_dest_store() # copy_store(source, dest) # assert len(source) == len(dest) # for key in source: # assert source[key] == dest[key] # def test_source_path(self): # source = self.source # # paths should be normalized # for source_path in "bar", "bar/", "/bar", "/bar/": # dest = self._get_dest_store() # copy_store(source, dest, source_path=source_path) # assert 2 == len(dest) # for key in source: # if key.startswith("bar/"): # dest_key = key.split("bar/")[1] # assert source[key] == dest[dest_key] # else: # assert key not in dest # def test_dest_path(self): # source = self.source # # paths should be normalized # for dest_path in "new", "new/", "/new", "/new/": # dest = self._get_dest_store() # copy_store(source, dest, dest_path=dest_path) # assert len(source) == len(dest) # for key in source: # if self._version == 3: # dest_key = f"{key[:10]}new/{key[10:]}" # else: # dest_key = f"new/{key}" # assert source[key] == dest[dest_key] # def test_source_dest_path(self): # source = self.source # # paths should be normalized # for source_path in "bar", "bar/", "/bar", "/bar/": # for dest_path in "new", "new/", "/new", "/new/": # dest = self._get_dest_store() # copy_store(source, dest, source_path=source_path, dest_path=dest_path) # assert 2 == len(dest) # for key in source: # if key.startswith("bar/"): # dest_key = "new/" + key.split("bar/")[1] # assert source[key] == dest[dest_key] # else: # assert key not in dest # assert (f"new/{key}") not in dest # def test_excludes_includes(self): # source = self.source # # single excludes # dest = self._get_dest_store() # excludes = "f.*" # copy_store(source, dest, excludes=excludes) # assert len(dest) == 2 # root = "" # assert "f{root}foo" not in dest # # multiple excludes # dest = self._get_dest_store() # excludes = "b.z", ".*x" # copy_store(source, dest, excludes=excludes) # assert len(dest) == 1 # assert f"{root}foo" in dest # assert f"{root}bar/baz" not in dest # assert f"{root}bar/qux" not in dest # # excludes and includes # dest = self._get_dest_store() # excludes = "b.*" # includes = ".*x" # copy_store(source, dest, excludes=excludes, includes=includes) # assert len(dest) == 2 # assert f"{root}foo" in dest # assert f"{root}bar/baz" not in dest # assert f"{root}bar/qux" in dest # def test_dry_run(self): # source = self.source # dest = self._get_dest_store() # copy_store(source, dest, dry_run=True) # assert 0 == len(dest) # def test_if_exists(self): # source = self.source # dest = self._get_dest_store() # root = "" # dest[f"{root}bar/baz"] = b"mmm" # # default ('raise') # with pytest.raises(CopyError): # copy_store(source, dest) # # explicit 'raise' # with pytest.raises(CopyError): # copy_store(source, dest, if_exists="raise") # # skip # copy_store(source, dest, if_exists="skip") # assert 3 == len(dest) # assert dest[f"{root}foo"] == b"xxx" # assert dest[f"{root}bar/baz"] == b"mmm" # assert dest[f"{root}bar/qux"] == b"zzz" # # replace # copy_store(source, dest, if_exists="replace") # assert 3 == len(dest) # assert dest[f"{root}foo"] == b"xxx" # assert dest[f"{root}bar/baz"] == b"yyy" # assert dest[f"{root}bar/qux"] == b"zzz" # # invalid option # with pytest.raises(ValueError): # copy_store(source, dest, if_exists="foobar") # def check_copied_array(original, copied, without_attrs=False, expect_props=None): # # setup # source_h5py = original.__module__.startswith("h5py.") # dest_h5py = copied.__module__.startswith("h5py.") # zarr_to_zarr = not (source_h5py or dest_h5py) # h5py_to_h5py = source_h5py and dest_h5py # zarr_to_h5py = not source_h5py and dest_h5py # h5py_to_zarr = source_h5py and not dest_h5py # if expect_props is None: # expect_props = dict() # else: # expect_props = expect_props.copy() # # common properties in zarr and h5py # for p in "dtype", "shape", "chunks": # expect_props.setdefault(p, getattr(original, p)) # # zarr-specific properties # if zarr_to_zarr: # for p in "compressor", "filters", "order", "fill_value": # expect_props.setdefault(p, getattr(original, p)) # # h5py-specific properties # if h5py_to_h5py: # for p in ( # "maxshape", # "compression", # "compression_opts", # "shuffle", # "scaleoffset", # "fletcher32", # "fillvalue", # ): # expect_props.setdefault(p, getattr(original, p)) # # common properties with some name differences # if h5py_to_zarr: # expect_props.setdefault("fill_value", original.fillvalue) # if zarr_to_h5py: # expect_props.setdefault("fillvalue", original.fill_value) # # compare properties # for k, v in expect_props.items(): # assert v == getattr(copied, k) # # compare data # assert_array_equal(original[:], copied[:]) # # compare attrs # if without_attrs: # for k in original.attrs.keys(): # assert k not in copied.attrs # else: # if dest_h5py and "filters" in original.attrs: # # special case in v3 (storing filters metadata under attributes) # # we explicitly do not copy this info over to HDF5 # original_attrs = original.attrs.asdict().copy() # original_attrs.pop("filters") # else: # original_attrs = original.attrs # assert sorted(original_attrs.items()) == sorted(copied.attrs.items()) # def check_copied_group(original, copied, without_attrs=False, expect_props=None, shallow=False): # # setup # if expect_props is None: # expect_props = dict() # else: # expect_props = expect_props.copy() # # compare children # for k, v in original.items(): # if hasattr(v, "shape"): # assert k in copied # check_copied_array(v, copied[k], without_attrs=without_attrs, expect_props=expect_props) # elif shallow: # assert k not in copied # else: # assert k in copied # check_copied_group( # v, # copied[k], # without_attrs=without_attrs, # shallow=shallow, # expect_props=expect_props, # ) # # compare attrs # if without_attrs: # for k in original.attrs.keys(): # assert k not in copied.attrs # else: # assert sorted(original.attrs.items()) == sorted(copied.attrs.items()) # def test_copy_all(): # """ # https://github.com/zarr-developers/zarr-python/issues/269 # copy_all used to not copy attributes as `.keys()` does not return hidden `.zattrs`. # """ # original_group = zarr.group(store=MemoryStore(), overwrite=True) # original_group.attrs["info"] = "group attrs" # original_subgroup = original_group.create_group("subgroup") # original_subgroup.attrs["info"] = "sub attrs" # destination_group = zarr.group(store=MemoryStore(), overwrite=True) # # copy from memory to directory store # copy_all( # original_group, # destination_group, # dry_run=False, # ) # assert "subgroup" in destination_group # assert destination_group.attrs["info"] == "group attrs" # assert destination_group.subgroup.attrs["info"] == "sub attrs" # class TestCopy: # @pytest.fixture(params=[False, True], ids=["zarr", "hdf5"]) # def source(self, request, tmpdir): # def prep_source(source): # foo = source.create_group("foo") # foo.attrs["experiment"] = "weird science" # baz = foo.create_dataset("bar/baz", data=np.arange(100), chunks=(50,)) # baz.attrs["units"] = "metres" # if request.param: # extra_kws = dict( # compression="gzip", # compression_opts=3, # fillvalue=84, # shuffle=True, # fletcher32=True, # ) # else: # extra_kws = dict(compressor=Zlib(3), order="F", fill_value=42, filters=[Adler32()]) # source.create_dataset( # "spam", # data=np.arange(100, 200).reshape(20, 5), # chunks=(10, 2), # dtype="i2", # **extra_kws, # ) # return source # if request.param: # h5py = pytest.importorskip("h5py") # fn = tmpdir.join("source.h5") # with h5py.File(str(fn), mode="w") as h5f: # yield prep_source(h5f) # else: # yield prep_source(group()) # @pytest.fixture(params=[False, True], ids=["zarr", "hdf5"]) # def dest(self, request, tmpdir): # if request.param: # h5py = pytest.importorskip("h5py") # fn = tmpdir.join("dest.h5") # with h5py.File(str(fn), mode="w") as h5f: # yield h5f # else: # yield group() # def test_copy_array(self, source, dest): # # copy array with default options # copy(source["foo/bar/baz"], dest) # check_copied_array(source["foo/bar/baz"], dest["baz"]) # copy(source["spam"], dest) # check_copied_array(source["spam"], dest["spam"]) # def test_copy_bad_dest(self, source, dest): # # try to copy to an array, dest must be a group # dest = dest.create_dataset("eggs", shape=(100,)) # with pytest.raises(ValueError): # copy(source["foo/bar/baz"], dest) # def test_copy_array_name(self, source, dest): # # copy array with name # copy(source["foo/bar/baz"], dest, name="qux") # assert "baz" not in dest # check_copied_array(source["foo/bar/baz"], dest["qux"]) # def test_copy_array_create_options(self, source, dest): # dest_h5py = dest.__module__.startswith("h5py.") # # copy array, provide creation options # compressor = Zlib(9) # create_kws = dict(chunks=(10,)) # if dest_h5py: # create_kws.update( # compression="gzip", compression_opts=9, shuffle=True, fletcher32=True, fillvalue=42 # ) # else: # create_kws.update(compressor=compressor, fill_value=42, order="F", filters=[Adler32()]) # copy(source["foo/bar/baz"], dest, without_attrs=True, **create_kws) # check_copied_array( # source["foo/bar/baz"], dest["baz"], without_attrs=True, expect_props=create_kws # ) # def test_copy_array_exists_array(self, source, dest): # # copy array, dest array in the way # dest.create_dataset("baz", shape=(10,)) # # raise # with pytest.raises(CopyError): # # should raise by default # copy(source["foo/bar/baz"], dest) # assert (10,) == dest["baz"].shape # with pytest.raises(CopyError): # copy(source["foo/bar/baz"], dest, if_exists="raise") # assert (10,) == dest["baz"].shape # # skip # copy(source["foo/bar/baz"], dest, if_exists="skip") # assert (10,) == dest["baz"].shape # # replace # copy(source["foo/bar/baz"], dest, if_exists="replace") # check_copied_array(source["foo/bar/baz"], dest["baz"]) # # invalid option # with pytest.raises(ValueError): # copy(source["foo/bar/baz"], dest, if_exists="foobar") # def test_copy_array_exists_group(self, source, dest): # # copy array, dest group in the way # dest.create_group("baz") # # raise # with pytest.raises(CopyError): # copy(source["foo/bar/baz"], dest) # assert not hasattr(dest["baz"], "shape") # with pytest.raises(CopyError): # copy(source["foo/bar/baz"], dest, if_exists="raise") # assert not hasattr(dest["baz"], "shape") # # skip # copy(source["foo/bar/baz"], dest, if_exists="skip") # assert not hasattr(dest["baz"], "shape") # # replace # copy(source["foo/bar/baz"], dest, if_exists="replace") # check_copied_array(source["foo/bar/baz"], dest["baz"]) # def test_copy_array_skip_initialized(self, source, dest): # dest_h5py = dest.__module__.startswith("h5py.") # dest.create_dataset("baz", shape=(100,), chunks=(10,), dtype="i8") # assert not np.all(source["foo/bar/baz"][:] == dest["baz"][:]) # if dest_h5py: # with pytest.raises(ValueError): # # not available with copy to h5py # copy(source["foo/bar/baz"], dest, if_exists="skip_initialized") # else: # # copy array, dest array exists but not yet initialized # copy(source["foo/bar/baz"], dest, if_exists="skip_initialized") # check_copied_array(source["foo/bar/baz"], dest["baz"]) # # copy array, dest array exists and initialized, will be skipped # dest["baz"][:] = np.arange(100, 200) # copy(source["foo/bar/baz"], dest, if_exists="skip_initialized") # assert_array_equal(np.arange(100, 200), dest["baz"][:]) # assert not np.all(source["foo/bar/baz"][:] == dest["baz"][:]) # def test_copy_group(self, source, dest): # # copy group, default options # copy(source["foo"], dest) # check_copied_group(source["foo"], dest["foo"]) # def test_copy_group_no_name(self, source, dest): # with pytest.raises(TypeError): # # need a name if copy root # copy(source, dest) # copy(source, dest, name="root") # check_copied_group(source, dest["root"]) # def test_copy_group_options(self, source, dest): # # copy group, non-default options # copy(source["foo"], dest, name="qux", without_attrs=True) # assert "foo" not in dest # check_copied_group(source["foo"], dest["qux"], without_attrs=True) # def test_copy_group_shallow(self, source, dest): # # copy group, shallow # copy(source, dest, name="eggs", shallow=True) # check_copied_group(source, dest["eggs"], shallow=True) # def test_copy_group_exists_group(self, source, dest): # # copy group, dest groups exist # dest.create_group("foo/bar") # copy(source["foo"], dest) # check_copied_group(source["foo"], dest["foo"]) # def test_copy_group_exists_array(self, source, dest): # # copy group, dest array in the way # dest.create_dataset("foo/bar", shape=(10,)) # # raise # with pytest.raises(CopyError): # copy(source["foo"], dest) # assert dest["foo/bar"].shape == (10,) # with pytest.raises(CopyError): # copy(source["foo"], dest, if_exists="raise") # assert dest["foo/bar"].shape == (10,) # # skip # copy(source["foo"], dest, if_exists="skip") # assert dest["foo/bar"].shape == (10,) # # replace # copy(source["foo"], dest, if_exists="replace") # check_copied_group(source["foo"], dest["foo"]) # def test_copy_group_dry_run(self, source, dest): # # dry run, empty destination # n_copied, n_skipped, n_bytes_copied = copy( # source["foo"], dest, dry_run=True, return_stats=True # ) # assert 0 == len(dest) # assert 3 == n_copied # assert 0 == n_skipped # assert 0 == n_bytes_copied # # dry run, array exists in destination # baz = np.arange(100, 200) # dest.create_dataset("foo/bar/baz", data=baz) # assert not np.all(source["foo/bar/baz"][:] == dest["foo/bar/baz"][:]) # assert 1 == len(dest) # # raise # with pytest.raises(CopyError): # copy(source["foo"], dest, dry_run=True) # assert 1 == len(dest) # # skip # n_copied, n_skipped, n_bytes_copied = copy( # source["foo"], dest, dry_run=True, if_exists="skip", return_stats=True # ) # assert 1 == len(dest) # assert 2 == n_copied # assert 1 == n_skipped # assert 0 == n_bytes_copied # assert_array_equal(baz, dest["foo/bar/baz"]) # # replace # n_copied, n_skipped, n_bytes_copied = copy( # source["foo"], dest, dry_run=True, if_exists="replace", return_stats=True # ) # assert 1 == len(dest) # assert 3 == n_copied # assert 0 == n_skipped # assert 0 == n_bytes_copied # assert_array_equal(baz, dest["foo/bar/baz"]) # def test_logging(self, source, dest, tmpdir): # # callable log # copy(source["foo"], dest, dry_run=True, log=print) # # file name # fn = str(tmpdir.join("log_name")) # copy(source["foo"], dest, dry_run=True, log=fn) # # file # with tmpdir.join("log_file").open(mode="w") as f: # copy(source["foo"], dest, dry_run=True, log=f) # # bad option # with pytest.raises(TypeError): # copy(source["foo"], dest, dry_run=True, log=True) def test_open_falls_back_to_open_group() -> None: # https://github.com/zarr-developers/zarr-python/issues/2309 store = MemoryStore() zarr.open_group(store, attributes={"key": "value"}) group = zarr.open(store) assert isinstance(group, Group) assert group.attrs == {"key": "value"} async def test_open_falls_back_to_open_group_async(zarr_format: ZarrFormat) -> None: # https://github.com/zarr-developers/zarr-python/issues/2309 store = MemoryStore() await zarr.api.asynchronous.open_group( store, attributes={"key": "value"}, zarr_format=zarr_format ) group = await zarr.api.asynchronous.open(store=store) assert isinstance(group, zarr.core.group.AsyncGroup) assert group.metadata.zarr_format == zarr_format assert group.attrs == {"key": "value"} @pytest.mark.parametrize("mode", ["r", "r+", "w", "a"]) def test_open_modes_creates_group(tmp_path: Path, mode: str) -> None: # https://github.com/zarr-developers/zarr-python/issues/2490 zarr_dir = tmp_path / f"mode-{mode}-test.zarr" if mode in ["r", "r+"]: # Expect FileNotFoundError to be raised if 'r' or 'r+' mode with pytest.raises(FileNotFoundError): zarr.open(store=zarr_dir, mode=mode) # type: ignore[arg-type] else: group = zarr.open(store=zarr_dir, mode=mode) # type: ignore[arg-type] assert isinstance(group, Group) async def test_metadata_validation_error() -> None: with pytest.raises( MetadataValidationError, match="Invalid value for 'zarr_format'. Expected 2, 3, or None. Got '3.0'.", ): await zarr.api.asynchronous.open_group(zarr_format="3.0") # type: ignore[arg-type] with pytest.raises( MetadataValidationError, match="Invalid value for 'zarr_format'. Expected 2, 3, or None. Got '3.0'.", ): await zarr.api.asynchronous.open_array(shape=(1,), zarr_format="3.0") # type: ignore[arg-type] @pytest.mark.parametrize( "store", ["local", "memory", "zip"], indirect=True, ) def test_open_array_with_mode_r_plus(store: Store, zarr_format: ZarrFormat) -> None: # 'r+' means read/write (must exist) with pytest.raises(ArrayNotFoundError): zarr.open_array(store=store, mode="r+", zarr_format=zarr_format) zarr.ones(store=store, shape=(3, 3), zarr_format=zarr_format) z2 = zarr.open_array(store=store, mode="r+") assert isinstance(z2, Array) assert z2.metadata.zarr_format == zarr_format result = z2[:] assert isinstance(result, NDArrayLike) assert (result == 1).all() z2[:] = 3 @pytest.mark.parametrize( ("a_func", "b_func"), [ (zarr.api.asynchronous.create_array, zarr.api.synchronous.create_array), (zarr.api.asynchronous.save, zarr.api.synchronous.save), (zarr.api.asynchronous.save_array, zarr.api.synchronous.save_array), (zarr.api.asynchronous.save_group, zarr.api.synchronous.save_group), (zarr.api.asynchronous.open_group, zarr.api.synchronous.open_group), (zarr.api.asynchronous.create, zarr.api.synchronous.create), ], ) def test_consistent_signatures( a_func: Callable[[object], object], b_func: Callable[[object], object] ) -> None: """ Ensure that pairs of functions have the same signature """ base_sig = inspect.signature(a_func) test_sig = inspect.signature(b_func) wrong: dict[str, list[object]] = { "missing_from_test": [], "missing_from_base": [], "wrong_type": [], } for key, value in base_sig.parameters.items(): if key not in test_sig.parameters: wrong["missing_from_test"].append((key, value)) for key, value in test_sig.parameters.items(): if key not in base_sig.parameters: wrong["missing_from_base"].append((key, value)) if base_sig.parameters[key] != value: wrong["wrong_type"].append({key: {"test": value, "base": base_sig.parameters[key]}}) assert wrong["missing_from_base"] == [] assert wrong["missing_from_test"] == [] assert wrong["wrong_type"] == [] def test_api_exports() -> None: """ Test that the sync API and the async API export the same objects """ assert zarr.api.asynchronous.__all__ == zarr.api.synchronous.__all__ @gpu_test @pytest.mark.parametrize( "store", ["local", "memory", "zip"], indirect=True, ) @pytest.mark.parametrize("zarr_format", [None, 2, 3]) def test_gpu_basic(store: Store, zarr_format: ZarrFormat | None) -> None: import cupy as cp if zarr_format == 2: # Without this, the zstd codec attempts to convert the cupy # array to bytes. compressors = None else: compressors = "auto" with zarr.config.enable_gpu(): src = cp.random.uniform(size=(100, 100)) # allocate on the device z = zarr.create_array( store, name="a", shape=src.shape, chunks=(10, 10), dtype=src.dtype, overwrite=True, zarr_format=zarr_format, compressors=compressors, # type: ignore[arg-type] ) z[:10, :10] = src[:10, :10] result = z[:10, :10] # assert_array_equal doesn't check the type assert isinstance(result, type(src)) cp.testing.assert_array_equal(result, src[:10, :10]) def test_v2_without_compressor() -> None: # Make sure it's possible to set no compressor for v2 arrays arr = zarr.create(store={}, shape=(1), dtype="uint8", zarr_format=2, compressor=None) assert arr.compressors == () def test_v2_with_v3_compressor() -> None: # Check trying to create a v2 array with a v3 compressor fails with pytest.raises( ValueError, match="Cannot use a BytesBytesCodec as a compressor for zarr v2 arrays. Use a numcodecs codec directly instead.", ): zarr.create( store={}, shape=(1), dtype="uint8", zarr_format=2, compressor=zarr.codecs.BloscCodec() ) def add_empty_file(path: Path) -> Path: fpath = path / "a.txt" fpath.touch() return fpath @pytest.mark.parametrize("create_function", [create_array, from_array]) @pytest.mark.parametrize("overwrite", [True, False]) def test_no_overwrite_array(tmp_path: Path, create_function: Callable, overwrite: bool) -> None: # type:ignore[type-arg] store = zarr.storage.LocalStore(tmp_path) existing_fpath = add_empty_file(tmp_path) assert existing_fpath.exists() create_function(store=store, data=np.ones(shape=(1,)), overwrite=overwrite) if overwrite: assert not existing_fpath.exists() else: assert existing_fpath.exists() @pytest.mark.parametrize("create_function", [create_group, group]) @pytest.mark.parametrize("overwrite", [True, False]) def test_no_overwrite_group(tmp_path: Path, create_function: Callable, overwrite: bool) -> None: # type:ignore[type-arg] store = zarr.storage.LocalStore(tmp_path) existing_fpath = add_empty_file(tmp_path) assert existing_fpath.exists() create_function(store=store, overwrite=overwrite) if overwrite: assert not existing_fpath.exists() else: assert existing_fpath.exists() @pytest.mark.parametrize("open_func", [zarr.open, open_group]) @pytest.mark.parametrize("mode", ["r", "r+", "a", "w", "w-"]) def test_no_overwrite_open(tmp_path: Path, open_func: Callable, mode: str) -> None: # type:ignore[type-arg] store = zarr.storage.LocalStore(tmp_path) existing_fpath = add_empty_file(tmp_path) assert existing_fpath.exists() with contextlib.suppress(FileExistsError, FileNotFoundError, ZarrUserWarning): open_func(store=store, mode=mode) if mode == "w": assert not existing_fpath.exists() else: assert existing_fpath.exists() def test_no_overwrite_load(tmp_path: Path) -> None: store = zarr.storage.LocalStore(tmp_path) existing_fpath = add_empty_file(tmp_path) assert existing_fpath.exists() with contextlib.suppress(NotImplementedError): zarr.load(store) assert existing_fpath.exists() @pytest.mark.parametrize( "f", [ zarr.array, zarr.create, zarr.create_array, zarr.ones, zarr.ones_like, zarr.empty, zarr.empty_like, zarr.full, zarr.full_like, zarr.zeros, zarr.zeros_like, ], ) def test_auto_chunks(f: Callable[..., AnyArray]) -> None: # Make sure chunks are set automatically across the public API # TODO: test shards with this test too shape = (1000, 1000) dtype = np.uint8 kwargs = {"shape": shape, "dtype": dtype} array = np.zeros(shape, dtype=dtype) store = zarr.storage.MemoryStore() # ruff: disable[FURB171] if f in [zarr.full, zarr.full_like]: kwargs["fill_value"] = 0 if f in [zarr.array]: kwargs["data"] = array if f in [zarr.empty_like, zarr.full_like, zarr.empty_like, zarr.ones_like, zarr.zeros_like]: kwargs["a"] = array if f in [zarr.create_array]: kwargs["store"] = store # ruff: enable[FURB171] a = f(**kwargs) assert a.chunks == (500, 500) @pytest.mark.parametrize("kwarg_name", ["synchronizer", "chunk_store", "cache_attrs", "meta_array"]) def test_unimplemented_kwarg_warnings(kwarg_name: str) -> None: kwargs = {kwarg_name: 1} with pytest.warns(RuntimeWarning, match=".* is not yet implemented"): zarr.create(shape=(1,), **kwargs) # type: ignore[arg-type] zarr-python-3.3.0/tests/test_api/000077500000000000000000000000001523267620000167675ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_api/test_asynchronous.py000066400000000000000000000070441523267620000231400ustar00rootroot00000000000000from __future__ import annotations import json from dataclasses import dataclass from typing import TYPE_CHECKING import numpy as np import pytest from zarr import create_array from zarr.api.asynchronous import _get_shape_chunks, _like_args, group, open from zarr.core.buffer.core import default_buffer_prototype from zarr.core.group import AsyncGroup if TYPE_CHECKING: from pathlib import Path from typing import Any import numpy.typing as npt from zarr.core.array import AsyncArray from zarr.core.metadata import ArrayV2Metadata, ArrayV3Metadata from zarr.types import AnyArray @dataclass class WithShape: shape: tuple[int, ...] @dataclass class WithChunks(WithShape): chunks: tuple[int, ...] @dataclass class WithChunkLen(WithShape): chunklen: int @pytest.mark.parametrize( ("observed", "expected"), [ ({}, (None, None)), (WithShape(shape=(1, 2)), ((1, 2), None)), (WithChunks(shape=(1, 2), chunks=(1, 2)), ((1, 2), (1, 2))), (WithChunkLen(shape=(10, 10), chunklen=1), ((10, 10), (1, 10))), ], ) def test_get_shape_chunks( observed: object, expected: tuple[tuple[int, ...] | None, tuple[int, ...] | None] ) -> None: """ Test the _get_shape_chunks function """ assert _get_shape_chunks(observed) == expected @pytest.mark.parametrize( ("observed", "expected"), [ (np.arange(10, dtype=np.dtype("int64")), {"shape": (10,), "dtype": np.dtype("int64")}), (WithChunks(shape=(1, 2), chunks=(1, 2)), {"chunks": (1, 2), "shape": (1, 2)}), ( create_array( {}, chunks=(10,), shape=(100,), dtype="f8", compressors=None, filters=None, zarr_format=2, )._async_array, { "chunks": (10,), "shape": (100,), "dtype": np.dtype("f8"), "fill_value": np.float64(0.0), "compressor": None, "filters": None, "order": "C", }, ), ], ) def test_like_args( observed: AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata] | AnyArray | npt.NDArray[Any], expected: object, ) -> None: """ Test the like_args function """ assert _like_args(observed) == expected async def test_open_no_array() -> None: """ Test that zarr.api.asynchronous.open attempts to open a group when no array is found, but shape was specified in kwargs. This behavior makes no sense but we should still test it. """ store = { "zarr.json": default_buffer_prototype().buffer.from_bytes( json.dumps({"zarr_format": 3, "node_type": "group"}).encode("utf-8") ) } with pytest.raises( TypeError, match=r"open_group\(\) got an unexpected keyword argument 'shape'" ): await open(store=store, shape=(1,)) async def test_open_group_new_path(tmp_path: Path) -> None: """ Test that zarr.api.asynchronous.group properly handles a string representation of a local file path that does not yet exist. See https://github.com/zarr-developers/zarr-python/issues/3406 """ # tmp_path exists, but tmp_path / "test.zarr" will not, which is important for this test path = tmp_path / "test.zarr" grp = await group(store=path, attributes={"a": 1}) assert isinstance(grp, AsyncGroup) # Calling group on an existing store should just open that store grp = await group(store=path) assert grp.attrs == {"a": 1} zarr-python-3.3.0/tests/test_api/test_synchronous.py000066400000000000000000000107211523267620000227730ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Any, Final import pytest from numpydoc.docscrape import NumpyDocString import zarr from zarr.api import asynchronous, synchronous if TYPE_CHECKING: from collections.abc import Callable MATCHED_EXPORT_NAMES: Final[tuple[str, ...]] = tuple( sorted(set(synchronous.__all__) | set(asynchronous.__all__)) ) """A sorted tuple of names that are exported by both the sync and async APIs.""" MATCHED_CALLABLE_NAMES: Final[tuple[str, ...]] = tuple( x for x in MATCHED_EXPORT_NAMES if callable(getattr(synchronous, x)) ) """A sorted tuple of callable names that are exported by both the sync and async APIs.""" @pytest.mark.parametrize("callable_name", MATCHED_CALLABLE_NAMES) def test_docstrings_match(callable_name: str) -> None: """ Tests that the docstrings for the sync and async define identical parameters. """ callable_a = getattr(synchronous, callable_name) callable_b = getattr(asynchronous, callable_name) if callable_a.__doc__ is None: assert callable_b.__doc__ is None else: params_a = NumpyDocString(callable_a.__doc__)["Parameters"] params_b = NumpyDocString(callable_b.__doc__)["Parameters"] mismatch = [] for idx, (a, b) in enumerate(zip(params_a, params_b, strict=False)): if a != b: mismatch.append((idx, (a, b))) assert mismatch == [] @pytest.mark.parametrize( ("parameter_name", "array_creation_routines"), [ pytest.param( ("store", "path"), ( asynchronous.create_array, synchronous.create_array, asynchronous.create_group, synchronous.create_group, zarr.AsyncGroup.create_array, zarr.Group.create_array, ), id="store-path-create_array_group", ), pytest.param( ( "store", "path", ), ( asynchronous.create, synchronous.create, zarr.Group.create, ), id="store-path-create", ), pytest.param( ( ( "filters", "codecs", "compressors", "compressor", "chunks", "shape", "dtype", "shardsfill_value", ) ), ( asynchronous.create, synchronous.create, asynchronous.create_array, synchronous.create_array, zarr.AsyncGroup.create_array, zarr.Group.create_array, ), id="encoding-params-create_and_array", ), ], ) def test_docstring_consistent_parameters( parameter_name: str, array_creation_routines: tuple[Callable[[Any], Any], ...] ) -> None: """ Tests that array and group creation routines document the same parameters consistently. This test inspects the docstrings of sets of callables and generates two dicts: - a dict where the keys are parameter descriptions and the values are the names of the routines with those descriptions - a dict where the keys are parameter types and the values are the names of the routines with those types If each dict has just 1 value, then the parameter description and type in the docstring must be identical across different routines. But if these dicts have multiple values, then there must be routines that use the same parameter but document it differently, which will trigger a test failure. """ descs: dict[tuple[str, ...], tuple[str, ...]] = {} types: dict[str, tuple[str, ...]] = {} for routine in array_creation_routines: key = f"{routine.__module__}.{routine.__qualname__}" docstring = NumpyDocString(routine.__doc__) param_dict = {d.name: d for d in docstring["Parameters"]} if parameter_name in param_dict: val = param_dict[parameter_name] if tuple(val.desc) in descs: descs[tuple(val.desc)] = descs[tuple(val.desc)] + (key,) else: descs[tuple(val.desc)] = (key,) if val.type in types: types[val.type] = types[val.type] + (key,) else: types[val.type] = (key,) assert len(descs) <= 1 assert len(types) <= 1 zarr-python-3.3.0/tests/test_array.py000066400000000000000000002467651523267620000177320ustar00rootroot00000000000000import dataclasses import inspect import json import math import multiprocessing as mp import pickle import re import sys from itertools import accumulate, starmap from typing import TYPE_CHECKING, Any, Literal from unittest import mock import numcodecs import numpy as np import numpy.typing as npt import pytest from packaging.version import Version import zarr.api.asynchronous import zarr.api.synchronous as sync_api from tests.conftest import skip_object_dtype from zarr import Array, Group from zarr.abc.store import Store from zarr.codecs import ( BytesCodec, GzipCodec, TransposeCodec, ZstdCodec, ) from zarr.core._info import ArrayInfo from zarr.core.array import ( AsyncArray, CompressorsLike, FiltersLike, _iter_chunk_coords, _iter_chunk_regions, _iter_shard_coords, _iter_shard_keys, _iter_shard_regions, _parse_chunk_encoding_v2, _parse_chunk_encoding_v3, _shards_initialized, create_array, default_filters_v2, default_serializer_v3, ) from zarr.core.array_spec import ArrayConfig, ArrayConfigParams from zarr.core.buffer import NDArrayLike, NDArrayLikeOrScalar, cpu, default_buffer_prototype from zarr.core.chunk_grids import ( SHARDED_INNER_CHUNK_MAX_BYTES, guess_chunks, normalize_chunks_nd, resolve_outer_and_inner_chunks, ) from zarr.core.chunk_key_encodings import ChunkKeyEncodingParams from zarr.core.common import JSON, ZarrFormat, ceildiv from zarr.core.dtype import ( DateTime64, Float32, Float64, Int16, Structured, TimeDelta64, UInt8, VariableLengthBytes, VariableLengthUTF8, ZDType, parse_dtype, ) from zarr.core.dtype.common import ENDIANNESS_STR, EndiannessStr from zarr.core.dtype.npy.common import NUMPY_ENDIANNESS_STR, endianness_from_numpy_str from zarr.core.group import AsyncGroup from zarr.core.indexing import BasicIndexer, _iter_grid, _iter_regions from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.core.sync import sync from zarr.errors import ( ContainsArrayError, ContainsGroupError, ZarrUserWarning, ) from zarr.storage import LocalStore, MemoryStore, StorePath from zarr.storage._logging import LoggingStore from zarr.types import AnyArray, AnyAsyncArray from .test_dtype.conftest import zdtype_examples if TYPE_CHECKING: from zarr.abc.codec import CodecJSON_V3 @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.parametrize("overwrite", [True, False]) @pytest.mark.parametrize("extant_node", ["array", "group"]) def test_array_creation_existing_node( store: LocalStore | MemoryStore, zarr_format: ZarrFormat, overwrite: bool, extant_node: Literal["array", "group"], ) -> None: """ Check that an existing array or group is handled as expected during array creation. """ spath = StorePath(store) group = Group.from_store(spath, zarr_format=zarr_format) expected_exception: type[ContainsArrayError | ContainsGroupError] if extant_node == "array": expected_exception = ContainsArrayError _ = group.create_array("extant", shape=(10,), dtype="uint8") elif extant_node == "group": expected_exception = ContainsGroupError _ = group.create_group("extant") else: raise AssertionError new_shape = (2, 2) new_dtype = "float32" if overwrite: if not store.supports_deletes: pytest.skip("store does not support deletes") arr_new = zarr.create_array( spath / "extant", shape=new_shape, dtype=new_dtype, overwrite=overwrite, zarr_format=zarr_format, ) assert arr_new.shape == new_shape assert arr_new.dtype == new_dtype else: with pytest.raises(expected_exception): arr_new = zarr.create_array( spath / "extant", shape=new_shape, dtype=new_dtype, overwrite=overwrite, zarr_format=zarr_format, ) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_create_creates_parents( store: LocalStore | MemoryStore, zarr_format: ZarrFormat ) -> None: # prepare a root node, with some data set await zarr.api.asynchronous.open_group( store=store, path="a", zarr_format=zarr_format, attributes={"key": "value"} ) # create a child node with a couple intermediates await zarr.api.asynchronous.create( shape=(2, 2), store=store, path="a/b/c/d", zarr_format=zarr_format ) parts = ["a", "a/b", "a/b/c"] if zarr_format == 2: files = [".zattrs", ".zgroup"] else: files = ["zarr.json"] expected = [f"{part}/{file}" for file in files for part in parts] if zarr_format == 2: expected.extend([".zattrs", ".zgroup", "a/b/c/d/.zarray", "a/b/c/d/.zattrs"]) else: expected.extend(["zarr.json", "a/b/c/d/zarr.json"]) expected = sorted(expected) result = sorted([x async for x in store.list_prefix("")]) assert result == expected paths = ["a", "a/b", "a/b/c"] for path in paths: g = await zarr.api.asynchronous.open_group(store=store, path=path) assert isinstance(g, AsyncGroup) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) def test_array_name_properties_no_group( store: LocalStore | MemoryStore, zarr_format: ZarrFormat ) -> None: arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), zarr_format=zarr_format, dtype=">i4" ) assert arr.path == "" assert arr.name == "/" assert arr.basename == "" @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) def test_array_name_properties_with_group( store: LocalStore | MemoryStore, zarr_format: ZarrFormat ) -> None: root = Group.from_store(store=store, zarr_format=zarr_format) foo = root.create_array("foo", shape=(100,), chunks=(10,), dtype="i4") assert foo.path == "foo" assert foo.name == "/foo" assert foo.basename == "foo" bar = root.create_group("bar") spam = bar.create_array("spam", shape=(100,), chunks=(10,), dtype="i4") assert spam.path == "bar/spam" assert spam.name == "/bar/spam" assert spam.basename == "spam" @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("specify_fill_value", [True, False]) @pytest.mark.parametrize( "zdtype", zdtype_examples, ids=tuple(str(type(v)) for v in zdtype_examples) ) def test_array_fill_value_default( store: MemoryStore, specify_fill_value: bool, zdtype: ZDType[Any, Any] ) -> None: """ Test that creating an array with the fill_value parameter set to None, or unspecified, results in the expected fill_value attribute of the array, i.e. the default value of the dtype """ shape = (10,) if specify_fill_value: arr = zarr.create_array( store=store, shape=shape, dtype=zdtype, zarr_format=3, chunks=shape, fill_value=None, ) else: arr = zarr.create_array(store=store, shape=shape, dtype=zdtype, zarr_format=3, chunks=shape) expected_fill_value = zdtype.default_scalar() if isinstance(expected_fill_value, np.datetime64 | np.timedelta64): if np.isnat(expected_fill_value): assert np.isnat(arr.fill_value) elif isinstance(expected_fill_value, np.floating | np.complexfloating): if np.isnan(expected_fill_value): assert np.isnan(arr.fill_value) else: assert arr.fill_value == expected_fill_value # A simpler check would be to ensure that arr.fill_value.dtype == arr.dtype # But for some numpy data types (namely, U), scalars might not have length. An empty string # scalar from a `>U4` array would have dtype `>U`, and arr.fill_value.dtype == arr.dtype will fail. assert type(arr.fill_value) is type(np.array([arr.fill_value], dtype=arr.dtype)[0]) @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize( ("dtype_str", "fill_value"), [("bool", True), ("uint8", 99), ("float32", -99.9), ("complex64", 3 + 4j)], ) def test_array_v3_fill_value(store: MemoryStore, fill_value: int, dtype_str: str) -> None: shape = (10,) arr = zarr.create_array( store=store, shape=shape, dtype=dtype_str, zarr_format=3, chunks=shape, fill_value=fill_value, ) assert arr.fill_value == np.dtype(dtype_str).type(fill_value) assert arr.fill_value.dtype == arr.dtype @pytest.mark.parametrize("store", ["memory"], indirect=True) async def test_array_v3_nan_fill_value(store: MemoryStore) -> None: shape = (10,) arr = zarr.create_array( store=store, shape=shape, dtype=np.float64, zarr_format=3, chunks=shape, fill_value=np.nan, ) arr[:] = np.nan assert np.isnan(arr.fill_value) assert arr.fill_value.dtype == arr.dtype # all fill value chunk is an empty chunk, and should not be written assert len([a async for a in store.list_prefix("/")]) == 0 @pytest.mark.parametrize("store", ["local"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_serializable_async_array( store: LocalStore | MemoryStore, zarr_format: ZarrFormat ) -> None: expected = await zarr.api.asynchronous.create_array( store=store, shape=(100,), chunks=(10,), zarr_format=zarr_format, dtype="i4" ) # await expected.setitems(list(range(100))) p = pickle.dumps(expected) actual = pickle.loads(p) assert actual == expected # np.testing.assert_array_equal(await actual.getitem(slice(None)), await expected.getitem(slice(None))) # TODO: uncomment the parts of this test that will be impacted by the config/prototype changes in flight @pytest.mark.parametrize("store", ["local"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) def test_serializable_sync_array(store: LocalStore, zarr_format: ZarrFormat) -> None: expected = zarr.create_array( store=store, shape=(100,), chunks=(10,), zarr_format=zarr_format, dtype="i4" ) expected[:] = list(range(100)) p = pickle.dumps(expected) actual = pickle.loads(p) assert actual == expected np.testing.assert_array_equal(actual[:], expected[:]) @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("zarr_format", [2, 3, "invalid"]) def test_storage_transformers(store: MemoryStore, zarr_format: ZarrFormat | str) -> None: """ Test that providing an actual storage transformer produces a warning and otherwise passes through """ metadata_dict: dict[str, JSON] if zarr_format == 3: metadata_dict = { "zarr_format": 3, "node_type": "array", "shape": (10,), "chunk_grid": {"name": "regular", "configuration": {"chunk_shape": (1,)}}, "data_type": "uint8", "chunk_key_encoding": {"name": "v2", "configuration": {"separator": "/"}}, "codecs": (BytesCodec().to_dict(),), "fill_value": 0, "storage_transformers": ({"test": "should_raise"}), } else: metadata_dict = { "zarr_format": zarr_format, "shape": (10,), "chunks": (1,), "dtype": "|u1", "dimension_separator": ".", "codecs": (BytesCodec().to_dict(),), "fill_value": 0, "order": "C", "storage_transformers": ({"test": "should_raise"}), } if zarr_format == 3: match = "Arrays with storage transformers are not supported in zarr-python at this time." with pytest.raises(ValueError, match=match): Array.from_dict(StorePath(store), data=metadata_dict) elif zarr_format == 2: # no warning Array.from_dict(StorePath(store), data=metadata_dict) else: match = f"Invalid zarr_format: {zarr_format}. Expected 2 or 3" with pytest.raises(ValueError, match=match): Array.from_dict(StorePath(store), data=metadata_dict) @pytest.mark.parametrize("test_cls", [AnyArray, AnyAsyncArray]) @pytest.mark.parametrize("nchunks", [2, 5, 10]) def test_nchunks(test_cls: type[AnyArray] | type[AnyAsyncArray], nchunks: int) -> None: """ Test that nchunks returns the number of chunks defined for the array. """ store = MemoryStore() shape = 100 arr = zarr.create_array(store, shape=(shape,), chunks=(ceildiv(shape, nchunks),), dtype="i4") expected = nchunks if test_cls == Array: observed = arr.nchunks else: observed = arr.async_array.nchunks assert observed == expected @pytest.mark.parametrize("test_cls", [Array, AsyncArray]) @pytest.mark.parametrize( ("shape", "shard_shape", "chunk_shape"), [((10,), None, (1,)), ((10,), (1,), (1,)), ((40,), (20,), (5,))], ) async def test_nchunks_initialized( test_cls: type[AnyArray] | type[AnyAsyncArray], shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], ) -> None: """ Test that nchunks_initialized accurately returns the number of stored partitions. """ store = MemoryStore() if shard_shape is None: chunks_per_shard = 1 else: chunks_per_shard = np.prod(np.array(shard_shape) // np.array(chunk_shape)) arr = zarr.create_array(store, shape=shape, shards=shard_shape, chunks=chunk_shape, dtype="i1") # write chunks one at a time for idx, region in enumerate(arr._iter_shard_regions()): arr[region] = 1 expected = idx + 1 if test_cls == Array: observed = arr._nshards_initialized assert observed == arr.nchunks_initialized // chunks_per_shard else: observed = await arr.async_array._nshards_initialized() assert observed == await arr.async_array.nchunks_initialized() // chunks_per_shard assert observed == expected # delete chunks for idx, key in enumerate(arr._iter_shard_keys()): sync(arr.store_path.store.delete(key)) if test_cls == Array: observed = arr._nshards_initialized assert observed == arr.nchunks_initialized // chunks_per_shard else: observed = await arr.async_array._nshards_initialized() assert observed == await arr.async_array.nchunks_initialized() // chunks_per_shard expected = arr._nshards - idx - 1 assert observed == expected @pytest.mark.parametrize("path", ["", "foo"]) @pytest.mark.parametrize( ("shape", "shard_shape", "chunk_shape"), [((10,), None, (1,)), ((10,), (1,), (1,)), ((40,), (20,), (5,))], ) async def test_chunks_initialized( path: str, shape: tuple[int, ...], shard_shape: tuple[int, ...], chunk_shape: tuple[int, ...] ) -> None: """ Test that chunks_initialized accurately returns the keys of stored chunks. """ store = MemoryStore() arr = zarr.create_array( store, name=path, shape=shape, shards=shard_shape, chunks=chunk_shape, dtype="i1" ) if path: await store.set(path, cpu.Buffer.from_bytes(b"")) chunks_accumulated = tuple( accumulate(tuple(tuple(v.split(" ")) for v in arr._iter_shard_keys())) ) for keys, region in zip(chunks_accumulated, arr._iter_shard_regions(), strict=False): arr[region] = 1 observed = sorted(await _shards_initialized(arr.async_array)) expected = sorted(keys) assert observed == expected def test_nbytes_stored() -> None: arr = zarr.create(shape=(100,), chunks=(10,), dtype="i4", codecs=[BytesCodec()]) result = arr.nbytes_stored() assert result == 502 # the size of the metadata document. This is a fragile test. arr[:50] = 1 result = arr.nbytes_stored() assert result == 702 # the size with 5 chunks filled. arr[50:] = 2 result = arr.nbytes_stored() assert result == 902 # the size with all chunks filled. async def test_nbytes_stored_async() -> None: arr = await zarr.api.asynchronous.create( shape=(100,), chunks=(10,), dtype="i4", codecs=[BytesCodec()] ) result = await arr.nbytes_stored() assert result == 502 # the size of the metadata document. This is a fragile test. await arr.setitem(slice(50), 1) result = await arr.nbytes_stored() assert result == 702 # the size with 5 chunks filled. await arr.setitem(slice(50, 100), 2) result = await arr.nbytes_stored() assert result == 902 # the size with all chunks filled. @pytest.mark.parametrize("zarr_format", [2, 3]) def test_update_attrs(zarr_format: ZarrFormat) -> None: # regression test for https://github.com/zarr-developers/zarr-python/issues/2328 store = MemoryStore() arr = zarr.create_array( store=store, shape=(5,), chunks=(5,), dtype="f8", zarr_format=zarr_format ) arr.attrs["foo"] = "bar" assert arr.attrs["foo"] == "bar" arr2 = zarr.open_array(store=store, zarr_format=zarr_format) assert arr2.attrs["foo"] == "bar" @pytest.mark.parametrize(("chunks", "shards"), [((2, 2), None), ((2, 2), (4, 4))]) class TestInfo: def test_info_v2(self, chunks: tuple[int, int], shards: tuple[int, int] | None) -> None: arr = zarr.create_array(store={}, shape=(8, 8), dtype="f8", chunks=chunks, zarr_format=2) result = arr.info expected = ArrayInfo( _zarr_format=2, _data_type=arr.async_array._zdtype, _fill_value=arr.fill_value, _shape=(8, 8), _chunk_shape=chunks, _shard_shape=None, _order="C", _read_only=False, _store_type="MemoryStore", _count_bytes=512, _compressors=(numcodecs.Zstd(),), ) assert result == expected def test_info_v3(self, chunks: tuple[int, int], shards: tuple[int, int] | None) -> None: arr = zarr.create_array(store={}, shape=(8, 8), dtype="f8", chunks=chunks, shards=shards) result = arr.info expected = ArrayInfo( _zarr_format=3, _data_type=arr.async_array._zdtype, _fill_value=arr.fill_value, _shape=(8, 8), _chunk_shape=chunks, _shard_shape=shards, _order="C", _read_only=False, _store_type="MemoryStore", _compressors=(ZstdCodec(),), _serializer=BytesCodec(), _count_bytes=512, ) assert result == expected def test_info_complete(self, chunks: tuple[int, int], shards: tuple[int, int] | None) -> None: arr = zarr.create_array( store={}, shape=(8, 8), dtype="f8", chunks=chunks, shards=shards, compressors=(), ) result = arr.info_complete() expected = ArrayInfo( _zarr_format=3, _data_type=arr.async_array._zdtype, _fill_value=arr.fill_value, _shape=(8, 8), _chunk_shape=chunks, _shard_shape=shards, _order="C", _read_only=False, _store_type="MemoryStore", _serializer=BytesCodec(), _count_bytes=512, _count_chunks_initialized=0, _count_bytes_stored=521 if shards is None else 982, # the metadata? ) assert result == expected arr[:4, :4] = 10 result = arr.info_complete() if shards is None: expected = dataclasses.replace( expected, _count_chunks_initialized=4, _count_bytes_stored=649 ) else: expected = dataclasses.replace( expected, _count_chunks_initialized=1, _count_bytes_stored=1178 ) assert result == expected async def test_info_v2_async( self, chunks: tuple[int, int], shards: tuple[int, int] | None ) -> None: arr = await zarr.api.asynchronous.create_array( store={}, shape=(8, 8), dtype="f8", chunks=chunks, zarr_format=2 ) result = arr.info expected = ArrayInfo( _zarr_format=2, _data_type=Float64(), _fill_value=arr.metadata.fill_value, _shape=(8, 8), _chunk_shape=(2, 2), _shard_shape=None, _order="C", _read_only=False, _store_type="MemoryStore", _count_bytes=512, _compressors=(numcodecs.Zstd(),), ) assert result == expected async def test_info_v3_async( self, chunks: tuple[int, int], shards: tuple[int, int] | None ) -> None: arr = await zarr.api.asynchronous.create_array( store={}, shape=(8, 8), dtype="f8", chunks=chunks, shards=shards, ) result = arr.info expected = ArrayInfo( _zarr_format=3, _data_type=arr._zdtype, _fill_value=arr.metadata.fill_value, _shape=(8, 8), _chunk_shape=chunks, _shard_shape=shards, _order="C", _read_only=False, _store_type="MemoryStore", _compressors=(ZstdCodec(),), _serializer=BytesCodec(), _count_bytes=512, ) assert result == expected async def test_info_complete_async( self, chunks: tuple[int, int], shards: tuple[int, int] | None ) -> None: arr = await zarr.api.asynchronous.create_array( store={}, dtype="f8", shape=(8, 8), chunks=chunks, shards=shards, compressors=None, ) result = await arr.info_complete() expected = ArrayInfo( _zarr_format=3, _data_type=arr._zdtype, _fill_value=arr.metadata.fill_value, _shape=(8, 8), _chunk_shape=chunks, _shard_shape=shards, _order="C", _read_only=False, _store_type="MemoryStore", _serializer=BytesCodec(), _count_bytes=512, _count_chunks_initialized=0, _count_bytes_stored=521 if shards is None else 982, # the metadata? ) assert result == expected await arr.setitem((slice(4), slice(4)), 10) result = await arr.info_complete() if shards is None: expected = dataclasses.replace( expected, _count_chunks_initialized=4, _count_bytes_stored=553 ) else: expected = dataclasses.replace( expected, _count_chunks_initialized=1, _count_bytes_stored=1178 ) @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_resize_1d(store: MemoryStore, zarr_format: ZarrFormat) -> None: z = zarr.create( shape=105, chunks=10, dtype="i4", fill_value=0, store=store, zarr_format=zarr_format ) a = np.arange(105, dtype="i4") z[:] = a result = z[:] assert isinstance(result, NDArrayLike) assert (105,) == z.shape assert (105,) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10,) == z.chunks np.testing.assert_array_equal(a, result) z.resize(205) result = z[:] assert isinstance(result, NDArrayLike) assert (205,) == z.shape assert (205,) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10,) == z.chunks np.testing.assert_array_equal(a, z[:105]) np.testing.assert_array_equal(np.zeros(100, dtype="i4"), z[105:]) z.resize(55) result = z[:] assert isinstance(result, NDArrayLike) assert (55,) == z.shape assert (55,) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10,) == z.chunks np.testing.assert_array_equal(a[:55], result) # via shape setter new_shape = (105,) z.shape = new_shape result = z[:] assert isinstance(result, NDArrayLike) assert new_shape == z.shape assert new_shape == result.shape @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_resize_2d(store: MemoryStore, zarr_format: ZarrFormat) -> None: z = zarr.create( shape=(105, 105), chunks=(10, 10), dtype="i4", fill_value=0, store=store, zarr_format=zarr_format, ) a = np.arange(105 * 105, dtype="i4").reshape((105, 105)) z[:] = a result = z[:] assert isinstance(result, NDArrayLike) assert (105, 105) == z.shape assert (105, 105) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(a, result) z.resize((205, 205)) result = z[:] assert isinstance(result, NDArrayLike) assert (205, 205) == z.shape assert (205, 205) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(a, z[:105, :105]) np.testing.assert_array_equal(np.zeros((100, 205), dtype="i4"), z[105:, :]) np.testing.assert_array_equal(np.zeros((205, 100), dtype="i4"), z[:, 105:]) z.resize((55, 55)) result = z[:] assert isinstance(result, NDArrayLike) assert (55, 55) == z.shape assert (55, 55) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(a[:55, :55], result) z.resize((55, 1)) result = z[:] assert isinstance(result, NDArrayLike) assert (55, 1) == z.shape assert (55, 1) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(a[:55, :1], result) z.resize((1, 55)) result = z[:] assert isinstance(result, NDArrayLike) assert (1, 55) == z.shape assert (1, 55) == result.shape assert np.dtype("i4") == z.dtype assert np.dtype("i4") == result.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(a[:1, :10], z[:, :10]) np.testing.assert_array_equal(np.zeros((1, 55 - 10), dtype="i4"), z[:, 10:55]) # via shape setter new_shape = (105, 105) z.shape = new_shape result = z[:] assert isinstance(result, NDArrayLike) assert new_shape == z.shape assert new_shape == result.shape @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_resize_growing_skips_chunk_enumeration( store: MemoryStore, zarr_format: ZarrFormat ) -> None: """Growing an array should not enumerate chunk coords for deletion (#3650 mitigation).""" z = zarr.create( shape=(10, 10), chunks=(5, 5), dtype="i4", fill_value=0, store=store, zarr_format=zarr_format, ) z[:] = np.ones((10, 10), dtype="i4") grid_cls = type(z._chunk_grid) # growth only - ensure no chunk coords are enumerated with mock.patch.object( grid_cls, "all_chunk_coords", wraps=z._chunk_grid.all_chunk_coords, ) as mock_coords: z.resize((20, 20)) mock_coords.assert_not_called() assert z.shape == (20, 20) np.testing.assert_array_equal(np.ones((10, 10), dtype="i4"), z[:10, :10]) np.testing.assert_array_equal(np.zeros((10, 10), dtype="i4"), z[10:, 10:]) # shrink - ensure no regression of behaviour with mock.patch.object( grid_cls, "all_chunk_coords", wraps=z._chunk_grid.all_chunk_coords, ) as mock_coords: z.resize((5, 5)) assert mock_coords.call_count > 0 assert z.shape == (5, 5) np.testing.assert_array_equal(np.ones((5, 5), dtype="i4"), z[:]) # mixed: grow dim 0, shrink dim 1 - ensure deletion path runs z2 = zarr.create( shape=(10, 10), chunks=(5, 5), dtype="i4", fill_value=0, store=store, zarr_format=zarr_format, overwrite=True, ) z2[:] = np.ones((10, 10), dtype="i4") with mock.patch.object( grid_cls, "all_chunk_coords", wraps=z2._chunk_grid.all_chunk_coords, ) as mock_coords: z2.resize((20, 5)) assert mock_coords.call_count > 0 assert z2.shape == (20, 5) np.testing.assert_array_equal(np.ones((10, 5), dtype="i4"), z2[:10, :]) np.testing.assert_array_equal(np.zeros((10, 5), dtype="i4"), z2[10:, :]) @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_append_1d(store: MemoryStore, zarr_format: ZarrFormat) -> None: a = np.arange(105) z = zarr.create(shape=a.shape, chunks=10, dtype=a.dtype, store=store, zarr_format=zarr_format) z[:] = a assert a.shape == z.shape assert a.dtype == z.dtype assert (10,) == z.chunks np.testing.assert_array_equal(a, z[:]) b = np.arange(105, 205) e = np.append(a, b) assert z.shape == (105,) z.append(b) assert e.shape == z.shape assert e.dtype == z.dtype assert (10,) == z.chunks np.testing.assert_array_equal(e, z[:]) # check append handles array-like c = [1, 2, 3] f = np.append(e, c) z.append(c) assert f.shape == z.shape assert f.dtype == z.dtype assert (10,) == z.chunks np.testing.assert_array_equal(f, z[:]) @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_append_2d(store: MemoryStore, zarr_format: ZarrFormat) -> None: a = np.arange(105 * 105, dtype="i4").reshape((105, 105)) z = zarr.create( shape=a.shape, chunks=(10, 10), dtype=a.dtype, store=store, zarr_format=zarr_format ) z[:] = a assert a.shape == z.shape assert a.dtype == z.dtype assert (10, 10) == z.chunks actual = z[:] np.testing.assert_array_equal(a, actual) b = np.arange(105 * 105, 2 * 105 * 105, dtype="i4").reshape((105, 105)) e = np.append(a, b, axis=0) z.append(b) assert e.shape == z.shape assert e.dtype == z.dtype assert (10, 10) == z.chunks actual = z[:] np.testing.assert_array_equal(e, actual) @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_append_2d_axis(store: MemoryStore, zarr_format: ZarrFormat) -> None: a = np.arange(105 * 105, dtype="i4").reshape((105, 105)) z = zarr.create( shape=a.shape, chunks=(10, 10), dtype=a.dtype, store=store, zarr_format=zarr_format ) z[:] = a assert a.shape == z.shape assert a.dtype == z.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(a, z[:]) b = np.arange(105 * 105, 2 * 105 * 105, dtype="i4").reshape((105, 105)) e = np.append(a, b, axis=1) z.append(b, axis=1) assert e.shape == z.shape assert e.dtype == z.dtype assert (10, 10) == z.chunks np.testing.assert_array_equal(e, z[:]) @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_append_bad_shape(store: MemoryStore, zarr_format: ZarrFormat) -> None: a = np.arange(100) z = zarr.create(shape=a.shape, chunks=10, dtype=a.dtype, store=store, zarr_format=zarr_format) z[:] = a b = a.reshape(10, 10) with pytest.raises(ValueError): z.append(b) @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("write_empty_chunks", [True, False]) @pytest.mark.parametrize("fill_value", [0, 5]) def test_write_empty_chunks_behavior( zarr_format: ZarrFormat, store: MemoryStore, write_empty_chunks: bool, fill_value: int ) -> None: """ Check that the write_empty_chunks value of the config is applied correctly. We expect that when write_empty_chunks is True, writing chunks equal to the fill value will result in those chunks appearing in the store. When write_empty_chunks is False, writing chunks that are equal to the fill value will result in those chunks not being present in the store. In particular, they should be deleted if they were already present. """ arr = zarr.create_array( store=store, shape=(2,), zarr_format=zarr_format, dtype="i4", fill_value=fill_value, chunks=(1,), config={"write_empty_chunks": write_empty_chunks}, ) assert arr.async_array.config.write_empty_chunks == write_empty_chunks # initialize the store with some non-fill value chunks arr[:] = fill_value + 1 assert arr._nshards_initialized == arr._nshards arr[:] = fill_value if not write_empty_chunks: assert arr._nshards_initialized == 0 else: assert arr._nshards_initialized == arr._nshards @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("fill_value", [0.0, -0.0]) @pytest.mark.parametrize("dtype", ["f4", "f2"]) def test_write_empty_chunks_negative_zero( zarr_format: ZarrFormat, store: MemoryStore, fill_value: float, dtype: str ) -> None: # regression test for https://github.com/zarr-developers/zarr-python/issues/3144 arr = zarr.create_array( store=store, shape=(2,), zarr_format=zarr_format, dtype=dtype, fill_value=fill_value, chunks=(1,), config={"write_empty_chunks": False}, ) assert arr.nchunks_initialized == 0 # initialize the with the negated fill value (-0.0 for +0.0, +0.0 for -0.0) arr[:] = -fill_value assert arr.nchunks_initialized == arr.nchunks @pytest.mark.parametrize( ("fill_value", "expected"), [ (np.nan * 1j, ["NaN", "NaN"]), (np.nan, ["NaN", 0.0]), (np.inf, ["Infinity", 0.0]), (np.inf * 1j, ["NaN", "Infinity"]), (-np.inf, ["-Infinity", 0.0]), (math.inf, ["Infinity", 0.0]), ], ) async def test_special_complex_fill_values_roundtrip(fill_value: Any, expected: list[Any]) -> None: store = MemoryStore() zarr.create_array(store=store, shape=(1,), dtype=np.complex64, fill_value=fill_value) content = await store.get("zarr.json", prototype=default_buffer_prototype()) assert content is not None actual = json.loads(content.to_bytes()) assert actual["fill_value"] == expected @pytest.mark.parametrize("shape", [(1,), (2, 3), (4, 5, 6)]) @pytest.mark.parametrize("dtype", ["uint8", "float32"]) @pytest.mark.parametrize("array_type", ["async", "sync"]) async def test_nbytes( shape: tuple[int, ...], dtype: str, array_type: Literal["async", "sync"] ) -> None: """ Test that the ``nbytes`` attribute of an Array or AsyncArray correctly reports the capacity of the chunks of that array. """ store = MemoryStore() arr = zarr.create_array(store=store, shape=shape, dtype=dtype, fill_value=0) if array_type == "async": assert arr.async_array.nbytes == np.prod(arr.shape) * arr.dtype.itemsize else: assert arr.nbytes == np.prod(arr.shape) * arr.dtype.itemsize @pytest.mark.parametrize( ("array_shape", "chunk_shape", "target_shard_size_bytes", "expected_shards"), [ pytest.param( (256, 256), (32, 32), 129 * 129, (128, 128), id="2d_chunking_max_byes_does_not_evenly_divide", ), pytest.param( (256, 256), (32, 32), 64 * 64, (64, 64), id="2d_chunking_max_byes_evenly_divides" ), pytest.param( (256, 256), (64, 32), 128 * 128, (128, 64), id="2d_non_square_chunking_max_byes_evenly_divides", ), pytest.param((256,), (2,), 255, (254,), id="max_bytes_just_below_array_shape"), pytest.param((256,), (2,), 256, (256,), id="max_bytes_equal_to_array_shape"), pytest.param((256,), (2,), 16, (16,), id="max_bytes_normal_val"), pytest.param((256,), (2,), 2, (2,), id="max_bytes_same_as_chunk"), pytest.param((256,), (2,), 1, (2,), id="max_bytes_less_than_chunk"), pytest.param((256,), (2,), None, (4,), id="use_default_auto_setting"), pytest.param((4,), (2,), None, (2,), id="small_array_shape_does_not_shard"), ], ) def test_auto_partition_auto_shards( array_shape: tuple[int, ...], chunk_shape: tuple[int, ...], target_shard_size_bytes: int | None, expected_shards: tuple[int, ...], ) -> None: """ Test that automatically picking a shard size returns a tuple of 2 * the chunk shape for any axis where there are 8 or more chunks. """ dtype = np.dtype("uint8") chunks_normalized = normalize_chunks_nd(chunk_shape, array_shape) with pytest.warns( ZarrUserWarning, match="Automatic shard shape inference is experimental and may change without notice.", ): with zarr.config.set({"array.target_shard_size_bytes": target_shard_size_bytes}): outer_chunks, _ = resolve_outer_and_inner_chunks( array_shape=array_shape, chunks=chunks_normalized, shard_shape="auto", item_size=dtype.itemsize, ) auto_shards = tuple(dim[0] for dim in outer_chunks) assert auto_shards == expected_shards def test_auto_partition_auto_shards_with_auto_chunks_should_be_close_to_1MiB() -> None: """ Test that automatically picking chunk and shard sizes together produces chunks close to 1 MiB and shards that are a multiple of the chunk size. """ array_shape = (10_000_000,) item_size = 1 # Auto-chunks with sharding use the default inner chunk size target chunks_normalized = guess_chunks( array_shape, item_size, max_bytes=SHARDED_INNER_CHUNK_MAX_BYTES ) chunk_shape = tuple(dim[0] for dim in chunks_normalized) chunk_bytes = np.prod(chunk_shape) * item_size assert chunk_bytes <= SHARDED_INNER_CHUNK_MAX_BYTES assert chunk_bytes > SHARDED_INNER_CHUNK_MAX_BYTES // 4 # should be in the right ballpark with pytest.warns( ZarrUserWarning, match="Automatic shard shape inference is experimental and may change without notice.", ): with zarr.config.set({"array.target_shard_size_bytes": 10_000_000}): outer_chunks, inner = resolve_outer_and_inner_chunks( array_shape=array_shape, chunks=chunks_normalized, shard_shape="auto", item_size=item_size, ) assert inner is not None shard_shape = tuple(dim[0] for dim in outer_chunks) # Shard dimensions must be multiples of chunk dimensions assert all(s % c == 0 for s, c in zip(shard_shape, chunk_shape, strict=True)) def test_chunks_and_shards() -> None: store = StorePath(MemoryStore()) shape = (100, 100) chunks = (5, 5) shards = (10, 10) arr_v3 = zarr.create_array(store=store / "v3", shape=shape, chunks=chunks, dtype="i4") assert arr_v3.chunks == chunks assert arr_v3.shards is None arr_v3_sharding = zarr.create_array( store=store / "v3_sharding", shape=shape, chunks=chunks, shards=shards, dtype="i4", ) assert arr_v3_sharding.chunks == chunks assert arr_v3_sharding.shards == shards arr_v2 = zarr.create_array( store=store / "v2", shape=shape, chunks=chunks, zarr_format=2, dtype="i4" ) assert arr_v2.chunks == chunks assert arr_v2.shards is None @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize( ("dtype", "fill_value_expected"), [(" None: a = zarr.create_array(store, shape=(5,), chunks=(5,), dtype=dtype) assert a.fill_value == fill_value_expected @pytest.mark.parametrize("store", ["memory"], indirect=True) class TestCreateArray: @staticmethod def test_chunks_and_shards(store: Store) -> None: spath = StorePath(store) shape = (100, 100) chunks = (5, 5) shards = (10, 10) arr_v3 = zarr.create_array(store=spath / "v3", shape=shape, chunks=chunks, dtype="i4") assert arr_v3.chunks == chunks assert arr_v3.shards is None arr_v3_sharding = zarr.create_array( store=spath / "v3_sharding", shape=shape, chunks=chunks, shards=shards, dtype="i4", ) assert arr_v3_sharding.chunks == chunks assert arr_v3_sharding.shards == shards arr_v2 = zarr.create_array( store=spath / "v2", shape=shape, chunks=chunks, zarr_format=2, dtype="i4" ) assert arr_v2.chunks == chunks assert arr_v2.shards is None @staticmethod @pytest.mark.parametrize("dtype", zdtype_examples) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_default_fill_value(dtype: ZDType[Any, Any], store: Store) -> None: """ Test that the fill value of an array is set to the default value for the dtype object """ a = zarr.create_array(store, shape=(5,), chunks=(5,), dtype=dtype) if isinstance(dtype, DateTime64 | TimeDelta64) and np.isnat(a.fill_value): assert np.isnat(dtype.default_scalar()) else: assert a.fill_value == dtype.default_scalar() @staticmethod # @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.parametrize("dtype", zdtype_examples) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_default_fill_value_None( dtype: ZDType[Any, Any], store: Store, zarr_format: ZarrFormat ) -> None: """ Test that the fill value of an array is set to the default value for an explicit None argument for Zarr Format 3, and to null for Zarr Format 2 """ a = zarr.create_array( store, shape=(5,), chunks=(5,), dtype=dtype, fill_value=None, zarr_format=zarr_format ) if zarr_format == 3: if isinstance(dtype, DateTime64 | TimeDelta64) and np.isnat(a.fill_value): assert np.isnat(dtype.default_scalar()) else: assert a.fill_value == dtype.default_scalar() elif zarr_format == 2: assert a.fill_value is None @staticmethod @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("dtype", zdtype_examples) def test_dtype_forms(dtype: ZDType[Any, Any], store: Store, zarr_format: ZarrFormat) -> None: """ Test that the same array is produced from a ZDType instance, a numpy dtype, or a numpy string """ skip_object_dtype(dtype) a = zarr.create_array( store, name="a", shape=(5,), chunks=(5,), dtype=dtype, zarr_format=zarr_format ) b = zarr.create_array( store, name="b", shape=(5,), chunks=(5,), dtype=dtype.to_native_dtype(), zarr_format=zarr_format, ) assert a.dtype == b.dtype # Structured dtypes do not have a numpy string representation that uniquely identifies them if not isinstance(dtype, Structured): if isinstance(dtype, VariableLengthUTF8): # in numpy 2.3, StringDType().str becomes the string 'StringDType()' which numpy # does not accept as a string representation of the dtype. c = zarr.create_array( store, name="c", shape=(5,), chunks=(5,), dtype=dtype.to_native_dtype().char, zarr_format=zarr_format, ) else: c = zarr.create_array( store, name="c", shape=(5,), chunks=(5,), dtype=dtype.to_native_dtype().str, zarr_format=zarr_format, ) assert a.dtype == c.dtype @staticmethod @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("dtype", zdtype_examples) def test_dtype_roundtrip( dtype: ZDType[Any, Any], store: Store, zarr_format: ZarrFormat ) -> None: """ Test that creating an array, then opening it, gets the same array. """ skip_object_dtype(dtype) a = zarr.create_array(store, shape=(5,), chunks=(5,), dtype=dtype, zarr_format=zarr_format) b = zarr.open_array(store) assert a.dtype == b.dtype @staticmethod @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("dtype", ["uint8", "float32", "U3", "S4", "V1"]) @pytest.mark.parametrize( "compressors", [ "auto", None, (), (ZstdCodec(level=3),), (ZstdCodec(level=3), GzipCodec(level=0)), ZstdCodec(level=3), {"name": "zstd", "configuration": {"level": 3}}, ({"name": "zstd", "configuration": {"level": 3}},), ], ) @pytest.mark.parametrize( "filters", [ "auto", None, (), ( TransposeCodec( order=[ 0, ] ), ), ( TransposeCodec( order=[ 0, ] ), TransposeCodec( order=[ 0, ] ), ), TransposeCodec( order=[ 0, ] ), {"name": "transpose", "configuration": {"order": [0]}}, ({"name": "transpose", "configuration": {"order": [0]}},), ], ) @pytest.mark.parametrize(("chunks", "shards"), [((6,), None), ((3,), (6,))]) async def test_v3_chunk_encoding( store: MemoryStore, compressors: CompressorsLike, filters: FiltersLike, dtype: str, chunks: tuple[int, ...], shards: tuple[int, ...] | None, ) -> None: """ Test various possibilities for the compressors and filters parameter to create_array """ arr = await create_array( store=store, dtype=dtype, shape=(12,), chunks=chunks, shards=shards, zarr_format=3, filters=filters, compressors=compressors, ) filters_expected, _, compressors_expected = _parse_chunk_encoding_v3( filters=filters, compressors=compressors, serializer="auto", dtype=arr._zdtype, ) assert arr.filters == filters_expected assert arr.compressors == compressors_expected @staticmethod @pytest.mark.parametrize("name", ["v2", "default", "invalid"]) @pytest.mark.parametrize("separator", [".", "/"]) async def test_chunk_key_encoding( name: str, separator: Literal[".", "/"], zarr_format: ZarrFormat, store: MemoryStore ) -> None: chunk_key_encoding = ChunkKeyEncodingParams(name=name, separator=separator) # type: ignore[typeddict-item] error_msg = "" if name == "invalid": error_msg = r'Unknown chunk key encoding: "Chunk key encoding \'invalid\' not found in registered chunk key encodings: \[.*\]."' if zarr_format == 2 and name == "default": error_msg = "Invalid chunk key encoding. For Zarr format 2 arrays, the `name` field of the chunk key encoding must be 'v2'." if error_msg: with pytest.raises(ValueError, match=error_msg): arr = await create_array( store=store, dtype="uint8", shape=(10,), chunks=(1,), zarr_format=zarr_format, chunk_key_encoding=chunk_key_encoding, ) else: arr = await create_array( store=store, dtype="uint8", shape=(10,), chunks=(1,), zarr_format=zarr_format, chunk_key_encoding=chunk_key_encoding, ) if isinstance(arr.metadata, ArrayV2Metadata): assert arr.metadata.dimension_separator == separator @staticmethod @pytest.mark.parametrize( ("kwargs", "error_msg"), [ ({"serializer": "bytes"}, "Zarr format 2 arrays do not support `serializer`."), ({"dimension_names": ["test"]}, "Zarr format 2 arrays do not support dimension names."), ], ) async def test_create_array_invalid_v2_arguments( kwargs: dict[str, Any], error_msg: str, store: MemoryStore ) -> None: with pytest.raises(ValueError, match=re.escape(error_msg)): await zarr.api.asynchronous.create_array( store=store, dtype="uint8", shape=(10,), chunks=(1,), zarr_format=2, **kwargs ) @staticmethod @pytest.mark.parametrize( ("kwargs", "error_msg"), [ ( {"dimension_names": ["test"]}, "dimension_names cannot be used for arrays with zarr_format 2.", ), ( {"chunk_key_encoding": {"name": "default", "separator": "/"}}, "chunk_key_encoding cannot be used for arrays with zarr_format 2. Use dimension_separator instead.", ), ( {"codecs": "bytes"}, "codecs cannot be used for arrays with zarr_format 2. Use filters and compressor instead.", ), ], ) async def test_create_invalid_v2_arguments( kwargs: dict[str, Any], error_msg: str, store: MemoryStore ) -> None: with pytest.raises(ValueError, match=re.escape(error_msg)): await zarr.api.asynchronous.create( store=store, dtype="uint8", shape=(10,), chunks=(1,), zarr_format=2, **kwargs ) @staticmethod @pytest.mark.parametrize( ("kwargs", "error_msg"), [ ( {"chunk_shape": (1,), "chunks": (2,)}, "Only one of chunk_shape or chunks can be provided.", ), ( {"dimension_separator": "/"}, "dimension_separator cannot be used for arrays with zarr_format 3. Use chunk_key_encoding instead.", ), ( {"filters": []}, "filters cannot be used for arrays with zarr_format 3. Use array-to-array codecs instead", ), ( {"compressor": "blosc"}, "compressor cannot be used for arrays with zarr_format 3. Use bytes-to-bytes codecs instead", ), ], ) async def test_invalid_v3_arguments( kwargs: dict[str, Any], error_msg: str, store: MemoryStore ) -> None: kwargs.setdefault("chunks", (1,)) with pytest.raises(ValueError, match=re.escape(error_msg)): zarr.create(store=store, dtype="uint8", shape=(10,), zarr_format=3, **kwargs) @staticmethod @pytest.mark.parametrize("dtype", ["uint8", "float32", "str", "U10", "S10", ">M8[10s]"]) @pytest.mark.parametrize( "compressors", [ "auto", None, numcodecs.Zstd(level=3), (), (numcodecs.Zstd(level=3),), ], ) @pytest.mark.parametrize( "filters", ["auto", None, numcodecs.GZip(level=1), (numcodecs.GZip(level=1),)] ) async def test_v2_chunk_encoding( store: MemoryStore, compressors: CompressorsLike, filters: FiltersLike, dtype: str ) -> None: if dtype == "str" and filters != "auto": pytest.skip("Only the auto filters are compatible with str dtype in this test.") arr: AsyncArray[ArrayV2Metadata] = await create_array( store=store, dtype=dtype, shape=(10,), zarr_format=2, compressors=compressors, filters=filters, ) filters_expected, compressor_expected = _parse_chunk_encoding_v2( filters=filters, compressor=compressors, dtype=parse_dtype(dtype, zarr_format=2) ) assert arr.metadata.zarr_format == 2 # guard for mypy assert arr.metadata.compressor == compressor_expected assert arr.metadata.filters == filters_expected # Normalize for property getters arr_compressors_expected = () if compressor_expected is None else (compressor_expected,) arr_filters_expected = () if filters_expected is None else filters_expected assert arr.compressors == arr_compressors_expected assert arr.filters == arr_filters_expected @staticmethod @pytest.mark.parametrize("dtype", [UInt8(), Float32(), VariableLengthUTF8()]) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") async def test_default_filters_compressors( store: MemoryStore, dtype: UInt8 | Float32 | VariableLengthUTF8, zarr_format: ZarrFormat ) -> None: """ Test that the default ``filters`` and ``compressors`` are used when ``create_array`` is invoked with ``filters`` and ``compressors`` unspecified. """ arr = await create_array( store=store, dtype=dtype, # type: ignore[arg-type] shape=(10,), zarr_format=zarr_format, ) sig = inspect.signature(create_array) if zarr_format == 3: expected_filters, expected_serializer, expected_compressors = _parse_chunk_encoding_v3( compressors=sig.parameters["compressors"].default, filters=sig.parameters["filters"].default, serializer=sig.parameters["serializer"].default, dtype=dtype, # type: ignore[arg-type] ) elif zarr_format == 2: default_filters, default_compressors = _parse_chunk_encoding_v2( compressor=sig.parameters["compressors"].default, filters=sig.parameters["filters"].default, dtype=dtype, # type: ignore[arg-type] ) if default_filters is None: expected_filters = () else: expected_filters = default_filters # type: ignore[assignment] if default_compressors is None: expected_compressors = () else: expected_compressors = (default_compressors,) # type: ignore[assignment] expected_serializer = None else: raise ValueError(f"Invalid zarr_format: {zarr_format}") assert arr.filters == expected_filters assert arr.serializer == expected_serializer assert arr.compressors == expected_compressors @staticmethod async def test_v2_no_shards(store: Store) -> None: """ Test that creating a Zarr v2 array with ``shard_shape`` set to a non-None value raises an error. """ msg = re.escape( "Zarr format 2 arrays can only be created with `shard_shape` set to `None`. Got `shard_shape=(5,)` instead." ) with pytest.raises(ValueError, match=msg): _ = await create_array( store=store, dtype="uint8", shape=(10,), shards=(5,), zarr_format=2, ) @staticmethod @pytest.mark.parametrize("impl", ["sync", "async"]) async def test_with_data(impl: Literal["sync", "async"], store: Store) -> None: """ Test that we can invoke ``create_array`` with a ``data`` parameter. """ data = np.arange(10) name = "foo" arr: AnyAsyncArray | AnyArray if impl == "sync": arr = sync_api.create_array(store, name=name, data=data) stored = arr[:] elif impl == "async": arr = await create_array(store, name=name, data=data, zarr_format=3) stored = await arr._get_selection( BasicIndexer(..., shape=arr.shape, chunk_grid=arr._chunk_grid), prototype=default_buffer_prototype(), ) else: raise ValueError(f"Invalid impl: {impl}") assert np.array_equal(stored, data) @staticmethod async def test_with_data_invalid_params(store: Store) -> None: """ Test that failing to specify data AND shape / dtype results in a ValueError """ with pytest.raises(ValueError, match="shape was not specified"): await create_array(store, data=None, shape=None, dtype=None) # we catch shape=None first, so specifying a dtype should raise the same exception as before with pytest.raises(ValueError, match="shape was not specified"): await create_array(store, data=None, shape=None, dtype="uint8") with pytest.raises(ValueError, match="dtype was not specified"): await create_array(store, data=None, shape=(10, 10)) @staticmethod async def test_data_ignored_params(store: Store) -> None: """ Test that specifying data AND shape AND dtype results in a ValueError """ data = np.arange(10) with pytest.raises( ValueError, match="The data parameter was used, but the shape parameter was also used." ): await create_array(store, data=data, shape=data.shape, dtype=None, overwrite=True) # we catch shape first, so specifying a dtype should raise the same warning as before with pytest.raises( ValueError, match="The data parameter was used, but the shape parameter was also used." ): await create_array(store, data=data, shape=data.shape, dtype=data.dtype, overwrite=True) with pytest.raises( ValueError, match="The data parameter was used, but the dtype parameter was also used." ): await create_array(store, data=data, shape=None, dtype=data.dtype, overwrite=True) @staticmethod @pytest.mark.parametrize("write_empty_chunks", [True, False]) async def test_write_empty_chunks_config(write_empty_chunks: bool, store: Store) -> None: """ Test that the value of write_empty_chunks is sensitive to the global config when not set explicitly """ with zarr.config.set({"array.write_empty_chunks": write_empty_chunks}): arr = await create_array(store, shape=(2, 2), dtype="i4") assert arr.config.write_empty_chunks == write_empty_chunks @staticmethod @pytest.mark.parametrize("path", [None, "", "/", "/foo", "foo", "foo/bar"]) async def test_name(store: Store, zarr_format: ZarrFormat, path: str | None) -> None: arr = await create_array( store, shape=(2, 2), dtype="i4", name=path, zarr_format=zarr_format ) if path is None: expected_path = "" elif path.startswith("/"): expected_path = path.lstrip("/") else: expected_path = path assert arr.path == expected_path assert arr.name == f"/{expected_path}" # test that implicit groups were created path_parts = expected_path.split("/") if len(path_parts) > 1: *parents, _ = ["", *accumulate(path_parts, lambda x, y: "/".join([x, y]))] # noqa: FLY002 for parent_path in parents: # this will raise if these groups were not created _ = await zarr.api.asynchronous.open_group( store=store, path=parent_path, zarr_format=zarr_format ) @staticmethod @pytest.mark.parametrize("endianness", ENDIANNESS_STR) def test_default_endianness( store: Store, zarr_format: ZarrFormat, endianness: EndiannessStr ) -> None: """ Test that endianness is correctly set when creating an array when not specifying a serializer. """ dtype = Int16(endianness=endianness) arr = zarr.create_array(store=store, shape=(1,), dtype=dtype, zarr_format=zarr_format) byte_order: str = arr[:].dtype.byteorder # type: ignore[union-attr] assert byte_order in NUMPY_ENDIANNESS_STR assert endianness_from_numpy_str(byte_order) == endianness # type: ignore[arg-type] # The explicit id for b"a" avoids colliding with the auto-generated id for "a". @pytest.mark.parametrize("value", [1, 1.4, "a", pytest.param(b"a", id="a-bytes"), np.array(1)]) @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_scalar_array(value: Any, zarr_format: ZarrFormat) -> None: arr = zarr.array(value, zarr_format=zarr_format) assert arr[...] == value assert arr.shape == () assert arr.ndim == 0 assert isinstance(arr[()], NDArrayLikeOrScalar) @pytest.mark.parametrize("store", ["local"], indirect=True) @pytest.mark.parametrize("store2", ["local"], indirect=["store2"]) @pytest.mark.parametrize("src_format", [2, 3]) @pytest.mark.parametrize("new_format", [2, 3, None]) async def test_creation_from_other_zarr_format( store: Store, store2: Store, src_format: ZarrFormat, new_format: ZarrFormat | None, ) -> None: if src_format == 2: src = zarr.create( (50, 50), chunks=(10, 10), store=store, zarr_format=src_format, dimension_separator="/" ) else: src = zarr.create( (50, 50), chunks=(10, 10), store=store, zarr_format=src_format, chunk_key_encoding=("default", "."), ) src[:] = np.arange(50 * 50).reshape((50, 50)) result = zarr.from_array( store=store2, data=src, zarr_format=new_format, ) np.testing.assert_array_equal(result[:], src[:]) assert result.fill_value == src.fill_value assert result.dtype == src.dtype assert result.chunks == src.chunks expected_format = src_format if new_format is None else new_format assert result.metadata.zarr_format == expected_format if src_format == new_format: assert result.metadata == src.metadata result2 = zarr.array( data=src, store=store2, overwrite=True, zarr_format=new_format, ) np.testing.assert_array_equal(result2[:], src[:]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=True) @pytest.mark.parametrize("store2", ["local", "memory", "zip"], indirect=["store2"]) @pytest.mark.parametrize("src_chunks", [(40, 10), (11, 50)]) @pytest.mark.parametrize("new_chunks", [(40, 10), (11, 50)]) async def test_from_array( store: Store, store2: Store, src_chunks: tuple[int, int], new_chunks: tuple[int, int], zarr_format: ZarrFormat, ) -> None: src_fill_value = 2 src_dtype = np.dtype("uint8") src_attributes = None src = zarr.create( (100, 10), chunks=src_chunks, dtype=src_dtype, store=store, fill_value=src_fill_value, attributes=src_attributes, ) src[:] = np.arange(1000).reshape((100, 10)) new_fill_value = 3 new_attributes: dict[str, JSON] = {"foo": "bar"} result = zarr.from_array( data=src, store=store2, chunks=new_chunks, fill_value=new_fill_value, attributes=new_attributes, ) np.testing.assert_array_equal(result[:], src[:]) assert result.fill_value == new_fill_value assert result.dtype == src_dtype assert result.attrs == new_attributes assert result.chunks == new_chunks @pytest.mark.parametrize("store", ["local"], indirect=True) @pytest.mark.parametrize("chunks", ["keep", "auto"]) @pytest.mark.parametrize("write_data", [True, False]) @pytest.mark.parametrize( "src", [ np.arange(1000).reshape(10, 10, 10), zarr.ones((10, 10, 10)), 5, [1, 2, 3], [[1, 2, 3], [4, 5, 6]], ], ) # add other npt.ArrayLike? async def test_from_array_arraylike( store: Store, chunks: Literal["auto", "keep"] | tuple[int, int], write_data: bool, src: AnyArray | npt.ArrayLike, ) -> None: fill_value = 42 result = zarr.from_array( store, data=src, chunks=chunks, write_data=write_data, fill_value=fill_value ) if write_data: np.testing.assert_array_equal(result[...], np.array(src)) else: np.testing.assert_array_equal(result[...], np.full_like(src, fill_value)) def test_from_array_F_order() -> None: arr = zarr.create_array(store={}, data=np.array([1]), order="F", zarr_format=2) with pytest.warns( ZarrUserWarning, match="The existing order='F' of the source Zarr format 2 array will be ignored.", ): zarr.from_array(store={}, data=arr, zarr_format=3) async def test_orthogonal_set_total_slice() -> None: """Ensure that a whole chunk overwrite does not read chunks""" store = MemoryStore() array = zarr.create_array(store, shape=(20, 20), chunks=(1, 2), dtype=int, fill_value=-1) with mock.patch("zarr.storage.MemoryStore.get", side_effect=RuntimeError): array[0, slice(4, 10)] = np.arange(6) array = zarr.create_array( store, shape=(20, 21), chunks=(1, 2), dtype=int, fill_value=-1, overwrite=True ) with mock.patch("zarr.storage.MemoryStore.get", side_effect=RuntimeError): array[0, :] = np.arange(21) with mock.patch("zarr.storage.MemoryStore.get", side_effect=RuntimeError): array[:] = 1 @pytest.mark.skipif( Version(numcodecs.__version__) < Version("0.15.1"), reason="codec configuration is overwritten on older versions. GH2800", ) def test_roundtrip_numcodecs() -> None: store = MemoryStore() compressors = [ {"name": "numcodecs.shuffle", "configuration": {"elementsize": 2}}, {"name": "numcodecs.zlib", "configuration": {"level": 4}}, ] filters: list[CodecJSON_V3] = [ { "name": "numcodecs.fixedscaleoffset", "configuration": { "scale": 100.0, "offset": 0.0, "dtype": " Any: return arr[index] @pytest.mark.parametrize( "method", [ pytest.param( "fork", marks=[ pytest.mark.skipif( sys.platform in ("win32", "darwin"), reason="fork not supported on Windows or OSX", ), # Python 3.15 deprecates fork() in multi-threaded processes, and zarr's # sync event-loop thread is always running here. Fork-safety despite # those threads is exactly what this test pins down, so keep running it. pytest.mark.filterwarnings( r"ignore:This process \(pid=\d+\) is multi-threaded, use of fork\(\):DeprecationWarning" ), ], ), "spawn", pytest.param( "forkserver", marks=pytest.mark.skipif( sys.platform == "win32", reason="forkserver not supported on Windows" ), ), ], ) @pytest.mark.parametrize("store", ["local"], indirect=True) @pytest.mark.parametrize("shards", [None, (20,)]) def test_multiprocessing( store: Store, method: Literal["fork", "spawn", "forkserver"], shards: tuple[int, ...] | None ) -> None: """ Test that arrays can be pickled and indexed in child processes """ data = np.arange(100) chunks: Literal["auto"] | tuple[int, ...] if shards is None: chunks = "auto" else: chunks = (1,) arr = zarr.create_array(store=store, data=data, shards=shards, chunks=chunks) ctx = mp.get_context(method) with ctx.Pool() as pool: results = pool.starmap(_index_array, [(arr, slice(len(data)))]) assert all(np.array_equal(r, data) for r in results) def test_create_array_method_signature() -> None: """ Test that the signature of the ``AsyncGroup.create_array`` function has nearly the same signature as the ``create_array`` function. ``AsyncGroup.create_array`` should take all of the same keyword arguments as ``create_array`` except ``store``. """ base_sig = inspect.signature(create_array) meth_sig = inspect.signature(AsyncGroup.create_array) # ignore keyword arguments that are either missing or have different semantics when # create_array is invoked as a group method ignore_kwargs = {"zarr_format", "store", "name"} # TODO: make this test stronger. right now, it only checks that all the parameters in the # function signature are used in the method signature. we can be more strict and check that # the method signature uses no extra parameters. base_params = dict(filter(lambda kv: kv[0] not in ignore_kwargs, base_sig.parameters.items())) assert (set(base_params.items()) - set(meth_sig.parameters.items())) == set() async def test_sharding_coordinate_selection() -> None: store = MemoryStore() g = zarr.open_group(store, mode="w") arr = g.create_array( name="a", shape=(2, 3, 4), chunks=(1, 2, 2), overwrite=True, dtype=np.float32, shards=(2, 4, 4), ) arr[:] = np.arange(2 * 3 * 4).reshape((2, 3, 4)) result = arr[1, [0, 1]] # type: ignore[index] assert isinstance(result, NDArrayLike) assert (result == np.array([[12, 13, 14, 15], [16, 17, 18, 19]])).all() @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_array_repr(store: Store) -> None: shape = (2, 3, 4) dtype = "uint8" arr = zarr.create_array(store, shape=shape, dtype=dtype) assert str(arr) == f"" class UnknownObjectCodecDtype(VariableLengthUTF8): """A data type that requires an object codec with an unknown id, used for error-path tests.""" object_codec_id = "unknown" # type: ignore[assignment] @pytest.mark.parametrize( "dtype", [VariableLengthUTF8(), VariableLengthBytes(), UnknownObjectCodecDtype()] ) def test_chunk_encoding_no_object_codec_errors(dtype: ZDType[Any, Any]) -> None: """ Test that a valuerror is raised when checking the chunk encoding for a v2 array with a data type that requires an object codec, but where no object codec is specified """ if isinstance(dtype, VariableLengthUTF8): codec_name = "the numcodecs.VLenUTF8 codec" elif isinstance(dtype, VariableLengthBytes): codec_name = "the numcodecs.VLenBytes codec" else: codec_name = f"an unknown object codec with id {dtype.object_codec_id!r}" # type: ignore[attr-defined] msg = ( f"Data type {dtype} requires {codec_name}, " "but no such codec was specified in the filters or compressor parameters for " "this array. " ) with pytest.raises(ValueError, match=re.escape(msg)): _parse_chunk_encoding_v2(filters=None, compressor=None, dtype=dtype) def test_unknown_object_codec_default_serializer_v3() -> None: """ Test that we get a valueerrror when trying to create the default serializer for a data type that requires an unknown object codec """ dtype = UnknownObjectCodecDtype() msg = f"Data type {dtype} requires an unknown object codec: {dtype.object_codec_id!r}." with pytest.raises(ValueError, match=re.escape(msg)): default_serializer_v3(dtype) def test_unknown_object_codec_default_filters_v2() -> None: """ Test that we get a valueerrror when trying to create the default serializer for a data type that requires an unknown object codec """ dtype = UnknownObjectCodecDtype() msg = f"Data type {dtype} requires an unknown object codec: {dtype.object_codec_id!r}." with pytest.raises(ValueError, match=re.escape(msg)): default_filters_v2(dtype) @pytest.mark.parametrize( ("array_shape", "shard_shape", "chunk_shape"), [ ((10,), None, (1,)), ((10,), (1,), (1,)), ((30, 10), None, (2, 5)), ((30, 10), (4, 10), (2, 5)), ], ) def test_chunk_grid_shape( array_shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], zarr_format: ZarrFormat, ) -> None: """ Test that the shape of the chunk grid and the shard grid are correctly indicated """ if zarr_format == 2 and shard_shape is not None: with pytest.raises( ValueError, match="Zarr format 2 arrays can only be created with `shard_shape` set to `None`.", ): arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) pytest.skip("Zarr format 2 arrays can only be created with `shard_shape` set to `None`.") else: arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) chunk_grid_shape = tuple(starmap(ceildiv, zip(array_shape, chunk_shape, strict=True))) if shard_shape is None: _shard_shape = chunk_shape else: _shard_shape = shard_shape shard_grid_shape = tuple(starmap(ceildiv, zip(array_shape, _shard_shape, strict=True))) assert arr._chunk_grid_shape == chunk_grid_shape assert arr.cdata_shape == chunk_grid_shape assert arr.async_array.cdata_shape == chunk_grid_shape assert arr._shard_grid_shape == shard_grid_shape assert arr._nshards == np.prod(shard_grid_shape) @pytest.mark.parametrize( ("array_shape", "shard_shape", "chunk_shape"), [((10,), None, (1,)), ((30, 10), None, (2, 5))] ) def test_iter_chunk_coords( array_shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], zarr_format: ZarrFormat, ) -> None: """ Test that we can use the various invocations of iter_chunk_coords to iterate over the coordinates of the origin of each chunk. """ arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) expected = tuple(_iter_grid(arr._shard_grid_shape)) observed = tuple(_iter_chunk_coords(arr)) assert observed == expected assert observed == tuple(arr._iter_chunk_coords()) assert observed == tuple(arr.async_array._iter_chunk_coords()) @pytest.mark.parametrize( ("array_shape", "shard_shape", "chunk_shape"), [((10,), (1,), (1,)), ((10,), None, (1,)), ((30, 10), (10, 5), (2, 5))], ) def test_iter_shard_coords( array_shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], zarr_format: ZarrFormat, ) -> None: """ Test that we can use the various invocations of iter_shard_coords to iterate over the coordinates of the origin of each shard. """ if zarr_format == 2 and shard_shape is not None: pytest.skip("Zarr format 2 does not support shard shape.") arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) expected = tuple(_iter_grid(arr._shard_grid_shape)) observed = tuple(_iter_shard_coords(arr)) assert observed == expected assert observed == tuple(arr._iter_shard_coords()) assert observed == tuple(arr.async_array._iter_shard_coords()) @pytest.mark.parametrize( ("array_shape", "shard_shape", "chunk_shape"), [((10,), (1,), (1,)), ((10,), None, (1,)), ((30, 10), (10, 5), (2, 5))], ) def test_iter_shard_keys( array_shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], zarr_format: ZarrFormat, ) -> None: """ Test that we can use the various invocations of iter_shard_keys to iterate over the stored keys of the shards of an array. """ if zarr_format == 2 and shard_shape is not None: pytest.skip("Zarr format 2 does not support shard shape.") arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) expected = tuple( arr.metadata.encode_chunk_key(key) for key in _iter_grid(arr._shard_grid_shape) ) observed = tuple(_iter_shard_keys(arr)) assert observed == expected assert observed == tuple(arr._iter_shard_keys()) assert observed == tuple(arr.async_array._iter_shard_keys()) @pytest.mark.parametrize( ("array_shape", "shard_shape", "chunk_shape"), [((10,), None, (1,)), ((10,), (1,), (1,)), ((30, 10), (10, 5), (2, 5))], ) def test_iter_shard_regions( array_shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], zarr_format: ZarrFormat, ) -> None: """ Test that we can use the various invocations of iter_shard_regions to iterate over the regions spanned by the shards of an array. """ if zarr_format == 2 and shard_shape is not None: pytest.skip("Zarr format 2 does not support shard shape.") arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) if shard_shape is None: _shard_shape = chunk_shape else: _shard_shape = shard_shape expected = tuple(_iter_regions(arr.shape, _shard_shape)) observed = tuple(_iter_shard_regions(arr)) assert observed == expected assert observed == tuple(arr._iter_shard_regions()) assert observed == tuple(arr.async_array._iter_shard_regions()) @pytest.mark.parametrize( ("array_shape", "shard_shape", "chunk_shape"), [((10,), None, (1,)), ((30, 10), None, (2, 5))] ) def test_iter_chunk_regions( array_shape: tuple[int, ...], shard_shape: tuple[int, ...] | None, chunk_shape: tuple[int, ...], zarr_format: ZarrFormat, ) -> None: """ Test that we can use the various invocations of iter_chunk_regions to iterate over the regions spanned by the chunks of an array. """ arr = zarr.create_array( {}, dtype="uint8", shape=array_shape, chunks=chunk_shape, shards=shard_shape, zarr_format=zarr_format, ) expected = tuple(_iter_regions(arr.shape, chunk_shape)) observed = tuple(_iter_chunk_regions(arr)) assert observed == expected assert observed == tuple(arr._iter_chunk_regions()) assert observed == tuple(arr.async_array._iter_chunk_regions()) @pytest.mark.parametrize("num_shards", [1, 3]) @pytest.mark.parametrize("array_type", ["numpy", "zarr"]) def test_create_array_with_data_num_gets( num_shards: int, array_type: Literal["numpy", "zarr"] ) -> None: """ Test that creating an array with data only invokes a single get request per stored object """ store = LoggingStore(store=MemoryStore()) chunk_shape = (1,) shard_shape = (100,) shape = (shard_shape[0] * num_shards,) data: AnyArray | npt.NDArray[np.int64] if array_type == "numpy": data = np.zeros(shape[0], dtype="int64") else: data = zarr.zeros(shape, dtype="int64") zarr.create_array(store, data=data, chunks=chunk_shape, shards=shard_shape, fill_value=-1) # type: ignore[arg-type] # One get for the metadata; full-shard writes should not read shard payloads. assert store.counter["get"] == 1 @pytest.mark.parametrize( ("selection", "expected_gets"), [(slice(None), 0), (slice(1, 9), 1)], ) def test_shard_write_num_gets(selection: slice, expected_gets: int) -> None: """ Test that partial-shard writes read the existing data and full-shard writes don't. """ store = LoggingStore(store=MemoryStore()) arr = zarr.create_array( store, shape=(10,), chunks=(1,), shards=(10,), dtype="int64", fill_value=-1, ) arr[:] = 0 store.counter.clear() arr[selection] = 1 assert store.counter["get"] == expected_gets @pytest.mark.parametrize("config", [{}, {"write_empty_chunks": True}, {"order": "C"}]) def test_with_config(config: ArrayConfigParams) -> None: """ Test that `AsyncArray.with_config` and `Array.with_config` create a copy of the source array with a new runtime configuration. """ # the config we start with source_config: ArrayConfigParams = {"write_empty_chunks": False, "order": "F"} source_array = zarr.create_array({}, shape=(1,), dtype="uint8", config=source_config) new_async_array_config_dict = source_array._async_array.with_config(config).config.to_dict() new_array_config_dict = source_array.with_config(config).config.to_dict() for key in source_config: if key in config: assert new_async_array_config_dict[key] == config[key] # type: ignore[literal-required] assert new_array_config_dict[key] == config[key] # type: ignore[literal-required] else: assert new_async_array_config_dict[key] == source_config[key] # type: ignore[literal-required] assert new_array_config_dict[key] == source_config[key] # type: ignore[literal-required] def test_with_config_polymorphism() -> None: """ Test that `AsyncArray.with_config` and `Array.with_config` accept dicts and full array config objects. """ source_config: ArrayConfig = ArrayConfig.from_dict({"write_empty_chunks": False, "order": "F"}) source_config_dict = source_config.to_dict() arr = zarr.create_array({}, shape=(1,), dtype="uint8") arr_source_config = arr.with_config(source_config) arr_source_config_dict = arr.with_config(source_config_dict) assert arr_source_config.config == arr_source_config_dict.config @pytest.mark.parametrize( ("chunk_input", "expected"), [ (-1, ((10,),)), ((-1,), ((10,),)), ((10,), ((10,),)), ((5,), ((5, 5),)), ((3,), ((3, 3, 3, 1),)), ], ids=["scalar-neg1", "tuple-neg1", "exact", "half", "remainder"], ) async def test_create_array_chunks_1d( chunk_input: int | tuple[int, ...], expected: tuple[tuple[int, ...], ...], ) -> None: """Test that chunk normalization produces the expected chunk sizes for 1D arrays.""" arr = await create_array(store={}, shape=(10,), chunks=chunk_input, dtype="uint8") assert arr.write_chunk_sizes == expected @pytest.mark.parametrize( ("chunk_input", "expected"), [ (-1, ((10,), (12,), (15,))), ((3, 4, 5), ((3, 3, 3, 1), (4, 4, 4), (5, 5, 5))), ((-1, 4, -1), ((10,), (4, 4, 4), (15,))), ((10, 12, 15), ((10,), (12,), (15,))), ((7, 3, 2), ((7, 3), (3, 3, 3, 3), (2, 2, 2, 2, 2, 2, 2, 1))), ], ids=["all-neg1", "mixed", "neg1-middle", "exact", "remainder"], ) async def test_create_array_chunks_3d( chunk_input: int | tuple[int, ...], expected: tuple[tuple[int, ...], ...], ) -> None: """Test that chunk normalization produces the expected chunk sizes for 3D arrays.""" shape = (10, 12, 15) arr = await create_array(store={}, shape=shape, chunks=chunk_input, dtype="float64") assert arr.write_chunk_sizes == expected zarr-python-3.3.0/tests/test_array_spec.py000066400000000000000000000143351523267620000207260ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Any import numpy as np import pytest from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import BufferPrototype, default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer from zarr.core.dtype import get_data_type_from_native_dtype if TYPE_CHECKING: from collections.abc import Callable from zarr.core.common import MemoryOrder def _make_spec( *, shape: tuple[int, ...] = (4, 4), native_dtype: Any = "int16", fill_value: Any = 0, order: MemoryOrder = "C", write_empty_chunks: bool = False, prototype: BufferPrototype | None = None, ) -> ArraySpec: """Creates an ArraySpec with common defaults""" zdtype = get_data_type_from_native_dtype(np.dtype(native_dtype)) fill_value = zdtype.cast_scalar(fill_value) # mirrors ArrayV3Metadata's fill_value return ArraySpec( shape=shape, dtype=zdtype, fill_value=fill_value, config=ArrayConfig(order=order, write_empty_chunks=write_empty_chunks), prototype=prototype if prototype is not None else default_buffer_prototype(), ) class _AltNDBuffer(NDBuffer): """A distinct NDBuffer subclass""" _ALT_PROTOTYPE = BufferPrototype( buffer=default_buffer_prototype().buffer, nd_buffer=_AltNDBuffer, ) # a distinct BufferPrototype with a different nd_buffer subclass # Difficult / important cases: # issue #3054: np.void is unhashable when writeable # nan/NaT aren't self-equal yet must compare equal for a ArraySpec SPECS = [ pytest.param({"native_dtype": "int16", "fill_value": 7}, id="int16"), pytest.param({"native_dtype": "float64", "fill_value": 1.5}, id="float64"), pytest.param({"native_dtype": "float64", "fill_value": float("nan")}, id="float64-nan"), pytest.param({"native_dtype": "float64", "fill_value": -0.0}, id="float64-negzero"), pytest.param({"native_dtype": "complex128", "fill_value": 1 + 2j}, id="complex128"), pytest.param( {"native_dtype": "complex128", "fill_value": complex(-0.0, -0.0)}, id="complex128-negzero", ), pytest.param({"native_dtype": "bool", "fill_value": True}, id="bool"), pytest.param( {"native_dtype": "datetime64[s]", "fill_value": np.datetime64("2020-01-01")}, id="datetime64", ), pytest.param( {"native_dtype": "datetime64[s]", "fill_value": np.datetime64("NaT", "s")}, id="datetime64-NaT", ), pytest.param( {"native_dtype": [("a", "f8"), ("b", "i8")], "fill_value": (1.0, 2)}, id="structured-void", ), pytest.param({"native_dtype": "U5", "fill_value": "hello"}, id="fixed-string"), pytest.param({"shape": ()}, id="scalar-shape"), pytest.param({"shape": (0,)}, id="zero-size"), pytest.param({"order": "F"}, id="order-F"), ] # Mutations: each mutate kwargs to an unequal version def _grow_shape(kw: dict[str, Any]) -> dict[str, Any]: return {"shape": (*kw.get("shape", (4, 4)), 1)} def _flip_order(kw: dict[str, Any]) -> dict[str, Any]: return {"order": "F" if kw.get("order", "C") == "C" else "C"} def _swap_prototype(_kw: dict[str, Any]) -> dict[str, Any]: return {"prototype": _ALT_PROTOTYPE} MUTATIONS = [ pytest.param(_grow_shape, id="shape"), pytest.param(_flip_order, id="order"), pytest.param(_swap_prototype, id="prototype"), ] @pytest.mark.parametrize("kwargs", SPECS) def test_hashable(kwargs: dict[str, Any]) -> None: """Every ArraySpec is hashable, including structured (np.void) fill values.""" assert isinstance(hash(_make_spec(**kwargs)), int) @pytest.mark.parametrize("kwargs", SPECS) def test_equal_specs_hash_equal(kwargs: dict[str, Any]) -> None: """Independently built specs with identical fields are equal and hash equal.""" a = _make_spec(**kwargs) b = _make_spec(**kwargs) assert a == b assert hash(a) == hash(b) @pytest.mark.parametrize("kwargs", SPECS) @pytest.mark.parametrize("mutate", MUTATIONS) def test_distinct_specs_unequal( mutate: Callable[[dict[str, Any]], dict[str, Any]], kwargs: dict[str, Any], ) -> None: """Changing one dtype-independent field makes a spec unequal to its base.""" base = _make_spec(**kwargs) variant = _make_spec(**{**kwargs, **mutate(kwargs)}) assert base != variant @pytest.mark.parametrize( ("base", "variant"), [ pytest.param({"fill_value": 0}, {"fill_value": 1}, id="fill_value"), pytest.param({"native_dtype": "int16"}, {"native_dtype": "int32"}, id="dtype"), pytest.param( {"native_dtype": "float32", "fill_value": 1.0}, {"native_dtype": "float64", "fill_value": 1.0}, id="dtype-float-promote", ), ], ) def test_dtype_and_fill_value_matter(base: dict[str, Any], variant: dict[str, Any]) -> None: """dtype and fill_value participate in equality; they can't join the cross product because fill_value is coupled to dtype.""" assert _make_spec(**base) != _make_spec(**variant) @pytest.mark.parametrize( ("native_dtype", "neg_fill", "pos_fill"), [ pytest.param("float16", -0.0, 0.0, id="float16"), pytest.param("float32", -0.0, 0.0, id="float32"), pytest.param("float64", -0.0, 0.0, id="float64"), pytest.param("complex128", complex(-0.0, -0.0), 0j, id="complex128-both"), pytest.param("complex128", complex(0.0, -0.0), 0j, id="complex128-imag"), pytest.param("complex128", complex(-0.0, 0.0), 0j, id="complex128-real"), pytest.param([("a", "f8")], (-0.0,), (0.0,), id="structured"), ], ) def test_signed_zero_fills_are_distinct(native_dtype: Any, neg_fill: Any, pos_fill: Any) -> None: """A -0.0 fill writes different bytes than +0.0, so the specs are not equal.""" neg = _make_spec(native_dtype=native_dtype, fill_value=neg_fill) pos = _make_spec(native_dtype=native_dtype, fill_value=pos_fill) assert neg != pos @pytest.mark.parametrize( ("obj"), [ pytest.param(None, id="None"), pytest.param(42, id="int"), pytest.param("hello", id="str"), pytest.param([1, 2, 3], id="list"), pytest.param({"a": 1}, id="dict"), ], ) def test_unequal_with_invalid_type(obj: Any) -> None: assert (_make_spec() == obj) is False assert _make_spec() != obj zarr-python-3.3.0/tests/test_attributes.py000066400000000000000000000053331523267620000207620ustar00rootroot00000000000000import json from typing import TYPE_CHECKING, Any import numpy as np import pytest import zarr.core import zarr.core.attributes import zarr.storage from tests.conftest import deep_nan_equal from zarr.core.common import ZarrFormat if TYPE_CHECKING: from zarr.types import AnyArray @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.parametrize( "data", [{"inf": np.inf, "-inf": -np.inf, "nan": np.nan}, {"a": 3, "c": 4}] ) def test_put(data: dict[str, Any], zarr_format: ZarrFormat) -> None: store = zarr.storage.MemoryStore() attrs = zarr.core.attributes.Attributes(zarr.Group.from_store(store, zarr_format=zarr_format)) attrs.put(data) expected = json.loads(json.dumps(data, allow_nan=True)) assert deep_nan_equal(dict(attrs), expected) def test_asdict() -> None: store = zarr.storage.MemoryStore() attrs = zarr.core.attributes.Attributes( zarr.Group.from_store(store, attributes={"a": 1, "b": 2}) ) result = attrs.asdict() assert result == {"a": 1, "b": 2} def test_update_attributes_preserves_existing() -> None: """ Test that `update_attributes` only updates the specified attributes and preserves existing ones. """ store = zarr.storage.MemoryStore() z = zarr.create(10, store=store, overwrite=True) z.attrs["a"] = [] z.attrs["b"] = 3 assert dict(z.attrs) == {"a": [], "b": 3} z.update_attributes({"a": [3, 4], "c": 4}) assert dict(z.attrs) == {"a": [3, 4], "b": 3, "c": 4} def test_update_empty_attributes() -> None: """ Ensure updating when initial attributes are empty works. """ store = zarr.storage.MemoryStore() z = zarr.create(10, store=store, overwrite=True) assert dict(z.attrs) == {} z.update_attributes({"a": [3, 4], "c": 4}) assert dict(z.attrs) == {"a": [3, 4], "c": 4} def test_update_no_changes() -> None: """ Ensure updating when no new or modified attributes does not alter existing ones. """ store = zarr.storage.MemoryStore() z = zarr.create(10, store=store, overwrite=True) z.attrs["a"] = [] z.attrs["b"] = 3 z.update_attributes({}) assert dict(z.attrs) == {"a": [], "b": 3} @pytest.mark.parametrize("group", [True, False]) def test_del_works(group: bool) -> None: store = zarr.storage.MemoryStore() z: zarr.Group | AnyArray if group: z = zarr.create_group(store) else: z = zarr.create_array(store=store, shape=10, dtype=int) assert dict(z.attrs) == {} z.update_attributes({"a": [3, 4], "c": 4}) del z.attrs["a"] assert dict(z.attrs) == {"c": 4} z2: zarr.Group | AnyArray if group: z2 = zarr.open_group(store) else: z2 = zarr.open_array(store) assert dict(z2.attrs) == {"c": 4} zarr-python-3.3.0/tests/test_buffer.py000066400000000000000000000202471523267620000200460ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Literal import numpy as np import pytest import zarr from zarr.abc.buffer import ArrayLike, BufferPrototype, NDArrayLike from zarr.buffer import cpu, gpu from zarr.codecs.blosc import BloscCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.transpose import TransposeCodec from zarr.codecs.zstd import ZstdCodec from zarr.errors import ZarrUserWarning from zarr.storage import MemoryStore, StorePath from zarr.testing.buffer import ( NDBufferUsingTestNDArrayLike, StoreExpectingTestBuffer, TestBuffer, TestNDArrayLike, ) from zarr.testing.utils import gpu_mark, gpu_test, skip_if_no_gpu if TYPE_CHECKING: import types try: import cupy as cp except ImportError: cp = None import zarr.api.asynchronous if TYPE_CHECKING: import types def test_nd_array_like(xp: types.ModuleType) -> None: ary = xp.arange(10) assert isinstance(ary, ArrayLike) assert isinstance(ary, NDArrayLike) async def test_async_array_prototype() -> None: """Test the use of a custom buffer prototype""" expect = np.zeros((9, 9), dtype="uint16", order="F") a = await zarr.api.asynchronous.create_array( StorePath(StoreExpectingTestBuffer()) / "test_async_array_prototype", shape=expect.shape, chunks=(5, 5), dtype=expect.dtype, fill_value=0, ) expect[1:4, 3:6] = np.ones((3, 3)) my_prototype = BufferPrototype(buffer=TestBuffer, nd_buffer=NDBufferUsingTestNDArrayLike) await a.setitem( selection=(slice(1, 4), slice(3, 6)), value=np.ones((3, 3)), prototype=my_prototype, ) got = await a.getitem(selection=(slice(0, 9), slice(0, 9)), prototype=my_prototype) # ignoring a mypy error here that TestNDArrayLike doesn't meet the NDArrayLike protocol # The test passes, so it clearly does. assert isinstance(got, TestNDArrayLike) assert np.array_equal(expect, got) # type: ignore[unreachable] @gpu_test async def test_async_array_gpu_prototype() -> None: """Test the use of the GPU buffer prototype""" expect = cp.zeros((9, 9), dtype="uint16", order="F") a = await zarr.api.asynchronous.create_array( StorePath(MemoryStore()) / "test_async_array_gpu_prototype", shape=expect.shape, chunks=(5, 5), dtype=expect.dtype, fill_value=0, ) expect[1:4, 3:6] = cp.ones((3, 3)) await a.setitem( selection=(slice(1, 4), slice(3, 6)), value=cp.ones((3, 3)), prototype=gpu.buffer_prototype, ) got = await a.getitem(selection=(slice(0, 9), slice(0, 9)), prototype=gpu.buffer_prototype) assert isinstance(got, cp.ndarray) assert cp.array_equal(expect, got) async def test_codecs_use_of_prototype() -> None: expect = np.zeros((10, 10), dtype="uint16", order="F") a = await zarr.api.asynchronous.create_array( StorePath(StoreExpectingTestBuffer()) / "test_codecs_use_of_prototype", shape=expect.shape, chunks=(5, 5), dtype=expect.dtype, fill_value=0, compressors=[BloscCodec(), Crc32cCodec(), GzipCodec(), ZstdCodec()], filters=[TransposeCodec(order=(1, 0))], ) expect[:] = np.arange(100).reshape(10, 10) my_prototype = BufferPrototype(buffer=TestBuffer, nd_buffer=NDBufferUsingTestNDArrayLike) await a.setitem( selection=(slice(0, 10), slice(0, 10)), value=expect[:], prototype=my_prototype, ) got = await a.getitem(selection=(slice(0, 10), slice(0, 10)), prototype=my_prototype) # ignoring a mypy error here that TestNDArrayLike doesn't meet the NDArrayLike protocol # The test passes, so it clearly does. assert isinstance(got, TestNDArrayLike) assert np.array_equal(expect, got) # type: ignore[unreachable] @gpu_test async def test_codecs_use_of_gpu_prototype() -> None: expect = cp.zeros((10, 10), dtype="uint16", order="F") a = await zarr.api.asynchronous.create_array( StorePath(MemoryStore()) / "test_codecs_use_of_gpu_prototype", shape=expect.shape, chunks=(5, 5), dtype=expect.dtype, fill_value=0, compressors=[BloscCodec(), Crc32cCodec(), GzipCodec(), ZstdCodec()], filters=[TransposeCodec(order=(1, 0))], ) expect[:] = cp.arange(100).reshape(10, 10) msg = "Creating a zarr.buffer.gpu.Buffer with an array that does not support the __cuda_array_interface__ for zero-copy transfers, falling back to slow copy based path" with pytest.warns(ZarrUserWarning, match=msg): await a.setitem( selection=(slice(0, 10), slice(0, 10)), value=expect[:], prototype=gpu.buffer_prototype, ) with pytest.warns(ZarrUserWarning, match=msg): got = await a.getitem( selection=(slice(0, 10), slice(0, 10)), prototype=gpu.buffer_prototype ) assert isinstance(got, cp.ndarray) assert cp.array_equal(expect, got) @gpu_test async def test_sharding_use_of_gpu_prototype() -> None: with zarr.config.enable_gpu(): expect = cp.zeros((10, 10), dtype="uint16", order="F") a = await zarr.api.asynchronous.create_array( StorePath(MemoryStore()) / "test_codecs_use_of_gpu_prototype", shape=expect.shape, chunks=(5, 5), shards=(10, 10), dtype=expect.dtype, fill_value=0, ) expect[:] = cp.arange(100).reshape(10, 10) msg = "Creating a zarr.buffer.gpu.Buffer with an array that does not support the __cuda_array_interface__ for zero-copy transfers, falling back to slow copy based path" with pytest.warns(ZarrUserWarning, match=msg): await a.setitem( selection=(slice(0, 10), slice(0, 10)), value=expect[:], prototype=gpu.buffer_prototype, ) with pytest.warns(ZarrUserWarning, match=msg): got = await a.getitem( selection=(slice(0, 10), slice(0, 10)), prototype=gpu.buffer_prototype ) assert isinstance(got, cp.ndarray) assert cp.array_equal(expect, got) def test_numpy_buffer_prototype() -> None: buffer = cpu.buffer_prototype.buffer.create_zero_length() ndbuffer = cpu.buffer_prototype.nd_buffer.create(shape=(1, 2), dtype=np.dtype("int64")) assert isinstance(buffer.as_array_like(), np.ndarray) assert isinstance(ndbuffer.as_ndarray_like(), np.ndarray) with pytest.raises(ValueError, match="Buffer does not contain a single scalar value"): ndbuffer.as_scalar() @gpu_test def test_gpu_buffer_prototype() -> None: buffer = gpu.buffer_prototype.buffer.create_zero_length() ndbuffer = gpu.buffer_prototype.nd_buffer.create(shape=(1, 2), dtype=cp.dtype("int64")) assert isinstance(buffer.as_array_like(), cp.ndarray) assert isinstance(ndbuffer.as_ndarray_like(), cp.ndarray) with pytest.raises(ValueError, match="Buffer does not contain a single scalar value"): ndbuffer.as_scalar() # TODO: the same test for other buffer classes def test_cpu_buffer_as_scalar() -> None: buf = cpu.buffer_prototype.nd_buffer.create(shape=(), dtype="int64") assert buf.as_scalar() == buf.as_ndarray_like()[()] # type: ignore[index] @pytest.mark.parametrize( "prototype", [ cpu.buffer_prototype, pytest.param( gpu.buffer_prototype, marks=[gpu_mark, skip_if_no_gpu], ), BufferPrototype( buffer=cpu.Buffer, nd_buffer=NDBufferUsingTestNDArrayLike, ), ], ) @pytest.mark.parametrize( "shape", [ (1, 2), (1, 2, 3), ], ) @pytest.mark.parametrize("dtype", ["int32", "float64"]) @pytest.mark.parametrize("order", ["C", "F"]) def test_empty( prototype: BufferPrototype, shape: tuple[int, ...], dtype: str, order: Literal["C", "F"] ) -> None: buf = prototype.nd_buffer.empty(shape=shape, dtype=dtype, order=order) result = buf.as_ndarray_like() assert result.shape == shape assert result.dtype == dtype if order == "C": assert result.flags.c_contiguous # type: ignore[attr-defined] else: assert result.flags.f_contiguous # type: ignore[attr-defined] zarr-python-3.3.0/tests/test_chunk_grids.py000066400000000000000000000225321523267620000210740ustar00rootroot00000000000000from typing import Any import numpy as np import pytest from tests.conftest import Expect, ExpectFail from zarr.core.chunk_grids import ( ChunkLayout, _guess_regular_chunks, normalize_chunks_1d, normalize_chunks_nd, resolve_outer_and_inner_chunks, ) def _assert_chunks_equal( actual: tuple[Any, ...], expected: tuple[tuple[int, ...], ...], ) -> None: """Compare a ChunksTuple (tuple of np.int64 arrays) against a tuple of int tuples.""" assert len(actual) == len(expected), f"axis count mismatch: {len(actual)} vs {len(expected)}" for axis, (a, e) in enumerate(zip(actual, expected, strict=True)): assert np.array_equal(a, np.asarray(e, dtype=np.int64)), ( f"axis {axis}: {list(a)} != {list(e)}" ) @pytest.mark.parametrize( "shape", [(0,), (0,) * 2, (1, 2, 0, 4, 5), (10, 0), (10,), (100,) * 3, (1000000,), (10000,) * 2] ) @pytest.mark.parametrize("itemsize", [1, 2, 4]) def test_guess_chunks(shape: tuple[int, ...], itemsize: int) -> None: chunks = _guess_regular_chunks(shape, itemsize) chunk_size = np.prod(chunks) * itemsize assert isinstance(chunks, tuple) assert len(chunks) == len(shape) assert chunk_size < (64 * 1024 * 1024) # doesn't make any sense to allow chunks to have zero length dimension assert all(0 < c <= max(s, 1) for c, s in zip(chunks, shape, strict=False)) @pytest.mark.parametrize( ("chunks", "shape", "expected"), [ # 1D cases ((10,), (100,), ((10,) * 10,)), ([10], (100,), ((10,) * 10,)), (10, (100,), ((10,) * 10,)), # 2D cases ((10, 10), (100, 10), ((10,) * 10, (10,))), (10, (100, 10), ((10,) * 10, (10,))), ((10, -1), (100, 10), ((10,) * 10, (10,))), # 3D cases (30, (100, 20, 10), ((30, 30, 30, 30), (30,), (30,))), ((30, -1, -1), (100, 20, 10), ((30, 30, 30, 30), (20,), (10,))), ((30, 20, -1), (100, 20, 10), ((30, 30, 30, 30), (20,), (10,))), ((30, 20, 10), (100, 20, 10), ((30, 30, 30, 30), (20,), (10,))), # dask-style chunks (explicit per-chunk sizes) (((100, 100, 100), (50, 50)), (300, 100), ((100, 100, 100), (50, 50))), (((100, 100, 50),), (250,), ((100, 100, 50),)), (((100,),), (100,), ((100,),)), # no chunking (False means each dimension is one chunk spanning the full extent) (False, (100,), ((100,),)), (False, (100, 50), ((100,), (50,))), # sentinel values (-1, (100,), ((100,),)), # zero-length dimensions preserve the declared chunk size (10, (0,), ((10,),)), ((5, 10), (0, 100), ((5,), (10,) * 10)), ((5, 10), (20, 0), ((5, 5, 5, 5), (10,))), ], ) def test_normalize_chunks( chunks: Any, shape: tuple[int, ...], expected: tuple[tuple[int, ...], ...] ) -> None: _assert_chunks_equal(normalize_chunks_nd(chunks, shape), expected) @pytest.mark.parametrize( ("array_shape", "chunks_input", "shard_shape", "expected_outer", "expected_inner_outer"), [ # no sharding: outer = chunks, inner = None ((100,), (10,), None, ((10,) * 10,), None), # explicit regular shards ((100,), (10,), (50,), ((50, 50),), ((10,) * 10,)), # rectilinear shards ((100,), (10,), ((60, 40),), ((60, 40),), ((10,) * 10,)), # dict-style shards ((100, 100), (10, 10), {"shape": (50, 50)}, ((50, 50), (50, 50)), ((10,) * 10, (10,) * 10)), ], ) def test_resolve_outer_and_inner_chunks( array_shape: tuple[int, ...], chunks_input: tuple[int, ...], shard_shape: Any, expected_outer: tuple[tuple[int, ...], ...], expected_inner_outer: tuple[tuple[int, ...], ...] | None, ) -> None: chunks = normalize_chunks_nd(chunks_input, array_shape) outer_chunks, inner = resolve_outer_and_inner_chunks( array_shape=array_shape, chunks=chunks, shard_shape=shard_shape, item_size=1 ) _assert_chunks_equal(outer_chunks, expected_outer) if expected_inner_outer is None: assert inner is None else: assert inner is not None _assert_chunks_equal(inner.outer_chunks, expected_inner_outer) assert inner.inner is None def test_chunk_layout_nested() -> None: """Test that ChunkLayout supports recursive nesting for nested sharding.""" leaf = normalize_chunks_nd((5, 5), (100, 100)) mid = ChunkLayout( outer_chunks=normalize_chunks_nd((25, 25), (100, 100)), inner=ChunkLayout(outer_chunks=leaf), ) top = ChunkLayout(outer_chunks=normalize_chunks_nd((50, 50), (100, 100)), inner=mid) # Three levels: top -> mid -> leaf _assert_chunks_equal(top.outer_chunks, ((50, 50), (50, 50))) assert top.inner is not None _assert_chunks_equal(top.inner.outer_chunks, ((25,) * 4, (25,) * 4)) assert top.inner.inner is not None _assert_chunks_equal(top.inner.inner.outer_chunks, ((5,) * 20, (5,) * 20)) assert top.inner.inner.inner is None @pytest.mark.parametrize( "case", [ ExpectFail( input=(0, 100), exception=ValueError, id="zero-uniform", msg="Chunk size must be positive", ), ExpectFail( input=(-2, 100), exception=ValueError, id="negative-uniform", msg="Chunk size must be positive", ), ExpectFail(input=([], 100), exception=ValueError, id="empty-list", msg="must not be empty"), ExpectFail( input=([10, -1, 10], 100), exception=ValueError, id="negative-element", msg="must be positive", ), ExpectFail( input=([10, 0, 10], 20), exception=ValueError, id="zero-element", msg="must be positive" ), ExpectFail( input=([10, 20], 100), exception=ValueError, id="wrong-sum", msg="do not sum to span" ), # Nested/RLE form for a single dim is rejected with offending indices. ExpectFail( input=([[3, 3], 1], 7), exception=TypeError, id="rle-single-dim", msg="non-integer element(s) ([3, 3],) at indices (0,)", escape=True, ), # Multiple non-int elements: all offending indices reported. ExpectFail( input=([1, [2, 2], 1, [3]], 9), exception=TypeError, id="multiple-non-ints", msg="non-integer element(s) ([2, 2], [3]) at indices (1, 3)", escape=True, ), # Strings are non-integers and should be reported the same way. ExpectFail( input=([2, "3", 5], 10), exception=TypeError, id="string-element", msg="non-integer element(s) ('3',) at indices (1,)", escape=True, ), ], ids=lambda c: c.id, ) def test_normalize_chunks_1d_errors(case: ExpectFail[tuple[Any, int]]) -> None: """Invalid 1D chunk specifications are rejected with informative error messages.""" chunks, span = case.input with case.raises(): normalize_chunks_1d(chunks, span=span) @pytest.mark.parametrize( "case", [ ExpectFail( input=(None, (100,)), exception=ValueError, id="none", msg="None is not a valid chunk input", ), # `True` is rejected explicitly because bool is a subclass of int — without # this guard, `chunks=True` would silently produce size-1 chunks. ExpectFail( input=(True, (100,)), exception=ValueError, id="true", msg="True is not a valid chunk input", ), ExpectFail(input=("foo", (100,)), exception=ValueError, id="string", msg="dimensions"), ExpectFail( input=((100, 10), (100,)), exception=ValueError, id="too-many-dims", msg="dimensions" ), ExpectFail( input=((10,), (100, 100)), exception=ValueError, id="too-few-dims", msg="dimensions" ), # End-to-end: per-dim RLE surfaces through normalize_chunks_nd. ExpectFail( input=([[6, 4], [[3, 3], 1]], (10, 10)), exception=TypeError, id="rle-inner-dim", msg="non-integer element(s) ([3, 3],) at indices (0,)", escape=True, ), ], ids=lambda c: c.id, ) def test_normalize_chunks_nd_errors(case: ExpectFail[tuple[Any, tuple[int, ...]]]) -> None: """Invalid N-D chunk specifications are rejected with informative error messages.""" chunks, shape = case.input with case.raises(): normalize_chunks_nd(chunks, shape) @pytest.mark.parametrize( "case", [ # uniform-chunks branch: one int → broadcast across span via np.full. Expect(input=(1000, 100_000), output=[1000] * 100, id="uniform"), # explicit-per-chunk branch. Expect(input=([10, 20, 30, 40], 100), output=[10, 20, 30, 40], id="explicit-list"), # -1 sentinel branch: one chunk covering the full span. Expect(input=(-1, 100), output=[100], id="full-span-sentinel"), ], ids=lambda c: c.id, ) def test_normalize_chunks_1d_returns_int64_array( case: Expect[tuple[Any, int], list[int]], ) -> None: """Every branch of normalize_chunks_1d must produce a 1D int64 array.""" chunks, span = case.input result = normalize_chunks_1d(chunks, span) assert isinstance(result, np.ndarray) assert result.dtype == np.int64 assert result.ndim == 1 assert result.tolist() == case.output zarr-python-3.3.0/tests/test_chunk_key_encodings.py000066400000000000000000000047131523267620000226060ustar00rootroot00000000000000from __future__ import annotations import pytest from zarr.core.chunk_key_encodings import DefaultChunkKeyEncoding, V2ChunkKeyEncoding @pytest.mark.parametrize("separator", ["/", "."]) @pytest.mark.parametrize( "coords", [(), (0,), (1, 2), (10, 0, 3)], ) def test_default_encoding_round_trips(separator: str, coords: tuple[int, ...]) -> None: """Encoding coordinates and decoding the result returns the coordinates.""" encoding = DefaultChunkKeyEncoding(separator=separator) # type: ignore[arg-type] key = encoding.encode_chunk_key(coords) assert encoding.decode_chunk_key(key) == coords @pytest.mark.parametrize("separator", ["/", "."]) @pytest.mark.parametrize("coords", [(0,), (1, 2), (10, 0, 3)]) def test_v2_encoding_round_trips(separator: str, coords: tuple[int, ...]) -> None: """The v2 encoding round-trips coordinates for either separator.""" encoding = V2ChunkKeyEncoding(separator=separator) # type: ignore[arg-type] key = encoding.encode_chunk_key(coords) assert encoding.decode_chunk_key(key) == coords @pytest.mark.parametrize("separator", ["/", "."]) def test_v2_zero_dimensional_key_is_ambiguous(separator: str) -> None: """A 0-d v2 array stores its sole chunk under `"0"`, the same key a 1-d array uses for chunk 0, so decoding cannot recover the empty tuple on its own -- the array's dimensionality is what disambiguates it.""" encoding = V2ChunkKeyEncoding(separator=separator) # type: ignore[arg-type] assert encoding.encode_chunk_key(()) == "0" assert encoding.decode_chunk_key("0") == (0,) @pytest.mark.parametrize( "chunk_key", [ "0/1", # no "c" prefix at all "c0/1", # "c" not followed by the separator "x/0/1", # wrong prefix character "", ], ) def test_default_encoding_rejects_key_without_prefix(chunk_key: str) -> None: """A key that does not carry the `c` prefix is not a chunk key for this encoding, and must be rejected rather than silently decoded.""" encoding = DefaultChunkKeyEncoding(separator="/") with pytest.raises(ValueError, match="Invalid chunk key"): encoding.decode_chunk_key(chunk_key) def test_default_encoding_rejects_key_using_the_other_separator() -> None: """A key encoded with `.` is not valid for a `/`-separated encoding.""" encoding = DefaultChunkKeyEncoding(separator="/") with pytest.raises(ValueError, match="Invalid chunk key"): encoding.decode_chunk_key("c.0.1") zarr-python-3.3.0/tests/test_chunk_transform.py000066400000000000000000000132231523267620000217740ustar00rootroot00000000000000"""Unit tests for ChunkTransform -- the per-chunk synchronous codec chain. ChunkTransform is the data structure FusedCodecPipeline uses to encode/decode a single chunk through a sequence of codecs synchronously. These tests exercise it directly (no pipeline, no store): construction and its rejection of codecs that lack a synchronous implementation, encode/decode roundtrips across codec chains, compute_encoded_size, and None short-circuiting when an array->array codec returns None. End-to-end pipeline behavior lives in the pipeline test modules. """ from __future__ import annotations from typing import Any import numpy as np import pytest from zarr.abc.codec import ArrayBytesCodec, Codec from zarr.codecs.bytes import BytesCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.transpose import TransposeCodec from zarr.codecs.zstd import ZstdCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import Buffer, NDBuffer, default_buffer_prototype from zarr.core.chunk_utils import ChunkTransform from zarr.core.dtype import get_data_type_from_native_dtype class AsyncOnlyCodec(ArrayBytesCodec): """A codec that only supports async, for testing rejection of non-sync codecs.""" is_fixed_size = True async def _decode_single(self, chunk_data: Buffer, chunk_spec: ArraySpec) -> NDBuffer: raise NotImplementedError # pragma: no cover async def _encode_single(self, chunk_data: NDBuffer, chunk_spec: ArraySpec) -> Buffer | None: raise NotImplementedError # pragma: no cover def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: return input_byte_length # pragma: no cover def _make_array_spec(shape: tuple[int, ...], dtype: np.dtype[np.generic]) -> ArraySpec: zdtype = get_data_type_from_native_dtype(dtype) return ArraySpec( shape=shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) def _make_nd_buffer(arr: np.ndarray[Any, np.dtype[Any]]) -> NDBuffer: return default_buffer_prototype().nd_buffer.from_numpy_array(arr) @pytest.mark.parametrize( ("shape", "codecs"), [ ((100,), (BytesCodec(),)), ((100,), (BytesCodec(), GzipCodec())), ((3, 4), (TransposeCodec(order=(1, 0)), BytesCodec(), ZstdCodec())), ], ids=["bytes-only", "with-compression", "full-chain"], ) def test_construction(shape: tuple[int, ...], codecs: tuple[Codec, ...]) -> None: """Construction succeeds when all codecs implement SupportsSyncCodec.""" _ = _make_array_spec(shape, np.dtype("float64")) ChunkTransform(codecs=codecs) @pytest.mark.parametrize( ("shape", "codecs"), [ ((100,), (AsyncOnlyCodec(),)), ((3, 4), (TransposeCodec(order=(1, 0)), AsyncOnlyCodec())), ], ids=["async-only", "mixed-sync-and-async"], ) def test_construction_rejects_non_sync(shape: tuple[int, ...], codecs: tuple[Codec, ...]) -> None: """Construction raises TypeError when any codec lacks SupportsSyncCodec.""" _ = _make_array_spec(shape, np.dtype("float64")) with pytest.raises(TypeError, match="AsyncOnlyCodec"): ChunkTransform(codecs=codecs) @pytest.mark.parametrize( ("arr", "codecs"), [ (np.arange(100, dtype="float64"), (BytesCodec(),)), (np.arange(100, dtype="float64"), (BytesCodec(), GzipCodec(level=1))), ( np.arange(12, dtype="float64").reshape(3, 4), (TransposeCodec(order=(1, 0)), BytesCodec(), ZstdCodec(level=1)), ), (np.arange(100, dtype="float64"), (BytesCodec(), Crc32cCodec())), (np.arange(50, dtype="int32"), (BytesCodec(), ZstdCodec(level=1))), ], ids=["bytes-only", "gzip", "transpose+zstd", "crc32c", "int32"], ) def test_encode_decode_roundtrip( arr: np.ndarray[Any, np.dtype[Any]], codecs: tuple[Codec, ...] ) -> None: """Data survives a full encode/decode cycle.""" spec = _make_array_spec(arr.shape, arr.dtype) chain = ChunkTransform(codecs=codecs) nd_buf = _make_nd_buffer(arr) encoded = chain.encode_chunk(nd_buf, spec) assert encoded is not None decoded = chain.decode_chunk(encoded, spec) np.testing.assert_array_equal(arr, decoded.as_numpy_array()) @pytest.mark.parametrize( ("shape", "codecs", "input_size", "expected_size"), [ ((100,), (BytesCodec(),), 800, 800), ((100,), (BytesCodec(), Crc32cCodec()), 800, 804), ((3, 4), (TransposeCodec(order=(1, 0)), BytesCodec()), 96, 96), ], ids=["bytes-only", "crc32c", "transpose"], ) def test_compute_encoded_size( shape: tuple[int, ...], codecs: tuple[Codec, ...], input_size: int, expected_size: int, ) -> None: """compute_encoded_size returns the correct byte length.""" spec = _make_array_spec(shape, np.dtype("float64")) chain = ChunkTransform(codecs=codecs) assert chain.compute_encoded_size(input_size, spec) == expected_size def test_encode_returns_none_propagation() -> None: """When an AA codec returns None, encode short-circuits and returns None.""" class NoneReturningAACodec(TransposeCodec): """An ArrayArrayCodec that always returns None from encode.""" def _encode_sync(self, chunk_array: NDBuffer, chunk_spec: ArraySpec) -> NDBuffer | None: return None spec = _make_array_spec((3, 4), np.dtype("float64")) chain = ChunkTransform( codecs=(NoneReturningAACodec(order=(1, 0)), BytesCodec()), ) arr = np.arange(12, dtype="float64").reshape(3, 4) nd_buf = _make_nd_buffer(arr) assert chain.encode_chunk(nd_buf, spec) is None zarr-python-3.3.0/tests/test_cli/000077500000000000000000000000001523267620000167655ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_cli/conftest.py000066400000000000000000000104231523267620000211640ustar00rootroot00000000000000from pathlib import Path from typing import Any, Literal import pytest import zarr from zarr.abc.store import Store from zarr.core.common import ZarrFormat def create_nested_zarr( store: Store, attributes: dict[str, Any] | None = None, separator: Literal[".", "/"] = ".", zarr_format: ZarrFormat = 2, ) -> list[str]: """Create a zarr with nested groups / arrays for testing, returning the paths to all.""" if attributes is None: attributes = {"baz": 42, "qux": [1, 4, 7, 12]} # 3 levels of nested groups group_0 = zarr.create_group(store=store, zarr_format=zarr_format, attributes=attributes) group_1 = group_0.create_group(name="group_1", attributes=attributes) group_2 = group_1.create_group(name="group_2", attributes=attributes) paths = [group_0.path, group_1.path, group_2.path] # 1 array per group for i, group in enumerate([group_0, group_1, group_2]): array = group.create_array( name=f"array_{i}", shape=(10, 10), chunks=(5, 5), dtype="uint16", attributes=attributes, chunk_key_encoding={"name": "v2", "separator": separator}, ) array[:] = 1 paths.append(array.path) return paths @pytest.fixture def expected_paths() -> list[Path]: """Expected paths for create_nested_zarr, with no metadata files or chunks""" return [ Path("array_0"), Path("group_1"), Path("group_1/array_1"), Path("group_1/group_2"), Path("group_1/group_2/array_2"), ] @pytest.fixture def expected_chunks() -> list[Path]: """Expected chunks for create_nested_zarr""" return [ Path("array_0/0.0"), Path("array_0/0.1"), Path("array_0/1.0"), Path("array_0/1.1"), Path("group_1/array_1/0.0"), Path("group_1/array_1/0.1"), Path("group_1/array_1/1.0"), Path("group_1/array_1/1.1"), Path("group_1/group_2/array_2/0.0"), Path("group_1/group_2/array_2/0.1"), Path("group_1/group_2/array_2/1.0"), Path("group_1/group_2/array_2/1.1"), ] @pytest.fixture def expected_v3_metadata() -> list[Path]: """Expected v3 metadata for create_nested_zarr""" return sorted( [ Path("zarr.json"), Path("array_0/zarr.json"), Path("group_1/zarr.json"), Path("group_1/array_1/zarr.json"), Path("group_1/group_2/zarr.json"), Path("group_1/group_2/array_2/zarr.json"), ] ) @pytest.fixture def expected_v2_metadata() -> list[Path]: """Expected v2 metadata for create_nested_zarr""" return sorted( [ Path(".zgroup"), Path(".zattrs"), Path("array_0/.zarray"), Path("array_0/.zattrs"), Path("group_1/.zgroup"), Path("group_1/.zattrs"), Path("group_1/array_1/.zarray"), Path("group_1/array_1/.zattrs"), Path("group_1/group_2/.zgroup"), Path("group_1/group_2/.zattrs"), Path("group_1/group_2/array_2/.zarray"), Path("group_1/group_2/array_2/.zattrs"), ] ) @pytest.fixture def expected_paths_no_metadata( expected_paths: list[Path], expected_chunks: list[Path] ) -> list[Path]: return sorted(expected_paths + expected_chunks) @pytest.fixture def expected_paths_v3_metadata( expected_paths: list[Path], expected_chunks: list[Path], expected_v3_metadata: list[Path] ) -> list[Path]: return sorted(expected_paths + expected_chunks + expected_v3_metadata) @pytest.fixture def expected_paths_v3_metadata_no_chunks( expected_paths: list[Path], expected_v3_metadata: list[Path] ) -> list[Path]: return sorted(expected_paths + expected_v3_metadata) @pytest.fixture def expected_paths_v2_metadata( expected_paths: list[Path], expected_chunks: list[Path], expected_v2_metadata: list[Path] ) -> list[Path]: return sorted(expected_paths + expected_chunks + expected_v2_metadata) @pytest.fixture def expected_paths_v2_v3_metadata( expected_paths: list[Path], expected_chunks: list[Path], expected_v2_metadata: list[Path], expected_v3_metadata: list[Path], ) -> list[Path]: return sorted(expected_paths + expected_chunks + expected_v2_metadata + expected_v3_metadata) zarr-python-3.3.0/tests/test_cli/test_migrate_v3.py000066400000000000000000000543051523267620000224450ustar00rootroot00000000000000import lzma from pathlib import Path from typing import Literal, cast import numcodecs import numcodecs.abc import numpy as np import pytest import zarr from tests.test_cli.conftest import create_nested_zarr from zarr.abc.codec import Codec from zarr.codecs.blosc import BloscCodec from zarr.codecs.bytes import BytesCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.numcodecs import LZMA, Delta from zarr.codecs.transpose import TransposeCodec from zarr.codecs.zstd import ZstdCodec from zarr.core.chunk_key_encodings import V2ChunkKeyEncoding from zarr.core.common import JSON, ZarrFormat from zarr.core.dtype.npy.int import UInt8, UInt16 from zarr.core.group import Group, GroupMetadata from zarr.core.metadata.v3 import ArrayV3Metadata from zarr.storage._local import LocalStore from zarr.types import AnyArray typer_testing = pytest.importorskip( "typer.testing", reason="optional cli dependencies aren't installed" ) cli = pytest.importorskip("zarr._cli.cli", reason="optional cli dependencies aren't installed") runner = typer_testing.CliRunner() def test_migrate_array(local_store: LocalStore) -> None: shape = (10, 10) chunks = (10, 10) dtype = "uint16" compressors = numcodecs.Blosc(cname="zstd", clevel=3, shuffle=1) fill_value = 2 attributes = cast(dict[str, JSON], {"baz": 42, "qux": [1, 4, 7, 12]}) zarr.create_array( store=local_store, shape=shape, chunks=chunks, dtype=dtype, compressors=compressors, zarr_format=2, fill_value=fill_value, attributes=attributes, ) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 assert (local_store.root / "zarr.json").exists() zarr_array = zarr.open(local_store.root, zarr_format=3) expected_metadata = ArrayV3Metadata( shape=shape, data_type=UInt16(endianness="little"), chunk_grid={"name": "regular", "configuration": {"chunk_shape": chunks}}, chunk_key_encoding=V2ChunkKeyEncoding(separator="."), fill_value=fill_value, codecs=( BytesCodec(endian="little"), BloscCodec(typesize=2, cname="zstd", clevel=3, shuffle="shuffle", blocksize=0), ), attributes=attributes, dimension_names=None, storage_transformers=None, ) assert zarr_array.metadata == expected_metadata def test_migrate_group(local_store: LocalStore) -> None: attributes = {"baz": 42, "qux": [1, 4, 7, 12]} zarr.create_group(store=local_store, zarr_format=2, attributes=attributes) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 assert (local_store.root / "zarr.json").exists() zarr_array = zarr.open(local_store.root, zarr_format=3) expected_metadata = GroupMetadata( attributes=attributes, zarr_format=3, consolidated_metadata=None ) assert zarr_array.metadata == expected_metadata @pytest.mark.parametrize("separator", [".", "/"]) def test_migrate_nested_groups_and_arrays_in_place( local_store: LocalStore, separator: str, expected_v3_metadata: list[Path] ) -> None: """Test that zarr.json are made at the correct points in a hierarchy of groups and arrays (including when there are additional dirs due to using a / separator)""" attributes = {"baz": 42, "qux": [1, 4, 7, 12]} paths = create_nested_zarr(local_store, attributes=attributes, separator=separator) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 zarr_json_paths = sorted(local_store.root.rglob("zarr.json")) expected_zarr_json_paths = [local_store.root / p for p in expected_v3_metadata] assert zarr_json_paths == expected_zarr_json_paths # Check converted zarr can be opened + metadata accessed at all levels zarr_array = zarr.open(local_store.root, zarr_format=3) for path in paths: zarr_v3 = cast(AnyArray | Group, zarr_array[path]) metadata = zarr_v3.metadata assert metadata.zarr_format == 3 assert metadata.attributes == attributes @pytest.mark.parametrize("separator", [".", "/"]) async def test_migrate_nested_groups_and_arrays_separate_location( tmp_path: Path, separator: str, expected_v2_metadata: list[Path], expected_v3_metadata: list[Path], ) -> None: """Test that zarr.json are made at the correct paths, when saving to a separate output location.""" input_zarr_path = tmp_path / "input.zarr" output_zarr_path = tmp_path / "output.zarr" local_store = await LocalStore.open(str(input_zarr_path)) create_nested_zarr(local_store, separator=separator) result = runner.invoke(cli.app, ["migrate", "v3", str(input_zarr_path), str(output_zarr_path)]) assert result.exit_code == 0 # Files in input zarr should be unchanged i.e. still v2 only zarr_json_paths = sorted(input_zarr_path.rglob("zarr.json")) assert len(zarr_json_paths) == 0 paths = [ path for path in input_zarr_path.rglob("*") if path.stem in [".zarray", ".zgroup", ".zattrs"] ] expected_paths = [input_zarr_path / p for p in expected_v2_metadata] assert sorted(paths) == expected_paths # Files in output zarr should only contain v3 metadata zarr_json_paths = sorted(output_zarr_path.rglob("zarr.json")) expected_zarr_json_paths = [output_zarr_path / p for p in expected_v3_metadata] assert zarr_json_paths == expected_zarr_json_paths def test_remove_v2_metadata_option_in_place( local_store: LocalStore, expected_paths_v3_metadata: list[Path] ) -> None: create_nested_zarr(local_store) # convert v2 metadata to v3, then remove v2 metadata result = runner.invoke( cli.app, ["migrate", "v3", str(local_store.root), "--remove-v2-metadata"] ) assert result.exit_code == 0 paths = sorted(local_store.root.rglob("*")) expected_paths = [local_store.root / p for p in expected_paths_v3_metadata] assert paths == expected_paths async def test_remove_v2_metadata_option_separate_location( tmp_path: Path, expected_paths_v2_metadata: list[Path], expected_paths_v3_metadata_no_chunks: list[Path], ) -> None: """Check that when using --remove-v2-metadata with a separate output location, no v2 metadata is removed from the input location.""" input_zarr_path = tmp_path / "input.zarr" output_zarr_path = tmp_path / "output.zarr" local_store = await LocalStore.open(str(input_zarr_path)) create_nested_zarr(local_store) result = runner.invoke( cli.app, ["migrate", "v3", str(input_zarr_path), str(output_zarr_path), "--remove-v2-metadata"], ) assert result.exit_code == 0 # input image should be unchanged paths = sorted(input_zarr_path.rglob("*")) expected_paths = [input_zarr_path / p for p in expected_paths_v2_metadata] assert paths == expected_paths # output image should be only v3 metadata paths = sorted(output_zarr_path.rglob("*")) expected_paths = [output_zarr_path / p for p in expected_paths_v3_metadata_no_chunks] assert paths == expected_paths def test_overwrite_option_in_place( local_store: LocalStore, expected_paths_v2_v3_metadata: list[Path] ) -> None: create_nested_zarr(local_store) # add v3 metadata in place result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 # check that v3 metadata can be overwritten with --overwrite result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root), "--overwrite"]) assert result.exit_code == 0 paths = sorted(local_store.root.rglob("*")) expected_paths = [local_store.root / p for p in expected_paths_v2_v3_metadata] assert paths == expected_paths async def test_overwrite_option_separate_location( tmp_path: Path, expected_paths_v2_metadata: list[Path], expected_paths_v3_metadata_no_chunks: list[Path], ) -> None: input_zarr_path = tmp_path / "input.zarr" output_zarr_path = tmp_path / "output.zarr" local_store = await LocalStore.open(str(input_zarr_path)) create_nested_zarr(local_store) # create v3 metadata at output_zarr_path result = runner.invoke( cli.app, ["migrate", "v3", str(input_zarr_path), str(output_zarr_path)], ) assert result.exit_code == 0 # re-run with --overwrite option result = runner.invoke( cli.app, ["migrate", "v3", str(input_zarr_path), str(output_zarr_path), "--overwrite", "--force"], ) assert result.exit_code == 0 # original image should be un-changed paths = sorted(input_zarr_path.rglob("*")) expected_paths = [input_zarr_path / p for p in expected_paths_v2_metadata] assert paths == expected_paths # output image is only v3 metadata paths = sorted(output_zarr_path.rglob("*")) expected_paths = [output_zarr_path / p for p in expected_paths_v3_metadata_no_chunks] assert paths == expected_paths @pytest.mark.parametrize("separator", [".", "/"]) def test_migrate_sub_group( local_store: LocalStore, separator: str, expected_v3_metadata: list[Path] ) -> None: """Test that only arrays/groups within group_1 are converted (+ no other files in store)""" create_nested_zarr(local_store, separator=separator) group_path = local_store.root / "group_1" result = runner.invoke(cli.app, ["migrate", "v3", str(group_path)]) assert result.exit_code == 0 zarr_json_paths = sorted(local_store.root.rglob("zarr.json")) expected_zarr_json_paths = [ local_store.root / p for p in expected_v3_metadata if group_path in (local_store.root / p).parents ] assert zarr_json_paths == expected_zarr_json_paths @pytest.mark.parametrize( ("compressor_v2", "compressor_v3"), [ ( numcodecs.Blosc(cname="zstd", clevel=3, shuffle=1), BloscCodec(typesize=2, cname="zstd", clevel=3, shuffle="shuffle", blocksize=0), ), (numcodecs.Zstd(level=3), ZstdCodec(level=3)), (numcodecs.GZip(level=3), GzipCodec(level=3)), ], ids=["blosc", "zstd", "gzip"], ) def test_migrate_compressor( local_store: LocalStore, compressor_v2: numcodecs.abc.Codec, compressor_v3: Codec ) -> None: zarr_array = zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype="uint16", compressors=compressor_v2, zarr_format=2, fill_value=0, ) zarr_array[:] = 1 result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 assert (local_store.root / "zarr.json").exists() zarr_array = zarr.open_array(local_store.root, zarr_format=3) metadata = zarr_array.metadata assert metadata.zarr_format == 3 assert metadata.codecs == ( BytesCodec(endian="little"), compressor_v3, ) assert np.all(zarr_array[:] == 1) def test_migrate_numcodecs_compressor(local_store: LocalStore) -> None: """Test migration of a numcodecs compressor without a zarr.codecs equivalent.""" lzma_settings = { "format": lzma.FORMAT_RAW, "check": -1, "preset": None, "filters": [ {"id": lzma.FILTER_DELTA, "dist": 4}, {"id": lzma.FILTER_LZMA2, "preset": 1}, ], } zarr_array = zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype="uint16", compressors=numcodecs.LZMA.from_config(lzma_settings), zarr_format=2, fill_value=0, ) zarr_array[:] = 1 result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 assert (local_store.root / "zarr.json").exists() zarr_array = zarr.open_array(local_store.root, zarr_format=3) metadata = zarr_array.metadata assert metadata.zarr_format == 3 assert metadata.codecs == ( BytesCodec(endian="little"), LZMA( format=lzma_settings["format"], check=lzma_settings["check"], preset=lzma_settings["preset"], filters=lzma_settings["filters"], ), ) assert np.all(zarr_array[:] == 1) def test_migrate_filter(local_store: LocalStore) -> None: filter_v2 = numcodecs.Delta(dtype=" None: zarr_array = zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype="uint16", compressors=None, zarr_format=2, fill_value=0, order=order, ) zarr_array[:] = 1 result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 assert (local_store.root / "zarr.json").exists() zarr_array = zarr.open_array(local_store.root, zarr_format=3) metadata = zarr_array.metadata assert metadata.zarr_format == 3 assert metadata.codecs == expected_codecs assert np.all(zarr_array[:] == 1) @pytest.mark.parametrize( ("dtype", "expected_data_type", "expected_codecs"), [ ("uint8", UInt8(), (BytesCodec(endian=None),)), ("uint16", UInt16(), (BytesCodec(endian="little"),)), ], ids=["single_byte", "multi_byte"], ) def test_migrate_endian( local_store: LocalStore, dtype: str, expected_data_type: UInt8 | UInt16, expected_codecs: tuple[Codec], ) -> None: zarr_array = zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype=dtype, compressors=None, zarr_format=2, fill_value=0, ) zarr_array[:] = 1 result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 assert (local_store.root / "zarr.json").exists() zarr_array = zarr.open_array(local_store.root, zarr_format=3) metadata = zarr_array.metadata assert metadata.zarr_format == 3 assert metadata.data_type == expected_data_type assert metadata.codecs == expected_codecs assert np.all(zarr_array[:] == 1) @pytest.mark.parametrize("node_type", ["array", "group"]) def test_migrate_v3(local_store: LocalStore, node_type: str) -> None: """Attempting to convert a v3 array/group should always fail""" if node_type == "array": zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), zarr_format=3, dtype="uint16" ) else: zarr.create_group(store=local_store, zarr_format=3) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 1 assert isinstance(result.exception, TypeError) assert str(result.exception) == "Only arrays / groups with zarr v2 metadata can be converted" def test_migrate_consolidated_metadata(local_store: LocalStore) -> None: """Attempting to convert a group with consolidated metadata should always fail""" group = zarr.create_group(store=local_store, zarr_format=2) group.create_array(shape=(1,), name="a", dtype="uint8") zarr.consolidate_metadata(local_store) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 1 assert isinstance(result.exception, NotImplementedError) assert str(result.exception) == "Migration of consolidated metadata isn't supported." def test_migrate_unknown_codec(local_store: LocalStore) -> None: """Attempting to convert a codec without a v3 equivalent should always fail""" zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype="uint16", filters=[numcodecs.Categorize(labels=["a", "b"], dtype=object)], zarr_format=2, fill_value=0, ) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 1 assert isinstance(result.exception, ValueError) assert ( str(result.exception) == "Couldn't find corresponding zarr.codecs.numcodecs codec for categorize" ) def test_migrate_incorrect_filter(local_store: LocalStore) -> None: """Attempting to convert a filter (which is the wrong type of codec) should always fail""" zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype="uint16", filters=[numcodecs.Zstd(level=3)], zarr_format=2, fill_value=0, ) result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 1 assert isinstance(result.exception, TypeError) assert ( str(result.exception) == "Filter is not an ArrayArrayCodec" ) def test_migrate_incorrect_compressor(local_store: LocalStore) -> None: """Attempting to convert a compressor (which is the wrong type of codec) should always fail""" zarr.create_array( store=local_store, shape=(10, 10), chunks=(10, 10), dtype="uint16", compressors=numcodecs.Delta(dtype=" is not a BytesBytesCodec" ) @pytest.mark.parametrize("zarr_format", [2, 3]) def test_remove_metadata_fails_without_force( local_store: LocalStore, zarr_format: ZarrFormat ) -> None: """Test removing metadata (when no alternate metadata is present) fails without --force.""" create_nested_zarr(local_store, zarr_format=zarr_format) result = runner.invoke(cli.app, ["remove-metadata", f"v{zarr_format}", str(local_store.root)]) assert result.exit_code == 1 assert isinstance(result.exception, ValueError) assert str(result.exception).startswith(f"Cannot remove v{zarr_format} metadata at file") @pytest.mark.parametrize("zarr_format", [2, 3]) def test_remove_metadata_succeeds_with_force( local_store: LocalStore, zarr_format: ZarrFormat, expected_paths_no_metadata: list[Path] ) -> None: """Test removing metadata (when no alternate metadata is present) succeeds with --force.""" create_nested_zarr(local_store, zarr_format=zarr_format) result = runner.invoke( cli.app, ["remove-metadata", f"v{zarr_format}", str(local_store.root), "--force"] ) assert result.exit_code == 0 paths = sorted(local_store.root.rglob("*")) expected_paths = [local_store.root / p for p in expected_paths_no_metadata] assert paths == expected_paths def test_remove_metadata_sub_group( local_store: LocalStore, expected_paths_no_metadata: list[Path] ) -> None: """Test only v2 metadata within group_1 is removed and rest remains un-changed.""" create_nested_zarr(local_store) result = runner.invoke( cli.app, ["remove-metadata", "v2", str(local_store.root / "group_1"), "--force"] ) assert result.exit_code == 0 # check all metadata files inside group_1 are removed (.zattrs / .zgroup / .zarray should remain only inside the top # group) paths = sorted(local_store.root.rglob("*")) expected_paths = [local_store.root / p for p in expected_paths_no_metadata] expected_paths.append(local_store.root / ".zattrs") expected_paths.append(local_store.root / ".zgroup") expected_paths.append(local_store.root / "array_0" / ".zarray") expected_paths.append(local_store.root / "array_0" / ".zattrs") assert paths == sorted(expected_paths) @pytest.mark.parametrize( ("zarr_format", "expected_output_paths"), [("v2", "expected_paths_v3_metadata"), ("v3", "expected_paths_v2_metadata")], ) def test_remove_metadata_after_conversion( local_store: LocalStore, request: pytest.FixtureRequest, zarr_format: str, expected_output_paths: str, ) -> None: """Test all v2/v3 metadata can be removed after metadata conversion (all groups / arrays / metadata of other versions should remain as-is)""" create_nested_zarr(local_store) # convert v2 metadata to v3 (so now both v2 and v3 metadata present!), then remove either the v2 or v3 metadata result = runner.invoke(cli.app, ["migrate", "v3", str(local_store.root)]) assert result.exit_code == 0 result = runner.invoke(cli.app, ["remove-metadata", zarr_format, str(local_store.root)]) assert result.exit_code == 0 paths = sorted(local_store.root.rglob("*")) expected_paths = request.getfixturevalue(expected_output_paths) expected_paths = [local_store.root / p for p in expected_paths] assert paths == expected_paths @pytest.mark.parametrize("cli_command", ["migrate", "remove-metadata"]) def test_dry_run( local_store: LocalStore, cli_command: str, expected_paths_v2_metadata: list[Path] ) -> None: """Test that all files are un-changed after a dry run""" create_nested_zarr(local_store) if cli_command == "migrate": result = runner.invoke( cli.app, ["migrate", "v3", str(local_store.root), "--overwrite", "--force", "--dry-run"] ) else: result = runner.invoke( cli.app, ["remove-metadata", "v2", str(local_store.root), "--force", "--dry-run"] ) assert result.exit_code == 0 paths = sorted(local_store.root.rglob("*")) expected_paths = [local_store.root / p for p in expected_paths_v2_metadata] assert paths == expected_paths zarr-python-3.3.0/tests/test_coalesce.py000066400000000000000000000577731523267620000203710ustar00rootroot00000000000000# tests/test_coalesce.py from __future__ import annotations import asyncio from dataclasses import dataclass, field from typing import TYPE_CHECKING import pytest from zarr.abc.store import ( ByteRequest, OffsetByteRequest, RangeByteRequest, SuffixByteRequest, ) from zarr.core._coalesce import ( coalesce_ranges, coalesced_get, ) from zarr.core.buffer import Buffer, default_buffer_prototype if TYPE_CHECKING: from collections.abc import AsyncIterator, Callable, Mapping, Sequence def _buf(data: bytes) -> Buffer: return default_buffer_prototype().buffer.from_bytes(data) @dataclass class FakeFetch: """Records every call and serves canned bytes from an in-memory blob.""" blob: bytes key_exists: bool = True raise_on: Callable[[ByteRequest | None], bool] | None = None calls: list[ByteRequest | None] = field(default_factory=list) async def __call__(self, byte_range: ByteRequest | None) -> Buffer | None: self.calls.append(byte_range) if not self.key_exists: return None if self.raise_on is not None and self.raise_on(byte_range): raise OSError("injected") if byte_range is None: return _buf(self.blob) if isinstance(byte_range, RangeByteRequest): return _buf(self.blob[byte_range.start : byte_range.end]) if isinstance(byte_range, OffsetByteRequest): return _buf(self.blob[byte_range.offset :]) if isinstance(byte_range, SuffixByteRequest): return _buf(self.blob[-byte_range.suffix :]) raise AssertionError(f"unknown byte_range {byte_range!r}") async def _collect( agen: AsyncIterator[Sequence[tuple[int, Buffer | None]]], ) -> list[list[tuple[int, Buffer | None]]]: """Drain an async generator of groups into a list of lists of tuples.""" return [list(group) async for group in agen] def _contents(groups: list[list[tuple[int, Buffer | None]]]) -> dict[int, bytes]: """Flatten to {index: bytes}.""" result: dict[int, bytes] = {} for group in groups: for idx, buf in group: assert buf is not None result[idx] = buf.to_bytes() return result # --------------------------------------------------------------------------- # Shared coalescing-knob bundles. Each is a complete mapping of all three # kwargs to splat into `coalesced_get`; `coalesce_ranges` ignores # `max_concurrency`. The leaf functions in `_coalesce.py` require all knobs # explicitly — `Store.get_ranges` is the public entry point and owns the # canonical defaults. Tests pick their own values appropriate to the scenario. # --------------------------------------------------------------------------- # Permissive default for tests that don't care about specific thresholds. Mirrors # `Store.get_ranges`'s public defaults but the test file owns this independently # of any production constants. DEFAULT: Mapping[str, int] = { "max_concurrency": 10, "max_gap_bytes": 1 << 20, "max_coalesced_bytes": 16 << 20, } """Permissive defaults; mirrors `Store.get_ranges`'s baseline.""" MERGE_GAP_50: Mapping[str, int] = { "max_concurrency": 10, "max_gap_bytes": 50, "max_coalesced_bytes": 1 << 20, } """Merge ranges within 50 bytes of each other.""" NO_MERGE: Mapping[str, int] = { "max_concurrency": 10, "max_gap_bytes": -1, "max_coalesced_bytes": 1 << 20, } """No merging: any positive gap is > -1, so no pair ever coalesces.""" CAP_50: Mapping[str, int] = { "max_concurrency": 10, "max_gap_bytes": 1000, "max_coalesced_bytes": 50, } """Gap permissive but merged size capped at 50 bytes.""" def _grouping(opts: Mapping[str, int]) -> dict[str, int]: """Return only the grouping knobs from a full options bundle. `coalesce_ranges` rejects `max_concurrency`; this lets test bundles be full kwargs maps (for `coalesced_get`) and still be passed to the pure planner via splat. """ return {k: v for k, v in opts.items() if k != "max_concurrency"} # A deterministic blob used for content-sensitive cases: byte i == (i % 256). _INDEXED_BLOB = bytes(i % 256 for i in range(10_000)) # --------------------------------------------------------------------------- # Parametrized structural/content tests (cases without async timing or errors). # --------------------------------------------------------------------------- @dataclass(frozen=True) class StructuralCase: """One row of the parametrized structure-and-contents table.""" id: str """pytest id for the case.""" ranges: list[ByteRequest | None] """Input to coalesced_get.""" options: Mapping[str, int] """Coalescing knobs to splat into `coalesced_get`.""" expected_group_sizes: list[int] """Sorted list of group tuple-counts (order-independent).""" expected_contents: dict[int, bytes] | None = None """{input_index: bytes} to verify bytes, or None to skip the content check.""" expected_n_fetches: int | None = None """Exact number of calls to the fetch callable, or None to skip the check.""" _STRUCTURAL_CASES: list[StructuralCase] = [ StructuralCase( id="empty-input", ranges=[], options=DEFAULT, expected_group_sizes=[], expected_n_fetches=0, ), StructuralCase( id="single-range", ranges=[RangeByteRequest(2, 5)], options=DEFAULT, expected_group_sizes=[1], expected_contents={0: _INDEXED_BLOB[2:5]}, expected_n_fetches=1, ), StructuralCase( id="disjoint-3-no-merge", ranges=[ RangeByteRequest(0, 10), RangeByteRequest(200, 210), RangeByteRequest(500, 510), ], options=MERGE_GAP_50, expected_group_sizes=[1, 1, 1], expected_contents={ 0: _INDEXED_BLOB[0:10], 1: _INDEXED_BLOB[200:210], 2: _INDEXED_BLOB[500:510], }, expected_n_fetches=3, ), StructuralCase( id="adjacent-3-one-merged-group", ranges=[ RangeByteRequest(0, 5), RangeByteRequest(10, 15), RangeByteRequest(20, 25), ], options=MERGE_GAP_50, expected_group_sizes=[3], expected_contents={ 0: _INDEXED_BLOB[0:5], 1: _INDEXED_BLOB[10:15], 2: _INDEXED_BLOB[20:25], }, expected_n_fetches=1, ), StructuralCase( id="two-clusters-one-singleton", ranges=[ RangeByteRequest(0, 10), RangeByteRequest(20, 30), RangeByteRequest(500, 510), ], options=MERGE_GAP_50, expected_group_sizes=[1, 2], expected_contents={ 0: _INDEXED_BLOB[0:10], 1: _INDEXED_BLOB[20:30], 2: _INDEXED_BLOB[500:510], }, expected_n_fetches=2, ), StructuralCase( id="uncoalescable-mixed-with-range", ranges=[ RangeByteRequest(0, 3), OffsetByteRequest(5), SuffixByteRequest(2), None, ], options=DEFAULT, expected_group_sizes=[1, 1, 1, 1], expected_contents={ 0: _INDEXED_BLOB[0:3], 1: _INDEXED_BLOB[5:], 2: _INDEXED_BLOB[-2:], 3: _INDEXED_BLOB, }, expected_n_fetches=4, ), StructuralCase( id="shuffled-input-indices-preserved", ranges=[ RangeByteRequest(500, 510), RangeByteRequest(0, 10), RangeByteRequest(200, 210), RangeByteRequest(300, 310), ], options=MERGE_GAP_50, expected_group_sizes=[1, 1, 1, 1], expected_contents={ 0: _INDEXED_BLOB[500:510], 1: _INDEXED_BLOB[0:10], 2: _INDEXED_BLOB[200:210], 3: _INDEXED_BLOB[300:310], }, expected_n_fetches=4, ), StructuralCase( id="cap-prevents-merge-of-close-ranges", # 20 + 20 gap + 20 = 60-byte merged span > cap of 50. ranges=[RangeByteRequest(0, 20), RangeByteRequest(40, 60)], options=CAP_50, expected_group_sizes=[1, 1], expected_n_fetches=2, ), StructuralCase( id="single-range-larger-than-cap-passes-through", # Cap only applies to MERGE decisions; a lone oversized range still fetches. ranges=[RangeByteRequest(0, 200)], options=CAP_50, expected_group_sizes=[1], expected_contents={0: _INDEXED_BLOB[0:200]}, expected_n_fetches=1, ), ] @pytest.mark.parametrize("case", _STRUCTURAL_CASES, ids=lambda c: c.id) async def test_coalescing_structure_and_contents(case: StructuralCase) -> None: """Group structure, byte contents, and fetch-call count for the deterministic cases.""" fetch = FakeFetch(_INDEXED_BLOB) groups = await _collect(coalesced_get(fetch, case.ranges, **case.options)) assert sorted(len(g) for g in groups) == sorted(case.expected_group_sizes) if case.expected_contents is not None: assert _contents(groups) == case.expected_contents if case.expected_n_fetches is not None: assert len(fetch.calls) == case.expected_n_fetches # --------------------------------------------------------------------------- # Focused non-parametrized tests for cases with distinctive assertion shapes. # --------------------------------------------------------------------------- async def test_within_group_ordering_is_start_offset() -> None: """Within a merged group, tuples are ordered by start offset, not input order.""" fetch = FakeFetch(_INDEXED_BLOB) # Two ranges that merge; one has a later start but is listed first in input. ranges: list[ByteRequest | None] = [RangeByteRequest(20, 25), RangeByteRequest(0, 5)] groups = await _collect(coalesced_get(fetch, ranges, **MERGE_GAP_50)) assert len(groups) == 1 # Input index 1 (start=0) comes first, then 0 (start=20). assert [idx for idx, _ in groups[0]] == [1, 0] async def test_adjacent_ranges_fire_single_fetch_spanning_merged_region() -> None: """Verify the merged fetch covers exactly the span from min-start to max-end.""" fetch = FakeFetch(_INDEXED_BLOB) ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 5), RangeByteRequest(10, 15), RangeByteRequest(20, 25), ] await _collect(coalesced_get(fetch, ranges, **MERGE_GAP_50)) assert len(fetch.calls) == 1 call = fetch.calls[0] assert isinstance(call, RangeByteRequest) assert call.start == 0 assert call.end == 25 # --------------------------------------------------------------------------- # Concurrency and cancellation. # --------------------------------------------------------------------------- async def test_max_concurrency_is_honored() -> None: """With 10 non-mergeable ranges and max_concurrency=3, peak in-flight must not exceed 3.""" in_flight = 0 peak = 0 lock = asyncio.Lock() async def fetch(byte_range: ByteRequest | None) -> Buffer | None: nonlocal in_flight, peak async with lock: in_flight += 1 peak = max(peak, in_flight) # give the scheduler a chance to run other tasks await asyncio.sleep(0.01) async with lock: in_flight -= 1 return _buf(b"x") ranges: list[ByteRequest | None] = [RangeByteRequest(i * 1000, i * 1000 + 1) for i in range(10)] opts: Mapping[str, int] = { "max_gap_bytes": 0, # force no merging "max_coalesced_bytes": 1 << 20, "max_concurrency": 3, } async for _group in coalesced_get(fetch, ranges, **opts): pass assert peak <= 3 assert peak >= 2 # must have been some real concurrency async def test_consumer_break_cancels_pending_fetches() -> None: """Breaking out of the async for should cancel pending fetches rather than let them complete.""" completed_calls = 0 cancelled_calls = 0 async def fetch(byte_range: ByteRequest | None) -> Buffer | None: nonlocal completed_calls, cancelled_calls assert isinstance(byte_range, RangeByteRequest) start = byte_range.start try: # First fetch returns fast so the async-for body runs and can break. # Later fetches sleep long enough that cancellation has room to land. await asyncio.sleep(0.001 if start == 0 else 2.0) except asyncio.CancelledError: cancelled_calls += 1 raise completed_calls += 1 return _buf(b"x") opts: Mapping[str, int] = { "max_gap_bytes": -1, # no merging "max_coalesced_bytes": 1 << 20, "max_concurrency": 3, } ranges: list[ByteRequest | None] = [RangeByteRequest(i * 1000, i * 1000 + 1) for i in range(6)] agen = coalesced_get(fetch, ranges, **opts) async for _group in agen: break # Explicitly close the generator so its finally block runs (cancelling # in-flight tasks) before we make assertions. await agen.aclose() # The fast task completes; the remaining tasks are either cancelled while # sleeping (raising CancelledError into the user try block) or cancelled # while still waiting on the semaphore (which doesn't enter the try at all). # Either way, none of them should be allowed to complete. assert completed_calls == 1 assert cancelled_calls >= 1 assert completed_calls + cancelled_calls <= len(ranges) # --------------------------------------------------------------------------- # Key-missing semantics. # --------------------------------------------------------------------------- async def test_key_missing_from_first_call_raises() -> None: """If the very first fetch returns None, the iterator raises an ExceptionGroup containing FileNotFoundError.""" fetch = FakeFetch(b"x" * 100, key_exists=False) ranges: list[ByteRequest | None] = [RangeByteRequest(0, 10), RangeByteRequest(20, 30)] with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): await _collect(coalesced_get(fetch, ranges, **DEFAULT)) @pytest.mark.parametrize( "byte_range", [OffsetByteRequest(5), SuffixByteRequest(5), None], ids=["offset", "suffix", "none"], ) async def test_key_missing_on_uncoalescable_input_raises( byte_range: ByteRequest | None, ) -> None: """Uncoalescable inputs take a distinct path; key-missing must still raise (wrapped in a group).""" fetch = FakeFetch(b"x" * 100, key_exists=False) with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): await _collect(coalesced_get(fetch, [byte_range], **DEFAULT)) async def test_key_missing_mid_stream_raises_after_earlier_groups() -> None: """If a later fetch returns None, earlier-completed groups yield before the raise.""" call_count = 0 async def fetch(byte_range: ByteRequest | None) -> Buffer | None: nonlocal call_count call_count += 1 # Deterministic: first call serves, second returns None. await asyncio.sleep(0.01 if call_count == 1 else 0.02) if call_count >= 2: return None return _buf(b"ok") opts: Mapping[str, int] = { "max_gap_bytes": -1, "max_coalesced_bytes": 1 << 20, "max_concurrency": 1, # serialize for determinism } ranges: list[ByteRequest | None] = [RangeByteRequest(0, 2), RangeByteRequest(100, 102)] agen = coalesced_get(fetch, ranges, **opts) first = await anext(agen) assert len(first) == 1 with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): await anext(agen) async def test_key_missing_mid_stream_with_concurrency_cancels_late_arrivals() -> None: """ Under max_concurrency > 1, a mid-stream miss should raise FileNotFoundError and cancel still-in-flight unrelated tasks rather than wait for them. """ late_gate = asyncio.Event() miss_fired = asyncio.Event() # Driven by the test body after the first successful yield, so the miss # task can't race past the start=0 result. fire_miss = asyncio.Event() async def fetch(byte_range: ByteRequest | None) -> Buffer | None: assert isinstance(byte_range, RangeByteRequest) start = byte_range.start if start == 0: return _buf(b"ok") if start == 1000: # Wait for the test to give the green light before returning None. # This makes ordering deterministic regardless of scheduling. await asyncio.wait_for(fire_miss.wait(), timeout=5.0) miss_fired.set() return None # Late arrivals would block on this gate; they should be cancelled # before they ever return. await asyncio.wait_for(late_gate.wait(), timeout=5.0) return _buf(b"ok") opts: Mapping[str, int] = { "max_gap_bytes": -1, "max_coalesced_bytes": 1 << 20, "max_concurrency": 3, } ranges: list[ByteRequest | None] = [RangeByteRequest(i * 1000, i * 1000 + 1) for i in range(7)] agen = coalesced_get(fetch, ranges, **opts) first = await anext(agen) assert len(first) == 1 idx, buf = first[0] assert idx == 0 assert buf is not None # Now that #0 has yielded, signal the miss task to return None. fire_miss.set() with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): await anext(agen) assert miss_fired.is_set() # Sanity: late_gate was never set, so the cancellation path is what completed the test. assert not late_gate.is_set() # --------------------------------------------------------------------------- # Error propagation. # --------------------------------------------------------------------------- async def test_fetch_raises_propagates() -> None: """An exception raised by fetch propagates on the yield that produced the failing group.""" fetch = FakeFetch( _INDEXED_BLOB, raise_on=lambda r: isinstance(r, RangeByteRequest) and r.start >= 100, ) opts: Mapping[str, int] = { "max_gap_bytes": -1, "max_coalesced_bytes": 1 << 20, "max_concurrency": 1, } ranges: list[ByteRequest | None] = [RangeByteRequest(0, 10), RangeByteRequest(200, 210)] with pytest.RaisesGroup(pytest.RaisesExc(OSError, match="injected")): await _collect(coalesced_get(fetch, ranges, **opts)) # --------------------------------------------------------------------------- # Property-style coverage invariant. # --------------------------------------------------------------------------- async def test_coverage_invariant_random_inputs() -> None: """For any random RangeByteRequest input, every input index appears exactly once.""" import random rng = random.Random(42) fetch = FakeFetch(_INDEXED_BLOB) ranges: list[ByteRequest | None] = [] for _ in range(50): start = rng.randint(0, 9000) length = rng.randint(1, 500) ranges.append(RangeByteRequest(start, start + length)) groups = await _collect(coalesced_get(fetch, ranges, **DEFAULT)) seen: list[int] = [idx for group in groups for idx, _buf in group] assert sorted(seen) == list(range(len(ranges))) flat = _contents(groups) for i, r in enumerate(ranges): assert isinstance(r, RangeByteRequest) assert flat[i] == _INDEXED_BLOB[r.start : r.end] # --------------------------------------------------------------------------- # Pure-function tests for coalesce_ranges (no async, no fetch). # --------------------------------------------------------------------------- def test_coalesce_ranges_empty_input() -> None: groups, uncoalescable = coalesce_ranges([], max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20) assert groups == [] assert uncoalescable == [] def test_coalesce_ranges_separates_coalescable_from_uncoalescable() -> None: ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 10), OffsetByteRequest(100), SuffixByteRequest(5), None, RangeByteRequest(20, 30), ] groups, uncoalescable = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) # Both range requests fall within MERGE_GAP_50's gap budget. assert len(groups) == 1 assert [idx for idx, _ in groups[0]] == [0, 4] # Non-RangeByteRequest entries preserve their original input indices. assert [(idx, type(req).__name__ if req else None) for idx, req in uncoalescable] == [ (1, "OffsetByteRequest"), (2, "SuffixByteRequest"), (3, None), ] def test_coalesce_ranges_no_merge_when_gap_exceeds_budget() -> None: ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 10), RangeByteRequest(200, 210), RangeByteRequest(500, 510), ] groups, uncoalescable = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) assert uncoalescable == [] assert [len(g) for g in groups] == [1, 1, 1] assert [idx for g in groups for idx, _ in g] == [0, 1, 2] def test_coalesce_ranges_merges_within_gap_budget() -> None: ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 5), RangeByteRequest(10, 15), RangeByteRequest(20, 25), ] groups, _ = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) assert len(groups) == 1 assert [idx for idx, _ in groups[0]] == [0, 1, 2] def test_coalesce_ranges_respects_max_coalesced_bytes() -> None: # Gap budget is permissive (1000), but the merged span would exceed CAP_50's # 50-byte cap, so the second range starts a new group. ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 30), RangeByteRequest(40, 80), ] groups, _ = coalesce_ranges(ranges, **_grouping(CAP_50)) assert [len(g) for g in groups] == [1, 1] def test_coalesce_ranges_groups_are_sorted_by_start() -> None: """Input order is irrelevant; groups always emerge in start-offset order.""" ranges: list[ByteRequest | None] = [ RangeByteRequest(500, 510), RangeByteRequest(0, 10), RangeByteRequest(20, 30), RangeByteRequest(200, 210), ] groups, _ = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) # First group is the {0-10, 20-30} cluster (from input indices 1, 2). # Then the {200-210} singleton, then {500-510}. flat = [idx for g in groups for idx, _ in g] assert flat == [1, 2, 3, 0] # Within each group, members are sorted by start. for g in groups: starts = [r.start for _, r in g] assert starts == sorted(starts) def test_coalesce_ranges_overlapping_ranges_merge() -> None: """Nested/overlapping ranges have a non-positive 'gap' and always merge.""" ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 100), RangeByteRequest(50, 60), # nested RangeByteRequest(80, 120), # overlaps ] groups, _ = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) assert len(groups) == 1 assert [idx for idx, _ in groups[0]] == [0, 1, 2] def test_coalesce_ranges_running_end_handles_nesting() -> None: """A subsequent range fully inside the running span must not extend group_end backwards.""" ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 1000), # group_end=1000 RangeByteRequest(100, 200), # nested; group_end stays at 1000 RangeByteRequest(990, 1010), # gap = -10 from running end, still merges ] groups, _ = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) assert len(groups) == 1 assert {idx for idx, _ in groups[0]} == {0, 1, 2} def test_coalesce_ranges_only_uncoalescable_inputs() -> None: ranges: list[ByteRequest | None] = [None, OffsetByteRequest(10), SuffixByteRequest(5)] groups, uncoalescable = coalesce_ranges( ranges, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20 ) assert groups == [] assert [idx for idx, _ in uncoalescable] == [0, 1, 2] def test_coalesce_ranges_total_index_coverage() -> None: """Every input index appears exactly once across groups + uncoalescable.""" ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 10), None, RangeByteRequest(15, 25), OffsetByteRequest(100), RangeByteRequest(30, 40), ] groups, uncoalescable = coalesce_ranges(ranges, **_grouping(MERGE_GAP_50)) seen = sorted([idx for g in groups for idx, _ in g] + [idx for idx, _ in uncoalescable]) assert seen == list(range(len(ranges))) zarr-python-3.3.0/tests/test_codec_entrypoints.py000066400000000000000000000023011523267620000223170ustar00rootroot00000000000000import pytest import zarr.registry from zarr import config @pytest.mark.usefixtures("set_path") @pytest.mark.parametrize("codec_name", ["TestEntrypointCodec", "TestEntrypointGroup.Codec"]) def test_entrypoint_codec(codec_name: str) -> None: config.set({"codecs.test": f"package_with_entrypoint.{codec_name}"}) cls_test = zarr.registry.get_codec_class("test") assert cls_test.__qualname__ == codec_name @pytest.mark.usefixtures("set_path") def test_entrypoint_pipeline() -> None: config.set({"codec_pipeline.path": "package_with_entrypoint.TestEntrypointCodecPipeline"}) cls = zarr.registry.get_pipeline_class() assert cls.__name__ == "TestEntrypointCodecPipeline" @pytest.mark.usefixtures("set_path") @pytest.mark.parametrize("buffer_name", ["TestEntrypointBuffer", "TestEntrypointGroup.Buffer"]) def test_entrypoint_buffer(buffer_name: str) -> None: config.set( { "buffer": f"package_with_entrypoint.{buffer_name}", "ndbuffer": "package_with_entrypoint.TestEntrypointNDBuffer", } ) assert zarr.registry.get_buffer_class().__qualname__ == buffer_name assert zarr.registry.get_ndbuffer_class().__name__ == "TestEntrypointNDBuffer" zarr-python-3.3.0/tests/test_codec_pipeline.py000066400000000000000000000270241523267620000215370ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Any import numpy as np import pytest pytest.importorskip("hypothesis") import hypothesis.strategies as st from hypothesis import given import zarr from zarr.codecs import BytesCodec, CastValue, GzipCodec, TransposeCodec from zarr.core.array import _get_chunk_spec from zarr.core.buffer.core import default_buffer_prototype from zarr.core.codec_pipeline import codecs_from_list from zarr.core.config import config as zarr_config from zarr.core.indexing import BasicIndexer from zarr.storage import MemoryStore if TYPE_CHECKING: from collections.abc import Callable, Generator from zarr.abc.codec import Codec @pytest.fixture(autouse=True) def _enable_rectilinear_chunks() -> Generator[None]: """Enable rectilinear chunks for all tests in this module.""" with zarr_config.set({"array.rectilinear_chunks": True}): yield pipeline_paths = [ "zarr.core.codec_pipeline.BatchedCodecPipeline", "zarr.core.codec_pipeline.FusedCodecPipeline", ] @pytest.fixture(params=pipeline_paths, ids=["batched", "sync"]) def pipeline_class(request: pytest.FixtureRequest) -> Generator[str]: """Temporarily set the codec pipeline class for the test.""" path = request.param with zarr_config.set({"codec_pipeline.path": path}): yield path # --------------------------------------------------------------------------- # GetResult status tests (low-level pipeline API) # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("write_slice", "read_slice", "expected_statuses"), [ (slice(None), slice(None), ("present", "present", "present")), (slice(0, 2), slice(None), ("present", "missing", "missing")), (None, slice(None), ("missing", "missing", "missing")), ], ) async def test_read_returns_get_results( pipeline_class: str, write_slice: slice | None, read_slice: slice, expected_statuses: tuple[str, ...], ) -> None: """CodecPipeline.read returns GetResult with correct statuses.""" store = MemoryStore() arr = zarr.open_array(store, mode="w", shape=(6,), chunks=(2,), dtype="int64", fill_value=-1) if write_slice is not None: arr[write_slice] = 0 async_arr = arr._async_array pipeline = async_arr.codec_pipeline metadata = async_arr.metadata prototype = default_buffer_prototype() config = async_arr.config indexer = BasicIndexer( read_slice, shape=metadata.shape, chunk_grid=async_arr._chunk_grid, ) out_buffer = prototype.nd_buffer.empty( shape=indexer.shape, dtype=metadata.dtype.to_native_dtype(), order=config.order, ) results = await pipeline.read( [ ( async_arr.store_path / metadata.encode_chunk_key(chunk_coords), _get_chunk_spec(metadata, async_arr._chunk_grid, chunk_coords, config, prototype), chunk_selection, out_selection, is_complete_chunk, ) for chunk_coords, chunk_selection, out_selection, is_complete_chunk in indexer ], out_buffer, drop_axes=indexer.drop_axes, ) assert len(results) == len(expected_statuses) for result, expected_status in zip(results, expected_statuses, strict=True): assert result["status"] == expected_status # --------------------------------------------------------------------------- # write_empty_chunks / read_missing_chunks config tests # --------------------------------------------------------------------------- async def test_write_empty_chunks_false_no_store(pipeline_class: str) -> None: """With write_empty_chunks=False, fill_value-only chunks should not be stored.""" store: dict[str, Any] = {} arr = zarr.create_array( store=store, shape=(20,), dtype="float64", chunks=(10,), shards=None, compressors=None, fill_value=0.0, config={"write_empty_chunks": False}, ) arr[:] = 0.0 # all fill_value # Chunks should NOT be persisted assert "c/0" not in store assert "c/1" not in store # But reading should still return fill values np.testing.assert_array_equal(arr[:], np.zeros(20, dtype="float64")) try: import cast_value_rs # noqa: F401 _HAS_CAST_VALUE_RS = True except ModuleNotFoundError: _HAS_CAST_VALUE_RS = False requires_cast_value_rs = pytest.mark.skipif( not _HAS_CAST_VALUE_RS, reason="cast-value-rs not installed" ) @requires_cast_value_rs @pytest.mark.parametrize( ("source_dtype", "target_dtype"), [ # Source is single-byte (no endianness); target is multi-byte (has endianness). # Without the fix, BytesCodec.evolve_from_array_spec sees the source dtype, # strips its `endian` to None, and then chokes when the chunk_spec dtype # gets transformed to the multi-byte target before bytes-decoding. ("int8", "int16"), ("uint8", "int32"), ("int8", "float32"), # Source is multi-byte; target is single-byte (the reverse direction also # exercises the spec-threading logic). ("int16", "int8"), ], ) def test_codec_pipeline_threads_dtype_through_evolve(source_dtype: str, target_dtype: str) -> None: """Regression for #3937: each codec must be evolved against the spec it will see at runtime, not the original array spec. cast_value transforms the dtype between AA codecs and the array->bytes serializer.""" arr = zarr.create_array( store={}, shape=(4,), chunks=(4,), dtype=source_dtype, fill_value=0, filters=[CastValue(data_type=target_dtype)], serializer=BytesCodec(endian="little"), compressors=[], zarr_format=3, overwrite=True, ) arr[:] = np.asarray([0, 1, 2, 3], dtype=source_dtype) np.testing.assert_array_equal(arr[:], np.asarray([0, 1, 2, 3], dtype=source_dtype)) def test_evolve_threads_spec_preserving_serializer_endian(pipeline_class: str) -> None: """Regression for #3937, dependency-free variant. `evolve_from_array_spec` must thread the spec FORWARD through the codec chain: each codec is evolved against the spec produced by the previous one, not the original array spec. An array->array codec that widens the dtype from a single-byte type (no endianness) to a multi-byte type means the BytesCodec serializer must be evolved against the *widened* dtype — otherwise it sees the single-byte source, strips its `endian` to None, and later fails to decode the multi-byte data. The original regression test for this needs `cast_value_rs` (so it only runs in the optional-deps CI job). This variant uses a minimal dtype-widening AA codec stub, so it runs everywhere and on both pipelines via `pipeline_class`. """ from dataclasses import dataclass from zarr.abc.codec import ArrayArrayCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.dtype import get_data_type_from_native_dtype from zarr.registry import get_pipeline_class @dataclass(frozen=True) class _WidenToInt16(ArrayArrayCodec): """Test-only AA codec: reports the encoded dtype as int16 (no real encode).""" is_fixed_size = True def to_dict(self) -> dict[str, Any]: return {"name": "_widen_to_int16"} @classmethod def from_dict(cls, data: dict[str, Any]) -> _WidenToInt16: return cls() def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: from dataclasses import replace return replace(chunk_spec, dtype=get_data_type_from_native_dtype(np.dtype("int16"))) def compute_encoded_size(self, input_byte_length: int, _spec: ArraySpec) -> int: return input_byte_length async def _decode_single(self, chunk_array: Any, chunk_spec: ArraySpec) -> Any: return chunk_array # pragma: no cover async def _encode_single(self, chunk_array: Any, chunk_spec: ArraySpec) -> Any: return chunk_array # pragma: no cover zdtype = get_data_type_from_native_dtype(np.dtype("int8")) # single-byte source spec = ArraySpec( shape=(4,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=False), prototype=default_buffer_prototype(), ) from zarr.core.codec_pipeline import BatchedCodecPipeline, FusedCodecPipeline pipeline = get_pipeline_class().from_codecs((_WidenToInt16(), BytesCodec(endian="little"))) evolved = pipeline.evolve_from_array_spec(spec) # Both concrete pipelines expose `array_bytes_codec`; narrow off the ABC. assert isinstance(evolved, (BatchedCodecPipeline, FusedCodecPipeline)) serializer = evolved.array_bytes_codec # The serializer must keep its little-endian setting: it is evolved against # the widened (int16) dtype, not the single-byte source. assert isinstance(serializer, BytesCodec) assert serializer.endian is not None, ( "BytesCodec serializer lost its `endian` — evolve_from_array_spec did not " "thread the dtype-widening AA codec's spec into the serializer" ) # Property-based check of codecs_from_list ordering validation. # # Valid codec orderings are exactly: (ArrayArrayCodec)* (ArrayBytesCodec) # (BytesBytesCodec)*. codecs_from_list walks adjacent pairs and must raise # TypeError the moment a codec appears in a structurally invalid position -- # notably, a BytesBytesCodec immediately following an ArrayArrayCodec with no # ArrayBytesCodec in between (which previously built an error message but never # raised it, falling through to an unrelated ValueError instead). _AA = "AA" # ArrayArrayCodec -> TransposeCodec _AB = "AB" # ArrayBytesCodec -> BytesCodec _BB = "BB" # BytesBytesCodec -> GzipCodec _CODEC_FACTORY: dict[str, Callable[[], Codec]] = { _AA: lambda: TransposeCodec(order=(0, 1)), _AB: BytesCodec, _BB: GzipCodec, } def _expected_codec_order_outcome(labels: list[str]) -> str: """Independently predict codecs_from_list's outcome: 'TypeError', 'ValueError' or 'ok', mirroring its left-to-right scan and the order in which it checks ordering violations (TypeError) vs. the ArrayBytes-count constraints (ValueError).""" prev = None seen_array_bytes = False for cur in labels: if cur == _AA: if prev in (_AB, _BB): return "TypeError" elif cur == _AB: if prev == _BB: return "TypeError" if seen_array_bytes: return "ValueError" # two ArrayBytesCodecs seen_array_bytes = True else: # _BB if prev == _AA: return "TypeError" prev = cur if not seen_array_bytes: return "ValueError" # Required ArrayBytesCodec was not found return "ok" @given(labels=st.lists(st.sampled_from([_AA, _AB, _BB]), min_size=1, max_size=5)) def test_codecs_from_list_outcome_matches_order_rules(labels: list[str]) -> None: codecs = [_CODEC_FACTORY[label]() for label in labels] expected = _expected_codec_order_outcome(labels) if expected == "TypeError": with pytest.raises(TypeError): codecs_from_list(codecs) elif expected == "ValueError": with pytest.raises(ValueError): codecs_from_list(codecs) else: # Valid ordering: must classify without raising. aa, _ab, bb = codecs_from_list(codecs) assert labels.count(_AA) == len(aa) assert labels.count(_BB) == len(bb) zarr-python-3.3.0/tests/test_codec_pipeline_suite.py000066400000000000000000000536201523267620000227510ustar00rootroot00000000000000"""Shared codec-pipeline behavior suite, run against EVERY codec pipeline. The defining property of a codec pipeline is that the array semantics it produces must be identical no matter which pipeline is configured. To make "one pipeline diverges from the others" structurally hard to ship, every pipeline-agnostic behavior test lives as a method on ``CodecPipelineTests`` and is instantiated once per pipeline (``TestBatchedPipeline`` / ``TestFusedPipeline``). Each test also runs over a *store axis* that exercises both code paths the synchronous pipelines branch on: * ``sync`` -> ``MemoryStore`` (full sync surface: fast path) * ``async`` -> ``_NoSyncIOStore(MemoryStore())`` (NOT sync-capable: async fallback) The async axis is deliberate: a regression that only affects the async fallback of the default pipeline (e.g. a codec-spec-evolution bug that surfaces only on remote stores) is invisible if every test runs on MemoryStore. Running the same battery over a non-sync store closes that gap. Pipeline-specific tests (construction, ``from_codecs``, the byte-range write fast path, etc.) stay in their own modules; only behavior that ALL pipelines must share belongs here. """ from __future__ import annotations from dataclasses import dataclass from typing import TYPE_CHECKING, Any import numcodecs import numpy as np import pytest import zarr from zarr.codecs import BytesCodec, GzipCodec, ShardingCodec, TransposeCodec from zarr.core.config import config as zarr_config from zarr.errors import ChunkNotFoundError from zarr.storage import MemoryStore from zarr.testing.store import LatencyStore if TYPE_CHECKING: from collections.abc import Iterator from zarr.abc.store import Store from zarr.codecs.sharding import SubchunkWriteOrder # --- store axis: a sync store and a non-sync (async-fallback) store ---------- STORE_KINDS = ["sync", "async"] class _NoSyncIOStore(LatencyStore): """An in-memory store that advertises no sync IO capability, so a synchronous pipeline must fall back to its async path. (A plain wrapper won't do: `WrapperStore` forwards the wrapped store's sync capability.)""" @property def _supports_sync_io(self) -> bool: return False def _make_store(kind: str) -> Store: if kind == "sync": # MemoryStore supports get_sync/set_sync -> synchronous fast path. return MemoryStore() if kind == "async": return _NoSyncIOStore(MemoryStore(), get_latency=0.0, set_latency=0.0) raise AssertionError(kind) # --- scenario model ---------------------------------------------------------- # # Most pipeline behavior tests have one shape: # create an array, apply some writes, (optionally) assert which chunk keys # exist, then assert reads come back correct. A Scenario captures exactly those # variables so one parametrized test covers them all. Correctness is checked # against a numpy reference array that the scenario mutates in lock-step with # the zarr array, so cases don't hand-maintain expected values. @dataclass(frozen=True) class Scenario: id: str array_kwargs: dict[str, Any] # (selection, value) writes applied in order. value may be a scalar or array. writes: tuple[tuple[Any, Any], ...] = () # selections to read back and check against the reference. () means "read all". reads: tuple[Any, ...] = (slice(None),) # substrings of chunk keys that must be present / absent after the writes. # Only checked on the sync store (key layout is identical across stores, but # we keep it to one axis to avoid asserting store internals twice). keys_present: tuple[str, ...] = () keys_absent: tuple[str, ...] = () def reference(self) -> np.ndarray: """The numpy array the scenario's writes should produce, starting from the array's fill value.""" kw = self.array_kwargs shape = kw["shape"] dtype = np.dtype(kw["dtype"]) fill = kw.get("fill_value", 0) ref = np.full(shape, fill, dtype=dtype) for sel, value in self.writes: ref[sel] = value return ref def _val(n: int, dtype: str, offset: int = 1) -> np.ndarray: return np.arange(offset, offset + n, dtype=dtype) # Common dtype/chunk presets reused below. _F64 = {"dtype": "float64", "fill_value": 0.0} _I32 = {"dtype": "int32", "fill_value": -1} SCENARIOS: tuple[Scenario, ...] = ( # --- full-array roundtrips across layouts/codecs ------------------------ Scenario( "1d-unsharded-roundtrip", {"shape": (100,), "chunks": (10,), "shards": None, "compressors": None, **_F64}, writes=((slice(None), _val(100, "float64")),), ), Scenario( "1d-sharded-roundtrip", {"shape": (100,), "chunks": (10,), "shards": (100,), "compressors": None, **_F64}, writes=((slice(None), _val(100, "float64")),), ), Scenario( "1d-multi-chunk-shard-roundtrip", {"shape": (100,), "chunks": (10,), "shards": (50,), "compressors": None, **_F64}, writes=((slice(None), _val(100, "float64")),), ), Scenario( "2d-unsharded-roundtrip", {"shape": (10, 20), "chunks": (5, 10), "shards": None, "compressors": None, **_I32}, writes=((slice(None), np.arange(200, dtype="int32").reshape(10, 20)),), ), Scenario( "2d-sharded-roundtrip", {"shape": (20, 20), "chunks": (5, 5), "shards": (10, 10), "compressors": None, **_I32}, writes=((slice(None), np.arange(400, dtype="int32").reshape(20, 20)),), ), Scenario( "1d-gzip-roundtrip", { "shape": (100,), "chunks": (10,), "shards": None, "compressors": {"name": "gzip", "configuration": {"level": 1}}, **_F64, }, writes=((slice(None), _val(100, "float64")),), ), Scenario( "1d-zstd-roundtrip", { "shape": (100,), "chunks": (10,), "shards": None, "compressors": {"name": "zstd", "configuration": {"level": 1}}, **_F64, }, writes=((slice(None), _val(100, "float64")),), ), Scenario( "1d-float32-roundtrip", { "shape": (50,), "chunks": (10,), "shards": None, "compressors": None, "dtype": "float32", "fill_value": 0.0, }, writes=((slice(None), _val(50, "float32")),), ), # zarr v2 goes through the V2Codec wrapper (filters + compressor), a # different codec path than the v3 AA/AB/BB chain — and a different sync # implementation under FusedCodecPipeline. Without these scenarios, v2 was # only exercised implicitly via whichever pipeline is the global default. Scenario( "v2-roundtrip", { "shape": (100,), "chunks": (10,), "shards": None, "compressors": None, "zarr_format": 2, **_F64, }, writes=((slice(None), _val(100, "float64")),), ), Scenario( "v2-gzip-roundtrip", { "shape": (100,), "chunks": (10,), "shards": None, "compressors": numcodecs.GZip(level=1), "zarr_format": 2, **_F64, }, writes=((slice(None), _val(100, "float64")),), ), # v2 filters are the other half of the V2Codec wrapper (numcodecs # array->array filters, a distinct branch from the compressor in # _encode_sync/_decode_sync). Scenario( "v2-filter-gzip-roundtrip", { "shape": (100,), "chunks": (10,), "shards": None, "filters": numcodecs.Delta(dtype="float64"), "compressors": numcodecs.GZip(level=1), "zarr_format": 2, **_F64, }, writes=((slice(None), _val(100, "float64")),), ), # --- read unwritten chunks -> fill value -------------------------------- Scenario( "missing-chunks-fill", { "shape": (100,), "chunks": (10,), "shards": None, "compressors": None, "dtype": "float64", "fill_value": -7.0, }, writes=(), ), Scenario( "missing-chunks-fill-sharded", { "shape": (100,), "chunks": (10,), "shards": (100,), "compressors": None, "dtype": "float64", "fill_value": -7.0, }, writes=(), ), # --- partial write, varied read selections ------------------------------ Scenario( "partial-write-full-read", {"shape": (100,), "chunks": (10,), "shards": None, "compressors": None, **_F64}, writes=((slice(5, 15), _val(10, "float64")),), reads=(slice(None),), ), Scenario( "full-write-strided-read", {"shape": (100,), "chunks": (10,), "shards": None, "compressors": None, **_F64}, writes=((slice(None), _val(100, "float64")),), reads=(np.s_[::3], np.s_[10:20]), ), Scenario( "partial-write-partial-read-sharded", {"shape": (100,), "chunks": (10,), "shards": (100,), "compressors": None, **_F64}, writes=((slice(20, 70), _val(50, "float64")),), reads=(np.s_[30:60], slice(None)), ), # scalar single-element reads from a sharded array hit the sharding codec's # partial-decode path (_decode_partial_single), distinct from slice reads. Scenario( "sharded-scalar-reads-1d", {"shape": (100,), "chunks": (10,), "shards": (50,), "compressors": None, **_F64}, writes=((slice(None), _val(100, "float64")),), reads=(np.s_[0], np.s_[50], np.s_[99], np.s_[::3]), ), Scenario( "sharded-scalar-reads-2d", {"shape": (20, 20), "chunks": (5, 5), "shards": (10, 10), "compressors": None, **_I32}, writes=((slice(None), np.arange(400, dtype="int32").reshape(20, 20)),), reads=(np.s_[0, 0], np.s_[10, 10], np.s_[19, 19]), ), # --- spec-changing codec (transpose): the async-spec-evolution guard ---- Scenario( "transpose", { "shape": (8, 12), "chunks": (2, 4), "shards": None, "filters": [TransposeCodec(order=(1, 0))], "serializer": BytesCodec(), **_I32, }, writes=((slice(None), np.arange(96, dtype="int32").reshape(8, 12)),), reads=(slice(None), np.s_[1:7, 2:10]), ), Scenario( "transpose-gzip", { "shape": (8, 12), "chunks": (2, 4), "shards": None, "filters": [TransposeCodec(order=(1, 0))], "serializer": BytesCodec(), "compressors": GzipCodec(level=1), **_I32, }, writes=((slice(None), np.arange(96, dtype="int32").reshape(8, 12)),), reads=(slice(None), np.s_[1:7, 2:10]), ), # --- nested sharding ---------------------------------------------------- Scenario( "nested-sharding", { "shape": (20, 20), "chunks": (10, 10), "shards": None, "compressors": None, **_I32, "fill_value": 0, "serializer": ShardingCodec( chunk_shape=(10, 10), codecs=[ShardingCodec(chunk_shape=(5, 5))] ), }, writes=((slice(None), np.arange(400, dtype="int32").reshape(20, 20)),), ), # --- partial overwrite of an existing shard (merge) --------------------- Scenario( "partial-shard-overwrite", { "shape": (40,), "chunks": (4,), "shards": (40,), "compressors": None, **_I32, "config": {"write_empty_chunks": True}, }, writes=( (slice(None), np.arange(40, dtype="int32")), (slice(7, 18), _val(11, "int32", 700)), ), ), # --- write_empty_chunks: storage-key presence/absence ------------------- Scenario( "write-empty-false-omits-fill-chunk", { "shape": (20,), "chunks": (10,), "shards": None, "compressors": None, **_F64, "config": {"write_empty_chunks": False}, }, writes=((slice(0, 10), _val(10, "float64")), (slice(10, 20), np.zeros(10, "float64"))), keys_present=("c/0",), keys_absent=("c/1",), ), Scenario( "write-empty-true-persists-fill-chunk", { "shape": (20,), "chunks": (10,), "shards": None, "compressors": None, **_F64, "config": {"write_empty_chunks": True}, }, writes=((slice(None), np.zeros(20, "float64")),), keys_present=("c/0", "c/1"), ), # default config (no explicit write_empty_chunks) must still skip fill chunks Scenario( "default-config-omits-fill-chunk", {"shape": (20,), "chunks": (10,), "shards": None, "compressors": None, **_F64}, writes=((slice(10, 20), np.zeros(10, "float64")),), keys_absent=("c/1",), ), ) class CodecPipelineTests: """Behavior every codec pipeline must satisfy, on sync and async stores. Subclasses set ``pipeline_path`` to the fully-qualified pipeline class. """ pipeline_path: str @pytest.fixture(autouse=True) def _use_pipeline(self) -> Iterator[None]: with zarr_config.set({"codec_pipeline.path": self.pipeline_path}): yield @pytest.fixture(params=STORE_KINDS) def store(self, request: pytest.FixtureRequest) -> Store: return _make_store(request.param) @staticmethod def _chunk_keys(store: Store) -> set[str]: """All non-metadata keys currently in the store (v3 and v2 metadata).""" import asyncio def _is_metadata(key: str) -> bool: tail = key.rsplit("/", 1)[-1] return tail in ("zarr.json", ".zarray", ".zattrs", ".zgroup", ".zmetadata") async def _list() -> set[str]: return {k async for k in store.list() if not _is_metadata(k)} return asyncio.run(_list()) # -- the common shape: create -> write -> [assert keys] -> assert reads ---- @pytest.mark.parametrize("scenario", SCENARIOS, ids=lambda s: s.id) def test_scenario(self, store: Store, scenario: Scenario) -> None: """Create an array, apply the scenario's writes, optionally assert which chunk keys exist, then assert each read selection matches a numpy reference. Run against every pipeline (subclass) and store kind (fixture). """ arr = zarr.create_array(store=store, **scenario.array_kwargs) for sel, value in scenario.writes: arr[sel] = value ref = scenario.reference() for sel in scenario.reads: np.testing.assert_array_equal( arr[sel], ref[sel], err_msg=f"{scenario.id}: read {sel!r} mismatch" ) if scenario.keys_present or scenario.keys_absent: keys = self._chunk_keys(store) for present in scenario.keys_present: assert any(present in k for k in keys), (present, keys) for absent in scenario.keys_absent: assert not any(absent in k for k in keys), (absent, keys) # -- outliers that don't fit the create/write/read scenario shape ---------- def test_read_missing_chunks_false_raises(self, store: Store) -> None: """read_missing_chunks=False makes reading an unwritten chunk an error, not a fill — a different assertion (raises) than the scenario shape.""" arr = zarr.create_array( store=store, shape=(20,), dtype="float64", chunks=(10,), shards=None, compressors=None, fill_value=0.0, config={"read_missing_chunks": False}, ) with pytest.raises(ChunkNotFoundError): arr[:] def test_read_missing_chunks_false_sharded_semantics(self, store: Store) -> None: """read_missing_chunks=False is a STORE-KEY-level promise on sharded arrays. The config exists to help consumers distinguish a transport error from a truly missing chunk. That distinction applies to store keys: a missing SHARD key raises ChunkNotFoundError. It does not cleanly apply to inner subchunks of a shard that was fetched successfully — there is no transport ambiguity there, the shard index simply records the subchunk as absent — so missing inner subchunks fill with the fill value rather than raising. This pins that asymmetry as intentional. """ arr = zarr.create_array( store=store, shape=(100,), dtype="float64", chunks=(10,), shards=(50,), compressors=None, fill_value=-1.0, config={"read_missing_chunks": False}, ) # No shard key exists yet: reading is a missing-store-key error. with pytest.raises(ChunkNotFoundError): arr[:] # Write one inner chunk of the first shard. The shard key now exists, # but most inner subchunks are absent from its index. arr[20:30] = np.arange(10, dtype="float64") # Reading across written + absent inner subchunks of the EXISTING shard # fills rather than raises. out = arr[15:35] expected = np.full(20, -1.0) expected[5:15] = np.arange(10, dtype="float64") np.testing.assert_array_equal(out, expected) # Both halves of the asymmetry in ONE read against the SAME partially # written array: shard 0 exists (absent subchunks fill), shard 1 has no # store key (raises) — pins that the raise still fires once some shard # exists, and not only on a fully-empty array. with pytest.raises(ChunkNotFoundError): arr[:] with pytest.raises(ChunkNotFoundError): arr[45:55] # spans the existing and the missing shard @pytest.mark.parametrize("subchunk_write_order", ["morton", "lexicographic", "colexicographic"]) def test_partial_write_after_reopen_is_correct( self, store: Store, subchunk_write_order: SubchunkWriteOrder ) -> None: """Has an extra step the scenario shape lacks — a REOPEN between writes. Reopening a sharded array and partially overwriting it must read back correctly regardless of the original subchunk_write_order. subchunk_write_ order is intentionally NOT recoverable on reopen, so chunk locations on a write to an existing shard must come from the STORED shard index, not the (now-default) live order. A non-square inner grid makes the orders physically distinct, so a wrong offset would corrupt data and fail here. """ shape, shard, inner = (6, 4), (6, 4), (2, 2) arr = zarr.create_array( store=store, shape=shape, dtype="int32", chunks=shard, fill_value=-1, compressors=None, config={"write_empty_chunks": True}, serializer=ShardingCodec( chunk_shape=inner, codecs=[BytesCodec()], subchunk_write_order=subchunk_write_order ), ) ref = np.arange(24, dtype="int32").reshape(shape) arr[:] = ref reopened = zarr.open_array(store=store, mode="r+") reopened[1:5, 0:3] = 777 # partial overwrite into the existing shard ref[1:5, 0:3] = 777 np.testing.assert_array_equal(reopened[:], ref) def test_empty_shard_deleted_after_overwrite_to_fill(self, store: Store) -> None: """A shard written with real data and then fully overwritten back to the fill value must have its store key deleted, not left as a stale blob. This has a mid-sequence key assertion (present after write 1, absent after write 2) that the create/write/read scenario shape can't express. """ arr = zarr.create_array( store=store, shape=(16,), chunks=(4,), shards=(8,), dtype="float64", compressors=None, fill_value=0.0, ) arr[0:8] = np.arange(8, dtype="float64") + 1 assert any("c/0" in k for k in self._chunk_keys(store)) arr[0:8] = 0.0 assert not any("c/0" in k for k in self._chunk_keys(store)), ( "shard should be deleted when fully overwritten to fill value" ) def test_read_write_methods_do_not_branch_on_sharding_codec_type(self) -> None: """Pipeline read/write must dispatch on supports_partial_encode/decode, not isinstance(ShardingCodec) — a static guard against type-branching. Scoped to this pipeline's own read/write methods (other helpers, e.g. metadata validation, may legitimately isinstance-check ShardingCodec). """ import inspect import re from zarr.registry import get_pipeline_class # The autouse _use_pipeline fixture has set codec_pipeline.path to this # subclass's pipeline; resolve the class it points at and guard that. # reload_config=False so the fixture's config override is honored # (reload_config=True re-reads the base config, ignoring the override). cls = get_pipeline_class(reload_config=False) pattern = re.compile(r"isinstance\s*\([^)]*ShardingCodec[^)]*\)") for method_name in ("read", "write", "read_sync", "write_sync"): method = getattr(cls, method_name, None) if method is None: continue matches = pattern.findall(inspect.getsource(method)) assert not matches, ( f"{cls.__name__}.{method_name} contains an isinstance check on " f"ShardingCodec; use supports_partial_encode/decode instead. " f"Matches: {matches}" ) class TestBatchedPipeline(CodecPipelineTests): pipeline_path = "zarr.core.codec_pipeline.BatchedCodecPipeline" class TestFusedPipeline(CodecPipelineTests): pipeline_path = "zarr.core.codec_pipeline.FusedCodecPipeline" zarr-python-3.3.0/tests/test_codecs/000077500000000000000000000000001523267620000174565ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_codecs/__init__.py000066400000000000000000000000001523267620000215550ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_codecs/test_blosc.py000066400000000000000000000233611523267620000221760ustar00rootroot00000000000000import enum import json import warnings from typing import Any, cast import numcodecs import numpy as np import pytest from packaging.version import Version import zarr from zarr.abc.codec import SupportsSyncCodec from zarr.codecs import BloscCodec from zarr.codecs.blosc import ( BLOSC_CNAME, BLOSC_SHUFFLE, BloscCname, BloscCnameLiteral, BloscShuffle, BloscShuffleLiteral, ) from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import UInt16, get_data_type_from_native_dtype from zarr.storage import MemoryStore, StorePath @pytest.mark.parametrize("dtype", ["uint8", "uint16"]) async def test_blosc_evolve(dtype: str) -> None: typesize = np.dtype(dtype).itemsize path = "blosc_evolve" store = MemoryStore() spath = StorePath(store, path) zarr.create_array( spath, shape=(16, 16), chunks=(16, 16), dtype=dtype, fill_value=0, compressors=BloscCodec(), ) buf = await store.get(f"{path}/zarr.json", prototype=default_buffer_prototype()) assert buf is not None zarr_json = json.loads(buf.to_bytes()) blosc_configuration_json = zarr_json["codecs"][1]["configuration"] assert blosc_configuration_json["typesize"] == typesize if typesize == 1: assert blosc_configuration_json["shuffle"] == "bitshuffle" else: assert blosc_configuration_json["shuffle"] == "shuffle" path2 = "blosc_evolve_sharding" spath2 = StorePath(store, path2) zarr.create_array( spath2, shape=(16, 16), chunks=(16, 16), shards=(16, 16), dtype=dtype, fill_value=0, compressors=BloscCodec(), ) buf = await store.get(f"{path2}/zarr.json", prototype=default_buffer_prototype()) assert buf is not None zarr_json = json.loads(buf.to_bytes()) blosc_configuration_json = zarr_json["codecs"][0]["configuration"]["codecs"][1]["configuration"] assert blosc_configuration_json["typesize"] == typesize if typesize == 1: assert blosc_configuration_json["shuffle"] == "bitshuffle" else: assert blosc_configuration_json["shuffle"] == "shuffle" @pytest.mark.parametrize("shuffle", [None, "bitshuffle", "legacy-enum"]) @pytest.mark.parametrize("typesize", [None, 1, 2]) def test_tunable_attrs_param( shuffle: None | BloscShuffleLiteral | str, typesize: None | int ) -> None: """ Test that the tunable_attrs parameter is set as expected when creating a BloscCodec. """ # Materialize BloscShuffle.shuffle via the deprecation shim without # contaminating the BloscCodec construction below with that warning. if shuffle == "legacy-enum": with pytest.warns(DeprecationWarning, match="BloscShuffle.shuffle"): shuffle_arg: None | BloscShuffleLiteral | str = BloscShuffle.shuffle else: shuffle_arg = shuffle codec = BloscCodec(typesize=typesize, shuffle=cast(BloscShuffleLiteral | None, shuffle_arg)) if shuffle_arg is None: assert codec.shuffle == "bitshuffle" # default shuffle assert "shuffle" in codec._tunable_attrs if typesize is None: assert codec.typesize == 1 # default typesize assert "typesize" in codec._tunable_attrs new_dtype = UInt16() array_spec = ArraySpec( shape=(1,), dtype=new_dtype, fill_value=1, prototype=default_buffer_prototype(), config=cast(ArrayConfig, {}), ) evolved_codec = codec.evolve_from_array_spec(array_spec=array_spec) if typesize is None: assert evolved_codec.typesize == new_dtype.item_size else: assert evolved_codec.typesize == codec.typesize if shuffle_arg is None: assert evolved_codec.shuffle == "shuffle" else: assert evolved_codec.shuffle == codec.shuffle async def test_typesize() -> None: a = np.arange(1000000, dtype=np.uint64) codecs = [zarr.codecs.BytesCodec(), zarr.codecs.BloscCodec()] z = zarr.array(a, chunks=(10000), codecs=codecs) data = await z.store.get("c/0", prototype=default_buffer_prototype()) assert data is not None bytes = data.to_bytes() size = len(bytes) msg = f"Blosc size mismatch. First 10 bytes: {bytes[:20]!r} and last 10 bytes: {bytes[-20:]!r}" if Version(numcodecs.__version__) >= Version("0.16.0"): expected_size = 402 assert size == expected_size, msg else: expected_size = 10216 assert size == expected_size, msg def test_blosc_codec_supports_sync() -> None: assert isinstance(BloscCodec(), SupportsSyncCodec) def test_blosc_codec_sync_roundtrip() -> None: codec = BloscCodec(typesize=8) arr = np.arange(100, dtype="float64") zdtype = get_data_type_from_native_dtype(arr.dtype) spec = ArraySpec( shape=arr.shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) buf = default_buffer_prototype().buffer.from_array_like(arr.view("B")) encoded = codec._encode_sync(buf, spec) assert encoded is not None decoded = codec._decode_sync(encoded, spec) result = np.frombuffer(decoded.as_numpy_array(), dtype="float64") np.testing.assert_array_equal(arr, result) @pytest.mark.parametrize("cname", BLOSC_CNAME) def test_blosc_codec_accepts_all_cnames(cname: BloscCnameLiteral) -> None: """ Every compressor name in BLOSC_CNAME is accepted by BloscCodec and round-trips to the same value on the stored attribute. Adding a new value to the BloscCnameLiteral type alias without also adding it to BLOSC_CNAME (or vice versa) is caught here. """ codec = BloscCodec(cname=cname) assert codec.cname == cname @pytest.mark.parametrize("shuffle", BLOSC_SHUFFLE) def test_blosc_codec_accepts_all_shuffles(shuffle: BloscShuffleLiteral) -> None: """ Every shuffle mode in BLOSC_SHUFFLE is accepted by BloscCodec and round-trips to the same value on the stored attribute. Adding a new value to the BloscShuffleLiteral type alias without also adding it to BLOSC_SHUFFLE (or vice versa) is caught here. """ codec = BloscCodec(shuffle=shuffle) assert codec.shuffle == shuffle @pytest.mark.parametrize("shuffle", BLOSC_SHUFFLE) @pytest.mark.parametrize("cname", BLOSC_CNAME) def test_blosc_codec_json_roundtrip(cname: BloscCnameLiteral, shuffle: BloscShuffleLiteral) -> None: """ JSON serialization (to_dict / from_dict) preserves every (cname, shuffle) pair drawn from BLOSC_CNAME x BLOSC_SHUFFLE. Guards against drift in the codec's V3 JSON form for any combination of compressor and shuffle option. The non-varied fields are fully specified so the codec has no tunable attributes; tunability is not part of the JSON form and would otherwise cause spurious round-trip mismatches. """ codec = BloscCodec(typesize=1, cname=cname, clevel=5, shuffle=shuffle, blocksize=0) restored = BloscCodec.from_dict(codec.to_dict()) assert restored == codec @pytest.mark.parametrize( ("enum_cls", "member", "expected"), [ (BloscShuffle, "shuffle", "shuffle"), (BloscCname, "zstd", "zstd"), ], ) def test_blosc_enum_member_access_warns(enum_cls: type, member: str, expected: str) -> None: """ Accessing a member on the deprecated BloscShuffle / BloscCname classes emits a DeprecationWarning and resolves to the equivalent literal string. """ match = f"{enum_cls.__name__}.{member}" with pytest.warns(DeprecationWarning, match=match): value = getattr(enum_cls, member) assert value == expected def test_blosc_enum_classes_import_silently() -> None: """ Importing the deprecated enum classes by name must not emit a warning; only member access does. This guards against the blosc module accidentally triggering its own deprecation warnings when it (or zarr) is imported. """ with warnings.catch_warnings(): warnings.simplefilter("error") from zarr.codecs.blosc import BloscCname as _BloscCname # noqa: F401 from zarr.codecs.blosc import BloscShuffle as _BloscShuffle # noqa: F401 def test_blosc_codec_init_with_enum_instance_warns() -> None: """ Passing a real `enum.Enum` instance to BloscCodec.__init__ (e.g. an instance materialized before the deprecation shim was introduced) must trigger the init-level deprecation warning and still normalize the value to the corresponding literal string. """ class LegacyShuffle(enum.Enum): bitshuffle = "bitshuffle" class LegacyCname(enum.Enum): zstd = "zstd" with pytest.warns(DeprecationWarning, match="enum"): codec = BloscCodec( cname=cast(BloscCname, LegacyCname.zstd), shuffle=cast(BloscShuffle, LegacyShuffle.bitshuffle), ) assert codec.cname == "zstd" assert codec.shuffle == "bitshuffle" @pytest.mark.parametrize("param", ["cname", "shuffle"]) def test_blosc_codec_rejects_unknown(param: str) -> None: """ BloscCodec.__init__ raises ValueError when given a string outside the allowed set for `cname` or `shuffle`, and the error message names the offending parameter. """ kwargs: dict[str, Any] = {param: f"not-a-{param}"} with pytest.raises(ValueError, match=f"{param} must be one of"): BloscCodec(**kwargs) @pytest.mark.parametrize("enum_cls", [BloscShuffle, BloscCname]) def test_blosc_enum_attribute_error_for_unknown_member(enum_cls: type) -> None: """ Attribute access for a name that is not a known member of the deprecated enum classes falls through to AttributeError, matching the behavior of a regular class. """ unknown_name = "not_a_member" with pytest.raises(AttributeError): getattr(enum_cls, unknown_name) zarr-python-3.3.0/tests/test_codecs/test_bytes.py000066400000000000000000000306121523267620000222170ustar00rootroot00000000000000"""Tests for `BytesCodec` and the deprecation of the `Endian` enum.""" from __future__ import annotations import enum import sys import warnings from typing import TYPE_CHECKING, Any, Literal, cast import numpy as np import pytest import zarr from tests.conftest import Expect, ExpectFail from zarr.abc.codec import SupportsSyncCodec from zarr.codecs.bytes import ( ENDIAN, BytesCodec, Endian, EndianLiteral, ) from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import NDBuffer, default_buffer_prototype from zarr.core.dtype import get_data_type_from_native_dtype from zarr.core.dtype.npy.int import Int8, Int32 from zarr.core.dtype.npy.structured import Struct from zarr.storage import StorePath from .test_codecs import _AsyncArrayProxy if TYPE_CHECKING: from zarr.abc.store import Store @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize( "input_dtype", [ ">u2", "f4"), ("mask", ">i4")], [("flux", " None: """ The `bytes` codec stores multi-byte data in the byte order configured on the codec, regardless of the input array's byte order, and reads it back to the original values. For structured dtypes this applies to every multi-byte field, per the `struct` data type spec; the struct cases guard against the endianness bugs from https://github.com/zarr-developers/zarr-python/issues/4141, where the encode path never byte-swapped struct fields (numpy reports byteorder '|' for void dtypes) and the decode path ignored the codec's endian entirely. The input-dtype/store-endian cross-product exercises the encode-side byteswap (input byte order != store byte order) and the no-op case alike. Compression is disabled so the stored chunk is the codec's raw output and its byte layout can be asserted directly. """ dtype = np.dtype(input_dtype) if dtype.fields is None: data = np.arange(0, 256, dtype=dtype).reshape((16, 16)) else: data = np.zeros((16, 16), dtype=dtype) data["flux"] = np.arange(0, 256).reshape((16, 16)) data["mask"] = np.arange(256, 512).reshape((16, 16)) path = "endian" spath = StorePath(store, path) a = await zarr.api.asynchronous.create_array( spath, shape=data.shape, chunks=(16, 16), dtype=dtype, fill_value=0, compressors=None, serializer=BytesCodec(endian=store_endian), ) await _AsyncArrayProxy(a)[:, :].set(data) # The stored chunk is laid out in the byte order configured on the codec. stored = await store.get(f"{path}/c/0/0", prototype=default_buffer_prototype()) assert stored is not None assert stored.to_bytes() == data.astype(dtype.newbyteorder(store_endian)).tobytes() # ... and the data reads back to the original values. readback_data = await _AsyncArrayProxy(a)[:, :].get() assert np.array_equal(data, readback_data) def test_bytes_codec_supports_sync() -> None: assert isinstance(BytesCodec(), SupportsSyncCodec) @pytest.mark.parametrize("endian", ENDIAN) @pytest.mark.parametrize( "native_dtype", [np.dtype("float64"), np.dtype(">u2"), np.dtype([("a", ">f4"), ("b", " None: """ The synchronous encode/decode path round-trips data, and the two byte orders involved are independent: the codec's `endian` configuration governs only the stored byte layout (every multi-byte value, including struct fields, is laid out in the codec's byte order regardless of the input array's byte order), while the decoded buffer's byte order is governed by the array's data type regardless of the codec's. The mixed-endian struct case pins that per-field byte order of the in-memory dtype survives a roundtrip through a single stored byte order. """ if native_dtype.fields is None: arr = np.arange(100, dtype=native_dtype) else: arr = np.array([(1.5, 2), (3.5, 4), (5.5, 6), (7.5, 8)], dtype=native_dtype) zdtype = get_data_type_from_native_dtype(arr.dtype) spec = ArraySpec( shape=arr.shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) nd_buf: NDBuffer = default_buffer_prototype().nd_buffer.from_numpy_array(arr) codec = BytesCodec(endian=endian).evolve_from_array_spec(spec) encoded = codec._encode_sync(nd_buf, spec) assert encoded is not None assert encoded.to_bytes() == arr.astype(native_dtype.newbyteorder(endian)).tobytes() decoded = codec._decode_sync(encoded, spec) assert decoded.dtype == zdtype.to_native_dtype() np.testing.assert_array_equal(arr, decoded.as_numpy_array()) @pytest.mark.parametrize("endian", ENDIAN) def test_bytes_codec_accepts_all_endians(endian: EndianLiteral) -> None: """ Every endian value in ENDIAN is accepted by BytesCodec and round-trips to the same value on the stored attribute. Catches drift between the EndianLiteral type alias and the runtime ENDIAN tuple. """ codec = BytesCodec(endian=endian) assert codec.endian == endian @pytest.mark.parametrize("endian", ENDIAN) def test_bytes_codec_json_roundtrip(endian: EndianLiteral) -> None: """ BytesCodec.to_dict produces the spec-defined wire shape and the round-trip through from_dict preserves equality. Asserting the literal JSON shape catches drift between BytesCodec's runtime representation and the codec's V3 on-disk form. """ codec = BytesCodec(endian=endian) assert codec.to_dict() == {"name": "bytes", "configuration": {"endian": endian}} restored = BytesCodec.from_dict(codec.to_dict()) assert restored == codec # to_dict and from_dict are inverses over this (endian setting, wire dict) mapping: # to_dict turns the endian setting into the dict; from_dict recovers it. _ENDIAN_DICT_CASES: list[Expect[EndianLiteral | None, dict[str, Any]]] = [ Expect( input="little", output={"name": "bytes", "configuration": {"endian": "little"}}, id="little", ), Expect( input="big", output={"name": "bytes", "configuration": {"endian": "big"}}, id="big", ), Expect(input=None, output={"name": "bytes"}, id="missing"), ] @pytest.mark.parametrize("case", _ENDIAN_DICT_CASES, ids=lambda c: c.id) def test_to_dict(case: Expect[EndianLiteral | None, dict[str, Any]]) -> None: assert BytesCodec(endian=case.input).to_dict() == case.output @pytest.mark.parametrize("case", _ENDIAN_DICT_CASES, ids=lambda c: c.id) def test_from_dict(case: Expect[EndianLiteral | None, dict[str, Any]]) -> None: assert BytesCodec.from_dict(case.output).endian == case.input @pytest.mark.parametrize("endian", ["little", "big", pytest.param(None, id="missing")]) def test_roundtrip(endian: EndianLiteral | None) -> None: codec = BytesCodec(endian=endian) encoded = codec.to_dict() roundtripped = BytesCodec.from_dict(encoded) assert codec == roundtripped @pytest.mark.parametrize( ("member", "expected"), [("little", "little"), ("big", "big")], ) def test_endian_member_access_warns(member: str, expected: str) -> None: """ Accessing a member on the deprecated `Endian` class emits a `DeprecationWarning` and resolves to the equivalent literal string. """ with pytest.warns(DeprecationWarning, match=rf"Endian\.{member}"): value = getattr(Endian, member) assert value == expected def test_endian_class_imports_silently() -> None: """ Importing the deprecated `Endian` class by name must not emit a warning; only member access does. Guards against `bytes.py` accidentally triggering its own deprecation warnings at import time. """ with warnings.catch_warnings(): warnings.simplefilter("error") from zarr.codecs.bytes import Endian as _Endian # noqa: F401 def test_bytes_codec_init_with_enum_instance_warns() -> None: """ Passing a foreign `enum.Enum` instance to `BytesCodec.__init__` triggers the init-level deprecation warning (from `_coerce_enum_input`) and normalizes the value to the corresponding literal string. Covers the case where a downstream package defined its own enum-shaped class to bridge between zarr's old API and its own. """ class LegacyEndian(enum.Enum): little = "little" with pytest.warns(DeprecationWarning, match=r"Passing an enum to BytesCodec"): codec = BytesCodec(endian=cast(Endian, LegacyEndian.little)) assert codec.endian == "little" def test_bytes_codec_init_with_deprecated_class_member() -> None: """ The realistic legacy-upgrade idiom: `BytesCodec(endian=Endian.little)`. Member access on `Endian` emits one `DeprecationWarning` (from the metaclass) and resolves to the bare string, which `BytesCodec` then accepts without further warning. No second warning from `_coerce_enum_input` because the metaclass already produced a string. The `cast` is necessary because the metaclass `__getattr__` is typed as returning `str`, which does not statically match the codec's `EndianLiteral` parameter even though the runtime value does. """ with pytest.warns(DeprecationWarning, match=r"Endian\.little"): codec = BytesCodec(endian=cast(EndianLiteral, Endian.little)) assert codec.endian == "little" @pytest.mark.parametrize( "case", [ ExpectFail( input="north", exception=ValueError, id="unknown-string", msg="endian must be one of", ), ], ids=lambda c: c.id, ) def test_bytes_codec_rejects_unknown_endian(case: ExpectFail[Any]) -> None: """ `BytesCodec.__init__` raises `ValueError` when given a value outside `ENDIAN`, and the error message names the offending parameter. """ with case.raises(): BytesCodec(endian=case.input) def test_endian_attribute_error_for_unknown_member() -> None: """ Attribute access for a name that is not a known member of the deprecated `Endian` class falls through to `AttributeError`, matching the behavior of a regular class. """ with pytest.raises(AttributeError): getattr(Endian, "not_a_member") # noqa: B009 def test_bytes_codec_default_endian_matches_system() -> None: """ Constructing `BytesCodec()` with no arguments yields a codec whose `endian` matches `sys.byteorder`. This replaces the previous `default_system_endian = Endian(sys.byteorder)` module-level binding. """ codec = BytesCodec() assert codec.endian == sys.byteorder def _make_array_spec(dtype: Any) -> ArraySpec: """Build a minimal ArraySpec around the given dtype for codec.evolve testing.""" return ArraySpec( shape=(1,), dtype=dtype, fill_value=0, config=cast(ArrayConfig, {}), prototype=default_buffer_prototype(), ) def test_bytes_codec_evolve_structured_multi_byte_fields_warns_and_defaults() -> None: """ BytesCodec(endian=None).evolve_from_array_spec(spec) with a structured dtype whose fields contain multi-byte members emits a UserWarning about the missing endian and returns a codec with endian set to "little" for legacy compatibility. """ codec = BytesCodec(endian=None) dtype = Struct(fields=(("a", Int32()), ("b", Int32()))) spec = _make_array_spec(dtype) with pytest.warns(UserWarning, match=r"Missing 'endian' for structured dtype"): evolved = codec.evolve_from_array_spec(spec) assert evolved.endian == "little" def test_bytes_codec_evolve_structured_single_byte_fields_clears_endian() -> None: """ For a structured dtype whose fields are all single-byte, BytesCodec drops its endian on evolve (endian is meaningless for single-byte content). """ codec = BytesCodec(endian="little") dtype = Struct(fields=(("a", Int8()), ("b", Int8()))) spec = _make_array_spec(dtype) evolved = codec.evolve_from_array_spec(spec) assert evolved.endian is None zarr-python-3.3.0/tests/test_codecs/test_cast_value.py000066400000000000000000000350121523267620000232160ustar00rootroot00000000000000from __future__ import annotations from typing import Any import numpy as np import pytest import zarr from tests.conftest import Expect, ExpectFail from zarr.codecs.cast_value import CastValue try: import cast_value_rs # noqa: F401 _HAS_CAST_VALUE_RS = True except ModuleNotFoundError: _HAS_CAST_VALUE_RS = False requires_cast_value_rs = pytest.mark.skipif( not _HAS_CAST_VALUE_RS, reason="cast-value-rs not installed" ) # --------------------------------------------------------------------------- # Serialization # --------------------------------------------------------------------------- @pytest.mark.parametrize( "case", [ Expect( input=CastValue(data_type="uint8"), output={"name": "cast_value", "configuration": {"data_type": "uint8"}}, id="minimal", ), Expect( input=CastValue( data_type="uint8", rounding="towards-zero", out_of_range="clamp", scalar_map={"encode": [("NaN", 0)]}, ), output={ "name": "cast_value", "configuration": { "data_type": "uint8", "rounding": "towards-zero", "out_of_range": "clamp", "scalar_map": {"encode": [("NaN", 0)]}, }, }, id="full", ), ], ids=lambda c: c.id, ) def test_to_dict(case: Expect[CastValue, dict[str, Any]]) -> None: """to_dict produces the expected JSON structure.""" assert case.input.to_dict() == case.output @pytest.mark.parametrize( "case", [ Expect( input={"name": "cast_value", "configuration": {"data_type": "float32"}}, output=("float32", "nearest-even", None), id="defaults", ), Expect( input={ "name": "cast_value", "configuration": { "data_type": "int16", "rounding": "towards-zero", "out_of_range": "clamp", }, }, output=("int16", "towards-zero", "clamp"), id="explicit", ), ], ids=lambda c: c.id, ) def test_from_dict(case: Expect[dict[str, Any], tuple[str, str, str | None]]) -> None: """from_dict deserializes configuration with correct values and defaults.""" codec = CastValue.from_dict(case.input) dtype_name, rounding, out_of_range = case.output assert codec.dtype.to_native_dtype() == np.dtype(dtype_name) assert codec.rounding == rounding assert codec.out_of_range == out_of_range @pytest.mark.parametrize( "codec", [ CastValue(data_type="int16", rounding="towards-zero", out_of_range="clamp"), CastValue( data_type="uint8", out_of_range="clamp", scalar_map={"encode": [("NaN", 0)], "decode": [(0, "NaN")]}, ), ], ids=["no-scalar-map", "with-scalar-map"], ) def test_serialization_roundtrip(codec: CastValue) -> None: """to_dict followed by from_dict produces an equal codec.""" restored = CastValue.from_dict(codec.to_dict()) assert codec == restored # --------------------------------------------------------------------------- # Construction # --------------------------------------------------------------------------- def test_construction_accepts_zdtype_object() -> None: """data_type can be a ZDType instance, not just a JSON string.""" from zarr.core.dtype import UInt8 codec = CastValue(data_type=UInt8()) assert codec.dtype.to_native_dtype() == np.dtype("uint8") def test_construction_rejects_invalid_target_dtype() -> None: """Construction rejects target dtypes not in PERMITTED_DATA_TYPE_NAMES.""" with pytest.raises(ValueError, match="Invalid target data type"): CastValue(data_type="complex64") # --------------------------------------------------------------------------- # Validation # --------------------------------------------------------------------------- @pytest.mark.parametrize( "case", [ ExpectFail( input={"dtype": "complex128", "target": "float64"}, msg="only supports integer and floating-point", exception=ValueError, id="complex-source", ), ExpectFail( input={"dtype": "int32", "target": "float64", "out_of_range": "wrap"}, msg="only valid for integer", exception=ValueError, id="wrap-float-target", ), ], ids=lambda c: c.id, ) def test_validation_rejects_invalid(case: ExpectFail[dict[str, Any]]) -> None: """Invalid dtype or out_of_range combinations are rejected at array creation.""" with case.raises(): zarr.create_array( store={}, shape=(10,), dtype=case.input["dtype"], chunks=(10,), filters=[ CastValue( data_type=case.input["target"], out_of_range=case.input.get("out_of_range"), ) ], compressors=None, fill_value=0, ) @requires_cast_value_rs @pytest.mark.parametrize( ("source_dtype", "target_dtype"), [ ("float16", "int8"), ("float32", "int32"), ("float64", "int64"), ("int32", "uint8"), ], ) def test_validation_accepts_wrap_with_integer_target(source_dtype: str, target_dtype: str) -> None: """Regression for #3936: `out_of_range="wrap"` is permitted when the cast TARGET (not the source array dtype) is an integer type.""" zarr.create_array( store={}, shape=(1,), dtype=source_dtype, chunks=(1,), filters=[CastValue(data_type=target_dtype, out_of_range="wrap")], compressors=None, fill_value=0, ) def test_zero_itemsize_raises() -> None: """Variable-length dtypes (itemsize=0) are rejected by compute_encoded_size.""" from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype.npy.string import VariableLengthUTF8 codec = CastValue(data_type="uint8") spec = ArraySpec( shape=(10,), dtype=VariableLengthUTF8(), # type: ignore[arg-type] fill_value="", config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) with pytest.raises(ValueError, match="fixed-size integer and floating-point data types"): codec.compute_encoded_size(100, spec) # --------------------------------------------------------------------------- # Encode / decode # --------------------------------------------------------------------------- @requires_cast_value_rs @pytest.mark.parametrize( "case", [ Expect(input=("float64", "float32"), output=np.arange(50, dtype="float64"), id="f64→f32"), Expect(input=("float32", "float64"), output=np.arange(50, dtype="float32"), id="f32→f64"), Expect(input=("int32", "int64"), output=np.arange(50, dtype="int32"), id="i32→i64"), Expect(input=("int64", "int16"), output=np.arange(50, dtype="int64"), id="i64→i16"), Expect(input=("float64", "int32"), output=np.arange(50, dtype="float64"), id="f64→i32"), Expect(input=("int32", "float64"), output=np.arange(50, dtype="int32"), id="i32→f64"), ], ids=lambda c: c.id, ) def test_encode_decode_roundtrip( case: Expect[tuple[str, str], np.ndarray[Any, np.dtype[Any]]], ) -> None: """Small integer data survives encode → decode for each dtype pair.""" import zarr source_dtype, target_dtype = case.input arr = zarr.create_array( store={}, shape=(50,), dtype=source_dtype, chunks=(50,), filters=[CastValue(data_type=target_dtype)], compressors=None, fill_value=0, ) arr[:] = case.output np.testing.assert_array_equal(arr[:], case.output) @requires_cast_value_rs @pytest.mark.parametrize( "case", [ Expect( input=np.array([1.7, -1.7, 2.5, -2.5], dtype="float64"), output=np.array([1, -1, 2, -2], dtype="float64"), id="towards-zero", ), ], ids=lambda c: c.id, ) def test_float_to_int_rounding( case: Expect[np.ndarray[Any, np.dtype[Any]], np.ndarray[Any, np.dtype[Any]]], ) -> None: """Fractional float values are truncated towards zero when cast to int32.""" import zarr arr = zarr.create_array( store={}, shape=case.input.shape, dtype=case.input.dtype, chunks=case.input.shape, filters=[CastValue(data_type="int32", rounding="towards-zero", out_of_range="clamp")], compressors=None, fill_value=0, ) arr[:] = case.input np.testing.assert_array_equal(arr[:], case.output) @requires_cast_value_rs @pytest.mark.parametrize( "case", [ Expect( input=np.array([0, 200, -200], dtype="int32"), output=np.array([0, 127, -128], dtype="int32"), id="int32→int8", ), ], ids=lambda c: c.id, ) def test_out_of_range_clamp( case: Expect[np.ndarray[Any, np.dtype[Any]], np.ndarray[Any, np.dtype[Any]]], ) -> None: """Values outside the int8 range are clamped to [-128, 127].""" import zarr arr = zarr.create_array( store={}, shape=case.input.shape, dtype=case.input.dtype, chunks=case.input.shape, filters=[CastValue(data_type="int8", out_of_range="clamp")], compressors=None, fill_value=0, ) arr[:] = case.input np.testing.assert_array_equal(arr[:], case.output) def test_compute_encoded_size() -> None: """compute_encoded_size correctly scales byte length by itemsize ratio.""" from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import get_data_type_from_json codec = CastValue(data_type="int16") spec = ArraySpec( shape=(10,), dtype=get_data_type_from_json("float64", zarr_format=3), fill_value=0, config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) # 10 float64 elements = 80 bytes -> 10 int16 elements = 20 bytes assert codec.compute_encoded_size(80, spec) == 20 @requires_cast_value_rs def test_scalar_map_encode_decode_roundtrip() -> None: """Scalar map entries are applied during encode and decode.""" import zarr data = np.array([1.0, float("nan"), 3.0], dtype="float64") arr = zarr.create_array( store={}, shape=data.shape, dtype="float64", chunks=data.shape, filters=[ CastValue( data_type="int32", rounding="nearest-even", out_of_range="clamp", scalar_map={"encode": [("NaN", -999)], "decode": [(-999, "NaN")]}, ), ], compressors=None, fill_value=1, ) arr[:] = data result = np.asarray(arr[:]) np.testing.assert_equal(result[0], 1.0) np.testing.assert_equal(result[2], 3.0) assert np.isnan(result[1]) @pytest.mark.parametrize( "case", [ ExpectFail( input={ "dtype": "int32", "target": "int8", "scalar_map": {"encode": [("NaN", 0)]}, }, msg="not representable in dtype int32", exception=ValueError, id="nan-key-for-int-source", ), ExpectFail( input={ "dtype": "int32", "target": "float64", "scalar_map": {"decode": [(0, "NaN")]}, }, msg="not representable in dtype int32", exception=ValueError, id="nan-value-for-int-decode-target", ), ExpectFail( input={ "dtype": "float64", "target": "int8", "scalar_map": {"encode": [("NaN", 999)]}, }, msg="not representable in dtype int8", exception=ValueError, id="encode-value-out-of-range", ), ExpectFail( input={ "dtype": "float64", "target": "int8", "scalar_map": {"encode": [("NaN", 1.5)]}, }, msg="not representable in dtype int8", exception=ValueError, id="encode-value-not-integer", ), ], ids=lambda c: c.id, ) def test_scalar_map_validation_rejects_invalid(case: ExpectFail[dict[str, Any]]) -> None: """Invalid scalar_map entries are rejected at array creation.""" import zarr with case.raises(): zarr.create_array( store={}, shape=(10,), dtype=case.input["dtype"], chunks=(10,), filters=[ CastValue( data_type=case.input["target"], out_of_range="clamp", scalar_map=case.input["scalar_map"], ) ], compressors=None, fill_value=0, ) @requires_cast_value_rs def test_combined_with_scale_offset() -> None: """scale_offset followed by cast_value compresses float64 into int16 and round-trips.""" import zarr from zarr.codecs.scale_offset import ScaleOffset arr = zarr.create_array( store={}, shape=(100,), dtype="float64", chunks=(100,), filters=[ ScaleOffset(offset=0, scale=10), CastValue(data_type="int16", rounding="nearest-even", out_of_range="clamp"), ], compressors=None, fill_value=0, ) data = np.arange(100, dtype="float64") * 0.1 arr[:] = data result = arr[:] np.testing.assert_array_almost_equal(result, data, decimal=1) # type: ignore[arg-type] @pytest.mark.parametrize( "case", [ Expect( input={"encode": [("NaN", 0)]}, output={"encode": {"NaN": 0}}, id="encode-only", ), Expect( input={"encode": [("NaN", 0)], "decode": [(0, "NaN")]}, output={"encode": {"NaN": 0}, "decode": {0: "NaN"}}, id="both-directions", ), Expect( input={"encode": {"NaN": 0}}, output={"encode": {"NaN": 0}}, id="already-normalized", ), ], ids=lambda c: c.id, ) def test_parse_scalar_map(case: Expect[Any, Any]) -> None: from zarr.codecs.cast_value import parse_scalar_map assert parse_scalar_map(case.input) == case.output zarr-python-3.3.0/tests/test_codecs/test_codecs.py000066400000000000000000000372001523267620000223310ustar00rootroot00000000000000from __future__ import annotations import json import warnings from dataclasses import dataclass from typing import TYPE_CHECKING, Any import numpy as np import pytest import zarr import zarr.api import zarr.api.asynchronous from zarr import Array, AsyncArray, config from zarr.codecs import ( BytesCodec, GzipCodec, ShardingCodec, TransposeCodec, ) from zarr.core.buffer import default_buffer_prototype from zarr.core.indexing import BasicSelection, decode_morton, morton_order_coords from zarr.core.metadata.v3 import ArrayV3Metadata from zarr.dtype import UInt8 from zarr.errors import ZarrUserWarning from zarr.storage import MemoryStore, StorePath if TYPE_CHECKING: from zarr.abc.codec import Codec from zarr.abc.store import Store from zarr.core.buffer.core import NDArrayLikeOrScalar from zarr.core.common import MemoryOrder from zarr.types import AnyAsyncArray @dataclass(frozen=True) class _AsyncArrayProxy: array: AnyAsyncArray def __getitem__(self, selection: BasicSelection) -> _AsyncArraySelectionProxy: return _AsyncArraySelectionProxy(self.array, selection) @dataclass(frozen=True) class _AsyncArraySelectionProxy: array: AnyAsyncArray selection: BasicSelection async def get(self) -> NDArrayLikeOrScalar: return await self.array.getitem(self.selection) async def set(self, value: np.ndarray[Any, Any]) -> None: return await self.array.setitem(self.selection, value) def order_from_dim(order: MemoryOrder, ndim: int) -> tuple[int, ...]: if order == "F": return tuple(ndim - x - 1 for x in range(ndim)) else: return tuple(range(ndim)) def test_sharding_pickle() -> None: """ Test that sharding codecs can be pickled """ @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("input_order", ["F", "C"]) @pytest.mark.parametrize("store_order", ["F", "C"]) @pytest.mark.parametrize("runtime_write_order", ["F", "C"]) @pytest.mark.parametrize("runtime_read_order", ["F", "C"]) @pytest.mark.parametrize("with_sharding", [True, False]) async def test_order( store: Store, input_order: MemoryOrder, store_order: MemoryOrder, runtime_write_order: MemoryOrder, runtime_read_order: MemoryOrder, with_sharding: bool, ) -> None: data = np.arange(0, 256, dtype="uint16").reshape((32, 8), order=input_order) path = "order" spath = StorePath(store, path=path) a = await zarr.api.asynchronous.create_array( spath, shape=data.shape, chunks=(16, 8) if with_sharding else (32, 8), shards=(32, 8) if with_sharding else None, dtype=data.dtype, fill_value=0, chunk_key_encoding={"name": "v2", "separator": "."}, filters=[TransposeCodec(order=order_from_dim(store_order, data.ndim))], config={"order": runtime_write_order}, ) await _AsyncArrayProxy(a)[:, :].set(data) read_data = await _AsyncArrayProxy(a)[:, :].get() assert np.array_equal(data, read_data) with config.set({"array.order": runtime_read_order}): a = await AsyncArray.open( spath, ) read_data = await _AsyncArrayProxy(a)[:, :].get() assert np.array_equal(data, read_data) assert isinstance(read_data, np.ndarray) if runtime_read_order == "F": assert read_data.flags["F_CONTIGUOUS"] assert not read_data.flags["C_CONTIGUOUS"] else: assert not read_data.flags["F_CONTIGUOUS"] assert read_data.flags["C_CONTIGUOUS"] @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("input_order", ["F", "C"]) @pytest.mark.parametrize("runtime_write_order", ["F", "C"]) @pytest.mark.parametrize("runtime_read_order", ["F", "C"]) @pytest.mark.parametrize("with_sharding", [True, False]) def test_order_implicit( store: Store, input_order: MemoryOrder, runtime_write_order: MemoryOrder, runtime_read_order: MemoryOrder, with_sharding: bool, ) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16), order=input_order) path = "order_implicit" spath = StorePath(store, path) with config.set({"array.order": runtime_write_order}): a = zarr.create_array( spath, shape=data.shape, chunks=(8, 8) if with_sharding else (16, 16), shards=(16, 16) if with_sharding else None, dtype=data.dtype, fill_value=0, ) a[:, :] = data with config.set({"array.order": runtime_read_order}): a = Array.open(spath) read_data = a[:, :] assert np.array_equal(data, read_data) assert isinstance(read_data, np.ndarray) if runtime_read_order == "F": assert read_data.flags["F_CONTIGUOUS"] assert not read_data.flags["C_CONTIGUOUS"] else: assert not read_data.flags["F_CONTIGUOUS"] assert read_data.flags["C_CONTIGUOUS"] @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_open(store: Store) -> None: spath = StorePath(store) a = zarr.create_array( spath, shape=(16, 16), chunks=(16, 16), dtype="int32", fill_value=0, ) b = Array.open(spath) assert a.metadata == b.metadata def test_morton_exact_order() -> None: """Test exact morton ordering for power-of-2 shapes.""" assert list(morton_order_coords((2, 2))) == [(0, 0), (1, 0), (0, 1), (1, 1)] assert list(morton_order_coords((2, 2, 2))) == [ (0, 0, 0), (1, 0, 0), (0, 1, 0), (1, 1, 0), (0, 0, 1), (1, 0, 1), (0, 1, 1), (1, 1, 1), ] assert list(morton_order_coords((2, 2, 2, 2))) == [ (0, 0, 0, 0), (1, 0, 0, 0), (0, 1, 0, 0), (1, 1, 0, 0), (0, 0, 1, 0), (1, 0, 1, 0), (0, 1, 1, 0), (1, 1, 1, 0), (0, 0, 0, 1), (1, 0, 0, 1), (0, 1, 0, 1), (1, 1, 0, 1), (0, 0, 1, 1), (1, 0, 1, 1), (0, 1, 1, 1), (1, 1, 1, 1), ] @pytest.mark.parametrize( "shape", [ (2, 2, 2), (5, 2), (2, 5), (2, 9, 2), (3, 2, 12), (2, 5, 1), (4, 3, 6, 2, 7), (3, 2, 1, 6, 4, 5, 2), (1,), (1, 1), (5, 1, 3), (1, 4, 1, 2), (5, 5, 5), # triggers argsort strategy (n_z/n_total > 4) ], ) def test_morton_is_permutation(shape: tuple[int, ...]) -> None: """Test that morton_order_coords produces every valid coordinate exactly once.""" import itertools from zarr.core.common import product order = list(morton_order_coords(shape)) expected_len = product(shape) # completeness: every valid coordinate is present assert len(order) == expected_len # no duplicates assert len(set(order)) == expected_len # all coordinates are within bounds assert all(all(c < s for c, s in zip(coord, shape, strict=True)) for coord in order) # the set of coordinates equals the full cartesian product assert set(order) == set(itertools.product(*(range(s) for s in shape))) @pytest.mark.parametrize( "shape", [ (2, 2), (4, 4), (2, 2, 2), (4, 4, 4), (2, 2, 2, 2), ], ) def test_morton_ordering(shape: tuple[int, ...]) -> None: """Test that the iteration order matches consecutive decode_morton outputs. For power-of-2 shapes, every decode_morton output is in-bounds, so the ordering should be exactly decode_morton(0), decode_morton(1), ... """ order = list(morton_order_coords(shape)) for i, coord in enumerate(order): assert coord == decode_morton(i, shape) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_write_partial_chunks(store: Store) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16)) spath = StorePath(store) a = zarr.create_array( spath, shape=data.shape, chunks=(20, 20), dtype=data.dtype, fill_value=1, ) a[0:16, 0:16] = data assert np.array_equal(a[0:16, 0:16], data) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) async def test_delete_empty_chunks(store: Store) -> None: data = np.ones((16, 16)) path = "delete_empty_chunks" spath = StorePath(store, path) a = await zarr.api.asynchronous.create_array( spath, shape=data.shape, chunks=(32, 32), dtype=data.dtype, fill_value=1, ) await _AsyncArrayProxy(a)[:16, :16].set(np.zeros((16, 16))) await _AsyncArrayProxy(a)[:16, :16].set(data) assert np.array_equal(await _AsyncArrayProxy(a)[:16, :16].get(), data) assert await store.get(f"{path}/c0/0", prototype=default_buffer_prototype()) is None @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) async def test_dimension_names(store: Store) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16)) path = "dimension_names" spath = StorePath(store, path) await zarr.api.asynchronous.create_array( spath, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, dimension_names=("x", "y"), ) assert isinstance( meta := (await zarr.api.asynchronous.open_array(store=spath)).metadata, ArrayV3Metadata ) assert meta.dimension_names == ( "x", "y", ) path2 = "dimension_names2" spath2 = StorePath(store, path2) await zarr.api.asynchronous.create_array( spath2, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, ) assert isinstance(meta := (await AsyncArray.open(spath2)).metadata, ArrayV3Metadata) assert meta.dimension_names is None zarr_json_buffer = await store.get(f"{path2}/zarr.json", prototype=default_buffer_prototype()) assert zarr_json_buffer is not None assert "dimension_names" not in json.loads(zarr_json_buffer.to_bytes()) @pytest.mark.parametrize( "codecs", [ (BytesCodec(), TransposeCodec(order=order_from_dim("F", 2))), (TransposeCodec(order=order_from_dim("F", 2)),), ], ) def test_invalid_metadata(codecs: tuple[Codec, ...]) -> None: shape = (16,) chunks = (16,) data_type = UInt8() with pytest.raises(ValueError, match="The `order` tuple must have as many entries"): ArrayV3Metadata( shape=shape, chunk_grid={"name": "regular", "configuration": {"chunk_shape": chunks}}, chunk_key_encoding={"name": "default", "configuration": {"separator": "/"}}, fill_value=0, data_type=data_type, codecs=codecs, attributes={}, dimension_names=None, ) def test_invalid_metadata_create_array() -> None: with pytest.warns( ZarrUserWarning, match="codec disables partial reads and writes, which may lead to inefficient performance", ): zarr.create_array( {}, shape=(16, 16), chunks=(16, 16), dtype=np.dtype("uint8"), fill_value=0, serializer=ShardingCodec(chunk_shape=(8, 8)), compressors=[ GzipCodec(), ], ) @pytest.mark.parametrize( "pipeline_path", [ "zarr.core.codec_pipeline.BatchedCodecPipeline", "zarr.core.codec_pipeline.FusedCodecPipeline", ], ) def test_sharding_warning_fires_once_per_open(pipeline_path: str) -> None: """Construction-time codec warnings (e.g. sharding's partial-reads warning) must fire exactly once per array open, not once per internal codec-chain reconstruction. `create_codec_pipeline` builds a throwaway pipeline via `from_codecs` (which warns) and then calls `evolve_from_array_spec` on it, which re-splits the (already-warned-about) codec chain against the evolved spec. That re-split goes through `codecs_from_list_unchecked` rather than `codecs_from_list`, so it does not re-emit the warning. `FusedCodecPipeline` additionally builds a `ChunkTransform` (and, on the async fallback path, an `AsyncChunkTransform` per call) from the same evolved codec chain, which must use the same quiet variant. """ with config.set({"codec_pipeline.path": pipeline_path}): store = MemoryStore() with warnings.catch_warnings(): warnings.simplefilter("ignore") zarr.create_array( store, shape=(16, 16), chunks=(16, 16), dtype=np.dtype("uint8"), fill_value=0, serializer=ShardingCodec(chunk_shape=(8, 8)), compressors=[GzipCodec()], ) with warnings.catch_warnings(record=True) as caught: warnings.simplefilter("always") zarr.open_array(store, mode="r") matches = [w for w in caught if "disables partial reads" in str(w.message)] assert len(matches) == 1 @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) async def test_resize(store: Store) -> None: data = np.zeros((16, 18), dtype="uint16") path = "resize" spath = StorePath(store, path) a = await zarr.api.asynchronous.create_array( spath, shape=data.shape, chunks=(10, 10), dtype=data.dtype, chunk_key_encoding={"name": "v2", "separator": "."}, fill_value=1, ) await _AsyncArrayProxy(a)[:16, :18].set(data) assert await store.get(f"{path}/1.1", prototype=default_buffer_prototype()) is not None assert await store.get(f"{path}/0.0", prototype=default_buffer_prototype()) is not None assert await store.get(f"{path}/0.1", prototype=default_buffer_prototype()) is not None assert await store.get(f"{path}/1.0", prototype=default_buffer_prototype()) is not None await a.resize((10, 12)) assert a.metadata.shape == (10, 12) assert a.shape == (10, 12) assert await store.get(f"{path}/0.0", prototype=default_buffer_prototype()) is not None assert await store.get(f"{path}/0.1", prototype=default_buffer_prototype()) is not None assert await store.get(f"{path}/1.0", prototype=default_buffer_prototype()) is None assert await store.get(f"{path}/1.1", prototype=default_buffer_prototype()) is None def _resolve_metadata_codecs() -> list[Codec]: from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.zstd import ZstdCodec return [ BytesCodec(), GzipCodec(level=1), TransposeCodec(order=(0,)), Crc32cCodec(), ZstdCodec(level=1), ] @pytest.mark.parametrize("codec", _resolve_metadata_codecs(), ids=lambda c: type(c).__name__) def test_resolve_metadata_only_mutates_shape(codec: Codec) -> None: """A codec's resolve_metadata may change a chunk's `shape` but must leave the prototype, dtype, fill_value, and config untouched -- the pipeline relies on those being stable across the codec chain. """ from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.dtype import get_data_type_from_native_dtype zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec_in = ArraySpec( shape=(10,), dtype=zdtype, fill_value=zdtype.cast_scalar(0.0), config=ArrayConfig(order="C", write_empty_chunks=False), prototype=default_buffer_prototype(), ) spec_out = codec.resolve_metadata(spec_in) name = type(codec).__name__ assert spec_out.prototype is spec_in.prototype, f"{name} changed prototype" assert spec_out.dtype == spec_in.dtype, f"{name} changed dtype" assert spec_out.fill_value == spec_in.fill_value, f"{name} changed fill_value" assert spec_out.config == spec_in.config, f"{name} changed config" zarr-python-3.3.0/tests/test_codecs/test_crc32c.py000066400000000000000000000021611523267620000221460ustar00rootroot00000000000000from __future__ import annotations import numpy as np from zarr.abc.codec import SupportsSyncCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import get_data_type_from_native_dtype def test_crc32c_codec_supports_sync() -> None: assert isinstance(Crc32cCodec(), SupportsSyncCodec) def test_crc32c_codec_sync_roundtrip() -> None: codec = Crc32cCodec() arr = np.arange(100, dtype="float64") zdtype = get_data_type_from_native_dtype(arr.dtype) spec = ArraySpec( shape=arr.shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) buf = default_buffer_prototype().buffer.from_array_like(arr.view("B")) encoded = codec._encode_sync(buf, spec) assert encoded is not None decoded = codec._decode_sync(encoded, spec) result = np.frombuffer(decoded.as_numpy_array(), dtype="float64") np.testing.assert_array_equal(arr, result) zarr-python-3.3.0/tests/test_codecs/test_gzip.py000066400000000000000000000031161523267620000220410ustar00rootroot00000000000000import numpy as np import pytest import zarr from zarr.abc.codec import SupportsSyncCodec from zarr.abc.store import Store from zarr.codecs import GzipCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import get_data_type_from_native_dtype from zarr.storage import StorePath @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_gzip(store: Store) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16)) a = zarr.create_array( StorePath(store), shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, compressors=GzipCodec(), ) a[:, :] = data assert np.array_equal(data, a[:, :]) def test_gzip_codec_supports_sync() -> None: assert isinstance(GzipCodec(), SupportsSyncCodec) def test_gzip_codec_sync_roundtrip() -> None: codec = GzipCodec(level=1) arr = np.arange(100, dtype="float64") zdtype = get_data_type_from_native_dtype(arr.dtype) spec = ArraySpec( shape=arr.shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) buf = default_buffer_prototype().buffer.from_array_like(arr.view("B")) encoded = codec._encode_sync(buf, spec) assert encoded is not None decoded = codec._decode_sync(encoded, spec) result = np.frombuffer(decoded.as_numpy_array(), dtype="float64") np.testing.assert_array_equal(arr, result) zarr-python-3.3.0/tests/test_codecs/test_numcodecs.py000066400000000000000000000260571523267620000230610ustar00rootroot00000000000000from __future__ import annotations import contextlib import pickle from typing import TYPE_CHECKING, Any import numpy as np import pytest from numcodecs import GZip try: from numcodecs.errors import UnknownCodecError except ImportError: # Older versions of numcodecs don't have a separate errors module UnknownCodecError = ValueError from zarr import config, create_array, open_array from zarr.abc.numcodec import _is_numcodec, _is_numcodec_cls from zarr.codecs import numcodecs as _numcodecs from zarr.registry import get_codec_class, get_numcodec if TYPE_CHECKING: from collections.abc import Iterator @contextlib.contextmanager def codec_conf() -> Iterator[Any]: base_conf = config.get("codecs") new_conf = { "numcodecs.bz2": "zarr.codecs.numcodecs.BZ2", "numcodecs.crc32": "zarr.codecs.numcodecs.CRC32", "numcodecs.crc32c": "zarr.codecs.numcodecs.CRC32C", "numcodecs.lz4": "zarr.codecs.numcodecs.LZ4", "numcodecs.lzma": "zarr.codecs.numcodecs.LZMA", "numcodecs.zfpy": "zarr.codecs.numcodecs.ZFPY", "numcodecs.adler32": "zarr.codecs.numcodecs.Adler32", "numcodecs.astype": "zarr.codecs.numcodecs.AsType", "numcodecs.bitround": "zarr.codecs.numcodecs.BitRound", "numcodecs.blosc": "zarr.codecs.numcodecs.Blosc", "numcodecs.delta": "zarr.codecs.numcodecs.Delta", "numcodecs.fixedscaleoffset": "zarr.codecs.numcodecs.FixedScaleOffset", "numcodecs.fletcher32": "zarr.codecs.numcodecs.Fletcher32", "numcodecs.gzip": "zarr.codecs.numcodecs.GZip", "numcodecs.jenkinslookup3": "zarr.codecs.numcodecs.JenkinsLookup3", "numcodecs.pcodec": "zarr.codecs.numcodecs.PCodec", "numcodecs.packbits": "zarr.codecs.numcodecs.PackBits", "numcodecs.shuffle": "zarr.codecs.numcodecs.Shuffle", "numcodecs.quantize": "zarr.codecs.numcodecs.Quantize", "numcodecs.zlib": "zarr.codecs.numcodecs.Zlib", "numcodecs.zstd": "zarr.codecs.numcodecs.Zstd", } yield config.set({"codecs": new_conf | base_conf}) if TYPE_CHECKING: from zarr.core.common import JSON def test_get_numcodec() -> None: assert get_numcodec({"id": "gzip", "level": 2}) == GZip(level=2) # type: ignore[typeddict-unknown-key] def test_is_numcodec() -> None: """ Test the _is_numcodec function """ assert _is_numcodec(GZip()) def test_is_numcodec_cls() -> None: """ Test the _is_numcodec_cls function """ assert _is_numcodec_cls(GZip) ALL_CODECS = tuple( filter( lambda v: issubclass(v, _numcodecs._NumcodecsCodec) and hasattr(v, "codec_name"), tuple(getattr(_numcodecs, cls_name) for cls_name in _numcodecs.__all__), ) ) @pytest.mark.parametrize("codec_cls", ALL_CODECS) def test_get_codec_class(codec_cls: type[_numcodecs._NumcodecsCodec]) -> None: assert get_codec_class(codec_cls.codec_name) == codec_cls # type: ignore[comparison-overlap,misc] @pytest.mark.parametrize("codec_class", ALL_CODECS) def test_docstring(codec_class: type[_numcodecs._NumcodecsCodec]) -> None: """ Test that the docstring for the zarr.numcodecs codecs references the wrapped numcodecs class. """ assert "See [numcodecs." in codec_class.__doc__ # type: ignore[operator] @pytest.mark.parametrize( "codec_class", [ _numcodecs.Blosc, _numcodecs.LZ4, _numcodecs.Zstd, _numcodecs.Zlib, _numcodecs.GZip, _numcodecs.BZ2, _numcodecs.LZMA, _numcodecs.Shuffle, ], ) def test_generic_compressor(codec_class: type[_numcodecs._NumcodecsBytesBytesCodec]) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, compressors=[codec_class()], ) a[:, :] = data.copy() np.testing.assert_array_equal(data, a[:, :]) @pytest.mark.parametrize( ("codec_class", "codec_config"), [ (_numcodecs.Delta, {"dtype": "float32"}), (_numcodecs.FixedScaleOffset, {"offset": 0, "scale": 25.5}), (_numcodecs.FixedScaleOffset, {"offset": 0, "scale": 51, "astype": "uint16"}), (_numcodecs.AsType, {"encode_dtype": "float32", "decode_dtype": "float32"}), ], ids=[ "delta", "fixedscaleoffset", "fixedscaleoffset2", "astype", ], ) def test_generic_filter( codec_class: type[_numcodecs._NumcodecsArrayArrayCodec], codec_config: dict[str, JSON], ) -> None: data = np.linspace(0, 10, 256, dtype="float32").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, filters=[ codec_class(**codec_config), ], ) a[:, :] = data.copy() with codec_conf(): b = open_array(a.store, mode="r") np.testing.assert_array_equal(data, b[:, :]) @pytest.mark.parametrize( ("codec_class", "codec_config", "dtype"), [ (_numcodecs.Delta, {"dtype": "int64"}, "int64"), (_numcodecs.FixedScaleOffset, {"offset": 0, "scale": 1}, "int64"), (_numcodecs.PackBits, {}, "bool"), ], ids=["delta", "fixedscaleoffset", "packbits"], ) def test_generic_filter_f_contiguous( codec_class: type[_numcodecs._NumcodecsArrayArrayCodec], codec_config: dict[str, JSON], dtype: str, ) -> None: # gh-3558: F-contiguous chunks were handed to numcodecs filters as is, and # numcodecs flattens in memory order, so the elements came back transposed if dtype == "bool": data = np.asfortranarray(np.tril(np.ones((16, 16), dtype=bool))) else: data = np.asfortranarray(np.arange(256, dtype=dtype).reshape(16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, filters=[codec_class(**codec_config)], ) a[:, :] = data np.testing.assert_array_equal(data, a[:, :]) def test_generic_filter_bitround() -> None: data = np.linspace(0, 1, 256, dtype="float32").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, filters=[_numcodecs.BitRound(keepbits=3)], ) a[:, :] = data.copy() b = open_array(a.store, mode="r") assert np.allclose(data, b[:, :], atol=0.1) def test_generic_filter_quantize() -> None: data = np.linspace(0, 10, 256, dtype="float32").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, filters=[_numcodecs.Quantize(digits=3)], ) a[:, :] = data.copy() b = open_array(a.store, mode="r") assert np.allclose(data, b[:, :], atol=0.001) def test_generic_filter_packbits() -> None: data = np.zeros((16, 16), dtype="bool") data[0:4, :] = True a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, filters=[_numcodecs.PackBits()], ) a[:, :] = data.copy() b = open_array(a.store, mode="r") np.testing.assert_array_equal(data, b[:, :]) with pytest.raises(ValueError, match=".*requires bool dtype.*"): create_array( {}, shape=data.shape, chunks=(16, 16), dtype="uint32", fill_value=0, filters=[_numcodecs.PackBits()], ) @pytest.mark.parametrize( "codec_class", [ _numcodecs.CRC32, _numcodecs.CRC32C, _numcodecs.Adler32, _numcodecs.Fletcher32, _numcodecs.JenkinsLookup3, ], ) def test_generic_checksum(codec_class: type[_numcodecs._NumcodecsBytesBytesCodec]) -> None: # Check if the codec is available in numcodecs try: codec_class()._codec # noqa: B018 except UnknownCodecError as e: # pragma: no cover pytest.skip(f"{codec_class.codec_name} is not available in numcodecs: {e}") # type: ignore[misc] data = np.linspace(0, 10, 256, dtype="float32").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, compressors=[codec_class()], ) a[:, :] = data.copy() with codec_conf(): b = open_array(a.store, mode="r") np.testing.assert_array_equal(data, b[:, :]) @pytest.mark.parametrize("codec_class", [_numcodecs.PCodec, _numcodecs.ZFPY]) def test_generic_bytes_codec(codec_class: type[_numcodecs._NumcodecsArrayBytesCodec]) -> None: try: codec_class()._codec # noqa: B018 except ValueError as e: # pragma: no cover if "codec not available" in str(e): pytest.xfail(f"{codec_class.codec_name} is not available: {e}") # type: ignore[misc] else: raise except ImportError as e: # pragma: no cover pytest.xfail(f"{codec_class.codec_name} is not available: {e}") # type: ignore[misc] data = np.arange(0, 256, dtype="float32").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, serializer=codec_class(), ) a[:, :] = data.copy() np.testing.assert_array_equal(data, a[:, :]) def test_delta_astype() -> None: data = np.linspace(0, 10, 256, dtype="i8").reshape((16, 16)) a = create_array( {}, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, filters=[ _numcodecs.Delta(dtype="i8", astype="i2"), ], ) a[:, :] = data.copy() with codec_conf(): b = open_array(a.store, mode="r") np.testing.assert_array_equal(data, b[:, :]) def test_repr() -> None: codec = _numcodecs.LZ4(level=5) assert repr(codec) == "LZ4(codec_name='numcodecs.lz4', codec_config={'level': 5})" def test_to_dict() -> None: codec = _numcodecs.LZ4(level=5) assert codec.to_dict() == {"name": "numcodecs.lz4", "configuration": {"level": 5}} @pytest.mark.parametrize( "codec_cls", [ _numcodecs.Blosc, _numcodecs.LZ4, _numcodecs.Zstd, _numcodecs.Zlib, _numcodecs.GZip, _numcodecs.BZ2, _numcodecs.LZMA, _numcodecs.Shuffle, _numcodecs.BitRound, _numcodecs.Delta, _numcodecs.FixedScaleOffset, _numcodecs.Quantize, _numcodecs.PackBits, _numcodecs.AsType, _numcodecs.CRC32, _numcodecs.CRC32C, _numcodecs.Adler32, _numcodecs.Fletcher32, _numcodecs.JenkinsLookup3, _numcodecs.PCodec, _numcodecs.ZFPY, ], ) def test_codecs_pickleable(codec_cls: type[_numcodecs._NumcodecsCodec]) -> None: # Check if the codec is available in numcodecs try: codec = codec_cls() except UnknownCodecError as e: # pragma: no cover pytest.skip(f"{codec_cls.codec_name} is not available in numcodecs: {e}") # type: ignore[misc] expected = codec p = pickle.dumps(codec) actual = pickle.loads(p) assert actual == expected zarr-python-3.3.0/tests/test_codecs/test_scale_offset.py000066400000000000000000000372241523267620000235340ustar00rootroot00000000000000from __future__ import annotations from typing import Any import numpy as np import pytest import zarr from tests.conftest import Expect, ExpectFail from zarr.codecs.scale_offset import ( ScaleOffset, _decode, _decode_fits_natively, _encode, ) from zarr.core.buffer.core import default_buffer_prototype from zarr.storage._memory import MemoryStore # --------------------------------------------------------------------------- # Serialization # --------------------------------------------------------------------------- @pytest.mark.parametrize( "case", [ Expect(input=ScaleOffset(), output={"name": "scale_offset"}, id="default"), Expect( input=ScaleOffset(offset=5), output={"name": "scale_offset", "configuration": {"offset": 5}}, id="offset-only", ), Expect( input=ScaleOffset(scale=0.1), output={"name": "scale_offset", "configuration": {"scale": 0.1}}, id="scale-only", ), Expect( input=ScaleOffset(offset=5, scale=0.1), output={"name": "scale_offset", "configuration": {"offset": 5, "scale": 0.1}}, id="both", ), ], ids=lambda c: c.id, ) def test_to_dict(case: Expect[ScaleOffset, dict[str, Any]]) -> None: """to_dict produces the expected JSON structure.""" assert case.input.to_dict() == case.output @pytest.mark.parametrize( "case", [ Expect(input={"name": "scale_offset"}, output=(0, 1), id="no-config"), Expect( input={"name": "scale_offset", "configuration": {"offset": 3, "scale": 2}}, output=(3, 2), id="with-config", ), ], ids=lambda c: c.id, ) def test_from_dict(case: Expect[dict[str, Any], tuple[int | float, int | float]]) -> None: """from_dict deserializes configuration with correct values and defaults.""" codec = ScaleOffset.from_dict(case.input) expected_offset, expected_scale = case.output assert codec.offset == expected_offset assert codec.scale == expected_scale def test_serialization_roundtrip() -> None: """to_dict followed by from_dict produces an equal codec.""" original = ScaleOffset(offset=7, scale=0.5) restored = ScaleOffset.from_dict(original.to_dict()) assert original == restored # --------------------------------------------------------------------------- # Construction # --------------------------------------------------------------------------- @pytest.mark.parametrize( "case", [ ExpectFail( input={"offset": [1, 2]}, exception=TypeError, id="list-offset", msg="offset must be a number or string", ), ExpectFail( input={"scale": [1, 2]}, exception=TypeError, id="list-scale", msg="scale must be a number or string", ), ], ids=lambda c: c.id, ) def test_construction_rejects_non_numeric(case: ExpectFail[dict[str, Any]]) -> None: """Non-numeric offset or scale is rejected at construction time.""" with case.raises(): ScaleOffset(**case.input) @pytest.mark.parametrize( "case", [ Expect(input={"offset": 5, "scale": 2}, output=(5, 2), id="int"), Expect(input={"offset": 0.5, "scale": 0.1}, output=(0.5, 0.1), id="float"), ], ids=lambda c: c.id, ) def test_construction_accepts_numeric( case: Expect[dict[str, Any], tuple[int | float, int | float]], ) -> None: """Integer and float values are accepted for both parameters.""" codec = ScaleOffset(**case.input) assert codec.offset == case.output[0] assert codec.scale == case.output[1] # --------------------------------------------------------------------------- # Encode / decode # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("dtype", "offset", "scale"), [ ("float64", 10.0, 0.1), ("float32", 5.0, 2.0), ("int32", 0, 1), ], ids=["float64", "float32", "int32-identity"], ) def test_encode_decode_roundtrip(dtype: str, offset: float, scale: float) -> None: """Data survives encode → decode.""" arr = zarr.create_array( store={}, shape=(100,), dtype=dtype, chunks=(100,), filters=[ScaleOffset(offset=offset, scale=scale)], compressors=None, fill_value=0, ) data = np.arange(100, dtype=dtype) arr[:] = data np.testing.assert_array_almost_equal(arr[:], data) # type: ignore[arg-type] def test_fill_value_transformed() -> None: """Fill value is transformed through the encode formula and read back correctly.""" arr = zarr.create_array( store={}, shape=(10,), dtype="float64", chunks=(10,), filters=[ScaleOffset(offset=5, scale=2)], compressors=None, fill_value=10.0, ) # fill_value=10.0, encode: (10 - 5) * 2 = 10.0 stored # Reading back without writing should return the original fill value np.testing.assert_array_equal(arr[:], np.full(10, 10.0)) def test_identity_is_noop() -> None: """Default codec (offset=0, scale=1) is a no-op.""" import zarr arr = zarr.create_array( store={}, shape=(50,), dtype="float64", chunks=(50,), filters=[ScaleOffset()], compressors=None, fill_value=0, ) data = np.arange(50, dtype="float64") arr[:] = data np.testing.assert_array_equal(arr[:], data) def test_rejects_complex_dtype() -> None: """Complex dtypes are rejected at array creation time.""" with pytest.raises(ValueError, match="only supports integer and floating-point"): zarr.create_array( store={}, shape=(10,), dtype="complex128", chunks=(10,), filters=[ScaleOffset(offset=1, scale=2)], compressors=None, fill_value=0, ) def test_uint64_large_value_roundtrip() -> None: """uint64 values above 2**63 must survive encode+decode (spec requires uint64 support).""" arr = zarr.create_array( store={}, shape=(3,), dtype="uint64", chunks=(3,), filters=[ScaleOffset(offset=0, scale=1)], compressors=None, fill_value=0, ) # Value above int64.max (2**63 - 1) — would wrap if we used int64 as wide dtype. data = np.array([0, 2**63, 2**64 - 1], dtype="uint64") arr[:] = data np.testing.assert_array_equal(arr[:], data) def test_float_nan_inf_preserved() -> None: """NaN and Inf are representable in float dtypes per IEEE 754 and must pass through.""" arr = np.array([1.0, np.nan, np.inf, -np.inf], dtype="float64") encoded = _encode(arr, np.float64(0.0), np.float64(2.0)) np.testing.assert_array_equal(encoded[[0]], np.array([2.0])) assert np.isnan(encoded[1]) assert encoded[2] == np.inf assert encoded[3] == -np.inf decoded = _decode(encoded, np.float64(0.0), np.float64(2.0), scale_repr=2.0) np.testing.assert_array_equal(decoded[[0]], np.array([1.0])) assert np.isnan(decoded[1]) def test_uint64_encode_rejects_underflow() -> None: """uint64 underflow during encode raises rather than silently wrapping.""" arr = zarr.create_array( store={}, shape=(3,), dtype="uint64", chunks=(3,), filters=[ScaleOffset(offset=100, scale=1)], compressors=None, fill_value=100, ) with pytest.raises(ValueError, match="outside the range of dtype uint64"): arr[:] = np.array([100, 50, 200], dtype="uint64") def test_rejects_zero_scale() -> None: """scale=0 is rejected (destroys data and breaks decode division).""" with pytest.raises(ValueError, match="scale must be non-zero"): zarr.create_array( store={}, shape=(10,), dtype="int32", chunks=(10,), filters=[ScaleOffset(offset=0, scale=0)], compressors=None, fill_value=0, ) @pytest.mark.parametrize( "case", [ ExpectFail( input={"dtype": "int32", "offset": 1.5, "scale": 1}, exception=ValueError, id="float-offset-for-int", msg="offset value 1.5 is not representable", ), ExpectFail( input={"dtype": "int32", "offset": 0, "scale": 0.5}, exception=ValueError, id="float-scale-for-int", msg="scale value 0.5 is not representable", ), ExpectFail( input={"dtype": "int16", "offset": "NaN", "scale": 1}, exception=ValueError, id="nan-offset-for-int", msg="offset value 'NaN' is not representable", ), ], ids=lambda c: c.id, ) def test_rejects_unrepresentable_scale_offset(case: ExpectFail[dict[str, Any]]) -> None: """Scale/offset values that can't be represented in the array dtype are rejected.""" with case.raises(): zarr.create_array( store={}, shape=(10,), dtype=case.input["dtype"], chunks=(10,), filters=[ScaleOffset(offset=case.input["offset"], scale=case.input["scale"])], compressors=None, fill_value=0, ) def test_dtype_preservation() -> None: """Integer scale/offset arithmetic preserves the array dtype when division is exact.""" arr = zarr.create_array( store={}, shape=(10,), dtype="int8", chunks=(10,), filters=[ScaleOffset(offset=1, scale=2)], compressors=None, fill_value=0, ) data = np.arange(10, dtype="int8") arr[:] = data # encode=(x-1)*2 is always divisible by scale=2, so decode is exact np.testing.assert_array_equal(arr[:], data) async def test_integer_decode_rejects_non_exact_division() -> None: """Decoding an integer array raises when the stored value isn't divisible by scale.""" store = MemoryStore() arr = zarr.create_array( store=store, shape=(3,), dtype="int8", chunks=(3,), filters=[ScaleOffset(offset=0, scale=2)], compressors=None, fill_value=0, ) # Write raw encoded bytes directly so we can inject a value that isn't divisible by scale. # Array layout: int8 [2, 3, 4]; 3 % 2 != 0, so decode must fail. buf = default_buffer_prototype().buffer.from_bytes(np.array([2, 3, 4], dtype="int8").tobytes()) await arr.store_path.store.set("c/0", buf) with pytest.raises(ValueError, match="non-zero remainder"): arr[:] def test_encode_rejects_signed_integer_overflow() -> None: """Encoding raises when (value - offset) * scale exceeds the target integer range.""" arr = zarr.create_array( store={}, shape=(3,), dtype="int8", chunks=(3,), filters=[ScaleOffset(offset=0, scale=100)], compressors=None, fill_value=0, ) # 2 * 100 = 200, outside int8 range [-128, 127] with pytest.raises(ValueError, match="outside the range of dtype int8"): arr[:] = np.array([0, 1, 2], dtype="int8") def test_encode_rejects_unsigned_integer_underflow() -> None: """Encoding raises when value - offset underflows an unsigned dtype.""" arr = zarr.create_array( store={}, shape=(3,), dtype="uint8", chunks=(3,), filters=[ScaleOffset(offset=10, scale=1)], compressors=None, fill_value=10, ) # 5 - 10 = -5, outside uint8 range [0, 255] with pytest.raises(ValueError, match="outside the range of dtype uint8"): arr[:] = np.array([10, 5, 20], dtype="uint8") def test_float32_dtype_preserved() -> None: """float32 arrays survive encode+decode without being promoted to float64.""" arr = np.arange(100, dtype="float32") offset = np.float32(5.0) scale = np.float32(0.25) encoded = _encode(arr, offset, scale) assert encoded.dtype == np.dtype("float32") decoded = _decode(encoded, offset, scale, scale_repr=0.25) assert decoded.dtype == np.dtype("float32") def test_float_encode_rejects_wider_scalar() -> None: """A float64 scalar passed with a float32 array must not silently widen the result.""" arr = np.arange(10, dtype="float32") # A numpy float64 scalar (not a Python float — NEP 50 exempts those) mixed with a # float32 ndarray promotes to float64. The codec must reject that. with pytest.raises(ValueError, match="changed dtype from float32 to float64"): _encode(arr, np.float64(5.0), np.float64(0.25)) def test_float_decode_rejects_wider_scalar() -> None: """A float64 scalar passed with a float32 array must not silently widen on decode.""" arr = np.arange(10, dtype="float32") with pytest.raises(ValueError, match="changed dtype from float32 to float64"): _decode(arr, np.float64(5.0), np.float64(0.25), scale_repr=0.25) async def test_decode_rejects_integer_overflow_on_offset_add() -> None: """Decoding raises when quotient + offset overflows the target integer dtype.""" store = MemoryStore() arr = zarr.create_array( store=store, shape=(3,), dtype="int8", chunks=(3,), filters=[ScaleOffset(offset=100, scale=1)], compressors=None, fill_value=0, ) # encoded=100 → decoded = 100/1 + 100 = 200, outside int8 range buf = default_buffer_prototype().buffer.from_bytes( np.array([0, 50, 100], dtype="int8").tobytes() ) await arr.store_path.store.set("c/0", buf) with pytest.raises(ValueError, match="outside the range of dtype int8"): arr[:] def test_decode_fits_natively_negative_scale() -> None: """_decode_fits_natively handles negative scale by swapping bounds.""" # For a negative scale, x // scale flips the relationship between min/max. # The function should use info.max // scale as the lower bound and info.min // scale # as the upper bound. dtype = np.dtype("int16") # scale=-2 inverts; offset=0 means range is just q_lo..q_hi assert _decode_fits_natively(dtype, offset=0, scale=-2) is True # An offset that pushes the range out of bounds returns False assert _decode_fits_natively(dtype, offset=100000, scale=-2) is False async def test_decode_int_widened_path() -> None: """When _decode_fits_natively returns False, decode falls through to the widened path.""" # For uint32 with offset near max, q_hi + offset can exceed uint32 if computed in target dtype. # The widened path uses int64 arithmetic and range-checks the result. # We bypass encode by writing raw bytes directly to the store. store = MemoryStore() arr = zarr.create_array( store=store, shape=(3,), dtype="uint32", chunks=(3,), # offset large enough that _decode_fits_natively returns False filters=[ScaleOffset(offset=2**31, scale=1)], compressors=None, # fill_value must be >= offset to avoid uint32 underflow during encode fill_value=2**31, ) # Encoded values that, when added to offset, stay within uint32 buf = default_buffer_prototype().buffer.from_bytes( np.array([0, 100, 1000], dtype="uint32").tobytes() ) await arr.store_path.store.set("c/0", buf) expected = np.array([2**31, 2**31 + 100, 2**31 + 1000], dtype="uint32") np.testing.assert_array_equal(arr[:], expected) def test_compute_encoded_size() -> None: """compute_encoded_size returns the input byte length unchanged (codec is fixed-size).""" codec = ScaleOffset(offset=0, scale=1) # The chunk_spec argument is unused; pass any sentinel assert codec.compute_encoded_size(input_byte_length=100, _chunk_spec=None) == 100 # type: ignore[arg-type] assert codec.compute_encoded_size(input_byte_length=0, _chunk_spec=None) == 0 # type: ignore[arg-type] zarr-python-3.3.0/tests/test_codecs/test_sharding.py000066400000000000000000001271521523267620000226760ustar00rootroot00000000000000import enum import pickle import warnings from typing import Any, cast, get_args from unittest.mock import AsyncMock import numpy as np import numpy.typing as npt import pytest import zarr import zarr.api import zarr.api.asynchronous from zarr import Array from zarr.abc.store import Store from zarr.codecs import ( BloscCodec, BytesCodec, Crc32cCodec, ShardingCodec, TransposeCodec, ) from zarr.codecs.sharding import ( INDEX_LOCATION, MAX_UINT_64, IndexLocation, ShardingCodecIndexLocation, SubchunkWriteOrder, _ShardIndex, _ShardReader, ) from zarr.core.buffer import NDArrayLike, default_buffer_prototype from zarr.core.indexing import lexicographic_order_coords from zarr.core.metadata.v3 import ArrayV3Metadata from zarr.storage import MemoryStore, StorePath, ZipStore from ..conftest import ArrayRequest from .test_codecs import _AsyncArrayProxy, order_from_dim def _reads_are_sync(store_mock: AsyncMock) -> bool: """True when the partial-shard read for this store+pipeline goes through the synchronous methods (get_sync / get_ranges_sync). That requires BOTH the configured pipeline to be the sync (Fused) one AND the store to support sync reads — a Fused read against a non-sync store (e.g. ZipStore) falls back to the async path. Lets the partial-shard-read tests assert the same intent against whichever method family is actually exercised.""" from zarr.abc.store import SupportsGetSync from zarr.core.config import config pipeline_is_sync = "Fused" in config.get("codec_pipeline.path") # store_mock wraps the real store; check the wrapped class for sync support. wrapped = getattr(store_mock, "_mock_wraps", store_mock) return pipeline_is_sync and isinstance(wrapped, SupportsGetSync) def _index_read_count(store_mock: AsyncMock) -> int: """Number of shard-index reads, regardless of sync/async pipeline.""" method = store_mock.get_sync if _reads_are_sync(store_mock) else store_mock.get return int(method.call_count) def _range_read_count(store_mock: AsyncMock) -> int: """Number of coalesced chunk-data reads, regardless of sync/async pipeline.""" method = store_mock.get_ranges_sync if _reads_are_sync(store_mock) else store_mock.get_ranges return int(method.call_count) def _fail_index_read(store_mock: AsyncMock) -> None: """Simulate the shard-index load returning nothing, for the active path.""" if _reads_are_sync(store_mock): store_mock.get_sync.return_value = None else: store_mock.get.return_value = None def _fail_chunk_reads( store_mock: AsyncMock, key_absent_exc: type[Exception] = FileNotFoundError ) -> None: """Simulate chunk-data loads failing (key absent), for the active path. Async get_ranges raises a BaseExceptionGroup; the sync get_ranges_sync mirrors that contract, so both inject a FileNotFoundError-bearing group.""" if _reads_are_sync(store_mock): def fail_sync(key: str, byte_ranges: Any, **kwargs: Any) -> Any: raise BaseExceptionGroup("chunk read failed", [key_absent_exc(key)]) store_mock.get_ranges_sync = fail_sync else: async def fail_async(key: str, byte_ranges: Any, **kwargs: Any) -> Any: raise BaseExceptionGroup("chunk read failed", [key_absent_exc(key)]) yield # type: ignore[unreachable] # marks this as an async generator store_mock.get_ranges = fail_async @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(128,) * 1, dtype="uint8", order="C"), ArrayRequest(shape=(128,) * 2, dtype="uint8", order="C"), ArrayRequest(shape=(128,) * 3, dtype="uint16", order="F"), ], indirect=["array_fixture"], ) @pytest.mark.parametrize("offset", [0, 10]) def test_sharding( store: Store, array_fixture: npt.NDArray[Any], index_location: IndexLocation, offset: int, ) -> None: """ Test that we can create an array with a sharding codec, write data to that array, and get the same data out via indexing. """ data = array_fixture spath = StorePath(store) arr = zarr.create_array( spath, shape=tuple(s + offset for s in data.shape), chunks=(32,) * data.ndim, shards={"shape": (64,) * data.ndim, "index_location": index_location}, dtype=data.dtype, fill_value=6, filters=[TransposeCodec(order=order_from_dim("F", data.ndim))], compressors=BloscCodec(cname="lz4"), ) write_region = tuple(slice(offset, None) for dim in range(data.ndim)) arr[write_region] = data if offset > 0: empty_region = tuple(slice(0, offset) for dim in range(data.ndim)) assert np.all(arr[empty_region] == arr.metadata.fill_value) read_data = arr[write_region] assert isinstance(read_data, NDArrayLike) assert data.shape == read_data.shape assert np.array_equal(data, read_data) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("offset", [0, 10]) def test_sharding_scalar( store: Store, index_location: IndexLocation, offset: int, ) -> None: """ Test that we can create an array with a sharding codec, write data to that array, and get the same data out via indexing. """ spath = StorePath(store) arr = zarr.create_array( spath, shape=(128, 128), chunks=(32, 32), shards={"shape": (64, 64), "index_location": index_location}, dtype="uint8", fill_value=6, filters=[TransposeCodec(order=order_from_dim("F", 2))], compressors=BloscCodec(cname="lz4"), ) arr[:16, :16] = 10 # intentionally write partial chunks read_data = arr[:16, :16] np.testing.assert_array_equal(read_data, 10) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(128,) * 3, dtype="uint16", order="F"), ], indirect=["array_fixture"], ) def test_sharding_partial( store: Store, array_fixture: npt.NDArray[Any], index_location: IndexLocation ) -> None: data = array_fixture spath = StorePath(store) a = zarr.create_array( spath, shape=tuple(a + 10 for a in data.shape), chunks=(32, 32, 32), shards={"shape": (64, 64, 64), "index_location": index_location}, compressors=BloscCodec(cname="lz4"), filters=[TransposeCodec(order=order_from_dim("F", data.ndim))], dtype=data.dtype, fill_value=0, ) a[10:, 10:, 10:] = data read_data = a[0:10, 0:10, 0:10] assert np.all(read_data == 0) read_data = a[10:, 10:, 10:] assert isinstance(read_data, NDArrayLike) assert data.shape == read_data.shape assert np.array_equal(data, read_data) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(128,) * 3, dtype="uint16", order="F"), ], indirect=["array_fixture"], ) def test_sharding_partial_readwrite( store: Store, array_fixture: npt.NDArray[Any], index_location: IndexLocation ) -> None: data = array_fixture spath = StorePath(store) a = zarr.create_array( spath, shape=data.shape, chunks=(1, data.shape[1], data.shape[2]), shards={"shape": data.shape, "index_location": index_location}, dtype=data.dtype, fill_value=0, filters=None, compressors=None, ) a[:] = data for x in range(data.shape[0]): read_data = a[x, :, :] assert np.array_equal(data[x], read_data) @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(128,) * 3, dtype="uint16", order="F"), ], indirect=["array_fixture"], ) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_partial_read( store: Store, array_fixture: npt.NDArray[Any], index_location: IndexLocation ) -> None: data = array_fixture spath = StorePath(store) a = zarr.create_array( spath, shape=tuple(a + 10 for a in data.shape), chunks=(32, 32, 32), shards={"shape": (64, 64, 64), "index_location": index_location}, compressors=BloscCodec(cname="lz4"), filters=[TransposeCodec(order=order_from_dim("F", data.ndim))], dtype=data.dtype, fill_value=1, ) read_data = a[0:10, 0:10, 0:10] assert np.all(read_data == 1) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_multiple_chunks_partial_shard_read( store: Store, index_location: IndexLocation, ) -> None: array_shape = (16, 64) shard_shape = (8, 32) chunk_shape = (2, 4) data = np.arange(np.prod(array_shape), dtype="float32").reshape(array_shape) store_mock = AsyncMock(wraps=store, spec=store.__class__) a = zarr.create_array( StorePath(store_mock), shape=data.shape, chunks=chunk_shape, shards={"shape": shard_shape, "index_location": index_location}, compressors=BloscCodec(cname="lz4"), dtype=data.dtype, fill_value=1, ) a[:] = data store_mock.reset_mock() # ignore store calls during array creation # Reads 3 (2 full, 1 partial) chunks each from 2 shards (a subset of both shards) # for a total of 6 chunks accessed assert np.allclose(a[0, 22:42], np.arange(22, 42, dtype="float32")) # 2 shard index reads + 2 coalesced chunk-data reads (one per shard) assert _index_read_count(store_mock) == 2 assert _range_read_count(store_mock) == 2 store_mock.reset_mock() # Reads 4 chunks from both shards along dimension 0 for a total of 8 chunks accessed assert np.allclose(a[:, 0], np.arange(0, data.size, array_shape[1], dtype="float32")) # 2 shard index reads + 2 coalesced chunk-data reads (one per shard) assert _index_read_count(store_mock) == 2 assert _range_read_count(store_mock) == 2 @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_duplicate_read_indexes( store: Store, index_location: IndexLocation, ) -> None: """ Check that duplicate index reads are handled correctly when using get_ranges for chunk data. """ array_shape = (15,) shard_shape = (8,) chunk_shape = (2,) data = np.arange(np.prod(array_shape), dtype="float32").reshape(array_shape) store_mock = AsyncMock(wraps=store, spec=store.__class__) a = zarr.create_array( StorePath(store_mock), shape=data.shape, chunks=chunk_shape, shards={"shape": shard_shape, "index_location": index_location}, compressors=BloscCodec(cname="lz4"), dtype=data.dtype, fill_value=-1, ) a[:] = data store_mock.reset_mock() # ignore store calls during array creation # Read the same index multiple times from two chunks indexer = [8, 8, 12, 12] assert np.array_equal(a[indexer], data[indexer]) # 1 shard index read + 1 coalesced chunk-data read assert _index_read_count(store_mock) == 1 assert _range_read_count(store_mock) == 1 @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_read_empty_chunks_within_non_empty_shard_write_empty_false( store: Store, index_location: IndexLocation ) -> None: """ Case where - some, but not all, chunks in the last shard are empty - the last shard is not complete (array length is not a multiple of shard shape), this takes us down the partial shard read path - write_empty_chunks=False so the shard index will have fewer entries than chunks in the shard """ # array with mixed empty and non-empty chunks in second shard data = np.array([ # shard 0. full 8 elements, all chunks have some non-fill data 0, 1, 2, 3, 4, 5, 6, 7, # shard 1. 6 elements (< shard shape) 2, 0, # chunk 0, written -9, -9, # chunk 1, all fill, not written 4, 5 # chunk 2, written ], dtype="int32") # fmt: off spath = StorePath(store) a = zarr.create_array( spath, shape=(14,), chunks=(2,), shards={"shape": (8,), "index_location": index_location}, dtype="int32", fill_value=-9, filters=None, compressors=None, config={"write_empty_chunks": False}, ) a[:] = data assert np.array_equal(a[:], data) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_read_empty_chunks_within_empty_shard_write_empty_false( store: Store, index_location: IndexLocation ) -> None: """ Case where - all chunks in last shard are empty - the last shard is not complete (array length is not a multiple of shard shape), this takes us down the partial shard read path - write_empty_chunks=False so the shard index will have no entries """ fill_value = -99 shard_size = 8 data = np.arange(14, dtype="int32") data[shard_size:] = fill_value # 2nd shard is all fill value spath = StorePath(store) a = zarr.create_array( spath, shape=(14,), chunks=(2,), shards={"shape": (shard_size,), "index_location": index_location}, dtype="int32", fill_value=fill_value, filters=None, compressors=None, config={"write_empty_chunks": False}, ) a[:] = data assert np.array_equal(a[:], data) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_partial_shard_read__index_load_fails( store: Store, index_location: IndexLocation ) -> None: """Test fill value is returned when the call to the store to load the bytes of the shard's chunk index fails.""" array_shape = (16,) shard_shape = (16,) chunk_shape = (8,) data = np.arange(np.prod(array_shape), dtype="float32").reshape(array_shape) fill_value = -999 store_mock = AsyncMock(wraps=store, spec=store.__class__) a = zarr.create_array( StorePath(store_mock), shape=data.shape, chunks=chunk_shape, shards={"shape": shard_shape, "index_location": index_location}, compressors=BloscCodec(cname="lz4"), dtype=data.dtype, fill_value=fill_value, ) a[:] = data # Loading the index returns None -> simulate an index load failure, on # whichever read method the active pipeline uses (get / get_sync). _fail_index_read(store_mock) # Read from one of two chunks in a shard to test the partial shard read path assert a[0] == fill_value assert a[0] != data[0] @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_partial_shard_read__index_chunk_slice_fails( store: Store, index_location: IndexLocation, monkeypatch: pytest.MonkeyPatch, ) -> None: """Test fill value is returned when looking up a chunk's byte slice within a shard fails.""" array_shape = (16,) shard_shape = (16,) chunk_shape = (8,) data = np.arange(np.prod(array_shape), dtype="float32").reshape(array_shape) fill_value = -999 monkeypatch.setattr( "zarr.codecs.sharding._ShardIndex.get_chunk_slice", lambda self, chunk_coords: None, ) a = zarr.create_array( StorePath(store), shape=data.shape, chunks=chunk_shape, shards={"shape": shard_shape, "index_location": index_location}, compressors=BloscCodec(cname="lz4"), dtype=data.dtype, fill_value=fill_value, ) a[:] = data # Read from one of two chunks in a shard to test the partial shard read path assert a[0] == fill_value assert a[0] != data[0] @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_partial_shard_read__chunk_load_fails( store: Store, index_location: IndexLocation ) -> None: """Test fill value is returned when the call to the store to load a chunk's bytes fails.""" array_shape = (16,) shard_shape = (16,) chunk_shape = (8,) data = np.arange(np.prod(array_shape), dtype="float32").reshape(array_shape) fill_value = -999 store_mock = AsyncMock(wraps=store, spec=store.__class__) a = zarr.create_array( StorePath(store_mock), shape=data.shape, chunks=chunk_shape, shards={"shape": shard_shape, "index_location": index_location}, compressors=BloscCodec(cname="lz4"), dtype=data.dtype, fill_value=fill_value, ) a[:] = data # Set up store mock after array creation to simulate chunk load failure. # Index loads still succeed, but chunk-byte loads fail (the coalesced range # read raises a BaseExceptionGroup containing FileNotFoundError — the same # shape produced when a key is absent), on whichever read method the active # pipeline uses (get_ranges / get_ranges_sync). store_mock.reset_mock() _fail_chunk_reads(store_mock) # Read from one of two chunks in a shard to test the partial shard read path assert a[0] == fill_value assert a[0] != data[0] @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(128,) * 3, dtype="uint16", order="F"), ], indirect=["array_fixture"], ) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_sharding_partial_overwrite( store: Store, array_fixture: npt.NDArray[Any], index_location: IndexLocation ) -> None: data = array_fixture[:10, :10, :10] spath = StorePath(store) a = zarr.create_array( spath, shape=tuple(a + 10 for a in data.shape), chunks=(32, 32, 32), shards={"shape": (64, 64, 64), "index_location": index_location}, compressors=BloscCodec(cname="lz4"), filters=[TransposeCodec(order=order_from_dim("F", data.ndim))], dtype=data.dtype, fill_value=1, ) a[:10, :10, :10] = data read_data = a[0:10, 0:10, 0:10] assert np.array_equal(data, read_data) data += 10 if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): a[:10, :10, :10] = data else: a[:10, :10, :10] = data read_data = a[0:10, 0:10, 0:10] assert np.array_equal(data, read_data) # Zip storage raises a warning about a duplicate name, which we ignore. @pytest.mark.filterwarnings("ignore:Duplicate name.*:UserWarning") @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(127, 128, 129), dtype="uint16", order="F"), ], indirect=True, ) @pytest.mark.parametrize( "outer_index_location", ["start", "end"], ) @pytest.mark.parametrize( "inner_index_location", ["start", "end"], ) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_nested_sharding( store: Store, array_fixture: npt.NDArray[Any], outer_index_location: IndexLocation, inner_index_location: IndexLocation, ) -> None: data = array_fixture spath = StorePath(store) # compressors=None ensures no BytesBytesCodec is added, which keeps # supports_partial_decode=True and exercises the partial decode path a = zarr.create_array( spath, data=data, chunks=(64,) * data.ndim, compressors=None, serializer=ShardingCodec( chunk_shape=(32,) * data.ndim, codecs=[ ShardingCodec(chunk_shape=(16,) * data.ndim, index_location=inner_index_location) ], index_location=outer_index_location, ), ) a[:] = data read_data = a[0 : data.shape[0], 0 : data.shape[1], 0 : data.shape[2]] assert isinstance(read_data, NDArrayLike) assert data.shape == read_data.shape assert np.array_equal(data, read_data) @pytest.mark.parametrize( "array_fixture", [ ArrayRequest(shape=(128,) * 3, dtype="uint16", order="F"), ], indirect=["array_fixture"], ) @pytest.mark.parametrize( "outer_index_location", ["start", "end"], ) @pytest.mark.parametrize( "inner_index_location", ["start", "end"], ) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_nested_sharding_create_array( store: Store, array_fixture: npt.NDArray[Any], outer_index_location: IndexLocation, inner_index_location: IndexLocation, ) -> None: data = array_fixture spath = StorePath(store) a = zarr.create_array( spath, shape=data.shape, chunks=(32, 32, 32), dtype=data.dtype, fill_value=0, serializer=ShardingCodec( chunk_shape=(32, 32, 32), codecs=[ShardingCodec(chunk_shape=(16, 16, 16), index_location=inner_index_location)], index_location=outer_index_location, ), filters=None, compressors=None, ) a[:] = data read_data = a[:] assert np.array_equal(data, read_data) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_open_sharding(store: Store) -> None: path = "open_sharding" spath = StorePath(store, path) a = zarr.create_array( spath, shape=(16, 16), chunks=(8, 8), shards=(16, 16), filters=[TransposeCodec(order=order_from_dim("F", 2))], compressors=BloscCodec(), dtype="int32", fill_value=0, ) b = Array.open(spath) assert a.metadata == b.metadata @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) def test_write_partial_sharded_chunks(store: Store) -> None: data = np.arange(0, 16 * 16, dtype="uint16").reshape((16, 16)) spath = StorePath(store) a = zarr.create_array( spath, shape=(40, 40), chunks=(10, 10), shards=(20, 20), dtype=data.dtype, compressors=BloscCodec(), fill_value=1, ) a[0:16, 0:16] = data assert np.array_equal(a[0:16, 0:16], data) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) async def test_delete_empty_shards(store: Store) -> None: if not store.supports_deletes: pytest.skip("store does not support deletes") path = "delete_empty_shards" spath = StorePath(store, path) a = await zarr.api.asynchronous.create_array( spath, shape=(16, 16), chunks=(8, 8), shards=(8, 16), dtype="uint16", compressors=None, fill_value=1, ) print(a.metadata.to_dict()) await _AsyncArrayProxy(a)[:, :].set(np.zeros((16, 16))) await _AsyncArrayProxy(a)[8:, :].set(np.ones((8, 16))) await _AsyncArrayProxy(a)[:, 8:].set(np.ones((16, 8))) # chunk (0, 0) is full # chunks (0, 1), (1, 0), (1, 1) are empty # shard (0, 0) is half-full # shard (1, 0) is empty data = np.ones((16, 16), dtype="uint16") data[:8, :8] = 0 assert np.array_equal(data, await _AsyncArrayProxy(a)[:, :].get()) assert await store.get(f"{path}/c/1/0", prototype=default_buffer_prototype()) is None chunk_bytes = await store.get(f"{path}/c/0/0", prototype=default_buffer_prototype()) assert chunk_bytes is not None assert len(chunk_bytes) == 16 * 2 + 8 * 8 * 2 + 4 def test_structured_dtype_fill_value() -> None: """Sharded arrays with a structured dtype are writable and readable even though the fill value is an (unhashable) ``np.void`` scalar: the sharding codec's chunk-spec caches key on ``ArraySpec``, whose hash must handle void fills (see https://github.com/zarr-developers/zarr-python/issues/3054).""" dtype = np.dtype([("a", "i4"), ("b", "f4")]) arr = zarr.create_array( MemoryStore(), shape=(8,), chunks=(2,), shards=(4,), dtype=dtype, fill_value=(1, 2.0), ) data = np.array([(i, i / 2) for i in range(8)], dtype=dtype) arr[:4] = data[:4] expected = np.zeros(8, dtype=dtype) expected[:4] = data[:4] expected[4:] = (1, 2.0) # untouched shard reads back as the fill value assert np.array_equal(arr[:], expected) def test_pickle() -> None: """ShardingCodec round-trips through pickle, including the non-serialized ``subchunk_write_order`` (which ``to_dict`` omits and which must not silently revert to the ``morton`` default).""" codec = ShardingCodec(chunk_shape=(8, 8)) assert pickle.loads(pickle.dumps(codec)) == codec ordered = ShardingCodec(chunk_shape=(8, 8), subchunk_write_order="lexicographic") restored = pickle.loads(pickle.dumps(ordered)) assert restored == ordered assert restored.subchunk_write_order == "lexicographic" @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("index_location", ["start", "end"]) async def test_sharding_with_empty_inner_chunk(store: Store, index_location: IndexLocation) -> None: data = np.arange(0, 16 * 16, dtype="uint32").reshape((16, 16)) fill_value = 1 path = f"sharding_with_empty_inner_chunk_{index_location}" spath = StorePath(store, path) a = await zarr.api.asynchronous.create_array( spath, shape=(16, 16), chunks=(4, 4), shards={"shape": (8, 8), "index_location": index_location}, dtype="uint32", fill_value=fill_value, ) data[:4, :4] = fill_value await a.setitem(..., data) print("read data") data_read = await a.getitem(...) assert np.array_equal(data_read, data) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize("chunks_per_shard", [(5, 2), (2, 5), (5, 5)]) async def test_sharding_with_chunks_per_shard( store: Store, index_location: IndexLocation, chunks_per_shard: tuple[int] ) -> None: chunk_shape = (2, 1) shape = tuple(x * y for x, y in zip(chunks_per_shard, chunk_shape, strict=False)) data = np.ones(np.prod(shape), dtype="int32").reshape(shape) fill_value = 42 path = f"test_sharding_with_chunks_per_shard_{index_location}" spath = StorePath(store, path) a = zarr.create_array( spath, shape=shape, chunks=chunk_shape, shards={"shape": shape, "index_location": index_location}, dtype="int32", fill_value=fill_value, ) a[...] = data data_read = a[...] assert np.array_equal(data_read, data) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_invalid_metadata(store: Store) -> None: spath1 = StorePath(store, "invalid_inner_chunk_shape") with pytest.raises(ValueError): zarr.create_array( spath1, shape=(16, 16), shards=(16, 16), chunks=(8,), dtype=np.dtype("uint8"), fill_value=0, ) spath2 = StorePath(store, "invalid_inner_chunk_shape") with pytest.raises(ValueError): zarr.create_array( spath2, shape=(16, 16), shards=(16, 16), chunks=(8, 7), dtype=np.dtype("uint8"), fill_value=0, ) def test_invalid_shard_shape() -> None: with pytest.raises( ValueError, match=( f"Chunk edge length {16} in dimension {0} is not " f"divisible by the shard's inner chunk size {9}\\." ), ): zarr.create_array( {}, shape=(16, 16), shards=(16, 16), chunks=(9, 9), dtype=np.dtype("uint8"), fill_value=0, ) @pytest.mark.parametrize("store", ["local"], indirect=["store"]) def test_sharding_mixed_integer_list_indexing(store: Store) -> None: """Regression test for https://github.com/zarr-developers/zarr-python/issues/3691. Mixed integer/list indexing on sharded arrays should return the same shape and data as on equivalent chunked arrays. """ import numpy as np data = np.arange(200 * 100 * 10, dtype=np.uint8).reshape(200, 100, 10) chunked = zarr.create_array( store, name="chunked", shape=(200, 100, 10), dtype=np.uint8, chunks=(200, 100, 1), overwrite=True, ) chunked[:, :, :] = data sharded = zarr.create_array( store, name="sharded", shape=(200, 100, 10), dtype=np.uint8, chunks=(200, 100, 1), shards=(200, 100, 10), overwrite=True, ) sharded[:, :, :] = data # Mixed integer + list indexing c = chunked[0:10, 0, [0, 1]] # type: ignore[index] s = sharded[0:10, 0, [0, 1]] # type: ignore[index] assert c.shape == s.shape == (10, 2), ( # type: ignore[union-attr] f"Expected (10, 2), got chunked={c.shape}, sharded={s.shape}" # type: ignore[union-attr] ) np.testing.assert_array_equal(c, s) # Multiple integer axes c2 = chunked[0, 0, [0, 1, 2]] # type: ignore[index] s2 = sharded[0, 0, [0, 1, 2]] # type: ignore[index] assert c2.shape == s2.shape == (3,) # type: ignore[union-attr] np.testing.assert_array_equal(c2, s2) # Slice + integer + slice c3 = chunked[0:5, 1, 0:3] s3 = sharded[0:5, 1, 0:3] assert c3.shape == s3.shape == (5, 3) # type: ignore[union-attr] np.testing.assert_array_equal(c3, s3) async def stored_data_and_get_order( codec: ShardingCodec, chunks_per_shard: tuple[int, ...] ) -> list[tuple[int, ...]]: shard_shape = tuple(c * s for c, s in zip(chunks_per_shard, codec.chunk_shape, strict=True)) store = MemoryStore() arr = zarr.create_array( StorePath(store), shape=shard_shape, dtype="uint8", chunks=shard_shape, serializer=codec, filters=None, compressors=None, fill_value=0, ) arr[:] = np.arange(np.prod(shard_shape), dtype="uint8").reshape(shard_shape) shard_buf = await store.get("c/0/0", prototype=default_buffer_prototype()) if shard_buf is None: raise RuntimeError("data write failed") index = (await _ShardReader.from_bytes(shard_buf, codec, chunks_per_shard)).index offset_to_coord: dict[int, tuple[int, ...]] = dict( zip( index.get_chunk_slices_vectorized(np.array(list(np.ndindex(chunks_per_shard))))[ 0 ], # start list(np.ndindex(chunks_per_shard)), # coord strict=True, ) ) # The physical write order is recovered by sorting coordinates by start offset. return [coord for _, coord in sorted(offset_to_coord.items())] @pytest.mark.parametrize( "subchunk_write_order", get_args(SubchunkWriteOrder), ) async def test_encoded_subchunk_write_order(subchunk_write_order: SubchunkWriteOrder) -> None: """Subchunks must be physically laid out in the shard in the order specified by ``subchunk_write_order``. We verify this by decoding the shard index and sorting the chunk coordinates by their byte offset. ``unordered`` makes no stable-order promise, but is deterministic in this implementation, so it is checked the same way.""" # Use a non-square chunks_per_shard so all orderings are distinguishable. chunks_per_shard = (3, 2) chunk_shape = (4, 4) codec = ShardingCodec( chunk_shape=chunk_shape, codecs=[BytesCodec()], index_codecs=[BytesCodec(), Crc32cCodec()], index_location="end", subchunk_write_order=subchunk_write_order, ) actual_order = await stored_data_and_get_order(codec, chunks_per_shard) expected_order = list(codec._subchunk_order_iter(chunks_per_shard, subchunk_write_order)) assert actual_order == expected_order @pytest.mark.parametrize( "subchunk_write_order", get_args(SubchunkWriteOrder), ) @pytest.mark.parametrize("do_partial", [True, False], ids=["partial", "complete"]) def test_subchunk_write_order_roundtrip( subchunk_write_order: SubchunkWriteOrder, do_partial: bool ) -> None: """Data written with any ``subchunk_write_order`` must round-trip correctly.""" chunks_per_shard = (3, 2) chunk_shape = (4, 4) shard_shape = tuple(c * s for c, s in zip(chunks_per_shard, chunk_shape, strict=True)) data = np.arange(np.prod(shard_shape), dtype="uint16").reshape(shard_shape) arr = zarr.create_array( StorePath(MemoryStore()), shape=shard_shape, dtype=data.dtype, chunks=shard_shape, serializer=ShardingCodec( chunk_shape=chunk_shape, codecs=[BytesCodec()], subchunk_write_order=subchunk_write_order, ), filters=None, compressors=None, fill_value=0, ) if do_partial: sub_data = data[: (shard_shape[0] // 2)] arr[: (shard_shape[0] // 2)] = data[: (shard_shape[0] // 2)] data = np.vstack([sub_data, np.zeros_like(sub_data)]) else: arr[:] = data np.testing.assert_array_equal(arr[:], data) # --- Tests for ShardingCodecIndexLocation deprecation --- @pytest.mark.parametrize("location", INDEX_LOCATION) def test_sharding_codec_accepts_all_index_locations(location: IndexLocation) -> None: """ Every value in INDEX_LOCATION is accepted by ShardingCodec and round-trips to the same value on the stored attribute. Catches drift between the IndexLocation type alias and the runtime INDEX_LOCATION tuple. """ codec = ShardingCodec(chunk_shape=(1,), index_location=location) assert codec.index_location == location @pytest.mark.parametrize("location", INDEX_LOCATION) def test_sharding_codec_json_roundtrip_index_location( location: IndexLocation, ) -> None: """ ShardingCodec.to_dict writes index_location as the bare literal string, and the round-trip through from_dict preserves equality. Asserting the on-disk index_location value (not just the round-trip) catches drift between ShardingCodec's runtime representation and the V3 wire form. """ codec = ShardingCodec(chunk_shape=(1,), index_location=location) serialized = codec.to_dict() assert serialized["configuration"]["index_location"] == location # type: ignore[index, call-overload] restored = ShardingCodec.from_dict(serialized) assert restored == codec @pytest.mark.parametrize( ("member", "expected"), [("start", "start"), ("end", "end")], ) def test_sharding_index_location_member_access_warns(member: str, expected: str) -> None: """ Accessing a member on the deprecated ShardingCodecIndexLocation class emits a DeprecationWarning and resolves to the equivalent literal string. """ with pytest.warns(DeprecationWarning, match=rf"ShardingCodecIndexLocation\.{member}"): value = getattr(ShardingCodecIndexLocation, member) assert value == expected def test_sharding_index_location_class_imports_silently() -> None: """ Importing the deprecated ShardingCodecIndexLocation class by name must not emit a warning; only member access does. """ with warnings.catch_warnings(): warnings.simplefilter("error") from zarr.codecs.sharding import ( # noqa: F401 ShardingCodecIndexLocation as _SCIL, ) def test_sharding_codec_init_with_enum_instance_warns() -> None: """ Passing a foreign enum.Enum instance to ShardingCodec.__init__ triggers the init-level deprecation warning (from _coerce_enum_input) and normalizes the value to the corresponding literal string. Covers the case where a downstream package defined its own enum-shaped class to bridge between zarr's old API and its own. """ class LegacyIndexLocation(enum.Enum): end = "end" with pytest.warns(DeprecationWarning, match=r"Passing an enum to ShardingCodec"): codec = ShardingCodec( chunk_shape=(1,), index_location=cast(ShardingCodecIndexLocation, LegacyIndexLocation.end), ) assert codec.index_location == "end" def test_sharding_codec_init_with_deprecated_class_member() -> None: """ The realistic legacy-upgrade idiom: ShardingCodec(index_location=ShardingCodecIndexLocation.end). Member access on ShardingCodecIndexLocation emits one DeprecationWarning (from the metaclass) and resolves to the bare string, which ShardingCodec then accepts without further warning. No second warning from _coerce_enum_input because the metaclass already produced a string. The cast is necessary because the metaclass __getattr__ is typed as returning str, which does not statically match the codec's IndexLocation parameter even though the runtime value does. """ with pytest.warns(DeprecationWarning, match=r"ShardingCodecIndexLocation\.end"): codec = ShardingCodec( chunk_shape=(1,), index_location=cast(IndexLocation, ShardingCodecIndexLocation.end), ) assert codec.index_location == "end" def test_sharding_codec_rejects_unknown_index_location() -> None: """ ShardingCodec.__init__ raises ValueError when index_location is outside INDEX_LOCATION, and the error message names the offending parameter. """ kwargs: dict[str, Any] = {"chunk_shape": (1,), "index_location": "middle"} with pytest.raises(ValueError, match="index_location must be one of"): ShardingCodec(**kwargs) def test_sharding_index_location_attribute_error_for_unknown_member() -> None: """ Attribute access for a name that is not a known member of the deprecated ShardingCodecIndexLocation class falls through to AttributeError. """ with pytest.raises(AttributeError): getattr(ShardingCodecIndexLocation, "not_a_member") # noqa: B009 @pytest.mark.parametrize("index_location", INDEX_LOCATION) def test_create_array_with_dict_shards_index_location( index_location: IndexLocation, ) -> None: """ zarr.create_array accepts a `ShardsConfigParam`-shaped dict for `shards` with an explicit `index_location`, and the resulting sharding codec stores that value. Covers the `isinstance(shards, dict)` branch in init_array that the tuple-shaped `shards` form doesn't reach. """ arr = zarr.create_array( store={}, shape=(8,), chunks=(2,), shards={"shape": (4,), "index_location": index_location}, dtype="uint8", ) assert isinstance(arr.metadata, ArrayV3Metadata) # needed for mypy sharding = arr.metadata.codecs[0] assert isinstance(sharding, ShardingCodec) assert sharding.index_location == index_location def test_sharding_zero_dimensional() -> None: """Regression test for https://github.com/zarr-developers/zarr-python/issues/3751""" arr = zarr.create_array({}, shape=(), dtype="f4", chunks=(), shards=()) arr[()] = 42.0 assert arr[()] == pytest.approx(42.0) # Overwriting should also work arr[()] = 43.0 assert arr[()] == pytest.approx(43.0) def test_shard_index_stores_chunks_per_shard_explicitly() -> None: """_ShardIndex stores the chunk grid shape as an explicit field.""" index = _ShardIndex.create_empty((2, 3)) assert index.chunks_per_shard == (2, 3) # 0-D: chunks_per_shard is the empty tuple, distinct from the array's rank index_0d = _ShardIndex.create_empty(()) assert index_0d.chunks_per_shard == () @pytest.mark.parametrize("chunks_per_shard", [(), (3,), (2, 3)]) def test_shard_index_get_chunk_slices_vectorized(chunks_per_shard: tuple[int, ...]) -> None: """get_chunk_slices_vectorized works uniformly across chunk grid ranks, including 0-D.""" index = _ShardIndex.create_empty(chunks_per_shard) # Write the first chunk; leave the rest (if any) empty. all_coords = list(lexicographic_order_coords(chunks_per_shard)) index.set_chunk_slice(all_coords[0], slice(10, 14)) coords_array = np.array(all_coords, dtype=np.uint64).reshape( len(all_coords), len(chunks_per_shard) ) starts, ends, valid = index.get_chunk_slices_vectorized(coords_array) expected_valid = np.zeros(len(all_coords), dtype=bool) expected_valid[0] = True np.testing.assert_array_equal(valid, expected_valid) assert starts[0] == 10 assert ends[0] == 14 np.testing.assert_array_equal(starts[~expected_valid], MAX_UINT_64) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize( "pipeline_path", [ "zarr.core.codec_pipeline.FusedCodecPipeline", "zarr.core.codec_pipeline.BatchedCodecPipeline", ], ) def test_sharding_vlen_inner_codec_roundtrip(pipeline_path: str) -> None: """A sharded array whose inner codec chain is a variable-length codec (VLenUTF8) must round-trip under either pipeline. Regression: the Fused pipeline's bulk-decode gate calls `c.is_fixed_size` on every inner codec. `is_fixed_size` is declared on the Codec ABC but had no default, so codecs that don't set it (VLenUTF8/VLenBytes, numcodecs wrappers) raised AttributeError on read — crashing every sharded read whose inner chain included such a codec. """ # The variable-length StringDType resolves to a VLenUTF8Codec inner chain # (a fixed-width None: """to_dict_vectorized derives its own coords and maps present chunks to buffers, empty to None. The reader is given the full per-shard chunk grid implicitly (it reads ``chunks_per_shard`` off its own index), so the result must contain every lexicographic coordinate as a key, with the stored bytes for present chunks and ``None`` for empty ones. """ all_coords = list(lexicographic_order_coords(chunks_per_shard)) # Lay two chunks back-to-back in the buffer; leave the rest (if any) empty. payload = b"abcdXY" index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice(all_coords[0], slice(0, 4)) present = {all_coords[0]: payload[0:4]} if len(all_coords) > 1: index.set_chunk_slice(all_coords[1], slice(4, 6)) present[all_coords[1]] = payload[4:6] reader = _ShardReader() reader.index = index reader.buf = default_buffer_prototype().buffer.from_bytes(payload) result = reader.to_dict_vectorized() # Every lexicographic coordinate is present as a key, in order. assert list(result.keys()) == all_coords for coords in all_coords: buf = result[coords] if coords in present: assert buf is not None assert buf.to_bytes() == present[coords] else: assert buf is None zarr-python-3.3.0/tests/test_codecs/test_sharding_unit.py000066400000000000000000001251211523267620000237270ustar00rootroot00000000000000from __future__ import annotations import asyncio from dataclasses import dataclass, replace from typing import TYPE_CHECKING, Any, Literal, cast from unittest.mock import AsyncMock import numpy as np import numpy.typing as npt import pytest import zarr from zarr.abc.codec import ArrayArrayCodec, ArrayBytesCodec from zarr.codecs.bytes import BytesCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.sharding import ( MAX_UINT_64, ShardingCodec, _ShardIndex, _ShardingByteGetter, _ShardReader, ) from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import Buffer as ABCBuffer from zarr.core.buffer import NDBuffer, default_buffer_prototype from zarr.core.buffer.cpu import Buffer from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.chunk_grids import ChunkGrid from zarr.core.config import config from zarr.core.dtype import get_data_type_from_native_dtype from zarr.core.indexing import BasicIndexer from zarr.storage._common import StorePath from zarr.storage._memory import MemoryStore if TYPE_CHECKING: from zarr.core.array import ShardsConfigParam from zarr.core.array_spec import ArrayConfigParams # ============================================================================ # _ShardIndex tests # ============================================================================ def test_shard_index_create_empty() -> None: """Test that create_empty creates an index filled with MAX_UINT_64.""" chunks_per_shard = (2, 3) index = _ShardIndex.create_empty(chunks_per_shard) assert index.chunks_per_shard == chunks_per_shard assert index.offsets_and_lengths.shape == (2, 3, 2) assert index.offsets_and_lengths.dtype == np.dtype(" None: """Test create_empty with 1D chunks_per_shard.""" chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) assert index.chunks_per_shard == chunks_per_shard assert index.offsets_and_lengths.shape == (4, 2) def test_shard_index_is_all_empty_true() -> None: """Test is_all_empty returns True for a freshly created empty index.""" index = _ShardIndex.create_empty((2, 2)) assert index.is_all_empty() is True def test_shard_index_is_all_empty_false() -> None: """Test is_all_empty returns False when at least one chunk is set.""" index = _ShardIndex.create_empty((2, 2)) index.set_chunk_slice((0, 0), slice(0, 100)) assert index.is_all_empty() is False def test_shard_index_get_chunk_slice_empty() -> None: """Test get_chunk_slice returns None for empty chunks.""" index = _ShardIndex.create_empty((2, 2)) assert index.get_chunk_slice((0, 0)) is None assert index.get_chunk_slice((1, 1)) is None def test_shard_index_get_chunk_slice_set() -> None: """Test get_chunk_slice returns correct (start, end) tuple after setting.""" index = _ShardIndex.create_empty((2, 2)) index.set_chunk_slice((0, 1), slice(100, 200)) result = index.get_chunk_slice((0, 1)) assert result == (100, 200) def test_shard_index_set_chunk_slice() -> None: """Test set_chunk_slice correctly sets offset and length.""" index = _ShardIndex.create_empty((3, 3)) # Set a chunk slice index.set_chunk_slice((1, 2), slice(50, 150)) # Verify the underlying array assert index.offsets_and_lengths[1, 2, 0] == 50 # offset assert index.offsets_and_lengths[1, 2, 1] == 100 # length (150 - 50) def test_shard_index_set_chunk_slice_none() -> None: """Test set_chunk_slice with None marks chunk as empty.""" index = _ShardIndex.create_empty((2, 2)) # First set a value index.set_chunk_slice((0, 0), slice(0, 100)) assert index.get_chunk_slice((0, 0)) == (0, 100) # Then clear it index.set_chunk_slice((0, 0), None) assert index.get_chunk_slice((0, 0)) is None assert index.offsets_and_lengths[0, 0, 0] == MAX_UINT_64 assert index.offsets_and_lengths[0, 0, 1] == MAX_UINT_64 def test_shard_index_get_full_chunk_map() -> None: """Test get_full_chunk_map returns correct boolean array.""" index = _ShardIndex.create_empty((2, 3)) # Set some chunks index.set_chunk_slice((0, 0), slice(0, 10)) index.set_chunk_slice((1, 2), slice(10, 20)) chunk_map = index.get_full_chunk_map() assert chunk_map.shape == (2, 3) assert chunk_map.dtype == np.bool_ assert chunk_map[0, 0] is np.True_ assert chunk_map[0, 1] is np.False_ assert chunk_map[0, 2] is np.False_ assert chunk_map[1, 0] is np.False_ assert chunk_map[1, 1] is np.False_ assert chunk_map[1, 2] is np.True_ def test_shard_index_localize_chunk() -> None: """Test _localize_chunk maps global coords to local shard coords via modulo.""" index = _ShardIndex.create_empty((2, 3)) # Within bounds - should return same coords assert index._localize_chunk((0, 0)) == (0, 0) assert index._localize_chunk((1, 2)) == (1, 2) # Out of bounds - should wrap via modulo assert index._localize_chunk((2, 0)) == (0, 0) # 2 % 2 = 0 assert index._localize_chunk((3, 5)) == (1, 2) # 3 % 2 = 1, 5 % 3 = 2 assert index._localize_chunk((4, 6)) == (0, 0) # 4 % 2 = 0, 6 % 3 = 0 # ============================================================================ # _load_partial_shard_maybe tests # # These exercise the partial-shard read path against a real MemoryStore wrapped # in a StorePath (the external-store branch in `_load_partial_shard_maybe`), # plus one test against a real `_ShardingByteGetter` (the in-memory branch used # by nested sharding). # ============================================================================ async def _store_path_with_blob(key: str, blob: bytes) -> StorePath: """Build a `StorePath` over a fresh `MemoryStore` containing `blob` at `key`.""" store = MemoryStore() await store.set(key, Buffer.from_bytes(blob)) return StorePath(store, key) async def test_load_partial_shard_maybe_index_load_fails() -> None: """Returns None when the shard key is absent (index load fails).""" codec = ShardingCodec(chunk_shape=(8,)) byte_getter = StorePath(MemoryStore(), "missing") result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=(2,), all_chunk_coords={(0,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result is None async def test_load_partial_shard_maybe_with_empty_chunks( monkeypatch: pytest.MonkeyPatch, ) -> None: """Chunks whose index entry is empty are silently skipped.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) # Index where chunk (1,) is empty; the others point into the stored blob. index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) index.set_chunk_slice((2,), slice(100, 200)) index.set_chunk_slice((3,), slice(200, 300)) async def mock_load_index( self: ShardingCodec, byte_getter: StorePath, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) byte_getter = await _store_path_with_blob("shard", b"x" * 300) result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,), (1,), (2,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result is not None assert (0,) in result assert (1,) not in result # empty in index assert (2,) in result async def test_load_partial_shard_maybe_all_chunks_empty( monkeypatch: pytest.MonkeyPatch, ) -> None: """Returns an empty dict when all requested chunks are empty (no I/O issued).""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) # Fully-empty index — `get_chunk_slice` returns None for every coord. index = _ShardIndex.create_empty(chunks_per_shard) async def mock_load_index( self: ShardingCodec, byte_getter: StorePath, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) # Empty store is fine — we never reach the chunk-read path when all are empty. byte_getter = StorePath(MemoryStore(), "shard") result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,), (1,), (2,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result == {} async def test_load_partial_shard_returns_chunk_contents( monkeypatch: pytest.MonkeyPatch, ) -> None: """Returns the correct bytes for each requested chunk.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) index.set_chunk_slice((1,), slice(100, 200)) async def mock_load_index( self: ShardingCodec, byte_getter: StorePath, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) blob = b"A" * 100 + b"B" * 100 byte_getter = await _store_path_with_blob("shard", blob) result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,), (1,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result is not None buf_0, buf_1 = result[(0,)], result[(1,)] assert buf_0 is not None assert buf_1 is not None assert buf_0.to_bytes() == b"A" * 100 assert buf_1.to_bytes() == b"B" * 100 async def test_load_partial_shard_shard_disappears_returns_none( monkeypatch: pytest.MonkeyPatch, ) -> None: """If the shard key is missing when chunk reads run, returns None. This models a race: the index loaded successfully, but the shard was deleted before the chunk-byte fetches landed. `Store.get_ranges` surfaces this as a `BaseExceptionGroup` containing `FileNotFoundError`, which the codec catches and converts to None to match the index-missing branch's behavior. """ codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) async def mock_load_index( self: ShardingCodec, byte_getter: StorePath, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) # Store has no value for "shard" — `get_ranges` will raise FileNotFoundError. byte_getter = StorePath(MemoryStore(), "shard") result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result is None async def test_load_partial_shard_non_fnf_error_propagates( monkeypatch: pytest.MonkeyPatch, ) -> None: """Non-FileNotFoundError errors from get_ranges are re-raised, not swallowed. Our `BaseExceptionGroup.split(FileNotFoundError)` keeps the "shard gone" behavior for FNF only; anything else (e.g. an OSError from the underlying fetch) must bubble up. """ codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) async def mock_load_index( self: ShardingCodec, byte_getter: StorePath, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) # Make the underlying store.get raise OSError. The default Store.get_ranges # impl routes through self.get; coalesced_get wraps the failure in a # BaseExceptionGroup, which our code re-raises (minus FNF leaves, of which # there are none here). async def boom(*args: object, **kwargs: object) -> Buffer | None: raise OSError("injected disk error") store = MemoryStore() monkeypatch.setattr(store, "get", boom) byte_getter = StorePath(store, "shard") with pytest.RaisesGroup(pytest.RaisesExc(OSError, match="injected disk error")): await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) async def test_load_partial_shard_nested_sharding_path( monkeypatch: pytest.MonkeyPatch, ) -> None: """Nested sharding: byte_getter is a `_ShardingByteGetter` over an in-memory dict.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) index.set_chunk_slice((1,), slice(100, 200)) async def mock_load_index( self: ShardingCodec, byte_getter: _ShardingByteGetter, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) # The "store" for an inner shard is a dict keyed by outer-chunk coords; the # byte_getter reads ranges out of one entry of that dict. blob = b"A" * 100 + b"B" * 100 shard_dict: dict[tuple[int, ...], Buffer | None] = {(0,): Buffer.from_bytes(blob)} byte_getter = _ShardingByteGetter(shard_dict, (0,)) result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,), (1,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result is not None buf_0, buf_1 = result[(0,)], result[(1,)] assert buf_0 is not None assert buf_1 is not None assert buf_0.to_bytes() == b"A" * 100 assert buf_1.to_bytes() == b"B" * 100 async def test_load_partial_shard_nested_sharding_missing_outer_chunk( monkeypatch: pytest.MonkeyPatch, ) -> None: """Nested sharding: outer chunk absent → `_ShardingByteGetter.get` returns None → chunks are silently skipped, yielding an empty shard_dict.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) async def mock_load_index( self: ShardingCodec, byte_getter: _ShardingByteGetter, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) # Empty outer dict — _ShardingByteGetter.get(...) returns None for any range. shard_dict: dict[tuple[int, ...], Buffer | None] = {} byte_getter = _ShardingByteGetter(shard_dict, (0,)) result = await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,)}, max_gap_bytes=1 << 20, max_coalesced_bytes=16 << 20, ) assert result == {} # ============================================================================ # Supporting class tests (_ShardReader, _is_total_shard) # ============================================================================ def test_shard_reader_create_empty() -> None: """Test _ShardReader.create_empty creates reader with empty index.""" chunks_per_shard = (2, 3) reader = _ShardReader.create_empty(chunks_per_shard) assert reader.index.is_all_empty() assert len(reader.buf) == 0 assert len(reader) == 2 * 3 def test_shard_reader_iteration() -> None: """Test _ShardReader iteration yields all chunk coordinates.""" chunks_per_shard = (2, 2) reader = _ShardReader.create_empty(chunks_per_shard) coords = list(reader) assert len(coords) == 4 assert (0, 0) in coords assert (0, 1) in coords assert (1, 0) in coords assert (1, 1) in coords def test_shard_reader_getitem_raises_for_empty() -> None: """Test _ShardReader.__getitem__ raises KeyError for empty chunks.""" chunks_per_shard = (2,) reader = _ShardReader.create_empty(chunks_per_shard) with pytest.raises(KeyError): _ = reader[(0,)] def test_is_total_shard_full() -> None: """Test _is_total_shard returns True when all chunk coords are present.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (2, 2) all_chunk_coords: set[tuple[int, ...]] = {(0, 0), (0, 1), (1, 0), (1, 1)} assert codec._is_total_shard(all_chunk_coords, chunks_per_shard) is True def test_is_total_shard_partial() -> None: """Test _is_total_shard returns False for partial chunk coords.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (2, 2) all_chunk_coords: set[tuple[int, ...]] = {(0, 0), (1, 1)} # Missing (0, 1) and (1, 0) assert codec._is_total_shard(all_chunk_coords, chunks_per_shard) is False def test_is_total_shard_empty() -> None: """Test _is_total_shard returns False for empty chunk coords.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (2, 2) all_chunk_coords: set[tuple[int, ...]] = set() assert codec._is_total_shard(all_chunk_coords, chunks_per_shard) is False def test_is_total_shard_1d() -> None: """Test _is_total_shard works with 1D shards.""" codec = ShardingCodec(chunk_shape=(8,)) chunks_per_shard = (4,) all_chunk_coords: set[tuple[int, ...]] = {(0,), (1,), (2,), (3,)} assert codec._is_total_shard(all_chunk_coords, chunks_per_shard) is True # Partial partial_coords: set[tuple[int, ...]] = {(0,), (2,)} assert codec._is_total_shard(partial_coords, chunks_per_shard) is False # ============================================================================ # _inner_codecs_fixed_size tests # ============================================================================ def test_inner_codecs_fixed_size_no_compression() -> None: """Inner codecs without compression should be fixed-size.""" codec = ShardingCodec(chunk_shape=(10,), codecs=[BytesCodec()]) assert codec._inner_codecs_fixed_size is True def test_inner_codecs_fixed_size_with_compression() -> None: """Inner codecs with compression should NOT be fixed-size.""" codec = ShardingCodec(chunk_shape=(10,), codecs=[BytesCodec(), GzipCodec()]) assert codec._inner_codecs_fixed_size is False # ============================================================================ # inner-chain spec threading # ============================================================================ @dataclass(frozen=True) class _WidenToInt16(ArrayArrayCodec): """Test-only sync-capable AA codec that reports its output dtype as int16.""" is_fixed_size = True def to_dict(self) -> dict[str, Any]: return {"name": "_widen_to_int16"} @classmethod def from_dict(cls, data: dict[str, Any]) -> _WidenToInt16: return cls() def resolve_metadata(self, chunk_spec: ArraySpec) -> ArraySpec: return replace(chunk_spec, dtype=get_data_type_from_native_dtype(np.dtype("int16"))) def compute_encoded_size(self, input_byte_length: int, _spec: ArraySpec) -> int: return input_byte_length def _encode_sync(self, chunk_array: Any, chunk_spec: ArraySpec) -> Any: return chunk_array # pragma: no cover def _decode_sync(self, chunk_array: Any, chunk_spec: ArraySpec) -> Any: return chunk_array # pragma: no cover async def _encode_single(self, chunk_array: Any, chunk_spec: ArraySpec) -> Any: return chunk_array # pragma: no cover async def _decode_single(self, chunk_array: Any, chunk_spec: ArraySpec) -> Any: return chunk_array # pragma: no cover def _int8_spec(shape: tuple[int, ...]) -> ArraySpec: zdtype = get_data_type_from_native_dtype(np.dtype("int8")) # single-byte source return ArraySpec( shape=shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=False), prototype=default_buffer_prototype(), ) def test_inner_chunk_transform_threads_spec() -> None: """The inner codec chain must be evolved with the spec threaded forward. A dtype-widening inner array->array codec means the BytesCodec serializer is evolved against the WIDENED dtype, not the single-byte source — otherwise it strips its `endian` to None and fails to decode multi-byte inner chunks. Same contract as the pipeline-level `evolve_codecs` regression test, applied to `_get_inner_chunk_transform`. """ codec = ShardingCodec(chunk_shape=(4,), codecs=[_WidenToInt16(), BytesCodec(endian="little")]) shard_spec = _int8_spec((8,)) transform = codec._get_inner_chunk_transform(shard_spec) serializer = transform._ab_codec assert isinstance(serializer, BytesCodec) assert serializer.endian is not None, ( "inner BytesCodec lost its `endian` — _get_inner_chunk_transform did not " "thread the dtype-widening codec's spec into the serializer" ) def test_evolve_from_array_spec_threads_spec() -> None: """`ShardingCodec.evolve_from_array_spec` must thread the spec through the inner chain, like `_get_inner_chunk_transform` does. This method runs EARLIER, on the real array-creation path (the outer pipeline evolves the sharding codec itself), so an unthreaded evolve here bakes an endian-stripped BytesCodec into the evolved instance's `codecs` before the transform builders ever run — and the later threaded evolve then raises instead of recovering. Calling `_get_inner_chunk_transform` on the EVOLVED instance pins the full real path. """ codec = ShardingCodec(chunk_shape=(4,), codecs=[_WidenToInt16(), BytesCodec(endian="little")]) # the array spec the OUTER pipeline evolves the sharding codec against array_spec = _int8_spec((8,)) evolved = codec.evolve_from_array_spec(array_spec) inner_serializer = next(c for c in evolved.codecs if isinstance(c, BytesCodec)) assert inner_serializer.endian is not None, ( "evolve_from_array_spec evolved the inner BytesCodec against the " "un-widened spec, stripping its `endian`" ) # and the evolved instance must still build a working inner transform transform = evolved._get_inner_chunk_transform(array_spec) serializer = transform._ab_codec assert isinstance(serializer, BytesCodec) assert serializer.endian is not None # ============================================================================ # async whole-shard codec methods # # `ShardingCodec` advertises partial decode/encode, so the codec pipeline # always routes sharded reads/writes through `_decode_partial_single` / # `_encode_partial_single`. The whole-shard async methods `_decode_single` / # `_encode_single` are reached only via the direct `ArrayBytesCodec` API (e.g. # a consumer that calls the codec outside a pipeline), so they get no coverage # from end-to-end array tests. Pin them with a direct round-trip. # ============================================================================ @pytest.mark.parametrize("write_empty_chunks", [True, False]) def test_decode_single_encode_single_roundtrip(write_empty_chunks: bool) -> None: """`ShardingCodec._encode_single` then `_decode_single` round-trips a whole shard. Covers the async whole-shard path the pipeline bypasses in favor of the partial methods.""" zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec = ArraySpec( shape=(50,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=write_empty_chunks), prototype=default_buffer_prototype(), ) codec = ShardingCodec(chunk_shape=(10,), codecs=[BytesCodec()]) data = np.arange(50, dtype="float64") value = CPUNDBuffer.from_numpy_array(data) encoded = asyncio.run(codec._encode_single(value, spec)) assert encoded is not None # data is non-empty -> a shard is always produced decoded = asyncio.run(codec._decode_single(encoded, spec)) np.testing.assert_array_equal(decoded.as_numpy_array(), data) def test_encode_single_all_empty_returns_none() -> None: """`_encode_single` of an all-fill shard under write_empty_chunks=False elides every inner chunk and returns None (the all-empty branch).""" zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec = ArraySpec( shape=(50,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=False), prototype=default_buffer_prototype(), ) codec = ShardingCodec(chunk_shape=(10,), codecs=[BytesCodec()]) fill = CPUNDBuffer.from_numpy_array(np.zeros(50, dtype="float64")) assert asyncio.run(codec._encode_single(fill, spec)) is None def test_decode_single_all_empty_fills() -> None: """`_decode_single` of a shard whose index is all-empty fills the output with the fill value (the is_all_empty fast path).""" zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec = ArraySpec( shape=(50,), dtype=zdtype, fill_value=zdtype.cast_scalar(-1.0), config=ArrayConfig(order="C", write_empty_chunks=False), prototype=default_buffer_prototype(), ) codec = ShardingCodec(chunk_shape=(10,), codecs=[BytesCodec()]) # an empty shard is just the encoded empty index empty_index = asyncio.run(codec._encode_shard_index(_ShardIndex.create_empty((5,)))) decoded = asyncio.run(codec._decode_single(empty_index, spec)) np.testing.assert_array_equal(decoded.as_numpy_array(), np.full(50, -1.0)) # ============================================================================ # async-only index codec fallback (#269) # # `_decode_shard_index` / `_encode_shard_index` delegate to their sync twins # when every index codec is sync-capable, and otherwise fall back to the async # pipeline. The default index chain (bytes + crc32c) is sync-capable, so the # fallback is exercised only by an async-only index codec. # ============================================================================ class _AsyncOnlyBytesCodec(ArrayBytesCodec): """An array<->bytes codec that implements ONLY the async per-chunk methods. Wraps a real `BytesCodec` for the actual conversion but deliberately omits `_encode_sync`/`_decode_sync`, so it is NOT a `SupportsSyncCodec`. Used as an index codec to force the async-pipeline fallback in `_decode_shard_index`/`_encode_shard_index`. """ _inner = BytesCodec() def to_dict(self) -> dict[str, Any]: return {"name": "_async_only_bytes"} @classmethod def from_dict(cls, data: dict[str, Any]) -> _AsyncOnlyBytesCodec: return cls() def evolve_from_array_spec(self, array_spec: ArraySpec) -> _AsyncOnlyBytesCodec: return self def compute_encoded_size(self, input_byte_length: int, _spec: ArraySpec) -> int: return input_byte_length async def _decode_single(self, chunk_bytes: ABCBuffer, chunk_spec: ArraySpec) -> NDBuffer: return await self._inner._decode_single(chunk_bytes, chunk_spec) async def _encode_single(self, chunk_array: NDBuffer, chunk_spec: ArraySpec) -> ABCBuffer: result = await self._inner._encode_single(chunk_array, chunk_spec) assert result is not None return result def test_shard_index_async_fallback_for_async_only_index_codec() -> None: """An async-only index codec is not sync-capable, so `_encode_shard_index` and `_decode_shard_index` must take the async-pipeline fallback (#269) instead of the sync twins — and still round-trip.""" from zarr.abc.codec import SupportsSyncCodec codec = ShardingCodec( chunk_shape=(10,), codecs=[BytesCodec()], index_codecs=[_AsyncOnlyBytesCodec(), Crc32cCodec()], ) assert not codec._index_codecs_sync_capable() assert not isinstance(_AsyncOnlyBytesCodec(), SupportsSyncCodec) chunks_per_shard = (5,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 42)) encoded = asyncio.run(codec._encode_shard_index(index)) decoded = asyncio.run(codec._decode_shard_index(encoded, chunks_per_shard)) np.testing.assert_array_equal(decoded.offsets_and_lengths, index.offsets_and_lengths) # ============================================================================ # Coalescing config option tests # # Assert that the `array.sharding_coalesce_max_gap_bytes` and # `array.sharding_coalesce_max_bytes` global config keys flow through # `ArrayConfig` to `Store.get_ranges` as `max_gap_bytes` / # `max_coalesced_bytes` kwargs, and that per-array `config={...}` overrides # the global default. # ============================================================================ def _trigger_partial_shard_read(array_config: ArrayConfigParams | None = None) -> AsyncMock: """Build a sharded array on a mocked `MemoryStore`, trigger a partial-shard read via the public read path, and return the `get_ranges` mock. """ import zarr chunk_shape = (2,) shard_shape = (8,) data = np.arange(8, dtype="int32") store = MemoryStore() store_mock = AsyncMock(wraps=store, spec=store.__class__) shards: ShardsConfigParam = { "shape": shard_shape, "index_location": "end", } a = zarr.create_array( StorePath(store_mock), shape=(8,), chunks=chunk_shape, shards=shards, dtype=data.dtype, fill_value=-1, config=array_config, ) a[:] = data store_mock.reset_mock() # Read a strict subset of chunks to take the partial-shard read path. _ = a[0:4] return cast(AsyncMock, store_mock.get_ranges) def test_load_partial_shard_forwards_global_config_to_get_ranges() -> None: """Global `array.sharding_coalesce_*` values flow into ArrayConfig at array-creation time and are forwarded to `Store.get_ranges`.""" with config.set( { "array.sharding_coalesce_max_gap_bytes": 4242, "array.sharding_coalesce_max_bytes": 424242, } ): get_ranges_mock = _trigger_partial_shard_read() assert get_ranges_mock.call_count >= 1 for call in get_ranges_mock.call_args_list: kwargs = call.kwargs assert kwargs["max_gap_bytes"] == 4242 assert kwargs["max_coalesced_bytes"] == 424242 def test_load_partial_shard_per_array_config_overrides_global() -> None: """Per-array `config={...}` passed to `create_array` takes precedence over the global config and is forwarded to `Store.get_ranges`.""" with config.set( { "array.sharding_coalesce_max_gap_bytes": 4242, "array.sharding_coalesce_max_bytes": 424242, } ): get_ranges_mock = _trigger_partial_shard_read( array_config={ "sharding_coalesce_max_gap_bytes": 99, "sharding_coalesce_max_bytes": 9999, }, ) assert get_ranges_mock.call_count >= 1 for call in get_ranges_mock.call_args_list: kwargs = call.kwargs assert kwargs["max_gap_bytes"] == 99 assert kwargs["max_coalesced_bytes"] == 9999 def test_load_partial_shard_uses_config_defaults() -> None: """Without explicit config, defaults from `zarr.config` are forwarded.""" get_ranges_mock = _trigger_partial_shard_read() assert get_ranges_mock.call_count >= 1 for call in get_ranges_mock.call_args_list: kwargs = call.kwargs assert kwargs["max_gap_bytes"] == config.get("array.sharding_coalesce_max_gap_bytes") assert kwargs["max_coalesced_bytes"] == config.get("array.sharding_coalesce_max_bytes") async def test_load_partial_shard_explicit_kwargs_passthrough( monkeypatch: pytest.MonkeyPatch, ) -> None: """`_load_partial_shard_maybe` forwards its explicit kwargs to `get_ranges`.""" codec = ShardingCodec(chunk_shape=(2,)) chunks_per_shard = (4,) index = _ShardIndex.create_empty(chunks_per_shard) index.set_chunk_slice((0,), slice(0, 100)) index.set_chunk_slice((2,), slice(200, 300)) store = MemoryStore() await store.set("shard", Buffer.from_bytes(b"x" * 300)) store_mock = AsyncMock(wraps=store, spec=store.__class__) byte_getter = StorePath(store_mock, "shard") async def mock_load_index( self: ShardingCodec, byte_getter: StorePath, cps: tuple[int, ...] ) -> _ShardIndex: return index monkeypatch.setattr(ShardingCodec, "_load_shard_index_maybe", mock_load_index) await codec._load_partial_shard_maybe( byte_getter=byte_getter, prototype=default_buffer_prototype(), chunks_per_shard=chunks_per_shard, all_chunk_coords={(0,), (2,)}, max_gap_bytes=12345, max_coalesced_bytes=67890, ) store_mock.get_ranges.assert_called_once() kwargs = store_mock.get_ranges.call_args.kwargs assert kwargs["max_gap_bytes"] == 12345 assert kwargs["max_coalesced_bytes"] == 67890 # ============================================================================ # Bulk full-shard decode: identity-read gating and dtype gating # ============================================================================ _FUSED_PIPELINE = "zarr.core.codec_pipeline.FusedCodecPipeline" def _fused_uncompressed_array( index_location: Literal["start", "end"], ) -> tuple[Any, npt.NDArray[np.int32]]: """Sharded `(8, 8)` array whose inner chain is a bare BytesCodec (no crc), one shard covering the whole array, filled with `arange` data. Callers must be inside a config context selecting the fused pipeline.""" shards: ShardsConfigParam = {"shape": (8, 8), "index_location": index_location} arr = zarr.create_array( store=MemoryStore(), shape=(8, 8), chunks=(2, 2), shards=shards, dtype="int32", compressors=None, filters=None, fill_value=0, config={"write_empty_chunks": True}, ) ref = np.arange(64, dtype="int32").reshape(8, 8) arr[:] = ref return arr, ref def _spy_on_bulk_decode(monkeypatch: pytest.MonkeyPatch) -> list[bool]: """Record, per call, whether `_decode_full_shard_bulk_if_uncompressed` engaged (returned non-None).""" engaged: list[bool] = [] orig = ShardingCodec._decode_full_shard_bulk_if_uncompressed def spy(self: ShardingCodec, shard_bytes: Any, shard_spec: Any, indexer: Any) -> Any: result = orig(self, shard_bytes, shard_spec, indexer) engaged.append(result is not None) return result monkeypatch.setattr(ShardingCodec, "_decode_full_shard_bulk_if_uncompressed", spy) return engaged _PERM_8 = np.array([7, 2, 5, 0, 3, 6, 1, 4]) _DUP_8 = np.array([0, 0, 1, 2, 3, 4, 5, 6]) @pytest.mark.parametrize("index_location", ["start", "end"]) @pytest.mark.parametrize( ("read", "expected", "expect_bulk"), [ pytest.param(lambda a: a[:], lambda r: r, True, id="full-slice"), pytest.param(lambda a: a[...], lambda r: r, True, id="ellipsis"), pytest.param( lambda a: a[_PERM_8, :], lambda r: r[_PERM_8, :], False, id="fancy-permutation" ), pytest.param(lambda a: a[_DUP_8, :], lambda r: r[_DUP_8, :], False, id="fancy-duplicates"), pytest.param( lambda a: a.oindex[_PERM_8, :], lambda r: r[_PERM_8, :], False, id="oindex-permutation", ), pytest.param( lambda a: a.oindex[_DUP_8, :], lambda r: r[_DUP_8, :], False, id="oindex-duplicates" ), pytest.param(lambda a: a[1:7, :], lambda r: r[1:7, :], False, id="subset-slice"), ], ) def test_bulk_decode_engagement_and_correctness( monkeypatch: pytest.MonkeyPatch, index_location: Literal["start", "end"], read: Any, expected: Any, expect_bulk: bool, ) -> None: """Under the fused pipeline on an uncompressed crc-free shard, the bulk whole-shard decode fires exactly for identity full reads — and every read returns what numpy returns. The engagement assertions keep the correctness half non-vacuous: a gate that simply disabled the fast path would pass the value checks but fail here.""" engaged = _spy_on_bulk_decode(monkeypatch) with config.set({"codec_pipeline.path": _FUSED_PIPELINE}): arr, ref = _fused_uncompressed_array(index_location) engaged.clear() np.testing.assert_array_equal(read(arr), expected(ref)) if expect_bulk: assert len(engaged) > 0, "bulk fast path was never reached for a full read" assert all(engaged), "bulk fast path did not engage for a full read" else: assert not any(engaged), "bulk fast path engaged for a non-identity selection" @pytest.mark.parametrize("index_location", ["start", "end"]) def test_multi_shard_permutation_read(index_location: Literal["start", "end"]) -> None: """A row permutation crossing shard boundaries must return permuted data under the fused pipeline (each shard sees a gather selection whose shape coincides with the shard shape).""" shards: ShardsConfigParam = {"shape": (8, 8), "index_location": index_location} with config.set({"codec_pipeline.path": _FUSED_PIPELINE}): arr = zarr.create_array( store=MemoryStore(), shape=(16, 16), chunks=(2, 2), shards=shards, dtype="int32", compressors=None, filters=None, fill_value=0, config={"write_empty_chunks": True}, ) ref = np.arange(256, dtype="int32").reshape(16, 16) arr[:] = ref perm = np.array([9, 3, 12, 0, 15, 6, 10, 1, 14, 5, 8, 2, 13, 7, 11, 4]) np.testing.assert_array_equal(arr[perm, :8], ref[perm, :8]) np.testing.assert_array_equal(arr.oindex[perm, :8], ref[perm, :8]) def _dense_shard_blob( codec: ShardingCodec, data: np.ndarray[Any, np.dtype[Any]], chunk_len: int ) -> Buffer: """Hand-assemble a dense `index_location="end"` shard blob for 1-D `data`: natural-order chunk payloads followed by the encoded index.""" n_chunks = data.shape[0] // chunk_len chunk_nbytes = chunk_len * data.dtype.itemsize index = _ShardIndex.create_empty((n_chunks,)) for i in range(n_chunks): index.set_chunk_slice((i,), slice(i * chunk_nbytes, (i + 1) * chunk_nbytes)) index_bytes = codec._encode_shard_index_sync(index) return Buffer.from_bytes(data.tobytes() + index_bytes.to_bytes()) def _identity_indexer(shape: tuple[int, ...], chunk_shape: tuple[int, ...]) -> BasicIndexer: return BasicIndexer( tuple(slice(0, s) for s in shape), shape=shape, chunk_grid=ChunkGrid.from_sizes(shape, chunk_shape), ) def _spec_for(data: np.ndarray[Any, np.dtype[Any]]) -> ArraySpec: zdt = get_data_type_from_native_dtype(data.dtype) return ArraySpec( shape=data.shape, dtype=zdt, fill_value=zdt.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) def test_bulk_decode_declines_structured_dtype() -> None: """The bulk path has no structured-dtype byte-order handling (the `Struct` branch of `BytesCodec._decode_sync`), so it must decline structured specs. The plain-dtype control on an identically constructed blob proves the decline comes from the dtype gate, not from a malformed blob.""" codec = ShardingCodec(chunk_shape=(2,), codecs=[BytesCodec(endian="little")]) # control: same construction with a plain dtype engages the bulk path plain = np.arange(4, dtype=" None: """`is_dense` accepts every layout whose fixed-size payloads exactly tile the data section, wherever that section starts and in whatever order the chunks were laid out.""" chunk_len = 24 n = int(np.prod(chunks_per_shard)) slots = np.arange(n) if layout_order == "reversed": slots = slots[::-1] offsets = data_section_start + slots * chunk_len index = _ShardIndex.create_empty(chunks_per_shard) for coord, off in zip(np.ndindex(chunks_per_shard), offsets, strict=True): index.set_chunk_slice(tuple(coord), slice(int(off), int(off) + chunk_len)) assert index.is_dense(chunk_len, data_section_start=data_section_start) is True def test_shard_index_is_dense_rejects_overlapping_offsets() -> None: """Unique but overlapping offsets (second payload starts inside the first) are not dense.""" chunk_len = 24 index = _ShardIndex.create_empty((2,)) index.set_chunk_slice((0,), slice(0, chunk_len)) index.set_chunk_slice((1,), slice(12, 12 + chunk_len)) assert index.is_dense(chunk_len, data_section_start=0) is False def test_shard_index_is_dense_rejects_out_of_range_offsets() -> None: """An offset outside the data section (here: chunk 0 pointing into an `index_location="start"` index region) is not dense, even though offsets are unique and non-overlapping.""" chunk_len = 24 data_section_start = 16 index = _ShardIndex.create_empty((2,)) index.set_chunk_slice((0,), slice(0, chunk_len)) index.set_chunk_slice( (1,), slice(data_section_start + chunk_len, data_section_start + 2 * chunk_len) ) assert index.is_dense(chunk_len, data_section_start=data_section_start) is False zarr-python-3.3.0/tests/test_codecs/test_transpose.py000066400000000000000000000106611523267620000231110ustar00rootroot00000000000000import numpy as np import pytest import zarr from zarr import AsyncArray, config from zarr.abc.codec import SupportsSyncCodec from zarr.abc.store import Store from zarr.codecs import TransposeCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import NDBuffer, default_buffer_prototype from zarr.core.common import MemoryOrder from zarr.core.dtype import get_data_type_from_native_dtype from zarr.storage import StorePath from .test_codecs import _AsyncArrayProxy @pytest.mark.parametrize("input_order", ["F", "C"]) @pytest.mark.parametrize("runtime_write_order", ["F", "C"]) @pytest.mark.parametrize("runtime_read_order", ["F", "C"]) @pytest.mark.parametrize("with_sharding", [True, False]) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) async def test_transpose( store: Store, input_order: MemoryOrder, runtime_write_order: MemoryOrder, runtime_read_order: MemoryOrder, with_sharding: bool, ) -> None: data = np.arange(0, 256, dtype="uint16").reshape((1, 32, 8), order=input_order) spath = StorePath(store, path="transpose") with config.set({"array.order": runtime_write_order}): a = await zarr.api.asynchronous.create_array( spath, shape=data.shape, chunks=(1, 16, 8) if with_sharding else (1, 32, 8), shards=(1, 32, 8) if with_sharding else None, dtype=data.dtype, fill_value=0, chunk_key_encoding={"name": "v2", "separator": "."}, filters=[TransposeCodec(order=(2, 1, 0))], ) await _AsyncArrayProxy(a)[:, :].set(data) read_data = await _AsyncArrayProxy(a)[:, :].get() assert np.array_equal(data, read_data) with config.set({"array.order": runtime_read_order}): a = await AsyncArray.open( spath, ) read_data = await _AsyncArrayProxy(a)[:, :].get() assert np.array_equal(data, read_data) assert isinstance(read_data, np.ndarray) if runtime_read_order == "F": assert read_data.flags["F_CONTIGUOUS"] assert not read_data.flags["C_CONTIGUOUS"] else: assert not read_data.flags["F_CONTIGUOUS"] assert read_data.flags["C_CONTIGUOUS"] @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("order", [[1, 2, 0], [1, 2, 3, 0], [3, 2, 4, 0, 1]]) def test_transpose_non_self_inverse(store: Store, order: list[int]) -> None: shape = [i + 3 for i in range(len(order))] data = np.arange(0, np.prod(shape), dtype="uint16").reshape(shape) spath = StorePath(store, "transpose_non_self_inverse") a = zarr.create_array( spath, shape=data.shape, chunks=data.shape, dtype=data.dtype, fill_value=0, filters=[TransposeCodec(order=order)], ) a[:, :] = data read_data = a[:, :] assert np.array_equal(data, read_data) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_transpose_invalid( store: Store, ) -> None: data = np.arange(0, 256, dtype="uint16").reshape((1, 32, 8)) spath = StorePath(store, "transpose_invalid") for order in [(1, 0), (3, 2, 1), (3, 3, 1), "F", "C"]: with pytest.raises((ValueError, TypeError)): zarr.create_array( spath, shape=data.shape, chunks=(1, 32, 8), dtype=data.dtype, fill_value=0, chunk_key_encoding={"name": "v2", "separator": "."}, filters=[TransposeCodec(order=order)], # type: ignore[arg-type] ) def test_transpose_codec_supports_sync() -> None: assert isinstance(TransposeCodec(order=(0, 1)), SupportsSyncCodec) def test_transpose_codec_sync_roundtrip() -> None: codec = TransposeCodec(order=(1, 0)) arr = np.arange(12, dtype="float64").reshape(3, 4) zdtype = get_data_type_from_native_dtype(arr.dtype) spec = ArraySpec( shape=arr.shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) nd_buf: NDBuffer = default_buffer_prototype().nd_buffer.from_numpy_array(arr) encoded = codec._encode_sync(nd_buf, spec) assert encoded is not None resolved_spec = codec.resolve_metadata(spec) decoded = codec._decode_sync(encoded, resolved_spec) np.testing.assert_array_equal(arr, decoded.as_numpy_array()) zarr-python-3.3.0/tests/test_codecs/test_vlen.py000066400000000000000000000076351523267620000220460ustar00rootroot00000000000000from typing import Any import numpy as np import pytest import zarr from zarr import Array from zarr.abc.codec import Codec, SupportsSyncCodec from zarr.abc.store import Store from zarr.codecs import ZstdCodec from zarr.codecs.vlen_utf8 import VLenBytesCodec, VLenUTF8Codec from zarr.core.dtype import get_data_type_from_native_dtype from zarr.core.metadata.v3 import ArrayV3Metadata from zarr.storage import StorePath # The explicit id for the "str" literal avoids colliding with the auto-generated id for # the `str` builtin. numpy_str_dtypes: list[Any] = [ None, str, pytest.param("str", id="str-literal"), np.dtypes.StrDType, "S", "U", np.dtypes.StringDType, ] expected_array_string_dtype: np.dtype[Any] = np.dtypes.StringDType() @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("store", ["memory", "local"], indirect=["store"]) @pytest.mark.parametrize("dtype", numpy_str_dtypes) @pytest.mark.parametrize("as_object_array", [False, True]) @pytest.mark.parametrize("compressor", [None, ZstdCodec()]) def test_vlen_string( store: Store, dtype: np.dtype[Any] | None, as_object_array: bool, compressor: Codec | None ) -> None: strings = ["hello", "world", "this", "is", "a", "test"] data = np.array(strings, dtype=dtype).reshape((2, 3)) sp = StorePath(store, path="string") a = zarr.create_array( sp, shape=data.shape, chunks=data.shape, dtype=data.dtype, fill_value="", compressors=compressor, # type: ignore[arg-type] ) assert isinstance(a.metadata, ArrayV3Metadata) # needed for mypy # should also work if input array is an object array, provided we explicitly specified # a stringlike dtype when creating the Array if as_object_array: data_obj = data.astype("O") a[:, :] = data_obj else: a[:, :] = data assert np.array_equal(data, a[:, :]) assert a.metadata.data_type == get_data_type_from_native_dtype(data.dtype) assert a.dtype == data.dtype # test round trip b = Array.open(sp) assert isinstance(b.metadata, ArrayV3Metadata) # needed for mypy assert np.array_equal(data, b[:, :]) assert b.metadata.data_type == get_data_type_from_native_dtype(data.dtype) assert a.dtype == data.dtype @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) @pytest.mark.parametrize( ("dtype", "fill_value", "elements"), [ pytest.param("string", "", [f"S{i:05}" for i in range(9)], id="string"), pytest.param("variable_length_bytes", b"", [b"%05d" % i for i in range(9)], id="bytes"), ], ) def test_vlen_f_contiguous( store: Store, dtype: str, fill_value: str | bytes, elements: list[str] | list[bytes] ) -> None: """An F-contiguous chunk written through a vlen codec round-trips in the original element order rather than the transposed memory order (gh-3558).""" # reshape(order="F") gives an F-contiguous view directly, so the whole-array write # below hands an F-contiguous chunk to the codec; assert it to guard the precondition. data = np.array(elements, dtype=object).reshape((3, 3), order="F") assert data.flags.f_contiguous sp = StorePath(store, path="vlen-f-contiguous") # chunks == shape so the write is a single complete chunk, which the codec pipeline # forwards to the codec untouched; a partial-chunk layout would be recopied to C order. a = zarr.create_array( sp, shape=data.shape, chunks=data.shape, dtype=dtype, fill_value=fill_value ) a[:, :] = data assert np.array_equal(data, np.asarray(a[:, :], dtype=object)) def test_vlen_utf8_codec_supports_sync() -> None: assert isinstance(VLenUTF8Codec(), SupportsSyncCodec) def test_vlen_bytes_codec_supports_sync() -> None: assert isinstance(VLenBytesCodec(), SupportsSyncCodec) zarr-python-3.3.0/tests/test_codecs/test_zstd.py000066400000000000000000000032711523267620000220560ustar00rootroot00000000000000import numpy as np import pytest import zarr from zarr.abc.codec import SupportsSyncCodec from zarr.abc.store import Store from zarr.codecs import ZstdCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import get_data_type_from_native_dtype from zarr.storage import StorePath @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("checksum", [True, False]) def test_zstd(store: Store, checksum: bool) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16)) a = zarr.create_array( StorePath(store, path="zstd"), shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, compressors=ZstdCodec(level=0, checksum=checksum), ) a[:, :] = data assert np.array_equal(data, a[:, :]) def test_zstd_codec_supports_sync() -> None: assert isinstance(ZstdCodec(), SupportsSyncCodec) def test_zstd_codec_sync_roundtrip() -> None: codec = ZstdCodec(level=1) arr = np.arange(100, dtype="float64") zdtype = get_data_type_from_native_dtype(arr.dtype) spec = ArraySpec( shape=arr.shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) buf = default_buffer_prototype().buffer.from_array_like(arr.view("B")) encoded = codec._encode_sync(buf, spec) assert encoded is not None decoded = codec._decode_sync(encoded, spec) result = np.frombuffer(decoded.as_numpy_array(), dtype="float64") np.testing.assert_array_equal(arr, result) zarr-python-3.3.0/tests/test_common.py000066400000000000000000000126611523267620000200660ustar00rootroot00000000000000from __future__ import annotations import asyncio from collections.abc import Iterable from typing import TYPE_CHECKING, get_args import numpy as np import pytest from zarr.core.common import ( ANY_ACCESS_MODE, AccessModeLiteral, concurrent_iter, parse_int, parse_name, parse_shapelike, product, ) from zarr.core.config import parse_indexing_order if TYPE_CHECKING: from typing import Any, Literal @pytest.mark.parametrize("data", [(0, 0, 0, 0), (1, 3, 4, 5, 6), (2, 4)]) def test_product(data: tuple[int, ...]) -> None: assert product(data) == np.prod(data) def test_access_modes() -> None: """ Test that the access modes type and variable for run-time checking are equivalent. """ assert set(ANY_ACCESS_MODE) == set(get_args(AccessModeLiteral)) async def test_concurrent_iter_schedules_eagerly() -> None: """`concurrent_iter` must return already-scheduled tasks, not a lazy generator. Its docstring promises `func(*item)` is launched concurrently for every item up front; a caller that awaits the returned tasks one at a time (rather than via `gather`/`as_completed`, which force iteration) relies on that eager scheduling to get any overlap at all. """ started = [False, False, False] async def mark(i: int) -> int: started[i] = True return i tasks = concurrent_iter([(0,), (1,), (2,)], mark) # Give the event loop one chance to run before awaiting anything # individually. If `concurrent_iter` were lazy, nothing would have been # scheduled yet and `started` would still be all-False here. await asyncio.sleep(0) assert started == [True, True, True] results = [await t for t in tasks] assert results == [0, 1, 2] # todo: test def test_concurrent_map() -> None: ... # todo: test def test_to_thread() -> None: ... # todo: test def test_enum_names() -> None: ... # todo: test def test_parse_enum() -> None: ... @pytest.mark.parametrize("data", [("foo", "bar"), (10, 11)]) def test_parse_name_invalid(data: tuple[Any, Any]) -> None: observed, expected = data if isinstance(observed, str): with pytest.raises(ValueError, match=f"Expected '{expected}'. Got {observed} instead."): parse_name(observed, expected) else: with pytest.raises( TypeError, match=f"Expected a string, got an instance of {type(observed)}." ): parse_name(observed, expected) @pytest.mark.parametrize("data", [("foo", "foo"), ("10", "10")]) def test_parse_name_valid(data: tuple[Any, Any]) -> None: observed, expected = data assert parse_name(observed, expected) == observed @pytest.mark.parametrize("data", [0, 1, "hello", "f"]) def test_parse_indexing_order_invalid(data: Any) -> None: with pytest.raises(ValueError, match="Expected one of"): parse_indexing_order(data) @pytest.mark.parametrize("data", ["1", 1.0, True, False, None, [1], (1,)]) def test_parse_int_invalid(data: Any) -> None: """Non-int values (including bools, which are int subclasses) are rejected.""" with pytest.raises(ValueError, match="Expected int"): parse_int(data) @pytest.mark.parametrize("data", [0, 1, -1, 2**63]) def test_parse_int_valid(data: int) -> None: assert parse_int(data) == data @pytest.mark.parametrize("data", ["C", "F"]) def parse_indexing_order_valid(data: Literal["C", "F"]) -> None: assert parse_indexing_order(data) == data @pytest.mark.parametrize("data", [lambda v: v, slice(None)]) def test_parse_shapelike_invalid_single_type(data: Any) -> None: """ Test that we get the expected error message when passing in a value that is not an integer or an iterable of integers. """ with pytest.raises(TypeError, match="Expected an integer or an iterable of integers."): parse_shapelike(data) def test_parse_shapelike_invalid_single_value() -> None: """ Test that we get the expected error message when passing in a negative integer. """ with pytest.raises(ValueError, match="Expected a non-negative integer."): parse_shapelike(-1) @pytest.mark.parametrize("data", ["shape", ("0", 1, 2, 3), {"0": "0"}, ((1, 2), (2, 2)), (4.0, 2)]) def test_parse_shapelike_invalid_iterable_types(data: Any) -> None: """ Test that we get the expected error message when passing in an iterable containing non-integer elements """ with pytest.raises(TypeError, match="Expected an iterable of integers"): parse_shapelike(data) @pytest.mark.parametrize("data", [(1, 2, 3, -1), (-10,)]) def test_parse_shapelike_invalid_iterable_values(data: Any) -> None: """ Test that we get the expected error message when passing in an iterable containing negative integers """ with pytest.raises(ValueError, match="Expected all values to be non-negative."): parse_shapelike(data) @pytest.mark.parametrize( "data", [range(10), [0, 1, 2, np.uint64(3)], (3, 4, 5), (), 1, np.uint8(1)] ) def test_parse_shapelike_valid(data: Iterable[int] | int) -> None: if isinstance(data, Iterable): expected = tuple(data) else: expected = (data,) assert parse_shapelike(data) == expected # todo: more dtypes @pytest.mark.parametrize("data", [("uint8", np.uint8), ("float64", np.float64)]) def parse_dtype(data: tuple[str, np.dtype[Any]]) -> None: unparsed, parsed = data assert parse_dtype(unparsed) == parsed # todo: figure out what it means to test this def test_parse_fill_value() -> None: ... zarr-python-3.3.0/tests/test_config.py000066400000000000000000000424131523267620000200410ustar00rootroot00000000000000import inspect import os from collections.abc import Iterable from typing import Any from unittest import mock from unittest.mock import Mock import numpy as np import pytest import zarr from zarr import zeros from zarr.abc.codec import CodecPipeline from zarr.abc.store import ByteSetter, Store from zarr.codecs import ( BloscCodec, BytesCodec, Crc32cCodec, ShardingCodec, ) from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import NDBuffer from zarr.core.buffer.core import Buffer from zarr.core.codec_pipeline import BatchedCodecPipeline from zarr.core.config import BadConfigError, config from zarr.core.indexing import SelectorTuple from zarr.errors import ChunkNotFoundError, ZarrUserWarning from zarr.registry import ( fully_qualified_name, get_buffer_class, get_codec_class, get_ndbuffer_class, get_pipeline_class, register_buffer, register_codec, register_ndbuffer, register_pipeline, ) from zarr.testing.buffer import ( NDBufferUsingTestNDArrayLike, StoreExpectingTestBuffer, TestBuffer, TestNDArrayLike, ) def test_config_defaults_set() -> None: # regression test for available defaults assert ( config.defaults == [ { "default_zarr_format": 3, "array": { "order": "C", "write_empty_chunks": False, "read_missing_chunks": True, "target_shard_size_bytes": None, "rectilinear_chunks": False, "sharding_coalesce_max_gap_bytes": 1 << 20, "sharding_coalesce_max_bytes": 16 << 20, }, "async": {"concurrency": 10, "timeout": None}, "threading": {"max_workers": None}, "json_indent": 2, "codec_pipeline": { "path": "zarr.core.codec_pipeline.BatchedCodecPipeline", "batch_size": 1, "max_workers": None, }, "codecs": { "blosc": "zarr.codecs.blosc.BloscCodec", "gzip": "zarr.codecs.gzip.GzipCodec", "zstd": "zarr.codecs.zstd.ZstdCodec", "bytes": "zarr.codecs.bytes.BytesCodec", "endian": "zarr.codecs.bytes.BytesCodec", # compatibility with earlier versions of ZEP1 "crc32c": "zarr.codecs.crc32c_.Crc32cCodec", "sharding_indexed": "zarr.codecs.sharding.ShardingCodec", "transpose": "zarr.codecs.transpose.TransposeCodec", "vlen-utf8": "zarr.codecs.vlen_utf8.VLenUTF8Codec", "vlen-bytes": "zarr.codecs.vlen_utf8.VLenBytesCodec", "numcodecs.bz2": "zarr.codecs.numcodecs.BZ2", "numcodecs.crc32": "zarr.codecs.numcodecs.CRC32", "numcodecs.crc32c": "zarr.codecs.numcodecs.CRC32C", "numcodecs.lz4": "zarr.codecs.numcodecs.LZ4", "numcodecs.lzma": "zarr.codecs.numcodecs.LZMA", "numcodecs.zfpy": "zarr.codecs.numcodecs.ZFPY", "numcodecs.adler32": "zarr.codecs.numcodecs.Adler32", "numcodecs.astype": "zarr.codecs.numcodecs.AsType", "numcodecs.bitround": "zarr.codecs.numcodecs.BitRound", "numcodecs.blosc": "zarr.codecs.numcodecs.Blosc", "numcodecs.delta": "zarr.codecs.numcodecs.Delta", "numcodecs.fixedscaleoffset": "zarr.codecs.numcodecs.FixedScaleOffset", "numcodecs.fletcher32": "zarr.codecs.numcodecs.Fletcher32", "numcodecs.gzip": "zarr.codecs.numcodecs.GZip", "numcodecs.jenkins_lookup3": "zarr.codecs.numcodecs.JenkinsLookup3", "numcodecs.pcodec": "zarr.codecs.numcodecs.PCodec", "numcodecs.packbits": "zarr.codecs.numcodecs.PackBits", "numcodecs.shuffle": "zarr.codecs.numcodecs.Shuffle", "numcodecs.quantize": "zarr.codecs.numcodecs.Quantize", "numcodecs.zlib": "zarr.codecs.numcodecs.Zlib", "numcodecs.zstd": "zarr.codecs.numcodecs.Zstd", }, "buffer": "zarr.buffer.cpu.Buffer", "ndbuffer": "zarr.buffer.cpu.NDBuffer", } ] ) assert config.get("array.order") == "C" assert config.get("async.concurrency") == 10 assert config.get("async.timeout") is None assert config.get("codec_pipeline.batch_size") == 1 assert config.get("json_indent") == 2 def test_array_config_init_defaults_match_global_config() -> None: """Each `ArrayConfig.__init__` parameter that has a default must match the value of `array.` in the global config. Catches drift between the two sources of truth.""" params = inspect.signature(ArrayConfig.__init__).parameters has_defaults = { name: p.default for name, p in params.items() if name != "self" and p.default is not inspect.Parameter.empty } assert has_defaults, "expected at least one default to check" for name, default in has_defaults.items(): assert default == config.get(f"array.{name}"), ( f"ArrayConfig.__init__ default for {name!r} ({default!r}) does not " f"match global config value for 'array.{name}' " f"({config.get(f'array.{name}')!r})" ) @pytest.mark.parametrize( ("key", "old_val", "new_val"), [("array.order", "C", "F"), ("async.concurrency", 10, 128), ("json_indent", 2, 0)], ) def test_config_defaults_can_be_overridden(key: str, old_val: Any, new_val: Any) -> None: assert config.get(key) == old_val with config.set({key: new_val}): assert config.get(key) == new_val def test_fully_qualified_name() -> None: class MockClass: pass assert ( fully_qualified_name(MockClass) == "tests.test_config.test_fully_qualified_name..MockClass" ) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_config_codec_pipeline_class(store: Store) -> None: # has default value assert get_pipeline_class().__name__ != "" config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.BatchedCodecPipeline"}) assert get_pipeline_class() == zarr.core.codec_pipeline.BatchedCodecPipeline _mock = Mock() class MockCodecPipeline(BatchedCodecPipeline): async def write( self, batch_info: Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]], value: NDBuffer, drop_axes: tuple[int, ...] = (), ) -> None: _mock.call() register_pipeline(MockCodecPipeline) config.set({"codec_pipeline.path": fully_qualified_name(MockCodecPipeline)}) assert get_pipeline_class() == MockCodecPipeline # test if codec is used arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), zarr_format=3, dtype="i4", ) arr[:] = range(100) _mock.call.assert_called() config.set({"codec_pipeline.path": "wrong_name"}) with pytest.raises(BadConfigError): get_pipeline_class() class MockEnvCodecPipeline(CodecPipeline): pass register_pipeline(MockEnvCodecPipeline) # type: ignore[type-abstract] with mock.patch.dict( os.environ, {"ZARR_CODEC_PIPELINE__PATH": fully_qualified_name(MockEnvCodecPipeline)} ): assert get_pipeline_class(reload_config=True) == MockEnvCodecPipeline @pytest.mark.filterwarnings("error") @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_config_codec_implementation(store: Store) -> None: # has default value assert fully_qualified_name(get_codec_class("blosc")) == config.defaults[0]["codecs"]["blosc"] _mock = Mock() class MockBloscCodec(BloscCodec): # Record a call from whichever encode entry point the active codec # pipeline uses: the async `_encode_single` (BatchedCodecPipeline, the # default) or the synchronous `_encode_sync` (FusedCodecPipeline). # Overriding both keeps this test ("the configured codec is actually # used") independent of which pipeline is the default. async def _encode_single(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> Buffer | None: _mock.call() return None def _encode_sync(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> Buffer | None: _mock.call() return None register_codec("blosc", MockBloscCodec) with config.set({"codecs.blosc": fully_qualified_name(MockBloscCodec)}): assert get_codec_class("blosc") == MockBloscCodec # test if codec is used arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), zarr_format=3, dtype="i4", compressors=[{"name": "blosc", "configuration": {}}], ) arr[:] = range(100) _mock.call.assert_called() # test set codec with environment variable class NewBloscCodec(BloscCodec): pass register_codec("blosc", NewBloscCodec) with mock.patch.dict(os.environ, {"ZARR_CODECS__BLOSC": fully_qualified_name(NewBloscCodec)}): assert get_codec_class("blosc", reload_config=True) == NewBloscCodec @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_config_ndbuffer_implementation(store: Store) -> None: # set custom ndbuffer with TestNDArrayLike implementation register_ndbuffer(NDBufferUsingTestNDArrayLike) with config.set({"ndbuffer": fully_qualified_name(NDBufferUsingTestNDArrayLike)}): assert get_ndbuffer_class() == NDBufferUsingTestNDArrayLike arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), zarr_format=3, dtype="i4", ) got = arr[:] assert isinstance(got, TestNDArrayLike) def test_config_buffer_implementation() -> None: # has default value assert config.defaults[0]["buffer"] == "zarr.buffer.cpu.Buffer" arr = zeros(shape=(100,), store=StoreExpectingTestBuffer()) # AssertionError of StoreExpectingTestBuffer when not using my buffer with pytest.raises(AssertionError): arr[:] = np.arange(100) register_buffer(TestBuffer) with config.set({"buffer": fully_qualified_name(TestBuffer)}): assert get_buffer_class() == TestBuffer # no error using TestBuffer data = np.arange(100) arr[:] = np.arange(100) assert np.array_equal(arr[:], data) data2d = np.arange(1000).reshape(100, 10) arr_sharding = zeros( shape=(100, 10), store=StoreExpectingTestBuffer(), codecs=[ShardingCodec(chunk_shape=(10, 10))], ) arr_sharding[:] = data2d assert np.array_equal(arr_sharding[:], data2d) arr_Crc32c = zeros( shape=(100, 10), store=StoreExpectingTestBuffer(), codecs=[BytesCodec(), Crc32cCodec()], ) arr_Crc32c[:] = data2d assert np.array_equal(arr_Crc32c[:], data2d) def test_config_buffer_backwards_compatibility() -> None: # This should warn once zarr.core is private # https://github.com/zarr-developers/zarr-python/issues/2621 with zarr.config.set( {"buffer": "zarr.core.buffer.cpu.Buffer", "ndbuffer": "zarr.core.buffer.cpu.NDBuffer"} ): get_buffer_class() get_ndbuffer_class() @pytest.mark.gpu def test_config_buffer_backwards_compatibility_gpu() -> None: # This should warn once zarr.core is private # https://github.com/zarr-developers/zarr-python/issues/2621 with zarr.config.set( {"buffer": "zarr.core.buffer.gpu.Buffer", "ndbuffer": "zarr.core.buffer.gpu.NDBuffer"} ): get_buffer_class() get_ndbuffer_class() @pytest.mark.filterwarnings("error") def test_warning_on_missing_codec_config() -> None: class NewCodec(BytesCodec): pass class NewCodec2(BytesCodec): pass # error if codec is not registered with pytest.raises(KeyError): get_codec_class("missing_codec") # no warning if only one implementation is available register_codec("new_codec", NewCodec) get_codec_class("new_codec") # warning because multiple implementations are available but none is selected in the config register_codec("new_codec", NewCodec2) with pytest.warns( ZarrUserWarning, match="not configured in config. Selecting any implementation" ): get_codec_class("new_codec") # no warning if multiple implementations are available and one is selected in the config with config.set({"codecs.new_codec": fully_qualified_name(NewCodec)}): get_codec_class("new_codec") @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize( "kwargs", [ {"shards": (4, 4)}, {"compressors": None}, ], ids=["partial_decode", "full_decode"], ) def test_config_read_missing_chunks(store: Store, kwargs: dict[str, Any]) -> None: arr = zarr.create_array( store=store, shape=(4, 4), chunks=(2, 2), dtype="int32", fill_value=42, **kwargs, ) # default behavior: missing chunks are filled with the fill value result = zarr.open_array(store)[:] assert np.array_equal(result, np.full((4, 4), 42, dtype="int32")) # with read_missing_chunks=False, reading missing chunks raises an error with config.set({"array.read_missing_chunks": False}): with pytest.raises(ChunkNotFoundError): zarr.open_array(store)[:] # after writing data, all chunks exist and no error is raised arr[:] = np.arange(16, dtype="int32").reshape(4, 4) with config.set({"array.read_missing_chunks": False}): result = zarr.open_array(store)[:] assert np.array_equal(result, np.arange(16, dtype="int32").reshape(4, 4)) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_config_read_missing_chunks_sharded_inner(store: Store) -> None: """Because the shard index and inner chunks should be stored together in a single storage object (read: a file or blob), we delegate to the shard index the responsibility of determining what chunks should be present. Thus, `read_missing_chunks` raises an error only if the entire *shard* is missing. Missing inner chunks are filled with the array's fill value and do not raise an error, even if `read_missing_chunks=False` at the array level. """ arr = zarr.create_array( store=store, shape=(8, 4), chunks=(2, 2), shards=(4, 4), dtype="int32", fill_value=42, ) # write only one inner chunk in the first shard, leaving the second shard empty arr[0:2, 0:2] = np.ones((2, 2), dtype="int32") with config.set({"array.read_missing_chunks": False}): a = zarr.open_array(store) # first shard exists: missing inner chunks are filled, no error result = a[:4] expected = np.full((4, 4), 42, dtype="int32") expected[0:2, 0:2] = 1 assert np.array_equal(result, expected) # second shard is entirely missing: raises an error with pytest.raises(ChunkNotFoundError): a[4:] @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_config_read_missing_chunks_write_empty_chunks(store: Store) -> None: """write_empty_chunks=False drops chunks equal to fill_value, which then appear missing to read_missing_chunks=False.""" arr = zarr.create_array( store=store, shape=(4,), chunks=(2,), dtype="int32", fill_value=0, config={"write_empty_chunks": False, "read_missing_chunks": False}, ) # write non-fill-value data: chunks are stored arr[:] = [1, 2, 3, 4] assert np.array_equal(arr[:], [1, 2, 3, 4]) # overwrite with fill_value: chunks are dropped by write_empty_chunks=False arr[:] = 0 with pytest.raises(ChunkNotFoundError): arr[:] # with write_empty_chunks=True, chunks are kept and no error is raised with config.set({"array.write_empty_chunks": True}): arr = zarr.open_array(store) arr[:] = 0 assert np.array_equal(arr[:], [0, 0, 0, 0]) @pytest.mark.parametrize( "key", [ "array.v2_default_compressor.numeric", "array.v2_default_compressor.string", "array.v2_default_compressor.bytes", "array.v2_default_filters.string", "array.v2_default_filters.bytes", "array.v3_default_filters.numeric", "array.v3_default_filters.raw", "array.v3_default_filters.bytes", "array.v3_default_serializer.numeric", "array.v3_default_serializer.string", "array.v3_default_serializer.bytes", "array.v3_default_compressors.string", "array.v3_default_compressors.bytes", "array.v3_default_compressors", ], ) def test_deprecated_config(key: str) -> None: """ Test that a valuerror is raised when setting the default chunk encoding for a given data type category """ with pytest.raises(ValueError): with zarr.config.set({key: "foo"}): pass zarr-python-3.3.0/tests/test_docs.py000066400000000000000000000267001523267620000175250ustar00rootroot00000000000000""" Tests for executable code blocks in markdown documentation. This module uses pytest-examples to validate Python code examples in the docs. A block is validated if it renders output at build (exec="true") or is explicitly marked for testing (test="true"). The two flags are separate on purpose: exec= drives markdown-exec's build-time rendering, while test= lets a block be validated without being run at build (e.g. gpu/s3 examples the build environment cannot run). The test_no_unvalidated_blocks guard ensures every python block declares one of those, or an explicit exec="false" opt-out with a reason, so a block can never silently skip validation. """ from __future__ import annotations from collections import defaultdict from pathlib import Path from typing import TYPE_CHECKING, Any import pytest pytest.importorskip("pytest_examples") from pytest_examples import CodeExample, EvalExample, find_examples if TYPE_CHECKING: from collections.abc import Generator DOCS_ROOT = Path(__file__).parent.parent / "docs" SOURCES_ROOT = Path(__file__).parent.parent / "src" / "zarr" def name_example(path: str, session: str) -> str: """Generate a readable name for a test case from file path and session.""" file = Path(path) try: file = file.relative_to(DOCS_ROOT) except ValueError: # Path is outside DOCS_ROOT (e.g. a tmp_path fixture in unit tests); use the # bare file name rather than an absolute path for a stable, readable id. file = Path(file.name) return f"{file}:{session}" def _marker_names(settings: dict[str, str]) -> list[str]: """Parse a block's markers="a b" attribute into a list of marker names.""" return [name for name in settings.get("markers", "").split() if name] def _is_tested(settings: dict[str, str]) -> bool: """A block is validated by our pytest harness if it is run at build to render output (exec="true") OR explicitly marked for testing (test="true"). The two flags are separate on purpose: exec= drives markdown-exec's build-time rendering, while test= lets a block be validated without being run at build (e.g. gpu/s3 blocks, which the build environment cannot run).""" return settings.get("exec") == "true" or settings.get("test") == "true" def _session_params(root: Path) -> list[Any]: """Group tested examples (exec="true" or test="true") by (file, session) and emit one pytest.param per session, carrying the union of markers declared by that session's blocks.""" sessions: defaultdict[tuple[str, str], list[CodeExample]] = defaultdict(list) marks_by_session: defaultdict[tuple[str, str], set[str]] = defaultdict(set) for example in find_examples(str(root)): settings = example.prefix_settings() if not _is_tested(settings): continue session_name = settings.get("session", "_default") key = (str(example.path), session_name) sessions[key].append(example) marks_by_session[key].update(_marker_names(settings)) params = [] for key in sorted(sessions.keys(), key=lambda x: (x[0], x[1])): marks = tuple(getattr(pytest.mark, name) for name in sorted(marks_by_session[key])) params.append(pytest.param(key, marks=marks, id=name_example(key[0], key[1]))) return params S3_BUCKET = "example-bucket" @pytest.fixture def docs_s3_backend( moto_server: str, monkeypatch: pytest.MonkeyPatch ) -> Generator[None, None, None]: """Point docs S3 examples at the shared moto server (tests/conftest.py) via a process-wide AWS_ENDPOINT_URL, so a block can use a bare s3:// URL with no storage_options (see spike in the design notes). The server lifecycle belongs to the session-scoped `moto_server` fixture; this fixture only adds the docs-specific endpoint env var and a fresh bucket, and restores both on teardown.""" s3fs = pytest.importorskip("s3fs") botocore = pytest.importorskip("botocore") requests = pytest.importorskip("requests") monkeypatch.setenv("AWS_ENDPOINT_URL", moto_server) session = botocore.session.Session() client = session.create_client("s3", endpoint_url=moto_server, region_name="us-east-1") client.create_bucket(Bucket=S3_BUCKET) client.close() s3fs.S3FileSystem.clear_instance_cache() try: yield finally: # Reset moto state; AWS_ENDPOINT_URL is restored automatically by monkeypatch. # The shared server keeps running (the moto_server fixture stops it at session end). requests.post(f"{moto_server}moto-api/reset") def test_markers_attribute_is_parsed(tmp_path: Path) -> None: """A test="true" block tagged markers="s3" must surface that marker on its parametrized case, so pytest can gate/bind it (e.g. attach the moto fixture). Uses test="true" (not exec="true") because marker-bound blocks are validated by the harness without being run at build time.""" md = tmp_path / "ex.md" md.write_text( '```python test="true" session="demo" markers="s3"\nimport zarr\n```\n', encoding="utf-8", ) params = _session_params(md.parent) assert len(params) == 1 marks = params[0].marks assert any(m.name == "s3" for m in marks) def test_no_unvalidated_blocks() -> None: """Every python code block in docs/ must declare its validation state: exec="true" (run at build to render output), test="true" (validated by this harness without being run at build), or exec="false" with a reason (explicit, documented opt-out). A bare or mistyped fence (e.g. exec="on") fails here, so a block can never silently opt out of validation -- the gap that hid the invalid create_array(mode="w") example in #4016. A separate placement constraint is enforced by test_test_only_blocks_come_last.""" offenders: list[str] = [] for example in find_examples(str(DOCS_ROOT)): rel = Path(example.path).relative_to(DOCS_ROOT) settings = example.prefix_settings() exec_val = settings.get("exec") loc = f"{rel}:{example.start_line}" # Validated either by build-render (exec="true") or by the test harness # (test="true"). if _is_tested(settings): continue # Explicit, documented opt-out from execution. if exec_val == "false" and settings.get("reason", "").strip(): continue offenders.append( f"{loc} (exec={exec_val!r}, test={settings.get('test')!r}, " f"reason={settings.get('reason')!r})" ) assert not offenders, ( 'Docs python blocks must be exec="true", test="true", or exec="false" with a ' "reason:\n" + "\n".join(offenders) ) def test_test_only_blocks_come_last() -> None: """A conservative placement convention: a test="true"-only block must come after every exec="true" block in the same file. Mechanism (established by experiment + markdown-exec's SuperFences integration): a python fence that markdown-exec does not execute -- i.e. one lacking exec="true", whether test="true" or exec="false" -- placed before an exec="true" block disrupts markdown-exec's build-time execution of a *later, state-dependent* block. Observed: a non-exec python fence inserted before the quickstart ZipStore write/read pair made the read block fail with FileNotFoundError (the write never took effect), aborting `mkdocs build --strict`. The effect needs a cross-block dependency to surface, so it does not affect the standalone exec="true" blocks in e.g. data_types.md/performance.md that already have exec="false" opt-out blocks above them. Because we cannot statically tell which later blocks are state-dependent, this guard enforces the simple, safe convention only for the blocks we author this way (test="true" marker-bound examples like s3/gpu). It is NOT a complete build-hazard check -- the authoritative check is `mkdocs build --strict` (the docs:check CI job), which catches the exec="false" case too. This guard just turns the common test-only case into a fast, local failure.""" # Collect, per published-docs file, the start lines of test-only and exec blocks. test_only: defaultdict[str, list[int]] = defaultdict(list) exec_lines: defaultdict[str, list[int]] = defaultdict(list) for example in find_examples(str(DOCS_ROOT)): settings = example.prefix_settings() path = str(example.path) if settings.get("exec") == "true": exec_lines[path].append(example.start_line) elif settings.get("test") == "true": test_only[path].append(example.start_line) offenders: list[str] = [] for path, only_lines in test_only.items(): rel = Path(path).relative_to(DOCS_ROOT) last_exec = max(exec_lines.get(path, [0])) offenders.extend( f'{rel}:{line} (test="true" block precedes an exec="true" block at line {last_exec})' for line in only_lines if line < last_exec ) assert not offenders, ( 'A test="true"-only block must come after every exec="true" block in the same ' 'file: a non-executed python fence before an exec="true" block can disrupt ' "markdown-exec's build-time execution of a later state-dependent block (see this " "test's docstring):\n" + "\n".join(offenders) ) # Get all example sessions @pytest.mark.parametrize("session_key", _session_params(DOCS_ROOT)) def test_documentation_examples( session_key: tuple[str, str], eval_example: EvalExample, request: pytest.FixtureRequest, ) -> None: """ Test that all validated code examples (exec="true" or test="true") in documentation execute successfully. This test groups examples by session (file + session name) and runs them sequentially in the same execution context, allowing code to build on previous examples. This test uses pytest-examples to: - Find all code examples marked exec="true" or test="true" in markdown files - Group them by session - Execute them in order within the same context - Verify no exceptions are raised """ if request.node.get_closest_marker("gpu") is not None: pytest.importorskip("cupy") if request.node.get_closest_marker("s3") is not None: request.getfixturevalue("docs_s3_backend") file_path, session_name = session_key # Get examples for this session all_examples = list(find_examples(DOCS_ROOT)) examples = [] for example in all_examples: settings = example.prefix_settings() if not _is_tested(settings): continue if str(example.path) == file_path and settings.get("session", "_default") == session_name: examples.append(example) # Run all examples in this session sequentially, preserving state module_globals: dict[str, object] = {} for example in examples: # TODO: uncomment this line when we are ready to fix output checks # result = eval_example.run_print_check(example, module_globals=module_globals) result = eval_example.run(example, module_globals=module_globals) # Update globals with the results from this execution module_globals.update(result) @pytest.mark.parametrize("example", list(find_examples(str(SOURCES_ROOT))), ids=str) def test_docstrings(example: CodeExample, eval_example: EvalExample) -> None: """Test our docstring examples.""" if example.path.name == "config.py" and "your.module" in example.source: pytest.skip("Skip testing docstring example that assumes nonexistent module.") eval_example.run_print_check(example) zarr-python-3.3.0/tests/test_dtype/000077500000000000000000000000001523267620000173435ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_dtype/__init__.py000066400000000000000000000000001523267620000214420ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_dtype/conftest.py000066400000000000000000000063761523267620000215560ustar00rootroot00000000000000# Generate a collection of zdtype instances for use in testing. import warnings from collections import Counter from typing import Any import numpy as np from zarr.core.dtype import data_type_registry from zarr.core.dtype.common import HasLength from zarr.core.dtype.npy.structured import Struct from zarr.core.dtype.npy.time import DateTime64, TimeDelta64 from zarr.core.dtype.wrapper import ZDType zdtype_examples: tuple[ZDType[Any, Any], ...] = () for wrapper_cls in data_type_registry.contents.values(): if wrapper_cls is Struct: with warnings.catch_warnings(): warnings.simplefilter("ignore") zdtype_examples += ( wrapper_cls.from_native_dtype(np.dtype([("a", np.float64), ("b", np.int8)])), ) elif issubclass(wrapper_cls, HasLength): zdtype_examples += (wrapper_cls(length=1),) elif issubclass(wrapper_cls, DateTime64 | TimeDelta64): zdtype_examples += (wrapper_cls(unit="s", scale_factor=10),) else: zdtype_examples += (wrapper_cls(),) def pytest_generate_tests(metafunc: Any) -> None: """ This is a pytest hook to parametrize class-scoped fixtures. This hook allows us to define class-scoped fixtures as class attributes and then generate the parametrize calls for pytest. This allows the fixtures to be reused across multiple tests within the same class. For example, if you had a regular pytest class like this: class TestClass: @pytest.mark.parametrize("param_a", [1, 2, 3]) def test_method(self, param_a): ... Child classes inheriting from ``TestClass`` would not be able to override the ``param_a`` fixture this implementation of ``pytest_generate_tests`` allows you to define class-scoped fixtures as class attributes, which allows the following to work: class TestExample: param_a = [1, 2, 3] def test_example(self, param_a): ... # this class will have its test_example method parametrized with the values of TestB.param_a class TestB(TestExample): param_a = [1, 2, 100, 10] """ # Iterate over all the fixtures defined in the class # and parametrize them with the values defined in the class # This allows us to define class-scoped fixtures as class attributes # and then generate the parametrize calls for pytest for fixture_name in metafunc.fixturenames: if hasattr(metafunc.cls, fixture_name): params = getattr(metafunc.cls, fixture_name) metafunc.parametrize( fixture_name, params, scope="class", ids=_unique_ids([str(p) for p in params]) ) def _unique_ids(ids: list[str]) -> list[str]: """Suffix repeated ids with their positional index so every id is unique. Distinct parameters can stringify identically: for example `np.dtype("i")` and `np.dtype(" 1 else id_ for idx, id_ in enumerate(ids)] zarr-python-3.3.0/tests/test_dtype/test_npy/000077500000000000000000000000001523267620000212105ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_dtype/test_npy/test_bool.py000066400000000000000000000020501523267620000235510ustar00rootroot00000000000000from __future__ import annotations import numpy as np from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype.npy.bool import Bool class TestBool(BaseTestZDType): test_cls = Bool valid_dtype = (np.dtype(np.bool_),) invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype(np.uint16), ) valid_json_v2 = ({"name": "|b1", "object_codec_id": None},) valid_json_v3 = ("bool",) invalid_json_v2 = ( "|b1", "bool", "|f8", ) invalid_json_v3 = ( "|b1", "|f8", {"name": "bool", "configuration": {"endianness": "little"}}, ) scalar_v2_params = ((Bool(), True), (Bool(), False)) scalar_v3_params = ((Bool(), True), (Bool(), False)) cast_value_params = ( (Bool(), "true", np.True_), (Bool(), True, np.True_), (Bool(), False, np.False_), (Bool(), np.True_, np.True_), (Bool(), np.False_, np.False_), ) invalid_scalar_params = (None,) item_size_params = (Bool(),) zarr-python-3.3.0/tests/test_dtype/test_npy/test_bytes.py000066400000000000000000000126131523267620000237520ustar00rootroot00000000000000import numpy as np import pytest from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype.npy.bytes import NullTerminatedBytes, RawBytes, VariableLengthBytes from zarr.errors import UnstableSpecificationWarning class TestNullTerminatedBytes(BaseTestZDType): test_cls = NullTerminatedBytes valid_dtype = (np.dtype("|S10"), np.dtype("|S4")) invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype("|U10"), ) valid_json_v2 = ( {"name": "|S1", "object_codec_id": None}, {"name": "|S2", "object_codec_id": None}, {"name": "|S4", "object_codec_id": None}, ) valid_json_v3 = ({"name": "null_terminated_bytes", "configuration": {"length_bytes": 10}},) invalid_json_v2 = ( "|S", "|U10", "|f8", {"name": "|S4", "object_codec_id": "vlen-bytes"}, ) invalid_json_v3 = ( {"name": "fixed_length_ascii", "configuration": {"length_bits": 0}}, {"name": "numpy.fixed_length_ascii", "configuration": {"length_bits": "invalid"}}, ) scalar_v2_params = ( (NullTerminatedBytes(length=1), "MA=="), (NullTerminatedBytes(length=2), "YWI="), (NullTerminatedBytes(length=4), "YWJjZA=="), ) scalar_v3_params = ( (NullTerminatedBytes(length=1), "MA=="), (NullTerminatedBytes(length=2), "YWI="), (NullTerminatedBytes(length=4), "YWJjZA=="), ) cast_value_params = ( (NullTerminatedBytes(length=1), "", np.bytes_("")), (NullTerminatedBytes(length=2), "ab", np.bytes_("ab")), (NullTerminatedBytes(length=4), "abcdefg", np.bytes_("abcd")), ) invalid_scalar_params = ((NullTerminatedBytes(length=1), 1.0),) item_size_params = ( NullTerminatedBytes(length=1), NullTerminatedBytes(length=4), NullTerminatedBytes(length=10), ) class TestRawBytes(BaseTestZDType): test_cls = RawBytes valid_dtype = (np.dtype("|V10"),) invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype("|S10"), ) valid_json_v2 = ({"name": "|V10", "object_codec_id": None},) valid_json_v3 = ( {"name": "raw_bytes", "configuration": {"length_bytes": 1}}, {"name": "raw_bytes", "configuration": {"length_bytes": 8}}, ) invalid_json_v2 = ( "|V", "|S10", "|f8", ) invalid_json_v3 = ( {"name": "r10"}, {"name": "r-80"}, ) scalar_v2_params = ( (RawBytes(length=1), "AA=="), (RawBytes(length=2), "YWI="), (RawBytes(length=4), "YWJjZA=="), ) scalar_v3_params = ( (RawBytes(length=1), "AA=="), (RawBytes(length=2), "YWI="), (RawBytes(length=4), "YWJjZA=="), ) cast_value_params = ( (RawBytes(length=1), b"\x00", np.void(b"\x00")), (RawBytes(length=2), b"ab", np.void(b"ab")), (RawBytes(length=4), b"abcd", np.void(b"abcd")), ) invalid_scalar_params = ((RawBytes(length=1), 1.0),) item_size_params = ( RawBytes(length=1), RawBytes(length=4), RawBytes(length=10), ) class TestVariableLengthBytes(BaseTestZDType): test_cls = VariableLengthBytes valid_dtype = (np.dtype("|O"),) invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype("|U10"), ) valid_json_v2 = ({"name": "|O", "object_codec_id": "vlen-bytes"},) valid_json_v3 = ("variable_length_bytes",) invalid_json_v2 = ( "|S", "|U10", "|f8", ) invalid_json_v3 = ( {"name": "fixed_length_ascii", "configuration": {"length_bits": 0}}, {"name": "numpy.fixed_length_ascii", "configuration": {"length_bits": "invalid"}}, ) scalar_v2_params = ( (VariableLengthBytes(), ""), (VariableLengthBytes(), "YWI="), (VariableLengthBytes(), "YWJjZA=="), ) scalar_v3_params = ( (VariableLengthBytes(), ""), (VariableLengthBytes(), "YWI="), (VariableLengthBytes(), "YWJjZA=="), ) cast_value_params = ( (VariableLengthBytes(), "", b""), (VariableLengthBytes(), "ab", b"ab"), (VariableLengthBytes(), "abcdefg", b"abcdefg"), ) invalid_scalar_params = ((VariableLengthBytes(), 1.0),) item_size_params = (VariableLengthBytes(),) def test_vlen_bytes_alias() -> None: """Test that "bytes" is an accepted alias for "variable_length_bytes" in JSON metadata""" a = VariableLengthBytes.from_json("bytes", zarr_format=3) b = VariableLengthBytes.from_json("variable_length_bytes", zarr_format=3) assert a == b @pytest.mark.parametrize( "zdtype", [NullTerminatedBytes(length=10), RawBytes(length=10), VariableLengthBytes()] ) def test_unstable_dtype_warning( zdtype: NullTerminatedBytes | RawBytes | VariableLengthBytes, ) -> None: """ Test that we get a warning when serializing a dtype without a zarr v3 spec to json when zarr_format is 3 """ with pytest.warns(UnstableSpecificationWarning): zdtype.to_json(zarr_format=3) @pytest.mark.parametrize("zdtype_cls", [NullTerminatedBytes, RawBytes]) def test_invalid_size(zdtype_cls: type[NullTerminatedBytes] | type[RawBytes]) -> None: """ Test that it's impossible to create a data type that has no length """ length = 0 msg = f"length must be >= 1, got {length}." with pytest.raises(ValueError, match=msg): zdtype_cls(length=length) zarr-python-3.3.0/tests/test_dtype/test_npy/test_common.py000066400000000000000000000304421523267620000241140ustar00rootroot00000000000000from __future__ import annotations import base64 import re import sys from typing import TYPE_CHECKING, Any, get_args import numpy as np import pytest from tests.conftest import nan_equal from zarr.core.dtype.common import ENDIANNESS_STR, JSONFloatV2, SpecialFloatStrings from zarr.core.dtype.npy.common import ( NumpyEndiannessStr, bytes_from_json, bytes_to_json, check_json_bool, check_json_complex_float_v2, check_json_complex_float_v3, check_json_float_v2, check_json_float_v3, check_json_int, check_json_intish_float, check_json_str, complex_float_to_json_v2, complex_float_to_json_v3, endianness_from_numpy_str, endianness_to_numpy_str, float_from_json_v2, float_from_json_v3, float_to_json_v2, float_to_json_v3, ) if TYPE_CHECKING: from zarr.core.common import JSON, ZarrFormat # Each special value is tested as both a Python float and a numpy scalar. The explicit # ids are load-bearing: np.float64("inf") stringifies identically to float("inf"), so # without them these parameter sets would produce duplicate test ids. json_float_v2_roundtrip_cases: tuple[Any, ...] = ( pytest.param("Infinity", float("inf"), id="Infinity-float"), pytest.param("Infinity", np.float64("inf"), id="Infinity-float64"), pytest.param("-Infinity", float("-inf"), id="-Infinity-float"), pytest.param("-Infinity", np.float64("-inf"), id="-Infinity-float64"), pytest.param("NaN", float("nan"), id="NaN-float"), pytest.param("NaN", np.float64("nan"), id="NaN-float64"), pytest.param(1.0, 1.0, id="1.0-1.0"), ) json_float_v3_cases = json_float_v2_roundtrip_cases @pytest.mark.parametrize( ("data", "expected"), [(">", "big"), ("<", "little"), ("=", sys.byteorder), ("|", None), ("err", "")], ) def test_endianness_from_numpy_str(data: str, expected: str | None) -> None: """ Test that endianness_from_numpy_str correctly converts a numpy str literal to a human-readable literal value. This test also checks that an invalid string input raises a ``ValueError`` """ if data in get_args(NumpyEndiannessStr): assert endianness_from_numpy_str(data) == expected # type: ignore[arg-type] else: msg = f"Invalid endianness: {data!r}. Expected one of {get_args(NumpyEndiannessStr)}" with pytest.raises(ValueError, match=re.escape(msg)): endianness_from_numpy_str(data) # type: ignore[arg-type] @pytest.mark.parametrize( ("data", "expected"), [("big", ">"), ("little", "<"), (None, "|"), ("err", "")], ) def test_endianness_to_numpy_str(data: str | None, expected: str) -> None: """ Test that endianness_to_numpy_str correctly converts a human-readable literal value to a numpy str literal. This test also checks that an invalid string input raises a ``ValueError`` """ if data in ENDIANNESS_STR: assert endianness_to_numpy_str(data) == expected # type: ignore[arg-type] else: msg = f"Invalid endianness: {data!r}. Expected one of {ENDIANNESS_STR}" with pytest.raises(ValueError, match=re.escape(msg)): endianness_to_numpy_str(data) # type: ignore[arg-type] @pytest.mark.parametrize( ("data", "expected"), json_float_v2_roundtrip_cases + (("SHOULD_ERR", ""),) ) def test_float_from_json_v2(data: JSONFloatV2 | str, expected: float | str) -> None: """ Test that float_from_json_v2 correctly converts a JSON string representation of a float to a float. This test also checks that an invalid string input raises a ``ValueError`` """ if data != "SHOULD_ERR": assert nan_equal(float_from_json_v2(data), expected) # type: ignore[arg-type] else: msg = f"could not convert string to float: {data!r}" with pytest.raises(ValueError, match=msg): float_from_json_v2(data) # type: ignore[arg-type] @pytest.mark.parametrize( ("data", "expected"), json_float_v3_cases + (("SHOULD_ERR", ""), ("0x", "")) ) def test_float_from_json_v3(data: JSONFloatV2 | str, expected: float | str) -> None: """ Test that float_from_json_v3 correctly converts a JSON string representation of a float to a float. This test also checks that an invalid string input raises a ``ValueError`` """ if data == "SHOULD_ERR": msg = ( f"Invalid float value: {data!r}. Expected a string starting with the hex prefix" " '0x', or one of 'NaN', 'Infinity', or '-Infinity'." ) with pytest.raises(ValueError, match=msg): float_from_json_v3(data) elif data == "0x": msg = ( f"Invalid hexadecimal float value: {data!r}. " "Expected the '0x' prefix to be followed by 4, 8, or 16 numeral characters" ) with pytest.raises(ValueError, match=msg): float_from_json_v3(data) else: assert nan_equal(float_from_json_v3(data), expected) # note the order of parameters relative to the order of the parametrized variable. @pytest.mark.parametrize(("expected", "data"), json_float_v2_roundtrip_cases) def test_float_to_json_v2(data: float | np.floating[Any], expected: JSONFloatV2) -> None: """ Test that floats are JSON-encoded properly for zarr v2 """ observed = float_to_json_v2(data) assert observed == expected # note the order of parameters relative to the order of the parametrized variable. @pytest.mark.parametrize(("expected", "data"), json_float_v3_cases) def test_float_to_json_v3(data: float | np.floating[Any], expected: JSONFloatV2) -> None: """ Test that floats are JSON-encoded properly for zarr v3 """ observed = float_to_json_v3(data) assert observed == expected def test_bytes_from_json(zarr_format: ZarrFormat) -> None: """ Test that a string is interpreted as base64-encoded bytes using the ascii alphabet. This test takes zarr_format as a parameter but doesn't actually do anything with it, because at present there is no zarr-format-specific logic in the code being tested, but such logic may exist in the future. """ data = "\00" assert bytes_from_json(data, zarr_format=zarr_format) == base64.b64decode(data.encode("ascii")) def test_bytes_to_json(zarr_format: ZarrFormat) -> None: """ Test that bytes are encoded with base64 using the ascii alphabet. This test takes zarr_format as a parameter but doesn't actually do anything with it, because at present there is no zarr-format-specific logic in the code being tested, but such logic may exist in the future. """ data = b"asdas" assert bytes_to_json(data, zarr_format=zarr_format) == base64.b64encode(data).decode("ascii") # note the order of parameters relative to the order of the parametrized variable. @pytest.mark.parametrize(("json_expected", "float_data"), json_float_v2_roundtrip_cases) def test_complex_to_json_v2( float_data: float | np.floating[Any], json_expected: JSONFloatV2 ) -> None: """ Test that complex numbers are correctly converted to JSON in v2 format. This use the same test input as the float tests, but the conversion is tested for complex numbers with real and imaginary parts equal to the float values provided in the test cases. """ cplx = complex(float_data, float_data) cplx_npy = np.complex128(cplx) assert complex_float_to_json_v2(cplx) == (json_expected, json_expected) assert complex_float_to_json_v2(cplx_npy) == (json_expected, json_expected) # note the order of parameters relative to the order of the parametrized variable. @pytest.mark.parametrize(("json_expected", "float_data"), json_float_v3_cases) def test_complex_to_json_v3( float_data: float | np.floating[Any], json_expected: JSONFloatV2 ) -> None: """ Test that complex numbers are correctly converted to JSON in v3 format. This use the same test input as the float tests, but the conversion is tested for complex numbers with real and imaginary parts equal to the float values provided in the test cases. """ cplx = complex(float_data, float_data) cplx_npy = np.complex128(cplx) assert complex_float_to_json_v3(cplx) == (json_expected, json_expected) assert complex_float_to_json_v3(cplx_npy) == (json_expected, json_expected) @pytest.mark.parametrize(("json_expected", "float_data"), json_float_v3_cases) def test_complex_float_to_json( float_data: float | np.floating[Any], json_expected: JSONFloatV2, zarr_format: ZarrFormat ) -> None: """ Test that complex numbers are correctly converted to JSON in v2 or v3 formats, depending on the ``zarr_format`` keyword argument. This use the same test input as the float tests, but the conversion is tested for complex numbers with real and imaginary parts equal to the float values provided in the test cases. """ cplx = complex(float_data, float_data) cplx_npy = np.complex128(cplx) if zarr_format == 2: assert complex_float_to_json_v2(cplx) == (json_expected, json_expected) assert complex_float_to_json_v2(cplx_npy) == ( json_expected, json_expected, ) elif zarr_format == 3: assert complex_float_to_json_v3(cplx) == (json_expected, json_expected) assert complex_float_to_json_v3(cplx_npy) == ( json_expected, json_expected, ) else: raise ValueError("zarr_format must be 2 or 3") # pragma: no cover check_json_float_cases = get_args(SpecialFloatStrings) + (1.0, 2) @pytest.mark.parametrize("data", check_json_float_cases) def test_check_json_float_v2_valid(data: JSONFloatV2 | int) -> None: assert check_json_float_v2(data) def test_check_json_float_v2_invalid() -> None: assert not check_json_float_v2("invalid") @pytest.mark.parametrize("data", check_json_float_cases) def test_check_json_float_v3_valid(data: JSONFloatV2 | int) -> None: assert check_json_float_v3(data) def test_check_json_float_v3_invalid() -> None: assert not check_json_float_v3("invalid") check_json_complex_float_true_cases: tuple[list[JSONFloatV2], ...] = ( [0.0, 1.0], [0.0, 1.0], [-1.0, "NaN"], ["Infinity", 1.0], ["Infinity", "NaN"], ) check_json_complex_float_false_cases: tuple[object, ...] = ( 0.0, "foo", [0.0], [1.0, 2.0, 3.0], [1.0, "_infinity_"], {"hello": 1.0}, ) @pytest.mark.parametrize("data", check_json_complex_float_true_cases) def test_check_json_complex_float_v2_true(data: JSON) -> None: assert check_json_complex_float_v2(data) @pytest.mark.parametrize("data", check_json_complex_float_false_cases) def test_check_json_complex_float_v2_false(data: JSON) -> None: assert not check_json_complex_float_v2(data) @pytest.mark.parametrize("data", check_json_complex_float_true_cases) def test_check_json_complex_float_v3_true(data: JSON) -> None: assert check_json_complex_float_v3(data) @pytest.mark.parametrize("data", check_json_complex_float_false_cases) def test_check_json_complex_float_v3_false(data: JSON) -> None: assert not check_json_complex_float_v3(data) @pytest.mark.parametrize("data", check_json_complex_float_true_cases) def test_check_json_complex_float_true(data: JSON, zarr_format: ZarrFormat) -> None: if zarr_format == 2: assert check_json_complex_float_v2(data) elif zarr_format == 3: assert check_json_complex_float_v3(data) else: raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover @pytest.mark.parametrize("data", check_json_complex_float_false_cases) def test_check_json_complex_float_false(data: JSON, zarr_format: ZarrFormat) -> None: if zarr_format == 2: assert not check_json_complex_float_v2(data) elif zarr_format == 3: assert not check_json_complex_float_v3(data) else: raise ValueError(f"zarr_format must be 2 or 3, got {zarr_format}") # pragma: no cover def test_check_json_int() -> None: assert check_json_int(0) assert not check_json_int(1.0) def test_check_json_intish_float() -> None: assert check_json_intish_float(0.0) assert check_json_intish_float(1.0) assert not check_json_intish_float("0") assert not check_json_intish_float(1.1) def test_check_json_str() -> None: assert check_json_str("0") assert not check_json_str(1.0) def test_check_json_bool() -> None: assert check_json_bool(True) assert check_json_bool(False) assert not check_json_bool(1.0) assert not check_json_bool("True") zarr-python-3.3.0/tests/test_dtype/test_npy/test_complex.py000066400000000000000000000057411523267620000242770ustar00rootroot00000000000000from __future__ import annotations import math import numpy as np from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype.npy.complex import Complex64, Complex128 class _BaseTestFloat(BaseTestZDType): def scalar_equals(self, scalar1: object, scalar2: object) -> bool: if np.isnan(scalar1) and np.isnan(scalar2): # type: ignore[call-overload] return True return super().scalar_equals(scalar1, scalar2) class TestComplex64(_BaseTestFloat): test_cls = Complex64 valid_dtype = (np.dtype(">c8"), np.dtype("c8", "object_codec_id": None}, {"name": "c16"), np.dtype("c16", "object_codec_id": None}, {"name": " bool: if np.isnan(scalar1) and np.isnan(scalar2): # type: ignore[call-overload] return True return super().scalar_equals(scalar1, scalar2) hex_string_params: tuple[tuple[str, float], ...] = () def test_hex_encoding(self, hex_string_params: tuple[str, float]) -> None: """ Test that hexadecimal strings can be read as NaN values """ hex_string, expected = hex_string_params zdtype = self.test_cls() observed = zdtype.from_json_scalar(hex_string, zarr_format=3) assert self.scalar_equals(observed, expected) class TestFloat16(_BaseTestFloat): test_cls = Float16 valid_dtype = (np.dtype(">f2"), np.dtype("f2", "object_codec_id": None}, {"name": "f4"), np.dtype("f4", "object_codec_id": None}, {"name": "f8"), np.dtype("f8", "object_codec_id": None}, {"name": " None: """Test the check_json_floatish_str function.""" from zarr.core.dtype.npy.common import check_json_floatish_str # Test valid string floats assert check_json_floatish_str("3.14") assert check_json_floatish_str("0.0") assert check_json_floatish_str("-2.5") assert check_json_floatish_str("1.0") # Test invalid cases assert not check_json_floatish_str("not_a_number") assert not check_json_floatish_str("") assert not check_json_floatish_str(3.14) # actual float, not string assert not check_json_floatish_str(42) # int assert not check_json_floatish_str(None) # Test that special cases still work via float() conversion # (these will be handled by existing functions first in practice) assert check_json_floatish_str("NaN") assert check_json_floatish_str("Infinity") assert check_json_floatish_str("-Infinity") def test_string_float_from_json_scalar() -> None: """Test that string representations of floats can be parsed by from_json_scalar.""" # Test with Float32 dtype_instance = Float32() result = dtype_instance.from_json_scalar("3.14", zarr_format=3) assert abs(result - np.float32(3.14)) < 1e-6 assert isinstance(result, np.float32) # Test other cases result = dtype_instance.from_json_scalar("0.0", zarr_format=3) assert result == np.float32(0.0) result = dtype_instance.from_json_scalar("-2.5", zarr_format=3) assert result == np.float32(-2.5) # Test that it works for v2 format too result = dtype_instance.from_json_scalar("1.5", zarr_format=2) assert result == np.float32(1.5) zarr-python-3.3.0/tests/test_dtype/test_npy/test_int.py000066400000000000000000000231401523267620000234130ustar00rootroot00000000000000from __future__ import annotations import numpy as np from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype.npy.int import Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64 class TestInt8(BaseTestZDType): test_cls = Int8 scalar_type = np.int8 valid_dtype = (np.dtype(np.int8),) invalid_dtype = ( np.dtype(np.int16), np.dtype(np.uint16), np.dtype(np.float64), ) valid_json_v2 = ({"name": "|i1", "object_codec_id": None},) valid_json_v3 = ("int8",) invalid_json_v2 = ( ">i1", "int8", "|f8", ) invalid_json_v3 = ( "|i1", "|f8", {"name": "int8", "configuration": {"endianness": "little"}}, ) scalar_v2_params = ((Int8(), 1), (Int8(), -1), (Int8(), 1.0)) scalar_v3_params = ((Int8(), 1), (Int8(), -1)) cast_value_params = ( (Int8(), 1, np.int8(1)), (Int8(), -1, np.int8(-1)), ) invalid_scalar_params = ((Int8(), {"set!"}), (Int8(), ("tuple",))) item_size_params = (Int8(),) class TestInt16(BaseTestZDType): test_cls = Int16 scalar_type = np.int16 valid_dtype = (np.dtype(">i2"), np.dtype("i2", "object_codec_id": None}, {"name": "i4"), np.dtype("i4", "object_codec_id": None}, {"name": "i8"), np.dtype("i8", "object_codec_id": None}, {"name": "u2"), np.dtype("u2", "object_codec_id": None}, {"name": "u4"), np.dtype("u4", "object_codec_id": None}, {"name": "u8"), np.dtype("u8", "object_codec_id": None}, {"name": " None: """Test the check_json_intish_str function.""" from zarr.core.dtype.npy.common import check_json_intish_str # Test valid string integers assert check_json_intish_str("0") assert check_json_intish_str("42") assert check_json_intish_str("-5") assert check_json_intish_str("123") # Test invalid cases assert not check_json_intish_str("3.14") assert not check_json_intish_str("not_a_number") assert not check_json_intish_str("") assert not check_json_intish_str(42) # actual int, not string assert not check_json_intish_str(3.14) # float assert not check_json_intish_str(None) def test_string_integer_from_json_scalar() -> None: """Test that string representations of integers can be parsed by from_json_scalar.""" # Test the specific reproducer case dtype_instance = Int32() result = dtype_instance.from_json_scalar("0", zarr_format=3) assert result == np.int32(0) assert isinstance(result, np.int32) # Test other cases result = dtype_instance.from_json_scalar("42", zarr_format=3) assert result == np.int32(42) result = dtype_instance.from_json_scalar("-5", zarr_format=3) assert result == np.int32(-5) # Test that it works for v2 format too result = dtype_instance.from_json_scalar("123", zarr_format=2) assert result == np.int32(123) zarr-python-3.3.0/tests/test_dtype/test_npy/test_string.py000066400000000000000000000056561523267620000241430ustar00rootroot00000000000000from __future__ import annotations import numpy as np import pytest from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype import FixedLengthUTF32 from zarr.core.dtype.npy.string import VariableLengthUTF8 class TestVariableLengthString(BaseTestZDType): test_cls = VariableLengthUTF8 # type: ignore[assignment] valid_dtype = (np.dtypes.StringDType(),) # type: ignore[assignment] invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype("|S10"), ) valid_json_v2 = ({"name": "|O", "object_codec_id": "vlen-utf8"},) valid_json_v3 = ("string",) invalid_json_v2 = ( "|S10", "|f8", "invalid", ) invalid_json_v3 = ( {"name": "variable_length_utf8", "configuration": {"invalid_key": "value"}}, {"name": "invalid_name"}, ) scalar_v2_params = ((VariableLengthUTF8(), ""), (VariableLengthUTF8(), "hi")) scalar_v3_params = ( (VariableLengthUTF8(), ""), (VariableLengthUTF8(), "hi"), ) cast_value_params = ( (VariableLengthUTF8(), "", np.str_("")), (VariableLengthUTF8(), "hi", np.str_("hi")), ) # anything can become a string invalid_scalar_params = (None,) item_size_params = (VariableLengthUTF8(),) class TestFixedLengthUTF32(BaseTestZDType): test_cls = FixedLengthUTF32 valid_dtype = (np.dtype(">U10"), np.dtype("U10", "object_codec_id": None}, {"name": " None: """ Test that it's impossible to create a data type that has no length """ length = 0 msg = f"length must be >= 1, got {length}." with pytest.raises(ValueError, match=msg): FixedLengthUTF32(length=length) zarr-python-3.3.0/tests/test_dtype/test_npy/test_structured.py000066400000000000000000000217341523267620000250340ustar00rootroot00000000000000from __future__ import annotations from typing import Any import numpy as np import pytest from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype import ( Float16, Float64, Int32, Int64, Struct, Structured, UInt8, ) class TestStruct(BaseTestZDType): """Test the canonical 'struct' dtype format.""" test_cls = Struct valid_dtype = ( np.dtype([("field1", np.int32), ("field2", np.float64)]), np.dtype([("field1", np.int64), ("field2", np.int32)]), ) invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype("|S10"), ) valid_json_v2 = ( {"name": [["field1", ">i4"], ["field2", ">f8"]], "object_codec_id": None}, {"name": [["field1", ">i8"], ["field2", ">i4"]], "object_codec_id": None}, ) valid_json_v3 = ( { "name": "struct", "configuration": { "fields": [ {"name": "field1", "data_type": "int32"}, {"name": "field2", "data_type": "float64"}, ] }, }, { "name": "struct", "configuration": { "fields": [ { "name": "field1", "data_type": { "name": "numpy.datetime64", "configuration": {"unit": "s", "scale_factor": 1}, }, }, { "name": "field2", "data_type": { "name": "fixed_length_utf32", "configuration": {"length_bytes": 32}, }, }, ] }, }, ) invalid_json_v2 = ( [("field1", "|i1"), ("field2", "|f8")], [("field1", "|S10"), ("field2", "|f8")], ) invalid_json_v3 = ( { "name": "struct", "configuration": { "fields": [ ("field1", {"name": "int32", "configuration": {"endianness": "invalid"}}), ("field2", {"name": "float64", "configuration": {"endianness": "big"}}), ] }, }, {"name": "invalid_name"}, ) scalar_v2_params = ( (Struct(fields=(("field1", Int32()), ("field2", Float64()))), "AQAAAAAAAAAAAPA/"), (Struct(fields=(("field1", Float16()), ("field2", Int32()))), "AQAAAAAA"), ) scalar_v3_params = ( ( Struct(fields=(("field1", Int32()), ("field2", Float64()))), {"field1": 1, "field2": 1.0}, ), (Struct(fields=(("field1", Int64()), ("field2", Int32()))), {"field1": 1, "field2": 1}), ) cast_value_params = ( ( Struct(fields=(("field1", Int32()), ("field2", Float64()))), (1, 2.0), np.array((1, 2.0), dtype=[("field1", np.int32), ("field2", np.float64)]), ), ( Struct(fields=(("field1", Int64()), ("field2", Int32()))), (3, 4.5), np.array((3, 4.5), dtype=[("field1", np.int64), ("field2", np.int32)]), ), ) item_size_params = ( Struct(fields=(("field1", Int32()), ("field2", Float64()))), Struct(fields=(("field1", Int64()), ("field2", Int32()))), ) invalid_scalar_params = ( (Struct(fields=(("field1", Int32()), ("field2", Float64()))), "i am a string"), (Struct(fields=(("field1", Int32()), ("field2", Float64()))), {"type": "dict"}), ) def scalar_equals(self, scalar1: Any, scalar2: Any) -> bool: if hasattr(scalar1, "shape") and hasattr(scalar2, "shape"): return np.array_equal(scalar1, scalar2) return super().scalar_equals(scalar1, scalar2) class TestStructured: """Test the legacy 'structured' dtype format.""" def test_invalid_size(self) -> None: """Test that it's impossible to create a data type that has no fields.""" fields = () msg = f"must have at least one field. Got {fields!r}" with pytest.raises(ValueError, match=msg): Structured(fields=fields) def test_structured_legacy_name_with_tuple_format(self) -> None: """Test that the legacy 'structured' name with tuple field format is accepted.""" json_v3 = { "name": "structured", "configuration": { "fields": [ ["field1", "int32"], ["field2", "float64"], ] }, } dtype = Structured.from_json(json_v3, zarr_format=3) assert dtype.fields[0][0] == "field1" assert dtype.fields[1][0] == "field2" @pytest.mark.filterwarnings("ignore::zarr.errors.UnstableSpecificationWarning") def test_structured_writes_tuple_format(self) -> None: """Test that 'structured' writes the tuple field format.""" dtype = Structured(fields=(("field1", Int32()), ("field2", Float64()))) json_v3 = dtype.to_json(zarr_format=3) assert json_v3["name"] == "structured" assert json_v3["configuration"]["fields"][0] == ["field1", "int32"] def test_invalid_size() -> None: """Test that it's impossible to create a data type that has no fields.""" fields = () msg = f"must have at least one field. Got {fields!r}" with pytest.raises(ValueError, match=msg): Struct(fields=fields) @pytest.mark.filterwarnings("ignore::zarr.errors.UnstableSpecificationWarning") def test_struct_name_is_primary() -> None: """Test that 'struct' is the primary name written to JSON.""" dtype = Struct(fields=(("field1", Int32()), ("field2", Float64()))) json_v3 = dtype.to_json(zarr_format=3) assert json_v3["name"] == "struct" def test_struct_reads_legacy_tuple_format() -> None: """Test that 'struct' dtype reads the legacy tuple field format.""" json_v3 = { "name": "struct", "configuration": { "fields": [ ["field1", "int32"], ["field2", "float64"], ] }, } dtype = Struct.from_json(json_v3, zarr_format=3) assert isinstance(dtype, Struct) assert dtype.fields[0][0] == "field1" assert dtype.fields[1][0] == "field2" def test_struct_reads_canonical_object_format() -> None: """Test that 'struct' dtype reads the new object field format.""" json_v3 = { "name": "struct", "configuration": { "fields": [ {"name": "field1", "data_type": "int32"}, {"name": "field2", "data_type": "float64"}, ] }, } dtype = Struct.from_json(json_v3, zarr_format=3) assert isinstance(dtype, Struct) assert dtype.fields[0][0] == "field1" assert dtype.fields[1][0] == "field2" def test_fill_value_dict_form() -> None: """Test that dict form fill values are properly parsed.""" dtype = Struct(fields=(("x", Int32()), ("y", Float64()))) fill_value = dtype.from_json_scalar({"x": 42, "y": 3.14}, zarr_format=3) assert fill_value["x"] == 42 assert fill_value["y"] == 3.14 def test_fill_value_dict_form_missing_fields() -> None: """Test that missing fields in dict form fill values use defaults.""" dtype = Struct(fields=(("x", Int32()), ("y", Float64()))) fill_value = dtype.from_json_scalar({"x": 42}, zarr_format=3) assert fill_value["x"] == 42 assert fill_value["y"] == 0.0 def test_fill_value_legacy_base64() -> None: """Test that legacy base64-encoded fill values are still readable.""" dtype = Struct(fields=(("field1", Int32()), ("field2", Float64()))) fill_value = dtype.from_json_scalar("AQAAAAAAAAAAAPA/", zarr_format=3) assert fill_value["field1"] == 1 assert fill_value["field2"] == 1.0 def test_fill_value_to_json_dict_form() -> None: """Test that fill values are serialized as dict form.""" dtype = Struct(fields=(("x", Int32()), ("y", Float64()))) scalar = np.array((42, 3.14), dtype=[("x", np.int32), ("y", np.float64)])[()] json_val = dtype.to_json_scalar(scalar, zarr_format=3) assert isinstance(json_val, dict) assert json_val["x"] == 42 assert json_val["y"] == 3.14 def test_has_multi_byte_fields_true() -> None: """Test that has_multi_byte_fields returns True for dtypes with multi-byte fields.""" dtype = Struct(fields=(("field1", Int32()), ("field2", Float64()))) assert dtype.has_multi_byte_fields() is True def test_has_multi_byte_fields_false() -> None: """Test that has_multi_byte_fields returns False for dtypes with only single-byte fields.""" dtype = Struct(fields=(("field1", UInt8()), ("field2", UInt8()))) assert dtype.has_multi_byte_fields() is False def test_struct_from_native_dtype() -> None: """Test that Struct can be created from native numpy dtype.""" dtype = np.dtype([("field1", np.int32), ("field2", np.float64)]) struct = Struct.from_native_dtype(dtype) assert struct.fields[0][0] == "field1" assert struct.fields[1][0] == "field2" zarr-python-3.3.0/tests/test_dtype/test_npy/test_time.py000066400000000000000000000142221523267620000235600ustar00rootroot00000000000000from __future__ import annotations import re from typing import get_args import numpy as np import pytest from tests.test_dtype.test_wrapper import BaseTestZDType from zarr.core.dtype.npy.common import DateTimeUnit from zarr.core.dtype.npy.time import DateTime64, TimeDelta64, datetime_from_int class _TestTimeBase(BaseTestZDType): def json_scalar_equals(self, scalar1: object, scalar2: object) -> bool: # This method gets overridden here to support the equivalency between NaT and # -9223372036854775808 fill values nat_scalars = (-9223372036854775808, "NaT") if scalar1 in nat_scalars and scalar2 in nat_scalars: return True return scalar1 == scalar2 def scalar_equals(self, scalar1: object, scalar2: object) -> bool: if np.isnan(scalar1) and np.isnan(scalar2): # type: ignore[call-overload] return True return super().scalar_equals(scalar1, scalar2) class TestDateTime64(_TestTimeBase): test_cls = DateTime64 valid_dtype = (np.dtype("datetime64[10ns]"), np.dtype("datetime64[us]"), np.dtype("datetime64")) invalid_dtype = ( np.dtype(np.int8), np.dtype(np.float64), np.dtype("timedelta64[ns]"), ) valid_json_v2 = ( {"name": ">M8", "object_codec_id": None}, {"name": ">M8[s]", "object_codec_id": None}, {"name": "m8", "object_codec_id": None}, {"name": ">m8[s]", "object_codec_id": None}, {"name": " None: """ Test that an invalid unit raises a ValueError. """ unit = "invalid" msg = f"unit must be one of ('Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'μs', 'ns', 'ps', 'fs', 'as', 'generic'), got {unit!r}." with pytest.raises(ValueError, match=re.escape(msg)): DateTime64(unit=unit) # type: ignore[arg-type] with pytest.raises(ValueError, match=re.escape(msg)): TimeDelta64(unit=unit) # type: ignore[arg-type] def test_time_scale_factor_too_low() -> None: """ Test that an invalid unit raises a ValueError. """ scale_factor = 0 msg = f"scale_factor must be > 0, got {scale_factor}." with pytest.raises(ValueError, match=msg): DateTime64(scale_factor=scale_factor) with pytest.raises(ValueError, match=msg): TimeDelta64(scale_factor=scale_factor) def test_default_is_NaT() -> None: np.testing.assert_equal( TimeDelta64(unit="ns", scale_factor=1).default_scalar(), np.timedelta64("NaT", "ns") ) def test_time_scale_factor_too_high() -> None: """ Test that an invalid unit raises a ValueError. """ scale_factor = 2**31 msg = f"scale_factor must be < 2147483648, got {scale_factor}." with pytest.raises(ValueError, match=msg): DateTime64(scale_factor=scale_factor) with pytest.raises(ValueError, match=msg): TimeDelta64(scale_factor=scale_factor) @pytest.mark.parametrize("unit", get_args(DateTimeUnit)) @pytest.mark.parametrize("scale_factor", [1, 10]) @pytest.mark.parametrize("value", [0, 1, 10]) def test_datetime_from_int(unit: DateTimeUnit, scale_factor: int, value: int) -> None: """ Test datetime_from_int. """ expected = np.int64(value).view(f"datetime64[{scale_factor}{unit}]") assert datetime_from_int(value, unit=unit, scale_factor=scale_factor) == expected zarr-python-3.3.0/tests/test_dtype/test_wrapper.py000066400000000000000000000176671523267620000224550ustar00rootroot00000000000000from __future__ import annotations import re from typing import TYPE_CHECKING, Any, ClassVar import pytest from zarr.core.dtype.common import DTypeSpec_V2, DTypeSpec_V3, HasItemSize if TYPE_CHECKING: from zarr.core.dtype.wrapper import TBaseDType, TBaseScalar, ZDType """ class _TestZDTypeSchema: # subclasses define the URL for the schema, if available schema_url: ClassVar[str] = "" @pytest.fixture(scope="class") def get_schema(self) -> object: response = requests.get(self.schema_url) response.raise_for_status() return json_schema.loads(response.text) def test_schema(self, schema: json_schema.Schema) -> None: assert schema.is_valid(self.test_cls.to_json(zarr_format=2)) """ class BaseTestZDType: """ A base class for testing ZDType subclasses. This class works in conjunction with the custom pytest collection function ``pytest_generate_tests`` defined in conftest.py, which applies the following procedure when generating tests: At test generation time, for each test fixture referenced by a method on this class pytest will look for an attribute with the same name as that fixture. Pytest will assume that this class attribute is a tuple of values to be used for generating a parametrized test fixture. This means that child classes can, by using different values for these class attributes, have customized test parametrization. Attributes ---------- test_cls : type[ZDType[TBaseDType, TBaseScalar]] The ZDType subclass being tested. scalar_type : ClassVar[type[TBaseScalar]] The expected scalar type for the ZDType. valid_dtype : ClassVar[tuple[TBaseDType, ...]] A tuple of valid numpy dtypes for the ZDType. invalid_dtype : ClassVar[tuple[TBaseDType, ...]] A tuple of invalid numpy dtypes for the ZDType. valid_json_v2 : ClassVar[tuple[str | dict[str, object] | list[object], ...]] A tuple of valid JSON representations for Zarr format version 2. invalid_json_v2 : ClassVar[tuple[str | dict[str, object] | list[object], ...]] A tuple of invalid JSON representations for Zarr format version 2. valid_json_v3 : ClassVar[tuple[str | dict[str, object], ...]] A tuple of valid JSON representations for Zarr format version 3. invalid_json_v3 : ClassVar[tuple[str | dict[str, object], ...]] A tuple of invalid JSON representations for Zarr format version 3. cast_value_params : ClassVar[tuple[tuple[Any, Any, Any], ...]] A tuple of (dtype, value, expected) tuples for testing ZDType.cast_value. scalar_v2_params : ClassVar[tuple[Any, ...]] A tuple of (dtype, scalar json) tuples for testing ZDType.from_json_scalar / ZDType.to_json_scalar for zarr v2 scalar_v3_params : ClassVar[tuple[Any, ...]] A tuple of (dtype, scalar json) tuples for testing ZDType.from_json_scalar / ZDType.to_json_scalar for zarr v3 invalid_scalar_params : ClassVar[tuple[Any, ...]] A tuple of (dtype, value) tuples, where each value is expected to fail ZDType.cast_value. item_size_params : ClassVar[tuple[Any, ...]] A tuple of (dtype, expected) tuples for testing ZDType.item_size """ test_cls: type[ZDType[TBaseDType, TBaseScalar]] scalar_type: ClassVar[type[TBaseScalar]] valid_dtype: ClassVar[tuple[TBaseDType, ...]] = () invalid_dtype: ClassVar[tuple[TBaseDType, ...]] = () valid_json_v2: ClassVar[tuple[DTypeSpec_V2, ...]] = () invalid_json_v2: ClassVar[tuple[str | dict[str, object] | list[object], ...]] = () valid_json_v3: ClassVar[tuple[DTypeSpec_V3, ...]] = () invalid_json_v3: ClassVar[tuple[str | dict[str, object], ...]] = () # for testing scalar round-trip serialization, we need a tuple of (data type json, scalar json) # pairs. the first element of the pair is used to create a dtype instance, and the second # element is the json serialization of the scalar that we want to round-trip. scalar_v2_params: ClassVar[tuple[tuple[ZDType[Any, Any], Any], ...]] = () scalar_v3_params: ClassVar[tuple[tuple[Any, Any], ...]] = () cast_value_params: ClassVar[tuple[tuple[ZDType[Any, Any], Any, Any], ...]] = () # Some data types, like bool and string, can consume any python object as a scalar. # So we allow passing None in to this test to indicate that it should be skipped. invalid_scalar_params: ClassVar[tuple[tuple[ZDType[Any, Any], Any], ...] | tuple[None]] = () item_size_params: ClassVar[tuple[ZDType[Any, Any], ...]] = () def json_scalar_equals(self, scalar1: object, scalar2: object) -> bool: # An equality check for json-encoded scalars. This defaults to regular equality, # but some classes may need to override this for special cases return scalar1 == scalar2 def scalar_equals(self, scalar1: object, scalar2: object) -> bool: # An equality check for scalars. This defaults to regular equality, # but some classes may need to override this for special cases return scalar1 == scalar2 def test_check_dtype_valid(self, valid_dtype: TBaseDType) -> None: assert self.test_cls._check_native_dtype(valid_dtype) def test_check_dtype_invalid(self, invalid_dtype: object) -> None: assert not self.test_cls._check_native_dtype(invalid_dtype) # type: ignore[arg-type] def test_from_dtype_roundtrip(self, valid_dtype: Any) -> None: zdtype = self.test_cls.from_native_dtype(valid_dtype) assert zdtype.to_native_dtype() == valid_dtype def test_from_json_roundtrip_v2(self, valid_json_v2: DTypeSpec_V2) -> None: zdtype = self.test_cls.from_json(valid_json_v2, zarr_format=2) assert zdtype.to_json(zarr_format=2) == valid_json_v2 @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_from_json_roundtrip_v3(self, valid_json_v3: DTypeSpec_V3) -> None: zdtype = self.test_cls.from_json(valid_json_v3, zarr_format=3) assert zdtype.to_json(zarr_format=3) == valid_json_v3 def test_scalar_roundtrip_v2(self, scalar_v2_params: tuple[ZDType[Any, Any], Any]) -> None: zdtype, scalar_json = scalar_v2_params scalar = zdtype.from_json_scalar(scalar_json, zarr_format=2) assert self.json_scalar_equals(scalar_json, zdtype.to_json_scalar(scalar, zarr_format=2)) def test_scalar_roundtrip_v3(self, scalar_v3_params: tuple[ZDType[Any, Any], Any]) -> None: zdtype, scalar_json = scalar_v3_params scalar = zdtype.from_json_scalar(scalar_json, zarr_format=3) assert self.json_scalar_equals(scalar_json, zdtype.to_json_scalar(scalar, zarr_format=3)) def test_cast_value(self, cast_value_params: tuple[ZDType[Any, Any], Any, Any]) -> None: zdtype, value, expected = cast_value_params observed = zdtype.cast_scalar(value) assert self.scalar_equals(expected, observed) # check that casting is idempotent assert self.scalar_equals(zdtype.cast_scalar(observed), observed) def test_invalid_scalar( self, invalid_scalar_params: tuple[ZDType[Any, Any], Any] | None ) -> None: if invalid_scalar_params is None: pytest.skip(f"No test data provided for {self}.{__name__}") zdtype, data = invalid_scalar_params msg = ( f"Cannot convert object {data!r} with type {type(data)} to a scalar compatible with the " f"data type {zdtype}." ) with pytest.raises(TypeError, match=re.escape(msg)): zdtype.cast_scalar(data) def test_item_size(self, item_size_params: ZDType[Any, Any]) -> None: """ Test that the item_size attribute matches the numpy dtype itemsize attribute, for dtypes with a fixed scalar size. """ if isinstance(item_size_params, HasItemSize): assert item_size_params.item_size == item_size_params.to_native_dtype().itemsize else: pytest.skip(f"Data type {item_size_params} does not implement HasItemSize") zarr-python-3.3.0/tests/test_dtype_registry.py000066400000000000000000000210101523267620000216370ustar00rootroot00000000000000from __future__ import annotations import re from typing import TYPE_CHECKING, Any, Literal, get_args import numpy as np import pytest from tests.conftest import skip_object_dtype from zarr.core.dtype import ( AnyDType, DataTypeRegistry, TBaseDType, TBaseScalar, get_data_type_from_json, ) from zarr.core.dtype.common import unpack_dtype_json from zarr.dtype import ( # type: ignore[attr-defined] Bool, FixedLengthUTF32, VariableLengthUTF8, ZDType, data_type_registry, parse_data_type, parse_dtype, ) if TYPE_CHECKING: from zarr.core.common import ZarrFormat from .test_dtype.conftest import zdtype_examples @pytest.fixture def data_type_registry_fixture() -> DataTypeRegistry: return DataTypeRegistry() class TestRegistry: @staticmethod def test_register(data_type_registry_fixture: DataTypeRegistry) -> None: """ Test that registering a dtype in a data type registry works. """ data_type_registry_fixture.register(Bool._zarr_v3_name, Bool) assert data_type_registry_fixture.get(Bool._zarr_v3_name) == Bool assert isinstance(data_type_registry_fixture.match_dtype(np.dtype("bool")), Bool) @staticmethod def test_override(data_type_registry_fixture: DataTypeRegistry) -> None: """ Test that registering a new dtype with the same name works (overriding the previous one). """ data_type_registry_fixture.register(Bool._zarr_v3_name, Bool) class NewBool(Bool): def default_scalar(self) -> np.bool_: return np.True_ data_type_registry_fixture.register(NewBool._zarr_v3_name, NewBool) assert isinstance(data_type_registry_fixture.match_dtype(np.dtype("bool")), NewBool) @staticmethod @pytest.mark.parametrize( ("wrapper_cls", "dtype_str"), [(Bool, "bool"), (FixedLengthUTF32, "|U4")] ) def test_match_dtype( data_type_registry_fixture: DataTypeRegistry, wrapper_cls: type[ZDType[TBaseDType, TBaseScalar]], dtype_str: str, ) -> None: """ Test that match_dtype resolves a numpy dtype into an instance of the correspond wrapper for that dtype. """ data_type_registry_fixture.register(wrapper_cls._zarr_v3_name, wrapper_cls) assert isinstance(data_type_registry_fixture.match_dtype(np.dtype(dtype_str)), wrapper_cls) @staticmethod def test_match_dtype_string_na_object_error( data_type_registry_fixture: DataTypeRegistry, ) -> None: data_type_registry_fixture.register(VariableLengthUTF8._zarr_v3_name, VariableLengthUTF8) # type: ignore[arg-type] dtype: np.dtype[Any] = np.dtypes.StringDType(na_object=None) with pytest.raises(ValueError, match=r"Zarr data type resolution from StringDType.*failed"): data_type_registry_fixture.match_dtype(dtype) @staticmethod def test_unregistered_dtype(data_type_registry_fixture: DataTypeRegistry) -> None: """ Test that match_dtype raises an error if the dtype is not registered. """ outside_dtype_name = "int8" outside_dtype = np.dtype(outside_dtype_name) msg = f"No Zarr data type found that matches dtype '{outside_dtype!r}'" with pytest.raises(ValueError, match=re.escape(msg)): data_type_registry_fixture.match_dtype(outside_dtype) with pytest.raises(KeyError): data_type_registry_fixture.get(outside_dtype_name) @staticmethod @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("zdtype", zdtype_examples) def test_registered_dtypes_match_dtype(zdtype: ZDType[TBaseDType, TBaseScalar]) -> None: """ Test that the registered dtypes can be retrieved from the registry. """ skip_object_dtype(zdtype) assert data_type_registry.match_dtype(zdtype.to_native_dtype()) == zdtype @staticmethod @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("zdtype", zdtype_examples) def test_registered_dtypes_match_json( zdtype: ZDType[TBaseDType, TBaseScalar], zarr_format: ZarrFormat ) -> None: assert ( data_type_registry.match_json( zdtype.to_json(zarr_format=zarr_format), zarr_format=zarr_format ) == zdtype ) @staticmethod @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("zdtype", zdtype_examples) def test_match_dtype_unique( zdtype: ZDType[Any, Any], data_type_registry_fixture: DataTypeRegistry, zarr_format: ZarrFormat, ) -> None: """ Test that the match_dtype method uniquely specifies a registered data type. We create a local registry that excludes the data type class being tested, and ensure that an instance of the wrapped data type fails to match anything in the registry """ skip_object_dtype(zdtype) for _cls in get_args(AnyDType): if _cls is not type(zdtype): data_type_registry_fixture.register(_cls._zarr_v3_name, _cls) dtype_instance = zdtype.to_native_dtype() msg = f"No Zarr data type found that matches dtype '{dtype_instance!r}'" with pytest.raises(ValueError, match=re.escape(msg)): data_type_registry_fixture.match_dtype(dtype_instance) instance_dict = zdtype.to_json(zarr_format=zarr_format) msg = f"No Zarr data type found that matches {instance_dict!r}" with pytest.raises(ValueError, match=re.escape(msg)): data_type_registry_fixture.match_json(instance_dict, zarr_format=zarr_format) @pytest.mark.usefixtures("set_path") def test_entrypoint_dtype(zarr_format: ZarrFormat) -> None: from package_with_entrypoint import TestDataType data_type_registry._lazy_load() instance = TestDataType() dtype_json = instance.to_json(zarr_format=zarr_format) assert get_data_type_from_json(dtype_json, zarr_format=zarr_format) == instance data_type_registry.unregister(TestDataType._zarr_v3_name) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize("data_type", zdtype_examples, ids=str) @pytest.mark.parametrize("json_style", [(2, "internal"), (2, "metadata"), (3, None)], ids=str) @pytest.mark.parametrize( "dtype_parser_func", [parse_dtype, parse_data_type], ids=["parse_dtype", "parse_data_type"] ) def test_parse_data_type( data_type: ZDType[Any, Any], json_style: tuple[ZarrFormat, None | Literal["internal", "metadata"]], dtype_parser_func: Any, ) -> None: """ Test the parsing of data types into ZDType instances. This function tests the ability of `dtype_parser_func` to correctly interpret and parse data type specifications into `ZDType` instances according to the specified Zarr format and JSON style. Parameters ---------- data_type : ZDType[Any, Any] The data type to be tested for parsing. json_style : tuple[ZarrFormat, None or Literal["internal", "metadata"]] A tuple specifying the Zarr format version and the JSON style for Zarr V2 2. For Zarr V2 there are 2 JSON styles: "internal", and "metadata". The internal style takes the form {"name": , "object_codec_id": }, while the metadata style is just . dtype_parser_func : Any The function to be tested for parsing the data type. This is necessary for compatibility reasons, as we support multiple functions that perform the same data type parsing operation. """ zarr_format, style = json_style dtype_spec: Any if zarr_format == 2: dtype_spec = data_type.to_json(zarr_format=zarr_format) if style == "internal": pass elif style == "metadata": dtype_spec = unpack_dtype_json(dtype_spec) else: raise ValueError(f"Invalid zarr v2 json style: {style}") else: dtype_spec = data_type.to_json(zarr_format=zarr_format) if dtype_spec == "|O": # The object data type on its own is ambiguous and should fail to resolve. msg = "Zarr data type resolution from object failed." with pytest.raises(ValueError, match=msg): dtype_parser_func(dtype_spec, zarr_format=zarr_format) else: observed = dtype_parser_func(dtype_spec, zarr_format=zarr_format) assert observed == data_type zarr-python-3.3.0/tests/test_errors.py000066400000000000000000000061321523267620000201060ustar00rootroot00000000000000"""Test errors""" import pytest from zarr.errors import ( ArrayNotFoundError, ContainsArrayAndGroupError, ContainsArrayError, ContainsGroupError, DataTypeValidationError, GroupNotFoundError, MetadataValidationError, NodeTypeValidationError, ZarrDeprecationWarning, ) def test_group_not_found_error() -> None: """ Test that calling GroupNotFoundError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = GroupNotFoundError("store", "path") assert str(err) == "No group found in store 'store' at path 'path'" def test_array_not_found_error() -> None: """ Test that calling ArrayNotFoundError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = ArrayNotFoundError("store", "path") assert str(err) == "No array found in store 'store' at path 'path'" def test_metadata_validation_error() -> None: """ Test that calling MetadataValidationError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = MetadataValidationError("a", "b", "c") assert str(err) == "Invalid value for 'a'. Expected 'b'. Got 'c'." def test_contains_group_error() -> None: """ Test that calling ContainsGroupError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = ContainsGroupError("store", "path") assert str(err) == "A group exists in store 'store' at path 'path'." def test_contains_array_error() -> None: """ Test that calling ContainsArrayError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = ContainsArrayError("store", "path") assert str(err) == "An array exists in store 'store' at path 'path'." def test_contains_array_and_group_error() -> None: """ Test that calling ContainsArrayAndGroupError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = ContainsArrayAndGroupError("store", "path") assert str(err) == ( "Array and group metadata documents (.zarray and .zgroup) were both found in store 'store' " "at path 'path'. Only one of these files may be present in a given directory / prefix. " "Remove the .zarray file, or the .zgroup file, or both." ) def test_node_type_validation_error() -> None: """ Test that calling NodeTypeValidationError with multiple arguments returns a formatted string. This is deprecated behavior. """ err = NodeTypeValidationError("a", "b", "c") assert str(err) == "Invalid value for 'a'. Expected 'b'. Got 'c'." @pytest.mark.parametrize( "module_name", [ "zarr.core.dtype.common", "zarr.core.dtype", "zarr.dtype", ], ) def test_data_type_validation_error_deprecated_import(module_name: str) -> None: import importlib module = importlib.import_module(module_name) with pytest.warns(ZarrDeprecationWarning, match=f"{module_name}"): cls = module.DataTypeValidationError assert cls is DataTypeValidationError zarr-python-3.3.0/tests/test_examples.py000066400000000000000000000057601523267620000204160ustar00rootroot00000000000000from __future__ import annotations import re import subprocess import sys from pathlib import Path from typing import Final import pytest import tomlkit from packaging.requirements import Requirement examples_dir = "examples" script_paths = tuple(Path(examples_dir).rglob("*.py")) PEP_723_REGEX: Final = r"(?m)^# /// (?P[a-zA-Z0-9-]+)$\s(?P(^#(| .*)$\s)+)^# ///$" # This is the absolute path to the local Zarr installation. Moving this test to a different directory will break it. ZARR_PROJECT_PATH = Path(".").absolute() def set_dep(script: str, dependency: str) -> str: """ Set a dependency in a PEP-723 script header. If the package is already in the list, it will be replaced. If the package is not already in the list, it will be added. Source code modified from https://packaging.python.org/en/latest/specifications/inline-script-metadata/#reference-implementation """ match = re.search(PEP_723_REGEX, script) if match is None: raise ValueError(f"PEP-723 header not found in {script}") content = "".join( line[2:] if line.startswith("# ") else line[1:] for line in match.group("content").splitlines(keepends=True) ) config = tomlkit.parse(content) for idx, dep in enumerate(tuple(config["dependencies"])): if Requirement(dep).name == Requirement(dependency).name: config["dependencies"][idx] = dependency new_content = "".join( f"# {line}" if line.strip() else f"#{line}" for line in tomlkit.dumps(config).splitlines(keepends=True) ) start, end = match.span("content") return script[:start] + new_content + script[end:] def resave_script(source_path: Path, dest_path: Path) -> None: """ Read a script from source_path and save it to dest_path after inserting the absolute path to the local Zarr project directory in the PEP-723 header. """ source_text = source_path.read_text() dest_text = set_dep(source_text, f"zarr @ file:///{ZARR_PROJECT_PATH}") dest_path.write_text(dest_text) def test_script_paths() -> None: """ Test that our test fixture is working properly and collecting script paths. """ assert len(script_paths) > 0 @pytest.mark.skipif( sys.platform == "win32", reason="This test fails for unknown reasons on Windows in CI." ) @pytest.mark.parametrize("script_path", script_paths) def test_scripts_can_run(script_path: Path, tmp_path: Path) -> None: dest_path = tmp_path / script_path.name # We resave the script after inserting the absolute path to the local Zarr project directory, # and then test its behavior. # This allows the example to be useful to users who don't have Zarr installed, but also testable. resave_script(script_path, dest_path) result = subprocess.run( ["uv", "run", "--refresh", str(dest_path)], capture_output=True, text=True ) assert result.returncode == 0, ( f"Script at {script_path} failed to run. Output: {result.stdout} Error: {result.stderr}" ) zarr-python-3.3.0/tests/test_experimental/000077500000000000000000000000001523267620000207135ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_experimental/test_cache_store.py000066400000000000000000001245121523267620000246100ustar00rootroot00000000000000""" Tests for the dual-store cache implementation. """ import asyncio import time import pytest from zarr.abc.store import RangeByteRequest, Store, SuffixByteRequest from zarr.core.buffer.core import default_buffer_prototype from zarr.core.buffer.cpu import Buffer as CPUBuffer from zarr.experimental.cache_store import CacheStore from zarr.storage import MemoryStore class TestCacheStore: """Test the dual-store cache implementation.""" @pytest.fixture def source_store(self) -> MemoryStore: """Create a source store with some test data.""" return MemoryStore() @pytest.fixture def cache_store(self) -> MemoryStore: """Create an empty cache store.""" return MemoryStore() @pytest.fixture def cached_store(self, source_store: Store, cache_store: Store) -> CacheStore: """Create a cached store instance.""" return CacheStore(source_store, cache_store=cache_store) async def test_with_read_only_round_trip(self) -> None: """ Ensure that CacheStore.with_read_only returns another CacheStore with the requested read_only state, shares cache state, and does not change the original store's read_only flag. """ source = MemoryStore() cache = MemoryStore() # Start from a read-only underlying store source_ro = source.with_read_only(read_only=True) cached_ro = CacheStore(store=source_ro, cache_store=cache) assert cached_ro.read_only buf = CPUBuffer.from_bytes(b"0123") # Cannot write through the read-only cache store with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await cached_ro.set("foo", buf) # Create a writable cache store from the read-only one writer = cached_ro.with_read_only(read_only=False) assert isinstance(writer, CacheStore) assert not writer.read_only # Cache configuration and state are shared assert writer._cache is cached_ro._cache assert writer._state is cached_ro._state assert writer._state.key_insert_times is cached_ro._state.key_insert_times # Writes via the writable cache store succeed and are cached await writer.set("foo", buf) out = await writer.get("foo", default_buffer_prototype()) assert out is not None assert out.to_bytes() == buf.to_bytes() # The original cache store remains read-only assert cached_ro.read_only with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await cached_ro.set("bar", buf) # Creating a read-only copy from the writable cache store works and is enforced reader = writer.with_read_only(read_only=True) assert isinstance(reader, CacheStore) assert reader.read_only with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await reader.set("baz", buf) async def test_basic_caching(self, cached_store: CacheStore, source_store: Store) -> None: """Test basic cache functionality.""" # Store some data test_data = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", test_data) # Verify it's in both stores assert await source_store.exists("test_key") assert await cached_store._cache.exists("test_key") # Retrieve and verify caching works result = await cached_store.get("test_key", default_buffer_prototype()) assert result is not None assert result.to_bytes() == b"test data" async def test_cache_miss_and_population( self, cached_store: CacheStore, source_store: Store ) -> None: """Test cache miss and subsequent population.""" # Put data directly in source store (bypassing cache) test_data = CPUBuffer.from_bytes(b"source data") await source_store.set("source_key", test_data) # First access should miss cache but populate it result = await cached_store.get("source_key", default_buffer_prototype()) assert result is not None assert result.to_bytes() == b"source data" # Verify data is now in cache assert await cached_store._cache.exists("source_key") async def test_cache_expiration(self) -> None: """Test cache expiration based on max_age_seconds.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_age_seconds=1, # 1 second expiration ) # Store data test_data = CPUBuffer.from_bytes(b"expiring data") await cached_store.set("expire_key", test_data) # Should be fresh initially assert cached_store._is_key_fresh("expire_key") # Wait for expiration await asyncio.sleep(1.1) # Should now be stale assert not cached_store._is_key_fresh("expire_key") async def test_cache_set_data_false(self, source_store: Store, cache_store: Store) -> None: """Test behavior when cache_set_data=False.""" cached_store = CacheStore(source_store, cache_store=cache_store, cache_set_data=False) test_data = CPUBuffer.from_bytes(b"no cache data") await cached_store.set("no_cache_key", test_data) # Data should be in source but not cache assert await source_store.exists("no_cache_key") assert not await cache_store.exists("no_cache_key") async def test_delete_removes_from_both_stores(self, cached_store: CacheStore) -> None: """Test that delete removes from both source and cache.""" test_data = CPUBuffer.from_bytes(b"delete me") await cached_store.set("delete_key", test_data) # Verify in both stores assert await cached_store._store.exists("delete_key") assert await cached_store._cache.exists("delete_key") # Delete await cached_store.delete("delete_key") # Verify removed from both assert not await cached_store._store.exists("delete_key") assert not await cached_store._cache.exists("delete_key") async def test_exists_checks_source_store( self, cached_store: CacheStore, source_store: Store ) -> None: """Test that exists() checks the source store (source of truth).""" # Put data directly in source test_data = CPUBuffer.from_bytes(b"exists test") await source_store.set("exists_key", test_data) # Should exist even though not in cache assert await cached_store.exists("exists_key") async def test_list_operations(self, cached_store: CacheStore, source_store: Store) -> None: """Test listing operations delegate to source store.""" # Add some test data test_data = CPUBuffer.from_bytes(b"list test") await cached_store.set("list/item1", test_data) await cached_store.set("list/item2", test_data) await cached_store.set("other/item3", test_data) # Test list_dir list_items = [key async for key in cached_store.list_dir("list/")] assert len(list_items) >= 2 # Should include our items # Test list_prefix prefix_items = [key async for key in cached_store.list_prefix("list/")] assert len(prefix_items) >= 2 async def test_stale_cache_refresh(self) -> None: """Test that stale cache entries are refreshed from source.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_age_seconds=1) # Store initial data old_data = CPUBuffer.from_bytes(b"old data") await cached_store.set("refresh_key", old_data) # Wait for expiration await asyncio.sleep(1.1) # Update source store directly (simulating external update) new_data = CPUBuffer.from_bytes(b"new data") await source_store.set("refresh_key", new_data) # Access should refresh from source when cache is stale result = await cached_store.get("refresh_key", default_buffer_prototype()) assert result is not None assert result.to_bytes() == b"new data" async def test_infinity_max_age(self, cached_store: CacheStore) -> None: """Test that 'infinity' max_age means cache never expires.""" test_data = CPUBuffer.from_bytes(b"eternal data") await cached_store.set("eternal_key", test_data) # Should always be fresh assert cached_store._is_key_fresh("eternal_key") # Even after time passes await asyncio.sleep(0.1) assert cached_store._is_key_fresh("eternal_key") async def test_cache_returns_cached_data_for_performance( self, cached_store: CacheStore, source_store: Store ) -> None: """Test that cache returns cached data for performance, even if not in source.""" # Put data in cache but not source (simulates orphaned cache entry) test_data = CPUBuffer.from_bytes(b"orphaned data") await cached_store._cache.set("orphan_key", test_data) cached_store._state.key_insert_times["orphan_key"] = time.monotonic() # Cache should return data for performance (no source verification) result = await cached_store.get("orphan_key", default_buffer_prototype()) assert result is not None assert result.to_bytes() == b"orphaned data" # Cache entry should remain (performance optimization) assert await cached_store._cache.exists("orphan_key") assert "orphan_key" in cached_store._state.key_insert_times async def test_cache_coherency_through_expiration(self) -> None: """Test that cache coherency is managed through cache expiration, not source verification.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_age_seconds=1, # Short expiration for coherency ) # Add data to both stores test_data = CPUBuffer.from_bytes(b"original data") await cached_store.set("coherency_key", test_data) # Remove from source (simulating external deletion) await source_store.delete("coherency_key") # Cache should still return cached data (performance optimization) result = await cached_store.get("coherency_key", default_buffer_prototype()) assert result is not None assert result.to_bytes() == b"original data" # Wait for cache expiration await asyncio.sleep(1.1) # Now stale cache should be refreshed from source result = await cached_store.get("coherency_key", default_buffer_prototype()) assert result is None # Key no longer exists in source async def test_cache_info(self, cached_store: CacheStore) -> None: """Test cache_info method returns correct information.""" # Test initial state info = cached_store.cache_info() # Check all expected keys are present expected_keys = { "cache_store_type", "max_age_seconds", "max_size", "current_size", "cache_set_data", "tracked_keys", "cached_keys", } assert set(info.keys()) == expected_keys # Check initial values assert info["cache_store_type"] == "MemoryStore" assert info["max_age_seconds"] == "infinity" assert info["max_size"] is None # Default unlimited assert info["current_size"] == 0 assert info["cache_set_data"] is True assert info["tracked_keys"] == 0 assert info["cached_keys"] == 0 # Add some data and verify tracking test_data = CPUBuffer.from_bytes(b"test data for cache info") await cached_store.set("info_test_key", test_data) # Check updated info updated_info = cached_store.cache_info() assert updated_info["tracked_keys"] == 1 assert updated_info["cached_keys"] == 1 assert updated_info["current_size"] > 0 # Should have some size now async def test_cache_info_with_max_size(self) -> None: """Test cache_info with max_size configuration.""" source_store = MemoryStore() cache_store = MemoryStore() # Create cache with specific max_size and max_age cached_store = CacheStore( source_store, cache_store=cache_store, max_size=1024, max_age_seconds=300, ) info = cached_store.cache_info() assert info["max_size"] == 1024 assert info["max_age_seconds"] == 300 assert info["current_size"] == 0 async def test_clear_cache(self, cached_store: CacheStore) -> None: """Test clear_cache method clears all cache data and tracking.""" # Add some test data test_data1 = CPUBuffer.from_bytes(b"test data 1") test_data2 = CPUBuffer.from_bytes(b"test data 2") await cached_store.set("clear_test_1", test_data1) await cached_store.set("clear_test_2", test_data2) # Verify data is cached info_before = cached_store.cache_info() assert info_before["tracked_keys"] == 2 assert info_before["cached_keys"] == 2 assert info_before["current_size"] > 0 # Verify data exists in cache assert await cached_store._cache.exists("clear_test_1") assert await cached_store._cache.exists("clear_test_2") # Clear the cache await cached_store.clear_cache() # Verify cache is cleared info_after = cached_store.cache_info() assert info_after["tracked_keys"] == 0 assert info_after["cached_keys"] == 0 assert info_after["current_size"] == 0 # Verify data is removed from cache store (if it supports clear) if hasattr(cached_store._cache, "clear"): # If cache store supports clear, all data should be gone assert not await cached_store._cache.exists("clear_test_1") assert not await cached_store._cache.exists("clear_test_2") # Verify data still exists in source store assert await cached_store._store.exists("clear_test_1") assert await cached_store._store.exists("clear_test_2") async def test_max_age_infinity(self) -> None: """Test cache with infinite max age.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_age_seconds="infinity") # Add data and verify it never expires test_data = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", test_data) # Even after time passes, key should be fresh assert cached_store._is_key_fresh("test_key") async def test_max_age_numeric(self) -> None: """Test cache with numeric max age.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_age_seconds=1, # 1 second ) # Add data test_data = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", test_data) # Key should be fresh initially assert cached_store._is_key_fresh("test_key") # Manually set old timestamp to test expiration cached_store._state.key_insert_times["test_key"] = time.monotonic() - 2 # 2 seconds ago # Key should now be stale assert not cached_store._is_key_fresh("test_key") async def test_cache_set_data_disabled(self) -> None: """Test cache behavior when cache_set_data is False.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, cache_set_data=False) # Set data test_data = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", test_data) # Data should be in source but not in cache assert await source_store.exists("test_key") assert not await cache_store.exists("test_key") # Cache info should show no cached data info = cached_store.cache_info() assert info["cache_set_data"] is False assert info["cached_keys"] == 0 async def test_eviction_with_max_size(self) -> None: """Test LRU eviction when max_size is exceeded.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_size=100, # Small cache size ) # Add data that exceeds cache size small_data = CPUBuffer.from_bytes(b"a" * 40) # 40 bytes medium_data = CPUBuffer.from_bytes(b"b" * 40) # 40 bytes large_data = CPUBuffer.from_bytes(b"c" * 40) # 40 bytes (would exceed 100 byte limit) # Set first two items await cached_store.set("key1", small_data) await cached_store.set("key2", medium_data) # Cache should have 2 items info = cached_store.cache_info() assert info["cached_keys"] == 2 assert info["current_size"] == 80 # Add third item - should trigger eviction of first item await cached_store.set("key3", large_data) # Cache should still have items but first one may be evicted info = cached_store.cache_info() assert info["current_size"] <= 100 async def test_value_exceeds_max_size(self) -> None: """Test behavior when a single value exceeds max_size.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_size=50, # Small cache size ) # Try to cache data larger than max_size large_data = CPUBuffer.from_bytes(b"x" * 100) # 100 bytes > 50 byte limit await cached_store.set("large_key", large_data) # Data should be in source but not cached assert await source_store.exists("large_key") info = cached_store.cache_info() assert info["cached_keys"] == 0 assert info["current_size"] == 0 async def test_get_nonexistent_key(self) -> None: """Test getting a key that doesn't exist in either store.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store) # Try to get nonexistent key result = await cached_store.get("nonexistent", default_buffer_prototype()) assert result is None # Should not create any cache entries info = cached_store.cache_info() assert info["cached_keys"] == 0 async def test_delete_both_stores(self) -> None: """Test that delete removes from both source and cache stores.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store) # Add data test_data = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", test_data) # Verify it's in both stores assert await source_store.exists("test_key") assert await cache_store.exists("test_key") # Delete await cached_store.delete("test_key") # Verify it's removed from both assert not await source_store.exists("test_key") assert not await cache_store.exists("test_key") # Verify tracking is updated info = cached_store.cache_info() assert info["cached_keys"] == 0 async def test_invalid_max_age_seconds(self) -> None: """Test that invalid max_age_seconds values raise ValueError.""" source_store = MemoryStore() cache_store = MemoryStore() with pytest.raises(ValueError, match="max_age_seconds string value must be 'infinity'"): CacheStore(source_store, cache_store=cache_store, max_age_seconds="invalid") async def test_unlimited_cache_size(self) -> None: """Test behavior when max_size is None (unlimited).""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_size=None, # Unlimited cache ) # Add large amounts of data for i in range(10): large_data = CPUBuffer.from_bytes(b"x" * 1000) # 1KB each await cached_store.set(f"large_key_{i}", large_data) # All should be cached since there's no size limit info = cached_store.cache_info() assert info["cached_keys"] == 10 assert info["current_size"] == 10000 # 10 * 1000 bytes async def test_evict_key_exception_handling(self) -> None: """Test exception handling in _evict_key method.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=100) # Add some data test_data = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", test_data) # Manually corrupt the tracking to trigger exception # Remove from one structure but not others to create inconsistency del cached_store._state.cache_order["test_key"] # Try to evict - should handle the KeyError gracefully await cached_store._evict_key("test_key") # Should still work and not crash info = cached_store.cache_info() assert isinstance(info, dict) async def test_get_no_cache_delete_tracking(self) -> None: """Test _get_no_cache when key doesn't exist and needs cleanup.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store) # First, add key to cache tracking but not to source test_data = CPUBuffer.from_bytes(b"test data") await cache_store.set("phantom_key", test_data) await cached_store._track_entry("phantom_key", test_data) # Verify it's in tracking assert "phantom_key" in cached_store._state.cache_order assert "phantom_key" in cached_store._state.key_insert_times # Now try to get it - since it's not in source, should clean up tracking result = await cached_store._get_no_cache("phantom_key", default_buffer_prototype()) assert result is None # Should have cleaned up tracking assert "phantom_key" not in cached_store._state.cache_order assert "phantom_key" not in cached_store._state.key_insert_times async def test_accommodate_value_no_max_size(self) -> None: """Test _accommodate_value early return when max_size is None.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( source_store, cache_store=cache_store, max_size=None, # No size limit ) # This should return early without doing anything await cached_store._accommodate_value(1000000) # Large value # Should not affect anything since max_size is None info = cached_store.cache_info() assert info["current_size"] == 0 async def test_concurrent_set_operations(self) -> None: """Test that concurrent set operations don't corrupt cache size tracking.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=1000) # Create 10 concurrent set operations async def set_data(key: str) -> None: data = CPUBuffer.from_bytes(b"x" * 50) await cached_store.set(key, data) # Run concurrently await asyncio.gather(*[set_data(f"key_{i}") for i in range(10)]) info = cached_store.cache_info() # Expected: 10 keys * 50 bytes = 500 bytes assert info["cached_keys"] == 10 assert info["current_size"] == 500 # WOULD FAIL due to race condition async def test_concurrent_eviction_race(self) -> None: """Test concurrent evictions don't corrupt size tracking.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=200) # Fill cache to near capacity data = CPUBuffer.from_bytes(b"x" * 80) await cached_store.set("key1", data) await cached_store.set("key2", data) # Now trigger two concurrent sets that both need to evict async def set_large(key: str) -> None: large_data = CPUBuffer.from_bytes(b"y" * 100) await cached_store.set(key, large_data) await asyncio.gather(set_large("key3"), set_large("key4")) info = cached_store.cache_info() # Size should be consistent with tracked keys assert info["current_size"] <= 200 # Might pass # But verify actual cache store size matches tracking total_size = sum( cached_store._state.key_sizes.get(k, 0) for k in cached_store._state.cache_order ) assert total_size == info["current_size"] # WOULD FAIL async def test_concurrent_get_and_evict(self) -> None: """Test get operations during eviction don't cause corruption.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=100) # Setup data = CPUBuffer.from_bytes(b"x" * 40) await cached_store.set("key1", data) await cached_store.set("key2", data) # Concurrent: read key1 while adding key3 (triggers eviction) async def read_key() -> None: for _ in range(100): await cached_store.get("key1", default_buffer_prototype()) async def write_key() -> None: for i in range(10): new_data = CPUBuffer.from_bytes(b"y" * 40) await cached_store.set(f"new_{i}", new_data) await asyncio.gather(read_key(), write_key()) # Verify consistency info = cached_store.cache_info() assert info["current_size"] <= 100 assert len(cached_store._state.cache_order) == len(cached_store._state.key_sizes) async def test_eviction_actually_deletes_from_cache_store(self) -> None: """Test that eviction removes keys from cache_store, not just tracking.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=100) # Add data that will be evicted data1 = CPUBuffer.from_bytes(b"x" * 60) data2 = CPUBuffer.from_bytes(b"y" * 60) await cached_store.set("key1", data1) # Verify key1 is in cache_store assert await cache_store.exists("key1") # Add key2, which should evict key1 await cached_store.set("key2", data2) # Check tracking - key1 should be removed assert "key1" not in cached_store._state.cache_order assert "key1" not in cached_store._state.key_sizes # CRITICAL: key1 should also be removed from cache_store assert not await cache_store.exists("key1"), ( "Evicted key still exists in cache_store! _evict_key doesn't actually delete." ) # But key1 should still exist in source store assert await source_store.exists("key1") async def test_eviction_no_orphaned_keys(self) -> None: """Test that eviction doesn't leave orphaned keys in cache_store.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=150) # Add multiple keys that will cause evictions for i in range(10): data = CPUBuffer.from_bytes(b"x" * 60) await cached_store.set(f"key_{i}", data) # Check tracking info = cached_store.cache_info() tracked_keys = info["cached_keys"] # Count actual keys in cache_store actual_keys = 0 async for _ in cache_store.list(): actual_keys += 1 # Cache store should have same number of keys as tracking assert actual_keys == tracked_keys, ( f"Cache store has {actual_keys} keys but tracking shows {tracked_keys}. " f"Eviction doesn't delete from cache_store!" ) async def test_size_accounting_with_key_updates(self) -> None: """Test that updating the same key replaces size instead of accumulating.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=500) # Set initial value data1 = CPUBuffer.from_bytes(b"x" * 100) await cached_store.set("same_key", data1) info1 = cached_store.cache_info() assert info1["current_size"] == 100 # Update with different size data2 = CPUBuffer.from_bytes(b"y" * 200) await cached_store.set("same_key", data2) info2 = cached_store.cache_info() # Should be 200, not 300 (update replaces, doesn't accumulate) assert info2["current_size"] == 200, ( f"Expected size 200 but got {info2['current_size']}. " "Updating same key should replace, not accumulate." ) async def test_all_tracked_keys_exist_in_cache_store(self) -> None: """Test invariant: all keys in tracking should exist in cache_store.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(source_store, cache_store=cache_store, max_size=500) # Add some data for i in range(5): data = CPUBuffer.from_bytes(b"x" * 50) await cached_store.set(f"key_{i}", data) # Every str key in tracking should exist in cache_store # (tuple keys are byte-range entries stored in-memory, not in the Store) for entry_key in cached_store._state.cache_order: if isinstance(entry_key, str): assert await cache_store.exists(entry_key), ( f"Key '{entry_key}' is tracked but doesn't exist in cache_store" ) # Every str key in _key_sizes should exist in cache_store for entry_key in cached_store._state.key_sizes: if isinstance(entry_key, str): assert await cache_store.exists(entry_key), ( f"Key '{entry_key}' has size tracked but doesn't exist in cache_store" ) # Additional coverage tests for 100% coverage async def test_cache_store_requires_delete_support(self) -> None: """Test that CacheStore validates cache_store supports deletes.""" from unittest.mock import MagicMock # Create a mock store that doesn't support deletes source_store = MemoryStore() cache_store = MagicMock() cache_store.supports_deletes = False with pytest.raises(ValueError, match="does not support deletes"): CacheStore(store=source_store, cache_store=cache_store) async def test_evict_key_exception_handling_with_real_error( self, monkeypatch: pytest.MonkeyPatch ) -> None: """Test _evict_key exception handling when deletion fails.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store, max_size=100) # Set up a key in tracking buffer = CPUBuffer.from_bytes(b"test data") await cached_store.set("test_key", buffer) # Mock the cache delete to raise an exception async def failing_delete(key: str) -> None: raise RuntimeError("Simulated cache deletion failure") monkeypatch.setattr(cache_store, "delete", failing_delete) # Attempt to evict should raise the exception with pytest.raises(RuntimeError, match="Simulated cache deletion failure"): async with cached_store._state.lock: await cached_store._evict_key("test_key") async def test_cache_stats_method(self) -> None: """Test cache_stats method returns correct statistics.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store, max_size=1000) # Initially, stats should be zero stats = cached_store.cache_stats() assert stats["hits"] == 0 assert stats["misses"] == 0 assert stats["evictions"] == 0 assert stats["total_requests"] == 0 assert stats["hit_rate"] == 0.0 # Perform some operations buffer = CPUBuffer.from_bytes(b"x" * 100) # Write to source store directly to avoid affecting stats await source_store.set("key1", buffer) # First get is a miss (not in cache yet) result1 = await cached_store.get("key1", default_buffer_prototype()) assert result1 is not None # Second get is a hit (now in cache) result2 = await cached_store.get("key1", default_buffer_prototype()) assert result2 is not None stats = cached_store.cache_stats() assert stats["hits"] == 1 assert stats["misses"] == 1 assert stats["total_requests"] == 2 assert stats["hit_rate"] == 0.5 async def test_cache_stats_with_evictions(self) -> None: """Test cache_stats tracks evictions correctly.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( store=source_store, cache_store=cache_store, max_size=150, # Small size to force eviction ) # Add items that will trigger eviction buffer1 = CPUBuffer.from_bytes(b"x" * 100) buffer2 = CPUBuffer.from_bytes(b"y" * 100) await cached_store.set("key1", buffer1) await cached_store.set("key2", buffer2) # Should evict key1 stats = cached_store.cache_stats() assert stats["evictions"] == 1 def test_repr_method(self) -> None: """Test __repr__ returns useful string representation.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore( store=source_store, cache_store=cache_store, max_age_seconds=60, max_size=1024 ) repr_str = repr(cached_store) # Check that repr contains key information assert "CacheStore" in repr_str assert "max_age_seconds=60" in repr_str assert "max_size=1024" in repr_str assert "current_size=0" in repr_str assert "cached_keys=0" in repr_str async def test_cache_stats_zero_division_protection(self) -> None: """Test cache_stats handles zero requests correctly.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store) # With no requests, hit_rate should be 0.0 (not NaN or error) stats = cached_store.cache_stats() assert stats["hit_rate"] == 0.0 assert stats["total_requests"] == 0 async def test_byte_range_does_not_corrupt_cache(self) -> None: """Test that fetching a byte range does not store partial data under the full key. Reproduces https://github.com/zarr-developers/zarr-python/issues/3690: when a byte-range read populates the cache, subsequent reads of different ranges (or the full key) return wrong data. """ source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store) full_data = b"bar baz" await source_store.set("foo", CPUBuffer.from_bytes(full_data)) proto = default_buffer_prototype() # First read: byte range [0, 3) -> b"bar" bar = await cached_store.get("foo", proto, byte_range=RangeByteRequest(0, 3)) assert bar is not None assert bar.to_bytes() == b"bar" # Second read: different byte range [4, 7) -> b"baz" baz = await cached_store.get("foo", proto, byte_range=RangeByteRequest(4, 7)) assert baz is not None assert baz.to_bytes() == b"baz" # Third read: full key -> full data full = await cached_store.get("foo", proto) assert full is not None assert full.to_bytes() == full_data async def test_full_read_then_byte_range(self) -> None: """Test that a cached full read correctly serves subsequent byte-range requests.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store) full_data = b"hello world" await source_store.set("key", CPUBuffer.from_bytes(full_data)) proto = default_buffer_prototype() # Full read populates cache full = await cached_store.get("key", proto) assert full is not None assert full.to_bytes() == full_data # Byte-range reads should return the correct slices part = await cached_store.get("key", proto, byte_range=RangeByteRequest(0, 5)) assert part is not None assert part.to_bytes() == b"hello" part2 = await cached_store.get("key", proto, byte_range=RangeByteRequest(6, 11)) assert part2 is not None assert part2.to_bytes() == b"world" suffix = await cached_store.get("key", proto, byte_range=SuffixByteRequest(5)) assert suffix is not None assert suffix.to_bytes() == b"world" async def test_byte_range_set_then_read(self) -> None: """Test that data written via set() can be read back with byte ranges.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store) full_data = b"abcdefghij" await cached_store.set("key", CPUBuffer.from_bytes(full_data)) proto = default_buffer_prototype() # Byte-range reads from the cached data mid = await cached_store.get("key", proto, byte_range=RangeByteRequest(3, 7)) assert mid is not None assert mid.to_bytes() == b"defg" # Full read should still work full = await cached_store.get("key", proto) assert full is not None assert full.to_bytes() == full_data async def test_set_invalidates_cached_byte_ranges(self) -> None: """Test that set() invalidates previously cached byte-range entries.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store) proto = default_buffer_prototype() # Populate source and cache some byte ranges await source_store.set("key", CPUBuffer.from_bytes(b"old data!!")) r1 = await cached_store.get("key", proto, byte_range=RangeByteRequest(0, 3)) assert r1 is not None assert r1.to_bytes() == b"old" # Byte-range entry should be in range_cache assert ("key", RangeByteRequest(0, 3)) in cached_store._state.cache_order # Overwrite via set() — range entries must be invalidated await cached_store.set("key", CPUBuffer.from_bytes(b"NEW DATA!!")) # The old range entry should be gone from tracking and range_cache assert ("key", RangeByteRequest(0, 3)) not in cached_store._state.cache_order assert "key" not in cached_store._state.range_cache # A fresh byte-range read should return the new data r2 = await cached_store.get("key", proto, byte_range=RangeByteRequest(0, 3)) assert r2 is not None assert r2.to_bytes() == b"NEW" async def test_delete_invalidates_cached_byte_ranges(self) -> None: """Test that delete() removes previously cached byte-range entries.""" source_store = MemoryStore() cache_store = MemoryStore() cached_store = CacheStore(store=source_store, cache_store=cache_store) proto = default_buffer_prototype() # Populate and cache a byte range await source_store.set("key", CPUBuffer.from_bytes(b"hello world")) r = await cached_store.get("key", proto, byte_range=RangeByteRequest(0, 5)) assert r is not None assert r.to_bytes() == b"hello" assert ("key", RangeByteRequest(0, 5)) in cached_store._state.cache_order # Delete the key — range entries must be cleaned up await cached_store.delete("key") assert ("key", RangeByteRequest(0, 5)) not in cached_store._state.cache_order assert "key" not in cached_store._state.range_cache # Key is gone from source result = await cached_store.get("key", proto) assert result is None def test_cache_store_opts_out_of_sync_io() -> None: """`CacheStore` must not advertise sync IO capability. Its caching logic lives only in the async `get`/`set`/`delete` overrides, while the inherited `WrapperStore` sync methods delegate straight to the source store. If the fused codec pipeline took the sync fast path, writes and deletes would bypass the cache and later async reads would serve stale entries. The opt-out forces sync-capable consumers onto the async path, which keeps the cache coherent. """ from zarr.abc.store import _store_supports_sync_io from zarr.storage import MemoryStore cached = CacheStore(MemoryStore(), cache_store=MemoryStore()) assert _store_supports_sync_io(cached) is False async def test_cache_coherent_after_fused_pipeline_write() -> None: """Writing through the fused pipeline must not leave stale cache entries.""" import numpy as np import zarr from zarr.core.config import config as zarr_config from zarr.storage import MemoryStore source = MemoryStore() cached = CacheStore(source, cache_store=MemoryStore()) with zarr_config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): arr = zarr.create_array(cached, shape=(8,), chunks=(8,), dtype="int32", fill_value=0) arr[:] = np.arange(8, dtype="int32") np.testing.assert_array_equal(arr[:], np.arange(8)) # Overwrite, then read back through the same cached handle: the read # must observe the overwrite, not a cached copy of the first write. arr[:] = np.arange(100, 108, dtype="int32") np.testing.assert_array_equal(arr[:], np.arange(100, 108)) zarr-python-3.3.0/tests/test_fastpath_equivalence.py000066400000000000000000000425721523267620000227750ustar00rootroot00000000000000"""Property tests: every fast path must equal the general path. The codec pipelines contain fast paths that skip work whose result is known — the complete-chunk merge view, the vectorized whole-shard bulk decode, the scalar-broadcast write memoization, byte-range coalescing. Each is only safe if it produces results identical to the general path it bypasses. These tests pin that equivalence on randomized inputs, so a fast path that silently diverges (the bug class behind the bulk-decode endianness fix) fails here instead of corrupting data downstream. Convention for new fast paths: a fast path is "skip work whose result is known", never "a different algorithm" — and it ships with a property test in this module asserting equality with the general path. """ from __future__ import annotations from typing import Any import hypothesis.extra.numpy as npst import hypothesis.strategies as st import numpy as np from hypothesis import given, settings import zarr from zarr.abc.store import OffsetByteRequest, RangeByteRequest, SuffixByteRequest from zarr.codecs.bytes import BytesCodec from zarr.codecs.sharding import ShardingCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import Buffer as CPUBuffer from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.chunk_grids import ChunkGrid from zarr.core.chunk_utils import _merge_chunk_array from zarr.core.dtype import get_data_type_from_native_dtype from zarr.core.indexing import BasicIndexer from zarr.storage import MemoryStore _DTYPES = st.sampled_from(["uint8", "int16", "float32"]) def _spec(shape: tuple[int, ...], dtype: str, *, write_empty_chunks: bool = True) -> ArraySpec: zdtype = get_data_type_from_native_dtype(np.dtype(dtype)) return ArraySpec( shape=shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=write_empty_chunks), prototype=default_buffer_prototype(), ) # --------------------------------------------------------------------------- # _merge_chunk_array: the complete-chunk early return (a view of # value[out_selection]) must equal the general create/copy + setitem path. # --------------------------------------------------------------------------- @st.composite def _merge_cases(draw: st.DrawFn) -> tuple[np.ndarray, tuple[int, ...], tuple[slice, ...]]: ndim = draw(st.integers(1, 3)) chunk_shape = tuple(draw(st.integers(1, 5)) for _ in range(ndim)) n_blocks = draw(st.integers(1, 3)) dtype = draw(_DTYPES) # value spans n_blocks chunk-sized blocks along axis 0; out_selection picks one value_shape = (chunk_shape[0] * n_blocks, *chunk_shape[1:]) value = draw(npst.arrays(dtype=np.dtype(dtype), shape=value_shape)) block = draw(st.integers(0, n_blocks - 1)) out_selection = ( slice(block * chunk_shape[0], (block + 1) * chunk_shape[0]), *(slice(0, s) for s in chunk_shape[1:]), ) return value, chunk_shape, out_selection @settings(max_examples=200, deadline=None) @given(case=_merge_cases(), with_existing=st.booleans()) def test_merge_complete_chunk_equals_general_path( case: tuple[np.ndarray, tuple[int, ...], tuple[slice, ...]], with_existing: bool ) -> None: """The is_complete_chunk fast path (return a view of value[out_selection]) must produce exactly what the general merge path produces — and a complete write must be independent of any existing chunk content.""" value_np, chunk_shape, out_selection = case spec = _spec(chunk_shape, str(value_np.dtype)) value = CPUNDBuffer.from_numpy_array(value_np) chunk_selection = tuple(slice(0, s) for s in chunk_shape) existing = None if with_existing: existing = CPUNDBuffer.from_numpy_array(np.full(chunk_shape, 7, dtype=value_np.dtype)) fast = _merge_chunk_array(existing, value, out_selection, spec, chunk_selection, True, ()) general = _merge_chunk_array(existing, value, out_selection, spec, chunk_selection, False, ()) np.testing.assert_array_equal(fast.as_numpy_array(), general.as_numpy_array()) np.testing.assert_array_equal(fast.as_numpy_array(), value_np[out_selection]) # --------------------------------------------------------------------------- # _decode_full_shard_bulk_if_uncompressed: the vectorized dense-shard decode must equal the # general per-chunk decode (_decode_sync), across dtypes, endianness, write # orders, and index locations. This is the bug class of the historical # bulk-decode endianness fix. # --------------------------------------------------------------------------- @st.composite def _shard_cases(draw: st.DrawFn) -> dict[str, Any]: ndim = draw(st.integers(1, 2)) chunk_shape = tuple(draw(st.integers(1, 4)) for _ in range(ndim)) grid = tuple(draw(st.integers(1, 3)) for _ in range(ndim)) shard_shape = tuple(c * g for c, g in zip(chunk_shape, grid, strict=True)) dtype = draw(_DTYPES) data = draw(npst.arrays(dtype=np.dtype(dtype), shape=shard_shape)) return { "chunk_shape": chunk_shape, "shard_shape": shard_shape, "data": data, "endian": draw(st.sampled_from(["little", "big"])), "index_location": draw(st.sampled_from(["start", "end"])), "subchunk_write_order": draw( st.sampled_from(["morton", "lexicographic", "colexicographic", "unordered"]) ), } @settings(max_examples=100, deadline=None) @given(case=_shard_cases()) def test_bulk_shard_decode_equals_general_decode(case: dict[str, Any]) -> None: """For dense fixed-size uncompressed shards, the vectorized bulk decode must reproduce the general per-chunk decode exactly, whatever the endianness, subchunk write order, or index location.""" codec = ShardingCodec( chunk_shape=case["chunk_shape"], codecs=[BytesCodec(endian=case["endian"])], index_location=case["index_location"], subchunk_write_order=case["subchunk_write_order"], ) spec = _spec(case["shard_shape"], str(case["data"].dtype), write_empty_chunks=True) blob = codec._encode_sync(CPUNDBuffer.from_numpy_array(case["data"]), spec) assert blob is not None # write_empty_chunks=True -> dense, never elided general = codec._decode_sync(blob, spec) indexer = BasicIndexer( tuple(slice(0, s) for s in case["shard_shape"]), shape=case["shard_shape"], chunk_grid=ChunkGrid.from_sizes(case["shard_shape"], case["chunk_shape"]), ) bulk = codec._decode_full_shard_bulk_if_uncompressed(blob, spec, indexer) # the fast path must APPLY for this dense uncompressed configuration — # a vacuous None would silently stop testing the equivalence assert bulk is not None np.testing.assert_array_equal(bulk.as_numpy_array(), general.as_numpy_array()) np.testing.assert_array_equal(general.as_numpy_array(), case["data"]) def test_merge_complete_chunk_returns_view_and_write_does_not_mutate_source() -> None: """The complete-chunk merge fast path returns a VIEW of the caller's value (no copy — that is the perf win), and a multi-chunk write through either pipeline leaves the user's source array untouched. Pins both halves of the aliasing contract: a future "defensive copy" refactor that silently reintroduces the per-chunk create/fill/copy breaks the first assertion, and an in-place-mutating codec that corrupts the user's array through the shared view breaks the second. """ # the fast path must return a view aliasing `value`, not a copy value_np = np.arange(30, dtype="uint16") spec = _spec((10,), "uint16") value = CPUNDBuffer.from_numpy_array(value_np) merged = _merge_chunk_array(None, value, (slice(10, 20),), spec, (slice(0, 10),), True, ()) assert np.shares_memory(merged.as_numpy_array(), value_np), ( "complete-chunk merge no longer returns a view of the caller's value" ) # end-to-end: the source array is byte-identical after a multi-chunk write for pipeline_path in ( "zarr.core.codec_pipeline.FusedCodecPipeline", "zarr.core.codec_pipeline.BatchedCodecPipeline", ): with zarr.config.set({"codec_pipeline.path": pipeline_path}): arr = zarr.create_array( store=MemoryStore(), shape=(30,), chunks=(10,), dtype="uint16", compressors=None, fill_value=0, ) source = np.arange(30, dtype="uint16") snapshot = source.copy() arr[:] = source np.testing.assert_array_equal(source, snapshot, err_msg=pipeline_path) np.testing.assert_array_equal(arr[:], snapshot, err_msg=pipeline_path) # --------------------------------------------------------------------------- # Whole-shard bulk decode under arbitrary indexing: the bulk decode only fires # for an *identity full-shard* read (every dimension a whole-dim step-1 slice), # but it is reached through the partial-read path (`_decode_partial_sync`) for # any indexer. A reordering or duplicating coordinate/orthogonal selection can # have an output shape equal to the shard shape — trivially in 1-D (any # selection of `shard_len` points), and in >=2-D whenever an axis-0 index array # has exactly `shard_shape[0]` entries — and must NOT be served by the bulk # path in natural order; it must honor the selection. This pins the END-TO-END # read, which `test_bulk_shard_decode_equals_general_decode` (identity # BasicIndexer only) cannot reach. See the vindex- and # oindex-on-uncompressed-shard corruption bugs. # --------------------------------------------------------------------------- @st.composite def _uncompressed_shard_index_cases(draw: st.DrawFn) -> dict[str, Any]: ndim = draw(st.integers(1, 2)) chunk_shape = tuple(draw(st.integers(1, 4)) for _ in range(ndim)) grid = tuple(draw(st.integers(1, 4)) for _ in range(ndim)) shard_shape = tuple(c * g for c, g in zip(chunk_shape, grid, strict=True)) dtype = draw(_DTYPES) data = draw(npst.arrays(dtype=np.dtype(dtype), shape=shard_shape)) dim0 = shard_shape[0] # axis-0 index array sized to the dimension: either a permutation # (reordering, no duplicates) or an arbitrary list (duplicates likely) — # both keep the output shape equal to the shard shape. if draw(st.booleans()): idx = np.array(draw(st.permutations(list(range(dim0)))), dtype=np.intp) else: idx = np.array( draw(st.lists(st.integers(0, dim0 - 1), min_size=dim0, max_size=dim0)), dtype=np.intp, ) return { "chunk_shape": chunk_shape, "shard_shape": shard_shape, "data": data, "idx": idx, "endian": draw(st.sampled_from(["little", "big"])), "index_location": draw(st.sampled_from(["start", "end"])), "subchunk_write_order": draw( st.sampled_from(["morton", "lexicographic", "colexicographic", "unordered"]) ), } @settings(max_examples=200, deadline=None) @given(case=_uncompressed_shard_index_cases()) def test_reordering_read_on_uncompressed_shard_honors_selection(case: dict[str, Any]) -> None: """A reordering or duplicating fancy/vindex/oindex read over a full uncompressed shard must return the selected data, not the shard in natural order — under the Fused pipeline (where the bulk-decode fast path engages) exactly as under numpy.""" idx = case["idx"] data = case["data"] ndim = data.ndim serializer = BytesCodec(endian=case["endian"]) with zarr.config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): arr = zarr.create_array( store=MemoryStore(), shape=case["shard_shape"], chunks=case["chunk_shape"], shards={"shape": case["shard_shape"], "index_location": case["index_location"]}, dtype=data.dtype, serializer=serializer, compressors=None, filters=None, fill_value=0, ) arr[...] = data # axis-0 index array (rest full slices): an OrthogonalIndexer whose # output shape equals the shard shape but which reorders/duplicates rows. rest = (slice(None),) * (ndim - 1) np.testing.assert_array_equal(arr[(idx, *rest)], data[idx]) np.testing.assert_array_equal(arr.oindex[(idx, *rest)], data[idx]) if ndim == 1: # coordinate selection: flattened point count == shard shape. np.testing.assert_array_equal(arr.vindex[idx], data[idx]) else: # 2-D broadcast index arrays: full-coverage coordinate selection # whose shape equals the shard shape. cols = np.arange(case["shard_shape"][1]) np.testing.assert_array_equal( arr.vindex[idx[:, None], cols[None, :]], data[idx[:, None], cols[None, :]] ) # --------------------------------------------------------------------------- # Scalar-broadcast write memoization: writing a scalar must produce the same # STORED BYTES as writing the equivalent broadcast array. # --------------------------------------------------------------------------- @st.composite def _scalar_cases(draw: st.DrawFn) -> dict[str, Any]: n_chunks = draw(st.integers(2, 6)) chunk = draw(st.integers(2, 6)) shape = n_chunks * chunk start = draw(st.integers(0, shape - 1)) stop = draw(st.integers(start + 1, shape)) return { "shape": shape, "chunk": chunk, "sel": slice(start, stop), "scalar": draw(st.integers(0, 255)), "write_empty_chunks": draw(st.booleans()), "sharded": draw(st.booleans()), } @settings(max_examples=100, deadline=None) @given(case=_scalar_cases()) def test_scalar_write_equals_broadcast_write(case: dict[str, Any]) -> None: """arr[sel] = scalar and arr[sel] = full(sel_shape, scalar) must leave the store byte-identical (pins the scalar-broadcast memoization in the sharded partial-write path, incl. its empty-chunk normalization).""" def build() -> tuple[MemoryStore, zarr.Array[Any]]: store = MemoryStore() arr = zarr.create_array( store=store, shape=(case["shape"],), chunks=(case["chunk"],), shards=(case["shape"],) if case["sharded"] else None, dtype="uint8", compressors=None, fill_value=0, config={"write_empty_chunks": case["write_empty_chunks"]}, ) return store, arr # The scalar-broadcast memoization lives in the Fused sync write path; pin it # explicitly since Fused is no longer the default pipeline. with zarr.config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): store_a, arr_a = build() arr_a[case["sel"]] = case["scalar"] store_b, arr_b = build() n = case["sel"].stop - case["sel"].start arr_b[case["sel"]] = np.full(n, case["scalar"], dtype="uint8") keys_a = {k: bytes(v.to_bytes()) for k, v in store_a._store_dict.items()} keys_b = {k: bytes(v.to_bytes()) for k, v in store_b._store_dict.items()} assert keys_a == keys_b # --------------------------------------------------------------------------- # get_ranges_sync coalescing: merged fetches must return exactly what # individual per-range gets return, for any gap/coalesce limits. # --------------------------------------------------------------------------- @st.composite def _range_cases(draw: st.DrawFn) -> dict[str, Any]: blob_len = draw(st.integers(1, 200)) n = draw(st.integers(1, 8)) ranges: list[RangeByteRequest | OffsetByteRequest | SuffixByteRequest | None] = [] for _ in range(n): kind = draw(st.sampled_from(["range", "offset", "suffix", "none"])) if kind == "range": start = draw(st.integers(0, blob_len - 1)) end = draw(st.integers(start + 1, blob_len)) ranges.append(RangeByteRequest(start, end)) elif kind == "offset": ranges.append(OffsetByteRequest(draw(st.integers(0, blob_len - 1)))) elif kind == "suffix": ranges.append(SuffixByteRequest(draw(st.integers(1, blob_len)))) else: ranges.append(None) return { "blob": draw(st.binary(min_size=blob_len, max_size=blob_len)), "ranges": ranges, "max_gap": draw(st.integers(0, 64)), "max_coalesced": draw(st.integers(1, 512)), } @settings(max_examples=200, deadline=None) @given(case=_range_cases()) def test_get_ranges_sync_equals_individual_gets(case: dict[str, Any]) -> None: """Coalesced byte-range reads must return exactly what one get_sync per range returns — for any gap/coalesce limits (the offset re-slicing math is where a coalescing bug would corrupt data).""" store = MemoryStore() store._is_open = True proto = default_buffer_prototype() store._store_dict["k"] = CPUBuffer.from_bytes(case["blob"]) expected = [store.get_sync("k", prototype=proto, byte_range=r) for r in case["ranges"]] got: dict[int, bytes | None] = {} for idx, buf in store.get_ranges_sync( "k", case["ranges"], prototype=proto, max_gap_bytes=case["max_gap"], max_coalesced_bytes=case["max_coalesced"], ): got[idx] = None if buf is None else bytes(buf.to_bytes()) for i, exp in enumerate(expected): exp_bytes = None if exp is None else bytes(exp.to_bytes()) assert got.get(i) == exp_bytes, f"range {i} ({case['ranges'][i]!r}) mismatch" zarr-python-3.3.0/tests/test_fused_pipeline.py000066400000000000000000001403621523267620000215710ustar00rootroot00000000000000"""Tests for FusedCodecPipeline -- the per-chunk-fused codec pipeline.""" from __future__ import annotations import asyncio from dataclasses import dataclass, field, replace from typing import TYPE_CHECKING, Any import numpy as np import pytest import zarr from zarr.abc.codec import ( ArrayBytesCodec, ArrayBytesCodecPartialDecodeMixin, ArrayBytesCodecPartialEncodeMixin, BytesBytesCodec, ) from zarr.abc.store import Store, _store_supports_sync_io from zarr.codecs.bytes import BytesCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.transpose import TransposeCodec from zarr.codecs.zstd import ZstdCodec from zarr.core.codec_pipeline import FusedCodecPipeline from zarr.core.config import config as zarr_config from zarr.registry import register_codec from zarr.storage import MemoryStore, StorePath, WrapperStore from zarr.storage._utils import _normalize_byte_range_index from zarr.testing.store import LatencyStore if TYPE_CHECKING: from collections.abc import AsyncIterator, Callable, Iterable from zarr.abc.store import ByteRequest from zarr.core.array_spec import ArraySpec from zarr.core.buffer import Buffer, BufferPrototype, NDBuffer @pytest.mark.parametrize( "codecs", [ (BytesCodec(),), (BytesCodec(), GzipCodec(level=1)), (BytesCodec(), ZstdCodec(level=1)), (TransposeCodec(order=(1, 0)), BytesCodec()), (TransposeCodec(order=(1, 0)), BytesCodec(), ZstdCodec(level=1)), ], ids=["bytes-only", "gzip", "zstd", "transpose", "transpose+zstd"], ) def test_construction(codecs: tuple[Any, ...]) -> None: """FusedCodecPipeline can be constructed from valid codec combinations.""" pipeline = FusedCodecPipeline.from_codecs(codecs) assert pipeline.codecs == codecs def test_sync_api_compute_off_event_loop(monkeypatch: pytest.MonkeyPatch) -> None: """Codec compute must never run on the thread driving the event loop. Every sync-API call, from every user thread, is serviced by the one global `zarr_io` event loop. Running decode/encode inline on that loop's thread turns it into a mutex around codec compute: concurrent readers serialize, and the penalty grows with codec cost (observed as "fused pipeline is slower for zstd data" under dask-style multi-threaded single-chunk reads). """ import asyncio from zarr.core.chunk_utils import ChunkTransform compute_on_loop = {"decode": False, "encode": False} calls = {"decode": 0, "encode": 0} real_decode = ChunkTransform.decode_chunk real_encode = ChunkTransform.encode_chunk def _running_loop() -> bool: try: asyncio.get_running_loop() except RuntimeError: return False return True def traced_decode(self: ChunkTransform, chunk_bytes: Any, chunk_spec: Any) -> Any: calls["decode"] += 1 compute_on_loop["decode"] = compute_on_loop["decode"] or _running_loop() return real_decode(self, chunk_bytes, chunk_spec) def traced_encode(self: ChunkTransform, chunk_array: Any, chunk_spec: Any) -> Any: calls["encode"] += 1 compute_on_loop["encode"] = compute_on_loop["encode"] or _running_loop() return real_encode(self, chunk_array, chunk_spec) monkeypatch.setattr(ChunkTransform, "decode_chunk", traced_decode) monkeypatch.setattr(ChunkTransform, "encode_chunk", traced_encode) with zarr_config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): arr = zarr.create_array( MemoryStore(), shape=(8, 8), chunks=(4, 4), dtype="float64", compressors=ZstdCodec(level=1), ) data = np.arange(64, dtype="float64").reshape(8, 8) arr[:4, :4] = data[:4, :4] # single-chunk write (batch of 1) arr[:] = data # multi-chunk write # Guard against vacuity: if the sync fast path stops triggering, the # traced ChunkTransform methods are never called (the async fallback # uses AsyncChunkTransform) and the on-loop flags stay trivially False. assert calls["encode"] > 0 assert compute_on_loop["encode"] is False np.testing.assert_array_equal(arr[:4, :4], data[:4, :4]) # single-chunk read np.testing.assert_array_equal(arr[:], data) # multi-chunk read assert calls["decode"] > 0 assert compute_on_loop["decode"] is False def test_evolve_from_array_spec() -> None: """evolve_from_array_spec creates a sync transform.""" from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import get_data_type_from_native_dtype pipeline = FusedCodecPipeline.from_codecs((BytesCodec(),)) assert pipeline.sync_transform is None zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec = ArraySpec( shape=(100,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) evolved = pipeline.evolve_from_array_spec(spec) assert evolved.sync_transform is not None # --------------------------------------------------------------------------- # Sync path tests # # These exercise FusedCodecPipeline's synchronous API (write_sync / read_sync / # sync_transform), which has no equivalent on BatchedCodecPipeline -- so they # cannot live in the pipeline-agnostic CodecPipelineTests suite. The async # roundtrip / fill-value behaviour is covered there (test_scenario) across both # pipelines and sync/async stores. # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("dtype", "shape"), [ ("float64", (100,)), ("float32", (50,)), ("int32", (200,)), ("float64", (10, 10)), ], ids=["f64-1d", "f32-1d", "i32-1d", "f64-2d"], ) def test_read_write_sync_roundtrip(dtype: str, shape: tuple[int, ...]) -> None: """Data written via write_sync can be read back via read_sync.""" from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.dtype import get_data_type_from_native_dtype store = MemoryStore() zdtype = get_data_type_from_native_dtype(np.dtype(dtype)) spec = ArraySpec( shape=shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) pipeline = FusedCodecPipeline.from_codecs((BytesCodec(),)) pipeline = pipeline.evolve_from_array_spec(spec) data = np.arange(int(np.prod(shape)), dtype=dtype).reshape(shape) value = CPUNDBuffer.from_numpy_array(data) chunk_selection = tuple(slice(0, s) for s in shape) out_selection = chunk_selection store_path = StorePath(store, "c/0") # Write sync pipeline.write_sync( [(store_path, spec, chunk_selection, out_selection, True)], value, ) # Read sync out = CPUNDBuffer.from_numpy_array(np.zeros(shape, dtype=dtype)) pipeline.read_sync( [(store_path, spec, chunk_selection, out_selection, True)], out, ) np.testing.assert_array_equal(data, out.as_numpy_array()) def test_read_sync_missing_chunk_fills() -> None: """Sync read of a missing chunk fills with the fill value.""" from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.dtype import get_data_type_from_native_dtype store = MemoryStore() zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec = ArraySpec( shape=(10,), dtype=zdtype, fill_value=zdtype.cast_scalar(42.0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) pipeline = FusedCodecPipeline.from_codecs((BytesCodec(),)) pipeline = pipeline.evolve_from_array_spec(spec) out = CPUNDBuffer.from_numpy_array(np.zeros(10, dtype="float64")) store_path = StorePath(store, "c/0") chunk_sel = (slice(0, 10),) pipeline.read_sync( [(store_path, spec, chunk_sel, chunk_sel, True)], out, ) np.testing.assert_array_equal(out.as_numpy_array(), np.full(10, 42.0)) def test_sync_write_async_read_roundtrip() -> None: """Data written via write_sync can be read back via async read.""" from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.dtype import get_data_type_from_native_dtype from zarr.core.sync import sync store = MemoryStore() zdtype = get_data_type_from_native_dtype(np.dtype("float64")) spec = ArraySpec( shape=(100,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) pipeline = FusedCodecPipeline.from_codecs((BytesCodec(),)) pipeline = pipeline.evolve_from_array_spec(spec) data = np.arange(100, dtype="float64") value = CPUNDBuffer.from_numpy_array(data) chunk_sel = (slice(0, 100),) store_path = StorePath(store, "c/0") # Write sync pipeline.write_sync( [(store_path, spec, chunk_sel, chunk_sel, True)], value, ) # Read async out = CPUNDBuffer.from_numpy_array(np.zeros(100, dtype="float64")) sync( pipeline.read( [(store_path, spec, chunk_sel, chunk_sel, True)], out, ) ) def test_chunk_transform_uses_runtime_prototype() -> None: """ChunkTransform must pass each codec the prototype from the runtime chunk_spec, not one captured at evolve time. Constructs ChunkTransform directly (a Fused-internal data structure with no BatchedCodecPipeline equivalent). """ from zarr.abc.codec import BytesBytesCodec from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import BufferPrototype, default_buffer_prototype from zarr.core.chunk_utils import ChunkTransform from zarr.core.dtype import get_data_type_from_native_dtype class _PrototypeRecordingCodec(BytesBytesCodec): # type: ignore[misc,unused-ignore] """A no-op BB codec that records the prototype it was called with.""" is_fixed_size = True seen_prototypes: list[object] def __init__(self) -> None: object.__setattr__(self, "seen_prototypes", []) def to_dict(self) -> dict[str, Any]: return {"name": "_prototype_recording", "configuration": {}} @classmethod def from_dict(cls, data: dict[str, Any]) -> _PrototypeRecordingCodec: return cls() def compute_encoded_size(self, input_byte_length: int, _spec: ArraySpec) -> int: return input_byte_length def _encode_sync(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> Buffer | None: self.seen_prototypes.append(chunk_spec.prototype) return chunk_bytes def _decode_sync(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> Buffer: self.seen_prototypes.append(chunk_spec.prototype) return chunk_bytes async def _encode_single(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> Buffer | None: return self._encode_sync(chunk_bytes, chunk_spec) async def _decode_single(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> Buffer: return self._decode_sync(chunk_bytes, chunk_spec) recording = _PrototypeRecordingCodec() transform = ChunkTransform(codecs=(BytesCodec(), recording)) zdtype = get_data_type_from_native_dtype(np.dtype("float64")) def _spec(prototype: BufferPrototype) -> ArraySpec: return ArraySpec( shape=(10,), dtype=zdtype, fill_value=zdtype.cast_scalar(0.0), config=ArrayConfig(order="C", write_empty_chunks=False), prototype=prototype, ) proto_default = default_buffer_prototype() # A distinct BufferPrototype instance with the same buffer/nd_buffer types -- # fails an identity check but works at runtime. proto_other = BufferPrototype(buffer=proto_default.buffer, nd_buffer=proto_default.nd_buffer) assert proto_other is not proto_default arr = proto_default.nd_buffer.from_numpy_array(np.arange(10, dtype="float64")) transform.encode_chunk(arr, _spec(proto_default)) transform.encode_chunk(arr, _spec(proto_other)) assert recording.seen_prototypes[0] is proto_default assert recording.seen_prototypes[1] is proto_other, ( "ChunkTransform did not pass the runtime prototype to the codec" ) # --------------------------------------------------------------------------- # Thread-pool (max_workers > 1) tests # # The pool dispatch in read_sync/write_sync is Fused-only and off by default # (codec_pipeline.max_workers defaults to 1 == sequential). These tests opt in # and exercise the pool path end-to-end, exception propagation from workers, # and concurrent decode through the shared ChunkTransform. # --------------------------------------------------------------------------- _FUSED_POOL_CONFIG = { "codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline", "codec_pipeline.max_workers": 4, } def test_read_write_with_thread_pool() -> None: """With max_workers > 1, multi-chunk reads and writes dispatch through the thread pool (pool.map in read_sync/write_sync) and produce the same results as sequential execution. The `_get_pool` spy pins that the pool branch actually fires: without it, a config-resolution regression (renamed key, `_resolve_max_workers` returning 1) would silently degrade all the pool tests into re-testing the sequential branch while staying green. """ from unittest.mock import patch import zarr.core.codec_pipeline as cp_mod with zarr_config.set(_FUSED_POOL_CONFIG): assert cp_mod._resolve_max_workers() == 4, ( "codec_pipeline.max_workers config did not reach _resolve_max_workers" ) store = MemoryStore() arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), dtype="float64", compressors=None, fill_value=0.0, ) assert isinstance(arr._async_array.codec_pipeline, FusedCodecPipeline) data = np.arange(100, dtype="float64") with patch.object(cp_mod, "_get_pool", wraps=cp_mod._get_pool) as pool_spy: arr[:] = data # 10 chunks -> pool dispatch in write_sync assert pool_spy.call_count >= 1, "multi-chunk write did not take the pool branch" writes = pool_spy.call_count np.testing.assert_array_equal(arr[:], data) # pool dispatch in read_sync assert pool_spy.call_count > writes, "multi-chunk read did not take the pool branch" arr[5:25] = 7.0 # partial write: merge path through the pool data[5:25] = 7.0 np.testing.assert_array_equal(arr[:], data) def test_thread_pool_write_worker_exception_propagates() -> None: """A store error raised inside a pool worker during write_sync surfaces to the caller (write_sync consumes pool.map, so worker exceptions re-raise).""" from unittest.mock import patch with zarr_config.set(_FUSED_POOL_CONFIG): store = MemoryStore() arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), dtype="float64", compressors=None, fill_value=0.0, ) with ( patch.object(store, "set_sync", side_effect=RuntimeError("simulated store error")), pytest.raises(RuntimeError, match="simulated store error"), ): arr[:] = np.arange(100, dtype="float64") def test_thread_pool_read_worker_exception_propagates() -> None: """A store error raised inside a pool worker during read_sync surfaces to the caller (read_sync consumes pool.map into a tuple).""" from unittest.mock import patch with zarr_config.set(_FUSED_POOL_CONFIG): store = MemoryStore() arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), dtype="float64", compressors=None, fill_value=0.0, ) arr[:] = np.arange(100, dtype="float64") with ( patch.object(store, "get_sync", side_effect=RuntimeError("simulated store error")), pytest.raises(RuntimeError, match="simulated store error"), ): arr[:] def test_resolve_max_workers_warns_and_falls_back_on_invalid_config() -> None: """`codec_pipeline.max_workers` arrives via the config/env layer (e.g. `ZARR_CODEC_PIPELINE__MAX_WORKERS`), so garbage input should warn and fall back to the default rather than raising mid-read. """ import os import zarr.core.codec_pipeline as cp_mod from zarr.errors import ZarrUserWarning default = os.cpu_count() or 1 with zarr_config.set({"codec_pipeline.max_workers": "fast"}): with pytest.warns(ZarrUserWarning, match="max_workers"): result = cp_mod._resolve_max_workers() assert result == default async def test_encode_and_write_as_completed_cancels_stray_writes_on_failure() -> None: """A failing write must not leave sibling writes running in the background. `_encode_and_write_as_completed` fires one write task per chunk as soon as its encode completes, then `gather`s them. Plain `gather` (without `return_exceptions=True`) re-raises the first exception without cancelling the other in-flight tasks, so a still-running write would keep going after the caller has already seen the exception -- and its eventual outcome is never retrieved (an unraisable "Task exception was never retrieved" warning if it later fails). """ from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.chunk_utils import ChunkTransform from zarr.core.codec_pipeline import _encode_and_write_as_completed from zarr.core.dtype import get_data_type_from_native_dtype write_started = asyncio.Event() write_finished = False class _SlowByteSetter: async def get( self, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: return None async def set(self, value: Buffer) -> None: nonlocal write_finished write_started.set() await asyncio.sleep(0.2) write_finished = True async def delete(self) -> None: pass async def set_if_not_exists(self, default: Buffer) -> None: pass class _FailingByteSetter: async def get( self, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: return None async def set(self, value: Buffer) -> None: raise RuntimeError("simulated write failure") async def delete(self) -> None: pass async def set_if_not_exists(self, default: Buffer) -> None: pass zdtype = get_data_type_from_native_dtype(np.dtype("uint8")) chunk_spec = ArraySpec( shape=(1,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) chunk_array = CPUNDBuffer.from_numpy_array(np.zeros(1, dtype="uint8")) transform = ChunkTransform(codecs=(BytesCodec(),)) batch = [ (_SlowByteSetter(), chunk_array, chunk_spec), (_FailingByteSetter(), chunk_array, chunk_spec), ] with pytest.raises(RuntimeError, match="simulated write failure"): await _encode_and_write_as_completed(batch, transform) # type: ignore[arg-type] assert write_started.is_set() # Give the slow write's sleep long enough to finish if it were left # running unattended in the background instead of being cancelled. await asyncio.sleep(0.3) assert not write_finished, "the slow write should have been cancelled, not left running" def test_concurrent_reads_shared_transform_with_pool() -> None: """Concurrent decode through the shared ChunkTransform produces correct data. The transform's `_resolve_specs` cache is shared mutable state. With no array->array codecs the cache is bypassed entirely, so this uses a transpose filter to force cache traffic, max_workers=4 so pool workers decode chunks concurrently, and an outer thread pool so multiple reads are in flight at once. Each round RE-OPENS the array so the shared transform starts with a cold spec cache and the concurrent readers race the non-atomic first fill — reading through a single pre-warmed handle would only ever exercise cache hits. This pins correctness under concurrency (it cannot prove the absence of a race, but a torn cache would corrupt results here). """ from concurrent.futures import ThreadPoolExecutor with zarr_config.set(_FUSED_POOL_CONFIG): store = MemoryStore() arr = zarr.create_array( store=store, shape=(40, 40), chunks=(5, 5), dtype="int32", filters=[TransposeCodec(order=(1, 0))], serializer=BytesCodec(), compressors=None, fill_value=-1, ) data = np.arange(1600, dtype="int32").reshape(40, 40) arr[:] = data for _ in range(5): # several rounds, each racing a cold cache fresh = zarr.open_array(store=store, mode="r") def read_row_block(i: int, handle: zarr.Array[Any] = fresh) -> np.ndarray: return np.asarray(handle[i * 4 : (i + 1) * 4, :]) with ThreadPoolExecutor(max_workers=8) as ex: futures = {ex.submit(read_row_block, i): i for i in range(10)} for fut, i in futures.items(): np.testing.assert_array_equal(fut.result(), data[i * 4 : (i + 1) * 4, :]) def test_shared_transform_decode_alternating_specs() -> None: """A single ChunkTransform must decode chunks of DIFFERENT specs correctly when calls alternate, exercising eviction/refill of its single-entry `_resolve_specs` cache. The two specs differ in shape, so each call evicts the other's cached entry. A transpose filter forces the cache to be used (with no AA codec the cache is bypassed). The cache entry is stored as one atomic tuple precisely so a concurrent reader can never observe a key paired with another spec's resolved chain; this test pins the sequential eviction/refill correctness that underpins that guarantee. (The concurrent counterpart is `test_concurrent_reads_shared_transform_with_pool`.) """ from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.chunk_utils import ChunkTransform from zarr.core.dtype import get_data_type_from_native_dtype def _spec(shape: tuple[int, ...]) -> ArraySpec: zdtype = get_data_type_from_native_dtype(np.dtype("int32")) return ArraySpec( shape=shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) transform = ChunkTransform(codecs=(TransposeCodec(order=(1, 0)), BytesCodec())) # two distinct specs (different shapes) sharing the one transform + cache slot cases = [] for shape in [(5, 7), (3, 11)]: spec = _spec(shape) arr = np.arange(int(np.prod(shape)), dtype="int32").reshape(shape) encoded = transform.encode_chunk(CPUNDBuffer.from_numpy_array(arr), spec) assert encoded is not None cases.append((spec, encoded, arr)) # Alternate specs so every call evicts and refills the single cache slot. for i in range(20): spec, encoded, expected = cases[i % len(cases)] got = transform.decode_chunk(encoded, spec).as_numpy_array() np.testing.assert_array_equal(got, expected) def test_sharded_fallback_inner_chunks_avoid_async_transform() -> None: """Inner chunks of a shard on a NON-sync store decode through the sync ChunkTransform, not per-chunk AsyncChunkTransform coroutines. The sharding byte getters are in-memory dict wrappers; they implement SyncByteGetter/SyncByteSetter, and the nested inner pipeline is evolved (so its sync transform exists), letting the nested read/write take the sync fast path. Without this, every inner chunk pays a coroutine for a dict lookup plus an async per-chunk transform — measured at 1.5x (raw) to 3.6x (gzip) of sharded fallback read time. """ from unittest.mock import patch from zarr.core.codec_pipeline import AsyncChunkTransform from zarr.testing.store import LatencyStore calls = {"decode": 0, "encode": 0} orig_decode = AsyncChunkTransform.decode_chunk orig_encode = AsyncChunkTransform.encode_chunk async def spy_decode(self: Any, *args: Any, **kwargs: Any) -> Any: calls["decode"] += 1 return await orig_decode(self, *args, **kwargs) async def spy_encode(self: Any, *args: Any, **kwargs: Any) -> Any: calls["encode"] += 1 return await orig_encode(self, *args, **kwargs) # LatencyStore is not sync-capable -> the OUTER pipeline takes the async # fallback; the INNER chunks go over the sharding byte getters. store = LatencyStore(MemoryStore(), get_latency=0.0, set_latency=0.0) arr = zarr.create_array( store=store, shape=(100,), chunks=(10,), shards=(50,), dtype="uint8", compressors=None, fill_value=0, ) if not isinstance(arr._async_array.codec_pipeline, FusedCodecPipeline): pytest.skip("sync fast path for inner chunks is specific to FusedCodecPipeline") data = np.arange(100, dtype="uint8") sync_calls = {"read_sync": 0} orig_read_sync = FusedCodecPipeline.read_sync def spy_read_sync(self: Any, *args: Any, **kwargs: Any) -> Any: sync_calls["read_sync"] += 1 return orig_read_sync(self, *args, **kwargs) with ( patch.object(AsyncChunkTransform, "decode_chunk", spy_decode), patch.object(AsyncChunkTransform, "encode_chunk", spy_encode), patch.object(FusedCodecPipeline, "read_sync", spy_read_sync), ): arr[:] = data out = np.asarray(arr[:]) np.testing.assert_array_equal(out, data) assert calls == {"decode": 0, "encode": 0}, ( f"inner chunks went through per-chunk AsyncChunkTransform coroutines: {calls}" ) # The outer store is not sync-capable, so any read_sync calls are the # NESTED pipeline taking the sync fast path over the sharding byte getters # (the SyncByteGetter gate). Without the gate, inner chunks go through # concurrent_map with one coroutine per chunk. (Writes don't appear here: # the fallback write encodes whole shards through the outer sync transform # -> ShardingCodec._encode_sync, never touching the nested byte setters.) assert sync_calls["read_sync"] >= 1, "nested read did not take the sync fast path" def test_write_over_sync_byte_setter_takes_sync_path() -> None: """`FusedCodecPipeline.write` routes a non-StorePath `SyncByteSetter` (the sharding codec's `_ShardingByteSetter`) through `write_sync`. This is the write-side twin of the SyncByteGetter gate: the read test above cannot guard it because fallback whole-array writes encode shards via `_encode_sync` and never touch the nested byte setters. The nested `write` over `_ShardingByteSetter` is reached from the async shard encode paths (`_encode_single`/`_encode_partial_single`), so pin the gate directly: without it, this write degrades to the async fallback (one coroutine per inner chunk for an in-memory dict store). """ import asyncio from unittest.mock import patch from zarr.codecs.sharding import _ShardingByteSetter from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.dtype import get_data_type_from_native_dtype zdtype = get_data_type_from_native_dtype(np.dtype("uint8")) spec = ArraySpec( shape=(10,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) pipeline = FusedCodecPipeline.from_codecs([BytesCodec()]).evolve_from_array_spec(spec) assert pipeline.sync_transform is not None shard_dict: dict[tuple[int, ...], Any] = {} setter = _ShardingByteSetter(shard_dict, (0,)) value = default_buffer_prototype().nd_buffer.from_numpy_array(np.arange(10, dtype="uint8")) sync_calls = {"write_sync": 0} orig_write_sync = FusedCodecPipeline.write_sync def spy_write_sync(self: Any, *args: Any, **kwargs: Any) -> Any: sync_calls["write_sync"] += 1 return orig_write_sync(self, *args, **kwargs) sel = (slice(0, 10),) with patch.object(FusedCodecPipeline, "write_sync", spy_write_sync): asyncio.run(pipeline.write([(setter, spec, sel, sel, True)], value)) assert sync_calls["write_sync"] >= 1, ( "write over a SyncByteSetter did not take the sync fast path" ) written = shard_dict[(0,)] np.testing.assert_array_equal( np.frombuffer(written.to_bytes(), dtype="uint8"), np.arange(10, dtype="uint8") ) # --------------------------------------------------------------------------- # Async-only codecs inside a shard's inner codec chain # --------------------------------------------------------------------------- class _AsyncOnlyNoopCodec(BytesBytesCodec): # type: ignore[misc,unused-ignore] """A no-op BB codec implementing ONLY the async codec interface. Deliberately does NOT satisfy `SupportsSyncCodec` (no `_decode_sync` / `_encode_sync`), modelling a third-party codec that predates the sync protocol. Class-level counters prove the codec actually ran. """ is_fixed_size = True encode_calls = 0 decode_calls = 0 def to_dict(self) -> dict[str, Any]: return {"name": "test-async-only-noop", "configuration": {}} @classmethod def from_dict(cls, data: dict[str, Any]) -> _AsyncOnlyNoopCodec: return cls() def compute_encoded_size(self, input_byte_length: int, _spec: Any) -> int: return input_byte_length async def _encode_single(self, chunk_bytes: Any, chunk_spec: Any) -> Any: type(self).encode_calls += 1 return chunk_bytes async def _decode_single(self, chunk_bytes: Any, chunk_spec: Any) -> Any: type(self).decode_calls += 1 return chunk_bytes def test_sharded_roundtrip_with_async_only_inner_codec() -> None: """A sharded array whose INNER codec chain contains an async-only codec round-trips under FusedCodecPipeline (full write, partial write, full read, partial read). Regression: the pipeline's top-level guard (evolve_from_array_spec -> sync_transform=None) only inspected the top-level chain. ShardingCodec structurally satisfies SupportsSyncCodec, so a sync transform was built and the sync fast path dove into ShardingCodec's sync shard paths, which raised TypeError from the inner ChunkTransform. The pipeline must instead decline the sync fast path and fall back to the async inner pipeline, like BatchedCodecPipeline. """ _AsyncOnlyNoopCodec.encode_calls = 0 _AsyncOnlyNoopCodec.decode_calls = 0 with zarr_config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): store = MemoryStore() arr = zarr.create_array( store=store, shape=(16, 16), shards=(8, 8), chunks=(4, 4), dtype="int32", compressors=[_AsyncOnlyNoopCodec()], fill_value=-1, ) assert isinstance(arr._async_array.codec_pipeline, FusedCodecPipeline) data = np.arange(256, dtype="int32").reshape(16, 16) arr[:] = data # full write np.testing.assert_array_equal(arr[:], data) # full read np.testing.assert_array_equal(arr[2:11, 3:14], data[2:11, 3:14]) # partial read arr[5:7, 5:13] = 0 # partial write (read-merge-write of existing shards) data[5:7, 5:13] = 0 np.testing.assert_array_equal(arr[:], data) assert _AsyncOnlyNoopCodec.encode_calls > 0, "async-only inner codec never encoded" assert _AsyncOnlyNoopCodec.decode_calls > 0, "async-only inner codec never decoded" # The stored bytes are valid for the default pipeline too: read them back # under BatchedCodecPipeline (default codec_pipeline.path). Opening from # metadata needs the codec name in the registry. from zarr.registry import register_codec register_codec("test-async-only-noop", _AsyncOnlyNoopCodec) reread = zarr.open_array(store=store, mode="r") np.testing.assert_array_equal(reread[:], data) # --------------------------------------------------------------------------- # AsyncChunkTransform: the async per-chunk codec chain used on the async # fallback path. It is the async mirror of ChunkTransform, so it must produce # identical bytes/arrays. The default (Fused, sync-store) path never uses it; # these tests drive it directly over multi-codec chains so the aa/bb loops and # the all-fill drop branch are exercised. # --------------------------------------------------------------------------- @pytest.mark.parametrize( "codecs", [ (BytesCodec(),), (BytesCodec(), GzipCodec(level=1)), (TransposeCodec(order=(1, 0)), BytesCodec()), (TransposeCodec(order=(1, 0)), BytesCodec(), ZstdCodec(level=1)), ], ids=["bytes-only", "bb", "aa", "aa+ab+bb"], ) def test_async_chunk_transform_matches_sync(codecs: tuple[Any, ...]) -> None: """`AsyncChunkTransform.decode_chunk`/`encode_chunk` must round-trip and produce exactly what the synchronous `ChunkTransform` produces, across array->array, array->bytes, and bytes->bytes codec combinations. This is the async mirror of the codecs the default pipeline runs synchronously; a divergence here corrupts data only on the async fallback path (remote stores), which no end-to-end test of the default pipeline touches. """ import asyncio from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.chunk_utils import ChunkTransform, evolve_codecs from zarr.core.codec_pipeline import AsyncChunkTransform from zarr.core.dtype import get_data_type_from_native_dtype shape = (4, 4) zdtype = get_data_type_from_native_dtype(np.dtype("int32")) spec = ArraySpec( shape=shape, dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) evolved = evolve_codecs(codecs, spec) sync_t = ChunkTransform(codecs=evolved) async_t = AsyncChunkTransform(codecs=evolved) data = np.arange(16, dtype="int32").reshape(shape) value = CPUNDBuffer.from_numpy_array(data) sync_bytes = sync_t.encode_chunk(value, spec) async_bytes = asyncio.run(async_t.encode_chunk(value, spec)) assert sync_bytes is not None assert async_bytes is not None np.testing.assert_array_equal(async_bytes.to_bytes(), sync_bytes.to_bytes()) sync_arr = sync_t.decode_chunk(async_bytes, spec) async_arr = asyncio.run(async_t.decode_chunk(async_bytes, spec)) np.testing.assert_array_equal(async_arr.as_numpy_array(), sync_arr.as_numpy_array()) np.testing.assert_array_equal(async_arr.as_numpy_array(), data) def test_async_decode_encode_passes_through_none_chunks() -> None: """`FusedCodecPipeline.decode`/`encode` (the async batch entry points used on the fallback path) map a None chunk to None and leave real chunks untouched — pins the None-passthrough branch the default sync path skips.""" import asyncio from zarr.core.array_spec import ArrayConfig, ArraySpec from zarr.core.buffer import default_buffer_prototype from zarr.core.buffer.cpu import NDBuffer as CPUNDBuffer from zarr.core.dtype import get_data_type_from_native_dtype zdtype = get_data_type_from_native_dtype(np.dtype("int32")) spec = ArraySpec( shape=(4,), dtype=zdtype, fill_value=zdtype.cast_scalar(0), config=ArrayConfig(order="C", write_empty_chunks=True), prototype=default_buffer_prototype(), ) pipeline = FusedCodecPipeline.from_codecs([BytesCodec()]).evolve_from_array_spec(spec) data = np.arange(4, dtype="int32") value = CPUNDBuffer.from_numpy_array(data) # encode a real chunk and a None chunk together encoded = list(asyncio.run(pipeline.encode([(value, spec), (None, spec)]))) assert encoded[1] is None assert encoded[0] is not None # decode the real chunk and a None chunk together decoded = list(asyncio.run(pipeline.decode([(encoded[0], spec), (None, spec)]))) assert decoded[1] is None assert decoded[0] is not None np.testing.assert_array_equal(decoded[0].as_numpy_array(), data) # --------------------------------------------------------------------------- # Graceful fallback for partial-mixin codecs without private sync-partial hooks # # The public partial-decode/encode contract (`ArrayBytesCodecPartialDecodeMixin` # / `ArrayBytesCodecPartialEncodeMixin`) only requires the async # `_decode_partial_single` / `_encode_partial_single`. The fused pipeline must # route such codecs through its full-chunk sync path instead of asserting on # the private `_decode_partial_sync` / `_encode_partial_sync` hooks. The double # below is a minimal conforming implementer of that contract; it guards the # public extension API, so it must not grow the private sync-partial methods. # --------------------------------------------------------------------------- @dataclass(frozen=True) class PartialMixinCodec( ArrayBytesCodec, ArrayBytesCodecPartialDecodeMixin, ArrayBytesCodecPartialEncodeMixin ): """Serializer with sync whole-chunk methods plus ONLY async partial methods. This is the pre-fused public contract for partial-capable codecs: the mixins' `_decode_partial_single` / `_encode_partial_single`. It must not implement `_decode_partial_sync` / `_encode_partial_sync`. """ inner: BytesCodec = field(default_factory=BytesCodec) @classmethod def from_dict(cls, data: dict[str, Any]) -> PartialMixinCodec: return cls() def to_dict(self) -> dict[str, Any]: return {"name": "test-partial-mixin"} def evolve_from_array_spec(self, array_spec: ArraySpec) -> PartialMixinCodec: return replace(self, inner=self.inner.evolve_from_array_spec(array_spec)) def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) -> int: return self.inner.compute_encoded_size(input_byte_length, chunk_spec) def _decode_sync(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> NDBuffer: return self.inner._decode_sync(chunk_bytes, chunk_spec) def _encode_sync(self, chunk_array: NDBuffer, chunk_spec: ArraySpec) -> Buffer | None: return self.inner._encode_sync(chunk_array, chunk_spec) async def _decode_single(self, chunk_bytes: Buffer, chunk_spec: ArraySpec) -> NDBuffer: return self._decode_sync(chunk_bytes, chunk_spec) async def _encode_single(self, chunk_array: NDBuffer, chunk_spec: ArraySpec) -> Buffer | None: return self._encode_sync(chunk_array, chunk_spec) async def _decode_partial_single( self, byte_getter: Any, selection: Any, chunk_spec: ArraySpec ) -> NDBuffer | None: chunk_bytes = await byte_getter.get(prototype=chunk_spec.prototype) if chunk_bytes is None: return None return self._decode_sync(chunk_bytes, chunk_spec)[selection] async def _encode_partial_single( self, byte_setter: Any, chunk_array: NDBuffer, selection: Any, chunk_spec: ArraySpec ) -> None: existing = await byte_setter.get(prototype=chunk_spec.prototype) if existing is None: full = chunk_spec.prototype.nd_buffer.create( shape=chunk_spec.shape, dtype=chunk_spec.dtype.to_native_dtype(), fill_value=chunk_spec.fill_value, ) else: full = self._decode_sync(existing, chunk_spec) full[selection] = chunk_array encoded = self._encode_sync(full, chunk_spec) assert encoded is not None await byte_setter.set(encoded) register_codec("test-partial-mixin", PartialMixinCodec) _FUSED = {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} _BATCHED = {"codec_pipeline.path": "zarr.core.codec_pipeline.BatchedCodecPipeline"} @pytest.mark.filterwarnings("ignore::zarr.errors.UnstableSpecificationWarning") @pytest.mark.parametrize("dtype", ["uint8", "float64"]) def test_partial_mixin_codec_async_partial_only_round_trip(dtype: str) -> None: """A serializer advertising the partial mixins with only async partial methods must round-trip under the fused pipeline: full write, full read, partial read, partial write, plus cross-pipeline parity with BatchedCodecPipeline.""" data = np.arange(64, dtype=dtype).reshape(8, 8) with zarr_config.set(_FUSED): store = MemoryStore() arr = zarr.create_array( store, shape=(8, 8), chunks=(4, 4), dtype=dtype, serializer=PartialMixinCodec(), compressors=None, filters=None, fill_value=0, ) pipeline = arr._async_array.codec_pipeline assert isinstance(pipeline, FusedCodecPipeline) assert pipeline.supports_partial_decode assert pipeline.supports_partial_encode assert pipeline.sync_transform is not None arr[:] = data np.testing.assert_array_equal(arr[:], data) np.testing.assert_array_equal(arr[1:5, 2:7], data[1:5, 2:7]) expected = data.copy() expected[2:6, 1:3] = 7 arr[2:6, 1:3] = expected[2:6, 1:3] np.testing.assert_array_equal(arr[:], expected) with zarr_config.set(_BATCHED): np.testing.assert_array_equal(zarr.open_array(store, mode="r")[:], expected) # Sync-IO capability gating (`zarr.abc.store._store_supports_sync_io`) # # The fused read/write fast paths must engage iff the store advertises the # FULL synchronous IO surface (get_sync + set_sync + delete_sync): write_sync # needs get_sync for partial-chunk read-modify-write and delete_sync for # all-fill chunk cleanup, so gating on any single protocol can crash # mid-batch. Wrappers must forward the capability of the wrapped store. # --------------------------------------------------------------------------- class AsyncOnlyStore(Store): """Dict-backed store implementing only the async `Store` surface (no `*_sync`).""" def __init__(self) -> None: super().__init__(read_only=False) self._data: dict[str, Buffer] = {} def __eq__(self, other: object) -> bool: return other is self @property def supports_writes(self) -> bool: return True @property def supports_deletes(self) -> bool: return True @property def supports_listing(self) -> bool: return True async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> Buffer | None: try: value = self._data[key] except KeyError: return None start, stop = _normalize_byte_range_index(value, byte_range) return prototype.buffer.from_buffer(value[start:stop]) async def get_partial_values( self, prototype: BufferPrototype, key_ranges: Iterable[tuple[str, ByteRequest | None]], ) -> list[Buffer | None]: return [await self.get(key, prototype, byte_range) for key, byte_range in key_ranges] async def exists(self, key: str) -> bool: return key in self._data async def set(self, key: str, value: Buffer) -> None: self._check_writable() self._data[key] = value async def delete(self, key: str) -> None: self._check_writable() self._data.pop(key, None) async def list(self) -> AsyncIterator[str]: for key in list(self._data): yield key async def list_prefix(self, prefix: str) -> AsyncIterator[str]: for key in list(self._data): if key.startswith(prefix): yield key async def list_dir(self, prefix: str) -> AsyncIterator[str]: if prefix and not prefix.endswith("/"): prefix += "/" seen: set[str] = set() for key in list(self._data): if key.startswith(prefix): head = key.removeprefix(prefix).split("/")[0] if head not in seen: seen.add(head) yield head class SetOnlySyncStore(AsyncOnlyStore): """Implements `set_sync` but not `get_sync`/`delete_sync` (partial sync surface).""" def set_sync(self, key: str, value: Buffer) -> None: self._check_writable() self._data[key] = value @pytest.mark.parametrize( ("store_factory", "expect_sync_path"), [ (MemoryStore, True), (lambda: WrapperStore(MemoryStore()), True), (lambda: LatencyStore(MemoryStore()), True), (SetOnlySyncStore, False), (lambda: WrapperStore(AsyncOnlyStore()), False), ], ids=[ "full-sync", "wrapper-of-sync", "latency-wrapper-of-sync", "set-sync-only", "wrapper-of-async-only", ], ) def test_sync_io_capability_gates_fused_paths( store_factory: Callable[[], Store], expect_sync_path: bool ) -> None: """The fused pipeline takes the sync fast path iff the store satisfies `_store_supports_sync_io`, and every store round-trips correctly through full writes, partial (read-modify-write) writes, and all-fill (delete) writes — a store with a partial sync surface must get a clean async fallback, never a mid-batch error.""" from unittest.mock import patch store = store_factory() assert _store_supports_sync_io(store) is expect_sync_path calls = {"read_sync": 0, "write_sync": 0} orig_read_sync = FusedCodecPipeline.read_sync orig_write_sync = FusedCodecPipeline.write_sync def spy_read_sync(self: FusedCodecPipeline, *args: Any, **kwargs: Any) -> Any: calls["read_sync"] += 1 return orig_read_sync(self, *args, **kwargs) def spy_write_sync(self: FusedCodecPipeline, *args: Any, **kwargs: Any) -> Any: calls["write_sync"] += 1 return orig_write_sync(self, *args, **kwargs) with zarr_config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): arr = zarr.create_array( store=store, shape=(8,), chunks=(4,), dtype="uint8", compressors=None, fill_value=0, ) assert isinstance(arr._async_array.codec_pipeline, FusedCodecPipeline) with ( patch.object(FusedCodecPipeline, "read_sync", spy_read_sync), patch.object(FusedCodecPipeline, "write_sync", spy_write_sync), ): data = np.arange(8, dtype="uint8") arr[:] = data # complete-chunk writes arr[:3] = 7 # partial write -> read-modify-write needs get data[:3] = 7 np.testing.assert_array_equal(arr[:], data) arr[4:8] = 0 # all-fill chunk -> delete needed data[4:8] = 0 np.testing.assert_array_equal(arr[:], data) if expect_sync_path: assert calls["write_sync"] > 0, "sync-capable store did not take the sync write path" assert calls["read_sync"] > 0, "sync-capable store did not take the sync read path" else: assert calls["write_sync"] == 0, "non-sync store took the sync write path" assert calls["read_sync"] == 0, "non-sync store took the sync read path" zarr-python-3.3.0/tests/test_group.py000066400000000000000000002511771523267620000177410ustar00rootroot00000000000000from __future__ import annotations import contextlib import inspect import json import operator import pickle import re import time import warnings from typing import TYPE_CHECKING, Any, Literal, get_args import numpy as np import pytest from numcodecs import Blosc import zarr import zarr.api.asynchronous import zarr.api.synchronous import zarr.storage from zarr import Array, AsyncArray, AsyncGroup, Group from zarr.abc.store import Store from zarr.core import sync_group from zarr.core._info import GroupInfo from zarr.core.buffer import default_buffer_prototype from zarr.core.config import config as zarr_config from zarr.core.dtype.common import unpack_dtype_json from zarr.core.dtype.npy.int import UInt8 from zarr.core.group import ( ConsolidatedMetadata, GroupMetadata, ImplicitGroupMarker, _build_metadata_v3, _get_roots, _parse_hierarchy_dict, create_hierarchy, create_nodes, create_rooted_hierarchy, get_node, ) from zarr.core.metadata.v3 import ArrayV3Metadata from zarr.core.sync import _collect_aiterator, sync from zarr.errors import ( ArrayNotFoundError, ContainsArrayError, ContainsGroupError, GroupNotFoundError, MetadataValidationError, ZarrUserWarning, ) from zarr.storage import LocalStore, MemoryStore, StorePath, ZipStore from zarr.storage._common import make_store_path from zarr.storage._utils import _join_paths, normalize_path from zarr.testing.store import LatencyStore from .conftest import meta_from_array, parse_store if TYPE_CHECKING: import pathlib from collections.abc import Callable from zarr.core.buffer.core import Buffer from zarr.core.common import JSON, ZarrFormat @pytest.fixture(params=["local", "memory", "zip"]) async def store(request: pytest.FixtureRequest, tmp_path: pathlib.Path) -> Store: result = await parse_store(request.param, str(tmp_path)) if not isinstance(result, Store): raise TypeError(f"Wrong store class returned by test fixture! got {result} instead") return result @pytest.fixture(params=[True, False]) def overwrite(request: pytest.FixtureRequest) -> bool: result = request.param if not isinstance(result, bool): raise TypeError("Wrong type returned by test fixture.") return result def test_group_init(store: Store, zarr_format: ZarrFormat) -> None: """ Test that initializing a group from an asyncgroup works. """ agroup = sync(AsyncGroup.from_store(store=store, zarr_format=zarr_format)) group = Group(agroup) assert group._async_group == agroup async def test_create_creates_parents(store: Store, zarr_format: ZarrFormat) -> None: # prepare a root node, with some data set await zarr.api.asynchronous.open_group( store=store, path="a", zarr_format=zarr_format, attributes={"key": "value"} ) objs = {x async for x in store.list()} if zarr_format == 2: assert objs == {".zgroup", ".zattrs", "a/.zgroup", "a/.zattrs"} else: assert objs == {"zarr.json", "a/zarr.json"} # test that root group node was created root = await zarr.api.asynchronous.open_group( store=store, ) agroup = await root.get_group("a") assert agroup.attrs == {"key": "value"} # create a child node with a couple intermediates await zarr.api.asynchronous.open_group(store=store, path="a/b/c/d", zarr_format=zarr_format) parts = ["a", "a/b", "a/b/c"] if zarr_format == 2: files = [".zattrs", ".zgroup"] else: files = ["zarr.json"] expected = [f"{part}/{file}" for file in files for part in parts] if zarr_format == 2: expected.extend([".zgroup", ".zattrs", "a/b/c/d/.zgroup", "a/b/c/d/.zattrs"]) else: expected.extend(["zarr.json", "a/b/c/d/zarr.json"]) expected = sorted(expected) result = sorted([x async for x in store.list_prefix("")]) assert result == expected paths = ["a", "a/b", "a/b/c"] for path in paths: g = await zarr.api.asynchronous.open_group(store=store, path=path) assert isinstance(g, AsyncGroup) if path == "a": # ensure we didn't overwrite the root attributes assert g.attrs == {"key": "value"} else: assert g.attrs == {} @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("root_name", ["", "/", "a", "/a"]) @pytest.mark.parametrize("branch_name", ["foo", "/foo", "foo/bar", "/foo/bar"]) def test_group_name_properties( store: Store, zarr_format: ZarrFormat, root_name: str, branch_name: str ) -> None: """ Test that the path, name, and basename attributes of a group and its subgroups are consistent """ root = Group.from_store(store=StorePath(store=store, path=root_name), zarr_format=zarr_format) assert root.path == normalize_path(root_name) assert root.name == f"/{root.path}" assert root.basename == root.path branch = root.create_group(branch_name) if root.path == "": assert branch.path == normalize_path(branch_name) else: assert branch.path == "/".join([root.path, normalize_path(branch_name)]) assert branch.name == f"/{branch.path}" assert branch.basename == branch_name.split("/")[-1] @pytest.mark.parametrize("consolidated_metadata", [True, False]) def test_group_members(store: Store, zarr_format: ZarrFormat, consolidated_metadata: bool) -> None: """ Test that `Group.members` returns correct values, i.e. the arrays and groups (explicit and implicit) contained in that group. """ # group/ # subgroup/ # subsubgroup/ # subsubsubgroup # subarray path = "group" group = Group.from_store( store=store, zarr_format=zarr_format, ) members_expected: dict[str, Array | Group] = {} members_expected["subgroup"] = group.create_group("subgroup") # make a sub-sub-subgroup, to ensure that the children calculation doesn't go # too deep in the hierarchy subsubgroup = members_expected["subgroup"].create_group("subsubgroup") subsubsubgroup = subsubgroup.create_group("subsubsubgroup") members_expected["subarray"] = group.create_array( "subarray", shape=(100,), dtype="uint8", chunks=(10,), overwrite=True ) # add an extra object to the domain of the group. # the list of children should ignore this object. sync( store.set( f"{path}/extra_object-1", default_buffer_prototype().buffer.from_bytes(b"000000"), ) ) # add an extra object under a directory-like prefix in the domain of the group. # this creates a directory with a random key in it # this should not show up as a member sync( store.set( f"{path}/extra_directory/extra_object-2", default_buffer_prototype().buffer.from_bytes(b"000000"), ) ) # this warning shows up when extra objects show up in the hierarchy warn_context = pytest.warns( ZarrUserWarning, match=r"(?:Object at .* is not recognized as a component of a Zarr hierarchy.)|(?:Consolidated metadata is currently not part in the Zarr format 3 specification.)", ) if consolidated_metadata: if isinstance(store, ZipStore): with warn_context: with pytest.warns(UserWarning, match="Duplicate name: "): zarr.consolidate_metadata(store=store, zarr_format=zarr_format) else: with warn_context: zarr.consolidate_metadata(store=store, zarr_format=zarr_format) # now that we've consolidated the store, we shouldn't get the warnings from the unrecognized objects anymore # we use a nullcontext to handle these cases warn_context = contextlib.nullcontext() group = zarr.open_consolidated(store=store, zarr_format=zarr_format) with warn_context: members_observed = group.members() # members are not guaranteed to be ordered, so sort before comparing assert sorted(dict(members_observed)) == sorted(members_expected) # partial with warn_context: members_observed = group.members(max_depth=1) members_expected["subgroup/subsubgroup"] = subsubgroup # members are not guaranteed to be ordered, so sort before comparing assert sorted(dict(members_observed)) == sorted(members_expected) # total with warn_context: members_observed = group.members(max_depth=None) members_expected["subgroup/subsubgroup/subsubsubgroup"] = subsubsubgroup # members are not guaranteed to be ordered, so sort before comparing assert sorted(dict(members_observed)) == sorted(members_expected) with pytest.raises(ValueError, match="max_depth"): members_observed = group.members(max_depth=-1) def test_group(store: Store, zarr_format: ZarrFormat) -> None: """ Test basic Group routines. """ store_path = StorePath(store) agroup = AsyncGroup(metadata=GroupMetadata(zarr_format=zarr_format), store_path=store_path) group = Group(agroup) assert agroup.metadata is group.metadata assert agroup.store_path == group.store_path == store_path # create two groups foo = group.create_group("foo") bar = foo.create_group("bar", attributes={"baz": "qux"}) # create an array from the "bar" group data = np.arange(0, 4 * 4, dtype="uint16").reshape((4, 4)) arr = bar.create_array("baz", shape=data.shape, dtype=data.dtype, chunks=(2, 2), overwrite=True) arr[:] = data # check the array assert arr == bar["baz"] assert arr.shape == data.shape assert arr.dtype == data.dtype # TODO: update this once the array api settles down assert arr.chunks == (2, 2) bar2 = foo["bar"] assert dict(bar2.attrs) == {"baz": "qux"} # update a group's attributes if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): bar2.attrs.update({"name": "bar"}) else: bar2.attrs.update({"name": "bar"}) # bar.attrs was modified in-place assert dict(bar2.attrs) == {"baz": "qux", "name": "bar"} # and the attrs were modified in the store bar3 = foo["bar"] assert dict(bar3.attrs) == {"baz": "qux", "name": "bar"} def test_group_create(store: Store, overwrite: bool, zarr_format: ZarrFormat) -> None: """ Test that `Group.from_store` works as expected. """ attributes = {"foo": 100} group = Group.from_store( store, attributes=attributes, zarr_format=zarr_format, overwrite=overwrite ) assert group.attrs == attributes if not overwrite: with pytest.raises(ContainsGroupError): _ = Group.from_store(store, overwrite=overwrite, zarr_format=zarr_format) def test_group_open(store: Store, zarr_format: ZarrFormat, overwrite: bool) -> None: """ Test the `Group.open` method. """ spath = StorePath(store) # attempt to open a group that does not exist with pytest.raises(FileNotFoundError): Group.open(store) # create the group attrs = {"path": "foo"} group_created = Group.from_store( store, attributes=attrs, zarr_format=zarr_format, overwrite=overwrite ) assert group_created.attrs == attrs assert group_created.metadata.zarr_format == zarr_format assert group_created.store_path == spath # attempt to create a new group in place, to test overwrite new_attrs = {"path": "bar"} if not overwrite: with pytest.raises(ContainsGroupError): Group.from_store(store, attributes=attrs, zarr_format=zarr_format, overwrite=overwrite) else: if not store.supports_deletes: pytest.skip( "Store does not support deletes but `overwrite` is True, requiring deletes to override a group" ) group_created_again = Group.from_store( store, attributes=new_attrs, zarr_format=zarr_format, overwrite=overwrite ) assert group_created_again.attrs == new_attrs assert group_created_again.metadata.zarr_format == zarr_format assert group_created_again.store_path == spath @pytest.mark.parametrize("consolidated", [True, False]) def test_group_getitem(store: Store, zarr_format: ZarrFormat, consolidated: bool) -> None: """ Test the `Group.__getitem__` method. """ group = Group.from_store(store, zarr_format=zarr_format) subgroup = group.create_group(name="subgroup") subarray = group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="uint8") subsubarray = subgroup.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="uint8") if consolidated: if zarr_format == 3: with pytest.warns( # noqa: PT031 ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): group = zarr.api.synchronous.consolidate_metadata( store=store, zarr_format=zarr_format ) else: group = zarr.api.synchronous.consolidate_metadata( store=store, zarr_format=zarr_format ) else: if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): group = zarr.api.synchronous.consolidate_metadata( store=store, zarr_format=zarr_format ) else: group = zarr.api.synchronous.consolidate_metadata( store=store, zarr_format=zarr_format ) # we're going to assume that `group.metadata` is correct, and reuse that to focus # on indexing in this test. Other tests verify the correctness of group.metadata object.__setattr__( subgroup.metadata, "consolidated_metadata", ConsolidatedMetadata( metadata={"subarray": group.metadata.consolidated_metadata.metadata["subarray"]} ), ) assert group["subgroup"] == subgroup assert group["subarray"] == subarray assert group["subgroup"]["subarray"] == subsubarray assert group["subgroup/subarray"] == subsubarray with pytest.raises(KeyError, match="nope"): group["nope"] with pytest.raises(KeyError, match="subarray/subsubarray"): group["subarray/subsubarray"] # Now test the mixed case if consolidated: object.__setattr__( group.metadata.consolidated_metadata.metadata["subgroup"], "consolidated_metadata", None, ) # test the implementation directly with pytest.raises(KeyError): group._async_group._getitem_consolidated( group.store_path, "subgroup/subarray", prefix="/" ) with pytest.raises(KeyError): # We've chosen to trust the consolidated metadata, which doesn't # contain this array group["subgroup/subarray"] with pytest.raises(KeyError, match="subarray/subsubarray"): group["subarray/subsubarray"] def test_group_get_with_default(store: Store, zarr_format: ZarrFormat) -> None: group = Group.from_store(store, zarr_format=zarr_format) # default behavior result = group.get("subgroup") assert result is None # custom default result = group.get("subgroup", 8) assert result == 8 # now with a group subgroup = group.require_group("subgroup") if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): subgroup.attrs["foo"] = "bar" else: subgroup.attrs["foo"] = "bar" result = group.get("subgroup", 8) assert result.attrs["foo"] == "bar" def test_group_get_array(store: Store, zarr_format: ZarrFormat) -> None: """ `Group.get_array` returns the array at the given path, for both direct child names and nested paths, and the result is statically typed as an Array. """ group = Group.from_store(store, zarr_format=zarr_format) subgroup = group.create_group(name="subgroup") subarray = group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="uint8") subsubarray = subgroup.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="uint8") observed = group.get_array("subarray") assert isinstance(observed, Array) assert observed == subarray assert group.get_array("subgroup/subarray") == subsubarray def test_group_get_array_missing(store: Store, zarr_format: ZarrFormat) -> None: """ `Group.get_array` raises `ArrayNotFoundError` when no node exists at the given path. """ group = Group.from_store(store, zarr_format=zarr_format) with pytest.raises(ArrayNotFoundError, match="No array found in store"): group.get_array("missing") def test_group_get_array_wrong_node_type(store: Store, zarr_format: ZarrFormat) -> None: """ `Group.get_array` raises `ContainsGroupError` when the node at the given path is a group rather than an array. """ group = Group.from_store(store, zarr_format=zarr_format) group.create_group(name="subgroup") with pytest.raises(ContainsGroupError, match="A group exists in store"): group.get_array("subgroup") def test_group_get_group(store: Store, zarr_format: ZarrFormat) -> None: """ `Group.get_group` returns the group at the given path, for both direct child names and nested paths, and the result is statically typed as a Group. """ group = Group.from_store(store, zarr_format=zarr_format) subgroup = group.create_group(name="subgroup") subsubgroup = subgroup.create_group(name="subsubgroup") observed = group.get_group("subgroup") assert isinstance(observed, Group) assert observed == subgroup assert group.get_group("subgroup/subsubgroup") == subsubgroup def test_group_get_group_missing(store: Store, zarr_format: ZarrFormat) -> None: """ `Group.get_group` raises `GroupNotFoundError` when no node exists at the given path. """ group = Group.from_store(store, zarr_format=zarr_format) with pytest.raises(GroupNotFoundError, match="No group found in store"): group.get_group("missing") def test_group_get_group_wrong_node_type(store: Store, zarr_format: ZarrFormat) -> None: """ `Group.get_group` raises `ContainsArrayError` when the node at the given path is an array rather than a group. """ group = Group.from_store(store, zarr_format=zarr_format) group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="uint8") with pytest.raises(ContainsArrayError, match="An array exists in store"): group.get_group("subarray") @pytest.mark.parametrize("consolidated", [True, False]) def test_group_delitem(store: Store, zarr_format: ZarrFormat, consolidated: bool) -> None: """ Test the `Group.__delitem__` method. """ if not store.supports_deletes: pytest.skip("store does not support deletes") group = Group.from_store(store, zarr_format=zarr_format) subgroup = group.create_group(name="subgroup") subarray = group.create_array(name="subarray", shape=(10,), chunks=(10,), dtype="uint8") if consolidated: if zarr_format == 3: with pytest.warns( # noqa: PT031 ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): group = zarr.api.synchronous.consolidate_metadata( store=store, zarr_format=zarr_format ) else: group = zarr.api.synchronous.consolidate_metadata( store=store, zarr_format=zarr_format ) else: group = zarr.api.synchronous.consolidate_metadata(store=store, zarr_format=zarr_format) object.__setattr__( subgroup.metadata, "consolidated_metadata", ConsolidatedMetadata(metadata={}) ) assert group["subgroup"] == subgroup assert group["subarray"] == subarray del group["subgroup"] with pytest.raises(KeyError, match="subgroup"): group["subgroup"] del group["subarray"] with pytest.raises(KeyError, match="subarray"): group["subarray"] def test_group_iter(store: Store, zarr_format: ZarrFormat) -> None: """ Test the `Group.__iter__` method. """ group = Group.from_store(store, zarr_format=zarr_format) assert list(group) == [] def test_group_len(store: Store, zarr_format: ZarrFormat) -> None: """ Test the `Group.__len__` method. """ group = Group.from_store(store, zarr_format=zarr_format) assert len(group) == 0 def test_group_setitem(store: Store, zarr_format: ZarrFormat) -> None: """ Test the `Group.__setitem__` method. """ group = Group.from_store(store, zarr_format=zarr_format) arr = np.ones((2, 4)) group["key"] = arr assert list(group.array_keys()) == ["key"] assert group["key"].shape == (2, 4) np.testing.assert_array_equal(group["key"][:], arr) if store.supports_deletes: key = "key" else: # overwriting with another array requires deletes # for stores that don't support this, we just use a new key key = "key2" # overwrite with another array arr = np.zeros((3, 5)) group[key] = arr assert key in list(group.array_keys()) assert group[key].shape == (3, 5) np.testing.assert_array_equal(group[key], arr) def test_group_contains(store: Store, zarr_format: ZarrFormat) -> None: """ Test the `Group.__contains__` method """ group = Group.from_store(store, zarr_format=zarr_format) assert "foo" not in group _ = group.create_group(name="foo") assert "foo" in group @pytest.mark.parametrize("consolidate", [True, False]) def test_group_child_iterators(store: Store, zarr_format: ZarrFormat, consolidate: bool): group = Group.from_store(store, zarr_format=zarr_format) expected_group_keys = ["g0", "g1"] expected_group_values = [group.create_group(name=name) for name in expected_group_keys] expected_groups = list(zip(expected_group_keys, expected_group_values, strict=False)) fill_value = 3 dtype = UInt8() expected_group_values[0].create_group("subgroup") expected_group_values[0].create_array( "subarray", shape=(1,), dtype=dtype, fill_value=fill_value ) expected_array_keys = ["a0", "a1"] expected_array_values = [ group.create_array(name=name, shape=(1,), dtype=dtype, fill_value=fill_value) for name in expected_array_keys ] expected_arrays = list(zip(expected_array_keys, expected_array_values, strict=False)) if consolidate: if zarr_format == 3: with pytest.warns( # noqa: PT031 ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): group = zarr.consolidate_metadata(store) else: group = zarr.consolidate_metadata(store) else: if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): group = zarr.consolidate_metadata(store) else: group = zarr.consolidate_metadata(store) if zarr_format == 2: metadata = { "subarray": { "attributes": {}, "dtype": unpack_dtype_json(dtype.to_json(zarr_format=zarr_format)), "fill_value": fill_value, "shape": (1,), "chunks": (1,), "order": "C", "filters": None, "compressor": Blosc(), "zarr_format": zarr_format, }, "subgroup": { "attributes": {}, "consolidated_metadata": { "metadata": {}, "kind": "inline", "must_understand": False, }, "node_type": "group", "zarr_format": zarr_format, }, } else: metadata = { "subarray": { "attributes": {}, "chunk_grid": { "configuration": {"chunk_shape": (1,)}, "name": "regular", }, "chunk_key_encoding": { "configuration": {"separator": "/"}, "name": "default", }, "codecs": ( {"configuration": {"endian": "little"}, "name": "bytes"}, {"configuration": {}, "name": "zstd"}, ), "data_type": unpack_dtype_json(dtype.to_json(zarr_format=zarr_format)), "fill_value": fill_value, "node_type": "array", "shape": (1,), "zarr_format": zarr_format, }, "subgroup": { "attributes": {}, "consolidated_metadata": { "metadata": {}, "kind": "inline", "must_understand": False, }, "node_type": "group", "zarr_format": zarr_format, }, } object.__setattr__( expected_group_values[0].metadata, "consolidated_metadata", ConsolidatedMetadata.from_dict( { "kind": "inline", "metadata": metadata, "must_understand": False, } ), ) object.__setattr__( expected_group_values[1].metadata, "consolidated_metadata", ConsolidatedMetadata(metadata={}), ) result = sorted(group.groups(), key=operator.itemgetter(0)) assert result == expected_groups assert sorted(group.groups(), key=operator.itemgetter(0)) == expected_groups assert sorted(group.group_keys()) == expected_group_keys assert sorted(group.group_values(), key=lambda x: x.name) == expected_group_values assert sorted(group.arrays(), key=operator.itemgetter(0)) == expected_arrays assert sorted(group.array_keys()) == expected_array_keys assert sorted(group.array_values(), key=lambda x: x.name) == expected_array_values def test_group_update_attributes(store: Store, zarr_format: ZarrFormat) -> None: """ Test the behavior of `Group.update_attributes` """ attrs = {"foo": 100} group = Group.from_store(store, zarr_format=zarr_format, attributes=attrs) assert group.attrs == attrs new_attrs = {"bar": 100} if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): new_group = group.update_attributes(new_attrs) else: new_group = group.update_attributes(new_attrs) updated_attrs = attrs.copy() updated_attrs.update(new_attrs) assert new_group.attrs == updated_attrs async def test_group_update_attributes_async(store: Store, zarr_format: ZarrFormat) -> None: """ Test the behavior of `Group.update_attributes_async` """ attrs = {"foo": 100} group = Group.from_store(store, zarr_format=zarr_format, attributes=attrs) assert group.attrs == attrs new_attrs = {"bar": 100} if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name: "): new_group = await group.update_attributes_async(new_attrs) else: new_group = await group.update_attributes_async(new_attrs) assert new_group.attrs == new_attrs @pytest.mark.parametrize("name", ["a", "/a"]) def test_group_create_array( store: Store, zarr_format: ZarrFormat, overwrite: bool, name: str, ) -> None: """ Test `Group.from_store` """ group = Group.from_store(store, zarr_format=zarr_format) shape = (10, 10) dtype = "uint8" data = np.arange(np.prod(shape)).reshape(shape).astype(dtype) array = group.create_array(name=name, shape=shape, dtype=dtype) array[:] = data if not overwrite: with pytest.raises(ContainsArrayError): # noqa: PT012 a = group.create_array(name=name, shape=shape, dtype=dtype) a[:] = data assert array.path == normalize_path(name) assert array.name == f"/{array.path}" assert array.shape == shape assert array.dtype == np.dtype(dtype) assert np.array_equal(array[:], data) @pytest.mark.parametrize("method", ["create_array", "create_group"]) def test_create_with_parent_array(store: Store, zarr_format: ZarrFormat, method: str): """Test that groups/arrays cannot be created under a parent array.""" # create a group with a child array group = Group.from_store(store, zarr_format=zarr_format) group.create_array(name="arr_1", shape=(10, 10), dtype="uint8") error_msg = r"A parent of .* is an array - only groups may have child nodes." if method == "create_array": with pytest.raises(ValueError, match=error_msg): group.create_array("arr_1/group_1/group_2/arr_2", shape=(10, 10), dtype="uint8") else: with pytest.raises(ValueError, match=error_msg): group.create_group("arr_1/group_1/group_2/group_3") LikeMethodName = Literal["zeros_like", "ones_like", "empty_like", "full_like"] @pytest.mark.parametrize("method_name", get_args(LikeMethodName)) @pytest.mark.parametrize("out_shape", ["keep", (10, 10)]) @pytest.mark.parametrize("out_chunks", ["keep", (10, 10)]) @pytest.mark.parametrize("out_dtype", ["keep", "int8"]) def test_group_array_like_creation( zarr_format: ZarrFormat, method_name: LikeMethodName, out_shape: Literal["keep"] | tuple[int, ...], out_chunks: Literal["keep"] | tuple[int, ...], out_dtype: str, ) -> None: """ Test Group.{zeros_like, ones_like, empty_like, full_like}, ensuring that we can override the shape, chunks, and dtype of the array-like object provided to these functions with appropriate keyword arguments """ ref_arr = zarr.ones(store={}, shape=(11, 12), dtype="uint8", chunks=(11, 12)) group = Group.from_store({}, zarr_format=zarr_format) kwargs = {} if method_name == "full_like": expect_fill = 4 kwargs["fill_value"] = expect_fill meth = group.full_like elif method_name == "zeros_like": expect_fill = 0 meth = group.zeros_like elif method_name == "ones_like": expect_fill = 1 meth = group.ones_like elif method_name == "empty_like": expect_fill = ref_arr.fill_value meth = group.empty_like else: raise AssertionError if out_shape != "keep": kwargs["shape"] = out_shape expect_shape = out_shape else: expect_shape = ref_arr.shape if out_chunks != "keep": kwargs["chunks"] = out_chunks expect_chunks = out_chunks else: expect_chunks = ref_arr.chunks if out_dtype != "keep": kwargs["dtype"] = out_dtype expect_dtype = out_dtype else: expect_dtype = ref_arr.dtype new_arr = meth(name="foo", data=ref_arr, **kwargs) assert new_arr.shape == expect_shape assert new_arr.chunks == expect_chunks assert new_arr.dtype == expect_dtype assert np.all(new_arr[:] == expect_fill) def test_group_array_creation( store: Store, zarr_format: ZarrFormat, ): group = Group.from_store(store, zarr_format=zarr_format) shape = (10, 10) empty_array = group.empty(name="empty", shape=shape) assert isinstance(empty_array, Array) assert empty_array.fill_value == 0 assert empty_array.shape == shape assert empty_array.store_path.store == store assert empty_array.store_path.path == "empty" empty_like_array = group.empty_like(name="empty_like", data=empty_array) assert isinstance(empty_like_array, Array) assert empty_like_array.fill_value == 0 assert empty_like_array.shape == shape assert empty_like_array.store_path.store == store empty_array_bool = group.empty(name="empty_bool", shape=shape, dtype=np.dtype("bool")) assert isinstance(empty_array_bool, Array) assert not empty_array_bool.fill_value assert empty_array_bool.shape == shape assert empty_array_bool.store_path.store == store empty_like_array_bool = group.empty_like(name="empty_like_bool", data=empty_array_bool) assert isinstance(empty_like_array_bool, Array) assert not empty_like_array_bool.fill_value assert empty_like_array_bool.shape == shape assert empty_like_array_bool.store_path.store == store zeros_array = group.zeros(name="zeros", shape=shape) assert isinstance(zeros_array, Array) assert zeros_array.fill_value == 0 assert zeros_array.shape == shape assert zeros_array.store_path.store == store zeros_like_array = group.zeros_like(name="zeros_like", data=zeros_array) assert isinstance(zeros_like_array, Array) assert zeros_like_array.fill_value == 0 assert zeros_like_array.shape == shape assert zeros_like_array.store_path.store == store ones_array = group.ones(name="ones", shape=shape) assert isinstance(ones_array, Array) assert ones_array.fill_value == 1 assert ones_array.shape == shape assert ones_array.store_path.store == store ones_like_array = group.ones_like(name="ones_like", data=ones_array) assert isinstance(ones_like_array, Array) assert ones_like_array.fill_value == 1 assert ones_like_array.shape == shape assert ones_like_array.store_path.store == store full_array = group.full(name="full", shape=shape, fill_value=42) assert isinstance(full_array, Array) assert full_array.fill_value == 42 assert full_array.shape == shape assert full_array.store_path.store == store full_like_array = group.full_like(name="full_like", data=full_array, fill_value=43) assert isinstance(full_like_array, Array) assert full_like_array.fill_value == 43 assert full_like_array.shape == shape assert full_like_array.store_path.store == store @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.parametrize("overwrite", [True, False]) @pytest.mark.parametrize("extant_node", ["array", "group"]) def test_group_creation_existing_node( store: Store, zarr_format: ZarrFormat, overwrite: bool, extant_node: Literal["array", "group"], ) -> None: """ Check that an existing array or group is handled as expected during group creation. """ spath = StorePath(store) group = Group.from_store(spath, zarr_format=zarr_format) expected_exception: type[ContainsArrayError | ContainsGroupError] attributes: dict[str, JSON] = {"old": True} if extant_node == "array": expected_exception = ContainsArrayError _ = group.create_array("extant", shape=(10,), dtype="uint8", attributes=attributes) elif extant_node == "group": expected_exception = ContainsGroupError _ = group.create_group("extant", attributes=attributes) else: raise AssertionError new_attributes = {"new": True} if overwrite: if not store.supports_deletes: pytest.skip("store does not support deletes but overwrite is True") node_new = Group.from_store( spath / "extant", attributes=new_attributes, zarr_format=zarr_format, overwrite=overwrite, ) assert node_new.attrs == new_attributes else: with pytest.raises(expected_exception): node_new = Group.from_store( spath / "extant", attributes=new_attributes, zarr_format=zarr_format, overwrite=overwrite, ) async def test_asyncgroup_create( store: Store, overwrite: bool, zarr_format: ZarrFormat, ) -> None: """ Test that `AsyncGroup.from_store` works as expected. """ spath = StorePath(store=store) attributes = {"foo": 100} agroup = await AsyncGroup.from_store( store, attributes=attributes, overwrite=overwrite, zarr_format=zarr_format, ) assert agroup.metadata == GroupMetadata(zarr_format=zarr_format, attributes=attributes) assert agroup.store_path == await make_store_path(store) if not overwrite: with pytest.raises(ContainsGroupError): agroup = await AsyncGroup.from_store( spath, attributes=attributes, overwrite=overwrite, zarr_format=zarr_format, ) # create an array at our target path collision_name = "foo" _ = await zarr.api.asynchronous.create_array( spath / collision_name, shape=(10,), dtype="uint8", zarr_format=zarr_format ) with pytest.raises(ContainsArrayError): _ = await AsyncGroup.from_store( StorePath(store=store) / collision_name, attributes=attributes, overwrite=overwrite, zarr_format=zarr_format, ) async def test_asyncgroup_attrs(store: Store, zarr_format: ZarrFormat) -> None: attributes = {"foo": 100} agroup = await AsyncGroup.from_store(store, zarr_format=zarr_format, attributes=attributes) assert agroup.attrs == agroup.metadata.attributes == attributes async def test_asyncgroup_open( store: Store, zarr_format: ZarrFormat, ) -> None: """ Create an `AsyncGroup`, then ensure that we can open it using `AsyncGroup.open` """ attributes = {"foo": 100} group_w = await AsyncGroup.from_store( store=store, attributes=attributes, overwrite=False, zarr_format=zarr_format, ) group_r = await AsyncGroup.open(store=store, zarr_format=zarr_format) assert group_w.attrs == group_w.attrs == attributes assert group_w == group_r async def test_asyncgroup_open_wrong_format( store: Store, zarr_format: ZarrFormat, ) -> None: _ = await AsyncGroup.from_store(store=store, overwrite=False, zarr_format=zarr_format) zarr_format_wrong: ZarrFormat # try opening with the wrong zarr format if zarr_format == 3: zarr_format_wrong = 2 elif zarr_format == 2: zarr_format_wrong = 3 else: raise AssertionError with pytest.raises(FileNotFoundError): await AsyncGroup.open(store=store, zarr_format=zarr_format_wrong) # todo: replace the dict[str, Any] type with something a bit more specific # should this be async? @pytest.mark.parametrize( "data", [ {"zarr_format": 3, "node_type": "group", "attributes": {"foo": 100}}, {"zarr_format": 2, "attributes": {"foo": 100}}, ], ) def test_asyncgroup_from_dict(store: Store, data: dict[str, Any]) -> None: """ Test that we can create an AsyncGroup from a dict """ path = "test" store_path = StorePath(store=store, path=path) group = AsyncGroup.from_dict(store_path, data=data) assert group.metadata.zarr_format == data["zarr_format"] assert group.metadata.attributes == data["attributes"] # todo: replace this with a declarative API where we model a full hierarchy async def test_asyncgroup_getitem(store: Store, zarr_format: ZarrFormat) -> None: """ Create an `AsyncGroup`, then create members of that group, and ensure that we can access those members via the `AsyncGroup.getitem` method. """ agroup = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) array_name = "sub_array" sub_array = await agroup.create_array(name=array_name, shape=(10,), dtype="uint8", chunks=(2,)) assert await agroup.getitem(array_name) == sub_array sub_group_path = "sub_group" sub_group = await agroup.create_group(sub_group_path, attributes={"foo": 100}) assert await agroup.getitem(sub_group_path) == sub_group # check that asking for a nonexistent key raises KeyError with pytest.raises(KeyError, match="foo"): await agroup.getitem("foo") async def test_asyncgroup_delitem(store: Store, zarr_format: ZarrFormat) -> None: if not store.supports_deletes: pytest.skip("store does not support deletes") agroup = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) array_name = "sub_array" _ = await agroup.create_array( name=array_name, shape=(10,), dtype="uint8", chunks=(2,), attributes={"foo": 100}, ) await agroup.delitem(array_name) # todo: clean up the code duplication here if zarr_format == 2: assert not await agroup.store_path.store.exists(f"{array_name}/.zarray") assert not await agroup.store_path.store.exists(f"{array_name}/.zattrs") elif zarr_format == 3: assert not await agroup.store_path.store.exists(f"{array_name}/zarr.json") else: raise AssertionError sub_group_path = "sub_group" _ = await agroup.create_group(sub_group_path, attributes={"foo": 100}) await agroup.delitem(sub_group_path) if zarr_format == 2: assert not await agroup.store_path.store.exists(f"{array_name}/.zgroup") assert not await agroup.store_path.store.exists(f"{array_name}/.zattrs") elif zarr_format == 3: assert not await agroup.store_path.store.exists(f"{array_name}/zarr.json") else: raise AssertionError @pytest.mark.parametrize("name", ["a", "/a"]) async def test_asyncgroup_create_group( store: Store, name: str, zarr_format: ZarrFormat, ) -> None: agroup = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) attributes = {"foo": 999} subgroup = await agroup.create_group(name=name, attributes=attributes) assert isinstance(subgroup, AsyncGroup) assert subgroup.path == normalize_path(name) assert subgroup.name == f"/{subgroup.path}" assert subgroup.attrs == attributes assert subgroup.store_path.path == subgroup.path assert subgroup.store_path.store == store assert subgroup.metadata.zarr_format == zarr_format async def test_asyncgroup_create_array( store: Store, zarr_format: ZarrFormat, overwrite: bool ) -> None: """ Test that the AsyncGroup.create_array method works correctly. We ensure that array properties specified in create_array are present on the resulting array. """ agroup = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) if not overwrite: with pytest.raises(ContainsGroupError): agroup = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) shape = (10,) dtype = "uint8" chunk_shape = (4,) attributes: dict[str, JSON] = {"foo": 100} sub_node_path = "sub_array" subnode = await agroup.create_array( name=sub_node_path, shape=shape, dtype=dtype, chunks=chunk_shape, attributes=attributes, ) assert isinstance(subnode, AsyncArray) assert subnode.attrs == attributes assert subnode.store_path.path == sub_node_path assert subnode.store_path.store == store assert subnode.shape == shape assert subnode.dtype == dtype assert subnode._chunk_grid.chunk_shape == chunk_shape assert subnode.metadata.zarr_format == zarr_format async def test_asyncgroup_update_attributes(store: Store, zarr_format: ZarrFormat) -> None: """ Test that the AsyncGroup.update_attributes method works correctly. """ attributes_old = {"foo": 10} attributes_new = {"baz": "new"} agroup = await AsyncGroup.from_store( store=store, zarr_format=zarr_format, attributes=attributes_old ) if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name"): agroup_new_attributes = await agroup.update_attributes(attributes_new) else: agroup_new_attributes = await agroup.update_attributes(attributes_new) attributes_updated = attributes_old.copy() attributes_updated.update(attributes_new) assert agroup_new_attributes.attrs == attributes_updated @pytest.mark.parametrize("store", ["local"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_serializable_async_group(store: LocalStore, zarr_format: ZarrFormat) -> None: expected = await AsyncGroup.from_store( store=store, attributes={"foo": 999}, zarr_format=zarr_format ) p = pickle.dumps(expected) actual = pickle.loads(p) assert actual == expected @pytest.mark.parametrize("store", ["local"], indirect=["store"]) @pytest.mark.parametrize("zarr_format", [2, 3]) def test_serializable_sync_group(store: LocalStore, zarr_format: ZarrFormat) -> None: expected = Group.from_store(store=store, attributes={"foo": 999}, zarr_format=zarr_format) p = pickle.dumps(expected) actual = pickle.loads(p) assert actual == expected @pytest.mark.parametrize("consolidated_metadata", [True, False]) async def test_group_members_async(store: Store, consolidated_metadata: bool) -> None: group = await AsyncGroup.from_store( store=store, ) a0 = await group.create_array("a0", shape=(1,), dtype="uint8") g0 = await group.create_group("g0") a1 = await g0.create_array("a1", shape=(1,), dtype="uint8") g1 = await g0.create_group("g1") a2 = await g1.create_array("a2", shape=(1,), dtype="uint8") g2 = await g1.create_group("g2") # immediate children children = sorted([x async for x in group.members()], key=operator.itemgetter(0)) assert children == [ ("a0", a0), ("g0", g0), ] nmembers = await group.nmembers() assert nmembers == 2 # partial children = sorted([x async for x in group.members(max_depth=1)], key=operator.itemgetter(0)) expected = [ ("a0", a0), ("g0", g0), ("g0/a1", a1), ("g0/g1", g1), ] assert children == expected nmembers = await group.nmembers(max_depth=1) assert nmembers == 4 # all children all_children = sorted( [x async for x in group.members(max_depth=None)], key=operator.itemgetter(0) ) expected = [ ("a0", a0), ("g0", g0), ("g0/a1", a1), ("g0/g1", g1), ("g0/g1/a2", a2), ("g0/g1/g2", g2), ] assert all_children == expected if consolidated_metadata: with pytest.warns( # noqa: PT031 ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name"): await zarr.api.asynchronous.consolidate_metadata(store=store) else: await zarr.api.asynchronous.consolidate_metadata(store=store) group = await zarr.api.asynchronous.open_group(store=store) nmembers = await group.nmembers(max_depth=None) assert nmembers == 6 with pytest.raises(ValueError, match="max_depth"): [x async for x in group.members(max_depth=-1)] if consolidated_metadata: # test for mixed known and unknown metadata. # For now, we trust the consolidated metadata. object.__setattr__( group.metadata.consolidated_metadata.metadata["g0"].consolidated_metadata.metadata[ "g1" ], "consolidated_metadata", None, ) # test depth=0 nmembers = await group.nmembers(max_depth=0) assert nmembers == 2 # test depth=1 nmembers = await group.nmembers(max_depth=1) assert nmembers == 4 # test depth=None all_children = sorted( [x async for x in group.members(max_depth=None)], key=operator.itemgetter(0) ) assert len(all_children) == 4 nmembers = await group.nmembers(max_depth=None) assert nmembers == 4 # test depth<0 with pytest.raises(ValueError, match="max_depth"): await group.nmembers(max_depth=-1) async def test_require_group(store: LocalStore | MemoryStore, zarr_format: ZarrFormat) -> None: root = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) # create foo group _ = await root.create_group("foo", attributes={"foo": 100}) # test that we can get the group using require_group foo_group = await root.require_group("foo") assert foo_group.attrs == {"foo": 100} # test that we can get the group using require_group and overwrite=True if store.supports_deletes: foo_group = await root.require_group("foo", overwrite=True) assert foo_group.attrs == {} _ = await foo_group.create_array( "bar", shape=(10,), dtype="uint8", chunks=(2,), attributes={"foo": 100} ) # test that overwriting a group w/ children fails # TODO: figure out why ensure_no_existing_node is not catching the foo.bar array # # with pytest.raises(ContainsArrayError): # await root.require_group("foo", overwrite=True) # test that requiring a group where an array is fails with pytest.raises(TypeError, match="Incompatible object"): await foo_group.require_group("bar") async def test_require_groups(store: LocalStore | MemoryStore, zarr_format: ZarrFormat) -> None: root = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) # create foo group _ = await root.create_group("foo", attributes={"foo": 100}) # create bar group _ = await root.create_group("bar", attributes={"bar": 200}) foo_group, bar_group = await root.require_groups("foo", "bar") assert foo_group.attrs == {"foo": 100} assert bar_group.attrs == {"bar": 200} # get a mix of existing and new groups foo_group, spam_group = await root.require_groups("foo", "spam") assert foo_group.attrs == {"foo": 100} assert spam_group.attrs == {} # no names no_group = await root.require_groups() assert no_group == () async def test_require_array(store: Store, zarr_format: ZarrFormat) -> None: root = await AsyncGroup.from_store(store=store, zarr_format=zarr_format) foo1 = await root.require_array("foo", shape=(10,), dtype="i8", attributes={"foo": 101}) assert foo1.attrs == {"foo": 101} foo2 = await root.require_array("foo", shape=(10,), dtype="i8") assert foo2.attrs == {"foo": 101} # exact = False _ = await root.require_array("foo", shape=10, dtype="f8") # errors w/ exact True with pytest.raises(TypeError, match="Incompatible dtype"): await root.require_array("foo", shape=(10,), dtype="f8", exact=True) with pytest.raises(TypeError, match="Incompatible shape"): await root.require_array("foo", shape=(100, 100), dtype="i8") with pytest.raises(TypeError, match="Incompatible dtype"): await root.require_array("foo", shape=(10,), dtype="f4") _ = await root.create_group("bar") with pytest.raises(TypeError, match="Incompatible object"): await root.require_array("bar", shape=(10,), dtype="int8") @pytest.mark.parametrize("consolidate", [True, False]) async def test_members_name(store: Store, consolidate: bool, zarr_format: ZarrFormat): group = Group.from_store(store=store, zarr_format=zarr_format) a = group.create_group(name="a") a.create_array("array", shape=(1,), dtype="uint8") b = a.create_group(name="b") b.create_array("array", shape=(1,), dtype="uint8") if consolidate: if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name"): # noqa: PT031 if zarr_format == 3: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): group = zarr.api.synchronous.consolidate_metadata(store) else: group = zarr.api.synchronous.consolidate_metadata(store) else: if zarr_format == 3: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): group = zarr.api.synchronous.consolidate_metadata(store) else: group = zarr.api.synchronous.consolidate_metadata(store) result = group["a"]["b"] assert result.name == "/a/b" paths = sorted(x.name for _, x in group.members(max_depth=None)) expected = ["/a", "/a/array", "/a/b", "/a/b/array"] assert paths == expected # regression test for https://github.com/zarr-developers/zarr-python/pull/2356 g = zarr.open_group(store, use_consolidated=False) with warnings.catch_warnings(): warnings.simplefilter("error") assert list(g) async def test_open_mutable_mapping(): group = await zarr.api.asynchronous.open_group( store={}, ) assert isinstance(group.store_path.store, MemoryStore) def test_open_mutable_mapping_sync(): group = zarr.open_group( store={}, ) assert isinstance(group.store_path.store, MemoryStore) async def test_open_ambiguous_node(): zarr_json_bytes = default_buffer_prototype().buffer.from_bytes( json.dumps({"zarr_format": 3, "node_type": "group"}).encode("utf-8") ) zgroup_bytes = default_buffer_prototype().buffer.from_bytes( json.dumps({"zarr_format": 2}).encode("utf-8") ) store: dict[str, Buffer] = {"zarr.json": zarr_json_bytes, ".zgroup": zgroup_bytes} with pytest.warns( ZarrUserWarning, match=r"Both zarr\.json \(Zarr format 3\) and \.zgroup \(Zarr format 2\) metadata objects exist at", ): await AsyncGroup.open(store, zarr_format=None) class TestConsolidated: async def test_group_getitem_consolidated(self, store: Store) -> None: root = await AsyncGroup.from_store(store=store) # Set up the test structure with # / # g0/ # group /g0 # g1/ # group /g0/g1 # g2/ # group /g0/g1/g2 # x1/ # group /x0 # x2/ # group /x0/x1 # x3/ # group /x0/x1/x2 g0 = await root.create_group("g0") g1 = await g0.create_group("g1") await g1.create_group("g2") x0 = await root.create_group("x0") x1 = await x0.create_group("x1") await x1.create_group("x2") with pytest.warns( # noqa: PT031 ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name"): await zarr.api.asynchronous.consolidate_metadata(store) else: await zarr.api.asynchronous.consolidate_metadata(store) # On disk, we've consolidated all the metadata in the root zarr.json group = await zarr.api.asynchronous.open(store=store) rg0 = await group.get_group("g0") expected = ConsolidatedMetadata( metadata={ "g1": GroupMetadata( attributes={}, zarr_format=3, consolidated_metadata=ConsolidatedMetadata( metadata={ "g2": GroupMetadata( attributes={}, zarr_format=3, consolidated_metadata=ConsolidatedMetadata(metadata={}), ) } ), ), } ) assert rg0.metadata.consolidated_metadata == expected rg1 = await rg0.get_group("g1") assert rg1.metadata.consolidated_metadata == expected.metadata["g1"].consolidated_metadata rg2 = await rg1.get_group("g2") assert rg2.metadata.consolidated_metadata == ConsolidatedMetadata(metadata={}) async def test_group_delitem_consolidated(self, store: Store) -> None: if isinstance(store, ZipStore): raise pytest.skip("Not implemented") root = await AsyncGroup.from_store(store=store) # Set up the test structure with # / # g0/ # group /g0 # g1/ # group /g0/g1 # g2/ # group /g0/g1/g2 # data # array # x1/ # group /x0 # x2/ # group /x0/x1 # x3/ # group /x0/x1/x2 # data # array g0 = await root.create_group("g0") g1 = await g0.create_group("g1") g2 = await g1.create_group("g2") await g2.create_array("data", shape=(1,), dtype="uint8") x0 = await root.create_group("x0") x1 = await x0.create_group("x1") x2 = await x1.create_group("x2") await x2.create_array("data", shape=(1,), dtype="uint8") with pytest.warns( # noqa: PT031 ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): if isinstance(store, ZipStore): with pytest.warns(UserWarning, match="Duplicate name"): await zarr.api.asynchronous.consolidate_metadata(store) else: await zarr.api.asynchronous.consolidate_metadata(store) group = await zarr.api.asynchronous.open_consolidated(store=store) assert len(group.metadata.consolidated_metadata.metadata) == 2 assert "g0" in group.metadata.consolidated_metadata.metadata await group.delitem("g0") assert len(group.metadata.consolidated_metadata.metadata) == 1 assert "g0" not in group.metadata.consolidated_metadata.metadata def test_open_consolidated_raises(self, store: Store) -> None: if isinstance(store, ZipStore): raise pytest.skip("Not implemented") root = Group.from_store(store=store) # fine to be missing by default zarr.open_group(store=store) with pytest.raises(ValueError, match="Consolidated metadata requested."): zarr.open_group(store=store, use_consolidated=True) # Now create consolidated metadata... root.create_group("g0") with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): zarr.consolidate_metadata(store) # and explicitly ignore it. group = zarr.open_group(store=store, use_consolidated=False) assert group.metadata.consolidated_metadata is None async def test_open_consolidated_raises_async(self, store: Store) -> None: if isinstance(store, ZipStore): raise pytest.skip("Not implemented") root = await AsyncGroup.from_store(store=store) # fine to be missing by default await zarr.api.asynchronous.open_group(store=store) with pytest.raises(ValueError, match="Consolidated metadata requested."): await zarr.api.asynchronous.open_group(store=store, use_consolidated=True) # Now create consolidated metadata... await root.create_group("g0") with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(store) # and explicitly ignore it. group = await zarr.api.asynchronous.open_group(store=store, use_consolidated=False) assert group.metadata.consolidated_metadata is None class TestGroupMetadata: def test_from_dict_extra_fields(self): data = { "attributes": {"key": "value"}, "_nczarr_superblock": {"version": "2.0.0"}, "zarr_format": 2, } result = GroupMetadata.from_dict(data) expected = GroupMetadata(attributes={"key": "value"}, zarr_format=2) assert result == expected class TestInfo: def test_info(self): store = zarr.storage.MemoryStore() A = zarr.group(store=store, path="A") B = A.create_group(name="B") B.create_array(name="x", shape=(1,), dtype="uint8") B.create_array(name="y", shape=(2,), dtype="uint8") result = A.info expected = GroupInfo( _name="A", _read_only=False, _store_type="MemoryStore", _zarr_format=3, ) assert result == expected result = A.info_complete() expected = GroupInfo( _name="A", _read_only=False, _store_type="MemoryStore", _zarr_format=3, _count_members=3, _count_arrays=2, _count_groups=1, ) assert result == expected def test_update_attrs() -> None: # regression test for https://github.com/zarr-developers/zarr-python/issues/2328 root = Group.from_store( MemoryStore(), ) root.attrs["foo"] = "bar" assert root.attrs["foo"] == "bar" @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) def test_delitem_removes_children(store: Store, zarr_format: ZarrFormat) -> None: # https://github.com/zarr-developers/zarr-python/issues/2191 g1 = zarr.group(store=store, zarr_format=zarr_format) g1.create_group("0") g1.create_group("0/0") arr = g1.create_array("0/0/0", shape=(1,), dtype="uint8") arr[:] = 1 del g1["0"] with pytest.raises(KeyError, match="0/0"): g1["0/0"] @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_nodes( impl: Literal["async", "sync"], store: Store, zarr_format: ZarrFormat ) -> None: """ Ensure that ``create_nodes`` can create a zarr hierarchy from a model of that hierarchy in dict form. Note that this creates an incomplete Zarr hierarchy. """ node_spec = { "group": GroupMetadata(attributes={"foo": 10}), "group/array_0": meta_from_array(np.arange(3), zarr_format=zarr_format), "group/array_1": meta_from_array(np.arange(4), zarr_format=zarr_format), "group/subgroup/array_0": meta_from_array(np.arange(4), zarr_format=zarr_format), "group/subgroup/array_1": meta_from_array(np.arange(5), zarr_format=zarr_format), } if impl == "sync": observed_nodes = dict(sync_group.create_nodes(store=store, nodes=node_spec)) elif impl == "async": observed_nodes = dict(await _collect_aiterator(create_nodes(store=store, nodes=node_spec))) else: raise ValueError(f"Invalid impl: {impl}") assert node_spec == {k: v.metadata for k, v in observed_nodes.items()} @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_create_nodes_concurrency_limit(store: MemoryStore) -> None: """ Test that the execution time of create_nodes can be constrained by the async concurrency configuration setting. """ set_latency = 0.02 num_groups = 10 groups = {str(idx): GroupMetadata() for idx in range(num_groups)} latency_store = LatencyStore(store, set_latency=set_latency) # check how long it takes to iterate over the groups # if create_nodes is sensitive to IO latency, # this should take (num_groups * get_latency) seconds # otherwise, it should take only marginally more than get_latency seconds with zarr_config.set({"async.concurrency": 1}): start = time.time() _ = tuple(sync_group.create_nodes(store=latency_store, nodes=groups)) elapsed = time.time() - start assert elapsed > num_groups * set_latency @pytest.mark.parametrize( ("a_func", "b_func"), [ (zarr.core.group.AsyncGroup.create_array, zarr.core.group.Group.create_array), (zarr.core.group.AsyncGroup.create_hierarchy, zarr.core.group.Group.create_hierarchy), (zarr.core.group.create_hierarchy, zarr.core.sync_group.create_hierarchy), (zarr.core.group.create_nodes, zarr.core.sync_group.create_nodes), (zarr.core.group.create_rooted_hierarchy, zarr.core.sync_group.create_rooted_hierarchy), (zarr.core.group.get_node, zarr.core.sync_group.get_node), ], # The default ids (from __name__) collide: the method pair and the module-level pair # for create_hierarchy would both be id'd "create_hierarchy-create_hierarchy". ids=lambda func: f"{func.__module__.rsplit('.', maxsplit=1)[-1]}.{func.__qualname__}", ) def test_consistent_signatures( a_func: Callable[[object], object], b_func: Callable[[object], object] ) -> None: """ Ensure that pairs of functions have consistent signatures """ base_sig = inspect.signature(a_func) test_sig = inspect.signature(b_func) wrong: dict[str, list[object]] = { "missing_from_test": [], "missing_from_base": [], "wrong_type": [], } for key, value in base_sig.parameters.items(): if key not in test_sig.parameters: wrong["missing_from_test"].append((key, value)) for key, value in test_sig.parameters.items(): if key not in base_sig.parameters: wrong["missing_from_base"].append((key, value)) if base_sig.parameters[key] != value: wrong["wrong_type"].append({key: {"test": value, "base": base_sig.parameters[key]}}) assert wrong["missing_from_base"] == [] assert wrong["missing_from_test"] == [] assert wrong["wrong_type"] == [] @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("overwrite", [True, False]) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_hierarchy( impl: Literal["async", "sync"], store: Store, overwrite: bool, zarr_format: ZarrFormat ) -> None: """ Test that ``create_hierarchy`` can create a complete Zarr hierarchy, even if the input describes an incomplete one. """ hierarchy_spec = { "group": GroupMetadata(attributes={"path": "group"}, zarr_format=zarr_format), "group/array_0": meta_from_array( np.arange(3), attributes={"path": "group/array_0"}, zarr_format=zarr_format ), "group/subgroup/array_0": meta_from_array( np.arange(4), attributes={"path": "group/subgroup/array_0"}, zarr_format=zarr_format ), } pre_existing_nodes = { "group/extra": GroupMetadata(zarr_format=zarr_format, attributes={"path": "group/extra"}), "": GroupMetadata(zarr_format=zarr_format, attributes={"name": "root"}), } # we expect create_hierarchy to insert a group that was missing from the hierarchy spec expected_meta = hierarchy_spec | {"group/subgroup": GroupMetadata(zarr_format=zarr_format)} # initialize the group with some nodes _ = dict(sync_group.create_nodes(store=store, nodes=pre_existing_nodes)) if impl == "sync": created = dict( sync_group.create_hierarchy(store=store, nodes=hierarchy_spec, overwrite=overwrite) ) elif impl == "async": created = { k: v async for k, v in create_hierarchy( store=store, nodes=hierarchy_spec, overwrite=overwrite ) } else: raise ValueError(f"Invalid impl: {impl}") if not overwrite: extra_group = sync_group.get_node(store=store, path="group/extra", zarr_format=zarr_format) assert extra_group.metadata.attributes == {"path": "group/extra"} else: with pytest.raises(FileNotFoundError): await get_node(store=store, path="group/extra", zarr_format=zarr_format) assert expected_meta == {k: v.metadata for k, v in created.items()} @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("extant_node", ["array", "group"]) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_hierarchy_existing_nodes( impl: Literal["async", "sync"], store: Store, extant_node: Literal["array", "group"], zarr_format: ZarrFormat, ) -> None: """ Test that create_hierarchy with overwrite = False will not overwrite an existing array or group, and raises an exception instead. """ extant_node_path = "node" if extant_node == "array": extant_metadata = meta_from_array( np.zeros(4), zarr_format=zarr_format, attributes={"extant": True} ) new_metadata = meta_from_array(np.zeros(4), zarr_format=zarr_format) err_cls = ContainsArrayError else: extant_metadata = GroupMetadata(zarr_format=zarr_format, attributes={"extant": True}) new_metadata = GroupMetadata(zarr_format=zarr_format) err_cls = ContainsGroupError # write the extant metadata tuple(sync_group.create_nodes(store=store, nodes={extant_node_path: extant_metadata})) msg = f"{extant_node} exists in store {store!r} at path {extant_node_path!r}." # ensure that we cannot invoke create_hierarchy with overwrite=False here if impl == "sync": with pytest.raises(err_cls, match=re.escape(msg)): tuple( sync_group.create_hierarchy( store=store, nodes={"node": new_metadata}, overwrite=False ) ) elif impl == "async": with pytest.raises(err_cls, match=re.escape(msg)): tuple( [ x async for x in create_hierarchy( store=store, nodes={"node": new_metadata}, overwrite=False ) ] ) else: raise ValueError(f"Invalid impl: {impl}") # ensure that the extant metadata was not overwritten assert ( await get_node(store=store, path=extant_node_path, zarr_format=zarr_format) ).metadata.attributes == {"extant": True} @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("overwrite", [True, False]) @pytest.mark.parametrize("group_path", ["", "foo"]) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_group_create_hierarchy( store: Store, zarr_format: ZarrFormat, overwrite: bool, group_path: str, impl: Literal["async", "sync"], ) -> None: """ Test that the Group.create_hierarchy method creates specified nodes and returns them in a dict. Also test that off-target nodes are not deleted, and that the root group is not deleted """ root_attrs = {"root": True} g = sync_group.create_rooted_hierarchy( store=store, nodes={group_path: GroupMetadata(zarr_format=zarr_format, attributes=root_attrs)}, ) node_spec = { "a": GroupMetadata(zarr_format=zarr_format, attributes={"name": "a"}), "a/b": GroupMetadata(zarr_format=zarr_format, attributes={"name": "a/b"}), "a/b/c": meta_from_array( np.zeros(5), zarr_format=zarr_format, attributes={"name": "a/b/c"} ), } # This node should be kept if overwrite is True extant_spec = {"b": GroupMetadata(zarr_format=zarr_format, attributes={"name": "b"})} if impl == "async": extant_created = dict( await _collect_aiterator(g._async_group.create_hierarchy(extant_spec, overwrite=False)) ) nodes_created = dict( await _collect_aiterator( g._async_group.create_hierarchy(node_spec, overwrite=overwrite) ) ) elif impl == "sync": extant_created = dict(g.create_hierarchy(extant_spec, overwrite=False)) nodes_created = dict(g.create_hierarchy(node_spec, overwrite=overwrite)) all_members = dict(g.members(max_depth=None)) for k, v in node_spec.items(): assert all_members[k].metadata == v == nodes_created[k].metadata # if overwrite is True, the extant nodes should be erased for k, v in extant_spec.items(): if overwrite: assert k in all_members else: assert all_members[k].metadata == v == extant_created[k].metadata # ensure that we left the root group as-is assert ( sync_group.get_node(store=store, path=group_path, zarr_format=zarr_format).attrs.asdict() == root_attrs ) @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("overwrite", [True, False]) def test_group_create_hierarchy_no_root( store: Store, zarr_format: ZarrFormat, overwrite: bool ) -> None: """ Test that the Group.create_hierarchy method will error if the dict provided contains a root. """ g = Group.from_store(store, zarr_format=zarr_format) tree = { "": GroupMetadata(zarr_format=zarr_format, attributes={"name": "a"}), } with pytest.raises( ValueError, match="It is an error to use this method to create a root node. " ): _ = dict(g.create_hierarchy(tree, overwrite=overwrite)) class TestParseHierarchyDict: """ Tests for the function that parses dicts of str : Metadata pairs, ensuring that the output models a valid Zarr hierarchy """ @staticmethod def test_normed_keys() -> None: """ Test that keys get normalized properly """ nodes = { "a": GroupMetadata(), "/b": GroupMetadata(), "": GroupMetadata(), "/a//c////": GroupMetadata(), } observed = _parse_hierarchy_dict(data=nodes) expected = {normalize_path(k): v for k, v in nodes.items()} assert observed == expected @staticmethod def test_empty() -> None: """ Test that an empty dict passes through """ assert _parse_hierarchy_dict(data={}) == {} @staticmethod def test_implicit_groups() -> None: """ Test that implicit groups were added as needed. """ requested = {"a/b/c": GroupMetadata()} expected = requested | { "": ImplicitGroupMarker(), "a": ImplicitGroupMarker(), "a/b": ImplicitGroupMarker(), } observed = _parse_hierarchy_dict(data=requested) assert observed == expected @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_group_create_hierarchy_invalid_mixed_zarr_format( store: Store, zarr_format: ZarrFormat ) -> None: """ Test that ``Group.create_hierarchy`` will raise an error if the zarr_format of the nodes is different from the parent group. """ other_format = 2 if zarr_format == 3 else 3 g = Group.from_store(store, zarr_format=other_format) tree = { "a": GroupMetadata(zarr_format=zarr_format, attributes={"name": "a"}), "a/b": meta_from_array(np.zeros(5), zarr_format=zarr_format, attributes={"name": "a/c"}), } msg = "The zarr_format of the nodes must be the same as the parent group." with pytest.raises(ValueError, match=msg): _ = tuple(g.create_hierarchy(tree)) @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("defect", ["array/array", "array/group"]) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_hierarchy_invalid_nested( impl: Literal["async", "sync"], store: Store, defect: tuple[str, str], zarr_format: ZarrFormat ) -> None: """ Test that create_hierarchy will not create a Zarr array that contains a Zarr group or Zarr array. """ if defect == "array/array": hierarchy_spec = { "array_0": meta_from_array(np.arange(3), zarr_format=zarr_format), "array_0/subarray": meta_from_array(np.arange(4), zarr_format=zarr_format), } elif defect == "array/group": hierarchy_spec = { "array_0": meta_from_array(np.arange(3), zarr_format=zarr_format), "array_0/subgroup": GroupMetadata(attributes={"foo": 10}, zarr_format=zarr_format), } msg = "Only Zarr groups can contain other nodes." if impl == "sync": with pytest.raises(ValueError, match=msg): tuple(sync_group.create_hierarchy(store=store, nodes=hierarchy_spec)) elif impl == "async": with pytest.raises(ValueError, match=msg): await _collect_aiterator(create_hierarchy(store=store, nodes=hierarchy_spec)) @pytest.mark.parametrize("store", ["memory"], indirect=True) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_hierarchy_invalid_mixed_format( impl: Literal["async", "sync"], store: Store ) -> None: """ Test that create_hierarchy will not create a Zarr group that contains a both Zarr v2 and Zarr v3 nodes. """ msg = ( "Got data with both Zarr v2 and Zarr v3 nodes, which is invalid. " "The following keys map to Zarr v2 nodes: ['v2']. " "The following keys map to Zarr v3 nodes: ['v3']." "Ensure that all nodes have the same Zarr format." ) nodes = { "v2": GroupMetadata(zarr_format=2), "v3": GroupMetadata(zarr_format=3), } if impl == "sync": with pytest.raises(ValueError, match=re.escape(msg)): tuple( sync_group.create_hierarchy( store=store, nodes=nodes, ) ) elif impl == "async": with pytest.raises(ValueError, match=re.escape(msg)): await _collect_aiterator( create_hierarchy( store=store, nodes=nodes, ) ) else: raise ValueError(f"Invalid impl: {impl}") @pytest.mark.parametrize("store", ["memory", "local"], indirect=True) @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.parametrize("root_key", ["", "root"]) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_rooted_hierarchy_group( impl: Literal["async", "sync"], store: Store, zarr_format, root_key: str ) -> None: """ Test that the _create_rooted_hierarchy can create a group. """ root_meta = {root_key: GroupMetadata(zarr_format=zarr_format, attributes={"path": root_key})} group_names = ["a", "a/b"] array_names = ["a/b/c", "a/b/d"] # just to ensure that we don't use the same name twice in tests assert set(group_names) & set(array_names) == set() groups_expected_meta = { _join_paths([root_key, node_name]): GroupMetadata( zarr_format=zarr_format, attributes={"path": node_name} ) for node_name in group_names } arrays_expected_meta = { _join_paths([root_key, node_name]): meta_from_array(np.zeros(4), zarr_format=zarr_format) for node_name in array_names } nodes_create = root_meta | groups_expected_meta | arrays_expected_meta if impl == "sync": g = sync_group.create_rooted_hierarchy(store=store, nodes=nodes_create) assert isinstance(g, Group) members = g.members(max_depth=None) elif impl == "async": g = await create_rooted_hierarchy(store=store, nodes=nodes_create) assert isinstance(g, AsyncGroup) members = await _collect_aiterator(g.members(max_depth=None)) else: raise ValueError(f"Unknown implementation: {impl}") assert g.metadata.attributes == {"path": root_key} members_observed_meta = {k: v.metadata for k, v in members} members_expected_meta_relative = { k.removeprefix(root_key).lstrip("/"): v for k, v in (groups_expected_meta | arrays_expected_meta).items() } assert members_observed_meta == members_expected_meta_relative @pytest.mark.parametrize("store", ["memory", "local"], indirect=True) @pytest.mark.parametrize("zarr_format", [2, 3]) @pytest.mark.parametrize("root_key", ["", "root"]) @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_rooted_hierarchy_array( impl: Literal["async", "sync"], store: Store, zarr_format, root_key: str ) -> None: """ Test that _create_rooted_hierarchy can create an array. """ root_meta = { root_key: meta_from_array( np.arange(3), zarr_format=zarr_format, attributes={"path": root_key} ) } nodes_create = root_meta if impl == "sync": a = sync_group.create_rooted_hierarchy(store=store, nodes=nodes_create, overwrite=True) assert isinstance(a, Array) elif impl == "async": a = await create_rooted_hierarchy(store=store, nodes=nodes_create, overwrite=True) assert isinstance(a, AsyncArray) else: raise ValueError(f"Invalid impl: {impl}") assert a.metadata.attributes == {"path": root_key} @pytest.mark.parametrize("impl", ["async", "sync"]) async def test_create_rooted_hierarchy_invalid(impl: Literal["async", "sync"]) -> None: """ Ensure _create_rooted_hierarchy will raise a ValueError if the input does not contain a root node. """ zarr_format = 3 nodes = { "a": GroupMetadata(zarr_format=zarr_format), "b": GroupMetadata(zarr_format=zarr_format), } msg = "The input does not specify a root node. " if impl == "sync": with pytest.raises(ValueError, match=msg): sync_group.create_rooted_hierarchy(store=store, nodes=nodes) elif impl == "async": with pytest.raises(ValueError, match=msg): await create_rooted_hierarchy(store=store, nodes=nodes) else: raise ValueError(f"Invalid impl: {impl}") @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_group_members_performance(store: Store) -> None: """ Test that the execution time of Group.members is less than the number of members times the latency for accessing each member. """ get_latency = 0.1 # use the input store to create some groups group_create = zarr.group(store=store) num_groups = 10 # Create some groups for i in range(num_groups): group_create.create_group(f"group{i}") latency_store = LatencyStore(store, get_latency=get_latency) # create a group with some latency on get operations group_read = zarr.group(store=latency_store) # check how long it takes to iterate over the groups # if .members is sensitive to IO latency, # this should take (num_groups * get_latency) seconds # otherwise, it should take only marginally more than get_latency seconds start = time.time() _ = group_read.members() elapsed = time.time() - start assert elapsed < (num_groups * get_latency) @pytest.mark.parametrize("store", ["memory"], indirect=True) def test_group_members_concurrency_limit(store: MemoryStore) -> None: """ Test that the execution time of Group.members can be constrained by the async concurrency configuration setting. """ get_latency = 0.02 # use the input store to create some groups group_create = zarr.group(store=store) num_groups = 10 # Create some groups for i in range(num_groups): group_create.create_group(f"group{i}") latency_store = LatencyStore(store, get_latency=get_latency) # create a group with some latency on get operations group_read = zarr.group(store=latency_store) # check how long it takes to iterate over the groups # if .members is sensitive to IO latency, # this should take (num_groups * get_latency) seconds # otherwise, it should take only marginally more than get_latency seconds with zarr_config.set({"async.concurrency": 1}): start = time.time() _ = group_read.members() elapsed = time.time() - start assert elapsed > num_groups * get_latency @pytest.mark.parametrize("option", ["array", "group", "invalid"]) def test_build_metadata_v3(option: Literal["array", "group", "invalid"]) -> None: """ Test that _build_metadata_v3 returns the correct metadata for a v3 array or group """ match option: case "array": metadata_dict = meta_from_array(np.arange(10), zarr_format=3).to_dict() assert _build_metadata_v3(metadata_dict) == ArrayV3Metadata.from_dict(metadata_dict) case "group": metadata_dict = GroupMetadata(attributes={"foo": 10}, zarr_format=3).to_dict() assert _build_metadata_v3(metadata_dict) == GroupMetadata.from_dict(metadata_dict) case "invalid": metadata_dict = GroupMetadata(zarr_format=3).to_dict() metadata_dict.pop("node_type") # TODO: fix the error message msg = "Required key 'node_type' is missing from the provided metadata document." with pytest.raises(MetadataValidationError, match=msg): _build_metadata_v3(metadata_dict) @pytest.mark.parametrize("roots", [("",), ("a", "b")]) def test_get_roots(roots: tuple[str, ...]): root_nodes = {k: GroupMetadata(attributes={"name": k}) for k in roots} child_nodes = { _join_paths([k, "foo"]): GroupMetadata(attributes={"name": _join_paths([k, "foo"])}) for k in roots } data = root_nodes | child_nodes assert set(_get_roots(data)) == set(roots) def test_open_array_as_group(): z = zarr.create_array(shape=(40, 50), chunks=(10, 10), dtype="f8", store={}) with pytest.raises(ContainsArrayError): zarr.open_group(z.store) zarr-python-3.3.0/tests/test_indexing.py000066400000000000000000002620531523267620000204050ustar00rootroot00000000000000from __future__ import annotations import itertools from collections import Counter from typing import TYPE_CHECKING, Any from uuid import uuid4 import numpy as np import numpy.typing as npt import pytest from numpy.testing import assert_array_equal import zarr from tests.conftest import Expect, ExpectFail from zarr import Array from zarr.core.buffer import default_buffer_prototype from zarr.core.chunk_grids import ChunkGrid from zarr.core.indexing import ( BasicSelection, CoordinateIndexer, CoordinateSelection, OrthogonalSelection, Selection, _ArrayIndexingOrder, _iter_grid, _iter_regions, ceildiv, make_slice_selection, normalize_integer_selection, oindex, oindex_set, replace_ellipsis, ) from zarr.registry import get_ndbuffer_class from zarr.storage import MemoryStore, StorePath if TYPE_CHECKING: from collections.abc import AsyncGenerator from zarr.abc.store import ByteRequest from zarr.core.buffer import BufferPrototype from zarr.core.buffer.core import Buffer @pytest.fixture async def store() -> AsyncGenerator[StorePath]: return StorePath(await MemoryStore.open()) def zarr_array_from_numpy_array( store: StorePath, a: npt.NDArray[Any], chunk_shape: tuple[int, ...] | None = None, ) -> zarr.Array: z = zarr.create_array( store=store / str(uuid4()), shape=a.shape, dtype=a.dtype, chunks=chunk_shape or a.shape, chunk_key_encoding={"name": "v2", "separator": "."}, ) z[()] = a return z class CountingDict(MemoryStore): counter: Counter[tuple[str, str]] @classmethod async def open(cls) -> CountingDict: store = await super().open() store.counter = Counter() return store async def get( self, key: str, prototype: BufferPrototype, byte_range: tuple[int | None, int | None] | None = None, ) -> Buffer | None: key_suffix = "/".join(key.split("/")[1:]) self.counter["__getitem__", key_suffix] += 1 return await super().get(key, prototype, byte_range) async def set(self, key: str, value: Buffer, byte_range: tuple[int, int] | None = None) -> None: key_suffix = "/".join(key.split("/")[1:]) self.counter["__setitem__", key_suffix] += 1 return await super().set(key, value, byte_range) def get_sync( self, key: str, *, prototype: BufferPrototype | None = None, byte_range: ByteRequest | None = None, ) -> Buffer | None: key_suffix = "/".join(key.split("/")[1:]) self.counter["__getitem__", key_suffix] += 1 return super().get_sync(key, prototype=prototype, byte_range=byte_range) def set_sync(self, key: str, value: Buffer) -> None: key_suffix = "/".join(key.split("/")[1:]) self.counter["__setitem__", key_suffix] += 1 return super().set_sync(key, value) def test_normalize_integer_selection() -> None: """normalize_integer_selection handles positive/negative indices and raises IndexError for out-of-bounds values.""" assert 1 == normalize_integer_selection(1, 100) assert 99 == normalize_integer_selection(-1, 100) with pytest.raises(IndexError): normalize_integer_selection(100, 100) with pytest.raises(IndexError): normalize_integer_selection(1000, 100) with pytest.raises(IndexError): normalize_integer_selection(-1000, 100) def test_replace_ellipsis() -> None: """replace_ellipsis expands Ellipsis to full slice(None) selections for 1D and 2D shapes.""" # 1D, single item assert (0,) == replace_ellipsis(0, (100,)) # 1D assert (slice(None),) == replace_ellipsis(Ellipsis, (100,)) assert (slice(None),) == replace_ellipsis(slice(None), (100,)) assert (slice(None, 100),) == replace_ellipsis(slice(None, 100), (100,)) assert (slice(0, None),) == replace_ellipsis(slice(0, None), (100,)) assert (slice(None),) == replace_ellipsis((slice(None), Ellipsis), (100,)) assert (slice(None),) == replace_ellipsis((Ellipsis, slice(None)), (100,)) # 2D, single item assert (0, 0) == replace_ellipsis((0, 0), (100, 100)) assert (-1, 1) == replace_ellipsis((-1, 1), (100, 100)) # 2D, single col/row assert (0, slice(None)) == replace_ellipsis((0, slice(None)), (100, 100)) assert (0, slice(None)) == replace_ellipsis((0,), (100, 100)) assert (slice(None), 0) == replace_ellipsis((slice(None), 0), (100, 100)) # 2D slice assert (slice(None), slice(None)) == replace_ellipsis(Ellipsis, (100, 100)) assert (slice(None), slice(None)) == replace_ellipsis(slice(None), (100, 100)) assert (slice(None), slice(None)) == replace_ellipsis((slice(None), slice(None)), (100, 100)) assert (slice(None), slice(None)) == replace_ellipsis((Ellipsis, slice(None)), (100, 100)) assert (slice(None), slice(None)) == replace_ellipsis((slice(None), Ellipsis), (100, 100)) assert (slice(None), slice(None)) == replace_ellipsis( (slice(None), Ellipsis, slice(None)), (100, 100) ) assert (slice(None), slice(None)) == replace_ellipsis( (Ellipsis, slice(None), slice(None)), (100, 100) ) assert (slice(None), slice(None)) == replace_ellipsis( (slice(None), slice(None), Ellipsis), (100, 100) ) @pytest.mark.parametrize( ("value", "dtype"), [ (42, "uint8"), pytest.param( (b"aaa", 1, 4.2), [("foo", "S3"), ("bar", "i4"), ("baz", "f8")], marks=pytest.mark.filterwarnings("ignore::zarr.errors.UnstableSpecificationWarning"), ), ], ) @pytest.mark.parametrize("use_out", [True, False]) def test_get_basic_selection_0d(store: StorePath, use_out: bool, value: Any, dtype: Any) -> None: """get_basic_selection on a 0-dimensional array returns the scalar value via Ellipsis and (), including the `out` buffer path.""" # setup arr_np = np.array(value, dtype=dtype) arr_z = zarr_array_from_numpy_array(store, arr_np) assert_array_equal(arr_np, arr_z.get_basic_selection(Ellipsis)) assert_array_equal(arr_np, arr_z[...]) assert arr_np[()] == arr_z.get_basic_selection(()) assert arr_np[()] == arr_z[()] if use_out: # test out param b = default_buffer_prototype().nd_buffer.from_numpy_array(np.zeros_like(arr_np)) arr_z.get_basic_selection(Ellipsis, out=b) assert_array_equal(arr_np, b.as_ndarray_like()) # todo: uncomment the structured array tests when we can make them pass, # or delete them if we formally decide not to support structured dtypes. # test structured array # value = (b"aaa", 1, 4.2) # a = np.array(value, dtype=[("foo", "S3"), ("bar", "i4"), ("baz", "f8")]) # z = zarr_array_from_numpy_array(store, a) # z[()] = value # assert_array_equal(a, z.get_basic_selection(Ellipsis)) # assert_array_equal(a, z[...]) # assert a[()] == z.get_basic_selection(()) # assert a[()] == z[()] # assert b"aaa" == z.get_basic_selection((), fields="foo") # assert b"aaa" == z["foo"] # assert a[["foo", "bar"]] == z.get_basic_selection((), fields=["foo", "bar"]) # assert a[["foo", "bar"]] == z["foo", "bar"] # # test out param # b = NDBuffer.from_numpy_array(np.zeros_like(a)) # z.get_basic_selection(Ellipsis, out=b) # assert_array_equal(a, b) # c = NDBuffer.from_numpy_array(np.zeros_like(a[["foo", "bar"]])) # z.get_basic_selection(Ellipsis, out=c, fields=["foo", "bar"]) # assert_array_equal(a[["foo", "bar"]], c) _BASIC_1D_CASES: list[Expect[BasicSelection, None]] = [ Expect(input=5, output=None, id="single-positive"), Expect(input=-1, output=None, id="single-negative"), Expect(input=slice(3, 18), output=None, id="bounded-slice"), Expect(input=slice(0, 100), output=None, id="over-bounds-slice"), Expect(input=slice(-18, -3), output=None, id="negative-slice"), Expect(input=slice(0, 0), output=None, id="empty-slice"), Expect(input=slice(-1, 0), output=None, id="empty-negative-slice"), Expect(input=slice(None), output=None, id="full-slice"), Expect(input=Ellipsis, output=None, id="ellipsis"), Expect(input=(), output=None, id="empty-tuple"), Expect(input=(Ellipsis, slice(None)), output=None, id="ellipsis-slice"), Expect(input=slice(None, None, 3), output=None, id="stride-3"), Expect(input=slice(3, 27, 5), output=None, id="bounded-stride"), ] _BASIC_1D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail( input=slice(None, None, -1), exception=IndexError, id="negative-step", msg="only slices with step >= 1 are supported", ), ExpectFail( input=2.3, exception=IndexError, id="float", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), # get_basic_selection and z[...] word their errors differently for a string # selection, so this case asserts only the exception type (msg=None). ExpectFail( input="foo", exception=IndexError, id="string", msg=None, ), ExpectFail( input=b"xxx", exception=IndexError, id="bytes", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ExpectFail( input=None, exception=IndexError, id="none", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ExpectFail( input=(0, 0), exception=IndexError, id="tuple-too-many", msg="too many indices for array; expected 1, got 2", ), ExpectFail( input=(slice(None), slice(None)), exception=IndexError, id="two-slices", msg="too many indices for array; expected 1, got 2", ), ] def _test_get_basic_selection( a: npt.NDArray[Any] | Array, z: Array, selection: BasicSelection ) -> None: expect = a[selection] actual = z.get_basic_selection(selection) assert_array_equal(expect, actual) actual = z[selection] assert_array_equal(expect, actual) # test out param b = default_buffer_prototype().nd_buffer.from_numpy_array( np.empty(shape=expect.shape, dtype=expect.dtype) ) z.get_basic_selection(selection, out=b) assert_array_equal(expect, b.as_numpy_array()) @pytest.mark.parametrize("case", _BASIC_1D_CASES, ids=lambda c: c.id) def test_get_basic_selection_1d(store: StorePath, case: Expect[BasicSelection, None]) -> None: """Basic getitem on a 1D array matches numpy for ints, slices, strides, and full selections.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_get_basic_selection(a, z, case.input) @pytest.mark.parametrize("case", _BASIC_1D_BAD_CASES, ids=lambda c: c.id) def test_get_basic_selection_1d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """Basic getitem on a 1D array rejects negative steps and invalid index types with IndexError.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.get_basic_selection(case.input) with case.raises(): z[case.input] _BASIC_2D_CASES: list[Expect[BasicSelection, None]] = [ Expect(input=5, output=None, id="single-row"), Expect(input=-1, output=None, id="single-row-neg"), Expect(input=(5, slice(None)), output=None, id="row-and-full-col"), Expect(input=(slice(None), 3), output=None, id="single-col"), Expect(input=(slice(None), -1), output=None, id="single-col-neg"), Expect(input=slice(None), output=None, id="full"), Expect(input=slice(2, 9), output=None, id="row-slice"), Expect(input=slice(0, 0), output=None, id="empty-row-slice"), Expect(input=(slice(2, 9), slice(1, 4)), output=None, id="2d-slice"), Expect(input=(slice(0, 12, 3), slice(0, 5, 2)), output=None, id="strided-2d-slice"), Expect(input=Ellipsis, output=None, id="ellipsis"), Expect(input=(), output=None, id="empty-tuple"), ] _BASIC_2D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail( input=2.3, exception=IndexError, id="float", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ExpectFail( input="foo", exception=IndexError, id="string", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ExpectFail( input=None, exception=IndexError, id="none", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ExpectFail( input=(2.3, slice(None)), exception=IndexError, id="float-in-tuple", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ExpectFail( input=slice(None, None, -1), exception=IndexError, id="negative-step", msg="only slices with step >= 1 are supported", ), ExpectFail( input=(slice(None), slice(None), slice(None)), exception=IndexError, id="too-many-dims", msg="too many indices for array; expected 2, got 3", ), ExpectFail( input=[0, 1], exception=IndexError, id="integer-list", msg="unsupported selection item for basic indexing; expected integer or slice, got ", escape=True, ), ] @pytest.mark.parametrize("case", _BASIC_2D_CASES, ids=lambda c: c.id) def test_get_basic_selection_2d(store: StorePath, case: Expect[BasicSelection, None]) -> None: """Basic getitem on a 2D array matches numpy for rows, cols, slices, and strides.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_get_basic_selection(a, z, case.input) @pytest.mark.parametrize("case", _BASIC_2D_BAD_CASES, ids=lambda c: c.id) def test_get_basic_selection_2d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """Basic getitem on a 2D array rejects malformed selections with IndexError.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with case.raises(): z.get_basic_selection(case.input) def test_basic_2d_fancy_fallback(store: StorePath) -> None: """Indexing a 2D array with paired integer lists falls back to fancy (vectorized) indexing.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) np.testing.assert_array_equal(z[([0, 1], [0, 1])], a[([0, 1], [0, 1])]) def test_get_basic_selection_1d_rejects_integer_list(store: StorePath) -> None: """get_basic_selection on a 1D array rejects an integer list (basic indexing is int/slice only).""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with pytest.raises(IndexError, match="unsupported selection item for basic indexing"): z.get_basic_selection([1, 0]) def test_get_basic_selection_2d_rejects_list_in_tuple(store: StorePath) -> None: """get_basic_selection on a 2D array rejects a list nested in an index tuple.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with pytest.raises(IndexError, match="unsupported selection item for basic indexing"): z.get_basic_selection((slice(None), [0, 1])) def test_fancy_indexing_fallback_on_get_setitem(store: StorePath) -> None: """Paired integer-list indexing falls back to vectorized (fancy) get and set via `__getitem__`/`__setitem__`.""" z = zarr_array_from_numpy_array(store, np.zeros((20, 20))) z[[1, 2, 3], [1, 2, 3]] = 1 np.testing.assert_array_equal( z[:4, :4], [ [0, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1], ], ) np.testing.assert_array_equal(z[[1, 2, 3], [1, 2, 3]], 1) # test broadcasting np.testing.assert_array_equal(z[1, [1, 2, 3]], [1, 0, 0]) # test 1D fancy indexing z2 = zarr_array_from_numpy_array(store, np.zeros(5)) z2[[1, 2, 3]] = 1 np.testing.assert_array_equal(z2[:], [0, 1, 1, 1, 0]) @pytest.mark.parametrize( ("index", "expected_result"), [ # Single iterable of integers ([0, 1], [[0, 1, 2], [3, 4, 5]]), # List first, then slice (([0, 1], slice(None)), [[0, 1, 2], [3, 4, 5]]), # List first, then slice (([0, 1], slice(1, None)), [[1, 2], [4, 5]]), # Slice first, then list ((slice(0, 2), [0, 2]), [[0, 2], [3, 5]]), # Slices only ((slice(0, 2), slice(0, 2)), [[0, 1], [3, 4]]), # List with repeated index (([1, 0, 1], slice(1, None)), [[4, 5], [1, 2], [4, 5]]), # 1D indexing (([1, 0, 1]), [[3, 4, 5], [0, 1, 2], [3, 4, 5]]), ], ) def test_orthogonal_indexing_fallback_on_getitem_2d( store: StorePath, index: Selection, expected_result: npt.ArrayLike ) -> None: """ Tests the orthogonal indexing fallback on __getitem__ for a 2D matrix. In addition to checking expected behavior, all indexing is also checked against numpy. """ # [0, 1, 2], # [3, 4, 5], # [6, 7, 8] a = np.arange(9).reshape(3, 3) z = zarr_array_from_numpy_array(store, a) np.testing.assert_array_equal(z[index], a[index], err_msg="Indexing disagrees with numpy") np.testing.assert_array_equal(z[index], expected_result) def test_setitem_zarr_array_as_value() -> None: """Assigning a zarr array as a value in `__setitem__` does not raise a SyncError (regression for GH3611).""" # Regression test for https://github.com/zarr-developers/zarr-python/issues/3611 # Assigning a zarr Array as the value used to raise # SyncError("Calling sync() from within a running loop") because the codec # pipeline tried to index the zarr array inside an already-running async loop. src = zarr.array(np.arange(10), chunks=(5,)) dst = zarr.zeros(10, chunks=(5,), dtype=src.dtype) # Full assignment dst[:] = src assert_array_equal(dst[:], np.arange(10)) # Slice assignment dst2 = zarr.zeros(10, chunks=(5,), dtype=src.dtype) dst2[2:7] = src[2:7] assert_array_equal(dst2[2:7], np.arange(2, 7)) @pytest.mark.skip(reason="fails on ubuntu, windows; numpy=2.2; in CI") def test_setitem_repeated_index(): """oindex assignment with repeated indices writes the last value for each duplicated index position.""" array = zarr.array(data=np.zeros((4,)), chunks=(1,)) indexer = np.array([-1, -1, 0, 0]) array.oindex[(indexer,)] = [0, 1, 2, 3] np.testing.assert_array_equal(array[:], np.array([3, 0, 0, 1])) indexer = np.array([-1, 0, 0, -1]) array.oindex[(indexer,)] = [0, 1, 2, 3] np.testing.assert_array_equal(array[:], np.array([2, 0, 0, 3])) Index = list[int] | tuple[slice | int | list[int], ...] @pytest.mark.parametrize( ("index", "expected_result"), [ # Single iterable of integers ([0, 1], [[[0, 1, 2], [3, 4, 5], [6, 7, 8]], [[9, 10, 11], [12, 13, 14], [15, 16, 17]]]), # One slice, two integers ((slice(0, 2), 1, 1), [4, 13]), # One integer, two slices ((slice(0, 2), 1, slice(0, 2)), [[3, 4], [12, 13]]), # Two slices and a list ((slice(0, 2), [1, 2], slice(0, 2)), [[[3, 4], [6, 7]], [[12, 13], [15, 16]]]), ], ) def test_orthogonal_indexing_fallback_on_getitem_3d( store: StorePath, index: Selection, expected_result: npt.ArrayLike ) -> None: """ Tests the orthogonal indexing fallback on __getitem__ for a 3D matrix. In addition to checking expected behavior, all indexing is also checked against numpy. """ # [[[ 0, 1, 2], # [ 3, 4, 5], # [ 6, 7, 8]], # [[ 9, 10, 11], # [12, 13, 14], # [15, 16, 17]], # [[18, 19, 20], # [21, 22, 23], # [24, 25, 26]]] a = np.arange(27).reshape(3, 3, 3) z = zarr_array_from_numpy_array(store, a) np.testing.assert_array_equal(z[index], a[index], err_msg="Indexing disagrees with numpy") np.testing.assert_array_equal(z[index], expected_result) @pytest.mark.parametrize( ("index", "expected_result"), [ # Single iterable of integers ([0, 1], [[1, 1, 1], [1, 1, 1], [0, 0, 0]]), # List and slice combined (([0, 1], slice(1, 3)), [[0, 1, 1], [0, 1, 1], [0, 0, 0]]), # Index repetition is ignored on setitem (([0, 1, 1, 1, 1, 1, 1], slice(1, 3)), [[0, 1, 1], [0, 1, 1], [0, 0, 0]]), # Slice with step (([0, 2], slice(None, None, 2)), [[1, 0, 1], [0, 0, 0], [1, 0, 1]]), ], ) def test_orthogonal_indexing_fallback_on_setitem_2d( store: StorePath, index: Selection, expected_result: npt.ArrayLike ) -> None: """ Tests the orthogonal indexing fallback on __setitem__ for a 3D matrix. In addition to checking expected behavior, all indexing is also checked against numpy. """ # Slice + fancy index a = np.zeros((3, 3)) z = zarr_array_from_numpy_array(store, a) z[index] = 1 a[index] = 1 np.testing.assert_array_equal(z[:], expected_result) np.testing.assert_array_equal(z[:], a, err_msg="Indexing disagrees with numpy") def test_fancy_indexing_doesnt_mix_with_implicit_slicing(store: StorePath) -> None: """Fancy indexing that would require implicit slicing over an unspecified axis raises IndexError on a 3D array.""" z2 = zarr_array_from_numpy_array(store, np.zeros((5, 5, 5))) with pytest.raises(IndexError): z2[[1, 2, 3], [1, 2, 3]] = 2 with pytest.raises(IndexError): np.testing.assert_array_equal(z2[[1, 2, 3], [1, 2, 3]], 0) with pytest.raises(IndexError): z2[..., [1, 2, 3]] = 2 # type: ignore[index] with pytest.raises(IndexError): np.testing.assert_array_equal(z2[..., [1, 2, 3]], 0) # type: ignore[index] @pytest.mark.parametrize( ("value", "dtype"), [ (42, "uint8"), pytest.param( (b"aaa", 1, 4.2), [("foo", "S3"), ("bar", "i4"), ("baz", "f8")], marks=pytest.mark.filterwarnings("ignore::zarr.errors.UnstableSpecificationWarning"), ), ], ) def test_set_basic_selection_0d( store: StorePath, value: Any, dtype: str | list[tuple[str, str]] ) -> None: """set_basic_selection and `__setitem__` write scalar values correctly to a 0-dimensional array.""" arr_np = np.array(value, dtype=dtype) arr_np_zeros = np.zeros_like(arr_np, dtype=dtype) arr_z = zarr_array_from_numpy_array(store, arr_np_zeros) assert_array_equal(arr_np_zeros, arr_z) arr_z.set_basic_selection(Ellipsis, value) assert_array_equal(arr_np, arr_z) arr_z[...] = arr_np_zeros[()] assert_array_equal(arr_np_zeros, arr_z) arr_z[...] = value assert_array_equal(arr_np, arr_z) # todo: uncomment the structured array tests when we can make them pass, # or delete them if we formally decide not to support structured dtypes. # arr_z.set_basic_selection(Ellipsis, v["foo"], fields="foo") # assert v["foo"] == arr_z["foo"] # assert arr_np_zeros["bar"] == arr_z["bar"] # assert arr_np_zeros["baz"] == arr_z["baz"] # arr_z["bar"] = v["bar"] # assert v["foo"] == arr_z["foo"] # assert v["bar"] == arr_z["bar"] # assert arr_np_zeros["baz"] == arr_z["baz"] # # multiple field assignment not supported # with pytest.raises(IndexError): # arr_z.set_basic_selection(Ellipsis, v[["foo", "bar"]], fields=["foo", "bar"]) # with pytest.raises(IndexError): # arr_z[..., "foo", "bar"] = v[["foo", "bar"]] def _test_get_orthogonal_selection( a: npt.NDArray[Any], z: Array, selection: OrthogonalSelection ) -> None: expect = oindex(a, selection) actual = z.get_orthogonal_selection(selection) assert_array_equal(expect, actual) actual = z.oindex[selection] assert_array_equal(expect, actual) _ORTHO_1D_BOOL_CASES: list[Expect[OrthogonalSelection, None]] = [ Expect(input=np.zeros(30, dtype=bool), output=None, id="empty-mask"), Expect(input=np.ones(30, dtype=bool), output=None, id="full-mask"), Expect(input=np.arange(30) % 2 == 0, output=None, id="alternating-mask"), Expect(input=np.arange(30) == 7, output=None, id="single-true"), Expect( input=np.isin(np.arange(30), [0, 1, 8, 15, 29]), output=None, id="sparse-cross-chunk", ), ] _ORTHO_1D_BOOL_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail( input=np.zeros(5, dtype=bool), exception=IndexError, id="mask-too-short", msg="wrong length for dimension; expected 30, got 5", ), ExpectFail( input=np.zeros(50, dtype=bool), exception=IndexError, id="mask-too-long", msg="wrong length for dimension; expected 30, got 50", ), ExpectFail( input=[[True, False], [False, True]], exception=IndexError, id="mask-too-many-dims", msg="must be 1-dimensional only", ), ] @pytest.mark.parametrize("case", _ORTHO_1D_BOOL_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_1d_bool( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """oindex with a 1D boolean mask matches numpy across chunk boundaries.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_get_orthogonal_selection(a, z, case.input) @pytest.mark.parametrize("case", _ORTHO_1D_BOOL_BAD_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_1d_bool_raises(store: StorePath, case: ExpectFail[Any]) -> None: """oindex rejects masks of the wrong length or dimensionality with IndexError.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.oindex[case.input] _ORTHO_1D_INT_CASES: list[Expect[OrthogonalSelection, None]] = [ Expect(input=[0, 8, 15, 29], output=None, id="sorted"), Expect(input=[3, 29, 1, 16], output=None, id="unsorted"), Expect(input=[2, 2, 8, 8], output=None, id="duplicates"), Expect(input=[0, 3, 10, -23, -12, -1], output=None, id="wraparound"), Expect(input=[15], output=None, id="single"), ] _ORTHO_1D_INT_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail( input=[31], exception=IndexError, id="out-of-bounds-high", msg="index out of bounds for dimension with length 30", ), ExpectFail( input=[-31], exception=IndexError, id="out-of-bounds-low", msg="index out of bounds for dimension with length 30", ), ExpectFail( input=[[2, 4], [6, 8]], exception=IndexError, id="too-many-dims", msg="integer arrays in an orthogonal selection must be 1-dimensional only", ), ] @pytest.mark.parametrize("case", _ORTHO_1D_INT_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_1d_int( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """oindex with a 1D integer array matches numpy, including wraparound and duplicates.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_get_orthogonal_selection(a, z, case.input) @pytest.mark.parametrize("case", _ORTHO_1D_INT_BAD_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_1d_int_raises(store: StorePath, case: ExpectFail[Any]) -> None: """oindex rejects out-of-bounds or multi-dimensional integer selections with IndexError.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.get_orthogonal_selection(case.input) with case.raises(): z.oindex[case.input] _ORTHO_2D_IX0_BOOL = np.isin(np.arange(12), [0, 5, 11]) # rows 0, 5, 11 _ORTHO_2D_IX1_BOOL = np.array([True, False, True, False, True]) # cols 0, 2, 4 _ORTHO_2D_IX0_INT = np.array([0, 5, 11]) _ORTHO_2D_IX1_INT = np.array([0, 2, 4]) _ORTHO_2D_CASES: list[Expect[OrthogonalSelection, None]] = [ Expect(input=(_ORTHO_2D_IX0_BOOL, _ORTHO_2D_IX1_BOOL), output=None, id="both-bool"), Expect(input=(_ORTHO_2D_IX0_BOOL, slice(1, 4)), output=None, id="bool-slice"), Expect(input=(_ORTHO_2D_IX0_BOOL, slice(0, 5, 2)), output=None, id="bool-strided-slice"), Expect(input=(slice(2, 9), _ORTHO_2D_IX1_BOOL), output=None, id="slice-bool"), Expect(input=(slice(0, 12, 4), _ORTHO_2D_IX1_BOOL), output=None, id="strided-slice-bool"), Expect(input=(_ORTHO_2D_IX0_BOOL, 3), output=None, id="bool-int"), Expect(input=(7, _ORTHO_2D_IX1_BOOL), output=None, id="int-bool"), Expect(input=(_ORTHO_2D_IX0_INT, _ORTHO_2D_IX1_INT), output=None, id="both-int"), Expect(input=(_ORTHO_2D_IX0_INT, _ORTHO_2D_IX1_BOOL), output=None, id="int-array-bool-array"), Expect(input=(_ORTHO_2D_IX0_BOOL, _ORTHO_2D_IX1_INT), output=None, id="bool-array-int-array"), Expect(input=7, output=None, id="single-row"), Expect(input=(slice(None), 3), output=None, id="single-col"), Expect(input=(slice(None), slice(None)), output=None, id="full"), Expect(input=slice(2, 9), output=None, id="row-slice"), ] _ORTHO_2D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail( input=2.3, exception=IndexError, id="float-index", msg="unsupported selection item for orthogonal indexing", ), # get_orthogonal_selection and oindex raise different messages for a string # selection, so assert only the exception type. ExpectFail( input="foo", exception=IndexError, id="string-index", msg=None, ), ExpectFail( input=None, exception=IndexError, id="none-index", msg="unsupported selection item for orthogonal indexing", ), ExpectFail( input=slice(None, None, -1), exception=IndexError, id="negative-step", msg="only slices with step >= 1 are supported", ), ExpectFail( input=(0, 0, 0), exception=IndexError, id="too-many-dims", msg="too many indices for array", ), ] @pytest.mark.parametrize("case", _ORTHO_2D_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_2d( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """oindex on a 2D array matches numpy for array/slice/int combinations per axis.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_get_orthogonal_selection(a, z, case.input) @pytest.mark.parametrize("case", _ORTHO_2D_BAD_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_2d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """oindex on a 2D array rejects malformed selections with IndexError.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with case.raises(): z.get_orthogonal_selection(case.input) with case.raises(): z.oindex[case.input] _ORTHO_3D_IX0_BOOL = np.isin(np.arange(7), [0, 3, 6]) # axis 0 _ORTHO_3D_IX1_BOOL = np.isin(np.arange(6), [0, 2, 5]) # axis 1 _ORTHO_3D_IX2_BOOL = np.isin(np.arange(10), [0, 4, 9]) # axis 2 _ORTHO_3D_IX0_INT = np.array([0, 3, 6]) _ORTHO_3D_IX1_INT = np.array([0, 2, 5]) _ORTHO_3D_IX2_INT = np.array([0, 4, 9]) _ORTHO_3D_CASES: list[Expect[OrthogonalSelection, None]] = [ # single value Expect(input=(5, 3, 8), output=None, id="single-value"), Expect(input=(-1, -1, -1), output=None, id="all-negative"), # index all axes with arrays Expect( input=(_ORTHO_3D_IX0_BOOL, _ORTHO_3D_IX1_BOOL, _ORTHO_3D_IX2_BOOL), output=None, id="three-bool-arrays", ), Expect( input=(_ORTHO_3D_IX0_INT, _ORTHO_3D_IX1_INT, _ORTHO_3D_IX2_INT), output=None, id="three-int-arrays", ), # mixed indexing with single array / slices Expect( input=(_ORTHO_3D_IX0_BOOL, slice(1, 5), slice(2, 9)), output=None, id="array-slice-slice" ), Expect( input=(slice(1, 6), _ORTHO_3D_IX1_BOOL, slice(2, 9)), output=None, id="slice-array-slice" ), Expect( input=(slice(1, 6), slice(1, 5), _ORTHO_3D_IX2_BOOL), output=None, id="slice-slice-array" ), Expect( input=(_ORTHO_3D_IX0_BOOL, slice(0, 6, 2), slice(0, 10, 3)), output=None, id="array-strided-strided", ), Expect( input=(slice(0, 7, 2), _ORTHO_3D_IX1_BOOL, slice(0, 10, 3)), output=None, id="strided-array-strided", ), Expect( input=(slice(0, 7, 2), slice(0, 6, 2), _ORTHO_3D_IX2_BOOL), output=None, id="strided-strided-array", ), # mixed indexing with single array / ints Expect(input=(_ORTHO_3D_IX0_BOOL, 3, 8), output=None, id="array-int-int"), Expect(input=(5, _ORTHO_3D_IX1_BOOL, 8), output=None, id="int-array-int"), Expect(input=(5, 3, _ORTHO_3D_IX2_BOOL), output=None, id="int-int-array"), # mixed indexing with single array / slice / int Expect(input=(_ORTHO_3D_IX0_BOOL, slice(1, 5), 8), output=None, id="array-slice-int"), Expect(input=(5, _ORTHO_3D_IX1_BOOL, slice(2, 9)), output=None, id="int-array-slice"), Expect(input=(slice(1, 6), 3, _ORTHO_3D_IX2_BOOL), output=None, id="slice-int-array"), # mixed indexing with two arrays / slice Expect( input=(_ORTHO_3D_IX0_BOOL, _ORTHO_3D_IX1_BOOL, slice(2, 9)), output=None, id="two-arrays-slice", ), Expect( input=(slice(1, 6), _ORTHO_3D_IX1_BOOL, _ORTHO_3D_IX2_BOOL), output=None, id="slice-two-arrays", ), Expect( input=(_ORTHO_3D_IX0_BOOL, slice(1, 5), _ORTHO_3D_IX2_BOOL), output=None, id="array-slice-array", ), # mixed indexing with two arrays / integer Expect(input=(_ORTHO_3D_IX0_BOOL, _ORTHO_3D_IX1_BOOL, 8), output=None, id="two-arrays-int"), Expect(input=(5, _ORTHO_3D_IX1_BOOL, _ORTHO_3D_IX2_BOOL), output=None, id="int-two-arrays"), Expect(input=(_ORTHO_3D_IX0_BOOL, 3, _ORTHO_3D_IX2_BOOL), output=None, id="array-int-array"), ] @pytest.mark.parametrize("case", _ORTHO_3D_CASES, ids=lambda c: c.id) def test_get_orthogonal_selection_3d( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """oindex on a 3D array matches numpy for array/slice/int combinations per axis.""" a = np.arange(420, dtype=int).reshape(7, 6, 10) z = zarr_array_from_numpy_array(store, a, chunk_shape=(3, 2, 4)) _test_get_orthogonal_selection(a, z, case.input) def test_orthogonal_indexing_edge_cases(store: StorePath) -> None: """oindex on a shape-(1, 2, 3) array correctly handles mixing integer, slice, int-list, and bool-list indexers per axis.""" a = np.arange(6).reshape(1, 2, 3) z = zarr_array_from_numpy_array(store, a, chunk_shape=(1, 2, 3)) expect = oindex(a, (0, slice(None), [0, 1, 2])) actual = z.oindex[0, :, [0, 1, 2]] assert_array_equal(expect, actual) expect = oindex(a, (0, slice(None), [True, True, True])) actual = z.oindex[0, :, [True, True, True]] assert_array_equal(expect, actual) def _test_set_orthogonal_selection( v: npt.NDArray[np.int_], a: npt.NDArray[Any], z: Array, selection: OrthogonalSelection ) -> None: for value in 42, oindex(v, selection), oindex(v, selection).tolist(): if isinstance(value, list) and value == []: # skip these cases as cannot preserve all dimensions continue # setup expectation a[:] = 0 oindex_set(a, selection, value) # long-form API z[:] = 0 z.set_orthogonal_selection(selection, value) assert_array_equal(a, z[:]) # short-form API z[:] = 0 z.oindex[selection] = value assert_array_equal(a, z[:]) @pytest.mark.parametrize("case", _ORTHO_1D_BOOL_CASES + _ORTHO_1D_INT_CASES, ids=lambda c: c.id) def test_set_orthogonal_selection_1d( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """set_orthogonal_selection on a 1D array round-trips through numpy for masks and int arrays.""" v = np.arange(30, dtype=int) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_set_orthogonal_selection(v, a, z, case.input) def test_set_item_1d_last_two_chunks(store: StorePath): """Regression for GH2849: `__setitem__` correctly writes to the last two chunks of a 1D array and to 0-dimensional scalar arrays.""" # regression test for GH2849 g = zarr.open_group(store=store, zarr_format=3, mode="w") a = g.create_array("bar", shape=(10,), chunks=(3,), dtype=int) data = np.array([7, 8, 9]) a[slice(7, 10)] = data np.testing.assert_array_equal(a[slice(7, 10)], data) z = zarr.open_group(store=store, mode="w") z.create_array("zoo", dtype=float, shape=()) z["zoo"][...] = np.array(1) # why doesn't [:] work? np.testing.assert_equal(z["zoo"][()], np.array(1)) z = zarr.open_group(store=store, mode="w") z.create_array("zoo", dtype=float, shape=()) z["zoo"][...] = 1 # why doesn't [:] work? np.testing.assert_equal(z["zoo"][()], np.array(1)) @pytest.mark.parametrize("case", _ORTHO_2D_CASES, ids=lambda c: c.id) def test_set_orthogonal_selection_2d( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """set_orthogonal_selection on a 2D array round-trips through numpy.""" v = np.arange(60, dtype=int).reshape(12, 5) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_set_orthogonal_selection(v, a, z, case.input) @pytest.mark.parametrize("case", _ORTHO_3D_CASES, ids=lambda c: c.id) def test_set_orthogonal_selection_3d( store: StorePath, case: Expect[OrthogonalSelection, None] ) -> None: """set_orthogonal_selection on a 3D array round-trips through numpy.""" v = np.arange(420, dtype=int).reshape(7, 6, 10) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(3, 2, 4)) _test_set_orthogonal_selection(v, a, z, case.input) def test_orthogonal_indexing_fallback_on_get_setitem(store: StorePath) -> None: """Paired integer-list indexing on a 2D array falls back to orthogonal get and set via `__getitem__`/`__setitem__`.""" z = zarr_array_from_numpy_array(store, np.zeros((20, 20))) z[[1, 2, 3], [1, 2, 3]] = 1 np.testing.assert_array_equal( z[:4, :4], [ [0, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1], ], ) np.testing.assert_array_equal(z[[1, 2, 3], [1, 2, 3]], 1) # test broadcasting np.testing.assert_array_equal(z[1, [1, 2, 3]], [1, 0, 0]) # test 1D fancy indexing z2 = zarr_array_from_numpy_array(store, np.zeros(5)) z2[[1, 2, 3]] = 1 np.testing.assert_array_equal(z2[:], [0, 1, 1, 1, 0]) def _test_get_coordinate_selection( a: npt.NDArray, z: Array, selection: CoordinateSelection ) -> None: expect = a[selection] actual = z.get_coordinate_selection(selection) assert_array_equal(expect, actual) actual = z.vindex[selection] assert_array_equal(expect, actual) _COORD_1D_CASES: list[Expect[CoordinateSelection, None]] = [ Expect(input=5, output=None, id="single"), Expect(input=-1, output=None, id="single-negative"), Expect(input=[0, 3, 10, -23, -12, -1], output=None, id="wraparound"), Expect(input=[3, 25, 8, 17], output=None, id="out-of-order"), Expect(input=[1, 8, 15, 29], output=None, id="sorted"), Expect(input=[29, 15, 8, 1], output=None, id="reversed"), Expect(input=np.array([29, 15, 8, 1], dtype=np.uint32), output=None, id="reversed-uint"), Expect(input=[2, 2, 8, 8], output=None, id="duplicates"), Expect(input=np.array([[2, 4], [6, 8]]), output=None, id="multi-dim"), # sorted-1D fast path (chunk_shape=(7,)): boundaries, contiguous runs, single chunk, full Expect(input=[0, 6, 7, 13, 14, 28, 29], output=None, id="sorted-chunk-boundaries"), Expect(input=[0, 1, 2, 8, 9, 10, 21, 22, 23], output=None, id="sorted-contiguous-runs"), Expect(input=[1, 2, 3, 4, 5, 6], output=None, id="sorted-single-chunk"), Expect(input=list(range(30)), output=None, id="sorted-full"), Expect(input=[0, 0, 7, 7, 7, 29], output=None, id="sorted-duplicates-boundaries"), ] # get_coordinate_selection and vindex word their errors differently for these # invalid-type inputs, so these cases assert only the exception type (msg=None). _COORD_1D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail(input=slice(5, 15), exception=IndexError, id="slice", msg=None), ExpectFail(input=slice(None), exception=IndexError, id="full-slice", msg=None), ExpectFail(input=Ellipsis, exception=IndexError, id="ellipsis", msg=None), ExpectFail(input=2.3, exception=IndexError, id="float", msg=None), ExpectFail(input="foo", exception=IndexError, id="string", msg=None), ExpectFail(input=b"xxx", exception=IndexError, id="bytes", msg=None), ExpectFail(input=None, exception=IndexError, id="none", msg=None), ExpectFail(input=(0, 0), exception=IndexError, id="tuple-pair", msg=None), ExpectFail(input=(slice(None), slice(None)), exception=IndexError, id="two-slices", msg=None), ExpectFail( input=[31], exception=IndexError, id="out-of-bounds-high", msg="index out of bounds for dimension with length 30", ), ExpectFail( input=[-31], exception=IndexError, id="out-of-bounds-low", msg="index out of bounds for dimension with length 30", ), ] _COORD_2D_IX0 = np.array([0, 5, 11, 2, 8]) _COORD_2D_IX1 = np.array([1, 3, 4, 0, 2]) _COORD_2D_CASES: list[Expect[CoordinateSelection, None]] = [ Expect(input=(5, 4), output=None, id="single"), Expect(input=(-1, -1), output=None, id="single-negative"), Expect(input=(_COORD_2D_IX0, _COORD_2D_IX1), output=None, id="both-arrays"), # scalar broadcasts in coordinate indexing (numpy and zarr agree) Expect(input=(np.array([0, 5, 11]), 4), output=None, id="array-int"), Expect(input=(7, np.array([0, 2, 4])), output=None, id="int-array"), Expect(input=([3, 3, 4, 2, 5], [1, 3, 4, 0, 2]), output=None, id="not-monotonic-first"), Expect(input=([1, 1, 2, 2, 5], [1, 3, 2, 1, 0]), output=None, id="not-monotonic-second"), Expect( input=(np.array([[1, 1, 2], [2, 2, 5]]), np.array([[1, 3, 2], [1, 0, 0]])), output=None, id="multi-dim", ), ] _COORD_2D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail( input=(slice(5, 15), [1, 2, 3]), exception=IndexError, id="slice-with-array", msg=None, ), ExpectFail( input=([1, 2, 3], slice(5, 15)), exception=IndexError, id="array-with-slice", msg=None, ), ExpectFail( input=(Ellipsis, [1, 2, 3]), exception=IndexError, id="ellipsis-with-array", msg=None, ), ExpectFail(input=Ellipsis, exception=IndexError, id="ellipsis", msg=None), ExpectFail( input=(np.array([12]), np.array([0])), exception=IndexError, id="out-of-bounds-axis0", msg="index out of bounds for dimension with length 12", ), ExpectFail( input=(np.array([0]), np.array([5])), exception=IndexError, id="out-of-bounds-axis1", msg="index out of bounds for dimension with length 5", ), ] @pytest.mark.parametrize("case", _COORD_1D_CASES, ids=lambda c: c.id) def test_get_coordinate_selection_1d( store: StorePath, case: Expect[CoordinateSelection, None] ) -> None: """vindex and get_coordinate_selection on a 1D array match numpy for int, list, and multi-dim selections.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_get_coordinate_selection(a, z, case.input) @pytest.mark.parametrize( ("chunks", "shards"), [((7,), None), ((7,), (21,))], ids=["chunked", "sharded"], ) def test_get_coordinate_selection_1d_fast_path( store: StorePath, chunks: tuple[int, ...], shards: tuple[int, ...] | None ) -> None: """The sorted-1D-runs fast path in CoordinateIndexer matches numpy on chunked and sharded arrays. Exercises the boundary/run/single-chunk/full-array cases that the fast path optimizes, plus the sharded case where the top-level (shard) grid drives chunk assignment. """ a = np.arange(210, dtype=int) z = zarr.create_array( store=store / str(uuid4()), shape=a.shape, dtype=a.dtype, chunks=chunks, shards=shards, ) z[:] = a rng = np.random.default_rng(0) selections = [ np.sort(rng.choice(210, 60, replace=False)), # scattered sorted np.array([0, 6, 7, 20, 21, 209]), # chunk/shard boundaries np.concatenate([np.arange(s, s + 5) for s in (0, 33, 100, 180)]), # contiguous runs np.array([0, 0, 7, 7, 209]), # sorted with duplicates np.arange(210), # whole array np.array([5]), # single element ] for sel in selections: assert_array_equal(a[sel], z.get_coordinate_selection(sel)) assert_array_equal(a[sel], z.vindex[sel]) def test_coordinate_indexer_1d_last_chunk_boundary_does_not_overflow() -> None: max_intp = np.iinfo(np.intp).max chunk_size = max_intp // 2 + 1 coords = np.arange(max_intp - 4, max_intp, dtype=np.intp) chunk_grid = ChunkGrid.from_sizes((max_intp,), (chunk_size,)) (projection,) = tuple(CoordinateIndexer((coords,), (max_intp,), chunk_grid)) assert projection.chunk_coords == (1,) assert_array_equal(projection.chunk_selection[0], coords - chunk_size) assert projection.out_selection == slice(0, 4) @pytest.mark.parametrize("coord_dtype", [np.int8, np.uint8, np.uint32]) def test_coordinate_selection_1d_narrow_dtype_large_chunk( store: StorePath, coord_dtype: type[np.integer[Any]] ) -> None: source = np.arange(1_000) coords = np.arange(10, dtype=coord_dtype) z = zarr_array_from_numpy_array(store, source, chunk_shape=(1_000,)) assert_array_equal(z.get_coordinate_selection(coords), source[coords]) assert_array_equal(z.vindex[coords], source[coords]) assert_array_equal(z[coords], source[coords]) expected = source.copy() expected[coords] = -1 z.set_coordinate_selection(coords, -1) assert_array_equal(z[:], expected) z[:] = source z.vindex[coords] = -1 assert_array_equal(z[:], expected) def test_coordinate_indexer_1d_sparse_selection_uses_general_path( monkeypatch: pytest.MonkeyPatch, ) -> None: coords = np.array([0, 99]) chunk_grid = ChunkGrid.from_sizes((100,), (1,)) def unexpected_searchsorted(*args: Any, **kwargs: Any) -> None: pytest.fail("sparse coordinate selection should not call searchsorted") monkeypatch.setattr(np, "searchsorted", unexpected_searchsorted) projections = tuple(CoordinateIndexer((coords,), (100,), chunk_grid)) assert tuple(projection.chunk_coords for projection in projections) == ((0,), (99,)) def test_get_coordinate_selection_1d_irregular_grid(store: StorePath) -> None: """Coordinate selections on an irregular (rectilinear) chunk grid bypass the sorted-1D fast path (which requires a regular grid) and still match numpy via the general path.""" a = np.arange(30, dtype=int) with zarr.config.set({"array.rectilinear_chunks": True}): z = zarr.create_array( store=store / str(uuid4()), shape=a.shape, dtype=a.dtype, chunks=((3, 3, 4, 5, 5, 5, 5),), ) z[:] = a for sel in (np.array([1, 8, 15, 29]), np.array([0, 3, 3, 29]), np.arange(30)): assert_array_equal(a[sel], z.get_coordinate_selection(sel)) @pytest.mark.parametrize("case", _COORD_1D_BAD_CASES, ids=lambda c: c.id) def test_get_coordinate_selection_1d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """get_coordinate_selection and vindex both raise IndexError for invalid 1D selections.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.get_coordinate_selection(case.input) # type: ignore[arg-type] with case.raises(): z.vindex[case.input] # type: ignore[index] @pytest.mark.parametrize("case", _COORD_2D_CASES, ids=lambda c: c.id) def test_get_coordinate_selection_2d( store: StorePath, case: Expect[CoordinateSelection, None] ) -> None: """vindex and get_coordinate_selection on a 2D array match numpy for coordinate selections.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_get_coordinate_selection(a, z, case.input) @pytest.mark.parametrize("case", _COORD_2D_BAD_CASES, ids=lambda c: c.id) def test_get_coordinate_selection_2d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """get_coordinate_selection raises IndexError when slices or Ellipsis appear in a 2D coordinate selection.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with case.raises(): z.get_coordinate_selection(case.input) # type: ignore[arg-type] def _test_set_coordinate_selection( v: npt.NDArray, a: npt.NDArray, z: Array, selection: CoordinateSelection ) -> None: for value in 42, v[selection], v[selection].tolist(): # setup expectation a[:] = 0 a[selection] = value # test long-form API z[:] = 0 z.set_coordinate_selection(selection, value) assert_array_equal(a, z[:]) # test short-form API z[:] = 0 z.vindex[selection] = value assert_array_equal(a, z[:]) @pytest.mark.parametrize("case", _COORD_1D_CASES, ids=lambda c: c.id) def test_set_coordinate_selection_1d( store: StorePath, case: Expect[CoordinateSelection, None] ) -> None: """set_coordinate_selection and vindex assignment on a 1D array round-trip through numpy.""" v = np.arange(30, dtype=int) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_set_coordinate_selection(v, a, z, case.input) @pytest.mark.parametrize("case", _COORD_2D_CASES, ids=lambda c: c.id) def test_set_coordinate_selection_2d( store: StorePath, case: Expect[CoordinateSelection, None] ) -> None: """set_coordinate_selection and vindex assignment on a 2D array round-trip through numpy.""" v = np.arange(60, dtype=int).reshape(12, 5) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_set_coordinate_selection(v, a, z, case.input) def _test_get_block_selection( a: npt.NDArray[Any], z: Array, selection: BasicSelection, expected_idx: slice | tuple[slice, ...], ) -> None: expect = a[expected_idx] actual = z.get_block_selection(selection) assert_array_equal(expect, actual) actual = z.blocks[selection] assert_array_equal(expect, actual) _BLOCK_1D_CASES: list[Expect[BasicSelection, slice]] = [ Expect(input=0, output=slice(0, 7), id="block-0"), Expect(input=2, output=slice(14, 21), id="block-mid"), Expect(input=4, output=slice(28, 30), id="block-last"), Expect(input=-1, output=slice(28, 30), id="block-neg-1"), Expect(input=-2, output=slice(21, 28), id="block-neg-2"), Expect(input=slice(3), output=slice(0, 21), id="slice-to-3"), Expect(input=slice(None, 2), output=slice(0, 14), id="slice-none-2"), Expect(input=slice(1, 2), output=slice(7, 14), id="slice-1-2"), Expect(input=slice(-2, -1), output=slice(21, 28), id="slice-neg"), Expect(input=slice(None), output=slice(0, 30), id="full"), ] _BLOCK_1D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail(input=slice(3, 8, 2), exception=IndexError, id="strided-slice"), ExpectFail(input=2.3, exception=IndexError, id="float"), ExpectFail(input=b"xxx", exception=IndexError, id="bytes"), ExpectFail(input=None, exception=IndexError, id="none"), ExpectFail(input=(0, 0), exception=IndexError, id="tuple-pair"), ExpectFail(input=(slice(None), slice(None)), exception=IndexError, id="two-slices"), ExpectFail(input=[0, 5, 3], exception=IndexError, id="int-list"), ExpectFail(input=5, exception=IndexError, id="out-of-bounds-high"), ExpectFail(input=-6, exception=IndexError, id="out-of-bounds-low"), ] _BLOCK_2D_CASES: list[Expect[BasicSelection, tuple[slice, slice]]] = [ Expect(input=(0, 0), output=(slice(0, 5), slice(0, 2)), id="single-00"), Expect(input=(1, 1), output=(slice(5, 10), slice(2, 4)), id="single-mid"), Expect(input=(-1, -1), output=(slice(10, 12), slice(4, 5)), id="neg"), Expect(input=(slice(0, 2), 0), output=(slice(0, 10), slice(0, 2)), id="slice-rows"), Expect(input=(2, slice(1, 3)), output=(slice(10, 12), slice(2, 5)), id="slice-cols"), Expect(input=(slice(0, 2), slice(0, 2)), output=(slice(0, 10), slice(0, 4)), id="both-slices"), Expect(input=(slice(None), slice(None)), output=(slice(0, 12), slice(0, 5)), id="full"), ] _BLOCK_2D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail(input=(slice(5, 15), [1, 2, 3]), exception=IndexError, id="slice-with-array"), ExpectFail(input=(Ellipsis, [1, 2, 3]), exception=IndexError, id="ellipsis-with-array"), ExpectFail(input=(slice(15, 20), slice(None)), exception=IndexError, id="out-of-bounds"), ] @pytest.mark.parametrize("case", _BLOCK_1D_CASES, ids=lambda c: c.id) def test_get_block_selection_1d(store: StorePath, case: Expect[BasicSelection, slice]) -> None: """get_block_selection / .blocks on a 1D array selects whole chunks matching the array slice.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_get_block_selection(a, z, case.input, case.output) @pytest.mark.parametrize("case", _BLOCK_1D_BAD_CASES, ids=lambda c: c.id) def test_get_block_selection_1d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """get_block_selection / .blocks on a 1D array rejects invalid block selections with IndexError.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.get_block_selection(case.input) with case.raises(): z.blocks[case.input] @pytest.mark.parametrize("case", _BLOCK_2D_CASES, ids=lambda c: c.id) def test_get_block_selection_2d( store: StorePath, case: Expect[BasicSelection, tuple[slice, slice]] ) -> None: """get_block_selection / .blocks on a 2D array selects whole chunk regions matching the array slices.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_get_block_selection(a, z, case.input, case.output) @pytest.mark.parametrize("case", _BLOCK_2D_BAD_CASES, ids=lambda c: c.id) def test_get_block_selection_2d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """get_block_selection on a 2D array rejects invalid or out-of-bounds block selections with IndexError.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with case.raises(): z.get_block_selection(case.input) def _test_set_block_selection( v: npt.NDArray[Any], a: npt.NDArray[Any], z: zarr.Array, selection: BasicSelection, expected_idx: slice | tuple[slice, ...], ) -> None: for value in 42, v[expected_idx], v[expected_idx].tolist(): # setup expectation a[:] = 0 a[expected_idx] = value # test long-form API z[:] = 0 z.set_block_selection(selection, value) assert_array_equal(a, z[:]) # test short-form API z[:] = 0 z.blocks[selection] = value assert_array_equal(a, z[:]) @pytest.mark.parametrize("case", _BLOCK_1D_CASES, ids=lambda c: c.id) def test_set_block_selection_1d(store: StorePath, case: Expect[BasicSelection, slice]) -> None: """set_block_selection / .blocks assignment on a 1D array round-trips through numpy for each block selection.""" v = np.arange(30, dtype=int) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_set_block_selection(v, a, z, case.input, case.output) @pytest.mark.parametrize("case", _BLOCK_1D_BAD_CASES, ids=lambda c: c.id) def test_set_block_selection_1d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """set_block_selection / .blocks assignment on a 1D array rejects invalid block selections with IndexError.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.set_block_selection(case.input, 42) with case.raises(): z.blocks[case.input] = 42 @pytest.mark.parametrize("case", _BLOCK_2D_CASES, ids=lambda c: c.id) def test_set_block_selection_2d( store: StorePath, case: Expect[BasicSelection, tuple[slice, slice]] ) -> None: """set_block_selection / .blocks assignment on a 2D array round-trips through numpy for each block selection.""" v = np.arange(60, dtype=int).reshape(12, 5) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_set_block_selection(v, a, z, case.input, case.output) @pytest.mark.parametrize("case", _BLOCK_2D_BAD_CASES, ids=lambda c: c.id) def test_set_block_selection_2d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """set_block_selection on a 2D array rejects invalid or out-of-bounds block selections with IndexError.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with case.raises(): z.set_block_selection(case.input, 42) def _test_get_mask_selection(a: npt.NDArray[Any], z: Array, selection: npt.NDArray) -> None: expect = a[selection] actual = z.get_mask_selection(selection) assert_array_equal(expect, actual) actual = z.vindex[selection] assert_array_equal(expect, actual) actual = z[selection] assert_array_equal(expect, actual) _MASK_1D_CASES: list[Expect[Any, None]] = [ Expect(input=np.zeros(30, dtype=bool), output=None, id="all-false"), Expect(input=np.ones(30, dtype=bool), output=None, id="all-true"), Expect(input=np.arange(30) % 2 == 0, output=None, id="alternating"), Expect( input=np.isin(np.arange(30), [0, 7, 14, 29]), output=None, id="sparse-cross-chunk", ), ] # msg=None for all 1d bad cases: get_mask_selection and vindex raise different # messages for the same input, so no single substring satisfies both assertions. _MASK_1D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail(input=slice(5, 15), exception=IndexError, id="slice"), ExpectFail(input=slice(None), exception=IndexError, id="full-slice"), ExpectFail(input=Ellipsis, exception=IndexError, id="ellipsis"), ExpectFail(input=2.3, exception=IndexError, id="float"), ExpectFail(input="foo", exception=IndexError, id="string"), ExpectFail(input=b"xxx", exception=IndexError, id="bytes"), ExpectFail(input=None, exception=IndexError, id="none"), ExpectFail(input=(0, 0), exception=IndexError, id="tuple-pair"), ExpectFail(input=(slice(None), slice(None)), exception=IndexError, id="two-slices"), ExpectFail(input=np.zeros(5, dtype=bool), exception=IndexError, id="mask-too-short"), ExpectFail(input=np.zeros(50, dtype=bool), exception=IndexError, id="mask-too-long"), ExpectFail(input=[[True, False], [False, True]], exception=IndexError, id="too-many-dims"), ] def _make_sparse_2d_mask() -> npt.NDArray[np.bool_]: """Build a deterministic sparse (12, 5) boolean mask with Trues at (0,0), (5,2), (11,4), (2,3).""" mask = np.zeros((12, 5), dtype=bool) for r, c in [(0, 0), (5, 2), (11, 4), (2, 3)]: mask[r, c] = True return mask _MASK_2D_CASES: list[Expect[Any, None]] = [ Expect(input=np.zeros((12, 5), dtype=bool), output=None, id="all-false"), Expect(input=np.ones((12, 5), dtype=bool), output=None, id="all-true"), Expect( input=(np.add.outer(np.arange(12), np.arange(5)) % 2).astype(bool), output=None, id="checkerboard", ), Expect( input=_make_sparse_2d_mask(), output=None, id="sparse", ), ] _MASK_2D_BAD_CASES: list[ExpectFail[Any]] = [ ExpectFail(input=np.zeros((12, 3), dtype=bool), exception=IndexError, id="too-few-cols"), ExpectFail(input=np.zeros((20, 5), dtype=bool), exception=IndexError, id="too-many-rows"), ExpectFail(input=[True, False], exception=IndexError, id="wrong-ndim"), ] @pytest.mark.parametrize("case", _MASK_1D_CASES, ids=lambda c: c.id) def test_get_mask_selection_1d(store: StorePath, case: Expect[Any, None]) -> None: """get_mask_selection / vindex / getitem on a 1D array match numpy for boolean masks.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_get_mask_selection(a, z, case.input) @pytest.mark.parametrize("case", _MASK_1D_BAD_CASES, ids=lambda c: c.id) def test_get_mask_selection_1d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """get_mask_selection / vindex on a 1D array reject non-boolean-mask and mis-shaped selections.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.get_mask_selection(case.input) # type: ignore[arg-type] with case.raises(): z.vindex[case.input] # type: ignore[index] @pytest.mark.parametrize("case", _MASK_2D_CASES, ids=lambda c: c.id) def test_get_mask_selection_2d(store: StorePath, case: Expect[Any, None]) -> None: """get_mask_selection / vindex / getitem on a 2D array match numpy for boolean masks.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_get_mask_selection(a, z, case.input) @pytest.mark.parametrize("case", _MASK_2D_BAD_CASES, ids=lambda c: c.id) def test_get_mask_selection_2d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """vindex on a 2D array rejects masks of the wrong shape or dimensionality.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) with case.raises(): z.vindex[case.input] # type: ignore[index] def _test_set_mask_selection( v: npt.NDArray, a: npt.NDArray, z: Array, selection: npt.NDArray ) -> None: a[:] = 0 z[:] = 0 a[selection] = v[selection] z.set_mask_selection(selection, v[selection]) assert_array_equal(a, z[:]) z[:] = 0 z.vindex[selection] = v[selection] assert_array_equal(a, z[:]) z[:] = 0 z[selection] = v[selection] assert_array_equal(a, z[:]) @pytest.mark.parametrize("case", _MASK_1D_CASES, ids=lambda c: c.id) def test_set_mask_selection_1d(store: StorePath, case: Expect[Any, None]) -> None: """set_mask_selection / vindex / setitem on a 1D array match numpy for boolean masks.""" v = np.arange(30, dtype=int) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) _test_set_mask_selection(v, a, z, case.input) @pytest.mark.parametrize("case", _MASK_1D_BAD_CASES, ids=lambda c: c.id) def test_set_mask_selection_1d_raises(store: StorePath, case: ExpectFail[Any]) -> None: """set_mask_selection / vindex on a 1D array reject non-boolean-mask and mis-shaped selections.""" a = np.arange(30, dtype=int) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) with case.raises(): z.set_mask_selection(case.input, 42) # type: ignore[arg-type] with case.raises(): z.vindex[case.input] = 42 # type: ignore[index] @pytest.mark.parametrize("case", _MASK_2D_CASES, ids=lambda c: c.id) def test_set_mask_selection_2d(store: StorePath, case: Expect[Any, None]) -> None: """set_mask_selection / vindex / setitem on a 2D array match numpy for boolean masks.""" v = np.arange(60, dtype=int).reshape(12, 5) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) _test_set_mask_selection(v, a, z, case.input) def test_get_selection_out(store: StorePath) -> None: """get_*_selection writes results into a provided out buffer, matching numpy.""" # basic selections a = np.arange(30) z = zarr_array_from_numpy_array(store, a, chunk_shape=(7,)) selections = [ slice(5, 15), slice(0, 30), slice(1, 2), ] for selection in selections: expect = a[selection] out = get_ndbuffer_class().from_numpy_array(np.empty(expect.shape)) z.get_basic_selection(selection, out=out) assert_array_equal(expect, out.as_numpy_array()[:]) with pytest.raises(TypeError): z.get_basic_selection(Ellipsis, out=[]) # type: ignore[arg-type] # orthogonal selections a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) selections = [ # index both axes with bool array (_ORTHO_2D_IX0_BOOL, _ORTHO_2D_IX1_BOOL), # mixed indexing with bool array / slice (_ORTHO_2D_IX0_BOOL, slice(1, 4)), (slice(2, 9), _ORTHO_2D_IX1_BOOL), # mixed indexing with bool array / int (_ORTHO_2D_IX0_BOOL, 3), (7, _ORTHO_2D_IX1_BOOL), # mixed int array / bool array (_ORTHO_2D_IX0_BOOL, _ORTHO_2D_IX1_INT), (_ORTHO_2D_IX0_INT, _ORTHO_2D_IX1_BOOL), ] for selection in selections: expect = oindex(a, selection) out = get_ndbuffer_class().from_numpy_array(np.zeros(expect.shape, dtype=expect.dtype)) z.get_orthogonal_selection(selection, out=out) assert_array_equal(expect, out.as_numpy_array()[:]) # coordinate selections a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) selections = [ # index both axes with array (np.array([0, 5, 11]), np.array([0, 2, 4])), # mixed indexing with array / int (np.array([0, 5, 11]), 3), (7, np.array([0, 2, 4])), ] for selection in selections: expect = a[selection] out = get_ndbuffer_class().from_numpy_array(np.zeros(expect.shape, dtype=expect.dtype)) z.get_coordinate_selection(selection, out=out) assert_array_equal(expect, out.as_numpy_array()[:]) @pytest.mark.xfail(reason="fields are not supported in v3") def test_get_selections_with_fields(store: StorePath) -> None: """Would verify that basic, orthogonal, coordinate, and mask selections with structured-array `fields` arguments return the correct sub-fields (xfail: fields unsupported in v3).""" a = np.array( [("aaa", 1, 4.2), ("bbb", 2, 8.4), ("ccc", 3, 12.6)], dtype=[("foo", "S3"), ("bar", "i4"), ("baz", "f8")], ) z = zarr_array_from_numpy_array(store, a, chunk_shape=(2,)) fields_fixture: list[str | list[str]] = [ "foo", ["foo"], ["foo", "bar"], ["foo", "baz"], ["bar", "baz"], ["foo", "bar", "baz"], ["bar", "foo"], ["baz", "bar", "foo"], ] for fields in fields_fixture: # total selection expect = a[fields] actual = z.get_basic_selection(Ellipsis, fields=fields) assert_array_equal(expect, actual) # alternative API if isinstance(fields, str): actual = z[fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z[fields[0], fields[1]] assert_array_equal(expect, actual) if isinstance(fields, str): actual = z[..., fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z[..., fields[0], fields[1]] assert_array_equal(expect, actual) # basic selection with slice expect = a[fields][0:2] actual = z.get_basic_selection(slice(0, 2), fields=fields) assert_array_equal(expect, actual) # alternative API if isinstance(fields, str): actual = z[0:2, fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z[0:2, fields[0], fields[1]] assert_array_equal(expect, actual) # basic selection with single item expect = a[fields][1] actual = z.get_basic_selection(1, fields=fields) assert_array_equal(expect, actual) # alternative API if isinstance(fields, str): actual = z[1, fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z[1, fields[0], fields[1]] assert_array_equal(expect, actual) # orthogonal selection ix = [0, 2] expect = a[fields][ix] actual = z.get_orthogonal_selection(ix, fields=fields) assert_array_equal(expect, actual) # alternative API if isinstance(fields, str): actual = z.oindex[ix, fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z.oindex[ix, fields[0], fields[1]] assert_array_equal(expect, actual) # coordinate selection ix = [0, 2] expect = a[fields][ix] actual = z.get_coordinate_selection(ix, fields=fields) assert_array_equal(expect, actual) # alternative API if isinstance(fields, str): actual = z.vindex[ix, fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z.vindex[ix, fields[0], fields[1]] assert_array_equal(expect, actual) # mask selection ix = [True, False, True] expect = a[fields][ix] actual = z.get_mask_selection(ix, fields=fields) assert_array_equal(expect, actual) # alternative API if isinstance(fields, str): actual = z.vindex[ix, fields] assert_array_equal(expect, actual) elif len(fields) == 2: actual = z.vindex[ix, fields[0], fields[1]] assert_array_equal(expect, actual) # missing/bad fields with pytest.raises(IndexError): z.get_basic_selection(Ellipsis, fields=["notafield"]) with pytest.raises(IndexError): z.get_basic_selection(Ellipsis, fields=slice(None)) # type: ignore[arg-type] @pytest.mark.xfail(reason="fields are not supported in v3") def test_set_selections_with_fields(store: StorePath) -> None: """Would verify that basic, orthogonal, coordinate, and mask set-selections with structured-array `fields` correctly write individual fields and reject multi-field assignment (xfail: fields unsupported in v3).""" v = np.array( [("aaa", 1, 4.2), ("bbb", 2, 8.4), ("ccc", 3, 12.6)], dtype=[("foo", "S3"), ("bar", "i4"), ("baz", "f8")], ) a = np.empty_like(v) z = zarr_array_from_numpy_array(store, v, chunk_shape=(2,)) fields_fixture: list[str | list[str]] = [ "foo", [], ["foo"], ["foo", "bar"], ["foo", "baz"], ["bar", "baz"], ["foo", "bar", "baz"], ["bar", "foo"], ["baz", "bar", "foo"], ] for fields in fields_fixture: # currently multi-field assignment is not supported in numpy, so we won't support # it either if isinstance(fields, list) and len(fields) > 1: with pytest.raises(IndexError): z.set_basic_selection(Ellipsis, v, fields=fields) with pytest.raises(IndexError): z.set_orthogonal_selection([0, 2], v, fields=fields) # type: ignore[arg-type] with pytest.raises(IndexError): z.set_coordinate_selection([0, 2], v, fields=fields) with pytest.raises(IndexError): z.set_mask_selection([True, False, True], v, fields=fields) # type: ignore[arg-type] else: if isinstance(fields, list) and len(fields) == 1: # work around numpy does not support multi-field assignment even if there # is only one field key = fields[0] elif isinstance(fields, list) and len(fields) == 0: # work around numpy ambiguity about what is a field selection key = Ellipsis else: key = fields # setup expectation a[:] = ("", 0, 0) z[:] = ("", 0, 0) assert_array_equal(a, z[:]) a[key] = v[key] # total selection z.set_basic_selection(Ellipsis, v[key], fields=fields) assert_array_equal(a, z[:]) # basic selection with slice a[:] = ("", 0, 0) z[:] = ("", 0, 0) a[key][0:2] = v[key][0:2] z.set_basic_selection(slice(0, 2), v[key][0:2], fields=fields) assert_array_equal(a, z[:]) # orthogonal selection a[:] = ("", 0, 0) z[:] = ("", 0, 0) ix = [0, 2] a[key][ix] = v[key][ix] z.set_orthogonal_selection(ix, v[key][ix], fields=fields) assert_array_equal(a, z[:]) # coordinate selection a[:] = ("", 0, 0) z[:] = ("", 0, 0) ix = [0, 2] a[key][ix] = v[key][ix] z.set_coordinate_selection(ix, v[key][ix], fields=fields) assert_array_equal(a, z[:]) # mask selection a[:] = ("", 0, 0) z[:] = ("", 0, 0) ix = [True, False, True] a[key][ix] = v[key][ix] z.set_mask_selection(ix, v[key][ix], fields=fields) assert_array_equal(a, z[:]) def test_slice_selection_uints() -> None: """make_slice_selection accepts unsigned integer indices without error and produces correct shape.""" arr = np.arange(24).reshape((4, 6)) idx = np.uint64(3) slice_sel = make_slice_selection((idx,)) assert arr[tuple(slice_sel)].shape == (1, 6) def test_numpy_int_indexing(store: StorePath) -> None: """Indexing with a plain Python int and with `np.int64` both return the correct scalar element.""" a = np.arange(1050) z = zarr_array_from_numpy_array(store, a, chunk_shape=(100,)) assert a[42] == z[42] assert a[np.int64(42)] == z[np.int64(42)] @pytest.mark.parametrize( ("shape", "chunks", "ops"), [ # 1D test cases ((1070,), (50,), [("__getitem__", (slice(200, 400),))]), ((1070,), (50,), [("__getitem__", (slice(200, 400, 100),))]), ( (1070,), (50,), [ ("__getitem__", (slice(200, 400),)), ("__setitem__", (slice(200, 400, 100),)), ], ), # 2D test cases ( (40, 50), (5, 8), [ ("__getitem__", (slice(6, 37, 13), (slice(4, 10)))), ("__setitem__", (slice(None), (slice(None)))), ], ), ], ) async def test_accessed_chunks( shape: tuple[int, ...], chunks: tuple[int, ...], ops: list[tuple[str, tuple[slice, ...]]] ) -> None: """Only the chunks intersected by a slice selection are read or written, verified via a `CountingDict` store.""" # Test that only the required chunks are accessed during basic selection operations # shape: array shape # chunks: chunk size # ops: list of tuples with (optype, tuple of slices) # optype = "__getitem__" or "__setitem__", tuple length must match number of dims # Use a counting dict as the backing store so we can track the items access store = await CountingDict.open() z = zarr_array_from_numpy_array(StorePath(store), np.zeros(shape), chunk_shape=chunks) for ii, (optype, slices) in enumerate(ops): # Resolve the slices into the accessed chunks for each dimension chunks_per_dim = [] for N, C, sl in zip(shape, chunks, slices, strict=True): chunk_ind = np.arange(N, dtype=int)[sl] // C chunks_per_dim.append(np.unique(chunk_ind)) # Combine and generate the cartesian product to determine the chunks keys that # will be accessed chunks_accessed = [".".join(map(str, comb)) for comb in itertools.product(*chunks_per_dim)] counts_before = store.counter.copy() # Perform the operation if optype == "__getitem__": z[slices] else: z[slices] = ii # Get the change in counts delta_counts = store.counter - counts_before # Check that the access counts for the operation have increased by one for all # the chunks we expect to be included for ci in chunks_accessed: assert delta_counts.pop((optype, ci)) == 1 # If the chunk was partially written to it will also have been read once. We # don't determine if the chunk was actually partial here, just that the # counts are consistent that this might have happened if optype == "__setitem__": assert ("__getitem__", ci) not in delta_counts or delta_counts.pop( ("__getitem__", ci) ) == 1 # Check that no other chunks were accessed assert len(delta_counts) == 0 @pytest.mark.parametrize( "selection", [ # basic selection [...], [1, ...], [slice(None)], [1, 3], [[1, 2, 3], 4], [np.arange(12)], [slice(2, 9)], [slice(1, 3), 3], [[1, 3]], # mask selection [np.tile([True, False, True, False, True], (12, 1))], [np.full((12, 5), False)], # coordinate selection [[1, 2, 3, 4], [0, 1, 2, 3]], [[10, 11, 5], [4, 0, 2]], ], ) def test_indexing_equals_numpy(store: StorePath, selection: Selection) -> None: """Indexing a zarr array with assorted basic/mask/coordinate selections matches numpy.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) # note: in python 3.10 a[*selection] is not valid unpacking syntax expected = a[*selection,] actual = z[*selection,] assert_array_equal(expected, actual, err_msg=f"selection: {selection}") @pytest.mark.parametrize( "selection", [ [np.tile([True, False], 6), np.tile([True, False, True, False, True], 1)], [np.full(12, False), np.array([True, False, True, False, True])], [np.full(12, True), np.full(5, True)], [np.full(12, True), [True, False, True, False, True]], ], ) def test_orthogonal_bool_indexing_like_numpy_ix( store: StorePath, selection: list[npt.ArrayLike] ) -> None: """Orthogonal boolean indexing on each axis matches numpy's np.ix_ semantics.""" a = np.arange(60, dtype=int).reshape(12, 5) z = zarr_array_from_numpy_array(store, a, chunk_shape=(5, 2)) expected = a[np.ix_(*selection)] # note: in python 3.10 z[*selection] is not valid unpacking syntax actual = z[*selection,] assert_array_equal(expected, actual, err_msg=f"{selection=}") @pytest.mark.parametrize("ndim", [1, 2, 3]) @pytest.mark.parametrize("origin_0d", [None, (0,), (1,)]) @pytest.mark.parametrize("selection_shape_0d", [None, (2,), (3,)]) def test_iter_grid( ndim: int, origin_0d: tuple[int] | None, selection_shape_0d: tuple[int] | None ) -> None: """ Test that iter_grid works as expected for 1, 2, and 3 dimensions. """ grid_shape = (10, 5, 7)[:ndim] if origin_0d is not None: origin_kwarg = origin_0d * ndim origin = origin_kwarg else: origin_kwarg = None origin = (0,) * ndim if selection_shape_0d is not None: selection_shape_kwarg = selection_shape_0d * ndim selection_shape = selection_shape_kwarg else: selection_shape_kwarg = None selection_shape = tuple(gs - o for gs, o in zip(grid_shape, origin, strict=False)) observed = tuple( _iter_grid(grid_shape, origin=origin_kwarg, selection_shape=selection_shape_kwarg) ) # generate a numpy array of indices, and index it coord_array = np.array(list(itertools.product(*[range(s) for s in grid_shape]))).reshape( (*grid_shape, ndim) ) coord_array_indexed = coord_array[ tuple(slice(o, o + s, 1) for o, s in zip(origin, selection_shape, strict=False)) + (range(ndim),) ] expected = tuple(map(tuple, coord_array_indexed.reshape(-1, ndim).tolist())) assert observed == expected def test_iter_grid_invalid() -> None: """ Ensure that a selection_shape that exceeds the grid_shape + origin produces an indexing error. """ with pytest.raises(IndexError): list(_iter_grid((5,), origin=(0,), selection_shape=(10,))) def test_indexing_with_zarr_array(store: StorePath) -> None: """Regression for GH2133: indexing a zarr array with another zarr array (boolean or integer) as the indexer produces the same result as indexing with the equivalent numpy array.""" # regression test for https://github.com/zarr-developers/zarr-python/issues/2133 a = np.arange(10) za = zarr.array(a, chunks=2, store=store, path="a") ix = [False, True, False, True, False, True, False, True, False, True] ii = [0, 2, 4, 5] zix = zarr.array(ix, chunks=2, store=store, dtype="bool", path="ix") zii = zarr.array(ii, chunks=2, store=store, dtype="i4", path="ii") assert_array_equal(a[ix], za[zix]) assert_array_equal(a[ix], za.oindex[zix]) assert_array_equal(a[ix], za.vindex[zix]) assert_array_equal(a[ii], za[zii]) assert_array_equal(a[ii], za.oindex[zii]) @pytest.mark.parametrize("store", ["local", "memory"], indirect=["store"]) @pytest.mark.parametrize("shape", [(0, 2, 3), (0,), (3, 0)]) def test_zero_sized_chunks(store: StorePath, shape: list[int]) -> None: """Arrays with zero-extent dimensions can be created and indexed without error; reading back returns the fill value.""" # Chunk sizes must be >= 1 per spec; use 1 for zero-extent dimensions. chunks = tuple(max(1, s) for s in shape) z = zarr.create_array(store=store, shape=shape, chunks=chunks, zarr_format=3, dtype="f8") z[...] = 42 assert_array_equal(z[...], np.zeros(shape, dtype="f8")) @pytest.mark.parametrize("store", ["memory"], indirect=["store"]) def test_vectorized_indexing_incompatible_shape(store) -> None: """Regression for GH2469: vectorized set-indexing raises ValueError when the value shape is incompatible with the indexer shape.""" # GH2469 shape = (4, 4) chunks = (2, 2) fill_value = 32767 arr = zarr.create( shape, store=store, chunks=chunks, dtype=np.int16, fill_value=fill_value, codecs=[zarr.codecs.BytesCodec(), zarr.codecs.BloscCodec()], ) with pytest.raises(ValueError, match="Attempting to set"): arr[np.array([1, 2]), np.array([1, 2])] = np.array([[-1, -2], [-3, -4]]) def test_iter_chunk_regions(): """_iter_chunk_regions yields slices that exactly cover each chunk, and reading/writing each region round-trips correctly.""" chunks = (2, 3) a = zarr.create((10, 10), chunks=chunks) a[:] = 1 for region in a._iter_chunk_regions(): assert_array_equal(a[region], np.ones_like(a[region])) a[region] = 0 assert_array_equal(a[region], np.zeros_like(a[region])) @pytest.mark.parametrize( ("domain_shape", "region_shape", "origin", "selection_shape"), [ ((9,), (1,), None, (9,)), ((9,), (1,), (0,), (9,)), ((3,), (2,), (0,), (1,)), ((9,), (2,), (2,), (2,)), ((9, 9), (2, 1), None, None), ((9, 9), (4, 1), None, None), ], ) @pytest.mark.parametrize("order", ["lexicographic"]) @pytest.mark.parametrize("trim_excess", [True, False]) def test_iter_regions( domain_shape: tuple[int, ...], region_shape: tuple[int, ...], origin: tuple[int, ...] | None, selection_shape: tuple[int, ...] | None, order: _ArrayIndexingOrder, trim_excess: bool, ) -> None: """ Test that iter_regions properly iterates over contiguous regions of a gridded domain. """ expected_slices_by_dim: list[list[slice]] = [] origin_parsed: tuple[int, ...] selection_shape_parsed: tuple[int, ...] if origin is None: origin_parsed = (0,) * len(domain_shape) else: origin_parsed = origin if selection_shape is None: selection_shape_parsed = tuple( ceildiv(ds, rs) - o for ds, o, rs in zip(domain_shape, origin_parsed, region_shape, strict=True) ) else: selection_shape_parsed = selection_shape for d_s, r_s, o, ss in zip( domain_shape, region_shape, origin_parsed, selection_shape_parsed, strict=True ): _expected_slices: list[slice] = [] start = o * r_s for incr in range(start, start + ss * r_s, r_s): if trim_excess: term = min(incr + r_s, d_s) else: term = incr + r_s _expected_slices.append(slice(incr, term, 1)) expected_slices_by_dim.append(_expected_slices) expected = tuple(itertools.product(*expected_slices_by_dim)) observed = tuple( _iter_regions( domain_shape, region_shape, origin=origin, selection_shape=selection_shape, order=order, trim_excess=trim_excess, ) ) assert observed == expected class TestAsync: @pytest.mark.parametrize( ("indexer", "expected"), [ # int ((0,), np.array([1, 2])), ((1,), np.array([3, 4])), ((0, 1), np.array(2)), # slice ((slice(None),), np.array([[1, 2], [3, 4]])), ((slice(0, 1),), np.array([[1, 2]])), ((slice(1, 2),), np.array([[3, 4]])), ((slice(0, 2),), np.array([[1, 2], [3, 4]])), ((slice(0, 0),), np.empty(shape=(0, 2), dtype="i8")), # ellipsis ((...,), np.array([[1, 2], [3, 4]])), ((0, ...), np.array([1, 2])), ((..., 0), np.array([1, 3])), ((0, 1, ...), np.array(2)), # combined ((0, slice(None)), np.array([1, 2])), ((slice(None), 0), np.array([1, 3])), ((slice(None), slice(None)), np.array([[1, 2], [3, 4]])), # array of ints (([0]), np.array([[1, 2]])), (([1]), np.array([[3, 4]])), (([0], [1]), np.array(2)), (([0, 1], [0]), np.array([[1], [3]])), (([0, 1], [0, 1]), np.array([[1, 2], [3, 4]])), # boolean array (np.array([True, True]), np.array([[1, 2], [3, 4]])), (np.array([True, False]), np.array([[1, 2]])), (np.array([False, True]), np.array([[3, 4]])), (np.array([False, False]), np.empty(shape=(0, 2), dtype="i8")), ], ) async def test_async_oindex(self, store, indexer, expected): """The async `oindex.getitem` interface returns the correct orthogonally-indexed result for int, slice, ellipsis, array, and boolean indexers.""" z = zarr.create_array(store=store, shape=(2, 2), chunks=(1, 1), zarr_format=3, dtype="i8") z[...] = np.array([[1, 2], [3, 4]]) async_zarr = z._async_array result = await async_zarr.oindex.getitem(indexer) assert_array_equal(result, expected) async def test_async_oindex_with_zarr_array(self, store): """The async `oindex.getitem` interface accepts a zarr boolean array as the indexer and returns the correct rows.""" group = zarr.create_group(store=store, zarr_format=3) z1 = group.create_array(name="z1", shape=(2, 2), chunks=(1, 1), dtype="i8") z1[...] = np.array([[1, 2], [3, 4]]) async_zarr = z1._async_array # create boolean zarr array to index with z2 = group.create_array(name="z2", shape=(2,), chunks=(1,), dtype="?") z2[...] = np.array([True, False]) result = await async_zarr.oindex.getitem(z2) expected = np.array([[1, 2]]) assert_array_equal(result, expected) @pytest.mark.parametrize( ("indexer", "expected"), [ (([0], [0]), np.array(1)), (([0, 1], [0, 1]), np.array([1, 4])), (np.array([[False, True], [False, True]]), np.array([2, 4])), ], ) async def test_async_vindex(self, store, indexer, expected): """The async `vindex.getitem` interface returns the correct vectorized-indexed result for coordinate and boolean indexers.""" z = zarr.create_array(store=store, shape=(2, 2), chunks=(1, 1), zarr_format=3, dtype="i8") z[...] = np.array([[1, 2], [3, 4]]) async_zarr = z._async_array result = await async_zarr.vindex.getitem(indexer) assert_array_equal(result, expected) async def test_async_vindex_with_zarr_array(self, store): """The async `vindex.getitem` interface accepts a zarr 2D boolean array as the indexer and returns the correct elements.""" group = zarr.create_group(store=store, zarr_format=3) z1 = group.create_array(name="z1", shape=(2, 2), chunks=(1, 1), dtype="i8") z1[...] = np.array([[1, 2], [3, 4]]) async_zarr = z1._async_array # create boolean zarr array to index with z2 = group.create_array(name="z2", shape=(2, 2), chunks=(1, 1), dtype="?") z2[...] = np.array([[False, True], [False, True]]) result = await async_zarr.vindex.getitem(z2) expected = np.array([2, 4]) assert_array_equal(result, expected) async def test_async_invalid_indexer(self, store): """The async `vindex.getitem` and `oindex.getitem` interfaces raise IndexError when given an unsupported indexer type.""" z = zarr.create_array(store=store, shape=(2, 2), chunks=(1, 1), zarr_format=3, dtype="i8") z[...] = np.array([[1, 2], [3, 4]]) async_zarr = z._async_array with pytest.raises(IndexError): await async_zarr.vindex.getitem("invalid_indexer") with pytest.raises(IndexError): await async_zarr.oindex.getitem("invalid_indexer") zarr-python-3.3.0/tests/test_info.py000066400000000000000000000104051523267620000175230ustar00rootroot00000000000000import textwrap import pytest from zarr.codecs.bytes import BytesCodec from zarr.core._info import ArrayInfo, GroupInfo, human_readable_size from zarr.core.common import ZarrFormat from zarr.core.dtype.npy.int import Int32 ZARR_FORMATS = [2, 3] @pytest.mark.parametrize("zarr_format", ZARR_FORMATS) def test_group_info_repr(zarr_format: ZarrFormat) -> None: info = GroupInfo( _name="a", _store_type="MemoryStore", _read_only=False, _zarr_format=zarr_format ) result = repr(info) expected = textwrap.dedent(f"""\ Name : a Type : Group Zarr format : {zarr_format} Read-only : False Store type : MemoryStore""") assert result == expected @pytest.mark.parametrize("zarr_format", ZARR_FORMATS) def test_group_info_complete(zarr_format: ZarrFormat) -> None: info = GroupInfo( _name="a", _store_type="MemoryStore", _zarr_format=zarr_format, _read_only=False, _count_arrays=10, _count_groups=4, _count_members=14, ) result = repr(info) expected = textwrap.dedent(f"""\ Name : a Type : Group Zarr format : {zarr_format} Read-only : False Store type : MemoryStore No. members : 14 No. arrays : 10 No. groups : 4""") assert result == expected @pytest.mark.parametrize("zarr_format", ZARR_FORMATS) def test_array_info(zarr_format: ZarrFormat) -> None: info = ArrayInfo( _zarr_format=zarr_format, _data_type=Int32(), _fill_value=0, _shape=(100, 100), _chunk_shape=(10, 100), _order="C", _read_only=True, _store_type="MemoryStore", _serializer=BytesCodec(), ) result = repr(info) assert result == textwrap.dedent(f"""\ Type : Array Zarr format : {zarr_format} Data type : Int32(endianness='little') Fill value : 0 Shape : (100, 100) Chunk shape : (10, 100) Order : C Read-only : True Store type : MemoryStore Filters : () Serializer : BytesCodec(endian='little') Compressors : ()""") @pytest.mark.parametrize("zarr_format", ZARR_FORMATS) @pytest.mark.parametrize("bytes_things", [(1_000_000, "976.6K", 500_000, "488.3K", "2.0", 5)]) def test_array_info_complete( zarr_format: ZarrFormat, bytes_things: tuple[int, str, int, str, str, int] ) -> None: ( count_bytes, count_bytes_formatted, count_bytes_stored, count_bytes_stored_formatted, storage_ratio_formatted, count_chunks_initialized, ) = bytes_things info = ArrayInfo( _zarr_format=zarr_format, _data_type=Int32(), _fill_value=0, _shape=(100, 100), _chunk_shape=(10, 100), _order="C", _read_only=True, _store_type="MemoryStore", _serializer=BytesCodec(), _count_bytes=count_bytes, _count_bytes_stored=count_bytes_stored, _count_chunks_initialized=count_chunks_initialized, ) result = repr(info) assert result == textwrap.dedent(f"""\ Type : Array Zarr format : {zarr_format} Data type : Int32(endianness='little') Fill value : 0 Shape : (100, 100) Chunk shape : (10, 100) Order : C Read-only : True Store type : MemoryStore Filters : () Serializer : BytesCodec(endian='little') Compressors : () No. bytes : {count_bytes} ({count_bytes_formatted}) No. bytes stored : {count_bytes_stored} ({count_bytes_stored_formatted}) Storage ratio : {storage_ratio_formatted} Chunks Initialized : 5""") @pytest.mark.parametrize( ("size", "expected"), [ (1, "1"), (2**10, "1.0K"), (2**20, "1.0M"), (2**30, "1.0G"), (2**40, "1.0T"), (2**50, "1.0P"), ], ) def test_human_readable_size(size: int, expected: str) -> None: result = human_readable_size(size) assert result == expected zarr-python-3.3.0/tests/test_json.py000066400000000000000000000102441523267620000175420ustar00rootroot00000000000000from __future__ import annotations import math from typing import TYPE_CHECKING import pytest from zarr.core._json import ( buffer_to_json, buffer_to_json_object, get_json, json_to_buffer, set_json, ) from zarr.core.buffer import cpu, default_buffer_prototype from zarr.storage import MemoryStore from zarr.storage._common import StorePath if TYPE_CHECKING: from zarr.core.common import JSON def test_json_to_buffer_round_trips() -> None: """`buffer_to_json` inverts `json_to_buffer` for an arbitrary JSON value.""" obj: JSON = {"zarr_format": 3, "node_type": "group", "attributes": {"a": [1, 2, 3]}} buffer = json_to_buffer(obj) assert buffer_to_json(buffer) == obj def test_json_to_buffer_uses_given_prototype() -> None: """`json_to_buffer` constructs the buffer from the supplied prototype.""" prototype = default_buffer_prototype() buffer = json_to_buffer({"x": 1}, prototype=prototype) assert isinstance(buffer, prototype.buffer) def test_json_to_buffer_allows_nan_by_default() -> None: """`json_to_buffer` permits NaN by default (writes it as `NaN`).""" buffer = json_to_buffer({"fill_value": math.nan}) decoded = buffer_to_json(buffer) assert isinstance(decoded, dict) assert math.isnan(decoded["fill_value"]) def test_json_to_buffer_allow_nan_false_rejects_nan() -> None: """`json_to_buffer(allow_nan=False)` raises on a non-finite value.""" with pytest.raises(ValueError, match="Out of range float"): json_to_buffer({"fill_value": math.nan}, allow_nan=False) def test_json_to_buffer_indent_controls_formatting() -> None: """`json_to_buffer(indent=...)` controls whitespace in the serialized bytes.""" obj: JSON = {"a": 1, "b": 2} compact = json_to_buffer(obj).to_bytes() indented = json_to_buffer(obj, indent=2).to_bytes() assert b"\n" not in compact assert b"\n" in indented # both still round-trip to the same value assert buffer_to_json(json_to_buffer(obj, indent=2)) == obj async def test_get_json_reads_existing_key() -> None: """`get_json` returns the parsed document stored at an existing key.""" store = MemoryStore() obj: JSON = {"zarr_format": 3, "node_type": "array"} await set_json(store, "zarr.json", obj) assert await get_json(store, "zarr.json") == obj async def test_get_json_returns_none_for_missing_key() -> None: """`get_json` returns None (rather than raising) when the key is absent.""" store = MemoryStore() assert await get_json(store, "does-not-exist") is None async def test_set_json_then_get_json_round_trips() -> None: """`set_json` followed by `get_json` returns the original value.""" store = MemoryStore() obj: JSON = {"a": 1, "b": [2, 3], "c": {"d": None}} await set_json(store, "doc.json", obj) assert await get_json(store, "doc.json") == obj async def test_storepath_get_json_reads_existing_key() -> None: """`StorePath.get_json` reads and parses the document at its own path.""" store = MemoryStore() obj: JSON = {"zarr_format": 2} await set_json(store, "group/.zgroup", obj) sp = StorePath(store, "group/.zgroup") assert await sp.get_json() == obj async def test_storepath_get_json_returns_none_for_missing() -> None: """`StorePath.get_json` returns None when its path is absent.""" store = MemoryStore() sp = StorePath(store, "missing") assert await sp.get_json() is None def test_buffer_to_json_on_cpu_buffer() -> None: """`buffer_to_json` works on a plain CPU buffer built from raw bytes.""" buffer = cpu.Buffer.from_bytes(b'{"hello": "world"}') assert buffer_to_json(buffer) == {"hello": "world"} def test_buffer_to_json_object_returns_dict() -> None: """`buffer_to_json_object` returns the parsed object as a dict.""" buffer = cpu.Buffer.from_bytes(b'{"node_type": "group"}') assert buffer_to_json_object(buffer) == {"node_type": "group"} def test_buffer_to_json_object_rejects_non_object() -> None: """`buffer_to_json_object` raises TypeError when the document is not an object.""" buffer = cpu.Buffer.from_bytes(b"[1, 2, 3]") with pytest.raises(TypeError, match="Expected a JSON object"): buffer_to_json_object(buffer) zarr-python-3.3.0/tests/test_metadata/000077500000000000000000000000001523267620000177765ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_metadata/__init__.py000066400000000000000000000000001523267620000220750ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_metadata/conftest.py000066400000000000000000000025301523267620000221750ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Any from zarr.codecs.bytes import BytesCodec if TYPE_CHECKING: from zarr.core.metadata.v3 import ArrayMetadataJSON_V3 def minimal_metadata_dict_v3( extra_fields: dict[str, Any] | None = None, **overrides: Any ) -> ArrayMetadataJSON_V3: """Build a minimal valid V3 array metadata JSON dict. The output matches the shape of ``ArrayV3Metadata.to_dict()`` — all fields that ``to_dict`` always emits are included. Parameters ---------- extra_fields : dict, optional Extra keys to inject into the dict (e.g. extension fields). **overrides Override any of the standard metadata fields. """ d: ArrayMetadataJSON_V3 = { "zarr_format": 3, "node_type": "array", "shape": (4, 4), "data_type": "uint8", "chunk_grid": {"name": "regular", "configuration": {"chunk_shape": (4, 4)}}, "chunk_key_encoding": {"name": "default", "configuration": {"separator": "/"}}, "fill_value": 0, "codecs": (BytesCodec().to_dict(),), # type: ignore[typeddict-item] "attributes": {}, "storage_transformers": (), } d.update(overrides) # type: ignore[typeddict-item] if extra_fields is not None: d.update(extra_fields) # type: ignore[typeddict-item] return d zarr-python-3.3.0/tests/test_metadata/test_consolidated.py000066400000000000000000001053321523267620000240630ustar00rootroot00000000000000from __future__ import annotations import json from typing import TYPE_CHECKING, Any import numpy as np import pytest from numcodecs import Blosc import zarr.api.asynchronous import zarr.api.synchronous import zarr.storage from zarr import AsyncGroup from zarr.api.asynchronous import ( consolidate_metadata, group, open, open_consolidated, ) from zarr.core.buffer import cpu, default_buffer_prototype from zarr.core.dtype import parse_dtype from zarr.core.group import ConsolidatedMetadata, GroupMetadata from zarr.core.metadata import ArrayV3Metadata from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.errors import ZarrUserWarning from zarr.storage import StorePath if TYPE_CHECKING: from zarr.abc.store import Store from zarr.core.common import JSON, ZarrFormat @pytest.fixture async def memory_store_with_hierarchy(memory_store: Store) -> Store: g = await group(store=memory_store, attributes={"foo": "bar"}) dtype = "uint8" await g.create_array(name="air", shape=(1, 2, 3), dtype=dtype) await g.create_array(name="lat", shape=(1,), dtype=dtype) await g.create_array(name="lon", shape=(2,), dtype=dtype) await g.create_array(name="time", shape=(3,), dtype=dtype) child = await g.create_group("child", attributes={"key": "child"}) await child.create_array("array", shape=(4, 4), attributes={"key": "child"}, dtype=dtype) grandchild = await child.create_group("grandchild", attributes={"key": "grandchild"}) await grandchild.create_array( "array", shape=(4, 4), attributes={"key": "grandchild"}, dtype=dtype ) await grandchild.create_group("empty_group", attributes={"key": "empty"}) return memory_store class TestConsolidated: @pytest.mark.filterwarnings("ignore:Consolidated metadata") async def test_getitem_consolidated_empty_leaf_group( self, memory_store: zarr.storage.MemoryStore, zarr_format: ZarrFormat ) -> None: # This test writes the bytes directly, rather than using the zarr API, to mimic # how older versions of zarr-python wrote the consolidated metadata. # Notably, zarr-python 2.x does not include a # # "consolidated_metadata": {"metadata": {}} # # field on the leaf group nodes. if zarr_format == 2: zmetadata: dict[str, JSON] = { "metadata": { ".zattrs": {}, ".zgroup": {"zarr_format": 2}, "raw/.zattrs": {}, "raw/.zgroup": {"zarr_format": 2}, "raw/varm/.zattrs": {}, "raw/varm/.zgroup": {"zarr_format": 2}, }, "zarr_consolidated_format": 1, } await memory_store.set( ".zgroup", cpu.Buffer.from_bytes(json.dumps({"zarr_format": 2}).encode()) ) await memory_store.set(".zattrs", cpu.Buffer.from_bytes(json.dumps({}).encode())) await memory_store.set( ".zmetadata", cpu.Buffer.from_bytes(json.dumps(zmetadata).encode()) ) else: zmetadata = { "attributes": {}, "zarr_format": 3, "consolidated_metadata": { "kind": "inline", "must_understand": False, "metadata": { "raw": { "attributes": {}, "zarr_format": 3, "node_type": "group", }, "raw/varm": { "attributes": {}, "zarr_format": 3, "node_type": "group", }, }, }, "node_type": "group", } await memory_store.set( "zarr.json", cpu.Buffer.from_bytes(json.dumps(zmetadata).encode()) ) group = await zarr.api.asynchronous.open_consolidated( store=memory_store, zarr_format=zarr_format ) raw = await group.get_group("raw") assert raw.metadata.consolidated_metadata is not None varm = await raw.get_group("varm") assert varm.metadata.consolidated_metadata == ConsolidatedMetadata(metadata={}) async def test_open_consolidated_false_raises(self) -> None: store = zarr.storage.MemoryStore() with pytest.raises(TypeError, match="use_consolidated"): await zarr.api.asynchronous.open_consolidated(store, use_consolidated=False) # type: ignore[arg-type] def test_open_consolidated_false_raises_sync(self) -> None: store = zarr.storage.MemoryStore() with pytest.raises(TypeError, match="use_consolidated"): zarr.open_consolidated(store, use_consolidated=False) # type: ignore[arg-type] async def test_consolidated(self, memory_store_with_hierarchy: Store) -> None: # TODO: Figure out desired keys in # TODO: variety in the hierarchies # More nesting # arrays under arrays # single array # etc. with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await consolidate_metadata(memory_store_with_hierarchy) group2 = await AsyncGroup.open(memory_store_with_hierarchy) array_metadata: dict[str, JSON] = { "attributes": {}, "chunk_key_encoding": { "configuration": {"separator": "/"}, "name": "default", }, "codecs": ( {"configuration": {"endian": "little"}, "name": "bytes"}, {"configuration": {"level": 0, "checksum": False}, "name": "zstd"}, ), "data_type": "uint8", "fill_value": 0, "node_type": "array", # "shape": (1, 2, 3), "zarr_format": 3, } expected = GroupMetadata( attributes={"foo": "bar"}, consolidated_metadata=ConsolidatedMetadata( kind="inline", must_understand=False, metadata={ "air": ArrayV3Metadata.from_dict( { "shape": (1, 2, 3), "chunk_grid": { "configuration": {"chunk_shape": (1, 2, 3)}, "name": "regular", }, **array_metadata, } ), "lat": ArrayV3Metadata.from_dict( { "shape": (1,), "chunk_grid": { "configuration": {"chunk_shape": (1,)}, "name": "regular", }, **array_metadata, } ), "lon": ArrayV3Metadata.from_dict( { "shape": (2,), "chunk_grid": { "configuration": {"chunk_shape": (2,)}, "name": "regular", }, **array_metadata, } ), "time": ArrayV3Metadata.from_dict( { "shape": (3,), "chunk_grid": { "configuration": {"chunk_shape": (3,)}, "name": "regular", }, **array_metadata, } ), "child": GroupMetadata( attributes={"key": "child"}, consolidated_metadata=ConsolidatedMetadata( metadata={ "array": ArrayV3Metadata.from_dict( { **array_metadata, "attributes": {"key": "child"}, "shape": (4, 4), "chunk_grid": { "configuration": {"chunk_shape": (4, 4)}, "name": "regular", }, } ), "grandchild": GroupMetadata( attributes={"key": "grandchild"}, consolidated_metadata=ConsolidatedMetadata( metadata={ # known to be empty child group "empty_group": GroupMetadata( consolidated_metadata=ConsolidatedMetadata( metadata={} ), attributes={"key": "empty"}, ), "array": ArrayV3Metadata.from_dict( { **array_metadata, "attributes": {"key": "grandchild"}, "shape": (4, 4), "chunk_grid": { "configuration": {"chunk_shape": (4, 4)}, "name": "regular", }, } ), } ), ), }, ), ), }, ), ) assert group2.metadata == expected group3 = await open(store=memory_store_with_hierarchy) assert group3.metadata == expected group4 = await open_consolidated(store=memory_store_with_hierarchy) assert group4.metadata == expected buf = await memory_store_with_hierarchy.get( "zarr.json", prototype=default_buffer_prototype() ) assert buf is not None result_raw = json.loads(buf.to_bytes())["consolidated_metadata"] assert result_raw["kind"] == "inline" assert sorted(result_raw["metadata"]) == [ "air", "child", "child/array", "child/grandchild", "child/grandchild/array", "child/grandchild/empty_group", "lat", "lon", "time", ] def test_consolidated_sync(self, memory_store: Store) -> None: g = zarr.api.synchronous.group(store=memory_store, attributes={"foo": "bar"}) dtype = "uint8" g.create_array(name="air", shape=(1, 2, 3), dtype=dtype) g.create_array(name="lat", shape=(1,), dtype=dtype) g.create_array(name="lon", shape=(2,), dtype=dtype) g.create_array(name="time", shape=(3,), dtype=dtype) with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): zarr.api.synchronous.consolidate_metadata(memory_store) group2 = zarr.Group.open(memory_store) array_metadata: dict[str, JSON] = { "attributes": {}, "chunk_key_encoding": { "configuration": {"separator": "/"}, "name": "default", }, "codecs": ( {"configuration": {"endian": "little"}, "name": "bytes"}, {"configuration": {"level": 0, "checksum": False}, "name": "zstd"}, ), "data_type": dtype, "fill_value": 0, "node_type": "array", # "shape": (1, 2, 3), "zarr_format": 3, } expected = GroupMetadata( attributes={"foo": "bar"}, consolidated_metadata=ConsolidatedMetadata( kind="inline", must_understand=False, metadata={ "air": ArrayV3Metadata.from_dict( { "shape": (1, 2, 3), "chunk_grid": { "configuration": {"chunk_shape": (1, 2, 3)}, "name": "regular", }, **array_metadata, } ), "lat": ArrayV3Metadata.from_dict( { "shape": (1,), "chunk_grid": { "configuration": {"chunk_shape": (1,)}, "name": "regular", }, **array_metadata, } ), "lon": ArrayV3Metadata.from_dict( { "shape": (2,), "chunk_grid": { "configuration": {"chunk_shape": (2,)}, "name": "regular", }, **array_metadata, } ), "time": ArrayV3Metadata.from_dict( { "shape": (3,), "chunk_grid": { "configuration": {"chunk_shape": (3,)}, "name": "regular", }, **array_metadata, } ), }, ), ) assert group2.metadata == expected group3 = zarr.api.synchronous.open(store=memory_store) assert group3.metadata == expected group4 = zarr.api.synchronous.open_consolidated(store=memory_store) assert group4.metadata == expected async def test_not_writable_raises(self, memory_store: zarr.storage.MemoryStore) -> None: await group(store=memory_store, attributes={"foo": "bar"}) read_store = zarr.storage.MemoryStore(store_dict=memory_store._store_dict, read_only=True) with pytest.raises(ValueError, match="does not support writing"): await consolidate_metadata(read_store) async def test_non_root_node(self, memory_store_with_hierarchy: Store) -> None: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await consolidate_metadata(memory_store_with_hierarchy, path="child") root = await AsyncGroup.open(memory_store_with_hierarchy) child = await AsyncGroup.open(StorePath(memory_store_with_hierarchy) / "child") assert root.metadata.consolidated_metadata is None assert child.metadata.consolidated_metadata is not None assert "air" not in child.metadata.consolidated_metadata.metadata assert "grandchild" in child.metadata.consolidated_metadata.metadata def test_consolidated_metadata_from_dict(self) -> None: data: dict[str, JSON] = {"must_understand": False} # missing kind with pytest.raises(ValueError, match="kind='None'"): ConsolidatedMetadata.from_dict(data) # invalid kind data["kind"] = "invalid" with pytest.raises(ValueError, match="kind='invalid'"): ConsolidatedMetadata.from_dict(data) # missing metadata data["kind"] = "inline" with pytest.raises(TypeError, match="Unexpected type for 'metadata'"): ConsolidatedMetadata.from_dict(data) data["kind"] = "inline" # empty is fine data["metadata"] = {} ConsolidatedMetadata.from_dict(data) def test_flatten(self) -> None: array_metadata: dict[str, Any] = { "attributes": {}, "chunk_key_encoding": { "configuration": {"separator": "/"}, "name": "default", }, "codecs": ({"configuration": {"endian": "little"}, "name": "bytes"},), "data_type": "float64", "fill_value": np.float64(0.0), "node_type": "array", # "shape": (1, 2, 3), "zarr_format": 3, } metadata = ConsolidatedMetadata( kind="inline", must_understand=False, metadata={ "air": ArrayV3Metadata.from_dict( { "shape": (1, 2, 3), "chunk_grid": { "configuration": {"chunk_shape": (1, 2, 3)}, "name": "regular", }, **array_metadata, } ), "lat": ArrayV3Metadata.from_dict( { "shape": (1,), "chunk_grid": { "configuration": {"chunk_shape": (1,)}, "name": "regular", }, **array_metadata, } ), "child": GroupMetadata( attributes={"key": "child"}, consolidated_metadata=ConsolidatedMetadata( metadata={ "array": ArrayV3Metadata.from_dict( { **array_metadata, "attributes": {"key": "child"}, "shape": (4, 4), "chunk_grid": { "configuration": {"chunk_shape": (4, 4)}, "name": "regular", }, } ), "grandchild": GroupMetadata( attributes={"key": "grandchild"}, consolidated_metadata=ConsolidatedMetadata( metadata={ "array": ArrayV3Metadata.from_dict( { **array_metadata, "attributes": {"key": "grandchild"}, "shape": (4, 4), "chunk_grid": { "configuration": {"chunk_shape": (4, 4)}, "name": "regular", }, } ) } ), ), }, ), ), }, ) result = metadata.flattened_metadata expected = { "air": metadata.metadata["air"], "lat": metadata.metadata["lat"], "child": GroupMetadata( attributes={"key": "child"}, consolidated_metadata=ConsolidatedMetadata(metadata={}) ), "child/array": metadata.metadata["child"].consolidated_metadata.metadata["array"], # type: ignore[union-attr] "child/grandchild": GroupMetadata( attributes={"key": "grandchild"}, consolidated_metadata=ConsolidatedMetadata(metadata={}), ), "child/grandchild/array": ( metadata.metadata["child"] .consolidated_metadata.metadata["grandchild"] # type: ignore[union-attr] .consolidated_metadata.metadata["array"] ), } assert result == expected def test_invalid_metadata_raises(self) -> None: payload: dict[str, JSON] = { "kind": "inline", "must_understand": False, "metadata": { "foo": [1, 2, 3] # invalid }, } with pytest.raises(TypeError, match="key='foo', type='list'"): ConsolidatedMetadata.from_dict(payload) def test_to_dict_empty(self) -> None: meta = ConsolidatedMetadata( metadata={ "empty": GroupMetadata( attributes={"key": "empty"}, consolidated_metadata=ConsolidatedMetadata(metadata={}), ) } ) result = meta.to_dict() expected = { "kind": "inline", "must_understand": False, "metadata": { "empty": { "attributes": {"key": "empty"}, "consolidated_metadata": { "kind": "inline", "must_understand": False, "metadata": {}, }, "node_type": "group", "zarr_format": 3, } }, } assert result == expected @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_to_dict_order( self, memory_store: zarr.storage.MemoryStore, zarr_format: ZarrFormat ) -> None: with zarr.config.set(default_zarr_format=zarr_format): g = await group(store=memory_store) # Create groups in non-lexicographix order dtype = "float32" await g.create_array(name="b", shape=(1,), dtype=dtype) child = await g.create_group("c", attributes={"key": "child"}) await g.create_array(name="a", shape=(1,), dtype=dtype) await child.create_array("e", shape=(1,), dtype=dtype) await child.create_array("d", shape=(1,), dtype=dtype) # Consolidate metadata and re-open store if zarr_format == 3: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(memory_store) else: await zarr.api.asynchronous.consolidate_metadata(memory_store) g2 = await zarr.api.asynchronous.open_group(store=memory_store) assert g2.metadata.consolidated_metadata is not None assert list(g2.metadata.consolidated_metadata.metadata) == ["a", "b", "c"] assert list(g2.metadata.consolidated_metadata.flattened_metadata) == [ "a", "b", "c", "c/d", "c/e", ] @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_open_consolidated_raises_async(self, zarr_format: ZarrFormat) -> None: store = zarr.storage.MemoryStore() await AsyncGroup.from_store(store, zarr_format=zarr_format) with pytest.raises(ValueError): await zarr.api.asynchronous.open_consolidated(store, zarr_format=zarr_format) with pytest.raises(ValueError): await zarr.api.asynchronous.open_consolidated(store, zarr_format=None) @pytest.fixture async def v2_consolidated_metadata_empty_dataset( self, memory_store: zarr.storage.MemoryStore ) -> AsyncGroup: zgroup_bytes = cpu.Buffer.from_bytes(json.dumps({"zarr_format": 2}).encode()) zmetadata_bytes = cpu.Buffer.from_bytes( b'{"metadata":{".zgroup":{"zarr_format":2}},"zarr_consolidated_format":1}' ) return AsyncGroup._from_bytes_v2( StorePath(memory_store, path=""), zgroup_bytes, zattrs_bytes=None, consolidated_metadata_bytes=zmetadata_bytes, ) async def test_consolidated_metadata_backwards_compatibility( self, v2_consolidated_metadata_empty_dataset: AsyncGroup ) -> None: """ Test that consolidated metadata handles a missing .zattrs key. This is necessary for backwards compatibility with zarr-python 2.x. See https://github.com/zarr-developers/zarr-python/issues/2694 """ store = zarr.storage.MemoryStore() await zarr.api.asynchronous.open(store=store, zarr_format=2) await zarr.api.asynchronous.consolidate_metadata(store) result = await zarr.api.asynchronous.open_consolidated(store, zarr_format=2) assert result.metadata == v2_consolidated_metadata_empty_dataset.metadata async def test_consolidated_metadata_v2(self) -> None: store = zarr.storage.MemoryStore() g = await AsyncGroup.from_store(store, attributes={"key": "root"}, zarr_format=2) dtype = parse_dtype("uint8", zarr_format=2) await g.create_array(name="a", shape=(1,), attributes={"key": "a"}, dtype=dtype) g1 = await g.create_group(name="g1", attributes={"key": "g1"}) await g1.create_group(name="g2", attributes={"key": "g2"}) await zarr.api.asynchronous.consolidate_metadata(store) result = await zarr.api.asynchronous.open_consolidated(store, zarr_format=2) expected = GroupMetadata( attributes={"key": "root"}, zarr_format=2, consolidated_metadata=ConsolidatedMetadata( metadata={ "a": ArrayV2Metadata( shape=(1,), dtype=dtype, attributes={"key": "a"}, chunks=(1,), fill_value=0, compressor=Blosc(), order="C", ), "g1": GroupMetadata( attributes={"key": "g1"}, zarr_format=2, consolidated_metadata=ConsolidatedMetadata( metadata={ "g2": GroupMetadata( attributes={"key": "g2"}, zarr_format=2, consolidated_metadata=ConsolidatedMetadata(metadata={}), ) } ), ), } ), ) assert result.metadata == expected @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_use_consolidated_false( self, memory_store: zarr.storage.MemoryStore, zarr_format: ZarrFormat ) -> None: with zarr.config.set(default_zarr_format=zarr_format): g = await group(store=memory_store, attributes={"foo": "bar"}) await g.create_group(name="a") # test a stale read if zarr_format == 3: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(memory_store) else: await zarr.api.asynchronous.consolidate_metadata(memory_store) await g.create_group(name="b") stale = await zarr.api.asynchronous.open_group(store=memory_store) assert len([x async for x in stale.members()]) == 1 assert stale.metadata.consolidated_metadata assert list(stale.metadata.consolidated_metadata.metadata) == ["a"] # bypass stale data good = await zarr.api.asynchronous.open_group( store=memory_store, use_consolidated=False ) assert len([x async for x in good.members()]) == 2 # reconsolidate if zarr_format == 3: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(memory_store) else: await zarr.api.asynchronous.consolidate_metadata(memory_store) good = await zarr.api.asynchronous.open_group(store=memory_store) assert len([x async for x in good.members()]) == 2 assert good.metadata.consolidated_metadata assert sorted(good.metadata.consolidated_metadata.metadata) == ["a", "b"] async def test_stale_child_metadata_ignored( self, memory_store: zarr.storage.MemoryStore ) -> None: # https://github.com/zarr-developers/zarr-python/issues/2921 # When consolidating metadata, we should ignore any (possibly stale) metadata # from previous consolidations, *including at child nodes*. root = await zarr.api.asynchronous.group(store=memory_store, zarr_format=3) await root.create_group("foo") await zarr.api.asynchronous.consolidate_metadata(memory_store, path="foo") await root.create_group("foo/bar/spam") with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(memory_store) reopened = await zarr.api.asynchronous.open_consolidated(store=memory_store, zarr_format=3) result = [x[0] async for x in reopened.members(max_depth=None)] expected = ["foo", "foo/bar", "foo/bar/spam"] assert result == expected async def test_use_consolidated_for_children_members( self, memory_store: zarr.storage.MemoryStore ) -> None: # A test that has *unconsolidated* metadata at the root group, but discovers # a child group with consolidated metadata. root = await zarr.api.asynchronous.create_group(store=memory_store) await root.create_group("a/b") # Consolidate metadata at "a/b" await zarr.api.asynchronous.consolidate_metadata(memory_store, path="a/b") # Add a new group a/b/c, that's not present in the CM at "a/b" await root.create_group("a/b/c") # Now according to the consolidated metadata, "a" has children ["b"] # but according to the unconsolidated metadata, "a" has children ["b", "c"] group = await zarr.api.asynchronous.open_group(store=memory_store, path="a") with pytest.warns(ZarrUserWarning, match="Object at 'c' not found"): result = sorted([x[0] async for x in group.members(max_depth=None)]) expected = ["b"] assert result == expected result = sorted( [x[0] async for x in group.members(max_depth=None, use_consolidated_for_children=False)] ) expected = ["b", "b/c"] assert result == expected async def test_absolute_path_for_subgroup(self, memory_store: zarr.storage.MemoryStore) -> None: root = await zarr.api.asynchronous.create_group(store=memory_store) await root.create_group("a/b") with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(memory_store) group = await zarr.api.asynchronous.open_group(store=memory_store) subgroup = await group.get_group("/a") members = [x async for x in subgroup.keys()] # noqa: SIM118 assert members == ["b"] @pytest.mark.parametrize("fill_value", [np.nan, np.inf, -np.inf]) async def test_consolidated_metadata_encodes_special_chars( memory_store: Store, zarr_format: ZarrFormat, fill_value: float ) -> None: root = await group(store=memory_store, zarr_format=zarr_format) _time = await root.create_array("time", shape=(12,), dtype=np.float64, fill_value=fill_value) if zarr_format == 3: with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): await zarr.api.asynchronous.consolidate_metadata(memory_store) else: await zarr.api.asynchronous.consolidate_metadata(memory_store) root = await group(store=memory_store, zarr_format=zarr_format) root_buffer = root.metadata.to_buffer_dict(default_buffer_prototype()) if zarr_format == 2: root_metadata = json.loads(root_buffer[".zmetadata"].to_bytes().decode("utf-8"))["metadata"] elif zarr_format == 3: root_metadata = json.loads(root_buffer["zarr.json"].to_bytes().decode("utf-8"))[ "consolidated_metadata" ]["metadata"] expected_fill_value = _time._zdtype.to_json_scalar(fill_value, zarr_format=2) if zarr_format == 2: assert root_metadata["time/.zarray"]["fill_value"] == expected_fill_value elif zarr_format == 3: assert root_metadata["time"]["fill_value"] == expected_fill_value class NonConsolidatedStore(zarr.storage.MemoryStore): """A store that doesn't support consolidated metadata""" @property def supports_consolidated_metadata(self) -> bool: return False async def test_consolidate_metadata_raises_for_self_consolidating_stores() -> None: """Verify calling consolidate_metadata on a non supporting stores raises an error.""" memory_store = NonConsolidatedStore() root = await zarr.api.asynchronous.create_group(store=memory_store) await root.create_group("a/b") with pytest.raises(TypeError, match="doesn't support consolidated metadata"): await zarr.api.asynchronous.consolidate_metadata(memory_store) async def test_open_group_in_non_consolidating_stores() -> None: memory_store = NonConsolidatedStore() root = await zarr.api.asynchronous.create_group(store=memory_store) await root.create_group("a/b") # Opening a group without consolidatedion works as expected await AsyncGroup.open(memory_store, use_consolidated=False) # let the Store opt out of consolidation await AsyncGroup.open(memory_store, use_consolidated=None) # Opening a group with use_consolidated=True should fail with pytest.raises(ValueError, match="doesn't support consolidated metadata"): await AsyncGroup.open(memory_store, use_consolidated=True) zarr-python-3.3.0/tests/test_metadata/test_v2.py000066400000000000000000000342641523267620000217470ustar00rootroot00000000000000from __future__ import annotations import json from typing import TYPE_CHECKING, Literal import numpy as np import pytest import zarr.api.asynchronous import zarr.storage from zarr.core.buffer import cpu from zarr.core.buffer.core import default_buffer_prototype from zarr.core.dtype.npy.float import Float32, Float64 from zarr.core.dtype.npy.int import Int16 from zarr.core.group import ConsolidatedMetadata, GroupMetadata from zarr.core.metadata import ArrayV2Metadata from zarr.core.metadata.v2 import parse_zarr_format from zarr.errors import ZarrUserWarning if TYPE_CHECKING: from pathlib import Path from typing import Any from zarr.abc.codec import Codec from zarr.core.common import JSON def test_parse_zarr_format_valid() -> None: assert parse_zarr_format(2) == 2 # The explicit id for "3" avoids colliding with the auto-generated id for the int 3. @pytest.mark.parametrize("data", [None, 1, 3, 4, 5, pytest.param("3", id="3-str")]) def test_parse_zarr_format_invalid(data: Any) -> None: with pytest.raises(ValueError, match=f"Invalid value. Expected 2. Got {data}"): parse_zarr_format(data) @pytest.mark.parametrize("attributes", [None, {"foo": "bar"}]) @pytest.mark.parametrize("filters", [None, [{"id": "gzip", "level": 1}]]) @pytest.mark.parametrize("compressor", [None, {"id": "gzip", "level": 1}]) @pytest.mark.parametrize("fill_value", [None, 0, 1]) @pytest.mark.parametrize("order", ["C", "F"]) @pytest.mark.parametrize("dimension_separator", [".", "/", None]) def test_metadata_to_dict( compressor: Codec | None, filters: tuple[Codec] | None, fill_value: Any, order: Literal["C", "F"], dimension_separator: Literal[".", "/"] | None, attributes: dict[str, Any] | None, ) -> None: shape = (1, 2, 3) chunks = (1,) * len(shape) data_type = "|u1" metadata_dict = { "zarr_format": 2, "shape": shape, "chunks": chunks, "dtype": data_type, "order": order, "compressor": compressor, "filters": filters, "fill_value": fill_value, } if attributes is not None: metadata_dict["attributes"] = attributes if dimension_separator is not None: metadata_dict["dimension_separator"] = dimension_separator metadata = ArrayV2Metadata.from_dict(metadata_dict) observed = metadata.to_dict() expected = metadata_dict.copy() if attributes is None: assert observed["attributes"] == {} observed.pop("attributes") if dimension_separator is None: expected_dimension_sep = "." assert observed["dimension_separator"] == expected_dimension_sep observed.pop("dimension_separator") assert observed == expected def test_filters_empty_tuple_warns() -> None: metadata_dict = { "zarr_format": 2, "shape": (1,), "chunks": (1,), "dtype": "|u1", "order": "C", "compressor": None, "filters": (), "fill_value": 0, } with pytest.warns( ZarrUserWarning, match="Found an empty list of filters in the array metadata document." ): meta = ArrayV2Metadata.from_dict(metadata_dict) assert meta.filters is None class TestConsolidated: @pytest.fixture async def v2_consolidated_metadata( self, memory_store: zarr.storage.MemoryStore ) -> zarr.storage.MemoryStore: zmetadata: dict[str, JSON] = { "metadata": { ".zattrs": { "Conventions": "COARDS", }, ".zgroup": {"zarr_format": 2}, "air/.zarray": { "chunks": [730], "compressor": None, "dtype": " None: # .zgroup, .zattrs, .metadata store = v2_consolidated_metadata group = zarr.open_consolidated(store=store, zarr_format=2) assert group.metadata.consolidated_metadata is not None expected = ConsolidatedMetadata( metadata={ "air": ArrayV2Metadata( shape=(730,), fill_value=0, chunks=(730,), attributes={"_ARRAY_DIMENSIONS": ["time"], "dataset": "NMC Reanalysis"}, dtype=Int16(), order="C", filters=None, dimension_separator=".", compressor=None, ), "time": ArrayV2Metadata( shape=(730,), fill_value=0.0, chunks=(730,), attributes={ "_ARRAY_DIMENSIONS": ["time"], "calendar": "standard", "long_name": "Time", "standard_name": "time", "units": "hours since 1800-01-01", }, dtype=Float32(), order="C", filters=None, dimension_separator=".", compressor=None, ), "nested": GroupMetadata( attributes={"key": "value"}, zarr_format=2, consolidated_metadata=ConsolidatedMetadata( metadata={ "array": ArrayV2Metadata( shape=(730,), fill_value=0.0, chunks=(730,), attributes={ "calendar": "standard", }, dtype=Float32(), order="C", filters=None, dimension_separator=".", compressor=None, ) } ), ), }, kind="inline", must_understand=False, ) result = group.metadata.consolidated_metadata assert result == expected async def test_getitem_consolidated( self, v2_consolidated_metadata: zarr.storage.MemoryStore ) -> None: store = v2_consolidated_metadata group = await zarr.api.asynchronous.open_consolidated(store=store, zarr_format=2) air = await group.getitem("air") assert isinstance(air, zarr.AsyncArray) assert air.metadata.shape == (730,) def test_from_dict_extra_fields() -> None: data = { "_nczarr_array": {"dimrefs": ["/dim1", "/dim2"], "storage": "chunked"}, "attributes": {"key": "value"}, "chunks": [8], "compressor": None, "dtype": " None: """Two metadata objects with an identical NaN fill_value compare equal. NaN is not equal to itself under IEEE 754, so the default dataclass __eq__ reports two otherwise-identical metadata objects as unequal. Metadata equality must treat matching NaN fill values as equal (see issue #2929). """ a = ArrayV2Metadata( shape=(8,), dtype=Float64(), chunks=(8,), fill_value=np.float64("nan"), order="C" ) b = ArrayV2Metadata( shape=(8,), dtype=Float64(), chunks=(8,), fill_value=np.float64("nan"), order="C" ) assert a == b def test_eq_distinct_fill_value() -> None: """Metadata objects that differ only in fill_value do not compare equal.""" a = ArrayV2Metadata(shape=(8,), dtype=Float64(), chunks=(8,), fill_value=0.0, order="C") b = ArrayV2Metadata(shape=(8,), dtype=Float64(), chunks=(8,), fill_value=1.0, order="C") assert a != b @pytest.mark.parametrize("fill_value", [np.float64("inf"), np.float64("-inf")]) def test_eq_inf_fill_value(fill_value: np.float64) -> None: """Two metadata objects with an identical infinite fill_value compare equal.""" a = ArrayV2Metadata(shape=(8,), dtype=Float64(), chunks=(8,), fill_value=fill_value, order="C") b = ArrayV2Metadata(shape=(8,), dtype=Float64(), chunks=(8,), fill_value=fill_value, order="C") assert a == b def test_hash_consistent_with_eq_nan_fill_value() -> None: """Equal metadata objects with a NaN fill_value hash equal. NaN hashes by identity, so a field-based hash would break the ``a == b implies hash(a) == hash(b)`` invariant for objects that compare equal under the to_dict-based __eq__. """ a = ArrayV2Metadata( shape=(8,), dtype=Float64(), chunks=(8,), fill_value=np.float64("nan"), order="C" ) b = ArrayV2Metadata( shape=(8,), dtype=Float64(), chunks=(8,), fill_value=np.float64("nan"), order="C" ) assert a == b assert hash(a) == hash(b) def test_eq_non_metadata() -> None: """Comparison against a non-metadata object returns False rather than erroring.""" a = ArrayV2Metadata(shape=(8,), dtype=Float64(), chunks=(8,), fill_value=0.0, order="C") assert a != object() def test_zstd_checksum() -> None: compressor_config: dict[str, JSON] = {"id": "zstd", "level": 5, "checksum": False} arr = zarr.create_array( {}, shape=(10,), chunks=(10,), dtype="int32", compressors=compressor_config, zarr_format=2, ) metadata = json.loads( arr.metadata.to_buffer_dict(default_buffer_prototype())[".zarray"].to_bytes() ) assert "checksum" not in metadata["compressor"] @pytest.mark.parametrize("fill_value", [np.void((0, 0), np.dtype([("foo", "i4"), ("bar", "i4")]))]) def test_structured_dtype_fill_value_serialization( tmp_path: Path, fill_value: np.void | np.dtype[Any] ) -> None: zarr_format: Literal[2] = 2 group_path = tmp_path / "test.zarr" root_group = zarr.open_group(group_path, mode="w", zarr_format=zarr_format) dtype = np.dtype([("foo", "i4"), ("bar", "i4")]) root_group.create_array( name="structured_dtype", shape=(100, 100), chunks=(100, 100), dtype=dtype, fill_value=fill_value, ) zarr.consolidate_metadata(root_group.store, zarr_format=zarr_format) root_group = zarr.open_group(group_path, mode="r") observed = root_group.metadata.consolidated_metadata.metadata["structured_dtype"].fill_value # type: ignore[union-attr] assert observed == fill_value zarr-python-3.3.0/tests/test_metadata/test_v3.py000066400000000000000000000433751523267620000217530ustar00rootroot00000000000000"""Tests for zarr v3 metadata classes and parsing helpers.""" from __future__ import annotations import json from typing import TYPE_CHECKING import numpy as np import pytest from tests.conftest import Expect, ExpectFail from tests.test_metadata.conftest import minimal_metadata_dict_v3 from zarr.core.buffer import default_buffer_prototype from zarr.core.chunk_grids import is_regular_1d, is_regular_nd from zarr.core.config import config from zarr.core.dtype import Float64, UInt8 from zarr.core.group import GroupMetadata, parse_node_type from zarr.core.metadata.v2 import ArrayV2Metadata from zarr.core.metadata.v3 import ( ARRAY_METADATA_KEYS, ArrayMetadataJSON_V3, ArrayV3Metadata, parse_codecs, parse_dimension_names, parse_node_type_array, parse_zarr_format, ) from zarr.errors import ( MetadataValidationError, NodeTypeValidationError, UnknownCodecError, ) if TYPE_CHECKING: from typing import Any # --------------------------------------------------------------------------- # Parsing helpers # --------------------------------------------------------------------------- def test_parse_zarr_format_valid() -> None: """The integer 3 is the only valid zarr_format for v3.""" assert parse_zarr_format(3) == 3 @pytest.mark.parametrize("data", [None, 1, 2, 4, 5, "3"]) def test_parse_zarr_format_invalid(data: Any) -> None: """Non-3 values are rejected.""" with pytest.raises(MetadataValidationError): parse_zarr_format(data) def test_parse_node_type_valid() -> None: """'array' and 'group' are the only valid node types.""" assert parse_node_type("array") == "array" assert parse_node_type("group") == "group" @pytest.mark.parametrize("data", [None, 2, "other"]) def test_parse_node_type_invalid(data: Any) -> None: """Non-string and unrecognized values are rejected.""" with pytest.raises(MetadataValidationError): parse_node_type(data) def test_parse_node_type_array_valid() -> None: """parse_node_type_array accepts only 'array'.""" assert parse_node_type_array("array") == "array" @pytest.mark.parametrize("data", [None, "group"]) def test_parse_node_type_array_invalid(data: Any) -> None: """parse_node_type_array rejects 'group' and non-string values.""" with pytest.raises(NodeTypeValidationError): parse_node_type_array(data) @pytest.mark.parametrize("data", [None, ("a", "b", "c"), ["a", "a", "a"], ()]) def test_parse_dimension_names_valid(data: Any) -> None: """None, tuples of strings, lists of strings, and empty tuples are accepted.""" result = parse_dimension_names(data) if data is None: assert result is None else: assert result == tuple(data) @pytest.mark.parametrize("data", [[1, 2, "a"], [None, 3]]) def test_parse_dimension_names_invalid(data: Any) -> None: """Iterables containing non-string elements are rejected.""" with pytest.raises(TypeError, match="Expected either None or"): parse_dimension_names(data) def test_parse_codecs_unknown_raises(monkeypatch: pytest.MonkeyPatch) -> None: """An unregistered codec name raises UnknownCodecError.""" from collections import defaultdict import zarr.registry from zarr.registry import Registry monkeypatch.setattr(zarr.registry, "_codec_registries", defaultdict(Registry)) with pytest.raises(UnknownCodecError): parse_codecs([{"name": "unknown"}]) # --------------------------------------------------------------------------- # Chunk-grid regularity helpers # --------------------------------------------------------------------------- # Cases used for both list/tuple (Python-sequence path) and ndarray (vectorized # path) of `is_regular_1d`. Parametrizing the input form ensures both branches # are exercised by the same suite of edge cases. _REGULAR_1D_CASES: list[Expect[list[int], bool]] = [ Expect(input=[], output=True, id="empty"), Expect(input=[10], output=True, id="single-chunk"), Expect(input=[10, 10, 10], output=True, id="all-equal"), Expect(input=[10, 10, 10, 7], output=True, id="smaller-boundary"), Expect(input=[10, 10, 10, 10], output=True, id="exact-multiple"), Expect(input=[10, 5, 10], output=False, id="middle-mismatch"), Expect(input=[10, 10, 10, 12], output=False, id="last-larger"), # The first chunk anchors the size; later mismatches in the middle fail # before the boundary check. Expect(input=[5, 10, 5], output=False, id="middle-larger"), ] @pytest.mark.parametrize("case", _REGULAR_1D_CASES, ids=lambda c: c.id) def test_is_regular_1d_sequence(case: Expect[list[int], bool]) -> None: """`is_regular_1d` accepts plain Python sequences and uses the iterative path.""" # list and tuple both go through the non-ndarray branch. assert is_regular_1d(case.input) is case.output assert is_regular_1d(tuple(case.input)) is case.output @pytest.mark.parametrize("case", _REGULAR_1D_CASES, ids=lambda c: c.id) def test_is_regular_1d_ndarray(case: Expect[list[int], bool]) -> None: """`is_regular_1d` accepts int64 ndarrays and uses the vectorized path.""" arr = np.asarray(case.input, dtype=np.int64) assert is_regular_1d(arr) is case.output @pytest.mark.parametrize( "case", [ Expect(input=[[10, 10, 10], [5, 5]], output=True, id="all-regular"), Expect(input=[[10, 10, 7], [5, 5, 5, 3]], output=True, id="all-regular-with-boundary"), Expect(input=[[10, 10, 10], [5, 8, 5]], output=False, id="second-dim-irregular"), Expect(input=[[10, 5, 10], [5, 5]], output=False, id="first-dim-irregular"), Expect(input=[], output=True, id="zero-dims"), ], ids=lambda c: c.id, ) def test_is_regular_nd_sequence(case: Expect[list[list[int]], bool]) -> None: """`is_regular_nd` returns True iff every per-dim spec is regular.""" assert is_regular_nd(case.input) is case.output # Same result via ndarray inputs. assert is_regular_nd([np.asarray(d, dtype=np.int64) for d in case.input]) is case.output # --------------------------------------------------------------------------- # Types # --------------------------------------------------------------------------- def test_array_metadata_keys_matches_typeddict() -> None: """ Test that the variable modelling the set of keys for array v3 metadata matches the keys of the typeddict model for the metadata. """ assert ARRAY_METADATA_KEYS == set(ArrayMetadataJSON_V3.__annotations__.keys()) # --------------------------------------------------------------------------- # ArrayV3Metadata: round-trip # --------------------------------------------------------------------------- # Codecs after evolution for single-byte (uint8) and multi-byte (float64) types. _UINT8_CODECS = ({"name": "bytes"},) _FLOAT64_CODECS = ({"name": "bytes", "configuration": {"endian": "little"}},) @pytest.mark.parametrize( "case", [ Expect( input={}, output=minimal_metadata_dict_v3(codecs=_UINT8_CODECS), id="minimal", ), Expect( input={"attributes": {"key": "value"}}, output=minimal_metadata_dict_v3(attributes={"key": "value"}, codecs=_UINT8_CODECS), id="with_attributes", ), Expect( input={"dimension_names": ("x", "y")}, output=minimal_metadata_dict_v3(dimension_names=("x", "y"), codecs=_UINT8_CODECS), id="with_dimension_names", ), Expect( input={"storage_transformers": ()}, output=minimal_metadata_dict_v3(storage_transformers=(), codecs=_UINT8_CODECS), id="with_storage_transformers", ), Expect( input={"data_type": "float64", "fill_value": 0.0}, output=minimal_metadata_dict_v3( data_type="float64", fill_value=0.0, codecs=_FLOAT64_CODECS ), id="float64", ), Expect( input={"chunk_key_encoding": {"name": "v2", "configuration": {"separator": "."}}}, output=minimal_metadata_dict_v3( chunk_key_encoding={"name": "v2", "configuration": {"separator": "."}}, codecs=_UINT8_CODECS, ), id="v2_chunk_key_encoding", ), Expect( input={"data_type": "float64", "fill_value": "NaN"}, output=minimal_metadata_dict_v3( data_type="float64", fill_value="NaN", codecs=_FLOAT64_CODECS ), id="nan_fill_value", ), Expect( input={"data_type": "float64", "fill_value": "Infinity"}, output=minimal_metadata_dict_v3( data_type="float64", fill_value="Infinity", codecs=_FLOAT64_CODECS ), id="inf_fill_value", ), Expect( input={"data_type": "float64", "fill_value": "-Infinity"}, output=minimal_metadata_dict_v3( data_type="float64", fill_value="-Infinity", codecs=_FLOAT64_CODECS ), id="neg_inf_fill_value", ), Expect( input={ "attributes": {}, "storage_transformers": (), "extra_fields": {"my_ext": {"must_understand": False, "data": [1, 2, 3]}}, }, output=minimal_metadata_dict_v3( attributes={}, storage_transformers=(), codecs=_UINT8_CODECS, extra_fields={"my_ext": {"must_understand": False, "data": [1, 2, 3]}}, ), id="extra_fields", ), ], ids=lambda case: case.id, ) def test_array_metadata_roundtrip(case: Expect[dict[str, Any], dict[str, Any]]) -> None: """from_dict(d).to_dict() produces the expected output, including codec evolution.""" d = minimal_metadata_dict_v3(**case.input) m = ArrayV3Metadata.from_dict(d) # type: ignore[arg-type] assert m.to_dict() == case.output # --------------------------------------------------------------------------- # ArrayV3Metadata: failure modes # --------------------------------------------------------------------------- @pytest.mark.parametrize( "case", [ ExpectFail( input={"dimension_names": ("x", "y", "z")}, exception=ValueError, msg="dimension_names.*shape", id="dimension_names_length_mismatch", ), ExpectFail( input={"data_type": "uint8", "fill_value": {}}, exception=TypeError, id="invalid_fill_value_type", ), ], ids=lambda case: case.id, ) def test_array_metadata_from_dict_fails(case: ExpectFail[dict[str, Any]]) -> None: """from_dict rejects invalid metadata documents.""" d = minimal_metadata_dict_v3(**case.input) with case.raises(): ArrayV3Metadata.from_dict(d) # type: ignore[arg-type] @pytest.mark.parametrize( "case", [ ExpectFail( input=minimal_metadata_dict_v3(extra_fields={"my_ext": {"must_understand": True}}), exception=MetadataValidationError, msg="disallowed extra fields", id="must_understand_true", ), ExpectFail( input=minimal_metadata_dict_v3(extra_fields={"my_ext": 42}), exception=MetadataValidationError, msg="disallowed extra fields", id="non_dict_extra_field", ), ], ids=lambda case: case.id, ) def test_array_metadata_extra_fields_rejected(case: ExpectFail[dict[str, Any]]) -> None: """from_dict rejects extra fields that don't conform to the spec.""" with case.raises(): ArrayV3Metadata.from_dict(case.input) def test_init_extra_fields_collision() -> None: """Extra field keys that collide with reserved metadata field names are rejected.""" extra_fields: dict[str, object] = {"shape": (10,), "data_type": "uint8"} with pytest.raises(ValueError, match="collide with keys reserved"): ArrayV3Metadata( shape=(10,), data_type=UInt8(), chunk_grid={"name": "regular", "configuration": {"chunk_shape": (10,)}}, chunk_key_encoding={"name": "default", "configuration": {"separator": "/"}}, fill_value=0, codecs=({"name": "bytes", "configuration": {"endian": "little"}},), attributes={}, dimension_names=None, extra_fields=extra_fields, # type: ignore[arg-type] ) # --------------------------------------------------------------------------- # Equality # --------------------------------------------------------------------------- def test_eq_nan_fill_value() -> None: """Two metadata objects with an identical NaN fill_value compare equal. NaN is not equal to itself under IEEE 754, so the default dataclass __eq__ reports two otherwise-identical metadata objects as unequal. Metadata equality must treat matching NaN fill values as equal (see issue #2929). """ a = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value="NaN")) # type: ignore[arg-type] b = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value="NaN")) # type: ignore[arg-type] assert a == b def test_eq_distinct_fill_value() -> None: """Metadata objects that differ only in fill_value do not compare equal.""" a = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value=0.0)) # type: ignore[arg-type] b = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value=1.0)) # type: ignore[arg-type] assert a != b @pytest.mark.parametrize("fill_value", ["Infinity", "-Infinity"]) def test_eq_inf_fill_value(fill_value: str) -> None: """Two metadata objects with an identical infinite fill_value compare equal.""" a = ArrayV3Metadata.from_dict( minimal_metadata_dict_v3(data_type="float64", fill_value=fill_value) # type: ignore[arg-type] ) b = ArrayV3Metadata.from_dict( minimal_metadata_dict_v3(data_type="float64", fill_value=fill_value) # type: ignore[arg-type] ) assert a == b def test_hash_consistent_with_eq_nan_fill_value() -> None: """Equal metadata objects with a NaN fill_value hash equal. NaN hashes by identity, so a field-based hash would break the ``a == b implies hash(a) == hash(b)`` invariant for objects that compare equal under the to_dict-based __eq__. """ a = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value="NaN")) # type: ignore[arg-type] b = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value="NaN")) # type: ignore[arg-type] assert a == b assert hash(a) == hash(b) def test_eq_non_metadata() -> None: """Comparison against a non-metadata object returns False rather than erroring.""" a = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value=0.0)) # type: ignore[arg-type] assert a != object() def test_eq_across_zarr_formats() -> None: """A v2 and v3 metadata describing the same array do not compare equal. Each __eq__ guards on its own concrete type and returns NotImplemented otherwise, so the two versions are never equal even when they describe the same array. """ v3 = ArrayV3Metadata.from_dict(minimal_metadata_dict_v3(data_type="float64", fill_value=0.0)) # type: ignore[arg-type] v2 = ArrayV2Metadata(shape=(4, 4), dtype=Float64(), chunks=(4, 4), fill_value=0.0, order="C") assert v2 != v3 assert v3 != v2 # --------------------------------------------------------------------------- # JSON indent # --------------------------------------------------------------------------- @pytest.mark.parametrize("indent", [2, 4, None]) def test_json_indent(indent: int | None) -> None: """The json_indent config setting controls indentation in to_buffer_dict output.""" with config.set({"json_indent": indent}): m = GroupMetadata() d = m.to_buffer_dict(default_buffer_prototype())["zarr.json"].to_bytes() assert d == json.dumps(json.loads(d), indent=indent).encode() # --------------------------------------------------------------------------- # GroupMetadata.to_dict # --------------------------------------------------------------------------- @pytest.mark.parametrize("attributes", [None, {"foo": "bar"}]) def test_group_metadata_to_dict(attributes: dict[str, Any] | None) -> None: """GroupMetadata.to_dict produces the expected v3 JSON structure.""" meta = GroupMetadata(attributes=attributes) assert meta.to_dict() == { "zarr_format": 3, "node_type": "group", "attributes": attributes or {}, } @pytest.mark.parametrize("attributes", [None, {"foo": "bar"}]) def test_group_metadata_to_dict_consolidated(attributes: dict[str, Any] | None) -> None: """GroupMetadata.to_dict includes consolidated_metadata when present.""" from zarr import consolidate_metadata, create_group from zarr.errors import ZarrUserWarning store: dict[str, object] = {} group = create_group(store, attributes=attributes, zarr_format=3) group.create_group("foo") with pytest.warns( ZarrUserWarning, match="Consolidated metadata is currently not part in the Zarr format 3 specification.", ): group = consolidate_metadata(store) assert group.metadata.to_dict() == { "zarr_format": 3, "node_type": "group", "attributes": attributes or {}, "consolidated_metadata": { "kind": "inline", "must_understand": False, "metadata": { "foo": { "attributes": {}, "zarr_format": 3, "node_type": "group", "consolidated_metadata": { "kind": "inline", "metadata": {}, "must_understand": False, }, } }, }, } zarr-python-3.3.0/tests/test_pipeline_parity.py000066400000000000000000000507421523267620000217750ustar00rootroot00000000000000"""Pipeline parity test — exhaustive matrix of read/write scenarios. For every cell of the matrix (codec config x layout x operation sequence x runtime config), assert that ``FusedCodecPipeline`` and ``BatchedCodecPipeline`` produce semantically identical results: * Same returned array contents on read. * Same set of store keys after writes (catches divergent empty-shard handling: one pipeline deletes, the other writes an empty blob). * Reading each pipeline's store contents through the *other* pipeline yields the same array (catches "wrote a layout that only one pipeline can read" bugs). Pipeline-divergence bugs (e.g. one pipeline writes a dense shard layout while the other writes a compact layout) fail this test loudly with a clear diff, instead of waiting for a downstream test to trip over the symptom. Byte-for-byte equality of store contents is intentionally NOT checked: codecs like gzip embed the wall-clock timestamp in their output, so two compressions of the same data done at different seconds produce different bytes despite being semantically identical. The matrix axes are: * codec chain — bytes-only, gzip, with/without sharding * layout — chunk_shape, shard_shape (None for no sharding) * write sequence — full overwrite, partial in middle, scalar to one cell, multiple overlapping writes, sequence ending in fill values * runtime config — write_empty_chunks True/False """ from __future__ import annotations import warnings from contextlib import contextmanager from typing import TYPE_CHECKING, Any import numpy as np import pytest import zarr from zarr.codecs.bytes import BytesCodec from zarr.codecs.crc32c_ import Crc32cCodec from zarr.codecs.gzip import GzipCodec from zarr.codecs.sharding import ( SUBCHUNK_WRITE_ORDER, IndexLocation, ShardingCodec, SubchunkWriteOrder, ) from zarr.codecs.transpose import TransposeCodec from zarr.core.config import config as zarr_config from zarr.errors import ZarrUserWarning from zarr.storage import MemoryStore if TYPE_CHECKING: from collections.abc import Callable, Iterator # --------------------------------------------------------------------------- # Reference helpers # --------------------------------------------------------------------------- def _store_snapshot(store: MemoryStore) -> dict[str, bytes]: """Return {key: bytes} for every entry in the store.""" return {k: bytes(v.to_bytes()) for k, v in store._store_dict.items()} # --------------------------------------------------------------------------- # Matrix definitions # --------------------------------------------------------------------------- # Each codec config is (filters, serializer, compressors). We only vary the # pieces that actually affect the pipeline. compressors=None means a # fixed-size chain (the byte-range fast path is eligible when sharded). CodecConfig = dict[str, Any] CODEC_CONFIGS: list[tuple[str, CodecConfig]] = [ ("bytes-only", {"compressors": None}), ("gzip", {"compressors": GzipCodec(level=1)}), # Big-endian serializer: the on-disk byte order is carried by the BytesCodec, # not the dtype. Guards the bulk whole-shard decode against ignoring endian # (it would otherwise reinterpret big-endian bytes as native — silent # corruption). dtype is int32 so endianness is observable. ( "bytes-big-endian", {"compressors": None, "serializer": BytesCodec(endian="big"), "dtype": "int32"}, ), # crc32c as a bytes->bytes codec after the serializer: the bulk fast path # must NOT silently drop checksum verification (it falls through to the # per-chunk path). Parity still requires identical bytes + contents across # pipelines. (crc32c is a BytesBytesCodec, so it goes in `compressors`.) ( "bytes-crc32c", {"compressors": [Crc32cCodec()], "serializer": BytesCodec(), "dtype": "int32"}, ), ] # (id, kwargs) — chunks/shards layout. kwargs are passed to create_array. LayoutConfig = dict[str, Any] LAYOUT_CONFIGS: list[tuple[str, LayoutConfig]] = [ ("1d-unsharded", {"shape": (100,), "chunks": (10,), "shards": None}), ("1d-1chunk-per-shard", {"shape": (100,), "chunks": (10,), "shards": (10,)}), ("1d-multi-chunk-per-shard", {"shape": (100,), "chunks": (10,), "shards": (50,)}), ("2d-unsharded", {"shape": (20, 20), "chunks": (5, 5), "shards": None}), ("2d-sharded", {"shape": (20, 20), "chunks": (5, 5), "shards": (10, 10)}), # Nested sharding: outer chunk (10,10) sharded into inner chunks (5,5). # Restricted to the codec configs that don't set their own `serializer` # (bytes-only, gzip): this layout supplies an explicit nested-ShardingCodec # `serializer`, and a codec config that also sets `serializer` (e.g. # bytes-big-endian) would silently clobber it via dict merge, dropping # sharding from the test entirely rather than exercising it. The gzip # config applies as an outer bytes-bytes codec around the outer # ShardingCodec -- this is the regression coverage for the fused pipeline # applying outer AA/BB codecs around sharding (see # `pipeline_supports_partial_decode`/`pipeline_supports_partial_encode`). ( "2d-nested-sharded", { "shape": (20, 20), "chunks": (10, 10), "shards": None, "serializer": ShardingCodec( chunk_shape=(10, 10), codecs=[ShardingCodec(chunk_shape=(5, 5))], ), "_codec_ids": {"bytes-only", "gzip"}, }, ), ] WriteOp = tuple[Any, Any] # (selection, value) WriteSequence = tuple[str, list[WriteOp]] def _full_overwrite(shape: tuple[int, ...]) -> list[WriteOp]: return [((slice(None),) * len(shape), np.arange(int(np.prod(shape))).reshape(shape) + 1)] def _partial_middle(shape: tuple[int, ...]) -> list[WriteOp]: if len(shape) == 1: n = shape[0] return [((slice(n // 4, 3 * n // 4),), 7)] # 2D: write a centered block rs = slice(shape[0] // 4, 3 * shape[0] // 4) cs = slice(shape[1] // 4, 3 * shape[1] // 4) return [((rs, cs), 7)] def _scalar_one_cell(shape: tuple[int, ...]) -> list[WriteOp]: if len(shape) == 1: return [((shape[0] // 2,), 99)] return [((shape[0] // 2, shape[1] // 2), 99)] def _overlapping(shape: tuple[int, ...]) -> list[WriteOp]: if len(shape) == 1: n = shape[0] return [ ((slice(0, n // 2),), 1), ((slice(n // 4, 3 * n // 4),), 2), ((slice(n // 2, n),), 3), ] rs1, cs1 = slice(0, shape[0] // 2), slice(0, shape[1] // 2) rs2, cs2 = slice(shape[0] // 4, 3 * shape[0] // 4), slice(shape[1] // 4, 3 * shape[1] // 4) return [((rs1, cs1), 1), ((rs2, cs2), 2)] def _ends_in_fill(shape: tuple[int, ...]) -> list[WriteOp]: """Write something then overwrite it with fill — exercises empty-chunk handling.""" full = (slice(None),) * len(shape) return [(full, 5), (full, 0)] def _ends_in_partial_fill(shape: tuple[int, ...]) -> list[WriteOp]: """Write data, then overwrite half with fill — some chunks become empty.""" full: tuple[slice, ...] half: tuple[slice, ...] if len(shape) == 1: full = (slice(None),) half = (slice(0, shape[0] // 2),) else: full = (slice(None), slice(None)) half = (slice(0, shape[0] // 2), slice(None)) return [(full, 5), (half, 0)] SEQUENCES: list[tuple[str, Callable[[tuple[int, ...]], list[WriteOp]]]] = [ ("full-overwrite", _full_overwrite), ("partial-middle", _partial_middle), ("scalar-one-cell", _scalar_one_cell), ("overlapping", _overlapping), ("ends-in-fill", _ends_in_fill), ("ends-in-partial-fill", _ends_in_partial_fill), ] WRITE_EMPTY_CHUNKS = [False, True] # --------------------------------------------------------------------------- # Matrix iteration (pruned) # --------------------------------------------------------------------------- def _matrix() -> Iterator[Any]: for codec_id, codec_kwargs in CODEC_CONFIGS: for layout_id, layout in LAYOUT_CONFIGS: allowed = layout.get("_codec_ids") if allowed is not None and codec_id not in allowed: continue for seq_id, seq_fn in SEQUENCES: for wec in WRITE_EMPTY_CHUNKS: yield pytest.param( codec_kwargs, layout, seq_fn, wec, id=f"{layout_id}-{codec_id}-{seq_id}-wec{wec}", ) # --------------------------------------------------------------------------- # The parity test # --------------------------------------------------------------------------- @contextmanager def _ignore_sharding_combo_warning() -> Iterator[None]: """Suppress the "combining sharding_indexed disables partial reads" warning. Only the nested-sharded-plus-outer-codec matrix cell emits this; scoping the ignore filter to just its message/category (rather than blanket-disabling warnings) keeps every other warning in the run promoted to an error as usual. """ with warnings.catch_warnings(): warnings.filterwarnings( "ignore", message=r"Combining a `sharding_indexed` codec.*", category=ZarrUserWarning, ) yield def _write_under_pipeline( pipeline_path: str, codec_kwargs: CodecConfig, layout: LayoutConfig, sequence: list[WriteOp], write_empty_chunks: bool, ) -> tuple[MemoryStore, Any]: """Apply a sequence of writes via the chosen pipeline. Returns (store with the written data, final array contents read back). """ # Strip private metadata keys (e.g. "_codec_ids") before passing to create_array. array_layout = {k: v for k, v in layout.items() if not k.startswith("_")} # dtype defaults to float64 but a codec config may override it (e.g. an # endian-sensitive int dtype). Merge so the override wins without a dup kwarg. create_kwargs = {"dtype": "float64", **array_layout, **codec_kwargs} store = MemoryStore() with zarr_config.set({"codec_pipeline.path": pipeline_path}): with _ignore_sharding_combo_warning(): arr = zarr.create_array( store=store, fill_value=0, config={"write_empty_chunks": write_empty_chunks}, **create_kwargs, ) for sel, val in sequence: arr[sel] = val contents = arr[...] return store, contents def _read_under_pipeline(pipeline_path: str, store: MemoryStore) -> Any: """Re-open an existing store under the chosen pipeline and read it whole.""" with zarr_config.set({"codec_pipeline.path": pipeline_path}): with _ignore_sharding_combo_warning(): arr = zarr.open_array(store=store, mode="r") return arr[...] _BATCHED = "zarr.core.codec_pipeline.BatchedCodecPipeline" _FUSED = "zarr.core.codec_pipeline.FusedCodecPipeline" @pytest.mark.parametrize( ("codec_kwargs", "layout", "sequence_fn", "write_empty_chunks"), list(_matrix()), ) def test_pipeline_parity( codec_kwargs: CodecConfig, layout: LayoutConfig, sequence_fn: Callable[[tuple[int, ...]], list[WriteOp]], write_empty_chunks: bool, ) -> None: """FusedCodecPipeline must be semantically identical to BatchedCodecPipeline. Three checks, in order of decreasing diagnostic value: 1. Both pipelines return the same array contents after the same write sequence (catches semantic correctness bugs). 2. Both pipelines produce the same set of store keys (catches empty-shard divergence: one deletes, the other doesn't). 3. Each pipeline can correctly read the *other* pipeline's output (catches layout-divergence bugs that would prevent interop, e.g. dense vs compact shard layouts). Byte-for-byte store equality is intentionally not checked: codecs like gzip embed wall-clock timestamps that vary between runs. """ sequence = sequence_fn(layout["shape"]) batched_store, batched_arr = _write_under_pipeline( _BATCHED, codec_kwargs, layout, sequence, write_empty_chunks ) sync_store, sync_arr = _write_under_pipeline( _FUSED, codec_kwargs, layout, sequence, write_empty_chunks ) # 1. Array contents must agree. np.testing.assert_array_equal( sync_arr, batched_arr, err_msg="FusedCodecPipeline returned different array contents than BatchedCodecPipeline", ) # 2. Store key sets must agree. batched_keys = set(batched_store._store_dict) - {"zarr.json"} sync_keys = set(sync_store._store_dict) - {"zarr.json"} assert sync_keys == batched_keys, ( f"Pipelines disagree on which store keys exist.\n" f" only in batched: {sorted(batched_keys - sync_keys)}\n" f" only in sync: {sorted(sync_keys - batched_keys)}" ) # 3. Cross-read: each pipeline must correctly read the other's output. sync_reads_batched = _read_under_pipeline(_FUSED, batched_store) batched_reads_sync = _read_under_pipeline(_BATCHED, sync_store) np.testing.assert_array_equal( sync_reads_batched, batched_arr, err_msg="FusedCodecPipeline could not correctly read BatchedCodecPipeline's output", ) np.testing.assert_array_equal( batched_reads_sync, sync_arr, err_msg="BatchedCodecPipeline could not correctly read FusedCodecPipeline's output", ) # --------------------------------------------------------------------------- # Partial-read parity across subchunk write orders # --------------------------------------------------------------------------- # # Note: general partial-read coverage (scalar single-element and strided reads # from sharded arrays, which hit the sharding codec's partial-decode path) lives # in tests/test_codec_pipeline_suite.py as Scenarios. Those run each pipeline # against a numpy reference -- strictly stronger than checking the two pipelines # only against each other, and they cover both the sync (_decode_partial_sync) # and async (_decode_partial_single) partial-decode variants. What remains here # is the cross-pipeline byte-identical-layout check, which the per-pipeline # suite structurally cannot express. @pytest.mark.parametrize("subchunk_write_order", SUBCHUNK_WRITE_ORDER) @pytest.mark.parametrize("index_location", ["start", "end"]) def test_pipeline_parity_subchunk_write_order( subchunk_write_order: SubchunkWriteOrder, index_location: IndexLocation ) -> None: """Both pipelines must agree across every subchunk_write_order, including a PARTIAL write into an already-dense fixed-size shard. This is the regression net for the byte-range write fast path, which derives each chunk's physical slot from its rank in subchunk_write_order. A wrong (e.g. hardcoded morton) assumption corrupts non-default orders silently, so we assert both identical contents AND identical stored bytes across pipelines. write_empty_chunks=True keeps every slot present, making the shard dense and the byte-range write path eligible. """ # 2D, fixed-size (no compression). The shard (array `chunks`) must hold # MULTIPLE inner chunks, and be non-square, so morton / lexicographic / # colexicographic produce physically DIFFERENT layouts — with one inner # chunk per shard all orders coincide and a wrong-order bug is invisible. # inner chunk = (2, 2); shard = (6, 4) -> a 3x2 grid of inner chunks. shape, shard_shape, inner_chunk = (12, 8), (6, 4), (2, 2) serializer = ShardingCodec( chunk_shape=inner_chunk, codecs=[BytesCodec()], index_location=index_location, subchunk_write_order=subchunk_write_order, ) ref = np.arange(int(np.prod(shape)), dtype="int32").reshape(shape) def run(pipeline_path: str) -> tuple[dict[str, bytes], Any]: store = MemoryStore() with zarr_config.set({"codec_pipeline.path": pipeline_path}): arr = zarr.create_array( store=store, shape=shape, chunks=shard_shape, # array "chunks" == shard size for a ShardingCodec serializer dtype="int32", fill_value=-1, serializer=serializer, compressors=None, config={"write_empty_chunks": True}, ) arr[:] = ref # dense full write arr[3:9, 1:6] = 777 # partial write INTO the dense shard contents = arr[...] return _store_snapshot(store), contents batched_bytes, batched_contents = run(_BATCHED) sync_bytes, sync_contents = run(_FUSED) # Contents must always match across pipelines and equal the reference — # this catches a wrong-order byte-range write (it corrupts the data). expected = ref.copy() expected[3:9, 1:6] = 777 np.testing.assert_array_equal(batched_contents, expected) np.testing.assert_array_equal( sync_contents, batched_contents, err_msg=f"pipeline contents diverged for subchunk_write_order={subchunk_write_order!r}", ) # The two pipelines must also produce byte-identical shards — a stronger # check that they agree on physical layout. This holds for EVERY order # (without special-casing any by name): both pipelines lay chunks out via # the same `_subchunk_order_iter`, so for a given codec instance they must # land on the same bytes whatever that order resolves to. We make no # assumption here about what any particular order "means" — only that the # two implementations agree. assert sync_bytes == batched_bytes, ( f"pipelines wrote different bytes for subchunk_write_order={subchunk_write_order!r} " f"(index_location={index_location!r}) — byte-range write fast path likely assumed " f"the wrong physical chunk order" ) # --------------------------------------------------------------------------- # Outer array-array / bytes-bytes codecs around a sharding serializer # --------------------------------------------------------------------------- # # Regression coverage for FusedCodecPipeline.supports_partial_decode/encode: # it used to allow AA/BB codecs outside the sharding codec, so its partial # branches called ShardingCodec._decode_partial_sync/_encode_partial_sync # directly on the raw stored value, skipping any outer filter/compressor. # That corrupted on-disk bytes for an outer bytes-bytes codec (unreadable by # the other pipeline) and silently produced wrong data for an outer # array-array codec. Both configs below force the partial branches: a # region write and a region read are included alongside the full ones. _OUTER_AA_BB_CONFIGS: list[tuple[str, CodecConfig]] = [ ( "outer-gzip-around-sharding", { "serializer": ShardingCodec(chunk_shape=(2, 2)), "compressors": [GzipCodec(level=1)], }, ), ( "outer-transpose-around-sharding", { "filters": [TransposeCodec(order=(1, 0))], "serializer": ShardingCodec(chunk_shape=(2, 2)), "compressors": None, }, ), ] @pytest.mark.parametrize(("config_id", "codec_kwargs"), _OUTER_AA_BB_CONFIGS) @pytest.mark.parametrize( ("writer", "reader"), [(_BATCHED, _FUSED), (_FUSED, _BATCHED)], ids=["batched-write-fused-read", "fused-write-batched-read"], ) def test_pipeline_parity_outer_aa_bb_codecs( config_id: str, codec_kwargs: CodecConfig, writer: str, reader: str, ) -> None: """Data written under one pipeline with outer AA/BB codecs must read back correctly under the other, including through a partial write and a partial read. """ shape = (8, 8) data = (np.arange(int(np.prod(shape))).reshape(shape) + 1).astype("uint16") store = MemoryStore() with zarr_config.set({"codec_pipeline.path": writer}): with _ignore_sharding_combo_warning(): arr = zarr.create_array( store=store, shape=shape, chunks=(4, 4), dtype=data.dtype, fill_value=0, **codec_kwargs, ) arr[...] = data arr[2:5, 1:3] = 99 # region write -- exercises the partial-encode branch expected = data.copy() expected[2:5, 1:3] = 99 with zarr_config.set({"codec_pipeline.path": reader}): with _ignore_sharding_combo_warning(): arr2 = zarr.open_array(store=store, mode="r") full = arr2[...] partial = arr2[1:3, 2:7] # region read -- exercises the partial-decode branch np.testing.assert_array_equal(full, expected) np.testing.assert_array_equal(partial, expected[1:3, 2:7]) zarr-python-3.3.0/tests/test_properties.py000066400000000000000000000415221523267620000207700ustar00rootroot00000000000000import itertools import json import numbers from collections.abc import Generator from typing import Any import numpy as np import pytest from numpy.testing import assert_array_equal import zarr from zarr.core.buffer import default_buffer_prototype pytest.importorskip("hypothesis") import hypothesis.extra.numpy as npst import hypothesis.strategies as st from hypothesis import assume, given, settings from zarr.abc.store import Store from zarr.core.common import ZARR_JSON, ZARRAY_JSON, ZATTRS_JSON from zarr.core.metadata import ArrayV2Metadata, ArrayV3Metadata from zarr.core.sync import sync from zarr.testing.strategies import ( array_metadata, arrays, basic_indices, block_indices, block_test_arrays, complex_rectilinear_arrays, numpy_arrays, orthogonal_indices, rectilinear_arrays, simple_arrays, stores, zarr_formats, ) @pytest.fixture(autouse=True) def _enable_rectilinear_chunks() -> Generator[None, None, None]: """Enable rectilinear chunks for all property tests since strategies may generate them.""" with zarr.config.set({"array.rectilinear_chunks": True}): yield def deep_equal(a: Any, b: Any) -> bool: """Deep equality check with handling of special cases for array metadata classes""" if isinstance(a, (complex, np.complexfloating)) and isinstance( b, (complex, np.complexfloating) ): a_real, a_imag = float(a.real), float(a.imag) b_real, b_imag = float(b.real), float(b.imag) if np.isnan(a_real) and np.isnan(b_real): real_eq = True else: real_eq = a_real == b_real if np.isnan(a_imag) and np.isnan(b_imag): imag_eq = True else: imag_eq = a_imag == b_imag return real_eq and imag_eq if isinstance(a, (float, np.floating)) and isinstance(b, (float, np.floating)): if np.isnan(a) and np.isnan(b): return True return a == b if isinstance(a, np.datetime64) and isinstance(b, np.datetime64): if np.isnat(a) and np.isnat(b): return True return a == b if isinstance(a, np.ndarray) and isinstance(b, np.ndarray): if a.shape != b.shape: return False return all(itertools.starmap(deep_equal, zip(a.flat, b.flat, strict=False))) if isinstance(a, dict) and isinstance(b, dict): if set(a.keys()) != set(b.keys()): return False return all(deep_equal(a[k], b[k]) for k in a) if isinstance(a, (list, tuple)) and isinstance(b, (list, tuple)): if len(a) != len(b): return False return all(itertools.starmap(deep_equal, zip(a, b, strict=False))) return a == b @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @given(data=st.data()) def test_array_roundtrip(data: st.DataObject) -> None: nparray = data.draw(numpy_arrays()) zarray = data.draw(arrays(arrays=st.just(nparray))) assert_array_equal(nparray, zarray[:]) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @given(array=arrays()) def test_array_creates_implicit_groups(array): path = array.path ancestry = path.split("/")[:-1] for i in range(len(ancestry)): parent = "/".join(ancestry[: i + 1]) if array.metadata.zarr_format == 2: assert ( sync(array.store.get(f"{parent}/.zgroup", prototype=default_buffer_prototype())) is not None ) elif array.metadata.zarr_format == 3: assert ( sync(array.store.get(f"{parent}/zarr.json", prototype=default_buffer_prototype())) is not None ) # this decorator removes timeout; not ideal but it should avoid intermittent CI failures @settings(deadline=None) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @given(data=st.data()) async def test_basic_indexing(data: st.DataObject) -> None: zarray = data.draw(st.one_of(simple_arrays(), rectilinear_arrays())) nparray = zarray[:] indexer = data.draw(basic_indices(shape=nparray.shape)) # sync get actual = zarray[indexer] assert_array_equal(nparray[indexer], actual) # async get async_zarray = zarray._async_array actual = await async_zarray.getitem(indexer) assert_array_equal(nparray[indexer], actual) # sync set new_data = data.draw(numpy_arrays(shapes=st.just(actual.shape), dtype=nparray.dtype)) zarray[indexer] = new_data nparray[indexer] = new_data assert_array_equal(nparray, zarray[:]) # TODO test async setitem? @settings(deadline=None) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @given(data=st.data()) async def test_basic_indexing_complex_rectilinear(data: st.DataObject) -> None: nparray, zarray = data.draw(complex_rectilinear_arrays()) indexer = data.draw(basic_indices(shape=nparray.shape)) assert_array_equal(nparray[indexer], zarray[indexer]) @given(data=st.data()) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") async def test_oindex(data: st.DataObject) -> None: # integer_array_indices can't handle 0-size dimensions. zarray = data.draw( st.one_of( simple_arrays(shapes=npst.array_shapes(max_dims=4, min_side=1)), rectilinear_arrays(shapes=npst.array_shapes(max_dims=4, min_side=1, max_side=20)), ) ) nparray = zarray[:] zindexer, npindexer = data.draw(orthogonal_indices(shape=nparray.shape)) # sync get actual = zarray.oindex[zindexer] assert_array_equal(nparray[npindexer], actual) # async get async_zarray = zarray._async_array actual = await async_zarray.oindex.getitem(zindexer) assert_array_equal(nparray[npindexer], actual) # sync get assume(zarray.shards is None) # GH2834 for idxr in npindexer: if isinstance(idxr, np.ndarray) and idxr.size != np.unique(idxr).size: # behaviour of setitem with repeated indices is not guaranteed in practice assume(False) new_data = data.draw(numpy_arrays(shapes=st.just(actual.shape), dtype=nparray.dtype)) nparray[npindexer] = new_data zarray.oindex[zindexer] = new_data assert_array_equal(nparray, zarray[:]) # note: async oindex setitem not yet implemented @given(data=st.data()) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") async def test_vindex(data: st.DataObject) -> None: # integer_array_indices can't handle 0-size dimensions. zarray = data.draw( st.one_of( simple_arrays(shapes=npst.array_shapes(max_dims=4, min_side=1)), rectilinear_arrays(shapes=npst.array_shapes(max_dims=3, min_side=1, max_side=20)), ) ) nparray = zarray[:] indexer = data.draw( npst.integer_array_indices( shape=nparray.shape, result_shape=npst.array_shapes(min_side=1, max_dims=None) ) ) # sync get actual = zarray.vindex[indexer] assert_array_equal(nparray[indexer], actual) # async get async_zarray = zarray._async_array actual = await async_zarray.vindex.getitem(indexer) assert_array_equal(nparray[indexer], actual) # sync set # FIXME! # when the indexer is such that a value gets overwritten multiple times, # I think the output depends on chunking. # new_data = data.draw(npst.arrays(shape=st.just(actual.shape), dtype=nparray.dtype)) # nparray[indexer] = new_data # zarray.vindex[indexer] = new_data # assert_array_equal(nparray, zarray[:]) # note: async vindex setitem not yet implemented @settings(deadline=None) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @given(data=st.data()) def test_mask_indexing(data: st.DataObject) -> None: zarray = data.draw(st.one_of(simple_arrays(), rectilinear_arrays())) nparray = zarray[:] mask = data.draw(npst.arrays(dtype=np.bool_, shape=st.just(nparray.shape))) expected = nparray[mask] # sync get, via both the dedicated method and the vindex interface assert_array_equal(expected, zarray.get_mask_selection(mask)) assert_array_equal(expected, zarray.vindex[mask]) # sync set, via both interfaces assume(zarray.shards is None) # GH2834 new_data = data.draw(numpy_arrays(shapes=st.just(expected.shape), dtype=nparray.dtype)) nparray[mask] = new_data zarray.set_mask_selection(mask, new_data) assert_array_equal(nparray, zarray[:]) zarray.vindex[mask] = new_data assert_array_equal(nparray, zarray[:]) @settings(deadline=None) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @given(data=st.data()) def test_block_indexing(data: st.DataObject) -> None: # Block indexing addresses whole inner chunks. block_indices() builds its # array-space oracle from cumulative chunk offsets, so it works for regular # (uniform), rectilinear, and sharded grids alike; block_test_arrays draws # across that matrix (rectilinear + sharded is unsupported and not drawn). zarray, nparray = data.draw(block_test_arrays()) block_indexer, array_indexer = data.draw(block_indices(chunk_sizes=zarray.write_chunk_sizes)) expected = nparray[array_indexer] # sync get, via both the .blocks interface and the dedicated method assert_array_equal(expected, zarray.blocks[block_indexer]) assert_array_equal(expected, zarray.get_block_selection(block_indexer)) # sync set, via both interfaces; sharded set is broken upstream (GH2834) assume(zarray.shards is None) new_data = data.draw(numpy_arrays(shapes=st.just(expected.shape), dtype=nparray.dtype)) nparray[array_indexer] = new_data zarray.blocks[block_indexer] = new_data assert_array_equal(nparray, zarray[:]) zarray.set_block_selection(block_indexer, new_data) assert_array_equal(nparray, zarray[:]) @given(store=stores, meta=array_metadata()) # type: ignore[misc] @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") async def test_roundtrip_array_metadata_from_store( store: Store, meta: ArrayV2Metadata | ArrayV3Metadata ) -> None: """ Verify that the I/O for metadata in a store are lossless. This test serializes an ArrayV2Metadata or ArrayV3Metadata object to a dict of buffers via `to_buffer_dict`, writes each buffer to a store under keys prefixed with "0/", and then reads them back. The test asserts that each retrieved buffer exactly matches the original buffer. """ asdict = meta.to_buffer_dict(prototype=default_buffer_prototype()) for key, expected in asdict.items(): await store.set(f"0/{key}", expected) actual = await store.get(f"0/{key}", prototype=default_buffer_prototype()) assert actual == expected @given(data=st.data(), zarr_format=zarr_formats) @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_roundtrip_array_metadata_from_json(data: st.DataObject, zarr_format: int) -> None: """ Verify that JSON serialization and deserialization of metadata is lossless. For Zarr v2: - The metadata is split into two JSON documents (one for array data and one for attributes). The test merges the attributes back before deserialization. For Zarr v3: - All metadata is stored in a single JSON document. No manual merger is necessary. The test then converts both the original and round-tripped metadata objects into dictionaries using `dataclasses.asdict` and uses a deep equality check to verify that the roundtrip has preserved all fields (including special cases like NaN, Infinity, complex numbers, and datetime values). """ metadata = data.draw(array_metadata(zarr_formats=st.just(zarr_format))) buffer_dict = metadata.to_buffer_dict(prototype=default_buffer_prototype()) if zarr_format == 2: zarray_dict = json.loads(buffer_dict[ZARRAY_JSON].to_bytes().decode()) zattrs_dict = json.loads(buffer_dict[ZATTRS_JSON].to_bytes().decode()) # zattrs and zarray are separate in v2, we have to add attributes back prior to `from_dict` zarray_dict["attributes"] = zattrs_dict metadata_roundtripped = ArrayV2Metadata.from_dict(zarray_dict) else: zarray_dict = json.loads(buffer_dict[ZARR_JSON].to_bytes().decode()) metadata_roundtripped = ArrayV3Metadata.from_dict(zarray_dict) orig = metadata.to_dict() rt = metadata_roundtripped.to_dict() assert deep_equal(orig, rt), f"Roundtrip mismatch:\nOriginal: {orig}\nRoundtripped: {rt}" # @st.composite # def advanced_indices(draw, *, shape): # basic_idxr = draw( # basic_indices( # shape=shape, min_dims=len(shape), max_dims=len(shape), allow_ellipsis=False # ).filter(lambda x: isinstance(x, tuple)) # ) # int_idxr = draw( # npst.integer_array_indices(shape=shape, result_shape=npst.array_shapes(max_dims=1)) # ) # args = tuple( # st.sampled_from((l, r)) for l, r in zip_longest(basic_idxr, int_idxr, fillvalue=slice(None)) # ) # return draw(st.tuples(*args)) # @given(st.data()) # def test_roundtrip_object_array(data): # nparray = data.draw(np_arrays) # zarray = data.draw(arrays(arrays=st.just(nparray))) # assert_array_equal(nparray, zarray[:]) def serialized_complex_float_is_valid( serialized: tuple[numbers.Real | str, numbers.Real | str], ) -> bool: """ Validate that the serialized representation of a complex float conforms to the spec. The specification requires that a serialized complex float must be either: - A JSON number, or - One of the strings "NaN", "Infinity", or "-Infinity". Args: serialized: The value produced by JSON serialization for a complex floating point number. Returns: bool: True if the serialized value is valid according to the spec, False otherwise. """ return ( isinstance(serialized, tuple) and len(serialized) == 2 and all(serialized_float_is_valid(x) for x in serialized) ) def serialized_float_is_valid(serialized: numbers.Real | str) -> bool: """ Validate that the serialized representation of a float conforms to the spec. The specification requires that a serialized float must be either: - A JSON number, or - One of the strings "NaN", "Infinity", or "-Infinity". Args: serialized: The value produced by JSON serialization for a floating point number. Returns: bool: True if the serialized value is valid according to the spec, False otherwise. """ if isinstance(serialized, numbers.Real): return True return serialized in ("NaN", "Infinity", "-Infinity") @given(meta=array_metadata()) # type: ignore[misc] @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_array_metadata_meets_spec(meta: ArrayV2Metadata | ArrayV3Metadata) -> None: """ Validate that the array metadata produced by the library conforms to the relevant spec (V2 vs V3). For ArrayV2Metadata: - Ensures that 'zarr_format' is 2. - Verifies that 'filters' is either None or a tuple (and not an empty tuple). For ArrayV3Metadata: - Ensures that 'zarr_format' is 3. For both versions: - If the dtype is a floating point of some kind, verifies of fill values: * NaN is serialized as the string "NaN" * Positive Infinity is serialized as the string "Infinity" * Negative Infinity is serialized as the string "-Infinity" * Other fill values are preserved as-is. - If the dtype is a complex number of some kind, verifies that each component of the fill value (real and imaginary) satisfies the serialization rules for floating point numbers. - If the dtype is a datetime of some kind, verifies that `NaT` values are serialized as "NaT". Note: This test validates spec-compliance for array metadata serialization. It is a work-in-progress and should be expanded as further edge cases are identified. """ asdict_dict = meta.to_dict() # version-specific validations if isinstance(meta, ArrayV2Metadata): assert asdict_dict["filters"] != () assert asdict_dict["filters"] is None or isinstance(asdict_dict["filters"], tuple) assert asdict_dict["zarr_format"] == 2 else: assert asdict_dict["zarr_format"] == 3 # version-agnostic validations dtype_native = meta.dtype.to_native_dtype() if dtype_native.kind == "f": assert serialized_float_is_valid(asdict_dict["fill_value"]) elif dtype_native.kind == "c": # fill_value should be a two-element array [real, imag]. assert serialized_complex_float_is_valid(asdict_dict["fill_value"]) elif dtype_native.kind in ("M", "m") and np.isnat(meta.fill_value): assert asdict_dict["fill_value"] == -9223372036854775808 zarr-python-3.3.0/tests/test_regression/000077500000000000000000000000001523267620000203765ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_regression/__init__.py000066400000000000000000000000001523267620000224750ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_regression/scripts/000077500000000000000000000000001523267620000220655ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_regression/scripts/__init__.py000066400000000000000000000000001523267620000241640ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_regression/scripts/v2.18.py000066400000000000000000000047361523267620000232270ustar00rootroot00000000000000# /// script # requires-python = ">=3.12" # dependencies = [ # "zarr==2.18", # "numcodecs==0.15" # ] # /// import argparse import zarr from zarr._storage.store import BaseStore def copy_group( *, node: zarr.hierarchy.Group, store: zarr.storage.BaseStore, path: str, overwrite: bool ) -> zarr.hierarchy.Group: result = zarr.group(store=store, path=path, overwrite=overwrite) result.attrs.put(node.attrs.asdict()) for key, child in node.items(): child_path = f"{path}/{key}" if isinstance(child, zarr.hierarchy.Group): copy_group(node=child, store=store, path=child_path, overwrite=overwrite) elif isinstance(child, zarr.core.Array): copy_array(node=child, store=store, overwrite=overwrite, path=child_path) return result def copy_array( *, node: zarr.core.Array, store: BaseStore, path: str, overwrite: bool ) -> zarr.core.Array: result = zarr.create( shape=node.shape, dtype=node.dtype, fill_value=node.fill_value, chunks=node.chunks, compressor=node.compressor, filters=node.filters, order=node.order, dimension_separator=node._dimension_separator, store=store, path=path, overwrite=overwrite, ) result.attrs.put(node.attrs.asdict()) result[:] = node[:] return result def copy_node( node: zarr.hierarchy.Group | zarr.core.Array, store: BaseStore, path: str, overwrite: bool ) -> zarr.hierarchy.Group | zarr.core.Array: if isinstance(node, zarr.hierarchy.Group): return copy_group(node=node, store=store, path=path, overwrite=overwrite) elif isinstance(node, zarr.core.Array): return copy_array(node=node, store=store, path=path, overwrite=overwrite) else: raise TypeError(f"Unexpected node type: {type(node)}") # pragma: no cover def cli() -> None: parser = argparse.ArgumentParser( description="Copy a zarr hierarchy from one location to another" ) parser.add_argument("source", type=str, help="Path to the source zarr hierarchy") parser.add_argument("destination", type=str, help="Path to the destination zarr hierarchy") args = parser.parse_args() src, dst = args.source, args.destination root_src = zarr.open(src, mode="r") result = copy_node(node=root_src, store=zarr.NestedDirectoryStore(dst), path="", overwrite=True) print(f"successfully created {result} at {dst}") def main() -> None: cli() if __name__ == "__main__": main() zarr-python-3.3.0/tests/test_regression/scripts/v3.0.8.py000066400000000000000000000036361523267620000233030ustar00rootroot00000000000000# /// script # requires-python = "==3.12" # dependencies = [ # "zarr==3.0.8", # "numcodecs==0.16.3" # ] # /// import argparse import zarr from zarr.abc.store import Store def copy_group( *, node: zarr.Group, store: Store, path: str, overwrite: bool ) -> zarr.Group: result = zarr.create_group( store=store, path=path, overwrite=overwrite, attributes=node.attrs.asdict(), zarr_format=node.metadata.zarr_format) for key, child in node.members(): child_path = f"{path}/{key}" if isinstance(child, zarr.Group): copy_group(node=child, store=store, path=child_path, overwrite=overwrite) else: copy_array(node=child, store=store, overwrite=overwrite, path=child_path) return result def copy_array( *, node: zarr.Array, store: Store, path: str, overwrite: bool ) -> zarr.Array: result = zarr.from_array(store, name=path, data=node, write_data=True) return result def copy_node( node: zarr.Group | zarr.Array, store: Store, path: str, overwrite: bool ) -> zarr.Group | zarr.Array: if isinstance(node, zarr.Group): return copy_group(node=node, store=store, path=path, overwrite=overwrite) else: return copy_array(node=node, store=store, path=path, overwrite=overwrite) def cli() -> None: parser = argparse.ArgumentParser( description="Copy a zarr hierarchy from one location to another" ) parser.add_argument("source", type=str, help="Path to the source zarr hierarchy") parser.add_argument("destination", type=str, help="Path to the destination zarr hierarchy") args = parser.parse_args() src, dst = args.source, args.destination root_src = zarr.open(src, mode="r") result = copy_node(node=root_src, store=dst, path="", overwrite=True) print(f"successfully created {result} at {dst}") def main() -> None: cli() if __name__ == "__main__": main() zarr-python-3.3.0/tests/test_regression/test_v2_dtype_regression.py000066400000000000000000000203771523267620000260140ustar00rootroot00000000000000import subprocess import sys from dataclasses import dataclass from itertools import product from pathlib import Path from typing import TYPE_CHECKING, Literal import numpy as np import pytest from numcodecs import LZ4, LZMA, Blosc, GZip, VLenBytes, VLenUTF8, Zstd import zarr import zarr.abc import zarr.abc.codec import zarr.codecs as zarrcodecs from zarr.abc.numcodec import Numcodec from zarr.core.chunk_key_encodings import V2ChunkKeyEncoding from zarr.core.dtype.npy.bytes import VariableLengthBytes from zarr.core.dtype.npy.string import VariableLengthUTF8 from zarr.storage import LocalStore from zarr.types import ArrayV2, ArrayV3 if TYPE_CHECKING: from zarr.core.dtype import ZDTypeLike ZarrPythonVersion = Literal["2.18", "3.0.8"] def runner_installed() -> bool: """ Check if a PEP-723 compliant python script runner is installed. """ try: subprocess.check_output(["uv", "--version"]) return True # noqa: TRY300 except FileNotFoundError: return False @dataclass(kw_only=True) class ArrayParams: values: np.ndarray[tuple[int], np.dtype[np.generic]] fill_value: np.generic | str | int | bytes filters: tuple[Numcodec, ...] = () serializer: str | None = None compressor: Numcodec basic_codecs: tuple[Numcodec, ...] = GZip(), Blosc(), LZ4(), LZMA(), Zstd() basic_dtypes = "|b", ">i2", ">i4", ">f4", ">f8", "c8", "c16", "M8[10us]", "m8[4ps]" string_dtypes = "U4" bytes_dtypes = ">S1", "V10", " ArrayV2: """ Writes a zarr array to a temporary directory based on the provided ArrayParams. The array is returned. """ dest = tmp_path / "in" store = LocalStore(dest) array_params: ArrayParams = request.param compressor = array_params.compressor chunk_key_encoding = V2ChunkKeyEncoding(separator="/") dtype: ZDTypeLike if array_params.values.dtype == np.dtype("|O") and array_params.serializer == "vlen-utf8": dtype = VariableLengthUTF8() # type: ignore[assignment] filters = array_params.filters + (VLenUTF8(),) elif array_params.values.dtype == np.dtype("|O") and array_params.serializer == "vlen-bytes": dtype = VariableLengthBytes() filters = array_params.filters + (VLenBytes(),) else: dtype = array_params.values.dtype filters = array_params.filters z = zarr.create_array( store, shape=array_params.values.shape, dtype=dtype, chunks=array_params.values.shape, compressors=compressor, filters=filters, fill_value=array_params.fill_value, order="C", chunk_key_encoding=chunk_key_encoding, write_data=True, zarr_format=2, ) z[:] = array_params.values return z @pytest.fixture def source_array_v3(tmp_path: Path, request: pytest.FixtureRequest) -> ArrayV3: """ Writes a zarr array to a temporary directory based on the provided ArrayParams. The array is returned. """ dest = tmp_path / "in" store = LocalStore(dest) array_params: ArrayParams = request.param chunk_key_encoding = V2ChunkKeyEncoding(separator="/") dtype: ZDTypeLike serializer: Literal["auto"] | zarr.abc.codec.Codec if array_params.values.dtype == np.dtype("|O") and array_params.serializer == "vlen-utf8": dtype = VariableLengthUTF8() # type: ignore[assignment] serializer = zarrcodecs.VLenUTF8Codec() elif array_params.values.dtype == np.dtype("|O") and array_params.serializer == "vlen-bytes": dtype = VariableLengthBytes() serializer = zarrcodecs.VLenBytesCodec() else: dtype = array_params.values.dtype serializer = "auto" if array_params.compressor == GZip(): compressor = zarrcodecs.GzipCodec() else: msg = ( "This test is only compatible with gzip compression at the moment, because the author" "did not want to implement a complete abstraction layer for v2 and v3 codecs in this test." ) raise ValueError(msg) z = zarr.create_array( store, shape=array_params.values.shape, dtype=dtype, chunks=array_params.values.shape, compressors=compressor, filters=array_params.filters, serializer=serializer, fill_value=array_params.fill_value, chunk_key_encoding=chunk_key_encoding, write_data=True, zarr_format=3, ) z[:] = array_params.values return z # TODO: make this dynamic based on the installed scripts script_paths = [Path(__file__).resolve().parent / "scripts" / "v2.18.py"] @pytest.mark.skipif( sys.platform == "darwin" and sys.version_info >= (3, 14), reason="Numcodecs pinned to 0.15 does not build on newer macos installations with newer python versions: see discussion https://github.com/zarr-developers/zarr-python/pull/3564#issuecomment-4081145034", ) @pytest.mark.skipif(not runner_installed(), reason="no python script runner installed") @pytest.mark.parametrize( "source_array_v2", array_cases_v2_18, indirect=True, ids=tuple(map(str, array_cases_v2_18)) ) @pytest.mark.parametrize("script_path", script_paths) def test_roundtrip_v2(source_array_v2: ArrayV2, tmp_path: Path, script_path: Path) -> None: out_path = tmp_path / "out" copy_op = subprocess.run( [ "uv", "run", str(script_path), str(source_array_v2.store).removeprefix("file://"), str(out_path), ], capture_output=True, text=True, ) assert copy_op.returncode == 0, f"stdout {copy_op.stdout}\n stderr{copy_op.stderr}" out_array = zarr.open_array(store=out_path, mode="r", zarr_format=2) assert source_array_v2.metadata.to_dict() == out_array.metadata.to_dict() assert np.array_equal(source_array_v2[:], out_array[:]) @pytest.mark.skipif(not runner_installed(), reason="no python script runner installed") @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") @pytest.mark.parametrize( "source_array_v3", array_cases_v3_08, indirect=True, ids=tuple(map(str, array_cases_v3_08)) ) def test_roundtrip_v3(source_array_v3: ArrayV3, tmp_path: Path) -> None: script_path = Path(__file__).resolve().parent / "scripts" / "v3.0.8.py" out_path = tmp_path / "out" copy_op = subprocess.run( [ "uv", "run", str(script_path), str(source_array_v3.store).removeprefix("file://"), str(out_path), ], capture_output=True, text=True, ) assert copy_op.returncode == 0 out_array = zarr.open_array(store=out_path, mode="r", zarr_format=3) assert source_array_v3.metadata.to_dict() == out_array.metadata.to_dict() assert np.array_equal(source_array_v3[:], out_array[:]) zarr-python-3.3.0/tests/test_store/000077500000000000000000000000001523267620000173525ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_store/__init__.py000066400000000000000000000000001523267620000214510ustar00rootroot00000000000000zarr-python-3.3.0/tests/test_store/test_core.py000066400000000000000000000330131523267620000217130ustar00rootroot00000000000000import tempfile from collections.abc import Awaitable, Callable, Generator from pathlib import Path from typing import Any, Literal import pytest import zarr from zarr import Group from zarr.core.buffer import cpu from zarr.core.common import ZARR_JSON, AccessModeLiteral, ZarrFormat from zarr.storage import FsspecStore, LocalStore, MemoryStore, StoreLike, StorePath, ZipStore from zarr.storage._common import ( _contains_node_v3, contains_array, contains_group, make_store_path, ) from zarr.storage._utils import ( _join_paths, _normalize_path_keys, _normalize_paths, _relativize_path, normalize_path, ) # contains_array and contains_group share this signature. _ContainsFunc = Callable[[StorePath, ZarrFormat], Awaitable[bool]] @pytest.fixture( params=["none", "temp_dir_str", "temp_dir_path", "store_path", "memory_store", "dict"] ) def store_like( request: pytest.FixtureRequest, ) -> Generator[None | str | Path | StorePath | MemoryStore | dict[Any, Any], None, None]: if request.param == "none": yield None elif request.param == "temp_dir_str": with tempfile.TemporaryDirectory() as temp_dir: yield temp_dir elif request.param == "temp_dir_path": with tempfile.TemporaryDirectory() as temp_dir: yield Path(temp_dir) elif request.param == "store_path": yield StorePath(store=MemoryStore(store_dict={}), path="/") elif request.param == "memory_store": yield MemoryStore(store_dict={}) elif request.param == "dict": yield {} @pytest.mark.parametrize("path", ["foo", "foo/bar"]) @pytest.mark.parametrize("write_group", [True, False]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_contains_group( local_store: LocalStore, path: str, write_group: bool, zarr_format: ZarrFormat ) -> None: """ Test that the contains_group method correctly reports the existence of a group. """ root = Group.from_store(store=local_store, zarr_format=zarr_format) if write_group: root.create_group(path) store_path = StorePath(local_store, path=path) assert await contains_group(store_path, zarr_format=zarr_format) == write_group @pytest.mark.parametrize("path", ["foo", "foo/bar"]) @pytest.mark.parametrize("write_array", [True, False]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_contains_array( local_store: LocalStore, path: str, write_array: bool, zarr_format: ZarrFormat ) -> None: """ Test that the contains array method correctly reports the existence of an array. """ root = Group.from_store(store=local_store, zarr_format=zarr_format) if write_array: root.create_array(path, shape=(100,), chunks=(10,), dtype="i4") store_path = StorePath(local_store, path=path) assert await contains_array(store_path, zarr_format=zarr_format) == write_array @pytest.mark.parametrize("func", [contains_array, contains_group]) async def test_contains_invalid_format_raises(local_store: LocalStore, func: _ContainsFunc) -> None: """ Test contains_group and contains_array raise errors for invalid zarr_formats """ store_path = StorePath(local_store) with pytest.raises(ValueError, match="Invalid zarr_format provided. Got 3.0, expected 2 or 3"): assert await func(store_path, "3.0") # type: ignore[arg-type] async def _write_zarr_json(store_path: StorePath, data: bytes) -> None: """Write raw bytes to the v3 metadata key under `store_path`.""" await (store_path / ZARR_JSON).set(cpu.Buffer.from_bytes(data)) @pytest.mark.parametrize("func", [contains_array, contains_group]) async def test_contains_malformed_json_returns_false( local_store: LocalStore, func: _ContainsFunc ) -> None: """A v3 metadata document that is not valid JSON reads as 'not present'.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b"{not valid json") assert await func(store_path, 3) is False @pytest.mark.parametrize("func", [contains_array, contains_group]) async def test_contains_non_object_json_returns_false( local_store: LocalStore, func: _ContainsFunc ) -> None: """A v3 metadata document that is valid JSON but not an object reads as 'not present'.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b"[1, 2, 3]") assert await func(store_path, 3) is False @pytest.mark.parametrize("func", [contains_array, contains_group]) async def test_contains_missing_node_type_returns_false( local_store: LocalStore, func: _ContainsFunc ) -> None: """A v3 metadata document with no 'node_type' key reads as 'not present'.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b'{"zarr_format": 3}') assert await func(store_path, 3) is False @pytest.mark.parametrize("func", [contains_array, contains_group]) async def test_contains_non_utf8_bytes_returns_false( local_store: LocalStore, func: _ContainsFunc ) -> None: """A v3 metadata document that is not valid UTF-8 reads as 'not present' (not an error).""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b"\x80\x81\x82\x83") assert await func(store_path, 3) is False async def test_contains_node_v3_malformed_json_returns_nothing(local_store: LocalStore) -> None: """`_contains_node_v3` returns 'nothing' when the document is not valid JSON.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b"{not valid json") assert await _contains_node_v3(store_path) == "nothing" async def test_contains_node_v3_non_object_json_returns_nothing(local_store: LocalStore) -> None: """`_contains_node_v3` returns 'nothing' when the document is not a JSON object.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b"[1, 2, 3]") assert await _contains_node_v3(store_path) == "nothing" async def test_contains_node_v3_missing_node_type_returns_nothing(local_store: LocalStore) -> None: """`_contains_node_v3` returns 'nothing' when the document lacks a 'node_type' key.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b'{"zarr_format": 3}') assert await _contains_node_v3(store_path) == "nothing" async def test_contains_node_v3_non_utf8_bytes_returns_nothing(local_store: LocalStore) -> None: """`_contains_node_v3` returns 'nothing' when the document is not valid UTF-8.""" store_path = StorePath(local_store, path="foo") await _write_zarr_json(store_path, b"\x80\x81\x82\x83") assert await _contains_node_v3(store_path) == "nothing" @pytest.mark.parametrize("path", [None, "", "bar"]) async def test_make_store_path_none(path: str) -> None: """ Test that creating a store_path with None creates a memorystore """ store_path = await make_store_path(None, path=path) assert isinstance(store_path.store, MemoryStore) assert store_path.path == normalize_path(path) @pytest.mark.parametrize("path", [None, "", "bar"]) @pytest.mark.parametrize("store_type", [str, Path]) @pytest.mark.parametrize("mode", ["r", "w"]) async def test_make_store_path_local( tmp_path: Path, store_type: type[str] | type[Path] | type[LocalStore], path: str, mode: AccessModeLiteral, ) -> None: """ Test the various ways of invoking make_store_path that create a LocalStore """ store_like = store_type(str(tmp_path)) store_path = await make_store_path(store_like, path=path, mode=mode) assert isinstance(store_path.store, LocalStore) assert Path(store_path.store.root) == Path(tmp_path) assert store_path.path == normalize_path(path) assert store_path.read_only == (mode == "r") @pytest.mark.parametrize("path", [None, "", "bar"]) @pytest.mark.parametrize("mode", ["r", "w"]) async def test_make_store_path_store_path( tmp_path: Path, path: str, mode: AccessModeLiteral ) -> None: """ Test invoking make_store_path when the input is another store_path. In particular we want to ensure that a new path is handled correctly. """ ro = mode == "r" store_like = await StorePath.open( LocalStore(str(tmp_path), read_only=ro), path="root", mode=mode ) store_path = await make_store_path(store_like, path=path, mode=mode) assert isinstance(store_path.store, LocalStore) assert Path(store_path.store.root) == tmp_path path_normalized = normalize_path(path) assert store_path.path == (store_like / path_normalized).path assert store_path.read_only == ro @pytest.mark.parametrize("modes", [(True, "w"), (False, "x")]) async def test_store_path_invalid_mode_raises( tmp_path: Path, modes: tuple[bool, Literal["w", "x"]] ) -> None: """ Test that ValueErrors are raise for invalid mode. """ with pytest.raises(ValueError): await StorePath.open(LocalStore(str(tmp_path), read_only=modes[0]), path="", mode=modes[1]) # type: ignore[arg-type] async def test_make_store_path_invalid() -> None: """ Test that invalid types raise TypeError """ with pytest.raises(TypeError, match="Unsupported type for store_like: 'int'"): await make_store_path(1) async def test_make_store_path_fsspec() -> None: pytest.importorskip("fsspec") pytest.importorskip("requests") pytest.importorskip("aiohttp") store_path = await make_store_path("http://foo.com/bar") assert isinstance(store_path.store, FsspecStore) async def test_make_store_path_storage_options_raises(store_like: StoreLike) -> None: with pytest.raises(TypeError, match="storage_options"): await make_store_path(store_like, storage_options={"foo": "bar"}) async def test_unsupported() -> None: with pytest.raises(TypeError, match="Unsupported type for store_like: 'int'"): await make_store_path(1) @pytest.mark.parametrize( "path", [ "/foo/bar", "//foo/bar", "foo///bar", "foo/bar///", Path("foo/bar"), b"foo/bar", ], ) def test_normalize_path_valid(path: str | bytes | Path) -> None: assert normalize_path(path) == "foo/bar" def test_normalize_path_upath() -> None: upath = pytest.importorskip("upath") assert normalize_path(upath.UPath("foo/bar", protocol="memory")) == "memory:/foo/bar" def test_normalize_path_none() -> None: assert normalize_path(None) == "" @pytest.mark.parametrize("path", [".", ".."]) def test_normalize_path_invalid(path: str) -> None: with pytest.raises(ValueError, match="is invalid because its string representation contains"): normalize_path(path) @pytest.mark.parametrize("paths", [("", "foo"), ("foo", "bar")]) def test_join_paths(paths: tuple[str, str]) -> None: """ Test that _join_paths joins paths in a way that is robust to an empty string """ observed = _join_paths(paths) if paths[0] == "": assert observed == paths[1] else: assert observed == "/".join(paths) class TestNormalizePaths: @staticmethod def test_valid() -> None: """ Test that path normalization works as expected """ paths = ["a", "b", "c", "d", "", "//a///b//"] assert _normalize_paths(paths) == tuple(normalize_path(p) for p in paths) @staticmethod @pytest.mark.parametrize("paths", [("", "/"), ("///a", "a")]) def test_invalid(paths: tuple[str, str]) -> None: """ Test that name collisions after normalization raise a ``ValueError`` """ msg = ( f"After normalization, the value '{paths[1]}' collides with '{paths[0]}'. " f"Both '{paths[1]}' and '{paths[0]}' normalize to the same value: '{normalize_path(paths[0])}'. " f"You should use either '{paths[1]}' or '{paths[0]}', but not both." ) with pytest.raises(ValueError, match=msg): _normalize_paths(paths) def test_normalize_path_keys() -> None: """ Test that ``_normalize_path_keys`` just applies the normalize_path function to each key of its input """ data = {"a": 10, "//b": 10} assert _normalize_path_keys(data) == {normalize_path(k): v for k, v in data.items()} @pytest.mark.parametrize( ("path", "prefix", "expected"), [ ("a", "", "a"), ("a/b/c", "a/b", "c"), ("a/b/c", "a", "b/c"), ], ) def test_relativize_path_valid(path: str, prefix: str, expected: str) -> None: """ Test the normal behavior of the _relativize_path function. Prefixes should be removed from the path argument. """ assert _relativize_path(path=path, prefix=prefix) == expected def test_relativize_path_invalid() -> None: path = "a/b/c" prefix = "b" msg = f"The first component of {path} does not start with {prefix}." with pytest.raises(ValueError, match=msg): _relativize_path(path="a/b/c", prefix="b") def test_different_open_mode(tmp_path: Path) -> None: # Test with a store that implements .with_read_only() store = MemoryStore() zarr.create((100,), store=store, zarr_format=2, path="a") arr = zarr.open_array(store=store, path="a", zarr_format=2, mode="r") assert arr.store.read_only # Test with a store that doesn't implement .with_read_only() zarr_path = tmp_path / "foo.zarr" zip_store = ZipStore(zarr_path, mode="w") zarr.create((100,), store=zip_store, zarr_format=2, path="a") with pytest.raises( ValueError, match="Store is not read-only but mode is 'r'. Unable to create a read-only copy of the store. Please use a read-only store or a storage class that implements .with_read_only().", ): zarr.open_array(store=zip_store, path="a", zarr_format=2, mode="r") zarr-python-3.3.0/tests/test_store/test_fsspec.py000066400000000000000000000607701523267620000222600ustar00rootroot00000000000000from __future__ import annotations import json import re from typing import TYPE_CHECKING, Any import numpy as np import pytest from packaging.version import parse as parse_version import zarr.api.asynchronous from zarr import Array from zarr.abc.store import OffsetByteRequest from zarr.core.buffer import Buffer, cpu, default_buffer_prototype from zarr.core.sync import _collect_aiterator, sync from zarr.errors import ZarrUserWarning from zarr.storage import FsspecStore from zarr.storage._common import make_store from zarr.storage._fsspec import _make_async from zarr.testing.store import StoreTests if TYPE_CHECKING: import pathlib from collections.abc import Generator from pathlib import Path import botocore.client import s3fs from zarr.core.common import JSON # Warning filter due to https://github.com/boto/boto3/issues/3889 pytestmark = [ pytest.mark.filterwarnings( re.escape("ignore:datetime.datetime.utcnow() is deprecated:DeprecationWarning") ), # FsspecStore.from_url() and from_mapper() now close the aiohttp session on store.close(). # This filter covers stores that are GC'd without an explicit close() call, and any # residual sessions from aiobotocore's ClientCreatorContext (a separate upstream issue). pytest.mark.filterwarnings("ignore:Unclosed client session:ResourceWarning"), pytest.mark.filterwarnings( "ignore:coroutine 'ClientCreatorContext.__aexit__' was never awaited:RuntimeWarning" ), # s3fs finalizers can fail when sessions are garbage collected without being entered pytest.mark.filterwarnings( "ignore:Exception ignored in.*finalize object.*:pytest.PytestUnraisableExceptionWarning" ), ] fsspec = pytest.importorskip("fsspec") s3fs = pytest.importorskip("s3fs") requests = pytest.importorskip("requests") # Skip this module entirely when moto is absent; the server itself comes from the shared # `moto_server` fixture in tests/conftest.py. pytest.importorskip("moto") botocore = pytest.importorskip("botocore") # ### amended from s3fs ### # test_bucket_name = "test" secure_bucket_name = "test-secure" @pytest.fixture def endpoint_url(moto_server: str) -> str: """Endpoint of the shared session-scoped moto server (see tests/conftest.py). A fixture rather than a module-level constant because the server binds an ephemeral port, so the endpoint is only known once the server is running.""" return moto_server def get_boto3_client(endpoint_url: str) -> botocore.client.BaseClient: # NB: we use the sync botocore client for setup session = botocore.session.Session() # Prevent IllegalLocationConstraintException by explicitly setting region to # "us-east-1", which does not require configuring LocationConstraint during # bucket creation. (It is, in fact, forbidden for that region.) Necessary # in the face of "ambient" AWS configuration in a development environment # where the default region might be configured differently. return session.create_client("s3", endpoint_url=endpoint_url, region_name="us-east-1") @pytest.fixture(autouse=True) def s3(endpoint_url: str) -> Generator[s3fs.S3FileSystem, None, None]: """ Quoting Martin Durant: pytest-asyncio creates a new event loop for each async test. When an async-mode s3fs instance is made from async, it will be assigned to the loop from which it is made. That means that if you use s3fs again from a subsequent test, you will have the same identical instance, but be running on a different loop - which fails. For the rest: it's very convenient to clean up the state of the store between tests, make sure we start off blank each time. https://github.com/zarr-developers/zarr-python/pull/1785#discussion_r1634856207 """ client = get_boto3_client(endpoint_url) client.create_bucket(Bucket=test_bucket_name, ACL="public-read") s3fs.S3FileSystem.clear_instance_cache() s3 = s3fs.S3FileSystem( anon=False, client_kwargs={"endpoint_url": endpoint_url}, # Prevent "AssertionError: Session was never entered" from aiobotocore # at end of test execution. Using clear_instance_cache is insufficient, # although still necessary. skip_instance_cache=True, ) session = sync(s3.set_session()) s3.invalidate_cache() yield s3 requests.post(f"{endpoint_url}/moto-api/reset") client.close() sync(session.close()) # ### end from s3fs ### # async def test_basic(endpoint_url: str) -> None: store = FsspecStore.from_url( f"s3://{test_bucket_name}/foo/spam/", storage_options={"endpoint_url": endpoint_url, "anon": False}, ) assert store.fs.asynchronous assert store.path == f"{test_bucket_name}/foo/spam" assert await _collect_aiterator(store.list()) == () assert not await store.exists("foo") data = b"hello" await store.set("foo", cpu.Buffer.from_bytes(data)) assert await store.exists("foo") buf = await store.get("foo", prototype=default_buffer_prototype()) assert buf is not None assert buf.to_bytes() == data out = await store.get_partial_values( prototype=default_buffer_prototype(), key_ranges=[("foo", OffsetByteRequest(1))] ) assert out[0] is not None assert out[0].to_bytes() == data[1:] class TestFsspecStoreS3(StoreTests[FsspecStore, cpu.Buffer]): store_cls = FsspecStore buffer_cls = cpu.Buffer @pytest.fixture def store_kwargs(self, endpoint_url: str) -> dict[str, str | bool]: try: from fsspec import url_to_fs except ImportError: # before fsspec==2024.3.1 from fsspec.core import url_to_fs fs, path = url_to_fs( f"s3://{test_bucket_name}", endpoint_url=endpoint_url, anon=False, asynchronous=True ) return {"fs": fs, "path": path} @pytest.fixture async def store(self, store_kwargs: dict[str, Any]) -> FsspecStore: return self.store_cls(**store_kwargs) async def get(self, store: FsspecStore, key: str) -> Buffer: # make a new, synchronous instance of the filesystem because this test is run in sync code new_fs = fsspec.filesystem( "s3", endpoint_url=store.fs.endpoint_url, anon=store.fs.anon, asynchronous=False ) return self.buffer_cls.from_bytes(new_fs.cat(f"{store.path}/{key}")) async def set(self, store: FsspecStore, key: str, value: Buffer) -> None: # make a new, synchronous instance of the filesystem because this test is run in sync code new_fs = fsspec.filesystem( "s3", endpoint_url=store.fs.endpoint_url, anon=store.fs.anon, asynchronous=False ) new_fs.write_bytes(f"{store.path}/{key}", value.to_bytes()) def test_store_repr(self, store: FsspecStore) -> None: assert str(store) == "" def test_store_supports_writes(self, store: FsspecStore) -> None: assert store.supports_writes def test_store_supports_listing(self, store: FsspecStore) -> None: assert store.supports_listing async def test_fsspec_store_from_uri(self, store: FsspecStore, endpoint_url: str) -> None: storage_options = { "endpoint_url": endpoint_url, "anon": False, } meta: dict[str, JSON] = { "attributes": {"key": "value"}, "zarr_format": 3, "node_type": "group", } await store.set( "zarr.json", self.buffer_cls.from_bytes(json.dumps(meta).encode()), ) group = await zarr.api.asynchronous.open_group( store=f"s3://{test_bucket_name}", storage_options=storage_options ) assert dict(group.attrs) == {"key": "value"} meta = { "attributes": {"key": "value-2"}, "zarr_format": 3, "node_type": "group", } await store.set( "directory-2/zarr.json", self.buffer_cls.from_bytes(json.dumps(meta).encode()), ) group = await zarr.api.asynchronous.open_group( store=f"s3://{test_bucket_name}/directory-2", storage_options=storage_options ) assert dict(group.attrs) == {"key": "value-2"} meta = { "attributes": {"key": "value-3"}, "zarr_format": 3, "node_type": "group", } await store.set( "directory-3/zarr.json", self.buffer_cls.from_bytes(json.dumps(meta).encode()), ) group = await zarr.api.asynchronous.open_group( store=f"s3://{test_bucket_name}", path="directory-3", storage_options=storage_options ) assert dict(group.attrs) == {"key": "value-3"} @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.03.01"), reason="Prior bug in from_upath", ) def test_from_upath(self, endpoint_url: str) -> None: upath = pytest.importorskip("upath") path = upath.UPath( f"s3://{test_bucket_name}/foo/bar/", endpoint_url=endpoint_url, anon=False, asynchronous=True, ) result = FsspecStore.from_upath(path) assert result.fs.endpoint_url == endpoint_url assert result.fs.asynchronous assert result.path == f"{test_bucket_name}/foo/bar" def test_init_warns_if_fs_asynchronous_is_false(self, endpoint_url: str) -> None: try: from fsspec import url_to_fs except ImportError: # before fsspec==2024.3.1 from fsspec.core import url_to_fs fs, path = url_to_fs( f"s3://{test_bucket_name}", endpoint_url=endpoint_url, anon=False, asynchronous=False ) store_kwargs = {"fs": fs, "path": path} with pytest.warns(ZarrUserWarning, match=r".* was not created with `asynchronous=True`.*"): self.store_cls(**store_kwargs) async def test_empty_nonexistent_path(self, store_kwargs: dict[str, Any]) -> None: # regression test for https://github.com/zarr-developers/zarr-python/pull/2343 store_kwargs["path"] += "/abc" store = await self.store_cls.open(**store_kwargs) assert await store.is_empty("") async def test_delete_dir_unsupported_deletes(self, store: FsspecStore) -> None: store.supports_deletes = False with pytest.raises( NotImplementedError, match="This method is only available for stores that support deletes.", ): await store.delete_dir("test_prefix") # ── Filesystem lifecycle ────────────────────────────────────────────────── async def test_close_marks_store_closed(self, endpoint_url: str) -> None: """close() must succeed and mark the store not-open.""" store = FsspecStore.from_url( f"s3://{test_bucket_name}/lifecycle/", storage_options={"endpoint_url": endpoint_url, "anon": False}, ) await store.set("probe", cpu.Buffer.from_bytes(b"x")) store.close() assert not store._is_open def array_roundtrip(store: FsspecStore) -> None: """ Round trip an array using a Zarr store Args: store: FsspecStore """ data = np.ones((3, 3)) arr = zarr.create_array(store=store, overwrite=True, data=data) assert isinstance(arr, Array) # Read set values arr2 = zarr.open_array(store=store) assert isinstance(arr2, Array) np.testing.assert_array_equal(arr[:], data) @pytest.mark.parametrize( ("root", "key", "expected"), [ # `"/"` as root collapses so that bare-key backends (notably # ReferenceFileSystem) get the right key. Regression test for # https://github.com/zarr-developers/zarr-python/issues/3922 . ("/", "zarr.json", "zarr.json"), ("", "zarr.json", "zarr.json"), # Trailing slashes on the root are stripped before joining. ("foo/", "zarr.json", "foo/zarr.json"), ("foo", "zarr.json", "foo/zarr.json"), # Leading slashes on the root are preserved -- absolute filesystem # paths must stay absolute. Regression test for the titiler-xarray # breakage that #3924 introduced when `normalize_path` was applied to # `FsspecStore.path`. ("/home/runner/data.zarr", "zarr.json", "/home/runner/data.zarr/zarr.json"), ("/home/runner/data.zarr/", "zarr.json", "/home/runner/data.zarr/zarr.json"), # Multi-segment keys. ("/home/foo", "a/b/zarr.json", "/home/foo/a/b/zarr.json"), ("", "a/b/zarr.json", "a/b/zarr.json"), # Trailing slash on the result is stripped (relevant when key is ""). ("/home/foo", "", "/home/foo"), ], ) def test_dereference_path(root: str, key: str, expected: str) -> None: """Verify the contract `_dereference_path` provides for `FsspecStore`. `FsspecStore.path` is stored verbatim; the join with a key must collapse a sentinel `"/"` root, strip trailing slashes, and preserve leading slashes on absolute paths. """ from zarr.storage._utils import _dereference_path assert _dereference_path(root, key) == expected async def test_fsspec_store_open_group_via_reference_filesystem() -> None: """End-to-end regression test for https://github.com/zarr-developers/zarr-python/issues/3922 . ``ReferenceFileSystem`` keys its refs by bare strings like ``"zarr.json"``. The bug was that ``FsspecStore(fs=ref_fs, path="/")`` produced ``"//zarr.json"`` at the join site and failed to find the entry, raising ``GroupNotFoundError``. This test pins ``path="/"`` explicitly to keep coverage even if the default value changes later. """ import json from fsspec.implementations.reference import ReferenceFileSystem group_json = json.dumps({"zarr_format": 3, "node_type": "group", "attributes": {}}) fs = ReferenceFileSystem( fo={"version": 1, "refs": {"zarr.json": group_json}}, asynchronous=True, ) store = FsspecStore(fs=fs, path="/", read_only=True) group = await zarr.api.asynchronous.open_group(store, mode="r") assert group.metadata.zarr_format == 3 async def test_fsspec_store_read_array_chunk_via_reference_filesystem() -> None: """End-to-end regression test that exercises the byte-range read path against ``ReferenceFileSystem``. Beyond opening a group (covered by ``test_fsspec_store_open_group_via_reference_filesystem``), this test constructs a small zarr v3 array whose chunk lives in the refs dict and reads it through the store. Path-handling bugs on the byte-range fetch path (used by kerchunk-style virtualization) would surface here rather than at metadata-open time. """ import json import numpy as np from fsspec.implementations.reference import ReferenceFileSystem # Construct a minimal v3 zarr: a single 1-D uint8 array of length 4 with # one chunk of size 4. The chunk bytes are little-endian uint8s 1..4. array_meta = json.dumps( { "zarr_format": 3, "node_type": "array", "shape": [4], "chunk_grid": {"name": "regular", "configuration": {"chunk_shape": [4]}}, "data_type": "uint8", "chunk_key_encoding": {"name": "default", "configuration": {"separator": "/"}}, "fill_value": 0, "codecs": [{"name": "bytes", "configuration": {"endian": "little"}}], "attributes": {}, } ) chunk_bytes = bytes([1, 2, 3, 4]) refs: dict[str, str] = { "zarr.json": array_meta, # ReferenceFileSystem accepts raw bytes via base64 encoding or # latin-1-decoded strings; latin-1 round-trips bytes 1:1. "c/0": chunk_bytes.decode("latin-1"), } fs = ReferenceFileSystem( fo={"version": 1, "refs": refs}, asynchronous=True, ) store = FsspecStore(fs=fs, path="/", read_only=True) array = await zarr.api.asynchronous.open_array(store=store, mode="r") data = await array.getitem(slice(None)) np.testing.assert_array_equal(data, np.array([1, 2, 3, 4], dtype="uint8")) @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_wrap_sync_filesystem(tmp_path: pathlib.Path) -> None: """The local fs is not async so we should expect it to be wrapped automatically""" from fsspec.implementations.asyn_wrapper import AsyncFileSystemWrapper store = FsspecStore.from_url(f"file://{tmp_path}", storage_options={"auto_mkdir": True}) assert isinstance(store.fs, AsyncFileSystemWrapper) assert store.fs.async_impl array_roundtrip(store) @pytest.mark.skipif( parse_version(fsspec.__version__) >= parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_wrap_sync_filesystem_raises(tmp_path: pathlib.Path) -> None: """The local fs is not async so we should expect it to be wrapped automatically""" with pytest.raises(ImportError, match="The filesystem .*"): FsspecStore.from_url(f"file://{tmp_path}", storage_options={"auto_mkdir": True}) @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_no_wrap_async_filesystem(endpoint_url: str) -> None: """An async fs should not be wrapped automatically; fsspec's s3 filesystem is such an fs""" from fsspec.implementations.asyn_wrapper import AsyncFileSystemWrapper store = FsspecStore.from_url( f"s3://{test_bucket_name}/foo/spam/", storage_options={"endpoint_url": endpoint_url, "anon": False, "asynchronous": True}, read_only=False, ) assert not isinstance(store.fs, AsyncFileSystemWrapper) assert store.fs.async_impl array_roundtrip(store) @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_open_fsmap_file(tmp_path: pathlib.Path) -> None: min_fsspec_with_async_wrapper = parse_version("2024.12.0") current_version = parse_version(fsspec.__version__) fs = fsspec.filesystem("file", auto_mkdir=True) mapper = fs.get_mapper(tmp_path) if current_version < min_fsspec_with_async_wrapper: # Expect ImportError for older versions with pytest.raises( ImportError, match=r"The filesystem .* is synchronous, and the required AsyncFileSystemWrapper is not available.*", ): array_roundtrip(mapper) else: # Newer versions should work array_roundtrip(mapper) @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_open_fsmap_file_raises(tmp_path: pathlib.Path) -> None: fsspec = pytest.importorskip("fsspec.implementations.local") fs = fsspec.LocalFileSystem(auto_mkdir=False) mapper = fs.get_mapper(tmp_path) with pytest.raises(FileNotFoundError, match="No such file or directory: .*"): array_roundtrip(mapper) @pytest.mark.parametrize("asynchronous", [True, False]) def test_open_fsmap_s3(asynchronous: bool, endpoint_url: str) -> None: s3_filesystem = s3fs.S3FileSystem( asynchronous=asynchronous, endpoint_url=endpoint_url, anon=False ) mapper = s3_filesystem.get_mapper(f"s3://{test_bucket_name}/map/foo/") array_roundtrip(mapper) def test_open_s3map_raises(endpoint_url: str) -> None: with pytest.raises(TypeError, match="Unsupported type for store_like:.*"): zarr.open(store=0, mode="w", shape=(3, 3)) s3_filesystem = s3fs.S3FileSystem(asynchronous=True, endpoint_url=endpoint_url, anon=False) mapper = s3_filesystem.get_mapper(f"s3://{test_bucket_name}/map/foo/") with pytest.raises( ValueError, match="'path' was provided but is not used for FSMap store_like objects" ): zarr.open(store=mapper, path="bar", mode="w", shape=(3, 3)) with pytest.raises( TypeError, match="'storage_options' is only used when the store is passed as an FSSpec URI string.", ): zarr.open(store=mapper, storage_options={"anon": True}, mode="w", shape=(3, 3)) async def test_close_does_not_close_filesystem_session() -> None: """close() must not touch the filesystem's session. fsspec caches and shares filesystem instances across callers, so the session is not the store's to close. HTTP is used because its aiohttp session is observably closed for good; s3fs transparently reconnects, which would hide a regression. No request is issued — set_session() only constructs the session. """ pytest.importorskip("aiohttp") store = FsspecStore.from_url("http://example.com/a") session = await store.fs.set_session() store.close() assert not session.closed async def test_close_does_not_break_a_sibling_store() -> None: """Closing one store must not close a session another store is using. Two stores from different URLs on one host are handed the same cached filesystem; a store that closed it on close() would take the sibling's session down too. This is the regression guard for that bug. """ pytest.importorskip("aiohttp") s1 = FsspecStore.from_url("http://example.com/a") s2 = FsspecStore.from_url("http://example.com/b") session = await s2.fs.set_session() s1.close() assert not session.closed @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_from_mapper_wraps_sync_filesystem(tmp_path: pathlib.Path) -> None: """from_mapper() with a sync fs wraps it in an AsyncFileSystemWrapper.""" import fsspec as _fsspec from fsspec.implementations.asyn_wrapper import AsyncFileSystemWrapper fs = _fsspec.filesystem("file", auto_mkdir=True) mapper = fs.get_mapper(str(tmp_path)) store = FsspecStore.from_mapper(mapper) assert isinstance(store.fs, AsyncFileSystemWrapper) @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) def test_with_read_only_shares_filesystem(tmp_path: pathlib.Path) -> None: """with_read_only() returns a store sharing the source's filesystem.""" source = FsspecStore.from_url(f"file://{tmp_path}", storage_options={"auto_mkdir": False}) derived = source.with_read_only(read_only=True) assert derived.fs is source.fs assert derived.read_only assert not source.read_only @pytest.mark.parametrize("asynchronous", [True, False]) def test_make_async(asynchronous: bool, endpoint_url: str) -> None: s3_filesystem = s3fs.S3FileSystem( asynchronous=asynchronous, endpoint_url=endpoint_url, anon=False ) fs = _make_async(s3_filesystem) assert fs.asynchronous @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) async def test_delete_dir_wrapped_filesystem(tmp_path: Path) -> None: from fsspec.implementations.asyn_wrapper import AsyncFileSystemWrapper from fsspec.implementations.local import LocalFileSystem wrapped_fs = AsyncFileSystemWrapper(LocalFileSystem(auto_mkdir=True)) store = FsspecStore(wrapped_fs, read_only=False, path=f"{tmp_path}/test/path") assert isinstance(store.fs, AsyncFileSystemWrapper) assert store.fs.asynchronous await store.set("zarr.json", cpu.Buffer.from_bytes(b"root")) await store.set("foo-bar/zarr.json", cpu.Buffer.from_bytes(b"root")) await store.set("foo/zarr.json", cpu.Buffer.from_bytes(b"bar")) await store.set("foo/c/0", cpu.Buffer.from_bytes(b"chunk")) await store.delete_dir("foo") assert await store.exists("zarr.json") assert await store.exists("foo-bar/zarr.json") assert not await store.exists("foo/zarr.json") assert not await store.exists("foo/c/0") @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) async def test_with_read_only_auto_mkdir(tmp_path: Path) -> None: """ Test that creating a read-only copy of a store backed by the local file system does not error if auto_mkdir is False. """ store_w = FsspecStore.from_url(f"file://{tmp_path}", storage_options={"auto_mkdir": False}) _ = store_w.with_read_only() @pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) async def test_memory_scheme() -> None: """Test that the "memory" scheme creates a `MemoryFileSystem`-backed store""" store = await make_store("memory://test") assert isinstance(store, FsspecStore) assert store.fs.protocol == "memory" zarr-python-3.3.0/tests/test_store/test_fsspec_get_ranges.py000066400000000000000000000105411523267620000244450ustar00rootroot00000000000000# tests/test_store/test_fsspec_get_ranges.py """Lightweight integration tests for FsspecStore.get_ranges using MemoryFileSystem. These don't need moto/s3 — they exercise the new method against an in-process fsspec MemoryFileSystem wrapped in the async wrapper. """ from __future__ import annotations import pytest from packaging.version import parse as parse_version from zarr.abc.store import RangeByteRequest from zarr.core.buffer import Buffer, default_buffer_prototype from zarr.storage import FsspecStore from zarr.storage._fsspec import _make_async fsspec = pytest.importorskip("fsspec") # AsyncFileSystemWrapper (needed to wrap a sync MemoryFileSystem) landed in fsspec 2024.12.0. # Older versions are pinned by the min-deps CI job, so skip the whole file there. pytestmark = pytest.mark.skipif( parse_version(fsspec.__version__) < parse_version("2024.12.0"), reason="No AsyncFileSystemWrapper", ) @pytest.fixture def memory_store() -> FsspecStore: """An FsspecStore backed by fsspec MemoryFileSystem (wrapped async).""" from fsspec.implementations.memory import MemoryFileSystem # Each test gets a clean filesystem; MemoryFileSystem is a singleton per target_options, # so clear state explicitly. fs: MemoryFileSystem = MemoryFileSystem() fs.store.clear() fs.pseudo_dirs.clear() async_fs = _make_async(fs) return FsspecStore(fs=async_fs, path="/root") async def _write(store: FsspecStore, key: str, data: bytes) -> None: buf = default_buffer_prototype().buffer.from_bytes(data) await store.set(key, buf) async def test_get_ranges_happy_path(memory_store: FsspecStore) -> None: blob = bytes(i % 256 for i in range(1024)) await _write(memory_store, "blob", blob) proto = default_buffer_prototype() ranges = [ RangeByteRequest(0, 10), RangeByteRequest(100, 110), RangeByteRequest(500, 520), ] groups: list[list[tuple[int, Buffer | None]]] = [ list(group) async for group in memory_store.get_ranges("blob", ranges, prototype=proto) ] flat: dict[int, bytes] = {} for group in groups: for idx, buf in group: assert buf is not None flat[idx] = buf.to_bytes() assert flat[0] == blob[0:10] assert flat[1] == blob[100:110] assert flat[2] == blob[500:520] async def test_get_ranges_missing_key_raises(memory_store: FsspecStore) -> None: """A request against a missing key raises BaseExceptionGroup containing FileNotFoundError.""" proto = default_buffer_prototype() agen = memory_store.get_ranges("does-not-exist", [RangeByteRequest(0, 10)], prototype=proto) with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): await anext(agen) async def test_get_ranges_forwards_coalescing_kwargs(memory_store: FsspecStore) -> None: """`max_gap_bytes=-1` forces no merging; we should see three groups for three ranges.""" blob = bytes(i % 256 for i in range(1024)) await _write(memory_store, "blob", blob) proto = default_buffer_prototype() ranges = [ RangeByteRequest(0, 10), RangeByteRequest(11, 20), # adjacent: would merge under defaults RangeByteRequest(21, 30), ] groups: list[list[tuple[int, Buffer | None]]] = [ list(group) async for group in memory_store.get_ranges( "blob", ranges, prototype=proto, max_gap_bytes=-1 ) ] # With merging disabled, every range becomes its own one-tuple group. assert sorted(len(g) for g in groups) == [1, 1, 1] async def test_get_ranges_mixed_range_types(memory_store: FsspecStore) -> None: """Covers RangeByteRequest, OffsetByteRequest, SuffixByteRequest, and None in one call.""" from zarr.abc.store import ByteRequest, OffsetByteRequest, SuffixByteRequest blob = bytes(i % 256 for i in range(512)) await _write(memory_store, "mixed", blob) proto = default_buffer_prototype() ranges: list[ByteRequest | None] = [ RangeByteRequest(0, 10), OffsetByteRequest(500), SuffixByteRequest(12), None, ] flat: dict[int, bytes] = {} async for group in memory_store.get_ranges("mixed", ranges, prototype=proto): for idx, buf in group: assert buf is not None flat[idx] = buf.to_bytes() assert flat[0] == blob[0:10] assert flat[1] == blob[500:] assert flat[2] == blob[-12:] assert flat[3] == blob zarr-python-3.3.0/tests/test_store/test_get_ranges.py000066400000000000000000000152441523267620000231070ustar00rootroot00000000000000# tests/test_store/test_get_ranges.py """Tests for `Store.get_ranges` — the ABC default implementation and wrapper delegation. `Store.get_ranges` is defined on the ABC with a default implementation built on `coalesced_get(self.get, ...)`, so every store inherits a working version. These tests cover that inherited path and the explicit delegation in `WrapperStore` (which ensures wrapped stores' optimized overrides are honored). Store-specific overrides (e.g. `FsspecStore`) have their own test modules. """ from __future__ import annotations from typing import TYPE_CHECKING import pytest from zarr.abc.store import RangeByteRequest from zarr.core.buffer import default_buffer_prototype from zarr.storage import MemoryStore, ZipStore from zarr.storage._wrapper import WrapperStore if TYPE_CHECKING: from collections.abc import AsyncIterator, Sequence from pathlib import Path from zarr.abc.store import ByteRequest from zarr.core.buffer import Buffer, BufferPrototype async def _write(store: MemoryStore, key: str, data: bytes) -> None: buf = default_buffer_prototype().buffer.from_bytes(data) await store.set(key, buf) async def test_memory_store_inherits_get_ranges_from_abc() -> None: """MemoryStore doesn't override `get_ranges`; the ABC default must work end-to-end.""" store = MemoryStore() blob = bytes(i % 256 for i in range(512)) await _write(store, "blob", blob) ranges = [RangeByteRequest(0, 10), RangeByteRequest(100, 110)] proto = default_buffer_prototype() flat: dict[int, bytes] = {} async for group in store.get_ranges("blob", ranges, prototype=proto): for idx, buf in group: assert buf is not None flat[idx] = buf.to_bytes() assert flat[0] == blob[0:10] assert flat[1] == blob[100:110] async def test_memory_store_get_ranges_missing_key_raises() -> None: """A missing key on a default-impl store raises BaseExceptionGroup containing FileNotFoundError.""" store = MemoryStore() proto = default_buffer_prototype() agen = store.get_ranges("does-not-exist", [RangeByteRequest(0, 10)], prototype=proto) with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): await anext(agen) def test_get_ranges_sync_reads_multiple_ranges() -> None: """The synchronous `get_ranges_sync` on a sync-capable store returns each requested range, mirroring the async `get_ranges` happy path.""" import asyncio store = MemoryStore() blob = bytes(i % 256 for i in range(512)) asyncio.run(_write(store, "blob", blob)) ranges = [RangeByteRequest(0, 10), RangeByteRequest(100, 110)] proto = default_buffer_prototype() flat: dict[int, bytes] = {} for idx, buf in store.get_ranges_sync("blob", ranges, prototype=proto): assert buf is not None flat[idx] = buf.to_bytes() assert flat[0] == blob[0:10] assert flat[1] == blob[100:110] def test_get_ranges_sync_missing_key_raises() -> None: """A missing key makes `get_ranges_sync` raise a BaseExceptionGroup containing FileNotFoundError — the same contract as async `get_ranges`, so callers handle a deleted shard uniformly across sync and async paths.""" store = MemoryStore() proto = default_buffer_prototype() with pytest.RaisesGroup(pytest.RaisesExc(FileNotFoundError)): store.get_ranges_sync("does-not-exist", [RangeByteRequest(0, 10)], prototype=proto) def test_get_ranges_sync_on_non_sync_store_raises_type_error(tmp_path: Path) -> None: """`get_ranges_sync` requires the store to support synchronous reads (`SupportsGetSync`); a non-sync store raises TypeError rather than silently falling back.""" store = ZipStore(tmp_path / "store.zip", mode="w") proto = default_buffer_prototype() with pytest.raises(TypeError, match="does not support synchronous reads"): store.get_ranges_sync("k", [RangeByteRequest(0, 10)], prototype=proto) async def test_wrapper_store_delegates_get_ranges() -> None: """WrapperStore.get_ranges must delegate to the wrapped store, not fall back to the default.""" class CountingMemoryStore(MemoryStore): """Tallies get_ranges invocations so we can assert delegation.""" get_ranges_calls: int = 0 async def get_ranges( self, key: str, byte_ranges: Sequence[ByteRequest | None], *, prototype: BufferPrototype, max_concurrency: int = 10, max_gap_bytes: int = 1 << 20, max_coalesced_bytes: int = 16 << 20, ) -> AsyncIterator[Sequence[tuple[int, Buffer | None]]]: type(self).get_ranges_calls += 1 async for group in super().get_ranges( key, byte_ranges, prototype=prototype, max_concurrency=max_concurrency, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ): yield group inner = CountingMemoryStore() blob = b"x" * 100 await _write(inner, "k", blob) wrapped = WrapperStore(inner) proto = default_buffer_prototype() groups: list[list[tuple[int, Buffer | None]]] = [ list(group) async for group in wrapped.get_ranges("k", [RangeByteRequest(0, 5)], prototype=proto) ] assert CountingMemoryStore.get_ranges_calls == 1 assert len(groups) == 1 assert groups[0][0][0] == 0 async def test_wrapper_store_forwards_coalescing_kwargs() -> None: """Coalescing kwargs flow through WrapperStore to the wrapped store's get_ranges.""" class SpyMemoryStore(MemoryStore): last_max_gap_bytes: int | None = None async def get_ranges( self, key: str, byte_ranges: Sequence[ByteRequest | None], *, prototype: BufferPrototype, max_concurrency: int = 10, max_gap_bytes: int = 1 << 20, max_coalesced_bytes: int = 16 << 20, ) -> AsyncIterator[Sequence[tuple[int, Buffer | None]]]: type(self).last_max_gap_bytes = max_gap_bytes async for group in super().get_ranges( key, byte_ranges, prototype=prototype, max_concurrency=max_concurrency, max_gap_bytes=max_gap_bytes, max_coalesced_bytes=max_coalesced_bytes, ): yield group inner = SpyMemoryStore() await _write(inner, "k", b"y" * 100) wrapped = WrapperStore(inner) proto = default_buffer_prototype() async for _ in wrapped.get_ranges( "k", [RangeByteRequest(0, 5)], prototype=proto, max_gap_bytes=-1 ): pass assert SpyMemoryStore.last_max_gap_bytes == -1 zarr-python-3.3.0/tests/test_store/test_latency.py000066400000000000000000000146701523267620000224320ustar00rootroot00000000000000from __future__ import annotations import time from unittest.mock import patch import numpy as np import pytest import zarr from zarr.abc.store import RangeByteRequest from zarr.core.buffer import default_buffer_prototype from zarr.core.codec_pipeline import FusedCodecPipeline from zarr.core.config import config as zarr_config from zarr.storage import MemoryStore from zarr.testing.store import LatencyStore async def test_latency_store_with_read_only_round_trip() -> None: """ Ensure that LatencyStore.with_read_only returns another LatencyStore with the requested read_only state, preserves latency configuration, and does not change the original wrapper. """ base = await MemoryStore.open() # Start from a read-only underlying store ro_base = base.with_read_only(read_only=True) latency_ro = LatencyStore(ro_base, get_latency=0.01, set_latency=0.02) assert latency_ro.read_only assert latency_ro.get_latency == pytest.approx(0.01) assert latency_ro.set_latency == pytest.approx(0.02) buf = default_buffer_prototype().buffer.from_bytes(b"abcd") # Cannot write through the read-only wrapper with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await latency_ro.set("key", buf) # Create a writable wrapper from the read-only one writer = latency_ro.with_read_only(read_only=False) assert isinstance(writer, LatencyStore) assert not writer.read_only # Latency configuration is preserved assert writer.get_latency == latency_ro.get_latency assert writer.set_latency == latency_ro.set_latency # Writes via the writable wrapper succeed await writer.set("key", buf) out = await writer.get("key", prototype=default_buffer_prototype()) assert out is not None assert out.to_bytes() == buf.to_bytes() # Creating a read-only copy from the writable wrapper works and is enforced reader = writer.with_read_only(read_only=True) assert isinstance(reader, LatencyStore) assert reader.read_only with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await reader.set("other", buf) # The original read-only wrapper remains read-only assert latency_ro.read_only @pytest.mark.parametrize( ("get_latency", "set_latency"), [ (0.01, 0.02), ((0.1, 0.05), (0.2, 0.01)), ], ids=["scalar", "distribution"], ) def test_with_store_preserves_latency_config( get_latency: float | tuple[float, float], set_latency: float | tuple[float, float] ) -> None: """Derived stores (e.g. via `with_read_only`) keep the raw latency config — a `(loc, scale)` distribution must not collapse to one sampled float.""" store = LatencyStore(MemoryStore(), get_latency=get_latency, set_latency=set_latency) derived = store.with_read_only(True) assert derived._get_latency == store._get_latency assert derived._set_latency == store._set_latency def test_sync_methods_inject_latency(monkeypatch: pytest.MonkeyPatch) -> None: """`get_sync`/`set_sync` sleep the configured latency on the calling thread before delegating to the wrapped store.""" sleeps: list[float] = [] monkeypatch.setattr(time, "sleep", sleeps.append) store = LatencyStore(MemoryStore(), get_latency=0.123, set_latency=0.456) buf = default_buffer_prototype().buffer.from_bytes(b"abcd") store.set_sync("key", buf) assert sleeps == [pytest.approx(0.456)] out = store.get_sync("key", prototype=default_buffer_prototype()) assert out is not None assert out.to_bytes() == b"abcd" assert sleeps == [pytest.approx(0.456), pytest.approx(0.123)] async def test_get_ranges_pays_latency_per_fetch() -> None: """`get_ranges` routes through the coalescing default built on `self.get`, so each merged fetch pays the configured latency instead of bypassing it via WrapperStore delegation. Two ranges further apart than `max_gap_bytes` cannot coalesce -> exactly two `get` calls.""" proto = default_buffer_prototype() inner = MemoryStore() await inner.set("blob", proto.buffer.from_bytes(bytes(4 << 20))) store = LatencyStore(inner, get_latency=0.0) requests = [RangeByteRequest(0, 10), RangeByteRequest(2 << 20, (2 << 20) + 10)] results: list[tuple[int, object]] = [] with patch.object(store, "get", wraps=store.get) as get_spy: async for group in store.get_ranges("blob", requests, prototype=proto): results.extend(group) assert get_spy.await_count == 2 assert sorted(idx for idx, _ in results) == [0, 1] for _, buf in results: assert buf is not None assert len(buf) == 10 # type: ignore[arg-type] async def test_get_partial_values_routes_through_get() -> None: """`get_partial_values` issues one `self.get` per key-range so each fetch pays the configured latency instead of bypassing it via WrapperStore delegation.""" proto = default_buffer_prototype() inner = MemoryStore() await inner.set("blob", proto.buffer.from_bytes(b"0123456789")) store = LatencyStore(inner, get_latency=0.0) with patch.object(store, "get", wraps=store.get) as get_spy: results = await store.get_partial_values( proto, [("blob", RangeByteRequest(0, 4)), ("blob", None)] ) assert get_spy.await_count == 2 assert results[0] is not None assert results[0].to_bytes() == b"0123" assert results[1] is not None assert results[1].to_bytes() == b"0123456789" def test_latency_store_engages_fused_sync_path() -> None: """A LatencyStore wrapping a sync-capable store must take the fused sync fast path: reads go through the inner store's `get_sync`, not the async fallback.""" inner = MemoryStore() store = LatencyStore(inner, get_latency=0.0, set_latency=0.0) with zarr_config.set({"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"}): arr = zarr.create_array( store=store, shape=(8,), chunks=(4,), dtype="uint8", compressors=None, fill_value=0, ) assert isinstance(arr._async_array.codec_pipeline, FusedCodecPipeline) data = np.arange(8, dtype="uint8") arr[:] = data with patch.object(inner, "get_sync", wraps=inner.get_sync) as get_sync_spy: np.testing.assert_array_equal(arr[:], data) assert get_sync_spy.call_count == 2 # one per chunk zarr-python-3.3.0/tests/test_store/test_local.py000066400000000000000000000137371523267620000220700ustar00rootroot00000000000000from __future__ import annotations import pathlib import re import numpy as np import pytest import zarr from zarr import create_array from zarr.core.buffer import Buffer, cpu from zarr.storage import LocalStore from zarr.storage._local import _atomic_write from zarr.testing.store import StoreTests from zarr.testing.utils import assert_bytes_equal class TestLocalStore(StoreTests[LocalStore, cpu.Buffer]): store_cls = LocalStore buffer_cls = cpu.Buffer async def get(self, store: LocalStore, key: str) -> Buffer: return self.buffer_cls.from_bytes((store.root / key).read_bytes()) async def set(self, store: LocalStore, key: str, value: Buffer) -> None: parent = (store.root / key).parent if not parent.exists(): parent.mkdir(parents=True) (store.root / key).write_bytes(value.to_bytes()) @pytest.fixture def store_kwargs(self, tmp_path: pathlib.Path) -> dict[str, str]: return {"root": str(tmp_path)} def test_store_repr(self, store: LocalStore) -> None: assert str(store) == f"file://{store.root.as_posix()}" def test_store_supports_writes(self, store: LocalStore) -> None: assert store.supports_writes def test_store_supports_listing(self, store: LocalStore) -> None: assert store.supports_listing async def test_empty_with_empty_subdir(self, store: LocalStore) -> None: assert await store.is_empty("") (store.root / "foo/bar").mkdir(parents=True) assert await store.is_empty("") def test_delete_sync_directory(self, store: LocalStore) -> None: """`delete_sync` on a key that is a directory must remove the whole tree. Mirrors the async `delete_dir` behavior: deleting `"foo"` where `"foo"` is a directory containing further nested paths should remove everything under it, not just fail or delete a single file. """ (store.root / "foo" / "bar").mkdir(parents=True) (store.root / "foo" / "bar" / "baz").write_bytes(b"data") store.delete_sync("foo") assert not (store.root / "foo").exists() def test_creates_new_directory(self, tmp_path: pathlib.Path) -> None: target = tmp_path.joinpath("a", "b", "c") assert not target.exists() store = self.store_cls(root=target) zarr.group(store=store) def test_invalid_root_raises(self) -> None: """ Test that a TypeError is raised when a non-str/Path type is used for the `root` argument """ with pytest.raises( TypeError, match=r"'root' must be a string or Path instance. Got an instance of instead.", ): LocalStore(root=0) # type: ignore[arg-type] async def test_get_with_prototype_default(self, store: LocalStore) -> None: """ Ensure that data can be read via ``store.get`` if the prototype keyword argument is unspecified, i.e. set to ``None``. """ data_buf = self.buffer_cls.from_bytes(b"\x01\x02\x03\x04") key = "c/0" await self.set(store, key, data_buf) observed = await store.get(key, prototype=None) assert_bytes_equal(observed, data_buf) @pytest.mark.parametrize("ndim", [0, 1, 3]) @pytest.mark.parametrize( "destination", ["destination", "foo/bar/destintion", pathlib.Path("foo/bar/destintion")] ) async def test_move( self, tmp_path: pathlib.Path, ndim: int, destination: pathlib.Path | str ) -> None: origin = tmp_path / "origin" if isinstance(destination, str): destination = str(tmp_path / destination) else: destination = tmp_path / destination print(type(destination)) store = await LocalStore.open(root=origin) shape = (4,) * ndim chunks = (2,) * ndim data = np.arange(4**ndim) if ndim > 0: data = data.reshape(*shape) array = create_array(store, data=data, chunks=chunks or "auto") await store.move(destination) assert store.root == pathlib.Path(destination) assert pathlib.Path(destination).exists() assert not origin.exists() assert np.array_equal(array[...], data) store2 = await LocalStore.open(root=origin) with pytest.raises( FileExistsError, match=re.escape(f"Destination root {destination} already exists") ): await store2.move(destination) @pytest.mark.parametrize("exclusive", [True, False]) def test_atomic_write_successful(tmp_path: pathlib.Path, exclusive: bool) -> None: path = tmp_path / "data" with _atomic_write(path, "wb", exclusive=exclusive) as f: f.write(b"abc") assert path.read_bytes() == b"abc" assert list(path.parent.iterdir()) == [path] # no temp files @pytest.mark.parametrize("exclusive", [True, False]) def test_atomic_write_incomplete(tmp_path: pathlib.Path, exclusive: bool) -> None: path = tmp_path / "data" with pytest.raises(RuntimeError): # noqa: PT012 with _atomic_write(path, "wb", exclusive=exclusive) as f: f.write(b"a") raise RuntimeError assert not path.exists() assert list(path.parent.iterdir()) == [] # no temp files def test_atomic_write_non_exclusive_preexisting(tmp_path: pathlib.Path) -> None: path = tmp_path / "data" with path.open("wb") as f: f.write(b"xyz") assert path.read_bytes() == b"xyz" with _atomic_write(path, "wb", exclusive=False) as f: f.write(b"abc") assert path.read_bytes() == b"abc" assert list(path.parent.iterdir()) == [path] # no temp files def test_atomic_write_exclusive_preexisting(tmp_path: pathlib.Path) -> None: path = tmp_path / "data" with path.open("wb") as f: f.write(b"xyz") assert path.read_bytes() == b"xyz" with pytest.raises(FileExistsError): with _atomic_write(path, "wb", exclusive=True) as f: f.write(b"abc") assert path.read_bytes() == b"xyz" assert list(path.parent.iterdir()) == [path] # no temp files zarr-python-3.3.0/tests/test_store/test_logging.py000066400000000000000000000153741523267620000224230ustar00rootroot00000000000000from __future__ import annotations import logging from typing import TYPE_CHECKING, TypedDict import pytest import zarr from zarr.core.buffer import Buffer, cpu, default_buffer_prototype from zarr.storage import LocalStore, LoggingStore from zarr.testing.store import StoreTests if TYPE_CHECKING: from pathlib import Path from zarr.abc.store import Store class StoreKwargs(TypedDict): store: LocalStore log_level: str class TestLoggingStore(StoreTests[LoggingStore[LocalStore], cpu.Buffer]): # store_cls is needed to do an isinstance check, so can't be a subscripted generic store_cls = LoggingStore # type: ignore[assignment] buffer_cls = cpu.Buffer async def get(self, store: LoggingStore[LocalStore], key: str) -> Buffer: return self.buffer_cls.from_bytes((store._store.root / key).read_bytes()) async def set(self, store: LoggingStore[LocalStore], key: str, value: Buffer) -> None: parent = (store._store.root / key).parent if not parent.exists(): parent.mkdir(parents=True) (store._store.root / key).write_bytes(value.to_bytes()) @pytest.fixture def store_kwargs(self, tmp_path: Path) -> StoreKwargs: return {"store": LocalStore(str(tmp_path)), "log_level": "DEBUG"} @pytest.fixture def open_kwargs(self, tmp_path: Path) -> dict[str, type[LocalStore] | str]: return {"store_cls": LocalStore, "root": str(tmp_path), "log_level": "DEBUG"} @pytest.fixture def store(self, store_kwargs: StoreKwargs) -> LoggingStore[LocalStore]: return self.store_cls(**store_kwargs) def test_store_supports_writes(self, store: LoggingStore[LocalStore]) -> None: assert store.supports_writes def test_store_supports_listing(self, store: LoggingStore[LocalStore]) -> None: assert store.supports_listing def test_store_repr(self, store: LoggingStore[LocalStore]) -> None: assert f"{store!r}" == f"LoggingStore(LocalStore, 'file://{store._store.root.as_posix()}')" def test_store_str(self, store: LoggingStore[LocalStore]) -> None: assert str(store) == f"logging-file://{store._store.root.as_posix()}" async def test_default_handler( self, local_store: LocalStore, capsys: pytest.CaptureFixture[str] ) -> None: # Store and then remove existing handlers to enter default handler code path handlers = logging.getLogger().handlers[:] for h in handlers: logging.getLogger().removeHandler(h) # Test logs are sent to stdout wrapped = LoggingStore(store=local_store) buffer = default_buffer_prototype().buffer res = await wrapped.set("foo/bar/c/0", buffer.from_bytes(b"\x01\x02\x03\x04")) # type: ignore[func-returns-value] assert res is None captured = capsys.readouterr() assert len(captured) == 2 assert "Calling LocalStore.set" in captured.out assert "Finished LocalStore.set" in captured.out # Restore handlers for h in handlers: logging.getLogger().addHandler(h) def test_is_open_setter_raises(self, store: LoggingStore[LocalStore]) -> None: "Test that a user cannot change `_is_open` without opening the underlying store." with pytest.raises( NotImplementedError, match="LoggingStore must be opened via the `_open` method" ): store._is_open = True async def test_with_read_only_round_trip(self, local_store: LocalStore) -> None: """ Ensure that LoggingStore.with_read_only returns another LoggingStore with the requested read_only state, preserves logging configuration, and does not change the original store. """ # Start from a read-only underlying store ro_store = local_store.with_read_only(read_only=True) wrapped_ro = LoggingStore(store=ro_store, log_level="INFO") assert wrapped_ro.read_only buf = default_buffer_prototype().buffer.from_bytes(b"0123") # Cannot write through the read-only wrapper with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await wrapped_ro.set("foo", buf) # Create a writable wrapper writer = wrapped_ro.with_read_only(read_only=False) assert isinstance(writer, LoggingStore) assert not writer.read_only # logging configuration is preserved assert writer.log_level == wrapped_ro.log_level assert writer.log_handler == wrapped_ro.log_handler # Writes via the writable wrapper succeed await writer.set("foo", buf) out = await writer.get("foo", prototype=default_buffer_prototype()) assert out is not None assert out.to_bytes() == buf.to_bytes() # The original wrapper remains read-only assert wrapped_ro.read_only with pytest.raises( ValueError, match="store was opened in read-only mode and does not support writing" ): await wrapped_ro.set("bar", buf) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) async def test_logging_store(store: Store, caplog: pytest.LogCaptureFixture) -> None: wrapped = LoggingStore(store=store, log_level="DEBUG") buffer = default_buffer_prototype().buffer caplog.clear() res = await wrapped.set("foo/bar/c/0", buffer.from_bytes(b"\x01\x02\x03\x04")) # type: ignore[func-returns-value] assert res is None assert len(caplog.record_tuples) == 2 for tup in caplog.record_tuples: assert str(store) in tup[0] assert f"Calling {type(store).__name__}.set" in caplog.record_tuples[0][2] assert f"Finished {type(store).__name__}.set" in caplog.record_tuples[1][2] caplog.clear() keys = [k async for k in wrapped.list()] assert keys == ["foo/bar/c/0"] assert len(caplog.record_tuples) == 2 for tup in caplog.record_tuples: assert str(store) in tup[0] assert f"Calling {type(store).__name__}.list" in caplog.record_tuples[0][2] assert f"Finished {type(store).__name__}.list" in caplog.record_tuples[1][2] @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=["store"]) async def test_logging_store_counter(store: Store) -> None: wrapped = LoggingStore(store=store, log_level="DEBUG") arr = zarr.create(shape=(10,), store=wrapped, overwrite=True) arr[:] = 1 assert wrapped.counter["set"] == 2 assert wrapped.counter["list"] == 0 assert wrapped.counter["list_dir"] == 0 assert wrapped.counter["list_prefix"] == 0 if store.supports_deletes: assert wrapped.counter["get"] == 0 # 1 if overwrite=False assert wrapped.counter["delete_dir"] == 1 else: assert wrapped.counter["get"] == 1 assert wrapped.counter["delete_dir"] == 0 zarr-python-3.3.0/tests/test_store/test_memory.py000066400000000000000000000521471523267620000223040ustar00rootroot00000000000000from __future__ import annotations import re from typing import TYPE_CHECKING, Any import numpy as np import numpy.typing as npt import pytest import zarr from zarr.core.buffer import Buffer, cpu, default_buffer_prototype, gpu from zarr.errors import ZarrUserWarning from zarr.storage import GpuMemoryStore, ManagedMemoryStore, MemoryStore from zarr.storage._utils import _join_paths from zarr.testing.store import StoreTests from zarr.testing.utils import gpu_test if TYPE_CHECKING: from zarr.core.common import ZarrFormat # TODO: work out where this warning is coming from and fix it @pytest.mark.filterwarnings( re.escape("ignore:coroutine 'ClientCreatorContext.__aexit__' was never awaited") ) class TestMemoryStore(StoreTests[MemoryStore, cpu.Buffer]): store_cls = MemoryStore buffer_cls = cpu.Buffer async def set(self, store: MemoryStore, key: str, value: Buffer) -> None: store._store_dict[key] = value async def get(self, store: MemoryStore, key: str) -> Buffer: return store._store_dict[key] @pytest.fixture(params=[None, True]) def store_kwargs(self, request: pytest.FixtureRequest) -> dict[str, Any]: kwargs: dict[str, Any] if request.param is True: kwargs = {"store_dict": {}} else: kwargs = {"store_dict": None} return kwargs @pytest.fixture async def store(self, store_kwargs: dict[str, Any]) -> MemoryStore: return self.store_cls(**store_kwargs) def test_store_repr(self, store: MemoryStore) -> None: assert str(store) == f"memory://{id(store._store_dict)}" def test_store_supports_writes(self, store: MemoryStore) -> None: assert store.supports_writes def test_store_supports_listing(self, store: MemoryStore) -> None: assert store.supports_listing async def test_list_prefix(self, store: MemoryStore) -> None: assert True @pytest.mark.parametrize("dtype", ["uint8", "float32", "int64"]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_deterministic_size( self, store: MemoryStore, dtype: npt.DTypeLike, zarr_format: ZarrFormat ) -> None: a = zarr.empty( store=store, shape=(3,), chunks=(1000,), dtype=dtype, zarr_format=zarr_format, overwrite=True, ) a[...] = 1 a.resize((1000,)) np.testing.assert_array_equal(a[:3], 1) np.testing.assert_array_equal(a[3:], 0) @pytest.mark.parametrize("method", ["set", "set_sync", "set_if_not_exists"]) async def test_set_does_not_retain_caller_buffer(self, store: MemoryStore, method: str) -> None: """Writing a buffer must not alias the caller's memory. MemoryStore keeps whatever it is handed alive in a dict, so retaining the caller's buffer lets a later mutation of that buffer rewrite data already committed to the store. """ source = np.frombuffer(bytearray(b"\x01\x02\x03\x04"), dtype="B") value = cpu.Buffer.from_array_like(source) if method == "set_sync": store.set_sync("k", value) else: await getattr(store, method)("k", value) source[:] = 0xF # mutate the caller's memory after the write stored = await store.get("k", prototype=default_buffer_prototype()) assert stored is not None assert stored.to_bytes() == b"\x01\x02\x03\x04" @pytest.mark.parametrize( "pipeline", [ "zarr.core.codec_pipeline.BatchedCodecPipeline", "zarr.core.codec_pipeline.FusedCodecPipeline", ], ) @pytest.mark.parametrize(("shape", "chunks"), [((30,), (10,)), ((8,), (4,)), ((4,), (4,))]) def test_write_does_not_alias_source_array( self, pipeline: str, shape: tuple[int], chunks: tuple[int] ) -> None: """Mutating the source array after a write must not corrupt stored chunks. Without compression the encoded buffer is a zero-copy view of the caller's array all the way down to the store, so this covers both the single-chunk and multi-chunk write paths. """ with zarr.config.set({"codec_pipeline.path": pipeline}): array = zarr.create_array( store=MemoryStore(), shape=shape, chunks=chunks, dtype="i4", compressors=None ) source = np.arange(shape[0], dtype="i4") expected = source.copy() array[:] = source source[:] = -1 np.testing.assert_array_equal(array[:], expected) # TODO: fix this warning @pytest.mark.filterwarnings("ignore:Unclosed client session:ResourceWarning") @gpu_test class TestGpuMemoryStore(StoreTests[GpuMemoryStore, gpu.Buffer]): store_cls = GpuMemoryStore buffer_cls = gpu.Buffer async def set(self, store: GpuMemoryStore, key: str, value: gpu.Buffer) -> None: # type: ignore[override] store._store_dict[key] = value async def get(self, store: MemoryStore, key: str) -> Buffer: return store._store_dict[key] @pytest.fixture(params=[None, True]) def store_kwargs(self, request: pytest.FixtureRequest) -> dict[str, Any]: kwargs: dict[str, Any] if request.param is True: kwargs = {"store_dict": {}} else: kwargs = {"store_dict": None} return kwargs @pytest.fixture async def store(self, store_kwargs: dict[str, Any]) -> GpuMemoryStore: return self.store_cls(**store_kwargs) def test_store_repr(self, store: GpuMemoryStore) -> None: assert str(store) == f"gpumemory://{id(store._store_dict)}" def test_store_supports_writes(self, store: GpuMemoryStore) -> None: assert store.supports_writes def test_store_supports_listing(self, store: GpuMemoryStore) -> None: assert store.supports_listing async def test_list_prefix(self, store: GpuMemoryStore) -> None: assert True def test_dict_reference(self, store: GpuMemoryStore) -> None: store_dict: dict[str, Any] = {} result = GpuMemoryStore(store_dict=store_dict) assert result._store_dict is store_dict def test_from_dict(self) -> None: d = { "a": gpu.Buffer.from_bytes(b"aaaa"), "b": cpu.Buffer.from_bytes(b"bbbb"), } msg = "Creating a zarr.buffer.gpu.Buffer with an array that does not support the __cuda_array_interface__ for zero-copy transfers, falling back to slow copy based path" with pytest.warns(ZarrUserWarning, match=msg): result = GpuMemoryStore.from_dict(d) for v in result._store_dict.values(): assert type(v) is gpu.Buffer def test_set_sync_converts_to_gpu_buffer(self, store: GpuMemoryStore) -> None: """`set_sync` must convert its value to a `gpu.Buffer`, mirroring `set`. `GpuMemoryStore`'s invariant is that every stored value is a `gpu.Buffer`. Without this override, the inherited `MemoryStore.set_sync` would store the CPU buffer it was given as-is, breaking that invariant for whichever code path (e.g. the fused pipeline) uses the sync API. """ cpu_value = cpu.Buffer.from_bytes(b"aaaa") msg = "Creating a zarr.buffer.gpu.Buffer with an array that does not support the __cuda_array_interface__ for zero-copy transfers, falling back to slow copy based path" with pytest.warns(ZarrUserWarning, match=msg): store.set_sync("k", cpu_value) assert type(store._store_dict["k"]) is gpu.Buffer class TestManagedMemoryStore(StoreTests[ManagedMemoryStore, cpu.Buffer]): store_cls = ManagedMemoryStore buffer_cls = cpu.Buffer async def set(self, store: ManagedMemoryStore, key: str, value: Buffer) -> None: store._store_dict[_join_paths([store.path, key])] = value async def get(self, store: ManagedMemoryStore, key: str) -> Buffer: return store._store_dict[_join_paths([store.path, key])] @pytest.fixture def store_kwargs(self, request: pytest.FixtureRequest) -> dict[str, Any]: # Use a unique name per test to avoid sharing state between tests # but ensure the name is deterministic for equality tests # Replace '/' with '-' since store names cannot contain '/' # A non-empty path exercises prefix handling; a store with an # unprefixed key in its backing dict would pass these tests # vacuously with path="". sanitized_name = request.node.name.replace("/", "-") return {"name": f"test-{sanitized_name}", "path": "prefix"} @pytest.fixture async def store(self, store_kwargs: dict[str, Any]) -> ManagedMemoryStore: return self.store_cls(**store_kwargs) def test_store_repr(self, store: ManagedMemoryStore) -> None: assert str(store) == _join_paths([f"memory://{store.name}", store.path]) async def test_serializable_store(self, store: ManagedMemoryStore) -> None: """ Test pickling semantics for ManagedMemoryStore. When pickled and unpickled within the same process (where the original store still exists in the registry), the unpickled store reconnects to the same backing dict. """ import pickle # Add some data to the store await store.set("test-key", self.buffer_cls.from_bytes(b"test-value")) # Pickle and unpickle the store pickled = pickle.dumps(store) store2 = pickle.loads(pickled) # The unpickled store should reconnect to the same backing dict assert store2._store_dict is store._store_dict assert store2.name == store.name assert store2.path == store.path assert store2.read_only == store.read_only # The data should be accessible result = await store2.get("test-key") assert result is not None assert result.to_bytes() == b"test-value" async def test_pickle_with_path(self) -> None: """Test that path is preserved through pickle round-trip.""" import pickle store = ManagedMemoryStore(name="pickle-path-test", path="some/path") await store.set("key", self.buffer_cls.from_bytes(b"value")) pickled = pickle.dumps(store) store2 = pickle.loads(pickled) assert store2.path == "some/path" assert store2._store_dict is store._store_dict # Check that operations use the path correctly result = await store2.get("key") assert result is not None assert result.to_bytes() == b"value" def test_pickle_after_gc(self) -> None: """ Test that unpickling after the original store is garbage collected creates a new empty store with the same name (in the same process). """ import gc import pickle # Create a store with a unique name and pickle it store = ManagedMemoryStore(name="gc-pickle-test") store._store_dict["key"] = self.buffer_cls.from_bytes(b"value") pickled = pickle.dumps(store) # Delete the store and garbage collect del store gc.collect() # Unpickling should create a new store with an empty dict store2 = pickle.loads(pickled) assert store2.name == "gc-pickle-test" # The dict is empty because the original was garbage collected assert len(store2._store_dict) == 0 async def test_cross_process_detection(self) -> None: """ Test that unpickling a ManagedMemoryStore in a different process raises an error. This prevents silent data loss when a store is pickled and unpickled in a different process (e.g., with multiprocessing). """ import os store = ManagedMemoryStore(name="cross-process-test") await store.set("key", self.buffer_cls.from_bytes(b"value")) # Get the reduce tuple and modify the state to simulate a different process cls, args, state = store.__reduce__() state["created_pid"] = os.getpid() + 1 # Fake a different process ID # Manually reconstruct what pickle.loads would do # This simulates unpickling data that was pickled in a different process reconstructed = cls(*args) with pytest.raises(RuntimeError, match="was created in process"): reconstructed.__setstate__(state) def test_store_supports_writes(self, store: ManagedMemoryStore) -> None: assert store.supports_writes def test_store_supports_listing(self, store: ManagedMemoryStore) -> None: assert store.supports_listing @pytest.mark.parametrize("dtype", ["uint8", "float32", "int64"]) @pytest.mark.parametrize("zarr_format", [2, 3]) async def test_deterministic_size( self, store: MemoryStore, dtype: npt.DTypeLike, zarr_format: ZarrFormat ) -> None: a = zarr.empty( store=store, shape=(3,), chunks=(1000,), dtype=dtype, zarr_format=zarr_format, overwrite=True, ) a[...] = 1 a.resize((1000,)) np.testing.assert_array_equal(a[:3], 1) np.testing.assert_array_equal(a[3:], 0) def test_from_url(self, store: ManagedMemoryStore) -> None: """Test that from_url creates a store sharing the same dict.""" url = str(store) store2 = ManagedMemoryStore.from_url(url) assert store2._store_dict is store._store_dict def test_from_url_with_path(self, store: ManagedMemoryStore) -> None: """Test that from_url extracts path component from URL.""" # Reconnect to the fixture's dict via its name, but with an empty # path, so appending "/some/path" below yields exactly that path. base = ManagedMemoryStore(name=store.name) url = f"{base}/some/path" store2 = ManagedMemoryStore.from_url(url) assert store2._store_dict is store._store_dict assert store2.path == "some/path" assert str(store2) == url def test_from_url_invalid(self) -> None: """Test that from_url raises ValueError for non-existent store.""" with pytest.raises(ValueError, match="Memory store not found"): ManagedMemoryStore.from_url("memory://nonexistent-store") def test_from_url_not_memory_scheme(self) -> None: """Test that from_url raises ValueError for non-memory URLs.""" with pytest.raises(ValueError, match="Expected a 'memory://' URL"): ManagedMemoryStore.from_url("file:///tmp/test") def test_named_store(self) -> None: """Test that stores can be created with explicit names.""" store = ManagedMemoryStore(name="my-test-store") assert store.name == "my-test-store" assert str(store) == "memory://my-test-store" def test_named_store_shares_dict(self) -> None: """Test that creating a store with the same name shares the dict.""" store1 = ManagedMemoryStore(name="shared-store") store2 = ManagedMemoryStore(name="shared-store") assert store1._store_dict is store2._store_dict assert store1.name == store2.name def test_auto_generated_name(self) -> None: """Test that stores get auto-generated names when none provided.""" store = ManagedMemoryStore() assert store.name is not None assert str(store) == f"memory://{store.name}" def test_with_read_only_shares_dict(self, store: ManagedMemoryStore) -> None: """Test that with_read_only creates a store sharing the same dict.""" store2 = store.with_read_only(True) assert store2._store_dict is store._store_dict assert store2.read_only is True assert store.read_only is False def test_with_read_only_preserves_path(self) -> None: """Test that with_read_only preserves the path.""" store = ManagedMemoryStore(name="path-test", path="some/path") store2 = store.with_read_only(True) assert store2.path == "some/path" assert store2._store_dict is store._store_dict async def test_path_prefix_operations(self) -> None: """Test that store operations use the path prefix correctly.""" store = ManagedMemoryStore(name="prefix-test") store_with_path = ManagedMemoryStore.from_url("memory://prefix-test/subdir") # Write via store_with_path await store_with_path.set("key", self.buffer_cls.from_bytes(b"value")) # The key should be stored with the prefix in the underlying dict assert "subdir/key" in store._store_dict assert "key" not in store._store_dict # Read via store_with_path should work result = await store_with_path.get("key") assert result is not None assert result.to_bytes() == b"value" # Read via store without path should use full key result2 = await store.get("subdir/key") assert result2 is not None assert result2.to_bytes() == b"value" async def test_path_list_operations(self) -> None: """Test that list operations filter by path prefix.""" store = ManagedMemoryStore(name="list-test") # Set up some keys at different paths await store.set("a/key1", self.buffer_cls.from_bytes(b"v1")) await store.set("a/key2", self.buffer_cls.from_bytes(b"v2")) await store.set("b/key3", self.buffer_cls.from_bytes(b"v3")) # Create a store with path "a" store_a = ManagedMemoryStore.from_url("memory://list-test/a") # list() should only return keys under "a", without the "a/" prefix keys = [k async for k in store_a.list()] assert sorted(keys) == ["key1", "key2"] async def test_path_exists(self) -> None: """Test that exists() uses the path prefix.""" store = ManagedMemoryStore(name="exists-test") await store.set("prefix/key", self.buffer_cls.from_bytes(b"value")) store_with_path = ManagedMemoryStore.from_url("memory://exists-test/prefix") assert await store_with_path.exists("key") assert not await store_with_path.exists("prefix/key") def test_path_normalization(self) -> None: """Test that paths are normalized.""" store1 = ManagedMemoryStore(name="norm-test", path="a/b/") store2 = ManagedMemoryStore(name="norm-test", path="/a/b") store3 = ManagedMemoryStore(name="norm-test", path="a//b") assert store1.path == "a/b" assert store2.path == "a/b" assert store3.path == "a/b" def test_name_cannot_contain_slash(self) -> None: """Test that store names cannot contain '/'.""" with pytest.raises(ValueError, match="cannot contain '/'"): ManagedMemoryStore(name="foo/bar") def test_garbage_collection(self) -> None: """Test that the dict is garbage collected when no stores reference it.""" import gc store = ManagedMemoryStore() url = str(store) # URL should resolve while store exists store2 = ManagedMemoryStore.from_url(url) assert store2._store_dict is store._store_dict # Delete both stores del store del store2 gc.collect() # URL should no longer resolve with pytest.raises(ValueError, match="garbage collected"): ManagedMemoryStore.from_url(url) def test_sync_methods_respect_path_prefix(self) -> None: """`get_sync`/`set_sync`/`delete_sync` must prefix keys with `self.path`, exactly like the async `get`/`set`/`delete` methods. `ManagedMemoryStore` used to inherit these from `MemoryStore`, which writes/reads the raw key. Two stores sharing a dict with different `path` values would then cross-talk through the sync API. """ store = ManagedMemoryStore(name="sync-prefix-test", path="subdir") data_buf = self.buffer_cls.from_bytes(b"value") store.set_sync("key", data_buf) assert "subdir/key" in store._store_dict assert "key" not in store._store_dict result = store.get_sync("key") assert result is not None assert result.to_bytes() == b"value" store.delete_sync("key") assert "subdir/key" not in store._store_dict def test_fused_pipeline_respects_path_prefix(self) -> None: """End-to-end regression: the fused pipeline's sync store fast path must write chunks under the store's path prefix. `FusedCodecPipeline` uses `set_sync`/`get_sync` when a store implements the sync protocols. If those methods skip the prefix that the async methods apply, chunk data lands outside `self.path` and a fresh handle re-reading through the prefix silently sees fill values instead. """ with zarr.config.set( {"codec_pipeline.path": "zarr.core.codec_pipeline.FusedCodecPipeline"} ): store = ManagedMemoryStore(name="fused-prefix-test", path="subdir") arr = zarr.create_array(store, shape=(4,), chunks=(4,), dtype="uint8", zarr_format=3) arr[:] = np.arange(4, dtype="uint8") bad_keys = [k for k in store._store_dict if not k.startswith("subdir/")] assert bad_keys == [], f"keys written outside the store's path prefix: {bad_keys}" store2 = ManagedMemoryStore.from_url("memory://fused-prefix-test/subdir") arr2 = zarr.open_array(store2, mode="r") np.testing.assert_array_equal(arr2[:], np.arange(4, dtype="uint8")) zarr-python-3.3.0/tests/test_store/test_object.py000066400000000000000000000122731523267620000222360ustar00rootroot00000000000000# ruff: noqa: E402 import re from pathlib import Path from typing import TypedDict import pytest obstore = pytest.importorskip("obstore") from hypothesis.stateful import ( run_state_machine_as_test, ) from obstore.store import LocalStore, MemoryStore, S3Store from zarr.core.buffer import Buffer, cpu from zarr.core.sync import _collect_aiterator from zarr.storage import ObjectStore from zarr.testing.stateful import ZarrHierarchyStateMachine from zarr.testing.store import StoreTests class StoreKwargs(TypedDict): store: LocalStore read_only: bool class TestObjectStore(StoreTests[ObjectStore[LocalStore], cpu.Buffer]): # store_cls is needed to do an isinstance check, so can't be a subscripted generic store_cls = ObjectStore # type: ignore[assignment] buffer_cls = cpu.Buffer @pytest.fixture def store_kwargs(self, tmp_path: Path) -> StoreKwargs: store = LocalStore(prefix=tmp_path) return {"store": store, "read_only": False} @pytest.fixture def store(self, store_kwargs: StoreKwargs) -> ObjectStore[LocalStore]: return self.store_cls(**store_kwargs) async def get(self, store: ObjectStore[LocalStore], key: str) -> Buffer: assert isinstance(store.store, LocalStore) new_local_store = LocalStore(prefix=store.store.prefix) return self.buffer_cls.from_bytes(obstore.get(new_local_store, key).bytes()) async def set(self, store: ObjectStore[LocalStore], key: str, value: Buffer) -> None: assert isinstance(store.store, LocalStore) new_local_store = LocalStore(prefix=store.store.prefix) obstore.put(new_local_store, key, value.to_bytes()) def test_store_repr(self, store: ObjectStore[LocalStore]) -> None: from fnmatch import fnmatch pattern = "ObjectStore(object_store://LocalStore(*))" assert fnmatch(f"{store!r}", pattern) def test_store_supports_writes(self, store: ObjectStore[LocalStore]) -> None: assert store.supports_writes def test_store_supports_partial_writes(self, store: ObjectStore[LocalStore]) -> None: assert not store.supports_partial_writes def test_store_supports_listing(self, store: ObjectStore[LocalStore]) -> None: assert store.supports_listing def test_store_equal(self, store: ObjectStore[LocalStore]) -> None: """Test store equality""" # Test equality against a different instance type assert store != 0 # Test equality against a different store type new_memory_store = ObjectStore(MemoryStore()) assert store != new_memory_store # Test equality against a read only store assert isinstance(store.store, LocalStore) new_local_store = ObjectStore(LocalStore(prefix=store.store.prefix), read_only=True) assert store != new_local_store # Test two memory stores cannot be equal second_memory_store = ObjectStore(MemoryStore()) assert new_memory_store != second_memory_store def test_store_init_raises(self) -> None: """Test __init__ raises appropriate error for improper store type""" with pytest.raises(TypeError): ObjectStore("path/to/store") # type: ignore[type-var] async def test_store_getsize(self, store: ObjectStore[LocalStore]) -> None: buf = cpu.Buffer.from_bytes(b"\x01\x02\x03\x04") await self.set(store, "key", buf) size = await store.getsize("key") assert size == len(buf) async def test_store_getsize_prefix(self, store: ObjectStore[LocalStore]) -> None: buf = cpu.Buffer.from_bytes(b"\x01\x02\x03\x04") await self.set(store, "c/key1/0", buf) await self.set(store, "c/key2/0", buf) size = await store.getsize_prefix("c/key1") assert size == len(buf) total_size = await store.getsize_prefix("c") assert total_size == len(buf) * 2 @pytest.mark.filterwarnings( re.escape("ignore:datetime.datetime.utcnow() is deprecated:DeprecationWarning") ) async def test_list_dir_ignores_s3_prefix_marker(moto_server: str) -> None: """Ensure obstore's exact-prefix S3 directory marker is not listed as a child.""" boto3 = pytest.importorskip("boto3") bucket = "object-store-prefix-marker" client = boto3.client( "s3", endpoint_url=moto_server, region_name="us-east-1", aws_access_key_id="x", aws_secret_access_key="x", ) client.create_bucket(Bucket=bucket) client.put_object(Bucket=bucket, Key="g/", Body=b"") store = ObjectStore( S3Store( bucket=bucket, endpoint=moto_server, region="us-east-1", access_key_id="x", secret_access_key="x", client_options={"allow_http": True}, virtual_hosted_style_request=False, ) ) assert await _collect_aiterator(store.list_dir("g")) == () assert await _collect_aiterator(store.list_dir("g/")) == () @pytest.mark.slow_hypothesis def test_zarr_hierarchy() -> None: sync_store = ObjectStore(MemoryStore()) def mk_test_instance_sync() -> ZarrHierarchyStateMachine: return ZarrHierarchyStateMachine(sync_store) run_state_machine_as_test(mk_test_instance_sync) # type: ignore[no-untyped-call] zarr-python-3.3.0/tests/test_store/test_stateful.py000066400000000000000000000036331523267620000226170ustar00rootroot00000000000000# Stateful tests for arbitrary Zarr stores. from collections.abc import Generator import pytest from hypothesis.stateful import ( run_state_machine_as_test, ) import zarr from zarr.abc.store import Store from zarr.storage import LocalStore, ZipStore from zarr.testing.stateful import ZarrHierarchyStateMachine, ZarrStoreStateMachine pytestmark = [ pytest.mark.slow_hypothesis, # TODO: work out where this warning is coming from and fix pytest.mark.filterwarnings("ignore:Unclosed client session:ResourceWarning"), ] @pytest.fixture(autouse=True) def _enable_rectilinear_chunks() -> Generator[None, None, None]: """Enable rectilinear chunks since strategies may generate them.""" with zarr.config.set({"array.rectilinear_chunks": True}): yield @pytest.mark.filterwarnings("ignore::zarr.core.dtype.common.UnstableSpecificationWarning") def test_zarr_hierarchy(sync_store: Store) -> None: def mk_test_instance_sync() -> ZarrHierarchyStateMachine: return ZarrHierarchyStateMachine(sync_store) if isinstance(sync_store, ZipStore): pytest.skip(reason="ZipStore does not support delete") run_state_machine_as_test(mk_test_instance_sync) # type: ignore[no-untyped-call] def test_zarr_store(sync_store: Store) -> None: def mk_test_instance_sync() -> ZarrStoreStateMachine: return ZarrStoreStateMachine(sync_store) if isinstance(sync_store, ZipStore): pytest.skip(reason="ZipStore does not support delete") if isinstance(sync_store, LocalStore): # This test uses arbitrary keys, which are passed to `set` and `delete`. # It assumes that `set` and `delete` are the only two operations that modify state. # But LocalStore, directories can hang around even after a key is delete-d. pytest.skip(reason="Test isn't suitable for LocalStore.") run_state_machine_as_test(mk_test_instance_sync) # type: ignore[no-untyped-call] zarr-python-3.3.0/tests/test_store/test_utils.py000066400000000000000000000111441523267620000221240ustar00rootroot00000000000000from __future__ import annotations import sys from unittest.mock import patch import pytest from zarr.abc.store import SuffixByteRequest from zarr.core.buffer.core import default_buffer_prototype from zarr.storage._utils import ParsedStoreUrl, _normalize_byte_range_index, parse_store_url class TestParseStoreUrl: """Tests for parse_store_url.""" def test_memory_url(self) -> None: result = parse_store_url("memory://mystore") assert result == ParsedStoreUrl( scheme="memory", name="mystore", path="", raw="memory://mystore" ) def test_memory_url_with_path(self) -> None: result = parse_store_url("memory://mystore/path/to/data") assert result == ParsedStoreUrl( scheme="memory", name="mystore", path="path/to/data", raw="memory://mystore/path/to/data", ) def test_memory_url_no_name(self) -> None: result = parse_store_url("memory://") assert result.scheme == "memory" assert result.name is None def test_s3_url(self) -> None: result = parse_store_url("s3://bucket/key") assert result == ParsedStoreUrl( scheme="s3", name="bucket", path="key", raw="s3://bucket/key" ) def test_file_url(self) -> None: result = parse_store_url("file:///tmp/test") assert result.scheme == "file" def test_local_absolute_path(self) -> None: result = parse_store_url("/local/path") assert result == ParsedStoreUrl(scheme="", name=None, path="/local/path", raw="/local/path") def test_local_relative_path(self) -> None: result = parse_store_url("relative/path") assert result == ParsedStoreUrl( scheme="", name=None, path="relative/path", raw="relative/path" ) @pytest.mark.parametrize( "url", [ "C:\\Users\\foo", "C:/Users/foo", "D:/data/zarr", "c:/test", ], ) def test_windows_drive_letter(self, url: str) -> None: """On Windows, bare drive-letter paths must be treated as local paths.""" with patch.object(sys, "platform", "win32"): result = parse_store_url(url) assert result.scheme == "" assert result.name is None assert result.path == url assert result.raw == url @pytest.mark.parametrize( "url", [ "file:///C:/Users/foo", "file://C:/Users/foo", ], ) def test_file_url_with_drive_letter_on_windows(self, url: str) -> None: """file:// URLs with drive letters are not treated as bare paths.""" with patch.object(sys, "platform", "win32"): result = parse_store_url(url) assert result.scheme == "file" @pytest.mark.parametrize( "url", [ "C:\\Users\\foo", "C:/Users/foo", ], ) def test_drive_letter_not_special_on_non_windows(self, url: str) -> None: """On non-Windows platforms, drive-letter paths go through urlparse.""" with patch.object(sys, "platform", "linux"): result = parse_store_url(url) # urlparse interprets the drive letter as a scheme assert result.scheme == "c" class TestNormalizeByteRangeIndex: """Tests for _normalize_byte_range_index.""" def test_suffix_larger_than_data_returns_all_bytes(self) -> None: """Regression: SuffixByteRequest with suffix > len(data) must not produce a negative start index that causes numpy to return fewer bytes than available.""" prototype = default_buffer_prototype() data = prototype.buffer.from_bytes(b"hello") # 5 bytes byte_range = SuffixByteRequest(suffix=7) start, stop = _normalize_byte_range_index(data, byte_range) assert start == 0, f"start should be 0 (clamped), got {start}" result = data[start:stop] assert len(result) == 5, f"expected all 5 bytes, got {len(result)}" def test_suffix_exact_length(self) -> None: """SuffixByteRequest with suffix == len(data) returns all bytes.""" prototype = default_buffer_prototype() data = prototype.buffer.from_bytes(b"hello") start, _stop = _normalize_byte_range_index(data, SuffixByteRequest(suffix=5)) assert start == 0 def test_suffix_shorter_than_data(self) -> None: """SuffixByteRequest with suffix < len(data) returns the last n bytes.""" prototype = default_buffer_prototype() data = prototype.buffer.from_bytes(b"hello") start, _stop = _normalize_byte_range_index(data, SuffixByteRequest(suffix=3)) assert start == 2 zarr-python-3.3.0/tests/test_store/test_wrapper.py000066400000000000000000000144021523267620000224440ustar00rootroot00000000000000from __future__ import annotations from typing import TYPE_CHECKING, Any, TypedDict import pytest from zarr.abc.store import ByteRequest, Store, _store_supports_sync_io from zarr.core.buffer import Buffer from zarr.core.buffer.cpu import Buffer as CPUBuffer from zarr.core.buffer.cpu import buffer_prototype from zarr.storage import LocalStore, MemoryStore, WrapperStore, ZipStore from zarr.testing.store import LatencyStore, StoreTests if TYPE_CHECKING: from pathlib import Path from zarr.core.buffer.core import BufferPrototype class StoreKwargs(TypedDict): store: LocalStore class OpenKwargs(TypedDict): store_cls: type[LocalStore] root: str # TODO: fix this warning @pytest.mark.filterwarnings( "ignore:coroutine 'ClientCreatorContext.__aexit__' was never awaited:RuntimeWarning" ) class TestWrapperStore(StoreTests[WrapperStore[Any], Buffer]): store_cls = WrapperStore buffer_cls = CPUBuffer async def get(self, store: WrapperStore[LocalStore], key: str) -> Buffer: return self.buffer_cls.from_bytes((store._store.root / key).read_bytes()) async def set(self, store: WrapperStore[LocalStore], key: str, value: Buffer) -> None: parent = (store._store.root / key).parent if not parent.exists(): parent.mkdir(parents=True) (store._store.root / key).write_bytes(value.to_bytes()) @pytest.fixture def store_kwargs(self, tmp_path: Path) -> StoreKwargs: return {"store": LocalStore(str(tmp_path))} @pytest.fixture def open_kwargs(self, tmp_path: Path) -> OpenKwargs: return {"store_cls": LocalStore, "root": str(tmp_path)} def test_store_supports_writes(self, store: WrapperStore[LocalStore]) -> None: assert store.supports_writes def test_store_supports_listing(self, store: WrapperStore[LocalStore]) -> None: assert store.supports_listing def test_store_repr(self, store: WrapperStore[LocalStore]) -> None: assert f"{store!r}" == f"WrapperStore(LocalStore, 'file://{store._store.root.as_posix()}')" def test_store_str(self, store: WrapperStore[LocalStore]) -> None: assert str(store) == f"wrapping-file://{store._store.root.as_posix()}" def test_check_writeable(self, store: WrapperStore[LocalStore]) -> None: """ Test _check_writeable() runs without errors. """ store._check_writable() def test_close(self, store: WrapperStore[LocalStore]) -> None: "Test store can be closed" store.close() assert not store._is_open def test_is_open_setter_raises(self, store: WrapperStore[LocalStore]) -> None: """ Test that a user cannot change `_is_open` without opening the underlying store. """ with pytest.raises( NotImplementedError, match="WrapperStore must be opened via the `_open` method" ): store._is_open = True # TODO: work out where warning is coming from and fix @pytest.mark.filterwarnings( "ignore:coroutine 'ClientCreatorContext.__aexit__' was never awaited:RuntimeWarning" ) @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=True) async def test_wrapped_set(store: Store, capsys: pytest.CaptureFixture[str]) -> None: # define a class that prints when it sets class NoisySetter(WrapperStore[Store]): async def set(self, key: str, value: Buffer) -> None: print(f"setting {key}") await super().set(key, value) key = "foo" value = CPUBuffer.from_bytes(b"bar") store_wrapped = NoisySetter(store) await store_wrapped.set(key, value) captured = capsys.readouterr() assert f"setting {key}" in captured.out assert await store_wrapped.get(key, buffer_prototype) == value @pytest.mark.filterwarnings("ignore:Unclosed client session:ResourceWarning") @pytest.mark.parametrize("store", ["local", "memory", "zip"], indirect=True) async def test_wrapped_get(store: Store, capsys: pytest.CaptureFixture[str]) -> None: # define a class that prints when it sets class NoisyGetter(WrapperStore[Any]): async def get( self, key: str, prototype: BufferPrototype, byte_range: ByteRequest | None = None ) -> None: print(f"getting {key}") await super().get(key, prototype=prototype, byte_range=byte_range) key = "foo" value = CPUBuffer.from_bytes(b"bar") store_wrapped = NoisyGetter(store) await store_wrapped.set(key, value) await store_wrapped.get(key, buffer_prototype) captured = capsys.readouterr() assert f"getting {key}" in captured.out @pytest.mark.parametrize( ("store_factory", "expected"), [ (lambda tmp: MemoryStore(), True), (lambda tmp: LocalStore(str(tmp)), True), (lambda tmp: WrapperStore(MemoryStore()), True), (lambda tmp: LatencyStore(MemoryStore()), True), (lambda tmp: ZipStore(tmp / "store.zip", mode="w"), False), (lambda tmp: WrapperStore(ZipStore(tmp / "store.zip", mode="w")), False), ], ids=[ "memory", "local", "wrapper-of-memory", "latency-wrapper-of-memory", "zip", "wrapper-of-zip", ], ) def test_supports_sync_io(store_factory: Any, expected: bool, tmp_path: Path | Any) -> None: """`_store_supports_sync_io` is True only for stores implementing the full sync surface (get_sync + set_sync + delete_sync); wrappers forward the wrapped store's capability via `_supports_sync_io`.""" assert _store_supports_sync_io(store_factory(tmp_path)) is expected def test_wrapper_get_sync_without_inner_sync_raises(tmp_path: Any) -> None: store = WrapperStore(ZipStore(tmp_path / "store.zip", mode="w")) with pytest.raises(TypeError, match="does not support synchronous get"): store.get_sync("key") def test_wrapper_set_sync_without_inner_sync_raises(tmp_path: Any) -> None: store = WrapperStore(ZipStore(tmp_path / "store.zip", mode="w")) with pytest.raises(TypeError, match="does not support synchronous set"): store.set_sync("key", CPUBuffer.from_bytes(b"data")) def test_wrapper_delete_sync_without_inner_sync_raises(tmp_path: Any) -> None: store = WrapperStore(ZipStore(tmp_path / "store.zip", mode="w")) with pytest.raises(TypeError, match="does not support synchronous delete"): store.delete_sync("key") zarr-python-3.3.0/tests/test_store/test_zip.py000066400000000000000000000366341523267620000216010ustar00rootroot00000000000000from __future__ import annotations import io import os import pickle import shutil import tempfile import zipfile from typing import TYPE_CHECKING import numpy as np import pytest from hypothesis import settings from hypothesis.stateful import ( RuleBasedStateMachine, initialize, precondition, rule, run_state_machine_as_test, ) import zarr from zarr import create_array from zarr.core.buffer import Buffer, cpu, default_buffer_prototype from zarr.core.sync import sync from zarr.storage import ZipStore from zarr.testing.store import StoreTests if TYPE_CHECKING: from pathlib import Path from typing import Any # TODO: work out where this is coming from and fix pytestmark = [ pytest.mark.filterwarnings( "ignore:coroutine method 'aclose' of 'ZipStore.list' was never awaited:RuntimeWarning" ) ] class TestZipStore(StoreTests[ZipStore, cpu.Buffer]): store_cls = ZipStore buffer_cls = cpu.Buffer @pytest.fixture def store_kwargs(self) -> dict[str, str | bool]: fd, temp_path = tempfile.mkstemp() os.close(fd) os.unlink(temp_path) return {"path": temp_path, "mode": "w", "read_only": False} async def get(self, store: ZipStore, key: str) -> Buffer: buf = store._get(key, prototype=default_buffer_prototype()) assert buf is not None return buf async def set(self, store: ZipStore, key: str, value: Buffer) -> None: return store._set(key, value) def test_store_read_only(self, store: ZipStore) -> None: assert not store.read_only async def test_read_only_store_raises(self, store_kwargs: dict[str, Any]) -> None: # we need to create the zipfile in write mode before switching to read mode store = await self.store_cls.open(**store_kwargs) store.close() kwargs = {**store_kwargs, "mode": "a", "read_only": True} store = await self.store_cls.open(**kwargs) assert store._zmode == "a" assert store.read_only # set with pytest.raises(ValueError): await store.set("foo", cpu.Buffer.from_bytes(b"bar")) def test_store_repr(self, store: ZipStore) -> None: assert str(store) == f"zip://{store.path}" def test_store_supports_writes(self, store: ZipStore) -> None: assert store.supports_writes def test_store_supports_listing(self, store: ZipStore) -> None: assert store.supports_listing # TODO: fix this warning @pytest.mark.filterwarnings("ignore:Unclosed client session:ResourceWarning") def test_api_integration(self, store: ZipStore) -> None: root = zarr.open_group(store=store, mode="a") data = np.arange(10000, dtype=np.uint16).reshape(100, 100) z = root.create_array( shape=data.shape, chunks=(10, 10), name="foo", dtype=np.uint16, fill_value=99 ) z[:] = data assert np.array_equal(data, z[:]) # you can overwrite existing chunks but zipfile will issue a warning with pytest.warns(UserWarning, match="Duplicate name: 'foo/c/0/0'"): z[0, 0] = 100 # TODO: assigning an entire chunk to fill value ends up deleting the chunk which is not supported # a work around will be needed here. with pytest.raises(NotImplementedError): z[0:10, 0:10] = 99 bar = root.create_group("bar", attributes={"hello": "world"}) assert "hello" in dict(bar.attrs) # keys cannot be deleted with pytest.raises(NotImplementedError): del root["bar"] store.close() @pytest.mark.parametrize("read_only", [True, False]) async def test_store_open_read_only( self, store_kwargs: dict[str, Any], read_only: bool ) -> None: if read_only: # create an empty zipfile with zipfile.ZipFile(store_kwargs["path"], mode="w"): pass await super().test_store_open_read_only(store_kwargs, read_only) @pytest.mark.parametrize(("zip_mode", "read_only"), [("w", False), ("a", False), ("x", False)]) async def test_zip_open_mode_translation( self, store_kwargs: dict[str, Any], zip_mode: str, read_only: bool ) -> None: kws = {**store_kwargs, "mode": zip_mode} store = await self.store_cls.open(**kws) assert store.read_only == read_only def test_externally_zipped_store(self, tmp_path: Path) -> None: # See: https://github.com/zarr-developers/zarr-python/issues/2757 zarr_path = tmp_path / "foo.zarr" root = zarr.open_group(store=zarr_path, mode="w") root.require_group("foo") foo = root.get_group("foo") foo["bar"] = np.array([1]) shutil.make_archive(str(zarr_path), "zip", zarr_path) zip_path = tmp_path / "foo.zarr.zip" zipped = zarr.open_group(ZipStore(zip_path, mode="r"), mode="r") assert list(zipped.keys()) == list(root.keys()) group = zipped.get_group("foo") assert list(group.keys()) == list(group.keys()) async def test_list_without_explicit_open(self, tmp_path: Path) -> None: # ZipStore.list(), list_dir(), and exists() should auto-open # the zip file just like _get() and _set() do. zip_path = tmp_path / "data.zip" zarr_path = tmp_path / "foo.zarr" root = zarr.open_group(store=zarr_path, mode="w") root["x"] = np.array([1, 2, 3]) shutil.make_archive(str(zarr_path), "zip", zarr_path) shutil.move(f"{zarr_path}.zip", zip_path) store = ZipStore(zip_path, mode="r") assert not store._is_open keys = [k async for k in store.list()] assert len(keys) > 0 store2 = ZipStore(zip_path, mode="r") assert not store2._is_open assert await store2.exists(keys[0]) store3 = ZipStore(zip_path, mode="r") assert not store3._is_open dir_keys = [k async for k in store3.list_dir("")] assert len(dir_keys) > 0 async def test_move(self, tmp_path: Path) -> None: origin = tmp_path / "origin.zip" destination = tmp_path / "some_folder" / "destination.zip" store = await ZipStore.open(path=origin, mode="a") array = create_array(store, data=np.arange(10)) await store.move(str(destination)) assert store.path == destination assert destination.exists() assert not origin.exists() assert np.array_equal(array[...], np.arange(10)) class TestZipStoreFileObj: """ZipStore backed by an open binary file-like object instead of a path.""" @pytest.fixture def zip_bytes(self, tmp_path: Path) -> bytes: path = tmp_path / "data.zip" store = ZipStore(path, mode="w") zarr.create_array(store, data=np.arange(10), chunks=(5,)) store.close() return path.read_bytes() def test_read_from_fileobj(self, zip_bytes: bytes) -> None: # an existing archive can be read through any seekable binary reader store = ZipStore(io.BytesIO(zip_bytes), mode="r") array = zarr.open_array(store, mode="r") assert np.array_equal(array[...], np.arange(10)) assert store.path is None def test_write_to_fileobj(self) -> None: # a writable file object receives the archive; the bytes it holds # after close() are a complete, reopenable zip buffer = io.BytesIO() store = ZipStore(buffer, mode="w", read_only=False) zarr.create_array(store, data=np.arange(4)) store.close() roundtrip = ZipStore(io.BytesIO(buffer.getvalue()), mode="r") array = zarr.open_array(roundtrip, mode="r") assert np.array_equal(array[...], np.arange(4)) async def test_clear_unsupported(self, zip_bytes: bytes) -> None: # clear() requires a filesystem location, so it raises a clear error # for file-object-backed stores store = ZipStore(io.BytesIO(zip_bytes), mode="a", read_only=False) store._sync_open() with pytest.raises(NotImplementedError, match="clear.*file-like"): await store.clear() async def test_move_unsupported(self, zip_bytes: bytes) -> None: # move() requires a filesystem location, so it raises a clear error # for file-object-backed stores store = ZipStore(io.BytesIO(zip_bytes), mode="a", read_only=False) store._sync_open() with pytest.raises(NotImplementedError, match="move.*file-like"): await store.move("elsewhere.zip") def test_invalid_file_object_rejected(self) -> None: # objects without read/seek/tell are rejected at construction, not # deep inside zipfile with pytest.raises(TypeError, match="read/seek/tell"): ZipStore(42, mode="r") # type: ignore[arg-type] @pytest.mark.parametrize("mode", ["w", "a", "x"]) def test_non_iobase_reader_write_modes_rejected(self, zip_bytes: bytes, mode: str) -> None: # readers that are not io.IOBase instances are adapted for reading # only; write modes are rejected at construction with a clear error class MinimalReader: def __init__(self, data: bytes) -> None: self._buffer = io.BytesIO(data) def read(self, size: int, /) -> bytes: return self._buffer.read(size) def seek(self, pos: int, whence: int = 0, /) -> int: return self._buffer.seek(pos, whence) def tell(self) -> int: return self._buffer.tell() with pytest.raises(TypeError, match="opened for reading"): ZipStore(MinimalReader(zip_bytes), mode=mode, read_only=False) # type: ignore[arg-type] def test_fsspec_file(self, tmp_path: Path, zip_bytes: bytes) -> None: # a file opened through fsspec (already an io.IOBase) is used directly; # fsspec's local filesystem stands in for a remote one fsspec = pytest.importorskip("fsspec") path = tmp_path / "fsspec.zip" path.write_bytes(zip_bytes) with fsspec.open(f"local://{path}", "rb") as fileobj: store = ZipStore(fileobj, mode="r") array = zarr.open_array(store, mode="r") assert np.array_equal(array[...], np.arange(10)) assert store.path is None def test_obstore_reader(self, tmp_path: Path, zip_bytes: bytes) -> None: # obstore's ReadableFile is not an io.IOBase and its read() returns a # buffer-protocol object; ZipStore adapts it via _RawReaderAdapter obstore = pytest.importorskip("obstore") from obstore.store import LocalStore as ObstoreLocalStore (tmp_path / "obstore.zip").write_bytes(zip_bytes) reader = obstore.open_reader(ObstoreLocalStore(str(tmp_path)), "obstore.zip") store = ZipStore(reader, mode="r") array = zarr.open_array(store, mode="r") assert np.array_equal(array[...], np.arange(10)) def test_raw_reader_adapter_eof(self) -> None: from zarr.storage._zip import _RawReaderAdapter class MinimalReader: """Non-io.IOBase reader exposing only read/seek/tell, like obstore.""" def __init__(self, data: bytes) -> None: self._buffer = io.BytesIO(data) def read(self, size: int, /) -> bytes: return self._buffer.read(size) def seek(self, pos: int, whence: int = 0, /) -> int: return self._buffer.seek(pos, whence) def tell(self) -> int: return self._buffer.tell() # the adapter must clamp reads to EOF: some readers (obstore < 0.6) # raise on short reads instead of returning fewer bytes data = b"0123456789" adapter = _RawReaderAdapter(MinimalReader(data)) # type: ignore[arg-type] # A read straddling EOF returns only the remaining bytes. adapter.seek(len(data) - 3) buf = bytearray(8) assert adapter.readinto(buf) == 3 assert bytes(buf[:3]) == data[-3:] # A read at EOF returns 0. assert adapter.tell() == len(data) assert adapter.readinto(bytearray(8)) == 0 def test_pickle_fileobj_raises(self, zip_bytes: bytes) -> None: # an open file object cannot be reliably serialized, so pickling a # file-object-backed store raises with a pointer at the alternative store = ZipStore(io.BytesIO(zip_bytes), mode="r") with pytest.raises(TypeError, match="cannot pickle a ZipStore backed by a file-like"): pickle.dumps(store) def test_pickle_path_backed_roundtrip(self, tmp_path: Path, zip_bytes: bytes) -> None: # path-backed stores remain picklable: the path is serialized and the # archive is reopened on unpickling path = tmp_path / "pickled.zip" path.write_bytes(zip_bytes) store = ZipStore(path, mode="r") unpickled = pickle.loads(pickle.dumps(store)) array = zarr.open_array(unpickled, mode="r") assert np.array_equal(array[...], np.arange(10)) def test_str_and_eq(self, zip_bytes: bytes) -> None: # file-object-backed stores stringify with the object repr and # compare equal only when backed by the very same file object fileobj = io.BytesIO(zip_bytes) store = ZipStore(fileobj, mode="r") assert str(store).startswith("zip://<") assert store == ZipStore(fileobj, mode="r") assert store != ZipStore(io.BytesIO(zip_bytes), mode="r") class ZipStoreLifecycleMachine(RuleBasedStateMachine): """Drive a ZipStore through construct / open / write / close transitions. Invariant under test: a constructed ZipStore can always be closed without raising, regardless of whether it was ever opened or did any I/O. This is a property-based generalization of the former example-based regression tests for ZipStore.close() being called on a never-opened store (which raised AttributeError because ``_lock`` is created lazily in ``_sync_open``). """ def __init__(self, tmp_path: Path) -> None: super().__init__() self._tmp_path = tmp_path self._counter = 0 self.store: ZipStore | None = None self._opened = False @initialize() def start(self) -> None: self.store = None self._opened = False @precondition(lambda self: self.store is None) @rule() def construct(self) -> None: # Fresh path each time so mode="w" never clobbers a closed archive. self._counter += 1 self.store = ZipStore(self._tmp_path / f"s{self._counter}.zip", mode="w") self._opened = False @precondition(lambda self: self.store is not None and not self._opened) @rule() def open(self) -> None: assert self.store is not None self.store._sync_open() self._opened = True @precondition(lambda self: self.store is not None and not self._opened) @rule() def write(self) -> None: assert self.store is not None # store.set auto-opens the store. sync(self.store.set("a", cpu.Buffer.from_bytes(b"hi"))) self._opened = True @precondition(lambda self: self.store is not None) @rule() def close(self) -> None: assert self.store is not None # The property under test: close() must never raise, even with no # prior open or I/O. self.store.close() self.store = None self._opened = False def test_zipstore_close_lifecycle(tmp_path: Path) -> None: run_state_machine_as_test( # type: ignore[no-untyped-call] lambda: ZipStoreLifecycleMachine(tmp_path), settings=settings(max_examples=50, deadline=None), ) zarr-python-3.3.0/tests/test_sync.py000066400000000000000000000114611523267620000175470ustar00rootroot00000000000000import asyncio from collections.abc import AsyncGenerator from unittest.mock import AsyncMock, patch import pytest import zarr from zarr.core.sync import ( SyncError, SyncMixin, _get_executor, _get_lock, _get_loop, cleanup_resources, loop, sync, ) @pytest.fixture(params=[True, False]) def sync_loop(request: pytest.FixtureRequest) -> asyncio.AbstractEventLoop | None: if request.param is True: return _get_loop() else: return None @pytest.fixture def clean_state(): # use this fixture to make sure no existing threads/loops exist in zarr.core.sync cleanup_resources() yield cleanup_resources() def test_get_loop() -> None: # test that calling _get_loop() twice returns the same loop loop = _get_loop() loop2 = _get_loop() assert loop is loop2 def test_get_lock() -> None: # test that calling _get_lock() twice returns the same lock lock = _get_lock() lock2 = _get_lock() assert lock is lock2 def test_sync(sync_loop: asyncio.AbstractEventLoop | None) -> None: foo = AsyncMock(return_value="foo") assert sync(foo(), loop=sync_loop) == "foo" foo.assert_awaited_once() def test_sync_raises(sync_loop: asyncio.AbstractEventLoop | None) -> None: foo = AsyncMock(side_effect=ValueError("foo-bar")) with pytest.raises(ValueError, match="foo-bar"): sync(foo(), loop=sync_loop) foo.assert_awaited_once() def test_sync_timeout() -> None: duration = 0.02 async def foo() -> None: await asyncio.sleep(duration) with pytest.raises(asyncio.TimeoutError): sync(foo(), timeout=duration / 10) def test_sync_raises_if_no_coroutine(sync_loop: asyncio.AbstractEventLoop | None) -> None: def foo() -> str: return "foo" with pytest.raises(TypeError): sync(foo(), loop=sync_loop) # type: ignore[arg-type] @pytest.mark.filterwarnings("ignore:coroutine.*was never awaited") def test_sync_raises_if_loop_is_closed() -> None: loop = _get_loop() foo = AsyncMock(return_value="foo") with patch.object(loop, "is_closed", return_value=True): with pytest.raises(RuntimeError): sync(foo(), loop=loop) foo.assert_not_awaited() @pytest.mark.filterwarnings("ignore:Unclosed client session:ResourceWarning") @pytest.mark.filterwarnings("ignore:coroutine.*was never awaited") def test_sync_raises_if_calling_sync_from_within_a_running_loop( sync_loop: asyncio.AbstractEventLoop | None, ) -> None: def foo() -> str: # technically, this should be an async function but doing that # yields a warning because it is never awaited by the inner function return "foo" async def bar() -> str: return sync(foo(), loop=sync_loop) # type: ignore[arg-type] with pytest.raises(SyncError): sync(bar(), loop=sync_loop) @pytest.mark.filterwarnings("ignore:coroutine.*was never awaited") def test_sync_raises_if_loop_is_invalid_type() -> None: foo = AsyncMock(return_value="foo") with pytest.raises(TypeError): sync(foo(), loop=1) # type: ignore[arg-type] foo.assert_not_awaited() def test_sync_mixin(sync_loop) -> None: class AsyncFoo: def __init__(self) -> None: pass async def foo(self) -> str: return "foo" async def bar(self) -> AsyncGenerator: for i in range(10): yield i class SyncFoo(SyncMixin): def __init__(self, async_foo: AsyncFoo) -> None: self._async_foo = async_foo def foo(self) -> str: return self._sync(self._async_foo.foo()) def bar(self) -> list[int]: return self._sync_iter(self._async_foo.bar()) async_foo = AsyncFoo() foo = SyncFoo(async_foo) assert foo.foo() == "foo" assert foo.bar() == list(range(10)) @pytest.mark.parametrize("workers", [None, 1, 2]) def test_threadpool_executor(clean_state, workers: int | None) -> None: with zarr.config.set({"threading.max_workers": workers}): _ = zarr.zeros(shape=(1,)) # trigger executor creation assert loop != [None] # confirm loop was created if workers is None: # confirm no executor was created if no workers were specified # (this is the default behavior) assert loop[0]._default_executor is None else: # confirm executor was created and attached to loop as the default executor # note: python doesn't have a direct way to get the default executor so we # use the private attribute assert _get_executor() is loop[0]._default_executor assert _get_executor()._max_workers == workers def test_cleanup_resources_idempotent() -> None: _get_executor() # trigger resource creation (iothread, loop, thread-pool) cleanup_resources() cleanup_resources() zarr-python-3.3.0/tests/test_tree.py000066400000000000000000000061551523267620000175360ustar00rootroot00000000000000import textwrap from typing import Any import pytest import zarr @pytest.mark.parametrize("root_name", [None, "root"]) @pytest.mark.parametrize("atty", [True, False]) @pytest.mark.parametrize("plain", [True, False]) def test_tree(root_name: Any, atty: bool, plain: bool, monkeypatch: pytest.MonkeyPatch) -> None: monkeypatch.setattr("sys.stdout.isatty", lambda: atty) if atty and not plain: BOPEN = "\x1b[1m" BCLOSE = "\x1b[0m" else: BOPEN = "" BCLOSE = "" g = zarr.group(path=root_name) A = g.create_group("A") B = g.create_group("B") C = B.create_group("C") D = C.create_group("C") A.create_array(name="x", shape=(2), dtype="float64") A.create_array(name="y", shape=(0,), dtype="int8") B.create_array(name="x", shape=(0,), dtype="float64") C.create_array(name="x", shape=(0,), dtype="float64") D.create_array(name="x", shape=(0,), dtype="float64") result = repr(g.tree(plain=plain)) root = root_name or "" expected = textwrap.dedent(f"""\ {BOPEN}/{root}{BCLOSE} ├── {BOPEN}A{BCLOSE} │ ├── {BOPEN}x{BCLOSE} (2,) float64 │ └── {BOPEN}y{BCLOSE} (0,) int8 └── {BOPEN}B{BCLOSE} ├── {BOPEN}C{BCLOSE} │ ├── {BOPEN}C{BCLOSE} │ │ └── {BOPEN}x{BCLOSE} (0,) float64 │ └── {BOPEN}x{BCLOSE} (0,) float64 └── {BOPEN}x{BCLOSE} (0,) float64 """) assert result == expected result = repr(g.tree(level=0, plain=plain)) expected = textwrap.dedent(f"""\ {BOPEN}/{root}{BCLOSE} ├── {BOPEN}A{BCLOSE} └── {BOPEN}B{BCLOSE} """) assert result == expected if not plain: tree = g.tree(plain=False) bundle = tree._repr_mimebundle_() assert "text/plain" in bundle assert "text/html" in bundle assert "A" in bundle["text/html"] assert "x" in bundle["text/html"] assert " None: g = zarr.group() g.create_group("a") g.create_group("b") g.create_group("c") g.create_group("d") g.create_group("e") result = repr(g.tree(max_nodes=3, plain=True)) assert "Truncated at max_nodes=3" in result # Should show exactly 3 nodes (lines with ── connectors). lines = result.strip().split("\n") node_lines = [line for line in lines if "──" in line] assert len(node_lines) == 3 # Full tree should not show truncation message. full = repr(g.tree(max_nodes=500, plain=True)) assert "truncated" not in full def test_tree_html_escaping() -> None: g = zarr.group() g.create_group("") tree = g.tree() bundle = tree._repr_mimebundle_() assert "<img" in bundle["text/html"] assert "" in bundle["text/plain"] def test_expand_not_implemented() -> None: g = zarr.group() with pytest.raises(NotImplementedError): g.tree(expand=True) zarr-python-3.3.0/tests/test_unified_chunk_grid.py000066400000000000000000003011551523267620000224150ustar00rootroot00000000000000""" Tests for the unified ChunkGrid design (POC). Tests the core ChunkGrid with FixedDimension/VaryingDimension internals, ChunkSpec, serialization round-trips, indexing with rectilinear grids, and end-to-end array creation + read/write. """ from __future__ import annotations from typing import TYPE_CHECKING, Any import numpy as np import pytest import zarr from zarr.core.chunk_grids import ( ChunkGrid, ChunkSpec, FixedDimension, VaryingDimension, _is_rectilinear_chunks, ) from zarr.core.common import compress_rle, expand_rle from zarr.core.metadata.v3 import ( RectilinearChunkGridMetadata, RectilinearChunkGridMetadataJSON, RegularChunkGridMetadata, parse_chunk_grid, ) from zarr.errors import BoundsCheckError from zarr.storage import MemoryStore if TYPE_CHECKING: from collections.abc import Generator from pathlib import Path @pytest.fixture(autouse=True) def _enable_rectilinear_chunks() -> Generator[None, None, None]: """Enable rectilinear chunks for all tests in this module.""" with zarr.config.set({"array.rectilinear_chunks": True}): yield def _edges(grid: ChunkGrid, dim: int) -> tuple[int, ...]: """Extract the per-chunk edge lengths for *dim* from a ChunkGrid.""" d = grid._dimensions[dim] if isinstance(d, FixedDimension): return tuple(d.size for _ in range(d.nchunks)) if isinstance(d, VaryingDimension): return tuple(d.edges) raise TypeError(f"Unexpected dimension type: {type(d)}") # --------------------------------------------------------------------------- # Dimension index_to_chunk bounds tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("dim", "index", "match"), [ (VaryingDimension([10, 20, 30], extent=60), 60, "out of bounds"), (VaryingDimension([10, 20, 30], extent=60), 100, "out of bounds"), (FixedDimension(size=10, extent=95), 95, "out of bounds"), (FixedDimension(size=10, extent=95), -1, "Negative"), ], ids=[ "varying-at-extent", "varying-past-extent", "fixed-at-extent", "fixed-negative", ], ) def test_dimension_index_to_chunk_bounds( dim: FixedDimension | VaryingDimension, index: int, match: str ) -> None: """Out-of-bounds or negative indices raise IndexError for both dimension types""" with pytest.raises(IndexError, match=match): dim.index_to_chunk(index) @pytest.mark.parametrize( ("dim", "index", "expected"), [ (VaryingDimension([10, 20, 30], extent=60), 59, 2), (FixedDimension(size=10, extent=95), 94, 9), ], ids=["varying-last-valid", "fixed-last-valid"], ) def test_dimension_index_to_chunk_last_valid( dim: FixedDimension | VaryingDimension, index: int, expected: int ) -> None: """Last valid index maps to the correct chunk for both dimension types""" assert dim.index_to_chunk(index) == expected # --------------------------------------------------------------------------- # Rectilinear feature flag tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( "action", [ lambda: RectilinearChunkGridMetadata(chunk_shapes=((10, 20), (25, 25))), lambda: RectilinearChunkGridMetadata.from_dict( { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[10, 20, 30], [50, 50]]}, } ), lambda: zarr.create_array(MemoryStore(), shape=(30,), chunks=[[10, 20]], dtype="int32"), ], ids=["constructor", "from_dict", "create_array"], ) def test_rectilinear_feature_flag_blocked(action: Any) -> None: """Rectilinear chunk operations raise ValueError when the feature flag is disabled""" with zarr.config.set({"array.rectilinear_chunks": False}): with pytest.raises(ValueError, match="experimental and disabled by default"): action() def test_rectilinear_feature_flag_enabled() -> None: """Rectilinear chunk grid construction succeeds when the feature flag is enabled""" with zarr.config.set({"array.rectilinear_chunks": True}): grid = RectilinearChunkGridMetadata(chunk_shapes=((10, 20), (25, 25))) assert grid.ndim == 2 # --------------------------------------------------------------------------- # FixedDimension tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ( "size", "extent", "chunk_ix", "expected_nchunks", "expected_chunk_size", "expected_data_size", "expected_offset", ), [ (10, 100, 0, 10, 10, 10, 0), (10, 100, 1, 10, 10, 10, 10), (10, 100, 9, 10, 10, 10, 90), (10, 95, 9, 10, 10, 5, 90), # boundary chunk (0, 0, None, 0, None, None, None), # zero-size ], ids=["start", "middle", "end", "boundary", "zero-size"], ) def test_fixed_dimension( size: int, extent: int, chunk_ix: int | None, expected_nchunks: int, expected_chunk_size: int | None, expected_data_size: int | None, expected_offset: int | None, ) -> None: """FixedDimension properties match expected values for various chunk/extent combinations""" d = FixedDimension(size=size, extent=extent) assert d.nchunks == expected_nchunks if chunk_ix is not None: assert d.chunk_size(chunk_ix) == expected_chunk_size assert d.data_size(chunk_ix) == expected_data_size assert d.chunk_offset(chunk_ix) == expected_offset @pytest.mark.parametrize( ("idx", "expected"), [(0, 0), (9, 0), (10, 1), (25, 2)], ) def test_fixed_dimension_index_to_chunk(idx: int, expected: int) -> None: """FixedDimension.index_to_chunk maps element indices to correct chunk indices""" d = FixedDimension(size=10, extent=100) assert d.index_to_chunk(idx) == expected def test_fixed_dimension_indices_to_chunks() -> None: """FixedDimension.indices_to_chunks vectorizes index-to-chunk mapping over an array""" d = FixedDimension(size=10, extent=100) indices = np.array([0, 5, 10, 15, 99]) np.testing.assert_array_equal(d.indices_to_chunks(indices), [0, 0, 1, 1, 9]) @pytest.mark.parametrize( ("size", "extent", "match"), [(-1, 100, "must be >= 0"), (10, -1, "must be >= 0")], ids=["negative-size", "negative-extent"], ) def test_fixed_dimension_rejects_negative(size: int, extent: int, match: str) -> None: """FixedDimension raises ValueError for negative size or extent""" with pytest.raises(ValueError, match=match): FixedDimension(size=size, extent=extent) # --------------------------------------------------------------------------- # VaryingDimension tests # --------------------------------------------------------------------------- def test_varying_dimension_construction() -> None: """VaryingDimension stores edges, cumulative sums, nchunks, and extent correctly""" d = VaryingDimension([10, 20, 30], extent=60) assert d.edges == (10, 20, 30) assert d.cumulative == (10, 30, 60) assert d.nchunks == 3 assert d.extent == 60 @pytest.mark.parametrize( ( "chunk_idx", "expected_offset", "expected_size", "expected_data", "expected_chunk_for_first_idx", ), [ (0, 0, 10, 10, 0), (1, 10, 20, 20, 1), (2, 30, 30, 30, 2), ], ) def test_varying_dimension( chunk_idx: int, expected_offset: int, expected_size: int, expected_data: int, expected_chunk_for_first_idx: int, ) -> None: """VaryingDimension chunk_offset, chunk_size, data_size, and index_to_chunk return correct values""" d = VaryingDimension([10, 20, 30], extent=60) assert d.chunk_offset(chunk_idx) == expected_offset assert d.chunk_size(chunk_idx) == expected_size assert d.data_size(chunk_idx) == expected_data assert d.index_to_chunk(expected_offset) == expected_chunk_for_first_idx def test_varying_dimension_indices_to_chunks() -> None: """VaryingDimension.indices_to_chunks vectorizes index-to-chunk mapping over an array""" d = VaryingDimension([10, 20, 30], extent=60) indices = np.array([0, 9, 10, 29, 30, 59]) np.testing.assert_array_equal(d.indices_to_chunks(indices), [0, 0, 1, 1, 2, 2]) @pytest.mark.parametrize( ("edges", "extent", "match"), [ ([], 0, "must not be empty"), ([10, 0, 5], 15, "must be > 0"), ], ids=["empty", "zero-edge"], ) def test_varying_dimension_rejects_invalid(edges: list[int], extent: int, match: str) -> None: """VaryingDimension raises ValueError for empty edges or zero-length edges""" with pytest.raises(ValueError, match=match): VaryingDimension(edges, extent=extent) # --------------------------------------------------------------------------- # ChunkSpec tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("slices", "codec_shape", "expected_shape", "expected_boundary"), [ ((slice(0, 10), slice(0, 20)), (10, 20), (10, 20), False), ((slice(90, 95), slice(0, 20)), (10, 20), (5, 20), True), ((slice(10, 10),), (0,), (0,), False), ((slice(0, 10), slice(0, 5)), (10, 10), (10, 5), True), ], ids=["basic", "boundary", "empty-slices", "multidim-boundary"], ) def test_chunk_spec( slices: tuple[slice, ...], codec_shape: tuple[int, ...], expected_shape: tuple[int, ...], expected_boundary: bool, ) -> None: """ChunkSpec reports correct shape and boundary status from slices and codec_shape""" spec = ChunkSpec(slices=slices, codec_shape=codec_shape) assert spec.shape == expected_shape assert spec.is_boundary == expected_boundary # --------------------------------------------------------------------------- # ChunkGrid construction tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("array_shape", "chunk_sizes", "expected_regular", "expected_ndim", "expected_chunk_shape"), [ ((100, 200), (10, 20), True, 2, (10, 20)), ((), (), True, 0, ()), ((60, 100), [[10, 20, 30], [25, 25, 25, 25]], False, 2, None), ((30, 50), [[10, 10, 10], [25, 25]], True, 2, (10, 25)), # uniform edges → regular ], ids=["regular", "zero-dim", "rectilinear", "uniform-becomes-regular"], ) def test_chunk_grid_construction( array_shape: tuple[int, ...], chunk_sizes: Any, expected_regular: bool, expected_ndim: int, expected_chunk_shape: tuple[int, ...] | None, ) -> None: """ChunkGrid.from_sizes produces grids with correct regularity, ndim, and chunk_shape""" g = ChunkGrid.from_sizes(array_shape, chunk_sizes) assert g.is_regular == expected_regular assert g.ndim == expected_ndim if expected_chunk_shape is not None: assert g.chunk_shape == expected_chunk_shape else: with pytest.raises(ValueError, match="only available for regular"): _ = g.chunk_shape def test_chunk_grid_rectilinear_uniform_dim_is_fixed() -> None: """A rectilinear grid with all-same sizes in one dim stores it as Fixed.""" g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [25, 25, 25, 25]]) assert isinstance(g._dimensions[0], VaryingDimension) assert isinstance(g._dimensions[1], FixedDimension) # --------------------------------------------------------------------------- # ChunkGrid query tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("shape", "chunks", "expected_grid_shape"), [ ((100, 200), (10, 20), (10, 10)), ((95, 200), (10, 20), (10, 10)), ((60, 100), [[10, 20, 30], [25, 25, 25, 25]], (3, 4)), ], ids=["regular", "regular-boundary", "rectilinear"], ) def test_chunk_grid_shape( shape: tuple[int, ...], chunks: Any, expected_grid_shape: tuple[int, ...], ) -> None: """ChunkGrid.grid_shape returns the expected number of chunks per dimension""" g = ChunkGrid.from_sizes(shape, chunks) assert g.grid_shape == expected_grid_shape @pytest.mark.parametrize( ( "array_shape", "chunk_sizes", "coords", "expected_shape", "expected_codec_shape", "expected_boundary", ), [ # regular interior ((100, 200), (10, 20), (0, 0), (10, 20), (10, 20), False), # regular boundary ((95, 200), (10, 20), (9, 0), (5, 20), (10, 20), True), # rectilinear ((60, 100), [[10, 20, 30], [25, 25, 25, 25]], (0, 0), (10, 25), (10, 25), False), ((60, 100), [[10, 20, 30], [25, 25, 25, 25]], (1, 0), (20, 25), (20, 25), False), ((60, 100), [[10, 20, 30], [25, 25, 25, 25]], (2, 3), (30, 25), (30, 25), False), ], ids=["regular", "regular-boundary", "rectilinear-0,0", "rectilinear-1,0", "rectilinear-2,3"], ) def test_chunk_grid_getitem( array_shape: tuple[int, ...], chunk_sizes: Any, coords: tuple[int, ...], expected_shape: tuple[int, ...], expected_codec_shape: tuple[int, ...], expected_boundary: bool, ) -> None: """ChunkGrid.__getitem__ returns a ChunkSpec with correct shape, codec_shape, and boundary flag""" g = ChunkGrid.from_sizes(array_shape, chunk_sizes) spec = g[coords] assert spec is not None assert spec.shape == expected_shape assert spec.codec_shape == expected_codec_shape assert spec.is_boundary == expected_boundary @pytest.mark.parametrize( ("array_shape", "chunk_sizes", "coords"), [ ((100, 200), (10, 20), (99, 0)), ((60, 100), [[10, 20, 30], [25, 25, 25, 25]], (3, 0)), ], ids=["regular-oob", "rectilinear-oob"], ) def test_chunk_grid_getitem_oob( array_shape: tuple[int, ...], chunk_sizes: Any, coords: tuple[int, ...] ) -> None: """Out-of-bounds chunk coordinates return None""" g = ChunkGrid.from_sizes(array_shape, chunk_sizes) assert g[coords] is None def test_chunk_grid_getitem_slices() -> None: """ChunkSpec.slices reflect the correct start/stop for a rectilinear chunk""" g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [25, 25, 25, 25]]) spec = g[(1, 2)] assert spec is not None assert spec.slices == (slice(10, 30, 1), slice(50, 75, 1)) # -- all_chunk_coords tests -- @pytest.mark.parametrize( ("array_shape", "chunk_sizes", "origin", "selection_shape", "expected_coords"), [ # rectilinear grid ( (60, 100), [[10, 20, 30], [50, 50]], None, None, [(0, 0), (0, 1), (1, 0), (1, 1), (2, 0), (2, 1)], ), ((60, 100), [[10, 20, 30], [50, 50]], (1, 0), None, [(1, 0), (1, 1), (2, 0), (2, 1)]), ((60, 100), [[10, 20, 30], [50, 50]], None, (2, 1), [(0, 0), (1, 0)]), ((60, 100), [[10, 20, 30], [50, 50]], (1, 1), (2, 1), [(1, 1), (2, 1)]), # regular grid ((30, 40), (10, 20), (2, 1), None, [(2, 1)]), ((30, 40), (10, 20), None, (0, 0), []), ((60, 80), (20, 20), (0, 2), (3, 1), [(0, 2), (1, 2), (2, 2)]), ], ids=[ "all", "with-origin", "with-sel-shape", "origin+sel", "last-chunk", "zero-sel", "single-dim", ], ) def test_all_chunk_coords( array_shape: tuple[int, ...], chunk_sizes: Any, origin: tuple[int, ...] | None, selection_shape: tuple[int, ...] | None, expected_coords: list[tuple[int, ...]], ) -> None: """all_chunk_coords yields the expected coordinates with optional origin and selection_shape""" g = ChunkGrid.from_sizes(array_shape, chunk_sizes) kwargs: dict[str, Any] = {} if origin is not None: kwargs["origin"] = origin if selection_shape is not None: kwargs["selection_shape"] = selection_shape assert list(g.all_chunk_coords(**kwargs)) == expected_coords def test_chunk_grid_get_nchunks() -> None: """get_nchunks returns the total number of chunks across all dimensions""" g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) assert g.get_nchunks() == 6 def test_chunk_grid_iter() -> None: """Iterating a ChunkGrid yields the correct number of ChunkSpec objects""" g = ChunkGrid.from_sizes((30, 40), (10, 20)) specs = list(g) assert len(specs) == 6 assert all(isinstance(s, ChunkSpec) for s in specs) # --------------------------------------------------------------------------- # RLE tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("compressed", "expected"), [ ([[10, 3]], [10, 10, 10]), ([[10, 2], [20, 1]], [10, 10, 20]), ], ) def test_rle_expand(compressed: list[Any], expected: list[int]) -> None: """RLE-encoded edges expand correctly""" assert expand_rle(compressed) == expected @pytest.mark.parametrize( ("original", "expected"), [ ([10, 10, 10], [[10, 3]]), ([10, 10, 20], [[10, 2], 20]), ([5], [5]), ([10, 20, 30], [10, 20, 30]), ], ) def test_rle_compress(original: list[int], expected: list[Any]) -> None: """compress_rle produces the expected RLE encoding for various input sequences""" assert compress_rle(original) == expected def test_rle_roundtrip() -> None: """compress_rle followed by expand_rle recovers the original sequence""" original = [10, 10, 10, 20, 20, 30] compressed = compress_rle(original) assert expand_rle(compressed) == original @pytest.mark.parametrize( ("rle_input", "match"), [ ([0], "Chunk edge length must be >= 1"), ([-5], "Chunk edge length must be >= 1"), ([[0, 3]], "Chunk edge length must be >= 1"), ([[-10, 2]], "Chunk edge length must be >= 1"), ([[5, 0]], "RLE repeat count must be >= 1"), ([[5, -1]], "RLE repeat count must be >= 1"), ], ids=[ "zero-edge", "negative-edge", "zero-rle-size", "negative-rle-size", "zero-rle-count", "negative-rle-count", ], ) def test_rle_expand_rejects_invalid(rle_input: list[Any], match: str) -> None: """expand_rle raises ValueError for zero/negative edge lengths or repeat counts""" with pytest.raises(ValueError, match=match): expand_rle(rle_input) # -- expand_rle handles JSON floats -- def test_expand_rle_bare_integer_floats_accepted() -> None: """JSON parsers may emit 10.0 for the integer 10; expand_rle should handle it.""" result = expand_rle([10.0, 20.0]) # type: ignore[list-item] assert result == [10, 20] def test_expand_rle_pair_with_float_count() -> None: """expand_rle accepts float repeat counts that are integer-valued""" result = expand_rle([[10, 3.0]]) # type: ignore[list-item] assert result == [10, 10, 10] # --------------------------------------------------------------------------- # _is_rectilinear_chunks tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("value", "expected"), [ ([[10, 20], [5, 5]], True), (((10, 20), (5, 5)), True), ((10, 20), False), ([10, 20], False), (10, False), ("auto", False), ([], False), ([[]], True), (ChunkGrid.from_sizes((10,), (5,)), False), (None, False), (3.14, False), ], ids=[ "nested-lists", "nested-tuples", "flat-tuple", "flat-list", "single-int", "string", "empty-list", "empty-nested-list", "chunk-grid-instance", "none", "float", ], ) def test_is_rectilinear_chunks(value: Any, expected: bool) -> None: """_is_rectilinear_chunks correctly identifies nested sequences as rectilinear""" assert _is_rectilinear_chunks(value) is expected def test_is_rectilinear_chunks_handles_broken_iterable() -> None: """_is_rectilinear_chunks returns False for objects that raise on iteration.""" class BrokenIter: def __iter__(self) -> Any: raise TypeError("cannot iterate") assert _is_rectilinear_chunks(BrokenIter()) is False # --------------------------------------------------------------------------- # Serialization tests # --------------------------------------------------------------------------- def test_serialization_error_non_regular_chunk_shape() -> None: """Accessing chunk_shape on a non-regular grid raises ValueError.""" grid = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [25, 25, 25, 25]]) with pytest.raises(ValueError, match="only available for regular"): grid.chunk_shape # noqa: B018 def test_serialization_error_zero_extent_rectilinear() -> None: """RectilinearChunkGridMetadata rejects empty edge tuples.""" with pytest.raises(ValueError, match="has no chunk edges"): RectilinearChunkGridMetadata(chunk_shapes=((),)) def test_serialization_unknown_name_parse() -> None: """Parsing metadata with an unknown chunk grid name raises ValueError""" with pytest.raises(ValueError, match="Unknown chunk grid"): parse_chunk_grid({"name": "hexagonal", "configuration": {}}) def test_from_metadata_unknown_chunk_grid_type() -> None: """ChunkGrid.from_metadata raises TypeError for unrecognised chunk grid metadata.""" from unittest.mock import MagicMock from zarr.core.metadata.v3 import ArrayV3Metadata mock_meta = MagicMock(spec=ArrayV3Metadata) mock_meta.chunk_grid = MagicMock() # not Regular or Rectilinear with pytest.raises(TypeError, match="Unknown chunk grid metadata type"): ChunkGrid.from_metadata(mock_meta) def test_from_sizes_rejects_empty_edge_list() -> None: """ChunkGrid.from_sizes raises ValueError when a dimension has an empty edge list.""" with pytest.raises(ValueError, match="at least one chunk"): ChunkGrid.from_sizes((10,), ([],)) # --------------------------------------------------------------------------- # Spec compliance tests # --------------------------------------------------------------------------- def test_spec_kind_inline_required_on_deserialize() -> None: """Deserialization requires kind: 'inline'.""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"chunk_shapes": [[10, 20], [15, 15]]}, } with pytest.raises(ValueError, match="requires a 'kind' field"): parse_chunk_grid(data) def test_spec_kind_unknown_rejected() -> None: """Unsupported rectilinear chunk grid kind raises ValueError on parse""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "reference", "chunk_shapes": [[10, 20], [15, 15]]}, } with pytest.raises(ValueError, match="Unsupported rectilinear chunk grid kind"): parse_chunk_grid(data) def test_spec_integer_shorthand_per_dimension() -> None: """A bare integer in chunk_shapes means repeat until >= extent.""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [4, [1, 2, 3]]}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) g = ChunkGrid.from_sizes((6, 6), meta.chunk_shapes) assert _edges(g, 0) == (4, 4) assert _edges(g, 1) == (1, 2, 3) def test_spec_mixed_rle_and_bare_integers() -> None: """An array can mix bare integers and [value, count] RLE pairs.""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[[1, 3], 3]]}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) g = ChunkGrid.from_sizes((6,), meta.chunk_shapes) assert _edges(g, 0) == (1, 1, 1, 3) def test_spec_overflow_chunks_allowed() -> None: """Edge sum >= extent is valid (overflow chunks permitted).""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[4, 4, 4]]}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) g = ChunkGrid.from_sizes((6,), meta.chunk_shapes) assert _edges(g, 0) == (4, 4, 4) def test_spec_example() -> None: """The full example from the spec README.""" data: dict[str, Any] = { "name": "rectilinear", "configuration": { "kind": "inline", "chunk_shapes": [ 4, [1, 2, 3], [[4, 2]], [[1, 3], 3], [4, 4, 4], ], }, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) g = ChunkGrid.from_sizes((6, 6, 6, 6, 6), meta.chunk_shapes) assert _edges(g, 0) == (4, 4) assert _edges(g, 1) == (1, 2, 3) assert _edges(g, 2) == (4, 4) assert _edges(g, 3) == (1, 1, 1, 3) assert _edges(g, 4) == (4, 4, 4) # --------------------------------------------------------------------------- # parse_chunk_grid validation tests # --------------------------------------------------------------------------- def test_parse_chunk_grid_varying_extent_mismatch_raises() -> None: """Reconstructing a ChunkGrid with mismatched extents raises ValueError""" g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) with pytest.raises(ValueError, match="extent"): ChunkGrid( dimensions=tuple( dim.with_extent(ext) for dim, ext in zip(g._dimensions, (100, 100), strict=True) ) ) def test_parse_chunk_grid_varying_extent_match_ok() -> None: """Reconstructing a ChunkGrid with matching extents succeeds""" g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) g2 = ChunkGrid( dimensions=tuple( dim.with_extent(ext) for dim, ext in zip(g._dimensions, (60, 100), strict=True) ) ) assert g2._dimensions[0].extent == 60 @pytest.mark.parametrize( ("chunk_shapes", "array_shape", "match"), [ ([[10, 20, 30], [25, 25]], (100, 50), "extent 100 exceeds sum of edges 60"), ([[50, 50], [10, 20]], (100, 50), "extent 50 exceeds sum of edges 30"), ], ids=["first-dim-mismatch", "second-dim-mismatch"], ) def test_parse_chunk_grid_rectilinear_extent_mismatch_raises( chunk_shapes: list[list[int]], array_shape: tuple[int, ...], match: str ) -> None: """Rectilinear grid raises ValueError when array extent exceeds sum of edges""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": chunk_shapes}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) with pytest.raises(ValueError, match=match): ChunkGrid.from_sizes(array_shape, meta.chunk_shapes) def test_parse_chunk_grid_rectilinear_extent_match_passes() -> None: """Rectilinear grid with matching extents parses and builds successfully""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[10, 20, 30], [25, 25]]}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) g = ChunkGrid.from_sizes((60, 50), meta.chunk_shapes) assert g.grid_shape == (3, 2) def test_parse_chunk_grid_rectilinear_ndim_mismatch_raises() -> None: """Mismatched ndim between array shape and chunk_sizes raises ValueError""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[10, 20], [25, 25]]}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) with pytest.raises(ValueError, match="3 dimensions but chunk_sizes has 2"): ChunkGrid.from_sizes((30, 50, 100), meta.chunk_shapes) def test_parse_chunk_grid_rectilinear_rle_extent_validated() -> None: """RLE-encoded edges are expanded before validation.""" data: dict[str, Any] = { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[[10, 5]], [[25, 2]]]}, } meta = parse_chunk_grid(data) assert isinstance(meta, RectilinearChunkGridMetadata) g = ChunkGrid.from_sizes((50, 50), meta.chunk_shapes) assert g.grid_shape == (5, 2) with pytest.raises(ValueError, match="extent 100 exceeds sum of edges 50"): ChunkGrid.from_sizes((100, 50), meta.chunk_shapes) def test_parse_chunk_grid_varying_dimension_extent_mismatch_on_chunkgrid_input() -> None: """ChunkGrid constructor rejects VaryingDimension with extent exceeding sum of edges""" g = ChunkGrid.from_sizes((60, 50), [[10, 20, 30], [25, 25]]) with pytest.raises(ValueError, match="less than"): ChunkGrid( dimensions=tuple( dim.with_extent(ext) for dim, ext in zip(g._dimensions, (100, 50), strict=True) ) ) # --------------------------------------------------------------------------- # Rectilinear indexing tests # --------------------------------------------------------------------------- def test_basic_indexer_rectilinear() -> None: """BasicIndexer produces correct projections for a full-slice rectilinear selection""" from zarr.core.indexing import BasicIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) indexer = BasicIndexer( selection=(slice(None), slice(None)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) assert len(projections) == 6 p0 = projections[0] assert p0.chunk_coords == (0, 0) assert p0.chunk_selection == (slice(0, 10, 1), slice(0, 50, 1)) p1 = projections[2] assert p1.chunk_coords == (1, 0) assert p1.chunk_selection == (slice(0, 20, 1), slice(0, 50, 1)) def test_basic_indexer_int_selection() -> None: """BasicIndexer with integer selection maps to the correct chunk and local offset""" from zarr.core.indexing import BasicIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) indexer = BasicIndexer( selection=(15, slice(None)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) assert len(projections) == 2 assert projections[0].chunk_coords == (1, 0) assert projections[0].chunk_selection == (5, slice(0, 50, 1)) def test_basic_indexer_slice_subset() -> None: """BasicIndexer with partial slices spans the expected chunk dimensions""" from zarr.core.indexing import BasicIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) indexer = BasicIndexer( selection=(slice(5, 35), slice(0, 50)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) chunk_coords_dim0 = sorted({p.chunk_coords[0] for p in projections}) assert chunk_coords_dim0 == [0, 1, 2] def test_orthogonal_indexer_rectilinear() -> None: """OrthogonalIndexer produces the expected number of projections for a rectilinear grid""" from zarr.core.indexing import OrthogonalIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) indexer = OrthogonalIndexer( selection=(slice(None), slice(None)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) assert len(projections) == 6 def test_oob_block_raises_bounds_check_error() -> None: """Out-of-bounds block index should raise BoundsCheckError, not IndexError.""" store = MemoryStore() a = zarr.create_array(store, shape=(30,), chunks=[[10, 20]], dtype="int32") with pytest.raises(BoundsCheckError): a.get_block_selection((2,)) # --------------------------------------------------------------------------- # End-to-end tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("shape", "chunks", "expected_regular"), [ ((100, 200), (10, 20), True), ((60, 100), [[10, 20, 30], [50, 50]], False), ], ids=["regular", "rectilinear"], ) def test_e2e_create_array( tmp_path: Path, shape: tuple[int, ...], chunks: Any, expected_regular: bool ) -> None: """End-to-end array creation sets correct regularity and ndim on chunk_grid""" arr = zarr.create_array( store=tmp_path / "arr.zarr", shape=shape, chunks=chunks, dtype="float32", ) assert ChunkGrid.from_metadata(arr.metadata).is_regular == expected_regular assert ChunkGrid.from_metadata(arr.metadata).ndim == len(shape) @pytest.mark.parametrize( ("shape", "chunks", "grid_type_name", "grid_name"), [ ((100, 200), (10, 20), "RegularChunkGridMetadata", "regular"), ((60, 100), [[10, 20, 30], [50, 50]], "RectilinearChunkGridMetadata", "rectilinear"), ], ids=["regular", "rectilinear"], ) def test_e2e_chunk_grid_serializes( tmp_path: Path, shape: tuple[int, ...], chunks: Any, grid_type_name: str, grid_name: str ) -> None: """Array metadata serializes chunk_grid with the correct type and name""" from zarr.core.metadata.v3 import ( ArrayV3Metadata, RectilinearChunkGridMetadata, RegularChunkGridMetadata, ) grid_type = ( RegularChunkGridMetadata if grid_type_name == "RegularChunkGridMetadata" else RectilinearChunkGridMetadata ) arr = zarr.create_array( store=tmp_path / "arr.zarr", shape=shape, chunks=chunks, dtype="float32", ) assert isinstance(arr.metadata, ArrayV3Metadata) assert isinstance(arr.metadata.chunk_grid, grid_type) d = arr.metadata.to_dict() chunk_grid_dict = d["chunk_grid"] assert isinstance(chunk_grid_dict, dict) assert chunk_grid_dict["name"] == grid_name def test_e2e_chunk_grid_name_roundtrip_preserves_rectilinear(tmp_path: Path) -> None: """A rectilinear grid with uniform edges stays 'rectilinear' through to_dict/from_dict.""" from zarr.core.metadata.v3 import ArrayV3Metadata, RectilinearChunkGridMetadata meta_dict: dict[str, Any] = { "zarr_format": 3, "node_type": "array", "shape": [100, 100], "chunk_grid": { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[[50, 2]], [[25, 4]]]}, }, "chunk_key_encoding": {"name": "default"}, "data_type": "float32", "fill_value": 0.0, "codecs": [{"name": "bytes", "configuration": {"endian": "little"}}], } meta = ArrayV3Metadata.from_dict(meta_dict) assert isinstance(meta.chunk_grid, RectilinearChunkGridMetadata) d = meta.to_dict() chunk_grid_dict = d["chunk_grid"] assert isinstance(chunk_grid_dict, dict) assert chunk_grid_dict["name"] == "rectilinear" def test_e2e_chunk_grid_name_regular_from_dict(tmp_path: Path) -> None: """A 'regular' chunk grid name is preserved through from_dict.""" from zarr.core.metadata.v3 import ArrayV3Metadata, RegularChunkGridMetadata meta_dict: dict[str, Any] = { "zarr_format": 3, "node_type": "array", "shape": [100, 100], "chunk_grid": { "name": "regular", "configuration": {"chunk_shape": [50, 25]}, }, "chunk_key_encoding": {"name": "default"}, "data_type": "float32", "fill_value": 0.0, "codecs": [{"name": "bytes", "configuration": {"endian": "little"}}], } meta = ArrayV3Metadata.from_dict(meta_dict) assert isinstance(meta.chunk_grid, RegularChunkGridMetadata) d = meta.to_dict() chunk_grid_dict = d["chunk_grid"] assert isinstance(chunk_grid_dict, dict) assert chunk_grid_dict["name"] == "regular" # --------------------------------------------------------------------------- # Sharding compatibility tests # --------------------------------------------------------------------------- def test_sharding_accepts_rectilinear_outer_grid() -> None: """ShardingCodec.validate should not reject rectilinear outer grids.""" from zarr.codecs.sharding import ShardingCodec from zarr.core.dtype import Float32 from zarr.core.metadata.v3 import RectilinearChunkGridMetadata codec = ShardingCodec(chunk_shape=(5, 5)) grid_meta = RectilinearChunkGridMetadata(chunk_shapes=((10, 20, 30), (50, 50))) codec.validate( shape=(60, 100), dtype=Float32(), chunk_grid=grid_meta, ) def test_sharding_rejects_non_divisible_rectilinear() -> None: """Rectilinear shard sizes not divisible by inner chunk_shape should raise.""" from zarr.codecs.sharding import ShardingCodec from zarr.core.dtype import Float32 from zarr.core.metadata.v3 import RectilinearChunkGridMetadata codec = ShardingCodec(chunk_shape=(5, 5)) grid_meta = RectilinearChunkGridMetadata(chunk_shapes=((10, 20, 17), (50, 50))) with pytest.raises(ValueError, match="divisible"): codec.validate( shape=(47, 100), dtype=Float32(), chunk_grid=grid_meta, ) def test_sharding_accepts_divisible_rectilinear() -> None: """Rectilinear shard sizes all divisible by inner chunk_shape should pass.""" from zarr.codecs.sharding import ShardingCodec from zarr.core.dtype import Float32 from zarr.core.metadata.v3 import RectilinearChunkGridMetadata codec = ShardingCodec(chunk_shape=(5, 5)) grid_meta = RectilinearChunkGridMetadata(chunk_shapes=((10, 20, 30), (50, 50))) codec.validate( shape=(60, 100), dtype=Float32(), chunk_grid=grid_meta, ) def test_sharding_rejects_non_divisible_among_repeated_edges() -> None: """Shard validation catches a non-divisible edge even among many repeated valid ones.""" from zarr.codecs.sharding import ShardingCodec from zarr.core.dtype import Float32 from zarr.core.metadata.v3 import RectilinearChunkGridMetadata # edges (10, 10, 7) — 7 is not divisible by 5 codec = ShardingCodec(chunk_shape=(5,)) grid_meta = RectilinearChunkGridMetadata(chunk_shapes=((10, 10, 7),)) with pytest.raises(ValueError, match="divisible"): codec.validate(shape=(27,), dtype=Float32(), chunk_grid=grid_meta) def test_sharding_accepts_all_repeated_divisible_edges() -> None: """Shard validation passes when all distinct edges are divisible by inner chunk size.""" from zarr.codecs.sharding import ShardingCodec from zarr.core.dtype import Float32 from zarr.core.metadata.v3 import RectilinearChunkGridMetadata # edges (10, 10, 20, 10) — unique values {10, 20}, both divisible by 5 codec = ShardingCodec(chunk_shape=(5,)) grid_meta = RectilinearChunkGridMetadata(chunk_shapes=((10, 10, 20, 10),)) codec.validate(shape=(50,), dtype=Float32(), chunk_grid=grid_meta) # --------------------------------------------------------------------------- # Edge cases # --------------------------------------------------------------------------- def test_edge_case_chunk_grid_boundary_getitem() -> None: """ChunkGrid with boundary FixedDimension via direct construction.""" g = ChunkGrid(dimensions=(FixedDimension(10, 95), FixedDimension(20, 40))) spec = g[(9, 1)] assert spec is not None assert spec.shape == (5, 20) assert spec.codec_shape == (10, 20) assert spec.is_boundary def test_edge_case_chunk_grid_boundary_iter() -> None: """Iterating a boundary grid yields correct boundary ChunkSpecs.""" g = ChunkGrid(dimensions=(FixedDimension(10, 25),)) specs = list(g) assert len(specs) == 3 assert specs[0].shape == (10,) assert specs[1].shape == (10,) assert specs[2].shape == (5,) assert specs[2].is_boundary assert not specs[0].is_boundary def test_edge_case_chunk_grid_boundary_shape() -> None: """shape property with boundary extent.""" g = ChunkGrid(dimensions=(FixedDimension(10, 95),)) assert g.grid_shape == (10,) # -- Zero-size and zero-extent -- @pytest.mark.parametrize( ("size", "extent"), [(0, 0), (0, 5), (10, 0)], ids=["zero-size-zero-extent", "zero-size-nonzero-extent", "zero-extent-nonzero-size"], ) def test_edge_case_zero_size_or_extent(size: int, extent: int) -> None: """FixedDimension with zero size or extent has zero chunks and getitem returns None""" d = FixedDimension(size=size, extent=extent) assert d.nchunks == 0 g = ChunkGrid(dimensions=(d,)) assert g[0] is None def test_edge_case_zero_size_data_and_indices() -> None: """FixedDimension(size=0) handles data_size, index_to_chunk, and indices_to_chunks safely.""" d = FixedDimension(size=0, extent=0) # Zero-sized chunks have zero data assert d.data_size(0) == 0 # Vectorized lookup maps every index to chunk 0 (avoids division by zero) indices = np.array([0, 0, 0], dtype=np.intp) np.testing.assert_array_equal(d.indices_to_chunks(indices), np.zeros(3, dtype=np.intp)) def test_edge_case_zero_size_nonzero_extent_index() -> None: """FixedDimension(size=0, extent>0) maps valid indices to chunk 0 without dividing by zero.""" d = FixedDimension(size=0, extent=5) assert d.nchunks == 0 # index_to_chunk avoids division by zero and returns 0 assert d.index_to_chunk(0) == 0 assert d.index_to_chunk(4) == 0 def test_edge_case_zero_size_data_and_index() -> None: """FixedDimension(size=0) returns zero for data_size and maps indices to chunk 0.""" d = FixedDimension(size=0, extent=0) # data_size returns 0 for a zero-sized chunk assert d.data_size(0) == 0 # vectorized indices_to_chunks returns zeros indices = np.array([0, 0, 0], dtype=np.intp) np.testing.assert_array_equal(d.indices_to_chunks(indices), np.zeros(3, dtype=np.intp)) # -- 0-d grid -- def test_0d_grid_getitem() -> None: """0-d grid has exactly one chunk at coords ().""" g = ChunkGrid.from_sizes((), ()) spec = g[()] assert spec is not None assert spec.shape == () assert spec.codec_shape == () assert not spec.is_boundary def test_0d_grid_iter() -> None: """0-d grid iteration yields a single ChunkSpec.""" g = ChunkGrid.from_sizes((), ()) specs = list(g) assert len(specs) == 1 def test_0d_grid_all_chunk_coords() -> None: """0-d grid has one chunk coord: the empty tuple.""" g = ChunkGrid.from_sizes((), ()) coords = list(g.all_chunk_coords()) assert coords == [()] def test_0d_grid_nchunks() -> None: """0-d grid reports exactly one chunk""" g = ChunkGrid.from_sizes((), ()) assert g.get_nchunks() == 1 # -- parse_chunk_grid edge cases -- def test_parse_chunk_grid_preserves_varying_extent() -> None: """parse_chunk_grid does not overwrite VaryingDimension extent.""" g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) assert isinstance(g._dimensions[0], VaryingDimension) assert g._dimensions[0].extent == 60 g2 = ChunkGrid( dimensions=tuple( dim.with_extent(ext) for dim, ext in zip(g._dimensions, (60, 100), strict=True) ) ) assert isinstance(g2._dimensions[0], VaryingDimension) assert g2._dimensions[0].extent == 60 def test_parse_chunk_grid_rebinds_fixed_extent() -> None: """parse_chunk_grid updates FixedDimension extent from array shape.""" g = ChunkGrid.from_sizes((100, 200), (10, 20)) assert g._dimensions[0].extent == 100 g2 = ChunkGrid( dimensions=tuple( dim.with_extent(ext) for dim, ext in zip(g._dimensions, (50, 100), strict=True) ) ) assert isinstance(g2._dimensions[0], FixedDimension) assert g2._dimensions[0].extent == 50 assert g2.grid_shape == (5, 5) # -- ChunkGrid.__getitem__ validation -- def test_getitem_int_1d_regular() -> None: """Integer indexing works for 1-d regular grids.""" g = ChunkGrid.from_sizes((100,), (10,)) spec = g[0] assert spec is not None assert spec.shape == (10,) assert spec.slices == (slice(0, 10, 1),) spec = g[9] assert spec is not None assert spec.shape == (10,) def test_getitem_int_1d_rectilinear() -> None: """Integer indexing works for 1-d rectilinear grids.""" g = ChunkGrid.from_sizes((100,), [[20, 30, 50]]) spec = g[0] assert spec is not None assert spec.shape == (20,) spec = g[1] assert spec is not None assert spec.shape == (30,) spec = g[2] assert spec is not None assert spec.shape == (50,) @pytest.mark.parametrize( ("shape", "chunks", "match"), [ ((), (), "Expected 0 coordinate.*got 1"), ((100, 200), (10, 20), "Expected 2 coordinate.*got 1"), ], ids=["0d", "2d"], ) def test_getitem_int_ndim_mismatch_raises( shape: tuple[int, ...], chunks: tuple[int, ...], match: str ) -> None: """Integer indexing on a multi-dim or 0-d grid raises ValueError for ndim mismatch""" g = ChunkGrid.from_sizes(shape, chunks) with pytest.raises(ValueError, match=match): g[0] @pytest.mark.parametrize( "index", [(10,), (99,), (-1,)], ids=["oob-10", "oob-99", "negative"], ) def test_getitem_oob_returns_none(index: tuple[int, ...]) -> None: """Out-of-bounds or negative chunk indices return None""" g = ChunkGrid.from_sizes((100,), (10,)) assert g[index] is None # -- Rectilinear with zero-nchunks FixedDimension -- def test_zero_nchunks_fixed_dim_in_rectilinear() -> None: """A rectilinear grid with a 0-extent FixedDimension still has valid size.""" g = ChunkGrid( dimensions=( VaryingDimension([10, 20], extent=30), FixedDimension(size=10, extent=0), ) ) assert g.grid_shape == (2, 0) # -- VaryingDimension data_size -- def test_varying_dim_data_size_equals_chunk_size() -> None: """For VaryingDimension, data_size == chunk_size (no padding).""" d = VaryingDimension([10, 20, 5], extent=35) for i in range(3): assert d.data_size(i) == d.chunk_size(i) # --------------------------------------------------------------------------- # OrthogonalIndexer rectilinear tests # --------------------------------------------------------------------------- def test_orthogonal_int_array_selection_rectilinear() -> None: """Integer array selection with rectilinear grid must produce correct chunk-local selections.""" from zarr.core.indexing import OrthogonalIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) indexer = OrthogonalIndexer( selection=(np.array([5, 15, 35]), slice(None)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) chunk_coords = [p.chunk_coords for p in projections] assert chunk_coords == [(0, 0), (0, 1), (1, 0), (1, 1), (2, 0), (2, 1)] def test_orthogonal_bool_array_selection_rectilinear() -> None: """Boolean array selection with rectilinear grid produces correct chunk projections.""" from zarr.core.indexing import OrthogonalIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) mask = np.zeros(60, dtype=bool) mask[5] = True mask[15] = True mask[35] = True indexer = OrthogonalIndexer( selection=(mask, slice(None)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) assert len(projections) == 6 chunk_coords = [p.chunk_coords for p in projections] assert (0, 0) in chunk_coords assert (1, 0) in chunk_coords assert (2, 0) in chunk_coords assert (0, 1) in chunk_coords assert (1, 1) in chunk_coords assert (2, 1) in chunk_coords def test_orthogonal_advanced_indexing_produces_correct_projections() -> None: """Verify OrthogonalIndexer produces correct chunk projections for advanced indexing with VaryingDimension.""" from zarr.core.indexing import OrthogonalIndexer g = ChunkGrid.from_sizes((60, 100), [[10, 20, 30], [50, 50]]) indexer = OrthogonalIndexer( selection=(np.array([5, 15]), slice(None)), shape=(60, 100), chunk_grid=g, ) projections = list(indexer) assert len(projections) == 4 coords = [p.chunk_coords for p in projections] assert (0, 0) in coords assert (0, 1) in coords assert (1, 0) in coords assert (1, 1) in coords # --------------------------------------------------------------------------- # Full pipeline rectilinear tests (helpers) # --------------------------------------------------------------------------- def _make_1d(tmp_path: Path) -> tuple[zarr.Array[Any], np.ndarray[Any, Any]]: a = np.arange(30, dtype="int32") z = zarr.create_array( store=tmp_path / "arr1d.zarr", shape=(30,), chunks=[[5, 10, 15]], dtype="int32", ) z[:] = a return z, a def _make_2d(tmp_path: Path) -> tuple[zarr.Array[Any], np.ndarray[Any, Any]]: a = np.arange(6000, dtype="int32").reshape(60, 100) z = zarr.create_array( store=tmp_path / "arr2d.zarr", shape=(60, 100), chunks=[[10, 20, 30], [25, 25, 25, 25]], dtype="int32", ) z[:] = a return z, a # --- Basic selection --- def test_pipeline_basic_selection_1d(tmp_path: Path) -> None: """1D rectilinear basic selections match numpy for ints, slices, and full-array reads""" z, a = _make_1d(tmp_path) sels: list[Any] = [0, 4, 5, 14, 15, 29, -1, slice(None), slice(3, 18), slice(0, 0)] for sel in sels: np.testing.assert_array_equal(z[sel], a[sel], err_msg=f"sel={sel}") def test_pipeline_basic_selection_1d_strided(tmp_path: Path) -> None: """1D rectilinear strided slice selections match numpy""" z, a = _make_1d(tmp_path) for sel in [slice(None, None, 2), slice(1, 25, 3), slice(0, 30, 7)]: np.testing.assert_array_equal(z[sel], a[sel], err_msg=f"sel={sel}") def test_pipeline_basic_selection_2d(tmp_path: Path) -> None: """2D rectilinear basic selections match numpy across chunk boundaries""" z, a = _make_2d(tmp_path) selections: list[Any] = [ 42, -1, (9, 24), (10, 25), (30, 50), (59, 99), slice(None), (slice(5, 35), slice(20, 80)), (slice(0, 10), slice(0, 25)), (slice(10, 10), slice(None)), (slice(None, None, 3), slice(None, None, 7)), ] for sel in selections: np.testing.assert_array_equal(z[sel], a[sel], err_msg=f"sel={sel}") # --- Orthogonal selection --- def test_pipeline_orthogonal_selection_1d_bool(tmp_path: Path) -> None: """1D boolean orthogonal indexing on rectilinear arrays matches numpy""" z, a = _make_1d(tmp_path) ix = np.zeros(30, dtype=bool) ix[[0, 4, 5, 14, 15, 29]] = True np.testing.assert_array_equal(z.oindex[ix], a[ix]) def test_pipeline_orthogonal_selection_1d_int(tmp_path: Path) -> None: """1D integer and negative-index orthogonal selection on rectilinear arrays matches numpy""" z, a = _make_1d(tmp_path) ix = np.array([0, 4, 5, 14, 15, 29]) np.testing.assert_array_equal(z.oindex[ix], a[ix]) ix_neg = np.array([0, -1, -15, -25]) np.testing.assert_array_equal(z.oindex[ix_neg], a[ix_neg]) def test_pipeline_orthogonal_selection_2d_bool(tmp_path: Path) -> None: """2D boolean orthogonal selection on rectilinear arrays matches numpy""" z, a = _make_2d(tmp_path) ix0 = np.zeros(60, dtype=bool) ix0[[0, 9, 10, 29, 30, 59]] = True ix1 = np.zeros(100, dtype=bool) ix1[[0, 24, 25, 49, 50, 99]] = True np.testing.assert_array_equal(z.oindex[ix0, ix1], a[np.ix_(ix0, ix1)]) def test_pipeline_orthogonal_selection_2d_int(tmp_path: Path) -> None: """2D integer orthogonal selection on rectilinear arrays matches numpy""" z, a = _make_2d(tmp_path) ix0 = np.array([0, 9, 10, 29, 30, 59]) ix1 = np.array([0, 24, 25, 49, 50, 99]) np.testing.assert_array_equal(z.oindex[ix0, ix1], a[np.ix_(ix0, ix1)]) def test_pipeline_orthogonal_selection_2d_mixed(tmp_path: Path) -> None: """2D mixed int-array and slice orthogonal selection on rectilinear arrays matches numpy""" z, a = _make_2d(tmp_path) ix = np.array([0, 9, 10, 29, 30, 59]) np.testing.assert_array_equal(z.oindex[ix, slice(25, 75)], a[np.ix_(ix, np.arange(25, 75))]) np.testing.assert_array_equal( z.oindex[slice(10, 30), ix[:4]], a[np.ix_(np.arange(10, 30), ix[:4])] ) # --- Coordinate (vindex) selection --- def test_pipeline_coordinate_selection_1d(tmp_path: Path) -> None: """1D coordinate (vindex) selection on rectilinear arrays matches numpy""" z, a = _make_1d(tmp_path) ix = np.array([0, 4, 5, 14, 15, 29]) np.testing.assert_array_equal(z.vindex[ix], a[ix]) def test_pipeline_coordinate_selection_2d(tmp_path: Path) -> None: """2D coordinate (vindex) selection on rectilinear arrays matches numpy""" z, a = _make_2d(tmp_path) r = np.array([0, 9, 10, 29, 30, 59]) c = np.array([0, 24, 25, 49, 50, 99]) np.testing.assert_array_equal(z.vindex[r, c], a[r, c]) def test_pipeline_coordinate_selection_2d_bool_mask(tmp_path: Path) -> None: """2D boolean mask vindex selection on rectilinear arrays matches numpy""" z, a = _make_2d(tmp_path) mask = a > 3000 np.testing.assert_array_equal(z.vindex[mask], a[mask]) # --- Block selection --- def test_pipeline_block_selection_1d(tmp_path: Path) -> None: """1D block selection on rectilinear arrays returns correct chunk data""" z, a = _make_1d(tmp_path) np.testing.assert_array_equal(z.blocks[0], a[0:5]) np.testing.assert_array_equal(z.blocks[1], a[5:15]) np.testing.assert_array_equal(z.blocks[2], a[15:30]) np.testing.assert_array_equal(z.blocks[-1], a[15:30]) np.testing.assert_array_equal(z.blocks[0:2], a[0:15]) np.testing.assert_array_equal(z.blocks[1:3], a[5:30]) np.testing.assert_array_equal(z.blocks[:], a[:]) def test_pipeline_block_selection_2d(tmp_path: Path) -> None: """2D block selection on rectilinear arrays returns correct chunk data""" z, a = _make_2d(tmp_path) np.testing.assert_array_equal(z.blocks[0, 0], a[0:10, 0:25]) np.testing.assert_array_equal(z.blocks[1, 2], a[10:30, 50:75]) np.testing.assert_array_equal(z.blocks[2, 3], a[30:60, 75:100]) np.testing.assert_array_equal(z.blocks[-1, -1], a[30:60, 75:100]) np.testing.assert_array_equal(z.blocks[0:2, 1:3], a[0:30, 25:75]) np.testing.assert_array_equal(z.blocks[:, :], a[:, :]) def test_pipeline_set_block_selection_1d(tmp_path: Path) -> None: """Writing via 1D block selection on rectilinear arrays persists correctly""" z, a = _make_1d(tmp_path) val = np.full(10, -1, dtype="int32") z.blocks[1] = val a[5:15] = val np.testing.assert_array_equal(z[:], a) def test_pipeline_set_block_selection_2d(tmp_path: Path) -> None: """Writing via 2D block selection on rectilinear arrays persists correctly""" z, a = _make_2d(tmp_path) val = np.full((30, 50), -99, dtype="int32") z.blocks[0:2, 1:3] = val a[0:30, 25:75] = val np.testing.assert_array_equal(z[:], a) def test_pipeline_block_selection_slice_stop_at_nchunks(tmp_path: Path) -> None: """Block slice with stop == nchunks exercises the dim_len fallback.""" z, a = _make_1d(tmp_path) np.testing.assert_array_equal(z.blocks[1:3], a[5:30]) np.testing.assert_array_equal(z.blocks[0:10], a[:]) def test_pipeline_block_selection_slice_stop_at_nchunks_2d(tmp_path: Path) -> None: """Same fallback test for 2D rectilinear arrays.""" z, a = _make_2d(tmp_path) np.testing.assert_array_equal(z.blocks[2:3, 3:4], a[30:60, 75:100]) np.testing.assert_array_equal(z.blocks[0:99, 0:99], a[:, :]) # --- Set coordinate selection --- def test_pipeline_set_coordinate_selection_1d(tmp_path: Path) -> None: """Writing via 1D coordinate selection on rectilinear arrays persists correctly""" z, a = _make_1d(tmp_path) ix = np.array([0, 4, 5, 14, 15, 29]) val = np.full(len(ix), -7, dtype="int32") z.vindex[ix] = val a[ix] = val np.testing.assert_array_equal(z[:], a) def test_pipeline_set_coordinate_selection_2d(tmp_path: Path) -> None: """Writing via 2D coordinate selection on rectilinear arrays persists correctly""" z, a = _make_2d(tmp_path) r = np.array([0, 9, 10, 29, 30, 59]) c = np.array([0, 24, 25, 49, 50, 99]) val = np.full(len(r), -42, dtype="int32") z.vindex[r, c] = val a[r, c] = val np.testing.assert_array_equal(z[:], a) # --- Set selection --- def test_pipeline_set_basic_selection(tmp_path: Path) -> None: """Writing via basic slice selection on rectilinear arrays persists correctly""" z, a = _make_2d(tmp_path) new_data = np.full((20, 50), -1, dtype="int32") z[5:25, 10:60] = new_data a[5:25, 10:60] = new_data np.testing.assert_array_equal(z[:], a) def test_pipeline_set_orthogonal_selection(tmp_path: Path) -> None: """Writing via orthogonal selection on rectilinear arrays persists correctly""" z, a = _make_2d(tmp_path) rows = np.array([0, 10, 30]) cols = np.array([0, 25, 50, 75]) val = np.full((3, 4), -99, dtype="int32") z.oindex[rows, cols] = val a[np.ix_(rows, cols)] = val np.testing.assert_array_equal(z[:], a) # --- Higher dimensions --- def test_pipeline_3d_array(tmp_path: Path) -> None: """3D rectilinear array write and read-back match numpy""" shape = (12, 20, 15) chunk_shapes = [[4, 8], [5, 5, 10], [5, 10]] a = np.arange(int(np.prod(shape)), dtype="int32").reshape(shape) z = zarr.create_array( store=tmp_path / "arr3d.zarr", shape=shape, chunks=chunk_shapes, dtype="int32", ) z[:] = a np.testing.assert_array_equal(z[:], a) np.testing.assert_array_equal(z[2:10, 3:18, 4:14], a[2:10, 3:18, 4:14]) def test_pipeline_1d_single_chunk(tmp_path: Path) -> None: """Single-chunk rectilinear array write and read-back match numpy""" a = np.arange(20, dtype="int32") z = zarr.create_array( store=tmp_path / "arr1c.zarr", shape=(20,), chunks=[[20]], dtype="int32", ) z[:] = a np.testing.assert_array_equal(z[:], a) # --- Persistence roundtrip --- def test_pipeline_persistence_roundtrip(tmp_path: Path) -> None: """Rectilinear array survives close and reopen with correct data""" _, a = _make_2d(tmp_path) z2 = zarr.open_array(store=tmp_path / "arr2d.zarr", mode="r") assert not ChunkGrid.from_metadata(z2.metadata).is_regular np.testing.assert_array_equal(z2[:], a) # --- Highly irregular chunks --- def test_pipeline_highly_irregular_chunks(tmp_path: Path) -> None: """Highly irregular chunk sizes produce correct write and partial-read results""" shape = (100, 100) chunk_shapes = [[5, 10, 15, 20, 50], [100]] a = np.arange(10000, dtype="int32").reshape(shape) z = zarr.create_array( store=tmp_path / "irreg.zarr", shape=shape, chunks=chunk_shapes, dtype="int32", ) z[:] = a np.testing.assert_array_equal(z[:], a) np.testing.assert_array_equal(z[3:97, 10:90], a[3:97, 10:90]) # --- API validation --- def test_pipeline_v2_rejects_rectilinear(tmp_path: Path) -> None: """Creating a rectilinear array with zarr_format=2 raises ValueError""" with pytest.raises(ValueError, match="Zarr format 2"): zarr.create_array( store=tmp_path / "v2.zarr", shape=(30,), chunks=[[10, 20]], dtype="int32", zarr_format=2, ) def test_pipeline_sharding_rejects_rectilinear_chunks_with_shards(tmp_path: Path) -> None: """Rectilinear chunks (inner) with sharding is not supported.""" with pytest.raises(ValueError, match="Rectilinear chunks with sharding"): zarr.create_array( store=tmp_path / "shard.zarr", shape=(60, 100), chunks=[[10, 20, 30], [25, 25, 25, 25]], shards=(30, 50), dtype="int32", ) def test_pipeline_rectilinear_shards_roundtrip(tmp_path: Path) -> None: """Rectilinear shards with uniform inner chunks: full write/read roundtrip.""" data = np.arange(120 * 100, dtype="int32").reshape(120, 100) arr = zarr.create_array( store=tmp_path / "rect_shards.zarr", shape=(120, 100), chunks=(10, 10), shards=[[60, 40, 20], [50, 50]], dtype="int32", ) arr[:] = data result = arr[:] np.testing.assert_array_equal(result, data) def test_pipeline_rectilinear_shards_partial_read(tmp_path: Path) -> None: """Partial reads across rectilinear shard boundaries.""" data = np.arange(120 * 100, dtype="float64").reshape(120, 100) arr = zarr.create_array( store=tmp_path / "rect_shards.zarr", shape=(120, 100), chunks=(10, 10), shards=[[60, 40, 20], [50, 50]], dtype="float64", ) arr[:] = data result = arr[50:70, 40:60] np.testing.assert_array_equal(result, data[50:70, 40:60]) def test_pipeline_rectilinear_shards_validates_divisibility(tmp_path: Path) -> None: """Inner chunk_shape must divide every shard's dimensions.""" with pytest.raises(ValueError, match="divisible"): zarr.create_array( store=tmp_path / "bad.zarr", shape=(120, 100), chunks=(10, 10), shards=[[60, 45, 15], [50, 50]], dtype="int32", ) def test_pipeline_nchunks(tmp_path: Path) -> None: """Rectilinear array reports the correct total number of chunks""" z, _ = _make_2d(tmp_path) assert ChunkGrid.from_metadata(z.metadata).get_nchunks() == 12 def test_pipeline_parse_chunk_grid_regular_from_dict() -> None: """parse_chunk_grid constructs a regular grid from a metadata dict.""" d: dict[str, Any] = {"name": "regular", "configuration": {"chunk_shape": [10, 20]}} meta = parse_chunk_grid(d) assert isinstance(meta, RegularChunkGridMetadata) g = ChunkGrid.from_sizes((100, 200), tuple(meta.chunk_shape)) assert g.is_regular assert g.chunk_shape == (10, 20) assert g.grid_shape == (10, 10) assert g.get_nchunks() == 100 # --------------------------------------------------------------------------- # VaryingDimension boundary tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("edges", "extent", "chunk_idx", "expected_data_size"), [ ([10, 20, 30], 50, 0, 10), ([10, 20, 30], 50, 1, 20), ([10, 20, 30], 50, 2, 20), ([10, 20, 30], 60, 2, 30), ([10, 20, 30], 31, 0, 10), ([10, 20, 30], 31, 1, 20), ([10, 20, 30], 31, 2, 1), ], ids=[ "interior-0", "interior-1", "boundary-clipped", "exact-no-clip", "single-element-boundary-0", "single-element-boundary-1", "single-element-boundary-2", ], ) def test_varying_dimension_boundary_data_size( edges: list[int], extent: int, chunk_idx: int, expected_data_size: int ) -> None: """VaryingDimension.data_size clips correctly at boundary chunks""" d = VaryingDimension(edges, extent=extent) assert d.data_size(chunk_idx) == expected_data_size def test_varying_dimension_boundary_extent_parameter() -> None: """VaryingDimension preserves extent and full chunk_size even when extent < sum of edges""" d = VaryingDimension([10, 20, 30], extent=50) assert d.extent == 50 assert d.chunk_size(2) == 30 def test_varying_dimension_extent_exceeds_sum_rejected() -> None: """VaryingDimension rejects extent greater than sum of edges""" with pytest.raises(ValueError, match="exceeds sum of edges"): VaryingDimension([10, 20], extent=50) def test_varying_dimension_negative_extent_rejected() -> None: """VaryingDimension rejects negative extent""" with pytest.raises(ValueError, match="must be >= 0"): VaryingDimension([10, 20], extent=-1) def test_varying_dimension_zero_extent() -> None: """VaryingDimension with extent=0 has zero active chunks but retains all grid cells.""" d = VaryingDimension([10, 20], extent=0) assert d.nchunks == 0 assert d.ngridcells == 2 # No chunks overlap [0, 0), so the grid is structurally non-empty but logically empty g = ChunkGrid(dimensions=(d,)) assert g.grid_shape == (0,) assert list(g) == [] def test_varying_dimension_boundary_chunk_spec() -> None: """ChunkGrid with a boundary VaryingDimension produces correct ChunkSpec.""" g = ChunkGrid(dimensions=(VaryingDimension([10, 20, 30], extent=50),)) spec = g[(2,)] assert spec is not None assert spec.codec_shape == (30,) assert spec.shape == (20,) assert spec.is_boundary is True def test_varying_dimension_interior_chunk_spec() -> None: """Interior VaryingDimension chunk has matching codec_shape and shape with no boundary""" g = ChunkGrid(dimensions=(VaryingDimension([10, 20, 30], extent=50),)) spec = g[(0,)] assert spec is not None assert spec.codec_shape == (10,) assert spec.shape == (10,) assert spec.is_boundary is False # --------------------------------------------------------------------------- # Multiple overflow chunks tests # --------------------------------------------------------------------------- def test_overflow_multiple_chunks_past_extent() -> None: """Edges past extent are structural; nchunks counts active only.""" g = ChunkGrid.from_sizes((50,), [[10, 20, 30, 40]]) d = g._dimensions[0] assert d.ngridcells == 4 assert d.nchunks == 3 assert d.data_size(0) == 10 assert d.data_size(1) == 20 assert d.data_size(2) == 20 assert d.chunk_size(2) == 30 def test_overflow_chunk_spec_past_extent_is_oob() -> None: """Chunk entirely past the extent is out of bounds (not active).""" g = ChunkGrid.from_sizes((50,), [[10, 20, 30, 40]]) spec = g[(3,)] assert spec is None def test_overflow_chunk_spec_partial() -> None: """ChunkSpec for a partially-overflowing chunk clips correctly.""" g = ChunkGrid.from_sizes((50,), [[10, 20, 30, 40]]) spec = g[(2,)] assert spec is not None assert spec.shape == (20,) assert spec.codec_shape == (30,) assert spec.is_boundary is True assert spec.slices == (slice(30, 50, 1),) def test_overflow_chunk_sizes() -> None: """chunk_sizes only includes active chunks.""" g = ChunkGrid.from_sizes((50,), [[10, 20, 30, 40]]) assert g.chunk_sizes == ((10, 20, 20),) def test_overflow_multidim() -> None: """Overflow in multiple dimensions simultaneously.""" g = ChunkGrid.from_sizes((45, 100), [[10, 20, 30], [40, 40, 40]]) assert g.chunk_sizes == ((10, 20, 15), (40, 40, 20)) spec = g[(2, 2)] assert spec is not None assert spec.shape == (15, 20) assert spec.codec_shape == (30, 40) def test_overflow_uniform_edges_collapses_to_fixed() -> None: """Uniform edges where len == ceildiv(extent, edge) collapse to FixedDimension.""" g = ChunkGrid.from_sizes((35,), [[10, 10, 10, 10]]) assert isinstance(g._dimensions[0], FixedDimension) assert g.is_regular assert g.chunk_sizes == ((10, 10, 10, 5),) assert g._dimensions[0].nchunks == 4 def test_overflow_index_to_chunk_near_extent() -> None: """Index lookup near and at the extent boundary.""" d = VaryingDimension([10, 20, 30, 40], extent=50) assert d.index_to_chunk(29) == 1 assert d.index_to_chunk(30) == 2 assert d.index_to_chunk(49) == 2 # --------------------------------------------------------------------------- # Boundary indexing tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ( "dim", "mask", "dim_len", "expected_chunk_ix", "expected_sel_len", "expected_first_two", "expected_third", ), [ ( FixedDimension(size=5, extent=7), np.array([False, False, False, False, False, True, True]), 7, 1, 5, (np.True_, np.True_), np.False_, ), ( VaryingDimension([5, 10], extent=7), np.array([False, False, False, False, False, True, True]), 7, 1, 10, (np.True_, np.True_), np.False_, ), ], ids=["fixed-boundary", "varying-boundary"], ) def test_bool_indexer_boundary( dim: FixedDimension | VaryingDimension, mask: np.ndarray[Any, Any], dim_len: int, expected_chunk_ix: int, expected_sel_len: int, expected_first_two: tuple[Any, Any], expected_third: Any, ) -> None: """BoolArrayDimIndexer pads to codec size for boundary chunks.""" from zarr.core.indexing import BoolArrayDimIndexer indexer = BoolArrayDimIndexer(mask, dim_len, dim) projections = list(indexer) assert len(projections) == 1 p = projections[0] assert p.dim_chunk_ix == expected_chunk_ix sel = p.dim_chunk_sel assert isinstance(sel, np.ndarray) assert sel.shape[0] == expected_sel_len assert sel[0] is expected_first_two[0] assert sel[1] is expected_first_two[1] assert sel[2] is expected_third def test_bool_indexer_no_padding_interior() -> None: """No padding needed for interior chunks.""" from zarr.core.indexing import BoolArrayDimIndexer dim = FixedDimension(size=5, extent=10) mask = np.array([True, False, False, False, False, False, False, False, False, False]) indexer = BoolArrayDimIndexer(mask, 10, dim) projections = list(indexer) assert len(projections) == 1 p = projections[0] assert p.dim_chunk_ix == 0 sel = p.dim_chunk_sel assert isinstance(sel, np.ndarray) assert sel.shape[0] == 5 def test_slice_indexer_varying_boundary() -> None: """SliceDimIndexer clips to data_size at boundary for VaryingDimension.""" from zarr.core.indexing import SliceDimIndexer dim = VaryingDimension([5, 10], extent=7) indexer = SliceDimIndexer(slice(None), 7, dim) projections = list(indexer) assert len(projections) == 2 assert projections[0].dim_chunk_sel == slice(0, 5, 1) assert projections[1].dim_chunk_sel == slice(0, 2, 1) def test_int_array_indexer_varying_boundary() -> None: """IntArrayDimIndexer handles indices near boundary correctly.""" from zarr.core.indexing import IntArrayDimIndexer dim = VaryingDimension([5, 10], extent=7) indices = np.array([6]) indexer = IntArrayDimIndexer(indices, 7, dim) projections = list(indexer) assert len(projections) == 1 assert projections[0].dim_chunk_ix == 1 sel = projections[0].dim_chunk_sel assert isinstance(sel, np.ndarray) np.testing.assert_array_equal(sel, [1]) @pytest.mark.parametrize( "dim", [FixedDimension(size=2, extent=10), VaryingDimension([5, 5], extent=10)], ids=["fixed", "varying"], ) def test_slice_indexer_empty_slice_at_boundary(dim: FixedDimension | VaryingDimension) -> None: """SliceDimIndexer yields no projections for an empty slice at the dimension boundary.""" from zarr.core.indexing import SliceDimIndexer indexer = SliceDimIndexer(slice(10, 10), 10, dim) projections = list(indexer) assert len(projections) == 0 def test_orthogonal_indexer_varying_boundary_advanced() -> None: """OrthogonalIndexer with advanced indexing uses per-chunk chunk_size.""" from zarr.core.indexing import OrthogonalIndexer g = ChunkGrid( dimensions=( VaryingDimension([5, 10], extent=7), FixedDimension(size=4, extent=8), ) ) indexer = OrthogonalIndexer( selection=(np.array([0, 6]), slice(None)), shape=(7, 8), chunk_grid=g, ) projections = list(indexer) assert len(projections) == 4 coords = {p.chunk_coords for p in projections} assert coords == {(0, 0), (0, 1), (1, 0), (1, 1)} # --------------------------------------------------------------------------- # update_shape tests # --------------------------------------------------------------------------- def test_update_shape_no_change() -> None: """update_shape with the same shape preserves edges unchanged""" grid = ChunkGrid.from_sizes((60, 50), [[10, 20, 30], [25, 25]]) new_grid = grid.update_shape((60, 50)) assert _edges(new_grid, 0) == (10, 20, 30) assert _edges(new_grid, 1) == (25, 25) def test_update_shape_grow_single_dim() -> None: """Growing a single dimension appends a new edge chunk""" grid = ChunkGrid.from_sizes((60, 50), [[10, 20, 30], [25, 25]]) new_grid = grid.update_shape((80, 50)) assert _edges(new_grid, 0) == (10, 20, 30, 20) assert _edges(new_grid, 1) == (25, 25) def test_update_shape_grow_multiple_dims() -> None: """Growing multiple dimensions appends correctly sized edge chunks""" grid = ChunkGrid.from_sizes((30, 50), [[10, 20], [20, 30]]) new_grid = grid.update_shape((45, 65)) assert _edges(new_grid, 0) == (10, 20, 15) assert _edges(new_grid, 1) == (20, 30, 15) def test_update_shape_shrink_single_dim() -> None: """Shrinking a single dimension reduces nchunks while preserving edges""" grid = ChunkGrid.from_sizes((100, 50), [[10, 20, 30, 40], [25, 25]]) new_grid = grid.update_shape((35, 50)) assert _edges(new_grid, 0) == (10, 20, 30, 40) assert new_grid._dimensions[0].nchunks == 3 assert _edges(new_grid, 1) == (25, 25) def test_update_shape_shrink_to_single_chunk() -> None: """Shrinking to fit within the first chunk reduces nchunks to 1""" grid = ChunkGrid.from_sizes((60, 50), [[10, 20, 30], [25, 25]]) new_grid = grid.update_shape((5, 50)) assert _edges(new_grid, 0) == (10, 20, 30) assert new_grid._dimensions[0].nchunks == 1 assert _edges(new_grid, 1) == (25, 25) def test_update_shape_shrink_multiple_dims() -> None: """Shrinking multiple dimensions reduces nchunks in each dimension""" grid = ChunkGrid.from_sizes((40, 60), [[10, 10, 15, 5], [20, 25, 15]]) new_grid = grid.update_shape((25, 35)) assert _edges(new_grid, 0) == (10, 10, 15, 5) assert new_grid._dimensions[0].nchunks == 3 assert _edges(new_grid, 1) == (20, 25, 15) assert new_grid._dimensions[1].nchunks == 2 def test_update_shape_dimension_mismatch_error() -> None: """update_shape raises ValueError when new shape has different ndim""" grid = ChunkGrid.from_sizes((30, 70), [[10, 20], [30, 40]]) with pytest.raises(ValueError, match="dimensions"): grid.update_shape((30, 70, 100)) def test_update_shape_boundary_cases() -> None: """update_shape handles grow-one-dim and shrink-both-dims edge cases correctly""" grid = ChunkGrid.from_sizes((60, 40), [[10, 20, 30], [15, 25]]) new_grid = grid.update_shape((60, 65)) assert _edges(new_grid, 0) == (10, 20, 30) assert _edges(new_grid, 1) == (15, 25, 25) grid2 = ChunkGrid.from_sizes((60, 50), [[10, 20, 30], [15, 25, 10]]) new_grid2 = grid2.update_shape((30, 40)) assert _edges(new_grid2, 0) == (10, 20, 30) assert new_grid2._dimensions[0].nchunks == 2 assert _edges(new_grid2, 1) == (15, 25, 10) assert new_grid2._dimensions[1].nchunks == 2 def test_update_shape_regular_preserves_extents(tmp_path: Path) -> None: """Resize a regular array -- chunk_grid extents must match new shape.""" z = zarr.create_array( store=tmp_path / "regular.zarr", shape=(100,), chunks=(10,), dtype="int32", ) z[:] = np.arange(100, dtype="int32") z.resize(50) assert z.shape == (50,) assert ChunkGrid.from_metadata(z.metadata)._dimensions[0].extent == 50 # --------------------------------------------------------------------------- # update_shape boundary tests # --------------------------------------------------------------------------- def test_update_shape_shrink_creates_boundary() -> None: """Shrinking extent into a chunk creates a boundary with clipped data_size""" grid = ChunkGrid.from_sizes((60,), [[10, 20, 30]]) new_grid = grid.update_shape((45,)) dim = new_grid._dimensions[0] assert isinstance(dim, VaryingDimension) assert dim.edges == (10, 20, 30) assert dim.extent == 45 assert dim.chunk_size(2) == 30 assert dim.data_size(2) == 15 def test_update_shape_shrink_to_exact_boundary() -> None: """Shrinking to an exact chunk boundary reduces nchunks without partial data""" grid = ChunkGrid.from_sizes((60,), [[10, 20, 30]]) new_grid = grid.update_shape((30,)) dim = new_grid._dimensions[0] assert isinstance(dim, VaryingDimension) assert dim.edges == (10, 20, 30) assert dim.nchunks == 2 assert dim.ngridcells == 3 assert dim.extent == 30 assert dim.data_size(1) == 20 def test_update_shape_shrink_chunk_spec() -> None: """After shrink, ChunkSpec reflects boundary correctly.""" grid = ChunkGrid.from_sizes((60,), [[10, 20, 30]]) new_grid = grid.update_shape((45,)) spec = new_grid[(2,)] assert spec is not None assert spec.codec_shape == (30,) assert spec.shape == (15,) assert spec.is_boundary is True def test_update_shape_parse_chunk_grid_rebinds_extent() -> None: """parse_chunk_grid re-binds VaryingDimension extent to array shape.""" g = ChunkGrid.from_sizes((60,), [[10, 20, 30]]) g2 = ChunkGrid( dimensions=tuple( dim.with_extent(ext) for dim, ext in zip(g._dimensions, (50,), strict=True) ) ) dim = g2._dimensions[0] assert isinstance(dim, VaryingDimension) assert dim.extent == 50 assert dim.data_size(2) == 20 # --------------------------------------------------------------------------- # Resize rectilinear tests # --------------------------------------------------------------------------- async def test_async_resize_grow() -> None: """Async resize grow appends new edge chunks and preserves existing data""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(30, 40), chunks=[[10, 20], [20, 20]], dtype="i4", zarr_format=3, ) data = np.arange(30 * 40, dtype="i4").reshape(30, 40) await arr.setitem(slice(None), data) await arr.resize((50, 60)) assert arr.shape == (50, 60) assert _edges(ChunkGrid.from_metadata(arr.metadata), 0) == (10, 20, 20) assert _edges(ChunkGrid.from_metadata(arr.metadata), 1) == (20, 20, 20) result = await arr.getitem((slice(0, 30), slice(0, 40))) np.testing.assert_array_equal(result, data) async def test_async_resize_shrink() -> None: """Async resize shrink truncates data to the new shape""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(60, 50), chunks=[[10, 20, 30], [25, 25]], dtype="f4", zarr_format=3, ) data = np.arange(60 * 50, dtype="f4").reshape(60, 50) await arr.setitem(slice(None), data) await arr.resize((25, 30)) assert arr.shape == (25, 30) result = await arr.getitem(slice(None)) np.testing.assert_array_equal(result, data[:25, :30]) def test_sync_resize_grow() -> None: """Sync resize grow expands the array and preserves existing data""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(20, 30), chunks=[[8, 12], [10, 20]], dtype="u1", zarr_format=3, ) data = np.arange(20 * 30, dtype="u1").reshape(20, 30) arr[:] = data arr.resize((35, 45)) assert arr.shape == (35, 45) np.testing.assert_array_equal(arr[:20, :30], data) def test_sync_resize_shrink() -> None: """Sync resize shrink truncates the array and returns correct data""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(40, 50), chunks=[[10, 15, 15], [20, 30]], dtype="i2", zarr_format=3, ) data = np.arange(40 * 50, dtype="i2").reshape(40, 50) arr[:] = data arr.resize((15, 30)) assert arr.shape == (15, 30) np.testing.assert_array_equal(arr[:], data[:15, :30]) # --------------------------------------------------------------------------- # Append rectilinear tests # --------------------------------------------------------------------------- async def test_append_first_axis() -> None: """Appending along axis 0 grows the array and concatenates data correctly""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(30, 20), chunks=[[10, 20], [10, 10]], dtype="i4", zarr_format=3, ) initial = np.arange(30 * 20, dtype="i4").reshape(30, 20) await arr.setitem(slice(None), initial) append_data = np.arange(30 * 20, 45 * 20, dtype="i4").reshape(15, 20) await arr.append(append_data, axis=0) assert arr.shape == (45, 20) result = await arr.getitem(slice(None)) np.testing.assert_array_equal(result, np.vstack([initial, append_data])) async def test_append_second_axis() -> None: """Appending along axis 1 grows the array and concatenates data correctly""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(20, 30), chunks=[[10, 10], [10, 20]], dtype="f4", zarr_format=3, ) initial = np.arange(20 * 30, dtype="f4").reshape(20, 30) await arr.setitem(slice(None), initial) append_data = np.arange(20 * 30, 20 * 45, dtype="f4").reshape(20, 15) await arr.append(append_data, axis=1) assert arr.shape == (20, 45) result = await arr.getitem(slice(None)) np.testing.assert_array_equal(result, np.hstack([initial, append_data])) def test_sync_append() -> None: """Sync append grows the array and preserves both initial and appended data""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(20, 20), chunks=[[8, 12], [7, 13]], dtype="u2", zarr_format=3, ) initial = np.arange(20 * 20, dtype="u2").reshape(20, 20) arr[:] = initial append_data = np.arange(20 * 20, 25 * 20, dtype="u2").reshape(5, 20) arr.append(append_data, axis=0) assert arr.shape == (25, 20) np.testing.assert_array_equal(arr[:20, :], initial) np.testing.assert_array_equal(arr[20:, :], append_data) async def test_multiple_appends() -> None: """Multiple sequential appends accumulate data correctly""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(10, 10), chunks=[[3, 7], [4, 6]], dtype="i4", zarr_format=3, ) initial = np.arange(10 * 10, dtype="i4").reshape(10, 10) await arr.setitem(slice(None), initial) all_data = [initial] for i in range(3): chunk = np.full((5, 10), i + 100, dtype="i4") await arr.append(chunk, axis=0) all_data.append(chunk) assert arr.shape == (25, 10) result = await arr.getitem(slice(None)) np.testing.assert_array_equal(result, np.vstack(all_data)) async def test_append_with_partial_edge_chunks() -> None: """Appending data that creates partial edge chunks preserves all data""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(25, 30), chunks=[[10, 15], [12, 18]], dtype="f8", zarr_format=3, ) initial = np.random.default_rng(42).random((25, 30)) await arr.setitem(slice(None), initial) append_data = np.random.default_rng(43).random((10, 30)) await arr.append(append_data, axis=0) assert arr.shape == (35, 30) result = np.asarray(await arr.getitem(slice(None))) np.testing.assert_array_almost_equal(result, np.vstack([initial, append_data])) async def test_append_small_data() -> None: """Appending a small amount of data smaller than a chunk works correctly""" store = zarr.storage.MemoryStore() arr = await zarr.api.asynchronous.create_array( store=store, shape=(20, 20), chunks=[[8, 12], [7, 13]], dtype="i4", zarr_format=3, ) data = np.arange(20 * 20, dtype="i4").reshape(20, 20) await arr.setitem(slice(None), data) small = np.full((3, 20), 999, dtype="i4") await arr.append(small, axis=0) assert arr.shape == (23, 20) result = await arr.getitem((slice(20, 23), slice(None))) np.testing.assert_array_equal(result, small) # --------------------------------------------------------------------------- # V2 regression tests # --------------------------------------------------------------------------- def test_v2_create_and_readback(tmp_path: Path) -> None: """Basic V2 array: create, write, read back.""" data = np.arange(60, dtype="float64").reshape(6, 10) a = zarr.create_array( store=tmp_path / "v2.zarr", shape=data.shape, chunks=(3, 5), dtype=data.dtype, zarr_format=2, ) a[:] = data np.testing.assert_array_equal(a[:], data) def test_v2_chunk_grid_is_regular(tmp_path: Path) -> None: """V2 chunk_grid produces a regular ChunkGrid with FixedDimensions.""" a = zarr.create_array( store=tmp_path / "v2.zarr", shape=(20, 30), chunks=(10, 15), dtype="int32", zarr_format=2, ) grid = ChunkGrid.from_metadata(a.metadata) assert grid.is_regular assert grid.chunk_shape == (10, 15) assert grid.grid_shape == (2, 2) assert all(isinstance(d, FixedDimension) for d in grid._dimensions) def test_v2_boundary_chunks(tmp_path: Path) -> None: """V2 boundary chunks: codec buffer size stays full, data is clipped.""" a = zarr.create_array( store=tmp_path / "v2.zarr", shape=(25,), chunks=(10,), dtype="int32", zarr_format=2, ) grid = ChunkGrid.from_metadata(a.metadata) assert grid._dimensions[0].nchunks == 3 assert grid._dimensions[0].chunk_size(2) == 10 assert grid._dimensions[0].data_size(2) == 5 def test_v2_slicing_with_boundary(tmp_path: Path) -> None: """V2 array slicing across boundary chunks returns correct data.""" data = np.arange(25, dtype="int32") a = zarr.create_array( store=tmp_path / "v2.zarr", shape=(25,), chunks=(10,), dtype="int32", zarr_format=2, ) a[:] = data np.testing.assert_array_equal(a[18:25], data[18:25]) np.testing.assert_array_equal(a[:], data) def test_v2_metadata_roundtrip(tmp_path: Path) -> None: """V2 metadata survives store close and reopen.""" store_path = tmp_path / "v2.zarr" data = np.arange(12, dtype="float32").reshape(3, 4) a = zarr.create_array( store=store_path, shape=data.shape, chunks=(2, 2), dtype=data.dtype, zarr_format=2, ) a[:] = data b = zarr.open_array(store=store_path, mode="r") assert b.metadata.zarr_format == 2 assert b.chunks == (2, 2) assert ChunkGrid.from_metadata(b.metadata).chunk_shape == (2, 2) np.testing.assert_array_equal(b[:], data) def test_v2_chunk_spec_via_grid(tmp_path: Path) -> None: """ChunkSpec from V2 grid has correct slices and codec_shape.""" a = zarr.create_array( store=tmp_path / "v2.zarr", shape=(15, 20), chunks=(10, 10), dtype="int32", zarr_format=2, ) grid = ChunkGrid.from_metadata(a.metadata) spec = grid[(0, 0)] assert spec is not None assert spec.shape == (10, 10) assert spec.codec_shape == (10, 10) spec = grid[(1, 1)] assert spec is not None assert spec.shape == (5, 10) assert spec.codec_shape == (10, 10) # --------------------------------------------------------------------------- # ChunkSizes tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("shape", "chunks", "expected"), [ ((100, 80), (30, 40), ((30, 30, 30, 10), (40, 40))), ((90, 80), (30, 40), ((30, 30, 30), (40, 40))), ((60, 100), [[10, 20, 30], [50, 50]], ((10, 20, 30), (50, 50))), ((10,), (10,), ((10,),)), ], ids=["regular", "regular-exact", "rectilinear", "single-chunk"], ) def test_chunk_sizes( shape: tuple[int, ...], chunks: Any, expected: tuple[tuple[int, ...], ...] ) -> None: """chunk_sizes returns the per-dimension tuple of actual data sizes""" grid = ChunkGrid.from_sizes(shape, chunks) assert grid.chunk_sizes == expected def test_array_read_chunk_sizes_regular() -> None: """Regular array exposes correct read_chunk_sizes and write_chunk_sizes""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(100, 80), chunks=(30, 40), dtype="i4", zarr_format=3 ) assert arr.read_chunk_sizes == ((30, 30, 30, 10), (40, 40)) assert arr.write_chunk_sizes == ((30, 30, 30, 10), (40, 40)) def test_array_read_chunk_sizes_rectilinear() -> None: """Rectilinear array exposes correct read_chunk_sizes and write_chunk_sizes""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(60, 100), chunks=[[10, 20, 30], [50, 50]], dtype="i4", zarr_format=3 ) assert arr.read_chunk_sizes == ((10, 20, 30), (50, 50)) assert arr.write_chunk_sizes == ((10, 20, 30), (50, 50)) def test_array_sharded_chunk_sizes() -> None: """Sharded array read_chunk_sizes reflects inner chunks and write_chunk_sizes reflects shards""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(120, 80), chunks=(60, 40), shards=(120, 80), dtype="i4", zarr_format=3, ) assert arr.read_chunk_sizes == ((60, 60), (40, 40)) assert arr.write_chunk_sizes == ((120,), (80,)) # --------------------------------------------------------------------------- # Info display test # --------------------------------------------------------------------------- def test_chunk_grid_repr_regular() -> None: """ChunkGrid repr shows uniform chunk sizes and array shape for regular grids.""" grid = ChunkGrid.from_sizes((100, 200), (10, 20)) r = repr(grid) assert r == "ChunkGrid(chunk_sizes=(10, 20), array_shape=(100, 200))" def test_chunk_grid_repr_rectilinear() -> None: """ChunkGrid repr shows per-chunk edge tuples for rectilinear dimensions.""" grid = ChunkGrid.from_sizes((30,), ([10, 20],)) r = repr(grid) assert "(10, 20)" in r assert "(30,)" in r def test_info_display_rectilinear() -> None: """Array.info should not crash for rectilinear grids.""" store = zarr.storage.MemoryStore() arr = zarr.create_array( store=store, shape=(30,), chunks=[[10, 20]], dtype="i4", zarr_format=3, ) info = arr.info text = repr(info) assert "" in text assert "Array" in text # --------------------------------------------------------------------------- # nchunks tests # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("shape", "chunks", "expected"), [ ((30,), [[10, 20]], 2), ((30, 40), [[10, 20], [15, 25]], 4), ], ids=["1d", "2d"], ) def test_nchunks_rectilinear( shape: tuple[int, ...], chunks: list[list[int]], expected: int ) -> None: """Array.nchunks reports correct total chunk count for rectilinear arrays""" store = MemoryStore() a = zarr.create_array(store, shape=shape, chunks=chunks, dtype="int32") assert a.nchunks == expected # --------------------------------------------------------------------------- # iter_chunk_regions test # --------------------------------------------------------------------------- def test_iter_chunk_regions_rectilinear() -> None: """_iter_chunk_regions should work for rectilinear arrays.""" from zarr.core.array import _iter_chunk_regions store = MemoryStore() a = zarr.create_array(store, shape=(30,), chunks=[[10, 20]], dtype="int32") regions = list(_iter_chunk_regions(a)) assert len(regions) == 2 assert regions[0] == (slice(0, 10, 1),) assert regions[1] == (slice(10, 30, 1),) # --------------------------------------------------------------------------- # RectilinearChunkGridMetadata metadata object tests (already parametrized) # --------------------------------------------------------------------------- @pytest.mark.parametrize( ("json_input", "expected_chunk_shapes"), [ ( { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [4, 8]}, }, (4, 8), ), ( { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[1, 2, 3], [10, 20]]}, }, ((1, 2, 3), (10, 20)), ), ( { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[[4, 3]], [10, 20]]}, }, ((4, 4, 4), (10, 20)), ), ( { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[[1, 3], 3], [5]]}, }, ((1, 1, 1, 3), (5,)), ), ( { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [4, [10, 20]]}, }, (4, (10, 20)), ), ], ) def test_rectilinear_from_dict( json_input: RectilinearChunkGridMetadataJSON, expected_chunk_shapes: tuple[int | tuple[int, ...], ...], ) -> None: """RectilinearChunkGridMetadata.from_dict correctly parses all spec forms.""" grid = RectilinearChunkGridMetadata.from_dict(json_input) assert grid.chunk_shapes == expected_chunk_shapes @pytest.mark.parametrize( ("chunk_shapes", "expected_json_shapes"), [ ((4, 8), [4, 8]), (((4,), (8,)), [[4], [8]]), (((10, 20), (5, 5)), [[10, 20], [[5, 2]]]), (((4, 4, 4), (10, 20)), [[[4, 3]], [10, 20]]), ((4, (10, 20)), [4, [10, 20]]), ], ) def test_rectilinear_to_dict( chunk_shapes: tuple[int | tuple[int, ...], ...], expected_json_shapes: list[Any], ) -> None: """RectilinearChunkGridMetadata.to_dict serializes back to spec-compliant JSON.""" grid = RectilinearChunkGridMetadata(chunk_shapes=chunk_shapes) result = grid.to_dict() assert result["name"] == "rectilinear" assert result["configuration"]["kind"] == "inline" assert list(result["configuration"]["chunk_shapes"]) == expected_json_shapes @pytest.mark.parametrize( "json_input", [ {"name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [4, 8]}}, { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[1, 2, 3], [10, 20]]}, }, { "name": "rectilinear", "configuration": {"kind": "inline", "chunk_shapes": [[[4, 3]], [[5, 2]]]}, }, ], ) def test_rectilinear_roundtrip(json_input: RectilinearChunkGridMetadataJSON) -> None: """from_dict -> to_dict -> from_dict produces the same grid.""" grid1 = RectilinearChunkGridMetadata.from_dict(json_input) grid2 = RectilinearChunkGridMetadata.from_dict(grid1.to_dict()) assert grid1.chunk_shapes == grid2.chunk_shapes # --------------------------------------------------------------------------- # Hypothesis property tests # --------------------------------------------------------------------------- pytest.importorskip("hypothesis") import hypothesis.strategies as st # noqa: E402 from hypothesis import event, given, settings # noqa: E402 @st.composite def rectilinear_chunks_st(draw: st.DrawFn, *, shape: tuple[int, ...]) -> list[list[int]]: """Generate valid rectilinear chunk shapes for a given array shape.""" chunk_shapes: list[list[int]] = [] for size in shape: assert size > 0 max_chunks = min(size, 10) nchunks = draw(st.integers(min_value=1, max_value=max_chunks)) if nchunks == 1: chunk_shapes.append([size]) else: dividers = sorted( draw( st.lists( st.integers(min_value=1, max_value=size - 1), min_size=nchunks - 1, max_size=nchunks - 1, unique=True, ) ) ) chunk_shapes.append( [a - b for a, b in zip(dividers + [size], [0] + dividers, strict=False)] ) return chunk_shapes @st.composite def rectilinear_arrays_st(draw: st.DrawFn) -> tuple[zarr.Array[Any], np.ndarray[Any, Any]]: """Generate a rectilinear zarr array with random data, shape, and chunks.""" from zarr.storage import MemoryStore ndim = draw(st.integers(min_value=1, max_value=3)) shape = draw(st.tuples(*[st.integers(min_value=2, max_value=20) for _ in range(ndim)])) chunk_shapes = draw(rectilinear_chunks_st(shape=shape)) event(f"ndim={ndim}, shape={shape}") a = np.arange(int(np.prod(shape)), dtype="int32").reshape(shape) store = MemoryStore() z = zarr.create_array(store=store, shape=shape, chunks=chunk_shapes, dtype="int32") z[:] = a return z, a @settings(deadline=None, max_examples=50) @given(data=st.data()) def test_property_block_indexing_rectilinear(data: st.DataObject) -> None: """Property test: block indexing on rectilinear arrays matches numpy.""" z, a = data.draw(rectilinear_arrays_st()) grid = ChunkGrid.from_metadata(z.metadata) for dim in range(a.ndim): dim_grid = grid._dimensions[dim] block_ix = data.draw(st.integers(min_value=0, max_value=dim_grid.nchunks - 1)) sel = [slice(None)] * a.ndim start = dim_grid.chunk_offset(block_ix) stop = start + dim_grid.data_size(block_ix) sel[dim] = slice(start, stop) block_sel: list[slice | int] = [slice(None)] * a.ndim block_sel[dim] = block_ix np.testing.assert_array_equal( z.blocks[tuple(block_sel)], a[tuple(sel)], err_msg=f"dim={dim}, block={block_ix}", ) zarr-python-3.3.0/tests/test_v2.py000066400000000000000000000234041523267620000171220ustar00rootroot00000000000000import json from pathlib import Path from typing import Any, Literal import numpy as np import pytest from numcodecs import Delta, Zlib from numcodecs.blosc import Blosc from numcodecs.zstd import Zstd import zarr import zarr.core.buffer import zarr.storage from zarr import config from zarr.abc.store import Store from zarr.core.buffer.core import default_buffer_prototype from zarr.core.dtype import FixedLengthUTF32, VariableLengthUTF8 from zarr.core.dtype.npy.bytes import NullTerminatedBytes from zarr.core.dtype.npy.structured import Struct from zarr.core.dtype.wrapper import ZDType from zarr.core.group import Group from zarr.core.sync import sync from zarr.errors import ZarrDeprecationWarning from zarr.storage import MemoryStore, StorePath @pytest.fixture async def store() -> StorePath: return StorePath(await MemoryStore.open()) def test_simple(store: StorePath) -> None: data = np.arange(0, 256, dtype="uint16").reshape((16, 16)) a = zarr.create_array( store / "simple_v2", zarr_format=2, shape=data.shape, chunks=(16, 16), dtype=data.dtype, fill_value=0, ) a[:, :] = data assert np.array_equal(data, a[:, :]) def test_codec_pipeline() -> None: # https://github.com/zarr-developers/zarr-python/issues/2243 store = MemoryStore() array = zarr.create( store=store, shape=(1,), dtype="i4", zarr_format=2, filters=[Delta(dtype="i4").get_config()], compressor=Blosc().get_config(), ) array[:] = 1 result = array[:] expected = np.ones(1) np.testing.assert_array_equal(result, expected) @pytest.mark.parametrize( ("dtype", "expected_dtype", "fill_value", "fill_value_json"), [ ("|S1", "|S1", b"X", "WA=="), ("|V1", "|V1", b"X", "WA=="), ("|V10", "|V10", b"X", "WAAAAAAAAAAAAA=="), ], ) async def test_v2_encode_decode( dtype: str, expected_dtype: str, fill_value: bytes, fill_value_json: str ) -> None: store = zarr.storage.MemoryStore() g = zarr.group(store=store, zarr_format=2) g.create_array( name="foo", shape=(3,), chunks=(3,), dtype=dtype, fill_value=fill_value, compressor=None ) result = await store.get("foo/.zarray", zarr.core.buffer.default_buffer_prototype()) assert result is not None serialized = json.loads(result.to_bytes()) expected = { "chunks": [3], "compressor": None, "dtype": expected_dtype, "fill_value": fill_value_json, "filters": None, "order": "C", "shape": [3], "zarr_format": 2, "dimension_separator": ".", } assert serialized == expected data = zarr.open_array(store=store, path="foo")[:] np.testing.assert_equal(data, np.full((3,), b"X", dtype=dtype)) data = zarr.open_array(store=store, path="foo")[:] np.testing.assert_equal(data, np.full((3,), b"X", dtype=dtype)) @pytest.mark.parametrize( ("dtype", "value"), [ (NullTerminatedBytes(length=1), b"Y"), (FixedLengthUTF32(length=1), "Y"), (VariableLengthUTF8(), "Y"), ], ) def test_v2_encode_decode_with_data(dtype: ZDType[Any, Any], value: str) -> None: expected = np.full((3,), value, dtype=dtype.to_native_dtype()) a = zarr.create( shape=(3,), zarr_format=2, dtype=dtype, ) a[:] = expected data = a[:] np.testing.assert_equal(data, expected) @pytest.mark.parametrize("filters", [[], [Delta(dtype=" None: array_fixture = [42] with config.set({"array.order": order}): arr = zarr.create(shape=1, dtype=" None: """ Test that passing compressor=None results in no compressor. Also test that the default value of the compressor parameter does produce a compressor. """ g = zarr.open(store, mode="w", zarr_format=2) assert isinstance(g, Group) arr = g.create_array("one", dtype="i8", shape=(1,), chunks=(1,), compressor=None) assert arr.async_array.compressor is None assert not (arr.filters) arr = g.create_array("two", dtype="i8", shape=(1,), chunks=(1,)) assert arr.async_array.compressor is not None assert not (arr.filters) arr = g.create_array("three", dtype="i8", shape=(1,), chunks=(1,), compressor=Zstd()) assert arr.async_array.compressor is not None assert not (arr.filters) with pytest.raises(ValueError): g.create_array( "four", dtype="i8", shape=(1,), chunks=(1,), compressor=None, compressors=None ) @pytest.mark.parametrize("numpy_order", ["C", "F"]) @pytest.mark.parametrize("zarr_order", ["C", "F"]) def test_v2_non_contiguous(numpy_order: Literal["C", "F"], zarr_order: Literal["C", "F"]) -> None: """ Make sure zarr v2 arrays save data using the memory order given to the zarr array, not the memory order of the original numpy array. """ store = MemoryStore() arr = zarr.create_array( store, shape=(10, 8), chunks=(3, 3), fill_value=np.nan, dtype="float64", zarr_format=2, filters=None, compressors=None, overwrite=True, order=zarr_order, ) # Non-contiguous write, using numpy memory order a = np.arange(arr.shape[0] * arr.shape[1]).reshape(arr.shape, order=numpy_order) arr[6:9, 3:6] = a[6:9, 3:6] # The slice on the RHS is important np.testing.assert_array_equal(arr[6:9, 3:6], a[6:9, 3:6]) buf = sync(store.get("2.1", default_buffer_prototype())) assert buf is not None np.testing.assert_array_equal( a[6:9, 3:6], np.frombuffer(buf.to_bytes(), dtype="float64").reshape((3, 3), order=zarr_order), ) # After writing and reading from zarr array, order should be same as zarr order sub_arr = arr[6:9, 3:6] assert isinstance(sub_arr, np.ndarray) if zarr_order == "F": assert (sub_arr).flags.f_contiguous else: assert (sub_arr).flags.c_contiguous # Contiguous write store = MemoryStore() arr = zarr.create_array( store, shape=(10, 8), chunks=(3, 3), fill_value=np.nan, dtype="float64", zarr_format=2, compressors=None, filters=None, overwrite=True, order=zarr_order, ) a = np.arange(9).reshape((3, 3), order=numpy_order) arr[6:9, 3:6] = a np.testing.assert_array_equal(arr[6:9, 3:6], a) # After writing and reading from zarr array, order should be same as zarr order sub_arr = arr[6:9, 3:6] assert isinstance(sub_arr, np.ndarray) if zarr_order == "F": assert (sub_arr).flags.f_contiguous else: assert (sub_arr).flags.c_contiguous def test_default_compressor_deprecation_warning() -> None: with pytest.warns(ZarrDeprecationWarning, match="default_compressor is deprecated"): zarr.storage.default_compressor = "zarr.codecs.zstd.ZstdCodec()" # type: ignore[attr-defined] @pytest.mark.parametrize("fill_value", [None, (b"", 0, 0.0)], ids=["no_fill", "fill"]) def test_structured_dtype_roundtrip(fill_value: float | bytes, tmp_path: Path) -> None: a = np.array( [(b"aaa", 1, 4.2), (b"bbb", 2, 8.4), (b"ccc", 3, 12.6)], dtype=[("foo", "S3"), ("bar", "i4"), ("baz", "f8")], ) array_path = tmp_path / "data.zarr" za = zarr.create( shape=(3,), store=array_path, chunks=(2,), fill_value=fill_value, zarr_format=2, dtype=a.dtype, ) if fill_value is not None: assert (np.array([fill_value] * a.shape[0], dtype=a.dtype) == za[:]).all() za[...] = a za = zarr.open_array(store=array_path) assert (a == za[:]).all() @pytest.mark.parametrize( ( "fill_value", "dtype", "expected_result", ), [ ( ("Alice", 30), np.dtype([("name", "U10"), ("age", "i4")]), np.array([("Alice", 30)], dtype=[("name", "U10"), ("age", "i4")])[0], ), ( ["Bob", 25], np.dtype([("name", "U10"), ("age", "i4")]), np.array([("Bob", 25)], dtype=[("name", "U10"), ("age", "i4")])[0], ), ( b"\x01\x00\x00\x00\x02\x00\x00\x00", np.dtype([("x", "i4"), ("y", "i4")]), np.array([(1, 2)], dtype=[("x", "i4"), ("y", "i4")])[0], ), ], ids=[ "tuple_input", "list_input", "bytes_input", ], ) def test_parse_structured_fill_value_valid( fill_value: Any, dtype: np.dtype[Any], expected_result: Any ) -> None: zdtype = Struct.from_native_dtype(dtype) result = zdtype.cast_scalar(fill_value) assert result.dtype == expected_result.dtype assert result == expected_result if isinstance(expected_result, np.void): for name in expected_result.dtype.names or []: assert result[name] == expected_result[name] @pytest.mark.parametrize("fill_value", [None, b"x"], ids=["no_fill", "fill"]) def test_other_dtype_roundtrip(fill_value: None | bytes, tmp_path: Path) -> None: a = np.array([b"a\0\0", b"bb", b"ccc"], dtype="V7") array_path = tmp_path / "data.zarr" za = zarr.create( shape=(3,), store=array_path, chunks=(2,), fill_value=fill_value, zarr_format=2, dtype=a.dtype, ) if fill_value is not None: assert (np.array([fill_value] * a.shape[0], dtype=a.dtype) == za[:]).all() za[...] = a za = zarr.open_array(store=array_path) assert (a == za[:]).all() zarr-python-3.3.0/tests/test_version_derivation.py000066400000000000000000000030461523267620000225040ustar00rootroot00000000000000"""Sanity check that ``zarr.__version__`` looks like a v3-or-newer release. Background: zarr-python derives its version from ``git describe`` via hatch-vcs. The repo also publishes a separate ``zarr-metadata`` subpackage that uses ``zarr_metadata-v*`` tags. Without the ``--match v*`` filter in ``[tool.hatch] version.raw-options.git_describe_command``, ``git describe`` walks back to those subpackage tags and reports a version like ``0.2.0`` for a from-source build of zarr-python itself — see https://github.com/zarr-developers/zarr-python/pull/3994. This test catches that class of regression: anything that makes zarr-python report a version lower than the v3 release line. When 4.0 is released, bump the floor; that's a deliberate, one-line edit at a planned boundary. """ from __future__ import annotations from packaging.version import Version import zarr def test_version_is_v3_or_newer() -> None: # Use packaging.Version so we transparently handle hatch-vcs dev suffixes # like "3.2.2.dev30+gdc5e1825" that appear on any source build past the # latest v* tag — Version.major returns 3 for that string. parsed = Version(zarr.__version__) assert parsed.major >= 3, ( f"zarr.__version__={zarr.__version__!r} is not on the v3 (or newer) " f"release line. If this fires on a from-source build, check that " f"[tool.hatch] version.raw-options.git_describe_command in " f"pyproject.toml still includes ``--match v*`` so the " f"``zarr_metadata-v*`` subpackage tags are excluded. See PR #3994." ) zarr-python-3.3.0/tests/test_zarr.py000066400000000000000000000012621523267620000175470ustar00rootroot00000000000000import pytest import zarr def test_exports() -> None: """ Ensure that everything in __all__ can be imported. """ from zarr import __all__ for export in __all__: getattr(zarr, export) def test_print_debug_info(capsys: pytest.CaptureFixture[str]) -> None: """ Ensure that print_debug_info does not raise an error """ from importlib.metadata import version from zarr import __version__, print_debug_info print_debug_info() captured = capsys.readouterr() # test that at least some of what we expect is # printed out assert f"zarr: {__version__}" in captured.out assert f"numpy: {version('numpy')}" in captured.out zarr-python-3.3.0/uv.lock000066400000000000000000023025471523267620000153360ustar00rootroot00000000000000version = 1 revision = 3 requires-python = ">=3.12" resolution-markers = [ "python_full_version >= '3.15'", "python_full_version < '3.15'", ] [[package]] name = "aiobotocore" version = "3.7.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "aiohttp" }, { name = "aioitertools" }, { name = "botocore" }, { name = "jmespath" }, { name = "multidict" }, { name = "python-dateutil" }, { name = "wrapt" }, ] sdist = { url = "https://files.pythonhosted.org/packages/e7/75/42cce839c2ec263ff74b10b650fe36b066fbb124cbee6f247eac0983e1ab/aiobotocore-3.7.0.tar.gz", hash = "sha256:c64d871ed5491a6571948dd48eabd185b46c6c23b64e3afd0c059fc7593ada30", size = 127054, upload-time = "2026-05-09T10:02:52.332Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/90/5f/85535dfb3cfd6442d66d1df1694062c5d6df02f895329e7e120b2a3d2b8b/aiobotocore-3.7.0-py3-none-any.whl", hash = "sha256:680bde7c64679a821a9312641b759d9497f790ba8b2e88c6959e6273ee765b8e", size = 89539, upload-time = "2026-05-09T10:02:50.389Z" }, ] [[package]] name = "aiohappyeyeballs" version = "2.6.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/26/30/f84a107a9c4331c14b2b586036f40965c128aa4fee4dda5d3d51cb14ad54/aiohappyeyeballs-2.6.1.tar.gz", hash = "sha256:c3f9d0113123803ccadfdf3f0faa505bc78e6a72d1cc4806cbd719826e943558", size = 22760, upload-time = "2025-03-12T01:42:48.764Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0f/15/5bf3b99495fb160b63f95972b81750f18f7f4e02ad051373b669d17d44f2/aiohappyeyeballs-2.6.1-py3-none-any.whl", hash = "sha256:f349ba8f4b75cb25c99c5c2d84e997e485204d2902a9597802b0371f09331fb8", size = 15265, upload-time = "2025-03-12T01:42:47.083Z" }, ] [[package]] name = "aiohttp" version = "3.14.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "aiohappyeyeballs" }, { name = "aiosignal" }, { name = "attrs" }, { name = "frozenlist" }, { name = "multidict" }, { name = "propcache" }, { name = "typing-extensions", marker = "python_full_version < '3.13'" }, { name = "yarl" }, ] sdist = { url = "https://files.pythonhosted.org/packages/82/78/8ea7308cac6934de8c74a14f3d5f65d1c89287426688be79538d0e5c013d/aiohttp-3.14.1.tar.gz", hash = "sha256:307f2cff90a764d329e77040603fa032db89c5c24fdad50c4c15334cba744035", size = 7955794, upload-time = "2026-06-07T21:09:35.529Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/1d/21/151624b51cd92553d95424daf4bf19f19ce9be9002d19253e7e7ce67197b/aiohttp-3.14.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:d35143e27778b4bb0fb189562d7f275bff79c62ab8e98459717c0ea617ff2480", size = 757402, upload-time = "2026-06-07T21:06:40.311Z" }, { url = "https://files.pythonhosted.org/packages/c2/82/280619e0bd7bf2454987e19282616e84762255dd9c8468f62382e8c191f1/aiohttp-3.14.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:bcfb80a2cc36fba2534e5e5b5264dc7ae6fcd9bf15256da3e53d2f499e6fa29d", size = 512310, upload-time = "2026-06-07T21:06:42.207Z" }, { url = "https://files.pythonhosted.org/packages/55/b2/2aac325583aaa1353045f96dffa586d8a34e8322e14a7ba49cffeb103ab4/aiohttp-3.14.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:27fd7c91e51729b4f7e1577865fa6d34c9adccbc39aabe9000285b48af9f0ec2", size = 512448, upload-time = "2026-06-07T21:06:43.813Z" }, { url = "https://files.pythonhosted.org/packages/8a/72/a60607cb849faa8af8a356c9329ea2eb6f395d49e82cc82ccba1fd8deb8f/aiohttp-3.14.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:64c567bf9eaf664280116a8688f63016e6b32db2505908e2bdaca1b6438142f2", size = 1766854, upload-time = "2026-06-07T21:06:45.391Z" }, { url = "https://files.pythonhosted.org/packages/b5/d3/d9fe1c9ec7557ab4d0d82bebaa728c6418f0b93295ec2f4ab015f7710cc7/aiohttp-3.14.1-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:f5e6ff2bdbb8f4cd3fbe41f99e25bbcd58e3bf9f13d3dd31a11e7917251cc77a", size = 1740884, upload-time = "2026-06-07T21:06:47.413Z" }, { url = "https://files.pythonhosted.org/packages/c1/dc/f2cecfaf9337ba3e63f181500814ff502aa3d00d9c7ec93a9d23d10a27b2/aiohttp-3.14.1-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:2f73e01dc37122325caf079982621262f96d74823c179038a82fddfc50359264", size = 1810034, upload-time = "2026-06-07T21:06:50.165Z" }, { url = "https://files.pythonhosted.org/packages/66/d7/2ff65c5e65c0d7476daf7e15c032e0805e36811185b9623e3238ad6c763e/aiohttp-3.14.1-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:bb2c0c80d431c0d03f2c7dbf125150fedd4f0de17366a7ca33f7ccb822391842", size = 1904054, upload-time = "2026-06-07T21:06:52.035Z" }, { url = "https://files.pythonhosted.org/packages/20/9c/d445818389df371f56d141d881153ba23183c4735a03f7356ffb43f7757d/aiohttp-3.14.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:3e6fc1a85fa7194a1a7d19f44e8609180f4a8eb5fa4c7ed8b4355f080fad235c", size = 1790278, upload-time = "2026-06-07T21:06:54.049Z" }, { url = "https://files.pythonhosted.org/packages/4d/aa/bf04cb4d865fc6101c2229a294ad744973b72e513fdc5a6b791e6983d72a/aiohttp-3.14.1-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:686b6c0d3911ec387b444ddf5dc62fb7f7c0a7d5186a7861626496a5ab4aff95", size = 1591795, upload-time = "2026-06-07T21:06:55.911Z" }, { url = "https://files.pythonhosted.org/packages/dc/b4/4dac0038960427ba832f6609dfb4ea5437d7fd80c72001b9e48f834f428b/aiohttp-3.14.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:c6fa4dc7ad6f8109c70bb1499e589f76b0b792baf39f9b017eb92c8a81d0a199", size = 1728397, upload-time = "2026-06-07T21:06:57.777Z" }, { url = "https://files.pythonhosted.org/packages/2b/f9/7cd4e8ad7aa3b75f17d56bb5498dd604a93d4e6eece822ba0568c413fff0/aiohttp-3.14.1-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:87a5eea1b2a5e21e1ebdbb33ad4165359189327e63fc4e4894693e7f821ac817", size = 1766504, upload-time = "2026-06-07T21:07:00.009Z" }, { url = "https://files.pythonhosted.org/packages/f9/df/fc01d9fcad0f73fed3f3d361f1f94f975947b50dff82919f6dc2bf4316cc/aiohttp-3.14.1-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:1c1421eb01d4fd608d88cc8290211d177a58532b55ad94076fb349c5bf467f0a", size = 1777806, upload-time = "2026-06-07T21:07:02.064Z" }, { url = "https://files.pythonhosted.org/packages/41/09/47e2d090bddcc8fb4ccb4c314aadc32d7c5d9bb55f50f6ad1c92fc15d501/aiohttp-3.14.1-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:34b257ec41345c1e8f2df68fa908a7952f5de932723871eb633ecbbff396c9a4", size = 1580707, upload-time = "2026-06-07T21:07:03.942Z" }, { url = "https://files.pythonhosted.org/packages/3d/36/f1a4ce904ae0b6930cfe9afc96d0896f7ec1a620c400405d63783bb95a9c/aiohttp-3.14.1-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:de538791a80e5d862addbc183f70f0158ac9b9bb872bb147f1fd2a683691e087", size = 1798121, upload-time = "2026-06-07T21:07:05.987Z" }, { url = "https://files.pythonhosted.org/packages/70/0a/e0075ce9ca0279ee1d4f0c0b85f54fea02ebc83c3007651a72bece658fec/aiohttp-3.14.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:6f71173be42d3241d428f760122febb748de0623f44308a6f120d0dd9ec572e3", size = 1767580, upload-time = "2026-06-07T21:07:07.873Z" }, { url = "https://files.pythonhosted.org/packages/3e/61/a0c0a8f327a9c52095cdd8e312391b00d3ed64ab6c72bb5c33d8ec251cf7/aiohttp-3.14.1-cp312-cp312-win32.whl", hash = "sha256:ec8dc383ee57ea3e883477dcca3f11b65d58199f1080acaf4cd6ad9a99698be4", size = 452771, upload-time = "2026-06-07T21:07:09.669Z" }, { url = "https://files.pythonhosted.org/packages/df/d9/ea367c75f16ac9c6cdc8febb25e8318fa21a2b1bc8d6514d4b2d890bface/aiohttp-3.14.1-cp312-cp312-win_amd64.whl", hash = "sha256:2aa92c87868cd13674989f9ee83e5f9f7ea4237589b728048e1f0c8f6caa3271", size = 479873, upload-time = "2026-06-07T21:07:11.538Z" }, { url = "https://files.pythonhosted.org/packages/03/64/8d96784a7851156db8a4c6c3f6f91042fdf39fb15a4cc38c8b3c14833c45/aiohttp-3.14.1-cp312-cp312-win_arm64.whl", hash = "sha256:2c840c90759922cb5e6dda94596e079a30fb5a5ba548e7e0dc00574703940847", size = 448073, upload-time = "2026-06-07T21:07:13.637Z" }, { url = "https://files.pythonhosted.org/packages/bc/97/bd137012dd97e1649162b099135a80e1fd59aaa807b2430fc448d1029aff/aiohttp-3.14.1-cp313-cp313-android_21_arm64_v8a.whl", hash = "sha256:b3a03285a7f9c7b016324574a6d92a1c895da6b978cb8f1deee3ac72bc6da178", size = 506882, upload-time = "2026-06-07T21:07:15.501Z" }, { url = "https://files.pythonhosted.org/packages/ef/79/e5cc690e9d922a66887ceeaca53a8ffd5a7b0be3816142b7abc433742d89/aiohttp-3.14.1-cp313-cp313-android_21_x86_64.whl", hash = "sha256:2a73f487ab8ef5abbb24b7aa9b73e98eaba9e9e031804ff2416f02eca315ccaf", size = 515270, upload-time = "2026-06-07T21:07:17.53Z" }, { url = "https://files.pythonhosted.org/packages/fe/22/a73ccbf9dbd6e26dda0b24d5fd5db7da92ee3383a79f47677ffb834c5c5b/aiohttp-3.14.1-cp313-cp313-ios_13_0_arm64_iphoneos.whl", hash = "sha256:915fbb7b41b115192259f8c9ae58f3ddc444d2b5579917270211858e606a4afd", size = 485841, upload-time = "2026-06-07T21:07:19.555Z" }, { url = "https://files.pythonhosted.org/packages/3b/b9/57ed8eaf596321c2ad747bd480fb1700dbd7177c60dfc9e4c187f629662e/aiohttp-3.14.1-cp313-cp313-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:7fb4bdf95b0561a79f259f9d28fbc109728c5ee7f27aff6391f0ca703a329abe", size = 492088, upload-time = "2026-06-07T21:07:21.581Z" }, { url = "https://files.pythonhosted.org/packages/78/c0/5ebe5270a7c140d7c6f79dcb018640225f14d406c149e4eec04a7d82fe71/aiohttp-3.14.1-cp313-cp313-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:1b9748363260121d2927704f5d4fc498150669ca3ae93625986ee89c8f80dcd4", size = 501564, upload-time = "2026-06-07T21:07:23.388Z" }, { url = "https://files.pythonhosted.org/packages/75/7f/8cdaa24fc7983865e0915153b96a9ac5bcdd3548d64c5a27d17cecccad2d/aiohttp-3.14.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:86a6dab78b0e43e2897a3bbe15745aa60dc5423ca437b7b0b164c069bf91b876", size = 751998, upload-time = "2026-06-07T21:07:25.046Z" }, { url = "https://files.pythonhosted.org/packages/b2/f4/c4227aacfacc5cb0cc2d119b65301d177912a6842cd64e120c47af76064f/aiohttp-3.14.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:4dfd6e47d3c44c2279907607f73a4240b88c69eb8b90da7e2441a8045dfd21da", size = 510918, upload-time = "2026-06-07T21:07:27.28Z" }, { url = "https://files.pythonhosted.org/packages/ab/01/a2d5f96cd4e74424864d30bc0a7e44d0a12dacdcfa91b5b2d1bd3dca6bf3/aiohttp-3.14.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:317acd9f8602858dc7d59679812c376c7f0b97bcbbf16e0d6237f54141d8a8a6", size = 508657, upload-time = "2026-06-07T21:07:29.252Z" }, { url = "https://files.pythonhosted.org/packages/e8/ed/3c0fb5c500fdd8e7ebc10d1889c04384fffa1a9163eac1356088ca9da1b1/aiohttp-3.14.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:bd869c427324e5cb15195793de951295710db28be7d818247f3097b4ab5d4b96", size = 1757907, upload-time = "2026-06-07T21:07:31.03Z" }, { url = "https://files.pythonhosted.org/packages/0b/ab/d4c924d9bd5be3050c226612413ce68cb54c70d2c31b661bfc8d9a5b6a70/aiohttp-3.14.1-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:93b032b5ec3255473c143627d21a69ac74ae12f7f33974cb587c564d11b1066f", size = 1737565, upload-time = "2026-06-07T21:07:33.031Z" }, { url = "https://files.pythonhosted.org/packages/19/2a/37326821ff779084020cdc33224d20b19f42f4183a500ff92022a739eda7/aiohttp-3.14.1-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f234b4deb12f3ad59127e037bc57c40c21e45b45282df7d3a55a0f409f595296", size = 1799018, upload-time = "2026-06-07T21:07:35.003Z" }, { url = "https://files.pythonhosted.org/packages/b3/4f/6e947ba73e4ce09070761c05ed3a8ceb7c21f5e46798671d8b2aac0e4626/aiohttp-3.14.1-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:9af6779bfb46abf124068327abcdf9ce95c9ef8287a3e8da76ccf2d0f16c28fa", size = 1894416, upload-time = "2026-06-07T21:07:36.956Z" }, { url = "https://files.pythonhosted.org/packages/9d/6e/dbf1d0625dc711fb2851f4f3c3055c39ed58bae92082d8c627dbe6013736/aiohttp-3.14.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:faccab372e66bc76d5731525e7f1143c922271725b9d38c9f97edcc66266b451", size = 1783881, upload-time = "2026-06-07T21:07:39.063Z" }, { url = "https://files.pythonhosted.org/packages/44/c2/5e25098a67268ed369483ae7d1a58bd0a13d03aab860d2a0e4a6eb25b046/aiohttp-3.14.1-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:f380468b09d2a81633ee863b0ec5648d364bd17bb8ecfb8c2f387f7ac1faf42c", size = 1587572, upload-time = "2026-06-07T21:07:41.058Z" }, { url = "https://files.pythonhosted.org/packages/2a/bd/cf9cee17e140f942a3de73e658a543aa8fbf35a5fc67a9d2538d52d77f0b/aiohttp-3.14.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:97e704dcd26271f5bda3fa07c3ce0fb76d6d3f8659f4baa1a24442cc9ba177ca", size = 1722137, upload-time = "2026-06-07T21:07:43.014Z" }, { url = "https://files.pythonhosted.org/packages/89/6d/5684f8c59045c96f81a18cefbc1fbbd79d25b88f1c622f2a5c5c08fcb632/aiohttp-3.14.1-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:269b76ac5394092b95bc4a098f4fc6c191c083c3bd12775d1e30e663132f6a09", size = 1755953, upload-time = "2026-06-07T21:07:45.933Z" }, { url = "https://files.pythonhosted.org/packages/a8/40/35caf3170f8359760740a7d9aa0fff2e344bef98e1d1186f5a0f6dec17e6/aiohttp-3.14.1-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:5c0b3e614340c889d575451696374c9d17affd54cd607ca0babed8f8c37b9397", size = 1766479, upload-time = "2026-06-07T21:07:48.047Z" }, { url = "https://files.pythonhosted.org/packages/6d/a1/b0c61e7a137f0d81de49a82023a6df73c3c16d6fefb0f8e4a93d21639002/aiohttp-3.14.1-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:5663ee9257cfa1add7253a7da3035a02f31b6600ec48261585e1800a81533080", size = 1580077, upload-time = "2026-06-07T21:07:50.069Z" }, { url = "https://files.pythonhosted.org/packages/0b/41/194ea4623693009fcefebef7aef63c141754f153e9cd0d39d3b9e36c175c/aiohttp-3.14.1-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:603a2c834142172ffddc054067f5ec0ca65d57a0aa98a71bc81952573208e345", size = 1791688, upload-time = "2026-06-07T21:07:52.106Z" }, { url = "https://files.pythonhosted.org/packages/ba/45/4de841f005cfe1fd63e2a2fe011262c515e2a62aa6994b15947e7d717ac9/aiohttp-3.14.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:cb21957bb8aca671c1765e32f58164cf0c50e6bf41c0bbbd16da20732ecaf588", size = 1761094, upload-time = "2026-06-07T21:07:54.113Z" }, { url = "https://files.pythonhosted.org/packages/e4/ae/dbce10533d3896d544d5053939ed75b7dc31a1b0973d959b1b5ae21028d6/aiohttp-3.14.1-cp313-cp313-win32.whl", hash = "sha256:e509a55f681e6158c20f70f102f9cf61fb20fbc382272bc6d94b7343f2582780", size = 452662, upload-time = "2026-06-07T21:07:56.06Z" }, { url = "https://files.pythonhosted.org/packages/7b/d9/0bf1a19362c32f06229da5e7ddfcec91f93474d6307f7a2d3135e9c674dc/aiohttp-3.14.1-cp313-cp313-win_amd64.whl", hash = "sha256:1ac8531b638959718e18c2207fbfe297819875da46a740b29dfa29beba64355a", size = 479748, upload-time = "2026-06-07T21:07:58.319Z" }, { url = "https://files.pythonhosted.org/packages/22/0a/62e7232dc9484fbec112ceb32efb6a624cc7994ec6e2b019286f17c4e8f2/aiohttp-3.14.1-cp313-cp313-win_arm64.whl", hash = "sha256:250d14af67f6b6a1a4a811049b1afa69d61d617fca6bf33149b3ab1a6dbcf7b8", size = 447723, upload-time = "2026-06-07T21:08:00.154Z" }, { url = "https://files.pythonhosted.org/packages/c4/a1/5fafa04e1ca91ddb47608699d60649c1c6db3cf41c99e78fc4056f9513db/aiohttp-3.14.1-cp314-cp314-android_24_arm64_v8a.whl", hash = "sha256:7c106c26852ca1c2047c6b80384f17100b4e439af276f21ef3d4e2f450ae7e15", size = 508531, upload-time = "2026-06-07T21:08:02.093Z" }, { url = "https://files.pythonhosted.org/packages/fa/2e/bfa02f699d87ffc86d5959270b28f1cb410add3ccaced8ed2e0b8a5238fc/aiohttp-3.14.1-cp314-cp314-android_24_x86_64.whl", hash = "sha256:20205f7f5ade7aaec9f4b500549bbc071b046453aed72f9c06dcab87896a83e8", size = 514718, upload-time = "2026-06-07T21:08:04.476Z" }, { url = "https://files.pythonhosted.org/packages/85/a5/9594ad6289eebbc97d167c44213d557807f90e59115caad24de21ad2c3b1/aiohttp-3.14.1-cp314-cp314-ios_13_0_arm64_iphoneos.whl", hash = "sha256:62a759436b29e677181a9e76bab8b8f689a29cb9c535f45f7c48c9c830d3f8c3", size = 487918, upload-time = "2026-06-07T21:08:06.377Z" }, { url = "https://files.pythonhosted.org/packages/b4/61/16a32c36c3c49edec122a3dc811f2057df2f94d3b14aa107c8017d981618/aiohttp-3.14.1-cp314-cp314-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:2964cbf553df4d7a57348da44d961d871895fc1ee4e8c322b2a95612c7b17fba", size = 494014, upload-time = "2026-06-07T21:08:08.263Z" }, { url = "https://files.pythonhosted.org/packages/9b/89/3ebcf96ed99c05bec9c434aaac6963fd3cbab4a786ae739908a144d9ce44/aiohttp-3.14.1-cp314-cp314-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:237651caadc3a59badd39319c54642b5299e9cc98a3a194310e55d5bb9f5e397", size = 502398, upload-time = "2026-06-07T21:08:10.244Z" }, { url = "https://files.pythonhosted.org/packages/fd/3d/b74870a0c2d40c355928cd5b96c7a11fa821b8a40fc41365e64479b151fb/aiohttp-3.14.1-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:896e12dfdbbab9d8f7e16d2b28c6769a60126fa92095d1ebf9473d02593a2448", size = 758018, upload-time = "2026-06-07T21:08:12.447Z" }, { url = "https://files.pythonhosted.org/packages/d3/66/f42f5c984d99e49c6cff5f26f590750f2e2f7ef1fcfb99966ab5be1b632e/aiohttp-3.14.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:d03f281ed22579314ba00821ce20115a7c0ac430660b4cc05704a3f818b3e004", size = 512462, upload-time = "2026-06-07T21:08:14.624Z" }, { url = "https://files.pythonhosted.org/packages/e9/a7/248e1aebe0c7810b0271e021a0f2a5eb6e78a051885b3c9df49f42a5802d/aiohttp-3.14.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:07eabb979d236335fed927e137a928c9adfb7df3b9ec7aa31726f133a62be983", size = 512824, upload-time = "2026-06-07T21:08:16.572Z" }, { url = "https://files.pythonhosted.org/packages/26/97/2aa0e5ba0727dc3bd5aaebb7ccbc510f7dfb7fb961ec87497cd496635ab1/aiohttp-3.14.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4fe1f1087cbadb280b5e1bb054a4f00d1423c74d6626c5e48400d871d34ecefe", size = 1749898, upload-time = "2026-06-07T21:08:18.635Z" }, { url = "https://files.pythonhosted.org/packages/00/8d/e97f6c96c891d457c8479d92a514ba194d0412f981d72c70341ee18488ed/aiohttp-3.14.1-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:367a9314fdc79dab0fac96e216cb41dd73c85bdca85306ce8999118ba7e0f333", size = 1710114, upload-time = "2026-06-07T21:08:20.892Z" }, { url = "https://files.pythonhosted.org/packages/6f/e6/aa8d7e863048c8fceb5cd6ce74017311cec3ead07847387e12265fb4444e/aiohttp-3.14.1-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:a24f677ebe83749039e7bdf862ff0bbb16818ae4193d4ef96505e269375bcce0", size = 1802541, upload-time = "2026-06-07T21:08:23.044Z" }, { url = "https://files.pythonhosted.org/packages/83/a8/72193137de57fda4ebfae4563182d082c8856e3b6e9871d0b46f028fb369/aiohttp-3.14.1-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:c83afe0ba876be7e943d2e0ba645809ad441575d2840c895c21ee5de93b9377a", size = 1875776, upload-time = "2026-06-07T21:08:25.288Z" }, { url = "https://files.pythonhosted.org/packages/a0/18/938441025db6769a3464596b2410af3afde0b21eb2f204c6f766f68af4bd/aiohttp-3.14.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:634e385930fb6d2d479cf3aa66515955863b77a5e3c2b5894ca259a25b308602", size = 1760329, upload-time = "2026-06-07T21:08:27.363Z" }, { url = "https://files.pythonhosted.org/packages/60/29/bf2496b4065e76e09fe48015aaffe5ce161d8f089b06ac6982070f653076/aiohttp-3.14.1-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:eeea07c4397bbc57719c4eed8f9c284874d4f175f9b6d57f7a1546b976d455ca", size = 1587293, upload-time = "2026-06-07T21:08:29.805Z" }, { url = "https://files.pythonhosted.org/packages/49/a2/2136674d52123b1354bd05dd5753c318db47dc0c927cc70b27bab3755456/aiohttp-3.14.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:335c0cc3e3545ce98dcb9cfcb836f40c3411f43fa03dab757597d80c89af8a35", size = 1714756, upload-time = "2026-06-07T21:08:32.094Z" }, { url = "https://files.pythonhosted.org/packages/a7/b9/e5fd2e6f915503081c0f9b1e8540947037929c70c191da2e4d54b31a21a1/aiohttp-3.14.1-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:ae6be797afdef264e8a84864a85b196ca06045586481b3df8a967322fd2fa844", size = 1721052, upload-time = "2026-06-07T21:08:34.167Z" }, { url = "https://files.pythonhosted.org/packages/63/5a/2833e324a2263e104e31e2e91bc5bbee81bc499afd32203faee048a883f0/aiohttp-3.14.1-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:8560b4d712474335d08907db7973f71912d3a9a8f1dee992ec06b5d2fe359496", size = 1766888, upload-time = "2026-06-07T21:08:36.95Z" }, { url = "https://files.pythonhosted.org/packages/57/fa/dea6511870913162f3b2e8c42a7614eb203a4540b8c2da43e0bfb0548f3c/aiohttp-3.14.1-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:2b7edd08e0a5deb1e8564a2fcd8f4561014a3f05252334671bbf55ddd47db0e5", size = 1581679, upload-time = "2026-06-07T21:08:39.292Z" }, { url = "https://files.pythonhosted.org/packages/14/bd/3cf0d55e71784b33534e9710a67d382d900598b4787fbce6cc7317f8c42a/aiohttp-3.14.1-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:b6ff7fcee63287ae57b5df3e4f5957ce032122802509246dec1a5bcc55904c95", size = 1782021, upload-time = "2026-06-07T21:08:41.407Z" }, { url = "https://files.pythonhosted.org/packages/c1/af/14bb5843eccbe234f4dfb78ab73e549d99727247e62ae5d62cbd22eaf5b0/aiohttp-3.14.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:6ffbb2f4ec1ceaff7e07d43922954da26b223d188bf30658e561b98e23089444", size = 1742574, upload-time = "2026-06-07T21:08:43.795Z" }, { url = "https://files.pythonhosted.org/packages/f2/1e/fbeb7af9210a67ac0f9c9bec0f8f4568497924e33137a3d5b48e1cf85f3f/aiohttp-3.14.1-cp314-cp314-win32.whl", hash = "sha256:a9875b46d910cff3ea2f5962f9d266b465459fe634e22556ab9bd6fc1192eea0", size = 457773, upload-time = "2026-06-07T21:08:46.168Z" }, { url = "https://files.pythonhosted.org/packages/f0/2b/13e8d741a9ec5db7d900c060554cf8352ab85e44e2a4469ebb9d377bda17/aiohttp-3.14.1-cp314-cp314-win_amd64.whl", hash = "sha256:af8b4b81a960eeaf1234971ac3cd0ba5901f3cd42eae42a46b4d089a8b492719", size = 485001, upload-time = "2026-06-07T21:08:48.401Z" }, { url = "https://files.pythonhosted.org/packages/df/30/491acfa2c4d6c3ff59c49a14fc1b50be3241e25bbb0c84c09e2da4d11395/aiohttp-3.14.1-cp314-cp314-win_arm64.whl", hash = "sha256:cf4491381b1b57425c315a56a439251b1bdac07b2275f19a8c44bc57744532ec", size = 453809, upload-time = "2026-06-07T21:08:50.7Z" }, { url = "https://files.pythonhosted.org/packages/34/e3/19dbe1a1f4cc6230eb9e314de7fe68053b0992f9302b27d12141a0b5db53/aiohttp-3.14.1-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:819c054312f1af92947e6a55883d1b66feefab11531a7fc45e0fb9b63880b5c2", size = 793320, upload-time = "2026-06-07T21:08:52.775Z" }, { url = "https://files.pythonhosted.org/packages/7f/20/1b7182219ba1b108430d6e4dc53d25ae02dcfcf5a045b33af4e8c5167527/aiohttp-3.14.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:10ee9c1753a8f706345b22496c79fbddb5be0599e0823f3738b1534058e25340", size = 529077, upload-time = "2026-06-07T21:08:55Z" }, { url = "https://files.pythonhosted.org/packages/b9/c8/14ce60ec31a2e5f5274bb17d383a6f7a3aabca31ac04eee05585bbadab16/aiohttp-3.14.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:1601cc37baf5750ccacae618ec2daf020769581695550e3b654a911f859c563d", size = 532476, upload-time = "2026-06-07T21:08:57.176Z" }, { url = "https://files.pythonhosted.org/packages/7e/02/9ac85e081e53da2e061b02fa7758fe0a12d17b8ce2d1f5e6c7cb76730328/aiohttp-3.14.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4d6e0ac9da31c9c04c84e1c0182ad8d6df35965a85cae29cd71d089621b3ae94", size = 1922347, upload-time = "2026-06-07T21:08:59.563Z" }, { url = "https://files.pythonhosted.org/packages/c0/3e/d3ba07a0ab38b5389e10bec4362d21e10a4f667cba2d79ba30837b3a5059/aiohttp-3.14.1-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:9e8f2d660c350b3d0e259c7a7e3d9b7fc8b41210cbcc3d4a7076ff0a5e5c2fdc", size = 1786465, upload-time = "2026-06-07T21:09:01.909Z" }, { url = "https://files.pythonhosted.org/packages/0b/cb/e2ee978a00cfb2df829704a69528b18154eba5939f45bc1efa8f33aee4c5/aiohttp-3.14.1-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:4691802dda97be727f79d86818acaad7eb8e9252626a1d6b519fedbb92d5e251", size = 1909423, upload-time = "2026-06-07T21:09:04.357Z" }, { url = "https://files.pythonhosted.org/packages/73/5d/1430334858b1022b58ae50399a918f0bd6fe8fa7fa183598d657ff61e040/aiohttp-3.14.1-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:c389c482a7e9b9dc3ee2701ac46c4125297a3818875b9c305ddb603c04828fd1", size = 2001906, upload-time = "2026-06-07T21:09:06.722Z" }, { url = "https://files.pythonhosted.org/packages/66/4e/560c7472d3d198a23aa5c8b19a5115bf6a9b77b7d3e4bb363da320430ad2/aiohttp-3.14.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fc0cacab7ba4e56f0f81c82a98c09bed2f39c940107b03a34b168bdf7597edd3", size = 1877095, upload-time = "2026-06-07T21:09:09.011Z" }, { url = "https://files.pythonhosted.org/packages/0d/f1/4745806578d447db4a784a8591e2dae3afdfc2bcb96f8f81271b13df6543/aiohttp-3.14.1-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:979ed4717f59b8bb12e3963378fa285d93d367e15bcd66c721311826d3c44a6c", size = 1676222, upload-time = "2026-06-07T21:09:11.461Z" }, { url = "https://files.pythonhosted.org/packages/6a/c9/48255813cca749a229ef0ab476004ec623728ad79a9c0840616f6c076325/aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:38e1e7daaea81df51c952e18483f323d878499a1e2bfe564790e0f9701d6f203", size = 1842922, upload-time = "2026-06-07T21:09:14.118Z" }, { url = "https://files.pythonhosted.org/packages/3d/c0/bbd054e2bee909f529523a5af3891052606af5143c09f5f183ec3b234676/aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:4132e72c608fe9fecb8f409113567605915b83e9bdd3ea56538d2f9cd35002f1", size = 1825035, upload-time = "2026-06-07T21:09:16.447Z" }, { url = "https://files.pythonhosted.org/packages/a8/ae/90395d4376deceb74e09ec26b6adf7d2015a6f8802d6d84446af860fef04/aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:eefd9cc9b6d4a2db5f00a26bc3e4f9acf71926a6ec557cd56c9c6f27c290b665", size = 1849512, upload-time = "2026-06-07T21:09:18.742Z" }, { url = "https://files.pythonhosted.org/packages/93/bd/fb25f3049957553d4ce0ba6ae480aa2f592a6985497fca590837d16c1be0/aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:b165790117eea512d7f3fb22f1f6dad3d55a7189571993eb015591c1401276d1", size = 1668571, upload-time = "2026-06-07T21:09:21.458Z" }, { url = "https://files.pythonhosted.org/packages/3f/22/7f73303d64dd567ff3addca90b556690ed1233a47b8f55d242fb90af3681/aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:ed09c7eb1c391271c2ed0314a51903e72a3acb653d5ccfc264cdf3ef11f8269d", size = 1881159, upload-time = "2026-06-07T21:09:23.813Z" }, { url = "https://files.pythonhosted.org/packages/44/be/0474c5a8b5640e1e4aa1923430a91f4151be82e511373fe764189b89aef5/aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:99abd37084b82f5830c635fddd0b4993b9742a66eb746dacf433c8590e8f9e3c", size = 1841409, upload-time = "2026-06-07T21:09:26.207Z" }, { url = "https://files.pythonhosted.org/packages/7b/3c/bb4a7cba26956cb3da4553cc2056cf67be5b5ff6e6d8fa4fbdff73bfb7ae/aiohttp-3.14.1-cp314-cp314t-win32.whl", hash = "sha256:47ddf841cdecc810749921d25606dee45857d12d2ad5ddb7b5bd7eab12e4b365", size = 494166, upload-time = "2026-06-07T21:09:28.505Z" }, { url = "https://files.pythonhosted.org/packages/8a/84/ec80c2c1f66a952555a9f86df6b33af65108a6febfa0471b69013a12f807/aiohttp-3.14.1-cp314-cp314t-win_amd64.whl", hash = "sha256:5e78b522b7a6e27e0b25d19b247b75039ac4c94f99823e3c9e53ae1603a9f7e9", size = 530255, upload-time = "2026-06-07T21:09:30.843Z" }, { url = "https://files.pythonhosted.org/packages/2a/71/6e22be134a4061ada85a92951b842f2657f17d926b727f3f94c56ae963d6/aiohttp-3.14.1-cp314-cp314t-win_arm64.whl", hash = "sha256:90d53f1609c29ccc2193945ef732428382a28f78d0456ae4d3daf0d48b74f0f6", size = 469640, upload-time = "2026-06-07T21:09:33.028Z" }, ] [[package]] name = "aioitertools" version = "0.13.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/fd/3c/53c4a17a05fb9ea2313ee1777ff53f5e001aefd5cc85aa2f4c2d982e1e38/aioitertools-0.13.0.tar.gz", hash = "sha256:620bd241acc0bbb9ec819f1ab215866871b4bbd1f73836a55f799200ee86950c", size = 19322, upload-time = "2025-11-06T22:17:07.609Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/10/a1/510b0a7fadc6f43a6ce50152e69dbd86415240835868bb0bd9b5b88b1e06/aioitertools-0.13.0-py3-none-any.whl", hash = "sha256:0be0292b856f08dfac90e31f4739432f4cb6d7520ab9eb73e143f4f2fa5259be", size = 24182, upload-time = "2025-11-06T22:17:06.502Z" }, ] [[package]] name = "aiosignal" version = "1.4.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "frozenlist" }, { name = "typing-extensions", marker = "python_full_version < '3.13'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/61/62/06741b579156360248d1ec624842ad0edf697050bbaf7c3e46394e106ad1/aiosignal-1.4.0.tar.gz", hash = "sha256:f47eecd9468083c2029cc99945502cb7708b082c232f9aca65da147157b251c7", size = 25007, upload-time = "2025-07-03T22:54:43.528Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/fb/76/641ae371508676492379f16e2fa48f4e2c11741bd63c48be4b12a6b09cba/aiosignal-1.4.0-py3-none-any.whl", hash = "sha256:053243f8b92b990551949e63930a839ff0cf0b0ebbe0597b0f3fb19e1a0fe82e", size = 7490, upload-time = "2025-07-03T22:54:42.156Z" }, ] [[package]] name = "alabaster" version = "1.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/a6/f8/d9c74d0daf3f742840fd818d69cfae176fa332022fd44e3469487d5a9420/alabaster-1.0.0.tar.gz", hash = "sha256:c00dca57bca26fa62a6d7d0a9fcce65f3e026e9bfe33e9c538fd3fbb2144fd9e", size = 24210, upload-time = "2024-07-26T18:15:03.762Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/7e/b3/6b4067be973ae96ba0d615946e314c5ae35f9f993eca561b356540bb0c2b/alabaster-1.0.0-py3-none-any.whl", hash = "sha256:fc6786402dc3fcb2de3cabd5fe455a2db534b371124f1f21de8731783dec828b", size = 13929, upload-time = "2024-07-26T18:15:02.05Z" }, ] [[package]] name = "annotated-doc" version = "0.0.4" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/57/ba/046ceea27344560984e26a590f90bc7f4a75b06701f653222458922b558c/annotated_doc-0.0.4.tar.gz", hash = "sha256:fbcda96e87e9c92ad167c2e53839e57503ecfda18804ea28102353485033faa4", size = 7288, upload-time = "2025-11-10T22:07:42.062Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/1e/d3/26bf1008eb3d2daa8ef4cacc7f3bfdc11818d111f7e2d0201bc6e3b49d45/annotated_doc-0.0.4-py3-none-any.whl", hash = "sha256:571ac1dc6991c450b25a9c2d84a3705e2ae7a53467b5d111c24fa8baabbed320", size = 5303, upload-time = "2025-11-10T22:07:40.673Z" }, ] [[package]] name = "annotated-types" version = "0.7.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/ee/67/531ea369ba64dcff5ec9c3402f9f51bf748cec26dde048a2f973a4eea7f5/annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89", size = 16081, upload-time = "2024-05-20T21:33:25.928Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/78/b6/6307fbef88d9b5ee7421e68d78a9f162e0da4900bc5f5793f6d3d0e34fb8/annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53", size = 13643, upload-time = "2024-05-20T21:33:24.1Z" }, ] [[package]] name = "antlr4-python3-runtime" version = "4.13.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/33/5f/2cdf6f7aca3b20d3f316e9f505292e1f256a32089bd702034c29ebde6242/antlr4_python3_runtime-4.13.2.tar.gz", hash = "sha256:909b647e1d2fc2b70180ac586df3933e38919c85f98ccc656a96cd3f25ef3916", size = 117467, upload-time = "2024-08-03T19:00:12.757Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/89/03/a851e84fcbb85214dc637b6378121ef9a0dd61b4c65264675d8a5c9b1ae7/antlr4_python3_runtime-4.13.2-py3-none-any.whl", hash = "sha256:fe3835eb8d33daece0e799090eda89719dbccee7aa39ef94eed3818cafa5a7e8", size = 144462, upload-time = "2024-08-03T19:00:11.134Z" }, ] [[package]] name = "ast-serialize" version = "0.6.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/58/ad/0d70a3a2d6e01968d985415259e8ec7ad3f777903f9b1c1f3c8c44642c60/ast_serialize-0.6.0.tar.gz", hash = "sha256:aadd3ffcf4858c9726bf3515f7b199c7eadbe504f96028e4a87172c0da65a8fe", size = 61489, upload-time = "2026-06-30T20:02:55.555Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/3f/12/3e5f575f156555547c250a8b0d1347517a3a20fc7f4492e9703a69d4f45e/ast_serialize-0.6.0-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:a7520b672827885bafeae7501f684d14d47d17e5f45256f9df547686cca52264", size = 1177640, upload-time = "2026-06-30T20:02:06.708Z" }, { url = "https://files.pythonhosted.org/packages/a2/a4/921a9e27951627983b0f368859ea00f8330a551dc0bf4c2fdcb11855a98b/ast_serialize-0.6.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:a14191beec7e0c078d2fc1f6edc0aee88bcd4db9f18e1bc9f8052b559c22dddc", size = 1168111, upload-time = "2026-06-30T20:02:08.366Z" }, { url = "https://files.pythonhosted.org/packages/00/69/950cf404de7b8782cf95e5c1237e25e2aa46177b287f39f9eeddf481fd6f/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:32ef62ec34cf6be20ad77d4799556638fbdf187f3ae10698dfb20ef9f2c89516", size = 1227656, upload-time = "2026-06-30T20:02:09.843Z" }, { url = "https://files.pythonhosted.org/packages/4c/a8/46f8f6a6479d9d2273980957bb091a506c55f5b95d3c029ee58518a78407/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:13b7769970a39983b0adf2f38917b1cd3b8946f76df045756c3d741bc689f089", size = 1227706, upload-time = "2026-06-30T20:02:11.367Z" }, { url = "https://files.pythonhosted.org/packages/b7/b9/9ac415bda0a40e49eab8fea3b2741c19c98bb84d57d62c4cfc6230eb67be/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6f7a408601bb3edaefb3bc67a4c01f5235e3253653b6a5729a2ee2382b35341c", size = 1431705, upload-time = "2026-06-30T20:02:12.737Z" }, { url = "https://files.pythonhosted.org/packages/e5/06/8807115d441444879f7561b5eede5ac18fc80392f11826d61ccf31f503b1/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8670bfa51208a2c0c8d138928e40e998fab158f9200d53bb80c088b5b8eda7b8", size = 1249533, upload-time = "2026-06-30T20:02:14.571Z" }, { url = "https://files.pythonhosted.org/packages/3e/c0/c2ba82ef9618650357d9421a1fdb27ffec862a7f57e8e2de82a3ccd11e12/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a4826809eb8597a8cd59fd924b6d7c285b8969a1e0007e2cb652cab62376270f", size = 1252619, upload-time = "2026-06-30T20:02:16.219Z" }, { url = "https://files.pythonhosted.org/packages/0f/a7/fa31d52dd4102cede29fb9634e98d214129b2783b4f95528c6dc6a8f6587/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_31_riscv64.whl", hash = "sha256:577a6c189068686869f5f1ddc38363f3ae1808a4753b577266f9202071a7bb66", size = 1242983, upload-time = "2026-06-30T20:02:17.813Z" }, { url = "https://files.pythonhosted.org/packages/b1/20/ddf742b5ad3c4bafd3466f2265037cfd99bc1b9a5ee46a5d58c90d523242/ast_serialize-0.6.0-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:085de7f62dc9cc247eb01e965a362707d1d90b1d89a82c5bf78301a60a3c417b", size = 1296148, upload-time = "2026-06-30T20:02:19.146Z" }, { url = "https://files.pythonhosted.org/packages/24/cb/9f6f217cce8b3b632c5568b478d195a35e79dce4dbe309438cb89ba6ea4f/ast_serialize-0.6.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:9f8a8b78b13173de6a9ec22111d9be674874cd5bdccda04f14ae5ebc2bef403a", size = 1403826, upload-time = "2026-06-30T20:02:20.696Z" }, { url = "https://files.pythonhosted.org/packages/2d/f8/9d16d4f0107a183924425cc0e7618d8bf76f96b45afa9ff19f924ed1ad57/ast_serialize-0.6.0-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:f2ff3baffc3a29c1f15bc9098aa0c09763410262d5e6cef42116f7356c184554", size = 1502943, upload-time = "2026-06-30T20:02:22.034Z" }, { url = "https://files.pythonhosted.org/packages/80/dd/bbc1c38756350dddf7e24acae1c9482ef42051c267417e019aecc1ed4075/ast_serialize-0.6.0-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:0067b25fce104eaae5b88383de9ab803faeb671831e14ca698b771b356e2600f", size = 1497632, upload-time = "2026-06-30T20:02:23.517Z" }, { url = "https://files.pythonhosted.org/packages/42/7e/9daffefcf5b97e6bb4c3e0b3c024c1aee9722f23d3cf7cd2ff80d6fb4a40/ast_serialize-0.6.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:c617417f9cbb0cb144f6283c3cbe0d2e0f01beaf9f608f662b21191058a626ec", size = 1448858, upload-time = "2026-06-30T20:02:24.889Z" }, { url = "https://files.pythonhosted.org/packages/e5/1f/f9baaab81a677ea0af7d2458cac2f94ebcc85958f8a3c15ba9d9e5dab653/ast_serialize-0.6.0-cp314-cp314t-win32.whl", hash = "sha256:5337cb256dcea3df9288205213d1601581536526b8f4da44b6974f1180f3252a", size = 1052600, upload-time = "2026-06-30T20:02:26.263Z" }, { url = "https://files.pythonhosted.org/packages/9e/1f/41b535866519512d8cf6669cb2cff7823b7672bb6279c0333b4ff89d7d9f/ast_serialize-0.6.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2d947e45cafc4b09bd7528917fa84c517654a43de173c79785574b7b3068ac24", size = 1095570, upload-time = "2026-06-30T20:02:27.639Z" }, { url = "https://files.pythonhosted.org/packages/50/64/e472fe3e3a2d33d874b987e8518aedf24562919e3b6161a4fa1797e89c0f/ast_serialize-0.6.0-cp314-cp314t-win_arm64.whl", hash = "sha256:6e15ec740436e1a0d62de848641abe5f3a2f89a7f94907d534795ac91bbacf14", size = 1067267, upload-time = "2026-06-30T20:02:28.949Z" }, { url = "https://files.pythonhosted.org/packages/52/19/ac8348ae8711c9b5ae834634f635780cab62a0f5e6f988882e048b89c2ae/ast_serialize-0.6.0-cp39-abi3-macosx_10_12_x86_64.whl", hash = "sha256:093cb8bb91b720d8523580498d031791bb1bbaa048599c3d21085d380e11a596", size = 1185367, upload-time = "2026-06-30T20:02:30.427Z" }, { url = "https://files.pythonhosted.org/packages/c1/f6/ec7ec652c51db77c2f61d8573338e13e4704303265ccc658cb4031d9f354/ast_serialize-0.6.0-cp39-abi3-macosx_11_0_arm64.whl", hash = "sha256:e61580a69faf47e3689795367ed211f2a10fd741478cc0f36a0f128793360aad", size = 1178657, upload-time = "2026-06-30T20:02:31.964Z" }, { url = "https://files.pythonhosted.org/packages/6f/02/613a7534a41d0122f37d1e0c64aa8ac78bfb831f8c92f6db057a311abb3c/ast_serialize-0.6.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:305802f2ce2a7c4e87835078ea85c58b586ddda8095b92fe2ead9364ae19c80a", size = 1238620, upload-time = "2026-06-30T20:02:33.664Z" }, { url = "https://files.pythonhosted.org/packages/4d/21/087957bba486242afc52f49b2d9e21c9dad00289356cf9efe67084015a9d/ast_serialize-0.6.0-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c7b8b8f0c42f752ea00b2b7d7c090b3f80d9c1c5c75cadf16423790a0cc74081", size = 1236075, upload-time = "2026-06-30T20:02:34.936Z" }, { url = "https://files.pythonhosted.org/packages/82/04/78128bbb170071c2c72a210a181f1c00e11cc1cec60a8beef747b07f9201/ast_serialize-0.6.0-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:cd5b91b9e6f2356ace3a556963b0cd783b395fbbb0bb17b4defc283415466e77", size = 1441348, upload-time = "2026-06-30T20:02:36.245Z" }, { url = "https://files.pythonhosted.org/packages/64/64/62fb99d6faf199b4c3e5b08a07136e9a0d7664bb249c6de3670e5b63e9b6/ast_serialize-0.6.0-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4d6ef91590258ada18909b9caea344dac4de2013906b035473cd674a43f4b790", size = 1258580, upload-time = "2026-06-30T20:02:37.53Z" }, { url = "https://files.pythonhosted.org/packages/ca/87/b4d6c38e0ccd5e85dc54cecdf933a152c60b28fe5d993a6d8a72fa6d5896/ast_serialize-0.6.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dcbed41e9386059fc0261d602445ede0976c2ecec2939688bcbcb9ed0b6f28b7", size = 1261693, upload-time = "2026-06-30T20:02:39.123Z" }, { url = "https://files.pythonhosted.org/packages/0e/4b/3676ca2191f39bafb75f93f99b2f429ec464586158fece2165f3572805dc/ast_serialize-0.6.0-cp39-abi3-manylinux_2_31_riscv64.whl", hash = "sha256:cdc4e6f930b9090c2f92c9036ad12ffb8e6e44d4a5ba06f1458a05d60f203f7b", size = 1252517, upload-time = "2026-06-30T20:02:40.511Z" }, { url = "https://files.pythonhosted.org/packages/f3/58/494ef8c4b4acb2f4a265ac934caf45f792a08fe27d6b853de35ad991941a/ast_serialize-0.6.0-cp39-abi3-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:897ac47b5637be41c0c07061c8a912fafa967ef1dc73fa115e4bfa70882a093b", size = 1304843, upload-time = "2026-06-30T20:02:41.961Z" }, { url = "https://files.pythonhosted.org/packages/b1/f2/13736d920ab3d49bbee80ef1a277dd7b7aaf3b3545efd9d2a8114fe05525/ast_serialize-0.6.0-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:c4af9a1386166e40ed01464991806f89038a2d89782576c7774876fa77034e32", size = 1413698, upload-time = "2026-06-30T20:02:44.179Z" }, { url = "https://files.pythonhosted.org/packages/a8/5a/e046f3899e2acba4677d7427b76431443a1aa1a0e583dfb05b55b69d55cf/ast_serialize-0.6.0-cp39-abi3-musllinux_1_2_armv7l.whl", hash = "sha256:c901adbd750029b9ac4ad3d6aa56853e0ad4875119fbf52b7b8298afc223828b", size = 1512209, upload-time = "2026-06-30T20:02:45.584Z" }, { url = "https://files.pythonhosted.org/packages/cc/c7/e42aaca7bb2d22a7c06d5a8c7930086c5a334e93d716e6fa5e6647a4515f/ast_serialize-0.6.0-cp39-abi3-musllinux_1_2_i686.whl", hash = "sha256:3ae22a366b752ab4496191525b78b097b5b72d531752e3c1dd7e383a8f2c8a1a", size = 1508464, upload-time = "2026-06-30T20:02:46.942Z" }, { url = "https://files.pythonhosted.org/packages/95/93/5524a3dc6c3f593de3228ed9cbef73afa047625b7000ec21b7f58e6eb4d4/ast_serialize-0.6.0-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:4ed29121da8b3fdc291002801a1de0f76248fa07dce89157a5f277842cf6126e", size = 1457164, upload-time = "2026-06-30T20:02:48.294Z" }, { url = "https://files.pythonhosted.org/packages/4f/c0/36a6ffb4d653cf621427b4c4928671f53ad800c453474de2b82564a44ad9/ast_serialize-0.6.0-cp39-abi3-pyemscripten_2026_0_wasm32.whl", hash = "sha256:b1dac4e09d341c1300ba69cdcbe62867b32a8c75d90db9bf4d083bec3b039f0b", size = 863014, upload-time = "2026-06-30T20:02:49.742Z" }, { url = "https://files.pythonhosted.org/packages/09/c7/7d5ad8b49e1278e1c2a1e0274bd7850560b3f09313aa00c13bc8d5544792/ast_serialize-0.6.0-cp39-abi3-win32.whl", hash = "sha256:82c312a7844d2fdeb4d5c48bd3d215bf940dafd4704e1a9bcf252a99010a99b1", size = 1063165, upload-time = "2026-06-30T20:02:50.98Z" }, { url = "https://files.pythonhosted.org/packages/47/ae/6710c14ecb276031cf10249f6adf5a59e2d3fdb3b5183bd59f70524067ee/ast_serialize-0.6.0-cp39-abi3-win_amd64.whl", hash = "sha256:113b58346f9ceb664352032770caca817d4a3c86f611c6088e6ef65ddaa70f0e", size = 1101444, upload-time = "2026-06-30T20:02:52.554Z" }, { url = "https://files.pythonhosted.org/packages/66/40/c53deb2cd0c9b0fb636d24d9f40924cf2e65028e6b20b10cd5c1eeb2c730/ast_serialize-0.6.0-cp39-abi3-win_arm64.whl", hash = "sha256:ccd132fe8db56f61fe743b1f644d01b8d65b83248a8da506f3132bda86d6ed5e", size = 1072965, upload-time = "2026-06-30T20:02:54.097Z" }, ] [[package]] name = "astor" version = "0.8.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/5a/21/75b771132fee241dfe601d39ade629548a9626d1d39f333fde31bc46febe/astor-0.8.1.tar.gz", hash = "sha256:6a6effda93f4e1ce9f618779b2dd1d9d84f1e32812c23a29b3fff6fd7f63fa5e", size = 35090, upload-time = "2019-12-10T01:50:35.51Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c3/88/97eef84f48fa04fbd6750e62dcceafba6c63c81b7ac1420856c8dcc0a3f9/astor-0.8.1-py2.py3-none-any.whl", hash = "sha256:070a54e890cefb5b3739d19f30f5a5ec840ffc9c50ffa7d23cc9fc1a38ebbfc5", size = 27488, upload-time = "2019-12-10T01:50:33.628Z" }, ] [[package]] name = "astroid" version = "4.1.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/da/fd/24475b7cfb70298e8921bc077adb46a3fe77887422545d8a061573e130ee/astroid-4.1.2.tar.gz", hash = "sha256:d6c4a52bfcda4bbeb7359dead642b0248b90f7d9a07e690230bd86fefd6d37f1", size = 414896, upload-time = "2026-03-22T19:16:42.075Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/54/97/4ee9b0438e85bf0a808a89ef0be357319252ab27e1b313ae0aef7aeaa5a6/astroid-4.1.2-py3-none-any.whl", hash = "sha256:21312e682c0866dc5a309ee57e4b88ea92751b9955a58b1c31371cbbeb088707", size = 279956, upload-time = "2026-03-22T19:16:40.062Z" }, ] [[package]] name = "attrs" version = "26.1.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/9a/8e/82a0fe20a541c03148528be8cac2408564a6c9a0cc7e9171802bc1d26985/attrs-26.1.0.tar.gz", hash = "sha256:d03ceb89cb322a8fd706d4fb91940737b6642aa36998fe130a9bc96c985eff32", size = 952055, upload-time = "2026-03-19T14:22:25.026Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/64/b4/17d4b0b2a2dc85a6df63d1157e028ed19f90d4cd97c36717afef2bc2f395/attrs-26.1.0-py3-none-any.whl", hash = "sha256:c647aa4a12dfbad9333ca4e71fe62ddc36f4e63b2d260a37a8b83d2f043ac309", size = 67548, upload-time = "2026-03-19T14:22:23.645Z" }, ] [[package]] name = "aws-sam-translator" version = "1.109.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "boto3" }, { name = "jsonschema" }, { name = "pydantic" }, { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/e0/09/f62aa8d076f6ba85080ec6291e61af345e9be0daf8a4094101555e054ec7/aws_sam_translator-1.109.0.tar.gz", hash = "sha256:0c5e60223ae8434ce0c6bdb9a491d69ba3ec97e15c0d825d3803f7806382d804", size = 369016, upload-time = "2026-04-08T23:34:32.535Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/89/29/db13205af6bbebdc8dae9dd603ef97ee10a23cd8a3e26d9de728948b2e33/aws_sam_translator-1.109.0-py3-none-any.whl", hash = "sha256:9a6376e7c6d4fee173342b8b557035a8e3ec36e795e175e870411c8e4238873d", size = 432447, upload-time = "2026-04-08T23:34:30.881Z" }, ] [[package]] name = "aws-xray-sdk" version = "2.15.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "botocore" }, { name = "wrapt" }, ] sdist = { url = "https://files.pythonhosted.org/packages/14/25/0cbd7a440080def5e6f063720c3b190a25f8aa2938c1e34415dc18241596/aws_xray_sdk-2.15.0.tar.gz", hash = "sha256:794381b96e835314345068ae1dd3b9120bd8b4e21295066c37e8814dbb341365", size = 76315, upload-time = "2025-10-29T20:59:45Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ef/c3/f30a7a63e664acc7c2545ca0491b6ce8264536e0e5cad3965f1d1b91e960/aws_xray_sdk-2.15.0-py2.py3-none-any.whl", hash = "sha256:422d62ad7d52e373eebb90b642eb1bb24657afe03b22a8df4a8b2e5108e278a3", size = 103228, upload-time = "2025-10-29T21:00:24.12Z" }, ] [[package]] name = "babel" version = "2.18.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/7d/b2/51899539b6ceeeb420d40ed3cd4b7a40519404f9baf3d4ac99dc413a834b/babel-2.18.0.tar.gz", hash = "sha256:b80b99a14bd085fcacfa15c9165f651fbb3406e66cc603abf11c5750937c992d", size = 9959554, upload-time = "2026-02-01T12:30:56.078Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/77/f5/21d2de20e8b8b0408f0681956ca2c69f1320a3848ac50e6e7f39c6159675/babel-2.18.0-py3-none-any.whl", hash = "sha256:e2b422b277c2b9a9630c1d7903c2a00d0830c409c59ac8cae9081c92f1aeba35", size = 10196845, upload-time = "2026-02-01T12:30:53.445Z" }, ] [[package]] name = "backrefs" version = "7.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/5e/a7/a7dd63622beef68cc0d3c3c36d472e143dd95443d5ebf14cd1a5b4dfbf11/backrefs-7.0.tar.gz", hash = "sha256:4989bb9e1e99eb23647c7160ed51fb21d0b41b5d200f2d3017da41e023097e82", size = 7012453, upload-time = "2026-04-28T16:28:04.215Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/d4/39/39a31d7eae729ea14ed10c3ccef79371197177b9355a86cb3525709e8502/backrefs-7.0-py310-none-any.whl", hash = "sha256:b57cd227ea556b0aed3dc9b8da4628db4eabc0402c6d7fcfc69283a93955f7e9", size = 380824, upload-time = "2026-04-28T16:27:55.647Z" }, { url = "https://files.pythonhosted.org/packages/c9/b5/9302644225ba7dfa934a2ff2b9c7bb85701313a90dddb3dfaf693fa5bae2/backrefs-7.0-py311-none-any.whl", hash = "sha256:a0fa7360c63509e9e077e174ef4e6d3c21c8db94189b9d957289ae6d794b9475", size = 392626, upload-time = "2026-04-28T16:27:57.42Z" }, { url = "https://files.pythonhosted.org/packages/36/da/87912ddec6e06feffbaa3d7aa18fc6352bee2e8f1fee185d7d1690f8f4e8/backrefs-7.0-py312-none-any.whl", hash = "sha256:ca42ce6a49ace3d75684dfa9937f3373902a63284ecb385ce36d15e5dcb41c12", size = 398537, upload-time = "2026-04-28T16:27:58.913Z" }, { url = "https://files.pythonhosted.org/packages/00/bb/90ba423612b6aa0adccc6b1874bcd4a9b44b660c0c16f346611e00f64ac3/backrefs-7.0-py313-none-any.whl", hash = "sha256:f2c52955d631b9e1ac4cd56209f0a3a946d592b98e7790e77699339ae01c102a", size = 400491, upload-time = "2026-04-28T16:28:00.928Z" }, { url = "https://files.pythonhosted.org/packages/3e/5c/fb93d3092640a24dfb7bd7727a24016d7c01774ca013e60efd3f683c8002/backrefs-7.0-py314-none-any.whl", hash = "sha256:a6448b28180e3ca01134c9cf09dcebafad8531072e09903c5451748a05f24bc9", size = 412349, upload-time = "2026-04-28T16:28:02.412Z" }, ] [[package]] name = "blinker" version = "1.9.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/21/28/9b3f50ce0e048515135495f198351908d99540d69bfdc8c1d15b73dc55ce/blinker-1.9.0.tar.gz", hash = "sha256:b4ce2265a7abece45e7cc896e98dbebe6cead56bcf805a3d23136d145f5445bf", size = 22460, upload-time = "2024-11-08T17:25:47.436Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/10/cb/f2ad4230dc2eb1a74edf38f1a38b9b52277f75bef262d8908e60d957e13c/blinker-1.9.0-py3-none-any.whl", hash = "sha256:ba0efaa9080b619ff2f3459d1d500c57bddea4a6b424b60a91141db6fd2f08bc", size = 8458, upload-time = "2024-11-08T17:25:46.184Z" }, ] [[package]] name = "boto3" version = "1.43.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "botocore" }, { name = "jmespath" }, { name = "s3transfer" }, ] sdist = { url = "https://files.pythonhosted.org/packages/b7/65/47670987f2f9e181397872c7ee6415b7b95156d711b7eab6c55f66e575bc/boto3-1.43.0.tar.gz", hash = "sha256:80d44a943ef90aba7958ab31d30c155c198acc8a9581b5846b3878b2c8951086", size = 113143, upload-time = "2026-04-29T22:07:49.084Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/b3/a0/3e6a0b1c1ea6bec76f71473727ef27abf3cd40e9709b3ebcbfbcfaae6f79/boto3-1.43.0-py3-none-any.whl", hash = "sha256:8ebe03754a4b73a5cb6ec2f14cca03ac33bd4760d0adea53da4724845130258b", size = 140497, upload-time = "2026-04-29T22:07:46.216Z" }, ] [[package]] name = "botocore" version = "1.43.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "jmespath" }, { name = "python-dateutil" }, { name = "urllib3" }, ] sdist = { url = "https://files.pythonhosted.org/packages/28/79/2f4be1896db3db7ccf44504253a175d56b6bd6b669619edc5147d1aa21ea/botocore-1.43.0.tar.gz", hash = "sha256:e933b31a2d644253e1d029d7d39e99ba41b87e29300534f189744cc438cdf928", size = 15286817, upload-time = "2026-04-29T22:07:31.723Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/bf/4b/afc1fef8a43bafb139f57f73bbd70df82807af5934321e8112ae50668827/botocore-1.43.0-py3-none-any.whl", hash = "sha256:cc5b15eaec3c6eac05d8012cb5ef17ebe891beb88a16ca13c374bfaece1241e6", size = 14970102, upload-time = "2026-04-29T22:07:27Z" }, ] [[package]] name = "cairocffi" version = "1.7.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "cffi" }, ] sdist = { url = "https://files.pythonhosted.org/packages/70/c5/1a4dc131459e68a173cbdab5fad6b524f53f9c1ef7861b7698e998b837cc/cairocffi-1.7.1.tar.gz", hash = "sha256:2e48ee864884ec4a3a34bfa8c9ab9999f688286eb714a15a43ec9d068c36557b", size = 88096, upload-time = "2024-06-18T10:56:06.741Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/93/d8/ba13451aa6b745c49536e87b6bf8f629b950e84bd0e8308f7dc6883b67e2/cairocffi-1.7.1-py3-none-any.whl", hash = "sha256:9803a0e11f6c962f3b0ae2ec8ba6ae45e957a146a004697a1ac1bbf16b073b3f", size = 75611, upload-time = "2024-06-18T10:55:59.489Z" }, ] [[package]] name = "cairosvg" version = "2.9.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "cairocffi" }, { name = "cssselect2" }, { name = "defusedxml" }, { name = "pillow" }, { name = "tinycss2" }, ] sdist = { url = "https://files.pythonhosted.org/packages/38/07/e8412a13019b3f737972dea23a2c61ca42becafc16c9338f4ca7a0caa993/cairosvg-2.9.0.tar.gz", hash = "sha256:1debb00cd2da11350d8b6f5ceb739f1b539196d71d5cf5eb7363dbd1bfbc8dc5", size = 40877, upload-time = "2026-03-13T15:42:00.564Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/bf/e0/5011747466414c12cac8a8df77aa235068669a6a5a5df301a96209db6054/cairosvg-2.9.0-py3-none-any.whl", hash = "sha256:4b82d07d145377dffdfc19d9791bd5fb65539bb4da0adecf0bdbd9cd4ffd7c68", size = 45962, upload-time = "2026-03-14T13:56:33.512Z" }, ] [[package]] name = "cast-value-rs" version = "0.4.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/44/88/3659e7a3e5c861ad1c689145adf26cc1a47a9e3dd8367690bfaab9fae161/cast_value_rs-0.4.0.tar.gz", hash = "sha256:26d71727b0b20c84ddcc721eddfc338fcfc2bd7dc500e0727fded2112a3ce7c3", size = 48896, upload-time = "2026-04-01T21:02:33.292Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c9/0b/13bbb127b1695272ab391d8d81266ae4fbae3dbcbb3943b1c712bc32ea82/cast_value_rs-0.4.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:f2f9c4ace575812436d74e84bf9c8e297e2c3c7d1aaccfa4507d4efc0b0b642c", size = 509234, upload-time = "2026-04-01T21:00:10.683Z" }, { url = "https://files.pythonhosted.org/packages/1d/d7/fb1e893a6897dbba983854942a1c5bd9d2689ae5e640c1878856bfbad4f6/cast_value_rs-0.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:233aca7d1012056f064c0e13921d1ddcd0998824225614fdd72afc325114eafd", size = 465329, upload-time = "2026-04-01T21:00:12.221Z" }, { url = "https://files.pythonhosted.org/packages/6c/61/087af77ba17979b0b6f4556793b36407f04457768f6127877ac50728c5fb/cast_value_rs-0.4.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e0eaddd64f2e00a8545279a0d937d8e41c85df847b1d34d693199a5946489a8d", size = 494432, upload-time = "2026-04-01T21:00:13.501Z" }, { url = "https://files.pythonhosted.org/packages/5d/98/c0c4239f1172d64eee3eeaa11aed9b096429d94f22e2d052ac8eaa55016b/cast_value_rs-0.4.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:6c15d16d459f43c66f4e913eef97aeb9f593e783344d276f93c86fc4785eadc8", size = 531316, upload-time = "2026-04-01T21:00:15.146Z" }, { url = "https://files.pythonhosted.org/packages/4a/a6/cd954496bde7ca8d55018e389643a9a053e165cb0bb9e9ab08a6a5679bbd/cast_value_rs-0.4.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:94f1430914a585f8475bc3b0617cc67d9eecb928cfe90548aa36a96ebdfed877", size = 659598, upload-time = "2026-04-01T21:00:16.71Z" }, { url = "https://files.pythonhosted.org/packages/de/12/58e62a3ba13e68969a51b180b8d94c13754cd41dbb8a751f724de25c17dd/cast_value_rs-0.4.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6b7bc5a910c2554da173e050bf49c2b24086273ce72fb3d941e58d2387174a99", size = 562379, upload-time = "2026-04-01T21:00:17.975Z" }, { url = "https://files.pythonhosted.org/packages/6d/20/d6e5555fbad2c7a89740d44c235a8db00913370fdec218fa7c5ba67b3d02/cast_value_rs-0.4.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b251eaf7dae58e51119b0f827fb348a72990ebe887e69d3a8b2c86f13b4c82ae", size = 556899, upload-time = "2026-04-01T21:00:19.45Z" }, { url = "https://files.pythonhosted.org/packages/45/0d/d4f81048ba28c0867076a9e5fa65af849260c5643be1f8ebf6e356e51999/cast_value_rs-0.4.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f97ea32da52c147342afe89c5bbfd7edc9644c832b2f54deb3388afb0c1ae911", size = 587816, upload-time = "2026-04-01T21:00:20.827Z" }, { url = "https://files.pythonhosted.org/packages/9d/d2/fe6ebbc017d75920b095150ae02aff387b710c24562ae23c96c9b388e787/cast_value_rs-0.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:52763c9da83e3e00dc8e63cd15b25bc9044bdd85148d67a3979fb396954c45be", size = 671468, upload-time = "2026-04-01T21:00:22.265Z" }, { url = "https://files.pythonhosted.org/packages/5a/78/9ee727254cc74198e34571d97260590bbdd11b71f193ddccf8374fc14629/cast_value_rs-0.4.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:e01e1941d035e1c640dfb900c89fab50787665640cd99ce403842de584720c68", size = 809484, upload-time = "2026-04-01T21:00:23.668Z" }, { url = "https://files.pythonhosted.org/packages/9b/2b/07f75100dc76e600c3c9562e72d4be05a3a6bc4fc761d5a4dddb169f282a/cast_value_rs-0.4.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:840f3000310aa2846839cd547312371d3e5a73cc95ed750e6c726638cf6c762c", size = 803296, upload-time = "2026-04-01T21:00:25.433Z" }, { url = "https://files.pythonhosted.org/packages/e3/9e/5b9d2e4fb157ddc8a5ee15d380e145078fad126f138630cf2bac5136971e/cast_value_rs-0.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:5ee3813bd223a45dd67a1a848ede57f6677183320152a315b3c69db8f745e9f2", size = 760952, upload-time = "2026-04-01T21:00:27.002Z" }, { url = "https://files.pythonhosted.org/packages/8e/8e/6ff327c27b7e24161b5d04f7916bce044c3d7750695d1d7ed139f13e977f/cast_value_rs-0.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:bc91d540ddc6e16785e464867a980c4fb714dc0d83a16d2dfa604604403266bd", size = 442019, upload-time = "2026-04-01T21:00:28.322Z" }, { url = "https://files.pythonhosted.org/packages/04/3f/ed6b219d7b62d32a0248940891c75dfc97e4df88e62966076cb0f5f9fc91/cast_value_rs-0.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:01a8161db167a4cf1d73b3eced2af01ed7bc0a6ffa937c3bd5ff33af79ba51c4", size = 387803, upload-time = "2026-04-01T21:00:30.151Z" }, { url = "https://files.pythonhosted.org/packages/d3/9d/16d38e5cdb91df16b06f4145482aacc3d486789d4901d149c8e346ff121d/cast_value_rs-0.4.0-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:a4a3b92d45447ca8407ccc4e4c50dbffb5f0266b83bc4eec8d44de51c8a5e7cd", size = 509653, upload-time = "2026-04-01T21:00:31.422Z" }, { url = "https://files.pythonhosted.org/packages/da/74/e293ca02ce1e0e8b3be08d2c28e450a3321eb2526af35b5c4e6837904181/cast_value_rs-0.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:63d06fc8ce800a98ce542da5a7631a39a19e3f1e99a25546e392bf415ccaaf0d", size = 465604, upload-time = "2026-04-01T21:00:32.759Z" }, { url = "https://files.pythonhosted.org/packages/4f/6d/1b7f161028fa617c9e896b37f014dce393578bfda32362de5b9e7f623d2c/cast_value_rs-0.4.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6e8a4b525b9cdf0b7fd62373e3452b62973943d441820bf49a71d6bb6ae4e55d", size = 494568, upload-time = "2026-04-01T21:00:34.277Z" }, { url = "https://files.pythonhosted.org/packages/fc/7b/e1f51e320330ac75ffecf037dd100d66c89a0b534fa4adc7cd8ffb87b2aa/cast_value_rs-0.4.0-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:6d605e8d8bd5ec841c7b7e8302ef3fd944ed4af5d89f7ecdc60f71309712a319", size = 532007, upload-time = "2026-04-01T21:00:35.813Z" }, { url = "https://files.pythonhosted.org/packages/03/b8/f2e109eee0dbdf611b608ee3384c9b5c8cf953c2dac80c9ce181c2a8e475/cast_value_rs-0.4.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b9a77f9debac4f017748695b5e126f137fbc62df3f02ef90467f50791d5d2572", size = 660049, upload-time = "2026-04-01T21:00:37.062Z" }, { url = "https://files.pythonhosted.org/packages/c6/f9/eafbe3622f0f2ec35979059ee693a25a219549ca727741d105a41246e35d/cast_value_rs-0.4.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dab9edb59f25165a934022b2372865cd19bdb187719c1df324b503f478524276", size = 562394, upload-time = "2026-04-01T21:00:38.754Z" }, { url = "https://files.pythonhosted.org/packages/cb/ae/96c0bafb8f1dc3b55598dbb34b1febf92632f1f2c4a7d439866593c8fa0a/cast_value_rs-0.4.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:972df11faab7b0794f16c3d6f8040a9c6b9c55b5ffc23e232057d141103f9830", size = 556762, upload-time = "2026-04-01T21:00:39.977Z" }, { url = "https://files.pythonhosted.org/packages/a4/47/db0182272fa794fba3c0102d28b9c7eaaab9755bae3ff4d603d66a6d0fe8/cast_value_rs-0.4.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a226c0ceb6397751bf92475b6f0d63f843ca81e8c7e94ce023d33e78b96e5d9f", size = 587838, upload-time = "2026-04-01T21:00:41.281Z" }, { url = "https://files.pythonhosted.org/packages/08/74/733a8c1562f6001888652cf5867d6439fd92aae5db4ce8979d1150fa1c2e/cast_value_rs-0.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbe2bd7df06bc8cafd3fbbcb66ea3f8ccbb2273c771fbe3538f98205f455705c", size = 671420, upload-time = "2026-04-01T21:00:42.559Z" }, { url = "https://files.pythonhosted.org/packages/b7/ff/725a0eb649a5a512c6aab87dfd9b2159c3fbe103a6ee1f63bbfe80969d34/cast_value_rs-0.4.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:efc00cfc1b376b920839424244fa7d79c7e2ee26b62e8c48ebc025e0bf350770", size = 809907, upload-time = "2026-04-01T21:00:44.147Z" }, { url = "https://files.pythonhosted.org/packages/0a/66/abedf22ec734f387dddc8a8a2fb72587adbe1c48ce144649dcc63c86eb6d/cast_value_rs-0.4.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:7dad4ecf608c7170f78ae45e0454b891c6c0e579c1190b68a5e448b714b79257", size = 803277, upload-time = "2026-04-01T21:00:45.545Z" }, { url = "https://files.pythonhosted.org/packages/5f/1b/8f19f848ca622c3090be39759420820ff70ac414be41b1762c191de06394/cast_value_rs-0.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:15c89f529b4cc37ebac8b2f6e0a1f8a90e2b2b71703e6629d3ff579efab77323", size = 761021, upload-time = "2026-04-01T21:00:46.962Z" }, { url = "https://files.pythonhosted.org/packages/fb/1a/684b634f621e35b4b0bbbde7ec28913b8925002b865e6f7b9d886dcccaef/cast_value_rs-0.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:a6247099de0b71e63f8156bbd97f9e964a1ddcc9b3d547b6a4839a0e911bdf54", size = 441797, upload-time = "2026-04-01T21:00:48.671Z" }, { url = "https://files.pythonhosted.org/packages/cc/35/393c9a1ccd4f2b85b178bda2b3f73ee6aae133d03b9be18ddce43b2ee6f9/cast_value_rs-0.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:fb18be6232a4e6d616e1ba2555bf105e663d22091abd0c6371d8f1a4c1670c82", size = 387884, upload-time = "2026-04-01T21:00:49.936Z" }, { url = "https://files.pythonhosted.org/packages/fb/a1/ac26f64f9ffda3d9f0b4a350b7a727da17ee5be417545743c84fd18ab5ef/cast_value_rs-0.4.0-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c51764b7fcedd5484ae4f7d8ee7a1f7f7a40736789f9c412f1ba780a6aba0cb", size = 490003, upload-time = "2026-04-01T21:00:51.191Z" }, { url = "https://files.pythonhosted.org/packages/b6/e9/a74d2ecc6e8f5fa0bd23b8f45ae1f11800b3e079c31f4eaad120140ed942/cast_value_rs-0.4.0-cp313-cp313t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5afeb1555b24a73c2b344dbb19e91a83260751dc2f8f9e1d3d1b44535cd3f520", size = 518662, upload-time = "2026-04-01T21:00:52.513Z" }, { url = "https://files.pythonhosted.org/packages/61/0d/7d25a5dc2e5f6a284684e39859607d41cb1fa5a3219d372facffd04c7ed9/cast_value_rs-0.4.0-cp313-cp313t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f9111ce32ca83a61565d92200b462007af6b1aa8895c81ea4732057567784298", size = 652482, upload-time = "2026-04-01T21:00:53.765Z" }, { url = "https://files.pythonhosted.org/packages/6a/36/d71bac4a6589fcb6d1320940bd8744cf2dcce65928d0de021c87d0356ae9/cast_value_rs-0.4.0-cp313-cp313t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:aeab17fe7e6cc1881af272bc681f7ae3971e11d079e440efd9012ed7d9e074d3", size = 558125, upload-time = "2026-04-01T21:00:55.429Z" }, { url = "https://files.pythonhosted.org/packages/86/9f/74a5dcb2dcfc3aaad6f9308d3ce0cf59be32b0d9563328c9331457888fd5/cast_value_rs-0.4.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:b5b040dd4838d0e4b2dee603bf61bef5b0625c35a91e859b0abd103c275c4207", size = 666195, upload-time = "2026-04-01T21:00:57.05Z" }, { url = "https://files.pythonhosted.org/packages/27/02/8c66fb39dd8c3efa05b3ee70c135aefc1631cf28cc08fca1d20515f34da4/cast_value_rs-0.4.0-cp313-cp313t-musllinux_1_2_armv7l.whl", hash = "sha256:59a55898bbf82d8d2b417960aac9db6fa195cd44451e7667076d5b8eb0b28ffd", size = 796949, upload-time = "2026-04-01T21:00:58.399Z" }, { url = "https://files.pythonhosted.org/packages/cc/13/349a2f64e1a0ffa2d211c9282d1cc7b41ac5edf473d24ec95cbc9d2fbf70/cast_value_rs-0.4.0-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:a528723cef699de74bf7344d55e8b2f21e2fdaf24dda22cf9bbb0f75effb296f", size = 778419, upload-time = "2026-04-01T21:01:00.154Z" }, { url = "https://files.pythonhosted.org/packages/b9/1b/926df4b577ed051920a63e13ac1435fdb9f7fbd5d28c2f7ec545050be675/cast_value_rs-0.4.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:a8d7a887e44a3ef642f5b5e462b6352062ba8041ef6d90f4b31c816f63dbb34f", size = 741379, upload-time = "2026-04-01T21:01:01.996Z" }, { url = "https://files.pythonhosted.org/packages/b9/36/3ec2848a1914655e85201f8def177526b4c17802b9530f17ad53de68c42a/cast_value_rs-0.4.0-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:4c73d47bd6d4e066b99482a48fc48a3a6220b42a282063125e3fa6c495754698", size = 509569, upload-time = "2026-04-01T21:01:03.308Z" }, { url = "https://files.pythonhosted.org/packages/47/b9/2ea6f9de182e0b454e852435d26238bef8eb58995ff8a1b4c48bb00ae4bc/cast_value_rs-0.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:18d0bdec57d7e747bec3fb258c7d2d48389bd8f05df5f59f109f9a8ec1f41dc1", size = 465923, upload-time = "2026-04-01T21:01:04.68Z" }, { url = "https://files.pythonhosted.org/packages/a9/15/feab5abdc6b02db474d840130b5a2a64afcb757db5f83446ca874eac6de5/cast_value_rs-0.4.0-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c03a09951fcb2433dd55d28ffffb04f5119d8abd5d231fc739a49908a9cab47b", size = 494033, upload-time = "2026-04-01T21:01:06.263Z" }, { url = "https://files.pythonhosted.org/packages/94/f6/d40ec4d3db15e07864038bdf4c8ab11165a517fa88d507bc5b859573aadd/cast_value_rs-0.4.0-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:84494970c1b3aa373100671b0b3a01f56c65a4dd5ed16b1be8c565ac6b3f0000", size = 532024, upload-time = "2026-04-01T21:01:07.574Z" }, { url = "https://files.pythonhosted.org/packages/d5/88/0cc4718632c9e47e7558964fa1d78841737f19a49c68e6aa7ac1074faf61/cast_value_rs-0.4.0-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0f95e67121c7ddbb1c06719694bb1559fd8d6e4e826ef1f93be7df5106b4f1c6", size = 661337, upload-time = "2026-04-01T21:01:09.152Z" }, { url = "https://files.pythonhosted.org/packages/b8/4f/26acfba143169e319267dcc93ccf55a113ebb99fc6bb1209195ded2c5f60/cast_value_rs-0.4.0-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:67079ea95b83b6c41471c35d7ae821d9148cf66739281c07bfd8f4ccbced5c8c", size = 562268, upload-time = "2026-04-01T21:01:10.547Z" }, { url = "https://files.pythonhosted.org/packages/3e/19/c23c8ebae9a06bf919ed4788e80c90cbc23b6443e5adf797a59967b66602/cast_value_rs-0.4.0-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:259b1b315171e8e1bde0284828601c289f1c75dc782cdb215786aec3b79a05f5", size = 555358, upload-time = "2026-04-01T21:01:12.024Z" }, { url = "https://files.pythonhosted.org/packages/05/dd/df59efda2ded4eddfb0d7f3f473a2efd638a5cc0775f3d91646293970572/cast_value_rs-0.4.0-cp314-cp314-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:84b733c91540247abee411d7052406a68f60ceaabb33a70a5eac7fd333d74220", size = 588031, upload-time = "2026-04-01T21:01:13.343Z" }, { url = "https://files.pythonhosted.org/packages/8d/1f/97b1d82b696f0b77ae9cba4ca6368a9d0f3ee61a6b7907fd34b1d8e117e8/cast_value_rs-0.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:c007832a316160c08642aed44bef1e2f3103488e29fb078f7c571c01e6f65caf", size = 671191, upload-time = "2026-04-01T21:01:14.627Z" }, { url = "https://files.pythonhosted.org/packages/b8/99/343eebb11a372defd7b049c0f627d29c67450bd5f9fbf28241d1f7b0712f/cast_value_rs-0.4.0-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:d8b2b9b69314b4596beaadb6c98a955bd6b1d988f54ae4cd14ab804f6e1bd450", size = 810173, upload-time = "2026-04-01T21:01:16.267Z" }, { url = "https://files.pythonhosted.org/packages/06/32/739a3ca0b9ef1f97929faf06a7b68b64b01cce0f9bcbeb885c0c51ac24e4/cast_value_rs-0.4.0-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:6a2de5f66441a174ec8cc63e672f2b6ddc4aada73fb98d795e0da17d9c41771a", size = 805596, upload-time = "2026-04-01T21:01:17.711Z" }, { url = "https://files.pythonhosted.org/packages/24/3f/56b33108837f195730a3f9467f686010132f459f0fcd050d8de74b111f74/cast_value_rs-0.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:2c0b31d3f8ef8857f7b0a7b2e6ef1b43e1a88263cb20406860ce38a06c727f1a", size = 759220, upload-time = "2026-04-01T21:01:19.29Z" }, { url = "https://files.pythonhosted.org/packages/d4/a1/18cbe0d297ba384a75f1d4476d67e88b5525afab77bddad6b8478992a8f3/cast_value_rs-0.4.0-cp314-cp314-win32.whl", hash = "sha256:6339adbce2686ad8218a38d17b543d71c062fb341c1411be6c45ab425abd2c64", size = 373865, upload-time = "2026-04-01T21:01:21.1Z" }, { url = "https://files.pythonhosted.org/packages/93/4c/2dc5a2347c150bd8aa1e67549f8e03368a4249f214548e237c191514ac0e/cast_value_rs-0.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:0dd4240cb62ddee6b2f794151a5d7b263dfb22cd8d0903598a1d900bd1d7b536", size = 443712, upload-time = "2026-04-01T21:01:22.768Z" }, { url = "https://files.pythonhosted.org/packages/25/3b/4c560902bf7825c1c479c3f0084aedec73cd355d54931bad4995faeb0f3f/cast_value_rs-0.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:6852abf682a5e9fa2bab04ccd43dc24dfe1056653f1a92dcf1a0d9ebd07af2cc", size = 388130, upload-time = "2026-04-01T21:01:24.284Z" }, { url = "https://files.pythonhosted.org/packages/b7/c0/f32d10128e6f0f5a58bc9adcb7525f5fa241bd682af0bb0fb7ce92b4f200/cast_value_rs-0.4.0-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f4fbddd4e2b255219597c39092ba10d9873c9fe37a8189add459fe77f310b86e", size = 489885, upload-time = "2026-04-01T21:01:25.596Z" }, { url = "https://files.pythonhosted.org/packages/bc/20/302156a38f1c7aef7f25864fd5895e831f5304a67d5af4d33874f676cdbf/cast_value_rs-0.4.0-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:01e053e5022cab8ce4a2e7605afe3e7c5685e3f56c90d05adcda69f8e5ec12d9", size = 517573, upload-time = "2026-04-01T21:01:26.887Z" }, { url = "https://files.pythonhosted.org/packages/a0/cd/d1502aa5bf0fb0fb5d410d0dac67962c47df9ea6a8d0934cd95f15a09834/cast_value_rs-0.4.0-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2840f7b76085e472f510ec0e1802ae5799f85a5c2ed9d909a9790c15054f0480", size = 649447, upload-time = "2026-04-01T21:01:28.219Z" }, { url = "https://files.pythonhosted.org/packages/0a/0a/f580ff584de55f1884cd8c15e1d2c9256188e58c5c981cd249894e2a87a4/cast_value_rs-0.4.0-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:86a75d9ba1315c3ad33690e5f251ebfe053ed84cfe645d027d2e639f4a4c6dd7", size = 558318, upload-time = "2026-04-01T21:01:29.51Z" }, { url = "https://files.pythonhosted.org/packages/2b/46/15f7318c2de3831689c0d9c40ed9a9179488d1650e1201e581df29fc10ea/cast_value_rs-0.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:4a56393964fea114ccb09d2c0fd14939e4aac0fb3178c7ff7af6b9f530f04267", size = 666217, upload-time = "2026-04-01T21:01:30.871Z" }, { url = "https://files.pythonhosted.org/packages/3a/3f/716eb0d80ef6b7c9498487cefb86e603a0f893a2e11273fe6484659b46bf/cast_value_rs-0.4.0-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:ab4b8d4cbb7bfcf73690c36447d34af66bcab7fb7bdf8242ee33cb725e2ed736", size = 796289, upload-time = "2026-04-01T21:01:32.546Z" }, { url = "https://files.pythonhosted.org/packages/fb/98/162a1d37a3d574783ff8d09286ffa33a108493c53367802e617f47607837/cast_value_rs-0.4.0-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:3693cf1b91b624061bcd649be53b2dd367ea3c18c212790c9a84a050df40ecca", size = 777483, upload-time = "2026-04-01T21:01:33.867Z" }, { url = "https://files.pythonhosted.org/packages/df/e3/6e3390fc9693d5a5e9ca0d677ca8666174a1e43328bdf57b9af23f138143/cast_value_rs-0.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:2a343f5cdddb17b7ae95ef9fa6013f8e66bd40ee97ceaa47e8972c021814df59", size = 744015, upload-time = "2026-04-01T21:01:35.143Z" }, ] [[package]] name = "certifi" version = "2026.4.22" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/25/ee/6caf7a40c36a1220410afe15a1cc64993a1f864871f698c0f93acb72842a/certifi-2026.4.22.tar.gz", hash = "sha256:8d455352a37b71bf76a79caa83a3d6c25afee4a385d632127b6afb3963f1c580", size = 137077, upload-time = "2026-04-22T11:26:11.191Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/22/30/7cd8fdcdfbc5b869528b079bfb76dcdf6056b1a2097a662e5e8c04f42965/certifi-2026.4.22-py3-none-any.whl", hash = "sha256:3cb2210c8f88ba2318d29b0388d1023c8492ff72ecdde4ebdaddbb13a31b1c4a", size = 135707, upload-time = "2026-04-22T11:26:09.372Z" }, ] [[package]] name = "cffi" version = "2.0.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pycparser", marker = "implementation_name != 'PyPy'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/eb/56/b1ba7935a17738ae8453301356628e8147c79dbb825bcbc73dc7401f9846/cffi-2.0.0.tar.gz", hash = "sha256:44d1b5909021139fe36001ae048dbdde8214afa20200eda0f64c068cac5d5529", size = 523588, upload-time = "2025-09-08T23:24:04.541Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ea/47/4f61023ea636104d4f16ab488e268b93008c3d0bb76893b1b31db1f96802/cffi-2.0.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:6d02d6655b0e54f54c4ef0b94eb6be0607b70853c45ce98bd278dc7de718be5d", size = 185271, upload-time = "2025-09-08T23:22:44.795Z" }, { url = "https://files.pythonhosted.org/packages/df/a2/781b623f57358e360d62cdd7a8c681f074a71d445418a776eef0aadb4ab4/cffi-2.0.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8eca2a813c1cb7ad4fb74d368c2ffbbb4789d377ee5bb8df98373c2cc0dee76c", size = 181048, upload-time = "2025-09-08T23:22:45.938Z" }, { url = "https://files.pythonhosted.org/packages/ff/df/a4f0fbd47331ceeba3d37c2e51e9dfc9722498becbeec2bd8bc856c9538a/cffi-2.0.0-cp312-cp312-manylinux1_i686.manylinux2014_i686.manylinux_2_17_i686.manylinux_2_5_i686.whl", hash = "sha256:21d1152871b019407d8ac3985f6775c079416c282e431a4da6afe7aefd2bccbe", size = 212529, upload-time = "2025-09-08T23:22:47.349Z" }, { url = "https://files.pythonhosted.org/packages/d5/72/12b5f8d3865bf0f87cf1404d8c374e7487dcf097a1c91c436e72e6badd83/cffi-2.0.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:b21e08af67b8a103c71a250401c78d5e0893beff75e28c53c98f4de42f774062", size = 220097, upload-time = "2025-09-08T23:22:48.677Z" }, { url = "https://files.pythonhosted.org/packages/c2/95/7a135d52a50dfa7c882ab0ac17e8dc11cec9d55d2c18dda414c051c5e69e/cffi-2.0.0-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:1e3a615586f05fc4065a8b22b8152f0c1b00cdbc60596d187c2a74f9e3036e4e", size = 207983, upload-time = "2025-09-08T23:22:50.06Z" }, { url = "https://files.pythonhosted.org/packages/3a/c8/15cb9ada8895957ea171c62dc78ff3e99159ee7adb13c0123c001a2546c1/cffi-2.0.0-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.whl", hash = "sha256:81afed14892743bbe14dacb9e36d9e0e504cd204e0b165062c488942b9718037", size = 206519, upload-time = "2025-09-08T23:22:51.364Z" }, { url = "https://files.pythonhosted.org/packages/78/2d/7fa73dfa841b5ac06c7b8855cfc18622132e365f5b81d02230333ff26e9e/cffi-2.0.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:3e17ed538242334bf70832644a32a7aae3d83b57567f9fd60a26257e992b79ba", size = 219572, upload-time = "2025-09-08T23:22:52.902Z" }, { url = "https://files.pythonhosted.org/packages/07/e0/267e57e387b4ca276b90f0434ff88b2c2241ad72b16d31836adddfd6031b/cffi-2.0.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3925dd22fa2b7699ed2617149842d2e6adde22b262fcbfada50e3d195e4b3a94", size = 222963, upload-time = "2025-09-08T23:22:54.518Z" }, { url = "https://files.pythonhosted.org/packages/b6/75/1f2747525e06f53efbd878f4d03bac5b859cbc11c633d0fb81432d98a795/cffi-2.0.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:2c8f814d84194c9ea681642fd164267891702542f028a15fc97d4674b6206187", size = 221361, upload-time = "2025-09-08T23:22:55.867Z" }, { url = "https://files.pythonhosted.org/packages/7b/2b/2b6435f76bfeb6bbf055596976da087377ede68df465419d192acf00c437/cffi-2.0.0-cp312-cp312-win32.whl", hash = "sha256:da902562c3e9c550df360bfa53c035b2f241fed6d9aef119048073680ace4a18", size = 172932, upload-time = "2025-09-08T23:22:57.188Z" }, { url = "https://files.pythonhosted.org/packages/f8/ed/13bd4418627013bec4ed6e54283b1959cf6db888048c7cf4b4c3b5b36002/cffi-2.0.0-cp312-cp312-win_amd64.whl", hash = "sha256:da68248800ad6320861f129cd9c1bf96ca849a2771a59e0344e88681905916f5", size = 183557, upload-time = "2025-09-08T23:22:58.351Z" }, { url = "https://files.pythonhosted.org/packages/95/31/9f7f93ad2f8eff1dbc1c3656d7ca5bfd8fb52c9d786b4dcf19b2d02217fa/cffi-2.0.0-cp312-cp312-win_arm64.whl", hash = "sha256:4671d9dd5ec934cb9a73e7ee9676f9362aba54f7f34910956b84d727b0d73fb6", size = 177762, upload-time = "2025-09-08T23:22:59.668Z" }, { url = "https://files.pythonhosted.org/packages/4b/8d/a0a47a0c9e413a658623d014e91e74a50cdd2c423f7ccfd44086ef767f90/cffi-2.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:00bdf7acc5f795150faa6957054fbbca2439db2f775ce831222b66f192f03beb", size = 185230, upload-time = "2025-09-08T23:23:00.879Z" }, { url = "https://files.pythonhosted.org/packages/4a/d2/a6c0296814556c68ee32009d9c2ad4f85f2707cdecfd7727951ec228005d/cffi-2.0.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:45d5e886156860dc35862657e1494b9bae8dfa63bf56796f2fb56e1679fc0bca", size = 181043, upload-time = "2025-09-08T23:23:02.231Z" }, { url = "https://files.pythonhosted.org/packages/b0/1e/d22cc63332bd59b06481ceaac49d6c507598642e2230f201649058a7e704/cffi-2.0.0-cp313-cp313-manylinux1_i686.manylinux2014_i686.manylinux_2_17_i686.manylinux_2_5_i686.whl", hash = "sha256:07b271772c100085dd28b74fa0cd81c8fb1a3ba18b21e03d7c27f3436a10606b", size = 212446, upload-time = "2025-09-08T23:23:03.472Z" }, { url = "https://files.pythonhosted.org/packages/a9/f5/a2c23eb03b61a0b8747f211eb716446c826ad66818ddc7810cc2cc19b3f2/cffi-2.0.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:d48a880098c96020b02d5a1f7d9251308510ce8858940e6fa99ece33f610838b", size = 220101, upload-time = "2025-09-08T23:23:04.792Z" }, { url = "https://files.pythonhosted.org/packages/f2/7f/e6647792fc5850d634695bc0e6ab4111ae88e89981d35ac269956605feba/cffi-2.0.0-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:f93fd8e5c8c0a4aa1f424d6173f14a892044054871c771f8566e4008eaa359d2", size = 207948, upload-time = "2025-09-08T23:23:06.127Z" }, { url = "https://files.pythonhosted.org/packages/cb/1e/a5a1bd6f1fb30f22573f76533de12a00bf274abcdc55c8edab639078abb6/cffi-2.0.0-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.whl", hash = "sha256:dd4f05f54a52fb558f1ba9f528228066954fee3ebe629fc1660d874d040ae5a3", size = 206422, upload-time = "2025-09-08T23:23:07.753Z" }, { url = "https://files.pythonhosted.org/packages/98/df/0a1755e750013a2081e863e7cd37e0cdd02664372c754e5560099eb7aa44/cffi-2.0.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:c8d3b5532fc71b7a77c09192b4a5a200ea992702734a2e9279a37f2478236f26", size = 219499, upload-time = "2025-09-08T23:23:09.648Z" }, { url = "https://files.pythonhosted.org/packages/50/e1/a969e687fcf9ea58e6e2a928ad5e2dd88cc12f6f0ab477e9971f2309b57c/cffi-2.0.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:d9b29c1f0ae438d5ee9acb31cadee00a58c46cc9c0b2f9038c6b0b3470877a8c", size = 222928, upload-time = "2025-09-08T23:23:10.928Z" }, { url = "https://files.pythonhosted.org/packages/36/54/0362578dd2c9e557a28ac77698ed67323ed5b9775ca9d3fe73fe191bb5d8/cffi-2.0.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:6d50360be4546678fc1b79ffe7a66265e28667840010348dd69a314145807a1b", size = 221302, upload-time = "2025-09-08T23:23:12.42Z" }, { url = "https://files.pythonhosted.org/packages/eb/6d/bf9bda840d5f1dfdbf0feca87fbdb64a918a69bca42cfa0ba7b137c48cb8/cffi-2.0.0-cp313-cp313-win32.whl", hash = "sha256:74a03b9698e198d47562765773b4a8309919089150a0bb17d829ad7b44b60d27", size = 172909, upload-time = "2025-09-08T23:23:14.32Z" }, { url = "https://files.pythonhosted.org/packages/37/18/6519e1ee6f5a1e579e04b9ddb6f1676c17368a7aba48299c3759bbc3c8b3/cffi-2.0.0-cp313-cp313-win_amd64.whl", hash = "sha256:19f705ada2530c1167abacb171925dd886168931e0a7b78f5bffcae5c6b5be75", size = 183402, upload-time = "2025-09-08T23:23:15.535Z" }, { url = "https://files.pythonhosted.org/packages/cb/0e/02ceeec9a7d6ee63bb596121c2c8e9b3a9e150936f4fbef6ca1943e6137c/cffi-2.0.0-cp313-cp313-win_arm64.whl", hash = "sha256:256f80b80ca3853f90c21b23ee78cd008713787b1b1e93eae9f3d6a7134abd91", size = 177780, upload-time = "2025-09-08T23:23:16.761Z" }, { url = "https://files.pythonhosted.org/packages/92/c4/3ce07396253a83250ee98564f8d7e9789fab8e58858f35d07a9a2c78de9f/cffi-2.0.0-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:fc33c5141b55ed366cfaad382df24fe7dcbc686de5be719b207bb248e3053dc5", size = 185320, upload-time = "2025-09-08T23:23:18.087Z" }, { url = "https://files.pythonhosted.org/packages/59/dd/27e9fa567a23931c838c6b02d0764611c62290062a6d4e8ff7863daf9730/cffi-2.0.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:c654de545946e0db659b3400168c9ad31b5d29593291482c43e3564effbcee13", size = 181487, upload-time = "2025-09-08T23:23:19.622Z" }, { url = "https://files.pythonhosted.org/packages/d6/43/0e822876f87ea8a4ef95442c3d766a06a51fc5298823f884ef87aaad168c/cffi-2.0.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:24b6f81f1983e6df8db3adc38562c83f7d4a0c36162885ec7f7b77c7dcbec97b", size = 220049, upload-time = "2025-09-08T23:23:20.853Z" }, { url = "https://files.pythonhosted.org/packages/b4/89/76799151d9c2d2d1ead63c2429da9ea9d7aac304603de0c6e8764e6e8e70/cffi-2.0.0-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:12873ca6cb9b0f0d3a0da705d6086fe911591737a59f28b7936bdfed27c0d47c", size = 207793, upload-time = "2025-09-08T23:23:22.08Z" }, { url = "https://files.pythonhosted.org/packages/bb/dd/3465b14bb9e24ee24cb88c9e3730f6de63111fffe513492bf8c808a3547e/cffi-2.0.0-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.whl", hash = "sha256:d9b97165e8aed9272a6bb17c01e3cc5871a594a446ebedc996e2397a1c1ea8ef", size = 206300, upload-time = "2025-09-08T23:23:23.314Z" }, { url = "https://files.pythonhosted.org/packages/47/d9/d83e293854571c877a92da46fdec39158f8d7e68da75bf73581225d28e90/cffi-2.0.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:afb8db5439b81cf9c9d0c80404b60c3cc9c3add93e114dcae767f1477cb53775", size = 219244, upload-time = "2025-09-08T23:23:24.541Z" }, { url = "https://files.pythonhosted.org/packages/2b/0f/1f177e3683aead2bb00f7679a16451d302c436b5cbf2505f0ea8146ef59e/cffi-2.0.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:737fe7d37e1a1bffe70bd5754ea763a62a066dc5913ca57e957824b72a85e205", size = 222828, upload-time = "2025-09-08T23:23:26.143Z" }, { url = "https://files.pythonhosted.org/packages/c6/0f/cafacebd4b040e3119dcb32fed8bdef8dfe94da653155f9d0b9dc660166e/cffi-2.0.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:38100abb9d1b1435bc4cc340bb4489635dc2f0da7456590877030c9b3d40b0c1", size = 220926, upload-time = "2025-09-08T23:23:27.873Z" }, { url = "https://files.pythonhosted.org/packages/3e/aa/df335faa45b395396fcbc03de2dfcab242cd61a9900e914fe682a59170b1/cffi-2.0.0-cp314-cp314-win32.whl", hash = "sha256:087067fa8953339c723661eda6b54bc98c5625757ea62e95eb4898ad5e776e9f", size = 175328, upload-time = "2025-09-08T23:23:44.61Z" }, { url = "https://files.pythonhosted.org/packages/bb/92/882c2d30831744296ce713f0feb4c1cd30f346ef747b530b5318715cc367/cffi-2.0.0-cp314-cp314-win_amd64.whl", hash = "sha256:203a48d1fb583fc7d78a4c6655692963b860a417c0528492a6bc21f1aaefab25", size = 185650, upload-time = "2025-09-08T23:23:45.848Z" }, { url = "https://files.pythonhosted.org/packages/9f/2c/98ece204b9d35a7366b5b2c6539c350313ca13932143e79dc133ba757104/cffi-2.0.0-cp314-cp314-win_arm64.whl", hash = "sha256:dbd5c7a25a7cb98f5ca55d258b103a2054f859a46ae11aaf23134f9cc0d356ad", size = 180687, upload-time = "2025-09-08T23:23:47.105Z" }, { url = "https://files.pythonhosted.org/packages/3e/61/c768e4d548bfa607abcda77423448df8c471f25dbe64fb2ef6d555eae006/cffi-2.0.0-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:9a67fc9e8eb39039280526379fb3a70023d77caec1852002b4da7e8b270c4dd9", size = 188773, upload-time = "2025-09-08T23:23:29.347Z" }, { url = "https://files.pythonhosted.org/packages/2c/ea/5f76bce7cf6fcd0ab1a1058b5af899bfbef198bea4d5686da88471ea0336/cffi-2.0.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:7a66c7204d8869299919db4d5069a82f1561581af12b11b3c9f48c584eb8743d", size = 185013, upload-time = "2025-09-08T23:23:30.63Z" }, { url = "https://files.pythonhosted.org/packages/be/b4/c56878d0d1755cf9caa54ba71e5d049479c52f9e4afc230f06822162ab2f/cffi-2.0.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:7cc09976e8b56f8cebd752f7113ad07752461f48a58cbba644139015ac24954c", size = 221593, upload-time = "2025-09-08T23:23:31.91Z" }, { url = "https://files.pythonhosted.org/packages/e0/0d/eb704606dfe8033e7128df5e90fee946bbcb64a04fcdaa97321309004000/cffi-2.0.0-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:92b68146a71df78564e4ef48af17551a5ddd142e5190cdf2c5624d0c3ff5b2e8", size = 209354, upload-time = "2025-09-08T23:23:33.214Z" }, { url = "https://files.pythonhosted.org/packages/d8/19/3c435d727b368ca475fb8742ab97c9cb13a0de600ce86f62eab7fa3eea60/cffi-2.0.0-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.whl", hash = "sha256:b1e74d11748e7e98e2f426ab176d4ed720a64412b6a15054378afdb71e0f37dc", size = 208480, upload-time = "2025-09-08T23:23:34.495Z" }, { url = "https://files.pythonhosted.org/packages/d0/44/681604464ed9541673e486521497406fadcc15b5217c3e326b061696899a/cffi-2.0.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:28a3a209b96630bca57cce802da70c266eb08c6e97e5afd61a75611ee6c64592", size = 221584, upload-time = "2025-09-08T23:23:36.096Z" }, { url = "https://files.pythonhosted.org/packages/25/8e/342a504ff018a2825d395d44d63a767dd8ebc927ebda557fecdaca3ac33a/cffi-2.0.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:7553fb2090d71822f02c629afe6042c299edf91ba1bf94951165613553984512", size = 224443, upload-time = "2025-09-08T23:23:37.328Z" }, { url = "https://files.pythonhosted.org/packages/e1/5e/b666bacbbc60fbf415ba9988324a132c9a7a0448a9a8f125074671c0f2c3/cffi-2.0.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:6c6c373cfc5c83a975506110d17457138c8c63016b563cc9ed6e056a82f13ce4", size = 223437, upload-time = "2025-09-08T23:23:38.945Z" }, { url = "https://files.pythonhosted.org/packages/a0/1d/ec1a60bd1a10daa292d3cd6bb0b359a81607154fb8165f3ec95fe003b85c/cffi-2.0.0-cp314-cp314t-win32.whl", hash = "sha256:1fc9ea04857caf665289b7a75923f2c6ed559b8298a1b8c49e59f7dd95c8481e", size = 180487, upload-time = "2025-09-08T23:23:40.423Z" }, { url = "https://files.pythonhosted.org/packages/bf/41/4c1168c74fac325c0c8156f04b6749c8b6a8f405bbf91413ba088359f60d/cffi-2.0.0-cp314-cp314t-win_amd64.whl", hash = "sha256:d68b6cef7827e8641e8ef16f4494edda8b36104d79773a334beaa1e3521430f6", size = 191726, upload-time = "2025-09-08T23:23:41.742Z" }, { url = "https://files.pythonhosted.org/packages/ae/3a/dbeec9d1ee0844c679f6bb5d6ad4e9f198b1224f4e7a32825f47f6192b0c/cffi-2.0.0-cp314-cp314t-win_arm64.whl", hash = "sha256:0a1527a803f0a659de1af2e1fd700213caba79377e27e4693648c2923da066f9", size = 184195, upload-time = "2025-09-08T23:23:43.004Z" }, ] [[package]] name = "cfn-lint" version = "1.51.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "aws-sam-translator" }, { name = "jsonpatch" }, { name = "networkx" }, { name = "pyyaml" }, { name = "regex" }, { name = "sympy" }, { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/5e/ea/bc4954dcbff3ecb500e2593e4b64d0e9a552973249b2a27dd22eee3fb5b0/cfn_lint-1.51.0.tar.gz", hash = "sha256:05d2a59708c99363afe3af6ac7325de95a5b37f8eef7728f41ae567d088a61f1", size = 4088652, upload-time = "2026-05-12T20:34:25.712Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/48/12/016d6b4a43bb7eb2e430770e04325ef159d73d4183dce94c6fa6dc144902/cfn_lint-1.51.0-py3-none-any.whl", hash = "sha256:116d4f9c7c7d039e69c01c31fe9ff309ff79f0884c859ea92b353507903dd89e", size = 6065464, upload-time = "2026-05-12T20:34:22.885Z" }, ] [[package]] name = "charset-normalizer" version = "3.4.7" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/e7/a1/67fe25fac3c7642725500a3f6cfe5821ad557c3abb11c9d20d12c7008d3e/charset_normalizer-3.4.7.tar.gz", hash = "sha256:ae89db9e5f98a11a4bf50407d4363e7b09b31e55bc117b4f7d80aab97ba009e5", size = 144271, upload-time = "2026-04-02T09:28:39.342Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0c/eb/4fc8d0a7110eb5fc9cc161723a34a8a6c200ce3b4fbf681bc86feee22308/charset_normalizer-3.4.7-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:eca9705049ad3c7345d574e3510665cb2cf844c2f2dcfe675332677f081cbd46", size = 311328, upload-time = "2026-04-02T09:26:24.331Z" }, { url = "https://files.pythonhosted.org/packages/f8/e3/0fadc706008ac9d7b9b5be6dc767c05f9d3e5df51744ce4cc9605de7b9f4/charset_normalizer-3.4.7-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6178f72c5508bfc5fd446a5905e698c6212932f25bcdd4b47a757a50605a90e2", size = 208061, upload-time = "2026-04-02T09:26:25.568Z" }, { url = "https://files.pythonhosted.org/packages/42/f0/3dd1045c47f4a4604df85ec18ad093912ae1344ac706993aff91d38773a2/charset_normalizer-3.4.7-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:e1421b502d83040e6d7fb2fb18dff63957f720da3d77b2fbd3187ceb63755d7b", size = 229031, upload-time = "2026-04-02T09:26:26.865Z" }, { url = "https://files.pythonhosted.org/packages/dc/67/675a46eb016118a2fbde5a277a5d15f4f69d5f3f5f338e5ee2f8948fcf43/charset_normalizer-3.4.7-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:edac0f1ab77644605be2cbba52e6b7f630731fc42b34cb0f634be1a6eface56a", size = 225239, upload-time = "2026-04-02T09:26:28.044Z" }, { url = "https://files.pythonhosted.org/packages/4b/f8/d0118a2f5f23b02cd166fa385c60f9b0d4f9194f574e2b31cef350ad7223/charset_normalizer-3.4.7-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5649fd1c7bade02f320a462fdefd0b4bd3ce036065836d4f42e0de958038e116", size = 216589, upload-time = "2026-04-02T09:26:29.239Z" }, { url = "https://files.pythonhosted.org/packages/b1/f1/6d2b0b261b6c4ceef0fcb0d17a01cc5bc53586c2d4796fa04b5c540bc13d/charset_normalizer-3.4.7-cp312-cp312-manylinux_2_31_armv7l.whl", hash = "sha256:203104ed3e428044fd943bc4bf45fa73c0730391f9621e37fe39ecf477b128cb", size = 202733, upload-time = "2026-04-02T09:26:30.5Z" }, { url = "https://files.pythonhosted.org/packages/6f/c0/7b1f943f7e87cc3db9626ba17807d042c38645f0a1d4415c7a14afb5591f/charset_normalizer-3.4.7-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:298930cec56029e05497a76988377cbd7457ba864beeea92ad7e844fe74cd1f1", size = 212652, upload-time = "2026-04-02T09:26:31.709Z" }, { url = "https://files.pythonhosted.org/packages/38/dd/5a9ab159fe45c6e72079398f277b7d2b523e7f716acc489726115a910097/charset_normalizer-3.4.7-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:708838739abf24b2ceb208d0e22403dd018faeef86ddac04319a62ae884c4f15", size = 211229, upload-time = "2026-04-02T09:26:33.282Z" }, { url = "https://files.pythonhosted.org/packages/d5/ff/531a1cad5ca855d1c1a8b69cb71abfd6d85c0291580146fda7c82857caa1/charset_normalizer-3.4.7-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:0f7eb884681e3938906ed0434f20c63046eacd0111c4ba96f27b76084cd679f5", size = 203552, upload-time = "2026-04-02T09:26:34.845Z" }, { url = "https://files.pythonhosted.org/packages/c1/4c/a5fb52d528a8ca41f7598cb619409ece30a169fbdf9cdce592e53b46c3a6/charset_normalizer-3.4.7-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:4dc1e73c36828f982bfe79fadf5919923f8a6f4df2860804db9a98c48824ce8d", size = 230806, upload-time = "2026-04-02T09:26:36.152Z" }, { url = "https://files.pythonhosted.org/packages/59/7a/071feed8124111a32b316b33ae4de83d36923039ef8cf48120266844285b/charset_normalizer-3.4.7-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:aed52fea0513bac0ccde438c188c8a471c4e0f457c2dd20cdbf6ea7a450046c7", size = 212316, upload-time = "2026-04-02T09:26:37.672Z" }, { url = "https://files.pythonhosted.org/packages/fd/35/f7dba3994312d7ba508e041eaac39a36b120f32d4c8662b8814dab876431/charset_normalizer-3.4.7-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:fea24543955a6a729c45a73fe90e08c743f0b3334bbf3201e6c4bc1b0c7fa464", size = 227274, upload-time = "2026-04-02T09:26:38.93Z" }, { url = "https://files.pythonhosted.org/packages/8a/2d/a572df5c9204ab7688ec1edc895a73ebded3b023bb07364710b05dd1c9be/charset_normalizer-3.4.7-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:bb6d88045545b26da47aa879dd4a89a71d1dce0f0e549b1abcb31dfe4a8eac49", size = 218468, upload-time = "2026-04-02T09:26:40.17Z" }, { url = "https://files.pythonhosted.org/packages/86/eb/890922a8b03a568ca2f336c36585a4713c55d4d67bf0f0c78924be6315ca/charset_normalizer-3.4.7-cp312-cp312-win32.whl", hash = "sha256:2257141f39fe65a3fdf38aeccae4b953e5f3b3324f4ff0daf9f15b8518666a2c", size = 148460, upload-time = "2026-04-02T09:26:41.416Z" }, { url = "https://files.pythonhosted.org/packages/35/d9/0e7dffa06c5ab081f75b1b786f0aefc88365825dfcd0ac544bdb7b2b6853/charset_normalizer-3.4.7-cp312-cp312-win_amd64.whl", hash = "sha256:5ed6ab538499c8644b8a3e18debabcd7ce684f3fa91cf867521a7a0279cab2d6", size = 159330, upload-time = "2026-04-02T09:26:42.554Z" }, { url = "https://files.pythonhosted.org/packages/9e/5d/481bcc2a7c88ea6b0878c299547843b2521ccbc40980cb406267088bc701/charset_normalizer-3.4.7-cp312-cp312-win_arm64.whl", hash = "sha256:56be790f86bfb2c98fb742ce566dfb4816e5a83384616ab59c49e0604d49c51d", size = 147828, upload-time = "2026-04-02T09:26:44.075Z" }, { url = "https://files.pythonhosted.org/packages/c1/3b/66777e39d3ae1ddc77ee606be4ec6d8cbd4c801f65e5a1b6f2b11b8346dd/charset_normalizer-3.4.7-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:f496c9c3cc02230093d8330875c4c3cdfc3b73612a5fd921c65d39cbcef08063", size = 309627, upload-time = "2026-04-02T09:26:45.198Z" }, { url = "https://files.pythonhosted.org/packages/2e/4e/b7f84e617b4854ade48a1b7915c8ccfadeba444d2a18c291f696e37f0d3b/charset_normalizer-3.4.7-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0ea948db76d31190bf08bd371623927ee1339d5f2a0b4b1b4a4439a65298703c", size = 207008, upload-time = "2026-04-02T09:26:46.824Z" }, { url = "https://files.pythonhosted.org/packages/c4/bb/ec73c0257c9e11b268f018f068f5d00aa0ef8c8b09f7753ebd5f2880e248/charset_normalizer-3.4.7-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:a277ab8928b9f299723bc1a2dabb1265911b1a76341f90a510368ca44ad9ab66", size = 228303, upload-time = "2026-04-02T09:26:48.397Z" }, { url = "https://files.pythonhosted.org/packages/85/fb/32d1f5033484494619f701e719429c69b766bfc4dbc61aa9e9c8c166528b/charset_normalizer-3.4.7-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:3bec022aec2c514d9cf199522a802bd007cd588ab17ab2525f20f9c34d067c18", size = 224282, upload-time = "2026-04-02T09:26:49.684Z" }, { url = "https://files.pythonhosted.org/packages/fa/07/330e3a0dda4c404d6da83b327270906e9654a24f6c546dc886a0eb0ffb23/charset_normalizer-3.4.7-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e044c39e41b92c845bc815e5ae4230804e8e7bc29e399b0437d64222d92809dd", size = 215595, upload-time = "2026-04-02T09:26:50.915Z" }, { url = "https://files.pythonhosted.org/packages/e3/7c/fc890655786e423f02556e0216d4b8c6bcb6bdfa890160dc66bf52dee468/charset_normalizer-3.4.7-cp313-cp313-manylinux_2_31_armv7l.whl", hash = "sha256:f495a1652cf3fbab2eb0639776dad966c2fb874d79d87ca07f9d5f059b8bd215", size = 201986, upload-time = "2026-04-02T09:26:52.197Z" }, { url = "https://files.pythonhosted.org/packages/d8/97/bfb18b3db2aed3b90cf54dc292ad79fdd5ad65c4eae454099475cbeadd0d/charset_normalizer-3.4.7-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:e712b419df8ba5e42b226c510472b37bd57b38e897d3eca5e8cfd410a29fa859", size = 211711, upload-time = "2026-04-02T09:26:53.49Z" }, { url = "https://files.pythonhosted.org/packages/6f/a5/a581c13798546a7fd557c82614a5c65a13df2157e9ad6373166d2a3e645d/charset_normalizer-3.4.7-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:7804338df6fcc08105c7745f1502ba68d900f45fd770d5bdd5288ddccb8a42d8", size = 210036, upload-time = "2026-04-02T09:26:54.975Z" }, { url = "https://files.pythonhosted.org/packages/8c/bf/b3ab5bcb478e4193d517644b0fb2bf5497fbceeaa7a1bc0f4d5b50953861/charset_normalizer-3.4.7-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:481551899c856c704d58119b5025793fa6730adda3571971af568f66d2424bb5", size = 202998, upload-time = "2026-04-02T09:26:56.303Z" }, { url = "https://files.pythonhosted.org/packages/e7/4e/23efd79b65d314fa320ec6017b4b5834d5c12a58ba4610aa353af2e2f577/charset_normalizer-3.4.7-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:f59099f9b66f0d7145115e6f80dd8b1d847176df89b234a5a6b3f00437aa0832", size = 230056, upload-time = "2026-04-02T09:26:57.554Z" }, { url = "https://files.pythonhosted.org/packages/b9/9f/1e1941bc3f0e01df116e68dc37a55c4d249df5e6fa77f008841aef68264f/charset_normalizer-3.4.7-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:f59ad4c0e8f6bba240a9bb85504faa1ab438237199d4cce5f622761507b8f6a6", size = 211537, upload-time = "2026-04-02T09:26:58.843Z" }, { url = "https://files.pythonhosted.org/packages/80/0f/088cbb3020d44428964a6c97fe1edfb1b9550396bf6d278330281e8b709c/charset_normalizer-3.4.7-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:3dedcc22d73ec993f42055eff4fcfed9318d1eeb9a6606c55892a26964964e48", size = 226176, upload-time = "2026-04-02T09:27:00.437Z" }, { url = "https://files.pythonhosted.org/packages/6a/9f/130394f9bbe06f4f63e22641d32fc9b202b7e251c9aef4db044324dac493/charset_normalizer-3.4.7-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:64f02c6841d7d83f832cd97ccf8eb8a906d06eb95d5276069175c696b024b60a", size = 217723, upload-time = "2026-04-02T09:27:02.021Z" }, { url = "https://files.pythonhosted.org/packages/73/55/c469897448a06e49f8fa03f6caae97074fde823f432a98f979cc42b90e69/charset_normalizer-3.4.7-cp313-cp313-win32.whl", hash = "sha256:4042d5c8f957e15221d423ba781e85d553722fc4113f523f2feb7b188cc34c5e", size = 148085, upload-time = "2026-04-02T09:27:03.192Z" }, { url = "https://files.pythonhosted.org/packages/5d/78/1b74c5bbb3f99b77a1715c91b3e0b5bdb6fe302d95ace4f5b1bec37b0167/charset_normalizer-3.4.7-cp313-cp313-win_amd64.whl", hash = "sha256:3946fa46a0cf3e4c8cb1cc52f56bb536310d34f25f01ca9b6c16afa767dab110", size = 158819, upload-time = "2026-04-02T09:27:04.454Z" }, { url = "https://files.pythonhosted.org/packages/68/86/46bd42279d323deb8687c4a5a811fd548cb7d1de10cf6535d099877a9a9f/charset_normalizer-3.4.7-cp313-cp313-win_arm64.whl", hash = "sha256:80d04837f55fc81da168b98de4f4b797ef007fc8a79ab71c6ec9bc4dd662b15b", size = 147915, upload-time = "2026-04-02T09:27:05.971Z" }, { url = "https://files.pythonhosted.org/packages/97/c8/c67cb8c70e19ef1960b97b22ed2a1567711de46c4ddf19799923adc836c2/charset_normalizer-3.4.7-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:c36c333c39be2dbca264d7803333c896ab8fa7d4d6f0ab7edb7dfd7aea6e98c0", size = 309234, upload-time = "2026-04-02T09:27:07.194Z" }, { url = "https://files.pythonhosted.org/packages/99/85/c091fdee33f20de70d6c8b522743b6f831a2f1cd3ff86de4c6a827c48a76/charset_normalizer-3.4.7-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1c2aed2e5e41f24ea8ef1590b8e848a79b56f3a5564a65ceec43c9d692dc7d8a", size = 208042, upload-time = "2026-04-02T09:27:08.749Z" }, { url = "https://files.pythonhosted.org/packages/87/1c/ab2ce611b984d2fd5d86a5a8a19c1ae26acac6bad967da4967562c75114d/charset_normalizer-3.4.7-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:54523e136b8948060c0fa0bc7b1b50c32c186f2fceee897a495406bb6e311d2b", size = 228706, upload-time = "2026-04-02T09:27:09.951Z" }, { url = "https://files.pythonhosted.org/packages/a8/29/2b1d2cb00bf085f59d29eb773ce58ec2d325430f8c216804a0a5cd83cbca/charset_normalizer-3.4.7-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:715479b9a2802ecac752a3b0efa2b0b60285cf962ee38414211abdfccc233b41", size = 224727, upload-time = "2026-04-02T09:27:11.175Z" }, { url = "https://files.pythonhosted.org/packages/47/5c/032c2d5a07fe4d4855fea851209cca2b6f03ebeb6d4e3afdb3358386a684/charset_normalizer-3.4.7-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bd6c2a1c7573c64738d716488d2cdd3c00e340e4835707d8fdb8dc1a66ef164e", size = 215882, upload-time = "2026-04-02T09:27:12.446Z" }, { url = "https://files.pythonhosted.org/packages/2c/c2/356065d5a8b78ed04499cae5f339f091946a6a74f91e03476c33f0ab7100/charset_normalizer-3.4.7-cp314-cp314-manylinux_2_31_armv7l.whl", hash = "sha256:c45e9440fb78f8ddabcf714b68f936737a121355bf59f3907f4e17721b9d1aae", size = 200860, upload-time = "2026-04-02T09:27:13.721Z" }, { url = "https://files.pythonhosted.org/packages/0c/cd/a32a84217ced5039f53b29f460962abb2d4420def55afabe45b1c3c7483d/charset_normalizer-3.4.7-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:3534e7dcbdcf757da6b85a0bbf5b6868786d5982dd959b065e65481644817a18", size = 211564, upload-time = "2026-04-02T09:27:15.272Z" }, { url = "https://files.pythonhosted.org/packages/44/86/58e6f13ce26cc3b8f4a36b94a0f22ae2f00a72534520f4ae6857c4b81f89/charset_normalizer-3.4.7-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:e8ac484bf18ce6975760921bb6148041faa8fef0547200386ea0b52b5d27bf7b", size = 211276, upload-time = "2026-04-02T09:27:16.834Z" }, { url = "https://files.pythonhosted.org/packages/8f/fe/d17c32dc72e17e155e06883efa84514ca375f8a528ba2546bee73fc4df81/charset_normalizer-3.4.7-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:a5fe03b42827c13cdccd08e6c0247b6a6d4b5e3cdc53fd1749f5896adcdc2356", size = 201238, upload-time = "2026-04-02T09:27:18.229Z" }, { url = "https://files.pythonhosted.org/packages/6a/29/f33daa50b06525a237451cdb6c69da366c381a3dadcd833fa5676bc468b3/charset_normalizer-3.4.7-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:2d6eb928e13016cea4f1f21d1e10c1cebd5a421bc57ddf5b1142ae3f86824fab", size = 230189, upload-time = "2026-04-02T09:27:19.445Z" }, { url = "https://files.pythonhosted.org/packages/b6/6e/52c84015394a6a0bdcd435210a7e944c5f94ea1055f5cc5d56c5fe368e7b/charset_normalizer-3.4.7-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:e74327fb75de8986940def6e8dee4f127cc9752bee7355bb323cc5b2659b6d46", size = 211352, upload-time = "2026-04-02T09:27:20.79Z" }, { url = "https://files.pythonhosted.org/packages/8c/d7/4353be581b373033fb9198bf1da3cf8f09c1082561e8e922aa7b39bf9fe8/charset_normalizer-3.4.7-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:d6038d37043bced98a66e68d3aa2b6a35505dc01328cd65217cefe82f25def44", size = 227024, upload-time = "2026-04-02T09:27:22.063Z" }, { url = "https://files.pythonhosted.org/packages/30/45/99d18aa925bd1740098ccd3060e238e21115fffbfdcb8f3ece837d0ace6c/charset_normalizer-3.4.7-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:7579e913a5339fb8fa133f6bbcfd8e6749696206cf05acdbdca71a1b436d8e72", size = 217869, upload-time = "2026-04-02T09:27:23.486Z" }, { url = "https://files.pythonhosted.org/packages/5c/05/5ee478aa53f4bb7996482153d4bfe1b89e0f087f0ab6b294fcf92d595873/charset_normalizer-3.4.7-cp314-cp314-win32.whl", hash = "sha256:5b77459df20e08151cd6f8b9ef8ef1f961ef73d85c21a555c7eed5b79410ec10", size = 148541, upload-time = "2026-04-02T09:27:25.146Z" }, { url = "https://files.pythonhosted.org/packages/48/77/72dcb0921b2ce86420b2d79d454c7022bf5be40202a2a07906b9f2a35c97/charset_normalizer-3.4.7-cp314-cp314-win_amd64.whl", hash = "sha256:92a0a01ead5e668468e952e4238cccd7c537364eb7d851ab144ab6627dbbe12f", size = 159634, upload-time = "2026-04-02T09:27:26.642Z" }, { url = "https://files.pythonhosted.org/packages/c6/a3/c2369911cd72f02386e4e340770f6e158c7980267da16af8f668217abaa0/charset_normalizer-3.4.7-cp314-cp314-win_arm64.whl", hash = "sha256:67f6279d125ca0046a7fd386d01b311c6363844deac3e5b069b514ba3e63c246", size = 148384, upload-time = "2026-04-02T09:27:28.271Z" }, { url = "https://files.pythonhosted.org/packages/94/09/7e8a7f73d24dba1f0035fbbf014d2c36828fc1bf9c88f84093e57d315935/charset_normalizer-3.4.7-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:effc3f449787117233702311a1b7d8f59cba9ced946ba727bdc329ec69028e24", size = 330133, upload-time = "2026-04-02T09:27:29.474Z" }, { url = "https://files.pythonhosted.org/packages/8d/da/96975ddb11f8e977f706f45cddd8540fd8242f71ecdb5d18a80723dcf62c/charset_normalizer-3.4.7-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:fbccdc05410c9ee21bbf16a35f4c1d16123dcdeb8a1d38f33654fa21d0234f79", size = 216257, upload-time = "2026-04-02T09:27:30.793Z" }, { url = "https://files.pythonhosted.org/packages/e5/e8/1d63bf8ef2d388e95c64b2098f45f84758f6d102a087552da1485912637b/charset_normalizer-3.4.7-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:733784b6d6def852c814bce5f318d25da2ee65dd4839a0718641c696e09a2960", size = 234851, upload-time = "2026-04-02T09:27:32.44Z" }, { url = "https://files.pythonhosted.org/packages/9b/40/e5ff04233e70da2681fa43969ad6f66ca5611d7e669be0246c4c7aaf6dc8/charset_normalizer-3.4.7-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a89c23ef8d2c6b27fd200a42aa4ac72786e7c60d40efdc76e6011260b6e949c4", size = 233393, upload-time = "2026-04-02T09:27:34.03Z" }, { url = "https://files.pythonhosted.org/packages/be/c1/06c6c49d5a5450f76899992f1ee40b41d076aee9279b49cf9974d2f313d5/charset_normalizer-3.4.7-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6c114670c45346afedc0d947faf3c7f701051d2518b943679c8ff88befe14f8e", size = 223251, upload-time = "2026-04-02T09:27:35.369Z" }, { url = "https://files.pythonhosted.org/packages/2b/9f/f2ff16fb050946169e3e1f82134d107e5d4ae72647ec8a1b1446c148480f/charset_normalizer-3.4.7-cp314-cp314t-manylinux_2_31_armv7l.whl", hash = "sha256:a180c5e59792af262bf263b21a3c49353f25945d8d9f70628e73de370d55e1e1", size = 206609, upload-time = "2026-04-02T09:27:36.661Z" }, { url = "https://files.pythonhosted.org/packages/69/d5/a527c0cd8d64d2eab7459784fb4169a0ac76e5a6fc5237337982fd61347e/charset_normalizer-3.4.7-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:3c9a494bc5ec77d43cea229c4f6db1e4d8fe7e1bbffa8b6f0f0032430ff8ab44", size = 220014, upload-time = "2026-04-02T09:27:38.019Z" }, { url = "https://files.pythonhosted.org/packages/7e/80/8a7b8104a3e203074dc9aa2c613d4b726c0e136bad1cc734594b02867972/charset_normalizer-3.4.7-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8d828b6667a32a728a1ad1d93957cdf37489c57b97ae6c4de2860fa749b8fc1e", size = 218979, upload-time = "2026-04-02T09:27:39.37Z" }, { url = "https://files.pythonhosted.org/packages/02/9a/b759b503d507f375b2b5c153e4d2ee0a75aa215b7f2489cf314f4541f2c0/charset_normalizer-3.4.7-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:cf1493cd8607bec4d8a7b9b004e699fcf8f9103a9284cc94962cb73d20f9d4a3", size = 209238, upload-time = "2026-04-02T09:27:40.722Z" }, { url = "https://files.pythonhosted.org/packages/c2/4e/0f3f5d47b86bdb79256e7290b26ac847a2832d9a4033f7eb2cd4bcf4bb5b/charset_normalizer-3.4.7-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:0c96c3b819b5c3e9e165495db84d41914d6894d55181d2d108cc1a69bfc9cce0", size = 236110, upload-time = "2026-04-02T09:27:42.33Z" }, { url = "https://files.pythonhosted.org/packages/96/23/bce28734eb3ed2c91dcf93abeb8a5cf393a7b2749725030bb630e554fdd8/charset_normalizer-3.4.7-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:752a45dc4a6934060b3b0dab47e04edc3326575f82be64bc4fc293914566503e", size = 219824, upload-time = "2026-04-02T09:27:43.924Z" }, { url = "https://files.pythonhosted.org/packages/2c/6f/6e897c6984cc4d41af319b077f2f600fc8214eb2fe2d6bcb79141b882400/charset_normalizer-3.4.7-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:8778f0c7a52e56f75d12dae53ae320fae900a8b9b4164b981b9c5ce059cd1fcb", size = 233103, upload-time = "2026-04-02T09:27:45.348Z" }, { url = "https://files.pythonhosted.org/packages/76/22/ef7bd0fe480a0ae9b656189ec00744b60933f68b4f42a7bb06589f6f576a/charset_normalizer-3.4.7-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:ce3412fbe1e31eb81ea42f4169ed94861c56e643189e1e75f0041f3fe7020abe", size = 225194, upload-time = "2026-04-02T09:27:46.706Z" }, { url = "https://files.pythonhosted.org/packages/c5/a7/0e0ab3e0b5bc1219bd80a6a0d4d72ca74d9250cb2382b7c699c147e06017/charset_normalizer-3.4.7-cp314-cp314t-win32.whl", hash = "sha256:c03a41a8784091e67a39648f70c5f97b5b6a37f216896d44d2cdcb82615339a0", size = 159827, upload-time = "2026-04-02T09:27:48.053Z" }, { url = "https://files.pythonhosted.org/packages/7a/1d/29d32e0fb40864b1f878c7f5a0b343ae676c6e2b271a2d55cc3a152391da/charset_normalizer-3.4.7-cp314-cp314t-win_amd64.whl", hash = "sha256:03853ed82eeebbce3c2abfdbc98c96dc205f32a79627688ac9a27370ea61a49c", size = 174168, upload-time = "2026-04-02T09:27:49.795Z" }, { url = "https://files.pythonhosted.org/packages/de/32/d92444ad05c7a6e41fb2036749777c163baf7a0301a040cb672d6b2b1ae9/charset_normalizer-3.4.7-cp314-cp314t-win_arm64.whl", hash = "sha256:c35abb8bfff0185efac5878da64c45dafd2b37fb0383add1be155a763c1f083d", size = 153018, upload-time = "2026-04-02T09:27:51.116Z" }, { url = "https://files.pythonhosted.org/packages/db/8f/61959034484a4a7c527811f4721e75d02d653a35afb0b6054474d8185d4c/charset_normalizer-3.4.7-py3-none-any.whl", hash = "sha256:3dce51d0f5e7951f8bb4900c257dad282f49190fdbebecd4ba99bcc41fef404d", size = 61958, upload-time = "2026-04-02T09:28:37.794Z" }, ] [[package]] name = "click" version = "8.3.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "colorama", marker = "sys_platform == 'win32'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/bb/63/f9e1ea081ce35720d8b92acde70daaedace594dc93b693c869e0d5910718/click-8.3.3.tar.gz", hash = "sha256:398329ad4837b2ff7cbe1dd166a4c0f8900c3ca3a218de04466f38f6497f18a2", size = 328061, upload-time = "2026-04-22T15:11:27.506Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ae/44/c1221527f6a71a01ec6fbad7fa78f1d50dfa02217385cf0fa3eec7087d59/click-8.3.3-py3-none-any.whl", hash = "sha256:a2bf429bb3033c89fa4936ffb35d5cb471e3719e1f3c8a7c3fff0b8314305613", size = 110502, upload-time = "2026-04-22T15:11:25.044Z" }, ] [[package]] name = "colorama" version = "0.4.6" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697, upload-time = "2022-10-25T02:36:22.414Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335, upload-time = "2022-10-25T02:36:20.889Z" }, ] [[package]] name = "coverage" version = "7.15.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/76/d0/55fe630f4cf94e3fcba868240fad8c8cdd1f764e2a932f8926347e6ec4cd/coverage-7.15.2.tar.gz", hash = "sha256:3df60dc267f0a2ca23cb7a9ab1109c62b9335ffbf519fcfe167157c28c09b81d", size = 927741, upload-time = "2026-07-15T18:56:19.558Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/6a/50/eb5bf42e531611a9f8d272556b1ed4de503f84a91413584094487cf69f8f/coverage-7.15.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:1adac78e5abc7c5438f7a209c9ca69d06542f0bf481d728b6989ea80b813fdf9", size = 221587, upload-time = "2026-07-15T18:54:18.439Z" }, { url = "https://files.pythonhosted.org/packages/06/d1/da99af464c335d4e023a6efcd7ec30f63b88a43c93745154ab74ffb31cea/coverage-7.15.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:b868acc62aa5de3be7a9d05c2333bf8359ca987e43f9cb30ff8fbda6a024ab73", size = 221943, upload-time = "2026-07-15T18:54:20.062Z" }, { url = "https://files.pythonhosted.org/packages/5b/8a/13c42723d61ca447eafa18732e8141dd6a63f2732e1c7e1502c182dd88d7/coverage-7.15.2-cp312-cp312-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:6f6966fc30e6f06ca8f98fb0ce51eda6b111b3ee8d066a8b1ec9e77fa06ab55d", size = 253450, upload-time = "2026-07-15T18:54:21.765Z" }, { url = "https://files.pythonhosted.org/packages/d7/29/99021303f98fbdcb63504b4d07bea4cc025b9b2dd907c4f07c85d50a0dab/coverage-7.15.2-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:68af907f595ab01a78f794932ff3bdf929c316d3000810d38dbc247129e26f8b", size = 256187, upload-time = "2026-07-15T18:54:23.4Z" }, { url = "https://files.pythonhosted.org/packages/f9/a8/fd503715ed6ca9c5d742923aa5209257340b367a867b2ced0c7d4ba8a0b9/coverage-7.15.2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:afa29e2eff3d5729267e2cb2fd4ce9d61c952932fb2694e34ccb5d9540c6a296", size = 257301, upload-time = "2026-07-15T18:54:25.183Z" }, { url = "https://files.pythonhosted.org/packages/da/40/3f4b8fb409810036ebc2857d36adc0498c6e957b5df0290c5036b2e143f1/coverage-7.15.2-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:bbf44513ceb1589e31948e20eafbde9deaface90e1a1afa5f5f77b4423d17ce6", size = 259562, upload-time = "2026-07-15T18:54:27.204Z" }, { url = "https://files.pythonhosted.org/packages/0b/8a/9bdffbef47db77cce3d6b02a28f7e919b19f0106c4b080c2c2246040f885/coverage-7.15.2-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:9deddf09eecb717b7f980414b43d90a5b22ff3967d2949ab29cb0aa83d9e9098", size = 253841, upload-time = "2026-07-15T18:54:29.134Z" }, { url = "https://files.pythonhosted.org/packages/1b/1e/9031efde019d31a06646261fce6dfc5c3c74e951e27a71e5c9a424563178/coverage-7.15.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:ae901f7e55ba405c84ee1cab3d3e962e4e871e4a2bcb9c90911adbd69b42ac5a", size = 255221, upload-time = "2026-07-15T18:54:31.142Z" }, { url = "https://files.pythonhosted.org/packages/56/db/787acde872389fc84a9ef9d8cd1ccc658e391ab4cb5b28092a714426a394/coverage-7.15.2-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:a0f47002c6eeb7c280228467a4cb0cc15ca2103a8421b986b2d3ec04a0f9bd8b", size = 253366, upload-time = "2026-07-15T18:54:32.886Z" }, { url = "https://files.pythonhosted.org/packages/2f/9b/6f57bc4b93c842eef1695f8cdaf2318e35e7ba54f5ba80d84be213ab7858/coverage-7.15.2-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:1cd7a5beb7af3e864a13b1f0fb26efd3695da43ef0daf71e586adfffaf34d5b2", size = 257434, upload-time = "2026-07-15T18:54:34.7Z" }, { url = "https://files.pythonhosted.org/packages/88/26/b3186a21b2acc83e451118978905c81c7072c3333707804db09a78c096a2/coverage-7.15.2-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:97a5c5457a9fb1d6c4e06cfb5dc835871fbfb6a6a51addc9e925bdeff5ef7440", size = 252935, upload-time = "2026-07-15T18:54:36.548Z" }, { url = "https://files.pythonhosted.org/packages/20/c2/c9f3376b2e717ea69ed7a6e9a5fcab968fb0b290db6cf4bd9a1fc7541b75/coverage-7.15.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:0901cfe6c13bcd2302da4f83e884555d2a22bda6e4c476f09ef204ba20ca536e", size = 254807, upload-time = "2026-07-15T18:54:38.296Z" }, { url = "https://files.pythonhosted.org/packages/f0/e1/dfc15401f4a8aaeb486e1ba3e9e3c40522a6e38bd0ecf0b3f29cb8082957/coverage-7.15.2-cp312-cp312-win32.whl", hash = "sha256:b171bdd71cb7ff792bf32e376173b0ace7e7963e7e57c58dfc42063a6a7174cd", size = 223641, upload-time = "2026-07-15T18:54:40.103Z" }, { url = "https://files.pythonhosted.org/packages/91/40/81b6d809d320cd366ec5bdf8176575e897dcb8efe7fb4b489ef9e93e4d13/coverage-7.15.2-cp312-cp312-win_amd64.whl", hash = "sha256:582edc45c2040543fef83341be23c43024a3ab3ae0c2d8bc498a06282905ad40", size = 224172, upload-time = "2026-07-15T18:54:41.882Z" }, { url = "https://files.pythonhosted.org/packages/ef/28/9f14ec438149f7de557f45518f09b4a7917b795cc37083aa7db482693f8c/coverage-7.15.2-cp312-cp312-win_arm64.whl", hash = "sha256:a638db90c61cd219aeee65e83a24fdaa57269a741ae0cf773309208ac862cee3", size = 223556, upload-time = "2026-07-15T18:54:43.674Z" }, { url = "https://files.pythonhosted.org/packages/fc/d5/f8c838e6b7282976f7c918884b792df7a0c42c5bba5d99c60ad2d221d56d/coverage-7.15.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:1121caa19159a38b5463eaae4b1e1fde81e525b15ecc5e000cd5b1a108f743a8", size = 221606, upload-time = "2026-07-15T18:54:45.448Z" }, { url = "https://files.pythonhosted.org/packages/bf/37/97c926376364f66298cc44893b89cdf17b8bc406376497c4061ae4b8a8ff/coverage-7.15.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a300c6934e0989c327b9e8a1e110329da4641149f872bbe9f70168be66da76c1", size = 221982, upload-time = "2026-07-15T18:54:47.341Z" }, { url = "https://files.pythonhosted.org/packages/b7/30/a36050a6e83c2135ee0776f452ca3948224befc6d7f26acecc082d0c106a/coverage-7.15.2-cp313-cp313-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:2617f8799d268fabdeef42a7e89ac3a23e1deee9025427db2df970f99a89a578", size = 252972, upload-time = "2026-07-15T18:54:49.2Z" }, { url = "https://files.pythonhosted.org/packages/31/d3/06b5f1daf95f0f15ab05bd75f26ba5f3c8b33d0bb72f3aaa3cf41d1bad3a/coverage-7.15.2-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:7dc2950a2992cd676d35c20ae63522836deeb034f08874699d14068710af3dc1", size = 255569, upload-time = "2026-07-15T18:54:51.098Z" }, { url = "https://files.pythonhosted.org/packages/81/1c/9afb3f8de2b8d36960391c48559a2e3ff96594b58099f115921549ea8d0d/coverage-7.15.2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9e36686f7a442185db2400b3df171aac520869faf9deb59df687d28659eda2a6", size = 256806, upload-time = "2026-07-15T18:54:53.145Z" }, { url = "https://files.pythonhosted.org/packages/64/d8/b989f96061a5e32d82fddd1b1b9ff48a7c8f8ae7606f0e80fd9de54b1e33/coverage-7.15.2-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:7d29ca7bd67af6e12e74632d65f026eabc1364da5c254494cd914446a28a3ef7", size = 258936, upload-time = "2026-07-15T18:54:55.015Z" }, { url = "https://files.pythonhosted.org/packages/b8/fa/f99771f5110457c7b511c1935ca49ddf288218eaa84322e028b9334146ae/coverage-7.15.2-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:db9c8438057e5b0f6a22a0af99c0c1d26b57fbbdbd1be5861ddb8f897fcc3a2d", size = 253178, upload-time = "2026-07-15T18:54:57.527Z" }, { url = "https://files.pythonhosted.org/packages/f6/96/c098a6044d119c751ceede7be91035fa8310170ec24a6523aff72f0a5793/coverage-7.15.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:63022c4c8dec1d0342f05c3ede99842fe3d007689acc45e86f123a1746e4a026", size = 254934, upload-time = "2026-07-15T18:54:59.41Z" }, { url = "https://files.pythonhosted.org/packages/b2/a2/1457b3a7a50c8d77500103b97a046db863e2f59a1cf6d2f814595f349885/coverage-7.15.2-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:6c0be82b4d4aa5b2704e08518e2252f3e3d110164bcca826816801052e48a7aa", size = 252898, upload-time = "2026-07-15T18:55:01.338Z" }, { url = "https://files.pythonhosted.org/packages/6c/0e/76958874c471ecfcdde0d2b2747bb2c61bdbf34a40636f4ce9db9923e643/coverage-7.15.2-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4510fb9cdf6bb02dfa6af0be4a534b8102d086e22e4a33f8836df663da3d660d", size = 257056, upload-time = "2026-07-15T18:55:03.243Z" }, { url = "https://files.pythonhosted.org/packages/7c/7c/3d7c4e3bf58baa40327dc7edc2272b17cf02299366d52763db1b0ca1556a/coverage-7.15.2-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:42ec3d989421b174a2ab607c1539f24127ad362757b7f1c0c0d7a2993f7eb37b", size = 252718, upload-time = "2026-07-15T18:55:05.029Z" }, { url = "https://files.pythonhosted.org/packages/c8/b8/1cecffed9ce14fb25be9ba42d37b6bb61485c9a3ddd43cd3dde36b6087d8/coverage-7.15.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:e8f91bce78e32343af184c3b7fa28fcf5a9e2641f4b6623d392038f804939188", size = 254490, upload-time = "2026-07-15T18:55:06.889Z" }, { url = "https://files.pythonhosted.org/packages/6c/2c/42984561bc7f4c045dca67516a0c50ee5ef8d84352dbeb5559dc86c4823e/coverage-7.15.2-cp313-cp313-win32.whl", hash = "sha256:434e68d531858205895eb0d74b73d20b84260de426387d53c422a5acda2cf050", size = 223647, upload-time = "2026-07-15T18:55:08.941Z" }, { url = "https://files.pythonhosted.org/packages/41/9f/39c7c9245efc583beddf89a87683574e663ed93637f3afb6cd7b88405676/coverage-7.15.2-cp313-cp313-win_amd64.whl", hash = "sha256:26c3b04a6377fd7c09800921fa934e3a17c0020439cd59df73e73ae1d4b6a78c", size = 224190, upload-time = "2026-07-15T18:55:10.789Z" }, { url = "https://files.pythonhosted.org/packages/c7/de/3a2883cf8a213659280ef4b403059e17a9acaeb7fc7fd4105e1226ff2e6d/coverage-7.15.2-cp313-cp313-win_arm64.whl", hash = "sha256:3ed010aa1b69cda8e827aabfca9866216c980e2dca82ab9a78c5f83689964c8b", size = 223583, upload-time = "2026-07-15T18:55:12.678Z" }, { url = "https://files.pythonhosted.org/packages/81/5f/aed265fd7a3551a394f36dfe41868aee709b7f95db4052205b4ad1563ac3/coverage-7.15.2-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:40f633c5c5fc783732f6312280122e859538fa24461235597c13d803ea9a108a", size = 221650, upload-time = "2026-07-15T18:55:14.527Z" }, { url = "https://files.pythonhosted.org/packages/6b/2c/222ba12a545189017120f8eddfc1a0bd4616b47d5d4a8d99421edb2fe4c6/coverage-7.15.2-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:075560438765b7a2ef43bf7aa7758661b53d889df47f062a31bda6c1ade553a2", size = 221988, upload-time = "2026-07-15T18:55:16.674Z" }, { url = "https://files.pythonhosted.org/packages/aa/38/304b5877ab46e6c290b4292cfcf3fe28245f0e5597cad7f6acc91fc7e0a4/coverage-7.15.2-cp314-cp314-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:25fd15dd40a0a2c51a500d664ca29053c09c3259d998407bf982b6e114696138", size = 253029, upload-time = "2026-07-15T18:55:18.856Z" }, { url = "https://files.pythonhosted.org/packages/6c/58/821b533b8db9e44cf1d8a97bd525149ced40dde1d0093da02cb78e715244/coverage-7.15.2-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:b9a6367e4aff723e8ee8190836836124284e8fcd4265e307c844010cfa074f3f", size = 255536, upload-time = "2026-07-15T18:55:21.027Z" }, { url = "https://files.pythonhosted.org/packages/f1/f2/7aa06604c389d32ea7f0a6a988359a7eafc3cd3f8e7bc2e88cd2fdf0b877/coverage-7.15.2-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9854ca62c152874b2060772503535be2e8f53f70b8aaa7686b094888d872f984", size = 256881, upload-time = "2026-07-15T18:55:23.125Z" }, { url = "https://files.pythonhosted.org/packages/a2/4f/1ef342339c7916d0096bc5888cc0f653882cc7bc8f897d5cb89143287c9b/coverage-7.15.2-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:913b6c56e110da40e035bbd168353bf7aaa2544a5eaccea5d98a4629aac156c7", size = 259196, upload-time = "2026-07-15T18:55:25.099Z" }, { url = "https://files.pythonhosted.org/packages/fe/f4/7ed055d7a9c5ec13b161773a115a5ccc6b0081d568c31fad830806306cc7/coverage-7.15.2-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:aaccad4129d735a8a4d526f26929894c9a4e8ef7034566f210b176749d6906e3", size = 253036, upload-time = "2026-07-15T18:55:27.018Z" }, { url = "https://files.pythonhosted.org/packages/14/79/ea82cca18c242a3a38b6c017da39726aa62dcb64aa635abf79b92009975c/coverage-7.15.2-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:a164b50081fc7357331c4024ef4d17b78ba325f8380d05f5a69599a7e05257ee", size = 254887, upload-time = "2026-07-15T18:55:29.084Z" }, { url = "https://files.pythonhosted.org/packages/a4/ba/a136db3c0d9562b00e10b72540dbf3a33cd3bc5b95060c9308e247494623/coverage-7.15.2-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:bfd341ccf78128e72c094bc70cc25b3ef309c33c7c2c66ba3ed4309549e02de1", size = 252852, upload-time = "2026-07-15T18:55:31.184Z" }, { url = "https://files.pythonhosted.org/packages/17/17/ea334246b16b7d059953fad6fdefa11e33c68efbd3fe37b1098120a1fac2/coverage-7.15.2-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:1473b3ba8e7ee0f076117b1a72c23f579a2b9e2bb742f48a8d86ea27ca93f91a", size = 257128, upload-time = "2026-07-15T18:55:33.163Z" }, { url = "https://files.pythonhosted.org/packages/ed/c3/074fb66d46d607855f710876b117cbda562c5ab08363528e78820449f937/coverage-7.15.2-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:17c432b5f73ad52ef46fb06019f6fa7c66ce381961cf0f7dfd1d3a4bd3a98145", size = 252668, upload-time = "2026-07-15T18:55:35.063Z" }, { url = "https://files.pythonhosted.org/packages/e1/c1/f620850ada9b36435921c9a3a8057013422b1d964eb4bf37fe138724d192/coverage-7.15.2-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:77f0ef5011df53a4bd1b35211ab122287f8d9b8d7aa1c4553e5c2deb24b1d446", size = 254325, upload-time = "2026-07-15T18:55:37.125Z" }, { url = "https://files.pythonhosted.org/packages/cc/31/a729ca3689404493af82ef8e6ff70bd88bdda8da89aeef6ca9b387aeb2b4/coverage-7.15.2-cp314-cp314-win32.whl", hash = "sha256:f653e5d7248c1191ec988a85c72edeab46c3ff44f90639a4ed4874ec0be90243", size = 223844, upload-time = "2026-07-15T18:55:39.078Z" }, { url = "https://files.pythonhosted.org/packages/c6/83/5d809dc808fb1698c671f3e372259bb9158e64b7ea526fc6ab7de64de9fe/coverage-7.15.2-cp314-cp314-win_amd64.whl", hash = "sha256:9911f31aad8906abe337c271343485cf20df5e70df5d2f57f9f136e7b55f26bc", size = 224331, upload-time = "2026-07-15T18:55:41.346Z" }, { url = "https://files.pythonhosted.org/packages/16/4e/35e488548e952795829e129995c4174df33bf432b591d1aa42c8d9e4e7ad/coverage-7.15.2-cp314-cp314-win_arm64.whl", hash = "sha256:e38def96ad59853824c97953fdcd2c320a84ba3ce99b417db78af8bb6c3db635", size = 223760, upload-time = "2026-07-15T18:55:43.518Z" }, { url = "https://files.pythonhosted.org/packages/ed/49/dd2c86cd6374038f6e415fb5bfb86db5218553209c081384a020369dee79/coverage-7.15.2-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:835ec4e20b45f0a7f63ed78f94065aca00de033403df8377bfe8b9c6abc0a7be", size = 222384, upload-time = "2026-07-15T18:55:45.569Z" }, { url = "https://files.pythonhosted.org/packages/d3/74/173ff17a1c0808e5a438f549f6f145d5ac7528f2791310b63523e3200ac7/coverage-7.15.2-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:7466cc7ab6dc0db871d264bf99e8779f0917ee63d40730af0552f71535a6e072", size = 222647, upload-time = "2026-07-15T18:55:47.544Z" }, { url = "https://files.pythonhosted.org/packages/84/f8/b8cba872162356fb44ac79c10309d987206a4461e32072fc29228dad7331/coverage-7.15.2-cp314-cp314t-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:e370c12133095ff18432de8c044962be85a5a96d90c6fcbce8e17e76236d2328", size = 264013, upload-time = "2026-07-15T18:55:49.768Z" }, { url = "https://files.pythonhosted.org/packages/ee/67/a807a7586d0b8cae485308ddd55756f0806c92f8e0b411bacbf23c48edf3/coverage-7.15.2-cp314-cp314t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:fe41909c9515c3bfdb5f02c4d1f857dba322d9a9a1178069b91eea77889df63a", size = 266135, upload-time = "2026-07-15T18:55:51.941Z" }, { url = "https://files.pythonhosted.org/packages/ce/67/cd78771dc985f7e4ebdcc82b1a96d9a932af9e806f01f2f91a89f4c72e80/coverage-7.15.2-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6aa28cfb6488e5453b5b762d65f73aa586380f6693a04d58078ce228a29b06c0", size = 268555, upload-time = "2026-07-15T18:55:54.065Z" }, { url = "https://files.pythonhosted.org/packages/18/3e/10134cf81275188c58568f324fc74aedff32c63ca4d5bbc513a91944a6f0/coverage-7.15.2-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:bcc0aae933921d03096f53b0b03eeb702129fd406dee59f08d2efacc68681fa5", size = 269674, upload-time = "2026-07-15T18:55:56.066Z" }, { url = "https://files.pythonhosted.org/packages/75/4a/771b77de446cba985dc414bbc5844bd21604da05dbc044286df8318a48a7/coverage-7.15.2-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:7c63387e21ab21f512c69c9756a8c7dadd322c7275edb064064433c9a09c3743", size = 263101, upload-time = "2026-07-15T18:55:58.107Z" }, { url = "https://files.pythonhosted.org/packages/5f/b5/70a7011da15f4071943361183aefa27847f3e3aec4fd335f1cb3d3a622b1/coverage-7.15.2-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:0e55510bc98ae943cece9e667a6c0fe94c6a92913720dea34243657a17993d0c", size = 266007, upload-time = "2026-07-15T18:56:00.468Z" }, { url = "https://files.pythonhosted.org/packages/b4/0d/f9547e804ce7ad49646ffeffac26699510efbe6c0f751b66fdc960c4e825/coverage-7.15.2-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:2ff08701be2d1556fc78b326c80a3e8042da09352ecb3819105f8e386c8a3071", size = 263611, upload-time = "2026-07-15T18:56:02.615Z" }, { url = "https://files.pythonhosted.org/packages/ac/59/f576a396659c0efd351f5c1544f67c3560e89c7761cabf7f65e412beeda5/coverage-7.15.2-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:38c9518b7103826c403a461544e3c2e77151e8676d06eaed85911a97e962584a", size = 267344, upload-time = "2026-07-15T18:56:04.622Z" }, { url = "https://files.pythonhosted.org/packages/7c/5d/c2e4fce3579c0cb635024293f1a32bbe26df101b3e3a69f22243d1352b6c/coverage-7.15.2-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:dee88b1ed88587abd8c0269a1fc1f4cc77f7750d1dfde2869e2a123af420e67d", size = 262456, upload-time = "2026-07-15T18:56:06.641Z" }, { url = "https://files.pythonhosted.org/packages/bb/dd/956287d69436b66094bc4b57ac2da71e43bfd2a5524e958900b9f582fcf8/coverage-7.15.2-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:2fbeeeecea279727f8ac16c8e1133ddfeee793e985c86ae343d6a5ce744eef8c", size = 264771, upload-time = "2026-07-15T18:56:08.795Z" }, { url = "https://files.pythonhosted.org/packages/2c/5a/6f979530c2734c575de77cf58f5f28d51f7123a94b5030fd9156fe5f363c/coverage-7.15.2-cp314-cp314t-win32.whl", hash = "sha256:cb0fddaa6884be6aae36ced9544b5e90f7d5f03845a2853bf47a14953a4e8688", size = 224151, upload-time = "2026-07-15T18:56:10.856Z" }, { url = "https://files.pythonhosted.org/packages/54/7e/27f6b2a74d484742f4017553e710b01e396b23d809df3e95ca0bb9a2824b/coverage-7.15.2-cp314-cp314t-win_amd64.whl", hash = "sha256:77f091ea3a9cc611cd29f433565476bc1936c084ac8eee00ea0e7e70c27e4199", size = 224981, upload-time = "2026-07-15T18:56:12.928Z" }, { url = "https://files.pythonhosted.org/packages/b1/48/284863423aa474240f6842bd00d680da22f4e6ea2e466618ef7c9c9e69a9/coverage-7.15.2-cp314-cp314t-win_arm64.whl", hash = "sha256:6fc448c377d6eeb00a47c673494bd9bae29280ca53987e1869e67ebedfe20658", size = 224294, upload-time = "2026-07-15T18:56:15.156Z" }, { url = "https://files.pythonhosted.org/packages/ec/82/32e3bd191d498e64f6f911ad55d14006a0861e54869d2d32452326399e65/coverage-7.15.2-py3-none-any.whl", hash = "sha256:eb6bcae8d1a9d305351ecb108232441d11c5cfe9de840a04388ba5d2db8d735c", size = 213375, upload-time = "2026-07-15T18:56:17.305Z" }, ] [[package]] name = "cryptography" version = "48.0.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "cffi", marker = "platform_python_implementation != 'PyPy'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/12/45/870e7f4bef50e5f53b9f51d4428aee5290eedf58ba443f16b1ebb7ab8e66/cryptography-48.0.1.tar.gz", hash = "sha256:266f4ee051abb2f725b74ef8072b521ce1feacf685a3364fa6a6b45548db791a", size = 832989, upload-time = "2026-06-09T22:32:31.8Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/1b/bc/ee4137cbbe105652c0ee4252792b78fc8e7afa4b8e61d9d5dc05a7f45731/cryptography-48.0.1-cp311-abi3-macosx_10_9_universal2.whl", hash = "sha256:3e4a1a3232eef2e6c732827d5722db29a0cc8b27af2a4d865b094cf954be9ca1", size = 8008324, upload-time = "2026-06-09T22:31:00.702Z" }, { url = "https://files.pythonhosted.org/packages/d5/85/6379d42181bfc713094f081360fc5784d6c816b599d45e7f082502d173ce/cryptography-48.0.1-cp311-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:32143b24adb918f078134e1e230f1eb8cc04886b92c28b5f0041aaf3e5699225", size = 4696243, upload-time = "2026-06-09T22:32:33.446Z" }, { url = "https://files.pythonhosted.org/packages/9c/87/c85d147b53323c7eb4d850920c8901377323c2a0ff8d79c262d4fee89aa2/cryptography-48.0.1-cp311-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:f0d27a5696721ef7a672b8c810f6aded391058e0b9486e63e6d93baf765da691", size = 4713235, upload-time = "2026-06-09T22:31:40.141Z" }, { url = "https://files.pythonhosted.org/packages/79/58/67cbf8cf1ee7c54b439ca07bbecf8362c07afc11a3724fea70f745784add/cryptography-48.0.1-cp311-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:eb86ce1af36fe65041b6db9a8bb064ee621a7e5fded0f80d475ec243477cd242", size = 4702323, upload-time = "2026-06-09T22:31:42.191Z" }, { url = "https://files.pythonhosted.org/packages/89/c6/24266ac10c47f6cd2a865f4446062b466da1d1f10b27189eac00e61bf0c9/cryptography-48.0.1-cp311-abi3-manylinux_2_28_ppc64le.whl", hash = "sha256:b024e784ad6c077ee0147b35ea9cbfc1e34e1fd4c1dcca214c2794d73a12df08", size = 5300085, upload-time = "2026-06-09T22:31:58.703Z" }, { url = "https://files.pythonhosted.org/packages/d2/bb/cc4b78784f97efc8c5874c2a9743708d172be6663024b34a0467885ae0c8/cryptography-48.0.1-cp311-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:3752f2dbc8f07a30aad2932c986cea495b03bb554887828225da104f732852b6", size = 4746137, upload-time = "2026-06-09T22:31:31.01Z" }, { url = "https://files.pythonhosted.org/packages/1f/52/0c44de3f5267f8fbe8e835138017522a333436166e406f0db9b9e6e3033f/cryptography-48.0.1-cp311-abi3-manylinux_2_31_armv7l.whl", hash = "sha256:bd81490cd5801d755cf97bb68ac191f14b708470b1c7cf4580f669b9c9264cd8", size = 4333867, upload-time = "2026-06-09T22:32:28.096Z" }, { url = "https://files.pythonhosted.org/packages/9a/2e/772d7adbfa931537bc401640b7cac9976bff689bda187833e5d63b428e49/cryptography-48.0.1-cp311-abi3-manylinux_2_34_aarch64.whl", hash = "sha256:66fd0771e7b9c6dcd44cf1120690d2338d16d72795cf40cae2786a39eba65429", size = 4701805, upload-time = "2026-06-09T22:31:38.284Z" }, { url = "https://files.pythonhosted.org/packages/f8/a3/b06844f303873493c963caf581c04df31c7035e0c1b0f02c4814d319ec80/cryptography-48.0.1-cp311-abi3-manylinux_2_34_ppc64le.whl", hash = "sha256:3fd2ca57062b241c856670b073487d2e86c4637937ca5601e48f97bf8e11fc8f", size = 5258461, upload-time = "2026-06-09T22:31:04.187Z" }, { url = "https://files.pythonhosted.org/packages/9f/13/8b765e2e12b07c74941caadb9d1c8fdc006c4dfbf2b8f2d610519758954d/cryptography-48.0.1-cp311-abi3-manylinux_2_34_x86_64.whl", hash = "sha256:0ee6ea481db1ab889cba043ec1eda17bb9c1ea79db6722f779c3667f9f70322f", size = 4745488, upload-time = "2026-06-09T22:32:30.07Z" }, { url = "https://files.pythonhosted.org/packages/2e/aa/48972bce55049b32a94f4907eda4d75fa385aad8a39506cc2fc72196ecf0/cryptography-48.0.1-cp311-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:f2ceef93cb096aa3c4cc4b5c94ca6131f9196d28c64d6111533402a9b2054d41", size = 4830256, upload-time = "2026-06-09T22:31:43.868Z" }, { url = "https://files.pythonhosted.org/packages/47/a2/e5079a032fb85cf6005046ca92bbd78b0c82dad2b5751ab8c311659da06f/cryptography-48.0.1-cp311-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:9bd3f92d76217892b15df84ca256c2c113d386fdda7a7d8691aeeced976507c6", size = 4979117, upload-time = "2026-06-09T22:31:05.845Z" }, { url = "https://files.pythonhosted.org/packages/b7/a0/8f50cae9c74e718ed769d63ed5c74bd0ea830c9550a74629cebd1b9c7bc7/cryptography-48.0.1-cp311-abi3-win32.whl", hash = "sha256:b9a32b876490d66c8bcc9963ef220199569748434ab01a9d6aaeabf88e7f5158", size = 3304154, upload-time = "2026-06-09T22:32:16.845Z" }, { url = "https://files.pythonhosted.org/packages/c5/69/0572c77dbace6fef72f33755bd52ea399c71367250d366237f8691826b9e/cryptography-48.0.1-cp311-abi3-win_amd64.whl", hash = "sha256:39489bfca54c7a1f6b297efcd8bc608ab92d16c4ca631b0cad4da46724588b24", size = 3817138, upload-time = "2026-06-09T22:32:00.388Z" }, { url = "https://files.pythonhosted.org/packages/42/06/3e768b4c3bc78201583fa35a0e18f640dd782ff41afba88f8545481a8874/cryptography-48.0.1-cp314-cp314t-macosx_10_9_universal2.whl", hash = "sha256:f817adc181390bd54f2f700107a7419040fb7c1bdf2fc26f36551a06a68c3345", size = 7989830, upload-time = "2026-06-09T22:31:07.8Z" }, { url = "https://files.pythonhosted.org/packages/8a/13/6476736484b94041110c8340a3eb63962fea4975baea8cb4a512adb44d4d/cryptography-48.0.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:d5d30989c6917b478b5817902e85fddaea2261efa8648383d965381ccb9e1ac4", size = 4689201, upload-time = "2026-06-09T22:31:09.745Z" }, { url = "https://files.pythonhosted.org/packages/79/62/65a87f34d2a431546e2509b85d55e8c90df86d668f6731da64d538512ac2/cryptography-48.0.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:df637c05205ea7c1d7fbcbe54bbfea648a52951155f997af13d895d0ecc96991", size = 4702822, upload-time = "2026-06-09T22:32:24.409Z" }, { url = "https://files.pythonhosted.org/packages/7f/59/810b5204b0a9b10f4b6bc06bd551a8b609803cd931806bc3b71884b225e5/cryptography-48.0.1-cp314-cp314t-manylinux_2_28_aarch64.whl", hash = "sha256:869c3b8a53bfe27147832df48b32adadf558249d50e76cb3769d40e986b13265", size = 4694875, upload-time = "2026-06-09T22:32:08.737Z" }, { url = "https://files.pythonhosted.org/packages/24/dc/d8ca05ffea724eec6d232ea6f18e74c269eb6bdfdcc9bfba689790d1325f/cryptography-48.0.1-cp314-cp314t-manylinux_2_28_ppc64le.whl", hash = "sha256:e361afba8918070d376df76f408a4f67fec0ee9cff81a99e48fe9a233ef59e17", size = 5290385, upload-time = "2026-06-09T22:31:15.212Z" }, { url = "https://files.pythonhosted.org/packages/03/8c/3be6cb4da181f5bb6c19cf560c2359d60644a6b5fc5b57854e528f47b296/cryptography-48.0.1-cp314-cp314t-manylinux_2_28_x86_64.whl", hash = "sha256:d069066deead00ac7f090be101be875a06855908f7ec004c27b8fefb4acfb411", size = 4737082, upload-time = "2026-06-09T22:32:22.66Z" }, { url = "https://files.pythonhosted.org/packages/aa/f6/d5f60a5a1434dbfd949e227fd0065d194c7e6b6ac526b17f5c06152b8231/cryptography-48.0.1-cp314-cp314t-manylinux_2_31_armv7l.whl", hash = "sha256:09f73a725d582cef64b91281a322cd798d14a33b2b6f2b7ad9531dc336d84c02", size = 4325328, upload-time = "2026-06-09T22:32:10.777Z" }, { url = "https://files.pythonhosted.org/packages/17/b7/ba75dd947a14b6ad907b01ae8f6b5b348cdd1b48142f0063dee9e20c1d9d/cryptography-48.0.1-cp314-cp314t-manylinux_2_34_aarch64.whl", hash = "sha256:15254441469dd6bf027039453288e2072124f8b6603563f5d759e1c9b69273fa", size = 4694530, upload-time = "2026-06-09T22:31:53.105Z" }, { url = "https://files.pythonhosted.org/packages/62/29/50d6b9e8aff12d8b67afaeb3569335e32dc83a5723e3bbded24fdac9f809/cryptography-48.0.1-cp314-cp314t-manylinux_2_34_ppc64le.whl", hash = "sha256:8ace4507d1e6533c125f4fac754f8bb8b6a74c08e92179dabd7e16571a3efbf3", size = 5245046, upload-time = "2026-06-09T22:31:25.774Z" }, { url = "https://files.pythonhosted.org/packages/9f/04/618f4115cfc0add0838c82507aa18a346089428da8653ad38b3ff36f5cb3/cryptography-48.0.1-cp314-cp314t-manylinux_2_34_x86_64.whl", hash = "sha256:b4e391975f038e66432328639620a4aff2d307513b004f1ca06d6225bced815c", size = 4736660, upload-time = "2026-06-09T22:32:12.676Z" }, { url = "https://files.pythonhosted.org/packages/24/9c/06e062462a0de28a3b3911322eded4c16deb9f441b1b7575d3dc59488ab5/cryptography-48.0.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:42fcd8e26fe555d9b3577a135f5091fefa0aa4e99129c23fb56787a1bd4ada72", size = 4822229, upload-time = "2026-06-09T22:31:17.062Z" }, { url = "https://files.pythonhosted.org/packages/f4/be/0561971eaaee4b8a0e7d5113c536921063ab91aaf23278ac374eaf881e11/cryptography-48.0.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:c1400da5e32a43253392277eac7490a60e497d810a63dd5608d71bbd7af507c9", size = 4966364, upload-time = "2026-06-09T22:31:32.842Z" }, { url = "https://files.pythonhosted.org/packages/a4/27/728c77876f12b000820b69ae490f3c4083775e79e07827e9e60be07ad209/cryptography-48.0.1-cp314-cp314t-win32.whl", hash = "sha256:0df56b056bc17c1b7d6821dfa65216e62bd232d8ab05eb3db44e71d235651471", size = 3278498, upload-time = "2026-06-09T22:31:29.154Z" }, { url = "https://files.pythonhosted.org/packages/06/e3/79a612c6d7b1e6ee0edd43633d53035bec2cfb78c82b76f7864f39e36f34/cryptography-48.0.1-cp314-cp314t-win_amd64.whl", hash = "sha256:9de21387aa95e2a895823d0745b430bed4f33503ba9ab5e0b5311f33e37d66d2", size = 3798790, upload-time = "2026-06-09T22:31:56.697Z" }, { url = "https://files.pythonhosted.org/packages/ca/6c/00fa2a95997164c8b2072ce327c23d4ab20809ccc323ea5fab91e53a4bba/cryptography-48.0.1-cp39-abi3-macosx_10_9_universal2.whl", hash = "sha256:4fdc69f8e4316bcf0c8c8ec1f26f285d12e8142d88d96c876a59a03be3f6ae67", size = 7987408, upload-time = "2026-06-09T22:32:20.777Z" }, { url = "https://files.pythonhosted.org/packages/b0/d9/45f309a7e4e5f3f8f121d6d3be9e94024a7726ec598d6e08ae04edb2f04d/cryptography-48.0.1-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:48fe40804d4caa2288f24e70ca8c64c42dd826da0ad7e4f1b41b2128d679e6c8", size = 4690196, upload-time = "2026-06-09T22:31:54.74Z" }, { url = "https://files.pythonhosted.org/packages/5f/9f/a1bc8bcc798811b8527eb374bbccf30a3f3e806829d967118222bf1125eb/cryptography-48.0.1-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:86be3b1b0b6bf09482fb50a979c508d2950ed95f5621ec77f4e385962006b83a", size = 4696782, upload-time = "2026-06-09T22:31:45.615Z" }, { url = "https://files.pythonhosted.org/packages/66/c2/81a4fb4e4373c500bb526bc337ac5719dd31dd15b970b84a238168c6aa08/cryptography-48.0.1-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:4ab0a343c807bbcd90c971cd1ecf072937cd01847a9e002bef88fb47ac6be577", size = 4696618, upload-time = "2026-06-09T22:31:11.564Z" }, { url = "https://files.pythonhosted.org/packages/e5/0b/aa68b221dde92d09cb29a024ede17550ee21e77a404e59fc093c82bb51e1/cryptography-48.0.1-cp39-abi3-manylinux_2_28_ppc64le.whl", hash = "sha256:9621de99d2da096006b629979efd8ae7eb2d8b822488d0c89ee4000c306c59b1", size = 5289970, upload-time = "2026-06-09T22:31:20.368Z" }, { url = "https://files.pythonhosted.org/packages/78/13/fba657f958d2af66ea959a4ba01212632089249d34af1ae48054136344d7/cryptography-48.0.1-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:88c852a0ae366e262e5a1744b685e6a433dc8788dd2a277e418bf4904203609d", size = 4731873, upload-time = "2026-06-09T22:31:22.253Z" }, { url = "https://files.pythonhosted.org/packages/4c/4c/9a964756d24a26b3e34dfcb16f961b89838786e6700b635b0d1e3adff4b6/cryptography-48.0.1-cp39-abi3-manylinux_2_31_armv7l.whl", hash = "sha256:43c5835e2cb98c8733d86f57d6fc879b613f5c3478607281c3e36daffc6dd8a6", size = 4330804, upload-time = "2026-06-09T22:31:36.56Z" }, { url = "https://files.pythonhosted.org/packages/4b/0f/a10f3a6eb12950a10e3a874070283aa2dd5875b2bfd15fad8a3e17b3f13e/cryptography-48.0.1-cp39-abi3-manylinux_2_34_aarch64.whl", hash = "sha256:fe0180af5bf9236518a087e35bf2d9a347d5f5f51e63c579d683ddff424e3d46", size = 4696217, upload-time = "2026-06-09T22:31:13.351Z" }, { url = "https://files.pythonhosted.org/packages/f3/6f/5cd12f951165ea73ef85266775d97e4c763b2474ccfd816dd69d3a18d6f8/cryptography-48.0.1-cp39-abi3-manylinux_2_34_ppc64le.whl", hash = "sha256:b7a2d1a937a738a881737cec135a38bb61470589b17515b9f73f571d0ae10401", size = 5245252, upload-time = "2026-06-09T22:32:02.193Z" }, { url = "https://files.pythonhosted.org/packages/68/ab/8aaa12e4516ec4464033ab79b6f3b592bd5a92102467c4ace8a0d970203f/cryptography-48.0.1-cp39-abi3-manylinux_2_34_x86_64.whl", hash = "sha256:b74ca3b8e5ecdd833bf6a002ca41b4793bb27fb8f1c06ffaf2643c9e9140e31b", size = 4731388, upload-time = "2026-06-09T22:32:04.019Z" }, { url = "https://files.pythonhosted.org/packages/1b/24/50027ea4dca85ec1f40688f3c24fb32ccacd520583c9592c3cc95628e6fb/cryptography-48.0.1-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:2c37f2461406063b417837f5f3daab668652acd82423efcd7f0a9f04be972de1", size = 4824186, upload-time = "2026-06-09T22:32:18.707Z" }, { url = "https://files.pythonhosted.org/packages/52/41/04cb5eb17085ade6f50cc611fb657df6a0f5885350de8764ece89c050197/cryptography-48.0.1-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:86fe77abb1bd87afb251d4d02ada7ecf53a32cee9b67d976abb2e45a13297475", size = 4964539, upload-time = "2026-06-09T22:31:18.793Z" }, { url = "https://files.pythonhosted.org/packages/36/bf/ed70785c496e89d7e73b7cda2d21f2447fd6d4e821714b8d04ff217fed92/cryptography-48.0.1-cp39-abi3-win32.whl", hash = "sha256:6b2c0c3e6ccf3ade7750f836ef3ee36eea250cc467d45c256895573ac08cc6f1", size = 3282307, upload-time = "2026-06-09T22:30:53.162Z" }, { url = "https://files.pythonhosted.org/packages/b3/ff/371ea7d252656ee1eb6d83eeeef3d1d0c6baf1d6497687d081ea03814670/cryptography-48.0.1-cp39-abi3-win_amd64.whl", hash = "sha256:9a49ca6c81417f6a5edb50375a60cccdd70fa0a91a5211829dbea74eba94d2ac", size = 3793408, upload-time = "2026-06-09T22:32:15.191Z" }, ] [[package]] name = "cssselect2" version = "0.9.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "tinycss2" }, { name = "webencodings" }, ] sdist = { url = "https://files.pythonhosted.org/packages/e0/20/92eaa6b0aec7189fa4b75c890640e076e9e793095721db69c5c81142c2e1/cssselect2-0.9.0.tar.gz", hash = "sha256:759aa22c216326356f65e62e791d66160a0f9c91d1424e8d8adc5e74dddfc6fb", size = 35595, upload-time = "2026-02-12T17:16:39.614Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/21/0e/8459ca4413e1a21a06c97d134bfaf18adfd27cea068813dc0faae06cbf00/cssselect2-0.9.0-py3-none-any.whl", hash = "sha256:6a99e5f91f9a016a304dd929b0966ca464bcfda15177b6fb4a118fc0fb5d9563", size = 15453, upload-time = "2026-02-12T17:16:38.317Z" }, ] [[package]] name = "cuda-pathfinder" version = "1.5.4" source = { registry = "https://pypi.org/simple" } wheels = [ { url = "https://files.pythonhosted.org/packages/11/d0/c177e29701cf1d3008d7d2b16b5fc626592ce13bd535f8795c5f57187e0e/cuda_pathfinder-1.5.4-py3-none-any.whl", hash = "sha256:9563d3175ce1828531acf4b94e1c1c7d67208c347ca002493e2654878b26f4b7", size = 51657, upload-time = "2026-04-27T22:42:07.712Z" }, ] [[package]] name = "cupy-cuda12x" version = "14.1.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "cuda-pathfinder" }, { name = "numpy" }, ] wheels = [ { url = "https://files.pythonhosted.org/packages/a3/6e/290ee2d7cc4ad63d66e67acfd7ff3026f2b648dd04449a1bf88ffaa36b1e/cupy_cuda12x-14.1.1-cp312-cp312-manylinux2014_aarch64.whl", hash = "sha256:7aae7d3bed37985e2aa39f0914b88ad90dbd3a6141d3e8198d73fce65859013c", size = 144383812, upload-time = "2026-06-01T04:52:23.799Z" }, { url = "https://files.pythonhosted.org/packages/f6/6e/dc03c1ddc940f33b3d32803898e2fdae5c9538a2127a25f499494c84b183/cupy_cuda12x-14.1.1-cp312-cp312-manylinux2014_x86_64.whl", hash = "sha256:a1138f20080489a46209291498cd12f792226d0a57d50c64a586c162a875a069", size = 133516927, upload-time = "2026-06-01T04:52:35.765Z" }, { url = "https://files.pythonhosted.org/packages/cc/da/d4a8045b533af634bc791572e8c87981065e4a27b5d3e09d0d4d285742fd/cupy_cuda12x-14.1.1-cp312-cp312-win_amd64.whl", hash = "sha256:85bebce86ffc25ecf31727b25da7b3793daf07b6fd9952704546af574d250988", size = 95238722, upload-time = "2026-06-01T04:52:46.296Z" }, { url = "https://files.pythonhosted.org/packages/30/90/00fe874c47207b26c9b6ac950d0cecc533b4a145491641932df17e573f3c/cupy_cuda12x-14.1.1-cp313-cp313-manylinux2014_aarch64.whl", hash = "sha256:afbb3d1fa9484b0ae20d76372c5939a8c5da327e3fc8711b77b2354566cac355", size = 143920086, upload-time = "2026-06-01T04:52:51.726Z" }, { url = "https://files.pythonhosted.org/packages/89/a4/c46ff91dba0dbe2a0a557974faf4c090a3159d6e7296431ca6846038d047/cupy_cuda12x-14.1.1-cp313-cp313-manylinux2014_x86_64.whl", hash = "sha256:76ea35469e2aa0a8332b88f72505ea2f7871a0bc8f9b0c87184f57e47c9aa3bf", size = 133071615, upload-time = "2026-06-01T04:52:57.428Z" }, { url = "https://files.pythonhosted.org/packages/ec/a0/46778424035ad3fc920d49471f079687a054f74d179142e9520014c2514e/cupy_cuda12x-14.1.1-cp313-cp313-win_amd64.whl", hash = "sha256:64072f4139b44df38215f0519a6badc14138fa0e4bb5b2db44fe94d05f8b9c8b", size = 95219598, upload-time = "2026-06-01T04:53:02.774Z" }, { url = "https://files.pythonhosted.org/packages/b6/99/d72336481264c3483b162ea128d58f80abb50009f1df82ca82905e0b8fd7/cupy_cuda12x-14.1.1-cp314-cp314-manylinux2014_aarch64.whl", hash = "sha256:22d0ff2755a7f29cb225d1d5fb979a73428c5534ea0bca91b0c02698e9948f84", size = 143788629, upload-time = "2026-06-01T04:53:09.404Z" }, { url = "https://files.pythonhosted.org/packages/c7/77/c43a67e6809e03780d88caf690fa44a8b3152db2d8f848714bec327c9881/cupy_cuda12x-14.1.1-cp314-cp314-manylinux2014_x86_64.whl", hash = "sha256:1059581507343e7cf6231facce30932a195c7aad4fa7771d00e4a252683915a1", size = 132406367, upload-time = "2026-06-01T04:53:16.232Z" }, { url = "https://files.pythonhosted.org/packages/7d/dc/96cd37de6da41239e02fc7f17e3364d60f99bd6816673d622916a06113ec/cupy_cuda12x-14.1.1-cp314-cp314-win_amd64.whl", hash = "sha256:e707e0eceee174d323be21652e87bb97be982e6966b5dc241756307df42842aa", size = 95793971, upload-time = "2026-06-01T04:53:21.478Z" }, { url = "https://files.pythonhosted.org/packages/20/c6/0ddec1be851de546e883ae3da5f03c1ea69738628b38234dce4362b5e38b/cupy_cuda12x-14.1.1-cp314-cp314t-manylinux2014_aarch64.whl", hash = "sha256:e09897636b7468a90efa1152109f0b19ba49ebc9a423d5dbd4682ed589e57843", size = 144093057, upload-time = "2026-06-01T04:53:28.647Z" }, { url = "https://files.pythonhosted.org/packages/a4/80/5e05de89ba61df072aab6f8a6ee3ffeec57db68a0a456825b3b4ce608426/cupy_cuda12x-14.1.1-cp314-cp314t-manylinux2014_x86_64.whl", hash = "sha256:238080487174268d0f09770fe518de7c5b206527bef5c6792aef7ba0626a1c48", size = 132635338, upload-time = "2026-06-01T04:53:35.229Z" }, ] [[package]] name = "defusedxml" version = "0.7.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/0f/d5/c66da9b79e5bdb124974bfe172b4daf3c984ebd9c2a06e2b8a4dc7331c72/defusedxml-0.7.1.tar.gz", hash = "sha256:1bb3032db185915b62d7c6209c5a8792be6a32ab2fedacc84e01b52c51aa3e69", size = 75520, upload-time = "2021-03-08T10:59:26.269Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/07/6c/aa3f2f849e01cb6a001cd8554a88d4c77c5c1a31c95bdf1cf9301e6d9ef4/defusedxml-0.7.1-py2.py3-none-any.whl", hash = "sha256:a352e7e428770286cc899e2542b6cdaedb2b4953ff269a210103ec58f6198a61", size = 25604, upload-time = "2021-03-08T10:59:24.45Z" }, ] [[package]] name = "docker" version = "7.1.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pywin32", marker = "sys_platform == 'win32'" }, { name = "requests" }, { name = "urllib3" }, ] sdist = { url = "https://files.pythonhosted.org/packages/91/9b/4a2ea29aeba62471211598dac5d96825bb49348fa07e906ea930394a83ce/docker-7.1.0.tar.gz", hash = "sha256:ad8c70e6e3f8926cb8a92619b832b4ea5299e2831c14284663184e200546fa6c", size = 117834, upload-time = "2024-05-23T11:13:57.216Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e3/26/57c6fb270950d476074c087527a558ccb6f4436657314bfb6cdf484114c4/docker-7.1.0-py3-none-any.whl", hash = "sha256:c96b93b7f0a746f9e77d325bcfb87422a3d8bd4f03136ae8a85b37f1898d5fc0", size = 147774, upload-time = "2024-05-23T11:13:55.01Z" }, ] [[package]] name = "docutils" version = "0.22.4" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/ae/b6/03bb70946330e88ffec97aefd3ea75ba575cb2e762061e0e62a213befee8/docutils-0.22.4.tar.gz", hash = "sha256:4db53b1fde9abecbb74d91230d32ab626d94f6badfc575d6db9194a49df29968", size = 2291750, upload-time = "2025-12-18T19:00:26.443Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/02/10/5da547df7a391dcde17f59520a231527b8571e6f46fc8efb02ccb370ab12/docutils-0.22.4-py3-none-any.whl", hash = "sha256:d0013f540772d1420576855455d050a2180186c91c15779301ac2ccb3eeb68de", size = 633196, upload-time = "2025-12-18T19:00:18.077Z" }, ] [[package]] name = "donfig" version = "0.8.1.post1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pyyaml" }, ] sdist = { url = "https://files.pythonhosted.org/packages/25/71/80cc718ff6d7abfbabacb1f57aaa42e9c1552bfdd01e64ddd704e4a03638/donfig-0.8.1.post1.tar.gz", hash = "sha256:3bef3413a4c1c601b585e8d297256d0c1470ea012afa6e8461dc28bfb7c23f52", size = 19506, upload-time = "2024-05-23T14:14:31.513Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0c/d5/c5db1ea3394c6e1732fb3286b3bd878b59507a8f77d32a2cebda7d7b7cd4/donfig-0.8.1.post1-py3-none-any.whl", hash = "sha256:2a3175ce74a06109ff9307d90a230f81215cbac9a751f4d1c6194644b8204f9d", size = 21592, upload-time = "2024-05-23T14:13:55.283Z" }, ] [[package]] name = "execnet" version = "2.1.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/bf/89/780e11f9588d9e7128a3f87788354c7946a9cbb1401ad38a48c4db9a4f07/execnet-2.1.2.tar.gz", hash = "sha256:63d83bfdd9a23e35b9c6a3261412324f964c2ec8dcd8d3c6916ee9373e0befcd", size = 166622, upload-time = "2025-11-12T09:56:37.75Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ab/84/02fc1827e8cdded4aa65baef11296a9bbe595c474f0d6d758af082d849fd/execnet-2.1.2-py3-none-any.whl", hash = "sha256:67fba928dd5a544b783f6056f449e5e3931a5c378b128bc18501f7ea79e296ec", size = 40708, upload-time = "2025-11-12T09:56:36.333Z" }, ] [[package]] name = "flask" version = "3.1.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "blinker" }, { name = "click" }, { name = "itsdangerous" }, { name = "jinja2" }, { name = "markupsafe" }, { name = "werkzeug" }, ] sdist = { url = "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302a175ea360f62533f12b27e2b/flask-3.1.3.tar.gz", hash = "sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", size = 759004, upload-time = "2026-02-19T05:00:57.678Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/7f/9c/34f6962f9b9e9c71f6e5ed806e0d0ff03c9d1b0b2340088a0cf4bce09b18/flask-3.1.3-py3-none-any.whl", hash = "sha256:f4bcbefc124291925f1a26446da31a5178f9483862233b23c0c96a20701f670c", size = 103424, upload-time = "2026-02-19T05:00:56.027Z" }, ] [[package]] name = "flask-cors" version = "6.0.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "flask" }, { name = "werkzeug" }, ] sdist = { url = "https://files.pythonhosted.org/packages/70/74/0fc0fa68d62f21daef41017dafab19ef4b36551521260987eb3a5394c7ba/flask_cors-6.0.2.tar.gz", hash = "sha256:6e118f3698249ae33e429760db98ce032a8bf9913638d085ca0f4c5534ad2423", size = 13472, upload-time = "2025-12-12T20:31:42.861Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/4f/af/72ad54402e599152de6d067324c46fe6a4f531c7c65baf7e96c63db55eaf/flask_cors-6.0.2-py3-none-any.whl", hash = "sha256:e57544d415dfd7da89a9564e1e3a9e515042df76e12130641ca6f3f2f03b699a", size = 13257, upload-time = "2025-12-12T20:31:41.3Z" }, ] [[package]] name = "frozenlist" version = "1.8.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/2d/f5/c831fac6cc817d26fd54c7eaccd04ef7e0288806943f7cc5bbf69f3ac1f0/frozenlist-1.8.0.tar.gz", hash = "sha256:3ede829ed8d842f6cd48fc7081d7a41001a56f1f38603f9d49bf3020d59a31ad", size = 45875, upload-time = "2025-10-06T05:38:17.865Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/69/29/948b9aa87e75820a38650af445d2ef2b6b8a6fab1a23b6bb9e4ef0be2d59/frozenlist-1.8.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:78f7b9e5d6f2fdb88cdde9440dc147259b62b9d3b019924def9f6478be254ac1", size = 87782, upload-time = "2025-10-06T05:36:06.649Z" }, { url = "https://files.pythonhosted.org/packages/64/80/4f6e318ee2a7c0750ed724fa33a4bdf1eacdc5a39a7a24e818a773cd91af/frozenlist-1.8.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:229bf37d2e4acdaf808fd3f06e854a4a7a3661e871b10dc1f8f1896a3b05f18b", size = 50594, upload-time = "2025-10-06T05:36:07.69Z" }, { url = "https://files.pythonhosted.org/packages/2b/94/5c8a2b50a496b11dd519f4a24cb5496cf125681dd99e94c604ccdea9419a/frozenlist-1.8.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f833670942247a14eafbb675458b4e61c82e002a148f49e68257b79296e865c4", size = 50448, upload-time = "2025-10-06T05:36:08.78Z" }, { url = "https://files.pythonhosted.org/packages/6a/bd/d91c5e39f490a49df14320f4e8c80161cfcce09f1e2cde1edd16a551abb3/frozenlist-1.8.0-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:494a5952b1c597ba44e0e78113a7266e656b9794eec897b19ead706bd7074383", size = 242411, upload-time = "2025-10-06T05:36:09.801Z" }, { url = "https://files.pythonhosted.org/packages/8f/83/f61505a05109ef3293dfb1ff594d13d64a2324ac3482be2cedc2be818256/frozenlist-1.8.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:96f423a119f4777a4a056b66ce11527366a8bb92f54e541ade21f2374433f6d4", size = 243014, upload-time = "2025-10-06T05:36:11.394Z" }, { url = "https://files.pythonhosted.org/packages/d8/cb/cb6c7b0f7d4023ddda30cf56b8b17494eb3a79e3fda666bf735f63118b35/frozenlist-1.8.0-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:3462dd9475af2025c31cc61be6652dfa25cbfb56cbbf52f4ccfe029f38decaf8", size = 234909, upload-time = "2025-10-06T05:36:12.598Z" }, { url = "https://files.pythonhosted.org/packages/31/c5/cd7a1f3b8b34af009fb17d4123c5a778b44ae2804e3ad6b86204255f9ec5/frozenlist-1.8.0-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:c4c800524c9cd9bac5166cd6f55285957fcfc907db323e193f2afcd4d9abd69b", size = 250049, upload-time = "2025-10-06T05:36:14.065Z" }, { url = "https://files.pythonhosted.org/packages/c0/01/2f95d3b416c584a1e7f0e1d6d31998c4a795f7544069ee2e0962a4b60740/frozenlist-1.8.0-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:d6a5df73acd3399d893dafc71663ad22534b5aa4f94e8a2fabfe856c3c1b6a52", size = 256485, upload-time = "2025-10-06T05:36:15.39Z" }, { url = "https://files.pythonhosted.org/packages/ce/03/024bf7720b3abaebcff6d0793d73c154237b85bdf67b7ed55e5e9596dc9a/frozenlist-1.8.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:405e8fe955c2280ce66428b3ca55e12b3c4e9c336fb2103a4937e891c69a4a29", size = 237619, upload-time = "2025-10-06T05:36:16.558Z" }, { url = "https://files.pythonhosted.org/packages/69/fa/f8abdfe7d76b731f5d8bd217827cf6764d4f1d9763407e42717b4bed50a0/frozenlist-1.8.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:908bd3f6439f2fef9e85031b59fd4f1297af54415fb60e4254a95f75b3cab3f3", size = 250320, upload-time = "2025-10-06T05:36:17.821Z" }, { url = "https://files.pythonhosted.org/packages/f5/3c/b051329f718b463b22613e269ad72138cc256c540f78a6de89452803a47d/frozenlist-1.8.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:294e487f9ec720bd8ffcebc99d575f7eff3568a08a253d1ee1a0378754b74143", size = 246820, upload-time = "2025-10-06T05:36:19.046Z" }, { url = "https://files.pythonhosted.org/packages/0f/ae/58282e8f98e444b3f4dd42448ff36fa38bef29e40d40f330b22e7108f565/frozenlist-1.8.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:74c51543498289c0c43656701be6b077f4b265868fa7f8a8859c197006efb608", size = 250518, upload-time = "2025-10-06T05:36:20.763Z" }, { url = "https://files.pythonhosted.org/packages/8f/96/007e5944694d66123183845a106547a15944fbbb7154788cbf7272789536/frozenlist-1.8.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:776f352e8329135506a1d6bf16ac3f87bc25b28e765949282dcc627af36123aa", size = 239096, upload-time = "2025-10-06T05:36:22.129Z" }, { url = "https://files.pythonhosted.org/packages/66/bb/852b9d6db2fa40be96f29c0d1205c306288f0684df8fd26ca1951d461a56/frozenlist-1.8.0-cp312-cp312-win32.whl", hash = "sha256:433403ae80709741ce34038da08511d4a77062aa924baf411ef73d1146e74faf", size = 39985, upload-time = "2025-10-06T05:36:23.661Z" }, { url = "https://files.pythonhosted.org/packages/b8/af/38e51a553dd66eb064cdf193841f16f077585d4d28394c2fa6235cb41765/frozenlist-1.8.0-cp312-cp312-win_amd64.whl", hash = "sha256:34187385b08f866104f0c0617404c8eb08165ab1272e884abc89c112e9c00746", size = 44591, upload-time = "2025-10-06T05:36:24.958Z" }, { url = "https://files.pythonhosted.org/packages/a7/06/1dc65480ab147339fecc70797e9c2f69d9cea9cf38934ce08df070fdb9cb/frozenlist-1.8.0-cp312-cp312-win_arm64.whl", hash = "sha256:fe3c58d2f5db5fbd18c2987cba06d51b0529f52bc3a6cdc33d3f4eab725104bd", size = 40102, upload-time = "2025-10-06T05:36:26.333Z" }, { url = "https://files.pythonhosted.org/packages/2d/40/0832c31a37d60f60ed79e9dfb5a92e1e2af4f40a16a29abcc7992af9edff/frozenlist-1.8.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:8d92f1a84bb12d9e56f818b3a746f3efba93c1b63c8387a73dde655e1e42282a", size = 85717, upload-time = "2025-10-06T05:36:27.341Z" }, { url = "https://files.pythonhosted.org/packages/30/ba/b0b3de23f40bc55a7057bd38434e25c34fa48e17f20ee273bbde5e0650f3/frozenlist-1.8.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:96153e77a591c8adc2ee805756c61f59fef4cf4073a9275ee86fe8cba41241f7", size = 49651, upload-time = "2025-10-06T05:36:28.855Z" }, { url = "https://files.pythonhosted.org/packages/0c/ab/6e5080ee374f875296c4243c381bbdef97a9ac39c6e3ce1d5f7d42cb78d6/frozenlist-1.8.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:f21f00a91358803399890ab167098c131ec2ddd5f8f5fd5fe9c9f2c6fcd91e40", size = 49417, upload-time = "2025-10-06T05:36:29.877Z" }, { url = "https://files.pythonhosted.org/packages/d5/4e/e4691508f9477ce67da2015d8c00acd751e6287739123113a9fca6f1604e/frozenlist-1.8.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:fb30f9626572a76dfe4293c7194a09fb1fe93ba94c7d4f720dfae3b646b45027", size = 234391, upload-time = "2025-10-06T05:36:31.301Z" }, { url = "https://files.pythonhosted.org/packages/40/76/c202df58e3acdf12969a7895fd6f3bc016c642e6726aa63bd3025e0fc71c/frozenlist-1.8.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:eaa352d7047a31d87dafcacbabe89df0aa506abb5b1b85a2fb91bc3faa02d822", size = 233048, upload-time = "2025-10-06T05:36:32.531Z" }, { url = "https://files.pythonhosted.org/packages/f9/c0/8746afb90f17b73ca5979c7a3958116e105ff796e718575175319b5bb4ce/frozenlist-1.8.0-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:03ae967b4e297f58f8c774c7eabcce57fe3c2434817d4385c50661845a058121", size = 226549, upload-time = "2025-10-06T05:36:33.706Z" }, { url = "https://files.pythonhosted.org/packages/7e/eb/4c7eefc718ff72f9b6c4893291abaae5fbc0c82226a32dcd8ef4f7a5dbef/frozenlist-1.8.0-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f6292f1de555ffcc675941d65fffffb0a5bcd992905015f85d0592201793e0e5", size = 239833, upload-time = "2025-10-06T05:36:34.947Z" }, { url = "https://files.pythonhosted.org/packages/c2/4e/e5c02187cf704224f8b21bee886f3d713ca379535f16893233b9d672ea71/frozenlist-1.8.0-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:29548f9b5b5e3460ce7378144c3010363d8035cea44bc0bf02d57f5a685e084e", size = 245363, upload-time = "2025-10-06T05:36:36.534Z" }, { url = "https://files.pythonhosted.org/packages/1f/96/cb85ec608464472e82ad37a17f844889c36100eed57bea094518bf270692/frozenlist-1.8.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ec3cc8c5d4084591b4237c0a272cc4f50a5b03396a47d9caaf76f5d7b38a4f11", size = 229314, upload-time = "2025-10-06T05:36:38.582Z" }, { url = "https://files.pythonhosted.org/packages/5d/6f/4ae69c550e4cee66b57887daeebe006fe985917c01d0fff9caab9883f6d0/frozenlist-1.8.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:517279f58009d0b1f2e7c1b130b377a349405da3f7621ed6bfae50b10adf20c1", size = 243365, upload-time = "2025-10-06T05:36:40.152Z" }, { url = "https://files.pythonhosted.org/packages/7a/58/afd56de246cf11780a40a2c28dc7cbabbf06337cc8ddb1c780a2d97e88d8/frozenlist-1.8.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:db1e72ede2d0d7ccb213f218df6a078a9c09a7de257c2fe8fcef16d5925230b1", size = 237763, upload-time = "2025-10-06T05:36:41.355Z" }, { url = "https://files.pythonhosted.org/packages/cb/36/cdfaf6ed42e2644740d4a10452d8e97fa1c062e2a8006e4b09f1b5fd7d63/frozenlist-1.8.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:b4dec9482a65c54a5044486847b8a66bf10c9cb4926d42927ec4e8fd5db7fed8", size = 240110, upload-time = "2025-10-06T05:36:42.716Z" }, { url = "https://files.pythonhosted.org/packages/03/a8/9ea226fbefad669f11b52e864c55f0bd57d3c8d7eb07e9f2e9a0b39502e1/frozenlist-1.8.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:21900c48ae04d13d416f0e1e0c4d81f7931f73a9dfa0b7a8746fb2fe7dd970ed", size = 233717, upload-time = "2025-10-06T05:36:44.251Z" }, { url = "https://files.pythonhosted.org/packages/1e/0b/1b5531611e83ba7d13ccc9988967ea1b51186af64c42b7a7af465dcc9568/frozenlist-1.8.0-cp313-cp313-win32.whl", hash = "sha256:8b7b94a067d1c504ee0b16def57ad5738701e4ba10cec90529f13fa03c833496", size = 39628, upload-time = "2025-10-06T05:36:45.423Z" }, { url = "https://files.pythonhosted.org/packages/d8/cf/174c91dbc9cc49bc7b7aab74d8b734e974d1faa8f191c74af9b7e80848e6/frozenlist-1.8.0-cp313-cp313-win_amd64.whl", hash = "sha256:878be833caa6a3821caf85eb39c5ba92d28e85df26d57afb06b35b2efd937231", size = 43882, upload-time = "2025-10-06T05:36:46.796Z" }, { url = "https://files.pythonhosted.org/packages/c1/17/502cd212cbfa96eb1388614fe39a3fc9ab87dbbe042b66f97acb57474834/frozenlist-1.8.0-cp313-cp313-win_arm64.whl", hash = "sha256:44389d135b3ff43ba8cc89ff7f51f5a0bb6b63d829c8300f79a2fe4fe61bcc62", size = 39676, upload-time = "2025-10-06T05:36:47.8Z" }, { url = "https://files.pythonhosted.org/packages/d2/5c/3bbfaa920dfab09e76946a5d2833a7cbdf7b9b4a91c714666ac4855b88b4/frozenlist-1.8.0-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:e25ac20a2ef37e91c1b39938b591457666a0fa835c7783c3a8f33ea42870db94", size = 89235, upload-time = "2025-10-06T05:36:48.78Z" }, { url = "https://files.pythonhosted.org/packages/d2/d6/f03961ef72166cec1687e84e8925838442b615bd0b8854b54923ce5b7b8a/frozenlist-1.8.0-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:07cdca25a91a4386d2e76ad992916a85038a9b97561bf7a3fd12d5d9ce31870c", size = 50742, upload-time = "2025-10-06T05:36:49.837Z" }, { url = "https://files.pythonhosted.org/packages/1e/bb/a6d12b7ba4c3337667d0e421f7181c82dda448ce4e7ad7ecd249a16fa806/frozenlist-1.8.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:4e0c11f2cc6717e0a741f84a527c52616140741cd812a50422f83dc31749fb52", size = 51725, upload-time = "2025-10-06T05:36:50.851Z" }, { url = "https://files.pythonhosted.org/packages/bc/71/d1fed0ffe2c2ccd70b43714c6cab0f4188f09f8a67a7914a6b46ee30f274/frozenlist-1.8.0-cp313-cp313t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:b3210649ee28062ea6099cfda39e147fa1bc039583c8ee4481cb7811e2448c51", size = 284533, upload-time = "2025-10-06T05:36:51.898Z" }, { url = "https://files.pythonhosted.org/packages/c9/1f/fb1685a7b009d89f9bf78a42d94461bc06581f6e718c39344754a5d9bada/frozenlist-1.8.0-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:581ef5194c48035a7de2aefc72ac6539823bb71508189e5de01d60c9dcd5fa65", size = 292506, upload-time = "2025-10-06T05:36:53.101Z" }, { url = "https://files.pythonhosted.org/packages/e6/3b/b991fe1612703f7e0d05c0cf734c1b77aaf7c7d321df4572e8d36e7048c8/frozenlist-1.8.0-cp313-cp313t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:3ef2d026f16a2b1866e1d86fc4e1291e1ed8a387b2c333809419a2f8b3a77b82", size = 274161, upload-time = "2025-10-06T05:36:54.309Z" }, { url = "https://files.pythonhosted.org/packages/ca/ec/c5c618767bcdf66e88945ec0157d7f6c4a1322f1473392319b7a2501ded7/frozenlist-1.8.0-cp313-cp313t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:5500ef82073f599ac84d888e3a8c1f77ac831183244bfd7f11eaa0289fb30714", size = 294676, upload-time = "2025-10-06T05:36:55.566Z" }, { url = "https://files.pythonhosted.org/packages/7c/ce/3934758637d8f8a88d11f0585d6495ef54b2044ed6ec84492a91fa3b27aa/frozenlist-1.8.0-cp313-cp313t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:50066c3997d0091c411a66e710f4e11752251e6d2d73d70d8d5d4c76442a199d", size = 300638, upload-time = "2025-10-06T05:36:56.758Z" }, { url = "https://files.pythonhosted.org/packages/fc/4f/a7e4d0d467298f42de4b41cbc7ddaf19d3cfeabaf9ff97c20c6c7ee409f9/frozenlist-1.8.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:5c1c8e78426e59b3f8005e9b19f6ff46e5845895adbde20ece9218319eca6506", size = 283067, upload-time = "2025-10-06T05:36:57.965Z" }, { url = "https://files.pythonhosted.org/packages/dc/48/c7b163063d55a83772b268e6d1affb960771b0e203b632cfe09522d67ea5/frozenlist-1.8.0-cp313-cp313t-musllinux_1_2_armv7l.whl", hash = "sha256:eefdba20de0d938cec6a89bd4d70f346a03108a19b9df4248d3cf0d88f1b0f51", size = 292101, upload-time = "2025-10-06T05:36:59.237Z" }, { url = "https://files.pythonhosted.org/packages/9f/d0/2366d3c4ecdc2fd391e0afa6e11500bfba0ea772764d631bbf82f0136c9d/frozenlist-1.8.0-cp313-cp313t-musllinux_1_2_ppc64le.whl", hash = "sha256:cf253e0e1c3ceb4aaff6df637ce033ff6535fb8c70a764a8f46aafd3d6ab798e", size = 289901, upload-time = "2025-10-06T05:37:00.811Z" }, { url = "https://files.pythonhosted.org/packages/b8/94/daff920e82c1b70e3618a2ac39fbc01ae3e2ff6124e80739ce5d71c9b920/frozenlist-1.8.0-cp313-cp313t-musllinux_1_2_s390x.whl", hash = "sha256:032efa2674356903cd0261c4317a561a6850f3ac864a63fc1583147fb05a79b0", size = 289395, upload-time = "2025-10-06T05:37:02.115Z" }, { url = "https://files.pythonhosted.org/packages/e3/20/bba307ab4235a09fdcd3cc5508dbabd17c4634a1af4b96e0f69bfe551ebd/frozenlist-1.8.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:6da155091429aeba16851ecb10a9104a108bcd32f6c1642867eadaee401c1c41", size = 283659, upload-time = "2025-10-06T05:37:03.711Z" }, { url = "https://files.pythonhosted.org/packages/fd/00/04ca1c3a7a124b6de4f8a9a17cc2fcad138b4608e7a3fc5877804b8715d7/frozenlist-1.8.0-cp313-cp313t-win32.whl", hash = "sha256:0f96534f8bfebc1a394209427d0f8a63d343c9779cda6fc25e8e121b5fd8555b", size = 43492, upload-time = "2025-10-06T05:37:04.915Z" }, { url = "https://files.pythonhosted.org/packages/59/5e/c69f733a86a94ab10f68e496dc6b7e8bc078ebb415281d5698313e3af3a1/frozenlist-1.8.0-cp313-cp313t-win_amd64.whl", hash = "sha256:5d63a068f978fc69421fb0e6eb91a9603187527c86b7cd3f534a5b77a592b888", size = 48034, upload-time = "2025-10-06T05:37:06.343Z" }, { url = "https://files.pythonhosted.org/packages/16/6c/be9d79775d8abe79b05fa6d23da99ad6e7763a1d080fbae7290b286093fd/frozenlist-1.8.0-cp313-cp313t-win_arm64.whl", hash = "sha256:bf0a7e10b077bf5fb9380ad3ae8ce20ef919a6ad93b4552896419ac7e1d8e042", size = 41749, upload-time = "2025-10-06T05:37:07.431Z" }, { url = "https://files.pythonhosted.org/packages/f1/c8/85da824b7e7b9b6e7f7705b2ecaf9591ba6f79c1177f324c2735e41d36a2/frozenlist-1.8.0-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:cee686f1f4cadeb2136007ddedd0aaf928ab95216e7691c63e50a8ec066336d0", size = 86127, upload-time = "2025-10-06T05:37:08.438Z" }, { url = "https://files.pythonhosted.org/packages/8e/e8/a1185e236ec66c20afd72399522f142c3724c785789255202d27ae992818/frozenlist-1.8.0-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:119fb2a1bd47307e899c2fac7f28e85b9a543864df47aa7ec9d3c1b4545f096f", size = 49698, upload-time = "2025-10-06T05:37:09.48Z" }, { url = "https://files.pythonhosted.org/packages/a1/93/72b1736d68f03fda5fdf0f2180fb6caaae3894f1b854d006ac61ecc727ee/frozenlist-1.8.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:4970ece02dbc8c3a92fcc5228e36a3e933a01a999f7094ff7c23fbd2beeaa67c", size = 49749, upload-time = "2025-10-06T05:37:10.569Z" }, { url = "https://files.pythonhosted.org/packages/a7/b2/fabede9fafd976b991e9f1b9c8c873ed86f202889b864756f240ce6dd855/frozenlist-1.8.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:cba69cb73723c3f329622e34bdbf5ce1f80c21c290ff04256cff1cd3c2036ed2", size = 231298, upload-time = "2025-10-06T05:37:11.993Z" }, { url = "https://files.pythonhosted.org/packages/3a/3b/d9b1e0b0eed36e70477ffb8360c49c85c8ca8ef9700a4e6711f39a6e8b45/frozenlist-1.8.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:778a11b15673f6f1df23d9586f83c4846c471a8af693a22e066508b77d201ec8", size = 232015, upload-time = "2025-10-06T05:37:13.194Z" }, { url = "https://files.pythonhosted.org/packages/dc/94/be719d2766c1138148564a3960fc2c06eb688da592bdc25adcf856101be7/frozenlist-1.8.0-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:0325024fe97f94c41c08872db482cf8ac4800d80e79222c6b0b7b162d5b13686", size = 225038, upload-time = "2025-10-06T05:37:14.577Z" }, { url = "https://files.pythonhosted.org/packages/e4/09/6712b6c5465f083f52f50cf74167b92d4ea2f50e46a9eea0523d658454ae/frozenlist-1.8.0-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:97260ff46b207a82a7567b581ab4190bd4dfa09f4db8a8b49d1a958f6aa4940e", size = 240130, upload-time = "2025-10-06T05:37:15.781Z" }, { url = "https://files.pythonhosted.org/packages/f8/d4/cd065cdcf21550b54f3ce6a22e143ac9e4836ca42a0de1022da8498eac89/frozenlist-1.8.0-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:54b2077180eb7f83dd52c40b2750d0a9f175e06a42e3213ce047219de902717a", size = 242845, upload-time = "2025-10-06T05:37:17.037Z" }, { url = "https://files.pythonhosted.org/packages/62/c3/f57a5c8c70cd1ead3d5d5f776f89d33110b1addae0ab010ad774d9a44fb9/frozenlist-1.8.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:2f05983daecab868a31e1da44462873306d3cbfd76d1f0b5b69c473d21dbb128", size = 229131, upload-time = "2025-10-06T05:37:18.221Z" }, { url = "https://files.pythonhosted.org/packages/6c/52/232476fe9cb64f0742f3fde2b7d26c1dac18b6d62071c74d4ded55e0ef94/frozenlist-1.8.0-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:33f48f51a446114bc5d251fb2954ab0164d5be02ad3382abcbfe07e2531d650f", size = 240542, upload-time = "2025-10-06T05:37:19.771Z" }, { url = "https://files.pythonhosted.org/packages/5f/85/07bf3f5d0fb5414aee5f47d33c6f5c77bfe49aac680bfece33d4fdf6a246/frozenlist-1.8.0-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:154e55ec0655291b5dd1b8731c637ecdb50975a2ae70c606d100750a540082f7", size = 237308, upload-time = "2025-10-06T05:37:20.969Z" }, { url = "https://files.pythonhosted.org/packages/11/99/ae3a33d5befd41ac0ca2cc7fd3aa707c9c324de2e89db0e0f45db9a64c26/frozenlist-1.8.0-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:4314debad13beb564b708b4a496020e5306c7333fa9a3ab90374169a20ffab30", size = 238210, upload-time = "2025-10-06T05:37:22.252Z" }, { url = "https://files.pythonhosted.org/packages/b2/60/b1d2da22f4970e7a155f0adde9b1435712ece01b3cd45ba63702aea33938/frozenlist-1.8.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:073f8bf8becba60aa931eb3bc420b217bb7d5b8f4750e6f8b3be7f3da85d38b7", size = 231972, upload-time = "2025-10-06T05:37:23.5Z" }, { url = "https://files.pythonhosted.org/packages/3f/ab/945b2f32de889993b9c9133216c068b7fcf257d8595a0ac420ac8677cab0/frozenlist-1.8.0-cp314-cp314-win32.whl", hash = "sha256:bac9c42ba2ac65ddc115d930c78d24ab8d4f465fd3fc473cdedfccadb9429806", size = 40536, upload-time = "2025-10-06T05:37:25.581Z" }, { url = "https://files.pythonhosted.org/packages/59/ad/9caa9b9c836d9ad6f067157a531ac48b7d36499f5036d4141ce78c230b1b/frozenlist-1.8.0-cp314-cp314-win_amd64.whl", hash = "sha256:3e0761f4d1a44f1d1a47996511752cf3dcec5bbdd9cc2b4fe595caf97754b7a0", size = 44330, upload-time = "2025-10-06T05:37:26.928Z" }, { url = "https://files.pythonhosted.org/packages/82/13/e6950121764f2676f43534c555249f57030150260aee9dcf7d64efda11dd/frozenlist-1.8.0-cp314-cp314-win_arm64.whl", hash = "sha256:d1eaff1d00c7751b7c6662e9c5ba6eb2c17a2306ba5e2a37f24ddf3cc953402b", size = 40627, upload-time = "2025-10-06T05:37:28.075Z" }, { url = "https://files.pythonhosted.org/packages/c0/c7/43200656ecc4e02d3f8bc248df68256cd9572b3f0017f0a0c4e93440ae23/frozenlist-1.8.0-cp314-cp314t-macosx_10_13_universal2.whl", hash = "sha256:d3bb933317c52d7ea5004a1c442eef86f426886fba134ef8cf4226ea6ee1821d", size = 89238, upload-time = "2025-10-06T05:37:29.373Z" }, { url = "https://files.pythonhosted.org/packages/d1/29/55c5f0689b9c0fb765055629f472c0de484dcaf0acee2f7707266ae3583c/frozenlist-1.8.0-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:8009897cdef112072f93a0efdce29cd819e717fd2f649ee3016efd3cd885a7ed", size = 50738, upload-time = "2025-10-06T05:37:30.792Z" }, { url = "https://files.pythonhosted.org/packages/ba/7d/b7282a445956506fa11da8c2db7d276adcbf2b17d8bb8407a47685263f90/frozenlist-1.8.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:2c5dcbbc55383e5883246d11fd179782a9d07a986c40f49abe89ddf865913930", size = 51739, upload-time = "2025-10-06T05:37:32.127Z" }, { url = "https://files.pythonhosted.org/packages/62/1c/3d8622e60d0b767a5510d1d3cf21065b9db874696a51ea6d7a43180a259c/frozenlist-1.8.0-cp314-cp314t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:39ecbc32f1390387d2aa4f5a995e465e9e2f79ba3adcac92d68e3e0afae6657c", size = 284186, upload-time = "2025-10-06T05:37:33.21Z" }, { url = "https://files.pythonhosted.org/packages/2d/14/aa36d5f85a89679a85a1d44cd7a6657e0b1c75f61e7cad987b203d2daca8/frozenlist-1.8.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:92db2bf818d5cc8d9c1f1fc56b897662e24ea5adb36ad1f1d82875bd64e03c24", size = 292196, upload-time = "2025-10-06T05:37:36.107Z" }, { url = "https://files.pythonhosted.org/packages/05/23/6bde59eb55abd407d34f77d39a5126fb7b4f109a3f611d3929f14b700c66/frozenlist-1.8.0-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:2dc43a022e555de94c3b68a4ef0b11c4f747d12c024a520c7101709a2144fb37", size = 273830, upload-time = "2025-10-06T05:37:37.663Z" }, { url = "https://files.pythonhosted.org/packages/d2/3f/22cff331bfad7a8afa616289000ba793347fcd7bc275f3b28ecea2a27909/frozenlist-1.8.0-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:cb89a7f2de3602cfed448095bab3f178399646ab7c61454315089787df07733a", size = 294289, upload-time = "2025-10-06T05:37:39.261Z" }, { url = "https://files.pythonhosted.org/packages/a4/89/5b057c799de4838b6c69aa82b79705f2027615e01be996d2486a69ca99c4/frozenlist-1.8.0-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:33139dc858c580ea50e7e60a1b0ea003efa1fd42e6ec7fdbad78fff65fad2fd2", size = 300318, upload-time = "2025-10-06T05:37:43.213Z" }, { url = "https://files.pythonhosted.org/packages/30/de/2c22ab3eb2a8af6d69dc799e48455813bab3690c760de58e1bf43b36da3e/frozenlist-1.8.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:168c0969a329b416119507ba30b9ea13688fafffac1b7822802537569a1cb0ef", size = 282814, upload-time = "2025-10-06T05:37:45.337Z" }, { url = "https://files.pythonhosted.org/packages/59/f7/970141a6a8dbd7f556d94977858cfb36fa9b66e0892c6dd780d2219d8cd8/frozenlist-1.8.0-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:28bd570e8e189d7f7b001966435f9dac6718324b5be2990ac496cf1ea9ddb7fe", size = 291762, upload-time = "2025-10-06T05:37:46.657Z" }, { url = "https://files.pythonhosted.org/packages/c1/15/ca1adae83a719f82df9116d66f5bb28bb95557b3951903d39135620ef157/frozenlist-1.8.0-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:b2a095d45c5d46e5e79ba1e5b9cb787f541a8dee0433836cea4b96a2c439dcd8", size = 289470, upload-time = "2025-10-06T05:37:47.946Z" }, { url = "https://files.pythonhosted.org/packages/ac/83/dca6dc53bf657d371fbc88ddeb21b79891e747189c5de990b9dfff2ccba1/frozenlist-1.8.0-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:eab8145831a0d56ec9c4139b6c3e594c7a83c2c8be25d5bcf2d86136a532287a", size = 289042, upload-time = "2025-10-06T05:37:49.499Z" }, { url = "https://files.pythonhosted.org/packages/96/52/abddd34ca99be142f354398700536c5bd315880ed0a213812bc491cff5e4/frozenlist-1.8.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:974b28cf63cc99dfb2188d8d222bc6843656188164848c4f679e63dae4b0708e", size = 283148, upload-time = "2025-10-06T05:37:50.745Z" }, { url = "https://files.pythonhosted.org/packages/af/d3/76bd4ed4317e7119c2b7f57c3f6934aba26d277acc6309f873341640e21f/frozenlist-1.8.0-cp314-cp314t-win32.whl", hash = "sha256:342c97bf697ac5480c0a7ec73cd700ecfa5a8a40ac923bd035484616efecc2df", size = 44676, upload-time = "2025-10-06T05:37:52.222Z" }, { url = "https://files.pythonhosted.org/packages/89/76/c615883b7b521ead2944bb3480398cbb07e12b7b4e4d073d3752eb721558/frozenlist-1.8.0-cp314-cp314t-win_amd64.whl", hash = "sha256:06be8f67f39c8b1dc671f5d83aaefd3358ae5cdcf8314552c57e7ed3e6475bdd", size = 49451, upload-time = "2025-10-06T05:37:53.425Z" }, { url = "https://files.pythonhosted.org/packages/e0/a3/5982da14e113d07b325230f95060e2169f5311b1017ea8af2a29b374c289/frozenlist-1.8.0-cp314-cp314t-win_arm64.whl", hash = "sha256:102e6314ca4da683dca92e3b1355490fed5f313b768500084fbe6371fddfdb79", size = 42507, upload-time = "2025-10-06T05:37:54.513Z" }, { url = "https://files.pythonhosted.org/packages/9a/9a/e35b4a917281c0b8419d4207f4334c8e8c5dbf4f3f5f9ada73958d937dcc/frozenlist-1.8.0-py3-none-any.whl", hash = "sha256:0c18a16eab41e82c295618a77502e17b195883241c563b00f0aa5106fc4eaa0d", size = 13409, upload-time = "2025-10-06T05:38:16.721Z" }, ] [[package]] name = "fsspec" version = "2026.6.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/10/a1/ae4e3e5003468d6391d2c77b6fa1cd73bd5d13511d81c642d7b28ac90ed4/fsspec-2026.6.0.tar.gz", hash = "sha256:f5bac145310fe30e16e1471bd6840b2d990d609e872251d7e674241822abf01a", size = 313646, upload-time = "2026-06-16T01:57:28.105Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e5/22/4222d7ddf3da30f363edaa98e329c2bce6c65497c9cb2810931c8b2c0fbc/fsspec-2026.6.0-py3-none-any.whl", hash = "sha256:02e0b71817df9b2169dc30a16832045764def1191b43dcff5bb85bdee212d2a1", size = 203949, upload-time = "2026-06-16T01:57:26.358Z" }, ] [[package]] name = "ghp-import" version = "2.1.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "python-dateutil" }, ] sdist = { url = "https://files.pythonhosted.org/packages/d9/29/d40217cbe2f6b1359e00c6c307bb3fc876ba74068cbab3dde77f03ca0dc4/ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343", size = 10943, upload-time = "2022-05-02T15:47:16.11Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb/ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", size = 11034, upload-time = "2022-05-02T15:47:14.552Z" }, ] [[package]] name = "google-crc32c" version = "1.8.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/03/41/4b9c02f99e4c5fb477122cd5437403b552873f014616ac1d19ac8221a58d/google_crc32c-1.8.0.tar.gz", hash = "sha256:a428e25fb7691024de47fecfbff7ff957214da51eddded0da0ae0e0f03a2cf79", size = 14192, upload-time = "2025-12-16T00:35:25.142Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e9/5f/7307325b1198b59324c0fa9807cafb551afb65e831699f2ce211ad5c8240/google_crc32c-1.8.0-cp312-cp312-macosx_12_0_arm64.whl", hash = "sha256:4b8286b659c1335172e39563ab0a768b8015e88e08329fa5321f774275fc3113", size = 31300, upload-time = "2025-12-16T00:21:56.723Z" }, { url = "https://files.pythonhosted.org/packages/21/8e/58c0d5d86e2220e6a37befe7e6a94dd2f6006044b1a33edf1ff6d9f7e319/google_crc32c-1.8.0-cp312-cp312-macosx_12_0_x86_64.whl", hash = "sha256:2a3dc3318507de089c5384cc74d54318401410f82aa65b2d9cdde9d297aca7cb", size = 30867, upload-time = "2025-12-16T00:38:31.302Z" }, { url = "https://files.pythonhosted.org/packages/ce/a9/a780cc66f86335a6019f557a8aaca8fbb970728f0efd2430d15ff1beae0e/google_crc32c-1.8.0-cp312-cp312-manylinux1_x86_64.manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:14f87e04d613dfa218d6135e81b78272c3b904e2a7053b841481b38a7d901411", size = 33364, upload-time = "2025-12-16T00:40:22.96Z" }, { url = "https://files.pythonhosted.org/packages/21/3f/3457ea803db0198c9aaca2dd373750972ce28a26f00544b6b85088811939/google_crc32c-1.8.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:cb5c869c2923d56cb0c8e6bcdd73c009c36ae39b652dbe46a05eb4ef0ad01454", size = 33740, upload-time = "2025-12-16T00:40:23.96Z" }, { url = "https://files.pythonhosted.org/packages/df/c0/87c2073e0c72515bb8733d4eef7b21548e8d189f094b5dad20b0ecaf64f6/google_crc32c-1.8.0-cp312-cp312-win_amd64.whl", hash = "sha256:3cc0c8912038065eafa603b238abf252e204accab2a704c63b9e14837a854962", size = 34437, upload-time = "2025-12-16T00:35:21.395Z" }, { url = "https://files.pythonhosted.org/packages/d1/db/000f15b41724589b0e7bc24bc7a8967898d8d3bc8caf64c513d91ef1f6c0/google_crc32c-1.8.0-cp313-cp313-macosx_12_0_arm64.whl", hash = "sha256:3ebb04528e83b2634857f43f9bb8ef5b2bbe7f10f140daeb01b58f972d04736b", size = 31297, upload-time = "2025-12-16T00:23:20.709Z" }, { url = "https://files.pythonhosted.org/packages/d7/0d/8ebed0c39c53a7e838e2a486da8abb0e52de135f1b376ae2f0b160eb4c1a/google_crc32c-1.8.0-cp313-cp313-macosx_12_0_x86_64.whl", hash = "sha256:450dc98429d3e33ed2926fc99ee81001928d63460f8538f21a5d6060912a8e27", size = 30867, upload-time = "2025-12-16T00:43:14.628Z" }, { url = "https://files.pythonhosted.org/packages/ce/42/b468aec74a0354b34c8cbf748db20d6e350a68a2b0912e128cabee49806c/google_crc32c-1.8.0-cp313-cp313-manylinux1_x86_64.manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:3b9776774b24ba76831609ffbabce8cdf6fa2bd5e9df37b594221c7e333a81fa", size = 33344, upload-time = "2025-12-16T00:40:24.742Z" }, { url = "https://files.pythonhosted.org/packages/1c/e8/b33784d6fc77fb5062a8a7854e43e1e618b87d5ddf610a88025e4de6226e/google_crc32c-1.8.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:89c17d53d75562edfff86679244830599ee0a48efc216200691de8b02ab6b2b8", size = 33694, upload-time = "2025-12-16T00:40:25.505Z" }, { url = "https://files.pythonhosted.org/packages/92/b1/d3cbd4d988afb3d8e4db94ca953df429ed6db7282ed0e700d25e6c7bfc8d/google_crc32c-1.8.0-cp313-cp313-win_amd64.whl", hash = "sha256:57a50a9035b75643996fbf224d6661e386c7162d1dfdab9bc4ca790947d1007f", size = 34435, upload-time = "2025-12-16T00:35:22.107Z" }, { url = "https://files.pythonhosted.org/packages/21/88/8ecf3c2b864a490b9e7010c84fd203ec8cf3b280651106a3a74dd1b0ca72/google_crc32c-1.8.0-cp314-cp314-macosx_12_0_arm64.whl", hash = "sha256:e6584b12cb06796d285d09e33f63309a09368b9d806a551d8036a4207ea43697", size = 31301, upload-time = "2025-12-16T00:24:48.527Z" }, { url = "https://files.pythonhosted.org/packages/36/c6/f7ff6c11f5ca215d9f43d3629163727a272eabc356e5c9b2853df2bfe965/google_crc32c-1.8.0-cp314-cp314-macosx_12_0_x86_64.whl", hash = "sha256:f4b51844ef67d6cf2e9425983274da75f18b1597bb2c998e1c0a0e8d46f8f651", size = 30868, upload-time = "2025-12-16T00:48:12.163Z" }, { url = "https://files.pythonhosted.org/packages/56/15/c25671c7aad70f8179d858c55a6ae8404902abe0cdcf32a29d581792b491/google_crc32c-1.8.0-cp314-cp314-manylinux1_x86_64.manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:b0d1a7afc6e8e4635564ba8aa5c0548e3173e41b6384d7711a9123165f582de2", size = 33381, upload-time = "2025-12-16T00:40:26.268Z" }, { url = "https://files.pythonhosted.org/packages/42/fa/f50f51260d7b0ef5d4898af122d8a7ec5a84e2984f676f746445f783705f/google_crc32c-1.8.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:8b3f68782f3cbd1bce027e48768293072813469af6a61a86f6bb4977a4380f21", size = 33734, upload-time = "2025-12-16T00:40:27.028Z" }, { url = "https://files.pythonhosted.org/packages/08/a5/7b059810934a09fb3ccb657e0843813c1fee1183d3bc2c8041800374aa2c/google_crc32c-1.8.0-cp314-cp314-win_amd64.whl", hash = "sha256:d511b3153e7011a27ab6ee6bb3a5404a55b994dc1a7322c0b87b29606d9790e2", size = 34878, upload-time = "2025-12-16T00:35:23.142Z" }, ] [[package]] name = "graphql-core" version = "3.2.8" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/68/c5/36aa96205c3ecbb3d34c7c24189e4553c7ca2ebc7e1dd07432339b980272/graphql_core-3.2.8.tar.gz", hash = "sha256:015457da5d996c924ddf57a43f4e959b0b94fb695b85ed4c29446e508ed65cf3", size = 513181, upload-time = "2026-03-05T19:55:37.332Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/86/41/cb887d9afc5dabd78feefe6ccbaf83ff423c206a7a1b7aeeac05120b2125/graphql_core-3.2.8-py3-none-any.whl", hash = "sha256:cbee07bee1b3ed5e531723685369039f32ff815ef60166686e0162f540f1520c", size = 207349, upload-time = "2026-03-05T19:55:35.911Z" }, ] [[package]] name = "griffe-inherited-docstrings" version = "1.1.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "griffelib" }, ] sdist = { url = "https://files.pythonhosted.org/packages/cb/da/fd002dc5f215cd896bfccaebe8b4aa1cdeed8ea1d9d60633685bd61ff933/griffe_inherited_docstrings-1.1.3.tar.gz", hash = "sha256:cd1f937ec9336a790e5425e7f9b92f5a5ab17f292ba86917f1c681c0704cb64e", size = 26738, upload-time = "2026-02-21T09:38:44.312Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/16/20/4bc15f242181daad1c104e0a7d33be49e712461ea89e548152be0365b9ea/griffe_inherited_docstrings-1.1.3-py3-none-any.whl", hash = "sha256:aa7f6e624515c50d9325a5cfdf4b2acac547f1889aca89092d5da7278f739695", size = 6710, upload-time = "2026-02-20T11:06:38.75Z" }, ] [[package]] name = "griffelib" version = "2.0.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/9d/82/74f4a3310cdabfbb10da554c3a672847f1ed33c6f61dd472681ce7f1fe67/griffelib-2.0.2.tar.gz", hash = "sha256:3cf20b3bc470e83763ffbf236e0076b1211bac1bc67de13daf494640f2de707e", size = 166461, upload-time = "2026-03-27T11:34:51.091Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/11/8c/c9138d881c79aa0ea9ed83cbd58d5ca75624378b38cee225dcf5c42cc91f/griffelib-2.0.2-py3-none-any.whl", hash = "sha256:925c857658fb1ba40c0772c37acbc2ab650bd794d9c1b9726922e36ea4117ea1", size = 142357, upload-time = "2026-03-27T11:34:46.275Z" }, ] [[package]] name = "hypothesis" version = "6.160.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "sortedcontainers" }, ] sdist = { url = "https://files.pythonhosted.org/packages/27/18/824aedbd4117d769862a2722ea2371aa61433a38bfb5355e5dc113b564c2/hypothesis-6.160.0.tar.gz", hash = "sha256:149400acbb7382e2ce6810a52e86a9fd6d4e5c4a47660818abb438cde76aa5d1", size = 485677, upload-time = "2026-07-22T14:12:13.331Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ad/c6/39fa718992b7529d1f68532a3554b9479f27f6a46aa5859c0d909bde0a40/hypothesis-6.160.0-cp310-abi3-macosx_10_12_x86_64.whl", hash = "sha256:69e1511325901fcd570fbd88779882e30cb280aeedd9708093aab4b25f7cdbf5", size = 766096, upload-time = "2026-07-22T14:11:58.283Z" }, { url = "https://files.pythonhosted.org/packages/94/1b/81b54dbf97baa4026034579ce63b56d3d35c0d22b72b032c68e23bbda92b/hypothesis-6.160.0-cp310-abi3-macosx_11_0_arm64.whl", hash = "sha256:1ba0f1dd0f2872b7f7230a3884a0d739917d57262d0e9e3c8ee34b775f95a553", size = 761752, upload-time = "2026-07-22T14:11:42.682Z" }, { url = "https://files.pythonhosted.org/packages/ea/02/fa35cf37fd801d1e952e2168c0b5542f99c77024098f954cd515f2101910/hypothesis-6.160.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3f9116a80ed96060a7fbc8d50cc5e93dec10d72f70f61e9184628dbcba2f9a2f", size = 1090928, upload-time = "2026-07-22T14:12:05.158Z" }, { url = "https://files.pythonhosted.org/packages/a7/35/f2422a4287bbac99d6317a10e7add5f24abe069952c503cb3512e91bebc0/hypothesis-6.160.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:065cfed699889b6c05265ca4f97e8c7bb85800d3d3146f4741b68ef7be1fed18", size = 1140474, upload-time = "2026-07-22T14:11:50.558Z" }, { url = "https://files.pythonhosted.org/packages/bc/ef/7504f31be0c9dfd8c69b1e068564e0c1126a82ab753abcb20c4bacd1544b/hypothesis-6.160.0-cp310-abi3-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:52e0cdc8fcd34b121a213205f239545fec38142014114afc721d1c867ac34834", size = 1132509, upload-time = "2026-07-22T14:11:48.702Z" }, { url = "https://files.pythonhosted.org/packages/b4/39/8c7a5cfc336e0bdd7b7ae1d8807028b2b46c03979a5d82e8992b4ba2b81c/hypothesis-6.160.0-cp310-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:4868821ffba805970441fec1b0635ea123f01aa6b71fc8f2d9550ee782f1ecd7", size = 1264762, upload-time = "2026-07-22T14:10:30.068Z" }, { url = "https://files.pythonhosted.org/packages/ac/00/0d47e996ccbfa1eceb66d285b6fbf248c7c020e4e18b1bea09b18f05f6f5/hypothesis-6.160.0-cp310-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:64cf59670080aeb3c6048d62df0f6352586410745d14d7045a692eb5d2245110", size = 1307495, upload-time = "2026-07-22T14:11:33.978Z" }, { url = "https://files.pythonhosted.org/packages/1a/b8/01f731cfcf9fc475adbde3c328d0c8f1d24952b4dd2a5049e7156aa64d9c/hypothesis-6.160.0-cp310-abi3-win32.whl", hash = "sha256:993c26c81e9cc9f291cdb64f54aa8f31507d2d472d0f1334f8ba9e7d77666911", size = 651991, upload-time = "2026-07-22T14:11:21.375Z" }, { url = "https://files.pythonhosted.org/packages/87/12/95216fe9a84cafc9bc721b4352cf9b78bf0e9089f278811fbd58c76dbe3f/hypothesis-6.160.0-cp310-abi3-win_amd64.whl", hash = "sha256:95a4b0e1faa366d0cc9d7ce261773cec69f4f130b845ca33b71c22c85493c35d", size = 658114, upload-time = "2026-07-22T14:10:54.298Z" }, { url = "https://files.pythonhosted.org/packages/81/b2/bc800c4925c1f47b61c17f78e57bb58a8743d03da28de13f59cba148daf2/hypothesis-6.160.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:18e058b34f4514da8b2ce15ebee9e6e98d3a95067665accf394415824934f790", size = 767730, upload-time = "2026-07-22T14:11:56.44Z" }, { url = "https://files.pythonhosted.org/packages/37/b6/d34a7f990eb0a38933a7f6b14d261fda990faef37122e71797b0043fa371/hypothesis-6.160.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5b38697f797e9406e20e03cd79e1a69c7ac714e7e244f13121d39b44f27f7ed3", size = 759362, upload-time = "2026-07-22T14:11:05.77Z" }, { url = "https://files.pythonhosted.org/packages/df/bf/48bd2bf246d22f188c82dbf3682832fc14fa4e6069c5415b1e8a473397a7/hypothesis-6.160.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ef7d9e8022a8dd2afa2bfbf6580f21a7fd8b4798d20c027f4afb048d780414fd", size = 1089731, upload-time = "2026-07-22T14:11:39.069Z" }, { url = "https://files.pythonhosted.org/packages/76/a0/d557bd44f611ec2516c69b6ada1e65f96c4d9d1dbad63f12b1799ca682b8/hypothesis-6.160.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4716ceb2adc72ea20138cd6a5600d102895f46fe95a42d915e032eed54b77ee6", size = 1139776, upload-time = "2026-07-22T14:11:19.164Z" }, { url = "https://files.pythonhosted.org/packages/32/99/cad454acb11e027773bdba5cb95cb181a46cd1cabb8bfe2f2042e29dc0c5/hypothesis-6.160.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3d186b17a25eaf51ebf0376ea9d702dddb4f62cc11c0b5230e0aae77b44f49d3", size = 1262564, upload-time = "2026-07-22T14:11:02.444Z" }, { url = "https://files.pythonhosted.org/packages/67/e7/61b2e1b6c2f75fa3b791040ba4baf2b617ffaf62ffbafad9463869baf521/hypothesis-6.160.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7e5e959bb18ec9b285dcc1d6f455c8860da919b9341842530847e820ed18dbbb", size = 1306756, upload-time = "2026-07-22T14:11:54.464Z" }, { url = "https://files.pythonhosted.org/packages/89/79/6e9f2da0f298f891930a9fc1ed0559818d4ba840f47ed736c89152fd962e/hypothesis-6.160.0-cp312-cp312-win_amd64.whl", hash = "sha256:ded91bbdd0c3a84903bda3dc08d639b3b3e28c03fb83b568af8e13039042c3c4", size = 655265, upload-time = "2026-07-22T14:10:58.076Z" }, { url = "https://files.pythonhosted.org/packages/85/05/a05ba058a37681d2aa872abcff9bd7a50c61c6347aedf2e3f5a15b8e932b/hypothesis-6.160.0-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:cb6cd703d38d881505a00e1901844d70d250e90824caa55e0dfaed6c8c7e0244", size = 767604, upload-time = "2026-07-22T14:11:11.346Z" }, { url = "https://files.pythonhosted.org/packages/ec/a1/33dde1810a52698802fe2e28cfd2696b6aefafdc721cc456dfbc85875bb2/hypothesis-6.160.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9561298d687f9fca38aab451e8eb8a9f18b65a57f81f7331eff5234f0f065dc0", size = 759264, upload-time = "2026-07-22T14:10:40.271Z" }, { url = "https://files.pythonhosted.org/packages/34/84/573402093577ef0fd86c8156d4c4ecd03b0a5e368e8925074fe565f9faba/hypothesis-6.160.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9e19f91119e2e19603210b849508695efabd2a35d6af9ac4d637c1b9a514a52b", size = 1089653, upload-time = "2026-07-22T14:11:37.333Z" }, { url = "https://files.pythonhosted.org/packages/da/05/c85a35fef75214fc08a27e5099ae51d713c6550252ef7ce4c156780433f1/hypothesis-6.160.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dd6b73076bb3fbf02001a439a5eb45cdd3db17e2cf6d95f453cfb1f5a97713f5", size = 1139592, upload-time = "2026-07-22T14:12:11.469Z" }, { url = "https://files.pythonhosted.org/packages/59/53/8f9996fa3a6352edec2c17b743630b6c5f62486db6b43594168a1c0b7571/hypothesis-6.160.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:c0dcde9c08f3bdd5318026c57155ce4bfe7615fd27d3eca77a7453cb3ffbba64", size = 1262616, upload-time = "2026-07-22T14:11:14.754Z" }, { url = "https://files.pythonhosted.org/packages/b4/f7/8b2699131893dd7bcecfe3be9ee758d3939cc8af68374700e68d9df2281b/hypothesis-6.160.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:78cb5fcf8518f3a10e888cdff545fa733931e2ff843b02a54e5e0b01b3142f94", size = 1306470, upload-time = "2026-07-22T14:11:23.203Z" }, { url = "https://files.pythonhosted.org/packages/88/ba/9764eaff70d2a54aa072f709a121f98cf8766fc1591a063f8fab2117b6cf/hypothesis-6.160.0-cp313-cp313-win_amd64.whl", hash = "sha256:e95c3ce8e9c5abd2256854a2e53395fdd91d16cdce8d1621eca8caf5c7a2b1a2", size = 655209, upload-time = "2026-07-22T14:11:17.33Z" }, { url = "https://files.pythonhosted.org/packages/a1/b9/3b92edf73785218f084521c2be9506ce6e5c63a64662cda074e588ff3071/hypothesis-6.160.0-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:9bd3d333a501f1faf8611159a998eb1bb28c43b620822ba6c8b2463f5de2a136", size = 767796, upload-time = "2026-07-22T14:11:28.865Z" }, { url = "https://files.pythonhosted.org/packages/12/c7/eefd510bffc66320015169e2c6669e3a08ea29dda84d81655ecc1c6cbd8c/hypothesis-6.160.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:21ee82802c25282d692eaec7d3b960176c10eb6dc70853b152c5bc6b3b6faf02", size = 759410, upload-time = "2026-07-22T14:10:31.902Z" }, { url = "https://files.pythonhosted.org/packages/1d/e4/6ad1e558d2df6900b0ad9d17081fbed4a74ffb01d86e64813cab4eaf45f1/hypothesis-6.160.0-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b7d71e85548be9dd3a6eb59904daa85d5879e337cb69ad42cc2267c05a17ab26", size = 1090131, upload-time = "2026-07-22T14:11:44.448Z" }, { url = "https://files.pythonhosted.org/packages/69/94/0d2fef37f9ff89b38b943cc38e12b45fda47cd06704d09bdeb890063d3bc/hypothesis-6.160.0-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4af833bb623f37b185e53ad7c62292272fc9fec3c7567d0703e3fdd3dcc90945", size = 1139829, upload-time = "2026-07-22T14:12:02.462Z" }, { url = "https://files.pythonhosted.org/packages/ad/f3/216b8af797eda74af68b0d8ee37d8452adf0cf5b924dd25780e5c3b6296f/hypothesis-6.160.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:5789a0cd225f216690d7d99159bbd5d01a6d42cb6c4a07233739b4bf59c7fa37", size = 1262992, upload-time = "2026-07-22T14:10:34.529Z" }, { url = "https://files.pythonhosted.org/packages/d8/14/63f14de37f41ed09d56593d9c03e8389a3bffcdbdf71bf05d30b5e3b1e4f/hypothesis-6.160.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:57f6e370e24c3ca4b9bb6cb132baa471745ca3d598f6328a602f590fe531b1e7", size = 1306760, upload-time = "2026-07-22T14:10:59.825Z" }, { url = "https://files.pythonhosted.org/packages/8f/9f/a94eb847dd98edf233aefb7dbe88bd7bf7506840896454ed03827f844907/hypothesis-6.160.0-cp314-cp314-pyemscripten_2026_0_wasm32.whl", hash = "sha256:5df6d4768d7a2d0bd82cd8704c2732cf80fd13089217a3b0ff7b330b59eb50c6", size = 599306, upload-time = "2026-07-22T14:11:09.704Z" }, { url = "https://files.pythonhosted.org/packages/cb/10/01a5545d22d61320e5d9507a252cef37a138af97d5c17bcad8ea08bfa936/hypothesis-6.160.0-cp314-cp314-win_amd64.whl", hash = "sha256:bdafeab25029d1261786f68ce7aedaa5c0be3ad4accfb13b32ff206ef6dfaa40", size = 655149, upload-time = "2026-07-22T14:11:12.9Z" }, { url = "https://files.pythonhosted.org/packages/91/d7/b170ae2dfeea3bc0edb99f361ccd725ce00120ddd2065590ed4281ffd29d/hypothesis-6.160.0-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:285f6763461d58ef1b9b75efd69b559ba3b91055c7c6fb34b1513b3666106a62", size = 766374, upload-time = "2026-07-22T14:10:37.579Z" }, { url = "https://files.pythonhosted.org/packages/85/30/64e3ca8d5132688bed13bf0c35b4cb1061975f7bba9201c718c394b14fbb/hypothesis-6.160.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:d7cefc720eaf6d80f4ee0be59a12e301f3d16a5941fdbefe11295ca7e567b0c2", size = 757876, upload-time = "2026-07-22T14:11:27.033Z" }, { url = "https://files.pythonhosted.org/packages/25/a2/219da3305b412dc265be7ecdd846882ff4e399f84896ff561982bb9be0d3/hypothesis-6.160.0-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1ec6ff81bace8494b12b6c2096e8fb18a769e861613a02138700a2cb5e4c1ccd", size = 1088723, upload-time = "2026-07-22T14:10:48.385Z" }, { url = "https://files.pythonhosted.org/packages/8a/29/c1879c3a25f3069b1102d17bf2b6f6a7c0667128f1fb2efb2e9964bc17c1/hypothesis-6.160.0-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c1c32bed39ecff19f68e37fef7ee4bcd1d13a82378fcd321b61d0cd2f1a360c8", size = 1138696, upload-time = "2026-07-22T14:10:52.712Z" }, { url = "https://files.pythonhosted.org/packages/b6/15/16239bfc9aad85aa0a0166f61b8aa4eddc69ee57b0c68188f191f4ef0b00/hypothesis-6.160.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8d04e56812e135c3223cd06cd0016f61466ce7c56720167046d91123534240f5", size = 1261184, upload-time = "2026-07-22T14:10:43.241Z" }, { url = "https://files.pythonhosted.org/packages/7d/b8/aa6f06d42d1505b2dab0f82d133d84853391437f34a15c4c39cbcda04f6a/hypothesis-6.160.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:c18c5eb6260bda6e56689429723d5b62b62cedee88c95de03976799645c9b0ce", size = 1305573, upload-time = "2026-07-22T14:10:51.193Z" }, { url = "https://files.pythonhosted.org/packages/44/13/645f8c95070a21fa1257f0d4cf68b938d7ec60e8371d79402ce7cb50d3c9/hypothesis-6.160.0-cp314-cp314t-win_amd64.whl", hash = "sha256:deabcb5645076988ac52237a7c3ee8fca2fbd4f859461537374911fbe0e99817", size = 655308, upload-time = "2026-07-22T14:10:38.969Z" }, ] [[package]] name = "idna" version = "3.15" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/82/77/7b3966d0b9d1d31a36ddf1746926a11dface89a83409bf1483f0237aa758/idna-3.15.tar.gz", hash = "sha256:ca962446ea538f7092a95e057da437618e886f4d349216d2b1e294abfdb65fdc", size = 199245, upload-time = "2026-05-12T22:45:57.011Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/d2/23/408243171aa9aaba178d3e2559159c24c1171a641aa83b67bdd3394ead8e/idna-3.15-py3-none-any.whl", hash = "sha256:048adeaf8c2d788c40fee287673ccaa74c24ffd8dcf09ffa555a2fbb59f10ac8", size = 72340, upload-time = "2026-05-12T22:45:55.733Z" }, ] [[package]] name = "imagesize" version = "2.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/6c/e6/7bf14eeb8f8b7251141944835abd42eb20a658d89084b7e1f3e5fe394090/imagesize-2.0.0.tar.gz", hash = "sha256:8e8358c4a05c304f1fccf7ff96f036e7243a189e9e42e90851993c558cfe9ee3", size = 1773045, upload-time = "2026-03-03T14:18:29.941Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5f/53/fb7122b71361a0d121b669dcf3d31244ef75badbbb724af388948de543e2/imagesize-2.0.0-py2.py3-none-any.whl", hash = "sha256:5667c5bbb57ab3f1fa4bc366f4fbc971db3d5ed011fd2715fd8001f782718d96", size = 9441, upload-time = "2026-03-03T14:18:27.892Z" }, ] [[package]] name = "iniconfig" version = "2.3.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/72/34/14ca021ce8e5dfedc35312d08ba8bf51fdd999c576889fc2c24cb97f4f10/iniconfig-2.3.0.tar.gz", hash = "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", size = 20503, upload-time = "2025-10-18T21:55:43.219Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/cb/b1/3846dd7f199d53cb17f49cba7e651e9ce294d8497c8c150530ed11865bb8/iniconfig-2.3.0-py3-none-any.whl", hash = "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12", size = 7484, upload-time = "2025-10-18T21:55:41.639Z" }, ] [[package]] name = "itsdangerous" version = "2.2.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/9c/cb/8ac0172223afbccb63986cc25049b154ecfb5e85932587206f42317be31d/itsdangerous-2.2.0.tar.gz", hash = "sha256:e0050c0b7da1eea53ffaf149c0cfbb5c6e2e2b69c4bef22c81fa6eb73e5f6173", size = 54410, upload-time = "2024-04-16T21:28:15.614Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/04/96/92447566d16df59b2a776c0fb82dbc4d9e07cd95062562af01e408583fc4/itsdangerous-2.2.0-py3-none-any.whl", hash = "sha256:c6242fc49e35958c8b15141343aa660db5fc54d4f13a1db01a3f5891b98700ef", size = 16234, upload-time = "2024-04-16T21:28:14.499Z" }, ] [[package]] name = "jinja2" version = "3.1.6" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markupsafe" }, ] sdist = { url = "https://files.pythonhosted.org/packages/df/bf/f7da0350254c0ed7c72f3e33cef02e048281fec7ecec5f032d4aac52226b/jinja2-3.1.6.tar.gz", hash = "sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d", size = 245115, upload-time = "2025-03-05T20:05:02.478Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/62/a1/3d680cbfd5f4b8f15abc1d571870c5fc3e594bb582bc3b64ea099db13e56/jinja2-3.1.6-py3-none-any.whl", hash = "sha256:85ece4451f492d0c13c5dd7c13a64681a86afae63a5f347908daf103ce6d2f67", size = 134899, upload-time = "2025-03-05T20:05:00.369Z" }, ] [[package]] name = "jmespath" version = "1.1.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/d3/59/322338183ecda247fb5d1763a6cbe46eff7222eaeebafd9fa65d4bf5cb11/jmespath-1.1.0.tar.gz", hash = "sha256:472c87d80f36026ae83c6ddd0f1d05d4e510134ed462851fd5f754c8c3cbb88d", size = 27377, upload-time = "2026-01-22T16:35:26.279Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/14/2f/967ba146e6d58cf6a652da73885f52fc68001525b4197effc174321d70b4/jmespath-1.1.0-py3-none-any.whl", hash = "sha256:a5663118de4908c91729bea0acadca56526eb2698e83de10cd116ae0f4e97c64", size = 20419, upload-time = "2026-01-22T16:35:24.919Z" }, ] [[package]] name = "joserfc" version = "1.6.8" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "cryptography" }, ] sdist = { url = "https://files.pythonhosted.org/packages/5d/ac/d4fd5b30f82900eac60d765f179f0ba005825ac462cc8ced6e13ec685ab3/joserfc-1.6.8.tar.gz", hash = "sha256:878620c553a6ebdd76ccdc356782fee3f735f21a356d079a546b42a4670ace5f", size = 232930, upload-time = "2026-05-27T03:22:37.819Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/98/8c/5cdce2cf3ce8155849baf9a5e2ce77e89dc87ec3bdb38259e5d85fbc45bd/joserfc-1.6.8-py3-none-any.whl", hash = "sha256:22fb31a69094a5e6f44632002a9df2c30c941fc6c8ce1b037e92c03de954cf9f", size = 70927, upload-time = "2026-05-27T03:22:35.796Z" }, ] [[package]] name = "jsonpatch" version = "1.33" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "jsonpointer" }, ] sdist = { url = "https://files.pythonhosted.org/packages/42/78/18813351fe5d63acad16aec57f94ec2b70a09e53ca98145589e185423873/jsonpatch-1.33.tar.gz", hash = "sha256:9fcd4009c41e6d12348b4a0ff2563ba56a2923a7dfee731d004e212e1ee5030c", size = 21699, upload-time = "2023-06-26T12:07:29.144Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/73/07/02e16ed01e04a374e644b575638ec7987ae846d25ad97bcc9945a3ee4b0e/jsonpatch-1.33-py2.py3-none-any.whl", hash = "sha256:0ae28c0cd062bbd8b8ecc26d7d164fbbea9652a1a3693f3b956c1eae5145dade", size = 12898, upload-time = "2023-06-16T21:01:28.466Z" }, ] [[package]] name = "jsonpath-ng" version = "1.8.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/32/58/250751940d75c8019659e15482d548a4aa3b6ce122c515102a4bfdac50e3/jsonpath_ng-1.8.0.tar.gz", hash = "sha256:54252968134b5e549ea5b872f1df1168bd7defe1a52fed5a358c194e1943ddc3", size = 74513, upload-time = "2026-02-24T14:42:06.182Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/03/99/33c7d78a3fb70d545fd5411ac67a651c81602cc09c9cf0df383733f068c5/jsonpath_ng-1.8.0-py3-none-any.whl", hash = "sha256:b8dde192f8af58d646fc031fac9c99fe4d00326afc4148f1f043c601a8cfe138", size = 67844, upload-time = "2026-02-28T00:53:19.637Z" }, ] [[package]] name = "jsonpointer" version = "3.1.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/18/c7/af399a2e7a67fd18d63c40c5e62d3af4e67b836a2107468b6a5ea24c4304/jsonpointer-3.1.1.tar.gz", hash = "sha256:0b801c7db33a904024f6004d526dcc53bbb8a4a0f4e32bfd10beadf60adf1900", size = 9068, upload-time = "2026-03-23T22:32:32.458Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/9e/6a/a83720e953b1682d2d109d3c2dbb0bc9bf28cc1cbc205be4ef4be5da709d/jsonpointer-3.1.1-py3-none-any.whl", hash = "sha256:8ff8b95779d071ba472cf5bc913028df06031797532f08a7d5b602d8b2a488ca", size = 7659, upload-time = "2026-03-23T22:32:31.568Z" }, ] [[package]] name = "jsonschema" version = "4.26.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "attrs" }, { name = "jsonschema-specifications" }, { name = "referencing" }, { name = "rpds-py" }, ] sdist = { url = "https://files.pythonhosted.org/packages/b3/fc/e067678238fa451312d4c62bf6e6cf5ec56375422aee02f9cb5f909b3047/jsonschema-4.26.0.tar.gz", hash = "sha256:0c26707e2efad8aa1bfc5b7ce170f3fccc2e4918ff85989ba9ffa9facb2be326", size = 366583, upload-time = "2026-01-07T13:41:07.246Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/69/90/f63fb5873511e014207a475e2bb4e8b2e570d655b00ac19a9a0ca0a385ee/jsonschema-4.26.0-py3-none-any.whl", hash = "sha256:d489f15263b8d200f8387e64b4c3a75f06629559fb73deb8fdfb525f2dab50ce", size = 90630, upload-time = "2026-01-07T13:41:05.306Z" }, ] [[package]] name = "jsonschema-path" version = "0.4.6" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pathable" }, { name = "pyyaml" }, { name = "referencing" }, ] sdist = { url = "https://files.pythonhosted.org/packages/01/86/cfee6dd25843bec0760f456599a4f7e7e40221a934b9229fda0662c859bc/jsonschema_path-0.4.6.tar.gz", hash = "sha256:c89eb635f4d497c9ac328eeff359c489755838806a7d033510a692e9576f5c4b", size = 15302, upload-time = "2026-04-27T18:57:08.412Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/6c/43/3d3065c05a04bb550c143bfbb8e4fd7022cd327e1082bf257bac74923783/jsonschema_path-0.4.6-py3-none-any.whl", hash = "sha256:451354b5311fa955c3144e6e4e255388c751c0121c5570ec5bb9291dd42d08c9", size = 19565, upload-time = "2026-04-27T18:57:06.792Z" }, ] [[package]] name = "jsonschema-specifications" version = "2025.9.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "referencing" }, ] sdist = { url = "https://files.pythonhosted.org/packages/19/74/a633ee74eb36c44aa6d1095e7cc5569bebf04342ee146178e2d36600708b/jsonschema_specifications-2025.9.1.tar.gz", hash = "sha256:b540987f239e745613c7a9176f3edb72b832a4ac465cf02712288397832b5e8d", size = 32855, upload-time = "2025-09-08T01:34:59.186Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/41/45/1a4ed80516f02155c51f51e8cedb3c1902296743db0bbc66608a0db2814f/jsonschema_specifications-2025.9.1-py3-none-any.whl", hash = "sha256:98802fee3a11ee76ecaca44429fda8a41bff98b00a0f2838151b113f210cc6fe", size = 18437, upload-time = "2025-09-08T01:34:57.871Z" }, ] [[package]] name = "lazy-object-proxy" version = "1.12.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/08/a2/69df9c6ba6d316cfd81fe2381e464db3e6de5db45f8c43c6a23504abf8cb/lazy_object_proxy-1.12.0.tar.gz", hash = "sha256:1f5a462d92fd0cfb82f1fab28b51bfb209fabbe6aabf7f0d51472c0c124c0c61", size = 43681, upload-time = "2025-08-22T13:50:06.783Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0d/1b/b5f5bd6bda26f1e15cd3232b223892e4498e34ec70a7f4f11c401ac969f1/lazy_object_proxy-1.12.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8ee0d6027b760a11cc18281e702c0309dd92da458a74b4c15025d7fc490deede", size = 26746, upload-time = "2025-08-22T13:42:37.572Z" }, { url = "https://files.pythonhosted.org/packages/55/64/314889b618075c2bfc19293ffa9153ce880ac6153aacfd0a52fcabf21a66/lazy_object_proxy-1.12.0-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:4ab2c584e3cc8be0dfca422e05ad30a9abe3555ce63e9ab7a559f62f8dbc6ff9", size = 71457, upload-time = "2025-08-22T13:42:38.743Z" }, { url = "https://files.pythonhosted.org/packages/11/53/857fc2827fc1e13fbdfc0ba2629a7d2579645a06192d5461809540b78913/lazy_object_proxy-1.12.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:14e348185adbd03ec17d051e169ec45686dcd840a3779c9d4c10aabe2ca6e1c0", size = 71036, upload-time = "2025-08-22T13:42:40.184Z" }, { url = "https://files.pythonhosted.org/packages/2b/24/e581ffed864cd33c1b445b5763d617448ebb880f48675fc9de0471a95cbc/lazy_object_proxy-1.12.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:c4fcbe74fb85df8ba7825fa05eddca764138da752904b378f0ae5ab33a36c308", size = 69329, upload-time = "2025-08-22T13:42:41.311Z" }, { url = "https://files.pythonhosted.org/packages/78/be/15f8f5a0b0b2e668e756a152257d26370132c97f2f1943329b08f057eff0/lazy_object_proxy-1.12.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:563d2ec8e4d4b68ee7848c5ab4d6057a6d703cb7963b342968bb8758dda33a23", size = 70690, upload-time = "2025-08-22T13:42:42.51Z" }, { url = "https://files.pythonhosted.org/packages/5d/aa/f02be9bbfb270e13ee608c2b28b8771f20a5f64356c6d9317b20043c6129/lazy_object_proxy-1.12.0-cp312-cp312-win_amd64.whl", hash = "sha256:53c7fd99eb156bbb82cbc5d5188891d8fdd805ba6c1e3b92b90092da2a837073", size = 26563, upload-time = "2025-08-22T13:42:43.685Z" }, { url = "https://files.pythonhosted.org/packages/f4/26/b74c791008841f8ad896c7f293415136c66cc27e7c7577de4ee68040c110/lazy_object_proxy-1.12.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:86fd61cb2ba249b9f436d789d1356deae69ad3231dc3c0f17293ac535162672e", size = 26745, upload-time = "2025-08-22T13:42:44.982Z" }, { url = "https://files.pythonhosted.org/packages/9b/52/641870d309e5d1fb1ea7d462a818ca727e43bfa431d8c34b173eb090348c/lazy_object_proxy-1.12.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:81d1852fb30fab81696f93db1b1e55a5d1ff7940838191062f5f56987d5fcc3e", size = 71537, upload-time = "2025-08-22T13:42:46.141Z" }, { url = "https://files.pythonhosted.org/packages/47/b6/919118e99d51c5e76e8bf5a27df406884921c0acf2c7b8a3b38d847ab3e9/lazy_object_proxy-1.12.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:be9045646d83f6c2664c1330904b245ae2371b5c57a3195e4028aedc9f999655", size = 71141, upload-time = "2025-08-22T13:42:47.375Z" }, { url = "https://files.pythonhosted.org/packages/e5/47/1d20e626567b41de085cf4d4fb3661a56c159feaa73c825917b3b4d4f806/lazy_object_proxy-1.12.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:67f07ab742f1adfb3966c40f630baaa7902be4222a17941f3d85fd1dae5565ff", size = 69449, upload-time = "2025-08-22T13:42:48.49Z" }, { url = "https://files.pythonhosted.org/packages/58/8d/25c20ff1a1a8426d9af2d0b6f29f6388005fc8cd10d6ee71f48bff86fdd0/lazy_object_proxy-1.12.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:75ba769017b944fcacbf6a80c18b2761a1795b03f8899acdad1f1c39db4409be", size = 70744, upload-time = "2025-08-22T13:42:49.608Z" }, { url = "https://files.pythonhosted.org/packages/c0/67/8ec9abe15c4f8a4bcc6e65160a2c667240d025cbb6591b879bea55625263/lazy_object_proxy-1.12.0-cp313-cp313-win_amd64.whl", hash = "sha256:7b22c2bbfb155706b928ac4d74c1a63ac8552a55ba7fff4445155523ea4067e1", size = 26568, upload-time = "2025-08-22T13:42:57.719Z" }, { url = "https://files.pythonhosted.org/packages/23/12/cd2235463f3469fd6c62d41d92b7f120e8134f76e52421413a0ad16d493e/lazy_object_proxy-1.12.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:4a79b909aa16bde8ae606f06e6bbc9d3219d2e57fb3e0076e17879072b742c65", size = 27391, upload-time = "2025-08-22T13:42:50.62Z" }, { url = "https://files.pythonhosted.org/packages/60/9e/f1c53e39bbebad2e8609c67d0830cc275f694d0ea23d78e8f6db526c12d3/lazy_object_proxy-1.12.0-cp313-cp313t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:338ab2f132276203e404951205fe80c3fd59429b3a724e7b662b2eb539bb1be9", size = 80552, upload-time = "2025-08-22T13:42:51.731Z" }, { url = "https://files.pythonhosted.org/packages/4c/b6/6c513693448dcb317d9d8c91d91f47addc09553613379e504435b4cc8b3e/lazy_object_proxy-1.12.0-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:8c40b3c9faee2e32bfce0df4ae63f4e73529766893258eca78548bac801c8f66", size = 82857, upload-time = "2025-08-22T13:42:53.225Z" }, { url = "https://files.pythonhosted.org/packages/12/1c/d9c4aaa4c75da11eb7c22c43d7c90a53b4fca0e27784a5ab207768debea7/lazy_object_proxy-1.12.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:717484c309df78cedf48396e420fa57fc8a2b1f06ea889df7248fdd156e58847", size = 80833, upload-time = "2025-08-22T13:42:54.391Z" }, { url = "https://files.pythonhosted.org/packages/0b/ae/29117275aac7d7d78ae4f5a4787f36ff33262499d486ac0bf3e0b97889f6/lazy_object_proxy-1.12.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:a6b7ea5ea1ffe15059eb44bcbcb258f97bcb40e139b88152c40d07b1a1dfc9ac", size = 79516, upload-time = "2025-08-22T13:42:55.812Z" }, { url = "https://files.pythonhosted.org/packages/19/40/b4e48b2c38c69392ae702ae7afa7b6551e0ca5d38263198b7c79de8b3bdf/lazy_object_proxy-1.12.0-cp313-cp313t-win_amd64.whl", hash = "sha256:08c465fb5cd23527512f9bd7b4c7ba6cec33e28aad36fbbe46bf7b858f9f3f7f", size = 27656, upload-time = "2025-08-22T13:42:56.793Z" }, { url = "https://files.pythonhosted.org/packages/ef/3a/277857b51ae419a1574557c0b12e0d06bf327b758ba94cafc664cb1e2f66/lazy_object_proxy-1.12.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:c9defba70ab943f1df98a656247966d7729da2fe9c2d5d85346464bf320820a3", size = 26582, upload-time = "2025-08-22T13:49:49.366Z" }, { url = "https://files.pythonhosted.org/packages/1a/b6/c5e0fa43535bb9c87880e0ba037cdb1c50e01850b0831e80eb4f4762f270/lazy_object_proxy-1.12.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:6763941dbf97eea6b90f5b06eb4da9418cc088fce0e3883f5816090f9afcde4a", size = 71059, upload-time = "2025-08-22T13:49:50.488Z" }, { url = "https://files.pythonhosted.org/packages/06/8a/7dcad19c685963c652624702f1a968ff10220b16bfcc442257038216bf55/lazy_object_proxy-1.12.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:fdc70d81235fc586b9e3d1aeef7d1553259b62ecaae9db2167a5d2550dcc391a", size = 71034, upload-time = "2025-08-22T13:49:54.224Z" }, { url = "https://files.pythonhosted.org/packages/12/ac/34cbfb433a10e28c7fd830f91c5a348462ba748413cbb950c7f259e67aa7/lazy_object_proxy-1.12.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:0a83c6f7a6b2bfc11ef3ed67f8cbe99f8ff500b05655d8e7df9aab993a6abc95", size = 69529, upload-time = "2025-08-22T13:49:55.29Z" }, { url = "https://files.pythonhosted.org/packages/6f/6a/11ad7e349307c3ca4c0175db7a77d60ce42a41c60bcb11800aabd6a8acb8/lazy_object_proxy-1.12.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:256262384ebd2a77b023ad02fbcc9326282bcfd16484d5531154b02bc304f4c5", size = 70391, upload-time = "2025-08-22T13:49:56.35Z" }, { url = "https://files.pythonhosted.org/packages/59/97/9b410ed8fbc6e79c1ee8b13f8777a80137d4bc189caf2c6202358e66192c/lazy_object_proxy-1.12.0-cp314-cp314-win_amd64.whl", hash = "sha256:7601ec171c7e8584f8ff3f4e440aa2eebf93e854f04639263875b8c2971f819f", size = 26988, upload-time = "2025-08-22T13:49:57.302Z" }, ] [[package]] name = "librt" version = "0.13.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/dc/2f/3908645ddddab7120b46295e541ead308109fa48dbec7d67d7a778870d60/librt-0.13.0.tar.gz", hash = "sha256:1d2a610c14ac0d0750ee0a3ab8548e83155258387891caaca04def4bf7289781", size = 211402, upload-time = "2026-07-08T12:26:29.834Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/f0/f4/b2933ddae222dac338476abb872641169a5cfed2c2bb5444a5b07b32b0c3/librt-0.13.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:30536798f4504c0fad0885b1d371b0539abb081e4570c9d7c641cb51141b49f0", size = 150990, upload-time = "2026-07-08T12:25:02.42Z" }, { url = "https://files.pythonhosted.org/packages/90/ef/db98f744ca50e6efc9c95c70ee49b77aefac31f6a3fc7c83754a42d6a74f/librt-0.13.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:93d24ebb82aa4420b1409c389e7857bc35bd0b668007ac8172427d5c73cc8cc5", size = 155238, upload-time = "2026-07-08T12:25:03.681Z" }, { url = "https://files.pythonhosted.org/packages/03/e7/a197e7bc72baf2c61ce7fdc6906a5054dc05bd8da0819aa894e4857bf87e/librt-0.13.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:cb8a1adce42d8b75485a5d56a9623a50bcab995b6079f1dac59fc44034dd93d9", size = 503073, upload-time = "2026-07-08T12:25:05.049Z" }, { url = "https://files.pythonhosted.org/packages/f8/e7/7887712e27da7c1ab80fcabb1de6eb24243964f6557cae530d4b70706dbd/librt-0.13.0-cp312-cp312-manylinux2014_i686.manylinux_2_17_i686.manylinux_2_28_i686.whl", hash = "sha256:0763ca2ab66058174f9dee426dc64f5e0a89c24a7df8d3fe3f1836c04e25de4b", size = 496528, upload-time = "2026-07-08T12:25:06.26Z" }, { url = "https://files.pythonhosted.org/packages/94/f0/f2283385bb6b950b26a1410f4ce51ec27231e0b3a4b925c46366d218b198/librt-0.13.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b222493da6e7b6199db9bd79502436cf5a27da3c1f7fa83c7e285444fc93fd03", size = 531786, upload-time = "2026-07-08T12:25:07.658Z" }, { url = "https://files.pythonhosted.org/packages/36/11/69ac3b54766ffba5fd7e5acebfb048d66dbe1f9f2d14516c2b3edc59cf87/librt-0.13.0-cp312-cp312-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:fadc63331f4388c3dc90090448f682a7e9feafc11481391c1e94f2f907a3976e", size = 524393, upload-time = "2026-07-08T12:25:09.121Z" }, { url = "https://files.pythonhosted.org/packages/61/5f/d72f95fd444a926a3c14b4e24979474116988dd57a45be242077c45d3c22/librt-0.13.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:70d9c62a4cffd9f23396cd5ef93fc5d11b31596b9b7d6306074abe3d5fcf09bd", size = 543026, upload-time = "2026-07-08T12:25:10.459Z" }, { url = "https://files.pythonhosted.org/packages/c4/08/dcd9993ad192737a004ba263d549f8ea605b326b952e7d6205c7d4170b76/librt-0.13.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:66c0e7e6b02a155576df2c77ec933a70b72da726e248c494abf690923e624348", size = 546829, upload-time = "2026-07-08T12:25:11.716Z" }, { url = "https://files.pythonhosted.org/packages/96/d5/6d9bb2f54e4109a956b7128836529653eb9d740f784bc47ed10a02c1000e/librt-0.13.0-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:ac04bcd3328eb91d99dfedf6a60d9c1f15d3434e6f6daf922f0420f7d90b85c7", size = 535700, upload-time = "2026-07-08T12:25:13.144Z" }, { url = "https://files.pythonhosted.org/packages/8c/f2/10946922503858a359492fa27f13e86228bde702116a740ac7b3cd185f24/librt-0.13.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:db327e7271e653c32040b85ae6188059c924b57d7e1e29f935523fa017cd4e82", size = 573566, upload-time = "2026-07-08T12:25:14.336Z" }, { url = "https://files.pythonhosted.org/packages/48/a8/94f00e3c99479a18088af3685ea016c42f3c7d5d1964d8dbb40c08d7f1aa/librt-0.13.0-cp312-cp312-win32.whl", hash = "sha256:860bd1d8ba48456ce08feaf8d343a8aaeb2fa086f2bcaa2a923fa3f7a3ff9aa3", size = 106099, upload-time = "2026-07-08T12:25:16.159Z" }, { url = "https://files.pythonhosted.org/packages/c9/7b/2da9c74c1ed25a89cc4e1c8e007ea2eb4a0f1fafa3e70d757fe3242c5c5c/librt-0.13.0-cp312-cp312-win_amd64.whl", hash = "sha256:e54a315caf843c8d77e388cadc56ea9ded569935ee2d2347d7ea94992e5aa6fa", size = 126934, upload-time = "2026-07-08T12:25:17.275Z" }, { url = "https://files.pythonhosted.org/packages/d0/65/aead61bbf3b5358593f9d4779d2a0e88eaf6ec191a6342dde36dd1df6371/librt-0.13.0-cp312-cp312-win_arm64.whl", hash = "sha256:c718e99a0992127af84385378460db624103b559ab260435abcfe77a4e4ed1c1", size = 112236, upload-time = "2026-07-08T12:25:18.425Z" }, { url = "https://files.pythonhosted.org/packages/67/3b/18e7b63255297a2bdc9c25c8d6d4ca8eca9f63aceb1252c0f7427ac7099e/librt-0.13.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:a468951af16155824e88bdd8326ebe5bdb371f3ec0ac04642994b98201d914f3", size = 151027, upload-time = "2026-07-08T12:25:19.638Z" }, { url = "https://files.pythonhosted.org/packages/4d/68/e2248452c00d1a03b45fee1752cdc8f790a476efd2402b75181da88a9e61/librt-0.13.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:ae01d8512cc17079e53425635327dbf3f7ff57a42c00dec348bf79791c56444c", size = 155152, upload-time = "2026-07-08T12:25:20.851Z" }, { url = "https://files.pythonhosted.org/packages/0e/16/52b1c99bf19057a062aac39c900cbb81499f6f75d6c537c14463d247ba78/librt-0.13.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:32c26893cd085c1efe83219e78d866da23fb20a066101b8f68210004361d224c", size = 502499, upload-time = "2026-07-08T12:25:22.055Z" }, { url = "https://files.pythonhosted.org/packages/9f/54/b811151805c795f55e0dedee6ec687b75f9982a8105d240ea3910737a77b/librt-0.13.0-cp313-cp313-manylinux2014_i686.manylinux_2_17_i686.manylinux_2_28_i686.whl", hash = "sha256:5929da1981a46bcf4b28b1b9499905f0ff58e2419da402a048234e9783acbc4b", size = 496108, upload-time = "2026-07-08T12:25:23.296Z" }, { url = "https://files.pythonhosted.org/packages/8f/f8/094d6b2bd93f3fdaa54db54cc788c4a365333bddad65ab02e04da0b1d004/librt-0.13.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:94b85d664d777bab6c0d709416cb42938251fda9e221b79e3a2215d85df5f4f9", size = 531576, upload-time = "2026-07-08T12:25:24.648Z" }, { url = "https://files.pythonhosted.org/packages/2e/40/541733d5755824f968f7ec39d78ffbd75d145964157ae5e69a09ec6d7326/librt-0.13.0-cp313-cp313-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:531b2df3e9fe96b1fcf73a6d165921e4656be5f58d631d384ebce344298368db", size = 524390, upload-time = "2026-07-08T12:25:25.898Z" }, { url = "https://files.pythonhosted.org/packages/c6/b5/255673cfdbf5ba663339d36cd863c897289ab4337577e19f9405ce059f36/librt-0.13.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:109b84a9edf69ad89dc1f66358659e14a031baca95e3e5b0060bd903ede8efd6", size = 543053, upload-time = "2026-07-08T12:25:27.436Z" }, { url = "https://files.pythonhosted.org/packages/9e/11/ab5005e9c9850710f21e354201bf090646349d3fabf5f951eaf70235729e/librt-0.13.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:1304368a3e7ffc3e9db986796cc5326fdb5943a3567ecc137cff318e4240c0e7", size = 546387, upload-time = "2026-07-08T12:25:28.65Z" }, { url = "https://files.pythonhosted.org/packages/a2/04/a5d7ce1d1df1afd15ca283dcdf7530ac073e12d69ae8c40879dda96f7868/librt-0.13.0-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:e4f9b472e7d308d94b62c801982065661158c6ed02790d6c7ddb4337cea0f9c1", size = 535970, upload-time = "2026-07-08T12:25:30.171Z" }, { url = "https://files.pythonhosted.org/packages/5a/76/927e267a6daa290174ac281b23c9804c8829b042ade9c6f24a065f540958/librt-0.13.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:9f836c37478f167a81200d8c8b2c920a22224564bed2c23d7aeec760965c367a", size = 573582, upload-time = "2026-07-08T12:25:31.507Z" }, { url = "https://files.pythonhosted.org/packages/10/24/b6c5213efe39c19f9e13605644d0cf063b4ddaa33ac2e45b088e23a70e2e/librt-0.13.0-cp313-cp313-pyemscripten_2025_0_wasm32.whl", hash = "sha256:4000d961ff9598ac6ea603c6c836a5ed49bc205ade5fc378b998dfe1e2c36628", size = 82189, upload-time = "2026-07-08T12:25:32.675Z" }, { url = "https://files.pythonhosted.org/packages/4c/00/d29736be177a906ac0b84a5b04b4fbfa22c776dc2f366de4172b0f968c08/librt-0.13.0-cp313-cp313-win32.whl", hash = "sha256:79e44cff71750d299d61a678e49995b0d5935a9cda238c2574daeca3ba536927", size = 106193, upload-time = "2026-07-08T12:25:33.692Z" }, { url = "https://files.pythonhosted.org/packages/c8/ac/aff6fb45393cb8912f39dfb156ef6b2d1cadb207ff465fc8f66141054be8/librt-0.13.0-cp313-cp313-win_amd64.whl", hash = "sha256:54dab44a847d5ad1acd05c8a83fe518ae685516ecf4d3f7cc6e3df2a66767650", size = 126962, upload-time = "2026-07-08T12:25:34.769Z" }, { url = "https://files.pythonhosted.org/packages/d9/3a/d68cb2b334d53fd30fac81d3a489ce4ba0d9506f4df43fcf676b68352b19/librt-0.13.0-cp313-cp313-win_arm64.whl", hash = "sha256:d4cb6fbfdf874340ab5e51450753c0f817b6958a3621125ee695bbc3de866566", size = 112127, upload-time = "2026-07-08T12:25:35.981Z" }, { url = "https://files.pythonhosted.org/packages/7b/66/f49ae0d592bd45b6941e9a8bafcb6a87cddcd501ee7874707e767f01b585/librt-0.13.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:25218d94b1d2cbc0ba1d8a3f9dc9af578d9646e5ed16443a70cde1dfdcce6d71", size = 149818, upload-time = "2026-07-08T12:25:37.203Z" }, { url = "https://files.pythonhosted.org/packages/3d/50/51c76d74014d04fb95b6506d286808984b78a2f7a41039094e6b2194ac48/librt-0.13.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:f26629539d4893c2957a16c41bb058e1e135c1f150f6a2e25ed047f64cf3f5c6", size = 154071, upload-time = "2026-07-08T12:25:39.399Z" }, { url = "https://files.pythonhosted.org/packages/b8/fe/f19b0f5f82d5a1f2da736586bc840abd00ce07d6388136ae80b7333883fc/librt-0.13.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a4517d47b2b8af26975a406fba7d314de9696d864252e0257c6ea90238cfe27f", size = 494168, upload-time = "2026-07-08T12:25:40.641Z" }, { url = "https://files.pythonhosted.org/packages/94/bc/b8550c75775127fd31a5f20e8775997f7b527ad661fc8ddccd7497c064f7/librt-0.13.0-cp314-cp314-manylinux2014_i686.manylinux_2_17_i686.manylinux_2_28_i686.whl", hash = "sha256:f19e181de5b3a1148bb3420b8c4b0b0ea0fce6950099724ad151d6cea5acc180", size = 491054, upload-time = "2026-07-08T12:25:41.905Z" }, { url = "https://files.pythonhosted.org/packages/30/14/4d0204867623df3f33f86efd3d3692ba5e01321443f4d6eab35a22697618/librt-0.13.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:22034924f5b42d5a56371cf271771bfeaabf235a7a8b6264bef2d20013f786c6", size = 523006, upload-time = "2026-07-08T12:25:43.327Z" }, { url = "https://files.pythonhosted.org/packages/19/0a/c45fc9a260934696bace1ac5df1e148ac92bd71767aee3bf7cd7a4534f4c/librt-0.13.0-cp314-cp314-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:c7897db4e95e22468bdda33d8e012ceacd0182abf001e6389d763f0def6286b9", size = 515058, upload-time = "2026-07-08T12:25:44.541Z" }, { url = "https://files.pythonhosted.org/packages/13/0a/50c5ce45b326854ef8fa6ae4c36cf5142e5c55315eaf9e51d0ae73ac4da3/librt-0.13.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:1ce61b3746545029d4f5c17d6bd74b676254ad98433086c846ffb5e8fa73f007", size = 534025, upload-time = "2026-07-08T12:25:45.825Z" }, { url = "https://files.pythonhosted.org/packages/89/2d/08c413c8f93fc13b8103624fce38e5caa86cd08cbbc8465870ab287af54b/librt-0.13.0-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:46c330e82565962c761dbce7941be2cff7db674ee807455a8d0cadc5f9b759b0", size = 540557, upload-time = "2026-07-08T12:25:47.059Z" }, { url = "https://files.pythonhosted.org/packages/b3/c1/93af71fb4a364952210051811dd4e40174e79656b050c89cacac18af3330/librt-0.13.0-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:375f5af8f99cbaa99dd293af986e3d57caabc9ba81a5d3f021603764854197a1", size = 523201, upload-time = "2026-07-08T12:25:48.392Z" }, { url = "https://files.pythonhosted.org/packages/c1/6e/9766f07b676a4889d9f8bc2864e9ba5fff165653143ef4dda7df6aa34d16/librt-0.13.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:9320d34c3376ae204b2cd176e8d4883a013934e0aef822f1aed9c536490c275d", size = 565740, upload-time = "2026-07-08T12:25:49.678Z" }, { url = "https://files.pythonhosted.org/packages/a2/1e/664e3472ce2b6e10e9b83f29d4a36eb982ff6b5a169ae7567bba3a4c4ff5/librt-0.13.0-cp314-cp314-pyemscripten_2026_0_wasm32.whl", hash = "sha256:9af313c66157a69dc69ea0059a66961692250e0dc95af9c385a48ffb770a0d16", size = 81611, upload-time = "2026-07-08T12:25:50.857Z" }, { url = "https://files.pythonhosted.org/packages/2f/d4/8582a4d65e2234673685e07309d02c230b28a85724eb0acbf13f019b7f6e/librt-0.13.0-cp314-cp314-win32.whl", hash = "sha256:f2a7253458e34f33543551394ae4fe104b497ec2a65ac266074de64c1df82e37", size = 100106, upload-time = "2026-07-08T12:25:52.03Z" }, { url = "https://files.pythonhosted.org/packages/63/ce/0cb99efe6086b46cd985dc26672166fae312a239690e75871f7fafbd3fc5/librt-0.13.0-cp314-cp314-win_amd64.whl", hash = "sha256:a3dfe4edf10e8ed7e55b026a8bfc2c2a8704218b659cd4bffdf604fab966dc39", size = 121209, upload-time = "2026-07-08T12:25:53.166Z" }, { url = "https://files.pythonhosted.org/packages/26/85/4f3ccb083a3c9b0d42e223acdb3c3f507953324a59cdcab4826e8e2e3b89/librt-0.13.0-cp314-cp314-win_arm64.whl", hash = "sha256:68a5faee4bba381cb93b5961f684a514cf0053cb92308ff9c792c2fea0b174c6", size = 106404, upload-time = "2026-07-08T12:25:54.253Z" }, { url = "https://files.pythonhosted.org/packages/b2/77/333191499538c8e8189de7a4cba8e6f49ee949fd6d6e6324b21fd1522466/librt-0.13.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:a38fb81d8376dfa2f8963b265fec07637802b0d01e2a127c19c66cb070fb24f5", size = 159231, upload-time = "2026-07-08T12:25:55.432Z" }, { url = "https://files.pythonhosted.org/packages/7a/9e/2aa83758f22c278b837a1d8025898434ce2b8bff36678d5330ecaef56dff/librt-0.13.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:d4c8d9bd5abce34b2e75edb3bf37ab0f34e49b1f915a40ae8468eb7c85bc5b46", size = 161300, upload-time = "2026-07-08T12:25:56.585Z" }, { url = "https://files.pythonhosted.org/packages/bb/c0/86791e936553ca763d6b3c2fb4d31d596cd00e14fa631c283a40ba01559a/librt-0.13.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:387e2f1d27e89bffe0d3f520f0da0662c973fd607ca16c1808f8a5085419485e", size = 582056, upload-time = "2026-07-08T12:25:58.144Z" }, { url = "https://files.pythonhosted.org/packages/a8/d3/a9ec15984a185e000c4d2a16ba28bd623124ad4c38a10974c7ff78e3a893/librt-0.13.0-cp314-cp314t-manylinux2014_i686.manylinux_2_17_i686.manylinux_2_28_i686.whl", hash = "sha256:4f6db193d2e5e0ed60359b9a5a682cd67205d0d3b1e459a867dd4b5c4e7eaa7a", size = 562758, upload-time = "2026-07-08T12:25:59.544Z" }, { url = "https://files.pythonhosted.org/packages/3c/af/dbe36b78b19c06a55097f99305e4ea9458e2273e6ae16a3cbecaad7ee978/librt-0.13.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0d38604854e8d22faadf683ec6c02bb0f886e2ba56ef981a1c36ee275f21ea22", size = 602095, upload-time = "2026-07-08T12:26:00.991Z" }, { url = "https://files.pythonhosted.org/packages/2a/a8/2966891b4dd2830f5203fbee92ac2c4947653a2390ba73dfa44244fad025/librt-0.13.0-cp314-cp314t-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:371f7ce73026815dafd51c50ce38416e91428b28c4b2ec97cd39271164b0045c", size = 593452, upload-time = "2026-07-08T12:26:02.352Z" }, { url = "https://files.pythonhosted.org/packages/61/f5/4df8bfc8405ecf8c0d525b4d69636f694bdd8620b313ec8b76e54a5926cc/librt-0.13.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:3aaedf52171bee90860704c560bc798fe83b76247df47568e0197e9b13c735a0", size = 623729, upload-time = "2026-07-08T12:26:04.294Z" }, { url = "https://files.pythonhosted.org/packages/d6/13/9ac202dffc8db06f75d06c08c2f9f6ff054be67d21272dcc078fa1cc0c57/librt-0.13.0-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:96bad8725a4f196a798366c25ce075d1f7543a4ec045ffc13e6a7ec095cdab04", size = 617077, upload-time = "2026-07-08T12:26:05.845Z" }, { url = "https://files.pythonhosted.org/packages/6e/f0/ebe38610716aee5cb28efd95089bb90192096179802779381e1c5dcf239c/librt-0.13.0-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:6bf6a559ffe4a93bbea6cf31ddf01a7fd9ba342ef51f27beb178e318b74acd61", size = 599561, upload-time = "2026-07-08T12:26:07.21Z" }, { url = "https://files.pythonhosted.org/packages/4f/5c/c2e72e236fff7abc716d5b1753b8b8cd3ea85ac46fe17d2e7c51d4e1c723/librt-0.13.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:301067672387902c55f94b51d5022304b36c966ea9fe1f21caab99a9bef487c9", size = 645511, upload-time = "2026-07-08T12:26:08.562Z" }, { url = "https://files.pythonhosted.org/packages/0c/99/6203ce619dee940d6bfbe099ec3fe4be00a68e9d60f70abf906cf124fe66/librt-0.13.0-cp314-cp314t-win32.whl", hash = "sha256:5fdcf34f86de8fb66d7dc7589f96ba91c4aa46671200d400e6fd6f109a483f18", size = 104357, upload-time = "2026-07-08T12:26:09.828Z" }, { url = "https://files.pythonhosted.org/packages/52/dd/843b6314087c41657c7036d7914d8f294bdf9b580aa8513ea0588c8e9a3d/librt-0.13.0-cp314-cp314t-win_amd64.whl", hash = "sha256:260c33e92263fa629b4f6d3c51967a1c2158fe6c33237aaa3ebeac586b085259", size = 126998, upload-time = "2026-07-08T12:26:10.975Z" }, { url = "https://files.pythonhosted.org/packages/5f/5d/3dcec2884ba1b0806d1408612555c38dd5d68e90156b59f75f6e36435c3a/librt-0.13.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2f281549a4c52ac7bb97997f14353f8bd0e53a34ca0dad1c905cfd0b4a58ae99", size = 110771, upload-time = "2026-07-08T12:26:12.303Z" }, ] [[package]] name = "markdown" version = "3.10.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/2b/f4/69fa6ed85ae003c2378ffa8f6d2e3234662abd02c10d216c0ba96081a238/markdown-3.10.2.tar.gz", hash = "sha256:994d51325d25ad8aa7ce4ebaec003febcce822c3f8c911e3b17c52f7f589f950", size = 368805, upload-time = "2026-02-09T14:57:26.942Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/de/1f/77fa3081e4f66ca3576c896ae5d31c3002ac6607f9747d2e3aa49227e464/markdown-3.10.2-py3-none-any.whl", hash = "sha256:e91464b71ae3ee7afd3017d9f358ef0baf158fd9a298db92f1d4761133824c36", size = 108180, upload-time = "2026-02-09T14:57:25.787Z" }, ] [[package]] name = "markdown-exec" version = "1.12.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pymdown-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/6d/76/c47da8edb6a12b066728432fb3724109d9d91de5331df5073d12d272493f/markdown_exec-1.12.3.tar.gz", hash = "sha256:006b9cac46470a9499797bc9c579305ae4719e0a8e495e5401dfbf1e66ce7fb4", size = 77841, upload-time = "2026-07-07T09:53:13.838Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ad/a7/0279016386d611183ccc508c5688eb1e2133e8182164d7a2c6213b176f69/markdown_exec-1.12.3-py3-none-any.whl", hash = "sha256:48ac12a565f3f4331b1acd9efc48a0773e717eb7ca7c38e23c1d72ee61660de6", size = 37995, upload-time = "2026-07-07T09:53:12.619Z" }, ] [package.optional-dependencies] ansi = [ { name = "pygments-ansi-color" }, ] [[package]] name = "markdown-it-py" version = "4.2.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "mdurl" }, ] sdist = { url = "https://files.pythonhosted.org/packages/06/ff/7841249c247aa650a76b9ee4bbaeae59370dc8bfd2f6c01f3630c35eb134/markdown_it_py-4.2.0.tar.gz", hash = "sha256:04a21681d6fbb623de53f6f364d352309d4094dd4194040a10fd51833e418d49", size = 82454, upload-time = "2026-05-07T12:08:28.36Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/b3/81/4da04ced5a082363ecfa159c010d200ecbd959ae410c10c0264a38cac0f5/markdown_it_py-4.2.0-py3-none-any.whl", hash = "sha256:9f7ebbcd14fe59494226453aed97c1070d83f8d24b6fc3a3bcf9a38092641c4a", size = 91687, upload-time = "2026-05-07T12:08:27.182Z" }, ] [[package]] name = "markupsafe" version = "3.0.3" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/7e/99/7690b6d4034fffd95959cbe0c02de8deb3098cc577c67bb6a24fe5d7caa7/markupsafe-3.0.3.tar.gz", hash = "sha256:722695808f4b6457b320fdc131280796bdceb04ab50fe1795cd540799ebe1698", size = 80313, upload-time = "2025-09-27T18:37:40.426Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5a/72/147da192e38635ada20e0a2e1a51cf8823d2119ce8883f7053879c2199b5/markupsafe-3.0.3-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:d53197da72cc091b024dd97249dfc7794d6a56530370992a5e1a08983ad9230e", size = 11615, upload-time = "2025-09-27T18:36:30.854Z" }, { url = "https://files.pythonhosted.org/packages/9a/81/7e4e08678a1f98521201c3079f77db69fb552acd56067661f8c2f534a718/markupsafe-3.0.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1872df69a4de6aead3491198eaf13810b565bdbeec3ae2dc8780f14458ec73ce", size = 12020, upload-time = "2025-09-27T18:36:31.971Z" }, { url = "https://files.pythonhosted.org/packages/1e/2c/799f4742efc39633a1b54a92eec4082e4f815314869865d876824c257c1e/markupsafe-3.0.3-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:3a7e8ae81ae39e62a41ec302f972ba6ae23a5c5396c8e60113e9066ef893da0d", size = 24332, upload-time = "2025-09-27T18:36:32.813Z" }, { url = "https://files.pythonhosted.org/packages/3c/2e/8d0c2ab90a8c1d9a24f0399058ab8519a3279d1bd4289511d74e909f060e/markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d6dd0be5b5b189d31db7cda48b91d7e0a9795f31430b7f271219ab30f1d3ac9d", size = 22947, upload-time = "2025-09-27T18:36:33.86Z" }, { url = "https://files.pythonhosted.org/packages/2c/54/887f3092a85238093a0b2154bd629c89444f395618842e8b0c41783898ea/markupsafe-3.0.3-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:94c6f0bb423f739146aec64595853541634bde58b2135f27f61c1ffd1cd4d16a", size = 21962, upload-time = "2025-09-27T18:36:35.099Z" }, { url = "https://files.pythonhosted.org/packages/c9/2f/336b8c7b6f4a4d95e91119dc8521402461b74a485558d8f238a68312f11c/markupsafe-3.0.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:be8813b57049a7dc738189df53d69395eba14fb99345e0a5994914a3864c8a4b", size = 23760, upload-time = "2025-09-27T18:36:36.001Z" }, { url = "https://files.pythonhosted.org/packages/32/43/67935f2b7e4982ffb50a4d169b724d74b62a3964bc1a9a527f5ac4f1ee2b/markupsafe-3.0.3-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:83891d0e9fb81a825d9a6d61e3f07550ca70a076484292a70fde82c4b807286f", size = 21529, upload-time = "2025-09-27T18:36:36.906Z" }, { url = "https://files.pythonhosted.org/packages/89/e0/4486f11e51bbba8b0c041098859e869e304d1c261e59244baa3d295d47b7/markupsafe-3.0.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:77f0643abe7495da77fb436f50f8dab76dbc6e5fd25d39589a0f1fe6548bfa2b", size = 23015, upload-time = "2025-09-27T18:36:37.868Z" }, { url = "https://files.pythonhosted.org/packages/2f/e1/78ee7a023dac597a5825441ebd17170785a9dab23de95d2c7508ade94e0e/markupsafe-3.0.3-cp312-cp312-win32.whl", hash = "sha256:d88b440e37a16e651bda4c7c2b930eb586fd15ca7406cb39e211fcff3bf3017d", size = 14540, upload-time = "2025-09-27T18:36:38.761Z" }, { url = "https://files.pythonhosted.org/packages/aa/5b/bec5aa9bbbb2c946ca2733ef9c4ca91c91b6a24580193e891b5f7dbe8e1e/markupsafe-3.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:26a5784ded40c9e318cfc2bdb30fe164bdb8665ded9cd64d500a34fb42067b1c", size = 15105, upload-time = "2025-09-27T18:36:39.701Z" }, { url = "https://files.pythonhosted.org/packages/e5/f1/216fc1bbfd74011693a4fd837e7026152e89c4bcf3e77b6692fba9923123/markupsafe-3.0.3-cp312-cp312-win_arm64.whl", hash = "sha256:35add3b638a5d900e807944a078b51922212fb3dedb01633a8defc4b01a3c85f", size = 13906, upload-time = "2025-09-27T18:36:40.689Z" }, { url = "https://files.pythonhosted.org/packages/38/2f/907b9c7bbba283e68f20259574b13d005c121a0fa4c175f9bed27c4597ff/markupsafe-3.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e1cf1972137e83c5d4c136c43ced9ac51d0e124706ee1c8aa8532c1287fa8795", size = 11622, upload-time = "2025-09-27T18:36:41.777Z" }, { url = "https://files.pythonhosted.org/packages/9c/d9/5f7756922cdd676869eca1c4e3c0cd0df60ed30199ffd775e319089cb3ed/markupsafe-3.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:116bb52f642a37c115f517494ea5feb03889e04df47eeff5b130b1808ce7c219", size = 12029, upload-time = "2025-09-27T18:36:43.257Z" }, { url = "https://files.pythonhosted.org/packages/00/07/575a68c754943058c78f30db02ee03a64b3c638586fba6a6dd56830b30a3/markupsafe-3.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:133a43e73a802c5562be9bbcd03d090aa5a1fe899db609c29e8c8d815c5f6de6", size = 24374, upload-time = "2025-09-27T18:36:44.508Z" }, { url = "https://files.pythonhosted.org/packages/a9/21/9b05698b46f218fc0e118e1f8168395c65c8a2c750ae2bab54fc4bd4e0e8/markupsafe-3.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ccfcd093f13f0f0b7fdd0f198b90053bf7b2f02a3927a30e63f3ccc9df56b676", size = 22980, upload-time = "2025-09-27T18:36:45.385Z" }, { url = "https://files.pythonhosted.org/packages/7f/71/544260864f893f18b6827315b988c146b559391e6e7e8f7252839b1b846a/markupsafe-3.0.3-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:509fa21c6deb7a7a273d629cf5ec029bc209d1a51178615ddf718f5918992ab9", size = 21990, upload-time = "2025-09-27T18:36:46.916Z" }, { url = "https://files.pythonhosted.org/packages/c2/28/b50fc2f74d1ad761af2f5dcce7492648b983d00a65b8c0e0cb457c82ebbe/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a4afe79fb3de0b7097d81da19090f4df4f8d3a2b3adaa8764138aac2e44f3af1", size = 23784, upload-time = "2025-09-27T18:36:47.884Z" }, { url = "https://files.pythonhosted.org/packages/ed/76/104b2aa106a208da8b17a2fb72e033a5a9d7073c68f7e508b94916ed47a9/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:795e7751525cae078558e679d646ae45574b47ed6e7771863fcc079a6171a0fc", size = 21588, upload-time = "2025-09-27T18:36:48.82Z" }, { url = "https://files.pythonhosted.org/packages/b5/99/16a5eb2d140087ebd97180d95249b00a03aa87e29cc224056274f2e45fd6/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:8485f406a96febb5140bfeca44a73e3ce5116b2501ac54fe953e488fb1d03b12", size = 23041, upload-time = "2025-09-27T18:36:49.797Z" }, { url = "https://files.pythonhosted.org/packages/19/bc/e7140ed90c5d61d77cea142eed9f9c303f4c4806f60a1044c13e3f1471d0/markupsafe-3.0.3-cp313-cp313-win32.whl", hash = "sha256:bdd37121970bfd8be76c5fb069c7751683bdf373db1ed6c010162b2a130248ed", size = 14543, upload-time = "2025-09-27T18:36:51.584Z" }, { url = "https://files.pythonhosted.org/packages/05/73/c4abe620b841b6b791f2edc248f556900667a5a1cf023a6646967ae98335/markupsafe-3.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:9a1abfdc021a164803f4d485104931fb8f8c1efd55bc6b748d2f5774e78b62c5", size = 15113, upload-time = "2025-09-27T18:36:52.537Z" }, { url = "https://files.pythonhosted.org/packages/f0/3a/fa34a0f7cfef23cf9500d68cb7c32dd64ffd58a12b09225fb03dd37d5b80/markupsafe-3.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:7e68f88e5b8799aa49c85cd116c932a1ac15caaa3f5db09087854d218359e485", size = 13911, upload-time = "2025-09-27T18:36:53.513Z" }, { url = "https://files.pythonhosted.org/packages/e4/d7/e05cd7efe43a88a17a37b3ae96e79a19e846f3f456fe79c57ca61356ef01/markupsafe-3.0.3-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:218551f6df4868a8d527e3062d0fb968682fe92054e89978594c28e642c43a73", size = 11658, upload-time = "2025-09-27T18:36:54.819Z" }, { url = "https://files.pythonhosted.org/packages/99/9e/e412117548182ce2148bdeacdda3bb494260c0b0184360fe0d56389b523b/markupsafe-3.0.3-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:3524b778fe5cfb3452a09d31e7b5adefeea8c5be1d43c4f810ba09f2ceb29d37", size = 12066, upload-time = "2025-09-27T18:36:55.714Z" }, { url = "https://files.pythonhosted.org/packages/bc/e6/fa0ffcda717ef64a5108eaa7b4f5ed28d56122c9a6d70ab8b72f9f715c80/markupsafe-3.0.3-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4e885a3d1efa2eadc93c894a21770e4bc67899e3543680313b09f139e149ab19", size = 25639, upload-time = "2025-09-27T18:36:56.908Z" }, { url = "https://files.pythonhosted.org/packages/96/ec/2102e881fe9d25fc16cb4b25d5f5cde50970967ffa5dddafdb771237062d/markupsafe-3.0.3-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:8709b08f4a89aa7586de0aadc8da56180242ee0ada3999749b183aa23df95025", size = 23569, upload-time = "2025-09-27T18:36:57.913Z" }, { url = "https://files.pythonhosted.org/packages/4b/30/6f2fce1f1f205fc9323255b216ca8a235b15860c34b6798f810f05828e32/markupsafe-3.0.3-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:b8512a91625c9b3da6f127803b166b629725e68af71f8184ae7e7d54686a56d6", size = 23284, upload-time = "2025-09-27T18:36:58.833Z" }, { url = "https://files.pythonhosted.org/packages/58/47/4a0ccea4ab9f5dcb6f79c0236d954acb382202721e704223a8aafa38b5c8/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:9b79b7a16f7fedff2495d684f2b59b0457c3b493778c9eed31111be64d58279f", size = 24801, upload-time = "2025-09-27T18:36:59.739Z" }, { url = "https://files.pythonhosted.org/packages/6a/70/3780e9b72180b6fecb83a4814d84c3bf4b4ae4bf0b19c27196104149734c/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:12c63dfb4a98206f045aa9563db46507995f7ef6d83b2f68eda65c307c6829eb", size = 22769, upload-time = "2025-09-27T18:37:00.719Z" }, { url = "https://files.pythonhosted.org/packages/98/c5/c03c7f4125180fc215220c035beac6b9cb684bc7a067c84fc69414d315f5/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:8f71bc33915be5186016f675cd83a1e08523649b0e33efdb898db577ef5bb009", size = 23642, upload-time = "2025-09-27T18:37:01.673Z" }, { url = "https://files.pythonhosted.org/packages/80/d6/2d1b89f6ca4bff1036499b1e29a1d02d282259f3681540e16563f27ebc23/markupsafe-3.0.3-cp313-cp313t-win32.whl", hash = "sha256:69c0b73548bc525c8cb9a251cddf1931d1db4d2258e9599c28c07ef3580ef354", size = 14612, upload-time = "2025-09-27T18:37:02.639Z" }, { url = "https://files.pythonhosted.org/packages/2b/98/e48a4bfba0a0ffcf9925fe2d69240bfaa19c6f7507b8cd09c70684a53c1e/markupsafe-3.0.3-cp313-cp313t-win_amd64.whl", hash = "sha256:1b4b79e8ebf6b55351f0d91fe80f893b4743f104bff22e90697db1590e47a218", size = 15200, upload-time = "2025-09-27T18:37:03.582Z" }, { url = "https://files.pythonhosted.org/packages/0e/72/e3cc540f351f316e9ed0f092757459afbc595824ca724cbc5a5d4263713f/markupsafe-3.0.3-cp313-cp313t-win_arm64.whl", hash = "sha256:ad2cf8aa28b8c020ab2fc8287b0f823d0a7d8630784c31e9ee5edea20f406287", size = 13973, upload-time = "2025-09-27T18:37:04.929Z" }, { url = "https://files.pythonhosted.org/packages/33/8a/8e42d4838cd89b7dde187011e97fe6c3af66d8c044997d2183fbd6d31352/markupsafe-3.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:eaa9599de571d72e2daf60164784109f19978b327a3910d3e9de8c97b5b70cfe", size = 11619, upload-time = "2025-09-27T18:37:06.342Z" }, { url = "https://files.pythonhosted.org/packages/b5/64/7660f8a4a8e53c924d0fa05dc3a55c9cee10bbd82b11c5afb27d44b096ce/markupsafe-3.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:c47a551199eb8eb2121d4f0f15ae0f923d31350ab9280078d1e5f12b249e0026", size = 12029, upload-time = "2025-09-27T18:37:07.213Z" }, { url = "https://files.pythonhosted.org/packages/da/ef/e648bfd021127bef5fa12e1720ffed0c6cbb8310c8d9bea7266337ff06de/markupsafe-3.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f34c41761022dd093b4b6896d4810782ffbabe30f2d443ff5f083e0cbbb8c737", size = 24408, upload-time = "2025-09-27T18:37:09.572Z" }, { url = "https://files.pythonhosted.org/packages/41/3c/a36c2450754618e62008bf7435ccb0f88053e07592e6028a34776213d877/markupsafe-3.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:457a69a9577064c05a97c41f4e65148652db078a3a509039e64d3467b9e7ef97", size = 23005, upload-time = "2025-09-27T18:37:10.58Z" }, { url = "https://files.pythonhosted.org/packages/bc/20/b7fdf89a8456b099837cd1dc21974632a02a999ec9bf7ca3e490aacd98e7/markupsafe-3.0.3-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:e8afc3f2ccfa24215f8cb28dcf43f0113ac3c37c2f0f0806d8c70e4228c5cf4d", size = 22048, upload-time = "2025-09-27T18:37:11.547Z" }, { url = "https://files.pythonhosted.org/packages/9a/a7/591f592afdc734f47db08a75793a55d7fbcc6902a723ae4cfbab61010cc5/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:ec15a59cf5af7be74194f7ab02d0f59a62bdcf1a537677ce67a2537c9b87fcda", size = 23821, upload-time = "2025-09-27T18:37:12.48Z" }, { url = "https://files.pythonhosted.org/packages/7d/33/45b24e4f44195b26521bc6f1a82197118f74df348556594bd2262bda1038/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:0eb9ff8191e8498cca014656ae6b8d61f39da5f95b488805da4bb029cccbfbaf", size = 21606, upload-time = "2025-09-27T18:37:13.485Z" }, { url = "https://files.pythonhosted.org/packages/ff/0e/53dfaca23a69fbfbbf17a4b64072090e70717344c52eaaaa9c5ddff1e5f0/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:2713baf880df847f2bece4230d4d094280f4e67b1e813eec43b4c0e144a34ffe", size = 23043, upload-time = "2025-09-27T18:37:14.408Z" }, { url = "https://files.pythonhosted.org/packages/46/11/f333a06fc16236d5238bfe74daccbca41459dcd8d1fa952e8fbd5dccfb70/markupsafe-3.0.3-cp314-cp314-win32.whl", hash = "sha256:729586769a26dbceff69f7a7dbbf59ab6572b99d94576a5592625d5b411576b9", size = 14747, upload-time = "2025-09-27T18:37:15.36Z" }, { url = "https://files.pythonhosted.org/packages/28/52/182836104b33b444e400b14f797212f720cbc9ed6ba34c800639d154e821/markupsafe-3.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:bdc919ead48f234740ad807933cdf545180bfbe9342c2bb451556db2ed958581", size = 15341, upload-time = "2025-09-27T18:37:16.496Z" }, { url = "https://files.pythonhosted.org/packages/6f/18/acf23e91bd94fd7b3031558b1f013adfa21a8e407a3fdb32745538730382/markupsafe-3.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:5a7d5dc5140555cf21a6fefbdbf8723f06fcd2f63ef108f2854de715e4422cb4", size = 14073, upload-time = "2025-09-27T18:37:17.476Z" }, { url = "https://files.pythonhosted.org/packages/3c/f0/57689aa4076e1b43b15fdfa646b04653969d50cf30c32a102762be2485da/markupsafe-3.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:1353ef0c1b138e1907ae78e2f6c63ff67501122006b0f9abad68fda5f4ffc6ab", size = 11661, upload-time = "2025-09-27T18:37:18.453Z" }, { url = "https://files.pythonhosted.org/packages/89/c3/2e67a7ca217c6912985ec766c6393b636fb0c2344443ff9d91404dc4c79f/markupsafe-3.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:1085e7fbddd3be5f89cc898938f42c0b3c711fdcb37d75221de2666af647c175", size = 12069, upload-time = "2025-09-27T18:37:19.332Z" }, { url = "https://files.pythonhosted.org/packages/f0/00/be561dce4e6ca66b15276e184ce4b8aec61fe83662cce2f7d72bd3249d28/markupsafe-3.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1b52b4fb9df4eb9ae465f8d0c228a00624de2334f216f178a995ccdcf82c4634", size = 25670, upload-time = "2025-09-27T18:37:20.245Z" }, { url = "https://files.pythonhosted.org/packages/50/09/c419f6f5a92e5fadde27efd190eca90f05e1261b10dbd8cbcb39cd8ea1dc/markupsafe-3.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fed51ac40f757d41b7c48425901843666a6677e3e8eb0abcff09e4ba6e664f50", size = 23598, upload-time = "2025-09-27T18:37:21.177Z" }, { url = "https://files.pythonhosted.org/packages/22/44/a0681611106e0b2921b3033fc19bc53323e0b50bc70cffdd19f7d679bb66/markupsafe-3.0.3-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:f190daf01f13c72eac4efd5c430a8de82489d9cff23c364c3ea822545032993e", size = 23261, upload-time = "2025-09-27T18:37:22.167Z" }, { url = "https://files.pythonhosted.org/packages/5f/57/1b0b3f100259dc9fffe780cfb60d4be71375510e435efec3d116b6436d43/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:e56b7d45a839a697b5eb268c82a71bd8c7f6c94d6fd50c3d577fa39a9f1409f5", size = 24835, upload-time = "2025-09-27T18:37:23.296Z" }, { url = "https://files.pythonhosted.org/packages/26/6a/4bf6d0c97c4920f1597cc14dd720705eca0bf7c787aebc6bb4d1bead5388/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:f3e98bb3798ead92273dc0e5fd0f31ade220f59a266ffd8a4f6065e0a3ce0523", size = 22733, upload-time = "2025-09-27T18:37:24.237Z" }, { url = "https://files.pythonhosted.org/packages/14/c7/ca723101509b518797fedc2fdf79ba57f886b4aca8a7d31857ba3ee8281f/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:5678211cb9333a6468fb8d8be0305520aa073f50d17f089b5b4b477ea6e67fdc", size = 23672, upload-time = "2025-09-27T18:37:25.271Z" }, { url = "https://files.pythonhosted.org/packages/fb/df/5bd7a48c256faecd1d36edc13133e51397e41b73bb77e1a69deab746ebac/markupsafe-3.0.3-cp314-cp314t-win32.whl", hash = "sha256:915c04ba3851909ce68ccc2b8e2cd691618c4dc4c4232fb7982bca3f41fd8c3d", size = 14819, upload-time = "2025-09-27T18:37:26.285Z" }, { url = "https://files.pythonhosted.org/packages/1a/8a/0402ba61a2f16038b48b39bccca271134be00c5c9f0f623208399333c448/markupsafe-3.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4faffd047e07c38848ce017e8725090413cd80cbc23d86e55c587bf979e579c9", size = 15426, upload-time = "2025-09-27T18:37:27.316Z" }, { url = "https://files.pythonhosted.org/packages/70/bc/6f1c2f612465f5fa89b95bead1f44dcb607670fd42891d8fdcd5d039f4f4/markupsafe-3.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:32001d6a8fc98c8cb5c947787c5d08b0a50663d139f1305bac5885d98d9b40fa", size = 14146, upload-time = "2025-09-27T18:37:28.327Z" }, ] [[package]] name = "mdurl" version = "0.1.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/d6/54/cfe61301667036ec958cb99bd3efefba235e65cdeb9c84d24a8293ba1d90/mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba", size = 8729, upload-time = "2022-08-14T12:40:10.846Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979, upload-time = "2022-08-14T12:40:09.779Z" }, ] [[package]] name = "mergedeep" version = "1.3.4" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", size = 4661, upload-time = "2021-02-05T18:55:30.623Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/2c/19/04f9b178c2d8a15b076c8b5140708fa6ffc5601fb6f1e975537072df5b2a/mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307", size = 6354, upload-time = "2021-02-05T18:55:29.583Z" }, ] [[package]] name = "mike" version = "2.2.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "jinja2" }, { name = "mkdocs" }, { name = "pyparsing" }, { name = "pyyaml" }, { name = "pyyaml-env-tag" }, { name = "verspec" }, ] sdist = { url = "https://files.pythonhosted.org/packages/b4/47/fa87e9d56bef16cdfe34b059a437e8c6f7ec6f1b9c378871c3cf95ebea9c/mike-2.2.0.tar.gz", hash = "sha256:1e3858e32c0f125aac14432fc7848434358f9ae0962c5c5cde387ad47f6ad25e", size = 38450, upload-time = "2026-04-14T04:59:03.944Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/76/8e/56ccb09c7232a55403a7637caa21922f3b65901a37f5e8bdb405d0de0946/mike-2.2.0-py3-none-any.whl", hash = "sha256:e1f4981c1152eec7c2490a3401142292cc47d686194188416db2648fdfe1d040", size = 34026, upload-time = "2026-04-14T04:59:02.602Z" }, ] [[package]] name = "mkdocs" version = "1.6.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "click" }, { name = "colorama", marker = "sys_platform == 'win32'" }, { name = "ghp-import" }, { name = "jinja2" }, { name = "markdown" }, { name = "markupsafe" }, { name = "mergedeep" }, { name = "mkdocs-get-deps" }, { name = "packaging" }, { name = "pathspec" }, { name = "pyyaml" }, { name = "pyyaml-env-tag" }, { name = "watchdog" }, ] sdist = { url = "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz", hash = "sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2", size = 3889159, upload-time = "2024-08-30T12:24:06.899Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c/mkdocs-1.6.1-py3-none-any.whl", hash = "sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e", size = 3864451, upload-time = "2024-08-30T12:24:05.054Z" }, ] [[package]] name = "mkdocs-autorefs" version = "1.4.4" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markdown" }, { name = "markupsafe" }, { name = "mkdocs" }, ] sdist = { url = "https://files.pythonhosted.org/packages/52/c0/f641843de3f612a6b48253f39244165acff36657a91cc903633d456ae1ac/mkdocs_autorefs-1.4.4.tar.gz", hash = "sha256:d54a284f27a7346b9c38f1f852177940c222da508e66edc816a0fa55fc6da197", size = 56588, upload-time = "2026-02-10T15:23:55.105Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/28/de/a3e710469772c6a89595fc52816da05c1e164b4c866a89e3cb82fb1b67c5/mkdocs_autorefs-1.4.4-py3-none-any.whl", hash = "sha256:834ef5408d827071ad1bc69e0f39704fa34c7fc05bc8e1c72b227dfdc5c76089", size = 25530, upload-time = "2026-02-10T15:23:53.817Z" }, ] [[package]] name = "mkdocs-get-deps" version = "0.2.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "mergedeep" }, { name = "platformdirs" }, { name = "pyyaml" }, ] sdist = { url = "https://files.pythonhosted.org/packages/ce/25/b3cccb187655b9393572bde9b09261d267c3bf2f2cdabe347673be5976a6/mkdocs_get_deps-0.2.2.tar.gz", hash = "sha256:8ee8d5f316cdbbb2834bc1df6e69c08fe769a83e040060de26d3c19fad3599a1", size = 11047, upload-time = "2026-03-10T02:46:33.632Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/88/29/744136411e785c4b0b744d5413e56555265939ab3a104c6a4b719dad33fd/mkdocs_get_deps-0.2.2-py3-none-any.whl", hash = "sha256:e7878cbeac04860b8b5e0ca31d3abad3df9411a75a32cde82f8e44b6c16ff650", size = 9555, upload-time = "2026-03-10T02:46:32.256Z" }, ] [[package]] name = "mkdocs-material" version = "9.7.7" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "babel" }, { name = "backrefs" }, { name = "colorama" }, { name = "jinja2" }, { name = "markdown" }, { name = "mkdocs" }, { name = "mkdocs-material-extensions" }, { name = "paginate" }, { name = "pygments" }, { name = "pymdown-extensions" }, { name = "requests" }, ] sdist = { url = "https://files.pythonhosted.org/packages/f1/cd/c05d3a530ba7934f144fb45f7203cd236adc25c7bdcc34673d202f4b0278/mkdocs_material-9.7.7.tar.gz", hash = "sha256:c0649c065b1b0512d60aad8c10f947f8e455284475239b364b610f2deb4d0855", size = 4097923, upload-time = "2026-07-17T16:21:33.156Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ad/21/17c1bc9e6f47c972ad66fb2ac2568f99f90f1207eeb6fc3b34d094dba7b5/mkdocs_material-9.7.7-py3-none-any.whl", hash = "sha256:8ea9bb1737a5b524a5f9dcf2e1b4ebda8274ae3008aa7845720a97083bef708f", size = 9305438, upload-time = "2026-07-17T16:21:30.017Z" }, ] [package.optional-dependencies] imaging = [ { name = "cairosvg" }, { name = "pillow" }, ] [[package]] name = "mkdocs-material-extensions" version = "1.3.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/79/9b/9b4c96d6593b2a541e1cb8b34899a6d021d208bb357042823d4d2cabdbe7/mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443", size = 11847, upload-time = "2023-11-22T19:09:45.208Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" }, ] [[package]] name = "mkdocs-redirects" version = "1.2.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "mkdocs" }, { name = "properdocs" }, ] sdist = { url = "https://files.pythonhosted.org/packages/73/25/49725f78ca5d3026b09973f7a2b3a8b179cc2e8c15e43d5a13bc79f6b274/mkdocs_redirects-1.2.3.tar.gz", hash = "sha256:5e980330999299729a2d6a125347d1af78023d68a23681a4de3053ce7dfe2e51", size = 7712, upload-time = "2026-03-28T13:57:41.766Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c6/90/871b1cddc01d2ba1637b858eeeabc2e3013dc8df591306b5567b98ef0870/mkdocs_redirects-1.2.3-py3-none-any.whl", hash = "sha256:ec7312fff462d03ec16395d0c001006a418f8d0c21cdf2b47ff11cf839dc3ce0", size = 6245, upload-time = "2026-03-28T13:57:40.466Z" }, ] [[package]] name = "mkdocstrings" version = "1.0.6" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "jinja2" }, { name = "markdown" }, { name = "markupsafe" }, { name = "mkdocs" }, { name = "mkdocs-autorefs" }, { name = "pymdown-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/53/71/f85bdf13355073ae15a7375f09879375a830553552e58c1c4b7e0bbc5c8b/mkdocstrings-1.0.6.tar.gz", hash = "sha256:a0b8c2bdd29a6416c80d717aa369bbf7831946bd9f23c2a66db1b1dbe7693dbd", size = 100649, upload-time = "2026-07-11T19:38:05.732Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5d/5b/4c1902e8bdd5c4db63284e9d101dece4038d4025d6d88850ffe0a1578980/mkdocstrings-1.0.6-py3-none-any.whl", hash = "sha256:2703708697487d1b6d6d7b412e176fa436edf120c1bf81dc9e126b12d00893c7", size = 35787, upload-time = "2026-07-11T19:38:04.417Z" }, ] [[package]] name = "mkdocstrings-python" version = "2.0.5" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "griffelib" }, { name = "mkdocs-autorefs" }, { name = "mkdocstrings" }, ] sdist = { url = "https://files.pythonhosted.org/packages/b1/b6/e858701499d57eee8b3fd8e78168083956c6683ddbe727b46758b19e1119/mkdocstrings_python-2.0.5.tar.gz", hash = "sha256:3a4d92556ad39637e88af94a5374213af9a8e3040c3824ceaed04b486c017594", size = 199578, upload-time = "2026-06-19T10:41:08.868Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/d1/fc/10ab7e80650a9c9e8f4f1105f8c8e73567f88ed0c06ada589ab81d38687c/mkdocstrings_python-2.0.5-py3-none-any.whl", hash = "sha256:30c837bbff016549f659fcba6539ac351303f0fd7e713c89a040611072236e9d", size = 104951, upload-time = "2026-06-19T10:41:07.378Z" }, ] [[package]] name = "moto" version = "5.2.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "boto3" }, { name = "botocore" }, { name = "cryptography" }, { name = "requests" }, { name = "responses" }, { name = "werkzeug" }, { name = "xmltodict" }, ] sdist = { url = "https://files.pythonhosted.org/packages/47/63/d944f387582cc53f53febbff2b3fa36a6d2ed7c1feef8990bf646cfa9cba/moto-5.2.2.tar.gz", hash = "sha256:aac8023a429e125e91c91f8f4730a67b54f518cda587352f7e67252fe3168f75", size = 8678761, upload-time = "2026-06-06T18:57:54.931Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c1/45/13cff46f4f617a6e97e1d497d75abd913e250bb4c823a4985668c6e593e4/moto-5.2.2-py3-none-any.whl", hash = "sha256:3817f1e39721ca833579b921e53e3b68547ace6a34d848c9486fbb5905808de9", size = 6698689, upload-time = "2026-06-06T18:57:51.435Z" }, ] [package.optional-dependencies] s3 = [ { name = "py-partiql-parser" }, { name = "pyyaml" }, ] server = [ { name = "antlr4-python3-runtime" }, { name = "aws-xray-sdk" }, { name = "cfn-lint" }, { name = "docker" }, { name = "flask" }, { name = "flask-cors" }, { name = "graphql-core" }, { name = "joserfc" }, { name = "jsonpath-ng" }, { name = "openapi-spec-validator" }, { name = "py-partiql-parser" }, { name = "pyparsing" }, { name = "pyyaml" }, { name = "setuptools" }, ] [[package]] name = "mpmath" version = "1.3.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/e0/47/dd32fa426cc72114383ac549964eecb20ecfd886d1e5ccf5340b55b02f57/mpmath-1.3.0.tar.gz", hash = "sha256:7a28eb2a9774d00c7bc92411c19a89209d5da7c4c9a9e227be8330a23a25b91f", size = 508106, upload-time = "2023-03-07T16:47:11.061Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/43/e3/7d92a15f894aa0c9c4b49b8ee9ac9850d6e63b03c9c32c0367a13ae62209/mpmath-1.3.0-py3-none-any.whl", hash = "sha256:a0b2b9fe80bbcd81a6647ff13108738cfb482d481d826cc0e02f5b35e5c88d2c", size = 536198, upload-time = "2023-03-07T16:47:09.197Z" }, ] [[package]] name = "msgpack" version = "1.2.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/31/f9/c0a1c127f9049db9155afc316952ea571720dd01833ff5e4d7e8e6352dbb/msgpack-1.2.1.tar.gz", hash = "sha256:04c721c2c7448767e9e3f2520a475663d8ee0f09c31890f6d2bd70fd636a9647", size = 183960, upload-time = "2026-06-18T16:13:52.594Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/bc/dd/9e8cbd8f5582ca4b590336f2b91ee5662f6a6ca562b565abaf696a0f81ff/msgpack-1.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:2ef59c659f289eddf8aa6623823f19fa2f40a4029266889eac7a2505dd210c35", size = 83531, upload-time = "2026-06-18T16:12:58.249Z" }, { url = "https://files.pythonhosted.org/packages/50/2e/ebdb85a8da151397a2790363676b7ed7c125924fe618e4c6d8befb0cc62c/msgpack-1.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d3567748a5107cb40cdf66a275430c2f87c07777698f4bfd25c35f44d533258c", size = 82657, upload-time = "2026-06-18T16:12:59.396Z" }, { url = "https://files.pythonhosted.org/packages/26/aa/753ad8b007b464e1d8aa0c8e650b9c5f4f725e658fc5ac8a7635c55b7f6e/msgpack-1.2.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:60926b75d00c8e816ef98f3034f484a8bc64242d66839cef4cf7e503142316a0", size = 410634, upload-time = "2026-06-18T16:13:00.383Z" }, { url = "https://files.pythonhosted.org/packages/6a/fd/6adabd4f6d5e686f97dd02ce7fce3fe4cf672cbac36b8f67ff4040e8ad8b/msgpack-1.2.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:020e881a764b20d8d7ca1a54fc01b8175519d108e3c3f194fddc200bda95951a", size = 419989, upload-time = "2026-06-18T16:13:01.776Z" }, { url = "https://files.pythonhosted.org/packages/5a/cc/85039b7b0eb168aaad7383a23c97e291a11f08351cb45a606ce865e4e3f1/msgpack-1.2.1-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:4202c74688ca06591f78cb18988228bd4cca2cc75d57b60008372892d2f1e6e6", size = 377544, upload-time = "2026-06-18T16:13:03.637Z" }, { url = "https://files.pythonhosted.org/packages/ed/bf/35963899493b32030c85fc513b723ae66144ac70c11ebc52e889e16e3d99/msgpack-1.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8b267ce94efb76fbd1b3373511420074ee3187f0f7811bf394531de13294735a", size = 400842, upload-time = "2026-06-18T16:13:05.012Z" }, { url = "https://files.pythonhosted.org/packages/a6/df/8e2ac970c8f99264cd9997d1c73df5466bc19da3301d7dc5500862a9b089/msgpack-1.2.1-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:e4f1d0f8f98ade9634e01fb704a408f9336c0a8f1117b369f5db83dc7551d8b1", size = 374108, upload-time = "2026-06-18T16:13:06.232Z" }, { url = "https://files.pythonhosted.org/packages/17/dd/fa8bd265110dfa51c20cb529f9e6d240a16fafe7e645004c6af2d01353ba/msgpack-1.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:f02cf17a6ca1abe29b5f980644f7551f94d71f2011509b26d8625ce038f0df64", size = 414939, upload-time = "2026-06-18T16:13:07.478Z" }, { url = "https://files.pythonhosted.org/packages/2e/b9/8377a5ad8953fc0437c70cc98d9ae29f27fe5ac5109fbec0812085865735/msgpack-1.2.1-cp312-cp312-win32.whl", hash = "sha256:0c0d9802354507bcba62af19c17918e3eb437cc25e6f50657d511b5856a77aac", size = 64504, upload-time = "2026-06-18T16:13:08.822Z" }, { url = "https://files.pythonhosted.org/packages/57/7f/ce1e377df7e62461fefd9eb23bfb93a4a523f40a517b377b8f844d836828/msgpack-1.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:5c24aa15d5963051e1a5c62b12c50cd705992502b5ec1f3bece6046f33c9fc24", size = 71421, upload-time = "2026-06-18T16:13:09.828Z" }, { url = "https://files.pythonhosted.org/packages/8f/32/ebfe84c9929f08f188d56c7a2fd913406a9ddad76a634697c1c43b8112e6/msgpack-1.2.1-cp312-cp312-win_arm64.whl", hash = "sha256:4227224aaec8f7fbcbfbd4272319347b2bb4030366502600f8c45588c5187b07", size = 64775, upload-time = "2026-06-18T16:13:11.056Z" }, { url = "https://files.pythonhosted.org/packages/b0/ac/dcddcab6f6c20ecb387ca5e980371cdb3f87ff69aeca388be97eebc4c074/msgpack-1.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:0a70e3cf2804a300d921bb0940426e35f4e489a23adfb77a808892241db0a064", size = 83151, upload-time = "2026-06-18T16:13:12.173Z" }, { url = "https://files.pythonhosted.org/packages/64/71/fbcfa83a1d6a9c6091942d1cfd070962244664b87427a9a49a6897b1b219/msgpack-1.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:491cc39455ca765fad51fb451bf2915eb2cf41192ab5801ce8d67c1d614fe056", size = 82351, upload-time = "2026-06-18T16:13:13.194Z" }, { url = "https://files.pythonhosted.org/packages/e3/10/ddf7b06db879e8792d13934ddda09ff20bd2a583fd84c9b59aae9b0e650b/msgpack-1.2.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f310233ef7fb9c14e201c93639fe5f5260b005f56f0b29048e999c30935596cc", size = 407518, upload-time = "2026-06-18T16:13:14.233Z" }, { url = "https://files.pythonhosted.org/packages/79/d3/36a46a8ed992b781acbc05928bd5bee3c810cb0c3563bf81a7b0c04a1a76/msgpack-1.2.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:787c9bebb5833e8f6fc8abca3c0597683d8d87f56a8842b6b89c75a5f3176e2d", size = 416405, upload-time = "2026-06-18T16:13:15.435Z" }, { url = "https://files.pythonhosted.org/packages/f9/84/e8e9598b557c0ba6ddae901a73780a4c75ac667dddf59414b1e56a42fb34/msgpack-1.2.1-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:dc871b997a9370d855b7394465f2f350e847a5b806dd38dcc9c989e7d87da155", size = 376257, upload-time = "2026-06-18T16:13:17.022Z" }, { url = "https://files.pythonhosted.org/packages/40/16/738fe6d875ad7e2a9429c165322a4ec088f4f273cdfae63d96a89c467961/msgpack-1.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:85f57e960d877f2977f6430896191b04a21f8901b3b4baf2e4604329f4db5402", size = 397469, upload-time = "2026-06-18T16:13:18.287Z" }, { url = "https://files.pythonhosted.org/packages/ca/be/6d5952df75a7f24f35833af764c3a6860780364cb3a0030beb8099e1b2b4/msgpack-1.2.1-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:1233ee2dd0cefba127583de50ea654677277047d238303521db35def3d7b2e7c", size = 372802, upload-time = "2026-06-18T16:13:19.685Z" }, { url = "https://files.pythonhosted.org/packages/e1/39/e2ef7dbf0473bcb8dc7c50bf782a892d67414877b63e47fc88eb189ef5e6/msgpack-1.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:e3dc2feb0876209d9c38aa56cb1de169bd6c4348f1aa48271f241226590993e6", size = 411273, upload-time = "2026-06-18T16:13:21.028Z" }, { url = "https://files.pythonhosted.org/packages/ef/c5/133f4512a56e983a93445c836c9d94d88f3bc2e0980ff4b9e577bd8416ce/msgpack-1.2.1-cp313-cp313-win32.whl", hash = "sha256:6d09badf350af2be9d189184e04e64cf54ad93569ab3d96fca58bd3e84aad707", size = 64471, upload-time = "2026-06-18T16:13:22.293Z" }, { url = "https://files.pythonhosted.org/packages/e2/98/577e10b055096a7dd40732358cabaf7180a20c79ed1dcdbb618e4b9deac7/msgpack-1.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:33f14fba63278b714efe6ad07e50ea5f03d91537aa6a1c5f1ceca4cf44013ca9", size = 71274, upload-time = "2026-06-18T16:13:23.455Z" }, { url = "https://files.pythonhosted.org/packages/ba/ee/0c0048e7cfbef23c6a94791b8959ab28155232e7956de8a305b5ff588f05/msgpack-1.2.1-cp313-cp313-win_arm64.whl", hash = "sha256:afc5febcd4c99effbc02b528e49d6fd0760b2b7d48c05239e345a5fa6e743d9a", size = 64795, upload-time = "2026-06-18T16:13:24.687Z" }, { url = "https://files.pythonhosted.org/packages/77/58/cce442852c6b9e1639c7c8ac8fd9143121cb32dab0f308df4d1426a8eb9c/msgpack-1.2.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:05f340e47e7e47d2da8db9b53e1bb1d294369e9ef45a747441309f6650b8351d", size = 83610, upload-time = "2026-06-18T16:13:25.724Z" }, { url = "https://files.pythonhosted.org/packages/60/5c/15b4c7a0182f75ffa90751958ba36a9c01cafee367d49a3edc10ed140b01/msgpack-1.2.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:810b916696c86ef0deb3b74588480224df4c1b071136c34183e4a2a4284d7ac7", size = 83138, upload-time = "2026-06-18T16:13:26.781Z" }, { url = "https://files.pythonhosted.org/packages/b8/a6/99e58722feaffc5f2fbcc0c8c0d1451ab9f84097f7af87291b46af2390f4/msgpack-1.2.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ca0dacff965c47afdc3749a8469d7302a8f801d6a28758d55120d75e66ce6889", size = 406090, upload-time = "2026-06-18T16:13:28.072Z" }, { url = "https://files.pythonhosted.org/packages/19/03/8c63e8cf52958534ef688625965ab04c269a6cadd8caef16758b380a821a/msgpack-1.2.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e2bf9280bceb5efca998435904b5d3e9fdbcc11d90dc9df30aec7973252b720", size = 412106, upload-time = "2026-06-18T16:13:29.427Z" }, { url = "https://files.pythonhosted.org/packages/63/d2/155d9e71b40e41fd934bc0c48b9b2770f22263e1ac20aad8e29fdca7be3f/msgpack-1.2.1-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:aa6c4be5d1c02a42b066ca6ddb71adf36432868fdcdb6ee87e634e86e0674190", size = 374851, upload-time = "2026-06-18T16:13:30.631Z" }, { url = "https://files.pythonhosted.org/packages/98/48/deaf2326262a8d5ea3295ce9649912ecd3f551ba7ec8e33c665d2ba583f3/msgpack-1.2.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:ec0e675d59150a6269ddc9139087c722292664a37d071a849c05c473350f1f2d", size = 396168, upload-time = "2026-06-18T16:13:31.977Z" }, { url = "https://files.pythonhosted.org/packages/10/2a/b4410f906c2ec0008f1608d3ab5143afc3ad3f4e6da0fed3ea2231d0bef4/msgpack-1.2.1-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:dd3bfe82d53edfe4b7fc9a7ec9761e23a7a5b1dac22264505af428253c29ed24", size = 371959, upload-time = "2026-06-18T16:13:33.282Z" }, { url = "https://files.pythonhosted.org/packages/59/86/1edc67270099a528fa2093ea60fe191233cd238e4bd30cfacf7db79fc959/msgpack-1.2.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:5ad5467fc3f68b5468e06c5f788d712e9f8ffc8b0cd1bcb160c105c1ee92dae7", size = 408457, upload-time = "2026-06-18T16:13:34.567Z" }, { url = "https://files.pythonhosted.org/packages/82/90/8b630fef07d8c5ab457b71ff2c217910c83d333c7a68472c186e87cc504a/msgpack-1.2.1-cp314-cp314-win32.whl", hash = "sha256:98b58bdb89c46190e4609bb36abe17c6d4105ad13f9c5f8f6f64d320f8ced3fb", size = 65942, upload-time = "2026-06-18T16:13:36.056Z" }, { url = "https://files.pythonhosted.org/packages/16/f1/467b81e98b24dd3885d7b1857728797b4ffc76a7a7483af4fb321a07de3c/msgpack-1.2.1-cp314-cp314-win_amd64.whl", hash = "sha256:74847557e28ce71bd3c438a447ca90e4b507e997ddbdef8a12a7b283b86c156b", size = 72627, upload-time = "2026-06-18T16:13:37.079Z" }, { url = "https://files.pythonhosted.org/packages/a7/1d/5d8c4c89985feb6acefb82a09e501c60392261856d2408d20bfe4f0360b1/msgpack-1.2.1-cp314-cp314-win_arm64.whl", hash = "sha256:b50b727bd652bdc37d950336c848ef20ec54a4cafc38dce19b1cd86ad625d0f7", size = 66908, upload-time = "2026-06-18T16:13:38.23Z" }, { url = "https://files.pythonhosted.org/packages/1b/02/ad2afb678b4de94496cd432b581759b756a92c1192d8c767edd6b132efdc/msgpack-1.2.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:8d00f177ca88a77c1cf848d204a38f249751650b601cb6532acc68805d8a8273", size = 86000, upload-time = "2026-06-18T16:13:39.44Z" }, { url = "https://files.pythonhosted.org/packages/54/74/0b797484013128837f3b1cbb6cea019277c4de4e377dc512b4d9a0f92940/msgpack-1.2.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:5bb9c386f0a329c035ddbab4b72d1028bf9627add8dda41070288563d57ed1b1", size = 86544, upload-time = "2026-06-18T16:13:40.447Z" }, { url = "https://files.pythonhosted.org/packages/a9/b4/b774d7eb95561739907fec675582f83203cf41c597a418c2589b4bfb8e9d/msgpack-1.2.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:20466cca18c49c7292a8984bc15d65857b171e7264bdcb5f96baf8be238791fc", size = 427661, upload-time = "2026-06-18T16:13:41.574Z" }, { url = "https://files.pythonhosted.org/packages/b2/f9/3243191dc9937e00756c8bc1b0272fed8f23758e43df2a3b46f533e5090f/msgpack-1.2.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:196300e7e5d6e74d50f1607ab9c06c4a1484c383cd22defd727902591f7e8dde", size = 426375, upload-time = "2026-06-18T16:13:42.936Z" }, { url = "https://files.pythonhosted.org/packages/23/c7/1693111db9944ba4ad4b67a1e788400d78a0b6af7a6523dc7e4e58f8274b/msgpack-1.2.1-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:575957e79cd51903a4e8495a242442949641e08f1efd5197b43bebd3ea7682b4", size = 380495, upload-time = "2026-06-18T16:13:44.306Z" }, { url = "https://files.pythonhosted.org/packages/3e/2b/92f86956a0c13e8662f7e2ad630c4eb4db07497b967589bd5245e018b2c1/msgpack-1.2.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8c2ed1e48cc0f460bf3c7780e7137ff21a4e18433451916f2442c1b21036cd7d", size = 410897, upload-time = "2026-06-18T16:13:45.629Z" }, { url = "https://files.pythonhosted.org/packages/da/ea/1479f72d200313a76fc2f823a79d1e07ed052ab7b8a0280640aa7b95de42/msgpack-1.2.1-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:5f6277e5f783c36786a145e0247fc189a03f35f84b251646e53592d2bc12b355", size = 378519, upload-time = "2026-06-18T16:13:46.998Z" }, { url = "https://files.pythonhosted.org/packages/f5/4d/fa006060ffa1011d32bfae826fe766fe73e02982183601633b7121058ab3/msgpack-1.2.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:f9389552ecf4784886345ead0647e4edc96bee37cbab05b75540f542f766c48c", size = 419815, upload-time = "2026-06-18T16:13:48.205Z" }, { url = "https://files.pythonhosted.org/packages/2f/e1/aab6c946570496b78e67804721f3d5e2d62a93081b9b37df77764ef56347/msgpack-1.2.1-cp314-cp314t-win32.whl", hash = "sha256:c1c79a604a2969a868a78b6ebd27a887e00c624f14f66b3038e0590cb23332d1", size = 70914, upload-time = "2026-06-18T16:13:49.385Z" }, { url = "https://files.pythonhosted.org/packages/13/0a/e608956488a2af014cfe6e3d665e090b8ee42aa14b07f8f95b8880d66b09/msgpack-1.2.1-cp314-cp314t-win_amd64.whl", hash = "sha256:f12038a35fabd52e56a3547bab42401af49a45caa6dd00b34c44de235bc93ee2", size = 77999, upload-time = "2026-06-18T16:13:50.467Z" }, { url = "https://files.pythonhosted.org/packages/d2/8a/27e2e57055176e366a46b85d02d68e7a5bcfbdd8474c9706375d965f24d3/msgpack-1.2.1-cp314-cp314t-win_arm64.whl", hash = "sha256:0adcf06ffde0777c0e1a9b771a2b1c4226ba1bbf748c8efcc02fcdeca3299107", size = 71160, upload-time = "2026-06-18T16:13:51.498Z" }, ] [[package]] name = "multidict" version = "6.7.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/1a/c2/c2d94cbe6ac1753f3fc980da97b3d930efe1da3af3c9f5125354436c073d/multidict-6.7.1.tar.gz", hash = "sha256:ec6652a1bee61c53a3e5776b6049172c53b6aaba34f18c9ad04f82712bac623d", size = 102010, upload-time = "2026-01-26T02:46:45.979Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/8d/9c/f20e0e2cf80e4b2e4b1c365bf5fe104ee633c751a724246262db8f1a0b13/multidict-6.7.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:a90f75c956e32891a4eda3639ce6dd86e87105271f43d43442a3aedf3cddf172", size = 76893, upload-time = "2026-01-26T02:43:52.754Z" }, { url = "https://files.pythonhosted.org/packages/fe/cf/18ef143a81610136d3da8193da9d80bfe1cb548a1e2d1c775f26b23d024a/multidict-6.7.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:3fccb473e87eaa1382689053e4a4618e7ba7b9b9b8d6adf2027ee474597128cd", size = 45456, upload-time = "2026-01-26T02:43:53.893Z" }, { url = "https://files.pythonhosted.org/packages/a9/65/1caac9d4cd32e8433908683446eebc953e82d22b03d10d41a5f0fefe991b/multidict-6.7.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:b0fa96985700739c4c7853a43c0b3e169360d6855780021bfc6d0f1ce7c123e7", size = 43872, upload-time = "2026-01-26T02:43:55.041Z" }, { url = "https://files.pythonhosted.org/packages/cf/3b/d6bd75dc4f3ff7c73766e04e705b00ed6dbbaccf670d9e05a12b006f5a21/multidict-6.7.1-cp312-cp312-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:cb2a55f408c3043e42b40cc8eecd575afa27b7e0b956dfb190de0f8499a57a53", size = 251018, upload-time = "2026-01-26T02:43:56.198Z" }, { url = "https://files.pythonhosted.org/packages/fd/80/c959c5933adedb9ac15152e4067c702a808ea183a8b64cf8f31af8ad3155/multidict-6.7.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:eb0ce7b2a32d09892b3dd6cc44877a0d02a33241fafca5f25c8b6b62374f8b75", size = 258883, upload-time = "2026-01-26T02:43:57.499Z" }, { url = "https://files.pythonhosted.org/packages/86/85/7ed40adafea3d4f1c8b916e3b5cc3a8e07dfcdcb9cd72800f4ed3ca1b387/multidict-6.7.1-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:c3a32d23520ee37bf327d1e1a656fec76a2edd5c038bf43eddfa0572ec49c60b", size = 242413, upload-time = "2026-01-26T02:43:58.755Z" }, { url = "https://files.pythonhosted.org/packages/d2/57/b8565ff533e48595503c785f8361ff9a4fde4d67de25c207cd0ba3befd03/multidict-6.7.1-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:9c90fed18bffc0189ba814749fdcc102b536e83a9f738a9003e569acd540a733", size = 268404, upload-time = "2026-01-26T02:44:00.216Z" }, { url = "https://files.pythonhosted.org/packages/e0/50/9810c5c29350f7258180dfdcb2e52783a0632862eb334c4896ac717cebcb/multidict-6.7.1-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:da62917e6076f512daccfbbde27f46fed1c98fee202f0559adec8ee0de67f71a", size = 269456, upload-time = "2026-01-26T02:44:02.202Z" }, { url = "https://files.pythonhosted.org/packages/f3/8d/5e5be3ced1d12966fefb5c4ea3b2a5b480afcea36406559442c6e31d4a48/multidict-6.7.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bfde23ef6ed9db7eaee6c37dcec08524cb43903c60b285b172b6c094711b3961", size = 256322, upload-time = "2026-01-26T02:44:03.56Z" }, { url = "https://files.pythonhosted.org/packages/31/6e/d8a26d81ac166a5592782d208dd90dfdc0a7a218adaa52b45a672b46c122/multidict-6.7.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3758692429e4e32f1ba0df23219cd0b4fc0a52f476726fff9337d1a57676a582", size = 253955, upload-time = "2026-01-26T02:44:04.845Z" }, { url = "https://files.pythonhosted.org/packages/59/4c/7c672c8aad41534ba619bcd4ade7a0dc87ed6b8b5c06149b85d3dd03f0cd/multidict-6.7.1-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:398c1478926eca669f2fd6a5856b6de9c0acf23a2cb59a14c0ba5844fa38077e", size = 251254, upload-time = "2026-01-26T02:44:06.133Z" }, { url = "https://files.pythonhosted.org/packages/7b/bd/84c24de512cbafbdbc39439f74e967f19570ce7924e3007174a29c348916/multidict-6.7.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:c102791b1c4f3ab36ce4101154549105a53dc828f016356b3e3bcae2e3a039d3", size = 252059, upload-time = "2026-01-26T02:44:07.518Z" }, { url = "https://files.pythonhosted.org/packages/fa/ba/f5449385510825b73d01c2d4087bf6d2fccc20a2d42ac34df93191d3dd03/multidict-6.7.1-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:a088b62bd733e2ad12c50dad01b7d0166c30287c166e137433d3b410add807a6", size = 263588, upload-time = "2026-01-26T02:44:09.382Z" }, { url = "https://files.pythonhosted.org/packages/d7/11/afc7c677f68f75c84a69fe37184f0f82fce13ce4b92f49f3db280b7e92b3/multidict-6.7.1-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:3d51ff4785d58d3f6c91bdbffcb5e1f7ddfda557727043aa20d20ec4f65e324a", size = 259642, upload-time = "2026-01-26T02:44:10.73Z" }, { url = "https://files.pythonhosted.org/packages/2b/17/ebb9644da78c4ab36403739e0e6e0e30ebb135b9caf3440825001a0bddcb/multidict-6.7.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:fc5907494fccf3e7d3f94f95c91d6336b092b5fc83811720fae5e2765890dfba", size = 251377, upload-time = "2026-01-26T02:44:12.042Z" }, { url = "https://files.pythonhosted.org/packages/ca/a4/840f5b97339e27846c46307f2530a2805d9d537d8b8bd416af031cad7fa0/multidict-6.7.1-cp312-cp312-win32.whl", hash = "sha256:28ca5ce2fd9716631133d0e9a9b9a745ad7f60bac2bccafb56aa380fc0b6c511", size = 41887, upload-time = "2026-01-26T02:44:14.245Z" }, { url = "https://files.pythonhosted.org/packages/80/31/0b2517913687895f5904325c2069d6a3b78f66cc641a86a2baf75a05dcbb/multidict-6.7.1-cp312-cp312-win_amd64.whl", hash = "sha256:fcee94dfbd638784645b066074b338bc9cc155d4b4bffa4adce1615c5a426c19", size = 46053, upload-time = "2026-01-26T02:44:15.371Z" }, { url = "https://files.pythonhosted.org/packages/0c/5b/aba28e4ee4006ae4c7df8d327d31025d760ffa992ea23812a601d226e682/multidict-6.7.1-cp312-cp312-win_arm64.whl", hash = "sha256:ba0a9fb644d0c1a2194cf7ffb043bd852cea63a57f66fbd33959f7dae18517bf", size = 43307, upload-time = "2026-01-26T02:44:16.852Z" }, { url = "https://files.pythonhosted.org/packages/f2/22/929c141d6c0dba87d3e1d38fbdf1ba8baba86b7776469f2bc2d3227a1e67/multidict-6.7.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:2b41f5fed0ed563624f1c17630cb9941cf2309d4df00e494b551b5f3e3d67a23", size = 76174, upload-time = "2026-01-26T02:44:18.509Z" }, { url = "https://files.pythonhosted.org/packages/c7/75/bc704ae15fee974f8fccd871305e254754167dce5f9e42d88a2def741a1d/multidict-6.7.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84e61e3af5463c19b67ced91f6c634effb89ef8bfc5ca0267f954451ed4bb6a2", size = 45116, upload-time = "2026-01-26T02:44:19.745Z" }, { url = "https://files.pythonhosted.org/packages/79/76/55cd7186f498ed080a18440c9013011eb548f77ae1b297206d030eb1180a/multidict-6.7.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:935434b9853c7c112eee7ac891bc4cb86455aa631269ae35442cb316790c1445", size = 43524, upload-time = "2026-01-26T02:44:21.571Z" }, { url = "https://files.pythonhosted.org/packages/e9/3c/414842ef8d5a1628d68edee29ba0e5bcf235dbfb3ccd3ea303a7fe8c72ff/multidict-6.7.1-cp313-cp313-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:432feb25a1cb67fe82a9680b4d65fb542e4635cb3166cd9c01560651ad60f177", size = 249368, upload-time = "2026-01-26T02:44:22.803Z" }, { url = "https://files.pythonhosted.org/packages/f6/32/befed7f74c458b4a525e60519fe8d87eef72bb1e99924fa2b0f9d97a221e/multidict-6.7.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:e82d14e3c948952a1a85503817e038cba5905a3352de76b9a465075d072fba23", size = 256952, upload-time = "2026-01-26T02:44:24.306Z" }, { url = "https://files.pythonhosted.org/packages/03/d6/c878a44ba877f366630c860fdf74bfb203c33778f12b6ac274936853c451/multidict-6.7.1-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:4cfb48c6ea66c83bcaaf7e4dfa7ec1b6bbcf751b7db85a328902796dfde4c060", size = 240317, upload-time = "2026-01-26T02:44:25.772Z" }, { url = "https://files.pythonhosted.org/packages/68/49/57421b4d7ad2e9e60e25922b08ceb37e077b90444bde6ead629095327a6f/multidict-6.7.1-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:1d540e51b7e8e170174555edecddbd5538105443754539193e3e1061864d444d", size = 267132, upload-time = "2026-01-26T02:44:27.648Z" }, { url = "https://files.pythonhosted.org/packages/b7/fe/ec0edd52ddbcea2a2e89e174f0206444a61440b40f39704e64dc807a70bd/multidict-6.7.1-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:273d23f4b40f3dce4d6c8a821c741a86dec62cded82e1175ba3d99be128147ed", size = 268140, upload-time = "2026-01-26T02:44:29.588Z" }, { url = "https://files.pythonhosted.org/packages/b0/73/6e1b01cbeb458807aa0831742232dbdd1fa92bfa33f52a3f176b4ff3dc11/multidict-6.7.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9d624335fd4fa1c08a53f8b4be7676ebde19cd092b3895c421045ca87895b429", size = 254277, upload-time = "2026-01-26T02:44:30.902Z" }, { url = "https://files.pythonhosted.org/packages/6a/b2/5fb8c124d7561a4974c342bc8c778b471ebbeb3cc17df696f034a7e9afe7/multidict-6.7.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:12fad252f8b267cc75b66e8fc51b3079604e8d43a75428ffe193cd9e2195dfd6", size = 252291, upload-time = "2026-01-26T02:44:32.31Z" }, { url = "https://files.pythonhosted.org/packages/5a/96/51d4e4e06bcce92577fcd488e22600bd38e4fd59c20cb49434d054903bd2/multidict-6.7.1-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:03ede2a6ffbe8ef936b92cb4529f27f42be7f56afcdab5ab739cd5f27fb1cbf9", size = 250156, upload-time = "2026-01-26T02:44:33.734Z" }, { url = "https://files.pythonhosted.org/packages/db/6b/420e173eec5fba721a50e2a9f89eda89d9c98fded1124f8d5c675f7a0c0f/multidict-6.7.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:90efbcf47dbe33dcf643a1e400d67d59abeac5db07dc3f27d6bdeae497a2198c", size = 249742, upload-time = "2026-01-26T02:44:35.222Z" }, { url = "https://files.pythonhosted.org/packages/44/a3/ec5b5bd98f306bc2aa297b8c6f11a46714a56b1e6ef5ebda50a4f5d7c5fb/multidict-6.7.1-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:5c4b9bfc148f5a91be9244d6264c53035c8a0dcd2f51f1c3c6e30e30ebaa1c84", size = 262221, upload-time = "2026-01-26T02:44:36.604Z" }, { url = "https://files.pythonhosted.org/packages/cd/f7/e8c0d0da0cd1e28d10e624604e1a36bcc3353aaebdfdc3a43c72bc683a12/multidict-6.7.1-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:401c5a650f3add2472d1d288c26deebc540f99e2fb83e9525007a74cd2116f1d", size = 258664, upload-time = "2026-01-26T02:44:38.008Z" }, { url = "https://files.pythonhosted.org/packages/52/da/151a44e8016dd33feed44f730bd856a66257c1ee7aed4f44b649fb7edeb3/multidict-6.7.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:97891f3b1b3ffbded884e2916cacf3c6fc87b66bb0dde46f7357404750559f33", size = 249490, upload-time = "2026-01-26T02:44:39.386Z" }, { url = "https://files.pythonhosted.org/packages/87/af/a3b86bf9630b732897f6fc3f4c4714b90aa4361983ccbdcd6c0339b21b0c/multidict-6.7.1-cp313-cp313-win32.whl", hash = "sha256:e1c5988359516095535c4301af38d8a8838534158f649c05dd1050222321bcb3", size = 41695, upload-time = "2026-01-26T02:44:41.318Z" }, { url = "https://files.pythonhosted.org/packages/b2/35/e994121b0e90e46134673422dd564623f93304614f5d11886b1b3e06f503/multidict-6.7.1-cp313-cp313-win_amd64.whl", hash = "sha256:960c83bf01a95b12b08fd54324a4eb1d5b52c88932b5cba5d6e712bb3ed12eb5", size = 45884, upload-time = "2026-01-26T02:44:42.488Z" }, { url = "https://files.pythonhosted.org/packages/ca/61/42d3e5dbf661242a69c97ea363f2d7b46c567da8eadef8890022be6e2ab0/multidict-6.7.1-cp313-cp313-win_arm64.whl", hash = "sha256:563fe25c678aaba333d5399408f5ec3c383ca5b663e7f774dd179a520b8144df", size = 43122, upload-time = "2026-01-26T02:44:43.664Z" }, { url = "https://files.pythonhosted.org/packages/6d/b3/e6b21c6c4f314bb956016b0b3ef2162590a529b84cb831c257519e7fde44/multidict-6.7.1-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:c76c4bec1538375dad9d452d246ca5368ad6e1c9039dadcf007ae59c70619ea1", size = 83175, upload-time = "2026-01-26T02:44:44.894Z" }, { url = "https://files.pythonhosted.org/packages/fb/76/23ecd2abfe0957b234f6c960f4ade497f55f2c16aeb684d4ecdbf1c95791/multidict-6.7.1-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:57b46b24b5d5ebcc978da4ec23a819a9402b4228b8a90d9c656422b4bdd8a963", size = 48460, upload-time = "2026-01-26T02:44:46.106Z" }, { url = "https://files.pythonhosted.org/packages/c4/57/a0ed92b23f3a042c36bc4227b72b97eca803f5f1801c1ab77c8a212d455e/multidict-6.7.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:e954b24433c768ce78ab7929e84ccf3422e46deb45a4dc9f93438f8217fa2d34", size = 46930, upload-time = "2026-01-26T02:44:47.278Z" }, { url = "https://files.pythonhosted.org/packages/b5/66/02ec7ace29162e447f6382c495dc95826bf931d3818799bbef11e8f7df1a/multidict-6.7.1-cp313-cp313t-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:3bd231490fa7217cc832528e1cd8752a96f0125ddd2b5749390f7c3ec8721b65", size = 242582, upload-time = "2026-01-26T02:44:48.604Z" }, { url = "https://files.pythonhosted.org/packages/58/18/64f5a795e7677670e872673aca234162514696274597b3708b2c0d276cce/multidict-6.7.1-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:253282d70d67885a15c8a7716f3a73edf2d635793ceda8173b9ecc21f2fb8292", size = 250031, upload-time = "2026-01-26T02:44:50.544Z" }, { url = "https://files.pythonhosted.org/packages/c8/ed/e192291dbbe51a8290c5686f482084d31bcd9d09af24f63358c3d42fd284/multidict-6.7.1-cp313-cp313t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:0b4c48648d7649c9335cf1927a8b87fa692de3dcb15faa676c6a6f1f1aabda43", size = 228596, upload-time = "2026-01-26T02:44:51.951Z" }, { url = "https://files.pythonhosted.org/packages/1e/7e/3562a15a60cf747397e7f2180b0a11dc0c38d9175a650e75fa1b4d325e15/multidict-6.7.1-cp313-cp313t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:98bc624954ec4d2c7cb074b8eefc2b5d0ce7d482e410df446414355d158fe4ca", size = 257492, upload-time = "2026-01-26T02:44:53.902Z" }, { url = "https://files.pythonhosted.org/packages/24/02/7d0f9eae92b5249bb50ac1595b295f10e263dd0078ebb55115c31e0eaccd/multidict-6.7.1-cp313-cp313t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:1b99af4d9eec0b49927b4402bcbb58dea89d3e0db8806a4086117019939ad3dd", size = 255899, upload-time = "2026-01-26T02:44:55.316Z" }, { url = "https://files.pythonhosted.org/packages/00/e3/9b60ed9e23e64c73a5cde95269ef1330678e9c6e34dd4eb6b431b85b5a10/multidict-6.7.1-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6aac4f16b472d5b7dc6f66a0d49dd57b0e0902090be16594dc9ebfd3d17c47e7", size = 247970, upload-time = "2026-01-26T02:44:56.783Z" }, { url = "https://files.pythonhosted.org/packages/3e/06/538e58a63ed5cfb0bd4517e346b91da32fde409d839720f664e9a4ae4f9d/multidict-6.7.1-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:21f830fe223215dffd51f538e78c172ed7c7f60c9b96a2bf05c4848ad49921c3", size = 245060, upload-time = "2026-01-26T02:44:58.195Z" }, { url = "https://files.pythonhosted.org/packages/b2/2f/d743a3045a97c895d401e9bd29aaa09b94f5cbdf1bd561609e5a6c431c70/multidict-6.7.1-cp313-cp313t-musllinux_1_2_armv7l.whl", hash = "sha256:f5dd81c45b05518b9aa4da4aa74e1c93d715efa234fd3e8a179df611cc85e5f4", size = 235888, upload-time = "2026-01-26T02:44:59.57Z" }, { url = "https://files.pythonhosted.org/packages/38/83/5a325cac191ab28b63c52f14f1131f3b0a55ba3b9aa65a6d0bf2a9b921a0/multidict-6.7.1-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:eb304767bca2bb92fb9c5bd33cedc95baee5bb5f6c88e63706533a1c06ad08c8", size = 243554, upload-time = "2026-01-26T02:45:01.054Z" }, { url = "https://files.pythonhosted.org/packages/20/1f/9d2327086bd15da2725ef6aae624208e2ef828ed99892b17f60c344e57ed/multidict-6.7.1-cp313-cp313t-musllinux_1_2_ppc64le.whl", hash = "sha256:c9035dde0f916702850ef66460bc4239d89d08df4d02023a5926e7446724212c", size = 252341, upload-time = "2026-01-26T02:45:02.484Z" }, { url = "https://files.pythonhosted.org/packages/e8/2c/2a1aa0280cf579d0f6eed8ee5211c4f1730bd7e06c636ba2ee6aafda302e/multidict-6.7.1-cp313-cp313t-musllinux_1_2_s390x.whl", hash = "sha256:af959b9beeb66c822380f222f0e0a1889331597e81f1ded7f374f3ecb0fd6c52", size = 246391, upload-time = "2026-01-26T02:45:03.862Z" }, { url = "https://files.pythonhosted.org/packages/e5/03/7ca022ffc36c5a3f6e03b179a5ceb829be9da5783e6fe395f347c0794680/multidict-6.7.1-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:41f2952231456154ee479651491e94118229844dd7226541788be783be2b5108", size = 243422, upload-time = "2026-01-26T02:45:05.296Z" }, { url = "https://files.pythonhosted.org/packages/dc/1d/b31650eab6c5778aceed46ba735bd97f7c7d2f54b319fa916c0f96e7805b/multidict-6.7.1-cp313-cp313t-win32.whl", hash = "sha256:df9f19c28adcb40b6aae30bbaa1478c389efd50c28d541d76760199fc1037c32", size = 47770, upload-time = "2026-01-26T02:45:06.754Z" }, { url = "https://files.pythonhosted.org/packages/ac/5b/2d2d1d522e51285bd61b1e20df8f47ae1a9d80839db0b24ea783b3832832/multidict-6.7.1-cp313-cp313t-win_amd64.whl", hash = "sha256:d54ecf9f301853f2c5e802da559604b3e95bb7a3b01a9c295c6ee591b9882de8", size = 53109, upload-time = "2026-01-26T02:45:08.044Z" }, { url = "https://files.pythonhosted.org/packages/3d/a3/cc409ba012c83ca024a308516703cf339bdc4b696195644a7215a5164a24/multidict-6.7.1-cp313-cp313t-win_arm64.whl", hash = "sha256:5a37ca18e360377cfda1d62f5f382ff41f2b8c4ccb329ed974cc2e1643440118", size = 45573, upload-time = "2026-01-26T02:45:09.349Z" }, { url = "https://files.pythonhosted.org/packages/91/cc/db74228a8be41884a567e88a62fd589a913708fcf180d029898c17a9a371/multidict-6.7.1-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:8f333ec9c5eb1b7105e3b84b53141e66ca05a19a605368c55450b6ba208cb9ee", size = 75190, upload-time = "2026-01-26T02:45:10.651Z" }, { url = "https://files.pythonhosted.org/packages/d5/22/492f2246bb5b534abd44804292e81eeaf835388901f0c574bac4eeec73c5/multidict-6.7.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:a407f13c188f804c759fc6a9f88286a565c242a76b27626594c133b82883b5c2", size = 44486, upload-time = "2026-01-26T02:45:11.938Z" }, { url = "https://files.pythonhosted.org/packages/f1/4f/733c48f270565d78b4544f2baddc2fb2a245e5a8640254b12c36ac7ac68e/multidict-6.7.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:0e161ddf326db5577c3a4cc2d8648f81456e8a20d40415541587a71620d7a7d1", size = 43219, upload-time = "2026-01-26T02:45:14.346Z" }, { url = "https://files.pythonhosted.org/packages/24/bb/2c0c2287963f4259c85e8bcbba9182ced8d7fca65c780c38e99e61629d11/multidict-6.7.1-cp314-cp314-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:1e3a8bb24342a8201d178c3b4984c26ba81a577c80d4d525727427460a50c22d", size = 245132, upload-time = "2026-01-26T02:45:15.712Z" }, { url = "https://files.pythonhosted.org/packages/a7/f9/44d4b3064c65079d2467888794dea218d1601898ac50222ab8a9a8094460/multidict-6.7.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:97231140a50f5d447d3164f994b86a0bed7cd016e2682f8650d6a9158e14fd31", size = 252420, upload-time = "2026-01-26T02:45:17.293Z" }, { url = "https://files.pythonhosted.org/packages/8b/13/78f7275e73fa17b24c9a51b0bd9d73ba64bb32d0ed51b02a746eb876abe7/multidict-6.7.1-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:6b10359683bd8806a200fd2909e7c8ca3a7b24ec1d8132e483d58e791d881048", size = 233510, upload-time = "2026-01-26T02:45:19.356Z" }, { url = "https://files.pythonhosted.org/packages/4b/25/8167187f62ae3cbd52da7893f58cb036b47ea3fb67138787c76800158982/multidict-6.7.1-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:283ddac99f7ac25a4acadbf004cb5ae34480bbeb063520f70ce397b281859362", size = 264094, upload-time = "2026-01-26T02:45:20.834Z" }, { url = "https://files.pythonhosted.org/packages/a1/e7/69a3a83b7b030cf283fb06ce074a05a02322359783424d7edf0f15fe5022/multidict-6.7.1-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:538cec1e18c067d0e6103aa9a74f9e832904c957adc260e61cd9d8cf0c3b3d37", size = 260786, upload-time = "2026-01-26T02:45:22.818Z" }, { url = "https://files.pythonhosted.org/packages/fe/3b/8ec5074bcfc450fe84273713b4b0a0dd47c0249358f5d82eb8104ffe2520/multidict-6.7.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7eee46ccb30ff48a1e35bb818cc90846c6be2b68240e42a78599166722cea709", size = 248483, upload-time = "2026-01-26T02:45:24.368Z" }, { url = "https://files.pythonhosted.org/packages/48/5a/d5a99e3acbca0e29c5d9cba8f92ceb15dce78bab963b308ae692981e3a5d/multidict-6.7.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:fa263a02f4f2dd2d11a7b1bb4362aa7cb1049f84a9235d31adf63f30143469a0", size = 248403, upload-time = "2026-01-26T02:45:25.982Z" }, { url = "https://files.pythonhosted.org/packages/35/48/e58cd31f6c7d5102f2a4bf89f96b9cf7e00b6c6f3d04ecc44417c00a5a3c/multidict-6.7.1-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:2e1425e2f99ec5bd36c15a01b690a1a2456209c5deed58f95469ffb46039ccbb", size = 240315, upload-time = "2026-01-26T02:45:27.487Z" }, { url = "https://files.pythonhosted.org/packages/94/33/1cd210229559cb90b6786c30676bb0c58249ff42f942765f88793b41fdce/multidict-6.7.1-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:497394b3239fc6f0e13a78a3e1b61296e72bf1c5f94b4c4eb80b265c37a131cd", size = 245528, upload-time = "2026-01-26T02:45:28.991Z" }, { url = "https://files.pythonhosted.org/packages/64/f2/6e1107d226278c876c783056b7db43d800bb64c6131cec9c8dfb6903698e/multidict-6.7.1-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:233b398c29d3f1b9676b4b6f75c518a06fcb2ea0b925119fb2c1bc35c05e1601", size = 258784, upload-time = "2026-01-26T02:45:30.503Z" }, { url = "https://files.pythonhosted.org/packages/4d/c1/11f664f14d525e4a1b5327a82d4de61a1db604ab34c6603bb3c2cc63ad34/multidict-6.7.1-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:93b1818e4a6e0930454f0f2af7dfce69307ca03cdcfb3739bf4d91241967b6c1", size = 251980, upload-time = "2026-01-26T02:45:32.603Z" }, { url = "https://files.pythonhosted.org/packages/e1/9f/75a9ac888121d0c5bbd4ecf4eead45668b1766f6baabfb3b7f66a410e231/multidict-6.7.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:f33dc2a3abe9249ea5d8360f969ec7f4142e7ac45ee7014d8f8d5acddf178b7b", size = 243602, upload-time = "2026-01-26T02:45:34.043Z" }, { url = "https://files.pythonhosted.org/packages/9a/e7/50bf7b004cc8525d80dbbbedfdc7aed3e4c323810890be4413e589074032/multidict-6.7.1-cp314-cp314-win32.whl", hash = "sha256:3ab8b9d8b75aef9df299595d5388b14530839f6422333357af1339443cff777d", size = 40930, upload-time = "2026-01-26T02:45:36.278Z" }, { url = "https://files.pythonhosted.org/packages/e0/bf/52f25716bbe93745595800f36fb17b73711f14da59ed0bb2eba141bc9f0f/multidict-6.7.1-cp314-cp314-win_amd64.whl", hash = "sha256:5e01429a929600e7dab7b166062d9bb54a5eed752384c7384c968c2afab8f50f", size = 45074, upload-time = "2026-01-26T02:45:37.546Z" }, { url = "https://files.pythonhosted.org/packages/97/ab/22803b03285fa3a525f48217963da3a65ae40f6a1b6f6cf2768879e208f9/multidict-6.7.1-cp314-cp314-win_arm64.whl", hash = "sha256:4885cb0e817aef5d00a2e8451d4665c1808378dc27c2705f1bf4ef8505c0d2e5", size = 42471, upload-time = "2026-01-26T02:45:38.889Z" }, { url = "https://files.pythonhosted.org/packages/e0/6d/f9293baa6146ba9507e360ea0292b6422b016907c393e2f63fc40ab7b7b5/multidict-6.7.1-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:0458c978acd8e6ea53c81eefaddbbee9c6c5e591f41b3f5e8e194780fe026581", size = 82401, upload-time = "2026-01-26T02:45:40.254Z" }, { url = "https://files.pythonhosted.org/packages/7a/68/53b5494738d83558d87c3c71a486504d8373421c3e0dbb6d0db48ad42ee0/multidict-6.7.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:c0abd12629b0af3cf590982c0b413b1e7395cd4ec026f30986818ab95bfaa94a", size = 48143, upload-time = "2026-01-26T02:45:41.635Z" }, { url = "https://files.pythonhosted.org/packages/37/e8/5284c53310dcdc99ce5d66563f6e5773531a9b9fe9ec7a615e9bc306b05f/multidict-6.7.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:14525a5f61d7d0c94b368a42cff4c9a4e7ba2d52e2672a7b23d84dc86fb02b0c", size = 46507, upload-time = "2026-01-26T02:45:42.99Z" }, { url = "https://files.pythonhosted.org/packages/e4/fc/6800d0e5b3875568b4083ecf5f310dcf91d86d52573160834fb4bfcf5e4f/multidict-6.7.1-cp314-cp314t-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:17307b22c217b4cf05033dabefe68255a534d637c6c9b0cc8382718f87be4262", size = 239358, upload-time = "2026-01-26T02:45:44.376Z" }, { url = "https://files.pythonhosted.org/packages/41/75/4ad0973179361cdf3a113905e6e088173198349131be2b390f9fa4da5fc6/multidict-6.7.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:7a7e590ff876a3eaf1c02a4dfe0724b6e69a9e9de6d8f556816f29c496046e59", size = 246884, upload-time = "2026-01-26T02:45:47.167Z" }, { url = "https://files.pythonhosted.org/packages/c3/9c/095bb28b5da139bd41fb9a5d5caff412584f377914bd8787c2aa98717130/multidict-6.7.1-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:5fa6a95dfee63893d80a34758cd0e0c118a30b8dcb46372bf75106c591b77889", size = 225878, upload-time = "2026-01-26T02:45:48.698Z" }, { url = "https://files.pythonhosted.org/packages/07/d0/c0a72000243756e8f5a277b6b514fa005f2c73d481b7d9e47cd4568aa2e4/multidict-6.7.1-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:a0543217a6a017692aa6ae5cc39adb75e587af0f3a82288b1492eb73dd6cc2a4", size = 253542, upload-time = "2026-01-26T02:45:50.164Z" }, { url = "https://files.pythonhosted.org/packages/c0/6b/f69da15289e384ecf2a68837ec8b5ad8c33e973aa18b266f50fe55f24b8c/multidict-6.7.1-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:f99fe611c312b3c1c0ace793f92464d8cd263cc3b26b5721950d977b006b6c4d", size = 252403, upload-time = "2026-01-26T02:45:51.779Z" }, { url = "https://files.pythonhosted.org/packages/a2/76/b9669547afa5a1a25cd93eaca91c0da1c095b06b6d2d8ec25b713588d3a1/multidict-6.7.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9004d8386d133b7e6135679424c91b0b854d2d164af6ea3f289f8f2761064609", size = 244889, upload-time = "2026-01-26T02:45:53.27Z" }, { url = "https://files.pythonhosted.org/packages/7e/a9/a50d2669e506dad33cfc45b5d574a205587b7b8a5f426f2fbb2e90882588/multidict-6.7.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:e628ef0e6859ffd8273c69412a2465c4be4a9517d07261b33334b5ec6f3c7489", size = 241982, upload-time = "2026-01-26T02:45:54.919Z" }, { url = "https://files.pythonhosted.org/packages/c5/bb/1609558ad8b456b4827d3c5a5b775c93b87878fd3117ed3db3423dfbce1b/multidict-6.7.1-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:841189848ba629c3552035a6a7f5bf3b02eb304e9fea7492ca220a8eda6b0e5c", size = 232415, upload-time = "2026-01-26T02:45:56.981Z" }, { url = "https://files.pythonhosted.org/packages/d8/59/6f61039d2aa9261871e03ab9dc058a550d240f25859b05b67fd70f80d4b3/multidict-6.7.1-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:ce1bbd7d780bb5a0da032e095c951f7014d6b0a205f8318308140f1a6aba159e", size = 240337, upload-time = "2026-01-26T02:45:58.698Z" }, { url = "https://files.pythonhosted.org/packages/a1/29/fdc6a43c203890dc2ae9249971ecd0c41deaedfe00d25cb6564b2edd99eb/multidict-6.7.1-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:b26684587228afed0d50cf804cc71062cc9c1cdf55051c4c6345d372947b268c", size = 248788, upload-time = "2026-01-26T02:46:00.862Z" }, { url = "https://files.pythonhosted.org/packages/a9/14/a153a06101323e4cf086ecee3faadba52ff71633d471f9685c42e3736163/multidict-6.7.1-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:9f9af11306994335398293f9958071019e3ab95e9a707dc1383a35613f6abcb9", size = 242842, upload-time = "2026-01-26T02:46:02.824Z" }, { url = "https://files.pythonhosted.org/packages/41/5f/604ae839e64a4a6efc80db94465348d3b328ee955e37acb24badbcd24d83/multidict-6.7.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:b4938326284c4f1224178a560987b6cf8b4d38458b113d9b8c1db1a836e640a2", size = 240237, upload-time = "2026-01-26T02:46:05.898Z" }, { url = "https://files.pythonhosted.org/packages/5f/60/c3a5187bf66f6fb546ff4ab8fb5a077cbdd832d7b1908d4365c7f74a1917/multidict-6.7.1-cp314-cp314t-win32.whl", hash = "sha256:98655c737850c064a65e006a3df7c997cd3b220be4ec8fe26215760b9697d4d7", size = 48008, upload-time = "2026-01-26T02:46:07.468Z" }, { url = "https://files.pythonhosted.org/packages/0c/f7/addf1087b860ac60e6f382240f64fb99f8bfb532bb06f7c542b83c29ca61/multidict-6.7.1-cp314-cp314t-win_amd64.whl", hash = "sha256:497bde6223c212ba11d462853cfa4f0ae6ef97465033e7dc9940cdb3ab5b48e5", size = 53542, upload-time = "2026-01-26T02:46:08.809Z" }, { url = "https://files.pythonhosted.org/packages/4c/81/4629d0aa32302ef7b2ec65c75a728cc5ff4fa410c50096174c1632e70b3e/multidict-6.7.1-cp314-cp314t-win_arm64.whl", hash = "sha256:2bbd113e0d4af5db41d5ebfe9ccaff89de2120578164f86a5d17d5a576d1e5b2", size = 44719, upload-time = "2026-01-26T02:46:11.146Z" }, { url = "https://files.pythonhosted.org/packages/81/08/7036c080d7117f28a4af526d794aab6a84463126db031b007717c1a6676e/multidict-6.7.1-py3-none-any.whl", hash = "sha256:55d97cc6dae627efa6a6e548885712d4864b81110ac76fa4e534c03819fa4a56", size = 12319, upload-time = "2026-01-26T02:46:44.004Z" }, ] [[package]] name = "mypy" version = "2.3.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "ast-serialize" }, { name = "librt", marker = "platform_python_implementation != 'PyPy'" }, { name = "mypy-extensions" }, { name = "pathspec" }, { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/12/af/4e516a05d3ca2eb9283e9ec45b2c02225c1514dd6da49fd3c9eaa6639370/mypy-2.3.0.tar.gz", hash = "sha256:465965d41cd9a2726694e983e8ce7113259327bec798115d1e1dfa2a52fb666e", size = 3988104, upload-time = "2026-07-13T11:34:53.387Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/dc/94/0e7e592619e2133596a47cdd642534b0456545c218430bd3b9d8fefdd1b1/mypy-2.3.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:2d53fc67b9d28a43c6199077f49fea0f05839e36cf6158500331c9549225e5a5", size = 15026523, upload-time = "2026-07-13T11:34:49.206Z" }, { url = "https://files.pythonhosted.org/packages/f6/d2/1e1731df090a857df2807177a4626863e5ac0f0256513c35780efe53986f/mypy-2.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:fbc00cee7bdbb9291979ddc9d08034a29dfcda4932628c9bbc28c1edd589df0c", size = 14032189, upload-time = "2026-07-13T11:33:57.168Z" }, { url = "https://files.pythonhosted.org/packages/44/95/cab921f4a806e171f34113e6181dd23c55358ccf6a80741269ef594a410e/mypy-2.3.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:04e617030eca5221909c8b7d8d7fd1c637948199aa2100b2ad9813feb07e1491", size = 14198696, upload-time = "2026-07-13T11:32:12.767Z" }, { url = "https://files.pythonhosted.org/packages/66/80/e6d008bb19fe446e3662d85e0e2717bf9f2d611a2164fb29d6e067dbf46c/mypy-2.3.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:56c184d2c20ca6b6378d58d1960270a767f41f5e44acbbd27f05effef4f4e1d7", size = 15286904, upload-time = "2026-07-13T11:34:27.594Z" }, { url = "https://files.pythonhosted.org/packages/db/83/94397c9293608a364aa03e8084fb34ede4ae976a260384b9b52929308135/mypy-2.3.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:3961a4a34b05f7c74b0f05aa51fbfe99a2d1e126038df40318d15c8f558b7ef3", size = 15528342, upload-time = "2026-07-13T11:34:07.819Z" }, { url = "https://files.pythonhosted.org/packages/cf/96/d8b37d819adec6cfccfb1fd3afc1735d94717ddeafb45536db9c6943e09b/mypy-2.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:b1942b9314d4c784b8ea1dbab4972603290e5dd5630f06675f13aec97526bc4c", size = 11218346, upload-time = "2026-07-13T11:28:27.745Z" }, { url = "https://files.pythonhosted.org/packages/2b/cd/cd9f725b19b19e5b530a154cf9bcf9e94279c5d55b3c34fb42b3aa48ea1b/mypy-2.3.0-cp312-cp312-win_arm64.whl", hash = "sha256:be51653d7669d7d7955d613b8d0bb57d5b652eaf71a873ddf65ac87254dd2595", size = 10204525, upload-time = "2026-07-13T11:31:02.552Z" }, { url = "https://files.pythonhosted.org/packages/6e/ae/f7d056eb0294586a572d0d0d89580ec633c064db520f11d37d5a2fb833bd/mypy-2.3.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:91ad22a52ae2c7e621c2f67c94d5a17f66b3209a4cff5cf8a573579835c69e97", size = 14947298, upload-time = "2026-07-13T11:27:47.734Z" }, { url = "https://files.pythonhosted.org/packages/32/d5/db3e7af01e7844d21662c6ddc1f7825ec7cb4053f0391ac02faf3638396f/mypy-2.3.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:99ac767cc5d3b64c8d0ae226ead10c96694f94e4e7da1668642225dcd4e75aac", size = 13950768, upload-time = "2026-07-13T11:27:57.726Z" }, { url = "https://files.pythonhosted.org/packages/d9/fb/43c031f0190513d1ec248ed037eceb742ddd2a4d74bbf406658a28173837/mypy-2.3.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:de6d2c484742a4d7b0ed6d07b143375624d3b899c5749c7b3c947f56261f48a6", size = 14151586, upload-time = "2026-07-13T11:29:18.615Z" }, { url = "https://files.pythonhosted.org/packages/ec/c3/f8b2ffc60883084da91be51af58e88a7ffd4ff9795acb7d902ff88d31eb1/mypy-2.3.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7da939dd335cfd2ad788bdfd081c9f4e47634ab995e5a45eb15fd1e5bc052f8b", size = 15227411, upload-time = "2026-07-13T11:30:29.904Z" }, { url = "https://files.pythonhosted.org/packages/83/2e/16b917fc7adcf03f1aadddfc93aab804ffb234b1ab09c0ffd6d92a5d34a2/mypy-2.3.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:7247eb2824f996722a949530183394921ca71deb9680052a338cf53cff7925c2", size = 15478790, upload-time = "2026-07-13T11:33:14.686Z" }, { url = "https://files.pythonhosted.org/packages/c0/88/aaa65a93c73d0cdae7e42f8adb302bf6885bb281302084f99d0290a35347/mypy-2.3.0-cp313-cp313-win_amd64.whl", hash = "sha256:75b0984bb3cbd76bb5c9291a8671f7ae66ca3b51c7584c358fc2e923259f0757", size = 11234919, upload-time = "2026-07-13T11:33:39.28Z" }, { url = "https://files.pythonhosted.org/packages/35/19/b40de63f1a80e63bc2d40f0679a6a8dbd34e95176c8122119bdf406aa552/mypy-2.3.0-cp313-cp313-win_arm64.whl", hash = "sha256:d78fcf900b59cb7e82cb7e3a235e31b462d9333d92285bd1e4952d355b8ffba1", size = 10201510, upload-time = "2026-07-13T11:31:52.619Z" }, { url = "https://files.pythonhosted.org/packages/a4/58/fa0ae047da911f540284009b4f44b96fe09d83c076d7c103e9d645f46303/mypy-2.3.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:ea317b060ce83e26050f8f9e4d7d6bf44ed7597c8ff9990bccffbb9d1d8522db", size = 14941909, upload-time = "2026-07-13T11:32:34.332Z" }, { url = "https://files.pythonhosted.org/packages/15/14/2ba1d61452d7c2a7fe12741e8d374e52b183476b07aa7f9e2a0d02b0720a/mypy-2.3.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:094af99f92638aa92852326188b85a89e50f4a472f44827c03362228482f0762", size = 13967581, upload-time = "2026-07-13T11:30:00.587Z" }, { url = "https://files.pythonhosted.org/packages/ed/5a/483fb9e5ffbbb1a28dccc7b0a13d141b17ac769b6c9f488c0a0c63698962/mypy-2.3.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:de121747278144fc9ae7caa2e978cf5df12aebc82933182f5b3b86081a30baef", size = 14168807, upload-time = "2026-07-13T11:28:48.6Z" }, { url = "https://files.pythonhosted.org/packages/ae/77/70d7a10732063beb74ad713682cf871e88f5c5fa39bfc8beff8a524bf9cb/mypy-2.3.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:37fa4de896a84e2dc9200d91e614c22563b43d1a266789d4bbac7b22ebe6192b", size = 15200144, upload-time = "2026-07-13T11:31:25.283Z" }, { url = "https://files.pythonhosted.org/packages/56/72/766218ac783be4fdfcd699b90037b63017348a3e86fb2c1fbfb18302637d/mypy-2.3.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:f1b3a98dfd21058bc759bb3337d5d1f61d0fdf9f3cf9c00f4291790fb5427bff", size = 15460389, upload-time = "2026-07-13T11:29:29.077Z" }, { url = "https://files.pythonhosted.org/packages/38/4e/8a9db7411ecb8ec0cb1fd05dba432f28bafffcd38b4e887714a4a0506689/mypy-2.3.0-cp314-cp314-pyemscripten_2026_0_wasm32.whl", hash = "sha256:944c665d984157cb96a679dfb7a4a81dd1d36b24b9c284b699514e6e626b82d4", size = 7753664, upload-time = "2026-07-13T11:29:08.147Z" }, { url = "https://files.pythonhosted.org/packages/65/4c/c3f8bfd6ed0e5e38b5a244403b27f821d433443df5a15a278417c10a3a3c/mypy-2.3.0-cp314-cp314-win_amd64.whl", hash = "sha256:4359424140d985192c778c1ce2c114a10c1ca58a381ed79cfa70d37df94b299f", size = 11417237, upload-time = "2026-07-13T11:33:47.467Z" }, { url = "https://files.pythonhosted.org/packages/3c/00/89a32eaf5ccf174bc4f90db0eaea5d70636c01b8d49f384bdab2e8834390/mypy-2.3.0-cp314-cp314-win_arm64.whl", hash = "sha256:3dd0bed92c4bdec57c42505b96416fb9e6a5aa7be84d2809bcd5f2ecec2860d7", size = 10389252, upload-time = "2026-07-13T11:31:43.81Z" }, { url = "https://files.pythonhosted.org/packages/31/56/104f93d69aa9f339b6b9d3b0a7faa699b8b466c942cf3ae86cc2a2ec0915/mypy-2.3.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:691fdc37132b1ae628d834f672e74de83462d9fb4aff621835767fb43a8dd373", size = 16385495, upload-time = "2026-07-13T11:29:49.818Z" }, { url = "https://files.pythonhosted.org/packages/d2/03/f1d2123313f55efafdd27706960f43a771c62f1b68426c76043f3ab9ebf3/mypy-2.3.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:aec15d465d477558fd842757b487849007311cf3897849cdda0e3162ac0ac556", size = 15098155, upload-time = "2026-07-13T11:30:40.301Z" }, { url = "https://files.pythonhosted.org/packages/e5/5d/d5f9200399b445e81726c4f23becee33f233aee81c72680b1ef3a258b641/mypy-2.3.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b352b7e49f5e6576009e8df730e1ff4f915cb565b851b396d2ffe2f5a6f5da88", size = 15514155, upload-time = "2026-07-13T11:34:38.569Z" }, { url = "https://files.pythonhosted.org/packages/cd/ce/69977c555f08faa3190cfde44189b89dbd56861b1ab97aa18fc5f3a2e4a3/mypy-2.3.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c6c6bf687b17f90dbfcad95b960d32eaa0154c00da45f03ab50bf8952e047fe", size = 16766351, upload-time = "2026-07-13T11:33:29.195Z" }, { url = "https://files.pythonhosted.org/packages/bc/92/6648b6caa3ab9e00f9ac0c2a78307805f873dd48139b24a6f6f7c3667bbf/mypy-2.3.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:f4ed18f111bfe2d599bca7468e7f9251042c1c2118f762c8de2766a56d773c60", size = 17043490, upload-time = "2026-07-13T11:30:53.927Z" }, { url = "https://files.pythonhosted.org/packages/7c/ab/0dc91d80f3f016634c68d451f294a97320fe903a9b6f90b9e57b3f7f1717/mypy-2.3.0-cp314-cp314t-win_amd64.whl", hash = "sha256:0b025a93cffb9781d231f232be07a17912f35f10a313c24f301c81e842870654", size = 12146869, upload-time = "2026-07-13T11:29:38.874Z" }, { url = "https://files.pythonhosted.org/packages/85/b5/4c964d02634ba81f4d1c84838e5c5b18ab06d13ed568960f5d6318495ccc/mypy-2.3.0-cp314-cp314t-win_arm64.whl", hash = "sha256:adebc76aab4f3495a88b41d48aa4aff0c03f2822501da76625afcca5975f19e5", size = 10965113, upload-time = "2026-07-13T11:28:07.056Z" }, { url = "https://files.pythonhosted.org/packages/2c/fa/fdc54fe583ba3cafbcedfb70eeeaf03849f75b1827a07096c7bd996f582d/mypy-2.3.0-py3-none-any.whl", hash = "sha256:6b1cdb579446b60432432b2b2403a6201b4b475a004d7f488511c9ba177c9e88", size = 2753292, upload-time = "2026-07-13T11:33:18.48Z" }, ] [[package]] name = "mypy-extensions" version = "1.1.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/a2/6e/371856a3fb9d31ca8dac321cda606860fa4548858c0cc45d9d1d4ca2628b/mypy_extensions-1.1.0.tar.gz", hash = "sha256:52e68efc3284861e772bbcd66823fde5ae21fd2fdb51c62a211403730b916558", size = 6343, upload-time = "2025-04-22T14:54:24.164Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/79/7b/2c79738432f5c924bef5071f933bcc9efd0473bac3b4aa584a6f7c1c8df8/mypy_extensions-1.1.0-py3-none-any.whl", hash = "sha256:1be4cccdb0f2482337c4743e60421de3a356cd97508abadd57d47403e94f5505", size = 4963, upload-time = "2025-04-22T14:54:22.983Z" }, ] [[package]] name = "networkx" version = "3.6.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/6a/51/63fe664f3908c97be9d2e4f1158eb633317598cfa6e1fc14af5383f17512/networkx-3.6.1.tar.gz", hash = "sha256:26b7c357accc0c8cde558ad486283728b65b6a95d85ee1cd66bafab4c8168509", size = 2517025, upload-time = "2025-12-08T17:02:39.908Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/9e/c9/b2622292ea83fbb4ec318f5b9ab867d0a28ab43c5717bb85b0a5f6b3b0a4/networkx-3.6.1-py3-none-any.whl", hash = "sha256:d47fbf302e7d9cbbb9e2555a0d267983d2aa476bac30e90dfbe5669bd57f3762", size = 2068504, upload-time = "2025-12-08T17:02:38.159Z" }, ] [[package]] name = "numcodecs" version = "0.16.5" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "numpy" }, { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/44/bd/8a391e7c356366224734efd24da929cc4796fff468bfb179fe1af6548535/numcodecs-0.16.5.tar.gz", hash = "sha256:0d0fb60852f84c0bd9543cc4d2ab9eefd37fc8efcc410acd4777e62a1d300318", size = 6276387, upload-time = "2025-11-21T02:49:48.986Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/75/cc/55420f3641a67f78392dc0bc5d02cb9eb0a9dcebf2848d1ac77253ca61fa/numcodecs-0.16.5-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:24e675dc8d1550cd976a99479b87d872cb142632c75cc402fea04c08c4898523", size = 1656287, upload-time = "2025-11-21T02:49:25.755Z" }, { url = "https://files.pythonhosted.org/packages/f5/6c/86644987505dcb90ba6d627d6989c27bafb0699f9fd00187e06d05ea8594/numcodecs-0.16.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:94ddfa4341d1a3ab99989d13b01b5134abb687d3dab2ead54b450aefe4ad5bd6", size = 1148899, upload-time = "2025-11-21T02:49:26.87Z" }, { url = "https://files.pythonhosted.org/packages/97/1e/98aaddf272552d9fef1f0296a9939d1487914a239e98678f6b20f8b0a5c8/numcodecs-0.16.5-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b554ab9ecf69de7ca2b6b5e8bc696bd9747559cb4dd5127bd08d7a28bec59c3a", size = 8534814, upload-time = "2025-11-21T02:49:28.547Z" }, { url = "https://files.pythonhosted.org/packages/fb/53/78c98ef5c8b2b784453487f3e4d6c017b20747c58b470393e230c78d18e8/numcodecs-0.16.5-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ad1a379a45bd3491deab8ae6548313946744f868c21d5340116977ea3be5b1d6", size = 9173471, upload-time = "2025-11-21T02:49:30.444Z" }, { url = "https://files.pythonhosted.org/packages/1c/20/2fdec87fc7f8cec950d2b0bea603c12dc9f05b4966dc5924ba5a36a61bf6/numcodecs-0.16.5-cp312-cp312-win_amd64.whl", hash = "sha256:845a9857886ffe4a3172ba1c537ae5bcc01e65068c31cf1fce1a844bd1da050f", size = 801412, upload-time = "2025-11-21T02:49:32.123Z" }, { url = "https://files.pythonhosted.org/packages/38/38/071ced5a5fd1c85ba0e14ba721b66b053823e5176298c2f707e50bed11d9/numcodecs-0.16.5-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:25be3a516ab677dad890760d357cfe081a371d9c0a2e9a204562318ac5969de3", size = 1654359, upload-time = "2025-11-21T02:49:33.673Z" }, { url = "https://files.pythonhosted.org/packages/d1/c0/5f84ba7525577c1b9909fc2d06ef11314825fc4ad4378f61d0e4c9883b4a/numcodecs-0.16.5-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:0107e839ef75b854e969cb577e140b1aadb9847893937636582d23a2a4c6ce50", size = 1144237, upload-time = "2025-11-21T02:49:35.294Z" }, { url = "https://files.pythonhosted.org/packages/0b/00/787ea5f237b8ea7bc67140c99155f9c00b5baf11c49afc5f3bfefa298f95/numcodecs-0.16.5-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:015a7c859ecc2a06e2a548f64008c0ec3aaecabc26456c2c62f4278d8fc20597", size = 8483064, upload-time = "2025-11-21T02:49:36.454Z" }, { url = "https://files.pythonhosted.org/packages/c4/e6/d359fdd37498e74d26a167f7a51e54542e642ea47181eb4e643a69a066c3/numcodecs-0.16.5-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:84230b4b9dad2392f2a84242bd6e3e659ac137b5a1ce3571d6965fca673e0903", size = 9126063, upload-time = "2025-11-21T02:49:38.018Z" }, { url = "https://files.pythonhosted.org/packages/27/72/6663cc0382ddbb866136c255c837bcb96cc7ce5e83562efec55e1b995941/numcodecs-0.16.5-cp313-cp313-win_amd64.whl", hash = "sha256:5088145502ad1ebf677ec47d00eb6f0fd600658217db3e0c070c321c85d6cf3d", size = 799275, upload-time = "2025-11-21T02:49:39.558Z" }, { url = "https://files.pythonhosted.org/packages/3c/9e/38e7ca8184c958b51f45d56a4aeceb1134ecde2d8bd157efadc98502cc42/numcodecs-0.16.5-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:b05647b8b769e6bc8016e9fd4843c823ce5c9f2337c089fb5c9c4da05e5275de", size = 1654721, upload-time = "2025-11-21T02:49:40.602Z" }, { url = "https://files.pythonhosted.org/packages/a1/37/260fa42e7b2b08e6e00ad632f8dd620961a60a459426c26cea390f8c68d0/numcodecs-0.16.5-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:3832bd1b5af8bb3e413076b7d93318c8e7d7b68935006b9fa36ca057d1725a8f", size = 1146887, upload-time = "2025-11-21T02:49:41.721Z" }, { url = "https://files.pythonhosted.org/packages/4e/15/e2e1151b5a8b14a15dfd4bb4abccce7fff7580f39bc34092780088835f3a/numcodecs-0.16.5-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:49f7b7d24f103187f53135bed28bb9f0ed6b2e14c604664726487bb6d7c882e1", size = 8476987, upload-time = "2025-11-21T02:49:43.363Z" }, { url = "https://files.pythonhosted.org/packages/6d/30/16a57fc4d9fb0ba06c600408bd6634f2f1753c54a7a351c99c5e09b51ee2/numcodecs-0.16.5-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:aec9736d81b70f337d89c4070ee3ffeff113f386fd789492fa152d26a15043e4", size = 9102377, upload-time = "2025-11-21T02:49:45.508Z" }, { url = "https://files.pythonhosted.org/packages/31/a5/a0425af36c20d55a3ea884db4b4efca25a43bea9214ba69ca7932dd997b4/numcodecs-0.16.5-cp314-cp314-win_amd64.whl", hash = "sha256:b16a14303800e9fb88abc39463ab4706c037647ac17e49e297faa5f7d7dbbf1d", size = 819022, upload-time = "2025-11-21T02:49:47.39Z" }, ] [package.optional-dependencies] msgpack = [ { name = "msgpack" }, ] [[package]] name = "numpy" version = "2.5.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/22/fd/89965aa4ac08c74998539fcbf24fa3540f3e15237fbeb6bcf9c908f4aade/numpy-2.5.1.tar.gz", hash = "sha256:a48a113e6afea91f5608793bafa7ef2ad481fefbda87ec5069f483de61cb9fa3", size = 20755553, upload-time = "2026-07-04T17:08:00.933Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/62/7b/14687aa674250e5e546f616f486b0d56d3631cd5b2415739141ce40bdcea/numpy-2.5.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:2c889b56fe48b1018f764b0eec8df59ab654e9148aa91faa12596043500de277", size = 16801574, upload-time = "2026-07-04T17:06:12.423Z" }, { url = "https://files.pythonhosted.org/packages/e1/19/cc5bb2a3f2913d27d6dbb2c78d25921fabaedc6741d4a5a615a11f3c5bf3/numpy-2.5.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ab451b59c5643c570974c43aef780703ef1d3b4965d2be07afd530615a9358d1", size = 11772250, upload-time = "2026-07-04T17:06:15.726Z" }, { url = "https://files.pythonhosted.org/packages/42/77/fdf34a71dd30f54979b18603bee915e0aaf825b07afe79acd60b04b691e2/numpy-2.5.1-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:78798bd5b9ad744056af8efa90e3b9ddaa53272a0848a483084a1cc0a13b2dc0", size = 5331516, upload-time = "2026-07-04T17:06:17.913Z" }, { url = "https://files.pythonhosted.org/packages/ce/e2/eb7efa015b4cce41e2517bf182a7fce0d7d5b9d9ed76a29bfa0f4fe4505c/numpy-2.5.1-cp312-cp312-macosx_14_0_x86_64.whl", hash = "sha256:2ae0ca40bcb22d6ba59c1dfd5446f49940b0f2d821fde133f10dda11f816b84e", size = 6664863, upload-time = "2026-07-04T17:06:20.02Z" }, { url = "https://files.pythonhosted.org/packages/a9/4b/a2b32dd94ee9ffbeecb28152240042a3949db33b1c834d44090b80e1b3b8/numpy-2.5.1-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:61ac47e772e6b8ea489e1d2f441a34c5c3ac17327e7ce294cbdf535795ad4e75", size = 15167977, upload-time = "2026-07-04T17:06:21.621Z" }, { url = "https://files.pythonhosted.org/packages/b8/a9/6e73d68500f80773f65f0654ea932019d6694329a0eb0ed0533de38df376/numpy-2.5.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:59fda5e192b570217ec2580c96f00e9a7e12ef6866a900eb089b62c1a32545ca", size = 16672469, upload-time = "2026-07-04T17:06:24.064Z" }, { url = "https://files.pythonhosted.org/packages/24/7d/ad3e59015135f5261c95fd4cafeff159c955febd83a99a1d9250c4233815/numpy-2.5.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:f7119ebff1a9829e9f431a4f9d28e703023bb6b9fe7c8f724467dbfc27c94ab3", size = 16527531, upload-time = "2026-07-04T17:06:26.69Z" }, { url = "https://files.pythonhosted.org/packages/83/d0/a39b2fbcde9cb17a1dac678f254b33a6336298af9df338824c685425d5e8/numpy-2.5.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e824c2acf8862052246be5a44c15da1777940c60d010dd2aab897824d9c430f9", size = 18431940, upload-time = "2026-07-04T17:06:29.521Z" }, { url = "https://files.pythonhosted.org/packages/04/12/cff070947791c1ed425ff76413189adbdc2fbe215eba7ce7fa454a03c7f8/numpy-2.5.1-cp312-cp312-win32.whl", hash = "sha256:08d60c810432eb83360958dea0999ac4cfb94531ea8efcbf0b7f277c2068aeb2", size = 6066764, upload-time = "2026-07-04T17:06:32.571Z" }, { url = "https://files.pythonhosted.org/packages/65/66/53f31807a48a750f9d748da273bc3fcedd12b27ff1f3e373bfec55ef2dc0/numpy-2.5.1-cp312-cp312-win_amd64.whl", hash = "sha256:f7d60026c0bdb1380e83bfa7a0419c4577ee4b9a08880afcb6dadeb74c649fa2", size = 12430966, upload-time = "2026-07-04T17:06:34.926Z" }, { url = "https://files.pythonhosted.org/packages/2b/2a/d1a88066b1c14186f5d3c0d18c94f17b064511982bab0578d49ee9d43c29/numpy-2.5.1-cp312-cp312-win_arm64.whl", hash = "sha256:17a25e09640602e10bc8de0e6fa2b3fd68eedd84ba6d7842dc8f32f9ab87bd0b", size = 10350488, upload-time = "2026-07-04T17:06:37.785Z" }, { url = "https://files.pythonhosted.org/packages/eb/07/ec2a3f0c91761581d4b7104a740791800025983f9a4dc4e73f91a99aeac4/numpy-2.5.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:0bfebd8695f9863592fe744be833a258120b14a9f39da255e8aa8fade2c0ddd1", size = 16796419, upload-time = "2026-07-04T17:06:40.37Z" }, { url = "https://files.pythonhosted.org/packages/ab/ab/ddb499fc4f8780354395face5b65c7fd107bcd6e1d667a5f07d046956f6f/numpy-2.5.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:30b44a6b53a7ae63c54c089a8726e5563ed302716c5b7ccc85afade40b0e7ff6", size = 11765832, upload-time = "2026-07-04T17:06:42.768Z" }, { url = "https://files.pythonhosted.org/packages/88/b3/3c28c558a09fc72100c646dac6d2fce8e834c471b0edca01a29996706117/numpy-2.5.1-cp313-cp313-macosx_14_0_arm64.whl", hash = "sha256:6165343f81b56ef8f514f396989e529b61d9dc709b99421b07e9f3e698e2287d", size = 5325143, upload-time = "2026-07-04T17:06:45.466Z" }, { url = "https://files.pythonhosted.org/packages/5e/0e/ce19b985bb15c596f4f05954e76cccc77c845083b3b8f938a6c68e523128/numpy-2.5.1-cp313-cp313-macosx_14_0_x86_64.whl", hash = "sha256:4939237038ada79308dda3204ac6462df056b5672b2e25db1149cf873668b3e1", size = 6659749, upload-time = "2026-07-04T17:06:47.288Z" }, { url = "https://files.pythonhosted.org/packages/2e/20/1ee6614d64332a1bba6411f38e68cb79eec1b2459e20a623777c5c5492a2/numpy-2.5.1-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1c6759f538fb912fc46de0a6b1758ccf7b57bc7c7ebebc23974fdac3de8db0cd", size = 15164716, upload-time = "2026-07-04T17:06:49.494Z" }, { url = "https://files.pythonhosted.org/packages/ed/a7/2bcd3fdbb87804755c35b729bf8709d62025c5f4cfd7d5b2415997097515/numpy-2.5.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9726558e8db4a5bf7929a70ae50f63abda4daf0efe810e3bfbab95976f75fc1a", size = 16661440, upload-time = "2026-07-04T17:06:52.061Z" }, { url = "https://files.pythonhosted.org/packages/fc/d7/a41e3310c886fe457d36e670bbf24fae411aca8a7b6ad92a32afd924077c/numpy-2.5.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:3935f3b419b244a02732676fa5317a9193cc596a4c0646db07e5b421229ac9f7", size = 16526305, upload-time = "2026-07-04T17:06:54.605Z" }, { url = "https://files.pythonhosted.org/packages/53/75/4333a9a707c1edd3a4e1a0c58eca52c0f31e55089fa80db02b5565b24df7/numpy-2.5.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:dc932a65ded7ce9013d120845a2514dcccb1a67bfc8deb8d37633762951904a6", size = 18423008, upload-time = "2026-07-04T17:06:57.54Z" }, { url = "https://files.pythonhosted.org/packages/ee/90/e314a32b1c11a2ffe818ddad3a57b50b4b6e1b6c487192eb50cdef0415d0/numpy-2.5.1-cp313-cp313-win32.whl", hash = "sha256:4b4ff1608417eb7a59da7b967bbb798cacfe071d2caf526a24281cd562072ed9", size = 6063885, upload-time = "2026-07-04T17:07:00.14Z" }, { url = "https://files.pythonhosted.org/packages/10/70/800b3fca480af32df9e8ea9f3d4a0c8feb4b32d7f195d174eabbda4829ad/numpy-2.5.1-cp313-cp313-win_amd64.whl", hash = "sha256:6c3fe51bc6a16453d452997053454f309e8e0ed7b42d6b361ce4ac8c32913d74", size = 12425674, upload-time = "2026-07-04T17:07:02.387Z" }, { url = "https://files.pythonhosted.org/packages/8b/0b/196350c122f50f6ca56846f2d71efd5e0d24b7b2e07355e019b2e2c7a11e/numpy-2.5.1-cp313-cp313-win_arm64.whl", hash = "sha256:f7feb014281029e628ba2d5a007407443b06e418b6fe451d1e2adcbc8eba0107", size = 10350256, upload-time = "2026-07-04T17:07:04.878Z" }, { url = "https://files.pythonhosted.org/packages/db/f4/731b6085a83faf6ca843394cbd5e217280c214399f7e8b21b9f552af0ae2/numpy-2.5.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:7c786fe9a5bbe360022e584c5a34cf6b54265c71bd7ec8ac3d8fec38968071f8", size = 16795063, upload-time = "2026-07-04T17:07:07.374Z" }, { url = "https://files.pythonhosted.org/packages/bf/64/0e215f2048dd11a55bb989ed41b3585ef57452404e638d703a211a3e4157/numpy-2.5.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:32985c896d897419ef8da6917872d80b78ad0ea26d85b23245c7366ffde76d75", size = 11776652, upload-time = "2026-07-04T17:07:09.907Z" }, { url = "https://files.pythonhosted.org/packages/b5/59/2b844c7a6e9deff69b404a66221e1542937734f65d5e6e39411876053862/numpy-2.5.1-cp314-cp314-macosx_14_0_arm64.whl", hash = "sha256:efd736408cc97c79b9e6917338dfc8f06013b2274f992e96b1d9a81a71e2a2c2", size = 5335944, upload-time = "2026-07-04T17:07:12.227Z" }, { url = "https://files.pythonhosted.org/packages/86/51/9bf7cb2cabcebc9e017e4ec7e6322b378317a542c08b4cb68479c1efc716/numpy-2.5.1-cp314-cp314-macosx_14_0_x86_64.whl", hash = "sha256:ab84dc6b074fa881cae55bea94cc4f68e285181ba7f32497bf7dee6b1496165b", size = 6656266, upload-time = "2026-07-04T17:07:14.368Z" }, { url = "https://files.pythonhosted.org/packages/83/3e/fb7615b211b82a32f44d5180a6d421b61f84d4fadd578b48ba4ac34e189f/numpy-2.5.1-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:caf3e317d33d60c37986b452613f4ab51246d0691350c03d0cb4a898627f4a95", size = 15179720, upload-time = "2026-07-04T17:07:16.272Z" }, { url = "https://files.pythonhosted.org/packages/41/5f/0f992cb24560673496c5d68de61913b57166ce530ffda07c1f280e0cc464/numpy-2.5.1-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:54ad769f17bc2d833b620851989f62054fb9ab93c969d9e1dc3c8e3d56beea21", size = 16664835, upload-time = "2026-07-04T17:07:19.021Z" }, { url = "https://files.pythonhosted.org/packages/a2/2f/97d6475ee91afe2587797d09446f9d3e475ad4cb681662d824809327b75a/numpy-2.5.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:c12afb53450fa976d4c681c50a7423729a4c51c0465ed9f32b8a9cabbc472373", size = 16539135, upload-time = "2026-07-04T17:07:22.015Z" }, { url = "https://files.pythonhosted.org/packages/c4/5b/4db81e4ba0be7e2776b1de68c82aa862c7f8ec27e1b4927d4ae075e20678/numpy-2.5.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:e8c11c405efc5ff6816d5983c96cdfa215bab3428961243af3ff59b228490438", size = 18426684, upload-time = "2026-07-04T17:07:24.941Z" }, { url = "https://files.pythonhosted.org/packages/1f/64/c0ba2d90724d450279a7df8f32057241070250a26a7e2b5337d77347f481/numpy-2.5.1-cp314-cp314-win32.whl", hash = "sha256:f2479a47f8d5932d1718168a681ad6e536a9df484c83cfcf9de365e164537ace", size = 6116103, upload-time = "2026-07-04T17:07:27.622Z" }, { url = "https://files.pythonhosted.org/packages/c1/1a/837f9ed7405adcd7a40538792eb169eddd8fa5630c16a1ef49dae71a30f4/numpy-2.5.1-cp314-cp314-win_amd64.whl", hash = "sha256:24d0eb82c0541d3415a33425db64ae439dffccd7b4dbcb30e7c35120205c506a", size = 12562177, upload-time = "2026-07-04T17:07:29.887Z" }, { url = "https://files.pythonhosted.org/packages/22/ed/49707938b6dd0a78a9178dd93227dc89e4c11af47f5c798d70366e8d0483/numpy-2.5.1-cp314-cp314-win_arm64.whl", hash = "sha256:5a4c988b38d261deeeaad9954e3deb091ad905c94e8bb6708654ef1d97f286b0", size = 10627739, upload-time = "2026-07-04T17:07:32.568Z" }, { url = "https://files.pythonhosted.org/packages/a6/c7/bb4b882cfe7f299cbc8b66e42e7dd78cf9d14e40f9469fc5e3db7e15b3bd/numpy-2.5.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:a33276be12fa045805f477f22482088b66bb758ffbe89a9d21457de863a32e22", size = 11894709, upload-time = "2026-07-04T17:07:34.941Z" }, { url = "https://files.pythonhosted.org/packages/40/3f/5af7f4a7f6224aef48017aa82bb6174c7a659d724be0c75017b7e64a55b4/numpy-2.5.1-cp314-cp314t-macosx_14_0_arm64.whl", hash = "sha256:f089d7b00756190aacf1f5d34bdf38c3c430ac82b4f868f8cede73380460fce7", size = 5453810, upload-time = "2026-07-04T17:07:37.495Z" }, { url = "https://files.pythonhosted.org/packages/20/c9/3474309bc94d634d3f9c3eddf03250ecb8c22cd948ef16fef69a77cc5d7b/numpy-2.5.1-cp314-cp314t-macosx_14_0_x86_64.whl", hash = "sha256:09e9bfd8d2cf479c7d174804fb3811c53a8e9f20a37444008606b57d6b7a826d", size = 6761189, upload-time = "2026-07-04T17:07:39.563Z" }, { url = "https://files.pythonhosted.org/packages/90/8a/558ae39fdd55d7e7f7fef9a84a6e964ac6b23edbd2a07e52bb084500507d/numpy-2.5.1-cp314-cp314t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:e68d8dd1e7eba712948f2053a29ec86917bc70ba1358df869d9f06649ef9cf09", size = 15225039, upload-time = "2026-07-04T17:07:41.682Z" }, { url = "https://files.pythonhosted.org/packages/63/27/ca7392b2d030277bdf0273e7d23255b3ee57d57a7c170a6f4fb3981e1e5d/numpy-2.5.1-cp314-cp314t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:99d5095fa265a0c4152e7bb12759e14381ef5496152f1ce58f44bdf55c44beb4", size = 16701306, upload-time = "2026-07-04T17:07:44.611Z" }, { url = "https://files.pythonhosted.org/packages/02/42/03d53ae7996c44d4374a8262e9dc41671fd56cbb98f7d47ef85cf5da4c6b/numpy-2.5.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:ab87a91b3cc3382b8956095bd8f95e00cf679bb81554339be1a2ba404a1473c1", size = 16589955, upload-time = "2026-07-04T17:07:47.694Z" }, { url = "https://files.pythonhosted.org/packages/7b/15/6c1784ae469640e65db111e9a34b3d0f14d91e8a38b9ce34810ced370dbb/numpy-2.5.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:224ca51130ef7da85bea2191625181cb4f337f9cb64b471f10c1a12aa8b60077", size = 18464252, upload-time = "2026-07-04T17:07:50.684Z" }, { url = "https://files.pythonhosted.org/packages/94/a8/f98e50356cf167df656c526c2dfeec2d7dde182f2a3da4b458a5938e2776/numpy-2.5.1-cp314-cp314t-win32.whl", hash = "sha256:6eab239876581b2b3c5a242281b6007bbdbcd1c7085d7709bb57c5929b11e6bf", size = 6263298, upload-time = "2026-07-04T17:07:53.445Z" }, { url = "https://files.pythonhosted.org/packages/72/ac/96ae880cdecad0b3275d9359fcec72667b49a4863c9f12942e43679dda02/numpy-2.5.1-cp314-cp314t-win_amd64.whl", hash = "sha256:83ce9c80d5b521b0d77ddcbe5447c218d247929b6cc056ca5351342accfff0af", size = 12748623, upload-time = "2026-07-04T17:07:55.384Z" }, { url = "https://files.pythonhosted.org/packages/a1/5a/4d2b1601df3602dba7a14f3348ba9bfe94a18adb428e693df6154c293831/numpy-2.5.1-cp314-cp314t-win_arm64.whl", hash = "sha256:5a6db61f9aaa57e369905c67d852045d3c4f7126405b29d09b19dec118e9c9cb", size = 10697674, upload-time = "2026-07-04T17:07:58.506Z" }, ] [[package]] name = "numpydoc" version = "1.10.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "sphinx" }, ] sdist = { url = "https://files.pythonhosted.org/packages/e9/3c/dfccc9e7dee357fb2aa13c3890d952a370dd0ed071e0f7ed62ed0df567c1/numpydoc-1.10.0.tar.gz", hash = "sha256:3f7970f6eee30912260a6b31ac72bba2432830cd6722569ec17ee8d3ef5ffa01", size = 94027, upload-time = "2025-12-02T16:39:12.937Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/62/5e/3a6a3e90f35cea3853c45e5d5fb9b7192ce4384616f932cf7591298ab6e1/numpydoc-1.10.0-py3-none-any.whl", hash = "sha256:3149da9874af890bcc2a82ef7aae5484e5aa81cb2778f08e3c307ba6d963721b", size = 69255, upload-time = "2025-12-02T16:39:11.561Z" }, ] [[package]] name = "obstore" version = "0.11.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "typing-extensions", marker = "python_full_version < '3.13'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/2e/2f/f83afaab7945509d72245b2b00af0b4834ce78fdd2d9ae9f0ad1a3036a91/obstore-0.11.0.tar.gz", hash = "sha256:a2f55163bcd348b4a60d12e6893eac50eddc742bad8032a1705d49140b992204", size = 130565, upload-time = "2026-06-25T18:29:49.405Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/fc/b2/00c213e7e5ca8065f97e37e55294adab836e3f6a88b23e4029069aaecf95/obstore-0.11.0-cp311-abi3-macosx_10_12_x86_64.whl", hash = "sha256:42f36546c7ac44dbab1173d2330a8a1b1a3f0e37950e553b8c904e3dd0744b25", size = 5491935, upload-time = "2026-06-25T18:28:32.029Z" }, { url = "https://files.pythonhosted.org/packages/ac/37/6a6b9a5e15a8a37c24d14317a87648097c4888593b588510c03c030d2e90/obstore-0.11.0-cp311-abi3-macosx_11_0_arm64.whl", hash = "sha256:687bb9d3962d568b7c439c5d0c6fea19b2749862a8e5c8eebd0c058c4eccde9e", size = 4672619, upload-time = "2026-06-25T18:28:33.852Z" }, { url = "https://files.pythonhosted.org/packages/28/f9/6745ce8c4f7bfac19dc14a4438b48a2e93a689b92b0cecfc695e41a4e8b1/obstore-0.11.0-cp311-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:010b51578c7514a41719d795cdb7a1e6529be509dac3772e477187a59422bb97", size = 5072806, upload-time = "2026-06-25T18:28:36.127Z" }, { url = "https://files.pythonhosted.org/packages/6c/18/991d3b3cdd851c0225e55f3dc45b47fd9e249827d188995011469f805132/obstore-0.11.0-cp311-abi3-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cfaa8129a3f5d8518a3a75184d4b02348db0f6263177cd1f0951f6568243cc9e", size = 5303777, upload-time = "2026-06-25T18:28:37.89Z" }, { url = "https://files.pythonhosted.org/packages/8d/e9/90e56015a45b5e56a84fc3188c4e5fb088b288d41992c73a629e10df6760/obstore-0.11.0-cp311-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c790a5cb9ff2970d1f464a6a708d734dce9939e9f668cb6708c5dba5d61589b2", size = 5493871, upload-time = "2026-06-25T18:28:39.981Z" }, { url = "https://files.pythonhosted.org/packages/66/02/f1744091d59ce71c5523174eb860fbb298275c901e89b9ea6fbf3e654a33/obstore-0.11.0-cp311-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:827113e12fe8088e0281a9d57b90b2b8dbc8a6ffe3b15dadb9baa5feb3d266c1", size = 5361913, upload-time = "2026-06-25T18:28:42.089Z" }, { url = "https://files.pythonhosted.org/packages/5d/59/3f47822683ee2b6db8685faa25829946d6343a561251ec2704548455d946/obstore-0.11.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a2ff6d3ed553298828fb760b4aef6347fbcc7b5c5e3ce3f8381ce805c370021a", size = 5638724, upload-time = "2026-06-25T18:28:43.897Z" }, { url = "https://files.pythonhosted.org/packages/23/50/1df335fdf9b527b3933f1e94ab6fc720ad314260fab8591cb0b6668ff192/obstore-0.11.0-cp311-abi3-manylinux_2_24_aarch64.whl", hash = "sha256:39d04b324fcf984e7050734ebda77b81764025b0c011750201a0d8954087f7aa", size = 5413508, upload-time = "2026-06-25T18:28:45.624Z" }, { url = "https://files.pythonhosted.org/packages/de/dc/a259aba149b841ca7c91fea177df9972a60a636b54077beed1a35b254994/obstore-0.11.0-cp311-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:37c0d15d775b1370ef5204ee3919a5ddf7e2592d11815213105f8db031f2ab8d", size = 5619995, upload-time = "2026-06-25T18:28:47.599Z" }, { url = "https://files.pythonhosted.org/packages/e5/b4/ec25fdb4d6b060bc6eea647fc0e88f75fcc20fe8d16d67fb0dbe999d323b/obstore-0.11.0-cp311-abi3-musllinux_1_2_armv7l.whl", hash = "sha256:7f468caf9b6e0f12ff151e5fe618de5fc9192befa9bd02734b06de4efd2e49f6", size = 5299512, upload-time = "2026-06-25T18:28:49.629Z" }, { url = "https://files.pythonhosted.org/packages/a8/e5/29be060d06ec13e2af3d1b6cfb77b7c37f8be6c56b77295c945fefad73e4/obstore-0.11.0-cp311-abi3-musllinux_1_2_i686.whl", hash = "sha256:42d8e8fad85be8ee488c1a9a9b7c6a42128abb84e67175da40d3d1165c1846df", size = 5427026, upload-time = "2026-06-25T18:28:51.317Z" }, { url = "https://files.pythonhosted.org/packages/57/b7/577a965f440e9ea64243518663f9d16be7df8eafc7123818e8e841fa21ce/obstore-0.11.0-cp311-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:9c8fd2a544e2e0b926669c47fcfb8d2314e234abc240ea165dae04ee42e1d7ac", size = 5869187, upload-time = "2026-06-25T18:28:53.166Z" }, { url = "https://files.pythonhosted.org/packages/e2/18/8fdbaee22bfd5b9c44e1fdff8ca0508e2fe60c42bf9fc85f0c9c27b4ecf2/obstore-0.11.0-cp311-abi3-win_amd64.whl", hash = "sha256:6fb3d4678c0f4242d3109362e9b1df5d7b27765f43d5aacb2e81af53a75cb9ef", size = 5329384, upload-time = "2026-06-25T18:28:55.305Z" }, { url = "https://files.pythonhosted.org/packages/8b/8b/7555e48ec768728fcfc71a051c6b28d6ddaf1bececf492ce5ef995aab5f0/obstore-0.11.0-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:f3132393eff9f3f2b543ecbb3bcc12319a7c433fef06493b4350d6854d505a14", size = 5515763, upload-time = "2026-06-25T18:28:57.527Z" }, { url = "https://files.pythonhosted.org/packages/23/8f/94d83f3336421cbb5e436ab0ae5695eae72f7c82990d6b1ac090712c8052/obstore-0.11.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:a3a8da19b47af4c14ecc694209b3c18ac6d89f96be5656ee3a19b77947c14155", size = 4649491, upload-time = "2026-06-25T18:28:59.386Z" }, { url = "https://files.pythonhosted.org/packages/fe/86/11f4e1f51a8c6cf21a5915c018d2357201ad3c5799d418f0c6529fafaab2/obstore-0.11.0-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e91298b9b6c3a0408c28eece62bca6c5b6cda2f6350351d84e07b4dc8fb2631f", size = 5060659, upload-time = "2026-06-25T18:29:01.139Z" }, { url = "https://files.pythonhosted.org/packages/49/e7/fd3036b0923d10e878e2073020f1ef692a618ed1cc3980d3e4a468c93713/obstore-0.11.0-cp314-cp314t-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3422c532486671dfb5e3e739bf15ec9ca2a8da544a3c23b74ae3857dcab1c6a8", size = 5277058, upload-time = "2026-06-25T18:29:02.96Z" }, { url = "https://files.pythonhosted.org/packages/2f/a7/b016c3ac6857ac856326dc0a292e3871b8500d03f25f3b90e168b05de357/obstore-0.11.0-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3de027ce46cf0592c2b41654e2c27dbc52a4a726f6fbc511380acc0da3a9f658", size = 5475852, upload-time = "2026-06-25T18:29:05.032Z" }, { url = "https://files.pythonhosted.org/packages/85/9e/644ffe8db7757de7f71f94a036ab24222bccb4de290d3ca69f76547e812d/obstore-0.11.0-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1a80a95548678210bc336b866e37139c293565c3b163eb3fef2433d5d6640a33", size = 5363082, upload-time = "2026-06-25T18:29:06.878Z" }, { url = "https://files.pythonhosted.org/packages/ae/0b/26af6b5fa6ba96af84086f44f78b4e5b0af1729c31402d7b28c68989d174/obstore-0.11.0-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:acaa261dc15efb95bbeca06f8fe9b47ee23d7302a6aa1fa3a9654baab8b23d7c", size = 5629116, upload-time = "2026-06-25T18:29:08.771Z" }, { url = "https://files.pythonhosted.org/packages/ae/ce/f30d502991c6719b2fbd7b8385ef3e39da07bfca099108bcc5eeed8b9c20/obstore-0.11.0-cp314-cp314t-manylinux_2_24_aarch64.whl", hash = "sha256:a3300cabbc3129670987b3723629c791d83c117ef1b6a0c670c2043648e000a1", size = 5404534, upload-time = "2026-06-25T18:29:11.294Z" }, { url = "https://files.pythonhosted.org/packages/52/20/d5bf5f816e868717ba647ed9a2109e800deb402d0265d410456b3fcb4376/obstore-0.11.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:f4e6a9480843645cd4ee122c41d5c5a46a56f1e9cdda85638826f2e0e439fe5c", size = 5613159, upload-time = "2026-06-25T18:29:13.414Z" }, { url = "https://files.pythonhosted.org/packages/db/b4/6d4c1c211e3b06cc8554189e0d4406e8fa1f98ed55f9213b8e398a11599f/obstore-0.11.0-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:9fb2b1814c4314b8903f4e2ebbe8c3365fea6543669615ee9a0288b0d3a2edeb", size = 5286279, upload-time = "2026-06-25T18:29:15.424Z" }, { url = "https://files.pythonhosted.org/packages/02/5e/d7b5589424a56171b16ab94cf92eb493490c300aaa044913bbdd94cace68/obstore-0.11.0-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:63fb9b072815eafe4705f617f567d896b1c858adcb390795fa1e269367791031", size = 5401780, upload-time = "2026-06-25T18:29:17.514Z" }, { url = "https://files.pythonhosted.org/packages/c4/18/841baea8936e51a18b0e5d4c51f09c0a7798cb73b027e9794be2362a0f0b/obstore-0.11.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:086fafba314ff98cfab1c4bf7814699e862513e8889720cf6f7462296cb32787", size = 5853618, upload-time = "2026-06-25T18:29:19.354Z" }, { url = "https://files.pythonhosted.org/packages/83/9a/d6127f5422b78e0222b0a9eadcfd7a5aa8d873a9498da7d4a77d4ac8ce2e/obstore-0.11.0-cp314-cp314t-win_amd64.whl", hash = "sha256:676d1154f6f08721110f9b7d14ee3a3c0293abaf9da135bb90f54e276dca1cac", size = 5314113, upload-time = "2026-06-25T18:29:21.209Z" }, ] [[package]] name = "openapi-schema-validator" version = "0.8.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "jsonschema" }, { name = "jsonschema-specifications" }, { name = "pydantic" }, { name = "pydantic-settings" }, { name = "referencing" }, { name = "rfc3339-validator" }, ] sdist = { url = "https://files.pythonhosted.org/packages/21/4b/67b24b2b23d96ea862be2cca3632a546f67a22461200831213e80c3c6011/openapi_schema_validator-0.8.1.tar.gz", hash = "sha256:4c57266ce8cbfa37bb4eb4d62cdb7d19356c3a468e3535743c4562863e1790da", size = 23134, upload-time = "2026-03-02T08:46:29.807Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/6f/87/e9f29f463b230d4b47d65e17858c595153a8ca8c1775f16e406aa82d455d/openapi_schema_validator-0.8.1-py3-none-any.whl", hash = "sha256:0f5859794c5bfa433d478dc5ac5e5768d50adc56b14380c8a6fd3a8113e89c9b", size = 19211, upload-time = "2026-03-02T08:46:28.154Z" }, ] [[package]] name = "openapi-spec-validator" version = "0.8.5" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "jsonschema" }, { name = "jsonschema-path" }, { name = "lazy-object-proxy" }, { name = "openapi-schema-validator" }, { name = "pydantic" }, { name = "pydantic-settings" }, ] sdist = { url = "https://files.pythonhosted.org/packages/79/3f/aa0c1150627b4e683ae5673486b7d5cf2623a8821601863ee389e430965a/openapi_spec_validator-0.8.5.tar.gz", hash = "sha256:93b04ef5321d5866b2502371123d86333e5c1444f051d323e02525d9e83c7622", size = 1756845, upload-time = "2026-04-24T15:25:21.334Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/64/96/d7dfe1cc0be2df22d7a97ffb0f8bb00b10d92749aa6e64ffa7cc9a041580/openapi_spec_validator-0.8.5-py3-none-any.whl", hash = "sha256:3669106361856934153991e30714616a294865a33f6411a4c25d1dc2d08cfbc2", size = 50334, upload-time = "2026-04-24T15:25:19.65Z" }, ] [[package]] name = "packaging" version = "26.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/d7/f1/e7a6dd94a8d4a5626c03e4e99c87f241ba9e350cd9e6d75123f992427270/packaging-26.2.tar.gz", hash = "sha256:ff452ff5a3e828ce110190feff1178bb1f2ea2281fa2075aadb987c2fb221661", size = 228134, upload-time = "2026-04-24T20:15:23.917Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/df/b2/87e62e8c3e2f4b32e5fe99e0b86d576da1312593b39f47d8ceef365e95ed/packaging-26.2-py3-none-any.whl", hash = "sha256:5fc45236b9446107ff2415ce77c807cee2862cb6fac22b8a73826d0693b0980e", size = 100195, upload-time = "2026-04-24T20:15:22.081Z" }, ] [[package]] name = "paginate" version = "0.5.7" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/ec/46/68dde5b6bc00c1296ec6466ab27dddede6aec9af1b99090e1107091b3b84/paginate-0.5.7.tar.gz", hash = "sha256:22bd083ab41e1a8b4f3690544afb2c60c25e5c9a63a30fa2f483f6c60c8e5945", size = 19252, upload-time = "2024-08-25T14:17:24.139Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/90/96/04b8e52da071d28f5e21a805b19cb9390aa17a47462ac87f5e2696b9566d/paginate-0.5.7-py2.py3-none-any.whl", hash = "sha256:b885e2af73abcf01d9559fd5216b57ef722f8c42affbb63942377668e35c7591", size = 13746, upload-time = "2024-08-25T14:17:22.55Z" }, ] [[package]] name = "pathable" version = "0.5.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/72/55/b748445cb4ea6b125626f15379be7c96d1035d4fa3e8fee362fa92298abf/pathable-0.5.0.tar.gz", hash = "sha256:d81938348a1cacb525e7c75166270644782c0fb9c8cecc16be033e71427e0ef1", size = 16655, upload-time = "2026-02-20T08:47:00.748Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/52/96/5a770e5c461462575474468e5af931cff9de036e7c2b4fea23c1c58d2cbe/pathable-0.5.0-py3-none-any.whl", hash = "sha256:646e3d09491a6351a0c82632a09c02cdf70a252e73196b36d8a15ba0a114f0a6", size = 16867, upload-time = "2026-02-20T08:46:59.536Z" }, ] [[package]] name = "pathlib-abc" version = "0.5.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/d6/cb/448649d7f25d228bf0be3a04590ab7afa77f15e056f8fa976ed05ec9a78f/pathlib_abc-0.5.2.tar.gz", hash = "sha256:fcd56f147234645e2c59c7ae22808b34c364bb231f685ddd9f96885aed78a94c", size = 33342, upload-time = "2025-10-10T18:37:20.524Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/b1/29/c028a0731e202035f0e2e0bfbf1a3e46ad6c628cbb17f6f1cc9eea5d9ff1/pathlib_abc-0.5.2-py3-none-any.whl", hash = "sha256:4c9d94cf1b23af417ce7c0417b43333b06a106c01000b286c99de230d95eefbb", size = 19070, upload-time = "2025-10-10T18:37:19.437Z" }, ] [[package]] name = "pathspec" version = "1.1.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/5a/82/42f767fc1c1143d6fd36efb827202a2d997a375e160a71eb2888a925aac1/pathspec-1.1.1.tar.gz", hash = "sha256:17db5ecd524104a120e173814c90367a96a98d07c45b2e10c2f3919fff91bf5a", size = 135180, upload-time = "2026-04-27T01:46:08.907Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/f1/d9/7fb5aa316bc299258e68c73ba3bddbc499654a07f151cba08f6153988714/pathspec-1.1.1-py3-none-any.whl", hash = "sha256:a00ce642f577bf7f473932318056212bc4f8bfdf53128c78bbd5af0b9b20b189", size = 57328, upload-time = "2026-04-27T01:46:07.06Z" }, ] [[package]] name = "pillow" version = "12.3.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/1c/3d/bb7fca845737cf9d7dbde16ed1843984665ff2e0a518f5db43e77ec540b9/pillow-12.3.0.tar.gz", hash = "sha256:3b8182a766685eaa002637e28b4ec8d6b18819a0c71f579bf0dbaa5830297cce", size = 47025035, upload-time = "2026-07-01T11:56:38.965Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/37/bf/fb3ebff8ddcb76aac5a01389251bbbb9519922a9b520d8247c1ca864a25d/pillow-12.3.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:ba09209fbe443b4acccebe845d8a138b89a8f4fbaeedd44953490b5315d5e965", size = 5345969, upload-time = "2026-07-01T11:54:06.397Z" }, { url = "https://files.pythonhosted.org/packages/d8/66/9a386a92561f402389a4fc70c18838bf6d35eb5eb5c6850b4b2dc64f5048/pillow-12.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ffd0c5368496f41b0944be820fcb7a838aa6e623d250b01acf2643939c3f99d7", size = 4780323, upload-time = "2026-07-01T11:54:09.351Z" }, { url = "https://files.pythonhosted.org/packages/25/27/ac8f99618ffd3dde21db0f4d4b1d2ab00c0880595bfd17df103f7f39fd0c/pillow-12.3.0-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:d9c7f76c0673154f044e9d78c8655fb4213f6ca31a836df48b40fe5d187717b9", size = 6266838, upload-time = "2026-07-01T11:54:11.71Z" }, { url = "https://files.pythonhosted.org/packages/84/21/a35af28dcc61f37ed850a2d64c65c701321dfbf25085e469d5559360cbbf/pillow-12.3.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:78cb2c6865a35ab8ff8b75fd122f6033b92a62c82801110e48ddd6c936a45d91", size = 6940830, upload-time = "2026-07-01T11:54:13.732Z" }, { url = "https://files.pythonhosted.org/packages/eb/51/8b08617af3ad95e33ce6d7dd2c99ed6c8298f7fb131636303956be022e25/pillow-12.3.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e491916b378fba47242221bb9ead245211b70d504f495d105d17b14a24b4907c", size = 6344383, upload-time = "2026-07-01T11:54:15.756Z" }, { url = "https://files.pythonhosted.org/packages/1d/72/cf78ac9780bb93c28328f408973845a309d4d145041665f734572ced1b52/pillow-12.3.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:0dd2064cbc55aaec028ef5fbb60fa47bb6c3e7918e07ff17935284b227a9d2df", size = 7052934, upload-time = "2026-07-01T11:54:17.721Z" }, { url = "https://files.pythonhosted.org/packages/20/20/25e0f4dc178a6bc0696793720055519a0de89e7661dae886992decbd2f81/pillow-12.3.0-cp312-cp312-win32.whl", hash = "sha256:dbce0b29841537a2fa4a214c2bbf14de3587c9680caa9b4e217568472490b28f", size = 6472684, upload-time = "2026-07-01T11:54:19.839Z" }, { url = "https://files.pythonhosted.org/packages/45/89/da2f7971a317f83d807fdd4065c0af40208e59e692cc43d315a71a0e96d1/pillow-12.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:a2b55dd6b2a4c4b7d87ffa56bdb33fdc5fdb9a462173861a7bc097f17d91cb09", size = 7227137, upload-time = "2026-07-01T11:54:22.025Z" }, { url = "https://files.pythonhosted.org/packages/de/47/4845a0a6c0dbf1db8456bd9fc791f13c5ced7ced20606d08a0aacfd25b49/pillow-12.3.0-cp312-cp312-win_arm64.whl", hash = "sha256:331b624368d4f1d069149002f25f44bc61c8919ce8ddb3c45bdad8f6e2d89510", size = 2568267, upload-time = "2026-07-01T11:54:24.051Z" }, { url = "https://files.pythonhosted.org/packages/9d/ac/31fb64e1e7efb5a4b50cd3d92049ba89ac6e4d8d3bb6a74e15048ca3353e/pillow-12.3.0-cp313-cp313-ios_13_0_arm64_iphoneos.whl", hash = "sha256:21900ce7ba264168cd50defae43cd75d25c833ad4ad6e73ffc5596d12e25ac89", size = 4161684, upload-time = "2026-07-01T11:54:25.934Z" }, { url = "https://files.pythonhosted.org/packages/87/b4/9805e23d2b4d77842b468513841fda254ee42f0289d25088340e4ff46e2d/pillow-12.3.0-cp313-cp313-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:4e8c2a84d977f50b9daed6eeaf3baef67d00d5d74d932288f02cb94518ee3ace", size = 4255487, upload-time = "2026-07-01T11:54:27.935Z" }, { url = "https://files.pythonhosted.org/packages/df/39/ecf519435a200c693fe053a6ee4d835b41cf963a4dfc2551c4e637cb2a71/pillow-12.3.0-cp313-cp313-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:ae26d61dfa7a47befdc7572b521024e8745f3d809bd95ca9505a7bba9ef849ec", size = 3696433, upload-time = "2026-07-01T11:54:29.813Z" }, { url = "https://files.pythonhosted.org/packages/42/92/2fc3ffad878ae8dd5469ec1bc8eb83b71f48e13efdf68f02709003982a32/pillow-12.3.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:7a743ff716f746fc19a9557f60dab1600d4613255f8a7aeb3cdde4db7eb15a66", size = 5345889, upload-time = "2026-07-01T11:54:31.97Z" }, { url = "https://files.pythonhosted.org/packages/10/76/8803c13605b763d33d156c4678fc77f8443389c0c51c8aef707bb02015f4/pillow-12.3.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:d69141514cc30b774ceea5e3ed3a6635c8d8a96edf664689b890f4089111fb35", size = 4780109, upload-time = "2026-07-01T11:54:34.026Z" }, { url = "https://files.pythonhosted.org/packages/1f/01/e18aff37cb0b4aac47ac90f016d347a49aca667ef97f190b06ac2aabc928/pillow-12.3.0-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f7401aebd7f581d7f83a439d87d474999317ee099218e5ad25d125290990ba65", size = 6263736, upload-time = "2026-07-01T11:54:36.131Z" }, { url = "https://files.pythonhosted.org/packages/f7/62/de5bdd77d935331f4f802edc11e4d82950f642caad6cb2f949837b8560e2/pillow-12.3.0-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0847a763afefb695bc912d7c131e7e0632d4edc1d8698f58ddabec8e46b8b6d3", size = 6937129, upload-time = "2026-07-01T11:54:38.216Z" }, { url = "https://files.pythonhosted.org/packages/70/4d/105627a13300c5e0df1d174230b32fd1273062c96f7745fd552b945d1e1d/pillow-12.3.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:571b9fcb07b97ef3a492028fb3d2dc0993ca23a06138b0315286566d29ef718a", size = 6339562, upload-time = "2026-07-01T11:54:40.354Z" }, { url = "https://files.pythonhosted.org/packages/6b/1d/f13de01a553988ab895ba1c722e06cf3144d4f57656fd5b81b6d881f1179/pillow-12.3.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:756c768d0c9c2955feb7a56c37ea24aea2e369f8d36a88da270b6a9f19e62b5e", size = 7049439, upload-time = "2026-07-01T11:54:42.489Z" }, { url = "https://files.pythonhosted.org/packages/c9/f9/066794cca041b969964f779ee5fa66a9498bbf34248ac39c5d7954e4198f/pillow-12.3.0-cp313-cp313-win32.whl", hash = "sha256:a876864214e136f0eb367788dbd7df045f4806801518e2cfe9e13229cfe06d8f", size = 6473287, upload-time = "2026-07-01T11:54:44.9Z" }, { url = "https://files.pythonhosted.org/packages/a6/9b/7a58e61d62be561da3a356fe2384d4059a6345fc130e23ef1c36a5b81d24/pillow-12.3.0-cp313-cp313-win_amd64.whl", hash = "sha256:1cca606cd25738df4ed873d5ad46bbdb3d83b5cbca291f6b4ff13a4df6b0bbe8", size = 7239691, upload-time = "2026-07-01T11:54:47.141Z" }, { url = "https://files.pythonhosted.org/packages/aa/b0/c4ed4f0ef8f8fa5ee8351537db6650bb8189f7e118842978dd6589065692/pillow-12.3.0-cp313-cp313-win_arm64.whl", hash = "sha256:b629de27fda84b42cde7edef0d85f13b958b47f6e9bbcbba9b673c562a89bd8b", size = 2568185, upload-time = "2026-07-01T11:54:49.137Z" }, { url = "https://files.pythonhosted.org/packages/dc/01/001f65b68192f0228cc1dbbc8d2530ab5d58b61037ba0587f946fea607cd/pillow-12.3.0-cp314-cp314-ios_13_0_arm64_iphoneos.whl", hash = "sha256:9cf95fe4d0f84c82d282745d9bb08ad9f926efa00be4697e767b814ce40d4330", size = 4161736, upload-time = "2026-07-01T11:54:51.156Z" }, { url = "https://files.pythonhosted.org/packages/1a/d2/0219746d0fd16fc8a84498e79452375be3797d3ce4044596ce565164b84f/pillow-12.3.0-cp314-cp314-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:8728f216dcdb6e6d555cf971cb34076139ad74b31fc2c14da4fafc741c5f6217", size = 4255435, upload-time = "2026-07-01T11:54:53.414Z" }, { url = "https://files.pythonhosted.org/packages/c8/02/8d0bc62ef0302318c46ff2a512822d2610e81c7aa46c9b3abe6cbaca5ad0/pillow-12.3.0-cp314-cp314-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:a45650e8ce7fafffd731db8550230db6b0d306d181a90b67d3e6bca2f1990930", size = 3696262, upload-time = "2026-07-01T11:54:55.739Z" }, { url = "https://files.pythonhosted.org/packages/85/e2/73c77d218410b14f5f2d565e8a998d5317b7b9c75368d29985139f7a46f0/pillow-12.3.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:ba54cfebe86920a559a7c4d6b9050791c20513650a1952ebe3368c7dc70306f8", size = 5350344, upload-time = "2026-07-01T11:54:57.657Z" }, { url = "https://files.pythonhosted.org/packages/c7/da/32c752228ae345f489e3a42499d817b6c3996da7e8a3bc7a04fc806b243b/pillow-12.3.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:e158cb00350dc278f3b91551101aa7d12415a66ebf2c91d8d5ac14e56ddd3ad0", size = 4780131, upload-time = "2026-07-01T11:54:59.713Z" }, { url = "https://files.pythonhosted.org/packages/b1/9d/8b2c807dbef61a5197c047afe99823787eb66f63daf9fb2432f91d6f0462/pillow-12.3.0-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:e9aeb04d6aef139de265b29683e119b638208f88cf73cdd1658aa07221165321", size = 6263757, upload-time = "2026-07-01T11:55:01.778Z" }, { url = "https://files.pythonhosted.org/packages/5c/44/c85361f65dbe00eea8576ee467c768d25129989efb76e94f205e9ca9bb46/pillow-12.3.0-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:251bf95b67017e27b13d82f5b326234ca62d70f9cf4c2b9032de2358a3b12c7b", size = 6936962, upload-time = "2026-07-01T11:55:03.93Z" }, { url = "https://files.pythonhosted.org/packages/18/7e/e483414b35800b86b6f08dbbc7803fb5cd52c4d6f897f47d53ea2c7e6f65/pillow-12.3.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:fe3cca2e4e8a592be0f269a1ca4835c25199d9f3ce815c8491048f785b0a0198", size = 6339171, upload-time = "2026-07-01T11:55:05.989Z" }, { url = "https://files.pythonhosted.org/packages/f0/f4/68c491844841ede6bed70189546b3ee9731cf9f2cbad396faff5e1ccba45/pillow-12.3.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:23aceaa007d6172b02c277f0cd359c79492bbb14f7072b4ede9fbcaf20648130", size = 7048116, upload-time = "2026-07-01T11:55:08.131Z" }, { url = "https://files.pythonhosted.org/packages/a3/34/77f3f793fed8efc7d243f21b33c5a3f0d1c97ee70346d3db855587e155ff/pillow-12.3.0-cp314-cp314-win32.whl", hash = "sha256:af8d94b0db561cf68b88a267c5c44b49e134f525d0dc2cb7ed413a66bc23559a", size = 6467209, upload-time = "2026-07-01T11:55:10.408Z" }, { url = "https://files.pythonhosted.org/packages/f1/e0/492879f69d94f91f60fc8cd05ba03650e9520afebb2fb7aa12777d7c7f38/pillow-12.3.0-cp314-cp314-win_amd64.whl", hash = "sha256:fdafc9cce40277e0f7a0feabce0ee50dd2fa1800f3b38015e51296b5e814048d", size = 7237707, upload-time = "2026-07-01T11:55:12.745Z" }, { url = "https://files.pythonhosted.org/packages/c9/ac/6b11f2875f1c2ac040d84e1bbf9cf22a88038f901ca1037898b280b38365/pillow-12.3.0-cp314-cp314-win_arm64.whl", hash = "sha256:e91206ee562682b51b98ef4b26a6ef48fd84e15fd4c4bc5ec768eb641d206838", size = 2565995, upload-time = "2026-07-01T11:55:14.736Z" }, { url = "https://files.pythonhosted.org/packages/52/69/c2208e56af9bfc1913afb24020297a691eb1d4ef688474c8a04913f65e04/pillow-12.3.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:164b31cd1a0490ab6efae01aa5df49da7061be0af1b30e035b6e9a1bfe34ee6e", size = 5352503, upload-time = "2026-07-01T11:55:17.076Z" }, { url = "https://files.pythonhosted.org/packages/07/70/e5686d753e898a45d778ff1718dba8516ead6ab6b95d85fc8c4b70650cf2/pillow-12.3.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:5afb51d599ea772b8365ae807ae557f18bccfe46ab261fd1c2a9ed700fc6eb17", size = 4782956, upload-time = "2026-07-01T11:55:19.448Z" }, { url = "https://files.pythonhosted.org/packages/d5/37/25c6692f06927ee973ff18c8d9ee98ad0b4d84ee67a09610c2dd1447958e/pillow-12.3.0-cp314-cp314t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:3edce1d53195db527e0191f84b71d02022de0540bf43a16ed734ed7537b07385", size = 6322855, upload-time = "2026-07-01T11:55:21.613Z" }, { url = "https://files.pythonhosted.org/packages/cc/91/420637fcb8f1bc11029e403b4538e6694744428d8246118e45719f944556/pillow-12.3.0-cp314-cp314t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bf16ba1b4d0b6b7c8e534936632270cf70eb00dbe09005bc345b2677b726855c", size = 6989642, upload-time = "2026-07-01T11:55:24.006Z" }, { url = "https://files.pythonhosted.org/packages/10/08/b94d7811281ccf0d143a1cf768d1c49e1e54af63e7b708ab2ee3eb87face/pillow-12.3.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:24870b09b224f7ae3c39ed07d10e819d06f8720bc551847b1d623832b5b0e28d", size = 6391281, upload-time = "2026-07-01T11:55:26.252Z" }, { url = "https://files.pythonhosted.org/packages/d2/87/24233f785f55474dc02ce3e739c5528a77e3a862e9333d1dd7a25cc31f70/pillow-12.3.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:30f2aa603c41533cc25c05acd0da21636e84a315768feb631c937177db558931", size = 7096716, upload-time = "2026-07-01T11:55:28.318Z" }, { url = "https://files.pythonhosted.org/packages/23/26/fcb2f6e37175b04f53570b59937867e2b80ee1685e744023153028fc14f9/pillow-12.3.0-cp314-cp314t-win32.whl", hash = "sha256:4b0a7fe987b14c31ebda6083f74f22b561fd3739bc0ac51e019622e3d72668c7", size = 6474125, upload-time = "2026-07-01T11:55:30.956Z" }, { url = "https://files.pythonhosted.org/packages/90/de/3634abee5f1c9e13c56787b7d5517b0ba8d6de51700b95578cf338349c9f/pillow-12.3.0-cp314-cp314t-win_amd64.whl", hash = "sha256:962864dc93511324d51ddbb5b9f8731bf71675b93ca612a07441896f4688fb8c", size = 7242939, upload-time = "2026-07-01T11:55:34.044Z" }, { url = "https://files.pythonhosted.org/packages/ce/2a/fd13f8eb24de5714a6eb444a3d67e2842c6c576e159a43793adf23051351/pillow-12.3.0-cp314-cp314t-win_arm64.whl", hash = "sha256:0740a512dc522224c77d9aa5a8d70d8b7d73fb91f2c21125d8d025d3b8990e45", size = 2567506, upload-time = "2026-07-01T11:55:35.988Z" }, { url = "https://files.pythonhosted.org/packages/5d/dc/8fdce34ec725a33c81c6ba122b904d6b9024e50ea9ac7bede62fab54506c/pillow-12.3.0-cp315-cp315-ios_13_0_arm64_iphoneos.whl", hash = "sha256:0feb2e9d6ad6c9e3c06effe9d00f3f1e618a6643273576b016f591e9315a7139", size = 4162063, upload-time = "2026-07-01T11:55:37.941Z" }, { url = "https://files.pythonhosted.org/packages/76/66/2044b9a63d3b84ff048228dfcb7cd9bf0df983e8470971bf7d4c57b693de/pillow-12.3.0-cp315-cp315-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:9e881fca225083806662a5c43d627d215f258ff43c890f831966c7d7ba9c7402", size = 4255549, upload-time = "2026-07-01T11:55:40.022Z" }, { url = "https://files.pythonhosted.org/packages/52/7e/1f67e6f4ece6b582ee4b539decbcc9f848dc245a93ed8cd7338bafef72f1/pillow-12.3.0-cp315-cp315-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:4998562bf62a445225f22e07c896bb04b35b1b1f2eb6d760584c9c51d7a5f78c", size = 3696331, upload-time = "2026-07-01T11:55:41.98Z" }, { url = "https://files.pythonhosted.org/packages/12/40/d306fc2c8e4d45d7f175c77edca7063be7b86fe7fe6e68f4353bf71d808c/pillow-12.3.0-cp315-cp315-macosx_10_15_x86_64.whl", hash = "sha256:dc624f6bc473dacdf7ef7eb8678d0d08edf15cd94fad6ae5c7d6cc67a4e4902f", size = 5350370, upload-time = "2026-07-01T11:55:44.028Z" }, { url = "https://files.pythonhosted.org/packages/dd/44/668fb1437e8ce420f62d6106eb66e44a5971602a4d794615bdf79315d82d/pillow-12.3.0-cp315-cp315-macosx_11_0_arm64.whl", hash = "sha256:71d6097b330eea8fd15097780c8e89cb1a8ce7838669f48c5bacd6f663dd4701", size = 4780147, upload-time = "2026-07-01T11:55:46.073Z" }, { url = "https://files.pythonhosted.org/packages/0c/08/93fa2e70e30a2d81547e481b6ee2bb9522117221fb1e0ce4b5df70967677/pillow-12.3.0-cp315-cp315-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:28ce87c5ab450a9dd970b52e5aca5fe63ed432d18a2eaddd1979a00a1ba24ace", size = 6273659, upload-time = "2026-07-01T11:55:48.264Z" }, { url = "https://files.pythonhosted.org/packages/f8/6d/043e96ff814fc31a33077e4cba86082167db520c93632afdf2042febbb0c/pillow-12.3.0-cp315-cp315-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6b02afb9b97f65fbca5f31db6a2a3ba21aa93030225f150fa3f249717e938fb4", size = 6947439, upload-time = "2026-07-01T11:55:50.503Z" }, { url = "https://files.pythonhosted.org/packages/af/92/ba71d2ee2ac0edf3fa33bd9d5ee9ee080da70b1766f3ca3934f9938ddac9/pillow-12.3.0-cp315-cp315-musllinux_1_2_aarch64.whl", hash = "sha256:1182d52bc2d5e5d7d0949503aa7e36d12f42205dc287e4883f407b1988820d39", size = 6353577, upload-time = "2026-07-01T11:55:52.697Z" }, { url = "https://files.pythonhosted.org/packages/0f/ce/e63064e2122923ff687c8ad792d0d736a7b3920a56a46982e81a7fdd25d6/pillow-12.3.0-cp315-cp315-musllinux_1_2_x86_64.whl", hash = "sha256:e795b7eb908249c4e43c7c99fac7c2c75dab0c43566e37db472a355f63693d71", size = 7060394, upload-time = "2026-07-01T11:55:55.149Z" }, { url = "https://files.pythonhosted.org/packages/54/76/a09cc3ccc8d773a7283d34c38bec1708f9e3cc932093cbc4c5e71ac4060b/pillow-12.3.0-cp315-cp315-win32.whl", hash = "sha256:57b3d78c95ba9059768b10e28b813002261d3f3dfc55cc48b0c988f625175827", size = 6467375, upload-time = "2026-07-01T11:55:57.769Z" }, { url = "https://files.pythonhosted.org/packages/3e/03/1846c49ba3b1d5550392a4bbd06d6fb4578e1cd91a803198b5c90f5f7d53/pillow-12.3.0-cp315-cp315-win_amd64.whl", hash = "sha256:fa4ecea169a355be7a3ade2c783e2ed12f0e40d2c5621cda8b3297faf7fbb9f5", size = 7237048, upload-time = "2026-07-01T11:55:59.975Z" }, { url = "https://files.pythonhosted.org/packages/fb/bb/89f35dcc79610423f9f195504d7def7f0d1416a711541b42867e25fe3412/pillow-12.3.0-cp315-cp315-win_arm64.whl", hash = "sha256:877c3f311ff35410f690861c4409e7ccbf0cd2f878e50628a28e5a0bb689e658", size = 2566006, upload-time = "2026-07-01T11:56:02.143Z" }, { url = "https://files.pythonhosted.org/packages/30/88/707027ba09942dfa2c28759b5c222d769290a41c6d20ea60ec250801941f/pillow-12.3.0-cp315-cp315t-macosx_10_15_x86_64.whl", hash = "sha256:e9871b1ffbfa9656b60aeee92ed5136a5742696006fa322b29ea3d8da0ecc9cf", size = 5352509, upload-time = "2026-07-01T11:56:04.2Z" }, { url = "https://files.pythonhosted.org/packages/b0/6d/00352fa25332c2569cd387851f568cc5a4b75a9adbfb37ac4fbce4c02eec/pillow-12.3.0-cp315-cp315t-macosx_11_0_arm64.whl", hash = "sha256:53aa02d20d10c3d814d536aa4e5ac9b84ca0ff5a88377963b085ad6822f93e64", size = 4783167, upload-time = "2026-07-01T11:56:06.631Z" }, { url = "https://files.pythonhosted.org/packages/13/4f/9e049dfa21af7c22427275720e2490267ba8138120add5c4c574deb69782/pillow-12.3.0-cp315-cp315t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:446c34dcc4324b084a53b705127dc15717b22c5e140ae0a3c38349d4efec071e", size = 6329237, upload-time = "2026-07-01T11:56:08.868Z" }, { url = "https://files.pythonhosted.org/packages/36/16/cf6eeaae8d0fce8dd390a33437cf68c5d5bd73834a2bc6e2f14efda0ab45/pillow-12.3.0-cp315-cp315t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:cf1845d02ad822a369a49f2bb9345b1614744267682e7a03527dc3bf6eea1777", size = 6997047, upload-time = "2026-07-01T11:56:11.379Z" }, { url = "https://files.pythonhosted.org/packages/1e/69/dbf769bdd55f48bf5733cac28edc6364ffaa072ec9ba336266e4fe66be55/pillow-12.3.0-cp315-cp315t-musllinux_1_2_aarch64.whl", hash = "sha256:186941b6aef820ad110fb01fb06eb925374dc3a21b17e37ec9a53b250c6fe2d1", size = 6400440, upload-time = "2026-07-01T11:56:13.908Z" }, { url = "https://files.pythonhosted.org/packages/a0/e1/ffc9cfc2eea0d178da8018e18e959301ad9d6bc9f3edb7181e748a474b97/pillow-12.3.0-cp315-cp315t-musllinux_1_2_x86_64.whl", hash = "sha256:f13c32a3abd6079a66d9526e18dad9b6d280384d49d7c54040cd57b6424041d9", size = 7105895, upload-time = "2026-07-01T11:56:16.575Z" }, { url = "https://files.pythonhosted.org/packages/18/f0/a5595c1e8c3ae44b9828cb2f0fa8155e5095ef04d6327b8f61cf44a3df85/pillow-12.3.0-cp315-cp315t-win32.whl", hash = "sha256:1657923d2d45afb66526e5b933e5b3052e6bdea196c90d3abb2424e18c77dae8", size = 6474384, upload-time = "2026-07-01T11:56:18.855Z" }, { url = "https://files.pythonhosted.org/packages/e4/04/62bcd9f844984c5938d3b05264a61d797a29d3e0812341a8204af70bbdee/pillow-12.3.0-cp315-cp315t-win_amd64.whl", hash = "sha256:8cd2f7bdda092d99c9fc2fb7391354f306d01443d22785d0cbfafa2e2c8bb418", size = 7243537, upload-time = "2026-07-01T11:56:21.214Z" }, { url = "https://files.pythonhosted.org/packages/3d/68/1f3066acedf37673694a7141381d8f811ae97f30d34413d236abe7d489f1/pillow-12.3.0-cp315-cp315t-win_arm64.whl", hash = "sha256:06ff022112bc9cbf83b60f8e028d94ad87b60621706487e65f673de61610ab59", size = 2567491, upload-time = "2026-07-01T11:56:23.506Z" }, ] [[package]] name = "platformdirs" version = "4.9.6" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/9f/4a/0883b8e3802965322523f0b200ecf33d31f10991d0401162f4b23c698b42/platformdirs-4.9.6.tar.gz", hash = "sha256:3bfa75b0ad0db84096ae777218481852c0ebc6c727b3168c1b9e0118e458cf0a", size = 29400, upload-time = "2026-04-09T00:04:10.812Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/75/a6/a0a304dc33b49145b21f4808d763822111e67d1c3a32b524a1baf947b6e1/platformdirs-4.9.6-py3-none-any.whl", hash = "sha256:e61adb1d5e5cb3441b4b7710bea7e4c12250ca49439228cc1021c00dcfac0917", size = 21348, upload-time = "2026-04-09T00:04:09.463Z" }, ] [[package]] name = "pluggy" version = "1.6.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/f9/e2/3e91f31a7d2b083fe6ef3fa267035b518369d9511ffab804f839851d2779/pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", size = 69412, upload-time = "2025-05-15T12:30:07.975Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" }, ] [[package]] name = "propcache" version = "0.5.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/ec/44/c87281c333769159c50594f22610f77398a47ccbfbbf23074e744e86f87c/propcache-0.5.2.tar.gz", hash = "sha256:01c4fc7480cd0598bb4b57022df55b9ca296da7fc5a8760bd8451a7e63a7d427", size = 50208, upload-time = "2026-05-08T21:02:12.199Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/4a/cb/e27bc2b2737a0bb49962b275efa051e8f1c35a936df7d5139b6b658b7dc9/propcache-0.5.2-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:806719138ecd720339a12410fb9614ac9b2b2d3a5fdf8235d56981c36f4039ba", size = 95887, upload-time = "2026-05-08T21:00:11.277Z" }, { url = "https://files.pythonhosted.org/packages/e6/13/b8ae04c59392f8d11c6cd9fb4011d1dc7c86b81225c770280300e259ffe1/propcache-0.5.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:db2b80ea58eab4f86b2beec3cc8b39e8ff9276ac20e96b7cce43c8ae84cd6b5a", size = 54654, upload-time = "2026-05-08T21:00:12.604Z" }, { url = "https://files.pythonhosted.org/packages/2c/7d/49777a3e20b55863d4794384a38acd460c04157b0a00f8602b0d508b8431/propcache-0.5.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:e5cbfac9f61484f7e9f3597775500cd3ebe8274e9b050c38f9525c77c97520bf", size = 55190, upload-time = "2026-05-08T21:00:13.935Z" }, { url = "https://files.pythonhosted.org/packages/44/c7/085d0cd63062e84044e3f05797749c3f8e3938ff3aeb0eb2f69d43fafc91/propcache-0.5.2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5dbc581d2814337da56222fab8dc5f161cd798a434e49bac27930aaef798e144", size = 59995, upload-time = "2026-05-08T21:00:15.526Z" }, { url = "https://files.pythonhosted.org/packages/9c/42/32cf8e3009e92b2645cf1e944f701e8ea4e924dffde1ee26db860bcbf7e4/propcache-0.5.2-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:857187f381f88c8e2fa2fe56ab94879d011b883d5a2ee5a1b60a8cd2a06846d9", size = 63422, upload-time = "2026-05-08T21:00:16.824Z" }, { url = "https://files.pythonhosted.org/packages/9e/1b/f112433f99fc979431b87a39ef169e3f8df070d99a72792c56d6937ac48b/propcache-0.5.2-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:178b4a2cdaac1818e2bf1c5a99b94383fa73ea5382e032a48dec07dc5668dc42", size = 64342, upload-time = "2026-05-08T21:00:18.362Z" }, { url = "https://files.pythonhosted.org/packages/14/15/5574111ae50dd6e879456888c0eadd4c5a869959775854e18e18a6b345f3/propcache-0.5.2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6f328175a2cde1f0ff2c4ed8ce968b9dcfb55f3a7153f39e2957ed994da13476", size = 61639, upload-time = "2026-05-08T21:00:19.692Z" }, { url = "https://files.pythonhosted.org/packages/cc/da/4d775080b1490c0ae604acda868bd71aabe3a89ed16f2aa4339eb8a283e7/propcache-0.5.2-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:5671d09a36b06d0fd4a3da0fccbcae360e9b1570924171a15e9e0997f0249fba", size = 61588, upload-time = "2026-05-08T21:00:21.155Z" }, { url = "https://files.pythonhosted.org/packages/04/ac/f076982cbe2195ee9cf32de5a1e46951d9fb399fc207f390562dd0fd8fb2/propcache-0.5.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:80168e2ebe4d3ec6599d10ad8f520304ae1cad9b6c5a95372aef1b66b7bfb53a", size = 60029, upload-time = "2026-05-08T21:00:22.713Z" }, { url = "https://files.pythonhosted.org/packages/70/60/189be62e0dd898dce3b331e1b8c7a543cd3a405ac0c81fe8ee8a9d5d77e1/propcache-0.5.2-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:45f11346f884bc47444f6e6647131055844134c3175b629f84952e2b5cd62b64", size = 56774, upload-time = "2026-05-08T21:00:24.001Z" }, { url = "https://files.pythonhosted.org/packages/ea/9e/93377b9c7939c1ffae98f878dee955efadfd638078bc86dbc21f9d52f651/propcache-0.5.2-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:8e778ebd44ef4f66ed60a0416b06b489687db264a9c0b3620362f26489492913", size = 63532, upload-time = "2026-05-08T21:00:25.545Z" }, { url = "https://files.pythonhosted.org/packages/14/f9/590ef6cfb9b8028d516d287812ece32bb0bc5f11fbb9c8bf6b2e6313fec8/propcache-0.5.2-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:c0cb9ed24c8964e172768d455a38254c2dd8a552905729ce006cad3d3dda59b1", size = 61592, upload-time = "2026-05-08T21:00:27.186Z" }, { url = "https://files.pythonhosted.org/packages/b4/5e/70958b3034c297a630bba2f17ca7abc2d5f39a803ad7e370ab79d1ecd022/propcache-0.5.2-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:1d1ad32d9d4355e2be65574fd0bfd3677e7066b009cd5b9b2dee8aa6a6393b33", size = 64788, upload-time = "2026-05-08T21:00:28.8Z" }, { url = "https://files.pythonhosted.org/packages/12/fd/77fe5936d8c3086ca9048f7f415f122ed82e53884a9ec193646b42deef06/propcache-0.5.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:c80f4ba3e8f00189165999a742ee526ebeccedf6c3f7beb0c7df821e9772435a", size = 62514, upload-time = "2026-05-08T21:00:30.098Z" }, { url = "https://files.pythonhosted.org/packages/cf/74/66bd798b5b3be70aa1b391f5cc9d6a0a5532d7fd3b19ec0b213e72e6ad9d/propcache-0.5.2-cp312-cp312-win32.whl", hash = "sha256:8c7972d8f193740d9175f0998ab38717e6cd322d5935c5b0fef8c0d323fd9031", size = 39018, upload-time = "2026-05-08T21:00:31.622Z" }, { url = "https://files.pythonhosted.org/packages/61/7c/5c0d34aa3024694d6dcb9271cdbdd08c4e47c1c0ad95ec7e7bc74cdea145/propcache-0.5.2-cp312-cp312-win_amd64.whl", hash = "sha256:d9ee8826a7d47863a08ac44e1a5f611a462eefc3a194b492da242128bec75b42", size = 42322, upload-time = "2026-05-08T21:00:32.918Z" }, { url = "https://files.pythonhosted.org/packages/4d/91/875812f1a3feb20ceba818ef39fbe4d92f1081e04ac815c822496d0d038b/propcache-0.5.2-cp312-cp312-win_arm64.whl", hash = "sha256:2800a4a8ead6b28cccd1ec54b59346f0def7922ee1c7598e8499c733cfbb7c84", size = 38172, upload-time = "2026-05-08T21:00:35.124Z" }, { url = "https://files.pythonhosted.org/packages/c5/09/f049e45385503fe67db75a6b6186a7b9f0c3930366dc960522c312a825b1/propcache-0.5.2-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:099aaf4b4d1a02265b92a977edf00b5c4f63b3b17ac6de39b0d637c9cac0188a", size = 94457, upload-time = "2026-05-08T21:00:36.355Z" }, { url = "https://files.pythonhosted.org/packages/6b/65/83d1d05655baf63113731bd5a1008435e14f8d1e5a06cbe4ec5b23ad7a31/propcache-0.5.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:68ce1c44c7a813a7f71ea04315a8c7b330b63db99d059a797a4651bb6f69f117", size = 53835, upload-time = "2026-05-08T21:00:38.072Z" }, { url = "https://files.pythonhosted.org/packages/a9/12/a6ba6482bb5ea3260c000c9b20881c95fa11c6b30173715668259f844ed7/propcache-0.5.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:fc299c129490f55f254cd90be0deca4764e36e9a7c08b4aa588479a3bbed3098", size = 54545, upload-time = "2026-05-08T21:00:39.319Z" }, { url = "https://files.pythonhosted.org/packages/a9/19/7fa086f5764c59ec8a8e157cd93aa8497acc00aba9dcdec56bfffb32602d/propcache-0.5.2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a6ae2198be502c10f09b2516e7b5d019816924bc3183a43ce792a7bd6625e6f4", size = 59886, upload-time = "2026-05-08T21:00:40.621Z" }, { url = "https://files.pythonhosted.org/packages/a1/e4/5d7663dc8235956c8f5281698a3af1d351d8820341ddd890f59d9a9127f2/propcache-0.5.2-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:6041d31504dc1779d700e1edcfb08eea334b357620b06681a4eabb57a74e574e", size = 63261, upload-time = "2026-05-08T21:00:41.775Z" }, { url = "https://files.pythonhosted.org/packages/4a/4a/15a03adee24d6350da4292caeac44c34c033d2afe5e87eb370f38854560f/propcache-0.5.2-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:f7eabc04151c78a9f4d5bbb5f1faf571e4defeb4b585e0fe95b60ff2dbe4d3d7", size = 64184, upload-time = "2026-05-08T21:00:43.018Z" }, { url = "https://files.pythonhosted.org/packages/8b/c6/979176efdaa3d239e36d503d5af63a0a773b36662ed8f52e5b6a6d9fd40e/propcache-0.5.2-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4db0ba63d693afd40d249bd93f842b5f144f8fcbb83de05660373bcf30517b1d", size = 61534, upload-time = "2026-05-08T21:00:44.507Z" }, { url = "https://files.pythonhosted.org/packages/c8/22/63e8cd1bae4c2d2be6493b6b7d10566ddafad88137cfbc99964a1119853c/propcache-0.5.2-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:1dbcf7675229b35d31abb6547d8ebc8c27a830ac3f9a794edff6254873ec7c0a", size = 61500, upload-time = "2026-05-08T21:00:45.796Z" }, { url = "https://files.pythonhosted.org/packages/60/5a/28e5d9acbac1cc9ccb67045e8c1b943aa8d79fdf39c93bd73cacd68008ea/propcache-0.5.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:d310c013aad2c72f1c3f2f8dd3279d460a858c551f97aeb8c63e4693cca7b4d2", size = 59994, upload-time = "2026-05-08T21:00:47.093Z" }, { url = "https://files.pythonhosted.org/packages/f3/40/db650677f554a95b9c01a7c9d93d629e93a15562f5deb4573c9ee136fed2/propcache-0.5.2-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:06187263ddad280d05b4d8a8b3bb7d164cbebd469236544a42e6d9b28ac6a4fa", size = 56884, upload-time = "2026-05-08T21:00:48.376Z" }, { url = "https://files.pythonhosted.org/packages/80/45/70b39b89516ff8b96bf732fa6fded8cef20f293cb1508690101c3c07ec51/propcache-0.5.2-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:3115559b8effafd63b142ea5ed53d63a16ea6469cbc63dce4ee194b42db5d853", size = 63464, upload-time = "2026-05-08T21:00:49.954Z" }, { url = "https://files.pythonhosted.org/packages/f9/e2/fa59d3a89eac5534293124af4f1d0d0ada091ce4a0ab4610ce03fd2bdd8d/propcache-0.5.2-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:c60462af8e6dc30c35407c7237ea908d777b22862bbee27bc4699c0d8bcdc45a", size = 61588, upload-time = "2026-05-08T21:00:51.281Z" }, { url = "https://files.pythonhosted.org/packages/0b/97/efb547a55c4bc7381cfb202d6a2239ac621045277bc1ea5dfd3a7f0516c0/propcache-0.5.2-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:40314bca9ac559716fe374094fc81c11dcc34b64fd6c585360f5775690505704", size = 64667, upload-time = "2026-05-08T21:00:52.602Z" }, { url = "https://files.pythonhosted.org/packages/92/56/f5c7d9b4b7595d5127da38974d791b2153f3d1eae6c674af3583ace92ad3/propcache-0.5.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:cfa21e036ce1e1db2be04ba3b85d2df1bb1702fa01932d984c5464c665228ff4", size = 62463, upload-time = "2026-05-08T21:00:54.303Z" }, { url = "https://files.pythonhosted.org/packages/bd/3b/484a3a65fc9f9f60c41dcd17b428bace5389544e2c680994534a20755066/propcache-0.5.2-cp313-cp313-win32.whl", hash = "sha256:f156a3529f38063b6dbaf356e15602a7f95f8055b1295a438433a6386f10463d", size = 38621, upload-time = "2026-05-08T21:00:55.808Z" }, { url = "https://files.pythonhosted.org/packages/1c/fd/3f0f10dba4dabad3bf53102be007abf55481067952bde0fdddff439e7c61/propcache-0.5.2-cp313-cp313-win_amd64.whl", hash = "sha256:dfed59d0a5aeb01e242e66ff0300bc4a265a7c05f612d30016f0b60b1017d757", size = 41649, upload-time = "2026-05-08T21:00:57.061Z" }, { url = "https://files.pythonhosted.org/packages/90/ec/6ce619cc32bb500a482f811f9cd509368b4e58e638d13f2c68f370d6b475/propcache-0.5.2-cp313-cp313-win_arm64.whl", hash = "sha256:ba338430e87ceb9c8f0cf754de38a9860560261e56c00376debd628698a7364f", size = 37636, upload-time = "2026-05-08T21:00:58.646Z" }, { url = "https://files.pythonhosted.org/packages/1b/82/c1d268bbbf2ef981c5bf0fbbe746db617c66e3bcefe431a1aa8943fbe23a/propcache-0.5.2-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:a592f5f3da71c8691c788c13cb6734b6d17663d2e1cb8caddf0673d01ef8847d", size = 98872, upload-time = "2026-05-08T21:00:59.889Z" }, { url = "https://files.pythonhosted.org/packages/f4/d4/52c871e73e864e6b34c0e2d58ac1ec5ccd149497ddc7ad2137ae98323a35/propcache-0.5.2-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:6a997d0489e9668a384fcfd5061b857aa5361de73191cac204d04b889cfbbafa", size = 56257, upload-time = "2026-05-08T21:01:01.195Z" }, { url = "https://files.pythonhosted.org/packages/67/f0/9b90ca2a210b3d09bcfcd96ecd0f55545c091535abce2a45de2775cfd357/propcache-0.5.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:10734b5484ea113152ee25a91dccedf81631791805d2c9ccb054958e51842c94", size = 56696, upload-time = "2026-05-08T21:01:02.941Z" }, { url = "https://files.pythonhosted.org/packages/9d/0e/6e9d4ba07c8e56e21ddec1e75f12148142b21ca83a51871babce095334f4/propcache-0.5.2-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:cafca7e56c12bb02ae16d283742bef25a61122e9dab2b5b3f2ccbe589ce32164", size = 62378, upload-time = "2026-05-08T21:01:04.475Z" }, { url = "https://files.pythonhosted.org/packages/65/19/c10badaa463dde8a27ce884f8ee2ec37e6035b7c9f5ff0c8f74f06f08dac/propcache-0.5.2-cp313-cp313t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f064f8d2b59177878b7615df1735cd8fe3462ed6be8c7b217d17a276489c2b7f", size = 65283, upload-time = "2026-05-08T21:01:05.959Z" }, { url = "https://files.pythonhosted.org/packages/b0/b6/93bea99ca80e19cef6512a8580e5b7857bbe09422d9daa7fd4ef5723306c/propcache-0.5.2-cp313-cp313t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:f78abfa8dfc32376fd1aacf597b2f2fbbe0ea751419aee718af5d4f82537ef8c", size = 66616, upload-time = "2026-05-08T21:01:07.228Z" }, { url = "https://files.pythonhosted.org/packages/83/e4/5c7462e50625f051f37fb38b8224f7639f667184bbd34424ec83819bb1b7/propcache-0.5.2-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f7467da8a9822bf1a55336f877340c5bcbd3c482afc43a99771169f74a26dedc", size = 63773, upload-time = "2026-05-08T21:01:08.514Z" }, { url = "https://files.pythonhosted.org/packages/ca/b6/99238894047b13c823be25027e736626cd414a52a5e30d2c3347c2733529/propcache-0.5.2-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:a6ddc6ac9e25de626c1f129c1b467d7ecd33ce2237d3fd0c4e429feef0a7ee1f", size = 63664, upload-time = "2026-05-08T21:01:09.874Z" }, { url = "https://files.pythonhosted.org/packages/85/1e/a3a1a63116a2b8edb415a8bb9a6f0c34bd03830b1e18e8ce2904e1dc1cf4/propcache-0.5.2-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:2f22cbbac9e26a8e864c0985ff1268d5d939d53d9d9411a9824279097e03a2cb", size = 62643, upload-time = "2026-05-08T21:01:11.132Z" }, { url = "https://files.pythonhosted.org/packages/e4/03/893cf147de2fc6543c5eaa07ad833170e7e2a2385725bbebe8c0503723bb/propcache-0.5.2-cp313-cp313t-musllinux_1_2_armv7l.whl", hash = "sha256:fc76378c62a0f04d0cd82fbb1a2cd2d7e28fcb40d5873f28a6c44e388aaa2751", size = 59595, upload-time = "2026-05-08T21:01:12.387Z" }, { url = "https://files.pythonhosted.org/packages/86/3b/04c1a2e12c57766568ba75ba72b3bf2042818d4c1425fab6fc07155c7cff/propcache-0.5.2-cp313-cp313t-musllinux_1_2_ppc64le.whl", hash = "sha256:acd2c8edba48e31e58a363b8cf4e5c7db3b04b3f9e371f601df30d9b0d244836", size = 65711, upload-time = "2026-05-08T21:01:13.676Z" }, { url = "https://files.pythonhosted.org/packages/1c/34/80f8d0099f8d6bacc4de1624c85672681c8cd1149ca2da0e38fd120b817f/propcache-0.5.2-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:452b5065457eb9991ec5eb38ff41d6cd4c991c9ac7c531c4d5849ae473a9a13f", size = 64247, upload-time = "2026-05-08T21:01:14.936Z" }, { url = "https://files.pythonhosted.org/packages/f3/1a/8b08f3a5f1037e9e370c55883ceeeee0f6dd0416fb2d2d67b8bfc91f2a79/propcache-0.5.2-cp313-cp313t-musllinux_1_2_s390x.whl", hash = "sha256:3430bb2bfe1331885c427745a751e774ee679fd4344f80b97bf879815fe8fa55", size = 67102, upload-time = "2026-05-08T21:01:16.281Z" }, { url = "https://files.pythonhosted.org/packages/34/68/8bdb7bb7756d76e005490649d10e4a8369e610c74d619f71e1aedf889e9c/propcache-0.5.2-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:cef6cea3922890dd6c9654971001fa797b526c16ab5e1e46c05fd6f877be7568", size = 64964, upload-time = "2026-05-08T21:01:17.57Z" }, { url = "https://files.pythonhosted.org/packages/0a/aa/50fb0b5d3968b61a510926ff8b8465f1d6e976b3ab74496d7a4b9fc42515/propcache-0.5.2-cp313-cp313t-win32.whl", hash = "sha256:72d61e16dd78228b58c5d47be830ff3da7e5f139abdf0aef9d86cde1c5cf2191", size = 42546, upload-time = "2026-05-08T21:01:18.946Z" }, { url = "https://files.pythonhosted.org/packages/ae/4c/0ddbae64321bd4a95bcbfc19307238016b5b1fee645c84626c8d539e5b74/propcache-0.5.2-cp313-cp313t-win_amd64.whl", hash = "sha256:0958834041a0166d343b8d2cedcd8bcbaeb4fdbe0cf08320c5379f143c3be6e7", size = 46330, upload-time = "2026-05-08T21:01:20.162Z" }, { url = "https://files.pythonhosted.org/packages/00/d9/9cddc8efb78d8af264c5ec9f6d10b62f57c515feda8d321595f56010fb23/propcache-0.5.2-cp313-cp313t-win_arm64.whl", hash = "sha256:6de8bd93ddde9b992cf2b2e0d796d501a19026b5b9fd87356d7d0779531a8d96", size = 40521, upload-time = "2026-05-08T21:01:21.399Z" }, { url = "https://files.pythonhosted.org/packages/e2/ea/23ee535d90ce8bcc465a3028eb3cc0ce3bd1005f4bb27710b30587de798d/propcache-0.5.2-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:46088abff4cba581dea21ae0467a480526cb25aa5f3c269e909f800328bc3999", size = 94662, upload-time = "2026-05-08T21:01:22.683Z" }, { url = "https://files.pythonhosted.org/packages/b5/06/c5a52f419b5d8972f8d46a7577476090d8e3263ff589ce40b5ca4968d5be/propcache-0.5.2-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:fc88b26f08d634f7bc819a7852e5214f5802641ab8d9fd5326892292eee1993e", size = 53928, upload-time = "2026-05-08T21:01:23.986Z" }, { url = "https://files.pythonhosted.org/packages/63/b1/4260d67d6bd85e58a66b72d54ce15d5de789b6f3870cc6bedf8ff9667401/propcache-0.5.2-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:97797ebb098e670a2f92dd66f32897e30d7615b14e7f59711de23e30a9072539", size = 54650, upload-time = "2026-05-08T21:01:25.305Z" }, { url = "https://files.pythonhosted.org/packages/70/06/2f46c318e3307cd7a6a7481def374ce838c0fe20084b39dd54b0879d0e99/propcache-0.5.2-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ba57fffe4ac99c5d30076161b5866336d97600769bad35cc68f7774b15298a4e", size = 59912, upload-time = "2026-05-08T21:01:26.545Z" }, { url = "https://files.pythonhosted.org/packages/4c/29/fe1aebec2ce57ab985a9c382bded1124431f85078113aa222c5d278430d4/propcache-0.5.2-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:583c19759d9eec1e5b69e2fbef36a7d9c326041be9746cb822d335c8cedc2979", size = 63300, upload-time = "2026-05-08T21:01:27.937Z" }, { url = "https://files.pythonhosted.org/packages/b4/18/2334b26768b6c82be8c69e83671b767d5ef426aa09b0cba6c2ea47816774/propcache-0.5.2-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:d0326e2e5e1f3163fa306c834e48e8d490e5fae607a097a40c0648109b47ba80", size = 64208, upload-time = "2026-05-08T21:01:29.484Z" }, { url = "https://files.pythonhosted.org/packages/2b/76/7f1bfd6afff4c5e38e36a3c6d68eb5f4b7311ea80baf693db78d95b603c4/propcache-0.5.2-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e00820e192c8dbebcafb383ebbf99030895f09905e7a0eb2e0340a0bcc2bc825", size = 61633, upload-time = "2026-05-08T21:01:31.068Z" }, { url = "https://files.pythonhosted.org/packages/c4/46/b3ff8aba2b4953a3e50de2cf72f1b5748b8eca93b15f3dc2c84339084c09/propcache-0.5.2-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:c66afea89b1e43725731d2004732a046fe6fe955d51f952c3e95a7314a284a39", size = 61724, upload-time = "2026-05-08T21:01:32.374Z" }, { url = "https://files.pythonhosted.org/packages/c5/01/814cfcafbcff954f94c01cf30e097ddc88a076b5440fbcf4570753437d40/propcache-0.5.2-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:d4dc37dec6c6cdad0b57881a5658fd14fbf53e333b1a86cf86559f190e1d9ec4", size = 60069, upload-time = "2026-05-08T21:01:33.67Z" }, { url = "https://files.pythonhosted.org/packages/da/68/5c6f7622d510cc666a300687e06fd060c1a43361c0c9b20d284f06d8096a/propcache-0.5.2-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:5570dbcc97571c15f68068e529c92715a12f8d54030e272d264b377e22bd17a5", size = 57099, upload-time = "2026-05-08T21:01:34.915Z" }, { url = "https://files.pythonhosted.org/packages/55/27/9cb0b4c679124085327957d42521c99dba04c88c90c3e55a6f0b633ebccc/propcache-0.5.2-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:f814362777a9f841adddb200ecdf8f5cb1e5a3c4b7a86378edbd6ccb26edd702", size = 63391, upload-time = "2026-05-08T21:01:36.231Z" }, { url = "https://files.pythonhosted.org/packages/f0/9d/7258aaa5bdf60fc6f27591eef6fe52768cb0beda7140be477c8b12c9794a/propcache-0.5.2-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:196913dea116aeb5a2ba95af4ddcb7ea85559ae07d8eee8751688310d09168c3", size = 61626, upload-time = "2026-05-08T21:01:37.545Z" }, { url = "https://files.pythonhosted.org/packages/8e/0d/41c602003e8a9b16fe1e7eadf62c7bfba9d5474370b24200bf48b315f45f/propcache-0.5.2-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:6e7b8719005dd1175be4ab1cd25e9b98659a5e0347331506ec6760d2773a7fb5", size = 64781, upload-time = "2026-05-08T21:01:38.83Z" }, { url = "https://files.pythonhosted.org/packages/8b/f3/38e66b1856e9bd079deea015bc4a55f7767c0e4db2f7dcf69e7e680ba4ce/propcache-0.5.2-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:51f96d685ab16e88cab128cd37a52c5da540809c8b879fa047731bfcb4ad35a4", size = 62570, upload-time = "2026-05-08T21:01:40.415Z" }, { url = "https://files.pythonhosted.org/packages/95/ca/bbfe9b910ce57dde8bb4876b4520fc02a4e89497c10de26be936758a3aaa/propcache-0.5.2-cp314-cp314-win32.whl", hash = "sha256:cc6fc3cc62e8501d3ed62894425040d2728ecddb1ed072737a5c70bd537aa9f0", size = 39436, upload-time = "2026-05-08T21:01:41.654Z" }, { url = "https://files.pythonhosted.org/packages/61/d2/45c9defbaa1ea297035d9d4cce9e8f80daafbf19319c6007f157c6256ea9/propcache-0.5.2-cp314-cp314-win_amd64.whl", hash = "sha256:81e3a30b0bb60caa22033dd0f8a3618d1d67356212514f62c57db75cb0ef410c", size = 42373, upload-time = "2026-05-08T21:01:43.041Z" }, { url = "https://files.pythonhosted.org/packages/44/68/9ea5103f41d5217d7d6ec24db90018e23aebec070c3f9a6e54d12b841fd8/propcache-0.5.2-cp314-cp314-win_arm64.whl", hash = "sha256:0d2c9bf8528f135dbb805ce027567e09164f7efa51a2be07458a2c0420f292d0", size = 38554, upload-time = "2026-05-08T21:01:44.336Z" }, { url = "https://files.pythonhosted.org/packages/8a/81/fadf555f42d3b762eea8a53950b0489fdc0aa9da5f8ed9e10ce0a4e01b48/propcache-0.5.2-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:4bc8ff1feffc6a61c7002ffe84634c41b822e104990ae009f44a0834430070bb", size = 99395, upload-time = "2026-05-08T21:01:45.883Z" }, { url = "https://files.pythonhosted.org/packages/f5/c9/c61e134a686949cf7971af3a390148b1156f7be81c73bc0cd12c873e2d48/propcache-0.5.2-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:79aa3ff0a9b566633b642fa9caf7e21ed1c13d6feca718187873f199e1514078", size = 56653, upload-time = "2026-05-08T21:01:47.307Z" }, { url = "https://files.pythonhosted.org/packages/cb/73/daf935ea7048ddd7ec8eec5345b4a40b619d2d178b3c0a0900796bc3c794/propcache-0.5.2-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:1b31822f4474c4036bae62de9402710051d431a606d6a0f907fec79935a071aa", size = 56914, upload-time = "2026-05-08T21:01:48.573Z" }, { url = "https://files.pythonhosted.org/packages/79/9f/aba959b435ea18617edd7cf0a7ad0b9c574b8fc7e3d2cd55fb59cb255d33/propcache-0.5.2-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:13fef48778b5a2a756523fdb781326b028ca75e32858b04f2cdd19f394564917", size = 62567, upload-time = "2026-05-08T21:01:49.903Z" }, { url = "https://files.pythonhosted.org/packages/6c/a1/859942de9a791ff42f6141736f5b37749b8f53e65edfa49638c67dd67e6a/propcache-0.5.2-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:8b73ab70f1a3351fbc71f663b3e645af6dd0329100c353081cf69c37433fc6fe", size = 65542, upload-time = "2026-05-08T21:01:51.204Z" }, { url = "https://files.pythonhosted.org/packages/b5/61/315bc0fd6c0fc7f80a528b8afd209e5fc4a875ea79571b91b8f50f442907/propcache-0.5.2-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:5538d2c13d93e4698af7e092b57bc7298fd35d1d58e656ae18f23ee0d0378e03", size = 66845, upload-time = "2026-05-08T21:01:52.539Z" }, { url = "https://files.pythonhosted.org/packages/47/f7/9f8122e3132e8e354ac41975ef8f1099be7d5a16bc7ae562734e993665c0/propcache-0.5.2-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:cd645f03898405cabe694fb8bc35241e3a9c332ec85627584fe3de201452b335", size = 63985, upload-time = "2026-05-08T21:01:53.847Z" }, { url = "https://files.pythonhosted.org/packages/c8/54/c317819ec157cbf6f35df9df9657a6f82daf34d5faf15948b2f639c2192e/propcache-0.5.2-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:a473b3440261e0c60706e732b2ed2f517857344fc21bf48fdfe211e2d98eb285", size = 63999, upload-time = "2026-05-08T21:01:55.179Z" }, { url = "https://files.pythonhosted.org/packages/5a/56/387e3f7dfce0a9233df41fb888aa1c30222cb4bbbf09537c02dd9bd85fe2/propcache-0.5.2-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:7afa37062e6650640e932e4cc9297d81f9f42d9944029cc386b8247dea4da837", size = 62779, upload-time = "2026-05-08T21:01:57.489Z" }, { url = "https://files.pythonhosted.org/packages/a1/9c/596784cb5824ed61ee960d3f8655a3f0993e107c6e98ab6c818b7fb92ccb/propcache-0.5.2-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:8a90efd5777e996e42d568db9ac740b944d691e565cbfd31b2f7832f9184b2b8", size = 59796, upload-time = "2026-05-08T21:01:58.736Z" }, { url = "https://files.pythonhosted.org/packages/c2/3d/1a6cfa1726a48542c1e8784a0761421476a5b68e09b7f36bf95eb954aaba/propcache-0.5.2-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:f19bb891234d72535764d703bfed1153cc34f4214d5bd7150aee1eec9e8f4366", size = 66023, upload-time = "2026-05-08T21:02:00.228Z" }, { url = "https://files.pythonhosted.org/packages/e4/0e/05fd6990369477076e4e280bcb970de760fddf0161a46e988bc95f7940ec/propcache-0.5.2-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:32775082acd2d807ee3db715c7770d38767b817870acfa08c29e057f3c4d5b56", size = 64448, upload-time = "2026-05-08T21:02:01.888Z" }, { url = "https://files.pythonhosted.org/packages/cd/86/5f8da315a4309c62c10c0b2516b17492d5d3bbe1bb862b96604db67e2a37/propcache-0.5.2-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:9282fb1a3bccd038da9f768b927b24a0c753e466c086b7c4f3c6982851eefb2d", size = 67329, upload-time = "2026-05-08T21:02:03.484Z" }, { url = "https://files.pythonhosted.org/packages/da/d3/3368efe79ab21f0cdf86ef49895811c9cc933131d4cde1f28a624e22e712/propcache-0.5.2-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:cc49723e2f60d6b32a0f0b08a3fd6d13203c07f1cd9566cfce0f12a917c967a2", size = 65172, upload-time = "2026-05-08T21:02:04.745Z" }, { url = "https://files.pythonhosted.org/packages/d5/07/127e8b0bacfb325396196f9d976a22453049b89b9b2b08477cc3145faa44/propcache-0.5.2-cp314-cp314t-win32.whl", hash = "sha256:2d7aa89ebca5acc98cba9d1472d976e394782f587bad6661003602a619fd1821", size = 43813, upload-time = "2026-05-08T21:02:06.025Z" }, { url = "https://files.pythonhosted.org/packages/88/fb/46dad6c0ae49ed230ab1b16c890c2b6314e2403e6c412976f4a72d64a527/propcache-0.5.2-cp314-cp314t-win_amd64.whl", hash = "sha256:d447bb0b3054be5818458fbb171208b1d9ff11eba14e18ca18b90cbb45767370", size = 47764, upload-time = "2026-05-08T21:02:07.353Z" }, { url = "https://files.pythonhosted.org/packages/e7/c4/a47d0a63aa309d10d59ede6e9d4cff03a344a79d1f0f4cd0cd74997b53e0/propcache-0.5.2-cp314-cp314t-win_arm64.whl", hash = "sha256:fe67a3d11cd9b4efabfa45c3d00ffba2b26811442a73a581a94b67c2b5faccf6", size = 41140, upload-time = "2026-05-08T21:02:09.065Z" }, { url = "https://files.pythonhosted.org/packages/3a/ed/1cdcab6ba3d6ab7feca11fc14f0eeea80755bb53ef4e892079f31b10a25f/propcache-0.5.2-py3-none-any.whl", hash = "sha256:be1ddfcbb376e3de5d2e2db1d58d6d67463e6b4f9f040c000de8e300295465fe", size = 14036, upload-time = "2026-05-08T21:02:10.673Z" }, ] [[package]] name = "properdocs" version = "1.6.7" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "click" }, { name = "colorama", marker = "sys_platform == 'win32'" }, { name = "ghp-import" }, { name = "jinja2" }, { name = "markdown" }, { name = "markupsafe" }, { name = "packaging" }, { name = "pathspec" }, { name = "platformdirs" }, { name = "pyyaml" }, { name = "pyyaml-env-tag" }, { name = "watchdog" }, ] sdist = { url = "https://files.pythonhosted.org/packages/ec/29/f27a4e1eddf72ed3db6e47818fbafe6debbf09fd7051f9c1a007239b46ef/properdocs-1.6.7.tar.gz", hash = "sha256:adc7b16e562890af0e098a7e5b02e3a81c20894a87d6a28d345c9300de73c26e", size = 276141, upload-time = "2026-03-20T20:07:48.167Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/bd/4d/fc923f5c85318ee8cc903566dc4e0ebe41b2dfc1d2ecf5546db232397ed6/properdocs-1.6.7-py3-none-any.whl", hash = "sha256:6fa0cfa2e01bf338f684892c8a506cf70ea88ae7f3479c933b6fa20168101cbd", size = 225406, upload-time = "2026-03-20T20:07:46.875Z" }, ] [[package]] name = "py-cpuinfo" version = "9.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/37/a8/d832f7293ebb21690860d2e01d8115e5ff6f2ae8bbdc953f0eb0fa4bd2c7/py-cpuinfo-9.0.0.tar.gz", hash = "sha256:3cdbbf3fac90dc6f118bfd64384f309edeadd902d7c8fb17f02ffa1fc3f49690", size = 104716, upload-time = "2022-10-25T20:38:06.303Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e0/a9/023730ba63db1e494a271cb018dcd361bd2c917ba7004c3e49d5daf795a2/py_cpuinfo-9.0.0-py3-none-any.whl", hash = "sha256:859625bc251f64e21f077d099d4162689c762b5d6a4c3c97553d56241c9674d5", size = 22335, upload-time = "2022-10-25T20:38:27.636Z" }, ] [[package]] name = "py-partiql-parser" version = "0.6.3" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/56/7a/a0f6bda783eb4df8e3dfd55973a1ac6d368a89178c300e1b5b91cd181e5e/py_partiql_parser-0.6.3.tar.gz", hash = "sha256:09cecf916ce6e3da2c050f0cb6106166de42c33d34a078ec2eb19377ea70389a", size = 17456, upload-time = "2025-10-18T13:56:13.441Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c9/33/a7cbfccc39056a5cf8126b7aab4c8bafbedd4f0ca68ae40ecb627a2d2cd3/py_partiql_parser-0.6.3-py2.py3-none-any.whl", hash = "sha256:deb0769c3346179d2f590dcbde556f708cdb929059fb654bad75f4cf6e07f582", size = 23752, upload-time = "2025-10-18T13:56:12.256Z" }, ] [[package]] name = "pycparser" version = "3.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/1b/7d/92392ff7815c21062bea51aa7b87d45576f649f16458d78b7cf94b9ab2e6/pycparser-3.0.tar.gz", hash = "sha256:600f49d217304a5902ac3c37e1281c9fe94e4d0489de643a9504c5cdfdfc6b29", size = 103492, upload-time = "2026-01-21T14:26:51.89Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0c/c3/44f3fbbfa403ea2a7c779186dc20772604442dde72947e7d01069cbe98e3/pycparser-3.0-py3-none-any.whl", hash = "sha256:b727414169a36b7d524c1c3e31839a521725078d7b2ff038656844266160a992", size = 48172, upload-time = "2026-01-21T14:26:50.693Z" }, ] [[package]] name = "pydantic" version = "2.12.5" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "annotated-types" }, { name = "pydantic-core" }, { name = "typing-extensions" }, { name = "typing-inspection" }, ] sdist = { url = "https://files.pythonhosted.org/packages/69/44/36f1a6e523abc58ae5f928898e4aca2e0ea509b5aa6f6f392a5d882be928/pydantic-2.12.5.tar.gz", hash = "sha256:4d351024c75c0f085a9febbb665ce8c0c6ec5d30e903bdb6394b7ede26aebb49", size = 821591, upload-time = "2025-11-26T15:11:46.471Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5a/87/b70ad306ebb6f9b585f114d0ac2137d792b48be34d732d60e597c2f8465a/pydantic-2.12.5-py3-none-any.whl", hash = "sha256:e561593fccf61e8a20fc46dfc2dfe075b8be7d0188df33f221ad1f0139180f9d", size = 463580, upload-time = "2025-11-26T15:11:44.605Z" }, ] [[package]] name = "pydantic-core" version = "2.41.5" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/71/70/23b021c950c2addd24ec408e9ab05d59b035b39d97cdc1130e1bce647bb6/pydantic_core-2.41.5.tar.gz", hash = "sha256:08daa51ea16ad373ffd5e7606252cc32f07bc72b28284b6bc9c6df804816476e", size = 460952, upload-time = "2025-11-04T13:43:49.098Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5f/5d/5f6c63eebb5afee93bcaae4ce9a898f3373ca23df3ccaef086d0233a35a7/pydantic_core-2.41.5-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:f41a7489d32336dbf2199c8c0a215390a751c5b014c2c1c5366e817202e9cdf7", size = 2110990, upload-time = "2025-11-04T13:39:58.079Z" }, { url = "https://files.pythonhosted.org/packages/aa/32/9c2e8ccb57c01111e0fd091f236c7b371c1bccea0fa85247ac55b1e2b6b6/pydantic_core-2.41.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:070259a8818988b9a84a449a2a7337c7f430a22acc0859c6b110aa7212a6d9c0", size = 1896003, upload-time = "2025-11-04T13:39:59.956Z" }, { url = "https://files.pythonhosted.org/packages/68/b8/a01b53cb0e59139fbc9e4fda3e9724ede8de279097179be4ff31f1abb65a/pydantic_core-2.41.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e96cea19e34778f8d59fe40775a7a574d95816eb150850a85a7a4c8f4b94ac69", size = 1919200, upload-time = "2025-11-04T13:40:02.241Z" }, { url = "https://files.pythonhosted.org/packages/38/de/8c36b5198a29bdaade07b5985e80a233a5ac27137846f3bc2d3b40a47360/pydantic_core-2.41.5-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ed2e99c456e3fadd05c991f8f437ef902e00eedf34320ba2b0842bd1c3ca3a75", size = 2052578, upload-time = "2025-11-04T13:40:04.401Z" }, { url = "https://files.pythonhosted.org/packages/00/b5/0e8e4b5b081eac6cb3dbb7e60a65907549a1ce035a724368c330112adfdd/pydantic_core-2.41.5-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:65840751b72fbfd82c3c640cff9284545342a4f1eb1586ad0636955b261b0b05", size = 2208504, upload-time = "2025-11-04T13:40:06.072Z" }, { url = "https://files.pythonhosted.org/packages/77/56/87a61aad59c7c5b9dc8caad5a41a5545cba3810c3e828708b3d7404f6cef/pydantic_core-2.41.5-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e536c98a7626a98feb2d3eaf75944ef6f3dbee447e1f841eae16f2f0a72d8ddc", size = 2335816, upload-time = "2025-11-04T13:40:07.835Z" }, { url = "https://files.pythonhosted.org/packages/0d/76/941cc9f73529988688a665a5c0ecff1112b3d95ab48f81db5f7606f522d3/pydantic_core-2.41.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eceb81a8d74f9267ef4081e246ffd6d129da5d87e37a77c9bde550cb04870c1c", size = 2075366, upload-time = "2025-11-04T13:40:09.804Z" }, { url = "https://files.pythonhosted.org/packages/d3/43/ebef01f69baa07a482844faaa0a591bad1ef129253ffd0cdaa9d8a7f72d3/pydantic_core-2.41.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d38548150c39b74aeeb0ce8ee1d8e82696f4a4e16ddc6de7b1d8823f7de4b9b5", size = 2171698, upload-time = "2025-11-04T13:40:12.004Z" }, { url = "https://files.pythonhosted.org/packages/b1/87/41f3202e4193e3bacfc2c065fab7706ebe81af46a83d3e27605029c1f5a6/pydantic_core-2.41.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:c23e27686783f60290e36827f9c626e63154b82b116d7fe9adba1fda36da706c", size = 2132603, upload-time = "2025-11-04T13:40:13.868Z" }, { url = "https://files.pythonhosted.org/packages/49/7d/4c00df99cb12070b6bccdef4a195255e6020a550d572768d92cc54dba91a/pydantic_core-2.41.5-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:482c982f814460eabe1d3bb0adfdc583387bd4691ef00b90575ca0d2b6fe2294", size = 2329591, upload-time = "2025-11-04T13:40:15.672Z" }, { url = "https://files.pythonhosted.org/packages/cc/6a/ebf4b1d65d458f3cda6a7335d141305dfa19bdc61140a884d165a8a1bbc7/pydantic_core-2.41.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:bfea2a5f0b4d8d43adf9d7b8bf019fb46fdd10a2e5cde477fbcb9d1fa08c68e1", size = 2319068, upload-time = "2025-11-04T13:40:17.532Z" }, { url = "https://files.pythonhosted.org/packages/49/3b/774f2b5cd4192d5ab75870ce4381fd89cf218af999515baf07e7206753f0/pydantic_core-2.41.5-cp312-cp312-win32.whl", hash = "sha256:b74557b16e390ec12dca509bce9264c3bbd128f8a2c376eaa68003d7f327276d", size = 1985908, upload-time = "2025-11-04T13:40:19.309Z" }, { url = "https://files.pythonhosted.org/packages/86/45/00173a033c801cacf67c190fef088789394feaf88a98a7035b0e40d53dc9/pydantic_core-2.41.5-cp312-cp312-win_amd64.whl", hash = "sha256:1962293292865bca8e54702b08a4f26da73adc83dd1fcf26fbc875b35d81c815", size = 2020145, upload-time = "2025-11-04T13:40:21.548Z" }, { url = "https://files.pythonhosted.org/packages/f9/22/91fbc821fa6d261b376a3f73809f907cec5ca6025642c463d3488aad22fb/pydantic_core-2.41.5-cp312-cp312-win_arm64.whl", hash = "sha256:1746d4a3d9a794cacae06a5eaaccb4b8643a131d45fbc9af23e353dc0a5ba5c3", size = 1976179, upload-time = "2025-11-04T13:40:23.393Z" }, { url = "https://files.pythonhosted.org/packages/87/06/8806241ff1f70d9939f9af039c6c35f2360cf16e93c2ca76f184e76b1564/pydantic_core-2.41.5-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:941103c9be18ac8daf7b7adca8228f8ed6bb7a1849020f643b3a14d15b1924d9", size = 2120403, upload-time = "2025-11-04T13:40:25.248Z" }, { url = "https://files.pythonhosted.org/packages/94/02/abfa0e0bda67faa65fef1c84971c7e45928e108fe24333c81f3bfe35d5f5/pydantic_core-2.41.5-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:112e305c3314f40c93998e567879e887a3160bb8689ef3d2c04b6cc62c33ac34", size = 1896206, upload-time = "2025-11-04T13:40:27.099Z" }, { url = "https://files.pythonhosted.org/packages/15/df/a4c740c0943e93e6500f9eb23f4ca7ec9bf71b19e608ae5b579678c8d02f/pydantic_core-2.41.5-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0cbaad15cb0c90aa221d43c00e77bb33c93e8d36e0bf74760cd00e732d10a6a0", size = 1919307, upload-time = "2025-11-04T13:40:29.806Z" }, { url = "https://files.pythonhosted.org/packages/9a/e3/6324802931ae1d123528988e0e86587c2072ac2e5394b4bc2bc34b61ff6e/pydantic_core-2.41.5-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:03ca43e12fab6023fc79d28ca6b39b05f794ad08ec2feccc59a339b02f2b3d33", size = 2063258, upload-time = "2025-11-04T13:40:33.544Z" }, { url = "https://files.pythonhosted.org/packages/c9/d4/2230d7151d4957dd79c3044ea26346c148c98fbf0ee6ebd41056f2d62ab5/pydantic_core-2.41.5-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dc799088c08fa04e43144b164feb0c13f9a0bc40503f8df3e9fde58a3c0c101e", size = 2214917, upload-time = "2025-11-04T13:40:35.479Z" }, { url = "https://files.pythonhosted.org/packages/e6/9f/eaac5df17a3672fef0081b6c1bb0b82b33ee89aa5cec0d7b05f52fd4a1fa/pydantic_core-2.41.5-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:97aeba56665b4c3235a0e52b2c2f5ae9cd071b8a8310ad27bddb3f7fb30e9aa2", size = 2332186, upload-time = "2025-11-04T13:40:37.436Z" }, { url = "https://files.pythonhosted.org/packages/cf/4e/35a80cae583a37cf15604b44240e45c05e04e86f9cfd766623149297e971/pydantic_core-2.41.5-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:406bf18d345822d6c21366031003612b9c77b3e29ffdb0f612367352aab7d586", size = 2073164, upload-time = "2025-11-04T13:40:40.289Z" }, { url = "https://files.pythonhosted.org/packages/bf/e3/f6e262673c6140dd3305d144d032f7bd5f7497d3871c1428521f19f9efa2/pydantic_core-2.41.5-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b93590ae81f7010dbe380cdeab6f515902ebcbefe0b9327cc4804d74e93ae69d", size = 2179146, upload-time = "2025-11-04T13:40:42.809Z" }, { url = "https://files.pythonhosted.org/packages/75/c7/20bd7fc05f0c6ea2056a4565c6f36f8968c0924f19b7d97bbfea55780e73/pydantic_core-2.41.5-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:01a3d0ab748ee531f4ea6c3e48ad9dac84ddba4b0d82291f87248f2f9de8d740", size = 2137788, upload-time = "2025-11-04T13:40:44.752Z" }, { url = "https://files.pythonhosted.org/packages/3a/8d/34318ef985c45196e004bc46c6eab2eda437e744c124ef0dbe1ff2c9d06b/pydantic_core-2.41.5-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:6561e94ba9dacc9c61bce40e2d6bdc3bfaa0259d3ff36ace3b1e6901936d2e3e", size = 2340133, upload-time = "2025-11-04T13:40:46.66Z" }, { url = "https://files.pythonhosted.org/packages/9c/59/013626bf8c78a5a5d9350d12e7697d3d4de951a75565496abd40ccd46bee/pydantic_core-2.41.5-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:915c3d10f81bec3a74fbd4faebe8391013ba61e5a1a8d48c4455b923bdda7858", size = 2324852, upload-time = "2025-11-04T13:40:48.575Z" }, { url = "https://files.pythonhosted.org/packages/1a/d9/c248c103856f807ef70c18a4f986693a46a8ffe1602e5d361485da502d20/pydantic_core-2.41.5-cp313-cp313-win32.whl", hash = "sha256:650ae77860b45cfa6e2cdafc42618ceafab3a2d9a3811fcfbd3bbf8ac3c40d36", size = 1994679, upload-time = "2025-11-04T13:40:50.619Z" }, { url = "https://files.pythonhosted.org/packages/9e/8b/341991b158ddab181cff136acd2552c9f35bd30380422a639c0671e99a91/pydantic_core-2.41.5-cp313-cp313-win_amd64.whl", hash = "sha256:79ec52ec461e99e13791ec6508c722742ad745571f234ea6255bed38c6480f11", size = 2019766, upload-time = "2025-11-04T13:40:52.631Z" }, { url = "https://files.pythonhosted.org/packages/73/7d/f2f9db34af103bea3e09735bb40b021788a5e834c81eedb541991badf8f5/pydantic_core-2.41.5-cp313-cp313-win_arm64.whl", hash = "sha256:3f84d5c1b4ab906093bdc1ff10484838aca54ef08de4afa9de0f5f14d69639cd", size = 1981005, upload-time = "2025-11-04T13:40:54.734Z" }, { url = "https://files.pythonhosted.org/packages/ea/28/46b7c5c9635ae96ea0fbb779e271a38129df2550f763937659ee6c5dbc65/pydantic_core-2.41.5-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:3f37a19d7ebcdd20b96485056ba9e8b304e27d9904d233d7b1015db320e51f0a", size = 2119622, upload-time = "2025-11-04T13:40:56.68Z" }, { url = "https://files.pythonhosted.org/packages/74/1a/145646e5687e8d9a1e8d09acb278c8535ebe9e972e1f162ed338a622f193/pydantic_core-2.41.5-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:1d1d9764366c73f996edd17abb6d9d7649a7eb690006ab6adbda117717099b14", size = 1891725, upload-time = "2025-11-04T13:40:58.807Z" }, { url = "https://files.pythonhosted.org/packages/23/04/e89c29e267b8060b40dca97bfc64a19b2a3cf99018167ea1677d96368273/pydantic_core-2.41.5-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:25e1c2af0fce638d5f1988b686f3b3ea8cd7de5f244ca147c777769e798a9cd1", size = 1915040, upload-time = "2025-11-04T13:41:00.853Z" }, { url = "https://files.pythonhosted.org/packages/84/a3/15a82ac7bd97992a82257f777b3583d3e84bdb06ba6858f745daa2ec8a85/pydantic_core-2.41.5-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:506d766a8727beef16b7adaeb8ee6217c64fc813646b424d0804d67c16eddb66", size = 2063691, upload-time = "2025-11-04T13:41:03.504Z" }, { url = "https://files.pythonhosted.org/packages/74/9b/0046701313c6ef08c0c1cf0e028c67c770a4e1275ca73131563c5f2a310a/pydantic_core-2.41.5-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4819fa52133c9aa3c387b3328f25c1facc356491e6135b459f1de698ff64d869", size = 2213897, upload-time = "2025-11-04T13:41:05.804Z" }, { url = "https://files.pythonhosted.org/packages/8a/cd/6bac76ecd1b27e75a95ca3a9a559c643b3afcd2dd62086d4b7a32a18b169/pydantic_core-2.41.5-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2b761d210c9ea91feda40d25b4efe82a1707da2ef62901466a42492c028553a2", size = 2333302, upload-time = "2025-11-04T13:41:07.809Z" }, { url = "https://files.pythonhosted.org/packages/4c/d2/ef2074dc020dd6e109611a8be4449b98cd25e1b9b8a303c2f0fca2f2bcf7/pydantic_core-2.41.5-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:22f0fb8c1c583a3b6f24df2470833b40207e907b90c928cc8d3594b76f874375", size = 2064877, upload-time = "2025-11-04T13:41:09.827Z" }, { url = "https://files.pythonhosted.org/packages/18/66/e9db17a9a763d72f03de903883c057b2592c09509ccfe468187f2a2eef29/pydantic_core-2.41.5-cp314-cp314-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2782c870e99878c634505236d81e5443092fba820f0373997ff75f90f68cd553", size = 2180680, upload-time = "2025-11-04T13:41:12.379Z" }, { url = "https://files.pythonhosted.org/packages/d3/9e/3ce66cebb929f3ced22be85d4c2399b8e85b622db77dad36b73c5387f8f8/pydantic_core-2.41.5-cp314-cp314-musllinux_1_1_aarch64.whl", hash = "sha256:0177272f88ab8312479336e1d777f6b124537d47f2123f89cb37e0accea97f90", size = 2138960, upload-time = "2025-11-04T13:41:14.627Z" }, { url = "https://files.pythonhosted.org/packages/a6/62/205a998f4327d2079326b01abee48e502ea739d174f0a89295c481a2272e/pydantic_core-2.41.5-cp314-cp314-musllinux_1_1_armv7l.whl", hash = "sha256:63510af5e38f8955b8ee5687740d6ebf7c2a0886d15a6d65c32814613681bc07", size = 2339102, upload-time = "2025-11-04T13:41:16.868Z" }, { url = "https://files.pythonhosted.org/packages/3c/0d/f05e79471e889d74d3d88f5bd20d0ed189ad94c2423d81ff8d0000aab4ff/pydantic_core-2.41.5-cp314-cp314-musllinux_1_1_x86_64.whl", hash = "sha256:e56ba91f47764cc14f1daacd723e3e82d1a89d783f0f5afe9c364b8bb491ccdb", size = 2326039, upload-time = "2025-11-04T13:41:18.934Z" }, { url = "https://files.pythonhosted.org/packages/ec/e1/e08a6208bb100da7e0c4b288eed624a703f4d129bde2da475721a80cab32/pydantic_core-2.41.5-cp314-cp314-win32.whl", hash = "sha256:aec5cf2fd867b4ff45b9959f8b20ea3993fc93e63c7363fe6851424c8a7e7c23", size = 1995126, upload-time = "2025-11-04T13:41:21.418Z" }, { url = "https://files.pythonhosted.org/packages/48/5d/56ba7b24e9557f99c9237e29f5c09913c81eeb2f3217e40e922353668092/pydantic_core-2.41.5-cp314-cp314-win_amd64.whl", hash = "sha256:8e7c86f27c585ef37c35e56a96363ab8de4e549a95512445b85c96d3e2f7c1bf", size = 2015489, upload-time = "2025-11-04T13:41:24.076Z" }, { url = "https://files.pythonhosted.org/packages/4e/bb/f7a190991ec9e3e0ba22e4993d8755bbc4a32925c0b5b42775c03e8148f9/pydantic_core-2.41.5-cp314-cp314-win_arm64.whl", hash = "sha256:e672ba74fbc2dc8eea59fb6d4aed6845e6905fc2a8afe93175d94a83ba2a01a0", size = 1977288, upload-time = "2025-11-04T13:41:26.33Z" }, { url = "https://files.pythonhosted.org/packages/92/ed/77542d0c51538e32e15afe7899d79efce4b81eee631d99850edc2f5e9349/pydantic_core-2.41.5-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:8566def80554c3faa0e65ac30ab0932b9e3a5cd7f8323764303d468e5c37595a", size = 2120255, upload-time = "2025-11-04T13:41:28.569Z" }, { url = "https://files.pythonhosted.org/packages/bb/3d/6913dde84d5be21e284439676168b28d8bbba5600d838b9dca99de0fad71/pydantic_core-2.41.5-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:b80aa5095cd3109962a298ce14110ae16b8c1aece8b72f9dafe81cf597ad80b3", size = 1863760, upload-time = "2025-11-04T13:41:31.055Z" }, { url = "https://files.pythonhosted.org/packages/5a/f0/e5e6b99d4191da102f2b0eb9687aaa7f5bea5d9964071a84effc3e40f997/pydantic_core-2.41.5-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3006c3dd9ba34b0c094c544c6006cc79e87d8612999f1a5d43b769b89181f23c", size = 1878092, upload-time = "2025-11-04T13:41:33.21Z" }, { url = "https://files.pythonhosted.org/packages/71/48/36fb760642d568925953bcc8116455513d6e34c4beaa37544118c36aba6d/pydantic_core-2.41.5-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:72f6c8b11857a856bcfa48c86f5368439f74453563f951e473514579d44aa612", size = 2053385, upload-time = "2025-11-04T13:41:35.508Z" }, { url = "https://files.pythonhosted.org/packages/20/25/92dc684dd8eb75a234bc1c764b4210cf2646479d54b47bf46061657292a8/pydantic_core-2.41.5-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5cb1b2f9742240e4bb26b652a5aeb840aa4b417c7748b6f8387927bc6e45e40d", size = 2218832, upload-time = "2025-11-04T13:41:37.732Z" }, { url = "https://files.pythonhosted.org/packages/e2/09/f53e0b05023d3e30357d82eb35835d0f6340ca344720a4599cd663dca599/pydantic_core-2.41.5-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:bd3d54f38609ff308209bd43acea66061494157703364ae40c951f83ba99a1a9", size = 2327585, upload-time = "2025-11-04T13:41:40Z" }, { url = "https://files.pythonhosted.org/packages/aa/4e/2ae1aa85d6af35a39b236b1b1641de73f5a6ac4d5a7509f77b814885760c/pydantic_core-2.41.5-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2ff4321e56e879ee8d2a879501c8e469414d948f4aba74a2d4593184eb326660", size = 2041078, upload-time = "2025-11-04T13:41:42.323Z" }, { url = "https://files.pythonhosted.org/packages/cd/13/2e215f17f0ef326fc72afe94776edb77525142c693767fc347ed6288728d/pydantic_core-2.41.5-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d0d2568a8c11bf8225044aa94409e21da0cb09dcdafe9ecd10250b2baad531a9", size = 2173914, upload-time = "2025-11-04T13:41:45.221Z" }, { url = "https://files.pythonhosted.org/packages/02/7a/f999a6dcbcd0e5660bc348a3991c8915ce6599f4f2c6ac22f01d7a10816c/pydantic_core-2.41.5-cp314-cp314t-musllinux_1_1_aarch64.whl", hash = "sha256:a39455728aabd58ceabb03c90e12f71fd30fa69615760a075b9fec596456ccc3", size = 2129560, upload-time = "2025-11-04T13:41:47.474Z" }, { url = "https://files.pythonhosted.org/packages/3a/b1/6c990ac65e3b4c079a4fb9f5b05f5b013afa0f4ed6780a3dd236d2cbdc64/pydantic_core-2.41.5-cp314-cp314t-musllinux_1_1_armv7l.whl", hash = "sha256:239edca560d05757817c13dc17c50766136d21f7cd0fac50295499ae24f90fdf", size = 2329244, upload-time = "2025-11-04T13:41:49.992Z" }, { url = "https://files.pythonhosted.org/packages/d9/02/3c562f3a51afd4d88fff8dffb1771b30cfdfd79befd9883ee094f5b6c0d8/pydantic_core-2.41.5-cp314-cp314t-musllinux_1_1_x86_64.whl", hash = "sha256:2a5e06546e19f24c6a96a129142a75cee553cc018ffee48a460059b1185f4470", size = 2331955, upload-time = "2025-11-04T13:41:54.079Z" }, { url = "https://files.pythonhosted.org/packages/5c/96/5fb7d8c3c17bc8c62fdb031c47d77a1af698f1d7a406b0f79aaa1338f9ad/pydantic_core-2.41.5-cp314-cp314t-win32.whl", hash = "sha256:b4ececa40ac28afa90871c2cc2b9ffd2ff0bf749380fbdf57d165fd23da353aa", size = 1988906, upload-time = "2025-11-04T13:41:56.606Z" }, { url = "https://files.pythonhosted.org/packages/22/ed/182129d83032702912c2e2d8bbe33c036f342cc735737064668585dac28f/pydantic_core-2.41.5-cp314-cp314t-win_amd64.whl", hash = "sha256:80aa89cad80b32a912a65332f64a4450ed00966111b6615ca6816153d3585a8c", size = 1981607, upload-time = "2025-11-04T13:41:58.889Z" }, { url = "https://files.pythonhosted.org/packages/9f/ed/068e41660b832bb0b1aa5b58011dea2a3fe0ba7861ff38c4d4904c1c1a99/pydantic_core-2.41.5-cp314-cp314t-win_arm64.whl", hash = "sha256:35b44f37a3199f771c3eaa53051bc8a70cd7b54f333531c59e29fd4db5d15008", size = 1974769, upload-time = "2025-11-04T13:42:01.186Z" }, { url = "https://files.pythonhosted.org/packages/09/32/59b0c7e63e277fa7911c2fc70ccfb45ce4b98991e7ef37110663437005af/pydantic_core-2.41.5-graalpy312-graalpy250_312_native-macosx_10_12_x86_64.whl", hash = "sha256:7da7087d756b19037bc2c06edc6c170eeef3c3bafcb8f532ff17d64dc427adfd", size = 2110495, upload-time = "2025-11-04T13:42:49.689Z" }, { url = "https://files.pythonhosted.org/packages/aa/81/05e400037eaf55ad400bcd318c05bb345b57e708887f07ddb2d20e3f0e98/pydantic_core-2.41.5-graalpy312-graalpy250_312_native-macosx_11_0_arm64.whl", hash = "sha256:aabf5777b5c8ca26f7824cb4a120a740c9588ed58df9b2d196ce92fba42ff8dc", size = 1915388, upload-time = "2025-11-04T13:42:52.215Z" }, { url = "https://files.pythonhosted.org/packages/6e/0d/e3549b2399f71d56476b77dbf3cf8937cec5cd70536bdc0e374a421d0599/pydantic_core-2.41.5-graalpy312-graalpy250_312_native-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c007fe8a43d43b3969e8469004e9845944f1a80e6acd47c150856bb87f230c56", size = 1942879, upload-time = "2025-11-04T13:42:56.483Z" }, { url = "https://files.pythonhosted.org/packages/f7/07/34573da085946b6a313d7c42f82f16e8920bfd730665de2d11c0c37a74b5/pydantic_core-2.41.5-graalpy312-graalpy250_312_native-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:76d0819de158cd855d1cbb8fcafdf6f5cf1eb8e470abe056d5d161106e38062b", size = 2139017, upload-time = "2025-11-04T13:42:59.471Z" }, ] [[package]] name = "pydantic-settings" version = "2.14.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pydantic" }, { name = "python-dotenv" }, { name = "typing-inspection" }, ] sdist = { url = "https://files.pythonhosted.org/packages/5c/b5/8f48e906c3e0205276e8bd8cb7512217a87b2685304d64be27cad5b3019f/pydantic_settings-2.14.2.tar.gz", hash = "sha256:c19dd64b19097f1de80184f0cc7b0272a13ae6e170cbf240a3e27e381ed14a5f", size = 237700, upload-time = "2026-06-19T13:44:56.324Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/77/c1/6e422f34e569cf8e18df68d1939c81c099d2b61e4f7d9621c8a77560799c/pydantic_settings-2.14.2-py3-none-any.whl", hash = "sha256:a20c97b37910b6550d5ea50fbcc2d4187defe58cd57070b73863d069419c9440", size = 61715, upload-time = "2026-06-19T13:44:55.02Z" }, ] [[package]] name = "pygments" version = "2.20.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/c3/b2/bc9c9196916376152d655522fdcebac55e66de6603a76a02bca1b6414f6c/pygments-2.20.0.tar.gz", hash = "sha256:6757cd03768053ff99f3039c1a36d6c0aa0b263438fcab17520b30a303a82b5f", size = 4955991, upload-time = "2026-03-29T13:29:33.898Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/f4/7e/a72dd26f3b0f4f2bf1dd8923c85f7ceb43172af56d63c7383eb62b332364/pygments-2.20.0-py3-none-any.whl", hash = "sha256:81a9e26dd42fd28a23a2d169d86d7ac03b46e2f8b59ed4698fb4785f946d0176", size = 1231151, upload-time = "2026-03-29T13:29:30.038Z" }, ] [[package]] name = "pygments-ansi-color" version = "0.3.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pygments" }, ] sdist = { url = "https://files.pythonhosted.org/packages/50/f9/7f417aaee98a74b4f757f2b72971245181fcf25d824d2e7a190345669eaf/pygments-ansi-color-0.3.0.tar.gz", hash = "sha256:7018954cf5b11d1e734383a1bafab5af613213f246109417fee3f76da26d5431", size = 7317, upload-time = "2023-05-18T22:44:35.792Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e6/17/8306a0bcd8c88d7761c2e73e831b0be026cd6873ce1f12beb3b4c9a03ffa/pygments_ansi_color-0.3.0-py3-none-any.whl", hash = "sha256:7eb063feaecadad9d4d1fd3474cbfeadf3486b64f760a8f2a00fc25392180aba", size = 10242, upload-time = "2023-05-18T22:44:34.287Z" }, ] [[package]] name = "pymdown-extensions" version = "10.21.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markdown" }, { name = "pyyaml" }, ] sdist = { url = "https://files.pythonhosted.org/packages/9e/26/d1015444da4d952a1ca487a236b522eb979766f0295a0bd0c5fc089989a9/pymdown_extensions-10.21.3.tar.gz", hash = "sha256:72cfcf55f07aea0d4af2c4f11dd4e52466ddfb1bb819673146398e0bd3a77354", size = 854140, upload-time = "2026-05-13T12:57:32.267Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/7e/85/545a951eecc270fcd688288c600017e2050a1aacb56c711d208586d3e470/pymdown_extensions-10.21.3-py3-none-any.whl", hash = "sha256:d7a5d08014fc571e80ca21dd6f854e31f94c489800350564d55d15b3c41e76b6", size = 269002, upload-time = "2026-05-13T12:57:30.296Z" }, ] [[package]] name = "pyparsing" version = "3.3.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/f3/91/9c6ee907786a473bf81c5f53cf703ba0957b23ab84c264080fb5a450416f/pyparsing-3.3.2.tar.gz", hash = "sha256:c777f4d763f140633dcb6d8a3eda953bf7a214dc4eff598413c070bcdc117cbc", size = 6851574, upload-time = "2026-01-21T03:57:59.36Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/10/bd/c038d7cc38edc1aa5bf91ab8068b63d4308c66c4c8bb3cbba7dfbc049f9c/pyparsing-3.3.2-py3-none-any.whl", hash = "sha256:850ba148bd908d7e2411587e247a1e4f0327839c40e2e5e6d05a007ecc69911d", size = 122781, upload-time = "2026-01-21T03:57:55.912Z" }, ] [[package]] name = "pytest" version = "9.1.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "colorama", marker = "sys_platform == 'win32'" }, { name = "iniconfig" }, { name = "packaging" }, { name = "pluggy" }, { name = "pygments" }, ] sdist = { url = "https://files.pythonhosted.org/packages/e4/47/b9efed96c114afcfa3c9d3fe98a76a1d14c74a9e266d397cf6eb64be5e01/pytest-9.1.1.tar.gz", hash = "sha256:1088fbde8f2b49d95a549a195707afa7a76a3ce9bcadc26b6d71f0ffda5fe313", size = 1636369, upload-time = "2026-06-19T10:58:32.857Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/24/25/1de2678b631f5a49215c6c96fff41ba892b0a34df68d6d80292b1b48aa7f/pytest-9.1.1-py3-none-any.whl", hash = "sha256:37a86b45efb9a47a61a36449063e8e18d0cab3161329fc099eb21783169c4f0c", size = 386536, upload-time = "2026-06-19T10:58:31.347Z" }, ] [[package]] name = "pytest-accept" version = "0.3.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "astor" }, { name = "pytest" }, ] sdist = { url = "https://files.pythonhosted.org/packages/6f/42/573e6dcd8d1a5fc779d525268d5036f710d018cdeefbae2bd5559687a6d5/pytest_accept-0.3.0.tar.gz", hash = "sha256:6f4e03e2492621e10b7678a331828274498cca04686b15b0f3e704e16e651068", size = 29744, upload-time = "2026-06-11T18:44:39.03Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/06/40/79f6f13e616f580b9c35110376818c76cacc54b70d2965bf1f82be336c66/pytest_accept-0.3.0-py3-none-any.whl", hash = "sha256:5e73f27020853b861a63dc630dfe63124af4bd60e0e0bb692e1376b99798f2b5", size = 39846, upload-time = "2026-06-11T18:44:37.965Z" }, ] [[package]] name = "pytest-asyncio" version = "1.4.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pytest" }, { name = "typing-extensions", marker = "python_full_version < '3.13'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/43/7c/d36d04db312ecf4298932ef77e6e4a9e8ad017906e24e34f0b0c361a2473/pytest_asyncio-1.4.0.tar.gz", hash = "sha256:c6c0d2259945122819f171a32ecea2c349ead889ee28176caaf492143424be42", size = 58514, upload-time = "2026-05-26T09:56:04.083Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/03/e2/08a497ef684b88559c9cc5f4ad53a37e7b99e727094a86d6ea32536d5d3c/pytest_asyncio-1.4.0-py3-none-any.whl", hash = "sha256:933ca923a23075a87fb7070c0ec272a6848489824d887c85c812670932835aa1", size = 16930, upload-time = "2026-05-26T09:56:02.576Z" }, ] [[package]] name = "pytest-benchmark" version = "5.2.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "py-cpuinfo" }, { name = "pytest" }, ] sdist = { url = "https://files.pythonhosted.org/packages/24/34/9f732b76456d64faffbef6232f1f9dbec7a7c4999ff46282fa418bd1af66/pytest_benchmark-5.2.3.tar.gz", hash = "sha256:deb7317998a23c650fd4ff76e1230066a76cb45dcece0aca5607143c619e7779", size = 341340, upload-time = "2025-11-09T18:48:43.215Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/33/29/e756e715a48959f1c0045342088d7ca9762a2f509b945f362a316e9412b7/pytest_benchmark-5.2.3-py3-none-any.whl", hash = "sha256:bc839726ad20e99aaa0d11a127445457b4219bdb9e80a1afc4b51da7f96b0803", size = 45255, upload-time = "2025-11-09T18:48:39.765Z" }, ] [[package]] name = "pytest-codspeed" version = "5.0.3" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pytest" }, { name = "rich" }, ] sdist = { url = "https://files.pythonhosted.org/packages/e1/b4/cf932fcd1960a2fd6d9b09eb403253a8709aeee975961afa6299239a830e/pytest_codspeed-5.0.3.tar.gz", hash = "sha256:91afef90e6a96b013495e4702ef5d6358614a449e71008cdc194ef668778b92f", size = 324571, upload-time = "2026-05-22T16:20:49.231Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c2/22/456c48160b761d5028c8afa119f085a9fc42855a783a13d73918078969f0/pytest_codspeed-5.0.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:2eeb25fb1ac3f73c4de50e739e78fea396b89782bdb740bf2a7cd2df21f8d4ee", size = 366255, upload-time = "2026-05-22T16:20:56.214Z" }, { url = "https://files.pythonhosted.org/packages/74/33/ac7441fa937c9d9f158083a8c46920a5a5c81ed3c5f96240fc8d650db5c2/pytest_codspeed-5.0.3-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:73c5c9d98a3372a42611989ccfa437cce3842431ac6d6b9ab42c4f0e59c070f7", size = 932325, upload-time = "2026-05-22T16:21:08.814Z" }, { url = "https://files.pythonhosted.org/packages/77/bc/8b994adcb9e9016e7d9a808056a3dd9cca21441e432ef456eae2b697d7fe/pytest_codspeed-5.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a2e0ab65df73e837666d12357280ca50ff6d6ac03ea5266703be518b68170edf", size = 934885, upload-time = "2026-05-22T16:21:01.444Z" }, { url = "https://files.pythonhosted.org/packages/dc/8e/e032451e9e0a06b0c4bff53105f62b693d9a54595dd8c024693741ce3380/pytest_codspeed-5.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:6524c57fec279a22ffef6112af404036afc71b4704758ae9f0abda429b8478d4", size = 366253, upload-time = "2026-05-22T16:20:46.192Z" }, { url = "https://files.pythonhosted.org/packages/a9/7b/ae76fd8ac656b9695806a6aafd5f22ec32e6ce20e266a58f9112e01d3cd8/pytest_codspeed-5.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0c383c9121deb58a69f174188e9e4488ffc0daced0ed276abf87747182511901", size = 932360, upload-time = "2026-05-22T16:20:30.589Z" }, { url = "https://files.pythonhosted.org/packages/a6/4a/dfd43d943fdb143be4fd62f34c2793ba349dc27aa188e521d19d629aa7ab/pytest_codspeed-5.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a4bcdb4b6522738152885ef067e0c8524d5699828d780fb6f464cdb3db44369c", size = 934928, upload-time = "2026-05-22T16:20:38.62Z" }, { url = "https://files.pythonhosted.org/packages/04/6a/fdcec19c7f267c195f147c51d3fd2245f6b8d09b80495ed0a90c008e0842/pytest_codspeed-5.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:25464363c7f9b9bd5022e969c0addba616fa40ac9b8f0fc9e030c4538863b32d", size = 366259, upload-time = "2026-05-22T16:21:06.039Z" }, { url = "https://files.pythonhosted.org/packages/6a/96/c6b03b81dcd21ae3d6b32cca0b3c10149fa378eb21b338d4b63c9eb8050b/pytest_codspeed-5.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:efd43f82ea03ced8488a767ded9473f050791ab7783ea8654107e1e0ac66af40", size = 932395, upload-time = "2026-05-22T16:21:04.804Z" }, { url = "https://files.pythonhosted.org/packages/96/08/56ad8f1cc7d6962f8a680141b361e93467a2abc53d976cd9d5e1edd740e3/pytest_codspeed-5.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:782f9985b6f6b45b8bc20152d206d3a52b56dd088ba81cb70a71f0b39841be9e", size = 934994, upload-time = "2026-05-22T16:20:28.809Z" }, { url = "https://files.pythonhosted.org/packages/0b/54/9096c4545f09da94b1b00f3be2fe4952949e86c9bcafca9a29b26aed1a75/pytest_codspeed-5.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:9aa0815b90196f3c20d736ea8691381e97f12bbe8c7d87af10a351e434b452cb", size = 366311, upload-time = "2026-05-22T16:20:41.791Z" }, { url = "https://files.pythonhosted.org/packages/a7/3c/24c53f67a38ad48cb087105ac30a8aa0923223ee274ea9bf2dc705edaa59/pytest_codspeed-5.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:85505c96a3477c346ec2d2b7dced8478f4c651e2b1666ee102d53a832b511853", size = 933169, upload-time = "2026-05-22T16:20:43.178Z" }, { url = "https://files.pythonhosted.org/packages/d1/de/2213f868fa7694f743f96cccbc07e757f45c920c523cccc2da97bc8652df/pytest_codspeed-5.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:20eba63765be9d1b6cacbbfad84b87d49eb04b357a7045a0899880da181f81e3", size = 935522, upload-time = "2026-05-22T16:21:03.398Z" }, { url = "https://files.pythonhosted.org/packages/df/85/5dfea1c031d6cccc11653464828edf205c30f798caf5b2a85375aacd914a/pytest_codspeed-5.0.3-cp315-cp315-macosx_11_0_arm64.whl", hash = "sha256:ec9fa6f0af0a9feb0e0bd517fb59ef28f806fbd50c0c6900ac26cbb4d080eba5", size = 366275, upload-time = "2026-05-22T16:20:59.463Z" }, { url = "https://files.pythonhosted.org/packages/3c/2b/af4d1b612f03b98a6cf3c7d5f62678917a60110a8bf380d49ab408b31137/pytest_codspeed-5.0.3-cp315-cp315-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:8df77b3409f54f4a268f77f3ff74992fe1d995cdbaf2cecf8ad74d32db217ce7", size = 932537, upload-time = "2026-05-22T16:20:54.945Z" }, { url = "https://files.pythonhosted.org/packages/f5/a2/c7ec45e36a61b418efb2a3cccaa67a0c2fcf1f21d5880f64c33114f0c249/pytest_codspeed-5.0.3-cp315-cp315-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a5d8695a227ea1c3a41d25db5b3fe720bf1b4808bd38862be811a4efd902c792", size = 934153, upload-time = "2026-05-22T16:21:07.494Z" }, { url = "https://files.pythonhosted.org/packages/cf/c7/d5bada9618a0af56a5c8065fc61280849cab8e7c1e24025807a51c3157ce/pytest_codspeed-5.0.3-cp315-cp315t-macosx_11_0_arm64.whl", hash = "sha256:bf4cc4178cbace8f4d2bd240408276bc4da3850ac5fcb5fb5f8a74ab417615bb", size = 366339, upload-time = "2026-05-22T16:20:51.968Z" }, { url = "https://files.pythonhosted.org/packages/a8/37/fb27aeb40a81320e7349553b877a21333c897b27c8dfe215630452908f36/pytest_codspeed-5.0.3-cp315-cp315t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:abe793da40f87295d33988673d34f06ea569848b44490b847552cd416816258a", size = 933055, upload-time = "2026-05-22T16:20:44.861Z" }, { url = "https://files.pythonhosted.org/packages/f3/d9/6f2d69e96deaf0475a695fc9195af59e7a3b5fab50782855e65c63a7bc28/pytest_codspeed-5.0.3-cp315-cp315t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c3a9ed38dfa776443b86f4b49a982e8443d0953db4974bd2673d63cc904ae1ad", size = 934481, upload-time = "2026-05-22T16:20:58.264Z" }, { url = "https://files.pythonhosted.org/packages/c5/b2/1d2a993c532146dce9eca5b5942d51898021c3579ce18b2454f932a915f8/pytest_codspeed-5.0.3-py3-none-any.whl", hash = "sha256:fe2ea83c924c2250675b75686c3ee456b8cf0208d83d552e182a195fdf467378", size = 74033, upload-time = "2026-05-22T16:20:26.814Z" }, ] [[package]] name = "pytest-cov" version = "7.1.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "coverage" }, { name = "pluggy" }, { name = "pytest" }, ] sdist = { url = "https://files.pythonhosted.org/packages/b1/51/a849f96e117386044471c8ec2bd6cfebacda285da9525c9106aeb28da671/pytest_cov-7.1.0.tar.gz", hash = "sha256:30674f2b5f6351aa09702a9c8c364f6a01c27aae0c1366ae8016160d1efc56b2", size = 55592, upload-time = "2026-03-21T20:11:16.284Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/9d/7a/d968e294073affff457b041c2be9868a40c1c71f4a35fcc1e45e5493067b/pytest_cov-7.1.0-py3-none-any.whl", hash = "sha256:a0461110b7865f9a271aa1b51e516c9a95de9d696734a2f71e3e78f46e1d4678", size = 22876, upload-time = "2026-03-21T20:11:14.438Z" }, ] [[package]] name = "pytest-xdist" version = "3.8.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "execnet" }, { name = "pytest" }, ] sdist = { url = "https://files.pythonhosted.org/packages/78/b4/439b179d1ff526791eb921115fca8e44e596a13efeda518b9d845a619450/pytest_xdist-3.8.0.tar.gz", hash = "sha256:7e578125ec9bc6050861aa93f2d59f1d8d085595d6551c2c90b6f4fad8d3a9f1", size = 88069, upload-time = "2025-07-01T13:30:59.346Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ca/31/d4e37e9e550c2b92a9cbc2e4d0b7420a27224968580b5a447f420847c975/pytest_xdist-3.8.0-py3-none-any.whl", hash = "sha256:202ca578cfeb7370784a8c33d6d05bc6e13b4f25b5053c30a152269fd10f0b88", size = 46396, upload-time = "2025-07-01T13:30:56.632Z" }, ] [[package]] name = "python-dateutil" version = "2.9.0.post0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "six" }, ] sdist = { url = "https://files.pythonhosted.org/packages/66/c0/0c8b6ad9f17a802ee498c46e004a0eb49bc148f2fd230864601a86dcf6db/python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 342432, upload-time = "2024-03-01T18:36:20.211Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ec/57/56b9bcc3c9c6a792fcbaf139543cee77261f3651ca9da0c93f5c1221264b/python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427", size = 229892, upload-time = "2024-03-01T18:36:18.57Z" }, ] [[package]] name = "python-dotenv" version = "1.2.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/82/ed/0301aeeac3e5353ef3d94b6ec08bbcabd04a72018415dcb29e588514bba8/python_dotenv-1.2.2.tar.gz", hash = "sha256:2c371a91fbd7ba082c2c1dc1f8bf89ca22564a087c2c287cd9b662adde799cf3", size = 50135, upload-time = "2026-03-01T16:00:26.196Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0b/d7/1959b9648791274998a9c3526f6d0ec8fd2233e4d4acce81bbae76b44b2a/python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a", size = 22101, upload-time = "2026-03-01T16:00:25.09Z" }, ] [[package]] name = "pywin32" version = "311" source = { registry = "https://pypi.org/simple" } wheels = [ { url = "https://files.pythonhosted.org/packages/e7/ab/01ea1943d4eba0f850c3c61e78e8dd59757ff815ff3ccd0a84de5f541f42/pywin32-311-cp312-cp312-win32.whl", hash = "sha256:750ec6e621af2b948540032557b10a2d43b0cee2ae9758c54154d711cc852d31", size = 8706543, upload-time = "2025-07-14T20:13:20.765Z" }, { url = "https://files.pythonhosted.org/packages/d1/a8/a0e8d07d4d051ec7502cd58b291ec98dcc0c3fff027caad0470b72cfcc2f/pywin32-311-cp312-cp312-win_amd64.whl", hash = "sha256:b8c095edad5c211ff31c05223658e71bf7116daa0ecf3ad85f3201ea3190d067", size = 9495040, upload-time = "2025-07-14T20:13:22.543Z" }, { url = "https://files.pythonhosted.org/packages/ba/3a/2ae996277b4b50f17d61f0603efd8253cb2d79cc7ae159468007b586396d/pywin32-311-cp312-cp312-win_arm64.whl", hash = "sha256:e286f46a9a39c4a18b319c28f59b61de793654af2f395c102b4f819e584b5852", size = 8710102, upload-time = "2025-07-14T20:13:24.682Z" }, { url = "https://files.pythonhosted.org/packages/a5/be/3fd5de0979fcb3994bfee0d65ed8ca9506a8a1260651b86174f6a86f52b3/pywin32-311-cp313-cp313-win32.whl", hash = "sha256:f95ba5a847cba10dd8c4d8fefa9f2a6cf283b8b88ed6178fa8a6c1ab16054d0d", size = 8705700, upload-time = "2025-07-14T20:13:26.471Z" }, { url = "https://files.pythonhosted.org/packages/e3/28/e0a1909523c6890208295a29e05c2adb2126364e289826c0a8bc7297bd5c/pywin32-311-cp313-cp313-win_amd64.whl", hash = "sha256:718a38f7e5b058e76aee1c56ddd06908116d35147e133427e59a3983f703a20d", size = 9494700, upload-time = "2025-07-14T20:13:28.243Z" }, { url = "https://files.pythonhosted.org/packages/04/bf/90339ac0f55726dce7d794e6d79a18a91265bdf3aa70b6b9ca52f35e022a/pywin32-311-cp313-cp313-win_arm64.whl", hash = "sha256:7b4075d959648406202d92a2310cb990fea19b535c7f4a78d3f5e10b926eeb8a", size = 8709318, upload-time = "2025-07-14T20:13:30.348Z" }, { url = "https://files.pythonhosted.org/packages/c9/31/097f2e132c4f16d99a22bfb777e0fd88bd8e1c634304e102f313af69ace5/pywin32-311-cp314-cp314-win32.whl", hash = "sha256:b7a2c10b93f8986666d0c803ee19b5990885872a7de910fc460f9b0c2fbf92ee", size = 8840714, upload-time = "2025-07-14T20:13:32.449Z" }, { url = "https://files.pythonhosted.org/packages/90/4b/07c77d8ba0e01349358082713400435347df8426208171ce297da32c313d/pywin32-311-cp314-cp314-win_amd64.whl", hash = "sha256:3aca44c046bd2ed8c90de9cb8427f581c479e594e99b5c0bb19b29c10fd6cb87", size = 9656800, upload-time = "2025-07-14T20:13:34.312Z" }, { url = "https://files.pythonhosted.org/packages/c0/d2/21af5c535501a7233e734b8af901574572da66fcc254cb35d0609c9080dd/pywin32-311-cp314-cp314-win_arm64.whl", hash = "sha256:a508e2d9025764a8270f93111a970e1d0fbfc33f4153b388bb649b7eec4f9b42", size = 8932540, upload-time = "2025-07-14T20:13:36.379Z" }, ] [[package]] name = "pyyaml" version = "6.0.3" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/05/8e/961c0007c59b8dd7729d542c61a4d537767a59645b82a0b521206e1e25c2/pyyaml-6.0.3.tar.gz", hash = "sha256:d76623373421df22fb4cf8817020cbb7ef15c725b9d5e45f17e189bfc384190f", size = 130960, upload-time = "2025-09-25T21:33:16.546Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/d1/33/422b98d2195232ca1826284a76852ad5a86fe23e31b009c9886b2d0fb8b2/pyyaml-6.0.3-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:7f047e29dcae44602496db43be01ad42fc6f1cc0d8cd6c83d342306c32270196", size = 182063, upload-time = "2025-09-25T21:32:11.445Z" }, { url = "https://files.pythonhosted.org/packages/89/a0/6cf41a19a1f2f3feab0e9c0b74134aa2ce6849093d5517a0c550fe37a648/pyyaml-6.0.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:fc09d0aa354569bc501d4e787133afc08552722d3ab34836a80547331bb5d4a0", size = 173973, upload-time = "2025-09-25T21:32:12.492Z" }, { url = "https://files.pythonhosted.org/packages/ed/23/7a778b6bd0b9a8039df8b1b1d80e2e2ad78aa04171592c8a5c43a56a6af4/pyyaml-6.0.3-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9149cad251584d5fb4981be1ecde53a1ca46c891a79788c0df828d2f166bda28", size = 775116, upload-time = "2025-09-25T21:32:13.652Z" }, { url = "https://files.pythonhosted.org/packages/65/30/d7353c338e12baef4ecc1b09e877c1970bd3382789c159b4f89d6a70dc09/pyyaml-6.0.3-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:5fdec68f91a0c6739b380c83b951e2c72ac0197ace422360e6d5a959d8d97b2c", size = 844011, upload-time = "2025-09-25T21:32:15.21Z" }, { url = "https://files.pythonhosted.org/packages/8b/9d/b3589d3877982d4f2329302ef98a8026e7f4443c765c46cfecc8858c6b4b/pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ba1cc08a7ccde2d2ec775841541641e4548226580ab850948cbfda66a1befcdc", size = 807870, upload-time = "2025-09-25T21:32:16.431Z" }, { url = "https://files.pythonhosted.org/packages/05/c0/b3be26a015601b822b97d9149ff8cb5ead58c66f981e04fedf4e762f4bd4/pyyaml-6.0.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8dc52c23056b9ddd46818a57b78404882310fb473d63f17b07d5c40421e47f8e", size = 761089, upload-time = "2025-09-25T21:32:17.56Z" }, { url = "https://files.pythonhosted.org/packages/be/8e/98435a21d1d4b46590d5459a22d88128103f8da4c2d4cb8f14f2a96504e1/pyyaml-6.0.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:41715c910c881bc081f1e8872880d3c650acf13dfa8214bad49ed4cede7c34ea", size = 790181, upload-time = "2025-09-25T21:32:18.834Z" }, { url = "https://files.pythonhosted.org/packages/74/93/7baea19427dcfbe1e5a372d81473250b379f04b1bd3c4c5ff825e2327202/pyyaml-6.0.3-cp312-cp312-win32.whl", hash = "sha256:96b533f0e99f6579b3d4d4995707cf36df9100d67e0c8303a0c55b27b5f99bc5", size = 137658, upload-time = "2025-09-25T21:32:20.209Z" }, { url = "https://files.pythonhosted.org/packages/86/bf/899e81e4cce32febab4fb42bb97dcdf66bc135272882d1987881a4b519e9/pyyaml-6.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:5fcd34e47f6e0b794d17de1b4ff496c00986e1c83f7ab2fb8fcfe9616ff7477b", size = 154003, upload-time = "2025-09-25T21:32:21.167Z" }, { url = "https://files.pythonhosted.org/packages/1a/08/67bd04656199bbb51dbed1439b7f27601dfb576fb864099c7ef0c3e55531/pyyaml-6.0.3-cp312-cp312-win_arm64.whl", hash = "sha256:64386e5e707d03a7e172c0701abfb7e10f0fb753ee1d773128192742712a98fd", size = 140344, upload-time = "2025-09-25T21:32:22.617Z" }, { url = "https://files.pythonhosted.org/packages/d1/11/0fd08f8192109f7169db964b5707a2f1e8b745d4e239b784a5a1dd80d1db/pyyaml-6.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:8da9669d359f02c0b91ccc01cac4a67f16afec0dac22c2ad09f46bee0697eba8", size = 181669, upload-time = "2025-09-25T21:32:23.673Z" }, { url = "https://files.pythonhosted.org/packages/b1/16/95309993f1d3748cd644e02e38b75d50cbc0d9561d21f390a76242ce073f/pyyaml-6.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:2283a07e2c21a2aa78d9c4442724ec1eb15f5e42a723b99cb3d822d48f5f7ad1", size = 173252, upload-time = "2025-09-25T21:32:25.149Z" }, { url = "https://files.pythonhosted.org/packages/50/31/b20f376d3f810b9b2371e72ef5adb33879b25edb7a6d072cb7ca0c486398/pyyaml-6.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ee2922902c45ae8ccada2c5b501ab86c36525b883eff4255313a253a3160861c", size = 767081, upload-time = "2025-09-25T21:32:26.575Z" }, { url = "https://files.pythonhosted.org/packages/49/1e/a55ca81e949270d5d4432fbbd19dfea5321eda7c41a849d443dc92fd1ff7/pyyaml-6.0.3-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a33284e20b78bd4a18c8c2282d549d10bc8408a2a7ff57653c0cf0b9be0afce5", size = 841159, upload-time = "2025-09-25T21:32:27.727Z" }, { url = "https://files.pythonhosted.org/packages/74/27/e5b8f34d02d9995b80abcef563ea1f8b56d20134d8f4e5e81733b1feceb2/pyyaml-6.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0f29edc409a6392443abf94b9cf89ce99889a1dd5376d94316ae5145dfedd5d6", size = 801626, upload-time = "2025-09-25T21:32:28.878Z" }, { url = "https://files.pythonhosted.org/packages/f9/11/ba845c23988798f40e52ba45f34849aa8a1f2d4af4b798588010792ebad6/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f7057c9a337546edc7973c0d3ba84ddcdf0daa14533c2065749c9075001090e6", size = 753613, upload-time = "2025-09-25T21:32:30.178Z" }, { url = "https://files.pythonhosted.org/packages/3d/e0/7966e1a7bfc0a45bf0a7fb6b98ea03fc9b8d84fa7f2229e9659680b69ee3/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:eda16858a3cab07b80edaf74336ece1f986ba330fdb8ee0d6c0d68fe82bc96be", size = 794115, upload-time = "2025-09-25T21:32:31.353Z" }, { url = "https://files.pythonhosted.org/packages/de/94/980b50a6531b3019e45ddeada0626d45fa85cbe22300844a7983285bed3b/pyyaml-6.0.3-cp313-cp313-win32.whl", hash = "sha256:d0eae10f8159e8fdad514efdc92d74fd8d682c933a6dd088030f3834bc8e6b26", size = 137427, upload-time = "2025-09-25T21:32:32.58Z" }, { url = "https://files.pythonhosted.org/packages/97/c9/39d5b874e8b28845e4ec2202b5da735d0199dbe5b8fb85f91398814a9a46/pyyaml-6.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:79005a0d97d5ddabfeeea4cf676af11e647e41d81c9a7722a193022accdb6b7c", size = 154090, upload-time = "2025-09-25T21:32:33.659Z" }, { url = "https://files.pythonhosted.org/packages/73/e8/2bdf3ca2090f68bb3d75b44da7bbc71843b19c9f2b9cb9b0f4ab7a5a4329/pyyaml-6.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:5498cd1645aa724a7c71c8f378eb29ebe23da2fc0d7a08071d89469bf1d2defb", size = 140246, upload-time = "2025-09-25T21:32:34.663Z" }, { url = "https://files.pythonhosted.org/packages/9d/8c/f4bd7f6465179953d3ac9bc44ac1a8a3e6122cf8ada906b4f96c60172d43/pyyaml-6.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:8d1fab6bb153a416f9aeb4b8763bc0f22a5586065f86f7664fc23339fc1c1fac", size = 181814, upload-time = "2025-09-25T21:32:35.712Z" }, { url = "https://files.pythonhosted.org/packages/bd/9c/4d95bb87eb2063d20db7b60faa3840c1b18025517ae857371c4dd55a6b3a/pyyaml-6.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:34d5fcd24b8445fadc33f9cf348c1047101756fd760b4dacb5c3e99755703310", size = 173809, upload-time = "2025-09-25T21:32:36.789Z" }, { url = "https://files.pythonhosted.org/packages/92/b5/47e807c2623074914e29dabd16cbbdd4bf5e9b2db9f8090fa64411fc5382/pyyaml-6.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:501a031947e3a9025ed4405a168e6ef5ae3126c59f90ce0cd6f2bfc477be31b7", size = 766454, upload-time = "2025-09-25T21:32:37.966Z" }, { url = "https://files.pythonhosted.org/packages/02/9e/e5e9b168be58564121efb3de6859c452fccde0ab093d8438905899a3a483/pyyaml-6.0.3-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:b3bc83488de33889877a0f2543ade9f70c67d66d9ebb4ac959502e12de895788", size = 836355, upload-time = "2025-09-25T21:32:39.178Z" }, { url = "https://files.pythonhosted.org/packages/88/f9/16491d7ed2a919954993e48aa941b200f38040928474c9e85ea9e64222c3/pyyaml-6.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c458b6d084f9b935061bc36216e8a69a7e293a2f1e68bf956dcd9e6cbcd143f5", size = 794175, upload-time = "2025-09-25T21:32:40.865Z" }, { url = "https://files.pythonhosted.org/packages/dd/3f/5989debef34dc6397317802b527dbbafb2b4760878a53d4166579111411e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7c6610def4f163542a622a73fb39f534f8c101d690126992300bf3207eab9764", size = 755228, upload-time = "2025-09-25T21:32:42.084Z" }, { url = "https://files.pythonhosted.org/packages/d7/ce/af88a49043cd2e265be63d083fc75b27b6ed062f5f9fd6cdc223ad62f03e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:5190d403f121660ce8d1d2c1bb2ef1bd05b5f68533fc5c2ea899bd15f4399b35", size = 789194, upload-time = "2025-09-25T21:32:43.362Z" }, { url = "https://files.pythonhosted.org/packages/23/20/bb6982b26a40bb43951265ba29d4c246ef0ff59c9fdcdf0ed04e0687de4d/pyyaml-6.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:4a2e8cebe2ff6ab7d1050ecd59c25d4c8bd7e6f400f5f82b96557ac0abafd0ac", size = 156429, upload-time = "2025-09-25T21:32:57.844Z" }, { url = "https://files.pythonhosted.org/packages/f4/f4/a4541072bb9422c8a883ab55255f918fa378ecf083f5b85e87fc2b4eda1b/pyyaml-6.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:93dda82c9c22deb0a405ea4dc5f2d0cda384168e466364dec6255b293923b2f3", size = 143912, upload-time = "2025-09-25T21:32:59.247Z" }, { url = "https://files.pythonhosted.org/packages/7c/f9/07dd09ae774e4616edf6cda684ee78f97777bdd15847253637a6f052a62f/pyyaml-6.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:02893d100e99e03eda1c8fd5c441d8c60103fd175728e23e431db1b589cf5ab3", size = 189108, upload-time = "2025-09-25T21:32:44.377Z" }, { url = "https://files.pythonhosted.org/packages/4e/78/8d08c9fb7ce09ad8c38ad533c1191cf27f7ae1effe5bb9400a46d9437fcf/pyyaml-6.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c1ff362665ae507275af2853520967820d9124984e0f7466736aea23d8611fba", size = 183641, upload-time = "2025-09-25T21:32:45.407Z" }, { url = "https://files.pythonhosted.org/packages/7b/5b/3babb19104a46945cf816d047db2788bcaf8c94527a805610b0289a01c6b/pyyaml-6.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6adc77889b628398debc7b65c073bcb99c4a0237b248cacaf3fe8a557563ef6c", size = 831901, upload-time = "2025-09-25T21:32:48.83Z" }, { url = "https://files.pythonhosted.org/packages/8b/cc/dff0684d8dc44da4d22a13f35f073d558c268780ce3c6ba1b87055bb0b87/pyyaml-6.0.3-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a80cb027f6b349846a3bf6d73b5e95e782175e52f22108cfa17876aaeff93702", size = 861132, upload-time = "2025-09-25T21:32:50.149Z" }, { url = "https://files.pythonhosted.org/packages/b1/5e/f77dc6b9036943e285ba76b49e118d9ea929885becb0a29ba8a7c75e29fe/pyyaml-6.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:00c4bdeba853cc34e7dd471f16b4114f4162dc03e6b7afcc2128711f0eca823c", size = 839261, upload-time = "2025-09-25T21:32:51.808Z" }, { url = "https://files.pythonhosted.org/packages/ce/88/a9db1376aa2a228197c58b37302f284b5617f56a5d959fd1763fb1675ce6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:66e1674c3ef6f541c35191caae2d429b967b99e02040f5ba928632d9a7f0f065", size = 805272, upload-time = "2025-09-25T21:32:52.941Z" }, { url = "https://files.pythonhosted.org/packages/da/92/1446574745d74df0c92e6aa4a7b0b3130706a4142b2d1a5869f2eaa423c6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:16249ee61e95f858e83976573de0f5b2893b3677ba71c9dd36b9cf8be9ac6d65", size = 829923, upload-time = "2025-09-25T21:32:54.537Z" }, { url = "https://files.pythonhosted.org/packages/f0/7a/1c7270340330e575b92f397352af856a8c06f230aa3e76f86b39d01b416a/pyyaml-6.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4ad1906908f2f5ae4e5a8ddfce73c320c2a1429ec52eafd27138b7f1cbe341c9", size = 174062, upload-time = "2025-09-25T21:32:55.767Z" }, { url = "https://files.pythonhosted.org/packages/f1/12/de94a39c2ef588c7e6455cfbe7343d3b2dc9d6b6b2f40c4c6565744c873d/pyyaml-6.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:ebc55a14a21cb14062aa4162f906cd962b28e2e9ea38f9b4391244cd8de4ae0b", size = 149341, upload-time = "2025-09-25T21:32:56.828Z" }, ] [[package]] name = "pyyaml-env-tag" version = "1.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pyyaml" }, ] sdist = { url = "https://files.pythonhosted.org/packages/eb/2e/79c822141bfd05a853236b504869ebc6b70159afc570e1d5a20641782eaa/pyyaml_env_tag-1.1.tar.gz", hash = "sha256:2eb38b75a2d21ee0475d6d97ec19c63287a7e140231e4214969d0eac923cd7ff", size = 5737, upload-time = "2025-05-13T15:24:01.64Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/04/11/432f32f8097b03e3cd5fe57e88efb685d964e2e5178a48ed61e841f7fdce/pyyaml_env_tag-1.1-py3-none-any.whl", hash = "sha256:17109e1a528561e32f026364712fee1264bc2ea6715120891174ed1b980d2e04", size = 4722, upload-time = "2025-05-13T15:23:59.629Z" }, ] [[package]] name = "referencing" version = "0.37.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "attrs" }, { name = "rpds-py" }, { name = "typing-extensions", marker = "python_full_version < '3.13'" }, ] sdist = { url = "https://files.pythonhosted.org/packages/22/f5/df4e9027acead3ecc63e50fe1e36aca1523e1719559c499951bb4b53188f/referencing-0.37.0.tar.gz", hash = "sha256:44aefc3142c5b842538163acb373e24cce6632bd54bdb01b21ad5863489f50d8", size = 78036, upload-time = "2025-10-13T15:30:48.871Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/2c/58/ca301544e1fa93ed4f80d724bf5b194f6e4b945841c5bfd555878eea9fcb/referencing-0.37.0-py3-none-any.whl", hash = "sha256:381329a9f99628c9069361716891d34ad94af76e461dcb0335825aecc7692231", size = 26766, upload-time = "2025-10-13T15:30:47.625Z" }, ] [[package]] name = "regex" version = "2026.5.9" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/dc/0e/49aee608ad09480e7fd276898c99ec6192985fa331abe4eb3a986094490b/regex-2026.5.9.tar.gz", hash = "sha256:a8234aa23ec39894bfe4a3f1b85616a7032481964a13ac6fc9f10de4f6fca270", size = 416074, upload-time = "2026-05-09T23:15:19.37Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/50/9b/6550044bc44e17c84d312c031c2ec42fbdb6a4ec4e29093be3a172d08772/regex-2026.5.9-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:57eeeb05db7979413dec5438f2db21d7ecbba787cde7a711df1a6f6df672aa06", size = 490451, upload-time = "2026-05-09T23:12:34.72Z" }, { url = "https://files.pythonhosted.org/packages/1e/95/fc7ba4303b5a0f92446a12ee6778ef2c6c799233f5060042a31bf390cfe9/regex-2026.5.9-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:398c521292f4c7fb807001dcd54694d3a1fcafc179a36ad9cc56f98df85930b6", size = 292112, upload-time = "2026-05-09T23:12:36.285Z" }, { url = "https://files.pythonhosted.org/packages/54/4b/ee27938d1b2c443e89a9a10e00d2d19aa5ee300cd3d61140644e93bb083e/regex-2026.5.9-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f7a7c26137296beba7784de6eba69c6a93a63ccebc385e4962fe67e267a91225", size = 289599, upload-time = "2026-05-09T23:12:38.089Z" }, { url = "https://files.pythonhosted.org/packages/d8/dd/ba103dc19614e25f3880800ca67ce093d6e21b325d72b8383c7bf906e9fa/regex-2026.5.9-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6441cc660d76107934a09c22167200839a0e89604a6297f78a974e66e931d2c0", size = 796732, upload-time = "2026-05-09T23:12:40.062Z" }, { url = "https://files.pythonhosted.org/packages/cf/e7/f035b4fd858b050b0080bf302968dc0f59ba34e391872d54936758e6844e/regex-2026.5.9-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:91328f1c23d47595ca3ef0a7557fa129c5a23404b775c770697d2f35b33e0107", size = 865440, upload-time = "2026-05-09T23:12:42.059Z" }, { url = "https://files.pythonhosted.org/packages/0a/51/8cd301ecc899aea28124357f729f4272f44de7806fc7ca02490bfbe253e8/regex-2026.5.9-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:93a7860539414dddaefba2b40f8771765ae17949d4c7182b876ce429e11a8309", size = 912329, upload-time = "2026-05-09T23:12:44.373Z" }, { url = "https://files.pythonhosted.org/packages/cc/1e/3fbe2fa1e8cebd62f3bb7d3321cff1640aca2e240b51d9bd624aad949260/regex-2026.5.9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:dd2810d22146b6d838acc5ec15602cb6b47920aa4e33015df3868eedfd20bab8", size = 801239, upload-time = "2026-05-09T23:12:46.268Z" }, { url = "https://files.pythonhosted.org/packages/17/2f/6f6008682bf2cf98040a0d3153a8e557b6ab728d7713d045cee4ce544ab8/regex-2026.5.9-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:daff2bdbaf1d23e52fdff7c0b7bc2048b68f978df6a4d107ac981f94caef2e66", size = 777054, upload-time = "2026-05-09T23:12:48.051Z" }, { url = "https://files.pythonhosted.org/packages/19/2b/eee0d20a6842ba04df4b8847a920b57ef56853f14ef85405473e586b605a/regex-2026.5.9-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:4eeb011098fcb77af513dcef521a3dbecbf8849b1e38940759d293b7a93f5026", size = 785098, upload-time = "2026-05-09T23:12:49.851Z" }, { url = "https://files.pythonhosted.org/packages/4a/98/6fc1e6410feefb92159edaed5041992bfe390e8d26c721865434acbca558/regex-2026.5.9-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:ea9c8ecfa1b73c73b626534d6626e5340d429630943672b8480724f44e84b962", size = 860095, upload-time = "2026-05-09T23:12:51.666Z" }, { url = "https://files.pythonhosted.org/packages/18/a3/bd855e0f2cb1a978ecf6fa6bb69632dd9c3f6ea3b81cde62fde14c9daec7/regex-2026.5.9-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:cd2846168eb9ee3c513902bc8225409cb1caab31d04728b145171fa1625d9621", size = 765762, upload-time = "2026-05-09T23:12:53.413Z" }, { url = "https://files.pythonhosted.org/packages/dc/66/0ae8c092e60b14c79d24f8e0b7f0aea5bfbffdcab00b5483d13404d3c3a5/regex-2026.5.9-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:39617fb0cde9c0e6306dc70e3bfc096f3da793219879f7ae7aa341a69fbdcf6d", size = 852100, upload-time = "2026-05-09T23:12:55.256Z" }, { url = "https://files.pythonhosted.org/packages/21/de/8dfde60fc1b21c946a893ba273403b72617edb261370cb1087099a83f088/regex-2026.5.9-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:fd03c4f0e33280d15cae17159b899245d6b7c53d21def19b263b39655061f5ce", size = 789479, upload-time = "2026-05-09T23:12:57.573Z" }, { url = "https://files.pythonhosted.org/packages/c3/1c/bdcc98f9a4af4fdd166c74941174619ccff4726d3ce32faa8e9a2ecd38dd/regex-2026.5.9-cp312-cp312-win32.whl", hash = "sha256:164eba9b755ea6f244b0d881196fbc1fac09714e9782c9e2732b813142033c8e", size = 266699, upload-time = "2026-05-09T23:12:59.14Z" }, { url = "https://files.pythonhosted.org/packages/78/87/240d36864f9e48ace85f72e79ced97ceb7f27ce87739a947dcb834b4e6bc/regex-2026.5.9-cp312-cp312-win_amd64.whl", hash = "sha256:86f40a5d6444db30a125c9c9177e6b25dad981cbc37451fd838f145e6edac92e", size = 277783, upload-time = "2026-05-09T23:13:00.789Z" }, { url = "https://files.pythonhosted.org/packages/4f/b5/7b30f312b0669dff5beebe5b0989dc2d1a312b1a44fab852199c387a5b96/regex-2026.5.9-cp312-cp312-win_arm64.whl", hash = "sha256:96f5f58b54a063d7ea9dca08e1cf57bfe10499c4d579ee672da284f57f5f0070", size = 270513, upload-time = "2026-05-09T23:13:02.426Z" }, { url = "https://files.pythonhosted.org/packages/aa/da/797e91ecec6f84135da778ddce78c20e0af5d2a15c26f87a81bc3eadb6db/regex-2026.5.9-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:d626b84406444b165fc0ba981604edea39f0588ff1f92baa23fe50799ea9afdb", size = 490303, upload-time = "2026-05-09T23:13:04.382Z" }, { url = "https://files.pythonhosted.org/packages/44/da/bf30abaaa737b58f4a4b8c4a03659e02fd92092c822e0197ed9e0daab917/regex-2026.5.9-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:d7bdc0ab8f3dd7e1b4f9ab88634e13374669db86bb3c72e8292f07ae313f539f", size = 292019, upload-time = "2026-05-09T23:13:06.022Z" }, { url = "https://files.pythonhosted.org/packages/2d/e7/d0eaf5713828417b9e5648cf81fa9bacd4961f6ab98c380c2034f8716e35/regex-2026.5.9-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a8820737949116ffff55fe18f9fc644530063ba6ebfcb8314239416e78f1347c", size = 289468, upload-time = "2026-05-09T23:13:08.214Z" }, { url = "https://files.pythonhosted.org/packages/d3/9b/b3fdd62b003baa1a9b593cd8c8699c9651c2e80cc21a5c715707983c42d7/regex-2026.5.9-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:aa0fbdbac82cb3e4450d0ccde7d7a35607f4cb2dd9fba4b8b69bfaf8c9fa6aed", size = 796749, upload-time = "2026-05-09T23:13:10.573Z" }, { url = "https://files.pythonhosted.org/packages/d4/30/66ab84588765f5b4b271a9ca09ef7ce2b87caa95176ec3d2ad65d7bc4902/regex-2026.5.9-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:57e8915c7986aa33d25e4d3629cef711cd2863f2961b10409f0c04cb8b7d9020", size = 865445, upload-time = "2026-05-09T23:13:12.523Z" }, { url = "https://files.pythonhosted.org/packages/1a/89/f05169e8588aac365f35ffc7f3bc3184f095ef4cfded7cfaa3c7fd5dbd89/regex-2026.5.9-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:508f56a89ba9cb26e4168cbc37dbd60a28d82430a9e18ad1d25fe0883c314ca2", size = 912322, upload-time = "2026-05-09T23:13:14.281Z" }, { url = "https://files.pythonhosted.org/packages/30/e1/c93444052cf41581f3c884ab3fb5823daf0992f11cd4388d4275ca610558/regex-2026.5.9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b6d189041f15691cfa2b6c4290448ec221244d225b3f5fe9e7771b34ffcdf6e2", size = 801269, upload-time = "2026-05-09T23:13:16.569Z" }, { url = "https://files.pythonhosted.org/packages/50/fe/0cf96b882f540e62e8b9956599798203d599c44cf4c77917ca27400ff69b/regex-2026.5.9-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:e82db382b44d0111b22601c509c89f64434816c9e0eef9d1989cda8cc6ff1c04", size = 777085, upload-time = "2026-05-09T23:13:18.675Z" }, { url = "https://files.pythonhosted.org/packages/23/5c/d78d4924e7fc875557b9e9b768423925fdfaac5549d06da7810019a9bd26/regex-2026.5.9-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:2acfb48634f64996b57f90f39afa692ff362162722581921fe92239a59960f3c", size = 785153, upload-time = "2026-05-09T23:13:20.525Z" }, { url = "https://files.pythonhosted.org/packages/bf/e0/5214774090e7b4524dcea3e3c4aa74141d43043f8beb49c1599db1c8b53a/regex-2026.5.9-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:d29eebfc9525db68cad3c97eedd7f754fa265aa5cd0cf4f863b2421e1b48fc9f", size = 860164, upload-time = "2026-05-09T23:13:22.263Z" }, { url = "https://files.pythonhosted.org/packages/6e/e1/4a57a83350319b1271f0d7a249b8672513ed928b237a741631270de6caea/regex-2026.5.9-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:debb893095e944091c16e641a6e33c1b0f4cb61ab945ec5afbf53ce7068834d8", size = 765731, upload-time = "2026-05-09T23:13:24.277Z" }, { url = "https://files.pythonhosted.org/packages/12/f4/499e74a20c156fc75836ee04a72a38d1a063978f600937f9760467beb1b0/regex-2026.5.9-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:d659eee77986549c9ea45b861c7567e44d6287c3dc9a4565478853f7b9fe2ff6", size = 852062, upload-time = "2026-05-09T23:13:26.125Z" }, { url = "https://files.pythonhosted.org/packages/5b/92/7eebc0d0a01e78629695f342ba17e0deaff8fb45e79cc0d7b98287da6e3e/regex-2026.5.9-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:2efa205e6d98b24d1f3ab395c11aa15cdf10935bca283d0285e0499c284fba21", size = 789577, upload-time = "2026-05-09T23:13:27.814Z" }, { url = "https://files.pythonhosted.org/packages/05/a4/018e71f7d2ad48c1ebe6d3ae0026f9b7cb4802fd15c7cc02fdf724355102/regex-2026.5.9-cp313-cp313-win32.whl", hash = "sha256:f3844f134e834076677dd369976e9f5068679fcb8e50102fdf6b7ac96a3ec127", size = 266691, upload-time = "2026-05-09T23:13:29.549Z" }, { url = "https://files.pythonhosted.org/packages/e6/1d/861a93719fb9ee7dbfc3761b3797b7a3e112a5d42c6129459d2d741be9b5/regex-2026.5.9-cp313-cp313-win_amd64.whl", hash = "sha256:3527bb4942d2c14552155406cdedd906567456821848aed1cb4933a391bf5eca", size = 277747, upload-time = "2026-05-09T23:13:31.859Z" }, { url = "https://files.pythonhosted.org/packages/d9/c6/0a2436ae4da1ba76e51cb98943c6838a9a721faa40ebe2dce07694ae34e3/regex-2026.5.9-cp313-cp313-win_arm64.whl", hash = "sha256:56a33f191f17d8c417f99945ebdc1e691d3af9605d86ec68c7e54a57e3e17af6", size = 270500, upload-time = "2026-05-09T23:13:33.525Z" }, { url = "https://files.pythonhosted.org/packages/e8/e9/d21346f7b60ed58789371358ed66b09d00f832e1bd7c06e55d9da5679882/regex-2026.5.9-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:01f28d868834624c934b8d2e0aa1c8341337e37831f4a012f18a5afcba4cbaf3", size = 494172, upload-time = "2026-05-09T23:13:35.935Z" }, { url = "https://files.pythonhosted.org/packages/c4/43/fd1177a2032037c681baecdb3422ee4e1424aec4e4f470ef47793d325274/regex-2026.5.9-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:48036f6374aaa79eb3b754ec29c61d1c6b1606749d705a13f8854fa2539671f6", size = 293952, upload-time = "2026-05-09T23:13:38.307Z" }, { url = "https://files.pythonhosted.org/packages/f2/7d/9fbf919768368d3f8a4f6c692cf2aa61e482b2b81ec6a298ace4cbf02480/regex-2026.5.9-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:b96350aa424e79d4fd6b567b344dcbe2b2d6bfc48dfe7717587e1fa6d43da6ff", size = 292314, upload-time = "2026-05-09T23:13:40.353Z" }, { url = "https://files.pythonhosted.org/packages/e2/6c/e41bfeecb589716843e7c4df09ba46ff2a42961457afece19059d85caeef/regex-2026.5.9-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:8f3af7a4903c5c04a11a196a5aa75cdd7dd3f8508132f9fb3259d9f5908e3b88", size = 811681, upload-time = "2026-05-09T23:13:42.543Z" }, { url = "https://files.pythonhosted.org/packages/87/83/a5c1c525fba0aa656e88ad0face0b1829788ef4c2fb6b26df58aa1151b84/regex-2026.5.9-cp313-cp313t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:7e87577720152d2caae19fe2baaf1f8d5ca12091e9e229f03915c37d1e4b9178", size = 871135, upload-time = "2026-05-09T23:13:44.326Z" }, { url = "https://files.pythonhosted.org/packages/18/d4/80882e799e440dd878b0979cbebf8fa4d54624a332c83037c7a701649e3f/regex-2026.5.9-cp313-cp313t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:c8b9b9d294cfea3cd19c718ade7cc93492b2c4991abd9a68d0b3477ae6d8e100", size = 917265, upload-time = "2026-05-09T23:13:47.295Z" }, { url = "https://files.pythonhosted.org/packages/ae/ff/8db60211e2286e396aad7dc7725356c502bff0901ea05bd6cdc2e1a042b9/regex-2026.5.9-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:728d8bfd28a8845c8b6bc5dc7ce010453d206396786c0765c2740cb65f37791e", size = 816311, upload-time = "2026-05-09T23:13:49.885Z" }, { url = "https://files.pythonhosted.org/packages/4c/47/742ef579c61730f8d268e5cf1f9ce0e37e2ea041ad0f5644724f2378e463/regex-2026.5.9-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:7e30b874d341fac767d7df5a0870540541c2c054b80cfaac116e8d367a8a7ff2", size = 785498, upload-time = "2026-05-09T23:13:52.25Z" }, { url = "https://files.pythonhosted.org/packages/7f/ab/cb0999802dcb0fb95b1ab005e8d4163d8afdd67efc2cb6b6630ac13f8cb1/regex-2026.5.9-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:fd190e88a895a8901325fad284a3f74ea52b1da8525b76cc811fa9b1edf0ce2b", size = 801348, upload-time = "2026-05-09T23:13:54.127Z" }, { url = "https://files.pythonhosted.org/packages/7d/62/8ca59a24c55bc34d166eefaf3717bd77772f329fdbf984d86581e0a3571c/regex-2026.5.9-cp313-cp313t-musllinux_1_2_ppc64le.whl", hash = "sha256:8e76e8161ad00694cfce6767d5dea860c6391ac5b83e5c3a39661e696f11fc7e", size = 866493, upload-time = "2026-05-09T23:13:56.067Z" }, { url = "https://files.pythonhosted.org/packages/8d/3d/30f2ae62cef3278bb5bb821f467277a55fb73f01032cf85997e15e8289a8/regex-2026.5.9-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:ddda5340e6c01a293027dd46232fa79eaff1b48058ce7a98f572b6445b088041", size = 772811, upload-time = "2026-05-09T23:13:57.867Z" }, { url = "https://files.pythonhosted.org/packages/d8/ae/7d2089bcd78ad0c0161bc684339df50032acb438a7bd3305e7ddb1193cec/regex-2026.5.9-cp313-cp313t-musllinux_1_2_s390x.whl", hash = "sha256:205109e96b3cf5adf8f4cd62bedde9487feb282b9497a3535451e5a24cd706a0", size = 856584, upload-time = "2026-05-09T23:13:59.679Z" }, { url = "https://files.pythonhosted.org/packages/a9/29/92ff47f75990131ea4f24ba17819e5a9d141e10819807e09addd73409af6/regex-2026.5.9-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:dfbe4579b9f08036aa7d101d1835437a20783574ac66327e6b29b4018a138081", size = 803453, upload-time = "2026-05-09T23:14:01.978Z" }, { url = "https://files.pythonhosted.org/packages/04/99/eff29f1037dcab36702c9ee5d6858cf1ce2336ea8ea2987f64245b99ea5e/regex-2026.5.9-cp313-cp313t-win32.whl", hash = "sha256:ed2c9e8068b614c574d8d30e543d617cf5379b0535d46f97ef00e904745a08b5", size = 269951, upload-time = "2026-05-09T23:14:03.661Z" }, { url = "https://files.pythonhosted.org/packages/0e/9d/8870b8981d27b22cda77bb26a5ac7ebfa9c7d9e0dea195a834a82380e748/regex-2026.5.9-cp313-cp313t-win_amd64.whl", hash = "sha256:b46b0f094dc1d3b90356c85a0bd2c9bafc4a6a190b9d6f8ddd5a033b6e088ed4", size = 281240, upload-time = "2026-05-09T23:14:05.56Z" }, { url = "https://files.pythonhosted.org/packages/72/b1/3379415e8f135c13ac551353397cc4fe97b4978f3cac73c5fcbcded548b8/regex-2026.5.9-cp313-cp313t-win_arm64.whl", hash = "sha256:872acc074bd29ffc9913ecdfedf6ea77502312ca44a4aa0d3779089c6069d8de", size = 272383, upload-time = "2026-05-09T23:14:07.843Z" }, { url = "https://files.pythonhosted.org/packages/13/3e/9c3cd292d8808b3645a2ce517e200179b6d0e903f176300bd8b542e14de5/regex-2026.5.9-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:1bd7587a2948b4085195d5a3374eaf4a425dc3e55784c038175355ecf3bbbf8a", size = 490376, upload-time = "2026-05-09T23:14:09.64Z" }, { url = "https://files.pythonhosted.org/packages/60/70/d43ee8a2ca0a8b68d167f21658b85520ac0574617c7f320367c5047f7556/regex-2026.5.9-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:dea2e88e1cce4522496cce630e11e67b98b7076620bc4336c3f674bc21a375f4", size = 291964, upload-time = "2026-05-09T23:14:11.424Z" }, { url = "https://files.pythonhosted.org/packages/21/91/9d50b433828d8e74196904e168a43abf1e6e88b2a15d47ed742456720c37/regex-2026.5.9-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:2099f7e7ff7b6aa3192312650a56e91cc091e49d50b04e4f6f8b6e28b3b27f1c", size = 289682, upload-time = "2026-05-09T23:14:13.123Z" }, { url = "https://files.pythonhosted.org/packages/3e/d2/b835e3cafbb9d977736912436259ff551d60919f7d7b3d37d46659c63564/regex-2026.5.9-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ecd353045824e4477562a2ac718c25799cdaaa41f7aa925a806a8a3e6848a5b9", size = 796996, upload-time = "2026-05-09T23:14:14.923Z" }, { url = "https://files.pythonhosted.org/packages/2c/a6/9f992d00019166b9de01c546dd4549bc679f2a68df11b877740b0760b7c2/regex-2026.5.9-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:65c8c8c37377794bd5b2f3ebe51919042bf17aec802e23c833d89782ed0c78af", size = 866089, upload-time = "2026-05-09T23:14:17.757Z" }, { url = "https://files.pythonhosted.org/packages/e0/08/4d32af657e049b19cb62b02e46e38fe1518797bfb2203ee93a510b21b0dc/regex-2026.5.9-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:5b73ab8afcf66c622db143d1c6fda4e58e4d537ee4f125229ad47b1ab80f34c0", size = 911530, upload-time = "2026-05-09T23:14:20.353Z" }, { url = "https://files.pythonhosted.org/packages/d9/27/2af43dd1dc201d1fecefda64a45f4ad0995855b92724f795a777b402ee69/regex-2026.5.9-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0de5cf193997384ed2ca6f1cd4f78055b255d93d82d5a8cd6ba0d11c10b167e4", size = 800643, upload-time = "2026-05-09T23:14:22.265Z" }, { url = "https://files.pythonhosted.org/packages/a4/dd/23a249047013b5321d4a60c4d2437462086f601b061776a525e5fba2a59f/regex-2026.5.9-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:d641a8c9a61618047796d572a39a79b26167b0411d2c3031937b2fe2d081e2cf", size = 777223, upload-time = "2026-05-09T23:14:24.179Z" }, { url = "https://files.pythonhosted.org/packages/94/6a/e85ed9538cd19586d0465076a4578a12e093ce776d15f3f8ce92733a8dd6/regex-2026.5.9-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:24b2355ef5cc9aa5b8f07d17704face1c166fdcc2290fa7bd6e6c925655a8346", size = 785760, upload-time = "2026-05-09T23:14:26.065Z" }, { url = "https://files.pythonhosted.org/packages/2a/c4/f25473209438638e947c55f9156fd8f236f74169229028cc99116380868e/regex-2026.5.9-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:a24852d3c29ad9e47593593d8a247c44ccc3d0548ef12c822d6ed0810affe676", size = 860891, upload-time = "2026-05-09T23:14:28.17Z" }, { url = "https://files.pythonhosted.org/packages/f9/f7/f4f86e3c74419c37370e91f150ae0c2ef7d34b2e0e4cdd5da046a02e4022/regex-2026.5.9-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:916714069da19329ef7de197dcbc77bb3104145c7c2c864dbfbe318f46b88b14", size = 765891, upload-time = "2026-05-09T23:14:30.06Z" }, { url = "https://files.pythonhosted.org/packages/26/70/704d8e13765939146b1cd0ef4e2feb71d7929727d2290f026eed10095955/regex-2026.5.9-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:fa411799ca8da32a8d38d020a88faa5b6f91657d284761352940ecf9f7c3bbdd", size = 851380, upload-time = "2026-05-09T23:14:32.123Z" }, { url = "https://files.pythonhosted.org/packages/26/29/1a13582a8460038edc38e49f64ceb0dd7c60f5caba77571f4bf6601965d9/regex-2026.5.9-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:1e6da47d679b7010ef27556b6e0f99771b744936db1792a10ceac6547ae1503e", size = 789350, upload-time = "2026-05-09T23:14:34.799Z" }, { url = "https://files.pythonhosted.org/packages/73/56/3dcafe34fc72e271d62ad9a291801e88a1457bb251c132f15fcc2e5aad1a/regex-2026.5.9-cp314-cp314-win32.whl", hash = "sha256:98bd73080e8756255137e1bd3f3f00295bbc5aa383c0e0f973920e9134d7c4ad", size = 272130, upload-time = "2026-05-09T23:14:36.729Z" }, { url = "https://files.pythonhosted.org/packages/d0/9c/02eebf0be95efe416c664db7fb8b6b05b7a0b06a7544f2884f2558b0526f/regex-2026.5.9-cp314-cp314-win_amd64.whl", hash = "sha256:ff8d372ac2acdc048d1c19916f27ee61bc5722728458ba6ca5052f2c72d51763", size = 280999, upload-time = "2026-05-09T23:14:39.126Z" }, { url = "https://files.pythonhosted.org/packages/70/5a/1dd1abee76cb7a846a0bcf42fdc87e5720c3c33c24f3e37814310a513d9f/regex-2026.5.9-cp314-cp314-win_arm64.whl", hash = "sha256:e1d93bf647916292e8edcec150c07ddf3dc50179ccaf770c04a7f9e452155372", size = 273500, upload-time = "2026-05-09T23:14:41.059Z" }, { url = "https://files.pythonhosted.org/packages/86/c1/c5f619b0057a7965cb78ec559c1d7a45ce8c99a35bea95483d64959a93d9/regex-2026.5.9-cp314-cp314t-macosx_10_13_universal2.whl", hash = "sha256:83d0ee4a57d1c87cb549e195ec300b8f0ec3a82eba66d835e4e2ed8634fe4499", size = 494269, upload-time = "2026-05-09T23:14:42.869Z" }, { url = "https://files.pythonhosted.org/packages/05/2c/5d01f1aee33de4bbe60c8452945bfc8477ca7c5ae4450f6bfe711036cb36/regex-2026.5.9-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:d3d7eb5c9a7f6df82ed3cfac9beb93882a5cbcb5b8b157b56cb2b3b276574ac1", size = 293954, upload-time = "2026-05-09T23:14:44.822Z" }, { url = "https://files.pythonhosted.org/packages/7a/fe/e8988b2ae2108c6ef71bd4aa8d87fbe257976dd0810e826cd75f701c68b6/regex-2026.5.9-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:075160bf16658e16d35233300b8453aac25de4cbea808d22348b6979668e924d", size = 292405, upload-time = "2026-05-09T23:14:47.211Z" }, { url = "https://files.pythonhosted.org/packages/79/34/d2b0937faa7859263f7f0a3c6b103a1296306be6952dc173d0154e9a2f49/regex-2026.5.9-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:45375819235558a4ff1c4971dc32881f022613abdb180128f5cb4768c1765a1c", size = 811855, upload-time = "2026-05-09T23:14:49.21Z" }, { url = "https://files.pythonhosted.org/packages/80/fe/daf53a47457a8486db66c66c01ceb9c2303eecee3f87197f1e77eb1a736d/regex-2026.5.9-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:ead4b163ac30a29574510cd4b3e2e985ac5290c05fc7095557d6a5f403fc31b5", size = 871189, upload-time = "2026-05-09T23:14:51.555Z" }, { url = "https://files.pythonhosted.org/packages/1c/75/058fc4470cbfbf57d800aff1a0022b929a3f9fa553ee10a0cdf2070eb31f/regex-2026.5.9-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:8c6e4218fbdfbcd4f6c19efca40930d24a621bf4b48cb76bc6640543bd28ef20", size = 917485, upload-time = "2026-05-09T23:14:53.633Z" }, { url = "https://files.pythonhosted.org/packages/88/e7/179cfda3a28bc843b5c6cfe7f79f23489c791ed95f151083803660878432/regex-2026.5.9-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6351571c8a42b505eb555c0dc47d740d0fb66977dc142919eea6f4325b7c56a0", size = 816369, upload-time = "2026-05-09T23:14:56.198Z" }, { url = "https://files.pythonhosted.org/packages/41/90/6f0cc422071688266d344fca8462d787cba0a2c144acb25721f9a61ec265/regex-2026.5.9-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:002205cafd2a9e78c6290c7d1df277bf3277b3b7a30e0b4bb0dac2e2e3f7cb2d", size = 785869, upload-time = "2026-05-09T23:14:58.602Z" }, { url = "https://files.pythonhosted.org/packages/02/67/a31f1760f09c27b251ef39e9beb541f462cf977381d067faa764c2c0e393/regex-2026.5.9-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8abd33fef90b2a9efac5557d6033ca82d1195ed3a15fea5af15ba7b463c6a63b", size = 801427, upload-time = "2026-05-09T23:15:00.642Z" }, { url = "https://files.pythonhosted.org/packages/e3/c4/1a80654597b6bc1e1ea0494824c31200e8a956abe290afae9b19a166a148/regex-2026.5.9-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:31037c82eccb44b7ea2e9e221d7c01429430e989a1f4b91ea5a855f6017b509a", size = 866482, upload-time = "2026-05-09T23:15:03.384Z" }, { url = "https://files.pythonhosted.org/packages/d1/11/960724e06482c08466ff5611e242e86f80062949cdf6b4b9cc317b9dd93d/regex-2026.5.9-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:5604dfd046dc37eca90250fc3be938b076c8059fa772ac0ed6f499b0f0fb0415", size = 773022, upload-time = "2026-05-09T23:15:05.625Z" }, { url = "https://files.pythonhosted.org/packages/50/a8/a9979c3e7918280e93159ebcab5ef1a65116dd4f3bd6091be0eae4a126e8/regex-2026.5.9-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:0e1b1b4e496afbb24f4a62aba855ee4f88f25578927697b340702e48c9ee6bc2", size = 856642, upload-time = "2026-05-09T23:15:07.966Z" }, { url = "https://files.pythonhosted.org/packages/fe/d4/a9b732f2f0072c0ab12227483abb24fffcb9f73f8a2b203df0a6d0434735/regex-2026.5.9-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:be3372b9df6ddecff6486d37e19095a7b4973137caf5512407a89f4455361f41", size = 803552, upload-time = "2026-05-09T23:15:10.215Z" }, { url = "https://files.pythonhosted.org/packages/d5/fe/1b3113817447a1d4155e4ac76d2e072f42c0bcba2f43fa8a0e756ea2cd91/regex-2026.5.9-cp314-cp314t-win32.whl", hash = "sha256:3ddd90103f9e5c471c49c7852ecc1fe27c7e45eb99e977aefe7caa4e779f4f58", size = 275746, upload-time = "2026-05-09T23:15:12.609Z" }, { url = "https://files.pythonhosted.org/packages/92/73/93d42045302636c91f2e5ef588b65b84b01428f28ec77de256b1dfdfbe5c/regex-2026.5.9-cp314-cp314t-win_amd64.whl", hash = "sha256:ca518ed29c46eecba6010b15f1b9a479314d2de409536e71b6a13aa04e3b8a77", size = 285685, upload-time = "2026-05-09T23:15:15.086Z" }, { url = "https://files.pythonhosted.org/packages/da/80/35b4c33c804a165a7f55289afda3ea9e3eb6d15800341a2d66455c0f1f30/regex-2026.5.9-cp314-cp314t-win_arm64.whl", hash = "sha256:5e41809d2683fcde7d5a8c87a6567ba1fb1ce0de9f31bff578de00a4b2d76daa", size = 275713, upload-time = "2026-05-09T23:15:16.98Z" }, ] [[package]] name = "requests" version = "2.34.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "certifi" }, { name = "charset-normalizer" }, { name = "idna" }, { name = "urllib3" }, ] sdist = { url = "https://files.pythonhosted.org/packages/ac/c3/e2a2b89f2d3e2179abd6d00ebd70bff6273f37fb3e0cc209f48b39d00cbf/requests-2.34.2.tar.gz", hash = "sha256:f288924cae4e29463698d6d60bc6a4da69c89185ad1e0bcc4104f584e960b9ed", size = 142856, upload-time = "2026-05-14T19:25:27.735Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/a0/f4/c67b0b3f1b9245e8d266f0f112c500d50e5b4e83cb6f3b71b6528104182a/requests-2.34.2-py3-none-any.whl", hash = "sha256:2a0d60c172f83ac6ab31e4554906c0f3b3588d37b5cb939b1c061f4907e278e0", size = 73075, upload-time = "2026-05-14T19:25:26.443Z" }, ] [[package]] name = "responses" version = "0.26.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "pyyaml" }, { name = "requests" }, { name = "urllib3" }, ] sdist = { url = "https://files.pythonhosted.org/packages/9f/b4/b7e040379838cc71bf5aabdb26998dfbe5ee73904c92c1c161faf5de8866/responses-0.26.0.tar.gz", hash = "sha256:c7f6923e6343ef3682816ba421c006626777893cb0d5e1434f674b649bac9eb4", size = 81303, upload-time = "2026-02-19T14:38:05.574Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/ce/04/7f73d05b556da048923e31a0cc878f03be7c5425ed1f268082255c75d872/responses-0.26.0-py3-none-any.whl", hash = "sha256:03ec4409088cd5c66b71ecbbbd27fe2c58ddfad801c66203457b3e6a04868c37", size = 35099, upload-time = "2026-02-19T14:38:03.847Z" }, ] [[package]] name = "rfc3339-validator" version = "0.1.4" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "six" }, ] sdist = { url = "https://files.pythonhosted.org/packages/28/ea/a9387748e2d111c3c2b275ba970b735e04e15cdb1eb30693b6b5708c4dbd/rfc3339_validator-0.1.4.tar.gz", hash = "sha256:138a2abdf93304ad60530167e51d2dfb9549521a836871b88d7f4695d0022f6b", size = 5513, upload-time = "2021-05-12T16:37:54.178Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/7b/44/4e421b96b67b2daff264473f7465db72fbdf36a07e05494f50300cc7b0c6/rfc3339_validator-0.1.4-py2.py3-none-any.whl", hash = "sha256:24f6ec1eda14ef823da9e36ec7113124b39c04d50a4d3d3a3c2859577e7791fa", size = 3490, upload-time = "2021-05-12T16:37:52.536Z" }, ] [[package]] name = "rich" version = "15.0.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markdown-it-py" }, { name = "pygments" }, ] sdist = { url = "https://files.pythonhosted.org/packages/c0/8f/0722ca900cc807c13a6a0c696dacf35430f72e0ec571c4275d2371fca3e9/rich-15.0.0.tar.gz", hash = "sha256:edd07a4824c6b40189fb7ac9bc4c52536e9780fbbfbddf6f1e2502c31b068c36", size = 230680, upload-time = "2026-04-12T08:24:00.75Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/82/3b/64d4899d73f91ba49a8c18a8ff3f0ea8f1c1d75481760df8c68ef5235bf5/rich-15.0.0-py3-none-any.whl", hash = "sha256:33bd4ef74232fb73fe9279a257718407f169c09b78a87ad3d296f548e27de0bb", size = 310654, upload-time = "2026-04-12T08:24:02.83Z" }, ] [[package]] name = "roman-numerals" version = "4.1.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/ae/f9/41dc953bbeb056c17d5f7a519f50fdf010bd0553be2d630bc69d1e022703/roman_numerals-4.1.0.tar.gz", hash = "sha256:1af8b147eb1405d5839e78aeb93131690495fe9da5c91856cb33ad55a7f1e5b2", size = 9077, upload-time = "2025-12-17T18:25:34.381Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/04/54/6f679c435d28e0a568d8e8a7c0a93a09010818634c3c3907fc98d8983770/roman_numerals-4.1.0-py3-none-any.whl", hash = "sha256:647ba99caddc2cc1e55a51e4360689115551bf4476d90e8162cf8c345fe233c7", size = 7676, upload-time = "2025-12-17T18:25:33.098Z" }, ] [[package]] name = "rpds-py" version = "0.30.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/20/af/3f2f423103f1113b36230496629986e0ef7e199d2aa8392452b484b38ced/rpds_py-0.30.0.tar.gz", hash = "sha256:dd8ff7cf90014af0c0f787eea34794ebf6415242ee1d6fa91eaba725cc441e84", size = 69469, upload-time = "2025-11-30T20:24:38.837Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/03/e7/98a2f4ac921d82f33e03f3835f5bf3a4a40aa1bfdc57975e74a97b2b4bdd/rpds_py-0.30.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:a161f20d9a43006833cd7068375a94d035714d73a172b681d8881820600abfad", size = 375086, upload-time = "2025-11-30T20:22:17.93Z" }, { url = "https://files.pythonhosted.org/packages/4d/a1/bca7fd3d452b272e13335db8d6b0b3ecde0f90ad6f16f3328c6fb150c889/rpds_py-0.30.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6abc8880d9d036ecaafe709079969f56e876fcf107f7a8e9920ba6d5a3878d05", size = 359053, upload-time = "2025-11-30T20:22:19.297Z" }, { url = "https://files.pythonhosted.org/packages/65/1c/ae157e83a6357eceff62ba7e52113e3ec4834a84cfe07fa4b0757a7d105f/rpds_py-0.30.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ca28829ae5f5d569bb62a79512c842a03a12576375d5ece7d2cadf8abe96ec28", size = 390763, upload-time = "2025-11-30T20:22:21.661Z" }, { url = "https://files.pythonhosted.org/packages/d4/36/eb2eb8515e2ad24c0bd43c3ee9cd74c33f7ca6430755ccdb240fd3144c44/rpds_py-0.30.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a1010ed9524c73b94d15919ca4d41d8780980e1765babf85f9a2f90d247153dd", size = 408951, upload-time = "2025-11-30T20:22:23.408Z" }, { url = "https://files.pythonhosted.org/packages/d6/65/ad8dc1784a331fabbd740ef6f71ce2198c7ed0890dab595adb9ea2d775a1/rpds_py-0.30.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f8d1736cfb49381ba528cd5baa46f82fdc65c06e843dab24dd70b63d09121b3f", size = 514622, upload-time = "2025-11-30T20:22:25.16Z" }, { url = "https://files.pythonhosted.org/packages/63/8e/0cfa7ae158e15e143fe03993b5bcd743a59f541f5952e1546b1ac1b5fd45/rpds_py-0.30.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d948b135c4693daff7bc2dcfc4ec57237a29bd37e60c2fabf5aff2bbacf3e2f1", size = 414492, upload-time = "2025-11-30T20:22:26.505Z" }, { url = "https://files.pythonhosted.org/packages/60/1b/6f8f29f3f995c7ffdde46a626ddccd7c63aefc0efae881dc13b6e5d5bb16/rpds_py-0.30.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47f236970bccb2233267d89173d3ad2703cd36a0e2a6e92d0560d333871a3d23", size = 394080, upload-time = "2025-11-30T20:22:27.934Z" }, { url = "https://files.pythonhosted.org/packages/6d/d5/a266341051a7a3ca2f4b750a3aa4abc986378431fc2da508c5034d081b70/rpds_py-0.30.0-cp312-cp312-manylinux_2_31_riscv64.whl", hash = "sha256:2e6ecb5a5bcacf59c3f912155044479af1d0b6681280048b338b28e364aca1f6", size = 408680, upload-time = "2025-11-30T20:22:29.341Z" }, { url = "https://files.pythonhosted.org/packages/10/3b/71b725851df9ab7a7a4e33cf36d241933da66040d195a84781f49c50490c/rpds_py-0.30.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a8fa71a2e078c527c3e9dc9fc5a98c9db40bcc8a92b4e8858e36d329f8684b51", size = 423589, upload-time = "2025-11-30T20:22:31.469Z" }, { url = "https://files.pythonhosted.org/packages/00/2b/e59e58c544dc9bd8bd8384ecdb8ea91f6727f0e37a7131baeff8d6f51661/rpds_py-0.30.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:73c67f2db7bc334e518d097c6d1e6fed021bbc9b7d678d6cc433478365d1d5f5", size = 573289, upload-time = "2025-11-30T20:22:32.997Z" }, { url = "https://files.pythonhosted.org/packages/da/3e/a18e6f5b460893172a7d6a680e86d3b6bc87a54c1f0b03446a3c8c7b588f/rpds_py-0.30.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:5ba103fb455be00f3b1c2076c9d4264bfcb037c976167a6047ed82f23153f02e", size = 599737, upload-time = "2025-11-30T20:22:34.419Z" }, { url = "https://files.pythonhosted.org/packages/5c/e2/714694e4b87b85a18e2c243614974413c60aa107fd815b8cbc42b873d1d7/rpds_py-0.30.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7cee9c752c0364588353e627da8a7e808a66873672bcb5f52890c33fd965b394", size = 563120, upload-time = "2025-11-30T20:22:35.903Z" }, { url = "https://files.pythonhosted.org/packages/6f/ab/d5d5e3bcedb0a77f4f613706b750e50a5a3ba1c15ccd3665ecc636c968fd/rpds_py-0.30.0-cp312-cp312-win32.whl", hash = "sha256:1ab5b83dbcf55acc8b08fc62b796ef672c457b17dbd7820a11d6c52c06839bdf", size = 223782, upload-time = "2025-11-30T20:22:37.271Z" }, { url = "https://files.pythonhosted.org/packages/39/3b/f786af9957306fdc38a74cef405b7b93180f481fb48453a114bb6465744a/rpds_py-0.30.0-cp312-cp312-win_amd64.whl", hash = "sha256:a090322ca841abd453d43456ac34db46e8b05fd9b3b4ac0c78bcde8b089f959b", size = 240463, upload-time = "2025-11-30T20:22:39.021Z" }, { url = "https://files.pythonhosted.org/packages/f3/d2/b91dc748126c1559042cfe41990deb92c4ee3e2b415f6b5234969ffaf0cc/rpds_py-0.30.0-cp312-cp312-win_arm64.whl", hash = "sha256:669b1805bd639dd2989b281be2cfd951c6121b65e729d9b843e9639ef1fd555e", size = 230868, upload-time = "2025-11-30T20:22:40.493Z" }, { url = "https://files.pythonhosted.org/packages/ed/dc/d61221eb88ff410de3c49143407f6f3147acf2538c86f2ab7ce65ae7d5f9/rpds_py-0.30.0-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:f83424d738204d9770830d35290ff3273fbb02b41f919870479fab14b9d303b2", size = 374887, upload-time = "2025-11-30T20:22:41.812Z" }, { url = "https://files.pythonhosted.org/packages/fd/32/55fb50ae104061dbc564ef15cc43c013dc4a9f4527a1f4d99baddf56fe5f/rpds_py-0.30.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:e7536cd91353c5273434b4e003cbda89034d67e7710eab8761fd918ec6c69cf8", size = 358904, upload-time = "2025-11-30T20:22:43.479Z" }, { url = "https://files.pythonhosted.org/packages/58/70/faed8186300e3b9bdd138d0273109784eea2396c68458ed580f885dfe7ad/rpds_py-0.30.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2771c6c15973347f50fece41fc447c054b7ac2ae0502388ce3b6738cd366e3d4", size = 389945, upload-time = "2025-11-30T20:22:44.819Z" }, { url = "https://files.pythonhosted.org/packages/bd/a8/073cac3ed2c6387df38f71296d002ab43496a96b92c823e76f46b8af0543/rpds_py-0.30.0-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:0a59119fc6e3f460315fe9d08149f8102aa322299deaa5cab5b40092345c2136", size = 407783, upload-time = "2025-11-30T20:22:46.103Z" }, { url = "https://files.pythonhosted.org/packages/77/57/5999eb8c58671f1c11eba084115e77a8899d6e694d2a18f69f0ba471ec8b/rpds_py-0.30.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:76fec018282b4ead0364022e3c54b60bf368b9d926877957a8624b58419169b7", size = 515021, upload-time = "2025-11-30T20:22:47.458Z" }, { url = "https://files.pythonhosted.org/packages/e0/af/5ab4833eadc36c0a8ed2bc5c0de0493c04f6c06de223170bd0798ff98ced/rpds_py-0.30.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:692bef75a5525db97318e8cd061542b5a79812d711ea03dbc1f6f8dbb0c5f0d2", size = 414589, upload-time = "2025-11-30T20:22:48.872Z" }, { url = "https://files.pythonhosted.org/packages/b7/de/f7192e12b21b9e9a68a6d0f249b4af3fdcdff8418be0767a627564afa1f1/rpds_py-0.30.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9027da1ce107104c50c81383cae773ef5c24d296dd11c99e2629dbd7967a20c6", size = 394025, upload-time = "2025-11-30T20:22:50.196Z" }, { url = "https://files.pythonhosted.org/packages/91/c4/fc70cd0249496493500e7cc2de87504f5aa6509de1e88623431fec76d4b6/rpds_py-0.30.0-cp313-cp313-manylinux_2_31_riscv64.whl", hash = "sha256:9cf69cdda1f5968a30a359aba2f7f9aa648a9ce4b580d6826437f2b291cfc86e", size = 408895, upload-time = "2025-11-30T20:22:51.87Z" }, { url = "https://files.pythonhosted.org/packages/58/95/d9275b05ab96556fefff73a385813eb66032e4c99f411d0795372d9abcea/rpds_py-0.30.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a4796a717bf12b9da9d3ad002519a86063dcac8988b030e405704ef7d74d2d9d", size = 422799, upload-time = "2025-11-30T20:22:53.341Z" }, { url = "https://files.pythonhosted.org/packages/06/c1/3088fc04b6624eb12a57eb814f0d4997a44b0d208d6cace713033ff1a6ba/rpds_py-0.30.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:5d4c2aa7c50ad4728a094ebd5eb46c452e9cb7edbfdb18f9e1221f597a73e1e7", size = 572731, upload-time = "2025-11-30T20:22:54.778Z" }, { url = "https://files.pythonhosted.org/packages/d8/42/c612a833183b39774e8ac8fecae81263a68b9583ee343db33ab571a7ce55/rpds_py-0.30.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:ba81a9203d07805435eb06f536d95a266c21e5b2dfbf6517748ca40c98d19e31", size = 599027, upload-time = "2025-11-30T20:22:56.212Z" }, { url = "https://files.pythonhosted.org/packages/5f/60/525a50f45b01d70005403ae0e25f43c0384369ad24ffe46e8d9068b50086/rpds_py-0.30.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:945dccface01af02675628334f7cf49c2af4c1c904748efc5cf7bbdf0b579f95", size = 563020, upload-time = "2025-11-30T20:22:58.2Z" }, { url = "https://files.pythonhosted.org/packages/0b/5d/47c4655e9bcd5ca907148535c10e7d489044243cc9941c16ed7cd53be91d/rpds_py-0.30.0-cp313-cp313-win32.whl", hash = "sha256:b40fb160a2db369a194cb27943582b38f79fc4887291417685f3ad693c5a1d5d", size = 223139, upload-time = "2025-11-30T20:23:00.209Z" }, { url = "https://files.pythonhosted.org/packages/f2/e1/485132437d20aa4d3e1d8b3fb5a5e65aa8139f1e097080c2a8443201742c/rpds_py-0.30.0-cp313-cp313-win_amd64.whl", hash = "sha256:806f36b1b605e2d6a72716f321f20036b9489d29c51c91f4dd29a3e3afb73b15", size = 240224, upload-time = "2025-11-30T20:23:02.008Z" }, { url = "https://files.pythonhosted.org/packages/24/95/ffd128ed1146a153d928617b0ef673960130be0009c77d8fbf0abe306713/rpds_py-0.30.0-cp313-cp313-win_arm64.whl", hash = "sha256:d96c2086587c7c30d44f31f42eae4eac89b60dabbac18c7669be3700f13c3ce1", size = 230645, upload-time = "2025-11-30T20:23:03.43Z" }, { url = "https://files.pythonhosted.org/packages/ff/1b/b10de890a0def2a319a2626334a7f0ae388215eb60914dbac8a3bae54435/rpds_py-0.30.0-cp313-cp313t-macosx_10_12_x86_64.whl", hash = "sha256:eb0b93f2e5c2189ee831ee43f156ed34e2a89a78a66b98cadad955972548be5a", size = 364443, upload-time = "2025-11-30T20:23:04.878Z" }, { url = "https://files.pythonhosted.org/packages/0d/bf/27e39f5971dc4f305a4fb9c672ca06f290f7c4e261c568f3dea16a410d47/rpds_py-0.30.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:922e10f31f303c7c920da8981051ff6d8c1a56207dbdf330d9047f6d30b70e5e", size = 353375, upload-time = "2025-11-30T20:23:06.342Z" }, { url = "https://files.pythonhosted.org/packages/40/58/442ada3bba6e8e6615fc00483135c14a7538d2ffac30e2d933ccf6852232/rpds_py-0.30.0-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cdc62c8286ba9bf7f47befdcea13ea0e26bf294bda99758fd90535cbaf408000", size = 383850, upload-time = "2025-11-30T20:23:07.825Z" }, { url = "https://files.pythonhosted.org/packages/14/14/f59b0127409a33c6ef6f5c1ebd5ad8e32d7861c9c7adfa9a624fc3889f6c/rpds_py-0.30.0-cp313-cp313t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:47f9a91efc418b54fb8190a6b4aa7813a23fb79c51f4bb84e418f5476c38b8db", size = 392812, upload-time = "2025-11-30T20:23:09.228Z" }, { url = "https://files.pythonhosted.org/packages/b3/66/e0be3e162ac299b3a22527e8913767d869e6cc75c46bd844aa43fb81ab62/rpds_py-0.30.0-cp313-cp313t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1f3587eb9b17f3789ad50824084fa6f81921bbf9a795826570bda82cb3ed91f2", size = 517841, upload-time = "2025-11-30T20:23:11.186Z" }, { url = "https://files.pythonhosted.org/packages/3d/55/fa3b9cf31d0c963ecf1ba777f7cf4b2a2c976795ac430d24a1f43d25a6ba/rpds_py-0.30.0-cp313-cp313t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:39c02563fc592411c2c61d26b6c5fe1e51eaa44a75aa2c8735ca88b0d9599daa", size = 408149, upload-time = "2025-11-30T20:23:12.864Z" }, { url = "https://files.pythonhosted.org/packages/60/ca/780cf3b1a32b18c0f05c441958d3758f02544f1d613abf9488cd78876378/rpds_py-0.30.0-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:51a1234d8febafdfd33a42d97da7a43f5dcb120c1060e352a3fbc0c6d36e2083", size = 383843, upload-time = "2025-11-30T20:23:14.638Z" }, { url = "https://files.pythonhosted.org/packages/82/86/d5f2e04f2aa6247c613da0c1dd87fcd08fa17107e858193566048a1e2f0a/rpds_py-0.30.0-cp313-cp313t-manylinux_2_31_riscv64.whl", hash = "sha256:eb2c4071ab598733724c08221091e8d80e89064cd472819285a9ab0f24bcedb9", size = 396507, upload-time = "2025-11-30T20:23:16.105Z" }, { url = "https://files.pythonhosted.org/packages/4b/9a/453255d2f769fe44e07ea9785c8347edaf867f7026872e76c1ad9f7bed92/rpds_py-0.30.0-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6bdfdb946967d816e6adf9a3d8201bfad269c67efe6cefd7093ef959683c8de0", size = 414949, upload-time = "2025-11-30T20:23:17.539Z" }, { url = "https://files.pythonhosted.org/packages/a3/31/622a86cdc0c45d6df0e9ccb6becdba5074735e7033c20e401a6d9d0e2ca0/rpds_py-0.30.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:c77afbd5f5250bf27bf516c7c4a016813eb2d3e116139aed0096940c5982da94", size = 565790, upload-time = "2025-11-30T20:23:19.029Z" }, { url = "https://files.pythonhosted.org/packages/1c/5d/15bbf0fb4a3f58a3b1c67855ec1efcc4ceaef4e86644665fff03e1b66d8d/rpds_py-0.30.0-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:61046904275472a76c8c90c9ccee9013d70a6d0f73eecefd38c1ae7c39045a08", size = 590217, upload-time = "2025-11-30T20:23:20.885Z" }, { url = "https://files.pythonhosted.org/packages/6d/61/21b8c41f68e60c8cc3b2e25644f0e3681926020f11d06ab0b78e3c6bbff1/rpds_py-0.30.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:4c5f36a861bc4b7da6516dbdf302c55313afa09b81931e8280361a4f6c9a2d27", size = 555806, upload-time = "2025-11-30T20:23:22.488Z" }, { url = "https://files.pythonhosted.org/packages/f9/39/7e067bb06c31de48de3eb200f9fc7c58982a4d3db44b07e73963e10d3be9/rpds_py-0.30.0-cp313-cp313t-win32.whl", hash = "sha256:3d4a69de7a3e50ffc214ae16d79d8fbb0922972da0356dcf4d0fdca2878559c6", size = 211341, upload-time = "2025-11-30T20:23:24.449Z" }, { url = "https://files.pythonhosted.org/packages/0a/4d/222ef0b46443cf4cf46764d9c630f3fe4abaa7245be9417e56e9f52b8f65/rpds_py-0.30.0-cp313-cp313t-win_amd64.whl", hash = "sha256:f14fc5df50a716f7ece6a80b6c78bb35ea2ca47c499e422aa4463455dd96d56d", size = 225768, upload-time = "2025-11-30T20:23:25.908Z" }, { url = "https://files.pythonhosted.org/packages/86/81/dad16382ebbd3d0e0328776d8fd7ca94220e4fa0798d1dc5e7da48cb3201/rpds_py-0.30.0-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:68f19c879420aa08f61203801423f6cd5ac5f0ac4ac82a2368a9fcd6a9a075e0", size = 362099, upload-time = "2025-11-30T20:23:27.316Z" }, { url = "https://files.pythonhosted.org/packages/2b/60/19f7884db5d5603edf3c6bce35408f45ad3e97e10007df0e17dd57af18f8/rpds_py-0.30.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:ec7c4490c672c1a0389d319b3a9cfcd098dcdc4783991553c332a15acf7249be", size = 353192, upload-time = "2025-11-30T20:23:29.151Z" }, { url = "https://files.pythonhosted.org/packages/bf/c4/76eb0e1e72d1a9c4703c69607cec123c29028bff28ce41588792417098ac/rpds_py-0.30.0-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f251c812357a3fed308d684a5079ddfb9d933860fc6de89f2b7ab00da481e65f", size = 384080, upload-time = "2025-11-30T20:23:30.785Z" }, { url = "https://files.pythonhosted.org/packages/72/87/87ea665e92f3298d1b26d78814721dc39ed8d2c74b86e83348d6b48a6f31/rpds_py-0.30.0-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ac98b175585ecf4c0348fd7b29c3864bda53b805c773cbf7bfdaffc8070c976f", size = 394841, upload-time = "2025-11-30T20:23:32.209Z" }, { url = "https://files.pythonhosted.org/packages/77/ad/7783a89ca0587c15dcbf139b4a8364a872a25f861bdb88ed99f9b0dec985/rpds_py-0.30.0-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3e62880792319dbeb7eb866547f2e35973289e7d5696c6e295476448f5b63c87", size = 516670, upload-time = "2025-11-30T20:23:33.742Z" }, { url = "https://files.pythonhosted.org/packages/5b/3c/2882bdac942bd2172f3da574eab16f309ae10a3925644e969536553cb4ee/rpds_py-0.30.0-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4e7fc54e0900ab35d041b0601431b0a0eb495f0851a0639b6ef90f7741b39a18", size = 408005, upload-time = "2025-11-30T20:23:35.253Z" }, { url = "https://files.pythonhosted.org/packages/ce/81/9a91c0111ce1758c92516a3e44776920b579d9a7c09b2b06b642d4de3f0f/rpds_py-0.30.0-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47e77dc9822d3ad616c3d5759ea5631a75e5809d5a28707744ef79d7a1bcfcad", size = 382112, upload-time = "2025-11-30T20:23:36.842Z" }, { url = "https://files.pythonhosted.org/packages/cf/8e/1da49d4a107027e5fbc64daeab96a0706361a2918da10cb41769244b805d/rpds_py-0.30.0-cp314-cp314-manylinux_2_31_riscv64.whl", hash = "sha256:b4dc1a6ff022ff85ecafef7979a2c6eb423430e05f1165d6688234e62ba99a07", size = 399049, upload-time = "2025-11-30T20:23:38.343Z" }, { url = "https://files.pythonhosted.org/packages/df/5a/7ee239b1aa48a127570ec03becbb29c9d5a9eb092febbd1699d567cae859/rpds_py-0.30.0-cp314-cp314-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:4559c972db3a360808309e06a74628b95eaccbf961c335c8fe0d590cf587456f", size = 415661, upload-time = "2025-11-30T20:23:40.263Z" }, { url = "https://files.pythonhosted.org/packages/70/ea/caa143cf6b772f823bc7929a45da1fa83569ee49b11d18d0ada7f5ee6fd6/rpds_py-0.30.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:0ed177ed9bded28f8deb6ab40c183cd1192aa0de40c12f38be4d59cd33cb5c65", size = 565606, upload-time = "2025-11-30T20:23:42.186Z" }, { url = "https://files.pythonhosted.org/packages/64/91/ac20ba2d69303f961ad8cf55bf7dbdb4763f627291ba3d0d7d67333cced9/rpds_py-0.30.0-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:ad1fa8db769b76ea911cb4e10f049d80bf518c104f15b3edb2371cc65375c46f", size = 591126, upload-time = "2025-11-30T20:23:44.086Z" }, { url = "https://files.pythonhosted.org/packages/21/20/7ff5f3c8b00c8a95f75985128c26ba44503fb35b8e0259d812766ea966c7/rpds_py-0.30.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:46e83c697b1f1c72b50e5ee5adb4353eef7406fb3f2043d64c33f20ad1c2fc53", size = 553371, upload-time = "2025-11-30T20:23:46.004Z" }, { url = "https://files.pythonhosted.org/packages/72/c7/81dadd7b27c8ee391c132a6b192111ca58d866577ce2d9b0ca157552cce0/rpds_py-0.30.0-cp314-cp314-win32.whl", hash = "sha256:ee454b2a007d57363c2dfd5b6ca4a5d7e2c518938f8ed3b706e37e5d470801ed", size = 215298, upload-time = "2025-11-30T20:23:47.696Z" }, { url = "https://files.pythonhosted.org/packages/3e/d2/1aaac33287e8cfb07aab2e6b8ac1deca62f6f65411344f1433c55e6f3eb8/rpds_py-0.30.0-cp314-cp314-win_amd64.whl", hash = "sha256:95f0802447ac2d10bcc69f6dc28fe95fdf17940367b21d34e34c737870758950", size = 228604, upload-time = "2025-11-30T20:23:49.501Z" }, { url = "https://files.pythonhosted.org/packages/e8/95/ab005315818cc519ad074cb7784dae60d939163108bd2b394e60dc7b5461/rpds_py-0.30.0-cp314-cp314-win_arm64.whl", hash = "sha256:613aa4771c99f03346e54c3f038e4cc574ac09a3ddfb0e8878487335e96dead6", size = 222391, upload-time = "2025-11-30T20:23:50.96Z" }, { url = "https://files.pythonhosted.org/packages/9e/68/154fe0194d83b973cdedcdcc88947a2752411165930182ae41d983dcefa6/rpds_py-0.30.0-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:7e6ecfcb62edfd632e56983964e6884851786443739dbfe3582947e87274f7cb", size = 364868, upload-time = "2025-11-30T20:23:52.494Z" }, { url = "https://files.pythonhosted.org/packages/83/69/8bbc8b07ec854d92a8b75668c24d2abcb1719ebf890f5604c61c9369a16f/rpds_py-0.30.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:a1d0bc22a7cdc173fedebb73ef81e07faef93692b8c1ad3733b67e31e1b6e1b8", size = 353747, upload-time = "2025-11-30T20:23:54.036Z" }, { url = "https://files.pythonhosted.org/packages/ab/00/ba2e50183dbd9abcce9497fa5149c62b4ff3e22d338a30d690f9af970561/rpds_py-0.30.0-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0d08f00679177226c4cb8c5265012eea897c8ca3b93f429e546600c971bcbae7", size = 383795, upload-time = "2025-11-30T20:23:55.556Z" }, { url = "https://files.pythonhosted.org/packages/05/6f/86f0272b84926bcb0e4c972262f54223e8ecc556b3224d281e6598fc9268/rpds_py-0.30.0-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5965af57d5848192c13534f90f9dd16464f3c37aaf166cc1da1cae1fd5a34898", size = 393330, upload-time = "2025-11-30T20:23:57.033Z" }, { url = "https://files.pythonhosted.org/packages/cb/e9/0e02bb2e6dc63d212641da45df2b0bf29699d01715913e0d0f017ee29438/rpds_py-0.30.0-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9a4e86e34e9ab6b667c27f3211ca48f73dba7cd3d90f8d5b11be56e5dbc3fb4e", size = 518194, upload-time = "2025-11-30T20:23:58.637Z" }, { url = "https://files.pythonhosted.org/packages/ee/ca/be7bca14cf21513bdf9c0606aba17d1f389ea2b6987035eb4f62bd923f25/rpds_py-0.30.0-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e5d3e6b26f2c785d65cc25ef1e5267ccbe1b069c5c21b8cc724efee290554419", size = 408340, upload-time = "2025-11-30T20:24:00.2Z" }, { url = "https://files.pythonhosted.org/packages/c2/c7/736e00ebf39ed81d75544c0da6ef7b0998f8201b369acf842f9a90dc8fce/rpds_py-0.30.0-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:626a7433c34566535b6e56a1b39a7b17ba961e97ce3b80ec62e6f1312c025551", size = 383765, upload-time = "2025-11-30T20:24:01.759Z" }, { url = "https://files.pythonhosted.org/packages/4a/3f/da50dfde9956aaf365c4adc9533b100008ed31aea635f2b8d7b627e25b49/rpds_py-0.30.0-cp314-cp314t-manylinux_2_31_riscv64.whl", hash = "sha256:acd7eb3f4471577b9b5a41baf02a978e8bdeb08b4b355273994f8b87032000a8", size = 396834, upload-time = "2025-11-30T20:24:03.687Z" }, { url = "https://files.pythonhosted.org/packages/4e/00/34bcc2565b6020eab2623349efbdec810676ad571995911f1abdae62a3a0/rpds_py-0.30.0-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:fe5fa731a1fa8a0a56b0977413f8cacac1768dad38d16b3a296712709476fbd5", size = 415470, upload-time = "2025-11-30T20:24:05.232Z" }, { url = "https://files.pythonhosted.org/packages/8c/28/882e72b5b3e6f718d5453bd4d0d9cf8df36fddeb4ddbbab17869d5868616/rpds_py-0.30.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:74a3243a411126362712ee1524dfc90c650a503502f135d54d1b352bd01f2404", size = 565630, upload-time = "2025-11-30T20:24:06.878Z" }, { url = "https://files.pythonhosted.org/packages/3b/97/04a65539c17692de5b85c6e293520fd01317fd878ea1995f0367d4532fb1/rpds_py-0.30.0-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:3e8eeb0544f2eb0d2581774be4c3410356eba189529a6b3e36bbbf9696175856", size = 591148, upload-time = "2025-11-30T20:24:08.445Z" }, { url = "https://files.pythonhosted.org/packages/85/70/92482ccffb96f5441aab93e26c4d66489eb599efdcf96fad90c14bbfb976/rpds_py-0.30.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:dbd936cde57abfee19ab3213cf9c26be06d60750e60a8e4dd85d1ab12c8b1f40", size = 556030, upload-time = "2025-11-30T20:24:10.956Z" }, { url = "https://files.pythonhosted.org/packages/20/53/7c7e784abfa500a2b6b583b147ee4bb5a2b3747a9166bab52fec4b5b5e7d/rpds_py-0.30.0-cp314-cp314t-win32.whl", hash = "sha256:dc824125c72246d924f7f796b4f63c1e9dc810c7d9e2355864b3c3a73d59ade0", size = 211570, upload-time = "2025-11-30T20:24:12.735Z" }, { url = "https://files.pythonhosted.org/packages/d0/02/fa464cdfbe6b26e0600b62c528b72d8608f5cc49f96b8d6e38c95d60c676/rpds_py-0.30.0-cp314-cp314t-win_amd64.whl", hash = "sha256:27f4b0e92de5bfbc6f86e43959e6edd1425c33b5e69aab0984a72047f2bcf1e3", size = 226532, upload-time = "2025-11-30T20:24:14.634Z" }, ] [[package]] name = "ruff" version = "0.15.22" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/3a/06/ae069393fc66e8ff33036d4b368003833bf6e88ccf182e17e7a2f1c754fd/ruff-0.15.22.tar.gz", hash = "sha256:3f15175b1fb580126f58285a5dae6b2ea89000136d980c64499211f116b54809", size = 4785063, upload-time = "2026-07-16T15:14:13.244Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/23/18/ee54b7ae1e121be7a28ea6da4b67564ebb0530e183a54415ab7e3bcd2c4e/ruff-0.15.22-py3-none-linux_armv6l.whl", hash = "sha256:44423e73493737f5e7c5b41d475483898ff37afcdae38bc3da5085e29af1c2d8", size = 10781258, upload-time = "2026-07-16T15:13:19.452Z" }, { url = "https://files.pythonhosted.org/packages/2f/d2/2520cb14761ddbeaf57642a76942fc36adcbdbe53b4532241995f6fc485c/ruff-0.15.22-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:b82c6482946e9eda7ff2e091d25b8bad3f718684e1916d41bd56873cee05b697", size = 10999477, upload-time = "2026-07-16T15:13:23.318Z" }, { url = "https://files.pythonhosted.org/packages/c9/10/74e53572aa758dfaa678c2a2646b5c5515d884b7ca56be4d2ce03ca4b560/ruff-0.15.22-py3-none-macosx_11_0_arm64.whl", hash = "sha256:11c1c715af53a09f714e011106bffc419751ec8232fcb5da42173284ea3fec6f", size = 10466716, upload-time = "2026-07-16T15:13:26.162Z" }, { url = "https://files.pythonhosted.org/packages/1e/cc/44eaaf0844e028182f2d0a8f2190d0f359159aed0a9e5ab861d892f1ae2a/ruff-0.15.22-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:742a29cf29bddb7c8327895d6a10e0e6c5b38a96dd407af9b5d0857f809c0576", size = 10892644, upload-time = "2026-07-16T15:13:29.229Z" }, { url = "https://files.pythonhosted.org/packages/9f/21/8edf559014d2b0f82beea19cfb713993ad802ccda16868769979c6090a84/ruff-0.15.22-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:72af58b951b0ae395935ae79763dc349bc0eb706319d28f7a33ad2cfb3cfc178", size = 10576719, upload-time = "2026-07-16T15:13:32.35Z" }, { url = "https://files.pythonhosted.org/packages/bf/1e/3a13abd392a3b50b62e5938a831f9ab6e588358cacad5c18545b716d2182/ruff-0.15.22-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:62d425005c1835eb24e2ee4161cb90e8db263415f4a71c8c72c33abaa6c0c224", size = 11376494, upload-time = "2026-07-16T15:13:35.958Z" }, { url = "https://files.pythonhosted.org/packages/bf/3e/422d3d95bcf04dd78e1aeac22184d4f9a8fb2c01865d39d44618484a0317/ruff-0.15.22-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e8b9b3f8779a4f08c969defc3c8c35abffaa757e601ed5ae66d6d1db6519969a", size = 12208370, upload-time = "2026-07-16T15:13:39.185Z" }, { url = "https://files.pythonhosted.org/packages/1e/91/5d065a0e0a02bf4813f5119ad278462eed081d2b832eb7c021ade0ec9e65/ruff-0.15.22-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1e0dd1b2e4d3d585f897a0d137cbf4eaf6223bef4e8ce34d6bb12556c5f9249e", size = 11581098, upload-time = "2026-07-16T15:13:42.132Z" }, { url = "https://files.pythonhosted.org/packages/f6/f9/a0d4871d12fae702eb1f41b686caf05f1f8b124dc6db6f784f53d74918fa/ruff-0.15.22-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:365523eb91d9224e1bcb03b022fbf0facb8f9e23792a2c53d9d4b3924bdbdebb", size = 11399422, upload-time = "2026-07-16T15:13:45.2Z" }, { url = "https://files.pythonhosted.org/packages/18/80/c843a5176cddbceb0b7e8dd41cf9993490796c1c469348d384f5a5c13c56/ruff-0.15.22-py3-none-manylinux_2_31_riscv64.whl", hash = "sha256:fabfd168afdf29fee5be98b831efa9683c94d7c5a3b58b9ce5a2e38444589a74", size = 11381683, upload-time = "2026-07-16T15:13:48.46Z" }, { url = "https://files.pythonhosted.org/packages/d4/00/8485de0ae92239438a36cfc51350db9b9e85c9ebdfaea91b18e422706662/ruff-0.15.22-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:225dbf095a87f1d9f90f5fd7924d2613ee452a75a4308c63a8f50f761787aa7c", size = 10850295, upload-time = "2026-07-16T15:13:51.655Z" }, { url = "https://files.pythonhosted.org/packages/fa/91/24977ec2ec72eaf15e4394ace2959fdff2dd1e14f03e005e838023407169/ruff-0.15.22-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:1877d63b9d24ed278744f1523fd11b85540566d54641f97c566d7d9dc5ca5296", size = 10579640, upload-time = "2026-07-16T15:13:54.79Z" }, { url = "https://files.pythonhosted.org/packages/9c/47/9b51216951974df1f263ac19da550d34252e0ed7218c25f10c5ef9ed7517/ruff-0.15.22-py3-none-musllinux_1_2_i686.whl", hash = "sha256:a1606c510bd7215680d32efab38965f7cdec3ef69f5170a3f4791404ffdd5262", size = 11105077, upload-time = "2026-07-16T15:13:57.915Z" }, { url = "https://files.pythonhosted.org/packages/c2/47/20e9d4a3b8016778acea5fc32bb50d35d207500a17ddb529ffa6996feef8/ruff-0.15.22-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:630479b18625f5ffc373f77603a22a9f8ac0acd7ff0501178b5db28ec71e9c64", size = 11490980, upload-time = "2026-07-16T15:14:01.032Z" }, { url = "https://files.pythonhosted.org/packages/4d/76/3f72d8fc38c1cb77b38c56a70da9d0c17700cc1cc50f9649c9d3c8f5ba71/ruff-0.15.22-py3-none-win32.whl", hash = "sha256:e5ba0e4a13fd14abbed2a77b517a3911290c6c6c59ef67784328d1668fab76cf", size = 10789165, upload-time = "2026-07-16T15:14:04.16Z" }, { url = "https://files.pythonhosted.org/packages/cb/46/4965251734c2b6fcdca1b1b187d20bcac3af0ee5b083b89c910bb961ce3a/ruff-0.15.22-py3-none-win_amd64.whl", hash = "sha256:9be63ba1eb936acd2d1342fb8337c356353706fce233b2a15a09a97037e6acde", size = 11938297, upload-time = "2026-07-16T15:14:07.316Z" }, { url = "https://files.pythonhosted.org/packages/57/c9/e69b1ff4c8b69093ef08b8919ab767af0569666865b39c30a8795d88d3c6/ruff-0.15.22-py3-none-win_arm64.whl", hash = "sha256:e1168075b72158510839f250027659cdd78476f40507dd517892304c41318661", size = 11298172, upload-time = "2026-07-16T15:14:10.51Z" }, ] [[package]] name = "s3fs" version = "2026.6.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "aiobotocore" }, { name = "aiohttp" }, { name = "fsspec" }, ] sdist = { url = "https://files.pythonhosted.org/packages/99/00/6677343dc919d6c072bb04d80210afdd22c16838a8d16b3315c122dc728f/s3fs-2026.6.0.tar.gz", hash = "sha256:b28de7082d0a4f72392884bdc497e34a4a1582f675d214c7da0acf6e950a0083", size = 87358, upload-time = "2026-06-16T02:05:48.719Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/a5/0b/f68a968b49876eae0f2a515387093cebb2eb9451380a96741cc20efac0d0/s3fs-2026.6.0-py3-none-any.whl", hash = "sha256:60576e31bb31193c1f643f32b4c6439548720ea6918ac702e21cd757c80b5db8", size = 32573, upload-time = "2026-06-16T02:05:47.608Z" }, ] [[package]] name = "s3transfer" version = "0.17.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "botocore" }, ] sdist = { url = "https://files.pythonhosted.org/packages/9b/ec/7c692cde9125b77e84b307354d4fb705f98b8ccad59a036d5957ca75bfc3/s3transfer-0.17.0.tar.gz", hash = "sha256:9edeb6d1c3c2f89d6050348548834ad8289610d886e5bf7b7207728bd43ce33a", size = 155337, upload-time = "2026-04-29T22:07:36.33Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/87/72/c6c32d2b657fa3dad1de340254e14390b1e334ce38268b7ad51abda3c8c2/s3transfer-0.17.0-py3-none-any.whl", hash = "sha256:ce3801712acf4ad3e89fb9990df97b4972e93f4b3b0004d214be5bce12814c20", size = 86811, upload-time = "2026-04-29T22:07:34.966Z" }, ] [[package]] name = "setuptools" version = "83.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/34/26/f5d29e25ffdb535afef2d35cdb55b325298f96debd670da4c325e08d70f4/setuptools-83.0.0.tar.gz", hash = "sha256:025bccbbf0fa05b6192bc64ae1e7b16e001fd6d6d4d5de03c97b1c1ade523bef", size = 1154254, upload-time = "2026-07-04T15:31:22.699Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5d/40/e1e72872c6354b306daef1703549e8e83b4d43cfea356311bf722a043752/setuptools-83.0.0-py3-none-any.whl", hash = "sha256:29b23c360f22f414dc7336bb39178cc7bcbf6021ed2733cde173f09dba19abb3", size = 1008090, upload-time = "2026-07-04T15:31:20.885Z" }, ] [[package]] name = "shellingham" version = "1.5.4" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/58/15/8b3609fd3830ef7b27b655beb4b4e9c62313a4e8da8c676e142cc210d58e/shellingham-1.5.4.tar.gz", hash = "sha256:8dbca0739d487e5bd35ab3ca4b36e11c4078f3a234bfce294b0a0291363404de", size = 10310, upload-time = "2023-10-24T04:13:40.426Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e0/f9/0595336914c5619e5f28a1fb793285925a8cd4b432c9da0a987836c7f822/shellingham-1.5.4-py2.py3-none-any.whl", hash = "sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686", size = 9755, upload-time = "2023-10-24T04:13:38.866Z" }, ] [[package]] name = "six" version = "1.17.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/94/e7/b2c673351809dca68a0e064b6af791aa332cf192da575fd474ed7d6f16a2/six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81", size = 34031, upload-time = "2024-12-04T17:35:28.174Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050, upload-time = "2024-12-04T17:35:26.475Z" }, ] [[package]] name = "snowballstemmer" version = "3.0.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/75/a7/9810d872919697c9d01295633f5d574fb416d47e535f258272ca1f01f447/snowballstemmer-3.0.1.tar.gz", hash = "sha256:6d5eeeec8e9f84d4d56b847692bacf79bc2c8e90c7f80ca4444ff8b6f2e52895", size = 105575, upload-time = "2025-05-09T16:34:51.843Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c8/78/3565d011c61f5a43488987ee32b6f3f656e7f107ac2782dd57bdd7d91d9a/snowballstemmer-3.0.1-py3-none-any.whl", hash = "sha256:6cd7b3897da8d6c9ffb968a6781fa6532dce9c3618a4b127d920dab764a19064", size = 103274, upload-time = "2025-05-09T16:34:50.371Z" }, ] [[package]] name = "sortedcontainers" version = "2.4.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/e8/c4/ba2f8066cceb6f23394729afe52f3bf7adec04bf9ed2c820b39e19299111/sortedcontainers-2.4.0.tar.gz", hash = "sha256:25caa5a06cc30b6b83d11423433f65d1f9d76c4c6a0c90e3379eaa43b9bfdb88", size = 30594, upload-time = "2021-05-16T22:03:42.897Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/32/46/9cb0e58b2deb7f82b84065f37f3bffeb12413f947f9388e4cac22c4621ce/sortedcontainers-2.4.0-py2.py3-none-any.whl", hash = "sha256:a163dcaede0f1c021485e957a39245190e74249897e2ae4b2aa38595db237ee0", size = 29575, upload-time = "2021-05-16T22:03:41.177Z" }, ] [[package]] name = "sphinx" version = "9.1.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "alabaster" }, { name = "babel" }, { name = "colorama", marker = "sys_platform == 'win32'" }, { name = "docutils" }, { name = "imagesize" }, { name = "jinja2" }, { name = "packaging" }, { name = "pygments" }, { name = "requests" }, { name = "roman-numerals" }, { name = "snowballstemmer" }, { name = "sphinxcontrib-applehelp" }, { name = "sphinxcontrib-devhelp" }, { name = "sphinxcontrib-htmlhelp" }, { name = "sphinxcontrib-jsmath" }, { name = "sphinxcontrib-qthelp" }, { name = "sphinxcontrib-serializinghtml" }, ] sdist = { url = "https://files.pythonhosted.org/packages/cd/bd/f08eb0f4eed5c83f1ba2a3bd18f7745a2b1525fad70660a1c00224ec468a/sphinx-9.1.0.tar.gz", hash = "sha256:7741722357dd75f8190766926071fed3bdc211c74dd2d7d4df5404da95930ddb", size = 8718324, upload-time = "2025-12-31T15:09:27.646Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/73/f7/b1884cb3188ab181fc81fa00c266699dab600f927a964df02ec3d5d1916a/sphinx-9.1.0-py3-none-any.whl", hash = "sha256:c84fdd4e782504495fe4f2c0b3413d6c2bf388589bb352d439b2a3bb99991978", size = 3921742, upload-time = "2025-12-31T15:09:25.561Z" }, ] [[package]] name = "sphinxcontrib-applehelp" version = "2.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/ba/6e/b837e84a1a704953c62ef8776d45c3e8d759876b4a84fe14eba2859106fe/sphinxcontrib_applehelp-2.0.0.tar.gz", hash = "sha256:2f29ef331735ce958efa4734873f084941970894c6090408b079c61b2e1c06d1", size = 20053, upload-time = "2024-07-29T01:09:00.465Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/5d/85/9ebeae2f76e9e77b952f4b274c27238156eae7979c5421fba91a28f4970d/sphinxcontrib_applehelp-2.0.0-py3-none-any.whl", hash = "sha256:4cd3f0ec4ac5dd9c17ec65e9ab272c9b867ea77425228e68ecf08d6b28ddbdb5", size = 119300, upload-time = "2024-07-29T01:08:58.99Z" }, ] [[package]] name = "sphinxcontrib-devhelp" version = "2.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/f6/d2/5beee64d3e4e747f316bae86b55943f51e82bb86ecd325883ef65741e7da/sphinxcontrib_devhelp-2.0.0.tar.gz", hash = "sha256:411f5d96d445d1d73bb5d52133377b4248ec79db5c793ce7dbe59e074b4dd1ad", size = 12967, upload-time = "2024-07-29T01:09:23.417Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/35/7a/987e583882f985fe4d7323774889ec58049171828b58c2217e7f79cdf44e/sphinxcontrib_devhelp-2.0.0-py3-none-any.whl", hash = "sha256:aefb8b83854e4b0998877524d1029fd3e6879210422ee3780459e28a1f03a8a2", size = 82530, upload-time = "2024-07-29T01:09:21.945Z" }, ] [[package]] name = "sphinxcontrib-htmlhelp" version = "2.1.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/43/93/983afd9aa001e5201eab16b5a444ed5b9b0a7a010541e0ddfbbfd0b2470c/sphinxcontrib_htmlhelp-2.1.0.tar.gz", hash = "sha256:c9e2916ace8aad64cc13a0d233ee22317f2b9025b9cf3295249fa985cc7082e9", size = 22617, upload-time = "2024-07-29T01:09:37.889Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/0a/7b/18a8c0bcec9182c05a0b3ec2a776bba4ead82750a55ff798e8d406dae604/sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl", hash = "sha256:166759820b47002d22914d64a075ce08f4c46818e17cfc9470a9786b759b19f8", size = 98705, upload-time = "2024-07-29T01:09:36.407Z" }, ] [[package]] name = "sphinxcontrib-jsmath" version = "1.0.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/b2/e8/9ed3830aeed71f17c026a07a5097edcf44b692850ef215b161b8ad875729/sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8", size = 5787, upload-time = "2019-01-21T16:10:16.347Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/c2/42/4c8646762ee83602e3fb3fbe774c2fac12f317deb0b5dbeeedd2d3ba4b77/sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178", size = 5071, upload-time = "2019-01-21T16:10:14.333Z" }, ] [[package]] name = "sphinxcontrib-qthelp" version = "2.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/68/bc/9104308fc285eb3e0b31b67688235db556cd5b0ef31d96f30e45f2e51cae/sphinxcontrib_qthelp-2.0.0.tar.gz", hash = "sha256:4fe7d0ac8fc171045be623aba3e2a8f613f8682731f9153bb2e40ece16b9bbab", size = 17165, upload-time = "2024-07-29T01:09:56.435Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/27/83/859ecdd180cacc13b1f7e857abf8582a64552ea7a061057a6c716e790fce/sphinxcontrib_qthelp-2.0.0-py3-none-any.whl", hash = "sha256:b18a828cdba941ccd6ee8445dbe72ffa3ef8cbe7505d8cd1fa0d42d3f2d5f3eb", size = 88743, upload-time = "2024-07-29T01:09:54.885Z" }, ] [[package]] name = "sphinxcontrib-serializinghtml" version = "2.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/3b/44/6716b257b0aa6bfd51a1b31665d1c205fb12cb5ad56de752dfa15657de2f/sphinxcontrib_serializinghtml-2.0.0.tar.gz", hash = "sha256:e9d912827f872c029017a53f0ef2180b327c3f7fd23c87229f7a8e8b70031d4d", size = 16080, upload-time = "2024-07-29T01:10:09.332Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/52/a7/d2782e4e3f77c8450f727ba74a8f12756d5ba823d81b941f1b04da9d033a/sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl", hash = "sha256:6e2cb0eef194e10c27ec0023bfeb25badbbb5868244cf5bc5bdc04e4464bf331", size = 92072, upload-time = "2024-07-29T01:10:08.203Z" }, ] [[package]] name = "sympy" version = "1.14.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "mpmath" }, ] sdist = { url = "https://files.pythonhosted.org/packages/83/d3/803453b36afefb7c2bb238361cd4ae6125a569b4db67cd9e79846ba2d68c/sympy-1.14.0.tar.gz", hash = "sha256:d3d3fe8df1e5a0b42f0e7bdf50541697dbe7d23746e894990c030e2b05e72517", size = 7793921, upload-time = "2025-04-27T18:05:01.611Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/a2/09/77d55d46fd61b4a135c444fc97158ef34a095e5681d0a6c10b75bf356191/sympy-1.14.0-py3-none-any.whl", hash = "sha256:e091cc3e99d2141a0ba2847328f5479b05d94a6635cb96148ccb3f34671bd8f5", size = 6299353, upload-time = "2025-04-27T18:04:59.103Z" }, ] [[package]] name = "tinycss2" version = "1.4.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "webencodings" }, ] sdist = { url = "https://files.pythonhosted.org/packages/7a/fd/7a5ee21fd08ff70d3d33a5781c255cbe779659bd03278feb98b19ee550f4/tinycss2-1.4.0.tar.gz", hash = "sha256:10c0972f6fc0fbee87c3edb76549357415e94548c1ae10ebccdea16fb404a9b7", size = 87085, upload-time = "2024-10-24T14:58:29.895Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e6/34/ebdc18bae6aa14fbee1a08b63c015c72b64868ff7dae68808ab500c492e2/tinycss2-1.4.0-py3-none-any.whl", hash = "sha256:3a49cf47b7675da0b15d0c6e1df8df4ebd96e9394bb905a5775adb0d884c5289", size = 26610, upload-time = "2024-10-24T14:58:28.029Z" }, ] [[package]] name = "tomlkit" version = "0.15.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/94/96/e07752635b98536177fa1f37671c8f3cdde2e724c6bcf6034b2cfb571565/tomlkit-0.15.1.tar.gz", hash = "sha256:e25bbf38843005246210a12982776f27f99cb9be67160e14434d0c0d21ee1e97", size = 180129, upload-time = "2026-07-17T01:48:04.562Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/13/bc/8c13eb66537dce1d2bd3a57132902f38d0e7f5bb46fa9f4daed9fe9d76ee/tomlkit-0.15.1-py3-none-any.whl", hash = "sha256:177a05aece5a8ca5266fd3c448abb47b8d352f09d477d3ca8332db4d89b24304", size = 49449, upload-time = "2026-07-17T01:48:05.728Z" }, ] [[package]] name = "towncrier" version = "25.8.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "click" }, { name = "jinja2" }, ] sdist = { url = "https://files.pythonhosted.org/packages/c2/eb/5bf25a34123698d3bbab39c5bc5375f8f8bcbcc5a136964ade66935b8b9d/towncrier-25.8.0.tar.gz", hash = "sha256:eef16d29f831ad57abb3ae32a0565739866219f1ebfbdd297d32894eb9940eb1", size = 76322, upload-time = "2025-08-30T11:41:55.393Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/42/06/8ba22ec32c74ac1be3baa26116e3c28bc0e76a5387476921d20b6fdade11/towncrier-25.8.0-py3-none-any.whl", hash = "sha256:b953d133d98f9aeae9084b56a3563fd2519dfc6ec33f61c9cd2c61ff243fb513", size = 65101, upload-time = "2025-08-30T11:41:53.644Z" }, ] [[package]] name = "typer" version = "0.27.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "annotated-doc" }, { name = "colorama", marker = "sys_platform == 'win32'" }, { name = "rich" }, { name = "shellingham" }, ] sdist = { url = "https://files.pythonhosted.org/packages/37/78/fda3361b56efc27944f24225f6ecd13d96d6fcfe37bd0eb34e2f4c63f9fc/typer-0.27.0.tar.gz", hash = "sha256:629bd12ea5d13a17148125d9a264f949eb171fb3f120f9b04d85873cab054fa5", size = 203430, upload-time = "2026-07-15T19:21:07.007Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/40/03/26a383c9e58c213199d1aad1c3d353cfc22d4444ec6d2c0bf8ad02523843/typer-0.27.0-py3-none-any.whl", hash = "sha256:6f4b27631e47f077871b7dc30e933ec0131c1390fbe0e387ea5574b5bac9ccf1", size = 122716, upload-time = "2026-07-15T19:21:05.553Z" }, ] [[package]] name = "typing-extensions" version = "4.16.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/f6/cc/6253133b5bb138fc3306cebfbda2c520f545d36b5be2c7255cc528bb45d6/typing_extensions-4.16.0.tar.gz", hash = "sha256:dc983d19a509c94dba722ee6abd33940f7c05a89e243c47e907eb4db6f1a43e5", size = 113555, upload-time = "2026-07-02T08:40:05.92Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/49/d3/b8441a820a491ddfc024b0b0cf0393375b75ea13866d9c66727e54c2fc80/typing_extensions-4.16.0-py3-none-any.whl", hash = "sha256:481caa481374e813c1b176ada14e97f1f67a4539ce9cfeb3f350d78d6370c2e8", size = 45571, upload-time = "2026-07-02T08:40:04.659Z" }, ] [[package]] name = "typing-inspection" version = "0.4.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/55/e3/70399cb7dd41c10ac53367ae42139cf4b1ca5f36bb3dc6c9d33acdb43655/typing_inspection-0.4.2.tar.gz", hash = "sha256:ba561c48a67c5958007083d386c3295464928b01faa735ab8547c5692e87f464", size = 75949, upload-time = "2025-10-01T02:14:41.687Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/dc/9b/47798a6c91d8bdb567fe2698fe81e0c6b7cb7ef4d13da4114b41d239f65d/typing_inspection-0.4.2-py3-none-any.whl", hash = "sha256:4ed1cacbdc298c220f1bd249ed5287caa16f34d44ef4e9c3d0cbad5b521545e7", size = 14611, upload-time = "2025-10-01T02:14:40.154Z" }, ] [[package]] name = "universal-pathlib" version = "0.3.10" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "fsspec" }, { name = "pathlib-abc" }, ] sdist = { url = "https://files.pythonhosted.org/packages/3d/6e/d997a70ee8f4c61f9a7e2f4f8af721cf072a3326848fc881b05187e52558/universal_pathlib-0.3.10.tar.gz", hash = "sha256:4487cbc90730a48cfb64f811d99e14b6faed6d738420cd5f93f59f48e6930bfb", size = 261110, upload-time = "2026-02-22T14:40:58.87Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/dd/1a/5d9a402b39ec892d856bbdd9db502ff73ce28cdf4aff72eb1ce1d6843506/universal_pathlib-0.3.10-py3-none-any.whl", hash = "sha256:dfaf2fb35683d2eb1287a3ed7b215e4d6016aa6eaf339c607023d22f90821c66", size = 83528, upload-time = "2026-02-22T14:40:57.316Z" }, ] [[package]] name = "urllib3" version = "2.7.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/53/0c/06f8b233b8fd13b9e5ee11424ef85419ba0d8ba0b3138bf360be2ff56953/urllib3-2.7.0.tar.gz", hash = "sha256:231e0ec3b63ceb14667c67be60f2f2c40a518cb38b03af60abc813da26505f4c", size = 433602, upload-time = "2026-05-07T16:13:18.596Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/7f/3e/5db95bcf282c52709639744ca2a8b149baccf648e39c8cc87553df9eae0c/urllib3-2.7.0-py3-none-any.whl", hash = "sha256:9fb4c81ebbb1ce9531cce37674bbc6f1360472bc18ca9a553ede278ef7276897", size = 131087, upload-time = "2026-05-07T16:13:17.151Z" }, ] [[package]] name = "uv" version = "0.11.31" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/21/f0/501fe8a234ac96ea8869e84cb47b3bd77e39a0e80ee01950713e24fe1c4a/uv-0.11.31.tar.gz", hash = "sha256:763609d59721af5b8522e16deac6cffe8055f82bb837740c708917506f305185", size = 6045932, upload-time = "2026-07-22T01:48:45.407Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/e7/6a/065e1e7feaf375eee8d1bb05e5276185708149dd48c27a230f320a0fc8bf/uv-0.11.31-py3-none-linux_armv6l.whl", hash = "sha256:6adaaf151f53fef04dec685f0816d304c09a091b2b609746f86ee7c55ada6bcd", size = 25838313, upload-time = "2026-07-22T01:47:21.787Z" }, { url = "https://files.pythonhosted.org/packages/e1/15/529b573723a36badbda1e13a432c3b21a7554b8ddef3b20a2200037051c2/uv-0.11.31-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:2d84b6dd6b1eaf42fc923203d21a5efd052e1982e4f961eccecc2a6905ffbecd", size = 24795386, upload-time = "2026-07-22T01:47:26.882Z" }, { url = "https://files.pythonhosted.org/packages/52/be/a809b3fe20c3d37bc667de33f38475c4c94f860979d07049ccddb6d91801/uv-0.11.31-py3-none-macosx_11_0_arm64.whl", hash = "sha256:335f3262c4350c004cf6e3b7061200148d670e579bcee7ba0e31c7535f125018", size = 23410594, upload-time = "2026-07-22T01:47:31.43Z" }, { url = "https://files.pythonhosted.org/packages/c9/9a/ebaacd8b7713fd755d23623e0e8de78dfd001f6abc818034f2e9058035c7/uv-0.11.31-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl", hash = "sha256:e1cf5803c39221387b2fe8be2b522b0529ac732831a2e52a92330e053539995e", size = 25358933, upload-time = "2026-07-22T01:47:36.544Z" }, { url = "https://files.pythonhosted.org/packages/81/34/c30568a0f9e556be766c341106bf6ca2ef5c8067be6c11665a53df0549f1/uv-0.11.31-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_1_armv7l.whl", hash = "sha256:68ae6974ffbd04703e138654e83220a16e7b0b679271a8f209f928928dd399f8", size = 25346175, upload-time = "2026-07-22T01:47:41.132Z" }, { url = "https://files.pythonhosted.org/packages/b5/63/18467b66f578dc121ec6d4af78074a0db06b27627b072fc433226a99a384/uv-0.11.31-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:48f7ec906eaebf9717a01ba0f7635cd0cac648ff5c8fff3a57b8805e6bd49078", size = 25381240, upload-time = "2026-07-22T01:47:45.659Z" }, { url = "https://files.pythonhosted.org/packages/b8/43/b51d6b8ad1307f51dd75154d623d6a527c6de600086bb0446251047d2e5e/uv-0.11.31-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5a2cfd1638420f9a2a7dbca71c808edaf3929b6d8f4ec2ceac2f27014150d0e3", size = 26661822, upload-time = "2026-07-22T01:47:50.42Z" }, { url = "https://files.pythonhosted.org/packages/30/9f/008c859ea3fc0d25d6ac32e1293a0795c737b0a472a8603b5e511b56659c/uv-0.11.31-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aec65d8f54403e60f32c50e44d98b6420de55211ad22a340927efc5db6ef4205", size = 27594901, upload-time = "2026-07-22T01:47:55.444Z" }, { url = "https://files.pythonhosted.org/packages/f5/ca/65a2856e79a208f8a1ece0ac077fbee531db7455608c06ab677b2513cbc4/uv-0.11.31-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5610fea306dc6ce5021482d272e6372f0c3dfd1e24ec061f90b1b9287263ac58", size = 26708620, upload-time = "2026-07-22T01:48:00.2Z" }, { url = "https://files.pythonhosted.org/packages/c4/c3/019ecbf3564d909c55fcf065592aff90b8b386d679e379caf356de4473f9/uv-0.11.31-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:44ac79fca5807122676701279a1f36d7917a922f25a0ab5c5cf58a252f666e7e", size = 26894006, upload-time = "2026-07-22T01:48:04.929Z" }, { url = "https://files.pythonhosted.org/packages/f6/9b/b67aa8736f9f82a9f99cec93c28d66d77ff42126914784a3f680bc737b56/uv-0.11.31-py3-none-manylinux_2_28_aarch64.whl", hash = "sha256:c4d4b34264017dc9047d0d49f09363a5e20b388481cddc39d5c44b16b3c2a57c", size = 25504398, upload-time = "2026-07-22T01:48:09.859Z" }, { url = "https://files.pythonhosted.org/packages/44/d1/37e3a30f55e1c623fca484efbb80b6e157b922ee79f5cb7b1c0ff5005f0f/uv-0.11.31-py3-none-manylinux_2_31_riscv64.musllinux_1_1_riscv64.whl", hash = "sha256:9ce168c7323aee61ef07220c815f1b3e3a1b74241acb9f56c0b7fc4794dad600", size = 26307040, upload-time = "2026-07-22T01:48:14.555Z" }, { url = "https://files.pythonhosted.org/packages/00/cc/f607ba28a93100c55b3e048838f85481f8b55a24e3a338e42c151f5884ae/uv-0.11.31-py3-none-manylinux_2_31_riscv64.whl", hash = "sha256:f3f8f58030ba4f711542d581b5fc3cde54db75a773fc873178f7b353f68f8711", size = 26425088, upload-time = "2026-07-22T01:48:19.204Z" }, { url = "https://files.pythonhosted.org/packages/0d/ae/dd865e1d680799f05ff32895689700a23f37e905aac9807c93521fc76d8c/uv-0.11.31-py3-none-musllinux_1_1_i686.whl", hash = "sha256:b1384887f8a4a0b0dfb8c6c81b2f819d1771015a96c70f89ef12559df8206b28", size = 25920399, upload-time = "2026-07-22T01:48:23.866Z" }, { url = "https://files.pythonhosted.org/packages/b8/0a/45ebfd783235a7a39ae1e99dc0bf26c083ea24a37584e530c7fbb6e38a21/uv-0.11.31-py3-none-musllinux_1_1_x86_64.whl", hash = "sha256:c6e052de498086b2014020536829b7e2b6f173ba95b07e55e9e0f85ac00a3927", size = 27126383, upload-time = "2026-07-22T01:48:28.376Z" }, { url = "https://files.pythonhosted.org/packages/d9/c7/4cf78823c123efd3bdac50eb26f4b8fc2c222962d47918a7bb2b465b6522/uv-0.11.31-py3-none-win32.whl", hash = "sha256:03e18e463ecf0e1c347f901f9a8739059d07e2e2ebce72c0f8f1b9328a349c6f", size = 24644301, upload-time = "2026-07-22T01:48:33.094Z" }, { url = "https://files.pythonhosted.org/packages/e1/4f/f2c3d0993ebab255a2dd7c476678c0307da03d890fb98761e8221d7bb043/uv-0.11.31-py3-none-win_amd64.whl", hash = "sha256:1a4bb0030d9070a4831a4f3115c5489998da7ca936e569a72696c90af469177a", size = 27699662, upload-time = "2026-07-22T01:48:37.708Z" }, { url = "https://files.pythonhosted.org/packages/4e/8b/259e12b510c655f743f9a0e3171e6e9276dfd35a058d04d6aeef1fc4a897/uv-0.11.31-py3-none-win_arm64.whl", hash = "sha256:88ab5fdbeff4ab10ac890ab2dd01b7ad62b92251665423e4f68b1cf977fbe635", size = 25849721, upload-time = "2026-07-22T01:48:42.513Z" }, ] [[package]] name = "verspec" version = "0.1.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/e7/44/8126f9f0c44319b2efc65feaad589cadef4d77ece200ae3c9133d58464d0/verspec-0.1.0.tar.gz", hash = "sha256:c4504ca697b2056cdb4bfa7121461f5a0e81809255b41c03dda4ba823637c01e", size = 27123, upload-time = "2020-11-30T02:24:09.646Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/a4/ce/3b6fee91c85626eaf769d617f1be9d2e15c1cca027bbdeb2e0d751469355/verspec-0.1.0-py3-none-any.whl", hash = "sha256:741877d5633cc9464c45a469ae2a31e801e6dbbaa85b9675d481cda100f11c31", size = 19640, upload-time = "2020-11-30T02:24:08.387Z" }, ] [[package]] name = "watchdog" version = "6.0.0" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/db/7d/7f3d619e951c88ed75c6037b246ddcf2d322812ee8ea189be89511721d54/watchdog-6.0.0.tar.gz", hash = "sha256:9ddf7c82fda3ae8e24decda1338ede66e1c99883db93711d8fb941eaa2d8c282", size = 131220, upload-time = "2024-11-01T14:07:13.037Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/39/ea/3930d07dafc9e286ed356a679aa02d777c06e9bfd1164fa7c19c288a5483/watchdog-6.0.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:bdd4e6f14b8b18c334febb9c4425a878a2ac20efd1e0b231978e7b150f92a948", size = 96471, upload-time = "2024-11-01T14:06:37.745Z" }, { url = "https://files.pythonhosted.org/packages/12/87/48361531f70b1f87928b045df868a9fd4e253d9ae087fa4cf3f7113be363/watchdog-6.0.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:c7c15dda13c4eb00d6fb6fc508b3c0ed88b9d5d374056b239c4ad1611125c860", size = 88449, upload-time = "2024-11-01T14:06:39.748Z" }, { url = "https://files.pythonhosted.org/packages/5b/7e/8f322f5e600812e6f9a31b75d242631068ca8f4ef0582dd3ae6e72daecc8/watchdog-6.0.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6f10cb2d5902447c7d0da897e2c6768bca89174d0c6e1e30abec5421af97a5b0", size = 89054, upload-time = "2024-11-01T14:06:41.009Z" }, { url = "https://files.pythonhosted.org/packages/68/98/b0345cabdce2041a01293ba483333582891a3bd5769b08eceb0d406056ef/watchdog-6.0.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:490ab2ef84f11129844c23fb14ecf30ef3d8a6abafd3754a6f75ca1e6654136c", size = 96480, upload-time = "2024-11-01T14:06:42.952Z" }, { url = "https://files.pythonhosted.org/packages/85/83/cdf13902c626b28eedef7ec4f10745c52aad8a8fe7eb04ed7b1f111ca20e/watchdog-6.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:76aae96b00ae814b181bb25b1b98076d5fc84e8a53cd8885a318b42b6d3a5134", size = 88451, upload-time = "2024-11-01T14:06:45.084Z" }, { url = "https://files.pythonhosted.org/packages/fe/c4/225c87bae08c8b9ec99030cd48ae9c4eca050a59bf5c2255853e18c87b50/watchdog-6.0.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a175f755fc2279e0b7312c0035d52e27211a5bc39719dd529625b1930917345b", size = 89057, upload-time = "2024-11-01T14:06:47.324Z" }, { url = "https://files.pythonhosted.org/packages/a9/c7/ca4bf3e518cb57a686b2feb4f55a1892fd9a3dd13f470fca14e00f80ea36/watchdog-6.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:7607498efa04a3542ae3e05e64da8202e58159aa1fa4acddf7678d34a35d4f13", size = 79079, upload-time = "2024-11-01T14:06:59.472Z" }, { url = "https://files.pythonhosted.org/packages/5c/51/d46dc9332f9a647593c947b4b88e2381c8dfc0942d15b8edc0310fa4abb1/watchdog-6.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:9041567ee8953024c83343288ccc458fd0a2d811d6a0fd68c4c22609e3490379", size = 79078, upload-time = "2024-11-01T14:07:01.431Z" }, { url = "https://files.pythonhosted.org/packages/d4/57/04edbf5e169cd318d5f07b4766fee38e825d64b6913ca157ca32d1a42267/watchdog-6.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:82dc3e3143c7e38ec49d61af98d6558288c415eac98486a5c581726e0737c00e", size = 79076, upload-time = "2024-11-01T14:07:02.568Z" }, { url = "https://files.pythonhosted.org/packages/ab/cc/da8422b300e13cb187d2203f20b9253e91058aaf7db65b74142013478e66/watchdog-6.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:212ac9b8bf1161dc91bd09c048048a95ca3a4c4f5e5d4a7d1b1a7d5752a7f96f", size = 79077, upload-time = "2024-11-01T14:07:03.893Z" }, { url = "https://files.pythonhosted.org/packages/2c/3b/b8964e04ae1a025c44ba8e4291f86e97fac443bca31de8bd98d3263d2fcf/watchdog-6.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:e3df4cbb9a450c6d49318f6d14f4bbc80d763fa587ba46ec86f99f9e6876bb26", size = 79078, upload-time = "2024-11-01T14:07:05.189Z" }, { url = "https://files.pythonhosted.org/packages/62/ae/a696eb424bedff7407801c257d4b1afda455fe40821a2be430e173660e81/watchdog-6.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:2cce7cfc2008eb51feb6aab51251fd79b85d9894e98ba847408f662b3395ca3c", size = 79077, upload-time = "2024-11-01T14:07:06.376Z" }, { url = "https://files.pythonhosted.org/packages/b5/e8/dbf020b4d98251a9860752a094d09a65e1b436ad181faf929983f697048f/watchdog-6.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:20ffe5b202af80ab4266dcd3e91aae72bf2da48c0d33bdb15c66658e685e94e2", size = 79078, upload-time = "2024-11-01T14:07:07.547Z" }, { url = "https://files.pythonhosted.org/packages/07/f6/d0e5b343768e8bcb4cda79f0f2f55051bf26177ecd5651f84c07567461cf/watchdog-6.0.0-py3-none-win32.whl", hash = "sha256:07df1fdd701c5d4c8e55ef6cf55b8f0120fe1aef7ef39a1c6fc6bc2e606d517a", size = 79065, upload-time = "2024-11-01T14:07:09.525Z" }, { url = "https://files.pythonhosted.org/packages/db/d9/c495884c6e548fce18a8f40568ff120bc3a4b7b99813081c8ac0c936fa64/watchdog-6.0.0-py3-none-win_amd64.whl", hash = "sha256:cbafb470cf848d93b5d013e2ecb245d4aa1c8fd0504e863ccefa32445359d680", size = 79070, upload-time = "2024-11-01T14:07:10.686Z" }, { url = "https://files.pythonhosted.org/packages/33/e8/e40370e6d74ddba47f002a32919d91310d6074130fe4e17dabcafc15cbf1/watchdog-6.0.0-py3-none-win_ia64.whl", hash = "sha256:a1914259fa9e1454315171103c6a30961236f508b9b623eae470268bbcc6a22f", size = 79067, upload-time = "2024-11-01T14:07:11.845Z" }, ] [[package]] name = "webencodings" version = "0.5.1" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/0b/02/ae6ceac1baeda530866a85075641cec12989bd8d31af6d5ab4a3e8c92f47/webencodings-0.5.1.tar.gz", hash = "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923", size = 9721, upload-time = "2017-04-05T20:21:34.189Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/f4/24/2a3e3df732393fed8b3ebf2ec078f05546de641fe1b667ee316ec1dcf3b7/webencodings-0.5.1-py2.py3-none-any.whl", hash = "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78", size = 11774, upload-time = "2017-04-05T20:21:32.581Z" }, ] [[package]] name = "werkzeug" version = "3.1.8" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markupsafe" }, ] sdist = { url = "https://files.pythonhosted.org/packages/dd/b2/381be8cfdee792dd117872481b6e378f85c957dd7c5bca38897b08f765fd/werkzeug-3.1.8.tar.gz", hash = "sha256:9bad61a4268dac112f1c5cd4630a56ede601b6ed420300677a869083d70a4c44", size = 875852, upload-time = "2026-04-02T18:49:14.268Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/93/8c/2e650f2afeb7ee576912636c23ddb621c91ac6a98e66dc8d29c3c69446e1/werkzeug-3.1.8-py3-none-any.whl", hash = "sha256:63a77fb8892bf28ebc3178683445222aa500e48ebad5ec77b0ad80f8726b1f50", size = 226459, upload-time = "2026-04-02T18:49:12.72Z" }, ] [[package]] name = "wrapt" version = "2.1.2" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/2e/64/925f213fdcbb9baeb1530449ac71a4d57fc361c053d06bf78d0c5c7cd80c/wrapt-2.1.2.tar.gz", hash = "sha256:3996a67eecc2c68fd47b4e3c564405a5777367adfd9b8abb58387b63ee83b21e", size = 81678, upload-time = "2026-03-06T02:53:25.134Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/4c/b6/1db817582c49c7fcbb7df6809d0f515af29d7c2fbf57eb44c36e98fb1492/wrapt-2.1.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:ff2aad9c4cda28a8f0653fc2d487596458c2a3f475e56ba02909e950a9efa6a9", size = 61255, upload-time = "2026-03-06T02:52:45.663Z" }, { url = "https://files.pythonhosted.org/packages/a2/16/9b02a6b99c09227c93cd4b73acc3678114154ec38da53043c0ddc1fba0dc/wrapt-2.1.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6433ea84e1cfacf32021d2a4ee909554ade7fd392caa6f7c13f1f4bf7b8e8748", size = 61848, upload-time = "2026-03-06T02:53:48.728Z" }, { url = "https://files.pythonhosted.org/packages/af/aa/ead46a88f9ec3a432a4832dfedb84092fc35af2d0ba40cd04aea3889f247/wrapt-2.1.2-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:c20b757c268d30d6215916a5fa8461048d023865d888e437fab451139cad6c8e", size = 121433, upload-time = "2026-03-06T02:54:40.328Z" }, { url = "https://files.pythonhosted.org/packages/3a/9f/742c7c7cdf58b59085a1ee4b6c37b013f66ac33673a7ef4aaed5e992bc33/wrapt-2.1.2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:79847b83eb38e70d93dc392c7c5b587efe65b3e7afcc167aa8abd5d60e8761c8", size = 123013, upload-time = "2026-03-06T02:53:26.58Z" }, { url = "https://files.pythonhosted.org/packages/e8/44/2c3dd45d53236b7ed7c646fcf212251dc19e48e599debd3926b52310fafb/wrapt-2.1.2-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:f8fba1bae256186a83d1875b2b1f4e2d1242e8fac0f58ec0d7e41b26967b965c", size = 117326, upload-time = "2026-03-06T02:53:11.547Z" }, { url = "https://files.pythonhosted.org/packages/74/e2/b17d66abc26bd96f89dec0ecd0ef03da4a1286e6ff793839ec431b9fae57/wrapt-2.1.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e3d3b35eedcf5f7d022291ecd7533321c4775f7b9cd0050a31a68499ba45757c", size = 121444, upload-time = "2026-03-06T02:54:09.5Z" }, { url = "https://files.pythonhosted.org/packages/3c/62/e2977843fdf9f03daf1586a0ff49060b1b2fc7ff85a7ea82b6217c1ae36e/wrapt-2.1.2-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:6f2c5390460de57fa9582bc8a1b7a6c86e1a41dfad74c5225fc07044c15cc8d1", size = 116237, upload-time = "2026-03-06T02:54:03.884Z" }, { url = "https://files.pythonhosted.org/packages/88/dd/27fc67914e68d740bce512f11734aec08696e6b17641fef8867c00c949fc/wrapt-2.1.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7dfa9f2cf65d027b951d05c662cc99ee3bd01f6e4691ed39848a7a5fffc902b2", size = 120563, upload-time = "2026-03-06T02:53:20.412Z" }, { url = "https://files.pythonhosted.org/packages/ec/9f/b750b3692ed2ef4705cb305bd68858e73010492b80e43d2a4faa5573cbe7/wrapt-2.1.2-cp312-cp312-win32.whl", hash = "sha256:eba8155747eb2cae4a0b913d9ebd12a1db4d860fc4c829d7578c7b989bd3f2f0", size = 58198, upload-time = "2026-03-06T02:53:37.732Z" }, { url = "https://files.pythonhosted.org/packages/8e/b2/feecfe29f28483d888d76a48f03c4c4d8afea944dbee2b0cd3380f9df032/wrapt-2.1.2-cp312-cp312-win_amd64.whl", hash = "sha256:1c51c738d7d9faa0b3601708e7e2eda9bf779e1b601dce6c77411f2a1b324a63", size = 60441, upload-time = "2026-03-06T02:52:47.138Z" }, { url = "https://files.pythonhosted.org/packages/44/e1/e328f605d6e208547ea9fd120804fcdec68536ac748987a68c47c606eea8/wrapt-2.1.2-cp312-cp312-win_arm64.whl", hash = "sha256:c8e46ae8e4032792eb2f677dbd0d557170a8e5524d22acc55199f43efedd39bf", size = 58836, upload-time = "2026-03-06T02:53:22.053Z" }, { url = "https://files.pythonhosted.org/packages/4c/7a/d936840735c828b38d26a854e85d5338894cda544cb7a85a9d5b8b9c4df7/wrapt-2.1.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:787fd6f4d67befa6fe2abdffcbd3de2d82dfc6fb8a6d850407c53332709d030b", size = 61259, upload-time = "2026-03-06T02:53:41.922Z" }, { url = "https://files.pythonhosted.org/packages/5e/88/9a9b9a90ac8ca11c2fdb6a286cb3a1fc7dd774c00ed70929a6434f6bc634/wrapt-2.1.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:4bdf26e03e6d0da3f0e9422fd36bcebf7bc0eeb55fdf9c727a09abc6b9fe472e", size = 61851, upload-time = "2026-03-06T02:52:48.672Z" }, { url = "https://files.pythonhosted.org/packages/03/a9/5b7d6a16fd6533fed2756900fc8fc923f678179aea62ada6d65c92718c00/wrapt-2.1.2-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:bbac24d879aa22998e87f6b3f481a5216311e7d53c7db87f189a7a0266dafffb", size = 121446, upload-time = "2026-03-06T02:54:14.013Z" }, { url = "https://files.pythonhosted.org/packages/45/bb/34c443690c847835cfe9f892be78c533d4f32366ad2888972c094a897e39/wrapt-2.1.2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:16997dfb9d67addc2e3f41b62a104341e80cac52f91110dece393923c0ebd5ca", size = 123056, upload-time = "2026-03-06T02:54:10.829Z" }, { url = "https://files.pythonhosted.org/packages/93/b9/ff205f391cb708f67f41ea148545f2b53ff543a7ac293b30d178af4d2271/wrapt-2.1.2-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:162e4e2ba7542da9027821cb6e7c5e068d64f9a10b5f15512ea28e954893a267", size = 117359, upload-time = "2026-03-06T02:53:03.623Z" }, { url = "https://files.pythonhosted.org/packages/1f/3d/1ea04d7747825119c3c9a5e0874a40b33594ada92e5649347c457d982805/wrapt-2.1.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f29c827a8d9936ac320746747a016c4bc66ef639f5cd0d32df24f5eacbf9c69f", size = 121479, upload-time = "2026-03-06T02:53:45.844Z" }, { url = "https://files.pythonhosted.org/packages/78/cc/ee3a011920c7a023b25e8df26f306b2484a531ab84ca5c96260a73de76c0/wrapt-2.1.2-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:a9dd9813825f7ecb018c17fd147a01845eb330254dff86d3b5816f20f4d6aaf8", size = 116271, upload-time = "2026-03-06T02:54:46.356Z" }, { url = "https://files.pythonhosted.org/packages/98/fd/e5ff7ded41b76d802cf1191288473e850d24ba2e39a6ec540f21ae3b57cb/wrapt-2.1.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:6f8dbdd3719e534860d6a78526aafc220e0241f981367018c2875178cf83a413", size = 120573, upload-time = "2026-03-06T02:52:50.163Z" }, { url = "https://files.pythonhosted.org/packages/47/c5/242cae3b5b080cd09bacef0591691ba1879739050cc7c801ff35c8886b66/wrapt-2.1.2-cp313-cp313-win32.whl", hash = "sha256:5c35b5d82b16a3bc6e0a04349b606a0582bc29f573786aebe98e0c159bc48db6", size = 58205, upload-time = "2026-03-06T02:53:47.494Z" }, { url = "https://files.pythonhosted.org/packages/12/69/c358c61e7a50f290958809b3c61ebe8b3838ea3e070d7aac9814f95a0528/wrapt-2.1.2-cp313-cp313-win_amd64.whl", hash = "sha256:f8bc1c264d8d1cf5b3560a87bbdd31131573eb25f9f9447bb6252b8d4c44a3a1", size = 60452, upload-time = "2026-03-06T02:53:30.038Z" }, { url = "https://files.pythonhosted.org/packages/8e/66/c8a6fcfe321295fd8c0ab1bd685b5a01462a9b3aa2f597254462fc2bc975/wrapt-2.1.2-cp313-cp313-win_arm64.whl", hash = "sha256:3beb22f674550d5634642c645aba4c72a2c66fb185ae1aebe1e955fae5a13baf", size = 58842, upload-time = "2026-03-06T02:52:52.114Z" }, { url = "https://files.pythonhosted.org/packages/da/55/9c7052c349106e0b3f17ae8db4b23a691a963c334de7f9dbd60f8f74a831/wrapt-2.1.2-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:0fc04bc8664a8bc4c8e00b37b5355cffca2535209fba1abb09ae2b7c76ddf82b", size = 63075, upload-time = "2026-03-06T02:53:19.108Z" }, { url = "https://files.pythonhosted.org/packages/09/a8/ce7b4006f7218248dd71b7b2b732d0710845a0e49213b18faef64811ffef/wrapt-2.1.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:a9b9d50c9af998875a1482a038eb05755dfd6fe303a313f6a940bb53a83c3f18", size = 63719, upload-time = "2026-03-06T02:54:33.452Z" }, { url = "https://files.pythonhosted.org/packages/e4/e5/2ca472e80b9e2b7a17f106bb8f9df1db11e62101652ce210f66935c6af67/wrapt-2.1.2-cp313-cp313t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:2d3ff4f0024dd224290c0eabf0240f1bfc1f26363431505fb1b0283d3b08f11d", size = 152643, upload-time = "2026-03-06T02:52:42.721Z" }, { url = "https://files.pythonhosted.org/packages/36/42/30f0f2cefca9d9cbf6835f544d825064570203c3e70aa873d8ae12e23791/wrapt-2.1.2-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:3278c471f4468ad544a691b31bb856374fbdefb7fee1a152153e64019379f015", size = 158805, upload-time = "2026-03-06T02:54:25.441Z" }, { url = "https://files.pythonhosted.org/packages/bb/67/d08672f801f604889dcf58f1a0b424fe3808860ede9e03affc1876b295af/wrapt-2.1.2-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:a8914c754d3134a3032601c6984db1c576e6abaf3fc68094bb8ab1379d75ff92", size = 145990, upload-time = "2026-03-06T02:53:57.456Z" }, { url = "https://files.pythonhosted.org/packages/68/a7/fd371b02e73babec1de6ade596e8cd9691051058cfdadbfd62a5898f3295/wrapt-2.1.2-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:ff95d4264e55839be37bafe1536db2ab2de19da6b65f9244f01f332b5286cfbf", size = 155670, upload-time = "2026-03-06T02:54:55.309Z" }, { url = "https://files.pythonhosted.org/packages/86/2d/9fe0095dfdb621009f40117dcebf41d7396c2c22dca6eac779f4c007b86c/wrapt-2.1.2-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:76405518ca4e1b76fbb1b9f686cff93aebae03920cc55ceeec48ff9f719c5f67", size = 144357, upload-time = "2026-03-06T02:54:24.092Z" }, { url = "https://files.pythonhosted.org/packages/0e/b6/ec7b4a254abbe4cde9fa15c5d2cca4518f6b07d0f1b77d4ee9655e30280e/wrapt-2.1.2-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:c0be8b5a74c5824e9359b53e7e58bef71a729bacc82e16587db1c4ebc91f7c5a", size = 150269, upload-time = "2026-03-06T02:53:31.268Z" }, { url = "https://files.pythonhosted.org/packages/6e/6b/2fabe8ebf148f4ee3c782aae86a795cc68ffe7d432ef550f234025ce0cfa/wrapt-2.1.2-cp313-cp313t-win32.whl", hash = "sha256:f01277d9a5fc1862f26f7626da9cf443bebc0abd2f303f41c5e995b15887dabd", size = 59894, upload-time = "2026-03-06T02:54:15.391Z" }, { url = "https://files.pythonhosted.org/packages/ca/fb/9ba66fc2dedc936de5f8073c0217b5d4484e966d87723415cc8262c5d9c2/wrapt-2.1.2-cp313-cp313t-win_amd64.whl", hash = "sha256:84ce8f1c2104d2f6daa912b1b5b039f331febfeee74f8042ad4e04992bd95c8f", size = 63197, upload-time = "2026-03-06T02:54:41.943Z" }, { url = "https://files.pythonhosted.org/packages/c0/1c/012d7423c95d0e337117723eb8ecf73c622ce15a97847e84cf3f8f26cd7e/wrapt-2.1.2-cp313-cp313t-win_arm64.whl", hash = "sha256:a93cd767e37faeddbe07d8fc4212d5cba660af59bdb0f6372c93faaa13e6e679", size = 60363, upload-time = "2026-03-06T02:54:48.093Z" }, { url = "https://files.pythonhosted.org/packages/39/25/e7ea0b417db02bb796182a5316398a75792cd9a22528783d868755e1f669/wrapt-2.1.2-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:1370e516598854e5b4366e09ce81e08bfe94d42b0fd569b88ec46cc56d9164a9", size = 61418, upload-time = "2026-03-06T02:53:55.706Z" }, { url = "https://files.pythonhosted.org/packages/ec/0f/fa539e2f6a770249907757eaeb9a5ff4deb41c026f8466c1c6d799088a9b/wrapt-2.1.2-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:6de1a3851c27e0bd6a04ca993ea6f80fc53e6c742ee1601f486c08e9f9b900a9", size = 61914, upload-time = "2026-03-06T02:52:53.37Z" }, { url = "https://files.pythonhosted.org/packages/53/37/02af1867f5b1441aaeda9c82deed061b7cd1372572ddcd717f6df90b5e93/wrapt-2.1.2-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:de9f1a2bbc5ac7f6012ec24525bdd444765a2ff64b5985ac6e0692144838542e", size = 120417, upload-time = "2026-03-06T02:54:30.74Z" }, { url = "https://files.pythonhosted.org/packages/c3/b7/0138a6238c8ba7476c77cf786a807f871672b37f37a422970342308276e7/wrapt-2.1.2-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:970d57ed83fa040d8b20c52fe74a6ae7e3775ae8cff5efd6a81e06b19078484c", size = 122797, upload-time = "2026-03-06T02:54:51.539Z" }, { url = "https://files.pythonhosted.org/packages/e1/ad/819ae558036d6a15b7ed290d5b14e209ca795dd4da9c58e50c067d5927b0/wrapt-2.1.2-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:3969c56e4563c375861c8df14fa55146e81ac11c8db49ea6fb7f2ba58bc1ff9a", size = 117350, upload-time = "2026-03-06T02:54:37.651Z" }, { url = "https://files.pythonhosted.org/packages/8b/2d/afc18dc57a4600a6e594f77a9ae09db54f55ba455440a54886694a84c71b/wrapt-2.1.2-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:57d7c0c980abdc5f1d98b11a2aa3bb159790add80258c717fa49a99921456d90", size = 121223, upload-time = "2026-03-06T02:54:35.221Z" }, { url = "https://files.pythonhosted.org/packages/b9/5b/5ec189b22205697bc56eb3b62aed87a1e0423e9c8285d0781c7a83170d15/wrapt-2.1.2-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:776867878e83130c7a04237010463372e877c1c994d449ca6aaafeab6aab2586", size = 116287, upload-time = "2026-03-06T02:54:19.654Z" }, { url = "https://files.pythonhosted.org/packages/f7/2d/f84939a7c9b5e6cdd8a8d0f6a26cabf36a0f7e468b967720e8b0cd2bdf69/wrapt-2.1.2-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:fab036efe5464ec3291411fabb80a7a39e2dd80bae9bcbeeca5087fdfa891e19", size = 119593, upload-time = "2026-03-06T02:54:16.697Z" }, { url = "https://files.pythonhosted.org/packages/0b/fe/ccd22a1263159c4ac811ab9374c061bcb4a702773f6e06e38de5f81a1bdc/wrapt-2.1.2-cp314-cp314-win32.whl", hash = "sha256:e6ed62c82ddf58d001096ae84ce7f833db97ae2263bff31c9b336ba8cfe3f508", size = 58631, upload-time = "2026-03-06T02:53:06.498Z" }, { url = "https://files.pythonhosted.org/packages/65/0a/6bd83be7bff2e7efaac7b4ac9748da9d75a34634bbbbc8ad077d527146df/wrapt-2.1.2-cp314-cp314-win_amd64.whl", hash = "sha256:467e7c76315390331c67073073d00662015bb730c566820c9ca9b54e4d67fd04", size = 60875, upload-time = "2026-03-06T02:53:50.252Z" }, { url = "https://files.pythonhosted.org/packages/6c/c0/0b3056397fe02ff80e5a5d72d627c11eb885d1ca78e71b1a5c1e8c7d45de/wrapt-2.1.2-cp314-cp314-win_arm64.whl", hash = "sha256:da1f00a557c66225d53b095a97eace0fc5349e3bfda28fa34ffae238978ee575", size = 59164, upload-time = "2026-03-06T02:53:59.128Z" }, { url = "https://files.pythonhosted.org/packages/71/ed/5d89c798741993b2371396eb9d4634f009ff1ad8a6c78d366fe2883ea7a6/wrapt-2.1.2-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:62503ffbc2d3a69891cf29beeaccdb4d5e0a126e2b6a851688d4777e01428dbb", size = 63163, upload-time = "2026-03-06T02:52:54.873Z" }, { url = "https://files.pythonhosted.org/packages/c6/8c/05d277d182bf36b0a13d6bd393ed1dec3468a25b59d01fba2dd70fe4d6ae/wrapt-2.1.2-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c7e6cd120ef837d5b6f860a6ea3745f8763805c418bb2f12eeb1fa6e25f22d22", size = 63723, upload-time = "2026-03-06T02:52:56.374Z" }, { url = "https://files.pythonhosted.org/packages/f4/27/6c51ec1eff4413c57e72d6106bb8dec6f0c7cdba6503d78f0fa98767bcc9/wrapt-2.1.2-cp314-cp314t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:3769a77df8e756d65fbc050333f423c01ae012b4f6731aaf70cf2bef61b34596", size = 152652, upload-time = "2026-03-06T02:53:23.79Z" }, { url = "https://files.pythonhosted.org/packages/db/4c/d7dd662d6963fc7335bfe29d512b02b71cdfa23eeca7ab3ac74a67505deb/wrapt-2.1.2-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a76d61a2e851996150ba0f80582dd92a870643fa481f3b3846f229de88caf044", size = 158807, upload-time = "2026-03-06T02:53:35.742Z" }, { url = "https://files.pythonhosted.org/packages/b4/4d/1e5eea1a78d539d346765727422976676615814029522c76b87a95f6bcdd/wrapt-2.1.2-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:6f97edc9842cf215312b75fe737ee7c8adda75a89979f8e11558dfff6343cc4b", size = 146061, upload-time = "2026-03-06T02:52:57.574Z" }, { url = "https://files.pythonhosted.org/packages/89/bc/62cabea7695cd12a288023251eeefdcb8465056ddaab6227cb78a2de005b/wrapt-2.1.2-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:4006c351de6d5007aa33a551f600404ba44228a89e833d2fadc5caa5de8edfbf", size = 155667, upload-time = "2026-03-06T02:53:39.422Z" }, { url = "https://files.pythonhosted.org/packages/e9/99/6f2888cd68588f24df3a76572c69c2de28287acb9e1972bf0c83ce97dbc1/wrapt-2.1.2-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:a9372fc3639a878c8e7d87e1556fa209091b0a66e912c611e3f833e2c4202be2", size = 144392, upload-time = "2026-03-06T02:54:22.41Z" }, { url = "https://files.pythonhosted.org/packages/40/51/1dfc783a6c57971614c48e361a82ca3b6da9055879952587bc99fe1a7171/wrapt-2.1.2-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:3144b027ff30cbd2fca07c0a87e67011adb717eb5f5bd8496325c17e454257a3", size = 150296, upload-time = "2026-03-06T02:54:07.848Z" }, { url = "https://files.pythonhosted.org/packages/6c/38/cbb8b933a0201076c1f64fc42883b0023002bdc14a4964219154e6ff3350/wrapt-2.1.2-cp314-cp314t-win32.whl", hash = "sha256:3b8d15e52e195813efe5db8cec156eebe339aaf84222f4f4f051a6c01f237ed7", size = 60539, upload-time = "2026-03-06T02:54:00.594Z" }, { url = "https://files.pythonhosted.org/packages/82/dd/e5176e4b241c9f528402cebb238a36785a628179d7d8b71091154b3e4c9e/wrapt-2.1.2-cp314-cp314t-win_amd64.whl", hash = "sha256:08ffa54146a7559f5b8df4b289b46d963a8e74ed16ba3687f99896101a3990c5", size = 63969, upload-time = "2026-03-06T02:54:39Z" }, { url = "https://files.pythonhosted.org/packages/5c/99/79f17046cf67e4a95b9987ea129632ba8bcec0bc81f3fb3d19bdb0bd60cd/wrapt-2.1.2-cp314-cp314t-win_arm64.whl", hash = "sha256:72aaa9d0d8e4ed0e2e98019cea47a21f823c9dd4b43c7b77bba6679ffcca6a00", size = 60554, upload-time = "2026-03-06T02:53:14.132Z" }, { url = "https://files.pythonhosted.org/packages/1a/c7/8528ac2dfa2c1e6708f647df7ae144ead13f0a31146f43c7264b4942bf12/wrapt-2.1.2-py3-none-any.whl", hash = "sha256:b8fd6fa2b2c4e7621808f8c62e8317f4aae56e59721ad933bac5239d913cf0e8", size = 43993, upload-time = "2026-03-06T02:53:12.905Z" }, ] [[package]] name = "xmltodict" version = "1.0.4" source = { registry = "https://pypi.org/simple" } sdist = { url = "https://files.pythonhosted.org/packages/19/70/80f3b7c10d2630aa66414bf23d210386700aa390547278c789afa994fd7e/xmltodict-1.0.4.tar.gz", hash = "sha256:6d94c9f834dd9e44514162799d344d815a3a4faec913717a9ecbfa5be1bb8e61", size = 26124, upload-time = "2026-02-22T02:21:22.074Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/38/34/98a2f52245f4d47be93b580dae5f9861ef58977d73a79eb47c58f1ad1f3a/xmltodict-1.0.4-py3-none-any.whl", hash = "sha256:a4a00d300b0e1c59fc2bfccb53d7b2e88c32f200df138a0dd2229f842497026a", size = 13580, upload-time = "2026-02-22T02:21:21.039Z" }, ] [[package]] name = "yarl" version = "1.23.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "idna" }, { name = "multidict" }, { name = "propcache" }, ] sdist = { url = "https://files.pythonhosted.org/packages/23/6e/beb1beec874a72f23815c1434518bfc4ed2175065173fb138c3705f658d4/yarl-1.23.0.tar.gz", hash = "sha256:53b1ea6ca88ebd4420379c330aea57e258408dd0df9af0992e5de2078dc9f5d5", size = 194676, upload-time = "2026-03-01T22:07:53.373Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/88/8a/94615bc31022f711add374097ad4144d569e95ff3c38d39215d07ac153a0/yarl-1.23.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:1932b6b8bba8d0160a9d1078aae5838a66039e8832d41d2992daa9a3a08f7860", size = 124737, upload-time = "2026-03-01T22:05:12.897Z" }, { url = "https://files.pythonhosted.org/packages/e3/6f/c6554045d59d64052698add01226bc867b52fe4a12373415d7991fdca95d/yarl-1.23.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:411225bae281f114067578891bc75534cfb3d92a3b4dfef7a6ca78ba354e6069", size = 87029, upload-time = "2026-03-01T22:05:14.376Z" }, { url = "https://files.pythonhosted.org/packages/19/2a/725ecc166d53438bc88f76822ed4b1e3b10756e790bafd7b523fe97c322d/yarl-1.23.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:13a563739ae600a631c36ce096615fe307f131344588b0bc0daec108cdb47b25", size = 86310, upload-time = "2026-03-01T22:05:15.71Z" }, { url = "https://files.pythonhosted.org/packages/99/30/58260ed98e6ff7f90ba84442c1ddd758c9170d70327394a6227b310cd60f/yarl-1.23.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9cbf44c5cb4a7633d078788e1b56387e3d3cf2b8139a3be38040b22d6c3221c8", size = 97587, upload-time = "2026-03-01T22:05:17.384Z" }, { url = "https://files.pythonhosted.org/packages/76/0a/8b08aac08b50682e65759f7f8dde98ae8168f72487e7357a5d684c581ef9/yarl-1.23.0-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:53ad387048f6f09a8969631e4de3f1bf70c50e93545d64af4f751b2498755072", size = 92528, upload-time = "2026-03-01T22:05:18.804Z" }, { url = "https://files.pythonhosted.org/packages/52/07/0b7179101fe5f8385ec6c6bb5d0cb9f76bd9fb4a769591ab6fb5cdbfc69a/yarl-1.23.0-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:4a59ba56f340334766f3a4442e0efd0af895fae9e2b204741ef885c446b3a1a8", size = 105339, upload-time = "2026-03-01T22:05:20.235Z" }, { url = "https://files.pythonhosted.org/packages/d3/8a/36d82869ab5ec829ca8574dfcb92b51286fcfb1e9c7a73659616362dc880/yarl-1.23.0-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:803a3c3ce4acc62eaf01eaca1208dcf0783025ef27572c3336502b9c232005e7", size = 105061, upload-time = "2026-03-01T22:05:22.268Z" }, { url = "https://files.pythonhosted.org/packages/66/3e/868e5c3364b6cee19ff3e1a122194fa4ce51def02c61023970442162859e/yarl-1.23.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a3d2bff8f37f8d0f96c7ec554d16945050d54462d6e95414babaa18bfafc7f51", size = 100132, upload-time = "2026-03-01T22:05:23.638Z" }, { url = "https://files.pythonhosted.org/packages/cf/26/9c89acf82f08a52cb52d6d39454f8d18af15f9d386a23795389d1d423823/yarl-1.23.0-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:c75eb09e8d55bceb4367e83496ff8ef2bc7ea6960efb38e978e8073ea59ecb67", size = 99289, upload-time = "2026-03-01T22:05:25.749Z" }, { url = "https://files.pythonhosted.org/packages/6f/54/5b0db00d2cb056922356104468019c0a132e89c8d3ab67d8ede9f4483d2a/yarl-1.23.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:877b0738624280e34c55680d6054a307aa94f7d52fa0e3034a9cc6e790871da7", size = 96950, upload-time = "2026-03-01T22:05:27.318Z" }, { url = "https://files.pythonhosted.org/packages/f6/40/10fa93811fd439341fad7e0718a86aca0de9548023bbb403668d6555acab/yarl-1.23.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:b5405bb8f0e783a988172993cfc627e4d9d00432d6bbac65a923041edacf997d", size = 93960, upload-time = "2026-03-01T22:05:28.738Z" }, { url = "https://files.pythonhosted.org/packages/bc/d2/8ae2e6cd77d0805f4526e30ec43b6f9a3dfc542d401ac4990d178e4bf0cf/yarl-1.23.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:1c3a3598a832590c5a3ce56ab5576361b5688c12cb1d39429cf5dba30b510760", size = 104703, upload-time = "2026-03-01T22:05:30.438Z" }, { url = "https://files.pythonhosted.org/packages/2f/0c/b3ceacf82c3fe21183ce35fa2acf5320af003d52bc1fcf5915077681142e/yarl-1.23.0-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:8419ebd326430d1cbb7efb5292330a2cf39114e82df5cc3d83c9a0d5ebeaf2f2", size = 98325, upload-time = "2026-03-01T22:05:31.835Z" }, { url = "https://files.pythonhosted.org/packages/9d/e0/12900edd28bdab91a69bd2554b85ad7b151f64e8b521fe16f9ad2f56477a/yarl-1.23.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:be61f6fff406ca40e3b1d84716fde398fc08bc63dd96d15f3a14230a0973ed86", size = 105067, upload-time = "2026-03-01T22:05:33.358Z" }, { url = "https://files.pythonhosted.org/packages/15/61/74bb1182cf79c9bbe4eb6b1f14a57a22d7a0be5e9cedf8e2d5c2086474c3/yarl-1.23.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:3ceb13c5c858d01321b5d9bb65e4cf37a92169ea470b70fec6f236b2c9dd7e34", size = 100285, upload-time = "2026-03-01T22:05:35.4Z" }, { url = "https://files.pythonhosted.org/packages/69/7f/cd5ef733f2550de6241bd8bd8c3febc78158b9d75f197d9c7baa113436af/yarl-1.23.0-cp312-cp312-win32.whl", hash = "sha256:fffc45637bcd6538de8b85f51e3df3223e4ad89bccbfca0481c08c7fc8b7ed7d", size = 82359, upload-time = "2026-03-01T22:05:36.811Z" }, { url = "https://files.pythonhosted.org/packages/f5/be/25216a49daeeb7af2bec0db22d5e7df08ed1d7c9f65d78b14f3b74fd72fc/yarl-1.23.0-cp312-cp312-win_amd64.whl", hash = "sha256:f69f57305656a4852f2a7203efc661d8c042e6cc67f7acd97d8667fb448a426e", size = 87674, upload-time = "2026-03-01T22:05:38.171Z" }, { url = "https://files.pythonhosted.org/packages/d2/35/aeab955d6c425b227d5b7247eafb24f2653fedc32f95373a001af5dfeb9e/yarl-1.23.0-cp312-cp312-win_arm64.whl", hash = "sha256:6e87a6e8735b44816e7db0b2fbc9686932df473c826b0d9743148432e10bb9b9", size = 81879, upload-time = "2026-03-01T22:05:40.006Z" }, { url = "https://files.pythonhosted.org/packages/9a/4b/a0a6e5d0ee8a2f3a373ddef8a4097d74ac901ac363eea1440464ccbe0898/yarl-1.23.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:16c6994ac35c3e74fb0ae93323bf8b9c2a9088d55946109489667c510a7d010e", size = 123796, upload-time = "2026-03-01T22:05:41.412Z" }, { url = "https://files.pythonhosted.org/packages/67/b6/8925d68af039b835ae876db5838e82e76ec87b9782ecc97e192b809c4831/yarl-1.23.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:4a42e651629dafb64fd5b0286a3580613702b5809ad3f24934ea87595804f2c5", size = 86547, upload-time = "2026-03-01T22:05:42.841Z" }, { url = "https://files.pythonhosted.org/packages/ae/50/06d511cc4b8e0360d3c94af051a768e84b755c5eb031b12adaaab6dec6e5/yarl-1.23.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:7c6b9461a2a8b47c65eef63bb1c76a4f1c119618ffa99ea79bc5bb1e46c5821b", size = 85854, upload-time = "2026-03-01T22:05:44.85Z" }, { url = "https://files.pythonhosted.org/packages/c4/f4/4e30b250927ffdab4db70da08b9b8d2194d7c7b400167b8fbeca1e4701ca/yarl-1.23.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:2569b67d616eab450d262ca7cb9f9e19d2f718c70a8b88712859359d0ab17035", size = 98351, upload-time = "2026-03-01T22:05:46.836Z" }, { url = "https://files.pythonhosted.org/packages/86/fc/4118c5671ea948208bdb1492d8b76bdf1453d3e73df051f939f563e7dcc5/yarl-1.23.0-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:e9d9a4d06d3481eab79803beb4d9bd6f6a8e781ec078ac70d7ef2dcc29d1bea5", size = 92711, upload-time = "2026-03-01T22:05:48.316Z" }, { url = "https://files.pythonhosted.org/packages/56/11/1ed91d42bd9e73c13dc9e7eb0dd92298d75e7ac4dd7f046ad0c472e231cd/yarl-1.23.0-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f514f6474e04179d3d33175ed3f3e31434d3130d42ec153540d5b157deefd735", size = 106014, upload-time = "2026-03-01T22:05:50.028Z" }, { url = "https://files.pythonhosted.org/packages/ce/c9/74e44e056a23fbc33aca71779ef450ca648a5bc472bdad7a82339918f818/yarl-1.23.0-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:fda207c815b253e34f7e1909840fd14299567b1c0eb4908f8c2ce01a41265401", size = 105557, upload-time = "2026-03-01T22:05:51.416Z" }, { url = "https://files.pythonhosted.org/packages/66/fe/b1e10b08d287f518994f1e2ff9b6d26f0adeecd8dd7d533b01bab29a3eda/yarl-1.23.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:34b6cf500e61c90f305094911f9acc9c86da1a05a7a3f5be9f68817043f486e4", size = 101559, upload-time = "2026-03-01T22:05:52.872Z" }, { url = "https://files.pythonhosted.org/packages/72/59/c5b8d94b14e3d3c2a9c20cb100119fd534ab5a14b93673ab4cc4a4141ea5/yarl-1.23.0-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:d7504f2b476d21653e4d143f44a175f7f751cd41233525312696c76aa3dbb23f", size = 100502, upload-time = "2026-03-01T22:05:54.954Z" }, { url = "https://files.pythonhosted.org/packages/77/4f/96976cb54cbfc5c9fd73ed4c51804f92f209481d1fb190981c0f8a07a1d7/yarl-1.23.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:578110dd426f0d209d1509244e6d4a3f1a3e9077655d98c5f22583d63252a08a", size = 98027, upload-time = "2026-03-01T22:05:56.409Z" }, { url = "https://files.pythonhosted.org/packages/63/6e/904c4f476471afdbad6b7e5b70362fb5810e35cd7466529a97322b6f5556/yarl-1.23.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:609d3614d78d74ebe35f54953c5bbd2ac647a7ddb9c30a5d877580f5e86b22f2", size = 95369, upload-time = "2026-03-01T22:05:58.141Z" }, { url = "https://files.pythonhosted.org/packages/9d/40/acfcdb3b5f9d68ef499e39e04d25e141fe90661f9d54114556cf83be8353/yarl-1.23.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4966242ec68afc74c122f8459abd597afd7d8a60dc93d695c1334c5fd25f762f", size = 105565, upload-time = "2026-03-01T22:06:00.286Z" }, { url = "https://files.pythonhosted.org/packages/5e/c6/31e28f3a6ba2869c43d124f37ea5260cac9c9281df803c354b31f4dd1f3c/yarl-1.23.0-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:e0fd068364a6759bc794459f0a735ab151d11304346332489c7972bacbe9e72b", size = 99813, upload-time = "2026-03-01T22:06:01.712Z" }, { url = "https://files.pythonhosted.org/packages/08/1f/6f65f59e72d54aa467119b63fc0b0b1762eff0232db1f4720cd89e2f4a17/yarl-1.23.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:39004f0ad156da43e86aa71f44e033de68a44e5a31fc53507b36dd253970054a", size = 105632, upload-time = "2026-03-01T22:06:03.188Z" }, { url = "https://files.pythonhosted.org/packages/a3/c4/18b178a69935f9e7a338127d5b77d868fdc0f0e49becd286d51b3a18c61d/yarl-1.23.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:e5723c01a56c5028c807c701aa66722916d2747ad737a046853f6c46f4875543", size = 101895, upload-time = "2026-03-01T22:06:04.651Z" }, { url = "https://files.pythonhosted.org/packages/8f/54/f5b870b5505663911dba950a8e4776a0dbd51c9c54c0ae88e823e4b874a0/yarl-1.23.0-cp313-cp313-win32.whl", hash = "sha256:1b6b572edd95b4fa8df75de10b04bc81acc87c1c7d16bcdd2035b09d30acc957", size = 82356, upload-time = "2026-03-01T22:06:06.04Z" }, { url = "https://files.pythonhosted.org/packages/7a/84/266e8da36879c6edcd37b02b547e2d9ecdfea776be49598e75696e3316e1/yarl-1.23.0-cp313-cp313-win_amd64.whl", hash = "sha256:baaf55442359053c7d62f6f8413a62adba3205119bcb6f49594894d8be47e5e3", size = 87515, upload-time = "2026-03-01T22:06:08.107Z" }, { url = "https://files.pythonhosted.org/packages/00/fd/7e1c66efad35e1649114fa13f17485f62881ad58edeeb7f49f8c5e748bf9/yarl-1.23.0-cp313-cp313-win_arm64.whl", hash = "sha256:fb4948814a2a98e3912505f09c9e7493b1506226afb1f881825368d6fb776ee3", size = 81785, upload-time = "2026-03-01T22:06:10.181Z" }, { url = "https://files.pythonhosted.org/packages/9c/fc/119dd07004f17ea43bb91e3ece6587759edd7519d6b086d16bfbd3319982/yarl-1.23.0-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:aecfed0b41aa72b7881712c65cf764e39ce2ec352324f5e0837c7048d9e6daaa", size = 130719, upload-time = "2026-03-01T22:06:11.708Z" }, { url = "https://files.pythonhosted.org/packages/e6/0d/9f2348502fbb3af409e8f47730282cd6bc80dec6630c1e06374d882d6eb2/yarl-1.23.0-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:a41bcf68efd19073376eb8cf948b8d9be0af26256403e512bb18f3966f1f9120", size = 89690, upload-time = "2026-03-01T22:06:13.429Z" }, { url = "https://files.pythonhosted.org/packages/50/93/e88f3c80971b42cfc83f50a51b9d165a1dbf154b97005f2994a79f212a07/yarl-1.23.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:cde9a2ecd91668bcb7f077c4966d8ceddb60af01b52e6e3e2680e4cf00ad1a59", size = 89851, upload-time = "2026-03-01T22:06:15.53Z" }, { url = "https://files.pythonhosted.org/packages/1c/07/61c9dd8ba8f86473263b4036f70fb594c09e99c0d9737a799dfd8bc85651/yarl-1.23.0-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5023346c4ee7992febc0068e7593de5fa2bf611848c08404b35ebbb76b1b0512", size = 95874, upload-time = "2026-03-01T22:06:17.553Z" }, { url = "https://files.pythonhosted.org/packages/9e/e9/f9ff8ceefba599eac6abddcfb0b3bee9b9e636e96dbf54342a8577252379/yarl-1.23.0-cp313-cp313t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:d1009abedb49ae95b136a8904a3f71b342f849ffeced2d3747bf29caeda218c4", size = 88710, upload-time = "2026-03-01T22:06:19.004Z" }, { url = "https://files.pythonhosted.org/packages/eb/78/0231bfcc5d4c8eec220bc2f9ef82cb4566192ea867a7c5b4148f44f6cbcd/yarl-1.23.0-cp313-cp313t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:a8d00f29b42f534cc8aa3931cfe773b13b23e561e10d2b26f27a8d309b0e82a1", size = 101033, upload-time = "2026-03-01T22:06:21.203Z" }, { url = "https://files.pythonhosted.org/packages/cd/9b/30ea5239a61786f18fd25797151a17fbb3be176977187a48d541b5447dd4/yarl-1.23.0-cp313-cp313t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:95451e6ce06c3e104556d73b559f5da6c34a069b6b62946d3ad66afcd51642ea", size = 100817, upload-time = "2026-03-01T22:06:22.738Z" }, { url = "https://files.pythonhosted.org/packages/62/e2/a4980481071791bc83bce2b7a1a1f7adcabfa366007518b4b845e92eeee3/yarl-1.23.0-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:531ef597132086b6cf96faa7c6c1dcd0361dd5f1694e5cc30375907b9b7d3ea9", size = 97482, upload-time = "2026-03-01T22:06:24.21Z" }, { url = "https://files.pythonhosted.org/packages/e5/1e/304a00cf5f6100414c4b5a01fc7ff9ee724b62158a08df2f8170dfc72a2d/yarl-1.23.0-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:88f9fb0116fbfcefcab70f85cf4b74a2b6ce5d199c41345296f49d974ddb4123", size = 95949, upload-time = "2026-03-01T22:06:25.697Z" }, { url = "https://files.pythonhosted.org/packages/68/03/093f4055ed4cae649ac53bca3d180bd37102e9e11d048588e9ab0c0108d0/yarl-1.23.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:e7b0460976dc75cb87ad9cc1f9899a4b97751e7d4e77ab840fc9b6d377b8fd24", size = 95839, upload-time = "2026-03-01T22:06:27.309Z" }, { url = "https://files.pythonhosted.org/packages/b9/28/4c75ebb108f322aa8f917ae10a8ffa4f07cae10a8a627b64e578617df6a0/yarl-1.23.0-cp313-cp313t-musllinux_1_2_armv7l.whl", hash = "sha256:115136c4a426f9da976187d238e84139ff6b51a20839aa6e3720cd1026d768de", size = 90696, upload-time = "2026-03-01T22:06:29.048Z" }, { url = "https://files.pythonhosted.org/packages/23/9c/42c2e2dd91c1a570402f51bdf066bfdb1241c2240ba001967bad778e77b7/yarl-1.23.0-cp313-cp313t-musllinux_1_2_ppc64le.whl", hash = "sha256:ead11956716a940c1abc816b7df3fa2b84d06eaed8832ca32f5c5e058c65506b", size = 100865, upload-time = "2026-03-01T22:06:30.525Z" }, { url = "https://files.pythonhosted.org/packages/74/05/1bcd60a8a0a914d462c305137246b6f9d167628d73568505fce3f1cb2e65/yarl-1.23.0-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:fe8f8f5e70e6dbdfca9882cd9deaac058729bcf323cf7a58660901e55c9c94f6", size = 96234, upload-time = "2026-03-01T22:06:32.692Z" }, { url = "https://files.pythonhosted.org/packages/90/b2/f52381aac396d6778ce516b7bc149c79e65bfc068b5de2857ab69eeea3b7/yarl-1.23.0-cp313-cp313t-musllinux_1_2_s390x.whl", hash = "sha256:a0e317df055958a0c1e79e5d2aa5a5eaa4a6d05a20d4b0c9c3f48918139c9fc6", size = 100295, upload-time = "2026-03-01T22:06:34.268Z" }, { url = "https://files.pythonhosted.org/packages/e5/e8/638bae5bbf1113a659b2435d8895474598afe38b4a837103764f603aba56/yarl-1.23.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:6f0fd84de0c957b2d280143522c4f91a73aada1923caee763e24a2b3fda9f8a5", size = 97784, upload-time = "2026-03-01T22:06:35.864Z" }, { url = "https://files.pythonhosted.org/packages/80/25/a3892b46182c586c202629fc2159aa13975d3741d52ebd7347fd501d48d5/yarl-1.23.0-cp313-cp313t-win32.whl", hash = "sha256:93a784271881035ab4406a172edb0faecb6e7d00f4b53dc2f55919d6c9688595", size = 88313, upload-time = "2026-03-01T22:06:37.39Z" }, { url = "https://files.pythonhosted.org/packages/43/68/8c5b36aa5178900b37387937bc2c2fe0e9505537f713495472dcf6f6fccc/yarl-1.23.0-cp313-cp313t-win_amd64.whl", hash = "sha256:dd00607bffbf30250fe108065f07453ec124dbf223420f57f5e749b04295e090", size = 94932, upload-time = "2026-03-01T22:06:39.579Z" }, { url = "https://files.pythonhosted.org/packages/c6/cc/d79ba8292f51f81f4dc533a8ccfb9fc6992cabf0998ed3245de7589dc07c/yarl-1.23.0-cp313-cp313t-win_arm64.whl", hash = "sha256:ac09d42f48f80c9ee1635b2fcaa819496a44502737660d3c0f2ade7526d29144", size = 84786, upload-time = "2026-03-01T22:06:41.988Z" }, { url = "https://files.pythonhosted.org/packages/90/98/b85a038d65d1b92c3903ab89444f48d3cee490a883477b716d7a24b1a78c/yarl-1.23.0-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:21d1b7305a71a15b4794b5ff22e8eef96ff4a6d7f9657155e5aa419444b28912", size = 124455, upload-time = "2026-03-01T22:06:43.615Z" }, { url = "https://files.pythonhosted.org/packages/39/54/bc2b45559f86543d163b6e294417a107bb87557609007c007ad889afec18/yarl-1.23.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:85610b4f27f69984932a7abbe52703688de3724d9f72bceb1cca667deff27474", size = 86752, upload-time = "2026-03-01T22:06:45.425Z" }, { url = "https://files.pythonhosted.org/packages/24/f9/e8242b68362bffe6fb536c8db5076861466fc780f0f1b479fc4ffbebb128/yarl-1.23.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:23f371bd662cf44a7630d4d113101eafc0cfa7518a2760d20760b26021454719", size = 86291, upload-time = "2026-03-01T22:06:46.974Z" }, { url = "https://files.pythonhosted.org/packages/ea/d8/d1cb2378c81dd729e98c716582b1ccb08357e8488e4c24714658cc6630e8/yarl-1.23.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c4a80f77dc1acaaa61f0934176fccca7096d9b1ff08c8ba9cddf5ae034a24319", size = 99026, upload-time = "2026-03-01T22:06:48.459Z" }, { url = "https://files.pythonhosted.org/packages/0a/ff/7196790538f31debe3341283b5b0707e7feb947620fc5e8236ef28d44f72/yarl-1.23.0-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:bd654fad46d8d9e823afbb4f87c79160b5a374ed1ff5bde24e542e6ba8f41434", size = 92355, upload-time = "2026-03-01T22:06:50.306Z" }, { url = "https://files.pythonhosted.org/packages/c1/56/25d58c3eddde825890a5fe6aa1866228377354a3c39262235234ab5f616b/yarl-1.23.0-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:682bae25f0a0dd23a056739f23a134db9f52a63e2afd6bfb37ddc76292bbd723", size = 106417, upload-time = "2026-03-01T22:06:52.1Z" }, { url = "https://files.pythonhosted.org/packages/51/8a/882c0e7bc8277eb895b31bce0138f51a1ba551fc2e1ec6753ffc1e7c1377/yarl-1.23.0-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a82836cab5f197a0514235aaf7ffccdc886ccdaa2324bc0aafdd4ae898103039", size = 106422, upload-time = "2026-03-01T22:06:54.424Z" }, { url = "https://files.pythonhosted.org/packages/42/2b/fef67d616931055bf3d6764885990a3ac647d68734a2d6a9e1d13de437a2/yarl-1.23.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c57676bdedc94cd3bc37724cf6f8cd2779f02f6aba48de45feca073e714fe52", size = 101915, upload-time = "2026-03-01T22:06:55.895Z" }, { url = "https://files.pythonhosted.org/packages/18/6a/530e16aebce27c5937920f3431c628a29a4b6b430fab3fd1c117b26ff3f6/yarl-1.23.0-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:c7f8dc16c498ff06497c015642333219871effba93e4a2e8604a06264aca5c5c", size = 100690, upload-time = "2026-03-01T22:06:58.21Z" }, { url = "https://files.pythonhosted.org/packages/88/08/93749219179a45e27b036e03260fda05190b911de8e18225c294ac95bbc9/yarl-1.23.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:5ee586fb17ff8f90c91cf73c6108a434b02d69925f44f5f8e0d7f2f260607eae", size = 98750, upload-time = "2026-03-01T22:06:59.794Z" }, { url = "https://files.pythonhosted.org/packages/d9/cf/ea424a004969f5d81a362110a6ac1496d79efdc6d50c2c4b2e3ea0fc2519/yarl-1.23.0-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:17235362f580149742739cc3828b80e24029d08cbb9c4bda0242c7b5bc610a8e", size = 94685, upload-time = "2026-03-01T22:07:01.375Z" }, { url = "https://files.pythonhosted.org/packages/e2/b7/14341481fe568e2b0408bcf1484c652accafe06a0ade9387b5d3fd9df446/yarl-1.23.0-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:0793e2bd0cf14234983bbb371591e6bea9e876ddf6896cdcc93450996b0b5c85", size = 106009, upload-time = "2026-03-01T22:07:03.151Z" }, { url = "https://files.pythonhosted.org/packages/0a/e6/5c744a9b54f4e8007ad35bce96fbc9218338e84812d36f3390cea616881a/yarl-1.23.0-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:3650dc2480f94f7116c364096bc84b1d602f44224ef7d5c7208425915c0475dd", size = 100033, upload-time = "2026-03-01T22:07:04.701Z" }, { url = "https://files.pythonhosted.org/packages/0c/23/e3bfc188d0b400f025bc49d99793d02c9abe15752138dcc27e4eaf0c4a9e/yarl-1.23.0-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:f40e782d49630ad384db66d4d8b73ff4f1b8955dc12e26b09a3e3af064b3b9d6", size = 106483, upload-time = "2026-03-01T22:07:06.231Z" }, { url = "https://files.pythonhosted.org/packages/72/42/f0505f949a90b3f8b7a363d6cbdf398f6e6c58946d85c6d3a3bc70595b26/yarl-1.23.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:94f8575fbdf81749008d980c17796097e645574a3b8c28ee313931068dad14fe", size = 102175, upload-time = "2026-03-01T22:07:08.4Z" }, { url = "https://files.pythonhosted.org/packages/aa/65/b39290f1d892a9dd671d1c722014ca062a9c35d60885d57e5375db0404b5/yarl-1.23.0-cp314-cp314-win32.whl", hash = "sha256:c8aa34a5c864db1087d911a0b902d60d203ea3607d91f615acd3f3108ac32169", size = 83871, upload-time = "2026-03-01T22:07:09.968Z" }, { url = "https://files.pythonhosted.org/packages/a9/5b/9b92f54c784c26e2a422e55a8d2607ab15b7ea3349e28359282f84f01d43/yarl-1.23.0-cp314-cp314-win_amd64.whl", hash = "sha256:63e92247f383c85ab00dd0091e8c3fa331a96e865459f5ee80353c70a4a42d70", size = 89093, upload-time = "2026-03-01T22:07:11.501Z" }, { url = "https://files.pythonhosted.org/packages/e0/7d/8a84dc9381fd4412d5e7ff04926f9865f6372b4c2fd91e10092e65d29eb8/yarl-1.23.0-cp314-cp314-win_arm64.whl", hash = "sha256:70efd20be968c76ece7baa8dafe04c5be06abc57f754d6f36f3741f7aa7a208e", size = 83384, upload-time = "2026-03-01T22:07:13.069Z" }, { url = "https://files.pythonhosted.org/packages/dd/8d/d2fad34b1c08aa161b74394183daa7d800141aaaee207317e82c790b418d/yarl-1.23.0-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:9a18d6f9359e45722c064c97464ec883eb0e0366d33eda61cb19a244bf222679", size = 131019, upload-time = "2026-03-01T22:07:14.903Z" }, { url = "https://files.pythonhosted.org/packages/19/ff/33009a39d3ccf4b94d7d7880dfe17fb5816c5a4fe0096d9b56abceea9ac7/yarl-1.23.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:2803ed8b21ca47a43da80a6fd1ed3019d30061f7061daa35ac54f63933409412", size = 89894, upload-time = "2026-03-01T22:07:17.372Z" }, { url = "https://files.pythonhosted.org/packages/0c/f1/dab7ac5e7306fb79c0190766a3c00b4cb8d09a1f390ded68c85a5934faf5/yarl-1.23.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:394906945aa8b19fc14a61cf69743a868bb8c465efe85eee687109cc540b98f4", size = 89979, upload-time = "2026-03-01T22:07:19.361Z" }, { url = "https://files.pythonhosted.org/packages/aa/b1/08e95f3caee1fad6e65017b9f26c1d79877b502622d60e517de01e72f95d/yarl-1.23.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:71d006bee8397a4a89f469b8deb22469fe7508132d3c17fa6ed871e79832691c", size = 95943, upload-time = "2026-03-01T22:07:21.266Z" }, { url = "https://files.pythonhosted.org/packages/c0/cc/6409f9018864a6aa186c61175b977131f373f1988e198e031236916e87e4/yarl-1.23.0-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:62694e275c93d54f7ccedcfef57d42761b2aad5234b6be1f3e3026cae4001cd4", size = 88786, upload-time = "2026-03-01T22:07:23.129Z" }, { url = "https://files.pythonhosted.org/packages/76/40/cc22d1d7714b717fde2006fad2ced5efe5580606cb059ae42117542122f3/yarl-1.23.0-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:a31de1613658308efdb21ada98cbc86a97c181aa050ba22a808120bb5be3ab94", size = 101307, upload-time = "2026-03-01T22:07:24.689Z" }, { url = "https://files.pythonhosted.org/packages/8f/0d/476c38e85ddb4c6ec6b20b815bdd779aa386a013f3d8b85516feee55c8dc/yarl-1.23.0-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:fb1e8b8d66c278b21d13b0a7ca22c41dd757a7c209c6b12c313e445c31dd3b28", size = 100904, upload-time = "2026-03-01T22:07:26.287Z" }, { url = "https://files.pythonhosted.org/packages/72/32/0abe4a76d59adf2081dcb0397168553ece4616ada1c54d1c49d8936c74f8/yarl-1.23.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:50f9d8d531dfb767c565f348f33dd5139a6c43f5cbdf3f67da40d54241df93f6", size = 97728, upload-time = "2026-03-01T22:07:27.906Z" }, { url = "https://files.pythonhosted.org/packages/b7/35/7b30f4810fba112f60f5a43237545867504e15b1c7647a785fbaf588fac2/yarl-1.23.0-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:575aa4405a656e61a540f4a80eaa5260f2a38fff7bfdc4b5f611840d76e9e277", size = 95964, upload-time = "2026-03-01T22:07:30.198Z" }, { url = "https://files.pythonhosted.org/packages/2d/86/ed7a73ab85ef00e8bb70b0cb5421d8a2a625b81a333941a469a6f4022828/yarl-1.23.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:041b1a4cefacf65840b4e295c6985f334ba83c30607441ae3cf206a0eed1a2e4", size = 95882, upload-time = "2026-03-01T22:07:32.132Z" }, { url = "https://files.pythonhosted.org/packages/19/90/d56967f61a29d8498efb7afb651e0b2b422a1e9b47b0ab5f4e40a19b699b/yarl-1.23.0-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:d38c1e8231722c4ce40d7593f28d92b5fc72f3e9774fe73d7e800ec32299f63a", size = 90797, upload-time = "2026-03-01T22:07:34.404Z" }, { url = "https://files.pythonhosted.org/packages/72/00/8b8f76909259f56647adb1011d7ed8b321bcf97e464515c65016a47ecdf0/yarl-1.23.0-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:d53834e23c015ee83a99377db6e5e37d8484f333edb03bd15b4bc312cc7254fb", size = 101023, upload-time = "2026-03-01T22:07:35.953Z" }, { url = "https://files.pythonhosted.org/packages/ac/e2/cab11b126fb7d440281b7df8e9ddbe4851e70a4dde47a202b6642586b8d9/yarl-1.23.0-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:2e27c8841126e017dd2a054a95771569e6070b9ee1b133366d8b31beb5018a41", size = 96227, upload-time = "2026-03-01T22:07:37.594Z" }, { url = "https://files.pythonhosted.org/packages/c2/9b/2c893e16bfc50e6b2edf76c1a9eb6cb0c744346197e74c65e99ad8d634d0/yarl-1.23.0-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:76855800ac56f878847a09ce6dba727c93ca2d89c9e9d63002d26b916810b0a2", size = 100302, upload-time = "2026-03-01T22:07:39.334Z" }, { url = "https://files.pythonhosted.org/packages/28/ec/5498c4e3a6d5f1003beb23405671c2eb9cdbf3067d1c80f15eeafe301010/yarl-1.23.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:e09fd068c2e169a7070d83d3bde728a4d48de0549f975290be3c108c02e499b4", size = 98202, upload-time = "2026-03-01T22:07:41.717Z" }, { url = "https://files.pythonhosted.org/packages/fe/c3/cd737e2d45e70717907f83e146f6949f20cc23cd4bf7b2688727763aa458/yarl-1.23.0-cp314-cp314t-win32.whl", hash = "sha256:73309162a6a571d4cbd3b6a1dcc703c7311843ae0d1578df6f09be4e98df38d4", size = 90558, upload-time = "2026-03-01T22:07:43.433Z" }, { url = "https://files.pythonhosted.org/packages/e1/19/3774d162f6732d1cfb0b47b4140a942a35ca82bb19b6db1f80e9e7bdc8f8/yarl-1.23.0-cp314-cp314t-win_amd64.whl", hash = "sha256:4503053d296bc6e4cbd1fad61cf3b6e33b939886c4f249ba7c78b602214fabe2", size = 97610, upload-time = "2026-03-01T22:07:45.773Z" }, { url = "https://files.pythonhosted.org/packages/51/47/3fa2286c3cb162c71cdb34c4224d5745a1ceceb391b2bd9b19b668a8d724/yarl-1.23.0-cp314-cp314t-win_arm64.whl", hash = "sha256:44bb7bef4ea409384e3f8bc36c063d77ea1b8d4a5b2706956c0d6695f07dcc25", size = 86041, upload-time = "2026-03-01T22:07:49.026Z" }, { url = "https://files.pythonhosted.org/packages/69/68/c8739671f5699c7dc470580a4f821ef37c32c4cb0b047ce223a7f115757f/yarl-1.23.0-py3-none-any.whl", hash = "sha256:a2df6afe50dea8ae15fa34c9f824a3ee958d785fd5d089063d960bae1daa0a3f", size = 48288, upload-time = "2026-03-01T22:07:51.388Z" }, ] [[package]] name = "zarr" source = { editable = "." } dependencies = [ { name = "donfig" }, { name = "google-crc32c" }, { name = "numcodecs" }, { name = "numpy" }, { name = "packaging" }, { name = "typing-extensions" }, ] [package.optional-dependencies] cast-value-rs = [ { name = "cast-value-rs" }, ] cli = [ { name = "typer" }, ] gpu = [ { name = "cupy-cuda12x", marker = "sys_platform != 'darwin'" }, ] optional = [ { name = "universal-pathlib" }, ] remote = [ { name = "fsspec" }, { name = "obstore" }, ] [package.dev-dependencies] dev = [ { name = "astroid" }, { name = "botocore" }, { name = "coverage" }, { name = "fsspec" }, { name = "griffe-inherited-docstrings" }, { name = "hypothesis" }, { name = "markdown-exec", extra = ["ansi"] }, { name = "mike" }, { name = "mkdocs" }, { name = "mkdocs-material", extra = ["imaging"] }, { name = "mkdocs-redirects" }, { name = "mkdocstrings" }, { name = "mkdocstrings-python" }, { name = "moto", extra = ["s3", "server"] }, { name = "mypy" }, { name = "numcodecs", extra = ["msgpack"] }, { name = "numpydoc" }, { name = "obstore" }, { name = "pytest" }, { name = "pytest-accept" }, { name = "pytest-asyncio" }, { name = "pytest-benchmark" }, { name = "pytest-codspeed" }, { name = "pytest-cov" }, { name = "pytest-xdist" }, { name = "requests" }, { name = "ruff" }, { name = "s3fs" }, { name = "tomlkit" }, { name = "towncrier" }, { name = "universal-pathlib" }, { name = "uv" }, ] docs = [ { name = "astroid" }, { name = "griffe-inherited-docstrings" }, { name = "markdown-exec", extra = ["ansi"] }, { name = "mike" }, { name = "mkdocs" }, { name = "mkdocs-material", extra = ["imaging"] }, { name = "mkdocs-redirects" }, { name = "mkdocstrings" }, { name = "mkdocstrings-python" }, { name = "numcodecs", extra = ["msgpack"] }, { name = "pytest" }, { name = "ruff" }, { name = "s3fs" }, { name = "towncrier" }, ] release = [ { name = "towncrier" }, ] remote-tests = [ { name = "botocore" }, { name = "coverage" }, { name = "fsspec" }, { name = "hypothesis" }, { name = "moto", extra = ["s3", "server"] }, { name = "numpydoc" }, { name = "obstore" }, { name = "pytest" }, { name = "pytest-accept" }, { name = "pytest-asyncio" }, { name = "pytest-benchmark" }, { name = "pytest-codspeed" }, { name = "pytest-cov" }, { name = "pytest-xdist" }, { name = "requests" }, { name = "s3fs" }, { name = "tomlkit" }, { name = "uv" }, ] test = [ { name = "coverage" }, { name = "hypothesis" }, { name = "numpydoc" }, { name = "pytest" }, { name = "pytest-accept" }, { name = "pytest-asyncio" }, { name = "pytest-benchmark" }, { name = "pytest-codspeed" }, { name = "pytest-cov" }, { name = "pytest-xdist" }, { name = "tomlkit" }, { name = "uv" }, ] [package.metadata] requires-dist = [ { name = "cast-value-rs", marker = "extra == 'cast-value-rs'" }, { name = "cupy-cuda12x", marker = "sys_platform != 'darwin' and extra == 'gpu'" }, { name = "donfig", specifier = ">=0.8" }, { name = "fsspec", marker = "extra == 'remote'", specifier = ">=2023.10.0" }, { name = "google-crc32c", specifier = ">=1.5" }, { name = "numcodecs", specifier = ">=0.14" }, { name = "numpy", specifier = ">=2" }, { name = "obstore", marker = "extra == 'remote'", specifier = ">=0.5.1" }, { name = "packaging", specifier = ">=22.0" }, { name = "typer", marker = "extra == 'cli'" }, { name = "typing-extensions", specifier = ">=4.14" }, { name = "universal-pathlib", marker = "extra == 'optional'" }, ] provides-extras = ["cast-value-rs", "cli", "gpu", "optional", "remote"] [package.metadata.requires-dev] dev = [ { name = "astroid", specifier = "==4.1.2" }, { name = "botocore" }, { name = "coverage", specifier = "==7.15.2" }, { name = "fsspec", specifier = ">=2023.10.0" }, { name = "griffe-inherited-docstrings", specifier = "==1.1.3" }, { name = "hypothesis", specifier = "==6.160.0" }, { name = "markdown-exec", extras = ["ansi"], specifier = "==1.12.3" }, { name = "mike", specifier = "==2.2.0" }, { name = "mkdocs", specifier = "==1.6.1" }, { name = "mkdocs-material", extras = ["imaging"], specifier = "==9.7.7" }, { name = "mkdocs-redirects", specifier = "==1.2.3" }, { name = "mkdocstrings", specifier = "==1.0.6" }, { name = "mkdocstrings-python", specifier = "==2.0.5" }, { name = "moto", extras = ["s3", "server"], specifier = "==5.2.2" }, { name = "mypy", specifier = "==2.3.0" }, { name = "numcodecs", extras = ["msgpack"] }, { name = "numpydoc", specifier = "==1.10.0" }, { name = "obstore", specifier = ">=0.5.1" }, { name = "pytest", specifier = "==9.1.1" }, { name = "pytest-accept", specifier = "==0.3.0" }, { name = "pytest-asyncio", specifier = "==1.4.0" }, { name = "pytest-benchmark", specifier = "==5.2.3" }, { name = "pytest-codspeed", specifier = "==5.0.3" }, { name = "pytest-cov", specifier = "==7.1.0" }, { name = "pytest-xdist", specifier = "==3.8.0" }, { name = "requests", specifier = "==2.34.2" }, { name = "ruff", specifier = "==0.15.22" }, { name = "s3fs", specifier = ">=2023.10.0" }, { name = "tomlkit", specifier = "==0.15.1" }, { name = "towncrier", specifier = "==25.8.0" }, { name = "universal-pathlib" }, { name = "uv", specifier = "==0.11.31" }, ] docs = [ { name = "astroid", specifier = "==4.1.2" }, { name = "griffe-inherited-docstrings", specifier = "==1.1.3" }, { name = "markdown-exec", extras = ["ansi"], specifier = "==1.12.3" }, { name = "mike", specifier = "==2.2.0" }, { name = "mkdocs", specifier = "==1.6.1" }, { name = "mkdocs-material", extras = ["imaging"], specifier = "==9.7.7" }, { name = "mkdocs-redirects", specifier = "==1.2.3" }, { name = "mkdocstrings", specifier = "==1.0.6" }, { name = "mkdocstrings-python", specifier = "==2.0.5" }, { name = "numcodecs", extras = ["msgpack"] }, { name = "pytest", specifier = "==9.1.1" }, { name = "ruff", specifier = "==0.15.22" }, { name = "s3fs", specifier = ">=2023.10.0" }, { name = "towncrier", specifier = "==25.8.0" }, ] release = [{ name = "towncrier", specifier = "==25.8.0" }] remote-tests = [ { name = "botocore" }, { name = "coverage", specifier = "==7.15.2" }, { name = "fsspec", specifier = ">=2023.10.0" }, { name = "hypothesis", specifier = "==6.160.0" }, { name = "moto", extras = ["s3", "server"], specifier = "==5.2.2" }, { name = "numpydoc", specifier = "==1.10.0" }, { name = "obstore", specifier = ">=0.5.1" }, { name = "pytest", specifier = "==9.1.1" }, { name = "pytest-accept", specifier = "==0.3.0" }, { name = "pytest-asyncio", specifier = "==1.4.0" }, { name = "pytest-benchmark", specifier = "==5.2.3" }, { name = "pytest-codspeed", specifier = "==5.0.3" }, { name = "pytest-cov", specifier = "==7.1.0" }, { name = "pytest-xdist", specifier = "==3.8.0" }, { name = "requests", specifier = "==2.34.2" }, { name = "s3fs", specifier = ">=2023.10.0" }, { name = "tomlkit", specifier = "==0.15.1" }, { name = "uv", specifier = "==0.11.31" }, ] test = [ { name = "coverage", specifier = "==7.15.2" }, { name = "hypothesis", specifier = "==6.160.0" }, { name = "numpydoc", specifier = "==1.10.0" }, { name = "pytest", specifier = "==9.1.1" }, { name = "pytest-accept", specifier = "==0.3.0" }, { name = "pytest-asyncio", specifier = "==1.4.0" }, { name = "pytest-benchmark", specifier = "==5.2.3" }, { name = "pytest-codspeed", specifier = "==5.0.3" }, { name = "pytest-cov", specifier = "==7.1.0" }, { name = "pytest-xdist", specifier = "==3.8.0" }, { name = "tomlkit", specifier = "==0.15.1" }, { name = "uv", specifier = "==0.11.31" }, ]