Introduced BaseIntEnum

This has helper method isin() to check specified parameter is set in its Enum object

Author: userlocalhost

airone/lib/acl.py

@@ -1,18 +1,20 @@
 import enum
 
+from airone.lib.types import BaseIntEnum
+
 __all__ = ["ACLType", "ACLObjType"]
 
 
 @enum.unique
-class ACLObjType(enum.IntEnum):
+class ACLObjType(BaseIntEnum):
     Entity = 1 << 0
     EntityAttr = 1 << 1
     Entry = 1 << 2
     EntryAttr = 1 << 3
     Category = 1 << 4
 
 
-class ACLType(enum.IntEnum):
+class ACLType(BaseIntEnum):
     Nothing = 1 << 0
     Readable = 1 << 1
     Writable = 1 << 2

airone/lib/elasticsearch.py

@@ -10,7 +10,7 @@
 
 from airone.lib.acl import ACLType
 from airone.lib.log import Logger
-from airone.lib.types import AttrType
+from airone.lib.types import AttrType, BaseIntEnum
 from entity.models import Entity
 from entry.settings import CONFIG
 from user.models import User
@@ -42,7 +42,7 @@ class AdvancedSearchResults(BaseModel):
 
 
 @enum.unique
-class FilterKey(enum.IntEnum):
+class FilterKey(BaseIntEnum):
     CLEARED = 0
     EMPTY = 1
     NON_EMPTY = 2

airone/lib/types.py

@@ -2,8 +2,14 @@
 from typing import Any
 
 
+class BaseIntEnum(enum.IntEnum):
+    @classmethod
+    def isin(cls, v):
+        return v in cls.__members__.values()
+
+
 @enum.unique
-class AttrType(enum.IntEnum):
+class AttrType(BaseIntEnum):
     OBJECT = 1 << 0
     STRING = 1 << 1
     TEXT = 1 << 2

entry/api_v2/views.py

@@ -860,10 +860,10 @@ def _validate_attrinfo(self):
             for info in json_loaded_value:
                 if not any(x in info for x in ["name", "filterKey", "keyword"]):
                     raise RequiredParameterError("(00)Invalid attrinfo was specified")
-                if not FilterKey(int(info["filterKey"])):
+                if not FilterKey.isin(int(info["filterKey"])):
                     raise RequiredParameterError("(01)Invalid attrinfo was specified")
         except Exception as e:
-            raise RequiredParameterError("(E0)Invalid attrinfo was specified (%s)" % str(e))
+            raise RequiredParameterError(e)
 
         return json_loaded_value
 

entry/tests/test_api_v2.py

@@ -4928,11 +4928,8 @@ def test_delete_entries_with_all_parameter_and_attrinfo(self):
         # send request to delete all items with attrinfo
         attrinfo_as_str = json.dumps(
             [
-                {
-                    "name": "val",
-                    "keyword": "hoge",
-                    "filterKey": "3",
-                }
+                {"name": "ref", "keyword": "", "filterKey": "0"},
+                {"name": "val", "keyword": "hoge", "filterKey": "3"},
             ]
         )
         resp = self.client.delete(

job/models.py

@@ -15,6 +15,7 @@
 from acl.models import ACLBase
 from airone.lib import auto_complement
 from airone.lib.log import Logger
+from airone.lib.types import BaseIntEnum
 from entity.models import Entity
 from entry.models import Entry
 from job.settings import CONFIG as JOB_CONFIG
@@ -36,7 +37,7 @@
     CUSTOM_PARALLELIZABLE_OPERATIONS = []
     CUSTOM_TASKS = {}
 
-    class JobOperationCustom(enum.IntEnum):  # type: ignore
+    class JobOperationCustom(BaseIntEnum):  # type: ignore
         pass
 
 
@@ -47,7 +48,7 @@ def _support_time_default(o):
 
 
 @enum.unique
-class JobOperation(enum.IntEnum):
+class JobOperation(BaseIntEnum):
     # Constant to describes status of each jobs
     CREATE_ENTRY = 1
     EDIT_ENTRY = 2
@@ -82,14 +83,14 @@ class JobOperation(enum.IntEnum):
 
 
 @enum.unique
-class JobTarget(enum.IntEnum):
+class JobTarget(BaseIntEnum):
     UNKNOWN = 0
     ENTRY = 1
     ENTITY = 2
 
 
 @enum.unique
-class JobStatus(enum.IntEnum):
+class JobStatus(BaseIntEnum):
     PREPARING = 1
     DONE = 2
     ERROR = 3