Skip to content

Commit 5506801

Browse files
committed
Merge branch 'main' of github.com:zarr-developers/zarr-python into keyword-only
2 parents 066fd3a + 9d97b24 commit 5506801

151 files changed

Lines changed: 13376 additions & 10958 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Contributing
22
============
33

4-
Please see the [project documentation](https://zarr.readthedocs.io/en/stable/contributing.html) for information about contributing to Zarr.
4+
Please see the [project documentation](https://zarr.readthedocs.io/en/stable/developers/contributing.html) for information about contributing to Zarr.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Zarr-Python release checklist
3+
about: Checklist for a new Zarr-Python release. [For project maintainers only!]
4+
title: Release Zarr-Python vX.Y.Z
5+
labels: release-checklist
6+
assignees: ''
7+
8+
---
9+
10+
**Release**: [v0.x.x](https://github.com/zarr-developers/zarr-python/milestones/?)
11+
**Scheduled Date**: 20YY/MM/DD
12+
13+
**Priority PRs/issues to complete prior to release**
14+
15+
- [ ] Priority pull request #X
16+
17+
**Before release**:
18+
19+
- [ ] Make sure that all pull requests which will be included in the release have been properly documented as changelog files in the [`changes/` directory](https://github.com/zarr-developers/zarr-python/tree/main/changes).
20+
- [ ] Run ``towncrier build --version x.y.z`` to create the changelog, and commit the result to the main branch.
21+
- [ ] 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.
22+
- [ ] Check to ensure that:
23+
- [ ] Deprecated workarounds/codes/tests are removed. Run `grep "# TODO" **/*.py` to find all potential TODOs.
24+
- [ ] All tests pass in the ["Tests" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/test.yml).
25+
- [ ] All tests pass in the ["GPU Tests" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/gpu_test.yml).
26+
- [ ] All tests pass in the ["Hypothesis" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/hypothesis.yaml).
27+
- [ ] Check that downstream libraries work well (maintainers can make executive decisions about whether all checks are required for this release).
28+
- [ ] Xarray (@jhamman @dcherian @TomNicholas)
29+
- Zarr's upstream compatibility is tested via the [Upstream Dev CI worklow](https://github.com/pydata/xarray/actions/workflows/upstream-dev-ci.yaml).
30+
- Click on the most recent workflow and check that the `upstream-dev` job has run and passed. `upstream-dev` is not run on all all workflow runs.
31+
- Check that the expected version of Zarr-Python was tested using the `Version Info` step of the `upstream-dev` job.
32+
- If testing on a branch other than `main` is needed, open a PR modifying https://github.com/pydata/xarray/blob/90ee30943aedba66a37856b2332a41264e288c20/ci/install-upstream-wheels.sh#L56 and add the `run-upstream` label.
33+
- [ ] Titiler.Xarray (@maxrjones)
34+
- [Modify dependencies](https://github.com/developmentseed/titiler/blob/main/src/titiler/xarray/pyproject.toml) for titiler.xarray.
35+
- Modify triggers for running [the test workflow](https://github.com/developmentseed/titiler/blob/61549f2de07b20cca8fb991cfcdc89b23e18ad05/.github/workflows/ci.yml#L5-L7).
36+
- Push the branch to the repository and check for the actions for any failures.
37+
38+
**Release**:
39+
40+
- [ ] Go to https://github.com/zarr-developers/zarr-python/releases.
41+
- [ ] Click "Draft a new release".
42+
- [ ] Choose a version number prefixed with a `v` (e.g. `v0.0.0`). For pre-releases, include the appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`).
43+
- [ ] Set the description of the release to: `See release notes https://zarr.readthedocs.io/en/stable/release-notes.html#release-0-0-0`, replacing the correct version numbers. For pre-release versions, the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
44+
- [ ] Click on "Generate release notes" to auto-fill the description.
45+
- [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too.
46+
- [ ] Verify that release workflows succeeded.
47+
- [ ] The latest version is correct on [PyPI](https://pypi.org/project/zarr/).
48+
- [ ] The stable version is correct on [ReadTheDocs](https://zarr.readthedocs.io/en/stable/).
49+
50+
**After release**:
51+
52+
- [ ] Review and merge the pull request on the conda-forge [zarr-feedstock](https://github.com/conda-forge/zarr-feedstock) that will be automatically generated.
53+
54+
---
55+
56+
- [ ] Party :tada:

.github/codecov.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

.github/workflows/gpu_test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
strategy:
2626
matrix:
2727
python-version: ['3.11']
28-
numpy-version: ['2.1']
28+
numpy-version: ['2.2']
2929
dependency-set: ["minimal"]
3030

3131
steps:

.github/workflows/hypothesis.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
name: Slow Hypothesis CI
22
on:
33
push:
4-
branches:
5-
- "main"
4+
branches: [main, 3.0.x]
65
pull_request:
7-
branches:
8-
- "main"
6+
branches: [main, 3.0.x]
97
types: [opened, reopened, synchronize, labeled]
108
schedule:
119
- cron: "0 0 * * *" # Daily “At 00:00” UTC
@@ -25,12 +23,19 @@ jobs:
2523

2624
strategy:
2725
matrix:
28-
python-version: ['3.11']
29-
numpy-version: ['2.1']
26+
python-version: ['3.12']
27+
numpy-version: ['2.2']
3028
dependency-set: ["optional"]
3129

3230
steps:
3331
- uses: actions/checkout@v4
32+
- name: Set HYPOTHESIS_PROFILE based on trigger
33+
run: |
34+
if [[ "${{ github.event_name }}" == "schedule" || "${{ github.event_name }}" == "workflow_dispatch" ]]; then
35+
echo "HYPOTHESIS_PROFILE=nightly" >> $GITHUB_ENV
36+
else
37+
echo "HYPOTHESIS_PROFILE=ci" >> $GITHUB_ENV
38+
fi
3439
- name: Set up Python
3540
uses: actions/setup-python@v5
3641
with:
@@ -58,6 +63,7 @@ jobs:
5863
if: success()
5964
id: status
6065
run: |
66+
echo "Using Hypothesis profile: $HYPOTHESIS_PROFILE"
6167
hatch env run --env test.py${{ matrix.python-version }}-${{ matrix.numpy-version }}-${{ matrix.dependency-set }} run-hypothesis
6268
6369
# explicitly save the cache so it gets updated, also do this even if it fails.

.github/workflows/test.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: Test
55

66
on:
77
push:
8-
branches: [ main ]
8+
branches: [ main, 3.0.x ]
99
pull_request:
10-
branches: [ main ]
10+
branches: [ main, 3.0.x ]
1111
workflow_dispatch:
1212

1313
concurrency:
@@ -21,7 +21,7 @@ jobs:
2121
strategy:
2222
matrix:
2323
python-version: ['3.11', '3.12', '3.13']
24-
numpy-version: ['1.25', '2.1']
24+
numpy-version: ['1.25', '2.2']
2525
dependency-set: ["minimal", "optional"]
2626
os: ["ubuntu-latest"]
2727
include:
@@ -30,15 +30,15 @@ jobs:
3030
dependency-set: 'optional'
3131
os: 'macos-latest'
3232
- python-version: '3.13'
33-
numpy-version: '2.1'
33+
numpy-version: '2.2'
3434
dependency-set: 'optional'
3535
os: 'macos-latest'
3636
- python-version: '3.11'
3737
numpy-version: '1.25'
3838
dependency-set: 'optional'
3939
os: 'windows-latest'
4040
- python-version: '3.13'
41-
numpy-version: '2.1'
41+
numpy-version: '2.2'
4242
dependency-set: 'optional'
4343
os: 'windows-latest'
4444
runs-on: ${{ matrix.os }}
@@ -61,6 +61,8 @@ jobs:
6161
hatch env create test.py${{ matrix.python-version }}-${{ matrix.numpy-version }}-${{ matrix.dependency-set }}
6262
hatch env run -e test.py${{ matrix.python-version }}-${{ matrix.numpy-version }}-${{ matrix.dependency-set }} list-env
6363
- name: Run Tests
64+
env:
65+
HYPOTHESIS_PROFILE: ci
6466
run: |
6567
hatch env run --env test.py${{ matrix.python-version }}-${{ matrix.numpy-version }}-${{ matrix.dependency-set }} run-coverage
6668
- name: Upload coverage
@@ -102,7 +104,7 @@ jobs:
102104
hatch env run -e ${{ matrix.dependency-set }} list-env
103105
- name: Run Tests
104106
run: |
105-
hatch env run --env ${{ matrix.dependency-set }} run
107+
hatch env run --env ${{ matrix.dependency-set }} run-coverage
106108
- name: Upload coverage
107109
uses: codecov/codecov-action@v5
108110
with:

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ci:
66
default_stages: [pre-commit, pre-push]
77
repos:
88
- repo: https://github.com/astral-sh/ruff-pre-commit
9-
rev: v0.11.9
9+
rev: v0.12.2
1010
hooks:
11-
- id: ruff
11+
- id: ruff-check
1212
args: ["--fix", "--show-fixes"]
1313
- id: ruff-format
1414
- repo: https://github.com/codespell-project/codespell
@@ -22,7 +22,7 @@ repos:
2222
- id: check-yaml
2323
- id: trailing-whitespace
2424
- repo: https://github.com/pre-commit/mirrors-mypy
25-
rev: v1.15.0
25+
rev: v1.16.1
2626
hooks:
2727
- id: mypy
2828
files: src|tests

bench/compress_normal.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import sys
22
import timeit
33

4+
import blosc
45
import line_profiler
56
import numpy as np
67

78
import zarr
8-
from zarr import blosc
99

1010
if __name__ == "__main__":
1111
sys.path.insert(0, "..")

changes/2819.chore.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Ensure that invocations of ``create_array`` use consistent keyword arguments, with consistent defaults.
2+
Specifically, ``zarr.api.synchronous.create_array`` now takes a ``write_data`` keyword argument; The
3+
``create_array`` method on ``zarr.Group`` takes ``data`` and ``write_data`` keyword arguments. The ``fill_value``
4+
keyword argument of the various invocations of ``create_array`` has been consistently set to ``None``, where previously it was either ``None`` or ``0``.

changes/2871.feature.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Added public API for Buffer ABCs and implementations.
2+
3+
Use :mod:`zarr.buffer` to access buffer implementations, and
4+
:mod:`zarr.abc.buffer` for the interface to implement new buffer types.
5+
6+
Users previously importing buffer from ``zarr.core.buffer`` should update their
7+
imports to use :mod:`zarr.buffer`. As a reminder, all of ``zarr.core`` is
8+
considered a private API that's not covered by zarr-python's versioning policy.

0 commit comments

Comments
 (0)