MITLibraries / archival-packaging-tool

72%

main: 96%

LAST BUILD ON BRANCH IN-1214-core-bagitarchive-class

branch: IN-1214-core-bagitarchive-class

CHANGE BRANCH

x

Reset

Sync Branches

• IN-1214-core-bagitarchive-class
• ETD-669-remove-default-contact-name
• IN-1192-scaffold-repository
• IN-1215-create-bag-action-and-class-design
• IN-1215-wire-lambda-handler
• IN-1219-lamdda-request-response-specs
• IN-1230-use-efs-mount
• IN-1238-use-pip-audit
• IN-1294-s3-efs-read-write-performance
• bug-extra-bag-zipfile
• dependabot/pip/black-25.1.0
• dependabot/pip/boto3-1.38.11
• dependabot/pip/boto3-1.38.12
• dependabot/pip/boto3-1.38.13
• dependabot/pip/boto3-1.38.14
• dependabot/pip/boto3-1.38.15
• dependabot/pip/boto3-1.38.16
• dependabot/pip/boto3-1.38.17
• dependabot/pip/boto3-1.38.18
• dependabot/pip/boto3-1.38.19
• dependabot/pip/boto3-1.38.20
• dependabot/pip/boto3-1.38.21
• dependabot/pip/boto3-1.38.22
• dependabot/pip/boto3-1.38.23
• dependabot/pip/boto3-1.38.24
• dependabot/pip/boto3-1.38.25
• dependabot/pip/boto3-1.38.26
• dependabot/pip/boto3-1.38.27
• dependabot/pip/boto3-1.38.28
• dependabot/pip/boto3-1.38.29
• dependabot/pip/boto3-1.38.30
• dependabot/pip/boto3-1.38.31
• dependabot/pip/boto3-1.38.32
• dependabot/pip/boto3-1.38.34
• dependabot/pip/boto3-1.38.35
• dependabot/pip/boto3-1.38.36
• dependabot/pip/boto3-1.38.37
• dependabot/pip/boto3-1.38.38
• dependabot/pip/boto3-1.38.39
• dependabot/pip/boto3-1.38.40
• dependabot/pip/boto3-1.38.41
• dependabot/pip/boto3-1.38.42
• dependabot/pip/boto3-1.38.43
• dependabot/pip/boto3-1.38.44
• dependabot/pip/boto3-1.38.45
• dependabot/pip/boto3-1.38.46
• dependabot/pip/boto3-1.39.0
• dependabot/pip/boto3-1.39.1
• dependabot/pip/boto3-1.39.10
• dependabot/pip/boto3-1.39.11
• dependabot/pip/boto3-1.39.12
• dependabot/pip/boto3-1.39.13
• dependabot/pip/boto3-1.39.15
• dependabot/pip/boto3-1.39.16
• dependabot/pip/boto3-1.39.17
• dependabot/pip/boto3-1.39.2
• dependabot/pip/boto3-1.39.3
• dependabot/pip/boto3-1.39.4
• dependabot/pip/boto3-1.39.6
• dependabot/pip/boto3-1.39.7
• dependabot/pip/boto3-1.39.8
• dependabot/pip/boto3-1.39.9
• dependabot/pip/boto3-1.40.0
• dependabot/pip/boto3-1.40.1
• dependabot/pip/boto3-1.40.10
• dependabot/pip/boto3-1.40.11
• dependabot/pip/boto3-1.40.12
• dependabot/pip/boto3-1.40.13
• dependabot/pip/boto3-1.40.14
• dependabot/pip/boto3-1.40.15
• dependabot/pip/boto3-1.40.16
• dependabot/pip/boto3-1.40.17
• dependabot/pip/boto3-1.40.18
• dependabot/pip/boto3-1.40.19
• dependabot/pip/boto3-1.40.2
• dependabot/pip/boto3-1.40.20
• dependabot/pip/boto3-1.40.21
• dependabot/pip/boto3-1.40.22
• dependabot/pip/boto3-1.40.24
• dependabot/pip/boto3-1.40.25
• dependabot/pip/boto3-1.40.26
• dependabot/pip/boto3-1.40.27
• dependabot/pip/boto3-1.40.28
• dependabot/pip/boto3-1.40.29
• dependabot/pip/boto3-1.40.3
• dependabot/pip/boto3-1.40.30
• dependabot/pip/boto3-1.40.31
• dependabot/pip/boto3-1.40.32
• dependabot/pip/boto3-1.40.33
• dependabot/pip/boto3-1.40.34
• dependabot/pip/boto3-1.40.35
• dependabot/pip/boto3-1.40.37
• dependabot/pip/boto3-1.40.38
• dependabot/pip/boto3-1.40.39
• dependabot/pip/boto3-1.40.4
• dependabot/pip/boto3-1.40.40
• dependabot/pip/boto3-1.40.41
• dependabot/pip/boto3-1.40.42
• dependabot/pip/boto3-1.40.43
• dependabot/pip/boto3-1.40.44
• dependabot/pip/boto3-1.40.45
• dependabot/pip/boto3-1.40.47
• dependabot/pip/boto3-1.40.48
• dependabot/pip/boto3-1.40.49
• dependabot/pip/boto3-1.40.5
• dependabot/pip/boto3-1.40.50
• dependabot/pip/boto3-1.40.51
• dependabot/pip/boto3-1.40.52
• dependabot/pip/boto3-1.40.53
• dependabot/pip/boto3-1.40.54
• dependabot/pip/boto3-1.40.55
• dependabot/pip/boto3-1.40.56
• dependabot/pip/boto3-1.40.57
• dependabot/pip/boto3-1.40.6
• dependabot/pip/boto3-1.40.7
• dependabot/pip/boto3-1.40.8
• dependabot/pip/boto3-1.40.9
• dependabot/pip/boto3-stubs-1.38.16
• dependabot/pip/boto3-stubs-1.38.17
• dependabot/pip/boto3-stubs-1.38.18
• dependabot/pip/boto3-stubs-1.38.19
• dependabot/pip/boto3-stubs-1.38.20
• dependabot/pip/boto3-stubs-1.38.21
• dependabot/pip/boto3-stubs-1.38.22
• dependabot/pip/boto3-stubs-1.38.23
• dependabot/pip/boto3-stubs-1.38.24
• dependabot/pip/boto3-stubs-1.38.25
• dependabot/pip/boto3-stubs-1.38.26
• dependabot/pip/boto3-stubs-1.38.27
• dependabot/pip/boto3-stubs-1.38.28
• dependabot/pip/boto3-stubs-1.38.29
• dependabot/pip/boto3-stubs-1.38.31
• dependabot/pip/boto3-stubs-1.38.32
• dependabot/pip/boto3-stubs-1.38.33
• dependabot/pip/boto3-stubs-1.38.34
• dependabot/pip/boto3-stubs-1.38.36
• dependabot/pip/boto3-stubs-1.38.38
• dependabot/pip/boto3-stubs-1.38.39
• dependabot/pip/boto3-stubs-1.38.40
• dependabot/pip/boto3-stubs-1.38.41
• dependabot/pip/boto3-stubs-1.38.42
• dependabot/pip/boto3-stubs-1.38.43
• dependabot/pip/boto3-stubs-1.38.44
• dependabot/pip/boto3-stubs-1.38.45
• dependabot/pip/boto3-stubs-1.38.46
• dependabot/pip/boto3-stubs-1.39.0
• dependabot/pip/boto3-stubs-1.39.1
• dependabot/pip/boto3-stubs-1.39.10
• dependabot/pip/boto3-stubs-1.39.11
• dependabot/pip/boto3-stubs-1.39.12
• dependabot/pip/boto3-stubs-1.39.13
• dependabot/pip/boto3-stubs-1.39.15
• dependabot/pip/boto3-stubs-1.39.16
• dependabot/pip/boto3-stubs-1.39.17
• dependabot/pip/boto3-stubs-1.39.2
• dependabot/pip/boto3-stubs-1.39.3
• dependabot/pip/boto3-stubs-1.39.4
• dependabot/pip/boto3-stubs-1.39.6
• dependabot/pip/boto3-stubs-1.39.7
• dependabot/pip/boto3-stubs-1.39.8
• dependabot/pip/boto3-stubs-1.39.9
• dependabot/pip/boto3-stubs-1.40.0
• dependabot/pip/boto3-stubs-1.40.1
• dependabot/pip/boto3-stubs-1.40.10
• dependabot/pip/boto3-stubs-1.40.11
• dependabot/pip/boto3-stubs-1.40.12
• dependabot/pip/boto3-stubs-1.40.13
• dependabot/pip/boto3-stubs-1.40.14
• dependabot/pip/boto3-stubs-1.40.15
• dependabot/pip/boto3-stubs-1.40.16
• dependabot/pip/boto3-stubs-1.40.17
• dependabot/pip/boto3-stubs-1.40.18
• dependabot/pip/boto3-stubs-1.40.19
• dependabot/pip/boto3-stubs-1.40.2
• dependabot/pip/boto3-stubs-1.40.20
• dependabot/pip/boto3-stubs-1.40.21
• dependabot/pip/boto3-stubs-1.40.22
• dependabot/pip/boto3-stubs-1.40.23
• dependabot/pip/boto3-stubs-1.40.24
• dependabot/pip/boto3-stubs-1.40.25
• dependabot/pip/boto3-stubs-1.40.26
• dependabot/pip/boto3-stubs-1.40.27
• dependabot/pip/boto3-stubs-1.40.28
• dependabot/pip/boto3-stubs-1.40.29
• dependabot/pip/boto3-stubs-1.40.3
• dependabot/pip/boto3-stubs-1.40.30
• dependabot/pip/boto3-stubs-1.40.31
• dependabot/pip/boto3-stubs-1.40.32
• dependabot/pip/boto3-stubs-1.40.33
• dependabot/pip/boto3-stubs-1.40.34
• dependabot/pip/boto3-stubs-1.40.35
• dependabot/pip/boto3-stubs-1.40.36
• dependabot/pip/boto3-stubs-1.40.37
• dependabot/pip/boto3-stubs-1.40.38
• dependabot/pip/boto3-stubs-1.40.39
• dependabot/pip/boto3-stubs-1.40.4
• dependabot/pip/boto3-stubs-1.40.40
• dependabot/pip/boto3-stubs-1.40.41
• dependabot/pip/boto3-stubs-1.40.42
• dependabot/pip/boto3-stubs-1.40.43
• dependabot/pip/boto3-stubs-1.40.44
• dependabot/pip/boto3-stubs-1.40.45
• dependabot/pip/boto3-stubs-1.40.47
• dependabot/pip/boto3-stubs-1.40.48
• dependabot/pip/boto3-stubs-1.40.5
• dependabot/pip/boto3-stubs-1.40.50
• dependabot/pip/boto3-stubs-1.40.51
• dependabot/pip/boto3-stubs-1.40.52
• dependabot/pip/boto3-stubs-1.40.53
• dependabot/pip/boto3-stubs-1.40.54
• dependabot/pip/boto3-stubs-1.40.55
• dependabot/pip/boto3-stubs-1.40.56
• dependabot/pip/boto3-stubs-1.40.57
• dependabot/pip/boto3-stubs-1.40.58
• dependabot/pip/boto3-stubs-1.40.6
• dependabot/pip/boto3-stubs-1.40.8
• dependabot/pip/boto3-stubs-1.40.9
• dependabot/pip/ipython-9.2.0
• dependabot/pip/mypy-1.15.0
• dependabot/pip/pip-25.2
• dependabot/pip/pre-commit-4.2.0
• dependabot/pip/requests-2.32.4
• dependabot/pip/ruff-0.11.10
• dependabot/pip/ruff-0.11.11
• dependabot/pip/ruff-0.11.12
• dependabot/pip/ruff-0.11.13
• dependabot/pip/ruff-0.11.3
• dependabot/pip/ruff-0.11.4
• dependabot/pip/ruff-0.11.5
• dependabot/pip/ruff-0.11.6
• dependabot/pip/ruff-0.11.7
• dependabot/pip/ruff-0.11.8
• dependabot/pip/ruff-0.11.9
• dependabot/pip/ruff-0.12.1
• dependabot/pip/ruff-0.12.10
• dependabot/pip/ruff-0.12.11
• dependabot/pip/ruff-0.12.12
• dependabot/pip/ruff-0.12.2
• dependabot/pip/ruff-0.12.3
• dependabot/pip/ruff-0.12.4
• dependabot/pip/ruff-0.12.5
• dependabot/pip/ruff-0.12.7
• dependabot/pip/ruff-0.12.8
• dependabot/pip/ruff-0.12.9
• dependabot/pip/ruff-0.13.0
• dependabot/pip/ruff-0.13.1
• dependabot/pip/ruff-0.13.2
• dependabot/pip/ruff-0.13.3
• dependabot/pip/ruff-0.14.0
• dependabot/pip/ruff-0.14.1
• dependabot/pip/ruff-0.14.2
• dependabot/pip/sentry-sdk-2.25.1
• dependabot/pip/sentry-sdk-2.26.0
• dependabot/pip/sentry-sdk-2.26.1
• dependabot/pip/sentry-sdk-2.27.0
• dependabot/pip/sentry-sdk-2.28.0
• dependabot/pip/setuptools-80.4.0
• dependabot/pip/setuptools-80.7.1
• dependabot/pip/setuptools-80.8.0
• dependabot/pip/setuptools-80.9.0
• dependabot/pip/types-jsonschema-4.23.0.20250516
• dependabot/pip/types-jsonschema-4.24.0.20250528
• dependabot/pip/types-jsonschema-4.24.0.20250708
• dependabot/pip/types-jsonschema-4.25.0.20250720
• dependabot/pip/types-jsonschema-4.25.0.20250809
• dependabot/pip/types-jsonschema-4.25.1.20250821
• dependabot/pip/types-jsonschema-4.25.1.20250822
• dependabot/pip/types-jsonschema-4.25.1.20251008
• dependabot/pip/types-jsonschema-4.25.1.20251009
• dependabot/pip/urllib3-2.5.0
• deployment-automation
• main
• pipenv-check-safety-auto-install
• v1.0
• v1.1

Build # 14889985915

Build Type

Pull #10

github

Committed by ghukill

Commit Message

More explicit with download and upload methods and args

Why these changes are being introduced:

Some PR feedback shared that it was a bit confusing how the utility
function stream_file_transfer() was capable of reading and writing
from a "URI" which could be an S3 object or a local filesystem path,
while the download and upload methods on the BagitArchive class seemed
more opinionated in what type of location was getting used.

There is some tension where a URI feels more accurate for the more
input/output agnostic utility function stream_file_transfer(), but
the methods are fairly opinionated whether things are coming from
S3 or not.

How this addresses that need:

Attempted to keep some flexibility in the utility function while making
the methods more opinionated by reworking some method names and arguments:

- upload_file() renamed to upload_bag_to_s3() which is quite literally
the only way it's used

- arguments for download_file() and upload_bag_to_s3() indicate if
they are "remote URIs" or some kind of "local path" to the degree possible

Side effects of this change:
* None

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-1214

Pull Request Pull Request #10: In 1214 core BagitArchive class

Run Details

96 of 117 new or added lines in 2 files covered. (82.05%)

131 of 182 relevant lines covered (71.98%)

0.72 hits per line