homeassistant.util.language Namespace Reference

Classes
class	Dialect

Functions
set[str]	intersect (set[str] languages_1, set[str] languages_2)
bool	is_language_match (str lang_1, str lang_2)
bool	is_region (str language, str|None region)
list[str]	matches (str target, Iterable[str] supported, str|None country=None)
Iterable[str]	preferred_regions (str language, str|None country=None, str|None code=None)

Variables
tuple	SAME_LANGUAGES
	SEPARATOR_RE = re.compile(r"[-_]")

Detailed Description

Helper methods for language selection in Home Assistant.

Function Documentation

intersect()

set[str] homeassistant.util.language.intersect	(	set[str]	languages_1,
		set[str]	languages_2
	)

Intersect two sets of languages using is_match for aliases.

Definition at line 202 of file language.py.

is_language_match()

bool homeassistant.util.language.is_language_match	(	str	lang_1,
		str	lang_2
	)

Return true if two languages are considered the same.

Definition at line 66 of file language.py.

is_region()

bool homeassistant.util.language.is_region	(	str	language,
		str | None	region
	)

Return true if region is not known to be a script/code instead.

Definition at line 52 of file language.py.

matches()

list[str] homeassistant.util.language.matches	(	str	target,
		Iterable[str]	supported,
		str | None	country = None
	)

Return a sorted list of matching language tags based on a target tag and country hint.

Definition at line 175 of file language.py.

preferred_regions()

Iterable[str] homeassistant.util.language.preferred_regions	(	str	language,
		str | None	country = None,
		str | None	code = None
	)

Yield an ordered list of regions for a language based on country/code hints.

Regions should be checked for support in the returned order if no other
information is available.

Definition at line 24 of file language.py.

Variable Documentation

SAME_LANGUAGES

tuple homeassistant.util.language.SAME_LANGUAGES

Initial value:

=  (
    # no = spoken Norwegian
    # nb = written Norwegian (Bokmål)
    ("nb", "no"),
    # he = Hebrew new code
    # iw = Hebrew old code
    ("he", "iw"),
)

Definition at line 14 of file language.py.

SEPARATOR_RE

homeassistant.util.language.SEPARATOR_RE = re.compile(r"[-_]")

Definition at line 13 of file language.py.