Repository navigation
Commit 4d7b848
refactor(objects): remove deprecated members.all() method
BREAKING CHANGE: remove deprecated members.all() method
in favor of members_all.list()1 parent c4f5ec6 commit 4d7b848
5 files changed
Lines changed: 2 additions & 56 deletions
File tree
- docs/gl_objects
- gitlab
- v4/objects
- tests/functional/api
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -272,8 +272,6 @@ List the group members recursively (including inherited members through | |||
| 272 | 272 | ancestor groups):: | |
| 273 | 273 | ||
| 274 | 274 | members = group.members_all.list(all=True) | |
| 275 | - # or | ||
| 276 | - members = group.members.all(all=True) # Deprecated | ||
| 277 | 275 | ||
| 278 | 276 | Get only direct group member:: | |
| 279 | 277 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -519,8 +519,6 @@ List the project members recursively (including inherited members through | |||
| 519 | 519 | ancestor groups):: | |
| 520 | 520 | ||
| 521 | 521 | members = project.members_all.list(all=True) | |
| 522 | - # or | ||
| 523 | - members = project.members.all(all=True) # Deprecated | ||
| 524 | 522 | ||
| 525 | 523 | Search project members matching a query string:: | |
| 526 | 524 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -15,7 +15,6 @@ | |||
| 15 | 15 | # You should have received a copy of the GNU Lesser General Public License | |
| 16 | 16 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 17 | 17 | ||
| 18 | - import warnings | ||
| 19 | 18 | from types import ModuleType | |
| 20 | 19 | from typing import ( | |
| 21 | 20 | Any, | |
@@ -927,50 +926,3 @@ def render(self, link_url: str, image_url: str, **kwargs: Any) -> Dict[str, Any] | |||
| 927 | 926 | if TYPE_CHECKING: | |
| 928 | 927 | assert not isinstance(result, requests.Response) | |
| 929 | 928 | return result | |
| 930 | - | ||
| 931 | - | ||
| 932 | - class MemberAllMixin(_RestManagerBase): | ||
| 933 | - """This mixin is deprecated.""" | ||
| 934 | - | ||
| 935 | - _computed_path: Optional[str] | ||
| 936 | - _from_parent_attrs: Dict[str, Any] | ||
| 937 | - _obj_cls: Optional[Type[base.RESTObject]] | ||
| 938 | - _parent: Optional[base.RESTObject] | ||
| 939 | - _parent_attrs: Dict[str, Any] | ||
| 940 | - _path: Optional[str] | ||
| 941 | - gitlab: gitlab.Gitlab | ||
| 942 | - | ||
| 943 | - @cli.register_custom_action(("GroupMemberManager", "ProjectMemberManager")) | ||
| 944 | - @exc.on_http_error(exc.GitlabListError) | ||
| 945 | - def all(self, **kwargs: Any) -> List[base.RESTObject]: | ||
| 946 | - """List all the members, included inherited ones. | ||
| 947 | - | ||
| 948 | - This Method is deprecated. | ||
| 949 | - | ||
| 950 | - Args: | ||
| 951 | - all (bool): If True, return all the items, without pagination | ||
| 952 | - per_page (int): Number of items to retrieve per request | ||
| 953 | - page (int): ID of the page to return (starts with page 1) | ||
| 954 | - as_list (bool): If set to False and no pagination option is | ||
| 955 | - defined, return a generator instead of a list | ||
| 956 | - **kwargs: Extra options to send to the server (e.g. sudo) | ||
| 957 | - | ||
| 958 | - Raises: | ||
| 959 | - GitlabAuthenticationError: If authentication is not correct | ||
| 960 | - GitlabListError: If the list could not be retrieved | ||
| 961 | - | ||
| 962 | - Returns: | ||
| 963 | - RESTObjectList: The list of members | ||
| 964 | - """ | ||
| 965 | - | ||
| 966 | - warnings.warn( | ||
| 967 | - "The all() method for this object is deprecated " | ||
| 968 | - "and will be removed in a future version. Use .members_all.list(all=True), instead.", | ||
| 969 | - DeprecationWarning, | ||
| 970 | - ) | ||
| 971 | - path = "%s/all" % self.path | ||
| 972 | - | ||
| 973 | - if TYPE_CHECKING: | ||
| 974 | - assert self._obj_cls is not None | ||
| 975 | - obj = self.gitlab.http_list(path, **kwargs) | ||
| 976 | - return [self._obj_cls(self, item) for item in obj] | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4,7 +4,6 @@ | |||
| 4 | 4 | CRUDMixin, | |
| 5 | 5 | DeleteMixin, | |
| 6 | 6 | ListMixin, | |
| 7 | - MemberAllMixin, | ||
| 8 | 7 | ObjectDeleteMixin, | |
| 9 | 8 | RetrieveMixin, | |
| 10 | 9 | SaveMixin, | |
@@ -28,7 +27,7 @@ class GroupMember(SaveMixin, ObjectDeleteMixin, RESTObject): | |||
| 28 | 27 | _short_print_attr = "username" | |
| 29 | 28 | ||
| 30 | 29 | ||
| 31 | - class GroupMemberManager(MemberAllMixin, CRUDMixin, RESTManager): | ||
| 30 | + class GroupMemberManager(CRUDMixin, RESTManager): | ||
| 32 | 31 | _path = "/groups/%(group_id)s/members" | |
| 33 | 32 | _obj_cls = GroupMember | |
| 34 | 33 | _from_parent_attrs = {"group_id": "id"} | |
@@ -74,7 +73,7 @@ class ProjectMember(SaveMixin, ObjectDeleteMixin, RESTObject): | |||
| 74 | 73 | _short_print_attr = "username" | |
| 75 | 74 | ||
| 76 | 75 | ||
| 77 | - class ProjectMemberManager(MemberAllMixin, CRUDMixin, RESTManager): | ||
| 76 | + class ProjectMemberManager(CRUDMixin, RESTManager): | ||
| 78 | 77 | _path = "/projects/%(project_id)s/members" | |
| 79 | 78 | _obj_cls = ProjectMember | |
| 80 | 79 | _from_parent_attrs = {"project_id": "id"} | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -89,7 +89,6 @@ def test_groups(gl): | |||
| 89 | 89 | ||
| 90 | 90 | group1.members.delete(user.id) | |
| 91 | 91 | assert len(group1.members.list()) == 2 | |
| 92 | - assert len(group1.members.all()) # Deprecated | ||
| 93 | 92 | assert len(group1.members_all.list()) | |
| 94 | 93 | member = group1.members.get(user2.id) | |
| 95 | 94 | member.access_level = gitlab.const.OWNER_ACCESS | |
0 commit comments