Skip to content

fix(config.py): fix crashes if settings.yml is not up to date #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 4, 2025
Merged

fix(config.py): fix crashes if settings.yml is not up to date #887

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77f5ff8
fix(config.py): fix crashes if settings.yml is not up to date
electron271 Jun 4, 2025
8fdf5d7
refactor(config.py): improve missing config key handling
electron271 Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions tux/utils/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,25 @@ def convert_dict_str_to_int(original_dict: dict[str, int]) -> dict[int, int]:
workspace_root = Path(__file__).parent.parent.parent

config_file = workspace_root / "config/settings.yml"
config_file_example = workspace_root / "config/settings.yml.example"
config = yaml.safe_load(config_file.read_text())
config_example = yaml.safe_load(config_file_example.read_text())

missing_keys = set(config_example.keys()) - set(config.keys())
if missing_keys:
logger.warning(f"The config file is missing the following keys: {', '.join(missing_keys)}. ")
logger.warning(
"This has been automatically fixed by adding the missing keys with their default values TO THE LOADED CONFIG.",
)
for key in missing_keys:
config[key] = config_example[key]


class Config:
# Permissions
BOT_OWNER_ID: Final[int] = config["USER_IDS"]["BOT_OWNER"]
SYSADMIN_IDS: Final[list[int]] = config["USER_IDS"]["SYSADMINS"]
# ALLOW_SYSADMINS_EVAL: Final[bool] = config["ALLOW_SYSADMINS_EVAL"]
# default to false if not specified in config
_allow_sysadmins_eval = config.get("ALLOW_SYSADMINS_EVAL")
if _allow_sysadmins_eval is None:
logger.warning(
"ALLOW_SYSADMINS_EVAL not found in config, defaulting to False. "
"If you want to use the old behavior, please set it to True in your config.",
)
_allow_sysadmins_eval = False
ALLOW_SYSADMINS_EVAL: Final[bool] = _allow_sysadmins_eval
ALLOW_SYSADMINS_EVAL: Final[bool] = config["ALLOW_SYSADMINS_EVAL"]

# Production env
DEFAULT_PROD_PREFIX: Final[str] = config["BOT_INFO"]["PROD_PREFIX"]
Expand Down