Move transports into their own package (#1247)

This moves all transport implementations into a new `transports` package
for cleaner main package & easier to understand project structure.

devtools/parse_pcap.py

@@ -9,7 +9,7 @@ import dpkt
 from dpkt.ethernet import ETH_TYPE_IP, Ethernet
 
 from kasa.cli.main import echo
-from kasa.xortransport import XorEncryption
+from kasa.transports.xortransport import XorEncryption
 
 
 def read_payloads_from_file(file):

devtools/parse_pcap_klap.py

@@ -25,8 +25,8 @@ from kasa.deviceconfig import (
     DeviceEncryptionType,
     DeviceFamily,
 )
-from kasa.klaptransport import KlapEncryptionSession, KlapTransportV2
 from kasa.protocol import DEFAULT_CREDENTIALS, get_default_credentials
+from kasa.transports.klaptransport import KlapEncryptionSession, KlapTransportV2
 
 
 def _get_seq_from_query(packet):

docs/source/reference.md

@@ -107,35 +107,35 @@
 ```
 
 ```{eval-rst}
-.. autoclass:: kasa.protocol.BaseTransport
+.. autoclass:: kasa.transports.BaseTransport
     :members:
     :inherited-members:
     :undoc-members:
 ```
 
 ```{eval-rst}
-.. autoclass:: kasa.xortransport.XorTransport
+.. autoclass:: kasa.transports.XorTransport
     :members:
     :inherited-members:
     :undoc-members:
 ```
 
 ```{eval-rst}
-.. autoclass:: kasa.klaptransport.KlapTransport
+.. autoclass:: kasa.transports.KlapTransport
     :members:
     :inherited-members:
     :undoc-members:
 ```
 
 ```{eval-rst}
-.. autoclass:: kasa.klaptransport.KlapTransportV2
+.. autoclass:: kasa.transports.KlapTransportV2
     :members:
     :inherited-members:
     :undoc-members:
 ```
 
 ```{eval-rst}
-.. autoclass:: kasa.aestransport.AesTransport
+.. autoclass:: kasa.transports.AesTransport
     :members:
     :inherited-members:
     :undoc-members:

kasa/__init__.py

@@ -41,8 +41,9 @@ from kasa.iotprotocol import (
     _deprecated_TPLinkSmartHomeProtocol,  # noqa: F401
 )
 from kasa.module import Module
-from kasa.protocol import BaseProtocol, BaseTransport
+from kasa.protocol import BaseProtocol
 from kasa.smartprotocol import SmartProtocol
+from kasa.transports import BaseTransport
 
 __version__ = version("python-kasa")
 

kasa/device.py

@@ -128,7 +128,7 @@ from .feature import Feature
 from .iotprotocol import IotProtocol
 from .module import Module
 from .protocol import BaseProtocol
-from .xortransport import XorTransport
+from .transports import XorTransport
 
 if TYPE_CHECKING:
     from .modulemapping import ModuleMapping, ModuleName

kasa/device_factory.py

@@ -6,7 +6,6 @@ import logging
 import time
 from typing import Any
 
-from .aestransport import AesTransport
 from .device import Device
 from .device_type import DeviceType
 from .deviceconfig import DeviceConfig
@@ -24,14 +23,18 @@ from .iot import (
     IotWallSwitch,
 )
 from .iotprotocol import IotProtocol
-from .klaptransport import KlapTransport, KlapTransportV2
 from .protocol import (
     BaseProtocol,
-    BaseTransport,
 )
 from .smart import SmartDevice
 from .smartprotocol import SmartProtocol
-from .xortransport import XorTransport
+from .transports import (
+    AesTransport,
+    BaseTransport,
+    KlapTransport,
+    KlapTransportV2,
+    XorTransport,
+)
 
 _LOGGER = logging.getLogger(__name__)
 

kasa/discover.py

@@ -111,7 +111,6 @@ from async_timeout import timeout as asyncio_timeout
 from pydantic.v1 import BaseModel, ValidationError
 
 from kasa import Device
-from kasa.aestransport import AesEncyptionSession, KeyPair
 from kasa.credentials import Credentials
 from kasa.device_factory import (
     get_device_class_from_family,
@@ -134,12 +133,14 @@ from kasa.iotprotocol import REDACTORS as IOT_REDACTORS
 from kasa.json import dumps as json_dumps
 from kasa.json import loads as json_loads
 from kasa.protocol import mask_mac, redact_data
-from kasa.xortransport import XorEncryption
+from kasa.transports.aestransport import AesEncyptionSession, KeyPair
+from kasa.transports.xortransport import XorEncryption
 
 _LOGGER = logging.getLogger(__name__)
 
 if TYPE_CHECKING:
-    from kasa import BaseProtocol, BaseTransport
+    from kasa import BaseProtocol
+    from kasa.transports import BaseTransport
 
 
 class ConnectAttempt(NamedTuple):

kasa/experimental/sslaestransport.py

@@ -13,7 +13,6 @@ from typing import TYPE_CHECKING, Any, Dict, cast
 
 from yarl import URL
 
-from ..aestransport import AesEncyptionSession
 from ..credentials import Credentials
 from ..deviceconfig import DeviceConfig
 from ..exceptions import (
@@ -28,7 +27,8 @@ from ..exceptions import (
 from ..httpclient import HttpClient
 from ..json import dumps as json_dumps
 from ..json import loads as json_loads
-from ..protocol import DEFAULT_CREDENTIALS, BaseTransport, get_default_credentials
+from ..protocol import DEFAULT_CREDENTIALS, get_default_credentials
+from ..transports import AesEncyptionSession, BaseTransport
 
 _LOGGER = logging.getLogger(__name__)
 

kasa/iotprotocol.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import asyncio
 import logging
 from pprint import pformat as pf
-from typing import Any, Callable
+from typing import TYPE_CHECKING, Any, Callable
 
 from .deviceconfig import DeviceConfig
 from .exceptions import (
@@ -16,8 +16,11 @@ from .exceptions import (
     _RetryableError,
 )
 from .json import dumps as json_dumps
-from .protocol import BaseProtocol, BaseTransport, mask_mac, redact_data
+from .protocol import BaseProtocol, mask_mac, redact_data
-from .xortransport import XorEncryption, XorTransport
+from .transports import XorEncryption, XorTransport
+
+if TYPE_CHECKING:
+    from .transports import BaseTransport
 
 _LOGGER = logging.getLogger(__name__)
 

kasa/protocol.py

@@ -18,7 +18,7 @@ import hashlib
 import logging
 import struct
 from abc import ABC, abstractmethod
-from typing import Any, Callable, TypeVar, cast
+from typing import TYPE_CHECKING, Any, Callable, TypeVar, cast
 
 # When support for cpython older than 3.11 is dropped
 # async_timeout can be replaced with asyncio.timeout
@@ -32,6 +32,10 @@ _UNSIGNED_INT_NETWORK_ORDER = struct.Struct(">I")
 _T = TypeVar("_T")
 
 
+if TYPE_CHECKING:
+    from .transports import BaseTransport
+
+
 def redact_data(data: _T, redactors: dict[str, Callable[[Any], Any] | None]) -> _T:
     """Redact sensitive data for logging."""
     if not isinstance(data, (dict, list)):
@@ -75,49 +79,6 @@ def md5(payload: bytes) -> bytes:
     return hashlib.md5(payload).digest()  # noqa: S324
 
 
-class BaseTransport(ABC):
-    """Base class for all TP-Link protocol transports."""
-
-    DEFAULT_TIMEOUT = 5
-
-    def __init__(
-        self,
-        *,
-        config: DeviceConfig,
-    ) -> None:
-        """Create a protocol object."""
-        self._config = config
-        self._host = config.host
-        self._port = config.port_override or self.default_port
-        self._credentials = config.credentials
-        self._credentials_hash = config.credentials_hash
-        if not config.timeout:
-            config.timeout = self.DEFAULT_TIMEOUT
-        self._timeout = config.timeout
-
-    @property
-    @abstractmethod
-    def default_port(self) -> int:
-        """The default port for the transport."""
-
-    @property
-    @abstractmethod
-    def credentials_hash(self) -> str | None:
-        """The hashed credentials used by the transport."""
-
-    @abstractmethod
-    async def send(self, request: str) -> dict:
-        """Send a message to the device and return a response."""
-
-    @abstractmethod
-    async def close(self) -> None:
-        """Close the transport.  Abstract method to be overriden."""
-
-    @abstractmethod
-    async def reset(self) -> None:
-        """Reset internal state."""
-
-
 class BaseProtocol(ABC):
     """Base class for all TP-Link Smart Home communication."""
 

kasa/smart/smartdevice.py

@@ -9,7 +9,6 @@ from collections.abc import Mapping, Sequence
 from datetime import datetime, timedelta, timezone, tzinfo
 from typing import TYPE_CHECKING, Any, cast
 
-from ..aestransport import AesTransport
 from ..device import Device, WifiNetwork
 from ..device_type import DeviceType
 from ..deviceconfig import DeviceConfig
@@ -18,6 +17,7 @@ from ..feature import Feature
 from ..module import Module
 from ..modulemapping import ModuleMapping, ModuleName
 from ..smartprotocol import SmartProtocol
+from ..transports import AesTransport
 from .modules import (
     ChildDevice,
     Cloud,

kasa/smartprotocol.py

@@ -12,7 +12,7 @@ import logging
 import time
 import uuid
 from pprint import pformat as pf
-from typing import Any, Callable
+from typing import TYPE_CHECKING, Any, Callable
 
 from .exceptions import (
     SMART_AUTHENTICATION_ERRORS,
@@ -26,7 +26,11 @@ from .exceptions import (
     _RetryableError,
 )
 from .json import dumps as json_dumps
-from .protocol import BaseProtocol, BaseTransport, mask_mac, md5, redact_data
+from .protocol import BaseProtocol, mask_mac, md5, redact_data
+
+if TYPE_CHECKING:
+    from .transports import BaseTransport
+
 
 _LOGGER = logging.getLogger(__name__)
 

kasa/transports/__init__.py

@@ -0,0 +1,16 @@
+"""Package containing all supported transports."""
+
+from .aestransport import AesEncyptionSession, AesTransport
+from .basetransport import BaseTransport
+from .klaptransport import KlapTransport, KlapTransportV2
+from .xortransport import XorEncryption, XorTransport
+
+__all__ = [
+    "AesTransport",
+    "AesEncyptionSession",
+    "BaseTransport",
+    "KlapTransport",
+    "KlapTransportV2",
+    "XorTransport",
+    "XorEncryption",
+]

kasa/transports/aestransport.py

@@ -20,9 +20,9 @@ from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from yarl import URL
 
-from .credentials import Credentials
+from kasa.credentials import Credentials
-from .deviceconfig import DeviceConfig
+from kasa.deviceconfig import DeviceConfig
-from .exceptions import (
+from kasa.exceptions import (
     SMART_AUTHENTICATION_ERRORS,
     SMART_RETRYABLE_ERRORS,
     AuthenticationError,
@@ -33,10 +33,12 @@ from .exceptions import (
     _ConnectionError,
     _RetryableError,
 )
-from .httpclient import HttpClient
+from kasa.httpclient import HttpClient
-from .json import dumps as json_dumps
+from kasa.json import dumps as json_dumps
-from .json import loads as json_loads
+from kasa.json import loads as json_loads
-from .protocol import DEFAULT_CREDENTIALS, BaseTransport, get_default_credentials
+from kasa.protocol import DEFAULT_CREDENTIALS, get_default_credentials
+
+from .basetransport import BaseTransport
 
 _LOGGER = logging.getLogger(__name__)
 

kasa/transports/basetransport.py

@@ -0,0 +1,55 @@
+"""Base class for all transport implementations.
+
+All transport classes must derive from this to implement the common interface.
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from kasa import DeviceConfig
+
+
+class BaseTransport(ABC):
+    """Base class for all TP-Link protocol transports."""
+
+    DEFAULT_TIMEOUT = 5
+
+    def __init__(
+        self,
+        *,
+        config: DeviceConfig,
+    ) -> None:
+        """Create a protocol object."""
+        self._config = config
+        self._host = config.host
+        self._port = config.port_override or self.default_port
+        self._credentials = config.credentials
+        self._credentials_hash = config.credentials_hash
+        if not config.timeout:
+            config.timeout = self.DEFAULT_TIMEOUT
+        self._timeout = config.timeout
+
+    @property
+    @abstractmethod
+    def default_port(self) -> int:
+        """The default port for the transport."""
+
+    @property
+    @abstractmethod
+    def credentials_hash(self) -> str | None:
+        """The hashed credentials used by the transport."""
+
+    @abstractmethod
+    async def send(self, request: str) -> dict:
+        """Send a message to the device and return a response."""
+
+    @abstractmethod
+    async def close(self) -> None:
+        """Close the transport.  Abstract method to be overriden."""
+
+    @abstractmethod
+    async def reset(self) -> None:
+        """Reset internal state."""

kasa/transports/klaptransport.py

@@ -57,12 +57,18 @@ from cryptography.hazmat.primitives import padding
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from yarl import URL
 
-from .credentials import Credentials
+from kasa.credentials import Credentials
-from .deviceconfig import DeviceConfig
+from kasa.deviceconfig import DeviceConfig
-from .exceptions import AuthenticationError, KasaException, _RetryableError
+from kasa.exceptions import AuthenticationError, KasaException, _RetryableError
-from .httpclient import HttpClient
+from kasa.httpclient import HttpClient
-from .json import loads as json_loads
+from kasa.json import loads as json_loads
-from .protocol import DEFAULT_CREDENTIALS, BaseTransport, get_default_credentials, md5
+from kasa.protocol import (
+    DEFAULT_CREDENTIALS,
+    get_default_credentials,
+    md5,
+)
+
+from .basetransport import BaseTransport
 
 _LOGGER = logging.getLogger(__name__)
 

kasa/transports/xortransport.py

@@ -24,10 +24,11 @@ from collections.abc import Generator
 # async_timeout can be replaced with asyncio.timeout
 from async_timeout import timeout as asyncio_timeout
 
-from .deviceconfig import DeviceConfig
+from kasa.deviceconfig import DeviceConfig
-from .exceptions import KasaException, _RetryableError
+from kasa.exceptions import KasaException, _RetryableError
-from .json import loads as json_loads
+from kasa.json import loads as json_loads
-from .protocol import BaseTransport
+
+from .basetransport import BaseTransport
 
 _LOGGER = logging.getLogger(__name__)
 _NO_RETRY_ERRORS = {errno.EHOSTDOWN, errno.EHOSTUNREACH, errno.ECONNREFUSED}

tests/conftest.py

@@ -11,7 +11,7 @@ from kasa import (
     DeviceConfig,
     SmartProtocol,
 )
-from kasa.protocol import BaseTransport
+from kasa.transports.basetransport import BaseTransport
 
 from .device_fixtures import *  # noqa: F403
 from .discovery_fixtures import *  # noqa: F403

tests/discovery_fixtures.py

@@ -6,7 +6,7 @@ from json import dumps as json_dumps
 
 import pytest
 
-from kasa.xortransport import XorEncryption
+from kasa.transports.xortransport import XorEncryption
 
 from .fakeprotocol_iot import FakeIotProtocol
 from .fakeprotocol_smart import FakeSmartProtocol, FakeSmartTransport

tests/fakeprotocol_iot.py

@@ -3,7 +3,7 @@ import logging
 
 from kasa.deviceconfig import DeviceConfig
 from kasa.iotprotocol import IotProtocol
-from kasa.protocol import BaseTransport
+from kasa.transports.basetransport import BaseTransport
 
 _LOGGER = logging.getLogger(__name__)
 

tests/fakeprotocol_smart.py

@@ -6,8 +6,8 @@ import pytest
 
 from kasa import Credentials, DeviceConfig, SmartProtocol
 from kasa.exceptions import SmartErrorCode
-from kasa.protocol import BaseTransport
 from kasa.smart import SmartChildDevice
+from kasa.transports.basetransport import BaseTransport
 
 
 class FakeSmartProtocol(SmartProtocol):

tests/fakeprotocol_smartcamera.py

@@ -5,7 +5,7 @@ from json import loads as json_loads
 
 from kasa import Credentials, DeviceConfig, SmartProtocol
 from kasa.experimental.smartcameraprotocol import SmartCameraProtocol
-from kasa.protocol import BaseTransport
+from kasa.transports.basetransport import BaseTransport
 
 from .fakeprotocol_smart import FakeSmartTransport
 

tests/test_aestransport.py

@@ -18,7 +18,6 @@ from cryptography.hazmat.primitives.asymmetric import padding as asymmetric_padd
 from freezegun.api import FrozenDateTimeFactory
 from yarl import URL
 
-from kasa.aestransport import AesEncyptionSession, AesTransport, TransportState
 from kasa.credentials import Credentials
 from kasa.deviceconfig import DeviceConfig
 from kasa.exceptions import (
@@ -28,6 +27,11 @@ from kasa.exceptions import (
     _ConnectionError,
 )
 from kasa.httpclient import HttpClient
+from kasa.transports.aestransport import (
+    AesEncyptionSession,
+    AesTransport,
+    TransportState,
+)
 
 pytestmark = [pytest.mark.requires_dummy]
 

tests/test_discovery.py

@@ -23,7 +23,6 @@ from kasa import (
     IotProtocol,
     KasaException,
 )
-from kasa.aestransport import AesEncyptionSession
 from kasa.device_factory import (
     get_device_class_from_family,
     get_device_class_from_sys_info,
@@ -41,7 +40,8 @@ from kasa.discover import (
 )
 from kasa.exceptions import AuthenticationError, UnsupportedDeviceError
 from kasa.iot import IotDevice
-from kasa.xortransport import XorEncryption, XorTransport
+from kasa.transports.aestransport import AesEncyptionSession
+from kasa.transports.xortransport import XorEncryption, XorTransport
 
 from .conftest import (
     bulb_iot,

tests/test_klapprotocol.py

@@ -9,7 +9,6 @@ import aiohttp
 import pytest
 from yarl import URL
 
-from kasa.aestransport import AesTransport
 from kasa.credentials import Credentials
 from kasa.deviceconfig import DeviceConfig
 from kasa.exceptions import (
@@ -21,14 +20,15 @@ from kasa.exceptions import (
 )
 from kasa.httpclient import HttpClient
 from kasa.iotprotocol import IotProtocol
-from kasa.klaptransport import (
+from kasa.protocol import DEFAULT_CREDENTIALS, get_default_credentials
+from kasa.smartprotocol import SmartProtocol
+from kasa.transports.aestransport import AesTransport
+from kasa.transports.klaptransport import (
     KlapEncryptionSession,
     KlapTransport,
     KlapTransportV2,
     _sha256,
 )
-from kasa.protocol import DEFAULT_CREDENTIALS, get_default_credentials
-from kasa.smartprotocol import SmartProtocol
 
 DUMMY_QUERY = {"foobar": {"foo": "bar", "bar": "foo"}}
 

tests/test_protocol.py

@@ -13,21 +13,21 @@ from unittest.mock import AsyncMock
 
 import pytest
 
-from kasa.aestransport import AesTransport
 from kasa.credentials import Credentials
 from kasa.device import Device
 from kasa.deviceconfig import DeviceConfig
 from kasa.exceptions import KasaException
 from kasa.iot import IotDevice
 from kasa.iotprotocol import IotProtocol, _deprecated_TPLinkSmartHomeProtocol
-from kasa.klaptransport import KlapTransport, KlapTransportV2
 from kasa.protocol import (
     BaseProtocol,
-    BaseTransport,
     mask_mac,
     redact_data,
 )
-from kasa.xortransport import XorEncryption, XorTransport
+from kasa.transports.aestransport import AesTransport
+from kasa.transports.basetransport import BaseTransport
+from kasa.transports.klaptransport import KlapTransport, KlapTransportV2
+from kasa.transports.xortransport import XorEncryption, XorTransport
 
 from .conftest import device_iot
 from .fakeprotocol_iot import FakeIotTransport

tests/test_sslaestransport.py

@@ -11,7 +11,6 @@ import aiohttp
 import pytest
 from yarl import URL
 
-from kasa.aestransport import AesEncyptionSession
 from kasa.credentials import Credentials
 from kasa.deviceconfig import DeviceConfig
 from kasa.exceptions import (
@@ -26,6 +25,7 @@ from kasa.experimental.sslaestransport import (
 )
 from kasa.httpclient import HttpClient
 from kasa.protocol import DEFAULT_CREDENTIALS, get_default_credentials
+from kasa.transports.aestransport import AesEncyptionSession
 
 # Transport tests are not designed for real devices
 pytestmark = [pytest.mark.requires_dummy]