Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.template.RenderInfo Class Reference

Public Member Functions

None __init__ (self, Template template)
 
str __repr__ (self)
 
str result (self)
 

Public Attributes

 all_states
 
 all_states_lifecycle
 
 domains
 
 domains_lifecycle
 
 entities
 
 filter
 
 filter_lifecycle
 
 has_time
 
 is_static
 
 rate_limit
 
 template
 

Private Member Functions

bool _filter_domains_and_entities (self, str entity_id)
 
bool _filter_entities (self, str entity_id)
 
bool _filter_lifecycle_domains (self, str entity_id)
 
None _freeze (self)
 
None _freeze_sets (self)
 
None _freeze_static (self)
 

Static Private Attributes

tuple __slots__
 

Detailed Description

Holds information about a template render.

Definition at line 373 of file template.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.helpers.template.RenderInfo.__init__ (   self,
Template  template 
)
Initialise.

Definition at line 392 of file template.py.

Member Function Documentation

◆ __repr__()

str homeassistant.helpers.template.RenderInfo.__repr__ (   self)
Representation of RenderInfo.

Definition at line 409 of file template.py.

◆ _filter_domains_and_entities()

bool homeassistant.helpers.template.RenderInfo._filter_domains_and_entities (   self,
str  entity_id 
)
private
Template should re-render if the entity state changes.

Only when we match specific domains or entities.

Definition at line 425 of file template.py.

◆ _filter_entities()

bool homeassistant.helpers.template.RenderInfo._filter_entities (   self,
str  entity_id 
)
private
Template should re-render if the entity state changes.

Only when we match specific entities.

Definition at line 434 of file template.py.

◆ _filter_lifecycle_domains()

bool homeassistant.helpers.template.RenderInfo._filter_lifecycle_domains (   self,
str  entity_id 
)
private
Template should re-render if the entity is added or removed.

Only with domains watched.

Definition at line 441 of file template.py.

◆ _freeze()

None homeassistant.helpers.template.RenderInfo._freeze (   self)
private

Definition at line 464 of file template.py.

◆ _freeze_sets()

None homeassistant.helpers.template.RenderInfo._freeze_sets (   self)
private

Definition at line 459 of file template.py.

◆ _freeze_static()

None homeassistant.helpers.template.RenderInfo._freeze_static (   self)
private

Definition at line 454 of file template.py.

◆ result()

str homeassistant.helpers.template.RenderInfo.result (   self)
Results of the template computation.

Definition at line 448 of file template.py.

Member Data Documentation

◆ __slots__

tuple homeassistant.helpers.template.RenderInfo.__slots__
staticprivate
Initial value:
= (
"template",
"filter_lifecycle",
"filter",
"_result",
"is_static",
"exception",
"all_states",
"all_states_lifecycle",
"domains",
"domains_lifecycle",
"entities",
"rate_limit",
"has_time",
)

Definition at line 376 of file template.py.

◆ all_states

homeassistant.helpers.template.RenderInfo.all_states

Definition at line 401 of file template.py.

◆ all_states_lifecycle

homeassistant.helpers.template.RenderInfo.all_states_lifecycle

Definition at line 402 of file template.py.

◆ domains

homeassistant.helpers.template.RenderInfo.domains

Definition at line 461 of file template.py.

◆ domains_lifecycle

homeassistant.helpers.template.RenderInfo.domains_lifecycle

Definition at line 462 of file template.py.

◆ entities

homeassistant.helpers.template.RenderInfo.entities

Definition at line 460 of file template.py.

◆ filter

homeassistant.helpers.template.RenderInfo.filter

Definition at line 486 of file template.py.

◆ filter_lifecycle

homeassistant.helpers.template.RenderInfo.filter_lifecycle

Definition at line 478 of file template.py.

◆ has_time

homeassistant.helpers.template.RenderInfo.has_time

Definition at line 407 of file template.py.

◆ is_static

homeassistant.helpers.template.RenderInfo.is_static

Definition at line 399 of file template.py.

◆ rate_limit

homeassistant.helpers.template.RenderInfo.rate_limit

Definition at line 469 of file template.py.

◆ template

homeassistant.helpers.template.RenderInfo.template

Definition at line 394 of file template.py.


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