class documentation

class Scope: (source)

View In Hierarchy

Track which target we are processing at any given time.
Method __init__ Undocumented
Method class​_scope Undocumented
Method current​_full​_target Return the current target (may be a class).
Method current​_function​_name Return the current function's short name if it exists
Method current​_module​_id Undocumented
Method current​_target Return the current target (non-class; for a class return enclosing module).
Method current​_type​_name Return the current type's short name if it exists
Method enter​_class Enter a class target scope.
Method function​_scope Undocumented
Method leave​_class Leave a class target scope.
Method module​_scope Undocumented
Method save Produce a saved scope that can be entered with saved_scope()
Method saved​_scope Undocumented
Instance Variable classes Undocumented
Instance Variable function Undocumented
Instance Variable ignored Undocumented
Instance Variable module Undocumented
def __init__(self): (source)

Undocumented

@contextmanager
def class_scope(self, info): (source)

Undocumented

Parameters
info:TypeInfoUndocumented
Returns
Iterator[None]Undocumented
def current_full_target(self): (source)
Return the current target (may be a class).
Returns
strUndocumented
def current_function_name(self): (source)
Return the current function's short name if it exists
Returns
Optional[str]Undocumented
def current_module_id(self): (source)

Undocumented

Returns
strUndocumented
def current_target(self): (source)
Return the current target (non-class; for a class return enclosing module).
Returns
strUndocumented
def current_type_name(self): (source)
Return the current type's short name if it exists
Returns
Optional[str]Undocumented
def enter_class(self, info): (source)
Enter a class target scope.
Parameters
info:TypeInfoUndocumented
@contextmanager
def function_scope(self, fdef): (source)

Undocumented

Parameters
fdef:FuncBaseUndocumented
Returns
Iterator[None]Undocumented
def leave_class(self): (source)
Leave a class target scope.
@contextmanager
def module_scope(self, prefix): (source)

Undocumented

Parameters
prefix:strUndocumented
Returns
Iterator[None]Undocumented
def save(self): (source)
Produce a saved scope that can be entered with saved_scope()
Returns
SavedScopeUndocumented
@contextmanager
def saved_scope(self, saved): (source)

Undocumented

Parameters
saved:SavedScopeUndocumented
Returns
Iterator[None]Undocumented
classes: list = (source)

Undocumented

function = (source)

Undocumented

ignored: int = (source)

Undocumented

module = (source)

Undocumented