伤心肠粉
伤心肠粉

reuqest API

MelonCholi 收录于  Python
    约 2721 字   预计阅读 6 分钟 

request API

模块

  • *requests.request(method, url, *kwargs)
  • *requests.get(url, params=None, *kwargs)
  • *requests.options(url, *kwargs)
  • *requests.head(url, *kwargs)
  • *requests.post(url, data=None, json=None, *kwargs)
  • *requests.put(url, data=None, *kwargs)
  • *requests.patch(url, data=None, *kwargs)
  • *requests.delete(url, *kwargs)

除了 requests.request() 外，其余 7 个方法与 http 协议中的请求方法一一对应。这 7 个方法其实都是在调用 requests.request() 方法

method简述
url请求的 url
params请求携带的 params
data请求 body 中的 data
json请求 body 中的 json 格式的 data
headers请求携带的 headers
cookies请求携带的 cookies
files上传文件时使用
auth身份认证时使用
timeout设置请求的超时时间，可以设置连接超时和读取超时
allow_redirects是否允许重定向，默认 True，即允许重定向
proxies设置请求的代理，支持 http 代理以及 socks 代理（需要安装第三方库 “pip install requests[socks]"）
verify用于 https 请求时的 ssl 证书验证，默认是开启的，如果不需要则设置为 False 即可
stream是否立即下载响应内容，默认是 False，即立即下载响应内容
cert用于指定本地文件用作客户端证书

基本调用

1
2
3
4
5
6
7
8

import requests
r = requests.request('get','https://api.github.com/events')
r = requests.get('https://api.github.com/events')
r = requests.post('http://httpbin.org/post', data = {'key':'value'})
r = requests.put('http://httpbin.org/put', data = {'key':'value'})
r = requests.delete('http://httpbin.org/delete')
r = requests.head('http://httpbin.org/get')
r = requests.options('http://httpbin.org/get')

返回 Response 对象

params

接受一个字典，用于传递 URL 参数

1
2
3

payload = {'key1': 'value1', 'key2': 'value2'}
r = requests.get("http://httpbin.org/get", params=payload)
print(r.url)

输出

1

http://httpbin.org/get?key1=value1&key2=value2

headers

接受一个字典，用于传递 header 参数（请求头）

1
2
3
4
5

url = 'https://tophub.today/n/mproPpoq6O'
headers = {
    'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36'
}
s = requests.get(url,headers=headers)

data

用于 POST 请求中，传递请求体中的 data 参数

该网站可以判断如果请求是 POST 方式，就把相关请求信息返回

1
2
3

data = {'name': 'germey', 'age': '22'}
r = requests.post("http://httpbin.org/post", data=data)
print(r.text)

输出

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "args": {}, 
  "data": "", 
  "files": {}, 
  "form": {
    "age": "22", 
    "name": "germey"
  }, 
  "headers": {
    "Accept": "*/*", 
    "Accept-Encoding": "gzip, deflate", 
    "Content-Length": "18", 
    "Content-Type": "application/x-www-form-urlencoded", 
    "Host": "httpbin.org", 
    "User-Agent": "python-requests/2.25.0", 
    "X-Amzn-Trace-Id": "Root=1-5fe43f55-5d4750b76935f7515662c3b3"
  }, 
  "json": null, 
  "origin": "59.79.2.148", 
  "url": "http://httpbin.org/post"
}

json

用于 POST 请求中，传递请求体中 json 格式的的 data 参数

files

上传文件

1
2
3
4

import requests
files = {'file': open('favicon.ico', 'rb')}
r = requests.post("http://httpbin.org/post", files=files)
print(r.text)

cookies

用于传递 cookies 参数，不过将 cookies 写在 headers 中比较方便

1
2
3
4
5

import requests
r = requests.get("https://www.baidu.com")
print(r.cookies)
for key, value in r.cookies.items():
    print(key + '=' + value)

输出

1
2

<RequestsCookieJar[<Cookie BDORZ=27315 for .baidu.com/>]>
BDORZ=27315

步骤

  1. 调用 cookies 属性，得到 Cookies，可以发现它是 RequestCookieJar 类型
  2. 用 items()方法将其转化为元组组成的列表，遍历输出每一个 Cookie 的名称和值，实现 Cookie 的遍历解析

verify

用于 https 请求时的 ssl 证书验证，默认是开启的，如果不需要则设置为 False 即可

例：请求一个 HTTPS 站点，但是证书验证错误的页面时，把 verify 参数设置为 False

1
2
3

import requests
response = requests.get('https://www.12306.cn', verify=False)
print(response.status_code)

输出

1
2
3

D:\Application\Anaconda\lib\site-packages\urllib3\connectionpool.py:988: InsecureRequestWarning: Unverified HTTPS request is being made to host 'www.12306.cn'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings
  InsecureRequestWarning,
200

报了一个警告，它建议我们给它指定证书

  • 可以通过设置忽略警告的方式来屏蔽这个警告
1
2

from requests.packages import urllib3
urllib3.disable_warnings()
  • 或者通过捕获警告到日志的方式忽略警告
1
2

import logging
logging.captureWarnings(True)
  • 可以指定一个本地证书用作客户端证书
1
2
3
4

import requests
response = requests.get('https://www.12306.cn',
                        cert=('/path/server.crt', '/path/key'))
print(response.status_code)

我们需要有 crt 和 key 文件，并且指定它们的路径。注意，本地私有证书的 key 必须是解密状态，加密状态的 key 是不支持的

proxies

设置请求的代理，支持 http 代理以及 socks 代理（需要安装第三方库 “pip install requests[socks]"）

1
2
3
4
5
6

import requests
proxies = {
	"http": "http://10.10.1.10:3128",
	"https": "http://10.10.1.10:1080",
}
requests.get("https://www.taobao.com", proxies=proxies)
  • 若代理需要使用 HTTP Basic Auth，可以使用类似http://user:password@host:port 这样的语法来设置代理
1
2
3

proxies = {
    "http": "http://user:password@10.10.1.10:3128/",
}
  • 使用 SOCKS 协议代理
1
2
3
4

proxies = {
	'http': 'socks5://user:password@host:port',
	'https': 'socks5://user:password@host:port'
}

timeout

设置请求的超时时间，（发出请求到服务器返回响应的时间），可以设置连接超时和读取超时

1
2
3

import requests
r = requests.get("https://www.taobao.com", timeout=1)
print(r.status_code)

  • 请求分为两个阶段，即连接（connect）和读取（read）。上面设置的 timeout 将用作连接和读取这二者的 timeout 总和

  • 如果想永久等待，可以直接将 timeout 设置为 None，或者不设置直接留空，因为默认是 None

auth

身份认证时使用

1
2
3
4
5

import requests
from requests.auth import HTTPBasicAuth
r = requests.get('http://localhost:5000',
                 auth=HTTPBasicAuth('username', 'password'))
print(r.status_code)

如果用户名和密码正确的话，请求时就会自动认证成功，会返回 200 状态码，如果认证失败，则返回 401 状态码

  • 直接传一个元组

    它会默认使用 HTTPBasicAuth 这个类来认证

1

r = requests.get('http://localhost:5000', auth=('username', 'password'))
  • 使用 OAuth1 认证
1
2
3
4
5
6

import requests
from requests_oauthlib import OAuth1
url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
auth = OAuth1('YOUR_APP_KEY', 'YOUR_APP_SECRET',
              'USER_OAUTH_TOKEN', 'USER_OAUTH_TOKEN_SECRET')
requests.get(url, auth=auth)

allow_redirects

是否允许重定向，默认 True，即允许重定向

response对象

response 类故名思议，它包含了服务器对 http 请求的响应。每次调用 requests 去请求之后，均会返回一个 response 对象，通过调用该对象，可以查看具体的响应信息

以下是 response 对象的部分属性

.url

请求的最终地址

1
2

print(type(r.url), r.url)
>>> <class 'str'> https://static1.scrape.center/

.request

PreparedRequest 对象，可以用于查看发送请求时的信息，比如 r.request.headers 查看请求头

.text

响应的内容，unicode 类型

1
2

print(type(r.text), r.text)
>>> <class 'str'> "HTML的内容"

.content

响应的内容，byte 类型（二进制）

一般在抓取图像时有用

.status_code

响应的 http 状态码

1
2

print(type(r.status_code), r.status_code)
>>> <class 'int'> 500

响应的解析头链接

.history

请求的历史记录，可以用于查看重定向信息，以列表形式展示，排序方式是从最旧到最新的请求

1
2

print(type(r.history), r.history)
>>> <class 'list'> []

.reason

响应状态的描述，比如 “Not Found” or “OK”

.cookies

服务器发回的 cookies，RequestsCookieJar 类型

1
2

print(type(r.cookies), r.cookies)
>>> <class 'requests.cookies.RequestsCookieJar'> <RequestsCookieJar[]>

.json()

用于将响应解析成 JSON 格式，即将返回结果是 JSON 格式的字符串转化为字典

如果返回结果不是 JSON 格式，便会出现解析错误，抛出json.decoder.JSONDecodeError异常

.headers()

响应头，可单独取出某个字段的值，比如(r.headers)[‘content-type’]

1
2

print(type(r.headers), r.headers)
>>> <class 'requests.structures.CaseInsensitiveDict'> {'Server': 'nginx/1.17.8', 'Date': 'Tue, 27 Oct 2020 15:10:32 GMT', 'Content-Type': 'text/html', 'Content-Length': '145', 'Connection': 'keep-alive', 'X-Frame-Options': 'DENY', 'Vary': 'Cookie', 'X-Content-Type-Options': 'nosniff', 'Strict-Transport-Security': 'max-age=15724800; includeSubDomains'}

session对象

会话维持

requests 中的 session 对象能够让我们跨 http 请求保持某些参数，即让同一个 session 对象发送的请求头携带某个指定的参数。当然，最常见的应用是它可以让 cookie 保持在后续的一串请求中

即，利用 Session 对象，可以方便地维护一个会话

1
2
3
4
5
6

import requests
# tips: http://httpbin.org能够用于测试http请求和响应
s = requests.Session() 											
s.get('http://httpbin.org/cookies/set/sessioncookie/123456789') #第一步：发送一个请求，用于设置请求中的cookies
r = s.get("http://httpbin.org/cookies") 						#第二步：再发送一个请求，用于查看当前请求中的cookies
print(r.text)

输出

1
2
3
4
5

{
  "cookies": {
    "sessioncookie": "123456789"
  }
}

第二次请求已经携带上了第一次请求所设置的 cookie，即通过 session 达到了保持 cookie 的目的

session 让请求之间具有了连贯性

s.cookies.update()

用于设置请求中的 cookies，方便实现跨参数请求，即能够在前后请求之间保持 cookie

传入参数：字典

1
2
3
4
5
6

import requests

s = requests.session()
s.cookies.update({'cookies_are': 'cookie'})
r = s.get(url='http://httpbin.org/cookies')
print(r.text)

输出

1
2
3
4
5

{
  "cookies": {
    "cookies_are": "cookie"
  }
}

状态码查询对象 requests.codes

1

exit() if not r.status_code == requests.codes.ok else print('Request Successfully!')

返回码和相应的查询条件

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# 信息性状态码
100: ('continue',),
101: ('switching_protocols',),
102: ('processing',),
103: ('checkpoint',),
122: ('uri_too_long', 'request_uri_too_long'),

# 成功状态码
200: ('ok', 'okay', 'all_ok', 'all_okay', 'all_good', '\\o/', '✓'),
201: ('created',),
202: ('accepted',),
203: ('non_authoritative_info', 'non_authoritative_information'),
204: ('no_content',),
205: ('reset_content', 'reset'),
206: ('partial_content', 'partial'),
207: ('multi_status', 'multiple_status', 'multi_stati', 'multiple_stati'),
208: ('already_reported',),
226: ('im_used',),

# 重定向状态码
300: ('multiple_choices',),
301: ('moved_permanently', 'moved', '\\o-'),
302: ('found',),
303: ('see_other', 'other'),
304: ('not_modified',),
305: ('use_proxy',),
306: ('switch_proxy',),
307: ('temporary_redirect', 'temporary_moved', 'temporary'),
308: ('permanent_redirect',
      'resume_incomplete', 'resume',), # These 2 to be removed in 3.0

# 客户端错误状态码
400: ('bad_request', 'bad'),
401: ('unauthorized',),
402: ('payment_required', 'payment'),
403: ('forbidden',),
404: ('not_found', '-o-'),
405: ('method_not_allowed', 'not_allowed'),
406: ('not_acceptable',),
407: ('proxy_authentication_required', 'proxy_auth', 'proxy_authentication'),
408: ('request_timeout', 'timeout'),
409: ('conflict',),
410: ('gone',),
411: ('length_required',),
412: ('precondition_failed', 'precondition'),
413: ('request_entity_too_large',),
414: ('request_uri_too_large',),
415: ('unsupported_media_type', 'unsupported_media', 'media_type'),
416: ('requested_range_not_satisfiable', 'requested_range', 'range_not_satisfiable'),
417: ('expectation_failed',),
418: ('im_a_teapot', 'teapot', 'i_am_a_teapot'),
421: ('misdirected_request',),
422: ('unprocessable_entity', 'unprocessable'),
423: ('locked',),
424: ('failed_dependency', 'dependency'),
425: ('unordered_collection', 'unordered'),
426: ('upgrade_required', 'upgrade'),
428: ('precondition_required', 'precondition'),
429: ('too_many_requests', 'too_many'),
431: ('header_fields_too_large', 'fields_too_large'),
444: ('no_response', 'none'),
449: ('retry_with', 'retry'),
450: ('blocked_by_windows_parental_controls', 'parental_controls'),
451: ('unavailable_for_legal_reasons', 'legal_reasons'),
499: ('client_closed_request',),

# 服务端错误状态码
500: ('internal_server_error', 'server_error', '/o\\', '✗'),
501: ('not_implemented',),
502: ('bad_gateway',),
503: ('service_unavailable', 'unavailable'),
504: ('gateway_timeout',),
505: ('http_version_not_supported', 'http_version'),
506: ('variant_also_negotiates',),
507: ('insufficient_storage',),
509: ('bandwidth_limit_exceeded', 'bandwidth'),
510: ('not_extended',),
511: ('network_authentication_required', 'network_auth', 'network_authentication')

异常处理

requests.exceptions.ConnectionError

  1. http 的连接数超过最大限制，默认的情况下连接是 Keep-alive 的，所以这就导致了服务器保持了太多连接而不能再新建连接。
  2. ip 被封
  3. 程序请求速度过快。
1
2
3
4
5

try:
	response = requests.get(url)
except requests.exceptions.ConnectionError:
	print('error!')
    continue
更新于 2024-04-27
CC BY-NC 4.0
 Python
返回 | 主页