Resolve DeprecationWarning: Seeding based on hashing #656

bmos · 2024-03-11T00:30:53Z

When calling randomtable without providing a seed, the warning DeprecationWarning: Seeding based on hashing is deprecated since Python 3.9 and will be removed in a subsequent version. The only supported seed types are: None, int, float, str, bytes, and bytearray. is emitted.

This actually becomes a TypeError in 3.11 and 3.12.

closes #657

It also seems like we don't even need to provide a seed based on the documentation, but I stuck to the way it was implemented before (using a hashed version of the date).
2.7: https://docs.python.org/2.7/library/random.html#random.seed
3.12: https://docs.python.org/3.12/library/random.html#random.seed

I also noticed that the filename utils/random.py seems to be conflicting with python's random module. When debugging the doctests in that file, I had to rename it.

Changes

Add unit tests for randomtable, dummytable, and their supporting functions and classes and updated their doctests to pass.
Fix: DeprecationWarning: Seeding based on hashing is deprecated since Python 3.9 and will be removed in a subsequent version.

Checklist

Use this checklist to ensure the quality of pull requests that include new code and/or make changes to existing code.

github-advanced-security · 2024-03-11T00:36:26Z

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

coveralls · 2024-03-11T11:50:54Z

Pull Request Test Coverage Report for Build 8238402266

Details

56 of 58 (96.55%) changed or added relevant lines in 2 files are covered.
2 unchanged lines in 1 file lost coverage.
Overall coverage increased (+0.03%) to 91.072%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
petl/util/random.py	14	16	87.5%

Files with Coverage Reduction	New Missed Lines	%
petl/version.py	2	81.82%

Totals
Change from base Build 5940841807:	0.03%
Covered Lines:	13352
Relevant Lines:	14661

💛 - Coveralls

petl/util/random.py

petl/test/util/test_random.py

+    columns, rows = 3, 10
+    table = randomtable(columns, rows)
+
+    assert len(table[0]) == columns


petl/test/util/test_random.py

+    columns, rows = 4, 60
+    table = RandomTable(numflds=columns, numrows=rows, wait=0, seed=None)
+
+    assert len(table[0]) == columns


petl/test/util/test_random.py

+        fields=columns,
+    )
+    assert len(table[0]) == 4
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    table = randomtable(columns, rows)
+
+    assert len(table[0]) == columns
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    rows = 70
+    table = dummytable(numrows=rows, fields=None, wait=0, seed=None)
+
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+        numrows=rows,
+        seed=42
+    )
+    assert len(table[0]) == 3


petl/test/util/test_random.py

+    table = RandomTable(numflds=columns, numrows=rows, wait=0, seed=None)
+
+    assert len(table[0]) == columns
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    table = randomtable(columns, rows)
+
+    assert len(table[0]) == columns
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+        fields=columns,
+    )
+    assert len(table[0]) == 4
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    rows = 70
+    table = dummytable(numrows=rows, fields=None, wait=0, seed=None)
+
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+        numrows=rows,
+    )
+    assert len(table[0]) == 3
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    table = dummytable(
+        numrows=rows,
+    )
+    assert len(table[0]) == 3


petl/test/util/test_random.py

+        numrows=rows,
+        seed=42
+    )
+    assert len(table[0]) == 3


petl/test/util/test_random.py

+        seed=42
+    )
+    assert len(table[0]) == 3
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    table = RandomTable(numflds=columns, numrows=rows, wait=0, seed=None)
+
+    assert len(table[0]) == columns
+    assert len(table) == rows + 1


petl/test/util/test_random.py

+    rows = 35
+
+    table = dummytable(numrows=rows, fields=columns)
+    assert table[0] == ('count', 'pet', 'color', 'value')


petl/test/util/test_random.py

+    rows = 35
+
+    table = dummytable(numrows=rows, fields=columns)
+    assert table[0] == ('count', 'pet', 'color', 'value')


petl/test/util/test_random.py

…tions and classes.

… Python 3.9 and will be removed in a subsequent version.

petl/test/util/test_random.py

+
+    assert isinstance(seed_1, str)
+    assert seed_1 != ""
+    assert seed_1 != seed_2


petl/test/util/test_random.py

+    time.sleep(1)
+    seed_2 = randomseed()
+
+    assert isinstance(seed_1, str)


petl/test/util/test_random.py

+    seed_2 = randomseed()
+
+    assert isinstance(seed_1, str)
+    assert seed_1 != ""


petl/util/random.py


        # construct fields
-        flds = ['f%s' % n for n in range(nf)]
+        flds = ["f%s" % n for n in range(nf)]


petl/util/random.py

        yield tuple(flds)

        # construct data rows
        for _ in xrange(nr):
            # artificial delay
            if self.wait:
                time.sleep(self.wait)
-            yield tuple(random.random() for n in range(nf))
+            yield tuple(pyrandom.random() for n in range(nf))


petl/util/random.py

petl/test/util/test_random.py

@@ -0,0 +1,93 @@
+import random as pyrandom


petl/test/util/test_random.py

+    """
+    columns = (
+        ('count', partial(pyrandom.randint, 0, 100)),
+        ('pet', partial(pyrandom.choice, ['dog', 'cat', 'cow', ])),


petl/test/util/test_random.py

+    and that it accepts and uses custom column names provided.
+    """
+    columns = (
+        ('count', partial(pyrandom.randint, 0, 100)),


petl/test/util/test_random.py

+    columns = (
+        ('count', partial(pyrandom.randint, 0, 100)),
+        ('pet', partial(pyrandom.choice, ['dog', 'cat', 'cow', ])),
+        ('color', partial(pyrandom.choice, ['yellow', 'orange', 'brown'])),


petl/util/random.py

+        fields=(
+                ('foo', partial(pyrandom.randint, 0, 100)),
+                ('bar', partial(pyrandom.choice, ('apples', 'pears', 'bananas', 'oranges'))),
+                ('baz', pyrandom.random),


petl/util/random.py

+        numrows=100,
+        fields=(
+                ('foo', partial(pyrandom.randint, 0, 100)),
+                ('bar', partial(pyrandom.choice, ('apples', 'pears', 'bananas', 'oranges'))),


petl/test/util/test_random.py

+    and that it accepts and uses custom column names provided.
+    """
+    columns = (
+        ('count', partial(pyrandom.randint, 0, 100)),


petl/test/util/test_random.py

+    columns = (
+        ('count', partial(pyrandom.randint, 0, 100)),
+        ('pet', partial(pyrandom.choice, ['dog', 'cat', 'cow', ])),
+        ('color', partial(pyrandom.choice, ['yellow', 'orange', 'brown'])),


petl/test/util/test_random.py

+    """
+    columns = (
+        ('count', partial(pyrandom.randint, 0, 100)),
+        ('pet', partial(pyrandom.choice, ['dog', 'cat', 'cow', ])),


petl/test/util/test_random.py

@@ -0,0 +1,93 @@
+import random as pyrandom


juarezr

Looks good to me

bmos mentioned this pull request Mar 11, 2024

Documentation discrepancy regarding supported Python versions move-coop/parsons#932

Closed

bmos marked this pull request as ready for review March 11, 2024 02:01