forked from PyGithub/PyGithub
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGithubObject.py
More file actions
396 lines (321 loc) · 15 KB
/
Copy pathGithubObject.py
File metadata and controls
396 lines (321 loc) · 15 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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques <[email protected]> #
# Copyright 2012 Zearin <[email protected]> #
# Copyright 2013 AKFish <[email protected]> #
# Copyright 2013 Vincent Jacques <[email protected]> #
# Copyright 2014 Andrew Scheller <[email protected]> #
# Copyright 2014 Vincent Jacques <[email protected]> #
# Copyright 2016 Jakub Wilk <[email protected]> #
# Copyright 2016 Jannis Gebauer <[email protected]> #
# Copyright 2016 Peter Buckley <[email protected]> #
# Copyright 2016 Sam Corbett <[email protected]> #
# Copyright 2018 Shubham Singh <[email protected]> #
# Copyright 2018 h.shi <[email protected]> #
# Copyright 2018 sfdye <[email protected]> #
# Copyright 2019 Adam Baratz <[email protected]> #
# Copyright 2019 Steve Kowalik <[email protected]> #
# Copyright 2019 Wan Liuyang <[email protected]> #
# Copyright 2020 Steve Kowalik <[email protected]> #
# Copyright 2021 Steve Kowalik <[email protected]> #
# Copyright 2023 Jonathan Leitschuh <[email protected]> #
# #
# 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/>. #
# #
################################################################################
import typing
from datetime import datetime, timezone
from operator import itemgetter
from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Type, Union
from dateutil import parser
from typing_extensions import Protocol, TypeGuard
from . import Consts
from .GithubException import BadAttributeException, IncompletableObject
if TYPE_CHECKING:
from .Requester import Requester
T = typing.TypeVar("T")
K = typing.TypeVar("K")
T_co = typing.TypeVar("T_co", covariant=True)
T_gh = typing.TypeVar("T_gh", bound="GithubObject")
class Attribute(Protocol[T_co]):
@property
def value(self) -> T_co:
raise NotImplementedError
class _NotSetType:
def __repr__(self) -> str:
return "NotSet"
@property
def value(self) -> Any:
return None
@staticmethod
def remove_unset_items(data: Dict[str, Any]) -> Dict[str, Any]:
return {key: value for key, value in data.items() if not isinstance(value, _NotSetType)}
NotSet = _NotSetType()
Opt = Union[T, _NotSetType]
def is_defined(v: Union[T, _NotSetType]) -> TypeGuard[T]:
return not isinstance(v, _NotSetType)
def is_undefined(v: Union[T, _NotSetType]) -> TypeGuard[_NotSetType]:
return isinstance(v, _NotSetType)
def is_optional(v: Any, type: Union[Type, Tuple[Type, ...]]) -> bool:
return isinstance(v, _NotSetType) or isinstance(v, type)
def is_optional_list(v: Any, type: Union[Type, Tuple[Type, ...]]) -> bool:
return isinstance(v, _NotSetType) or isinstance(v, list) and all(isinstance(element, type) for element in v)
class _ValuedAttribute(Attribute[T]):
def __init__(self, value: T):
self._value = value
@property
def value(self) -> T:
return self._value
class _BadAttribute(Attribute):
def __init__(self, value: Any, expectedType: Any, exception: Optional[Exception] = None):
self.__value = value
self.__expectedType = expectedType
self.__exception = exception
@property
def value(self) -> Any:
raise BadAttributeException(self.__value, self.__expectedType, self.__exception)
# v3: add * to edit function of all GithubObject implementations,
# this allows to rename attributes and maintain the order of attributes
class GithubObject:
"""
Base class for all classes representing objects returned by the API.
"""
"""
A global debug flag to enable header validation by requester for all objects
"""
CHECK_AFTER_INIT_FLAG = False
_url: Attribute[str]
@classmethod
def setCheckAfterInitFlag(cls, flag: bool) -> None:
cls.CHECK_AFTER_INIT_FLAG = flag
def __init__(
self,
requester: "Requester",
headers: Dict[str, Union[str, int]],
attributes: Any,
completed: bool,
):
self._requester = requester
self._initAttributes()
self._storeAndUseAttributes(headers, attributes)
# Ask requester to do some checking, for debug and test purpose
# Since it's most handy to access and kinda all-knowing
if self.CHECK_AFTER_INIT_FLAG: # pragma no branch (Flag always set in tests)
requester.check_me(self)
def _storeAndUseAttributes(self, headers: Dict[str, Union[str, int]], attributes: Any) -> None:
# Make sure headers are assigned before calling _useAttributes
# (Some derived classes will use headers in _useAttributes)
self._headers = headers
self._rawData = attributes
self._useAttributes(attributes)
@property
def raw_data(self) -> Dict[str, Any]:
"""
:type: dict
"""
self._completeIfNeeded()
return self._rawData
@property
def raw_headers(self) -> Dict[str, Union[str, int]]:
"""
:type: dict
"""
self._completeIfNeeded()
return self._headers
@staticmethod
def _parentUrl(url: str) -> str:
return "/".join(url.split("/")[:-1])
@staticmethod
def __makeSimpleAttribute(value: Any, type: Type[T]) -> Attribute[T]:
if value is None or isinstance(value, type):
return _ValuedAttribute(value) # type: ignore
else:
return _BadAttribute(value, type) # type: ignore
@staticmethod
def __makeSimpleListAttribute(value: list, type: Type[T]) -> Attribute[T]:
if isinstance(value, list) and all(isinstance(element, type) for element in value):
return _ValuedAttribute(value) # type: ignore
else:
return _BadAttribute(value, [type]) # type: ignore
@staticmethod
def __makeTransformedAttribute(value: T, type: Type[T], transform: Callable[[T], K]) -> Attribute[K]:
if value is None:
return _ValuedAttribute(None) # type: ignore
elif isinstance(value, type):
try:
return _ValuedAttribute(transform(value))
except Exception as e:
return _BadAttribute(value, type, e) # type: ignore
else:
return _BadAttribute(value, type) # type: ignore
@staticmethod
def _makeStringAttribute(value: Optional[Union[int, str]]) -> Attribute[str]:
return GithubObject.__makeSimpleAttribute(value, str)
@staticmethod
def _makeIntAttribute(value: Optional[Union[int, str]]) -> Attribute[int]:
return GithubObject.__makeSimpleAttribute(value, int)
@staticmethod
def _makeFloatAttribute(value: Optional[float]) -> Attribute[float]:
return GithubObject.__makeSimpleAttribute(value, float)
@staticmethod
def _makeBoolAttribute(value: Optional[bool]) -> Attribute[bool]:
return GithubObject.__makeSimpleAttribute(value, bool)
@staticmethod
def _makeDictAttribute(value: Dict[str, Any]) -> Attribute[Dict[str, Any]]:
return GithubObject.__makeSimpleAttribute(value, dict)
@staticmethod
def _makeTimestampAttribute(value: int) -> Attribute[datetime]:
return GithubObject.__makeTransformedAttribute(
value,
int,
lambda t: datetime.fromtimestamp(t, tz=timezone.utc),
)
@staticmethod
def _makeDatetimeAttribute(value: Optional[str]) -> Attribute[datetime]:
return GithubObject.__makeTransformedAttribute(value, str, parser.parse) # type: ignore
def _makeClassAttribute(self, klass: Type[T_gh], value: Any) -> Attribute[T_gh]:
return GithubObject.__makeTransformedAttribute(
value,
dict,
lambda value: klass(self._requester, self._headers, value, completed=False),
)
@staticmethod
def _makeListOfStringsAttribute(value: Union[List[List[str]], List[str], List[Union[str, int]]]) -> Attribute:
return GithubObject.__makeSimpleListAttribute(value, str)
@staticmethod
def _makeListOfIntsAttribute(value: List[int]) -> Attribute:
return GithubObject.__makeSimpleListAttribute(value, int)
@staticmethod
def _makeListOfDictsAttribute(
value: List[Dict[str, Union[str, List[Dict[str, Union[str, List[int]]]]]]]
) -> Attribute:
return GithubObject.__makeSimpleListAttribute(value, dict)
@staticmethod
def _makeListOfListOfStringsAttribute(
value: List[List[str]],
) -> Attribute:
return GithubObject.__makeSimpleListAttribute(value, list)
def _makeListOfClassesAttribute(self, klass: Type[T_gh], value: Any) -> Attribute[List[T_gh]]:
if isinstance(value, list) and all(isinstance(element, dict) for element in value):
return _ValuedAttribute(
[klass(self._requester, self._headers, element, completed=False) for element in value]
)
else:
return _BadAttribute(value, [dict])
def _makeDictOfStringsToClassesAttribute(
self,
klass: Type[T_gh],
value: Dict[
str,
Union[int, Dict[str, Union[str, int, None]], Dict[str, Union[str, int]]],
],
) -> Attribute[Dict[str, T_gh]]:
if isinstance(value, dict) and all(
isinstance(key, str) and isinstance(element, dict) for key, element in value.items()
):
return _ValuedAttribute(
{key: klass(self._requester, self._headers, element, completed=False) for key, element in value.items()}
)
else:
return _BadAttribute(value, {str: dict})
@property
def etag(self) -> Optional[str]:
"""
:type: str
"""
return self._headers.get(Consts.RES_ETAG) # type: ignore
@property
def last_modified(self) -> Optional[str]:
"""
:type: str
"""
return self._headers.get(Consts.RES_LAST_MODIFIED) # type: ignore
def get__repr__(self, params: Dict[str, Any]) -> str:
"""
Converts the object to a nicely printable string.
"""
def format_params(params: Dict[str, Any]) -> typing.Generator[str, None, None]:
items = list(params.items())
for k, v in sorted(items, key=itemgetter(0), reverse=True):
if isinstance(v, bytes):
v = v.decode("utf-8")
if isinstance(v, str):
v = f'"{v}"'
yield f"{k}={v}"
return "{class_name}({params})".format(
class_name=self.__class__.__name__,
params=", ".join(list(format_params(params))),
)
def _initAttributes(self) -> None:
raise NotImplementedError("BUG: Not Implemented _initAttributes")
def _useAttributes(self, attributes: Any) -> None:
raise NotImplementedError("BUG: Not Implemented _useAttributes")
def _completeIfNeeded(self) -> None:
raise NotImplementedError("BUG: Not Implemented _completeIfNeeded")
class NonCompletableGithubObject(GithubObject):
def _completeIfNeeded(self) -> None:
pass
class CompletableGithubObject(GithubObject):
def __init__(
self,
requester: "Requester",
headers: Dict[str, Union[str, int]],
attributes: Dict[str, Any],
completed: bool,
):
super().__init__(requester, headers, attributes, completed)
self.__completed = completed
def __eq__(self, other: Any) -> bool:
return other.__class__ is self.__class__ and other._url.value == self._url.value
def __hash__(self) -> int:
return hash(self._url.value)
def __ne__(self, other: Any) -> bool:
return not self == other
def _completeIfNotSet(self, value: Attribute) -> None:
if isinstance(value, _NotSetType):
self._completeIfNeeded()
def _completeIfNeeded(self) -> None:
if not self.__completed:
self.__complete()
def __complete(self) -> None:
if self._url.value is None:
raise IncompletableObject(400, message="Returned object contains no URL")
headers, data = self._requester.requestJsonAndCheck("GET", self._url.value)
self._storeAndUseAttributes(headers, data)
self.__completed = True
def update(self, additional_headers: Optional[Dict[str, Any]] = None) -> bool:
"""
Check and update the object with conditional request
:rtype: Boolean value indicating whether the object is changed
"""
conditionalRequestHeader = dict()
if self.etag is not None:
conditionalRequestHeader[Consts.REQ_IF_NONE_MATCH] = self.etag
if self.last_modified is not None:
conditionalRequestHeader[Consts.REQ_IF_MODIFIED_SINCE] = self.last_modified
if additional_headers is not None:
conditionalRequestHeader.update(additional_headers)
status, responseHeaders, output = self._requester.requestJson(
"GET", self._url.value, headers=conditionalRequestHeader
)
if status == 304:
return False
else:
headers, data = self._requester._Requester__check(status, responseHeaders, output) # type: ignore
self._storeAndUseAttributes(headers, data)
self.__completed = True
return True