{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathContentFile.py
More file actions
303 lines (257 loc) · 12.8 KB
/
Copy pathContentFile.py
File metadata and controls
303 lines (257 loc) · 12.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
############################ 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 Thialfihar <thi@thialfihar.org> #
# 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 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 h.shi <10385628+AnYeMoWang@users.noreply.github.com> #
# Copyright 2018 sfdye <tsfdye@gmail.com> #
# Copyright 2019 Adam Baratz <adam.baratz@gmail.com> #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2020 Alice GIRARD <bouhahah@gmail.com> #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# 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> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# #
# 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
import base64
from datetime import datetime
from typing import TYPE_CHECKING, Any
import github.GitCommit
import github.GithubObject
import github.License
import github.Repository
from github.GithubObject import Attribute, CompletableGithubObject, NotSet, _ValuedAttribute
if TYPE_CHECKING:
from github.GitCommit import GitCommit
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
The OpenAPI schema can be found at
- /components/schemas/content-directory
- /components/schemas/content-file
- /components/schemas/content-submodule
- /components/schemas/content-symlink
- /components/schemas/file-commit
- /components/schemas/license-content
"""
def _initAttributes(self) -> None:
self.__links: Attribute[dict[str, Any]] = NotSet
self._commit: Attribute[GitCommit] = NotSet
self._content: Attribute[str] = NotSet
self._download_url: Attribute[str] = NotSet
self._encoding: Attribute[str] = NotSet
self._file_size: Attribute[int] = NotSet
self._git_url: Attribute[str] = NotSet
self._html_url: Attribute[str] = NotSet
self._language: Attribute[str] = NotSet
self._last_modified_at: Attribute[datetime] = NotSet
self._license: Attribute[License] = NotSet
self._line_numbers: Attribute[list[str]] = 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._submodule_git_url: Attribute[str] = NotSet
self._target: Attribute[str] = NotSet
self._text_matches: Attribute[str] = NotSet
self._type: Attribute[str] = NotSet
self._url: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"path": self._path.value})
@property
def _links(self) -> dict[str, Any]:
self._completeIfNotSet(self.__links)
return self.__links.value
@property
def commit(self) -> GitCommit:
self._completeIfNotSet(self._commit)
return self._commit.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 file_size(self) -> int:
self._completeIfNotSet(self._file_size)
return self._file_size.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 language(self) -> str:
self._completeIfNotSet(self._language)
return self._language.value
@property
def last_modified_at(self) -> datetime:
self._completeIfNotSet(self._last_modified_at)
return self._last_modified_at.value
@property
def license(self) -> License:
self._completeIfNotSet(self._license)
return self._license.value
@property
def line_numbers(self) -> list[str]:
self._completeIfNotSet(self._line_numbers)
return self._line_numbers.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 submodule_git_url(self) -> str:
self._completeIfNotSet(self._submodule_git_url)
return self._submodule_git_url.value
@property
def target(self) -> str:
self._completeIfNotSet(self._target)
return self._target.value
@property
def text_matches(self) -> str:
self._completeIfNotSet(self._text_matches)
return self._text_matches.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
def _useAttributes(self, attributes: dict[str, Any]) -> None:
if "_links" in attributes: # pragma no branch
self.__links = self._makeDictAttribute(attributes["_links"])
if "commit" in attributes: # pragma no branch
self._commit = self._makeClassAttribute(github.GitCommit.GitCommit, attributes["commit"])
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 "file_size" in attributes: # pragma no branch
self._file_size = self._makeIntAttribute(attributes["file_size"])
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 "language" in attributes: # pragma no branch
self._language = self._makeStringAttribute(attributes["language"])
if "last_modified_at" in attributes: # pragma no branch
self._last_modified_at = self._makeDatetimeAttribute(attributes["last_modified_at"])
if "license" in attributes: # pragma no branch
self._license = self._makeClassAttribute(github.License.License, attributes["license"])
if "line_numbers" in attributes: # pragma no branch
self._line_numbers = self._makeListOfStringsAttribute(attributes["line_numbers"])
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 "submodule_git_url" in attributes: # pragma no branch
self._submodule_git_url = self._makeStringAttribute(attributes["submodule_git_url"])
if "target" in attributes: # pragma no branch
self._target = self._makeStringAttribute(attributes["target"])
if "text_matches" in attributes: # pragma no branch
self._text_matches = self._makeListOfDictsAttribute(attributes["text_matches"])
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"])
class ContentFileSearchResult(ContentFile):
"""
This class represents ContentFileSearchResult.
The reference can be found here
https://docs.github.com/en/rest/reference/search#search-code
The OpenAPI schema can be found at
- /components/schemas/code-search-result-item
"""
def _initAttributes(self) -> None:
super()._initAttributes()
self._score: Attribute[float] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"path": self._path.value})
@property
def score(self) -> float:
self._completeIfNotSet(self._score)
return self._score.value
def _useAttributes(self, attributes: dict[str, Any]) -> None:
super()._useAttributes(attributes)
if "score" in attributes: # pragma no branch
self._score = self._makeFloatAttribute(attributes["score"])
You can’t perform that action at this time.