week06

env/lib/python3.12/site-packages/gitlab/v4/objects/variables.py

@@ -0,0 +1,83 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/instance_level_ci_variables.html
+https://docs.gitlab.com/ee/api/project_level_variables.html
+https://docs.gitlab.com/ee/api/group_level_variables.html
+"""
+
+from typing import Any, cast, Union
+
+from gitlab.base import RESTManager, RESTObject
+from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
+from gitlab.types import RequiredOptional
+
+__all__ = [
+    "Variable",
+    "VariableManager",
+    "GroupVariable",
+    "GroupVariableManager",
+    "ProjectVariable",
+    "ProjectVariableManager",
+]
+
+
+class Variable(SaveMixin, ObjectDeleteMixin, RESTObject):
+    _id_attr = "key"
+
+
+class VariableManager(CRUDMixin, RESTManager):
+    _path = "/admin/ci/variables"
+    _obj_cls = Variable
+    _create_attrs = RequiredOptional(
+        required=("key", "value"), optional=("protected", "variable_type", "masked")
+    )
+    _update_attrs = RequiredOptional(
+        required=("key", "value"), optional=("protected", "variable_type", "masked")
+    )
+
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Variable:
+        return cast(Variable, super().get(id=id, lazy=lazy, **kwargs))
+
+
+class GroupVariable(SaveMixin, ObjectDeleteMixin, RESTObject):
+    _id_attr = "key"
+
+
+class GroupVariableManager(CRUDMixin, RESTManager):
+    _path = "/groups/{group_id}/variables"
+    _obj_cls = GroupVariable
+    _from_parent_attrs = {"group_id": "id"}
+    _create_attrs = RequiredOptional(
+        required=("key", "value"), optional=("protected", "variable_type", "masked")
+    )
+    _update_attrs = RequiredOptional(
+        required=("key", "value"), optional=("protected", "variable_type", "masked")
+    )
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> GroupVariable:
+        return cast(GroupVariable, super().get(id=id, lazy=lazy, **kwargs))
+
+
+class ProjectVariable(SaveMixin, ObjectDeleteMixin, RESTObject):
+    _id_attr = "key"
+
+
+class ProjectVariableManager(CRUDMixin, RESTManager):
+    _path = "/projects/{project_id}/variables"
+    _obj_cls = ProjectVariable
+    _from_parent_attrs = {"project_id": "id"}
+    _create_attrs = RequiredOptional(
+        required=("key", "value"),
+        optional=("protected", "variable_type", "masked", "environment_scope"),
+    )
+    _update_attrs = RequiredOptional(
+        required=("key", "value"),
+        optional=("protected", "variable_type", "masked", "environment_scope"),
+    )
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectVariable:
+        return cast(ProjectVariable, super().get(id=id, lazy=lazy, **kwargs))