mypy.stubgen.StubGenerator

class documentation

class StubGenerator(mypy.traverser.TraverserVisitor): (source)

Generate stub text from a mypy AST.

Method	`__init__`	Undocumented
Method	`add`	Add text to generated stub.
Method	`add_abc_import`	Add a name to be imported from collections.abc, unless it's imported already.
Method	`add_coroutine_decorator`	Undocumented
Method	`add_decorator`	Undocumented
Method	`add_import_line`	Add a line of text to the import section, unless it's already there.
Method	`add_typing_import`	Add a name to be imported from typing, unless it's imported already.
Method	`clear_decorators`	Undocumented
Method	`get_base_types`	Get list of base classes for a class.
Method	`get_init`	Return initializer for a variable.
Method	`get_str_type_of_node`	Undocumented
Method	`is_alias_expression`	Return True for things that look like target for an alias.
Method	`is_namedtuple`	Undocumented
Method	`is_none_expr`	Undocumented
Method	`is_not_in_all`	Undocumented
Method	`is_private_member`	Undocumented
Method	`is_private_name`	Undocumented
Method	`is_recorded_name`	Has this name been recorded previously?
Method	`is_top_level`	Are we processing the top level of a file?
Method	`output`	Return the text for the stub.
Method	`print_annotation`	Undocumented
Method	`process_decorator`	Process a series of decorators.
Method	`process_member_expr_decorator`	Process a function decorator of form @foo.bar.
Method	`process_name_expr_decorator`	Process a function decorator of form @foo.
Method	`process_namedtuple`	Undocumented
Method	`process_typealias`	Undocumented
Method	`record_name`	Mark a name as defined.
Method	`refers_to_fullname`	Undocumented
Method	`typing_name`	Undocumented
Method	`visit_assignment_stmt`	Undocumented
Method	`visit_block`	Undocumented
Method	`visit_class_def`	Undocumented
Method	`visit_decorator`	Undocumented
Method	`visit_func_def`	Undocumented
Method	`visit_if_stmt`	Undocumented
Method	`visit_import`	Undocumented
Method	`visit_import_all`	Undocumented
Method	`visit_import_from`	Undocumented
Method	`visit_mypy_file`	Undocumented
Method	`visit_overloaded_func_def`	@property with setters and getters, or @overload chain
Instance Variable	`analyzed`	Undocumented
Instance Variable	`defined_names`	Undocumented
Instance Variable	`export_less`	Undocumented
Instance Variable	`import_tracker`	Undocumented
Instance Variable	`method_names`	Undocumented
Instance Variable	`module`	Undocumented
Instance Variable	`path`	Undocumented
Instance Variable	`referenced_names`	Undocumented
Instance Variable	`_all_`	Undocumented
Instance Variable	`_decorators`	Undocumented
Instance Variable	`_import_lines`	Undocumented
Instance Variable	`_include_private`	Undocumented
Instance Variable	`_indent`	Undocumented
Instance Variable	`_output`	Undocumented
Instance Variable	`_pyversion`	Undocumented
Instance Variable	`_state`	Undocumented
Instance Variable	`_toplevel_names`	Undocumented
Instance Variable	`_vars`	Undocumented

Inherited from TraverserVisitor:

Method	`visit_assert_stmt`	Undocumented
Method	`visit_assignment_expr`	Undocumented
Method	`visit_await_expr`	Undocumented
Method	`visit_backquote_expr`	Undocumented
Method	`visit_call_expr`	Undocumented
Method	`visit_cast_expr`	Undocumented
Method	`visit_comparison_expr`	Undocumented
Method	`visit_conditional_expr`	Undocumented
Method	`visit_del_stmt`	Undocumented
Method	`visit_dict_expr`	Undocumented
Method	`visit_dictionary_comprehension`	Undocumented
Method	`visit_exec_stmt`	Undocumented
Method	`visit_expression_stmt`	Undocumented
Method	`visit_for_stmt`	Undocumented
Method	`visit_func`	Undocumented
Method	`visit_generator_expr`	Undocumented
Method	`visit_index_expr`	Undocumented
Method	`visit_lambda_expr`	Undocumented
Method	`visit_list_comprehension`	Undocumented
Method	`visit_list_expr`	Undocumented
Method	`visit_member_expr`	Undocumented
Method	`visit_op_expr`	Undocumented
Method	`visit_operator_assignment_stmt`	Undocumented
Method	`visit_print_stmt`	Undocumented
Method	`visit_raise_stmt`	Undocumented
Method	`visit_return_stmt`	Undocumented
Method	`visit_reveal_expr`	Undocumented
Method	`visit_set_comprehension`	Undocumented
Method	`visit_set_expr`	Undocumented
Method	`visit_slice_expr`	Undocumented
Method	`visit_star_expr`	Undocumented
Method	`visit_super_expr`	Undocumented
Method	`visit_try_stmt`	Undocumented
Method	`visit_tuple_expr`	Undocumented
Method	`visit_type_application`	Undocumented
Method	`visit_unary_expr`	Undocumented
Method	`visit_while_stmt`	Undocumented
Method	`visit_with_stmt`	Undocumented
Method	`visit_yield_expr`	Undocumented
Method	`visit_yield_from_expr`	Undocumented

def __init__(self, _all_, pyversion, include_private=False, analyzed=False, export_less=False): (source)

overrides mypy.traverser.TraverserVisitor.__init__

Undocumented

Parameters
_all_:`Optional[List[str]]`	Undocumented
pyversion:`Tuple[int, int]`	Undocumented
include_private:`bool`	Undocumented
analyzed:`bool`	Undocumented
export_less:`bool`	Undocumented

def add(self, string): (source)

Add text to generated stub.

Parameters
string:`str`	Undocumented

def add_abc_import(self, name): (source)

Add a name to be imported from collections.abc, unless it's imported already.

The import will be internal to the stub.

Parameters
name:`str`	Undocumented

def add_coroutine_decorator(self, func, name, require_name): (source)

Undocumented

Parameters
func:`FuncDef`	Undocumented
name:`str`	Undocumented
require_name:`str`	Undocumented

def add_decorator(self, name): (source)

Undocumented

Parameters
name:`str`	Undocumented

def add_import_line(self, line): (source)

Add a line of text to the import section, unless it's already there.

Parameters
line:`str`	Undocumented

def add_typing_import(self, name): (source)

Add a name to be imported from typing, unless it's imported already.

The import will be internal to the stub.

Parameters
name:`str`	Undocumented

def clear_decorators(self): (source)

Undocumented

def get_base_types(self, cdef): (source)

Get list of base classes for a class.

Parameters
cdef:`ClassDef`	Undocumented
Returns
`List[str]`	Undocumented

def get_init(self, lvalue, rvalue, annotation=None): (source)

Return initializer for a variable.

Return None if we've generated one already or if the variable is internal.

Parameters
lvalue:`str`	Undocumented
rvalue:`Expression`	Undocumented
annotation:`Optional[Type]`	Undocumented
Returns
`Optional[str]`	Undocumented

def get_str_type_of_node(self, rvalue, can_infer_optional=False, can_be_any=True): (source)

Undocumented

Parameters
rvalue:`Expression`	Undocumented
can_infer_optional:`bool`	Undocumented
can_be_any:`bool`	Undocumented
Returns
`str`	Undocumented

def is_alias_expression(self, expr, top_level=True): (source)

Return True for things that look like target for an alias.

Used to know if assignments look like type aliases, function alias, or module alias.

Parameters
expr:`Expression`	Undocumented
top_level:`bool`	Undocumented
Returns
`bool`	Undocumented

def is_namedtuple(self, expr): (source)

Undocumented

Parameters
expr:`Expression`	Undocumented
Returns
`bool`	Undocumented

def is_none_expr(self, expr): (source)

Undocumented

Parameters
expr:`Expression`	Undocumented
Returns
`bool`	Undocumented

def is_not_in_all(self, name): (source)

Undocumented

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

def is_private_member(self, fullname): (source)

Undocumented

Parameters
fullname:`str`	Undocumented
Returns
`bool`	Undocumented

def is_private_name(self, name, fullname=None): (source)

Undocumented

Parameters
name:`str`	Undocumented
fullname:`Optional[str]`	Undocumented
Returns
`bool`	Undocumented

def is_recorded_name(self, name): (source)

Has this name been recorded previously?

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

def is_top_level(self): (source)

Are we processing the top level of a file?

Returns
`bool`	Undocumented

def output(self): (source)

Return the text for the stub.

Returns
`str`	Undocumented

def print_annotation(self, t): (source)

Undocumented

Parameters
t:`Type`	Undocumented
Returns
`str`	Undocumented

def process_decorator(self, o): (source)

Process a series of decorators.

Only preserve certain special decorators such as @abstractmethod.

Return a pair of booleans: - True if any of the decorators makes a method abstract. - True if any of the decorators is typing.overload.

Parameters
o:`Decorator`	Undocumented
Returns
`Tuple[bool, bool]`	Undocumented

def process_member_expr_decorator(self, expr, context): (source)

Process a function decorator of form @foo.bar.

Only preserve certain special decorators such as @abstractmethod.

Return a pair of booleans: - True if the decorator makes a method abstract. - True if the decorator is typing.overload.

Parameters
expr:`MemberExpr`	Undocumented
context:`Decorator`	Undocumented
Returns
`Tuple[bool, bool]`	Undocumented

def process_name_expr_decorator(self, expr, context): (source)

Process a function decorator of form @foo.

Only preserve certain special decorators such as @abstractmethod.

Return a pair of booleans: - True if the decorator makes a method abstract. - True if the decorator is typing.overload.

Parameters
expr:`NameExpr`	Undocumented
context:`Decorator`	Undocumented
Returns
`Tuple[bool, bool]`	Undocumented

def process_namedtuple(self, lvalue, rvalue): (source)

Undocumented

Parameters
lvalue:`NameExpr`	Undocumented
rvalue:`CallExpr`	Undocumented

def process_typealias(self, lvalue, rvalue): (source)

Undocumented

Parameters
lvalue:`NameExpr`	Undocumented
rvalue:`Expression`	Undocumented

def record_name(self, name): (source)

Mark a name as defined.

This only does anything if at the top level of a module.

Parameters
name:`str`	Undocumented

def refers_to_fullname(self, name, fullname): (source)

Undocumented

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

def typing_name(self, name): (source)

Undocumented

Parameters
name:`str`	Undocumented
Returns
`str`	Undocumented

def visit_assignment_stmt(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_assignment_stmt

Undocumented

Parameters
o:`AssignmentStmt`	Undocumented

def visit_block(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_block

Undocumented

Parameters
o:`Block`	Undocumented

def visit_class_def(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_class_def

Undocumented

Parameters
o:`ClassDef`	Undocumented

def visit_decorator(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_decorator

Undocumented

Parameters
o:`Decorator`	Undocumented

def visit_func_def(self, o, is_abstract=False, is_overload=False): (source)

overrides mypy.traverser.TraverserVisitor.visit_func_def

Undocumented

Parameters
o:`FuncDef`	Undocumented
is_abstract:`bool`	Undocumented
is_overload:`bool`	Undocumented

def visit_if_stmt(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_if_stmt

Undocumented

Parameters
o:`IfStmt`	Undocumented

def visit_import(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_import

Undocumented

Parameters
o:`Import`	Undocumented

def visit_import_all(self, o): (source)

Undocumented

Parameters
o:`ImportAll`	Undocumented

def visit_import_from(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_import_from

Undocumented

Parameters
o:`ImportFrom`	Undocumented

def visit_mypy_file(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_mypy_file

Undocumented

Parameters
o:`MypyFile`	Undocumented

def visit_overloaded_func_def(self, o): (source)

overrides mypy.traverser.TraverserVisitor.visit_overloaded_func_def

@property with setters and getters, or @overload chain

Parameters
o:`OverloadedFuncDef`	Undocumented

analyzed = (source)

Undocumented

defined_names = (source)

Undocumented

export_less = (source)

Undocumented

import_tracker = (source)

Undocumented

method_names = (source)

Undocumented

module = (source)

Undocumented

path = (source)

Undocumented

referenced_names = (source)

Undocumented

_all_ = (source)

Undocumented

_decorators: List[str] = (source)

Undocumented

_import_lines: List[str] = (source)

Undocumented

_include_private = (source)

Undocumented

_indent = (source)

Undocumented

_output: List[str] = (source)

Undocumented

_pyversion = (source)

Undocumented

_state = (source)

Undocumented

_toplevel_names: List[str] = (source)

Undocumented

_vars: List[List[str]] = (source)

Undocumented