homeassistant.components.frontend.IndexView Class Reference

Inheritance diagram for homeassistant.components.frontend.IndexView:

Collaboration diagram for homeassistant.components.frontend.IndexView:

Public Member Functions
None	__init__ (self, str|None repo_path, HomeAssistant hass)
Iterator[web_urldispatcher.ResourceRoute]	__iter__ (self)
int	__len__ (self)
None	add_prefix (self, str prefix)
str	canonical (self)
web.Response	get (self, web.Request request)
dict[str, list[str]]	get_info (self)
jinja2.Template	get_template (self)
bool	raw_match (self, str path)
tuple[web_urldispatcher.UrlMappingMatchInfo|None, set[str]]	resolve (self, web.Request request)
URL	url_for (self, **str kwargs)

Public Attributes
	hass
	repo_path

Private Member Functions
web_urldispatcher.ResourceRoute	_route (self)

Private Attributes
	_template_cache

Detailed Description

Serve the frontend.

Definition at line 583 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.frontend.IndexView.__init__	(		self,
		str | None	repo_path,
		HomeAssistant	hass
	)

Initialize the frontend view.

Definition at line 586 of file __init__.py.

Member Function Documentation

__iter__()

Iterator[web_urldispatcher.ResourceRoute] homeassistant.components.frontend.IndexView.__iter__

(

self

)

Iterate over routes.

Definition at line 691 of file __init__.py.

__len__()

int homeassistant.components.frontend.IndexView.__len__

(

self

)

Return length of resource.

Definition at line 687 of file __init__.py.

_route()

web_urldispatcher.ResourceRoute homeassistant.components.frontend.IndexView._route (   self )

private

Return the index route.

Definition at line 599 of file __init__.py.

add_prefix()

None homeassistant.components.frontend.IndexView.add_prefix	(		self,
		str	prefix
	)

Add a prefix to processed URLs.

Required for subapplications support.

Definition at line 627 of file __init__.py.

canonical()

str homeassistant.components.frontend.IndexView.canonical

(

self

)

Return resource's canonical path.

Definition at line 594 of file __init__.py.

get()

web.Response homeassistant.components.frontend.IndexView.get	(		self,
		web.Request	request
	)

Serve the index page for panel pages.

Definition at line 655 of file __init__.py.

get_info()

dict[str, list[str]] homeassistant.components.frontend.IndexView.get_info

(

self

)

Return a dict with additional info useful for introspection.

Definition at line 633 of file __init__.py.

get_template()

jinja2.Template homeassistant.components.frontend.IndexView.get_template

(

self

)

Get template.

Definition at line 641 of file __init__.py.

raw_match()

bool homeassistant.components.frontend.IndexView.raw_match	(		self,
		str	path
	)

Perform a raw match against path.

Definition at line 637 of file __init__.py.

resolve()

tuple[web_urldispatcher.UrlMappingMatchInfo | None, set[str]] homeassistant.components.frontend.IndexView.resolve	(		self,
		web.Request	request
	)

Resolve resource.

Return (UrlMappingMatchInfo, allowed_methods) pair.

Definition at line 607 of file __init__.py.

url_for()

URL homeassistant.components.frontend.IndexView.url_for	(		self,
		**str	kwargs
	)

Construct url for resource with additional params.

Definition at line 603 of file __init__.py.

Member Data Documentation

_template_cache

homeassistant.components.frontend.IndexView._template_cache

private

Definition at line 651 of file __init__.py.

hass

homeassistant.components.frontend.IndexView.hass

Definition at line 590 of file __init__.py.

repo_path

homeassistant.components.frontend.IndexView.repo_path

Definition at line 589 of file __init__.py.

---

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

• core/homeassistant/components/frontend/__init__.py