coxbuild.configurations package

Submodules

coxbuild.configurations.builders module

class coxbuild.configurations.builders.ConfigurationBuilder

Bases: abc.ABC

abstract build(config: coxbuild.configurations.Configuration) → None

class coxbuild.configurations.builders.ConfigurationBuilderCollection

Bases: coxbuild.configurations.builders.ConfigurationBuilder

add(builder: coxbuild.configurations.builders.ConfigurationBuilder) → coxbuild.configurations.builders.ConfigurationBuilderCollection

build(config: coxbuild.configurations.Configuration) → None

class coxbuild.configurations.builders.DictionaryConfigurationBuilder(data: dict[str, Any])

Bases: coxbuild.configurations.builders.ConfigurationBuilder

Use dictionary to build configuration.

Nested dictionary will be converted to a subsection. To avoid this behavior, use an entry with key ‘__keep__’.

build(config: coxbuild.configurations.Configuration) → None

class coxbuild.configurations.builders.EnvironmentConfigurationBuilder

Bases: coxbuild.configurations.builders.ConfigurationBuilder

build(config: coxbuild.configurations.Configuration) → None

class coxbuild.configurations.builders.JsonConfigurationBuilder(path: pathlib.Path)

Bases: coxbuild.configurations.builders.ConfigurationBuilder

build(config: coxbuild.configurations.Configuration) → None

class coxbuild.configurations.builders.YamlConfigurationBuilder(path: pathlib.Path)

Bases: coxbuild.configurations.builders.ConfigurationBuilder

build(config: coxbuild.configurations.Configuration) → None

coxbuild.configurations.builders.getDefaultBuilder() → coxbuild.configurations.builders.ConfigurationBuilderCollection

Use environment variables and file buildcox.[json/yaml] to build configuration.

Module contents

class coxbuild.configurations.Configuration(name: str = '', data: Optional[dict[str, Any]] = None)

Bases: object

Build configuration, entry key is case-insensitive.

copy() → coxbuild.configurations.Configuration

Copy configuration.

env()

get(key: str) → Optional[Any]

section(name: str)

Get sub-section.

name: sub-section name

class coxbuild.configurations.ConfigurationAccessor(config: coxbuild.configurations.Configuration)

Bases: object

Configuration accessor.

get(key: str) → Any

Get configuration value.

getPath(key: str) → pathlib.Path | None

Get configuration value as Path.