Merge pull request #244 from khaeru/enh/to_pandas-labels

Refine handling of labels="both"

Author: khaeru

doc/api/format.rst

@@ -16,7 +16,7 @@ In general, the :mod:`sdmx` package:
 
 - **reads** most :ref:`sdmx-csv`, :ref:`sdmx-json` 1.0, and :ref:`sdmx-ml` messages;
   see details in the individual sections below and the linked :mod:`.reader` submodules.
-- **writes** certain :ref:`sdmx-csv` 1.0, and :ref:`sdmx-ml` formats;
+- **writes** certain :ref:`sdmx-csv` and :ref:`sdmx-ml` formats;
   see details below and the linked :ref:`.writer` submodules.
 - is **tested** using collected specimens of messages in various formats,
   stored in the `khaeru/sdmx-test-data <https://github.com/khaeru/sdmx-test-data/>`_ Git repository.
@@ -62,15 +62,19 @@ The SDMX-CSV *format* is versioned differently from the overall SDMX *standard*:
   The format differs from and is not backwards compatible with SDMX-CSV 1.0.
   SDMX-CSV 2.0.0 files are recognizable by the header ``STRUCTURE`` in the first column of the first row.
 
+  :mod:`.reader.csv` supports reading SDMX-CSV 2.0.0.
+
   .. versionadded:: 2.19.0
 
-     Initial support for *reading* SDMX-CSV 2.0.0.
-     See :mod:`.reader.csv`.
+     Initial support for reading SDMX-CSV 2.0.0.
+
+  :mod:`.writer.csv` supports writing SDMX-CSV 2.0.0.
+  Currently, only :attr:`Keys.none` is supported;
+  passing any other value raises :class:`ValueError`.
 
   .. versionadded:: 2.23.0
 
-     Initial support for *writing* SDMX-CSV 2.0.0.
-     See :mod:`.writer.csv`.
+     Initial support for writing SDMX-CSV 2.0.0.
 
 .. automodule:: sdmx.format.csv.common
    :members:

doc/walkthrough.rst

@@ -274,7 +274,6 @@ We also see that 'USD' and 'JPY' are valid values along both dimensions.
 
 Attribute names and allowed values can be obtained in a similar fashion.
 
-
 Select and query data from a dataflow
 =====================================
 
@@ -430,12 +429,16 @@ Thus we can now generate our pandas DataFrame from daily exchange rate data only
     cur_df.shape
     cur_df.tail()
 
-
 .. _datetime:
 
 Convert dimensions to :class:`pandas.DatetimeIndex` or :class:`~pandas.PeriodIndex`
 -----------------------------------------------------------------------------------
 
+.. warning:: This section describes the use of the deprecated :attr:`~.PandasConverter.datetime` argument.
+   See the migration notes for :ref:`v2.23.0`.
+
+.. todo:: Update the section to use the current arguments.
+
 SDMX datasets often have a :class:`~.Dimension` with a name like ``TIME_PERIOD``.
 To ease further processing of time-series data read from SDMX messages,
 :func:`.convert_dataset` provides a `datetime` argument

doc/whatsnew.rst

@@ -40,9 +40,9 @@ All changes
   - :func:`sdmx.util.compare` is deprecated and will be removed in a future version.
 
 - :func:`.to_csv` supports writing :ref:`sdmx-csv` version 2.0.0 (:pull:`243`).
-- :func:`.to_csv` and :func:`.to_pandas` support :attr:`.Labels.both`
-  (:pull:`243`, thanks :gh-user:`aboddie` for :pull:`242`).
-- New modules (:pull:`243`):
+- :func:`.to_csv` and :func:`.to_pandas` support :attr:`.Labels.both` and :attr:`.Labels.name`
+  (:pull:`243`, :pull:`244`, thanks :gh-user:`aboddie` for :pull:`242`).
+- New modules (:pull:`243`, :pull:`244`):
 
   - :mod:`.convert` and :mod:`.convert.common`.
   - :mod:`.convert.pandas` and :class:`.PandasConverter`, replacing :py:`.writer.pandas`.
@@ -56,6 +56,10 @@ All changes
   - Key is sortable (:pull:`234`).
   - :meth:`.Key.copy` returns the same type for subclasses (:pull:`243`).
 
+- :meth:`DataStructure.make_key <.BaseDataStructureDefinition.make_key>`
+  associates :class:`.Code` to :attr:`.KeyValue.value`
+  when :attr:`.Representation.enumerated` is set
+  for the respective :attr:`Dimension.local_representation <.Component.local_representation>` (:pull:`244`).
 - :func:`.install_schemas` and :func:`.construct_schema` fetch, store, and use a local copy of :file:`xhtml1-strict.dsd` (:pull:`236`, :issue:`235`).
   This enables use of :func:`.validate_xml`
   with lxml version 6.0.0 (`released 2025-06-26 <https://lxml.de/6.0/changes-6.0.0.html>`__)