From 456484cf7d43482e9ecd2d9c51bd0190a0051ffc Mon Sep 17 00:00:00 2001 From: Donald Zou Date: Fri, 17 Apr 2026 16:09:34 +0800 Subject: [PATCH] Chore: Corrected some documentation and missing parameters --- .gitignore | 2 +- src/modules/config/config.py | 10 +++++----- src/modules/config/config_utils.py | 4 ++-- src/modules/routes/locale.py | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index a395b4d..9c4f677 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ - +.idea/* *.db dist diff --git a/src/modules/config/config.py b/src/modules/config/config.py index 844b1c5..fd5641c 100644 --- a/src/modules/config/config.py +++ b/src/modules/config/config.py @@ -8,9 +8,9 @@ from .config_utils import config_utils class config(): @staticmethod def filter(config_data: dict, filter_keyword: str) -> tuple[bool, dict]: - ''' + """ Helper function to grab a specific part of the config - ''' + """ lower_filter_keyword = filter_keyword.lower() for section_name, section_values in config_data.items(): @@ -23,9 +23,9 @@ class config(): @staticmethod def read() -> tuple[bool, dict]: - ''' + """ check some basic things and then return the dict containing the config data - ''' + """ ok, candidate_path = config_utils.search_known_paths() if not ok: @@ -46,7 +46,7 @@ class config(): ok, config_data = config.read() if not ok: - log.error("failed to read the config succesfully") + log.error("failed to read the config successfully") return False if not config_utils.find_section(config_data, lower_target_section): diff --git a/src/modules/config/config_utils.py b/src/modules/config/config_utils.py index ddc57e7..5a5ffe1 100644 --- a/src/modules/config/config_utils.py +++ b/src/modules/config/config_utils.py @@ -8,9 +8,9 @@ import os class config_utils(): @staticmethod def search_known_paths() -> tuple[bool, str]: - ''' + """ Look at predefined paths on the filesystem for a config file - ''' + """ possible_config_locations = [ "./config.ini", diff --git a/src/modules/routes/locale.py b/src/modules/routes/locale.py index db68d8a..a0e56ab 100644 --- a/src/modules/routes/locale.py +++ b/src/modules/routes/locale.py @@ -40,7 +40,7 @@ class localeman: return json.load(lang_file) return None - def get_available_languages(): + def get_available_languages(self): available_languages_path = "./static/locales/supported_locales.json" with open(os.path.join(available_languages_path), "r") as f: