pysdmx 1.11.0__tar.gz → 1.12.0__tar.gz

{pysdmx-1.11.0 → pysdmx-1.12.0}/PKG-INFO

@@ -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 → pysdmx-1.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pysdmx"
-version = "1.11.0"
+version = "1.12.0"
 description = "Your opinionated Python SDMX library"
 license = { text = "Apache-2.0" }
 readme = "README.rst"

{pysdmx-1.11.0 → pysdmx-1.12.0}/src/pysdmx/__init__.py

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

pysdmx-1.12.0/src/pysdmx/io/json/fusion/messages/constraint.py

@@ -0,0 +1,42 @@
+"""Collection of Fusion-JSON schemas for content constraints."""
+
+from typing import Dict, List, Optional, Sequence
+
+from msgspec import Struct
+
+
+class FusionKeyValue(Struct, frozen=True):
+    """Fusion-JSON payload for the list of allowed values per component."""
+
+    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-1.11.0 → pysdmx-1.12.0}/src/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-1.11.0 → pysdmx-1.12.0}/src/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-1.11.0 → pysdmx-1.12.0}/src/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-1.11.0 → pysdmx-1.12.0}/src/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/src/pysdmx/io/json/fusion/messages/constraint.py

@@ -1,21 +0,0 @@
-"""Collection of Fusion-JSON schemas for content constraints."""
-
-from typing import Dict, Sequence
-
-from msgspec import Struct
-
-
-class FusionKeyValue(Struct, frozen=True):
-    """Fusion-JSON payload for the list of allowed values per component."""
-
-    values: Sequence[str]
-
-
-class FusionContentConstraint(Struct, frozen=True):
-    """Fusion-JSON payload for a content constraint."""
-
-    includeCube: Dict[str, FusionKeyValue] = {}
-
-    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()}