-
Notifications
You must be signed in to change notification settings - Fork 11
/
report.py
585 lines (474 loc) · 18 KB
/
report.py
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
"""The main module containing the `Report` class."""
import importlib
from importlib.metadata import PackageNotFoundError, distribution, version as importlib_version
import sys
import time
from types import ModuleType
from typing import Any, Dict, List, Literal, Optional, Tuple, Union, cast
from .knowledge import (
PACKAGE_ALIASES,
VERSION_ATTRIBUTES,
VERSION_METHODS,
get_filesystem_type,
in_ipykernel,
in_ipython,
)
MODULE_NOT_FOUND = 'Module not found'
MODULE_TROUBLE = 'Trouble importing'
VERSION_NOT_FOUND = 'Version unknown'
# Info classes
class PlatformInfo:
"""Internal helper class to access details about the computer platform."""
def __init__(self):
"""Initialize."""
self._mkl_info: Optional[str] # for typing purpose
self._filesystem: Union[str, Literal[False]]
@property
def system(self) -> str:
"""Return the system/OS name.
E.g. ``'Linux (name version)'``, ``'Windows'``, or ``'Darwin'``. An empty string is
returned if the value cannot be determined.
"""
s = platform().system()
if s == 'Linux':
try:
s += (
f' ({platform().freedesktop_os_release()["NAME"]} '
+ f'{platform().freedesktop_os_release()["VERSION_ID"]})'
)
except Exception:
pass
elif s == 'Windows':
try:
release, version, csd, ptype = platform().win32_ver()
s += f' ({release} {version} {csd} {ptype})'
except Exception:
pass
elif s == 'Darwin':
try:
release, _, _ = platform().mac_ver()
s += f' (macOS {release})'
except Exception:
pass
elif s == 'Java':
# TODO: parse platform().java_ver()
pass
return s
@property
def platform(self) -> str:
"""Return the platform."""
return platform().platform()
@property
def machine(self) -> str:
"""Return the machine type, e.g. 'i386'.
An empty string is returned if the value cannot be determined.
"""
return platform().machine()
@property
def architecture(self) -> str:
"""Return the bit architecture used for the executable."""
return platform().architecture()[0]
@property
def cpu_count(self) -> int:
"""Return the number of CPUs in the system."""
if not hasattr(self, '_cpu_count'):
import multiprocessing # lazy-load see PR#85
self._cpu_count = multiprocessing.cpu_count()
return self._cpu_count
@property
def total_ram(self) -> str:
"""Return total RAM info.
If not available, returns 'unknown'.
"""
if not hasattr(self, '_total_ram'):
try:
import psutil # lazy-load see PR#85
tmem = psutil.virtual_memory().total
self._total_ram = '{:.1f} GiB'.format(tmem / (1024.0**3))
except ImportError:
self._total_ram = 'unknown'
return self._total_ram
@property
def mkl_info(self) -> Optional[str]:
"""Return MKL info.
If not available, returns 'unknown'.
"""
if not hasattr(self, '_mkl_info'):
try:
import mkl # lazy-load see PR#85
mkl.get_version_string()
except (ImportError, AttributeError):
mkl = False
try:
import numexpr # lazy-load see PR#85
except ImportError:
numexpr = False
# Get mkl info from numexpr or mkl, if available
if mkl:
self._mkl_info = cast(str, mkl.get_version_string())
elif numexpr:
self._mkl_info = cast(str, numexpr.get_vml_version())
else:
self._mkl_info = None
return self._mkl_info
@property
def date(self) -> str:
"""Return the date formatted as a string."""
return time.strftime('%a %b %d %H:%M:%S %Y %Z')
@property
def filesystem(self) -> Union[str, Literal[False]]:
"""Get the type of the file system at the path of the scooby package."""
if not hasattr(self, '_filesystem'):
self._filesystem = get_filesystem_type()
return self._filesystem
class PythonInfo:
"""Internal helper class to access Python info and package versions."""
def __init__(
self,
additional: Optional[List[Union[str, ModuleType]]],
core: Optional[List[Union[str, ModuleType]]],
optional: Optional[List[Union[str, ModuleType]]],
sort: bool,
):
"""Initialize python info."""
self._packages: Dict[str, Any] = {} # Holds name of packages and their version
self._sort = sort
# Add packages in the following order:
self._add_packages(additional) # Provided by the user
self._add_packages(core) # Provided by a module dev
self._add_packages(optional, optional=True) # Optional packages
def _add_packages(
self, packages: Optional[List[Union[str, ModuleType]]], optional: bool = False
):
"""Add all packages to list; optional ones only if available."""
# Ensure arguments are a list
if isinstance(packages, (str, ModuleType)):
pckgs: List[Union[str, ModuleType]] = [
packages,
]
elif packages is None or len(packages) < 1:
pckgs = list()
else:
pckgs = list(packages)
# Loop over packages
for pckg in pckgs:
name, version = get_version(pckg)
if not (version == MODULE_NOT_FOUND and optional):
self._packages[name] = version
@property
def sys_version(self) -> str:
"""Return the system version."""
return sys.version
@property
def python_environment(self) -> Literal['Jupyter', 'IPython', 'Python']:
"""Return the python environment."""
if in_ipykernel():
return 'Jupyter'
elif in_ipython():
return 'IPython'
return 'Python'
@property
def packages(self) -> Dict[str, Any]:
"""Return versions of all packages.
Includes available and unavailable/unknown.
"""
pckg_dict = dict(self._packages)
if self._sort:
packages: Dict[str, Any] = {}
for name in sorted(pckg_dict.keys(), key=lambda x: x.lower()):
packages[name] = pckg_dict[name]
pckg_dict = packages
return pckg_dict
# The main Report instance
class Report(PlatformInfo, PythonInfo):
"""Have Scooby report the active Python environment.
Displays the system information when a ``__repr__`` method is called
(through outputting or printing).
Parameters
----------
additional : list(ModuleType), list(str)
List of packages or package names to add to output information.
core : list(ModuleType), list(str)
The core packages to list first.
optional : list(ModuleType), list(str)
A list of packages to list if they are available. If not available,
no warnings or error will be thrown.
Defaults to ``['numpy', 'scipy', 'IPython', 'matplotlib', 'scooby']``
ncol : int, optional
Number of package-columns in html table (no effect in text-version);
Defaults to 3.
text_width : int, optional
The text width for non-HTML display modes.
sort : bool, optional
Sort the packages when the report is shown.
extra_meta : tuple(tuple(str, str), ...), optional
Additional two component pairs of meta information to display.
max_width : int, optional
Max-width of html-table. By default None.
"""
def __init__(
self,
additional: Optional[List[Union[str, ModuleType]]] = None,
core: Optional[List[Union[str, ModuleType]]] = None,
optional: Optional[List[Union[str, ModuleType]]] = None,
ncol: int = 4,
text_width: int = 80,
sort: bool = False,
extra_meta: Optional[Union[Tuple[Tuple[str, str], ...], List[Tuple[str, str]]]] = None,
max_width: Optional[int] = None,
) -> None:
"""Initialize report."""
# Set default optional packages to investigate
if optional is None:
optional = ['numpy', 'scipy', 'IPython', 'matplotlib', 'scooby']
PythonInfo.__init__(self, additional=additional, core=core, optional=optional, sort=sort)
self.ncol = int(ncol)
self.text_width = int(text_width)
self.max_width = max_width
if extra_meta is not None:
if not isinstance(extra_meta, (list, tuple)):
raise TypeError("`extra_meta` must be a list/tuple of " "key-value pairs.")
if len(extra_meta) == 2 and isinstance(extra_meta[0], str):
extra_meta = [extra_meta]
for meta in extra_meta:
if not isinstance(meta, (list, tuple)) or len(meta) != 2:
raise TypeError("Each chunk of meta info must have two values.")
else:
extra_meta = []
self._extra_meta = extra_meta
def __repr__(self) -> str:
"""Return Plain-text version information."""
import textwrap # lazy-load see PR#85
# Width for text-version
text = '\n' + self.text_width * '-' + '\n'
# Date and time info as title
date_text = ' Date: '
mult = 0
indent = len(date_text)
for txt in textwrap.wrap(self.date, self.text_width - indent):
date_text += ' ' * mult + txt + '\n'
mult = indent
text += date_text + '\n'
# Get length of longest package: min of 18 and max of 40
if self._packages:
row_width = min(40, max(18, len(max(self._packages.keys(), key=len))))
else:
row_width = 18
# Platform/OS details
repr_dict = self.to_dict()
for key in ['OS', 'CPU(s)', 'Machine', 'Architecture', 'RAM', 'Environment', 'File system']:
if key in repr_dict:
text += f'{key:>{row_width}} : {repr_dict[key]}\n'
for key, value in self._extra_meta:
text += f'{key:>{row_width}} : {value}\n'
# Python details
text += '\n'
for txt in textwrap.wrap('Python ' + self.sys_version, self.text_width - 4):
text += ' ' + txt + '\n'
if self._packages:
text += '\n'
# Loop over packages
for name, version in self._packages.items():
text += f'{name:>{row_width}} : {version}\n'
# MKL details
if self.mkl_info:
text += '\n'
for txt in textwrap.wrap(self.mkl_info, self.text_width - 4):
text += ' ' + txt + '\n'
# Finish
text += self.text_width * '-'
return text
def _repr_html_(self) -> str:
"""Return HTML-rendered version information."""
# Define html-styles
border = "border: 1px solid;'"
def colspan(html: str, txt: str, ncol: int, nrow: int) -> str:
r"""Print txt in a row spanning whole table."""
html += " <tr>\n"
html += " <td style='"
if ncol == 1:
html += "text-align: left; "
else:
html += "text-align: center; "
if nrow == 0:
html += "font-weight: bold; font-size: 1.2em; "
html += border + " colspan='"
html += f"{2 * ncol}'>{txt}</td>\n"
html += " </tr>\n"
return html
def cols(html: str, version: str, name: str, ncol: int, i: int) -> Tuple[str, int]:
r"""Print package information in two cells."""
# Check if we have to start a new row
if i > 0 and i % ncol == 0:
html += " </tr>\n"
html += " <tr>\n"
align = "left" if ncol == 1 else "right"
html += f" <td style='text-align: {align};"
html += " " + border + ">%s</td>\n" % name
html += " <td style='text-align: left; "
html += border + ">%s</td>\n" % version
return html, i + 1
# Start html-table
html = "<table style='border: 1.5px solid;"
if self.max_width:
html += f" max-width: {self.max_width}px;"
html += "'>\n"
# Date and time info as title
html = colspan(html, self.date, self.ncol, 0)
# Platform/OS details
html += " <tr>\n"
repr_dict = self.to_dict()
i = 0
for key in ['OS', 'CPU(s)', 'Machine', 'Architecture', 'RAM', 'Environment', "File system"]:
if key in repr_dict:
html, i = cols(html, repr_dict[key], key, self.ncol, i)
for meta in self._extra_meta:
html, i = cols(html, meta[1], meta[0], self.ncol, i)
# Finish row
html += " </tr>\n"
# Python details
html = colspan(html, 'Python ' + self.sys_version, self.ncol, 1)
html += " <tr>\n"
# Loop over packages
i = 0 # Reset count for rows.
for name, version in self.packages.items():
html, i = cols(html, version, name, self.ncol, i)
# Fill up the row
while i % self.ncol != 0:
html += " <td style= " + border + "></td>\n"
html += " <td style= " + border + "></td>\n"
i += 1
# Finish row
html += " </tr>\n"
# MKL details
if self.mkl_info:
html = colspan(html, self.mkl_info, self.ncol, 2)
# Finish
html += "</table>"
return html
def to_dict(self) -> Dict[str, str]:
"""Return report as dict for storage."""
out: Dict[str, str] = {}
# Date and time info
out['Date'] = self.date
# Platform/OS details
out['OS'] = self.system
out['CPU(s)'] = str(self.cpu_count)
out['Machine'] = self.machine
out['Architecture'] = self.architecture
if self.filesystem:
out['File system'] = self.filesystem
if self.total_ram != 'unknown':
out['RAM'] = self.total_ram
out['Environment'] = self.python_environment
for meta in self._extra_meta:
out[meta[1]] = meta[0]
# Python details
out['Python'] = self.sys_version
# Loop over packages
for name, version in self._packages.items():
out[name] = version
# MKL details
if self.mkl_info:
out['MKL'] = self.mkl_info
return out
class AutoReport(Report):
"""Auto-generate a scooby.Report for a package.
This will generate a report based on the distribution requirements of the package.
"""
def __init__(self, module, additional=None, ncol=3, text_width=80, sort=False):
"""Initialize."""
if not isinstance(module, (str, ModuleType)):
raise TypeError("Cannot generate report for type " "({})".format(type(module)))
if isinstance(module, ModuleType):
module = module.__name__
# Autogenerate from distribution requirements
core = [module, *get_distribution_dependencies(module)]
Report.__init__(
self,
additional=additional,
core=core,
optional=[],
ncol=ncol,
text_width=text_width,
sort=sort,
)
# This functionaliy might also be of interest on its own.
def get_version(module: Union[str, ModuleType]) -> Tuple[str, Optional[str]]:
"""Get the version of ``module`` by passing the package or it's name.
Parameters
----------
module : str or module
Name of a module to import or the module itself.
Returns
-------
name : str
Package name
version : str or None
Version of module.
"""
# module is (1) a module or (2) a string.
if not isinstance(module, (str, ModuleType)):
raise TypeError("Cannot fetch version from type " "({})".format(type(module)))
# module is module; get name
if isinstance(module, ModuleType):
name = module.__name__
else:
name = module
module = None
# Check aliased names
if name in PACKAGE_ALIASES:
name = PACKAGE_ALIASES[name]
# try importlib.metadata before loading the module
try:
return name, importlib_version(name)
except PackageNotFoundError:
module = None
# importlib could not find the package, try to load it
if module is None:
try:
module = importlib.import_module(name)
except ImportError:
return name, MODULE_NOT_FOUND
except Exception:
return name, MODULE_TROUBLE
# Try common version names on loaded module
for v_string in ('__version__', 'version'):
try:
return name, getattr(module, v_string)
except AttributeError:
pass
# Try the VERSION_ATTRIBUTES library
try:
attr = VERSION_ATTRIBUTES[name]
return name, getattr(module, attr)
except (KeyError, AttributeError):
pass
# Try the VERSION_METHODS library
try:
method = VERSION_METHODS[name]
return name, method()
except (KeyError, ImportError):
pass
# If still not found, return VERSION_NOT_FOUND
return name, VERSION_NOT_FOUND
def platform() -> ModuleType:
"""Return platform as lazy load; see PR#85."""
import platform
return platform
def get_distribution_dependencies(dist_name: str):
"""Get the dependencies of a specified package distribution.
Parameters
----------
dist_name : str
Name of the package distribution.
Returns
-------
dependencies : list
List of dependency names.
"""
try:
dist = distribution(dist_name)
except PackageNotFoundError:
raise PackageNotFoundError(f"Package `{dist_name}` has no distribution.")
return [pkg.split()[0] for pkg in dist.requires]