pcdsdevices.interface.TabCompletionHelperClass

class pcdsdevices.interface.TabCompletionHelperClass(cls)

Tab completion helper for the class itself.

Parameters

cls (subclass of BaseInterface) – Class type object to generate tab completion information from.

Methods

add(attr: str)

Add an attribute to the include list.

build_regex() → Pattern

Update the regular expression based on the current includes.

new_instance(instance) → pcdsdevices.interface.TabCompletionHelperInstance

Create a new TabCompletionHelperInstance for the given object.

Parameters

instance (object) – The instance of self.cls.

remove(attr: str)

Remove an attribute from the include list.

reset()

Reset the attribute includes to those annotated in the class.

Attributes

cls: Type[pcdsdevices.interface.BaseInterface]