Refactor (#33)

A simple start for a refactor. This is not a whole refactor because most
problems that I see with the current code a in places that would be
changed by already open issues. These places should be cleaned up in the
corresponding PRs for the issues.

Author: ASDFGamer

.pylintrc

@@ -10,13 +10,12 @@
 from dataclasses import dataclass
 import os
 from pathlib import Path
-from typing import List
 
-from rsnapshot_docker_compose_backup.container import Container
+from rsnapshot_docker_compose_backup.structure.container import Container
 
 # Other imports
 from rsnapshot_docker_compose_backup.global_values import set_folder, set_config_file
-from rsnapshot_docker_compose_backup import docker_compose
+from rsnapshot_docker_compose_backup.docker import docker_compose
 
 
 @dataclass
@@ -48,7 +47,7 @@ def parse_arguments() -> ProgramArgs:
 def run(args: ProgramArgs) -> str:
     set_folder(args.folder)
     set_config_file(args.config)
-    docker_container: List[Container] = docker_compose.find_container(args.folder)
+    docker_container: list[Container] = docker_compose.find_container(args.folder)
     result: list[str] = []
     for container in docker_container:
         container_result = container.backup()

pylintrc.toml

@@ -3,10 +3,10 @@
 from pathlib import Path
 import re
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, List
+from typing import Any, Callable, Union
 
 from rsnapshot_docker_compose_backup.utils import CaseInsensitiveRe
-from rsnapshot_docker_compose_backup.volume import Volume
+from rsnapshot_docker_compose_backup.structure.volume import Volume
 
 
 class AbstractConfig(ABC):
@@ -24,9 +24,9 @@ class AbstractConfig(ABC):
     ]
 
     def __init__(self, config_path: Path, name: str):
-        self.enabled_actions: Dict[str, bool] = {}
-        self.backup_steps: Dict[str, str] = {}
-        self.vars: Dict[str, str | List[Volume]] = {}
+        self.enabled_actions: dict[str, bool] = {}
+        self.backup_steps: dict[str, str] = {}
+        self.vars: dict[str, Union[str, list[Volume]]] = {}
         for step in self.backupOrder:
             self.backup_steps[step] = ""
         self._load_config_file(config_path, name)
@@ -55,15 +55,17 @@ def _load_config_file(self, config_path: Path, section_name: str) -> None:
         if config_file.has_section(actions_section):
             for action in config_file.options(actions_section):
                 val = config_file.get(actions_section, action, fallback=None)
-                use = val is None or val.lower() in ["true"]
+                use = val is None or val.lower() in {"true"}
                 self.enabled_actions[action] = use
         vars_section = self.vars_name(section_name)
         if config_file.has_section(vars_section):
             for var in config_file.options(vars_section):
                 val = config_file.get(vars_section, var)
                 self.vars["${}".format(var)] = val
 
-    def _resolve_vars(self, cmd: str, variables: Dict[str, str | list[Volume]]) -> str:
+    def _resolve_vars(
+        self, cmd: str, variables: dict[str, Union[str, list[Volume]]]
+    ) -> str:
         for var in variables.keys():
             if var.lower() in cmd.lower():
                 replace_function = _replace_var.get(type(variables[var]))
@@ -104,7 +106,7 @@ def ireplace(old: str, new: str, text: str) -> str:
     return text
 
 
-def _replace_list(cmd: str, var: str, val: list[list[Any] | str | Volume]) -> str:
+def _replace_list(cmd: str, var: str, val: list[Union[list[Any], str, Volume]]) -> str:
     result: str = ""
     for i in val:
         result += str(_replace_var[type(i)](cmd, var, i)) + "\n"
@@ -122,7 +124,7 @@ def _replace_volume(cmd: str, var: str, val: Volume) -> str:
     return tmp
 
 
-_replace_var: Dict[type, Callable[..., str]] = {
+_replace_var: dict[type, Callable[..., str]] = {
     list: _replace_list,
     str: _replace_str,
     Volume: _replace_volume,

src/rsnapshot_docker_compose_backup/backup_planer.py

@@ -0,0 +1,53 @@
+#This is the default config of the rsnapshot-docker-compose-backup program.
+
+#This section can contain rsnapshot commands that are executed in the different steps of the container backup
+[{default_config}]
+#Example:
+#run_backup=backup_script   echo "Hello" > helloWorld   test/
+
+#This section contains settings that can be set. This section can only be used in the default config.
+[{default_config_settings}]
+#This outputs the Start and End Times for each backup command to the log. 
+#Rsnapshot doesn't log timestamps
+logTime = true
+
+[{default_config_vars}]
+#This setting corresponds to the var with the same name and can be used as a prefix in the folder path
+backupprefixfolder = .
+
+#This Section controls which actions should be enabled
+[{default_config_actions}]
+#This action stops the container before copying the volumes and starts it after it finished.
+stopcontainer = true
+
+#This action backups all volumes of the container
+volumebackup = true
+
+#This action saves the docker-compose.yml
+yamlbackup = true
+imagebackup = true
+
+#The following actions are disabled by default
+logbackup = false
+projectDirBackup = false
+
+#The following is the definition of actions that can be used in the backup
+
+[{actions}.volumeBackup]
+backup = backup\t$volumes.path\t$backupPrefixFolder/$serviceName/$volumes.name
+
+[{actions}.yamlBackup]
+runtime_backup = backup\t$projectFolder\t$backupPrefixFolder/$serviceName/yaml\t+rsync_long_args=--include=*.yml,+rsync_long_args=--include=*.yaml
+
+[{actions}.projectDirBackup]
+backup = backup\t$projectFolder\t$backupPrefixFolder/$serviceName/projectDir
+
+[{actions}.imageBackup]
+runtime_backup = backup_script\t/usr/bin/docker image save $image -o $serviceName_image.tar\t$backupPrefixFolder/$serviceName/image
+
+[{actions}.logBackup]
+backup = backup_script\t/usr/bin/docker logs $containerID > $serviceName_logs.log 2>&1\t$backupPrefixFolder/$serviceName/log
+
+[{actions}.stopContainer]
+stop = backup_exec\tcd $projectFolder; /usr/bin/docker-compose stop
+restart = backup_exec\tcd $projectFolder; /usr/bin/docker-compose start

src/rsnapshot_docker_compose_backup/config/__init__.py

@@ -1,11 +1,13 @@
 import configparser
+from importlib import resources
 import os
 from pathlib import Path
 import re
-from typing import Dict, Optional
+import sys
+from typing import Optional
 
 from rsnapshot_docker_compose_backup import global_values
-from rsnapshot_docker_compose_backup.abstract_config import AbstractConfig
+from rsnapshot_docker_compose_backup.config.abstract_config import AbstractConfig
 from rsnapshot_docker_compose_backup.utils import CaseInsensitiveRe
 
 
@@ -22,7 +24,7 @@ class DefaultConfig(AbstractConfig):
         "onlyRunning": True,
     }
 
-    actions: Dict[str, Dict[str, str]] = {}
+    actions: dict[str, dict[str, str]] = {}
 
     @staticmethod
     def get_instance() -> "DefaultConfig":
@@ -51,8 +53,19 @@ def __init__(self) -> None:
         self._load_settings()
 
     def _create_default_config(self) -> None:
-        with open(self.filename, "w", encoding="UTF-8") as config_file:
-            config_file.write(defaultConfigContent)
+        with resources.open_text(
+            "rsnapshot_docker_compose_backup.config", "backup.ini"
+        ) as default_backup_ini:
+            default_config = default_backup_ini.read().format(
+                default_config=self.defaultConfig,
+                default_config_actions=self.actions_name(self.defaultConfig),
+                default_config_vars=self.vars_name(self.defaultConfig),
+                actions=self.actionSection,
+                default_config_settings=self.settingsSection,
+            )
+
+            with open(self.filename, "w", encoding="UTF-8") as config_file:
+                config_file.write(default_config)
 
     def get_step(self, step: str) -> str:
         return self.backup_steps.get(step, "")
@@ -68,7 +81,7 @@ def _load_actions(self) -> None:
                 action_name = section[len(self.actionSection + ".") :]
                 commands = {}
                 for step in self.backup_steps:
-                    if config_file.has_option(section, step):
+                    if config_file.has_option(section.lower(), step):
                         commands[step] = config_file.get(section, step).strip() + "\n"
                 if commands:
                     self.actions[action_name] = commands
@@ -89,67 +102,3 @@ def _load_settings(self) -> None:
 
     def get_action(self, name: str) -> dict[str, str]:
         return self.actions[name]
-
-
-defaultConfigContent = """
-#This is the default config of the rsnapshot-docker-compose-backup program.
-
-#This section can contain rsnapshot commands that are executed in the different steps of the container backup
-[{default_config}]
-#Example:
-#run_backup=backup_script   echo "Hello" > helloWorld   test/
-
-#This section contains settings that can be set. This section can only be used in the default config.
-[{default_config_settings}]
-#This outputs the Start and End Times for each backup command to the log. 
-#Rsnapshot doesn't log timestamps
-logTime = true
-
-[{default_config_vars}]
-#This setting corresponds to the var with the same name and can be used as a prefix in the folder path
-backupprefixfolder = .
-
-#This Section controls which actions should be enabled
-[{default_config_actions}]
-#This action stops the container before copying the volumes and starts it after it finished.
-stopcontainer = true
-
-#This action backups all volumes of the container
-volumebackup = true
-
-#This action saves the docker-compose.yml
-yamlbackup = true
-imagebackup = true
-
-#The following actions are disabled by default
-logbackup = false
-projectDirBackup = false
-
-#The following is the definition of actions that can be used in the backup
-
-[{actions}.volumeBackup]
-backup = backup\t$volumes.path\t$backupPrefixFolder/$serviceName/$volumes.name
-
-[{actions}.yamlBackup]
-runtime_backup = backup\t$projectFolder\t$backupPrefixFolder/$serviceName/yaml\t+rsync_long_args=--include=*.yml,+rsync_long_args=--include=*.yaml
-
-[{actions}.projectDirBackup]
-backup = backup\t$projectFolder\t$backupPrefixFolder/$serviceName/projectDir
-
-[{actions}.imageBackup]
-runtime_backup = backup_script\t/usr/bin/docker image save $image -o $serviceName_image.tar\t$backupPrefixFolder/$serviceName/image
-
-[{actions}.logBackup]
-backup = backup_script\t/usr/bin/docker logs $containerID > $serviceName_logs.log 2>&1\t$backupPrefixFolder/$serviceName/log
-
-[{actions}.stopContainer]
-stop = backup_exec\tcd $projectFolder; /usr/bin/docker-compose stop
-restart = backup_exec\tcd $projectFolder; /usr/bin/docker-compose start
-
-""".format(
-    default_config=DefaultConfig.defaultConfig,
-    default_config_actions=DefaultConfig.actions_name(DefaultConfig.defaultConfig),
-    default_config_vars=DefaultConfig.vars_name(DefaultConfig.defaultConfig),
-    actions=DefaultConfig.actionSection,
-    default_config_settings=DefaultConfig.settingsSection,
-)

src/rsnapshot_docker_compose_backup/abstract_config.py renamed to src/rsnapshot_docker_compose_backup/config/abstract_config.py

@@ -1,9 +1,9 @@
 import json
 import re
-from typing import List, Any
+from typing import Any, Optional
 
 from rsnapshot_docker_compose_backup.utils import command
-from rsnapshot_docker_compose_backup.volume import Volume
+from rsnapshot_docker_compose_backup.structure.volume import Volume
 
 
 def inspect(container: str) -> Any:
@@ -12,7 +12,7 @@ def inspect(container: str) -> Any:
     return json.loads(command("docker inspect {}".format(container)).stdout)[0]
 
 
-def ps(container_id: str | None = None) -> str:
+def ps(container_id: Optional[str] = None) -> str:
     result = command("docker ps -a").stdout
     if container_id:
         for line in ps().splitlines():
@@ -22,8 +22,8 @@ def ps(container_id: str | None = None) -> str:
     return result
 
 
-def volumes(container_id: str) -> List[Volume]:
-    result: List[Volume] = []
+def volumes(container_id: str) -> list[Volume]:
+    result: list[Volume] = []
     container_info = inspect(container_id)
     for mount in container_info["Mounts"]:
         if mount["Type"] == "volume":

src/rsnapshot_docker_compose_backup/config/backup.ini

@@ -4,21 +4,21 @@
 import os
 from pathlib import Path
 import re
-from typing import List, Tuple
 from concurrent import futures
 import json
+from typing import Optional
 
-from rsnapshot_docker_compose_backup.container import Container
+from rsnapshot_docker_compose_backup.structure.container import Container
 from rsnapshot_docker_compose_backup.utils import command
 
 
 def get_binary() -> str:
     if command("docker compose").returncode == 0:
         return "docker compose"
-    elif command("docker-compose").returncode == 0:
+    if command("docker-compose").returncode == 0:
         return "docker-compose"
-    else:
-        raise Exception("Docker Compose is not installed")
+
+    raise Exception("Docker Compose is not installed")
 
 
 def get_container_id(service_name: str, path: Path) -> str:
@@ -52,12 +52,12 @@ def container_stopped(container_id: str) -> bool:
     return status.stdout.startswith("Exited")
 
 
-def find_container(root_folder: Path) -> List[Container]:
-    all_container: List[Container] = []
-    docker_dirs: List[Path] = find_docker_dirs(root_folder)
+def find_container(root_folder: Path) -> list[Container]:
+    all_container: list[Container] = []
+    docker_dirs: list[Path] = find_docker_dirs(root_folder)
     with futures.ProcessPoolExecutor() as pool:
         for service_list, directory in pool.map(get_services, docker_dirs):
-            # container_list: List[str] = get_services(output)
+            # container_list: list[str] = get_services(output)
             for container_info in service_list:
                 if container_info.container_id:
                     all_container.append(
@@ -79,25 +79,25 @@ class ContainerInfo:
     container_id: str
 
 
-def get_services(path: Path) -> Tuple[List[ContainerInfo], Path]:
-    service_name: List[str] = command(
+def get_services(path: Path) -> tuple[list[ContainerInfo], Path]:
+    service_name: list[str] = command(
         "{} config --services".format(get_binary()), path=path
     ).stdout.splitlines()
     # Docker doesn't return it always in the same order
     service_name.sort()
     # print(service_name)
-    services: List[ContainerInfo] = []
+    services: list[ContainerInfo] = []
     for service in service_name:
         container_id = get_container_id(service, path)
         container_name = get_container_name(service, path)
         services.append(ContainerInfo(service, container_name, container_id))
     return services, path
 
 
-def find_docker_dirs(root_folder: Path = Path(os.getcwd())) -> List[Path]:
+def find_docker_dirs(root_folder: Path = Path(os.getcwd())) -> list[Path]:
     """Finds all docker-compose dirs in current sub folder
     :returns: a list of all folders"""
-    dirs: List[Path] = []
+    dirs: list[Path] = []
     docker_compose_files = [
         "compose.yaml",
         "compose.yml",
@@ -112,17 +112,17 @@ def find_docker_dirs(root_folder: Path = Path(os.getcwd())) -> List[Path]:
     return dirs
 
 
-def get_running_container(ps_out: str) -> List[str]:
+def get_running_container(ps_out: str) -> list[str]:
     return get_container(ps_out, state="UP")
 
 
 def get_column(column_nr: int, input_str: str) -> str:
     return re.sub(r"\s\s+", "  ", input_str).split("  ")[column_nr]
 
 
-def get_container(ps_out: str, state: str | None = None) -> List[str]:
-    all_container: List[str] = ps_out.splitlines()[2:]
-    container: List[str] = []
+def get_container(ps_out: str, state: Optional[str] = None) -> list[str]:
+    all_container: list[str] = ps_out.splitlines()[2:]
+    container: list[str] = []
     if not all_container:
         return []
     for line in all_container: