Source.Model.config Namespace Reference

Classes
class	Config
	Class Configuration: Read/Write configuration data (user or articles) More...

Functions
float	get_dict_float (dict[str, dict[str, str]] d_dict, str s_section, str s_key)
	Get floating value in dictionary.
int	get_dict_int (dict[str, dict[str, str]] d_dict, str s_section, str s_key)
	Get integer value in dictionary.
str	get_dict_value (dict[str, dict[str, str]] d_dict, str s_section, str s_key)
	Get value from dictionary.
bool	is_float (Any value)
	Check if string can convert to float.
bool	is_int (Any value)
	Check if string can convert to integer.
dict[str, dict[str, str|list[str]]]	read_data_from_config_file (str s_file_name)
	Read data from configuration file.
dict[str, Any]	sort_dict (dict[str, Any] d_dict_to_sort, dict[str, Any] d_order_reference)
	Sort dictionary.
None	write_config_to_file (str s_file_name, dict[str, Any] d_dict)
	Write configuration to file.

Variables
	log = logging.getLogger(__title__)
str	S_ITEM_FILE = "articles.ini"
str	S_ITEM_TEMP_FILE = "_temp_articles.ini"
str	S_USER_FILE = "user.ini"
str	S_USER_TEMP_FILE = "_temp_user.ini"

Detailed Description

---

Function Documentation

get_dict_float()

float get_dict_float	(	dict[str, dict[str, str]]	d_dict,
		str	s_section,
		str	s_key )

Get floating value in dictionary.

Parameters

d_dict	: dictionary
s_section	: section
s_key	: key

Returns

get floating value from dictionary. 0 if not present

Definition at line 62 of file config.py.

def get_dict_float(d_dict: dict[str, dict[str, str]], s_section: str, s_key: str) -> float:
    """!
    @brief Get floating value in dictionary.
    @param d_dict : dictionary
    @param s_section : section
    @param s_key : key
    @return get floating value from dictionary. 0 if not present
    """
    f_float = 0.0
    if s_section in d_dict:
        value = d_dict[s_section].get(s_key)
        if value is not None:
            if is_float(value):
                f_float = float(value)
    return f_float
 
 

get_dict_int()

int get_dict_int	(	dict[str, dict[str, str]]	d_dict,
		str	s_section,
		str	s_key )

Get integer value in dictionary.

Parameters

d_dict	: dictionary
s_section	: section
s_key	: key

Returns

get integer value from dictionary. 0 if not present

Definition at line 79 of file config.py.

def get_dict_int(d_dict: dict[str, dict[str, str]], s_section: str, s_key: str) -> int:
    """!
    @brief Get integer value in dictionary.
    @param d_dict : dictionary
    @param s_section : section
    @param s_key : key
    @return get integer value from dictionary. 0 if not present
    """
    i_int = 0
    if s_section in d_dict:
        value = d_dict[s_section].get(s_key)
        if value is not None:
            if is_int(value):
                i_int = int(value)
    return i_int
 
 

get_dict_value()

str get_dict_value	(	dict[str, dict[str, str]]	d_dict,
		str	s_section,
		str	s_key )

Get value from dictionary.

Parameters

d_dict	: dictionary
s_section	: section
s_key	: key

Returns

get integer value from dictionary. Nothing if not present

Definition at line 96 of file config.py.

def get_dict_value(d_dict: dict[str, dict[str, str]], s_section: str, s_key: str) -> str:
    """!
    @brief Get value from dictionary.
    @param d_dict : dictionary
    @param s_section : section
    @param s_key : key
    @return get integer value from dictionary. Nothing if not present
    """
    if s_section in d_dict and s_key in d_dict[s_section]:
        value = str(d_dict[s_section][s_key])
    else:
        value = ""
    return value
 
 

is_float()

bool is_float

(

Any

value

)

Check if string can convert to float.

Parameters

value

: value to check

Returns

status if string can convert to float

Definition at line 34 of file config.py.

def is_float(value: Any) -> bool:
    """!
    @brief Check if string can convert to float.
    @param value : value to check
    @return status if string can convert to float
    """
    try:
        float(value)
        b_float = True
    except (TypeError, ValueError):
        b_float = False
    return b_float
 
 

is_int()

bool is_int

(

Any

value

)

Check if string can convert to integer.

Parameters

value

: value to check

Returns

status if string can convert to integer

Definition at line 48 of file config.py.

def is_int(value: Any) -> bool:
    """!
    @brief Check if string can convert to integer.
    @param value : value to check
    @return status if string can convert to integer
    """
    try:
        int(value)
        b_int = True
    except (TypeError, ValueError):
        b_int = False
    return b_int
 
 

read_data_from_config_file()

dict[str, dict[str, str | list[str]]] read_data_from_config_file

(

str

s_file_name

)

Read data from configuration file.

Parameters

s_file_name

: file to read

Returns

return configuration of the file

Definition at line 484 of file config.py.

def read_data_from_config_file(s_file_name: str) -> dict[str, dict[str, str | list[str]]]:
    """!
    @brief Read data from configuration file.
    @param s_file_name : file to read
    @return return configuration of the file
    """
    d_data: dict[str, dict[str, str | list[str]]] = {}
    parser = ConfigParser()
    with codecs.open(s_file_name, mode="r", encoding="utf-8") as file:
        parser.read_file(file)
    for s_section in parser.sections():
        d_data[s_section] = {}
        for key, value in parser.items(s_section):
            b_list_key = False
            if b_list_key and value.startswith('[') and value.endswith(']'):  # read UID as list if possible
                s_entries = value[1:-1].split(", ")
                l_entries = [s_char.strip('\'\"') for s_char in s_entries]
                d_data[s_section][key] = l_entries
            else:
                d_data[s_section][key] = value
    return d_data
 
 

sort_dict()

dict[str, Any] sort_dict	(	dict[str, Any]	d_dict_to_sort,
		dict[str, Any]	d_order_reference )

Sort dictionary.

Parameters

d_dict_to_sort	: dictionary to sort
d_order_reference	: reference dictionary to sort in this order

Returns

return sorted dictionary

Definition at line 453 of file config.py.

def sort_dict(d_dict_to_sort: dict[str, Any], d_order_reference: dict[str, Any]) -> dict[str, Any]:
    """!
    @brief Sort dictionary.
    @param d_dict_to_sort : dictionary to sort
    @param d_order_reference : reference dictionary to sort in this order
    @return return sorted dictionary
    """
    sorted_dict = OrderedDict()
    unsorted_dict = OrderedDict()
 
    for key, _order in d_order_reference.items():
        if key in d_dict_to_sort:
            value = d_dict_to_sort[key]
 
            if isinstance(value, dict):
                sorted_dict[key] = sort_dict(value, d_order_reference[key])
            else:
                sorted_dict[key] = value
 
    # insert unsorted values at the end
    for key, value in d_dict_to_sort.items():
        if key not in d_order_reference:
            if isinstance(value, dict):
                unsorted_dict[key] = sort_dict(value, {})
            else:
                unsorted_dict[key] = value
 
    sorted_dict.update(unsorted_dict)
    return sorted_dict
 
 

write_config_to_file()

None write_config_to_file	(	str	s_file_name,
		dict[str, Any]	d_dict )

Write configuration to file.

Parameters

s_file_name	: write to this file
d_dict	: dictionary to write

Definition at line 507 of file config.py.

def write_config_to_file(s_file_name: str, d_dict: dict[str, Any]) -> None:
    """!
    @brief Write configuration to file.
    @param s_file_name : write to this file
    @param d_dict : dictionary to write
    """
    parser = cfg.ConfigParser()
    for s_ini_section in d_dict:
        parser.add_section(s_ini_section)
        for s_ini_key in d_dict[s_ini_section]:
            s_ini_value = d_dict[s_ini_section][s_ini_key]
            if isinstance(s_ini_value, list):
                s_ini_value = ', '.join(f'"{item}"' for item in s_ini_value)
                s_ini_value = f"[{s_ini_value}]"
            parser.set(s_ini_section, s_ini_key, s_ini_value)
    with open(s_file_name, mode="w", encoding="utf-8") as o_cfg_file:
        parser.write(o_cfg_file)

Variable Documentation

log

log = logging.getLogger(__title__)

Definition at line 31 of file config.py.

S_ITEM_FILE

str S_ITEM_FILE = "articles.ini"

Definition at line 26 of file config.py.

S_ITEM_TEMP_FILE

str S_ITEM_TEMP_FILE = "_temp_articles.ini"

Definition at line 27 of file config.py.

S_USER_FILE

str S_USER_FILE = "user.ini"

Definition at line 28 of file config.py.

S_USER_TEMP_FILE

str S_USER_TEMP_FILE = "_temp_user.ini"

Definition at line 29 of file config.py.