Skip to content

Commit 55205b9

Browse files
committed
Update installation report docs
1 parent a7f70b0 commit 55205b9

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/html/reference/installation-report.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ package with the following properties:
5656
URL reference. `false` if the requirements was provided as a name and version
5757
specifier.
5858

59+
- `is_yanked`: `true` if the requirement was yanked from the index, but was still
60+
selected by pip conform to [PEP 592](https://peps.python.org/pep-0592/#installers).
61+
5962
- `download_info`: Information about the artifact (to be) downloaded for installation,
6063
using the [direct URL data
6164
structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/).
@@ -106,6 +109,7 @@ will produce an output similar to this (metadata abriged for brevity):
106109
}
107110
},
108111
"is_direct": false,
112+
"is_yanked": false,
109113
"requested": true,
110114
"metadata": {
111115
"name": "pydantic",
@@ -133,6 +137,7 @@ will produce an output similar to this (metadata abriged for brevity):
133137
}
134138
},
135139
"is_direct": true,
140+
"is_yanked": false,
136141
"requested": true,
137142
"metadata": {
138143
"name": "packaging",

news/12224.feature.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Add ``is_yanked`` boolean entry to the installation report (``--report``) to indicate whether the requirement was yanked from the index, but still was selected by pip conform PEP 592.
1+
Add ``is_yanked`` boolean entry to the installation report (``--report``) to indicate whether the requirement was yanked from the index, but was still selected by pip conform to PEP 592.

0 commit comments

Comments
 (0)