Update dependency setuptools to v62
This MR contains the following updates:
Package | Type | Update | Change |
---|---|---|---|
setuptools | ironbank-pypi | major |
60.5.0 -> 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
Configuration
-
If you want to rebase/retry this MR, click this checkbox.
This MR has been generated by Renovate Bot.