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!
Metadata
Release files for django-template-analyzer 2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-template-analyzer-2.1.tar.gz | 9.5 kB | Without provenance | Details for django-template-analyzer-2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| django_template_analyzer-2.1-py3-none-any.whl | Python 3 | none | any | Details for django_template_analyzer-2.1-py3-none-any.whl |
Total release size: 20.4 kB
Release files / django-template-analyzer-2.1.tar.gz
| Download URL | django-template-analyzer-2.1.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aacacf114a23f65b3f967319fb49284b413a9596652bc6594b63aba82db06b89
|
|
BLAKE2b-256 checksum How to use checksums |
2e6a3b16854a12743c0896b9837eb338537a6dbc47b01c897f8410814c08cfdc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.13
|
Release files / django_template_analyzer-2.1-py3-none-any.whl
| Download URL | django_template_analyzer-2.1-py3-none-any.whl |
|---|---|
| Size | 10.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f528ee9712c508bdec31f36a57a69c85a704b3df723454cc43786af908b758cb
|
|
BLAKE2b-256 checksum How to use checksums |
b194b6bc4929010486826b6c750b9a32bc87a7d6291c3a2b51d836c154ce74c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.13
|
Security for django-template-analyzer 2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.