status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-08-31 19:01:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c0dae31a97ea83c21d6157ae8952b7f3e265dac4
PyGithub/github/Gist.py
T

385 lines
16 KiB
Python
Raw Blame History

# -*- coding: utf-8 -*-
############################ Copyrights and license ############################
# #
# Copyright 2012 Steve English <steve.english@navetas.com> #
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2012 Zearin <zearin@gonk.net> #
# Copyright 2013 AKFish <akfish@gmail.com> #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# #
# This file is part of PyGithub. http://jacquev6.github.com/PyGithub/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################
import github.GithubObject
import github.PaginatedList
import github.GistComment
import github.NamedUser
import github.GistFile
import github.GistHistoryState
class Gist(github.GithubObject.CompletableGithubObject):
"""
This class represents Gists as returned for example by http://developer.github.com/v3/todo
"""
@property
def comments(self):
"""
:type: integer
"""
self._completeIfNotSet(self._comments)
return self._NoneIfNotSet(self._comments)
@property
def comments_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._comments_url)
return self._NoneIfNotSet(self._comments_url)
@property
def commits_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._commits_url)
return self._NoneIfNotSet(self._commits_url)
@property
def created_at(self):
"""
:type: datetime.datetime
"""
self._completeIfNotSet(self._created_at)
return self._NoneIfNotSet(self._created_at)
@property
def description(self):
"""
:type: string
"""
self._completeIfNotSet(self._description)
return self._NoneIfNotSet(self._description)
@property
def files(self):
"""
:type: dict of string to :class:`github.GistFile.GistFile`
"""
self._completeIfNotSet(self._files)
return self._NoneIfNotSet(self._files)
@property
def fork_of(self):
"""
:type: :class:`github.Gist.Gist`
"""
self._completeIfNotSet(self._fork_of)
return self._NoneIfNotSet(self._fork_of)
@property
def forks(self):
"""
:type: list of :class:`github.Gist.Gist`
"""
self._completeIfNotSet(self._forks)
return self._NoneIfNotSet(self._forks)
@property
def forks_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._forks_url)
return self._NoneIfNotSet(self._forks_url)
@property
def git_pull_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._git_pull_url)
return self._NoneIfNotSet(self._git_pull_url)
@property
def git_push_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._git_push_url)
return self._NoneIfNotSet(self._git_push_url)
@property
def history(self):
"""
:type: list of :class:`github.GistHistoryState.GistHistoryState`
"""
self._completeIfNotSet(self._history)
return self._NoneIfNotSet(self._history)
@property
def html_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._html_url)
return self._NoneIfNotSet(self._html_url)
@property
def id(self):
"""
:type: string
"""
self._completeIfNotSet(self._id)
return self._NoneIfNotSet(self._id)
@property
def public(self):
"""
:type: bool
"""
self._completeIfNotSet(self._public)
return self._NoneIfNotSet(self._public)
@property
def updated_at(self):
"""
:type: datetime.datetime
"""
self._completeIfNotSet(self._updated_at)
return self._NoneIfNotSet(self._updated_at)
@property
def url(self):
"""
:type: string
"""
self._completeIfNotSet(self._url)
return self._NoneIfNotSet(self._url)
@property
def user(self):
"""
:type: :class:`github.NamedUser.NamedUser`
"""
self._completeIfNotSet(self._user)
return self._NoneIfNotSet(self._user)
def create_comment(self, body):
"""
:calls: `POST /gists/:gist_id/comments <http://developer.github.com/v3/gists/comments>`_
:param body: string
:rtype: :class:`github.GistComment.GistComment`
"""
assert isinstance(body, (str, unicode)), body
post_parameters = {
"body": body,
}
headers, data = self._requester.requestJsonAndCheck(
"POST",
self.url + "/comments",
input=post_parameters
)
return github.GistComment.GistComment(self._requester, headers, data, completed=True)
def create_fork(self):
"""
:calls: `POST /gists/:id/forks <http://developer.github.com/v3/gists>`_
:rtype: :class:`github.Gist.Gist`
"""
headers, data = self._requester.requestJsonAndCheck(
"POST",
self.url + "/forks"
)
return Gist(self._requester, headers, data, completed=True)
def delete(self):
"""
:calls: `DELETE /gists/:id <http://developer.github.com/v3/gists>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck(
"DELETE",
self.url
)
def edit(self, description=github.GithubObject.NotSet, files=github.GithubObject.NotSet):
"""
:calls: `PATCH /gists/:id <http://developer.github.com/v3/gists>`_
:param description: string
:param files: dict of string to :class:`github.InputFileContent.InputFileContent`
:rtype: None
"""
assert description is github.GithubObject.NotSet or isinstance(description, (str, unicode)), description
assert files is github.GithubObject.NotSet or all(element is None or isinstance(element, github.InputFileContent) for element in files.itervalues()), files
post_parameters = dict()
if description is not github.GithubObject.NotSet:
post_parameters["description"] = description
if files is not github.GithubObject.NotSet:
post_parameters["files"] = dict((key, None if value is None else value._identity) for key, value in files.iteritems())
headers, data = self._requester.requestJsonAndCheck(
"PATCH",
self.url,
input=post_parameters
)
self._useAttributes(data)
def get_comment(self, id):
"""
:calls: `GET /gists/:gist_id/comments/:id <http://developer.github.com/v3/gists/comments>`_
:param id: integer
:rtype: :class:`github.GistComment.GistComment`
"""
assert isinstance(id, (int, long)), id
headers, data = self._requester.requestJsonAndCheck(
"GET",
self.url + "/comments/" + str(id)
)
return github.GistComment.GistComment(self._requester, headers, data, completed=True)
def get_comments(self):
"""
:calls: `GET /gists/:gist_id/comments <http://developer.github.com/v3/gists/comments>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GistComment.GistComment`
"""
return github.PaginatedList.PaginatedList(
github.GistComment.GistComment,
self._requester,
self.url + "/comments",
None
)
def is_starred(self):
"""
:calls: `GET /gists/:id/star <http://developer.github.com/v3/gists>`_
:rtype: bool
"""
status, headers, data = self._requester.requestJson(
"GET",
self.url + "/star"
)
return status == 204
def reset_starred(self):
"""
:calls: `DELETE /gists/:id/star <http://developer.github.com/v3/gists>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck(
"DELETE",
self.url + "/star"
)
def set_starred(self):
"""
:calls: `PUT /gists/:id/star <http://developer.github.com/v3/gists>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck(
"PUT",
self.url + "/star"
)
def _initAttributes(self):
self._comments = github.GithubObject.NotSet
self._comments_url = github.GithubObject.NotSet
self._commits_url = github.GithubObject.NotSet
self._created_at = github.GithubObject.NotSet
self._description = github.GithubObject.NotSet
self._files = github.GithubObject.NotSet
self._fork_of = github.GithubObject.NotSet
self._forks = github.GithubObject.NotSet
self._forks_url = github.GithubObject.NotSet
self._git_pull_url = github.GithubObject.NotSet
self._git_push_url = github.GithubObject.NotSet
self._history = github.GithubObject.NotSet
self._html_url = github.GithubObject.NotSet
self._id = github.GithubObject.NotSet
self._public = github.GithubObject.NotSet
self._updated_at = github.GithubObject.NotSet
self._url = github.GithubObject.NotSet
self._user = github.GithubObject.NotSet
def _useAttributes(self, attributes):
if "comments" in attributes: # pragma no branch
assert attributes["comments"] is None or isinstance(attributes["comments"], (int, long)), attributes["comments"]
self._comments = attributes["comments"]
if "comments_url" in attributes: # pragma no branch
assert attributes["comments_url"] is None or isinstance(attributes["comments_url"], (str, unicode)), attributes["comments_url"]
self._comments_url = attributes["comments_url"]
if "commits_url" in attributes: # pragma no branch
assert attributes["commits_url"] is None or isinstance(attributes["commits_url"], (str, unicode)), attributes["commits_url"]
self._commits_url = attributes["commits_url"]
if "created_at" in attributes: # pragma no branch
assert attributes["created_at"] is None or isinstance(attributes["created_at"], (str, unicode)), attributes["created_at"]
self._created_at = self._parseDatetime(attributes["created_at"])
if "description" in attributes: # pragma no branch
assert attributes["description"] is None or isinstance(attributes["description"], (str, unicode)), attributes["description"]
self._description = attributes["description"]
if "files" in attributes: # pragma no branch
assert attributes["files"] is None or all(isinstance(element, dict) for element in attributes["files"].itervalues()), attributes["files"]
self._files = None if attributes["files"] is None else dict(
(key, github.GistFile.GistFile(self._requester, self._headers, element, completed=False))
for key, element in attributes["files"].iteritems()
)
if "fork_of" in attributes: # pragma no branch
assert attributes["fork_of"] is None or isinstance(attributes["fork_of"], dict), attributes["fork_of"]
self._fork_of = None if attributes["fork_of"] is None else Gist(self._requester, self._headers, attributes["fork_of"], completed=False)
if "forks" in attributes: # pragma no branch
assert attributes["forks"] is None or all(isinstance(element, dict) for element in attributes["forks"]), attributes["forks"]
self._forks = None if attributes["forks"] is None else [
Gist(self._requester, self._headers, element, completed=False)
for element in attributes["forks"]
]
if "forks_url" in attributes: # pragma no branch
assert attributes["forks_url"] is None or isinstance(attributes["forks_url"], (str, unicode)), attributes["forks_url"]
self._forks_url = attributes["forks_url"]
if "git_pull_url" in attributes: # pragma no branch
assert attributes["git_pull_url"] is None or isinstance(attributes["git_pull_url"], (str, unicode)), attributes["git_pull_url"]
self._git_pull_url = attributes["git_pull_url"]
if "git_push_url" in attributes: # pragma no branch
assert attributes["git_push_url"] is None or isinstance(attributes["git_push_url"], (str, unicode)), attributes["git_push_url"]
self._git_push_url = attributes["git_push_url"]
if "history" in attributes: # pragma no branch
assert attributes["history"] is None or all(isinstance(element, dict) for element in attributes["history"]), attributes["history"]
self._history = None if attributes["history"] is None else [
github.GistHistoryState.GistHistoryState(self._requester, self._headers, element, completed=False)
for element in attributes["history"]
]
if "html_url" in attributes: # pragma no branch
assert attributes["html_url"] is None or isinstance(attributes["html_url"], (str, unicode)), attributes["html_url"]
self._html_url = attributes["html_url"]
if "id" in attributes: # pragma no branch
assert attributes["id"] is None or isinstance(attributes["id"], (str, unicode)), attributes["id"]
self._id = attributes["id"]
if "public" in attributes: # pragma no branch
assert attributes["public"] is None or isinstance(attributes["public"], bool), attributes["public"]
self._public = attributes["public"]
if "updated_at" in attributes: # pragma no branch
assert attributes["updated_at"] is None or isinstance(attributes["updated_at"], (str, unicode)), attributes["updated_at"]
self._updated_at = self._parseDatetime(attributes["updated_at"])
if "url" in attributes: # pragma no branch
assert attributes["url"] is None or isinstance(attributes["url"], (str, unicode)), attributes["url"]
self._url = attributes["url"]
if "user" in attributes: # pragma no branch
assert attributes["user"] is None or isinstance(attributes["user"], dict), attributes["user"]
self._user = None if attributes["user"] is None else github.NamedUser.NamedUser(self._requester, self._headers, attributes["user"], completed=False)
Reference in New Issue View Git Blame Copy Permalink