feat: add auto-generated url names

Author: jerivas

demo/demo/views/colors/add.py

@@ -35,5 +35,5 @@ def view(request):
     form = ColorAddForm(request.POST or None)
     if request.method == "POST" and form.is_valid():
         color = form.save()
-        return redirect(f"/colors/{color.slug}")
+        return redirect("colors-slug", color.slug)
     return render_str(__doc__, request, {"form": form})

demo/demo/views/colors/index.py

@@ -3,11 +3,11 @@
 
 <ul>
     {% for color in colors %}
-        <li><a href="/colors/{{ color.slug }}">{{ color.name }}</a></li>
+        <li><a href="{% url 'colors-slug' color.slug %}">{{ color.name }}</a></li>
     {% endfor %}
 </ul>
 
-<p><a href="/colors/add">Add a new color</a></p>
+<p><a href="{% url 'colors-add' %}">Add a new color</a></p>
 """
 
 from demo.models import Color

demo/demo/views/index.py

@@ -3,8 +3,8 @@
 
 <p>Here are some links:</p>
 <ul>
-    <li><a href="/colors">Colors</a></li>
-    <li><a href="/current-time">Current Time</a></li>
+    <li><a href="{% url 'colors' %}">Colors</a></li>
+    <li><a href="{% url 'current-time' %}">Current Time</a></li>
 </ul>
 """
 

file_router/__init__.py

@@ -9,6 +9,17 @@
 
 __version__ = "0.1.0"
 
+DISALLOWED_CHARS = re.compile(
+    "|".join(
+        [
+            r"^-",  # Dash at the start
+            r"[<>]",  # Angle brackets (url param wrapper)
+            r"\w+\:",  # Letters followed by colon (path converters)
+        ]
+    )
+)
+TO_DASHES = re.compile("[/_]")  # Match slash and underscore
+
 
 def file_patterns(start_dir, append_slash=False):
     """
@@ -17,6 +28,10 @@ def file_patterns(start_dir, append_slash=False):
     patterns = []
     start_dir_re = re.compile(f"^{start_dir}")
     for root, dirs, files in os.walk(start_dir):
+        # Reverse the list so files that start with "<" go to the bottom and
+        # regular files come to the top. This ensures hard-coded url params
+        # always match before variable ones
+        files = tuple(reversed(files))
         for file in files:
             if not file.endswith(".py"):
                 continue
@@ -33,13 +48,14 @@ def file_patterns(start_dir, append_slash=False):
             url = "" if file == "index.py" else file.replace(".py", "")
             url = start_dir_re.sub("", f"{root}/{url}").strip("/")
             url = (url + "/") if append_slash else url
-            patterns.append(path(url, view_fn))
+            urlname = DISALLOWED_CHARS.sub("", TO_DASHES.sub("-", url))
+            patterns.append(path(url, view_fn, name=urlname))
     return patterns
 
 
 def render_str(source, request, context=None):
     """
-    Take
+    Take a string and respond with a fully rendered template
     """
     rendered = Template(source).render(RequestContext(request, context))
     return HttpResponse(rendered)