Beautify code (#97)

* Move project to `uv` Add typing Add pre-commit Reformat code Make code more secure Update workflow python_simplified.yml Update workflow python_detailed.yml Signed-off-by: andrew000 <[email protected]> * Replace `pipe operator` to `Union`, to support py3.9 Bump deps Signed-off-by: andrew000 <[email protected]> * Resolve conflicts Bump deps Signed-off-by: andrew000 <[email protected]> * Fix `_fields_` in `Signature` Add stream handler to logger Signed-off-by: andrew000 <[email protected]> * Add stream handler to logger in rand.py and kem.py Signed-off-by: andrew000 <[email protected]> * Add stream handler to logger in sig.py Signed-off-by: andrew000 <[email protected]> * Updated examples * Bump `ruff`, `0.9.3` -> `0.9.4` Signed-off-by: andrew000 <[email protected]> * Change type hint of `_fields_` from `list` to `Sequence` Signed-off-by: andrew000 <[email protected]> * Added COM812 to tools.ruff.lint.ignore Signed-off-by: Vlad Gheorghiu <[email protected]> --------- Signed-off-by: andrew000 <[email protected]> Signed-off-by: Vlad Gheorghiu <[email protected]> Co-authored-by: Vlad Gheorghiu <[email protected]>
open-quantum-safe · Feb 2, 2025 · 7dc350f · 7dc350f
1 parent 720f2cc
commit 7dc350f
Show file tree

Hide file tree

Showing 17 changed files with 717 additions and 356 deletions.
diff --git a/.github/workflows/python_detailed.yml b/.github/workflows/python_detailed.yml
@@ -2,11 +2,11 @@ name: GitHub actions detailed
 
 on:
   push:
-    branches: ["**"]
+    branches: [ "**" ]
   pull_request:
-    branches: ["**"]
+    branches: [ "**" ]
   repository_dispatch:
-    types: ["**"]
+    types: [ "**" ]
 
 permissions:
   contents: read
@@ -20,21 +20,24 @@ jobs:
   build:
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: "3.10"
+          version: "latest"
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
+
+      - name: Set up Python 3.9
+        run: uv python install 3.9
 
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install nose2
+        run: uv sync --extra dev
 
       - name: Install liboqs POSIX
         if: matrix.os != 'windows-latest'
@@ -47,17 +50,17 @@ jobs:
       - name: Run examples POSIX
         if: matrix.os != 'windows-latest'
         run: |
-          pip install .
-          python examples/kem.py
+          uv sync --extra dev
+          uv run examples/kem.py
           echo
-          python examples/sig.py
+          uv run examples/sig.py
           echo
-          python examples/rand.py
+          uv run examples/rand.py
 
       - name: Run unit tests POSIX
         if: matrix.os != 'windows-latest'
         run: |
-          nose2 --verbose
+          uv run nose2 --verbose
 
       - name: Install liboqs Windows
         if: matrix.os == 'windows-latest'
@@ -73,16 +76,16 @@ jobs:
         shell: cmd
         run: |
           set PATH=%PATH%;${{env.WIN_LIBOQS_INSTALL_PATH}}\bin
-          pip install .
-          python examples/kem.py
+          uv sync --extra dev
+          uv run examples/kem.py
           echo.
-          python examples/sig.py
+          uv run examples/sig.py
           echo.
-          python examples/rand.py
+          uv run examples/rand.py
 
       - name: Run unit tests Windows
         shell: cmd
         if: matrix.os == 'windows-latest'
         run: |
           set PATH=%PATH%;${{env.WIN_LIBOQS_INSTALL_PATH}}\bin
-          nose2 --verbose
+          uv run nose2 --verbose
diff --git a/.github/workflows/python_simplified.yml b/.github/workflows/python_simplified.yml
@@ -2,11 +2,11 @@ name: GitHub actions simplified
 
 on:
   push:
-    branches: ["**"]
+    branches: [ "**" ]
   pull_request:
-    branches: ["**"]
+    branches: [ "**" ]
   repository_dispatch:
-    types: ["**"]
+    types: [ "**" ]
 
 permissions:
   contents: read
@@ -15,25 +15,29 @@ jobs:
   build:
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: "3.10"
+          version: "latest"
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
+
+      - name: Set up Python 3.9
+        run: uv python install 3.9
 
       - name: Run examples
         run: |
-          python -m pip install --upgrade pip
-          pip install .
-          python examples/kem.py
-          python examples/sig.py
-          python examples/rand.py
+          uv sync --extra dev
+          uv run examples/kem.py
+          uv run examples/sig.py
+          uv run examples/rand.py
 
       - name: Run unit tests
         run: |
-          nose2 --verbose
+          uv run nose2 --verbose
diff --git a/.gitignore b/.gitignore
@@ -117,4 +117,5 @@ pip-selfcheck.json
 pyvenv.cfg
 
 # vim
-*.swp
+*.swp
+/uv.lock
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,38 @@
+fail_fast: false
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: "trailing-whitespace"
+      - id: "check-case-conflict"
+      - id: "check-merge-conflict"
+      - id: "debug-statements"
+      - id: "end-of-file-fixer"
+      - id: "mixed-line-ending"
+        args: [ "--fix", "crlf" ]
+        types:
+          - python
+          - yaml
+          - toml
+          - text
+      - id: "detect-private-key"
+      - id: "check-yaml"
+      - id: "check-toml"
+      - id: "check-json"
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.9.4
+    hooks:
+      - id: ruff
+        args: [ "--fix" ]
+        files: "oqs"
+
+      - id: ruff-format
+        files: "oqs"
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)
+        files: "oqs"
diff --git a/Makefile b/Makefile
@@ -0,0 +1,41 @@
+# Code checker/formatter
+#
+# Pre-requisites
+#
+# isort
+# mypy
+# ruff
+# uv
+
+src-dir = oqs
+tests-dir = tests
+examples-dir = examples
+
+.PHONY lint:
+lint:
+	echo "Running ruff..."
+	uv run ruff check --config pyproject.toml --diff $(src-dir) $(tests-dir) $(examples-dir)
+
+.PHONY format:
+format:
+	echo "Running ruff check with --fix..."
+	uv run ruff check --config pyproject.toml --fix --unsafe-fixes $(src-dir) $(tests-dir) $(examples-dir)
+
+	echo "Running ruff..."
+	uv run ruff format --config pyproject.toml $(src-dir) $(tests-dir) $(examples-dir)
+
+	echo "Running isort..."
+	uv run isort --settings-file pyproject.toml $(src-dir) $(tests-dir) $(examples-dir)
+
+.PHONE mypy:
+mypy:
+	echo "Running MyPy..."
+	uv run mypy --config-file pyproject.toml $(src-dir)
+
+.PHONY outdated:
+outdated:
+	uv tree --outdated --universal
+
+.PHONY sync:
+sync:
+	uv sync --extra dev --extra lint
diff --git a/examples/__init__.py b/examples/__init__.py
diff --git a/examples/kem.py b/examples/kem.py
@@ -1,20 +1,27 @@
 # Key encapsulation Python example
 
+import logging
+from pprint import pformat
+from sys import stdout
+
 import oqs
-from pprint import pprint
 
-print("liboqs version:", oqs.oqs_version())
-print("liboqs-python version:", oqs.oqs_python_version())
-print("Enabled KEM mechanisms:")
-kems = oqs.get_enabled_kem_mechanisms()
-pprint(kems, compact=True)
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+logger.addHandler(logging.StreamHandler(stdout))
+
+logger.info("liboqs version: %s", oqs.oqs_version())
+logger.info("liboqs-python version: %s", oqs.oqs_python_version())
+logger.info(
+    "Enabled KEM mechanisms:\n%s",
+    pformat(oqs.get_enabled_kem_mechanisms(), compact=True),
+)
 
 # Create client and server with sample KEM mechanisms
 kemalg = "ML-KEM-512"
 with oqs.KeyEncapsulation(kemalg) as client:
     with oqs.KeyEncapsulation(kemalg) as server:
-        print("\nKey encapsulation details:")
-        pprint(client.details)
+        logger.info("Key encapsulation details:\n%s", pformat(client.details))
 
         # Client generates its keypair
         public_key_client = client.generate_keypair()
@@ -31,6 +38,7 @@
         # The client decapsulates the server's ciphertext to obtain the shared secret
         shared_secret_client = client.decap_secret(ciphertext)
 
-        print(
-            "\nShared secretes coincide:", shared_secret_client == shared_secret_server
-        )
+    logger.info(
+        "Shared secretes coincide: %s",
+        shared_secret_client == shared_secret_server,
+    )
diff --git a/examples/rand.py b/examples/rand.py
@@ -1,22 +1,29 @@
 # Various RNGs Python example
 
+import logging
 import platform  # to learn the OS we're on
+from sys import stdout
+
 import oqs.rand as oqsrand  # must be explicitly imported
-from oqs import oqs_version, oqs_python_version
+from oqs import oqs_python_version, oqs_version
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+logger.addHandler(logging.StreamHandler(stdout))
 
-print("liboqs version:", oqs_version())
-print("liboqs-python version:", oqs_python_version())
+logger.info("liboqs version: %s", oqs_version())
+logger.info("liboqs-python version: %s", oqs_python_version())
 
 oqsrand.randombytes_switch_algorithm("system")
-print(
-    "{:17s}".format("System (default):"),
-    " ".join("{:02X}".format(x) for x in oqsrand.randombytes(32)),
+logger.info(
+    "System (default): %s",
+    " ".join(f"{x:02X}" for x in oqsrand.randombytes(32)),
 )
 
 # We do not yet support OpenSSL under Windows
 if platform.system() != "Windows":
     oqsrand.randombytes_switch_algorithm("OpenSSL")
-    print(
-        "{:17s}".format("OpenSSL:"),
-        " ".join("{:02X}".format(x) for x in oqsrand.randombytes(32)),
+    logger.info(
+        "OpenSSL: %s",
+        " ".join(f"{x:02X}" for x in oqsrand.randombytes(32)),
     )
diff --git a/examples/sig.py b/examples/sig.py
@@ -1,36 +1,42 @@
 # Signature Python example
 
+import logging
+from pprint import pformat
+from sys import stdout
+
 import oqs
-from pprint import pprint
 
-print("liboqs version:", oqs.oqs_version())
-print("liboqs-python version:", oqs.oqs_python_version())
-print("Enabled signature mechanisms:")
-sigs = oqs.get_enabled_sig_mechanisms()
-pprint(sigs, compact=True)
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+logger.addHandler(logging.StreamHandler(stdout))
+
+logger.info("liboqs version: %s", oqs.oqs_version())
+logger.info("liboqs-python version: %s", oqs.oqs_python_version())
+logger.info(
+    "Enabled signature mechanisms:\n%s",
+    pformat(oqs.get_enabled_sig_mechanisms(), compact=True),
+)
 
-message = "This is the message to sign".encode()
+message = b"This is the message to sign"
 
 # Create signer and verifier with sample signature mechanisms
 sigalg = "ML-DSA-44"
-with oqs.Signature(sigalg) as signer:
-    with oqs.Signature(sigalg) as verifier:
-        print("\nSignature details:")
-        pprint(signer.details)
+with oqs.Signature(sigalg) as signer, oqs.Signature(sigalg) as verifier:
+    logger.info("Signature details:\n%s", pformat(signer.details))
 
-        # Signer generates its keypair
-        signer_public_key = signer.generate_keypair()
-        # Optionally, the secret key can be obtained by calling export_secret_key()
-        # and the signer can later be re-instantiated with the key pair:
-        # secret_key = signer.export_secret_key()
+    # Signer generates its keypair
+    signer_public_key = signer.generate_keypair()
+    # Optionally, the secret key can be obtained by calling export_secret_key()
+    # and the signer can later be re-instantiated with the key pair:
+    # secret_key = signer.export_secret_key()
 
-        # Store key pair, wait... (session resumption):
-        # signer = oqs.Signature(sigalg, secret_key)
+    # Store key pair, wait... (session resumption):
+    # signer = oqs.Signature(sigalg, secret_key)
 
-        # Signer signs the message
-        signature = signer.sign(message)
+    # Signer signs the message
+    signature = signer.sign(message)
 
-        # Verifier verifies the signature
-        is_valid = verifier.verify(message, signature, signer_public_key)
+    # Verifier verifies the signature
+    is_valid = verifier.verify(message, signature, signer_public_key)
 
-        print("\nValid signature?", is_valid)
+    logger.info("Valid signature? %s", is_valid)
-Original file line number
+Diff line change
@@ Expand Up / @@ -117,4 +117,5 @@ pip-selfcheck.json @@
     pyvenv.cfg
     # vim
-    *.swp
+    *.swp
+    /uv.lock