OpenQuizz
Une application de gestion des contenus pédagogiques
Node Class Reference
Inheritance diagram for Node:
Collaboration diagram for Node:

Public Member Functions

def __init__ (self, *fields, **attributes)
 
def iter_fields (self, exclude=None, only=None)
 
def iter_child_nodes (self, exclude=None, only=None)
 
def find (self, node_type)
 
def find_all (self, node_type)
 
def set_ctx (self, ctx)
 
def set_lineno (self, lineno, override=False)
 
def set_environment (self, environment)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __repr__ (self)
 
def dump (self)
 
- Public Member Functions inherited from NodeType
def __new__ (mcs, name, bases, d)
 

Static Public Attributes

 fields
 
 attributes
 
 abstract
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
fields,
**  attributes 
)

Member Function Documentation

◆ __eq__()

def __eq__ (   self,
  other 
)

◆ __ne__()

def __ne__ (   self,
  other 
)

◆ __repr__()

def __repr__ (   self)

◆ dump()

def dump (   self)

◆ find()

def find (   self,
  node_type 
)
Find the first node of a given type.  If no such node exists the
return value is `None`.

◆ find_all()

def find_all (   self,
  node_type 
)
Find all the nodes of a given type.  If the type is a tuple,
the check is performed for any of the tuple items.

◆ iter_child_nodes()

def iter_child_nodes (   self,
  exclude = None,
  only = None 
)
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.

◆ iter_fields()

def iter_fields (   self,
  exclude = None,
  only = None 
)
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.

◆ set_ctx()

def set_ctx (   self,
  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.

◆ set_environment()

def set_environment (   self,
  environment 
)
Set the environment for all nodes.

◆ set_lineno()

def set_lineno (   self,
  lineno,
  override = False 
)
Set the line numbers of the node and children.

Field Documentation

◆ abstract

abstract
static

◆ attributes

attributes
static

◆ fields

fields
static

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