{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathGithubObject.py
More file actions
851 lines (685 loc) · 31.7 KB
/
Copy pathGithubObject.py
File metadata and controls
851 lines (685 loc) · 31.7 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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
############################ 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 Andrew Scheller <github@loowis.durge.org> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2016 Jakub Wilk <jwilk@jwilk.net> #
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2016 Sam Corbett <sam.corbett@cloudsoftcorp.com> #
# Copyright 2018 Shubham Singh <41840111+singh811@users.noreply.github.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 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2021 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2023 Christoph Reiter <reiter.christoph@gmail.com> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Jonathan Greg <31892308+jmgreg31@users.noreply.github.com> #
# Copyright 2023 Jonathan Leitschuh <jonathan.leitschuh@gmail.com> #
# Copyright 2023 Joseph Henrich <crimsonknave@gmail.com> #
# Copyright 2023 Nicolas Schweitzer <nicolas.schweitzer@datadoghq.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 2024 Min RK <benjaminrk@gmail.com> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2026 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2026 Hugo van Kemenade <1324225+hugovk@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 <http://www.gnu.org/licenses/>. #
# #
################################################################################
from __future__ import annotations
import email.utils
import re
import typing
from abc import ABC
from collections.abc import Callable
from datetime import datetime, timezone
from decimal import Decimal
from operator import itemgetter
from typing import TYPE_CHECKING, Any, TypeGuard, Union, overload
from typing_extensions import ParamSpec, Protocol, Self, TypeVar
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
def _datetime_from_http_date(value: str) -> datetime:
"""
Convert an HTTP date to a datetime object.
Raises ValueError for invalid dates.
"""
dt = email.utils.parsedate_to_datetime(value)
if dt.tzinfo is None:
# RFC7231 states that UTC is assumed if no timezone info is present
return dt.replace(tzinfo=timezone.utc)
return dt
def _datetime_from_github_isoformat(value: str) -> datetime:
"""
Convert an GitHub API timestamps to a datetime object.
Raises ValueError for invalid timestamps.
"""
# Github always returns YYYY-MM-DDTHH:MM:SSZ, so we can use the stdlib parser
# with some minor adjustments for Python < 3.11 which doesn't support "Z"
# https://docs.github.com/en/rest/overview/resources-in-the-rest-api#schema
if value.endswith("Z"):
value = value[:-1] + "+00:00"
return datetime.fromisoformat(value)
class _NotSetType(Attribute[Any]):
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: T | _NotSetType) -> TypeGuard[T]:
return not isinstance(v, _NotSetType)
def is_undefined(v: T | _NotSetType) -> TypeGuard[_NotSetType]:
return isinstance(v, _NotSetType)
def is_optional(v: Any, type: type | tuple[type, ...]) -> bool:
return isinstance(v, _NotSetType) or isinstance(v, type)
def is_list(v: Any, type: type | tuple[type, ...]) -> bool:
return isinstance(v, list) and all(isinstance(element, type) for element in v)
def is_optional_list(v: Any, type: type | tuple[type, ...]) -> bool:
return is_undefined(v) or is_list(v, type)
camel_to_snake_case_regexp = re.compile(r"(?<!^)(?=[A-Z])")
@overload
def as_rest_api_attributes(graphql_attributes: dict[str, Any]) -> dict[str, Any]:
...
@overload
def as_rest_api_attributes(graphql_attributes: None) -> None:
...
def as_rest_api_attributes(graphql_attributes: dict[str, Any] | None) -> dict[str, Any] | None:
"""
Converts attributes from GraphQL schema to REST API schema.
The GraphQL API uses lower camel case (e.g. createdAt), whereas REST API uses snake case (created_at). Initializing
REST API GithubObjects from GraphQL API attributes requires transformation provided by this method.
Further renames GraphQL attributes to REST API attributes where the case conversion is not sufficient. For example,
GraphQL attribute 'id' is equivalent to REST API attribute 'node_id'.
"""
if graphql_attributes is None:
return None
attribute_translation = {
"id": "node_id",
"databaseId": "id", # must be after 'id': 'node_id'!
"url": "html_url",
}
def translate(attr: str) -> str:
def un_capitalize(match: re.Match) -> str:
return match.group(1) + match.group(2).lower()
attr = attribute_translation.get(attr, attr)
attr = re.sub(r"([A-Z])([A-Z]+)", un_capitalize, attr)
attr = camel_to_snake_case_regexp.sub("_", attr)
attr = attr.lower()
return attr
return {
translate(k): as_rest_api_attributes(v)
if isinstance(v, dict)
else (as_rest_api_attributes_list(v) if isinstance(v, list) else v)
for k, v in graphql_attributes.items()
}
def as_rest_api_attributes_list(graphql_attributes: list[dict[str, Any] | None]) -> list[dict[str, Any] | None]:
return [as_rest_api_attributes(v) if isinstance(v, dict) else v for v in graphql_attributes]
class _ValuedAttribute(Attribute[T]):
def __init__(self, value: T):
self._value = value
@property
def value(self) -> T:
return self._value
class _BadAttribute(Attribute[T]):
def __init__(self, value: Any, expectedType: Any, exception: Exception | None = None):
self.__value = value
self.__expectedType = expectedType
self.__exception = exception
@property
def value(self) -> T:
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(ABC):
"""
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 is_rest(cls) -> bool:
return not cls.is_graphql()
@classmethod
def is_graphql(cls) -> bool:
return False
@classmethod
def setCheckAfterInitFlag(cls, flag: bool) -> None:
cls.CHECK_AFTER_INIT_FLAG = flag
def __init__(
self,
requester: Requester,
headers: dict[str, str | int],
attributes: Any,
):
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, str | int], attributes: Any) -> None:
# Make sure headers are assigned before calling _useAttributes
# (Some derived classes will use headers in _useAttributes)
self._api_version = headers.get(Consts.headerApiVersionSelected)
self._headers = headers
self._rawData = attributes
self._useAttributes(attributes)
@property
def requester(self) -> Requester:
"""
Return my Requester object.
For example, to make requests to API endpoints not yet supported by PyGitHub.
"""
return self._requester
@property
def raw_data(self) -> dict[str, Any]:
"""
:type: dict
"""
return self._rawData
@property
def raw_headers(self) -> dict[str, str | int]:
"""
:type: dict
"""
return self._headers
@property
def api_version(self) -> str | None:
"""
The Github API version of this PyGithub object as returned by the Github API.
This does not reflect the API version configured via Github(api_version=…) or GithubIntegration(api_version=…).
:type: str
"""
return self._api_version # type: ignore
@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: int | str | None) -> Attribute[str]:
return GithubObject.__makeSimpleAttribute(value, str)
@staticmethod
def _makeIntAttribute(value: int | str | None) -> Attribute[int]:
return GithubObject.__makeSimpleAttribute(value, int)
@staticmethod
def _makeDecimalAttribute(value: Decimal | None) -> Attribute[Decimal]:
return GithubObject.__makeSimpleAttribute(value, Decimal)
@staticmethod
def _makeFloatAttribute(value: float | None) -> Attribute[float]:
return GithubObject.__makeSimpleAttribute(value, float)
@staticmethod
def _makeBoolAttribute(value: bool | None) -> 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: str | None) -> Attribute[datetime]:
return GithubObject.__makeTransformedAttribute(value, str, _datetime_from_github_isoformat) # type: ignore
@staticmethod
def _makeHttpDatetimeAttribute(value: str | None) -> Attribute[datetime]:
return GithubObject.__makeTransformedAttribute(value, str, _datetime_from_http_date) # 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),
)
def _makeUnionClassAttributeFromTypeName(
self, type_name: str | None, fallback_type: str | None, value: Any, *class_and_names: tuple[type[T_gh], str]
) -> Attribute[T_gh]:
class_and_name_index = {name: clazz for clazz, name in class_and_names}
if fallback_type is not None:
assert fallback_type in class_and_name_index
if value is None or type_name is None:
return _ValuedAttribute(None) # type: ignore
klass = class_and_name_index.get(type_name)
if klass is not None:
return self._makeClassAttribute(klass, value)
if fallback_type is not None:
fallback_class = class_and_name_index.get(fallback_type)
assert fallback_class is not None
return self._makeClassAttribute(fallback_class, value)
return _BadAttribute(value, type) # type: ignore
def _makeUnionClassAttributeFromTypeKey(
self,
type_key: str,
default_and_fallback_type: str | tuple[str, str] | None,
value: Any,
*class_and_names: tuple[type[T_gh], str],
) -> Attribute[T_gh]:
if value is None or not isinstance(value, dict):
return _ValuedAttribute(None) # type: ignore
default_type: str | None
fallback_type: str | None
if isinstance(default_and_fallback_type, tuple):
default_type, fallback_type = default_and_fallback_type
else:
default_type = default_and_fallback_type
fallback_type = default_and_fallback_type
return self._makeUnionClassAttributeFromTypeName(
value.get(type_key, default_type), fallback_type, value, *class_and_names
)
def _makeUnionClassAttributeFromTypeKeyAndValueKey(
self,
type_key: str,
value_key: str,
default_and_fallback_type: str | tuple[str, str] | None,
value: Any,
*class_and_names: tuple[type[T_gh], str],
) -> Attribute[T_gh]:
if value is None or not isinstance(value, dict):
return _ValuedAttribute(None) # type: ignore
default_type: str | None
fallback_type: str | None
if isinstance(default_and_fallback_type, tuple):
default_type, fallback_type = default_and_fallback_type
else:
default_type = default_and_fallback_type
fallback_type = default_and_fallback_type
return self._makeUnionClassAttributeFromTypeName(
value.get(type_key, default_type), fallback_type, value.get(value_key), *class_and_names
)
@staticmethod
def _makeListOfStringsAttribute(value: list[list[str]] | list[str] | list[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, str | list[dict[str, 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) for element in value])
else:
return _BadAttribute(value, [dict])
def _makeListOfUnionClassesAttributeFromTypeKey(
self,
type_key: str,
default_and_fallback_type: str | tuple[str, str],
value: Any,
*class_and_names: tuple[type[T_gh], str],
) -> Attribute[list[T_gh]]:
class_and_name_index = {name: clazz for clazz, name in class_and_names}
if isinstance(default_and_fallback_type, str):
default_type = default_and_fallback_type
fallback_type = default_and_fallback_type
else:
default_type, fallback_type = default_and_fallback_type
assert default_type in class_and_name_index
assert fallback_type in class_and_name_index
fallback_class = class_and_name_index.get(fallback_type)
assert fallback_class is not None
if isinstance(value, list) and all(isinstance(element, dict) for element in value):
return _ValuedAttribute(
[
klass(self._requester, self._headers, element)
for element in value
for type_name in [element.get(type_key, default_type)]
for klass in [class_and_name_index.get(type_name, fallback_class)]
]
)
else:
return _BadAttribute(value, [dict])
def _makeDictOfStringsToClassesAttribute(
self,
klass: type[T_gh],
value: dict[
str,
int | dict[str, Any],
],
) -> 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) for key, element in value.items()}
)
else:
return _BadAttribute(value, {str: dict})
@property
def etag(self) -> str | None:
"""
:type: str
"""
return self._headers.get(Consts.RES_ETAG) # type: ignore
@property
def last_modified(self) -> str | None:
"""
:type: str
"""
return self._headers.get(Consts.RES_LAST_MODIFIED) # type: ignore
@property
def last_modified_datetime(self) -> datetime | None:
"""
:type: datetime
"""
return self._makeHttpDatetimeAttribute(self.last_modified).value # 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")
class GraphQlObject:
@classmethod
def is_graphql(cls) -> bool:
return True
class NonCompletableGithubObject(GithubObject, ABC):
def __init__(
self,
requester: Requester,
headers: dict[str, str | int],
attributes: dict[str, Any],
):
super().__init__(requester, headers, attributes)
class CompletableGithubObject(GithubObject, ABC):
def __init__(
self,
requester: Requester,
headers: dict[str, str | int] | None = None,
attributes: dict[str, Any] | None = None,
completed: bool | None = None,
*,
url: str | None = None,
accept: str | None = None,
):
"""
A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not
initialized will then trigger a request to complete all attributes.
A partially initialized CompletableGithubObject (completed=False) can be completed
via ``complete()``. This requires the url to be given via parameter ``url`` or ``attributes``.
With a requester where ``Requester.is_lazy == True``, this CompletableGithubObjects is
partially initialized. This requires the url to be given via parameter ``url`` or ``attributes``.
Any CompletableGithubObject created from this lazy object will be lazy itself if created with
parameter ``url`` or ``attributes``.
:param requester: requester
:param headers: response headers
:param attributes: attributes to initialize
:param completed: do not update non-initialized attributes when True
:param url: url of this instance, overrides attributes['url']
:param accept: use this accept header when completing this instance
"""
response_given = headers is not None
if headers is None:
headers = {}
if attributes is None:
attributes = {}
if url is not None:
attributes["url"] = url
super().__init__(requester, headers, attributes)
self.__completed = completed if isinstance(completed, bool) else False
self.__completeHeaders = {"Accept": accept} if accept else None
# complete this completable object when requester indicates non-laziness and
# neither of complete and headers are given
if requester.is_not_lazy and completed is None and not response_given:
self.complete()
def _initAttributes(self) -> None:
self._url: Attribute[str] = NotSet
def __eq__(self, other: Any) -> bool:
return (
other.__class__ is self.__class__
and other.requester.base_url == self.requester.base_url
and other._url.value.removeprefix(other.requester.base_url)
== self._url.value.removeprefix(self.requester.base_url)
)
def __hash__(self) -> int:
return hash(self._url.value)
def __ne__(self, other: Any) -> bool:
return not self == other
@property
def completed(self) -> bool:
return self.__completed
@property
def raw_data(self) -> dict[str, Any]:
"""
:type: dict
"""
self._completeIfNeeded()
return super().raw_data
@property
def raw_headers(self) -> dict[str, str | int]:
"""
:type: dict
"""
self._completeIfNeeded()
return super().raw_headers
@property
def url(self) -> str:
self._completeIfNotSet(self._url)
return self._url.value
def complete(self) -> Self:
self._completeIfNeeded()
return self
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, parameters: dict[str, Any] | None = None) -> None:
if self._url.value is None:
raise IncompletableObject(400, message="Cannot complete object as it contains no URL")
headers, data = self._requester.requestJsonAndCheck(
"GET", self._url.value, parameters=parameters, headers=self.__completeHeaders
)
self._storeAndUseAttributes(headers, data)
self._set_complete()
def _set_complete(self) -> None:
self.__completed = True
def update(
self, additional_headers: dict[str, Any] | None = None, parameters: dict[str, Any] | None = 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, parameters=parameters, 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
def _useAttributes(self, attributes: dict[str, Any]) -> None:
# populate url attribute with self-link
if "url" not in attributes:
self_link = attributes.get("_links", {}).get("self", {})
if self_link:
if isinstance(self_link, str):
attributes["url"] = self_link
elif isinstance(self_link, dict):
href = self_link.get("href")
if href:
attributes["url"] = href
if "url" in attributes: # pragma no branch
self._url = self._makeStringAttribute(attributes["url"])
class CompletableGithubObjectWithPaginatedProperty(CompletableGithubObject):
"""
A CompletableGithubObject that has a property that is subject to pagination.
An instance created from a Requester with a non-default value for ``per_page`` must have the
``per_page`` value in the URL in order for the paginated property to use the ``per_page`` value.
"""
def __init__(
self,
requester: Requester,
headers: dict[str, str | int] | None = None,
attributes: dict[str, Any] | None = None,
completed: bool | None = None,
*,
url: str | None = None,
accept: str | None = None,
per_page: int | None = None,
):
assert per_page is None or isinstance(per_page, int) and per_page > 0, per_page
# we set page=1 to get pagination links, PaginatedList can work from there
self.__pagination_parameters = {"page": 1}
if per_page is not None:
# we set the given per_page
self.__pagination_parameters["per_page"] = per_page
else:
# we use the per_page explicitly configured with the Requester
if requester.per_page != Consts.DEFAULT_PER_PAGE:
self.__pagination_parameters["per_page"] = requester.per_page
else:
# we use the default (no) per_page (not Consts.DEFAULT_PER_PAGE, the URL might have a different default)
pass
super().__init__(requester, headers, attributes, completed, url=url, accept=accept)
@property
def _pagination_parameters(self) -> dict[str, Any]:
return self.__pagination_parameters
def _pagination_parameters_with(self, page: int, per_page: int | None) -> dict[str, Any]:
assert page > 0, page
assert per_page is None or isinstance(per_page, int) and per_page > 0, per_page
parameters = self._pagination_parameters.copy()
parameters["page"] = page
if per_page is not None:
parameters["per_page"] = per_page
return parameters
def _complete(self, parameters: dict[str, Any] | None = None) -> None:
# inject pagination parameters into the complete request
parameters = {**parameters} if parameters else {}
parameters.update(**self.__pagination_parameters)
super()._complete(parameters=parameters)
def update(
self, additional_headers: dict[str, Any] | None = None, parameters: dict[str, Any] | None = None
) -> bool:
# inject pagination parameters into the complete request
parameters = {**parameters} if parameters else {}
parameters.update(**self.__pagination_parameters)
return super().update(parameters=parameters)
Param = ParamSpec("Param")
RetType = TypeVar("RetType")
# decorator to annotate methods with OpenAPI mapping information
def method_parameter(
*, name: str, required: bool = False, merge: list[str] | None = None, docstring_prepend: str | None = None
) -> Callable[[Callable[Param, RetType]], Callable[Param, RetType]]:
def method_parameter_decorator(fn: Callable[Param, RetType]) -> Callable[Param, RetType]:
return fn
return method_parameter_decorator
# decorator to annotate methods with OpenAPI mapping information
def method_returns(
*, schema_property: str | None = None
) -> Callable[[Callable[Param, RetType]], Callable[Param, RetType]]:
def method_returns_decorator(fn: Callable[Param, RetType]) -> Callable[Param, RetType]:
return fn
return method_returns_decorator
# decorator to annotate methods with OpenAPI mapping information
def openapi_parameter(
*,
name: str,
matches: str | None = None,
type: str | None = None,
input: bool | None = None,
docstring_prepend: str | None = None,
) -> Callable[[Callable[Param, RetType]], Callable[Param, RetType]]:
def openapi_parameter_decorator(fn: Callable[Param, RetType]) -> Callable[Param, RetType]:
return fn
return openapi_parameter_decorator
# decorator to annotate methods with OpenAPI mapping information
def ignore_return_type(*, ignore_type: str) -> Callable[[Callable[Param, RetType]], Callable[Param, RetType]]:
def ignore_return_types_decorator(fn: Callable[Param, RetType]) -> Callable[Param, RetType]:
return fn
return ignore_return_types_decorator
You can’t perform that action at this time.