Skip to content

Commit

Permalink
Add #192 to doc/whatsnew
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed Sep 3, 2024
1 parent ef8d9d9 commit e4d53d6
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 10 deletions.
21 changes: 19 additions & 2 deletions doc/whatsnew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,25 @@
What's new?
***********

.. Next release
.. ============
Next release
============

- :class:`MetadataStructureDefinition <.BaseMetadataStructureDefinition>` and :class:`MetadataSet <.BaseMetadataSet>` can be written to and read from SDMX-ML (:pull:`192`).

- Clarify differences between :attr:`.v21.MetadataSet.structured_by` and :attr:`.v30.MetadataSet.structured_by`, according to the respective standards documents.
- Read and write :class:`.MetadataAttribute`, :class:`.MetadataReport`, :class:`.ReportedAttribute`, :class:`.Period`, and associated classes and subclasses.
- :class:`.XHTMLAttributeValue` contents are stored as :mod:`lxml.etree` nodes.
- MetadataStructureDefinition is included when writing :class:`.StructureMessage`.

- Update base url for :ref:`WB_WDI` source to use HTTPS instead of plain HTTP (:issue:`191`, :pull:`192`).
- Improvements to :mod:`.reader.xml` and :mod:`.reader.xml.v21` (:pull:`192`).

- Correctly associate :class:`.Item` in :class:`.ItemScheme` with its parent, even if the parent is defined after the child (“forward reference”).
- Bugfix: correctly handle a :class:`.MaintainableArtefact` that is explicitly included in a message (that is, not merely referenced), but with :py:`is_external_reference = True`; the value given in the file is preserved.
- Bugfix: :class:`.FacetValueType` is written in UpperCamelCase per the standard.
The standard specifies lowerCamelCase only in the Information Model.
- Bugfix: erroneous extra :xml:`<Ref ... style="Ref"/>` attribute is no longer written.
- Expand logged information in :meth:`.ComponentList.compare` (:pull:`192`).

v2.16.0 (2024-08-16)
====================
Expand Down
4 changes: 2 additions & 2 deletions sdmx/model/v21.py
Original file line number Diff line number Diff line change
Expand Up @@ -514,8 +514,8 @@ class MetadataSet(NameableArtefact, common.BaseMetadataSet):
described_by: Optional[MetadataflowDefinition] = None
# described_by: Optional[ReportStructure] = None

#: .. seealso:: :attr:`.v30.MetadataSet.structured_by`, which has different
#: semantics.
#: .. seealso::
#: :attr:`.v30.MetadataSet.structured_by`, which has different semantics.
structured_by: Optional[MetadataStructureDefinition] = None

#: Analogous to :attr:`.v30.MetadataSet.provided_by`.
Expand Down
14 changes: 8 additions & 6 deletions sdmx/model/v30.py
Original file line number Diff line number Diff line change
Expand Up @@ -486,18 +486,20 @@ class MetadataSet(MaintainableArtefact, common.BaseMetadataSet):
valid_to: Optional[str] = None
set_id: Optional[str] = None

#: .. note:: According to the standard, MetadataSet has **two** associations, both
#: named :py:`.described_by`: one to a :class:`.Metadataflow`, and the other to a
#: .. note::
#: According to the standard, MetadataSet has **two** associations, both named
#: :py:`.described_by`: one to a :class:`.Metadataflow`, and the other to a
#: :class:`.MetadataProvisionAgreement`. :mod:`sdmx` implements the first,
#: because it is consistent with SDMX 2.1.
described_by: Optional[Metadataflow] = None

# described_by: Optional[MetadataProvisionAgreement] = None

#: .. note:: According to the standard, this differs from
#: :attr:`v21.MetadataSet.structured_by` in pointing to
#: :attr:`.MetadataStructureDefinition.attributes`, directly, rather than to the
#: MetadataStructureDefinition itself.
#: .. note::
#: According to the standard, this differs from
#: :attr:`v21.MetadataSet.structured_by` in that it points directly to
#: :attr:`.MetadataStructureDefinition.attributes`, rather than to the
#: MetadataStructureDefinition that contains the attribute descriptor.
structured_by: Optional[MetadataAttributeDescriptor] = None

#: Analogous to :attr:`.v21.MetadataSet.published_by`.
Expand Down

0 comments on commit e4d53d6

Please sign in to comment.