-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathRequester.py
More file actions
1424 lines (1220 loc) · 56.1 KB
/
Requester.py
File metadata and controls
1424 lines (1220 loc) · 56.1 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
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
############################ Copyrights and license ############################
# #
# Copyright 2012 Andrew Bettison <andrewb@zip.com.au> #
# Copyright 2012 Dima Kukushkin <dima@kukushkin.me> #
# Copyright 2012 Michael Woodworth <mwoodworth@upverter.com> #
# Copyright 2012 Petteri Muilu <pmuilu@xena.(none)> #
# Copyright 2012 Steve English <steve.english@navetas.com> #
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2012 Zearin <zearin@gonk.net> #
# Copyright 2013 AKFish <akfish@gmail.com> #
# Copyright 2013 Cameron White <cawhite@pdx.edu> #
# Copyright 2013 Ed Jackson <ed.jackson@gmail.com> #
# Copyright 2013 Jonathan J Hunt <hunt@braincorporation.com> #
# Copyright 2013 Mark Roddy <markroddy@gmail.com> #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2014 Jimmy Zelinskie <jimmyzelinskie@gmail.com> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2015 Brian Eugley <Brian.Eugley@capitalone.com> #
# Copyright 2015 Daniel Pocock <daniel@pocock.pro> #
# Copyright 2016 Denis K <f1nal@cgaming.org> #
# Copyright 2016 Jared K. Smith <jaredsmith@jaredsmith.net> #
# Copyright 2016 Mathieu Mitchell <mmitchell@iweb.com> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2017 Chris McBride <thehighlander@users.noreply.github.com> #
# Copyright 2017 Hugo <hugovk@users.noreply.github.com> #
# Copyright 2017 Simon <spam@esemi.ru> #
# Copyright 2018 Arda Kuyumcu <kuyumcuarda@gmail.com> #
# Copyright 2018 Dylan <djstein@ncsu.edu> #
# Copyright 2018 Maarten Fonville <mfonville@users.noreply.github.com> #
# Copyright 2018 Mike Miller <github@mikeage.net> #
# Copyright 2018 R1kk3r <R1kk3r@users.noreply.github.com> #
# Copyright 2018 Shubham Singh <41840111+singh811@users.noreply.github.com> #
# Copyright 2018 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2018 Tuuu Nya <yuzesheji@qq.com> #
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 sfdye <tsfdye@gmail.com> #
# Copyright 2019 Isac Souza <isouza@daitan.com> #
# Copyright 2019 Rigas Papathanasopoulos <rigaspapas@gmail.com> #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2020 Jesse Li <jesse.li2002@gmail.com> #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2021 Amador Pahim <apahim@redhat.com> #
# Copyright 2021 Mark Walker <mark.walker@realbuzz.com> #
# Copyright 2021 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2022 Liuyang Wan <tsfdye@gmail.com> #
# Copyright 2023 Denis Blanchette <dblanchette@coveo.com> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Heitor Polidoro <heitor.polidoro@gmail.com> #
# Copyright 2023 Hemslo Wang <hemslo.wang@gmail.com> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Phillip Tran <phillip.qtr@gmail.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2023 adosibalo <94008816+adosibalo@users.noreply.github.com> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2024 Jonathan Kliem <jonathan.kliem@gmail.com> #
# Copyright 2024 Kobbi Gal <85439776+kgal-pan@users.noreply.github.com> #
# Copyright 2024 Min RK <benjaminrk@gmail.com> #
# Copyright 2025 Alec Ostrander <alec.ostrander@gmail.com> #
# Copyright 2025 Chris Kuehl <ckuehl@ckuehl.me> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2025 Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> #
# Copyright 2025 Jakub Smolar <jakub.smolar@scylladb.com> #
# Copyright 2025 Neel Malik <41765022+neel-m@users.noreply.github.com> #
# Copyright 2025 Timothy Klopotoski <tklopotoski@ebsco.com> #
# Copyright 2026 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 io
import json
import logging
import mimetypes
import os
import re
import threading
import time
import urllib
import urllib.parse
from collections import deque
from collections.abc import Callable, ItemsView, Iterator
from datetime import datetime, timezone
from io import IOBase
from typing import TYPE_CHECKING, Any, BinaryIO, Deque, Generic, TypeVar
import requests
import requests.adapters
from urllib3 import Retry
import github.Consts as Consts
import github.GithubException
import github.GithubException as GithubException
from github.GithubObject import Opt, as_rest_api_attributes, is_undefined
if TYPE_CHECKING:
from .AppAuthentication import AppAuthentication
from .Auth import Auth
from .GithubObject import GithubObject
from .InstallationAuthorization import InstallationAuthorization
T = TypeVar("T")
T_gh = TypeVar("T_gh", bound="GithubObject")
# For App authentication, time remaining before token expiration to request a new one
ACCESS_TOKEN_REFRESH_THRESHOLD_SECONDS = 20
class RequestsResponse:
# mimic the httplib response object
def __init__(self, r: requests.Response):
self.status = r.status_code
self.headers = r.headers
self.response = r
def getheaders(self) -> ItemsView[str, str]:
return self.headers.items()
def read(self) -> str:
return self.response.text
def iter_content(self, chunk_size: int | None = 1) -> Iterator:
return self.response.iter_content(chunk_size=chunk_size)
def raise_for_status(self) -> None:
self.response.raise_for_status()
class HTTPSRequestsConnectionClass:
retry: int | Retry
# mimic the httplib connection object
def __init__(
self,
host: str,
port: int | None = None,
strict: bool = False,
timeout: int | None = None,
retry: int | Retry | None = None,
pool_size: int | None = None,
**kwargs: Any,
) -> None:
self.port = port if port else 443
self.host = host
self.protocol = "https"
self.timeout = timeout
self.verify = kwargs.get("verify", True)
self.session = requests.Session()
# having Session.auth set something other than None disables falling back to .netrc file
# https://github.com/psf/requests/blob/d63e94f552ebf77ccf45d97e5863ac46500fa2c7/src/requests/sessions.py#L480-L481
# see https://github.com/PyGithub/PyGithub/pull/2703
self.session.auth = Requester.noopAuth
if retry is None:
self.retry = requests.adapters.DEFAULT_RETRIES
else:
self.retry = retry
if pool_size is None:
self.pool_size = requests.adapters.DEFAULT_POOLSIZE
else:
self.pool_size = pool_size
self.adapter = requests.adapters.HTTPAdapter(
max_retries=self.retry,
pool_connections=self.pool_size,
pool_maxsize=self.pool_size,
)
self.session.mount("https://", self.adapter)
def request(
self,
verb: str,
url: str,
input: str | io.BufferedReader | None,
headers: dict[str, str],
stream: bool = False,
) -> None:
self.verb = verb
self.url = url
self.input = input
self.headers = headers
self.stream = stream
def getresponse(self) -> RequestsResponse:
verb = getattr(self.session, self.verb.lower())
url = f"{self.protocol}://{self.host}:{self.port}{self.url}"
r = verb(
url,
headers=self.headers,
data=self.input,
timeout=self.timeout,
verify=self.verify,
allow_redirects=False,
)
return RequestsResponse(r)
def close(self) -> None:
self.session.close()
class HTTPRequestsConnectionClass:
# mimic the httplib connection object
def __init__(
self,
host: str,
port: int | None = None,
strict: bool = False,
timeout: int | None = None,
retry: int | Retry | None = None,
pool_size: int | None = None,
**kwargs: Any,
):
self.port = port if port else 80
self.host = host
self.protocol = "http"
self.timeout = timeout
self.verify = kwargs.get("verify", True)
self.session = requests.Session()
# having Session.auth set something other than None disables falling back to .netrc file
# https://github.com/psf/requests/blob/d63e94f552ebf77ccf45d97e5863ac46500fa2c7/src/requests/sessions.py#L480-L481
# see https://github.com/PyGithub/PyGithub/pull/2703
self.session.auth = Requester.noopAuth
if retry is None:
self.retry = requests.adapters.DEFAULT_RETRIES
else:
self.retry = retry # type: ignore
if pool_size is None:
self.pool_size = requests.adapters.DEFAULT_POOLSIZE
else:
self.pool_size = pool_size
self.adapter = requests.adapters.HTTPAdapter(
max_retries=self.retry,
pool_connections=self.pool_size,
pool_maxsize=self.pool_size,
)
self.session.mount("http://", self.adapter)
def request(self, verb: str, url: str, input: None, headers: dict[str, str], stream: bool = False) -> None:
self.verb = verb
self.url = url
self.input = input
self.headers = headers
self.stream = stream
def getresponse(self) -> RequestsResponse:
verb = getattr(self.session, self.verb.lower())
url = f"{self.protocol}://{self.host}:{self.port}{self.url}"
r = verb(
url,
headers=self.headers,
data=self.input,
timeout=self.timeout,
verify=self.verify,
allow_redirects=False,
)
return RequestsResponse(r)
def close(self) -> None:
self.session.close()
class Requester:
__installation_authorization: InstallationAuthorization | None
__app_auth: AppAuthentication | None
__httpConnectionClass = HTTPRequestsConnectionClass
__httpsConnectionClass = HTTPSRequestsConnectionClass
__persist = True
__logger: logging.Logger | None = None
_frameBuffer: list[Any]
@staticmethod
def noopAuth(request: requests.models.PreparedRequest) -> requests.models.PreparedRequest:
return request
@classmethod
def injectConnectionClasses(
cls,
httpConnectionClass: type[HTTPRequestsConnectionClass],
httpsConnectionClass: type[HTTPSRequestsConnectionClass],
) -> None:
cls.__persist = False
cls.__httpConnectionClass = httpConnectionClass
cls.__httpsConnectionClass = httpsConnectionClass
@classmethod
def resetConnectionClasses(cls) -> None:
cls.__persist = True
cls.__httpConnectionClass = HTTPRequestsConnectionClass
cls.__httpsConnectionClass = HTTPSRequestsConnectionClass
@classmethod
def injectLogger(cls, logger: logging.Logger) -> None:
cls.__logger = logger
@classmethod
def resetLogger(cls) -> None:
cls.__logger = None
#############################################################
# For Debug
@classmethod
def setDebugFlag(cls, flag: bool) -> None:
cls.DEBUG_FLAG = flag
@classmethod
def setOnCheckMe(cls, onCheckMe: Callable) -> None:
cls.ON_CHECK_ME = onCheckMe
DEBUG_FLAG = False
DEBUG_FRAME_BUFFER_SIZE = 1024
DEBUG_HEADER_KEY = "DEBUG_FRAME"
ON_CHECK_ME: Callable | None = None
def NEW_DEBUG_FRAME(self, requestHeader: dict[str, str]) -> None:
"""
Initialize a debug frame with requestHeader
Frame count is updated and will be attached to respond header
The structure of a frame: [requestHeader, statusCode, responseHeader, raw_data]
Some of them may be None
"""
if self.DEBUG_FLAG: # pragma no branch (Flag always set in tests)
new_frame = [requestHeader, None, None, None]
if self._frameCount < self.DEBUG_FRAME_BUFFER_SIZE - 1: # pragma no branch (Should be covered)
self._frameBuffer.append(new_frame)
else:
self._frameBuffer[0] = new_frame # pragma no cover (Should be covered)
self._frameCount = len(self._frameBuffer) - 1
def DEBUG_ON_RESPONSE(self, statusCode: int, responseHeader: dict[str, str | int], data: str) -> None:
"""
Update current frame with response Current frame index will be attached to responseHeader.
"""
if self.DEBUG_FLAG: # pragma no branch (Flag always set in tests)
self._frameBuffer[self._frameCount][1:4] = [
statusCode,
responseHeader,
data,
]
responseHeader[self.DEBUG_HEADER_KEY] = self._frameCount
def check_me(self, obj: GithubObject) -> None:
if self.DEBUG_FLAG and self.ON_CHECK_ME is not None: # pragma no branch (Flag always set in tests)
frame = None
if self.DEBUG_HEADER_KEY in obj._headers:
frame_index = obj._headers[self.DEBUG_HEADER_KEY]
frame = self._frameBuffer[frame_index] # type: ignore
self.ON_CHECK_ME(obj, frame)
def _initializeDebugFeature(self) -> None:
self._frameCount = 0
self._frameBuffer = []
#############################################################
_frameCount: int
__connectionClass: type[HTTPRequestsConnectionClass] | type[HTTPSRequestsConnectionClass]
__hostname: str
__authorizationHeader: str | None
__seconds_between_requests: float | None
__seconds_between_writes: float | None
# keep arguments in-sync with github.MainClass and GithubIntegration
def __init__(
self,
auth: Auth | None,
base_url: str,
timeout: int,
user_agent: str,
per_page: int,
verify: bool | str,
retry: int | Retry | None,
pool_size: int | None,
seconds_between_requests: float | None = None,
seconds_between_writes: float | None = None,
lazy: bool = False,
):
self._initializeDebugFeature()
self.__auth = auth
self.__base_url = base_url
o = urllib.parse.urlparse(base_url)
self.__graphql_prefix = self.get_graphql_prefix(o.path)
self.__graphql_url = urllib.parse.urlunparse(o._replace(path=self.__graphql_prefix))
self.__hostname = o.hostname # type: ignore
if base_url == Consts.DEFAULT_BASE_URL:
self.__domains = ["github.com", "githubusercontent.com"]
else:
self.__domains = list({o.hostname, o.hostname.removeprefix("api.")}) # type: ignore
self.__port = o.port
self.__prefix = o.path
self.__timeout = timeout
self.__retry = retry # NOTE: retry can be either int or an urllib3 Retry object
self.__pool_size = pool_size
self.__seconds_between_requests = seconds_between_requests
self.__seconds_between_writes = seconds_between_writes
self.__last_requests: dict[str, float] = dict()
self.__scheme = o.scheme
if o.scheme == "https":
self.__connectionClass = self.__httpsConnectionClass
elif o.scheme == "http":
self.__connectionClass = self.__httpConnectionClass
else:
assert False, "Unknown URL scheme"
self.__connection: HTTPRequestsConnectionClass | HTTPSRequestsConnectionClass | None = None
self.__connection_lock = threading.Lock()
self.__custom_connections: Deque[HTTPRequestsConnectionClass | HTTPSRequestsConnectionClass] = deque()
self.rate_limiting = (-1, -1)
self.rate_limiting_resettime = 0
self.FIX_REPO_GET_GIT_REF = True
assert isinstance(per_page, int) and per_page > 0, per_page
self.per_page = per_page
self.oauth_scopes = None
assert user_agent is not None, (
"github now requires a user-agent. "
"See https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required"
)
self.__userAgent = user_agent
self.__verify = verify
self.__lazy = lazy
self.__installation_authorization = None
# provide auth implementations that require a requester with this requester
if isinstance(self.__auth, WithRequester):
self.__auth.withRequester(self)
def __getstate__(self) -> dict[str, Any]:
state = self.__dict__.copy()
# __connection_lock is not picklable
del state["_Requester__connection_lock"]
# __connection is not usable on remote, so ignore it
del state["_Requester__connection"]
# __custom_connections is not usable on remote, so ignore it
del state["_Requester__custom_connections"]
return state
def __setstate__(self, state: dict[str, Any]) -> None:
self.__dict__.update(state)
self.__connection_lock = threading.Lock()
self.__connection = None
self.__custom_connections = deque()
@staticmethod
# replace with str.removesuffix once support for Python 3.8 is dropped
def remove_suffix(string: str, suffix: str) -> str:
if string.endswith(suffix):
return string[: -len(suffix)]
return string
@staticmethod
def get_graphql_prefix(path: str | None) -> str:
if path is None or path in ["", "/"]:
path = ""
if path.endswith(("/v3", "/v3/")):
path = Requester.remove_suffix(path, "/")
path = Requester.remove_suffix(path, "/v3")
return path + "/graphql"
@staticmethod
def get_parameters_of_url(url: str) -> dict[str, list]:
query = urllib.parse.urlparse(url)[4]
return urllib.parse.parse_qs(query)
@staticmethod
def add_parameters_to_url(
url: str,
parameters: dict[str, Any],
) -> str:
scheme, netloc, url, params, query, fragment = urllib.parse.urlparse(url)
url_params = urllib.parse.parse_qs(query)
# union parameters in url with given parameters, the latter has precedence
url_params.update(**{k: v if isinstance(v, list) else [v] for k, v in parameters.items()})
parameter_list = [(key, value) for key, values in url_params.items() for value in values]
# remove query from url
url = urllib.parse.urlunparse((scheme, netloc, url, params, "", fragment))
if len(parameter_list) == 0:
return url
else:
# we need deterministic URLs for stable test assertions
return f"{url}?{urllib.parse.urlencode(sorted(parameter_list))}"
def close(self) -> None:
"""
Close the connection to the server.
"""
with self.__connection_lock:
if self.__connection is not None:
self.__connection.close()
self.__connection = None
while self.__custom_connections:
self.__custom_connections.popleft().close()
@property
def kwargs(self) -> dict[str, Any]:
"""
Returns arguments required to recreate this Requester with Requester.__init__, as well as with
MainClass.__init__ and GithubIntegration.__init__.
"""
return dict(
auth=self.__auth,
base_url=self.__base_url,
timeout=self.__timeout,
user_agent=self.__userAgent,
per_page=self.per_page,
verify=self.__verify,
retry=self.__retry,
pool_size=self.__pool_size,
seconds_between_requests=self.__seconds_between_requests,
seconds_between_writes=self.__seconds_between_writes,
lazy=self.__lazy,
)
@property
def base_url(self) -> str:
return self.__base_url
@property
def graphql_url(self) -> str:
return self.__graphql_url
@property
def scheme(self) -> str:
return self.__scheme
@property
def hostname(self) -> str:
return self.__hostname
@property
def hostname_and_port(self) -> str:
if self.__port is None:
return self.hostname
return f"{self.hostname}:{self.__port}"
@property
def auth(self) -> Auth | None:
return self.__auth
def withAuth(self, auth: Auth | None) -> Requester:
"""
Create a new requester instance with identical configuration but the given authentication method.
:param auth: authentication method
:return: new Requester instance
"""
kwargs = self.kwargs
kwargs.update(auth=auth)
return Requester(**kwargs)
@property
def is_lazy(self) -> bool:
return self.__lazy
@property
def is_not_lazy(self) -> bool:
return not self.__lazy
def withLazy(self, lazy: Opt[bool]) -> Requester:
"""
Create a new requester instance with identical configuration but the given lazy setting.
:param lazy: if True, completable objects created from this instance are lazy, as well as completable objects
created from those, and so on.
:return: new Requester instance if is_defined(lazy) and lazy != self.is_lazy, this instance otherwise
"""
if is_undefined(lazy) or self.is_lazy == lazy:
return self
kwargs = self.kwargs
kwargs.update(lazy=lazy)
return Requester(**kwargs)
def requestJsonAndCheck(
self,
verb: str,
url: str,
parameters: dict[str, Any] | None = None,
headers: dict[str, str] | None = None,
input: Any | None = None,
follow_302_redirect: bool = False,
) -> tuple[dict[str, Any], Any]:
"""
Send a request with JSON body.
:param input: request body, serialized to JSON if specified
:return: ``(headers: dict, JSON Response: Any)``
:raises: :class:`GithubException` for error status codes
"""
return self.__postProcess(
verb,
url,
*self.__check(
*self.requestJson(
verb,
url,
parameters,
headers,
input,
self.__customConnection(url),
follow_302_redirect=follow_302_redirect,
)
),
)
def requestMultipartAndCheck(
self,
verb: str,
url: str,
parameters: dict[str, Any] | None = None,
headers: dict[str, Any] | None = None,
input: dict[str, str] | None = None,
) -> tuple[dict[str, Any], dict[str, Any] | None]:
"""
Send a request with multi-part-encoded body.
:param input: request body, will be multi-part encoded if specified
:return: ``(headers: dict, JSON Response: Any)``
:raises: :class:`GithubException` for error status codes
"""
return self.__postProcess(
verb,
url,
*self.__check(*self.requestMultipart(verb, url, parameters, headers, input, self.__customConnection(url))),
)
def requestBlobAndCheck(
self,
verb: str,
url: str,
parameters: dict[str, str] | None = None,
headers: dict[str, str] | None = None,
input: str | None = None,
cnx: HTTPRequestsConnectionClass | HTTPSRequestsConnectionClass | None = None,
) -> tuple[dict[str, Any], dict[str, Any]]:
"""
Send a request with a file for the body.
:param input: path to a file to use for the request body
:return: ``(headers: dict, JSON Response: Any)``
:raises: :class:`GithubException` for error status codes
"""
return self.__postProcess(
verb,
url,
*self.__check(*self.requestBlob(verb, url, parameters, headers, input, self.__customConnection(url))),
)
@classmethod
def paths_of_dict(cls, d: dict) -> dict:
return {key: cls.paths_of_dict(val) if isinstance(val, dict) else None for key, val in d.items()}
def data_as_class(
self, headers: dict[str, Any], data: dict[str, Any], data_path: list[str], klass: type[T_gh]
) -> T_gh:
for item in data_path:
if item not in data:
raise RuntimeError(f"GraphQL path {data_path} not found in data: {self.paths_of_dict(data)}")
data = data[item]
if klass.is_rest():
data = as_rest_api_attributes(data)
return klass(self, headers, data)
def graphql_query(self, query: str, variables: dict[str, Any]) -> tuple[dict[str, Any], dict[str, Any]]:
"""
Queries the GraphQL API.
:param query: GraphQL query
:param variables: GraphQL variables
:return: ``(headers: dict, JSON Response: dict)``
:raises: :class:`GithubException` for error status codes
"""
input_ = {"query": query, "variables": variables}
response_headers, data = self.requestJsonAndCheck("POST", self.graphql_url, input=input_)
if "errors" in data:
if len(data["errors"]) == 1:
error = data["errors"][0]
if error.get("type") == "NOT_FOUND":
raise github.UnknownObjectException(404, data, response_headers, error.get("message"))
raise self.createException(400, response_headers, data)
return response_headers, data
def graphql_query_class(
self, query: str, variables: dict[str, Any], data_path: list[str], klass: type[T_gh]
) -> T_gh:
"""
Queries the GraphQL API, extracts data from a given path, populates and returns a PyGithub class instance.
Uses :func:`graphql_query` to query the GraphQL API.
:param query: GraphQL query
:param data_path: GraphQL path in the response to extract the properties for the class to return
:param klass: PyGithub class
:return: PyGithub class instance
:raises: :class:`GithubException` for error status codes
"""
headers, data = self.graphql_query(query, variables)
return self.data_as_class(headers, data, ["data"] + data_path, klass)
def graphql_node(self, node_id: str, output_schema: str, node_type: str) -> tuple[dict[str, Any], dict[str, Any]]:
"""
Fetches a GraphQL node by id in the give schema.
This sends the following GraphQL request::
query Q($id. ID!) {
node(id: $id) {
__typename
... on <node_type> {
<output_schema>
}
}
}
:param node_id: GraphQL node id
:param output_schema: The schema of the retrieved properties of the node, without enclosing curly brackets
:param node_type: The GraphQL node type
:return: ``(headers: dict, JSON Response: dict)``
:raises: :class:`GithubException` for error status codes
"""
if not output_schema.startswith("\n"):
output_schema = f" {output_schema} "
query = (
"""
query Q($id: ID!) {
node(id: $id) {
__typename
... on """
+ f"{node_type} {{{output_schema}}}"
+ """
}
}
"""
)
headers, data = self.graphql_query(query, {"id": node_id})
actual_node_type = data.get("data", {}).get("node", {}).get("__typename", node_type)
if actual_node_type != node_type:
raise github.GithubException(
400,
data,
message=f"Retrieved {node_type} object is of different type: {actual_node_type}",
)
return headers, data
def graphql_node_class(
self, node_id: str, output_schema: str, klass: type[T_gh], node_type: str | None = None
) -> T_gh:
"""
Fetches a GraphQL node by id in the give schema, and returns a PyGithub instance of the given class populated
with the retrieved properties.
Uses :func:`graph_node` to retrieve the GraphQl node.
:param node_id: GraphQL node id
:param output_schema: The schema of the retrieved properties of the node, without enclosing curly brackets
:param klass: PyGithub class
:param node_type: Optional GraphQL node type, defaults to the name of the PyGithub class
:return: PyGithub class instance
:raises: :class:`GithubException` for error status codes
"""
if node_type is None:
node_type = klass.__name__
headers, data = self.graphql_node(node_id, output_schema, node_type)
return self.data_as_class(headers, data, ["data", "node"], klass)
def graphql_named_mutation(
self, mutation_name: str, mutation_input: dict[str, Any], output_schema: str
) -> tuple[dict[str, Any], dict[str, Any]]:
"""
Send a GraphQL mutation to the GraphQL API.
This sends the following GraphQL request::
mutation Mutation($input: MutationNameInput!) {
mutationName(input: $input) {
<output_schema>
}
}
Uses :func:`graphql_query` to send the request to the GraphQL API.
:param mutation_name: name of the mutation
:param mutation_input: input data for the mutation
:param output_schema: The schema of the retrieved properties of the mutation, without enclosing curly brackets
:return: ``(headers: dict, JSON Response: dict)``
:raises: :class:`GithubException` for error status codes
"""
mutation_input_name = mutation_name[:1].upper() + mutation_name[1:] + "Input!"
query = f"mutation Mutation($input: {mutation_input_name}) {{ {mutation_name}(input: $input) {{ {output_schema} }} }}"
headers, data = self.graphql_query(query, {"input": mutation_input})
return headers, data.get("data", {}).get(mutation_name, {})
def graphql_named_mutation_class(
self, mutation_name: str, mutation_input: dict[str, Any], output_schema: str, item: str, klass: type[T_gh]
) -> T_gh:
"""
Send a GraphQL mutation to the GraphQL API, populates and returns a PyGithub class instance.
Uses :func:`graphql_named_mutation` to send the mutation to the GraphQL API.
:param mutation_name: name of the mutation
:param mutation_input: input data for the mutation
:param output_schema: The schema of the retrieved properties of the mutation, without enclosing curly brackets
:param item: property in the response to extract the properties for the class to return
:return: PyGithub class instance
:raises: :class:`GithubException` for error status codes
"""
headers, data = self.graphql_named_mutation(mutation_name, mutation_input, output_schema)
return self.data_as_class(headers, data, [item], klass)
def __check(
self,
status: int,
responseHeaders: dict[str, Any],
output: str,
) -> tuple[dict[str, Any], Any]:
data = self.__structuredFromJson(output)
if status >= 400:
raise self.createException(status, responseHeaders, data)
return responseHeaders, data
def __postProcess(
self, verb: str, url: str, responseHeaders: dict[str, Any], data: Any
) -> tuple[dict[str, Any], Any]:
if verb == "GET" and isinstance(data, dict) and "url" not in data:
if "_links" in data and "self" in data["_links"] and data["_links"]["self"]:
self_link = data["_links"]["self"]
if isinstance(self_link, str):
data["url"] = self_link
elif isinstance(self_link, dict):
href = self_link.get("href")
if href:
data["url"] = href
else:
data["url"] = url
return responseHeaders, data
@classmethod
def __hostnameHasDomain(cls, hostname: str, domain_or_domains: str | list[str]) -> bool:
if isinstance(domain_or_domains, str):
if hostname == domain_or_domains:
return True
domain_suffix = f".{domain_or_domains}"
return hostname.endswith(domain_suffix)
return any(cls.__hostnameHasDomain(hostname, d) for d in domain_or_domains)
def __assertUrlAllowed(self, url: str) -> None:
o = urllib.parse.urlparse(url)
assert o.hostname is not None
if o.hostname == self.__hostname:
prefixes = [self.__prefix, self.__graphql_prefix, "/api/", "/login/oauth"]
assert o.path.startswith(tuple(prefixes)), o.path
assert o.port == self.__port, o.port
else:
assert self.__hostnameHasDomain(o.hostname, self.__domains), o.hostname
def __customConnection(self, url: str) -> HTTPRequestsConnectionClass | HTTPSRequestsConnectionClass | None:
cnx: HTTPRequestsConnectionClass | HTTPSRequestsConnectionClass | None = None
if not url.startswith("/"):
# check URL is allowed
self.__assertUrlAllowed(url)
# only return connection if url deviates from base_url
o = urllib.parse.urlparse(url)
if (
o.hostname != self.__hostname
or (o.port and o.port != self.__port)
or (o.scheme != self.__scheme and not (o.scheme == "https" and self.__scheme == "http"))
): # issue80
if o.scheme == "http":
cnx = self.__httpConnectionClass(
o.hostname, # type: ignore
o.port,
retry=self.__retry,
pool_size=self.__pool_size,
)
self.__custom_connections.append(cnx)
elif o.scheme == "https":
cnx = self.__httpsConnectionClass(
o.hostname, # type: ignore
o.port,
retry=self.__retry,
pool_size=self.__pool_size,
)
self.__custom_connections.append(cnx)
return cnx
@classmethod
def createException(
cls,
status: int,
headers: dict[str, Any],
output: dict[str, Any],
) -> GithubException.GithubException:
message = output.get("message") if output else None
lc_message = message.lower() if message else ""
msg = None
exc = GithubException.GithubException
if status == 401 and lc_message == "bad credentials":
exc = GithubException.BadCredentialsException
elif status == 401 and Consts.headerOTP in headers and re.match(r".*required.*", headers[Consts.headerOTP]):
exc = GithubException.TwoFactorException
elif status == 403 and lc_message.startswith("missing or invalid user agent string"):
exc = GithubException.BadUserAgentException
elif status == 403 and cls.isRateLimitError(lc_message):
exc = GithubException.RateLimitExceededException
elif status == 404 and ("not found" in lc_message or "no object found" in lc_message):
exc = GithubException.UnknownObjectException
if lc_message != "not found":
msg = message
else:
# for general GithubException, provide the actual message
msg = message
return exc(status, output, headers, msg)
@classmethod
def isRateLimitError(cls, message: str) -> bool:
return cls.isPrimaryRateLimitError(message) or cls.isSecondaryRateLimitError(message)
@classmethod
def isPrimaryRateLimitError(cls, message: str) -> bool:
if not message:
return False
message = message.lower()
return message.startswith("api rate limit exceeded")
@classmethod
def isSecondaryRateLimitError(cls, message: str) -> bool:
if not message:
return False
message = message.lower()
return (
message.startswith("you have exceeded a secondary rate limit")
or message.endswith("please retry your request again later.")
or message.endswith("please wait a few minutes before you try again.")
)
def __structuredFromJson(self, data: str) -> Any:
if len(data) == 0:
return None
else:
if isinstance(data, bytes):
data = data.decode("utf-8")
try:
return json.loads(data)
except ValueError:
if data.startswith("{") or data.startswith("["):
raise