Remove deprecated srp_energy integration (ADR-0004) (#26826)

.coveragerc

@@ -608,7 +608,6 @@ omit =
     homeassistant/components/spotcrime/sensor.py
     homeassistant/components/spotify/media_player.py
     homeassistant/components/squeezebox/media_player.py
-    homeassistant/components/srp_energy/sensor.py
     homeassistant/components/starlingbank/sensor.py
     homeassistant/components/steam_online/sensor.py
     homeassistant/components/stiebel_eltron/*

homeassistant/components/srp_energy/__init__.py

@@ -1 +0,0 @@
-"""The srp_energy component."""

homeassistant/components/srp_energy/manifest.json

@@ -1,10 +0,0 @@
-{
-  "domain": "srp_energy",
-  "name": "Srp energy",
-  "documentation": "https://www.home-assistant.io/components/srp_energy",
-  "requirements": [
-    "srpenergy==1.0.6"
-  ],
-  "dependencies": [],
-  "codeowners": []
-}

homeassistant/components/srp_energy/sensor.py

@@ -1,156 +0,0 @@
-"""Platform for retrieving energy data from SRP."""
-from datetime import datetime, timedelta
-import logging
-
-from requests.exceptions import ConnectionError as ConnectError, HTTPError, Timeout
-import voluptuous as vol
-
-from homeassistant.const import (
-    CONF_NAME,
-    CONF_PASSWORD,
-    ENERGY_KILO_WATT_HOUR,
-    CONF_USERNAME,
-    CONF_ID,
-)
-import homeassistant.helpers.config_validation as cv
-from homeassistant.util import Throttle
-from homeassistant.components.sensor import PLATFORM_SCHEMA
-from homeassistant.helpers.entity import Entity
-
-_LOGGER = logging.getLogger(__name__)
-
-ATTRIBUTION = "Powered by SRP Energy"
-
-DEFAULT_NAME = "SRP Energy"
-MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=1440)
-ENERGY_KWH = ENERGY_KILO_WATT_HOUR
-
-ATTR_READING_COST = "reading_cost"
-ATTR_READING_TIME = "datetime"
-ATTR_READING_USAGE = "reading_usage"
-ATTR_DAILY_USAGE = "daily_usage"
-ATTR_USAGE_HISTORY = "usage_history"
-
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
-    {
-        vol.Required(CONF_USERNAME): cv.string,
-        vol.Required(CONF_PASSWORD): cv.string,
-        vol.Required(CONF_ID): cv.string,
-        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
-    }
-)
-
-
-def setup_platform(hass, config, add_entities, discovery_info=None):
-    """Set up the SRP energy."""
-    _LOGGER.warning(
-        "The srp_energy integration is deprecated and will be removed "
-        "in Home Assistant 0.100.0. For more information see ADR-0004:"
-        "https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md"
-    )
-
-    name = config[CONF_NAME]
-    username = config[CONF_USERNAME]
-    password = config[CONF_PASSWORD]
-    account_id = config[CONF_ID]
-
-    from srpenergy.client import SrpEnergyClient
-
-    srp_client = SrpEnergyClient(account_id, username, password)
-
-    if not srp_client.validate():
-        _LOGGER.error("Couldn't connect to %s. Check credentials", name)
-        return
-
-    add_entities([SrpEnergy(name, srp_client)], True)
-
-
-class SrpEnergy(Entity):
-    """Representation of an srp usage."""
-
-    def __init__(self, name, client):
-        """Initialize SRP Usage."""
-        self._state = None
-        self._name = name
-        self._client = client
-        self._history = None
-        self._usage = None
-
-    @property
-    def attribution(self):
-        """Return the attribution."""
-        return ATTRIBUTION
-
-    @property
-    def state(self):
-        """Return the current state."""
-        if self._state is None:
-            return None
-
-        return f"{self._state:.2f}"
-
-    @property
-    def name(self):
-        """Return the name of the sensor."""
-        return self._name
-
-    @property
-    def unit_of_measurement(self):
-        """Return the unit of measurement of this entity, if any."""
-        return ENERGY_KWH
-
-    @property
-    def history(self):
-        """Return the energy usage history of this entity, if any."""
-        if self._usage is None:
-            return None
-
-        history = [
-            {
-                ATTR_READING_TIME: isodate,
-                ATTR_READING_USAGE: kwh,
-                ATTR_READING_COST: cost,
-            }
-            for _, _, isodate, kwh, cost in self._usage
-        ]
-
-        return history
-
-    @property
-    def device_state_attributes(self):
-        """Return the state attributes."""
-        attributes = {ATTR_USAGE_HISTORY: self.history}
-
-        return attributes
-
-    @Throttle(MIN_TIME_BETWEEN_UPDATES)
-    def update(self):
-        """Get the latest usage from SRP Energy."""
-        start_date = datetime.now() + timedelta(days=-1)
-        end_date = datetime.now()
-
-        try:
-
-            usage = self._client.usage(start_date, end_date)
-
-            daily_usage = 0.0
-            for _, _, _, kwh, _ in usage:
-                daily_usage += float(kwh)
-
-            if usage:
-
-                self._state = daily_usage
-                self._usage = usage
-
-            else:
-                _LOGGER.error("Unable to fetch data from SRP. No data")
-
-        except (ConnectError, HTTPError, Timeout) as error:
-            _LOGGER.error("Unable to connect to SRP. %s", error)
-        except ValueError as error:
-            _LOGGER.error("Value error connecting to SRP. %s", error)
-        except TypeError as error:
-            _LOGGER.error(
-                "Type error connecting to SRP. " "Check username and password. %s",
-                error,
-            )

requirements_all.txt

@@ -1814,9 +1814,6 @@ spotipy-homeassistant==2.4.4.dev1
 # homeassistant.components.sql
 sqlalchemy==1.3.8
 
-# homeassistant.components.srp_energy
-srpenergy==1.0.6
-
 # homeassistant.components.starlingbank
 starlingbank==3.1
 

requirements_test_all.txt

@@ -407,9 +407,6 @@ somecomfort==0.5.2
 # homeassistant.components.sql
 sqlalchemy==1.3.8
 
-# homeassistant.components.srp_energy
-srpenergy==1.0.6
-
 # homeassistant.components.statsd
 statsd==3.2.1
 

tests/components/srp_energy/__init__.py

@@ -1 +0,0 @@
-"""Tests for the srp_energy component."""

tests/components/srp_energy/test_sensor.py

@@ -1,62 +0,0 @@
-"""The tests for the Srp Energy Platform."""
-from unittest.mock import patch
-import logging
-from homeassistant.setup import async_setup_component
-
-_LOGGER = logging.getLogger(__name__)
-
-VALID_CONFIG_MINIMAL = {
-    "sensor": {
-        "platform": "srp_energy",
-        "username": "foo",
-        "password": "bar",
-        "id": 1234,
-    }
-}
-
-PATCH_INIT = "srpenergy.client.SrpEnergyClient.__init__"
-PATCH_VALIDATE = "srpenergy.client.SrpEnergyClient.validate"
-PATCH_USAGE = "srpenergy.client.SrpEnergyClient.usage"
-
-
-def mock_usage(self, startdate, enddate):  # pylint: disable=invalid-name
-    """Mock srpusage usage."""
-    _LOGGER.log(logging.INFO, "Calling mock usage")
-    usage = [
-        ("9/19/2018", "12:00 AM", "2018-09-19T00:00:00-7:00", "1.2", "0.17"),
-        ("9/19/2018", "1:00 AM", "2018-09-19T01:00:00-7:00", "2.1", "0.30"),
-        ("9/19/2018", "2:00 AM", "2018-09-19T02:00:00-7:00", "1.5", "0.23"),
-        ("9/19/2018", "9:00 PM", "2018-09-19T21:00:00-7:00", "1.2", "0.19"),
-        ("9/19/2018", "10:00 PM", "2018-09-19T22:00:00-7:00", "1.1", "0.18"),
-        ("9/19/2018", "11:00 PM", "2018-09-19T23:00:00-7:00", "0.4", "0.09"),
-    ]
-    return usage
-
-
-async def test_setup_with_config(hass):
-    """Test the platform setup with configuration."""
-    with patch(PATCH_INIT, return_value=None), patch(
-        PATCH_VALIDATE, return_value=True
-    ), patch(PATCH_USAGE, new=mock_usage):
-
-        await async_setup_component(hass, "sensor", VALID_CONFIG_MINIMAL)
-
-        state = hass.states.get("sensor.srp_energy")
-        assert state is not None
-
-
-async def test_daily_usage(hass):
-    """Test the platform daily usage."""
-    with patch(PATCH_INIT, return_value=None), patch(
-        PATCH_VALIDATE, return_value=True
-    ), patch(PATCH_USAGE, new=mock_usage):
-
-        await async_setup_component(hass, "sensor", VALID_CONFIG_MINIMAL)
-
-        state = hass.states.get("sensor.srp_energy")
-
-        assert state
-        assert state.state == "7.50"
-
-        assert state.attributes
-        assert state.attributes.get("unit_of_measurement")