jinja2.nativetypes.NativeTemplate Class Reference

Inheritance diagram for jinja2.nativetypes.NativeTemplate:

Collaboration diagram for jinja2.nativetypes.NativeTemplate:

Public Member Functions
t.Any	render (self, *t.Any args, **t.Any kwargs)
t.Any	render_async (self, *t.Any args, **t.Any kwargs)
Public Member Functions inherited from jinja2.environment.Template
t.Any	__new__ (cls, t.Union[str, nodes.Template] source, str block_start_string=BLOCK_START_STRING, str block_end_string=BLOCK_END_STRING, str variable_start_string=VARIABLE_START_STRING, str variable_end_string=VARIABLE_END_STRING, str comment_start_string=COMMENT_START_STRING, str comment_end_string=COMMENT_END_STRING, t.Optional[str] line_statement_prefix=LINE_STATEMENT_PREFIX, t.Optional[str] line_comment_prefix=LINE_COMMENT_PREFIX, bool trim_blocks=TRIM_BLOCKS, bool lstrip_blocks=LSTRIP_BLOCKS, "te.Literal['\\n', '\\r\\n', '\\r']" newline_sequence=NEWLINE_SEQUENCE, bool keep_trailing_newline=KEEP_TRAILING_NEWLINE, t.Sequence[t.Union[str, t.Type["Extension"]]] extensions=(), bool optimized=True, t.Type[Undefined] undefined=Undefined, t.Optional[t.Callable[..., t.Any]] finalize=None, t.Union[bool, t.Callable[[t.Optional[str]], bool]] autoescape=False, bool enable_async=False)
"Template"	from_code (cls, Environment environment, CodeType code, t.MutableMapping[str, t.Any] globals, t.Optional[t.Callable[[], bool]] uptodate=None)
"Template"	from_module_dict (cls, Environment environment, t.MutableMapping[str, t.Any] module_dict, t.MutableMapping[str, t.Any] globals)
"TemplateStream"	stream (self, *t.Any args, **t.Any kwargs)
t.Iterator[str]	generate (self, *t.Any args, **t.Any kwargs)
t.AsyncGenerator[str, object]	generate_async (self, *t.Any args, **t.Any kwargs)
Context	new_context (self, t.Optional[t.Dict[str, t.Any]] vars=None, bool shared=False, t.Optional[t.Mapping[str, t.Any]] locals=None)
"TemplateModule"	make_module (self, t.Optional[t.Dict[str, t.Any]] vars=None, bool shared=False, t.Optional[t.Mapping[str, t.Any]] locals=None)
"TemplateModule"	make_module_async (self, t.Optional[t.Dict[str, t.Any]] vars=None, bool shared=False, t.Optional[t.Mapping[str, t.Any]] locals=None)
"TemplateModule"	module (self)
int	get_corresponding_lineno (self, int lineno)
bool	is_up_to_date (self)
t.List[t.Tuple[int, int]]	debug_info (self)
str	__repr__ (self)

Static Public Attributes
	environment_class = NativeEnvironment
	template_class
Static Public Attributes inherited from jinja2.environment.Template
t	environment_class = Environment
Environment	environment
t	globals .MutableMapping[str, t.Any]
t	name .Optional[str]
t	filename .Optional[str]
t	blocks .Dict[str, t.Callable[[Context], t.Iterator[str]]]
t	root_render_func .Callable[[Context], t.Iterator[str]]

Additional Inherited Members
Public Attributes inherited from jinja2.environment.Template
	environment_class
	environment
	name
	blocks
	globals
	debug_info
Protected Member Functions inherited from jinja2.environment.Template
"Template"	_from_namespace (cls, Environment environment, t.MutableMapping[str, t.Any] namespace, t.MutableMapping[str, t.Any] globals)
"TemplateModule"	_get_default_module (self, t.Optional[Context] ctx=None)
"TemplateModule"	_get_default_module_async (self, t.Optional[Context] ctx=None)
Protected Attributes inherited from jinja2.environment.Template
	_module
Static Protected Attributes inherited from jinja2.environment.Template
t	_module .Optional["TemplateModule"]
str	_debug_info
t	_uptodate .Optional[t.Callable[[], bool]]

Member Function Documentation

render()

t.Any jinja2.nativetypes.NativeTemplate.render	(		self,
		*t.Any	args,
		**t.Any	kwargs
	)

Render the template to produce a native Python type. If the
result is a single node, its value is returned. Otherwise, the
nodes are concatenated as strings. If the result can be parsed
with :func:`ast.literal_eval`, the parsed value is returned.
Otherwise, the string is returned.

Reimplemented from jinja2.environment.Template.

render_async()

t.Any jinja2.nativetypes.NativeTemplate.render_async	(		self,
		*t.Any	args,
		**t.Any	kwargs
	)

This works similar to :meth:`render` but returns a coroutine
that when awaited returns the entire rendered template string.  This
requires the async feature to be enabled.

Example usage::

    await template.render_async(knights='that say nih; asynchronously')

Reimplemented from jinja2.environment.Template.

---

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

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