Get rid of custom Enum (fixes #645)

cliquet/errors.py

@@ -1,31 +1,33 @@
 import six
 from pyramid import httpexceptions
+from enum import Enum
 
 from cliquet.logs import logger
-from cliquet.utils import Enum, json, reapply_cors, encode_header
-
-
-ERRORS = Enum(
-    MISSING_AUTH_TOKEN=104,
-    INVALID_AUTH_TOKEN=105,
-    BADJSON=106,
-    INVALID_PARAMETERS=107,
-    MISSING_PARAMETERS=108,
-    INVALID_POSTED_DATA=109,
-    INVALID_RESOURCE_ID=110,
-    MISSING_RESOURCE=111,
-    MISSING_CONTENT_LENGTH=112,
-    REQUEST_TOO_LARGE=113,
-    MODIFIED_MEANWHILE=114,
-    METHOD_NOT_ALLOWED=115,
-    VERSION_NOT_AVAILABLE=116,
-    CLIENT_REACHED_CAPACITY=117,
-    FORBIDDEN=121,
-    CONSTRAINT_VIOLATED=122,
-    UNDEFINED=999,
-    BACKEND=201,
-    SERVICE_DEPRECATED=202
-)
+from cliquet.utils import json, reapply_cors, encode_header
+
+
+class ERRORS(Enum):
+    MISSING_AUTH_TOKEN = 104
+    INVALID_AUTH_TOKEN = 105
+    BADJSON = 106
+    INVALID_PARAMETERS = 107
+    MISSING_PARAMETERS = 108
+    INVALID_POSTED_DATA = 109
+    INVALID_RESOURCE_ID = 110
+    MISSING_RESOURCE = 111
+    MISSING_CONTENT_LENGTH = 112
+    REQUEST_TOO_LARGE = 113
+    MODIFIED_MEANWHILE = 114
+    METHOD_NOT_ALLOWED = 115
+    VERSION_NOT_AVAILABLE = 116
+    CLIENT_REACHED_CAPACITY = 117
+    FORBIDDEN = 121
+    CONSTRAINT_VIOLATED = 122
+    UNDEFINED = 999
+    BACKEND = 201
+    SERVICE_DEPRECATED = 202
+
+
 """Predefined errors as specified by the protocol.
 
 +-------------+-------+------------------------------------------------+
@@ -88,6 +90,9 @@ def http_error(httpexception, errno=None,
     """
     errno = errno or ERRORS.UNDEFINED
 
+    if isinstance(errno, Enum):
+        errno = errno.value
+
     # Track error number for request summary
     logger.bind(errno=errno)
 
@@ -144,7 +149,7 @@ def json_error_handler(errors):
         message = '%(location)s: %(description)s' % error
 
     response = http_error(httpexceptions.HTTPBadRequest(),
-                          errno=ERRORS.INVALID_PARAMETERS,
+                          errno=ERRORS.INVALID_PARAMETERS.value,
                           error='Invalid parameters',
                           message=message,
                           details=errors)

cliquet/events.py

@@ -2,15 +2,21 @@
 
 import transaction
 from pyramid.events import NewRequest
+from enum import Enum
 
 from cliquet.logs import logger
-from cliquet.utils import strip_uri_prefix, Enum
+from cliquet.utils import strip_uri_prefix
 
 
-ACTIONS = Enum(CREATE='create',
-               DELETE='delete',
-               READ='read',
-               UPDATE='update')
+class ACTIONS(Enum):
+    CREATE = 'create'
+    DELETE = 'delete'
+    READ = 'read'
+    UPDATE = 'update'
+
+    @staticmethod
+    def from_string_list(elements):
+        return tuple(ACTIONS(el) for el in elements)
 
 
 class _ResourceEvent(object):
@@ -115,7 +121,8 @@ def notify_resource_event(request, timestamp, data, action, old=None):
     resource_name = request.current_resource_name
 
     # Add to impacted records or create new event.
-    group_by = resource_name + action
+    group_by = resource_name + action.value
+
     if group_by in events:
         if action == ACTIONS.READ:
             events[group_by].read_records.extend(impacted)

cliquet/initialization.py

@@ -397,14 +397,14 @@ def on_new_response(event):
 
 class EventActionFilter(object):
     def __init__(self, actions, config):
-        self.actions = actions
+        self.actions = [action.value for action in actions]
 
     def phash(self):
         return 'for_actions = %s' % (','.join(self.actions))
 
     def __call__(self, event):
         action = event.payload.get('action')
-        return not action or action in self.actions
+        return not action or action.value in self.actions
 
 
 class EventResourceFilter(object):
@@ -446,7 +446,12 @@ def setup_listeners(config):
             key = 'listeners.%s' % name
             listener = statsd_client.timer(key)(listener.__call__)
 
-        actions = aslist(settings.get(prefix + 'actions', '')) or write_actions
+        actions = aslist(settings.get(prefix + 'actions', ''))
+        if len(actions) > 0:
+            actions = ACTIONS.from_string_list(actions)
+        else:
+            actions = write_actions
+
         resource_names = aslist(settings.get(prefix + 'resources', ''))
         options = dict(for_actions=actions, for_resources=resource_names)
 

cliquet/resource/__init__.py

@@ -376,7 +376,8 @@ def put(self):
             existing = self._get_record_or_404(self.record_id)
         except HTTPNotFound:
             # Look if this record used to exist (for preconditions check).
-            filter_by_id = Filter(id_field, self.record_id, COMPARISON.EQ)
+            filter_by_id = Filter(id_field, self.record_id,
+                                  COMPARISON.EQ.value)
             tombstones, _ = self.model.get_records(filters=[filter_by_id],
                                                    include_deleted=True)
             if len(tombstones) > 0:
@@ -882,15 +883,15 @@ def _extract_filters(self, queryparams=None):
                     raise_invalid(self.request, **error_details)
 
                 if param == '_since':
-                    operator = COMPARISON.GT
+                    operator = COMPARISON.GT.value
                 else:
                     if param == '_to':
                         message = ('_to is now deprecated, '
                                    'you should use _before instead')
                         url = ('http://cliquet.rtfd.org/en/2.4.0/api/resource'
                                '.html#list-of-available-url-parameters')
                         send_alert(self.request, message, url)
-                    operator = COMPARISON.LT
+                    operator = COMPARISON.LT.value
                 filters.append(
                     Filter(self.model.modified_field, value, operator)
                 )
@@ -899,9 +900,9 @@ def _extract_filters(self, queryparams=None):
             m = re.match(r'^(min|max|not|lt|gt|in|exclude)_(\w+)$', param)
             if m:
                 keyword, field = m.groups()
-                operator = getattr(COMPARISON, keyword.upper())
+                operator = getattr(COMPARISON, keyword.upper()).value
             else:
-                operator, field = COMPARISON.EQ, param
+                operator, field = COMPARISON.EQ.value, param
 
             if not self.is_known_field(field):
                 error_details = {
@@ -911,7 +912,7 @@ def _extract_filters(self, queryparams=None):
                 raise_invalid(self.request, **error_details)
 
             value = native_value(paramvalue)
-            if operator in (COMPARISON.IN, COMPARISON.EXCLUDE):
+            if operator in (COMPARISON.IN.value, COMPARISON.EXCLUDE.value):
                 value = set([native_value(v) for v in paramvalue.split(',')])
 
             filters.append(Filter(field, value, operator))
@@ -957,14 +958,17 @@ def _build_pagination_rules(self, sorting, last_record, rules=None):
         next_sorting = sorting[:-1]
 
         for field, _ in next_sorting:
-            rule.append(Filter(field, last_record.get(field), COMPARISON.EQ))
+            rule.append(Filter(field, last_record.get(field),
+                               COMPARISON.EQ.value))
 
         field, direction = sorting[-1]
 
         if direction == -1:
-            rule.append(Filter(field, last_record.get(field), COMPARISON.LT))
+            rule.append(Filter(field, last_record.get(field),
+                               COMPARISON.LT.value))
         else:
-            rule.append(Filter(field, last_record.get(field), COMPARISON.GT))
+            rule.append(Filter(field, last_record.get(field),
+                               COMPARISON.GT.value))
 
         rules.append(rule)
 
@@ -1077,7 +1081,8 @@ def _extract_filters(self, queryparams=None):
 
         ids = self.context.shared_ids
         if ids:
-            filter_by_id = Filter(self.model.id_field, ids, COMPARISON.IN)
+            filter_by_id = Filter(self.model.id_field, ids,
+                                  COMPARISON.IN.value)
             filters.insert(0, filter_by_id)
 
         return filters

cliquet/storage/memory.py

@@ -91,22 +91,23 @@ def apply_filters(self, records, filters):
         """Filter the specified records, using basic iteration.
         """
         operators = {
-            COMPARISON.LT: operator.lt,
-            COMPARISON.MAX: operator.le,
-            COMPARISON.EQ: operator.eq,
-            COMPARISON.NOT: operator.ne,
-            COMPARISON.MIN: operator.ge,
-            COMPARISON.GT: operator.gt,
-            COMPARISON.IN: operator.contains,
-            COMPARISON.EXCLUDE: lambda x, y: not operator.contains(x, y),
+            COMPARISON.LT.value: operator.lt,
+            COMPARISON.MAX.value: operator.le,
+            COMPARISON.EQ.value: operator.eq,
+            COMPARISON.NOT.value: operator.ne,
+            COMPARISON.MIN.value: operator.ge,
+            COMPARISON.GT.value: operator.gt,
+            COMPARISON.IN.value: operator.contains,
+            COMPARISON.EXCLUDE.value: lambda x, y: not operator.contains(x, y),
         }
 
         for record in records:
             matches = True
             for f in filters:
                 left = record.get(f.field)
                 right = f.value
-                if f.operator in (COMPARISON.IN, COMPARISON.EXCLUDE):
+                if f.operator in (COMPARISON.IN.value,
+                                  COMPARISON.EXCLUDE.value):
                     right = left
                     left = f.value
                 matches = matches and operators[f.operator](left, right)
@@ -330,11 +331,11 @@ def get_unicity_rules(collection_id, parent_id, record, unique_fields,
         if value is None:
             continue
 
-        filters = [Filter(field, value, COMPARISON.EQ)]
+        filters = [Filter(field, value, COMPARISON.EQ.value)]
 
         if not for_creation:
             object_id = record[id_field]
-            exclude = Filter(id_field, object_id, COMPARISON.NOT)
+            exclude = Filter(id_field, object_id, COMPARISON.NOT.value)
             filters.append(exclude)
 
         rules.append(filters)

cliquet/storage/postgresql/__init__.py

@@ -566,10 +566,10 @@ def _format_conditions(self, filters, id_field, modified_field,
         :rtype: tuple
         """
         operators = {
-            COMPARISON.EQ: '=',
-            COMPARISON.NOT: '<>',
-            COMPARISON.IN: 'IN',
-            COMPARISON.EXCLUDE: 'NOT IN',
+            COMPARISON.EQ.value: '=',
+            COMPARISON.NOT.value: '<>',
+            COMPARISON.IN.value: 'IN',
+            COMPARISON.EXCLUDE.value: 'NOT IN',
         }
 
         conditions = []
@@ -589,7 +589,8 @@ def _format_conditions(self, filters, id_field, modified_field,
                 # If field is missing, we default to ''.
                 sql_field = "coalesce(data->>:%s, '')" % field_holder
 
-            if filtr.operator not in (COMPARISON.IN, COMPARISON.EXCLUDE):
+            if filtr.operator not in (COMPARISON.IN.value,
+                                      COMPARISON.EXCLUDE.value):
                 # For the IN operator, let psycopg escape the values list.
                 # Otherwise JSON-ify the native value (e.g. True -> 'true')
                 if not isinstance(filtr.value, six.string_types):
@@ -703,7 +704,7 @@ def _check_unicity(self, conn, collection_id, parent_id, record,
             if value is None:
                 continue
             sql, holders = self._format_conditions(
-                [Filter(field, value, COMPARISON.EQ)],
+                [Filter(field, value, COMPARISON.EQ.value)],
                 id_field,
                 modified_field,
                 prefix=field)
@@ -720,7 +721,7 @@ def _check_unicity(self, conn, collection_id, parent_id, record,
         if not for_creation:
             object_id = record[id_field]
             sql, holders = self._format_conditions(
-                [Filter(id_field, object_id, COMPARISON.NOT)],
+                [Filter(id_field, object_id, COMPARISON.NOT.value)],
                 id_field,
                 modified_field)
             safeholders['condition_record'] = sql

cliquet/tests/resource/test_events.py

@@ -277,19 +277,19 @@ def test_impacted_records_are_merged(self):
         self.assertEqual(len(self.events), 3)
 
         create_event = self.events[0]
-        self.assertEqual(create_event.payload['action'], 'create')
+        self.assertEqual(create_event.payload['action'], ACTIONS.CREATE)
         self.assertEqual(len(create_event.impacted_records), 1)
         self.assertNotIn('old', create_event.impacted_records[0])
         update_event = self.events[1]
-        self.assertEqual(update_event.payload['action'], 'update')
+        self.assertEqual(update_event.payload['action'], ACTIONS.UPDATE)
         impacted = update_event.impacted_records
         self.assertEqual(len(impacted), 2)
         self.assertEqual(impacted[0]['old']['name'], 'foo')
         self.assertEqual(impacted[0]['new']['name'], 'bar')
         self.assertEqual(impacted[1]['old']['name'], 'bar')
         self.assertEqual(impacted[1]['new']['name'], 'baz')
         delete_event = self.events[2]
-        self.assertEqual(delete_event.payload['action'], 'delete')
+        self.assertEqual(delete_event.payload['action'], ACTIONS.DELETE)
         self.assertEqual(len(delete_event.impacted_records), 1)
         self.assertNotIn('new', delete_event.impacted_records[0])
 

cliquet/tests/resource/test_filter.py

@@ -70,7 +70,7 @@ def test_filter_errors_are_json_formatted(self):
         except httpexceptions.HTTPBadRequest as e:
             error = e
         self.assertEqual(error.json, {
-            'errno': ERRORS.INVALID_PARAMETERS,
+            'errno': ERRORS.INVALID_PARAMETERS.value,
             'message': "querystring: Unknown filter field 'foo'",
             'code': 400,
             'error': 'Invalid parameters',

cliquet/tests/resource/test_preconditions.py

@@ -80,7 +80,7 @@ def test_preconditions_errors_are_json_formatted(self):
         except httpexceptions.HTTPPreconditionFailed as e:
             error = e
         self.assertEqual(error.json, {
-            'errno': ERRORS.MODIFIED_MEANWHILE,
+            'errno': ERRORS.MODIFIED_MEANWHILE.value,
             'details': {},
             'message': 'Resource was modified meanwhile',
             'code': 412,

cliquet/tests/resource/test_record.py

@@ -295,7 +295,7 @@ def assertReadonlyError(self, field):
         except httpexceptions.HTTPBadRequest as e:
             error = e
         self.assertEqual(error.json, {
-            'errno': ERRORS.INVALID_PARAMETERS,
+            'errno': ERRORS.INVALID_PARAMETERS.value,
             'message': 'Cannot modify {0}'.format(field),
             'code': 400,
             'error': 'Invalid parameters',

cliquet/tests/resource/test_sort.py

@@ -42,7 +42,7 @@ def test_filter_errors_are_json_formatted(self):
         except httpexceptions.HTTPBadRequest as e:
             error = e
         self.assertEqual(error.json, {
-            'errno': ERRORS.INVALID_PARAMETERS,
+            'errno': ERRORS.INVALID_PARAMETERS.value,
             'message': "querystring: Unknown sort field 'foo'",
             'code': 400,
             'error': 'Invalid parameters',