Django Template Analyzer - Extract template nodes from a Django template
Project description
django-template-analyzer
The template_analyzer package offers an API to analyze the Django template structure. It can be used to find nodes of a particular type, e.g. to do automatic detection of placeholder tags.
Supported features
The scanner finds tags in various situations, including:
Extend nodes
Include nodes
Overwritten blocks with new definitions
Blocks with or without {{ block.super }}
Reorganized blocks
Ignoring nodes outside blocks in extending templates
Handling multiple levels of super includes
The returned nodes are provided in a natural ordering, as they would be expected to appear in the outputted page.
While Django offers a template.nodelist.get_nodes_of_type() function, this function does not produce the same results.
API example
from django.template.loader import get_template
from mycms.templatetags.placeholdertags import Placeholder
from template_analyzer.djangoanalyzer import get_node_instances
# Load a Django template
template = get_template("mycms/default-page.html")
# Find all tags in the template:
placeholders = get_node_instances(template, Placeholder)
# Read information from the template tag themselves:
# (this is an example, accessing a custom method on the Placeholder object)
placeholder_names = [p.get_name() for p in placeholders]
Installation
First install the module, preferably in a virtual environment. It can be installed from PyPI:
pip install django-template-analyzer
Or the current folder can be installed:
pip install .
Credits
This package is based on the work of Django CMS.
Many thanks to the contributors of cms/utils/placeholder.py / cms/utils/plugins.py in Django CMS!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-template-analyzer-2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aacacf114a23f65b3f967319fb49284b413a9596652bc6594b63aba82db06b89 |
|
MD5 | ba9922185fc70286a65d9ae7bdb6885f |
|
BLAKE2b-256 | 2e6a3b16854a12743c0896b9837eb338537a6dbc47b01c897f8410814c08cfdc |
Hashes for django_template_analyzer-2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f528ee9712c508bdec31f36a57a69c85a704b3df723454cc43786af908b758cb |
|
MD5 | 6325598aff30941ba4cf8e0e773acd36 |
|
BLAKE2b-256 | b194b6bc4929010486826b6c750b9a32bc87a7d6291c3a2b51d836c154ce74c1 |