mypy.stubgen.StubGenerator

class documentation

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

View In Hierarchy

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 _state Undocumented
Instance Variable _toplevel_names Undocumented
Instance Variable _vars Undocumented

Inherited from TraverserVisitor:

Method visit_as_pattern Undocumented
Method visit_assert_stmt Undocumented
Method visit_assert_type_expr Undocumented
Method visit_assignment_expr Undocumented
Method visit_await_expr Undocumented
Method visit_call_expr Undocumented
Method visit_cast_expr Undocumented
Method visit_class_pattern 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_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_mapping_pattern Undocumented
Method visit_match_stmt Undocumented
Method visit_member_expr Undocumented
Method visit_op_expr Undocumented
Method visit_operator_assignment_stmt Undocumented
Method visit_or_pattern Undocumented
Method visit_raise_stmt Undocumented
Method visit_return_stmt Undocumented
Method visit_reveal_expr Undocumented
Method visit_sequence_pattern Undocumented
Method visit_set_comprehension Undocumented
Method visit_set_expr Undocumented
Method visit_slice_expr Undocumented
Method visit_star_expr Undocumented
Method visit_starred_pattern 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_value_pattern Undocumented
Method visit_while_stmt Undocumented
Method visit_with_stmt Undocumented
Method visit_yield_expr Undocumented
Method visit_yield_from_expr Undocumented

Inherited from NodeVisitor (via TraverserVisitor):

Method visit__promote_expr Undocumented
Method visit_break_stmt Undocumented
Method visit_bytes_expr Undocumented
Method visit_complex_expr Undocumented
Method visit_continue_stmt Undocumented
Method visit_ellipsis Undocumented
Method visit_enum_call_expr Undocumented
Method visit_float_expr Undocumented
Method visit_global_decl Undocumented
Method visit_int_expr Undocumented
Method visit_name_expr Undocumented
Method visit_namedtuple_expr Undocumented
Method visit_newtype_expr Undocumented
Method visit_nonlocal_decl Undocumented
Method visit_paramspec_expr Undocumented
Method visit_pass_stmt Undocumented
Method visit_placeholder_node Undocumented
Method visit_singleton_pattern Undocumented
Method visit_str_expr Undocumented
Method visit_temp_node Undocumented
Method visit_type_alias Undocumented
Method visit_type_alias_expr Undocumented
Method visit_type_var_expr Undocumented
Method visit_type_var_tuple_expr Undocumented
Method visit_typeddict_expr Undocumented
Method visit_var Undocumented
def __init__(self, _all_: list[str]|None, include_private: bool = False, analyzed: bool = False, export_less: bool = False): (source)
overrides mypy.traverser.TraverserVisitor.__init__

Undocumented

def add(self, string: str): (source)

Add text to generated stub.

def add_abc_import(self, name: str): (source)

Add a name to be imported from collections.abc, unless it's imported already. The import will be internal to the stub.

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

Undocumented

def add_decorator(self, name: str): (source)

Undocumented

def add_import_line(self, line: str): (source)

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

def add_typing_import(self, name: str): (source)

Add a name to be imported from typing, unless it's imported already. The import will be internal to the stub.

def clear_decorators(self): (source)

Undocumented

def get_base_types(self, cdef: ClassDef) -> list[str]: (source)

Get list of base classes for a class.

def get_init(self, lvalue: str, rvalue: Expression, annotation: Type|None = None) -> str|None: (source)

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

def get_str_type_of_node(self, rvalue: Expression, can_infer_optional: bool = False, can_be_any: bool = True) -> str: (source)

Undocumented

def is_alias_expression(self, expr: Expression, top_level: bool = True) -> bool: (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.

def is_namedtuple(self, expr: Expression) -> bool: (source)

Undocumented

def is_none_expr(self, expr: Expression) -> bool: (source)

Undocumented

def is_not_in_all(self, name: str) -> bool: (source)

Undocumented

def is_private_member(self, fullname: str) -> bool: (source)

Undocumented

def is_private_name(self, name: str, fullname: str|None = None) -> bool: (source)

Undocumented

def is_recorded_name(self, name: str) -> bool: (source)

Has this name been recorded previously?

def is_top_level(self) -> bool: (source)

Are we processing the top level of a file?

def output(self) -> str: (source)

Return the text for the stub.

def print_annotation(self, t: Type) -> str: (source)

Undocumented

def process_decorator(self, o: Decorator) -> tuple[bool, bool]: (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.

def process_member_expr_decorator(self, expr: MemberExpr, context: Decorator) -> tuple[bool, bool]: (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.

def process_name_expr_decorator(self, expr: NameExpr, context: Decorator) -> tuple[bool, bool]: (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.

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

Undocumented

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

Undocumented

def record_name(self, name: str): (source)

Mark a name as defined. This only does anything if at the top level of a module.

def refers_to_fullname(self, name: str, fullname: str|tuple[str, ...]) -> bool: (source)

Undocumented

def typing_name(self, name: str) -> str: (source)

Undocumented

def visit_assignment_stmt(self, o: AssignmentStmt): (source)
overrides mypy.traverser.TraverserVisitor.visit_assignment_stmt

Undocumented

def visit_block(self, o: Block): (source)
overrides mypy.traverser.TraverserVisitor.visit_block

Undocumented

def visit_class_def(self, o: ClassDef): (source)
overrides mypy.traverser.TraverserVisitor.visit_class_def

Undocumented

def visit_decorator(self, o: Decorator): (source)
overrides mypy.traverser.TraverserVisitor.visit_decorator

Undocumented

def visit_func_def(self, o: FuncDef, is_abstract: bool = False, is_overload: bool = False): (source)
overrides mypy.traverser.TraverserVisitor.visit_func_def

Undocumented

def visit_if_stmt(self, o: IfStmt): (source)
overrides mypy.traverser.TraverserVisitor.visit_if_stmt

Undocumented

def visit_import(self, o: Import): (source)
overrides mypy.traverser.TraverserVisitor.visit_import

Undocumented

def visit_import_all(self, o: ImportAll): (source)
overrides mypy.visitor.NodeVisitor.visit_import_all

Undocumented

def visit_import_from(self, o: ImportFrom): (source)
overrides mypy.traverser.TraverserVisitor.visit_import_from

Undocumented

def visit_mypy_file(self, o: MypyFile): (source)
overrides mypy.traverser.TraverserVisitor.visit_mypy_file

Undocumented

def visit_overloaded_func_def(self, o: OverloadedFuncDef): (source)
overrides mypy.traverser.TraverserVisitor.visit_overloaded_func_def

@property with setters and getters, or @overload chain

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

_state = (source)

Undocumented

_toplevel_names: list[str] = (source)

Undocumented

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

Undocumented