forked from winpython/winpython
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpiptree.py
More file actions
290 lines (256 loc) · 14.5 KB
/
piptree.py
File metadata and controls
290 lines (256 loc) · 14.5 KB
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
# -*- coding: utf-8 -*-
"""
piptree.py: inspect and display Python package dependencies,
supporting both downward and upward dependency trees.
Requires Python 3.8+ due to importlib.metadata.
"""
import json
import sys
import re
import platform
import os
import logging
from functools import lru_cache
from collections import OrderedDict
from typing import Dict, List, Optional, Tuple, Union
from pip._vendor.packaging.markers import Marker
from importlib.metadata import Distribution, distributions
from pathlib import Path
from . import utils
from . import packagemetadata as pm
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)
class PipDataError(Exception):
"""Custom exception for PipData related errors."""
pass
class PipData:
"""Manages package metadata and dependency relationships in a Python environment."""
def __init__(self, target: Optional[str] = None, wheelhouse = None):
"""
Initialize the PipData instance.
:param target: Optional target path to search for packages
"""
self.distro: Dict[str, Dict] = {}
self.raw: Dict[str, Dict] = {}
self.environment = self._get_environment()
try:
packages = self._get_packages(target or sys.executable, wheelhouse)
self._process_packages(packages)
self._populate_reverse_dependencies()
except Exception as e:
raise PipDataError(f"Failed to initialize package data: {str(e)}") from e
@staticmethod
@lru_cache(maxsize=None)
def normalize(name: str) -> str:
"""Normalize package name per PEP 503."""
return re.sub(r"[-_.]+", "-", name).lower()
def _get_environment(self) -> Dict[str, str]:
"""Collect system and Python environment details."""
return {
"implementation_name": sys.implementation.name,
"implementation_version": f"{sys.implementation.version.major}.{sys.implementation.version.minor}.{sys.implementation.version.micro}",
"os_name": os.name,
"platform_machine": platform.machine(),
"platform_release": platform.release(),
"platform_system": platform.system(),
"platform_version": platform.version(),
"python_full_version": platform.python_version(),
"platform_python_implementation": platform.python_implementation(),
"python_version": ".".join(platform.python_version_tuple()[:2]),
"sys_platform": sys.platform,
}
def _get_packages(self, search_path: str, wheelhouse) -> List[Distribution]:
"""Retrieve installed packages from the specified path."""
if wheelhouse:
return pm.get_directory_metadata(wheelhouse)
if sys.executable == search_path:
return pm.get_installed_metadata() #Distribution.discover()
else:
return pm.get_installed_metadata(path=[str(Path(search_path).parent / 'lib' / 'site-packages')]) #distributions(path=[str(Path(search_path).parent / 'lib' / 'site-packages')])
def _process_packages(self, packages: List[Distribution]) -> None:
"""Process packages metadata and store them in the distro dictionary."""
for package in packages:
try:
meta = package.metadata
name = meta.get('Name')
if not name:
continue
key = self.normalize(name)
self.raw[key] = meta
self.distro[key] = {
"name": name,
"version": package.version,
"summary": meta.get("Summary", ""),
"requires_dist": self._get_requires(package),
"reverse_dependencies": [],
"description": meta.get("Description", ""),
"provides": self._get_provides(package),
"provided": {'': None} # Placeholder for extras provided by this package
}
except Exception as e:
logger.warning(f"Failed to process package {name}: {str(e)}", exc_info=True)
def _get_requires(self, package: Distribution) -> List[Dict[str, str]]:
"""Extract and normalize requirements for a package."""
requires = []
replacements = str.maketrans({" ": " ", "[": "", "]": "", "'": "", '"': ""})
further_replacements = [
(' == ', '=='), ('= ', '='), (' !=', '!='), (' ~=', '~='),
(' <', '<'), ('< ', '<'), (' >', '>'), ('> ', '>'),
('; ', ';'), (' ;', ';'), ('( ', '('),
(' and (', ' andZZZZZ('), (' (', '('), (' andZZZZZ(', ' and (')
]
if package.requires:
for req in package.requires:
req_nameextra, req_marker = (req + ";").split(";")[:2]
req_nameextra = self.normalize(re.split(r" |;|==|!|>|<|~=", req_nameextra + ";")[0])
req_key = self.normalize((req_nameextra + "[").split("[")[0])
req_key_extra = req_nameextra[len(req_key) + 1:].split("]")[0]
req_version = req[len(req_nameextra):].translate(replacements)
for old, new in further_replacements:
req_version = req_version.replace(old, new)
req_add = {
"req_key": req_key,
"req_version": req_version,
"req_extra": req_key_extra,
}
if req_marker != "":
req_add["req_marker"] = req_marker
requires.append(req_add)
return requires
def _get_provides(self, package: Distribution) -> Dict[str, None]:
"""Extract provided extras from package requirements."""
provides = {'': None}
if package.requires:
for req in package.requires:
req_marker = (req + ";").split(";")[1]
if 'extra == ' in req_marker:
remove_list = {ord("'"): None, ord('"'): None}
provides[req_marker.split('extra == ')[1].translate(remove_list)] = None
return provides
def _populate_reverse_dependencies(self) -> None:
"""Populate reverse dependencies."""
for pkg_key, pkg_data in self.distro.items():
for req in pkg_data["requires_dist"]:
target_key = req["req_key"]
if target_key in self.distro:
rev_dep = {"req_key": pkg_key, "req_version": req["req_version"], "req_extra": req["req_extra"]}
if "req_marker" in req:
rev_dep["req_marker"] = req["req_marker"]
if 'extra == ' in req["req_marker"]:
remove_list = {ord("'"): None, ord('"'): None}
self.distro[target_key]["provided"][req["req_marker"].split('extra == ')[1].translate(remove_list)] = None
self.distro[target_key]["reverse_dependencies"].append(rev_dep)
def _get_dependency_tree(self, package_name: str, extra: str = "", version_req: str = "", depth: int = 20, path: Optional[List[str]] = None, verbose: bool = False, upward: bool = False) -> List[List[str]]:
"""Recursive function to build dependency tree."""
path = path or []
extras = extra.split(",")
pkg_key = self.normalize(package_name)
ret_all = []
full_name = f"{package_name}[{extra}]" if extra else package_name
if full_name in path:
logger.warning(f"Cycle detected: {' -> '.join(path + [full_name])}")
return []
pkg_data = self.distro[pkg_key]
if pkg_data and len(path) <= depth:
for extra in extras:
environment = {"extra": extra, **self.environment}
summary = f' {pkg_data["summary"]}' if verbose else ''
base_name = f'{package_name}[{extra}]' if extra else package_name
ret = [f'{base_name}=={pkg_data["version"]} {version_req}{summary}']
dependencies = pkg_data["requires_dist"] if not upward else pkg_data["reverse_dependencies"]
for dependency in dependencies:
if dependency["req_key"] in self.distro:
next_path = path + [base_name]
if upward:
up_req = (dependency.get("req_marker", "").split('extra == ')+[""])[1].strip("'\"")
if dependency["req_key"] in self.distro and dependency["req_key"]+"["+up_req+"]" not in path:
# upward dependancy taken if:
# - if extra "" demanded, and no marker from upward package: like pandas[] ==> numpy
# - or the extra is in the upward package, like pandas[test] ==> pytest, for 'test' extra
# - or an extra "array" is demanded, and indeed in the req_extra list: array,dataframe,diagnostics,distributer
if (not dependency.get("req_marker") and extra == "") or \
("req_marker" in dependency and extra == up_req and \
dependency["req_key"] != pkg_key and \
Marker(dependency["req_marker"]).evaluate(environment=environment)) or \
("req_marker" in dependency and extra != "" and \
extra + ',' in dependency["req_extra"] + ',' and \
Marker(dependency["req_marker"]).evaluate(environment=environment | {"extra": up_req})):
# IA risk error: # dask[array] go upwards as dask[dataframe], so {"extra": up_req} , not {"extra": extra}
#tag downward limiting dependancies
wall = " " if dependency["req_version"][:1] == "~" or dependency["req_version"].startswith("==") or "<" in dependency["req_version"] else ""
ret += self._get_dependency_tree(
dependency["req_key"],
up_req,
f"[requires{wall}: {package_name}"
+ (f"[{dependency['req_extra']}]" if dependency["req_extra"] != "" else "")
+ f'{dependency["req_version"]}]',
depth,
next_path,
verbose=verbose,
upward=upward,
)
elif not dependency.get("req_marker") or Marker(dependency["req_marker"]).evaluate(environment=environment):
ret += self._get_dependency_tree(
dependency["req_key"],
dependency["req_extra"],
dependency["req_version"],
depth,
next_path,
verbose=verbose,
upward=upward,
)
ret_all.append(ret)
return ret_all
def down(self, pp: str = "", extra: str = "", depth: int = 20, indent: int = 5, version_req: str = "", verbose: bool = False) -> str:
"""Generate downward dependency tree as formatted string."""
if pp == ".":
results = [self.down(p, extra, depth, indent, version_req, verbose=verbose) for p in sorted(self.distro)]
return '\n'.join(filter(None, results))
if extra == ".":
if pp in self.distro:
results = [self.down(pp, one_extra, depth, indent, version_req, verbose=verbose)
for one_extra in sorted(self.distro[pp]["provides"])]
return '\n'.join(filter(None, results))
return ""
if pp not in self.distro:
return ""
rawtext = json.dumps(self._get_dependency_tree(pp, extra, version_req, depth, verbose=verbose), indent=indent)
lines = [l for l in rawtext.split("\n") if len(l.strip()) > 2]
return "\n".join(lines).replace('"', "")
def up(self, ppw: str, extra: str = "", depth: int = 20, indent: int = 5, version_req: str = "", verbose: bool = False) -> str:
"""Generate upward dependency tree as formatted string."""
pp = ppw[:-1] if ppw.endswith('!') else ppw
ppend = "!" if ppw.endswith('!') else "" #show only downward limiting dependancies
if pp == ".":
results = [aa for p in sorted(self.distro) if '[requires' in (aa:=self.up(p + ppend, extra, depth, indent, version_req, verbose))]
return '\n'.join(filter(None, results))
if extra == ".":
if pp in self.distro:
extras = set(self.distro[pp]["provided"]).union(set(self.distro[pp]["provides"]))
results = [self.up(pp + ppend, e, depth, indent, version_req, verbose=verbose) for e in sorted(extras)]
return '\n'.join(filter(None, results))
return ""
if pp not in self.distro:
return ""
rawtext = json.dumps(self._get_dependency_tree(pp, extra, version_req, depth, verbose=verbose, upward=True), indent=indent)
lines = [l for l in rawtext.split("\n") if len(l.strip()) > 2 and ( ppend=="" or not "[requires:" in l)]
return "\n".join(filter(None, lines)).replace('"', "").replace('[requires :', '[requires:')
def description(self, pp: str) -> None:
"""Return package description or None if not found."""
if pp in self.distro:
return print("\n".join(self.distro[pp]["description"].split(r"\n")))
def summary(self, pp: str) -> str:
"""Return package summary or empty string if not found."""
if pp in self.distro:
return self.distro[pp]["summary"]
return ""
def pip_list(self, full: bool = False, max_length: int = 144) -> List[Tuple[str, Union[str, Tuple[str, str]]]]:
"""List installed packages with optional details.
:param full: Whether to include the package version and summary
:param max_length: The maximum length for the summary
:return: List of tuples containing package information
"""
pkgs = sorted(self.distro.items())
if full:
return [(p, d["version"], utils.sum_up(d["summary"], max_length)) for p, d in pkgs]
return [(p, d["version"]) for p, d in pkgs]