jinja2.nodes.Filter Class Reference

Inheritance diagram for jinja2.nodes.Filter:

Collaboration diagram for jinja2.nodes.Filter:

Public Member Functions
t.Any	as_const (self, t.Optional[EvalContext] eval_ctx=None)
Public Member Functions inherited from jinja2.nodes.Expr
bool	can_assign (self)
Public Member Functions inherited from jinja2.nodes.Node
None	__init__ (self, *t.Any fields, **t.Any attributes)
t.Iterator[t.Tuple[str, t.Any]]	iter_fields (self, t.Optional[t.Container[str]] exclude=None, t.Optional[t.Container[str]] only=None)
t.Iterator["Node"]	iter_child_nodes (self, t.Optional[t.Container[str]] exclude=None, t.Optional[t.Container[str]] only=None)
t.Optional[_NodeBound]	find (self, t.Type[_NodeBound] node_type)
t.Iterator[_NodeBound]	find_all (self, t.Union[t.Type[_NodeBound], t.Tuple[t.Type[_NodeBound],...]] node_type)
"Node"	set_ctx (self, str ctx)
"Node"	set_lineno (self, int lineno, bool override=False)
"Node"	set_environment (self, "Environment" environment)
bool	__eq__ (self, t.Any other)
str	__repr__ (self)
str	dump (self)
Public Member Functions inherited from jinja2.nodes.NodeType
	__new__ (mcs, name, bases, d)

Static Public Attributes
t	node .Optional[Expr]
Static Public Attributes inherited from jinja2.nodes._FilterTestCommon
tuple	fields = ("node", "name", "args", "kwargs", "dyn_args", "dyn_kwargs")
Expr	node
str	name
t	args .List[Expr]
t	kwargs .List[Pair]
t	dyn_args .Optional[Expr]
t	dyn_kwargs .Optional[Expr]
bool	abstract = True
Static Public Attributes inherited from jinja2.nodes.Expr
bool	abstract = True
Static Public Attributes inherited from jinja2.nodes.Node
tuple	fields = ()
tuple	attributes = ("lineno", "environment")
bool	abstract = True
int	lineno
t	environment .Optional["Environment"]

Additional Inherited Members
Public Attributes inherited from jinja2.nodes.Node
	fields
Static Protected Attributes inherited from jinja2.nodes._FilterTestCommon
bool	_is_filter = True

Detailed Description

Apply a filter to an expression. ``name`` is the name of the
filter, the other fields are the same as :class:`Call`.

If ``node`` is ``None``, the filter is being used in a filter block
and is applied to the content of the block.

Member Function Documentation

as_const()

t.Any jinja2.nodes.Filter.as_const	(		self,
		t.Optional[EvalContext]	eval_ctx = None
	)

Return the value of the expression as constant or raise
:exc:`Impossible` if this was not possible.

An :class:`EvalContext` can be provided, if none is given
a default context is created which requires the nodes to have
an attached environment.

.. versionchanged:: 2.4
   the `eval_ctx` parameter was added.

Reimplemented from jinja2.nodes._FilterTestCommon.

---

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

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