http_client_request 0.0.8__tar.gz → 0.0.9__tar.gz

{http_client_request-0.0.8 → http_client_request-0.0.9}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: http_client_request
-Version: 0.0.8
-Summary: ttp.client request extension.
+Version: 0.0.9
+Summary: http.client request extension.
 Home-page: https://github.com/ChenyangGao/python-modules/tree/main/http_client_request
 License: MIT
 Keywords: http.client,request
@@ -22,10 +22,10 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: http_response (>=0.0.9)
 Requires-Dist: python-argtools (>=0.0.2)
-Requires-Dist: python-cookietools (>=0.1.3)
+Requires-Dist: python-cookietools (>=0.1.4)
 Requires-Dist: python-dicttools (>=0.0.4)
-Requires-Dist: python-filewrap (>=0.2.8)
-Requires-Dist: python-http_request (>=0.1.4)
+Requires-Dist: python-filewrap (>=0.2.9)
+Requires-Dist: python-http_request (>=0.1.6)
 Requires-Dist: python-property (>=0.0.3)
 Requires-Dist: python-undefined (>=0.0.3)
 Requires-Dist: urllib3

{http_client_request-0.0.8 → http_client_request-0.0.9}/http_client_request/__init__.py

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 __author__ = "ChenyangGao <https://chenyanggao.github.io>"
-__version__ = (0, 0, 8)
+__version__ = (0, 0, 9)
 __all__ = [
     "CONNECTION_POOL", "HTTPConnection", "HTTPSConnection", "HTTPResponse", 
     "ConnectionPool", "request", 
@@ -24,6 +24,7 @@ from http.cookies import BaseCookie
 from io import BufferedReader
 from inspect import signature
 from os import PathLike
+from platform import system
 from select import select
 from socket import socket as Socket
 from ssl import SSLWantReadError
@@ -74,6 +75,68 @@ def sock_buf_readable(sock: Socket, /) -> bool:
     return bool(rlist)
 
 
+def set_keepalive_linux(
+    sock: Socket, 
+    after_idle_sec: int = 1, 
+    interval_sec: int = 5, 
+    max_fails: int = 5, 
+):
+    """Set TCP keepalive on an open socket on Linux.
+    """
+    sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+    sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, after_idle_sec) # type: ignore
+    sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, interval_sec)
+    sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, max_fails)
+
+
+def set_keepalive_osx(
+    sock: Socket, 
+    after_idle_sec: int = 1, 
+    interval_sec: int = 5, 
+    max_fails: int = 5, 
+):
+    """Set TCP keepalive on an open socket on MaxOSX.
+    """
+    sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+    sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPALIVE, after_idle_sec) # type: ignore
+    sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, interval_sec)
+    sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, max_fails)
+
+
+def set_keepalive_win(
+    sock: Socket, 
+    after_idle_sec: int = 1, 
+    interval_sec: int = 5, 
+    max_fails: int = 5, 
+):
+    """Set TCP keepalive on an open socket on Windows.
+    """
+    sock.ioctl(socket.SIO_KEEPALIVE_VALS, (1, after_idle_sec * 1000, interval_sec * 1000)) # type: ignore
+
+
+def set_keepalive(
+    sock: Socket, 
+    after_idle_sec: int = 1, 
+    interval_sec: int = 3, 
+    max_fails: int = 5, 
+):
+    """Set TCP keepalive on an open socket on multiple platforms.
+
+    It activates after `after_idle_sec` second of idleness,
+    then sends a keepalive ping once every `interval_sec` seconds,
+    and closes the connection after `max_fails` failed ping (max_fails), or 15 seconds.
+    """
+    platform = system()
+    match platform:
+        case "Darwin":
+            return set_keepalive_osx(sock, after_idle_sec, interval_sec, max_fails)
+        case "Windows":
+            return set_keepalive_win(sock, after_idle_sec, interval_sec, max_fails)
+        case "Linux":
+            return set_keepalive_linux(sock, after_idle_sec, interval_sec, max_fails)
+    raise RuntimeError(f"unsupport platform {platform!r}")
+
+
 try:
     from fcntl import ioctl
     from termios import FIONREAD
@@ -220,6 +283,10 @@ class HTTPConnection(BaseHTTPConnection):
     def response(self, /) -> None | HTTPResponse:
         return self._HTTPConnection__response # type: ignore
 
+    def connect(self, /):
+        super().connect()
+        set_keepalive(self.sock)
+
     def getresponse(self, /) -> HTTPResponse:
         return cast(HTTPResponse, super().getresponse())
 
@@ -241,6 +308,10 @@ class HTTPSConnection(BaseHTTPSConnection):
     def response(self, /) -> None | HTTPResponse:
         return self._HTTPConnection__response # type: ignore
 
+    def connect(self, /):
+        super().connect()
+        set_keepalive(self.sock)
+
     def getresponse(self, /) -> HTTPResponse:
         return cast(HTTPResponse, super().getresponse())
 

{http_client_request-0.0.8 → http_client_request-0.0.9}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "http_client_request"
-version = "0.0.8"
-description = "ttp.client request extension."
+version = "0.0.9"
+description = "http.client request extension."
 authors = ["ChenyangGao <wosiwujm@gmail.com>"]
 license = "MIT"
 readme = "readme.md"
@@ -29,10 +29,10 @@ include = [
 python = "^3.12"
 http_response = ">=0.0.9"
 python-argtools = ">=0.0.2"
-python-cookietools = ">=0.1.3"
+python-cookietools = ">=0.1.4"
 python-dicttools = ">=0.0.4"
-python-filewrap = ">=0.2.8"
-python-http_request = ">=0.1.4"
+python-filewrap = ">=0.2.9"
+python-http_request = ">=0.1.6"
 python-property = ">=0.0.3"
 python-undefined = ">=0.0.3"
 urllib3 = "*"