Development¶
This page describes the development of sdmx
.
Contributions are welcome!
For current development priorities, see the list of GitHub milestones and issues/PRs targeted to each.
For wishlist features, see issues on GitHub tagged ‘enh’ or ‘wishlist’.
Code style¶
Apply the following to new or modified code:
isort -rc . && black . && mypy . && flake8
Respectively, these:
Write docstrings in the numpydoc style.
Test specimens¶
New in version 2.0.
A variety of specimens—example files from real web services, or published with the standards—are used to test that sdmx
correctly reads and writes the different SDMX message formats.
Since v2.0, specimens are stored in the separate sdmx-test-data repository.
Running the test suite requires these files. To retrieve them, use one of the following methods:
Obtain the files by one of two methods:
Clone
khaeru/sdmx-test-data
:$ git clone git@github.com:khaeru/sdmx-test-data.git
Download https://github.com/khaeru/sdmx-test-data/archive/master.zip
Indicate where pytest can find the files, by one of two methods:
Set the SDMX_TEST_DATA environment variable:
# Set the variable only for one command $ SDMX_TEST_DATA=/path/to/files pytest # Export the variable to the environment $ export SDMX_TEST_DATA $ pytest
Give the option
--sdmx-test-data=<PATH>
when invoking pytest:$ pytest --sdmx-test-data=/path/to/files
The files are:
Arranged in directories with names matching particular sources in
sources.json
.Named with:
Certain keywords:
-structure
: a structure message, often associated with a file with a similar name containing a data message.ts
: time-series data, i.e. with a TimeDimensions at the level of individual Observations.xs
: cross-sectional data arranged in other ways.flat
: flat DataSets with all Dimensions at the Observation level.ss
: structure-specific data messages.
In some cases, the query string or data flow/structure ID as the file name.
Hyphens
-
instead of underscores_
.
Releasing¶
Before releasing, check:
https://github.com/khaeru/sdmx/actions?query=workflow:test+branch:main to ensure that the push and scheduled builds are passing.
https://readthedocs.org/projects/sdmx1/builds/ to ensure that the docs build is passing.
Address any failures before releasing.
Edit
doc/whatsnew.rst
. Comment the heading “Next release”, then insert another heading below it, at the same level, with the version number and date. Make a commit with a message like “Mark vX.Y.Z in doc/whatsnew”.Tag the version as a release candidate, i.e. with a
rcN
suffix, and push:$ git tag v1.2.3rc1 $ git push --tags origin main
Check:
at https://github.com/khaeru/sdmx/actions?query=workflow:publish that the workflow completes: the package builds successfully and is published to TestPyPI.
at https://test.pypi.org/project/sdmx1/ that:
The package can be downloaded, installed and run.
The README is rendered correctly.
Address any warnings or errors that appear. If needed, make a new commit and go back to step (2), incrementing the rc number.
Optional. This step (but not step (2)) can also be performed directly on GitHub; see (5), next. Tag the release itself and push:
$ git tag v1.2.3 $ git push --tags origin main
Visit https://github.com/khaeru/sdmx/releases and mark the new release: either using the pushed tag from (4), or by creating the tag and release simultaneously.
Check at https://github.com/khaeru/sdmx/actions?query=workflow:publish and https://pypi.org/project/sdmx1/ that the distributions are published.
Internal code reference¶
testing
: Testing utilities¶
-
class
sdmx.testing.
MessageTest
[source]¶ Bases:
object
Base class for tests of specific specimen files.
-
directory
: Union[str, pathlib.Path] = PosixPath('.')¶
-
-
class
sdmx.testing.
SpecimenCollection
(base_path)[source]¶ Bases:
object
Collection of test specimens.
-
as_params
(format=None, kind=None, marks={})[source]¶ Generate
pytest.param()
from specimens.One
param()
is generated for each specimen that matches the format and kind arguments (if any). Marks are attached to each param from marks, wherein the keys are partial paths.
-
expected_data
(path)[source]¶ Return the expected
to_pandas()
result for the specimen path.
-
-
sdmx.testing.
generate_endpoint_tests
(metafunc)[source]¶ pytest hook for parametrizing tests that need an “endpoint” fixture.
-
sdmx.testing.
pytest_addoption
(parser)[source]¶ Add the
--sdmx-test-data
command-line option to pytest.
-
sdmx.testing.
pytest_generate_tests
(metafunc)[source]¶ Generate tests.
Calls both
parametrize_specimens()
andgenerate_endpoint_tests()
.
-
sdmx.testing.
specimen
(pytestconfig)[source]¶ Fixture: the
SpecimenCollection
.
-
sdmx.testing.
unsupported
= MarkDecorator(mark=Mark(name='xfail', args=(), kwargs={'strict': True, 'reason': 'Known non-supported endpoint.', 'raises': <class 'NotImplementedError'>}))¶ This exception is raised by client.Client._request_from_args
Todo
parametrize force=True to query these endpoints anyway; then XPASS will reveal when data sources change their support for endpoints
Inline TODOs¶
Todo
Support selection of language for conversion of
InternationalString
.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/sdmx1/checkouts/v2.4.0/doc/api.rst, line 146.)
Todo
parametrize force=True to query these endpoints anyway; then XPASS will reveal when data sources change their support for endpoints
(The original entry is located in docstring of sdmx.testing.unsupported, line 3.)