-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Return added team membership instance #2956
Open
jdelic
wants to merge
1
commit into
PyGithub:main
Choose a base branch
from
optile:feature/add-team-return-values
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,6 +41,7 @@ | |
# Copyright 2024 Andrii Kezikov <[email protected]> # | ||
# Copyright 2024 Enrico Minack <[email protected]> # | ||
# Copyright 2024 Jirka Borovec <[email protected]> # | ||
# Copyright 2024 Jonas Maurus <[email protected]> # | ||
# # | ||
# This file is part of PyGithub. # | ||
# http://pygithub.readthedocs.io/ # | ||
|
@@ -200,7 +201,7 @@ def add_to_members(self, member: NamedUser) -> None: | |
assert isinstance(member, github.NamedUser.NamedUser), member | ||
headers, data = self._requester.requestJsonAndCheck("PUT", f"{self.url}/members/{member._identity}") | ||
|
||
def add_membership(self, member: NamedUser, role: Opt[str] = NotSet) -> None: | ||
def add_membership(self, member: NamedUser, role: Opt[str] = NotSet) -> Membership: | ||
""" | ||
:calls: `PUT /teams/{id}/memberships/{user} <https://docs.github.com/en/rest/reference/teams>`_ | ||
""" | ||
|
@@ -218,6 +219,7 @@ def add_membership(self, member: NamedUser, role: Opt[str] = NotSet) -> None: | |
headers, data = self._requester.requestJsonAndCheck( | ||
"PUT", f"{self.url}/memberships/{member._identity}", input=put_parameters | ||
) | ||
return github.Membership.Membership(self._requester, headers, data, completed=True) | ||
|
||
def get_team_membership(self, member: str | NamedUser) -> Membership: | ||
""" | ||
|
@@ -298,11 +300,15 @@ def update_team_repository(self, repo: Repository, permission: str) -> bool: | |
) | ||
return status == 204 | ||
|
||
def delete(self) -> None: | ||
def delete(self) -> bool: | ||
""" | ||
:calls: `DELETE /teams/{id} <https://docs.github.com/en/rest/reference/teams#delete-a-team>`_ | ||
""" | ||
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url) | ||
status, headers, data = self._requester.requestJson( | ||
"DELETE", | ||
self.url, | ||
) | ||
return status == 204 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is bad practise: #2760 |
||
|
||
def edit( | ||
self, | ||
|
@@ -411,12 +417,13 @@ def has_in_repos(self, repo: Repository) -> bool: | |
status, headers, data = self._requester.requestJson("GET", f"{self.url}/repos/{repo._identity}") | ||
return status == 204 | ||
|
||
def remove_membership(self, member: NamedUser) -> None: | ||
def remove_membership(self, member: NamedUser) -> bool: | ||
""" | ||
:calls: `DELETE /teams/{team_id}/memberships/{username} <https://docs.github.com/en/rest/reference/teams#remove-team-membership-for-a-user>`_ | ||
""" | ||
assert isinstance(member, github.NamedUser.NamedUser), member | ||
headers, data = self._requester.requestJsonAndCheck("DELETE", f"{self.url}/memberships/{member._identity}") | ||
status, headers, data = self._requester.requestJson("DELETE", f"{self.url}/memberships/{member._identity}") | ||
return status == 204 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same here |
||
|
||
def remove_from_members(self, member: NamedUser) -> None: | ||
""" | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to approve this change, but can you extend the tests in
tests/Team.py
? Tests already calladd_membership
, so simply assert some attributes of the returnedMembership
instance.