mypy.stubgenc

module documentation

(source)

Stub generator for C modules.

The public interface is via the mypy.stubgen module.

Function	`add_typing_import`	Add typing imports for collections/types that occur in the generated stub.
Function	`generate_c_function_stub`	Generate stub for a single function or method.
Function	`generate_c_property_stub`	Generate property stub using introspection of 'obj'.
Function	`generate_c_type_stub`	Generate stub for a single class using runtime introspection.
Function	`generate_stub_for_c_module`	Generate stub for C module.
Function	`get_type_fullname`	Undocumented
Function	`infer_method_sig`	Undocumented
Function	`is_c_classmethod`	Undocumented
Function	`is_c_function`	Undocumented
Function	`is_c_method`	Undocumented
Function	`is_c_property`	Undocumented
Function	`is_c_property_readonly`	Undocumented
Function	`is_c_type`	Undocumented
Function	`is_pybind11_overloaded_function_docstring`	Undocumented
Function	`is_pybind_skipped_attribute`	Undocumented
Function	`is_skipped_attribute`	Undocumented
Function	`is_static_property`	Undocumented
Function	`method_name_sort_key`	Sort methods in classes in a typical order.
Function	`strip_or_import`	Strips unnecessary module names from typ.
Constant	`_DEFAULT_TYPING_IMPORTS`	Undocumented

def add_typing_import(output): (source)

Add typing imports for collections/types that occur in the generated stub.

Parameters
output:`List[str]`	Undocumented
Returns
`List[str]`	Undocumented

def generate_c_function_stub(module, name, obj, output, imports, self_var=None, sigs=None, class_name=None, class_sigs=None): (source)

Generate stub for a single function or method.

The result (always a single line) will be appended to 'output'. If necessary, any required names will be added to 'imports'. The 'class_name' is used to find signature of __init__ or __new__ in 'class_sigs'.

Parameters
module:`ModuleType`	Undocumented
name:`str`	Undocumented
obj:`object`	Undocumented
output:`List[str]`	Undocumented
imports:`List[str]`	Undocumented
self_var:`Optional[str]`	Undocumented
sigs:`Optional[Dict[str, str]]`	Undocumented
class_name:`Optional[str]`	Undocumented
class_sigs:`Optional[Dict[str, str]]`	Undocumented

def generate_c_property_stub(name, obj, static_properties, rw_properties, ro_properties, readonly, module=None, imports=None): (source)

Generate property stub using introspection of 'obj'.

Try to infer type from docstring, append resulting lines to 'output'.

Parameters
name:`str`	Undocumented
obj:`object`	Undocumented
static_properties:`List[str]`	Undocumented
rw_properties:`List[str]`	Undocumented
ro_properties:`List[str]`	Undocumented
readonly:`bool`	Undocumented
module:`Optional[ModuleType]`	Undocumented
imports:`Optional[List[str]]`	Undocumented

def generate_c_type_stub(module, class_name, obj, output, imports, sigs=None, class_sigs=None): (source)

Generate stub for a single class using runtime introspection.

The result lines will be appended to 'output'. If necessary, any required names will be added to 'imports'.

Parameters
module:`ModuleType`	Undocumented
class_name:`str`	Undocumented
obj:`type`	Undocumented
output:`List[str]`	Undocumented
imports:`List[str]`	Undocumented
sigs:`Optional[Dict[str, str]]`	Undocumented
class_sigs:`Optional[Dict[str, str]]`	Undocumented

def generate_stub_for_c_module(module_name, target, sigs=None, class_sigs=None): (source)

Generate stub for C module.

This combines simple runtime introspection (looking for docstrings and attributes with simple builtin types) and signatures inferred from .rst documentation (if given).

If directory for target doesn't exist it will be created. Existing stub will be overwritten.

Parameters
module_name:`str`	Undocumented
target:`str`	Undocumented
sigs:`Optional[Dict[str, str]]`	Undocumented
class_sigs:`Optional[Dict[str, str]]`	Undocumented

def get_type_fullname(typ): (source)

Undocumented

Parameters
typ:`type`	Undocumented
Returns
`str`	Undocumented

def infer_method_sig(name, self_var=None): (source)

Undocumented

Parameters
name:`str`	Undocumented
self_var:`Optional[str]`	Undocumented
Returns
`List[ArgSig]`	Undocumented

def is_c_classmethod(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`bool`	Undocumented

def is_c_function(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`bool`	Undocumented

def is_c_method(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`bool`	Undocumented

def is_c_property(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`bool`	Undocumented

def is_c_property_readonly(prop): (source)

Undocumented

Parameters
prop:`Any`	Undocumented
Returns
`bool`	Undocumented

def is_c_type(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`bool`	Undocumented

def is_pybind11_overloaded_function_docstring(docstr, name): (source)

Undocumented

Parameters
docstr:`str`	Undocumented
name:`str`	Undocumented
Returns
`bool`	Undocumented

def is_pybind_skipped_attribute(attr): (source)

Undocumented

Parameters
attr:`str`	Undocumented
Returns
`bool`	Undocumented

def is_skipped_attribute(attr): (source)

Undocumented

Parameters
attr:`str`	Undocumented
Returns
`bool`	Undocumented

def is_static_property(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`bool`	Undocumented

def method_name_sort_key(name): (source)

Sort methods in classes in a typical order.

I.e.: constructor, normal methods, special methods.

Parameters
name:`str`	Undocumented
Returns
`Tuple[int, str]`	Undocumented

def strip_or_import(typ, module, imports): (source)

Strips unnecessary module names from typ.

If typ represents a type that is inside module or is a type coming from builtins, remove module declaration from it. Return stripped name of the type.

Arguments:: typ: name of the type module: in which this type is used imports: list of import statements (may be modified during the call)

Parameters
typ:`str`	Undocumented
module:`ModuleType`	Undocumented
imports:`List[str]`	Undocumented
Returns
`str`	Undocumented

_DEFAULT_TYPING_IMPORTS: tuple[str, ...] = (source)

Undocumented

Value

('Any',
 'Callable',
 'ClassVar',
 'Dict',
 'Iterable',
 'Iterator',
 'List',
...