homeassistant.helpers.issue_registry.IssueRegistry Class Reference

Inheritance diagram for homeassistant.helpers.issue_registry.IssueRegistry:

Collaboration diagram for homeassistant.helpers.issue_registry.IssueRegistry:

Public Member Functions
None	__init__ (self, HomeAssistant hass)
None	async_delete (self, str domain, str issue_id)
IssueEntry|None	async_get_issue (self, str domain, str issue_id)
IssueEntry	async_get_or_create (self, str domain, str issue_id, *str|None breaks_in_ha_version=None, dict[str, str|int|float|None]|None data=None, bool is_fixable, bool is_persistent, str|None issue_domain=None, str|None learn_more_url=None, IssueSeverity severity, str translation_key, dict[str, str]|None translation_placeholders=None)
IssueEntry	async_ignore (self, str domain, str issue_id, bool ignore)
None	async_load (self)
None	make_read_only (self)

Public Attributes
	hass
	issues

Private Member Functions
dict[str, list[dict[str, str|None]]]	_data_to_save (self)

Private Attributes
	_store

Detailed Description

Class to hold a registry of issues.

Definition at line 109 of file issue_registry.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.issue_registry.IssueRegistry.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the issue registry.

Definition at line 112 of file issue_registry.py.

Member Function Documentation

_data_to_save()

dict[str, list[dict[str, str | None]]] homeassistant.helpers.issue_registry.IssueRegistry._data_to_save (   self )

private

Return data of issue registry to store in a file.

Definition at line 301 of file issue_registry.py.

async_delete()

None homeassistant.helpers.issue_registry.IssueRegistry.async_delete	(		self,
		str	domain,
		str	issue_id
	)

Delete issue.

Definition at line 204 of file issue_registry.py.

async_get_issue()

IssueEntry | None homeassistant.helpers.issue_registry.IssueRegistry.async_get_issue	(		self,
		str	domain,
		str	issue_id
	)

Get issue by id.

Definition at line 125 of file issue_registry.py.

async_get_or_create()

IssueEntry homeassistant.helpers.issue_registry.IssueRegistry.async_get_or_create	(		self,
		str	domain,
		str	issue_id,
		*str | None	breaks_in_ha_version = None,
		dict[str, str | int | float | None] | None	data = None,
		bool	is_fixable,
		bool	is_persistent,
		str | None	issue_domain = None,
		str | None	learn_more_url = None,
		IssueSeverity	severity,
		str	translation_key,
		dict[str, str] | None	translation_placeholders = None
	)

Get issue. Create if it doesn't exist.

Definition at line 130 of file issue_registry.py.

async_ignore()

IssueEntry homeassistant.helpers.issue_registry.IssueRegistry.async_ignore	(		self,
		str	domain,
		str	issue_id,
		bool	ignore
	)

Ignore issue.

Definition at line 221 of file issue_registry.py.

async_load()

None homeassistant.helpers.issue_registry.IssueRegistry.async_load

(

self

)

Load the issue registry.

Definition at line 254 of file issue_registry.py.

make_read_only()

None homeassistant.helpers.issue_registry.IssueRegistry.make_read_only

(

self

)

Make the registry read-only.

This method is irreversible.

Definition at line 247 of file issue_registry.py.

Member Data Documentation

_store

homeassistant.helpers.issue_registry.IssueRegistry._store

private

Definition at line 116 of file issue_registry.py.

hass

homeassistant.helpers.issue_registry.IssueRegistry.hass

Definition at line 114 of file issue_registry.py.

issues

homeassistant.helpers.issue_registry.IssueRegistry.issues

Definition at line 298 of file issue_registry.py.

---

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

• core/homeassistant/helpers/issue_registry.py