Pull Requests service¶
Example:
from pygithub3 import Github
gh = Github(user='octocat', repo='sample')
pull_requests = gh.pull_requests.list().all()
pull_request_commits = gh.pull_requests.list_commits(2512).all()
Pull Requests¶
-
class
pygithub3.services.pull_requests.
PullRequests
(**config)¶ Consume Pull Request API
-
comments
¶
-
create
(data, user=None, repo=None)¶ Create a pull request
Parameters: - data (dict) – Input. See github pullrequests doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(number, user=None, repo=None)¶ Get a single pull request
Parameters: - number (str) – The number of the pull request to get
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
is_merged
(number, user=None, repo=None)¶ Gets whether a pull request has been merged or not.
Parameters: - number (str) – The pull request to check
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
list
(state='open', user=None, repo=None)¶ List all of the pull requests for a repo
Parameters: - state (str) – Pull requests state (‘open’ or ‘closed’)
- user (str) – Username
- repo (str) – Repository
Returns: A Result
Note
Remember Config precedence
-
list_commits
(number, user=None, repo=None)¶ List the commits for a pull request
Parameters: - number (str) – The number of the pull request to list commits for
- user (str) – Username
- repo (str) – Repository
Returns: A Result
Note
Remember Config precedence
-
list_files
(number, user=None, repo=None)¶ List the files for a pull request
Parameters: - number (str) – The number of the pull request to list files for
- user (str) – Username
- repo (str) – Repository
Returns: A Result
Note
Remember Config precedence
-
merge
(number, message='', user=None, repo=None)¶ Merge a pull request.
Parameters: - number (str) – The pull request to merge
- message (str) – Message of pull request
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
This currently raises an HTTP 405 error if the request is not mergable.
-
update
(number, data, user=None, repo=None)¶ Update a pull request
Parameters: - number (str) – The number of the the pull request to update
- data (dict) – Input. See github pullrequests doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
Pull Request Comments¶
-
class
pygithub3.services.pull_requests.
Comments
(**config)¶ Consume Review Comments API
-
create
(number, data, user=None, repo=None)¶ Create a comment
Parameters: - number (str) – the pull request to comment on
- data (dict) – Input. See github pullrequests comments doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
delete
(number, user=None, repo=None)¶ Delete a comment
Parameters: - number (str) – The comment to delete
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(number, user=None, repo=None)¶ Get a single comment
Parameters: - number (str) – The comment to get
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
list
(number, user=None, repo=None)¶ List all the comments for a pull request
Parameters: - number (str) – The number of the pull request
- user (str) – Username
- repo (str) – Repository
Returns: A Result
Note
Remember Config precedence
-
update
(number, message, user=None, repo=None)¶ Update a comment
Parameters: - number (str) – The id of the comment to update
- message (str) – Comment message
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-