Merge pull request #11 from GiacomoPope/use_ruff

Use ruff instead of black in ci

Author: GiacomoPope

.github/workflows/ci.yml

@@ -7,37 +7,23 @@ on:
   pull_request:
 
 jobs:
-  code-format:
+  lint_check_ruff:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
         with:
-          fetch-depth: 10
-      - name: Verify git status
-        run: |
-          git status
-          git remote -v
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+          version: "latest"
+          args: "check"
+
+  lint_format_ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
         with:
-          python-version: "3.12"
-      - name: Display Python version
-        run: python -c "import sys; print(sys.version)"
-      - name: Display installed python package versions
-        run: |
-          pip list || :
-      - name: Install build dependencies
-        run: |
-          pip install -r requirements.txt
-      - name: Install black
-        run: |
-          pip install black==24.4.2
-      - name: Display installed python package versions
-        run: |
-          pip list || :
-      - name: Check formatting
-        run: |
-          black --check .
+          version: "latest"
+          args: "format --check"
 
   test:
     runs-on: ${{ matrix.os }}

benchmarks/benchmark_dilithium.py

@@ -60,9 +60,9 @@ def benchmark_dilithium(Dilithium, name, count):
             fails += 1
 
     print(f"Keygen median: {round(median(keygen_times), 3)}")
-    print(f"Sign median: {round(median(sign_times),3)}")
-    print(f"Sign average: {round(mean(sign_times),3)}")
-    print(f"Verify median: {round(median(verify_times),3)}")
+    print(f"Sign median: {round(median(sign_times), 3)}")
+    print(f"Sign average: {round(mean(sign_times), 3)}")
+    print(f"Verify median: {round(median(verify_times), 3)}")
     print(f"Fails: {fails}")
 
 

benchmarks/benchmark_ml_dsa.py

@@ -60,9 +60,9 @@ def benchmark_ml_dsa(ML_DSA, name, count):
             fails += 1
 
     print(f"Keygen median: {round(median(keygen_times), 3)}")
-    print(f"Sign median: {round(median(sign_times),3)}")
-    print(f"Sign average: {round(mean(sign_times),3)}")
-    print(f"Verify median: {round(median(verify_times),3)}")
+    print(f"Sign median: {round(median(sign_times), 3)}")
+    print(f"Sign average: {round(mean(sign_times), 3)}")
+    print(f"Verify median: {round(median(verify_times), 3)}")
     print(f"Fails: {fails}")
 
 

src/dilithium_py/drbg/aes256_ctr_drbg.py

@@ -30,7 +30,7 @@ def __init__(self, seed: Optional[bytes] = None, personalization: bytes = b""):
         self.__ctr_drbg_update(seed_material)
         self.reseed_ctr = 1
 
-    def __check_entropy_input(self, entropy_input: bytes) -> bytes:
+    def __check_entropy_input(self, entropy_input: Optional[bytes] = None) -> bytes:
         """
         If no entropy given, us os.urandom, else
         check that the input is of the right length.

src/dilithium_py/polynomials/polynomials.py

@@ -199,9 +199,9 @@ def bit_unpack_w(self, input_bytes, gamma_2):
             coefficients = self.__bit_unpack(input_bytes, 6)
         # Level 3 and 5 parameter set
         else:
-            assert (
-                gamma_2 == 261888
-            ), f"Expected gamma_2 to be either (q-1)/88 or (q-1)/32, got {gamma_2 = }"
+            assert gamma_2 == 261888, (
+                f"Expected gamma_2 to be either (q-1)/88 or (q-1)/32, got {gamma_2 = }"
+            )
             coefficients = self.__bit_unpack(input_bytes, 4)
 
         return self(coefficients)
@@ -212,9 +212,9 @@ def bit_unpack_z(self, input_bytes, gamma_1):
             altered_coeffs = self.__bit_unpack(input_bytes, 18)
         # Level 3 and 5 parameter set
         else:
-            assert gamma_1 == (
-                1 << 19
-            ), f"Expected gamma_1 to be either 2^17 or 2^19, got {gamma_1 = }"
+            assert gamma_1 == (1 << 19), (
+                f"Expected gamma_1 to be either 2^17 or 2^19, got {gamma_1 = }"
+            )
             altered_coeffs = self.__bit_unpack(input_bytes, 20)
 
         coefficients = [gamma_1 - c for c in altered_coeffs]
@@ -350,9 +350,9 @@ def bit_pack_w(self, gamma_2):
         if gamma_2 == 95232:
             return self.__bit_pack(self.coeffs, 6, 192)
         # Level 3 and 5 parameter set
-        assert (
-            gamma_2 == 261888
-        ), f"Expected gamma_2 to be either (q-1)/88 or (q-1)/32, got {gamma_2 = }"
+        assert gamma_2 == 261888, (
+            f"Expected gamma_2 to be either (q-1)/88 or (q-1)/32, got {gamma_2 = }"
+        )
         return self.__bit_pack(self.coeffs, 4, 128)
 
     def bit_pack_z(self, gamma_1):
@@ -361,9 +361,9 @@ def bit_pack_z(self, gamma_1):
         if gamma_1 == (1 << 17):
             return self.__bit_pack(altered_coeffs, 18, 576)
         # Level 3 and 5 parameter set
-        assert gamma_1 == (
-            1 << 19
-        ), f"Expected gamma_1 to be either 2^17 or 2^19, got: {gamma_1 = }"
+        assert gamma_1 == (1 << 19), (
+            f"Expected gamma_1 to be either 2^17 or 2^19, got: {gamma_1 = }"
+        )
         return self.__bit_pack(altered_coeffs, 20, 640)
 
     def make_hint(self, other, alpha):