class documentation

class SaveUrlError(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.SaveUrlError.download_failed: Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled. :ivar files.SaveUrlError.invalid_url: The given URL is invalid. :ivar files.SaveUrlError.not_found: The file where the URL is saved to no longer exists.

Class Method path Create an instance of this class set to the ``path`` tag with value ``val``.
Method get_path Only call this if :meth:`is_path` is true.
Method is_download_failed Check if the union tag is ``download_failed``.
Method is_invalid_url Check if the union tag is ``invalid_url``.
Method is_not_found Check if the union tag is ``not_found``.
Method is_other Check if the union tag is ``other``.
Method is_path Check if the union tag is ``path``.
Class Variable download_failed Undocumented
Class Variable invalid_url Undocumented
Class Variable not_found Undocumented
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def path(cls, val): (source)

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

def get_path(self): (source)

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

def is_download_failed(self): (source)

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

def is_invalid_url(self): (source)

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

def is_not_found(self): (source)

Check if the union tag is ``not_found``. :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

download_failed = (source)

Undocumented

invalid_url = (source)

Undocumented

not_found = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented