Config Class Reference

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

Public Member Functions
None	__init__ (self, "MainWindow" ui)
bool	get_auto_open (self)
	Get drawer auto open status.
str	get_device_name (self)
	Get smart card user status.
bool	get_free_auto_logout (self)
	Get free user auto logout status.
float	get_group_tax (self, int i_group)
	Get tax value from group.
str	get_header1 (self)
	Get first bon header.
str	get_header2 (self)
	Get second bon header.
str	get_item_background (self, int i_item_number)
	Get item background.
str	get_item_button_name (self, int i_item_number)
	Get item name for button.
int	get_item_group (self, int i_item_number)
	Get item group.
bool	get_item_mark_status (self, int i_item_number)
	Get item mark status.
str	get_item_name (self, int i_item_number)
	Get item name.
float	get_item_price (self, int i_item_number)
	Get item price.
bool	get_item_print_status (self, int i_item_number)
	Get item print status.
EUser|None	get_item_visible_user (self, int i_item_number)
	Get visible user for item.
float	get_logout_time (self)
	Get timeout for inactive user.
bool	get_print_article_status (self)
	Get article print status.
bool	get_print_free_price_status (self)
	Get print free user price status.
str	get_user_name (self, str user)
	Get name of user (only for order staff).
str	get_user_pw (self, str user)
	Get password of user.
float	get_user_tax (self)
	Get user involvement.
dict[str, Any]|None	handle_config_data_read (self, str s_file)
	Try to read config data to handle duplicate items.
bool	read_item_file (self, str s_file, bool b_remove_file=False)
	Read articles file configuration and save in settings.
bool	read_user_file (self, str s_file, bool b_remove_file=False)
	Read user file configuration and save in settings.
None	store_user_data (self)
	Store actual user data.
None	update_extended_article_status (self, bool prevent_resize=False)
	Update extended article status.

Public Attributes
bool	b_smartcard_id_present = False
	d_item = sort_dict(read_articles_settings(), D_DEFAULT_ITEM)
	d_user = sort_dict(read_user_settings(), D_DEFAULT_USER)
	item_number_size = ItemNumber.MIN
	ui = ui

Detailed Description

Class Configuration: Read/Write configuration data (user or articles)

Parameters

ui	: main window object

Definition at line 111 of file config.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		"MainWindow"	ui )

Definition at line 117 of file config.py.

    def __init__(self, ui: "MainWindow") -> None:
        self.ui = ui
        self.b_smartcard_id_present = False
        self.d_user = sort_dict(read_user_settings(), D_DEFAULT_USER)
        self.d_item = sort_dict(read_articles_settings(), D_DEFAULT_ITEM)
        self.item_number_size = ItemNumber.MIN
        self.update_extended_article_status(prevent_resize=True)
 

Member Function Documentation

get_auto_open()

bool get_auto_open

(

self

)

Get drawer auto open status.

Returns

cash drawer auto open status

Definition at line 165 of file config.py.

    def get_auto_open(self) -> bool:
        """!
        @brief Get drawer auto open status.
        @return cash drawer auto open status
        """
        s_select = get_dict_value(self.d_user, S_GENERAL, S_AUTO_OPEN)
        return not bool(s_select == "False")
 

get_device_name()

str get_device_name

(

self

)

Get smart card user status.

Returns

start card user activation status

Definition at line 146 of file config.py.

    def get_device_name(self) -> str:
        """!
        @brief Get smart card user status.
        @return start card user activation status
        """
        origin_device_name = get_dict_value(self.d_user, S_GENERAL, S_DEVICE)
        if not origin_device_name.isalnum():  # only letter and numbers allowed for file name
            device_name = ""
        else:
            device_name = origin_device_name
        return device_name
 

get_free_auto_logout()

bool get_free_auto_logout

(

self

)

Get free user auto logout status.

Returns

free user auto logout status

Definition at line 173 of file config.py.

    def get_free_auto_logout(self) -> bool:
        """!
        @brief Get free user auto logout status.
        @return free user auto logout status
        """
        s_select = get_dict_value(self.d_user, S_GENERAL, S_FREE_AUTO_LOGOUT)
        return not bool(s_select == "False")
 

get_group_tax()

float get_group_tax	(		self,
		int	i_group )

Get tax value from group.

Parameters

i_group

: get tax of this group (1-3)

Returns

tax value of group

Definition at line 211 of file config.py.

    def get_group_tax(self, i_group: int) -> float:
        """!
        @brief Get tax value from group
        @param i_group : get tax of this group (1-3)
        @return tax value of group
        """
        if i_group == I_GROUP_1:
            s_group = S_GROUP_1
        elif i_group == I_GROUP_2:
            s_group = S_GROUP_2
        else:
            s_group = S_GROUP_3
        return get_dict_float(self.d_item, S_TAX, s_group)
 

get_header1()

str get_header1

(

self

)

Get first bon header.

Returns

first bon header string

Definition at line 197 of file config.py.

    def get_header1(self) -> str:
        """!
        @brief Get first bon header
        @return first bon header string
        """
        return get_dict_value(self.d_item, S_HEADER, S_HEADER_1)
 

get_header2()

str get_header2

(

self

)

Get second bon header.

Returns

second bon header string

Definition at line 204 of file config.py.

    def get_header2(self) -> str:
        """!
        @brief Get second bon header
        @return second bon header string
        """
        return get_dict_value(self.d_item, S_HEADER, S_HEADER_2)
 

get_item_background()

str get_item_background	(		self,
		int	i_item_number )

Get item background.

Parameters

i_item_number

: item number (1-30)

Returns

mark status of item

Definition at line 319 of file config.py.

    def get_item_background(self, i_item_number: int) -> str:
        """!
        @brief Get item background
        @param i_item_number : item number (1-30)
        @return mark status of item
        """
        background = get_dict_value(self.d_item, str(i_item_number), S_BACKGROUND)
        return background
 

get_item_button_name()

str get_item_button_name	(		self,
		int	i_item_number )

Get item name for button.

(with new lines)

Parameters

i_item_number

: item number (1-30)

Returns

name of item ("" for not present user)

Definition at line 257 of file config.py.

    def get_item_button_name(self, i_item_number: int) -> str:
        """!
        @brief Get item name for button. (with new lines)
        @param i_item_number : item number (1-30)
        @return name of item ("" for not present user)
        """
        if i_item_number > ItemNumber.MAX:
            i_item_number -= ItemNumber.MAX
        return get_dict_value(self.d_item, str(i_item_number), S_NAME).replace(S_BREAK_LINE, "\n")
 

get_item_group()

int get_item_group	(		self,
		int	i_item_number )

Get item group.

Parameters

i_item_number

: item number (1-30)

Returns

group of item

Definition at line 276 of file config.py.

    def get_item_group(self, i_item_number: int) -> int:
        """!
        @brief Get item group
        @param i_item_number : item number (1-30)
        @return group of item
        """
        i_group = get_dict_int(self.d_item, str(i_item_number), S_GROUP)
        if i_group not in [I_GROUP_1, I_GROUP_2, I_GROUP_3]:
            i_group = I_GROUP_3
        return i_group
 

get_item_mark_status()

bool get_item_mark_status	(		self,
		int	i_item_number )

Get item mark status.

Parameters

i_item_number

: item number (1-30)

Returns

mark status of item

Definition at line 310 of file config.py.

    def get_item_mark_status(self, i_item_number: int) -> bool:
        """!
        @brief Get item mark status
        @param i_item_number : item number (1-30)
        @return mark status of item
        """
        s_select = get_dict_value(self.d_item, str(i_item_number), S_MARK)
        return bool(s_select == "True")
 

get_item_name()

str get_item_name	(		self,
		int	i_item_number )

Get item name.

Parameters

i_item_number

: item number (1-30)

Returns

name of item

Definition at line 248 of file config.py.

    def get_item_name(self, i_item_number: int) -> str:
        """!
        @brief Get item name
        @param i_item_number : item number (1-30)
        @return name of item
        """
        item_name = get_dict_value(self.d_item, str(i_item_number), S_NAME).replace(S_BREAK_LINE, "")
        return item_name
 

get_item_price()

float get_item_price	(		self,
		int	i_item_number )

Get item price.

Parameters

i_item_number

: item number (1-30)

Returns

price of item

Definition at line 267 of file config.py.

    def get_item_price(self, i_item_number: int) -> float:
        """!
        @brief Get item price
        @param i_item_number : item number (1-30)
        @return price of item
        """
        f_price = get_dict_float(self.d_item, str(i_item_number), S_PRICE)
        return f_price
 

get_item_print_status()

bool get_item_print_status	(		self,
		int	i_item_number )

Get item print status.

Parameters

i_item_number

: item number (1-30)

Returns

print status of item

Definition at line 301 of file config.py.

    def get_item_print_status(self, i_item_number: int) -> bool:
        """!
        @brief Get item print status
        @param i_item_number : item number (1-30)
        @return print status of item
        """
        s_select = get_dict_value(self.d_item, str(i_item_number), S_PRINT)
        return not bool(s_select == "False")
 

get_item_visible_user()

EUser | None get_item_visible_user	(		self,
		int	i_item_number )

Get visible user for item.

Parameters

i_item_number

: item number (1-30)

Returns

visible user for item

Definition at line 287 of file config.py.

    def get_item_visible_user(self, i_item_number: int) -> EUser | None:
        """!
        @brief Get visible user for item
        @param i_item_number : item number (1-30)
        @return visible user for item
        """
        s_user = get_dict_value(self.d_item, str(i_item_number), S_USER_VISIBLE)
        user_values = [user.value for user in EUser]
        if s_user in user_values:
            e_user = EUser(s_user)
        else:
            e_user = None
        return e_user
 

get_logout_time()

float get_logout_time

(

self

)

Get timeout for inactive user.

Returns

logout timeout

Definition at line 158 of file config.py.

    def get_logout_time(self) -> float:
        """!
        @brief Get timeout for inactive user.
        @return logout timeout
        """
        return get_dict_float(self.d_user, S_GENERAL, S_USER_TIMEOUT)
 

get_print_article_status()

bool get_print_article_status

(

self

)

Get article print status.

Returns

article print status

Definition at line 232 of file config.py.

    def get_print_article_status(self) -> bool:
        """!
        @brief Get article print status
        @return article print status
        """
        s_select = get_dict_value(self.d_item, S_PRINTS, S_PRINT_ARTICLE)
        return not bool(s_select == "False")
 

get_print_free_price_status()

bool get_print_free_price_status

(

self

)

Get print free user price status.

Returns

print free price status

Definition at line 240 of file config.py.

    def get_print_free_price_status(self) -> bool:
        """!
        @brief Get print free user price status
        @return print free price status
        """
        s_select = get_dict_value(self.d_item, S_PRINTS, S_PRINT_FREE_PRICE)
        return not bool(s_select == "False")
 

get_user_name()

str get_user_name	(		self,
		str	user )

Get name of user (only for order staff).

Parameters

user	: get name of this user

Returns

user name

Definition at line 181 of file config.py.

    def get_user_name(self, user: str) -> str:
        """!
        @brief Get name of user (only for order staff).
        @param user : get name of this user
        @return user name
        """
        return get_dict_value(self.d_user, user, S_NAME)
 

get_user_pw()

str get_user_pw	(		self,
		str	user )

Get password of user.

Parameters

user	: get password of this user

Returns

password of user

Definition at line 189 of file config.py.

    def get_user_pw(self, user: str) -> str:
        """!
        @brief Get password of user.
        @param user : get password of this user
        @return password of user
        """
        return get_dict_value(self.d_user, user, S_PW)
 

get_user_tax()

float get_user_tax

(

self

)

Get user involvement.

Returns

user involvement

Definition at line 225 of file config.py.

    def get_user_tax(self) -> float:
        """!
        @brief Get user involvement
        @return user involvement
        """
        return get_dict_float(self.d_item, S_TAX, S_USER_TAX)
 

handle_config_data_read()

dict[str, Any] | None handle_config_data_read	(		self,
		str	s_file )

Try to read config data to handle duplicate items.

Parameters

s_file

: file to read

Returns

config data from file

Definition at line 439 of file config.py.

    def handle_config_data_read(self, s_file: str) -> dict[str, Any] | None:
        """!
        @brief Try to read config data to handle duplicate items.
        @param s_file : file to read
        @return config data from file
        """
        try:
            d_data = read_data_from_config_file(s_file)
        except (DuplicateSectionError, DuplicateOptionError) as e:
            log.debug(e)
            d_data = None
        return d_data
 
 

read_item_file()

bool read_item_file	(		self,
		str	s_file,
		bool	b_remove_file = False )

Read articles file configuration and save in settings.

Parameters

s_file	: file top read
b_remove_file	: [True] = delete file; [False] = don't delete file

Returns

status if data was imported

Definition at line 394 of file config.py.

    def read_item_file(self, s_file: str, b_remove_file: bool = False) -> bool:
        """!
        @brief Read articles file configuration and save in settings.
        @param s_file : file top read
        @param b_remove_file : [True] = delete file; [False] = don't delete file
        @return status if data was imported
        """
        log.debug("Import edited or new articles file: %s", s_file)
        config_data = self.handle_config_data_read(s_file)
        b_set_data = False
        self.ui.unblock_ui()  # unlock before set status to show status message
        if config_data is not None:
            l_possible_articles = [str(i) for i in range(1, ItemNumber.MAX + 1)]
            if any(value in config_data for value in l_possible_articles):
                b_set_data = True
            else:
                b_set_data = self.ui.confirm_dialog(["Import file?", "Datei importieren?"],
                                                    l_optional_text=[f"This file does not contain any articles data:\n{s_file}",
                                                                     f"Diese Datei enthält keine Artikel Daten:\n{s_file}"])
            if b_set_data:
                self.d_item = config_data
                self.update_extended_article_status()
                if not self.ui.test_mode:
                    write_articles_settings(self.d_item)
                if b_remove_file:
                    os.remove(s_file)
                # update header in printer
                self.ui.model.c_printer.set_header(self.get_header1(),
                                                   self.get_header2())
                self.ui.set_status(["Articles configuration changed", "Artikel Konfiguration wurde geändert"])
        else:
            if b_remove_file:
                b_edit = self.ui.confirm_dialog(["Invalid. Edit again?", "Ungültig. Erneut bearbeiten?"])
                if b_edit:
                    self.ui.edit_items_in_notepad(s_file)
                else:
                    self.ui.set_status(["Unable to read articles configuration with duplicate numbers",
                                        "Artikelkonfiguration mit doppelten Positionen kann nicht gelesen werden"], True)
            else:
                self.ui.set_status(["Unable to import articles configuration with duplicate numbers",
                                    "Importieren der Artikelkonfiguration mit doppelten Positionen nicht möglich"], True)
        if b_set_data:
            self.ui.update_screen()
        return b_set_data
 

read_user_file()

bool read_user_file	(		self,
		str	s_file,
		bool	b_remove_file = False )

Read user file configuration and save in settings.

Parameters

s_file	: file top read
b_remove_file	: [True] = delete file; [False] = don't delete file

Returns

status if data was imported

Definition at line 334 of file config.py.

    def read_user_file(self, s_file: str, b_remove_file: bool = False) -> bool:
        """!
        @brief Read user file configuration and save in settings.
        @param s_file : file top read
        @param b_remove_file : [True] = delete file; [False] = don't delete file
        @return status if data was imported
        """
        log.debug("Import edited or new user file: %s", s_file)
        config_data = self.handle_config_data_read(s_file)
        b_set_data = False
        self.ui.unblock_ui()  # unlock before set status to show status message
        if config_data is not None:
            d_read_user_dict = config_data
            if any(value in d_read_user_dict for value in L_ALLOWED_USER):
                b_set_data = True
            else:
                b_set_data = self.ui.confirm_dialog(["Import file?", "Datei importieren?"],
                                                    l_optional_text=[f"This file does not contain any user data:\n{s_file}",
                                                                     f"Diese Datei enthält keine Benutzer Daten:\n{s_file}"])
            if b_set_data:
                if (not self.ui.model.c_auth.check_user_login(EUser.ADMIN)) and (EUser.ADMIN.value in d_read_user_dict):
                    del d_read_user_dict[EUser.ADMIN.value]  # delete if other user write Admin PW to edit file
                if EUser.ADMIN.value not in d_read_user_dict:
                    if EUser.ADMIN.value in self.d_user:
                        d_read_user_dict[EUser.ADMIN.value] = self.d_user[EUser.ADMIN.value]  # restore admin pw if not present
                    else:
                        self.ui.set_status("No Admin data to restore", True)  # state not possible
                self.d_user = d_read_user_dict.copy()
            # default Admin PW if not valid
            if EUser.ADMIN.value not in self.d_user:
                self.d_user[EUser.ADMIN.value] = D_DEFAULT_USER[EUser.ADMIN.value].copy()
                self.d_user[EUser.ADMIN.value][S_PW] = DEFAULT_CODE
                self.ui.set_status([f"No Admin data. Password is set to default: {DEFAULT_CODE}",
                                    f"Keine Admin Daten. Passwort wurde zurückgesetzt: {DEFAULT_CODE}"], True)
            if S_PW not in self.d_user[EUser.ADMIN.value]:
                self.d_user[EUser.ADMIN.value][S_PW] = DEFAULT_CODE
                self.ui.set_status([f"No Admin Password data. Password is set to default: {DEFAULT_CODE}",
                                    f"Kein Admin Passwort. Passwort wurde zurückgesetzt: {DEFAULT_CODE}"], True)
            if not self.d_user[EUser.ADMIN.value][S_PW].isdigit() and self.d_user[EUser.ADMIN.value][S_PW] != "":
                self.d_user[EUser.ADMIN.value][S_PW] = DEFAULT_CODE
                self.ui.set_status([f"Admin password is invalid. Password is set to default: {DEFAULT_CODE}",
                                    f"Admin Passwort ist ungültig. Passwort wurde zurückgesetzt: {DEFAULT_CODE}"], True)
            if not self.ui.test_mode:
                self.store_user_data()
            if b_remove_file:
                os.remove(s_file)
            self.ui.set_status(["User configuration changed", "Benutzer Konfiguration wurde geändert"])
        else:
            if b_remove_file:
                b_edit = self.ui.confirm_dialog(["Invalid. Edit again?", "Ungültig. Erneut bearbeiten?"])
                if b_edit:
                    self.ui.edit_user_in_notepad(s_file)
                else:
                    self.ui.set_status(["Unable to read user configuration with duplicate users",
                                        "Benutzerkonfiguration mit doppelten Benutzern kann nicht gelesen werden"], True)
            else:
                self.ui.set_status(["Unable to import user configuration with duplicate users",
                                    "Importieren der Benutzerkonfiguration mit doppelten Benutzern nicht möglich"], True)
        return b_set_data
 

store_user_data()

None store_user_data

(

self

)

Store actual user data.

Definition at line 328 of file config.py.

    def store_user_data(self) -> None:
        """!
        @brief Store actual user data
        """
        write_user_settings(self.d_user)
 

update_extended_article_status()

None update_extended_article_status	(		self,
		bool	prevent_resize = False )

Update extended article status.

Parameters

prevent_resize

: prevent resize

Definition at line 125 of file config.py.

    def update_extended_article_status(self, prevent_resize: bool = False) -> None:
        """!
        @brief Update extended article status.
        @param prevent_resize : prevent resize
        """
        item_number_size = ItemNumber.MIN
        for i in range(ItemNumber.MAX, ItemNumber.MIN, -1):
            i_item_number = i
            s_item_name = self.get_item_button_name(i_item_number)
            if s_item_name != "":
                if i_item_number > ItemNumber.EXT:
                    item_number_size = ItemNumber.MAX
                    break
                if i_item_number > ItemNumber.MIN:
                    item_number_size = ItemNumber.EXT
                    break
        if self.item_number_size != item_number_size:
            self.item_number_size = item_number_size
            if not prevent_resize:
                self.ui.model.c_monitor.resize_window()  # resize only if extended view changed
 

Member Data Documentation

b_smartcard_id_present

bool b_smartcard_id_present = False

Definition at line 119 of file config.py.

d_item

d_item = sort_dict(read_articles_settings(), D_DEFAULT_ITEM)

Definition at line 121 of file config.py.

d_user

d_user = sort_dict(read_user_settings(), D_DEFAULT_USER)

Definition at line 120 of file config.py.

item_number_size

item_number_size = ItemNumber.MIN

Definition at line 122 of file config.py.

ui

ui = ui

Definition at line 118 of file config.py.

---

The documentation for this class was generated from the following file:

• config.py