-
Notifications
You must be signed in to change notification settings - Fork 349
Expand file tree
/
Copy pathpiptree.py
More file actions
297 lines (272 loc) · 14.8 KB
/
piptree.py
File metadata and controls
297 lines (272 loc) · 14.8 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
291
292
293
294
295
296
# -*- coding: utf-8 -*-
# require python 3.8+ because of importlib.metadata
import json, sys, re, platform, os, sysconfig
import re
from collections import OrderedDict
from pip._vendor.packaging.markers import Marker
from importlib.metadata import Distribution , distributions
from pathlib import Path
import configparser as cp
def normalize(this):
"""apply https://peps.python.org/pep-0503/#normalized-names"""
return re.sub(r"[-_.]+", "-", this).lower()
def sum_up(this, max_length=144, stop_at=". "):
"""Keep only 1 line of max_length characters at most"""
sumup = (this + os.linesep).splitlines()[0]
if len(sumup) > max_length and len(stop_at)>1:
sumup = (sumup + stop_at ).split(stop_at)[0]
if len(sumup) > max_length:
sumup = sumup[:max_length]
return sumup
class pipdata:
"""Wrapper around Distribution.discover() or Distribution.distributions()"""
def __init__(self, Target=None):
# create a distro{} dict of Packages
# key = normalised package name
# string_elements = 'name', 'version', 'summary'
# requires = list of dict with 1 level need downward
# req_key = package_key requires
# req_extra = extra branch needed of the package_key ('all' or '')
# req_version = version needed
# req_marker = marker of the requirement (if any)
# on current Python, use from importlib.metadata + Distribution.Discover() for 2x speed-up
# on other Python, use importlib.metadata + distributions(path=[str(Path(Target).parent /'lib'/'site-packages'),])
self.distro = {}
self.raw = {}
replacements = str.maketrans({" ": "", "[": "", "]": "", "'": "", '"': ""})
self.environment = {
"implementation_name": sys.implementation.name,
"implementation_version": "{0.major}.{0.minor}.{0.micro}".format(
sys.implementation.version
),
"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,
}
if Target == None:
Target = sys.executable
if sys.executable==Target:
# self-Distro inspection case (use all packages reachable per sys.path I presume )
pip_json_installed=Distribution.discover()
else:
# not self-Distro inspection case , look at site-packages only)
pip_json_installed=distributions(path=[str(Path(Target).parent /'lib'/'site-packages'),])
for p in pip_json_installed:
meta = p.metadata
name = p.metadata['Name'] # p.name is not ok in 3.8
version = p.version
key = normalize(name)
requires = []
provides = {'':None}
provided = {'':None}
self.raw[key] = meta
if p.requires:
for i in p.requires:
det = (i + ";").split(";")
# req_nameextra is "python-jose[cryptography]"
# from fastapi "python-jose[cryptography]<4.0.0,>=3.3.0
# req_nameextra is "google-cloud-storage"
# from "google-cloud-storage (<2.0.0,>=1.26.0)
req_nameextra = re.split(" |;|==|!|>|<", det[0] + ";")[0]
req_nameextra = normalize(req_nameextra)
req_key = normalize((req_nameextra + "[").split("[")[0])
req_key_extra = req_nameextra[len(req_key) + 1 :].split("]")[0]
req_version = det[0][len(req_nameextra) :].translate(replacements)
req_marker = det[1]
if 'extra == ' in req_marker:
remove_list = {ord("'"):None, ord('"'):None}
provides[req_marker.split('extra == ')[1].translate(remove_list)] = None
req_add = {
"req_key": req_key,
"req_version": req_version,
"req_extra": req_key_extra,
}
# add the marker of the requirement, if not nothing:
if not req_marker == "":
req_add["req_marker"] = req_marker
requires += [req_add]
self.distro[key] = {
"name": name,
"version": p.version,
"summary": meta["Summary"] if "Summary" in meta else "",
"requires_dist": requires,
"wanted_per": [],
"description": meta["Description"] if "Description" in meta else "",
"provides": provides, # extras of the package: 'array' for dask because dask['array'] defines some extra
"provided": provided, # extras from other package: 'test' for pytest because dask['test'] wants pytest
}
# On a second pass, complement distro in reverse mode with 'wanted-per':
# - get all downward links in 'requires_dist' of each package
# - feed the required packages 'wanted_per' as a reverse dict of dict
# contains =
# req_key = upstream package_key
# req_version = downstream package version wanted
# req_marker = marker of the downstream package requirement (if any)
for p in self.distro:
for r in self.distro[p]["requires_dist"]:
if r["req_key"] in self.distro:
want_add = {
"req_key": p, # p is a string
"req_version": r["req_version"],
"req_extra": r["req_extra"],
} # req_key_extra
# provided = extras in upper packages that triggers the need for this package,
# like 'pandas[test]->Pytest', so 'test' in distro['pytest']['provided']['test']
# corner-cases: 'dask[dataframe]' -> dask[array]'
# 'dask-image ->dask[array]
if "req_marker" in r:
want_add["req_marker"] = r["req_marker"] # req_key_extra
if 'extra == ' in r["req_marker"]:
remove_list = {ord("'"):None, ord('"'):None}
self.distro[r["req_key"]]["provided"][r["req_marker"].split('extra == ')[1].translate(remove_list)] = None
self.distro[r["req_key"]]["wanted_per"] += [want_add]
def _downraw(self, pp, extra="", version_req="", depth=20, path=[], verbose=False):
"""build a nested list of needed packages with given extra and depth"""
envi = {"extra": extra, **self.environment}
p = normalize(pp)
# several extras request management: example dask[array,diagnostics]
extras = extra.split(",")
ret_all = []
if p+"["+extra+"]" in path: # for dask[complete]->dask[array,test,..]
print("cycle!", "->".join(path + [p+"["+extra+"]"]))
elif p in self.distro and len(path) <= depth:
for extra in extras: # several extras request management
envi = {"extra": extra, **self.environment}
summary = f' {self.distro[p]["summary"]}' if verbose else ''
if extra == "":
ret = [f'{p}=={self.distro[p]["version"]} {version_req}{summary}']
else:
ret = [f'{p}[{extra}]=={self.distro[p]["version"]} {version_req}{summary}']
for r in self.distro[p]["requires_dist"]:
if r["req_key"] in self.distro:
if "req_marker" not in r or Marker(r["req_marker"]).evaluate(
environment=envi
):
ret += self._downraw(
r["req_key"],
r["req_extra"],
r["req_version"],
depth,
path + [p+"["+extra+"]"],
verbose=verbose,
)
ret_all += [ret]
return ret_all
def _upraw(self, pp, extra="", version_req="", depth=20, path=[], verbose=False):
"""build a nested list of user packages with given extra and depth
from direct dependancies like dask-image <--dask['array']
or indirect like Pytest['test'] <-- pandas['test']"""
remove_list = {ord("'"):None, ord('"'):None} # to clean-up req_extra
envi = {"extra": extra, **self.environment}
p = normalize(pp)
pe = normalize(f'{pp}[{extra}]')
ret_all = []
if pe in path:
print("cycle!", "->".join(path + [pe]))
elif p in self.distro and len(path) <= depth:
summary = f' {self.distro[p]["summary"]}' if verbose else ''
if extra == "":
ret_all = [f'{p}=={self.distro[p]["version"]} {version_req}{summary}']
elif extra in set(self.distro[p]["provided"]).union(set(self.distro[p]["provides"])): # so that -r pytest[test] gives
ret_all = [f'{p}[{extra}]=={self.distro[p]["version"]} {version_req}{summary}']
else:
return []
ret = []
for r in self.distro[p]["wanted_per"]:
up_req = (r["req_marker"].split('extra == ')+[""])[1].translate(remove_list) if "req_marker" in r else ""
if r["req_key"] in self.distro and r["req_key"]+"["+up_req+"]" not in path: # avoids circular links on dask[array]
# 2024-06-30 example of langchain <- numpy. pip.distro['numpy']['wanted_per'] has:
# {'req_key': 'langchain', 'req_version': '(>=1,<2)', 'req_extra': '', 'req_marker': ' python_version < "3.12"'},
# {'req_key': 'langchain', 'req_version': '(>=1.26.0,<2.0.0)', 'req_extra': '', 'req_marker': ' python_version >= "3.12"'}
# must be no extra dependancy, optionnal extra in the package, or provided extra per upper packages
if ("req_marker" not in r and extra =="") or (extra !="" and extra==up_req and r["req_key"]!=p) or (extra !="" and "req_marker" in r and extra+',' in r["req_extra"]+',' #bingo1346 contourpy[test-no-images]
or "req_marker" in r and extra+',' in r["req_extra"]+',' and Marker(r["req_marker"]).evaluate(environment=envi)
):
ret += self._upraw(
r["req_key"],
up_req, # pydask[array] going upwards will look for pydask[dataframe]
f"[requires: {p}"
+ (
"[" + r["req_extra"] + "]"
if r["req_extra"] != ""
else ""
)
+ f'{r["req_version"]}]',
depth,
path + [pe],
verbose=verbose,
)
if not ret == []:
ret_all += [ret]
return ret_all
def down(self, pp="", extra="", depth=99, indent=5, version_req="", verbose=False):
"""print the downward requirements for the package or all packages"""
if not pp == ".":
if not extra == ".":
if pp in self.distro:
extras = [s for s in extra.split(',') if s in sorted(self.distro[pp]["provides"])]
if extras == []: return ''
rawtext = json.dumps(
self._downraw(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('"', ""))
else:
if pp in self.distro:
r = []
for one_extra in sorted(self.distro[pp]["provides"]):
s = self.down(pp, one_extra, depth, indent, version_req, verbose=verbose)
if s != '': r += [s]
#print(r)
return '\n'.join([i for i in r if i!= ''])
else:
r = []
for one_pp in sorted(self.distro):
s = self.down(one_pp, extra, depth, indent, version_req, verbose=verbose)
if s != '': r += [s]
return '\n'.join([i for i in r if i!= ''])
def up(self, pp, extra="", depth=99, indent=5, version_req="", verbose=False):
"""print the upward needs for the package"""
r = []
if not pp == ".":
if not extra == ".":
s = self._upraw(pp, extra, version_req, depth, verbose=verbose)
if s == []: return ''
rawtext = json.dumps(self._upraw(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(i for i in lines if i!= '').replace('"', "") )
else:
if pp in self.distro:
r = []
for one_extra in sorted(set(self.distro[pp]["provided"]).union(set(self.distro[pp]["provides"]))): #direct and from-upward tags
s = self.up(pp, one_extra, depth, indent, version_req, verbose=verbose)
if s != '': r += [s]
return '\n'.join([i for i in r if i!= ''])
else:
for one_pp in sorted(self.distro):
s = self.up(one_pp, extra, depth, indent, version_req, verbose=verbose)
if s != []: r += [s]
if r !=[]:
return '\n'.join([i for i in r if i!= ''])
else:
return
def description(self, pp):
"return description of the package"
if pp in self.distro:
return print("\n".join(self.distro[pp]["description"].split(r"\n")))
def summary(self, pp):
"return summary of the package"
if pp in self.distro:
return self.distro[pp]["summary"]
def pip_list(self, full=False, max_length=144):
"""do like pip list"""
if full:
return [(p, self.distro[p]["version"], sum_up(self.distro[p]["summary"]), max_length) for p in sorted(self.distro)]
else:
return [(p, sum_up(self.distro[p]["version"], max_length)) for p in sorted(self.distro)]