reformat docstrings and supress small errors inline

Signed-off-by: E3E <ntanzill@purdue.edu>

Author: NicholasTanz

pyproject.toml

@@ -83,19 +83,16 @@ line-length=80
 [tool.ruff.lint]
 select = [
     "D",  # pydocstyle
-    "I",  # isort
+    "E",  # pycodestyle
     "F",  # pyflakes
+    "I",  # isort
     "N",  # pep8-naming
-    "E"   # pycodestyle 
 ] 
 ignore = ["D400","D415","D213","D205","D202","D107","D407","D413","D212","D104","D406","D105","D411","D401","D200","D203"]
+
 [tool.ruff.lint.per-file-ignores]
 "tests/*" = ["D", "E"]
 "examples/*/*" = ["D"] 
-"tuf/repository/__init__.py" = ["F401"]
-"tuf/api/exceptions.py" = ["F401"]
-"tuf/repository/_repository.py" = ["N818"]
-"verify_release" = ["F401", "D103", "E501"]
 
 # Pylint section
 

tuf/api/exceptions.py

@@ -11,8 +11,7 @@
 #### Repository errors ####
 
 # pylint: disable=unused-import
-# ruff: disable unused-inport
-from securesystemslib.exceptions import StorageError
+from securesystemslib.exceptions import StorageError  # noqa: F401
 
 
 class RepositoryError(Exception):

tuf/repository/__init__.py

@@ -10,5 +10,4 @@
 The repository module is not considered part of the stable python-tuf API yet.
 """
 
-# ruff: disable unused-inport
-from tuf.repository._repository import AbortEdit, Repository
+from tuf.repository._repository import AbortEdit, Repository  # noqa: F401, I001

tuf/repository/_repository.py

@@ -22,8 +22,7 @@
 logger = logging.getLogger(__name__)
 
 
-# ruff: ignore N818 `Exception name should have Error suffix`
-class AbortEdit(Exception):
+class AbortEdit(Exception):  # noqa: N818
     """Raise to exit the edit() contextmanager without saving changes"""
 
 

verify_release

@@ -19,7 +19,7 @@ from tempfile import TemporaryDirectory
 from typing import Optional
 
 try:
-    import build as _  # type: ignore
+    import build as _  # type: ignore # noqa: F401
     import requests
 except ImportError:
     print("Error: verify_release requires modules 'requests' and 'build':")
@@ -168,19 +168,21 @@ def sign_release_artifacts(
 
 
 def finished(s: str) -> None:
+    """Displays a finished message."""
     # clear line
     sys.stdout.write("\033[K")
     print(f"* {s}")
 
 
 def progress(s: str) -> None:
+    """Displays a progress message."""
     # clear line
     sys.stdout.write("\033[K")
     # carriage return but no newline: next print will overwrite this one
     print(f"  {s}...", end="\r", flush=True)
 
 
-def main() -> int:
+def main() -> int:  # noqa: D103
     parser = argparse.ArgumentParser()
     parser.add_argument(
         "--skip-pypi",
@@ -194,8 +196,9 @@ def main() -> int:
         const=True,
         metavar="<key id>",
         dest="sign",
-        help="Sign release artifacts with 'gpg'. If no <key id> is passed, the default "
-        "signing key is used. Resulting '*.asc' files are written to CWD.",
+        help="Sign release artifacts with 'gpg'. If no <key id> is passed,"
+        " the default signing key is used. Resulting '*.asc' files are written"
+        " to CWD.",
     )
     args = parser.parse_args()
 
@@ -237,7 +240,8 @@ def main() -> int:
         else:
             finished("GitHub artifacts match the built release")
 
-        # NOTE: 'gpg' might prompt for password or ask if it should override files...
+        # NOTE: 'gpg' might prompt for password or ask if it should
+        # override files...
         if args.sign:
             progress("Signing built release with gpg")
             if success: