Update setuptools to 65.6.3

[pyup-bot]

This PR updates setuptools from 57.0.0 to 65.6.3.

Changelog

65.6.3

-------


Misc
^^^^
* 3709: Fix condition to patch ``distutils.dist.log`` to only apply when using
``distutils`` from the stdlib.

65.6.2

-------

No significant changes.

65.6.1

-------


Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3689: Documented that ``distutils.cfg`` might be ignored unless
``SETUPTOOLS_USE_DISTUTILS=stdlib``.

Misc
^^^^
* 3678: Improve clib builds reproducibility by sorting sources -- by :user:`danigm`
* 3684: Improved exception/traceback when invalid entry-points are specified.
* 3690: Fixed logging errors: 'underlying buffer has been detached' (issue 1631).
* 3693: Merge pypa/distutils3e9d47e with compatibility fix for distutils.log.Log.
* 3695, 3697, 3698, 3699: Changed minor text details (spelling, spaces ...)
* 3696: Removed unnecessary ``coding: utf-8`` annotations
* 3704: Fixed temporary build directories interference with auto-discovery.

65.6.0

-------


Changes
^^^^^^^
* 3674: Sync with pypa/distutilse0787fa, including pypa/distutils183 updating distutils to use the Python logging framework.

65.5.1

-------


Misc
^^^^
* 3638: Drop a test dependency on the ``mock`` package, always use :external+python:py:mod:`unittest.mock` -- by :user:`hroncok`
* 3659: Fixed REDoS vector in package_index.

65.5.0

-------


Changes
^^^^^^^
* 3624: Fixed editable install for multi-module/no-package ``src``-layout projects.
* 3626: Minor refactorings to support distutils using stdlib logging module.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3419: Updated the example version numbers to be compliant with PEP-440 on the "Specifying Your Project’s Version" page of the user guide.

Misc
^^^^
* 3569: Improved information about conflicting entries in the current working directory
and editable install (in documentation and as an informational warning).
* 3576: Updated version of ``validate_pyproject``.

65.4.1

-------


Misc
^^^^
* 3613: Fixed encoding errors in ``expand.StaticModule`` when system default encoding doesn't match expectations for source files.
* 3617: Merge with pypa/distutils6852b20 including fix for pypa/distutils181.

65.4.0

-------


Changes
^^^^^^^
* 3609: Merge with pypa/distutilsd82d926 including support for DIST_EXTRA_CONFIG in pypa/distutils177.

65.3.0

-------


Changes
^^^^^^^
* 3547: Stop ``ConfigDiscovery.analyse_name`` from splatting the ``Distribution.name`` attribute -- by :user:`jeamland`

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3554: Changed requires to requests in the pyproject.toml example in the :doc:`Dependency management section of the Quickstart guide <userguide/quickstart>` -- by :user:`mfbutner`

Misc
^^^^
* 3561: Fixed accidental name matching in editable hooks.

65.2.0

-------


Changes
^^^^^^^
* 3553: Sync with pypa/distutils22b9bcf, including fixed cross-compiling support and removing deprecation warning per pypa/distutils169.

65.1.1

-------


Misc
^^^^
* 3551: Avoided circular imports in meta path finder for editable installs when a
missing module has the same name as its parent.

65.1.0

-------


Changes
^^^^^^^
* 3536: Remove monkeypatching of msvc9compiler.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3538: Corrected documentation on how to use the ``legacy-editable`` mode.

65.0.2

-------


Misc
^^^^
* 3505: Restored distutils msvccompiler and msvc9compiler modules and marked as deprecated (pypa/distutilsc802880).

65.0.1

-------


Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3529: Added clarification to :doc:`/userguide/quickstart` about support
to ``setup.py``.

Misc
^^^^
* 3526: Fixed backward compatibility of editable installs and custom ``build_ext``
commands inheriting directly from ``distutils``.
* 3528: Fixed ``buid_meta.prepare_metadata_for_build_wheel`` when
given ``metadata_directory`` is ``"."``.

65.0.0

-------


Breaking Changes
^^^^^^^^^^^^^^^^
* 3505: Removed 'msvccompiler' and 'msvc9compiler' modules from distutils.
* 3521: Remove bdist_msi and bdist_wininst commands, which have been deprecated since Python 3.9. Use older Setuptools for these behaviors if needed.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3519: Changed the note in ``keywords`` documentation regarding editable installations
to specify which ``setuptools`` version require a minimal ``setup.py`` file or not.

64.0.3

-------


Misc
^^^^
* 3515: Fixed "inline" file copying for editable installations and
optional extensions.
* 3517: Fixed ``editable_wheel`` to ensure other commands are finalized before using
them. This should prevent errors with plugins trying to use different commands
or reinitializing them.
* 3517: Augmented filter to prevent transient/temporary source files from being
considered ``package_data`` or ``data_files``.

64.0.2

-------


Misc
^^^^
* 3506: Suppress errors in custom ``build_py`` implementations when running editable
installs in favor of a warning indicating what is the most appropriate
migration path.
This is a *transitional* measure. Errors might be raised in future versions of
``setuptools``.
* 3512: Added capability of handling namespace packages created
accidentally/purposefully via discovery configuration during editable installs.
This should emulate the behaviour of a non-editable installation.

64.0.1

-------


Misc
^^^^
* 3497: Fixed ``editable_wheel`` for legacy namespaces.
* 3502: Fixed issue with editable install and single module distributions.
* 3503: Added filter to ignore external ``.egg-info`` files in manifest.

Some plugins might rely on the fact that the ``.egg-info`` directory is
produced inside the project dir, which may not be the case in editable installs
(the ``.egg-info`` directory is produced inside the metadata directory given by
the build frontend via PEP 660 hooks).

64.0.0

-------


Deprecations
^^^^^^^^^^^^
* 3380: Passing some types of parameters via ``--global-option`` to setuptools PEP 517/PEP 660 backend
is now considered deprecated. The user can pass the same arbitrary parameter
via ``--build-option`` (``--global-option`` is now reserved for flags like
``--verbose`` or ``--quiet``).

Both ``--build-option`` and ``--global-option`` are supported as a **transitional** effort (a.k.a. "escape hatch").
In the future a proper list of allowed ``config_settings`` may be created.

Breaking Changes
^^^^^^^^^^^^^^^^
* 3265: Added implementation for *editable install* hooks (PEP 660).

By default the users will experience a *lenient* behavior  which prioritises
the ability of the users of changing the distributed packages (e.g. adding new
files or removing old ones).
But they can also opt into a *strict* mode, which will try to replicate as much
as possible the behavior of the package as if it would be normally installed by
end users. The *strict* editable installation is not able to detect if files
are added or removed from the project (a new installation is required).

This implementation might also affect plugins and customizations that assume
certain ``build`` subcommands don't run during editable installs or that they
always copy files to the temporary build directory.

.. important::
  The *editable* aspect of the *editable install* supported this implementation
  is restricted to the Python modules contained in the distributed package.
  Changes in binary extensions (e.g. C/C++), entry-point definitions,
  dependencies, metadata, datafiles, etc may require a new installation.

Changes
^^^^^^^
* 3380: Improved the handling of the ``config_settings`` parameter in both PEP 517 and
PEP 660 interfaces:

- It is possible now to pass both ``--global-option`` and ``--build-option``.
 As discussed in 1928, arbitrary arguments passed via ``--global-option``
 should be placed before the name of the setuptools' internal command, while
 ``--build-option`` should come after.

- Users can pass ``editable-mode=strict`` to select a strict behaviour for the
 editable installation.
* 3392: Exposed ``get_output_mapping()`` from ``build_py`` and ``build_ext``
subcommands. This interface is reserved for the use of ``setuptools``
Extensions and third part packages are explicitly disallowed to calling it.
However, any implementation overwriting ``build_py`` or ``build_ext`` are
required to honour this interface.
* 3412: Added ability of collecting source files from custom build sub-commands to
``sdist``. This allows plugins and customization scripts to automatically
add required source files in the source distribution.
* 3414: Users can *temporarily* specify an environment variable
``SETUPTOOLS_ENABLE_FEATURES=legacy-editable`` as a escape hatch for the
:pep:`660` behavior. This setting is **transitional** and may be removed in the
future.
* 3484: Added *transient* ``compat`` mode to editable installs.
This more will be temporarily available (to facilitate the transition period)
for those that want to emulate the behavior of the ``develop`` command
(in terms of what is added to ``sys.path``).
This mode is provided "as is", with limited support, and will be removed in
future versions of ``setuptools``.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3414: Updated :doc:`Development Mode </userguide/development_mode>` to reflect on the
implementation of :pep:`660`.

63.4.3

-------


Misc
^^^^
* 3496: Update to pypa/distutilsb65aa40 including more robust support for library/include dir handling in msvccompiler (pypa/distutils153) and test suite improvements.

63.4.2

-------


Misc
^^^^
* 3453: Bump vendored version of :pypi:`pyparsing` to 3.0.9.
* 3481: Add warning for potential ``install_requires`` and ``extras_require``
misconfiguration in ``setup.cfg``
* 3487: Modified ``pyproject.toml`` validation exception handling to
make relevant debugging information easier to spot.

63.4.1

-------


Misc
^^^^
* 3482: Sync with pypa/distutils274758f1c02048d295efdbc13d2f88d9923547f8, restoring compatibility shim in bdist.format_commands.

63.4.0

-------


Changes
^^^^^^^
* 2971: ``upload_docs`` command is deprecated once again.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3443: Installed ``sphinx-hoverxref`` extension to show tooltips on internal an external references.
-- by :user:`humitos`
* 3444: Installed ``sphinx-notfound-page`` extension to generate nice 404 pages.
-- by :user:`humitos`

Misc
^^^^
* 3480: Merge with pypa/distutilsc397f4c

63.3.0

-------


Changes
^^^^^^^
* 3475: Merge with pypa/distutils129480b, including substantial delinting and cleanup, some refactoring around compiler logic, better messaging in cygwincompiler (pypa/distutils161).

63.2.0

-------


Changes
^^^^^^^
* 3395: Included a performance optimization: ``setuptools.build_meta`` no longer tries
to :func:`compile` the setup script code before :func:`exec`-ing it.

Misc
^^^^
* 3435: Corrected issue in macOS framework builds on Python 3.9 not installed by homebrew (pypa/distutils158).

63.1.0

-------


Changes
^^^^^^^
* 3430: Merge with pypa/distutils152c13d including pypa/distutils155 (improved compatibility for editable installs on homebrew Python 3.9), pypa/distutils150 (better handling of runtime_library_dirs on cygwin), and pypa/distutils151 (remove warnings for namespace packages).

63.0.0

-------


Breaking Changes
^^^^^^^^^^^^^^^^
* 3421: Drop setuptools' support for installing an entrypoint extra requirements at load time:
- the functionality has been broken since v60.8.0.
- the mechanism to do so is deprecated (``fetch_build_eggs``).
- that use case (e.g. a custom command class entrypoint) is covered by making sure the necessary build requirements are declared.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3305: Updated the example pyproject.toml -- by :user:`jacalata`
* 3394: This updates the documentation for the ``file_finders`` hook so that
the logging recommendation aligns with the suggestion to not use
``distutils`` directly.
* 3397: Fix reference for ``keywords`` to point to the Core Metadata Specification
instead of PEP 314 (the live standard is kept always up-to-date and
consolidates several PEPs together in a single document).
* 3402: Reordered the User Guide's Table of Contents -- by :user:`codeandfire`

62.6.0

-------


Changes
^^^^^^^
* 3253: Enabled using ``file:`` for requirements in setup.cfg -- by :user:`akx`
(this feature is currently considered to be in **beta** stage).
* 3255: Enabled using ``file:`` for dependencies and optional-dependencies in pyproject.toml -- by :user:`akx`
(this feature is currently considered to be in **beta** stage).
* 3391: Updated ``attr:`` to also extract simple constants with type annotations -- by :user:`karlotness`

62.5.0

-------


Changes
^^^^^^^
* 3347: Changed warnings and documentation notes about *experimental* aspect of ``pyproject.toml`` configuration:
now ``[project]`` is a fully supported configuration interface, but the ``[tool.setuptools]`` table
and sub-tables are still considered to be in **beta** stage.
* 3383: In _distutils_hack, suppress/undo the use of local distutils when select tests are imported in CPython.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3368: Added documentation page about extension modules -- by :user:`mkoeppe`
* 3371: Moved documentation from ``/userguide/commands`` to ``/depracted/commands``.
This change was motived by the fact that running ``python setup.py`` directly is
considered a deprecated practice.
* 3372: Consolidated sections about ``sdist`` contents and ``MANIFEST.in`` into a single page.

Added a simple ``MANIFEST.in`` example.
* 3373: Moved remarks about using :pypi:`Cython` to the newly created page for
extension modules.
* 3374: Added clarification that using ``python setup.py egg_info`` commands to
manage project versions is only supported in a *transitional* basis, and
that eventually ``egg_info`` will be deprecated.

Reorganized sections with tips for managing versions.
* 3378: Updated ``Quickstart`` docs to make it easier to follow for beginners.

Misc
^^^^
* 3385: Modules used to parse and evaluate configuration from ``pyproject.toml`` files are
intended for internal use only and that not part of the public API.

62.4.0

-------


Changes
^^^^^^^
* 3256: Added setuptools.command.build command to match distutils.command.build -- by :user:`isuruf`
* 3366: Merge with pypa/distutils75ed79d including reformat using black, fix for Cygwin support (pypa/distutils139), and improved support for cross compiling (pypa/distutils144 and pypa/distutils145).

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3355: Changes to the User Guide's Entry Points page -- by :user:`codeandfire`
* 3361: Further minor corrections to the Entry Points page -- by :user:`codeandfire`
* 3363: Rework some documentation pages to de-emphasize ``distutils`` and the history
of packaging in the Python ecosystem. The focus of these changes is to make the
documentation easier to read for new users.
* 3364: Update documentation about dependency management, removing mention to
the deprecated ``dependency_links`` and adding some small improvements.
* 3367: Extracted text about automatic resource extraction and the zip-safe flag
from ``userguide/miscellaneous`` to ``deprecated/resource_extraction`` and
``deprecated/zip_safe``.

Extracted text about additional metadata files from
``userguide/miscellaneous`` into the existing ``userguide/extension``
document.

Updated ``userguide/extension`` to better reflect the status of the
setuptools project.

Removed ``userguide/functionalities_rewrite`` (a virtually empty part of the
docs).

62.3.4

-------


Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3349: Fixed two small issues preventing docs from building locally -- by :user:`codeandfire`
* 3350: Added note explaining ``package_data`` glob pattern matching for dotfiles -- by :user:`comabrewer`
* 3358: Clarify the role of the ``package_dir`` configuration.

Misc
^^^^
* 3354: Improve clarity in warning about unlisted namespace packages.

62.3.3

-------


Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3331: Replaced single backticks with double ones in ``CHANGES.rst`` -- by :user:`codeandfire`
* 3332: Fixed grammar/typos, modified example directory trees for src-layout and flat-layout -- by :user:`codeandfire`
* 3335: Changes to code snippets and other examples in the Data Files page of the User Guide -- by :user:`codeandfire`

Misc
^^^^
* 3336: Modified ``test_setup_install_includes_dependencies`` to work with custom ``PYTHONPATH`` –- by :user:`hroncok`

62.3.2

-------


Misc
^^^^
* 3328: Include a first line summary to some of the existing multi-line warnings.

62.3.1

-------


Misc
^^^^
* 3320: Fixed typo which causes ``namespace_packages`` to raise an error instead of
warning.

62.3.0

-------


Deprecations
^^^^^^^^^^^^
* 3262: Formally added deprecation messages for ``namespace_packages``.
The methodology that uses ``pkg_resources`` and ``namespace_packages`` for
creating namespaces was already discouraged by the :doc:`setuptools docs
</userguide/package_discovery>` and the
:doc:`Python Packaging User Guide <PyPUG:guides/packaging-namespace-packages>`,
therefore this change just make the deprecation more official.
Users can consider migrating to native/implicit namespaces (as introduced in
:pep:`420`).
* 3308: Relying on ``include_package_data`` to ensure sub-packages are automatically
added to the build wheel distribution (as "data") is now considered a
deprecated practice.

This behaviour was controversial and caused inconsistencies (3260).

Instead, projects are encouraged to properly configure ``packages`` or use
discovery tools. General information can be found in :doc:`userguide/package_discovery`.

Changes
^^^^^^^
* 1806: Allowed recursive globs (``**``) in ``package_data``. -- by :user:`nullableVoidPtr`
* 3206: Fixed behaviour when both ``install_requires`` (in ``setup.py``) and
``dependencies`` (in ``pyproject.toml``) are specified.
The configuration in ``pyproject.toml`` will take precedence over ``setup.py``
(in accordance with PEP 621). A warning was added to inform users.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3307: Added introduction to references/keywords.

Added deprecation tags to test kwargs.

Moved userguide/keywords to deprecated section.

Clarified in deprecated doc what keywords came from distutils and which were added or changed by setuptools.

Misc
^^^^
* 3274: Updated version of vendored ``pyparsing`` to 3.0.8 to avoid problems with
upcoming deprecation in Python 3.11.
* 3292: Added warning about incompatibility with old versions of
``importlib-metadata``.

62.2.0

-------


Changes
^^^^^^^
* 3299: Optional metadata fields are now truly optional. Includes merge with pypa/distutilsa7cfb56 per pypa/distutils138.

Misc
^^^^
* 3282: Added CI cache for ``setup.cfg`` examples used when testing ``setuptools.config``.

62.1.0

-------


Changes
^^^^^^^
* 3258: Merge pypa/distutils5229dad46b.

Misc
^^^^
* 3249: Simplified ``package_dir`` obtained via auto-discovery.

62.0.0

-------


Breaking Changes
^^^^^^^^^^^^^^^^
* 3151: Made ``setup.py develop --user`` install to the user site packages directory even if it is disabled in the current interpreter.

Changes
^^^^^^^
* 3153: When resolving requirements use both canonical and normalized names -- by :user:`ldaniluk`
* 3167: Honor unix file mode in ZipFile when installing wheel via ``install_as_egg`` -- by :user:`delijati`

Misc
^^^^
* 3088: Fixed duplicated tag with the ``dist-info`` command.
* 3247: Fixed problem preventing ``readme`` specified as dynamic in ``pyproject.toml``
from being dynamically specified in ``setup.py``.

61.3.1

-------


Misc
^^^^
* 3233: Included missing test file ``setupcfg_examples.txt`` in ``sdist``.
* 3233: Added script that allows developers to download ``setupcfg_examples.txt`` prior to
running tests. By caching these files it should be possible to run the test suite
offline.

61.3.0

-------


Changes
^^^^^^^
* 3229: Disabled automatic download of ``trove-classifiers`` to facilitate reproducibility.

Misc
^^^^
* 3229: Updated ``pyproject.toml`` validation via ``validate-pyproject`` v0.7.1.
* 3229: New internal tool made available for updating the code responsible for
the validation of ``pyproject.toml``.
This tool can be executed via ``tox -e generate-validation-code``.

61.2.0

-------


Changes
^^^^^^^
* 3215: Ignored a subgroup of invalid ``pyproject.toml`` files that use the ``[project]``
table to specify only ``requires-python`` (**transitional**).

.. warning::
  Please note that future releases of setuptools will halt the build process
  if a ``pyproject.toml`` file that does not match doc:`the PyPA Specification
  <PyPUG:specifications/declaring-project-metadata>` is given.
* 3215: Updated ``pyproject.toml`` validation, as generated by ``validate-pyproject==0.6.1``.
* 3218: Prevented builds from erroring if the project specifies metadata via
``pyproject.toml``, but uses other files (e.g. ``setup.py``) to complement it,
without setting ``dynamic`` properly.

.. important::
  This is a **transitional** behaviour.
  Future releases of ``setuptools`` may simply ignore externally set metadata
  not backed by ``dynamic`` or even halt the build with an error.
* 3224: Merge changes from pypa/distutilse1d5c9b1f6

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3217: Fixed typo in ``pyproject.toml`` example in Quickstart -- by :user:`pablo-cardenas`.

Misc
^^^^
* 3223: Fixed missing requirements with environment markers when
``optional-dependencies`` is set in ``pyproject.toml``.

61.1.1

-------


Misc
^^^^
* 3212: Fixed missing dependencies when running ``setup.py install``.
Note that calling ``setup.py install`` directly is still deprecated and
will be removed in future versions of ``setuptools``.
Please check the release notes for :ref:`setup_install_deprecation_note`.

61.1.0

-------


Deprecations
^^^^^^^^^^^^
* 3206: Changed ``setuptools.convert_path`` to an internal function that is not exposed
as part of setuptools API.
Future releases of ``setuptools`` are likely to remove this function.

Changes
^^^^^^^
* 3202: Changed behaviour of auto-discovery to not explicitly expand ``package_dir``
for flat-layouts and to not use relative paths starting with ``./``.
* 3203: Prevented ``pyproject.toml`` parsing from overwriting
``dist.include_package_data`` explicitly set in ``setup.py`` with default
value.
* 3208: Added a warning for non existing files listed with the ``file`` directive in
``setup.cfg`` and ``pyproject.toml``.
* 3208: Added a default value for dynamic ``classifiers`` in ``pyproject.toml`` when
files are missing and errors being ignored.
* 3211: Disabled auto-discovery when distribution class has a ``configuration``
attribute (e.g. when the ``setup.py`` script contains ``setup(...,
configuration=...)``).  This is done to ensure extension-only packages created
with ``numpy.distutils.misc_util.Configuration`` are not broken by the safe
guard
behaviour to avoid accidental multiple top-level packages in a flat-layout.

.. note::
  Users that don't set ``packages``, ``py_modules``, or ``configuration`` are
  still likely to observe the auto-discovery behavior, which may halt the
  build if the project contains multiple directories and/or multiple Python
  files directly under the project root.

  To disable auto-discovery please explicitly set either ``packages`` or
  ``py_modules``. Alternatively you can also configure :ref:`custom-discovery`.

61.0.0

-------


Deprecations
^^^^^^^^^^^^
* 3068: Deprecated ``setuptools.config.read_configuration``,
``setuptools.config.parse_configuration`` and other functions or classes
from ``setuptools.config``.

Users that still need to parse and process configuration from ``setup.cfg`` can
import a direct replacement from ``setuptools.config.setupcfg``, however this
module is transitional and might be removed in the future
(the ``setup.cfg`` configuration format itself is likely to be deprecated in the future).

Breaking Changes
^^^^^^^^^^^^^^^^
* 2894: If you purposefully want to create an *"empty distribution"*, please be aware
that some Python files (or general folders) might be automatically detected and
included.

Projects that currently don't specify both ``packages`` and ``py_modules`` in their
configuration and contain extra folders or Python files (not meant for distribution),
might see these files being included in the wheel archive or even experience
the build to fail.

You can check details about the automatic discovery (and how to configure a
different behaviour) in :doc:`/userguide/package_discovery`.
* 3067: If the file ``pyproject.toml`` exists and it includes project
metadata/config (via ``[project]`` table or ``[tool.setuptools]``),
a series of new behaviors that are not backward compatible may take place:

- The default value of ``include_package_data`` will be considered to be ``True``.
- Setuptools will attempt to validate the ``pyproject.toml`` file according
 to PEP 621 specification.
- The values specified in ``pyproject.toml`` will take precedence over those
 specified in ``setup.cfg`` or ``setup.py``.

Changes
^^^^^^^
* 2887: **[EXPERIMENTAL]** Added automatic discovery for ``py_modules`` and ``packages``
-- by :user:`abravalheri`.

Setuptools will try to find these values assuming that the package uses either
the *src-layout* (a ``src`` directory containing all the packages or modules),
the *flat-layout* (package directories directly under the project root),
or the *single-module* approach (an isolated Python file, directly under
the project root).

The automatic discovery will also respect layouts that are explicitly
configured using the ``package_dir`` option.

For backward-compatibility, this behavior will be observed **only if both**
``py_modules`` **and** ``packages`` **are not set**.
(**Note**: specifying ``ext_modules`` might also prevent auto-discover from
taking place)

If setuptools detects modules or packages that are not supposed to be in the
distribution, please manually set ``py_modules`` and ``packages`` in your
``setup.cfg`` or ``setup.py`` file.
If you are using a *flat-layout*, you can also consider switching to
*src-layout*.
* 2887: **[EXPERIMENTAL]** Added automatic configuration for the ``name`` metadata
-- by :user:`abravalheri`.

Setuptools will adopt the name of the top-level package (or module in the case
of single-module distributions), **only when** ``name`` **is not explicitly
provided**.

Please note that it is not possible to automatically derive a single name when
the distribution consists of multiple top-level packages or modules.
* 3066: Added vendored dependencies for :pypi:`tomli`, :pypi:`validate-pyproject`.

These dependencies are used to read ``pyproject.toml`` files and validate them.
* 3067: **[EXPERIMENTAL]** When using ``pyproject.toml`` metadata,
the default value of ``include_package_data`` is changed to ``True``.
* 3068: **[EXPERIMENTAL]** Add support for ``pyproject.toml`` configuration
(as introduced by :pep:`621`). Configuration parameters not covered by
standards are handled in the ``[tool.setuptools]`` sub-table.

In the future, existing ``setup.cfg`` configuration
may be automatically converted into the ``pyproject.toml`` equivalent before taking effect
(as proposed in 1688). Meanwhile users can use automated tools like
:pypi:`ini2toml` to help in the transition.

Please note that the legacy backend is not guaranteed to work with
``pyproject.toml`` configuration.

-- by :user:`abravalheri`
* 3125: Implicit namespaces (as introduced in :pep:`420`) are now considered by default
during :doc:`package discovery </userguide/package_discovery>`, when
``setuptools`` configuration and project metadata are added to the
``pyproject.toml`` file.

To disable this behaviour, use ``namespaces = False`` when explicitly setting
the ``[tool.setuptools.packages.find]`` section in ``pyproject.toml``.

This change is backwards compatible and does not affect the behaviour of
configuration done in ``setup.cfg`` or ``setup.py``.
* 3152: **[EXPERIMENTAL]** Added support for ``attr:`` and ``cmdclass`` configurations
in ``setup.cfg`` and ``pyproject.toml`` when ``package_dir`` is implicitly
found via auto-discovery.
* 3178: Postponed importing ``ctypes`` when hiding files on Windows.
This helps to prevent errors in systems that might not have ``libffi`` installed.
* 3179: Merge with pypa/distutils267dbd25ac

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3172: Added initial documentation about configuring ``setuptools`` via ``pyproject.toml``
(using standard project metadata).

Misc
^^^^
* 3065: Refactored ``setuptools.config`` by separating configuration parsing (specific
to the configuration file format, e.g. ``setup.cfg``) and post-processing
(which includes directives such as ``file:`` that can be used across different
configuration formats).

60.10.0

--------


Changes
^^^^^^^
* 2971: Deprecated upload_docs command, to be removed in the future.
* 3137: Use samefile from stdlib, supported on Windows since Python 3.2.
* 3170: Adopt nspektr (vendored) to implement Distribution._install_dependencies.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 3144: Added documentation on using console_scripts from setup.py, which was previously only shown in setup.cfg  -- by :user:`xhlulu`
* 3148: Added clarifications about ``MANIFEST.in``, that include links to PyPUG docs
and more prominent mentions to using a revision control system plugin as an
alternative.
* 3148: Removed mention to ``pkg_resources`` as the recommended way of accessing data
files, in favour of importlib.resources.
Additionally more emphasis was put on the fact that *package data files* reside
**inside** the *package directory* (and therefore should be *read-only*).

Misc
^^^^
* 3120: Added workaround for intermittent failures of backend tests on PyPy.
These tests now are marked with `XFAIL
<https://docs.pytest.org/en/stable/how-to/skipping.html>`_, instead of erroring
out directly.
* 3124: Improved configuration for :pypi:`rst-linker` (extension used to build the
changelog).
* 3133: Enhanced isolation of tests using virtual environments - PYTHONPATH is not leaking to spawned subprocesses  -- by :user:`befeleme`
* 3147: Added options to provide a pre-built ``setuptools`` wheel or sdist for being
used during tests with virtual environments.
Paths for these pre-built distribution files can now be set via the environment
variables: ``PRE_BUILT_SETUPTOOLS_SDIST`` and ``PRE_BUILT_SETUPTOOLS_WHEEL``.

60.9.3

-------


Misc
^^^^
* 3093: Repaired automated release process.

60.9.2

-------


Misc
^^^^
* 3035: When loading distutils from the vendored copy, rewrite ``__name__`` to ensure consistent importing from inside and out.

60.9.1

-------


Misc
^^^^
* 3102: Prevent vendored importlib_metadata from loading distributions from older importlib_metadata.
* 3103: Fixed issue where string-based entry points would be omitted.
* 3107: Bump importlib_metadata to 4.11.1 addressing issue with parsing requirements in egg-info as found in PyPy.

60.9.0

-------


Changes
^^^^^^^
* 2876: In the build backend, allow single config settings to be supplied.
* 2993: Removed workaround in distutils hack for get-pip now that pypa/get-pip137 is closed.
* 3085: Setuptools no longer relies on ``pkg_resources`` for entry point handling.
* 3098: Bump vendored packaging to 21.3.
* Removed bootstrap script.

.. warning:: Users trying to install the unmaintained :pypi:`pathlib` backport
from PyPI/``sdist``/source code may find problems when using ``setuptools >= 60.9.0``.
This happens because during the installation, the unmaintained
implementation of ``pathlib`` is loaded and may cause compatibility problems
(it does not expose the same public API defined in the Python standard library).

Whenever possible users should avoid declaring ``pathlib`` as a dependency.
An alternative is to pre-build a wheel for ``pathlib`` using a separated
virtual environment with an older version of setuptools and install the
library directly from the pre-built wheel.

60.8.2

-------


Misc
^^^^
* 3091: Make ``concurrent.futures`` import lazy in vendored ``more_itertools``
package to a  avoid importing threading as a side effect (which caused
`gevent/gevent1865 <https://github.com/gevent/gevent/issues/1865>`__).
-- by :user:`maciejp-ro`

60.8.1

-------


Misc
^^^^
* 3084: When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.

60.8.0

-------


Changes
^^^^^^^
* 3085: Setuptools now vendors importlib_resources and importlib_metadata and jaraco.text. Setuptools no longer relies on pkg_resources for ensure_directory nor parse_requirements.

60.7.1

-------


Misc
^^^^
* 3072: Remove lorem_ipsum from jaraco.text when vendored.

60.7.0

-------


Changes
^^^^^^^
* 3061: Vendored jaraco.text and use line processing from that library in pkg_resources.

Misc
^^^^
* 3070: Avoid AttributeError in easy_install.create_home_path when sysconfig.get_config_vars values are not strings.

60.6.0

-------


Changes
^^^^^^^
* 3043: Merge with pypa/distutilsbb018f1ac3 including consolidated behavior in sysconfig.get_platform (pypa/distutils104).
* 3057: Don't include optional ``Home-page`` in metadata if no ``url`` is specified. -- by :user:`cdce8p`
* 3062: Merge with pypa/distutilsb53a824ec3 including improved support for lib directories on non-x64 Windows builds.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2897: Added documentation about wrapping ``setuptools.build_meta`` in a in-tree
custom backend. This is a :pep:`517`-compliant way of dynamically specifying
build dependencies (e.g. when platform, OS and other markers are not enough).
-- by :user:`abravalheri`
* 3034: Replaced occurrences of the defunct distutils-sig mailing list with pointers
to GitHub Discussions.
-- by :user:`ashemedai`
* 3056: The documentation has stopped suggesting to add ``wheel`` to
:pep:`517` requirements -- by :user:`webknjaz`

Misc
^^^^
* 3054: Used Py3 syntax ``super().__init__()`` -- by :user:`imba-tjd`

60.5.4

-------


Misc
^^^^
* 3009: Remove filtering of distutils warnings.
* 3031: Suppress distutils replacement when building or testing CPython.

60.5.3

-------


Misc
^^^^
* 3026: Honor sysconfig variables in easy_install.

60.5.2

-------


Misc
^^^^
* 2993: In _distutils_hack, for get-pip, simulate existence of setuptools.

60.5.1

-------


Misc
^^^^
* 2918: Correct support for Python 3 native loaders.

60.5.0

-------


Changes
^^^^^^^
* 2990: Set the ``.origin`` attribute of the ``distutils`` module to the module's ``__file__``.

60.4.0

-------


Changes
^^^^^^^
* 2839: Removed ``requires`` sorting when installing wheels as an egg dir.
* 2953: Fixed a bug that easy install incorrectly parsed Python 3.10 version string.
* 3006: Fixed startup performance issue of Python interpreter due to imports of
costly modules in ``_distutils_hack`` -- by :user:`tiran`

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2674: Added link to additional resources on packaging in Quickstart guide
* 3008: "In-tree" Sphinx extension for "favicons" replaced with ``sphinx-favicon``.
* 3008: SVG images (logo, banners, ...) optimised with the help of the ``scour``
package.

Misc
^^^^
* 2862: Added integration tests that focus on building and installing some packages in
the Python ecosystem via ``pip`` -- by :user:`abravalheri`
* 2952: Modified "vendoring" logic to keep license files.
* 2968: Improved isolation for some tests that where inadvertently using the project
root for builds, and therefore creating directories (e.g. ``build``, ``dist``,
``*.egg-info``) that could interfere with the outcome of other tests
-- by :user:`abravalheri`.
* 2968: Introduced new test fixtures ``venv``, ``venv_without_setuptools``,
``bare_venv`` that rely on the ``jaraco.envs`` package.
These new test fixtures were also used to remove the (currently problematic)
dependency on the ``pytest_virtualenv`` plugin.
* 2968: Removed ``tmp_src`` test fixture. Previously this fixture was copying all the
files and folders under the project root, including the ``.git`` directory,
which is error prone and increases testing time.

Since ``tmp_src`` was used to populate virtual environments (installing the
version of ``setuptools`` under test via the source tree), it was replaced by
the new ``setuptools_sdist`` and ``setuptools_wheel`` fixtures (that are build
only once per session testing and can be shared between all the workers for
read-only usage).

60.3.1

-------


Misc
^^^^
* 3002: Suppress AttributeError when detecting get-pip.

60.3.0

-------


Changes
^^^^^^^
* 2993: In _distutils_hack, bypass the distutils exception for pip when get-pip is being invoked, because it imports setuptools.

Misc
^^^^
* 2989: Merge with pypa/distutils788cc159. Includes fix for config vars missing from sysconfig.

60.2.0

-------


Changes
^^^^^^^
* 2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of using ``distutils.log.*``, use ``logging.getLogger(name).*``.
* 2987: Sync with pypa/distutils2def21c5d74fdd2fe7996ee4030ac145a9d751bd, including fix for missing get_versions attribute (2969), more reliance on sysconfig from stdlib.

Misc
^^^^
* 2962: Avoid attempting to use local distutils when the presiding version of Setuptools on the path doesn't have one.
* 2983: Restore 'add_shim' as the way to invoke the hook. Avoids compatibility issues between different versions of Setuptools with the distutils local implementation.

60.1.1

-------


Misc
^^^^
* 2980: Bypass distutils loader when setuptools module is no longer available on sys.path.

60.1.0

-------


Changes
^^^^^^^
* 2958: In distutils_hack, only add the metadata finder once. In ensure_local_distutils, rely on a context manager for reliable manipulation.
* 2963: Merge with pypa/distutilsa5af364910. Includes revisited fix for pypa/distutils15 and improved MinGW/Cygwin support from pypa/distutils77.

60.0.5

-------


Misc
^^^^
* 2960: Install schemes fall back to default scheme for headers.

60.0.4

-------


Misc
^^^^
* 2954: Merge with pypa/distutilseba2bcd310. Adds platsubdir to config vars available for substitution.

60.0.3

-------


Misc
^^^^
* 2940: Avoid KeyError in distutils hack when pip is imported during ensurepip.

60.0.2

-------


Misc
^^^^
* 2938: Select 'posix_user' for the scheme unless falling back to stdlib, then use 'unix_user'.

60.0.1

-------


Misc
^^^^
* 2944: Add support for extended install schemes in easy_install.

60.0.0

-------


Breaking Changes
^^^^^^^^^^^^^^^^
* 2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib.

59.8.0

-------


Changes
^^^^^^^
* 2935: Merge pypa/distutils460b59f0e68dba17e2465e8dd421bbc14b994d1f.

59.7.0

-------


Changes
^^^^^^^
* 2930: Require Python 3.7

59.6.0

-------


Changes
^^^^^^^
* 2925: Merge with pypa/distutils92082ee42c including introduction of deprecation warning on Version classes.

59.5.0

-------


Changes
^^^^^^^
* 2914: Merge with pypa/distutils8f2df0bf6.

59.4.0

-------


Changes
^^^^^^^
* 2893: Restore deprecated support for newlines in the Summary field.

59.3.0

-------


Changes
^^^^^^^
* 2902: Merge with pypa/distutils85db7a41242.

Misc
^^^^
* 2906: In ensure_local_distutils, re-use DistutilsMetaFinder to load the module. Avoids race conditions when _distutils_system_mod is employed.

59.2.0

-------


Changes
^^^^^^^
* 2875: Introduce changes from pypa/distutils514e9d0, including support for overrides from Debian and pkgsrc, unlocking the possibility of making SETUPTOOLS_USE_DISTUTILS=local the default again.

59.1.1

-------


Misc
^^^^
* 2885: Fixed errors when encountering LegacyVersions.

59.1.0

-------


Changes
^^^^^^^
* 2497: Update packaging to 21.2.
* 2877: Back out deprecation of setup_requires and replace instead by a deprecation of setuptools.installer and fetch_build_egg. Now setup_requires is still supported when installed as part of a PEP 517 build, but is deprecated when an unsatisfied requirement is encountered.
* 2879: Bump packaging to 21.2.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2867: PNG/ICO images replaced with SVG in the docs.
* 2867: Added support to SVG "favicons" via "in-tree" Sphinx extension.

59.0.1

-------


Misc
^^^^
* 2880: Removed URL requirement for ``pytest-virtualenv`` in ``setup.cfg``.
PyPI rejects packages with dependencies external to itself.
Instead the test dependency was overwritten via ``tox.ini``

59.0.0

-------


Deprecations
^^^^^^^^^^^^
* 2856: Support for custom commands that inherit directly from ``distutils`` is
**deprecated**. Users should extend classes provided by setuptools instead.

Breaking Changes
^^^^^^^^^^^^^^^^
* 2870: Started failing on invalid inline description with line breaks :class:`ValueError` -- by :user:`webknjaz`

Changes
^^^^^^^
* 2698: Exposed exception classes from ``distutils.errors`` via ``setuptools.errors``.
* 2866: Incorporate changes from pypa/distutilsf1b0a2b.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2227: Added sphinx theme customisations to display the new logo in the sidebar and
use its colours as "accent" in the documentation -- by :user:`abravalheri`
* 2227: Added new setuptools logo, including editable files and artwork documentation
-- by :user:`abravalheri`
* 2698: Added mentions to ``setuptools.errors`` as a way of handling custom command
errors.
* 2698: Added instructions to migrate from ``distutils.commands`` and
``distutils.errors`` in the porting guide.
* 2871: Added a note to the docs that it is possible to install
``setup.py``-less projects in editable mode with :doc:`pip v21.1+
<pip:index>`, only having ``setup.cfg`` and ``pyproject.toml`` in
project root -- by :user:`webknjaz`

58.5.3

-------


Misc
^^^^
* 2849: Add fallback for custom ``build_py`` commands inheriting directly from
:mod:`distutils`, while still handling ``include_package_data=True`` for
``sdist``.

58.5.2

-------


Misc
^^^^
* 2847: Suppress 'setup.py install' warning under bdist_wheel.

58.5.1

-------


Misc
^^^^
* 2846: Move PkgResourcesDeprecationWarning above implicitly-called function so that it's in the namespace when version warnings are generated in an environment that contains them.

58.5.0

-------


Changes
^^^^^^^
* 1461: Fix inconsistency with ``include_package_data`` and ``packages_data`` in sdist
by replacing the loop breaking mechanism between the ``sdist`` and
``egg_info`` commands -- by :user:`abravalheri`

58.4.0

-------


Changes
^^^^^^^
* 2497: Officially deprecated PEP 440 non-compliant versions.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2832: Removed the deprecated ``data_files`` option from the example in the
declarative configuration docs -- by :user:`abravalheri`
* 2832: Change type of ``data_files`` option from ``dict`` to ``section`` in
declarative configuration docs (to match previous example) -- by
:user:`abravalheri`


.. _setup_install_deprecation_note:

58.3.0

-------


Changes
^^^^^^^
* 917: ``setup.py install`` and ``easy_install`` commands are now officially deprecated. Use other standards-based installers (like pip) and builders (like build). Workloads reliant on this behavior should pin to this major version of Setuptools. See `Why you shouldn't invoke setup.py directly <https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html>`_ for more background.
* 1988: Deprecated the ``bdist_rpm`` command. Binary packages should be built as wheels instead.
-- by :user:`hugovk`
* 2785: Replace ``configparser``'s ``readfp`` with ``read_file``, deprecated since Python 3.2.
-- by :user:`hugovk`
* 2823: Officially deprecated support for ``setup_requires``. Users are encouraged instead to migrate to PEP 518 ``build-system.requires`` in ``pyproject.toml``. Users reliant on ``setup_requires`` should consider pinning to this major version to avoid disruption.

Misc
^^^^
* 2762: Changed codecov.yml to configure the threshold to be lower
-- by :user:`tanvimoharir`

58.2.0

-------


Changes
^^^^^^^
* 2757: Add windows arm64 launchers for scripts generated by easy_install.
* 2800: Added ``--owner`` and ``--group`` options to the ``sdist`` command,
for specifying file ownership within the produced tarball (similarly
to the corresponding distutils ``sdist`` options).

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2792: Document how the legacy and non-legacy versions are compared, and reference to the PEP 440 scheme.

58.1.0

-------


Changes
^^^^^^^
* 2796: Merge with pypa/distutils02e9f65ab0

58.0.4

-------


Misc
^^^^
* 2773: Retain case in setup.cfg during sdist.

58.0.3

-------


Misc
^^^^
* 2777: Build does not fail fast when ``use_2to3`` is supplied but set to a false value.

58.0.2

-------


Misc
^^^^
* 2769: Build now fails fast when ``use_2to3`` is supplied.

58.0.1

-------


Misc
^^^^
* 2765: In Distribution.finalize_options, suppress known removed entry points to avoid issues with older Setuptools.

58.0.0

-------


Breaking Changes
^^^^^^^^^^^^^^^^
* 2086: Removed support for 2to3 during builds. Projects should port to a unified codebase or pin to an older version of Setuptools using PEP 518 build-requires.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2746: add python_requires example

57.5.0

-------


Changes
^^^^^^^
* 2712: Added implicit globbing support for ``[options.data_files]`` values.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2737: fix various syntax and style errors in code snippets in docs

57.4.0

-------


Changes
^^^^^^^
* 2722: Added support for ``SETUPTOOLS_EXT_SUFFIX`` environment variable to override the suffix normally detected from the ``sysconfig`` module.

57.3.0

-------


Changes
^^^^^^^
* 2465: Documentation is now published using the Furo theme.

57.2.0

-------


Changes
^^^^^^^
* 2724: Added detection of Windows ARM64 build environments using the ``VSCMD_ARG_TGT_ARCH`` environment variable.

57.1.0

-------


Changes
^^^^^^^
* 2692: Globs are now sorted in 'license_files' restoring reproducibility by eliminating variance from disk order.
* 2714: Update to distutils at pypa/distutilse2627b7.
* 2715: Removed reliance on deprecated ssl.match_hostname by removing the ssl support. Now any index operations rely on the native SSL implementation.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2604: Revamped the backward/cross tool compatibility section to remove
some confusion.
Add some examples and the version since when ``entry_points`` are
supported in declarative configuration.
Tried to make the reading flow a bit leaner, gather some information
that were a bit dispersed.

Links

• PyPI: https://pypi.org/project/setuptools
• Changelog: https://pyup.io/changelogs/setuptools/
• Repo: https://github.com/pypa/setuptools