refactor: replaced root logger use with named ones (#307)

Author: TomerFi

src/aioswitcher/api/__init__.py

@@ -18,7 +18,7 @@
 from binascii import unhexlify
 from datetime import timedelta
 from enum import Enum, unique
-from logging import debug, info
+from logging import getLogger
 from socket import AF_INET
 from types import TracebackType
 from typing import Optional, Set, Tuple, Type, final
@@ -40,6 +40,8 @@
     SwitcherStateResponse,
 )
 
+logger = getLogger(__name__)
+
 
 @unique
 class Command(Enum):
@@ -88,24 +90,24 @@ async def __aexit__(
 
     async def connect(self) -> None:
         """Connect to asynchronous socket and get reader and writer object."""
-        info("connecting to the switcher device")
+        logger.info("connecting to the switcher device")
         self._reader, self._writer = await open_connection(
             host=self._ip_address,
             port=self._port,
             family=AF_INET,
         )
 
         self._connected = True
-        info("switcher device connected")
+        logger.info("switcher device connected")
 
     async def disconnect(self) -> None:
         """Disconnect from asynchronous socket."""
         if hasattr(self, "_writer") and self._writer:
-            info("disconnecting from the switcher device")
+            logger.info("disconnecting from the switcher device")
             self._writer.close()
             await self._writer.wait_closed()
         else:
-            info("switcher device not connected")
+            logger.info("switcher device not connected")
         self._connected = False
 
     @property
@@ -128,7 +130,7 @@ async def _login(self) -> Tuple[str, SwitcherLoginResponse]:
         packet = packets.LOGIN_PACKET.format(timestamp)
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a login packet")
+        logger.debug("sending a login packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return timestamp, SwitcherLoginResponse(response)
@@ -153,7 +155,7 @@ async def _get_full_state(self) -> Tuple[str, str, SwitcherStateResponse]:
             )
             signed_packet = sign_packet_with_crc_key(packet)
 
-            debug("sending a get state packet")
+            logger.debug("sending a get state packet")
             self._writer.write(unhexlify(signed_packet))
             state_resp = await self._reader.read(1024)
             try:
@@ -202,7 +204,7 @@ async def control_device(
         )
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a control packet")
+        logger.debug("sending a control packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return SwitcherBaseResponse(response)
@@ -228,7 +230,7 @@ async def set_auto_shutdown(self, full_time: timedelta) -> SwitcherBaseResponse:
         )
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a set auto shutdown packet")
+        logger.debug("sending a set auto shutdown packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return SwitcherBaseResponse(response)
@@ -253,7 +255,7 @@ async def set_device_name(self, name: str) -> SwitcherBaseResponse:
         )
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a set name packet")
+        logger.debug("sending a set name packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return SwitcherBaseResponse(response)
@@ -273,7 +275,7 @@ async def get_schedules(self) -> SwitcherGetSchedulesResponse:
         )
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a get schedules packet")
+        logger.debug("sending a get schedules packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return SwitcherGetSchedulesResponse(response)
@@ -296,7 +298,7 @@ async def delete_schedule(self, schedule_id: str) -> SwitcherBaseResponse:
         )
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a delete schedule packet")
+        logger.debug("sending a delete schedule packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return SwitcherBaseResponse(response)
@@ -335,7 +337,7 @@ async def create_schedule(
         )
         signed_packet = sign_packet_with_crc_key(packet)
 
-        debug("sending a create schedule packet")
+        logger.debug("sending a create schedule packet")
         self._writer.write(unhexlify(signed_packet))
         response = await self._reader.read(1024)
         return SwitcherBaseResponse(response)

src/aioswitcher/bridge.py

@@ -18,7 +18,7 @@
 from binascii import hexlify
 from dataclasses import dataclass
 from functools import partial
-from logging import critical, debug, error, info
+from logging import getLogger
 from socket import AF_INET, inet_ntoa
 from struct import pack
 from types import TracebackType
@@ -36,6 +36,7 @@
 from .device.tools import seconds_to_iso_time, watts_to_amps
 
 __all__ = ["SwitcherBridge"]
+logger = getLogger(__name__)
 
 
 def _parse_device_from_datagram(
@@ -52,7 +53,7 @@ def _parse_device_from_datagram(
     """
     parser = DatagramParser(datagram)
     if not parser.is_switcher_originator():
-        error("received datagram from an unknown source")
+        logger.error("received datagram from an unknown source")
     else:
         device_type = parser.get_device_type()
         device_state = parser.get_device_state()
@@ -64,7 +65,7 @@ def _parse_device_from_datagram(
             electric_current = 0.0
 
         if device_type and device_type.category == DeviceCategory.WATER_HEATER:
-            debug("discovered a water heater switcher device")
+            logger.debug("discovered a water heater switcher device")
             device_callback(
                 SwitcherWaterHeater(
                     device_type,
@@ -85,7 +86,7 @@ def _parse_device_from_datagram(
             )
 
         elif device_type and device_type.category == DeviceCategory.POWER_PLUG:
-            debug("discovered a power plug switcher device")
+            logger.debug("discovered a power plug switcher device")
             device_callback(
                 SwitcherPowerPlug(
                     device_type,
@@ -137,7 +138,7 @@ async def __aexit__(
 
     async def start(self) -> None:
         """Create an asynchronous listener and start the bridge."""
-        info("starting the udp bridge")
+        logger.info("starting the udp bridge")
         protocol_factory = UdpClientProtocol(
             partial(_parse_device_from_datagram, self._on_device)
         )
@@ -148,16 +149,16 @@ async def start(self) -> None:
         )
 
         self._is_running = True
-        info("udp bridge started")
+        logger.info("udp bridge started")
         self._transport = transport
 
     async def stop(self) -> None:
         """Stop the asynchronous bridge."""
         if self._transport and not self._transport.is_closing():
-            info("stopping the udp bridge")
+            logger.info("stopping the udp bridge")
             self._transport.close()
         else:
-            info("udp bridge not started")
+            logger.info("udp bridge not started")
         self._is_running = False
 
     @property
@@ -186,16 +187,16 @@ def datagram_received(self, data: bytes, addr: Tuple) -> None:
     def error_received(self, exc: Optional[Exception]) -> None:
         """Call on exception received."""
         if exc:
-            error(f"udp client received error {exc}")
+            logger.error(f"udp client received error {exc}")
         else:
             warn("udp client received error")
 
     def connection_lost(self, exc: Optional[Exception]) -> None:
         """Call on connection lost."""
         if exc:
-            critical(f"udp bridge lost its connection {exc}")
+            logger.critical(f"udp bridge lost its connection {exc}")
         else:
-            info("udp connection stopped")
+            logger.info("udp connection stopped")
 
 
 @final