能否及是否应使用Pydantic为requests调用定义参数Schema？

问题描述 #

我正在编写一个类来处理对API的GET/POST/PATCH/DELETE请求，为每种请求分别实现了对应方法（例如def get_request()）。由于请求所需参数较多，会导致每个函数的参数列表过长，因此我希望通过其他方式定义参数结构并将其作为单个变量传入。

我当然可以使用普通字典来实现，但由于我已在使用Pydantic解析请求返回结果，因此想了解是否可以（以及是否应该）使用Pydantic模型来传递请求参数，是否存在符合Python风格的处理方式？

我设想的代码大致如下（未测试）：

from pydantic import BaseModel
import requests

class Params(BaseModel):
  param_1: str
  param_2: int
  param_3: list[str]

class ApiCall:
  def get_request(self, url: str, params: Params):
    response = requests.get(url, params = params.dict())

请问这种处理方式是否有效？或者是否有其他常规的处理方案？

回答 #

你的方案完全有效，而且非常贴合你已经在使用Pydantic的技术栈，是符合Python风格的做法，主要有这些优势：

• 类型校验：Pydantic会自动校验参数的类型和格式，提前拦截不符合要求的参数，避免因参数错误导致API请求失败
• 可读性与可维护性：相比松散的字典，Pydantic模型明确定义了参数结构，其他开发者能快速理解所需参数的类型和必填性
• 复用性：如果后续需要生成API文档或做参数校验逻辑复用，Pydantic模型可以直接复用，减少重复代码

代码优化小细节

如果使用的是Pydantic V2版本，建议用params.model_dump()替代params.dict()，因为dict()方法已被弃用，model_dump()是官方推荐的序列化方式：

def get_request(self, url: str, params: Params):
    response = requests.get(url, params=params.model_dump())

其他常规处理方案

除了Pydantic模型，还有几种常见的Python风格方案可选：

• 使用**kwargs收集关键字参数：如果参数结构不固定或不想提前定义模型，可以直接用关键字参数接收，内部转成字典传入请求。缺点是缺乏类型校验，可读性稍差：

  class ApiCall:
      def get_request(self, url: str, **kwargs):
          response = requests.get(url, params=kwargs)
  

• 标准库dataclasses：如果不需要Pydantic的复杂校验和序列化能力，用标准库的dataclasses.dataclass也能定义结构化参数，轻量无额外依赖：

  from dataclasses import dataclass, asdict
  import requests
  
  @dataclass
  class Params:
      param_1: str
      param_2: int
      param_3: list[str]
  
  class ApiCall:
      def get_request(self, url: str, params: Params):
          response = requests.get(url, params=asdict(params))
  

• 混合模式：如果部分参数是固定必填项，部分是可选参数，可以把固定参数放进Pydantic模型，可选参数用**kwargs补充，兼顾类型安全和灵活性。

内容的提问来源于stack exchange，提问作者Jan