############################ 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 2017 Aaron Levine # # Copyright 2017 Mike Miller # # Copyright 2018 Darragh Bailey # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Adam Baratz # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # 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 typing import Any from github.GithubObject import Attribute, CompletableGithubObject, NotSet class License(CompletableGithubObject): """ This class represents Licenses. The reference can be found here https://docs.github.com/en/rest/reference/licenses The OpenAPI schema can be found at - /components/schemas/license-simple - /components/schemas/minimal-repository/properties/license - /components/schemas/nullable-license-simple """ def _initAttributes(self) -> None: self._body: Attribute[str] = NotSet self._conditions: Attribute[list[str]] = NotSet self._description: Attribute[str] = NotSet self._html_url: Attribute[str] = NotSet self._implementation: Attribute[str] = NotSet self._key: Attribute[str] = NotSet self._limitations: Attribute[list[str]] = NotSet self._name: Attribute[str] = NotSet self._node_id: Attribute[str] = NotSet self._permissions: Attribute[list[str]] = NotSet self._spdx_id: Attribute[str] = NotSet self._url: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"name": self._name.value}) @property def body(self) -> str: self._completeIfNotSet(self._body) return self._body.value @property def conditions(self) -> list[str]: self._completeIfNotSet(self._conditions) return self._conditions.value @property def description(self) -> str: self._completeIfNotSet(self._description) return self._description.value @property def html_url(self) -> str: self._completeIfNotSet(self._html_url) return self._html_url.value @property def implementation(self) -> str: self._completeIfNotSet(self._implementation) return self._implementation.value @property def key(self) -> str: self._completeIfNotSet(self._key) return self._key.value @property def limitations(self) -> list[str]: self._completeIfNotSet(self._limitations) return self._limitations.value @property def name(self) -> str: self._completeIfNotSet(self._name) return self._name.value @property def node_id(self) -> str: self._completeIfNotSet(self._node_id) return self._node_id.value @property def permissions(self) -> list[str]: self._completeIfNotSet(self._permissions) return self._permissions.value @property def spdx_id(self) -> str: self._completeIfNotSet(self._spdx_id) return self._spdx_id.value @property def url(self) -> str: self._completeIfNotSet(self._url) return self._url.value def _useAttributes(self, attributes: dict[str, Any]) -> None: if "body" in attributes: # pragma no branch self._body = self._makeStringAttribute(attributes["body"]) if "conditions" in attributes: # pragma no branch self._conditions = self._makeListOfStringsAttribute(attributes["conditions"]) if "description" in attributes: # pragma no branch self._description = self._makeStringAttribute(attributes["description"]) if "html_url" in attributes: # pragma no branch self._html_url = self._makeStringAttribute(attributes["html_url"]) if "implementation" in attributes: # pragma no branch self._implementation = self._makeStringAttribute(attributes["implementation"]) if "key" in attributes: # pragma no branch self._key = self._makeStringAttribute(attributes["key"]) if "limitations" in attributes: # pragma no branch self._limitations = self._makeListOfStringsAttribute(attributes["limitations"]) if "name" in attributes: # pragma no branch self._name = self._makeStringAttribute(attributes["name"]) if "node_id" in attributes: # pragma no branch self._node_id = self._makeStringAttribute(attributes["node_id"]) if "permissions" in attributes: # pragma no branch self._permissions = self._makeListOfStringsAttribute(attributes["permissions"]) if "spdx_id" in attributes: # pragma no branch self._spdx_id = self._makeStringAttribute(attributes["spdx_id"]) if "url" in attributes: # pragma no branch self._url = self._makeStringAttribute(attributes["url"])