Skip to content

Commit 245150e

Browse files
committed
Deprecate Team.add_to_members an Team.remove_from_members
1 parent e79d9bc commit 245150e

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

github/Team.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,7 @@ def url(self) -> str:
279279
self._completeIfNotSet(self._url)
280280
return self._url.value
281281

282+
@deprecated("Use add_membership instead")
282283
def add_to_members(self, member: NamedUser) -> None:
283284
"""
284285
This API call is deprecated. Use `add_membership` instead.
@@ -504,6 +505,7 @@ def remove_membership(self, member: NamedUser) -> None:
504505
assert isinstance(member, github.NamedUser.NamedUser), member
505506
headers, data = self._requester.requestJsonAndCheck("DELETE", f"{self.url}/memberships/{member._identity}")
506507

508+
@deprecated("Use remove_membership instead")
507509
def remove_from_members(self, member: NamedUser) -> None:
508510
"""
509511
This API call is deprecated. Use `remove_membership` instead:

tests/ReplayData/Team.testMembers.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ https
3535
PUT
3636
api.github.com
3737
None
38-
/organizations/1234567/team/12345678/members/jacquev6
39-
{'Authorization': 'token private_token_removed', 'User-Agent': 'PyGithub/Python'}
40-
None
38+
/organizations/1234567/team/12345678/memberships/jacquev6
39+
{'Content-Type': 'application/json', 'Authorization': 'token private_token_removed', 'User-Agent': 'PyGithub/Python'}
40+
{"role": "member"}
4141
204
4242
[('status', '204 No Content'), ('x-ratelimit-remaining', '4971'), ('server', 'nginx/1.0.13'), ('connection', 'keep-alive'), ('x-ratelimit-limit', '5000'), ('etag', '"d41d8cd98f00b204e9800998ecf8427e"'), ('date', 'Sat, 26 May 2012 21:09:55 GMT')]
4343

@@ -68,7 +68,7 @@ https
6868
DELETE
6969
api.github.com
7070
None
71-
/organizations/1234567/team/12345678/members/jacquev6
71+
/organizations/1234567/team/12345678/memberships/jacquev6
7272
{'Authorization': 'token private_token_removed', 'User-Agent': 'PyGithub/Python'}
7373
None
7474
204

tests/Team.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,10 @@ def testMembers(self):
143143
user = self.g.get_user("jacquev6")
144144
self.assertListKeyEqual(self.team.get_members(), None, [])
145145
self.assertFalse(self.team.has_in_members(user))
146-
self.team.add_to_members(user)
146+
self.team.add_membership(user)
147147
self.assertListKeyEqual(self.team.get_members(), lambda u: u.login, ["jacquev6"])
148148
self.assertTrue(self.team.has_in_members(user))
149-
self.team.remove_from_members(user)
149+
self.team.remove_membership(user)
150150
self.assertListKeyEqual(self.team.get_members(), None, [])
151151
self.assertFalse(self.team.has_in_members(user))
152152
self.team.add_membership(user, "maintainer")

0 commit comments

Comments
 (0)