jinja2.nodes.Node

class documentation

class Node: (source)

Known subclasses: jinja2.nodes.Expr, jinja2.nodes.Helper, jinja2.nodes.Stmt, jinja2.nodes.Template

View In Hierarchy

Baseclass for all Jinja nodes. There are a number of nodes available of different types. There are four major types: - :class:`Stmt`: statements - :class:`Expr`: expressions - :class:`Helper`: helper nodes - :class:`Template`: the outermost wrapper node All nodes have fields and attributes. Fields may be other nodes, lists, or arbitrary values. Fields are passed to the constructor as regular positional arguments, attributes as keyword arguments. Each node has two attributes: `lineno` (the line number of the node) and `environment`. The `environment` attribute is set at the end of the parsing process for all nodes automatically.

Method __eq__ Undocumented
Method __init__ Undocumented
Method __repr__ Undocumented
Method dump Undocumented
Method find Find the first node of a given type. If no such node exists the return value is `None`.
Method find_all Find all the nodes of a given type. If the type is a tuple, the check is performed for any of the tuple items.
Method iter_child_nodes Iterates over all direct child nodes of the node. This iterates over all fields and yields the values of they are nodes. If the value of a field is a list all the nodes in that list are returned.
Method iter_fields This method iterates over all fields that are defined and yields ``(key, value)`` tuples. Per default all fields are returned, but it's possible to limit that to some fields by providing the `only` parameter or to exclude some using the `exclude` parameter...
Method set_ctx Reset the context of a node and all child nodes. Per default the parser will all generate nodes that have a 'load' context as it's the most common one. This method is used in the parser to set assignment targets and other nodes to a store context.
Method set_environment Set the environment for all nodes.
Method set_lineno Set the line numbers of the node and children.
Class Variable abstract Undocumented
Class Variable attributes Undocumented
Class Variable environment Undocumented
Class Variable fields Undocumented
Class Variable lineno Undocumented
def __eq__(self, other): (source)

Undocumented

Parameters
other:t.AnyUndocumented
Returns
boolUndocumented
def __init__(self, *fields, **attributes): (source)
overridden in jinja2.nodes.InternalName

Undocumented

Parameters
*fields:t.AnyUndocumented
**attributes:t.AnyUndocumented
def __repr__(self): (source)

Undocumented

Returns
strUndocumented
def dump(self): (source)

Undocumented

Returns
strUndocumented
def find(self, node_type): (source)

Find the first node of a given type. If no such node exists the return value is `None`.

Parameters
node_type:t.Type[_NodeBound]Undocumented
Returns
t.Optional[_NodeBound]Undocumented
def find_all(self, node_type): (source)

Find all the nodes of a given type. If the type is a tuple, the check is performed for any of the tuple items.

Parameters
node_type:t.Union[t.Type[_NodeBound], t.Tuple[t.Type[_NodeBound], ...]]Undocumented
Returns
t.Iterator[_NodeBound]Undocumented
def iter_child_nodes(self, exclude=None, only=None): (source)

Iterates over all direct child nodes of the node. This iterates over all fields and yields the values of they are nodes. If the value of a field is a list all the nodes in that list are returned.

Parameters
exclude:t.Optional[t.Container[str]]Undocumented
only:t.Optional[t.Container[str]]Undocumented
Returns
t.Iterator[Node]Undocumented
def iter_fields(self, exclude=None, only=None): (source)

This method iterates over all fields that are defined and yields ``(key, value)`` tuples. Per default all fields are returned, but it's possible to limit that to some fields by providing the `only` parameter or to exclude some using the `exclude` parameter. Both should be sets or tuples of field names.

Parameters
exclude:t.Optional[t.Container[str]]Undocumented
only:t.Optional[t.Container[str]]Undocumented
Returns
t.Iterator[t.Tuple[str, t.Any]]Undocumented
def set_ctx(self, ctx): (source)

Reset the context of a node and all child nodes. Per default the parser will all generate nodes that have a 'load' context as it's the most common one. This method is used in the parser to set assignment targets and other nodes to a store context.

Parameters
ctx:strUndocumented
Returns
NodeUndocumented
def set_environment(self, environment): (source)

Set the environment for all nodes.

Parameters
environment:EnvironmentUndocumented
Returns
NodeUndocumented
def set_lineno(self, lineno, override=False): (source)

Set the line numbers of the node and children.

Parameters
lineno:intUndocumented
override:boolUndocumented
Returns
NodeUndocumented
abstract: bool = (source)
overridden in jinja2.nodes.Expr, jinja2.nodes.Helper, jinja2.nodes.Stmt

Undocumented

attributes: t.Tuple[str, ...] = (source)

Undocumented

environment: t.Optional[Environment] = (source)

Undocumented

fields: t.Tuple[str, ...] = (source)
overridden in jinja2.nodes.Assign, jinja2.nodes.AssignBlock, jinja2.nodes.BinExpr, jinja2.nodes.Block, jinja2.nodes.Call, jinja2.nodes.CallBlock, jinja2.nodes.Compare, jinja2.nodes.Concat, jinja2.nodes.CondExpr, jinja2.nodes.Const, jinja2.nodes.Dict, jinja2.nodes.EnvironmentAttribute, jinja2.nodes.EvalContextModifier, jinja2.nodes.ExprStmt, jinja2.nodes.Extends, jinja2.nodes.ExtensionAttribute, jinja2.nodes.FilterBlock, jinja2.nodes.For, jinja2.nodes.FromImport, jinja2.nodes.Getattr, jinja2.nodes.Getitem, jinja2.nodes.If, jinja2.nodes.Import, jinja2.nodes.ImportedName, jinja2.nodes.Include, jinja2.nodes.InternalName, jinja2.nodes.Keyword, jinja2.nodes.List, jinja2.nodes.Macro, jinja2.nodes.MarkSafe, jinja2.nodes.MarkSafeIfAutoescape, jinja2.nodes.Name, jinja2.nodes.NSRef, jinja2.nodes.Operand, jinja2.nodes.Output, jinja2.nodes.OverlayScope, jinja2.nodes.Pair, jinja2.nodes.Scope, jinja2.nodes.Slice, jinja2.nodes.Template, jinja2.nodes.TemplateData, jinja2.nodes.Tuple, jinja2.nodes.UnaryExpr, jinja2.nodes.With, jinja2.nodes._FilterTestCommon

Undocumented

lineno: int = (source)

Undocumented