Repository navigation
Expand file tree
/
Copy pathinspect.py
More file actions
1060 lines (859 loc) · 36 KB
/
Copy pathinspect.py
File metadata and controls
1060 lines (859 loc) · 36 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
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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Helpers for inspecting Python modules."""
from __future__ import annotations
import ast
import builtins
import contextlib
import enum
import inspect
import re
import sys
import types
import typing
from collections.abc import Mapping
from functools import cached_property, partial, partialmethod, singledispatchmethod
from importlib import import_module
from inspect import Parameter, Signature
from io import StringIO
from types import ClassMethodDescriptorType, MethodDescriptorType, WrapperDescriptorType
from typing import TYPE_CHECKING, Any, ForwardRef
from sphinx.pycode.ast import unparse as ast_unparse
from sphinx.util import logging
from sphinx.util.typing import stringify_annotation
if TYPE_CHECKING:
from collections.abc import Callable, Iterator, Sequence
from inspect import _ParameterKind
from types import MethodType, ModuleType
from typing import Final, Protocol, TypeAlias
from typing_extensions import TypeIs
from sphinx.util.typing import _StringifyMode
class _SupportsGet(Protocol):
def __get__(self, instance: Any, owner: type | None = ..., /) -> Any: ...
class _SupportsSet(Protocol):
# instance and value are contravariants but we do not need that precision
def __set__(self, instance: Any, value: Any, /) -> None: ...
class _SupportsDelete(Protocol):
# instance is contravariant but we do not need that precision
def __delete__(self, instance: Any, /) -> None: ...
class _AttrGetter(Protocol):
def __call__(self, obj: Any, name: str, default: Any = ..., /) -> Any: ...
_RoutineType: TypeAlias = (
types.FunctionType
| types.LambdaType
| types.MethodType
| types.BuiltinFunctionType
| types.BuiltinMethodType
| types.WrapperDescriptorType
| types.MethodDescriptorType
| types.ClassMethodDescriptorType
)
_SignatureType: TypeAlias = (
Callable[..., Any] | staticmethod[Any, Any] | classmethod[Any, Any, Any]
)
logger = logging.getLogger(__name__)
memory_address_re = re.compile(r' at 0x[0-9a-f]{8,16}(?=>)', re.IGNORECASE)
# re-export as is
isasyncgenfunction = inspect.isasyncgenfunction
ismethod = inspect.ismethod
ismethoddescriptor = inspect.ismethoddescriptor
isclass = inspect.isclass
ismodule = inspect.ismodule
def unwrap(obj: Any) -> Any:
"""Get an original object from wrapped object (wrapped functions).
Mocked objects are returned as is.
"""
if hasattr(obj, '__sphinx_mock__'):
# Skip unwrapping mock object to avoid RecursionError
return obj
try:
return inspect.unwrap(obj)
except ValueError:
# might be a mock object
return obj
def unwrap_all(obj: Any, *, stop: Callable[[Any], bool] | None = None) -> Any:
"""Get an original object from wrapped object.
Unlike :func:`unwrap`, this unwraps partial functions, wrapped functions,
class methods and static methods.
When specified, *stop* is a predicate indicating whether an object should
be unwrapped or not.
"""
if callable(stop):
while not stop(obj):
if ispartial(obj):
obj = obj.func
elif inspect.isroutine(obj) and hasattr(obj, '__wrapped__'):
obj = obj.__wrapped__
elif isclassmethod(obj) or isstaticmethod(obj):
obj = obj.__func__
else:
return obj
return obj # in case the while loop never starts
while True:
if ispartial(obj):
obj = obj.func
elif inspect.isroutine(obj) and hasattr(obj, '__wrapped__'):
obj = obj.__wrapped__
elif isclassmethod(obj) or isstaticmethod(obj):
obj = obj.__func__
else:
return obj
def getall(obj: Any) -> Sequence[str] | None:
"""Get the ``__all__`` attribute of an object as a sequence.
This returns ``None`` if the given ``obj.__all__`` does not exist and
raises :exc:`ValueError` if ``obj.__all__`` is not a list or tuple of
strings.
"""
__all__ = safe_getattr(obj, '__all__', None)
if __all__ is None:
return None
if isinstance(__all__, list | tuple) and all(isinstance(e, str) for e in __all__):
return __all__
raise ValueError(__all__)
def getannotations(obj: Any) -> Mapping[str, Any]:
"""Safely get the ``__annotations__`` attribute of an object."""
__annotations__ = safe_getattr(obj, '__annotations__', None)
if isinstance(__annotations__, Mapping):
return __annotations__
return {}
def getglobals(obj: Any) -> Mapping[str, Any]:
"""Safely get :attr:`obj.__globals__ <function.__globals__>`."""
__globals__ = safe_getattr(obj, '__globals__', None)
if isinstance(__globals__, Mapping):
return __globals__
return {}
def getmro(obj: Any) -> tuple[type, ...]:
"""Safely get :attr:`obj.__mro__ <class.__mro__>`."""
__mro__ = safe_getattr(obj, '__mro__', None)
if isinstance(__mro__, tuple):
return __mro__
return ()
def getorigbases(obj: Any) -> tuple[Any, ...] | None:
"""Safely get ``obj.__orig_bases__``.
This returns ``None`` if the object is not a class or if ``__orig_bases__``
is not well-defined (e.g., a non-tuple object or an empty sequence).
"""
if not isclass(obj):
return None
# Get __orig_bases__ from obj.__dict__ to avoid accessing the parent's __orig_bases__.
# See: https://github.com/sphinx-doc/sphinx/issues/9607
__dict__ = safe_getattr(obj, '__dict__', {})
__orig_bases__ = __dict__.get('__orig_bases__')
if isinstance(__orig_bases__, tuple) and len(__orig_bases__) > 0:
return __orig_bases__
return None
def getslots(obj: Any) -> dict[str, Any] | dict[str, None] | None:
"""Safely get :term:`obj.__slots__ <__slots__>` as a dictionary if any.
- This returns ``None`` if ``obj.__slots__`` does not exist.
- This raises a :exc:`TypeError` if *obj* is not a class.
- This raises a :exc:`ValueError` if ``obj.__slots__`` is invalid.
"""
if not isclass(obj):
raise TypeError
__slots__ = safe_getattr(obj, '__slots__', None)
if __slots__ is None:
return None
elif isinstance(__slots__, dict):
return __slots__
elif isinstance(__slots__, str):
return {__slots__: None}
elif isinstance(__slots__, list | tuple):
return dict.fromkeys(__slots__)
else:
raise ValueError
def isenumclass(x: Any) -> TypeIs[type[enum.Enum]]:
"""Check if the object is an :class:`enumeration class <enum.Enum>`."""
return isclass(x) and issubclass(x, enum.Enum)
def isenumattribute(x: Any) -> TypeIs[enum.Enum]:
"""Check if the object is an enumeration attribute."""
return isinstance(x, enum.Enum)
def unpartial(obj: Any) -> Any:
"""Get an original object from a partial-like object.
If *obj* is not a partial object, it is returned as is.
.. seealso:: :func:`ispartial`
"""
while ispartial(obj):
obj = obj.func
return obj
def ispartial(obj: Any) -> TypeIs[partial[Any] | partialmethod[Any]]:
"""Check if the object is a partial function or method."""
return isinstance(obj, partial | partialmethod)
def isclassmethod(
obj: Any, cls: Any = None, name: str | None = None
) -> TypeIs[classmethod[Any, Any, Any]]:
"""Check if the object is a :class:`classmethod`."""
if isinstance(obj, classmethod):
return True
if ismethod(obj) and obj.__self__ is not None and isclass(obj.__self__):
return True
if cls and name:
# trace __mro__ if the method is defined in parent class
sentinel = object()
for basecls in getmro(cls):
meth = basecls.__dict__.get(name, sentinel)
if meth is not sentinel:
return isclassmethod(meth)
return False
def is_classmethod_descriptor(
obj: Any, cls: Any = None, name: str | None = None
) -> TypeIs[types.ClassMethodDescriptorType]:
"""Check if the object is a :class:`~types.ClassMethodDescriptorType`.
This check is stricter than :func:`is_builtin_classmethod_like` as
a classmethod descriptor does not have a ``__func__`` attribute.
"""
if isinstance(obj, types.ClassMethodDescriptorType):
return True
if cls and name:
# trace __mro__ if the method is defined in parent class
sentinel = object()
for basecls in getmro(cls):
meth = basecls.__dict__.get(name, sentinel)
if meth is not sentinel:
return isinstance(meth, types.ClassMethodDescriptorType)
return False
def is_builtin_classmethod_like(
obj: Any, cls: Any = None, name: str | None = None
) -> bool:
"""Check if the object looks like a class method implemented in C.
This is equivalent to test that *obj* is a class method descriptor
or is a built-in object with a ``__self__`` attribute that is a type,
or that ``parent_class.__dict__[name]`` satisfies those properties
for some parent class in *cls* MRO.
"""
if is_classmethod_descriptor(obj, cls, name):
return True
if (
isbuiltin(obj)
and getattr(obj, '__self__', None) is not None
and isclass(obj.__self__)
):
return True
if cls and name:
# trace __mro__ if the method is defined in parent class
sentinel = object()
for basecls in getmro(cls):
meth = basecls.__dict__.get(name, sentinel)
if meth is not sentinel:
return is_classmethod_descriptor(meth, None, None) or (
isbuiltin(meth)
and getattr(meth, '__self__', None) is not None
and isclass(meth.__self__)
)
return False
def is_classmethod_like(obj: Any, cls: Any = None, name: str | None = None) -> bool:
"""Check if the object looks like a class method."""
return isclassmethod(obj, cls, name) or is_builtin_classmethod_like(obj, cls, name)
def isstaticmethod(
obj: Any, cls: Any = None, name: str | None = None
) -> TypeIs[staticmethod[Any, Any]]:
"""Check if the object is a :class:`staticmethod`."""
if isinstance(obj, staticmethod):
return True
# Unlike built-in class methods, built-in static methods
# satisfy "isinstance(cls.__dict__[name], staticmethod)".
if cls and name:
# trace __mro__ if the method is defined in parent class
sentinel = object()
for basecls in getattr(cls, '__mro__', [cls]):
meth = basecls.__dict__.get(name, sentinel)
if meth is not sentinel:
return isinstance(meth, staticmethod)
return False
def isdescriptor(x: Any) -> TypeIs[_SupportsGet | _SupportsSet | _SupportsDelete]:
"""Check if the object is a :external+python:term:`descriptor`."""
return any(
callable(safe_getattr(x, item, None))
for item in ('__get__', '__set__', '__delete__')
)
def isabstractmethod(obj: Any) -> bool:
"""Check if the object is an :func:`abstractmethod`."""
return safe_getattr(obj, '__isabstractmethod__', False) is True
def isboundmethod(method: MethodType) -> bool:
"""Check if the method is a bound method."""
return safe_getattr(method, '__self__', None) is not None
def is_cython_function_or_method(obj: Any) -> bool:
"""Check if the object is a function or method in cython."""
try:
return obj.__class__.__name__ == 'cython_function_or_method'
except AttributeError:
return False
_DESCRIPTOR_LIKE: Final[tuple[type, ...]] = (
ClassMethodDescriptorType,
MethodDescriptorType,
WrapperDescriptorType,
)
def isattributedescriptor(obj: Any) -> bool:
"""Check if the object is an attribute-like descriptor."""
if inspect.isdatadescriptor(obj):
# data descriptor is kind of attribute
return True
if isdescriptor(obj):
# non data descriptor
unwrapped = unwrap(obj)
if isfunction(unwrapped) or isbuiltin(unwrapped) or ismethod(unwrapped):
# attribute must not be either function, builtin and method
return False
if is_cython_function_or_method(unwrapped):
# attribute must not be either function and method (for cython)
return False
if isclass(unwrapped):
# attribute must not be a class
return False
if isinstance(unwrapped, _DESCRIPTOR_LIKE):
# attribute must not be a method descriptor
return False
# attribute must not be an instancemethod (C-API)
return type(unwrapped).__name__ != 'instancemethod'
return False
def is_singledispatch_function(obj: Any) -> bool:
"""Check if the object is a :func:`~functools.singledispatch` function."""
return (
inspect.isfunction(obj)
and hasattr(obj, 'dispatch')
and hasattr(obj, 'register')
and obj.dispatch.__module__ == 'functools'
)
def is_singledispatch_method(obj: Any) -> TypeIs[singledispatchmethod[Any]]:
"""Check if the object is a :class:`~functools.singledispatchmethod`."""
return isinstance(obj, singledispatchmethod)
def isfunction(obj: Any) -> TypeIs[types.FunctionType]:
"""Check if the object is a user-defined function.
Partial objects are unwrapped before checking them.
.. seealso:: :external+python:func:`inspect.isfunction`
"""
return inspect.isfunction(unpartial(obj))
def isbuiltin(obj: Any) -> TypeIs[types.BuiltinFunctionType]:
"""Check if the object is a built-in function or method.
Partial objects are unwrapped before checking them.
.. seealso:: :external+python:func:`inspect.isbuiltin`
"""
return inspect.isbuiltin(unpartial(obj))
def isroutine(obj: Any) -> TypeIs[_RoutineType]:
"""Check if the object is a kind of function or method.
Partial objects are unwrapped before checking them.
.. seealso:: :external+python:func:`inspect.isroutine`
"""
return inspect.isroutine(unpartial(obj))
def iscoroutinefunction(
obj: Any,
) -> TypeIs[Callable[..., types.CoroutineType[Any, Any, Any]]]:
"""Check if the object is a :external+python:term:`coroutine` function."""
obj = unwrap_all(obj, stop=_is_wrapped_coroutine)
return inspect.iscoroutinefunction(obj)
def _is_wrapped_coroutine(obj: Any) -> bool:
"""Check if the object is wrapped coroutine-function."""
if isstaticmethod(obj) or isclassmethod(obj) or ispartial(obj):
# staticmethod, classmethod and partial method are not a wrapped coroutine-function
# Note: Since 3.10, staticmethod and classmethod becomes a kind of wrappers
return False
return hasattr(obj, '__wrapped__')
def isproperty(obj: Any) -> TypeIs[property | cached_property[Any]]:
"""Check if the object is property (possibly cached)."""
return isinstance(obj, property | cached_property)
def isgenericalias(obj: Any) -> TypeIs[types.GenericAlias]:
"""Check if the object is a generic alias."""
return isinstance(obj, types.GenericAlias | typing._BaseGenericAlias) # type: ignore[attr-defined]
def safe_getattr(obj: Any, name: str, *defargs: Any) -> Any:
"""A getattr() that turns all exceptions into AttributeErrors."""
if len(defargs) > 1:
msg = f'safe_getattr expected at most 3 arguments, got {len(defargs)}'
raise TypeError(msg)
try:
return getattr(obj, name, *defargs)
except Exception as exc:
# sometimes accessing a property raises an exception (e.g.
# NotImplementedError), so let's try to read the attribute directly
try:
# In case the object does weird things with attribute access
# such that accessing `obj.__dict__` may raise an exception
return obj.__dict__[name]
except Exception:
pass
# this is a catch-all for all the weird things that some modules do
# with attribute access
if defargs:
return defargs[0]
raise AttributeError(name) from exc
def object_description(obj: Any, *, _seen: frozenset[int] = frozenset()) -> str:
"""A repr() implementation that returns text safe to use in reST context.
Maintains a set of 'seen' object IDs to detect and avoid infinite recursion.
"""
seen = _seen
if isinstance(obj, dict):
if id(obj) in seen:
return 'dict(...)'
seen |= {id(obj)}
try:
sorted_keys = sorted(obj)
except TypeError:
# Cannot sort dict keys, fall back to using descriptions as a sort key
sorted_keys = sorted(obj, key=lambda k: object_description(k, _seen=seen))
items = (
(
object_description(key, _seen=seen),
object_description(obj[key], _seen=seen),
)
for key in sorted_keys
)
return '{%s}' % ', '.join(f'{key}: {value}' for (key, value) in items)
elif isinstance(obj, set):
if id(obj) in seen:
return 'set(...)'
seen |= {id(obj)}
try:
sorted_values = sorted(obj)
except TypeError:
# Cannot sort set values, fall back to using descriptions as a sort key
sorted_values = sorted(obj, key=lambda x: object_description(x, _seen=seen))
return '{%s}' % ', '.join(
object_description(x, _seen=seen) for x in sorted_values
)
elif isinstance(obj, frozenset):
if id(obj) in seen:
return 'frozenset(...)'
seen |= {id(obj)}
try:
sorted_values = sorted(obj)
except TypeError:
# Cannot sort frozenset values, fall back to using descriptions as a sort key
sorted_values = sorted(obj, key=lambda x: object_description(x, _seen=seen))
return 'frozenset({%s})' % ', '.join(
object_description(x, _seen=seen) for x in sorted_values
)
elif isinstance(obj, enum.Enum):
if obj.__repr__.__func__ is not enum.Enum.__repr__: # type: ignore[attr-defined]
return repr(obj)
return f'{obj.__class__.__name__}.{obj.name}'
elif isinstance(obj, tuple):
if id(obj) in seen:
return 'tuple(...)'
seen |= frozenset([id(obj)])
return '({}{})'.format(
', '.join(object_description(x, _seen=seen) for x in obj),
',' * (len(obj) == 1),
)
elif isinstance(obj, list):
if id(obj) in seen:
return 'list(...)'
seen |= {id(obj)}
return '[%s]' % ', '.join(object_description(x, _seen=seen) for x in obj)
try:
s = repr(obj)
except Exception as exc:
raise ValueError from exc
# Strip non-deterministic memory addresses such as
# ``<__main__.A at 0x7f68cb685710>``
s = memory_address_re.sub('', s)
return s.replace('\n', ' ')
def is_builtin_class_method(obj: Any, attr_name: str) -> bool:
"""Check whether *attr_name* is implemented on a builtin class.
>>> is_builtin_class_method(int, '__init__')
True
This function is needed since CPython implements ``int.__init__`` via
descriptors, but PyPy implementation is written in pure Python code.
"""
mro = getmro(obj)
try:
cls = next(c for c in mro if attr_name in safe_getattr(c, '__dict__', {}))
except StopIteration:
return False
try:
name = safe_getattr(cls, '__name__')
except AttributeError:
return False
return getattr(builtins, name, None) is cls
class DefaultValue:
"""A simple wrapper for default value of the parameters of overload functions."""
def __init__(self, value: str) -> None:
self.value = value
def __eq__(self, other: object) -> bool:
return self.value == other
def __hash__(self) -> int:
return hash(self.value)
def __repr__(self) -> str:
return self.value
class TypeAliasForwardRef:
"""Pseudo typing class for :confval:`autodoc_type_aliases`.
This avoids the error on evaluating the type inside :func:`typing.get_type_hints()`.
"""
def __init__(self, name: str) -> None:
self.name = name
def __call__(self) -> None:
# Dummy method to imitate special typing classes
pass
def __eq__(self, other: object) -> bool:
return self.name == other
def __hash__(self) -> int:
return hash(self.name)
def __repr__(self) -> str:
return f'{self.__class__.__name__}({self.name!r})'
class TypeAliasModule:
"""Pseudo module class for :confval:`autodoc_type_aliases`."""
def __init__(self, modname: str, mapping: Mapping[str, str]) -> None:
self.__modname = modname
self.__mapping = mapping
self.__module: ModuleType | None = None
def __getattr__(self, name: str) -> Any:
fullname = '.'.join(filter(None, [self.__modname, name]))
if fullname in self.__mapping:
# exactly matched
return TypeAliasForwardRef(self.__mapping[fullname])
else:
prefix = fullname + '.'
nested = {k: v for k, v in self.__mapping.items() if k.startswith(prefix)}
if nested:
# sub modules or classes found
return TypeAliasModule(fullname, nested)
else:
# no sub modules or classes found.
try:
# return the real submodule if exists
return import_module(fullname)
except ImportError:
# return the real class
if self.__module is None:
self.__module = import_module(self.__modname)
return getattr(self.__module, name)
class TypeAliasNamespace(Mapping[str, Any]):
"""Pseudo namespace class for :confval:`autodoc_type_aliases`.
Useful for looking up nested objects via ``namespace.foo.bar.Class``.
"""
def __init__(self, mapping: Mapping[str, str]) -> None:
super().__init__()
self.__mapping = mapping
def __getitem__(self, key: object) -> Any:
if not isinstance(key, str):
raise KeyError
if key in self.__mapping:
# exactly matched
return TypeAliasForwardRef(self.__mapping[key])
else:
prefix = key + '.'
nested = {k: v for k, v in self.__mapping.items() if k.startswith(prefix)}
if nested:
# sub modules or classes found
return TypeAliasModule(key, nested)
else:
raise KeyError
def __contains__(self, key: object) -> bool:
if not isinstance(key, str):
return False
ns = self.__mapping
prefix = f'{key}.'
return key in ns or any(k.startswith(prefix) for k in ns)
def __iter__(self) -> Iterator[str]:
for k in self.__mapping:
yield k
for i in range(k.count('.')):
yield k.rsplit('.', i + 1)[0]
def __len__(self) -> int:
return sum(k.count('.') + 1 for k in self.__mapping)
def _should_unwrap(subject: _SignatureType) -> bool:
"""Check the function should be unwrapped on getting signature."""
__globals__ = getglobals(subject)
# contextmanger should be unwrapped
return (
__globals__.get('__name__') == 'contextlib'
and __globals__.get('__file__') == contextlib.__file__
)
def signature(
subject: _SignatureType,
bound_method: bool = False,
type_aliases: Mapping[str, str] | None = None,
) -> Signature:
"""Return a Signature object for the given *subject*.
:param bound_method: Specify *subject* is a bound method or not.
When *subject* is a built-in callable, *bound_method* is ignored.
"""
if type_aliases is None:
type_aliases = {}
try:
if _should_unwrap(subject):
signature = inspect.signature(subject) # type: ignore[arg-type]
else:
signature = inspect.signature(subject, follow_wrapped=True) # type: ignore[arg-type]
except ValueError:
# follow built-in wrappers up (ex. functools.lru_cache)
signature = inspect.signature(subject) # type: ignore[arg-type]
parameters = list(signature.parameters.values())
return_annotation = signature.return_annotation
try:
# Resolve annotations using ``get_type_hints()`` and type_aliases.
localns = TypeAliasNamespace(type_aliases)
annotations = typing.get_type_hints(subject, None, localns, include_extras=True)
for i, param in enumerate(parameters):
if param.name in annotations:
annotation = annotations[param.name]
if isinstance(annotation, TypeAliasForwardRef):
annotation = annotation.name
parameters[i] = param.replace(annotation=annotation)
if 'return' in annotations:
if isinstance(annotations['return'], TypeAliasForwardRef):
return_annotation = annotations['return'].name
else:
return_annotation = annotations['return']
except Exception:
# ``get_type_hints()`` does not support some kind of objects like partial,
# ForwardRef and so on.
pass
# For built-in objects, we use the signature that was specified
# by the extension module even if we detected the subject to be
# a possible bound method.
if bound_method and not inspect.isbuiltin(subject):
if inspect.ismethod(subject):
# ``inspect.signature()`` considers the subject is a bound method and removes
# first argument from signature. Therefore no skips are needed here.
pass
else:
if len(parameters) > 0:
parameters.pop(0)
# To allow to create signature object correctly for pure python functions,
# pass an internal parameter __validate_parameters__=False to Signature
#
# For example, this helps a function having a default value `inspect._empty`.
# See: https://github.com/sphinx-doc/sphinx/issues/7935
return Signature(
parameters, return_annotation=return_annotation, __validate_parameters__=False
)
def evaluate_signature(
sig: Signature,
globalns: dict[str, Any] | None = None,
localns: dict[str, Any] | None = None,
) -> Signature:
"""Evaluate unresolved type annotations in a signature object."""
if globalns is None:
globalns = {}
if localns is None:
localns = globalns
parameters = list(sig.parameters.values())
for i, param in enumerate(parameters):
if param.annotation:
annotation = _evaluate(param.annotation, globalns, localns)
parameters[i] = param.replace(annotation=annotation)
return_annotation = sig.return_annotation
if return_annotation:
return_annotation = _evaluate(return_annotation, globalns, localns)
return sig.replace(parameters=parameters, return_annotation=return_annotation)
def _evaluate_forwardref(
ref: ForwardRef,
globalns: dict[str, Any] | None,
localns: dict[str, Any] | None,
) -> Any:
"""Evaluate a forward reference."""
if sys.version_info[:2] >= (3, 14):
# https://docs.python.org/dev/library/annotationlib.html#annotationlib.ForwardRef.evaluate
# https://docs.python.org/dev/library/typing.html#typing.evaluate_forward_ref
return typing.evaluate_forward_ref(ref, globals=globalns, locals=localns)
if sys.version_info >= (3, 12, 4):
# ``type_params`` were added in 3.13 and the signature of _evaluate()
# is not backward-compatible (it was backported to 3.12.4, so anything
# before 3.12.4 still has the old signature).
#
# See: https://github.com/python/cpython/pull/118104.
return ref._evaluate(
globalns, localns, type_params=(), recursive_guard=frozenset()
) # type: ignore[call-arg]
return ref._evaluate(globalns, localns, recursive_guard=frozenset())
def _evaluate(
annotation: Any,
globalns: dict[str, Any],
localns: dict[str, Any],
) -> Any:
"""Evaluate unresolved type annotation."""
try:
if isinstance(annotation, str):
ref = ForwardRef(annotation)
annotation = _evaluate_forwardref(ref, globalns, localns)
if isinstance(annotation, ForwardRef):
annotation = _evaluate_forwardref(ref, globalns, localns)
elif isinstance(annotation, str):
# might be a ForwardRef'ed annotation in overloaded functions
ref = ForwardRef(annotation)
annotation = _evaluate_forwardref(ref, globalns, localns)
except (NameError, TypeError):
# failed to evaluate type. skipped.
pass
return annotation
def stringify_signature(
sig: Signature,
show_annotation: bool = True,
show_return_annotation: bool = True,
unqualified_typehints: bool = False,
short_literals: bool = False,
) -> str:
"""Stringify a :class:`~inspect.Signature` object.
:param show_annotation: If enabled, show annotations on the signature
:param show_return_annotation: If enabled, show annotation of the return value
:param unqualified_typehints: If enabled, show annotations as unqualified
(ex. io.StringIO -> StringIO)
:param short_literals: If enabled, use short literal types.
"""
mode: _StringifyMode
if unqualified_typehints:
mode = 'smart'
else:
mode = 'fully-qualified'
EMPTY = Parameter.empty
args = []
last_kind = None
for param in sig.parameters.values():
if (
param.kind != Parameter.POSITIONAL_ONLY
and last_kind == Parameter.POSITIONAL_ONLY
):
# PEP-570: Separator for Positional Only Parameter: /
args.append('/')
if param.kind == Parameter.KEYWORD_ONLY and last_kind in {
Parameter.POSITIONAL_OR_KEYWORD,
Parameter.POSITIONAL_ONLY,
None,
}:
# PEP-3102: Separator for Keyword Only Parameter: *
args.append('*')
arg = StringIO()
if param.kind is Parameter.VAR_POSITIONAL:
arg.write('*' + param.name)
elif param.kind is Parameter.VAR_KEYWORD:
arg.write('**' + param.name)
else:
arg.write(param.name)
if show_annotation and param.annotation is not EMPTY:
arg.write(': ')
arg.write(
stringify_annotation(
param.annotation, mode, short_literals=short_literals
)
)
if param.default is not EMPTY:
if show_annotation and param.annotation is not EMPTY:
arg.write(' = ')
else:
arg.write('=')
arg.write(object_description(param.default))
args.append(arg.getvalue())
last_kind = param.kind
if last_kind is Parameter.POSITIONAL_ONLY:
# PEP-570: Separator for Positional Only Parameter: /
args.append('/')
concatenated_args = ', '.join(args)
if (
sig.return_annotation is EMPTY
or not show_annotation
or not show_return_annotation
):
return f'({concatenated_args})'
else:
retann = stringify_annotation(
sig.return_annotation, mode, short_literals=short_literals
)
return f'({concatenated_args}) -> {retann}'
def signature_from_str(signature: str) -> Signature:
"""Create a :class:`~inspect.Signature` object from a string."""
code = 'def func' + signature + ': pass'
module = ast.parse(code)
function = typing.cast('ast.FunctionDef', module.body[0])
return signature_from_ast(function, code)
def signature_from_ast(node: ast.FunctionDef, code: str = '') -> Signature:
"""Create a :class:`~inspect.Signature` object from an AST node."""
EMPTY = Parameter.empty
args: ast.arguments = node.args
defaults: tuple[ast.expr | None, ...] = tuple(args.defaults)
pos_only_offset = len(args.posonlyargs)
defaults_offset = pos_only_offset + len(args.args) - len(defaults)
# The sequence ``D = args.defaults`` contains non-None AST expressions,
# so we can use ``None`` as a sentinel value for that to indicate that
# there is no default value for a specific parameter.
#
# Let *p* be the number of positional-only and positional-or-keyword
# arguments. Note that ``0 <= len(D) <= p`` and ``D[0]`` is the default
# value corresponding to a positional-only *or* a positional-or-keyword
# argument. Since a non-default argument cannot follow a default argument,
# the sequence *D* can be completed on the left by adding None sentinels
# so that ``len(D) == p`` and ``D[i]`` is the *i*-th default argument.
defaults = (None,) * defaults_offset + defaults
# construct the parameter list
params: list[Parameter] = []
# positional-only arguments (introduced in Python 3.8)
for arg, defexpr in zip(args.posonlyargs, defaults, strict=False):
params.append(_define(Parameter.POSITIONAL_ONLY, arg, code, defexpr=defexpr))
# normal arguments
for arg, defexpr in zip(args.args, defaults[pos_only_offset:], strict=False):
params.append(
_define(Parameter.POSITIONAL_OR_KEYWORD, arg, code, defexpr=defexpr)
)
# variadic positional argument (no possible default expression)
if args.vararg:
params.append(
_define(Parameter.VAR_POSITIONAL, args.vararg, code, defexpr=None)
)
# keyword-only arguments
for arg, defexpr in zip(args.kwonlyargs, args.kw_defaults, strict=False):
params.append(_define(Parameter.KEYWORD_ONLY, arg, code, defexpr=defexpr))
# variadic keyword argument (no possible default expression)
if args.kwarg:
params.append(_define(Parameter.VAR_KEYWORD, args.kwarg, code, defexpr=None))
return_annotation = ast_unparse(node.returns, code) or EMPTY
return Signature(params, return_annotation=return_annotation)
def _define(
kind: _ParameterKind,
arg: ast.arg,
code: str,
*,
defexpr: ast.expr | None,
) -> Parameter:
EMPTY = Parameter.empty
default = EMPTY if defexpr is None else DefaultValue(ast_unparse(defexpr, code))
annotation = ast_unparse(arg.annotation, code) or EMPTY
return Parameter(arg.arg, kind, default=default, annotation=annotation)
def getdoc(
obj: Any,