rnet 3.0.0rc1__cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

rnet/blocking.py

@@ -0,0 +1,511 @@
+from typing import Unpack
+from rnet import Message, Proxy, Request, Streamer, WebSocketRequest
+import ipaddress
+from typing import (
+    Optional,
+    Union,
+    Any,
+    Dict,
+    List,
+    Unpack,
+)
+from pathlib import Path
+
+from rnet import Version, Method, SocketAddr, StatusCode
+from rnet.tls import CertStore, KeyLogPolicy, TlsVersion, Identity
+from rnet.header import HeaderMap, OrigHeaderMap
+from rnet.cookie import Cookie, Jar
+from rnet.emulation import EmulationOption, Emulation
+
+
+class Client:
+    r"""
+    A blocking client for making HTTP requests.
+    """
+
+    def __new__(
+        cls,
+        emulation: Optional[Union[Emulation, EmulationOption]] = None,
+        user_agent: Optional[str] = None,
+        headers: Optional[Union[Dict[str, str], HeaderMap]] = None,
+        orig_headers: Optional[Union[List[str], OrigHeaderMap]] = None,
+        referer: Optional[bool] = None,
+        allow_redirects: Optional[bool] = None,
+        max_redirects: Optional[int] = None,
+        cookie_store: Optional[bool] = None,
+        cookie_provider: Optional[Jar] = None,
+        timeout: Optional[int] = None,
+        connect_timeout: Optional[int] = None,
+        read_timeout: Optional[int] = None,
+        no_keepalive: Optional[bool] = None,
+        tcp_keepalive: Optional[int] = None,
+        tcp_keepalive_interval: Optional[int] = None,
+        tcp_keepalive_retries: Optional[int] = None,
+        tcp_user_timeout: Optional[int] = None,
+        tcp_nodelay: Optional[bool] = None,
+        tcp_reuse_address: Optional[bool] = None,
+        pool_idle_timeout: Optional[int] = None,
+        pool_max_idle_per_host: Optional[int] = None,
+        pool_max_size: Optional[int] = None,
+        http1_only: Optional[bool] = None,
+        http2_only: Optional[bool] = None,
+        https_only: Optional[bool] = None,
+        http2_max_retry_count: Optional[int] = None,
+        verify: Optional[Union[bool, Path, CertStore]] = None,
+        identity: Optional[Identity] = None,
+        keylog: Optional[KeyLogPolicy] = None,
+        tls_info: Optional[bool] = None,
+        min_tls_version: Optional[TlsVersion] = None,
+        max_tls_version: Optional[TlsVersion] = None,
+        no_proxy: Optional[bool] = None,
+        proxies: Optional[List[Proxy]] = None,
+        local_address: Optional[
+            Union[str, ipaddress.IPv4Address, ipaddress.IPv6Address]
+        ] = None,
+        interface: Optional[str] = None,
+        gzip: Optional[bool] = None,
+        brotli: Optional[bool] = None,
+        deflate: Optional[bool] = None,
+        zstd: Optional[bool] = None,
+    ) -> "Client":
+        r"""
+        Creates a new blocking Client instance.
+
+        Args:
+            emulation: Browser fingerprint/Emulation config.
+            user_agent: Default User-Agent string.
+            headers: Default request headers.
+            orig_headers: Original request headers (case-sensitive and order).
+            referer: Automatically set Referer.
+            allow_redirects: Allow automatic redirects.
+            max_redirects: Maximum number of redirects.
+            cookie_store: Enable cookie store.
+            lookup_ip_strategy: IP lookup strategy.
+            timeout: Total timeout (seconds).
+            connect_timeout: Connection timeout (seconds).
+            read_timeout: Read timeout (seconds).
+            no_keepalive: Disable HTTP keep-alive.
+            tcp_keepalive: TCP keepalive time (seconds).
+            tcp_keepalive_interval: TCP keepalive interval (seconds).
+            tcp_keepalive_retries: TCP keepalive retry count.
+            tcp_user_timeout: TCP user timeout (seconds).
+            tcp_nodelay: Enable TCP_NODELAY.
+            tcp_reuse_address: Enable SO_REUSEADDR.
+            pool_idle_timeout: Connection pool idle timeout (seconds).
+            pool_max_idle_per_host: Max idle connections per host.
+            pool_max_size: Max total connections in pool.
+            http1_only: Enable HTTP/1.1 only.
+            http2_only: Enable HTTP/2 only.
+            https_only: Enable HTTPS only.
+            http2_max_retry_count: Max HTTP/2 retry count.
+            verify: Verify SSL or specify CA path.
+            identity: Represents a private key and X509 cert as a client certificate.
+            keylog: Key logging policy (environment or file).
+            tls_info: Return TLS info.
+            min_tls_version: Minimum TLS version.
+            max_tls_version: Maximum TLS version.
+            no_proxy: Disable proxy.
+            proxies: Proxy server list.
+            local_address: Local bind address.
+            interface: Local network interface.
+            gzip: Enable gzip decompression.
+            brotli: Enable brotli decompression.
+            deflate: Enable deflate decompression.
+            zstd: Enable zstd decompression.
+
+        # Examples
+
+        ```python
+        import asyncio
+        import rnet
+
+        client = rnet.blocking.Client(
+            user_agent="my-app/0.0.1",
+            timeout=10,
+        )
+        response = client.get('https://httpbin.org/get')
+        print(response.text())
+        ```
+        """
+
+    def request(
+        self,
+        method: Method,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given method and URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.request(Method.GET, "https://httpbin.org/anything")
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def websocket(self, url: str, **kwargs: Unpack[WebSocketRequest]) -> "WebSocket":
+        r"""
+        Sends a WebSocket request.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+
+        async def main():
+            client = rnet.blocking.Client()
+            ws = client.websocket("wss://echo.websocket.org")
+            ws.send(rnet.Message.from_text("Hello, WebSocket!"))
+            message = ws.recv()
+            print("Received:", message.data)
+            ws.close()
+
+        asyncio.run(main())
+        ```
+        """
+
+    def trace(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.trace("https://httpbin.org/anything")
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def options(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.options("https://httpbin.org/anything")
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def head(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.head("https://httpbin.org/anything")
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def delete(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.delete("https://httpbin.org/anything")
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def patch(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.patch("https://httpbin.org/anything", json={"key": "value"})
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def put(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.put("https://httpbin.org/anything", json={"key": "value"})
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def post(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.post("https://httpbin.org/anything", json={"key": "value"})
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+    def get(
+        self,
+        url: str,
+        **kwargs: Unpack[Request],
+    ) -> "Response":
+        r"""
+        Sends a request with the given URL.
+
+        # Examples
+
+        ```python
+        import rnet
+        import asyncio
+        from rnet import Method
+
+        async def main():
+            client = rnet.blocking.Client()
+            response = client.get("https://httpbin.org/anything")
+            print(response.text())
+
+        asyncio.run(main())
+        ```
+        """
+
+
+class Response:
+    r"""
+    A blocking response from a request.
+    """
+
+    url: str
+    r"""
+    Returns the URL of the response.
+    """
+    status: StatusCode
+    r"""
+    Returns the status code of the response.
+    """
+    version: Version
+    r"""
+    Returns the HTTP version of the response.
+    """
+    headers: HeaderMap
+    r"""
+    Returns the headers of the response.
+    """
+    cookies: List[Cookie]
+    r"""
+    Returns the cookies of the response.
+    """
+    content_length: int
+    r"""
+    Returns the content length of the response.
+    """
+    remote_addr: Optional[SocketAddr]
+    r"""
+    Returns the remote address of the response.
+    """
+    encoding: str
+    r"""
+    Encoding to decode with when accessing text.
+    """
+
+    def __enter__(self) -> "Response": ...
+    def __exit__(self, _exc_type: Any, _exc_value: Any, _traceback: Any) -> None: ...
+    def peer_certificate(self) -> Optional[bytes]:
+        r"""
+        Returns the TLS peer certificate of the response.
+        """
+
+    def text(self) -> str:
+        r"""
+        Returns the text content of the response.
+        """
+
+    def text_with_charset(self, encoding: str) -> str:
+        r"""
+        Returns the text content of the response with a specific charset.
+
+        # Arguments
+
+        * `encoding` - The default encoding to use if the charset is not specified.
+        """
+
+    def json(self) -> Any:
+        r"""
+        Returns the JSON content of the response.
+        """
+
+    def bytes(self) -> bytes:
+        r"""
+        Returns the bytes content of the response.
+        """
+
+    def stream(self) -> Streamer:
+        r"""
+        Convert the response into a `Stream` of `Bytes` from the body.
+        """
+
+    def close(self) -> None:
+        r"""
+        Closes the response connection.
+        """
+
+
+class WebSocket:
+    r"""
+    A blocking WebSocket response.
+    """
+
+    status: StatusCode
+    r"""
+    Returns the status code of the response.
+    """
+    version: Version
+    r"""
+    Returns the HTTP version of the response.
+    """
+    headers: HeaderMap
+    r"""
+    Returns the headers of the response.
+    """
+    cookies: List[Cookie]
+    r"""
+    Returns the cookies of the response.
+    """
+    remote_addr: Optional[SocketAddr]
+    r"""
+    Returns the remote address of the response.
+    """
+    protocol: Optional[str]
+    r"""
+    Returns the WebSocket protocol.
+    """
+
+    def __iter__(self) -> "WebSocket": ...
+    def __next__(self) -> Message: ...
+    def __enter__(self) -> "WebSocket": ...
+    def __exit__(self, _exc_type: Any, _exc_value: Any, _traceback: Any) -> None: ...
+    def recv(self) -> Optional[Message]:
+        r"""
+        Receives a message from the WebSocket.
+        """
+
+    def send(self, message: Message) -> None:
+        r"""
+        Sends a message to the WebSocket.
+
+        # Arguments
+
+        * `message` - The message to send.
+        """
+
+    def close(
+        self,
+        code: Optional[int] = None,
+        reason: Optional[str] = None,
+    ) -> None:
+        r"""
+        Closes the WebSocket connection.
+
+        # Arguments
+
+        * `code` - An optional close code.
+        * `reason` - An optional reason for closing.
+        """

rnet/cookie.py

@@ -0,0 +1,130 @@
+"""
+HTTP Cookie Management
+
+This module provides classes for creating, managing, and storing HTTP cookies
+in a thread-safe manner. It includes support for all standard cookie attributes
+and provides a cookie jar for automatic cookie handling during HTTP requests.
+"""
+
+import datetime
+from enum import Enum, auto
+from typing import Optional
+
+
+class SameSite(Enum):
+    r"""
+    The Cookie SameSite attribute.
+    """
+
+    Strict = auto()
+    Lax = auto()
+    Empty = auto()
+
+
+class Cookie:
+    r"""
+    A cookie.
+    """
+
+    name: str
+    r"""
+    The name of the cookie.
+    """
+    value: str
+    r"""
+    The value of the cookie.
+    """
+    http_only: bool
+    r"""
+    Returns true if the 'HttpOnly' directive is enabled.
+    """
+    secure: bool
+    r"""
+    Returns true if the 'Secure' directive is enabled.
+    """
+    same_site_lax: bool
+    r"""
+    Returns true if  'SameSite' directive is 'Lax'.
+    """
+    same_site_strict: bool
+    r"""
+    Returns true if  'SameSite' directive is 'Strict'.
+    """
+    path: Optional[str]
+    r"""
+    Returns the path directive of the cookie, if set.
+    """
+    domain: Optional[str]
+    r"""
+    Returns the domain directive of the cookie, if set.
+    """
+    max_age: Optional[datetime.timedelta]
+    r"""
+    Get the Max-Age information.
+    """
+    expires: Optional[datetime.datetime]
+    r"""
+    The cookie expiration time.
+    """
+
+    def __new__(
+        cls,
+        name: str,
+        value: str,
+        domain: Optional[str] = None,
+        path: Optional[str] = None,
+        max_age: Optional[datetime.timedelta] = None,
+        expires: Optional[datetime.datetime] = None,
+        http_only: bool = False,
+        secure: bool = False,
+        same_site: Optional[SameSite] = None,
+    ) -> "Cookie":
+        r"""
+        Create a new cookie.
+        """
+
+    def __str__(self) -> str: ...
+
+
+class Jar:
+    r"""
+    A thread-safe cookie jar for storing and managing HTTP cookies.
+
+    This cookie jar can be safely shared across multiple threads and is used
+    to automatically handle cookies during HTTP requests and responses.
+    """
+
+    def __new__(cls) -> "Jar":
+        r"""
+        Create a new cookie jar.
+        """
+
+    def get(self, name: str, url: str) -> Optional[Cookie]:
+        r"""
+        Get a cookie by name and URL.
+        """
+
+    def get_all(self) -> list[Cookie]:
+        r"""
+        Get all cookies.
+        """
+
+    def add(self, cookie: Cookie, url: str) -> None:
+        r"""
+        Add a cookie to this jar.
+        """
+
+    def add_cookie_str(self, cookie: str, url: str) -> None:
+        r"""
+        Add a cookie str to this jar.
+        """
+
+    def remove(self, name: str, url: str) -> None:
+        r"""
+        Remove a cookie from this jar by name and URL.
+        """
+
+    def clear(self) -> None:
+        r"""
+        Clear all cookies in this jar.
+        """