convert_underscores 如何在 FAST-API 中使用 Header 方法？

Question

这里是param_functions.py

中Header方法的代码

def Header(  # noqa: N802
    default: Any,
    *,
    alias: Optional[str] = None,
    convert_underscores: bool = True,
    title: Optional[str] = None,
    description: Optional[str] = None,
    gt: Optional[float] = None,
    ge: Optional[float] = None,
    lt: Optional[float] = None,
    le: Optional[float] = None,
    min_length: Optional[int] = None,
    max_length: Optional[int] = None,
    regex: Optional[str] = None,
    deprecated: Optional[bool] = None,
    **extra: Any,
) -> Any:
    return params.Header(
        default,
        alias=alias,
        convert_underscores=convert_underscores,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        regex=regex,
        deprecated=deprecated,
        **extra,
    )

这里是 params.py

中 Header class 的代码

class Header(Param):
    in_ = ParamTypes.header

    def __init__(
        self,
        default: Any,
        *,
        alias: Optional[str] = None,
        convert_underscores: bool = True,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        regex: Optional[str] = None,
        deprecated: Optional[bool] = None,
        **extra: Any,
    ):
        self.convert_underscores = convert_underscores
        super().__init__(
            default,
            alias=alias,
            title=title,
            description=description,
            gt=gt,
            ge=ge,
            lt=lt,
            le=le,
            min_length=min_length,
            max_length=max_length,
            regex=regex,
            deprecated=deprecated,
            **extra,
        )

我尝试了FAST-API的Header方法。现在我很好奇。

如果我在 Header 方法中设置 convert_underscores=False，FAST-API 不会将连字符转换为下划线。所以我认为 convert_underscores 只是用于转换的标志。

它是如何工作的？

Answer 1

用连字符替换下划线的逻辑在get_param_field函数中完成：

if not field_info.alias and getattr(field_info, "convert_underscores", None):
    alias = param.name.replace("_", "-")

convert_underscores 如何在 FAST-API 中使用 Header 方法？

How convert_underscores works of Header method in FAST-API?

python

fastapi