mcph.config

Module for parse and interact with config.

Module Contents

Classes

Protocol	Protocols for file manager.
Library	Libraries for library manager.
RemoteData	Data for remote connection.
Config	Class for config.

Attributes

config

Initialised Config object.

class Protocol(*args, **kwds)

Bases: enum.Enum

Protocols for file manager.

Note

Currently supporting only local files protocol. In plans also FTP.

LOCAL = local

class Library(*args, **kwds)

Bases: enum.Enum

Libraries for library manager.

Note

Currently supporting only Spigot library.

SPIGOT = spigot

class RemoteData

Data for remote connection.

host: str

port: int

username: str

password: str

class Config

Class for config.

protocol: Protocol

Currently, supporting local files. In plans also support FTP and SFTP.

default_library: Library

At now only supporting spigot

default_plugins_path: str = ./

remote: RemoteData

classmethod setup() → Config

Set up the config.

It is just load config from file, also it is rewrite config with merged data.

Returns:

Config instance.

static _handle_env_variables(cfg: omegaconf.dictconfig.DictConfig) → None

Process all values, and redef them with values from env variables.

Parameters:

cfg – Config instance.

config

Initialised Config object.