From 744f75c1e7b9f64541e8d95247b0efc61fdef254 Mon Sep 17 00:00:00 2001 From: Fridolin Pokorny Date: Thu, 26 Jan 2023 16:35:19 +0100 Subject: [PATCH] Fix pydocstyle D209 Fix multi-line docstring closing quotes should be on a separate line Signed-off-by: Fridolin Pokorny --- tuf/api/exceptions.py | 7 ++++--- tuf/api/metadata.py | 6 ++++-- tuf/ngclient/_internal/requests_fetcher.py | 8 +++++--- tuf/repository/_repository.py | 6 ++++-- 4 files changed, 17 insertions(+), 10 deletions(-) diff --git a/tuf/api/exceptions.py b/tuf/api/exceptions.py index a2a889b0..9e01f742 100644 --- a/tuf/api/exceptions.py +++ b/tuf/api/exceptions.py @@ -16,13 +16,14 @@ class RepositoryError(Exception): """An error with a repository's state, such as a missing file. + It covers all exceptions that come from the repository side when - looking from the perspective of users of metadata API or ngclient.""" + looking from the perspective of users of metadata API or ngclient. + """ class UnsignedMetadataError(RepositoryError): - """An error about metadata object with insufficient threshold of - signatures.""" + """An error about metadata object with insufficient threshold of signatures.""" class BadVersionNumberError(RepositoryError): diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py index f463c543..2b41ea80 100644 --- a/tuf/api/metadata.py +++ b/tuf/api/metadata.py @@ -1774,8 +1774,10 @@ def __init__( @property def custom(self) -> Any: - """Can be used to provide implementation specific data related to the - target. python-tuf does not use or validate this data.""" + """Get implementation specific data related to the target. + + python-tuf does not use or validate this data. + """ return self.unrecognized_fields.get("custom") def __eq__(self, other: Any) -> bool: diff --git a/tuf/ngclient/_internal/requests_fetcher.py b/tuf/ngclient/_internal/requests_fetcher.py index 6abd8160..0080cbb9 100644 --- a/tuf/ngclient/_internal/requests_fetcher.py +++ b/tuf/ngclient/_internal/requests_fetcher.py @@ -96,9 +96,11 @@ def _fetch(self, url: str) -> Iterator[bytes]: return self._chunks(response) def _chunks(self, response: "requests.Response") -> Iterator[bytes]: - """A generator function to be returned by fetch. This way the - caller of fetch can differentiate between connection and actual data - download.""" + """A generator function to be returned by fetch. + + This way the caller of fetch can differentiate between connection + and actual data download. + """ try: for data in response.iter_content(self.chunk_size): diff --git a/tuf/repository/_repository.py b/tuf/repository/_repository.py index ec1223e3..d411ede7 100644 --- a/tuf/repository/_repository.py +++ b/tuf/repository/_repository.py @@ -40,7 +40,8 @@ class Repository(ABC): def open(self, role: str) -> Metadata: """Load a roles metadata from storage or cache, return it - If role has no metadata, create first version from scratch""" + If role has no metadata, create first version from scratch. + """ raise NotImplementedError @abstractmethod @@ -48,7 +49,8 @@ def close(self, role: str, md: Metadata) -> None: """Write roles metadata into storage Update expiry and version and replace signatures with ones from all - available keys. Keep snapshot_info and targets_infos updated.""" + available keys. Keep snapshot_info and targets_infos updated. + """ raise NotImplementedError @property