Develop Reference

Django honeypot error template customization

I am using Django honeypot (https://github.com/jamesturk/django-honeypot) and was wondering how to customize the honeypot_error.html page (https://github.com/jamesturk/django-honeypot/blob/master/honeypot/templates/honeypot/honeypot_error.html), which is executed when honeypot detection gets tripped. Thanks!!

if you had honeypot_error.html with the same structured path
templates/honeypot/honeypot_error.html in your project it will take your page as default. (see the key point to note: here )
example:
package x define a template named toto.html in templates/myapp/toto.html
in your application, add a customized toto.html in templates/myapp/toto.html
when calling
python manage.py collectstatic
it will get your template and not the one provided by default by myapp

I can't comment on MSR974's answer so:
From Django's documentation on overriding templates:
from pathlib import Path
BASE_DIR = Path(__file__).resolve(strict=True).parent.parent
INSTALLED_APPS = [
...,
'blog',
...,
]
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [BASE_DIR / 'templates'],
'APP_DIRS': True,
...
},
]
Notice: "If you have app and project templates directories that both contain overrides, the default Django template loader will try to load the template from the project-level directory first. In other words, DIRS is searched before APP_DIRS."
As you read through the examples, keep in mind the distinction between APP and PROJECT templates and make sure you've configured your SETTINGS according to the chosen strategy.

Django registration of tag library not working

I try to register my custom template tag library in django, but unfortunately it isnt working!
I want to create a custom include-tag and followed the instruction at:
https://docs.djangoproject.com/en/1.11/howto/custom-template-tags/#howto-custom-template-tags-inclusion-tags
I have created an app called 'tag_lib' (installed in settings.py) to put my template tags in. In the app folder is a dictionary called 'templatetags' containing an empty __init__.py and my my_tags.py.
my_tags.py contains:
from django import template
register = template.Library()
#register.inclusion_tag(filename='navbar.html', takes_context=True)
def navbar_context(context):
return {
'some_var': context['some_var'],
}
When I restart my devserver and try to load the library with
{% load my_tags %} `
in a template, I'm getting the error:`
TemplateSyntaxError at /
'my_tags' is not a registered tag library. Must be one of:
admin_list
admin_modify
admin_static
admin_urls
cache
i18n
l10n
log
static
staticfiles
tz
Any idea where I made a mistake?
Thanks.

I faced this problem to.what i did was just stop the server run and just run it again.It seems that django does not initialize tags (or resources in general) while running the server.hope it helps.

According to django documentation:
Development server won’t automatically restart after adding the templatetags module, you will need to restart your server before you can use the tags or filters in templates.
So, to resolve the issue, you need restart development server.
Source: https://docs.djangoproject.com/en/3.0/howto/custom-template-tags/#code-layout

Just for a reminder, when using django under Windows, it is necessary to restart the development server (python.exe manage.py runserver) in at least two situations, which are:
when a new templatetag was created in an app
when static files were modified in the 'app/static/app/' folder
Hope this helps

I faced the same problem, but reloading the server doesn't work.
So I solved it by this:
at project/setting.py I wrote the next, at TEMPLATE I registered libraries:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [os.path.join(BASE_DIR, 'templates'), ],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
'libraries': {
'my_tags': 'app.templatetags.blog_tags',
}
},
},
]
And the server restarted by itself.

In Django 3.1 i solved it putting my py file inside templatetags folder inside my app. As the docs said. custom template tags.
The py file must have register = template.Library()
myapp/templatetags/mytags.py
in settings i have myapp inside INSTALLED_APPS array
Then in my template file
{% load mytags %}

How can I have a template folder outside my Django project

I'm working on an Open Source Django app and created some design for it. Now a customer wants to use it's own, copyrighted, design. After reading the Django docs I created a separate, private, GIT repository that I want to use for the new design. I got it almost working by adding 2 items to the settings; an extra entry to look for templates in a folder "funder_custom_templates" and an extra entry to look for static files in the same location. This is how I configured TEMPLATES and STATICFILES_DIR:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [
os.path.join(PROJECT_DIR, '..', '..', 'funder_custom_templates'),
os.path.join(PROJECT_DIR, 'templates'),
],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
'fundraiser.context_processors.cart',
],
},
},
]
STATICFILES_DIRS = [
os.path.join(PROJECT_DIR, '..', '..', 'funder_custom_templates','static'),
os.path.join(PROJECT_DIR, 'static'),
]
This works for overriding the base design located in the PROJECT_DIR/templates/base.html, when I create funder_customer_templates/base.html and for all the static files as expected. But I also want to override app specific template files like blog/templates/blog/blog_index_page.html
I tried to put these files in the root of funder_custom_templates and I tried to mimic the app folders structure in funder_custom_templates but that doesn't load the app specific templates. Is there a way to solve this?
Example project files, with the folder structure, located at: https://github.com/acidjunk/funder/tree/develop/

Since you are using the app_directories.Loader class to load templates (specified by setting 'APP_DIRS': True,), then for app specfic templates Django will iterate over your INSTALLED_APPS setting looking for a specific template file. The important thing here is that it does so in order.
So if you want to override blog/templates/blog/blog_index_page.html then you will need to have a custom_blog/templates/blog/blog_index_page.html inside an application that comes before blog.
I recommend wrapping up all custom static resources in their own django application and python package. This way you can simply install the package from its private repo and add it to the list of installed apps to override any static content and templates.
See Django's docs for more details on template loading: https://docs.djangoproject.com/en/1.9/ref/templates/api/#django.template.loaders.app_directories.Loader

Django Admin Panel

I am trying to set up a new blog. I want to keep all my project templates folder in the same folder as where my settings.py is. To do this I did the following...
[...]
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [os.path.join(BASE_DIR, "templates/")],
'APP_DIRS': False,
'OPTIONS': {
'context_processors': [
[...]
But now, my admin panel layout doesn't work. How can I circumvent the above solution when using the admin panel? I get the error
Exception Type: TemplateDoesNotExist
Exception Value: admin/login.html

By disabling APP_DIRS you're forcing Django to look for your templates in the templates folder of your basedir regardless of where the app specifies them. This will break any plugins and also prevents you from namespacing templates. Its generally a bad idea.
DIRS is a list, so you can specify multiple locations if desperately want to hold the templates in a different locationand maintain access to teh admin

Django 1.8 ignores DIRS, cannot find templates

Here is my TEMPLATES section in settings.py:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [
os.path.join(BASE_DIR, 'templates'),
],
'APP_DIRS': True,
'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',
],
},
},
]
I'm using template inside application directory and it works. But whenever I'm trying to extend it with layout from global templates directory (os.path.join(BASE_DIR, 'templates'), which exists, I tested), django raises TemplateDoesNotExist error. Here is Template-loader postmortem, which does not includes my DIRS directory:
Django tried loading these templates, in this order:
Using loader django.template.loaders.filesystem.Loader:
Using loader django.template.loaders.app_directories.Loader:
/usr/local/lib/python2.7/dist-packages/django/contrib/admin/templates/layouts/default.html (File does not exist)
/usr/local/lib/python2.7/dist-packages/django/contrib/auth/templates/layouts/default.html (File does not exist)
/home/foundation/public/foundation/foundation/event_request/templates/layouts/default.html (File does not exist)
**UPDATE: ** seems like apache loads django 1.5 instead of django 1.8. This might be a problem.

After log entry
Using loader django.template.loaders.filesystem.Loader:
loader should print all possible locations that it tried to find your template, like it was after similar log from app_directories loader. If there is no paths here, double check if your TEMPLATES setting is defined correctly, is not overwritten somewhere later in your settings or other files and if Django is loading that settings file correctly.
You can throw some exception to get 500 server error when DEBUG is set to True, on error page you will get handy list of all settings that Django sees.
Also check if your WSGI server is loading proper version of django, older versions doesn't have TEMPLATE setting (it was splitted between multiple settings).

Problem has to do with wrong virtualenv and actual use of Django 1.5.1 instead of 1.8. I'll save this post, maybe it will help someone with similar problem in future.