Skip to content

Commit 573d460

Browse files
committed
Add return type field to entry-point docstrings
Fixes: psf#2483
1 parent bc746e1 commit 573d460

File tree

2 files changed

+24
-8
lines changed

2 files changed

+24
-8
lines changed

AUTHORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,4 @@ Patches and Suggestions
159159
- Syed Suhail Ahmed <[email protected]> (`@syedsuhail <https://github.com/syedsuhail>`_)
160160
- Scott Sadler (`@ssadler <https://github.com/ssadler>`_)
161161
- Arthur Darcet (`@arthurdarcet <https://github.com/arthurdarcet>`_)
162+
- Ulrich Petri (`@ulope <https://github.com/ulope>`_)

requests/api.py

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
def request(method, url, **kwargs):
1818
"""Constructs and sends a :class:`Request <Request>`.
19-
Returns :class:`Response <Response>` object.
2019
2120
:param method: method for the new :class:`Request` object.
2221
:param url: URL for the new :class:`Request` object.
@@ -37,6 +36,8 @@ def request(method, url, **kwargs):
3736
:param verify: (optional) if ``True``, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
3837
:param stream: (optional) if ``False``, the response content will be immediately downloaded.
3938
:param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.
39+
:return: :class:`Response <Response>` object
40+
:rtype: requests.Response
4041
4142
Usage::
4243
@@ -55,77 +56,91 @@ def request(method, url, **kwargs):
5556

5657

5758
def get(url, **kwargs):
58-
"""Sends a GET request. Returns :class:`Response` object.
59+
"""Sends a GET request.
5960
6061
:param url: URL for the new :class:`Request` object.
6162
:param \*\*kwargs: Optional arguments that ``request`` takes.
63+
:return: :class:`Response <Response>` object
64+
:rtype: requests.Response
6265
"""
6366

6467
kwargs.setdefault('allow_redirects', True)
6568
return request('get', url, **kwargs)
6669

6770

6871
def options(url, **kwargs):
69-
"""Sends a OPTIONS request. Returns :class:`Response` object.
72+
"""Sends a OPTIONS request.
7073
7174
:param url: URL for the new :class:`Request` object.
7275
:param \*\*kwargs: Optional arguments that ``request`` takes.
76+
:return: :class:`Response <Response>` object
77+
:rtype: requests.Response
7378
"""
7479

7580
kwargs.setdefault('allow_redirects', True)
7681
return request('options', url, **kwargs)
7782

7883

7984
def head(url, **kwargs):
80-
"""Sends a HEAD request. Returns :class:`Response` object.
85+
"""Sends a HEAD request.
8186
8287
:param url: URL for the new :class:`Request` object.
8388
:param \*\*kwargs: Optional arguments that ``request`` takes.
89+
:return: :class:`Response <Response>` object
90+
:rtype: requests.Response
8491
"""
8592

8693
kwargs.setdefault('allow_redirects', False)
8794
return request('head', url, **kwargs)
8895

8996

9097
def post(url, data=None, json=None, **kwargs):
91-
"""Sends a POST request. Returns :class:`Response` object.
98+
"""Sends a POST request.
9299
93100
:param url: URL for the new :class:`Request` object.
94101
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
95102
:param json: (optional) json data to send in the body of the :class:`Request`.
96103
:param \*\*kwargs: Optional arguments that ``request`` takes.
104+
:return: :class:`Response <Response>` object
105+
:rtype: requests.Response
97106
"""
98107

99108
return request('post', url, data=data, json=json, **kwargs)
100109

101110

102111
def put(url, data=None, **kwargs):
103-
"""Sends a PUT request. Returns :class:`Response` object.
112+
"""Sends a PUT request.
104113
105114
:param url: URL for the new :class:`Request` object.
106115
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
107116
:param \*\*kwargs: Optional arguments that ``request`` takes.
117+
:return: :class:`Response <Response>` object
118+
:rtype: requests.Response
108119
"""
109120

110121
return request('put', url, data=data, **kwargs)
111122

112123

113124
def patch(url, data=None, **kwargs):
114-
"""Sends a PATCH request. Returns :class:`Response` object.
125+
"""Sends a PATCH request.
115126
116127
:param url: URL for the new :class:`Request` object.
117128
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
118129
:param \*\*kwargs: Optional arguments that ``request`` takes.
130+
:return: :class:`Response <Response>` object
131+
:rtype: requests.Response
119132
"""
120133

121134
return request('patch', url, data=data, **kwargs)
122135

123136

124137
def delete(url, **kwargs):
125-
"""Sends a DELETE request. Returns :class:`Response` object.
138+
"""Sends a DELETE request.
126139
127140
:param url: URL for the new :class:`Request` object.
128141
:param \*\*kwargs: Optional arguments that ``request`` takes.
142+
:return: :class:`Response <Response>` object
143+
:rtype: requests.Response
129144
"""
130145

131146
return request('delete', url, **kwargs)

0 commit comments

Comments
 (0)