octodns.manager

class octodns.manager._AggregateTarget(targets)

Bases: object

id = 'aggregate'

__init__(targets)

supports(record)

class octodns.manager.MakeThreadFuture(func, args, kwargs)

Bases: object

__init__(func, args, kwargs)

result()

class octodns.manager.MainThreadExecutor

Bases: object

Dummy executor that runs things on the main thread during the invocation of submit, but still returns a future object with the result. This allows code to be written to handle async, even in the case where we don’t want to use multiple threads/workers and would prefer that things flow as if traditionally written.

submit(func, *args, **kwargs)

exception octodns.manager.ManagerException

Bases: Exception

class octodns.manager.Manager(config_file, max_workers=None, include_meta=False, auto_arpa=False, enable_checksum=False)

Bases: object

log = <Logger Manager (WARNING)>

plan_log = <Logger Plan (WARNING)>

classmethod _plan_keyer(p)

__init__(config_file, max_workers=None, include_meta=False, auto_arpa=False, enable_checksum=False)

_config_zones(zones)

_config_executor(manager_config, max_workers=None)

_config_include_meta(manager_config, include_meta=False)

_config_enable_checksum(manager_config, enable_checksum=False)

_config_auto_arpa(manager_config, auto_arpa=False)

_config_secret_handlers(secret_handlers_config)

_config_providers(providers_config)

_config_processors(processors_config)

_config_plan_outputs(plan_outputs_config)

_try_version(module_name, module=None, version=None)

_import_module(module_name)

_get_named_class(_type, _class, context)

_build_kwargs(source)

configured_sub_zones(zone_name)

Accepts either UTF-8 or IDNA encoded zone name and returns the list of any configured sub-zones in IDNA form. E.g. for the following configured zones:

some.com. other.some.com. deep.thing.some.com.

It would return

other deep.thing

_populate_and_plan(zone_name, processors, sources, targets, desired=None, lenient=False)

_get_sources(decoded_zone_name, config, eligible_sources)

_preprocess_zones(zones, eligible_sources=None, sources=None)

This may modify the passed in zone object, it should be ignored after the call and the zones returned from this function should be used instead.

sync(eligible_zones=[], eligible_sources=[], eligible_targets=[], dry_run=True, force=False, plan_output_fh=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, checksum=None)

compare(a, b, zone)

Compare zone data between 2 sources.

Note: only things supported by both sources will be considered

dump(zone, output_dir, sources, lenient=False, split=False, output_provider=None)

Dump zone data from the specified source

validate_configs(lenient=False)

get_zone(zone_name)