diff --git a/tools/extract_historical_drops.py b/tools/extract_historical_drops.py
index 9af65a0..65db357 100755
--- a/tools/extract_historical_drops.py
+++ b/tools/extract_historical_drops.py
@@ -16,7 +16,7 @@ import argparse
import hashlib
import json
import shutil
-import subprocess # ruff:ignore[suspicious-subprocess-import]
+import subprocess # noqa: S404
import tempfile
from pathlib import Path
from typing import Any
@@ -60,7 +60,7 @@ def run_git(git_dir: str, *args: str, check: bool = True) -> str:
if not git:
msg = "Git executable not found in PATH."
raise FileNotFoundError(msg)
- result: subprocess.CompletedProcess[str] = subprocess.run( # ruff:ignore[subprocess-without-shell-equals-true]
+ result: subprocess.CompletedProcess[str] = subprocess.run( # noqa: S603
[git, "--git-dir", git_dir, *args],
capture_output=True,
text=True,
diff --git a/twitch/api.py b/twitch/api.py
index 26af923..96a409d 100644
--- a/twitch/api.py
+++ b/twitch/api.py
@@ -1,6 +1,6 @@
from __future__ import annotations
-import datetime # ruff:ignore[typing-only-standard-library-import]
+import datetime # noqa: TC003
from dataclasses import dataclass
from typing import TYPE_CHECKING
from typing import Literal
@@ -9,7 +9,7 @@ from django.db import models
from django.http import Http404
from django.shortcuts import get_object_or_404
from django.utils import timezone
-from ninja import Router
+from ninja import NinjaAPI
from ninja import Schema
from twitch.models import Channel
@@ -28,7 +28,7 @@ if TYPE_CHECKING:
from twitch.models import DropBenefit
from twitch.models import TimeBasedDrop
-V1StatusFilter = Literal["active", "upcoming", "expired", "unknown"]
+V1StatusFilter = Literal["active", "upcoming", "expired"]
DEFAULT_PAGE_SIZE = 100
MAX_PAGE_SIZE = 500
@@ -253,7 +253,11 @@ class V1ChatBadgeSetListSchema(V1PaginationSchema):
items: list[V1ChatBadgeSetSchema]
-api = Router()
+api = NinjaAPI(
+ title="TTVDrops Twitch API",
+ version="1.0.0",
+ urls_namespace="twitch:twitch-api-v1",
+)
def _paginate[ModelT: models.Model](
@@ -301,11 +305,6 @@ def _apply_status_filter[ModelT: models.Model](
return queryset.filter(**{f"{start_field}__gt": now})
if status == "expired":
return queryset.filter(**{f"{end_field}__lt": now})
- if status == "unknown":
- return queryset.filter(
- models.Q(**{f"{start_field}__isnull": True})
- | models.Q(**{f"{end_field}__isnull": True}),
- )
return queryset
diff --git a/twitch/apps.py b/twitch/apps.py
index 67d0d6c..d15fdbd 100644
--- a/twitch/apps.py
+++ b/twitch/apps.py
@@ -15,7 +15,7 @@ class TwitchConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "twitch"
- def ready(self) -> None: # ruff:ignore[undocumented-public-method]
+ def ready(self) -> None: # noqa: D102
logger: logging.Logger = logging.getLogger("ttvdrops.apps")
# Patch FieldFile.open to swallow FileNotFoundError and provide
@@ -39,18 +39,18 @@ class TwitchConfig(AppConfig):
# Register post_save signal handlers that dispatch image download tasks
# when new Twitch records are created.
- from django.db.models.signals import m2m_changed # ruff:ignore[unsorted-imports, import-outside-top-level]
- from django.db.models.signals import post_save # ruff:ignore[import-outside-top-level]
+ from django.db.models.signals import m2m_changed # noqa: I001, PLC0415
+ from django.db.models.signals import post_save # noqa: PLC0415
- from twitch.models import DropBenefit # ruff:ignore[import-outside-top-level]
- from twitch.models import DropCampaign # ruff:ignore[import-outside-top-level]
- from twitch.models import Game # ruff:ignore[import-outside-top-level]
- from twitch.models import RewardCampaign # ruff:ignore[import-outside-top-level]
- from twitch.signals import on_drop_benefit_saved # ruff:ignore[import-outside-top-level]
- from twitch.signals import on_drop_campaign_allow_channels_changed # ruff:ignore[import-outside-top-level]
- from twitch.signals import on_drop_campaign_saved # ruff:ignore[import-outside-top-level]
- from twitch.signals import on_game_saved # ruff:ignore[import-outside-top-level]
- from twitch.signals import on_reward_campaign_saved # ruff:ignore[import-outside-top-level]
+ from twitch.models import DropBenefit # noqa: PLC0415
+ from twitch.models import DropCampaign # noqa: PLC0415
+ from twitch.models import Game # noqa: PLC0415
+ from twitch.models import RewardCampaign # noqa: PLC0415
+ from twitch.signals import on_drop_benefit_saved # noqa: PLC0415
+ from twitch.signals import on_drop_campaign_allow_channels_changed # noqa: PLC0415
+ from twitch.signals import on_drop_campaign_saved # noqa: PLC0415
+ from twitch.signals import on_game_saved # noqa: PLC0415
+ from twitch.signals import on_reward_campaign_saved # noqa: PLC0415
post_save.connect(on_game_saved, sender=Game)
post_save.connect(on_drop_campaign_saved, sender=DropCampaign)
diff --git a/twitch/feeds.py b/twitch/feeds.py
index 3c9e904..b5c503c 100644
--- a/twitch/feeds.py
+++ b/twitch/feeds.py
@@ -22,7 +22,7 @@ from django.utils.html import format_html_join
from django.utils.safestring import SafeText
from core.base_url import build_absolute_uri
-from core.base_url import get_current_site # ruff:ignore[redefined-while-unused]
+from core.base_url import get_current_site # noqa: F811
from twitch.models import Channel
from twitch.models import ChatBadge
from twitch.models import DropCampaign
@@ -185,9 +185,9 @@ class TTVDropsBaseFeed(Feed):
Returns:
SyndicationFeed: The feed generator instance with the correct site and URL context for absolute URL generation.
"""
- # TODO(TheLovinator): Refactor to avoid this mess. # ruff:ignore[missing-todo-link]
+ # TODO(TheLovinator): Refactor to avoid this mess. # noqa: TD003
try:
- from django.contrib.sites import shortcuts as sites_shortcuts # ruff:ignore[unsorted-imports, import-outside-top-level]
+ from django.contrib.sites import shortcuts as sites_shortcuts # noqa: I001, PLC0415
except ImportError:
sites_shortcuts = None
@@ -575,7 +575,7 @@ def generate_channels_html(item: Model, *, hide_paid: bool = False) -> list[Safe
)
if "twitch-chat-badges-guide" in getattr(game, "details_url", ""):
- # TODO(TheLovinator): Improve detection of global emotes # ruff:ignore[missing-todo-link]
+ # TODO(TheLovinator): Improve detection of global emotes # noqa: TD003
parts.append(
format_html(
"{}",
@@ -1177,7 +1177,7 @@ class GameCampaignFeed(TTVDropsBaseFeed):
self._hide_paid = _query_bool(request, "hide_paid")
return super().__call__(request, *args, **kwargs)
- def get_object(self, request: HttpRequest, twitch_id: str) -> Game: # ruff:ignore[unused-method-argument]
+ def get_object(self, request: HttpRequest, twitch_id: str) -> Game: # noqa: ARG002
"""Retrieve the Game instance for the given Twitch ID.
Returns:
@@ -1727,7 +1727,7 @@ class GameRewardCampaignFeed(TTVDropsBaseFeed):
self._limit = None
return super().__call__(request, *args, **kwargs)
- def get_object(self, request: HttpRequest, twitch_id: str) -> Game: # ruff:ignore[unused-method-argument]
+ def get_object(self, request: HttpRequest, twitch_id: str) -> Game: # noqa: ARG002
"""Retrieve the Game instance for the given Twitch ID.
Returns:
diff --git a/twitch/management/commands/backfill_image_dimensions.py b/twitch/management/commands/backfill_image_dimensions.py
index 3a0b468..9d876b0 100644
--- a/twitch/management/commands/backfill_image_dimensions.py
+++ b/twitch/management/commands/backfill_image_dimensions.py
@@ -14,7 +14,7 @@ class Command(BaseCommand):
help = "Backfill image dimensions for existing cached images"
- def handle(self, *args, **options) -> None: # ruff:ignore[unused-method-argument, too-many-statements]
+ def handle(self, *args, **options) -> None: # noqa: ARG002, PLR0915
"""Execute the command."""
total_updated = 0
diff --git a/twitch/management/commands/backup_db.py b/twitch/management/commands/backup_db.py
index bcdbbd5..753e844 100644
--- a/twitch/management/commands/backup_db.py
+++ b/twitch/management/commands/backup_db.py
@@ -2,7 +2,7 @@ import io
import json
import os
import shutil
-import subprocess # ruff:ignore[suspicious-subprocess-import]
+import subprocess # noqa: S404
from compression import zstd
from datetime import datetime
from pathlib import Path
@@ -191,11 +191,11 @@ def _write_table_rows(
connection: SQLite connection.
table: Table name.
"""
- cursor = connection.execute(f'SELECT * FROM "{table}"') # ruff:ignore[hardcoded-sql-expression]
+ cursor = connection.execute(f'SELECT * FROM "{table}"') # noqa: S608
columns = [description[0] for description in cursor.description]
for row in cursor.fetchall():
values = ", ".join(_sql_literal(row[idx]) for idx in range(len(columns)))
- handle.write(f'INSERT INTO "{table}" VALUES ({values});\n') # ruff:ignore[hardcoded-sql-expression]
+ handle.write(f'INSERT INTO "{table}" VALUES ({values});\n') # noqa: S608
def _write_indexes(
@@ -268,7 +268,7 @@ def _write_postgres_dump(output_path: Path, tables: list[str]) -> None:
for table in tables:
cmd.extend(["-t", f"public.{table}"])
- process = subprocess.Popen( # ruff:ignore[subprocess-without-shell-equals-true]
+ process = subprocess.Popen( # noqa: S603
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
@@ -339,7 +339,7 @@ def _write_json_dump(output_path: Path, tables: list[str]) -> None:
data: dict[str, list[dict]] = {}
with django_connection.cursor() as cursor:
for table in tables:
- cursor.execute(f'SELECT * FROM "{table}"') # ruff:ignore[hardcoded-sql-expression]
+ cursor.execute(f'SELECT * FROM "{table}"') # noqa: S608
columns: list[str] = [col[0] for col in cursor.description]
rows = cursor.fetchall()
data[table] = [dict(zip(columns, row, strict=False)) for row in rows]
diff --git a/twitch/management/commands/better_import_drops.py b/twitch/management/commands/better_import_drops.py
index 03ed611..81acda0 100644
--- a/twitch/management/commands/better_import_drops.py
+++ b/twitch/management/commands/better_import_drops.py
@@ -403,7 +403,7 @@ def repair_partially_broken_json(raw_text: str) -> str:
wrapped: str = f"[{raw_text}]"
wrapped_data = json.loads(wrapped)
# Validate that all items look like GraphQL responses
- if isinstance(wrapped_data, list) and wrapped_data: # ruff:ignore[collapsible-if]
+ if isinstance(wrapped_data, list) and wrapped_data: # noqa: SIM102
# Check if all items have "data" or "extensions" (GraphQL response structure)
if all(
isinstance(item, dict) and ("data" in item or "extensions" in item)
@@ -452,7 +452,7 @@ def repair_partially_broken_json(raw_text: str) -> str:
valid_lines: list[dict[str, Any]] = []
for line in lines:
- line: str = line.strip() # ruff:ignore[redefined-loop-name]
+ line: str = line.strip() # noqa: PLW2901
if line and line.startswith("{"):
try:
fixed_line: str = json_repair.repair_json(line, logging=False)
@@ -749,7 +749,7 @@ class Command(BaseCommand):
return channel_obj
- def process_responses( # ruff:ignore[too-many-statements]
+ def process_responses( # noqa: PLR0915
self,
responses: list[dict[str, Any]],
file_path: Path,
@@ -1180,7 +1180,7 @@ class Command(BaseCommand):
msg: str = f"Path does not exist: {input_path}"
raise CommandError(msg)
- def handle(self, *args, **options) -> None: # ruff:ignore[unused-method-argument]
+ def handle(self, *args, **options) -> None: # noqa: ARG002
"""Main entry point for the command."""
colorama_init(autoreset=True)
diff --git a/twitch/management/commands/cleanup_unknown_organizations.py b/twitch/management/commands/cleanup_unknown_organizations.py
index e6ec0a9..3f07263 100644
--- a/twitch/management/commands/cleanup_unknown_organizations.py
+++ b/twitch/management/commands/cleanup_unknown_organizations.py
@@ -49,7 +49,7 @@ class Command(BaseCommand):
),
)
- def handle(self, *args: Any, **options: Any) -> None: # ruff:ignore[any-type, unused-method-argument]
+ def handle(self, *args: Any, **options: Any) -> None: # noqa: ANN401, ARG002
"""Execute the command to detach the organization and optionally re-import data.
Args:
diff --git a/twitch/management/commands/download_box_art.py b/twitch/management/commands/download_box_art.py
index 2a32cb2..3d1b513 100644
--- a/twitch/management/commands/download_box_art.py
+++ b/twitch/management/commands/download_box_art.py
@@ -39,7 +39,7 @@ class Command(BaseCommand):
help="Re-download even if a local box art file already exists.",
)
- def handle( # ruff:ignore[too-many-locals, too-many-statements]
+ def handle( # noqa: PLR0914, PLR0915
self,
*_args: str,
**options: str | bool | int | None,
diff --git a/twitch/management/commands/import_chat_badges.py b/twitch/management/commands/import_chat_badges.py
index 2e0d463..43906be 100644
--- a/twitch/management/commands/import_chat_badges.py
+++ b/twitch/management/commands/import_chat_badges.py
@@ -50,7 +50,7 @@ class Command(BaseCommand):
help="Twitch Access Token (optional - will be obtained automatically if not provided)",
)
- def handle(self, *args, **options) -> None: # ruff:ignore[unused-method-argument]
+ def handle(self, *args, **options) -> None: # noqa: ARG002
"""Main entry point for the command.
Raises:
diff --git a/twitch/management/commands/import_twitch_drops_api.py b/twitch/management/commands/import_twitch_drops_api.py
index 8791b18..f8119ec 100644
--- a/twitch/management/commands/import_twitch_drops_api.py
+++ b/twitch/management/commands/import_twitch_drops_api.py
@@ -27,7 +27,7 @@ import hashlib
import json
import os
import pathlib
-import subprocess # ruff:ignore[suspicious-subprocess-import]
+import subprocess # noqa: S404
import tempfile
from typing import TYPE_CHECKING
from typing import Any
@@ -194,7 +194,7 @@ class Command(BaseCommand):
),
)
- def handle(self, *args: Any, **options: Any) -> None: # ruff:ignore[any-type, unused-method-argument, too-many-locals, too-many-statements]
+ def handle(self, *args: Any, **options: Any) -> None: # noqa: ANN401, ARG002, PLR0914, PLR0915
"""Main entry point for the command.
Raises:
@@ -301,7 +301,7 @@ class Command(BaseCommand):
crash_on_error=crash_on_error,
skip_existing=skip_existing,
)
- except Exception as exc: # ruff:ignore[blind-except]
+ except Exception as exc: # noqa: BLE001
msg = f"Failed to import drops.json: {exc}"
self.stderr.write(self.style.ERROR(msg))
errors.append(msg)
@@ -315,7 +315,7 @@ class Command(BaseCommand):
crash_on_error=crash_on_error,
skip_existing=skip_existing,
)
- except Exception as exc: # ruff:ignore[blind-except]
+ except Exception as exc: # noqa: BLE001
msg = f"Failed to import rewards.json: {exc}"
self.stderr.write(self.style.ERROR(msg))
errors.append(msg)
@@ -353,7 +353,7 @@ class Command(BaseCommand):
# Historical import via git clone
# ------------------------------------------------------------------
- def _process_historical( # ruff:ignore[too-many-arguments]
+ def _process_historical( # noqa: PLR0913
self,
source: str,
*,
@@ -423,7 +423,7 @@ class Command(BaseCommand):
max_commits=max_commits,
skip_existing=skip_existing,
)
- except Exception as exc: # ruff:ignore[blind-except]
+ except Exception as exc: # noqa: BLE001
errors.append(str(exc))
finally:
if own_clone:
@@ -431,7 +431,7 @@ class Command(BaseCommand):
return drops_count, rewards_count, errors
- def _import_historical_file( # ruff:ignore[too-many-arguments]
+ def _import_historical_file( # noqa: PLR0913
self,
git_dir: str,
file_path: str,
@@ -581,7 +581,7 @@ class Command(BaseCommand):
Stdout of the git command.
"""
cmd = ["git", "--git-dir", git_dir, *args]
- result = subprocess.run(cmd, capture_output=True, text=True, check=check) # ruff:ignore[subprocess-without-shell-equals-true]
+ result = subprocess.run(cmd, capture_output=True, text=True, check=check) # noqa: S603
return result.stdout
def _rmtree(self, path: str) -> None:
@@ -659,7 +659,7 @@ class Command(BaseCommand):
)
@staticmethod
- def _strip_typename(data: Any) -> Any: # ruff:ignore[any-type]
+ def _strip_typename(data: Any) -> Any: # noqa: ANN401
"""Recursively remove ``__typename`` keys from parsed JSON data.
Old commits in the repo included GraphQL ``__typename`` metadata which
@@ -683,7 +683,7 @@ class Command(BaseCommand):
return [Command._strip_typename(item) for item in data]
return data
- def _generate_report( # ruff:ignore[too-many-locals, too-many-statements]
+ def _generate_report( # noqa: PLR0914, PLR0915
self,
drops_url: str,
rewards_url: str,
@@ -707,7 +707,7 @@ class Command(BaseCommand):
Raises:
ValidationError: If any item fails schema validation and crash_on_error is True.
"""
- from collections import Counter # ruff:ignore[import-outside-top-level]
+ from collections import Counter # noqa: PLC0415
self.stdout.write("=" * 60)
self.stdout.write(self.style.SUCCESS("COMPARISON REPORT"))
@@ -719,14 +719,14 @@ class Command(BaseCommand):
# Track differences for field-level comparison
sample_limit = 5
- for label, raw_url, model_cls, id_field in [ # ruff:ignore[too-many-nested-blocks]
+ for label, raw_url, model_cls, id_field in [ # noqa: PLR1702
("drops", drops_url, DropCampaign, "twitch_id"),
("rewards", rewards_url, RewardCampaign, "twitch_id"),
]:
self.stdout.write(f"\n--- {label.upper()} ---")
try:
raw_data = self._fetch_json(raw_url, f"{label}.json")
- except Exception as exc: # ruff:ignore[blind-except]
+ except Exception as exc: # noqa: BLE001
self.stderr.write(
self.style.ERROR(f" Failed to fetch {label}.json: {exc}"),
)
@@ -894,7 +894,7 @@ class Command(BaseCommand):
self.stdout.write("\n" + "=" * 60)
- def _parse_and_import_drops( # ruff:ignore[too-many-arguments]
+ def _parse_and_import_drops( # noqa: PLR0913
self,
raw_data: list[dict[str, Any]],
source: str,
@@ -976,7 +976,7 @@ class Command(BaseCommand):
return total_campaigns
- def _process_sunkwibot_reward( # ruff:ignore[too-many-statements]
+ def _process_sunkwibot_reward( # noqa: PLR0915
self,
reward: SunkwiBotRewardSchema,
game_obj: Game,
@@ -1133,7 +1133,7 @@ class Command(BaseCommand):
self,
tbd_schema: SunkwiBotTimeBasedDropSchema,
campaign_obj: DropCampaign,
- source: str, # ruff:ignore[unused-method-argument]
+ source: str, # noqa: ARG002
*,
verbose: bool,
) -> None:
@@ -1335,7 +1335,7 @@ class Command(BaseCommand):
skip_existing=skip_existing,
)
- def _parse_and_import_rewards( # ruff:ignore[too-many-arguments]
+ def _parse_and_import_rewards( # noqa: PLR0913
self,
raw_data: list[dict[str, Any]],
source: str,
@@ -1563,12 +1563,12 @@ class Command(BaseCommand):
self._org_cache[twitch_id] = org_obj
return org_obj
- def _get_or_create_game( # ruff:ignore[too-many-arguments]
+ def _get_or_create_game( # noqa: PLR0913
self,
twitch_id: str,
display_name: str,
box_art_url: str,
- source: str, # ruff:ignore[unused-method-argument]
+ source: str, # noqa: ARG002
*,
verbose: bool,
org_obj: Organization | None = None,
diff --git a/twitch/management/commands/watch_imports.py b/twitch/management/commands/watch_imports.py
index 96e8549..d1f6ca3 100644
--- a/twitch/management/commands/watch_imports.py
+++ b/twitch/management/commands/watch_imports.py
@@ -37,7 +37,7 @@ class Command(BaseCommand):
help="Path to directory to watch for JSON files",
)
- def handle(self, *args, **options) -> None: # ruff:ignore[unused-method-argument]
+ def handle(self, *args, **options) -> None: # noqa: ARG002
"""Main entry point for the watch command.
Args:
@@ -87,7 +87,7 @@ class Command(BaseCommand):
importer_command: An instance of the BetterImportDropsCommand to handle the import logic.
watch_path: The directory path to watch for JSON files.
"""
- # TODO(TheLovinator): Implement actual file watching using watchdog or similar library. # ruff:ignore[missing-todo-link]
+ # TODO(TheLovinator): Implement actual file watching using watchdog or similar library. # noqa: TD003
json_files: list[Path] = [
f for f in watch_path.iterdir() if f.suffix == ".json" and f.is_file()
]
diff --git a/twitch/migrations/0007_rename_operation_name_to_operation_names.py b/twitch/migrations/0007_rename_operation_name_to_operation_names.py
index bbe6ac2..63190e1 100644
--- a/twitch/migrations/0007_rename_operation_name_to_operation_names.py
+++ b/twitch/migrations/0007_rename_operation_name_to_operation_names.py
@@ -5,7 +5,7 @@ from django.db import migrations
from django.db import models
-def migrate_operation_name_to_list(apps, schema_editor) -> None: # ruff:ignore[missing-type-function-argument]
+def migrate_operation_name_to_list(apps, schema_editor) -> None: # noqa: ANN001
"""Convert operation_name string values to operation_names list."""
DropCampaign = apps.get_model("twitch", "DropCampaign")
for campaign in DropCampaign.objects.all():
@@ -14,7 +14,7 @@ def migrate_operation_name_to_list(apps, schema_editor) -> None: # ruff:ignore[
campaign.save(update_fields=["operation_names"])
-def reverse_operation_names_to_string(apps, schema_editor) -> None: # ruff:ignore[missing-type-function-argument]
+def reverse_operation_names_to_string(apps, schema_editor) -> None: # noqa: ANN001
"""Convert operation_names list back to operation_name string (first item only)."""
DropCampaign = apps.get_model("twitch", "DropCampaign")
for campaign in DropCampaign.objects.all():
diff --git a/twitch/migrations/0016_mark_all_drops_fully_imported.py b/twitch/migrations/0016_mark_all_drops_fully_imported.py
index 5a9ef00..54b4003 100644
--- a/twitch/migrations/0016_mark_all_drops_fully_imported.py
+++ b/twitch/migrations/0016_mark_all_drops_fully_imported.py
@@ -1,7 +1,7 @@
from django.db import migrations
-def mark_all_drops_fully_imported(apps, schema_editor) -> None: # ruff:ignore[missing-type-function-argument]
+def mark_all_drops_fully_imported(apps, schema_editor) -> None: # noqa: ANN001
"""Marks all existing DropCampaigns as fully imported.
This was needed to ensure that the Twitch API view only returns campaigns that are ready for display.
diff --git a/twitch/models.py b/twitch/models.py
index 7ff20f7..6aeb0f1 100644
--- a/twitch/models.py
+++ b/twitch/models.py
@@ -137,7 +137,7 @@ class Game(auto_prefetch.Model):
default="",
)
- box_art = models.URLField( # ruff:ignore[django-nullable-model-string-field]
+ box_art = models.URLField( # noqa: DJ001
verbose_name="Box art URL",
max_length=500,
blank=True,
@@ -231,12 +231,12 @@ class Game(auto_prefetch.Model):
@property
def organizations(self) -> models.QuerySet[Organization]:
- """Orgs that own games with campaigns for this game."""
+ """Return orgs that own games with campaigns for this game."""
return Organization.objects.filter(games__drop_campaigns__game=self).distinct()
@property
def get_game_name(self) -> str:
- """The best available name for the game."""
+ """Return the best available name for the game."""
if self.display_name:
return self.display_name
if self.name:
@@ -247,8 +247,8 @@ class Game(auto_prefetch.Model):
@property
def twitch_directory_url(self) -> str:
- """Twitch directory URL with drops filter when slug exists."""
- # TODO(TheLovinator): If no slug, get from Twitch API or IGDB? # ruff:ignore[missing-todo-link]
+ """Return Twitch directory URL with drops filter when slug exists."""
+ # TODO(TheLovinator): If no slug, get from Twitch API or IGDB? # noqa: TD003
if self.slug:
return f"https://www.twitch.tv/directory/category/{self.slug}?filter=drops"
@@ -256,7 +256,7 @@ class Game(auto_prefetch.Model):
@property
def box_art_best_url(self) -> str:
- """The best available URL for the game's box art (local first)."""
+ """Return the best available URL for the game's box art (local first)."""
try:
if self.box_art_file and getattr(self.box_art_file, "url", None):
return self.box_art_file.url
@@ -271,7 +271,7 @@ class Game(auto_prefetch.Model):
@property
def dashboard_box_art_url(self) -> str:
- """Dashboard-safe box art URL without touching deferred image fields."""
+ """Return dashboard-safe box art URL without touching deferred image fields."""
return normalize_twitch_box_art_url(self.box_art or "")
@classmethod
@@ -570,7 +570,7 @@ class Channel(auto_prefetch.Model):
@property
def preferred_name(self) -> str:
- """Display name fallback used by channel-facing pages."""
+ """Return display name fallback used by channel-facing pages."""
return self.display_name or self.name or self.twitch_id
def detail_description(self, total_campaigns: int) -> str:
@@ -580,7 +580,7 @@ class Channel(auto_prefetch.Model):
# MARK: DropCampaign
-class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
+class DropCampaign(auto_prefetch.Model): # noqa: PLR0904
"""Represents a Twitch drop campaign."""
twitch_id = models.TextField(
@@ -801,10 +801,6 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
queryset = queryset.filter(start_at__gt=now)
elif status == "expired":
queryset = queryset.filter(end_at__lt=now)
- elif status == "unknown":
- queryset = queryset.filter(
- Q(start_at__isnull=True) | Q(end_at__isnull=True),
- )
return queryset
@classmethod
@@ -1270,7 +1266,7 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def clean_name(self) -> str:
- """The campaign name without the game name prefix.
+ """Return the campaign name without the game name prefix.
Examples:
"Ravendawn - July 2" -> "July 2"
@@ -1302,7 +1298,7 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def single_reward_benefit(self) -> DropBenefit | None:
- """The only unique reward benefit for this campaign, if it has one."""
+ """Return the only unique reward benefit for this campaign, if it has one."""
benefits: list[DropBenefit] = []
seen_benefit_keys: set[int | str] = set()
@@ -1321,7 +1317,7 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def single_reward_image_best_url(self) -> str:
- """The best image URL for a campaign that has exactly one reward."""
+ """Return the best image URL for a campaign that has exactly one reward."""
benefit: DropBenefit | None = self.single_reward_benefit
if not benefit:
return ""
@@ -1329,12 +1325,12 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def meta_image_url(self) -> str:
- """The preferred campaign image URL for SEO metadata."""
+ """Return the preferred campaign image URL for SEO metadata."""
return self.single_reward_image_best_url or self.image_best_url
@property
def image_best_url(self) -> str:
- """The best URL for the campaign image.
+ """Return the best URL for the campaign image.
Priority:
1. Local cached image file
@@ -1361,7 +1357,7 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def listing_image_url(self) -> str:
- """A campaign image URL optimized for list views.
+ """Return a campaign image URL optimized for list views.
This intentionally avoids traversing drops/benefits to prevent N+1 queries
in list pages that render many campaigns.
@@ -1375,7 +1371,7 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def dashboard_image_url(self) -> str:
- """Dashboard-safe campaign or single-reward image URL."""
+ """Return dashboard-safe campaign or single-reward image URL."""
benefit: DropBenefit | None = self.single_reward_benefit
if benefit and benefit.image_asset_url:
return benefit.image_asset_url
@@ -1383,7 +1379,7 @@ class DropCampaign(auto_prefetch.Model): # ruff:ignore[too-many-public-methods]
@property
def duration_iso(self) -> str:
- """The campaign duration in ISO 8601 format (e.g., 'P3DT4H30M').
+ """Return the campaign duration in ISO 8601 format (e.g., 'P3DT4H30M').
This is used for the