pysdmx 1.10.0rc1__py3-none-any.whl → 1.10.1__py3-none-any.whl

pysdmx/__init__.py

@@ -1,3 +1,3 @@
 """Your opinionated Python SDMX library."""
 
-__version__ = "1.10.0rc1"
+__version__ = "1.10.1"

pysdmx/api/fmr/__init__.py

@@ -39,11 +39,13 @@ from pysdmx.model import (
     Dataflow,
     DataflowInfo,
     DataProvider,
+    DataStructureDefinition,
     Hierarchy,
     HierarchyAssociation,
     Metadataflow,
     MetadataProvisionAgreement,
     MetadataReport,
+    MetadataStructure,
     MultiRepresentationMap,
     ProvisionAgreement,
     RepresentationMap,
@@ -678,7 +680,7 @@ class RegistryClient(__BaseRegistryClient):
         agency: str = "*",
         id: str = "*",
         version: str = "+",
-    ) -> Sequence[Dataflow]:
+    ) -> Sequence[DataStructureDefinition]:
         """Get the data structures(s) matching the supplied parameters.
 
         Args:
@@ -767,7 +769,7 @@ class RegistryClient(__BaseRegistryClient):
         agency: str = "*",
         id: str = "*",
         version: str = "+",
-    ) -> Sequence[Dataflow]:
+    ) -> Sequence[MetadataStructure]:
         """Get the metadata structures (MSD) matching the supplied parameters.
 
         Args:
@@ -1252,7 +1254,7 @@ class AsyncRegistryClient(__BaseRegistryClient):
         agency: str = "*",
         id: str = "*",
         version: str = "+",
-    ) -> Sequence[Dataflow]:
+    ) -> Sequence[DataStructureDefinition]:
         """Get the data structures(s) matching the supplied parameters.
 
         Args:
@@ -1341,7 +1343,7 @@ class AsyncRegistryClient(__BaseRegistryClient):
         agency: str = "*",
         id: str = "*",
         version: str = "+",
-    ) -> Sequence[Dataflow]:
+    ) -> Sequence[MetadataStructure]:
         """Get the metadata structures (MSD) matching the supplied parameters.
 
         Args:

pysdmx/api/qb/data.py

@@ -329,6 +329,8 @@ class DataQuery(_CoreDataQuery, frozen=True, omit_defaults=True):
 
     def __get_short_v2_qs(self, api_version: ApiVersion) -> str:
         qs = ""
+        if self.components:
+            qs += self._create_component_filters(self.components)
         if self.updated_after:
             qs = super()._append_qs_param(
                 qs,

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

@@ -80,8 +80,14 @@ class FusionAttribute(Struct, frozen=True):
     measureReferences: Optional[Sequence[str]] = None
 
     def __derive_level(self, groups: Sequence[FusionGroup]) -> str:
-        if self.attachmentLevel == "OBSERVATION":
-            return "O"
+        if self.measureReferences:
+            if (
+                len(self.measureReferences) == 1
+                and self.measureReferences[0] == "OBS_VALUE"
+            ):
+                return "O"
+            else:
+                return ",".join(self.measureReferences)
         elif self.attachmentLevel == "DATA_SET":
             return "D"
         elif self.attachmentLevel == "GROUP":

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

@@ -12,6 +12,9 @@ from pysdmx.io.json.sdmxjson2.messages.code import (
     JsonHierarchyMessage,
 )
 from pysdmx.io.json.sdmxjson2.messages.concept import JsonConceptSchemeMessage
+from pysdmx.io.json.sdmxjson2.messages.constraint import (
+    JsonDataConstraintMessage,
+)
 from pysdmx.io.json.sdmxjson2.messages.dataflow import (
     JsonDataflowMessage,
     JsonDataflowsMessage,
@@ -50,6 +53,7 @@ __all__ = [
     "JsonCategorySchemeMessage",
     "JsonCodelistMessage",
     "JsonConceptSchemeMessage",
+    "JsonDataConstraintMessage",
     "JsonDataflowMessage",
     "JsonDataflowsMessage",
     "JsonDataStructuresMessage",

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

@@ -231,7 +231,7 @@ class JsonCodelists(Struct, frozen=True, omit_defaults=True):
     """SDMX-JSON payload for lists of codes."""
 
     codelists: Sequence[JsonCodelist] = ()
-    valuelists: Sequence[JsonValuelist] = ()
+    valueLists: Sequence[JsonValuelist] = ()
 
 
 class JsonCodelistMessage(Struct, frozen=True, omit_defaults=True):
@@ -244,7 +244,7 @@ class JsonCodelistMessage(Struct, frozen=True, omit_defaults=True):
         if self.data.codelists:
             return self.data.codelists[0].to_model()
         else:
-            return self.data.valuelists[0].to_model()
+            return self.data.valueLists[0].to_model()
 
 
 class JsonHierarchicalCode(Struct, frozen=True, omit_defaults=True):
@@ -329,10 +329,10 @@ class JsonHierarchicalCode(Struct, frozen=True, omit_defaults=True):
             code=code.urn,
             validFrom=code.rel_valid_from,
             validTo=code.rel_valid_to,
-            annotations=tuple(annotations),
-            hierarchicalCodes=[
-                JsonHierarchicalCode.from_model(c) for c in code.codes
-            ],
+            annotations=tuple(annotations) if annotations else None,
+            hierarchicalCodes=tuple(
+                [JsonHierarchicalCode.from_model(c) for c in code.codes]
+            ),
         )
 
 
@@ -475,6 +475,15 @@ class JsonHierarchyAssociation(
                 "SDMX-JSON hierarchy associations must reference a context",
                 {"hierarchy_association": ha.id},
             )
+        lnk = (
+            JsonLink(
+                rel="UserDefinedOperator",
+                type="sdmx_artefact",
+                urn=ha.operator,
+            )
+            if ha.operator
+            else None
+        )
         return JsonHierarchyAssociation(
             agency=(
                 ha.agency.id if isinstance(ha.agency, Agency) else ha.agency
@@ -492,6 +501,7 @@ class JsonHierarchyAssociation(
             linkedHierarchy=href,
             linkedObject=ha.component_ref,
             contextObject=ha.context_ref,
+            links=[lnk] if lnk else (),
         )
 
 

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/dsd.py

@@ -126,7 +126,10 @@ class JsonAttributeRelationship(Struct, frozen=True, omit_defaults=True):
     ) -> str:
         """Returns the attachment level."""
         if measures:
-            return "O"
+            if len(measures) == 1 and measures[0] == "OBS_VALUE":
+                return "O"
+            else:
+                return ",".join(measures)
         elif self.dimensions:
             return ",".join(self.dimensions)
         elif self.group:
@@ -136,15 +139,17 @@ class JsonAttributeRelationship(Struct, frozen=True, omit_defaults=True):
             return "D"
 
     @classmethod
-    def from_model(self, rel: str) -> "JsonAttributeRelationship":
+    def from_model(
+        self, rel: str, has_measure_rel: bool = False
+    ) -> "JsonAttributeRelationship":
         """Converts a pysdmx attribute relationship to an SDMX-JSON one."""
         if rel == "D":
             return JsonAttributeRelationship(dataflow={})
-        elif rel == "O":
+        elif rel == "O" or has_measure_rel:
             return JsonAttributeRelationship(observation={})
         else:
-            dims = rel.split(",")
-            return JsonAttributeRelationship(dimensions=dims)
+            comps = rel.split(",")
+            return JsonAttributeRelationship(dimensions=comps)
 
 
 class JsonDimension(Struct, frozen=True, omit_defaults=True):
@@ -257,20 +262,37 @@ class JsonAttribute(Struct, frozen=True, omit_defaults=True):
         )
 
     @classmethod
-    def from_model(self, attribute: Component) -> "JsonAttribute":
+    def from_model(
+        self, attribute: Component, measures: Sequence[Component]
+    ) -> "JsonAttribute":
         """Converts a pysdmx attribute to an SDMX-JSON one."""
         concept = _get_concept_reference(attribute)
         usage = "mandatory" if attribute.required else "optional"
+        repr = _get_json_representation(attribute)
+
+        ids = attribute.attachment_level.split(",")  # type: ignore[union-attr]
+        comps = set(ids)
+        mids = {m.id for m in measures}
+        has_measure_rel = len(comps.intersection(mids)) > 0
         level = JsonAttributeRelationship.from_model(
-            attribute.attachment_level  # type: ignore[arg-type]
+            attribute.attachment_level,  # type: ignore[arg-type]
+            has_measure_rel,
         )
-        repr = _get_json_representation(attribute)
+
+        if attribute.attachment_level == "O":
+            mr = ["OBS_VALUE"]
+        elif has_measure_rel:
+            mr = ids
+        else:
+            mr = None
+
         return JsonAttribute(
             id=attribute.id,
             conceptIdentity=concept,
             attributeRelationship=level,
             usage=usage,
             localRepresentation=repr,
+            measureRelationship=mr,
         )
 
 
@@ -351,12 +373,14 @@ class JsonAttributes(Struct, frozen=True, omit_defaults=True):
 
     @classmethod
     def from_model(
-        self, attributes: Sequence[Component]
+        self, attributes: Sequence[Component], measures: Sequence[Component]
     ) -> Optional["JsonAttributes"]:
         """Converts a pysdmx list of attributes to an SDMX-JSON one."""
         if len(attributes) > 0:
             return JsonAttributes(
-                attributes=[JsonAttribute.from_model(a) for a in attributes]
+                attributes=[
+                    JsonAttribute.from_model(a, measures) for a in attributes
+                ]
             )
         else:
             return None
@@ -447,19 +471,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,
                 )
             )
@@ -474,7 +521,9 @@ class JsonComponents(Struct, frozen=True, omit_defaults=True):
     ) -> "JsonComponents":
         """Converts a pysdmx components list to an SDMX-JSON one."""
         dimensions = JsonDimensions.from_model(components.dimensions)
-        attributes = JsonAttributes.from_model(components.attributes)
+        attributes = JsonAttributes.from_model(
+            components.attributes, components.measures
+        )
         measures = JsonMeasures.from_model(components.measures)
         if grps is None:
             groups = []
@@ -556,7 +605,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 +614,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]
         )