[Django] #17093: Refactor django.template to quarantine global state
Django
------------------------------------------------+------------------------
Reporter: carljm | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
The template engine keeps a lot of global state around: the instantiated
template loaders, the list of builtins, the cached list of loaded
templatetag modules. This makes it inflexible for use as a library (you
can't render different templates using different template loaders or
directories or tag modules in the same process) and makes test isolation
very difficult (for the same reasons).
This can be fixed via a refactoring to introduce a `TemplateEngine` class
to encapsulate all this state. We would still create a default module-
level instance of `TemplateEngine` based on the settings, and backwards-
compatibility wrappers for the current public API that delegate to the
default engine. But this would then allow alternative instances of
TemplateEngine to be created and used for library use and testing, that
would be self-contained and independent from settings.
In the long run, this type of refactoring is also necessary if we want to
move towards "app-object" style configuration in place of global settings.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Alex):
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:1>
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Bradley Ayers <bradley.ayers@…>):
* cc: bradley.ayers@… (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:2>
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by wayla):
* cc: waylan@… (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:3>
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by steveire):
For an equivalent API (in C++) see
http://www.grantlee.org/apidox/classGrantlee_1_1Engine.html.
It also allows the case of pre-loading template tag modules brought up
recently on the devel mailing list.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:4>
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by anatoly techtonik <techtonik@…>):
* cc: techtonik@… (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:5>
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by kmike):
* cc: kmike84@… (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:6>
Django
Type: Cleanup/optimization | Status: new
Component: Template system | Version: SVN
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by tgecho):
* cc: tgecho (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:7>
Django
Type: Cleanup/optimization | Status: new
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by yac):
* cc: yac (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:8>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Cleanup/optimization | Status: new
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by chrismedrela):
* owner: nobody => chrismedrela
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:9>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by anonymous):
See progress of my work at github
https://github.com/chrismedrela/django/tree/ticket_17093.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:10>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by chrismedrela):
That was me.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:11>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by chrismedrela):
I've started discussion at django-developers mailing list
https://groups.google.com/d/topic/django-
developers/WT1cOvpPbSM/discussion.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:12>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by chrismedrela):
I rebased my work. I kept old branch and created new one
(https://github.com/chrismedrela/django/tree/ticket_17093v2) where I'm
pushing my work. The branch is almost ready to review.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:13>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by chrismedrela):
Please watch new branch
(https://github.com/chrismedrela/django/tree/ticket_17093v3).
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:14>
Django
Reporter: carljm | Owner:
Type: | chrismedrela
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by techtonik):
What is exactly the scope of data that should encapsulated in
`TemplateEngine`, and what will be left behind?
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:15>
Django
Reporter: carljm | Owner: aaugustin
Type: | Status: assigned
Cleanup/optimization | Version: master
Component: Template system | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
Has patch: 0 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by aaugustin):
* owner: chrismedrela => aaugustin
* status: new => assigned
Comment:
I'm picking this up as part of my Multiple Template Engines project.
See https://github.com/aaugustin/django/compare/refactor-template-engine-
as-library
I'm going to perform a more intensive cleanup and reorganisation of
django.template.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:16>
Django
Reporter: carljm | Owner: aaugustin
Type: | Status: assigned
Cleanup/optimization | Version: master
Component: Template system | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by aaugustin):
* has_patch: 0 => 1
Comment:
PR: https://github.com/django/django/pull/3605
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:17>
Django
Reporter: carljm | Owner: aaugustin
Cleanup/optimization | Version: master
Component: Template system | Resolution: fixed
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
I assume this can be closed since the PR was committed. Please reopen if
there is still more work to do.
--
Ticket URL: <https://code.djangoproject.com/ticket/17093#comment:18>