summaryrefslogtreecommitdiff
path: root/typings/serial/serialwin32.pyi
blob: 5124dd2553680b56ebb41f51cfce4b99b7c3f933 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
"""
This type stub file was generated by pyright.
"""

from typing import Any, Optional
from serial.serialutil import SerialBase


class Serial(SerialBase):
    """Serial port implementation for Win32 based on ctypes."""

    def __init__(
        self,
        port: Optional[str] = ...,
        baudrate: Optional[int] = ...,
        **kwargs: Any
    ) -> None:
        ...

    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: ...