summaryrefslogtreecommitdiff
path: root/typings/serial/tools/list_ports.pyi
blob: 67df6f618f0c0e5ba50a025667be1659040c939d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
"""\
This module will provide a function called comports that returns an
iterable (generator or list) that will enumerate available com ports. Note that
on some systems non-existent ports may be listed.

Additionally a grep function is supplied that can be used to search for ports
based on their descriptions or hardware ID.
"""
from typing import Any, List, Optional

from list_ports_common import ListPortInfo


def comports(include_links: Optional[Any] = ...) -> List[ListPortInfo]:
    """Return a list of info objects about serial ports"""
    ...