Introduction rapide aux requêtes Python

Cet article présente principalement le tutoriel de démarrage rapide pour l'utilisation des requêtes python. Il est très simple d'utiliser des requêtes pour envoyer des requêtes réseau. Pour des méthodes de fonctionnement spécifiques, veuillez vous référer à cet article

Commencez vite

Vous avez hâte ? Cette page fournit un bon guide sur la façon de démarrer avec les requêtes. Cela suppose que Requests est installé. Si vous ne l'avez pas encore fait, rendez-vous dans la section installation et jetez-y un œil.

Tout d'abord, assurez-vous :

Requests est installé

Requests est à jour

Commençons par quelques exemples simples.

Envoyer une requête

L'envoi de requêtes réseau est très simple à l'aide de Requests.

Importez d'abord le module Requêtes :

>>> import requests

Ensuite, essayez d'obtenir une page Web. Dans cet exemple, obtenons la chronologie publique de Github :

>>> r = requests.get('https://github.com/timeline.json')

Maintenant, nous avons un objet Response nommé r. Nous pouvons obtenir toutes les informations que nous souhaitons à partir de cet objet.

Requêtes Une API simple signifie que tous les types de requêtes HTTP sont évidents. Par exemple, vous pourriez envoyer une requête HTTP POST comme celle-ci :

>>> r = requests.post(http://httpbin.org/post)

Jolie, non ? Qu’en est-il des autres types de requêtes HTTP : PUT, DELETE, HEAD et OPTIONS ? Elles sont toutes simples :

>>> r = requests.put("http://httpbin.org/put")
>>> r = requests.delete("http://httpbin.org/delete")
>>> r = requests.head("http://httpbin.org/get")
>>> r = requests.options(http://httpbin.org/get)

Elles sont toutes bonnes, mais ce n'est que la pointe de l'iceberg des requêtes.

Transmission des paramètres d'URL

Vous souhaiterez peut-être souvent transmettre certains types de données pour la chaîne de requête de l'URL. Si vous créez l'URL à la main, les données sont placées dans l'URL sous forme de paires clé/valeur, suivies d'un point d'interrogation. Par exemple, httpbin.org/get?key=val. Les requêtes vous permettent d'utiliser l'argument mot-clé params pour fournir ces paramètres sous forme de dictionnaire de chaînes. Par exemple, si vous souhaitez passer key1=value1 et key2=value2 à httpbin.org/get, alors vous pouvez utiliser le code suivant :

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

En imprimant la sortie Pour l'URL, vous pouvez voir que l'URL a été correctement encodée :

>>> print(r.url)
http://httpbin.org/get?key2=value2&key1=value1

Notez qu'aucune des clés de dictionnaire avec une valeur de None ne sera ajoutée à la chaîne de requête URL à l’intérieur.

Vous pouvez également transmettre une liste comme valeur :

>>> payload = {'key1': 'value1', 'key2': ['value2', 'value3']}
>>> r = requests.get('http://httpbin.org/get', params=payload)
>>> print(r.url)
http://httpbin.org/get?key1=value1&key2=value2&key2=value3

Contenu de la réponse

Nous pouvons lire le contenu de la réponse du serveur. En utilisant à nouveau la chronologie GitHub comme exemple :

>>> import requests
>>> r = requests.get('https://github.com/timeline.json')
>>> r.text
u'[{"repository":{"open_issues":0,"url":"https://github.com/...

Les requêtes décodent automatiquement le contenu du serveur. La plupart des jeux de caractères Unicode peuvent être décodés de manière transparente.

Une fois qu'une requête est effectuée, Requests fait une supposition éclairée sur le codage de la réponse en fonction des en-têtes HTTP. Lorsque vous accédez à r.text, Requests utilise son codage de texte déduit. Vous pouvez découvrir quel encodage utilise Requests, et pouvoir le modifier à l'aide de la propriété r.encoding :

>>> r.encoding
'utf-8'
>>> r.encoding = 'ISO-8859-1'

Si vous modifiez l'encodage, à chaque fois que vous accédez à r .text et Request utiliseront tous la nouvelle valeur de r.encoding. Vous souhaiterez peut-être modifier le codage après avoir utilisé une logique spéciale pour calculer le codage du texte. Par exemple, HTTP et XML peuvent spécifier eux-mêmes les codages. Dans ce cas, vous devez utiliser r.content pour trouver l'encodage, puis définir r.encoding sur l'encodage correspondant. Cela permettra à r.text d'être analysé en utilisant le codage correct.

Les requêtes peuvent également utiliser un encodage personnalisé si vous en avez besoin. Si vous créez votre propre encodage et l'enregistrez auprès du module codecs, vous pouvez facilement utiliser le nom du décodeur comme valeur de r.encoding et laisser Requests gérer l'encodage pour vous.

Contenu de la réponse binaire

Vous pouvez également accéder au corps de la réponse de la requête en octets, pour les requêtes non textuelles :

>>> r.content
b'[{"repository":{"open_issues":0,"url":"https://github.com/...

Les requêtes décoderont automatiquement gzip et dégonfleront les données de réponse codées par transfert pour vous.

Par exemple, pour créer une image à partir des données binaires renvoyées par la requête, vous pouvez utiliser le code suivant :

>>> from PIL import Image
>>> from io import BytesIO
>>> i = Image.open(BytesIO(r.content))

Contenu de la réponse JSON

Requests dispose également d'un décodeur JSON intégré pour vous aider à traiter les données JSON :

>>> import requests
>>> r = requests.get('https://github.com/timeline.json')
>>> r.json()
[{u'repository': {u'open_issues': 0, u'url': 'https://github.com/...

Si JSON Si le décodage échoue, r.json() lèvera une exception. Par exemple, si la réponse est 401 (Non autorisé), la tentative d'accès à r.json() générera une exception ValueError : aucun objet JSON n'a pu être décodé.

Il convient de noter qu'un appel réussi à r.json() ne signifie pas le succès de la réponse. Certains serveurs incluent un objet JSON dans la réponse à l'échec (comme les détails de l'erreur HTTP 500). Ce JSON sera décodé et renvoyé. Pour vérifier si la demande a abouti, utilisez r.raise_for_status() ou vérifiez si r.status_code correspond à ce que vous attendiez.

Contenu original de la réponse

在罕见的情况下，你可能想获取来自服务器的原始套接字响应，那么你可以访问 r.raw。 如果你确实想这么干，那请你确保在初始请求中设置了 stream=True。具体你可以这么做：

>>> r = requests.get('https://github.com/timeline.json', stream=True)
>>> r.raw
<requests.packages.urllib3.response.HTTPResponse object at 0x101194810>
>>> r.raw.read(10)
&#39;\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03&#39;

但一般情况下，你应该以下面的模式将文本流保存到文件：

with open(filename, 'wb') as fd:
 for chunk in r.iter_content(chunk_size):
  fd.write(chunk)

使用 Response.iter_content 将会处理大量你直接使用 Response.raw 不得不处理的。 当流下载时，上面是优先推荐的获取内容方式。 Note that chunk_size can be freely adjusted to a number that may better fit your use cases.

定制请求头

如果你想为请求添加 HTTP 头部，只要简单地传递一个 dict 给 headers 参数就可以了。

例如，在前一个示例中我们没有指定 content-type:

>>> url = 'https://api.github.com/some/endpoint'
>>> headers = {'user-agent': 'my-app/0.0.1'}
>>> r = requests.get(url, headers=headers)

注意: 定制 header 的优先级低于某些特定的信息源，例如：

如果在 .netrc 中设置了用户认证信息，使用 headers= 设置的授权就不会生效。而如果设置了auth= 参数，``.netrc`` 的设置就无效了。

如果被重定向到别的主机，授权 header 就会被删除。

代理授权 header 会被 URL 中提供的代理身份覆盖掉。

在我们能判断内容长度的情况下，header 的 Content-Length 会被改写。

更进一步讲，Requests 不会基于定制 header 的具体情况改变自己的行为。只不过在最后的请求中，所有的 header 信息都会被传递进去。

注意: 所有的 header 值必须是 string、bytestring 或者 unicode。尽管传递 unicode header 也是允许的，但不建议这样做。

更加复杂的 POST 请求

通常，你想要发送一些编码为表单形式的数据——非常像一个 HTML 表单。要实现这个，只需简单地传递一个字典给 data 参数。你的数据字典在发出请求时会自动编码为表单形式：

>>> payload = {'key1': 'value1', 'key2': 'value2'}

>>> r = requests.post("http://httpbin.org/post", data=payload)
>>> print(r.text)
{
...
"form": {
"key2": "value2",
"key1": "value1"
},
...
}

你还可以为 data 参数传入一个元组列表。在表单中多个元素使用同一 key 的时候，这种方式尤其有效：

>>> payload = (('key1', 'value1'), ('key1', 'value2'))
>>> r = requests.post('http://httpbin.org/post', data=payload)
>>> print(r.text)
{
...
"form": {
"key1": [
"value1",
"value2"
]
},
...
}

很多时候你想要发送的数据并非编码为表单形式的。如果你传递一个 string 而不是一个 dict，那么数据会被直接发布出去。

例如，Github API v3 接受编码为 JSON 的 POST/PATCH 数据：

>>> import json
>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}
>>> r = requests.post(url, data=json.dumps(payload))

此处除了可以自行对 dict 进行编码，你还可以使用 json 参数直接传递，然后它就会被自动编码。这是 2.4.2 版的新加功能：

>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}
>>> r = requests.post(url, json=payload)

POST一个多部分编码(Multipart-Encoded)的文件

Requests 使得上传多部分编码文件变得很简单：

>>> url = 'http://httpbin.org/post'
>>> files = {'file': open('report.xls', 'rb')}
>>> r = requests.post(url, files=files)
>>> r.text
{
...
"files": {
"file": ""
},
...
}

你可以显式地设置文件名，文件类型和请求头：

>>> url = 'http://httpbin.org/post'
>>> files = {'fichier' : ('rapport.xls', open('rapport. xls', 'rb'), 'application/vnd.ms-excel', {'Expire' : '0'})}
>>>
>>> r.text
{
...
"files": {
"file": " "
},
...
}

Si vous le souhaitez, vous pouvez également envoyer la chaîne reçue sous forme de fichier :

>>> url = 'http://httpbin.org/post'
>>> files = {'file' : ('report.csv', 'some,data,to,sendnanother,row,to,sendn' )}

>>> r = requêtes.post(url, fichiers=fichiers)
>>> > "files": {
"file": "certaines,données,à,envoyer\nanautre,ligne,à,envoyer\n"
},
...
}

Si vous envoyez un fichier très volumineux sous forme de requête multipart/form-data, vous souhaiterez peut-être diffuser la requête. Par défaut, les requêtes ne sont pas prises en charge, mais il existe un package tiers request-toolbelt qui la prend en charge. Vous pouvez lire la documentation de la ceinture d'outils pour savoir comment l'utiliser.

Envoi de plusieurs références de fichiers dans une seule demande, section Utilisation avancée.

Attention

Nous vous recommandons fortement d'ouvrir le fichier en mode binaire. En effet, Requests peut essayer de vous fournir un en-tête Content-Length et, lorsqu'il le fait, cette valeur sera définie sur le nombre d'octets du fichier. Si vous ouvrez le fichier en mode texte, des erreurs peuvent survenir.

Code d'état de la réponse

Nous pouvons détecter le code d'état de la réponse :

>>> get ')

>>> r.status_code

200

Pour une référence facile, Requests est également livré avec un objet de requête de code d'état intégré :

> > > r.status_code == request.codes.ok

True

Si une demande d'erreur est envoyée (une erreur client 4XX ou une réponse d'erreur serveur 5XX), nous pouvons transmettre Response.raise_for_status () pour lever une exception :

>>> bad_r = request.get('http://httpbin.org/status/404')

>>> status_code

404

>>> bad_r.raise_for_status()
Traceback (dernier appel le plus récent) :
Fichier "requests/models.py", ligne 832, dans raise_for_status
raise http_error
requests.exceptions.HTTPError: 404 Client Error

Cependant, puisque le status_code de r dans notre exemple est 200, lorsque nous appelons raise_for_status(), nous obtenons :

> ;>> r.raise_for_status()

Aucun

Tout est assez harmonieux.

En-têtes de réponse

Nous pouvons visualiser les en-têtes de réponse du serveur affichés sous forme de dictionnaire Python :

>>> content-encoding' : 'gzip',

'transfer-encoding' : 'chunked',

'connection' : 'close',

'server' : 'nginx/1.0.4',
'x-runtime' : '148ms',
'etag' : '"e1ca502697e5c9317743dc078f67693f"',
'content-type' : 'application/json'
>

Mais ça Le dictionnaire est spécial : il concerne uniquement les en-têtes HTTP. Selon la RFC 2616, les en-têtes HTTP ne sont pas sensibles à la casse.

Par conséquent, nous pouvons accéder à ces champs d'en-tête de réponse en utilisant des majuscules arbitraires :

>>> r.headers['Content-Type']

'application/json '

>>> r.headers.get('content-type')

'application/json'

Il a aussi un point spécial, c'est-à-dire que le serveur peut l'accepter plusieurs times Utilisez des valeurs différentes pour le même en-tête à chaque fois. Mais les requêtes les combineront afin qu'elles puissent être représentées par un mappage, voir RFC 7230 :

Un destinataire PEUT combiner plusieurs champs d'en-tête avec le même nom de champ en une seule paire "nom de champ : valeur de champ", sans changer la sémantique du message, en ajoutant chaque valeur de champ suivante à la valeur de champ combinée dans l'ordre, séparés par une virgule.

Le destinataire peut fusionner plusieurs champs d'en-tête portant le même nom, ils sont combinés en un "nom de champ : valeur de champ", et chaque valeur de champ suivante est ajoutée tour à tour à la valeur de champ combinée, séparée par des virgules, sans modifier la sémantique des informations.

Cookies

Si une réponse contient des cookies, vous pouvez y accéder rapidement :

>>> url = 'http://example.com/some/cookie/setting/url'
>>> r = requests.get(url)
>>> r.cookies['example_cookie_name']
'example_cookie_value'
要想发送你的cookies到服务器，可以使用 cookies 参数：

>>> url = 'http://httpbin.org/cookies'
>>> cookies = dict(cookies_are='working')

>>> r = requests.get(url, cookies=cookies)
>>> r.text
'{"cookies": {"cookies_are": "working"}}'

Cookie 的返回对象为 RequestsCookieJar，它的行为和字典类似，但界面更为完整，适合跨域名跨路径使用。你还可以把 Cookie Jar 传到 Requests 中：

>>> jar = requests.cookies.RequestsCookieJar()
>>> jar.set('tasty_cookie', 'yum', domain='httpbin.org', path='/cookies')
>>> jar.set('gross_cookie', 'blech', domain='httpbin.org', path='/elsewhere')
>>> url = 'http://httpbin.org/cookies'
>>> r = requests.get(url, cookies=jar)
>>> r.text
'{"cookies": {"tasty_cookie": "yum"}}'

重定向与请求历史

默认情况下，除了 HEAD, Requests 会自动处理所有重定向。

可以使用响应对象的 history 方法来追踪重定向。

Response.history 是一个 Response 对象的列表，为了完成请求而创建了这些对象。这个对象列表按照从最老到最近的请求进行排序。

例如，Github 将所有的 HTTP 请求重定向到 HTTPS：

>>> r = requests.get('http://github.com')
>>> r.url
'https://github.com/'
>>> r.status_code
200
>>> r.history
[<Response [301]>]

如果你使用的是GET、OPTIONS、POST、PUT、PATCH 或者 DELETE，那么你可以通过 allow_redirects 参数禁用重定向处理：

>>> r = requests.get('http://github.com', allow_redirects=False)
>>> r.status_code
301
>>> r.history
[]

如果你使用了 HEAD，你也可以启用重定向：

>>> r = requests.head('http://github.com', allow_redirects=True)
>>> r.url
'https://github.com/'
>>> r.history
[<Response [301]>]

超时

你可以告诉 requests 在经过以 timeout 参数设定的秒数时间之后停止等待响应。基本上所有的生产代码都应该使用这一参数。如果不使用，你的程序可能会永远失去响应：

>>> requests.get('http://github.com', timeout=0.001)
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
requests.exceptions.Timeout: HTTPConnectionPool(host=&#39;github.com&#39;, port=80): Request timed out. (timeout=0.001)

注意

timeout 仅对连接过程有效，与响应体的下载无关。 timeout 并不是整个下载响应的时间限制，而是如果服务器在 timeout 秒内没有应答，将会引发一个异常（更精确地说，是在timeout 秒内没有从基础套接字上接收到任何字节的数据时）If no timeout is specified explicitly, requests do not time out.

错误与异常

遇到网络问题（如：DNS 查询失败、拒绝连接等）时，Requests 会抛出一个 ConnectionError 异常。

如果 HTTP 请求返回了不成功的状态码， Response.raise_for_status() 会抛出一个 HTTPError 异常。

若请求超时，则抛出一个 Timeout 异常。

若请求超过了设定的最大重定向次数，则会抛出一个 TooManyRedirects 异常。

所有Requests显式抛出的异常都继承自 requests.exceptions.RequestException 。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!