Mercurial > repos > bcclaywell > argo_navis
diff venv/lib/python2.7/site-packages/github/Gist.py @ 0:d67268158946 draft
planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b
author | bcclaywell |
---|---|
date | Mon, 12 Oct 2015 17:43:33 -0400 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/venv/lib/python2.7/site-packages/github/Gist.py Mon Oct 12 17:43:33 2015 -0400 @@ -0,0 +1,368 @@ +# -*- 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._comments.value + + @property + def comments_url(self): + """ + :type: string + """ + self._completeIfNotSet(self._comments_url) + return self._comments_url.value + + @property + def commits_url(self): + """ + :type: string + """ + self._completeIfNotSet(self._commits_url) + return self._commits_url.value + + @property + def created_at(self): + """ + :type: datetime.datetime + """ + self._completeIfNotSet(self._created_at) + return self._created_at.value + + @property + def description(self): + """ + :type: string + """ + self._completeIfNotSet(self._description) + return self._description.value + + @property + def files(self): + """ + :type: dict of string to :class:`github.GistFile.GistFile` + """ + self._completeIfNotSet(self._files) + return self._files.value + + @property + def fork_of(self): + """ + :type: :class:`github.Gist.Gist` + """ + self._completeIfNotSet(self._fork_of) + return self._fork_of.value + + @property + def forks(self): + """ + :type: list of :class:`github.Gist.Gist` + """ + self._completeIfNotSet(self._forks) + return self._forks.value + + @property + def forks_url(self): + """ + :type: string + """ + self._completeIfNotSet(self._forks_url) + return self._forks_url.value + + @property + def git_pull_url(self): + """ + :type: string + """ + self._completeIfNotSet(self._git_pull_url) + return self._git_pull_url.value + + @property + def git_push_url(self): + """ + :type: string + """ + self._completeIfNotSet(self._git_push_url) + return self._git_push_url.value + + @property + def history(self): + """ + :type: list of :class:`github.GistHistoryState.GistHistoryState` + """ + self._completeIfNotSet(self._history) + return self._history.value + + @property + def html_url(self): + """ + :type: string + """ + self._completeIfNotSet(self._html_url) + return self._html_url.value + + @property + def id(self): + """ + :type: string + """ + self._completeIfNotSet(self._id) + return self._id.value + + @property + def owner(self): + """ + :type: :class:`github.NamedUser.NamedUser` + """ + self._completeIfNotSet(self._owner) + return self._owner.value + + @property + def public(self): + """ + :type: bool + """ + self._completeIfNotSet(self._public) + return self._public.value + + @property + def updated_at(self): + """ + :type: datetime.datetime + """ + self._completeIfNotSet(self._updated_at) + return self._updated_at.value + + @property + def url(self): + """ + :type: string + """ + self._completeIfNotSet(self._url) + return self._url.value + + @property + def user(self): + """ + :type: :class:`github.NamedUser.NamedUser` + """ + self._completeIfNotSet(self._user) + return self._user.value + + 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._owner = 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 + self._comments = self._makeIntAttribute(attributes["comments"]) + if "comments_url" in attributes: # pragma no branch + self._comments_url = self._makeStringAttribute(attributes["comments_url"]) + if "commits_url" in attributes: # pragma no branch + self._commits_url = self._makeStringAttribute(attributes["commits_url"]) + if "created_at" in attributes: # pragma no branch + self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) + if "description" in attributes: # pragma no branch + self._description = self._makeStringAttribute(attributes["description"]) + if "files" in attributes: # pragma no branch + self._files = self._makeDictOfStringsToClassesAttribute(github.GistFile.GistFile, attributes["files"]) + if "fork_of" in attributes: # pragma no branch + self._fork_of = self._makeClassAttribute(Gist, attributes["fork_of"]) + if "forks" in attributes: # pragma no branch + self._forks = self._makeListOfClassesAttribute(Gist, attributes["forks"]) + if "forks_url" in attributes: # pragma no branch + self._forks_url = self._makeStringAttribute(attributes["forks_url"]) + if "git_pull_url" in attributes: # pragma no branch + self._git_pull_url = self._makeStringAttribute(attributes["git_pull_url"]) + if "git_push_url" in attributes: # pragma no branch + self._git_push_url = self._makeStringAttribute(attributes["git_push_url"]) + if "history" in attributes: # pragma no branch + self._history = self._makeListOfClassesAttribute(github.GistHistoryState.GistHistoryState, attributes["history"]) + if "html_url" in attributes: # pragma no branch + self._html_url = self._makeStringAttribute(attributes["html_url"]) + if "id" in attributes: # pragma no branch + self._id = self._makeStringAttribute(attributes["id"]) + if "owner" in attributes: # pragma no branch + self._owner = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["owner"]) + if "public" in attributes: # pragma no branch + self._public = self._makeBoolAttribute(attributes["public"]) + if "updated_at" in attributes: # pragma no branch + self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"]) + if "url" in attributes: # pragma no branch + self._url = self._makeStringAttribute(attributes["url"]) + if "user" in attributes: # pragma no branch + self._user = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["user"])