Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove deprecated volume conversion functions (#101200)

pull/101204/head
Dave T 2023-10-01 15:06:14 +01:00 committed by GitHub
parent 87ecdfb84f
commit a4a99ce957
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 1 additions and 199 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/api/util.rst
View File

@ -141,11 +141,3 @@ homeassistant.util.unit\_system
:members:
:undoc-members:
:show-inheritance:
homeassistant.util.volume
-------------------------
.. automodule:: homeassistant.util.volume
:members:
:undoc-members:
:show-inheritance:

52
homeassistant/util/volume.py
View File

@ -1,52 +0,0 @@
"""Volume conversion util functions."""
from __future__ import annotations
# pylint: disable-next=hass-deprecated-import
from homeassistant.const import ( # noqa: F401
UNIT_NOT_RECOGNIZED_TEMPLATE,
VOLUME,
VOLUME_CUBIC_FEET,
VOLUME_CUBIC_METERS,
VOLUME_FLUID_OUNCE,
VOLUME_GALLONS,
VOLUME_LITERS,
VOLUME_MILLILITERS,
)
from homeassistant.helpers.frame import report
from .unit_conversion import VolumeConverter
VALID_UNITS = VolumeConverter.VALID_UNITS
def liter_to_gallon(liter: float) -> float:
"""Convert a volume measurement in Liter to Gallon."""
return convert(liter, VOLUME_LITERS, VOLUME_GALLONS)
def gallon_to_liter(gallon: float) -> float:
"""Convert a volume measurement in Gallon to Liter."""
return convert(gallon, VOLUME_GALLONS, VOLUME_LITERS)
def cubic_meter_to_cubic_feet(cubic_meter: float) -> float:
"""Convert a volume measurement in cubic meter to cubic feet."""
return convert(cubic_meter, VOLUME_CUBIC_METERS, VOLUME_CUBIC_FEET)
def cubic_feet_to_cubic_meter(cubic_feet: float) -> float:
"""Convert a volume measurement in cubic feet to cubic meter."""
return convert(cubic_feet, VOLUME_CUBIC_FEET, VOLUME_CUBIC_METERS)
def convert(volume: float, from_unit: str, to_unit: str) -> float:
"""Convert a volume from one unit to another."""
report(
(
"uses volume utility. This is deprecated since 2022.10 and will "
"stop working in Home Assistant 2023.4, it should be updated to use "
"unit_conversion.VolumeConverter instead"
),
error_if_core=False,
)
return VolumeConverter.convert(volume, from_unit, to_unit)

2
tests/util/test_unit_conversion.py
View File

@ -105,7 +105,7 @@ _GET_UNIT_RATIO: dict[type[BaseUnitConverter], tuple[str | None, str | None, flo
VolumeConverter: (UnitOfVolume.GALLONS, UnitOfVolume.LITERS, 0.264172),
}
# Dict containing a conversion test for every know unit.
# Dict containing a conversion test for every known unit.
_CONVERTED_VALUE: dict[
type[BaseUnitConverter], list[tuple[float, str | None, float, str | None]]
] = {

138
tests/util/test_volume.py
View File

@ -1,138 +0,0 @@
"""Test Home Assistant volume utility functions."""
import pytest
from homeassistant.const import (
VOLUME_CUBIC_FEET,
VOLUME_CUBIC_METERS,
VOLUME_FLUID_OUNCE,
VOLUME_GALLONS,
VOLUME_LITERS,
VOLUME_MILLILITERS,
)
from homeassistant.exceptions import HomeAssistantError
import homeassistant.util.volume as volume_util
INVALID_SYMBOL = "bob"
VALID_SYMBOL = VOLUME_LITERS
def test_raise_deprecation_warning(caplog: pytest.LogCaptureFixture) -> None:
"""Ensure that a warning is raised on use of convert."""
assert volume_util.convert(2, VOLUME_LITERS, VOLUME_LITERS) == 2
assert "use unit_conversion.VolumeConverter instead" in caplog.text
@pytest.mark.parametrize(
("function_name", "value", "expected"),
[
("liter_to_gallon", 2, pytest.approx(0.528344)),
("gallon_to_liter", 2, 7.570823568),
("cubic_meter_to_cubic_feet", 2, pytest.approx(70.629333)),
("cubic_feet_to_cubic_meter", 2, pytest.approx(0.0566337)),
],
)
def test_deprecated_functions(
function_name: str, value: float, expected: float
) -> None:
"""Test that deprecated function still work."""
convert = getattr(volume_util, function_name)
assert convert(value) == expected
def test_convert_same_unit() -> None:
"""Test conversion from any unit to same unit."""
assert volume_util.convert(2, VOLUME_LITERS, VOLUME_LITERS) == 2
assert volume_util.convert(3, VOLUME_MILLILITERS, VOLUME_MILLILITERS) == 3
assert volume_util.convert(4, VOLUME_GALLONS, VOLUME_GALLONS) == 4
assert volume_util.convert(5, VOLUME_FLUID_OUNCE, VOLUME_FLUID_OUNCE) == 5
def test_convert_invalid_unit() -> None:
"""Test exception is thrown for invalid units."""
with pytest.raises(HomeAssistantError, match="is not a recognized .* unit"):
volume_util.convert(5, INVALID_SYMBOL, VALID_SYMBOL)
with pytest.raises(HomeAssistantError, match="is not a recognized .* unit"):
volume_util.convert(5, VALID_SYMBOL, INVALID_SYMBOL)
def test_convert_nonnumeric_value() -> None:
"""Test exception is thrown for nonnumeric type."""
with pytest.raises(TypeError):
volume_util.convert("a", VOLUME_GALLONS, VOLUME_LITERS)
def test_convert_from_liters() -> None:
"""Test conversion from liters to other units."""
liters = 5
assert volume_util.convert(liters, VOLUME_LITERS, VOLUME_GALLONS) == pytest.approx(
1.32086
)
def test_convert_from_gallons() -> None:
"""Test conversion from gallons to other units."""
gallons = 5
assert volume_util.convert(gallons, VOLUME_GALLONS, VOLUME_LITERS) == pytest.approx(
18.92706
)
def test_convert_from_cubic_meters() -> None:
"""Test conversion from cubic meter to other units."""
cubic_meters = 5
assert volume_util.convert(
cubic_meters, VOLUME_CUBIC_METERS, VOLUME_CUBIC_FEET
) == pytest.approx(176.5733335)
def test_convert_from_cubic_feet() -> None:
"""Test conversion from cubic feet to cubic meters to other units."""
cubic_feets = 500
assert volume_util.convert(
cubic_feets, VOLUME_CUBIC_FEET, VOLUME_CUBIC_METERS
) == pytest.approx(14.1584233)
@pytest.mark.parametrize(
("source_unit", "target_unit", "expected"),
[
(VOLUME_CUBIC_FEET, VOLUME_CUBIC_METERS, 14.1584233),
(VOLUME_CUBIC_FEET, VOLUME_FLUID_OUNCE, 478753.2467),
(VOLUME_CUBIC_FEET, VOLUME_GALLONS, 3740.25974),
(VOLUME_CUBIC_FEET, VOLUME_LITERS, 14158.42329599),
(VOLUME_CUBIC_FEET, VOLUME_MILLILITERS, 14158423.29599),
(VOLUME_CUBIC_METERS, VOLUME_CUBIC_METERS, 500),
(VOLUME_CUBIC_METERS, VOLUME_FLUID_OUNCE, 16907011.35),
(VOLUME_CUBIC_METERS, VOLUME_GALLONS, 132086.02617),
(VOLUME_CUBIC_METERS, VOLUME_LITERS, 500000),
(VOLUME_CUBIC_METERS, VOLUME_MILLILITERS, 500000000),
(VOLUME_FLUID_OUNCE, VOLUME_CUBIC_FEET, 0.52218967),
(VOLUME_FLUID_OUNCE, VOLUME_CUBIC_METERS, 0.014786764),
(VOLUME_FLUID_OUNCE, VOLUME_GALLONS, 3.90625),
(VOLUME_FLUID_OUNCE, VOLUME_LITERS, 14.786764),
(VOLUME_FLUID_OUNCE, VOLUME_MILLILITERS, 14786.764),
(VOLUME_GALLONS, VOLUME_CUBIC_FEET, 66.84027),
(VOLUME_GALLONS, VOLUME_CUBIC_METERS, 1.892706),
(VOLUME_GALLONS, VOLUME_FLUID_OUNCE, 64000),
(VOLUME_GALLONS, VOLUME_LITERS, 1892.70589),
(VOLUME_GALLONS, VOLUME_MILLILITERS, 1892705.89),
(VOLUME_LITERS, VOLUME_CUBIC_FEET, 17.65733),
(VOLUME_LITERS, VOLUME_CUBIC_METERS, 0.5),
(VOLUME_LITERS, VOLUME_FLUID_OUNCE, 16907.011),
(VOLUME_LITERS, VOLUME_GALLONS, 132.086),
(VOLUME_LITERS, VOLUME_MILLILITERS, 500000),
(VOLUME_MILLILITERS, VOLUME_CUBIC_FEET, 0.01765733),
(VOLUME_MILLILITERS, VOLUME_CUBIC_METERS, 0.0005),
(VOLUME_MILLILITERS, VOLUME_FLUID_OUNCE, 16.907),
(VOLUME_MILLILITERS, VOLUME_GALLONS, 0.132086),
(VOLUME_MILLILITERS, VOLUME_LITERS, 0.5),
],
)
def test_convert(source_unit, target_unit, expected) -> None:
"""Test conversion between units."""
value = 500
assert volume_util.convert(value, source_unit, target_unit) == pytest.approx(
expected
)