8000 Rename base TPLinkProtocol to BaseProtocol (#669) · python-kasa/python-kasa@14acc85 · GitHub
[go: up one dir, main page]
Skip to content

Commit 14acc85

Browse files
sdb9696sdb9696
authored
Rename base TPLinkProtocol to BaseProtocol (#669)
1 parent b784d89 commit 14acc85

14 files changed

+30
-30
lines changed

‎kasa/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
UnsupportedDeviceException,
3030
)
3131
from kasa.iotprotocol import IotProtocol
32-
from kasa.protocol import TPLinkProtocol, TPLinkSmartHomeProtocol
32+
from kasa.protocol import BaseProtocol, TPLinkSmartHomeProtocol
3333
from kasa.smartbulb import SmartBulb, SmartBulbPreset, TurnOnBehavior, TurnOnBehaviors
3434
from kasa.smartdevice import DeviceType, SmartDevice
3535
from kasa.smartdimmer import SmartDimmer
@@ -44,7 +44,7 @@
4444
__all__ = [
4545
"Discover",
4646
"TPLinkSmartHomeProtocol",
47-
"TPLinkProtocol",
47+
"BaseProtocol",
4848
"IotProtocol",
4949
"SmartProtocol",
5050
"SmartBulb",

‎kasa/device_factory.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
from .iotprotocol import IotProtocol
1010
from .klaptransport import KlapTransport, KlapTransportV2
1111
from .protocol import (
12+
BaseProtocol,
1213
BaseTransport,
13-
TPLinkProtocol,
1414
TPLinkSmartHomeProtocol,
1515
_XorTransport,
1616
)
@@ -141,14 +141,14 @@ def get_device_class_from_family(device_type: str) -> Optional[Type[SmartDevice]
141141

142142
def get_protocol(
143143
config: DeviceConfig,
144-
) -> Optional[TPLinkProtocol]:
144+
) -> Optional[BaseProtocol]:
145145
"""Return the protocol from the connection name."""
146146
protocol_name = config.connection_type.device_family.value.split(".")[0]
147147
protocol_transport_key = (
148148
protocol_name + "." + config.connection_type.encryption_type.value
149149
)
150150
supported_device_protocols: Dict[
151-
str, Tuple[Type[TPLinkProtocol], Type[BaseTransport]]
151+
str, Tuple[Type[BaseProtocol], Type[BaseTransport]]
152152
] = {
153153
"IOT.XOR": (TPLinkSmartHomeProtocol, _XorTransport),
154154
"IOT.KLAP": (IotProtocol, KlapTransport),

‎kasa/iotprotocol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
TimeoutException,
1212
)
1313
from .json import dumps as json_dumps
14-
from .protocol import BaseTransport, TPLinkProtocol
14+
from .protocol import BaseProtocol, BaseTransport
1515

1616
_LOGGER = logging.getLogger(__name__)
1717

1818

19-
class IotProtocol(TPLinkProtocol):
19+
class IotProtocol(BaseProtocol):
2020
"""Class for the legacy TPLink IOT KASA Protocol."""
2121

2222
BACKOFF_SECONDS_AFTER_TIMEOUT = 1

‎kasa/protocol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ async def close(self) -> None:
7979
"""Close the transport. Abstract method to be overriden."""
8080

8181

82-
class TPLinkProtocol(ABC):
82+
class BaseProtocol(ABC):
8383
"""Base class for all TP-Link Smart Home communication."""
8484

8585
def __init__(
@@ -140,7 +140,7 @@ async def close(self) -> None:
140140
"""Close the transport. Abstract method to be overriden."""
141141

142142

143-
class TPLinkSmartHomeProtocol(TPLinkProtocol):
143+
class TPLinkSmartHomeProtocol(BaseProtocol):
144144
"""Implementation of the TP-Link Smart Home protocol."""
145145

146146
INITIALIZATION_VECTOR = 171

‎kasa/smartbulb.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
from .deviceconfig import DeviceConfig
1313
from .modules import Antitheft, Cloud, Countdown, Emeter, Schedule, Time, Usage
14-
from .protocol import TPLinkProtocol
14+
from .protocol import BaseProtocol
1515
from .smartdevice import DeviceType, SmartDevice, SmartDeviceException, requires_update
1616

1717

@@ -222,7 +222,7 @@ def __init__(
222222
host: str,
223223
*,
224224
config: Optional[DeviceConfig] = None,
225-
protocol: Optional[TPLinkProtocol] = None,
225+
protocol: Optional[BaseProtocol] = None,
226226
) -> None:
227227
super().__init__(host=host, config=config, protocol=protocol)
228228
self._device_type = DeviceType.Bulb

‎kasa/smartdevice.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from .emeterstatus import EmeterStatus
2626
from .exceptions import SmartDeviceException
2727
from .modules import Emeter, Module
28-
from .protocol import TPLinkProtocol, TPLinkSmartHomeProtocol, _XorTransport
28+
from .protocol import BaseProtocol, TPLinkSmartHomeProtocol, _XorTransport
2929

3030
_LOGGER = logging.getLogger(__name__)
3131

@@ -196,15 +196,15 @@ def __init__(
196196
host: str,
197197
*,
198198
config: Optional[DeviceConfig] = None,
199-
protocol: Optional[TPLinkProtocol] = None,
199+
protocol: Optional[BaseProtocol] = None,
200200
) -> None:
201201
"""Create a new SmartDevice instance.
202202
203203
:param str host: host name or ip address on which the device listens
204204
"""
205205
if config and protocol:
206206
protocol._transport._config = config
207-
self.protocol: TPLinkProtocol = protocol or TPLinkSmartHomeProtocol(
207+
self.protocol: BaseProtocol = protocol or TPLinkSmartHomeProtocol(
208208
transport=_XorTransport(config=config or DeviceConfig(host=host)),
209209
)
210210
_LOGGER.debug("Initializing %s of type %s", self.host, type(self))

‎kasa/smartdimmer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from kasa.deviceconfig import DeviceConfig
66
from kasa.modules import AmbientLight, Motion
7-
from kasa.protocol import TPLinkProtocol
7+
from kasa.protocol import BaseProtocol
88
from kasa.smartdevice import DeviceType, SmartDeviceException, requires_update
99
from kasa.smartplug import SmartPlug
1010

@@ -70,7 +70,7 @@ def __init__(
7070
host: str,
7171
*,
7272
config: Optional[DeviceConfig] = None,
73-
protocol: Optional[TPLinkProtocol] = None,
73+
protocol: Optional[BaseProtocol] = None,
7474
) -> None:
7575
super().__init__(host=host, config=config, protocol=protocol)
7676
self._device_type = DeviceType.Dimmer

‎kasa/smartlightstrip.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
from .deviceconfig import DeviceConfig
55
from .effects import EFFECT_MAPPING_V1, EFFECT_NAMES_V1
6-
from .protocol import TPLinkProtocol
6+
from .protocol import BaseProtocol
77
from .smartbulb import SmartBulb
88
from .smartdevice import DeviceType, SmartDeviceException, requires_update
99

@@ -48,7 +48,7 @@ def __init__(
4848
host: str,
4949
*,
5050
config: Optional[DeviceConfig] = None,
51-
protocol: Optional[TPLinkProtocol] = None,
51+
protocol: Optional[BaseProtocol] = None,
5252
) -> None:
5353
super().__init__(host=host, config=config, protocol=protocol)
5454
self._device_type = DeviceType.LightStrip

‎kasa/smartplug.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from kasa.deviceconfig import DeviceConfig
66
from kasa.modules import Antitheft, Cloud, Schedule, Time, Usage
7-
from kasa.protocol import TPLinkProtocol
7+
from kasa.protocol import BaseProtocol
88
from kasa.smartdevice import DeviceType, SmartDevice, requires_update
99

1010
_LOGGER = logging.getLogger(__name__)
@@ -45,7 +45,7 @@ def __init__(
4545
host: str,
4646
*,
4747
config: Optional[DeviceConfig] = None,
48-
protocol: Optional[TPLinkProtocol] = None,
48+
protocol: Optional[BaseProtocol] = None,
4949
) -> None:
5050
super().__init__(host=host, config=config, protocol=protocol)
5151
self._device_type = DeviceType.Plug

‎kasa/smartprotocol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
TimeoutException,
2525
)
2626
from .json import dumps as json_dumps
27-
from .protocol import BaseTransport, TPLinkProtocol, md5
27+
from .protocol import BaseProtocol, BaseTransport, md5
2828

2929
_LOGGER = logging.getLogger(__name__)
3030

3131

32-
class SmartProtocol(TPLinkProtocol):
32+
class SmartProtocol(BaseProtocol):
3333
"""Class for the new TPLink SMART protocol."""
3434

3535
BACKOFF_SECONDS_AFTER_TIMEOUT = 1

0 commit comments

Comments
 (0)
0