Metadata API: Remove Signed.bump_expiration() method #1743
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
Remove `bump_expiration()` method, which is unlikely to be used as is, i.e. bump to "current expiration date plus delta". A more realistic use case is to bump to "now plus delta" (see theupdateframework#1727 for details). Moreover, bump_expiration can either way easily be replaced by a one-liner expression using the 'datetime' module. A corresponding code snippet is added to the `expires` property's docstring. Note: `expires` became a property with a millisec-removing setter (for spec conformance) in theupdateframework#1712, which further reduces the need for a convenience bump_expiration method. This patch also removes a related unit test and updates another one. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Update sphinx/rtd conf to display inherited members. This is enabled specifically for the newly added `expires` property, which has a useful code snippet in the docstring. We don't display - them on the tuf.api automodule overview page (avoid duplicates) - members inherited from the built-in Exception class Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Pull Request Test Coverage Report for Build 1610942226
💛 - Coveralls |
joshuagl
approved these changes
Jan 4, 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.
Fixes #1727
Description of the changes being introduced by the pull request:
Remove
bump_expiration()method, which is unlikely to be used as is, i.e. bump to "current expiration date plus delta". A more realistic use case is to bump to "now plus delta" (see #1727 for details).Moreover, bump_expiration can either way easily be replaced by a one-liner expression using the 'datetime' module. A corresponding code snippet is added to the
expiresproperty's docstring.Note:
expiresbecame a property with a millisec-removing setter (for spec conformance) in #1712, which further reduces the need for a convenience bump_expiration method.This patch also
expiresproperty with said code snippet (see e.g.Root.expires)Please verify and check that the pull request fulfills the following
requirements: