Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==18.0
->==62.3.2
Release Notes
pypa/setuptools
v62.3.2
Compare Source
Misc
^^^^
v62.3.1
Compare Source
Misc
^^^^
namespace_packages
to raise an error instead ofwarning.
v62.3.0
Compare Source
Deprecations
^^^^^^^^^^^^
#3262: Formally added deprecation messages for
namespace_packages
.The methodology that uses
pkg_resources
andnamespace_packages
forcreating 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 automaticallyadded 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 usediscovery tools. General information can be found in :doc:
userguide/package_discovery
.Changes
^^^^^^^
**
) inpackage_data
. -- by :user:nullableVoidPtr
install_requires
(insetup.py
) anddependencies
(inpyproject.toml
) are specified.The configuration in
pyproject.toml
will take precedence oversetup.py
(in accordance with PEP 621). A warning was added to inform users.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
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
^^^^
pyparsing
to 3.0.8 to avoid problems withupcoming deprecation in Python 3.11.
importlib-metadata
.v62.2.0
Compare Source
Changes
^^^^^^^
a7cfb56
per pypa/distutils#138.Misc
^^^^
setup.cfg
examples used when testingsetuptools.config
.v62.1.0
Compare Source
Changes
^^^^^^^
5229dad
.Misc
^^^^
package_dir
obtained via auto-discovery.v62.0.0
Compare Source
Breaking Changes
^^^^^^^^^^^^^^^^
setup.py develop --user
install to the user site packages directory even if it is disabled in the current interpreter.Changes
^^^^^^^
ldaniluk
install_as_egg
-- by :user:delijati
Misc
^^^^
dist-info
command.readme
specified as dynamic inpyproject.toml
from being dynamically specified in
setup.py
.v61.3.1
Compare Source
Misc
^^^^
setupcfg_examples.txt
insdist
.setupcfg_examples.txt
prior torunning tests. By caching these files it should be possible to run the test suite
offline.
v61.3.0
Compare Source
Changes
^^^^^^^
trove-classifiers
to facilitate reproducibility.Misc
^^^^
pyproject.toml
validation viavalidate-pyproject
v0.7.1.the validation of
pyproject.toml
.This tool can be executed via
tox -e generate-validation-code
.v61.2.0
Compare Source
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 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 setting
dynamic
properly... important::
This is a transitional behaviour.
Future releases of
setuptools
may simply ignore externally set metadatanot backed by
dynamic
or even halt the build with an error.#3224: Merge changes from pypa/distutils@
e1d5c9b
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
pyproject.toml
example in Quickstart -- by :user:pablo-cardenas
.Misc
^^^^
optional-dependencies
is set inpyproject.toml
.v61.1.1
Compare Source
Misc
^^^^
setup.py install
.Note that calling
setup.py install
directly is still deprecated andwill be removed in future versions of
setuptools
.Please check the release notes for :ref:
setup_install_deprecation_note
.v61.1.0
Compare Source
Deprecations
^^^^^^^^^^^^
setuptools.convert_path
to an internal function that is not exposedas 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 overwritingdist.include_package_data
explicitly set insetup.py
with defaultvalue.
#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
whenfiles are missing and errors being ignored.
#3211: Disabled auto-discovery when distribution class has a
configuration
attribute (e.g. when the
setup.py
script containssetup(..., configuration=...)
). This is done to ensure extension-only packages createdwith
numpy.distutils.misc_util.Configuration
are not broken by the safeguard
behaviour to avoid accidental multiple top-level packages in a flat-layout.
.. note::
Users that don't set
packages
,py_modules
, orconfiguration
arestill 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
Compare Source
Deprecations
^^^^^^^^^^^^
#3068: Deprecated
setuptools.config.read_configuration
,setuptools.config.parse_configuration
and other functions or classesfrom
setuptools.config
.Users that still need to parse and process configuration from
setup.cfg
canimport a direct replacement from
setuptools.config.setupcfg
, however thismodule 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
andpy_modules
in theirconfiguration 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 projectmetadata/config (via
[project]
table or[tool.setuptools]
),a series of new behaviors that are not backward compatible may take place:
include_package_data
will be considered to beTrue
.pyproject.toml
file accordingto PEP 621 specification.
pyproject.toml
will take precedence over thosespecified in
setup.cfg
orsetup.py
.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: specifying
ext_modules
might also prevent auto-discover fromtaking 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 explicitlyprovided.
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 toTrue
.#3068: [EXPERIMENTAL] Add support for
pyproject.toml
configuration(as introduced by :pep:
621
). Configuration parameters not covered bystandards are handled in the
[tool.setuptools]
sub-table.In the future, existing
setup.cfg
configurationmay 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 defaultduring :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 settingthe
[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
configurationsin
setup.cfg
andpyproject.toml
whenpackage_dir
is implicitlyfound 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/distutils@
267dbd2
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
setuptools
viapyproject.toml
(using standard project metadata).
Misc
^^^^
setuptools.config
by separating configuration parsing (specificto the configuration file format, e.g.
setup.cfg
) and post-processing(which includes directives such as
file:
that can be used across differentconfiguration formats).
v60.10.0
Compare Source
Changes
^^^^^^^
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
xhlulu
MANIFEST.in
, that include links to PyPUG docsand more prominent mentions to using a revision control system plugin as an
alternative.
pkg_resources
as the recommended way of accessing datafiles, 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
^^^^
These tests now are marked with
XFAIL <https://docs.pytest.org/en/stable/how-to/skipping.html>
_, instead of erroringout directly.
rst-linker
(extension used to build thechangelog).
befeleme
setuptools
wheel or sdist for beingused during tests with virtual environments.
Paths for these pre-built distribution files can now be set via the environment
variables:
PRE_BUILT_SETUPTOOLS_SDIST
andPRE_BUILT_SETUPTOOLS_WHEEL
.v60.9.3
Compare Source
Misc
^^^^
v60.9.2
Compare Source
Misc
^^^^
__name__
to ensure consistent importing from inside and out.v60.9.1
Compare Source
Misc
^^^^
v60.9.0
Compare Source
Changes
^^^^^^^
pkg_resources
for entry point handling... warning:: Users trying to install the unmaintained :pypi:
pathlib
backportfrom PyPI/
sdist
/source code may find problems when usingsetuptools >= 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 separatedvirtual environment with an older version of setuptools and install the
library directly from the pre-built wheel.
v60.8.2
Compare Source
Misc
^^^^
concurrent.futures
import lazy in vendoredmore_itertools
package to a avoid importing threading as a side effect (which caused
gevent/gevent#​1865 <https://github.com/gevent/gevent/issues/1865>
__).-- by :user:
maciejp-ro
v60.8.1
Compare Source
Misc
^^^^
v60.8.0
Compare Source
Changes
^^^^^^^
v60.7.1
Compare Source
Misc
^^^^
v60.7.0
Compare Source
Changes
^^^^^^^
Misc
^^^^
v60.6.0
Compare Source
Changes
^^^^^^^
bb018f1
including consolidated behavior in sysconfig.get_platform (pypa/distutils#104).Home-page
in metadata if nourl
is specified. -- by :user:cdce8p
b53a824
including improved support for lib directories on non-x64 Windows builds.Documentation changes
^^^^^^^^^^^^^^^^^^^^^
setuptools.build_meta
in a in-treecustom backend. This is a :pep:
517
-compliant way of dynamically specifyingbuild dependencies (e.g. when platform, OS and other markers are not enough).
-- by :user:
abravalheri
to GitHub Discussions.
-- by :user:
ashemedai
wheel
to:pep:
517
requirements -- by :user:webknjaz
Misc
^^^^
super().__init__()
-- by :user:imba-tjd
v60.5.0
Compare Source
Changes
^^^^^^^
.origin
attribute of thedistutils
module to the module's__file__
.v60.4.0
Compare Source
Changes
^^^^^^^
requires
sorting when installing wheels as an egg dir.costly modules in
_distutils_hack
-- by :user:tiran
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
sphinx-favicon
.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 the
pytest_virtualenv
plugin.#2968: Removed
tmp_src
test fixture. Previously this fixture was copying all thefiles 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 theversion of
setuptools
under test via the source tree), it was replaced bythe new
setuptools_sdist
andsetuptools_wheel
fixtures (that are buildonly once per session testing and can be shared between all the workers for
read-only usage).
v60.3.1
Compare Source
Misc
^^^^
v60.3.0
Compare Source
Changes
^^^^^^^
Misc
^^^^
788cc15
. Includes fix for config vars missing from sysconfig.v60.2.0
Compare Source
Changes
^^^^^^^
distutils.log.*
, uselogging.getLogger(name).*
.2def21c
, including fix for missing get_versions attribute (#2969), more reliance on sysconfig from stdlib.Misc
^^^^
v60.1.1
Compare Source
Misc
^^^^
v60.1.0
Compare Source
Changes
^^^^^^^
a5af364
. Includes revisited fix for pypa/distutils#15 and improved MinGW/Cygwin support from pypa/distutils#77.v60.0.5
Compare Source
Misc
^^^^
v60.0.4
Compare Source
Misc
^^^^
eba2bcd
. Adds platsubdir to config vars available for substitution.v60.0.3
Compare Source
Misc
^^^^
v60.0.2
Compare Source
Misc
^^^^
v60.0.1
Compare Source
Misc
^^^^
v60.0.0
Compare Source
Breaking Changes
^^^^^^^^^^^^^^^^
v59.8.0
Compare Source
Changes
^^^^^^^
460b59f
.v59.7.0
Compare Source
Changes
^^^^^^^
v59.6.0
Compare Source
Changes
^^^^^^^
92082ee
including introduction of deprecation warning on Version classes.v59.5.0
Compare Source
Changes
^^^^^^^
8f2df0b
.v59.4.0
Compare Source
Changes
^^^^^^^
v59.3.0
Compare Source
Changes
^^^^^^^
85db7a4
.Misc
^^^^
v59.2.0
Compare Source
Changes
^^^^^^^
514e9d0
, including support for overrides from Debian and pkgsrc, unlocking the possibility of making SETUPTOOLS_USE_DISTUTILS=local the default again.v59.1.1
Compare Source
Misc
^^^^
v59.1.0
Compare Source
Changes
^^^^^^^
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
v59.0.1
Compare Source
Misc
^^^^
pytest-virtualenv
insetup.cfg
.PyPI rejects packages with dependencies external to itself.
Instead the test dependency was overwritten via
tox.ini
v58.5.3
Compare Source
Misc
^^^^
build_py
commands inheriting directly from:mod:
distutils
, while still handlinginclude_package_data=True
forsdist
.v58.5.2
Compare Source
Misc
^^^^
v58.5.1
Compare Source
Misc
^^^^
v58.5.0
Compare Source
Changes
^^^^^^^
include_package_data
andpackages_data
in sdistby replacing the loop breaking mechanism between the
sdist
andegg_info
commands -- by :user:abravalheri
v58.4.0
Compare Source
Changes
^^^^^^^
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
data_files
option from the example in thedeclarative configuration docs -- by :user:
abravalheri
data_files
option fromdict
tosection
indeclarative configuration docs (to match previous example) -- by
:user:
abravalheri
.. _setup_install_deprecation_note:
v58.3.0
Compare Source
Changes
^^^^^^^
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.bdist_rpm
command. Binary packages should be built as wheels instead.-- by :user:
hugovk
configparser
'sreadfp
withread_file
, deprecated since Python 3.2.-- by :user:
hugovk
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
^^^^
-- by :user:
tanvimoharir
v58.2.0
Compare Source
Changes
^^^^^^^
--owner
and--group
options to thesdist
command,for specifying file ownership within the produced tarball (similarly
to the corresponding distutils
sdist
options).Documentation changes
^^^^^^^^^^^^^^^^^^^^^
v58.1.0
Compare Source
Changes
^^^^^^^
02e9f65
v58.0.4
Compare Source
Misc
^^^^
v58.0.3
Compare Source
Misc
^^^^
use_2to3
is supplied but set to a false value.v58.0.2
Compare Source
Misc
^^^^
use_2to3
is supplied.v58.0.1
Compare Source
Misc
^^^^
v58.0.0
Compare Source
Breaking Changes
^^^^^^^^^^^^^^^^
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
v57.5.0
Compare Source
Changes
^^^^^^^
[options.data_files]
values.Documentation changes
^^^^^^^^^^^^^^^^^^^^^
v57.4.0
Compare Source
Changes
^^^^^^^
SETUPTOOLS_EXT_SUFFIX
environment variable to override the suffix normally detected from thesysconfig
module.v57.3.0
Compare Source
Changes
^^^^^^^
v57.2.0
Compare Source
Changes
^^^^^^^
VSCMD_ARG_TGT_ARCH
environment variable.v57.1.0
Compare Source
Changes
^^^^^^^
e2627b7
.Documentation changes
^^^^^^^^^^^^^^^^^^^^^
some confusion.
Add some examples and the version since when
entry_points
aresupported in declarative configuration.
Tried to make the reading flow a bit leaner, gather some information
that were a bit dispersed.
v57.0.0
Compare Source
Breaking Changes
^^^^^^^^^^^^^^^^
MANIFEST.in
but matched by eitherthe
license_file
(deprecated) orlicense_files
options,will be nevertheless included in the source distribution. - by :user:
cdce8p
Changes
^^^^^^^
cdce8p
License-File
(multiple) to the output package metadata.The field will contain the path of a license file, matched by the
license_file
(deprecated) andlicense_files
options,relative to
.dist-info
. - by :user:cdce8p
more_itertools
for Setuptools.Misc
^^^^
Towncrier and show the previews of not-yet-released setuptools versions
in the changelog -- :user:
webknjaz
v56.2.0
Compare Source
Changes
^^^^^^^
cdce8p
metadata version for
PKG-INFO
. - by :user:cdce8p
v56.1.0
Compare Source
Changes
^^^^^^^
dofuuz
Misc
^^^^
DeprecationWarning
due tothreading.Thread.setDaemon
in tests -- by :user:tirkarthi
with Towncrier >= 19.9 -- :user:
webknjaz
v56.0.0
Compare Source
Deprecations
^^^^^^^^^^^^
license_file
option is now marked as deprecated.Use
license_files
instead. -- by :user:cdce8p
Breaking Changes
^^^^^^^^^^^^^^^^
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 of
bdist_wheel
. -- by :user:cdce8p
Changes
^^^^^^^
license_file
andlicense_files
options now support glob patterns. -- by :user:cdce8p
VendorImporter.find_spec()
method to get ridof
ImportWarning
that Python 3.10 emits when only the old-styleimporter hooks are present -- by :user:
webknjaz
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
license_files
option. -- by :user:cdce8p
v54.2.0
Compare Source
Changes
^^^^^^^
an empty
setup.py
-- by :user:layday
v54.1.3
Compare Source
No significant changes.
v54.1.2
Compare Source
Misc
^^^^
melissa-kun-li
v54.1.1
Compare Source
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
sphinx-inline-tabs
extension to allow for comparison ofsetup.py
and its equivalentsetup.cfg
-- by :user:amy-lei
Misc
^^^^
[metadata]
section ofsetup.cfg
case-sensitive. Users havinguppercase option spellings will get a warning suggesting to make them to lowercase
-- by :user:
melissa-kun-li
v54.1.0
Compare Source
Changes
^^^^^^^
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
Compare Source
Breaking Changes
^^^^^^^^^^^^^^^^
Changes
^^^^^^^
AttributeError
by raising :code:DistutilsSetupError
in :code:dist.check_specifier()
when specifier is not a string -- by :user:melissa-kun-li
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
pwoolvett
v53.1.0
Compare Source
Changes
^^^^^^^
melissa-kun-li
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
Compare Source
Breaking Changes
^^^^^^^^^^^^^^^^
v52.0.0
[Compare Source](https
Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.
🔕 Ignore: Close this PR and you won't be reminded about this update again.