mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
f9a987ca18
* Add doctests to SmartBulb * Add SmartDevice doctests, cleanup README.md * add doctests for smartplug and smartstrip * add discover doctests * Fix bulb mock * add smartdimmer doctests * add sphinx-generated docs, cleanup readme a bit * remove sphinx-click as it does not work with asyncclick * in preparation for rtd hooking, move doc deps to be separate from dev deps * pytestmark needs to be applied separately for each and every file, this fixes the tests * use pathlib for resolving relative paths * Skip discovery doctest on python3.7 The code is just fine, but some reason the mocking behaves differently between 3.7 and 3.8. The latter seems to accept a discrete object for asyncio.run where the former expects a coroutine..
66 lines
2.2 KiB
Python
66 lines
2.2 KiB
Python
import sys
|
|
|
|
import pytest
|
|
|
|
import xdoctest
|
|
from kasa.tests.conftest import get_device_for_file
|
|
|
|
|
|
def test_bulb_examples(mocker):
|
|
"""Use KL130 (bulb with all features) to test the doctests."""
|
|
p = get_device_for_file("KL130(US)_1.0.json")
|
|
mocker.patch("kasa.smartbulb.SmartBulb", return_value=p)
|
|
mocker.patch("kasa.smartbulb.SmartBulb.update")
|
|
res = xdoctest.doctest_module("kasa.smartbulb", "all")
|
|
assert not res["failed"]
|
|
|
|
|
|
def test_smartdevice_examples(mocker):
|
|
"""Use HS110 for emeter examples."""
|
|
p = get_device_for_file("HS110(EU)_1.0_real.json")
|
|
mocker.patch("kasa.smartdevice.SmartDevice", return_value=p)
|
|
mocker.patch("kasa.smartdevice.SmartDevice.update")
|
|
res = xdoctest.doctest_module("kasa.smartdevice", "all")
|
|
assert not res["failed"]
|
|
|
|
|
|
def test_plug_examples(mocker):
|
|
"""Test plug examples."""
|
|
p = get_device_for_file("HS110(EU)_1.0_real.json")
|
|
mocker.patch("kasa.smartplug.SmartPlug", return_value=p)
|
|
mocker.patch("kasa.smartplug.SmartPlug.update")
|
|
res = xdoctest.doctest_module("kasa.smartplug", "all")
|
|
assert not res["failed"]
|
|
|
|
|
|
def test_strip_examples(mocker):
|
|
"""Test strip examples."""
|
|
p = get_device_for_file("KP303(UK)_1.0.json")
|
|
mocker.patch("kasa.smartstrip.SmartStrip", return_value=p)
|
|
mocker.patch("kasa.smartstrip.SmartStrip.update")
|
|
res = xdoctest.doctest_module("kasa.smartstrip", "all")
|
|
assert not res["failed"]
|
|
|
|
|
|
def test_dimmer_examples(mocker):
|
|
"""Test dimmer examples."""
|
|
p = get_device_for_file("HS220(US)_1.0_real.json")
|
|
mocker.patch("kasa.smartdimmer.SmartDimmer", return_value=p)
|
|
mocker.patch("kasa.smartdimmer.SmartDimmer.update")
|
|
res = xdoctest.doctest_module("kasa.smartdimmer", "all")
|
|
assert not res["failed"]
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
sys.version_info < (3, 8), reason="3.7 handles asyncio.run differently"
|
|
)
|
|
def test_discovery_examples(mocker):
|
|
"""Test discovery examples."""
|
|
p = get_device_for_file("KP303(UK)_1.0.json")
|
|
|
|
# This succeeds on python 3.8 but fails on 3.7
|
|
# ValueError: a coroutine was expected, got [<DeviceType.Strip model KP303(UK) ...
|
|
mocker.patch("kasa.discover.Discover.discover", return_value=[p])
|
|
res = xdoctest.doctest_module("kasa.discover", "all")
|
|
assert not res["failed"]
|