python source jsonschema support #520
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… exchangeratesapi
jrhizor
commented
Oct 8, 2020
| @@ -30,7 +30,7 @@ definitions: | |||
| additionalProperties: false | |||
| required: | |||
| - data | |||
| - extracted_at | |||
| - emitted_at | |||
There was a problem hiding this comment.
didn't align with the actual name of the field
jrhizor
commented
Oct 8, 2020
| @@ -2,7 +2,7 @@ | |||
| "$schema": http://json-schema.org/draft-07/schema# | |||
| "$id": https://github.com/airbytehq/airbyte/blob/master/airbyte-protocol/models/src/main/resources/airbyte_protocol/airbyte_message.yaml | |||
| title: AirbyteMessage | |||
| description: | |||
| description: Airbyte message | |||
There was a problem hiding this comment.
python-jsonschema-objects fails on None descriptions
jrhizor
commented
Oct 8, 2020
| @@ -31,7 +33,7 @@ def discover(shell_command, transform=(lambda x: AirbyteSchema(x))) -> AirbyteSc | |||
| return transform(completed_process.stdout) | |||
|
|
|||
| @staticmethod | |||
| def read(shell_command, is_message=(lambda x: True), transform=(lambda x: AirbyteMessage(x))) -> Generator[ | |||
| def read(shell_command, is_message=(lambda x: True), transform=(lambda x: AirbyteMessage(type="RECORD", record=AirbyteRecordMessage(data={'value': x}, emitted_at=str(datetime.now()))))) -> Generator[ | |||
There was a problem hiding this comment.
This will probably change to just outputting an object that will convert to json, which will be placed into the data field. Then base.py will be responsible for setting the timestamp and constructing the objects.
sherifnada
approved these changes
Oct 8, 2020
| def _load_classes(yaml_path: str): | ||
| data = yaml.load(pkgutil.get_data(__name__, yaml_path), Loader=yaml.FullLoader) | ||
| builder = pjs.ObjectBuilder(data) | ||
| return builder.build_classes(standardize_names=False) |
There was a problem hiding this comment.
Is there a reason to prefer dynamic bindings over static generation? Might make sense to retain the context in a comment
There was a problem hiding this comment.
The only static builders for Python I found were https://github.com/pearmaster/json-schema-codegen and https://github.com/microsoft/jschema-to-python, which aren't as full-featured or widely used.
I can add a todo #530
| @@ -0,0 +1 @@ | |||
| types | |||
There was a problem hiding this comment.
why is this being ignored if it is being used in init.py?
There was a problem hiding this comment.
This is only ignored on git because it is copied to a local dir for Python packaging and Docker copying. Since it's a duplicate and it's effectively "generated" during the build because it's copied, I thought it would make sense to exclude.
| builder = pjs.ObjectBuilder(data) | ||
| return builder.build_classes(standardize_names=False) | ||
|
|
||
| with warnings.catch_warnings(): |
There was a problem hiding this comment.
is this because the underlying libraries output lots of noise? Are they something we'd want to retain/emit anywhere?
There was a problem hiding this comment.
There's one warning about the JSON schema version we're using. All of the features we're using here are supported, but the version itself isn't. Added a comment.
| @@ -86,7 +86,7 @@ def start(self): | |||
| # todo: pass in state | |||
| generator = source.read(logging, rendered_config_path) | |||
| for message in generator: | |||
| print(message.message_string.strip()) | |||
| print(message.serialize(sort_keys=True)) | |||
There was a problem hiding this comment.
why do we sort keys? is this needed or just a nice to have? could you mention this context in a comment?
michel-tricot
approved these changes
Oct 9, 2020
| } | ||
|
|
||
| task copyProtocolDefinitions(type: Copy) { | ||
| from file("$projectDir/../../airbyte-protocol/models/src/main/resources/airbyte_protocol").absolutePath |
There was a problem hiding this comment.
can you use rootDir so you don't have to ../../?
|
For config: The output is: I'll add schema emission and moving stream to a higher level in the message in separate PRs. |
This was referenced Oct 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tested with spec/discover/check/read for the exchangerate v2 api.
Logging via message records will be in a different PR.