API Reference

Subpackages

• msa.builtins package
  • Subpackages
    • msa.builtins.command package
      • Submodules
      • msa.builtins.command.events module
      • msa.builtins.command.handlers module
      • Module contents
    • msa.builtins.command_registry package
      • Submodules
      • msa.builtins.command_registry.events module
      • msa.builtins.command_registry.handlers module
      • Module contents
    • msa.builtins.echo package
      • Submodules
      • msa.builtins.echo.events module
      • msa.builtins.echo.handlers module
      • Module contents
    • msa.builtins.time package
      • Submodules
      • msa.builtins.time.events module
      • msa.builtins.time.handlers module
      • Module contents
    • msa.builtins.tty package
      • Submodules
      • msa.builtins.tty.events module
      • msa.builtins.tty.handlers module
      • msa.builtins.tty.prompt module
      • msa.builtins.tty.style module
      • Module contents
  • Module contents
• msa.core package
  • Submodules
  • msa.core.config_manager module
  • msa.core.event module
  • msa.core.event_bus module
  • msa.core.event_handler module
  • msa.core.loader module
  • msa.core.supervisor module
  • Module contents

Submodules

msa.config module

class msa.config.Config(config_file: str, sections: Dict[str, msa.config.Section])

Bases: object

A wrapper class for storing and accessing multiple sections

exception msa.config.ConfigError(sec: str, key: str, val: str, msg: str, index: int = 0)

Bases: Exception

A type of exception to be used when encountering invalid configuration settings

index() → int

key() → str

message() → str

section() → str

value() → str

class msa.config.Section(name: str)

Bases: object

Holds a group of keys, each key can have multiple or no values assigned

create_key(key: str) → None

get_all(key: str) → List[str]

Returns a list of all values within a given key

get_entries() → List[str]

Returns a list of all existing keys, even if the keys are empty

has(key: str) → bool

push(key: str, val: str) → None

Adds a value to the end of a key, even if there are empty values

set(key: str, index: int, val: str) → None

msa.config.load(filepath: str) → msa.config.Config

Loads a configuration file into a Config object for use within the code

msa.config.save(config: msa.config.Config, filepath: str) → None

Saves a Config object as a file to the provided file path

msa.var module

class msa.var.Expander

Bases: object

Holds variables for substitution in strings

expand(text: str) → str

Replaces any variables within a string to their values if any, variables are preceded by $

get_value(var: str) → str

register_protected(var: str, val: str) → None

register_var(var: str) → None

set_value(var: str, val: str) → None

unregister_protected(var: str) → None

unregister_var(var: str) → None

Module contents