boss.configuration

Classes

Document	dict() -> new empty dictionary
WorkerConfigurationDocument	dict() -> new empty dictionary

Functions

_resolve_references(value, realm) → object

Replace $name strings at any depth with remote HEROs.

Module Contents

boss.configuration._resolve_references(value: object, realm: str) → object

Replace $name strings at any depth with remote HEROs.

A leading $$ is an escape: one $ is stripped and the string is passed on literally. Dict keys are not resolved. Containers are rebuilt, the input is not modified.

Parameters:

• value – argument value, possibly a nested dict, list or tuple

• realm – realm in which the referenced HEROs are looked up

Returns:

The value with all references resolved.

class boss.configuration.Document

Bases: dict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

classmethod parse_string(s: str)

Parse a document in JSON format from a string.

Parameters:

s – string containing the JSON representation of the config

classmethod parse_url(url: str)

Parse a document in JSON format from a URL.

Parameters:

url – any URL supported by urllib (e.g. file://local.json or https://user:pass@couch.db/database/my_doc)

class boss.configuration.WorkerConfigurationDocument

Bases: Document

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

datasource_config()

generate_tags(boss_name)

Add boss/configuration specific tags to the HERO.

build_hero_for_worker(boss_name: str, worker_object, realm='heros')