make it easier to override the default templates (#636)

Author: jowilf

starlette_admin/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.15.0rc4"
+__version__ = "0.15.0rc7"
 
 from ._types import ExportType as ExportType
 from ._types import RequestAction as RequestAction

starlette_admin/base.py

@@ -2,7 +2,13 @@
 from json import JSONDecodeError
 from typing import Any, Awaitable, Callable, Dict, List, Optional, Sequence, Type, Union
 
-from jinja2 import ChoiceLoader, Environment, FileSystemLoader, PackageLoader
+from jinja2 import (
+    ChoiceLoader,
+    Environment,
+    FileSystemLoader,
+    PackageLoader,
+    PrefixLoader,
+)
 from starlette.applications import Starlette
 from starlette.datastructures import FormData
 from starlette.exceptions import HTTPException
@@ -195,6 +201,13 @@ def _setup_templates(self) -> None:
                 [
                     FileSystemLoader(self.templates_dir),
                     PackageLoader("starlette_admin", "templates"),
+                    PrefixLoader(
+                        {
+                            "@starlette-admin": PackageLoader(
+                                "starlette_admin", "templates"
+                            ),
+                        }
+                    ),
                 ]
             ),
             extensions=["jinja2.ext.i18n"],

tests/templates/report.html tests/templates/auth/report.html

@@ -0,0 +1,4 @@
+{% extends "@starlette-admin/base.html" %}
+{% block head_meta %}
+<meta name="custom-meta" content="Custom metadata" />
+{% endblock %}

tests/templates/basic/base.html

@@ -0,0 +1,2 @@
+{% extends "layout.html" %}
+{% block content %}This is custom view to display some data.{% endblock %}

tests/templates/custom_index.html tests/templates/basic/custom_index.html

@@ -0,0 +1,2 @@
+{% extends "layout.html" %}
+{% block content %}This is custom view to display some data.{% endblock %}

tests/templates/multiple-admin/report.html

@@ -31,7 +31,7 @@ def test_custom_index_view(self):
             index_view=CustomView(
                 "Home", path="/home", template_path="custom_index.html"
             ),
-            templates_dir="tests/templates",
+            templates_dir="tests/templates/basic",
         )
         admin.mount_to(app)
         assert len(admin._views) == 1
@@ -64,3 +64,15 @@ def test_admin_customisation(self):
         assert response.status_code == 200
         assert response.text.count("<title>DashBoard</title>") == 1
         assert response.text.count("https://test.com/logo.png") == 1
+
+    def test_template_override(self):
+        app = Starlette()
+        admin = BaseAdmin(templates_dir="tests/templates/basic")
+        admin.mount_to(app)
+        client = TestClient(app)
+        response = client.get("/admin")
+        assert response.status_code == 200
+        assert (
+            response.text.count('<meta name="custom-meta" content="Custom metadata" />')
+            == 1
+        )

tests/templates/views/report.html

@@ -204,7 +204,7 @@ def setup_method(self, method):
     @pytest.fixture
     def client(self, report_view):
         admin = BaseAdmin(
-            auth_provider=MyAuthProvider(), templates_dir="tests/templates"
+            auth_provider=MyAuthProvider(), templates_dir="tests/templates/auth"
         )
         app = Starlette()
         admin.add_view(report_view)

tests/test_admin_basic.py

@@ -54,7 +54,7 @@ def test_multiple_admin(report_view):
         "Admin1",
         base_url="/admin1",
         route_name="admin1",
-        templates_dir="tests/templates",
+        templates_dir="tests/templates/multiple-admin",
     )
     admin1.add_view(report_view)
     admin1.add_view(PostView)

tests/test_auth.py

@@ -116,7 +116,7 @@ def setup_method(self, method):
         PostView.seq = len(PostView.db.keys()) + 1
 
     def test_add_custom_view(self, report_view):
-        admin = BaseAdmin(templates_dir="tests/templates")
+        admin = BaseAdmin(templates_dir="tests/templates/views")
         app = Starlette()
         admin.add_view(report_view)
         admin.mount_to(app)