class documentation

class ImportFormat(bb.Union): (source)

View In Hierarchy

The import format of the incoming data. 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 paper.ImportFormat.html: The provided data is interpreted as standard HTML. :ivar paper.ImportFormat.markdown: The provided data is interpreted as markdown. The first line of the provided document will be used as the doc title. :ivar paper.ImportFormat.plain_text: The provided data is interpreted as plain text. The first line of the provided document will be used as the doc title.

Method is_html Check if the union tag is ``html``.
Method is_markdown Check if the union tag is ``markdown``.
Method is_other Check if the union tag is ``other``.
Method is_plain_text Check if the union tag is ``plain_text``.
Class Variable html Undocumented
Class Variable markdown Undocumented
Class Variable other Undocumented
Class Variable plain_text Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_html(self): (source)

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

def is_markdown(self): (source)

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

def is_other(self): (source)

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

def is_plain_text(self): (source)

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

Undocumented

markdown = (source)

Undocumented

Undocumented

plain_text = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented