Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add note about implicit tuple to list conversion on write/read #1589

Merged
merged 1 commit into from
Jul 31, 2023
Merged

add note about implicit tuple to list conversion on write/read #1589

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/asdf/features.rst
View file
Open in desktop
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