augur.types module

class augur.types.ArgparseEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Intended to be used as a parent class for any enum representation of string values to be used with argparse options.

Can be replaced by enum.StrEnum once Augur’s minimum supported Python version is 3.11.

classmethod argtype(input_string)

Intended to be used as the argument type converter for argparse options that use the enum values as inputs.

Raises a custom argparse.ArgumentTypeError so that the error message can include a helpful list of the all valid enum values.

class augur.types.DataErrorMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: ArgparseEnum

Enum representation of string values that represent how a data error should be handled.

ERROR_ALL = 'error_all'

ERROR_FIRST = 'error_first'

SILENT = 'silent'

WARN = 'warn'

class augur.types.EmptyOutputReportingMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: ArgparseEnum

Enum representation of string values that represent how empty outputs should be reported.

ERROR = 'error'

SILENT = 'silent'

WARN = 'warn'

class augur.types.ValidationMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: ArgparseEnum

Enum representation of string values that represent how validation should be handled.

ERROR = 'error'

SKIP = 'skip'

WARN = 'warn'