| ############################ Copyrights and license ############################ | |
| # # | |
| # 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> # | |
| # Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> # | |
| # Copyright 2016 Jannis Gebauer <ja.geb@me.com> # | |
| # Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> # | |
| # Copyright 2017 Nicolas Agustín Torres <nicolastrres@gmail.com> # | |
| # Copyright 2018 Wan Liuyang <tsfdye@gmail.com> # | |
| # Copyright 2018 sfdye <tsfdye@gmail.com> # | |
| # Copyright 2019 Steve Kowalik <steven@wedontsleep.org> # | |
| # Copyright 2019 Wan Liuyang <tsfdye@gmail.com> # | |
| # Copyright 2020 Steve Kowalik <steven@wedontsleep.org> # | |
| # Copyright 2021 Mark Walker <mark.walker@realbuzz.com> # | |
| # Copyright 2021 Steve Kowalik <steven@wedontsleep.org> # | |
| # Copyright 2023 Enrico Minack <github@enrico.minack.dev> # | |
| # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # | |
| # Copyright 2023 Trim21 <trim21.me@gmail.com> # | |
| # Copyright 2024 Enrico Minack <github@enrico.minack.dev> # | |
| # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # | |
| # # | |
| # 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 <http://www.gnu.org/licenses/>. # | |
| # # | |
| ################################################################################ | |
| from __future__ import annotations | |
| from datetime import datetime | |
| from typing import TYPE_CHECKING, Any | |
| import github.NamedUser | |
| from github.GithubObject import Attribute, CompletableGithubObject, NotSet | |
| from . import Consts | |
| if TYPE_CHECKING: | |
| from github.NamedUser import NamedUser | |
| class Reaction(CompletableGithubObject): | |
| """ | |
| This class represents Reactions. | |
| The reference can be found here | |
| https://docs.github.com/en/rest/reference/reactions | |
| """ | |
| def _initAttributes(self) -> None: | |
| self._content: Attribute[str] = NotSet | |
| self._created_at: Attribute[datetime] = NotSet | |
| self._id: Attribute[int] = NotSet | |
| self._user: Attribute[NamedUser] = NotSet | |
| def __repr__(self) -> str: | |
| return self.get__repr__({"id": self._id.value, "user": self._user.value}) | |
| def content(self) -> str: | |
| self._completeIfNotSet(self._content) | |
| return self._content.value | |
| def created_at(self) -> datetime: | |
| self._completeIfNotSet(self._created_at) | |
| return self._created_at.value | |
| def id(self) -> int: | |
| self._completeIfNotSet(self._id) | |
| return self._id.value | |
| def user(self) -> NamedUser: | |
| self._completeIfNotSet(self._user) | |
| return self._user.value | |
| def delete(self) -> None: | |
| """ | |
| :calls: `DELETE /reactions/{id} <https://docs.github.com/en/rest/reference/reactions#delete-a-reaction-legacy>`_ | |
| :rtype: None | |
| """ | |
| self._requester.requestJsonAndCheck( | |
| "DELETE", | |
| f"{self._parentUrl('')}/reactions/{self.id}", | |
| headers={"Accept": Consts.mediaTypeReactionsPreview}, | |
| ) | |
| def _useAttributes(self, attributes: dict[str, Any]) -> None: | |
| if "content" in attributes: # pragma no branch | |
| self._content = self._makeStringAttribute(attributes["content"]) | |
| 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 "user" in attributes: # pragma no branch | |
| self._user = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["user"]) | |