############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques #
# Copyright 2012 Zearin #
# Copyright 2013 AKFish #
# Copyright 2013 Vincent Jacques #
# Copyright 2013 martinqt #
# Copyright 2014 Vincent Jacques #
# Copyright 2016 Jannis Gebauer #
# Copyright 2016 Peter Buckley #
# Copyright 2018 Mateusz Loskot #
# 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 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 . #
# #
################################################################################
import urllib.parse
from typing import Any, Dict
from github import Consts
from github.GithubObject import Attribute, CompletableGithubObject, NotSet, Opt, is_optional
class Label(CompletableGithubObject):
"""
This class represents Labels.
The reference can be found here
https://docs.github.com/en/rest/reference/issues#labels
"""
def _initAttributes(self) -> None:
self._color: Attribute[str] = NotSet
self._description: Attribute[str] = NotSet
self._name: Attribute[str] = NotSet
self._url: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"name": self._name.value})
@property
def color(self) -> str:
self._completeIfNotSet(self._color)
return self._color.value
@property
def description(self) -> str:
self._completeIfNotSet(self._description)
return self._description.value
@property
def name(self) -> str:
self._completeIfNotSet(self._name)
return self._name.value
@property
def url(self) -> str:
self._completeIfNotSet(self._url)
return self._url.value
def delete(self) -> None:
"""
:calls: `DELETE /repos/{owner}/{repo}/labels/{name} `_
"""
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
def edit(self, name: str, color: str, description: Opt[str] = NotSet) -> None:
"""
:calls: `PATCH /repos/{owner}/{repo}/labels/{name} `_
"""
assert isinstance(name, str), name
assert isinstance(color, str), color
assert is_optional(description, str), description
post_parameters = NotSet.remove_unset_items({"new_name": name, "color": color, "description": description})
headers, data = self._requester.requestJsonAndCheck(
"PATCH",
self.url,
input=post_parameters,
headers={"Accept": Consts.mediaTypeLabelDescriptionSearchPreview},
)
self._useAttributes(data)
@property
def _identity(self) -> str:
return urllib.parse.quote(self.name)
def _useAttributes(self, attributes: Dict[str, Any]) -> None:
if "color" in attributes: # pragma no branch
self._color = self._makeStringAttribute(attributes["color"])
if "description" in attributes: # pragma no branch
self._description = self._makeStringAttribute(attributes["description"])
if "name" in attributes: # pragma no branch
self._name = self._makeStringAttribute(attributes["name"])
if "url" in attributes: # pragma no branch
self._url = self._makeStringAttribute(attributes["url"])