Skip to content

Update the bootstrap guide for tomllib #739

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
takluyver merged 4 commits into from
Mar 27, 2025
+12 −3
Merged

Update the bootstrap guide for tomllib #739

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7eabbcb
Update the bootstrap guide for ``tomllib``
AA-Turner Mar 25, 2025
2e5b400
Make it clearer that ``tomli`` is always vendored
AA-Turner Mar 27, 2025
ed88399
Restructure the unvendoring guidance into a note
AA-Turner Mar 27, 2025
148ac5c
Improve clarity of instruction
AA-Turner Mar 27, 2025
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
9 changes: 6 additions & 3 deletions doc/bootstrap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@ included in the sdist (or by unzipping it to the correct directory)::
# Install somewhere else:
python bootstrap_install.py --installdir /path/to/site-packages dist/flit_core-*.whl

As of version 3.6, flit_core bundles the ``tomli`` TOML parser, to avoid a
dependency cycle. If you need to unbundle it, you will need to special-case
installing flit_core and/or tomli to get around that cycle.
In Python 3.11 and newer, ``flit_core`` uses the standard library :mod:`tomllib`
module, meaning that ``flit_core`` has no third-party dependencies.
Copy link
Member

@cdce8p cdce8p Mar 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's vendored for all Python versions, just not used in >=3.11.

For older versions of Python, ``flit_core`` as of version 3.6 bundles the
``tomli`` TOML parser to avoid a dependency cycle. If you need to unbundle it,
you must use a Python version that includes :mod:`!tomllib`, or special-case
installing ``flit_core`` and/or ``tomli`` to get around that cycle.

After ``flit_core``, I recommend that you get `installer
<https://pypi.org/project/installer/>`_ set up. You can use
Expand Down
Loading