refactor: linting

Author: csacca

.devcontainer/devcontainer.json

@@ -3,9 +3,7 @@
   "image": "ludeeus/container:integration-debian",
   "name": "Blueprint integration development",
   "context": "..",
-  "appPort": [
-    "9123:8123"
-  ],
+  "appPort": ["9123:8123"],
   "postCreateCommand": "container install",
   "extensions": [
     "ms-python.python",
@@ -27,4 +25,4 @@
     "editor.formatOnType": true,
     "files.trimTrailingWhitespace": true
   }
-}
+}

.flake8

@@ -8,4 +8,4 @@ select = C,E,F,W,B,SIM,T
 # the line lengths are enforced by black and docformatter
 # therefore we ignore E501 and B950 here
 # SIM119 - are irrelevant as we still support python 3.6 series
-ignore = E501,B950,W503,E203,SIM119
+ignore = E501,B950,W503,E203,SIM119

.vscode/launch.json

@@ -31,4 +31,4 @@
       ]
     }
   ]
-}
+}

.vscode/settings.json

@@ -1,10 +1,7 @@
 {
   "editor.formatOnSave": true,
   "python.formatting.provider": "black",
-  "python.sortImports.args": [
-    "--profile",
-    "black"
-  ],
+  "python.sortImports.args": ["--profile", "black"],
   "editor.codeActionsOnSave": {
     "source.organizeImports": true
   },
@@ -13,12 +10,5 @@
   "files.associations": {
     "*.yaml": "home-assistant"
   },
-  "cSpell.words": [
-    "actions",
-    "assistant",
-    "hassfest",
-    "home",
-    "master",
-    "uhoo"
-  ],
-}
+  "cSpell.words": ["actions", "assistant", "hassfest", "home", "master", "uhoo"]
+}

.yamllint

@@ -4,4 +4,4 @@ rules:
   # 80 chars should be enough, but don't fail if a line is longer
   line-length:
     max: 80
-    level: warning
+    level: warning

custom_components/uhoo/__init__.py

@@ -6,10 +6,11 @@
 """
 
 import asyncio
-from typing import Dict
+from typing import Dict, List
 
 from pyuhoo import Client
 from pyuhoo.device import Device
+from pyuhoo.errors import UnauthorizedError
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
@@ -41,6 +42,14 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
     session = async_get_clientsession(hass)
     client = Client(username, password, session, debug=True)
 
+    try:
+        client = Client(username, password, session, debug=True)
+        await client.login()
+    except UnauthorizedError as err:
+        LOGGER.error(
+            f"Error: received a 401 Unauthorized error attempting to login:\n{err}"
+        )
+
     coordinator = UhooDataUpdateCoordinator(hass, client=client)
     await coordinator.async_refresh()
 
@@ -66,7 +75,7 @@ class UhooDataUpdateCoordinator(DataUpdateCoordinator):
     def __init__(self, hass: HomeAssistant, client: Client) -> None:
         """Initialize."""
         self.client = client
-        self.platforms = []
+        self.platforms: List[str] = []
         self.user_settings_temp = None
 
         super().__init__(hass, LOGGER, name=DOMAIN, update_interval=UPDATE_INTERVAL)
@@ -77,6 +86,9 @@ async def _async_update_data(self) -> Dict[str, Device]:
             self.user_settings_temp = self.client.user_settings_temp
             return self.client.get_devices()
         except Exception as exception:
+            LOGGER.error(
+                f"Error: an exception occurred while attempting to get latest data:\n{exception}"
+            )
             raise UpdateFailed() from exception
 
 

custom_components/uhoo/config_flow.py

@@ -14,7 +14,7 @@
 from homeassistant.core import callback
 from homeassistant.helpers.aiohttp_client import async_create_clientsession
 
-from .const import DOMAIN, PLATFORMS
+from .const import DOMAIN, LOGGER, PLATFORMS
 
 
 class UhooFlowHandler(ConfigFlow, domain=DOMAIN):  # type: ignore[call-arg]
@@ -86,10 +86,12 @@ async def _test_credentials(self, username, password):
             client = Client(username, password, session)
             await client.login()
             return True
-        except UnauthorizedError:
-            pass
-        except Exception:
-            pass
+        except UnauthorizedError as err:
+            LOGGER.error(
+                f"Error: received a 401 Unauthorized error attempting to login:\n{err}"
+            )
+        except Exception as err:
+            LOGGER.error(f"Error: exception while attempting to login:\n{err}")
         return False
 
 

custom_components/uhoo/const.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
 import logging
 
-from homeassistant.const import (
+from homeassistant.const import (  # noqa:F401
     ATTR_DEVICE_CLASS,
     CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
     CONCENTRATION_PARTS_PER_BILLION,
@@ -10,11 +10,14 @@
     DEVICE_CLASS_TEMPERATURE,
     PERCENTAGE,
     PRESSURE_HPA,
+    TEMP_CELSIUS,
     TEMP_FAHRENHEIT,
 )
 
 # Base component constants
 NAME = "uHoo Integration"
+MODEL = "uHoo Indoor Air Monitor"
+MANUFACTURER = "uHoo"
 DOMAIN = "uhoo"
 VERSION = "0.0.3"
 ISSUE_URL = "https://github.com/csacca/uhoo-homeassistant/issues"

custom_components/uhoo/manifest.json

@@ -6,10 +6,6 @@
   "issue_tracker": "https://github.com/csacca/uhoo-homeassistant/issues",
   "version": "0.0.2",
   "config_flow": true,
-  "codeowners": [
-    "@csacca"
-  ],
-  "requirements": [
-    "pyuhoo==0.0.3"
-  ]
-}
+  "codeowners": ["@csacca"],
+  "requirements": ["pyuhoo==0.0.3"]
+}

custom_components/uhoo/sensor.py

@@ -1,5 +1,7 @@
 """UhooSensorEntity class"""
 
+from pyuhoo.device import Device
+
 from custom_components.uhoo import UhooDataUpdateCoordinator
 from homeassistant.components.sensor import SensorEntity
 from homeassistant.core import HomeAssistant
@@ -15,7 +17,8 @@
     ATTR_UNIQUE_ID,
     ATTR_UNIT,
     DOMAIN,
-    NAME,
+    MANUFACTURER,
+    MODEL,
     SENSOR_TYPES,
     TEMP_CELSIUS,
     TEMP_FAHRENHEIT,
@@ -45,58 +48,59 @@ def __init__(
         self, kind: str, serial_number: str, coordinator: UhooDataUpdateCoordinator
     ):
         super().__init__(coordinator)
+        self._coordinator = coordinator
         self._kind = kind
         self._serial_number = serial_number
 
     @property
     def name(self):
         """Return the name of the particular component."""
-        return (
-            f"uHoo {self._serial_number} {SENSOR_TYPES[self.sensor_type][ATTR_LABEL]}"
-        )
+        device: Device = self.coordinator.data[self._serial_number]
+        return f"uHoo {device.name} {SENSOR_TYPES[self._kind][ATTR_LABEL]}"
 
     @property
     def unique_id(self):
         """Return a unique ID to use for this entity."""
-        return f"{self._serial_number}_{SENSOR_TYPES[self.sensor_type][ATTR_UNIQUE_ID]}"
+        return f"{self._serial_number}_{SENSOR_TYPES[self._kind][ATTR_UNIQUE_ID]}"
 
     @property
     def device_info(self):
         # we probably could pull the firmware version if we wanted
         # its in the api somewhere
+        device: Device = self.coordinator.data[self._serial_number]
         return {
             "identifiers": {(DOMAIN, self._serial_number)},
-            "name": NAME,
-            "model": NAME,
-            "manufacturer": NAME,
+            "name": device.name,
+            "model": MODEL,
+            "manufacturer": MANUFACTURER,
         }
 
     @property
     def state(self):
         """State of the sensor."""
-        device = self.coordinator.data[self.serial_number]
-        state = getattr(device, self.sensor_type)
+        device: Device = self._coordinator.data[self._serial_number]
+        state = getattr(device, self._kind)
         if isinstance(state, list):
             state = state[0]
         return state
 
     @property
     def device_class(self):
         """Return the device class."""
-        return SENSOR_TYPES[self.sensor_type][ATTR_DEVICE_CLASS]
+        return SENSOR_TYPES[self._kind][ATTR_DEVICE_CLASS]
 
     @property
     def icon(self):
         """Return the icon."""
-        return SENSOR_TYPES[self.sensor_type][ATTR_ICON]
+        return SENSOR_TYPES[self._kind][ATTR_ICON]
 
     @property
     def unit_of_measurement(self):
         """Return unit of measurement."""
-        if self.sensor_type == API_TEMP:
-            if self.coordinator.user_settings_temp == "f":
+        if self._kind == API_TEMP:
+            if self._coordinator.user_settings_temp == "f":
                 return TEMP_FAHRENHEIT
             else:
                 return TEMP_CELSIUS
         else:
-            return SENSOR_TYPES[self.sensor_type][ATTR_UNIT]
+            return SENSOR_TYPES[self._kind][ATTR_UNIT]

custom_components/uhoo/translations/en.json

@@ -16,4 +16,4 @@
       "single_instance_allowed": "Only a single instance is allowed."
     }
   }
-}
+}

poetry.lock

@@ -9,7 +9,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-pyuhoo = "^0.0.3"
+pyuhoo = "^0.0.4"
 
 [tool.poetry.dev-dependencies]
 homeassistant = "^2021.8.0b0"