Rename "routes" modules to "views"

"Views" should be more familiar to people who have some experience
with web frameworks. It also better matches the intended scope
of the module.

Author: encukou

naucse/__init__.py

@@ -9,7 +9,7 @@
     raise RuntimeError('We love Python 3.')
 
 from naucse.cli import cli
-from naucse.routes import app, lesson_static_generator
+from naucse.views import app, lesson_static_generator
 
 
 def main():

naucse/cli.py

@@ -1,7 +1,7 @@
 import click
 import elsa
 
-from naucse.utils.routes import forks_enabled, does_course_return_info
+from naucse.utils.views import forks_enabled, does_course_return_info
 
 
 def cli(app, *, base_url=None, freezer=None):
@@ -27,7 +27,7 @@ def list_courses(forks_only):
         A practical benefit is that on Travis CI the docker images are pulled/built
         in this command and the freezing won't timeout after the 10 minute limit if things are taking particularly long.
         """
-        from naucse.routes import model
+        from naucse.views import model
 
         def canonical(course, suffix=""):
             click.echo(f"  {course.slug}: {course.title}{suffix}")

naucse/freezer.py

@@ -2,7 +2,7 @@
 
 from flask_frozen import UrlForLogger, Freezer
 
-from naucse.utils.routes import absolute_urls_to_freeze
+from naucse.utils.views import absolute_urls_to_freeze
 
 
 class AllLinksLogger(UrlForLogger):

naucse/models.py

@@ -10,10 +10,10 @@
 from arca import Task
 from git import Repo
 
-import naucse.utils.routes
+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.routes import AllowedElementsParser, absolute_urls_to_freeze
+from naucse.utils.views import AllowedElementsParser, absolute_urls_to_freeze
 from naucse.templates import setup_jinja_env, vars_functions
 from naucse.utils.markdown import convert_markdown
 from naucse.utils.notebook import convert_notebook
@@ -624,7 +624,7 @@ def base_course(self):
     def render(self, page_type, *args, **kwargs):
         """ Renders a page in the fork, checks the content and registers urls to freeze.
         """
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         task = Task(
             "naucse.utils.forks:render",
@@ -672,7 +672,7 @@ def get_footer_links(self, lesson_slug, page, **kwargs):
             with a warning. This method provides the correct footer links for the page, since ``sessions``
             is not included in the info provided by forks.
         """
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         task = Task(
             "naucse.utils.forks:get_footer_links",
@@ -684,7 +684,7 @@ def get_footer_links(self, lesson_slug, page, **kwargs):
 
         to_return = []
 
-        from naucse.routes import logger
+        from naucse.views import logger
         logger.debug(result.output)
 
         if not isinstance(result.output, dict):
@@ -744,7 +744,7 @@ def slug(self):
         """ Returns the slug of the repository based on the current branch. Returns the default if not on a branch,
             the branch doesn't have a remote or the remote url can't be parsed.
         """
-        from naucse.routes import logger
+        from naucse.views import logger
 
         # Travis CI checks out specific commit, so there isn't an active branch
         if os.environ.get("TRAVIS") and os.environ.get("TRAVIS_REPO_SLUG"):
@@ -785,7 +785,7 @@ def slug(self):
     def branch(self):
         """ Returns the active branch name or master if not on a branch.
         """
-        from naucse.routes import logger
+        from naucse.views import logger
 
         # Travis CI checks out specific commit, so there isn't an active branch
         if os.environ.get("TRAVIS") and os.environ.get("TRAVIS_BRANCH"):
@@ -844,8 +844,8 @@ def safe_run_years(self):
             for run in run_years.runs.values():
                 if not run.is_link():
                     safe_run_years.append(run)
-                elif (naucse.utils.routes.forks_enabled() and
-                      naucse.utils.routes.does_course_return_info(run, extra_required=["start_date", "end_date"])):
+                elif (naucse.utils.views.forks_enabled() and
+                      naucse.utils.views.does_course_return_info(run, extra_required=["start_date", "end_date"])):
                     safe_run_years.append(run)
 
             safe_years[year] = safe_run_years

naucse/utils/forks.py

@@ -5,9 +5,9 @@
 from flask_frozen import UrlForLogger
 from git import Repo
 
-from naucse import routes
+from naucse import views
 from naucse.models import Course
-from naucse.utils.routes import page_content_cache_key, get_edit_info
+from naucse.utils.views import page_content_cache_key, get_edit_info
 
 
 def get_course_from_slug(slug: str) -> Course:
@@ -16,9 +16,9 @@ def get_course_from_slug(slug: str) -> Course:
     parts = slug.split("/")
 
     if parts[0] == "course":
-        return routes.model.courses[parts[1]]
+        return views.model.courses[parts[1]]
     else:
-        return routes.model.runs[(int(parts[0]), parts[1])]
+        return views.model.runs[(int(parts[0]), parts[1])]
 
 
 def course_info(slug: str, *args, **kwargs) -> Dict[str, Any]:
@@ -71,35 +71,35 @@ def render(page_type: str, slug: str, *args, **kwargs) -> Dict[str, Any]:
     if kwargs.get("request_url"):
         path = [kwargs["request_url"]]
 
-    logger = UrlForLogger(routes.app)
-    with routes.app.test_request_context(*path):
+    logger = UrlForLogger(views.app)
+    with views.app.test_request_context(*path):
         with logger:
 
             info = {
                 "course": {
                     "title": course.title,
-                    "url": routes.course_url(course),
+                    "url": views.course_url(course),
                     "vars": course.vars,
                     "canonical": course.canonical,
                     "is_derived": course.is_derived,
                 },
             }
 
             if page_type == "course":
-                info["content"] = routes.course_content(course)
+                info["content"] = views.course_content(course)
                 info["edit_info"] = get_edit_info(course.edit_path)
 
             elif page_type == "calendar":
-                info["content"] = routes.course_calendar_content(course)
+                info["content"] = views.course_calendar_content(course)
                 info["edit_info"] = get_edit_info(course.edit_path)
 
             elif page_type == "calendar_ics":
-                info["calendar"] = str(routes.generate_calendar_ics(course))
+                info["calendar"] = str(views.generate_calendar_ics(course))
                 info["edit_info"] = get_edit_info(course.edit_path)
 
             elif page_type == "course_page":
                 lesson_slug, page, solution, *_ = args
-                lesson = routes.model.get_lesson(lesson_slug)
+                lesson = views.model.get_lesson(lesson_slug)
 
                 content_offer_key = kwargs.get("content_key")
 
@@ -119,13 +119,13 @@ def render(page_type: str, slug: str, *args, **kwargs) -> Dict[str, Any]:
                 if request_url is None:
                     request_url = url_for('course_page', course=course, lesson=lesson, page=page, solution=solution)
 
-                lesson_url, subpage_url, static_url = routes.relative_url_functions(request_url, course, lesson)
-                page, session, prv, nxt = routes.get_page(course, lesson, page)
+                lesson_url, subpage_url, static_url = views.relative_url_functions(request_url, course, lesson)
+                page, session, prv, nxt = views.get_page(course, lesson, page)
 
                 # if content isn't cached or the version was refused, let's render
                 # the content here (but just the content and not the whole page with headers, menus etc)
                 if content is not_processed:
-                    content = routes.page_content(lesson, page, solution, course,
+                    content = views.page_content(lesson, page, solution, course,
                                                   lesson_url=lesson_url, subpage_url=subpage_url, static_url=static_url,
                                                   without_cache=True)
 
@@ -155,7 +155,7 @@ def render(page_type: str, slug: str, *args, **kwargs) -> Dict[str, Any]:
                         "slug": session.slug,
                     }
 
-                prev_link, session_link, next_link = routes.get_footer_links(course, session, prv, nxt, lesson_url)
+                prev_link, session_link, next_link = views.get_footer_links(course, session, prv, nxt, lesson_url)
                 info["footer"] = {
                     "prev_link": prev_link,
                     "session_link": session_link,
@@ -172,7 +172,7 @@ def render(page_type: str, slug: str, *args, **kwargs) -> Dict[str, Any]:
                         "title": session.title,
                         "url": url_for("session_coverpage", course=course.slug, session=session.slug),
                     },
-                    "content": routes.session_coverpage_content(course, session, coverpage),
+                    "content": views.session_coverpage_content(course, session, coverpage),
                     "edit_info": get_edit_info(session.get_edit_path(course, coverpage)),
                 })
             else:
@@ -197,21 +197,21 @@ def get_footer_links(slug, lesson_slug, page, request_url=None):
         raise ValueError("Circular dependency.")
 
     try:
-        lesson = routes.model.get_lesson(lesson_slug)
+        lesson = views.model.get_lesson(lesson_slug)
     except LookupError:
         raise ValueError("Lesson not found")
 
     path = []
     if request_url is not None:
         path = [request_url]
 
-    with routes.app.test_request_context(*path):
+    with views.app.test_request_context(*path):
 
         def lesson_url(lesson, *args, **kwargs):
             return url_for("course_page", course=course, lesson=lesson, *args, **kwargs)
 
-        page, session, prv, nxt = routes.get_page(course, lesson, page)
-        prev_link, session_link, next_link = routes.get_footer_links(course, session, prv, nxt, lesson_url)
+        page, session, prv, nxt = views.get_page(course, lesson, page)
+        prev_link, session_link, next_link = views.get_footer_links(course, session, prv, nxt, lesson_url)
 
     return {
         "prev_link": prev_link,

naucse/utils/links.py

@@ -3,7 +3,7 @@
 from xml.dom import SyntaxErr
 
 from naucse.models import Page
-from naucse.utils.routes import DisallowedStyle
+from naucse.utils.views import DisallowedStyle
 
 
 class InvalidInfo(Exception):

naucse/utils/models.py

@@ -5,7 +5,7 @@
 from arca import Task, Arca
 from werkzeug.local import LocalProxy
 
-import naucse.utils.routes
+import naucse.utils.views
 
 _arca = None
 
@@ -112,7 +112,7 @@ def process_kwargs(self, instance):
         return x
 
     def compute(self, instance):
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         task = Task(**self.process_kwargs(instance))
 

naucse/utils/routes.py naucse/utils/views.pynaucse/utils/routes.py renamed to naucse/utils/views.py

@@ -65,7 +65,7 @@ def list_months(start_date, end_date):
 def get_naucse_tree_hash(repo):
     """ Returns the tree hash of the folder ``naucse``, which contains rendering mechanisms, in specified ``repo``.
     """
-    from naucse.routes import app
+    from naucse.views import app
     global _naucse_tree_hash
 
     if _naucse_tree_hash.get(repo.git_dir):
@@ -85,7 +85,7 @@ def get_naucse_tree_hash(repo):
 def get_lesson_tree_hash(repo, lesson_slug):
     """ Returns the tree hash of the folder containing the lesson in specified ``repo``.
     """
-    from naucse.routes import app
+    from naucse.views import app
 
     global _lesson_tree_hash
 
@@ -264,7 +264,7 @@ def does_course_return_info(course, extra_required=(), *, force_ignore=False):
 
     Raises exception if :func:`raise_errors_from_forks` returns it should. (But not if ``force_ignore`` is set.)
     """
-    from naucse.routes import logger
+    from naucse.views import logger
 
     required = ["title", "description"] + list(extra_required)
     try:
@@ -314,7 +314,7 @@ def page_content_cache_key(repo, lesson_slug, page, solution, course_vars=None)
 
 
 def edit_link(path):
-    from naucse.routes import model
+    from naucse.views import model
 
     if path == Path("."):
         return f"https://github.com/{model.meta.slug}"

naucse/routes.py naucse/views.pynaucse/routes.py renamed to naucse/views.py

@@ -24,12 +24,12 @@
 from naucse.utils.links import (process_course_data, process_session_data, process_page_data, process_footer_data,
                                 InvalidInfo)
 from naucse.utils.models import arca
-from naucse.utils.routes import (get_recent_runs, list_months, DisallowedStyle,
+from naucse.utils.views import (get_recent_runs, list_months, DisallowedStyle,
                                  DisallowedElement, does_course_return_info, absolute_urls_to_freeze,
                                  raise_errors_from_forks, page_content_cache_key, InvalidHTML, get_edit_info)
 
 # so it can be mocked
-import naucse.utils.routes
+import naucse.utils.views
 
 app = Flask('naucse')
 app.config['TEMPLATES_AUTO_RELOAD'] = True
@@ -168,7 +168,7 @@ def courses():
     for course in model.courses.values():
         if not course.is_link():
             safe_courses.append(course)
-        elif naucse.utils.routes.forks_enabled() and does_course_return_info(course):
+        elif naucse.utils.views.forks_enabled() and does_course_return_info(course):
             safe_courses.append(course)
 
     return render_template("course_list.html",
@@ -197,7 +197,7 @@ def lesson_static(course, lesson, path):
         lesson = None
 
     if course is not None and course.is_link():  # is static file from a link?
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         try:
             return send_from_directory(*course.lesson_static(lesson_slug, path))
@@ -276,7 +276,7 @@ def lesson_url(lesson, *args, **kwargs):
 @app.route('/<course:course>/')
 def course(course):
     if course.is_link():
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         try:
             data_from_fork = course.render_course(request_url=request.path)
@@ -489,7 +489,7 @@ def course_page(course, lesson, page, solution=None):
     prev_link = session_link = next_link = session = None
 
     if course.is_link():
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         fork_kwargs = {"request_url": request.path}
 
@@ -696,7 +696,7 @@ def session_coverpage(course, session, coverpage):
         rendered session coverpage
     """
     if course.is_link():
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         try:
             data_from_fork = course.render_session_coverpage(session, coverpage, request_url=request.path)
@@ -756,7 +756,7 @@ def course_calendar_content(course):
 @app.route('/<course:course>/calendar/')
 def course_calendar(course):
     if course.is_link():
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         try:
             data_from_fork = course.render_calendar(request_url=request.path)
@@ -828,7 +828,7 @@ def course_calendar_ics(course):
         abort(404)
 
     if course.is_link():
-        naucse.utils.routes.forks_raise_if_disabled()
+        naucse.utils.views.forks_raise_if_disabled()
 
         try:
             data_from_fork = course.render_calendar_ics(request_url=request.path)