Replace donfig with a statically-typed configuration object

changes/4101.misc.md

@@ -0,0 +1,12 @@
+Replaced the `donfig`-based configuration with a statically-typed
+configuration object. `zarr.config` now provides precise static types for
+attribute access (`zarr.config.array.order`) and for the dotted-string API
+(`zarr.config.get("array.order")`). The string API, environment-variable
+ingestion (`ZARR_FOO__BAR`), YAML config files, `config.set` (permanent and
+as a context manager), `config.reset`, `config.enable_gpu`, and the
+`deprecations` mechanism are all preserved. The `donfig` dependency has been
+removed.
+
+Note: `zarr.config.defaults` now returns a nested `dict` directly; donfig
+previously returned a one-element `list[dict]`, so callers that used
+`config.defaults[0]` must be updated to use `config.defaults`.

docs/user-guide/config.md

@@ -1,7 +1,8 @@
 # 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.
+[`zarr.config`][] is a `ZarrConfigManager` instance that manages all runtime
+settings for zarr.  It provides both typed attribute access and a dotted-string
+key API.
 
 Configuration values can be set using code like the following:
 
@@ -18,12 +19,13 @@ zarr.config.set({'array.order': 'F'})
 print(zarr.config.get('array.order'))
 ```
 
-Alternatively, configuration values can be set using environment variables, e.g.
+Alternatively, configuration values can be set using environment variables.
+The variable name uses a `ZARR_` prefix, with `__` to denote nesting, 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/).
+The configuration can also be read from YAML files.  Place a `zarr.yaml` (or
+any `.yaml`/`.yml` file) in `~/.config/zarr/`, or point the `ZARR_CONFIG`
+environment variable at a specific file path.
 
 Configuration options include the following:
 
@@ -46,8 +48,5 @@ 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())
+pprint(zarr.config.to_dict())
 ```

docs/user-guide/installation.md

@@ -10,7 +10,7 @@ Required dependencies include:
 - [numcodecs](https://numcodecs.readthedocs.io) (0.14 or later)
 - [google-crc32c](https://github.com/googleapis/python-crc32c) (1.5 or later)
 - [typing_extensions](https://typing-extensions.readthedocs.io) (4.9 or later)
-- [donfig](https://donfig.readthedocs.io) (0.8 or later)
+- [pyyaml](https://pyyaml.org) (6 or later)
 
 ## pip
 

pyproject.toml

@@ -36,7 +36,7 @@ dependencies = [
     'numcodecs>=0.14',
     'google-crc32c>=1.5',
     'typing_extensions>=4.14',
-    'donfig>=0.8',
+    'pyyaml>=6',
 ]
 
 dynamic = [
@@ -242,7 +242,6 @@ extra-dependencies = [
     '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',
 ]
 
@@ -268,7 +267,7 @@ extra-dependencies = [
     's3fs==2023.10.0',
     'universal_pathlib==0.2.0',
     'typing_extensions==4.14.*',
-    'donfig==0.8.*',
+    'pyyaml==6.*',
     'obstore==0.5.*',
 ]
 

src/zarr/__init__.py

@@ -68,7 +68,7 @@ def print_packages(packages: list[str]) -> None:
         "numpy",
         "numcodecs",
         "typing_extensions",
-        "donfig",
+        "pyyaml",
     ]
     optional = [
         "botocore",