Merge pull request #2580 from theupdateframework/dependabot/pip/test-and-lint-dependencies-c17666fe2e

Lukas Pühringer · web-flow · commit e1b52e7fd828 · 2024-03-12T09:40:40.000+01:00
build(deps): bump the test-and-lint-dependencies group with 1 update
diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst
@@ -76,4 +76,4 @@ The linter in CI/CD will check that new TUF code is formatted with
 command line:
 ::
 
-    $ ruff format .
+    $ tox -e fix
diff --git a/examples/manual_repo/succinct_hash_bin_delegations.py b/examples/manual_repo/succinct_hash_bin_delegations.py
@@ -17,6 +17,7 @@
 
 NOTE: Metadata files will be written to a 'tmp*'-directory in CWD.
 """
+
 import math
 import os
 import tempfile
diff --git a/requirements/lint.txt b/requirements/lint.txt
@@ -6,5 +6,5 @@
 # Lint tools
 # (We are not so interested in the specific versions of the tools: the versions
 # are pinned to prevent unexpected linting failures when tools update)
-ruff==0.2.2
+ruff==0.3.0
 mypy==1.8.0
diff --git a/tests/repository_simulator.py b/tests/repository_simulator.py
@@ -3,7 +3,7 @@
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-""""Test utility to simulate a repository
+"""Test utility to simulate a repository
 
 RepositorySimulator provides methods to modify repository metadata so that it's
 easy to "publish" new repository versions with modified metadata, while serving
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -2,9 +2,7 @@
 
 # Copyright 2020, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
-""" Unit tests for api/metadata.py
-
-"""
+"""Unit tests for api/metadata.py"""
 
 import json
 import logging
diff --git a/tests/test_examples.py b/tests/test_examples.py
@@ -1,9 +1,8 @@
 #!/usr/bin/env python
 # Copyright 2020, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
-""" Unit tests for 'examples' scripts.
+"""Unit tests for 'examples' scripts."""
 
-"""
 import glob
 import os
 import shutil
diff --git a/tests/test_fetcher_ng.py b/tests/test_fetcher_ng.py
@@ -3,8 +3,7 @@
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""Unit test for RequestsFetcher.
-"""
+"""Unit test for RequestsFetcher."""
 
 import io
 import logging
diff --git a/tests/test_metadata_eq_.py b/tests/test_metadata_eq_.py
@@ -5,7 +5,6 @@
 
 """Test __eq__ implementations of classes inside tuf/api/metadata.py."""
 
-
 import copy
 import os
 import sys
diff --git a/tests/test_metadata_generation.py b/tests/test_metadata_generation.py
@@ -3,7 +3,6 @@
 # Copyright New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-
 import sys
 import unittest
 
diff --git a/tests/test_metadata_serialization.py b/tests/test_metadata_serialization.py
@@ -1,7 +1,7 @@
 # Copyright New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-""" Unit tests testing tuf/api/metadata.py classes
+"""Unit tests testing tuf/api/metadata.py classes
 serialization and deserialization.
 
 """
diff --git a/tests/test_updater_fetch_target.py b/tests/test_updater_fetch_target.py
@@ -6,6 +6,7 @@
 """Test 'Fetch target' from 'Detailed client workflow' as well as
 target files storing/loading from cache.
 """
+
 import os
 import sys
 import tempfile
diff --git a/tests/test_updater_ng.py b/tests/test_updater_ng.py
@@ -3,8 +3,7 @@
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""Test Updater class
-"""
+"""Test Updater class"""
 
 import logging
 import os
diff --git a/tests/test_updater_validation.py b/tests/test_updater_validation.py
@@ -3,8 +3,7 @@
 # Copyright 2022, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""Test ngclient Updater validations.
-"""
+"""Test ngclient Updater validations."""
 
 import os
 import sys
diff --git a/tox.ini b/tox.ini
@@ -53,6 +53,13 @@ commands =
 
     mypy {[testenv:lint]lint_dirs}
 
+[testenv:fix]
+changedir = {toxinidir}
+deps = {[testenv:lint]deps}
+commands =
+    ruff check --fix {[testenv:lint]lint_dirs}
+    ruff format {[testenv:lint]lint_dirs}
+
 [testenv:docs]
 deps =
     -r{toxinidir}/requirements/docs.txt
diff --git a/tuf/__init__.py b/tuf/__init__.py
@@ -1,8 +1,7 @@
 # Copyright New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""TUF.
-"""
+"""TUF."""
 
 # This value is used in the requests user agent.
 __version__ = "3.1.0"
diff --git a/tuf/api/_payload.py b/tuf/api/_payload.py
@@ -2,9 +2,8 @@
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
 
-"""Helper classes for low-level Metadata API.
+"""Helper classes for low-level Metadata API."""
 
-"""
 import abc
 import fnmatch
 import io
diff --git a/tuf/api/dsse.py b/tuf/api/dsse.py
@@ -1,6 +1,5 @@
-"""Low-level TUF DSSE API. (experimental!)
+"""Low-level TUF DSSE API. (experimental!)"""
 
-"""
 import json
 from typing import Dict, Generic, Type, cast
 
diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py
@@ -19,16 +19,17 @@
 
 The above principle means that a ``Metadata`` object represents a single
 metadata file, and has a ``signed`` attribute that is an instance of one of the
-four top level signed classes (``Root``, ``Timestamp``, ``Snapshot`` and 
-``Targets``). To make Python type annotations useful ``Metadata`` can be 
-type constrained: e.g. the signed attribute of ``Metadata[Root]`` 
+four top level signed classes (``Root``, ``Timestamp``, ``Snapshot`` and
+``Targets``). To make Python type annotations useful ``Metadata`` can be
+type constrained: e.g. the signed attribute of ``Metadata[Root]``
 is known to be ``Root``.
 
 Currently Metadata API supports JSON as the file format.
 
 A basic example of repository implementation using the Metadata is available in
 `examples/repo_example <https://github.com/theupdateframework/python-tuf/tree/develop/examples/repo_example>`_.
 """
+
 import logging
 import tempfile
 from typing import Any, Dict, Generic, Optional, Type, cast
diff --git a/tuf/ngclient/__init__.py b/tuf/ngclient/__init__.py
@@ -1,9 +1,7 @@
 # Copyright New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""TUF client public API.
-"""
-
+"""TUF client public API."""
 
 from tuf.api.metadata import TargetFile
 
diff --git a/tuf/ngclient/config.py b/tuf/ngclient/config.py
@@ -1,8 +1,7 @@
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""Configuration options for ``Updater`` class.
-"""
+"""Configuration options for ``Updater`` class."""
 
 from dataclasses import dataclass
 from enum import Flag, unique
diff --git a/tuf/ngclient/fetcher.py b/tuf/ngclient/fetcher.py
@@ -1,8 +1,7 @@
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
-"""Provides an interface for network IO abstraction.
-"""
+"""Provides an interface for network IO abstraction."""
 
 # Imports
 import abc
