Support URLRouter with include

channels/routing.py

@@ -1,9 +1,11 @@
 import importlib
+import re
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.urls.exceptions import Resolver404
-from django.urls.resolvers import RegexPattern, RoutePattern, URLResolver
+from django.urls.resolvers import RegexPattern, RoutePattern, URLResolver, URLPattern
+from django.urls import reverse as django_reverse
 
 """
 All Routing instances inside this file are also valid ASGI applications - with
@@ -52,6 +54,70 @@ async def __call__(self, scope, receive, send):
             )
 
 
+def _parse_resolver(child_url_pattern, parent_resolver, parent_regex, routes):
+    """Parse resolver (returned by `include`) recurrsively
+
+    Parameters
+    ----------
+    child_url_pattern : URLResolver |
+        The child url pattern
+    parent_resolver : URLResolver
+        The parent resolver
+    parent_regex : Pattern
+        The parent regex pattern
+    routes : list[URLPattern]
+        The URLPattern's list that stores the routes
+
+    Returns
+    -------
+    list[URLPattern]
+        The URLPattern's list that stores the routes
+    """
+    if isinstance(child_url_pattern, URLResolver):
+        # parse the urls resolved by django's `include` function
+        for url_pattern in child_url_pattern.url_patterns:
+            # call _parse_resolver recurrsively to parse nested URLResolver
+            routes.extend(
+                _parse_resolver(
+                    url_pattern,
+                    child_url_pattern,
+                    parent_resolver.pattern.regex,
+                    routes,
+                )
+            )
+    else:
+        # concatenate parent's url (route) and child's url (url_pattern)
+        regex = "".join(
+            x.pattern
+            for x in [
+                parent_regex,
+                parent_resolver.pattern.regex,
+                child_url_pattern.pattern.regex,
+            ]
+        )
+
+        # Remove the redundant caret ^ which is appended by `path` function
+        regex = re.sub(r"(?<!^)\^", "", regex)
+
+        name = (
+            f"{parent_resolver.app_name}:{child_url_pattern.name}"
+            if child_url_pattern.name
+            else None
+        )
+        pattern = RegexPattern(regex, name=name, is_endpoint=True)
+
+        routes.append(
+            URLPattern(
+                pattern,
+                child_url_pattern.callback,
+                child_url_pattern.default_args,
+                name,
+            )
+        )
+
+    return routes
+
+
 class URLRouter:
     """
     Routes to different applications/consumers based on the URL path.
@@ -67,7 +133,17 @@ class URLRouter:
     _path_routing = True
 
     def __init__(self, routes):
-        self.routes = routes
+        new_routes = []
+        for route in routes:
+            if not route.callback and isinstance(route, URLResolver):
+                # parse the urls resolved by django's `include` function
+                for url_pattern in route.url_patterns:
+                    new_routes.extend(
+                        _parse_resolver(url_pattern, route, re.compile(r""), [])
+                    )
+            else:
+                new_routes.append(route)
+        self.routes = new_routes
 
         for route in self.routes:
             # The inner ASGI app wants to do additional routing, route
@@ -158,3 +234,25 @@ async def __call__(self, scope, receive, send):
             raise ValueError(
                 "No application configured for channel name %r" % scope["channel"]
             )
+
+
+def reverse(*args, urlconf=None, **kwargs):
+    """reverse wrapper for django's reverse function
+
+    Parameters
+    ----------
+    urlconf : str, optional
+        The root path of the routings, by default None
+
+    See the django's
+    [reverse](https://docs.djangoproject.com/en/5.0/ref/urlresolvers/#reverse)
+    for more details of the other arguments
+
+    Returns
+    -------
+    str
+        The reversed url
+    """
+    if urlconf is None:
+        urlconf = settings.ROOT_WEBSOCKET_URLCONF
+    return django_reverse(*args, urlconf=urlconf, **kwargs)

tests/conftest.py

@@ -1,4 +1,5 @@
 import pytest
+import sys
 from django.conf import settings
 
 
@@ -38,3 +39,20 @@ def samesite(request, settings):
 def samesite_invalid(settings):
     """Set samesite flag to strict."""
     settings.SESSION_COOKIE_SAMESITE = "Hello"
+
+
+@pytest.fixture
+def root_urlconf(settings):
+    """Set ROOT_WEBSOCKET_URLCONF."""
+    settings.ROOT_WEBSOCKET_URLCONF = "__src.routings"
+    return settings.ROOT_WEBSOCKET_URLCONF
+
+
+@pytest.fixture(autouse=True)
+def mock_modules():
+    """Save original modules for each test and clear a cache"""
+    original_modules = sys.modules.copy()
+    yield
+    sys.modules = original_modules
+    from django.urls.base import _get_cached_resolver
+    _get_cached_resolver.cache_clear()