Merge pull request #20 from cisagov/bugfix/issue-19

Add support for Python 3.11

Author: felddy

.github/workflows/build.yml

@@ -112,11 +112,11 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.6"
           - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v3
       - id: setup-python
@@ -199,11 +199,11 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.6"
           - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v3
       - id: setup-python

.pre-commit-config.yaml

@@ -101,8 +101,8 @@ repos:
     rev: 22.3.0
     hooks:
       - id: black
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.2
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
     hooks:
       - id: flake8
         additional_dependencies:

src/lcgit/_version.py

@@ -1,2 +1,2 @@
 """This file defines the version of this module."""
-__version__ = "0.1.0"
+__version__ = "0.1.1"

src/lcgit/lcgit.py

@@ -13,7 +13,7 @@
 from collections.abc import Sequence
 from ipaddress import _BaseNetwork
 from math import sin
-from random import randint, shuffle
+from random import Random, randint
 
 
 def _lcg_params(u, v):
@@ -102,8 +102,11 @@ def __iter__(self):
         """
         seed = self.seed
         index = self.index
+
+        # The LCG algorithm requires a sequence of more than 4 elements to operate.
+        # If the sequence is not sufficiently large, we will fall back to the shuffle method.
         if self.seqlength > 4:
-            # use LCG
+            # Sequence is large enough to use LCG algorithm
             while index < self.seqlength:
                 while True:
                     seed = (seed * self.multiplier + self.increment) % self.modulus
@@ -115,12 +118,13 @@ def __iter__(self):
                 else:
                     yield self.seq[seed]
         else:
-            # use shuffle
+            # Sequence is too small to use LCG algorithm, use shuffle instead
             shuffled_seq = list(self.seq)
-            shuffle(
-                shuffled_seq,
-                random=lambda: abs(sin(self.multiplier + self.increment + seed)),
+            seeded_random = Random()
+            seeded_random.seed(
+                abs(sin(self.multiplier + self.increment + seed)), version=1
             )
+            seeded_random.shuffle(shuffled_seq)
             for i in shuffled_seq[index:]:
                 index += 1
                 if self.emit: