arkimet.cfg package

Module contents

class arkimet.cfg.Section

Arkimet configuration, as a section of key/value options

copy() → arkimet.cfg.Section

return a deep copy of this Section object

get(name: str, default: Optional[Any] = None) → Union[str, Any]

return the value for the given key, or the given default value if it does not exist

items() → Iterable[Tuple[str, str]]

Iterate over key/value pairs

keys() → Iterable[str]

Iterate over key names

parse(Union[Str, TextIO]) → arki.cfg.Section

parse the named file or open file, and return the resulting Section object

write(TextIO)

write the configuration to any object with a write method

class arkimet.cfg.Sections

Arkimet configuration, as multiple sections of key/value options

copy() → arkimet.cfg.Sections

return a deep copy of this Sections object

get(name: str, default: Optional[Any] = None) → Union[arki.cfg.Section, Any]

return the named section, or the given default value if it does not exist

items() → Iterable[Tuple[str, arki.cfg.Section]]

Iterate over section names and sections

keys() → Iterable[str]

Iterate over section names

obtain(Str) → arki.cfg.Section

return the named section, creating it if it does not exist

parse(Union[Str, TextIO]) → arki.cfg.Sections

parse the named file or open file, and return the resulting Sections object

section(Str) → Optional[arki.cfg.Section]

return the named section, if it exists, or None if it does not

write(TextIO)

write the configuration to any object with a write method