Compare commits

...

16 Commits

Author SHA1 Message Date
dw-0
065fc1ff7f Merge d5ec761f5f into 5eff560627 2024-06-19 21:17:12 +02:00
dw-0
d5ec761f5f refactor: use SimpleConfigParser and finalize the code
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2024-06-19 21:17:04 +02:00
dw-0
7889b00999 Merge commit 'a17171b88e982c8343761bf07c5a4373acdbd205' into feat/obico-for-v6 2024-06-19 21:14:50 +02:00
dw-0
a17171b88e Squashed 'kiauh/core/submodules/simple_config_parser/' changes from 2698f60..7aa6586
7aa6586 fix: sections can have hyphens in their second word
44cedf5 fix(tests): fix whitespaces in expected output

git-subtree-dir: kiauh/core/submodules/simple_config_parser
git-subtree-split: 7aa658654eeb08fd53831effbfba4503a61e0eff
2024-06-19 21:14:50 +02:00
dw-0
494545b0a9 Merge branch 'refs/heads/kiauh-v6-dev' into feat/obico-for-v6 2024-06-19 20:24:13 +02:00
dw-0
5eff560627 Merge remote-tracking branch 'origin/kiauh-v6-dev' into kiauh-v6-dev 2024-06-19 20:21:03 +02:00
Staubgeborener
93ba579232 refactor(klipper_backup): replace is_service_installed with service_instance_exists (#481)
* use service_instance_exists function

* change header in __init__.py

* remove is_service_installed function

* small fix
2024-06-19 20:17:52 +02:00
dw-0
5c090e88c3 refactor(settings): use SimpleConfigParser for KiauhSettings
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2024-06-19 20:12:39 +02:00
dw-0
08640e5b17 Squashed 'kiauh/core/submodules/simple_config_parser/' changes from 4d60d30..2698f60
2698f60 refactor: reset state on read method call

git-subtree-dir: kiauh/core/submodules/simple_config_parser
git-subtree-split: 2698f600e4bef3197d696a798f2c3436dabe836a
2024-06-19 20:06:45 +02:00
dw-0
c2dfabb326 Merge commit '08640e5b177595f5e84d4bf9194311282b1a91e2' into kiauh-v6-dev 2024-06-19 20:06:45 +02:00
dw-0
802eaccf57 refactor(scp): replace old config parser with new one, remove ConfigManager
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2024-06-16 21:46:21 +02:00
dw-0
c6cc3fc0f6 Squashed 'kiauh/core/submodules/simple_config_parser/' changes from 188dd1f..4d60d30
4d60d30 refactor: in multiline options we do not replace the option name
0a1fba5 refactor: set default indent to 4 spaces
ab522bf refactor: the value of an option can be a list of strings

git-subtree-dir: kiauh/core/submodules/simple_config_parser
git-subtree-split: 4d60d30a75e7151be7b38b7cdbb2c133711b0091
2024-06-16 18:57:15 +02:00
dw-0
7b9f9b1a67 Merge commit 'c6cc3fc0f6e6400714c67d316f2abf08527ad24e' into kiauh-v6-dev 2024-06-16 18:57:15 +02:00
dw-0
fbab9a769a feat(scp): add new config parser
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2024-06-16 18:17:05 +02:00
dw-0
60f8aef69b Squashed 'kiauh/core/submodules/simple_config_parser/' content from commit 188dd1f
git-subtree-dir: kiauh/core/submodules/simple_config_parser
git-subtree-split: 188dd1ffd80bf72a2dc6075147ddc9339b059c4b
2024-06-16 18:14:55 +02:00
dw-0
f73ee6e6a0 Merge commit '60f8aef69ba552ce8d31066d2e09829d1cca9df2' as 'kiauh/core/submodules/simple_config_parser' 2024-06-16 18:14:55 +02:00
42 changed files with 2231 additions and 251 deletions

View File

@@ -121,7 +121,7 @@ def update_crowsnest() -> None:
Logger.print_status("Updating Crowsnest ...")
settings = KiauhSettings()
if settings.get("kiauh", "backup_before_update"):
if settings.kiauh.backup_before_update:
bm = BackupManager()
bm.backup_directory(
"crowsnest",

View File

@@ -109,8 +109,8 @@ def install_klipper() -> None:
def setup_klipper_prerequesites() -> None:
settings = KiauhSettings()
repo = settings.get("klipper", "repo_url")
branch = settings.get("klipper", "branch")
repo = settings.klipper.repo_url
branch = settings.klipper.branch
git_clone_wrapper(repo, KLIPPER_DIR, branch)
@@ -144,13 +144,13 @@ def update_klipper() -> None:
return
settings = KiauhSettings()
if settings.get("kiauh", "backup_before_update"):
if settings.kiauh.backup_before_update:
backup_klipper_dir()
instance_manager = InstanceManager(Klipper)
instance_manager.stop_all_instance()
git_pull_wrapper(repo=settings.get("klipper", "repo_url"), target_dir=KLIPPER_DIR)
git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
# install possible new system packages
install_klipper_packages(KLIPPER_DIR)

View File

@@ -34,10 +34,12 @@ from components.webui_client.client_config.client_config_setup import (
create_client_config_symlink,
)
from core.backup_manager.backup_manager import BackupManager
from core.config_manager.config_manager import ConfigManager
from core.instance_manager.base_instance import BaseInstance
from core.instance_manager.instance_manager import InstanceManager
from core.instance_manager.name_scheme import NameScheme
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from utils import PRINTER_CFG_BACKUP_DIR
from utils.common import get_install_status
from utils.constants import CURRENT_USER
@@ -186,10 +188,11 @@ def klipper_to_multi_conversion(new_name: str) -> None:
# patch the virtual_sdcard sections path
# value to match the new printer_data foldername
cm = ConfigManager(new_instance.cfg_file)
if cm.config.has_section("virtual_sdcard"):
cm.set_value("virtual_sdcard", "path", str(new_instance.gcodes_dir))
cm.write_config()
scp = SimpleConfigParser()
scp.read(new_instance.cfg_file)
if scp.has_section("virtual_sdcard"):
scp.set("virtual_sdcard", "path", str(new_instance.gcodes_dir))
scp.write(new_instance.cfg_file)
# finalize creating the new instance
im.create_instance()
@@ -292,18 +295,19 @@ def create_example_printer_cfg(
Logger.print_error(f"Unable to create example printer.cfg:\n{e}")
return
cm = ConfigManager(target)
cm.set_value("virtual_sdcard", "path", str(instance.gcodes_dir))
scp = SimpleConfigParser()
scp.read(target)
scp.set("virtual_sdcard", "path", str(instance.gcodes_dir))
# include existing client configs in the example config
if clients is not None and len(clients) > 0:
for c in clients:
client_config = c.client_config
section = client_config.config_section
cm.config.add_section(section=section)
scp.add_section(section=section)
create_client_config_symlink(client_config, [instance])
cm.write_config()
scp.write(target)
Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")

View File

@@ -124,7 +124,7 @@ def update_klipperscreen() -> None:
cmd_sysctl_service("KlipperScreen", "stop")
settings = KiauhSettings()
if settings.get("kiauh", "backup_before_update"):
if settings.kiauh.backup_before_update:
backup_klipperscreen_dir()
git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)

View File

@@ -120,7 +120,7 @@ def update_mobileraker() -> None:
cmd_sysctl_service("mobileraker", "stop")
settings = KiauhSettings()
if settings.get("kiauh", "backup_before_update"):
if settings.kiauh.backup_before_update:
backup_mobileraker_dir()
git_pull_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)

View File

@@ -6,14 +6,17 @@
# #
# This file may be distributed under the terms of the GNU GPLv3 license #
# ======================================================================= #
from __future__ import annotations
import subprocess
from pathlib import Path
from typing import List, Union
from typing import List
from components.moonraker import MODULE_PATH, MOONRAKER_DIR, MOONRAKER_ENV_DIR
from core.config_manager.config_manager import ConfigManager
from core.instance_manager.base_instance import BaseInstance
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from utils.constants import SYSTEMD
from utils.logger import Logger
@@ -144,11 +147,12 @@ class Moonraker(BaseInstance):
)
return env_file_content
def _get_port(self) -> Union[int, None]:
def _get_port(self) -> int | None:
if not self.cfg_file.is_file():
return None
cm = ConfigManager(cfg_file=self.cfg_file)
port = cm.get_value("server", "port")
scp = SimpleConfigParser()
scp.read(self.cfg_file)
port = scp.getint("server", "port", fallback=None)
return int(port) if port is not None else port
return port

View File

@@ -137,8 +137,8 @@ def check_moonraker_install_requirements() -> bool:
def setup_moonraker_prerequesites() -> None:
settings = KiauhSettings()
repo = settings.get("moonraker", "repo_url")
branch = settings.get("moonraker", "branch")
repo = settings.moonraker.repo_url
branch = settings.moonraker.branch
git_clone_wrapper(repo, MOONRAKER_DIR, branch)
@@ -200,14 +200,14 @@ def update_moonraker() -> None:
return
settings = KiauhSettings()
if settings.get("kiauh", "backup_before_update"):
if settings.kiauh.backup_before_update:
backup_moonraker_dir()
instance_manager = InstanceManager(Moonraker)
instance_manager.stop_all_instance()
git_pull_wrapper(
repo=settings.get("moonraker", "repo_url"), target_dir=MOONRAKER_DIR
repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR
)
# install possible new system packages

View File

@@ -23,8 +23,10 @@ from components.webui_client.base_data import BaseWebClient
from components.webui_client.client_utils import enable_mainsail_remotemode
from components.webui_client.mainsail_data import MainsailData
from core.backup_manager.backup_manager import BackupManager
from core.config_manager.config_manager import ConfigManager
from core.instance_manager.instance_manager import InstanceManager
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from utils.common import get_install_status
from utils.logger import Logger
from utils.sys_utils import (
@@ -76,13 +78,21 @@ def create_example_moonraker_conf(
ip.extend(["0", "0/16"])
uds = instance.comms_dir.joinpath("klippy.sock")
cm = ConfigManager(target)
trusted_clients = f"\n{'.'.join(ip)}"
trusted_clients += cm.get_value("authorization", "trusted_clients")
scp = SimpleConfigParser()
scp.read(target)
trusted_clients: List[str] = [
".".join(ip),
*scp.get("authorization", "trusted_clients"),
]
cm.set_value("server", "port", str(port))
cm.set_value("server", "klippy_uds_address", str(uds))
cm.set_value("authorization", "trusted_clients", trusted_clients)
scp.set("server", "port", str(port))
scp.set("server", "klippy_uds_address", str(uds))
scp.set(
"authorization",
"trusted_clients",
"\n".join(trusted_clients),
True,
)
# add existing client and client configs in the update section
if clients is not None and len(clients) > 0:
@@ -95,9 +105,9 @@ def create_example_moonraker_conf(
("repo", c.repo_path),
("path", c.client_dir),
]
cm.config.add_section(section=c_section)
scp.add_section(section=c_section)
for option in c_options:
cm.config.set(c_section, option[0], option[1])
scp.set(c_section, option[0], option[1])
# client config part
c_config = c.client_config
@@ -110,11 +120,11 @@ def create_example_moonraker_conf(
("origin", c_config.repo_url),
("managed_services", "klipper"),
]
cm.config.add_section(section=c_config_section)
scp.add_section(section=c_config_section)
for option in c_config_options:
cm.config.set(c_config_section, option[0], option[1])
scp.set(c_config_section, option[0], option[1])
cm.write_config()
scp.write(target)
Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")
@@ -150,14 +160,15 @@ def moonraker_to_multi_conversion(new_name: str) -> None:
im.current_instance = new_instance
# patch the server sections klippy_uds_address value to match the new printer_data foldername
cm = ConfigManager(new_instance.cfg_file)
if cm.config.has_section("server"):
cm.set_value(
scp = SimpleConfigParser()
scp.read(new_instance.cfg_file)
if scp.has_section("server"):
scp.set(
"server",
"klippy_uds_address",
str(new_instance.comms_dir.joinpath("klippy.sock")),
)
cm.write_config()
scp.write(new_instance.cfg_file)
# create, enable and start the new moonraker instance
im.create_instance()

View File

@@ -102,7 +102,7 @@ def update_client_config(client: BaseWebClient) -> None:
return
settings = KiauhSettings()
if settings.get("kiauh", "backup_before_update"):
if settings.kiauh.backup_before_update:
backup_client_config_data(client)
git_pull_wrapper(client_config.repo_url, client_config.config_dir)

View File

@@ -1,83 +0,0 @@
# ======================================================================= #
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
# #
# This file is part of KIAUH - Klipper Installation And Update Helper #
# https://github.com/dw-0/kiauh #
# #
# This file may be distributed under the terms of the GNU GPLv3 license #
# ======================================================================= #
import configparser
from pathlib import Path
from typing import Union
from utils.logger import Logger
# noinspection PyMethodMayBeStatic
class ConfigManager:
def __init__(self, cfg_file: Path):
self.config_file = cfg_file
self.config = CustomConfigParser()
if cfg_file.is_file():
self.read_config()
def read_config(self) -> None:
if not self.config_file:
Logger.print_error("Unable to read config file. File not found.")
return
self.config.read_file(open(self.config_file, "r"))
def write_config(self) -> None:
with open(self.config_file, "w") as cfg:
self.config.write(cfg)
def get_value(self, section: str, key: str, silent=True) -> Union[str, bool, None]:
if not self.config.has_section(section):
if not silent:
log = f"Section not defined. Unable to read section: [{section}]."
Logger.print_error(log)
return None
if not self.config.has_option(section, key):
if not silent:
log = f"Option not defined in section [{section}]. Unable to read option: '{key}'."
Logger.print_error(log)
return None
value = self.config.get(section, key)
if value == "True" or value == "true":
return True
elif value == "False" or value == "false":
return False
else:
return value
def set_value(self, section: str, key: str, value: str):
self.config.set(section, key, value)
class CustomConfigParser(configparser.ConfigParser):
"""
A custom ConfigParser class overwriting the write() method of configparser.Configparser.
Key and value will be delimited by a ": ".
Note the whitespace AFTER the colon, which is the whole reason for that overwrite.
"""
def write(self, fp, space_around_delimiters=False):
if self._defaults:
fp.write("[%s]\n" % configparser.DEFAULTSECT)
for key, value in self._defaults.items():
fp.write("%s: %s\n" % (key, str(value).replace("\n", "\n\t")))
fp.write("\n")
for section in self._sections:
fp.write("[%s]\n" % section)
for key, value in self._sections[section].items():
if key == "__name__":
continue
if (value is not None) or (self._optcre == self.OPTCRE):
key = ": ".join((key, str(value).replace("\n", "\n\t")))
fp.write("%s\n" % key)
fp.write("\n")

View File

@@ -94,28 +94,19 @@ class SettingsMenu(BaseMenu):
print(menu, end="")
def _load_settings(self):
self.kiauh_settings = KiauhSettings()
self.settings = KiauhSettings()
self._format_repo_str("klipper")
self._format_repo_str("moonraker")
self.auto_backups_enabled = self.kiauh_settings.get(
"kiauh",
"backup_before_update",
)
self.mainsail_unstable = self.kiauh_settings.get(
"mainsail",
"unstable_releases",
)
self.fluidd_unstable = self.kiauh_settings.get(
"fluidd",
"unstable_releases",
)
self.auto_backups_enabled = self.settings.kiauh.backup_before_update
self.mainsail_unstable = self.settings.mainsail.unstable_releases
self.fluidd_unstable = self.settings.fluidd.unstable_releases
def _format_repo_str(self, repo_name: str) -> None:
repo = self.kiauh_settings.get(repo_name, "repo_url")
repo = self.settings.get(repo_name, "repo_url")
repo = f"{'/'.join(repo.rsplit('/', 2)[-2:])}"
branch = self.kiauh_settings.get(repo_name, "branch")
branch = self.settings.get(repo_name, "branch")
branch = f"({COLOR_CYAN}@ {branch}{RESET_FORMAT})"
setattr(self, f"{repo_name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT} {branch}")
@@ -156,9 +147,9 @@ class SettingsMenu(BaseMenu):
)
if get_confirm("Apply changes?", allow_go_back=True):
self.kiauh_settings.set(repo_name, "repo_url", repo_url)
self.kiauh_settings.set(repo_name, "branch", branch)
self.kiauh_settings.save()
self.settings.set(repo_name, "repo_url", repo_url)
self.settings.set(repo_name, "branch", branch)
self.settings.save()
self._load_settings()
Logger.print_ok("Changes saved!")
else:
@@ -189,8 +180,8 @@ class SettingsMenu(BaseMenu):
im = InstanceManager(_type)
im.stop_all_instance()
repo = self.kiauh_settings.get(name, "repo_url")
branch = self.kiauh_settings.get(name, "branch")
repo = self.settings.get(name, "repo_url")
branch = self.settings.get(name, "branch")
git_clone_wrapper(repo, target_dir, branch)
im.start_all_instance()
@@ -203,27 +194,15 @@ class SettingsMenu(BaseMenu):
def toggle_mainsail_release(self, **kwargs):
self.mainsail_unstable = not self.mainsail_unstable
self.kiauh_settings.set(
"mainsail",
"unstable_releases",
self.mainsail_unstable,
)
self.kiauh_settings.save()
self.settings.mainsail.unstable_releases = self.mainsail_unstable
self.settings.save()
def toggle_fluidd_release(self, **kwargs):
self.fluidd_unstable = not self.fluidd_unstable
self.kiauh_settings.set(
"fluidd",
"unstable_releases",
self.fluidd_unstable,
)
self.kiauh_settings.save()
self.settings.fluidd.unstable_releases = self.fluidd_unstable
self.settings.save()
def toggle_backup_before_update(self, **kwargs):
self.auto_backups_enabled = not self.auto_backups_enabled
self.kiauh_settings.set(
"kiauh",
"backup_before_update",
self.auto_backups_enabled,
)
self.kiauh_settings.save()
self.settings.kiauh.backup_before_update = self.auto_backups_enabled
self.settings.save()

View File

@@ -6,12 +6,16 @@
# #
# This file may be distributed under the terms of the GNU GPLv3 license #
# ======================================================================= #
from __future__ import annotations
import configparser
import textwrap
from typing import Dict, Union
from typing import Union
from core.config_manager.config_manager import CustomConfigParser
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
NoOptionError,
NoSectionError,
SimpleConfigParser,
)
from utils.constants import COLOR_RED, RESET_FORMAT
from utils.logger import Logger
from utils.sys_utils import kill
@@ -19,6 +23,35 @@ from utils.sys_utils import kill
from kiauh import PROJECT_ROOT
class AppSettings:
def __init__(self) -> None:
self.backup_before_update = None
class KlipperSettings:
def __init__(self) -> None:
self.repo_url = None
self.branch = None
class MoonrakerSettings:
def __init__(self) -> None:
self.repo_url = None
self.branch = None
class MainsailSettings:
def __init__(self) -> None:
self.port = None
self.unstable_releases = None
class FluiddSettings:
def __init__(self) -> None:
self.port = None
self.unstable_releases = None
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class KiauhSettings:
@@ -36,32 +69,69 @@ class KiauhSettings:
if self.__initialized:
return
self.__initialized = True
self.config = CustomConfigParser()
self.settings: Dict[str, Dict[str, Union[str, int, bool]]] = {}
self._load_settings()
self.config = SimpleConfigParser()
self.kiauh = AppSettings()
self.klipper = KlipperSettings()
self.moonraker = MoonrakerSettings()
self.mainsail = MainsailSettings()
self.fluidd = FluiddSettings()
self.kiauh.backup_before_update = None
self.klipper.repo_url = None
self.klipper.branch = None
self.moonraker.repo_url = None
self.moonraker.branch = None
self.mainsail.port = None
self.mainsail.unstable_releases = None
self.fluidd.port = None
self.fluidd.unstable_releases = None
self._load_config()
def get(self, section: str, option: str) -> Union[str, int, bool]:
return self.settings[section][option]
"""
Get a value from the settings state by providing the section and option name as strings.
Prefer direct access to the properties, as it is usually safer!
:param section: The section name as string.
:param option: The option name as string.
:return: The value of the option as string, int or bool.
"""
try:
section = getattr(self, section)
value = getattr(section, option)
return value
except AttributeError:
raise
def set(self, section: str, option: str, value: Union[str, int, bool]) -> None:
self.settings[section][option] = value
"""
Set a value in the settings state by providing the section and option name as strings.
Prefer direct access to the properties, as it is usually safer!
:param section: The section name as string.
:param option: The option name as string.
:param value: The value to set as string, int or bool.
"""
try:
section = getattr(self, section)
section.option = value
except AttributeError:
raise
def save(self) -> None:
for section, option in self.settings.items():
self.config[section] = option
with open(self._custom_cfg, "w") as configfile:
self.config.write(configfile)
self._load_settings()
self._set_config_options()
self.config.write(self._custom_cfg)
self._load_config()
def _load_settings(self) -> None:
if self._custom_cfg.exists():
self.config.read(self._custom_cfg)
elif self._default_cfg.exists():
self.config.read(self._default_cfg)
else:
def _load_config(self) -> None:
if not self._custom_cfg.exists() or not self._default_cfg.exists():
self._kill()
cfg = self._custom_cfg if self._custom_cfg.exists() else self._default_cfg
self.config.read(cfg)
self._validate_cfg()
self._parse_settings()
self._read_settings()
def _validate_cfg(self) -> None:
try:
@@ -80,11 +150,11 @@ class KiauhSettings:
err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
Logger.print_error(err)
kill()
except configparser.NoSectionError:
except NoSectionError:
err = f"Missing section '{self._v_section}' in config file"
Logger.print_error(err)
kill()
except configparser.NoOptionError:
except NoOptionError:
err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
Logger.print_error(err)
kill()
@@ -103,18 +173,43 @@ class KiauhSettings:
if v.isdigit() or v.lower() == "true" or v.lower() == "false":
raise ValueError
def _parse_settings(self):
for s in self.config.sections():
self.settings[s] = {}
for o, v in self.config.items(s):
if v.lower() == "true":
self.settings[s][o] = True
elif v.lower() == "false":
self.settings[s][o] = False
elif v.isdigit():
self.settings[s][o] = int(v)
else:
self.settings[s][o] = v
def _read_settings(self):
self.kiauh.backup_before_update = self.config.getboolean(
"kiauh", "backup_before_update"
)
self.klipper.repo_url = self.config.get("klipper", "repo_url")
self.klipper.branch = self.config.get("klipper", "branch")
self.moonraker.repo_url = self.config.get("moonraker", "repo_url")
self.moonraker.branch = self.config.get("moonraker", "branch")
self.mainsail.port = self.config.getint("mainsail", "port")
self.mainsail.unstable_releases = self.config.getboolean(
"mainsail", "unstable_releases"
)
self.fluidd.port = self.config.getint("fluidd", "port")
self.fluidd.unstable_releases = self.config.getboolean(
"fluidd", "unstable_releases"
)
def _set_config_options(self):
self.config.set(
"kiauh",
"backup_before_update",
str(self.kiauh.backup_before_update),
)
self.config.set("klipper", "repo_url", self.klipper.repo_url)
self.config.set("klipper", "branch", self.klipper.branch)
self.config.set("moonraker", "repo_url", self.moonraker.repo_url)
self.config.set("moonraker", "branch", self.moonraker.branch)
self.config.set("mainsail", "port", str(self.mainsail.port))
self.config.set(
"mainsail",
"unstable_releases",
str(self.mainsail.unstable_releases),
)
self.config.set("fluidd", "port", str(self.fluidd.port))
self.config.set(
"fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
)
def _kill(self) -> None:
l1 = "!!! ERROR !!!"

View File

@@ -0,0 +1,13 @@
# see https://editorconfig.org/
root = true
[*]
end_of_line = lf
trim_trailing_whitespace = true
indent_style = space
insert_final_newline = true
indent_size = 4
charset = utf-8
[*.py]
max_line_length = 88

View File

@@ -0,0 +1,13 @@
*.py[cod]
*.pyc
__pycache__
.pytest_cache/
.idea/
.vscode/
.venv*/
venv*/
.coverage
htmlcov/

View File

@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

View File

@@ -0,0 +1,6 @@
# Simple Config Parser
A custom config parser inspired by Python's configparser module.
Specialized for handling Klipper style config files.

View File

@@ -0,0 +1,66 @@
[project]
name = "simple-config-parser"
version = "0.0.1"
description = "A simple config parser for Python"
authors = [
{name = "Dominik Willner", email = "th33xitus@gmail.com"},
]
readme = "README.md"
license = {text = "GPL-3.0-only"}
requires-python = ">=3.8"
[project.urls]
homepage = "https://github.com/dw-0/simple-config-parser"
repository = "https://github.com/dw-0/simple-config-parser"
documentation = "https://github.com/dw-0/simple-config-parser"
[project.optional-dependencies]
dev=["ruff"]
[tool.ruff]
required-version = ">=0.3.4"
respect-gitignore = true
exclude = [".git",".github", "./docs"]
line-length = 88
indent-width = 4
output-format = "full"
[tool.ruff.format]
indent-style = "space"
line-ending = "lf"
quote-style = "double"
[tool.ruff.lint]
extend-select = ["I"]
[tool.pytest.ini_options]
minversion = "8.2.1"
testpaths = ["tests/**/*.py"]
addopts = "--cov --cov-config=pyproject.toml --cov-report=html"
[tool.coverage.run]
branch = true
source = ["src.simple_config_parser"]
[tool.coverage.report]
# Regexes for lines to exclude from consideration
exclude_also = [
# Don't complain about missing debug-only code:
"def __repr__",
"if self\\.debug",
# Don't complain if tests don't hit defensive assertion code:
"raise AssertionError",
"raise NotImplementedError",
# Don't complain if non-runnable code isn't run:
"if 0:",
"if __name__ == .__main__.:",
# Don't complain about abstract methods, they aren't run:
"@(abc\\.)?abstractmethod",
]
[tool.coverage.html]
title = "SimpleConfigParser Coverage Report"
directory = "htmlcov"

View File

@@ -0,0 +1,3 @@
ruff >= 0.3.4
pytest >= 8.2.1
pytest-cov >= 5.0.0

View File

@@ -0,0 +1,551 @@
# ======================================================================= #
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
# #
# https://github.com/dw-0/simple-config-parser #
# #
# This file may be distributed under the terms of the GNU GPLv3 license #
# ======================================================================= #
from __future__ import annotations
import re
from pathlib import Path
from typing import Callable, Dict, List, Match, Tuple, TypedDict
_UNSET = object()
class Section(TypedDict):
"""
A single section in the config file
- _raw: The raw representation of the section name
- options: A list of options in the section
"""
_raw: str
options: List[Option]
class Option(TypedDict, total=False):
"""
A single option in a section in the config file
- is_multiline: Whether the option is a multiline option
- option: The name of the option
- value: The value of the option
- _raw: The raw representation of the option
- _raw_value: The raw value of the option
A multinline option is an option that contains multiple lines of text following
the option name in the next line. The value of a multiline option is a list of
strings, where each string represents a single line of text.
"""
is_multiline: bool
option: str
value: str | List[str]
_raw: str
_raw_value: str | List[str]
class NoSectionError(Exception):
"""Raised when a section is not defined"""
def __init__(self, section: str):
msg = f"Section '{section}' is not defined"
super().__init__(msg)
class NoOptionError(Exception):
"""Raised when an option is not defined in a section"""
def __init__(self, option: str, section: str):
msg = f"Option '{option}' in section '{section}' is not defined"
super().__init__(msg)
class DuplicateSectionError(Exception):
"""Raised when a section is defined more than once"""
def __init__(self, section: str):
msg = f"Section '{section}' is defined more than once"
super().__init__(msg)
class DuplicateOptionError(Exception):
"""Raised when an option is defined more than once"""
def __init__(self, option: str, section: str):
msg = f"Option '{option}' in section '{section}' is defined more than once"
super().__init__(msg)
# noinspection PyMethodMayBeStatic
class SimpleConfigParser:
"""A customized config parser targeted at handling Klipper style config files"""
_SECTION_RE = re.compile(r"\s*\[(\w+\s?[\w\-]+)]\s*([#;].*)?$")
_OPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([^=:].*)\s*([#;].*)?$")
_MLOPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([#;].*)?$")
_COMMENT_RE = re.compile(r"^\s*([#;].*)?$")
_EMPTY_LINE_RE = re.compile(r"^\s*$")
BOOLEAN_STATES = {
"1": True,
"yes": True,
"true": True,
"on": True,
"0": False,
"no": False,
"false": False,
"off": False,
}
def __init__(self):
self._config: Dict = {}
self._header: List[str] = []
self._all_sections: List[str] = []
self._all_options: Dict = {}
self.section_name: str = ""
self.in_option_block: bool = False # whether we are in a multiline option block
def read(self, file: Path) -> None:
"""
Read the given file and store the result in the internal state.
Call this method before using any other methods. Calling this method
multiple times will reset the internal state on each call.
"""
self._reset_state()
try:
with open(file, "r") as f:
self._parse_config(f.readlines())
except OSError:
raise
def _reset_state(self):
"""Reset the internal state."""
self._config.clear()
self._header.clear()
self._all_sections.clear()
self._all_options.clear()
self.section_name = ""
self.in_option_block = False
def write(self, filename):
"""Write the internal state to the given file"""
content = self._construct_content()
with open(filename, "w") as f:
f.write(content)
def _construct_content(self) -> str:
"""
Constructs the content of the configuration file based on the internal state of
the _config object by iterating over the sections and their options. It starts
by checking if a header is present and extends the content list with its elements.
Then, for each section, it appends the raw representation of the section to the
content list. If the section has a body, it iterates over its options and extends
the content list with their raw representations. If an option is multiline, it
also extends the content list with its raw value. Finally, the content list is
joined into a single string and returned.
:return: The content of the configuration file as a string
"""
content: List[str] = []
if self._header is not None:
content.extend(self._header)
for section in self._config:
content.append(self._config[section]["_raw"])
if (sec_body := self._config[section].get("body")) is not None:
for option in sec_body:
content.extend(option["_raw"])
if option["is_multiline"]:
content.extend(option["_raw_value"])
content: str = "".join(content)
return content
def sections(self) -> List[str]:
"""Return a list of section names"""
return self._all_sections
def add_section(self, section: str) -> None:
"""Add a new section to the internal state"""
if section in self._all_sections:
raise DuplicateSectionError(section)
self._all_sections.append(section)
self._all_options[section] = {}
self._config[section] = {"_raw": f"\n[{section}]\n", "body": []}
def remove_section(self, section: str) -> None:
"""Remove the given section"""
if section not in self._all_sections:
raise NoSectionError(section)
del self._all_sections[self._all_sections.index(section)]
del self._all_options[section]
del self._config[section]
def options(self, section) -> List[str]:
"""Return a list of option names for the given section name"""
return self._all_options.get(section)
def get(
self, section: str, option: str, fallback: str | _UNSET = _UNSET
) -> str | List[str]:
"""
Return the value of the given option in the given section
If the key is not found and 'fallback' is provided, it is used as
a fallback value.
"""
try:
if section not in self._all_sections:
raise NoSectionError(section)
if option not in self._all_options.get(section):
raise NoOptionError(option, section)
return self._all_options[section][option]
except (NoSectionError, NoOptionError):
if fallback is _UNSET:
raise
return fallback
def getint(self, section: str, option: str, fallback: int | _UNSET = _UNSET) -> int:
"""Return the value of the given option in the given section as an int"""
return self._get_conv(section, option, int, fallback=fallback)
def getfloat(
self, section: str, option: str, fallback: float | _UNSET = _UNSET
) -> float:
return self._get_conv(section, option, float, fallback=fallback)
def getboolean(
self, section: str, option: str, fallback: bool | _UNSET = _UNSET
) -> bool:
return self._get_conv(
section, option, self._convert_to_boolean, fallback=fallback
)
def _convert_to_boolean(self, value) -> bool:
if value.lower() not in self.BOOLEAN_STATES:
raise ValueError("Not a boolean: %s" % value)
return self.BOOLEAN_STATES[value.lower()]
def _get_conv(
self,
section: str,
option: str,
conv: Callable[[str], int | float | bool],
fallback: _UNSET = _UNSET,
) -> int | float | bool:
try:
return conv(self.get(section, option, fallback))
except:
if fallback is not _UNSET:
return fallback
raise
def items(self, section: str) -> List[Tuple[str, str]]:
"""Return a list of (option, value) tuples for a specific section"""
if section not in self._all_sections:
raise NoSectionError(section)
result = []
for _option in self._all_options[section]:
result.append((_option, self._all_options[section][_option]))
return result
def set(
self,
section: str,
option: str,
value: str,
multiline: bool = False,
indent: int = 4,
) -> None:
"""Set the given option to the given value in the given section
If the option is already defined, it will be overwritten. If the option
is not defined yet, it will be added to the section body.
The multiline parameter can be used to specify whether the value is
multiline or not. If it is not specified, the value will be considered
as multiline if it contains a newline character. The value will then be split
into multiple lines. If the value does not contain a newline character, it
will be considered as a single line value. The indent parameter can be used
to specify the indentation of the multiline value. Indentations are with spaces.
:param section: The section to set the option in
:param option: The option to set
:param value: The value to set
:param multiline: Whether the value is multiline or not
:param indent: The indentation for multiline values
"""
if section not in self._all_sections:
raise NoSectionError(section)
# prepare the options value and raw value depending on the multiline flag
_raw_value: List[str] | None = None
if multiline or "\n" in value:
_multiline = True
_raw: str = f"{option}:\n"
_value: List[str] = value.split("\n")
_raw_value: List[str] = [f"{' ' * indent}{v}\n" for v in _value]
else:
_multiline = False
_raw: str = f"{option}: {value}\n"
_value: str = value
# the option does not exist yet
if option not in self._all_options.get(section):
_option: Option = {
"is_multiline": _multiline,
"option": option,
"value": _value,
"_raw": _raw,
}
if _raw_value is not None:
_option["_raw_value"] = _raw_value
self._config[section]["body"].insert(0, _option)
# the option exists and we need to update it
else:
for _option in self._config[section]["body"]:
if _option["option"] == option:
if multiline:
_option["_raw"] = _raw
else:
# we preserve inline comments by replacing the old value with the new one
_option["_raw"] = _option["_raw"].replace(
_option["value"], _value
)
_option["value"] = _value
if _raw_value is not None:
_option["_raw_value"] = _raw_value
break
self._all_options[section][option] = _value
def remove_option(self, section: str, option: str) -> None:
"""Remove the given option from the given section"""
if section not in self._all_sections:
raise NoSectionError(section)
if option not in self._all_options.get(section):
raise NoOptionError(option, section)
for _option in self._config[section]["body"]:
if _option["option"] == option:
del self._all_options[section][option]
self._config[section]["body"].remove(_option)
break
def has_section(self, section: str) -> bool:
"""Return True if the given section exists, False otherwise"""
return section in self._all_sections
def has_option(self, section: str, option: str) -> bool:
"""Return True if the given option exists in the given section, False otherwise"""
return option in self._all_options.get(section)
def _is_section(self, line: str) -> bool:
"""Check if the given line contains a section definition"""
return self._SECTION_RE.match(line) is not None
def _is_option(self, line: str) -> bool:
"""Check if the given line contains an option definition"""
match: Match[str] | None = self._OPTION_RE.match(line)
if not match:
return False
# if there is no value, it's not a regular option but a multiline option
if match.group(2).strip() == "":
return False
if not match.group(1).strip() == "":
return True
return False
def _is_comment(self, line: str) -> bool:
"""Check if the given line is a comment"""
return self._COMMENT_RE.match(line) is not None
def _is_empty_line(self, line: str) -> bool:
"""Check if the given line is an empty line"""
return self._EMPTY_LINE_RE.match(line) is not None
def _is_multiline_option(self, line: str) -> bool:
"""Check if the given line starts a multiline option block"""
match: Match[str] | None = self._MLOPTION_RE.match(line)
if not match:
return False
return True
def _parse_config(self, content: List[str]) -> None:
"""Parse the given content and store the result in the internal state"""
_curr_multi_opt = ""
# THE ORDER MATTERS, DO NOT REORDER THE CONDITIONS!
for line in content:
if self._is_section(line):
self._parse_section(line)
elif self._is_option(line):
self._parse_option(line)
# if it's not a regular option with the value inline,
# it might be a might be a multiline option block
elif self._is_multiline_option(line):
self.in_option_block = True
_curr_multi_opt = self._OPTION_RE.match(line).group(1).strip()
self._add_option_to_section_body(_curr_multi_opt, "", line)
elif self.in_option_block:
self._parse_multiline_option(_curr_multi_opt, line)
# if it's nothing from above, it's probably a comment or an empty line
elif self._is_comment(line) or self._is_empty_line(line):
self._parse_comment(line)
def _parse_section(self, line: str) -> None:
"""Parse a section line and store the result in the internal state"""
match: Match[str] | None = self._SECTION_RE.match(line)
if not match:
return
self.in_option_block = False
section_name: str = match.group(1).strip()
self._store_internal_state_section(section_name, line)
def _store_internal_state_section(self, section: str, raw_value: str) -> None:
"""Store the given section and its raw value in the internal state"""
if section in self._all_sections:
raise DuplicateSectionError(section)
self.section_name = section
self._all_sections.append(section)
self._config[section]: Section = {"_raw": raw_value, "body": []}
def _parse_option(self, line: str) -> None:
"""Parse an option line and store the result in the internal state"""
self.in_option_block = False
match: Match[str] | None = self._OPTION_RE.match(line)
if not match:
return
option: str = match.group(1).strip()
value: str = match.group(2).strip()
if ";" in value:
i = value.index(";")
value = value[:i].strip()
elif "#" in value:
i = value.index("#")
value = value[:i].strip()
self._store_internal_state_option(option, value, line)
def _store_internal_state_option(
self, option: str, value: str, raw_value: str
) -> None:
"""Store the given option and its raw value in the internal state"""
section_options = self._all_options.setdefault(self.section_name, {})
if option in section_options:
raise DuplicateOptionError(option, self.section_name)
section_options[option] = value
self._add_option_to_section_body(option, value, raw_value)
def _parse_multiline_option(self, curr_ml_opt: str, line: str) -> None:
"""Parse a multiline option line and store the result in the internal state"""
section_options = self._all_options.setdefault(self.section_name, {})
multiline_options = section_options.setdefault(curr_ml_opt, [])
_cleaned_line = line.strip().strip("\n")
if _cleaned_line and not self._is_comment(line):
multiline_options.append(_cleaned_line)
# add the option to the internal multiline option value state
self._ensure_section_body_exists()
for _option in self._config[self.section_name]["body"]:
if _option.get("option") == curr_ml_opt:
_option.update(
is_multiline=True,
_raw_value=_option.get("_raw_value", []) + [line],
value=multiline_options,
)
def _parse_comment(self, line: str) -> None:
"""
Parse a comment line and store the result in the internal state
If the there was no previous section parsed, the lines are handled as
the file header and added to the internal header list as it means, that
we are at the very top of the file.
"""
self.in_option_block = False
if not self.section_name:
self._header.append(line)
else:
self._add_option_to_section_body("", "", line)
def _ensure_section_body_exists(self) -> None:
"""
Ensure that the section body exists in the internal state.
If the section body does not exist, it is created as an empty list
"""
if self.section_name not in self._config:
self._config.setdefault(self.section_name, {}).setdefault("body", [])
def _add_option_to_section_body(
self, option: str, value: str, line: str, is_multiline: bool = False
) -> None:
"""Add a raw option line to the internal state"""
self._ensure_section_body_exists()
new_option: Option = {
"is_multiline": is_multiline,
"option": option,
"value": value,
"_raw": line,
}
option_body = self._config[self.section_name]["body"]
option_body.append(new_option)

View File

@@ -0,0 +1,21 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Test SimpleConfigParser" type="tests" factoryName="py.test">
<module name="simple-config-parser" />
<option name="ENV_FILES" value="" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="PARENT_ENVS" value="true" />
<option name="SDK_HOME" value="" />
<option name="SDK_NAME" value="Python 3.8 (simple-config-parser)" />
<option name="WORKING_DIRECTORY" value="" />
<option name="IS_MODULE_SDK" value="false" />
<option name="ADD_CONTENT_ROOTS" value="true" />
<option name="ADD_SOURCE_ROOTS" value="true" />
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
<option name="_new_keywords" value="&quot;&quot;" />
<option name="_new_parameters" value="&quot;&quot;" />
<option name="_new_additionalArguments" value="&quot;-s -vv&quot;" />
<option name="_new_target" value="&quot;&quot;" />
<option name="_new_targetType" value="&quot;PATH&quot;" />
<method v="2" />
</configuration>
</component>

View File

@@ -0,0 +1,95 @@
import pytest
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
@pytest.fixture
def parser():
parser = SimpleConfigParser()
parser._header = ["header1\n", "header2\n"]
parser._config = {
"section1": {
"_raw": "[section1]\n",
"body": [
{
"_raw": "option1: value1\n",
"_raw_value": "value1\n",
"is_multiline": False,
"option": "option1",
"value": "value1",
},
{
"_raw": "option2: value2\n",
"_raw_value": "value2\n",
"is_multiline": False,
"option": "option2",
"value": "value2",
},
],
},
"section2": {
"_raw": "[section2]\n",
"body": [
{
"_raw": "option3: value3\n",
"_raw_value": "value3\n",
"is_multiline": False,
"option": "option3",
"value": "value3",
},
],
},
"section3": {
"_raw": "[section3]\n",
"body": [
{
"_raw": "option4:\n",
"_raw_value": [" value4\n", " value5\n", " value6\n"],
"is_multiline": True,
"option": "option4",
"value": ["value4", "value5", "value6"],
},
],
},
}
return parser
def test_construct_content(parser):
content = parser._construct_content()
assert (
content == "header1\nheader2\n"
"[section1]\n"
"option1: value1\n"
"option2: value2\n"
"[section2]\n"
"option3: value3\n"
"[section3]\n"
"option4:\n"
" value4\n"
" value5\n"
" value6\n"
)
def test_construct_content_no_header(parser):
parser._header = None
content = parser._construct_content()
assert (
content == "[section1]\n"
"option1: value1\n"
"option2: value2\n"
"[section2]\n"
"option3: value3\n"
"[section3]\n"
"option4:\n"
" value4\n"
" value5\n"
" value6\n"
)
def test_construct_content_no_sections(parser):
parser._config = {}
content = parser._construct_content()
assert content == "".join(parser._header)

View File

@@ -0,0 +1,83 @@
import pytest
from src.simple_config_parser.simple_config_parser import (
DuplicateOptionError,
DuplicateSectionError,
SimpleConfigParser,
)
@pytest.fixture
def parser():
return SimpleConfigParser()
class TestInternalStateChanges:
@pytest.mark.parametrize(
"given", ["dummy_section", "dummy_section 2", "another_section"]
)
def test_ensure_section_body_exists(self, parser, given):
parser._config = {}
parser.section_name = given
parser._ensure_section_body_exists()
assert parser._config[given] is not None
assert parser._config[given]["body"] == []
def test_add_option_to_section_body(self):
pass
@pytest.mark.parametrize(
"given", ["dummy_section", "dummy_section 2", "another_section\n"]
)
def test_store_internal_state_section(self, parser, given):
parser._store_internal_state_section(given, given)
assert parser._all_sections == [given]
assert parser._config[given]["body"] == []
assert parser._config[given]["_raw"] == given
def test_duplicate_section_error(self, parser):
section_name = "dummy_section"
parser._all_sections = [section_name]
with pytest.raises(DuplicateSectionError) as excinfo:
parser._store_internal_state_section(section_name, section_name)
message = f"Section '{section_name}' is defined more than once"
assert message in str(excinfo.value)
# Check that the internal state of the parser is correct
assert parser.in_option_block is False
assert parser.section_name == ""
assert parser._all_sections == [section_name]
@pytest.mark.parametrize(
"given_name, given_value, given_raw_value",
[("dummyoption", "dummyvalue", "dummyvalue\n")],
)
def test_store_internal_state_option(
self, parser, given_name, given_value, given_raw_value
):
parser.section_name = "dummy_section"
parser._store_internal_state_option(given_name, given_value, given_raw_value)
assert parser._all_options[parser.section_name] == {given_name: given_value}
new_option = {
"is_multiline": False,
"option": given_name,
"value": given_value,
"_raw": given_raw_value,
}
assert parser._config[parser.section_name]["body"] == [new_option]
def test_duplicate_option_error(self, parser):
option_name = "dummyoption"
value = "dummyvalue"
parser.section_name = "dummy_section"
parser._all_options = {parser.section_name: {option_name: value}}
with pytest.raises(DuplicateOptionError) as excinfo:
parser._store_internal_state_option(option_name, value, value)
message = f"Option '{option_name}' in section '{parser.section_name}' is defined more than once"
assert message in str(excinfo.value)

View File

@@ -0,0 +1,6 @@
testcases = [
"# comment # 1",
"; comment # 2",
" ; indented comment",
" # another indented comment",
]

View File

@@ -0,0 +1,19 @@
testcases = [
("option: value", "option", "value"),
("option : value", "option", "value"),
("option :value", "option", "value"),
("option= value", "option", "value"),
("option = value", "option", "value"),
("option =value", "option", "value"),
("option: value\n", "option", "value"),
("option: value # inline comment", "option", "value"),
("option: value # inline comment\n", "option", "value"),
("description: homing!", "description", "homing!"),
("description: inline macro :-)", "description", "inline macro :-)"),
("path: %GCODES_DIR%", "path", "%GCODES_DIR%"),
(
"serial = /dev/serial/by-id/<your-mcu-id>",
"serial",
"/dev/serial/by-id/<your-mcu-id>",
),
]

View File

@@ -0,0 +1,6 @@
testcases = [
("[test_section]", "test_section"),
("[test_section two]", "test_section two"),
("[section1] # inline comment", "section1"),
("[section2] ; second comment", "section2"),
]

View File

@@ -0,0 +1,92 @@
import pytest
from data.case_parse_comment import testcases as case_parse_comment
from data.case_parse_option import testcases as case_parse_option
from data.case_parse_section import testcases as case_parse_section
from src.simple_config_parser.simple_config_parser import (
Option,
SimpleConfigParser,
)
@pytest.fixture
def parser():
return SimpleConfigParser()
class TestLineParsing:
@pytest.mark.parametrize("given, expected", [*case_parse_section])
def test_parse_section(self, parser, given, expected):
parser._parse_section(given)
# Check that the internal state of the parser is correct
assert parser.section_name == expected
assert parser.in_option_block is False
assert parser._all_sections == [expected]
assert parser._config[expected]["_raw"] == given
assert parser._config[expected]["body"] == []
@pytest.mark.parametrize(
"given, expected_option, expected_value", [*case_parse_option]
)
def test_parse_option(self, parser, given, expected_option, expected_value):
section_name = "test_section"
parser.section_name = section_name
parser._parse_option(given)
# Check that the internal state of the parser is correct
assert parser.section_name == section_name
assert parser.in_option_block is False
assert parser._all_options[section_name][expected_option] == expected_value
section_option = parser._config[section_name]["body"][0]
assert section_option["option"] == expected_option
assert section_option["value"] == expected_value
assert section_option["_raw"] == given
@pytest.mark.parametrize(
"option, next_line",
[("gcode", "next line"), ("gcode", " {{% some jinja template %}}")],
)
def test_parse_multiline_option(self, parser, option, next_line):
parser.section_name = "dummy_section"
parser.in_option_block = True
parser._add_option_to_section_body(option, "", option)
parser._parse_multiline_option(option, next_line)
cleaned_next_line = next_line.strip().strip("\n")
assert parser._all_options[parser.section_name] is not None
assert parser._all_options[parser.section_name][option] == [cleaned_next_line]
expected_option: Option = {
"is_multiline": True,
"option": option,
"value": [cleaned_next_line],
"_raw": option,
"_raw_value": [next_line],
}
assert parser._config[parser.section_name]["body"] == [expected_option]
@pytest.mark.parametrize("given", [*case_parse_comment])
def test_parse_comment(self, parser, given):
parser.section_name = "dummy_section"
parser._parse_comment(given)
# internal state checks after parsing
assert parser.in_option_block is False
expected_option = {
"is_multiline": False,
"_raw": given,
"option": "",
"value": "",
}
assert parser._config[parser.section_name]["body"] == [expected_option]
@pytest.mark.parametrize("given", ["# header line", "; another header line"])
def test_parse_header_comment(self, parser, given):
parser.section_name = ""
parser._parse_comment(given)
assert parser.in_option_block is False
assert parser._header == [given]

View File

@@ -0,0 +1,9 @@
testcases = [
("# an arbitrary comment", True),
("; another arbitrary comment", True),
(" ; indented comment", True),
(" # indented comment", True),
("not_a: comment", False),
("also_not_a= comment", False),
("[definitely_not_a_comment]", False),
]

View File

@@ -0,0 +1,9 @@
testcases = [
("", True),
(" ", True),
("not empty", False),
(" # indented comment", False),
("not: empty", False),
("also_not= empty", False),
("[definitely_not_empty]", False),
]

View File

@@ -0,0 +1,17 @@
testcases = [
("valid_option:", True),
("valid_option:\n", True),
("valid_option: ; inline comment", True),
("valid_option: # inline comment", True),
("valid_option :", True),
("valid_option=", True),
("valid_option= ", True),
("valid_option =", True),
("valid_option = ", True),
("invalid_option ==", False),
("invalid_option :=", False),
("not_a_valid_option", False),
("", False),
("# that's a comment", False),
("; that's a comment", False),
]

View File

@@ -0,0 +1,30 @@
testcases = [
("valid_option: value", True),
("valid_option: value\n", True),
("valid_option: value ; inline comment", True),
("valid_option: value # inline comment", True),
("valid_option: value # inline comment\n", True),
("valid_option : value", True),
("valid_option :value", True),
("valid_option= value", True),
("valid_option = value", True),
("valid_option =value", True),
("invalid_option:", False),
("invalid_option=", False),
("invalid_option:: value", False),
("invalid_option :: value", False),
("invalid_option ::value", False),
("invalid_option== value", False),
("invalid_option == value", False),
("invalid_option ==value", False),
("invalid_option:= value", False),
("invalid_option := value", False),
("invalid_option :=value", False),
("[that_is_a_section]", False),
("[that_is_section two]", False),
("not_a_valid_option", False),
("description: homing!", True),
("description: inline macro :-)", True),
("path: %GCODES_DIR%", True),
("serial = /dev/serial/by-id/<your-mcu-id>", True),
]

View File

@@ -0,0 +1,7 @@
testcases = [
("[example_section]", True),
("[update_manager moonraker-obico]", True),
("[example_section two]", True),
("not_a_valid_section", False),
("section: invalid", False),
]

View File

@@ -0,0 +1,37 @@
import pytest
from data.case_line_is_comment import testcases as case_line_is_comment
from data.case_line_is_empty import testcases as case_line_is_empty
from data.case_line_is_multiline_option import (
testcases as case_line_is_multiline_option,
)
from data.case_line_is_option import testcases as case_line_is_option
from data.case_line_is_section import testcases as case_line_is_section
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
@pytest.fixture
def parser():
return SimpleConfigParser()
class TestLineTypeDetection:
@pytest.mark.parametrize("given, expected", [*case_line_is_section])
def test_line_is_section(self, parser, given, expected):
assert parser._is_section(given) is expected
@pytest.mark.parametrize("given, expected", [*case_line_is_option])
def test_line_is_option(self, parser, given, expected):
assert parser._is_option(given) is expected
@pytest.mark.parametrize("given, expected", [*case_line_is_multiline_option])
def test_line_is_multiline_option(self, parser, given, expected):
assert parser._is_multiline_option(given) is expected
@pytest.mark.parametrize("given, expected", [*case_line_is_comment])
def test_line_is_comment(self, parser, given, expected):
assert parser._is_comment(given) is expected
@pytest.mark.parametrize("given, expected", [*case_line_is_empty])
def test_line_is_empty(self, parser, given, expected):
assert parser._is_empty_line(given) is expected

View File

@@ -0,0 +1,196 @@
import pytest
from src.simple_config_parser.simple_config_parser import (
DuplicateSectionError,
NoOptionError,
NoSectionError,
SimpleConfigParser,
)
@pytest.fixture
def parser():
return SimpleConfigParser()
class TestPublicAPI:
def test_has_section(self, parser):
parser._all_sections = ["section1"]
assert parser.has_section("section1") is True
@pytest.mark.parametrize("section", ["section1", "section2", "section three"])
def test_add_section(self, parser, section):
parser.add_section(section)
assert section in parser._all_sections
assert parser._all_options[section] == {}
cfg_section = {"_raw": f"\n[{section}]\n", "body": []}
assert parser._config[section] == cfg_section
@pytest.mark.parametrize("section", ["section1", "section2", "section three"])
def test_add_existing_section(self, parser, section):
parser._all_sections = [section]
with pytest.raises(DuplicateSectionError):
parser.add_section(section)
assert parser._all_sections == [section]
@pytest.mark.parametrize("section", ["section1", "section2", "section three"])
def test_remove_section(self, parser, section):
parser.add_section(section)
parser.remove_section(section)
assert section not in parser._all_sections
assert section not in parser._all_options
assert section not in parser._config
@pytest.mark.parametrize("section", ["section1", "section2", "section three"])
def test_remove_non_existing_section(self, parser, section):
with pytest.raises(NoSectionError):
parser.remove_section(section)
def test_get_all_sections(self, parser):
parser.add_section("section1")
parser.add_section("section2")
parser.add_section("section three")
assert parser.sections() == ["section1", "section2", "section three"]
def test_has_option(self, parser):
parser.add_section("section1")
parser.set("section1", "option1", "value1")
assert parser.has_option("section1", "option1") is True
@pytest.mark.parametrize(
"section, option, value",
[
("section1", "option1", "value1"),
("section2", "option2", "value2"),
("section three", "option3", "value three"),
],
)
def test_set_new_option(self, parser, section, option, value):
parser.add_section(section)
parser.set(section, option, value)
assert section in parser._all_sections
assert option in parser._all_options[section]
assert parser._all_options[section][option] == value
assert parser._config[section]["body"][0]["is_multiline"] is False
assert parser._config[section]["body"][0]["option"] == option
assert parser._config[section]["body"][0]["value"] == value
assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value}\n"
def test_set_existing_option(self, parser):
section, option, value1, value2 = "section1", "option1", "value1", "value2"
parser.add_section(section)
parser.set(section, option, value1)
parser.set(section, option, value2)
assert parser._all_options[section][option] == value2
assert parser._config[section]["body"][0]["is_multiline"] is False
assert parser._config[section]["body"][0]["option"] == option
assert parser._config[section]["body"][0]["value"] == value2
assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value2}\n"
def test_set_new_multiline_option(self, parser):
section, option, value = "section1", "option1", "value1\nvalue2\nvalue3"
parser.add_section(section)
parser.set(section, option, value)
assert parser._config[section]["body"][0]["is_multiline"] is True
assert parser._config[section]["body"][0]["option"] == option
values = ["value1", "value2", "value3"]
raw_values = [" value1\n", " value2\n", " value3\n"]
assert parser._config[section]["body"][0]["value"] == values
assert parser._config[section]["body"][0]["_raw"] == f"{option}:\n"
assert parser._config[section]["body"][0]["_raw_value"] == raw_values
assert parser._all_options[section][option] == values
def test_set_option_of_non_existing_section(self, parser):
with pytest.raises(NoSectionError):
parser.set("section1", "option1", "value1")
def test_remove_option(self, parser):
section, option, value = "section1", "option1", "value1"
parser.add_section(section)
parser.set(section, option, value)
parser.remove_option(section, option)
assert option not in parser._all_options[section]
assert option not in parser._config[section]["body"]
def test_remove_non_existing_option(self, parser):
parser.add_section("section1")
with pytest.raises(NoOptionError):
parser.remove_option("section1", "option1")
def test_remove_option_of_non_existing_section(self, parser):
with pytest.raises(NoSectionError):
parser.remove_option("section1", "option1")
def test_get_option(self, parser):
parser.add_section("section1")
parser.add_section("section2")
parser.set("section1", "option1", "value1")
parser.set("section2", "option2", "value2")
parser.set("section2", "option3", "value two")
assert parser.get("section1", "option1") == "value1"
assert parser.get("section2", "option2") == "value2"
assert parser.get("section2", "option3") == "value two"
def test_get_option_of_non_existing_section(self, parser):
with pytest.raises(NoSectionError):
parser.get("section1", "option1")
def test_get_option_of_non_existing_option(self, parser):
parser.add_section("section1")
with pytest.raises(NoOptionError):
parser.get("section1", "option1")
def test_get_option_fallback(self, parser):
parser.add_section("section1")
assert parser.get("section1", "option1", "fallback_value") == "fallback_value"
def test_get_options(self, parser):
parser.add_section("section1")
parser.set("section1", "option1", "value1")
parser.set("section1", "option2", "value2")
parser.set("section1", "option3", "value3")
options = {"option1": "value1", "option2": "value2", "option3": "value3"}
assert parser.options("section1") == options
def test_get_option_as_int(self, parser):
parser.add_section("section1")
parser.set("section1", "option1", "1")
option = parser.getint("section1", "option1")
assert isinstance(option, int) is True
def test_get_option_as_float(self, parser):
parser.add_section("section1")
parser.set("section1", "option1", "1.234")
option = parser.getfloat("section1", "option1")
assert isinstance(option, float) is True
@pytest.mark.parametrize(
"value",
["True", "true", "on", "1", "yes", "False", "false", "off", "0", "no"],
)
def test_get_option_as_boolean(self, parser, value):
parser.add_section("section1")
parser.set("section1", "option1", value)
option = parser.getboolean("section1", "option1")
assert isinstance(option, bool) is True

View File

@@ -13,8 +13,10 @@ from typing import List
from components.klipper.klipper import Klipper
from core.backup_manager.backup_manager import BackupManager
from core.config_manager.config_manager import ConfigManager
from core.instance_manager.instance_manager import InstanceManager
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from extensions.base_extension import BaseExtension
from extensions.gcode_shell_cmd import (
EXAMPLE_CFG_SRC,
@@ -118,10 +120,11 @@ class GcodeShellCmdExtension(BaseExtension):
cfg_files = [instance.cfg_file for instance in instances]
for cfg_file in cfg_files:
Logger.print_status(f"Include shell_command.cfg in '{cfg_file}' ...")
cm = ConfigManager(cfg_file)
if cm.config.has_section(section):
scp = SimpleConfigParser()
scp.read(cfg_file)
if scp.has_section(section):
Logger.print_info("Section already defined! Skipping ...")
continue
cm.config.add_section(section)
cm.write_config()
scp.add_section(section)
scp.write(cfg_file)
Logger.print_ok("Done!")

View File

@@ -1,6 +1,7 @@
# ======================================================================= #
# Copyright (C) 2023 - 2024 Staubgeborener and Tylerjet #
# https://github.com/Staubgeborener/klipper-backup #
# https://klipperbackup.xyz #
# #
# This file is part of KIAUH - Klipper Installation And Update Helper #
# https://github.com/dw-0/kiauh #

View File

@@ -23,6 +23,7 @@ from extensions.klipper_backup import (
from utils.fs_utils import check_file_exist
from utils.input_utils import get_confirm
from utils.logger import Logger
from utils.sys_utils import service_instance_exists
# noinspection PyMethodMayBeStatic
@@ -44,14 +45,6 @@ class KlipperbackupExtension(BaseExtension):
subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh"), "check_updates"])
def remove_extension(self, **kwargs) -> None:
def is_service_installed(service_name):
command = ["systemctl", "status", service_name]
result = subprocess.run(command, capture_output=True, text=True)
# Doesn't matter whether the service is active or not, what matters is whether it is installed. So let's search for "Loaded:" in stdout
if "Loaded:" in result.stdout:
return True
else:
return False
def uninstall_service(service_name):
try:
@@ -60,7 +53,7 @@ class KlipperbackupExtension(BaseExtension):
["sudo", "systemctl", "disable", service_name], check=True
)
subprocess.run(["sudo", "systemctl", "daemon-reload"], check=True)
service_path = f"/etc/systemd/system/{service_name}"
service_path = f"/etc/systemd/system/{service_name}.service"
os.system(f"sudo rm {service_path}")
return True
except subprocess.CalledProcessError:
@@ -114,30 +107,28 @@ class KlipperbackupExtension(BaseExtension):
if get_confirm(question, True, False):
# Remove Klipper-Backup services
service_names = [
"klipper-backup-on-boot.service",
"klipper-backup-filewatch.service",
"klipper-backup-on-boot",
"klipper-backup-filewatch",
]
for service_name in service_names:
try:
Logger.print_status(
f"Check whether the service {service_name} is installed ..."
f"Check whether the {service_name} service is installed ..."
)
if is_service_installed(service_name):
if service_instance_exists(service_name):
Logger.print_info(f"Service {service_name} detected.")
if uninstall_service(service_name):
Logger.print_ok(
f"The service {service_name} has been successfully uninstalled."
f"The {service_name} service has been successfully uninstalled."
)
else:
Logger.print_error(
f"Error uninstalling the service {service_name}."
)
f"Error uninstalling the {service_name} service."
)
else:
Logger.print_info(
f"The service {service_name} is not installed. Skipping ..."
)
Logger.print_info(f"Service {service_name} NOT detected.")
except:
Logger.print_error(f"Unable to remove the service {service_name}")
Logger.print_error(f"Unable to remove the {service_name} service")
# Remove Klipper-Backup cron
Logger.print_status("Check for Klipper-Backup cron entry ...")

View File

@@ -12,6 +12,9 @@ from subprocess import DEVNULL, CalledProcessError, run
from typing import List
from core.instance_manager.base_instance import BaseInstance
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from utils.constants import SYSTEMD
from utils.logger import Logger
@@ -160,8 +163,9 @@ class MoonrakerObico(BaseInstance):
return env_file_content
def _check_link_status(self) -> bool:
from core.config_manager.config_manager import ConfigManager
if not self.cfg_file.exists():
return False
cm = ConfigManager(self.cfg_file)
return cm.get_value("server", "auth_token") is not None
scp = SimpleConfigParser()
scp.read(self.cfg_file)
return scp.get("server", "auth_token", None) is not None

View File

@@ -12,8 +12,10 @@ from typing import List
from components.klipper.klipper import Klipper
from components.moonraker.moonraker import Moonraker
from core.config_manager.config_manager import ConfigManager
from core.instance_manager.instance_manager import InstanceManager
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from extensions.base_extension import BaseExtension
from extensions.obico.moonraker_obico import (
OBICO_DIR,
@@ -122,7 +124,7 @@ class ObicoExtension(BaseExtension):
)
except Exception as e:
Logger.print_error(f"Error during Obico for Klipper installation: {e}")
Logger.print_error(f"Error during Obico for Klipper installation:\n{e}")
def update_extension(self, **kwargs) -> None:
Logger.print_status("Updating Obico for Klipper ...")
@@ -137,7 +139,7 @@ class ObicoExtension(BaseExtension):
Logger.print_ok("Obico for Klipper successfully updated!")
except Exception as e:
Logger.print_error(f"Error during Obico for Klipper update: {e}")
Logger.print_error(f"Error during Obico for Klipper update:\n{e}")
def remove_extension(self, **kwargs) -> None:
Logger.print_status("Removing Obico for Klipper ...")
@@ -163,7 +165,7 @@ class ObicoExtension(BaseExtension):
)
except Exception as e:
Logger.print_error(f"Error during Obico for Klipper removal: {e}")
Logger.print_error(f"Error during Obico for Klipper removal:\n{e}")
def _obico_server_url_prompt(self) -> None:
Logger.print_dialog(
@@ -243,9 +245,18 @@ class ObicoExtension(BaseExtension):
f"Obico macros in {moonraker.cfg_dir} already exists! Skipped ..."
)
def _create_obico_cfg(self, current_instance, moonraker) -> None:
def _create_obico_cfg(
self, current_instance: MoonrakerObico, moonraker: Moonraker
) -> None:
cfg_template = OBICO_DIR.joinpath("moonraker-obico.cfg.sample")
cfg_target_file = current_instance.cfg_file
if not cfg_template.exists():
Logger.print_error(
f"Obico config template file {cfg_target_file} does not exist!"
)
return
if not cfg_target_file.exists():
run(["cp", cfg_template, cfg_target_file], check=True)
self._patch_obico_cfg(moonraker, current_instance)
@@ -255,11 +266,12 @@ class ObicoExtension(BaseExtension):
)
def _patch_obico_cfg(self, moonraker: Moonraker, obico: MoonrakerObico) -> None:
cm = ConfigManager(obico.cfg_file)
cm.set_value("server", "url", self.server_url)
cm.set_value("moonraker", "port", str(moonraker.port))
cm.set_value("logging", "path", str(obico.log))
cm.write_config()
scp = SimpleConfigParser()
scp.read(obico.cfg_file)
scp.set("server", "url", self.server_url)
scp.set("moonraker", "port", str(moonraker.port))
scp.set("logging", "path", str(obico.log))
scp.write(obico.cfg_file)
def _patch_obico_macros(self, klipper: List[Klipper]) -> None:
add_config_section(

View File

@@ -12,7 +12,9 @@ from typing import List, Optional, Tuple, TypeVar
from components.klipper.klipper import Klipper
from components.moonraker.moonraker import Moonraker
from core.config_manager.config_manager import ConfigManager
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
SimpleConfigParser,
)
from utils.logger import Logger
B = TypeVar("B", Klipper, Moonraker)
@@ -32,27 +34,30 @@ def add_config_section(
Logger.print_warn(f"'{cfg_file}' not found!")
continue
cm = ConfigManager(cfg_file)
if cm.config.has_section(section):
scp = SimpleConfigParser()
scp.read(cfg_file)
if scp.has_section(section):
Logger.print_info("Section already exist. Skipped ...")
continue
cm.config.add_section(section)
scp.add_section(section)
if options is not None:
for option in options:
cm.config.set(section, option[0], option[1])
for option in reversed(options):
scp.set(section, option[0], option[1])
cm.write_config()
scp.write(cfg_file)
def add_config_section_at_top(section: str, instances: List[B]):
# TODO: this could be implemented natively in SimpleConfigParser
for instance in instances:
tmp_cfg = tempfile.NamedTemporaryFile(mode="w", delete=False)
tmp_cfg_path = Path(tmp_cfg.name)
cmt = ConfigManager(tmp_cfg_path)
cmt.config.add_section(section)
cmt.write_config()
scp = SimpleConfigParser()
scp.read(tmp_cfg_path)
scp.add_section(section)
scp.write(tmp_cfg_path)
tmp_cfg.close()
cfg_file = instance.cfg_file
@@ -74,10 +79,11 @@ def remove_config_section(section: str, instances: List[B]) -> None:
Logger.print_warn(f"'{cfg_file}' not found!")
continue
cm = ConfigManager(cfg_file)
if not cm.config.has_section(section):
scp = SimpleConfigParser()
scp.read(cfg_file)
if not scp.has_section(section):
Logger.print_info("Section does not exist. Skipped ...")
continue
cm.config.remove_section(section)
cm.write_config()
scp.remove_section(section)
scp.write(cfg_file)