pcdsdevices.interface.TabCompletionHelperInstance

class pcdsdevices.interface.TabCompletionHelperInstance(instance, class_helper)

Tab completion helper for one instance of a class.

Parameters

• instance (object) – Instance of class_helper.cls.

• class_helper (TabCompletionHelperClass) – Class helper for defaults.

Methods

add(attr: str)

Add an attribute to the include list.

build_regex() → Pattern

Update the regular expression based on the current includes.

get_dir() → List[str]

Get the dir list based on the engineering mode settings.

get_filtered_dir_list() → List[str]

Get the dir list, filtered based on the whitelist.

remove(attr: str)

Remove an attribute from the include list.

reset()

Reset the attribute includes to that defined by the class.

Attributes

class_helper: pcdsdevices.interface.TabCompletionHelperClass

instance: pcdsdevices.interface.BaseInterface

super_dir: Callable[[], List[str]]