developers.home-assistant/2022-10-14-deprecate-unit-system.md at 8e3979ee81fcc6745c8b1682ae901b58ab745ecd

mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-05-08 03:58:38 +00:00

Rename IMPERIAL_SYSTEM to US_CUSTOMARY_SYSTEM (#1500 )

* Rename IMPERIAL_SYSTEM to US_CUSTOMARY_SYSTEM

* Update 2022-10-14-deprecate-unit-system.md

* Delete 2022-10-18-rename-imperial-unit-system.md

* Update 2022-10-14-deprecate-unit-system.md

* Update 2022-10-14-deprecate-unit-system.md

2022-10-24 11:21:38 +02:00

977 B

Raw Blame History

author, authorURL, title

author	authorURL	title
epenet	https://github.com/epenet	Deprecate IMPERIAL_SYSTEM unit system and linked constants and properties

As of Home Assistant Core 2022.11, the IMPERIAL_SYSTEM is deprecated, replaced by US_CUSTOMARY_SYSTEM. The is_metric and name properties of a unit system are likewise deprecated and should not be used.

Custom integrations referencing this unit system or these properties will need to be adjusted to use instance checks instead.

Correct:

if hass.config.units is METRIC_SYSTEM:
    pass

if hass.config.units is US_CUSTOMARY_SYSTEM:
    pass

To avoid confusion with future unit systems, the constants CONF_UNIT_SYSTEM_IMPERIAL and CONF_UNIT_SYSTEM_METRIC are also deprecated and should no longer be referenced:

if they were used to compare against the name of a unit system, then this is no longer needed.
if they were used for another reason, then local constants should be created instead.

977 B Raw Blame History

977 B

Raw Blame History