Fix flake8 errors and add it to CI (#45)

* Fix flake8 errors and add it to CI
* Use extras for test dependencies

Co-authored-by: Fantix King <[email protected]>

Author: hukkinj1

.github/workflows/tests.yml

@@ -49,5 +49,6 @@ jobs:
     - name: Test
       if: steps.release.outputs.version == 0
       run: |
-        pip install -e .
+        pip install -e .[test]
+        flake8 immutables/ tests/
         python -m unittest -v tests.suite

immutables/map.py

@@ -46,10 +46,12 @@ def map_bitindex(bitmap, bit):
 W_EMPTY, W_NEWNODE, W_NOT_FOUND = range(3)
 void = object()
 
+
 class _Unhashable:
     __slots__ = ()
     __hash__ = None
 
+
 _NULL = _Unhashable()
 del _Unhashable
 

setup.py

@@ -3,6 +3,19 @@
 import setuptools
 
 
+# Minimal dependencies required to test immutables.
+TEST_DEPENDENCIES = [
+    # pycodestyle is a dependency of flake8, but it must be frozen because
+    # their combination breaks too often
+    # (example breakage: https://gitlab.com/pycqa/flake8/issues/427)
+    'flake8~=3.8.4',
+    'pycodestyle~=2.6.0',
+]
+
+EXTRA_DEPENDENCIES = {
+    'test': TEST_DEPENDENCIES,
+}
+
 CFLAGS = ['-O2']
 if platform.uname().system != 'Windows':
     CFLAGS.extend(['-std=c99', '-fsigned-char', '-Wall',
@@ -73,4 +86,5 @@
     provides=['immutables'],
     include_package_data=True,
     ext_modules=ext_modules,
+    extras_require=EXTRA_DEPENDENCIES,
 )

tests/test_issue24.py

@@ -51,7 +51,7 @@ def test_bitmap_node_update_in_place_count(self):
         d = m.__dump__().splitlines()
         self.assertTrue(d)
         if d[0].startswith('HAMT'):
-            header = d[1] # skip _map.Map.__dump__() header
+            header = d[1]  # skip _map.Map.__dump__() header
         else:
             header = d[0]
         self.dump_check_bitmap_node_count(header, 7)
@@ -66,7 +66,7 @@ def test_bitmap_node_delete_in_place_count(self):
         d = m2.__dump__().splitlines()
         self.assertTrue(d)
         if d[0].startswith('HAMT'):
-            header = d[1] # skip _map.Map.__dump__() header
+            header = d[1]  # skip _map.Map.__dump__() header
         else:
             header = d[0]
         self.dump_check_bitmap_node_count(header, 4)
@@ -79,7 +79,7 @@ def test_collision_node_update_in_place_count(self):
         self.assertTrue(len(d) > 3)
         # get node headers
         if d[0].startswith('HAMT'):
-            h1, h2 = d[1], d[3] # skip _map.Map.__dump__() header
+            h1, h2 = d[1], d[3]  # skip _map.Map.__dump__() header
         else:
             h1, h2 = d[0], d[2]
         self.dump_check_node_kind(h1, 'Bitmap')
@@ -96,12 +96,13 @@ def test_collision_node_delete_in_place_count(self):
         self.assertTrue(len(d) > 3)
         # get node headers
         if d[0].startswith('HAMT'):
-            h1, h2 = d[1], d[3] # skip _map.Map.__dump__() header
+            h1, h2 = d[1], d[3]  # skip _map.Map.__dump__() header
         else:
             h1, h2 = d[0], d[2]
         self.dump_check_node_kind(h1, 'Bitmap')
         self.dump_check_collision_node_count(h2, 4)
 
+
 try:
     from immutables._map import Map as CMap
 except ImportError:

tests/test_map.py

@@ -7,7 +7,12 @@
 import weakref
 
 from immutables.map import Map as PyMap
-from immutables._testutils import *  # NoQA
+from immutables._testutils import EqError
+from immutables._testutils import HashKey
+from immutables._testutils import HashKeyCrasher
+from immutables._testutils import HashingError
+from immutables._testutils import KeyStr
+from immutables._testutils import ReprError
 
 
 class BaseMapTest:
@@ -159,8 +164,6 @@ def test_map_collision_2(self):
         #                             <Key name:E hash:362244>: 'e'
         #     <Key name:B hash:101>: 'b'
 
-
-
     def test_map_stress_01(self):
         COLLECTION_SIZE = 7000
         TEST_ITERS_EVERY = 647
@@ -1235,7 +1238,6 @@ def test_map_mut_20(self):
             # node to be converted into an array node
             h = h.set(HashKey(i, i), i)
 
-
         h = h.set(HashKey(18, '18-collision'), 18)
 
         with h.mutate() as m:
@@ -1348,7 +1350,9 @@ def test_map_pickle(self):
         with self.assertRaisesRegex(TypeError, "can('t|not) pickle"):
             pickle.dumps(h.mutate())
 
-    @unittest.skipIf(sys.version_info < (3, 7, 0), "__class_getitem__ is not available")
+    @unittest.skipIf(
+        sys.version_info < (3, 7, 0), "__class_getitem__ is not available"
+    )
     def test_map_is_subscriptable(self):
         self.assertIs(self.Map[int, str], self.Map)
 

tests/test_none_keys.py

@@ -1,7 +1,7 @@
 import unittest
 
 from immutables.map import map_hash, map_mask, Map as PyMap
-from immutables._testutils import *  # NoQA
+from immutables._testutils import HashKey
 
 
 none_hash = map_hash(None)
@@ -342,7 +342,7 @@ def test_collision_4(self):
         self.assertTrue(key4 in m3)
         self.assertEqual(m3[key2], 2)
         self.assertEqual(m3[key4], 4)
-        self.assertFalse(None in  m3)
+        self.assertFalse(None in m3)
         with self.assertRaises(KeyError):
             m3.delete(None)
 
@@ -352,7 +352,7 @@ def test_collision_4(self):
         self.assertTrue(key4 in m3)
         self.assertEqual(m3[None], 9)
         self.assertEqual(m3[key4], 4)
-        self.assertFalse(key2 in  m3)
+        self.assertFalse(key2 in m3)
         with self.assertRaises(KeyError):
             m3.delete(key2)
 
@@ -362,7 +362,7 @@ def test_collision_4(self):
         self.assertTrue(key2 in m3)
         self.assertEqual(m3[None], 9)
         self.assertEqual(m3[key2], 2)
-        self.assertFalse(key4 in  m3)
+        self.assertFalse(key4 in m3)
         with self.assertRaises(KeyError):
             m3.delete(key4)