feat(api): convert gitlab.const to Enums

jspricke · jspricke · commit 27e839ae9050 · 2021-11-12T08:27:43.000+01:00
This allows accessing the elements by value, i.e.:

import gitlab.const
gitlab.const.AccessLevel(20)
diff --git a/gitlab/const.py b/gitlab/const.py
@@ -15,10 +15,13 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from enum import Enum
+
 from gitlab.__version__ import __title__, __version__
 
 DEFAULT_URL: str = "https://gitlab.com"
 
+# TODO: deprecate these in favor of AccessLevel
 NO_ACCESS: int = 0
 MINIMAL_ACCESS: int = 5
 GUEST_ACCESS: int = 10
@@ -27,17 +30,48 @@
 MAINTAINER_ACCESS: int = 40
 OWNER_ACCESS: int = 50
 
+
+class AccessLevel(Enum):
+    NO_ACCESS: int = 0
+    MINIMAL_ACCESS: int = 5
+    GUEST_ACCESS: int = 10
+    REPORTER_ACCESS: int = 20
+    DEVELOPER_ACCESS: int = 30
+    MAINTAINER_ACCESS: int = 40
+    OWNER_ACCESS: int = 50
+
+
+# TODO: deprecate these in favor of Visibility
 VISIBILITY_PRIVATE: str = "private"
 VISIBILITY_INTERNAL: str = "internal"
 VISIBILITY_PUBLIC: str = "public"
 
+
+class Visibility(Enum):
+    VISIBILITY_PRIVATE: str = "private"
+    VISIBILITY_INTERNAL: str = "internal"
+    VISIBILITY_PUBLIC: str = "public"
+
+
+# TODO: deprecate these in favor of NotificationLevel
 NOTIFICATION_LEVEL_DISABLED: str = "disabled"
 NOTIFICATION_LEVEL_PARTICIPATING: str = "participating"
 NOTIFICATION_LEVEL_WATCH: str = "watch"
 NOTIFICATION_LEVEL_GLOBAL: str = "global"
 NOTIFICATION_LEVEL_MENTION: str = "mention"
 NOTIFICATION_LEVEL_CUSTOM: str = "custom"
 
+
+class NotificationLevel(Enum):
+    NOTIFICATION_LEVEL_DISABLED: str = "disabled"
+    NOTIFICATION_LEVEL_PARTICIPATING: str = "participating"
+    NOTIFICATION_LEVEL_WATCH: str = "watch"
+    NOTIFICATION_LEVEL_GLOBAL: str = "global"
+    NOTIFICATION_LEVEL_MENTION: str = "mention"
+    NOTIFICATION_LEVEL_CUSTOM: str = "custom"
+
+
+# TODO: deprecate these in favor of SearchScope
 # Search scopes
 # all scopes (global, group and  project)
 SEARCH_SCOPE_PROJECTS: str = "projects"
@@ -49,6 +83,20 @@
 SEARCH_SCOPE_BLOBS: str = "blobs"
 SEARCH_SCOPE_USERS: str = "users"
 
+
+# Search scopes
+# all scopes (global, group and  project)
+class SearchScope(Enum):
+    SEARCH_SCOPE_PROJECTS: str = "projects"
+    SEARCH_SCOPE_ISSUES: str = "issues"
+    SEARCH_SCOPE_MERGE_REQUESTS: str = "merge_requests"
+    SEARCH_SCOPE_MILESTONES: str = "milestones"
+    SEARCH_SCOPE_WIKI_BLOBS: str = "wiki_blobs"
+    SEARCH_SCOPE_COMMITS: str = "commits"
+    SEARCH_SCOPE_BLOBS: str = "blobs"
+    SEARCH_SCOPE_USERS: str = "users"
+
+
 # specific global scope
 SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES: str = "snippet_titles"
 
