desc
stringlengths
3
26.7k
decl
stringlengths
11
7.89k
bodies
stringlengths
8
553k
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':type: string'
@property def body(self):
self._completeIfNotSet(self._body) return self._body.value
':type: string'
@property def title(self):
self._completeIfNotSet(self._title) return self._title.value
':type: string'
@property def tag_name(self):
self._completeIfNotSet(self._tag_name) return self._tag_name.value
':type: :class:`github.GitAuthor.GitAuthor`'
@property def author(self):
self._completeIfNotSet(self._author) return self._author.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':type: string'
@property def upload_url(self):
self._completeIfNotSet(self._upload_url) return self._upload_url.value
':type: list of int'
@property def all(self):
return self._all.value
':type: list of int'
@property def owner(self):
return self._owner.value
':type: :class:`github.GitObject.GitObject`'
@property def object(self):
self._completeIfNotSet(self._object) return self._object.value
':type: string'
@property def ref(self):
self._completeIfNotSet(self._ref) return self._ref.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':calls: `DELETE /repos/:owner/:repo/git/refs/:ref <http://developer.github.com/v3/git/refs>`_ :rtype: None'
def delete(self):
(headers, data) = self._requester.requestJsonAndCheck('DELETE', self.url)
':calls: `PATCH /repos/:owner/:repo/git/refs/:ref <http://developer.github.com/v3/git/refs>`_ :param sha: string :param force: bool :rtype: None'
def edit(self, sha, force=github.GithubObject.NotSet):
assert isinstance(sha, (str, unicode)), sha assert ((force is github.GithubObject.NotSet) or isinstance(force, bool)), force post_parameters = {'sha': sha} if (force is not github.GithubObject.NotSet): post_parameters['force'] = force (headers, data) = self._requester.requestJsonAndCheck('PA...
':type: string'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: datetime.datetime'
@property def last_read_at(self):
self._completeIfNotSet(self._last_read_at) return self._last_read_at.value
':type: :class:`github.Repository.Repository`'
@property def repository(self):
self._completeIfNotSet(self._repository) return self._repository.value
':type: :class:`github.NotificationSubject.NotificationSubject`'
@property def subject(self):
self._completeIfNotSet(self._subject) return self._subject.value
':type: string'
@property def reason(self):
self._completeIfNotSet(self._reason) return self._reason.value
':type: string'
@property def subscription_url(self):
self._completeIfNotSet(self._subscription_url) return self._subscription_url.value
':type: bool'
@property def unread(self):
self._completeIfNotSet(self._unread) return self._unread.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: string'
@property def label(self):
return self._label.value
':type: string'
@property def ref(self):
return self._ref.value
':type: :class:`github.Repository.Repository`'
@property def repo(self):
return self._repo.value
':type: string'
@property def sha(self):
return self._sha.value
':type: :class:`github.NamedUser.NamedUser`'
@property def user(self):
return self._user.value
':type: string'
@property def avatar_url(self):
self._completeIfNotSet(self._avatar_url) return self._avatar_url.value
':type: string'
@property def bio(self):
self._completeIfNotSet(self._bio) return self._bio.value
':type: string'
@property def blog(self):
self._completeIfNotSet(self._blog) return self._blog.value
':type: integer'
@property def collaborators(self):
self._completeIfNotSet(self._collaborators) return self._collaborators.value
':type: string'
@property def company(self):
self._completeIfNotSet(self._company) return self._company.value
':type: integer'
@property def contributions(self):
self._completeIfNotSet(self._contributions) return self._contributions.value
':type: datetime.datetime'
@property def created_at(self):
self._completeIfNotSet(self._created_at) return self._created_at.value
':type: integer'
@property def disk_usage(self):
self._completeIfNotSet(self._disk_usage) return self._disk_usage.value
':type: string'
@property def email(self):
self._completeIfNotSet(self._email) return self._email.value
':type: string'
@property def events_url(self):
self._completeIfNotSet(self._events_url) return self._events_url.value
':type: integer'
@property def followers(self):
self._completeIfNotSet(self._followers) return self._followers.value
':type: string'
@property def followers_url(self):
self._completeIfNotSet(self._followers_url) return self._followers_url.value
':type: integer'
@property def following(self):
self._completeIfNotSet(self._following) return self._following.value
':type: string'
@property def following_url(self):
self._completeIfNotSet(self._following_url) return self._following_url.value
':type: string'
@property def gists_url(self):
self._completeIfNotSet(self._gists_url) return self._gists_url.value
':type: string'
@property def gravatar_id(self):
self._completeIfNotSet(self._gravatar_id) return self._gravatar_id.value
':type: bool'
@property def hireable(self):
self._completeIfNotSet(self._hireable) return self._hireable.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 location(self):
self._completeIfNotSet(self._location) return self._location.value
':type: string'
@property def login(self):
self._completeIfNotSet(self._login) return self._login.value
':type: string'
@property def name(self):
self._completeIfNotSet(self._name) return self._name.value
':type: string'
@property def organizations_url(self):
self._completeIfNotSet(self._organizations_url) return self._organizations_url.value
':type: integer'
@property def owned_private_repos(self):
self._completeIfNotSet(self._owned_private_repos) return self._owned_private_repos.value
':type: :class:`github.Plan.Plan`'
@property def plan(self):
self._completeIfNotSet(self._plan) return self._plan.value
':type: integer'
@property def private_gists(self):
self._completeIfNotSet(self._private_gists) return self._private_gists.value
':type: integer'
@property def public_gists(self):
self._completeIfNotSet(self._public_gists) return self._public_gists.value
':type: integer'
@property def public_repos(self):
self._completeIfNotSet(self._public_repos) return self._public_repos.value
':type: string'
@property def received_events_url(self):
self._completeIfNotSet(self._received_events_url) return self._received_events_url.value
':type: string'
@property def repos_url(self):
self._completeIfNotSet(self._repos_url) return self._repos_url.value
':type: string'
@property def starred_url(self):
self._completeIfNotSet(self._starred_url) return self._starred_url.value
':type: string'
@property def subscriptions_url(self):
self._completeIfNotSet(self._subscriptions_url) return self._subscriptions_url.value
':type: integer'
@property def total_private_repos(self):
self._completeIfNotSet(self._total_private_repos) return self._total_private_repos.value
':type: string'
@property def type(self):
self._completeIfNotSet(self._type) return self._type.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: `GET /users/:user/events <http://developer.github.com/v3/activity/events>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`'
def get_events(self):
return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, (self.url + '/events'), None)
':calls: `GET /users/:user/followers <http://developer.github.com/v3/users/followers>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`'
def get_followers(self):
return github.PaginatedList.PaginatedList(NamedUser, self._requester, (self.url + '/followers'), None)
':calls: `GET /users/:user/following <http://developer.github.com/v3/users/followers>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`'
def get_following(self):
return github.PaginatedList.PaginatedList(NamedUser, self._requester, (self.url + '/following'), None)
':calls: `GET /users/:user/gists <http://developer.github.com/v3/gists>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Gist.Gist`'
def get_gists(self):
return github.PaginatedList.PaginatedList(github.Gist.Gist, self._requester, (self.url + '/gists'), None)
':calls: `GET /users/:user/keys <http://developer.github.com/v3/users/keys>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.UserKey.UserKey`'
def get_keys(self):
return github.PaginatedList.PaginatedList(github.UserKey.UserKey, self._requester, (self.url + '/keys'), None)
':calls: `GET /users/:user/orgs <http://developer.github.com/v3/orgs>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Organization.Organization`'
def get_orgs(self):
return github.PaginatedList.PaginatedList(github.Organization.Organization, self._requester, (self.url + '/orgs'), None)
':calls: `GET /users/:user/events/public <http://developer.github.com/v3/activity/events>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`'
def get_public_events(self):
return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, (self.url + '/events/public'), None)
':calls: `GET /users/:user/received_events/public <http://developer.github.com/v3/activity/events>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`'
def get_public_received_events(self):
return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, (self.url + '/received_events/public'), None)
':calls: `GET /users/:user/received_events <http://developer.github.com/v3/activity/events>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`'
def get_received_events(self):
return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, (self.url + '/received_events'), None)
':calls: `GET /repos/:owner/:repo <http://developer.github.com/v3/repos>`_ :param name: string :rtype: :class:`github.Repository.Repository`'
def get_repo(self, name):
assert isinstance(name, (str, unicode)), name (headers, data) = self._requester.requestJsonAndCheck('GET', ((('/repos/' + self.login) + '/') + name)) return github.Repository.Repository(self._requester, headers, data, completed=True)
':calls: `GET /users/:user/repos <http://developer.github.com/v3/repos>`_ :param type: string :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_repos(self, type=github.GithubObject.NotSet):
assert ((type is github.GithubObject.NotSet) or isinstance(type, (str, unicode))), type url_parameters = dict() if (type is not github.GithubObject.NotSet): url_parameters['type'] = type return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, (self.url + '/repos'...
':calls: `GET /users/:user/starred <http://developer.github.com/v3/activity/starring>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_starred(self):
return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, (self.url + '/starred'), None)
':calls: `GET /users/:user/subscriptions <http://developer.github.com/v3/activity/watching>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_subscriptions(self):
return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, (self.url + '/subscriptions'), None)
':calls: `GET /users/:user/watched <http://developer.github.com/v3/activity/starring>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_watched(self):
return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, (self.url + '/watched'), None)
':calls: `GET /users/:user/following/:target_user <http://developer.github.com/v3/users/followers/#check-if-one-user-follows-another>`_ :param following: :class:`github.NamedUser.NamedUser` :rtype: bool'
def has_in_following(self, following):
assert isinstance(following, github.NamedUser.NamedUser), following (status, headers, data) = self._requester.requestJson('GET', ((self.url + '/following/') + following._identity)) return (status == 204)
':type: :class:`github.Commit.Commit`'
@property def commit(self):
return self._commit.value
':type: string'
@property def name(self):
return self._name.value
':type: datetime.datetime'
@property def week(self):
return self._week.value
':type: int'
@property def additions(self):
return self._additions.value
':type: int'
@property def deletions(self):
return self._deletions.value
':type: string'
@property def body(self):
return self._body.value
':type: string'
@property def status(self):
return self._status.value
':type: datetime.datetime'
@property def created_on(self):
return self._created_on.value
':type: string'
@property def sha(self):
self._completeIfNotSet(self._sha) return self._sha.value
':type: list of :class:`github.GitTreeElement.GitTreeElement`'
@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
':type: integer'
@property def limit(self):
return self._limit.value
':type: integer'
@property def remaining(self):
return self._remaining.value
':type: datetime.datetime'
@property def reset(self):
return self._reset.value
':type: string'
@property def avatar_url(self):
self._completeIfNotSet(self._avatar_url) return self._avatar_url.value
':type: string'
@property def bio(self):
self._completeIfNotSet(self._bio) return self._bio.value
':type: string'
@property def blog(self):
self._completeIfNotSet(self._blog) return self._blog.value
':type: integer'
@property def collaborators(self):
self._completeIfNotSet(self._collaborators) return self._collaborators.value
':type: string'
@property def company(self):
self._completeIfNotSet(self._company) return self._company.value
':type: datetime.datetime'
@property def created_at(self):
self._completeIfNotSet(self._created_at) return self._created_at.value
':type: integer'
@property def disk_usage(self):
self._completeIfNotSet(self._disk_usage) return self._disk_usage.value