refactor: do not recommend plain gitlab.const constants

nejch · JohnVillalovos · commit d65213385a6f · 2022-06-27T16:36:23.000-07:00
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -43,9 +43,9 @@ def __getattr__(name: str) -> Any:
     if name in gitlab.const._DEPRECATED:
         _utils.warn(
             message=(
-                f"\nDirect access to 'gitlab.{name}' is deprecated and will be "
-                f"removed in a future major python-gitlab release. Please "
-                f"use 'gitlab.const.{name}' instead."
+                f"\nDirect access to constants as 'gitlab.{name}' is deprecated and "
+                f"will be removed in a future major python-gitlab release. Please "
+                f"see the usage of constants in the 'gitlab.const' module instead."
             ),
             category=DeprecationWarning,
         )
diff --git a/gitlab/const.py b/gitlab/const.py
@@ -56,6 +56,10 @@
 ]
 
 
+class GitlabEnum(str, Enum):
+    """An enum mixed in with str to make it JSON-serializable."""
+
+
 # https://gitlab.com/gitlab-org/gitlab/-/blob/e97357824bedf007e75f8782259fe07435b64fbb/lib/gitlab/access.rb#L12-18
 class AccessLevel(IntEnum):
     NO_ACCESS: int = 0
@@ -69,13 +73,13 @@ class AccessLevel(IntEnum):
 
 
 # https://gitlab.com/gitlab-org/gitlab/-/blob/e97357824bedf007e75f8782259fe07435b64fbb/lib/gitlab/visibility_level.rb#L23-25
-class Visibility(Enum):
+class Visibility(GitlabEnum):
     PRIVATE: str = "private"
     INTERNAL: str = "internal"
     PUBLIC: str = "public"
 
 
-class NotificationLevel(Enum):
+class NotificationLevel(GitlabEnum):
     DISABLED: str = "disabled"
     PARTICIPATING: str = "participating"
     WATCH: str = "watch"
@@ -85,7 +89,7 @@ class NotificationLevel(Enum):
 
 
 # https://gitlab.com/gitlab-org/gitlab/-/blob/e97357824bedf007e75f8782259fe07435b64fbb/app/views/search/_category.html.haml#L10-37
-class SearchScope(Enum):
+class SearchScope(GitlabEnum):
     # all scopes (global, group and  project)
     PROJECTS: str = "projects"
     ISSUES: str = "issues"
