typeshed/stdlib/http/server.pyi at main · python/typeshed · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

import _socket

import email.message

import io

import socketserver

import sys

from _ssl import _PasswordType

from _typeshed import ReadableBuffer, StrOrBytesPath, StrPath, SupportsRead, SupportsWrite

from collections.abc import Callable, Iterable, Mapping, Sequence

from ssl import Purpose, SSLContext

from typing import Any, AnyStr, BinaryIO, ClassVar, Protocol, type_check_only

from typing_extensions import Self, deprecated

__all__ = ["HTTPServer", "ThreadingHTTPServer", "BaseHTTPRequestHandler", "SimpleHTTPRequestHandler"]

if sys.version_info < (3, 15):

__all__ += ["CGIHTTPRequestHandler"]

if sys.version_info >= (3, 14):

__all__ = ["HTTPSServer", "ThreadingHTTPSServer"]

class HTTPServer(socketserver.TCPServer):

server_name: str

server_port: int

class ThreadingHTTPServer(socketserver.ThreadingMixIn, HTTPServer): ...

if sys.version_info >= (3, 14):

@type_check_only

class _SSLModule(Protocol):

@staticmethod

def create_default_context(

purpose: Purpose = ...,

cafile: StrOrBytesPath | None = None,

capath: StrOrBytesPath | None = None,

cadata: str | ReadableBuffer | None = None,

) -> SSLContext: ...

class HTTPSServer(HTTPServer):

ssl: _SSLModule

certfile: StrOrBytesPath

keyfile: StrOrBytesPath | None

password: _PasswordType | None

alpn_protocols: Iterable[str]

def __init__(

self,

server_address: socketserver._AfInetAddress,

RequestHandlerClass: Callable[[Any, _socket._RetAddress, Self], socketserver.BaseRequestHandler],

bind_and_activate: bool = True,

certfile: StrOrBytesPath,

keyfile: StrOrBytesPath | None = None,

password: _PasswordType | None = None,

alpn_protocols: Iterable[str] | None = None,

) -> None: ...

def server_activate(self) -> None: ...

class ThreadingHTTPSServer(socketserver.ThreadingMixIn, HTTPSServer): ...

class BaseHTTPRequestHandler(socketserver.StreamRequestHandler):

client_address: tuple[str, int]

close_connection: bool

requestline: str

command: str

path: str

request_version: str

headers: email.message.Message

server_version: str

sys_version: str

error_message_format: str

error_content_type: str

protocol_version: str

MessageClass: type

responses: Mapping[int, tuple[str, str]]

if sys.version_info >= (3, 15):

default_content_type: str

default_request_version: str # undocumented

weekdayname: ClassVar[Sequence[str]] # undocumented

monthname: ClassVar[Sequence[str | None]] # undocumented

def handle_one_request(self) -> None: ...

def handle_expect_100(self) -> bool: ...

def send_error(self, code: int, message: str | None = None, explain: str | None = None) -> None: ...

def send_response(self, code: int, message: str | None = None) -> None: ...

def send_header(self, keyword: str, value: str) -> None: ...

def send_response_only(self, code: int, message: str | None = None) -> None: ...

def end_headers(self) -> None: ...

def flush_headers(self) -> None: ...

def log_request(self, code: int | str = "-", size: int | str = "-") -> None: ...

def log_error(self, format: str, *args: Any) -> None: ...

def log_message(self, format: str, *args: Any) -> None: ...

def version_string(self) -> str: ...

def date_time_string(self, timestamp: float | None = None) -> str: ...

def log_date_time_string(self) -> str: ...

def address_string(self) -> str: ...

def parse_request(self) -> bool: ... # undocumented

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):

extensions_map: dict[str, str]

if sys.version_info >= (3, 12):

index_pages: ClassVar[tuple[str, ...]]

directory: str

if sys.version_info >= (3, 15):

def __init__(

self,

request: socketserver._RequestType,

client_address: _socket._RetAddress,

server: socketserver.BaseServer,

directory: StrPath | None = None,

extra_response_headers: Mapping[str, str] | None = None,

) -> None: ...

else:

def __init__(

self,

request: socketserver._RequestType,

client_address: _socket._RetAddress,

server: socketserver.BaseServer,

directory: StrPath | None = None,

) -> None: ...

def do_GET(self) -> None: ...

def do_HEAD(self) -> None: ...

def send_head(self) -> io.BytesIO | BinaryIO | None: ... # undocumented

def list_directory(self, path: StrPath) -> io.BytesIO | None: ... # undocumented

def translate_path(self, path: str) -> str: ... # undocumented

def copyfile(self, source: SupportsRead[AnyStr], outputfile: SupportsWrite[AnyStr]) -> None: ... # undocumented

def guess_type(self, path: StrPath) -> str: ... # undocumented

def executable(path: StrPath) -> bool: ... # undocumented

if sys.version_info < (3, 15):

@deprecated("Deprecated and unsafe; removed in Python 3.15.")

class CGIHTTPRequestHandler(SimpleHTTPRequestHandler):

cgi_directories: list[str]

have_fork: bool # undocumented

def do_POST(self) -> None: ...

def is_cgi(self) -> bool: ... # undocumented

def is_executable(self, path: StrPath) -> bool: ... # undocumented

def is_python(self, path: StrPath) -> bool: ... # undocumented

def run_cgi(self) -> None: ... # undocumented

typeshed/stdlib/http/server.pyi at main · python/typeshed · GitHub

Repository navigation

Expand file tree

Breadcrumbs

server.pyi

Latest commit

History

Breadcrumbs

server.pyi

File metadata and controls