prefect-client 2.20.2__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.
- prefect/__init__.py +74 -110
- prefect/_internal/compatibility/deprecated.py +6 -115
- prefect/_internal/compatibility/experimental.py +4 -79
- prefect/_internal/compatibility/migration.py +166 -0
- prefect/_internal/concurrency/__init__.py +2 -2
- prefect/_internal/concurrency/api.py +1 -35
- prefect/_internal/concurrency/calls.py +0 -6
- prefect/_internal/concurrency/cancellation.py +0 -3
- prefect/_internal/concurrency/event_loop.py +0 -20
- prefect/_internal/concurrency/inspection.py +3 -3
- prefect/_internal/concurrency/primitives.py +1 -0
- prefect/_internal/concurrency/services.py +23 -0
- prefect/_internal/concurrency/threads.py +35 -0
- prefect/_internal/concurrency/waiters.py +0 -28
- prefect/_internal/integrations.py +7 -0
- prefect/_internal/pydantic/__init__.py +0 -45
- prefect/_internal/pydantic/annotations/pendulum.py +2 -2
- prefect/_internal/pydantic/v1_schema.py +21 -22
- prefect/_internal/pydantic/v2_schema.py +0 -2
- prefect/_internal/pydantic/v2_validated_func.py +18 -23
- prefect/_internal/pytz.py +1 -1
- prefect/_internal/retries.py +61 -0
- prefect/_internal/schemas/bases.py +45 -177
- prefect/_internal/schemas/fields.py +1 -43
- prefect/_internal/schemas/validators.py +47 -233
- prefect/agent.py +3 -695
- prefect/artifacts.py +173 -14
- prefect/automations.py +39 -4
- prefect/blocks/abstract.py +1 -1
- prefect/blocks/core.py +423 -164
- prefect/blocks/fields.py +2 -57
- prefect/blocks/notifications.py +43 -28
- prefect/blocks/redis.py +168 -0
- prefect/blocks/system.py +67 -20
- prefect/blocks/webhook.py +2 -9
- prefect/cache_policies.py +239 -0
- prefect/client/__init__.py +4 -0
- prefect/client/base.py +33 -27
- prefect/client/cloud.py +65 -20
- prefect/client/collections.py +1 -1
- prefect/client/orchestration.py +667 -440
- prefect/client/schemas/actions.py +115 -100
- prefect/client/schemas/filters.py +46 -52
- prefect/client/schemas/objects.py +228 -178
- prefect/client/schemas/responses.py +18 -36
- prefect/client/schemas/schedules.py +55 -36
- prefect/client/schemas/sorting.py +2 -0
- prefect/client/subscriptions.py +8 -7
- prefect/client/types/flexible_schedule_list.py +11 -0
- prefect/client/utilities.py +9 -6
- prefect/concurrency/asyncio.py +60 -11
- prefect/concurrency/context.py +24 -0
- prefect/concurrency/events.py +2 -2
- prefect/concurrency/services.py +46 -16
- prefect/concurrency/sync.py +51 -7
- prefect/concurrency/v1/asyncio.py +143 -0
- prefect/concurrency/v1/context.py +27 -0
- prefect/concurrency/v1/events.py +61 -0
- prefect/concurrency/v1/services.py +116 -0
- prefect/concurrency/v1/sync.py +92 -0
- prefect/context.py +246 -149
- prefect/deployments/__init__.py +33 -18
- prefect/deployments/base.py +10 -15
- prefect/deployments/deployments.py +2 -1048
- prefect/deployments/flow_runs.py +178 -0
- prefect/deployments/runner.py +72 -173
- prefect/deployments/schedules.py +31 -25
- prefect/deployments/steps/__init__.py +0 -1
- prefect/deployments/steps/core.py +7 -0
- prefect/deployments/steps/pull.py +15 -21
- prefect/deployments/steps/utility.py +2 -1
- prefect/docker/__init__.py +20 -0
- prefect/docker/docker_image.py +82 -0
- prefect/engine.py +15 -2466
- prefect/events/actions.py +17 -23
- prefect/events/cli/automations.py +20 -7
- prefect/events/clients.py +142 -80
- prefect/events/filters.py +14 -18
- prefect/events/related.py +74 -75
- prefect/events/schemas/__init__.py +0 -5
- prefect/events/schemas/automations.py +55 -46
- prefect/events/schemas/deployment_triggers.py +7 -197
- prefect/events/schemas/events.py +46 -65
- prefect/events/schemas/labelling.py +10 -14
- prefect/events/utilities.py +4 -5
- prefect/events/worker.py +23 -8
- prefect/exceptions.py +15 -0
- prefect/filesystems.py +30 -529
- prefect/flow_engine.py +827 -0
- prefect/flow_runs.py +379 -7
- prefect/flows.py +470 -360
- prefect/futures.py +382 -331
- prefect/infrastructure/__init__.py +5 -26
- prefect/infrastructure/base.py +3 -320
- prefect/infrastructure/provisioners/__init__.py +5 -3
- prefect/infrastructure/provisioners/cloud_run.py +13 -8
- prefect/infrastructure/provisioners/container_instance.py +14 -9
- prefect/infrastructure/provisioners/ecs.py +10 -8
- prefect/infrastructure/provisioners/modal.py +8 -5
- prefect/input/__init__.py +4 -0
- prefect/input/actions.py +2 -4
- prefect/input/run_input.py +9 -9
- prefect/logging/formatters.py +2 -4
- prefect/logging/handlers.py +9 -14
- prefect/logging/loggers.py +5 -5
- prefect/main.py +72 -0
- prefect/plugins.py +2 -64
- prefect/profiles.toml +16 -2
- prefect/records/__init__.py +1 -0
- prefect/records/base.py +223 -0
- prefect/records/filesystem.py +207 -0
- prefect/records/memory.py +178 -0
- prefect/records/result_store.py +64 -0
- prefect/results.py +577 -504
- prefect/runner/runner.py +124 -51
- prefect/runner/server.py +32 -34
- prefect/runner/storage.py +3 -12
- prefect/runner/submit.py +2 -10
- prefect/runner/utils.py +2 -2
- prefect/runtime/__init__.py +1 -0
- prefect/runtime/deployment.py +1 -0
- prefect/runtime/flow_run.py +40 -5
- prefect/runtime/task_run.py +1 -0
- prefect/serializers.py +28 -39
- prefect/server/api/collections_data/views/aggregate-worker-metadata.json +5 -14
- prefect/settings.py +209 -332
- prefect/states.py +160 -63
- prefect/task_engine.py +1478 -57
- prefect/task_runners.py +383 -287
- prefect/task_runs.py +240 -0
- prefect/task_worker.py +463 -0
- prefect/tasks.py +684 -374
- prefect/transactions.py +410 -0
- prefect/types/__init__.py +72 -86
- prefect/types/entrypoint.py +13 -0
- prefect/utilities/annotations.py +4 -3
- prefect/utilities/asyncutils.py +227 -148
- prefect/utilities/callables.py +138 -48
- prefect/utilities/collections.py +134 -86
- prefect/utilities/dispatch.py +27 -14
- prefect/utilities/dockerutils.py +11 -4
- prefect/utilities/engine.py +186 -32
- prefect/utilities/filesystem.py +4 -5
- prefect/utilities/importtools.py +26 -27
- prefect/utilities/pydantic.py +128 -38
- prefect/utilities/schema_tools/hydration.py +18 -1
- prefect/utilities/schema_tools/validation.py +30 -0
- prefect/utilities/services.py +35 -9
- prefect/utilities/templating.py +12 -2
- prefect/utilities/timeout.py +20 -5
- prefect/utilities/urls.py +195 -0
- prefect/utilities/visualization.py +1 -0
- prefect/variables.py +78 -59
- prefect/workers/__init__.py +0 -1
- prefect/workers/base.py +237 -244
- prefect/workers/block.py +5 -226
- prefect/workers/cloud.py +6 -0
- prefect/workers/process.py +265 -12
- prefect/workers/server.py +29 -11
- {prefect_client-2.20.2.dist-info → prefect_client-3.0.0.dist-info}/METADATA +30 -26
- prefect_client-3.0.0.dist-info/RECORD +201 -0
- {prefect_client-2.20.2.dist-info → prefect_client-3.0.0.dist-info}/WHEEL +1 -1
- prefect/_internal/pydantic/_base_model.py +0 -51
- prefect/_internal/pydantic/_compat.py +0 -82
- prefect/_internal/pydantic/_flags.py +0 -20
- prefect/_internal/pydantic/_types.py +0 -8
- prefect/_internal/pydantic/utilities/config_dict.py +0 -72
- prefect/_internal/pydantic/utilities/field_validator.py +0 -150
- prefect/_internal/pydantic/utilities/model_construct.py +0 -56
- prefect/_internal/pydantic/utilities/model_copy.py +0 -55
- prefect/_internal/pydantic/utilities/model_dump.py +0 -136
- prefect/_internal/pydantic/utilities/model_dump_json.py +0 -112
- prefect/_internal/pydantic/utilities/model_fields.py +0 -50
- prefect/_internal/pydantic/utilities/model_fields_set.py +0 -29
- prefect/_internal/pydantic/utilities/model_json_schema.py +0 -82
- prefect/_internal/pydantic/utilities/model_rebuild.py +0 -80
- prefect/_internal/pydantic/utilities/model_validate.py +0 -75
- prefect/_internal/pydantic/utilities/model_validate_json.py +0 -68
- prefect/_internal/pydantic/utilities/model_validator.py +0 -87
- prefect/_internal/pydantic/utilities/type_adapter.py +0 -71
- prefect/_vendor/fastapi/__init__.py +0 -25
- prefect/_vendor/fastapi/applications.py +0 -946
- prefect/_vendor/fastapi/background.py +0 -3
- prefect/_vendor/fastapi/concurrency.py +0 -44
- prefect/_vendor/fastapi/datastructures.py +0 -58
- prefect/_vendor/fastapi/dependencies/__init__.py +0 -0
- prefect/_vendor/fastapi/dependencies/models.py +0 -64
- prefect/_vendor/fastapi/dependencies/utils.py +0 -877
- prefect/_vendor/fastapi/encoders.py +0 -177
- prefect/_vendor/fastapi/exception_handlers.py +0 -40
- prefect/_vendor/fastapi/exceptions.py +0 -46
- prefect/_vendor/fastapi/logger.py +0 -3
- prefect/_vendor/fastapi/middleware/__init__.py +0 -1
- prefect/_vendor/fastapi/middleware/asyncexitstack.py +0 -25
- prefect/_vendor/fastapi/middleware/cors.py +0 -3
- prefect/_vendor/fastapi/middleware/gzip.py +0 -3
- prefect/_vendor/fastapi/middleware/httpsredirect.py +0 -3
- prefect/_vendor/fastapi/middleware/trustedhost.py +0 -3
- prefect/_vendor/fastapi/middleware/wsgi.py +0 -3
- prefect/_vendor/fastapi/openapi/__init__.py +0 -0
- prefect/_vendor/fastapi/openapi/constants.py +0 -2
- prefect/_vendor/fastapi/openapi/docs.py +0 -203
- prefect/_vendor/fastapi/openapi/models.py +0 -480
- prefect/_vendor/fastapi/openapi/utils.py +0 -485
- prefect/_vendor/fastapi/param_functions.py +0 -340
- prefect/_vendor/fastapi/params.py +0 -453
- prefect/_vendor/fastapi/py.typed +0 -0
- prefect/_vendor/fastapi/requests.py +0 -4
- prefect/_vendor/fastapi/responses.py +0 -40
- prefect/_vendor/fastapi/routing.py +0 -1331
- prefect/_vendor/fastapi/security/__init__.py +0 -15
- prefect/_vendor/fastapi/security/api_key.py +0 -98
- prefect/_vendor/fastapi/security/base.py +0 -6
- prefect/_vendor/fastapi/security/http.py +0 -172
- prefect/_vendor/fastapi/security/oauth2.py +0 -227
- prefect/_vendor/fastapi/security/open_id_connect_url.py +0 -34
- prefect/_vendor/fastapi/security/utils.py +0 -10
- prefect/_vendor/fastapi/staticfiles.py +0 -1
- prefect/_vendor/fastapi/templating.py +0 -3
- prefect/_vendor/fastapi/testclient.py +0 -1
- prefect/_vendor/fastapi/types.py +0 -3
- prefect/_vendor/fastapi/utils.py +0 -235
- prefect/_vendor/fastapi/websockets.py +0 -7
- prefect/_vendor/starlette/__init__.py +0 -1
- prefect/_vendor/starlette/_compat.py +0 -28
- prefect/_vendor/starlette/_exception_handler.py +0 -80
- prefect/_vendor/starlette/_utils.py +0 -88
- prefect/_vendor/starlette/applications.py +0 -261
- prefect/_vendor/starlette/authentication.py +0 -159
- prefect/_vendor/starlette/background.py +0 -43
- prefect/_vendor/starlette/concurrency.py +0 -59
- prefect/_vendor/starlette/config.py +0 -151
- prefect/_vendor/starlette/convertors.py +0 -87
- prefect/_vendor/starlette/datastructures.py +0 -707
- prefect/_vendor/starlette/endpoints.py +0 -130
- prefect/_vendor/starlette/exceptions.py +0 -60
- prefect/_vendor/starlette/formparsers.py +0 -276
- prefect/_vendor/starlette/middleware/__init__.py +0 -17
- prefect/_vendor/starlette/middleware/authentication.py +0 -52
- prefect/_vendor/starlette/middleware/base.py +0 -220
- prefect/_vendor/starlette/middleware/cors.py +0 -176
- prefect/_vendor/starlette/middleware/errors.py +0 -265
- prefect/_vendor/starlette/middleware/exceptions.py +0 -74
- prefect/_vendor/starlette/middleware/gzip.py +0 -113
- prefect/_vendor/starlette/middleware/httpsredirect.py +0 -19
- prefect/_vendor/starlette/middleware/sessions.py +0 -82
- prefect/_vendor/starlette/middleware/trustedhost.py +0 -64
- prefect/_vendor/starlette/middleware/wsgi.py +0 -147
- prefect/_vendor/starlette/py.typed +0 -0
- prefect/_vendor/starlette/requests.py +0 -328
- prefect/_vendor/starlette/responses.py +0 -347
- prefect/_vendor/starlette/routing.py +0 -933
- prefect/_vendor/starlette/schemas.py +0 -154
- prefect/_vendor/starlette/staticfiles.py +0 -248
- prefect/_vendor/starlette/status.py +0 -199
- prefect/_vendor/starlette/templating.py +0 -231
- prefect/_vendor/starlette/testclient.py +0 -804
- prefect/_vendor/starlette/types.py +0 -30
- prefect/_vendor/starlette/websockets.py +0 -193
- prefect/blocks/kubernetes.py +0 -119
- prefect/deprecated/__init__.py +0 -0
- prefect/deprecated/data_documents.py +0 -350
- prefect/deprecated/packaging/__init__.py +0 -12
- prefect/deprecated/packaging/base.py +0 -96
- prefect/deprecated/packaging/docker.py +0 -146
- prefect/deprecated/packaging/file.py +0 -92
- prefect/deprecated/packaging/orion.py +0 -80
- prefect/deprecated/packaging/serializers.py +0 -171
- prefect/events/instrument.py +0 -135
- prefect/infrastructure/container.py +0 -824
- prefect/infrastructure/kubernetes.py +0 -920
- prefect/infrastructure/process.py +0 -289
- prefect/manifests.py +0 -20
- prefect/new_flow_engine.py +0 -449
- prefect/new_task_engine.py +0 -423
- prefect/pydantic/__init__.py +0 -76
- prefect/pydantic/main.py +0 -39
- prefect/software/__init__.py +0 -2
- prefect/software/base.py +0 -50
- prefect/software/conda.py +0 -199
- prefect/software/pip.py +0 -122
- prefect/software/python.py +0 -52
- prefect/task_server.py +0 -322
- prefect_client-2.20.2.dist-info/RECORD +0 -294
- /prefect/{_internal/pydantic/utilities → client/types}/__init__.py +0 -0
- /prefect/{_vendor → concurrency/v1}/__init__.py +0 -0
- {prefect_client-2.20.2.dist-info → prefect_client-3.0.0.dist-info}/LICENSE +0 -0
- {prefect_client-2.20.2.dist-info → prefect_client-3.0.0.dist-info}/top_level.txt +0 -0
@@ -1,480 +0,0 @@
|
|
1
|
-
from enum import Enum
|
2
|
-
from typing import Any, Callable, Dict, Iterable, List, Optional, Set, Union
|
3
|
-
|
4
|
-
from prefect._vendor.fastapi.logger import logger
|
5
|
-
|
6
|
-
from prefect._internal.pydantic import HAS_PYDANTIC_V2
|
7
|
-
|
8
|
-
if HAS_PYDANTIC_V2:
|
9
|
-
from pydantic.v1 import AnyUrl, BaseModel, Field
|
10
|
-
else:
|
11
|
-
from pydantic import AnyUrl, BaseModel, Field
|
12
|
-
|
13
|
-
from typing_extensions import Annotated, Literal
|
14
|
-
from typing_extensions import deprecated as typing_deprecated
|
15
|
-
|
16
|
-
try:
|
17
|
-
import email_validator # type: ignore
|
18
|
-
|
19
|
-
assert email_validator # make autoflake ignore the unused import
|
20
|
-
|
21
|
-
if HAS_PYDANTIC_V2:
|
22
|
-
from pydantic.v1 import EmailStr
|
23
|
-
else:
|
24
|
-
from pydantic import EmailStr
|
25
|
-
|
26
|
-
except ImportError: # pragma: no cover
|
27
|
-
|
28
|
-
class EmailStr(str): # type: ignore
|
29
|
-
@classmethod
|
30
|
-
def __get_validators__(cls) -> Iterable[Callable[..., Any]]:
|
31
|
-
yield cls.validate
|
32
|
-
|
33
|
-
@classmethod
|
34
|
-
def validate(cls, v: Any) -> str:
|
35
|
-
logger.warning(
|
36
|
-
"email-validator not installed, email fields will be treated as str.\n"
|
37
|
-
"To install, run: pip install email-validator"
|
38
|
-
)
|
39
|
-
return str(v)
|
40
|
-
|
41
|
-
|
42
|
-
class Contact(BaseModel):
|
43
|
-
name: Optional[str] = None
|
44
|
-
url: Optional[AnyUrl] = None
|
45
|
-
email: Optional[EmailStr] = None
|
46
|
-
|
47
|
-
class Config:
|
48
|
-
extra = "allow"
|
49
|
-
|
50
|
-
|
51
|
-
class License(BaseModel):
|
52
|
-
name: str
|
53
|
-
identifier: Optional[str] = None
|
54
|
-
url: Optional[AnyUrl] = None
|
55
|
-
|
56
|
-
class Config:
|
57
|
-
extra = "allow"
|
58
|
-
|
59
|
-
|
60
|
-
class Info(BaseModel):
|
61
|
-
title: str
|
62
|
-
summary: Optional[str] = None
|
63
|
-
description: Optional[str] = None
|
64
|
-
termsOfService: Optional[str] = None
|
65
|
-
contact: Optional[Contact] = None
|
66
|
-
license: Optional[License] = None
|
67
|
-
version: str
|
68
|
-
|
69
|
-
class Config:
|
70
|
-
extra = "allow"
|
71
|
-
|
72
|
-
|
73
|
-
class ServerVariable(BaseModel):
|
74
|
-
enum: Annotated[Optional[List[str]], Field(min_items=1)] = None
|
75
|
-
default: str
|
76
|
-
description: Optional[str] = None
|
77
|
-
|
78
|
-
class Config:
|
79
|
-
extra = "allow"
|
80
|
-
|
81
|
-
|
82
|
-
class Server(BaseModel):
|
83
|
-
url: Union[AnyUrl, str]
|
84
|
-
description: Optional[str] = None
|
85
|
-
variables: Optional[Dict[str, ServerVariable]] = None
|
86
|
-
|
87
|
-
class Config:
|
88
|
-
extra = "allow"
|
89
|
-
|
90
|
-
|
91
|
-
class Reference(BaseModel):
|
92
|
-
ref: str = Field(alias="$ref")
|
93
|
-
|
94
|
-
|
95
|
-
class Discriminator(BaseModel):
|
96
|
-
propertyName: str
|
97
|
-
mapping: Optional[Dict[str, str]] = None
|
98
|
-
|
99
|
-
|
100
|
-
class XML(BaseModel):
|
101
|
-
name: Optional[str] = None
|
102
|
-
namespace: Optional[str] = None
|
103
|
-
prefix: Optional[str] = None
|
104
|
-
attribute: Optional[bool] = None
|
105
|
-
wrapped: Optional[bool] = None
|
106
|
-
|
107
|
-
class Config:
|
108
|
-
extra = "allow"
|
109
|
-
|
110
|
-
|
111
|
-
class ExternalDocumentation(BaseModel):
|
112
|
-
description: Optional[str] = None
|
113
|
-
url: AnyUrl
|
114
|
-
|
115
|
-
class Config:
|
116
|
-
extra = "allow"
|
117
|
-
|
118
|
-
|
119
|
-
class Schema(BaseModel):
|
120
|
-
# Ref: JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-core.html#name-the-json-schema-core-vocabu
|
121
|
-
# Core Vocabulary
|
122
|
-
schema_: Optional[str] = Field(default=None, alias="$schema")
|
123
|
-
vocabulary: Optional[str] = Field(default=None, alias="$vocabulary")
|
124
|
-
id: Optional[str] = Field(default=None, alias="$id")
|
125
|
-
anchor: Optional[str] = Field(default=None, alias="$anchor")
|
126
|
-
dynamicAnchor: Optional[str] = Field(default=None, alias="$dynamicAnchor")
|
127
|
-
ref: Optional[str] = Field(default=None, alias="$ref")
|
128
|
-
dynamicRef: Optional[str] = Field(default=None, alias="$dynamicRef")
|
129
|
-
defs: Optional[Dict[str, "SchemaOrBool"]] = Field(default=None, alias="$defs")
|
130
|
-
comment: Optional[str] = Field(default=None, alias="$comment")
|
131
|
-
# Ref: JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-core.html#name-a-vocabulary-for-applying-s
|
132
|
-
# A Vocabulary for Applying Subschemas
|
133
|
-
allOf: Optional[List["SchemaOrBool"]] = None
|
134
|
-
anyOf: Optional[List["SchemaOrBool"]] = None
|
135
|
-
oneOf: Optional[List["SchemaOrBool"]] = None
|
136
|
-
not_: Optional["SchemaOrBool"] = Field(default=None, alias="not")
|
137
|
-
if_: Optional["SchemaOrBool"] = Field(default=None, alias="if")
|
138
|
-
then: Optional["SchemaOrBool"] = None
|
139
|
-
else_: Optional["SchemaOrBool"] = Field(default=None, alias="else")
|
140
|
-
dependentSchemas: Optional[Dict[str, "SchemaOrBool"]] = None
|
141
|
-
prefixItems: Optional[List["SchemaOrBool"]] = None
|
142
|
-
# TODO: uncomment and remove below when deprecating Pydantic v1
|
143
|
-
# It generales a list of schemas for tuples, before prefixItems was available
|
144
|
-
# items: Optional["SchemaOrBool"] = None
|
145
|
-
items: Optional[Union["SchemaOrBool", List["SchemaOrBool"]]] = None
|
146
|
-
contains: Optional["SchemaOrBool"] = None
|
147
|
-
properties: Optional[Dict[str, "SchemaOrBool"]] = None
|
148
|
-
patternProperties: Optional[Dict[str, "SchemaOrBool"]] = None
|
149
|
-
additionalProperties: Optional["SchemaOrBool"] = None
|
150
|
-
propertyNames: Optional["SchemaOrBool"] = None
|
151
|
-
unevaluatedItems: Optional["SchemaOrBool"] = None
|
152
|
-
unevaluatedProperties: Optional["SchemaOrBool"] = None
|
153
|
-
# Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-structural
|
154
|
-
# A Vocabulary for Structural Validation
|
155
|
-
type: Optional[str] = None
|
156
|
-
enum: Optional[List[Any]] = None
|
157
|
-
const: Optional[Any] = None
|
158
|
-
multipleOf: Optional[float] = Field(default=None, gt=0)
|
159
|
-
maximum: Optional[float] = None
|
160
|
-
exclusiveMaximum: Optional[float] = None
|
161
|
-
minimum: Optional[float] = None
|
162
|
-
exclusiveMinimum: Optional[float] = None
|
163
|
-
maxLength: Optional[int] = Field(default=None, ge=0)
|
164
|
-
minLength: Optional[int] = Field(default=None, ge=0)
|
165
|
-
pattern: Optional[str] = None
|
166
|
-
maxItems: Optional[int] = Field(default=None, ge=0)
|
167
|
-
minItems: Optional[int] = Field(default=None, ge=0)
|
168
|
-
uniqueItems: Optional[bool] = None
|
169
|
-
maxContains: Optional[int] = Field(default=None, ge=0)
|
170
|
-
minContains: Optional[int] = Field(default=None, ge=0)
|
171
|
-
maxProperties: Optional[int] = Field(default=None, ge=0)
|
172
|
-
minProperties: Optional[int] = Field(default=None, ge=0)
|
173
|
-
required: Optional[List[str]] = None
|
174
|
-
dependentRequired: Optional[Dict[str, Set[str]]] = None
|
175
|
-
# Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-vocabularies-for-semantic-c
|
176
|
-
# Vocabularies for Semantic Content With "format"
|
177
|
-
format: Optional[str] = None
|
178
|
-
# Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-the-conten
|
179
|
-
# A Vocabulary for the Contents of String-Encoded Data
|
180
|
-
contentEncoding: Optional[str] = None
|
181
|
-
contentMediaType: Optional[str] = None
|
182
|
-
contentSchema: Optional["SchemaOrBool"] = None
|
183
|
-
# Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-basic-meta
|
184
|
-
# A Vocabulary for Basic Meta-Data Annotations
|
185
|
-
title: Optional[str] = None
|
186
|
-
description: Optional[str] = None
|
187
|
-
default: Optional[Any] = None
|
188
|
-
deprecated: Optional[bool] = None
|
189
|
-
readOnly: Optional[bool] = None
|
190
|
-
writeOnly: Optional[bool] = None
|
191
|
-
examples: Optional[List[Any]] = None
|
192
|
-
# Ref: OpenAPI 3.1.0: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object
|
193
|
-
# Schema Object
|
194
|
-
discriminator: Optional[Discriminator] = None
|
195
|
-
xml: Optional[XML] = None
|
196
|
-
externalDocs: Optional[ExternalDocumentation] = None
|
197
|
-
example: Annotated[
|
198
|
-
Optional[Any],
|
199
|
-
typing_deprecated(
|
200
|
-
"Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
|
201
|
-
"although still supported. Use examples instead."
|
202
|
-
),
|
203
|
-
] = None
|
204
|
-
|
205
|
-
class Config:
|
206
|
-
extra: str = "allow"
|
207
|
-
|
208
|
-
|
209
|
-
# Ref: https://json-schema.org/draft/2020-12/json-schema-core.html#name-json-schema-documents
|
210
|
-
# A JSON Schema MUST be an object or a boolean.
|
211
|
-
SchemaOrBool = Union[Schema, bool]
|
212
|
-
|
213
|
-
|
214
|
-
class Example(BaseModel):
|
215
|
-
summary: Optional[str] = None
|
216
|
-
description: Optional[str] = None
|
217
|
-
value: Optional[Any] = None
|
218
|
-
externalValue: Optional[AnyUrl] = None
|
219
|
-
|
220
|
-
class Config:
|
221
|
-
extra = "allow"
|
222
|
-
|
223
|
-
|
224
|
-
class ParameterInType(Enum):
|
225
|
-
query = "query"
|
226
|
-
header = "header"
|
227
|
-
path = "path"
|
228
|
-
cookie = "cookie"
|
229
|
-
|
230
|
-
|
231
|
-
class Encoding(BaseModel):
|
232
|
-
contentType: Optional[str] = None
|
233
|
-
headers: Optional[Dict[str, Union["Header", Reference]]] = None
|
234
|
-
style: Optional[str] = None
|
235
|
-
explode: Optional[bool] = None
|
236
|
-
allowReserved: Optional[bool] = None
|
237
|
-
|
238
|
-
class Config:
|
239
|
-
extra = "allow"
|
240
|
-
|
241
|
-
|
242
|
-
class MediaType(BaseModel):
|
243
|
-
schema_: Optional[Union[Schema, Reference]] = Field(default=None, alias="schema")
|
244
|
-
example: Optional[Any] = None
|
245
|
-
examples: Optional[Dict[str, Union[Example, Reference]]] = None
|
246
|
-
encoding: Optional[Dict[str, Encoding]] = None
|
247
|
-
|
248
|
-
class Config:
|
249
|
-
extra = "allow"
|
250
|
-
|
251
|
-
|
252
|
-
class ParameterBase(BaseModel):
|
253
|
-
description: Optional[str] = None
|
254
|
-
required: Optional[bool] = None
|
255
|
-
deprecated: Optional[bool] = None
|
256
|
-
# Serialization rules for simple scenarios
|
257
|
-
style: Optional[str] = None
|
258
|
-
explode: Optional[bool] = None
|
259
|
-
allowReserved: Optional[bool] = None
|
260
|
-
schema_: Optional[Union[Schema, Reference]] = Field(default=None, alias="schema")
|
261
|
-
example: Optional[Any] = None
|
262
|
-
examples: Optional[Dict[str, Union[Example, Reference]]] = None
|
263
|
-
# Serialization rules for more complex scenarios
|
264
|
-
content: Optional[Dict[str, MediaType]] = None
|
265
|
-
|
266
|
-
class Config:
|
267
|
-
extra = "allow"
|
268
|
-
|
269
|
-
|
270
|
-
class Parameter(ParameterBase):
|
271
|
-
name: str
|
272
|
-
in_: ParameterInType = Field(alias="in")
|
273
|
-
|
274
|
-
|
275
|
-
class Header(ParameterBase):
|
276
|
-
pass
|
277
|
-
|
278
|
-
|
279
|
-
class RequestBody(BaseModel):
|
280
|
-
description: Optional[str] = None
|
281
|
-
content: Dict[str, MediaType]
|
282
|
-
required: Optional[bool] = None
|
283
|
-
|
284
|
-
class Config:
|
285
|
-
extra = "allow"
|
286
|
-
|
287
|
-
|
288
|
-
class Link(BaseModel):
|
289
|
-
operationRef: Optional[str] = None
|
290
|
-
operationId: Optional[str] = None
|
291
|
-
parameters: Optional[Dict[str, Union[Any, str]]] = None
|
292
|
-
requestBody: Optional[Union[Any, str]] = None
|
293
|
-
description: Optional[str] = None
|
294
|
-
server: Optional[Server] = None
|
295
|
-
|
296
|
-
class Config:
|
297
|
-
extra = "allow"
|
298
|
-
|
299
|
-
|
300
|
-
class Response(BaseModel):
|
301
|
-
description: str
|
302
|
-
headers: Optional[Dict[str, Union[Header, Reference]]] = None
|
303
|
-
content: Optional[Dict[str, MediaType]] = None
|
304
|
-
links: Optional[Dict[str, Union[Link, Reference]]] = None
|
305
|
-
|
306
|
-
class Config:
|
307
|
-
extra = "allow"
|
308
|
-
|
309
|
-
|
310
|
-
class Operation(BaseModel):
|
311
|
-
tags: Optional[List[str]] = None
|
312
|
-
summary: Optional[str] = None
|
313
|
-
description: Optional[str] = None
|
314
|
-
externalDocs: Optional[ExternalDocumentation] = None
|
315
|
-
operationId: Optional[str] = None
|
316
|
-
parameters: Optional[List[Union[Parameter, Reference]]] = None
|
317
|
-
requestBody: Optional[Union[RequestBody, Reference]] = None
|
318
|
-
# Using Any for Specification Extensions
|
319
|
-
responses: Optional[Dict[str, Union[Response, Any]]] = None
|
320
|
-
callbacks: Optional[Dict[str, Union[Dict[str, "PathItem"], Reference]]] = None
|
321
|
-
deprecated: Optional[bool] = None
|
322
|
-
security: Optional[List[Dict[str, List[str]]]] = None
|
323
|
-
servers: Optional[List[Server]] = None
|
324
|
-
|
325
|
-
class Config:
|
326
|
-
extra = "allow"
|
327
|
-
|
328
|
-
|
329
|
-
class PathItem(BaseModel):
|
330
|
-
ref: Optional[str] = Field(default=None, alias="$ref")
|
331
|
-
summary: Optional[str] = None
|
332
|
-
description: Optional[str] = None
|
333
|
-
get: Optional[Operation] = None
|
334
|
-
put: Optional[Operation] = None
|
335
|
-
post: Optional[Operation] = None
|
336
|
-
delete: Optional[Operation] = None
|
337
|
-
options: Optional[Operation] = None
|
338
|
-
head: Optional[Operation] = None
|
339
|
-
patch: Optional[Operation] = None
|
340
|
-
trace: Optional[Operation] = None
|
341
|
-
servers: Optional[List[Server]] = None
|
342
|
-
parameters: Optional[List[Union[Parameter, Reference]]] = None
|
343
|
-
|
344
|
-
class Config:
|
345
|
-
extra = "allow"
|
346
|
-
|
347
|
-
|
348
|
-
class SecuritySchemeType(Enum):
|
349
|
-
apiKey = "apiKey"
|
350
|
-
http = "http"
|
351
|
-
oauth2 = "oauth2"
|
352
|
-
openIdConnect = "openIdConnect"
|
353
|
-
|
354
|
-
|
355
|
-
class SecurityBase(BaseModel):
|
356
|
-
type_: SecuritySchemeType = Field(alias="type")
|
357
|
-
description: Optional[str] = None
|
358
|
-
|
359
|
-
class Config:
|
360
|
-
extra = "allow"
|
361
|
-
|
362
|
-
|
363
|
-
class APIKeyIn(Enum):
|
364
|
-
query = "query"
|
365
|
-
header = "header"
|
366
|
-
cookie = "cookie"
|
367
|
-
|
368
|
-
|
369
|
-
class APIKey(SecurityBase):
|
370
|
-
type_: SecuritySchemeType = Field(default=SecuritySchemeType.apiKey, alias="type")
|
371
|
-
in_: APIKeyIn = Field(alias="in")
|
372
|
-
name: str
|
373
|
-
|
374
|
-
|
375
|
-
class HTTPBase(SecurityBase):
|
376
|
-
type_: SecuritySchemeType = Field(default=SecuritySchemeType.http, alias="type")
|
377
|
-
scheme: str
|
378
|
-
|
379
|
-
|
380
|
-
class HTTPBearer(HTTPBase):
|
381
|
-
scheme: Literal["bearer"] = "bearer"
|
382
|
-
bearerFormat: Optional[str] = None
|
383
|
-
|
384
|
-
|
385
|
-
class OAuthFlow(BaseModel):
|
386
|
-
refreshUrl: Optional[str] = None
|
387
|
-
scopes: Dict[str, str] = {}
|
388
|
-
|
389
|
-
class Config:
|
390
|
-
extra = "allow"
|
391
|
-
|
392
|
-
|
393
|
-
class OAuthFlowImplicit(OAuthFlow):
|
394
|
-
authorizationUrl: str
|
395
|
-
|
396
|
-
|
397
|
-
class OAuthFlowPassword(OAuthFlow):
|
398
|
-
tokenUrl: str
|
399
|
-
|
400
|
-
|
401
|
-
class OAuthFlowClientCredentials(OAuthFlow):
|
402
|
-
tokenUrl: str
|
403
|
-
|
404
|
-
|
405
|
-
class OAuthFlowAuthorizationCode(OAuthFlow):
|
406
|
-
authorizationUrl: str
|
407
|
-
tokenUrl: str
|
408
|
-
|
409
|
-
|
410
|
-
class OAuthFlows(BaseModel):
|
411
|
-
implicit: Optional[OAuthFlowImplicit] = None
|
412
|
-
password: Optional[OAuthFlowPassword] = None
|
413
|
-
clientCredentials: Optional[OAuthFlowClientCredentials] = None
|
414
|
-
authorizationCode: Optional[OAuthFlowAuthorizationCode] = None
|
415
|
-
|
416
|
-
class Config:
|
417
|
-
extra = "allow"
|
418
|
-
|
419
|
-
|
420
|
-
class OAuth2(SecurityBase):
|
421
|
-
type_: SecuritySchemeType = Field(default=SecuritySchemeType.oauth2, alias="type")
|
422
|
-
flows: OAuthFlows
|
423
|
-
|
424
|
-
|
425
|
-
class OpenIdConnect(SecurityBase):
|
426
|
-
type_: SecuritySchemeType = Field(
|
427
|
-
default=SecuritySchemeType.openIdConnect, alias="type"
|
428
|
-
)
|
429
|
-
openIdConnectUrl: str
|
430
|
-
|
431
|
-
|
432
|
-
SecurityScheme = Union[APIKey, HTTPBase, OAuth2, OpenIdConnect, HTTPBearer]
|
433
|
-
|
434
|
-
|
435
|
-
class Components(BaseModel):
|
436
|
-
schemas: Optional[Dict[str, Union[Schema, Reference]]] = None
|
437
|
-
responses: Optional[Dict[str, Union[Response, Reference]]] = None
|
438
|
-
parameters: Optional[Dict[str, Union[Parameter, Reference]]] = None
|
439
|
-
examples: Optional[Dict[str, Union[Example, Reference]]] = None
|
440
|
-
requestBodies: Optional[Dict[str, Union[RequestBody, Reference]]] = None
|
441
|
-
headers: Optional[Dict[str, Union[Header, Reference]]] = None
|
442
|
-
securitySchemes: Optional[Dict[str, Union[SecurityScheme, Reference]]] = None
|
443
|
-
links: Optional[Dict[str, Union[Link, Reference]]] = None
|
444
|
-
# Using Any for Specification Extensions
|
445
|
-
callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference, Any]]] = None
|
446
|
-
pathItems: Optional[Dict[str, Union[PathItem, Reference]]] = None
|
447
|
-
|
448
|
-
class Config:
|
449
|
-
extra = "allow"
|
450
|
-
|
451
|
-
|
452
|
-
class Tag(BaseModel):
|
453
|
-
name: str
|
454
|
-
description: Optional[str] = None
|
455
|
-
externalDocs: Optional[ExternalDocumentation] = None
|
456
|
-
|
457
|
-
class Config:
|
458
|
-
extra = "allow"
|
459
|
-
|
460
|
-
|
461
|
-
class OpenAPI(BaseModel):
|
462
|
-
openapi: str
|
463
|
-
info: Info
|
464
|
-
jsonSchemaDialect: Optional[str] = None
|
465
|
-
servers: Optional[List[Server]] = None
|
466
|
-
# Using Any for Specification Extensions
|
467
|
-
paths: Optional[Dict[str, Union[PathItem, Any]]] = None
|
468
|
-
webhooks: Optional[Dict[str, Union[PathItem, Reference]]] = None
|
469
|
-
components: Optional[Components] = None
|
470
|
-
security: Optional[List[Dict[str, List[str]]]] = None
|
471
|
-
tags: Optional[List[Tag]] = None
|
472
|
-
externalDocs: Optional[ExternalDocumentation] = None
|
473
|
-
|
474
|
-
class Config:
|
475
|
-
extra = "allow"
|
476
|
-
|
477
|
-
|
478
|
-
Schema.update_forward_refs()
|
479
|
-
Operation.update_forward_refs()
|
480
|
-
Encoding.update_forward_refs()
|