Merge pull request #58 from faekiva/ruff #none

Added formatter

Author: lawndoc

.github/workflows/pr-verify.yaml

@@ -29,6 +29,15 @@ jobs:
           uv sync --locked --directory src/
           uv run --directory src/ pytest
 
+  code-quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check --diff"
+          src: ./src
+          version-file: ./src/pyproject.toml
   build:
     runs-on: ubuntu-latest
     steps:

src/pyproject.toml

@@ -12,6 +12,7 @@ dev = [
     "black>=25.1.0",
     "pre-commit>=4.2.0",
     "pytest>=7.4.0",
+    "ruff>=0.12.3",
 ]
 
 [tool.pytest.ini_options]

src/restic_compose_backup/alerts/__init__.py

@@ -5,24 +5,26 @@
 
 logger = logging.getLogger(__name__)
 
-ALERT_INFO = 'INFO',
-ALERT_ERROR = 'ERROR'
+ALERT_INFO = ("INFO",)
+ALERT_ERROR = "ERROR"
 ALERT_TYPES = [ALERT_INFO, ALERT_ERROR]
 BACKENDS = [SMTPAlert, DiscordWebhookAlert]
 
 
-def send(subject: str = None, body: str = None, alert_type: str = 'INFO'):
+def send(subject: str = None, body: str = None, alert_type: str = "INFO"):
     """Send alert to all configured backends"""
     alert_classes = configured_alert_types()
     for instance in alert_classes:
-        logger.info('Configured: %s', instance.name)
+        logger.info("Configured: %s", instance.name)
         try:
             instance.send(
-                subject=f'[{alert_type}] {subject}',
+                subject=f"[{alert_type}] {subject}",
                 body=body,
             )
         except Exception as ex:
-            logger.error("Exception raised when sending alert [%s]: %s", instance.name, ex)
+            logger.error(
+                "Exception raised when sending alert [%s]: %s", instance.name, ex
+            )
             logger.exception(ex)
 
     if len(alert_classes) == 0:
@@ -31,12 +33,14 @@ def send(subject: str = None, body: str = None, alert_type: str = 'INFO'):
 
 def configured_alert_types():
     """Returns a list of configured alert class instances"""
-    logger.debug('Getting alert backends')
+    logger.debug("Getting alert backends")
     entires = []
 
     for cls in BACKENDS:
         instance = cls.create_from_env()
-        logger.debug("Alert backend '%s' configured: %s", cls.name, instance is not None)
+        logger.debug(
+            "Alert backend '%s' configured: %s", cls.name, instance is not None
+        )
         if instance:
             entires.append(instance)
 

src/restic_compose_backup/alerts/base.py

@@ -1,5 +1,3 @@
-
-
 class BaseAlert:
     name = None
 

src/restic_compose_backup/alerts/discord.py

@@ -8,15 +8,15 @@
 
 
 class DiscordWebhookAlert(BaseAlert):
-    name = 'discord_webhook'
+    name = "discord_webhook"
     success_codes = [200]
 
     def __init__(self, webhook_url):
         self.url = webhook_url
 
     @classmethod
     def create_from_env(cls):
-        instance = cls(os.environ.get('DISCORD_WEBHOOK'))
+        instance = cls(os.environ.get("DISCORD_WEBHOOK"))
 
         if instance.properly_configured:
             return instance
@@ -34,15 +34,17 @@ def send(self, subject: str = None, body: str = None, alert_type: str = None):
         #       The max description size is 2048
         #       Total embed size limit is 6000 characters (per embed)
         data = {
-            'embeds': [
+            "embeds": [
                 {
-                    'title': subject[-256:],
-                    'description': body[-2048:] if body else "",
+                    "title": subject[-256:],
+                    "description": body[-2048:] if body else "",
                 },
             ]
         }
-        response = requests.post(self.url, params={'wait': True}, json=data)
+        response = requests.post(self.url, params={"wait": True}, json=data)
         if response.status_code not in self.success_codes:
-            logger.error("Discord webhook failed: %s: %s", response.status_code, response.content)
+            logger.error(
+                "Discord webhook failed: %s: %s", response.status_code, response.content
+            )
         else:
-            logger.info('Discord webhook successful')
+            logger.info("Discord webhook successful")

src/restic_compose_backup/alerts/smtp.py

@@ -9,7 +9,7 @@
 
 
 class SMTPAlert(BaseAlert):
-    name = 'smtp'
+    name = "smtp"
 
     def __init__(self, host, port, user, password, to):
         self.host = host
@@ -21,11 +21,11 @@ def __init__(self, host, port, user, password, to):
     @classmethod
     def create_from_env(cls):
         instance = cls(
-            os.environ.get('EMAIL_HOST'),
-            os.environ.get('EMAIL_PORT'),
-            os.environ.get('EMAIL_HOST_USER'),
-            os.environ.get('EMAIL_HOST_PASSWORD'),
-            (os.environ.get('EMAIL_SEND_TO') or "").split(','),
+            os.environ.get("EMAIL_HOST"),
+            os.environ.get("EMAIL_PORT"),
+            os.environ.get("EMAIL_HOST_USER"),
+            os.environ.get("EMAIL_HOST_PASSWORD"),
+            (os.environ.get("EMAIL_SEND_TO") or "").split(","),
         )
         if instance.properly_configured:
             return instance
@@ -36,11 +36,11 @@ def create_from_env(cls):
     def properly_configured(self) -> bool:
         return self.host and self.port and self.user and len(self.to) > 0
 
-    def send(self, subject: str = None, body: str = None, alert_type: str = 'INFO'):
+    def send(self, subject: str = None, body: str = None, alert_type: str = "INFO"):
         msg = MIMEText(body)
-        msg['Subject'] = f"[{alert_type}] {subject}"
-        msg['From'] = self.user
-        msg['To'] = ', '.join(self.to)
+        msg["Subject"] = f"[{alert_type}] {subject}"
+        msg["From"] = self.user
+        msg["To"] = ", ".join(self.to)
 
         try:
             logger.info("Connecting to %s port %s", self.host, self.port)
@@ -52,15 +52,17 @@ def send(self, subject: str = None, body: str = None, alert_type: str = 'INFO'):
                 try:
                     server.starttls()
                 except smtplib.SMTPHeloError:
-                    logger.error("The server didn't reply properly to the HELO greeting. Email not sent.")
+                    logger.error(
+                        "The server didn't reply properly to the HELO greeting. Email not sent."
+                    )
                     return
                 except smtplib.SMTPNotSupportedError:
                     logger.error("STARTTLS not supported on server. Email not sent.")
                     return
             server.ehlo()
             server.login(self.user, self.password)
             server.sendmail(self.user, self.to, msg.as_string())
-            logger.info('Email sent')
+            logger.info("Email sent")
         except Exception as ex:
             logger.exception(ex)
         finally:

src/restic_compose_backup/backup_runner.py

@@ -6,8 +6,14 @@
 logger = logging.getLogger(__name__)
 
 
-def run(image: str = None, command: str = None, volumes: dict = None,
-        environment: dict = None, labels: dict = None, source_container_id: str = None):
+def run(
+    image: str = None,
+    command: str = None,
+    volumes: dict = None,
+    environment: dict = None,
+    labels: dict = None,
+    source_container_id: str = None,
+):
     logger.info("Starting backup container")
     client = utils.docker_client()
 
@@ -17,9 +23,9 @@ def run(image: str = None, command: str = None, volumes: dict = None,
         labels=labels,
         # auto_remove=True,  # We remove the container further down
         detach=True,
-        environment=environment + ['BACKUP_PROCESS_CONTAINER=true'],
+        environment=environment + ["BACKUP_PROCESS_CONTAINER=true"],
         volumes=volumes,
-        network_mode=f'container:{source_container_id}',  # Reuse original container's network stack.
+        network_mode=f"container:{source_container_id}",  # Reuse original container's network stack.
         working_dir=os.getcwd(),
         tty=True,
     )
@@ -40,7 +46,7 @@ def readlines(stream):
                         line += data.decode()
                     elif isinstance(data, str):
                         line += data
-                    if line.endswith('\n'):
+                    if line.endswith("\n"):
                         break
                 except StopIteration:
                     break
@@ -49,15 +55,15 @@ def readlines(stream):
             else:
                 break
 
-    with open('backup.log', 'w') as fd:
+    with open("backup.log", "w") as fd:
         for line in readlines(log_generator):
             fd.write(line)
-            fd.write('\n')
+            fd.write("\n")
             print(line)
 
     container.wait()
     container.reload()
-    logger.debug("Container ExitCode %s", container.attrs['State']['ExitCode'])
+    logger.debug("Container ExitCode %s", container.attrs["State"]["ExitCode"])
     container.remove()
 
-    return container.attrs['State']['ExitCode']
+    return container.attrs["State"]["ExitCode"]