Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Mark kwargs in metadata API methods as Optional

Browse source 
Use typing.Optional for optional kwargs that default to None.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
This commit is contained in:
Lukas Puehringer 2021-03-05 11:27:33 +01:00
parent 2b4085718b
commit aa8225cb07
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
tuf/api/metadata.py
View file

@ -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: