pysdmx 1.8.1__py3-none-any.whl → 1.10.0__py3-none-any.whl

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

@@ -1,16 +1,43 @@
 """Collection of SDMX-JSON schemas for content constraints."""
 
-from typing import Dict, Literal, Optional, Sequence
+from datetime import datetime
+from typing import Optional, Sequence
 
 from msgspec import Struct
 
-from pysdmx.io.json.sdmxjson2.messages.core import MaintainableType
+from pysdmx import errors
+from pysdmx.io.json.sdmxjson2.messages.core import (
+    JsonAnnotation,
+    MaintainableType,
+)
+from pysdmx.model import (
+    Agency,
+    ConstraintAttachment,
+    CubeKeyValue,
+    CubeRegion,
+    CubeValue,
+    DataConstraint,
+    DataKey,
+    DataKeyValue,
+    KeySet,
+)
 
 
 class JsonValue(Struct, frozen=True, omit_defaults=True):
-    """SDMX-JSON payload for an allowed value."""
+    """SDMX-JSON payload for a cube value."""
 
     value: str
+    validFrom: Optional[datetime] = None
+    validTo: Optional[datetime] = None
+
+    def to_model(self) -> CubeValue:
+        """Converts a JsonValue to a CubeValue."""
+        return CubeValue(self.value, self.validFrom, self.validTo)
+
+    @classmethod
+    def from_model(self, cv: CubeValue) -> "JsonValue":
+        """Converts a pysdmx cube value to an SDMX-JSON one."""
+        return JsonValue(cv.value, cv.valid_from, cv.valid_to)
 
 
 class JsonKeyValue(Struct, frozen=True, omit_defaults=True):
@@ -18,36 +45,228 @@ class JsonKeyValue(Struct, frozen=True, omit_defaults=True):
 
     id: str
     values: Sequence[JsonValue]
+    # Additional properties are supported in the model (include,
+    # removePrefix, validFrom, validTo, timeRange) but not by the FMR.
+    # Therefore, they are ignored for now.
+
+    def to_model(self) -> CubeKeyValue:
+        """Converts a JsonKeyValue to a CubeKeyValue."""
+        return CubeKeyValue(self.id, [v.to_model() for v in self.values])
 
-    def to_model(self) -> Sequence[str]:
-        """Returns the requested list of values."""
-        return [v.value for v in self.values]
+    @classmethod
+    def from_model(self, key_value: CubeKeyValue) -> "JsonKeyValue":
+        """Converts a pysdmx cube key value to an SDMX-JSON one."""
+        return JsonKeyValue(
+            key_value.id, [JsonValue.from_model(v) for v in key_value.values]
+        )
 
 
 class JsonCubeRegion(Struct, frozen=True, omit_defaults=True):
     """SDMX-JSON payload for a cube region."""
 
+    # The property `components` is ignored as it's not used in the FMR`
     keyValues: Sequence[JsonKeyValue]
+    include: bool = True
 
-    def to_map(self) -> Dict[str, Sequence[str]]:
-        """Gets the list of allowed values for a component."""
-        return {kv.id: kv.to_model() for kv in self.keyValues}
+    def to_model(self) -> CubeRegion:
+        """Converts a JsonCubeRegion to a CubeRegion."""
+        return CubeRegion(
+            [kv.to_model() for kv in self.keyValues], self.include
+        )
+
+    @classmethod
+    def from_model(self, region: CubeRegion) -> "JsonCubeRegion":
+        """Converts a pysdmx cube region to an SDMX-JSON one."""
+        return JsonCubeRegion(
+            [JsonKeyValue.from_model(kv) for kv in region.key_values],
+            region.is_included,
+        )
 
 
 class JsonConstraintAttachment(Struct, frozen=True, omit_defaults=True):
     """SDMX-JSON payload for a constraint attachment."""
 
-    dataProvider: Optional[str]
-    simpleDataSources: Optional[Sequence[str]] = None
-    dataStructures: Optional[Sequence[str]] = None
-    dataflows: Optional[Sequence[str]] = None
-    provisionAgreements: Optional[Sequence[str]] = None
-    queryableDataSources: Optional[Sequence[str]] = None
+    dataProvider: Optional[str] = None
+    dataStructures: Sequence[str] = ()
+    dataflows: Sequence[str] = ()
+    provisionAgreements: Sequence[str] = ()
+
+    def to_model(self) -> ConstraintAttachment:
+        """Converts a JsonConstraintAttachment to a ConstraintAttachment."""
+        return ConstraintAttachment(
+            self.dataProvider,
+            self.dataStructures,
+            self.dataflows,
+            self.provisionAgreements,
+        )
+
+    @classmethod
+    def from_model(
+        self, attachment: ConstraintAttachment
+    ) -> "JsonConstraintAttachment":
+        """Converts a pysdmx constraint attachment to an SDMX-JSON one."""
+        ds = attachment.data_structures if attachment.data_structures else ()
+        df = attachment.dataflows if attachment.dataflows else ()
+        pa = (
+            attachment.provision_agreements
+            if attachment.provision_agreements
+            else ()
+        )
+        return JsonConstraintAttachment(attachment.data_provider, ds, df, pa)
+
+
+class JsonDataKeyValue(Struct, frozen=True, omit_defaults=True):
+    """SDMX-JSON payload for a data key value."""
+
+    id: str
+    value: str
+
+    def to_model(self) -> DataKeyValue:
+        """Converts a JsonDataKeyValue to a DataKeyValue."""
+        return DataKeyValue(self.id, self.value)
+
+    @classmethod
+    def from_model(self, kv: DataKeyValue) -> "JsonDataKeyValue":
+        """Converts a pysdmx key value to an SDMX-JSON one."""
+        return JsonDataKeyValue(kv.id, kv.value)
+
+
+class JsonDataKey(Struct, frozen=True, omit_defaults=True):
+    """SDMX-JSON payload for a data key."""
+
+    keyValues: Sequence[JsonDataKeyValue]
+    validFrom: Optional[datetime] = None
+    validTo: Optional[datetime] = None
+
+    def to_model(self) -> DataKey:
+        """Converts a JsonDataKey to a DataKey."""
+        return DataKey(
+            [kv.to_model() for kv in self.keyValues],
+            self.validFrom,
+            self.validTo,
+        )
+
+    @classmethod
+    def from_model(self, kv: DataKey) -> "JsonDataKey":
+        """Converts a pysdmx key constraint to an SDMX-JSON one."""
+        return JsonDataKey(
+            [JsonDataKeyValue.from_model(val) for val in kv.keys_values],
+            kv.valid_from,
+            kv.valid_to,
+        )
+
+
+class JsonKeySet(Struct, frozen=True, omit_defaults=True):
+    """SDMX-JSON payload for a keyset."""
+
+    keys: Sequence[JsonDataKey]
+    isIncluded: bool
+
+    def to_model(self) -> KeySet:
+        """Converts a JsonKeySet to a KeySet."""
+        return KeySet([k.to_model() for k in self.keys], self.isIncluded)
+
+    @classmethod
+    def from_model(self, ks: KeySet) -> "JsonKeySet":
+        """Converts a pysdmx key set constraint to an SDMX-JSON one."""
+        return JsonKeySet(
+            [JsonDataKey.from_model(k) for k in ks.keys], ks.is_included
+        )
 
 
 class JsonDataConstraint(MaintainableType, frozen=True, omit_defaults=True):
     """SDMX-JSON payload for a content constraint."""
 
-    role: Optional[Literal["Allowed", "Actual"]] = None
     constraintAttachment: Optional[JsonConstraintAttachment] = None
     cubeRegions: Optional[Sequence[JsonCubeRegion]] = None
+    dataKeySets: Optional[Sequence[JsonKeySet]] = None
+
+    def to_model(self) -> DataConstraint:
+        """Converts a JsonDataConstraint to a pysdmx Data Constraint."""
+        at = self.constraintAttachment.to_model()  # type: ignore[union-attr]
+        return DataConstraint(
+            id=self.id,
+            name=self.name,
+            agency=self.agency,
+            description=self.description,
+            version=self.version,
+            annotations=tuple([a.to_model() for a in self.annotations]),
+            is_external_reference=self.isExternalReference,
+            valid_from=self.validFrom,
+            valid_to=self.validTo,
+            constraint_attachment=at,
+            cube_regions=[r.to_model() for r in self.cubeRegions]
+            if self.cubeRegions
+            else (),
+            key_sets=[s.to_model() for s in self.dataKeySets]
+            if self.dataKeySets
+            else (),
+        )
+
+    @classmethod
+    def from_model(self, cons: DataConstraint) -> "JsonDataConstraint":
+        """Converts a pysdmx constraint to an SDMX-JSON one."""
+        crs = (
+            [JsonCubeRegion.from_model(r) for r in cons.cube_regions]
+            if cons.cube_regions
+            else None
+        )
+        dks = (
+            [JsonKeySet.from_model(s) for s in cons.key_sets]
+            if cons.key_sets
+            else None
+        )
+        if not cons.name:
+            raise errors.Invalid(
+                "Invalid input",
+                "SDMX-JSON data constraints must have a name",
+                {"data_constraint": cons.id},
+            )
+        if not cons.constraint_attachment:
+            raise errors.Invalid(
+                "Invalid input",
+                "SDMX-JSON data constraints must have a constraint attachment",
+                {"data_constraint": cons.id},
+            )
+        return JsonDataConstraint(
+            id=cons.id,
+            name=cons.name,
+            agency=(
+                cons.agency.id
+                if isinstance(cons.agency, Agency)
+                else cons.agency
+            ),
+            description=cons.description,
+            version=cons.version,
+            annotations=tuple(
+                [JsonAnnotation.from_model(a) for a in cons.annotations]
+            ),
+            isExternalReference=cons.is_external_reference,
+            validFrom=cons.valid_from,
+            validTo=cons.valid_to,
+            constraintAttachment=JsonConstraintAttachment.from_model(
+                cons.constraint_attachment
+            ),
+            cubeRegions=crs,
+            dataKeySets=dks,
+        )
+
+
+class JsonDataConstraints(Struct, frozen=True, omit_defaults=True):
+    """SDMX-JSON payload for data constraints."""
+
+    dataConstraints: Sequence[JsonDataConstraint] = ()
+
+    def to_model(self) -> Sequence[DataConstraint]:
+        """Returns the requested data constraints."""
+        return [cc.to_model() for cc in self.dataConstraints]
+
+
+class JsonDataConstraintMessage(Struct, frozen=True, omit_defaults=True):
+    """SDMX-JSON payload for /dataconstraint queries."""
+
+    data: JsonDataConstraints
+
+    def to_model(self) -> Sequence[DataConstraint]:
+        """Returns the requested data constraints."""
+        return self.data.to_model()

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

@@ -299,6 +299,7 @@ class JsonHeader(msgspec.Struct, frozen=True, omit_defaults=True):
             test=self.test,
             prepared=self.prepared,
             sender=self.sender,
+            receiver=self.receivers if self.receivers else (),
         )
 
     @classmethod
@@ -313,7 +314,7 @@ class JsonHeader(msgspec.Struct, frozen=True, omit_defaults=True):
             header.prepared,
             header.sender,
             header.test,
-            receivers=(header.receiver,) if header.receiver else None,
+            receivers=header.receiver if header.receiver else None,
             schema=(
                 "https://raw.githubusercontent.com/sdmx-twg/sdmx-json/"
                 "develop/structure-message/tools/schemas/2.0.0/"

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

@@ -265,12 +265,17 @@ class JsonAttribute(Struct, frozen=True, omit_defaults=True):
             attribute.attachment_level  # type: ignore[arg-type]
         )
         repr = _get_json_representation(attribute)
+        # The line below will need to be changed when we work on
+        # Measure Relationship (cf. issue #467)
+        mr = ["OBS_VALUE"] if attribute.attachment_level == "O" else None
+
         return JsonAttribute(
             id=attribute.id,
             conceptIdentity=concept,
             attributeRelationship=level,
             usage=usage,
             localRepresentation=repr,
+            measureRelationship=mr,
         )
 
 
@@ -447,19 +452,42 @@ class JsonComponents(Struct, frozen=True, omit_defaults=True):
         enums = [cl.to_model() for cl in cls]
         enums.extend([vl.to_model() for vl in vls])
         comps = []
-        if constraints and constraints[0].cubeRegions:
-            cons = constraints[0].cubeRegions[0].to_map()
+        if constraints:
+            incl_cubes = []
+            for const in constraints:
+                incl_cubes.extend(
+                    [cr for cr in (const.cubeRegions or []) if cr.include]
+                )
+            if len(incl_cubes) == 1:
+                cons = {
+                    kv.id: [v.value for v in kv.values]
+                    for kv in incl_cubes[0].keyValues
+                }
+            else:
+                cons = {}
         else:
             cons = {}
-        comps.extend(self.dimensionList.to_model(cs, enums, cons))
+        comps.extend(
+            self.dimensionList.to_model(
+                cs,
+                enums,
+                cons,  # type: ignore[arg-type]
+            )
+        )
         if self.measureList:
-            comps.extend(self.measureList.to_model(cs, enums, cons))
+            comps.extend(
+                self.measureList.to_model(
+                    cs,
+                    enums,
+                    cons,  # type: ignore[arg-type]
+                )
+            )
         if self.attributeList:
             comps.extend(
                 self.attributeList.to_model(
                     cs,
                     enums,
-                    cons,
+                    cons,  # type: ignore[arg-type]
                     self.groups,
                 )
             )
@@ -556,7 +584,7 @@ class JsonDataStructures(Struct, frozen=True, omit_defaults=True):
     conceptSchemes: Sequence[JsonConceptScheme] = ()
     valuelists: Sequence[JsonValuelist] = ()
     codelists: Sequence[JsonCodelist] = ()
-    contentConstraints: Sequence[JsonDataConstraint] = ()
+    dataConstraints: Sequence[JsonDataConstraint] = ()
 
     def to_model(self) -> Sequence[DataStructureDefinition]:
         """Returns the requested dsds."""
@@ -565,7 +593,7 @@ class JsonDataStructures(Struct, frozen=True, omit_defaults=True):
                 self.conceptSchemes,
                 self.codelists,
                 self.valuelists,
-                self.contentConstraints,
+                self.dataConstraints,
             )
             for dsd in self.dataStructures
         ]

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

@@ -87,19 +87,20 @@ class JsonRepresentationMapping(Struct, frozen=True, omit_defaults=True):
         self, vm: Union[MultiValueMap, ValueMap]
     ) -> "JsonRepresentationMapping":
         """Converts a value map to an SDMX-JSON JsonRepresentationMapping."""
+        fmt = r"%Y-%m-%dT%H:%M:%S"
         if isinstance(vm, ValueMap):
             return JsonRepresentationMapping(
                 [JsonSourceValue.from_model(vm.source)],
                 [vm.target],
-                vm.valid_from.strftime("%Y-%m-%d") if vm.valid_from else None,
-                vm.valid_to.strftime("%Y-%m-%d") if vm.valid_to else None,
+                vm.valid_from.strftime(fmt) if vm.valid_from else None,
+                vm.valid_to.strftime(fmt) if vm.valid_to else None,
             )
         else:
             return JsonRepresentationMapping(
                 [JsonSourceValue.from_model(s) for s in vm.source],
                 vm.target,
-                vm.valid_from.strftime("%Y-%m-%d") if vm.valid_from else None,
-                vm.valid_to.strftime("%Y-%m-%d") if vm.valid_to else None,
+                vm.valid_from.strftime(fmt) if vm.valid_from else None,
+                vm.valid_to.strftime(fmt) if vm.valid_to else None,
             )
 
 

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

@@ -65,6 +65,7 @@ class JsonMetadataflow(MaintainableType, frozen=True, omit_defaults=True):
                 [JsonAnnotation.from_model(a) for a in df.annotations]
             ),
             structure=dsdref,
+            targets=df.targets,  # type: ignore[arg-type]
         )
 
 

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

@@ -15,7 +15,6 @@ from pysdmx.io.json.sdmxjson2.messages.core import (
 from pysdmx.io.json.sdmxjson2.messages.dsd import (
     _find_concept,
     _get_concept_reference,
-    _get_json_representation,
     _get_representation,
 )
 from pysdmx.model import (
@@ -28,6 +27,13 @@ from pysdmx.model import (
 from pysdmx.util import parse_item_urn
 
 
+def _get_attr_repr(comp: MetadataComponent) -> Optional[JsonRepresentation]:
+    enum = comp.local_enum_ref if comp.local_enum_ref else None
+    return JsonRepresentation.from_model(
+        comp.local_dtype, enum, comp.local_facets, None
+    )
+
+
 class JsonMetadataAttribute(Struct, frozen=True, omit_defaults=True):
     """SDMX-JSON payload for an attribute."""
 
@@ -80,11 +86,13 @@ class JsonMetadataAttribute(Struct, frozen=True, omit_defaults=True):
     def from_model(self, cmp: MetadataComponent) -> "JsonMetadataAttribute":
         """Converts a pysdmx metadata attribute to an SDMX-JSON one."""
         concept = _get_concept_reference(cmp)
-        repr = _get_json_representation(cmp)
+        repr = _get_attr_repr(cmp)
 
         min_occurs = cmp.array_def.min_size if cmp.array_def else 0
-        if cmp.array_def is None or cmp.array_def.max_size is None:
-            max_occurs: Union[int, Literal["unbounded"]] = "unbounded"
+        if cmp.array_def is None:
+            max_occurs: Union[int, Literal["unbounded"]] = 1
+        elif cmp.array_def.max_size is None:
+            max_occurs = "unbounded"
         else:
             max_occurs = cmp.array_def.max_size
 
@@ -95,9 +103,9 @@ class JsonMetadataAttribute(Struct, frozen=True, omit_defaults=True):
             minOccurs=min_occurs,
             maxOccurs=max_occurs,
             isPresentational=cmp.is_presentational,
-            metadataAttributes=[
-                JsonMetadataAttribute.from_model(c) for c in cmp.components
-            ],
+            metadataAttributes=tuple(
+                [JsonMetadataAttribute.from_model(c) for c in cmp.components]
+            ),
         )
 
 
@@ -119,9 +127,9 @@ class JsonMetadataAttributes(Struct, frozen=True, omit_defaults=True):
     ) -> "JsonMetadataAttributes":
         """Converts a pysdmx list of metadata attributes to SDMX-JSON."""
         return JsonMetadataAttributes(
-            metadataAttributes=[
-                JsonMetadataAttribute.from_model(a) for a in attributes
-            ]
+            metadataAttributes=tuple(
+                [JsonMetadataAttribute.from_model(a) for a in attributes]
+            )
         )
 
 

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

@@ -21,7 +21,7 @@ class JsonSchemas(msgspec.Struct, frozen=True, omit_defaults=True):
     dataStructures: Sequence[JsonDataStructure]
     valuelists: Sequence[JsonValuelist] = ()
     codelists: Sequence[JsonCodelist] = ()
-    contentConstraints: Sequence[JsonDataConstraint] = ()
+    dataConstraints: Sequence[JsonDataConstraint] = ()
 
     def to_model(
         self,
@@ -32,7 +32,7 @@ class JsonSchemas(msgspec.Struct, frozen=True, omit_defaults=True):
             self.conceptSchemes,
             self.codelists,
             self.valuelists,
-            self.contentConstraints,
+            self.dataConstraints,
         )
         return comps, grps  # type: ignore[return-value]