add Ruff for Python file format and lint

.github/workflows/build_and_test.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Install dependencies
         run: |
           apk update && apk add cppcheck python3-dev
-          python3 -m pip install cmake-format clang-format==18.1.6
+          python3 -m pip install cmake-format clang-format==18.1.6 ruff==0.6.5
 
       # TODO: investigate how to run pre-commit with `venv`
       - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1

.pre-commit-config.yaml

@@ -7,6 +7,20 @@ repos:
         name: Check clang-format version
         entry: python3 ./ci/check-clang-format-version.py
         language: system
+      - id: check-ruff-format-version
+        name: Check ruff-format version
+        entry: python3 ./ci/check-ruff-version.py
+        language: system
+      - id: ruff
+        name: ruff
+        entry: ruff check
+        types_or: [python]
+        language: system
+      - id: ruff-format
+        name: ruff-format
+        entry: ruff format --check
+        types_or: [python]
+        language: system
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:
@@ -21,10 +35,6 @@ repos:
       - id: mixed-line-ending
         args: ['--fix=lf']
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: 24.8.0
-    hooks:
-      - id: black
   - repo: https://github.com/pocc/pre-commit-hooks
     rev: v1.3.5
     hooks:

3rdParty/OUIDataset/create_oui_data.py

@@ -75,7 +75,7 @@ def convert_line(line: str) -> list[str]:
 
 
 def parse_mac_and_vendor(line_parts: list[str]) -> Optional[LineElements]:
-    if line_parts == None or len(line_parts) < 3:
+    if line_parts is None or len(line_parts) < 3:
         return None
 
     if len(line_parts[0]) == 6:

Tests/ExamplesTest/tests/test_httpanalyzer.py

@@ -1,5 +1,4 @@
 from os import path
-from itertools import filterfalse
 import pytest
 from .test_utils import ExampleTest, compare_stdout_with_file
 

Tests/ExamplesTest/tests/test_pcapsearch.py

@@ -1,6 +1,4 @@
-from os import path
 import pytest
-import re
 import ntpath
 from .test_utils import ExampleTest
 
@@ -42,7 +40,7 @@ def test_exact_file_format(self):
                     num_of_packets = int(words[0])
                     file_name = ntpath.basename(words[-1].replace("'", ""))
                     actual.add((num_of_packets, file_name))
-                except:
+                except Exception:
                     pass
 
         assert expected.issubset(actual)
@@ -52,7 +50,7 @@ def test_different_file_extensions(self):
         completed_process = self.run_example(args=args)
         assert ".dmp'" in completed_process.stdout
         assert ".pcapng'" in completed_process.stdout
-        assert not ".pcap'" in completed_process.stdout
+        assert ".pcap'" not in completed_process.stdout
 
     def test_no_args(self):
         args = {}

Tests/ExamplesTest/tests/test_pcapsplitter.py

@@ -238,7 +238,7 @@ def test_split_by_connection(self, tmpdir):
             else:
                 conn = frozenset([])
 
-            assert not conn in connection_map
+            assert conn not in connection_map
             connection_map[conn] = True
 
             if len(conn) == 0:

Tests/ExamplesTest/tests/test_sslanalyzer.py

@@ -1,5 +1,4 @@
 from os import path
-from itertools import filterfalse
 import pytest
 from .test_utils import ExampleTest, compare_stdout_with_file
 

Tests/ExamplesTest/tests/test_tlsfingerprinting.py

@@ -1,5 +1,4 @@
 import os
-import filecmp
 import pytest
 from .test_utils import (
     ExampleTest,

ci/check-ruff-version.py

@@ -0,0 +1,18 @@
+import subprocess
+
+EXPECTED_RUFF_VERSION = "0.6.5"
+
+
+def main():
+    result = subprocess.run(("ruff", "--version"), capture_output=True)
+    result.check_returncode()
+
+    version_str = result.stdout.decode("utf-8").split(" ")[1].strip()
+    if version_str != EXPECTED_RUFF_VERSION:
+        raise ValueError(
+            f"Error: Found ruff version {version_str}, but {EXPECTED_RUFF_VERSION} is required."
+        )
+
+
+if __name__ == "__main__":
+    main()

ci/run_tests/run_tests_windows.py

@@ -57,7 +57,7 @@ def find_interface():
                 if completed_process.returncode != 0:
                     continue
                 return interface, ip_address
-            except:
+            except Exception:
                 pass
     return None, None
 

cmake/setup_dpdk.py

@@ -230,9 +230,7 @@ def usage():
     [Restore]
 
         sudo python setup_dpdk.py restore\n\n
-    """.format(
-        settings_file=_SETTINGS_FILE
-    )
+    """.format(settings_file=_SETTINGS_FILE)
 
 
 # This is roughly compatible with check_output function in subprocess module
@@ -439,7 +437,7 @@ def handle_error(error_msg):
     filename = "/sys/bus/pci/drivers/%s/unbind" % dev["Driver_str"]
     try:
         file_d = open(filename, "a")
-    except:  # pylint:disable=bare-except
+    except Exception:
         handle_error(
             "Error: unbind failed for %s - Cannot open %s" % (dev_id, filename)
         )
@@ -491,7 +489,7 @@ def handle_error(error_msg):
     if os.path.exists(filename):
         try:
             file_d = open(filename, "w")
-        except:  # pylint:disable=bare-except
+        except Exception:
             handle_error(
                 "Error: bind failed for %s - Cannot open %s" % (dev_id, filename)
             )
@@ -500,7 +498,7 @@ def handle_error(error_msg):
             file_d.write("%s" % driver)
             logger.debug("bind_one: write '%s' to '%s'", driver, filename)
             file_d.close()
-        except:  # pylint:disable=bare-except
+        except Exception:
             handle_error(
                 "Error: bind failed for %s - Cannot write driver %s to "
                 "PCI ID " % (dev_id, driver)
@@ -511,7 +509,7 @@ def handle_error(error_msg):
         filename = "/sys/bus/pci/drivers/%s/new_id" % driver
         try:
             file_d = open(filename, "w")
-        except:  # pylint:disable=bare-except
+        except Exception:
             handle_error(
                 "Error: bind failed for %s - Cannot open %s" % (dev_id, filename)
             )
@@ -520,7 +518,7 @@ def handle_error(error_msg):
             # Convert Device and Vendor Id to int to write to new_id
             file_d.write("%04x %04x" % (int(dev["Vendor"], 16), int(dev["Device"], 16)))
             file_d.close()
-        except:  # pylint:disable=bare-except
+        except Exception:
             handle_error(
                 "Error: bind failed for %s - Cannot write new PCI ID to "
                 "driver %s" % (dev_id, driver)
@@ -531,7 +529,7 @@ def handle_error(error_msg):
     filename = "/sys/bus/pci/drivers/%s/bind" % driver
     try:
         file_d = open(filename, "a")
-    except:  # pylint:disable=bare-except
+    except Exception:
         logger.error("Error: bind failed for %s - Cannot open %s", dev_id, filename)
         if saved_driver is not None:  # restore any previous driver
             bind_one(dev_id, saved_driver, quiet, force)
@@ -540,7 +538,7 @@ def handle_error(error_msg):
         file_d.write(dev_id)
         logger.debug("bind_one: write '%s' to '%s'", dev_id, filename)
         file_d.close()
-    except:  # pylint:disable=bare-except
+    except Exception:
         # for some reason, closing dev_id after adding a new PCI ID to new_id
         # results in IOError. however, if the device was successfully bound,
         # we don't care for any errors and can safely ignore IOError
@@ -561,7 +559,7 @@ def handle_error(error_msg):
     if os.path.exists(filename):
         try:
             file_d = open(filename, "w")
-        except:  # pylint:disable=bare-except
+        except Exception:
             handle_error(
                 "Error: unbind failed for %s - Cannot open %s" % (dev_id, filename)
             )
@@ -570,7 +568,7 @@ def handle_error(error_msg):
             file_d.write("\00")
             logger.debug("bind_one: write '\00' to '%s'", filename)
             file_d.close()
-        except:  # pylint:disable=bare-except
+        except Exception:
             handle_error(
                 "Error: unbind failed for %s - Cannot open %s" % (dev_id, filename)
             )
@@ -1216,7 +1214,7 @@ def main():
     try:
         args.func(args, settings)
         settings.save(settings_file_full_path)
-    except:  # pylint:disable=bare-except
+    except Exception:
         pass