Merge pull request #24 from jamescooke/enums

Enums

flake8_aaa/act_block.py

@@ -1,23 +1,20 @@
 from .exceptions import NotActionBlock
 from .helpers import node_is_pytest_raises, node_is_result_assignment
+from .types import ActBlockType
 
 
 class ActBlock:
     """
     Attributes:
         node
-        block_type (str)
+        block_type (ActBlockType)
     """
 
-    MARKED_ACT = 'marked_act'
-    PYTEST_RAISES = 'pytest_raises'
-    RESULT_ASSIGNMENT = 'result_assignment'
-
     def __init__(self, node, block_type):
         """
         Args:
             node
-            block_type (str)
+            block_type (ActBlockType)
         """
         self.node = node
         self.block_type = block_type
@@ -35,12 +32,12 @@ def build(obj, node):
             NotActionBlock: When ``node`` does not look like an Act block.
         """
         if node_is_result_assignment(node):
-            return obj(node, obj.RESULT_ASSIGNMENT)
+            return obj(node, ActBlockType.result_assignment)
         elif node_is_pytest_raises(node):
-            return obj(node, obj.PYTEST_RAISES)
+            return obj(node, ActBlockType.pytest_raises)
 
         # Check if line marked with '# act'
         if node.first_token.line.strip().endswith('# act'):
-            return obj(node, obj.MARKED_ACT)
+            return obj(node, ActBlockType.marked_act)
 
         raise NotActionBlock()

flake8_aaa/function.py

@@ -1,6 +1,7 @@
 from .act_block import ActBlock
 from .exceptions import NotActionBlock, ValidationError
 from .helpers import function_is_noop
+from .types import ActBlockType
 
 
 class Function:
@@ -52,7 +53,7 @@ def load_act_block(self):
         # are `pytest.raises` blocks that are not the first.
         if len(act_blocks) > 1:
             act_blocks = [act_blocks[0]
-                          ] + list(filter(lambda ab: ab.block_type != ActBlock.PYTEST_RAISES, act_blocks[1:]))
+                          ] + list(filter(lambda ab: ab.block_type != ActBlockType.pytest_raises, act_blocks[1:]))
 
         if len(act_blocks) < 1:
             raise ValidationError(self.node.lineno, self.node.col_offset, 'AAA01 no Act block found in test')

flake8_aaa/types.py

@@ -0,0 +1,3 @@
+from enum import Enum
+
+ActBlockType = Enum('ActBlockType', 'marked_act pytest_raises result_assignment')

setup.py

@@ -32,6 +32,8 @@ def readme():
     py_modules=['flake8_aaa'],
     install_requires=[
         'asttokens >= 1.1.10',
+        # Skip enum34 because it's not needed for py3 and because flake8 will
+        # install it for py2.
         'flake8 >= 3',
     ],
     entry_points={

tests/act_block/test_build.py

@@ -2,6 +2,7 @@
 
 from flake8_aaa.act_block import ActBlock
 from flake8_aaa.exceptions import NotActionBlock
+from flake8_aaa.types import ActBlockType
 
 # TODO act blocks need testing with 'result =' indented
 # TODO act blocks need testing with indentation in general
@@ -21,14 +22,14 @@ def test_raises_block(first_node_with_tokens):
 
     assert isinstance(result, ActBlock)
     assert result.node == first_node_with_tokens.body[0]
-    assert result.block_type == ActBlock.PYTEST_RAISES
+    assert result.block_type == ActBlockType.pytest_raises
 
 
 @pytest.mark.parametrize(
     'code_str, expected_type', [
-        ('result = do_thing()', ActBlock.RESULT_ASSIGNMENT),
-        ('with pytest.raises(Exception):\n    do_thing()', ActBlock.PYTEST_RAISES),
-        ('data[new_key] = value  # act', ActBlock.MARKED_ACT),
+        ('result = do_thing()', ActBlockType.result_assignment),
+        ('with pytest.raises(Exception):\n    do_thing()', ActBlockType.pytest_raises),
+        ('data[new_key] = value  # act', ActBlockType.marked_act),
     ]
 )
 def test(expected_type, first_node_with_tokens):

tests/act_block/test_init.py

@@ -1,12 +1,13 @@
 import ast
 
 from flake8_aaa.act_block import ActBlock
+from flake8_aaa.types import ActBlockType
 
 
 def test():
     node = ast.parse('result = do_thing()').body[0]
 
-    result = ActBlock(node, 'result_assignment')
+    result = ActBlock(node, ActBlockType.result_assignment)
 
     assert result.node == node
-    assert result.block_type == ActBlock.RESULT_ASSIGNMENT
+    assert result.block_type == ActBlockType.result_assignment

tests/function/test_load_act_block.py

@@ -2,6 +2,7 @@
 
 from flake8_aaa.act_block import ActBlock
 from flake8_aaa.exceptions import ValidationError
+from flake8_aaa.types import ActBlockType
 
 
 @pytest.mark.parametrize('code_str', ['''
@@ -14,7 +15,7 @@ def test_assignment(function):
     result = function.load_act_block()
 
     assert isinstance(result, ActBlock)
-    assert result.block_type == ActBlock.RESULT_ASSIGNMENT
+    assert result.block_type == ActBlockType.result_assignment
     assert result.node.first_token.line == '    result = 1\n'
 
 
@@ -28,7 +29,7 @@ def test_act_marker(function):
     result = function.load_act_block()
 
     assert isinstance(result, ActBlock)
-    assert result.block_type == ActBlock.MARKED_ACT
+    assert result.block_type == ActBlockType.marked_act
     assert result.node.first_token.line == '    x = y + 1  # act\n'
 
 
@@ -49,7 +50,7 @@ def test_raises_in_assert(function):
     result = function.load_act_block()
 
     assert isinstance(result, ActBlock)
-    assert result.block_type == ActBlock.RESULT_ASSIGNMENT
+    assert result.block_type == ActBlockType.result_assignment
     assert result.node.first_token.line == '    result = existing_user.delete()\n'
 
 

tox.ini

@@ -11,6 +11,7 @@ deps =
     test,lint: -rrequirements/test.txt
 commands =
     install: flake8 --version
+    install: flake8 tests
     test: pytest
     lint: make lint
 setenv = IN_TOX = 1