class documentation

class SearchError(bb.Union): (source)

View In Hierarchy

This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar files.SearchError.internal_error: Something went wrong, please try again.

Class Method invalid_argument Create an instance of this class set to the ``invalid_argument`` tag with value ``val``.
Class Method path Create an instance of this class set to the ``path`` tag with value ``val``.
Method get_invalid_argument Only call this if :meth:`is_invalid_argument` is true.
Method get_path Only call this if :meth:`is_path` is true.
Method is_internal_error Check if the union tag is ``internal_error``.
Method is_invalid_argument Check if the union tag is ``invalid_argument``.
Method is_other Check if the union tag is ``other``.
Method is_path Check if the union tag is ``path``.
Class Variable internal_error Undocumented
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def invalid_argument(cls, val): (source)

Create an instance of this class set to the ``invalid_argument`` tag with value ``val``. :param str val: :rtype: SearchError

@classmethod
def path(cls, val): (source)

Create an instance of this class set to the ``path`` tag with value ``val``. :param LookupError val: :rtype: SearchError

def get_invalid_argument(self): (source)

Only call this if :meth:`is_invalid_argument` is true. :rtype: str

def get_path(self): (source)

Only call this if :meth:`is_path` is true. :rtype: LookupError

def is_internal_error(self): (source)

Check if the union tag is ``internal_error``. :rtype: bool

def is_invalid_argument(self): (source)

Check if the union tag is ``invalid_argument``. :rtype: bool

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_path(self): (source)

Check if the union tag is ``path``. :rtype: bool

internal_error = (source)

Undocumented

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all: str = (source)

Undocumented