")
+
+ with temptemplate("temp_test.html") as temp_template_path:
+ temp_template_path.write_text("temp test")
+ (temp_template_path.parent / "temp_test_2.html").write_text("temp test 2")
+ NEW_TEMPLATES = settings.TEMPLATES.copy()
+ NEW_TEMPLATES[0]["DIRS"] = (temp_template_path.parent,)
+ with self.settings(TEMPLATES=NEW_TEMPLATES):
+ t1 = Template.objects.create(name="temp_test.html")
+ t1.populate()
+ self.assertEqual(t1.content, "temp test")
+ t2 = Template.objects.create(name="temp_test.html")
+ t2.populate(name="temp_test_2.html")
+ self.assertEqual(t2.content, "temp test 2")
+ t3 = Template.objects.create(name="temp_test_3.html")
+ self.assertIsNone(t3.populate(name="temp_test_doesnt_exist.html"))
+ self.assertEqual(t3.content, "")
+
+ @override_settings(DBTEMPLATES_ADD_DEFAULT_SITE=False)
+ def test_empty_sites(self):
+ self.t3 = Template.objects.create(name="footer.html", content="footer")
+ self.assertQuerySetEqual(self.t3.sites.all(), self.t3.sites.none())
+
+ def test_error_templates_creation(self):
+ call_command("create_error_templates", force=True, verbosity=0)
+ self.assertQuerySetEqual(
+ Template.objects.filter(sites=self.site1), Template.objects.filter()
+ )
+ self.assertTrue(Template.objects.filter(name="404.html").exists())
+
+ def test_automatic_sync(self):
+ admin_base_template = get_template_source("admin/base.html")
+ template = Template.objects.create(name="admin/base.html")
+ self.assertEqual(admin_base_template, template.content)
+
+ def test_get_cache(self):
+ self.assertTrue(isinstance(get_cache_backend(), BaseCache))
+
+ def test_check_template_syntax(self):
+ bad_template, _ = Template.objects.get_or_create(
+ name="bad.html", content="{% if foo %}Bar"
+ )
+ good_template, _ = Template.objects.get_or_create(
+ name="good.html", content="{% if foo %}Bar{% endif %}"
+ )
+ self.assertFalse(check_template_syntax(bad_template)[0])
+ self.assertTrue(check_template_syntax(good_template)[0])
+
+ def test_get_cache_name(self):
+ self.assertEqual(
+ get_cache_key("name with spaces"), "dbtemplates::name-with-spaces::1"
+ )
+
+
+class DbTemplatesSyncTemplatesCommandTestCase(TestCase):
+ def test_sync_templates(self):
+ with temptemplate("temp_test.html") as temp_template_path:
+ temp_template_path.write_text("temp test", encoding="utf-8")
+ NEW_TEMPLATES = settings.TEMPLATES.copy()
+ NEW_TEMPLATES[0]["DIRS"] = sync_templates.DIRS = (
+ temp_template_path.parent,
+ )
+ with self.settings(TEMPLATES=NEW_TEMPLATES):
+ self.assertFalse(
+ Template.objects.filter(name="temp_test.html").exists()
+ )
+ call_command(
+ "sync_templates",
+ force=True,
+ verbosity=0,
+ overwrite=sync_templates.FILES_TO_DATABASE,
+ )
+ self.assertTrue(Template.objects.filter(name="temp_test.html").exists())
+
+ t = Template.objects.get(name="temp_test.html")
+ t.content = "temp test modified"
+ t.save()
+ call_command(
+ "sync_templates",
+ force=True,
+ verbosity=0,
+ overwrite=sync_templates.DATABASE_TO_FILES,
+ )
+ self.assertEqual(
+ "temp test modified", temp_template_path.read_text(encoding="utf-8")
+ )
+
+ call_command(
+ "sync_templates",
+ ext=".html",
+ app_first=True,
+ force=True,
+ verbosity=0,
+ delete=True,
+ overwrite=sync_templates.DATABASE_TO_FILES,
+ )
+ self.assertTrue(temp_template_path.exists())
+ self.assertFalse(
+ Template.objects.filter(name="temp_test.html").exists()
+ )
diff --git a/dbtemplates/test_settings.py b/dbtemplates/test_settings.py
index 198fdde..d39673d 100644
--- a/dbtemplates/test_settings.py
+++ b/dbtemplates/test_settings.py
@@ -1,51 +1,55 @@
-DBTEMPLATES_CACHE_BACKEND = 'dummy://'
-
-DATABASE_ENGINE = 'sqlite3'
+DATABASE_ENGINE = "sqlite3"
# SQLite does not support removing unique constraints (see #28)
SOUTH_TESTS_MIGRATE = False
SITE_ID = 1
-SECRET_KEY = 'something-something'
+SECRET_KEY = "something-something"
+
+CACHES = {
+ "default": {
+ "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+ },
+}
DATABASES = {
- 'default': {
- 'ENGINE': 'django.db.backends.sqlite3',
- 'NAME': ':memory:',
+ "default": {
+ "ENGINE": "django.db.backends.sqlite3",
+ "NAME": ":memory:",
}
}
INSTALLED_APPS = [
- 'django.contrib.contenttypes',
- 'django.contrib.sites',
- 'django.contrib.sessions',
- 'django.contrib.messages',
- 'django.contrib.admin',
- 'django.contrib.auth',
- 'dbtemplates',
+ "django.contrib.contenttypes",
+ "django.contrib.sites",
+ "django.contrib.sessions",
+ "django.contrib.messages",
+ "django.contrib.admin",
+ "django.contrib.auth",
+ "dbtemplates",
]
MIDDLEWARE = (
- 'django.contrib.sessions.middleware.SessionMiddleware',
- 'django.contrib.messages.middleware.MessageMiddleware',
- 'django.contrib.auth.middleware.AuthenticationMiddleware',
+ "django.contrib.sessions.middleware.SessionMiddleware",
+ "django.contrib.messages.middleware.MessageMiddleware",
+ "django.contrib.auth.middleware.AuthenticationMiddleware",
)
TEMPLATE_LOADERS = (
- 'django.template.loaders.filesystem.Loader',
- 'django.template.loaders.app_directories.Loader',
- 'dbtemplates.loader.Loader',
+ "django.template.loaders.filesystem.Loader",
+ "django.template.loaders.app_directories.Loader",
+ "dbtemplates.loader.Loader",
)
TEMPLATES = [
{
- 'BACKEND': 'django.template.backends.django.DjangoTemplates',
- 'OPTIONS': {
- 'loaders': TEMPLATE_LOADERS,
- 'context_processors': [
- 'django.contrib.auth.context_processors.auth',
- 'django.contrib.messages.context_processors.messages',
- ]
- }
+ "BACKEND": "django.template.backends.django.DjangoTemplates",
+ "OPTIONS": {
+ "loaders": TEMPLATE_LOADERS,
+ "context_processors": [
+ "django.contrib.auth.context_processors.auth",
+ "django.contrib.messages.context_processors.messages",
+ ],
+ },
},
]
diff --git a/dbtemplates/utils/cache.py b/dbtemplates/utils/cache.py
index 89039ab..96076b9 100644
--- a/dbtemplates/utils/cache.py
+++ b/dbtemplates/utils/cache.py
@@ -9,6 +9,7 @@ def get_cache_backend():
Compatibilty wrapper for getting Django's cache backend instance
"""
from django.core.cache import caches
+
cache = caches.create_connection(settings.DBTEMPLATES_CACHE_BACKEND)
# Some caches -- python-memcached in particular -- need to do a cleanup at
@@ -21,14 +22,13 @@ def get_cache_backend():
cache = get_cache_backend()
-def get_cache_key(name, site=None):
- if site is None:
- site = Site.objects.get_current()
- return f"dbtemplates::{slugify(name)}::{site.pk}"
+def get_cache_key(name, current_site=None):
+ current_site = current_site or Site.objects.get_current()
+ return f"dbtemplates::{slugify(name)}::{current_site.pk}"
-def get_cache_notfound_key(name):
- return get_cache_key(name) + "::notfound"
+def get_cache_notfound_key(name, current_site=None):
+ return get_cache_key(name, current_site=current_site) + "::notfound"
def remove_notfound_key(instance):
@@ -59,4 +59,4 @@ def remove_cached_template(instance, **kwargs):
in the database was changed or deleted.
"""
for site in instance.sites.all():
- cache.delete(get_cache_key(instance.name, site=site))
+ cache.delete(get_cache_key(instance.name, current_site=site))
diff --git a/dbtemplates/utils/template.py b/dbtemplates/utils/template.py
index 662b4f6..e8d3be4 100644
--- a/dbtemplates/utils/template.py
+++ b/dbtemplates/utils/template.py
@@ -1,9 +1,9 @@
-from django.template import (Template, TemplateDoesNotExist,
- TemplateSyntaxError)
+from django.template import Template, TemplateDoesNotExist, TemplateSyntaxError
def get_loaders():
from django.template.loader import _engine_list
+
loaders = []
for engine in _engine_list():
loaders.extend(engine.engine.template_loaders)
@@ -12,17 +12,21 @@ def get_loaders():
def get_template_source(name):
source = None
+ not_found = []
for loader in get_loaders():
- if loader.__module__.startswith('dbtemplates.'):
+ if loader.__module__.startswith("dbtemplates."):
# Don't give a damn about dbtemplates' own loader.
continue
for origin in loader.get_template_sources(name):
try:
source = loader.get_contents(origin)
- except (NotImplementedError, TemplateDoesNotExist):
+ except (NotImplementedError, TemplateDoesNotExist) as exc:
+ if exc.args[0] not in not_found:
+ not_found.append(exc.args[0])
continue
- if source:
+ else:
return source
+ raise TemplateDoesNotExist(name, chain=not_found)
def check_template_syntax(template):
diff --git a/docs/conf.py b/docs/conf.py
index 2055241..6b2422f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,29 +15,29 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath("."))
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage"]
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
# The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = ".txt"
# The encoding of source files.
-#source_encoding = 'utf-8'
+# source_encoding = 'utf-8'
# The master toctree document.
-master_doc = 'index'
+master_doc = "index"
# General information about the project.
-project = 'django-dbtemplates'
-copyright = '2007-2019, Jannis Leidel and contributors'
+project = "django-dbtemplates"
+copyright = "2007-2019, Jannis Leidel and contributors"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -46,61 +46,62 @@
# The short X.Y version.
try:
from dbtemplates import __version__
+
# The short X.Y version.
- version = '.'.join(__version__.split('.')[:2])
+ version = ".".join(__version__.split(".")[:2])
# The full version, including alpha/beta/rc tags.
release = __version__
except ImportError:
- version = release = 'dev'
+ version = release = "dev"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = None
+# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
-#today = ''
+# today = ''
# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
-exclude_trees = ['_build']
+exclude_trees = ["_build"]
# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+html_theme = "default"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = ['_theme']
@@ -114,12 +115,12 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-#html_logo = None
+# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
-#html_favicon = None
+# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -128,71 +129,76 @@
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
# If false, no module index is generated.
-#html_use_modindex = True
+# html_use_modindex = True
# If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
# If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# html_file_suffix = ''
# Output file base name for HTML help builder.
-htmlhelp_basename = 'django-dbtemplatesdoc'
+htmlhelp_basename = "django-dbtemplatesdoc"
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'django-dbtemplates.tex', 'django-dbtemplates Documentation',
- 'Jannis Leidel and contributors', 'manual'),
+ (
+ "index",
+ "django-dbtemplates.tex",
+ "django-dbtemplates Documentation",
+ "Jannis Leidel and contributors",
+ "manual",
+ ),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
-#latex_logo = None
+# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
# Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
# If false, no module index is generated.
-#latex_use_modindex = True
+# latex_use_modindex = True