pysdmx 1.11.0__py3-none-any.whl → 1.12.0__py3-none-any.whl

pysdmx/__init__.py

@@ -1,3 +1,3 @@
 """Your opinionated Python SDMX library."""
 
-__version__ = "1.11.0"
+__version__ = "1.12.0"

pysdmx/io/json/fusion/messages/constraint.py

@@ -1,6 +1,6 @@
 """Collection of Fusion-JSON schemas for content constraints."""
 
-from typing import Dict, Sequence
+from typing import Dict, List, Optional, Sequence
 
 from msgspec import Struct
 
@@ -11,11 +11,32 @@ class FusionKeyValue(Struct, frozen=True):
     values: Sequence[str]
 
 
+class FusionKeySet(Struct, frozen=True):
+    """Fusion-JSON payload for the list of allowed values per component."""
+
+    dims: Sequence[str]
+    rows: Sequence[Sequence[str]]
+
+
 class FusionContentConstraint(Struct, frozen=True):
     """Fusion-JSON payload for a content constraint."""
 
     includeCube: Dict[str, FusionKeyValue] = {}
+    includeSeries: Optional[FusionKeySet] = None
 
     def to_map(self) -> Dict[str, Sequence[str]]:
         """Gets the list of allowed values for a component."""
         return {k: v.values for k, v in self.includeCube.items()}
+
+    def get_series(self, dimensions: List[str]) -> Sequence[str]:
+        """Get the list of series defined in the keyset."""
+        if self.includeSeries:
+            series = []
+            for r in self.includeSeries.rows:
+                s = dict.fromkeys(dimensions, "*")
+                for idx, cd in enumerate(self.includeSeries.dims):
+                    s[cd] = r[idx]
+                series.append(".".join(s.values()))
+            return series
+        else:
+            return []

pysdmx/io/json/fusion/messages/dsd.py

@@ -163,6 +163,7 @@ class FusionDimension(Struct, frozen=True):
     id: str
     concept: str
     representation: Optional[FusionRepresentation] = None
+    isTimeDimension: bool = False
 
     def to_model(
         self,

pysdmx/io/json/fusion/messages/schema.py

@@ -65,6 +65,25 @@ class FusionSchemaMessage(msgspec.Struct, frozen=True):
         mapped_grps = [
             Group(g.id, dimensions=g.dimensionReferences) for g in grps
         ]
+        keys: List[str] = []
+        for dc in self.DataConstraint:
+            keys.extend(
+                dc.get_series(
+                    [
+                        d.id
+                        for d in self.DataStructure[0].dimensionList.dimensions
+                        if not d.isTimeDimension
+                    ]
+                )
+            )
+        keys = list(set(keys)) if keys else None  # type: ignore[assignment]
         return Schema(
-            context, agency, id_, comps, version, urns, groups=mapped_grps
+            context,
+            agency,
+            id_,
+            comps,
+            version,
+            urns,
+            groups=mapped_grps,
+            keys=keys,
         )

pysdmx/io/json/sdmxjson2/messages/schema.py

@@ -1,12 +1,15 @@
 """Collection of SDMX-JSON schemas for SDMX-REST schema queries."""
 
-from typing import Literal, Optional, Sequence, Tuple
+from typing import Dict, Literal, Optional, Sequence, Tuple
 
 import msgspec
 
 from pysdmx.io.json.sdmxjson2.messages.code import JsonCodelist, JsonValuelist
 from pysdmx.io.json.sdmxjson2.messages.concept import JsonConceptScheme
-from pysdmx.io.json.sdmxjson2.messages.constraint import JsonDataConstraint
+from pysdmx.io.json.sdmxjson2.messages.constraint import (
+    JsonDataConstraint,
+    JsonKeySet,
+)
 from pysdmx.io.json.sdmxjson2.messages.core import JsonHeader
 from pysdmx.io.json.sdmxjson2.messages.dsd import JsonDataStructure
 from pysdmx.model import Components, HierarchyAssociation, Schema
@@ -25,7 +28,7 @@ class JsonSchemas(msgspec.Struct, frozen=True, omit_defaults=True):
 
     def to_model(
         self,
-    ) -> Tuple[Components, Optional[Sequence[Group]]]:
+    ) -> Tuple[Components, Optional[Sequence[Group]], Optional[Sequence[str]]]:
         """Returns the requested schema."""
         comps = self.dataStructures[0].dataStructureComponents
         comps, grps = comps.to_model(  # type: ignore[union-attr,assignment]
@@ -34,7 +37,36 @@ class JsonSchemas(msgspec.Struct, frozen=True, omit_defaults=True):
             self.valuelists,
             self.dataConstraints,
         )
-        return comps, grps  # type: ignore[return-value]
+        keys = self.__process_keys()
+        return comps, grps, keys  # type: ignore[return-value]
+
+    def __extract_keys_dict(
+        self, keysets: Sequence[JsonKeySet]
+    ) -> Sequence[Dict[str, str]]:
+        keys = []
+        for ks in keysets:
+            keys.extend(
+                [{kv.id: kv.value for kv in k.keyValues} for k in ks.keys]
+            )
+        return keys
+
+    def __infer_keys(self, keys_dict: Dict[str, str]) -> str:
+        dimensions = [
+            d.id
+            for d in self.dataStructures[  # type: ignore[union-attr]
+                0
+            ].dataStructureComponents.dimensionList.dimensions
+        ]
+        dim_values = [keys_dict.get(d, "*") for d in dimensions]
+        return ".".join(dim_values)
+
+    def __process_keys(self) -> Optional[Sequence[str]]:
+        keys = []
+        for c in self.dataConstraints:
+            if c.dataKeySets:
+                keys_dicts = self.__extract_keys_dict(c.dataKeySets)
+                keys.extend([self.__infer_keys(d) for d in keys_dicts])
+        return list(set(keys))
 
 
 class JsonSchemaMessage(msgspec.Struct, frozen=True, omit_defaults=True):
@@ -52,7 +84,7 @@ class JsonSchemaMessage(msgspec.Struct, frozen=True, omit_defaults=True):
         hierarchies: Sequence[HierarchyAssociation],
     ) -> Schema:
         """Returns the requested schema."""
-        components, groups = self.data.to_model()
+        components, groups, keys = self.data.to_model()
         comp_dict = {c.id: c for c in components}
         urns = [a.urn for a in self.meta.links]
         for ha in hierarchies:
@@ -77,4 +109,5 @@ class JsonSchemaMessage(msgspec.Struct, frozen=True, omit_defaults=True):
             version,
             urns,  # type: ignore[arg-type]
             groups=groups,
+            keys=keys,
         )

pysdmx/model/dataflow.py

@@ -487,6 +487,14 @@ class Schema(Struct, frozen=True, omit_defaults=True, repr_omit_defaults=True):
             if any of the artefacts listed under the artefacts
             property has been updated after the schema was
             generated, you might want to regenerate the schema.
+        name: The schema name.
+        groups: The list of groups defined in the data structure.
+        keys: The list of allowed series. This is the equivalent
+            of an SDMX KeySet. KeySets allow finer
+            restrictions than when components only (i.e. SDMX
+            CubeRegions). The values in the sequence follow
+            the SDMX-REST conventions for series wildcarding
+            (e.g. *.USD.CHF.*).
     """
 
     context: Literal["datastructure", "dataflow", "provisionagreement"]
@@ -498,6 +506,7 @@ class Schema(Struct, frozen=True, omit_defaults=True, repr_omit_defaults=True):
     generated: datetime = datetime.now(timezone.utc)
     name: Optional[str] = None
     groups: Optional[Sequence[Group]] = None
+    keys: Optional[Sequence[str]] = None
 
     def __str__(self) -> str:
         """Custom string representation without the class name."""

{pysdmx-1.11.0.dist-info → pysdmx-1.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdmx
-Version: 1.11.0
+Version: 1.12.0
 Summary: Your opinionated Python SDMX library
 License: Apache-2.0
 License-File: LICENSE

{pysdmx-1.11.0.dist-info → pysdmx-1.12.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pysdmx/__extras_check.py,sha256=Tmluui2OuJVyJB6a1Jl0PlrRjpsswhtCjAqtRLOSero,2059
-pysdmx/__init__.py,sha256=8EDbBiciJ8gxk5fE9tPCuRnhh-xaYrjzgW5j86WRuwk,68
+pysdmx/__init__.py,sha256=LCdSlP0rLXyq15h8hnc9obDN-ntA9c4EgVNKcYeP7IM,68
 pysdmx/api/__init__.py,sha256=8lRaF6kEO51ehl0fmW_pHLvkN_34TtEhqhr3oKo6E6g,26
 pysdmx/api/dc/__init__.py,sha256=oPU32X8CRZy4T1to9mO5KMqMwxQsVI424dPqai-I8zI,121
 pysdmx/api/dc/_api.py,sha256=poy1FYFXnF6maBGy5lpOodf32-7QQjH8PCBNDkuOXxQ,7747
@@ -43,10 +43,10 @@ pysdmx/io/json/fusion/messages/__init__.py,sha256=ac2jWfjGGBcfoSutiKy68LzqwNp_cl
 pysdmx/io/json/fusion/messages/category.py,sha256=2NnYTptQ6nAdeYBIkAysyriTFF6dW8fjb9AvRWtTOao,5606
 pysdmx/io/json/fusion/messages/code.py,sha256=YayxSKiHa124WTr_lK8HTfXHomh_e0oDZvuydd29XKg,8300
 pysdmx/io/json/fusion/messages/concept.py,sha256=m4lTyncSIriFXWWupE-zLxUVPx3Xrg56qahzKr4HEag,2824
-pysdmx/io/json/fusion/messages/constraint.py,sha256=dPkzhCWN49Y9ReSZPRFTdM6GWc0rU2BZTyFfWsqlX34,615
+pysdmx/io/json/fusion/messages/constraint.py,sha256=pQlirYnZLCD-qqwcqHtAuYaBqU3R-o449nMubyDyC-g,1353
 pysdmx/io/json/fusion/messages/core.py,sha256=GdzF3TNUGrB0gxuaaSpk9LaYqcdy_M6L2azExZQfM0Q,4843
 pysdmx/io/json/fusion/messages/dataflow.py,sha256=lsaMPjmA-KiM51I78wrONfNHyvfBSeAll5Sp0jmTezc,2972
-pysdmx/io/json/fusion/messages/dsd.py,sha256=0YA87KkDAoFlOCi4MboU4MhHEqc_5Wqx2A90pZG5q6o,10668
+pysdmx/io/json/fusion/messages/dsd.py,sha256=67Wym_OLnUERBQGJehu08MdFvH1p3UcUbiz0WZ69zV8,10702
 pysdmx/io/json/fusion/messages/map.py,sha256=TPsCFuUfk5Jhhe7CNvEoHuFNZFpHhvNiYFWeIEUx-sc,7695
 pysdmx/io/json/fusion/messages/metadataflow.py,sha256=Js4j8lUF9ZwqL7lJUrfrjk9tmBmRQPt8qxdrfnZ6R5E,1374
 pysdmx/io/json/fusion/messages/mpa.py,sha256=WvcHn7Pa_UBHxkZbfSzIxc8qeeMfTWThxgCRHuioXFY,1494
@@ -54,7 +54,7 @@ pysdmx/io/json/fusion/messages/msd.py,sha256=XzQ5JiX0rAswj71a3mCYulhGLtu7GDp_RzL
 pysdmx/io/json/fusion/messages/org.py,sha256=gWIvmvVrj5wXCrwbsJL0B13YM3WjlfIQxrRUc_WAoYs,9538
 pysdmx/io/json/fusion/messages/pa.py,sha256=6zN8Qxj5bdf5zo2N9TwYlSLyGxokvsELtk1--1cMbxw,1393
 pysdmx/io/json/fusion/messages/report.py,sha256=ZE62ZmHlCXk3TxRTRWCDCKVMhnN0J5UjMEzrsnD5I3E,1551
-pysdmx/io/json/fusion/messages/schema.py,sha256=xBbpLyJNapJpzZA4vAvROmWTSNYymcpggqMZ_NjL444,2603
+pysdmx/io/json/fusion/messages/schema.py,sha256=cdC2OTcuJFqR9GeyCr0OxL-jYjSdN0HKFMp1OkfORCA,3134
 pysdmx/io/json/fusion/messages/vtl.py,sha256=7VGjDRWzKMO6WT4CnGvGBKinhX06DzrJmDRudnvN4XM,16092
 pysdmx/io/json/fusion/reader/__init__.py,sha256=4lFrsX0Flhvlopv5FAYZBeQMPtmnMm5HgC-q7Pey0dw,1710
 pysdmx/io/json/gds/messages/__init__.py,sha256=5LqGtO3GDi2B6HM2eDGCSJCncLS8C4MQ7vd5YBvCRok,885
@@ -80,7 +80,7 @@ pysdmx/io/json/sdmxjson2/messages/msd.py,sha256=cYQqWOex5LVYE-8ASsyIwI_Y0jCuT9IP
 pysdmx/io/json/sdmxjson2/messages/pa.py,sha256=VoaPBgcWGwWU7h5IaVa5wNWncOoktWihSXjcP4vEb00,2780
 pysdmx/io/json/sdmxjson2/messages/provider.py,sha256=htAwdDzVR3qeyExhmjpvg8W0X4lWqRh2Bvd5H8wsOTY,8197
 pysdmx/io/json/sdmxjson2/messages/report.py,sha256=jr4HZunfnQicG2AFi15AGX_v031jNb3d6PiQgc8TPgY,6672
-pysdmx/io/json/sdmxjson2/messages/schema.py,sha256=JwFYjgvhK_1NN5KQIUYNb0ul4ywQhDQ28ZQBGnsX5X4,2862
+pysdmx/io/json/sdmxjson2/messages/schema.py,sha256=TfsYPKyaQRz-nd6wiSwtL2_VrLJFJQ4rzZmFeU-bH3E,3960
 pysdmx/io/json/sdmxjson2/messages/structure.py,sha256=GCpQboHEpDyfCmXVJGbCyKpIaLCbOXYDxj6WXnvv9pw,12851
 pysdmx/io/json/sdmxjson2/messages/vtl.py,sha256=C-JQY1_W8SrJd2lLdUGCmQO9Br1pdqdT8WmB1K4e_yY,35284
 pysdmx/io/json/sdmxjson2/reader/__init__.py,sha256=RbNnZSrGQa4OE0HBWJau9tPFSQbDklcKZaBWOzxEw4I,1629
@@ -146,7 +146,7 @@ pysdmx/model/category.py,sha256=ksYIOGPHgZI619RhmRXZUXHP_juY9im40tWzR2yuMEc,6796
 pysdmx/model/code.py,sha256=Wu6rEXeZf_XA0aBrDXgN-3yvySAHH7SAjrWliFlmC24,12799
 pysdmx/model/concept.py,sha256=mQfqJdtWc10WdTKX_Mw7Znw65cN3QO-kCar9MWYeWO4,9645
 pysdmx/model/constraint.py,sha256=MwI_GLKzwkuo0BzAsgcnDeB-b7bq8qqwHNte5JjCEFA,1960
-pysdmx/model/dataflow.py,sha256=hNeQjNXebjaDbakx05bfzcQ9DoplZMQi1BUW4NH6lnI,24201
+pysdmx/model/dataflow.py,sha256=FjXuMfAme1JyO1WCFV_yw0WcYqwXMB7kG0mOUwh04q8,24670
 pysdmx/model/dataset.py,sha256=Lbr7tYonGHD3NZUD-M9hK2puaEAluOVPG2DbkOohzMM,4861
 pysdmx/model/gds.py,sha256=QrnmI8Hn--C95gGXCeUeWwhn-Ur7DuT08Cg7oPJIEVI,4976
 pysdmx/model/map.py,sha256=9a3hl6efq_5kAYuJWkepoQOkao8Eqk17N69JGyRfxsk,17506
@@ -168,7 +168,7 @@ pysdmx/util/__init__.py,sha256=m_XWRAmVJ7F6ai4Ckrj_YuPbhg3cJZAXeZrEThrL88k,3997
 pysdmx/util/_date_pattern_map.py,sha256=IS1qONwVHbTBNIFCT0Rqbijj2a9mYvs7onXSK6GeQAQ,1620
 pysdmx/util/_model_utils.py,sha256=nQ1yWBt-tZYDios9xvRvJ7tHq6A8_RoGdY1wi7WGz2w,3793
 pysdmx/util/_net_utils.py,sha256=nOTz_x3FgFrwKh42_J70IqYXz9duQkMFJWtejZXcLHs,1326
-pysdmx-1.11.0.dist-info/METADATA,sha256=eO9SWX3mB1x9glSSm9wEJxu7JQoiHz9Rj9Ac1oPnQZI,5364
-pysdmx-1.11.0.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
-pysdmx-1.11.0.dist-info/licenses/LICENSE,sha256=3XTNDPtv2RxDUNkQzn9MIWit2u7_Ob5daMLEq-4pBJs,649
-pysdmx-1.11.0.dist-info/RECORD,,
+pysdmx-1.12.0.dist-info/METADATA,sha256=Lh2s5ZlVZY0MY1taf1MeFSTlqF1mJIiWEYX1qqRCLps,5364
+pysdmx-1.12.0.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+pysdmx-1.12.0.dist-info/licenses/LICENSE,sha256=3XTNDPtv2RxDUNkQzn9MIWit2u7_Ob5daMLEq-4pBJs,649
+pysdmx-1.12.0.dist-info/RECORD,,

{pysdmx-1.11.0.dist-info → pysdmx-1.12.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.3.0
+Generator: poetry-core 2.3.1
 Root-Is-Purelib: true
 Tag: py3-none-any