Skip to content

Commit 10bcc97

Browse files
vup903claude
andcommitted
refactor: hoist json_parse imports to module level (zarr-developers#3285)
These were function-local to dodge import cycles under the old hand-written parse_json. After the msgspec rewrite json_parse's only zarr import is JSON under TYPE_CHECKING, so it has no runtime zarr dependency and cannot form a cycle. Verified each touched module still imports standalone. Hoisting exposed a latent packaging gap: msgspec was added to pyproject.toml but never locked, so uv.lock lacked it. That stayed hidden only because json_parse was imported lazily; at module level it broke `uv run --frozen` (ModuleNotFoundError in the docs job). Regenerated the lock, which adds msgspec 0.21.1 and nothing else. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
1 parent cccd69e commit 10bcc97

10 files changed

Lines changed: 52 additions & 34 deletions

File tree

‎src/zarr/codecs/blosc.py‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
from zarr.core.buffer.cpu import as_numpy_array_wrapper
1515
from zarr.core.common import JSON, NamedRequiredConfig, parse_named_configuration
1616
from zarr.core.dtype.common import HasItemSize
17+
from zarr.core.json_parse import parse_field
1718

1819
if TYPE_CHECKING:
1920
from typing import Self
@@ -104,8 +105,6 @@ class BloscCname(metaclass=_DeprecatedStrEnumMeta):
104105

105106

106107
def parse_typesize(data: JSON) -> int:
107-
from zarr.core.json_parse import parse_field
108-
109108
parsed: int = parse_field(data, int, "typesize", error=TypeError)
110109
if parsed > 0:
111110
return parsed
@@ -117,15 +116,11 @@ def parse_typesize(data: JSON) -> int:
117116

118117
# todo: real validation
119118
def parse_clevel(data: JSON) -> int:
120-
from zarr.core.json_parse import parse_field
121-
122119
parsed: int = parse_field(data, int, "clevel", error=TypeError)
123120
return parsed
124121

125122

126123
def parse_blocksize(data: JSON) -> int:
127-
from zarr.core.json_parse import parse_field
128-
129124
parsed: int = parse_field(data, int, "blocksize", error=TypeError)
130125
return parsed
131126

‎src/zarr/codecs/gzip.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
from zarr.abc.codec import BytesBytesCodec
1111
from zarr.core.buffer.cpu import as_numpy_array_wrapper
1212
from zarr.core.common import JSON, parse_named_configuration
13+
from zarr.core.json_parse import parse_field
1314

1415
if TYPE_CHECKING:
1516
from typing import Self
@@ -19,8 +20,6 @@
1920

2021

2122
def parse_gzip_level(data: JSON) -> int:
22-
from zarr.core.json_parse import parse_field
23-
2423
parsed: int = parse_field(data, int, "level", error=TypeError)
2524
if parsed not in range(10):
2625
raise ValueError(

‎src/zarr/codecs/zstd.py‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
from zarr.abc.codec import BytesBytesCodec
1313
from zarr.core.buffer.cpu import as_numpy_array_wrapper
1414
from zarr.core.common import JSON, parse_named_configuration
15+
from zarr.core.json_parse import parse_field
1516

1617
if TYPE_CHECKING:
1718
from typing import Self
@@ -21,17 +22,13 @@
2122

2223

2324
def parse_zstd_level(data: JSON) -> int:
24-
from zarr.core.json_parse import parse_field
25-
2625
parsed: int = parse_field(data, int, "level", error=TypeError)
2726
if parsed >= 23:
2827
raise ValueError(f"Value must be less than or equal to 22. Got {parsed} instead.")
2928
return parsed
3029

3130

3231
def parse_checksum(data: JSON) -> bool:
33-
from zarr.core.json_parse import parse_field
34-
3532
parsed: bool = parse_field(data, bool, "checksum", error=TypeError)
3633
return parsed
3734

‎src/zarr/core/chunk_key_encodings.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,13 @@
1313
NamedConfig,
1414
parse_named_configuration,
1515
)
16+
from zarr.core.json_parse import parse_field
1617
from zarr.registry import get_chunk_key_encoding_class, register_chunk_key_encoding
1718

1819
SeparatorLiteral = Literal[".", "/"]
1920

2021

2122
def parse_separator(data: JSON) -> SeparatorLiteral:
22-
from zarr.core.json_parse import parse_field
23-
2423
return cast("SeparatorLiteral", parse_field(data, Literal[".", "/"], "separator"))
2524

2625

‎src/zarr/core/common.py‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
from typing_extensions import ReadOnly
2121

2222
from zarr.core.config import config as zarr_config
23+
from zarr.core.json_parse import convert, parse_field
2324
from zarr.errors import ZarrRuntimeWarning
2425

2526
if TYPE_CHECKING:
@@ -147,8 +148,6 @@ def parse_enum[E: Enum](data: object, cls: type[E]) -> E:
147148

148149

149150
def parse_name(data: JSON, expected: str | None = None) -> str:
150-
from zarr.core.json_parse import convert
151-
152151
try:
153152
data = cast("str", convert(data, str))
154153
except (ValueError, TypeError) as exc:
@@ -230,14 +229,10 @@ def parse_fill_value(data: Any) -> Any:
230229

231230

232231
def parse_order(data: Any) -> Literal["C", "F"]:
233-
from zarr.core.json_parse import parse_field
234-
235232
return cast("Literal['C', 'F']", parse_field(data, Literal["C", "F"], "order"))
236233

237234

238235
def parse_bool(data: Any) -> bool:
239-
from zarr.core.json_parse import convert
240-
241236
return cast("bool", convert(data, bool))
242237

243238

‎src/zarr/core/config.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333

3434
from donfig import Config as DConfig
3535

36+
from zarr.core.json_parse import parse_field
37+
3638
if TYPE_CHECKING:
3739
from donfig.config_obj import ConfigSet
3840

@@ -159,6 +161,4 @@ def enable_gpu(self) -> ConfigSet:
159161

160162

161163
def parse_indexing_order(data: Any) -> Literal["C", "F"]:
162-
from zarr.core.json_parse import parse_field
163-
164164
return cast("Literal['C', 'F']", parse_field(data, Literal["C", "F"], "order"))

‎src/zarr/core/group.py‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
parse_shapelike,
4747
)
4848
from zarr.core.config import config
49+
from zarr.core.json_parse import parse_field
4950
from zarr.core.metadata import ArrayV2Metadata, ArrayV3Metadata
5051
from zarr.core.metadata.io import save_metadata
5152
from zarr.core.sync import SyncMixin, sync
@@ -85,15 +86,11 @@
8586

8687
def parse_zarr_format(data: Any) -> ZarrFormat:
8788
"""Parse the zarr_format field from metadata."""
88-
from zarr.core.json_parse import parse_field
89-
9089
return cast("ZarrFormat", parse_field(data, Literal[2, 3], "zarr_format"))
9190

9291

9392
def parse_node_type(data: Any) -> NodeType:
9493
"""Parse the node_type field from metadata."""
95-
from zarr.core.json_parse import parse_field
96-
9794
return cast(
9895
"Literal['array', 'group']",
9996
parse_field(data, Literal["array", "group"], "node_type", error=MetadataValidationError),

‎src/zarr/core/metadata/v2.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
parse_shapelike,
4242
)
4343
from zarr.core.config import config, parse_indexing_order
44+
from zarr.core.json_parse import parse_field
4445
from zarr.core.metadata.common import parse_attributes
4546

4647

@@ -280,8 +281,6 @@ def parse_dtype(data: npt.DTypeLike) -> np.dtype[Any]:
280281
def parse_zarr_format(data: object) -> Literal[2]:
281282
from typing import Literal
282283

283-
from zarr.core.json_parse import parse_field
284-
285284
return cast("Literal[2]", parse_field(data, Literal[2], "zarr_format"))
286285

287286

‎src/zarr/core/metadata/v3.py‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
from zarr.core.config import config
3535
from zarr.core.dtype import VariableLengthUTF8, ZDType, get_data_type_from_json
3636
from zarr.core.dtype.common import check_dtype_spec_v3
37+
from zarr.core.json_parse import parse_field, validate_json_value
3738
from zarr.core.metadata.common import parse_attributes
3839
from zarr.errors import MetadataValidationError, NodeTypeValidationError, UnknownCodecError
3940
from zarr.registry import get_codec_class
@@ -47,16 +48,12 @@
4748

4849

4950
def parse_zarr_format(data: object) -> Literal[3]:
50-
from zarr.core.json_parse import parse_field
51-
5251
return cast(
5352
"Literal[3]", parse_field(data, Literal[3], "zarr_format", error=MetadataValidationError)
5453
)
5554

5655

5756
def parse_node_type_array(data: object) -> Literal["array"]:
58-
from zarr.core.json_parse import parse_field
59-
6057
return cast(
6158
'Literal["array"]',
6259
parse_field(data, Literal["array"], "node_type", error=NodeTypeValidationError),
@@ -614,8 +611,6 @@ def to_buffer_dict(self, prototype: BufferPrototype) -> dict[str, Buffer]:
614611

615612
@classmethod
616613
def from_dict(cls, data: dict[str, JSON]) -> Self:
617-
from zarr.core.json_parse import validate_json_value
618-
619614
# make a copy because we are modifying the dict
620615
_data = data.copy()
621616

‎uv.lock‎

Lines changed: 42 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)