siirto.configuration
index
/mnt/d/github/siirto/siirto/configuration.py

 
Modules
       
os

 
Classes
       
builtins.object
SiirtoConfiguration

 
class SiirtoConfiguration(builtins.object)
    Siirto configuration module.
Loads the config file and provide it to various modules
 
:param filename: configuration file path
:type filename: str
 
  Methods defined here:
__init__(self, filename:str) -> None
Initialize self.  See help(type(self)) for accurate signature.
get(self, section:str, key:str, default:Any=None)
Get the value from configuration object
:param section: section
:type section: str
:param key: key
:type key: str
:param default: default value, if section->key not found
:type default: Any
:return: section -> key value from config file
get_user_defined(self, key, default=None)
Get the value from configuration object from `user_defined section`
:param key: key
:type key: str
:param default: default value, if section->key not found
:type default: Any
:return: "user_defined" sectioin -> key value from config file
set(self, section:str, key:str, value:Any=None) -> None
Set the section->key value in configuration object
:param section: section
:type section: str
:param key: key
:type key: str
:param value: default value, if section->key not found
:type value: Any

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        Any = typing.Any
configuration = <siirto.configuration.SiirtoConfiguration object>