Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.template.TemplateEnvironment Class Reference
Inheritance diagram for homeassistant.helpers.template.TemplateEnvironment:
[legend]
Collaboration diagram for homeassistant.helpers.template.TemplateEnvironment:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant|None hass, bool|None limited=False, bool|None strict=False, Callable[[int, str], None]|None log_fn=None)
 
CodeType|str compile (self, str|jinja2.nodes.Template source, str|None name=None, str|None filename=None, bool raw=False, bool defer_init=False)
 
CodeType compile (self, str|jinja2.nodes.Template source, str|None name=None, str|None filename=None, Literal[False] raw=False, bool defer_init=False)
 
str compile (self, str|jinja2.nodes.Template source, str|None name=None, str|None filename=None, Literal[True] raw=..., bool defer_init=False)
 
def is_safe_attribute (self, obj, attr, value)
 
def is_safe_callable (self, obj)
 

Public Attributes

 hass
 
 loader
 

Detailed Description

The Home Assistant template environment.

Definition at line 2842 of file template.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.helpers.template.TemplateEnvironment.__init__ (   self,
HomeAssistant | None  hass,
bool | None   limited = False,
bool | None   strict = False,
Callable[[int, str], None] | None   log_fn = None 
)
Initialise template environment.

Definition at line 2845 of file template.py.

Member Function Documentation

◆ compile() [1/3]

CodeType | str homeassistant.helpers.template.TemplateEnvironment.compile (   self,
str | jinja2.nodes.Template  source,
str | None   name = None,
str | None   filename = None,
bool   raw = False,
bool   defer_init = False 
)
Compile the template.

Definition at line 3184 of file template.py.

◆ compile() [2/3]

CodeType homeassistant.helpers.template.TemplateEnvironment.compile (   self,
str | jinja2.nodes.Template  source,
str | None   name = None,
str | None   filename = None,
Literal[False]   raw = False,
bool   defer_init = False 
)

Definition at line 3165 of file template.py.

◆ compile() [3/3]

str homeassistant.helpers.template.TemplateEnvironment.compile (   self,
str | jinja2.nodes.Template  source,
str | None   name = None,
str | None   filename = None,
Literal[True]   raw = ...,
bool   defer_init = False 
)

Definition at line 3175 of file template.py.

◆ is_safe_attribute()

def homeassistant.helpers.template.TemplateEnvironment.is_safe_attribute (   self,
  obj,
  attr,
  value 
)
Test if attribute is safe.

Definition at line 3152 of file template.py.

◆ is_safe_callable()

def homeassistant.helpers.template.TemplateEnvironment.is_safe_callable (   self,
  obj 
)
Test if callback is safe.

Definition at line 3146 of file template.py.

Member Data Documentation

◆ hass

homeassistant.helpers.template.TemplateEnvironment.hass

Definition at line 2854 of file template.py.

◆ loader

homeassistant.helpers.template.TemplateEnvironment.loader

Definition at line 2958 of file template.py.


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