mypy.suggestions.SuggestionEngine

class documentation

class SuggestionEngine: (source)

Engine for finding call sites and suggesting signatures.

Method	`__init__`	Undocumented
Method	`add_adjustments`	Undocumented
Method	`ensure_loaded`	Make sure that the module represented by state is fully loaded.
Method	`extract_from_decorator`	Undocumented
Method	`filter_options`	Apply any configured filters to the possible guesses.
Method	`find_best`	From a list of possible function types, find the best one.
Method	`find_node`	From a target name, return module/target names and the func def.
Method	`find_node_by_file_and_line`	Find symbol node by path to file and line number.
Method	`find_node_by_module_and_name`	Find symbol node by module id and qualified name.
Method	`format_args`	Undocumented
Method	`format_signature`	Format a callable type in a way suitable as an annotation... kind of
Method	`format_type`	Undocumented
Method	`get_args`	Produce a list of type suggestions for each argument type.
Method	`get_callsites`	Find all call sites of a function.
Method	`get_default_arg_types`	Undocumented
Method	`get_guesses`	Compute a list of guesses for a function's type.
Method	`get_guesses_from_parent`	Try to get a guess of a method type from a parent class.
Method	`get_starting_type`	Undocumented
Method	`get_suggestion`	Compute a suggestion for a function.
Method	`get_trivial_type`	Generate a trivial callable type from a func def, with all Anys
Method	`json_suggestion`	Produce a json blob for a suggestion suitable for application by pyannotate.
Method	`named_type`	Undocumented
Method	`pyannotate_signature`	Format a callable type as a pyannotate dict
Method	`reload`	Recheck the module given by state.
Method	`restore_after`	Context manager that reloads a module after executing the body.
Method	`score_callable`	Undocumented
Method	`score_type`	Generate a score for a type that we use to pick which type to use.
Method	`suggest`	Suggest an inferred type for function.
Method	`suggest_callsites`	Find a list of call sites of function.
Method	`try_type`	Recheck a function while assuming it has type typ.
Method	`with_export_types`	Context manager that enables the export_types flag in the body.
Instance Variable	`fgmanager`	Undocumented
Instance Variable	`finder`	Undocumented
Instance Variable	`flex_any`	Undocumented
Instance Variable	`give_json`	Undocumented
Instance Variable	`graph`	Undocumented
Instance Variable	`manager`	Undocumented
Instance Variable	`max_guesses`	Undocumented
Instance Variable	`no_errors`	Undocumented
Instance Variable	`plugin`	Undocumented
Instance Variable	`try_text`	Undocumented
Instance Variable	`use_fixme`	Undocumented

def __init__(self, fgmanager, *, json, no_errors=False, no_any=False, try_text=False, flex_any=None, use_fixme=None, max_guesses=None): (source)

Undocumented

Parameters
fgmanager:`FineGrainedBuildManager`	Undocumented
json:`bool`	Undocumented
no_errors:`bool`	Undocumented
no_any:`bool`	Undocumented
try_text:`bool`	Undocumented
flex_any:`Optional[float]`	Undocumented
use_fixme:`Optional[str]`	Undocumented
max_guesses:`Optional[int]`	Undocumented

def add_adjustments(self, typs): (source)

Undocumented

Parameters
typs:`List[Type]`	Undocumented
Returns
`List[Type]`	Undocumented

def ensure_loaded(self, state, force=False): (source)

Make sure that the module represented by state is fully loaded.

Parameters
state:`State`	Undocumented
force:`bool`	Undocumented
Returns
`MypyFile`	Undocumented

def extract_from_decorator(self, node): (source)

Undocumented

Parameters
node:`Decorator`	Undocumented
Returns
`Optional[FuncDef]`	Undocumented

def filter_options(self, guesses, is_method, ignore_return): (source)

Apply any configured filters to the possible guesses.

Currently the only option is filtering based on Any prevalance.

Parameters
guesses:`List[CallableType]`	Undocumented
is_method:`bool`	Undocumented
ignore_return:`bool`	Undocumented
Returns
`List[CallableType]`	Undocumented

def find_best(self, func, guesses): (source)

From a list of possible function types, find the best one.

For best, we want the fewest errors, then the best "score" from score_callable.

Parameters
func:`FuncDef`	Undocumented
guesses:`List[CallableType]`	Undocumented
Returns
`Tuple[CallableType, int]`	Undocumented

def find_node(self, key): (source)

From a target name, return module/target names and the func def.

The 'key' argument can be in one of two formats: * As the function full name, e.g., package.module.Cls.method * As the function location as file and line separated by column,

e.g., path/to/file.py:42

Parameters
key:`str`	Undocumented
Returns
`Tuple[str, str, FuncDef]`	Undocumented

def find_node_by_file_and_line(self, file, line): (source)

Find symbol node by path to file and line number.

Find the first function declared before or on the line number.

Return module id and the node found. Raise SuggestionFailure if can't find one.

Parameters
file:`str`	Undocumented
line:`int`	Undocumented
Returns
`Tuple[str, SymbolNode]`	Undocumented

def find_node_by_module_and_name(self, modname, tail): (source)

Find symbol node by module id and qualified name.

Raise SuggestionFailure if can't find one.

Parameters
modname:`str`	Undocumented
tail:`str`	Undocumented
Returns
`Optional[SymbolNode]`	Undocumented

def format_args(self, arg_kinds, arg_names, arg_types): (source)

Undocumented

Parameters
arg_kinds:`List[List[ArgKind]]`	Undocumented
arg_names:`List[List[Optional[str]]]`	Undocumented
arg_types:`List[List[Type]]`	Undocumented
Returns
`str`	Undocumented

def format_signature(self, sig): (source)

Format a callable type in a way suitable as an annotation... kind of

Parameters
sig:`PyAnnotateSignature`	Undocumented
Returns
`str`	Undocumented

def format_type(self, cur_module, typ): (source)

Undocumented

Parameters
cur_module:`Optional[str]`	Undocumented
typ:`Type`	Undocumented
Returns
`str`	Undocumented

def get_args(self, is_method, base, defaults, callsites, uses): (source)

Produce a list of type suggestions for each argument type.

Parameters
is_method:`bool`	Undocumented
base:`CallableType`	Undocumented
defaults:`List[Optional[Type]]`	Undocumented
callsites:`List[Callsite]`	Undocumented
uses:`List[List[Type]]`	Undocumented
Returns
`List[List[Type]]`	Undocumented

def get_callsites(self, func): (source)

Find all call sites of a function.

Parameters
func:`FuncDef`	Undocumented
Returns
`Tuple[List[Callsite], List[str]]`	Undocumented

def get_default_arg_types(self, state, fdef): (source)

Undocumented

Parameters
state:`State`	Undocumented
fdef:`FuncDef`	Undocumented
Returns
`List[Optional[Type]]`	Undocumented

def get_guesses(self, is_method, base, defaults, callsites, uses): (source)

Compute a list of guesses for a function's type.

This focuses just on the argument types, and doesn't change the provided return type.

Parameters
is_method:`bool`	Undocumented
base:`CallableType`	Undocumented
defaults:`List[Optional[Type]]`	Undocumented
callsites:`List[Callsite]`	Undocumented
uses:`List[List[Type]]`	Undocumented
Returns
`List[CallableType]`	Undocumented

def get_guesses_from_parent(self, node): (source)

Try to get a guess of a method type from a parent class.

Parameters
node:`FuncDef`	Undocumented
Returns
`List[CallableType]`	Undocumented

def get_starting_type(self, fdef): (source)

Undocumented

Parameters
fdef:`FuncDef`	Undocumented
Returns
`CallableType`	Undocumented

def get_suggestion(self, mod, node): (source)

Compute a suggestion for a function.

Return the type and whether the first argument should be ignored.

Parameters
mod:`str`	Undocumented
node:`FuncDef`	Undocumented
Returns
`PyAnnotateSignature`	Undocumented

def get_trivial_type(self, fdef): (source)

Generate a trivial callable type from a func def, with all Anys

Parameters
fdef:`FuncDef`	Undocumented
Returns
`CallableType`	Undocumented

def json_suggestion(self, mod, func_name, node, suggestion): (source)

Produce a json blob for a suggestion suitable for application by pyannotate.

Parameters
mod:`str`	Undocumented
func_name:`str`	Undocumented
node:`FuncDef`	Undocumented
suggestion:`PyAnnotateSignature`	Undocumented
Returns
`str`	Undocumented

def named_type(self, s): (source)

Undocumented

Parameters
s:`str`	Undocumented
Returns
`Instance`	Undocumented

def pyannotate_signature(self, cur_module, is_method, typ): (source)

Format a callable type as a pyannotate dict

Parameters
cur_module:`Optional[str]`	Undocumented
is_method:`bool`	Undocumented
typ:`CallableType`	Undocumented
Returns
`PyAnnotateSignature`	Undocumented

def reload(self, state, check_errors=False): (source)

Recheck the module given by state.

If check_errors is true, raise an exception if there are errors.

Parameters
state:`State`	Undocumented
check_errors:`bool`	Undocumented
Returns
`List[str]`	Undocumented

@contextmanager
def restore_after(self, module): (source)

Context manager that reloads a module after executing the body.

This should undo any damage done to the module state while mucking around.

Parameters
module:`str`	Undocumented
Returns
`Iterator[None]`	Undocumented

def score_callable(self, t): (source)

Undocumented

Parameters
t:`CallableType`	Undocumented
Returns
`int`	Undocumented

def score_type(self, t, arg_pos): (source)

Generate a score for a type that we use to pick which type to use.

Lower is better, prefer non-union/non-any types. Don't penalize optionals.

Parameters
t:`Type`	Undocumented
arg_pos:`bool`	Undocumented
Returns
`int`	Undocumented

def suggest(self, function): (source)

Suggest an inferred type for function.

Parameters
function:`str`	Undocumented
Returns
`str`	Undocumented

def suggest_callsites(self, function): (source)

Find a list of call sites of function.

Parameters
function:`str`	Undocumented
Returns
`str`	Undocumented

def try_type(self, func, typ): (source)

Recheck a function while assuming it has type typ.

Return all error messages.

Parameters
func:`FuncDef`	Undocumented
typ:`ProperType`	Undocumented
Returns
`List[str]`	Undocumented

@contextmanager
def with_export_types(self): (source)

Context manager that enables the export_types flag in the body.

This causes type information to be exported into the manager's all_types variable.

Returns
`Iterator[None]`	Undocumented

fgmanager = (source)

Undocumented

finder = (source)

Undocumented

flex_any: float = (source)

Undocumented

give_json = (source)

Undocumented

graph = (source)

Undocumented

manager = (source)

Undocumented

max_guesses = (source)

Undocumented

no_errors = (source)

Undocumented

plugin = (source)

Undocumented

try_text = (source)

Undocumented

use_fixme = (source)

Undocumented