| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031 |
- """
- Type stubs for primp - HTTP client that can impersonate web browsers.
- This module provides both synchronous and asynchronous HTTP clients with
- browser impersonation capabilities.
- """
- from typing import (
- Any,
- Dict,
- Iterator,
- Mapping,
- Optional,
- Tuple,
- Union,
- AsyncIterator,
- )
- # =============================================================================
- # Type Aliases
- # =============================================================================
- HeadersType = Optional[Mapping[str, str]]
- ParamsType = Optional[Mapping[str, str]]
- CookiesType = Optional[Mapping[str, str]]
- FilesType = Optional[Mapping[str, str]]
- AuthType = Optional[Tuple[str, Optional[str]]]
- # =============================================================================
- # Exception Classes
- # =============================================================================
- class PrimpError(Exception):
- """Base exception for all primp errors."""
- ...
- class BuilderError(PrimpError):
- """Error during client builder configuration."""
- ...
- class RequestError(PrimpError):
- """Error during request execution."""
- ...
- class ConnectError(RequestError):
- """Error connecting to the server."""
- ...
- class TimeoutError(RequestError):
- """Request timed out."""
- ...
- class StatusError(PrimpError):
- """HTTP status error (4xx/5xx)."""
- ...
- class RedirectError(PrimpError):
- """Error during redirect handling."""
- ...
- class BodyError(PrimpError):
- """Error with request/response body."""
- ...
- class DecodeError(PrimpError):
- """Error decoding response content."""
- ...
- class UpgradeError(PrimpError):
- """Error during protocol upgrade."""
- ...
- # =============================================================================
- # Response Classes (Synchronous)
- # =============================================================================
- class Response:
- """
- HTTP response object.
-
- Provides access to response status, headers, cookies, and body content.
- """
-
- # Properties (read-only)
- url: str
- status_code: int
-
- @property
- def content(self) -> bytes: ...
- @property
- def encoding(self) -> str: ...
- @encoding.setter
- def encoding(self, value: Optional[str]) -> None: ...
- @property
- def headers(self) -> Dict[str, str]: ...
- @property
- def cookies(self) -> Dict[str, str]: ...
- @property
- def text(self) -> str: ...
- @property
- def text_markdown(self) -> str: ...
- @property
- def text_plain(self) -> str: ...
- @property
- def text_rich(self) -> str: ...
-
- # Methods
- def json(self) -> Any: ...
- def raise_for_status(self) -> None: ...
- class StreamResponse:
- """
- Streaming HTTP response object.
-
- Supports iteration over response chunks and context manager protocol.
- """
-
- # Properties (read-only)
- url: str
- status_code: int
-
- @property
- def headers(self) -> Dict[str, str]: ...
- @property
- def cookies(self) -> Dict[str, str]: ...
- @property
- def encoding(self) -> str: ...
- @encoding.setter
- def encoding(self, value: str) -> None: ...
- @property
- def content(self) -> bytes: ...
- @property
- def text(self) -> str: ...
-
- # Methods
- def read(self) -> bytes: ...
- def iter_bytes(self, chunk_size: Optional[int] = None) -> BytesIterator: ...
- def iter_text(self, chunk_size: Optional[int] = None) -> TextIterator: ...
- def iter_lines(self) -> LinesIterator: ...
- def next(self) -> Optional[bytes]: ...
- def close(self) -> None: ...
- def raise_for_status(self) -> None: ...
-
- # Context manager
- def __enter__(self) -> StreamResponse: ...
- def __exit__(
- self,
- exc_type: Optional[Any],
- exc_value: Optional[Any],
- traceback: Optional[Any],
- ) -> bool: ...
- class BytesIterator:
- """Iterator over byte chunks from a streaming response."""
-
- def __iter__(self) -> BytesIterator: ...
- def __next__(self) -> bytes: ...
- class TextIterator:
- """Iterator over text chunks from a streaming response."""
-
- def __iter__(self) -> TextIterator: ...
- def __next__(self) -> str: ...
- class LinesIterator:
- """Iterator over lines from a streaming response."""
-
- def __iter__(self) -> LinesIterator: ...
- def __next__(self) -> str: ...
- # =============================================================================
- # Response Classes (Asynchronous)
- # =============================================================================
- class AsyncResponse:
- """
- Asynchronous HTTP response object.
-
- Provides access to response status, headers, cookies, and body content.
- All property access is synchronous but may block.
- """
-
- # Properties (read-only)
- url: str
- status_code: int
-
- @property
- def content(self) -> bytes: ...
- @property
- def encoding(self) -> str: ...
- @encoding.setter
- def encoding(self, value: Optional[str]) -> None: ...
- @property
- def headers(self) -> Dict[str, str]: ...
- @property
- def cookies(self) -> Dict[str, str]: ...
- @property
- def text(self) -> str: ...
- @property
- def text_markdown(self) -> str: ...
- @property
- def text_plain(self) -> str: ...
- @property
- def text_rich(self) -> str: ...
-
- # Methods
- def json(self) -> Any: ...
- def raise_for_status(self) -> None: ...
- class AsyncStreamResponse:
- """
- Asynchronous streaming HTTP response object.
-
- Supports async iteration over response chunks and async context manager protocol.
- """
-
- # Properties (read-only)
- url: str
- status_code: int
-
- @property
- def headers(self) -> Dict[str, str]: ...
- @property
- def cookies(self) -> Dict[str, str]: ...
- @property
- def encoding(self) -> str: ...
- @encoding.setter
- def encoding(self, value: str) -> None: ...
- @property
- def content(self) -> bytes: ...
- @property
- def text(self) -> str: ...
-
- # Async methods
- async def aread(self) -> bytes: ...
- def aiter_bytes(self, chunk_size: Optional[int] = None) -> AsyncBytesIterator: ...
- def aiter_text(self, chunk_size: Optional[int] = None) -> AsyncTextIterator: ...
- def aiter_lines(self) -> AsyncLinesIterator: ...
- async def anext(self) -> Optional[bytes]: ...
- async def aclose(self) -> None: ...
- def raise_for_status(self) -> None: ...
-
- # Async context manager
- async def __aenter__(self) -> AsyncStreamResponse: ...
- async def __aexit__(
- self,
- exc_type: Optional[Any],
- exc_value: Optional[Any],
- traceback: Optional[Any],
- ) -> bool: ...
- class AsyncBytesIterator:
- """Async iterator over byte chunks from a streaming response."""
-
- def __aiter__(self) -> AsyncBytesIterator: ...
- async def __anext__(self) -> bytes: ...
- class AsyncTextIterator:
- """Async iterator over text chunks from a streaming response."""
-
- def __aiter__(self) -> AsyncTextIterator: ...
- async def __anext__(self) -> str: ...
- class AsyncLinesIterator:
- """Async iterator over lines from a streaming response."""
-
- def __aiter__(self) -> AsyncLinesIterator: ...
- async def __anext__(self) -> str: ...
- # =============================================================================
- # Client Classes
- # =============================================================================
- class Client:
- """
- Synchronous HTTP client that can impersonate web browsers.
-
- This client supports browser impersonation, proxy configuration,
- cookie management, and various authentication methods.
-
- Example:
- >>> client = Client(impersonate="chrome_144")
- >>> response = client.get("https://example.com")
- >>> print(response.text)
- """
-
- # Instance properties
- auth: Optional[Tuple[str, Optional[str]]]
- auth_bearer: Optional[str]
- params: Optional[Mapping[str, str]]
- proxy: Optional[str]
- timeout: Optional[float]
-
- @property
- def headers(self) -> Dict[str, str]: ...
- @headers.setter
- def headers(self, value: Optional[Mapping[str, str]]) -> None: ...
- @property
- def impersonate(self) -> Optional[str]: ...
- @property
- def impersonate_os(self) -> Optional[str]: ...
-
- def __init__(
- self,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookie_store: bool = True,
- referer: bool = True,
- proxy: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- follow_redirects: bool = True,
- max_redirects: int = 20,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- https_only: bool = False,
- http2_only: bool = False,
- ) -> None: ...
-
- def headers_update(self, new_headers: Optional[Mapping[str, str]]) -> None: ...
- def get_cookies(self, url: str) -> Dict[str, str]: ...
- def set_cookies(self, url: str, cookies: Optional[Mapping[str, str]]) -> None: ...
-
- def request(
- self,
- method: str,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def get(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def head(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def options(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def delete(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def post(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def put(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- def patch(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]: ...
-
- # Context manager
- def __enter__(self) -> Client: ...
- def __exit__(
- self,
- exc_type: Optional[Any],
- exc_value: Optional[Any],
- traceback: Optional[Any],
- ) -> None: ...
- class AsyncClient:
- """
- Asynchronous HTTP client that can impersonate web browsers.
-
- This client supports browser impersonation, proxy configuration,
- cookie management, and various authentication methods.
-
- Example:
- >>> async with AsyncClient(impersonate="chrome_144") as client:
- ... response = await client.get("https://example.com")
- ... print(response.text)
- """
-
- # Instance properties
- auth: Optional[Tuple[str, Optional[str]]]
- auth_bearer: Optional[str]
- params: Optional[Mapping[str, str]]
- proxy: Optional[str]
- timeout: Optional[float]
-
- @property
- def headers(self) -> Dict[str, str]: ...
- @headers.setter
- def headers(self, value: Optional[Mapping[str, str]]) -> None: ...
- @property
- def impersonate(self) -> Optional[str]: ...
- @property
- def impersonate_os(self) -> Optional[str]: ...
-
- def __init__(
- self,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookie_store: bool = True,
- referer: bool = True,
- proxy: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- follow_redirects: bool = True,
- max_redirects: int = 20,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- https_only: bool = False,
- http2_only: bool = False,
- ) -> None: ...
-
- def headers_update(self, new_headers: Optional[Mapping[str, str]]) -> None: ...
- def get_cookies(self, url: str) -> Dict[str, str]: ...
- def set_cookies(self, url: str, cookies: Optional[Mapping[str, str]]) -> None: ...
-
- async def request(
- self,
- method: str,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def get(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def head(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def options(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def delete(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def post(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def put(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- async def patch(
- self,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- stream: bool = False,
- ) -> Union[AsyncResponse, AsyncStreamResponse]: ...
-
- # Async context manager
- async def __aenter__(self) -> AsyncClient: ...
- async def __aexit__(
- self,
- exc_type: Optional[Any],
- exc_value: Optional[Any],
- traceback: Optional[Any],
- ) -> None: ...
- # =============================================================================
- # Module-level Functions
- # =============================================================================
- def get(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a GET request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def head(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a HEAD request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def options(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send an OPTIONS request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def delete(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a DELETE request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def post(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a POST request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def put(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a PUT request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def patch(
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a PATCH request with a temporary client.
-
- Args:
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
- def request(
- method: str,
- url: str,
- params: Optional[Mapping[str, str]] = None,
- headers: Optional[Mapping[str, str]] = None,
- cookies: Optional[Mapping[str, str]] = None,
- content: Optional[bytes] = None,
- data: Optional[Any] = None,
- json: Optional[Any] = None,
- files: Optional[Mapping[str, str]] = None,
- auth: Optional[Tuple[str, Optional[str]]] = None,
- auth_bearer: Optional[str] = None,
- timeout: Optional[float] = None,
- impersonate: Optional[str] = None,
- impersonate_os: Optional[str] = None,
- verify: bool = True,
- ca_cert_file: Optional[str] = None,
- stream: bool = False,
- ) -> Union[Response, StreamResponse]:
- """
- Send a request with a custom HTTP method using a temporary client.
-
- Args:
- method: The HTTP method to use (e.g., "GET", "POST", "CUSTOM").
- url: The URL to request.
- params: Query parameters to append to the URL.
- headers: HTTP headers to send with the request.
- cookies: Cookies to send with the request.
- content: Raw bytes to send in the request body.
- data: Form data to send in the request body.
- json: JSON-serializable object to send in the request body.
- files: Mapping of field names to file paths for multipart upload.
- auth: Tuple of (username, password) for basic authentication.
- auth_bearer: Bearer token for authentication.
- timeout: Request timeout in seconds.
- impersonate: Browser to impersonate (e.g., "chrome_144").
- impersonate_os: OS to impersonate (e.g., "windows", "macos", "linux").
- verify: Whether to verify SSL certificates.
- ca_cert_file: Path to CA certificate file.
- stream: If True, returns a StreamResponse for streaming.
-
- Returns:
- Response or StreamResponse object.
- """
- ...
|