desc
stringlengths
3
26.7k
decl
stringlengths
11
7.89k
bodies
stringlengths
8
553k
':type: list of string'
@property def events(self):
self._completeIfNotSet(self._events) return self._events.value
':type: integer'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: :class:`github.HookResponse.HookResponse`'
@property def last_response(self):
self._completeIfNotSet(self._last_response) return self._last_response.value
':type: string'
@property def name(self):
self._completeIfNotSet(self._name) return self._name.value
':type: string'
@property def test_url(self):
self._completeIfNotSet(self._test_url) return self._test_url.value
':type: datetime.datetime'
@property def updated_at(self):
self._completeIfNotSet(self._updated_at) return self._updated_at.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':calls: `DELETE /repos/:owner/:repo/hooks/:id <http://developer.github.com/v3/repos/hooks>`_ :rtype: None'
def delete(self):
(headers, data) = self._requester.requestJsonAndCheck('DELETE', self.url)
':calls: `PATCH /repos/:owner/:repo/hooks/:id <http://developer.github.com/v3/repos/hooks>`_ :param name: string :param config: dict :param events: list of string :param add_events: list of string :param remove_events: list of string :param active: bool :rtype: None'
def edit(self, name, config, events=github.GithubObject.NotSet, add_events=github.GithubObject.NotSet, remove_events=github.GithubObject.NotSet, active=github.GithubObject.NotSet):
assert isinstance(name, (str, unicode)), name assert isinstance(config, dict), config assert ((events is github.GithubObject.NotSet) or all((isinstance(element, (str, unicode)) for element in events))), events assert ((add_events is github.GithubObject.NotSet) or all((isinstance(element, (str, unicode))...
':calls: `POST /repos/:owner/:repo/hooks/:id/tests <http://developer.github.com/v3/repos/hooks>`_ :rtype: None'
def test(self):
(headers, data) = self._requester.requestJsonAndCheck('POST', (self.url + '/tests'))
':type: datetime.datetime'
@property def date(self):
return self._date.value
':type: string'
@property def email(self):
return self._email.value
':type: string'
@property def name(self):
return self._name.value
':type: :class:`github.CommitStats.CommitStats`'
@property def change_status(self):
self._completeIfNotSet(self._change_status) return self._change_status.value
':type: integer'
@property def comments(self):
self._completeIfNotSet(self._comments) return self._comments.value
':type: string'
@property def comments_url(self):
self._completeIfNotSet(self._comments_url) return self._comments_url.value
':type: string'
@property def commits_url(self):
self._completeIfNotSet(self._commits_url) return self._commits_url.value
':type: datetime.datetime'
@property def committed_at(self):
self._completeIfNotSet(self._committed_at) return self._committed_at.value
':type: datetime.datetime'
@property def created_at(self):
self._completeIfNotSet(self._created_at) return self._created_at.value
':type: string'
@property def description(self):
self._completeIfNotSet(self._description) return self._description.value
':type: dict of string to :class:`github.GistFile.GistFile`'
@property def files(self):
self._completeIfNotSet(self._files) return self._files.value
':type: list of :class:`github.Gist.Gist`'
@property def forks(self):
self._completeIfNotSet(self._forks) return self._forks.value
':type: string'
@property def forks_url(self):
self._completeIfNotSet(self._forks_url) return self._forks_url.value
':type: string'
@property def git_pull_url(self):
self._completeIfNotSet(self._git_pull_url) return self._git_pull_url.value
':type: string'
@property def git_push_url(self):
self._completeIfNotSet(self._git_push_url) return self._git_push_url.value
':type: list of :class:`GistHistoryState`'
@property def history(self):
self._completeIfNotSet(self._history) return self._history.value
':type: string'
@property def html_url(self):
self._completeIfNotSet(self._html_url) return self._html_url.value
':type: string'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: :class:`github.NamedUser.NamedUser`'
@property def owner(self):
self._completeIfNotSet(self._owner) return self._owner.value
':type: bool'
@property def public(self):
self._completeIfNotSet(self._public) return self._public.value
':type: datetime.datetime'
@property def updated_at(self):
self._completeIfNotSet(self._updated_at) return self._updated_at.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':type: :class:`github.NamedUser.NamedUser`'
@property def user(self):
self._completeIfNotSet(self._user) return self._user.value
':type: string'
@property def version(self):
self._completeIfNotSet(self._version) return self._version.value
':type: string'
@property def mode(self):
return self._mode.value
':type: string'
@property def path(self):
return self._path.value
':type: string'
@property def sha(self):
return self._sha.value
':type: integer'
@property def size(self):
return self._size.value
':type: string'
@property def type(self):
return self._type.value
':type: string'
@property def url(self):
return self._url.value
':type: integer'
@property def additions(self):
self._completeIfNotSet(self._additions) return self._additions.value
':type: :class:`github.NamedUser.NamedUser`'
@property def assignee(self):
self._completeIfNotSet(self._assignee) return self._assignee.value
':type: :class:`github.PullRequestPart.PullRequestPart`'
@property def base(self):
self._completeIfNotSet(self._base) return self._base.value
':type: string'
@property def body(self):
self._completeIfNotSet(self._body) return self._body.value
':type: integer'
@property def changed_files(self):
self._completeIfNotSet(self._changed_files) return self._changed_files.value
':type: datetime.datetime'
@property def closed_at(self):
self._completeIfNotSet(self._closed_at) return self._closed_at.value
':type: integer'
@property def comments(self):
self._completeIfNotSet(self._comments) return self._comments.value
':type: string'
@property def comments_url(self):
self._completeIfNotSet(self._comments_url) return self._comments_url.value
':type: integer'
@property def commits(self):
self._completeIfNotSet(self._commits) return self._commits.value
':type: string'
@property def commits_url(self):
self._completeIfNotSet(self._commits_url) return self._commits_url.value
':type: datetime.datetime'
@property def created_at(self):
self._completeIfNotSet(self._created_at) return self._created_at.value
':type: integer'
@property def deletions(self):
self._completeIfNotSet(self._deletions) return self._deletions.value
':type: string'
@property def diff_url(self):
self._completeIfNotSet(self._diff_url) return self._diff_url.value
':type: :class:`github.PullRequestPart.PullRequestPart`'
@property def head(self):
self._completeIfNotSet(self._head) return self._head.value
':type: string'
@property def html_url(self):
self._completeIfNotSet(self._html_url) return self._html_url.value
':type: integer'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: string'
@property def issue_url(self):
self._completeIfNotSet(self._issue_url) return self._issue_url.value
':type: string'
@property def merge_commit_sha(self):
self._completeIfNotSet(self._merge_commit_sha) return self._merge_commit_sha.value
':type: bool'
@property def mergeable(self):
self._completeIfNotSet(self._mergeable) return self._mergeable.value
':type: string'
@property def mergeable_state(self):
self._completeIfNotSet(self._mergeable_state) return self._mergeable_state.value
':type: bool'
@property def merged(self):
self._completeIfNotSet(self._merged) return self._merged.value
':type: datetime.datetime'
@property def merged_at(self):
self._completeIfNotSet(self._merged_at) return self._merged_at.value
':type: :class:`github.NamedUser.NamedUser`'
@property def merged_by(self):
self._completeIfNotSet(self._merged_by) return self._merged_by.value
':type: :class:`github.Milestone.Milestone`'
@property def milestone(self):
self._completeIfNotSet(self._milestone) return self._milestone.value
':type: integer'
@property def number(self):
self._completeIfNotSet(self._number) return self._number.value
':type: string'
@property def patch_url(self):
self._completeIfNotSet(self._patch_url) return self._patch_url.value
':type: string'
@property def review_comment_url(self):
self._completeIfNotSet(self._review_comment_url) return self._review_comment_url.value
':type: integer'
@property def review_comments(self):
self._completeIfNotSet(self._review_comments) return self._review_comments.value
':type: string'
@property def review_comments_url(self):
self._completeIfNotSet(self._review_comments_url) return self._review_comments_url.value
':type: string'
@property def state(self):
self._completeIfNotSet(self._state) return self._state.value
':type: string'
@property def title(self):
self._completeIfNotSet(self._title) return self._title.value
':type: datetime.datetime'
@property def updated_at(self):
self._completeIfNotSet(self._updated_at) return self._updated_at.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':type: :class:`github.NamedUser.NamedUser`'
@property def user(self):
self._completeIfNotSet(self._user) return self._user.value
':calls: `POST /repos/:owner/:repo/pulls/:number/comments <http://developer.github.com/v3/pulls/comments>`_ :param body: string :param commit_id: :class:`github.Commit.Commit` :param path: string :param position: integer :rtype: :class:`github.PullRequestComment.PullRequestComment`'
def create_comment(self, body, commit_id, path, position):
return self.create_review_comment(body, commit_id, path, position)
':calls: `POST /repos/:owner/:repo/pulls/:number/comments <http://developer.github.com/v3/pulls/comments>`_ :param body: string :param commit_id: :class:`github.Commit.Commit` :param path: string :param position: integer :rtype: :class:`github.PullRequestComment.PullRequestComment`'
def create_review_comment(self, body, commit_id, path, position):
assert isinstance(body, (str, unicode)), body assert isinstance(commit_id, github.Commit.Commit), commit_id assert isinstance(path, (str, unicode)), path assert isinstance(position, (int, long)), position post_parameters = {'body': body, 'commit_id': commit_id._identity, 'path': path, 'position': po...
':calls: `POST /repos/:owner/:repo/issues/:number/comments <http://developer.github.com/v3/issues/comments>`_ :param body: string :rtype: :class:`github.IssueComment.IssueComment`'
def create_issue_comment(self, body):
assert isinstance(body, (str, unicode)), body post_parameters = {'body': body} (headers, data) = self._requester.requestJsonAndCheck('POST', (((self._parentUrl(self._parentUrl(self.url)) + '/issues/') + str(self.number)) + '/comments'), input=post_parameters) return github.IssueComment.IssueComment(self...
':calls: `PATCH /repos/:owner/:repo/pulls/:number <http://developer.github.com/v3/pulls>`_ :param title: string :param body: string :param state: string :rtype: None'
def edit(self, title=github.GithubObject.NotSet, body=github.GithubObject.NotSet, state=github.GithubObject.NotSet):
assert ((title is github.GithubObject.NotSet) or isinstance(title, (str, unicode))), title assert ((body is github.GithubObject.NotSet) or isinstance(body, (str, unicode))), body assert ((state is github.GithubObject.NotSet) or isinstance(state, (str, unicode))), state post_parameters = dict() if (t...
':calls: `GET /repos/:owner/:repo/pulls/comments/:number <http://developer.github.com/v3/pulls/comments>`_ :param id: integer :rtype: :class:`github.PullRequestComment.PullRequestComment`'
def get_comment(self, id):
return self.get_review_comment(id)
':calls: `GET /repos/:owner/:repo/pulls/comments/:number <http://developer.github.com/v3/pulls/comments>`_ :param id: integer :rtype: :class:`github.PullRequestComment.PullRequestComment`'
def get_review_comment(self, id):
assert isinstance(id, (int, long)), id (headers, data) = self._requester.requestJsonAndCheck('GET', ((self._parentUrl(self.url) + '/comments/') + str(id))) return github.PullRequestComment.PullRequestComment(self._requester, headers, data, completed=True)
':calls: `GET /repos/:owner/:repo/pulls/:number/comments <http://developer.github.com/v3/pulls/comments>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment`'
def get_comments(self):
return self.get_review_comments()
':calls: `GET /repos/:owner/:repo/pulls/:number/comments <http://developer.github.com/v3/pulls/comments>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment`'
def get_review_comments(self):
return github.PaginatedList.PaginatedList(github.PullRequestComment.PullRequestComment, self._requester, (self.url + '/comments'), None)
':calls: `GET /repos/:owner/:repo/pulls/:number/commits <http://developer.github.com/v3/pulls>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Commit.Commit`'
def get_commits(self):
return github.PaginatedList.PaginatedList(github.Commit.Commit, self._requester, (self.url + '/commits'), None)
':calls: `GET /repos/:owner/:repo/pulls/:number/files <http://developer.github.com/v3/pulls>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.File.File`'
def get_files(self):
return github.PaginatedList.PaginatedList(github.File.File, self._requester, (self.url + '/files'), None)
':calls: `GET /repos/:owner/:repo/issues/comments/:id <http://developer.github.com/v3/issues/comments>`_ :param id: integer :rtype: :class:`github.IssueComment.IssueComment`'
def get_issue_comment(self, id):
assert isinstance(id, (int, long)), id (headers, data) = self._requester.requestJsonAndCheck('GET', ((self._parentUrl(self._parentUrl(self.url)) + '/issues/comments/') + str(id))) return github.IssueComment.IssueComment(self._requester, headers, data, completed=True)
':calls: `GET /repos/:owner/:repo/issues/:number/comments <http://developer.github.com/v3/issues/comments>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.IssueComment.IssueComment`'
def get_issue_comments(self):
return github.PaginatedList.PaginatedList(github.IssueComment.IssueComment, self._requester, (((self._parentUrl(self._parentUrl(self.url)) + '/issues/') + str(self.number)) + '/comments'), None)
':calls: `GET /repos/:owner/:repo/pulls/:number/merge <http://developer.github.com/v3/pulls>`_ :rtype: bool'
def is_merged(self):
(status, headers, data) = self._requester.requestJson('GET', (self.url + '/merge')) return (status == 204)
':calls: `PUT /repos/:owner/:repo/pulls/:number/merge <http://developer.github.com/v3/pulls>`_ :param commit_message: string :rtype: :class:`github.PullRequestMergeStatus.PullRequestMergeStatus`'
def merge(self, commit_message=github.GithubObject.NotSet):
assert ((commit_message is github.GithubObject.NotSet) or isinstance(commit_message, (str, unicode))), commit_message post_parameters = dict() if (commit_message is not github.GithubObject.NotSet): post_parameters['commit_message'] = commit_message (headers, data) = self._requester.requestJsonAn...
':type: datetime.datetime'
@property def starred_at(self):
return self._starred_at.value
':type: :class:`github.NamedUser`'
@property def user(self):
return self._user.value
':type: string'
@property def source(self):
return self._source.value
':type: string'
@property def name(self):
return self._name.value
':type: :class:`github.GitAuthor.GitAuthor`'
@property def author(self):
self._completeIfNotSet(self._author) return self._author.value
':type: :class:`github.GitAuthor.GitAuthor`'
@property def committer(self):
self._completeIfNotSet(self._committer) return self._committer.value
':type: string'
@property def html_url(self):
self._completeIfNotSet(self._html_url) return self._html_url.value
':type: string'
@property def message(self):
self._completeIfNotSet(self._message) return self._message.value
':type: list of :class:`github.GitCommit.GitCommit`'
@property def parents(self):
self._completeIfNotSet(self._parents) return self._parents.value
':type: string'
@property def sha(self):
self._completeIfNotSet(self._sha) return self._sha.value
':type: :class:`github.GitTree.GitTree`'
@property def tree(self):
self._completeIfNotSet(self._tree) return self._tree.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value