From aa8225cb079536c09c497696c8d2fb1321a8f1df Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Fri, 5 Mar 2021 11:27:33 +0100 Subject: [PATCH] Mark kwargs in metadata API methods as Optional Use typing.Optional for optional kwargs that default to None. Signed-off-by: Lukas Puehringer --- tuf/api/metadata.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py index 83d5a79a..8af694ce 100644 --- a/tuf/api/metadata.py +++ b/tuf/api/metadata.py @@ -104,7 +104,8 @@ class also that has a 'from_dict' factory method. (Currently this is @classmethod def from_file( - cls, filename: str, deserializer: MetadataDeserializer = None, + cls, filename: str, + deserializer: Optional[MetadataDeserializer] = None, storage_backend: Optional[StorageBackendInterface] = None ) -> 'Metadata': """Loads TUF metadata from file storage. @@ -150,8 +151,10 @@ def to_dict(self) -> JsonDict: 'signed': self.signed.to_dict() } - def to_file(self, filename: str, serializer: MetadataSerializer = None, - storage_backend: StorageBackendInterface = None) -> None: + def to_file( + self, filename: str, serializer: Optional[MetadataSerializer] = None, + storage_backend: Optional[StorageBackendInterface] = None + ) -> None: """Writes TUF metadata to file storage. Arguments: @@ -183,7 +186,7 @@ def to_file(self, filename: str, serializer: MetadataSerializer = None, # Signatures. def sign(self, key: JsonDict, append: bool = False, - serializer: SignedSerializer = None) -> JsonDict: + serializer: Optional[SignedSerializer] = None) -> JsonDict: """Creates signature over 'signed' and assigns it to 'signatures'. Arguments: @@ -223,7 +226,7 @@ def sign(self, key: JsonDict, append: bool = False, def verify(self, key: JsonDict, - serializer: SignedSerializer = None) -> bool: + serializer: Optional[SignedSerializer] = None) -> bool: """Verifies 'signatures' over 'signed' that match the passed key by id. Arguments: