pyhocon package

Submodules

pyhocon.config_tree module

class pyhocon.config_tree.ConfigList(iterable)

Bases: list

class pyhocon.config_tree.ConfigSlashString(value)

Bases: str

class pyhocon.config_tree.ConfigSubstitution(variable, ws)

Bases: object

class pyhocon.config_tree.ConfigTree

Bases: object

KEY_SEP = '.'

get(key)

Get a value from the tree

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:value in the tree located at key

get_bool(key)

Return boolean representation of value found at key

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:boolean value

get_config(key)

Return tree config representation of value found at key

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:config value

get_float(key)

Return float representation of value found at key

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:float value

get_int(key)

Return int representation of value found at key

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:int value

get_list(key)

Return list representation of value found at key

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:list value

get_string(key)

Return string representation of value found at key

Parameters:key (basestring) – key to use (dot separated). E.g., a.b.c Returns:string value

items()

Return items found in the config

Returns:list of items

iteritems()

Return items iterator found in the config

Returns:items iterator

iterkeys()

Return keys iterator found in the config

Returns:keys iterator

itervalues()

Return values iterator found in the config

Returns:values iterator

put(key, value, append=False)

Put a value in the tree (dot separated)

Parameters:

• key (basestring) – key to use (dot separated). E.g., a.b.c
• value – value to put

class pyhocon.config_tree.ConfigUnquotedString(value)

Bases: str

class pyhocon.config_tree.ConfigValues(iterable)

Bases: object

has_substitution()

put(index, value)

transform()

pyhocon.exceptions module

exception pyhocon.exceptions.ConfigException(message, ex=None)

Bases: exceptions.Exception

exception pyhocon.exceptions.ConfigMissingException(message, ex=None)

Bases: pyhocon.exceptions.ConfigException

exception pyhocon.exceptions.ConfigSubstitutionException(message, ex=None)

Bases: pyhocon.exceptions.ConfigException

exception pyhocon.exceptions.ConfigWrongTypeException(message, ex=None)

Bases: pyhocon.exceptions.ConfigException

pyhocon.tool module

class pyhocon.tool.HOCONConverter

Bases: object

static convert(input_file=None, output_file=None, format='json')

Convert to json, properties or yaml

Parameters:format (basestring) – json, properties or yaml Returns:json, properties or yaml string representation

static to_json(config, level=0)

Convert HOCON input into a JSON output

Returns:JSON string representation

static to_properties(config, key_stack=[])

Convert HOCON input into a .properties output

Returns:.properties string representation Returns:

static to_yaml(config, level=0)

Convert HOCON input into a YAML output

Returns:YAML string representation

pyhocon.tool.main()

Module contents

class pyhocon.ConcatenatedValueParser(expr=None)

Bases: pyparsing.TokenConverter

postParse(instring, loc, token_list)

class pyhocon.ConfigFactory

Bases: object

static parse_URL(url, timeout=None)

Parse URL

Parameters:url (basestring) – url to parse Returns:Config object

static parse_file(filename)

Parse file

Parameters:filename (basestring) – filename Returns:Config object

static parse_string(content, basedir=None)

Parse URL

Parameters:url (basestring) – url to parse Returns:Config object

class pyhocon.ConfigParser

Bases: object

Parse HOCON files: https://github.com/typesafehub/config/blob/master/HOCON.md

REPLACEMENTS = {'\\t': '\t', '\\r': '\r', '\\#': '#', '\\!': '!', '\\n': '\n', '\\"': '"', '\\=': '=', '\\\n': '\n'}

static parse(content, basedir=None)

parse a HOCON content

Parameters:content (basestring) – HOCON content to parse Returns:a ConfigTree or a list

class pyhocon.ConfigTreeParser(expr=None)

Bases: pyparsing.TokenConverter

Parse a config tree from tokens

postParse(instring, loc, token_list)

Create ConfigTree from tokens

Parameters:

• instring –
• loc –
• token_list –

Returns:

class pyhocon.ListParser(expr=None)

Bases: pyparsing.TokenConverter

Parse a list [elt1, etl2, ...]

postParse(instring, loc, token_list)

Create a list from the tokens

Parameters:

• instring –
• loc –
• token_list –

Returns: