clowder.config package

Submodules

clowder.config.clowder_config module

Clowder config class

class clowder.config.clowder_config.ClowderConfig(clowder_config: Optional[dict] = None, current_clowder_name: Optional[str] = None)

Bases: object

Clowder config class

Variables:
  • name (str) – Name of clowder
  • clowder_dir (Path) – Path to clowder directory
  • ..]] projects (Optional[Tuple[str,) – Default projects
  • protocol (Optional[str]) – Default protocol
  • rebase (Optional[bool]) – Default rebase
  • jobs (Optional[int]) – Default number of jobs
clear() → None

Clear all config settings

get_yaml() → dict

Get yaml representation of config

Returns:YAML python object
Return type:dict
is_config_value_set(value: clowder.config.clowder_config.ClowderConfigType) → None

Determine if config value is set

Parameters:value (ClowderConfigType) – Clowder config value
Raises:ClowderError –
is_empty() → bool

Determine if any config values are set

Returns:True, if any config values are set
Return type:bool
print_config_value(value: clowder.config.clowder_config.ClowderConfigType) → None

Print current configuration

Parameters:value (ClowderConfigType) – Clowder config value
Raises:ClowderError –
print_configuration() → None

Print current configuration

validate_config_projects_defined(project_options: Tuple[str, ...]) → None

Validate all projects were defined in clowder yaml file

Parameters:..] project_options (Tuple[str,) – Projects to validate against
Raises:ClowderError –
class clowder.config.clowder_config.ClowderConfigType

Bases: enum.Enum

An enumeration.

JOBS = 1
PROJECTS = 2
PROTOCOL = 3
REBASE = 4

clowder.config.config module

Config handler class

class clowder.config.config.Config(current_clowder_name: Optional[str], project_options: Tuple[str, ...], raise_exceptions: bool = False)

Bases: object

Config handler class

Variables:
  • version (float) – Version number of config file
  • ..] clowder_configs (Tuple[ClowderConfig,) – Configs for clowders
  • current_clowder_config (Optional[ClowderConfig]) – Config for current clowder
  • error (Optional[Exception]) – Exception from failing to load clowder config yaml file
process_projects_arg(projects: List[str]) → Tuple[str, ...]

Process project args based on parameters and config

Parameters:projects (List[str]) – Projects to filter
Returns:Projects in groups matching given names
Return type:Tuple[str, ..]
save() → None

Save configuration to file

Module contents

clowder.config module __init__