Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2025-08-06 10:44:04 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add tutorial doctest module and enable top level await (#919)

Browse Source 
Add a tutorial module with examples that can be tested with `doctest`.

In order to simplify the examples they can be run with doctest allowing
top level await statements by adding a fixture to patch the builtins
that xdoctest uses to test code.

---------

Co-authored-by: Teemu R. <tpr@iki.fi>
This commit is contained in:
Steven B
2024-05-16 17:13:44 +01:00
committed by GitHub
parent a2e8d2c4e8
commit 3490a1ef84
17 changed files with 228 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
kasa/__init__.py
View File

@@ -1,12 +1,12 @@
"""Python interface for TP-Link's smart home devices.
All common, shared functionalities are available through `SmartDevice` class::
All common, shared functionalities are available through `Device` class::
x = SmartDevice("192.168.1.1")
print(x.sys_info)
>>> from kasa import Discover
>>> x = await Discover.discover_single("192.168.1.1")
>>> print(x.model)
For device type specific actions `SmartBulb`, `SmartPlug`, or `SmartStrip`
should be used instead.
For device type specific actions `modules` and `features` should be used instead.
Module-specific errors are raised as `KasaException` and are expected
to be handled by the user of the library.