Skip to content

Commit 5c0581a

Browse files
author
octavia-squidington-iii
committed
Auto-fix lint and format issues
1 parent 1a41386 commit 5c0581a

File tree

4 files changed

+56
-76
lines changed

4 files changed

+56
-76
lines changed

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

Lines changed: 41 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -618,9 +618,7 @@ class OAuthAuthenticator(BaseModel):
618618
scopes: Optional[List[str]] = Field(
619619
None,
620620
description="List of scopes that should be granted to the access token.",
621-
examples=[
622-
["crm.list.read", "crm.objects.contacts.read", "crm.schema.contacts.read"]
623-
],
621+
examples=[["crm.list.read", "crm.objects.contacts.read", "crm.schema.contacts.read"]],
624622
title="Scopes",
625623
)
626624
token_expiry_date: Optional[str] = Field(
@@ -1126,28 +1124,24 @@ class OAuthConfigSpecification(BaseModel):
11261124
class Config:
11271125
extra = Extra.allow
11281126

1129-
oauth_user_input_from_connector_config_specification: Optional[Dict[str, Any]] = (
1130-
Field(
1131-
None,
1132-
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 }",
1133-
examples=[
1134-
{"app_id": {"type": "string", "path_in_connector_config": ["app_id"]}},
1135-
{
1136-
"app_id": {
1137-
"type": "string",
1138-
"path_in_connector_config": ["info", "app_id"],
1139-
}
1140-
},
1141-
],
1142-
title="OAuth user input",
1143-
)
1127+
oauth_user_input_from_connector_config_specification: Optional[Dict[str, Any]] = Field(
1128+
None,
1129+
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 }",
1130+
examples=[
1131+
{"app_id": {"type": "string", "path_in_connector_config": ["app_id"]}},
1132+
{
1133+
"app_id": {
1134+
"type": "string",
1135+
"path_in_connector_config": ["info", "app_id"],
1136+
}
1137+
},
1138+
],
1139+
title="OAuth user input",
11441140
)
1145-
oauth_connector_input_specification: Optional[OauthConnectorInputSpecification] = (
1146-
Field(
1147-
None,
1148-
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 }',
1149-
title="DeclarativeOAuth Connector Specification",
1150-
)
1141+
oauth_connector_input_specification: Optional[OauthConnectorInputSpecification] = Field(
1142+
None,
1143+
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 }',
1144+
title="DeclarativeOAuth Connector Specification",
11511145
)
11521146
complete_oauth_output_specification: Optional[Dict[str, Any]] = Field(
11531147
None,
@@ -1165,9 +1159,7 @@ class Config:
11651159
complete_oauth_server_input_specification: Optional[Dict[str, Any]] = Field(
11661160
None,
11671161
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 }",
1168-
examples=[
1169-
{"client_id": {"type": "string"}, "client_secret": {"type": "string"}}
1170-
],
1162+
examples=[{"client_id": {"type": "string"}, "client_secret": {"type": "string"}}],
11711163
title="OAuth input specification",
11721164
)
11731165
complete_oauth_server_output_specification: Optional[Dict[str, Any]] = Field(
@@ -1498,9 +1490,7 @@ class StreamConfig(BaseModel):
14981490
examples=[["data"], ["data", "streams"], ["data", "{{ parameters.name }}"]],
14991491
title="Configs Pointer",
15001492
)
1501-
default_values: Optional[List] = Field(
1502-
None, description="placeholder", title="Default Values"
1503-
)
1493+
default_values: Optional[List] = Field(None, description="placeholder", title="Default Values")
15041494
parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
15051495

15061496

@@ -1891,17 +1881,13 @@ class ListPartitionRouter(BaseModel):
18911881

18921882
class RecordSelector(BaseModel):
18931883
type: Literal["RecordSelector"]
1894-
extractor: Union[
1895-
DpathExtractor, CustomRecordExtractor
1896-
]
1884+
extractor: Union[DpathExtractor, CustomRecordExtractor]
18971885
record_filter: Optional[Union[RecordFilter, CustomRecordFilter]] = Field(
18981886
None,
18991887
description="Responsible for filtering records to be emitted by the Source.",
19001888
title="Record Filter",
19011889
)
1902-
schema_normalization: Optional[
1903-
Union[SchemaNormalization, CustomSchemaNormalization]
1904-
] = Field(
1890+
schema_normalization: Optional[Union[SchemaNormalization, CustomSchemaNormalization]] = Field(
19051891
None,
19061892
description="Responsible for normalization according to the schema.",
19071893
title="Schema Normalization",
@@ -2147,9 +2133,7 @@ class Config:
21472133
extra = Extra.allow
21482134

21492135
type: Literal["DeclarativeStream"]
2150-
name: Optional[str] = Field(
2151-
"", description="The stream name.", example=["Users"], title="Name"
2152-
)
2136+
name: Optional[str] = Field("", description="The stream name.", example=["Users"], title="Name")
21532137
retriever: Union[SimpleRetriever, AsyncRetriever, CustomRetriever] = Field(
21542138
...,
21552139
description="Component used to coordinate how records are extracted across stream slices and request pages.",
@@ -2327,20 +2311,18 @@ class HttpRequester(BaseModelWithDeprecations):
23272311
description="Allows for retrieving a dynamic set of properties from an API endpoint which can be injected into outbound request using the stream_partition.extra_fields.",
23282312
title="Fetch Properties from Endpoint",
23292313
)
2330-
request_parameters: Optional[Union[Dict[str, Union[str, QueryProperties]], str]] = (
2331-
Field(
2332-
None,
2333-
description="Specifies the query parameters that should be set on an outgoing HTTP request given the inputs.",
2334-
examples=[
2335-
{"unit": "day"},
2336-
{
2337-
"query": 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2338-
},
2339-
{"searchIn": "{{ ','.join(config.get('search_in', [])) }}"},
2340-
{"sort_by[asc]": "updated_at"},
2341-
],
2342-
title="Query Parameters",
2343-
)
2314+
request_parameters: Optional[Union[Dict[str, Union[str, QueryProperties]], str]] = Field(
2315+
None,
2316+
description="Specifies the query parameters that should be set on an outgoing HTTP request given the inputs.",
2317+
examples=[
2318+
{"unit": "day"},
2319+
{
2320+
"query": 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2321+
},
2322+
{"searchIn": "{{ ','.join(config.get('search_in', [])) }}"},
2323+
{"sort_by[asc]": "updated_at"},
2324+
],
2325+
title="Query Parameters",
23442326
)
23452327
request_headers: Optional[Union[Dict[str, str], str]] = Field(
23462328
None,
@@ -2533,9 +2515,7 @@ class QueryProperties(BaseModel):
25332515

25342516
class StateDelegatingStream(BaseModel):
25352517
type: Literal["StateDelegatingStream"]
2536-
name: str = Field(
2537-
..., description="The stream name.", example=["Users"], title="Name"
2538-
)
2518+
name: str = Field(..., description="The stream name.", example=["Users"], title="Name")
25392519
full_refresh_stream: DeclarativeStream = Field(
25402520
...,
25412521
description="Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided.",
@@ -2624,9 +2604,7 @@ class AsyncRetriever(BaseModel):
26242604
)
26252605
download_extractor: Optional[
26262606
Union[DpathExtractor, CustomRecordExtractor, ResponseToFileExtractor]
2627-
] = Field(
2628-
None, description="Responsible for fetching the records from provided urls."
2629-
)
2607+
] = Field(None, description="Responsible for fetching the records from provided urls.")
26302608
creation_requester: Union[HttpRequester, CustomRequester] = Field(
26312609
...,
26322610
description="Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job.",
@@ -2766,12 +2744,10 @@ class DynamicDeclarativeStream(BaseModel):
27662744
stream_template: DeclarativeStream = Field(
27672745
..., description="Reference to the stream template.", title="Stream Template"
27682746
)
2769-
components_resolver: Union[HttpComponentsResolver, ConfigComponentsResolver] = (
2770-
Field(
2771-
...,
2772-
description="Component resolve and populates stream templates with components values.",
2773-
title="Components Resolver",
2774-
)
2747+
components_resolver: Union[HttpComponentsResolver, ConfigComponentsResolver] = Field(
2748+
...,
2749+
description="Component resolve and populates stream templates with components values.",
2750+
title="Components Resolver",
27752751
)
27762752

27772753

airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3655,12 +3655,16 @@ def create_stream_config(
36553655
def create_config_components_resolver(
36563656
self, model: ConfigComponentsResolverModel, config: Config
36573657
) -> Any:
3658+
model_stream_configs = (
3659+
model.stream_config if isinstance(model.stream_config, list) else [model.stream_config]
3660+
)
36583661

3659-
model_stream_configs = model.stream_config if isinstance(model.stream_config, list) else [model.stream_config]
3660-
3661-
stream_configs = [self._create_component_from_model(
3662-
stream_config, config=config, parameters=model.parameters or {}
3663-
) for stream_config in model_stream_configs]
3662+
stream_configs = [
3663+
self._create_component_from_model(
3664+
stream_config, config=config, parameters=model.parameters or {}
3665+
)
3666+
for stream_config in model_stream_configs
3667+
]
36643668

36653669
components_mapping = [
36663670
self._create_component_from_model(

airbyte_cdk/sources/declarative/resolvers/config_components_resolver.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
33
#
44

5-
from itertools import product
65
from copy import deepcopy
76
from dataclasses import InitVar, dataclass, field
8-
from typing import Any, Dict, Iterable, List, Mapping, Union, Optional
7+
from itertools import product
8+
from typing import Any, Dict, Iterable, List, Mapping, Optional, Union
99

1010
import dpath
1111
from typing_extensions import deprecated
@@ -97,8 +97,7 @@ def __post_init__(self, parameters: Mapping[str, Any]) -> None:
9797
def _stream_config(self):
9898
def resolve_path(pointer):
9999
return [
100-
node.eval(self.config) if not isinstance(node, str) else node
101-
for node in pointer
100+
node.eval(self.config) if not isinstance(node, str) else node for node in pointer
102101
]
103102

104103
def normalize_configs(configs):
@@ -165,7 +164,8 @@ def _parse_yaml_if_possible(value: Any) -> Any:
165164
if isinstance(value, str):
166165
try:
167166
import yaml
167+
168168
return yaml.safe_load(value)
169169
except Exception:
170170
return value
171-
return value
171+
return value

airbyte_cdk/sources/declarative/schema/dynamic_schema_loader.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
import dpath
1111
from typing_extensions import deprecated
1212

13+
from airbyte_cdk.sources.declarative.extractors.record_filter import RecordFilter
1314
from airbyte_cdk.sources.declarative.interpolation.interpolated_boolean import InterpolatedBoolean
1415
from airbyte_cdk.sources.declarative.interpolation.interpolated_string import InterpolatedString
1516
from airbyte_cdk.sources.declarative.retrievers.retriever import Retriever
1617
from airbyte_cdk.sources.declarative.schema.schema_loader import SchemaLoader
17-
from airbyte_cdk.sources.declarative.extractors.record_filter import RecordFilter
1818
from airbyte_cdk.sources.declarative.transformations import RecordTransformation
1919
from airbyte_cdk.sources.source import ExperimentalClassWarning
2020
from airbyte_cdk.sources.types import Config, StreamSlice, StreamState

0 commit comments

Comments
 (0)