pysdmx 1.7.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

pysdmx/__init__.py

@@ -1,3 +1,3 @@
 """Your opinionated Python SDMX library."""
 
-__version__ = "1.7.0"
+__version__ = "1.8.0"

pysdmx/api/fmr/__init__.py

@@ -41,6 +41,8 @@ from pysdmx.model import (
     DataProvider,
     Hierarchy,
     HierarchyAssociation,
+    Metadataflow,
+    MetadataProvisionAgreement,
     MetadataReport,
     MultiRepresentationMap,
     ProvisionAgreement,
@@ -196,6 +198,18 @@ class __BaseRegistryClient:
             StructureType.DATA_PROVIDER_SCHEME, agency, references=r
         )
 
+    def _metadata_providers_q(
+        self, agency: str, with_flows: bool
+    ) -> StructureQuery:
+        r = (
+            StructureReference.METADATA_PROVISION_AGREEMENT
+            if with_flows
+            else StructureReference.NONE
+        )
+        return StructureQuery(
+            StructureType.METADATA_PROVIDER_SCHEME, agency, references=r
+        )
+
     def _categories_q(
         self, agency: str, id: str, version: str
     ) -> StructureQuery:
@@ -273,6 +287,38 @@ class __BaseRegistryClient:
             StructureType.PROVISION_AGREEMENT, agency, id, version
         )
 
+    def _metadataflows_q(
+        self, agency: str, id: str, version: str
+    ) -> StructureQuery:
+        return StructureQuery(StructureType.METADATAFLOW, agency, id, version)
+
+    def _mpa_q(self, agency: str, id: str, version: str) -> StructureQuery:
+        return StructureQuery(
+            StructureType.METADATA_PROVISION_AGREEMENT, agency, id, version
+        )
+
+    def _msds_q(self, agency: str, id: str, version: str) -> StructureQuery:
+        return StructureQuery(
+            StructureType.METADATA_STRUCTURE,
+            agency,
+            id,
+            version,
+            detail=StructureDetail.REFERENCE_PARTIAL,
+            references=StructureReference.DESCENDANTS,
+        )
+
+    def _data_structures_q(
+        self, agency: str, id: str, version: str
+    ) -> StructureQuery:
+        return StructureQuery(
+            StructureType.DATA_STRUCTURE,
+            agency,
+            id,
+            version,
+            detail=StructureDetail.REFERENCE_PARTIAL,
+            references=StructureReference.DESCENDANTS,
+        )
+
 
 class RegistryClient(__BaseRegistryClient):
     """A client to be used to retrieve metadata from the FMR.
@@ -385,6 +431,28 @@ class RegistryClient(__BaseRegistryClient):
         schemes = super()._out(out, self.deser.providers)
         return schemes[0].items
 
+    def get_metadata_providers(
+        self,
+        agency: str,
+        with_flows: bool = False,
+    ) -> Sequence[DataProvider]:
+        """Get the list of **metadata providers** for the supplied agency.
+
+        Args:
+            agency: The agency maintaining the metadata provider scheme from
+                which metadata providers must be returned.
+            with_flows: Whether the metadata providers should contain the list
+                of metadataflows for which the metadata provider provides
+                metadata reports.
+
+        Returns:
+            The requested list of metadata providers.
+        """
+        query = super()._metadata_providers_q(agency, with_flows)
+        out = self.__fetch(query)
+        schemes = super()._out(out, self.deser.metadata_providers)
+        return schemes[0].items
+
     def get_categories(
         self,
         agency: str,
@@ -605,6 +673,28 @@ class RegistryClient(__BaseRegistryClient):
         out = self.__fetch(query)
         return super()._out(out, self.deser.dataflows)
 
+    def get_data_structures(
+        self,
+        agency: str = "*",
+        id: str = "*",
+        version: str = "+",
+    ) -> Sequence[Dataflow]:
+        """Get the data structures(s) matching the supplied parameters.
+
+        Args:
+            agency: The agency maintaining the data structures(s).
+            id: The ID of the data structures(s) to be returned.
+            version: The version of the data structures(s) to be returned.
+                The most recent version will be returned, unless specified
+                otherwise.
+
+        Returns:
+            The requested data structures(s).
+        """
+        query = super()._data_structures_q(agency, id, version)
+        out = self.__fetch(query)
+        return super()._out(out, self.deser.data_structures)
+
     def get_hierarchy(
         self,
         agency: str,
@@ -672,6 +762,72 @@ class RegistryClient(__BaseRegistryClient):
         out = self.__fetch(query)
         return super()._out(out, self.deser.report).reports
 
+    def get_metadata_structures(
+        self,
+        agency: str = "*",
+        id: str = "*",
+        version: str = "+",
+    ) -> Sequence[Dataflow]:
+        """Get the metadata structures (MSD) matching the supplied parameters.
+
+        Args:
+            agency: The agency maintaining the MSD(s).
+            id: The ID of the metadata structure(s) to be returned.
+            version: The version of the metadata structure(s) to be returned.
+                The most recent version will be returned, unless specified
+                otherwise.
+
+        Returns:
+            The requested MSD(s).
+        """
+        query = super()._msds_q(agency, id, version)
+        out = self.__fetch(query)
+        return super()._out(out, self.deser.msds)
+
+    def get_metadataflows(
+        self,
+        agency: str = "*",
+        id: str = "*",
+        version: str = "+",
+    ) -> Sequence[Metadataflow]:
+        """Get the metadataflow(s) matching the supplied parameters.
+
+        Args:
+            agency: The agency maintaining the metadataflow(s).
+            id: The ID of the metadataflow(s) to be returned.
+            version: The version of the metadataflow(s) to be returned.
+                The most recent version will be returned, unless specified
+                otherwise.
+
+        Returns:
+            The requested metadataflow(s).
+        """
+        query = super()._metadataflows_q(agency, id, version)
+        out = self.__fetch(query)
+        return super()._out(out, self.deser.metadataflows)
+
+    def get_metadata_provision_agreement(
+        self,
+        agency: str,
+        id: str,
+        version: str = "+",
+    ) -> MetadataProvisionAgreement:
+        """Get the metadata provision agreement matching the parameters.
+
+        Args:
+            agency: The agency maintaining the metadata provision agreement.
+            id: The ID of the metadata provision agreement to be returned.
+            version: The version of the metadata provision agreement to be
+                returned. The most recent version will be returned, unless
+                specified otherwise.
+
+        Returns:
+            The requested metadata provision agreement.
+        """
+        query = super()._mpa_q(agency, id, version)
+        out = self.__fetch(query)
+        return super()._out(out, self.deser.metadata_provision_agreement)[0]
+
     def get_mapping(
         self,
         agency: str,
@@ -844,6 +1000,28 @@ class AsyncRegistryClient(__BaseRegistryClient):
         schemes = super()._out(out, self.deser.providers)
         return schemes[0].items
 
+    async def get_metadata_providers(
+        self,
+        agency: str,
+        with_flows: bool = False,
+    ) -> Sequence[DataProvider]:
+        """Get the list of **metadata providers** for the supplied agency.
+
+        Args:
+            agency: The agency maintaining the metadata provider scheme from
+                which metadata providers must be returned.
+            with_flows: Whether the metadata providers should contain the list
+                of metadataflows for which the metadata provider provides
+                metadata reports.
+
+        Returns:
+            The requested list of metadata providers.
+        """
+        query = super()._metadata_providers_q(agency, with_flows)
+        out = await self.__fetch(query)
+        schemes = super()._out(out, self.deser.metadata_providers)
+        return schemes[0].items
+
     async def get_categories(
         self,
         agency: str,
@@ -1069,6 +1247,28 @@ class AsyncRegistryClient(__BaseRegistryClient):
         out = await self.__fetch(query)
         return super()._out(out, self.deser.dataflows)
 
+    async def get_data_structures(
+        self,
+        agency: str = "*",
+        id: str = "*",
+        version: str = "+",
+    ) -> Sequence[Dataflow]:
+        """Get the data structures(s) matching the supplied parameters.
+
+        Args:
+            agency: The agency maintaining the data structures(s).
+            id: The ID of the data structures(s) to be returned.
+            version: The version of the data structures(s) to be returned.
+                The most recent version will be returned, unless specified
+                otherwise.
+
+        Returns:
+            The requested data structures(s).
+        """
+        query = super()._data_structures_q(agency, id, version)
+        out = await self.__fetch(query)
+        return super()._out(out, self.deser.data_structures)
+
     async def get_hierarchy(
         self,
         agency: str,
@@ -1136,6 +1336,72 @@ class AsyncRegistryClient(__BaseRegistryClient):
         out = await self.__fetch(query)
         return super()._out(out, self.deser.report).reports
 
+    async def get_metadata_structures(
+        self,
+        agency: str = "*",
+        id: str = "*",
+        version: str = "+",
+    ) -> Sequence[Dataflow]:
+        """Get the metadata structures (MSD) matching the supplied parameters.
+
+        Args:
+            agency: The agency maintaining the MSD(s).
+            id: The ID of the metadata structure(s) to be returned.
+            version: The version of the metadata structure(s) to be returned.
+                The most recent version will be returned, unless specified
+                otherwise.
+
+        Returns:
+            The requested MSD(s).
+        """
+        query = super()._msds_q(agency, id, version)
+        out = await self.__fetch(query)
+        return super()._out(out, self.deser.msds)
+
+    async def get_metadataflows(
+        self,
+        agency: str = "*",
+        id: str = "*",
+        version: str = "+",
+    ) -> Sequence[Metadataflow]:
+        """Get the metadataflow(s) matching the supplied parameters.
+
+        Args:
+            agency: The agency maintaining the metadataflow(s).
+            id: The ID of the metadataflow(s) to be returned.
+            version: The version of the metadataflow(s) to be returned.
+                The most recent version will be returned, unless specified
+                otherwise.
+
+        Returns:
+            The requested metadataflow(s).
+        """
+        query = super()._metadataflows_q(agency, id, version)
+        out = await self.__fetch(query)
+        return super()._out(out, self.deser.metadataflows)
+
+    async def get_metadata_provision_agreement(
+        self,
+        agency: str,
+        id: str,
+        version: str = "+",
+    ) -> MetadataProvisionAgreement:
+        """Get the metadata provision agreement matching the parameters.
+
+        Args:
+            agency: The agency maintaining the metadata provision agreement.
+            id: The ID of the metadata provision agreement to be returned.
+            version: The version of the metadata provision agreement to be
+                returned. The most recent version will be returned, unless
+                specified otherwise.
+
+        Returns:
+            The requested metadata provision agreement.
+        """
+        query = super()._mpa_q(agency, id, version)
+        out = await self.__fetch(query)
+        return super()._out(out, self.deser.metadata_provision_agreement)[0]
+
     async def get_mapping(
         self,
         agency: str,

pysdmx/api/qb/refmeta.py

@@ -43,7 +43,7 @@ class _RefMetaCoreQuery(CoreQuery, frozen=True, omit_defaults=True):
             )
 
     def _get_as_of_value(self, as_of: Optional[datetime]) -> str:
-        return f'&asOf={as_of.isoformat("T", "seconds")}' if as_of else ""
+        return f"&asOf={as_of.isoformat('T', 'seconds')}" if as_of else ""
 
     def _get_short_qs(
         self, detail: RefMetaDetail, as_of: Optional[datetime]

pysdmx/api/qb/schema.py

@@ -101,10 +101,7 @@ class SchemaQuery(CoreQuery, frozen=True, omit_defaults=True):
         self.__check_deletion(version)
 
     def _create_full_query(self, ver: ApiVersion) -> str:
-        u = (
-            f"/schema/{self.context.value}/"
-            f"{self.agency_id}/{self.resource_id}"
-        )
+        u = f"/schema/{self.context.value}/{self.agency_id}/{self.resource_id}"
         u += f"/{self._to_kw(self.version, ver)}"
         if (
             self.obs_dimension
@@ -122,7 +119,7 @@ class SchemaQuery(CoreQuery, frozen=True, omit_defaults=True):
         if self.as_of:
             if self.obs_dimension:
                 u += "&"
-            u += f'asOf={self.as_of.isoformat("T", "seconds")}'
+            u += f"asOf={self.as_of.isoformat('T', 'seconds')}"
         if ver >= ApiVersion.V2_2_0:
             if self.obs_dimension or self.as_of:
                 u += "&"
@@ -130,10 +127,7 @@ class SchemaQuery(CoreQuery, frozen=True, omit_defaults=True):
         return u
 
     def _create_short_query(self, ver: ApiVersion) -> str:
-        u = (
-            f"/schema/{self.context.value}/"
-            f"{self.agency_id}/{self.resource_id}"
-        )
+        u = f"/schema/{self.context.value}/{self.agency_id}/{self.resource_id}"
         if self.version != REST_LATEST:
             u += f"/{self._to_kw(self.version, ver)}"
         if self.obs_dimension or self.explicit or self.as_of or self.deletion:
@@ -147,7 +141,7 @@ class SchemaQuery(CoreQuery, frozen=True, omit_defaults=True):
         if self.as_of:
             if self.obs_dimension:
                 u += "&"
-            u += f'asOf={self.as_of.isoformat("T", "seconds")}'
+            u += f"asOf={self.as_of.isoformat('T', 'seconds')}"
         if self.deletion:
             if self.obs_dimension or self.as_of:
                 u += "&"

pysdmx/api/qb/service.py

@@ -166,8 +166,12 @@ class RestService(_CoreRestService):
         return self.__fetch(q, f)
 
     def __fetch(self, query: str, format: str) -> bytes:
-        with httpx.Client(verify=self._ssl_context) as client:
+        with httpx.Client(
+            verify=self._ssl_context, follow_redirects=True
+        ) as client:
             try:
+                query = _add_query_slash(query)
+
                 url = f"{self._api_endpoint}{query}"
                 h = self._headers.copy()
                 h["Accept"] = format
@@ -282,8 +286,12 @@ class AsyncRestService(_CoreRestService):
         return out
 
     async def __fetch(self, query: str, format: str) -> bytes:
-        async with httpx.AsyncClient(verify=self._ssl_context) as client:
+        async with httpx.AsyncClient(
+            verify=self._ssl_context, follow_redirects=True
+        ) as client:
             try:
+                query = _add_query_slash(query)
+
                 url = f"{self._api_endpoint}{query}"
                 h = self._headers.copy()
                 h["Accept"] = format
@@ -336,12 +344,22 @@ class _CoreGdsRestService:
             raise errors.Unavailable("Connection error", msg) from e
 
 
+def _add_query_slash(query: str) -> str:
+    if "?" not in query and "#" not in query and not query.endswith("/"):
+        query += "/"
+    return query
+
+
 class GdsRestService(_CoreGdsRestService):
     """Synchronous GDS-REST service."""
 
     def _fetch(self, query: str, format_: str) -> bytes:
-        with httpx.Client(verify=self._ssl_context) as client:
+        with httpx.Client(
+            verify=self._ssl_context, follow_redirects=True
+        ) as client:
             try:
+                query = _add_query_slash(query)
+
                 url = f"{self._api_endpoint}{query}"
                 headers = {**self._headers, "Accept": format_}
                 response = client.get(
@@ -362,8 +380,12 @@ class GdsAsyncRestService(_CoreGdsRestService):
     """Asynchronous GDS-REST service."""
 
     async def _fetch(self, query: str, format_: str) -> bytes:
-        async with httpx.AsyncClient(verify=self._ssl_context) as client:
+        async with httpx.AsyncClient(
+            verify=self._ssl_context, follow_redirects=True
+        ) as client:
             try:
+                query = _add_query_slash(query)
+
                 url = f"{self._api_endpoint}{query}"
                 headers = {**self._headers, "Accept": format_}
                 response = await client.get(

pysdmx/api/qb/structure.py

@@ -433,7 +433,7 @@ class StructureQuery(CoreQuery, frozen=True, omit_defaults=True):
         u += f"/{i}" if all(ck) else ""
         u += f"?detail={self.detail.value}&references={self.references.value}"
         if self.as_of:
-            u += f'&asOf={self.as_of.isoformat("T", "seconds")}'
+            u += f"&asOf={self.as_of.isoformat('T', 'seconds')}"
         return u
 
     def _create_short_query(self, ver: ApiVersion) -> str:
@@ -492,7 +492,7 @@ class StructureQuery(CoreQuery, frozen=True, omit_defaults=True):
             else ""
         )
         u += (
-            f'asOf={self.as_of.isoformat("T", "seconds")}'
+            f"asOf={self.as_of.isoformat('T', 'seconds')}"
             if self.as_of
             else ""
         )

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

@@ -14,12 +14,21 @@ from pysdmx.io.json.fusion.messages.dataflow import (
     FusionDataflowMessage,
     FusionDataflowsMessage,
 )
+from pysdmx.io.json.fusion.messages.dsd import FusionDataStructuresMessage
 from pysdmx.io.json.fusion.messages.map import (
     FusionMappingMessage,
     FusionRepresentationMapMessage,
 )
+from pysdmx.io.json.fusion.messages.metadataflow import (
+    FusionMetadataflowsMessage,
+)
+from pysdmx.io.json.fusion.messages.mpa import (
+    FusionMetadataProvisionAgreementMessage,
+)
+from pysdmx.io.json.fusion.messages.msd import FusionMetadataStructuresMessage
 from pysdmx.io.json.fusion.messages.org import (
     FusionAgencyMessage,
+    FusionMetadataProviderMessage,
     FusionProviderMessage,
 )
 from pysdmx.io.json.fusion.messages.pa import (
@@ -41,6 +50,10 @@ __all__ = [
     "FusionDataflowMessage",
     "FusionDataflowsMessage",
     "FusionMappingMessage",
+    "FusionMetadataflowsMessage",
+    "FusionMetadataProviderMessage",
+    "FusionMetadataProvisionAgreementMessage",
+    "FusionMetadataStructuresMessage",
     "FusionRepresentationMapMessage",
     "FusionAgencyMessage",
     "FusionProviderMessage",
@@ -48,4 +61,5 @@ __all__ = [
     "FusionSchemaMessage",
     "FusionTransfoMsg",
     "FusionPAMessage",
+    "FusionDataStructuresMessage",
 ]

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

@@ -20,10 +20,12 @@ from pysdmx.model import (
     Codelist,
     Component,
     Components,
+    DataStructureDefinition,
     DataType,
     Facets,
     Role,
 )
+from pysdmx.model.dataflow import Group
 from pysdmx.util import parse_item_urn
 
 
@@ -248,7 +250,7 @@ class FusionDataStructure(Struct, frozen=True, rename={"agency": "agencyId"}):
     measures: Sequence[FusionMeasure] = ()
     attributeList: Optional[FusionAttributes] = None
     groups: Sequence[FusionGroup] = ()
-    description: Optional[Sequence[FusionString]] = None
+    descriptions: Optional[Sequence[FusionString]] = None
     version: str = "1.0"
 
     def get_components(
@@ -273,3 +275,52 @@ class FusionDataStructure(Struct, frozen=True, rename={"agency": "agencyId"}):
                 )
             )
         return Components(comps)
+
+    def to_model(
+        self,
+        cs: Sequence[FusionConceptScheme],
+        cls: Sequence[FusionCodelist],
+        vls: Sequence[FusionCodelist],
+        constraints: Sequence[FusionContentConstraint],
+    ) -> DataStructureDefinition:
+        """Map to pysdmx model class."""
+        enums: list[FusionCodelist] = []
+        enums.extend(cls)
+        enums.extend(vls)
+        cmps = self.get_components(cs, enums, constraints)
+        grps = [
+            Group(g.id, dimensions=g.dimensionReferences) for g in self.groups
+        ]
+        return DataStructureDefinition(
+            id=self.id,
+            name=self.names[0].value,
+            agency=self.agency,
+            description=(
+                self.descriptions[0].value if self.descriptions else None
+            ),
+            version=self.version,
+            components=cmps,
+            groups=grps,
+        )
+
+
+class FusionDataStructuresMessage(Struct, frozen=True, omit_defaults=True):
+    """Fusion-JSON payload for /datastructure queries."""
+
+    ConceptScheme: Sequence[FusionConceptScheme]
+    DataStructure: Sequence[FusionDataStructure]
+    ValueList: Sequence[FusionCodelist] = ()
+    Codelist: Sequence[FusionCodelist] = ()
+    DataConstraint: Sequence[FusionContentConstraint] = ()
+
+    def to_model(self) -> Sequence[DataStructureDefinition]:
+        """Returns the requested data structures."""
+        return [
+            dsd.to_model(
+                self.ConceptScheme,
+                self.Codelist,
+                self.ValueList,
+                self.DataConstraint,
+            )
+            for dsd in self.DataStructure
+        ]

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

@@ -0,0 +1,44 @@
+"""Collection of Fusion-JSON schemas for dataflow queries."""
+
+from typing import Optional, Sequence
+
+from msgspec import Struct
+
+from pysdmx.io.json.fusion.messages.core import FusionString
+from pysdmx.model import Metadataflow as MDF
+
+
+class FusionMetadataflow(Struct, frozen=True, rename={"agency": "agencyId"}):
+    """Fusion-JSON payload for a metadataflow."""
+
+    id: str
+    agency: str
+    names: Sequence[FusionString]
+    metadataStructureRef: str
+    targets: Sequence[str]
+    descriptions: Optional[Sequence[FusionString]] = None
+    version: str = "1.0"
+
+    def to_model(self) -> MDF:
+        """Converts a FusionMetadataflow to a standard metadataflow."""
+        return MDF(
+            id=self.id,
+            agency=self.agency,
+            name=self.names[0].value if self.names else None,
+            description=(
+                self.descriptions[0].value if self.descriptions else None
+            ),
+            version=self.version,
+            structure=self.metadataStructureRef,
+            targets=self.targets,
+        )
+
+
+class FusionMetadataflowsMessage(Struct, frozen=True):
+    """Fusion-JSON payload for /metadataflow queries."""
+
+    Metadataflow: Sequence[FusionMetadataflow]
+
+    def to_model(self) -> Sequence[MDF]:
+        """Returns the requested metadataflow details."""
+        return [df.to_model() for df in self.Metadataflow]

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

@@ -0,0 +1,45 @@
+"""Collection of Fusion-JSON schemas for provision agreements."""
+
+from typing import Optional, Sequence
+
+from msgspec import Struct
+
+from pysdmx.io.json.fusion.messages.core import FusionString
+from pysdmx.model import MetadataProvisionAgreement as MPA
+
+
+class FusionMetadataProvisionAgreement(
+    Struct, frozen=True, rename={"agency": "agencyId"}
+):
+    """Fusion-JSON payload for a metadata provision agreement."""
+
+    id: str
+    names: Sequence[FusionString]
+    agency: str
+    metadataflowRef: str
+    metadataproviderRef: str
+    descriptions: Optional[Sequence[FusionString]] = None
+    version: str = "1.0"
+
+    def to_model(self) -> MPA:
+        """Converts a JsonPA to a standard provision agreement."""
+        description = self.descriptions[0].value if self.descriptions else None
+        return MPA(
+            id=self.id,
+            name=self.names[0].value,
+            agency=self.agency,
+            description=description,
+            version=self.version,
+            metadata_provider=self.metadataproviderRef,
+            metadataflow=self.metadataflowRef,
+        )
+
+
+class FusionMetadataProvisionAgreementMessage(Struct, frozen=True):
+    """Fusion-JSON payload for /metadataprovisionagreement queries."""
+
+    MetadataProvisionAgreement: Sequence[FusionMetadataProvisionAgreement]
+
+    def to_model(self) -> Sequence[MPA]:
+        """Returns the requested metadata provision agreements."""
+        return [c.to_model() for c in self.MetadataProvisionAgreement]