mirror of
https://github.com/jazzband/django-dbtemplates.git
synced 2026-03-17 06:30:29 +00:00
Compare commits
No commits in common. "master" and "1.2.1" have entirely different histories.
52 changed files with 766 additions and 1200 deletions
|
|
@ -1,6 +0,0 @@
|
|||
[run]
|
||||
source = dbtemplates
|
||||
branch = 1
|
||||
|
||||
[report]
|
||||
omit = *tests*,*/migrations/*,test_*
|
||||
40
.github/workflows/release.yml
vendored
40
.github/workflows/release.yml
vendored
|
|
@ -1,40 +0,0 @@
|
|||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
if: github.repository == 'jazzband/django-dbtemplates'
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: "3.10"
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install -U pip
|
||||
python -m pip install -U setuptools twine wheel
|
||||
|
||||
- name: Build package
|
||||
run: |
|
||||
python setup.py --version
|
||||
python setup.py sdist --format=gztar bdist_wheel
|
||||
twine check dist/*
|
||||
|
||||
- name: Upload packages to Jazzband
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
user: jazzband
|
||||
password: ${{ secrets.JAZZBAND_RELEASE_KEY }}
|
||||
repository_url: https://jazzband.co/projects/django-dbtemplates/upload
|
||||
48
.github/workflows/test.yml
vendored
48
.github/workflows/test.yml
vendored
|
|
@ -1,48 +0,0 @@
|
|||
name: Test
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
max-parallel: 5
|
||||
matrix:
|
||||
python-version: ['3.8', '3.9', '3.10', '3.11', '3.13']
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Get pip cache dir
|
||||
id: pip-cache
|
||||
run: |
|
||||
echo "::set-output name=dir::$(pip cache dir)"
|
||||
|
||||
- name: Cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: ${{ steps.pip-cache.outputs.dir }}
|
||||
key:
|
||||
${{ matrix.python-version }}-v1-${{ hashFiles('**/setup.py') }}-${{ hashFiles('**/tox.ini') }}
|
||||
restore-keys: |
|
||||
${{ matrix.python-version }}-v1-
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install --upgrade tox tox-gh-actions
|
||||
|
||||
- name: Tox tests
|
||||
run: |
|
||||
tox -v
|
||||
|
||||
- name: Upload coverage
|
||||
uses: codecov/codecov-action@v2
|
||||
with:
|
||||
name: Python ${{ matrix.python-version }}
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
|
|
@ -1,14 +1,13 @@
|
|||
.*
|
||||
!.gitignore
|
||||
!.coveragerc
|
||||
*.pyc
|
||||
.*.swp
|
||||
MANIFEST
|
||||
build
|
||||
dist
|
||||
*.egg-info
|
||||
example/example.db
|
||||
docs/_build
|
||||
.tox/
|
||||
*.egg/
|
||||
.coverage
|
||||
pep8.txt
|
||||
coverage.xml
|
||||
.coverage
|
||||
9
.hgignore
Normal file
9
.hgignore
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
syntax: glob
|
||||
*.pyc
|
||||
.*.swp
|
||||
MANIFEST
|
||||
build
|
||||
dist
|
||||
django_dbtemplates.egg-info/
|
||||
example/example.db
|
||||
docs/_build
|
||||
24
.hgtags
Normal file
24
.hgtags
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
bd537cd8beba30f1a26328e02126d3d1b14ebf8f 0.2.5
|
||||
1b426859f05b8a003411964883ed5d42ec6c1b01 0.3.0
|
||||
97da228cc698bfae05f60a68ec978030722b0777 0.3.1
|
||||
50c69325d3758d2e82541b13be2794ebbe9ee449 0.4.0
|
||||
d35a41ea96d3604a3c2654590c5c76b8865c4251 0.4.1
|
||||
a4bd56a7c2ea4c6f16a726e47bb185101934fe08 0.4.2
|
||||
447247c1ce1fbc77ac79c5855630af306f4f8c42 0.4.3
|
||||
5b2e4f7fc267daf71325991e913f98e6f96259bb 0.4.4
|
||||
ea4d636f3459ddbb51d87e921cf23f87e41d658d 0.4.5
|
||||
9a30f34bc5b07376ed6752eed94d9d58e791fbac 0.4.6
|
||||
9dc2a0e48494d6a354f5ca25db31638cede4bae4 0.4.7
|
||||
a3be97628ed8633e2fe232e6680474e7fd3e9fea 0.5.0
|
||||
bf3db2fe192d4a02bf531e61e23df342c36d6b1b 0.5.1
|
||||
67a86cf9f7c8ac8d9da855c13abbef2547033cce 0.5.2
|
||||
6967bbbee378f470e4b1df02b57112dd050d424b 0.5.3
|
||||
5965315c03c1a8c1cfb34752cca3802d68156e27 0.5.4
|
||||
4109e0db4340042cb85ea8a7d2b6ce37245738c6 0.5.5
|
||||
ade167225d06cb6888ea8bfa84e7d020590171c6 0.5.6
|
||||
dff01be9c8af328f8fcbc2fc97edcbe8d97840e2 0.5.7
|
||||
f8f7eaf275c5e8ac52174642265af55691abef7c 0.5.8
|
||||
4b36382cdfd756f45f81b0d042aaf331c3eabe30 0.6.0
|
||||
0ac352fec2c2a03ac801ff0c40f0649ef16e1f64 0.6.1
|
||||
34a0511928629872ce8cc5f94c6bed65f82ac343 0.7.0
|
||||
74c22fa8c4a64ea37f9b6b2515a4162b8b8b1a2a 0.7.1
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
repos:
|
||||
- repo: https://github.com/asottile/pyupgrade
|
||||
rev: v2.34.0
|
||||
hooks:
|
||||
- id: pyupgrade
|
||||
args: [--py37-plus]
|
||||
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.3.0
|
||||
hooks:
|
||||
- id: check-merge-conflict
|
||||
- id: check-yaml
|
||||
|
||||
ci:
|
||||
autoupdate_schedule: quarterly
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# .readthedocs.yaml
|
||||
# Read the Docs configuration file
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||
|
||||
# Required
|
||||
version: 2
|
||||
|
||||
# Set the version of Python and other tools you might need
|
||||
build:
|
||||
os: ubuntu-20.04
|
||||
tools:
|
||||
python: "3.9"
|
||||
|
||||
# Build documentation in the docs/ directory with Sphinx
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
||||
# If using Sphinx, optionally build your docs in additional formats such as PDF
|
||||
formats:
|
||||
- pdf
|
||||
|
||||
# Optionally declare the Python requirements required to build your docs
|
||||
python:
|
||||
install:
|
||||
- requirements: requirements/docs.txt
|
||||
|
|
@ -4,4 +4,5 @@ source_file = dbtemplates/locale/en/LC_MESSAGES/django.po
|
|||
source_lang = en
|
||||
|
||||
[main]
|
||||
host = https://www.transifex.com
|
||||
host = https://www.transifex.net
|
||||
|
||||
|
|
|
|||
4
AUTHORS
4
AUTHORS
|
|
@ -5,14 +5,10 @@ Alexander Artemenko
|
|||
Arne Brodowski
|
||||
David Paccoud
|
||||
Diego Búrigo Zacarão
|
||||
Dmitry Falk
|
||||
Jannis Leidel
|
||||
Jure Cuhalev
|
||||
Jason Mayfield
|
||||
Kevin Mooney
|
||||
Mark Stahler
|
||||
Matt Dorn
|
||||
Oliver George
|
||||
Selwin Ong
|
||||
Stephan Peijnik <spe@anexia.at>, ANEXIA Internetdienstleistungs GmbH, http://www.anexia.at/
|
||||
Zhang Kun
|
||||
|
|
|
|||
|
|
@ -1,46 +0,0 @@
|
|||
# Code of Conduct
|
||||
|
||||
As contributors and maintainers of the Jazzband projects, and in the interest of
|
||||
fostering an open and welcoming community, we pledge to respect all people who
|
||||
contribute through reporting issues, posting feature requests, updating documentation,
|
||||
submitting pull requests or patches, and other activities.
|
||||
|
||||
We are committed to making participation in the Jazzband a harassment-free experience
|
||||
for everyone, regardless of the level of experience, gender, gender identity and
|
||||
expression, sexual orientation, disability, personal appearance, body size, race,
|
||||
ethnicity, age, religion, or nationality.
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery
|
||||
- Personal attacks
|
||||
- Trolling or insulting/derogatory comments
|
||||
- Public or private harassment
|
||||
- Publishing other's private information, such as physical or electronic addresses,
|
||||
without explicit permission
|
||||
- Other unethical or unprofessional conduct
|
||||
|
||||
The Jazzband roadies have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are not
|
||||
aligned to this Code of Conduct, or to ban temporarily or permanently any contributor
|
||||
for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
By adopting this Code of Conduct, the roadies commit themselves to fairly and
|
||||
consistently applying these principles to every aspect of managing the jazzband
|
||||
projects. Roadies who do not follow or enforce the Code of Conduct may be permanently
|
||||
removed from the Jazzband roadies.
|
||||
|
||||
This code of conduct applies both within project spaces and in public spaces when an
|
||||
individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
|
||||
contacting the roadies at `roadies@jazzband.co`. All complaints will be reviewed and
|
||||
investigated and will result in a response that is deemed necessary and appropriate to
|
||||
the circumstances. Roadies are obligated to maintain confidentiality with regard to the
|
||||
reporter of an incident.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version
|
||||
1.3.0, available at [https://contributor-covenant.org/version/1/3/0/][version]
|
||||
|
||||
[homepage]: https://contributor-covenant.org
|
||||
[version]: https://contributor-covenant.org/version/1/3/0/
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
[](https://jazzband.co/)
|
||||
|
||||
This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/docs/conduct) and follow the [guidelines](https://jazzband.co/docs/guidelines).
|
||||
17
INSTALL
Normal file
17
INSTALL
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
To install it, run the following command inside this directory:
|
||||
|
||||
python setup.py install
|
||||
|
||||
Or if you'd prefer you can simply place the included ``dbtemplates``
|
||||
directory somewhere on your Python path, or symlink to it from
|
||||
somewhere on your Python path; this is useful if you're working from a
|
||||
Subversion checkout. Since ``dbtemplates`` is registered in the
|
||||
Python Package Index you can also run ``easy_install django-dbtemplates``
|
||||
or ``pip install django-dbtemplates`` optionally.
|
||||
|
||||
Note that this application requires Python 2.3 or later, and a recent
|
||||
Subversion checkout of Django. You can obtain Python from
|
||||
http://www.python.org/ and Django from http://www.djangoproject.com/.
|
||||
|
||||
This install notice was bluntly stolen from James Bennett's registration
|
||||
package, http://www.bitbucket.org/ubernostrum/django-registration/
|
||||
2
LICENSE
2
LICENSE
|
|
@ -1,4 +1,4 @@
|
|||
Copyright (c) 2007-2019, Jannis Leidel and contributors
|
||||
Copyright (c) 2007-2011, Jannis Leidel and contributors
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
|
|
|
|||
|
|
@ -1,4 +1,8 @@
|
|||
include LICENSE AUTHORS README.rst MANIFEST.in tox.ini .coveragerc CONTRIBUTING.md
|
||||
include INSTALL
|
||||
include LICENSE
|
||||
include AUTHORS
|
||||
include README.rst
|
||||
include MANIFEST.in
|
||||
recursive-include docs *.txt
|
||||
recursive-include dbtemplates/locale *
|
||||
recursive-include dbtemplates/static/dbtemplates *.css *.js
|
||||
|
|
|
|||
17
README.rst
17
README.rst
|
|
@ -1,17 +1,6 @@
|
|||
django-dbtemplates
|
||||
==================
|
||||
|
||||
.. image:: https://jazzband.co/static/img/badge.svg
|
||||
:alt: Jazzband
|
||||
:target: https://jazzband.co/
|
||||
|
||||
.. image:: https://github.com/jazzband/django-dbtemplates/workflows/Test/badge.svg
|
||||
:target: https://github.com/jazzband/django-dbtemplates/actions
|
||||
|
||||
.. image:: https://codecov.io/github/jazzband/django-dbtemplates/coverage.svg?branch=master
|
||||
:alt: Codecov
|
||||
:target: https://codecov.io/github/jazzband/django-dbtemplates?branch=master
|
||||
|
||||
``dbtemplates`` is a Django app that consists of two parts:
|
||||
|
||||
1. It allows you to store templates in your database
|
||||
|
|
@ -21,10 +10,10 @@ django-dbtemplates
|
|||
It also features optional support for versioned storage and django-admin
|
||||
command, integrates with Django's caching system and the admin actions.
|
||||
|
||||
Please see https://django-dbtemplates.readthedocs.io/ for more details.
|
||||
Please see http://django-dbtemplates.readthedocs.org/ for more details.
|
||||
|
||||
The source code and issue tracker can be found on Github:
|
||||
|
||||
https://github.com/jazzband/django-dbtemplates
|
||||
https://github.com/jezdez/django-dbtemplates
|
||||
|
||||
.. _template loader: http://docs.djangoproject.com/en/dev/ref/templates/api/#loader-types
|
||||
.. _template loader: http://docs.djangoproject.com/en/dev/ref/templates/api/#loader-types
|
||||
|
|
@ -1,3 +1,2 @@
|
|||
import importlib.metadata
|
||||
|
||||
__version__ = importlib.metadata.version("django-dbtemplates")
|
||||
# following PEP 386, versiontools will pick it up
|
||||
__version__ = (1, 2, 1, "final", 0)
|
||||
|
|
|
|||
|
|
@ -1,29 +1,23 @@
|
|||
import posixpath
|
||||
from django import forms
|
||||
from django.contrib import admin
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
from django.utils.translation import ngettext
|
||||
from django.utils.translation import ungettext, ugettext_lazy as _
|
||||
from django.utils.safestring import mark_safe
|
||||
|
||||
from dbtemplates.conf import settings
|
||||
from dbtemplates.models import Template, add_template_to_cache, remove_cached_template
|
||||
from dbtemplates.models import (Template,
|
||||
remove_cached_template, add_template_to_cache)
|
||||
from dbtemplates.utils.template import check_template_syntax
|
||||
|
||||
# Check if either django-reversion-compare or django-reversion is installed and
|
||||
# use reversion_compare's CompareVersionAdmin or reversion's VersionAdmin as
|
||||
# the base admin class if yes
|
||||
if settings.DBTEMPLATES_USE_REVERSION_COMPARE:
|
||||
from reversion_compare.admin import CompareVersionAdmin \
|
||||
as TemplateModelAdmin
|
||||
elif settings.DBTEMPLATES_USE_REVERSION:
|
||||
# Check if django-reversion is installed and use reversions' VersionAdmin
|
||||
# as the base admin class if yes
|
||||
if settings.DBTEMPLATES_USE_REVERSION:
|
||||
from reversion.admin import VersionAdmin as TemplateModelAdmin
|
||||
else:
|
||||
from django.contrib.admin import ModelAdmin as TemplateModelAdmin # noqa
|
||||
from django.contrib.admin import ModelAdmin as TemplateModelAdmin
|
||||
|
||||
|
||||
class CodeMirrorTextArea(forms.Textarea):
|
||||
|
||||
"""
|
||||
A custom widget for the CodeMirror browser editor to be used with the
|
||||
content field of the Template model.
|
||||
|
|
@ -31,14 +25,13 @@ class CodeMirrorTextArea(forms.Textarea):
|
|||
class Media:
|
||||
css = dict(screen=[posixpath.join(
|
||||
settings.DBTEMPLATES_MEDIA_PREFIX, 'css/editor.css')])
|
||||
js = [posixpath.join(settings.DBTEMPLATES_MEDIA_PREFIX,
|
||||
'js/codemirror.js')]
|
||||
js = [posixpath.join(settings.DBTEMPLATES_MEDIA_PREFIX, 'js/codemirror.js')]
|
||||
|
||||
def render(self, name, value, attrs=None, renderer=None):
|
||||
def render(self, name, value, attrs=None):
|
||||
result = []
|
||||
result.append(
|
||||
super().render(name, value, attrs))
|
||||
result.append("""
|
||||
super(CodeMirrorTextArea, self).render(name, value, attrs))
|
||||
result.append(u"""
|
||||
<script type="text/javascript">
|
||||
var editor = CodeMirror.fromTextArea('id_%(name)s', {
|
||||
path: "%(media_prefix)sjs/",
|
||||
|
|
@ -52,8 +45,7 @@ class CodeMirrorTextArea(forms.Textarea):
|
|||
});
|
||||
</script>
|
||||
""" % dict(media_prefix=settings.DBTEMPLATES_MEDIA_PREFIX, name=name))
|
||||
return mark_safe("".join(result))
|
||||
|
||||
return mark_safe(u"".join(result))
|
||||
|
||||
if settings.DBTEMPLATES_USE_CODEMIRROR:
|
||||
TemplateContentTextArea = CodeMirrorTextArea
|
||||
|
|
@ -62,42 +54,26 @@ else:
|
|||
|
||||
if settings.DBTEMPLATES_AUTO_POPULATE_CONTENT:
|
||||
content_help_text = _("Leaving this empty causes Django to look for a "
|
||||
"template with the given name and populate this "
|
||||
"field with its content.")
|
||||
"template with the given name and populate this field with its "
|
||||
"content.")
|
||||
else:
|
||||
content_help_text = ""
|
||||
|
||||
if settings.DBTEMPLATES_USE_CODEMIRROR and settings.DBTEMPLATES_USE_TINYMCE:
|
||||
raise ImproperlyConfigured("You may use either CodeMirror or TinyMCE "
|
||||
"with dbtemplates, not both. Please disable "
|
||||
"one of them.")
|
||||
|
||||
if settings.DBTEMPLATES_USE_TINYMCE:
|
||||
from tinymce.widgets import AdminTinyMCE
|
||||
TemplateContentTextArea = AdminTinyMCE
|
||||
elif settings.DBTEMPLATES_USE_REDACTOR:
|
||||
from redactor.widgets import RedactorEditor
|
||||
TemplateContentTextArea = RedactorEditor
|
||||
|
||||
|
||||
class TemplateAdminForm(forms.ModelForm):
|
||||
|
||||
"""
|
||||
Custom AdminForm to make the content textarea wider.
|
||||
"""
|
||||
content = forms.CharField(
|
||||
widget=TemplateContentTextArea(attrs={'rows': '24'}),
|
||||
widget=TemplateContentTextArea({'rows': '24'}),
|
||||
help_text=content_help_text, required=False)
|
||||
|
||||
class Meta:
|
||||
model = Template
|
||||
fields = ('name', 'content', 'sites', 'creation_date', 'last_changed')
|
||||
fields = "__all__"
|
||||
|
||||
|
||||
class TemplateAdmin(TemplateModelAdmin):
|
||||
form = TemplateAdminForm
|
||||
readonly_fields = ['creation_date', 'last_changed']
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('name', 'content'),
|
||||
|
|
@ -122,7 +98,7 @@ class TemplateAdmin(TemplateModelAdmin):
|
|||
for template in queryset:
|
||||
remove_cached_template(template)
|
||||
count = queryset.count()
|
||||
message = ngettext(
|
||||
message = ungettext(
|
||||
"Cache of one template successfully invalidated.",
|
||||
"Cache of %(count)d templates successfully invalidated.",
|
||||
count)
|
||||
|
|
@ -134,7 +110,7 @@ class TemplateAdmin(TemplateModelAdmin):
|
|||
for template in queryset:
|
||||
add_template_to_cache(template)
|
||||
count = queryset.count()
|
||||
message = ngettext(
|
||||
message = ungettext(
|
||||
"Cache successfully repopulated with one template.",
|
||||
"Cache successfully repopulated with %(count)d templates.",
|
||||
count)
|
||||
|
|
@ -147,19 +123,18 @@ class TemplateAdmin(TemplateModelAdmin):
|
|||
for template in queryset:
|
||||
valid, error = check_template_syntax(template)
|
||||
if not valid:
|
||||
errors.append(f'{template.name}: {error}')
|
||||
errors.append('%s: %s' % (template.name, error))
|
||||
if errors:
|
||||
count = len(errors)
|
||||
message = ngettext(
|
||||
message = ungettext(
|
||||
"Template syntax check FAILED for %(names)s.",
|
||||
"Template syntax check FAILED for "
|
||||
"%(count)d templates: %(names)s.",
|
||||
"Template syntax check FAILED for %(count)d templates: %(names)s.",
|
||||
count)
|
||||
self.message_user(request, message %
|
||||
{'count': count, 'names': ', '.join(errors)})
|
||||
else:
|
||||
count = queryset.count()
|
||||
message = ngettext(
|
||||
message = ungettext(
|
||||
"Template syntax OK.",
|
||||
"Template syntax OK for %(count)d templates.", count)
|
||||
self.message_user(request, message % {'count': count})
|
||||
|
|
@ -169,5 +144,4 @@ class TemplateAdmin(TemplateModelAdmin):
|
|||
return ", ".join([site.name for site in template.sites.all()])
|
||||
site_list.short_description = _('sites')
|
||||
|
||||
|
||||
admin.site.register(Template, TemplateAdmin)
|
||||
|
|
|
|||
|
|
@ -1,9 +0,0 @@
|
|||
from django.apps import AppConfig
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
|
||||
|
||||
class DBTemplatesConfig(AppConfig):
|
||||
name = 'dbtemplates'
|
||||
verbose_name = _('Database templates')
|
||||
|
||||
default_auto_field = 'django.db.models.AutoField'
|
||||
|
|
@ -9,9 +9,6 @@ from appconf import AppConf
|
|||
class DbTemplatesConf(AppConf):
|
||||
USE_CODEMIRROR = False
|
||||
USE_REVERSION = False
|
||||
USE_REVERSION_COMPARE = False
|
||||
USE_TINYMCE = False
|
||||
USE_REDACTOR = False
|
||||
ADD_DEFAULT_SITE = True
|
||||
AUTO_POPULATE_CONTENT = True
|
||||
MEDIA_PREFIX = None
|
||||
|
|
@ -32,7 +29,7 @@ class DbTemplatesConf(AppConf):
|
|||
return "dbtemplates"
|
||||
else:
|
||||
return "default"
|
||||
if isinstance(value, str) and value.startswith("dbtemplates."):
|
||||
if isinstance(value, basestring) and value.startswith("dbtemplates."):
|
||||
raise ImproperlyConfigured("Please upgrade to one of the "
|
||||
"supported backends as defined "
|
||||
"in the Django docs.")
|
||||
|
|
@ -41,27 +38,5 @@ class DbTemplatesConf(AppConf):
|
|||
def configure_use_reversion(self, value):
|
||||
if value and 'reversion' not in settings.INSTALLED_APPS:
|
||||
raise ImproperlyConfigured("Please add 'reversion' to your "
|
||||
"INSTALLED_APPS setting to make "
|
||||
"use of it in dbtemplates.")
|
||||
return value
|
||||
|
||||
def configure_use_reversion_compare(self, value):
|
||||
if value and 'reversion_compare' not in settings.INSTALLED_APPS:
|
||||
raise ImproperlyConfigured("Please add 'reversion_compare' to your"
|
||||
" INSTALLED_APPS setting to make "
|
||||
"use of it in dbtemplates.")
|
||||
return value
|
||||
|
||||
def configure_use_tinymce(self, value):
|
||||
if value and 'tinymce' not in settings.INSTALLED_APPS:
|
||||
raise ImproperlyConfigured("Please add 'tinymce' to your "
|
||||
"INSTALLED_APPS setting to make "
|
||||
"use of it in dbtemplates.")
|
||||
return value
|
||||
|
||||
def configure_use_redactor(self, value):
|
||||
if value and 'redactor' not in settings.INSTALLED_APPS:
|
||||
raise ImproperlyConfigured("Please add 'redactor' to your "
|
||||
"INSTALLED_APPS setting to make "
|
||||
"use of it in dbtemplates.")
|
||||
"INSTALLED_APPS setting to make use of it in dbtemplates.")
|
||||
return value
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
from django.contrib.sites.models import Site
|
||||
from django.db import router
|
||||
from django.template import Origin, TemplateDoesNotExist
|
||||
from django.template.loaders.base import Loader as BaseLoader
|
||||
from django.template import TemplateDoesNotExist
|
||||
|
||||
from dbtemplates.conf import settings
|
||||
from dbtemplates.models import Template
|
||||
from dbtemplates.utils.cache import (cache, get_cache_key,
|
||||
set_and_return, get_cache_notfound_key)
|
||||
from django.template.loader import BaseLoader
|
||||
|
||||
|
||||
class Loader(BaseLoader):
|
||||
|
|
@ -19,25 +19,7 @@ class Loader(BaseLoader):
|
|||
"""
|
||||
is_usable = True
|
||||
|
||||
def get_template_sources(self, template_name, template_dirs=None):
|
||||
yield Origin(
|
||||
name=template_name,
|
||||
template_name=template_name,
|
||||
loader=self,
|
||||
)
|
||||
|
||||
def get_contents(self, origin):
|
||||
content, _ = self._load_template_source(origin.template_name)
|
||||
return content
|
||||
|
||||
def _load_and_store_template(self, template_name, cache_key, site,
|
||||
**params):
|
||||
template = Template.objects.get(name__exact=template_name, **params)
|
||||
db = router.db_for_read(Template, instance=template)
|
||||
display_name = f'dbtemplates:{db}:{template_name}:{site.domain}'
|
||||
return set_and_return(cache_key, template.content, display_name)
|
||||
|
||||
def _load_template_source(self, template_name, template_dirs=None):
|
||||
def load_template_source(self, template_name, template_dirs=None):
|
||||
# The logic should work like this:
|
||||
# * Try to find the template in the cache. If found, return it.
|
||||
# * Now check the cache if a lookup for the given template
|
||||
|
|
@ -51,13 +33,15 @@ class Loader(BaseLoader):
|
|||
# in the cache indicating that queries failed, with the current
|
||||
# timestamp.
|
||||
site = Site.objects.get_current()
|
||||
display_name = 'dbtemplates:%s:%s:%s' % (settings.DATABASE_ENGINE,
|
||||
template_name, site.domain)
|
||||
cache_key = get_cache_key(template_name)
|
||||
if cache:
|
||||
try:
|
||||
backend_template = cache.get(cache_key)
|
||||
if backend_template:
|
||||
return backend_template, template_name
|
||||
except Exception:
|
||||
except:
|
||||
pass
|
||||
|
||||
# Not found in cache, move on.
|
||||
|
|
@ -67,19 +51,20 @@ class Loader(BaseLoader):
|
|||
notfound = cache.get(cache_notfound_key)
|
||||
if notfound:
|
||||
raise TemplateDoesNotExist(template_name)
|
||||
except Exception:
|
||||
except:
|
||||
raise TemplateDoesNotExist(template_name)
|
||||
|
||||
# Not marked as not-found, move on...
|
||||
|
||||
try:
|
||||
return self._load_and_store_template(template_name, cache_key,
|
||||
site, sites__in=[site.id])
|
||||
template = Template.objects.get(name__exact=template_name,
|
||||
sites__in=[site.id])
|
||||
return set_and_return(cache_key, template.content, display_name)
|
||||
except (Template.MultipleObjectsReturned, Template.DoesNotExist):
|
||||
try:
|
||||
return self._load_and_store_template(template_name, cache_key,
|
||||
site, sites__isnull=True)
|
||||
except (Template.MultipleObjectsReturned, Template.DoesNotExist):
|
||||
template = Template.objects.get(name__exact=template_name)
|
||||
return set_and_return(cache_key, template.content, display_name)
|
||||
except Template.DoesNotExist:
|
||||
pass
|
||||
|
||||
# Mark as not-found in cache.
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -1,106 +0,0 @@
|
|||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
|
||||
# This file is distributed under the same license as the PACKAGE package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: PACKAGE VERSION\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2013-07-30 14:03+0600\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"Language: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
|
||||
"%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);\n"
|
||||
|
||||
#: admin.py:57
|
||||
msgid ""
|
||||
"Leaving this empty causes Django to look for a template with the given name "
|
||||
"and populate this field with its content."
|
||||
msgstr "Если вы оставите это поле незаполненным, Django будет искать шаблон с введённым именем и заполнит поле его содержимым."
|
||||
|
||||
#: admin.py:92
|
||||
msgid "Advanced"
|
||||
msgstr "Дополнительно"
|
||||
|
||||
#: admin.py:95
|
||||
msgid "Date/time"
|
||||
msgstr "Дата/время"
|
||||
|
||||
#: admin.py:112
|
||||
#, python-format
|
||||
msgid "Cache of one template successfully invalidated."
|
||||
msgid_plural "Cache of %(count)d templates successfully invalidated."
|
||||
msgstr[0] "Кэш для шаблона успешно очищен."
|
||||
msgstr[1] "Кэш для шаблонов (%(count)d шт.) успешно очищен."
|
||||
|
||||
#: admin.py:116
|
||||
msgid "Invalidate cache of selected templates"
|
||||
msgstr "Очистить кэш для выделенных шаблонов"
|
||||
|
||||
#: admin.py:124
|
||||
#, python-format
|
||||
msgid "Cache successfully repopulated with one template."
|
||||
msgid_plural "Cache successfully repopulated with %(count)d templates."
|
||||
msgstr[0] "Кэш для шаблона успешно заполнен."
|
||||
msgstr[1] "Кэш для шаблонов (%(count)d шт.) успешно заполнен."
|
||||
|
||||
#: admin.py:128
|
||||
msgid "Repopulate cache with selected templates"
|
||||
msgstr "Заполнить кэш для выделенных шаблонов"
|
||||
|
||||
#: admin.py:140
|
||||
#, python-format
|
||||
msgid "Template syntax check FAILED for %(names)s."
|
||||
msgid_plural "Template syntax check FAILED for %(count)d templates: %(names)s."
|
||||
msgstr[0] "Неверный синтаксис у шаблона %(names)s."
|
||||
msgstr[1] "Неверный синтаксис у следующих шаблонов: %(names)s."
|
||||
|
||||
#: admin.py:148
|
||||
#, python-format
|
||||
msgid "Template syntax OK."
|
||||
msgid_plural "Template syntax OK for %(count)d templates."
|
||||
msgstr[0] "Синтаксис шаблона корректен."
|
||||
msgstr[1] "Синтаксис шаблонов корректен."
|
||||
|
||||
#: admin.py:151
|
||||
msgid "Check template syntax"
|
||||
msgstr "Проверить синтаксис шаблона"
|
||||
|
||||
#: admin.py:155 models.py:29
|
||||
msgid "sites"
|
||||
msgstr "сайты"
|
||||
|
||||
#: models.py:26
|
||||
msgid "name"
|
||||
msgstr "название"
|
||||
|
||||
#: models.py:27
|
||||
msgid "Example: 'flatpages/default.html'"
|
||||
msgstr "Например: 'flatpages/default.html'"
|
||||
|
||||
#: models.py:28
|
||||
msgid "content"
|
||||
msgstr "содержимое"
|
||||
|
||||
#: models.py:31
|
||||
msgid "creation date"
|
||||
msgstr "дата создания"
|
||||
|
||||
#: models.py:33
|
||||
msgid "last changed"
|
||||
msgstr "последнее изменение"
|
||||
|
||||
#: models.py:41
|
||||
msgid "template"
|
||||
msgstr "шаблон"
|
||||
|
||||
#: models.py:42
|
||||
msgid "templates"
|
||||
msgstr "шаблоны"
|
||||
|
|
@ -1,19 +1,20 @@
|
|||
from django.core.management.base import CommandError, BaseCommand
|
||||
from django.core.management.base import CommandError, NoArgsCommand
|
||||
|
||||
from dbtemplates.models import Template
|
||||
from dbtemplates.utils.template import check_template_syntax
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
class Command(NoArgsCommand):
|
||||
help = "Ensures templates stored in the database don't have syntax errors."
|
||||
|
||||
def handle(self, **options):
|
||||
def handle_noargs(self, **options):
|
||||
errors = []
|
||||
for template in Template.objects.all():
|
||||
valid, error = check_template_syntax(template)
|
||||
if not valid:
|
||||
errors.append(f'{template.name}: {error}')
|
||||
errors.append('%s: %s' % (template.name, error))
|
||||
if errors:
|
||||
raise CommandError(
|
||||
'Some templates contained errors\n%s' % '\n'.join(errors))
|
||||
self.stdout.write('OK')
|
||||
# NOTE: printing instead of using self.stdout.write to maintain
|
||||
# Django 1.2 compatibility
|
||||
print('OK')
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
import sys
|
||||
from django.core.management.base import CommandError, BaseCommand
|
||||
from optparse import make_option
|
||||
|
||||
from django.core.management.base import CommandError, NoArgsCommand
|
||||
from django.contrib.sites.models import Site
|
||||
|
||||
from dbtemplates.models import Template
|
||||
|
|
@ -24,15 +26,13 @@ TEMPLATES = {
|
|||
}
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
class Command(NoArgsCommand):
|
||||
help = "Creates the default error templates as database template objects."
|
||||
option_list = NoArgsCommand.option_list + (
|
||||
make_option("-f", "--force", action="store_true", dest="force",
|
||||
default=False, help="overwrite existing database templates"),)
|
||||
|
||||
def add_arguments(self, parser):
|
||||
parser.add_argument(
|
||||
"-f", "--force", action="store_true", dest="force",
|
||||
default=False, help="overwrite existing database templates")
|
||||
|
||||
def handle(self, **options):
|
||||
def handle_noargs(self, **options):
|
||||
force = options.get('force')
|
||||
try:
|
||||
site = Site.objects.get_current()
|
||||
|
|
@ -43,7 +43,7 @@ class Command(BaseCommand):
|
|||
verbosity = int(options.get('verbosity', 1))
|
||||
for error_code in (404, 500):
|
||||
template, created = Template.objects.get_or_create(
|
||||
name=f"{error_code}.html")
|
||||
name="%s.html" % error_code)
|
||||
if created or (not created and force):
|
||||
template.content = TEMPLATES.get(error_code, '')
|
||||
template.save()
|
||||
|
|
|
|||
|
|
@ -1,153 +1,111 @@
|
|||
import os
|
||||
import codecs
|
||||
from optparse import make_option
|
||||
|
||||
from dbtemplates.models import Template
|
||||
from django.contrib.sites.models import Site
|
||||
from django.core.management.base import BaseCommand, CommandError
|
||||
from django.template.loader import _engine_list
|
||||
from django.template.utils import get_app_template_dirs
|
||||
from django.core.management.base import CommandError, NoArgsCommand
|
||||
from django.template.loaders.app_directories import app_template_dirs
|
||||
|
||||
ALWAYS_ASK, FILES_TO_DATABASE, DATABASE_TO_FILES = ("0", "1", "2")
|
||||
from dbtemplates.conf import settings
|
||||
from dbtemplates.models import Template
|
||||
|
||||
DIRS = []
|
||||
for engine in _engine_list():
|
||||
DIRS.extend(engine.dirs)
|
||||
DIRS = tuple(DIRS)
|
||||
app_template_dirs = get_app_template_dirs("templates")
|
||||
ALWAYS_ASK, FILES_TO_DATABASE, DATABASE_TO_FILES = ('0', '1', '2')
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
class Command(NoArgsCommand):
|
||||
help = "Syncs file system templates with the database bidirectionally."
|
||||
option_list = NoArgsCommand.option_list + (
|
||||
make_option("-e", "--ext", dest="ext", action="store", default="html",
|
||||
help="extension of the files you want to sync with the database "
|
||||
"[default: %default]"),
|
||||
make_option("-f", "--force", action="store_true", dest="force",
|
||||
default=False, help="overwrite existing database templates"),
|
||||
make_option("-o", "--overwrite", action="store", dest="overwrite",
|
||||
default='0', help="'0' - ask always, '1' - overwrite database "
|
||||
"templates from template files, '2' - overwrite template "
|
||||
"files from database templates"),
|
||||
make_option("-a", "--app-first", action="store_true", dest="app_first",
|
||||
default=False, help="look for templates in applications "
|
||||
"directories before project templates"),
|
||||
make_option("-d", "--delete", action="store_true", dest="delete",
|
||||
default=False, help="Delete templates after syncing"))
|
||||
|
||||
def add_arguments(self, parser):
|
||||
parser.add_argument(
|
||||
"-e",
|
||||
"--ext",
|
||||
dest="ext",
|
||||
action="store",
|
||||
default="html",
|
||||
help="extension of the files you want to "
|
||||
"sync with the database [default: %(default)s]",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-f",
|
||||
"--force",
|
||||
action="store_true",
|
||||
dest="force",
|
||||
default=False,
|
||||
help="overwrite existing database templates",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-o",
|
||||
"--overwrite",
|
||||
action="store",
|
||||
dest="overwrite",
|
||||
default="0",
|
||||
help="'0' - ask always, '1' - overwrite database "
|
||||
"templates from template files, '2' - overwrite "
|
||||
"template files from database templates",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-a",
|
||||
"--app-first",
|
||||
action="store_true",
|
||||
dest="app_first",
|
||||
default=False,
|
||||
help="look for templates in applications "
|
||||
"directories before project templates",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-d",
|
||||
"--delete",
|
||||
action="store_true",
|
||||
dest="delete",
|
||||
default=False,
|
||||
help="Delete templates after syncing",
|
||||
)
|
||||
|
||||
def handle(self, **options):
|
||||
extension = options.get("ext")
|
||||
force = options.get("force")
|
||||
overwrite = options.get("overwrite")
|
||||
app_first = options.get("app_first")
|
||||
delete = options.get("delete")
|
||||
def handle_noargs(self, **options):
|
||||
extension = options.get('ext')
|
||||
force = options.get('force')
|
||||
overwrite = options.get('overwrite')
|
||||
app_first = options.get('app_first')
|
||||
delete = options.get('delete')
|
||||
|
||||
if not extension.startswith("."):
|
||||
extension = f".{extension}"
|
||||
extension = ".%s" % extension
|
||||
|
||||
try:
|
||||
site = Site.objects.get_current()
|
||||
except Exception:
|
||||
raise CommandError(
|
||||
"Please make sure to have the sites contrib "
|
||||
"app installed and setup with a site object"
|
||||
)
|
||||
except:
|
||||
raise CommandError("Please make sure to have the sites contrib "
|
||||
"app installed and setup with a site object")
|
||||
|
||||
if not type(settings.TEMPLATE_DIRS) in (tuple, list):
|
||||
raise CommandError("Please make sure settings.TEMPLATE_DIRS is a "
|
||||
"list or tuple.")
|
||||
|
||||
if app_first:
|
||||
tpl_dirs = app_template_dirs + DIRS
|
||||
tpl_dirs = app_template_dirs + settings.TEMPLATE_DIRS
|
||||
else:
|
||||
tpl_dirs = DIRS + app_template_dirs
|
||||
templatedirs = [str(d) for d in tpl_dirs if os.path.isdir(d)]
|
||||
tpl_dirs = settings.TEMPLATE_DIRS + app_template_dirs
|
||||
templatedirs = [d for d in tpl_dirs if os.path.isdir(d)]
|
||||
|
||||
for templatedir in templatedirs:
|
||||
for dirpath, subdirs, filenames in os.walk(templatedir):
|
||||
for f in [
|
||||
f
|
||||
for f in filenames
|
||||
if f.endswith(extension) and not f.startswith(".")
|
||||
]:
|
||||
for f in [f for f in filenames
|
||||
if f.endswith(extension) and not f.startswith(".")]:
|
||||
path = os.path.join(dirpath, f)
|
||||
name = path.split(str(templatedir))[1]
|
||||
if name.startswith("/"):
|
||||
name = path.split(templatedir)[1]
|
||||
if name.startswith('/'):
|
||||
name = name[1:]
|
||||
try:
|
||||
t = Template.on_site.get(name__exact=name)
|
||||
except Template.DoesNotExist:
|
||||
if not force:
|
||||
confirm = input(
|
||||
confirm = raw_input(
|
||||
"\nA '%s' template doesn't exist in the "
|
||||
"database.\nCreate it with '%s'?"
|
||||
" (y/[n]): "
|
||||
"" % (name, path)
|
||||
)
|
||||
if force or confirm.lower().startswith("y"):
|
||||
with open(path, encoding="utf-8") as f:
|
||||
t = Template(name=name, content=f.read())
|
||||
" (y/[n]): """ % (name, path))
|
||||
if force or confirm.lower().startswith('y'):
|
||||
t = Template(name=name,
|
||||
content=codecs.open(path, "r").read())
|
||||
t.save()
|
||||
t.sites.add(site)
|
||||
else:
|
||||
while True:
|
||||
while 1:
|
||||
if overwrite == ALWAYS_ASK:
|
||||
_i = (
|
||||
"\n%(template)s exists in the database.\n"
|
||||
"(1) Overwrite %(template)s with '%(path)s'\n" # noqa
|
||||
"(2) Overwrite '%(path)s' with %(template)s\n" # noqa
|
||||
confirm = raw_input(
|
||||
"\n%s exists in the database.\n"
|
||||
"(1) Overwrite %s with '%s'\n"
|
||||
"(2) Overwrite '%s' with %s\n"
|
||||
"Type 1 or 2 or press <Enter> to skip: "
|
||||
% {"template": t.__repr__(), "path": path}
|
||||
)
|
||||
|
||||
confirm = input(_i)
|
||||
% (t.__repr__(),
|
||||
t.__repr__(), path,
|
||||
path, t.__repr__()))
|
||||
else:
|
||||
confirm = overwrite
|
||||
if confirm in (
|
||||
"",
|
||||
FILES_TO_DATABASE,
|
||||
DATABASE_TO_FILES,
|
||||
):
|
||||
if confirm in ('', FILES_TO_DATABASE, DATABASE_TO_FILES):
|
||||
if confirm == FILES_TO_DATABASE:
|
||||
with open(path, encoding="utf-8") as f:
|
||||
t.content = f.read()
|
||||
t.save()
|
||||
t.sites.add(site)
|
||||
t.content = codecs.open(path, 'r').read()
|
||||
t.save()
|
||||
t.sites.add(site)
|
||||
if delete:
|
||||
try:
|
||||
os.remove(path)
|
||||
except OSError:
|
||||
raise CommandError(
|
||||
f"Couldn't delete {path}"
|
||||
)
|
||||
u"Couldn't delete %s" % path)
|
||||
elif confirm == DATABASE_TO_FILES:
|
||||
with open(path, "w", encoding="utf-8") as f: # noqa
|
||||
try:
|
||||
f = codecs.open(path, 'w')
|
||||
f.write(t.content)
|
||||
finally:
|
||||
f.close()
|
||||
if delete:
|
||||
t.delete()
|
||||
break
|
||||
|
|
|
|||
|
|
@ -1,73 +1,57 @@
|
|||
import django
|
||||
import django.utils.timezone
|
||||
from django.db import migrations, models
|
||||
# encoding: utf-8
|
||||
import datetime
|
||||
from south.db import db
|
||||
from south.v2 import SchemaMigration
|
||||
from django.db import models
|
||||
|
||||
class Migration(SchemaMigration):
|
||||
|
||||
def forwards(self, orm):
|
||||
|
||||
# Adding model 'Template'
|
||||
db.create_table('django_template', (
|
||||
('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
|
||||
('name', self.gf('django.db.models.fields.CharField')(unique=True, max_length=100)),
|
||||
('content', self.gf('django.db.models.fields.TextField')(blank=True)),
|
||||
('creation_date', self.gf('django.db.models.fields.DateTimeField')(default=datetime.datetime.now)),
|
||||
('last_changed', self.gf('django.db.models.fields.DateTimeField')(default=datetime.datetime.now)),
|
||||
))
|
||||
db.send_create_signal('dbtemplates', ['Template'])
|
||||
|
||||
# Adding M2M table for field sites on 'Template'
|
||||
db.create_table('django_template_sites', (
|
||||
('id', models.AutoField(verbose_name='ID', primary_key=True, auto_created=True)),
|
||||
('template', models.ForeignKey(orm['dbtemplates.template'], null=False)),
|
||||
('site', models.ForeignKey(orm['sites.site'], null=False))
|
||||
))
|
||||
db.create_unique('django_template_sites', ['template_id', 'site_id'])
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
def backwards(self, orm):
|
||||
|
||||
# Deleting model 'Template'
|
||||
db.delete_table('django_template')
|
||||
|
||||
dependencies = [
|
||||
("sites", "0001_initial"),
|
||||
]
|
||||
# Removing M2M table for field sites on 'Template'
|
||||
db.delete_table('django_template_sites')
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="Template",
|
||||
fields=[
|
||||
(
|
||||
"id",
|
||||
models.AutoField(
|
||||
verbose_name="ID",
|
||||
serialize=False,
|
||||
auto_created=True,
|
||||
primary_key=True,
|
||||
),
|
||||
),
|
||||
(
|
||||
"name",
|
||||
models.CharField(
|
||||
help_text="Example: 'flatpages/default.html'",
|
||||
max_length=100,
|
||||
verbose_name="name",
|
||||
),
|
||||
),
|
||||
(
|
||||
"content",
|
||||
models.TextField(verbose_name="content", blank=True),
|
||||
), # noqa
|
||||
(
|
||||
"creation_date",
|
||||
models.DateTimeField(
|
||||
default=django.utils.timezone.now,
|
||||
verbose_name="creation date", # noqa
|
||||
),
|
||||
),
|
||||
(
|
||||
"last_changed",
|
||||
models.DateTimeField(
|
||||
default=django.utils.timezone.now,
|
||||
verbose_name="last changed", # noqa
|
||||
),
|
||||
),
|
||||
(
|
||||
"sites",
|
||||
models.ManyToManyField(
|
||||
to="sites.Site", verbose_name="sites", blank=True
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"ordering": ("name",),
|
||||
"db_table": "django_template",
|
||||
"verbose_name": "template",
|
||||
"verbose_name_plural": "templates",
|
||||
},
|
||||
bases=(models.Model,),
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
(
|
||||
"on_site",
|
||||
django.contrib.sites.managers.CurrentSiteManager("sites"),
|
||||
), # noqa
|
||||
],
|
||||
),
|
||||
]
|
||||
|
||||
models = {
|
||||
'dbtemplates.template': {
|
||||
'Meta': {'ordering': "('name',)", 'object_name': 'Template', 'db_table': "'django_template'"},
|
||||
'content': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
|
||||
'creation_date': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
|
||||
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
|
||||
'last_changed': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
|
||||
'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '100'}),
|
||||
'sites': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['sites.Site']", 'symmetrical': 'False'})
|
||||
},
|
||||
'sites.site': {
|
||||
'Meta': {'ordering': "('domain',)", 'object_name': 'Site', 'db_table': "'django_site'"},
|
||||
'domain': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
|
||||
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
|
||||
'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
|
||||
}
|
||||
}
|
||||
|
||||
complete_apps = ['dbtemplates']
|
||||
|
|
|
|||
|
|
@ -1,23 +0,0 @@
|
|||
# Generated by Django 5.1 on 2025-05-26 19:59
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('dbtemplates', '0001_initial'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name='template',
|
||||
name='creation_date',
|
||||
field=models.DateTimeField(auto_now_add=True, verbose_name='creation date'),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name='template',
|
||||
name='last_changed',
|
||||
field=models.DateTimeField(auto_now=True, verbose_name='last changed'),
|
||||
),
|
||||
]
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# encoding: utf-8
|
||||
import datetime
|
||||
from south.db import db
|
||||
from south.v2 import SchemaMigration
|
||||
from django.db import models
|
||||
|
||||
class Migration(SchemaMigration):
|
||||
|
||||
def forwards(self, orm):
|
||||
|
||||
# Removing unique constraint on 'Template', fields ['name']
|
||||
db.delete_unique('django_template', ['name'])
|
||||
|
||||
|
||||
def backwards(self, orm):
|
||||
|
||||
# Adding unique constraint on 'Template', fields ['name']
|
||||
db.create_unique('django_template', ['name'])
|
||||
|
||||
|
||||
models = {
|
||||
'dbtemplates.template': {
|
||||
'Meta': {'ordering': "('name',)", 'object_name': 'Template', 'db_table': "'django_template'"},
|
||||
'content': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
|
||||
'creation_date': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
|
||||
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
|
||||
'last_changed': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
|
||||
'name': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
|
||||
'sites': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['sites.Site']", 'symmetrical': 'False'})
|
||||
},
|
||||
'sites.site': {
|
||||
'Meta': {'ordering': "('domain',)", 'object_name': 'Site', 'db_table': "'django_site'"},
|
||||
'domain': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
|
||||
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
|
||||
'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
|
||||
}
|
||||
}
|
||||
|
||||
complete_apps = ['dbtemplates']
|
||||
|
|
@ -1,16 +1,17 @@
|
|||
from dbtemplates.conf import settings
|
||||
from dbtemplates.utils.cache import (
|
||||
add_template_to_cache,
|
||||
remove_cached_template,
|
||||
)
|
||||
from dbtemplates.utils.template import get_template_source
|
||||
# -*- coding: utf-8 -*-
|
||||
from datetime import datetime
|
||||
|
||||
from django.contrib.sites.managers import CurrentSiteManager
|
||||
from django.contrib.sites.models import Site
|
||||
from django.db import models
|
||||
from django.db.models import signals
|
||||
from django.template import TemplateDoesNotExist
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
from django.utils.translation import ugettext_lazy as _
|
||||
|
||||
from django.contrib.sites.models import Site
|
||||
from django.contrib.sites.managers import CurrentSiteManager
|
||||
|
||||
from dbtemplates.conf import settings
|
||||
from dbtemplates.utils.cache import add_template_to_cache, remove_cached_template
|
||||
from dbtemplates.utils.template import get_template_source
|
||||
|
||||
|
||||
class Template(models.Model):
|
||||
|
|
@ -18,15 +19,15 @@ class Template(models.Model):
|
|||
Defines a template model for use with the database template loader.
|
||||
The field ``name`` is the equivalent to the filename of a static template.
|
||||
"""
|
||||
id = models.AutoField(primary_key=True, verbose_name=_('ID'),
|
||||
serialize=False, auto_created=True)
|
||||
name = models.CharField(_('name'), max_length=100,
|
||||
help_text=_("Example: 'flatpages/default.html'"))
|
||||
content = models.TextField(_('content'), blank=True)
|
||||
sites = models.ManyToManyField(Site, verbose_name=_('sites'),
|
||||
blank=True)
|
||||
creation_date = models.DateTimeField(_('creation date'), auto_now_add=True)
|
||||
last_changed = models.DateTimeField(_('last changed'), auto_now=True)
|
||||
sites = models.ManyToManyField(Site, verbose_name=_(u'sites'),
|
||||
blank=True, null=True)
|
||||
creation_date = models.DateTimeField(_('creation date'),
|
||||
default=datetime.now)
|
||||
last_changed = models.DateTimeField(_('last changed'),
|
||||
default=datetime.now)
|
||||
|
||||
objects = models.Manager()
|
||||
on_site = CurrentSiteManager('sites')
|
||||
|
|
@ -37,7 +38,7 @@ class Template(models.Model):
|
|||
verbose_name_plural = _('templates')
|
||||
ordering = ('name',)
|
||||
|
||||
def __str__(self):
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
|
||||
def populate(self, name=None):
|
||||
|
|
@ -55,11 +56,12 @@ class Template(models.Model):
|
|||
pass
|
||||
|
||||
def save(self, *args, **kwargs):
|
||||
self.last_changed = datetime.now()
|
||||
# If content is empty look for a template with the given name and
|
||||
# populate the template instance with its content.
|
||||
if settings.DBTEMPLATES_AUTO_POPULATE_CONTENT and not self.content:
|
||||
self.populate()
|
||||
super().save(*args, **kwargs)
|
||||
super(Template, self).save(*args, **kwargs)
|
||||
|
||||
|
||||
def add_default_site(instance, **kwargs):
|
||||
|
|
|
|||
|
|
@ -1,175 +0,0 @@
|
|||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
from unittest import mock
|
||||
|
||||
from django.conf import settings as django_settings
|
||||
from django.core.cache.backends.base import BaseCache
|
||||
from django.core.management import call_command
|
||||
from django.template import loader, TemplateDoesNotExist
|
||||
from django.test import TestCase
|
||||
|
||||
from django.contrib.sites.models import Site
|
||||
|
||||
from dbtemplates.conf import settings
|
||||
from dbtemplates.models import Template
|
||||
from dbtemplates.utils.cache import get_cache_backend, get_cache_key
|
||||
from dbtemplates.utils.template import (get_template_source,
|
||||
check_template_syntax)
|
||||
from dbtemplates.management.commands.sync_templates import (FILES_TO_DATABASE,
|
||||
DATABASE_TO_FILES)
|
||||
|
||||
|
||||
class DbTemplatesTestCase(TestCase):
|
||||
def setUp(self):
|
||||
self.old_TEMPLATES = settings.TEMPLATES
|
||||
if 'dbtemplates.loader.Loader' not in settings.TEMPLATES:
|
||||
loader.template_source_loaders = None
|
||||
settings.TEMPLATES = list(settings.TEMPLATES) + [
|
||||
'dbtemplates.loader.Loader'
|
||||
]
|
||||
|
||||
self.site1, created1 = Site.objects.get_or_create(
|
||||
domain="example.com", name="example.com")
|
||||
self.site2, created2 = Site.objects.get_or_create(
|
||||
domain="example.org", name="example.org")
|
||||
self.t1, _ = Template.objects.get_or_create(
|
||||
name='base.html', content='base')
|
||||
self.t2, _ = Template.objects.get_or_create(
|
||||
name='sub.html', content='sub')
|
||||
self.t2.sites.add(self.site2)
|
||||
|
||||
def tearDown(self):
|
||||
loader.template_source_loaders = None
|
||||
settings.TEMPLATES = self.old_TEMPLATES
|
||||
|
||||
def test_basics(self):
|
||||
self.assertEqual(list(self.t1.sites.all()), [self.site1])
|
||||
self.assertTrue("base" in self.t1.content)
|
||||
self.assertEqual(list(Template.objects.filter(sites=self.site1)),
|
||||
[self.t1, self.t2])
|
||||
self.assertEqual(list(self.t2.sites.all()), [self.site1, self.site2])
|
||||
|
||||
def test_empty_sites(self):
|
||||
old_add_default_site = settings.DBTEMPLATES_ADD_DEFAULT_SITE
|
||||
try:
|
||||
settings.DBTEMPLATES_ADD_DEFAULT_SITE = False
|
||||
self.t3 = Template.objects.create(
|
||||
name='footer.html', content='footer')
|
||||
self.assertEqual(list(self.t3.sites.all()), [])
|
||||
finally:
|
||||
settings.DBTEMPLATES_ADD_DEFAULT_SITE = old_add_default_site
|
||||
|
||||
def test_load_templates_sites(self):
|
||||
old_add_default_site = settings.DBTEMPLATES_ADD_DEFAULT_SITE
|
||||
old_site_id = django_settings.SITE_ID
|
||||
try:
|
||||
settings.DBTEMPLATES_ADD_DEFAULT_SITE = False
|
||||
t_site1 = Template.objects.create(
|
||||
name='copyright.html', content='(c) example.com')
|
||||
t_site1.sites.add(self.site1)
|
||||
t_site2 = Template.objects.create(
|
||||
name='copyright.html', content='(c) example.org')
|
||||
t_site2.sites.add(self.site2)
|
||||
|
||||
django_settings.SITE_ID = Site.objects.create(
|
||||
domain="example.net", name="example.net").id
|
||||
Site.objects.clear_cache()
|
||||
|
||||
self.assertRaises(TemplateDoesNotExist,
|
||||
loader.get_template, "copyright.html")
|
||||
finally:
|
||||
django_settings.SITE_ID = old_site_id
|
||||
settings.DBTEMPLATES_ADD_DEFAULT_SITE = old_add_default_site
|
||||
|
||||
def test_load_templates(self):
|
||||
result = loader.get_template("base.html").render()
|
||||
self.assertEqual(result, 'base')
|
||||
result2 = loader.get_template("sub.html").render()
|
||||
self.assertEqual(result2, 'sub')
|
||||
|
||||
def test_error_templates_creation(self):
|
||||
call_command('create_error_templates', force=True, verbosity=0)
|
||||
self.assertEqual(list(Template.objects.filter(sites=self.site1)),
|
||||
list(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_sync_templates(self):
|
||||
old_template_dirs = settings.TEMPLATES[0].get('DIRS', [])
|
||||
temp_template_dir = tempfile.mkdtemp('dbtemplates')
|
||||
temp_template_path = os.path.join(temp_template_dir, 'temp_test.html')
|
||||
temp_template = open(temp_template_path, 'w', encoding='utf-8')
|
||||
try:
|
||||
temp_template.write('temp test')
|
||||
settings.TEMPLATES[0]['DIRS'] = (temp_template_dir,)
|
||||
# these works well if is not settings patched at runtime
|
||||
# for supporting django < 1.7 tests we must patch dirs in runtime
|
||||
from dbtemplates.management.commands import sync_templates
|
||||
sync_templates.DIRS = settings.TEMPLATES[0]['DIRS']
|
||||
|
||||
self.assertFalse(
|
||||
Template.objects.filter(name='temp_test.html').exists())
|
||||
call_command('sync_templates', force=True,
|
||||
verbosity=0, overwrite=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=DATABASE_TO_FILES)
|
||||
self.assertEqual('temp test modified',
|
||||
open(temp_template_path,
|
||||
encoding='utf-8').read())
|
||||
|
||||
call_command('sync_templates', force=True, verbosity=0,
|
||||
delete=True, overwrite=DATABASE_TO_FILES)
|
||||
self.assertTrue(os.path.exists(temp_template_path))
|
||||
self.assertFalse(
|
||||
Template.objects.filter(name='temp_test.html').exists())
|
||||
finally:
|
||||
temp_template.close()
|
||||
settings.TEMPLATES[0]['DIRS'] = old_template_dirs
|
||||
shutil.rmtree(temp_template_dir)
|
||||
|
||||
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')
|
||||
|
||||
def test_cache_invalidation(self):
|
||||
# Add t1 into the cache of site2
|
||||
self.t1.sites.add(self.site2)
|
||||
with mock.patch('django.contrib.sites.models.SiteManager.get_current',
|
||||
return_value=self.site2):
|
||||
result = loader.get_template("base.html").render()
|
||||
self.assertEqual(result, 'base')
|
||||
|
||||
# Update content
|
||||
self.t1.content = 'new content'
|
||||
self.t1.save()
|
||||
result = loader.get_template("base.html").render()
|
||||
self.assertEqual(result, 'new content')
|
||||
|
||||
# Cache invalidation should work across sites.
|
||||
# Site2 should see the new content.
|
||||
with mock.patch('django.contrib.sites.models.SiteManager.get_current',
|
||||
return_value=self.site2):
|
||||
result = loader.get_template("base.html").render()
|
||||
self.assertEqual(result, 'new content')
|
||||
|
|
@ -1,51 +1,18 @@
|
|||
DBTEMPLATES_CACHE_BACKEND = 'dummy://'
|
||||
|
||||
DATABASE_ENGINE = 'sqlite3'
|
||||
# SQLite does not support removing unique constraints (see #28)
|
||||
SOUTH_TESTS_MIGRATE = False
|
||||
|
||||
SITE_ID = 1
|
||||
|
||||
SECRET_KEY = 'something-something'
|
||||
|
||||
DATABASES = {
|
||||
'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',
|
||||
]
|
||||
|
||||
MIDDLEWARE = (
|
||||
'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',
|
||||
)
|
||||
|
||||
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',
|
||||
]
|
||||
}
|
||||
},
|
||||
]
|
||||
|
|
|
|||
107
dbtemplates/tests.py
Normal file
107
dbtemplates/tests.py
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
from __future__ import with_statement
|
||||
import codecs
|
||||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
|
||||
from django.core.cache.backends.base import BaseCache
|
||||
from django.core.management import call_command
|
||||
from django.template import loader, Context
|
||||
from django.test import TestCase
|
||||
|
||||
from django.contrib.sites.models import Site
|
||||
|
||||
from dbtemplates.conf import settings
|
||||
from dbtemplates.models import Template
|
||||
from dbtemplates.utils.cache import get_cache_backend
|
||||
from dbtemplates.utils.template import (get_template_source,
|
||||
check_template_syntax)
|
||||
from dbtemplates.management.commands.sync_templates import (FILES_TO_DATABASE,
|
||||
DATABASE_TO_FILES)
|
||||
|
||||
class DbTemplatesTestCase(TestCase):
|
||||
def setUp(self):
|
||||
self.site1, created1 = Site.objects.get_or_create(
|
||||
domain="example.com", name="example.com")
|
||||
self.site2, created2 = Site.objects.get_or_create(
|
||||
domain="example.org", name="example.org")
|
||||
self.t1, _ = Template.objects.get_or_create(
|
||||
name='base.html', content='base')
|
||||
self.t2, _ = Template.objects.get_or_create(
|
||||
name='sub.html', content='sub')
|
||||
self.t2.sites.add(self.site2)
|
||||
|
||||
def test_basiscs(self):
|
||||
self.assertEqual(list(self.t1.sites.all()), [self.site1])
|
||||
self.assertTrue("base" in self.t1.content)
|
||||
self.assertEqual(list(Template.objects.filter(sites=self.site1)),
|
||||
[self.t1, self.t2])
|
||||
self.assertEqual(list(self.t2.sites.all()), [self.site1, self.site2])
|
||||
|
||||
def test_empty_sites(self):
|
||||
old_add_default_site = settings.DBTEMPLATES_ADD_DEFAULT_SITE
|
||||
try:
|
||||
settings.DBTEMPLATES_ADD_DEFAULT_SITE = False
|
||||
self.t3 = Template.objects.create(
|
||||
name='footer.html', content='footer')
|
||||
self.assertEqual(list(self.t3.sites.all()), [])
|
||||
finally:
|
||||
settings.DBTEMPLATES_ADD_DEFAULT_SITE = old_add_default_site
|
||||
|
||||
def test_load_templates(self):
|
||||
result = loader.get_template("base.html").render(Context({}))
|
||||
self.assertEqual(result, 'base')
|
||||
result2 = loader.get_template("sub.html").render(Context({}))
|
||||
self.assertEqual(result2, 'sub')
|
||||
|
||||
def test_error_templates_creation(self):
|
||||
call_command('create_error_templates', force=True, verbosity=0)
|
||||
self.assertEqual(list(Template.objects.filter(sites=self.site1)),
|
||||
list(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_sync_templates(self):
|
||||
old_template_dirs = settings.TEMPLATE_DIRS
|
||||
temp_template_dir = tempfile.mkdtemp('dbtemplates')
|
||||
last_path_part = temp_template_dir.split('/')[-1]
|
||||
temp_template_path = os.path.join(temp_template_dir, 'temp_test.html')
|
||||
temp_template = codecs.open(temp_template_path, 'w')
|
||||
try:
|
||||
temp_template.write('temp test')
|
||||
settings.TEMPLATE_DIRS = (temp_template_dir,)
|
||||
self.assertFalse(Template.objects.filter(name='temp_test.html').exists())
|
||||
call_command('sync_templates',
|
||||
force=True, verbosity=0, overwrite=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=DATABASE_TO_FILES)
|
||||
self.assertTrue('modified' in codecs.open(temp_template_path).read())
|
||||
|
||||
call_command('sync_templates',
|
||||
force=True, verbosity=0, delete=True, overwrite=DATABASE_TO_FILES)
|
||||
self.assertTrue(os.path.exists(temp_template_path))
|
||||
self.assertFalse(Template.objects.filter(name='temp_test.html').exists())
|
||||
finally:
|
||||
temp_template.close()
|
||||
settings.TEMPLATE_DIRS = old_template_dirs
|
||||
shutil.rmtree(temp_template_dir)
|
||||
|
||||
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])
|
||||
|
|
@ -1,34 +1,23 @@
|
|||
from dbtemplates.conf import settings
|
||||
from django.core.cache import get_cache
|
||||
|
||||
from django.contrib.sites.models import Site
|
||||
from django.core import signals
|
||||
from django.template.defaultfilters import slugify
|
||||
|
||||
from dbtemplates.conf import settings
|
||||
|
||||
|
||||
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
|
||||
# the end of a request cycle. If not implemented in a particular backend
|
||||
# cache.close is a no-op
|
||||
signals.request_finished.connect(cache.close)
|
||||
return cache
|
||||
|
||||
return get_cache(settings.DBTEMPLATES_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 = Site.objects.get_current()
|
||||
return 'dbtemplates::%s::%s' % (name, current_site.pk)
|
||||
|
||||
|
||||
def get_cache_notfound_key(name):
|
||||
return get_cache_key(name) + "::notfound"
|
||||
return get_cache_key(name) + '::notfound'
|
||||
|
||||
|
||||
def remove_notfound_key(instance):
|
||||
|
|
@ -58,5 +47,4 @@ def remove_cached_template(instance, **kwargs):
|
|||
Called via Django's signals to remove cached templates, if the template
|
||||
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))
|
||||
|
|
|
|||
|
|
@ -1,13 +1,24 @@
|
|||
from django import VERSION
|
||||
from django.template import (Template, TemplateDoesNotExist,
|
||||
TemplateSyntaxError)
|
||||
TemplateSyntaxError)
|
||||
from django.utils.importlib import import_module
|
||||
|
||||
|
||||
def get_loaders():
|
||||
from django.template.loader import _engine_list
|
||||
loaders = []
|
||||
for engine in _engine_list():
|
||||
loaders.extend(engine.engine.template_loaders)
|
||||
return loaders
|
||||
from django.template.loader import template_source_loaders
|
||||
if template_source_loaders is None:
|
||||
try:
|
||||
from django.template.loader import (
|
||||
find_template as finder_func)
|
||||
except ImportError:
|
||||
from django.template.loader import (
|
||||
find_template_source as finder_func)
|
||||
try:
|
||||
source, name = finder_func('test')
|
||||
except TemplateDoesNotExist:
|
||||
pass
|
||||
from django.template.loader import template_source_loaders
|
||||
return template_source_loaders or []
|
||||
|
||||
|
||||
def get_template_source(name):
|
||||
|
|
@ -16,18 +27,33 @@ def get_template_source(name):
|
|||
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):
|
||||
continue
|
||||
module = import_module(loader.__module__)
|
||||
load_template_source = getattr(module, 'load_template_source', None)
|
||||
if load_template_source is None:
|
||||
load_template_source = loader.load_template_source
|
||||
try:
|
||||
source, origin = load_template_source(name)
|
||||
if source:
|
||||
return source
|
||||
except NotImplementedError:
|
||||
pass
|
||||
except TemplateDoesNotExist:
|
||||
pass
|
||||
if source is None and VERSION[:2] < (1, 2):
|
||||
# Django supported template source extraction still :/
|
||||
try:
|
||||
from django.template.loader import find_template_source
|
||||
template, origin = find_template_source(name, None)
|
||||
if not hasattr(template, 'render'):
|
||||
return template
|
||||
except (ImportError, TemplateDoesNotExist):
|
||||
pass
|
||||
return None
|
||||
|
||||
|
||||
def check_template_syntax(template):
|
||||
try:
|
||||
Template(template.content)
|
||||
except TemplateSyntaxError as e:
|
||||
except TemplateSyntaxError, e:
|
||||
return (False, e)
|
||||
return (True, None)
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ To enable one of them you need to specify a setting called
|
|||
.. note::
|
||||
Starting in version 1.0 ``dbtemplates`` allows you also to set the new
|
||||
dict-based ``CACHES`` setting, which was introduced in Django 1.3.
|
||||
|
||||
|
||||
All you have to do is to provide a new entry in the ``CACHES`` dict
|
||||
named ``'dbtemplates'``, e.g.::
|
||||
|
||||
|
|
@ -61,17 +61,8 @@ Short installation howto
|
|||
3. Sync your database with ``python manage.py syncdb``
|
||||
4. Set ``DBTEMPLATES_USE_REVERSION`` setting to ``True``
|
||||
|
||||
History compare view
|
||||
--------------------
|
||||
|
||||
You can also use ``dbtemplates`` together with `django-reversion-compare`_ which
|
||||
provides a history compare view to compare two versions of a model which is under
|
||||
reversion.
|
||||
|
||||
.. _django-reversion: https://github.com/etianen/django-reversion
|
||||
.. _django-reversion's documentation: https://django-reversion.readthedocs.io/en/latest/
|
||||
.. _django-reversion-compare: https://github.com/jedie/django-reversion-compare
|
||||
|
||||
.. _django-reversion's documentation: https://github.com/etianen/django-reversion/wiki/getting-started
|
||||
|
||||
.. _commands:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,114 +1,6 @@
|
|||
Changelog
|
||||
=========
|
||||
|
||||
v5.0 (unreleased)
|
||||
-----------------
|
||||
|
||||
.. warning::
|
||||
|
||||
This is a backwards-incompatible release!
|
||||
|
||||
* Dropped support for Python 3.7 and Django < 4.2.
|
||||
|
||||
* Added support for Python 3.11, 3.12, 3.13.
|
||||
|
||||
* Django 5.x support
|
||||
|
||||
v4.0 (2022-09-3)
|
||||
-----------------
|
||||
|
||||
.. warning::
|
||||
|
||||
This is a backwards-incompatible release!
|
||||
|
||||
* Dropped support for Python 2.7 and Django < 3.2.
|
||||
|
||||
* Added support for Python 3.8, 3.9, 3.10.
|
||||
|
||||
* Moved test runner to GitHub Actions:
|
||||
|
||||
http://github.com/jazzband/django-dbtemplates/actions
|
||||
|
||||
* Django 4.x support
|
||||
|
||||
v3.0 (2019-01-27)
|
||||
-----------------
|
||||
|
||||
.. warning::
|
||||
|
||||
This is a backwards-incompatible release!
|
||||
|
||||
* Dropped support for Django < 1.11.
|
||||
|
||||
* Added support for Django 2.0 and 2.1.
|
||||
|
||||
* Added support for Python 3.7.
|
||||
|
||||
* Recompiled Russian locale.
|
||||
|
||||
* Fixed byte string in migration file that caused the migration
|
||||
system to falsely think that there are new changes.
|
||||
|
||||
* Fixed string representation of template model, e.g. to improve
|
||||
readability in choice fields.
|
||||
|
||||
v2.0 (2016-09-29)
|
||||
-----------------
|
||||
|
||||
.. warning::
|
||||
|
||||
This is a backwards-incompatible release!
|
||||
|
||||
* Moved maintenance to the `Jazzband <https://jazzband.co/>`_
|
||||
|
||||
* Dropped support for Python 2.6
|
||||
|
||||
* Added support for Python 3.4 and 3.5
|
||||
|
||||
* Dropped support for Django < 1.8
|
||||
|
||||
* Removed South migrations. Please use Django's native migration system instead
|
||||
|
||||
* Removed the example project since it's out-of-date quickly
|
||||
|
||||
v1.3.2 (2015-06-15)
|
||||
-------------------
|
||||
|
||||
* support for Django 1.8 (not full, but usable)
|
||||
* support for RedactorJS
|
||||
|
||||
thanks for contrib - @eculver, @kmooney, @volksman
|
||||
|
||||
v1.3.1 (2012-05-23)
|
||||
-------------------
|
||||
|
||||
* Minor release to move away from nose again and use own
|
||||
`django-discover-runner`_.
|
||||
|
||||
.. _`django-discover-runner`: http://pypi.python.org/pypi/django-discover-runner
|
||||
|
||||
v1.3 (2012-05-07)
|
||||
-----------------
|
||||
|
||||
* Dropped support for Django < 1.3 **backwards incompatible**
|
||||
|
||||
* Dropped using versiontools in favor of home made solution.
|
||||
|
||||
* Added optional support for TinyMCE editor instead of the CodeMirror
|
||||
editor (just enable ``DBTEMPLATES_USE_TINYMCE``).
|
||||
|
||||
* Fixed compatibility to Django 1.4's handling of the ``DATABASES``
|
||||
setting. Should also respect database routers now.
|
||||
|
||||
* Fixed an issue of the cache key generation in combination with
|
||||
memcache's inability to stomach spaces.
|
||||
|
||||
* Moved test runner to use nose_ and a hosted CI project at Travis_:
|
||||
http://travis-ci.org/jazzband/django-dbtemplates
|
||||
|
||||
.. _nose: https://nose.readthedocs.io/
|
||||
.. _Travis: http://travis-ci.org
|
||||
|
||||
v1.2.1 (2011-09-07)
|
||||
-------------------
|
||||
|
||||
|
|
@ -244,7 +136,7 @@ v0.7.1 (2010-07-07)
|
|||
|
||||
* Fixed problem with the ``DBTEMPLATES_MEDIA_PREFIX`` setting, which defaults
|
||||
now to ``os.path.join(settings.MEDIA_ROOT, 'dbtemplates')`` now.
|
||||
|
||||
|
||||
In other words, if you don't specify a ``DBTEMPLATES_MEDIA_PREFIX`` setting
|
||||
and have the CodeMirror textarea enabled, dbtemplates will look in a
|
||||
subdirectory of your site's ``MEDIA_ROOT`` for the CodeMirror media files.
|
||||
|
|
@ -354,10 +246,10 @@ v0.5.0
|
|||
empty by using Django's other template loaders
|
||||
|
||||
* added caching backend system with two default backends:
|
||||
|
||||
|
||||
* ``FileSystemBackend``
|
||||
* ``DjangoCacheBackend``
|
||||
|
||||
|
||||
More about it in the `blog post`_ and in the docs.
|
||||
|
||||
.. _django-reversion: http://code.google.com/p/django-reversion/
|
||||
|
|
@ -425,4 +317,4 @@ Support
|
|||
|
||||
Please leave your questions and messages on the designated site:
|
||||
|
||||
http://github.com/jazzband/django-dbtemplates/issues/
|
||||
http://github.com/jezdez/django-dbtemplates/issues/
|
||||
|
|
|
|||
22
docs/conf.py
22
docs/conf.py
|
|
@ -1,3 +1,4 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# django-dbtemplates documentation build configuration file, created by
|
||||
# sphinx-quickstart on Fri Oct 9 14:52:11 2009.
|
||||
|
|
@ -15,7 +16,7 @@ import sys, os
|
|||
# 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 -----------------------------------------------------
|
||||
|
||||
|
|
@ -36,22 +37,17 @@ source_suffix = '.txt'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = 'django-dbtemplates'
|
||||
copyright = '2007-2019, Jannis Leidel and contributors'
|
||||
project = u'django-dbtemplates'
|
||||
copyright = u'2007-2011, 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
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
try:
|
||||
from dbtemplates import __version__
|
||||
# The short X.Y version.
|
||||
version = '.'.join(__version__.split('.')[:2])
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = __version__
|
||||
except ImportError:
|
||||
version = release = 'dev'
|
||||
version = '1.2'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.2.1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
@ -176,8 +172,8 @@ htmlhelp_basename = 'django-dbtemplatesdoc'
|
|||
# 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', u'django-dbtemplates Documentation',
|
||||
u'Jannis Leidel and contributors', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@ It also features optional support for :ref:`versioned storage <versioned>`
|
|||
and :ref:`django-admin command <commands>`, integrates with Django's
|
||||
:ref:`caching system <caching>` and the :ref:`admin actions <admin_actions>`.
|
||||
|
||||
Please see https://django-dbtemplates.readthedocs.io/ for more details.
|
||||
Please see http://django-dbtemplates.readthedocs.org/ for more details.
|
||||
|
||||
The source code and issue tracker can be found on Github: https://github.com/jazzband/django-dbtemplates
|
||||
The source code and issue tracker can be found on Github: https://github.com/jezdez/django-dbtemplates
|
||||
|
||||
.. _template loader: http://docs.djangoproject.com/en/dev/ref/templates/api/#loading-templates
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@ Setup
|
|||
=====
|
||||
|
||||
1. Get the source from the `Git repository`_ or install it from the
|
||||
Python Package Index by running ``pip install django-dbtemplates``.
|
||||
2. Edit the settings.py of your Django site:
|
||||
Python Package Index by running ``pip django-dbtemplates``.
|
||||
2. Follow the instructions in the INSTALL file
|
||||
3. Edit the settings.py of your Django site:
|
||||
|
||||
* Add ``dbtemplates`` to the ``INSTALLED_APPS`` setting
|
||||
|
||||
|
|
@ -23,54 +24,28 @@ Setup
|
|||
'dbtemplates',
|
||||
)
|
||||
|
||||
* Add ``dbtemplates.loader.Loader`` to the ``TEMPLATES.OPTIONS.loaders`` list
|
||||
* Add ``dbtemplates.loader.Loader`` to the ``TEMPLATE_LOADERS`` list
|
||||
in the settings.py of your Django project.
|
||||
|
||||
It should look something like this::
|
||||
|
||||
TEMPLATES = [
|
||||
{
|
||||
'BACKEND': 'django.template.backends.django.DjangoTemplates',
|
||||
'DIRS': [ # your template dirs here
|
||||
],
|
||||
'APP_DIRS': False,
|
||||
'OPTIONS': {
|
||||
'context_processors': [
|
||||
'django.contrib.auth.context_processors.auth',
|
||||
'django.template.context_processors.debug',
|
||||
'django.template.context_processors.i18n',
|
||||
'django.template.context_processors.media',
|
||||
'django.template.context_processors.static',
|
||||
'django.template.context_processors.tz',
|
||||
'django.contrib.messages.context_processors.messages',
|
||||
'django.template.context_processors.request',
|
||||
],
|
||||
'loaders': [
|
||||
'django.template.loaders.filesystem.Loader',
|
||||
'django.template.loaders.app_directories.Loader',
|
||||
'dbtemplates.loader.Loader',
|
||||
],
|
||||
},
|
||||
},
|
||||
]
|
||||
TEMPLATE_LOADERS = (
|
||||
'django.template.loaders.filesystem.Loader',
|
||||
'django.template.loaders.app_directories.Loader',
|
||||
'dbtemplates.loader.Loader',
|
||||
)
|
||||
|
||||
The order of ``TEMPLATES.OPTIONS.loaders`` is important. In the former
|
||||
example, templates from the database will be used as a fallback (ie. when
|
||||
the template does not exists in other locations). If you want the template
|
||||
from the database to be used to override templates in other locations,
|
||||
put ``dbtemplates.loader.Loader`` at the beginning of ``loaders``.
|
||||
4. Sync your database ``python manage.py syncdb``
|
||||
5. Restart your Django server
|
||||
|
||||
3. Sync your database ``python manage.py migrate``
|
||||
4. Restart your Django server
|
||||
|
||||
.. _Git repository: https://github.com/jazzband/django-dbtemplates/
|
||||
.. _Git repository: http://github.com/jezdez/django-dbtemplates/
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Creating database templates is pretty simple: Just open the admin interface
|
||||
of your Django-based site in your browser and click on "Templates" in the
|
||||
"Database templates" section.
|
||||
"Dbtemplates" section.
|
||||
|
||||
There you only need to fill in the ``name`` field with the identifier, Django
|
||||
is supposed to use while searching for templates, e.g.
|
||||
|
|
@ -84,3 +59,44 @@ other template loaders. For example, if you have a template called
|
|||
contents in the database, you just need to leave the content field empty to
|
||||
automatically populate it. That's especially useful if you don't want to
|
||||
copy and paste its content manually to the textarea.
|
||||
|
||||
Example
|
||||
=======
|
||||
|
||||
``dbtemplates`` comes with an example Django project that let's you try it
|
||||
out. The example uses Django's own `flatpages app`_ to enable you to create
|
||||
a simple page using ``dbtemplates``. Flat pages are a perfect fit to
|
||||
dbtemplates since they come prepackaged and are simple to use.
|
||||
|
||||
Here is how it works:
|
||||
|
||||
1. Open your command line and change to the ``example`` directory in the
|
||||
directory with the extracted source distribution.
|
||||
2. Run ``python manage.py syncdb`` and follow the instructions.
|
||||
3. Run ``python manage.py runserver`` and open your favorite browser with the
|
||||
address http://127.0.0.1:8000/admin/.
|
||||
4. Next add a new `Template` object in the ``dbtemplates`` section and use
|
||||
``flatpages/default.html`` as the value for the ``name`` field. For the
|
||||
``content`` field use this example::
|
||||
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>{{ flatpage.title }}</title>
|
||||
</head>
|
||||
<body>
|
||||
{{ flatpage.content }}
|
||||
</body>
|
||||
</html>
|
||||
|
||||
5. Return to the home screen of the admin interface and add a new flat page.
|
||||
Use ``/`` (yep, just a forward slash) and whatever ``title`` and
|
||||
``content`` you prefer. Please make sure you select the default site
|
||||
``example.com`` before you save the flat page.
|
||||
6. Visit http://127.0.0.1:8000/ and see the flat page you just created
|
||||
rendered with the ``flatpages/default.html`` template provided by
|
||||
``dbtemplates``.
|
||||
|
||||
.. _flatpages app: http://docs.djangoproject.com/en/dev/ref/contrib/flatpages/
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ Settings
|
|||
``DBTEMPLATES_ADD_DEFAULT_SITE``
|
||||
--------------------------------
|
||||
|
||||
``dbtemplates`` adds the current site (``settings.SITE_ID``) to the database
|
||||
template when it is created by default. You can disable this feature by
|
||||
``dbtemplates`` adds the current site (``settings.SITE_ID``) to the database
|
||||
template when it is created by default. You can disable this feature by
|
||||
setting ``DBTEMPLATES_ADD_DEFAULT_SITE`` to ``False``.
|
||||
|
||||
``DBTEMPLATES_AUTO_POPULATE_CONTENT``
|
||||
|
|
@ -28,24 +28,11 @@ The dotted Python path to the cache backend class. See
|
|||
A boolean, if enabled triggers the use of the CodeMirror based editor.
|
||||
Set to ``False`` by default.
|
||||
|
||||
``DBTEMPLATES_USE_TINYMCE``
|
||||
---------------------------
|
||||
|
||||
.. versionadded:: 1.3
|
||||
|
||||
A boolean, if enabled triggers the use of the TinyMCE based editor.
|
||||
Set to ``False`` by default.
|
||||
|
||||
``DBTEMPLATES_USE_REVERSION``
|
||||
-----------------------------
|
||||
|
||||
A boolean, if enabled triggers the use of ``django-reversion``.
|
||||
|
||||
``DBTEMPLATES_USE_REVERSION_COMPARE``
|
||||
-----------------------------
|
||||
|
||||
A boolean, if enabled triggers the use of ``django-reversion-compare``.
|
||||
|
||||
``DBTEMPLATES_MEDIA_PREFIX``
|
||||
----------------------------
|
||||
|
||||
|
|
|
|||
0
example/__init__.py
Normal file
0
example/__init__.py
Normal file
15
example/manage.py
Executable file
15
example/manage.py
Executable file
|
|
@ -0,0 +1,15 @@
|
|||
#!/usr/bin/env python
|
||||
import os, sys
|
||||
from django.core.management import execute_manager
|
||||
|
||||
sys.path.insert(0, os.path.abspath('./..'))
|
||||
|
||||
try:
|
||||
import settings # Assumed to be in the same directory.
|
||||
except ImportError:
|
||||
import sys
|
||||
sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__)
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
execute_manager(settings)
|
||||
2
example/requirements.txt
Normal file
2
example/requirements.txt
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
south
|
||||
django>=1.3
|
||||
113
example/settings.py
Normal file
113
example/settings.py
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
# Django settings for example project.
|
||||
import os, posixpath
|
||||
|
||||
PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
|
||||
|
||||
DEBUG = True
|
||||
TEMPLATE_DEBUG = DEBUG
|
||||
|
||||
ADMINS = (
|
||||
# ('Your Name', 'your_email@domain.com'),
|
||||
)
|
||||
|
||||
MANAGERS = ADMINS
|
||||
|
||||
DATABASE_ENGINE = 'sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
|
||||
DATABASE_NAME = 'example.db' # Or path to database file if using sqlite3.
|
||||
DATABASE_USER = '' # Not used with sqlite3.
|
||||
DATABASE_PASSWORD = '' # Not used with sqlite3.
|
||||
DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3.
|
||||
DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3.
|
||||
|
||||
DATABASES = {
|
||||
"default": {
|
||||
"ENGINE": "django.db.backends.sqlite3",
|
||||
"NAME": DATABASE_NAME,
|
||||
}
|
||||
}
|
||||
|
||||
# Local time zone for this installation. Choices can be found here:
|
||||
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
|
||||
# although not all choices may be available on all operating systems.
|
||||
# If running in a Windows environment this must be set to the same as your
|
||||
# system time zone.
|
||||
TIME_ZONE = 'America/Chicago'
|
||||
|
||||
# Language code for this installation. All choices can be found here:
|
||||
# http://www.i18nguy.com/unicode/language-identifiers.html
|
||||
LANGUAGE_CODE = 'en-us'
|
||||
|
||||
SITE_ID = 1
|
||||
|
||||
# If you set this to False, Django will make some optimizations so as not
|
||||
# to load the internationalization machinery.
|
||||
USE_I18N = True
|
||||
|
||||
# Absolute path to the directory that holds media.
|
||||
# Example: "/home/media/media.lawrence.com/"
|
||||
MEDIA_ROOT = os.path.join(PROJECT_ROOT, "site_media", "media")
|
||||
|
||||
# URL that handles the media served from MEDIA_ROOT. Make sure to use a
|
||||
# trailing slash if there is a path component (optional in other cases).
|
||||
# Examples: "http://media.lawrence.com", "http://example.com/media/"
|
||||
MEDIA_URL = "/site_media/media/"
|
||||
|
||||
# Absolute path to the directory that holds static files like app media.
|
||||
# Example: "/home/media/media.lawrence.com/apps/"
|
||||
STATIC_ROOT = os.path.join(PROJECT_ROOT, "site_media", "static")
|
||||
|
||||
# URL that handles the static files like app media.
|
||||
# Example: "http://media.lawrence.com"
|
||||
STATIC_URL = "/site_media/static/"
|
||||
|
||||
# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
|
||||
# trailing slash.
|
||||
# Examples: "http://foo.com/media/", "/media/".
|
||||
ADMIN_MEDIA_PREFIX = posixpath.join(STATIC_URL, "admin/")
|
||||
|
||||
# Make this unique, and don't share it with anybody.
|
||||
SECRET_KEY = 'e-%(1e1f8ar2v)_8d!%-75a2ag(w(ht*l%n-wts5$li!5=97)8'
|
||||
|
||||
# List of callables that know how to import templates from various sources.
|
||||
TEMPLATE_LOADERS = (
|
||||
'django.template.loaders.filesystem.Loader',
|
||||
'django.template.loaders.app_directories.Loader',
|
||||
'django.template.loaders.eggs.Loader',
|
||||
'dbtemplates.loader.Loader',
|
||||
)
|
||||
|
||||
MIDDLEWARE_CLASSES = (
|
||||
'django.middleware.common.CommonMiddleware',
|
||||
'django.contrib.sessions.middleware.SessionMiddleware',
|
||||
'django.contrib.auth.middleware.AuthenticationMiddleware',
|
||||
'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',
|
||||
)
|
||||
|
||||
ROOT_URLCONF = 'example.urls'
|
||||
|
||||
TEMPLATE_DIRS = (
|
||||
# Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
|
||||
# Always use forward slashes, even on Windows.
|
||||
# Don't forget to use absolute paths, not relative paths.
|
||||
)
|
||||
|
||||
INSTALLED_APPS = (
|
||||
'django.contrib.auth',
|
||||
'django.contrib.contenttypes',
|
||||
'django.contrib.sessions',
|
||||
'django.contrib.sites',
|
||||
'django.contrib.admin',
|
||||
'django.contrib.flatpages',
|
||||
'django.contrib.staticfiles',
|
||||
'dbtemplates',
|
||||
'south',
|
||||
#'reversion',
|
||||
)
|
||||
|
||||
# Uncomment the following two settings to use the file system cache backend.
|
||||
# It will cache in the directory "cache" inside the example project directory.
|
||||
DBTEMPLATES_CACHE_BACKEND = "locmem://"
|
||||
|
||||
DBTEMPLATES_MEDIA_PREFIX = posixpath.join(STATIC_URL, "dbtemplates/")
|
||||
DBTEMPLATES_USE_CODEMIRROR = True
|
||||
|
||||
18
example/urls.py
Normal file
18
example/urls.py
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
from django.conf import settings
|
||||
from django.conf.urls.defaults import patterns, include
|
||||
|
||||
# Uncomment the next two lines to enable the admin:
|
||||
from django.contrib import admin
|
||||
admin.autodiscover()
|
||||
|
||||
urlpatterns = patterns('',
|
||||
# Example:
|
||||
# (r'^example/', include('example.foo.urls')),
|
||||
|
||||
# Uncomment the admin/doc line below and add 'django.contrib.admindocs'
|
||||
# to INSTALLED_APPS to enable admin documentation:
|
||||
# (r'^admin/doc/', include('django.contrib.admindocs.urls')),
|
||||
|
||||
# Uncomment the next line to enable the admin:
|
||||
(r'^admin/', include(admin.site.urls)),
|
||||
)
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
[build-system]
|
||||
requires = [
|
||||
"setuptools>=61.2",
|
||||
"setuptools_scm",
|
||||
]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "django-dbtemplates"
|
||||
authors = [{name = "Jannis Leidel", email = "jannis@leidel.info"}]
|
||||
description = "Template loader for templates stored in the database"
|
||||
readme = "README.rst"
|
||||
classifiers = [
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Environment :: Web Environment",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: BSD License",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3 :: Only",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Framework :: Django",
|
||||
]
|
||||
requires-python = ">=3.8"
|
||||
dependencies = ["django-appconf >= 0.4"]
|
||||
dynamic = ["version"]
|
||||
|
||||
[project.urls]
|
||||
Documentation = "https://django-dbtemplates.readthedocs.io/"
|
||||
Changelog = "https://django-dbtemplates.readthedocs.io/en/latest/changelog.html"
|
||||
Source = "https://github.com/jazzband/django-dbtemplates"
|
||||
|
||||
[tool.setuptools]
|
||||
zip-safe = false
|
||||
include-package-data = false
|
||||
|
||||
[tool.setuptools.packages]
|
||||
find = {namespaces = false}
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
dbtemplates = [
|
||||
"locale/*/LC_MESSAGES/*",
|
||||
"static/dbtemplates/css/*.css",
|
||||
"static/dbtemplates/js/*.js",
|
||||
]
|
||||
|
|
@ -1 +0,0 @@
|
|||
django
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
flake8
|
||||
coverage
|
||||
13
setup.cfg
Normal file
13
setup.cfg
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
[egg_info]
|
||||
#tag_build = a1
|
||||
|
||||
[build_sphinx]
|
||||
source-dir = docs/
|
||||
build-dir = docs/_build
|
||||
all_files = 1
|
||||
|
||||
[upload_docs]
|
||||
upload-dir = docs/_build/html
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = docs/_build/html
|
||||
39
setup.py
Normal file
39
setup.py
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
import codecs
|
||||
from os import path
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
read = lambda filepath: codecs.open(filepath, 'r', 'utf-8').read()
|
||||
|
||||
setup(
|
||||
name='django-dbtemplates',
|
||||
version=':versiontools:dbtemplates:',
|
||||
description='Template loader for templates stored in the database',
|
||||
long_description=read(path.join(path.dirname(__file__), 'README.rst')),
|
||||
author='Jannis Leidel',
|
||||
author_email='jannis@leidel.info',
|
||||
url='http://django-dbtemplates.readthedocs.org/',
|
||||
packages=find_packages(exclude=['example']),
|
||||
zip_safe=False,
|
||||
package_data = {
|
||||
'dbtemplates': [
|
||||
'locale/*/LC_MESSAGES/*',
|
||||
'static/dbtemplates/css/*.css',
|
||||
'static/dbtemplates/js/*.js',
|
||||
],
|
||||
},
|
||||
classifiers=[
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Environment :: Web Environment',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: BSD License',
|
||||
'Operating System :: OS Independent',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 2',
|
||||
'Programming Language :: Python :: 2.5',
|
||||
'Programming Language :: Python :: 2.6',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Framework :: Django',
|
||||
],
|
||||
install_requires=['django-appconf >= 0.4'],
|
||||
setup_requires=['versiontools >= 1.5'],
|
||||
)
|
||||
94
tox.ini
94
tox.ini
|
|
@ -1,61 +1,51 @@
|
|||
[tox]
|
||||
minversion = 4.0
|
||||
distribute = false
|
||||
envlist =
|
||||
flake8
|
||||
py3{8,9,10,11,12}-dj42
|
||||
py3{10,11,12}-dj{50}
|
||||
py3{10,11,12,13}-dj{51,52}
|
||||
py3{12,13}-dj{main}
|
||||
coverage
|
||||
|
||||
[gh-actions]
|
||||
python =
|
||||
3.8: py38
|
||||
3.9: py39
|
||||
3.10: py310
|
||||
3.10: py310, flake8
|
||||
3.11: py311
|
||||
3.12: py312
|
||||
3.13: py313
|
||||
py25-1.2.X, py26-1.2.X, py27-1.2.X,
|
||||
py25-1.3.X, py26-1.3.X, py27-1.3.X
|
||||
|
||||
[testenv]
|
||||
skipsdist = true
|
||||
package = editable
|
||||
basepython =
|
||||
py38: python3.8
|
||||
py39: python3.9
|
||||
py310: python3.10
|
||||
py311: python3.11
|
||||
py312: python3.12
|
||||
py313: python3.13
|
||||
setenv =
|
||||
DJANGO_SETTINGS_MODULE = dbtemplates.test_settings
|
||||
downloadcache = {toxworkdir}/_download/
|
||||
commands =
|
||||
{envbindir}/coverage erase
|
||||
{envbindir}/coverage run --branch --source=dbtemplates {envbindir}/django-admin.py test {posargs:dbtemplates} --settings=dbtemplates.test_settings
|
||||
{envbindir}/coverage report --omit=*test*
|
||||
{envbindir}/coverage html --omit=*test* -d {envtmpdir}
|
||||
echo "Type the following to open the coverage report: python -m webbrowser -t file://{envtmpdir}/index.html"
|
||||
|
||||
[testenv:py25-1.2.X]
|
||||
basepython = python2.5
|
||||
deps =
|
||||
-r requirements/tests.txt
|
||||
dj42: Django>=4.2,<4.3
|
||||
dj50: Django>=5.0,<5.1
|
||||
dj51: Django>=5.1,<5.2
|
||||
dj52: Django>=5.2,<5.3
|
||||
djmain: https://github.com/django/django/archive/main.tar.gz#egg=django
|
||||
coverage
|
||||
django==1.2.5
|
||||
|
||||
commands =
|
||||
python --version
|
||||
python -c "import django ; print(django.VERSION)"
|
||||
coverage run --branch --parallel-mode {envbindir}/django-admin test -v2 {posargs:dbtemplates}
|
||||
[testenv:py26-1.2.X]
|
||||
basepython = python2.6
|
||||
deps =
|
||||
coverage
|
||||
django==1.2.5
|
||||
|
||||
[testenv:coverage]
|
||||
basepython = python3.10
|
||||
deps = coverage
|
||||
commands =
|
||||
coverage combine
|
||||
coverage report
|
||||
coverage xml
|
||||
[testenv:py27-1.2.X]
|
||||
basepython = python2.7
|
||||
deps =
|
||||
coverage
|
||||
django==1.2.5
|
||||
|
||||
[testenv:flake8]
|
||||
basepython = python3.10
|
||||
commands = flake8 dbtemplates
|
||||
deps = flake8
|
||||
|
||||
[flake8]
|
||||
exclude=.tox
|
||||
ignore=E501,E127,E128,E124
|
||||
[testenv:py25-1.3.X]
|
||||
basepython = python2.5
|
||||
deps =
|
||||
coverage
|
||||
django==1.3
|
||||
|
||||
[testenv:py26-1.3.X]
|
||||
basepython = python2.6
|
||||
deps =
|
||||
coverage
|
||||
django==1.3
|
||||
|
||||
[testenv:py27-1.3.X]
|
||||
basepython = python2.7
|
||||
deps =
|
||||
coverage
|
||||
django==1.3
|
||||
|
|
|
|||
Loading…
Reference in a new issue