Miscellaneous improvements from 2025-W08 #227

khaeru · 2025-03-02T12:12:17Z

Add .model.v{21,30}.Annotation
- Add BaseAnnotation.value attribute: read-only on v21.Annotation, mutable on v30.Annotation. This is an Information Model change in SDMX 3.0.0 that is not mentioned in the list of changes.
- Adjust usage in code, tests.
- Add tests for v{21,30}.Annotation.
- Read <com:AnnotationValue> from SDMX-ML 3.0.0 and store (partly addresses Read SDMX-ML returned by IMF sources #226).
More as recorded in doc/whatsnew.rst.

PR checklist

Checks all ✅
Update documentation
Update doc/whatsnew.rst

codecov · 2025-03-02T12:14:22Z

Codecov Report

Attention: Patch coverage is 99.11700% with 4 lines in your changes missing coverage. Please review.

Project coverage is 98.21%. Comparing base (5588f01) to head (3504cdf).
Report is 32 commits behind head on main.

Files with missing lines	Patch %	Lines
sdmx/reader/xml/v30.py	82.35%	3 Missing ⚠️
sdmx/reader/xml/v21.py	99.19%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #227      +/-   ##
==========================================
- Coverage   98.90%   98.21%   -0.69%     
==========================================
  Files         101      101              
  Lines        8406     8646     +240     
==========================================
+ Hits         8314     8492     +178     
- Misses         92      154      +62

Files with missing lines	Coverage Δ
sdmx/format/xml/common.py	`100.00% <100.00%> (ø)`
sdmx/format/xml/v21.py	`100.00% <ø> (ø)`
sdmx/format/xml/v30.py	`100.00% <ø> (ø)`
sdmx/message.py	`100.00% <100.00%> (ø)`
sdmx/model/common.py	`99.90% <100.00%> (+<0.01%)`	⬆️
sdmx/model/v21.py	`100.00% <100.00%> (ø)`
sdmx/model/v30.py	`100.00% <100.00%> (ø)`
sdmx/reader/xml/common.py	`100.00% <100.00%> (ø)`
sdmx/testing/data.py	`100.00% <ø> (ø)`
sdmx/tests/model/test_common.py	`100.00% <100.00%> (ø)`
... and 9 more

... and 18 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Add BaseAnnotation.value attribute, read-only on v21.Annotation. - Adjust usage in code, tests. - Add tests for v{21,30}.Annotation. - Read and store <com:AnnotationValue> from SDMX-ML 3.0.0.

- Copyedit some text. - Add a table with version correspondence. - Use complete "3.0.0" labels throughout.

IMF/CL_FREQ-3.0-structure.xml contains the elements: - <common:AnnotationValue> - <common:Link>

- Also ReportedAttribute.get_child(). - Ensure bool(ReportedAttribute) is True. - Test instantiation of TextAttributeValue. - Add tests.

Construct an lxml.etree.XMLSchema instance that can handle XHTML embedded in MetadataMessage.

Use metadata structure to aid reading metadata messages.

- Write {Metad,D}ataSet.annotations. - Write <md:Report id="…"> attribute and annotations. - Do not (incorrectly) write MetadataReport.target. - Write <md:Target id="…"> attribute and annotations. - Handle {v21,v30}.DataSet and subclasses via tag_for_class().

- IMF/CL_FREQ-3.0-structure.xml contains the elements: - <common:AnnotationValue> - <common:Link> - IMF/datastructure-0.xml contains <str:ConceptIdentity> and <str:ConceptRole>, with the latter referring to external item schemes. - IMF/hierarchicalcodelist-1.xml contains <str:Hierarchy> *without* the leveled=… attribute.

- Allows sorted() on collections including both IA and str. - Expand tests.

Allow use of named stashes, instead of LIFO.

Document +describedBy error in SDMX 2.1 IM.

- Ensure annotations, name, description are associated to the correct objects. - Handle <str:Level> as a reference and store HierarchicalCode.level. - Use reader.model.Annotation everywhere.

Retrieve an ID from an attribute according to whether structure-specific or generic SDMX-ML

- Collapse generic and structure-specific readers of {Group,Series}Key. - Document standards error/lacuna regarding multi-valued AttributeValue.

khaeru added enh Enhancements & new features xml SDMX-ML format reader Read file formats defined by the SDMX standards sdmx-3 Support for SDMX 3.0 (2021), 3.1 (2025), etc. labels Mar 2, 2025

khaeru self-assigned this Mar 2, 2025

khaeru temporarily deployed to publish March 2, 2025 12:12 — with GitHub Actions Inactive

khaeru added 2 commits March 4, 2025 15:06

Add .model.v{21,30}.Annotation

91b5663

- Add BaseAnnotation.value attribute, read-only on v21.Annotation. - Adjust usage in code, tests. - Add tests for v{21,30}.Annotation. - Read and store <com:AnnotationValue> from SDMX-ML 3.0.0.

Improve doc/implementation

78d7628

- Copyedit some text. - Add a table with version correspondence. - Use complete "3.0.0" labels throughout.

khaeru force-pushed the enh/2025-w08 branch from caefcb3 to bf6ac5f Compare March 4, 2025 14:31

khaeru temporarily deployed to publish March 4, 2025 14:31 — with GitHub Actions Inactive

khaeru added a commit to khaeru/sdmx-test-data that referenced this pull request Mar 4, 2025

Add specimen for khaeru/sdmx#227

f5389e0

IMF/CL_FREQ-3.0-structure.xml contains the elements: - <common:AnnotationValue> - <common:Link>

khaeru mentioned this pull request Mar 4, 2025

Clarify role of <com:Link> in SDMX-ML 3.0.0 #228

Open

khaeru added a commit that referenced this pull request Mar 5, 2025

Add specimen for #227

88cad1a

khaeru force-pushed the enh/2025-w08 branch from bf6ac5f to 09d3f86 Compare March 5, 2025 13:18

khaeru temporarily deployed to publish March 5, 2025 13:18 — with GitHub Actions Inactive

khaeru linked an issue Mar 5, 2025 that may be closed by this pull request

Read SDMX-ML returned by IMF sources #226

Closed

khaeru added 5 commits March 7, 2025 17:31

Add MetadataReport.get{,_value}() methods

8b25a3b

- Also ReportedAttribute.get_child(). - Ensure bool(ReportedAttribute) is True. - Test instantiation of TextAttributeValue. - Add tests.

Add .format.xml.common.construct_schema()

f8a0ce0

Construct an lxml.etree.XMLSchema instance that can handle XHTML embedded in MetadataMessage.

Split test_{meta,}data_roundtrip()

6dec2c4

Use metadata structure to aid reading metadata messages.

Make v21.MetadataReport an AnnotableArtefact

22cc110

khaeru added a commit that referenced this pull request Mar 7, 2025

Add 3 specimens for #227

f59e348

khaeru force-pushed the enh/2025-w08 branch from 09d3f86 to e7f9e71 Compare March 7, 2025 16:49

khaeru temporarily deployed to publish March 7, 2025 16:49 — with GitHub Actions Inactive

khaeru temporarily deployed to publish March 12, 2025 23:39 — with GitHub Actions Inactive

khaeru force-pushed the enh/2025-w08 branch from 2c43d8b to 612c6e5 Compare March 13, 2025 10:48

khaeru temporarily deployed to publish March 13, 2025 10:49 — with GitHub Actions Inactive

khaeru force-pushed the enh/2025-w08 branch from 23a58b8 to 12fc0c8 Compare March 13, 2025 15:22

khaeru temporarily deployed to publish March 13, 2025 15:22 — with GitHub Actions Inactive

khaeru added a commit that referenced this pull request Mar 14, 2025

Add #227 to doc/whatsnew

6f70ab2

khaeru temporarily deployed to publish March 14, 2025 08:15 — with GitHub Actions Inactive

khaeru temporarily deployed to publish March 14, 2025 10:23 — with GitHub Actions Inactive

khaeru added a commit that referenced this pull request Mar 14, 2025

Improve test coverage for #227

a53e3df

khaeru temporarily deployed to publish March 14, 2025 10:34 — with GitHub Actions Inactive

khaeru added a commit that referenced this pull request Mar 14, 2025

Improve test coverage for #227

aff7958

khaeru force-pushed the enh/2025-w08 branch from a53e3df to aff7958 Compare March 14, 2025 10:47

khaeru temporarily deployed to publish March 14, 2025 10:48 — with GitHub Actions Inactive

khaeru temporarily deployed to publish March 14, 2025 12:31 — with GitHub Actions Inactive

khaeru force-pushed the enh/2025-w08 branch from a75179f to 4e2e61e Compare March 14, 2025 12:38

khaeru temporarily deployed to publish March 14, 2025 12:38 — with GitHub Actions Inactive

khaeru added 11 commits March 14, 2025 13:48

Implement IdentifiableArtefact.__gt__; handle str

5486932

- Allows sorted() on collections including both IA and str. - Expand tests.

Add name=… kw to XMLEventReader.{un,}stash()

f240e6a

Allow use of named stashes, instead of LIFO.

Add v21.MetadataSet.report_structure

758afef

Document +describedBy error in SDMX 2.1 IM.

Add test fixture metadata_message and test write

28b2807

Improve read of <str:HierarchicalCodelist>

2267829

- Ensure annotations, name, description are associated to the correct objects. - Handle <str:Level> as a reference and store HierarchicalCode.level. - Use reader.model.Annotation everywhere.

Add _get_id() utility

b0458b7

Retrieve an ID from an attribute according to whether structure-specific or generic SDMX-ML

Add #227 to doc/whatsnew

49750ae

Use consistent & explicit imports in .reader.xml

9db68df

- Collapse generic and structure-specific readers of {Group,Series}Key. - Document standards error/lacuna regarding multi-valued AttributeValue.

Improve test coverage for #227

a6ddb1e

Handle full/partial URN in StructureMessage.get()

dff5ef3

Update doc/example.rst and test

3504cdf

khaeru force-pushed the enh/2025-w08 branch from 4e2e61e to 3504cdf Compare March 14, 2025 12:50

khaeru temporarily deployed to publish March 14, 2025 12:50 — with GitHub Actions Inactive

khaeru merged commit 5a6ea56 into main Mar 14, 2025
20 checks passed

khaeru mentioned this pull request Mar 14, 2025

Use more durable IDs for IMF_Beta and IMF_Beta3 #225

Merged

3 tasks

khaeru deleted the enh/2025-w08 branch June 30, 2025 09:53

khaeru mentioned this pull request Jul 16, 2025

Adjust ECB data expectations in 2 tests #236

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Miscellaneous improvements from 2025-W08 #227

Miscellaneous improvements from 2025-W08 #227

Uh oh!

khaeru commented Mar 2, 2025 •

edited

Loading

Uh oh!

codecov bot commented Mar 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Miscellaneous improvements from 2025-W08 #227

Miscellaneous improvements from 2025-W08 #227

Uh oh!

Conversation

khaeru commented Mar 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Uh oh!

codecov bot commented Mar 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

khaeru commented Mar 2, 2025 •

edited

Loading

codecov bot commented Mar 2, 2025 •

edited

Loading