Use function based views instead of class based views
This commit is contained in:
parent
df6a77a1fd
commit
5e415ae1c8
3 changed files with 218 additions and 261 deletions
|
|
@ -12,8 +12,8 @@
|
|||
<h2 id="organizations-header">Organizations</h2>
|
||||
<ul id="organizations-list">
|
||||
{% for org in results.organizations %}
|
||||
<li id="org-{{ org.pk }}">
|
||||
<a href="{% url 'twitch:organization_detail' org.pk %}">{{ org.name }}</a>
|
||||
<li id="org-{{ org.twitch_id }}">
|
||||
<a href="{% url 'twitch:organization_detail' org.twitch_id %}">{{ org.name }}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
@ -22,8 +22,8 @@
|
|||
<h2 id="games-header">Games</h2>
|
||||
<ul id="games-list">
|
||||
{% for game in results.games %}
|
||||
<li id="game-{{ game.pk }}">
|
||||
<a href="{% url 'twitch:game_detail' game.pk %}">{{ game.display_name }}</a>
|
||||
<li id="game-{{ game.twitch_id }}">
|
||||
<a href="{% url 'twitch:game_detail' game.twitch_id %}">{{ game.display_name }}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
@ -32,8 +32,8 @@
|
|||
<h2 id="campaigns-header">Campaigns</h2>
|
||||
<ul id="campaigns-list">
|
||||
{% for campaign in results.campaigns %}
|
||||
<li id="campaign-{{ campaign.pk }}">
|
||||
<a href="{% url 'twitch:campaign_detail' campaign.pk %}">{{ campaign.name }}</a>
|
||||
<li id="campaign-{{ campaign.twitch_id }}">
|
||||
<a href="{% url 'twitch:campaign_detail' campaign.twitch_id %}">{{ campaign.name }}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
@ -42,8 +42,8 @@
|
|||
<h2 id="drops-header">Drops</h2>
|
||||
<ul id="drops-list">
|
||||
{% for drop in results.drops %}
|
||||
<li id="drop-{{ drop.id }}">
|
||||
<a href="{% url 'twitch:campaign_detail' drop.campaign.pk %}#drop-{{ drop.id }}">{{ drop.name }}</a> (in {{ drop.campaign.name }})
|
||||
<li id="drop-{{ drop.twitch_id }}">
|
||||
<a href="{% url 'twitch:campaign_detail' drop.campaign.pk %}#drop-{{ drop.twitch_id }}">{{ drop.name }}</a> (in {{ drop.campaign.name }})
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
{% if results.benefits %}
|
||||
<h2 id="benefits-header">Benefits</h2>
|
||||
<ul id="benefits-list">
|
||||
{% for benefit in results.benefits %}<li id="benefit-{{ benefit.id }}">{{ benefit.name }}</li>{% endfor %}
|
||||
{% for benefit in results.benefits %}<li id="benefit-{{ benefit.twitch_id }}">{{ benefit.name }}</li>{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -18,39 +18,15 @@ urlpatterns: list[URLPattern] = [
|
|||
path("", views.dashboard, name="dashboard"),
|
||||
path("search/", views.search_view, name="search"),
|
||||
path("debug/", views.debug_view, name="debug"),
|
||||
path(
|
||||
"campaigns/",
|
||||
views.DropCampaignListView.as_view(),
|
||||
name="campaign_list",
|
||||
),
|
||||
path(
|
||||
"campaigns/<str:pk>/",
|
||||
views.DropCampaignDetailView.as_view(),
|
||||
name="campaign_detail",
|
||||
),
|
||||
path("campaigns/", views.drop_campaign_list_view, name="campaign_list"),
|
||||
path("campaigns/<str:twitch_id>/", views.drop_campaign_detail_view, name="campaign_detail"),
|
||||
path("games/", views.GamesGridView.as_view(), name="game_list"),
|
||||
path(
|
||||
"games/list/",
|
||||
views.GamesListView.as_view(),
|
||||
name="game_list_simple",
|
||||
),
|
||||
path(
|
||||
"games/<str:pk>/",
|
||||
views.GameDetailView.as_view(),
|
||||
name="game_detail",
|
||||
),
|
||||
path("games/list/", views.GamesListView.as_view(), name="game_list_simple"),
|
||||
path("games/<str:twitch_id>/", views.GameDetailView.as_view(), name="game_detail"),
|
||||
path("organizations/", views.OrgListView.as_view(), name="org_list"),
|
||||
path(
|
||||
"organizations/<str:pk>/",
|
||||
views.OrgDetailView.as_view(),
|
||||
name="organization_detail",
|
||||
),
|
||||
path("organizations/<str:twitch_id>/", views.organization_detail_view, name="organization_detail"),
|
||||
path("channels/", views.ChannelListView.as_view(), name="channel_list"),
|
||||
path(
|
||||
"channels/<str:pk>/",
|
||||
views.ChannelDetailView.as_view(),
|
||||
name="channel_detail",
|
||||
),
|
||||
path("channels/<str:twitch_id>/", views.ChannelDetailView.as_view(), name="channel_detail"),
|
||||
path("rss/organizations/", OrganizationFeed(), name="organization_feed"),
|
||||
path("rss/games/", GameFeed(), name="game_feed"),
|
||||
path("rss/campaigns/", DropCampaignFeed(), name="campaign_feed"),
|
||||
|
|
|
|||
251
twitch/views.py
251
twitch/views.py
|
|
@ -8,10 +8,12 @@ from collections import defaultdict
|
|||
from typing import TYPE_CHECKING
|
||||
from typing import Any
|
||||
|
||||
from django.core.paginator import EmptyPage
|
||||
from django.core.paginator import PageNotAnInteger
|
||||
from django.core.paginator import Paginator
|
||||
from django.core.serializers import serialize
|
||||
from django.db.models import Count
|
||||
from django.db.models import F
|
||||
from django.db.models import Model
|
||||
from django.db.models import Prefetch
|
||||
from django.db.models import Q
|
||||
from django.db.models.functions import Trim
|
||||
|
|
@ -101,53 +103,28 @@ class OrgListView(ListView):
|
|||
context_object_name = "orgs"
|
||||
|
||||
|
||||
# MARK: /organizations/<pk>/
|
||||
class OrgDetailView(DetailView):
|
||||
"""Detail view for organization."""
|
||||
# MARK: /organizations/<twitch_id>/
|
||||
|
||||
model = Organization
|
||||
template_name = "twitch/organization_detail.html"
|
||||
context_object_name = "organization"
|
||||
|
||||
def get_object(
|
||||
self,
|
||||
queryset: QuerySet[Organization] | None = None,
|
||||
) -> Organization:
|
||||
"""Get the organization object using twitch_id.
|
||||
def organization_detail_view(request: HttpRequest, twitch_id: str) -> HttpResponse:
|
||||
"""Function-based view for organization detail.
|
||||
|
||||
Args:
|
||||
queryset: Optional queryset to use.
|
||||
request: The HTTP request.
|
||||
twitch_id: The Twitch ID of the organization.
|
||||
|
||||
Returns:
|
||||
Organization: The organization object.
|
||||
HttpResponse: The rendered organization detail page.
|
||||
|
||||
Raises:
|
||||
Http404: If the organization is not found.
|
||||
"""
|
||||
if queryset is None:
|
||||
queryset = self.get_queryset()
|
||||
|
||||
# Use twitch_id as the lookup field since it's the primary key
|
||||
pk: str | None = self.kwargs.get(self.pk_url_kwarg)
|
||||
try:
|
||||
org: Organization = queryset.get(twitch_id=pk)
|
||||
organization: Organization = Organization.objects.get(twitch_id=twitch_id)
|
||||
except Organization.DoesNotExist as exc:
|
||||
msg = "No organization found matching the query"
|
||||
raise Http404(msg) from exc
|
||||
|
||||
return org
|
||||
|
||||
def get_context_data(self, **kwargs) -> dict[str, Any]:
|
||||
"""Add additional context data.
|
||||
|
||||
Args:
|
||||
**kwargs: Additional arguments.
|
||||
|
||||
Returns:
|
||||
dict: Context data.
|
||||
"""
|
||||
context: dict[str, Any] = super().get_context_data(**kwargs)
|
||||
organization: Organization = self.get_object() # pyright: ignore[reportAssignmentType]
|
||||
games: QuerySet[Game] = organization.games.all() # pyright: ignore[reportAttributeAccessIssue]
|
||||
|
||||
serialized_org: str = serialize(
|
||||
|
|
@ -168,58 +145,63 @@ class OrgDetailView(DetailView):
|
|||
|
||||
pretty_org_data: str = json.dumps(org_data[0], indent=4)
|
||||
|
||||
context.update(
|
||||
{
|
||||
context: dict[str, Any] = {
|
||||
"organization": organization,
|
||||
"games": games,
|
||||
"org_data": pretty_org_data,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
return context
|
||||
return render(request, "twitch/organization_detail.html", context)
|
||||
|
||||
|
||||
# MARK: /campaigns/
|
||||
class DropCampaignListView(ListView):
|
||||
"""List view for drop campaigns."""
|
||||
def drop_campaign_list_view(request: HttpRequest) -> HttpResponse:
|
||||
"""Function-based view for drop campaigns list.
|
||||
|
||||
model = DropCampaign
|
||||
template_name = "twitch/campaign_list.html"
|
||||
context_object_name = "campaigns"
|
||||
paginate_by = 100
|
||||
|
||||
def get_queryset(self) -> QuerySet[DropCampaign]:
|
||||
"""Get queryset of drop campaigns.
|
||||
Args:
|
||||
request: The HTTP request.
|
||||
|
||||
Returns:
|
||||
QuerySet: Filtered drop campaigns.
|
||||
HttpResponse: The rendered campaign list page.
|
||||
"""
|
||||
queryset: QuerySet[DropCampaign] = super().get_queryset()
|
||||
game_filter: str | None = self.request.GET.get("game")
|
||||
game_filter: str | None = request.GET.get("game")
|
||||
status_filter: str | None = request.GET.get("status")
|
||||
per_page: int = 100
|
||||
queryset: QuerySet[DropCampaign] = DropCampaign.objects.all()
|
||||
|
||||
if game_filter:
|
||||
queryset = queryset.filter(game__id=game_filter)
|
||||
|
||||
return queryset.select_related("game__owner").order_by("-start_at")
|
||||
queryset = queryset.select_related("game__owner").order_by("-start_at")
|
||||
|
||||
def get_context_data(self, **kwargs) -> dict[str, Any]:
|
||||
"""Add additional context data.
|
||||
# Optionally filter by status (active, upcoming, expired)
|
||||
now = timezone.now()
|
||||
if status_filter == "active":
|
||||
queryset = queryset.filter(start_at__lte=now, end_at__gte=now)
|
||||
elif status_filter == "upcoming":
|
||||
queryset = queryset.filter(start_at__gt=now)
|
||||
elif status_filter == "expired":
|
||||
queryset = queryset.filter(end_at__lt=now)
|
||||
|
||||
Args:
|
||||
**kwargs: Additional arguments.
|
||||
paginator = Paginator(queryset, per_page)
|
||||
page = request.GET.get("page") or 1
|
||||
try:
|
||||
campaigns = paginator.page(page)
|
||||
except PageNotAnInteger:
|
||||
campaigns = paginator.page(1)
|
||||
except EmptyPage:
|
||||
campaigns = paginator.page(paginator.num_pages)
|
||||
|
||||
Returns:
|
||||
dict: Context data.
|
||||
"""
|
||||
context: dict[str, Any] = super().get_context_data(**kwargs)
|
||||
|
||||
context["games"] = Game.objects.all().order_by("display_name")
|
||||
context["status_options"] = ["active", "upcoming", "expired"]
|
||||
context["now"] = timezone.now()
|
||||
context["selected_game"] = self.request.GET.get("game", "")
|
||||
context["selected_per_page"] = self.paginate_by
|
||||
context["selected_status"] = self.request.GET.get("status", "")
|
||||
|
||||
return context
|
||||
context: dict[str, Any] = {
|
||||
"campaigns": campaigns,
|
||||
"games": Game.objects.all().order_by("display_name"),
|
||||
"status_options": ["active", "upcoming", "expired"],
|
||||
"now": now,
|
||||
"selected_game": game_filter or "",
|
||||
"selected_per_page": per_page,
|
||||
"selected_status": status_filter or "",
|
||||
}
|
||||
return render(request, "twitch/campaign_list.html", context)
|
||||
|
||||
|
||||
def format_and_color_json(data: dict[str, Any] | str) -> str:
|
||||
|
|
@ -238,44 +220,69 @@ def format_and_color_json(data: dict[str, Any] | str) -> str:
|
|||
return highlight(formatted_code, JsonLexer(), HtmlFormatter())
|
||||
|
||||
|
||||
# MARK: /campaigns/<pk>/
|
||||
class DropCampaignDetailView(DetailView):
|
||||
"""Detail view for a drop campaign."""
|
||||
# MARK: /campaigns/<twitch_id>/
|
||||
|
||||
model = DropCampaign
|
||||
template_name = "twitch/campaign_detail.html"
|
||||
context_object_name = "campaign"
|
||||
# MARK: /campaigns/<twitch_id>/
|
||||
|
||||
def get_object(
|
||||
self,
|
||||
queryset: QuerySet[DropCampaign] | None = None,
|
||||
) -> Model:
|
||||
"""Get the campaign object with related data prefetched.
|
||||
|
||||
def _enhance_drops_with_context(drops: QuerySet[TimeBasedDrop], now: datetime.datetime) -> list[dict[str, Any]]:
|
||||
"""Helper to enhance drops with countdown and context.
|
||||
|
||||
Args:
|
||||
queryset: Optional queryset to use.
|
||||
drops: QuerySet of TimeBasedDrop objects.
|
||||
now: Current datetime.
|
||||
|
||||
Returns:
|
||||
DropCampaign: The campaign object with prefetched relations.
|
||||
List of dicts with drop, local_start, local_end, timezone_name, and countdown_text.
|
||||
"""
|
||||
if queryset is None:
|
||||
queryset = self.get_queryset()
|
||||
enhanced = []
|
||||
for drop in drops:
|
||||
if drop.end_at and drop.end_at > now:
|
||||
time_diff: datetime.timedelta = drop.end_at - now
|
||||
days: int = time_diff.days
|
||||
hours, remainder = divmod(time_diff.seconds, 3600)
|
||||
minutes, seconds = divmod(remainder, 60)
|
||||
if days > 0:
|
||||
countdown_text: str = f"{days}d {hours}h {minutes}m"
|
||||
elif hours > 0:
|
||||
countdown_text = f"{hours}h {minutes}m"
|
||||
elif minutes > 0:
|
||||
countdown_text = f"{minutes}m {seconds}s"
|
||||
else:
|
||||
countdown_text = f"{seconds}s"
|
||||
elif drop.start_at and drop.start_at > now:
|
||||
countdown_text = "Not started"
|
||||
else:
|
||||
countdown_text = "Expired"
|
||||
enhanced.append({
|
||||
"drop": drop,
|
||||
"local_start": drop.start_at,
|
||||
"local_end": drop.end_at,
|
||||
"timezone_name": "UTC",
|
||||
"countdown_text": countdown_text,
|
||||
})
|
||||
return enhanced
|
||||
|
||||
queryset = queryset.select_related("game__owner")
|
||||
|
||||
return super().get_object(queryset=queryset)
|
||||
|
||||
def get_context_data(self, **kwargs: object) -> dict[str, Any]: # noqa: PLR0914
|
||||
"""Add additional context data.
|
||||
def drop_campaign_detail_view(request: HttpRequest, twitch_id: str) -> HttpResponse:
|
||||
"""Function-based view for a drop campaign detail.
|
||||
|
||||
Args:
|
||||
**kwargs: Additional arguments.
|
||||
request: The HTTP request.
|
||||
twitch_id: The Twitch ID of the campaign.
|
||||
|
||||
Returns:
|
||||
dict: Context data.
|
||||
HttpResponse: The rendered campaign detail page.
|
||||
|
||||
Raises:
|
||||
Http404: If the campaign is not found.
|
||||
"""
|
||||
context: dict[str, Any] = super().get_context_data(**kwargs)
|
||||
campaign: DropCampaign = context["campaign"]
|
||||
try:
|
||||
campaign: DropCampaign = DropCampaign.objects.select_related("game__owner").get(twitch_id=twitch_id)
|
||||
except DropCampaign.DoesNotExist as exc:
|
||||
msg = "No campaign found matching the query"
|
||||
raise Http404(msg) from exc
|
||||
|
||||
drops: QuerySet[TimeBasedDrop] = (
|
||||
TimeBasedDrop.objects
|
||||
.filter(campaign=campaign)
|
||||
|
|
@ -330,46 +337,19 @@ class DropCampaignDetailView(DetailView):
|
|||
|
||||
campaign_data[0]["fields"]["drops"] = drops_data
|
||||
|
||||
# Enhance drops with additional context data
|
||||
enhanced_drops: list[dict[str, TimeBasedDrop | datetime.datetime | str | None]] = []
|
||||
now: datetime.datetime = timezone.now()
|
||||
for drop in drops:
|
||||
# Calculate countdown text
|
||||
if drop.end_at and drop.end_at > now:
|
||||
time_diff: datetime.timedelta = drop.end_at - now
|
||||
days: int = time_diff.days
|
||||
hours, remainder = divmod(time_diff.seconds, 3600)
|
||||
minutes, seconds = divmod(remainder, 60)
|
||||
enhanced_drops = _enhance_drops_with_context(drops, now)
|
||||
|
||||
if days > 0:
|
||||
countdown_text: str = f"{days}d {hours}h {minutes}m"
|
||||
elif hours > 0:
|
||||
countdown_text = f"{hours}h {minutes}m"
|
||||
elif minutes > 0:
|
||||
countdown_text = f"{minutes}m {seconds}s"
|
||||
else:
|
||||
countdown_text = f"{seconds}s"
|
||||
elif drop.start_at and drop.start_at > now:
|
||||
countdown_text = "Not started"
|
||||
else:
|
||||
countdown_text = "Expired"
|
||||
|
||||
enhanced_drop: dict[str, TimeBasedDrop | datetime.datetime | str | None] = {
|
||||
"drop": drop,
|
||||
"local_start": drop.start_at,
|
||||
"local_end": drop.end_at,
|
||||
"timezone_name": "UTC",
|
||||
"countdown_text": countdown_text,
|
||||
context: dict[str, Any] = {
|
||||
"campaign": campaign,
|
||||
"now": now,
|
||||
"drops": enhanced_drops,
|
||||
"campaign_data": format_and_color_json(campaign_data[0]),
|
||||
"owner": campaign.game.owner,
|
||||
"allowed_channels": campaign.allow_channels.all().order_by("display_name"),
|
||||
}
|
||||
enhanced_drops.append(enhanced_drop)
|
||||
|
||||
context["now"] = now
|
||||
context["drops"] = enhanced_drops
|
||||
context["campaign_data"] = format_and_color_json(campaign_data[0])
|
||||
context["owner"] = campaign.game.owner
|
||||
context["allowed_channels"] = campaign.allow_channels.all().order_by("display_name")
|
||||
|
||||
return context
|
||||
return render(request, "twitch/campaign_detail.html", context)
|
||||
|
||||
|
||||
# MARK: /games/
|
||||
|
|
@ -448,13 +428,14 @@ class GamesGridView(ListView):
|
|||
return context
|
||||
|
||||
|
||||
# MARK: /games/<pk>/
|
||||
# MARK: /games/<twitch_id>/
|
||||
class GameDetailView(DetailView):
|
||||
"""Detail view for a game."""
|
||||
|
||||
model = Game
|
||||
template_name = "twitch/game_detail.html"
|
||||
context_object_name = "game"
|
||||
lookup_field = "twitch_id"
|
||||
|
||||
def get_object(self, queryset: QuerySet[Game] | None = None) -> Game:
|
||||
"""Get the game object using twitch_id as the primary key lookup.
|
||||
|
|
@ -472,9 +453,9 @@ class GameDetailView(DetailView):
|
|||
queryset = self.get_queryset()
|
||||
|
||||
# Use twitch_id as the lookup field since it's the primary key
|
||||
pk = self.kwargs.get(self.pk_url_kwarg)
|
||||
twitch_id = self.kwargs.get("twitch_id")
|
||||
try:
|
||||
game = queryset.get(twitch_id=pk)
|
||||
game = queryset.get(twitch_id=twitch_id)
|
||||
except Game.DoesNotExist as exc:
|
||||
msg = "No game found matching the query"
|
||||
raise Http404(msg) from exc
|
||||
|
|
@ -832,13 +813,14 @@ class ChannelListView(ListView):
|
|||
return context
|
||||
|
||||
|
||||
# MARK: /channels/<pk>/
|
||||
# MARK: /channels/<twitch_id>/
|
||||
class ChannelDetailView(DetailView):
|
||||
"""Detail view for a channel."""
|
||||
|
||||
model = Channel
|
||||
template_name = "twitch/channel_detail.html"
|
||||
context_object_name = "channel"
|
||||
lookup_field = "twitch_id"
|
||||
|
||||
def get_object(self, queryset: QuerySet[Channel] | None = None) -> Channel:
|
||||
"""Get the channel object using twitch_id as the primary key lookup.
|
||||
|
|
@ -855,10 +837,9 @@ class ChannelDetailView(DetailView):
|
|||
if queryset is None:
|
||||
queryset = self.get_queryset()
|
||||
|
||||
# Use twitch_id as the lookup field since it's the primary key
|
||||
pk = self.kwargs.get(self.pk_url_kwarg)
|
||||
twitch_id = self.kwargs.get("twitch_id")
|
||||
try:
|
||||
channel = queryset.get(twitch_id=pk)
|
||||
channel = queryset.get(twitch_id=twitch_id)
|
||||
except Channel.DoesNotExist as exc:
|
||||
msg = "No channel found matching the query"
|
||||
raise Http404(msg) from exc
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue