Skip to content

socketserver: improve bytes handling #9096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion stdlib/http/server.pyi
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import _socket
import email.message
import io
import socketserver
Expand Down Expand Up @@ -56,7 +57,7 @@ class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
def __init__(
self,
request: socketserver._RequestType,
client_address: socketserver._AddressType,
client_address: _socket._RetAddress,
server: socketserver.BaseServer,
*,
directory: str | None = ...,
Expand Down
59 changes: 32 additions & 27 deletions stdlib/socketserver.pyi
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import sys
import types
from _typeshed import Self
from _socket import _Address, _RetAddress
from _typeshed import ReadableBuffer, Self
from collections.abc import Callable
from socket import socket as _socket
from typing import Any, BinaryIO, ClassVar, Union
Expand Down Expand Up @@ -29,38 +30,39 @@ if sys.platform != "win32":
]

_RequestType: TypeAlias = Union[_socket, tuple[bytes, _socket]]
_AddressType: TypeAlias = Union[tuple[str, int], str]
_AfUnixAddress: TypeAlias = str | ReadableBuffer # adddress acceptable for an AF_UNIX socket
_AfInetAddress: TypeAlias = tuple[str | bytes | bytearray, int] # address acceptable for an AF_INET socket

# This can possibly be generic at some point:
class BaseServer:
address_family: int
server_address: tuple[str, int]
server_address: _Address
socket: _socket
allow_reuse_address: bool
request_queue_size: int
socket_type: int
timeout: float | None
def __init__(
self: Self, server_address: Any, RequestHandlerClass: Callable[[Any, Any, Self], BaseRequestHandler]
self: Self, server_address: _Address, RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler]
) -> None: ...
# It is not actually a `@property`, but we need a `Self` type:
@property
def RequestHandlerClass(self: Self) -> Callable[[Any, Any, Self], BaseRequestHandler]: ...
def RequestHandlerClass(self: Self) -> Callable[[Any, _RetAddress, Self], BaseRequestHandler]: ...
@RequestHandlerClass.setter
def RequestHandlerClass(self: Self, val: Callable[[Any, Any, Self], BaseRequestHandler]) -> None: ...
def RequestHandlerClass(self: Self, val: Callable[[Any, _RetAddress, Self], BaseRequestHandler]) -> None: ...
def fileno(self) -> int: ...
def handle_request(self) -> None: ...
def serve_forever(self, poll_interval: float = ...) -> None: ...
def shutdown(self) -> None: ...
def server_close(self) -> None: ...
def finish_request(self, request: _RequestType, client_address: _AddressType) -> None: ...
def finish_request(self, request: _RequestType, client_address: _RetAddress) -> None: ...
def get_request(self) -> tuple[Any, Any]: ...
def handle_error(self, request: _RequestType, client_address: _AddressType) -> None: ...
def handle_error(self, request: _RequestType, client_address: _RetAddress) -> None: ...
def handle_timeout(self) -> None: ...
def process_request(self, request: _RequestType, client_address: _AddressType) -> None: ...
def process_request(self, request: _RequestType, client_address: _RetAddress) -> None: ...
def server_activate(self) -> None: ...
def server_bind(self) -> None: ...
def verify_request(self, request: _RequestType, client_address: _AddressType) -> bool: ...
def verify_request(self, request: _RequestType, client_address: _RetAddress) -> bool: ...
def __enter__(self: Self) -> Self: ...
def __exit__(
self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: types.TracebackType | None
Expand All @@ -72,32 +74,35 @@ class BaseServer:
class TCPServer(BaseServer):
if sys.version_info >= (3, 11):
allow_reuse_port: bool
server_address: _AfInetAddress # type: ignore[assignment]
def __init__(
self: Self,
server_address: tuple[str, int],
RequestHandlerClass: Callable[[Any, Any, Self], BaseRequestHandler],
server_address: _AfInetAddress,
RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler],
bind_and_activate: bool = ...,
) -> None: ...
def get_request(self) -> tuple[_socket, Any]: ...
def get_request(self) -> tuple[_socket, _RetAddress]: ...

class UDPServer(TCPServer):
max_packet_size: ClassVar[int]
def get_request(self) -> tuple[tuple[bytes, _socket], Any]: ... # type: ignore[override]
def get_request(self) -> tuple[tuple[bytes, _socket], _RetAddress]: ... # type: ignore[override]

if sys.platform != "win32":
class UnixStreamServer(BaseServer):
server_address: _AfUnixAddress # type: ignore[assignment]
def __init__(
self: Self,
server_address: str | bytes,
RequestHandlerClass: Callable[[Any, Any, Self], BaseRequestHandler],
server_address: _AfUnixAddress,
RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler],
bind_and_activate: bool = ...,
) -> None: ...

class UnixDatagramServer(BaseServer):
server_address: _AfUnixAddress # type: ignore[assignment]
def __init__(
self: Self,
server_address: str | bytes,
RequestHandlerClass: Callable[[Any, Any, Self], BaseRequestHandler],
server_address: _AfUnixAddress,
RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler],
bind_and_activate: bool = ...,
) -> None: ...

Expand All @@ -110,14 +115,14 @@ if sys.platform != "win32":
def collect_children(self, *, blocking: bool = ...) -> None: ... # undocumented
def handle_timeout(self) -> None: ... # undocumented
def service_actions(self) -> None: ... # undocumented
def process_request(self, request: _RequestType, client_address: _AddressType) -> None: ...
def process_request(self, request: _RequestType, client_address: _RetAddress) -> None: ...
def server_close(self) -> None: ...

class ThreadingMixIn:
daemon_threads: bool
block_on_close: bool
def process_request_thread(self, request: _RequestType, client_address: _AddressType) -> None: ... # undocumented
def process_request(self, request: _RequestType, client_address: _AddressType) -> None: ...
def process_request_thread(self, request: _RequestType, client_address: _RetAddress) -> None: ... # undocumented
def process_request(self, request: _RequestType, client_address: _RetAddress) -> None: ...
def server_close(self) -> None: ...

if sys.platform != "win32":
Expand All @@ -132,16 +137,16 @@ if sys.platform != "win32":
class ThreadingUnixDatagramServer(ThreadingMixIn, UnixDatagramServer): ...

class BaseRequestHandler:
# Those are technically of types, respectively:
# * _RequestType
# * _AddressType
# But there are some concerns that having unions here would cause
# `request` is technically of type _RequestType,
# but there are some concerns that having a union here would cause
# too much inconvenience to people using it (see
# https://github.com/python/typeshed/pull/384#issuecomment-234649696)
#
# Note also that _RetAddress is also just an alias for `Any`
request: Any
client_address: Any
client_address: _RetAddress
server: BaseServer
def __init__(self, request: _RequestType, client_address: _AddressType, server: BaseServer) -> None: ...
def __init__(self, request: _RequestType, client_address: _RetAddress, server: BaseServer) -> None: ...
def setup(self) -> None: ...
def handle(self) -> None: ...
def finish(self) -> None: ...
Expand Down