-
Notifications
You must be signed in to change notification settings - Fork 16
/
imports.py
310 lines (250 loc) · 9.94 KB
/
imports.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
# Copyright The PyTorch Lightning team.
# Licensed under the Apache License, Version 2.0 (the "License");
# http://www.apache.org/licenses/LICENSE-2.0
import functools
import importlib
import os
import warnings
from functools import lru_cache
from importlib.util import find_spec
from types import ModuleType
from typing import Any, Callable, List, Optional, TypeVar
import pkg_resources
from packaging.requirements import Requirement
from packaging.version import Version
from typing_extensions import ParamSpec
T = TypeVar("T")
P = ParamSpec("P")
try:
from importlib import metadata
except ImportError:
# Python < 3.8
import importlib_metadata as metadata # type: ignore
@lru_cache()
def package_available(package_name: str) -> bool:
"""Check if a package is available in your environment.
>>> package_available('os')
True
>>> package_available('bla')
False
"""
try:
return find_spec(package_name) is not None
except ModuleNotFoundError:
return False
@lru_cache()
def module_available(module_path: str) -> bool:
"""Check if a module path is available in your environment.
>>> module_available('os')
True
>>> module_available('os.bla')
False
>>> module_available('bla.bla')
False
"""
module_names = module_path.split(".")
if not package_available(module_names[0]):
return False
try:
importlib.import_module(module_path)
except ImportError:
return False
return True
def compare_version(package: str, op: Callable, version: str, use_base_version: bool = False) -> bool:
"""Compare package version with some requirements.
>>> compare_version("torch", operator.ge, "0.1")
True
>>> compare_version("does_not_exist", operator.ge, "0.0")
False
"""
try:
pkg = importlib.import_module(package)
except (ImportError, pkg_resources.DistributionNotFound):
return False
try:
if hasattr(pkg, "__version__"):
pkg_version = Version(pkg.__version__)
else:
# try pkg_resources to infer version
pkg_version = Version(pkg_resources.get_distribution(package).version)
except TypeError:
# this is mocked by Sphinx, so it should return True to generate all summaries
return True
if use_base_version:
pkg_version = Version(pkg_version.base_version)
return op(pkg_version, Version(version))
class RequirementCache:
"""Boolean-like class to check for requirement and module availability.
Args:
requirement: The requirement to check, version specifiers are allowed.
module: The optional module to try to import if the requirement check fails.
>>> RequirementCache("torch>=0.1")
Requirement 'torch>=0.1' met
>>> bool(RequirementCache("torch>=0.1"))
True
>>> bool(RequirementCache("torch>100.0"))
False
>>> RequirementCache("torch")
Requirement 'torch' met
>>> bool(RequirementCache("torch"))
True
>>> bool(RequirementCache("unknown_package"))
False
"""
def __init__(self, requirement: str, module: Optional[str] = None) -> None:
self.requirement = requirement
self.module = module
def _check_requirement(self) -> None:
if hasattr(self, "available"):
return
try:
# first try the pkg_resources requirement
pkg_resources.require(self.requirement)
self.available = True
self.message = f"Requirement {self.requirement!r} met"
except Exception as ex:
self.available = False
self.message = f"{ex.__class__.__name__}: {ex}. HINT: Try running `pip install -U {self.requirement!r}`"
requirement_contains_version_specifier = any(c in self.requirement for c in "=<>")
if not requirement_contains_version_specifier or self.module is not None:
module = self.requirement if self.module is None else self.module
# sometimes `pkg_resources.require()` fails but the module is importable
self.available = module_available(module)
if self.available:
self.message = f"Module {module!r} available"
def __bool__(self) -> bool:
"""Format as bool."""
self._check_requirement()
return self.available
def __str__(self) -> str:
"""Format as string."""
self._check_requirement()
return self.message
def __repr__(self) -> str:
"""Format as string."""
return self.__str__()
class ModuleAvailableCache:
"""Boolean-like class for check of module availability.
>>> ModuleAvailableCache("torch")
Module 'torch' available
>>> bool(ModuleAvailableCache("torch.utils"))
True
>>> bool(ModuleAvailableCache("unknown_package"))
False
>>> bool(ModuleAvailableCache("unknown.module.path"))
False
"""
def __init__(self, module: str) -> None:
self.module = module
def _check_requirement(self) -> None:
if hasattr(self, "available"):
return
self.available = module_available(self.module)
if self.available:
self.message = f"Module {self.module!r} available"
else:
self.message = f"Module not found: {self.module!r}. HINT: Try running `pip install -U {self.module}`"
def __bool__(self) -> bool:
"""Format as bool."""
self._check_requirement()
return self.available
def __str__(self) -> str:
"""Format as string."""
self._check_requirement()
return self.message
def __repr__(self) -> str:
"""Format as string."""
return self.__str__()
def get_dependency_min_version_spec(package_name: str, dependency_name: str) -> str:
"""Return the minimum version specifier of a dependency of a package.
>>> get_dependency_min_version_spec("pytorch-lightning==1.8.0", "jsonargparse")
'>=4.12.0'
"""
dependencies = metadata.requires(package_name) or []
for dep in dependencies:
dependency = Requirement(dep)
if dependency.name == dependency_name:
spec = [str(s) for s in dependency.specifier if str(s)[0] == ">"]
return spec[0] if spec else ""
raise ValueError(
"This is an internal error. Please file a GitHub issue with the error message. Dependency "
f"{dependency_name!r} not found in package {package_name!r}."
)
class LazyModule(ModuleType):
"""Proxy module that lazily imports the underlying module the first time it is actually used.
Args:
module_name: the fully-qualified module name to import
callback: a callback function to call before importing the module
"""
def __init__(self, module_name: str, callback: Optional[Callable] = None) -> None:
super().__init__(module_name)
self._module: Any = None
self._callback = callback
def __getattr__(self, item: str) -> Any:
"""Overwrite attribute access to attribute."""
if self._module is None:
self._import_module()
return getattr(self._module, item)
def __dir__(self) -> List[str]:
"""Overwrite attribute access for dictionary."""
if self._module is None:
self._import_module()
return dir(self._module)
def _import_module(self) -> None:
# Execute callback, if any
if self._callback is not None:
self._callback()
# Actually import the module
self._module = importlib.import_module(self.__name__)
# Update this object's dict so that attribute references are efficient
# (__getattr__ is only called on lookups that fail)
self.__dict__.update(self._module.__dict__)
def lazy_import(module_name: str, callback: Optional[Callable] = None) -> LazyModule:
"""Return a proxy module object that will lazily import the given module the first time it is used.
Example usage:
# Lazy version of `import tensorflow as tf`
tf = lazy_import("tensorflow")
# Other commands
# Now the module is loaded
tf.__version__
Args:
module_name: the fully-qualified module name to import
callback: a callback function to call before importing the module
Returns:
a proxy module object that will be lazily imported when first used
"""
return LazyModule(module_name, callback=callback)
def requires(*module_path_version: str, raise_exception: bool = True) -> Callable[[Callable[P, T]], Callable[P, T]]:
"""Wrap early import failure with some nice exception message.
Args:
module_path_version: pythin package path (e.g. `torch.cuda`) or pip like requiremsnt (e.g. `torch>=2.0.0`)
raise_exception: how strict the check shall be if exit the code or just warn user
Example:
>>> @requires("libpath", raise_exception=bool(int(os.getenv("LIGHTING_TESTING", "0"))))
... def my_cwd():
... from pathlib import Path
... return Path(__file__).parent
>>> class MyRndPower:
... @requires("math", "random")
... def __init__(self):
... from math import pow
... from random import randint
... self._rnd = pow(randint(1, 9), 2)
"""
def decorator(func: Callable[P, T]) -> Callable[P, T]:
reqs = [
ModuleAvailableCache(mod_ver) if "." in mod_ver else RequirementCache(mod_ver)
for mod_ver in module_path_version
]
available = all(map(bool, reqs))
@functools.wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
if not available:
missing = os.linesep.join([repr(r) for r in reqs if not bool(r)])
msg = f"Required dependencies not available: \n{missing}"
if raise_exception:
raise ModuleNotFoundError(msg)
warnings.warn(msg, stacklevel=2)
return func(*args, **kwargs)
return wrapper
return decorator