diff options
Diffstat (limited to 'typings/serial/serialposix.pyi')
-rw-r--r-- | typings/serial/serialposix.pyi | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/typings/serial/serialposix.pyi b/typings/serial/serialposix.pyi new file mode 100644 index 0000000..9f41fd2 --- /dev/null +++ b/typings/serial/serialposix.pyi @@ -0,0 +1,34 @@ +from typing import Any, Optional +from serial.serialutil import SerialBase + + +class PlatformSpecificBase: + ... + + +class PlatformSpecific(PlatformSpecificBase): + ... + + +class Serial(SerialBase, PlatformSpecific): + """\ + Serial port class POSIX implementation. Serial port configuration is + done with termios and fcntl. Runs on Linux and many other Un*x like + systems. + """ + + def close(self) -> None: + """Close port""" + ... + + def read(self, size: Optional[int] = ...) -> bytes: + """\ + Read size bytes from the serial port. If a timeout is set it may + return less characters as requested. With no timeout it will block + until the requested number of bytes is read. + """ + ... + + def __enter__(self) -> Serial: ... + + def __exit__(self, *args: Any, **kwargs: Any) -> None: ... |