diff options
| -rw-r--r-- | .bumpversion.cfg | 2 | ||||
| -rw-r--r-- | CHANGES.rst | 69 | ||||
| -rw-r--r-- | changelog.d/3265.breaking.rst | 15 | ||||
| -rw-r--r-- | changelog.d/3380.change.rst | 10 | ||||
| -rw-r--r-- | changelog.d/3380.deprecation.rst | 7 | ||||
| -rw-r--r-- | changelog.d/3392.change.rst | 5 | ||||
| -rw-r--r-- | changelog.d/3412.change.rst | 3 | ||||
| -rw-r--r-- | changelog.d/3414.change.rst | 4 | ||||
| -rw-r--r-- | changelog.d/3414.doc.rst | 2 | ||||
| -rw-r--r-- | changelog.d/3484.change.rst | 6 | ||||
| -rw-r--r-- | setup.cfg | 2 |
11 files changed, 71 insertions, 54 deletions
diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 6662e830..9141b766 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 63.4.3 +current_version = 64.0.0 commit = True tag = True diff --git a/CHANGES.rst b/CHANGES.rst index 1e1ba615..3c42bce3 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,3 +1,72 @@ +v64.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). + + .. 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_FEATURE=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`. + + v63.4.3 ------- diff --git a/changelog.d/3265.breaking.rst b/changelog.d/3265.breaking.rst deleted file mode 100644 index cbd4e3a4..00000000 --- a/changelog.d/3265.breaking.rst +++ /dev/null @@ -1,15 +0,0 @@ -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). - -.. 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. diff --git a/changelog.d/3380.change.rst b/changelog.d/3380.change.rst deleted file mode 100644 index 9622417a..00000000 --- a/changelog.d/3380.change.rst +++ /dev/null @@ -1,10 +0,0 @@ -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. diff --git a/changelog.d/3380.deprecation.rst b/changelog.d/3380.deprecation.rst deleted file mode 100644 index 54d3c4c3..00000000 --- a/changelog.d/3380.deprecation.rst +++ /dev/null @@ -1,7 +0,0 @@ -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. diff --git a/changelog.d/3392.change.rst b/changelog.d/3392.change.rst deleted file mode 100644 index 8ae7fd90..00000000 --- a/changelog.d/3392.change.rst +++ /dev/null @@ -1,5 +0,0 @@ -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. diff --git a/changelog.d/3412.change.rst b/changelog.d/3412.change.rst deleted file mode 100644 index 69f02bc8..00000000 --- a/changelog.d/3412.change.rst +++ /dev/null @@ -1,3 +0,0 @@ -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. diff --git a/changelog.d/3414.change.rst b/changelog.d/3414.change.rst deleted file mode 100644 index b29f2c55..00000000 --- a/changelog.d/3414.change.rst +++ /dev/null @@ -1,4 +0,0 @@ -Users can *temporarily* specify an environment variable -``SETUPTOOLS_ENABLE_FEATURE=legacy-editable`` as a escape hatch for the -:pep:`660` behavior. This setting is **transitional** and may be removed in the -future. diff --git a/changelog.d/3414.doc.rst b/changelog.d/3414.doc.rst deleted file mode 100644 index b4756dae..00000000 --- a/changelog.d/3414.doc.rst +++ /dev/null @@ -1,2 +0,0 @@ -Updated :doc:`Development Mode </userguide/development_mode>` to reflect on the -implementation of :pep:`660`. diff --git a/changelog.d/3484.change.rst b/changelog.d/3484.change.rst deleted file mode 100644 index 3c671cb8..00000000 --- a/changelog.d/3484.change.rst +++ /dev/null @@ -1,6 +0,0 @@ -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``. @@ -1,6 +1,6 @@ [metadata] name = setuptools -version = 63.4.3 +version = 64.0.0 author = Python Packaging Authority author_email = distutils-sig@python.org description = Easily download, build, install, upgrade, and uninstall Python packages |