jinja2.ext.DebugExtension Class Reference

Inheritance diagram for jinja2.ext.DebugExtension:

Collaboration diagram for jinja2.ext.DebugExtension:

Public Member Functions
nodes.Output	parse (self, "Parser" parser)
Public Member Functions inherited from jinja2.ext.Extension
None	__init_subclass__ (cls)
None	__init__ (self, Environment environment)
"te.Self"	bind (self, Environment environment)
str	preprocess (self, str source, t.Optional[str] name, t.Optional[str] filename=None)
t.Union["TokenStream", t.Iterable["Token"]]	filter_stream (self, "TokenStream" stream)
nodes.ExtensionAttribute	attr (self, str name, t.Optional[int] lineno=None)
nodes.Call	call_method (self, str name, t.Optional[t.List[nodes.Expr]] args=None, t.Optional[t.List[nodes.Keyword]] kwargs=None, t.Optional[nodes.Expr] dyn_args=None, t.Optional[nodes.Expr] dyn_kwargs=None, t.Optional[int] lineno=None)

Static Public Attributes
dict	tags = {"debug"}
Static Public Attributes inherited from jinja2.ext.Extension
t	identifier .ClassVar[str]
t	tags = set()
int	priority = 100

Protected Member Functions
str	_render (self, Context context)

Additional Inherited Members
Public Attributes inherited from jinja2.ext.Extension
	identifier
	environment

Detailed Description

A ``{% debug %}`` tag that dumps the available variables,
filters, and tests.

.. code-block:: html+jinja

    <pre>{% debug %}</pre>

.. code-block:: text

    {'context': {'cycler': <class 'jinja2.utils.Cycler'>,
                 ...,
                 'namespace': <class 'jinja2.utils.Namespace'>},
     'filters': ['abs', 'attr', 'batch', 'capitalize', 'center', 'count', 'd',
                 ..., 'urlencode', 'urlize', 'wordcount', 'wordwrap', 'xmlattr'],
     'tests': ['!=', '<', '<=', '==', '>', '>=', 'callable', 'defined',
               ..., 'odd', 'sameas', 'sequence', 'string', 'undefined', 'upper']}

.. versionadded:: 2.11.0

Member Function Documentation

parse()

nodes.Output jinja2.ext.DebugExtension.parse	(		self,
		"Parser"	parser
	)

If any of the :attr:`tags` matched this method is called with the
parser as first argument.  The token the parser stream is pointing at
is the name token that matched.  This method has to return one or a
list of multiple nodes.

Reimplemented from jinja2.ext.Extension.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/jinja2/ext.py