############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Thialfihar # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 h.shi <10385628+AnYeMoWang@users.noreply.github.com> # # Copyright 2018 sfdye # # Copyright 2019 Adam Baratz # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Alice GIRARD # # 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> # # # # 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 import base64 from typing import TYPE_CHECKING, Any import github.GithubObject import github.Repository from github.GithubObject import Attribute, CompletableGithubObject, NotSet, _ValuedAttribute if TYPE_CHECKING: from github.License import License from github.Repository import Repository class ContentFile(CompletableGithubObject): """ This class represents ContentFiles. The reference can be found here https://docs.github.com/en/rest/reference/repos#contents """ def _initAttributes(self) -> None: self._content: Attribute[str] = NotSet self._download_url: Attribute[str] = NotSet self._encoding: Attribute[str] = NotSet self._git_url: Attribute[str] = NotSet self._html_url: Attribute[str] = NotSet self._license: Attribute[License] = NotSet self._name: Attribute[str] = NotSet self._path: Attribute[str] = NotSet self._repository: Attribute[Repository] = NotSet self._sha: Attribute[str] = NotSet self._size: Attribute[int] = NotSet self._type: Attribute[str] = NotSet self._url: Attribute[str] = NotSet self._text_matches: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"path": self._path.value}) @property def content(self) -> str: self._completeIfNotSet(self._content) return self._content.value @property def decoded_content(self) -> bytes: assert self.encoding == "base64", f"unsupported encoding: {self.encoding}" return base64.b64decode(bytearray(self.content, "utf-8")) @property def download_url(self) -> str: self._completeIfNotSet(self._download_url) return self._download_url.value @property def encoding(self) -> str: self._completeIfNotSet(self._encoding) return self._encoding.value @property def git_url(self) -> str: self._completeIfNotSet(self._git_url) return self._git_url.value @property def html_url(self) -> str: self._completeIfNotSet(self._html_url) return self._html_url.value @property def license(self) -> License: self._completeIfNotSet(self._license) return self._license.value @property def name(self) -> str: self._completeIfNotSet(self._name) return self._name.value @property def path(self) -> str: self._completeIfNotSet(self._path) return self._path.value @property def repository(self) -> Repository: if self._repository is NotSet: # The repository was not set automatically, so it must be looked up by url. repo_url = "/".join(self.url.split("/")[:6]) # pragma no cover (Should be covered) self._repository = _ValuedAttribute( github.Repository.Repository(self._requester, self._headers, {"url": repo_url}, completed=False) ) # pragma no cover (Should be covered) return self._repository.value @property def sha(self) -> str: self._completeIfNotSet(self._sha) return self._sha.value @property def size(self) -> int: self._completeIfNotSet(self._size) return self._size.value @property def type(self) -> str: self._completeIfNotSet(self._type) return self._type.value @property def url(self) -> str: self._completeIfNotSet(self._url) return self._url.value @property def text_matches(self) -> str: self._completeIfNotSet(self._text_matches) return self._text_matches.value def _useAttributes(self, attributes: dict[str, Any]) -> None: if "content" in attributes: # pragma no branch self._content = self._makeStringAttribute(attributes["content"]) if "download_url" in attributes: # pragma no branch self._download_url = self._makeStringAttribute(attributes["download_url"]) if "encoding" in attributes: # pragma no branch self._encoding = self._makeStringAttribute(attributes["encoding"]) if "git_url" in attributes: # pragma no branch self._git_url = self._makeStringAttribute(attributes["git_url"]) if "html_url" in attributes: # pragma no branch self._html_url = self._makeStringAttribute(attributes["html_url"]) if "license" in attributes: # pragma no branch self._license = self._makeClassAttribute(github.License.License, attributes["license"]) if "name" in attributes: # pragma no branch self._name = self._makeStringAttribute(attributes["name"]) if "path" in attributes: # pragma no branch self._path = self._makeStringAttribute(attributes["path"]) if "repository" in attributes: # pragma no branch self._repository = self._makeClassAttribute(github.Repository.Repository, attributes["repository"]) if "sha" in attributes: # pragma no branch self._sha = self._makeStringAttribute(attributes["sha"]) if "size" in attributes: # pragma no branch self._size = self._makeIntAttribute(attributes["size"]) if "type" in attributes: # pragma no branch self._type = self._makeStringAttribute(attributes["type"]) if "url" in attributes: # pragma no branch self._url = self._makeStringAttribute(attributes["url"]) if "text_matches" in attributes: # pragma no branch self._text_matches = self._makeListOfDictsAttribute(attributes["text_matches"])