sphinx.util.typing

module documentation
(source)

The composite types for Sphinx.

Function get_type_hints Return a dictionary containing type hints for a function, method, module or class object.
Function is_invalid_builtin_class Check *obj* is an invalid built-in class.
Function is_system_TypeVar Check *typ* is system defined TypeVar.
Function restify Convert python class to a reST reference.
Function stringify_annotation Stringify type annotation object.
Constant INVALID_BUILTIN_CLASSES Undocumented
Type Alias Inventory Undocumented
Type Alias InventoryItem Undocumented
Type Alias OptionSpec Undocumented
Type Alias PathMatcher Undocumented
Type Alias RoleFunction Undocumented
Type Alias TextlikeNode Undocumented
Type Alias TitleGetter Undocumented
Variable NoneType Undocumented
def get_type_hints(obj, globalns=None, localns=None): (source)

Return a dictionary containing type hints for a function, method, module or class object. This is a simple wrapper of `typing.get_type_hints()` that does not raise an error on runtime.

Parameters
obj:AnyUndocumented
globalns:dict[str, Any]|NoneUndocumented
localns:dict|NoneUndocumented
Returns
dict[str, Any]Undocumented
def is_invalid_builtin_class(obj): (source)

Check *obj* is an invalid built-in class.

Parameters
obj:AnyUndocumented
Returns
boolUndocumented
def is_system_TypeVar(typ): (source)

Check *typ* is system defined TypeVar.

Parameters
typ:AnyUndocumented
Returns
boolUndocumented
def restify(cls, mode='fully-qualified-except-typing'): (source)

Convert python class to a reST reference. :param mode: Specify a method how annotations will be stringified. 'fully-qualified-except-typing' Show the module name and qualified name of the annotation except the "typing" module. 'smart' Show the name of the annotation.

Parameters
cls:type|NoneUndocumented
mode:strUndocumented
Returns
strUndocumented
def stringify_annotation(annotation, /, mode='fully-qualified-except-typing'): (source)

Stringify type annotation object. :param annotation: The annotation to stringified. :param mode: Specify a method how annotations will be stringified. 'fully-qualified-except-typing' Show the module name and qualified name of the annotation except the "typing" module. 'smart' Show the name of the annotation. 'fully-qualified' Show the module name and qualified name of the annotation.

Parameters
annotation:AnyUndocumented
mode:strUndocumented
Returns
strUndocumented
INVALID_BUILTIN_CLASSES = (source)

Undocumented

Value
{Struct: 'struct.Struct', TracebackType: 'types.TracebackType'}
Inventory = (source)

Undocumented

Value
Dict[str, Dict[str, InventoryItem]]
InventoryItem = (source)

Undocumented

Value
Tuple[str, str, str, str]
OptionSpec = (source)

Undocumented

Value
Dict[str, Callable[[str], Any]]
PathMatcher = (source)

Undocumented

Value
Callable[[str], bool]
RoleFunction = (source)

Undocumented

Value
Callable[[str, str, str, int, Inliner, Dict[str, Any], List[str]],
         Tuple[List[nodes.Node], List[nodes.system_message]]]
TextlikeNode = (source)

Undocumented

Value
Union[nodes.Text, nodes.TextElement]
TitleGetter = (source)

Undocumented

Value
Callable[[nodes.Node], str]
NoneType = (source)

Undocumented