Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[stubs] Create primp.pyi #71

Merged
merged 1 commit into from
Jan 7, 2025
Merged

[stubs] Create primp.pyi #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
325 changes: 325 additions & 0 deletions primp.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
from __future__ import annotations

from typing import Literal, Any

IMPERSONATE = Literal[
"chrome_100",
"chrome_101",
"chrome_104",
"chrome_105",
"chrome_106",
"chrome_107",
"chrome_108",
"chrome_109",
"chrome_114",
"chrome_116",
"chrome_117",
"chrome_118",
"chrome_119",
"chrome_120",
"chrome_123",
"chrome_124",
"chrome_126",
"chrome_127",
"chrome_128",
"chrome_129",
"chrome_130",
"chrome_131",
"safari_ios_16.5",
"safari_ios_17.2",
"safari_ios_17.4.1",
"safari_15.3",
"safari_15.5",
"safari_15.6.1",
"safari_16",
"safari_16.5",
"safari_17.0",
"safari_17.2.1",
"safari_17.4.1",
"safari_17.5",
"safari_18",
"safari_ios_18.1.1",
"safari_18.2",
"safari_ipad_18",
"okhttp_3.9",
"okhttp_3.11",
"okhttp_3.13",
"okhttp_3.14",
"okhttp_4.9",
"okhttp_4.10",
"okhttp_5",
"edge_101",
"edge_122",
"edge_127",
"edge_131",
"firefox_109",
"firefox_117",
"firefox_133",
]

class Response:
@property
def content(self) -> bytes: ...
@property
def cookies(self) -> dict[str, str]: ...
@property
def headers(self) -> dict[str, str]: ...
@property
def status_code(self) -> int: ...
@property
def url(self) -> str: ...
@property
def encoding(self) -> str: ...
@property
def text(self) -> str: ...
def json(self) -> Any: ...
@property
def text_markdown(self) -> str: ...
@property
def text_plain(self) -> str: ...
@property
def text_rich(self) -> str: ...

class Client:
def __init__(
self,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
timeout: float | None = None,
cookie_store: bool | None = True,
referer: bool | None = True,
proxy: str | None = None,
impersonate: IMPERSONATE | None = None,
follow_redirects: bool | None = True,
max_redirects: int | None = 20,
verify: bool | None = True,
ca_cert_file: str | None = None,
https_only: bool | None = False,
http2_only: bool | None = False,
) -> None: ...
@property
def headers(self) -> dict[str, str]: ...
@headers.setter
def headers(self, headers: dict[str, str]) -> None: ...
@property
def cookies(self) -> dict[str, str]: ...
@cookies.setter
def cookies(self, cookies: dict[str, str]) -> None: ...
@property
def proxy(self) -> str | None: ...
@proxy.setter
def proxy(self, proxy: str) -> None: ...
def request(
self,
method: str,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def get(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def head(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def options(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def delete(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def post(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def put(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...
def patch(
self,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
) -> Response: ...

def request(
method: str,
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def get(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def head(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def options(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def delete(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def post(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def put(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
def patch(
url: str,
params: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
cookies: dict[str, str] | None = None,
content: bytes | None = None,
data: dict[str, Any] | None = None,
json: Any | None = None,
files: dict[str, str] | None = None,
auth: tuple[str, str | None] | None = None,
auth_bearer: str | None = None,
timeout: float | None = None,
impersonate: IMPERSONATE | None = None,
verify: bool | None = None,
ca_cert_file: str | None = None,
) -> Response: ...
Loading