############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2021 Mark Walker # # Copyright 2021 Steve Kowalik # # Copyright 2023 Enrico Minack # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Trim21 # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2025 Enrico Minack # # # # This file is part of PyGithub. # # http://pygithub.readthedocs.io/ # # # # 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 . # # # ################################################################################ from __future__ import annotations from datetime import datetime from typing import Any import github.GithubObject import github.NamedUser from github.GithubObject import Attribute, CompletableGithubObject, NotSet class GistComment(CompletableGithubObject): """ This class represents GistComments. The reference can be found here https://docs.github.com/en/rest/reference/gists#comments The OpenAPI schema can be found at - /components/schemas/gist-comment """ def _initAttributes(self) -> None: self._author_association: Attribute[str] = NotSet self._body: Attribute[str] = NotSet self._created_at: Attribute[datetime] = NotSet self._id: Attribute[int] = NotSet self._node_id: Attribute[str] = NotSet self._updated_at: Attribute[datetime] = NotSet self._url: Attribute[str] = NotSet self._user: Attribute[github.NamedUser.NamedUser] = NotSet def __repr__(self) -> str: return self.get__repr__({"id": self._id.value, "user": self._user.value}) @property def author_association(self) -> str: self._completeIfNotSet(self._author_association) return self._author_association.value @property def body(self) -> str: self._completeIfNotSet(self._body) return self._body.value @property def created_at(self) -> datetime: self._completeIfNotSet(self._created_at) return self._created_at.value @property def id(self) -> int: self._completeIfNotSet(self._id) return self._id.value @property def node_id(self) -> str: self._completeIfNotSet(self._node_id) return self._node_id.value @property def updated_at(self) -> datetime: self._completeIfNotSet(self._updated_at) return self._updated_at.value @property def url(self) -> str: self._completeIfNotSet(self._url) return self._url.value @property def user(self) -> github.NamedUser.NamedUser: self._completeIfNotSet(self._user) return self._user.value def delete(self) -> None: """ :calls: `DELETE /gists/{gist_id}/comments/{id} `_ """ headers, data = self._requester.requestJsonAndCheck("DELETE", self.url) def edit(self, body: str) -> None: """ :calls: `PATCH /gists/{gist_id}/comments/{id} `_ """ assert isinstance(body, str), body post_parameters = { "body": body, } headers, data = self._requester.requestJsonAndCheck("PATCH", self.url, input=post_parameters) self._useAttributes(data) def _useAttributes(self, attributes: dict[str, Any]) -> None: if "author_association" in attributes: # pragma no branch self._author_association = self._makeStringAttribute(attributes["author_association"]) if "body" in attributes: # pragma no branch self._body = self._makeStringAttribute(attributes["body"]) if "created_at" in attributes: # pragma no branch self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) if "id" in attributes: # pragma no branch self._id = self._makeIntAttribute(attributes["id"]) if "node_id" in attributes: # pragma no branch self._node_id = self._makeStringAttribute(attributes["node_id"]) 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"])