python-gitlab 5.6.0__py3-none-any.whl → 6.0.0__py3-none-any.whl

gitlab/v4/objects/job_token_scope.py

@@ -1,6 +1,8 @@
-from typing import Any, cast
+from __future__ import annotations
 
-from gitlab.base import RESTManager, RESTObject
+from typing import cast
+
+from gitlab.base import RESTObject
 from gitlab.mixins import (
     CreateMixin,
     DeleteMixin,
@@ -14,28 +16,24 @@ from gitlab.mixins import (
 )
 from gitlab.types import RequiredOptional
 
-__all__ = [
-    "ProjectJobTokenScope",
-    "ProjectJobTokenScopeManager",
-]
+__all__ = ["ProjectJobTokenScope", "ProjectJobTokenScopeManager"]
 
 
 class ProjectJobTokenScope(RefreshMixin, SaveMixin, RESTObject):
     _id_attr = None
 
-    allowlist: "AllowlistProjectManager"
-    groups_allowlist: "AllowlistGroupManager"
+    allowlist: AllowlistProjectManager
+    groups_allowlist: AllowlistGroupManager
 
 
-class ProjectJobTokenScopeManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
+class ProjectJobTokenScopeManager(
+    GetWithoutIdMixin[ProjectJobTokenScope], UpdateMixin[ProjectJobTokenScope]
+):
     _path = "/projects/{project_id}/job_token_scope"
     _obj_cls = ProjectJobTokenScope
     _from_parent_attrs = {"project_id": "id"}
     _update_method = UpdateMethod.PATCH
 
-    def get(self, **kwargs: Any) -> ProjectJobTokenScope:
-        return cast(ProjectJobTokenScope, super().get(**kwargs))
-
 
 class AllowlistProject(ObjectDeleteMixin, RESTObject):
     _id_attr = "target_project_id"  # note: only true for create endpoint
@@ -50,7 +48,11 @@ class AllowlistProject(ObjectDeleteMixin, RESTObject):
         return cast(int, self.id)
 
 
-class AllowlistProjectManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
+class AllowlistProjectManager(
+    ListMixin[AllowlistProject],
+    CreateMixin[AllowlistProject],
+    DeleteMixin[AllowlistProject],
+):
     _path = "/projects/{project_id}/job_token_scope/allowlist"
     _obj_cls = AllowlistProject
     _from_parent_attrs = {"project_id": "project_id"}
@@ -70,7 +72,9 @@ class AllowlistGroup(ObjectDeleteMixin, RESTObject):
         return cast(int, self.id)
 
 
-class AllowlistGroupManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
+class AllowlistGroupManager(
+    ListMixin[AllowlistGroup], CreateMixin[AllowlistGroup], DeleteMixin[AllowlistGroup]
+):
     _path = "/projects/{project_id}/job_token_scope/groups_allowlist"
     _obj_cls = AllowlistGroup
     _from_parent_attrs = {"project_id": "project_id"}

gitlab/v4/objects/jobs.py

@@ -1,35 +1,23 @@
-from typing import (
-    Any,
-    Callable,
-    cast,
-    Dict,
-    Iterator,
-    Literal,
-    Optional,
-    overload,
-    TYPE_CHECKING,
-    Union,
-)
+from __future__ import annotations
+
+from typing import Any, Callable, Iterator, Literal, overload, TYPE_CHECKING
 
 import requests
 
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab import utils
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import RefreshMixin, RetrieveMixin
 from gitlab.types import ArrayAttribute
 
-__all__ = [
-    "ProjectJob",
-    "ProjectJobManager",
-]
+__all__ = ["ProjectJob", "ProjectJobManager"]
 
 
 class ProjectJob(RefreshMixin, RESTObject):
     @cli.register_custom_action(cls_names="ProjectJob")
     @exc.on_http_error(exc.GitlabJobCancelError)
-    def cancel(self, **kwargs: Any) -> Dict[str, Any]:
+    def cancel(self, **kwargs: Any) -> dict[str, Any]:
         """Cancel the job.
 
         Args:
@@ -47,7 +35,7 @@ class ProjectJob(RefreshMixin, RESTObject):
 
     @cli.register_custom_action(cls_names="ProjectJob")
     @exc.on_http_error(exc.GitlabJobRetryError)
-    def retry(self, **kwargs: Any) -> Dict[str, Any]:
+    def retry(self, **kwargs: Any) -> dict[str, Any]:
         """Retry the job.
 
         Args:
@@ -152,7 +140,7 @@ class ProjectJob(RefreshMixin, RESTObject):
     def artifacts(
         self,
         streamed: Literal[True] = True,
-        action: Optional[Callable[[bytes], Any]] = None,
+        action: Callable[[bytes], Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: Literal[False] = False,
@@ -164,12 +152,12 @@ class ProjectJob(RefreshMixin, RESTObject):
     def artifacts(
         self,
         streamed: bool = False,
-        action: Optional[Callable[..., Any]] = None,
+        action: Callable[..., Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: bool = False,
         **kwargs: Any,
-    ) -> Optional[Union[bytes, Iterator[Any]]]:
+    ) -> bytes | Iterator[Any] | None:
         """Get the job artifacts.
 
         Args:
@@ -229,7 +217,7 @@ class ProjectJob(RefreshMixin, RESTObject):
         self,
         path: str,
         streamed: Literal[True] = True,
-        action: Optional[Callable[[bytes], Any]] = None,
+        action: Callable[[bytes], Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: Literal[False] = False,
@@ -242,12 +230,12 @@ class ProjectJob(RefreshMixin, RESTObject):
         self,
         path: str,
         streamed: bool = False,
-        action: Optional[Callable[..., Any]] = None,
+        action: Callable[..., Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: bool = False,
         **kwargs: Any,
-    ) -> Optional[Union[bytes, Iterator[Any]]]:
+    ) -> bytes | Iterator[Any] | None:
         """Get a single artifact file from within the job's artifacts archive.
 
         Args:
@@ -305,7 +293,7 @@ class ProjectJob(RefreshMixin, RESTObject):
     def trace(
         self,
         streamed: Literal[True] = True,
-        action: Optional[Callable[[bytes], Any]] = None,
+        action: Callable[[bytes], Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: Literal[False] = False,
@@ -317,12 +305,12 @@ class ProjectJob(RefreshMixin, RESTObject):
     def trace(
         self,
         streamed: bool = False,
-        action: Optional[Callable[..., Any]] = None,
+        action: Callable[..., Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: bool = False,
         **kwargs: Any,
-    ) -> Optional[Union[bytes, Iterator[Any]]]:
+    ) -> bytes | Iterator[Any] | None:
         """Get the job trace.
 
         Args:
@@ -354,12 +342,9 @@ class ProjectJob(RefreshMixin, RESTObject):
         )
 
 
-class ProjectJobManager(RetrieveMixin, RESTManager):
+class ProjectJobManager(RetrieveMixin[ProjectJob]):
     _path = "/projects/{project_id}/jobs"
     _obj_cls = ProjectJob
     _from_parent_attrs = {"project_id": "id"}
     _list_filters = ("scope",)
     _types = {"scope": ArrayAttribute}
-
-    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> ProjectJob:
-        return cast(ProjectJob, super().get(id=id, lazy=lazy, **kwargs))

gitlab/v4/objects/keys.py

@@ -1,33 +1,30 @@
-from typing import Any, cast, Optional, TYPE_CHECKING, Union
+from __future__ import annotations
 
-from gitlab.base import RESTManager, RESTObject
+from typing import Any, TYPE_CHECKING
+
+from gitlab.base import RESTObject
 from gitlab.mixins import GetMixin
 
-__all__ = [
-    "Key",
-    "KeyManager",
-]
+__all__ = ["Key", "KeyManager"]
 
 
 class Key(RESTObject):
     pass
 
 
-class KeyManager(GetMixin, RESTManager):
+class KeyManager(GetMixin[Key]):
     _path = "/keys"
     _obj_cls = Key
 
     def get(
-        self, id: Optional[Union[int, str]] = None, lazy: bool = False, **kwargs: Any
+        self, id: int | str | None = None, lazy: bool = False, **kwargs: Any
     ) -> Key:
         if id is not None:
-            return cast(Key, super().get(id, lazy=lazy, **kwargs))
+            return super().get(id, lazy=lazy, **kwargs)
 
         if "fingerprint" not in kwargs:
             raise AttributeError("Missing attribute: id or fingerprint")
 
-        if TYPE_CHECKING:
-            assert self.path is not None
         server_data = self.gitlab.http_get(self.path, **kwargs)
         if TYPE_CHECKING:
             assert isinstance(server_data, dict)

gitlab/v4/objects/labels.py

@@ -1,7 +1,9 @@
-from typing import Any, cast, Dict, Optional, Union
+from __future__ import annotations
+
+from typing import Any
 
 from gitlab import exceptions as exc
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import (
     CreateMixin,
     DeleteMixin,
@@ -14,17 +16,12 @@ from gitlab.mixins import (
 )
 from gitlab.types import RequiredOptional
 
-__all__ = [
-    "GroupLabel",
-    "GroupLabelManager",
-    "ProjectLabel",
-    "ProjectLabelManager",
-]
+__all__ = ["GroupLabel", "GroupLabelManager", "ProjectLabel", "ProjectLabelManager"]
 
 
 class GroupLabel(SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
-    manager: "GroupLabelManager"
+    manager: GroupLabelManager
 
     # Update without ID, but we need an ID to get from list.
     @exc.on_http_error(exc.GitlabUpdateError)
@@ -48,7 +45,10 @@ class GroupLabel(SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
 
 
 class GroupLabelManager(
-    RetrieveMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager
+    RetrieveMixin[GroupLabel],
+    CreateMixin[GroupLabel],
+    UpdateMixin[GroupLabel],
+    DeleteMixin[GroupLabel],
 ):
     _path = "/groups/{group_id}/labels"
     _obj_cls = GroupLabel
@@ -60,18 +60,12 @@ class GroupLabelManager(
         required=("name",), optional=("new_name", "color", "description", "priority")
     )
 
-    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupLabel:
-        return cast(GroupLabel, super().get(id=id, lazy=lazy, **kwargs))
-
     # Update without ID.
     # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore
     # type error
     def update(  # type: ignore[override]
-        self,
-        name: Optional[str],
-        new_data: Optional[Dict[str, Any]] = None,
-        **kwargs: Any,
-    ) -> Dict[str, Any]:
+        self, name: str | None, new_data: dict[str, Any] | None = None, **kwargs: Any
+    ) -> dict[str, Any]:
         """Update a Label on the server.
 
         Args:
@@ -88,7 +82,7 @@ class ProjectLabel(
     PromoteMixin, SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject
 ):
     _id_attr = "name"
-    manager: "ProjectLabelManager"
+    manager: ProjectLabelManager
 
     # Update without ID, but we need an ID to get from list.
     @exc.on_http_error(exc.GitlabUpdateError)
@@ -112,7 +106,10 @@ class ProjectLabel(
 
 
 class ProjectLabelManager(
-    RetrieveMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager
+    RetrieveMixin[ProjectLabel],
+    CreateMixin[ProjectLabel],
+    UpdateMixin[ProjectLabel],
+    DeleteMixin[ProjectLabel],
 ):
     _path = "/projects/{project_id}/labels"
     _obj_cls = ProjectLabel
@@ -124,20 +121,12 @@ class ProjectLabelManager(
         required=("name",), optional=("new_name", "color", "description", "priority")
     )
 
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> ProjectLabel:
-        return cast(ProjectLabel, super().get(id=id, lazy=lazy, **kwargs))
-
     # Update without ID.
     # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore
     # type error
     def update(  # type: ignore[override]
-        self,
-        name: Optional[str],
-        new_data: Optional[Dict[str, Any]] = None,
-        **kwargs: Any,
-    ) -> Dict[str, Any]:
+        self, name: str | None, new_data: dict[str, Any] | None = None, **kwargs: Any
+    ) -> dict[str, Any]:
         """Update a Label on the server.
 
         Args:

gitlab/v4/objects/ldap.py

@@ -1,29 +1,45 @@
-from typing import Any, List, Union
+from __future__ import annotations
+
+from typing import Any, Literal, overload
 
 from gitlab import exceptions as exc
 from gitlab.base import RESTManager, RESTObject, RESTObjectList
 
-__all__ = [
-    "LDAPGroup",
-    "LDAPGroupManager",
-]
+__all__ = ["LDAPGroup", "LDAPGroupManager"]
 
 
 class LDAPGroup(RESTObject):
     _id_attr = None
 
 
-class LDAPGroupManager(RESTManager):
+class LDAPGroupManager(RESTManager[LDAPGroup]):
     _path = "/ldap/groups"
     _obj_cls = LDAPGroup
     _list_filters = ("search", "provider")
 
+    @overload
+    def list(
+        self, *, iterator: Literal[False] = False, **kwargs: Any
+    ) -> list[LDAPGroup]: ...
+
+    @overload
+    def list(
+        self, *, iterator: Literal[True] = True, **kwargs: Any
+    ) -> RESTObjectList[LDAPGroup]: ...
+
+    @overload
+    def list(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> list[LDAPGroup] | RESTObjectList[LDAPGroup]: ...
+
     @exc.on_http_error(exc.GitlabListError)
-    def list(self, **kwargs: Any) -> Union[List[LDAPGroup], RESTObjectList]:
+    def list(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> list[LDAPGroup] | RESTObjectList[LDAPGroup]:
         """Retrieve a list of objects.
 
         Args:
-            all: If True, return all the items, without pagination
+            get_all: If True, return all the items, without pagination
             per_page: Number of items to retrieve per request
             page: ID of the page to return (starts with page 1)
             iterator: If set to True and no pagination option is
@@ -46,7 +62,7 @@ class LDAPGroupManager(RESTManager):
         else:
             path = self._path
 
-        obj = self.gitlab.http_list(path, **data)
+        obj = self.gitlab.http_list(path, iterator=iterator, **data)
         if isinstance(obj, list):
             return [self._obj_cls(self, item) for item in obj]
         return RESTObjectList(self, self._obj_cls, obj)

gitlab/v4/objects/member_roles.py

@@ -0,0 +1,102 @@
+"""
+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 gitlab.base import RESTObject
+from gitlab.mixins import (
+    CreateMixin,
+    DeleteMixin,
+    ListMixin,
+    ObjectDeleteMixin,
+    SaveMixin,
+)
+from gitlab.types import RequiredOptional
+
+__all__ = [
+    "MemberRole",
+    "MemberRoleManager",
+    "GroupMemberRole",
+    "GroupMemberRoleManager",
+]
+
+
+class MemberRole(SaveMixin, ObjectDeleteMixin, RESTObject):
+    pass
+
+
+class MemberRoleManager(
+    ListMixin[MemberRole], CreateMixin[MemberRole], DeleteMixin[MemberRole]
+):
+    _path = "/member_roles"
+    _obj_cls = MemberRole
+    _create_attrs = RequiredOptional(
+        required=("name", "base_access_level"),
+        optional=(
+            "description",
+            "admin_cicd_variables",
+            "admin_compliance_framework",
+            "admin_group_member",
+            "admin_group_member",
+            "admin_merge_request",
+            "admin_push_rules",
+            "admin_terraform_state",
+            "admin_vulnerability",
+            "admin_web_hook",
+            "archive_project",
+            "manage_deploy_tokens",
+            "manage_group_access_tokens",
+            "manage_merge_request_settings",
+            "manage_project_access_tokens",
+            "manage_security_policy_link",
+            "read_code",
+            "read_runners",
+            "read_dependency",
+            "read_vulnerability",
+            "remove_group",
+            "remove_project",
+        ),
+    )
+
+
+class GroupMemberRole(SaveMixin, ObjectDeleteMixin, RESTObject):
+    pass
+
+
+class GroupMemberRoleManager(
+    ListMixin[GroupMemberRole],
+    CreateMixin[GroupMemberRole],
+    DeleteMixin[GroupMemberRole],
+):
+    _path = "/groups/{group_id}/member_roles"
+    _from_parent_attrs = {"group_id": "id"}
+    _obj_cls = GroupMemberRole
+    _create_attrs = RequiredOptional(
+        required=("name", "base_access_level"),
+        optional=(
+            "description",
+            "admin_cicd_variables",
+            "admin_compliance_framework",
+            "admin_group_member",
+            "admin_group_member",
+            "admin_merge_request",
+            "admin_push_rules",
+            "admin_terraform_state",
+            "admin_vulnerability",
+            "admin_web_hook",
+            "archive_project",
+            "manage_deploy_tokens",
+            "manage_group_access_tokens",
+            "manage_merge_request_settings",
+            "manage_project_access_tokens",
+            "manage_security_policy_link",
+            "read_code",
+            "read_runners",
+            "read_dependency",
+            "read_vulnerability",
+            "remove_group",
+            "remove_project",
+        ),
+    )

gitlab/v4/objects/members.py

@@ -1,7 +1,7 @@
-from typing import Any, cast, Union
+from __future__ import annotations
 
 from gitlab import types
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import (
     CRUDMixin,
     DeleteMixin,
@@ -32,7 +32,7 @@ class GroupMember(SaveMixin, ObjectDeleteMixin, RESTObject):
     _repr_attr = "username"
 
 
-class GroupMemberManager(CRUDMixin, RESTManager):
+class GroupMemberManager(CRUDMixin[GroupMember]):
     _path = "/groups/{group_id}/members"
     _obj_cls = GroupMember
     _from_parent_attrs = {"group_id": "id"}
@@ -49,19 +49,16 @@ class GroupMemberManager(CRUDMixin, RESTManager):
         "tasks_to_be_done": types.ArrayAttribute,
     }
 
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> GroupMember:
-        return cast(GroupMember, super().get(id=id, lazy=lazy, **kwargs))
-
 
 class GroupBillableMember(ObjectDeleteMixin, RESTObject):
     _repr_attr = "username"
 
-    memberships: "GroupBillableMemberMembershipManager"
+    memberships: GroupBillableMemberMembershipManager
 
 
-class GroupBillableMemberManager(ListMixin, DeleteMixin, RESTManager):
+class GroupBillableMemberManager(
+    ListMixin[GroupBillableMember], DeleteMixin[GroupBillableMember]
+):
     _path = "/groups/{group_id}/billable_members"
     _obj_cls = GroupBillableMember
     _from_parent_attrs = {"group_id": "id"}
@@ -72,7 +69,7 @@ class GroupBillableMemberMembership(RESTObject):
     _id_attr = "user_id"
 
 
-class GroupBillableMemberMembershipManager(ListMixin, RESTManager):
+class GroupBillableMemberMembershipManager(ListMixin[GroupBillableMemberMembership]):
     _path = "/groups/{group_id}/billable_members/{user_id}/memberships"
     _obj_cls = GroupBillableMemberMembership
     _from_parent_attrs = {"group_id": "group_id", "user_id": "id"}
@@ -82,22 +79,17 @@ class GroupMemberAll(RESTObject):
     _repr_attr = "username"
 
 
-class GroupMemberAllManager(RetrieveMixin, RESTManager):
+class GroupMemberAllManager(RetrieveMixin[GroupMemberAll]):
     _path = "/groups/{group_id}/members/all"
     _obj_cls = GroupMemberAll
     _from_parent_attrs = {"group_id": "id"}
 
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> GroupMemberAll:
-        return cast(GroupMemberAll, super().get(id=id, lazy=lazy, **kwargs))
-
 
 class ProjectMember(SaveMixin, ObjectDeleteMixin, RESTObject):
     _repr_attr = "username"
 
 
-class ProjectMemberManager(CRUDMixin, RESTManager):
+class ProjectMemberManager(CRUDMixin[ProjectMember]):
     _path = "/projects/{project_id}/members"
     _obj_cls = ProjectMember
     _from_parent_attrs = {"project_id": "id"}
@@ -114,22 +106,12 @@ class ProjectMemberManager(CRUDMixin, RESTManager):
         "tasks_to_be_dones": types.ArrayAttribute,
     }
 
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> ProjectMember:
-        return cast(ProjectMember, super().get(id=id, lazy=lazy, **kwargs))
-
 
 class ProjectMemberAll(RESTObject):
     _repr_attr = "username"
 
 
-class ProjectMemberAllManager(RetrieveMixin, RESTManager):
+class ProjectMemberAllManager(RetrieveMixin[ProjectMemberAll]):
     _path = "/projects/{project_id}/members/all"
     _obj_cls = ProjectMemberAll
     _from_parent_attrs = {"project_id": "id"}
-
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> ProjectMemberAll:
-        return cast(ProjectMemberAll, super().get(id=id, lazy=lazy, **kwargs))