add reverse (#2110)

channels/routing.py

@@ -5,6 +5,7 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.urls.exceptions import Resolver404
 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
@@ -234,3 +235,24 @@ 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()