11from __future__ import annotations
22
33import json
4+ import warnings
45from typing import TYPE_CHECKING , Any
56
67import numpy as np
2223from zarr .core .group import ConsolidatedMetadata , GroupMetadata
2324from zarr .core .metadata import ArrayV3Metadata
2425from zarr .core .metadata .v2 import ArrayV2Metadata
25- from zarr .errors import MetadataValidationError , ZarrUserWarning
26+ from zarr .errors import MetadataValidationError , ZarrDeprecationWarning , ZarrUserWarning
2627from zarr .storage import StorePath
2728
2829if TYPE_CHECKING :
@@ -918,6 +919,7 @@ async def test_consolidated_metadata_case_differing_siblings(memory_store: Store
918919 "codecs" : [{"name" : "bytes" , "configuration" : {"endian" : "little" }}],
919920}
920921_GROUP_V3 = {"zarr_format" : 3 , "node_type" : "group" , "attributes" : {}}
922+ _GROUP_V2 = {"zarr_format" : 2 }
921923
922924
923925def _consolidated_doc (metadata : dict [str , Any ]) -> dict [str , Any ]:
@@ -926,14 +928,57 @@ def _consolidated_doc(metadata: dict[str, Any]) -> dict[str, Any]:
926928
927929@pytest .mark .parametrize (
928930 "key" ,
929- ["" , "." , ".." , "zarr.json" , "__a" , "a/zarr.json " , "a/../b " , "a//b " ],
931+ ["" , "a//b " , "/a " , "a/" ],
930932)
931933def test_consolidated_metadata_rejects_invalid_keys (key : str ) -> None :
932- """Listing keys are node paths; every segment must be a valid node name ."""
934+ """Listing keys are node paths; every segment must be non-empty ."""
933935 with pytest .raises (MetadataValidationError , match = "Invalid node path" ):
934936 ConsolidatedMetadata .from_dict (_consolidated_doc ({key : _GROUP_V3 }))
935937
936938
939+ @pytest .mark .parametrize (
940+ "key" ,
941+ ["." , ".." , "zarr.json" , "__a" , "a/zarr.json" , "a/__x" ],
942+ )
943+ def test_consolidated_metadata_warns_on_reserved_v3_keys (key : str ) -> None :
944+ """v3 reserves '.', '..', 'zarr.json', and '__'-prefixed names, but stores
945+ written before the names were rejected still open, so they only warn."""
946+ with pytest .warns (ZarrDeprecationWarning , match = "reserved" ):
947+ consolidated = ConsolidatedMetadata .from_dict (
948+ _consolidated_doc ({key : _GROUP_V3 , "a" : _GROUP_V3 })
949+ )
950+ if "/" in key :
951+ parent , leaf = key .split ("/" )
952+ nested = consolidated .metadata [parent ].consolidated_metadata
953+ assert nested is not None
954+ assert leaf in nested .metadata
955+ else :
956+ assert key in consolidated .metadata
957+
958+
959+ def test_consolidated_metadata_reserved_name_below_missing_parent () -> None :
960+ """A reserved name warns before the missing-parent error is raised."""
961+ with pytest .warns (ZarrDeprecationWarning , match = "reserved" ):
962+ with pytest .raises (MetadataValidationError , match = "without a listing" ):
963+ ConsolidatedMetadata .from_dict (
964+ _consolidated_doc ({"a" : _GROUP_V3 , "a/../b" : _GROUP_V3 })
965+ )
966+
967+
968+ @pytest .mark .parametrize (
969+ "key" ,
970+ ["." , ".." , "zarr.json" , "__a" ],
971+ )
972+ def test_consolidated_metadata_ignores_reserved_v2_keys (key : str ) -> None :
973+ """The v2 specification does not reserve node names."""
974+ with warnings .catch_warnings ():
975+ warnings .simplefilter ("error" )
976+ consolidated = ConsolidatedMetadata .from_dict (
977+ _consolidated_doc ({key : _GROUP_V2 })
978+ )
979+ assert key in consolidated .metadata
980+
981+
937982def test_consolidated_metadata_rejects_child_without_parent () -> None :
938983 """A listing for 'a/b' with no 'a' listing made the root group unopenable."""
939984 with pytest .raises (MetadataValidationError , match = "without a listing" ):
0 commit comments