Skip to content

[pull] main from pypa:main #104

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 2 commits into from
Oct 11, 2023
Merged

[pull] main from pypa:main #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
513c978
Address `distutils` removal from Python stdlib
chrysle Oct 10, 2023
df2c8b2
Merge pull request #1312 from chrysle/update-distutils-references
webknjaz Oct 10, 2023
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
4 changes: 2 additions & 2 deletions source/guides/distributing-packages-using-setuptools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ Each file name in ``files`` is interpreted relative to the :file:`setup.py`
script at the top of the project source distribution.

For more information see the distutils section on :ref:`Installing Additional Files
<python:distutils-additional-files>`.
<setuptools:distutils-additional-files>`.

.. note::

Expand All @@ -498,7 +498,7 @@ For more information see the distutils section on :ref:`Installing Additional Fi
~~~~~~~~~~~

Although ``setup()`` supports a :ref:`scripts
<python:distutils-installing-scripts>`
<setuptools:distutils-installing-scripts>`
keyword for pointing to pre-made scripts to install, the recommended approach to
achieve cross-platform compatibility is to use :ref:`console_scripts` entry
points (see below).
Expand Down
2 changes: 1 addition & 1 deletion source/guides/dropping-older-python-versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ metadata values based on the argument you provide in ``python_requires``.

Within a Python source package (the zip or the tar-gz file you download) is a text file called PKG-INFO.

This file is generated by Distutils or :ref:`setuptools` when it generates the source package.
This file is generated by :ref:`distutils` or :ref:`setuptools` when it generates the source package.
The file contains a set of keys and values, the list of keys is part of the PyPa standard metadata format.

You can see the contents of the generated file like this:
Expand Down
2 changes: 1 addition & 1 deletion source/guides/tool-recommendations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ migration, and what settings to change in your clients.
:ref:`virtualenv`. However, using :ref:`virtualenv` will still be
recommended for users that need cross-version consistency.

.. [5] Although you can use pure ``distutils`` for many projects, it does not
.. [5] Although you can use pure :ref:`distutils` for many projects, it does not
support defining dependencies on other projects and is missing several
convenience utilities for automatically populating distribution metadata
correctly that are provided by ``setuptools``. Being outside the
Expand Down
7 changes: 3 additions & 4 deletions source/key_projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,21 +676,20 @@ build of the Python distribution.
distutils
=========

`Docs <https://docs.python.org/3/library/distutils.html>`__ |
`Issues <https://bugs.python.org/>`__

The original Python packaging system, added to the standard library in
Python 2.0.

Due to the challenges of maintaining a packaging system
where feature updates are tightly coupled to language runtime updates,
direct usage of :ref:`distutils` is now actively discouraged, with
direct usage of :ref:`distutils` has been actively discouraged, with
:ref:`Setuptools` being the preferred replacement. :ref:`Setuptools`
not only provides features that plain :ref:`distutils` doesn't offer
(such as dependency declarations and entry point declarations), it
also provides a consistent build interface and feature set across all
supported Python versions.

Consequently, :ref:`distutils` was deprecated in Python 3.10 by :pep:`632` and
has been :doc:`removed <python:whatsnew/3.12>` from the standard library in Python 3.12.

.. _venv:

Expand Down
2 changes: 1 addition & 1 deletion source/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ you can use Python's native packaging tools to create a *source*
Python's *sdists* are compressed archives (``.tar.gz`` files)
containing one or more packages or modules. If your code is
pure-Python, and you only depend on other Python packages, you can
:doc:`go here to learn more <python:distutils/sourcedist>`.
go to the :ref:`source-distribution-format` specification to learn more.

If you rely on any non-Python code, or non-Python packages (such as
`libxml2 <https://en.wikipedia.org/wiki/Libxml2>`_ in the case of
Expand Down
4 changes: 3 additions & 1 deletion source/specifications/platform-compatibility-tags.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,10 @@ decide how to best use the ABI tag.
Platform Tag
------------

The platform tag is simply ``distutils.util.get_platform()`` with all
The platform tag is simply ``sysconfig.get_platform()`` with all
hyphens ``-`` and periods ``.`` replaced with underscore ``_``.
Until the removal of :ref:`distutils` in Python 3.12, this
was ``distutils.util.get_platform()``.

* win32
* linux_i386
Expand Down