feat: add feature to get inherited member for project/group

Oleksii Shkurupii · nejch · commit 230591557232 · 2021-05-06T22:01:39.000+02:00
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
@@ -225,27 +225,35 @@ Reference
 
   + :class:`gitlab.v4.objects.GroupMember`
   + :class:`gitlab.v4.objects.GroupMemberManager`
+  + :class:`gitlab.v4.objects.GroupMemberAllManager`
   + :attr:`gitlab.v4.objects.Group.members`
+  + :attr:`gitlab.v4.objects.Group.members_all`
 
 * GitLab API: https://docs.gitlab.com/ce/api/groups.html
 
 
 Examples
 --------
 
-List group members::
+List only direct group members::
 
     members = group.members.list()
 
 List the group members recursively (including inherited members through
 ancestor groups)::
 
-    members = group.members.all(all=True)
+    members = group.members.all(all=True) # Deprecated
+    # or
+    members = group.members_all.list(all=True)
 
-Get a group member::
+Get only direct group member::
 
     members = group.members.get(member_id)
 
+Get a member of a group, including members inherited through ancestor groups::
+
+    members = group.members_all.get(member_id)
+
 Add a member to the group::
 
     member = group.members.create({'user_id': user_id,
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -502,30 +502,39 @@ Reference
 
   + :class:`gitlab.v4.objects.ProjectMember`
   + :class:`gitlab.v4.objects.ProjectMemberManager`
+  + :class:`gitlab.v4.objects.ProjectMemberAllManager`
   + :attr:`gitlab.v4.objects.Project.members`
+  + :attr:`gitlab.v4.objects.Project.members_all`
 
 * GitLab API: https://docs.gitlab.com/ce/api/members.html
 
 Examples
 --------
 
-List the project members::
+List only direct project members::
 
     members = project.members.list()
 
 List the project members recursively (including inherited members through
 ancestor groups)::
 
-    members = project.members.all(all=True)
+    members = project.members.all(all=True) # Deprecated
+    # or
+    members = project.members_all.list(all=True)
 
 Search project members matching a query string::
 
     members = project.members.list(query='bar')
 
-Get a single project member::
+Get only direct project member::
 
     member = project.members.get(user_id)
 
+Get a member of a project, including members inherited through ancestor groups::
+
+    members = project.members_all.get(member_id)
+
+
 Add a project member::
 
     member = project.members.create({'user_id': user.id, 'access_level':
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -36,7 +36,7 @@
 from gitlab import exceptions as exc
 from gitlab import types as g_types
 from gitlab import utils
-
+import warnings
 
 __all__ = [
     "GetMixin",
@@ -928,3 +928,39 @@ def render(self, link_url: str, image_url: str, **kwargs: Any) -> Dict[str, Any]
         if TYPE_CHECKING:
             assert not isinstance(result, requests.Response)
         return result
+
+
+class MemberAllMixin(object):
+    """This mixin is deprecated."""
+
+    @cli.register_custom_action(("GroupMemberManager", "ProjectMemberManager"))
+    @exc.on_http_error(exc.GitlabListError)
+    def all(self, **kwargs):
+        """List all the members, included inherited ones.
+
+        This Method is deprecated.
+
+        Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabListError: If the list could not be retrieved
+
+        Returns:
+            RESTObjectList: The list of members
+        """
+
+        warnings.warn(
+            "The all() method for this object is deprecated "
+            "and will be removed in a future version.",
+            DeprecationWarning,
+        )
+        path = "%s/all" % self.path
+        obj = self.gitlab.http_list(path, **kwargs)
+        return [self._obj_cls(self, item) for item in obj]
diff --git a/gitlab/v4/objects/members.py b/gitlab/v4/objects/members.py
@@ -1,8 +1,13 @@
 from gitlab import cli, types
 from gitlab import exceptions as exc
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
-from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
-
+from gitlab.mixins import (
+    CRUDMixin,
+    ObjectDeleteMixin,
+    SaveMixin,
+    RetrieveMixin,
+    MemberAllMixin,
+)
 
 __all__ = [
     "GroupMember",
@@ -16,7 +21,7 @@ class GroupMember(SaveMixin, ObjectDeleteMixin, RESTObject):
     _short_print_attr = "username"
 
 
-class GroupMemberManager(CRUDMixin, RESTManager):
+class GroupMemberManager(MemberAllMixin, CRUDMixin, RESTManager):
     _path = "/groups/%(group_id)s/members"
     _obj_cls = GroupMember
     _from_parent_attrs = {"group_id": "id"}
@@ -28,37 +33,18 @@ class GroupMemberManager(CRUDMixin, RESTManager):
     )
     _types = {"user_ids": types.ListAttribute}
 
-    @cli.register_custom_action("GroupMemberManager")
-    @exc.on_http_error(exc.GitlabListError)
-    def all(self, **kwargs):
-        """List all the members, included inherited ones.
-
-        Args:
-            all (bool): If True, return all the items, without pagination
-            per_page (int): Number of items to retrieve per request
-            page (int): ID of the page to return (starts with page 1)
-            as_list (bool): If set to False and no pagination option is
-                defined, return a generator instead of a list
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabListError: If the list could not be retrieved
 
-        Returns:
-            RESTObjectList: The list of members
-        """
-
-        path = "%s/all" % self.path
-        obj = self.gitlab.http_list(path, **kwargs)
-        return [self._obj_cls(self, item) for item in obj]
+class GroupMemberAllManager(RetrieveMixin, RESTManager):
+    _path = "/groups/%(group_id)s/members/all"
+    _obj_cls = GroupMember
+    _from_parent_attrs = {"group_id": "id"}
 
 
 class ProjectMember(SaveMixin, ObjectDeleteMixin, RESTObject):
     _short_print_attr = "username"
 
 
-class ProjectMemberManager(CRUDMixin, RESTManager):
+class ProjectMemberManager(MemberAllMixin, CRUDMixin, RESTManager):
     _path = "/projects/%(project_id)s/members"
     _obj_cls = ProjectMember
     _from_parent_attrs = {"project_id": "id"}
@@ -70,27 +56,8 @@ class ProjectMemberManager(CRUDMixin, RESTManager):
     )
     _types = {"user_ids": types.ListAttribute}
 
-    @cli.register_custom_action("ProjectMemberManager")
-    @exc.on_http_error(exc.GitlabListError)
-    def all(self, **kwargs):
-        """List all the members, included inherited ones.
 
-        Args:
-            all (bool): If True, return all the items, without pagination
-            per_page (int): Number of items to retrieve per request
-            page (int): ID of the page to return (starts with page 1)
-            as_list (bool): If set to False and no pagination option is
-                defined, return a generator instead of a list
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabListError: If the list could not be retrieved
-
-        Returns:
-            RESTObjectList: The list of members
-        """
-
-        path = "%s/all" % self.path
-        obj = self.gitlab.http_list(path, **kwargs)
-        return [self._obj_cls(self, item) for item in obj]
+class ProjectMemberAllManager(RetrieveMixin, RESTManager):
+    _path = "/projects/%(project_id)s/members/all"
+    _obj_cls = ProjectMember
+    _from_parent_attrs = {"project_id": "id"}
