Update dependency setuptools to v62
This MR contains the following updates:
Package | Update | Change |
---|---|---|
setuptools | major |
==49.2.1 -> ==62.3.2
|
Release Notes
pypa/setuptools
v62.3.2
Misc ^^^^
- #3328: Include a first line summary to some of the existing multi-line warnings.
v62.3.1
Misc ^^^^
-
#3320: Fixed typo which causes
namespace_packages
to raise an error instead of warning.
v62.3.0
Deprecations ^^^^^^^^^^^^
-
#3262: Formally added deprecation messages for
namespace_packages
. The methodology that usespkg_resources
andnamespace_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 (
**
) inpackage_data
. -- by :user:nullableVoidPtr
-
#3206: Fixed behaviour when both
install_requires
(insetup.py
) anddependencies
(inpyproject.toml
) are specified. The configuration inpyproject.toml
will take precedence oversetup.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
.
v62.2.0
Changes ^^^^^^^
-
#3299: Optional metadata fields are now truly optional. Includes merge with pypa/distutils@
a7cfb56
per pypa/distutils#138.
Misc ^^^^
-
#3282: Added CI cache for
setup.cfg
examples used when testingsetuptools.config
.
v62.1.0
Changes ^^^^^^^
-
#3258: Merge pypa/distutils@
5229dad
.
Misc ^^^^
-
#3249: Simplified
package_dir
obtained via auto-discovery.
v62.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 inpyproject.toml
from being dynamically specified insetup.py
.
v61.3.1
Misc ^^^^
-
#3233: Included missing test file
setupcfg_examples.txt
insdist
. -
#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.
v61.3.0
Changes ^^^^^^^
-
#3229: Disabled automatic download of
trove-classifiers
to facilitate reproducibility.
Misc ^^^^
-
#3229: Updated
pyproject.toml
validation viavalidate-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 viatox -e generate-validation-code
.
v61.2.0
Changes ^^^^^^^
-
#3215: Ignored a subgroup of invalid
pyproject.toml
files that use the[project]
table to specify onlyrequires-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 byvalidate-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 settingdynamic
properly... important:: This is a transitional behaviour. Future releases of
setuptools
may simply ignore externally set metadata not backed bydynamic
or even halt the build with an error. -
#3224: Merge changes from pypa/distutils@
e1d5c9b
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 inpyproject.toml
.
v61.1.1
Misc ^^^^
-
#3212: Fixed missing dependencies when running
setup.py install
. Note that callingsetup.py install
directly is still deprecated and will be removed in future versions ofsetuptools
. Please check the release notes for :ref:setup_install_deprecation_note
.
v61.1.0
Deprecations ^^^^^^^^^^^^
-
#3206: Changed
setuptools.convert_path
to an internal function that is not exposed as part of setuptools API. Future releases ofsetuptools
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 overwritingdist.include_package_data
explicitly set insetup.py
with default value. -
#3208: Added a warning for non existing files listed with the
file
directive insetup.cfg
andpyproject.toml
. -
#3208: Added a default value for dynamic
classifiers
inpyproject.toml
when files are missing and errors being ignored. -
#3211: Disabled auto-discovery when distribution class has a
configuration
attribute (e.g. when thesetup.py
script containssetup(..., configuration=...)
). This is done to ensure extension-only packages created withnumpy.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
, orconfiguration
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
orpy_modules
. Alternatively you can also configure :ref:custom-discovery
.
v61.0.0
Deprecations ^^^^^^^^^^^^
-
#3068: Deprecated
setuptools.config.read_configuration
,setuptools.config.parse_configuration
and other functions or classes fromsetuptools.config
.Users that still need to parse and process configuration from
setup.cfg
can import a direct replacement fromsetuptools.config.setupcfg
, however this module is transitional and might be removed in the future (thesetup.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
andpy_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 beTrue
. - 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 insetup.cfg
orsetup.py
.
- The default value of
Changes ^^^^^^^
-
#2887: [EXPERIMENTAL] Added automatic discovery for
py_modules
andpackages
-- 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
andpackages
are not set. (Note: specifyingext_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
andpackages
in yoursetup.cfg
orsetup.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 ofinclude_package_data
is changed toTrue
. -
#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 thepyproject.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>
, whensetuptools
configuration and project metadata are added to thepyproject.toml
file.To disable this behaviour, use
namespaces = False
when explicitly setting the[tool.setuptools.packages.find]
section inpyproject.toml
.This change is backwards compatible and does not affect the behaviour of configuration done in
setup.cfg
orsetup.py
. -
#3152: [EXPERIMENTAL] Added support for
attr:
andcmdclass
configurations insetup.cfg
andpyproject.toml
whenpackage_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 havelibffi
installed. -
#3179: Merge with pypa/distutils@
267dbd2
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#3172: Added initial documentation about configuring
setuptools
viapyproject.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 asfile:
that can be used across different configuration formats).
v60.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:MRE_BUILT_SETUPTOOLS_SDIST
andMRE_BUILT_SETUPTOOLS_WHEEL
.
v60.9.3
Misc ^^^^
- #3093: Repaired automated release process.
v60.9.2
Misc ^^^^
-
#3035: When loading distutils from the vendored copy, rewrite
__name__
to ensure consistent importing from inside and out.
v60.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.
v60.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-pip#137 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.
v60.8.2
Misc ^^^^
-
#3091: Make
concurrent.futures
import lazy in vendoredmore_itertools
package to a avoid importing threading as a side effect (which causedgevent/gevent#​1865 <https://github.com/gevent/gevent/issues/1865>
__). -- by :user:maciejp-ro
v60.8.1
Misc ^^^^
- #3084: When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.
v60.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.
v60.7.1
Misc ^^^^
- #3072: Remove lorem_ipsum from jaraco.text when vendored.
v60.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.
v60.6.0
Changes ^^^^^^^
-
#3043: Merge with pypa/distutils@
bb018f1
including consolidated behavior in sysconfig.get_platform (pypa/distutils#104). -
#3057: Don't include optional
Home-page
in metadata if nourl
is specified. -- by :user:cdce8p
-
#3062: Merge with pypa/distutils@
b53a824
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
v60.5.0
Changes ^^^^^^^
-
#2990: Set the
.origin
attribute of thedistutils
module to the module's__file__
.
v60.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 thejaraco.envs
package. These new test fixtures were also used to remove the (currently problematic) dependency on thepytest_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 ofsetuptools
under test via the source tree), it was replaced by the newsetuptools_sdist
andsetuptools_wheel
fixtures (that are build only once per session testing and can be shared between all the workers for read-only usage).
v60.3.1
Misc ^^^^
- #3002: Suppress AttributeError when detecting get-pip.
v60.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/distutils@
788cc15
. Includes fix for config vars missing from sysconfig.
v60.2.0
Changes ^^^^^^^
-
#2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of using
distutils.log.*
, uselogging.getLogger(name).*
. -
#2987: Sync with pypa/distutils@
2def21c
, 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.
v60.1.1
Misc ^^^^
- #2980: Bypass distutils loader when setuptools module is no longer available on sys.path.
v60.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/distutils@
a5af364
. Includes revisited fix for pypa/distutils#15 and improved MinGW/Cygwin support from pypa/distutils#77.
v60.0.5
Misc ^^^^
- #2960: Install schemes fall back to default scheme for headers.
v60.0.4
Misc ^^^^
-
#2954: Merge with pypa/distutils@
eba2bcd
. Adds platsubdir to config vars available for substitution.
v60.0.3
Misc ^^^^
- #2940: Avoid KeyError in distutils hack when pip is imported during ensurepip.
v60.0.2
Misc ^^^^
- #2938: Select 'posix_user' for the scheme unless falling back to stdlib, then use 'unix_user'.
v60.0.1
Misc ^^^^
- #2944: Add support for extended install schemes in easy_install.
v60.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
- #2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib.
v59.8.0
Changes ^^^^^^^
-
#2935: Merge pypa/distutils@
460b59f
.
v59.7.0
Changes ^^^^^^^
- #2930: Require Python 3.7
v59.6.0
Changes ^^^^^^^
-
#2925: Merge with pypa/distutils@
92082ee
including introduction of deprecation warning on Version classes.
v59.5.0
Changes ^^^^^^^
-
#2914: Merge with pypa/distutils@
8f2df0b
.
v59.4.0
Changes ^^^^^^^
- #2893: Restore deprecated support for newlines in the Summary field.
v59.3.0
Changes ^^^^^^^
-
#2902: Merge with pypa/distutils@
85db7a4
.
Misc ^^^^
- #2906: In ensure_local_distutils, re-use DistutilsMetaFinder to load the module. Avoids race conditions when _distutils_system_mod is employed.
v59.2.0
Changes ^^^^^^^
-
#2875: Introduce changes from pypa/distutils@
514e9d0
, including support for overrides from Debian and pkgsrc, unlocking the possibility of making SETUPTOOLS_USE_DISTUTILS=local the default again.
v59.1.1
Misc ^^^^
- #2885: Fixed errors when encountering LegacyVersions.
v59.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.
v59.0.1
Misc ^^^^
-
#2880: Removed URL requirement for
pytest-virtualenv
insetup.cfg
. PyPI rejects packages with dependencies external to itself. Instead the test dependency was overwritten viatox.ini
v58.5.3
Misc ^^^^
-
#2849: Add fallback for custom
build_py
commands inheriting directly from :mod:distutils
, while still handlinginclude_package_data=True
forsdist
.
v58.5.2
Misc ^^^^
- #2847: Suppress 'setup.py install' warning under bdist_wheel.
v58.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.
v58.5.0
Changes ^^^^^^^
-
#1461: Fix inconsistency with
include_package_data
andpackages_data
in sdist by replacing the loop breaking mechanism between thesdist
andegg_info
commands -- by :user:abravalheri
v58.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 fromdict
tosection
in declarative configuration docs (to match previous example) -- by :user:abravalheri
.. _setup_install_deprecation_note:
v58.3.0
Changes ^^^^^^^
-
#917:
setup.py install
andeasy_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. SeeWhy 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
'sreadfp
withread_file
, deprecated since Python 3.2. -- by :user:hugovk
-
#2823: Officially deprecated support for
setup_requires
. Users are encouraged instead to migrate to PEP 518build-system.requires
inpyproject.toml
. Users reliant onsetup_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
v58.2.0
Changes ^^^^^^^
- #2757: Add windows arm64 launchers for scripts generated by easy_install.
-
#2800: Added
--owner
and--group
options to thesdist
command, for specifying file ownership within the produced tarball (similarly to the corresponding distutilssdist
options).
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
- #2792: Document how the legacy and non-legacy versions are compared, and reference to the PEP 440 scheme.
v58.1.0
Changes ^^^^^^^
-
#2796: Merge with pypa/distutils@
02e9f65
v58.0.4
Misc ^^^^
- #2773: Retain case in setup.cfg during sdist.
v58.0.3
Misc ^^^^
-
#2777: Build does not fail fast when
use_2to3
is supplied but set to a false value.
v58.0.2
Misc ^^^^
-
#2769: Build now fails fast when
use_2to3
is supplied.
v58.0.1
Misc ^^^^
- #2765: In Distribution.finalize_options, suppress known removed entry points to avoid issues with older Setuptools.
v58.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
v57.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
v57.4.0
Changes ^^^^^^^
-
#2722: Added support for
SETUPTOOLS_EXT_SUFFIX
environment variable to override the suffix normally detected from thesysconfig
module.
v57.3.0
Changes ^^^^^^^
- #2465: Documentation is now published using the Furo theme.
v57.2.0
Changes ^^^^^^^
-
#2724: Added detection of Windows ARM64 build environments using the
VSCMD_ARG_TGT_ARCH
environment variable.
v57.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/distutils@
e2627b7
. - #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.
v57.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
-
#2645: License files excluded via the
MANIFEST.in
but matched by either thelicense_file
(deprecated) orlicense_files
options, will be nevertheless included in the source distribution. - by :user:cdce8p
Changes ^^^^^^^
-
#2628: Write long description in message payload of PKG-INFO file. - by :user:
cdce8p
-
#2645: Added
License-File
(multiple) to the output package metadata. The field will contain the path of a license file, matched by thelicense_file
(deprecated) andlicense_files
options, relative to.dist-info
. - by :user:cdce8p
- #2678: Moved Setuptools' own entry points into declarative config.
-
#2680: Vendored :pypi:
more_itertools
for Setuptools. - #2681: Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml.
Misc ^^^^
-
#2650: Updated the docs build tooling to support the latest version of
Towncrier and show the previews of not-yet-released setuptools versions
in the changelog -- :user:
webknjaz
v56.2.0
Changes ^^^^^^^
-
#2640: Fixed handling of multiline license strings. - by :user:
cdce8p
-
#2641: Setuptools will now always try to use the latest supported
metadata version for
PKG-INFO
. - by :user:cdce8p
v56.1.0
Changes ^^^^^^^
- #2653: Incorporated assorted changes from pypa/distutils.
- #2657: Adopted docs from distutils.
-
#2663: Added Visual Studio Express 2017 support -- by :user:
dofuuz
Misc ^^^^
-
#2644: Fixed
DeprecationWarning
due tothreading.Thread.setDaemon
in tests -- by :user:tirkarthi
-
#2654: Made the changelog generator compatible
with Towncrier >= 19.9 -- :user:
webknjaz
- #2664: Relax the deprecation message in the distutils hack.
v56.0.0
Deprecations ^^^^^^^^^^^^
-
#2620: The
license_file
option is now marked as deprecated. Uselicense_files
instead. -- by :user:cdce8p
Breaking Changes ^^^^^^^^^^^^^^^^
-
#2620: If neither
license_file
norlicense_files
is specified, thesdist
option will now auto-include files that match the following patterns:LICEN[CS]E*
,COPYING*
,NOTICE*
,AUTHORS*
. This matches the behavior ofbdist_wheel
. -- by :user:cdce8p
Changes ^^^^^^^
-
#2620: The
license_file
andlicense_files
options now support glob patterns. -- by :user:cdce8p
-
#2632: Implemented
VendorImporter.find_spec()
method to get rid ofImportWarning
that Python 3.10 emits when only the old-style importer hooks are present -- by :user:webknjaz
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2620: Added documentation for the
license_files
option. -- by :user:cdce8p
v54.2.0
Changes ^^^^^^^
-
#2608: Added informative error message to PEP 517 build failures owing to
an empty
setup.py
-- by :user:layday
v54.1.3
No significant changes.
v54.1.2
Misc ^^^^
-
#2595: Reduced scope of dash deprecation warning to Setuptools/distutils only -- by :user:
melissa-kun-li
v54.1.1
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2584: Added
sphinx-inline-tabs
extension to allow for comparison ofsetup.py
and its equivalentsetup.cfg
-- by :user:amy-lei
Misc ^^^^
-
#2592: Made option keys in the
[metadata]
section ofsetup.cfg
case-sensitive. Users having uppercase option spellings will get a warning suggesting to make them to lowercase -- by :user:melissa-kun-li
v54.1.0
Changes ^^^^^^^
-
#1608: Removed the conversion of dashes to underscores in the :code:
extras_require
and :code:data_files
of :code:setup.cfg
to support the usage of dashes. Method will warn users when they use a dash-separated key which in the future will only allow an underscore. Note: the method performs the dash to underscore conversion to preserve compatibility, but future versions will no longer support it -- by :user:melissa-kun-li
v54.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
- #2582: Simplified build-from-source story by providing bootstrapping metadata in a separate egg-info directory. Build requirements no longer include setuptools itself. Sdist once again includes the pyproject.toml. Project can no longer be installed from source on pip 19.x, but install from source is still supported on pip < 19 and pip >= 20 and install from wheel is still supported with pip >= 9.
Changes ^^^^^^^
-
#1932: Handled :code:
AttributeError
by raising :code:DistutilsSetupError
in :code:dist.check_specifier()
when specifier is not a string -- by :user:melissa-kun-li
- #2570: Correctly parse cmdclass in setup.cfg.
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2553: Added userguide example for markers in extras_require -- by :user:
pwoolvett
v53.1.0
Changes ^^^^^^^
-
#1937: Preserved case-sensitivity of keys in setup.cfg so that entry point names are case-sensitive. Changed sensitivity of configparser. NOTE: Any projects relying on case-insensitivity will need to adapt to accept the original case as published. -- by :user:
melissa-kun-li
-
#2573: Fixed error in uploading a Sphinx doc with the :code:
upload_docs
command. An html builder will be used. Note: :code:upload_docs
is deprecated for PyPi, but is supported for other sites -- by :user:melissa-kun-li
v53.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
- #1527: Removed bootstrap script. Now Setuptools requires pip or another pep517-compliant builder such as 'build' to build. Now Setuptools can be installed from Github main branch.
v52.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
- #2537: Remove fallback support for fetch_build_eggs using easy_install. Now pip is required for setup_requires to succeed.
- #2544: Removed 'easy_install' top-level model (runpy entry point) and 'easy_install' console script.
- #2545: Removed support for eggsecutables.
Changes ^^^^^^^
-
#2459: Tests now run in parallel via pytest-xdist, completing in about half the time. Special thanks to :user:
webknjaz
for hard work implementing test isolation. To run without parallelization, disable the plugin withtox -- -p no:xdist
.
v51.3.3
Misc ^^^^
- #2539: Fix AttributeError in Description validation.
v51.3.2
Misc ^^^^
- #1390: Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces).
v51.3.1
Misc ^^^^
- #2536: Reverted tag deduplication handling.
v51.3.0
Changes ^^^^^^^
- #1390: Newlines in metadata description/Summary now trigger a ValueError.
-
#2481: Define
create_module()
andexec_module()
methods inVendorImporter
to get rid ofImportWarning
-- by :user:hroncok
-
#2489:
pkg_resources
behavior for zipimport now matches the regular behavior, and finds.egg-info
(previously would only find.dist-info
) -- by :user:thatch
- #2529: Fixed an issue where version tags may be added multiple times
v51.2.0
Changes ^^^^^^^
-
#2493: Use importlib.import_module() rather than the deprecated loader.load_module()
in pkg_resources namespace declaration -- by :user:
encukou
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2525: Fix typo in the document page about entry point. -- by :user:
jtr109
Misc ^^^^
- #2534: Avoid hitting network during test_easy_install.
v51.1.2
Misc ^^^^
- #2505: Disable inclusion of package data as it causes 'tests' to be included as data.
v51.1.1
Misc ^^^^
- #2534: Avoid hitting network during test_virtualenv.test_test_command.
v51.1.0
Changes ^^^^^^^
- #2486: Project adopts jaraco/skeleton for shared package maintenance.
Misc ^^^^
- #2477: Restore inclusion of rst files in sdist.
- #2484: Setuptools has replaced the master branch with the main branch.
-
#2485: Fixed failing test when pip 20.3+ is present.
-- by :user:
yan12125
-
#2487: Fix tests with pytest 6.2
-- by :user:
yan12125
v51.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
- #2435: Require Python 3.6 or later.
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2430: Fixed inconsistent RST title nesting levels caused by #2399
-- by :user:
webknjaz
-
#2430: Fixed a typo in Sphinx docs that made docs dev section disappear
as a result of MR #2426 -- by :user:
webknjaz
Misc ^^^^
- #2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.
v50.3.2
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2394: Extended towncrier news template to include change note categories.
This allows to see what types of changes a given version introduces
-- by :user:
webknjaz
-
#2427: Started enforcing strict syntax and reference validation
in the Sphinx docs -- by :user:
webknjaz
-
#2428: Removed redundant Sphinx
Makefile
support -- by :user:webknjaz
Misc ^^^^
-
#2401: Enabled test results reporting in AppVeyor CI
-- by :user:
webknjaz
- #2420: Replace Python 3.9.0 beta with 3.9.0 final on GitHub Actions.
-
#2421: Python 3.9 Trove classifier got added to the dist metadata
-- by :user:
webknjaz
v50.3.1
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
- #2093: Finalized doc revamp.
- #2097: doc: simplify index and group deprecated files
- #2102: doc overhaul step 2: break main doc into multiple sections
- #2111: doc overhaul step 3: update userguide
-
#2395: Added a
:user:
role to Sphinx config -- by :user:webknjaz
-
#2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:
webknjaz
Misc ^^^^
- #2379: Travis CI test suite now tests against PPC64.
- #2413: Suppress EOF errors (and other exceptions) when importing lib2to3.
v50.3.0
Changes ^^^^^^^
- #2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils#15.
v50.2.0
Changes ^^^^^^^
- #2355: When pip is imported as part of a build, leave distutils patched.
-
#2380: There are some setuptools specific changes in the
setuptools.command.bdist_rpm
module that are no longer needed, because they are part of thebdist_rpm
module in distutils in Python 3.5.0. Therefore, code was removed fromsetuptools.command.bdist_rpm
.
v50.1.0
Changes ^^^^^^^
-
#2350: Setuptools reverts using the included distutils by default. Platform maintainers and system integrators and others are strongly encouraged to set
SETUPTOOLS_USE_DISTUTILS=local
to help identify and work through the reported issues with distutils adoption, mainly to file issues and pull requests with pypa/distutils such that distutils performs as needed across every supported environment.
v50.0.3
Misc ^^^^
- #2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils#9).
v50.0.2
Misc ^^^^
- #2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.
v50.0.1
Misc ^^^^
-
#2357: Restored Python 3.5 support in distutils.util for missing
subprocess._optim_args_from_interpreter_flags
. - #2358: Restored AIX support on Python 3.8 and earlier.
- #2361: Add Python 3.10 support to _distutils_hack. Get the 'Loader' abstract class from importlib.abc rather than importlib.util.abc (alias removed in Python 3.10).
v50.0.0
Breaking Changes ^^^^^^^^^^^^^^^^
-
#2232: Once again, Setuptools overrides the stdlib distutils on import. For environments or invocations where this behavior is undesirable, users are provided with a temporary escape hatch. If the environment variable
SETUPTOOLS_USE_DISTUTILS
is set tostdlib
, Setuptools will fall back to the legacy behavior. Use of this escape hatch is discouraged, but it is provided to ease the transition while proper fixes for edge cases can be addressed.
Changes ^^^^^^^
- #2334: In MSVC module, refine text in error message.
v49.6.0
Changes ^^^^^^^
- #2129: In pkg_resources, no longer detect any pathname ending in .egg as a Python egg. Now the path must be an unpacked egg or a zip file.
v49.5.0
Changes ^^^^^^^
-
#2306: When running as a PEP 517 backend, setuptools does not try to install
setup_requires
itself. They are reported as build requirements for the frontend to install.
v49.4.0
Changes ^^^^^^^
- #2310: Updated vendored packaging version to 20.4.
v49.3.2
Documentation changes ^^^^^^^^^^^^^^^^^^^^^
-
#2300: Improve the
safe_version
function documentation
Misc ^^^^
- #2297: Once again, in stubs prefer exec_module to the deprecated load_module.
v49.3.1
Changes ^^^^^^^
-
#2316: Removed warning when
distutils
is imported beforesetuptools
whendistutils
replacement is not enabled.
v49.3.0
Changes ^^^^^^^
- #2259: Setuptools now provides a .pth file (except for editable installs of setuptools) to the target environment to ensure that when enabled, the setuptools-provided distutils is preferred before setuptools has been imported (and even if setuptools is never imported). Honors the SETUPTOOLS_USE_DISTUTILS environment variable.
Configuration
-
If you want to rebase/retry this MR, click this checkbox.
This MR has been generated by Renovate Bot.