feat: allow ingesting custom data with python client #329
Conversation
This file contains hidden or 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
drake-nominal
requested review from
alkasm,
bauerm97,
ross-barrett and
varun-nominal
stefanv
approved these changes
May 2, 2025
| Args: | ||
| extractor: ContainerizedExtractor instance (or rid of one) to use for extracting and ingesting data. | ||
| sources: Mapping of environment variables to source files to use with the extractor. |
Collaborator
There was a problem hiding this comment.
Could we clarify this description a bit? Maybe an example of env var -> source file? I'm not sure what this would be.
| sources: Mapping of environment variables to source files to use with the extractor. | ||
| NOTE: these must match the registered inputs of the containerized extractor exactly | ||
| tag: Docker image tag to use the extractor of. | ||
| NOTE: if not provided, the default registered docker tag will be used. |
Collaborator
There was a problem hiding this comment.
Custom extractor can contain multiple Docker containers?
| if extractor_input.required and extractor_input.environment_variable not in sources: | ||
| raise ValueError(f"Required input '{extractor_input.environment_variable} not present in sources!") | ||
|
|
||
| # Ensure all provided inputs are permitted by the etractor |
Collaborator
There was a problem hiding this comment.
Suggested change
| # Ensure all provided inputs are permitted by the etractor | |
| # Ensure all provided inputs are permitted by the extractor |
| self._clients.upload, | ||
| ) | ||
| logger.info("Uploaded %s -> %s", source_path, s3_path) | ||
| s3_inputs[source] = source_path |
Collaborator
There was a problem hiding this comment.
If the operations fails beyond this point, is it the client's responsibility to delete uploaded files?
alkasm
reviewed
May 2, 2025
| for extractor_input in extractor.inputs: | ||
| registered_inputs.add(extractor_input.environment_variable) | ||
| if extractor_input.required and extractor_input.environment_variable not in sources: | ||
| raise ValueError(f"Required input '{extractor_input.environment_variable} not present in sources!") |
Contributor
There was a problem hiding this comment.
Suggested change
| raise ValueError(f"Required input '{extractor_input.environment_variable} not present in sources!") | |
| raise ValueError(f"Required input '{extractor_input.environment_variable}' not present in sources!") |
| if isinstance(extractor, str): | ||
| extractor = ContainerizedExtractor._from_conjure( | ||
| self._clients, | ||
| self._clients.containerized_extractors.get_containerized_extractor(self.rid, extractor), |
Contributor
There was a problem hiding this comment.
can we just create a method to get an extractor instead of inlining this?
| def add_custom( | ||
| self, | ||
| extractor: str | ContainerizedExtractor, | ||
| sources: Mapping[str, Path], |
Contributor
There was a problem hiding this comment.
I think we generally do Path | str everywhere
Co-authored-by: Alexander Reynolds <alex.reynolds@nominal.io>
Co-authored-by: Alexander Reynolds <alex.reynolds@nominal.io>
Co-authored-by: Stefan van der Walt <stefanv@berkeley.edu>
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.
No description provided.