small refactoring and review feedback

Author: artcz

intbot/core/admin.py

@@ -26,12 +26,12 @@ class WebhookAdmin(admin.ModelAdmin):
         "processed_at",
     ]
 
-    def pretty_meta(self, obj):
+    def pretty_meta(self, obj: Webhook):
         return format_html("<pre>{}</pre>", json.dumps(obj.meta, indent=4))
 
     pretty_meta.short_description = "Meta"
 
-    def pretty_content(self, obj):
+    def pretty_content(self, obj: Webhook):
         return format_html("<pre>{}</pre>", json.dumps(obj.content, indent=4))
 
     pretty_content.short_description = "Content"
@@ -61,7 +61,7 @@ class DiscordMessageAdmin(admin.ModelAdmin):
         "sent_at",
     ]
 
-    def content_short(self, obj):
+    def content_short(self, obj: DiscordMessage):
         # NOTE(artcz) This can create false shortcuts, but for most messages is
         # good enough, because most of them are longer than 20 chars
         return f"{obj.content[:10]}...{obj.content[-10:]}"
@@ -84,7 +84,7 @@ class PretalxDataAdmin(admin.ModelAdmin):
         "processed_at",
     ]
 
-    def pretty_content(self, obj):
+    def pretty_content(self, obj: PretalxData):
         return format_html("<pre>{}</pre>", json.dumps(obj.content, indent=4))
 
     pretty_content.short_description = "Content"

intbot/core/integrations/pretalx.py

@@ -1,66 +1,85 @@
+import logging
 from typing import Any
 
 import httpx
 from core.models import PretalxData
 from django.conf import settings
 
-PRETALX_EVENT = "ep2025"
-base_url = f"https://pretalx.com/api/events/{PRETALX_EVENT}/"
+logger = logging.getLogger(__name__)
 
-RESOURCES = {
+PRETALX_EVENTS = [
+    "ep2023",
+    "ep2024",
+    "ep2025",
+]
+
+ENDPOINTS = {
     # Questions need to be passed to include answers in the same endpoint,
     # saving us later time with joining the answers.
-    PretalxData.PretalxEndpoints.submissions: "submissions?questions=all",
-    PretalxData.PretalxEndpoints.speakers: "speakers?questions=all",
+    PretalxData.PretalxResources.submissions: "submissions?questions=all",
+    PretalxData.PretalxResources.speakers: "speakers?questions=all",
 }
 
 
 JsonType = dict[str, Any]
 
 
-def fetch_pretalx_data(resource) -> list[JsonType]:
+def get_event_url(event):
+    assert event in PRETALX_EVENTS
+
+    return f"https://pretalx.com/api/events/{event}/"
+
+
+def fetch_pretalx_data(event: str, resource: PretalxData.PretalxResources) -> list[JsonType]:
     headers = {
         "Authorization": f"Token {settings.PRETALX_API_TOKEN}",
         "Content-Type": "application/json",
     }
 
-    endpoint = RESOURCES[resource]
-    url = base_url + f"{endpoint}"
+    base_url = get_event_url(event)
+    endpoint = ENDPOINTS[resource]
+    url = f"{base_url}{endpoint}"
 
     # Pretalx paginates the output, so we will need to do multiple requests and
     # then merge mutliple pages to one big dictionary
-    res0 = []
+    results = []
     data = {"next": url}
-    n = 0
+    page = 0
+
+    # This takes advantage of the fact that "next" will contain a url to the
+    # next page, until there is more data to fetch. If this is the last page,
+    # then the data["next"] will be None (falsy), and thus stop the while loop.
     while url := data["next"]:
-        n += 1
+        page += 1
         response = httpx.get(url, headers=headers)
 
         if response.status_code != 200:
             raise Exception(f"Error {response.status_code}: {response.text}")
 
+        logger.info("Fetching data from %s, page %s", url, page)
+
         data = response.json()
-        res0 += data["results"]
+        results += data["results"]
 
-    return res0
+    return results
 
 
-def download_latest_submissions() -> PretalxData:
-    data = fetch_pretalx_data(PretalxData.PretalxEndpoints.submissions)
+def download_latest_submissions(event: str) -> PretalxData:
+    data = fetch_pretalx_data(event, PretalxData.PretalxResources.submissions)
 
     pretalx_data = PretalxData.objects.create(
-        endpoint=PretalxData.PretalxEndpoints.submissions,
+        resource=PretalxData.PretalxResources.submissions,
         content=data,
     )
 
     return pretalx_data
 
 
-def download_latest_speakers() -> PretalxData:
-    data = fetch_pretalx_data(PretalxData.PretalxEndpoints.speakers)
+def download_latest_speakers(event: str) -> PretalxData:
+    data = fetch_pretalx_data(event, PretalxData.PretalxResources.speakers)
 
     pretalx_data = PretalxData.objects.create(
-        endpoint=PretalxData.PretalxEndpoints.speakers,
+        resource=PretalxData.PretalxResources.speakers,
         content=data,
     )
 

intbot/core/models.py

@@ -92,15 +92,15 @@ class PretalxData(models.Model):
     "business" tables, like "Proposal" or "Speaker".
     """
 
-    class PretalxEndpoints(models.TextChoices):
+    class PretalxResources(models.TextChoices):
         submissions = "submissions", "Submissions"
         speakers = "speakers", "Speakers"
         schedule = "schedule", "Schedule"
 
     uuid = models.UUIDField(default=uuid.uuid4)
-    endpoint = models.CharField(
+    resource= models.CharField(
         max_length=255,
-        choices=PretalxEndpoints.choices,
+        choices=PretalxResources.choices,
     )
     content = models.JSONField()