Replace absolute_urls_to_freeze with a utility function

Author: encukou

naucse/freezer.py

@@ -1,8 +1,13 @@
 import contextlib
+from collections import deque
 
 from flask_frozen import UrlForLogger, Freezer
 
-from naucse.utils.views import absolute_urls_to_freeze
+absolute_urls_to_freeze = deque()
+
+def record_url(url):
+    """Logs that `url` should be included in the resulting static site"""
+    absolute_urls_to_freeze.append(url)
 
 
 class AllLinksLogger(UrlForLogger):

naucse/models.py

@@ -14,7 +14,7 @@
 import naucse.utils.views
 from naucse.utils.models import Model, YamlProperty, DataProperty, DirProperty, MultipleModelDirProperty, ForkProperty
 from naucse.utils.models import reify, arca
-from naucse.utils.views import absolute_urls_to_freeze
+from naucse.freezer import record_url
 from naucse.validation import AllowedElementsParser
 from naucse.templates import setup_jinja_env, vars_functions
 from naucse.utils.markdown import convert_markdown
@@ -647,7 +647,9 @@ def render(self, page_type, *args, **kwargs):
         if "urls" in result.output:
             # Freeze URLs generated by the code in fork, but only if
             # they start with the slug of the course
-            absolute_urls_to_freeze.extend([url for url in result.output["urls"] if url.startswith(f"/{self.slug}/")])
+            for url in result.output["urls"]:
+                if url.startswith(f"/{self.slug}/"):
+                    record_url(url)
 
         return result.output
 
@@ -708,7 +710,7 @@ def validate_link(link, key):
 
             if isinstance(link, dict) and validate_link(link, "url") and validate_link(link, "title"):
                 if link["url"].startswith(f"/{self.slug}/"):
-                    absolute_urls_to_freeze.append(link["url"])
+                    record_url(link["url"])
                 to_return.append(link)
             else:
                 to_return.append(None)

naucse/utils/views.py

@@ -2,14 +2,12 @@
 import hashlib
 import json
 import os
-from collections import deque, defaultdict
+from collections import defaultdict
 from pathlib import Path
 
 from arca.exceptions import PullError, BuildError, RequirementsMismatch
 from arca.utils import get_hash_for_file
 
-absolute_urls_to_freeze = deque()
-
 
 def get_recent_runs(course):
     """Build a list of "recent" runs based on a course.

naucse/views.py

@@ -16,7 +16,7 @@
 from werkzeug.local import LocalProxy
 
 from naucse import models
-from naucse.freezer import temporary_url_for_logger
+from naucse.freezer import temporary_url_for_logger, record_url
 from naucse.models import allowed_elements_parser
 from naucse.templates import setup_jinja_env, vars_functions
 from naucse.urlconverters import register_url_converters
@@ -26,7 +26,7 @@
 from naucse.utils.models import arca
 from naucse.utils.views import get_recent_runs, list_months
 from naucse.utils.views import does_course_return_info
-from naucse.utils.views import absolute_urls_to_freeze, raise_errors_from_forks
+from naucse.utils.views import raise_errors_from_forks
 from naucse.utils.views import page_content_cache_key, get_edit_info
 from naucse.validation import DisallowedStyle, DisallowedElement, InvalidHTML
 
@@ -485,11 +485,10 @@ def content_creator():
     content_key = page_content_cache_key(Repo("."), lesson.slug, page.slug, solution, variables)
     cached = arca.region.get_or_create(content_key, content_creator)
 
-    # The urls are added twice to ``absolute_urls_to_freeze``
-    # when the content is created.
+    # The urls are recorded twice when the content is created.
     # But it doesn't matter, duplicate URLs are skipped.
-    absolute_urls = [urljoin(request.path, x) for x in cached["urls"]]
-    absolute_urls_to_freeze.extend(absolute_urls)
+    for x in cached["urls"]:
+        record_url(urljoin(request.path, x))
 
     return cached
 
@@ -537,13 +536,13 @@ def course_page(course, lesson, page, solution=None):
             if content is None:
                 # the offer was accepted
                 content = content_offer["content"]
-                absolute_urls_to_freeze.extend([urljoin(request.path, x)
-                                                for x in content_offer["urls"]])
+                for x in content_offer["urls"]:
+                    record_url(urljoin(request.path, x))
             else:
                 # the offer was rejected or the the fragment was not in cache
                 arca.region.set(content_key, {"content": content, "urls": data_from_fork["content_urls"]})
-                absolute_urls_to_freeze.extend([urljoin(request.path, x)
-                                                for x in data_from_fork["content_urls"]])
+                for x in data_from_fork["content_urls"]:
+                    record_url(urljoin(request.path, x))
 
             # compatibility
             page = process_page_data(data_from_fork.get("page"))