Admindocs doesn't account for template loaders

[Aymeric Augustin]

TemplateDetailView only considers dirs and assumes that the filesystem loader is enabled. It doesn't account for other loaders such as app_directories.

The code changed a bit during the multiple-template-engines refactor but this bug existed before and still exists.

[Kris Avi]

It seems it is quite fixable with something like that:

That is probably not the most elegant solution. Tried to get loaders from all the engines and combine their location directories into one to send to enumerator.

            ...
            pass
        else:
            # This doesn't account for template loaders (#24128).

            # Fix for #24128
            from django.template import engines
            directories = set(default_engine.dirs)                    # making set with default engine dirs parameter as initial set
            for engine in engines.all():                              # going through all the engines
                for loader in engine.engine.template_loaders:         # getting each template loader from engine
                    directories.update(loader.get_dirs())             # updating set with new directories from loaders

            for index, directory in enumerate(directories):           # new enumerator with all dirs from default and loaders
            # for index, directory in enumerate(default_engine.dirs): # commented out original enumerator
            # End of fix for #24128
                template_file = os.path.join(directory, template)
                templates.append({
                ...

instead of

            ...
            pass
        else:
            # This doesn't account for template loaders (#24128).
            for index, directory in enumerate(default_engine.dirs):
                template_file = os.path.join(directory, template)
                templates.append({
                ...

[Tim Graham]

​PR without tests.

[Gunnar Ahlberg]

I tested this patch. It works nicely for me

[Alexander Lazarević]

I applied the patch and all tests pass on my machine.

[Alexander Lazarević]

As an example I get the following for http://localhost:8000/admin/doc/templates/base.html/ without the patch:

Template: "base.html"
Search path for template "base.html":

    /home/laza/Projects/Django/empty/templates/base.html

and with the patch:

Template: "base.html"
Search path for template "base.html":

    /home/laza/Projects/Django/django/django/contrib/admin/templates/base.html (does not exist)
    /home/laza/Projects/Django/empty/templates/base.html
    /home/laza/Projects/Django/django/django/contrib/admindocs/templates/base.html (does not exist)
    /home/laza/Projects/Django/django/django/contrib/auth/templates/base.html (does not exist)

So that's what the fix is about? Right now I'm not sure how to write a test for this.

[Alexander Lazarević]

Just saw that there is also an old PR for the ticket: ​https://github.com/django/django/pull/7434

[Alexander Lazarević]

I created a new (draft) PR: ​https://github.com/django/django/pull/17725

[Alexander Lazarević]

I applied the recommendations on the PR

[Mariusz Felisiak <felisiak.mariusz@…>]

In b7154f8:

Fixed #24128 -- Made admindocs TemplateDetailView respect template_loaders.

Co-Authored-By: Author: Alexander Lazarević <laza@…>