fastapi/param_functions.py · 清风/FastAPI

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 76

清风/FastAPI

forked from Gitee 极速下载/FastAPI

代码 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

master

分支 (7)

标签 (116)

管理

master

python3.9-3.10

fastapi-people

add-link-to-testdriven-io

release-notes

consistency-star

windows-dev

0.70.0

0.69.0

0.68.2

0.68.1

0.68.0

0.67.0

0.66.1

0.66.0

0.65.3

0.65.2

0.65.1

0.65.0

0.64.0

0.63.0

0.62.0

0.61.2

0.61.1

0.61.0

0.60.2

0.60.1

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

分支 7

标签 116

FastAPI

fastapi

param_functions.py

param_functions.py 6.90 KB

from typing import Any, Callable, Dict, Optional, Sequence

from fastapi import params
from pydantic.fields import Undefined

def Path( # noqa: N802
 default: Any,
 *,
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 deprecated: Optional[bool] = None,
 **extra: Any,
) -> Any:
 return params.Path(
 default=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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )

def Query( # noqa: N802
 default: Any,
 *,
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 deprecated: Optional[bool] = None,
 **extra: Any,
) -> Any:
 return params.Query(
 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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )

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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = 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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )

def Cookie( # noqa: N802
 default: Any,
 *,
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 deprecated: Optional[bool] = None,
 **extra: Any,
) -> Any:
 return params.Cookie(
 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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )

def Body( # noqa: N802
 default: Any,
 *,
 embed: bool = False,
 media_type: str = "application/json",
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 **extra: Any,
) -> Any:
 return params.Body(
 default,
 embed=embed,
 media_type=media_type,
 alias=alias,
 title=title,
 description=description,
 gt=gt,
 ge=ge,
 lt=lt,
 le=le,
 min_length=min_length,
 max_length=max_length,
 regex=regex,
 example=example,
 examples=examples,
 **extra,
 )

def Form( # noqa: N802
 default: Any,
 *,
 media_type: str = "application/x-www-form-urlencoded",
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 **extra: Any,
) -> Any:
 return params.Form(
 default,
 media_type=media_type,
 alias=alias,
 title=title,
 description=description,
 gt=gt,
 ge=ge,
 lt=lt,
 le=le,
 min_length=min_length,
 max_length=max_length,
 regex=regex,
 example=example,
 examples=examples,
 **extra,
 )

def File( # noqa: N802
 default: Any,
 *,
 media_type: str = "multipart/form-data",
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 **extra: Any,
) -> Any:
 return params.File(
 default,
 media_type=media_type,
 alias=alias,
 title=title,
 description=description,
 gt=gt,
 ge=ge,
 lt=lt,
 le=le,
 min_length=min_length,
 max_length=max_length,
 regex=regex,
 example=example,
 examples=examples,
 **extra,
 )

def Depends( # noqa: N802
 dependency: Optional[Callable[..., Any]] = None, *, use_cache: bool = True
) -> Any:
 return params.Depends(dependency=dependency, use_cache=use_cache)

def Security( # noqa: N802
 dependency: Optional[Callable[..., Any]] = None,
 *,
 scopes: Optional[Sequence[str]] = None,
 use_cache: bool = True,
) -> Any:
 return params.Security(dependency=dependency, scopes=scopes, use_cache=use_cache)

一键复制编辑原始数据按行查看历史

Austin Orr 提交于 2021年05月06日 02:20 +08:00 . ✨ Add support for adding multiple examples in request bodies and path,...

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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

from typing import Any, Callable, Dict, Optional, Sequence

from fastapi import params
from pydantic.fields import Undefined


def Path( # noqa: N802
 default: Any,
 *,
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 deprecated: Optional[bool] = None,
 **extra: Any,
) -> Any:
 return params.Path(
 default=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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )


def Query( # noqa: N802
 default: Any,
 *,
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 deprecated: Optional[bool] = None,
 **extra: Any,
) -> Any:
 return params.Query(
 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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )


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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = 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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )


def Cookie( # noqa: N802
 default: Any,
 *,
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 deprecated: Optional[bool] = None,
 **extra: Any,
) -> Any:
 return params.Cookie(
 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,
 example=example,
 examples=examples,
 deprecated=deprecated,
 **extra,
 )


def Body( # noqa: N802
 default: Any,
 *,
 embed: bool = False,
 media_type: str = "application/json",
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 **extra: Any,
) -> Any:
 return params.Body(
 default,
 embed=embed,
 media_type=media_type,
 alias=alias,
 title=title,
 description=description,
 gt=gt,
 ge=ge,
 lt=lt,
 le=le,
 min_length=min_length,
 max_length=max_length,
 regex=regex,
 example=example,
 examples=examples,
 **extra,
 )


def Form( # noqa: N802
 default: Any,
 *,
 media_type: str = "application/x-www-form-urlencoded",
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 **extra: Any,
) -> Any:
 return params.Form(
 default,
 media_type=media_type,
 alias=alias,
 title=title,
 description=description,
 gt=gt,
 ge=ge,
 lt=lt,
 le=le,
 min_length=min_length,
 max_length=max_length,
 regex=regex,
 example=example,
 examples=examples,
 **extra,
 )


def File( # noqa: N802
 default: Any,
 *,
 media_type: str = "multipart/form-data",
 alias: Optional[str] = None,
 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,
 example: Any = Undefined,
 examples: Optional[Dict[str, Any]] = None,
 **extra: Any,
) -> Any:
 return params.File(
 default,
 media_type=media_type,
 alias=alias,
 title=title,
 description=description,
 gt=gt,
 ge=ge,
 lt=lt,
 le=le,
 min_length=min_length,
 max_length=max_length,
 regex=regex,
 example=example,
 examples=examples,
 **extra,
 )


def Depends( # noqa: N802
 dependency: Optional[Callable[..., Any]] = None, *, use_cache: bool = True
) -> Any:
 return params.Depends(dependency=dependency, use_cache=use_cache)


def Security( # noqa: N802
 dependency: Optional[Callable[..., Any]] = None,
 *,
 scopes: Optional[Sequence[str]] = None,
 use_cache: bool = True,
) -> Any:
 return params.Security(dependency=dependency, scopes=scopes, use_cache=use_cache)