make websocket and web module paths consts

Author: rmorshea

README.md

@@ -56,7 +56,7 @@ your_app/
 To start, we'll need to use [`channels`](https://channels.readthedocs.io/en/stable/) to
 create a `ProtocolTypeRouter` that will become the top of our ASGI application stack.
 Under the `"websocket"` protocol, we'll then add a path for IDOM's websocket consumer
-using `idom_websocket_path`. If you wish to change the route where this
+using `IDOM_WEB_MODULES_PATH`. If you wish to change the route where this
 websocket is served from, see the available [settings](#settings.py).
 
 ```python
@@ -65,7 +65,7 @@ import os
 
 from django.core.asgi import get_asgi_application
 
-from django_idom import idom_websocket_path
+from django_idom import IDOM_WEB_MODULES_PATH
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_app.settings")
 
@@ -79,7 +79,7 @@ application = ProtocolTypeRouter(
         "http": http_asgi_app,
         "websocket": URLRouter(
           # add a path for IDOM's websocket
-          [idom_websocket_path()]
+          [IDOM_WEB_MODULES_PATH]
         ),
     }
 )
@@ -119,15 +119,15 @@ CACHES = {
 
 ## `urls.py`
 
-You'll need to include IDOM's static web modules path using `idom_web_modules_path`.
-Similarly to the `idom_websocket_path()`. If you wish to change the route where this
+You'll need to include IDOM's static web modules path using `IDOM_WEB_MODULES_PATH`.
+Similarly to the `IDOM_WEBSOCKET_PATH`. If you wish to change the route where this
 websocket is served from, see the available [settings](#settings.py).
 
 ```python
-from django_idom import idom_web_modules_path
+from django_idom import IDOM_WEB_MODULES_PATH
 
 urlpatterns = [
-    idom_web_modules_path(),
+    IDOM_WEB_MODULES_PATH,
     ...
 ]
 ```

src/django_idom/__init__.py

@@ -1,5 +1,5 @@
-from .paths import idom_web_modules_path, idom_websocket_path
+from .paths import IDOM_WEB_MODULES_PATH, IDOM_WEBSOCKET_PATH
 
 
 __version__ = "0.0.1"
-__all__ = ["idom_websocket_path", "idom_web_modules_path"]
+__all__ = ["IDOM_WEB_MODULES_PATH", "IDOM_WEBSOCKET_PATH"]

src/django_idom/config.py

@@ -1,8 +1,8 @@
 from typing import Dict
 
 from django.conf import settings
-from idom.core.proto import ComponentConstructor
 from django.core.cache import DEFAULT_CACHE_ALIAS
+from idom.core.proto import ComponentConstructor
 
 
 IDOM_REGISTERED_COMPONENTS: Dict[str, ComponentConstructor] = {}

src/django_idom/paths.py

@@ -5,31 +5,23 @@
 from .websocket_consumer import IdomAsyncWebSocketConsumer
 
 
-def idom_websocket_path(*args, **kwargs):
-    """Return a URL resolver for :class:`IdomAsyncWebSocketConsumer`
+IDOM_WEBSOCKET_PATH = path(
+    IDOM_WEBSOCKET_URL + "<view_id>/", IdomAsyncWebSocketConsumer.as_asgi()
+)
+"""A URL resolver for :class:`IdomAsyncWebSocketConsumer`
 
-    While this is relatively uncommon in most Django apps, because the URL of the
-    websocket must be defined by the setting ``IDOM_WEBSOCKET_URL``. There's no need
-    to allow users to configure the URL themselves.
-    """
-    return path(
-        IDOM_WEBSOCKET_URL + "<view_id>/",
-        IdomAsyncWebSocketConsumer.as_asgi(),
-        *args,
-        **kwargs,
-    )
+While this is relatively uncommon in most Django apps, because the URL of the
+websocket must be defined by the setting ``IDOM_WEBSOCKET_URL``. There's no need
+to allow users to configure the URL themselves.
+"""
 
 
-def idom_web_modules_path(*args, **kwargs):
-    """Return a URL resolver for static web modules required by IDOM
+IDOM_WEB_MODULES_PATH = path(
+    IDOM_WEB_MODULES_URL + "<path:file>", views.web_modules_file
+)
+"""A URL resolver for static web modules required by IDOM
 
-    While this is relatively uncommon in most Django apps, because the URL of the
-    websocket must be defined by the setting ``IDOM_WEBSOCKET_URL``. There's no need
-    to allow users to configure the URL themselves.
-    """
-    return path(
-        IDOM_WEB_MODULES_URL + "<path:file>",
-        views.web_modules_file,
-        *args,
-        **kwargs,
-    )
+While this is relatively uncommon in most Django apps, because the URL of the
+websocket must be defined by the setting ``IDOM_WEBSOCKET_URL``. There's no need
+to allow users to configure the URL themselves.
+"""

src/django_idom/views.py

@@ -1,10 +1,10 @@
-import os
 import asyncio
 import functools
+import os
 
+from django.core.cache import caches
 from django.http import HttpRequest, HttpResponse
 from idom.config import IDOM_WED_MODULES_DIR
-from django.core.cache import caches
 
 from .config import IDOM_WEB_MODULE_CACHE, IDOM_WEB_MODULE_LRU_CACHE_SIZE
 

tests/test_app/asgi.py

@@ -11,7 +11,7 @@
 
 from django.core.asgi import get_asgi_application
 
-from django_idom import idom_websocket_path
+from django_idom import IDOM_WEBSOCKET_PATH
 
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_app.settings")
@@ -25,6 +25,6 @@
 application = ProtocolTypeRouter(
     {
         "http": http_asgi_app,
-        "websocket": URLRouter([idom_websocket_path()]),
+        "websocket": URLRouter([IDOM_WEBSOCKET_PATH]),
     }
 )

tests/test_app/urls.py

@@ -19,12 +19,9 @@
 """
 from django.urls import path
 
-from django_idom import idom_web_modules_path
+from django_idom import IDOM_WEB_MODULES_PATH
 
 from .views import base_template
 
 
-urlpatterns = [
-    path("", base_template),
-    idom_web_modules_path(),
-]
+urlpatterns = [path("", base_template), IDOM_WEB_MODULES_PATH]