Split up util.get_file_details() #259
Merged
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
MVrachev
force-pushed
the
split-get-file-details
branch
from
ef84bba to
76f9385
Compare
joshuagl
approved these changes
Jul 21, 2020
securesystemslib/util.py
Outdated
| securesystemslib.exceptions.Error: If 'filepath' does not exist. | ||
| <Returns> | ||
| A dictionary conformat to securesystemslib.formats.HASHDICT_SCHEMA |
There was a problem hiding this comment.
Suggested change
| A dictionary conformat to securesystemslib.formats.HASHDICT_SCHEMA | |
| A dictionary conforming to securesystemslib.formats.HASHDICT_SCHEMA |
securesystemslib/util.py
Outdated
| <Returns> | ||
| A dictionary conformat to securesystemslib.formats.HASHDICT_SCHEMA | ||
| containing information about the hashes of "filepath". |
There was a problem hiding this comment.
Suggested change
| containing information about the hashes of "filepath". | |
| containing information about the hashes of the file at "filepath". |
securesystemslib/util.py
Outdated
| securesystemslib.exceptions.Error: If 'filepath' does not exist. | ||
| <Returns> | ||
| One digit describing 'filepath' length. |
There was a problem hiding this comment.
Suggested change
| One digit describing 'filepath' length. | |
| The length, in bytes, of the file at 'filepath'. |
securesystemslib/util.py
Outdated
Comment on lines
94
to
95
| To get file's hash/hashes information. The hash is computed using the | ||
| sha256 algorithm by default. |
There was a problem hiding this comment.
Suggested change
| To get file's hash/hashes information. The hash is computed using the | |
| sha256 algorithm by default. | |
| Compute hash(es) of the file at filepath using each of the specified | |
| hashing algorithms. If no algorithms are specified, the hash is | |
| computed using the SHA-256 algorithm. |
The util.get_file_details() function returns the length and hashes of the specified file. This makes a lot of sense for generating information about TUF targets, where the length and hashes of each target are required, but is potentially too costly function when generating information about TUF metadata files for the snapshot role, where lengths and hashes are optional. Snapshot metadata may only want hashes, or only want lengths, and we don't want to force an adopter to implement their own subset of the functionality in get_file_details(). Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
MVrachev
force-pushed
the
split-get-file-details
branch
from
76f9385 to
f92f1fd
Compare
|
I agree with all of the docstrings suggestions and updated the commit by addressing them. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Please fill in the fields below to submit a pull request. The more information
that is provided, the better.
Fixes issue #: #246
Description of the changes being introduced by the pull request:
The
util.get_file_details()function returns the length and hashesof the specified file.
As said on issue #246 on first glance it seems that only TUF uses
util.get_file_details()and if that's the case then for TUF it willbe better if we split that function
In the current format the function
util.get_file_details()makes a lot of sense for generating information about TUF targets,
where the length and hashes of each target are required but this is
potentially too costly function when generating information about TUF
metadata files for the snapshot role, where lengths and hashes are optional.
Snapshot metadata may only want hashes, or only want lengths,
and we don't want to force an adopter to implement their own subset
of the functionality in get_file_details().
Please verify and check that the pull request fulfils the following
requirements: