LoLBench / cpython_5 /tests /private /omitted.patch
lolbench26's picture
Publish LoLBench Harbor tasks from artifact branch (part 11)
5a9e79d verified
Raw History Blame Contribute Delete
6.84 kB
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index ff7ffe1414..33a3ebb3a3 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -141,6 +141,8 @@ Lib/ast.py @isidentical
**/*cgi* @ethanfurman
**/*tarfile* @ethanfurman
+**/*tomllib* @encukou
+
# macOS
/Mac/ @python/macos-team
**/*osx_support* @python/macos-team
diff --git a/Doc/library/fileformats.rst b/Doc/library/fileformats.rst
index e9c2e1fbbd..bb099fe2d3 100644
--- a/Doc/library/fileformats.rst
+++ b/Doc/library/fileformats.rst
@@ -12,6 +12,7 @@ that aren't markup languages and are not related to e-mail.
csv.rst
configparser.rst
+ tomllib.rst
netrc.rst
xdrlib.rst
plistlib.rst
diff --git a/Doc/library/tomllib.rst b/Doc/library/tomllib.rst
new file mode 100644
index 0000000000..918576eb37
--- /dev/null
+++ b/Doc/library/tomllib.rst
@@ -0,0 +1,117 @@
+:mod:`tomllib` --- Parse TOML files
+===================================
+
+.. module:: tomllib
+ :synopsis: Parse TOML files.
+
+.. versionadded:: 3.11
+
+.. moduleauthor:: Taneli Hukkinen
+.. sectionauthor:: Taneli Hukkinen
+
+**Source code:** :source:`Lib/tomllib`
+
+--------------
+
+This module provides an interface for parsing TOML (Tom's Obvious Minimal
+Language, `https://toml.io <https://toml.io/en/>`_). This module does not
+support writing TOML.
+
+.. seealso::
+
+ The `Tomli-W package <https://pypi.org/project/tomli-w/>`__
+ is a TOML writer that can be used in conjunction with this module,
+ providing a write API familiar to users of the standard library
+ :mod:`marshal` and :mod:`pickle` modules.
+
+.. seealso::
+
+ The `TOML Kit package <https://pypi.org/project/tomlkit/>`__
+ is a style-preserving TOML library with both read and write capability.
+ It is a recommended replacement for this module for editing already
+ existing TOML files.
+
+
+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`. 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)``.
+ This can be used to use another datatype or parser for TOML floats
+ (e.g. :class:`decimal.Decimal`). The callable must not return a
+ :class:`dict` or a :class:`list`, else a :exc:`ValueError` is raised.
+
+ A :exc:`TOMLDecodeError` will be raised on an invalid TOML document.
+
+
+.. function:: loads(s, /, *, parse_float=float)
+
+ 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.
+
+
+The following exceptions are available:
+
+.. exception:: TOMLDecodeError
+
+ Subclass of :exc:`ValueError`.
+
+
+Examples
+--------
+
+Parsing a TOML file::
+
+ import tomllib
+
+ with open("pyproject.toml", "rb") as f:
+ data = tomllib.load(f)
+
+Parsing a TOML string::
+
+ import tomllib
+
+ toml_str = """
+ python-version = "3.11.0"
+ python-implementation = "CPython"
+ """
+
+ 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 |
++------------------+--------------------------------------------------------------------------------------+
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 4a64e044c4..9b82de7f4a 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -214,7 +214,8 @@ Other CPython Implementation Changes
New Modules
===========
-* None yet.
+* A new module, :mod:`tomllib`, was added for parsing TOML.
+ (Contributed by Taneli Hukkinen in :issue:`40059`.)
Improved Modules
diff --git a/Misc/NEWS.d/next/Library/2022-02-23-01-11-08.bpo-40059.Iwc9UH.rst b/Misc/NEWS.d/next/Library/2022-02-23-01-11-08.bpo-40059.Iwc9UH.rst
new file mode 100644
index 0000000000..d41ff1304e
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2022-02-23-01-11-08.bpo-40059.Iwc9UH.rst
@@ -0,0 +1 @@
+:pep:`680`, the :mod:`tomllib` module. Adds support for parsing TOML.