IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add some comments for Union types in `sphinx.util.typing` (#12281)

Browse Source
This commit is contained in:
Bénédikt Tran 2024-04-23 00:27:42 +02:00 committed by GitHub
parent 48a345b7c5
commit a5f534a77d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
sphinx/util/typing.py
View File

@ -186,6 +186,8 @@ def restify(cls: type | None, mode: str = 'fully-qualified-except-typing') -> st
else: else:
return f':py:class:`{cls.__name__}`' return f':py:class:`{cls.__name__}`'
elif UnionType and isinstance(cls, UnionType): elif UnionType and isinstance(cls, UnionType):
# Union types (PEP 585) retain their definition order when they
# are printed natively and ``None``-like types are kept as is.
return ' | '.join(restify(a, mode) for a in cls.__args__) return ' | '.join(restify(a, mode) for a in cls.__args__)
elif cls.__module__ in ('__builtin__', 'builtins'): elif cls.__module__ in ('__builtin__', 'builtins'):
if hasattr(cls, '__args__'): if hasattr(cls, '__args__'):
@ -199,6 +201,7 @@ def restify(cls: type | None, mode: str = 'fully-qualified-except-typing') -> st
elif (inspect.isgenericalias(cls) elif (inspect.isgenericalias(cls)
and cls.__module__ == 'typing' and cls.__module__ == 'typing'
and cls.__origin__ is Union): # type: ignore[attr-defined] and cls.__origin__ is Union): # type: ignore[attr-defined]
# *cls* is defined in ``typing``, and thus ``__args__`` must exist
return ' | '.join(restify(a, mode) for a in cls.__args__) # type: ignore[attr-defined] return ' | '.join(restify(a, mode) for a in cls.__args__) # type: ignore[attr-defined]
elif inspect.isgenericalias(cls): elif inspect.isgenericalias(cls):
if isinstance(cls.__origin__, typing._SpecialForm): # type: ignore[attr-defined] if isinstance(cls.__origin__, typing._SpecialForm): # type: ignore[attr-defined]