Skip to content

bpo-40059: tomllib #31498

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

Merged
encukou merged 13 commits into from
Mar 8, 2022
Merged

bpo-40059: tomllib #31498

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2f5edf2
Add tomllib and tests
hukkin Feb 1, 2022
026a48b
Run `make regen-stdlib-module-names`
hukkin Feb 1, 2022
1cdda7c
Add tomllib docs
hukkin Feb 1, 2022
eafc4e0
Document parse_float limitations
hukkin Feb 2, 2022
1c9b341
Add conversion table to docs
hukkin Feb 2, 2022
876a43c
Sync with Tomli
hukkin Feb 3, 2022
ab5e488
Remove commented out test code
hukkin Feb 9, 2022
4316ae6
Add NEWS
hukkin Feb 22, 2022
13edc69
Add whatsnew
hukkin Feb 22, 2022
6cd95a5
Add CODEOWNERS
hukkin Feb 22, 2022
d5e8053
Update .github/CODEOWNERS
hukkin Mar 2, 2022
ea27f36
Add asserts
hukkin Mar 2, 2022
2898cc3
Add a poor man's xfail
hukkin Mar 2, 2022
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
Prev Previous commit
Next Next commit
Add conversion table to docs
  • Loading branch information
@hukkin
hukkin committed Feb 2, 2022
commit 1c9b341cd173fba0c7398a4c356f1b3d167dfbf1
38 changes: 35 additions & 3 deletions Doc/library/tomllib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ This module defines the following functions:
.. function:: load(fp, /, *, parse_float=float)

Read a TOML file. The first argument should be a readable and binary file object.
Return a :class:`dict`.
Return a :class:`dict`. Convert TOML types to Python using this
:ref:`conversion table <toml-to-py-table>`.

*parse_float* will be called with the string of every TOML
float to be decoded. By default, this is equivalent to ``float(num_str)``.
Expand All @@ -51,8 +52,9 @@ This module defines the following functions:

.. function:: loads(s, /, *, parse_float=float)

Load TOML from a :class:`str` object. The *parse_float* argument has the
same meaning as in :func:`load`.
Load TOML from a :class:`str` object. Return a :class:`dict`. Convert TOML
types to Python using this :ref:`conversion table <toml-to-py-table>`. The
*parse_float* argument has the same meaning as in :func:`load`.

A :exc:`TOMLDecodeError` will be raised on an invalid TOML document.

Expand Down Expand Up @@ -84,3 +86,33 @@ Parsing a TOML string::
"""

data = tomllib.loads(toml_str)


Conversion Table
----------------

.. _toml-to-py-table:

+------------------+--------------------------------------------------------------------------------------+
| TOML | Python |
+==================+======================================================================================+
| table | dict |
+------------------+--------------------------------------------------------------------------------------+
| string | str |
+------------------+--------------------------------------------------------------------------------------+
| integer | int |
+------------------+--------------------------------------------------------------------------------------+
| float | float (configurable with *parse_float*) |
+------------------+--------------------------------------------------------------------------------------+
| boolean | bool |
+------------------+--------------------------------------------------------------------------------------+
| offset date-time | datetime.datetime (``tzinfo`` attribute set to an instance of ``datetime.timezone``) |
+------------------+--------------------------------------------------------------------------------------+
| local date-time | datetime.datetime (``tzinfo`` attribute set to ``None``) |
+------------------+--------------------------------------------------------------------------------------+
| local date | datetime.date |
+------------------+--------------------------------------------------------------------------------------+
| local time | datetime.time |
+------------------+--------------------------------------------------------------------------------------+
| array | list |
+------------------+--------------------------------------------------------------------------------------+