Skip to content

[Docs] Improve documentation about migration from distutils #3171

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
merged 4 commits into from
Mar 13, 2022
Merged

[Docs] Improve documentation about migration from distutils #3171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
722e1fd
[Docs] Improve documentation about migration from distutils
abravalheri Mar 13, 2022
c522737
Fix version of setuptools for default local distutils
abravalheri Mar 13, 2022
82141a2
Fix PEP 632 link display
abravalheri Mar 13, 2022
19609c0
Link packaging
abravalheri Mar 13, 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
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@

intersphinx_mapping['pip'] = 'https://pip.pypa.io/en/latest', None
intersphinx_mapping['PyPUG'] = ('https://packaging.python.org/en/latest/', None)
intersphinx_mapping['packaging'] = ('https://packaging.pypa.io/en/latest/', None)
intersphinx_mapping['importlib-resources'] = (
'https://importlib-resources.readthedocs.io/en/latest', None
)
12 changes: 7 additions & 5 deletions docs/deprecated/distutils-legacy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ Porting from Distutils

Setuptools and the PyPA have a `stated goal <https://github.com/pypa/packaging-problems/issues/127>`_ to make Setuptools the reference API for distutils.

Since the 49.1.2 release, Setuptools includes a local, vendored copy of distutils (from late copies of CPython) that is disabled by default. To enable the use of this copy of distutils when invoking setuptools, set the enviroment variable:
Since the 60.0.0 release, Setuptools includes a local, vendored copy of distutils (from late copies of CPython) that is enabled by default. To disable the use of this copy of distutils when invoking setuptools, set the enviroment variable:

SETUPTOOLS_USE_DISTUTILS=local
SETUPTOOLS_USE_DISTUTILS=stdlib

This behavior is planned to become the default.

Prefer Setuptools
-----------------
Expand All @@ -20,12 +19,15 @@ As Distutils is deprecated, any usage of functions or objects from distutils is

``distutils.command.{build_clib,build_ext,build_py,sdist}`` → ``setuptools.command.*``

``distutils.log`` → (no replacement yet)
``distutils.log`` → :mod:`logging` (standard library)

``distutils.version.*`` → ``packaging.version.*``
``distutils.version.*`` → :doc:`packaging.version.* <packaging:version>`

``distutils.errors.*`` → ``setuptools.errors.*`` [#errors]_


Migration advice is also provided by :pep:`PEP 632 <632#migration-advice>`.

If a project relies on uses of ``distutils`` that do not have a suitable replacement above, please search the `Setuptools issue tracker <https://github.com/pypa/setuptools/issues/>`_ and file a request, describing the use-case so that Setuptools' maintainers can investigate. Please provide enough detail to help the maintainers understand how distutils is used, what value it provides, and why that behavior should be supported.


Expand Down