16
16
17
17
def request (method , url , ** kwargs ):
18
18
"""Constructs and sends a :class:`Request <Request>`.
19
- Returns :class:`Response <Response>` object.
20
19
21
20
:param method: method for the new :class:`Request` object.
22
21
:param url: URL for the new :class:`Request` object.
@@ -37,6 +36,8 @@ def request(method, url, **kwargs):
37
36
:param verify: (optional) if ``True``, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
38
37
:param stream: (optional) if ``False``, the response content will be immediately downloaded.
39
38
: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
40
41
41
42
Usage::
42
43
@@ -55,77 +56,91 @@ def request(method, url, **kwargs):
55
56
56
57
57
58
def get (url , ** kwargs ):
58
- """Sends a GET request. Returns :class:`Response` object.
59
+ """Sends a GET request.
59
60
60
61
:param url: URL for the new :class:`Request` object.
61
62
:param \*\*kwargs: Optional arguments that ``request`` takes.
63
+ :return: :class:`Response <Response>` object
64
+ :rtype: requests.Response
62
65
"""
63
66
64
67
kwargs .setdefault ('allow_redirects' , True )
65
68
return request ('get' , url , ** kwargs )
66
69
67
70
68
71
def options (url , ** kwargs ):
69
- """Sends a OPTIONS request. Returns :class:`Response` object.
72
+ """Sends a OPTIONS request.
70
73
71
74
:param url: URL for the new :class:`Request` object.
72
75
:param \*\*kwargs: Optional arguments that ``request`` takes.
76
+ :return: :class:`Response <Response>` object
77
+ :rtype: requests.Response
73
78
"""
74
79
75
80
kwargs .setdefault ('allow_redirects' , True )
76
81
return request ('options' , url , ** kwargs )
77
82
78
83
79
84
def head (url , ** kwargs ):
80
- """Sends a HEAD request. Returns :class:`Response` object.
85
+ """Sends a HEAD request.
81
86
82
87
:param url: URL for the new :class:`Request` object.
83
88
:param \*\*kwargs: Optional arguments that ``request`` takes.
89
+ :return: :class:`Response <Response>` object
90
+ :rtype: requests.Response
84
91
"""
85
92
86
93
kwargs .setdefault ('allow_redirects' , False )
87
94
return request ('head' , url , ** kwargs )
88
95
89
96
90
97
def post (url , data = None , json = None , ** kwargs ):
91
- """Sends a POST request. Returns :class:`Response` object.
98
+ """Sends a POST request.
92
99
93
100
:param url: URL for the new :class:`Request` object.
94
101
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
95
102
:param json: (optional) json data to send in the body of the :class:`Request`.
96
103
:param \*\*kwargs: Optional arguments that ``request`` takes.
104
+ :return: :class:`Response <Response>` object
105
+ :rtype: requests.Response
97
106
"""
98
107
99
108
return request ('post' , url , data = data , json = json , ** kwargs )
100
109
101
110
102
111
def put (url , data = None , ** kwargs ):
103
- """Sends a PUT request. Returns :class:`Response` object.
112
+ """Sends a PUT request.
104
113
105
114
:param url: URL for the new :class:`Request` object.
106
115
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
107
116
:param \*\*kwargs: Optional arguments that ``request`` takes.
117
+ :return: :class:`Response <Response>` object
118
+ :rtype: requests.Response
108
119
"""
109
120
110
121
return request ('put' , url , data = data , ** kwargs )
111
122
112
123
113
124
def patch (url , data = None , ** kwargs ):
114
- """Sends a PATCH request. Returns :class:`Response` object.
125
+ """Sends a PATCH request.
115
126
116
127
:param url: URL for the new :class:`Request` object.
117
128
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
118
129
:param \*\*kwargs: Optional arguments that ``request`` takes.
130
+ :return: :class:`Response <Response>` object
131
+ :rtype: requests.Response
119
132
"""
120
133
121
134
return request ('patch' , url , data = data , ** kwargs )
122
135
123
136
124
137
def delete (url , ** kwargs ):
125
- """Sends a DELETE request. Returns :class:`Response` object.
138
+ """Sends a DELETE request.
126
139
127
140
:param url: URL for the new :class:`Request` object.
128
141
:param \*\*kwargs: Optional arguments that ``request`` takes.
142
+ :return: :class:`Response <Response>` object
143
+ :rtype: requests.Response
129
144
"""
130
145
131
146
return request ('delete' , url , ** kwargs )
0 commit comments