repository_name
stringlengths 7
55
| func_path_in_repository
stringlengths 4
223
| func_name
stringlengths 1
134
| whole_func_string
stringlengths 75
104k
| language
stringclasses 1
value | func_code_string
stringlengths 75
104k
| func_code_tokens
listlengths 19
28.4k
| func_documentation_string
stringlengths 1
46.9k
| func_documentation_tokens
listlengths 1
1.97k
| split_name
stringclasses 1
value | func_code_url
stringlengths 87
315
|
|---|---|---|---|---|---|---|---|---|---|---|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.organization_memberships
|
def organization_memberships(self, state=None, number=-1, etag=None):
"""List organizations of which the user is a current or pending member.
:param str state: (option), state of the membership, i.e., active,
pending
:returns: iterator of :class:`Membership <github3.orgs.Membership>`
"""
params = None
url = self._build_url('user', 'memberships', 'orgs')
if state is not None and state.lower() in ('active', 'pending'):
params = {'state': state.lower()}
return self._iter(int(number), url, Membership,
params=params,
etag=etag)
|
python
|
def organization_memberships(self, state=None, number=-1, etag=None):
"""List organizations of which the user is a current or pending member.
:param str state: (option), state of the membership, i.e., active,
pending
:returns: iterator of :class:`Membership <github3.orgs.Membership>`
"""
params = None
url = self._build_url('user', 'memberships', 'orgs')
if state is not None and state.lower() in ('active', 'pending'):
params = {'state': state.lower()}
return self._iter(int(number), url, Membership,
params=params,
etag=etag)
|
[
"def",
"organization_memberships",
"(",
"self",
",",
"state",
"=",
"None",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"params",
"=",
"None",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
",",
"'memberships'",
",",
"'orgs'",
")",
"if",
"state",
"is",
"not",
"None",
"and",
"state",
".",
"lower",
"(",
")",
"in",
"(",
"'active'",
",",
"'pending'",
")",
":",
"params",
"=",
"{",
"'state'",
":",
"state",
".",
"lower",
"(",
")",
"}",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Membership",
",",
"params",
"=",
"params",
",",
"etag",
"=",
"etag",
")"
] |
List organizations of which the user is a current or pending member.
:param str state: (option), state of the membership, i.e., active,
pending
:returns: iterator of :class:`Membership <github3.orgs.Membership>`
|
[
"List",
"organizations",
"of",
"which",
"the",
"user",
"is",
"a",
"current",
"or",
"pending",
"member",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L974-L987
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.pubsubhubbub
|
def pubsubhubbub(self, mode, topic, callback, secret=''):
"""Create/update a pubsubhubbub hook.
:param str mode: (required), accepted values: ('subscribe',
'unsubscribe')
:param str topic: (required), form:
https://github.com/:user/:repo/events/:event
:param str callback: (required), the URI that receives the updates
:param str secret: (optional), shared secret key that generates a
SHA1 HMAC of the payload content.
:returns: bool
"""
from re import match
m = match('https?://[\w\d\-\.\:]+/\w+/[\w\._-]+/events/\w+', topic)
status = False
if mode and topic and callback and m:
data = [('hub.mode', mode), ('hub.topic', topic),
('hub.callback', callback)]
if secret:
data.append(('hub.secret', secret))
url = self._build_url('hub')
# This is not JSON data. It is meant to be form data
# application/x-www-form-urlencoded works fine here, no need for
# multipart/form-data
status = self._boolean(self._post(url, data=data, json=False), 204,
404)
return status
|
python
|
def pubsubhubbub(self, mode, topic, callback, secret=''):
"""Create/update a pubsubhubbub hook.
:param str mode: (required), accepted values: ('subscribe',
'unsubscribe')
:param str topic: (required), form:
https://github.com/:user/:repo/events/:event
:param str callback: (required), the URI that receives the updates
:param str secret: (optional), shared secret key that generates a
SHA1 HMAC of the payload content.
:returns: bool
"""
from re import match
m = match('https?://[\w\d\-\.\:]+/\w+/[\w\._-]+/events/\w+', topic)
status = False
if mode and topic and callback and m:
data = [('hub.mode', mode), ('hub.topic', topic),
('hub.callback', callback)]
if secret:
data.append(('hub.secret', secret))
url = self._build_url('hub')
# This is not JSON data. It is meant to be form data
# application/x-www-form-urlencoded works fine here, no need for
# multipart/form-data
status = self._boolean(self._post(url, data=data, json=False), 204,
404)
return status
|
[
"def",
"pubsubhubbub",
"(",
"self",
",",
"mode",
",",
"topic",
",",
"callback",
",",
"secret",
"=",
"''",
")",
":",
"from",
"re",
"import",
"match",
"m",
"=",
"match",
"(",
"'https?://[\\w\\d\\-\\.\\:]+/\\w+/[\\w\\._-]+/events/\\w+'",
",",
"topic",
")",
"status",
"=",
"False",
"if",
"mode",
"and",
"topic",
"and",
"callback",
"and",
"m",
":",
"data",
"=",
"[",
"(",
"'hub.mode'",
",",
"mode",
")",
",",
"(",
"'hub.topic'",
",",
"topic",
")",
",",
"(",
"'hub.callback'",
",",
"callback",
")",
"]",
"if",
"secret",
":",
"data",
".",
"append",
"(",
"(",
"'hub.secret'",
",",
"secret",
")",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'hub'",
")",
"# This is not JSON data. It is meant to be form data",
"# application/x-www-form-urlencoded works fine here, no need for",
"# multipart/form-data",
"status",
"=",
"self",
".",
"_boolean",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
",",
"json",
"=",
"False",
")",
",",
"204",
",",
"404",
")",
"return",
"status"
] |
Create/update a pubsubhubbub hook.
:param str mode: (required), accepted values: ('subscribe',
'unsubscribe')
:param str topic: (required), form:
https://github.com/:user/:repo/events/:event
:param str callback: (required), the URI that receives the updates
:param str secret: (optional), shared secret key that generates a
SHA1 HMAC of the payload content.
:returns: bool
|
[
"Create",
"/",
"update",
"a",
"pubsubhubbub",
"hook",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L990-L1016
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.pull_request
|
def pull_request(self, owner, repository, number):
"""Fetch pull_request #:number: from :owner:/:repository
:param str owner: (required), owner of the repository
:param str repository: (required), name of the repository
:param int number: (required), issue number
:return: :class:`Issue <github3.issues.Issue>`
"""
r = self.repository(owner, repository)
return r.pull_request(number) if r else None
|
python
|
def pull_request(self, owner, repository, number):
"""Fetch pull_request #:number: from :owner:/:repository
:param str owner: (required), owner of the repository
:param str repository: (required), name of the repository
:param int number: (required), issue number
:return: :class:`Issue <github3.issues.Issue>`
"""
r = self.repository(owner, repository)
return r.pull_request(number) if r else None
|
[
"def",
"pull_request",
"(",
"self",
",",
"owner",
",",
"repository",
",",
"number",
")",
":",
"r",
"=",
"self",
".",
"repository",
"(",
"owner",
",",
"repository",
")",
"return",
"r",
".",
"pull_request",
"(",
"number",
")",
"if",
"r",
"else",
"None"
] |
Fetch pull_request #:number: from :owner:/:repository
:param str owner: (required), owner of the repository
:param str repository: (required), name of the repository
:param int number: (required), issue number
:return: :class:`Issue <github3.issues.Issue>`
|
[
"Fetch",
"pull_request",
"#",
":",
"number",
":",
"from",
":",
"owner",
":",
"/",
":",
"repository"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1018-L1027
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.rate_limit
|
def rate_limit(self):
"""Returns a dictionary with information from /rate_limit.
The dictionary has two keys: ``resources`` and ``rate``. In
``resources`` you can access information about ``core`` or ``search``.
Note: the ``rate`` key will be deprecated before version 3 of the
GitHub API is finalized. Do not rely on that key. Instead, make your
code future-proof by using ``core`` in ``resources``, e.g.,
::
rates = g.rate_limit()
rates['resources']['core'] # => your normal ratelimit info
rates['resources']['search'] # => your search ratelimit info
.. versionadded:: 0.8
:returns: dict
"""
url = self._build_url('rate_limit')
return self._json(self._get(url), 200)
|
python
|
def rate_limit(self):
"""Returns a dictionary with information from /rate_limit.
The dictionary has two keys: ``resources`` and ``rate``. In
``resources`` you can access information about ``core`` or ``search``.
Note: the ``rate`` key will be deprecated before version 3 of the
GitHub API is finalized. Do not rely on that key. Instead, make your
code future-proof by using ``core`` in ``resources``, e.g.,
::
rates = g.rate_limit()
rates['resources']['core'] # => your normal ratelimit info
rates['resources']['search'] # => your search ratelimit info
.. versionadded:: 0.8
:returns: dict
"""
url = self._build_url('rate_limit')
return self._json(self._get(url), 200)
|
[
"def",
"rate_limit",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'rate_limit'",
")",
"return",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")"
] |
Returns a dictionary with information from /rate_limit.
The dictionary has two keys: ``resources`` and ``rate``. In
``resources`` you can access information about ``core`` or ``search``.
Note: the ``rate`` key will be deprecated before version 3 of the
GitHub API is finalized. Do not rely on that key. Instead, make your
code future-proof by using ``core`` in ``resources``, e.g.,
::
rates = g.rate_limit()
rates['resources']['core'] # => your normal ratelimit info
rates['resources']['search'] # => your search ratelimit info
.. versionadded:: 0.8
:returns: dict
|
[
"Returns",
"a",
"dictionary",
"with",
"information",
"from",
"/",
"rate_limit",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1029-L1050
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.repository
|
def repository(self, owner, repository):
"""Returns a Repository object for the specified combination of
owner and repository
:param str owner: (required)
:param str repository: (required)
:returns: :class:`Repository <github3.repos.Repository>`
"""
json = None
if owner and repository:
url = self._build_url('repos', owner, repository)
json = self._json(self._get(url), 200)
return Repository(json, self) if json else None
|
python
|
def repository(self, owner, repository):
"""Returns a Repository object for the specified combination of
owner and repository
:param str owner: (required)
:param str repository: (required)
:returns: :class:`Repository <github3.repos.Repository>`
"""
json = None
if owner and repository:
url = self._build_url('repos', owner, repository)
json = self._json(self._get(url), 200)
return Repository(json, self) if json else None
|
[
"def",
"repository",
"(",
"self",
",",
"owner",
",",
"repository",
")",
":",
"json",
"=",
"None",
"if",
"owner",
"and",
"repository",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'repos'",
",",
"owner",
",",
"repository",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Repository",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Returns a Repository object for the specified combination of
owner and repository
:param str owner: (required)
:param str repository: (required)
:returns: :class:`Repository <github3.repos.Repository>`
|
[
"Returns",
"a",
"Repository",
"object",
"for",
"the",
"specified",
"combination",
"of",
"owner",
"and",
"repository"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1052-L1064
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.revoke_authorization
|
def revoke_authorization(self, access_token):
"""Revoke specified authorization for an OAuth application.
Revoke all authorization tokens created by your application. This will
only work if you have already called ``set_client_id``.
:param str access_token: (required), the access_token to revoke
:returns: bool -- True if successful, False otherwise
"""
client_id, client_secret = self._session.retrieve_client_credentials()
url = self._build_url('applications', str(client_id), 'tokens',
access_token)
with self._session.temporary_basic_auth(client_id, client_secret):
response = self._delete(url, params={'client_id': None,
'client_secret': None})
return self._boolean(response, 204, 404)
|
python
|
def revoke_authorization(self, access_token):
"""Revoke specified authorization for an OAuth application.
Revoke all authorization tokens created by your application. This will
only work if you have already called ``set_client_id``.
:param str access_token: (required), the access_token to revoke
:returns: bool -- True if successful, False otherwise
"""
client_id, client_secret = self._session.retrieve_client_credentials()
url = self._build_url('applications', str(client_id), 'tokens',
access_token)
with self._session.temporary_basic_auth(client_id, client_secret):
response = self._delete(url, params={'client_id': None,
'client_secret': None})
return self._boolean(response, 204, 404)
|
[
"def",
"revoke_authorization",
"(",
"self",
",",
"access_token",
")",
":",
"client_id",
",",
"client_secret",
"=",
"self",
".",
"_session",
".",
"retrieve_client_credentials",
"(",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'applications'",
",",
"str",
"(",
"client_id",
")",
",",
"'tokens'",
",",
"access_token",
")",
"with",
"self",
".",
"_session",
".",
"temporary_basic_auth",
"(",
"client_id",
",",
"client_secret",
")",
":",
"response",
"=",
"self",
".",
"_delete",
"(",
"url",
",",
"params",
"=",
"{",
"'client_id'",
":",
"None",
",",
"'client_secret'",
":",
"None",
"}",
")",
"return",
"self",
".",
"_boolean",
"(",
"response",
",",
"204",
",",
"404",
")"
] |
Revoke specified authorization for an OAuth application.
Revoke all authorization tokens created by your application. This will
only work if you have already called ``set_client_id``.
:param str access_token: (required), the access_token to revoke
:returns: bool -- True if successful, False otherwise
|
[
"Revoke",
"specified",
"authorization",
"for",
"an",
"OAuth",
"application",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1067-L1083
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.search_code
|
def search_code(self, query, sort=None, order=None, per_page=None,
text_match=False, number=-1, etag=None):
"""Find code via the code search API.
The query can contain any combination of the following supported
qualifiers:
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the file contents, the file path, or
both.
- ``language`` Searches code based on the language it’s written in.
- ``fork`` Specifies that code from forked repositories should be
searched. Repository forks will not be searchable unless the fork
has more stars than the parent repository.
- ``size`` Finds files that match a certain size (in bytes).
- ``path`` Specifies the path that the resulting file must be at.
- ``extension`` Matches files with a certain extension.
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
For more information about these qualifiers, see: http://git.io/-DvAuA
:param str query: (required), a valid query as described above, e.g.,
``addClass in:file language:js repo:jquery/jquery``
:param str sort: (optional), how the results should be sorted;
option(s): ``indexed``; default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/iRmJxg for more information
:param int number: (optional), number of repositories to return.
Default: -1, returns all available repositories
:param str etag: (optional), previous ETag header value
:return: generator of :class:`CodeSearchResult
<github3.search.CodeSearchResult>`
"""
params = {'q': query}
headers = {}
if sort == 'indexed':
params['sort'] = sort
if sort and order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'code')
return SearchIterator(number, url, CodeSearchResult, self, params,
etag, headers)
|
python
|
def search_code(self, query, sort=None, order=None, per_page=None,
text_match=False, number=-1, etag=None):
"""Find code via the code search API.
The query can contain any combination of the following supported
qualifiers:
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the file contents, the file path, or
both.
- ``language`` Searches code based on the language it’s written in.
- ``fork`` Specifies that code from forked repositories should be
searched. Repository forks will not be searchable unless the fork
has more stars than the parent repository.
- ``size`` Finds files that match a certain size (in bytes).
- ``path`` Specifies the path that the resulting file must be at.
- ``extension`` Matches files with a certain extension.
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
For more information about these qualifiers, see: http://git.io/-DvAuA
:param str query: (required), a valid query as described above, e.g.,
``addClass in:file language:js repo:jquery/jquery``
:param str sort: (optional), how the results should be sorted;
option(s): ``indexed``; default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/iRmJxg for more information
:param int number: (optional), number of repositories to return.
Default: -1, returns all available repositories
:param str etag: (optional), previous ETag header value
:return: generator of :class:`CodeSearchResult
<github3.search.CodeSearchResult>`
"""
params = {'q': query}
headers = {}
if sort == 'indexed':
params['sort'] = sort
if sort and order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'code')
return SearchIterator(number, url, CodeSearchResult, self, params,
etag, headers)
|
[
"def",
"search_code",
"(",
"self",
",",
"query",
",",
"sort",
"=",
"None",
",",
"order",
"=",
"None",
",",
"per_page",
"=",
"None",
",",
"text_match",
"=",
"False",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'q'",
":",
"query",
"}",
"headers",
"=",
"{",
"}",
"if",
"sort",
"==",
"'indexed'",
":",
"params",
"[",
"'sort'",
"]",
"=",
"sort",
"if",
"sort",
"and",
"order",
"in",
"(",
"'asc'",
",",
"'desc'",
")",
":",
"params",
"[",
"'order'",
"]",
"=",
"order",
"if",
"text_match",
":",
"headers",
"=",
"{",
"'Accept'",
":",
"'application/vnd.github.v3.full.text-match+json'",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'search'",
",",
"'code'",
")",
"return",
"SearchIterator",
"(",
"number",
",",
"url",
",",
"CodeSearchResult",
",",
"self",
",",
"params",
",",
"etag",
",",
"headers",
")"
] |
Find code via the code search API.
The query can contain any combination of the following supported
qualifiers:
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the file contents, the file path, or
both.
- ``language`` Searches code based on the language it’s written in.
- ``fork`` Specifies that code from forked repositories should be
searched. Repository forks will not be searchable unless the fork
has more stars than the parent repository.
- ``size`` Finds files that match a certain size (in bytes).
- ``path`` Specifies the path that the resulting file must be at.
- ``extension`` Matches files with a certain extension.
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
For more information about these qualifiers, see: http://git.io/-DvAuA
:param str query: (required), a valid query as described above, e.g.,
``addClass in:file language:js repo:jquery/jquery``
:param str sort: (optional), how the results should be sorted;
option(s): ``indexed``; default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/iRmJxg for more information
:param int number: (optional), number of repositories to return.
Default: -1, returns all available repositories
:param str etag: (optional), previous ETag header value
:return: generator of :class:`CodeSearchResult
<github3.search.CodeSearchResult>`
|
[
"Find",
"code",
"via",
"the",
"code",
"search",
"API",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1103-L1156
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.search_issues
|
def search_issues(self, query, sort=None, order=None, per_page=None,
text_match=False, number=-1, etag=None):
"""Find issues by state and keyword
The query can contain any combination of the following supported
qualifers:
- ``type`` With this qualifier you can restrict the search to issues
or pull request only.
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the title, body, comments, or any
combination of these.
- ``author`` Finds issues created by a certain user.
- ``assignee`` Finds issues that are assigned to a certain user.
- ``mentions`` Finds issues that mention a certain user.
- ``commenter`` Finds issues that a certain user commented on.
- ``involves`` Finds issues that were either created by a certain user,
assigned to that user, mention that user, or were commented on by
that user.
- ``state`` Filter issues based on whether they’re open or closed.
- ``labels`` Filters issues based on their labels.
- ``language`` Searches for issues within repositories that match a
certain language.
- ``created`` or ``updated`` Filters issues based on times of creation,
or when they were last updated.
- ``comments`` Filters issues based on the quantity of comments.
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
For more information about these qualifiers, see: http://git.io/d1oELA
:param str query: (required), a valid query as described above, e.g.,
``windows label:bug``
:param str sort: (optional), how the results should be sorted;
options: ``created``, ``comments``, ``updated``;
default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/QLQuSQ for more information
:param int number: (optional), number of issues to return.
Default: -1, returns all available issues
:param str etag: (optional), previous ETag header value
:return: generator of :class:`IssueSearchResult
<github3.search.IssueSearchResult>`
"""
params = {'q': query}
headers = {}
if sort in ('comments', 'created', 'updated'):
params['sort'] = sort
if order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'issues')
return SearchIterator(number, url, IssueSearchResult, self, params,
etag, headers)
|
python
|
def search_issues(self, query, sort=None, order=None, per_page=None,
text_match=False, number=-1, etag=None):
"""Find issues by state and keyword
The query can contain any combination of the following supported
qualifers:
- ``type`` With this qualifier you can restrict the search to issues
or pull request only.
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the title, body, comments, or any
combination of these.
- ``author`` Finds issues created by a certain user.
- ``assignee`` Finds issues that are assigned to a certain user.
- ``mentions`` Finds issues that mention a certain user.
- ``commenter`` Finds issues that a certain user commented on.
- ``involves`` Finds issues that were either created by a certain user,
assigned to that user, mention that user, or were commented on by
that user.
- ``state`` Filter issues based on whether they’re open or closed.
- ``labels`` Filters issues based on their labels.
- ``language`` Searches for issues within repositories that match a
certain language.
- ``created`` or ``updated`` Filters issues based on times of creation,
or when they were last updated.
- ``comments`` Filters issues based on the quantity of comments.
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
For more information about these qualifiers, see: http://git.io/d1oELA
:param str query: (required), a valid query as described above, e.g.,
``windows label:bug``
:param str sort: (optional), how the results should be sorted;
options: ``created``, ``comments``, ``updated``;
default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/QLQuSQ for more information
:param int number: (optional), number of issues to return.
Default: -1, returns all available issues
:param str etag: (optional), previous ETag header value
:return: generator of :class:`IssueSearchResult
<github3.search.IssueSearchResult>`
"""
params = {'q': query}
headers = {}
if sort in ('comments', 'created', 'updated'):
params['sort'] = sort
if order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'issues')
return SearchIterator(number, url, IssueSearchResult, self, params,
etag, headers)
|
[
"def",
"search_issues",
"(",
"self",
",",
"query",
",",
"sort",
"=",
"None",
",",
"order",
"=",
"None",
",",
"per_page",
"=",
"None",
",",
"text_match",
"=",
"False",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'q'",
":",
"query",
"}",
"headers",
"=",
"{",
"}",
"if",
"sort",
"in",
"(",
"'comments'",
",",
"'created'",
",",
"'updated'",
")",
":",
"params",
"[",
"'sort'",
"]",
"=",
"sort",
"if",
"order",
"in",
"(",
"'asc'",
",",
"'desc'",
")",
":",
"params",
"[",
"'order'",
"]",
"=",
"order",
"if",
"text_match",
":",
"headers",
"=",
"{",
"'Accept'",
":",
"'application/vnd.github.v3.full.text-match+json'",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'search'",
",",
"'issues'",
")",
"return",
"SearchIterator",
"(",
"number",
",",
"url",
",",
"IssueSearchResult",
",",
"self",
",",
"params",
",",
"etag",
",",
"headers",
")"
] |
Find issues by state and keyword
The query can contain any combination of the following supported
qualifers:
- ``type`` With this qualifier you can restrict the search to issues
or pull request only.
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the title, body, comments, or any
combination of these.
- ``author`` Finds issues created by a certain user.
- ``assignee`` Finds issues that are assigned to a certain user.
- ``mentions`` Finds issues that mention a certain user.
- ``commenter`` Finds issues that a certain user commented on.
- ``involves`` Finds issues that were either created by a certain user,
assigned to that user, mention that user, or were commented on by
that user.
- ``state`` Filter issues based on whether they’re open or closed.
- ``labels`` Filters issues based on their labels.
- ``language`` Searches for issues within repositories that match a
certain language.
- ``created`` or ``updated`` Filters issues based on times of creation,
or when they were last updated.
- ``comments`` Filters issues based on the quantity of comments.
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
For more information about these qualifiers, see: http://git.io/d1oELA
:param str query: (required), a valid query as described above, e.g.,
``windows label:bug``
:param str sort: (optional), how the results should be sorted;
options: ``created``, ``comments``, ``updated``;
default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/QLQuSQ for more information
:param int number: (optional), number of issues to return.
Default: -1, returns all available issues
:param str etag: (optional), previous ETag header value
:return: generator of :class:`IssueSearchResult
<github3.search.IssueSearchResult>`
|
[
"Find",
"issues",
"by",
"state",
"and",
"keyword"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1158-L1221
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.search_repositories
|
def search_repositories(self, query, sort=None, order=None,
per_page=None, text_match=False, number=-1,
etag=None):
"""Find repositories via various criteria.
The query can contain any combination of the following supported
qualifers:
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the repository name, description,
readme, or any combination of these.
- ``size`` Finds repositories that match a certain size (in
kilobytes).
- ``forks`` Filters repositories based on the number of forks, and/or
whether forked repositories should be included in the results at
all.
- ``created`` or ``pushed`` Filters repositories based on times of
creation, or when they were last updated. Format: ``YYYY-MM-DD``.
Examples: ``created:<2011``, ``pushed:<2013-02``,
``pushed:>=2013-03-06``
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
- ``language`` Searches repositories based on the language they're
written in.
- ``stars`` Searches repositories based on the number of stars.
For more information about these qualifiers, see: http://git.io/4Z8AkA
:param str query: (required), a valid query as described above, e.g.,
``tetris language:assembly``
:param str sort: (optional), how the results should be sorted;
options: ``stars``, ``forks``, ``updated``; default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/4ct1eQ for more information
:param int number: (optional), number of repositories to return.
Default: -1, returns all available repositories
:param str etag: (optional), previous ETag header value
:return: generator of :class:`Repository <github3.repos.Repository>`
"""
params = {'q': query}
headers = {}
if sort in ('stars', 'forks', 'updated'):
params['sort'] = sort
if order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'repositories')
return SearchIterator(number, url, RepositorySearchResult, self,
params, etag, headers)
|
python
|
def search_repositories(self, query, sort=None, order=None,
per_page=None, text_match=False, number=-1,
etag=None):
"""Find repositories via various criteria.
The query can contain any combination of the following supported
qualifers:
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the repository name, description,
readme, or any combination of these.
- ``size`` Finds repositories that match a certain size (in
kilobytes).
- ``forks`` Filters repositories based on the number of forks, and/or
whether forked repositories should be included in the results at
all.
- ``created`` or ``pushed`` Filters repositories based on times of
creation, or when they were last updated. Format: ``YYYY-MM-DD``.
Examples: ``created:<2011``, ``pushed:<2013-02``,
``pushed:>=2013-03-06``
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
- ``language`` Searches repositories based on the language they're
written in.
- ``stars`` Searches repositories based on the number of stars.
For more information about these qualifiers, see: http://git.io/4Z8AkA
:param str query: (required), a valid query as described above, e.g.,
``tetris language:assembly``
:param str sort: (optional), how the results should be sorted;
options: ``stars``, ``forks``, ``updated``; default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/4ct1eQ for more information
:param int number: (optional), number of repositories to return.
Default: -1, returns all available repositories
:param str etag: (optional), previous ETag header value
:return: generator of :class:`Repository <github3.repos.Repository>`
"""
params = {'q': query}
headers = {}
if sort in ('stars', 'forks', 'updated'):
params['sort'] = sort
if order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'repositories')
return SearchIterator(number, url, RepositorySearchResult, self,
params, etag, headers)
|
[
"def",
"search_repositories",
"(",
"self",
",",
"query",
",",
"sort",
"=",
"None",
",",
"order",
"=",
"None",
",",
"per_page",
"=",
"None",
",",
"text_match",
"=",
"False",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'q'",
":",
"query",
"}",
"headers",
"=",
"{",
"}",
"if",
"sort",
"in",
"(",
"'stars'",
",",
"'forks'",
",",
"'updated'",
")",
":",
"params",
"[",
"'sort'",
"]",
"=",
"sort",
"if",
"order",
"in",
"(",
"'asc'",
",",
"'desc'",
")",
":",
"params",
"[",
"'order'",
"]",
"=",
"order",
"if",
"text_match",
":",
"headers",
"=",
"{",
"'Accept'",
":",
"'application/vnd.github.v3.full.text-match+json'",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'search'",
",",
"'repositories'",
")",
"return",
"SearchIterator",
"(",
"number",
",",
"url",
",",
"RepositorySearchResult",
",",
"self",
",",
"params",
",",
"etag",
",",
"headers",
")"
] |
Find repositories via various criteria.
The query can contain any combination of the following supported
qualifers:
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the repository name, description,
readme, or any combination of these.
- ``size`` Finds repositories that match a certain size (in
kilobytes).
- ``forks`` Filters repositories based on the number of forks, and/or
whether forked repositories should be included in the results at
all.
- ``created`` or ``pushed`` Filters repositories based on times of
creation, or when they were last updated. Format: ``YYYY-MM-DD``.
Examples: ``created:<2011``, ``pushed:<2013-02``,
``pushed:>=2013-03-06``
- ``user`` or ``repo`` Limits searches to a specific user or
repository.
- ``language`` Searches repositories based on the language they're
written in.
- ``stars`` Searches repositories based on the number of stars.
For more information about these qualifiers, see: http://git.io/4Z8AkA
:param str query: (required), a valid query as described above, e.g.,
``tetris language:assembly``
:param str sort: (optional), how the results should be sorted;
options: ``stars``, ``forks``, ``updated``; default: best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/4ct1eQ for more information
:param int number: (optional), number of repositories to return.
Default: -1, returns all available repositories
:param str etag: (optional), previous ETag header value
:return: generator of :class:`Repository <github3.repos.Repository>`
|
[
"Find",
"repositories",
"via",
"various",
"criteria",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1223-L1281
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.search_users
|
def search_users(self, query, sort=None, order=None, per_page=None,
text_match=False, number=-1, etag=None):
"""Find users via the Search API.
The query can contain any combination of the following supported
qualifers:
- ``type`` With this qualifier you can restrict the search to just
personal accounts or just organization accounts.
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the username, public email, full
name, or any combination of these.
- ``repos`` Filters users based on the number of repositories they
have.
- ``location`` Filter users by the location indicated in their
profile.
- ``language`` Search for users that have repositories that match a
certain language.
- ``created`` Filter users based on when they joined.
- ``followers`` Filter users based on the number of followers they
have.
For more information about these qualifiers see: http://git.io/wjVYJw
:param str query: (required), a valid query as described above, e.g.,
``tom repos:>42 followers:>1000``
:param str sort: (optional), how the results should be sorted;
options: ``followers``, ``repositories``, or ``joined``; default:
best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/_V1zRwa for more information
:param int number: (optional), number of search results to return;
Default: -1 returns all available
:param str etag: (optional), ETag header value of the last request.
:return: generator of :class:`UserSearchResult
<github3.search.UserSearchResult>`
"""
params = {'q': query}
headers = {}
if sort in ('followers', 'repositories', 'joined'):
params['sort'] = sort
if order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'users')
return SearchIterator(number, url, UserSearchResult, self, params,
etag, headers)
|
python
|
def search_users(self, query, sort=None, order=None, per_page=None,
text_match=False, number=-1, etag=None):
"""Find users via the Search API.
The query can contain any combination of the following supported
qualifers:
- ``type`` With this qualifier you can restrict the search to just
personal accounts or just organization accounts.
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the username, public email, full
name, or any combination of these.
- ``repos`` Filters users based on the number of repositories they
have.
- ``location`` Filter users by the location indicated in their
profile.
- ``language`` Search for users that have repositories that match a
certain language.
- ``created`` Filter users based on when they joined.
- ``followers`` Filter users based on the number of followers they
have.
For more information about these qualifiers see: http://git.io/wjVYJw
:param str query: (required), a valid query as described above, e.g.,
``tom repos:>42 followers:>1000``
:param str sort: (optional), how the results should be sorted;
options: ``followers``, ``repositories``, or ``joined``; default:
best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/_V1zRwa for more information
:param int number: (optional), number of search results to return;
Default: -1 returns all available
:param str etag: (optional), ETag header value of the last request.
:return: generator of :class:`UserSearchResult
<github3.search.UserSearchResult>`
"""
params = {'q': query}
headers = {}
if sort in ('followers', 'repositories', 'joined'):
params['sort'] = sort
if order in ('asc', 'desc'):
params['order'] = order
if text_match:
headers = {
'Accept': 'application/vnd.github.v3.full.text-match+json'
}
url = self._build_url('search', 'users')
return SearchIterator(number, url, UserSearchResult, self, params,
etag, headers)
|
[
"def",
"search_users",
"(",
"self",
",",
"query",
",",
"sort",
"=",
"None",
",",
"order",
"=",
"None",
",",
"per_page",
"=",
"None",
",",
"text_match",
"=",
"False",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'q'",
":",
"query",
"}",
"headers",
"=",
"{",
"}",
"if",
"sort",
"in",
"(",
"'followers'",
",",
"'repositories'",
",",
"'joined'",
")",
":",
"params",
"[",
"'sort'",
"]",
"=",
"sort",
"if",
"order",
"in",
"(",
"'asc'",
",",
"'desc'",
")",
":",
"params",
"[",
"'order'",
"]",
"=",
"order",
"if",
"text_match",
":",
"headers",
"=",
"{",
"'Accept'",
":",
"'application/vnd.github.v3.full.text-match+json'",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'search'",
",",
"'users'",
")",
"return",
"SearchIterator",
"(",
"number",
",",
"url",
",",
"UserSearchResult",
",",
"self",
",",
"params",
",",
"etag",
",",
"headers",
")"
] |
Find users via the Search API.
The query can contain any combination of the following supported
qualifers:
- ``type`` With this qualifier you can restrict the search to just
personal accounts or just organization accounts.
- ``in`` Qualifies which fields are searched. With this qualifier you
can restrict the search to just the username, public email, full
name, or any combination of these.
- ``repos`` Filters users based on the number of repositories they
have.
- ``location`` Filter users by the location indicated in their
profile.
- ``language`` Search for users that have repositories that match a
certain language.
- ``created`` Filter users based on when they joined.
- ``followers`` Filter users based on the number of followers they
have.
For more information about these qualifiers see: http://git.io/wjVYJw
:param str query: (required), a valid query as described above, e.g.,
``tom repos:>42 followers:>1000``
:param str sort: (optional), how the results should be sorted;
options: ``followers``, ``repositories``, or ``joined``; default:
best match
:param str order: (optional), the direction of the sorted results,
options: ``asc``, ``desc``; default: ``desc``
:param int per_page: (optional)
:param bool text_match: (optional), if True, return matching search
terms. See http://git.io/_V1zRwa for more information
:param int number: (optional), number of search results to return;
Default: -1 returns all available
:param str etag: (optional), ETag header value of the last request.
:return: generator of :class:`UserSearchResult
<github3.search.UserSearchResult>`
|
[
"Find",
"users",
"via",
"the",
"Search",
"API",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1283-L1340
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.star
|
def star(self, login, repo):
"""Star to login/repo
:param str login: (required), owner of the repo
:param str repo: (required), name of the repo
:return: bool
"""
resp = False
if login and repo:
url = self._build_url('user', 'starred', login, repo)
resp = self._boolean(self._put(url), 204, 404)
return resp
|
python
|
def star(self, login, repo):
"""Star to login/repo
:param str login: (required), owner of the repo
:param str repo: (required), name of the repo
:return: bool
"""
resp = False
if login and repo:
url = self._build_url('user', 'starred', login, repo)
resp = self._boolean(self._put(url), 204, 404)
return resp
|
[
"def",
"star",
"(",
"self",
",",
"login",
",",
"repo",
")",
":",
"resp",
"=",
"False",
"if",
"login",
"and",
"repo",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
",",
"'starred'",
",",
"login",
",",
"repo",
")",
"resp",
"=",
"self",
".",
"_boolean",
"(",
"self",
".",
"_put",
"(",
"url",
")",
",",
"204",
",",
"404",
")",
"return",
"resp"
] |
Star to login/repo
:param str login: (required), owner of the repo
:param str repo: (required), name of the repo
:return: bool
|
[
"Star",
"to",
"login",
"/",
"repo"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1364-L1375
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.unfollow
|
def unfollow(self, login):
"""Make the authenticated user stop following login
:param str login: (required)
:returns: bool
"""
resp = False
if login:
url = self._build_url('user', 'following', login)
resp = self._boolean(self._delete(url), 204, 404)
return resp
|
python
|
def unfollow(self, login):
"""Make the authenticated user stop following login
:param str login: (required)
:returns: bool
"""
resp = False
if login:
url = self._build_url('user', 'following', login)
resp = self._boolean(self._delete(url), 204, 404)
return resp
|
[
"def",
"unfollow",
"(",
"self",
",",
"login",
")",
":",
"resp",
"=",
"False",
"if",
"login",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
",",
"'following'",
",",
"login",
")",
"resp",
"=",
"self",
".",
"_boolean",
"(",
"self",
".",
"_delete",
"(",
"url",
")",
",",
"204",
",",
"404",
")",
"return",
"resp"
] |
Make the authenticated user stop following login
:param str login: (required)
:returns: bool
|
[
"Make",
"the",
"authenticated",
"user",
"stop",
"following",
"login"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1392-L1402
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.unstar
|
def unstar(self, login, repo):
"""Unstar to login/repo
:param str login: (required), owner of the repo
:param str repo: (required), name of the repo
:return: bool
"""
resp = False
if login and repo:
url = self._build_url('user', 'starred', login, repo)
resp = self._boolean(self._delete(url), 204, 404)
return resp
|
python
|
def unstar(self, login, repo):
"""Unstar to login/repo
:param str login: (required), owner of the repo
:param str repo: (required), name of the repo
:return: bool
"""
resp = False
if login and repo:
url = self._build_url('user', 'starred', login, repo)
resp = self._boolean(self._delete(url), 204, 404)
return resp
|
[
"def",
"unstar",
"(",
"self",
",",
"login",
",",
"repo",
")",
":",
"resp",
"=",
"False",
"if",
"login",
"and",
"repo",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
",",
"'starred'",
",",
"login",
",",
"repo",
")",
"resp",
"=",
"self",
".",
"_boolean",
"(",
"self",
".",
"_delete",
"(",
"url",
")",
",",
"204",
",",
"404",
")",
"return",
"resp"
] |
Unstar to login/repo
:param str login: (required), owner of the repo
:param str repo: (required), name of the repo
:return: bool
|
[
"Unstar",
"to",
"login",
"/",
"repo"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1405-L1416
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.update_user
|
def update_user(self, name=None, email=None, blog=None,
company=None, location=None, hireable=False, bio=None):
"""If authenticated as this user, update the information with
the information provided in the parameters. All parameters are
optional.
:param str name: e.g., 'John Smith', not login name
:param str email: e.g., 'john.smith@example.com'
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
:param str company: company name
:param str location: where you are located
:param bool hireable: defaults to False
:param str bio: GitHub flavored markdown
:returns: bool
"""
user = self.user()
return user.update(name, email, blog, company, location, hireable,
bio)
|
python
|
def update_user(self, name=None, email=None, blog=None,
company=None, location=None, hireable=False, bio=None):
"""If authenticated as this user, update the information with
the information provided in the parameters. All parameters are
optional.
:param str name: e.g., 'John Smith', not login name
:param str email: e.g., 'john.smith@example.com'
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
:param str company: company name
:param str location: where you are located
:param bool hireable: defaults to False
:param str bio: GitHub flavored markdown
:returns: bool
"""
user = self.user()
return user.update(name, email, blog, company, location, hireable,
bio)
|
[
"def",
"update_user",
"(",
"self",
",",
"name",
"=",
"None",
",",
"email",
"=",
"None",
",",
"blog",
"=",
"None",
",",
"company",
"=",
"None",
",",
"location",
"=",
"None",
",",
"hireable",
"=",
"False",
",",
"bio",
"=",
"None",
")",
":",
"user",
"=",
"self",
".",
"user",
"(",
")",
"return",
"user",
".",
"update",
"(",
"name",
",",
"email",
",",
"blog",
",",
"company",
",",
"location",
",",
"hireable",
",",
"bio",
")"
] |
If authenticated as this user, update the information with
the information provided in the parameters. All parameters are
optional.
:param str name: e.g., 'John Smith', not login name
:param str email: e.g., 'john.smith@example.com'
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
:param str company: company name
:param str location: where you are located
:param bool hireable: defaults to False
:param str bio: GitHub flavored markdown
:returns: bool
|
[
"If",
"authenticated",
"as",
"this",
"user",
"update",
"the",
"information",
"with",
"the",
"information",
"provided",
"in",
"the",
"parameters",
".",
"All",
"parameters",
"are",
"optional",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1433-L1450
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.user
|
def user(self, login=None):
"""Returns a User object for the specified login name if
provided. If no login name is provided, this will return a User
object for the authenticated user.
:param str login: (optional)
:returns: :class:`User <github3.users.User>`
"""
if login:
url = self._build_url('users', login)
else:
url = self._build_url('user')
json = self._json(self._get(url), 200)
return User(json, self._session) if json else None
|
python
|
def user(self, login=None):
"""Returns a User object for the specified login name if
provided. If no login name is provided, this will return a User
object for the authenticated user.
:param str login: (optional)
:returns: :class:`User <github3.users.User>`
"""
if login:
url = self._build_url('users', login)
else:
url = self._build_url('user')
json = self._json(self._get(url), 200)
return User(json, self._session) if json else None
|
[
"def",
"user",
"(",
"self",
",",
"login",
"=",
"None",
")",
":",
"if",
"login",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'users'",
",",
"login",
")",
"else",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"User",
"(",
"json",
",",
"self",
".",
"_session",
")",
"if",
"json",
"else",
"None"
] |
Returns a User object for the specified login name if
provided. If no login name is provided, this will return a User
object for the authenticated user.
:param str login: (optional)
:returns: :class:`User <github3.users.User>`
|
[
"Returns",
"a",
"User",
"object",
"for",
"the",
"specified",
"login",
"name",
"if",
"provided",
".",
"If",
"no",
"login",
"name",
"is",
"provided",
"this",
"will",
"return",
"a",
"User",
"object",
"for",
"the",
"authenticated",
"user",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1452-L1466
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHub.zen
|
def zen(self):
"""Returns a quote from the Zen of GitHub. Yet another API Easter Egg
:returns: str
"""
url = self._build_url('zen')
resp = self._get(url)
return resp.content if resp.status_code == 200 else ''
|
python
|
def zen(self):
"""Returns a quote from the Zen of GitHub. Yet another API Easter Egg
:returns: str
"""
url = self._build_url('zen')
resp = self._get(url)
return resp.content if resp.status_code == 200 else ''
|
[
"def",
"zen",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'zen'",
")",
"resp",
"=",
"self",
".",
"_get",
"(",
"url",
")",
"return",
"resp",
".",
"content",
"if",
"resp",
".",
"status_code",
"==",
"200",
"else",
"''"
] |
Returns a quote from the Zen of GitHub. Yet another API Easter Egg
:returns: str
|
[
"Returns",
"a",
"quote",
"from",
"the",
"Zen",
"of",
"GitHub",
".",
"Yet",
"another",
"API",
"Easter",
"Egg"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1468-L1475
|
kislyuk/aegea
|
aegea/packages/github3/github.py
|
GitHubEnterprise.admin_stats
|
def admin_stats(self, option):
"""This is a simple way to get statistics about your system.
:param str option: (required), accepted values: ('all', 'repos',
'hooks', 'pages', 'orgs', 'users', 'pulls', 'issues',
'milestones', 'gists', 'comments')
:returns: dict
"""
stats = {}
if option.lower() in ('all', 'repos', 'hooks', 'pages', 'orgs',
'users', 'pulls', 'issues', 'milestones',
'gists', 'comments'):
url = self._build_url('enterprise', 'stats', option.lower())
stats = self._json(self._get(url), 200)
return stats
|
python
|
def admin_stats(self, option):
"""This is a simple way to get statistics about your system.
:param str option: (required), accepted values: ('all', 'repos',
'hooks', 'pages', 'orgs', 'users', 'pulls', 'issues',
'milestones', 'gists', 'comments')
:returns: dict
"""
stats = {}
if option.lower() in ('all', 'repos', 'hooks', 'pages', 'orgs',
'users', 'pulls', 'issues', 'milestones',
'gists', 'comments'):
url = self._build_url('enterprise', 'stats', option.lower())
stats = self._json(self._get(url), 200)
return stats
|
[
"def",
"admin_stats",
"(",
"self",
",",
"option",
")",
":",
"stats",
"=",
"{",
"}",
"if",
"option",
".",
"lower",
"(",
")",
"in",
"(",
"'all'",
",",
"'repos'",
",",
"'hooks'",
",",
"'pages'",
",",
"'orgs'",
",",
"'users'",
",",
"'pulls'",
",",
"'issues'",
",",
"'milestones'",
",",
"'gists'",
",",
"'comments'",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'enterprise'",
",",
"'stats'",
",",
"option",
".",
"lower",
"(",
")",
")",
"stats",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"stats"
] |
This is a simple way to get statistics about your system.
:param str option: (required), accepted values: ('all', 'repos',
'hooks', 'pages', 'orgs', 'users', 'pulls', 'issues',
'milestones', 'gists', 'comments')
:returns: dict
|
[
"This",
"is",
"a",
"simple",
"way",
"to",
"get",
"statistics",
"about",
"your",
"system",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/github.py#L1499-L1513
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
Key.update
|
def update(self, title, key):
"""Update this key.
:param str title: (required), title of the key
:param str key: (required), text of the key file
:returns: bool
"""
json = None
if title and key:
data = {'title': title, 'key': key}
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_(json)
return True
return False
|
python
|
def update(self, title, key):
"""Update this key.
:param str title: (required), title of the key
:param str key: (required), text of the key file
:returns: bool
"""
json = None
if title and key:
data = {'title': title, 'key': key}
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_(json)
return True
return False
|
[
"def",
"update",
"(",
"self",
",",
"title",
",",
"key",
")",
":",
"json",
"=",
"None",
"if",
"title",
"and",
"key",
":",
"data",
"=",
"{",
"'title'",
":",
"title",
",",
"'key'",
":",
"key",
"}",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_patch",
"(",
"self",
".",
"_api",
",",
"data",
"=",
"dumps",
"(",
"data",
")",
")",
",",
"200",
")",
"if",
"json",
":",
"self",
".",
"_update_",
"(",
"json",
")",
"return",
"True",
"return",
"False"
] |
Update this key.
:param str title: (required), title of the key
:param str key: (required), text of the key file
:returns: bool
|
[
"Update",
"this",
"key",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L57-L71
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.add_email_addresses
|
def add_email_addresses(self, addresses=[]):
"""Add the email addresses in ``addresses`` to the authenticated
user's account.
:param list addresses: (optional), email addresses to be added
:returns: list of email addresses
"""
json = []
if addresses:
url = self._build_url('user', 'emails')
json = self._json(self._post(url, data=addresses), 201)
return json
|
python
|
def add_email_addresses(self, addresses=[]):
"""Add the email addresses in ``addresses`` to the authenticated
user's account.
:param list addresses: (optional), email addresses to be added
:returns: list of email addresses
"""
json = []
if addresses:
url = self._build_url('user', 'emails')
json = self._json(self._post(url, data=addresses), 201)
return json
|
[
"def",
"add_email_addresses",
"(",
"self",
",",
"addresses",
"=",
"[",
"]",
")",
":",
"json",
"=",
"[",
"]",
"if",
"addresses",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
",",
"'emails'",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"addresses",
")",
",",
"201",
")",
"return",
"json"
] |
Add the email addresses in ``addresses`` to the authenticated
user's account.
:param list addresses: (optional), email addresses to be added
:returns: list of email addresses
|
[
"Add",
"the",
"email",
"addresses",
"in",
"addresses",
"to",
"the",
"authenticated",
"user",
"s",
"account",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L200-L211
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.delete_email_addresses
|
def delete_email_addresses(self, addresses=[]):
"""Delete the email addresses in ``addresses`` from the
authenticated user's account.
:param list addresses: (optional), email addresses to be removed
:returns: bool
"""
url = self._build_url('user', 'emails')
return self._boolean(self._delete(url, data=dumps(addresses)),
204, 404)
|
python
|
def delete_email_addresses(self, addresses=[]):
"""Delete the email addresses in ``addresses`` from the
authenticated user's account.
:param list addresses: (optional), email addresses to be removed
:returns: bool
"""
url = self._build_url('user', 'emails')
return self._boolean(self._delete(url, data=dumps(addresses)),
204, 404)
|
[
"def",
"delete_email_addresses",
"(",
"self",
",",
"addresses",
"=",
"[",
"]",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
",",
"'emails'",
")",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_delete",
"(",
"url",
",",
"data",
"=",
"dumps",
"(",
"addresses",
")",
")",
",",
"204",
",",
"404",
")"
] |
Delete the email addresses in ``addresses`` from the
authenticated user's account.
:param list addresses: (optional), email addresses to be removed
:returns: bool
|
[
"Delete",
"the",
"email",
"addresses",
"in",
"addresses",
"from",
"the",
"authenticated",
"user",
"s",
"account",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L223-L232
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.is_assignee_on
|
def is_assignee_on(self, login, repository):
"""Checks if this user can be assigned to issues on login/repository.
:returns: :class:`bool`
"""
url = self._build_url('repos', login, repository, 'assignees',
self.login)
return self._boolean(self._get(url), 204, 404)
|
python
|
def is_assignee_on(self, login, repository):
"""Checks if this user can be assigned to issues on login/repository.
:returns: :class:`bool`
"""
url = self._build_url('repos', login, repository, 'assignees',
self.login)
return self._boolean(self._get(url), 204, 404)
|
[
"def",
"is_assignee_on",
"(",
"self",
",",
"login",
",",
"repository",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'repos'",
",",
"login",
",",
"repository",
",",
"'assignees'",
",",
"self",
".",
"login",
")",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"204",
",",
"404",
")"
] |
Checks if this user can be assigned to issues on login/repository.
:returns: :class:`bool`
|
[
"Checks",
"if",
"this",
"user",
"can",
"be",
"assigned",
"to",
"issues",
"on",
"login",
"/",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L234-L241
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.is_following
|
def is_following(self, login):
"""Checks if this user is following ``login``.
:param str login: (required)
:returns: bool
"""
url = self.following_urlt.expand(other_user=login)
return self._boolean(self._get(url), 204, 404)
|
python
|
def is_following(self, login):
"""Checks if this user is following ``login``.
:param str login: (required)
:returns: bool
"""
url = self.following_urlt.expand(other_user=login)
return self._boolean(self._get(url), 204, 404)
|
[
"def",
"is_following",
"(",
"self",
",",
"login",
")",
":",
"url",
"=",
"self",
".",
"following_urlt",
".",
"expand",
"(",
"other_user",
"=",
"login",
")",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"204",
",",
"404",
")"
] |
Checks if this user is following ``login``.
:param str login: (required)
:returns: bool
|
[
"Checks",
"if",
"this",
"user",
"is",
"following",
"login",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L243-L251
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_events
|
def iter_events(self, public=False, number=-1, etag=None):
"""Iterate over events performed by this user.
:param bool public: (optional), only list public events for the
authenticated user
:param int number: (optional), number of events to return. Default: -1
returns all available events.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.events.Event>`\ s
"""
path = ['events']
if public:
path.append('public')
url = self._build_url(*path, base_url=self._api)
return self._iter(int(number), url, Event, etag=etag)
|
python
|
def iter_events(self, public=False, number=-1, etag=None):
"""Iterate over events performed by this user.
:param bool public: (optional), only list public events for the
authenticated user
:param int number: (optional), number of events to return. Default: -1
returns all available events.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.events.Event>`\ s
"""
path = ['events']
if public:
path.append('public')
url = self._build_url(*path, base_url=self._api)
return self._iter(int(number), url, Event, etag=etag)
|
[
"def",
"iter_events",
"(",
"self",
",",
"public",
"=",
"False",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"path",
"=",
"[",
"'events'",
"]",
"if",
"public",
":",
"path",
".",
"append",
"(",
"'public'",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"*",
"path",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Event",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over events performed by this user.
:param bool public: (optional), only list public events for the
authenticated user
:param int number: (optional), number of events to return. Default: -1
returns all available events.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.events.Event>`\ s
|
[
"Iterate",
"over",
"events",
"performed",
"by",
"this",
"user",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L253-L268
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_followers
|
def iter_followers(self, number=-1, etag=None):
"""Iterate over the followers of this user.
:param int number: (optional), number of followers to return. Default:
-1 returns all available
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <User>`\ s
"""
url = self._build_url('followers', base_url=self._api)
return self._iter(int(number), url, User, etag=etag)
|
python
|
def iter_followers(self, number=-1, etag=None):
"""Iterate over the followers of this user.
:param int number: (optional), number of followers to return. Default:
-1 returns all available
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <User>`\ s
"""
url = self._build_url('followers', base_url=self._api)
return self._iter(int(number), url, User, etag=etag)
|
[
"def",
"iter_followers",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'followers'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"User",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over the followers of this user.
:param int number: (optional), number of followers to return. Default:
-1 returns all available
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <User>`\ s
|
[
"Iterate",
"over",
"the",
"followers",
"of",
"this",
"user",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L270-L280
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_keys
|
def iter_keys(self, number=-1, etag=None):
"""Iterate over the public keys of this user.
.. versionadded:: 0.5
:param int number: (optional), number of keys to return. Default: -1
returns all available keys
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Key <Key>`\ s
"""
url = self._build_url('keys', base_url=self._api)
return self._iter(int(number), url, Key, etag=etag)
|
python
|
def iter_keys(self, number=-1, etag=None):
"""Iterate over the public keys of this user.
.. versionadded:: 0.5
:param int number: (optional), number of keys to return. Default: -1
returns all available keys
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Key <Key>`\ s
"""
url = self._build_url('keys', base_url=self._api)
return self._iter(int(number), url, Key, etag=etag)
|
[
"def",
"iter_keys",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'keys'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Key",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over the public keys of this user.
.. versionadded:: 0.5
:param int number: (optional), number of keys to return. Default: -1
returns all available keys
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Key <Key>`\ s
|
[
"Iterate",
"over",
"the",
"public",
"keys",
"of",
"this",
"user",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L294-L306
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_org_events
|
def iter_org_events(self, org, number=-1, etag=None):
"""Iterate over events as they appear on the user's organization
dashboard. You must be authenticated to view this.
:param str org: (required), name of the organization
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.events.Event>`\ s
"""
url = ''
if org:
url = self._build_url('events', 'orgs', org, base_url=self._api)
return self._iter(int(number), url, Event, etag=etag)
|
python
|
def iter_org_events(self, org, number=-1, etag=None):
"""Iterate over events as they appear on the user's organization
dashboard. You must be authenticated to view this.
:param str org: (required), name of the organization
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.events.Event>`\ s
"""
url = ''
if org:
url = self._build_url('events', 'orgs', org, base_url=self._api)
return self._iter(int(number), url, Event, etag=etag)
|
[
"def",
"iter_org_events",
"(",
"self",
",",
"org",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"''",
"if",
"org",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'events'",
",",
"'orgs'",
",",
"org",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Event",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over events as they appear on the user's organization
dashboard. You must be authenticated to view this.
:param str org: (required), name of the organization
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.events.Event>`\ s
|
[
"Iterate",
"over",
"events",
"as",
"they",
"appear",
"on",
"the",
"user",
"s",
"organization",
"dashboard",
".",
"You",
"must",
"be",
"authenticated",
"to",
"view",
"this",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L308-L322
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_orgs
|
def iter_orgs(self, number=-1, etag=None):
"""Iterate over organizations the user is member of
:param int number: (optional), number of organizations to return.
Default: -1 returns all available organization
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.orgs.Organization>`\ s
"""
# Import here, because a toplevel import causes an import loop
from .orgs import Organization
url = self._build_url('orgs', base_url=self._api)
return self._iter(int(number), url, Organization, etag=etag)
|
python
|
def iter_orgs(self, number=-1, etag=None):
"""Iterate over organizations the user is member of
:param int number: (optional), number of organizations to return.
Default: -1 returns all available organization
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.orgs.Organization>`\ s
"""
# Import here, because a toplevel import causes an import loop
from .orgs import Organization
url = self._build_url('orgs', base_url=self._api)
return self._iter(int(number), url, Organization, etag=etag)
|
[
"def",
"iter_orgs",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"# Import here, because a toplevel import causes an import loop",
"from",
".",
"orgs",
"import",
"Organization",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'orgs'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Organization",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over organizations the user is member of
:param int number: (optional), number of organizations to return.
Default: -1 returns all available organization
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: list of :class:`Event <github3.orgs.Organization>`\ s
|
[
"Iterate",
"over",
"organizations",
"the",
"user",
"is",
"member",
"of"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L343-L355
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_starred
|
def iter_starred(self, sort=None, direction=None, number=-1, etag=None):
"""Iterate over repositories starred by this user.
.. versionchanged:: 0.5
Added sort and direction parameters (optional) as per the change in
GitHub's API.
:param int number: (optional), number of starred repos to return.
Default: -1, returns all available repos
:param str sort: (optional), either 'created' (when the star was
created) or 'updated' (when the repository was last pushed to)
:param str direction: (optional), either 'asc' or 'desc'. Default:
'desc'
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
"""
from .repos import Repository
params = {'sort': sort, 'direction': direction}
self._remove_none(params)
url = self.starred_urlt.expand(owner=None, repo=None)
return self._iter(int(number), url, Repository, params, etag)
|
python
|
def iter_starred(self, sort=None, direction=None, number=-1, etag=None):
"""Iterate over repositories starred by this user.
.. versionchanged:: 0.5
Added sort and direction parameters (optional) as per the change in
GitHub's API.
:param int number: (optional), number of starred repos to return.
Default: -1, returns all available repos
:param str sort: (optional), either 'created' (when the star was
created) or 'updated' (when the repository was last pushed to)
:param str direction: (optional), either 'asc' or 'desc'. Default:
'desc'
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
"""
from .repos import Repository
params = {'sort': sort, 'direction': direction}
self._remove_none(params)
url = self.starred_urlt.expand(owner=None, repo=None)
return self._iter(int(number), url, Repository, params, etag)
|
[
"def",
"iter_starred",
"(",
"self",
",",
"sort",
"=",
"None",
",",
"direction",
"=",
"None",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"from",
".",
"repos",
"import",
"Repository",
"params",
"=",
"{",
"'sort'",
":",
"sort",
",",
"'direction'",
":",
"direction",
"}",
"self",
".",
"_remove_none",
"(",
"params",
")",
"url",
"=",
"self",
".",
"starred_urlt",
".",
"expand",
"(",
"owner",
"=",
"None",
",",
"repo",
"=",
"None",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Repository",
",",
"params",
",",
"etag",
")"
] |
Iterate over repositories starred by this user.
.. versionchanged:: 0.5
Added sort and direction parameters (optional) as per the change in
GitHub's API.
:param int number: (optional), number of starred repos to return.
Default: -1, returns all available repos
:param str sort: (optional), either 'created' (when the star was
created) or 'updated' (when the repository was last pushed to)
:param str direction: (optional), either 'asc' or 'desc'. Default:
'desc'
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
|
[
"Iterate",
"over",
"repositories",
"starred",
"by",
"this",
"user",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L357-L379
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.iter_subscriptions
|
def iter_subscriptions(self, number=-1, etag=None):
"""Iterate over repositories subscribed to by this user.
:param int number: (optional), number of subscriptions to return.
Default: -1, returns all available
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
"""
from .repos import Repository
url = self._build_url('subscriptions', base_url=self._api)
return self._iter(int(number), url, Repository, etag=etag)
|
python
|
def iter_subscriptions(self, number=-1, etag=None):
"""Iterate over repositories subscribed to by this user.
:param int number: (optional), number of subscriptions to return.
Default: -1, returns all available
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
"""
from .repos import Repository
url = self._build_url('subscriptions', base_url=self._api)
return self._iter(int(number), url, Repository, etag=etag)
|
[
"def",
"iter_subscriptions",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"from",
".",
"repos",
"import",
"Repository",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'subscriptions'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Repository",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over repositories subscribed to by this user.
:param int number: (optional), number of subscriptions to return.
Default: -1, returns all available
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
|
[
"Iterate",
"over",
"repositories",
"subscribed",
"to",
"by",
"this",
"user",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L381-L392
|
kislyuk/aegea
|
aegea/packages/github3/users.py
|
User.update
|
def update(self, name=None, email=None, blog=None, company=None,
location=None, hireable=False, bio=None):
"""If authenticated as this user, update the information with
the information provided in the parameters.
:param str name: e.g., 'John Smith', not login name
:param str email: e.g., 'john.smith@example.com'
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
:param str company:
:param str location:
:param bool hireable: defaults to False
:param str bio: GitHub flavored markdown
:returns: bool
"""
user = {'name': name, 'email': email, 'blog': blog,
'company': company, 'location': location,
'hireable': hireable, 'bio': bio}
self._remove_none(user)
url = self._build_url('user')
json = self._json(self._patch(url, data=dumps(user)), 200)
if json:
self._update_(json)
return True
return False
|
python
|
def update(self, name=None, email=None, blog=None, company=None,
location=None, hireable=False, bio=None):
"""If authenticated as this user, update the information with
the information provided in the parameters.
:param str name: e.g., 'John Smith', not login name
:param str email: e.g., 'john.smith@example.com'
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
:param str company:
:param str location:
:param bool hireable: defaults to False
:param str bio: GitHub flavored markdown
:returns: bool
"""
user = {'name': name, 'email': email, 'blog': blog,
'company': company, 'location': location,
'hireable': hireable, 'bio': bio}
self._remove_none(user)
url = self._build_url('user')
json = self._json(self._patch(url, data=dumps(user)), 200)
if json:
self._update_(json)
return True
return False
|
[
"def",
"update",
"(",
"self",
",",
"name",
"=",
"None",
",",
"email",
"=",
"None",
",",
"blog",
"=",
"None",
",",
"company",
"=",
"None",
",",
"location",
"=",
"None",
",",
"hireable",
"=",
"False",
",",
"bio",
"=",
"None",
")",
":",
"user",
"=",
"{",
"'name'",
":",
"name",
",",
"'email'",
":",
"email",
",",
"'blog'",
":",
"blog",
",",
"'company'",
":",
"company",
",",
"'location'",
":",
"location",
",",
"'hireable'",
":",
"hireable",
",",
"'bio'",
":",
"bio",
"}",
"self",
".",
"_remove_none",
"(",
"user",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'user'",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_patch",
"(",
"url",
",",
"data",
"=",
"dumps",
"(",
"user",
")",
")",
",",
"200",
")",
"if",
"json",
":",
"self",
".",
"_update_",
"(",
"json",
")",
"return",
"True",
"return",
"False"
] |
If authenticated as this user, update the information with
the information provided in the parameters.
:param str name: e.g., 'John Smith', not login name
:param str email: e.g., 'john.smith@example.com'
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
:param str company:
:param str location:
:param bool hireable: defaults to False
:param str bio: GitHub flavored markdown
:returns: bool
|
[
"If",
"authenticated",
"as",
"this",
"user",
"update",
"the",
"information",
"with",
"the",
"information",
"provided",
"in",
"the",
"parameters",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/users.py#L395-L418
|
kislyuk/aegea
|
aegea/packages/github3/notifications.py
|
Thread.delete_subscription
|
def delete_subscription(self):
"""Delete subscription for this thread.
:returns: bool
"""
url = self._build_url('subscription', base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
|
python
|
def delete_subscription(self):
"""Delete subscription for this thread.
:returns: bool
"""
url = self._build_url('subscription', base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
|
[
"def",
"delete_subscription",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'subscription'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_delete",
"(",
"url",
")",
",",
"204",
",",
"404",
")"
] |
Delete subscription for this thread.
:returns: bool
|
[
"Delete",
"subscription",
"for",
"this",
"thread",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/notifications.py#L63-L69
|
kislyuk/aegea
|
aegea/packages/github3/notifications.py
|
Thread.set_subscription
|
def set_subscription(self, subscribed, ignored):
"""Set the user's subscription for this thread
:param bool subscribed: (required), determines if notifications should
be received from this thread.
:param bool ignored: (required), determines if notifications should be
ignored from this thread.
:returns: :class:`Subscription <Subscription>`
"""
url = self._build_url('subscription', base_url=self._api)
sub = {'subscribed': subscribed, 'ignored': ignored}
json = self._json(self._put(url, data=dumps(sub)), 200)
return Subscription(json, self) if json else None
|
python
|
def set_subscription(self, subscribed, ignored):
"""Set the user's subscription for this thread
:param bool subscribed: (required), determines if notifications should
be received from this thread.
:param bool ignored: (required), determines if notifications should be
ignored from this thread.
:returns: :class:`Subscription <Subscription>`
"""
url = self._build_url('subscription', base_url=self._api)
sub = {'subscribed': subscribed, 'ignored': ignored}
json = self._json(self._put(url, data=dumps(sub)), 200)
return Subscription(json, self) if json else None
|
[
"def",
"set_subscription",
"(",
"self",
",",
"subscribed",
",",
"ignored",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'subscription'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"sub",
"=",
"{",
"'subscribed'",
":",
"subscribed",
",",
"'ignored'",
":",
"ignored",
"}",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_put",
"(",
"url",
",",
"data",
"=",
"dumps",
"(",
"sub",
")",
")",
",",
"200",
")",
"return",
"Subscription",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Set the user's subscription for this thread
:param bool subscribed: (required), determines if notifications should
be received from this thread.
:param bool ignored: (required), determines if notifications should be
ignored from this thread.
:returns: :class:`Subscription <Subscription>`
|
[
"Set",
"the",
"user",
"s",
"subscription",
"for",
"this",
"thread"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/notifications.py#L82-L94
|
kislyuk/aegea
|
aegea/packages/github3/notifications.py
|
Thread.subscription
|
def subscription(self):
"""Checks the status of the user's subscription to this thread.
:returns: :class:`Subscription <Subscription>`
"""
url = self._build_url('subscription', base_url=self._api)
json = self._json(self._get(url), 200)
return Subscription(json, self) if json else None
|
python
|
def subscription(self):
"""Checks the status of the user's subscription to this thread.
:returns: :class:`Subscription <Subscription>`
"""
url = self._build_url('subscription', base_url=self._api)
json = self._json(self._get(url), 200)
return Subscription(json, self) if json else None
|
[
"def",
"subscription",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'subscription'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Subscription",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Checks the status of the user's subscription to this thread.
:returns: :class:`Subscription <Subscription>`
|
[
"Checks",
"the",
"status",
"of",
"the",
"user",
"s",
"subscription",
"to",
"this",
"thread",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/notifications.py#L96-L103
|
kislyuk/aegea
|
aegea/packages/github3/notifications.py
|
Subscription.set
|
def set(self, subscribed, ignored):
"""Set the user's subscription for this subscription
:param bool subscribed: (required), determines if notifications should
be received from this thread.
:param bool ignored: (required), determines if notifications should be
ignored from this thread.
"""
sub = {'subscribed': subscribed, 'ignored': ignored}
json = self._json(self._put(self._api, data=dumps(sub)), 200)
self.__init__(json, self._session)
|
python
|
def set(self, subscribed, ignored):
"""Set the user's subscription for this subscription
:param bool subscribed: (required), determines if notifications should
be received from this thread.
:param bool ignored: (required), determines if notifications should be
ignored from this thread.
"""
sub = {'subscribed': subscribed, 'ignored': ignored}
json = self._json(self._put(self._api, data=dumps(sub)), 200)
self.__init__(json, self._session)
|
[
"def",
"set",
"(",
"self",
",",
"subscribed",
",",
"ignored",
")",
":",
"sub",
"=",
"{",
"'subscribed'",
":",
"subscribed",
",",
"'ignored'",
":",
"ignored",
"}",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_put",
"(",
"self",
".",
"_api",
",",
"data",
"=",
"dumps",
"(",
"sub",
")",
")",
",",
"200",
")",
"self",
".",
"__init__",
"(",
"json",
",",
"self",
".",
"_session",
")"
] |
Set the user's subscription for this subscription
:param bool subscribed: (required), determines if notifications should
be received from this thread.
:param bool ignored: (required), determines if notifications should be
ignored from this thread.
|
[
"Set",
"the",
"user",
"s",
"subscription",
"for",
"this",
"subscription"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/notifications.py#L139-L149
|
kislyuk/aegea
|
aegea/util/aws/__init__.py
|
locate_ami
|
def locate_ami(product, region=None, channel="releases", stream="released", root_store="ssd", virt="hvm"):
"""
Examples::
locate_ami(product="com.ubuntu.cloud:server:16.04:amd64", channel="daily", stream="daily", region="us-west-2")
locate_ami(product="Amazon Linux AMI 2016.09")
"""
if region is None:
region = clients.ec2.meta.region_name
if product.startswith("com.ubuntu.cloud"):
partition = "aws"
if region.startswith("cn-"):
partition = "aws-cn"
elif region.startswith("us-gov-"):
partition = "aws-govcloud"
if partition not in {"aws", "aws-cn", "aws-govcloud"}:
raise AegeaException("Unrecognized partition {}".format(partition))
manifest_url = "https://cloud-images.ubuntu.com/{channel}/streams/v1/com.ubuntu.cloud:{stream}:{partition}.json"
manifest_url = manifest_url.format(partition=partition, channel=channel, stream=stream)
manifest = requests.get(manifest_url).json()
if product not in manifest["products"]:
raise AegeaException("Ubuntu version {} not found in Ubuntu cloud image manifest".format(product))
versions = manifest["products"][product]["versions"]
for version in sorted(versions.keys(), reverse=True)[:8]:
for ami in versions[version]["items"].values():
if ami["crsn"] == region and ami["root_store"] == root_store and ami["virt"] == virt:
logger.info("Found %s for %s", ami["id"], ":".join([product, version, region, root_store, virt]))
return ami["id"]
elif product.startswith("Amazon Linux"):
filters = {"root-device-type": "ebs" if root_store == "ssd" else root_store, "virtualization-type": virt,
"architecture": "x86_64", "owner-alias": "amazon", "state": "available"}
images = resources.ec2.images.filter(Filters=[dict(Name=k, Values=[v]) for k, v in filters.items()])
for image in sorted(images, key=lambda i: i.creation_date, reverse=True):
if root_store == "ebs" and not image.name.endswith("x86_64-gp2"):
continue
if image.name.startswith("amzn-ami-" + virt) and image.description.startswith(product):
return image.image_id
raise AegeaException("No AMI found for {} {} {} {}".format(product, region, root_store, virt))
|
python
|
def locate_ami(product, region=None, channel="releases", stream="released", root_store="ssd", virt="hvm"):
"""
Examples::
locate_ami(product="com.ubuntu.cloud:server:16.04:amd64", channel="daily", stream="daily", region="us-west-2")
locate_ami(product="Amazon Linux AMI 2016.09")
"""
if region is None:
region = clients.ec2.meta.region_name
if product.startswith("com.ubuntu.cloud"):
partition = "aws"
if region.startswith("cn-"):
partition = "aws-cn"
elif region.startswith("us-gov-"):
partition = "aws-govcloud"
if partition not in {"aws", "aws-cn", "aws-govcloud"}:
raise AegeaException("Unrecognized partition {}".format(partition))
manifest_url = "https://cloud-images.ubuntu.com/{channel}/streams/v1/com.ubuntu.cloud:{stream}:{partition}.json"
manifest_url = manifest_url.format(partition=partition, channel=channel, stream=stream)
manifest = requests.get(manifest_url).json()
if product not in manifest["products"]:
raise AegeaException("Ubuntu version {} not found in Ubuntu cloud image manifest".format(product))
versions = manifest["products"][product]["versions"]
for version in sorted(versions.keys(), reverse=True)[:8]:
for ami in versions[version]["items"].values():
if ami["crsn"] == region and ami["root_store"] == root_store and ami["virt"] == virt:
logger.info("Found %s for %s", ami["id"], ":".join([product, version, region, root_store, virt]))
return ami["id"]
elif product.startswith("Amazon Linux"):
filters = {"root-device-type": "ebs" if root_store == "ssd" else root_store, "virtualization-type": virt,
"architecture": "x86_64", "owner-alias": "amazon", "state": "available"}
images = resources.ec2.images.filter(Filters=[dict(Name=k, Values=[v]) for k, v in filters.items()])
for image in sorted(images, key=lambda i: i.creation_date, reverse=True):
if root_store == "ebs" and not image.name.endswith("x86_64-gp2"):
continue
if image.name.startswith("amzn-ami-" + virt) and image.description.startswith(product):
return image.image_id
raise AegeaException("No AMI found for {} {} {} {}".format(product, region, root_store, virt))
|
[
"def",
"locate_ami",
"(",
"product",
",",
"region",
"=",
"None",
",",
"channel",
"=",
"\"releases\"",
",",
"stream",
"=",
"\"released\"",
",",
"root_store",
"=",
"\"ssd\"",
",",
"virt",
"=",
"\"hvm\"",
")",
":",
"if",
"region",
"is",
"None",
":",
"region",
"=",
"clients",
".",
"ec2",
".",
"meta",
".",
"region_name",
"if",
"product",
".",
"startswith",
"(",
"\"com.ubuntu.cloud\"",
")",
":",
"partition",
"=",
"\"aws\"",
"if",
"region",
".",
"startswith",
"(",
"\"cn-\"",
")",
":",
"partition",
"=",
"\"aws-cn\"",
"elif",
"region",
".",
"startswith",
"(",
"\"us-gov-\"",
")",
":",
"partition",
"=",
"\"aws-govcloud\"",
"if",
"partition",
"not",
"in",
"{",
"\"aws\"",
",",
"\"aws-cn\"",
",",
"\"aws-govcloud\"",
"}",
":",
"raise",
"AegeaException",
"(",
"\"Unrecognized partition {}\"",
".",
"format",
"(",
"partition",
")",
")",
"manifest_url",
"=",
"\"https://cloud-images.ubuntu.com/{channel}/streams/v1/com.ubuntu.cloud:{stream}:{partition}.json\"",
"manifest_url",
"=",
"manifest_url",
".",
"format",
"(",
"partition",
"=",
"partition",
",",
"channel",
"=",
"channel",
",",
"stream",
"=",
"stream",
")",
"manifest",
"=",
"requests",
".",
"get",
"(",
"manifest_url",
")",
".",
"json",
"(",
")",
"if",
"product",
"not",
"in",
"manifest",
"[",
"\"products\"",
"]",
":",
"raise",
"AegeaException",
"(",
"\"Ubuntu version {} not found in Ubuntu cloud image manifest\"",
".",
"format",
"(",
"product",
")",
")",
"versions",
"=",
"manifest",
"[",
"\"products\"",
"]",
"[",
"product",
"]",
"[",
"\"versions\"",
"]",
"for",
"version",
"in",
"sorted",
"(",
"versions",
".",
"keys",
"(",
")",
",",
"reverse",
"=",
"True",
")",
"[",
":",
"8",
"]",
":",
"for",
"ami",
"in",
"versions",
"[",
"version",
"]",
"[",
"\"items\"",
"]",
".",
"values",
"(",
")",
":",
"if",
"ami",
"[",
"\"crsn\"",
"]",
"==",
"region",
"and",
"ami",
"[",
"\"root_store\"",
"]",
"==",
"root_store",
"and",
"ami",
"[",
"\"virt\"",
"]",
"==",
"virt",
":",
"logger",
".",
"info",
"(",
"\"Found %s for %s\"",
",",
"ami",
"[",
"\"id\"",
"]",
",",
"\":\"",
".",
"join",
"(",
"[",
"product",
",",
"version",
",",
"region",
",",
"root_store",
",",
"virt",
"]",
")",
")",
"return",
"ami",
"[",
"\"id\"",
"]",
"elif",
"product",
".",
"startswith",
"(",
"\"Amazon Linux\"",
")",
":",
"filters",
"=",
"{",
"\"root-device-type\"",
":",
"\"ebs\"",
"if",
"root_store",
"==",
"\"ssd\"",
"else",
"root_store",
",",
"\"virtualization-type\"",
":",
"virt",
",",
"\"architecture\"",
":",
"\"x86_64\"",
",",
"\"owner-alias\"",
":",
"\"amazon\"",
",",
"\"state\"",
":",
"\"available\"",
"}",
"images",
"=",
"resources",
".",
"ec2",
".",
"images",
".",
"filter",
"(",
"Filters",
"=",
"[",
"dict",
"(",
"Name",
"=",
"k",
",",
"Values",
"=",
"[",
"v",
"]",
")",
"for",
"k",
",",
"v",
"in",
"filters",
".",
"items",
"(",
")",
"]",
")",
"for",
"image",
"in",
"sorted",
"(",
"images",
",",
"key",
"=",
"lambda",
"i",
":",
"i",
".",
"creation_date",
",",
"reverse",
"=",
"True",
")",
":",
"if",
"root_store",
"==",
"\"ebs\"",
"and",
"not",
"image",
".",
"name",
".",
"endswith",
"(",
"\"x86_64-gp2\"",
")",
":",
"continue",
"if",
"image",
".",
"name",
".",
"startswith",
"(",
"\"amzn-ami-\"",
"+",
"virt",
")",
"and",
"image",
".",
"description",
".",
"startswith",
"(",
"product",
")",
":",
"return",
"image",
".",
"image_id",
"raise",
"AegeaException",
"(",
"\"No AMI found for {} {} {} {}\"",
".",
"format",
"(",
"product",
",",
"region",
",",
"root_store",
",",
"virt",
")",
")"
] |
Examples::
locate_ami(product="com.ubuntu.cloud:server:16.04:amd64", channel="daily", stream="daily", region="us-west-2")
locate_ami(product="Amazon Linux AMI 2016.09")
|
[
"Examples",
"::",
"locate_ami",
"(",
"product",
"=",
"com",
".",
"ubuntu",
".",
"cloud",
":",
"server",
":",
"16",
".",
"04",
":",
"amd64",
"channel",
"=",
"daily",
"stream",
"=",
"daily",
"region",
"=",
"us",
"-",
"west",
"-",
"2",
")",
"locate_ami",
"(",
"product",
"=",
"Amazon",
"Linux",
"AMI",
"2016",
".",
"09",
")"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/util/aws/__init__.py#L30-L66
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.add_collaborator
|
def add_collaborator(self, login):
"""Add ``login`` as a collaborator to a repository.
:param str login: (required), login of the user
:returns: bool -- True if successful, False otherwise
"""
resp = False
if login:
url = self._build_url('collaborators', login, base_url=self._api)
resp = self._boolean(self._put(url), 204, 404)
return resp
|
python
|
def add_collaborator(self, login):
"""Add ``login`` as a collaborator to a repository.
:param str login: (required), login of the user
:returns: bool -- True if successful, False otherwise
"""
resp = False
if login:
url = self._build_url('collaborators', login, base_url=self._api)
resp = self._boolean(self._put(url), 204, 404)
return resp
|
[
"def",
"add_collaborator",
"(",
"self",
",",
"login",
")",
":",
"resp",
"=",
"False",
"if",
"login",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'collaborators'",
",",
"login",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"resp",
"=",
"self",
".",
"_boolean",
"(",
"self",
".",
"_put",
"(",
"url",
")",
",",
"204",
",",
"404",
")",
"return",
"resp"
] |
Add ``login`` as a collaborator to a repository.
:param str login: (required), login of the user
:returns: bool -- True if successful, False otherwise
|
[
"Add",
"login",
"as",
"a",
"collaborator",
"to",
"a",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L302-L312
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.archive
|
def archive(self, format, path='', ref='master'):
"""Get the tarball or zipball archive for this repo at ref.
See: http://developer.github.com/v3/repos/contents/#get-archive-link
:param str format: (required), accepted values: ('tarball',
'zipball')
:param path: (optional), path where the file should be saved
to, default is the filename provided in the headers and will be
written in the current directory.
it can take a file-like object as well
:type path: str, file
:param str ref: (optional)
:returns: bool -- True if successful, False otherwise
"""
resp = None
if format in ('tarball', 'zipball'):
url = self._build_url(format, ref, base_url=self._api)
resp = self._get(url, allow_redirects=True, stream=True)
if resp and self._boolean(resp, 200, 404):
stream_response_to_file(resp, path)
return True
return False
|
python
|
def archive(self, format, path='', ref='master'):
"""Get the tarball or zipball archive for this repo at ref.
See: http://developer.github.com/v3/repos/contents/#get-archive-link
:param str format: (required), accepted values: ('tarball',
'zipball')
:param path: (optional), path where the file should be saved
to, default is the filename provided in the headers and will be
written in the current directory.
it can take a file-like object as well
:type path: str, file
:param str ref: (optional)
:returns: bool -- True if successful, False otherwise
"""
resp = None
if format in ('tarball', 'zipball'):
url = self._build_url(format, ref, base_url=self._api)
resp = self._get(url, allow_redirects=True, stream=True)
if resp and self._boolean(resp, 200, 404):
stream_response_to_file(resp, path)
return True
return False
|
[
"def",
"archive",
"(",
"self",
",",
"format",
",",
"path",
"=",
"''",
",",
"ref",
"=",
"'master'",
")",
":",
"resp",
"=",
"None",
"if",
"format",
"in",
"(",
"'tarball'",
",",
"'zipball'",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"format",
",",
"ref",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"resp",
"=",
"self",
".",
"_get",
"(",
"url",
",",
"allow_redirects",
"=",
"True",
",",
"stream",
"=",
"True",
")",
"if",
"resp",
"and",
"self",
".",
"_boolean",
"(",
"resp",
",",
"200",
",",
"404",
")",
":",
"stream_response_to_file",
"(",
"resp",
",",
"path",
")",
"return",
"True",
"return",
"False"
] |
Get the tarball or zipball archive for this repo at ref.
See: http://developer.github.com/v3/repos/contents/#get-archive-link
:param str format: (required), accepted values: ('tarball',
'zipball')
:param path: (optional), path where the file should be saved
to, default is the filename provided in the headers and will be
written in the current directory.
it can take a file-like object as well
:type path: str, file
:param str ref: (optional)
:returns: bool -- True if successful, False otherwise
|
[
"Get",
"the",
"tarball",
"or",
"zipball",
"archive",
"for",
"this",
"repo",
"at",
"ref",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L314-L338
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.asset
|
def asset(self, id):
"""Returns a single Asset.
:param int id: (required), id of the asset
:returns: :class:`Asset <github3.repos.release.Asset>`
"""
data = None
if int(id) > 0:
url = self._build_url('releases', 'assets', str(id),
base_url=self._api)
data = self._json(self._get(url, headers=Release.CUSTOM_HEADERS),
200)
return Asset(data, self) if data else None
|
python
|
def asset(self, id):
"""Returns a single Asset.
:param int id: (required), id of the asset
:returns: :class:`Asset <github3.repos.release.Asset>`
"""
data = None
if int(id) > 0:
url = self._build_url('releases', 'assets', str(id),
base_url=self._api)
data = self._json(self._get(url, headers=Release.CUSTOM_HEADERS),
200)
return Asset(data, self) if data else None
|
[
"def",
"asset",
"(",
"self",
",",
"id",
")",
":",
"data",
"=",
"None",
"if",
"int",
"(",
"id",
")",
">",
"0",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'releases'",
",",
"'assets'",
",",
"str",
"(",
"id",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
",",
"headers",
"=",
"Release",
".",
"CUSTOM_HEADERS",
")",
",",
"200",
")",
"return",
"Asset",
"(",
"data",
",",
"self",
")",
"if",
"data",
"else",
"None"
] |
Returns a single Asset.
:param int id: (required), id of the asset
:returns: :class:`Asset <github3.repos.release.Asset>`
|
[
"Returns",
"a",
"single",
"Asset",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L340-L352
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.blob
|
def blob(self, sha):
"""Get the blob indicated by ``sha``.
:param str sha: (required), sha of the blob
:returns: :class:`Blob <github3.git.Blob>` if successful, otherwise
None
"""
url = self._build_url('git', 'blobs', sha, base_url=self._api)
json = self._json(self._get(url), 200)
return Blob(json) if json else None
|
python
|
def blob(self, sha):
"""Get the blob indicated by ``sha``.
:param str sha: (required), sha of the blob
:returns: :class:`Blob <github3.git.Blob>` if successful, otherwise
None
"""
url = self._build_url('git', 'blobs', sha, base_url=self._api)
json = self._json(self._get(url), 200)
return Blob(json) if json else None
|
[
"def",
"blob",
"(",
"self",
",",
"sha",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'blobs'",
",",
"sha",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Blob",
"(",
"json",
")",
"if",
"json",
"else",
"None"
] |
Get the blob indicated by ``sha``.
:param str sha: (required), sha of the blob
:returns: :class:`Blob <github3.git.Blob>` if successful, otherwise
None
|
[
"Get",
"the",
"blob",
"indicated",
"by",
"sha",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L354-L363
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.branch
|
def branch(self, name):
"""Get the branch ``name`` of this repository.
:param str name: (required), branch name
:type name: str
:returns: :class:`Branch <github3.repos.branch.Branch>`
"""
json = None
if name:
url = self._build_url('branches', name, base_url=self._api)
json = self._json(self._get(url), 200)
return Branch(json, self) if json else None
|
python
|
def branch(self, name):
"""Get the branch ``name`` of this repository.
:param str name: (required), branch name
:type name: str
:returns: :class:`Branch <github3.repos.branch.Branch>`
"""
json = None
if name:
url = self._build_url('branches', name, base_url=self._api)
json = self._json(self._get(url), 200)
return Branch(json, self) if json else None
|
[
"def",
"branch",
"(",
"self",
",",
"name",
")",
":",
"json",
"=",
"None",
"if",
"name",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'branches'",
",",
"name",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Branch",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the branch ``name`` of this repository.
:param str name: (required), branch name
:type name: str
:returns: :class:`Branch <github3.repos.branch.Branch>`
|
[
"Get",
"the",
"branch",
"name",
"of",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L365-L376
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.commit
|
def commit(self, sha):
"""Get a single (repo) commit. See :func:`git_commit` for the Git Data
Commit.
:param str sha: (required), sha of the commit
:returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` if
successful, otherwise None
"""
url = self._build_url('commits', sha, base_url=self._api)
json = self._json(self._get(url), 200)
return RepoCommit(json, self) if json else None
|
python
|
def commit(self, sha):
"""Get a single (repo) commit. See :func:`git_commit` for the Git Data
Commit.
:param str sha: (required), sha of the commit
:returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` if
successful, otherwise None
"""
url = self._build_url('commits', sha, base_url=self._api)
json = self._json(self._get(url), 200)
return RepoCommit(json, self) if json else None
|
[
"def",
"commit",
"(",
"self",
",",
"sha",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'commits'",
",",
"sha",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"RepoCommit",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get a single (repo) commit. See :func:`git_commit` for the Git Data
Commit.
:param str sha: (required), sha of the commit
:returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` if
successful, otherwise None
|
[
"Get",
"a",
"single",
"(",
"repo",
")",
"commit",
".",
"See",
":",
"func",
":",
"git_commit",
"for",
"the",
"Git",
"Data",
"Commit",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L378-L388
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.commit_comment
|
def commit_comment(self, comment_id):
"""Get a single commit comment.
:param int comment_id: (required), id of the comment used by GitHub
:returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if
successful, otherwise None
"""
url = self._build_url('comments', str(comment_id), base_url=self._api)
json = self._json(self._get(url), 200)
return RepoComment(json, self) if json else None
|
python
|
def commit_comment(self, comment_id):
"""Get a single commit comment.
:param int comment_id: (required), id of the comment used by GitHub
:returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if
successful, otherwise None
"""
url = self._build_url('comments', str(comment_id), base_url=self._api)
json = self._json(self._get(url), 200)
return RepoComment(json, self) if json else None
|
[
"def",
"commit_comment",
"(",
"self",
",",
"comment_id",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'comments'",
",",
"str",
"(",
"comment_id",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"RepoComment",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get a single commit comment.
:param int comment_id: (required), id of the comment used by GitHub
:returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if
successful, otherwise None
|
[
"Get",
"a",
"single",
"commit",
"comment",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L390-L399
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.compare_commits
|
def compare_commits(self, base, head):
"""Compare two commits.
:param str base: (required), base for the comparison
:param str head: (required), compare this against base
:returns: :class:`Comparison <github3.repos.comparison.Comparison>` if
successful, else None
"""
url = self._build_url('compare', base + '...' + head,
base_url=self._api)
json = self._json(self._get(url), 200)
return Comparison(json) if json else None
|
python
|
def compare_commits(self, base, head):
"""Compare two commits.
:param str base: (required), base for the comparison
:param str head: (required), compare this against base
:returns: :class:`Comparison <github3.repos.comparison.Comparison>` if
successful, else None
"""
url = self._build_url('compare', base + '...' + head,
base_url=self._api)
json = self._json(self._get(url), 200)
return Comparison(json) if json else None
|
[
"def",
"compare_commits",
"(",
"self",
",",
"base",
",",
"head",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'compare'",
",",
"base",
"+",
"'...'",
"+",
"head",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Comparison",
"(",
"json",
")",
"if",
"json",
"else",
"None"
] |
Compare two commits.
:param str base: (required), base for the comparison
:param str head: (required), compare this against base
:returns: :class:`Comparison <github3.repos.comparison.Comparison>` if
successful, else None
|
[
"Compare",
"two",
"commits",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L401-L412
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.contents
|
def contents(self, path, ref=None):
"""Get the contents of the file pointed to by ``path``.
If the path provided is actually a directory, you will receive a
dictionary back of the form::
{
'filename.md': Contents(), # Where Contents an instance
'github.py': Contents(),
}
:param str path: (required), path to file, e.g.
github3/repo.py
:param str ref: (optional), the string name of a commit/branch/tag.
Default: master
:returns: :class:`Contents <github3.repos.contents.Contents>` or dict
if successful, else None
"""
url = self._build_url('contents', path, base_url=self._api)
json = self._json(self._get(url, params={'ref': ref}), 200)
if isinstance(json, dict):
return Contents(json, self)
elif isinstance(json, list):
return dict((j.get('name'), Contents(j, self)) for j in json)
return None
|
python
|
def contents(self, path, ref=None):
"""Get the contents of the file pointed to by ``path``.
If the path provided is actually a directory, you will receive a
dictionary back of the form::
{
'filename.md': Contents(), # Where Contents an instance
'github.py': Contents(),
}
:param str path: (required), path to file, e.g.
github3/repo.py
:param str ref: (optional), the string name of a commit/branch/tag.
Default: master
:returns: :class:`Contents <github3.repos.contents.Contents>` or dict
if successful, else None
"""
url = self._build_url('contents', path, base_url=self._api)
json = self._json(self._get(url, params={'ref': ref}), 200)
if isinstance(json, dict):
return Contents(json, self)
elif isinstance(json, list):
return dict((j.get('name'), Contents(j, self)) for j in json)
return None
|
[
"def",
"contents",
"(",
"self",
",",
"path",
",",
"ref",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'contents'",
",",
"path",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
",",
"params",
"=",
"{",
"'ref'",
":",
"ref",
"}",
")",
",",
"200",
")",
"if",
"isinstance",
"(",
"json",
",",
"dict",
")",
":",
"return",
"Contents",
"(",
"json",
",",
"self",
")",
"elif",
"isinstance",
"(",
"json",
",",
"list",
")",
":",
"return",
"dict",
"(",
"(",
"j",
".",
"get",
"(",
"'name'",
")",
",",
"Contents",
"(",
"j",
",",
"self",
")",
")",
"for",
"j",
"in",
"json",
")",
"return",
"None"
] |
Get the contents of the file pointed to by ``path``.
If the path provided is actually a directory, you will receive a
dictionary back of the form::
{
'filename.md': Contents(), # Where Contents an instance
'github.py': Contents(),
}
:param str path: (required), path to file, e.g.
github3/repo.py
:param str ref: (optional), the string name of a commit/branch/tag.
Default: master
:returns: :class:`Contents <github3.repos.contents.Contents>` or dict
if successful, else None
|
[
"Get",
"the",
"contents",
"of",
"the",
"file",
"pointed",
"to",
"by",
"path",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L414-L438
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_blob
|
def create_blob(self, content, encoding):
"""Create a blob with ``content``.
:param str content: (required), content of the blob
:param str encoding: (required), ('base64', 'utf-8')
:returns: string of the SHA returned
"""
sha = ''
if encoding in ('base64', 'utf-8'):
url = self._build_url('git', 'blobs', base_url=self._api)
data = {'content': content, 'encoding': encoding}
json = self._json(self._post(url, data=data), 201)
if json:
sha = json.get('sha')
return sha
|
python
|
def create_blob(self, content, encoding):
"""Create a blob with ``content``.
:param str content: (required), content of the blob
:param str encoding: (required), ('base64', 'utf-8')
:returns: string of the SHA returned
"""
sha = ''
if encoding in ('base64', 'utf-8'):
url = self._build_url('git', 'blobs', base_url=self._api)
data = {'content': content, 'encoding': encoding}
json = self._json(self._post(url, data=data), 201)
if json:
sha = json.get('sha')
return sha
|
[
"def",
"create_blob",
"(",
"self",
",",
"content",
",",
"encoding",
")",
":",
"sha",
"=",
"''",
"if",
"encoding",
"in",
"(",
"'base64'",
",",
"'utf-8'",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'blobs'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"{",
"'content'",
":",
"content",
",",
"'encoding'",
":",
"encoding",
"}",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"if",
"json",
":",
"sha",
"=",
"json",
".",
"get",
"(",
"'sha'",
")",
"return",
"sha"
] |
Create a blob with ``content``.
:param str content: (required), content of the blob
:param str encoding: (required), ('base64', 'utf-8')
:returns: string of the SHA returned
|
[
"Create",
"a",
"blob",
"with",
"content",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L441-L455
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_comment
|
def create_comment(self, body, sha, path=None, position=None, line=1):
"""Create a comment on a commit.
:param str body: (required), body of the message
:param str sha: (required), commit id
:param str path: (optional), relative path of the file to comment
on
:param str position: (optional), line index in the diff to comment on
:param int line: (optional), line number of the file to comment on,
default: 1
:returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if
successful, otherwise None
"""
json = None
if body and sha and (line and int(line) > 0):
data = {'body': body, 'line': line, 'path': path,
'position': position}
self._remove_none(data)
url = self._build_url('commits', sha, 'comments',
base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return RepoComment(json, self) if json else None
|
python
|
def create_comment(self, body, sha, path=None, position=None, line=1):
"""Create a comment on a commit.
:param str body: (required), body of the message
:param str sha: (required), commit id
:param str path: (optional), relative path of the file to comment
on
:param str position: (optional), line index in the diff to comment on
:param int line: (optional), line number of the file to comment on,
default: 1
:returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if
successful, otherwise None
"""
json = None
if body and sha and (line and int(line) > 0):
data = {'body': body, 'line': line, 'path': path,
'position': position}
self._remove_none(data)
url = self._build_url('commits', sha, 'comments',
base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return RepoComment(json, self) if json else None
|
[
"def",
"create_comment",
"(",
"self",
",",
"body",
",",
"sha",
",",
"path",
"=",
"None",
",",
"position",
"=",
"None",
",",
"line",
"=",
"1",
")",
":",
"json",
"=",
"None",
"if",
"body",
"and",
"sha",
"and",
"(",
"line",
"and",
"int",
"(",
"line",
")",
">",
"0",
")",
":",
"data",
"=",
"{",
"'body'",
":",
"body",
",",
"'line'",
":",
"line",
",",
"'path'",
":",
"path",
",",
"'position'",
":",
"position",
"}",
"self",
".",
"_remove_none",
"(",
"data",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'commits'",
",",
"sha",
",",
"'comments'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"RepoComment",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a comment on a commit.
:param str body: (required), body of the message
:param str sha: (required), commit id
:param str path: (optional), relative path of the file to comment
on
:param str position: (optional), line index in the diff to comment on
:param int line: (optional), line number of the file to comment on,
default: 1
:returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if
successful, otherwise None
|
[
"Create",
"a",
"comment",
"on",
"a",
"commit",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L458-L480
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_commit
|
def create_commit(self, message, tree, parents, author={}, committer={}):
"""Create a commit on this repository.
:param str message: (required), commit message
:param str tree: (required), SHA of the tree object this
commit points to
:param list parents: (required), SHAs of the commits that were parents
of this commit. If empty, the commit will be written as the root
commit. Even if there is only one parent, this should be an
array.
:param dict author: (optional), if omitted, GitHub will
use the authenticated user's credentials and the current
time. Format: {'name': 'Committer Name', 'email':
'name@example.com', 'date': 'YYYY-MM-DDTHH:MM:SS+HH:00'}
:param dict committer: (optional), if ommitted, GitHub will use the
author parameters. Should be the same format as the author
parameter.
:returns: :class:`Commit <github3.git.Commit>` if successful, else
None
"""
json = None
if message and tree and isinstance(parents, list):
url = self._build_url('git', 'commits', base_url=self._api)
data = {'message': message, 'tree': tree, 'parents': parents,
'author': author, 'committer': committer}
json = self._json(self._post(url, data=data), 201)
return Commit(json, self) if json else None
|
python
|
def create_commit(self, message, tree, parents, author={}, committer={}):
"""Create a commit on this repository.
:param str message: (required), commit message
:param str tree: (required), SHA of the tree object this
commit points to
:param list parents: (required), SHAs of the commits that were parents
of this commit. If empty, the commit will be written as the root
commit. Even if there is only one parent, this should be an
array.
:param dict author: (optional), if omitted, GitHub will
use the authenticated user's credentials and the current
time. Format: {'name': 'Committer Name', 'email':
'name@example.com', 'date': 'YYYY-MM-DDTHH:MM:SS+HH:00'}
:param dict committer: (optional), if ommitted, GitHub will use the
author parameters. Should be the same format as the author
parameter.
:returns: :class:`Commit <github3.git.Commit>` if successful, else
None
"""
json = None
if message and tree and isinstance(parents, list):
url = self._build_url('git', 'commits', base_url=self._api)
data = {'message': message, 'tree': tree, 'parents': parents,
'author': author, 'committer': committer}
json = self._json(self._post(url, data=data), 201)
return Commit(json, self) if json else None
|
[
"def",
"create_commit",
"(",
"self",
",",
"message",
",",
"tree",
",",
"parents",
",",
"author",
"=",
"{",
"}",
",",
"committer",
"=",
"{",
"}",
")",
":",
"json",
"=",
"None",
"if",
"message",
"and",
"tree",
"and",
"isinstance",
"(",
"parents",
",",
"list",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'commits'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"{",
"'message'",
":",
"message",
",",
"'tree'",
":",
"tree",
",",
"'parents'",
":",
"parents",
",",
"'author'",
":",
"author",
",",
"'committer'",
":",
"committer",
"}",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Commit",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a commit on this repository.
:param str message: (required), commit message
:param str tree: (required), SHA of the tree object this
commit points to
:param list parents: (required), SHAs of the commits that were parents
of this commit. If empty, the commit will be written as the root
commit. Even if there is only one parent, this should be an
array.
:param dict author: (optional), if omitted, GitHub will
use the authenticated user's credentials and the current
time. Format: {'name': 'Committer Name', 'email':
'name@example.com', 'date': 'YYYY-MM-DDTHH:MM:SS+HH:00'}
:param dict committer: (optional), if ommitted, GitHub will use the
author parameters. Should be the same format as the author
parameter.
:returns: :class:`Commit <github3.git.Commit>` if successful, else
None
|
[
"Create",
"a",
"commit",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L483-L509
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_deployment
|
def create_deployment(self, ref, force=False, payload='',
auto_merge=False, description='', environment=None):
"""Create a deployment.
:param str ref: (required), The ref to deploy. This can be a branch,
tag, or sha.
:param bool force: Optional parameter to bypass any ahead/behind
checks or commit status checks. Default: False
:param str payload: Optional JSON payload with extra information about
the deployment. Default: ""
:param bool auto_merge: Optional parameter to merge the default branch
into the requested deployment branch if necessary. Default: False
:param str description: Optional short description. Default: ""
:param str environment: Optional name for the target deployment
environment (e.g., production, staging, qa). Default: "production"
:returns: :class:`Deployment <github3.repos.deployment.Deployment>`
"""
json = None
if ref:
url = self._build_url('deployments', base_url=self._api)
data = {'ref': ref, 'force': force, 'payload': payload,
'auto_merge': auto_merge, 'description': description,
'environment': environment}
self._remove_none(data)
headers = Deployment.CUSTOM_HEADERS
json = self._json(self._post(url, data=data, headers=headers),
201)
return Deployment(json, self) if json else None
|
python
|
def create_deployment(self, ref, force=False, payload='',
auto_merge=False, description='', environment=None):
"""Create a deployment.
:param str ref: (required), The ref to deploy. This can be a branch,
tag, or sha.
:param bool force: Optional parameter to bypass any ahead/behind
checks or commit status checks. Default: False
:param str payload: Optional JSON payload with extra information about
the deployment. Default: ""
:param bool auto_merge: Optional parameter to merge the default branch
into the requested deployment branch if necessary. Default: False
:param str description: Optional short description. Default: ""
:param str environment: Optional name for the target deployment
environment (e.g., production, staging, qa). Default: "production"
:returns: :class:`Deployment <github3.repos.deployment.Deployment>`
"""
json = None
if ref:
url = self._build_url('deployments', base_url=self._api)
data = {'ref': ref, 'force': force, 'payload': payload,
'auto_merge': auto_merge, 'description': description,
'environment': environment}
self._remove_none(data)
headers = Deployment.CUSTOM_HEADERS
json = self._json(self._post(url, data=data, headers=headers),
201)
return Deployment(json, self) if json else None
|
[
"def",
"create_deployment",
"(",
"self",
",",
"ref",
",",
"force",
"=",
"False",
",",
"payload",
"=",
"''",
",",
"auto_merge",
"=",
"False",
",",
"description",
"=",
"''",
",",
"environment",
"=",
"None",
")",
":",
"json",
"=",
"None",
"if",
"ref",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'deployments'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"{",
"'ref'",
":",
"ref",
",",
"'force'",
":",
"force",
",",
"'payload'",
":",
"payload",
",",
"'auto_merge'",
":",
"auto_merge",
",",
"'description'",
":",
"description",
",",
"'environment'",
":",
"environment",
"}",
"self",
".",
"_remove_none",
"(",
"data",
")",
"headers",
"=",
"Deployment",
".",
"CUSTOM_HEADERS",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
",",
"headers",
"=",
"headers",
")",
",",
"201",
")",
"return",
"Deployment",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a deployment.
:param str ref: (required), The ref to deploy. This can be a branch,
tag, or sha.
:param bool force: Optional parameter to bypass any ahead/behind
checks or commit status checks. Default: False
:param str payload: Optional JSON payload with extra information about
the deployment. Default: ""
:param bool auto_merge: Optional parameter to merge the default branch
into the requested deployment branch if necessary. Default: False
:param str description: Optional short description. Default: ""
:param str environment: Optional name for the target deployment
environment (e.g., production, staging, qa). Default: "production"
:returns: :class:`Deployment <github3.repos.deployment.Deployment>`
|
[
"Create",
"a",
"deployment",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L512-L539
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_file
|
def create_file(self, path, message, content, branch=None,
committer=None, author=None):
"""Create a file in this repository.
See also: http://developer.github.com/v3/repos/contents/#create-a-file
:param str path: (required), path of the file in the repository
:param str message: (required), commit message
:param bytes content: (required), the actual data in the file
:param str branch: (optional), branch to create the commit on.
Defaults to the default branch of the repository
:param dict committer: (optional), if no information is given the
authenticated user's information will be used. You must specify
both a name and email.
:param dict author: (optional), if omitted this will be filled in with
committer information. If passed, you must specify both a name and
email.
:returns: {
'content': :class:`Contents <github3.repos.contents.Contents>`:,
'commit': :class:`Commit <github3.git.Commit>`}
"""
if content and not isinstance(content, bytes):
raise ValueError( # (No coverage)
'content must be a bytes object') # (No coverage)
json = None
if path and message and content:
url = self._build_url('contents', path, base_url=self._api)
content = b64encode(content).decode('utf-8')
data = {'message': message, 'content': content, 'branch': branch,
'committer': validate_commmitter(committer),
'author': validate_commmitter(author)}
self._remove_none(data)
json = self._json(self._put(url, data=dumps(data)), 201)
if 'content' in json and 'commit' in json:
json['content'] = Contents(json['content'], self)
json['commit'] = Commit(json['commit'], self)
return json
|
python
|
def create_file(self, path, message, content, branch=None,
committer=None, author=None):
"""Create a file in this repository.
See also: http://developer.github.com/v3/repos/contents/#create-a-file
:param str path: (required), path of the file in the repository
:param str message: (required), commit message
:param bytes content: (required), the actual data in the file
:param str branch: (optional), branch to create the commit on.
Defaults to the default branch of the repository
:param dict committer: (optional), if no information is given the
authenticated user's information will be used. You must specify
both a name and email.
:param dict author: (optional), if omitted this will be filled in with
committer information. If passed, you must specify both a name and
email.
:returns: {
'content': :class:`Contents <github3.repos.contents.Contents>`:,
'commit': :class:`Commit <github3.git.Commit>`}
"""
if content and not isinstance(content, bytes):
raise ValueError( # (No coverage)
'content must be a bytes object') # (No coverage)
json = None
if path and message and content:
url = self._build_url('contents', path, base_url=self._api)
content = b64encode(content).decode('utf-8')
data = {'message': message, 'content': content, 'branch': branch,
'committer': validate_commmitter(committer),
'author': validate_commmitter(author)}
self._remove_none(data)
json = self._json(self._put(url, data=dumps(data)), 201)
if 'content' in json and 'commit' in json:
json['content'] = Contents(json['content'], self)
json['commit'] = Commit(json['commit'], self)
return json
|
[
"def",
"create_file",
"(",
"self",
",",
"path",
",",
"message",
",",
"content",
",",
"branch",
"=",
"None",
",",
"committer",
"=",
"None",
",",
"author",
"=",
"None",
")",
":",
"if",
"content",
"and",
"not",
"isinstance",
"(",
"content",
",",
"bytes",
")",
":",
"raise",
"ValueError",
"(",
"# (No coverage)",
"'content must be a bytes object'",
")",
"# (No coverage)",
"json",
"=",
"None",
"if",
"path",
"and",
"message",
"and",
"content",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'contents'",
",",
"path",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"content",
"=",
"b64encode",
"(",
"content",
")",
".",
"decode",
"(",
"'utf-8'",
")",
"data",
"=",
"{",
"'message'",
":",
"message",
",",
"'content'",
":",
"content",
",",
"'branch'",
":",
"branch",
",",
"'committer'",
":",
"validate_commmitter",
"(",
"committer",
")",
",",
"'author'",
":",
"validate_commmitter",
"(",
"author",
")",
"}",
"self",
".",
"_remove_none",
"(",
"data",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_put",
"(",
"url",
",",
"data",
"=",
"dumps",
"(",
"data",
")",
")",
",",
"201",
")",
"if",
"'content'",
"in",
"json",
"and",
"'commit'",
"in",
"json",
":",
"json",
"[",
"'content'",
"]",
"=",
"Contents",
"(",
"json",
"[",
"'content'",
"]",
",",
"self",
")",
"json",
"[",
"'commit'",
"]",
"=",
"Commit",
"(",
"json",
"[",
"'commit'",
"]",
",",
"self",
")",
"return",
"json"
] |
Create a file in this repository.
See also: http://developer.github.com/v3/repos/contents/#create-a-file
:param str path: (required), path of the file in the repository
:param str message: (required), commit message
:param bytes content: (required), the actual data in the file
:param str branch: (optional), branch to create the commit on.
Defaults to the default branch of the repository
:param dict committer: (optional), if no information is given the
authenticated user's information will be used. You must specify
both a name and email.
:param dict author: (optional), if omitted this will be filled in with
committer information. If passed, you must specify both a name and
email.
:returns: {
'content': :class:`Contents <github3.repos.contents.Contents>`:,
'commit': :class:`Commit <github3.git.Commit>`}
|
[
"Create",
"a",
"file",
"in",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L542-L580
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_fork
|
def create_fork(self, organization=None):
"""Create a fork of this repository.
:param str organization: (required), login for organization to create
the fork under
:returns: :class:`Repository <Repository>` if successful, else None
"""
url = self._build_url('forks', base_url=self._api)
if organization:
resp = self._post(url, data={'organization': organization})
else:
resp = self._post(url)
json = self._json(resp, 202)
return Repository(json, self) if json else None
|
python
|
def create_fork(self, organization=None):
"""Create a fork of this repository.
:param str organization: (required), login for organization to create
the fork under
:returns: :class:`Repository <Repository>` if successful, else None
"""
url = self._build_url('forks', base_url=self._api)
if organization:
resp = self._post(url, data={'organization': organization})
else:
resp = self._post(url)
json = self._json(resp, 202)
return Repository(json, self) if json else None
|
[
"def",
"create_fork",
"(",
"self",
",",
"organization",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'forks'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"if",
"organization",
":",
"resp",
"=",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"{",
"'organization'",
":",
"organization",
"}",
")",
"else",
":",
"resp",
"=",
"self",
".",
"_post",
"(",
"url",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"resp",
",",
"202",
")",
"return",
"Repository",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a fork of this repository.
:param str organization: (required), login for organization to create
the fork under
:returns: :class:`Repository <Repository>` if successful, else None
|
[
"Create",
"a",
"fork",
"of",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L583-L597
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_hook
|
def create_hook(self, name, config, events=['push'], active=True):
"""Create a hook on this repository.
:param str name: (required), name of the hook
:param dict config: (required), key-value pairs which act as settings
for this hook
:param list events: (optional), events the hook is triggered for
:param bool active: (optional), whether the hook is actually
triggered
:returns: :class:`Hook <github3.repos.hook.Hook>` if successful,
otherwise None
"""
json = None
if name and config and isinstance(config, dict):
url = self._build_url('hooks', base_url=self._api)
data = {'name': name, 'config': config, 'events': events,
'active': active}
json = self._json(self._post(url, data=data), 201)
return Hook(json, self) if json else None
|
python
|
def create_hook(self, name, config, events=['push'], active=True):
"""Create a hook on this repository.
:param str name: (required), name of the hook
:param dict config: (required), key-value pairs which act as settings
for this hook
:param list events: (optional), events the hook is triggered for
:param bool active: (optional), whether the hook is actually
triggered
:returns: :class:`Hook <github3.repos.hook.Hook>` if successful,
otherwise None
"""
json = None
if name and config and isinstance(config, dict):
url = self._build_url('hooks', base_url=self._api)
data = {'name': name, 'config': config, 'events': events,
'active': active}
json = self._json(self._post(url, data=data), 201)
return Hook(json, self) if json else None
|
[
"def",
"create_hook",
"(",
"self",
",",
"name",
",",
"config",
",",
"events",
"=",
"[",
"'push'",
"]",
",",
"active",
"=",
"True",
")",
":",
"json",
"=",
"None",
"if",
"name",
"and",
"config",
"and",
"isinstance",
"(",
"config",
",",
"dict",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'hooks'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"{",
"'name'",
":",
"name",
",",
"'config'",
":",
"config",
",",
"'events'",
":",
"events",
",",
"'active'",
":",
"active",
"}",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Hook",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a hook on this repository.
:param str name: (required), name of the hook
:param dict config: (required), key-value pairs which act as settings
for this hook
:param list events: (optional), events the hook is triggered for
:param bool active: (optional), whether the hook is actually
triggered
:returns: :class:`Hook <github3.repos.hook.Hook>` if successful,
otherwise None
|
[
"Create",
"a",
"hook",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L600-L618
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_issue
|
def create_issue(self,
title,
body=None,
assignee=None,
milestone=None,
labels=None):
"""Creates an issue on this repository.
:param str title: (required), title of the issue
:param str body: (optional), body of the issue
:param str assignee: (optional), login of the user to assign the
issue to
:param int milestone: (optional), id number of the milestone to
attribute this issue to (e.g. ``m`` is a :class:`Milestone
<github3.issues.milestone.Milestone>` object, ``m.number`` is
what you pass here.)
:param labels: (optional), labels to apply to this
issue
:type labels: list of strings
:returns: :class:`Issue <github3.issues.issue.Issue>` if successful,
otherwise None
"""
issue = {'title': title, 'body': body, 'assignee': assignee,
'milestone': milestone, 'labels': labels}
self._remove_none(issue)
json = None
if issue:
url = self._build_url('issues', base_url=self._api)
json = self._json(self._post(url, data=issue), 201)
return Issue(json, self) if json else None
|
python
|
def create_issue(self,
title,
body=None,
assignee=None,
milestone=None,
labels=None):
"""Creates an issue on this repository.
:param str title: (required), title of the issue
:param str body: (optional), body of the issue
:param str assignee: (optional), login of the user to assign the
issue to
:param int milestone: (optional), id number of the milestone to
attribute this issue to (e.g. ``m`` is a :class:`Milestone
<github3.issues.milestone.Milestone>` object, ``m.number`` is
what you pass here.)
:param labels: (optional), labels to apply to this
issue
:type labels: list of strings
:returns: :class:`Issue <github3.issues.issue.Issue>` if successful,
otherwise None
"""
issue = {'title': title, 'body': body, 'assignee': assignee,
'milestone': milestone, 'labels': labels}
self._remove_none(issue)
json = None
if issue:
url = self._build_url('issues', base_url=self._api)
json = self._json(self._post(url, data=issue), 201)
return Issue(json, self) if json else None
|
[
"def",
"create_issue",
"(",
"self",
",",
"title",
",",
"body",
"=",
"None",
",",
"assignee",
"=",
"None",
",",
"milestone",
"=",
"None",
",",
"labels",
"=",
"None",
")",
":",
"issue",
"=",
"{",
"'title'",
":",
"title",
",",
"'body'",
":",
"body",
",",
"'assignee'",
":",
"assignee",
",",
"'milestone'",
":",
"milestone",
",",
"'labels'",
":",
"labels",
"}",
"self",
".",
"_remove_none",
"(",
"issue",
")",
"json",
"=",
"None",
"if",
"issue",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'issues'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"issue",
")",
",",
"201",
")",
"return",
"Issue",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Creates an issue on this repository.
:param str title: (required), title of the issue
:param str body: (optional), body of the issue
:param str assignee: (optional), login of the user to assign the
issue to
:param int milestone: (optional), id number of the milestone to
attribute this issue to (e.g. ``m`` is a :class:`Milestone
<github3.issues.milestone.Milestone>` object, ``m.number`` is
what you pass here.)
:param labels: (optional), labels to apply to this
issue
:type labels: list of strings
:returns: :class:`Issue <github3.issues.issue.Issue>` if successful,
otherwise None
|
[
"Creates",
"an",
"issue",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L621-L652
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_key
|
def create_key(self, title, key):
"""Create a deploy key.
:param str title: (required), title of key
:param str key: (required), key text
:returns: :class:`Key <github3.users.Key>` if successful, else None
"""
json = None
if title and key:
data = {'title': title, 'key': key}
url = self._build_url('keys', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Key(json, self) if json else None
|
python
|
def create_key(self, title, key):
"""Create a deploy key.
:param str title: (required), title of key
:param str key: (required), key text
:returns: :class:`Key <github3.users.Key>` if successful, else None
"""
json = None
if title and key:
data = {'title': title, 'key': key}
url = self._build_url('keys', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Key(json, self) if json else None
|
[
"def",
"create_key",
"(",
"self",
",",
"title",
",",
"key",
")",
":",
"json",
"=",
"None",
"if",
"title",
"and",
"key",
":",
"data",
"=",
"{",
"'title'",
":",
"title",
",",
"'key'",
":",
"key",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'keys'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Key",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a deploy key.
:param str title: (required), title of key
:param str key: (required), key text
:returns: :class:`Key <github3.users.Key>` if successful, else None
|
[
"Create",
"a",
"deploy",
"key",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L655-L667
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_label
|
def create_label(self, name, color):
"""Create a label for this repository.
:param str name: (required), name to give to the label
:param str color: (required), value of the color to assign to the
label, e.g., '#fafafa' or 'fafafa' (the latter is what is sent)
:returns: :class:`Label <github3.issues.label.Label>` if successful,
else None
"""
json = None
if name and color:
data = {'name': name, 'color': color.strip('#')}
url = self._build_url('labels', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Label(json, self) if json else None
|
python
|
def create_label(self, name, color):
"""Create a label for this repository.
:param str name: (required), name to give to the label
:param str color: (required), value of the color to assign to the
label, e.g., '#fafafa' or 'fafafa' (the latter is what is sent)
:returns: :class:`Label <github3.issues.label.Label>` if successful,
else None
"""
json = None
if name and color:
data = {'name': name, 'color': color.strip('#')}
url = self._build_url('labels', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Label(json, self) if json else None
|
[
"def",
"create_label",
"(",
"self",
",",
"name",
",",
"color",
")",
":",
"json",
"=",
"None",
"if",
"name",
"and",
"color",
":",
"data",
"=",
"{",
"'name'",
":",
"name",
",",
"'color'",
":",
"color",
".",
"strip",
"(",
"'#'",
")",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'labels'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Label",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a label for this repository.
:param str name: (required), name to give to the label
:param str color: (required), value of the color to assign to the
label, e.g., '#fafafa' or 'fafafa' (the latter is what is sent)
:returns: :class:`Label <github3.issues.label.Label>` if successful,
else None
|
[
"Create",
"a",
"label",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L670-L684
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_milestone
|
def create_milestone(self, title, state=None, description=None,
due_on=None):
"""Create a milestone for this repository.
:param str title: (required), title of the milestone
:param str state: (optional), state of the milestone, accepted
values: ('open', 'closed'), default: 'open'
:param str description: (optional), description of the milestone
:param str due_on: (optional), ISO 8601 formatted due date
:returns: :class:`Milestone <github3.issues.milestone.Milestone>` if
successful, otherwise None
"""
url = self._build_url('milestones', base_url=self._api)
if state not in ('open', 'closed'):
state = None
data = {'title': title, 'state': state,
'description': description, 'due_on': due_on}
self._remove_none(data)
json = None
if data:
json = self._json(self._post(url, data=data), 201)
return Milestone(json, self) if json else None
|
python
|
def create_milestone(self, title, state=None, description=None,
due_on=None):
"""Create a milestone for this repository.
:param str title: (required), title of the milestone
:param str state: (optional), state of the milestone, accepted
values: ('open', 'closed'), default: 'open'
:param str description: (optional), description of the milestone
:param str due_on: (optional), ISO 8601 formatted due date
:returns: :class:`Milestone <github3.issues.milestone.Milestone>` if
successful, otherwise None
"""
url = self._build_url('milestones', base_url=self._api)
if state not in ('open', 'closed'):
state = None
data = {'title': title, 'state': state,
'description': description, 'due_on': due_on}
self._remove_none(data)
json = None
if data:
json = self._json(self._post(url, data=data), 201)
return Milestone(json, self) if json else None
|
[
"def",
"create_milestone",
"(",
"self",
",",
"title",
",",
"state",
"=",
"None",
",",
"description",
"=",
"None",
",",
"due_on",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'milestones'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"if",
"state",
"not",
"in",
"(",
"'open'",
",",
"'closed'",
")",
":",
"state",
"=",
"None",
"data",
"=",
"{",
"'title'",
":",
"title",
",",
"'state'",
":",
"state",
",",
"'description'",
":",
"description",
",",
"'due_on'",
":",
"due_on",
"}",
"self",
".",
"_remove_none",
"(",
"data",
")",
"json",
"=",
"None",
"if",
"data",
":",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Milestone",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a milestone for this repository.
:param str title: (required), title of the milestone
:param str state: (optional), state of the milestone, accepted
values: ('open', 'closed'), default: 'open'
:param str description: (optional), description of the milestone
:param str due_on: (optional), ISO 8601 formatted due date
:returns: :class:`Milestone <github3.issues.milestone.Milestone>` if
successful, otherwise None
|
[
"Create",
"a",
"milestone",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L687-L708
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_pull
|
def create_pull(self, title, base, head, body=None):
"""Create a pull request of ``head`` onto ``base`` branch in this repo.
:param str title: (required)
:param str base: (required), e.g., 'master'
:param str head: (required), e.g., 'username:branch'
:param str body: (optional), markdown formatted description
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
successful, else None
"""
data = {'title': title, 'body': body, 'base': base,
'head': head}
return self._create_pull(data)
|
python
|
def create_pull(self, title, base, head, body=None):
"""Create a pull request of ``head`` onto ``base`` branch in this repo.
:param str title: (required)
:param str base: (required), e.g., 'master'
:param str head: (required), e.g., 'username:branch'
:param str body: (optional), markdown formatted description
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
successful, else None
"""
data = {'title': title, 'body': body, 'base': base,
'head': head}
return self._create_pull(data)
|
[
"def",
"create_pull",
"(",
"self",
",",
"title",
",",
"base",
",",
"head",
",",
"body",
"=",
"None",
")",
":",
"data",
"=",
"{",
"'title'",
":",
"title",
",",
"'body'",
":",
"body",
",",
"'base'",
":",
"base",
",",
"'head'",
":",
"head",
"}",
"return",
"self",
".",
"_create_pull",
"(",
"data",
")"
] |
Create a pull request of ``head`` onto ``base`` branch in this repo.
:param str title: (required)
:param str base: (required), e.g., 'master'
:param str head: (required), e.g., 'username:branch'
:param str body: (optional), markdown formatted description
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
successful, else None
|
[
"Create",
"a",
"pull",
"request",
"of",
"head",
"onto",
"base",
"branch",
"in",
"this",
"repo",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L711-L723
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_pull_from_issue
|
def create_pull_from_issue(self, issue, base, head):
"""Create a pull request from issue #``issue``.
:param int issue: (required), issue number
:param str base: (required), e.g., 'master'
:param str head: (required), e.g., 'username:branch'
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
successful, else None
"""
if int(issue) > 0:
data = {'issue': issue, 'base': base, 'head': head}
return self._create_pull(data)
return None
|
python
|
def create_pull_from_issue(self, issue, base, head):
"""Create a pull request from issue #``issue``.
:param int issue: (required), issue number
:param str base: (required), e.g., 'master'
:param str head: (required), e.g., 'username:branch'
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
successful, else None
"""
if int(issue) > 0:
data = {'issue': issue, 'base': base, 'head': head}
return self._create_pull(data)
return None
|
[
"def",
"create_pull_from_issue",
"(",
"self",
",",
"issue",
",",
"base",
",",
"head",
")",
":",
"if",
"int",
"(",
"issue",
")",
">",
"0",
":",
"data",
"=",
"{",
"'issue'",
":",
"issue",
",",
"'base'",
":",
"base",
",",
"'head'",
":",
"head",
"}",
"return",
"self",
".",
"_create_pull",
"(",
"data",
")",
"return",
"None"
] |
Create a pull request from issue #``issue``.
:param int issue: (required), issue number
:param str base: (required), e.g., 'master'
:param str head: (required), e.g., 'username:branch'
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
successful, else None
|
[
"Create",
"a",
"pull",
"request",
"from",
"issue",
"#",
"issue",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L726-L738
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_ref
|
def create_ref(self, ref, sha):
"""Create a reference in this repository.
:param str ref: (required), fully qualified name of the reference,
e.g. ``refs/heads/master``. If it doesn't start with ``refs`` and
contain at least two slashes, GitHub's API will reject it.
:param str sha: (required), SHA1 value to set the reference to
:returns: :class:`Reference <github3.git.Reference>` if successful
else None
"""
json = None
if ref and ref.count('/') >= 2 and sha:
data = {'ref': ref, 'sha': sha}
url = self._build_url('git', 'refs', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Reference(json, self) if json else None
|
python
|
def create_ref(self, ref, sha):
"""Create a reference in this repository.
:param str ref: (required), fully qualified name of the reference,
e.g. ``refs/heads/master``. If it doesn't start with ``refs`` and
contain at least two slashes, GitHub's API will reject it.
:param str sha: (required), SHA1 value to set the reference to
:returns: :class:`Reference <github3.git.Reference>` if successful
else None
"""
json = None
if ref and ref.count('/') >= 2 and sha:
data = {'ref': ref, 'sha': sha}
url = self._build_url('git', 'refs', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Reference(json, self) if json else None
|
[
"def",
"create_ref",
"(",
"self",
",",
"ref",
",",
"sha",
")",
":",
"json",
"=",
"None",
"if",
"ref",
"and",
"ref",
".",
"count",
"(",
"'/'",
")",
">=",
"2",
"and",
"sha",
":",
"data",
"=",
"{",
"'ref'",
":",
"ref",
",",
"'sha'",
":",
"sha",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'refs'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Reference",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Create a reference in this repository.
:param str ref: (required), fully qualified name of the reference,
e.g. ``refs/heads/master``. If it doesn't start with ``refs`` and
contain at least two slashes, GitHub's API will reject it.
:param str sha: (required), SHA1 value to set the reference to
:returns: :class:`Reference <github3.git.Reference>` if successful
else None
|
[
"Create",
"a",
"reference",
"in",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L741-L756
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_release
|
def create_release(self, tag_name, target_commitish=None, name=None,
body=None, draft=False, prerelease=False):
"""Create a release for this repository.
:param str tag_name: (required), name to give to the tag
:param str target_commitish: (optional), vague concept of a target,
either a SHA or a branch name.
:param str name: (optional), name of the release
:param str body: (optional), description of the release
:param bool draft: (optional), whether this release is a draft or not
:param bool prerelease: (optional), whether this is a prerelease or
not
:returns: :class:`Release <github3.repos.release.Release>`
"""
data = {'tag_name': str(tag_name),
'target_commitish': target_commitish,
'name': name,
'body': body,
'draft': draft,
'prerelease': prerelease
}
self._remove_none(data)
url = self._build_url('releases', base_url=self._api)
json = self._json(self._post(
url, data=data, headers=Release.CUSTOM_HEADERS
), 201)
return Release(json, self)
|
python
|
def create_release(self, tag_name, target_commitish=None, name=None,
body=None, draft=False, prerelease=False):
"""Create a release for this repository.
:param str tag_name: (required), name to give to the tag
:param str target_commitish: (optional), vague concept of a target,
either a SHA or a branch name.
:param str name: (optional), name of the release
:param str body: (optional), description of the release
:param bool draft: (optional), whether this release is a draft or not
:param bool prerelease: (optional), whether this is a prerelease or
not
:returns: :class:`Release <github3.repos.release.Release>`
"""
data = {'tag_name': str(tag_name),
'target_commitish': target_commitish,
'name': name,
'body': body,
'draft': draft,
'prerelease': prerelease
}
self._remove_none(data)
url = self._build_url('releases', base_url=self._api)
json = self._json(self._post(
url, data=data, headers=Release.CUSTOM_HEADERS
), 201)
return Release(json, self)
|
[
"def",
"create_release",
"(",
"self",
",",
"tag_name",
",",
"target_commitish",
"=",
"None",
",",
"name",
"=",
"None",
",",
"body",
"=",
"None",
",",
"draft",
"=",
"False",
",",
"prerelease",
"=",
"False",
")",
":",
"data",
"=",
"{",
"'tag_name'",
":",
"str",
"(",
"tag_name",
")",
",",
"'target_commitish'",
":",
"target_commitish",
",",
"'name'",
":",
"name",
",",
"'body'",
":",
"body",
",",
"'draft'",
":",
"draft",
",",
"'prerelease'",
":",
"prerelease",
"}",
"self",
".",
"_remove_none",
"(",
"data",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'releases'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
",",
"headers",
"=",
"Release",
".",
"CUSTOM_HEADERS",
")",
",",
"201",
")",
"return",
"Release",
"(",
"json",
",",
"self",
")"
] |
Create a release for this repository.
:param str tag_name: (required), name to give to the tag
:param str target_commitish: (optional), vague concept of a target,
either a SHA or a branch name.
:param str name: (optional), name of the release
:param str body: (optional), description of the release
:param bool draft: (optional), whether this release is a draft or not
:param bool prerelease: (optional), whether this is a prerelease or
not
:returns: :class:`Release <github3.repos.release.Release>`
|
[
"Create",
"a",
"release",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L759-L786
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_status
|
def create_status(self, sha, state, target_url=None, description=None,
context='default'):
"""Create a status object on a commit.
:param str sha: (required), SHA of the commit to create the status on
:param str state: (required), state of the test; only the following
are accepted: 'pending', 'success', 'error', 'failure'
:param str target_url: (optional), URL to associate with this status.
:param str description: (optional), short description of the status
:param str context: (optional), A string label to differentiate this
status from the status of other systems
:returns: the status created if successful
:rtype: :class:`~github3.repos.status.Status`
"""
json = None
if sha and state:
data = {'state': state, 'target_url': target_url,
'description': description, 'context': context}
url = self._build_url('statuses', sha, base_url=self._api)
self._remove_none(data)
json = self._json(self._post(url, data=data), 201)
return Status(json) if json else None
|
python
|
def create_status(self, sha, state, target_url=None, description=None,
context='default'):
"""Create a status object on a commit.
:param str sha: (required), SHA of the commit to create the status on
:param str state: (required), state of the test; only the following
are accepted: 'pending', 'success', 'error', 'failure'
:param str target_url: (optional), URL to associate with this status.
:param str description: (optional), short description of the status
:param str context: (optional), A string label to differentiate this
status from the status of other systems
:returns: the status created if successful
:rtype: :class:`~github3.repos.status.Status`
"""
json = None
if sha and state:
data = {'state': state, 'target_url': target_url,
'description': description, 'context': context}
url = self._build_url('statuses', sha, base_url=self._api)
self._remove_none(data)
json = self._json(self._post(url, data=data), 201)
return Status(json) if json else None
|
[
"def",
"create_status",
"(",
"self",
",",
"sha",
",",
"state",
",",
"target_url",
"=",
"None",
",",
"description",
"=",
"None",
",",
"context",
"=",
"'default'",
")",
":",
"json",
"=",
"None",
"if",
"sha",
"and",
"state",
":",
"data",
"=",
"{",
"'state'",
":",
"state",
",",
"'target_url'",
":",
"target_url",
",",
"'description'",
":",
"description",
",",
"'context'",
":",
"context",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'statuses'",
",",
"sha",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"self",
".",
"_remove_none",
"(",
"data",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Status",
"(",
"json",
")",
"if",
"json",
"else",
"None"
] |
Create a status object on a commit.
:param str sha: (required), SHA of the commit to create the status on
:param str state: (required), state of the test; only the following
are accepted: 'pending', 'success', 'error', 'failure'
:param str target_url: (optional), URL to associate with this status.
:param str description: (optional), short description of the status
:param str context: (optional), A string label to differentiate this
status from the status of other systems
:returns: the status created if successful
:rtype: :class:`~github3.repos.status.Status`
|
[
"Create",
"a",
"status",
"object",
"on",
"a",
"commit",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L789-L810
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_tag
|
def create_tag(self, tag, message, sha, obj_type, tagger,
lightweight=False):
"""Create a tag in this repository.
:param str tag: (required), name of the tag
:param str message: (required), tag message
:param str sha: (required), SHA of the git object this is tagging
:param str obj_type: (required), type of object being tagged, e.g.,
'commit', 'tree', 'blob'
:param dict tagger: (required), containing the name, email of the
tagger and the date it was tagged
:param bool lightweight: (optional), if False, create an annotated
tag, otherwise create a lightweight tag (a Reference).
:returns: If lightweight == False: :class:`Tag <github3.git.Tag>` if
successful, else None. If lightweight == True: :class:`Reference
<github3.git.Reference>`
"""
if lightweight and tag and sha:
return self.create_ref('refs/tags/' + tag, sha)
json = None
if tag and message and sha and obj_type and len(tagger) == 3:
data = {'tag': tag, 'message': message, 'object': sha,
'type': obj_type, 'tagger': tagger}
url = self._build_url('git', 'tags', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
if json:
self.create_ref('refs/tags/' + tag, sha)
return Tag(json) if json else None
|
python
|
def create_tag(self, tag, message, sha, obj_type, tagger,
lightweight=False):
"""Create a tag in this repository.
:param str tag: (required), name of the tag
:param str message: (required), tag message
:param str sha: (required), SHA of the git object this is tagging
:param str obj_type: (required), type of object being tagged, e.g.,
'commit', 'tree', 'blob'
:param dict tagger: (required), containing the name, email of the
tagger and the date it was tagged
:param bool lightweight: (optional), if False, create an annotated
tag, otherwise create a lightweight tag (a Reference).
:returns: If lightweight == False: :class:`Tag <github3.git.Tag>` if
successful, else None. If lightweight == True: :class:`Reference
<github3.git.Reference>`
"""
if lightweight and tag and sha:
return self.create_ref('refs/tags/' + tag, sha)
json = None
if tag and message and sha and obj_type and len(tagger) == 3:
data = {'tag': tag, 'message': message, 'object': sha,
'type': obj_type, 'tagger': tagger}
url = self._build_url('git', 'tags', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
if json:
self.create_ref('refs/tags/' + tag, sha)
return Tag(json) if json else None
|
[
"def",
"create_tag",
"(",
"self",
",",
"tag",
",",
"message",
",",
"sha",
",",
"obj_type",
",",
"tagger",
",",
"lightweight",
"=",
"False",
")",
":",
"if",
"lightweight",
"and",
"tag",
"and",
"sha",
":",
"return",
"self",
".",
"create_ref",
"(",
"'refs/tags/'",
"+",
"tag",
",",
"sha",
")",
"json",
"=",
"None",
"if",
"tag",
"and",
"message",
"and",
"sha",
"and",
"obj_type",
"and",
"len",
"(",
"tagger",
")",
"==",
"3",
":",
"data",
"=",
"{",
"'tag'",
":",
"tag",
",",
"'message'",
":",
"message",
",",
"'object'",
":",
"sha",
",",
"'type'",
":",
"obj_type",
",",
"'tagger'",
":",
"tagger",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'tags'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"if",
"json",
":",
"self",
".",
"create_ref",
"(",
"'refs/tags/'",
"+",
"tag",
",",
"sha",
")",
"return",
"Tag",
"(",
"json",
")",
"if",
"json",
"else",
"None"
] |
Create a tag in this repository.
:param str tag: (required), name of the tag
:param str message: (required), tag message
:param str sha: (required), SHA of the git object this is tagging
:param str obj_type: (required), type of object being tagged, e.g.,
'commit', 'tree', 'blob'
:param dict tagger: (required), containing the name, email of the
tagger and the date it was tagged
:param bool lightweight: (optional), if False, create an annotated
tag, otherwise create a lightweight tag (a Reference).
:returns: If lightweight == False: :class:`Tag <github3.git.Tag>` if
successful, else None. If lightweight == True: :class:`Reference
<github3.git.Reference>`
|
[
"Create",
"a",
"tag",
"in",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L813-L841
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.create_tree
|
def create_tree(self, tree, base_tree=''):
"""Create a tree on this repository.
:param list tree: (required), specifies the tree structure.
Format: [{'path': 'path/file', 'mode':
'filemode', 'type': 'blob or tree', 'sha': '44bfc6d...'}]
:param str base_tree: (optional), SHA1 of the tree you want
to update with new data
:returns: :class:`Tree <github3.git.Tree>` if successful, else None
"""
json = None
if tree and isinstance(tree, list):
data = {'tree': tree, 'base_tree': base_tree}
url = self._build_url('git', 'trees', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Tree(json) if json else None
|
python
|
def create_tree(self, tree, base_tree=''):
"""Create a tree on this repository.
:param list tree: (required), specifies the tree structure.
Format: [{'path': 'path/file', 'mode':
'filemode', 'type': 'blob or tree', 'sha': '44bfc6d...'}]
:param str base_tree: (optional), SHA1 of the tree you want
to update with new data
:returns: :class:`Tree <github3.git.Tree>` if successful, else None
"""
json = None
if tree and isinstance(tree, list):
data = {'tree': tree, 'base_tree': base_tree}
url = self._build_url('git', 'trees', base_url=self._api)
json = self._json(self._post(url, data=data), 201)
return Tree(json) if json else None
|
[
"def",
"create_tree",
"(",
"self",
",",
"tree",
",",
"base_tree",
"=",
"''",
")",
":",
"json",
"=",
"None",
"if",
"tree",
"and",
"isinstance",
"(",
"tree",
",",
"list",
")",
":",
"data",
"=",
"{",
"'tree'",
":",
"tree",
",",
"'base_tree'",
":",
"base_tree",
"}",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'trees'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"Tree",
"(",
"json",
")",
"if",
"json",
"else",
"None"
] |
Create a tree on this repository.
:param list tree: (required), specifies the tree structure.
Format: [{'path': 'path/file', 'mode':
'filemode', 'type': 'blob or tree', 'sha': '44bfc6d...'}]
:param str base_tree: (optional), SHA1 of the tree you want
to update with new data
:returns: :class:`Tree <github3.git.Tree>` if successful, else None
|
[
"Create",
"a",
"tree",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L844-L859
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.delete_file
|
def delete_file(self, path, message, sha, branch=None, committer=None,
author=None):
"""Delete the file located at ``path``.
This is part of the Contents CrUD (Create Update Delete) API. See
http://developer.github.com/v3/repos/contents/#delete-a-file for more
information.
:param str path: (required), path to the file being removed
:param str message: (required), commit message for the deletion
:param str sha: (required), blob sha of the file being removed
:param str branch: (optional), if not provided, uses the repository's
default branch
:param dict committer: (optional), if no information is given the
authenticated user's information will be used. You must specify
both a name and email.
:param dict author: (optional), if omitted this will be filled in with
committer information. If passed, you must specify both a name and
email.
:returns: :class:`Commit <github3.git.Commit>` if successful
"""
json = None
if path and message and sha:
url = self._build_url('contents', path, base_url=self._api)
data = {'message': message, 'sha': sha, 'branch': branch,
'committer': validate_commmitter(committer),
'author': validate_commmitter(author)}
self._remove_none(data)
json = self._json(self._delete(url, data=dumps(data)), 200)
if json and 'commit' in json:
json = Commit(json['commit'])
return json
|
python
|
def delete_file(self, path, message, sha, branch=None, committer=None,
author=None):
"""Delete the file located at ``path``.
This is part of the Contents CrUD (Create Update Delete) API. See
http://developer.github.com/v3/repos/contents/#delete-a-file for more
information.
:param str path: (required), path to the file being removed
:param str message: (required), commit message for the deletion
:param str sha: (required), blob sha of the file being removed
:param str branch: (optional), if not provided, uses the repository's
default branch
:param dict committer: (optional), if no information is given the
authenticated user's information will be used. You must specify
both a name and email.
:param dict author: (optional), if omitted this will be filled in with
committer information. If passed, you must specify both a name and
email.
:returns: :class:`Commit <github3.git.Commit>` if successful
"""
json = None
if path and message and sha:
url = self._build_url('contents', path, base_url=self._api)
data = {'message': message, 'sha': sha, 'branch': branch,
'committer': validate_commmitter(committer),
'author': validate_commmitter(author)}
self._remove_none(data)
json = self._json(self._delete(url, data=dumps(data)), 200)
if json and 'commit' in json:
json = Commit(json['commit'])
return json
|
[
"def",
"delete_file",
"(",
"self",
",",
"path",
",",
"message",
",",
"sha",
",",
"branch",
"=",
"None",
",",
"committer",
"=",
"None",
",",
"author",
"=",
"None",
")",
":",
"json",
"=",
"None",
"if",
"path",
"and",
"message",
"and",
"sha",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'contents'",
",",
"path",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"{",
"'message'",
":",
"message",
",",
"'sha'",
":",
"sha",
",",
"'branch'",
":",
"branch",
",",
"'committer'",
":",
"validate_commmitter",
"(",
"committer",
")",
",",
"'author'",
":",
"validate_commmitter",
"(",
"author",
")",
"}",
"self",
".",
"_remove_none",
"(",
"data",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_delete",
"(",
"url",
",",
"data",
"=",
"dumps",
"(",
"data",
")",
")",
",",
"200",
")",
"if",
"json",
"and",
"'commit'",
"in",
"json",
":",
"json",
"=",
"Commit",
"(",
"json",
"[",
"'commit'",
"]",
")",
"return",
"json"
] |
Delete the file located at ``path``.
This is part of the Contents CrUD (Create Update Delete) API. See
http://developer.github.com/v3/repos/contents/#delete-a-file for more
information.
:param str path: (required), path to the file being removed
:param str message: (required), commit message for the deletion
:param str sha: (required), blob sha of the file being removed
:param str branch: (optional), if not provided, uses the repository's
default branch
:param dict committer: (optional), if no information is given the
authenticated user's information will be used. You must specify
both a name and email.
:param dict author: (optional), if omitted this will be filled in with
committer information. If passed, you must specify both a name and
email.
:returns: :class:`Commit <github3.git.Commit>` if successful
|
[
"Delete",
"the",
"file",
"located",
"at",
"path",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L870-L902
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.delete_key
|
def delete_key(self, key_id):
"""Delete the key with the specified id from your deploy keys list.
:returns: bool -- True if successful, False otherwise
"""
if int(key_id) <= 0:
return False
url = self._build_url('keys', str(key_id), base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
|
python
|
def delete_key(self, key_id):
"""Delete the key with the specified id from your deploy keys list.
:returns: bool -- True if successful, False otherwise
"""
if int(key_id) <= 0:
return False
url = self._build_url('keys', str(key_id), base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
|
[
"def",
"delete_key",
"(",
"self",
",",
"key_id",
")",
":",
"if",
"int",
"(",
"key_id",
")",
"<=",
"0",
":",
"return",
"False",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'keys'",
",",
"str",
"(",
"key_id",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_delete",
"(",
"url",
")",
",",
"204",
",",
"404",
")"
] |
Delete the key with the specified id from your deploy keys list.
:returns: bool -- True if successful, False otherwise
|
[
"Delete",
"the",
"key",
"with",
"the",
"specified",
"id",
"from",
"your",
"deploy",
"keys",
"list",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L905-L913
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.edit
|
def edit(self,
name,
description=None,
homepage=None,
private=None,
has_issues=None,
has_wiki=None,
has_downloads=None,
default_branch=None):
"""Edit this repository.
:param str name: (required), name of the repository
:param str description: (optional), If not ``None``, change the
description for this repository. API default: ``None`` - leave
value unchanged.
:param str homepage: (optional), If not ``None``, change the homepage
for this repository. API default: ``None`` - leave value unchanged.
:param bool private: (optional), If ``True``, make the repository
private. If ``False``, make the repository public. API default:
``None`` - leave value unchanged.
:param bool has_issues: (optional), If ``True``, enable issues for
this repository. If ``False``, disable issues for this repository.
API default: ``None`` - leave value unchanged.
:param bool has_wiki: (optional), If ``True``, enable the wiki for
this repository. If ``False``, disable the wiki for this
repository. API default: ``None`` - leave value unchanged.
:param bool has_downloads: (optional), If ``True``, enable downloads
for this repository. If ``False``, disable downloads for this
repository. API default: ``None`` - leave value unchanged.
:param str default_branch: (optional), If not ``None``, change the
default branch for this repository. API default: ``None`` - leave
value unchanged.
:returns: bool -- True if successful, False otherwise
"""
edit = {'name': name, 'description': description, 'homepage': homepage,
'private': private, 'has_issues': has_issues,
'has_wiki': has_wiki, 'has_downloads': has_downloads,
'default_branch': default_branch}
self._remove_none(edit)
json = None
if edit:
json = self._json(self._patch(self._api, data=dumps(edit)), 200)
self._update_(json)
return True
return False
|
python
|
def edit(self,
name,
description=None,
homepage=None,
private=None,
has_issues=None,
has_wiki=None,
has_downloads=None,
default_branch=None):
"""Edit this repository.
:param str name: (required), name of the repository
:param str description: (optional), If not ``None``, change the
description for this repository. API default: ``None`` - leave
value unchanged.
:param str homepage: (optional), If not ``None``, change the homepage
for this repository. API default: ``None`` - leave value unchanged.
:param bool private: (optional), If ``True``, make the repository
private. If ``False``, make the repository public. API default:
``None`` - leave value unchanged.
:param bool has_issues: (optional), If ``True``, enable issues for
this repository. If ``False``, disable issues for this repository.
API default: ``None`` - leave value unchanged.
:param bool has_wiki: (optional), If ``True``, enable the wiki for
this repository. If ``False``, disable the wiki for this
repository. API default: ``None`` - leave value unchanged.
:param bool has_downloads: (optional), If ``True``, enable downloads
for this repository. If ``False``, disable downloads for this
repository. API default: ``None`` - leave value unchanged.
:param str default_branch: (optional), If not ``None``, change the
default branch for this repository. API default: ``None`` - leave
value unchanged.
:returns: bool -- True if successful, False otherwise
"""
edit = {'name': name, 'description': description, 'homepage': homepage,
'private': private, 'has_issues': has_issues,
'has_wiki': has_wiki, 'has_downloads': has_downloads,
'default_branch': default_branch}
self._remove_none(edit)
json = None
if edit:
json = self._json(self._patch(self._api, data=dumps(edit)), 200)
self._update_(json)
return True
return False
|
[
"def",
"edit",
"(",
"self",
",",
"name",
",",
"description",
"=",
"None",
",",
"homepage",
"=",
"None",
",",
"private",
"=",
"None",
",",
"has_issues",
"=",
"None",
",",
"has_wiki",
"=",
"None",
",",
"has_downloads",
"=",
"None",
",",
"default_branch",
"=",
"None",
")",
":",
"edit",
"=",
"{",
"'name'",
":",
"name",
",",
"'description'",
":",
"description",
",",
"'homepage'",
":",
"homepage",
",",
"'private'",
":",
"private",
",",
"'has_issues'",
":",
"has_issues",
",",
"'has_wiki'",
":",
"has_wiki",
",",
"'has_downloads'",
":",
"has_downloads",
",",
"'default_branch'",
":",
"default_branch",
"}",
"self",
".",
"_remove_none",
"(",
"edit",
")",
"json",
"=",
"None",
"if",
"edit",
":",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_patch",
"(",
"self",
".",
"_api",
",",
"data",
"=",
"dumps",
"(",
"edit",
")",
")",
",",
"200",
")",
"self",
".",
"_update_",
"(",
"json",
")",
"return",
"True",
"return",
"False"
] |
Edit this repository.
:param str name: (required), name of the repository
:param str description: (optional), If not ``None``, change the
description for this repository. API default: ``None`` - leave
value unchanged.
:param str homepage: (optional), If not ``None``, change the homepage
for this repository. API default: ``None`` - leave value unchanged.
:param bool private: (optional), If ``True``, make the repository
private. If ``False``, make the repository public. API default:
``None`` - leave value unchanged.
:param bool has_issues: (optional), If ``True``, enable issues for
this repository. If ``False``, disable issues for this repository.
API default: ``None`` - leave value unchanged.
:param bool has_wiki: (optional), If ``True``, enable the wiki for
this repository. If ``False``, disable the wiki for this
repository. API default: ``None`` - leave value unchanged.
:param bool has_downloads: (optional), If ``True``, enable downloads
for this repository. If ``False``, disable downloads for this
repository. API default: ``None`` - leave value unchanged.
:param str default_branch: (optional), If not ``None``, change the
default branch for this repository. API default: ``None`` - leave
value unchanged.
:returns: bool -- True if successful, False otherwise
|
[
"Edit",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L925-L969
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.git_commit
|
def git_commit(self, sha):
"""Get a single (git) commit.
:param str sha: (required), sha of the commit
:returns: :class:`Commit <github3.git.Commit>` if successful,
otherwise None
"""
json = {}
if sha:
url = self._build_url('git', 'commits', sha, base_url=self._api)
json = self._json(self._get(url), 200)
return Commit(json, self) if json else None
|
python
|
def git_commit(self, sha):
"""Get a single (git) commit.
:param str sha: (required), sha of the commit
:returns: :class:`Commit <github3.git.Commit>` if successful,
otherwise None
"""
json = {}
if sha:
url = self._build_url('git', 'commits', sha, base_url=self._api)
json = self._json(self._get(url), 200)
return Commit(json, self) if json else None
|
[
"def",
"git_commit",
"(",
"self",
",",
"sha",
")",
":",
"json",
"=",
"{",
"}",
"if",
"sha",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'commits'",
",",
"sha",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Commit",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get a single (git) commit.
:param str sha: (required), sha of the commit
:returns: :class:`Commit <github3.git.Commit>` if successful,
otherwise None
|
[
"Get",
"a",
"single",
"(",
"git",
")",
"commit",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L982-L993
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.hook
|
def hook(self, id_num):
"""Get a single hook.
:param int id_num: (required), id of the hook
:returns: :class:`Hook <github3.repos.hook.Hook>` if successful,
otherwise None
"""
json = None
if int(id_num) > 0:
url = self._build_url('hooks', str(id_num), base_url=self._api)
json = self._json(self._get(url), 200)
return Hook(json, self) if json else None
|
python
|
def hook(self, id_num):
"""Get a single hook.
:param int id_num: (required), id of the hook
:returns: :class:`Hook <github3.repos.hook.Hook>` if successful,
otherwise None
"""
json = None
if int(id_num) > 0:
url = self._build_url('hooks', str(id_num), base_url=self._api)
json = self._json(self._get(url), 200)
return Hook(json, self) if json else None
|
[
"def",
"hook",
"(",
"self",
",",
"id_num",
")",
":",
"json",
"=",
"None",
"if",
"int",
"(",
"id_num",
")",
">",
"0",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'hooks'",
",",
"str",
"(",
"id_num",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Hook",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get a single hook.
:param int id_num: (required), id of the hook
:returns: :class:`Hook <github3.repos.hook.Hook>` if successful,
otherwise None
|
[
"Get",
"a",
"single",
"hook",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L996-L1007
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.is_assignee
|
def is_assignee(self, login):
"""Check if the user is a possible assignee for an issue on this
repository.
:returns: :class:`bool`
"""
if not login:
return False
url = self._build_url('assignees', login, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
|
python
|
def is_assignee(self, login):
"""Check if the user is a possible assignee for an issue on this
repository.
:returns: :class:`bool`
"""
if not login:
return False
url = self._build_url('assignees', login, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
|
[
"def",
"is_assignee",
"(",
"self",
",",
"login",
")",
":",
"if",
"not",
"login",
":",
"return",
"False",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'assignees'",
",",
"login",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"204",
",",
"404",
")"
] |
Check if the user is a possible assignee for an issue on this
repository.
:returns: :class:`bool`
|
[
"Check",
"if",
"the",
"user",
"is",
"a",
"possible",
"assignee",
"for",
"an",
"issue",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1009-L1018
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.issue
|
def issue(self, number):
"""Get the issue specified by ``number``.
:param int number: (required), number of the issue on this repository
:returns: :class:`Issue <github3.issues.issue.Issue>` if successful,
otherwise None
"""
json = None
if int(number) > 0:
url = self._build_url('issues', str(number), base_url=self._api)
json = self._json(self._get(url), 200)
return Issue(json, self) if json else None
|
python
|
def issue(self, number):
"""Get the issue specified by ``number``.
:param int number: (required), number of the issue on this repository
:returns: :class:`Issue <github3.issues.issue.Issue>` if successful,
otherwise None
"""
json = None
if int(number) > 0:
url = self._build_url('issues', str(number), base_url=self._api)
json = self._json(self._get(url), 200)
return Issue(json, self) if json else None
|
[
"def",
"issue",
"(",
"self",
",",
"number",
")",
":",
"json",
"=",
"None",
"if",
"int",
"(",
"number",
")",
">",
"0",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'issues'",
",",
"str",
"(",
"number",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Issue",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the issue specified by ``number``.
:param int number: (required), number of the issue on this repository
:returns: :class:`Issue <github3.issues.issue.Issue>` if successful,
otherwise None
|
[
"Get",
"the",
"issue",
"specified",
"by",
"number",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1020-L1031
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.key
|
def key(self, id_num):
"""Get the specified deploy key.
:param int id_num: (required), id of the key
:returns: :class:`Key <github3.users.Key>` if successful, else None
"""
json = None
if int(id_num) > 0:
url = self._build_url('keys', str(id_num), base_url=self._api)
json = self._json(self._get(url), 200)
return Key(json, self) if json else None
|
python
|
def key(self, id_num):
"""Get the specified deploy key.
:param int id_num: (required), id of the key
:returns: :class:`Key <github3.users.Key>` if successful, else None
"""
json = None
if int(id_num) > 0:
url = self._build_url('keys', str(id_num), base_url=self._api)
json = self._json(self._get(url), 200)
return Key(json, self) if json else None
|
[
"def",
"key",
"(",
"self",
",",
"id_num",
")",
":",
"json",
"=",
"None",
"if",
"int",
"(",
"id_num",
")",
">",
"0",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'keys'",
",",
"str",
"(",
"id_num",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Key",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the specified deploy key.
:param int id_num: (required), id of the key
:returns: :class:`Key <github3.users.Key>` if successful, else None
|
[
"Get",
"the",
"specified",
"deploy",
"key",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1034-L1044
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.label
|
def label(self, name):
"""Get the label specified by ``name``
:param str name: (required), name of the label
:returns: :class:`Label <github3.issues.label.Label>` if successful,
else None
"""
json = None
if name:
url = self._build_url('labels', name, base_url=self._api)
json = self._json(self._get(url), 200)
return Label(json, self) if json else None
|
python
|
def label(self, name):
"""Get the label specified by ``name``
:param str name: (required), name of the label
:returns: :class:`Label <github3.issues.label.Label>` if successful,
else None
"""
json = None
if name:
url = self._build_url('labels', name, base_url=self._api)
json = self._json(self._get(url), 200)
return Label(json, self) if json else None
|
[
"def",
"label",
"(",
"self",
",",
"name",
")",
":",
"json",
"=",
"None",
"if",
"name",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'labels'",
",",
"name",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Label",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the label specified by ``name``
:param str name: (required), name of the label
:returns: :class:`Label <github3.issues.label.Label>` if successful,
else None
|
[
"Get",
"the",
"label",
"specified",
"by",
"name"
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1046-L1057
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_branches
|
def iter_branches(self, number=-1, etag=None):
"""Iterate over the branches in this repository.
:param int number: (optional), number of branches to return. Default:
-1 returns all branches
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Branch <github3.repos.branch.Branch>`\ es
"""
url = self._build_url('branches', base_url=self._api)
return self._iter(int(number), url, Branch, etag=etag)
|
python
|
def iter_branches(self, number=-1, etag=None):
"""Iterate over the branches in this repository.
:param int number: (optional), number of branches to return. Default:
-1 returns all branches
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Branch <github3.repos.branch.Branch>`\ es
"""
url = self._build_url('branches', base_url=self._api)
return self._iter(int(number), url, Branch, etag=etag)
|
[
"def",
"iter_branches",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'branches'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Branch",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over the branches in this repository.
:param int number: (optional), number of branches to return. Default:
-1 returns all branches
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Branch <github3.repos.branch.Branch>`\ es
|
[
"Iterate",
"over",
"the",
"branches",
"in",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1082-L1093
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_code_frequency
|
def iter_code_frequency(self, number=-1, etag=None):
"""Iterate over the code frequency per week.
Returns a weekly aggregate of the number of additions and deletions
pushed to this repository.
:param int number: (optional), number of weeks to return. Default: -1
returns all weeks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of lists ``[seconds_from_epoch, additions,
deletions]``
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
"""
url = self._build_url('stats', 'code_frequency', base_url=self._api)
return self._iter(int(number), url, list, etag=etag)
|
python
|
def iter_code_frequency(self, number=-1, etag=None):
"""Iterate over the code frequency per week.
Returns a weekly aggregate of the number of additions and deletions
pushed to this repository.
:param int number: (optional), number of weeks to return. Default: -1
returns all weeks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of lists ``[seconds_from_epoch, additions,
deletions]``
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
"""
url = self._build_url('stats', 'code_frequency', base_url=self._api)
return self._iter(int(number), url, list, etag=etag)
|
[
"def",
"iter_code_frequency",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'stats'",
",",
"'code_frequency'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"list",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over the code frequency per week.
Returns a weekly aggregate of the number of additions and deletions
pushed to this repository.
:param int number: (optional), number of weeks to return. Default: -1
returns all weeks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of lists ``[seconds_from_epoch, additions,
deletions]``
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
|
[
"Iterate",
"over",
"the",
"code",
"frequency",
"per",
"week",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1095-L1117
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_comments_on_commit
|
def iter_comments_on_commit(self, sha, number=1, etag=None):
"""Iterate over comments for a single commit.
:param sha: (required), sha of the commit to list comments on
:type sha: str
:param int number: (optional), number of comments to return. Default:
-1 returns all comments
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`RepoComment <github3.repos.comment.RepoComment>`\ s
"""
url = self._build_url('commits', sha, 'comments', base_url=self._api)
return self._iter(int(number), url, RepoComment, etag=etag)
|
python
|
def iter_comments_on_commit(self, sha, number=1, etag=None):
"""Iterate over comments for a single commit.
:param sha: (required), sha of the commit to list comments on
:type sha: str
:param int number: (optional), number of comments to return. Default:
-1 returns all comments
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`RepoComment <github3.repos.comment.RepoComment>`\ s
"""
url = self._build_url('commits', sha, 'comments', base_url=self._api)
return self._iter(int(number), url, RepoComment, etag=etag)
|
[
"def",
"iter_comments_on_commit",
"(",
"self",
",",
"sha",
",",
"number",
"=",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'commits'",
",",
"sha",
",",
"'comments'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"RepoComment",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over comments for a single commit.
:param sha: (required), sha of the commit to list comments on
:type sha: str
:param int number: (optional), number of comments to return. Default:
-1 returns all comments
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`RepoComment <github3.repos.comment.RepoComment>`\ s
|
[
"Iterate",
"over",
"comments",
"for",
"a",
"single",
"commit",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1144-L1157
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_commit_activity
|
def iter_commit_activity(self, number=-1, etag=None):
"""Iterate over last year of commit activity by week.
See: http://developer.github.com/v3/repos/statistics/
:param int number: (optional), number of weeks to return. Default -1
will return all of the weeks.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of dictionaries
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
"""
url = self._build_url('stats', 'commit_activity', base_url=self._api)
return self._iter(int(number), url, dict, etag=etag)
|
python
|
def iter_commit_activity(self, number=-1, etag=None):
"""Iterate over last year of commit activity by week.
See: http://developer.github.com/v3/repos/statistics/
:param int number: (optional), number of weeks to return. Default -1
will return all of the weeks.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of dictionaries
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
"""
url = self._build_url('stats', 'commit_activity', base_url=self._api)
return self._iter(int(number), url, dict, etag=etag)
|
[
"def",
"iter_commit_activity",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'stats'",
",",
"'commit_activity'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"dict",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over last year of commit activity by week.
See: http://developer.github.com/v3/repos/statistics/
:param int number: (optional), number of weeks to return. Default -1
will return all of the weeks.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of dictionaries
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
|
[
"Iterate",
"over",
"last",
"year",
"of",
"commit",
"activity",
"by",
"week",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1159-L1179
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_commits
|
def iter_commits(self, sha=None, path=None, author=None, number=-1,
etag=None, since=None, until=None):
"""Iterate over commits in this repository.
:param str sha: (optional), sha or branch to start listing commits
from
:param str path: (optional), commits containing this path will be
listed
:param str author: (optional), GitHub login, real name, or email to
filter commits by (using commit author)
:param int number: (optional), number of commits to return. Default:
-1 returns all commits
:param str etag: (optional), ETag from a previous request to the same
endpoint
:param since: (optional), Only commits after this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string.
:type since: datetime or string
:param until: (optional), Only commits before this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string.
:type until: datetime or string
:returns: generator of
:class:`RepoCommit <github3.repos.commit.RepoCommit>`\ s
"""
params = {'sha': sha, 'path': path, 'author': author,
'since': timestamp_parameter(since),
'until': timestamp_parameter(until)}
self._remove_none(params)
url = self._build_url('commits', base_url=self._api)
return self._iter(int(number), url, RepoCommit, params, etag)
|
python
|
def iter_commits(self, sha=None, path=None, author=None, number=-1,
etag=None, since=None, until=None):
"""Iterate over commits in this repository.
:param str sha: (optional), sha or branch to start listing commits
from
:param str path: (optional), commits containing this path will be
listed
:param str author: (optional), GitHub login, real name, or email to
filter commits by (using commit author)
:param int number: (optional), number of commits to return. Default:
-1 returns all commits
:param str etag: (optional), ETag from a previous request to the same
endpoint
:param since: (optional), Only commits after this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string.
:type since: datetime or string
:param until: (optional), Only commits before this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string.
:type until: datetime or string
:returns: generator of
:class:`RepoCommit <github3.repos.commit.RepoCommit>`\ s
"""
params = {'sha': sha, 'path': path, 'author': author,
'since': timestamp_parameter(since),
'until': timestamp_parameter(until)}
self._remove_none(params)
url = self._build_url('commits', base_url=self._api)
return self._iter(int(number), url, RepoCommit, params, etag)
|
[
"def",
"iter_commits",
"(",
"self",
",",
"sha",
"=",
"None",
",",
"path",
"=",
"None",
",",
"author",
"=",
"None",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
",",
"since",
"=",
"None",
",",
"until",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'sha'",
":",
"sha",
",",
"'path'",
":",
"path",
",",
"'author'",
":",
"author",
",",
"'since'",
":",
"timestamp_parameter",
"(",
"since",
")",
",",
"'until'",
":",
"timestamp_parameter",
"(",
"until",
")",
"}",
"self",
".",
"_remove_none",
"(",
"params",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'commits'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"RepoCommit",
",",
"params",
",",
"etag",
")"
] |
Iterate over commits in this repository.
:param str sha: (optional), sha or branch to start listing commits
from
:param str path: (optional), commits containing this path will be
listed
:param str author: (optional), GitHub login, real name, or email to
filter commits by (using commit author)
:param int number: (optional), number of commits to return. Default:
-1 returns all commits
:param str etag: (optional), ETag from a previous request to the same
endpoint
:param since: (optional), Only commits after this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string.
:type since: datetime or string
:param until: (optional), Only commits before this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string.
:type until: datetime or string
:returns: generator of
:class:`RepoCommit <github3.repos.commit.RepoCommit>`\ s
|
[
"Iterate",
"over",
"commits",
"in",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1181-L1213
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_contributors
|
def iter_contributors(self, anon=False, number=-1, etag=None):
"""Iterate over the contributors to this repository.
:param bool anon: (optional), True lists anonymous contributors as
well
:param int number: (optional), number of contributors to return.
Default: -1 returns all contributors
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <github3.users.User>`\ s
"""
url = self._build_url('contributors', base_url=self._api)
params = {}
if anon:
params = {'anon': True}
return self._iter(int(number), url, User, params, etag)
|
python
|
def iter_contributors(self, anon=False, number=-1, etag=None):
"""Iterate over the contributors to this repository.
:param bool anon: (optional), True lists anonymous contributors as
well
:param int number: (optional), number of contributors to return.
Default: -1 returns all contributors
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <github3.users.User>`\ s
"""
url = self._build_url('contributors', base_url=self._api)
params = {}
if anon:
params = {'anon': True}
return self._iter(int(number), url, User, params, etag)
|
[
"def",
"iter_contributors",
"(",
"self",
",",
"anon",
"=",
"False",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'contributors'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"params",
"=",
"{",
"}",
"if",
"anon",
":",
"params",
"=",
"{",
"'anon'",
":",
"True",
"}",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"User",
",",
"params",
",",
"etag",
")"
] |
Iterate over the contributors to this repository.
:param bool anon: (optional), True lists anonymous contributors as
well
:param int number: (optional), number of contributors to return.
Default: -1 returns all contributors
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <github3.users.User>`\ s
|
[
"Iterate",
"over",
"the",
"contributors",
"to",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1215-L1230
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_contributor_statistics
|
def iter_contributor_statistics(self, number=-1, etag=None):
"""Iterate over the contributors list.
See also: http://developer.github.com/v3/repos/statistics/
:param int number: (optional), number of weeks to return. Default -1
will return all of the weeks.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`ContributorStats <github3.repos.stats.ContributorStats>`
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
"""
url = self._build_url('stats', 'contributors', base_url=self._api)
return self._iter(int(number), url, ContributorStats, etag=etag)
|
python
|
def iter_contributor_statistics(self, number=-1, etag=None):
"""Iterate over the contributors list.
See also: http://developer.github.com/v3/repos/statistics/
:param int number: (optional), number of weeks to return. Default -1
will return all of the weeks.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`ContributorStats <github3.repos.stats.ContributorStats>`
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
"""
url = self._build_url('stats', 'contributors', base_url=self._api)
return self._iter(int(number), url, ContributorStats, etag=etag)
|
[
"def",
"iter_contributor_statistics",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'stats'",
",",
"'contributors'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"ContributorStats",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over the contributors list.
See also: http://developer.github.com/v3/repos/statistics/
:param int number: (optional), number of weeks to return. Default -1
will return all of the weeks.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`ContributorStats <github3.repos.stats.ContributorStats>`
.. note:: All statistics methods may return a 202. On those occasions,
you will not receive any objects. You should store your
iterator and check the new ``last_status`` attribute. If it
is a 202 you should wait before re-requesting.
.. versionadded:: 0.7
|
[
"Iterate",
"over",
"the",
"contributors",
"list",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1232-L1253
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_deployments
|
def iter_deployments(self, number=-1, etag=None):
"""Iterate over deployments for this repository.
:param int number: (optional), number of deployments to return.
Default: -1, returns all available deployments
:param str etag: (optional), ETag from a previous request for all
deployments
:returns: generator of
:class:`Deployment <github3.repos.deployment.Deployment>`\ s
"""
url = self._build_url('deployments', base_url=self._api)
i = self._iter(int(number), url, Deployment, etag=etag)
i.headers.update(Deployment.CUSTOM_HEADERS)
return i
|
python
|
def iter_deployments(self, number=-1, etag=None):
"""Iterate over deployments for this repository.
:param int number: (optional), number of deployments to return.
Default: -1, returns all available deployments
:param str etag: (optional), ETag from a previous request for all
deployments
:returns: generator of
:class:`Deployment <github3.repos.deployment.Deployment>`\ s
"""
url = self._build_url('deployments', base_url=self._api)
i = self._iter(int(number), url, Deployment, etag=etag)
i.headers.update(Deployment.CUSTOM_HEADERS)
return i
|
[
"def",
"iter_deployments",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'deployments'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"i",
"=",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Deployment",
",",
"etag",
"=",
"etag",
")",
"i",
".",
"headers",
".",
"update",
"(",
"Deployment",
".",
"CUSTOM_HEADERS",
")",
"return",
"i"
] |
Iterate over deployments for this repository.
:param int number: (optional), number of deployments to return.
Default: -1, returns all available deployments
:param str etag: (optional), ETag from a previous request for all
deployments
:returns: generator of
:class:`Deployment <github3.repos.deployment.Deployment>`\ s
|
[
"Iterate",
"over",
"deployments",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1255-L1268
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_forks
|
def iter_forks(self, sort='', number=-1, etag=None):
"""Iterate over forks of this repository.
:param str sort: (optional), accepted values:
('newest', 'oldest', 'watchers'), API default: 'newest'
:param int number: (optional), number of forks to return. Default: -1
returns all forks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <Repository>`
"""
url = self._build_url('forks', base_url=self._api)
params = {}
if sort in ('newest', 'oldest', 'watchers'):
params = {'sort': sort}
return self._iter(int(number), url, Repository, params, etag)
|
python
|
def iter_forks(self, sort='', number=-1, etag=None):
"""Iterate over forks of this repository.
:param str sort: (optional), accepted values:
('newest', 'oldest', 'watchers'), API default: 'newest'
:param int number: (optional), number of forks to return. Default: -1
returns all forks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <Repository>`
"""
url = self._build_url('forks', base_url=self._api)
params = {}
if sort in ('newest', 'oldest', 'watchers'):
params = {'sort': sort}
return self._iter(int(number), url, Repository, params, etag)
|
[
"def",
"iter_forks",
"(",
"self",
",",
"sort",
"=",
"''",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'forks'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"params",
"=",
"{",
"}",
"if",
"sort",
"in",
"(",
"'newest'",
",",
"'oldest'",
",",
"'watchers'",
")",
":",
"params",
"=",
"{",
"'sort'",
":",
"sort",
"}",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Repository",
",",
"params",
",",
"etag",
")"
] |
Iterate over forks of this repository.
:param str sort: (optional), accepted values:
('newest', 'oldest', 'watchers'), API default: 'newest'
:param int number: (optional), number of forks to return. Default: -1
returns all forks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <Repository>`
|
[
"Iterate",
"over",
"forks",
"of",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1282-L1297
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_hooks
|
def iter_hooks(self, number=-1, etag=None):
"""Iterate over hooks registered on this repository.
:param int number: (optional), number of hoks to return. Default: -1
returns all hooks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Hook <github3.repos.hook.Hook>`\ s
"""
url = self._build_url('hooks', base_url=self._api)
return self._iter(int(number), url, Hook, etag=etag)
|
python
|
def iter_hooks(self, number=-1, etag=None):
"""Iterate over hooks registered on this repository.
:param int number: (optional), number of hoks to return. Default: -1
returns all hooks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Hook <github3.repos.hook.Hook>`\ s
"""
url = self._build_url('hooks', base_url=self._api)
return self._iter(int(number), url, Hook, etag=etag)
|
[
"def",
"iter_hooks",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'hooks'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Hook",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over hooks registered on this repository.
:param int number: (optional), number of hoks to return. Default: -1
returns all hooks
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Hook <github3.repos.hook.Hook>`\ s
|
[
"Iterate",
"over",
"hooks",
"registered",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1300-L1310
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_issues
|
def iter_issues(self,
milestone=None,
state=None,
assignee=None,
mentioned=None,
labels=None,
sort=None,
direction=None,
since=None,
number=-1,
etag=None):
"""Iterate over issues on this repo based upon parameters passed.
.. versionchanged:: 0.9.0
The ``state`` parameter now accepts 'all' in addition to 'open'
and 'closed'.
:param int milestone: (optional), 'none', or '*'
:param str state: (optional), accepted values: ('all', 'open',
'closed')
:param str assignee: (optional), 'none', '*', or login name
:param str mentioned: (optional), user's login name
:param str labels: (optional), comma-separated list of labels, e.g.
'bug,ui,@high'
:param sort: (optional), accepted values:
('created', 'updated', 'comments', 'created')
:param str direction: (optional), accepted values: ('asc', 'desc')
:param since: (optional), Only issues after this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string, e.g., 2012-05-20T23:10:27Z
:type since: datetime or string
:param int number: (optional), Number of issues to return.
By default all issues are returned
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Issue <github3.issues.issue.Issue>`\ s
"""
url = self._build_url('issues', base_url=self._api)
params = {'assignee': assignee, 'mentioned': mentioned}
if milestone in ('*', 'none') or isinstance(milestone, int):
params['milestone'] = milestone
self._remove_none(params)
params.update(
issue_params(None, state, labels, sort, direction,
since)
)
return self._iter(int(number), url, Issue, params, etag)
|
python
|
def iter_issues(self,
milestone=None,
state=None,
assignee=None,
mentioned=None,
labels=None,
sort=None,
direction=None,
since=None,
number=-1,
etag=None):
"""Iterate over issues on this repo based upon parameters passed.
.. versionchanged:: 0.9.0
The ``state`` parameter now accepts 'all' in addition to 'open'
and 'closed'.
:param int milestone: (optional), 'none', or '*'
:param str state: (optional), accepted values: ('all', 'open',
'closed')
:param str assignee: (optional), 'none', '*', or login name
:param str mentioned: (optional), user's login name
:param str labels: (optional), comma-separated list of labels, e.g.
'bug,ui,@high'
:param sort: (optional), accepted values:
('created', 'updated', 'comments', 'created')
:param str direction: (optional), accepted values: ('asc', 'desc')
:param since: (optional), Only issues after this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string, e.g., 2012-05-20T23:10:27Z
:type since: datetime or string
:param int number: (optional), Number of issues to return.
By default all issues are returned
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Issue <github3.issues.issue.Issue>`\ s
"""
url = self._build_url('issues', base_url=self._api)
params = {'assignee': assignee, 'mentioned': mentioned}
if milestone in ('*', 'none') or isinstance(milestone, int):
params['milestone'] = milestone
self._remove_none(params)
params.update(
issue_params(None, state, labels, sort, direction,
since)
)
return self._iter(int(number), url, Issue, params, etag)
|
[
"def",
"iter_issues",
"(",
"self",
",",
"milestone",
"=",
"None",
",",
"state",
"=",
"None",
",",
"assignee",
"=",
"None",
",",
"mentioned",
"=",
"None",
",",
"labels",
"=",
"None",
",",
"sort",
"=",
"None",
",",
"direction",
"=",
"None",
",",
"since",
"=",
"None",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'issues'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"params",
"=",
"{",
"'assignee'",
":",
"assignee",
",",
"'mentioned'",
":",
"mentioned",
"}",
"if",
"milestone",
"in",
"(",
"'*'",
",",
"'none'",
")",
"or",
"isinstance",
"(",
"milestone",
",",
"int",
")",
":",
"params",
"[",
"'milestone'",
"]",
"=",
"milestone",
"self",
".",
"_remove_none",
"(",
"params",
")",
"params",
".",
"update",
"(",
"issue_params",
"(",
"None",
",",
"state",
",",
"labels",
",",
"sort",
",",
"direction",
",",
"since",
")",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Issue",
",",
"params",
",",
"etag",
")"
] |
Iterate over issues on this repo based upon parameters passed.
.. versionchanged:: 0.9.0
The ``state`` parameter now accepts 'all' in addition to 'open'
and 'closed'.
:param int milestone: (optional), 'none', or '*'
:param str state: (optional), accepted values: ('all', 'open',
'closed')
:param str assignee: (optional), 'none', '*', or login name
:param str mentioned: (optional), user's login name
:param str labels: (optional), comma-separated list of labels, e.g.
'bug,ui,@high'
:param sort: (optional), accepted values:
('created', 'updated', 'comments', 'created')
:param str direction: (optional), accepted values: ('asc', 'desc')
:param since: (optional), Only issues after this date will
be returned. This can be a `datetime` or an `ISO8601` formatted
date string, e.g., 2012-05-20T23:10:27Z
:type since: datetime or string
:param int number: (optional), Number of issues to return.
By default all issues are returned
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Issue <github3.issues.issue.Issue>`\ s
|
[
"Iterate",
"over",
"issues",
"on",
"this",
"repo",
"based",
"upon",
"parameters",
"passed",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1312-L1361
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_issue_events
|
def iter_issue_events(self, number=-1, etag=None):
"""Iterates over issue events on this repository.
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`IssueEvent <github3.issues.event.IssueEvent>`\ s
"""
url = self._build_url('issues', 'events', base_url=self._api)
return self._iter(int(number), url, IssueEvent, etag=etag)
|
python
|
def iter_issue_events(self, number=-1, etag=None):
"""Iterates over issue events on this repository.
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`IssueEvent <github3.issues.event.IssueEvent>`\ s
"""
url = self._build_url('issues', 'events', base_url=self._api)
return self._iter(int(number), url, IssueEvent, etag=etag)
|
[
"def",
"iter_issue_events",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'issues'",
",",
"'events'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"IssueEvent",
",",
"etag",
"=",
"etag",
")"
] |
Iterates over issue events on this repository.
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`IssueEvent <github3.issues.event.IssueEvent>`\ s
|
[
"Iterates",
"over",
"issue",
"events",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1363-L1374
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_languages
|
def iter_languages(self, number=-1, etag=None):
"""Iterate over the programming languages used in the repository.
:param int number: (optional), number of languages to return. Default:
-1 returns all used languages
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of tuples
"""
url = self._build_url('languages', base_url=self._api)
return self._iter(int(number), url, tuple, etag=etag)
|
python
|
def iter_languages(self, number=-1, etag=None):
"""Iterate over the programming languages used in the repository.
:param int number: (optional), number of languages to return. Default:
-1 returns all used languages
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of tuples
"""
url = self._build_url('languages', base_url=self._api)
return self._iter(int(number), url, tuple, etag=etag)
|
[
"def",
"iter_languages",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'languages'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"tuple",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over the programming languages used in the repository.
:param int number: (optional), number of languages to return. Default:
-1 returns all used languages
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of tuples
|
[
"Iterate",
"over",
"the",
"programming",
"languages",
"used",
"in",
"the",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1401-L1411
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_milestones
|
def iter_milestones(self, state=None, sort=None, direction=None,
number=-1, etag=None):
"""Iterates over the milestones on this repository.
:param str state: (optional), state of the milestones, accepted
values: ('open', 'closed')
:param str sort: (optional), how to sort the milestones, accepted
values: ('due_date', 'completeness')
:param str direction: (optional), direction to sort the milestones,
accepted values: ('asc', 'desc')
:param int number: (optional), number of milestones to return.
Default: -1 returns all milestones
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Milestone <github3.issues.milestone.Milestone>`\ s
"""
url = self._build_url('milestones', base_url=self._api)
accepted = {'state': ('open', 'closed'),
'sort': ('due_date', 'completeness'),
'direction': ('asc', 'desc')}
params = {'state': state, 'sort': sort, 'direction': direction}
for (k, v) in list(params.items()):
if not (v and (v in accepted[k])): # e.g., '' or None
del params[k]
if not params:
params = None
return self._iter(int(number), url, Milestone, params, etag)
|
python
|
def iter_milestones(self, state=None, sort=None, direction=None,
number=-1, etag=None):
"""Iterates over the milestones on this repository.
:param str state: (optional), state of the milestones, accepted
values: ('open', 'closed')
:param str sort: (optional), how to sort the milestones, accepted
values: ('due_date', 'completeness')
:param str direction: (optional), direction to sort the milestones,
accepted values: ('asc', 'desc')
:param int number: (optional), number of milestones to return.
Default: -1 returns all milestones
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Milestone <github3.issues.milestone.Milestone>`\ s
"""
url = self._build_url('milestones', base_url=self._api)
accepted = {'state': ('open', 'closed'),
'sort': ('due_date', 'completeness'),
'direction': ('asc', 'desc')}
params = {'state': state, 'sort': sort, 'direction': direction}
for (k, v) in list(params.items()):
if not (v and (v in accepted[k])): # e.g., '' or None
del params[k]
if not params:
params = None
return self._iter(int(number), url, Milestone, params, etag)
|
[
"def",
"iter_milestones",
"(",
"self",
",",
"state",
"=",
"None",
",",
"sort",
"=",
"None",
",",
"direction",
"=",
"None",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'milestones'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"accepted",
"=",
"{",
"'state'",
":",
"(",
"'open'",
",",
"'closed'",
")",
",",
"'sort'",
":",
"(",
"'due_date'",
",",
"'completeness'",
")",
",",
"'direction'",
":",
"(",
"'asc'",
",",
"'desc'",
")",
"}",
"params",
"=",
"{",
"'state'",
":",
"state",
",",
"'sort'",
":",
"sort",
",",
"'direction'",
":",
"direction",
"}",
"for",
"(",
"k",
",",
"v",
")",
"in",
"list",
"(",
"params",
".",
"items",
"(",
")",
")",
":",
"if",
"not",
"(",
"v",
"and",
"(",
"v",
"in",
"accepted",
"[",
"k",
"]",
")",
")",
":",
"# e.g., '' or None",
"del",
"params",
"[",
"k",
"]",
"if",
"not",
"params",
":",
"params",
"=",
"None",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Milestone",
",",
"params",
",",
"etag",
")"
] |
Iterates over the milestones on this repository.
:param str state: (optional), state of the milestones, accepted
values: ('open', 'closed')
:param str sort: (optional), how to sort the milestones, accepted
values: ('due_date', 'completeness')
:param str direction: (optional), direction to sort the milestones,
accepted values: ('asc', 'desc')
:param int number: (optional), number of milestones to return.
Default: -1 returns all milestones
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Milestone <github3.issues.milestone.Milestone>`\ s
|
[
"Iterates",
"over",
"the",
"milestones",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1413-L1440
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_network_events
|
def iter_network_events(self, number=-1, etag=None):
"""Iterates over events on a network of repositories.
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Event <github3.events.Event>`\ s
"""
base = self._api.replace('repos', 'networks', 1)
url = self._build_url('events', base_url=base)
return self._iter(int(number), url, Event, etag)
|
python
|
def iter_network_events(self, number=-1, etag=None):
"""Iterates over events on a network of repositories.
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Event <github3.events.Event>`\ s
"""
base = self._api.replace('repos', 'networks', 1)
url = self._build_url('events', base_url=base)
return self._iter(int(number), url, Event, etag)
|
[
"def",
"iter_network_events",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"base",
"=",
"self",
".",
"_api",
".",
"replace",
"(",
"'repos'",
",",
"'networks'",
",",
"1",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'events'",
",",
"base_url",
"=",
"base",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Event",
",",
"etag",
")"
] |
Iterates over events on a network of repositories.
:param int number: (optional), number of events to return. Default: -1
returns all available events
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Event <github3.events.Event>`\ s
|
[
"Iterates",
"over",
"events",
"on",
"a",
"network",
"of",
"repositories",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1442-L1453
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_notifications
|
def iter_notifications(self, all=False, participating=False, since=None,
number=-1, etag=None):
"""Iterates over the notifications for this repository.
:param bool all: (optional), show all notifications, including ones
marked as read
:param bool participating: (optional), show only the notifications the
user is participating in directly
:param since: (optional), filters out any notifications updated
before the given time. This can be a `datetime` or an `ISO8601`
formatted date string, e.g., 2012-05-20T23:10:27Z
:type since: datetime or string
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Thread <github3.notifications.Thread>`
"""
url = self._build_url('notifications', base_url=self._api)
params = {
'all': all,
'participating': participating,
'since': timestamp_parameter(since)
}
for (k, v) in list(params.items()):
if not v:
del params[k]
return self._iter(int(number), url, Thread, params, etag)
|
python
|
def iter_notifications(self, all=False, participating=False, since=None,
number=-1, etag=None):
"""Iterates over the notifications for this repository.
:param bool all: (optional), show all notifications, including ones
marked as read
:param bool participating: (optional), show only the notifications the
user is participating in directly
:param since: (optional), filters out any notifications updated
before the given time. This can be a `datetime` or an `ISO8601`
formatted date string, e.g., 2012-05-20T23:10:27Z
:type since: datetime or string
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Thread <github3.notifications.Thread>`
"""
url = self._build_url('notifications', base_url=self._api)
params = {
'all': all,
'participating': participating,
'since': timestamp_parameter(since)
}
for (k, v) in list(params.items()):
if not v:
del params[k]
return self._iter(int(number), url, Thread, params, etag)
|
[
"def",
"iter_notifications",
"(",
"self",
",",
"all",
"=",
"False",
",",
"participating",
"=",
"False",
",",
"since",
"=",
"None",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'notifications'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"params",
"=",
"{",
"'all'",
":",
"all",
",",
"'participating'",
":",
"participating",
",",
"'since'",
":",
"timestamp_parameter",
"(",
"since",
")",
"}",
"for",
"(",
"k",
",",
"v",
")",
"in",
"list",
"(",
"params",
".",
"items",
"(",
")",
")",
":",
"if",
"not",
"v",
":",
"del",
"params",
"[",
"k",
"]",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Thread",
",",
"params",
",",
"etag",
")"
] |
Iterates over the notifications for this repository.
:param bool all: (optional), show all notifications, including ones
marked as read
:param bool participating: (optional), show only the notifications the
user is participating in directly
:param since: (optional), filters out any notifications updated
before the given time. This can be a `datetime` or an `ISO8601`
formatted date string, e.g., 2012-05-20T23:10:27Z
:type since: datetime or string
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Thread <github3.notifications.Thread>`
|
[
"Iterates",
"over",
"the",
"notifications",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1456-L1481
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_pages_builds
|
def iter_pages_builds(self, number=-1, etag=None):
"""Iterate over pages builds of this repository.
:returns: generator of :class:`PagesBuild
<github3.repos.pages.PagesBuild>`
"""
url = self._build_url('pages', 'builds', base_url=self._api)
return self._iter(int(number), url, PagesBuild, etag=etag)
|
python
|
def iter_pages_builds(self, number=-1, etag=None):
"""Iterate over pages builds of this repository.
:returns: generator of :class:`PagesBuild
<github3.repos.pages.PagesBuild>`
"""
url = self._build_url('pages', 'builds', base_url=self._api)
return self._iter(int(number), url, PagesBuild, etag=etag)
|
[
"def",
"iter_pages_builds",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'pages'",
",",
"'builds'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"PagesBuild",
",",
"etag",
"=",
"etag",
")"
] |
Iterate over pages builds of this repository.
:returns: generator of :class:`PagesBuild
<github3.repos.pages.PagesBuild>`
|
[
"Iterate",
"over",
"pages",
"builds",
"of",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1484-L1491
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_pulls
|
def iter_pulls(self, state=None, head=None, base=None, sort='created',
direction='desc', number=-1, etag=None):
"""List pull requests on repository.
.. versionchanged:: 0.9.0
- The ``state`` parameter now accepts 'all' in addition to 'open'
and 'closed'.
- The ``sort`` parameter was added.
- The ``direction`` parameter was added.
:param str state: (optional), accepted values: ('all', 'open',
'closed')
:param str head: (optional), filters pulls by head user and branch
name in the format ``user:ref-name``, e.g., ``seveas:debian``
:param str base: (optional), filter pulls by base branch name.
Example: ``develop``.
:param str sort: (optional), Sort pull requests by ``created``,
``updated``, ``popularity``, ``long-running``. Default: 'created'
:param str direction: (optional), Choose the direction to list pull
requests. Accepted values: ('desc', 'asc'). Default: 'desc'
:param int number: (optional), number of pulls to return. Default: -1
returns all available pull requests
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`PullRequest <github3.pulls.PullRequest>`\ s
"""
url = self._build_url('pulls', base_url=self._api)
params = {}
if state and state.lower() in ('all', 'open', 'closed'):
params['state'] = state.lower()
params.update(head=head, base=base, sort=sort, direction=direction)
self._remove_none(params)
return self._iter(int(number), url, PullRequest, params, etag)
|
python
|
def iter_pulls(self, state=None, head=None, base=None, sort='created',
direction='desc', number=-1, etag=None):
"""List pull requests on repository.
.. versionchanged:: 0.9.0
- The ``state`` parameter now accepts 'all' in addition to 'open'
and 'closed'.
- The ``sort`` parameter was added.
- The ``direction`` parameter was added.
:param str state: (optional), accepted values: ('all', 'open',
'closed')
:param str head: (optional), filters pulls by head user and branch
name in the format ``user:ref-name``, e.g., ``seveas:debian``
:param str base: (optional), filter pulls by base branch name.
Example: ``develop``.
:param str sort: (optional), Sort pull requests by ``created``,
``updated``, ``popularity``, ``long-running``. Default: 'created'
:param str direction: (optional), Choose the direction to list pull
requests. Accepted values: ('desc', 'asc'). Default: 'desc'
:param int number: (optional), number of pulls to return. Default: -1
returns all available pull requests
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`PullRequest <github3.pulls.PullRequest>`\ s
"""
url = self._build_url('pulls', base_url=self._api)
params = {}
if state and state.lower() in ('all', 'open', 'closed'):
params['state'] = state.lower()
params.update(head=head, base=base, sort=sort, direction=direction)
self._remove_none(params)
return self._iter(int(number), url, PullRequest, params, etag)
|
[
"def",
"iter_pulls",
"(",
"self",
",",
"state",
"=",
"None",
",",
"head",
"=",
"None",
",",
"base",
"=",
"None",
",",
"sort",
"=",
"'created'",
",",
"direction",
"=",
"'desc'",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'pulls'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"params",
"=",
"{",
"}",
"if",
"state",
"and",
"state",
".",
"lower",
"(",
")",
"in",
"(",
"'all'",
",",
"'open'",
",",
"'closed'",
")",
":",
"params",
"[",
"'state'",
"]",
"=",
"state",
".",
"lower",
"(",
")",
"params",
".",
"update",
"(",
"head",
"=",
"head",
",",
"base",
"=",
"base",
",",
"sort",
"=",
"sort",
",",
"direction",
"=",
"direction",
")",
"self",
".",
"_remove_none",
"(",
"params",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"PullRequest",
",",
"params",
",",
"etag",
")"
] |
List pull requests on repository.
.. versionchanged:: 0.9.0
- The ``state`` parameter now accepts 'all' in addition to 'open'
and 'closed'.
- The ``sort`` parameter was added.
- The ``direction`` parameter was added.
:param str state: (optional), accepted values: ('all', 'open',
'closed')
:param str head: (optional), filters pulls by head user and branch
name in the format ``user:ref-name``, e.g., ``seveas:debian``
:param str base: (optional), filter pulls by base branch name.
Example: ``develop``.
:param str sort: (optional), Sort pull requests by ``created``,
``updated``, ``popularity``, ``long-running``. Default: 'created'
:param str direction: (optional), Choose the direction to list pull
requests. Accepted values: ('desc', 'asc'). Default: 'desc'
:param int number: (optional), number of pulls to return. Default: -1
returns all available pull requests
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`PullRequest <github3.pulls.PullRequest>`\ s
|
[
"List",
"pull",
"requests",
"on",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1493-L1529
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_refs
|
def iter_refs(self, subspace='', number=-1, etag=None):
"""Iterates over references for this repository.
:param str subspace: (optional), e.g. 'tags', 'stashes', 'notes'
:param int number: (optional), number of refs to return. Default: -1
returns all available refs
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Reference <github3.git.Reference>`\ s
"""
if subspace:
args = ('git', 'refs', subspace)
else:
args = ('git', 'refs')
url = self._build_url(*args, base_url=self._api)
return self._iter(int(number), url, Reference, etag=etag)
|
python
|
def iter_refs(self, subspace='', number=-1, etag=None):
"""Iterates over references for this repository.
:param str subspace: (optional), e.g. 'tags', 'stashes', 'notes'
:param int number: (optional), number of refs to return. Default: -1
returns all available refs
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Reference <github3.git.Reference>`\ s
"""
if subspace:
args = ('git', 'refs', subspace)
else:
args = ('git', 'refs')
url = self._build_url(*args, base_url=self._api)
return self._iter(int(number), url, Reference, etag=etag)
|
[
"def",
"iter_refs",
"(",
"self",
",",
"subspace",
"=",
"''",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"if",
"subspace",
":",
"args",
"=",
"(",
"'git'",
",",
"'refs'",
",",
"subspace",
")",
"else",
":",
"args",
"=",
"(",
"'git'",
",",
"'refs'",
")",
"url",
"=",
"self",
".",
"_build_url",
"(",
"*",
"args",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Reference",
",",
"etag",
"=",
"etag",
")"
] |
Iterates over references for this repository.
:param str subspace: (optional), e.g. 'tags', 'stashes', 'notes'
:param int number: (optional), number of refs to return. Default: -1
returns all available refs
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Reference <github3.git.Reference>`\ s
|
[
"Iterates",
"over",
"references",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1531-L1546
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_releases
|
def iter_releases(self, number=-1, etag=None):
"""Iterates over releases for this repository.
:param int number: (optional), number of refs to return. Default: -1
returns all available refs
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Release <github3.repos.release.Release>`\ s
"""
url = self._build_url('releases', base_url=self._api)
iterator = self._iter(int(number), url, Release, etag=etag)
iterator.headers.update(Release.CUSTOM_HEADERS)
return iterator
|
python
|
def iter_releases(self, number=-1, etag=None):
"""Iterates over releases for this repository.
:param int number: (optional), number of refs to return. Default: -1
returns all available refs
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Release <github3.repos.release.Release>`\ s
"""
url = self._build_url('releases', base_url=self._api)
iterator = self._iter(int(number), url, Release, etag=etag)
iterator.headers.update(Release.CUSTOM_HEADERS)
return iterator
|
[
"def",
"iter_releases",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'releases'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"iterator",
"=",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Release",
",",
"etag",
"=",
"etag",
")",
"iterator",
".",
"headers",
".",
"update",
"(",
"Release",
".",
"CUSTOM_HEADERS",
")",
"return",
"iterator"
] |
Iterates over releases for this repository.
:param int number: (optional), number of refs to return. Default: -1
returns all available refs
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of
:class:`Release <github3.repos.release.Release>`\ s
|
[
"Iterates",
"over",
"releases",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1548-L1561
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_statuses
|
def iter_statuses(self, sha, number=-1, etag=None):
"""Iterates over the statuses for a specific SHA.
:param str sha: SHA of the commit to list the statuses of
:param int number: (optional), return up to number statuses. Default:
-1 returns all available statuses.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Status <github3.repos.status.Status>`
"""
url = ''
if sha:
url = self._build_url('statuses', sha, base_url=self._api)
return self._iter(int(number), url, Status, etag=etag)
|
python
|
def iter_statuses(self, sha, number=-1, etag=None):
"""Iterates over the statuses for a specific SHA.
:param str sha: SHA of the commit to list the statuses of
:param int number: (optional), return up to number statuses. Default:
-1 returns all available statuses.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Status <github3.repos.status.Status>`
"""
url = ''
if sha:
url = self._build_url('statuses', sha, base_url=self._api)
return self._iter(int(number), url, Status, etag=etag)
|
[
"def",
"iter_statuses",
"(",
"self",
",",
"sha",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"''",
"if",
"sha",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'statuses'",
",",
"sha",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"Status",
",",
"etag",
"=",
"etag",
")"
] |
Iterates over the statuses for a specific SHA.
:param str sha: SHA of the commit to list the statuses of
:param int number: (optional), return up to number statuses. Default:
-1 returns all available statuses.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Status <github3.repos.status.Status>`
|
[
"Iterates",
"over",
"the",
"statuses",
"for",
"a",
"specific",
"SHA",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1587-L1600
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.iter_tags
|
def iter_tags(self, number=-1, etag=None):
"""Iterates over tags on this repository.
:param int number: (optional), return up to at most number tags.
Default: -1 returns all available tags.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`RepoTag <github3.repos.tag.RepoTag>`\ s
"""
url = self._build_url('tags', base_url=self._api)
return self._iter(int(number), url, RepoTag, etag=etag)
|
python
|
def iter_tags(self, number=-1, etag=None):
"""Iterates over tags on this repository.
:param int number: (optional), return up to at most number tags.
Default: -1 returns all available tags.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`RepoTag <github3.repos.tag.RepoTag>`\ s
"""
url = self._build_url('tags', base_url=self._api)
return self._iter(int(number), url, RepoTag, etag=etag)
|
[
"def",
"iter_tags",
"(",
"self",
",",
"number",
"=",
"-",
"1",
",",
"etag",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'tags'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"return",
"self",
".",
"_iter",
"(",
"int",
"(",
"number",
")",
",",
"url",
",",
"RepoTag",
",",
"etag",
"=",
"etag",
")"
] |
Iterates over tags on this repository.
:param int number: (optional), return up to at most number tags.
Default: -1 returns all available tags.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`RepoTag <github3.repos.tag.RepoTag>`\ s
|
[
"Iterates",
"over",
"tags",
"on",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1602-L1612
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.mark_notifications
|
def mark_notifications(self, last_read=''):
"""Mark all notifications in this repository as read.
:param str last_read: (optional), Describes the last point that
notifications were checked. Anything updated since this time will
not be updated. Default: Now. Expected in ISO 8601 format:
``YYYY-MM-DDTHH:MM:SSZ``. Example: "2012-10-09T23:39:01Z".
:returns: bool
"""
url = self._build_url('notifications', base_url=self._api)
mark = {'read': True}
if last_read:
mark['last_read_at'] = last_read
return self._boolean(self._put(url, data=dumps(mark)),
205, 404)
|
python
|
def mark_notifications(self, last_read=''):
"""Mark all notifications in this repository as read.
:param str last_read: (optional), Describes the last point that
notifications were checked. Anything updated since this time will
not be updated. Default: Now. Expected in ISO 8601 format:
``YYYY-MM-DDTHH:MM:SSZ``. Example: "2012-10-09T23:39:01Z".
:returns: bool
"""
url = self._build_url('notifications', base_url=self._api)
mark = {'read': True}
if last_read:
mark['last_read_at'] = last_read
return self._boolean(self._put(url, data=dumps(mark)),
205, 404)
|
[
"def",
"mark_notifications",
"(",
"self",
",",
"last_read",
"=",
"''",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'notifications'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"mark",
"=",
"{",
"'read'",
":",
"True",
"}",
"if",
"last_read",
":",
"mark",
"[",
"'last_read_at'",
"]",
"=",
"last_read",
"return",
"self",
".",
"_boolean",
"(",
"self",
".",
"_put",
"(",
"url",
",",
"data",
"=",
"dumps",
"(",
"mark",
")",
")",
",",
"205",
",",
"404",
")"
] |
Mark all notifications in this repository as read.
:param str last_read: (optional), Describes the last point that
notifications were checked. Anything updated since this time will
not be updated. Default: Now. Expected in ISO 8601 format:
``YYYY-MM-DDTHH:MM:SSZ``. Example: "2012-10-09T23:39:01Z".
:returns: bool
|
[
"Mark",
"all",
"notifications",
"in",
"this",
"repository",
"as",
"read",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1629-L1643
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.merge
|
def merge(self, base, head, message=''):
"""Perform a merge from ``head`` into ``base``.
:param str base: (required), where you're merging into
:param str head: (required), where you're merging from
:param str message: (optional), message to be used for the commit
:returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>`
"""
url = self._build_url('merges', base_url=self._api)
data = {'base': base, 'head': head}
if message:
data['commit_message'] = message
json = self._json(self._post(url, data=data), 201)
return RepoCommit(json, self) if json else None
|
python
|
def merge(self, base, head, message=''):
"""Perform a merge from ``head`` into ``base``.
:param str base: (required), where you're merging into
:param str head: (required), where you're merging from
:param str message: (optional), message to be used for the commit
:returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>`
"""
url = self._build_url('merges', base_url=self._api)
data = {'base': base, 'head': head}
if message:
data['commit_message'] = message
json = self._json(self._post(url, data=data), 201)
return RepoCommit(json, self) if json else None
|
[
"def",
"merge",
"(",
"self",
",",
"base",
",",
"head",
",",
"message",
"=",
"''",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'merges'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"data",
"=",
"{",
"'base'",
":",
"base",
",",
"'head'",
":",
"head",
"}",
"if",
"message",
":",
"data",
"[",
"'commit_message'",
"]",
"=",
"message",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_post",
"(",
"url",
",",
"data",
"=",
"data",
")",
",",
"201",
")",
"return",
"RepoCommit",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Perform a merge from ``head`` into ``base``.
:param str base: (required), where you're merging into
:param str head: (required), where you're merging from
:param str message: (optional), message to be used for the commit
:returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>`
|
[
"Perform",
"a",
"merge",
"from",
"head",
"into",
"base",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1646-L1659
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.milestone
|
def milestone(self, number):
"""Get the milestone indicated by ``number``.
:param int number: (required), unique id number of the milestone
:returns: :class:`Milestone <github3.issues.milestone.Milestone>`
"""
json = None
if int(number) > 0:
url = self._build_url('milestones', str(number),
base_url=self._api)
json = self._json(self._get(url), 200)
return Milestone(json, self) if json else None
|
python
|
def milestone(self, number):
"""Get the milestone indicated by ``number``.
:param int number: (required), unique id number of the milestone
:returns: :class:`Milestone <github3.issues.milestone.Milestone>`
"""
json = None
if int(number) > 0:
url = self._build_url('milestones', str(number),
base_url=self._api)
json = self._json(self._get(url), 200)
return Milestone(json, self) if json else None
|
[
"def",
"milestone",
"(",
"self",
",",
"number",
")",
":",
"json",
"=",
"None",
"if",
"int",
"(",
"number",
")",
">",
"0",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'milestones'",
",",
"str",
"(",
"number",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Milestone",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the milestone indicated by ``number``.
:param int number: (required), unique id number of the milestone
:returns: :class:`Milestone <github3.issues.milestone.Milestone>`
|
[
"Get",
"the",
"milestone",
"indicated",
"by",
"number",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1661-L1672
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.pages
|
def pages(self):
"""Get information about this repository's pages site.
:returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>`
"""
url = self._build_url('pages', base_url=self._api)
json = self._json(self._get(url), 200)
return PagesInfo(json) if json else None
|
python
|
def pages(self):
"""Get information about this repository's pages site.
:returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>`
"""
url = self._build_url('pages', base_url=self._api)
json = self._json(self._get(url), 200)
return PagesInfo(json) if json else None
|
[
"def",
"pages",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'pages'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"PagesInfo",
"(",
"json",
")",
"if",
"json",
"else",
"None"
] |
Get information about this repository's pages site.
:returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>`
|
[
"Get",
"information",
"about",
"this",
"repository",
"s",
"pages",
"site",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1675-L1682
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.pull_request
|
def pull_request(self, number):
"""Get the pull request indicated by ``number``.
:param int number: (required), number of the pull request.
:returns: :class:`PullRequest <github3.pulls.PullRequest>`
"""
json = None
if int(number) > 0:
url = self._build_url('pulls', str(number), base_url=self._api)
json = self._json(self._get(url), 200)
return PullRequest(json, self) if json else None
|
python
|
def pull_request(self, number):
"""Get the pull request indicated by ``number``.
:param int number: (required), number of the pull request.
:returns: :class:`PullRequest <github3.pulls.PullRequest>`
"""
json = None
if int(number) > 0:
url = self._build_url('pulls', str(number), base_url=self._api)
json = self._json(self._get(url), 200)
return PullRequest(json, self) if json else None
|
[
"def",
"pull_request",
"(",
"self",
",",
"number",
")",
":",
"json",
"=",
"None",
"if",
"int",
"(",
"number",
")",
">",
"0",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'pulls'",
",",
"str",
"(",
"number",
")",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"PullRequest",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the pull request indicated by ``number``.
:param int number: (required), number of the pull request.
:returns: :class:`PullRequest <github3.pulls.PullRequest>`
|
[
"Get",
"the",
"pull",
"request",
"indicated",
"by",
"number",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1684-L1694
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.readme
|
def readme(self):
"""Get the README for this repository.
:returns: :class:`Contents <github3.repos.contents.Contents>`
"""
url = self._build_url('readme', base_url=self._api)
json = self._json(self._get(url), 200)
return Contents(json, self) if json else None
|
python
|
def readme(self):
"""Get the README for this repository.
:returns: :class:`Contents <github3.repos.contents.Contents>`
"""
url = self._build_url('readme', base_url=self._api)
json = self._json(self._get(url), 200)
return Contents(json, self) if json else None
|
[
"def",
"readme",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'readme'",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Contents",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get the README for this repository.
:returns: :class:`Contents <github3.repos.contents.Contents>`
|
[
"Get",
"the",
"README",
"for",
"this",
"repository",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1696-L1703
|
kislyuk/aegea
|
aegea/packages/github3/repos/repo.py
|
Repository.ref
|
def ref(self, ref):
"""Get a reference pointed to by ``ref``.
The most common will be branches and tags. For a branch, you must
specify 'heads/branchname' and for a tag, 'tags/tagname'. Essentially,
the system should return any reference you provide it in the namespace,
including notes and stashes (provided they exist on the server).
:param str ref: (required)
:returns: :class:`Reference <github3.git.Reference>`
"""
json = None
if ref:
url = self._build_url('git', 'refs', ref, base_url=self._api)
json = self._json(self._get(url), 200)
return Reference(json, self) if json else None
|
python
|
def ref(self, ref):
"""Get a reference pointed to by ``ref``.
The most common will be branches and tags. For a branch, you must
specify 'heads/branchname' and for a tag, 'tags/tagname'. Essentially,
the system should return any reference you provide it in the namespace,
including notes and stashes (provided they exist on the server).
:param str ref: (required)
:returns: :class:`Reference <github3.git.Reference>`
"""
json = None
if ref:
url = self._build_url('git', 'refs', ref, base_url=self._api)
json = self._json(self._get(url), 200)
return Reference(json, self) if json else None
|
[
"def",
"ref",
"(",
"self",
",",
"ref",
")",
":",
"json",
"=",
"None",
"if",
"ref",
":",
"url",
"=",
"self",
".",
"_build_url",
"(",
"'git'",
",",
"'refs'",
",",
"ref",
",",
"base_url",
"=",
"self",
".",
"_api",
")",
"json",
"=",
"self",
".",
"_json",
"(",
"self",
".",
"_get",
"(",
"url",
")",
",",
"200",
")",
"return",
"Reference",
"(",
"json",
",",
"self",
")",
"if",
"json",
"else",
"None"
] |
Get a reference pointed to by ``ref``.
The most common will be branches and tags. For a branch, you must
specify 'heads/branchname' and for a tag, 'tags/tagname'. Essentially,
the system should return any reference you provide it in the namespace,
including notes and stashes (provided they exist on the server).
:param str ref: (required)
:returns: :class:`Reference <github3.git.Reference>`
|
[
"Get",
"a",
"reference",
"pointed",
"to",
"by",
"ref",
"."
] |
train
|
https://github.com/kislyuk/aegea/blob/94957e9dba036eae3052e2662c208b259c08399a/aegea/packages/github3/repos/repo.py#L1705-L1720
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.