Lint repo with new ruff rules

Author: ChrisLovering

.github/workflows/lint.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Run pre-commit hooks
         run: SKIP=ruff pre-commit run --all-files
-  
+
       # Run `ruff` using github formatting to enable automatic inline annotations.
       - name: Run ruff
         run: "ruff check --format=github ."

docs/Gemfile

@@ -8,4 +8,3 @@ platforms :mingw, :x64_mingw, :mswin, :jruby do
 end
 
 gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
-

olli/alert.py

@@ -1,4 +1,4 @@
-"""This module contains the logic for grepping logs and generating Discord alerts."""
+"""The logic for grepping logs and generating Discord alerts."""
 import httpx
 from loguru import logger
 
@@ -43,19 +43,19 @@ def get_match(token: TokenConfig) -> TokenMatch:
 
 def send_alerts(matches: list[TokenMatch]) -> None:
     """Take the found matches and relay them to Discord."""
-    # TODO: batch into 10 to avoid embed limits
+    # TODO: batch into 10 to avoid embed limits  # noqa: TD002,TD003,FIX002
     logger.info("Sending webhook payload to Discord")
     webhook.send_token_matches(matches)
 
 
 def run() -> None:
     """Entrypoint for Olli's search process."""
     logger.info("Running Olli search")
-    matches = []
-
-    for token in SERVICE_CONFIG.tokens:
-        if match := get_match(token):
-            matches.append(match)
+    matches = [
+        match
+        for token in SERVICE_CONFIG.tokens
+        if (match := get_match(token))
+    ]
 
     send_alerts(matches)
     logger.info("Olli search complete.")

olli/api.py

@@ -1,4 +1,4 @@
-"""This module contains API logic for interacting with Loki."""
+"""The API logic for interacting with Loki."""
 import datetime
 from typing import Any
 
@@ -17,18 +17,18 @@ def route(path: str) -> str:
 
     def get_token_logs(self, token: TokenConfig) -> dict[str, Any]:
         """
-        Fetch the logs from configured services for a matchign token.
+        Fetch the logs from configured services for a matching token.
 
         The term is searched case-insensitively in the logs for the interval
         configured in the config.toml file.
         """
         td = datetime.timedelta(minutes=SERVICE_CONFIG.interval_minutes)
-        start_time = datetime.datetime.now() - td
+        start_time = datetime.datetime.now(tz=datetime.UTC) - td
         start_ts = start_time.timestamp() * 1_000_000_000
 
         job_regex = "|".join(LOKI_CONFIG.jobs)
 
-        case_filter = '(?i)' if not token.case_sensitive else ''
+        case_filter = "(?i)" if not token.case_sensitive else ""
 
         resp = httpx.get(self.route("query_range"), params={
             "query": f'{{job=~"({job_regex})"}} |~ "{case_filter}{token.token}"',

olli/config.py

@@ -1,9 +1,8 @@
 """Configuration loading and validation."""
 
-from typing import Optional
 
 from loguru import logger
-from pydantic import BaseModel
+from pydantic import BaseModel, field_validator
 from pydantic_settings import BaseSettings
 
 
@@ -22,7 +21,7 @@ class _LokiConfig(EnvConfig, env_prefix="loki_"):
 
     api_url: str
     jobs: list[str]
-    max_logs: Optional[int] = 5_000
+    max_logs: int | None = 5_000
 
 
 LOKI_CONFIG = _LokiConfig()
@@ -31,7 +30,7 @@ class _LokiConfig(EnvConfig, env_prefix="loki_"):
 class _DiscordConfig(EnvConfig, env_prefix="discord_"):
     """Configuration for Discord alerting."""
 
-    webhook_url: Optional[str]
+    webhook_url: str | None
 
 
 DISCORD_CONFIG = _DiscordConfig()
@@ -41,8 +40,8 @@ class TokenConfig(BaseModel):
     """Class representing a token config entry."""
 
     token: str
-    color: Optional[str] = "#7289DA"
-    case_sensitive: Optional[bool] = False
+    color: str | None = "#7289DA"
+    case_sensitive: bool | None = False
 
 
 class _ServiceConfig(EnvConfig, env_prefix="service_"):
@@ -51,15 +50,18 @@ class _ServiceConfig(EnvConfig, env_prefix="service_"):
     interval_minutes: int
     tokens: list[TokenConfig]
 
-    @validator("interval_minutes")
+    @field_validator("interval_minutes")
+    @classmethod
     def must_be_above_zero(cls, value: int) -> int:
         """Validate that the interval minutes is 1 or greater."""
         if value < 1:
-            raise ValueError("Interval must be above zero minutes.")
+            msg = "Interval must be above zero minutes."
+            raise ValueError(msg)
 
         return value
 
-    @validator("tokens")
+    @field_validator("tokens")
+    @classmethod
     def warn_above_ten(cls, value: list[TokenConfig]) -> list[TokenConfig]:
         """
         Warn a user if they have more than 10 tokens.

olli/webhook.py

@@ -1,5 +1,5 @@
-"""This module contains the logic for sending webhooks to Discord."""
-from datetime import datetime
+"""The logic for sending webhooks to Discord."""
+from datetime import UTC, datetime
 from typing import Any
 
 import httpx
@@ -16,7 +16,7 @@ def send_with_backoff(url: str, json: dict[str, Any], n: int = 5) -> None:
         try:
             httpx.post(url, json=json).raise_for_status()
             break
-        except Exception:
+        except httpx.HTTPStatusError:
             i += 1
             if i == n:
                 logger.exception(f"Could not POST to URL {url}")
@@ -31,13 +31,14 @@ def send_olli_error(error: str) -> None:
             "title": "Olli Error",
             "color": 0xff5f5f,
             "description": f"Olli encountered an error: {error}",
-            "timestamp": datetime.utcnow().isoformat(),
-        }]
+            "timestamp": datetime.now(tz=UTC).isoformat(),
+        }],
     })
 
 
 def send_token_matches(matches: list[TokenMatch]) -> None:
-    """Send the found token matches to Discord.
+    """
+    Send the found token matches to Discord.
 
     The method checks that each token has at least 1 match and then merges
     together up to 10 embeds into one webhook payload.
@@ -53,28 +54,28 @@ def send_token_matches(matches: list[TokenMatch]) -> None:
             "description": f"`{sum(match.services.values())}` events matching",
             "color": int(match.token.color[1:], 16),
             "author": {
-                "name": "Olli"
+                "name": "Olli",
             },
             "footer": {
                 "text": f"Last {SERVICE_CONFIG.interval_minutes} minutes",
             },
-            "timestamp": datetime.utcnow().isoformat(),
-            "fields": []
+            "timestamp": datetime.now(tz=UTC).isoformat(),
+            "fields": [],
         }
 
         for service, count in match.services.items():
             embed["fields"].append({
                 "name": service,
                 "value": f"`{count:,}` logs",
-                "inline": True
+                "inline": True,
             })
 
         embeds.append(embed)
 
     if len(embeds) > 0:
         logger.info("Sending alerts payload to Discord")
         send_with_backoff(DISCORD_CONFIG.webhook_url, {
-            "embeds": embeds
+            "embeds": embeds,
         })
     else:
         logger.info("No alerts to send to Discord")

pyproject.toml

@@ -50,6 +50,8 @@ ignore = [
     "ARG003",
     "C901",
     "D100", "D104", "D105", "D107", "D203", "D212", "D214", "D215", "D416",
+    "EM101",
+    "TRY003"
 ]
 line-length = 120
 select = ["ALL"]