feat(templatetags): custom svg tag to replace django-inline-svg

Author: aarushtools

docs/source/reference_index/apps/templatetags.rst

@@ -16,4 +16,5 @@ templatetags
    paginate
    status_helper
    strings
+   svg
    tests

intranet/apps/templatetags/svg.py

@@ -0,0 +1,55 @@
+import logging
+import os
+
+from django import template
+from django.contrib.staticfiles import finders
+from django.core.exceptions import ImproperlyConfigured
+from django.utils.safestring import mark_safe
+
+from intranet import settings
+
+logger = logging.getLogger(__name__)
+register = template.Library()
+
+# An updated version of django-inline-svg that works with django 5+
+
+
+class SVGNotFound(FileNotFoundError):
+    pass
+
+
+@register.simple_tag
+def svg(filename):
+    SVG_DIRS = getattr(settings, "SVG_DIRS", [])
+
+    if not isinstance(SVG_DIRS, list):
+        raise ImproperlyConfigured("SVG_DIRS setting must be a list")
+
+    path = None
+
+    if SVG_DIRS:
+        for directory in SVG_DIRS:
+            svg_path = os.path.join(directory, "%s.svg" % filename)
+            if os.path.isfile(svg_path):
+                path = svg_path
+    else:
+        path = finders.find(os.path.join("svg", "%s.svg" % filename))
+
+    if not path:
+        message = "SVG '%s.svg' not found" % filename
+
+        # Raise exception if DEBUG is True, else just log a warning.
+        if settings.DEBUG:
+            raise SVGNotFound(message)
+        else:
+            logger.warning(message)
+            return ""
+
+    # Sometimes path can be a list/tuple if there's more than one file found
+    if isinstance(path, list | tuple):
+        path = path[0]
+
+    with open(path) as svg_file:
+        svg = mark_safe(svg_file.read())
+
+    return svg

intranet/settings/__init__.py

@@ -697,7 +697,6 @@ def get_month_seconds():
     "oauth2_provider",  # django-oauth-toolkit
     "corsheaders",  # django-cors-headers
     "cacheops",  # django-cacheops
-    "svg",  # django-inline-svg
     "simple_history",  # django-simple-history
     "django_referrer_policy",
     "django_user_agents",

requirements.txt

@@ -11,7 +11,6 @@ django-cors-headers==4.7.0
 django-debug-toolbar==5.2.0
 django-extensions==4.1
 django-formtools==2.5.1
-django-inline-svg==0.1.1
 django-maintenance-mode==0.22.0
 django-oauth-toolkit==3.0.1
 django-pipeline==4.0.0