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

pysdmx/__init__.py

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

pysdmx/api/fmr/maintenance.py

@@ -64,9 +64,7 @@ class RegistryMaintenanceClient:
             timeout: The maximum number of seconds to wait before considering
                 that a request timed out. Defaults to 10 seconds.
         """
-        if api_endpoint.endswith("/"):
-            api_endpoint = api_endpoint[0:-1]
-        self._api_endpoint = f"{api_endpoint}"
+        self._api_endpoint = self.__sanitize_endpoint(api_endpoint)
         self._user = user
         self._password = password
         self._timeout = timeout
@@ -87,7 +85,6 @@ class RegistryMaintenanceClient:
     ) -> None:
         with httpx.Client(verify=self._ssl_context) as client:
             try:
-                url = f"{endpoint}"
                 auth = httpx.BasicAuth(self._user, self._password)
                 headers = {
                     "Content-Type": "application/text",
@@ -99,7 +96,7 @@ class RegistryMaintenanceClient:
                     serializer = serializers.structure_message
                 bodyjs = self._encoder.encode(serializer.from_model(message))
                 r = client.post(
-                    url,
+                    endpoint,
                     headers=headers,
                     content=bodyjs,
                     timeout=self._timeout,
@@ -156,3 +153,11 @@ class RegistryMaintenanceClient:
         message = MetadataMessage(header=header, reports=reports)
         endpoint = f"{self._api_endpoint}/ws/secure/sdmx/v2/metadata"
         return self.__post(message, action, endpoint)
+
+    def __sanitize_endpoint(self, endpoint: str) -> str:
+        if endpoint.endswith("/"):
+            endpoint = endpoint[0:-1]
+        endpoint = endpoint.replace("/ws/secure/sdmx/v2/metadata", "")
+        endpoint = endpoint.replace("/sdmx/v2", "")
+        endpoint = endpoint.replace("/ws/secure/sdmxapi/rest", "")
+        return endpoint

pysdmx/io/input_processor.py

@@ -97,6 +97,10 @@ def __get_sdmx_json_flavour(input_str: str) -> Tuple[str, Format]:
         return input_str, Format.STRUCTURE_SDMX_JSON_2_0_0
     elif "2.0.0/sdmx-json-metadata-schema.json" in flavour_check:
         return input_str, Format.REFMETA_SDMX_JSON_2_0_0
+    elif "2.1/sdmx-json-structure-schema.json" in flavour_check:
+        return input_str, Format.STRUCTURE_SDMX_JSON_2_1_0
+    elif "2.1/sdmx-json-metadata-schema.json" in flavour_check:
+        return input_str, Format.REFMETA_SDMX_JSON_2_1_0
     elif "sdmx-json" in flavour_check:
         raise NotImplemented(
             "Unsupported format", "This flavour of SDMX-JSON is not supported."

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

@@ -20,6 +20,7 @@ from pysdmx.model import (
     Codelist,
     Component,
     Components,
+    Concept,
     DataStructureDefinition,
     DataType,
     Facets,
@@ -32,14 +33,15 @@ from pysdmx.util import parse_item_urn
 def _find_concept(
     cs: Sequence[FusionConceptScheme],
     urn: str,
-) -> FusionConcept:
+) -> Optional[FusionConcept]:
     r = parse_item_urn(urn)
     f = [
         m
         for m in cs
         if (m.agency == r.agency and m.id == r.id and m.version == r.version)
     ]
-    return [c for c in f[0].items if c.id == r.item_id][0]
+    m = [c for c in f[0].items if c.id == r.item_id]
+    return m[0] if m else None
 
 
 def _get_representation(
@@ -112,12 +114,13 @@ class FusionAttribute(Struct, frozen=True):
         groups: Sequence[FusionGroup],
     ) -> Component:
         """Returns an attribute."""
-        c = _find_concept(cs, self.concept)
+        m = _find_concept(cs, self.concept) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.concept)
         dt, facets, codes, ab = _get_representation(
             self.id, self.representation, cls, cons
         )
         lvl = self.__derive_level(groups)
-        desc = c.descriptions[0].value if c.descriptions else None
+        desc = c.description if isinstance(c, Concept) else None
         if self.representation and self.representation.representation:
             local_enum_ref = self.representation.representation
         else:
@@ -126,10 +129,10 @@ class FusionAttribute(Struct, frozen=True):
             id=self.id,
             required=self.mandatory,
             role=Role.ATTRIBUTE,
-            concept=c.to_model(cls),
+            concept=c,
             local_dtype=dt,
             local_facets=facets,
-            name=c.names[0].value,
+            name=c.name if isinstance(c, Concept) else None,
             description=desc,
             local_codes=codes,
             attachment_level=lvl,
@@ -168,11 +171,12 @@ class FusionDimension(Struct, frozen=True):
         cons: Dict[str, Sequence[str]],
     ) -> Component:
         """Returns a dimension."""
-        c = _find_concept(cs, self.concept)
+        m = _find_concept(cs, self.concept) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.concept)
         dt, facets, codes, ab = _get_representation(
             self.id, self.representation, cls, cons
         )
-        desc = c.descriptions[0].value if c.descriptions else None
+        desc = c.description if isinstance(c, Concept) else None
         if self.representation and self.representation.representation:
             local_enum_ref = self.representation.representation
         else:
@@ -181,10 +185,10 @@ class FusionDimension(Struct, frozen=True):
             id=self.id,
             required=True,
             role=Role.DIMENSION,
-            concept=c.to_model(cls),
+            concept=c,
             local_dtype=dt,
             local_facets=facets,
-            name=c.names[0].value,
+            name=c.name if isinstance(c, Concept) else None,
             description=desc,
             local_codes=codes,
             array_def=ab,
@@ -222,11 +226,12 @@ class FusionMeasure(Struct, frozen=True):
         cons: Dict[str, Sequence[str]],
     ) -> Component:
         """Returns a measure."""
-        c = _find_concept(cs, self.concept)
+        m = _find_concept(cs, self.concept) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.concept)
         dt, facets, codes, ab = _get_representation(
             self.id, self.representation, cls, cons
         )
-        desc = c.descriptions[0].value if c.descriptions else None
+        desc = c.description if isinstance(c, Concept) else None
         if self.representation and self.representation.representation:
             local_enum_ref = self.representation.representation
         else:
@@ -235,10 +240,10 @@ class FusionMeasure(Struct, frozen=True):
             id=self.id,
             required=self.mandatory,
             role=Role.MEASURE,
-            concept=c.to_model(cls),
+            concept=c,
             local_dtype=dt,
             local_facets=facets,
-            name=c.names[0].value,
+            name=c.name if isinstance(c, Concept) else None,
             description=desc,
             local_codes=codes,
             array_def=ab,

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

@@ -14,13 +14,9 @@ from pysdmx.io.json.fusion.messages.dsd import (
     _find_concept,
     _get_representation,
 )
-from pysdmx.model import (
-    ArrayBoundaries,
-    MetadataComponent,
-)
-from pysdmx.model import (
-    MetadataStructure as MSD,
-)
+from pysdmx.model import ArrayBoundaries, MetadataComponent
+from pysdmx.model import MetadataStructure as MSD
+from pysdmx.util import parse_item_urn
 
 
 class FusionMetadataAttribute(Struct, frozen=True):
@@ -40,7 +36,8 @@ class FusionMetadataAttribute(Struct, frozen=True):
         cls: Sequence[FusionCodelist],
     ) -> MetadataComponent:
         """Returns an attribute."""
-        c = _find_concept(cs, self.concept)
+        m = _find_concept(cs, self.concept) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.concept)
         dt, facets, codes, _ = _get_representation(
             self.id, self.representation, cls, {}
         )
@@ -60,7 +57,7 @@ class FusionMetadataAttribute(Struct, frozen=True):
         return MetadataComponent(
             self.id,
             is_presentational=self.presentational,  # type: ignore[arg-type]
-            concept=c.to_model(cls),
+            concept=c,
             local_dtype=dt,
             local_facets=facets,
             local_codes=codes,

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

@@ -307,17 +307,24 @@ class JsonHeader(msgspec.Struct, frozen=True, omit_defaults=True):
         self,
         header: Header,
         msg_type: Literal["structure", "metadata"] = "structure",
+        msg_version: Literal["2.0.0", "2.1"] = "2.0.0",
     ) -> "JsonHeader":
         """Create an SDMX-JSON header from a pysdmx Header."""
+        if msg_version == "2.0.0":
+            schema = (
+                "https://raw.githubusercontent.com/sdmx-twg/sdmx-json/"
+                f"develop/structure-message/tools/schemas/{msg_version}/"
+                f"sdmx-json-{msg_type}-schema.json"
+            )
+        else:
+            schema = (
+                f"https://json.sdmx.org/2.1/sdmx-json-{msg_type}-schema.json"
+            )
         return JsonHeader(
             header.id,
             header.prepared,
             header.sender,
             header.test,
             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/"
-                f"sdmx-json-{msg_type}-schema.json"
-            ),
+            schema=schema,
         )

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

@@ -34,14 +34,17 @@ from pysdmx.model.dataflow import Group
 from pysdmx.util import parse_item_urn
 
 
-def _find_concept(cs: Sequence[JsonConceptScheme], urn: str) -> JsonConcept:
+def _find_concept(
+    cs: Sequence[JsonConceptScheme], urn: str
+) -> Optional[JsonConcept]:
     r = parse_item_urn(urn)
     f = [
         m
         for m in cs
         if (m.agency == r.agency and m.id == r.id and m.version == r.version)
     ]
-    return [c for c in f[0].concepts if c.id == r.item_id][0]
+    m = [c for c in f[0].concepts if c.id == r.item_id]
+    return m[0] if m else None
 
 
 def _get_type(repr_: JsonRepresentation) -> Optional[str]:
@@ -168,11 +171,8 @@ class JsonDimension(Struct, frozen=True, omit_defaults=True):
         cons: Dict[str, Sequence[str]],
     ) -> Component:
         """Returns a component."""
-        c = (
-            _find_concept(cs, self.conceptIdentity).to_model(cls)
-            if cs
-            else parse_item_urn(self.conceptIdentity)
-        )
+        m = _find_concept(cs, self.conceptIdentity) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.conceptIdentity)
         name = c.name if isinstance(c, Concept) else None
         desc = c.description if isinstance(c, Concept) else None
         dt, facets, codes, ab = _get_representation(
@@ -227,11 +227,8 @@ class JsonAttribute(Struct, frozen=True, omit_defaults=True):
         groups: Sequence[JsonGroup],
     ) -> Component:
         """Returns a component."""
-        c = (
-            _find_concept(cs, self.conceptIdentity).to_model(cls)
-            if cs
-            else parse_item_urn(self.conceptIdentity)
-        )
+        m = _find_concept(cs, self.conceptIdentity) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.conceptIdentity)
         name = c.name if isinstance(c, Concept) else None
         desc = c.description if isinstance(c, Concept) else None
         dt, facets, codes, ab = _get_representation(
@@ -312,11 +309,8 @@ class JsonMeasure(Struct, frozen=True, omit_defaults=True):
         cons: Dict[str, Sequence[str]],
     ) -> Component:
         """Returns a component."""
-        c = (
-            _find_concept(cs, self.conceptIdentity).to_model(cls)
-            if cs
-            else parse_item_urn(self.conceptIdentity)
-        )
+        m = _find_concept(cs, self.conceptIdentity) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.conceptIdentity)
         name = c.name if isinstance(c, Concept) else None
         desc = c.description if isinstance(c, Concept) else None
         dt, facets, codes, ab = _get_representation(

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

@@ -49,11 +49,8 @@ class JsonMetadataAttribute(Struct, frozen=True, omit_defaults=True):
         self, cs: Sequence[JsonConceptScheme], cls: Sequence[Codelist]
     ) -> MetadataComponent:
         """Returns a metadata component."""
-        c = (
-            _find_concept(cs, self.conceptIdentity).to_model(cls)
-            if cs
-            else parse_item_urn(self.conceptIdentity)
-        )
+        m = _find_concept(cs, self.conceptIdentity) if cs else None
+        c = m.to_model(cls) if m else parse_item_urn(self.conceptIdentity)
         dt, facets, codes, _ = _get_representation(
             self.id, self.localRepresentation, cls, {}
         )

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

@@ -1,6 +1,6 @@
 """Collection of SDMX-JSON schemas for reference metadata queries."""
 
-from typing import Any, Optional, Sequence
+from typing import Any, Literal, Optional, Sequence
 
 from msgspec import Struct
 
@@ -162,7 +162,11 @@ class JsonMetadataMessage(Struct, frozen=True, omit_defaults=True):
         return MetadataMessage(header, reports)
 
     @classmethod
-    def from_model(self, msg: MetadataMessage) -> "JsonMetadataMessage":
+    def from_model(
+        self,
+        msg: MetadataMessage,
+        msg_version: Literal["2.0.0", "2.1"] = "2.0.0",
+    ) -> "JsonMetadataMessage":
         """Converts a pysdmx metadata message to an SDMX-JSON one."""
         if not msg.header:
             raise errors.Invalid(
@@ -175,6 +179,6 @@ class JsonMetadataMessage(Struct, frozen=True, omit_defaults=True):
                 "SDMX-JSON metadata messages must have metadata reports.",
             )
 
-        header = JsonHeader.from_model(msg.header, "metadata")
+        header = JsonHeader.from_model(msg.header, "metadata", msg_version)
         reports = [JsonMetadataReport.from_model(r) for r in msg.reports]
         return JsonMetadataMessage(header, JsonMetadataSets(reports))

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

@@ -1,6 +1,6 @@
 """Collection of SDMX-JSON schemas for generic structure messages."""
 
-from typing import Sequence
+from typing import Literal, Sequence
 
 from msgspec import Struct
 
@@ -338,12 +338,16 @@ class JsonStructureMessage(Struct, frozen=True, omit_defaults=True):
         return StructureMessage(header, structures)
 
     @classmethod
-    def from_model(cls, message: StructureMessage) -> "JsonStructureMessage":
+    def from_model(
+        cls,
+        message: StructureMessage,
+        msg_version: Literal["2.0.0", "2.1"] = "2.0.0",
+    ) -> "JsonStructureMessage":
         """Creates an SDMX-JSON payload from a pysdmx StructureMessage."""
         if not message.header:
             raise errors.Invalid(
                 "Invalid input", "SDMX-JSON messages must have a header."
             )
-        header = JsonHeader.from_model(message.header)
+        header = JsonHeader.from_model(message.header, msg_version=msg_version)
         structs = JsonStructures.from_model(message)
         return JsonStructureMessage(header, structs)

pysdmx/io/json/sdmxjson2/reader/metadata.py

@@ -1,4 +1,4 @@
-"""Writer interface for SDMX-JSON 2.0.0 Reference Metadata messages."""
+"""Reader interface for SDMX-JSON 2.0.0 and 2.1.0 Reference Metadata."""
 
 import msgspec
 
@@ -11,7 +11,7 @@ from pysdmx.model.message import MetadataMessage
 
 
 def read(input_str: str, validate: bool = True) -> MetadataMessage:
-    """Read an SDMX-JSON 2.0.0 Metadata Message.
+    """Read SDMX-JSON 2.0.0 and 2.1.0 Metadata messages.
 
     Args:
         input_str: SDMX-JSON reference metadata message to read.
@@ -34,6 +34,6 @@ def read(input_str: str, validate: bool = True) -> MetadataMessage:
             "Invalid message",
             (
                 "The supplied file could not be read as SDMX-JSON 2.0.0 "
-                "reference metadata message."
+                "or 2.1.0 reference metadata message."
             ),
         ) from de

pysdmx/io/json/sdmxjson2/reader/structure.py

@@ -1,4 +1,4 @@
-"""Reader interface for SDMX-JSON 2.0.0 Structure messages."""
+"""Reader interface for SDMX-JSON 2.0.0 and 2.1.0 Structure messages."""
 
 import msgspec
 
@@ -11,7 +11,7 @@ from pysdmx.model.message import StructureMessage
 
 
 def read(input_str: str, validate: bool = True) -> StructureMessage:
-    """Read an SDMX-JSON 2.0.0 Structure Message.
+    """Read SDMX-JSON 2.0.0 and 2.1.0 Structure messages.
 
     Args:
         input_str: SDMX-JSON structure message to read.
@@ -34,6 +34,6 @@ def read(input_str: str, validate: bool = True) -> StructureMessage:
             "Invalid message",
             (
                 "The supplied file could not be read as SDMX-JSON 2.0.0 "
-                "structure message."
+                "or 2.1.0 structure message."
             ),
         ) from de

pysdmx/io/json/sdmxjson2/writer/_helper.py

@@ -0,0 +1,118 @@
+"""Writer interface for SDMX-JSON 2.0.0 Reference Metadata messages."""
+
+from pathlib import Path
+from typing import Literal, Optional, Sequence, Union
+
+import msgspec
+
+from pysdmx.io.json.sdmxjson2.messages import (
+    JsonMetadataMessage,
+    JsonStructureMessage,
+)
+from pysdmx.model import MetadataReport, encoders
+from pysdmx.model.__base import MaintainableArtefact
+from pysdmx.model.message import Header, MetadataMessage, StructureMessage
+
+
+def write_metadata_msg(
+    reports: Sequence[MetadataReport],
+    output_path: Optional[Union[str, Path]] = None,
+    prettyprint: bool = True,
+    header: Optional[Header] = None,
+    msg_version: Literal["2.0.0", "2.1"] = "2.0.0",
+) -> Optional[str]:
+    """Write metadata reports in requested SDMX-JSON version.
+
+    Args:
+        reports: The reference metadata reports to be serialized.
+        output_path: The path to save the JSON file. If None or empty, the
+            serialized content is returned as a string instead.
+        prettyprint: Whether to format the JSON output with indentation (True)
+            or output compact JSON without extra whitespace (False).
+        header: The header to be used in the SDMX-JSON message
+            (will be generated if no header is supplied).
+        msg_version: The desired version of SDMX-JSON. Defaults to 2.0.0.
+
+    Returns:
+        The JSON string if output_path is None or empty, None otherwise.
+    """
+    if not header:
+        header = Header()
+    sm = MetadataMessage(header, reports)
+    jsm = JsonMetadataMessage.from_model(sm, msg_version)
+
+    encoder = msgspec.json.Encoder(enc_hook=encoders)
+    serialized_data = encoder.encode(jsm)
+
+    # Apply pretty-printing if requested
+    if prettyprint:
+        serialized_data = msgspec.json.format(serialized_data, indent=4)
+
+    # If output_path is provided, write to file
+    if output_path:
+        # Convert to Path object if string
+        if isinstance(output_path, str):
+            output_path = Path(output_path)
+
+        # Create parent directories if they don't exist
+        output_path.parent.mkdir(parents=True, exist_ok=True)
+
+        # Write to file
+        with open(output_path, "wb") as f:
+            f.write(serialized_data)
+        return None
+    else:
+        # Return as string
+        return serialized_data.decode("utf-8")
+
+
+def write_structure_msg(
+    structures: Sequence[MaintainableArtefact],
+    output_path: Optional[Union[str, Path]] = None,
+    prettyprint: bool = True,
+    header: Optional[Header] = None,
+    msg_version: Literal["2.0.0", "2.1"] = "2.0.0",
+) -> Optional[str]:
+    """Write maintainable SDMX artefacts in SDMX-JSON 2.0.0.
+
+    Args:
+        structures: The maintainable SDMX artefacts to be serialized.
+        output_path: The path to save the JSON file. If None or empty, the
+            serialized content is returned as a string instead.
+        prettyprint: Whether to format the JSON output with indentation (True)
+            or output compact JSON without extra whitespace (False).
+        header: The header to be used in the SDMX-JSON message
+            (will be generated if no header is supplied).
+        msg_version: The desired version of SDMX-JSON. Defaults to 2.0.0.
+
+    Returns:
+        The JSON string if output_path is None or empty, None otherwise.
+    """
+    if not header:
+        header = Header()
+    sm = StructureMessage(header, structures)
+    jsm = JsonStructureMessage.from_model(sm, msg_version)
+
+    encoder = msgspec.json.Encoder(enc_hook=encoders)
+    serialized_data = encoder.encode(jsm)
+
+    # Apply pretty-printing if requested
+    if prettyprint:
+        serialized_data = msgspec.json.format(serialized_data, indent=4)
+
+    # If output_path is provided, write to file
+    if output_path:
+        # Convert to Path object if string
+        if isinstance(output_path, str):
+            output_path = Path(output_path)
+
+        # Create parent directories if they don't exist
+        output_path.parent.mkdir(parents=True, exist_ok=True)
+
+        # Write to file
+        with open(output_path, "wb") as f:
+            f.write(serialized_data)
+        return None
+    else:
+        # Return as string
+        return serialized_data.decode("utf-8")

pysdmx/io/json/sdmxjson2/writer/v2_0/__init__.py

@@ -0,0 +1 @@
+"""Collection of writers for SDMX-JSON 2.0.0 messages."""

pysdmx/io/json/sdmxjson2/writer/v2_0/metadata.py

@@ -0,0 +1,33 @@
+"""Writer interface for SDMX-JSON 2.0.0 Reference Metadata messages."""
+
+from pathlib import Path
+from typing import Optional, Sequence, Union
+
+from pysdmx.io.json.sdmxjson2.writer._helper import write_metadata_msg
+from pysdmx.model import MetadataReport
+from pysdmx.model.message import Header
+
+
+def write(
+    reports: Sequence[MetadataReport],
+    output_path: Optional[Union[str, Path]] = None,
+    prettyprint: bool = True,
+    header: Optional[Header] = None,
+) -> Optional[str]:
+    """Write metadata reports in SDMX-JSON 2.0.0.
+
+    Args:
+        reports: The reference metadata reports to be serialized.
+        output_path: The path to save the JSON file. If None or empty, the
+            serialized content is returned as a string instead.
+        prettyprint: Whether to format the JSON output with indentation (True)
+            or output compact JSON without extra whitespace (False).
+        header: The header to be used in the SDMX-JSON message
+            (will be generated if no header is supplied).
+
+    Returns:
+        The JSON string if output_path is None or empty, None otherwise.
+    """
+    return write_metadata_msg(
+        reports, output_path, prettyprint, header, "2.0.0"
+    )

pysdmx/io/json/sdmxjson2/writer/v2_0/structure.py

@@ -0,0 +1,33 @@
+"""Writer interface for SDMX-JSON 2.0.0 Structure messages."""
+
+from pathlib import Path
+from typing import Optional, Sequence, Union
+
+from pysdmx.io.json.sdmxjson2.writer._helper import write_structure_msg
+from pysdmx.model.__base import MaintainableArtefact
+from pysdmx.model.message import Header
+
+
+def write(
+    structures: Sequence[MaintainableArtefact],
+    output_path: Optional[Union[str, Path]] = None,
+    prettyprint: bool = True,
+    header: Optional[Header] = None,
+) -> Optional[str]:
+    """Write maintainable SDMX artefacts in SDMX-JSON 2.0.0.
+
+    Args:
+        structures: The maintainable SDMX artefacts to be serialized.
+        output_path: The path to save the JSON file. If None or empty, the
+            serialized content is returned as a string instead.
+        prettyprint: Whether to format the JSON output with indentation (True)
+            or output compact JSON without extra whitespace (False).
+        header: The header to be used in the SDMX-JSON message
+            (will be generated if no header is supplied).
+
+    Returns:
+        The JSON string if output_path is None or empty, None otherwise.
+    """
+    return write_structure_msg(
+        structures, output_path, prettyprint, header, "2.0.0"
+    )

pysdmx/io/json/sdmxjson2/writer/v2_1/__init__.py

@@ -0,0 +1 @@
+"""Collection of writers for SDMX-JSON 2.1.0 messages."""

pysdmx/io/json/sdmxjson2/writer/v2_1/metadata.py

@@ -0,0 +1,31 @@
+"""Writer interface for SDMX-JSON 2.1.0 Reference Metadata messages."""
+
+from pathlib import Path
+from typing import Optional, Sequence, Union
+
+from pysdmx.io.json.sdmxjson2.writer._helper import write_metadata_msg
+from pysdmx.model import MetadataReport
+from pysdmx.model.message import Header
+
+
+def write(
+    reports: Sequence[MetadataReport],
+    output_path: Optional[Union[str, Path]] = None,
+    prettyprint: bool = True,
+    header: Optional[Header] = None,
+) -> Optional[str]:
+    """Write metadata reports in SDMX-JSON 2.1.0.
+
+    Args:
+        reports: The reference metadata reports to be serialized.
+        output_path: The path to save the JSON file. If None or empty, the
+            serialized content is returned as a string instead.
+        prettyprint: Whether to format the JSON output with indentation (True)
+            or output compact JSON without extra whitespace (False).
+        header: The header to be used in the SDMX-JSON message
+            (will be generated if no header is supplied).
+
+    Returns:
+        The JSON string if output_path is None or empty, None otherwise.
+    """
+    return write_metadata_msg(reports, output_path, prettyprint, header, "2.1")