Skip to content

Add module.device to the public api #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rytilahti merged 3 commits into from
Jan 29, 2025
Merged

Add module.device to the public api #1478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b3f00d
Add module.device to the public api
sdb9696 Jan 23, 2025
05599b2
Update docstring and update tests to use the public property
sdb9696 Jan 29, 2025
a99c14b
Merge branch 'master' into feat/module_device
sdb9696 Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions kasa/module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,11 @@ def __init__(self, device: Device, module: str) -> None:
self._module = module
self._module_features: dict[str, Feature] = {}

@property
def device(self) -> Device:
"""Return the device exposing the module."""
return self._device

@property
def _all_features(self) -> dict[str, Feature]:
"""Get the features for this module and any sub modules."""
Expand Down
4 changes: 2 additions & 2 deletions tests/iot/test_iotdevice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,12 +277,12 @@ async def test_get_modules():
# Modules on device
module = dummy_device.modules.get("cloud")
assert module
assert module._device == dummy_device
assert module.device == dummy_device
assert isinstance(module, Cloud)

module = dummy_device.modules.get(Module.IotCloud)
assert module
assert module._device == dummy_device
assert module.device == dummy_device
assert isinstance(module, Cloud)

# Invalid modules
Expand Down
2 changes: 1 addition & 1 deletion tests/smart/modules/test_fan.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ async def test_fan_module(dev: SmartDevice, mocker: MockerFixture):
assert isinstance(dev, SmartDevice)
fan = next(get_parent_and_child_modules(dev, Module.Fan))
assert fan
device = fan._device
device = fan.device

await fan.set_fan_speed_level(1)
await dev.update()
Expand Down
6 changes: 3 additions & 3 deletions tests/smart/test_smartdevice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ async def test_get_modules():
# Modules on device
module = dummy_device.modules.get("Cloud")
assert module
assert module._device == dummy_device
assert module.device == dummy_device
assert isinstance(module, Cloud)

module = dummy_device.modules.get(Module.Cloud)
Expand All @@ -617,8 +617,8 @@ async def test_get_modules():
assert module is None
module = next(get_parent_and_child_modules(dummy_device, "Fan"))
assert module
assert module._device != dummy_device
assert module._device._parent == dummy_device
assert module.device != dummy_device
assert module.device.parent == dummy_device

# Invalid modules
module = dummy_device.modules.get("DummyModule")
Expand Down
8 changes: 4 additions & 4 deletions tests/test_common_modules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ async def test_light_brightness(dev: Device):
assert light

# Test getting the value
feature = light._device.features["brightness"]
feature = light.device.features["brightness"]
assert feature.minimum_value == 0
assert feature.maximum_value == 100

Expand Down Expand Up @@ -205,7 +205,7 @@ async def test_light_color_temp(dev: Device):
)

# Test getting the value
feature = light._device.features["color_temperature"]
feature = light.device.features["color_temperature"]
assert isinstance(feature.minimum_value, int)
assert isinstance(feature.maximum_value, int)

Expand Down Expand Up @@ -237,7 +237,7 @@ async def test_light_set_state(dev: Device):
light = next(get_parent_and_child_modules(dev, Module.Light))
assert light
# For fixtures that have a light effect active switch off
if light_effect := light._device.modules.get(Module.LightEffect):
if light_effect := light.device.modules.get(Module.LightEffect):
await light_effect.set_effect(light_effect.LIGHT_EFFECTS_OFF)

await light.set_state(LightState(light_on=False))
Expand All @@ -264,7 +264,7 @@ async def test_light_preset_module(dev: Device, mocker: MockerFixture):
assert preset_mod
light_mod = next(get_parent_and_child_modules(dev, Module.Light))
assert light_mod
feat = preset_mod._device.features["light_preset"]
feat = preset_mod.device.features["light_preset"]

preset_list = preset_mod.preset_list
assert "Not set" in preset_list
Expand Down
Loading