mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add smartref parameter to sphinx.util.typing:stringify()
To make the generated function signatures simple, this adds a new parameter `smartref` to sphinx.util.typing:stringify() to suppress the leading module name from typehints.
This commit is contained in:
Takeshi KOMIYA
@@ -299,10 +299,19 @@ def _restify_py36(cls: Optional[Type]) -> str:
|
||||
return ':py:obj:`%s.%s`' % (cls.__module__, qualname)
|
||||
|
||||
|
||||
def stringify(annotation: Any) -> str:
|
||||
"""Stringify type annotation object."""
|
||||
def stringify(annotation: Any, smartref: bool = False) -> str:
|
||||
"""Stringify type annotation object.
|
||||
|
||||
:param smartref: If true, add "~" prefix to the result to remove the leading
|
||||
module and class names from the reference text
|
||||
"""
|
||||
from sphinx.util import inspect # lazy loading
|
||||
|
||||
if smartref:
|
||||
prefix = '~'
|
||||
else:
|
||||
prefix = ''
|
||||
|
||||
if isinstance(annotation, str):
|
||||
if annotation.startswith("'") and annotation.endswith("'"):
|
||||
# might be a double Forward-ref'ed type. Go unquoting.
|
||||
@@ -313,11 +322,11 @@ def stringify(annotation: Any) -> str:
|
||||
if annotation.__module__ == 'typing':
|
||||
return annotation.__name__
|
||||
else:
|
||||
return '.'.join([annotation.__module__, annotation.__name__])
|
||||
return prefix + '.'.join([annotation.__module__, annotation.__name__])
|
||||
elif inspect.isNewType(annotation):
|
||||
if sys.version_info > (3, 10):
|
||||
# newtypes have correct module info since Python 3.10+
|
||||
return '%s.%s' % (annotation.__module__, annotation.__name__)
|
||||
return prefix + '%s.%s' % (annotation.__module__, annotation.__name__)
|
||||
else:
|
||||
return annotation.__name__
|
||||
elif not annotation:
|
||||
@@ -325,7 +334,7 @@ def stringify(annotation: Any) -> str:
|
||||
elif annotation is NoneType:
|
||||
return 'None'
|
||||
elif annotation in INVALID_BUILTIN_CLASSES:
|
||||
return INVALID_BUILTIN_CLASSES[annotation]
|
||||
return prefix + INVALID_BUILTIN_CLASSES[annotation]
|
||||
elif str(annotation).startswith('typing.Annotated'): # for py310+
|
||||
pass
|
||||
elif (getattr(annotation, '__module__', None) == 'builtins' and
|
||||
@@ -338,28 +347,36 @@ def stringify(annotation: Any) -> str:
|
||||
return '...'
|
||||
|
||||
if sys.version_info >= (3, 7): # py37+
|
||||
return _stringify_py37(annotation)
|
||||
return _stringify_py37(annotation, smartref)
|
||||
else:
|
||||
return _stringify_py36(annotation)
|
||||
return _stringify_py36(annotation, smartref)
|
||||
|
||||
|
||||
def _stringify_py37(annotation: Any) -> str:
|
||||
def _stringify_py37(annotation: Any, smartref: bool = False) -> str:
|
||||
"""stringify() for py37+."""
|
||||
module = getattr(annotation, '__module__', None)
|
||||
if module == 'typing':
|
||||
modprefix = ''
|
||||
if module == 'typing' and getattr(annotation, '__forward_arg__', None):
|
||||
qualname = annotation.__forward_arg__
|
||||
elif module == 'typing':
|
||||
if getattr(annotation, '_name', None):
|
||||
qualname = annotation._name
|
||||
elif getattr(annotation, '__qualname__', None):
|
||||
qualname = annotation.__qualname__
|
||||
elif getattr(annotation, '__forward_arg__', None):
|
||||
qualname = annotation.__forward_arg__
|
||||
else:
|
||||
qualname = stringify(annotation.__origin__) # ex. Union
|
||||
|
||||
if smartref:
|
||||
modprefix = '~%s.' % module
|
||||
elif hasattr(annotation, '__qualname__'):
|
||||
qualname = '%s.%s' % (module, annotation.__qualname__)
|
||||
if smartref:
|
||||
modprefix = '~%s.' % module
|
||||
else:
|
||||
modprefix = '%s.' % module
|
||||
qualname = annotation.__qualname__
|
||||
elif hasattr(annotation, '__origin__'):
|
||||
# instantiated generic provided by a user
|
||||
qualname = stringify(annotation.__origin__)
|
||||
qualname = stringify(annotation.__origin__, smartref)
|
||||
elif UnionType and isinstance(annotation, UnionType): # types.Union (for py3.10+)
|
||||
qualname = 'types.Union'
|
||||
else:
|
||||
@@ -374,54 +391,63 @@ def _stringify_py37(annotation: Any) -> str:
|
||||
elif qualname in ('Optional', 'Union'):
|
||||
if len(annotation.__args__) > 1 and annotation.__args__[-1] is NoneType:
|
||||
if len(annotation.__args__) > 2:
|
||||
args = ', '.join(stringify(a) for a in annotation.__args__[:-1])
|
||||
return 'Optional[Union[%s]]' % args
|
||||
args = ', '.join(stringify(a, smartref) for a in annotation.__args__[:-1])
|
||||
return '%sOptional[%sUnion[%s]]' % (modprefix, modprefix, args)
|
||||
else:
|
||||
return 'Optional[%s]' % stringify(annotation.__args__[0])
|
||||
return '%sOptional[%s]' % (modprefix,
|
||||
stringify(annotation.__args__[0], smartref))
|
||||
else:
|
||||
args = ', '.join(stringify(a) for a in annotation.__args__)
|
||||
return 'Union[%s]' % args
|
||||
args = ', '.join(stringify(a, smartref) for a in annotation.__args__)
|
||||
return '%sUnion[%s]' % (modprefix, args)
|
||||
elif qualname == 'types.Union':
|
||||
if len(annotation.__args__) > 1 and None in annotation.__args__:
|
||||
args = ' | '.join(stringify(a) for a in annotation.__args__ if a)
|
||||
return 'Optional[%s]' % args
|
||||
return '%sOptional[%s]' % (modprefix, args)
|
||||
else:
|
||||
return ' | '.join(stringify(a) for a in annotation.__args__)
|
||||
elif qualname == 'Callable':
|
||||
args = ', '.join(stringify(a) for a in annotation.__args__[:-1])
|
||||
returns = stringify(annotation.__args__[-1])
|
||||
return '%s[[%s], %s]' % (qualname, args, returns)
|
||||
args = ', '.join(stringify(a, smartref) for a in annotation.__args__[:-1])
|
||||
returns = stringify(annotation.__args__[-1], smartref)
|
||||
return '%s%s[[%s], %s]' % (modprefix, qualname, args, returns)
|
||||
elif qualname == 'Literal':
|
||||
args = ', '.join(repr(a) for a in annotation.__args__)
|
||||
return '%s[%s]' % (qualname, args)
|
||||
return '%s%s[%s]' % (modprefix, qualname, args)
|
||||
elif str(annotation).startswith('typing.Annotated'): # for py39+
|
||||
return stringify(annotation.__args__[0])
|
||||
return stringify(annotation.__args__[0], smartref)
|
||||
elif all(is_system_TypeVar(a) for a in annotation.__args__):
|
||||
# Suppress arguments if all system defined TypeVars (ex. Dict[KT, VT])
|
||||
return qualname
|
||||
return modprefix + qualname
|
||||
else:
|
||||
args = ', '.join(stringify(a) for a in annotation.__args__)
|
||||
return '%s[%s]' % (qualname, args)
|
||||
args = ', '.join(stringify(a, smartref) for a in annotation.__args__)
|
||||
return '%s%s[%s]' % (modprefix, qualname, args)
|
||||
|
||||
return qualname
|
||||
return modprefix + qualname
|
||||
|
||||
|
||||
def _stringify_py36(annotation: Any) -> str:
|
||||
def _stringify_py36(annotation: Any, smartref: bool = False) -> str:
|
||||
"""stringify() for py36."""
|
||||
module = getattr(annotation, '__module__', None)
|
||||
if module == 'typing':
|
||||
modprefix = ''
|
||||
if module == 'typing' and getattr(annotation, '__forward_arg__', None):
|
||||
qualname = annotation.__forward_arg__
|
||||
elif module == 'typing':
|
||||
if getattr(annotation, '_name', None):
|
||||
qualname = annotation._name
|
||||
elif getattr(annotation, '__qualname__', None):
|
||||
qualname = annotation.__qualname__
|
||||
elif getattr(annotation, '__forward_arg__', None):
|
||||
qualname = annotation.__forward_arg__
|
||||
elif getattr(annotation, '__origin__', None):
|
||||
qualname = stringify(annotation.__origin__) # ex. Union
|
||||
else:
|
||||
qualname = repr(annotation).replace('typing.', '')
|
||||
|
||||
if smartref:
|
||||
modprefix = '~%s.' % module
|
||||
elif hasattr(annotation, '__qualname__'):
|
||||
qualname = '%s.%s' % (module, annotation.__qualname__)
|
||||
if smartref:
|
||||
modprefix = '~%s.' % module
|
||||
else:
|
||||
modprefix = '%s.' % module
|
||||
qualname = annotation.__qualname__
|
||||
else:
|
||||
qualname = repr(annotation)
|
||||
|
||||
@@ -429,10 +455,10 @@ def _stringify_py36(annotation: Any) -> str:
|
||||
not hasattr(annotation, '__tuple_params__')): # for Python 3.6
|
||||
params = annotation.__args__
|
||||
if params:
|
||||
param_str = ', '.join(stringify(p) for p in params)
|
||||
return '%s[%s]' % (qualname, param_str)
|
||||
param_str = ', '.join(stringify(p, smartref) for p in params)
|
||||
return '%s%s[%s]' % (modprefix, qualname, param_str)
|
||||
else:
|
||||
return qualname
|
||||
return modprefix + qualname
|
||||
elif isinstance(annotation, typing.GenericMeta):
|
||||
params = None
|
||||
if annotation.__args__ is None or len(annotation.__args__) <= 2: # type: ignore # NOQA
|
||||
@@ -440,28 +466,28 @@ def _stringify_py36(annotation: Any) -> str:
|
||||
elif annotation.__origin__ == Generator: # type: ignore
|
||||
params = annotation.__args__ # type: ignore
|
||||
else: # typing.Callable
|
||||
args = ', '.join(stringify(arg) for arg
|
||||
args = ', '.join(stringify(arg, smartref) for arg
|
||||
in annotation.__args__[:-1]) # type: ignore
|
||||
result = stringify(annotation.__args__[-1]) # type: ignore
|
||||
return '%s[[%s], %s]' % (qualname, args, result)
|
||||
return '%s%s[[%s], %s]' % (modprefix, qualname, args, result)
|
||||
if params is not None:
|
||||
param_str = ', '.join(stringify(p) for p in params)
|
||||
return '%s[%s]' % (qualname, param_str)
|
||||
param_str = ', '.join(stringify(p, smartref) for p in params)
|
||||
return '%s%s[%s]' % (modprefix, qualname, param_str)
|
||||
elif (hasattr(annotation, '__origin__') and
|
||||
annotation.__origin__ is typing.Union):
|
||||
params = annotation.__args__
|
||||
if params is not None:
|
||||
if len(params) > 1 and params[-1] is NoneType:
|
||||
if len(params) > 2:
|
||||
param_str = ", ".join(stringify(p) for p in params[:-1])
|
||||
return 'Optional[Union[%s]]' % param_str
|
||||
param_str = ", ".join(stringify(p, smartref) for p in params[:-1])
|
||||
return '%sOptional[%sUnion[%s]]' % (modprefix, modprefix, param_str)
|
||||
else:
|
||||
return 'Optional[%s]' % stringify(params[0])
|
||||
return '%sOptional[%s]' % (modprefix, stringify(params[0]))
|
||||
else:
|
||||
param_str = ', '.join(stringify(p) for p in params)
|
||||
return 'Union[%s]' % param_str
|
||||
param_str = ', '.join(stringify(p, smartref) for p in params)
|
||||
return '%sUnion[%s]' % (modprefix, param_str)
|
||||
|
||||
return qualname
|
||||
return modprefix + qualname
|
||||
|
||||
|
||||
deprecated_alias('sphinx.util.typing',
|
||||
|
||||
@@ -178,78 +178,156 @@ def test_restify_mock():
|
||||
|
||||
|
||||
def test_stringify():
|
||||
assert stringify(int) == "int"
|
||||
assert stringify(str) == "str"
|
||||
assert stringify(None) == "None"
|
||||
assert stringify(Integral) == "numbers.Integral"
|
||||
assert stringify(Struct) == "struct.Struct"
|
||||
assert stringify(TracebackType) == "types.TracebackType"
|
||||
assert stringify(Any) == "Any"
|
||||
assert stringify(int, False) == "int"
|
||||
assert stringify(int, True) == "int"
|
||||
|
||||
assert stringify(str, False) == "str"
|
||||
assert stringify(str, True) == "str"
|
||||
|
||||
assert stringify(None, False) == "None"
|
||||
assert stringify(None, True) == "None"
|
||||
|
||||
assert stringify(Integral, False) == "numbers.Integral"
|
||||
assert stringify(Integral, True) == "~numbers.Integral"
|
||||
|
||||
assert stringify(Struct, False) == "struct.Struct"
|
||||
assert stringify(Struct, True) == "~struct.Struct"
|
||||
|
||||
assert stringify(TracebackType, False) == "types.TracebackType"
|
||||
assert stringify(TracebackType, True) == "~types.TracebackType"
|
||||
|
||||
assert stringify(Any, False) == "Any"
|
||||
assert stringify(Any, True) == "~typing.Any"
|
||||
|
||||
|
||||
def test_stringify_type_hints_containers():
|
||||
assert stringify(List) == "List"
|
||||
assert stringify(Dict) == "Dict"
|
||||
assert stringify(List[int]) == "List[int]"
|
||||
assert stringify(List[str]) == "List[str]"
|
||||
assert stringify(Dict[str, float]) == "Dict[str, float]"
|
||||
assert stringify(Tuple[str, str, str]) == "Tuple[str, str, str]"
|
||||
assert stringify(Tuple[str, ...]) == "Tuple[str, ...]"
|
||||
assert stringify(Tuple[()]) == "Tuple[()]"
|
||||
assert stringify(List[Dict[str, Tuple]]) == "List[Dict[str, Tuple]]"
|
||||
assert stringify(MyList[Tuple[int, int]]) == "tests.test_util_typing.MyList[Tuple[int, int]]"
|
||||
assert stringify(Generator[None, None, None]) == "Generator[None, None, None]"
|
||||
assert stringify(List, False) == "List"
|
||||
assert stringify(List, True) == "~typing.List"
|
||||
|
||||
assert stringify(Dict, False) == "Dict"
|
||||
assert stringify(Dict, True) == "~typing.Dict"
|
||||
|
||||
assert stringify(List[int], False) == "List[int]"
|
||||
assert stringify(List[int], True) == "~typing.List[int]"
|
||||
|
||||
assert stringify(List[str], False) == "List[str]"
|
||||
assert stringify(List[str], True) == "~typing.List[str]"
|
||||
|
||||
assert stringify(Dict[str, float], False) == "Dict[str, float]"
|
||||
assert stringify(Dict[str, float], True) == "~typing.Dict[str, float]"
|
||||
|
||||
assert stringify(Tuple[str, str, str], False) == "Tuple[str, str, str]"
|
||||
assert stringify(Tuple[str, str, str], True) == "~typing.Tuple[str, str, str]"
|
||||
|
||||
assert stringify(Tuple[str, ...], False) == "Tuple[str, ...]"
|
||||
assert stringify(Tuple[str, ...], True) == "~typing.Tuple[str, ...]"
|
||||
|
||||
assert stringify(Tuple[()], False) == "Tuple[()]"
|
||||
assert stringify(Tuple[()], True) == "~typing.Tuple[()]"
|
||||
|
||||
assert stringify(List[Dict[str, Tuple]], False) == "List[Dict[str, Tuple]]"
|
||||
assert stringify(List[Dict[str, Tuple]], True) == "~typing.List[~typing.Dict[str, ~typing.Tuple]]"
|
||||
|
||||
assert stringify(MyList[Tuple[int, int]], False) == "tests.test_util_typing.MyList[Tuple[int, int]]"
|
||||
assert stringify(MyList[Tuple[int, int]], True) == "~tests.test_util_typing.MyList[~typing.Tuple[int, int]]"
|
||||
|
||||
assert stringify(Generator[None, None, None], False) == "Generator[None, None, None]"
|
||||
assert stringify(Generator[None, None, None], True) == "~typing.Generator[None, None, None]"
|
||||
|
||||
|
||||
@pytest.mark.skipif(sys.version_info < (3, 9), reason='python 3.9+ is required.')
|
||||
def test_stringify_type_hints_pep_585():
|
||||
assert stringify(list[int]) == "list[int]"
|
||||
assert stringify(list[str]) == "list[str]"
|
||||
assert stringify(dict[str, float]) == "dict[str, float]"
|
||||
assert stringify(tuple[str, str, str]) == "tuple[str, str, str]"
|
||||
assert stringify(tuple[str, ...]) == "tuple[str, ...]"
|
||||
assert stringify(tuple[()]) == "tuple[()]"
|
||||
assert stringify(list[dict[str, tuple]]) == "list[dict[str, tuple]]"
|
||||
assert stringify(type[int]) == "type[int]"
|
||||
assert stringify(list[int], False) == "list[int]"
|
||||
assert stringify(list[int], True) == "list[int]"
|
||||
|
||||
assert stringify(list[str], False) == "list[str]"
|
||||
assert stringify(list[str], True) == "list[str]"
|
||||
|
||||
assert stringify(dict[str, float], False) == "dict[str, float]"
|
||||
assert stringify(dict[str, float], True) == "dict[str, float]"
|
||||
|
||||
assert stringify(tuple[str, str, str], False) == "tuple[str, str, str]"
|
||||
assert stringify(tuple[str, str, str], True) == "tuple[str, str, str]"
|
||||
|
||||
assert stringify(tuple[str, ...], False) == "tuple[str, ...]"
|
||||
assert stringify(tuple[str, ...], True) == "tuple[str, ...]"
|
||||
|
||||
assert stringify(tuple[()], False) == "tuple[()]"
|
||||
assert stringify(tuple[()], True) == "tuple[()]"
|
||||
|
||||
assert stringify(list[dict[str, tuple]], False) == "list[dict[str, tuple]]"
|
||||
assert stringify(list[dict[str, tuple]], True) == "list[dict[str, tuple]]"
|
||||
|
||||
assert stringify(type[int], False) == "type[int]"
|
||||
assert stringify(type[int], True) == "type[int]"
|
||||
|
||||
|
||||
@pytest.mark.skipif(sys.version_info < (3, 9), reason='python 3.9+ is required.')
|
||||
def test_stringify_Annotated():
|
||||
from typing import Annotated # type: ignore
|
||||
assert stringify(Annotated[str, "foo", "bar"]) == "str" # NOQA
|
||||
assert stringify(Annotated[str, "foo", "bar"], False) == "str" # NOQA
|
||||
assert stringify(Annotated[str, "foo", "bar"], True) == "str" # NOQA
|
||||
|
||||
|
||||
def test_stringify_type_hints_string():
|
||||
assert stringify("int") == "int"
|
||||
assert stringify("str") == "str"
|
||||
assert stringify(List["int"]) == "List[int]"
|
||||
assert stringify("Tuple[str]") == "Tuple[str]"
|
||||
assert stringify("unknown") == "unknown"
|
||||
assert stringify("int", False) == "int"
|
||||
assert stringify("int", True) == "int"
|
||||
|
||||
assert stringify("str", False) == "str"
|
||||
assert stringify("str", True) == "str"
|
||||
|
||||
assert stringify(List["int"], False) == "List[int]"
|
||||
assert stringify(List["int"], True) == "~typing.List[int]"
|
||||
|
||||
assert stringify("Tuple[str]", False) == "Tuple[str]"
|
||||
assert stringify("Tuple[str]", True) == "Tuple[str]"
|
||||
|
||||
assert stringify("unknown", False) == "unknown"
|
||||
assert stringify("unknown", True) == "unknown"
|
||||
|
||||
|
||||
def test_stringify_type_hints_Callable():
|
||||
assert stringify(Callable) == "Callable"
|
||||
assert stringify(Callable, False) == "Callable"
|
||||
assert stringify(Callable, True) == "~typing.Callable"
|
||||
|
||||
if sys.version_info >= (3, 7):
|
||||
assert stringify(Callable[[str], int]) == "Callable[[str], int]"
|
||||
assert stringify(Callable[..., int]) == "Callable[[...], int]"
|
||||
assert stringify(Callable[[str], int], False) == "Callable[[str], int]"
|
||||
assert stringify(Callable[[str], int], True) == "~typing.Callable[[str], int]"
|
||||
|
||||
assert stringify(Callable[..., int], False) == "Callable[[...], int]"
|
||||
assert stringify(Callable[..., int], True) == "~typing.Callable[[...], int]"
|
||||
else:
|
||||
assert stringify(Callable[[str], int]) == "Callable[str, int]"
|
||||
assert stringify(Callable[..., int]) == "Callable[..., int]"
|
||||
assert stringify(Callable[[str], int], False) == "Callable[str, int]"
|
||||
assert stringify(Callable[[str], int], True) == "~typing.Callable[str, int]"
|
||||
|
||||
assert stringify(Callable[..., int], False) == "Callable[..., int]"
|
||||
assert stringify(Callable[..., int], True) == "~typing.Callable[..., int]"
|
||||
|
||||
|
||||
def test_stringify_type_hints_Union():
|
||||
assert stringify(Optional[int]) == "Optional[int]"
|
||||
assert stringify(Union[str, None]) == "Optional[str]"
|
||||
assert stringify(Union[int, str]) == "Union[int, str]"
|
||||
assert stringify(Optional[int], False) == "Optional[int]"
|
||||
assert stringify(Optional[int], True) == "~typing.Optional[int]"
|
||||
|
||||
assert stringify(Union[str, None], False) == "Optional[str]"
|
||||
assert stringify(Union[str, None], True) == "~typing.Optional[str]"
|
||||
|
||||
assert stringify(Union[int, str], False) == "Union[int, str]"
|
||||
assert stringify(Union[int, str], True) == "~typing.Union[int, str]"
|
||||
|
||||
if sys.version_info >= (3, 7):
|
||||
assert stringify(Union[int, Integral]) == "Union[int, numbers.Integral]"
|
||||
assert (stringify(Union[MyClass1, MyClass2]) ==
|
||||
assert stringify(Union[int, Integral], False) == "Union[int, numbers.Integral]"
|
||||
assert stringify(Union[int, Integral], True) == "~typing.Union[int, ~numbers.Integral]"
|
||||
|
||||
assert (stringify(Union[MyClass1, MyClass2], False) ==
|
||||
"Union[tests.test_util_typing.MyClass1, tests.test_util_typing.<MyClass2>]")
|
||||
assert (stringify(Union[MyClass1, MyClass2], True) ==
|
||||
"~typing.Union[~tests.test_util_typing.MyClass1, ~tests.test_util_typing.<MyClass2>]")
|
||||
else:
|
||||
assert stringify(Union[int, Integral]) == "numbers.Integral"
|
||||
assert stringify(Union[MyClass1, MyClass2]) == "tests.test_util_typing.MyClass1"
|
||||
assert stringify(Union[int, Integral], False) == "numbers.Integral"
|
||||
assert stringify(Union[int, Integral], True) == "~numbers.Integral"
|
||||
|
||||
assert stringify(Union[MyClass1, MyClass2], False) == "tests.test_util_typing.MyClass1"
|
||||
assert stringify(Union[MyClass1, MyClass2], True) == "~tests.test_util_typing.MyClass1"
|
||||
|
||||
|
||||
def test_stringify_type_hints_typevars():
|
||||
@@ -258,52 +336,83 @@ def test_stringify_type_hints_typevars():
|
||||
T_contra = TypeVar('T_contra', contravariant=True)
|
||||
|
||||
if sys.version_info < (3, 7):
|
||||
assert stringify(T) == "T"
|
||||
assert stringify(T_co) == "T_co"
|
||||
assert stringify(T_contra) == "T_contra"
|
||||
assert stringify(List[T]) == "List[T]"
|
||||
assert stringify(T, False) == "T"
|
||||
assert stringify(T, True) == "T"
|
||||
|
||||
assert stringify(T_co, False) == "T_co"
|
||||
assert stringify(T_co, True) == "T_co"
|
||||
|
||||
assert stringify(T_contra, False) == "T_contra"
|
||||
assert stringify(T_contra, True) == "T_contra"
|
||||
|
||||
assert stringify(List[T], False) == "List[T]"
|
||||
assert stringify(List[T], True) == "~typing.List[T]"
|
||||
else:
|
||||
assert stringify(T) == "tests.test_util_typing.T"
|
||||
assert stringify(T_co) == "tests.test_util_typing.T_co"
|
||||
assert stringify(T_contra) == "tests.test_util_typing.T_contra"
|
||||
assert stringify(List[T]) == "List[tests.test_util_typing.T]"
|
||||
assert stringify(T, False) == "tests.test_util_typing.T"
|
||||
assert stringify(T, True) == "~tests.test_util_typing.T"
|
||||
|
||||
assert stringify(T_co, False) == "tests.test_util_typing.T_co"
|
||||
assert stringify(T_co, True) == "~tests.test_util_typing.T_co"
|
||||
|
||||
assert stringify(T_contra, False) == "tests.test_util_typing.T_contra"
|
||||
assert stringify(T_contra, True) == "~tests.test_util_typing.T_contra"
|
||||
|
||||
assert stringify(List[T], False) == "List[tests.test_util_typing.T]"
|
||||
assert stringify(List[T], True) == "~typing.List[~tests.test_util_typing.T]"
|
||||
|
||||
if sys.version_info >= (3, 10):
|
||||
assert stringify(MyInt) == "tests.test_util_typing.MyInt"
|
||||
assert stringify(MyInt, False) == "tests.test_util_typing.MyInt"
|
||||
assert stringify(MyInt, True) == "~tests.test_util_typing.MyInt"
|
||||
else:
|
||||
assert stringify(MyInt) == "MyInt"
|
||||
assert stringify(MyInt, False) == "MyInt"
|
||||
assert stringify(MyInt, True) == "MyInt"
|
||||
|
||||
|
||||
def test_stringify_type_hints_custom_class():
|
||||
assert stringify(MyClass1) == "tests.test_util_typing.MyClass1"
|
||||
assert stringify(MyClass2) == "tests.test_util_typing.<MyClass2>"
|
||||
assert stringify(MyClass1, False) == "tests.test_util_typing.MyClass1"
|
||||
assert stringify(MyClass1, True) == "~tests.test_util_typing.MyClass1"
|
||||
|
||||
assert stringify(MyClass2, False) == "tests.test_util_typing.<MyClass2>"
|
||||
assert stringify(MyClass2, True) == "~tests.test_util_typing.<MyClass2>"
|
||||
|
||||
|
||||
def test_stringify_type_hints_alias():
|
||||
MyStr = str
|
||||
MyTuple = Tuple[str, str]
|
||||
assert stringify(MyStr) == "str"
|
||||
assert stringify(MyTuple) == "Tuple[str, str]" # type: ignore
|
||||
|
||||
assert stringify(MyStr, False) == "str"
|
||||
assert stringify(MyStr, True) == "str"
|
||||
|
||||
assert stringify(MyTuple, False) == "Tuple[str, str]" # type: ignore
|
||||
assert stringify(MyTuple, True) == "~typing.Tuple[str, str]" # type: ignore
|
||||
|
||||
|
||||
@pytest.mark.skipif(sys.version_info < (3, 8), reason='python 3.8+ is required.')
|
||||
def test_stringify_type_Literal():
|
||||
from typing import Literal # type: ignore
|
||||
assert stringify(Literal[1, "2", "\r"]) == "Literal[1, '2', '\\r']"
|
||||
assert stringify(Literal[1, "2", "\r"], False) == "Literal[1, '2', '\\r']"
|
||||
assert stringify(Literal[1, "2", "\r"], True) == "~typing.Literal[1, '2', '\\r']"
|
||||
|
||||
|
||||
@pytest.mark.skipif(sys.version_info < (3, 10), reason='python 3.10+ is required.')
|
||||
def test_stringify_type_union_operator():
|
||||
assert stringify(int | None) == "int | None" # type: ignore
|
||||
assert stringify(int | str) == "int | str" # type: ignore
|
||||
assert stringify(int | str | None) == "int | str | None" # type: ignore
|
||||
assert stringify(int | None, False) == "int | None" # type: ignore
|
||||
assert stringify(int | None, True) == "int | None" # type: ignore
|
||||
|
||||
assert stringify(int | str, False) == "int | str" # type: ignore
|
||||
assert stringify(int | str, True) == "int | str" # type: ignore
|
||||
|
||||
assert stringify(int | str | None, False) == "int | str | None" # type: ignore
|
||||
assert stringify(int | str | None, True) == "int | str | None" # type: ignore
|
||||
|
||||
|
||||
def test_stringify_broken_type_hints():
|
||||
assert stringify(BrokenType) == 'tests.test_util_typing.BrokenType'
|
||||
assert stringify(BrokenType, False) == 'tests.test_util_typing.BrokenType'
|
||||
assert stringify(BrokenType, True) == '~tests.test_util_typing.BrokenType'
|
||||
|
||||
|
||||
def test_stringify_mock():
|
||||
with mock(['unknown']):
|
||||
import unknown
|
||||
assert stringify(unknown.secret.Class) == 'unknown.secret.Class'
|
||||
assert stringify(unknown.secret.Class, False) == 'unknown.secret.Class'
|
||||
assert stringify(unknown.secret.Class, True) == 'unknown.secret.Class'
|
||||
|
||||
Reference in New Issue
Block a user