sphinx.util.typing

module documentation

The composite types for Sphinx.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Constant	`INVALID_BUILTIN_CLASSES`	Undocumented
Variable	`Inventory`	Undocumented
Variable	`InventoryItem`	Undocumented
Variable	`NoneType`	Undocumented
Variable	`OptionSpec`	Undocumented
Variable	`PathMatcher`	Undocumented
Variable	`RoleFunction`	Undocumented
Variable	`TextlikeNode`	Undocumented
Variable	`TitleGetter`	Undocumented
Variable	`UnionType`	Undocumented
Function	`_restify_py36`	Undocumented
Function	`_restify_py37`	Convert python class to a reST reference.
Function	`_stringify_py36`	stringify() for py36.
Function	`_stringify_py37`	stringify() for py37+.
Function	`get_type_hints`	Return a dictionary containing type hints for a function, method, module or class object.
Function	`is_system_TypeVar`	Check typ is system defined TypeVar.
Function	`restify`	Convert python class to a reST reference.
Function	`stringify`	Stringify type annotation object.

INVALID_BUILTIN_CLASSES =

Undocumented

Value

{Struct: 'struct.Struct', TracebackType: 'types.TracebackType'}

Inventory =

Undocumented

InventoryItem =

Undocumented

NoneType =

Undocumented

OptionSpec =

Undocumented

PathMatcher =

Undocumented

RoleFunction =

Undocumented

TextlikeNode =

Undocumented

TitleGetter =

Undocumented

UnionType =

Undocumented

def _restify_py36(cls, mode='fully-qualified-except-typing'):

Undocumented

Parameters
mode:`str`	Undocumented
Returns
`str`	Undocumented

def _restify_py37(cls, mode='fully-qualified-except-typing'):

Convert python class to a reST reference.

Parameters
mode:`str`	Undocumented
Returns
`str`	Undocumented

def _stringify_py36(annotation, mode='fully-qualified-except-typing'):

stringify() for py36.

Parameters
annotation:`Any`	Undocumented
mode:`str`	Undocumented
Returns
`str`	Undocumented

def _stringify_py37(annotation, mode='fully-qualified-except-typing'):

stringify() for py37+.

Parameters
annotation:`Any`	Undocumented
mode:`str`	Undocumented
Returns
`str`	Undocumented

def get_type_hints(obj, globalns=None, localns=None):

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:`Any`	Undocumented
globalns:`Dict`	Undocumented
localns:`Dict`	Undocumented
Returns
`Dict[str, Any]`	Undocumented

def is_system_TypeVar(typ):

Check typ is system defined TypeVar.

Parameters
typ:`Any`	Undocumented
Returns
`bool`	Undocumented

def restify(cls, mode='fully-qualified-except-typing'):

Convert python class to a reST reference.

Parameters
mode:`str`	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.
Returns
`str`	Undocumented

def stringify(annotation, mode='fully-qualified-except-typing'):

Stringify type annotation object.

Parameters
annotation:`Any`	Undocumented
mode:`str`	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.
Returns
`str`	Undocumented