-
Notifications
You must be signed in to change notification settings - Fork 6
/
utils.py
453 lines (377 loc) · 14.2 KB
/
utils.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
# -*- coding=utf-8 -*-
"""
Shared utility functions which are not specific to any particular module.
"""
from __future__ import absolute_import
import contextlib
import copy
import inspect
import sys
from collections.abc import Callable
from functools import wraps
from packaging.version import _BaseVersion, parse
from .environment import MYPY_RUNNING
if MYPY_RUNNING:
from types import ModuleType
from typing import (
Any,
Dict,
Iterator,
List,
Optional,
Sequence,
Tuple,
Type,
TypeVar,
Union,
)
TShimmedPath = TypeVar("TShimmedPath")
TShimmedPathCollection = TypeVar("TShimmedPathCollection")
TShim = Union[TShimmedPath, TShimmedPathCollection]
TShimmedFunc = Union[TShimmedPath, TShimmedPathCollection, Callable, Type]
STRING_TYPES = (str,)
if sys.version_info < (3, 0):
STRING_TYPES = STRING_TYPES + (unicode,) # noqa:F821
class BaseMethod(Callable):
def __init__(self, func_base, name, *args, **kwargs):
# type: (Callable, str, Any, Any) -> None
self.func = func_base
self.__name__ = self.__qualname__ = name
def __call__(self, *args, **kwargs):
# type: (Any, Any) -> Any
return self.func(*args, **kwargs)
class BaseClassMethod(Callable):
def __init__(self, func_base, name, *args, **kwargs):
# type: (Callable, str, Any, Any) -> None
self.func = func_base
self.__name__ = self.__qualname__ = name
def __call__(self, cls, *args, **kwargs):
# type: (Type, Any, Any) -> Any
return self.func(*args, **kwargs)
def make_method(fn):
# type: (Callable) -> Callable
@wraps(fn)
def method_creator(*args, **kwargs):
# type: (Any, Any) -> Callable
return BaseMethod(fn, *args, **kwargs)
return method_creator
def make_classmethod(fn):
# type: (Callable) -> Callable
@wraps(fn)
def classmethod_creator(*args, **kwargs):
# type: (Any, Any) -> Callable
return classmethod(BaseClassMethod(fn, *args, **kwargs))
return classmethod_creator
def memoize(obj):
# type: (Any) -> Callable
cache = obj.cache = {}
@wraps(obj)
def memoizer(*args, **kwargs):
key = str(args) + str(kwargs)
if key not in cache:
cache[key] = obj(*args, **kwargs)
return cache[key]
return memoizer
@memoize
def _parse(version):
# type: (str) -> Tuple[int, ...]
if isinstance(version, STRING_TYPES):
return tuple(int(i) for i in version.split("."))
return version
@memoize
def parse_version(version):
# type: (str) -> _BaseVersion
if not isinstance(version, STRING_TYPES):
raise TypeError("Can only derive versions from string, got {!r}".format(version))
return parse(version)
@memoize
def split_package(module, subimport=None):
# type: (str, Optional[str]) -> Tuple[str, str]
"""
Used to determine what target to import.
Either splits off the final segment or uses the provided sub-import to return a
2-tuple of the import path and the target module or sub-path.
:param str module: A package to import from
:param Optional[str] subimport: A class, function, or subpackage to import
:return: A 2-tuple of the corresponding import package and sub-import path
:rtype: Tuple[str, str]
:Example:
>>> from pip_shims.utils import split_package
>>> split_package("pip._internal.req.req_install", subimport="InstallRequirement")
("pip._internal.req.req_install", "InstallRequirement")
>>> split_package("pip._internal.cli.base_command")
("pip._internal.cli", "base_command")
"""
package = None
if subimport:
package = subimport
else:
module, _, package = module.rpartition(".")
return module, package
def get_method_args(target_method):
# type: (Callable) -> Tuple[Callable, Optional[inspect.Arguments]]
"""
Returns the arguments for a callable.
:param Callable target_method: A callable to retrieve arguments for
:return: A 2-tuple of the original callable and its resulting arguments
:rtype: Tuple[Callable, Optional[inspect.Arguments]]
"""
inspected_args = None
try:
inspected_args = inspect.getargs(target_method.__code__)
except AttributeError:
target_func = getattr(target_method, "__func__", None)
if target_func is not None:
inspected_args = inspect.getargs(target_func.__code__)
else:
target_func = target_method
return target_func, inspected_args
def set_default_kwargs(basecls, method, *args, **default_kwargs):
# type: (Union[Type, ModuleType], Callable, Any, Any) -> Union[Type, ModuleType] # noqa
target_method = getattr(basecls, method, None)
if target_method is None:
return basecls
target_func, inspected_args = get_method_args(target_method)
if inspected_args is not None:
pos_args = inspected_args.args
else:
pos_args = []
# Spit back the base class if we can't find matching arguments
# to put defaults in place of
if not any(arg in pos_args for arg in list(default_kwargs.keys())):
return basecls
prepended_defaults = tuple() # type: Tuple[Any, ...]
# iterate from the function's argument order to make sure we fill this
# out in the correct order
for arg in args:
prepended_defaults += (arg,)
for arg in pos_args:
if arg in default_kwargs:
prepended_defaults = prepended_defaults + (default_kwargs[arg],)
if not prepended_defaults:
return basecls
new_defaults = prepended_defaults + target_method.__defaults__
target_method.__defaults__ = new_defaults
setattr(basecls, method, target_method)
return basecls
def ensure_function(parent, funcname, func):
# type: (Union[ModuleType, Type, Callable, Any], str, Callable) -> Callable
"""Given a module, a function name, and a function object, attaches the given
function to the module and ensures it is named properly according to the provided
argument
:param Any parent: The parent to attack the function to
:param str funcname: The name to give the function
:param Callable func: The function to rename and attach to **parent**
:returns: The function with its name, qualname, etc set to mirror **parent**
:rtype: Callable
"""
qualname = funcname
if parent is None:
parent = __module__ # type: ignore # noqa:F821
parent_is_module = inspect.ismodule(parent)
parent_is_class = inspect.isclass(parent)
module = None
if parent_is_module:
module = parent.__name__
elif parent_is_class:
qualname = "{}.{}".format(parent.__name__, qualname)
module = getattr(parent, "__module__", None)
else:
module = getattr(parent, "__module__", None)
try:
func.__name__ = funcname
except AttributeError:
if getattr(func, "__func__", None) is not None:
func = func.__func__
func.__name__ = funcname
func.__qualname__ = qualname
func.__module__ = module
return func
def add_mixin_to_class(basecls, mixins):
# type: (Type, List[Type]) -> Type
"""
Given a class, adds the provided mixin classes as base classes and gives a new class
:param Type basecls: An initial class to generate a new class from
:param List[Type] mixins: A list of mixins to add as base classes
:return: A new class with the provided mixins as base classes
:rtype: Type[basecls, *mixins]
"""
if not any(mixins):
return basecls
base_dict = basecls.__dict__.copy()
class_tuple = (basecls,) # type: Tuple[Type, ...]
for mixin in mixins:
if not mixin:
continue
mixin_dict = mixin.__dict__.copy()
base_dict.update(mixin_dict)
class_tuple = class_tuple + (mixin,)
base_dict.update(basecls.__dict__)
return type(basecls.__name__, class_tuple, base_dict)
def fallback_is_file_url(link):
# type: (Any) -> bool
return link.url.lower().startswith("file:")
def fallback_is_artifact(self):
# type: (Any) -> bool
return not getattr(self, "is_vcs", False)
def fallback_is_vcs(self):
# type: (Any) -> bool
return not getattr(self, "is_artifact", True)
def resolve_possible_shim(target):
# type: (TShimmedFunc) -> Optional[Union[Type, Callable]]
if target is None:
return target
if getattr(target, "shim", None):
return target.shim()
return target
@contextlib.contextmanager
def nullcontext(*args, **kwargs):
# type: (Any, Any) -> Iterator
try:
yield
finally:
pass
def has_property(target, name):
# type: (Any, str) -> bool
if getattr(target, name, None) is not None:
return True
return False
def apply_alias(imported, target, *aliases):
# type: (Union[ModuleType, Type, None], Any, Any) -> Any
"""
Given a target with attributes, point non-existant aliases at the first existing one
:param Union[ModuleType, Type] imported: A Module or Class base
:param Any target: The target which is a member of **imported** and will have aliases
:param str aliases: A list of aliases, the first found attribute will be the basis
for all non-existant names which will be created as pointers
:return: The original target
:rtype: Any
"""
base_value = None # type: Optional[Any]
applied_aliases = set()
unapplied_aliases = set()
for alias in aliases:
if has_property(target, alias):
base_value = getattr(target, alias)
applied_aliases.add(alias)
else:
unapplied_aliases.add(alias)
is_callable = inspect.ismethod(base_value) or inspect.isfunction(base_value)
for alias in unapplied_aliases:
if is_callable:
func_copy = copy.deepcopy(base_value)
alias_value = ensure_function(imported, alias, func_copy)
else:
alias_value = base_value
setattr(target, alias, alias_value)
return target
def suppress_setattr(obj, attr, value, filter_none=False):
"""
Set an attribute, suppressing any exceptions and skipping the attempt on failure.
:param Any obj: Object to set the attribute on
:param str attr: The attribute name to set
:param Any value: The value to set the attribute to
:param bool filter_none: [description], defaults to False
:return: Nothing
:rtype: None
:Example:
>>> class MyClass(object):
... def __init__(self, name):
... self.name = name
... self.parent = None
... def __repr__(self):
... return "<{0!r} instance (name={1!r}, parent={2!r})>".format(
... self.__class__.__name__, self.name, self.parent
... )
... def __str__(self):
... return self.name
>>> me = MyClass("Dan")
>>> dad = MyClass("John")
>>> grandfather = MyClass("Joe")
>>> suppress_setattr(dad, "parent", grandfather)
>>> dad
<'MyClass' instance (name='John', parent=<'MyClass' instance (name='Joe', parent=None
)>)>
>>> suppress_setattr(me, "parent", dad)
>>> me
<'MyClass' instance (name='Dan', parent=<'MyClass' instance (name='John', parent=<'My
Class' instance (name='Joe', parent=None)>)>)>
>>> suppress_setattr(me, "grandparent", grandfather)
>>> me
<'MyClass' instance (name='Dan', parent=<'MyClass' instance (name='John', parent=<'My
Class' instance (name='Joe', parent=None)>)>)>
"""
if filter_none and value is None:
pass
try:
setattr(obj, attr, value)
except Exception: # noqa
pass
def get_allowed_args(fn_or_class):
# type: (Union[Callable, Type]) -> Tuple[List[str], Dict[str, Any]]
"""
Given a callable or a class, returns the arguments and default kwargs passed in.
:param Union[Callable, Type] fn_or_class: A function, method or class to inspect.
:return: A 2-tuple with a list of arguments and a dictionary of keywords mapped to
default values.
:rtype: Tuple[List[str], Dict[str, Any]]
"""
try:
signature = inspect.signature(fn_or_class)
except AttributeError:
import funcsigs
signature = funcsigs.signature(fn_or_class)
args = []
kwargs = {}
for arg, param in signature.parameters.items():
if (
param.kind in (param.POSITIONAL_OR_KEYWORD, param.POSITIONAL_ONLY)
) and param.default is param.empty:
args.append(arg)
else:
kwargs[arg] = param.default if param.default is not param.empty else None
return args, kwargs
def call_function_with_correct_args(fn, **provided_kwargs):
# type: (Callable, Dict[str, Any]) -> Any
"""
Determines which arguments from **provided_kwargs** to call **fn** and calls it.
Consumes a list of allowed arguments (e.g. from :func:`~inspect.getargs()`) and
uses it to determine which of the arguments in the provided kwargs should be passed
through to the given callable.
:param Callable fn: A callable which has some dynamic arguments
:param List[str] allowed_args: A list of allowed arguments which can be passed to
the supplied function
:return: The result of calling the function
:rtype: Any
"""
# signature = inspect.signature(fn)
args = []
kwargs = {}
func_args, func_kwargs = get_allowed_args(fn)
for arg in func_args:
args.append(provided_kwargs[arg])
for arg in func_kwargs:
if not provided_kwargs.get(arg):
continue
kwargs[arg] = provided_kwargs[arg]
return fn(*args, **kwargs)
def filter_allowed_args(fn, **provided_kwargs):
# type: (Callable, Dict[str, Any]) -> Tuple[List[Any], Dict[str, Any]]
"""
Given a function and a kwarg mapping, return only those kwargs used in the function.
:param Callable fn: A function to inspect
:param Dict[str, Any] kwargs: A mapping of kwargs to filter
:return: A new, filtered kwarg mapping
:rtype: Tuple[List[Any], Dict[str, Any]]
"""
args = []
kwargs = {}
func_args, func_kwargs = get_allowed_args(fn)
for arg in func_args:
if arg in provided_kwargs:
args.append(provided_kwargs[arg])
for arg in func_kwargs:
if arg not in provided_kwargs:
continue
kwargs[arg] = provided_kwargs[arg]
return args, kwargs