Skip to content

Commit 226afc2

Browse files
authored
Merge pull request #1673 from konstin/konsti/scripts-are-files
Clarify that the scripts directory is for files only
2 parents 7576f94 + 40842ab commit 226afc2

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

source/specifications/binary-distribution-format.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ its version, e.g. ``1.0.0``, consist of:
189189
#. Python scripts must appear in ``scripts`` and begin with exactly
190190
``b'#!python'`` in order to enjoy script wrapper generation and
191191
``#!python`` rewriting at install time. They may have any or no
192-
extension.
192+
extension. The ``scripts`` directory may only contain regular files.
193193
#. ``{distribution}-{version}.dist-info/METADATA`` is Metadata version 1.1
194194
or greater format metadata.
195195
#. ``{distribution}-{version}.dist-info/WHEEL`` is metadata about the archive
@@ -423,6 +423,10 @@ History
423423
- February 2013: This specification was approved through :pep:`427`.
424424
- February 2021: The rules on escaping in wheel filenames were revised, to bring
425425
them into line with what popular tools actually do.
426+
- December 2024: Clarified that the ``scripts`` folder should only contain
427+
regular files (the expected behaviour of consuming tools when encountering
428+
symlinks or subdirectories in this folder is not formally defined, and hence
429+
may vary between tools).
426430

427431

428432
Appendix

0 commit comments

Comments
 (0)