octodns.provider.plan

Classes

Plan(existing, desired, changes, exists[, ...])

PlanHtml(name[, output_filename])

PlanJson(name[, indent, sort_keys, ...])

PlanLogger(name[, level])

PlanMarkdown(name[, output_filename])

Exceptions

RootNsChange()

TooMuchChange(why, update_pcent, ...)

UnsafePlan

exception octodns.provider.plan.UnsafePlan[source]

Bases: Exception

exception octodns.provider.plan.RootNsChange[source]

Bases: UnsafePlan

__init__()[source]
exception octodns.provider.plan.TooMuchChange(why, update_pcent, update_threshold, change_count, existing_count, name)[source]

Bases: UnsafePlan

__init__(why, update_pcent, update_threshold, change_count, existing_count, name)[source]
class octodns.provider.plan.Plan(existing, desired, changes, exists, update_pcent_threshold=0.3, delete_pcent_threshold=0.3, meta=None)[source]

Bases: object

log = <Logger Plan (WARNING)>
MAX_SAFE_UPDATE_PCENT = 0.3
MAX_SAFE_DELETE_PCENT = 0.3
MIN_EXISTING_RECORDS = 10
__init__(existing, desired, changes, exists, update_pcent_threshold=0.3, delete_pcent_threshold=0.3, meta=None)[source]
property data
raise_if_unsafe()[source]
__repr__()[source]

Return repr(self).

class octodns.provider.plan._PlanOutput(name)[source]

Bases: object

__init__(name)[source]
octodns.provider.plan._custom_fh(func)[source]

Decorator that handles output_filename for plan output classes. If output_filename is set, opens that file and passes it as fh.

class octodns.provider.plan._PlanFhOutput(name, output_filename=None)[source]

Bases: _PlanOutput

Intermediate class for plan outputs that write to a file handle.

__init__(name, output_filename=None)[source]
class octodns.provider.plan.PlanLogger(name, level='info')[source]

Bases: _PlanOutput

__init__(name, level='info')[source]
run(log, plans, *args, **kwargs)[source]
octodns.provider.plan._value_stringifier(record, sep)[source]
class octodns.provider.plan.PlanJson(name, indent=None, sort_keys=True, output_filename=None)[source]

Bases: _PlanFhOutput

__init__(name, indent=None, sort_keys=True, output_filename=None)[source]
run(*args, **kwargs)[source]
class octodns.provider.plan.PlanMarkdown(name, output_filename=None)[source]

Bases: _PlanFhOutput

run(*args, **kwargs)[source]
class octodns.provider.plan.PlanHtml(name, output_filename=None)[source]

Bases: _PlanFhOutput

run(*args, **kwargs)[source]