mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
264 lines
10 KiB
Python
264 lines
10 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2012 Vincent Jacques
|
|
# vincent@vincent-jacques.net
|
|
|
|
# This file is part of PyGithub. http://vincent-jacques.net/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 GithubObject
|
|
import PaginatedList
|
|
|
|
import Gist
|
|
import GistComment
|
|
import NamedUser
|
|
import GistFile
|
|
import InputFileContent
|
|
import GistHistoryState
|
|
|
|
|
|
class Gist(GithubObject.GithubObject):
|
|
@property
|
|
def comments(self):
|
|
self._completeIfNotSet(self._comments)
|
|
return self._NoneIfNotSet(self._comments)
|
|
|
|
@property
|
|
def created_at(self):
|
|
self._completeIfNotSet(self._created_at)
|
|
return self._NoneIfNotSet(self._created_at)
|
|
|
|
@property
|
|
def description(self):
|
|
self._completeIfNotSet(self._description)
|
|
return self._NoneIfNotSet(self._description)
|
|
|
|
@property
|
|
def files(self):
|
|
self._completeIfNotSet(self._files)
|
|
return self._NoneIfNotSet(self._files)
|
|
|
|
@property
|
|
def fork_of(self):
|
|
self._completeIfNotSet(self._fork_of)
|
|
return self._NoneIfNotSet(self._fork_of)
|
|
|
|
@property
|
|
def forks(self):
|
|
self._completeIfNotSet(self._forks)
|
|
return self._NoneIfNotSet(self._forks)
|
|
|
|
@property
|
|
def git_pull_url(self):
|
|
self._completeIfNotSet(self._git_pull_url)
|
|
return self._NoneIfNotSet(self._git_pull_url)
|
|
|
|
@property
|
|
def git_push_url(self):
|
|
self._completeIfNotSet(self._git_push_url)
|
|
return self._NoneIfNotSet(self._git_push_url)
|
|
|
|
@property
|
|
def history(self):
|
|
self._completeIfNotSet(self._history)
|
|
return self._NoneIfNotSet(self._history)
|
|
|
|
@property
|
|
def html_url(self):
|
|
self._completeIfNotSet(self._html_url)
|
|
return self._NoneIfNotSet(self._html_url)
|
|
|
|
@property
|
|
def id(self):
|
|
self._completeIfNotSet(self._id)
|
|
return self._NoneIfNotSet(self._id)
|
|
|
|
@property
|
|
def public(self):
|
|
self._completeIfNotSet(self._public)
|
|
return self._NoneIfNotSet(self._public)
|
|
|
|
@property
|
|
def updated_at(self):
|
|
self._completeIfNotSet(self._updated_at)
|
|
return self._NoneIfNotSet(self._updated_at)
|
|
|
|
@property
|
|
def url(self):
|
|
self._completeIfNotSet(self._url)
|
|
return self._NoneIfNotSet(self._url)
|
|
|
|
@property
|
|
def user(self):
|
|
self._completeIfNotSet(self._user)
|
|
return self._NoneIfNotSet(self._user)
|
|
|
|
def create_comment(self, body):
|
|
assert isinstance(body, (str, unicode)), body
|
|
post_parameters = {
|
|
"body": body,
|
|
}
|
|
headers, data = self._requester.requestAndCheck(
|
|
"POST",
|
|
self.url + "/comments",
|
|
None,
|
|
post_parameters
|
|
)
|
|
return GistComment.GistComment(self._requester, data, completed=True)
|
|
|
|
def create_fork(self):
|
|
headers, data = self._requester.requestAndCheck(
|
|
"POST",
|
|
self.url + "/fork",
|
|
None,
|
|
None
|
|
)
|
|
return Gist(self._requester, data, completed=True)
|
|
|
|
def delete(self):
|
|
headers, data = self._requester.requestAndCheck(
|
|
"DELETE",
|
|
self.url,
|
|
None,
|
|
None
|
|
)
|
|
|
|
def edit(self, description=GithubObject.NotSet, files=GithubObject.NotSet):
|
|
assert description is GithubObject.NotSet or isinstance(description, (str, unicode)), description
|
|
assert files is GithubObject.NotSet or all(isinstance(element, InputFileContent.InputFileContent) for element in files.itervalues()), files
|
|
post_parameters = dict()
|
|
if description is not GithubObject.NotSet:
|
|
post_parameters["description"] = description
|
|
if files is not GithubObject.NotSet:
|
|
post_parameters["files"] = dict((key, value._identity) for key, value in files.iteritems())
|
|
headers, data = self._requester.requestAndCheck(
|
|
"PATCH",
|
|
self.url,
|
|
None,
|
|
post_parameters
|
|
)
|
|
self._useAttributes(data)
|
|
|
|
def get_comment(self, id):
|
|
assert isinstance(id, int), id
|
|
headers, data = self._requester.requestAndCheck(
|
|
"GET",
|
|
self.url + "/comments/" + str(id),
|
|
None,
|
|
None
|
|
)
|
|
return GistComment.GistComment(self._requester, data, completed=True)
|
|
|
|
def get_comments(self):
|
|
return PaginatedList.PaginatedList(
|
|
GistComment.GistComment,
|
|
self._requester,
|
|
self.url + "/comments",
|
|
None
|
|
)
|
|
|
|
def is_starred(self):
|
|
status, headers, data = self._requester.requestRaw(
|
|
"GET",
|
|
self.url + "/star",
|
|
None,
|
|
None
|
|
)
|
|
return status == 204
|
|
|
|
def reset_starred(self):
|
|
headers, data = self._requester.requestAndCheck(
|
|
"DELETE",
|
|
self.url + "/star",
|
|
None,
|
|
None
|
|
)
|
|
|
|
def set_starred(self):
|
|
headers, data = self._requester.requestAndCheck(
|
|
"PUT",
|
|
self.url + "/star",
|
|
None,
|
|
None
|
|
)
|
|
|
|
def _initAttributes(self):
|
|
self._comments = GithubObject.NotSet
|
|
self._created_at = GithubObject.NotSet
|
|
self._description = GithubObject.NotSet
|
|
self._files = GithubObject.NotSet
|
|
self._fork_of = GithubObject.NotSet
|
|
self._forks = GithubObject.NotSet
|
|
self._git_pull_url = GithubObject.NotSet
|
|
self._git_push_url = GithubObject.NotSet
|
|
self._history = GithubObject.NotSet
|
|
self._html_url = GithubObject.NotSet
|
|
self._id = GithubObject.NotSet
|
|
self._public = GithubObject.NotSet
|
|
self._updated_at = GithubObject.NotSet
|
|
self._url = GithubObject.NotSet
|
|
self._user = GithubObject.NotSet
|
|
|
|
def _useAttributes(self, attributes):
|
|
if "comments" in attributes: # pragma no branch
|
|
assert attributes["comments"] is None or isinstance(attributes["comments"], int), attributes["comments"]
|
|
self._comments = attributes["comments"]
|
|
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, GistFile.GistFile(self._requester, 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, 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, element, completed=False)
|
|
for element in attributes["forks"]
|
|
]
|
|
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 [
|
|
GistHistoryState.GistHistoryState(self._requester, 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 NamedUser.NamedUser(self._requester, attributes["user"], completed=False)
|