Handle validFrom, validTo, and annotations on ItemSchemes

doc/whatsnew.rst

@@ -6,6 +6,7 @@ What's new?
 Next release
 ============
 
+- Fix two bugs in parsing :class:`.ItemScheme` from SDMX-ML: :attr:`.VersionableArtefact.valid_from`, :attr:`~.VersionableArtefact.valid_to` not stored, and :class:`Annotations <.Annotation>` for the scheme itself erroneously collected by the first :class:`.Item` in the scheme (:pull:`143`; thanks :gh-user:`goatsweater` for :issue:`142`).
 - Update :ref:`OECD <OECD>` to support the provider's recently-added SDMX-ML API (:pull:`140`).
   Rename the corresponding, older SDMX-JSON source :ref:`OECD_JSON <OECD_JSON>`; work around a known issue with its SSL configuration (see :func:`.oecd_json.Client`).
 

sdmx/reader/xml/v21.py

@@ -576,7 +576,15 @@ def maintainable(self, cls, elem, **kwargs):
         the same object ID will return references to the same object.
         """
         kwargs.setdefault("is_external_reference", elem is None)
-        setdefault_attrib(kwargs, elem, "isExternalReference", "isFinal", "version")
+        setdefault_attrib(
+            kwargs,
+            elem,
+            "isExternalReference",
+            "isFinal",
+            "validFrom",
+            "validTo",
+            "version",
+        )
         kwargs["is_final"] = kwargs.get("is_final", None) == "true"
 
         # Create a candidate object
@@ -956,7 +964,7 @@ def _item_start(reader, elem):
         # No child elements; stash() anyway, but it will be a no-op
         pass
 
-    reader.stash("Name", "Description")
+    reader.stash(model.Annotation, "Name", "Description")
 
 
 @end(
@@ -1393,7 +1401,6 @@ def _cc(reader, elem):
         else:
             content.add(resolved)
 
-    # return reader.nameable(
     return reader.maintainable(
         cls,
         elem,

sdmx/testing/__init__.py

@@ -275,6 +275,7 @@ def __init__(self, base_path):
                 ("UNICEF", "GLOBAL_DATAFLOW-structure.xml"),
                 ("UNSD", "codelist_partial.xml"),
                 ("SGR", "common-structure.xml"),
+                ("TEST", "gh-142.xml"),
             ]
         )
 

sdmx/tests/reader/test_reader_xml_v21.py

@@ -117,6 +117,21 @@ def test_gh_116(specimen):
     assert cl4.is_partial and 0 < len(cl4) < len(cl3)
 
 
+def test_gh_142(specimen):
+    """Test of https://github.com/khaeru/sdmx/issues/142."""
+    with specimen("TEST/gh-142.xml") as f:
+        msg = sdmx.read_sdmx(f)
+
+    # Annotations, valid_from and valid_to properties stored on the Codelist *per se*
+    cl = msg.codelist["CL_NAICS"]
+    assert 3 == len(cl.annotations)
+    assert "2021-01-24T08:00:00" == cl.valid_from
+    assert "2021-09-24T08:00:00" == cl.valid_to
+
+    # No annotations attached to any Code
+    assert all(0 == len(code.annotations) for code in cl)
+
+
 # Each entry is a tuple with 2 elements:
 # 1. an instance of lxml.etree.Element to be parsed.
 # 2. Either: