Merge pull request #2768 from keon/codex/fix-repo-audit-findings

Fix correctness issues found in repository audit

Author: keon

.github/workflows/publish.yml

@@ -8,10 +8,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09  # v5
 
       - name: Set up Python
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6
         with:
           python-version: "3.13"
 
@@ -22,7 +22,7 @@ jobs:
         run: python -m build
 
       - name: Upload build artifacts
-        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08  # v4
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4  # v5
         with:
           name: dist
           path: dist/
@@ -35,7 +35,7 @@ jobs:
       id-token: write
     steps:
       - name: Download build artifacts
-        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16  # v4
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53  # v6
         with:
           name: dist
           path: dist/

.github/workflows/python-app.yml

@@ -9,15 +9,17 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     strategy:
       matrix:
         python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09  # v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -31,3 +33,6 @@ jobs:
 
       - name: Test with pytest
         run: python -m pytest
+
+      - name: Test documentation examples
+        run: python -m pytest --doctest-modules algorithms/

algorithms/backtracking/factor_combinations.py

@@ -25,7 +25,7 @@ def get_factors(number: int) -> list[list[int]]:
 
     Examples:
         >>> get_factors(12)
-        [[2, 6], [2, 2, 3], [3, 4]]
+        [[2, 6], [3, 4], [2, 2, 3]]
     """
     todo: list[tuple[int, int, list[int]]] = [(number, 2, [])]
     combinations: list[list[int]] = []

algorithms/backtracking/minimax.py

@@ -25,7 +25,7 @@ def minimax(
     *depth* is the current depth (start with log2(len(scores))).
 
     >>> minimax(2, True, [3, 5, 2, 9])
-    5
+    3
     >>> minimax(3, True, [3, 5, 2, 9, 12, 5, 23, 23])
     12
     """

algorithms/backtracking/subsets.py

@@ -24,8 +24,8 @@ def subsets(nums: list[int]) -> list[list[int]]:
         A list of all subsets.
 
     Examples:
-        >>> sorted(subsets([1, 2]), key=str)
-        [[], [1], [1, 2], [2]]
+        >>> sorted(subsets([1, 2]), key=lambda item: (len(item), item))
+        [[], [1], [2], [1, 2]]
     """
     result: list[list[int]] = []
     _backtrack(result, nums, [], 0)
@@ -61,8 +61,8 @@ def subsets_v2(nums: list[int]) -> list[list[int]]:
         A list of all subsets.
 
     Examples:
-        >>> sorted(subsets_v2([1, 2]), key=str)
-        [[], [1], [1, 2], [2]]
+        >>> sorted(subsets_v2([1, 2]), key=lambda item: (len(item), item))
+        [[], [1], [2], [1, 2]]
     """
     result: list[list[int]] = [[]]
     for number in sorted(nums):

algorithms/compression/elias.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+from collections.abc import Callable
 from math import log
 
 
@@ -50,46 +51,47 @@ def _unary(x: int) -> str:
         x: A positive integer.
 
     Returns:
-        A unary-coded string (x-1 ones followed by a zero).
+        A unary-coded string (x-1 zeros followed by a one).
     """
-    return (x - 1) * "1" + "0"
+    return (x - 1) * "0" + "1"
 
 
 def _elias_generic(
-    length_encoding: callable,
+    length_encoding: Callable[[int], str],
     x: int,
 ) -> str:
     """Generic Elias encoding using a pluggable length-encoding function.
 
     Args:
         length_encoding: A function to encode the length prefix.
-        x: A non-negative integer to encode.
+        x: A positive integer to encode.
 
     Returns:
         The Elias-coded bit string.
     """
-    if x == 0:
-        return "0"
+    if x <= 0:
+        raise ValueError("Elias coding is defined only for positive integers")
 
     first_part = 1 + int(_log2(x))
     remainder = x - 2 ** int(_log2(x))
     bit_count = int(_log2(x))
+    suffix = _binary(remainder, bit_count) if bit_count else ""
 
-    return length_encoding(first_part) + _binary(remainder, bit_count)
+    return length_encoding(first_part) + suffix
 
 
 def elias_gamma(x: int) -> str:
     """Encode a positive integer using Elias gamma coding.
 
     Args:
-        x: A non-negative integer.
+        x: A positive integer.
 
     Returns:
         The Elias gamma coded bit string.
 
     Examples:
         >>> elias_gamma(1)
-        '0'
+        '1'
         >>> elias_gamma(5)
         '00101'
     """
@@ -100,14 +102,14 @@ def elias_delta(x: int) -> str:
     """Encode a positive integer using Elias delta coding.
 
     Args:
-        x: A non-negative integer.
+        x: A positive integer.
 
     Returns:
         The Elias delta coded bit string.
 
     Examples:
         >>> elias_delta(1)
-        '0'
+        '1'
         >>> elias_delta(5)
         '01101'
     """

algorithms/graph/find_all_cliques.py

@@ -51,4 +51,4 @@ def _get_connected(vertex: str, old_set: set[str]) -> set[str]:
 
     possibles = set(edges.keys())
     _expand_clique(possibles, set())
-    return solutions
+    return sorted(sorted(clique) for clique in solutions)

algorithms/graph/satisfiability.py

@@ -148,7 +148,7 @@ def solve_sat(
 
     Examples:
         >>> solve_sat([(('x', False), ('y', False)), (('x', True), ('y', True))])
-        {'x': False, 'y': False}
+        {'x': True, 'y': False}
     """
     graph = _build_graph(formula)
     vertex_scc = _scc(graph)

algorithms/graph/sudoku_solver.py

@@ -55,7 +55,9 @@ def _possible_values(self) -> dict[tuple[int, int], list[str]]:
                     val[(i, j)] = []
         for i, j in val:
             inval = (
-                d.get(("r", i), []) + d.get(("c", j), []) + d.get((i / 3, j / 3), [])
+                d.get(("r", i), [])
+                + d.get(("c", j), [])
+                + d.get((i // 3, j // 3), [])
             )
             val[(i, j)] = [n for n in a if n not in inval]
         return val
@@ -100,7 +102,7 @@ def _valid_one(
             if n in self.val[ind] and (
                 ind[0] == i
                 or ind[1] == j
-                or (ind[0] / 3, ind[1] / 3) == (i / 3, j / 3)
+                or (ind[0] // 3, ind[1] // 3) == (i // 3, j // 3)
             ):
                     update[ind] = n
                     self.val[ind].remove(n)

algorithms/graph/transitive_closure_dfs.py

@@ -48,7 +48,7 @@ def _dfs_util(self, source: int, target: int) -> None:
         """
         self.closure[source][target] = 1
 
-        for adjacent in self.graph[target]:
+        for adjacent in self.graph.get(target, []):
             if self.closure[source][adjacent] == 0:
                 self._dfs_util(source, adjacent)