homeassistant.requirements.RequirementsManager Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass)
Integration	async_get_integration_with_requirements (self, str domain, set[str]|None done=None)
None	async_load_installed_versions (self, set[str] requirements)
None	async_process_requirements (self, str name, list[str] requirements)

Public Attributes
	hass
	pip_lock

Private Member Functions
None	_async_process_integration (self, Integration integration, set[str] done)
None	_async_process_requirements (self, str name, list[str] requirements)
list[str]	_find_missing_requirements (self, list[str] requirements)
None	_raise_for_failed_requirements (self, str integration, list[str] missing)

Detailed Description

Manage requirements.

Definition at line 122 of file requirements.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.requirements.RequirementsManager.__init__	(		self,
		HomeAssistant	hass
	)

Init the requirements manager.

Definition at line 125 of file requirements.py.

Member Function Documentation

_async_process_integration()

None homeassistant.requirements.RequirementsManager._async_process_integration (   self, Integration  integration, set[str]   done  )

private

Process an integration and requirements.

Definition at line 177 of file requirements.py.

_async_process_requirements()

None homeassistant.requirements.RequirementsManager._async_process_requirements (   self, str  name, list[str]  requirements  )

private

Install a requirement and save failures.

Definition at line 294 of file requirements.py.

_find_missing_requirements()

list[str] homeassistant.requirements.RequirementsManager._find_missing_requirements (   self, list[str]  requirements  )

private

Find requirements that are missing in the cache.

Definition at line 271 of file requirements.py.

_raise_for_failed_requirements()

None homeassistant.requirements.RequirementsManager._raise_for_failed_requirements (   self, str  integration, list[str]   missing  )

private

Raise for failed installing integration requirements.

Raise RequirementsNotFound so we do not keep trying requirements
that have already failed.

Definition at line 275 of file requirements.py.

async_get_integration_with_requirements()

Integration homeassistant.requirements.RequirementsManager.async_get_integration_with_requirements	(		self,
		str	domain,
		set[str] | None	done = None
	)

Get an integration with all requirements installed, including dependencies.

This can raise IntegrationNotFound if manifest or integration
is invalid, RequirementNotFound if there was some type of
failure to install requirements.

Definition at line 135 of file requirements.py.

async_load_installed_versions()

None homeassistant.requirements.RequirementsManager.async_load_installed_versions	(		self,
		set[str]	requirements
	)

Load the installed version of requirements.

Definition at line 309 of file requirements.py.

async_process_requirements()

None homeassistant.requirements.RequirementsManager.async_process_requirements	(		self,
		str	name,
		list[str]	requirements
	)

Install the requirements for a component or platform.

This method is a coroutine. It will raise RequirementsNotFound
if an requirement can't be satisfied.

Definition at line 242 of file requirements.py.

Member Data Documentation

hass

homeassistant.requirements.RequirementsManager.hass

Definition at line 127 of file requirements.py.

pip_lock

homeassistant.requirements.RequirementsManager.pip_lock

Definition at line 128 of file requirements.py.

---

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

• core/homeassistant/requirements.py