diff --git a/pyproject.toml b/pyproject.toml index 72fa2a77..bfaac440 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -154,3 +154,7 @@ module = [ "securesystemslib.*", ] ignore_missing_imports = "True" + +[tool.pydocstyle] +inherit = false +ignore = "D400,D415,D213,D205,D202,D107,D407,D413,D212,D104,D406,D105,D411,D401,D200,D203" diff --git a/requirements-test.txt b/requirements-test.txt index 42edd73a..0dc08cbe 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -10,3 +10,4 @@ isort==5.11.4 pylint==2.16.1 mypy==0.991 bandit==1.7.4 +pydocstyle==6.3.0 diff --git a/tox.ini b/tox.ini index b3e243b7..95205e5c 100644 --- a/tox.ini +++ b/tox.ini @@ -52,6 +52,8 @@ commands = bandit -r tuf + pydocstyle tuf + [testenv:docs] deps = -r{toxinidir}/requirements-docs.txt diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py index 2f40499c..b2e64ddf 100644 --- a/tuf/api/metadata.py +++ b/tuf/api/metadata.py @@ -817,7 +817,8 @@ def revoke_key(self, keyid: str, role: str) -> None: def get_delegated_role(self, delegated_role: str) -> Role: """Return the role object for the given delegated role. - Raises ValueError if delegated_role is not actually delegated.""" + Raises ValueError if delegated_role is not actually delegated. + """ if delegated_role not in self.roles: raise ValueError(f"Delegated role {delegated_role} not found") @@ -826,7 +827,8 @@ def get_delegated_role(self, delegated_role: str) -> Role: def get_key(self, keyid: str) -> Key: """Return the key object for the given keyid. - Raises ValueError if key is not found.""" + Raises ValueError if key is not found. + """ if keyid not in self.keys: raise ValueError(f"Key {keyid} not found") @@ -1897,7 +1899,8 @@ def revoke_key(self, keyid: str, role: Optional[str] = None) -> None: def get_delegated_role(self, delegated_role: str) -> Role: """Return the role object for the given delegated role. - Raises ValueError if delegated_role is not actually delegated.""" + Raises ValueError if delegated_role is not actually delegated. + """ if self.delegations is None: raise ValueError("No delegations found") @@ -1914,7 +1917,8 @@ def get_delegated_role(self, delegated_role: str) -> Role: def get_key(self, keyid: str) -> Key: """Return the key object for the given keyid. - Raises ValueError if keyid is not found.""" + Raises ValueError if keyid is not found. + """ if self.delegations is None: raise ValueError("No delegations found") if keyid not in self.delegations.keys: