Initial commit archive_dataset script #33
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
Also added module comments to the top of the other scripts I wrote in the past few weeks. Additionally, extended backfill_json_datasets to use cached Synapse credentials if an ssm-parameter name is not passed.
thomasyu888
reviewed
Dec 19, 2021
There was a problem hiding this comment.
Some general comments for you. I like how you add examples in the docstrings - very informative.
Not completely necessary to include the jira link in the description but I understand it does make it more convenient than searching for the issue after going to the ETL project in jira.
| if len(relevant_archive_dataset_prefixes) == 0: | ||
| # No datasets of this type and version in archive | ||
| return 0 | ||
| preexisting_update_nums = [ |
There was a problem hiding this comment.
This will break if the archive number doesn't get added on accident.
And joined prefixes with os module for clarity
thomasyu888
approved these changes
Dec 22, 2021
Comment on lines
+67
to
+76
| Keyword arguments: | ||
| s3_client -- An AWS S3 client object. | ||
| bucket -- The S3 bucket name. | ||
| app -- The app identifier, as used in the S3 prefix in the bucket, to archive. | ||
| dataset -- The name of the dataset to archive. | ||
| dataset_version -- The dataset version to archive. | ||
|
|
||
| Returns: | ||
| A dictionary with source prefixes as keys and destination | ||
| prefixes as values. |
There was a problem hiding this comment.
Just out of curiosity, where did you find this python docstring standard? I'm only familiar with
- pydoc
- numpy
There was a problem hiding this comment.
| dest = source_and_dest[source] | ||
| bash_command = f"aws s3 cp --recursive {source} {dest}" | ||
| subprocess.run( | ||
| shlex.split(bash_command), |
There was a problem hiding this comment.
This is very cool! I did not know about shlex
tthyer
approved these changes
Jan 10, 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.
Addresses: https://sagebionetworks.jira.com/browse/ETL-89
Also added module comments to the top of the other scripts I wrote
in the past few weeks. Additionally, extended backfill_json_datasets
to use cached Synapse credentials if an ssm-parameter name is not
passed.