Skip to content

Commit aeeae15

Browse files
committed
Remove REQUESTED from the spec (with a note)
1 parent de005e5 commit aeeae15

1 file changed

Lines changed: 5 additions & 29 deletions

File tree

source/specifications/recording-installed-packages.rst

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,8 @@ below:
4747
* ``METADATA``: contains project metadata
4848
* ``RECORD``: records the list of installed files.
4949
* ``INSTALLER``: records the name of the tool used to install the project.
50-
* ``REQUESTED``: indicates that the project installation was explicitly
51-
requested (i.e., not installed as a dependency).
5250

5351
The ``METADATA`` file is mandatory.
54-
The ``REQUESTED`` file must be written when applicable
55-
(see the corresponding section).
5652
All other files may be omitted at the installing tool's discretion.
5753
Additional installer-specific files may be present.
5854

@@ -63,6 +59,11 @@ Additional installer-specific files may be present.
6359
Such files may be copied to the ``.dist-info`` directory of an
6460
installed project.
6561

62+
The previous versions of this specification also specified a ``REQUESTED``
63+
file. This file is now considered a tool-specific extension, but may be
64+
standardized again in the future. See `PEP 376 <https://www.python.org/dev/peps/pep-0376/#requested>`_
65+
for its original meaning.
66+
6667

6768
The METADATA file
6869
=================
@@ -170,28 +171,3 @@ This value should be used for informational purposes only.
170171
For example, if a tool is asked to uninstall a project but finds no ``RECORD``
171172
file, it may suggest that the tool named in ``INSTALLER`` may be able to do the
172173
uninstallation.
173-
174-
175-
The REQUESTED file
176-
==================
177-
178-
Some install tools automatically detect unfulfilled dependencies and install
179-
them. In these cases, it is useful to track which distributions were installed
180-
purely as a dependency, so if their dependent distribution is later
181-
uninstalled, the user can be alerted of the orphaned dependency.
182-
183-
If a distribution is installed by direct user request (the usual case), a
184-
file named ``REQUESTED`` must be added to the ``.dist-info`` directory of the
185-
installed distribution.
186-
The ``REQUESTED`` file may be empty, or may contain a marker comment line
187-
beginning with the ``"#"`` character.
188-
189-
If an install tool installs a distribution automatically, as a dependency of
190-
another distribution, the ``REQUESTED`` file should not be created.
191-
192-
If an install tool cannot determine whether installation was requested
193-
by the user, it must default to creating the ``REQUESTED`` file.
194-
195-
If a distribution that was already installed on the system as a dependency
196-
is later installed by name, tools should create the ``REQUESTED`` file in the
197-
``.dist-info`` directory of the existing installation.

0 commit comments

Comments
 (0)