Typing improvements for TPLink (#50947)

* Typing improvements for TPLink

* Update homeassistant/components/tplink/common.py

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Franck Nijhof 2021-05-22 14:47:26 +02:00 committed by GitHub
parent afb372a680
commit 560dd0a0cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 78 additions and 50 deletions

View file

@ -1,8 +1,12 @@
"""Support for TPLink HS100/HS110/HS200 smart switch."""
from __future__ import annotations
import asyncio
from collections.abc import Mapping
from contextlib import suppress
import logging
import time
from typing import Any
from pyHS100 import SmartDeviceException, SmartPlug
@ -11,10 +15,13 @@ from homeassistant.components.switch import (
ATTR_TODAY_ENERGY_KWH,
SwitchEntity,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_VOLTAGE
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import PlatformNotReady
import homeassistant.helpers.device_registry as dr
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import CONF_SWITCH, DOMAIN as TPLINK_DOMAIN
from .common import add_available_devices
@ -30,7 +37,11 @@ MAX_ATTEMPTS = 300
SLEEP_TIME = 2
async def async_setup_entry(hass: HomeAssistant, config_entry, async_add_entities):
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up switches."""
entities = await hass.async_add_executor_job(
add_available_devices, hass, CONF_SWITCH, SmartPlugSwitch
@ -62,17 +73,17 @@ class SmartPlugSwitch(SwitchEntity):
self._host = None
@property
def unique_id(self):
def unique_id(self) -> str | None:
"""Return a unique ID."""
return self._device_id
@property
def name(self):
def name(self) -> str | None:
"""Return the name of the Smart Plug."""
return self._alias
@property
def device_info(self):
def device_info(self) -> DeviceInfo:
"""Return information about the device."""
return {
"name": self._alias,
@ -88,37 +99,37 @@ class SmartPlugSwitch(SwitchEntity):
return self._is_available
@property
def is_on(self):
def is_on(self) -> bool | None:
"""Return true if switch is on."""
return self._state
def turn_on(self, **kwargs):
def turn_on(self, **kwargs: Any) -> None:
"""Turn the switch on."""
self.smartplug.turn_on()
def turn_off(self, **kwargs):
def turn_off(self, **kwargs: Any) -> None:
"""Turn the switch off."""
self.smartplug.turn_off()
@property
def extra_state_attributes(self):
def extra_state_attributes(self) -> Mapping[str, Any] | None:
"""Return the state attributes of the device."""
return self._emeter_params
@property
def _plug_from_context(self):
def _plug_from_context(self) -> Any:
"""Return the plug from the context."""
children = self.smartplug.sys_info["children"]
return next(c for c in children if c["id"] == self.smartplug.context)
def update_state(self):
def update_state(self) -> None:
"""Update the TP-Link switch's state."""
if self.smartplug.context is None:
self._state = self.smartplug.state == self.smartplug.SWITCH_STATE_ON
else:
self._state = self._plug_from_context["state"] == 1
def attempt_update(self, update_attempt):
def attempt_update(self, update_attempt: int) -> bool:
"""Attempt to get details from the TP-Link switch."""
try:
if not self._sysinfo:
@ -168,7 +179,7 @@ class SmartPlugSwitch(SwitchEntity):
)
return False
async def async_update(self):
async def async_update(self) -> None:
"""Update the TP-Link switch's state."""
for update_attempt in range(MAX_ATTEMPTS):
is_ready = await self.hass.async_add_executor_job(