prefect-client 2.20.4__py3-none-any.whl → 3.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (288) hide show
  1. prefect/__init__.py +74 -110
  2. prefect/_internal/compatibility/deprecated.py +6 -115
  3. prefect/_internal/compatibility/experimental.py +4 -79
  4. prefect/_internal/compatibility/migration.py +166 -0
  5. prefect/_internal/concurrency/__init__.py +2 -2
  6. prefect/_internal/concurrency/api.py +1 -35
  7. prefect/_internal/concurrency/calls.py +0 -6
  8. prefect/_internal/concurrency/cancellation.py +0 -3
  9. prefect/_internal/concurrency/event_loop.py +0 -20
  10. prefect/_internal/concurrency/inspection.py +3 -3
  11. prefect/_internal/concurrency/primitives.py +1 -0
  12. prefect/_internal/concurrency/services.py +23 -0
  13. prefect/_internal/concurrency/threads.py +35 -0
  14. prefect/_internal/concurrency/waiters.py +0 -28
  15. prefect/_internal/integrations.py +7 -0
  16. prefect/_internal/pydantic/__init__.py +0 -45
  17. prefect/_internal/pydantic/annotations/pendulum.py +2 -2
  18. prefect/_internal/pydantic/v1_schema.py +21 -22
  19. prefect/_internal/pydantic/v2_schema.py +0 -2
  20. prefect/_internal/pydantic/v2_validated_func.py +18 -23
  21. prefect/_internal/pytz.py +1 -1
  22. prefect/_internal/retries.py +61 -0
  23. prefect/_internal/schemas/bases.py +45 -177
  24. prefect/_internal/schemas/fields.py +1 -43
  25. prefect/_internal/schemas/validators.py +47 -233
  26. prefect/agent.py +3 -695
  27. prefect/artifacts.py +173 -14
  28. prefect/automations.py +39 -4
  29. prefect/blocks/abstract.py +1 -1
  30. prefect/blocks/core.py +405 -153
  31. prefect/blocks/fields.py +2 -57
  32. prefect/blocks/notifications.py +43 -28
  33. prefect/blocks/redis.py +168 -0
  34. prefect/blocks/system.py +67 -20
  35. prefect/blocks/webhook.py +2 -9
  36. prefect/cache_policies.py +239 -0
  37. prefect/client/__init__.py +4 -0
  38. prefect/client/base.py +33 -27
  39. prefect/client/cloud.py +65 -20
  40. prefect/client/collections.py +1 -1
  41. prefect/client/orchestration.py +650 -442
  42. prefect/client/schemas/actions.py +115 -100
  43. prefect/client/schemas/filters.py +46 -52
  44. prefect/client/schemas/objects.py +228 -178
  45. prefect/client/schemas/responses.py +18 -36
  46. prefect/client/schemas/schedules.py +55 -36
  47. prefect/client/schemas/sorting.py +2 -0
  48. prefect/client/subscriptions.py +8 -7
  49. prefect/client/types/flexible_schedule_list.py +11 -0
  50. prefect/client/utilities.py +9 -6
  51. prefect/concurrency/asyncio.py +60 -11
  52. prefect/concurrency/context.py +24 -0
  53. prefect/concurrency/events.py +2 -2
  54. prefect/concurrency/services.py +46 -16
  55. prefect/concurrency/sync.py +51 -7
  56. prefect/concurrency/v1/asyncio.py +143 -0
  57. prefect/concurrency/v1/context.py +27 -0
  58. prefect/concurrency/v1/events.py +61 -0
  59. prefect/concurrency/v1/services.py +116 -0
  60. prefect/concurrency/v1/sync.py +92 -0
  61. prefect/context.py +246 -149
  62. prefect/deployments/__init__.py +33 -18
  63. prefect/deployments/base.py +10 -15
  64. prefect/deployments/deployments.py +2 -1048
  65. prefect/deployments/flow_runs.py +178 -0
  66. prefect/deployments/runner.py +72 -173
  67. prefect/deployments/schedules.py +31 -25
  68. prefect/deployments/steps/__init__.py +0 -1
  69. prefect/deployments/steps/core.py +7 -0
  70. prefect/deployments/steps/pull.py +15 -21
  71. prefect/deployments/steps/utility.py +2 -1
  72. prefect/docker/__init__.py +20 -0
  73. prefect/docker/docker_image.py +82 -0
  74. prefect/engine.py +15 -2475
  75. prefect/events/actions.py +17 -23
  76. prefect/events/cli/automations.py +20 -7
  77. prefect/events/clients.py +142 -80
  78. prefect/events/filters.py +14 -18
  79. prefect/events/related.py +74 -75
  80. prefect/events/schemas/__init__.py +0 -5
  81. prefect/events/schemas/automations.py +55 -46
  82. prefect/events/schemas/deployment_triggers.py +7 -197
  83. prefect/events/schemas/events.py +46 -65
  84. prefect/events/schemas/labelling.py +10 -14
  85. prefect/events/utilities.py +4 -5
  86. prefect/events/worker.py +23 -8
  87. prefect/exceptions.py +15 -0
  88. prefect/filesystems.py +30 -529
  89. prefect/flow_engine.py +827 -0
  90. prefect/flow_runs.py +379 -7
  91. prefect/flows.py +470 -360
  92. prefect/futures.py +382 -331
  93. prefect/infrastructure/__init__.py +5 -26
  94. prefect/infrastructure/base.py +3 -320
  95. prefect/infrastructure/provisioners/__init__.py +5 -3
  96. prefect/infrastructure/provisioners/cloud_run.py +13 -8
  97. prefect/infrastructure/provisioners/container_instance.py +14 -9
  98. prefect/infrastructure/provisioners/ecs.py +10 -8
  99. prefect/infrastructure/provisioners/modal.py +8 -5
  100. prefect/input/__init__.py +4 -0
  101. prefect/input/actions.py +2 -4
  102. prefect/input/run_input.py +9 -9
  103. prefect/logging/formatters.py +2 -4
  104. prefect/logging/handlers.py +9 -14
  105. prefect/logging/loggers.py +5 -5
  106. prefect/main.py +72 -0
  107. prefect/plugins.py +2 -64
  108. prefect/profiles.toml +16 -2
  109. prefect/records/__init__.py +1 -0
  110. prefect/records/base.py +223 -0
  111. prefect/records/filesystem.py +207 -0
  112. prefect/records/memory.py +178 -0
  113. prefect/records/result_store.py +64 -0
  114. prefect/results.py +577 -504
  115. prefect/runner/runner.py +117 -47
  116. prefect/runner/server.py +32 -34
  117. prefect/runner/storage.py +3 -12
  118. prefect/runner/submit.py +2 -10
  119. prefect/runner/utils.py +2 -2
  120. prefect/runtime/__init__.py +1 -0
  121. prefect/runtime/deployment.py +1 -0
  122. prefect/runtime/flow_run.py +40 -5
  123. prefect/runtime/task_run.py +1 -0
  124. prefect/serializers.py +28 -39
  125. prefect/server/api/collections_data/views/aggregate-worker-metadata.json +5 -14
  126. prefect/settings.py +209 -332
  127. prefect/states.py +160 -63
  128. prefect/task_engine.py +1478 -57
  129. prefect/task_runners.py +383 -287
  130. prefect/task_runs.py +240 -0
  131. prefect/task_worker.py +463 -0
  132. prefect/tasks.py +684 -374
  133. prefect/transactions.py +410 -0
  134. prefect/types/__init__.py +72 -86
  135. prefect/types/entrypoint.py +13 -0
  136. prefect/utilities/annotations.py +4 -3
  137. prefect/utilities/asyncutils.py +227 -148
  138. prefect/utilities/callables.py +137 -45
  139. prefect/utilities/collections.py +134 -86
  140. prefect/utilities/dispatch.py +27 -14
  141. prefect/utilities/dockerutils.py +11 -4
  142. prefect/utilities/engine.py +186 -32
  143. prefect/utilities/filesystem.py +4 -5
  144. prefect/utilities/importtools.py +26 -27
  145. prefect/utilities/pydantic.py +128 -38
  146. prefect/utilities/schema_tools/hydration.py +18 -1
  147. prefect/utilities/schema_tools/validation.py +30 -0
  148. prefect/utilities/services.py +35 -9
  149. prefect/utilities/templating.py +12 -2
  150. prefect/utilities/timeout.py +20 -5
  151. prefect/utilities/urls.py +195 -0
  152. prefect/utilities/visualization.py +1 -0
  153. prefect/variables.py +78 -59
  154. prefect/workers/__init__.py +0 -1
  155. prefect/workers/base.py +237 -244
  156. prefect/workers/block.py +5 -226
  157. prefect/workers/cloud.py +6 -0
  158. prefect/workers/process.py +265 -12
  159. prefect/workers/server.py +29 -11
  160. {prefect_client-2.20.4.dist-info → prefect_client-3.0.0.dist-info}/METADATA +28 -24
  161. prefect_client-3.0.0.dist-info/RECORD +201 -0
  162. {prefect_client-2.20.4.dist-info → prefect_client-3.0.0.dist-info}/WHEEL +1 -1
  163. prefect/_internal/pydantic/_base_model.py +0 -51
  164. prefect/_internal/pydantic/_compat.py +0 -82
  165. prefect/_internal/pydantic/_flags.py +0 -20
  166. prefect/_internal/pydantic/_types.py +0 -8
  167. prefect/_internal/pydantic/utilities/config_dict.py +0 -72
  168. prefect/_internal/pydantic/utilities/field_validator.py +0 -150
  169. prefect/_internal/pydantic/utilities/model_construct.py +0 -56
  170. prefect/_internal/pydantic/utilities/model_copy.py +0 -55
  171. prefect/_internal/pydantic/utilities/model_dump.py +0 -136
  172. prefect/_internal/pydantic/utilities/model_dump_json.py +0 -112
  173. prefect/_internal/pydantic/utilities/model_fields.py +0 -50
  174. prefect/_internal/pydantic/utilities/model_fields_set.py +0 -29
  175. prefect/_internal/pydantic/utilities/model_json_schema.py +0 -82
  176. prefect/_internal/pydantic/utilities/model_rebuild.py +0 -80
  177. prefect/_internal/pydantic/utilities/model_validate.py +0 -75
  178. prefect/_internal/pydantic/utilities/model_validate_json.py +0 -68
  179. prefect/_internal/pydantic/utilities/model_validator.py +0 -87
  180. prefect/_internal/pydantic/utilities/type_adapter.py +0 -71
  181. prefect/_vendor/fastapi/__init__.py +0 -25
  182. prefect/_vendor/fastapi/applications.py +0 -946
  183. prefect/_vendor/fastapi/background.py +0 -3
  184. prefect/_vendor/fastapi/concurrency.py +0 -44
  185. prefect/_vendor/fastapi/datastructures.py +0 -58
  186. prefect/_vendor/fastapi/dependencies/__init__.py +0 -0
  187. prefect/_vendor/fastapi/dependencies/models.py +0 -64
  188. prefect/_vendor/fastapi/dependencies/utils.py +0 -877
  189. prefect/_vendor/fastapi/encoders.py +0 -177
  190. prefect/_vendor/fastapi/exception_handlers.py +0 -40
  191. prefect/_vendor/fastapi/exceptions.py +0 -46
  192. prefect/_vendor/fastapi/logger.py +0 -3
  193. prefect/_vendor/fastapi/middleware/__init__.py +0 -1
  194. prefect/_vendor/fastapi/middleware/asyncexitstack.py +0 -25
  195. prefect/_vendor/fastapi/middleware/cors.py +0 -3
  196. prefect/_vendor/fastapi/middleware/gzip.py +0 -3
  197. prefect/_vendor/fastapi/middleware/httpsredirect.py +0 -3
  198. prefect/_vendor/fastapi/middleware/trustedhost.py +0 -3
  199. prefect/_vendor/fastapi/middleware/wsgi.py +0 -3
  200. prefect/_vendor/fastapi/openapi/__init__.py +0 -0
  201. prefect/_vendor/fastapi/openapi/constants.py +0 -2
  202. prefect/_vendor/fastapi/openapi/docs.py +0 -203
  203. prefect/_vendor/fastapi/openapi/models.py +0 -480
  204. prefect/_vendor/fastapi/openapi/utils.py +0 -485
  205. prefect/_vendor/fastapi/param_functions.py +0 -340
  206. prefect/_vendor/fastapi/params.py +0 -453
  207. prefect/_vendor/fastapi/py.typed +0 -0
  208. prefect/_vendor/fastapi/requests.py +0 -4
  209. prefect/_vendor/fastapi/responses.py +0 -40
  210. prefect/_vendor/fastapi/routing.py +0 -1331
  211. prefect/_vendor/fastapi/security/__init__.py +0 -15
  212. prefect/_vendor/fastapi/security/api_key.py +0 -98
  213. prefect/_vendor/fastapi/security/base.py +0 -6
  214. prefect/_vendor/fastapi/security/http.py +0 -172
  215. prefect/_vendor/fastapi/security/oauth2.py +0 -227
  216. prefect/_vendor/fastapi/security/open_id_connect_url.py +0 -34
  217. prefect/_vendor/fastapi/security/utils.py +0 -10
  218. prefect/_vendor/fastapi/staticfiles.py +0 -1
  219. prefect/_vendor/fastapi/templating.py +0 -3
  220. prefect/_vendor/fastapi/testclient.py +0 -1
  221. prefect/_vendor/fastapi/types.py +0 -3
  222. prefect/_vendor/fastapi/utils.py +0 -235
  223. prefect/_vendor/fastapi/websockets.py +0 -7
  224. prefect/_vendor/starlette/__init__.py +0 -1
  225. prefect/_vendor/starlette/_compat.py +0 -28
  226. prefect/_vendor/starlette/_exception_handler.py +0 -80
  227. prefect/_vendor/starlette/_utils.py +0 -88
  228. prefect/_vendor/starlette/applications.py +0 -261
  229. prefect/_vendor/starlette/authentication.py +0 -159
  230. prefect/_vendor/starlette/background.py +0 -43
  231. prefect/_vendor/starlette/concurrency.py +0 -59
  232. prefect/_vendor/starlette/config.py +0 -151
  233. prefect/_vendor/starlette/convertors.py +0 -87
  234. prefect/_vendor/starlette/datastructures.py +0 -707
  235. prefect/_vendor/starlette/endpoints.py +0 -130
  236. prefect/_vendor/starlette/exceptions.py +0 -60
  237. prefect/_vendor/starlette/formparsers.py +0 -276
  238. prefect/_vendor/starlette/middleware/__init__.py +0 -17
  239. prefect/_vendor/starlette/middleware/authentication.py +0 -52
  240. prefect/_vendor/starlette/middleware/base.py +0 -220
  241. prefect/_vendor/starlette/middleware/cors.py +0 -176
  242. prefect/_vendor/starlette/middleware/errors.py +0 -265
  243. prefect/_vendor/starlette/middleware/exceptions.py +0 -74
  244. prefect/_vendor/starlette/middleware/gzip.py +0 -113
  245. prefect/_vendor/starlette/middleware/httpsredirect.py +0 -19
  246. prefect/_vendor/starlette/middleware/sessions.py +0 -82
  247. prefect/_vendor/starlette/middleware/trustedhost.py +0 -64
  248. prefect/_vendor/starlette/middleware/wsgi.py +0 -147
  249. prefect/_vendor/starlette/py.typed +0 -0
  250. prefect/_vendor/starlette/requests.py +0 -328
  251. prefect/_vendor/starlette/responses.py +0 -347
  252. prefect/_vendor/starlette/routing.py +0 -933
  253. prefect/_vendor/starlette/schemas.py +0 -154
  254. prefect/_vendor/starlette/staticfiles.py +0 -248
  255. prefect/_vendor/starlette/status.py +0 -199
  256. prefect/_vendor/starlette/templating.py +0 -231
  257. prefect/_vendor/starlette/testclient.py +0 -804
  258. prefect/_vendor/starlette/types.py +0 -30
  259. prefect/_vendor/starlette/websockets.py +0 -193
  260. prefect/blocks/kubernetes.py +0 -119
  261. prefect/deprecated/__init__.py +0 -0
  262. prefect/deprecated/data_documents.py +0 -350
  263. prefect/deprecated/packaging/__init__.py +0 -12
  264. prefect/deprecated/packaging/base.py +0 -96
  265. prefect/deprecated/packaging/docker.py +0 -146
  266. prefect/deprecated/packaging/file.py +0 -92
  267. prefect/deprecated/packaging/orion.py +0 -80
  268. prefect/deprecated/packaging/serializers.py +0 -171
  269. prefect/events/instrument.py +0 -135
  270. prefect/infrastructure/container.py +0 -824
  271. prefect/infrastructure/kubernetes.py +0 -920
  272. prefect/infrastructure/process.py +0 -289
  273. prefect/manifests.py +0 -20
  274. prefect/new_flow_engine.py +0 -449
  275. prefect/new_task_engine.py +0 -423
  276. prefect/pydantic/__init__.py +0 -76
  277. prefect/pydantic/main.py +0 -39
  278. prefect/software/__init__.py +0 -2
  279. prefect/software/base.py +0 -50
  280. prefect/software/conda.py +0 -199
  281. prefect/software/pip.py +0 -122
  282. prefect/software/python.py +0 -52
  283. prefect/task_server.py +0 -322
  284. prefect_client-2.20.4.dist-info/RECORD +0 -294
  285. /prefect/{_internal/pydantic/utilities → client/types}/__init__.py +0 -0
  286. /prefect/{_vendor → concurrency/v1}/__init__.py +0 -0
  287. {prefect_client-2.20.4.dist-info → prefect_client-3.0.0.dist-info}/LICENSE +0 -0
  288. {prefect_client-2.20.4.dist-info → prefect_client-3.0.0.dist-info}/top_level.txt +0 -0
@@ -1,340 +0,0 @@
1
- from typing import Any, Callable, List, Optional, Sequence
2
-
3
- from prefect._vendor.fastapi import params
4
-
5
- from prefect._internal.pydantic import HAS_PYDANTIC_V2
6
-
7
- if HAS_PYDANTIC_V2:
8
- from pydantic.v1.fields import Undefined
9
- else:
10
- from pydantic.fields import Undefined
11
-
12
- from typing_extensions import Annotated, deprecated
13
-
14
-
15
- def Path( # noqa: N802
16
- default: Any = ...,
17
- *,
18
- alias: Optional[str] = None,
19
- title: Optional[str] = None,
20
- description: Optional[str] = None,
21
- gt: Optional[float] = None,
22
- ge: Optional[float] = None,
23
- lt: Optional[float] = None,
24
- le: Optional[float] = None,
25
- min_length: Optional[int] = None,
26
- max_length: Optional[int] = None,
27
- regex: Optional[str] = None,
28
- examples: Optional[List[Any]] = None,
29
- example: Annotated[
30
- Optional[Any],
31
- deprecated(
32
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
33
- "although still supported. Use examples instead."
34
- ),
35
- ] = Undefined,
36
- deprecated: Optional[bool] = None,
37
- include_in_schema: bool = True,
38
- **extra: Any,
39
- ) -> Any:
40
- return params.Path(
41
- default=default,
42
- alias=alias,
43
- title=title,
44
- description=description,
45
- gt=gt,
46
- ge=ge,
47
- lt=lt,
48
- le=le,
49
- min_length=min_length,
50
- max_length=max_length,
51
- regex=regex,
52
- example=example,
53
- examples=examples,
54
- deprecated=deprecated,
55
- include_in_schema=include_in_schema,
56
- **extra,
57
- )
58
-
59
-
60
- def Query( # noqa: N802
61
- default: Any = Undefined,
62
- *,
63
- alias: Optional[str] = None,
64
- title: Optional[str] = None,
65
- description: Optional[str] = None,
66
- gt: Optional[float] = None,
67
- ge: Optional[float] = None,
68
- lt: Optional[float] = None,
69
- le: Optional[float] = None,
70
- min_length: Optional[int] = None,
71
- max_length: Optional[int] = None,
72
- regex: Optional[str] = None,
73
- examples: Optional[List[Any]] = None,
74
- example: Annotated[
75
- Optional[Any],
76
- deprecated(
77
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
78
- "although still supported. Use examples instead."
79
- ),
80
- ] = Undefined,
81
- deprecated: Optional[bool] = None,
82
- include_in_schema: bool = True,
83
- **extra: Any,
84
- ) -> Any:
85
- return params.Query(
86
- default=default,
87
- alias=alias,
88
- title=title,
89
- description=description,
90
- gt=gt,
91
- ge=ge,
92
- lt=lt,
93
- le=le,
94
- min_length=min_length,
95
- max_length=max_length,
96
- regex=regex,
97
- example=example,
98
- examples=examples,
99
- deprecated=deprecated,
100
- include_in_schema=include_in_schema,
101
- **extra,
102
- )
103
-
104
-
105
- def Header( # noqa: N802
106
- default: Any = Undefined,
107
- *,
108
- alias: Optional[str] = None,
109
- convert_underscores: bool = True,
110
- title: Optional[str] = None,
111
- description: Optional[str] = None,
112
- gt: Optional[float] = None,
113
- ge: Optional[float] = None,
114
- lt: Optional[float] = None,
115
- le: Optional[float] = None,
116
- min_length: Optional[int] = None,
117
- max_length: Optional[int] = None,
118
- regex: Optional[str] = None,
119
- examples: Optional[List[Any]] = None,
120
- example: Annotated[
121
- Optional[Any],
122
- deprecated(
123
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
124
- "although still supported. Use examples instead."
125
- ),
126
- ] = Undefined,
127
- deprecated: Optional[bool] = None,
128
- include_in_schema: bool = True,
129
- **extra: Any,
130
- ) -> Any:
131
- return params.Header(
132
- default=default,
133
- alias=alias,
134
- convert_underscores=convert_underscores,
135
- title=title,
136
- description=description,
137
- gt=gt,
138
- ge=ge,
139
- lt=lt,
140
- le=le,
141
- min_length=min_length,
142
- max_length=max_length,
143
- regex=regex,
144
- example=example,
145
- examples=examples,
146
- deprecated=deprecated,
147
- include_in_schema=include_in_schema,
148
- **extra,
149
- )
150
-
151
-
152
- def Cookie( # noqa: N802
153
- default: Any = Undefined,
154
- *,
155
- alias: Optional[str] = None,
156
- title: Optional[str] = None,
157
- description: Optional[str] = None,
158
- gt: Optional[float] = None,
159
- ge: Optional[float] = None,
160
- lt: Optional[float] = None,
161
- le: Optional[float] = None,
162
- min_length: Optional[int] = None,
163
- max_length: Optional[int] = None,
164
- regex: Optional[str] = None,
165
- examples: Optional[List[Any]] = None,
166
- example: Annotated[
167
- Optional[Any],
168
- deprecated(
169
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
170
- "although still supported. Use examples instead."
171
- ),
172
- ] = Undefined,
173
- deprecated: Optional[bool] = None,
174
- include_in_schema: bool = True,
175
- **extra: Any,
176
- ) -> Any:
177
- return params.Cookie(
178
- default=default,
179
- alias=alias,
180
- title=title,
181
- description=description,
182
- gt=gt,
183
- ge=ge,
184
- lt=lt,
185
- le=le,
186
- min_length=min_length,
187
- max_length=max_length,
188
- regex=regex,
189
- example=example,
190
- examples=examples,
191
- deprecated=deprecated,
192
- include_in_schema=include_in_schema,
193
- **extra,
194
- )
195
-
196
-
197
- def Body( # noqa: N802
198
- default: Any = Undefined,
199
- *,
200
- embed: bool = False,
201
- media_type: str = "application/json",
202
- alias: Optional[str] = None,
203
- title: Optional[str] = None,
204
- description: Optional[str] = None,
205
- gt: Optional[float] = None,
206
- ge: Optional[float] = None,
207
- lt: Optional[float] = None,
208
- le: Optional[float] = None,
209
- min_length: Optional[int] = None,
210
- max_length: Optional[int] = None,
211
- regex: Optional[str] = None,
212
- examples: Optional[List[Any]] = None,
213
- example: Annotated[
214
- Optional[Any],
215
- deprecated(
216
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
217
- "although still supported. Use examples instead."
218
- ),
219
- ] = Undefined,
220
- **extra: Any,
221
- ) -> Any:
222
- return params.Body(
223
- default=default,
224
- embed=embed,
225
- media_type=media_type,
226
- alias=alias,
227
- title=title,
228
- description=description,
229
- gt=gt,
230
- ge=ge,
231
- lt=lt,
232
- le=le,
233
- min_length=min_length,
234
- max_length=max_length,
235
- regex=regex,
236
- example=example,
237
- examples=examples,
238
- **extra,
239
- )
240
-
241
-
242
- def Form( # noqa: N802
243
- default: Any = Undefined,
244
- *,
245
- media_type: str = "application/x-www-form-urlencoded",
246
- alias: Optional[str] = None,
247
- title: Optional[str] = None,
248
- description: Optional[str] = None,
249
- gt: Optional[float] = None,
250
- ge: Optional[float] = None,
251
- lt: Optional[float] = None,
252
- le: Optional[float] = None,
253
- min_length: Optional[int] = None,
254
- max_length: Optional[int] = None,
255
- regex: Optional[str] = None,
256
- examples: Optional[List[Any]] = None,
257
- example: Annotated[
258
- Optional[Any],
259
- deprecated(
260
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
261
- "although still supported. Use examples instead."
262
- ),
263
- ] = Undefined,
264
- **extra: Any,
265
- ) -> Any:
266
- return params.Form(
267
- default=default,
268
- media_type=media_type,
269
- alias=alias,
270
- title=title,
271
- description=description,
272
- gt=gt,
273
- ge=ge,
274
- lt=lt,
275
- le=le,
276
- min_length=min_length,
277
- max_length=max_length,
278
- regex=regex,
279
- example=example,
280
- examples=examples,
281
- **extra,
282
- )
283
-
284
-
285
- def File( # noqa: N802
286
- default: Any = Undefined,
287
- *,
288
- media_type: str = "multipart/form-data",
289
- alias: Optional[str] = None,
290
- title: Optional[str] = None,
291
- description: Optional[str] = None,
292
- gt: Optional[float] = None,
293
- ge: Optional[float] = None,
294
- lt: Optional[float] = None,
295
- le: Optional[float] = None,
296
- min_length: Optional[int] = None,
297
- max_length: Optional[int] = None,
298
- regex: Optional[str] = None,
299
- examples: Optional[List[Any]] = None,
300
- example: Annotated[
301
- Optional[Any],
302
- deprecated(
303
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
304
- "although still supported. Use examples instead."
305
- ),
306
- ] = Undefined,
307
- **extra: Any,
308
- ) -> Any:
309
- return params.File(
310
- default=default,
311
- media_type=media_type,
312
- alias=alias,
313
- title=title,
314
- description=description,
315
- gt=gt,
316
- ge=ge,
317
- lt=lt,
318
- le=le,
319
- min_length=min_length,
320
- max_length=max_length,
321
- regex=regex,
322
- example=example,
323
- examples=examples,
324
- **extra,
325
- )
326
-
327
-
328
- def Depends( # noqa: N802
329
- dependency: Optional[Callable[..., Any]] = None, *, use_cache: bool = True
330
- ) -> Any:
331
- return params.Depends(dependency=dependency, use_cache=use_cache)
332
-
333
-
334
- def Security( # noqa: N802
335
- dependency: Optional[Callable[..., Any]] = None,
336
- *,
337
- scopes: Optional[Sequence[str]] = None,
338
- use_cache: bool = True,
339
- ) -> Any:
340
- return params.Security(dependency=dependency, scopes=scopes, use_cache=use_cache)