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

Oleksii Shkurupii · Oleksii Shkurupii · commit 1b62c2e9bc38 · 2020-09-12T12:30:27.000+03:00
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
@@ -221,27 +221,33 @@ 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.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,37 @@ 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.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/v4/objects/__init__.py b/gitlab/v4/objects/__init__.py
@@ -1170,30 +1170,11 @@ class GroupMemberManager(CRUDMixin, RESTManager):
     _create_attrs = (("access_level", "user_id"), ("expires_at",))
     _update_attrs = (("access_level",), ("expires_at",))
 
-    @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 GroupMergeRequest(RESTObject):
@@ -1394,6 +1375,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
         ("issues", "GroupIssueManager"),
         ("labels", "GroupLabelManager"),
         ("members", "GroupMemberManager"),
+        ("members_all", "GroupMemberAllManager"),
         ("mergerequests", "GroupMergeRequestManager"),
         ("milestones", "GroupMilestoneManager"),
         ("notificationsettings", "GroupNotificationSettingsManager"),
@@ -2838,30 +2820,11 @@ class ProjectMemberManager(CRUDMixin, RESTManager):
     _create_attrs = (("access_level", "user_id"), ("expires_at",))
     _update_attrs = (("access_level",), ("expires_at",))
 
-    @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"}
 
 
 class ProjectNote(RESTObject):
@@ -4595,6 +4558,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
         ("issues", "ProjectIssueManager"),
         ("labels", "ProjectLabelManager"),
         ("members", "ProjectMemberManager"),
+        ("members_all", "ProjectMemberAllManager"),
         ("mergerequests", "ProjectMergeRequestManager"),
         ("milestones", "ProjectMilestoneManager"),
         ("notes", "ProjectNoteManager"),
