Skip to content

Commit

Permalink
add note about implicit tuple to list conversion on write/read
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram committed Jul 13, 2023
1 parent 8ef92d3 commit 2fa3589
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/asdf/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ and reading trees, see :ref:`overview`.
Integers and floats of up to 64 bits can be stored inside of :mod:`numpy`
arrays (see below).

.. note::

The ASDF standard does not have an immutable sequence type that maps directly
to Python's :class:`tuple`. Following the behavior of
pyyaml, asdf writes tuples as YAML sequences, which when loaded
are converted to lists. If round-tripping of tuples is important
to your application see the :ref:`extending` to write a custom extension
to save and load tuples.

One of the key features of `asdf` is its ability to serialize :mod:`numpy`
arrays. This is discussed in detail in :ref:`array-data`.
Expand Down

0 comments on commit 2fa3589

Please sign in to comment.