Skip to content

Commit ae09e4e

Browse files
milanboersAlexWaygoodAkuli
authored
Add more typing hints for requests (#7696)
Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: Akuli <[email protected]>
1 parent fa46774 commit ae09e4e

File tree

3 files changed

+211
-212
lines changed

3 files changed

+211
-212
lines changed

‎stubs/requests/@tests/stubtest_allowlist.txt

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,9 @@
1-
requests.Session.delete
2-
requests.Session.get
3-
requests.Session.head
4-
requests.Session.options
5-
requests.Session.patch
6-
requests.Session.post
7-
requests.Session.put
81
requests.adapters.PoolManager.connection_from_host
92
requests.adapters.PoolManager.connection_from_url
103
requests.adapters.PoolManager.urlopen
11-
requests.api.delete
12-
requests.api.get
13-
requests.api.head
14-
requests.api.options
15-
requests.api.patch
16-
requests.api.post
17-
requests.api.put
18-
requests.api.request
19-
requests.delete
20-
requests.get
21-
requests.head
224
requests.models.RequestField.__init__
235
requests.models.RequestField.from_tuples
24-
requests.options
256
requests.packages.VendorAlias
26-
requests.patch
27-
requests.post
28-
requests.put
29-
requests.request
30-
requests.sessions.Session.delete
31-
requests.sessions.Session.get
32-
requests.sessions.Session.head
33-
requests.sessions.Session.options
34-
requests.sessions.Session.patch
35-
requests.sessions.Session.post
36-
requests.sessions.Session.put
377
requests.sessions.SessionRedirectMixin.resolve_redirects
388
requests.structures.LookupDict.__getattr__
399
requests.structures.LookupDict.get

‎stubs/requests/requests/api.pyi

Lines changed: 97 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,142 +1,150 @@
11
from typing import Any
22

33
from .models import Response
4-
from .sessions import _Data, _Params
4+
from .sessions import RequestsCookieJar, _Auth, _Cert, _Data, _Files, _HooksInput, _Params, _TextMapping, _Timeout, _Verify
55

66
def request(
77
method: str | bytes,
88
url: str | bytes,
9+
*,
910
params: _Params | None = ...,
10-
data: Any | None = ...,
11-
headers: Any | None = ...,
12-
cookies: Any | None = ...,
13-
files: Any | None = ...,
14-
auth: Any | None = ...,
15-
timeout: Any | None = ...,
11+
data: _Data | None = ...,
12+
headers: _TextMapping | None = ...,
13+
cookies: RequestsCookieJar | _TextMapping | None = ...,
14+
files: _Files | None = ...,
15+
auth: _Auth | None = ...,
16+
timeout: _Timeout | None = ...,
1617
allow_redirects: bool = ...,
17-
proxies: Any | None = ...,
18-
hooks: Any | None = ...,
19-
stream: Any | None = ...,
20-
verify: Any | None = ...,
21-
cert: Any | None = ...,
18+
proxies: _TextMapping | None = ...,
19+
hooks: _HooksInput | None = ...,
20+
stream: bool | None = ...,
21+
verify: _Verify | None = ...,
22+
cert: _Cert | None = ...,
2223
json: Any | None = ...,
2324
) -> Response: ...
2425
def get(
2526
url: str | bytes,
2627
params: _Params | None = ...,
27-
data: Any | None = ...,
28-
headers: Any | None = ...,
29-
cookies: Any | None = ...,
30-
files: Any | None = ...,
31-
auth: Any | None = ...,
32-
timeout: Any | None = ...,
28+
*,
29+
data: _Data | None = ...,
30+
headers: _TextMapping | None = ...,
31+
cookies: RequestsCookieJar | _TextMapping | None = ...,
32+
files: _Files | None = ...,
33+
auth: _Auth | None = ...,
34+
timeout: _Timeout | None = ...,
3335
allow_redirects: bool = ...,
34-
proxies: Any | None = ...,
35-
hooks: Any | None = ...,
36-
stream: Any | None = ...,
37-
verify: Any | None = ...,
38-
cert: Any | None = ...,
36+
proxies: _TextMapping | None = ...,
37+
hooks: _HooksInput | None = ...,
38+
stream: bool | None = ...,
39+
verify: _Verify | None = ...,
40+
cert: _Cert | None = ...,
3941
json: Any | None = ...,
4042
) -> Response: ...
4143
def options(
4244
url: str | bytes,
45+
*,
4346
params: _Params | None = ...,
44-
data: Any | None = ...,
45-
headers: Any | None = ...,
46-
cookies: Any | None = ...,
47-
files: Any | None = ...,
48-
auth: Any | None = ...,
49-
timeout: Any | None = ...,
47+
data: _Data | None = ...,
48+
headers: _TextMapping | None = ...,
49+
cookies: RequestsCookieJar | _TextMapping | None = ...,
50+
files: _Files | None = ...,
51+
auth: _Auth | None = ...,
52+
timeout: _Timeout | None = ...,
5053
allow_redirects: bool = ...,
51-
proxies: Any | None = ...,
52-
hooks: Any | None = ...,
53-
stream: Any | None = ...,
54-
verify: Any | None = ...,
55-
cert: Any | None = ...,
54+
proxies: _TextMapping | None = ...,
55+
hooks: _HooksInput | None = ...,
56+
stream: bool | None = ...,
57+
verify: _Verify | None = ...,
58+
cert: _Cert | None = ...,
5659
json: Any | None = ...,
5760
) -> Response: ...
5861
def head(
5962
url: str | bytes,
63+
*,
6064
params: _Params | None = ...,
61-
data: Any | None = ...,
62-
headers: Any | None = ...,
63-
cookies: Any | None = ...,
64-
files: Any | None = ...,
65-
auth: Any | None = ...,
66-
timeout: Any | None = ...,
65+
data: _Data | None = ...,
66+
headers: _TextMapping | None = ...,
67+
cookies: RequestsCookieJar | _TextMapping | None = ...,
68+
files: _Files | None = ...,
69+
auth: _Auth | None = ...,
70+
timeout: _Timeout | None = ...,
6771
allow_redirects: bool = ...,
68-
proxies: Any | None = ...,
69-
hooks: Any | None = ...,
70-
stream: Any | None = ...,
71-
verify: Any | None = ...,
72-
cert: Any | None = ...,
72+
proxies: _TextMapping | None = ...,
73+
hooks: _HooksInput | None = ...,
74+
stream: bool | None = ...,
75+
verify: _Verify | None = ...,
76+
cert: _Cert | None = ...,
7377
json: Any | None = ...,
7478
) -> Response: ...
7579
def post(
7680
url: str | bytes,
77-
data: _Data = ...,
81+
data: _Data | None = ...,
7882
json: Any | None = ...,
83+
*,
7984
params: _Params | None = ...,
80-
headers: Any | None = ...,
81-
cookies: Any | None = ...,
82-
files: Any | None = ...,
83-
auth: Any | None = ...,
84-
timeout: Any | None = ...,
85+
headers: _TextMapping | None = ...,
86+
cookies: RequestsCookieJar | _TextMapping | None = ...,
87+
files: _Files | None = ...,
88+
auth: _Auth | None = ...,
89+
timeout: _Timeout | None = ...,
8590
allow_redirects: bool = ...,
86-
proxies: Any | None = ...,
87-
hooks: Any | None = ...,
88-
stream: Any | None = ...,
89-
verify: Any | None = ...,
90-
cert: Any | None = ...,
91+
proxies: _TextMapping | None = ...,
92+
hooks: _HooksInput | None = ...,
93+
stream: bool | None = ...,
94+
verify: _Verify | None = ...,
95+
cert: _Cert | None = ...,
9196
) -> Response: ...
9297
def put(
9398
url: str | bytes,
94-
data: _Data = ...,
99+
data: _Data | None = ...,
100+
*,
95101
params: _Params | None = ...,
96-
headers: Any | None = ...,
97-
cookies: Any | None = ...,
98-
files: Any | None = ...,
99-
auth: Any | None = ...,
100-
timeout: Any | None = ...,
102+
headers: _TextMapping | None = ...,
103+
cookies: RequestsCookieJar | _TextMapping | None = ...,
104+
files: _Files | None = ...,
105+
auth: _Auth | None = ...,
106+
timeout: _Timeout | None = ...,
101107
allow_redirects: bool = ...,
102-
proxies: Any | None = ...,
103-
hooks: Any | None = ...,
104-
stream: Any | None = ...,
105-
verify: Any | None = ...,
106-
cert: Any | None = ...,
108+
proxies: _TextMapping | None = ...,
109+
hooks: _HooksInput | None = ...,
110+
stream: bool | None = ...,
111+
verify: _Verify | None = ...,
112+
cert: _Cert | None = ...,
107113
json: Any | None = ...,
108114
) -> Response: ...
109115
def patch(
110116
url: str | bytes,
111-
data: _Data = ...,
117+
data: _Data | None = ...,
118+
*,
112119
params: _Params | None = ...,
113-
headers: Any | None = ...,
114-
cookies: Any | None = ...,
115-
files: Any | None = ...,
116-
auth: Any | None = ...,
117-
timeout: Any | None = ...,
120+
headers: _TextMapping | None = ...,
121+
cookies: RequestsCookieJar | _TextMapping | None = ...,
122+
files: _Files | None = ...,
123+
auth: _Auth | None = ...,
124+
timeout: _Timeout | None = ...,
118125
allow_redirects: bool = ...,
119-
proxies: Any | None = ...,
120-
hooks: Any | None = ...,
121-
stream: Any | None = ...,
122-
verify: Any | None = ...,
123-
cert: Any | None = ...,
126+
proxies: _TextMapping | None = ...,
127+
hooks: _HooksInput | None = ...,
128+
stream: bool | None = ...,
129+
verify: _Verify | None = ...,
130+
cert: _Cert | None = ...,
124131
json: Any | None = ...,
125132
) -> Response: ...
126133
def delete(
127134
url: str | bytes,
135+
*,
128136
params: _Params | None = ...,
129-
data: Any | None = ...,
130-
headers: Any | None = ...,
131-
cookies: Any | None = ...,
132-
files: Any | None = ...,
133-
auth: Any | None = ...,
134-
timeout: Any | None = ...,
137+
data: _Data | None = ...,
138+
headers: _TextMapping | None = ...,
139+
cookies: RequestsCookieJar | _TextMapping | None = ...,
140+
files: _Files | None = ...,
141+
auth: _Auth | None = ...,
142+
timeout: _Timeout | None = ...,
135143
allow_redirects: bool = ...,
136-
proxies: Any | None = ...,
137-
hooks: Any | None = ...,
138-
stream: Any | None = ...,
139-
verify: Any | None = ...,
140-
cert: Any | None = ...,
144+
proxies: _TextMapping | None = ...,
145+
hooks: _HooksInput | None = ...,
146+
stream: bool | None = ...,
147+
verify: _Verify | None = ...,
148+
cert: _Cert | None = ...,
141149
json: Any | None = ...,
142150
) -> Response: ...

0 commit comments

Comments
 (0)