栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Python

requests库post请求参数data、json和files的使用

Python 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

requests库post请求参数data、json和files的使用

  • 1. 内容
  • 2. 环境
  • 3. requests.post
  • 4. data
    • 4.1. Dictionary
      • 4.1.1. 源码-分析requests是如何对传入的data数据进行处理的
    • 4.2. list of tuples
  • 5. json
    • 5.1. 源码-分析requests是如何对传入的json数据进行处理的
  • 6. files
    • 6.1. 采用{'name', file-like-objects}上传文件
    • 6.2. 采用{'name': file-tuple}的形式上传文件
    • 6.3. 上传多个文件
  • 7. 提交application/json类型的数据的两种方式
    • 7.1. 方式1:使用data参数
    • 7.2. 方式2:使用json参数
1. 内容

主要讨论使用requests.post函数的参数data、json和files来发送不同类型的数据或者文件。

2. 环境

python:3.9.12
requests:2.20.0

3. requests.post

主要关注post请求中的data、json以及files参数。首先,查看requests.data的源码,data和json参数的内容如下:

def post(url, data=None, json=None, **kwargs):
    r"""Sends a POST request.

    :param url: URL for the new :class:`Request` object.
    :param data: (optional) Dictionary, list of tuples, bytes, or file-like
        object to send in the body of the :class:`Request`.
    :param json: (optional) json data to send in the body of the :class:`Request`.
    :param **kwargs: Optional arguments that ``request`` takes.
    :return: :class:`Response ` object
    :rtype: requests.Response
    """
    return request('post', url, data=data, json=json, **kwargs)

继续查看requests.request的源码,主要关注参数files的说明,如下:

def request(method, url, **kwargs):
    """Constructs and sends a :class:`Request `.

    ...
    :param files: (optional) Dictionary of ``'name': file-like-objects`` (or ``{'name': file-tuple}``) for multipart encoding upload.
        ``file-tuple`` can be a 2-tuple ``('filename', fileobj)``, 3-tuple ``('filename', fileobj, 'content_type')``
        or a 4-tuple ``('filename', fileobj, 'content_type', custom_headers)``, where ``'content-type'`` is a string
        defining the content type of the given file and ``custom_headers`` a dict-like object containing additional headers
        to add for the file.
    """

在了解data、json以及files参数的取值范围之后,接下来就是以实际的例子来说明分别识别data、json以及files发送数据的情况。

4. data

通过requests.data参数可以看到,data的参数支持4种类型,分别为Dictionary、list of tuples、bytes、file-like object,这里主要关注使用Dictionary、list of tuples这两种方式发送数据时的请求方式、请求信息和响应结果信息。剩余的bytes、file-like object会在之后遇到实际应用时补充。

4.1. Dictionary

首先,使用字典的形式提交数据,如下所示:

  1. 定义一个Python字典:data,并以键值对的形式说明需要上传的数据。
  2. 通过输出请求头的body信息res.request.body发现,其取值为name=Tom&age=18.
  3. 使用data传递Dictionary类型的键值对时,此时的Content-Type默认为application/x-www-form-urlencoded
import requests

url = "http://httpbin.org/post"
data = {
    "name": "Tom",
    "age": 18
}
res = requests.post(url, data=data)
print("请求头", res.request.headers, type(res.request.headers))
print("请求体", res.request.body, type(res.request.body))
print("响应头", res.headers, type(res.headers))
print("响应体", res.text, type(res.text))

输出结果为:

请求头 {'User-Agent': 'python-requests/2.20.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '**", 
    "Accept-Encoding": "gzip, deflate", 
    "Content-Length": "15", 
    "Content-Type": "application/x-www-form-urlencoded", 
    "Host": "httpbin.org", 
    "User-Agent": "python-requests/2.20.0", 
    "X-Amzn-Trace-Id": "Root=1-62838329-3e9cc2f465f24f73694a0f1a"
  }, 
  "json": null, 
  "origin": "58.48.122.206", 
  "url": "http://httpbin.org/post"
}
 
4.1.1. 源码-分析requests是如何对传入的data数据进行处理的

首先,使用pycharm工具,一步步查看代码调用顺序,找到修改data数据的代码即可,这里可自己查看的调用顺序整理如下:(api.py::post带包api.py文件中的post函数)

调用requests.post时,此时相当于执行了requests/api.py::post函数
接着调用requests/api.py::request函数
接着会调用requests/sessions.py::request函数
在该函数中执行了这个语句prep = self.prepare_request(req),继续查看prepare_request()函数
在该函数中调用了requests/models.py/prepare函数
接着在该函数中调用了requests/models.py/prepare_body(data, files, json),可以看到这里对data数据进行了处理。

这里主要关注models.py文件中的prepare_body和_encode_params函数,下面列举出该函数的部分内容,如下:

  1. 在prepare_body函数中,此时当data存在值的时候,会调用self._encode_params(data),也就是在调用_encode_params的时候将data = {"name": "Tom","age": 18}转化为了name=Tom&age=18。(这里就不在深究requests是如何实现的了)
  def prepare_body(self, data, files, json=None):
      """Prepares the given HTTP body data."""

      # Check if file, fo, generator, iterator.
      # If not, run through normal process.

      # Nottin' on you.
      body = None
      content_type = None

      if is_stream:
          ...
      else:
          ...
          else:
              if data:
                  body = self._encode_params(data)
                  if isinstance(data, basestring) or hasattr(data, 'read'):
                      content_type = None
                  else:
                      content_type = 'application/x-www-form-urlencoded'
4.2. list of tuples

使用元组列表构建一个data,然后传递给post请求的data参数中,如下所示:

  1. 使用元组构建data的方式也比较简单,其实就是将data转化为list,每个键值对变成list中的一个元组,即可以通过list(zip(data.keys(), data.values()))将data转化为元组列表。
import requests

url = "http://httpbin.org/post"
data = [("name", "Tom"), ("age", 18)]
res = requests.post(url, data=data)
print("请求头", res.request.headers, type(res.request.headers))
print("请求体", res.request.body, type(res.request.body))

输出结果如下,可以发现与使用Dictionary的方式一样。

请求头 {'User-Agent': 'python-requests/2.20.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '**', 'Connection': 'keep-alive', 'Content-Length': '26', 'Content-Type': 'application/json'} 
请求体 b'{"name": "Tom", "age": 18}' 

如上,res.request.body返回的是一个bytes类型。这里可以通过查看源码来看requests在接收到json参数传递的数据之后做了哪些操作。

5.1. 源码-分析requests是如何对传入的json数据进行处理的

和前面分析data数据一样,这里直接查看requests/models.py/prepare_body函数,该函数的部分内容如下所示:

def prepare_body(self, data, files, json=None):
    """Prepares the given HTTP body data."""

    # Check if file, fo, generator, iterator.
    # If not, run through normal process.

    # Nottin' on you.
    body = None
    content_type = None

    if not data and json is not None:
        # urllib3 requires a bytes-like body. Python 2's json.dumps
        # provides this natively, but Python 3 gives a Unicode string.
        content_type = 'application/json'
        body = complexjson.dumps(json)
        if not isinstance(body, bytes):
            body = body.encode('utf-8')

如上,可以看到当data为空且json不为None的时候,此时设置了请求类型为application/json,同时将参数转化为json字符串,并使用utf-8编码为bytes类型。

6. files

首先,根据requests.request函数中的参数说明(具体可以参考第3节),对于files参数,可以有以下几种类型:

  1. Dictionary of 'name': file-like-objects
  2. {‘name’: file-tuple}:file-tuple又可以包含多种,比如:
    1. 2-tuple:分别是filename, fileobj
    2. 3-tuple:分别是filename, fileobj, content_type
    3. 4-tuple:分别是filename, fileobj, content_type, custom_headers

注意:

  1. 这里的name相当于前端通过form表单上传文件时,input字段的name的取值,即后台会根据这里的name获取上传的文件。

6.1. 采用{'name', file-like-objects}上传文件
#coding=utf-8
# 采用xampp搭建的真实服务测试过,可以上传文件成功
import requests

url = "http://httpbin.org/post"
files = {
    "file": open("./second_module.py", "rb")
}
res = requests.post(url, files=files)
print("请求头", res.request.headers, type(res.request.headers))
print("请求体", res.request.body, type(res.request.body))
print("响应头", res.headers, type(res.headers))
print("响应体", res.text, type(res.text))

输出结果如下:

请求头 {'User-Agent': 'python-requests/2.20.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '**", 
    "Accept-Encoding": "gzip, deflate", 
    "Content-Length": "175", 
    "Content-Type": "multipart/form-data; boundary=60676effe8eb282f2238484ce8c733d7", 
    "Host": "httpbin.org", 
    "User-Agent": "python-requests/2.20.0", 
    "X-Amzn-Trace-Id": "Root=1-6284bd7c-4834506703ccab59771b3319"
  }, 
  "json": null, 
  "origin": "58.48.122.206", 
  "url": "http://httpbin.org/post"
}
 

如上:

  1. 使用files上传文件时,此时默认的content-type类型为:multipart/form-data; boundary=60676effe8eb282f2238484ce8c733d7,即会自动生成1个随机的boundary。
  2. 请求体中包含如下内容.
b'--60676effe8eb282f2238484ce8c733d7rnContent-Disposition: form-data; name="file"; filename="second_module.py"rnrnimport first_modulernrnrn--60676effe8eb282f2238484ce8c733d7--rn' 
6.2. 采用{'name': file-tuple}的形式上传文件
#coding=utf-8
# 采用xampp搭建的真实服务测试过,可以上传文件成功
import requests
import mimetypes

url = "http://httpbin.org/post"

filepath = "./second_module.py"
# 猜测文件类型
file_type = mimetypes.guess_type("./second_module.py")[0]      # image/jpeg

files = {
    # 元组中第一个参数:代表实际上传服务器时使用的文件名,没有传入该参数的时候,实际上传之后的filename是open函数中打开的文件的文件名。
    # 元祖第二个参数:就是一个文件对象
    # 元祖第三个参数:文件类型,这里通过使用mimetypes来猜测文件类型。
    # 元祖第四个参数:自定义的一些头部信息
    "file": ("new_filename.py", open(filepath, "rb"), file_type, {'Expires':'0'})
}
res = requests.post(url, files=files)
print("请求头", res.request.headers, type(res.request.headers))
print("请求体", res.request.body, type(res.request.body))

此时的输出结果为:

请求头 {'User-Agent': 'python-requests/2.20.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '**', 'Connection': 'keep-alive', 'Content-Length': '394', 'Content-Type': 'multipart/form-data; boundary=fe0a1f7e51c9795b4665897765267b7c'} 
请求体 b'--fe0a1f7e51c9795b4665897765267b7crnContent-Disposition: form-data; name="file"; filename="new_filename1.py"rnContent-Type: text/x-pythonrnExpires: 0rnrnimport first_modulernrnrn--fe0a1f7e51c9795b4665897765267b7crnContent-Disposition: form-data; name="file"; filename="new_filename2.py"rnContent-Type: text/x-pythonrnExpires: 0rnrnimport first_modulernrnrn--fe0a1f7e51c9795b4665897765267b7c--rn' 

说明:

  1. 上传多个文件时,可以使用上面例子中提到的元组列表的形式,也可以使用下面的形式
files = {
    "file": ("new_filename3.py", open(filepath, "rb"), file_type, {'Expires':'0'}),
    "file2": ("new_filename4.py", open(filepath, "rb"), file_type, {'Expires':'0'}),
}
7. 提交application/json类型的数据的两种方式 7.1. 方式1:使用data参数

此时需要使用json.dumps(data)将Dictionary类型转换为json字符串,并在请求头中添加content-type字段类型为application/json

import requests

url = "http://httpbin.org/post"
data = {
    "name": "Tom",
    "age": 18
}
res = requests.post(url, data=json.dumps(data), headers={"content-type":"application/json"})

print("请求头", res.request.headers, type(res.request.headers))
print("请求体", res.request.body, type(res.request.body))

此时的输出结果如下:

请求头 {'User-Agent': 'python-requests/2.20.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '*/*', 'Connection': 'keep-alive', 'content-type': 'application/json', 'Content-Length': '26'} 
请求体 {"name": "Tom", "age": 18} 
7.2. 方式2:使用json参数

直接参考第5节。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/915829.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号