Author SHA1 Message Date
klemek 60e70ea0c0 fix: hide python version
Python Lint CI / ruff (push) Successful in 58s
Python Lint CI / ruff-format-check (push) Successful in 1m0s
Python Lint CI / ty (push) Successful in 1m0s
Docker CI / docker-build (push) Successful in 2m52s
Python Test CI / coverage (push) Successful in 2m30s
2026-05-26 10:58:16 +02:00
klemek 9cefd6657a feat: send HSTS header 2026-05-26 10:58:05 +02:00
klemek 1e5f3ba986 chore: release 1.4.0
Python Lint CI / ruff (push) Successful in 2m16s
Docker CI / docker-build (push) Successful in 3m8s
Python Lint CI / ruff-format-check (push) Successful in 2m33s
Python Lint CI / ty (push) Successful in 5m13s
Python Test CI / coverage (push) Successful in 5m6s
2026-05-11 17:26:42 +02:00
klemek d3d98bd9b2 feat: handle HEAD requests 2026-05-11 17:26:21 +02:00
4 changed files with 41 additions and 11 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
[project] [project]
name = "stapler" name = "stapler"
version = "1.3.2" version = "1.4.0"
description = "Static pages as simple as a gzip file" description = "Static pages as simple as a gzip file"
requires-python = ">=3.14" requires-python = ">=3.14"
dependencies = [ dependencies = [
+24 -7
View File
@@ -29,6 +29,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
timeout = 10 timeout = 10
protocol_version = "HTTP/1.1" protocol_version = "HTTP/1.1"
REQUEST_COUNT = 0 REQUEST_COUNT = 0
RESPONSE_HEADERS: typing.ClassVar = {
"Connection": "close",
"Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload",
}
@typing.override @typing.override
def __init__( def __init__(
@@ -48,6 +52,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
self.connection.close() self.connection.close()
@typing.override
def version_string(self) -> str:
return self.server_version
@typing.override @typing.override
def send_error( def send_error(
self, self,
@@ -151,9 +159,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.send_response(code, message) self.send_response(code, message)
self.send_header("Content-Type", f"{content_type}; charset=UTF-8") self.send_header("Content-Type", f"{content_type}; charset=UTF-8")
self.send_header("Content-Length", str(len(encoded))) self.send_header("Content-Length", str(len(encoded)))
self.send_header("Connection", "close") self._send_basic_headers()
self.end_headers() self.end_headers()
self.wfile.write(encoded) if self.command != http.HTTPMethod.HEAD:
self.wfile.write(encoded)
self.close_connection = True self.close_connection = True
def send_status_only( def send_status_only(
@@ -166,7 +175,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
headers = {} headers = {}
self.send_response(code, message) self.send_response(code, message)
self.send_header("Content-Length", "0") self.send_header("Content-Length", "0")
self.send_header("Connection", "close") self._send_basic_headers()
for header, value in headers.items(): for header, value in headers.items():
self.send_header(header, value) self.send_header(header, value)
self.end_headers() self.end_headers()
@@ -220,9 +229,9 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
]: ]:
self.send_header(header, value.replace(target_host, self.host)) self.send_header(header, value.replace(target_host, self.host))
self.send_header("Content-Length", str(out_size := len(response.content))) self.send_header("Content-Length", str(out_size := len(response.content)))
self.send_header("Connection", "close") self._send_basic_headers()
self.end_headers() self.end_headers()
if out_size > 0: if out_size > 0 and self.command != http.HTTPMethod.HEAD:
self.wfile.write(response.content) self.wfile.write(response.content)
self.close_connection = True self.close_connection = True
@@ -268,6 +277,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.send_error(http.HTTPStatus.INTERNAL_SERVER_ERROR, str(e)) self.send_error(http.HTTPStatus.INTERNAL_SERVER_ERROR, str(e))
self.logger.exception("Internal Server Error") self.logger.exception("Internal Server Error")
def _send_basic_headers(self) -> None:
for header, value in self.RESPONSE_HEADERS.items():
self.send_header(header, value)
class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler): class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
protocol_version = "HTTP/1.1" protocol_version = "HTTP/1.1"
@@ -387,9 +400,13 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
def do_HEAD(self) -> None: def do_HEAD(self) -> None:
with self.handle_errors(): with self.handle_errors():
self._pre_log_request() self._pre_log_request()
if not self._proxy_or_redirect(): if self._proxy_or_redirect():
super().do_HEAD() return None
if self.path == "/" and self.host == self.default_host:
return self.send_basic_body(self.server_signature())
super().do_HEAD()
self.close_connection = True self.close_connection = True
return None
@typing.override @typing.override
def do_GET(self) -> None: def do_GET(self) -> None:
+15 -2
View File
@@ -36,6 +36,7 @@ class BaseHandlerTestCase(BaseTestCase, abc.ABC):
code: int, code: int,
message: str | None = None, message: str | None = None,
headers: dict[str, str] | None = None, headers: dict[str, str] | None = None,
content_length: int = 0,
) -> typing.Iterator[None]: ) -> typing.Iterator[None]:
if headers is None: if headers is None:
headers = {} headers = {}
@@ -46,7 +47,7 @@ class BaseHandlerTestCase(BaseTestCase, abc.ABC):
send_response_mock.assert_called_once_with(code, message) send_response_mock.assert_called_once_with(code, message)
send_header_mock.assert_has_calls( send_header_mock.assert_has_calls(
[ [
unittest.mock.call("Content-Length", "0"), unittest.mock.call("Content-Length", str(content_length)),
] ]
+ [unittest.mock.call(header, value) for header, value in headers.items()], + [unittest.mock.call(header, value) for header, value in headers.items()],
any_order=True, any_order=True,
@@ -192,9 +193,21 @@ class TestRequestHandler(BaseHandlerTestCase):
token_manager=self.token_manager, token_manager=self.token_manager,
) )
def test_do_head_forward(self) -> None: def test_do_head_index(self) -> None:
handler = self._get_handler() handler = self._get_handler()
with ( with (
self.expects_status_only(
handler, 200, content_length=len(handler.server_signature())
),
self.patch("http.server.SimpleHTTPRequestHandler.do_HEAD", count=0),
self.seal_mocks(),
):
handler.do_HEAD()
def test_do_head_forward(self) -> None:
handler = self._get_handler("/file")
with (
self.mock_call(self.registry.get_from_path, ["file"], Page("file")),
self.patch("http.server.SimpleHTTPRequestHandler.do_HEAD"), self.patch("http.server.SimpleHTTPRequestHandler.do_HEAD"),
self.seal_mocks(), self.seal_mocks(),
): ):
Generated
+1 -1
View File
@@ -212,7 +212,7 @@ wheels = [
[[package]] [[package]]
name = "stapler" name = "stapler"
version = "1.3.2" version = "1.4.0"
source = { editable = "." } source = { editable = "." }
dependencies = [ dependencies = [
{ name = "requests" }, { name = "requests" },