-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
CHANGES.rst
7422 lines (5144 loc) · 223 KB
/
CHANGES.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
v68.0.0
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* #3948: Removed verification for existing ``depends.txt`` file (deprecated since v0.5a4).
* #3948: Remove autofixing of broken ``.egg-info`` directories containing the ``-``
character in their base name (without suffix).
They should no longer be produced by sufficiently new versions of ``setuptools``
(warning introduced in 2005).
* #3948: Remove deprecated APIs in ``easy_install``: ``get_script_args``,
``get_script_header`` and ``get_writer``.
The direct usage of ``easy_install`` has been deprecated since v58.3.0,
and the warnings regarding these APIs predate that version.
* #3948: Removed ``egg_info.get_pkg_info_revision`` (deprecated since 2015).
* #3948: Removed ``setuptools.dist._get_unpatched`` (deprecated since 2016)
* #3948: Removed support for SVN in ``setuptools.package_index`` (deprecated since 2018).
* #3948: Removed support for invalid ``pyproject.toml`` files.
During the implementation of PEP 621, it was identified that some users were
producing invalid files. As a transitional measure, the validation was relaxed
for a few use cases. The grace period, however, came to an end.
Changes
^^^^^^^
* #3760: Added symlink support to launcher for installed executables -- by :user:`eugene-sevostianov-sc`
* #3926: Updated vendored ``packaging`` version from 23.0 to 23.1 -- by :user:`MetRonnie`
* #3950: Implemented workaround for old versions of ``vswhere``, which miss the
``-requiresAny`` parameter, such as the ones distributed together with Visual Studio 2017 < 15.6.
* #3952: Changed ``DistutilsMetaFinder`` to skip ``spec_for_pip`` on Python >= 3.12.
* #3952: Removed ``_distutils_hack.remove_shim`` on Python >= 3.12
(since ``distutils`` was removed from the standard library,
``DistutilsMetaFinder`` cannot be disabled on Python >= 3.12).
Misc
^^^^
* #3920: Add a link to deprecation warning in ``pkg_resources`` and improve
``stacklevel`` for better visibility.
v67.8.0
-------
Changes
^^^^^^^
* #3128: In deprecated easy_install, reload and merge the pth file before saving.
Misc
^^^^
* #3915: Adequate tests to the latest changes in ``virtualenv`` for Python 3.12.
v67.7.2
-------
Misc
^^^^
* #3902: Fixed wrong URLs used in warnings and logs.
v67.7.1
-------
Misc
^^^^
* #3898: Fixes setuptools.dist:invalid_unless_false when value is false don't raise error -- by :user:`jammarher`
v67.7.0
-------
Changes
^^^^^^^
* #3849: Overhaul warning system for better visibility.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* #3859: Added a note about historical presence of ``wheel``
in ``build-system.requires``, in ``pyproject.toml``.
* #3893: Improved the documentation example regarding making a thin :pep:`517` in-tree
backend wrapper of ``setuptools.build_meta`` that is future-proof and supports
:pep:`660` hook too -- by :user:`webknjaz`.
Misc
^^^^
* #3884: Add a ``stacklevel`` parameter to ``warnings.warn()`` to provide more information to the user.
-- by :user:`cclauss`
v67.6.1
-------
Misc
^^^^
* #3865: Fixed ``_WouldIgnoreField`` warnings for ``scripts`` and ``gui_scripts``,
when ``entry-points`` is not listed in dynamic.
* #3875: Update code generated by ``validate-pyproject`` to use v0.12.2.
This should fix default license patterns when ``pyproject.toml`` is used.
v67.6.0
-------
Changes
^^^^^^^
* #3804: Added caching for supported wheel tags.
* #3846: Added pruning heuristics to ``PackageFinder`` based on ``exclude``.
v67.5.1
-------
Misc
^^^^
* #3836: Fixed interaction between ``setuptools``' package auto-discovery and
auto-generated ``htmlcov`` files.
Previously, the ``htmlcov`` name was ignored when searching for single-file
modules, however the correct behaviour is to ignore it when searching for
packages (since it is supposed to be a directory, see `coverage config`_)
-- by :user:`yukihiko-shinoda`.
.. _coverage config: https://coverage.readthedocs.io/en/stable/config.html#html-directory
* #3838: Improved error messages for ``pyproject.toml`` validations.
* #3839: Fixed ``pkg_resources`` errors caused when parsing metadata of packages that
are already installed but do not conform with PEP 440.
v67.5.0
-------
Changes
^^^^^^^
* #3843: Although pkg_resources has been discouraged for use, some projects still consider pkg_resources viable for usage. This change makes it clear that pkg_resources should not be used, emitting a DeprecationWarning when imported.
v67.4.0
-------
Changes
^^^^^^^
* #3832: Update vendored ``importlib-metadata`` (to 6.0.0) and
``importlib-resources`` (to 5.10.2)
v67.3.3
-------
Misc
^^^^
* #3820: Restore quoted ``#include`` argument to ``has_function``.
v67.3.2
-------
Misc
^^^^
* #3827: Improve deprecation warning message on ``pkg_resources.declare_namespace``
to display package name.
v67.3.1
-------
Misc
^^^^
* #3823: Fixes ``egg_info`` code path triggered during integration with ``pip``.
v67.3.0
-------
Deprecations
^^^^^^^^^^^^
* #3434: Added deprecation warning for ``pkg_resources.declare_namespace``.
Users that wish to implement namespace packages, are recommended to follow the
practice described in PEP 420 and omit the ``__init__.py`` file entirely.
Changes
^^^^^^^
* #3792: Reduced usage of ``pkg_resources`` in ``setuptools`` via internal
restructuring and refactoring.
Misc
^^^^
* #3822: Added debugging tips for "editable mode" and update related docs.
Instead of using a custom exception to display the help message to the user,
``setuptools`` will now use a warning and re-raise the original exception.
* #3822: Added clarification about ``editable_wheel`` and ``dist_info`` CLI commands:
they should not be called directly with ``python setup.py ...``.
Instead they are reserved for internal use of ``setuptools`` (effectively as "private" commands).
Users are recommended to rely on build backend APIs (:pep:`517` and :pep:`660`)
exposed by ``setuptools.build_meta``.
v67.2.0
-------
Changes
^^^^^^^
* #3809: Merge with distutils@8c3c3d29, including fix for ``sysconfig.get_python_inc()`` (pypa/distutils#178), fix for segfault on MinGW (pypa/distutils#196), and better ``has_function`` support (pypa/distutils#195, #3648).
v67.1.0
-------
Changes
^^^^^^^
* #3795: Ensured that ``__file__`` is an absolute path when executing ``setup.py`` as
part of ``setuptools.build_meta``.
Misc
^^^^
* #3798: Updated validations for ``pyproject.toml`` using ``validate-pyproject==0.12.1``
to allow stub packages (:pep:`561`) to be listed in ``tool.setuptools.packages``
and ``tool.setuptools.package-dir``.
v67.0.0
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* #3741: Removed patching of ``distutils._msvccompiler.gen_lib_options``
for compatibility with Numpy < 1.11.2 -- by :user:`mgorny`
* #3790: Bump vendored version of :pypi:`packaging` to 23.0
(:pypi:`pyparsing` is no longer required and was removed).
As a consequence, users will experience a more strict parsing of requirements.
Specifications that don't comply with :pep:`440` and :pep:`508` will result
in build errors.
v66.1.1
-------
Misc
^^^^
* #3782: Fixed problem with ``file`` directive in ``tool.setuptools.dynamic``
(``pyproject.toml``) when value is a simple string instead of list.
v66.1.0
-------
Changes
^^^^^^^
* #3685: Fix improper usage of deprecated/removed ``pkgutil`` APIs in Python 3.12+.
* #3779: Files referenced by ``file:`` in ``setup.cfg`` and by ``project.readme.file``,
``project.license.file`` or ``tool.setuptools.dynamic.*.file`` in
``pyproject.toml`` are now automatically included in the generated sdists.
Misc
^^^^
* #3776: Added note about using the ``--pep-517`` flag with ``pip`` to workaround
``InvalidVersion`` errors for packages that are already installed in the system.
v66.0.0
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* #2497: Support for PEP 440 non-conforming versions has been removed. Environments containing packages with non-conforming versions may fail or the packages may not be recognized.
Changes
^^^^^^^
* #3769: Replace 'appdirs' with 'platformdirs'.
v65.7.0
-------
Changes
^^^^^^^
* #3594: Added ``htmlcov`` to FlatLayoutModuleFinder.DEFAULT_EXCLUDE -- by :user:`demianbrecht`
* #3667: Added a human-readable error description when ``.egg-info`` directory is not writeable -- by :user:`droodev`
Misc
^^^^
* #3713: Fixed incomplete ``getattr`` statement that caused problems when accessing
undefined attribute.
v65.6.3
-------
Misc
^^^^
* #3709: Fix condition to patch ``distutils.dist.log`` to only apply when using
``distutils`` from the stdlib.
v65.6.2
-------
No significant changes.
v65.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/distutils@3e9d47e 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.
v65.6.0
-------
Changes
^^^^^^^
* #3674: Sync with pypa/distutils@e0787fa, including pypa/distutils#183 updating distutils to use the Python logging framework.
v65.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.
v65.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``.
v65.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/distutils@6852b20 including fix for pypa/distutils#181.
v65.4.0
-------
Changes
^^^^^^^
* #3609: Merge with pypa/distutils@d82d926 including support for DIST_EXTRA_CONFIG in pypa/distutils#177.
v65.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.
v65.2.0
-------
Changes
^^^^^^^
* #3553: Sync with pypa/distutils@22b9bcf, including fixed cross-compiling support and removing deprecation warning per pypa/distutils#169.
v65.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.
v65.1.0
-------
Changes
^^^^^^^
* #3536: Remove monkeypatching of msvc9compiler.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* #3538: Corrected documentation on how to use the ``legacy-editable`` mode.
v65.0.2
-------
Misc
^^^^
* #3505: Restored distutils msvccompiler and msvc9compiler modules and marked as deprecated (pypa/distutils@c802880).
v65.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 ``"."``.
v65.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.
v64.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``.
v64.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.
v64.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).
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).
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`.
v63.4.3
-------
Misc
^^^^
* #3496: Update to pypa/distutils@b65aa40 including more robust support for library/include dir handling in msvccompiler (pypa/distutils#153) and test suite improvements.
v63.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.
v63.4.1
-------
Misc
^^^^
* #3482: Sync with pypa/distutils@274758f1c02048d295efdbc13d2f88d9923547f8, restoring compatibility shim in bdist.format_commands.
v63.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/distutils@c397f4c
v63.3.0
-------
Changes
^^^^^^^
* #3475: Merge with pypa/distutils@129480b, including substantial delinting and cleanup, some refactoring around compiler logic, better messaging in cygwincompiler (pypa/distutils#161).
v63.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/distutils#158).
v63.1.0
-------
Changes
^^^^^^^
* #3430: Merge with pypa/distutils@152c13d including pypa/distutils#155 (improved compatibility for editable installs on homebrew Python 3.9), pypa/distutils#150 (better handling of runtime_library_dirs on cygwin), and pypa/distutils#151 (remove warnings for namespace packages).
v63.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`
v62.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`
v62.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.
v62.4.0
-------
Changes
^^^^^^^
* #3256: Added setuptools.command.build command to match distutils.command.build -- by :user:`isuruf`
* #3366: Merge with pypa/distutils@75ed79d including reformat using black, fix for Cygwin support (pypa/distutils#139), and improved support for cross compiling (pypa/distutils#144 and pypa/distutils#145).
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).
v62.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.
v62.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`
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 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``.
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 testing ``setuptools.config``.
v62.1.0
-------
Changes
^^^^^^^
* #3258: Merge pypa/distutils@5229dad46b.
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 in ``pyproject.toml``
from being dynamically specified in ``setup.py``.
v61.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.
v61.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``.
v61.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/distutils@e1d5c9b1f6
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``.