# -*- coding: utf-8 -*- # Copyright 2012 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 . import github.GithubObject import github.NamedUser class CommitComment(github.GithubObject.CompletableGithubObject): """ This class represents CommitComments as returned for example by http://developer.github.com/v3/todo """ @property def body(self): """ :type: string """ self._completeIfNotSet(self._body) return self._NoneIfNotSet(self._body) @property def commit_id(self): """ :type: string """ self._completeIfNotSet(self._commit_id) return self._NoneIfNotSet(self._commit_id) @property def created_at(self): """ :type: datetime.datetime """ self._completeIfNotSet(self._created_at) return self._NoneIfNotSet(self._created_at) @property def html_url(self): """ :type: string """ self._completeIfNotSet(self._html_url) return self._NoneIfNotSet(self._html_url) @property def id(self): """ :type: integer """ self._completeIfNotSet(self._id) return self._NoneIfNotSet(self._id) @property def line(self): """ :type: integer """ self._completeIfNotSet(self._line) return self._NoneIfNotSet(self._line) @property def path(self): """ :type: string """ self._completeIfNotSet(self._path) return self._NoneIfNotSet(self._path) @property def position(self): """ :type: integer """ self._completeIfNotSet(self._position) return self._NoneIfNotSet(self._position) @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 delete(self): """ :calls: `DELETE /repos/:user/:repo/comments/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( "DELETE", self.url, None, None ) def edit(self, body): """ :calls: `PATCH /repos/:user/:repo/comments/:id `_ :param body: string :rtype: None """ assert isinstance(body, (str, unicode)), body post_parameters = { "body": body, } headers, data = self._requester.requestJsonAndCheck( "PATCH", self.url, None, post_parameters ) self._useAttributes(data) def _initAttributes(self): self._body = github.GithubObject.NotSet self._commit_id = github.GithubObject.NotSet self._created_at = github.GithubObject.NotSet self._html_url = github.GithubObject.NotSet self._id = github.GithubObject.NotSet self._line = github.GithubObject.NotSet self._path = github.GithubObject.NotSet self._position = github.GithubObject.NotSet self._updated_at = github.GithubObject.NotSet self._url = github.GithubObject.NotSet self._user = github.GithubObject.NotSet def _useAttributes(self, attributes): if "body" in attributes: # pragma no branch assert attributes["body"] is None or isinstance(attributes["body"], (str, unicode)), attributes["body"] self._body = attributes["body"] if "commit_id" in attributes: # pragma no branch assert attributes["commit_id"] is None or isinstance(attributes["commit_id"], (str, unicode)), attributes["commit_id"] self._commit_id = attributes["commit_id"] 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 "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"], (int, long)), attributes["id"] self._id = attributes["id"] if "line" in attributes: # pragma no branch assert attributes["line"] is None or isinstance(attributes["line"], (int, long)), attributes["line"] self._line = attributes["line"] if "path" in attributes: # pragma no branch assert attributes["path"] is None or isinstance(attributes["path"], (str, unicode)), attributes["path"] self._path = attributes["path"] if "position" in attributes: # pragma no branch assert attributes["position"] is None or isinstance(attributes["position"], (int, long)), attributes["position"] self._position = attributes["position"] 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, attributes["user"], completed=False)