feat(proxy): move to proxy module and support unix sockets

Author: 0x676e67

python/examples/proxy.py

@@ -1,25 +1,12 @@
 import asyncio
 import rnet
 from rnet import Client, Proxy
-from rnet.emulation import Emulation
 
 
 async def main():
     # Create a client with multiple proxies
     client = Client(
-        proxies=[
-            Proxy.http("socks5h://abc:[email protected]:6152"),
-            Proxy.https(url="socks5h://127.0.0.1:6153", username="abc", password="def"),
-            Proxy.http(
-                url="http://abc:[email protected]:6152",
-                custom_http_auth="abcedf",
-                custom_http_headers={"User-Agent": "rnet", "x-custom-header": "value"},
-            ),
-            Proxy.all(
-                url="socks5h://abc:[email protected]:6153",
-                exclusion="google.com, facebook.com, twitter.com",
-            ),
-        ],
+        proxies=[Proxy.http("socks5h://abc:[email protected]:6152")],
     )
 
     resp = await client.get("https://httpbin.io/anything")

python/rnet/__init__.py

@@ -12,6 +12,7 @@
 from .tls import *
 from .dns import *
 from .redirect import *
+from .proxy import *
 
 __all__ = (
     header.__all__
@@ -23,4 +24,5 @@
     + tls.__all__
     + dns.__all__
     + redirect.__all__
+    + proxy.__all__
 )  # type: ignore

python/rnet/__init__.pyi

@@ -21,6 +21,7 @@ from .dns import ResolverOptions
 from .http1 import Http1Options
 from .http2 import Http2Options
 from .redirect import History
+from .proxy import *
 from .cookie import *
 from .header import *
 from .emulation import *
@@ -159,77 +160,6 @@ class Part:
         """
         ...
 
-class ProxyParams(TypedDict):
-    username: NotRequired[str]
-    r"""Username for proxy authentication."""
-
-    password: NotRequired[str]
-    r"""Password for proxy authentication."""
-
-    custom_http_auth: NotRequired[str]
-    r"""Custom HTTP proxy authentication header value."""
-
-    custom_http_headers: NotRequired[Dict[str, str] | HeaderMap]
-    r"""Custom HTTP proxy headers."""
-
-    exclusion: NotRequired[str]
-    r"""List of domains to exclude from proxying."""
-
-@final
-class Proxy:
-    r"""
-    A proxy server for a request.
-    Supports HTTP, HTTPS, SOCKS4, SOCKS4a, SOCKS5, and SOCKS5h protocols.
-    """
-
-    @staticmethod
-    def http(url: str, **kwargs: Unpack[ProxyParams]) -> "Proxy":
-        r"""
-        Creates a new HTTP proxy.
-
-        This method sets up a proxy server for HTTP requests.
-
-        # Examples
-
-        ```python
-        import rnet
-
-        proxy = rnet.Proxy.http("http://proxy.example.com")
-        ```
-        """
-
-    @staticmethod
-    def https(url: str, **kwargs: Unpack[ProxyParams]) -> "Proxy":
-        r"""
-        Creates a new HTTPS proxy.
-
-        This method sets up a proxy server for HTTPS requests.
-
-        # Examples
-
-        ```python
-        import rnet
-
-        proxy = rnet.Proxy.https("https://proxy.example.com")
-        ```
-        """
-
-    @staticmethod
-    def all(url: str, **kwargs: Unpack[ProxyParams]) -> "Proxy":
-        r"""
-        Creates a new proxy for all protocols.
-
-        This method sets up a proxy server for all types of requests (HTTP, HTTPS, etc.).
-
-        # Examples
-
-        ```python
-        import rnet
-
-        proxy = rnet.Proxy.all("https://proxy.example.com")
-        ```
-        """
-
 class Message:
     r"""
     A WebSocket message.
@@ -564,7 +494,7 @@ class WebSocket:
     def __aexit__(self, _exc_type: Any, _exc_value: Any, _traceback: Any) -> Any: ...
     def __str__(self) -> str: ...
 
-class ClientParams(TypedDict):
+class ClientConfig(TypedDict):
     emulation: NotRequired[Emulation | EmulationOption]
     """Emulation config."""
 
@@ -1078,7 +1008,7 @@ class Client:
 
     def __init__(
         self,
-        **kwargs: Unpack[ClientParams],
+        **kwargs: Unpack[ClientConfig],
     ) -> None:
         r"""
         Creates a new Client instance.

python/rnet/blocking.py

@@ -1,6 +1,6 @@
 import datetime
 from rnet import (
-    ClientParams,
+    ClientConfig,
     History,
     Message,
     Request,
@@ -205,7 +205,7 @@ class Client:
 
     def __init__(
         self,
-        **kwargs: Unpack[ClientParams],
+        **kwargs: Unpack[ClientConfig],
     ) -> None:
         r"""
         Creates a new blocking Client instance.

python/rnet/proxy.py

@@ -0,0 +1,98 @@
+from typing import Dict, NotRequired, TypedDict, Unpack, final
+
+from rnet.header import HeaderMap
+
+__all__ = ["Proxy"]
+
+
+class ProxyConfig(TypedDict):
+    username: NotRequired[str]
+    r"""Username for proxy authentication."""
+
+    password: NotRequired[str]
+    r"""Password for proxy authentication."""
+
+    custom_http_auth: NotRequired[str]
+    r"""Custom HTTP proxy authentication header value."""
+
+    custom_http_headers: NotRequired[Dict[str, str] | HeaderMap]
+    r"""Custom HTTP proxy headers."""
+
+    exclusion: NotRequired[str]
+    r"""List of domains to exclude from proxying."""
+
+
+@final
+class Proxy:
+    r"""
+    A proxy server for a request.
+    Supports HTTP, HTTPS, SOCKS4, SOCKS4a, SOCKS5, and SOCKS5h protocols.
+    """
+
+    @staticmethod
+    def http(url: str, **kwargs: Unpack[ProxyConfig]) -> "Proxy":
+        r"""
+        Creates a new HTTP proxy.
+
+        This method sets up a proxy server for HTTP requests.
+
+        # Examples
+
+        ```python
+        import rnet
+
+        proxy = rnet.Proxy.http("http://proxy.example.com")
+        ```
+        """
+        ...
+
+    @staticmethod
+    def https(url: str, **kwargs: Unpack[ProxyConfig]) -> "Proxy":
+        r"""
+        Creates a new HTTPS proxy.
+
+        This method sets up a proxy server for HTTPS requests.
+
+        # Examples
+
+        ```python
+        import rnet
+
+        proxy = rnet.Proxy.https("https://proxy.example.com")
+        ```
+        """
+        ...
+
+    @staticmethod
+    def all(url: str, **kwargs: Unpack[ProxyConfig]) -> "Proxy":
+        r"""
+        Creates a new proxy for all protocols.
+
+        This method sets up a proxy server for all types of requests (HTTP, HTTPS, etc.).
+
+        # Examples
+
+        ```python
+        import rnet
+
+        proxy = rnet.Proxy.all("https://proxy.example.com")
+        ```
+        """
+        ...
+
+    @staticmethod
+    def unix(path: str, **kwargs: Unpack[ProxyConfig]) -> "Proxy":
+        r"""
+        Creates a new UNIX socket proxy.
+
+        This method sets up a proxy server using a UNIX domain socket.
+
+        # Examples
+
+        ```python
+        import rnet
+
+        proxy = rnet.Proxy.unix("/var/run/docker.sock")
+        ```
+        """
+        ...

python/rnet/redirect.py

@@ -1,4 +1,4 @@
-from typing import Callable, Optional, Sequence, final
+from typing import Callable, Sequence, final
 
 from .header import HeaderMap
 from . import StatusCode