class documentation

class PaperDocUpdatePolicy(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 paper.PaperDocUpdatePolicy.append: The content will be appended to the doc. :ivar paper.PaperDocUpdatePolicy.prepend: The content will be prepended to the doc. The doc title will not be affected. :ivar paper.PaperDocUpdatePolicy.overwrite_all: The document will be overwitten at the head with the provided content.

Method is_append Check if the union tag is ``append``.
Method is_other Check if the union tag is ``other``.
Method is_overwrite_all Check if the union tag is ``overwrite_all``.
Method is_prepend Check if the union tag is ``prepend``.
Class Variable append Undocumented
Class Variable other Undocumented
Class Variable overwrite_all Undocumented
Class Variable prepend Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_append(self): (source)

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

def is_other(self): (source)

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

def is_overwrite_all(self): (source)

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

def is_prepend(self): (source)

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

Undocumented

Undocumented

overwrite_all = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented