Skip to content

Commit 4862ec1

Browse files
author
octavia-squidington-iii
committed
Auto-fix lint and format issues
1 parent 11382f9 commit 4862ec1

File tree

1 file changed

+42
-70
lines changed

1 file changed

+42
-70
lines changed

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

Lines changed: 42 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -609,9 +609,7 @@ class OAuthAuthenticator(BaseModel):
609609
scopes: Optional[List[str]] = Field(
610610
None,
611611
description="List of scopes that should be granted to the access token.",
612-
examples=[
613-
["crm.list.read", "crm.objects.contacts.read", "crm.schema.contacts.read"]
614-
],
612+
examples=[["crm.list.read", "crm.objects.contacts.read", "crm.schema.contacts.read"]],
615613
title="Scopes",
616614
)
617615
token_expiry_date: Optional[str] = Field(
@@ -1080,28 +1078,24 @@ class OAuthConfigSpecification(BaseModel):
10801078
class Config:
10811079
extra = Extra.allow
10821080

1083-
oauth_user_input_from_connector_config_specification: Optional[Dict[str, Any]] = (
1084-
Field(
1085-
None,
1086-
description="OAuth specific blob. This is a Json Schema used to validate Json configurations used as input to OAuth.\nMust be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification\nusing special annotation 'path_in_connector_config'.\nThese are input values the user is entering through the UI to authenticate to the connector, that might also shared\nas inputs for syncing data via the connector.\nExamples:\nif no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[]\nif connector values such as 'app_id' inside the top level are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['app_id']\n }\n }\nif connector values such as 'info.app_id' nested inside another object are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['info', 'app_id']\n }\n }",
1087-
examples=[
1088-
{"app_id": {"type": "string", "path_in_connector_config": ["app_id"]}},
1089-
{
1090-
"app_id": {
1091-
"type": "string",
1092-
"path_in_connector_config": ["info", "app_id"],
1093-
}
1094-
},
1095-
],
1096-
title="OAuth user input",
1097-
)
1081+
oauth_user_input_from_connector_config_specification: Optional[Dict[str, Any]] = Field(
1082+
None,
1083+
description="OAuth specific blob. This is a Json Schema used to validate Json configurations used as input to OAuth.\nMust be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification\nusing special annotation 'path_in_connector_config'.\nThese are input values the user is entering through the UI to authenticate to the connector, that might also shared\nas inputs for syncing data via the connector.\nExamples:\nif no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[]\nif connector values such as 'app_id' inside the top level are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['app_id']\n }\n }\nif connector values such as 'info.app_id' nested inside another object are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['info', 'app_id']\n }\n }",
1084+
examples=[
1085+
{"app_id": {"type": "string", "path_in_connector_config": ["app_id"]}},
1086+
{
1087+
"app_id": {
1088+
"type": "string",
1089+
"path_in_connector_config": ["info", "app_id"],
1090+
}
1091+
},
1092+
],
1093+
title="OAuth user input",
10981094
)
1099-
oauth_connector_input_specification: Optional[OauthConnectorInputSpecification] = (
1100-
Field(
1101-
None,
1102-
description='The DeclarativeOAuth specific blob.\nPertains to the fields defined by the connector relating to the OAuth flow.\n\nInterpolation capabilities:\n- The variables placeholders are declared as `{{my_var}}`.\n- The nested resolution variables like `{{ {{my_nested_var}} }}` is allowed as well.\n\n- The allowed interpolation context is:\n + base64Encoder - encode to `base64`, {{ {{my_var_a}}:{{my_var_b}} | base64Encoder }}\n + base64Decorer - decode from `base64` encoded string, {{ {{my_string_variable_or_string_value}} | base64Decoder }}\n + urlEncoder - encode the input string to URL-like format, {{ https://test.host.com/endpoint | urlEncoder}}\n + urlDecorer - decode the input url-encoded string into text format, {{ urlDecoder:https%3A%2F%2Fairbyte.io | urlDecoder}}\n + codeChallengeS256 - get the `codeChallenge` encoded value to provide additional data-provider specific authorisation values, {{ {{state_value}} | codeChallengeS256 }}\n\nExamples:\n - The TikTok Marketing DeclarativeOAuth spec:\n {\n "oauth_connector_input_specification": {\n "type": "object",\n "additionalProperties": false,\n "properties": {\n "consent_url": "https://ads.tiktok.com/marketing_api/auth?{{client_id_key}}={{client_id_value}}&{{redirect_uri_key}}={{ {{redirect_uri_value}} | urlEncoder}}&{{state_key}}={{state_value}}",\n "access_token_url": "https://business-api.tiktok.com/open_api/v1.3/oauth2/access_token/",\n "access_token_params": {\n "{{ auth_code_key }}": "{{ auth_code_value }}",\n "{{ client_id_key }}": "{{ client_id_value }}",\n "{{ client_secret_key }}": "{{ client_secret_value }}"\n },\n "access_token_headers": {\n "Content-Type": "application/json",\n "Accept": "application/json"\n },\n "extract_output": ["data.access_token"],\n "client_id_key": "app_id",\n "client_secret_key": "secret",\n "auth_code_key": "auth_code"\n }\n }\n }',
1103-
title="DeclarativeOAuth Connector Specification",
1104-
)
1095+
oauth_connector_input_specification: Optional[OauthConnectorInputSpecification] = Field(
1096+
None,
1097+
description='The DeclarativeOAuth specific blob.\nPertains to the fields defined by the connector relating to the OAuth flow.\n\nInterpolation capabilities:\n- The variables placeholders are declared as `{{my_var}}`.\n- The nested resolution variables like `{{ {{my_nested_var}} }}` is allowed as well.\n\n- The allowed interpolation context is:\n + base64Encoder - encode to `base64`, {{ {{my_var_a}}:{{my_var_b}} | base64Encoder }}\n + base64Decorer - decode from `base64` encoded string, {{ {{my_string_variable_or_string_value}} | base64Decoder }}\n + urlEncoder - encode the input string to URL-like format, {{ https://test.host.com/endpoint | urlEncoder}}\n + urlDecorer - decode the input url-encoded string into text format, {{ urlDecoder:https%3A%2F%2Fairbyte.io | urlDecoder}}\n + codeChallengeS256 - get the `codeChallenge` encoded value to provide additional data-provider specific authorisation values, {{ {{state_value}} | codeChallengeS256 }}\n\nExamples:\n - The TikTok Marketing DeclarativeOAuth spec:\n {\n "oauth_connector_input_specification": {\n "type": "object",\n "additionalProperties": false,\n "properties": {\n "consent_url": "https://ads.tiktok.com/marketing_api/auth?{{client_id_key}}={{client_id_value}}&{{redirect_uri_key}}={{ {{redirect_uri_value}} | urlEncoder}}&{{state_key}}={{state_value}}",\n "access_token_url": "https://business-api.tiktok.com/open_api/v1.3/oauth2/access_token/",\n "access_token_params": {\n "{{ auth_code_key }}": "{{ auth_code_value }}",\n "{{ client_id_key }}": "{{ client_id_value }}",\n "{{ client_secret_key }}": "{{ client_secret_value }}"\n },\n "access_token_headers": {\n "Content-Type": "application/json",\n "Accept": "application/json"\n },\n "extract_output": ["data.access_token"],\n "client_id_key": "app_id",\n "client_secret_key": "secret",\n "auth_code_key": "auth_code"\n }\n }\n }',
1098+
title="DeclarativeOAuth Connector Specification",
11051099
)
11061100
complete_oauth_output_specification: Optional[Dict[str, Any]] = Field(
11071101
None,
@@ -1119,9 +1113,7 @@ class Config:
11191113
complete_oauth_server_input_specification: Optional[Dict[str, Any]] = Field(
11201114
None,
11211115
description="OAuth specific blob. This is a Json Schema used to validate Json configurations persisted as Airbyte Server configurations.\nMust be a valid non-nested JSON describing additional fields configured by the Airbyte Instance or Workspace Admins to be used by the\nserver when completing an OAuth flow (typically exchanging an auth code for refresh token).\nExamples:\n complete_oauth_server_input_specification={\n client_id: {\n type: string\n },\n client_secret: {\n type: string\n }\n }",
1122-
examples=[
1123-
{"client_id": {"type": "string"}, "client_secret": {"type": "string"}}
1124-
],
1116+
examples=[{"client_id": {"type": "string"}, "client_secret": {"type": "string"}}],
11251117
title="OAuth input specification",
11261118
)
11271119
complete_oauth_server_output_specification: Optional[Dict[str, Any]] = Field(
@@ -1774,9 +1766,7 @@ class RecordSelector(BaseModel):
17741766
description="Responsible for filtering records to be emitted by the Source.",
17751767
title="Record Filter",
17761768
)
1777-
schema_normalization: Optional[
1778-
Union[SchemaNormalization, CustomSchemaNormalization]
1779-
] = Field(
1769+
schema_normalization: Optional[Union[SchemaNormalization, CustomSchemaNormalization]] = Field(
17801770
SchemaNormalization.None_,
17811771
description="Responsible for normalization according to the schema.",
17821772
title="Schema Normalization",
@@ -1975,12 +1965,12 @@ class Config:
19751965
extra = Extra.allow
19761966

19771967
type: Literal["DeclarativeStream"]
1978-
retriever: Union[
1979-
AsyncRetriever, CustomRetriever, SimpleRetriever, StateDelegatingRetriever
1980-
] = Field(
1981-
...,
1982-
description="Component used to coordinate how records are extracted across stream slices and request pages.",
1983-
title="Retriever",
1968+
retriever: Union[AsyncRetriever, CustomRetriever, SimpleRetriever, StateDelegatingRetriever] = (
1969+
Field(
1970+
...,
1971+
description="Component used to coordinate how records are extracted across stream slices and request pages.",
1972+
title="Retriever",
1973+
)
19841974
)
19851975
incremental_sync: Optional[
19861976
Union[CustomIncrementalSync, DatetimeBasedCursor, IncrementingCountCursor]
@@ -1989,9 +1979,7 @@ class Config:
19891979
description="Component used to fetch data incrementally based on a time field in the data.",
19901980
title="Incremental Sync",
19911981
)
1992-
name: Optional[str] = Field(
1993-
"", description="The stream name.", example=["Users"], title="Name"
1994-
)
1982+
name: Optional[str] = Field("", description="The stream name.", example=["Users"], title="Name")
19951983
primary_key: Optional[PrimaryKey] = Field(
19961984
"", description="The primary key of the stream.", title="Primary Key"
19971985
)
@@ -2252,19 +2240,15 @@ class StateDelegatingRetriever(BaseModel):
22522240
False,
22532241
description="If set to true, a min and max limitation for start and end datetime will be ignored for full refresh retriever.",
22542242
)
2255-
full_refresh_retriever: Union[AsyncRetriever, CustomRetriever, SimpleRetriever] = (
2256-
Field(
2257-
...,
2258-
description="Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided.",
2259-
title="Retriever",
2260-
)
2243+
full_refresh_retriever: Union[AsyncRetriever, CustomRetriever, SimpleRetriever] = Field(
2244+
...,
2245+
description="Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided.",
2246+
title="Retriever",
22612247
)
2262-
incremental_retriever: Union[AsyncRetriever, CustomRetriever, SimpleRetriever] = (
2263-
Field(
2264-
...,
2265-
description="Component used to coordinate how records are extracted across stream slices and request pages when the state provided.",
2266-
title="Retriever",
2267-
)
2248+
incremental_retriever: Union[AsyncRetriever, CustomRetriever, SimpleRetriever] = Field(
2249+
...,
2250+
description="Component used to coordinate how records are extracted across stream slices and request pages when the state provided.",
2251+
title="Retriever",
22682252
)
22692253
parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
22702254

@@ -2292,11 +2276,7 @@ class SimpleRetriever(BaseModel):
22922276
CustomPartitionRouter,
22932277
ListPartitionRouter,
22942278
SubstreamPartitionRouter,
2295-
List[
2296-
Union[
2297-
CustomPartitionRouter, ListPartitionRouter, SubstreamPartitionRouter
2298-
]
2299-
],
2279+
List[Union[CustomPartitionRouter, ListPartitionRouter, SubstreamPartitionRouter]],
23002280
]
23012281
] = Field(
23022282
[],
@@ -2340,9 +2320,7 @@ class AsyncRetriever(BaseModel):
23402320
)
23412321
download_extractor: Optional[
23422322
Union[CustomRecordExtractor, DpathExtractor, ResponseToFileExtractor]
2343-
] = Field(
2344-
None, description="Responsible for fetching the records from provided urls."
2345-
)
2323+
] = Field(None, description="Responsible for fetching the records from provided urls.")
23462324
creation_requester: Union[CustomRequester, HttpRequester] = Field(
23472325
...,
23482326
description="Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job.",
@@ -2376,11 +2354,7 @@ class AsyncRetriever(BaseModel):
23762354
CustomPartitionRouter,
23772355
ListPartitionRouter,
23782356
SubstreamPartitionRouter,
2379-
List[
2380-
Union[
2381-
CustomPartitionRouter, ListPartitionRouter, SubstreamPartitionRouter
2382-
]
2383-
],
2357+
List[Union[CustomPartitionRouter, ListPartitionRouter, SubstreamPartitionRouter]],
23842358
]
23852359
] = Field(
23862360
[],
@@ -2448,12 +2422,10 @@ class DynamicDeclarativeStream(BaseModel):
24482422
stream_template: DeclarativeStream = Field(
24492423
..., description="Reference to the stream template.", title="Stream Template"
24502424
)
2451-
components_resolver: Union[HttpComponentsResolver, ConfigComponentsResolver] = (
2452-
Field(
2453-
...,
2454-
description="Component resolve and populates stream templates with components values.",
2455-
title="Components Resolver",
2456-
)
2425+
components_resolver: Union[HttpComponentsResolver, ConfigComponentsResolver] = Field(
2426+
...,
2427+
description="Component resolve and populates stream templates with components values.",
2428+
title="Components Resolver",
24572429
)
24582430

24592431

0 commit comments

Comments
 (0)