From 9d345b4df42939b697a84ee461a8760eb674050e Mon Sep 17 00:00:00 2001 From: Jelle Zijlstra Date: Sat, 28 Oct 2023 17:13:25 -0700 Subject: [PATCH] Add stubs for portpicker (#10944) Co-authored-by: Alex Waygood --- stubs/portpicker/METADATA.toml | 2 ++ stubs/portpicker/portpicker.pyi | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 stubs/portpicker/METADATA.toml create mode 100644 stubs/portpicker/portpicker.pyi diff --git a/stubs/portpicker/METADATA.toml b/stubs/portpicker/METADATA.toml new file mode 100644 index 000000000..626dbf6c4 --- /dev/null +++ b/stubs/portpicker/METADATA.toml @@ -0,0 +1,2 @@ +version = "1.6.*" +upstream_repository = "https://github.com/google/python_portpicker" diff --git a/stubs/portpicker/portpicker.pyi b/stubs/portpicker/portpicker.pyi new file mode 100644 index 000000000..cac293cbc --- /dev/null +++ b/stubs/portpicker/portpicker.pyi @@ -0,0 +1,21 @@ +import socket +from typing_extensions import TypeAlias + +_Port: TypeAlias = int + +__all__ = ("bind", "is_port_free", "pick_unused_port", "return_port", "add_reserved_port", "get_port_from_port_server") + +class NoFreePortFoundError(Exception): ... + +def add_reserved_port(port: _Port) -> None: ... +def return_port(port: _Port) -> None: ... +def bind(port: _Port, socket_type: socket.SocketKind, socket_proto: int) -> _Port | None: ... +def is_port_free(port: _Port) -> bool: ... +def pick_unused_port(pid: int | None = None, portserver_address: str | None = None) -> _Port: ... +def get_port_from_port_server(portserver_address: str, pid: int | None = None) -> _Port | None: ... + +# legacy aliases +Bind = bind +GetPortFromPortServer = get_port_from_port_server +IsPortFree = is_port_free +PickUnusedPort = pick_unused_port