Django 1.10.1 'my_templatetag' is not a registered tag library. Must be one of:

Question

I want a menu thats custom depending which group you are member of. Im using Django 1.10.1, allauth and so on. When im trying to make my templatetag it fails and it says:¨

TemplateSyntaxError at /
'my_templatetag' is not a registered tag library. Must be one of:
account
account_tags
admin_list
admin_modify
admin_static
admin_urls
cache
i18n
l10n
log
socialaccount
socialaccount_tags
static
staticfiles
tz

'my_templatetag.py' looks like this:

from django import template
from django.contrib.auth.models import Group


register = template.Library()

@register.filter(name='has_group')
def has_group(user, group_name):
    group =  Group.objects.get(name=group_name)
    return group in user.groups.all()

and tha error comes in my .html file which say,

{%  load my_templatetag %}

I have tried to restart the server like millions of times, also i tried to change all the names, and the app is a part of INSTALLED_APPS in settings.py. What am I doing wrong?

score 208 · Answer 1 · answered Mar 18 '17 at 23:24

208

Besides putting my_templatetag.py inside app_name/templatetags, make sure you restart the Django development server (or ensure it restarted itself) every time you modify template tags. If the server does not restart, Django won't register the tags.

answered Mar 18 '17 at 23:24

lmiguelvargasf

63,191
45
217
228

5

For me it was the missing ***__init__.py*** in the *templatetags folder*... – zypro Mar 22 '19 at 08:55
2

This. One can spend an embarrassingly long time debugging something that would work if you would just restart... – logicOnAbstractions May 04 '21 at 13:59

score 110 · Answer 2 · edited Jul 15 '21 at 15:53

110

From Django 1.9, you can load those new tags/filters in settings like this:

TEMPLATES = [
{
    'BACKEND': 'django.template.backends.django.DjangoTemplates',
    'DIRS': [],
    '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',
            'app.apptemplates.load_setting',
            
        ],
                
        'libraries':{
            'my_templatetag': 'app.templatetags.my_templatetag',
            
            }
    },
},

]

If you have templatetag dir in your project dir (not in an app dir), then above method is recommended.

Example-
enter image description here

Quoting: https://docs.djangoproject.com/en/3.2/howto/custom-template-tags/#:~:text=It%20also%20enables%20you%20to%20register%20tags%20without%20installing%20an%20application.

edited Jul 15 '21 at 15:53

Nimantha

6,405
6
28
69

answered Apr 19 '17 at 02:29

Dat TT

2,850
2
16
18

2

It worked for me as well. This could be actually the chosen answer for the question. I'm using the 2.0 version of django in case people wonder. – R.R.C. Feb 18 '18 at 23:41
this allowed me to use the custom tag for the entire project – dangel Jun 04 '19 at 01:32
this also works if you need to overwrite specific templatetags of a site-package – NiMeDia May 19 '20 at 11:54
4

This should be the answer: I use Django 3.x. – FearlessFuture May 28 '20 at 04:04
Where did you find this explanation. it doesn't say it in the docs but it was the only thing that worked for me. – benji8 Feb 18 '21 at 22:31
it didn't work for me "invalid template library specified. ImportError raised when trying to load...." – Conor Jul 07 '22 at 12:27

score 50 · Answer 3 · answered Nov 02 '17 at 21:44

50

Make sure you are not missing any of the following steps:

Create a folder called "templatetags" at the same level as models.py and views.py in your application folder
Your application must be in the INSTALLED_APPS in settings.py
The templatetags folder must have __init__.py
Restart the django server

answered Nov 02 '17 at 21:44

Heapify

2,581
17
17

1

It seems for me that all my apps require an apps.py and __init__.py to contain `default_app_config = 'custom_admin.apps.Config'`. Otherwise Django 1.10 is not loading templatetags. I don't see this explicitly in the docs though. – Chris Sattinger Feb 06 '18 at 16:30
Thanks! I had forgotten to add `__ini__.py`, but do you know why it used to work in Python3 but not in Python2? – Farzad Abdolhosseini Apr 05 '18 at 19:19
2

It's the restart that gets me every time! Thx for reminding me on #4 ^^ – Marc Apr 24 '18 at 16:05
Point #4 helped me "Restart the Django server,",so Django can identify the new template tags. – 0xFK Oct 27 '18 at 07:34
Forgot to restart. It worked. – JayB Nov 14 '22 at 18:00

Shamsul Arefin · Answer 4 · 2019-07-21T07:27:37.367

27

In my case the problem was, I was using {% load filter_method_name %}

I had to change to {% load filename %}

I then had to restart the server.

edited Jul 21 '19 at 07:27

answered Jul 17 '19 at 10:45

Shamsul Arefin

1,771
1
21
21

4

*Restart the server* , Such a simple solution for an annoying bug – Ahmed I. Elsayed Sep 29 '19 at 01:24
1

The filename was the one for me. Thanks! – ravioli May 08 '20 at 04:05
@ravioli yes, a really subtle thing to notice – Shamsul Arefin May 10 '20 at 20:31
Thank you! I totally overlooked this, as I had assumed that I needed to load the method and not the module itself. – Majestic Pixel Aug 21 '20 at 21:49
Restart the server – Rafi khan Jul 11 '21 at 17:18
@Rafikhan I did not post this solution before first trying only restart. I tried restarting , did not work. Then fixed my mistake in the code and restarted – Shamsul Arefin Jul 12 '21 at 06:00

score 10 · Answer 5 · edited Sep 02 '20 at 03:10

10

you have to manually stop the development server and start it again, so Django can identify the new template tags

edited Sep 02 '20 at 03:10

Arghya Sadhu

41,002
9
78
107

answered Sep 01 '20 at 22:00

anakyou

111
1
2

score 5 · Answer 6 · edited Feb 03 '19 at 00:19

5

Where is 'my_templatetag.py' stored? It should be stored in a directory called 'templatetags' which is within the app.

Please see: https://docs.djangoproject.com/en/dev/howto/custom-template-tags/ if that isn't the case.

edited Feb 03 '19 at 00:19

pyjavo

1,598
2
23
41

answered Nov 19 '16 at 00:35

zubhav

1,519
1
13
19

1

Thanks, it was the map name! – Sliljedal Nov 19 '16 at 16:02

score 5 · Answer 7 · answered Jan 09 '19 at 20:54

5

I am using Django 1.11, and I was having the same problem. Some of the answers here are right, but some things may be missing. Here is what I did:

Quoting a previous user:

Create a folder called "templatetags" at the same level as models.py and views.py in your application folder

Your application must be in the INSTALLED_APPS in settings.py

The templatetags folder must have init.py

But, before you re-start the Django server, add this to the file that contains the tags:

from django import template
register = template.Library()

Then you can re-start the server.

answered Jan 09 '19 at 20:54

Roddy P. Carbonell

858
1
11
16

This worked for me when I used '__init__.py' instead of 'init.py'. – William Sep 07 '19 at 19:14
What is the difference between the two? One is in bold the other is in normal font, can't understand your statement @William – aspiring1 Mar 01 '21 at 13:50
It looks like underscores are bolded now in stackoverflow comments :) I wrote __init__.py with two underscores either side of the 'init'. See Chris Shaw's answer as an example. – William Mar 01 '21 at 17:37

score 4 · Answer 8 · answered Aug 17 '17 at 06:40

4

Restart the django server. It worked for me after setting the templatetag folder within the app and template_name.py in the templatetag folder.

answered Aug 17 '17 at 06:40

Anish Ravula

41
1

score 3 · Answer 9 · answered Oct 17 '19 at 11:00

3

In case it helps someone, the issue in my case was that I was using quotes when trying to load the tag(s)

{%  load 'my_templatetag' %}  <!-- incorrect -->

instead of

{%  load my_templatetag %}  <!-- correct -->

Note: extends needs quotes around the filename but not load

answered Oct 17 '19 at 11:00

Anupam

14,950
19
67
94

This was my problem! – elplatt Feb 12 '20 at 00:15

score 1 · Answer 10 · edited Feb 03 '19 at 12:22

I know this is a bit old, but I ran into the same problem today. I found the solution in the docs: https://docs.djangoproject.com/en/dev/howto/custom-template-tags/

The app should contain a templatetags directory, at the same level as models.py, views.py, etc. If this doesn’t already exist, create it - don’t forget the __init__.py file to ensure the directory is treated as a Python package.

Simply copying the __init__.py from another location into the new templatetag's directory sorted it out.

score 1 · Answer 11 · answered Dec 18 '20 at 21:11

1

I solved this by adding a templatestag folder in the root with a filter.py file defining my filters, then I adjusted my settings.py.

Please check my complete answer regarding this issue in this similar thread

answered Dec 18 '20 at 21:11

LucianoBAF

189
2
6

score 0 · Answer 12 · answered Dec 12 '17 at 12:00

0

put my_templatetag.py inside app_name/templatetags then create init.py inside app_name/templatetags .. Then open terminal in project folder give command python manage.py shell

from app_name.templatetags import my_templatetag

answered Dec 12 '17 at 12:00

Kiran Bachhav.

13
3

inside templatetags folder crate blank file with name __init__.py – Kiran Bachhav. Dec 12 '17 at 12:02
2

Please [edit your answer](https://stackoverflow.com/posts/47772135/edit) to put all details into it and format it to be readable (use code formatting where appropriate). – Melebius Dec 12 '17 at 14:56

score 0 · Answer 13 · answered Jan 27 '18 at 03:50

0

you just cut/remove your code which written inside the (example templatetags/home.py) from home.py you remove your code and restart your server and again paste your code in home.py it will work.

answered Jan 27 '18 at 03:50

Rahul Verma

404
8
20

score 0 · Answer 14 · edited May 25 '21 at 16:17

0

The templatetags folder must have a __init__.py file in order to be a regular python package

Ensure that you also created the templatetags.py file next to the __init__.py file

edited May 25 '21 at 16:17

He3lixxx

3,263
1
12
31

answered May 25 '21 at 12:33

Shubham Patil

11
3

Still doesn't resolve anything – Conor Jul 07 '22 at 12:33

score 0 · Answer 15 · answered Jul 06 '22 at 08:19

For me, I had to register my customer Filter as this since my templatetags are outside of any app

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [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',
                'django.template.context_processors.media',
            ],
            # ! New Line
            'libraries':{
                'customFilter': 'templatetags.customFilter',
            }
        },
    },
]

score 0 · Answer 16 · answered Jun 24 '23 at 17:49

This Solved My Problem:

make sure templatetags folder exsist in main django project
use this line in INSTALLED_APPS in project settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
     ...
  
    'my_app.apps.AppConfig',
    
]

score 0 · Answer 17 · answered Aug 29 '23 at 12:41

0

I know this is old, but in your case you should try {% load has_group from my_templatetag %}

answered Aug 29 '23 at 12:41

Youssef Snoussi

118
12

score -1 · Answer 18 · answered Jun 15 '20 at 16:20

-1

at first stop the server.remove/cut the code from templatetags/tag.py and rewrite/paste it.then run the server.it worked for me

answered Jun 15 '20 at 16:20

shomit

1

2

How will cutting, then pasting back in the code help? If you see an error in the question's sample code, please point it out. – Ben Jun 15 '20 at 18:25

score -2 · Answer 19 · answered Dec 16 '20 at 08:24

-2

Yah, This problem you are currently facing because of older django version Or Complexly to write "Depreciation"

if You HAve These Types OF TAgs In Your template/ Html Files Change Them With..

> {{% load staticfiles %} or  {% load admin_static %}, {% load
> admin_static %}}

change with

{% load static %}

Get to The Point.. JUst SImply Perform These Replace All These from YOur BAse.html/or Any type Of HTML

answered Dec 16 '20 at 08:24

Ash

1
1

1

Can you correct this messy description? It's hard for me to understand your explanation. Please also correct the code formatting. See [answer] – Gander Dec 16 '20 at 09:17

Django 1.10.1 'my_templatetag' is not a registered tag library. Must be one of:

19 Answers19

if You HAve These Types OF TAgs In Your template/ Html Files Change Them With..

Linked