homeassistant.helpers.network Namespace Reference

Classes
class	NoURLAvailableError

Functions
str	_get_cloud_url (HomeAssistant hass, bool require_current_request=False)
str	_get_external_url (HomeAssistant hass, *bool allow_cloud=True, bool allow_ip=True, bool prefer_cloud=False, bool require_current_request=False, bool require_ssl=False, bool require_standard_port=False, bool require_cloud=False)
str	_get_internal_url (HomeAssistant hass, *bool allow_ip=True, bool require_current_request=False, bool require_ssl=False, bool require_standard_port=False)
str|None	_get_request_host ()
str|None	get_supervisor_network_url (HomeAssistant hass, *bool allow_ssl=False)
str	get_url (HomeAssistant hass, *bool require_current_request=False, bool require_ssl=False, bool require_standard_port=False, bool require_cloud=False, bool allow_internal=True, bool allow_external=True, bool allow_cloud=True, bool|None allow_ip=None, bool|None prefer_external=None, bool prefer_cloud=False)
bool	is_cloud_connection (HomeAssistant hass)
bool	is_hass_url (HomeAssistant hass, str url)
bool	is_internal_request (HomeAssistant hass)

Variables
string	SUPERVISOR_NETWORK_HOST = "homeassistant"
string	TYPE_URL_EXTERNAL = "external_url"
string	TYPE_URL_INTERNAL = "internal_url"

Detailed Description

Network helpers.

Function Documentation

_get_cloud_url()

str homeassistant.helpers.network._get_cloud_url ( HomeAssistant  hass, bool   require_current_request = False  )

private

Get external Home Assistant Cloud URL of this instance.

Definition at line 317 of file network.py.

_get_external_url()

str homeassistant.helpers.network._get_external_url ( HomeAssistant  hass, *bool   allow_cloud = True, bool   allow_ip = True, bool   prefer_cloud = False, bool   require_current_request = False, bool   require_ssl = False, bool   require_standard_port = False, bool   require_cloud = False  )

private

Get external URL of this instance.

Definition at line 272 of file network.py.

_get_internal_url()

str homeassistant.helpers.network._get_internal_url ( HomeAssistant  hass, *bool   allow_ip = True, bool   require_current_request = False, bool   require_ssl = False, bool   require_standard_port = False  )

private

Get internal URL of this instance.

Definition at line 234 of file network.py.

_get_request_host()

str | None homeassistant.helpers.network._get_request_host ( )

private

Get the host address of the current request.

Definition at line 215 of file network.py.

get_supervisor_network_url()

str | None homeassistant.helpers.network.get_supervisor_network_url	(	HomeAssistant	hass,
		*bool	allow_ssl = False
	)

Get URL for home assistant within supervisor network.

Definition at line 43 of file network.py.

get_url()

str homeassistant.helpers.network.get_url	(	HomeAssistant	hass,
		*bool	require_current_request = False,
		bool	require_ssl = False,
		bool	require_standard_port = False,
		bool	require_cloud = False,
		bool	allow_internal = True,
		bool	allow_external = True,
		bool	allow_cloud = True,
		bool | None	allow_ip = None,
		bool | None	prefer_external = None,
		bool	prefer_cloud = False
	)

Get a URL to this instance.

Definition at line 118 of file network.py.

is_cloud_connection()

bool homeassistant.helpers.network.is_cloud_connection

(

HomeAssistant

hass

)

Return True if the current connection is a nabucasa cloud connection.

Definition at line 338 of file network.py.

is_hass_url()

bool homeassistant.helpers.network.is_hass_url	(	HomeAssistant	hass,
		str	url
	)

Return if the URL points at this Home Assistant instance.

Definition at line 67 of file network.py.

is_internal_request()

bool homeassistant.helpers.network.is_internal_request

(

HomeAssistant

hass

)

Test if the current request is internal.

Definition at line 31 of file network.py.

Variable Documentation

SUPERVISOR_NETWORK_HOST

string homeassistant.helpers.network.SUPERVISOR_NETWORK_HOST = "homeassistant"

Definition at line 23 of file network.py.

TYPE_URL_EXTERNAL

string homeassistant.helpers.network.TYPE_URL_EXTERNAL = "external_url"

Definition at line 22 of file network.py.

TYPE_URL_INTERNAL

string homeassistant.helpers.network.TYPE_URL_INTERNAL = "internal_url"

Definition at line 21 of file network.py.