Skip to content

Sort Requires and Required-By fields for pip show #10422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 21, 2021
Merged

Sort Requires and Required-By fields for pip show #10422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
42d4d04
Sort Requires and Required-By fields for pip show
aphedges Sep 2, 2021
75f6383
Replace lambda with str.lower
aphedges Sep 3, 2021
0e9aad5
Make _get_requiring_packages() return an Iterator
aphedges Sep 3, 2021
3d72678
Switch news file to feature
aphedges Sep 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/10422.feature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
``pip show`` now sorts ``Requires`` and ``Required-By`` alphabetically.
13 changes: 8 additions & 5 deletions src/pip/_internal/commands/show.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ def search_packages_info(query: List[str]) -> Iterator[_PackageInfo]:
if missing:
logger.warning("Package(s) not found: %s", ", ".join(missing))

def _get_requiring_packages(current_dist: BaseDistribution) -> List[str]:
return [
def _get_requiring_packages(current_dist: BaseDistribution) -> Iterator[str]:
return (
dist.metadata["Name"] or "UNKNOWN"
for dist in installed.values()
if current_dist.canonical_name
in {canonicalize_name(d.name) for d in dist.iter_dependencies()}
]
)

def _files_from_record(dist: BaseDistribution) -> Optional[Iterator[str]]:
try:
Expand Down Expand Up @@ -155,6 +155,9 @@ def _files_from_legacy(dist: BaseDistribution) -> Optional[Iterator[str]]:
except KeyError:
continue

requires = sorted((req.name for req in dist.iter_dependencies()), key=str.lower)
required_by = sorted(_get_requiring_packages(dist), key=str.lower)

try:
entry_points_text = dist.read_text("entry_points.txt")
entry_points = entry_points_text.splitlines(keepends=False)
Expand All @@ -173,8 +176,8 @@ def _files_from_legacy(dist: BaseDistribution) -> Optional[Iterator[str]]:
name=dist.raw_name,
version=str(dist.version),
location=dist.location or "",
requires=[req.name for req in dist.iter_dependencies()],
required_by=_get_requiring_packages(dist),
requires=requires,
required_by=required_by,
installer=dist.installer,
metadata_version=dist.metadata_version or "",
classifiers=metadata.get_all("Classifier", []),
Expand Down