Avoid duplicating templates when more than one template engine is set up

Author: maribedran

pattern_library/utils.py

@@ -1,6 +1,7 @@
 import operator
 import os
 import re
+from pathlib import Path
 
 from django.conf import settings
 from django.template import TemplateDoesNotExist
@@ -75,9 +76,11 @@ def get_template_dirs():
     template_dirs = [
         d for engines in settings.TEMPLATES for d in engines.get("DIRS", [])
     ]
+    template_dirs_paths = [Path(d).absolute() for d in template_dirs]
     template_app_dirs = get_app_template_dirs("templates")
-    template_dirs += template_app_dirs
-    return template_dirs
+    # Use set to avoid duplicates in case more than one engine is used and
+    # both find the same dirs
+    return list(set(template_dirs_paths).union(set(template_app_dirs)))
 
 
 def get_pattern_config_str(template_name):

tests/tests/test_utils.py

@@ -65,13 +65,13 @@ def get_relative_template_dirs(self):
         ]
     )
     def test_get_template_dirs_app_dirs(self):
-        self.assertListEqual(
-            self.get_relative_template_dirs(),
-            [
+        self.assertEqual(
+            set(self.get_relative_template_dirs()),
+            {
                 "django/contrib/auth",
                 "dpl/pattern_library",
                 "dpl/tests",
-            ],
+            },
         )
 
     @override_settings(
@@ -90,15 +90,40 @@ def test_get_template_dirs_app_dirs(self):
         ]
     )
     def test_get_template_dirs_list_dirs(self):
-        self.assertListEqual(
-            self.get_relative_template_dirs(),
-            [
+        self.assertEqual(
+            set(self.get_relative_template_dirs()),
+            {
                 "dpl/tests/test_one",
                 "dpl/tests/test_two",
                 "django/contrib/auth",
                 "dpl/pattern_library",
                 "dpl/tests",
-            ],
+            },
+        )
+
+    @override_settings(
+        TEMPLATES=[
+            {
+                "BACKEND": "django.template.backends.django.DjangoTemplates",
+                "APP_DIRS": True,
+                "DIRS": [os.path.join(settings.BASE_DIR, "test_one", "templates")],
+            },
+            {
+                "BACKEND": "django.template.backends.jinja2.Jinja2",
+                "APP_DIRS": True,
+                "DIRS": [os.path.join(settings.BASE_DIR, "test_one", "templates")],
+            },
+        ]
+    )
+    def test_get_template_dirs_with_two_engines(self):
+        self.assertEqual(
+            set(self.get_relative_template_dirs()),
+            {
+                "dpl/tests/test_one",
+                "django/contrib/auth",
+                "dpl/pattern_library",
+                "dpl/tests",
+            },
         )