Change: Replace pylint with ruff

Use ruff instead of pylint because ruff is so much faster.

.github/workflows/ci-python.yml

@@ -17,6 +17,7 @@ jobs:
           - "3.11"
     uses: greenbone/workflows/.github/workflows/lint-python.yml@main
     with:
+      linter: ruff
       lint-packages: gvmtools tests
       python-version: ${{ matrix.python-version }}
 
@@ -39,9 +40,9 @@ jobs:
         run: poetry run pip install -r scripts/requirements.txt
       - name: Check with black
         run: poetry run black --check scripts/*.gmp.py
-      - name: Run pylint
+      - name: Lint scripts
         run: |
-          poetry run pylint --rcfile=scripts/.pylintrc --disable=R --ignore=requirements.txt scripts/*.py
+          poetry run ruff --config scripts/ruff.toml scripts/*.py
 
   test:
     name: Unit tests

gvmtools/cli.py

@@ -49,7 +49,7 @@
       gvm-cli socket --gmp-username foo --gmp-password foo myfile.xml
 
     The protocol specifications for GMP and OSP are available at:
-      https://docs.greenbone.net/index.html#api_documentation"""
+      https://docs.greenbone.net/index.html#api_documentation"""  # noqa: E501
 
 
 def _load_infile(filename=None):

gvmtools/config.py

@@ -84,7 +84,7 @@ def defaults(self):
         return self._defaults
 
     def get(self, section, name):
-        if not section in self._config:
+        if section not in self._config:
             return None
 
         return self._config[section].get(name)

pyproject.toml

@@ -12,7 +12,7 @@ readme = "README.md"
 homepage = "https://github.com/greenbone/gvm-tools/"
 repository = "https://github.com/greenbone/gvm-tools/"
 documentation = "https://greenbone.github.io/gvm-tools/"
-classifiers=[
+classifiers = [
     # Full list: https://pypi.org/pypi?%3Aaction=list_classifiers
     'Development Status :: 5 - Production/Stable',
     'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
@@ -42,7 +42,7 @@ python-gvm = ">=23.4.2"
 
 [tool.poetry.dev-dependencies]
 autohooks = ">=22.8.0"
-autohooks-plugin-pylint = ">=22.8.1"
+autohooks-plugin-ruff = ">=23.6.1"
 autohooks-plugin-black = ">=22.8.1"
 autohooks-plugin-isort = ">=22.8.0"
 pontos = ">=22.8.1"
@@ -75,7 +75,11 @@ line_length = 80
 
 [tool.autohooks]
 mode = "poetry"
-pre-commit = ['autohooks.plugins.black', 'autohooks.plugins.pylint', 'autohooks.plugins.isort']
+pre-commit = [
+    'autohooks.plugins.black',
+    'autohooks.plugins.ruff',
+    'autohooks.plugins.isort',
+]
 
 [tool.pontos.version]
 version-module-file = "gvmtools/__version__.py"

scripts/certbund-report.gmp.py

@@ -252,7 +252,7 @@ def main(gmp: Gmp, args: Namespace) -> None:
     _info(f"processing {len(hosts)}/{len(hostdatas)} hosts")
     for hostdata in hostdatas:
         asset = hostdata.find("asset").attrib["asset_id"]
-        if not asset in hosts:
+        if asset not in hosts:
             continue
         details: Dict[str, Optional[str]] = {}
         details["ip"] = _get_text(hostdata.find("ip"))
@@ -295,7 +295,7 @@ def main(gmp: Gmp, args: Namespace) -> None:
             # warn below
             continue
         for cbi in cbs.findall("info"):
-            if not "id" in cbi.attrib:
+            if "id" not in cbi.attrib:
                 # we have both <info id="CB-K14/1304"> (which we want)
                 # and, for some reason, <info start="1" max="10"/>
                 continue

scripts/check-gmp.gmp.py

@@ -270,7 +270,7 @@ def delete_entry_with_ip(self, ip):
         self.cursor.execute("DELETE FROM Report WHERE host=?", (ip,))
         self.con_db.isolation_level = None
         self.cursor.execute("VACUUM")
-        self.con_db.isolation_level = ""  # see: https://github.com/CxAalto/gtfspy/commit/8d05c3c94a6d4ca3ed675d88af93def7d5053bfe # pylint: disable=line-too-long
+        self.con_db.isolation_level = ""  # see: https://github.com/CxAalto/gtfspy/commit/8d05c3c94a6d4ca3ed675d88af93def7d5053bfe # pylint: disable=line-too-long # noqa: E501
         # Save the changes
         self.con_db.commit()
 

scripts/combine-reports.gmp.py

@@ -16,6 +16,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+# ruff: noqa: E501
+
 import sys
 import time
 from argparse import Namespace
@@ -43,7 +45,7 @@ def check_args(args: Namespace) -> None:
         n. <report_n_uuid> --uuid of report to be combined
 
         Example for starting up the routine:
-            $ gvm-script --gmp-username=namessh --gmp-password=pass ssh --hostname=hostname  \
+            $ gvm-script --gmp-username=namessh --gmp-password=pass ssh --hostname=hostname \
      scripts/combine-reports.gmp.py \
     "d15a337c-56f3-4208-a462-afeb79eb03b7" \
     "303fa0a6-aa9b-43c4-bac0-66ae0b2d1698" 'first_task'

scripts/generate-random-reports.gmp.py

@@ -52,8 +52,8 @@
     """
 
 LOREM_IPSUM = """Lorem ipsum dolor sit amet, consectetur adipiscing elit,
-sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
-Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut 
+sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
 voluptate velit esse cillum dolore eu fugiat nulla pariatur.
 Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
@@ -340,7 +340,7 @@ def generate_host_elem(
     return host_elem
 
 
-def generate_reports(task, n_reports, with_gauss, **kwargs):
+def generate_reports(task, n_reports, n_results, with_gauss, **kwargs):
     reports = []
 
     if with_gauss:
@@ -350,7 +350,7 @@ def generate_reports(task, n_reports, with_gauss, **kwargs):
 
     for _ in range(n_reports):
         if with_gauss:
-            n_results = abs(int(gauss(n_results, 2)))
+            abs(int(gauss(n_results, 2)))
 
         report_elem = generate_report_elem(task, **kwargs)
         report_elem = e.tostring(report_elem)
@@ -388,8 +388,9 @@ def main(gmp: Gmp, args: Namespace) -> None:
         epilog=textwrap.dedent(
             """
         Example:
-            $ gvm-script --gmp-username name --gmp-password pass
-            ssh --hostname <gsm> scripts/gen-random-reports.gmp.py -T 5 -r 4 -R 3 --hosts 10
+            $ gvm-script --gmp-username name --gmp-password pass \
+              ssh --hostname <gsm> scripts/gen-random-reports.gmp.py \
+              -T 5 -r 4 -R 3 --hosts 10
         """
         ),
     )

scripts/ruff.toml

@@ -0,0 +1 @@
+builtins = ["gmp", "args"]

scripts/send-delta-emails.gmp.py

@@ -40,7 +40,8 @@ def check_args(args: Namespace) -> None:
         reports via email for selected tasks.
 
         Example for starting up the routine:
-            $ gvm-script --gmp-username name --gmp-password pass ssh --hostname <gsm> scripts/send-delta-emails.gmp.py
+            $ gvm-script --gmp-username name --gmp-password pass ssh \
+                --hostname <gsm> scripts/send-delta-emails.gmp.py
 
         The routine follows this procedure:
 

scripts/ssv_csv.py

@@ -54,7 +54,7 @@
 
 import re
 import sys
-from typing import IO, AnyStr, List, Optional, Pattern, TextIO, Union
+from typing import IO, AnyStr, List, Optional, TextIO
 
 
 class CSVShapeError(Exception):

scripts/start-multiple-alerts-scan.gmp.py

@@ -32,10 +32,11 @@ def check_args(args):
 
         1. <sender_email>     -- E-Mail of the sender
         2. <receiver_email>   -- E-Mail of the receiver
-        
+
                 Example:
             $ gvm-script --gmp-username name --gmp-password pass \
-ssh --hostname <gsm> scripts/start-multiple-alert-scan.gmp.py <sender_email> <receiver_email>
+ssh --hostname <gsm> scripts/start-multiple-alert-scan.gmp.py \
+<sender_email> <receiver_email>
     """
     if len_args != 2:
         print(message)

scripts/sync-hosts.gmp.py

@@ -30,7 +30,8 @@ def check_args(args):
         This script reads host data from a csv file and sync it with the gsm.
         It needs one parameters after the script name.
 
-        1. <csv_file> - should contain a table of IP-addresses with an optional a comment
+        1. <csv_file> - should contain a table of IP-addresses with an
+                        optional a comment
 
         Example:
             $ gvm-script --gmp-username name --gmp-password pass \

tests/scripts/__init__.py

@@ -19,7 +19,7 @@
 from importlib.util import module_from_spec, spec_from_file_location
 from pathlib import Path
 from typing import Union
-from unittest.mock import MagicMock, create_autospec, patch
+from unittest.mock import MagicMock, create_autospec
 
 from gvm.protocols.latest import Gmp
 from lxml import etree