forked from python-gitlab/python-gitlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient.py
More file actions
1479 lines (1276 loc) · 53.8 KB
/
client.py
File metadata and controls
1479 lines (1276 loc) · 53.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
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
"""Wrapper for the GitLab API."""
from __future__ import annotations
import os
import re
from typing import (
Any,
BinaryIO,
cast,
Dict,
List,
Optional,
Tuple,
Type,
TYPE_CHECKING,
Union,
)
from urllib import parse
import requests
import gitlab
import gitlab.config
import gitlab.const
import gitlab.exceptions
from gitlab import _backends, utils
try:
import gql
import gql.transport.exceptions
import graphql
import httpx
from ._backends.graphql import GitlabAsyncTransport, GitlabTransport
_GQL_INSTALLED = True
except ImportError: # pragma: no cover
_GQL_INSTALLED = False
REDIRECT_MSG = (
"python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
"your GitLab URL to the correct URL to avoid issues. The redirection was from: "
"{source!r} to {target!r}"
)
# https://docs.gitlab.com/ee/api/#offset-based-pagination
_PAGINATION_URL = (
f"https://python-gitlab.readthedocs.io/en/v{gitlab.__version__}/"
f"api-usage.html#pagination"
)
class Gitlab:
"""Represents a GitLab server connection.
Args:
url: The URL of the GitLab server (defaults to https://gitlab.com).
private_token: The user private token
oauth_token: An oauth token
job_token: A CI job token
ssl_verify: Whether SSL certificates should be validated. If
the value is a string, it is the path to a CA file used for
certificate validation.
timeout: Timeout to use for requests to the GitLab server.
http_username: Username for HTTP authentication
http_password: Password for HTTP authentication
api_version: Gitlab API version to use (support for 4 only)
pagination: Can be set to 'keyset' to use keyset pagination
order_by: Set order_by globally
user_agent: A custom user agent to use for making HTTP requests.
retry_transient_errors: Whether to retry after 500, 502, 503, 504
or 52x responses. Defaults to False.
keep_base_url: keep user-provided base URL for pagination if it
differs from response headers
Keyword Args:
requests.Session session: HTTP Requests Session
RequestsBackend backend: Backend that will be used to make http requests
"""
def __init__(
self,
url: Optional[str] = None,
private_token: Optional[str] = None,
oauth_token: Optional[str] = None,
job_token: Optional[str] = None,
ssl_verify: Union[bool, str] = True,
http_username: Optional[str] = None,
http_password: Optional[str] = None,
timeout: Optional[float] = None,
api_version: str = "4",
per_page: Optional[int] = None,
pagination: Optional[str] = None,
order_by: Optional[str] = None,
user_agent: str = gitlab.const.USER_AGENT,
retry_transient_errors: bool = False,
keep_base_url: bool = False,
**kwargs: Any,
) -> None:
self._api_version = str(api_version)
self._server_version: Optional[str] = None
self._server_revision: Optional[str] = None
self._base_url = utils.get_base_url(url)
self._url = f"{self._base_url}/api/v{api_version}"
#: Timeout to use for requests to gitlab server
self.timeout = timeout
self.retry_transient_errors = retry_transient_errors
self.keep_base_url = keep_base_url
#: Headers that will be used in request to GitLab
self.headers = {"User-Agent": user_agent}
#: Whether SSL certificates should be validated
self.ssl_verify = ssl_verify
self.private_token = private_token
self.http_username = http_username
self.http_password = http_password
self.oauth_token = oauth_token
self.job_token = job_token
self._set_auth_info()
#: Create a session object for requests
_backend: Type[_backends.DefaultBackend] = kwargs.pop(
"backend", _backends.DefaultBackend
)
self._backend = _backend(**kwargs)
self.session = self._backend.client
self.per_page = per_page
self.pagination = pagination
self.order_by = order_by
# We only support v4 API at this time
if self._api_version not in ("4",):
raise ModuleNotFoundError(f"gitlab.v{self._api_version}.objects")
# NOTE: We must delay import of gitlab.v4.objects until now or
# otherwise it will cause circular import errors
from gitlab.v4 import objects
self._objects = objects
self.user: Optional[objects.CurrentUser] = None
self.broadcastmessages = objects.BroadcastMessageManager(self)
"""See :class:`~gitlab.v4.objects.BroadcastMessageManager`"""
self.bulk_imports = objects.BulkImportManager(self)
"""See :class:`~gitlab.v4.objects.BulkImportManager`"""
self.bulk_import_entities = objects.BulkImportAllEntityManager(self)
"""See :class:`~gitlab.v4.objects.BulkImportAllEntityManager`"""
self.ci_lint = objects.CiLintManager(self)
"""See :class:`~gitlab.v4.objects.CiLintManager`"""
self.deploykeys = objects.DeployKeyManager(self)
"""See :class:`~gitlab.v4.objects.DeployKeyManager`"""
self.deploytokens = objects.DeployTokenManager(self)
"""See :class:`~gitlab.v4.objects.DeployTokenManager`"""
self.geonodes = objects.GeoNodeManager(self)
"""See :class:`~gitlab.v4.objects.GeoNodeManager`"""
self.gitlabciymls = objects.GitlabciymlManager(self)
"""See :class:`~gitlab.v4.objects.GitlabciymlManager`"""
self.gitignores = objects.GitignoreManager(self)
"""See :class:`~gitlab.v4.objects.GitignoreManager`"""
self.groups = objects.GroupManager(self)
"""See :class:`~gitlab.v4.objects.GroupManager`"""
self.hooks = objects.HookManager(self)
"""See :class:`~gitlab.v4.objects.HookManager`"""
self.issues = objects.IssueManager(self)
"""See :class:`~gitlab.v4.objects.IssueManager`"""
self.issues_statistics = objects.IssuesStatisticsManager(self)
"""See :class:`~gitlab.v4.objects.IssuesStatisticsManager`"""
self.keys = objects.KeyManager(self)
"""See :class:`~gitlab.v4.objects.KeyManager`"""
self.ldapgroups = objects.LDAPGroupManager(self)
"""See :class:`~gitlab.v4.objects.LDAPGroupManager`"""
self.licenses = objects.LicenseManager(self)
"""See :class:`~gitlab.v4.objects.LicenseManager`"""
self.namespaces = objects.NamespaceManager(self)
"""See :class:`~gitlab.v4.objects.NamespaceManager`"""
self.mergerequests = objects.MergeRequestManager(self)
"""See :class:`~gitlab.v4.objects.MergeRequestManager`"""
self.notificationsettings = objects.NotificationSettingsManager(self)
"""See :class:`~gitlab.v4.objects.NotificationSettingsManager`"""
self.projects = objects.ProjectManager(self)
"""See :class:`~gitlab.v4.objects.ProjectManager`"""
self.registry_repositories = objects.RegistryRepositoryManager(self)
"""See :class:`~gitlab.v4.objects.RegistryRepositoryManager`"""
self.runners = objects.RunnerManager(self)
"""See :class:`~gitlab.v4.objects.RunnerManager`"""
self.runners_all = objects.RunnerAllManager(self)
"""See :class:`~gitlab.v4.objects.RunnerManager`"""
self.settings = objects.ApplicationSettingsManager(self)
"""See :class:`~gitlab.v4.objects.ApplicationSettingsManager`"""
self.appearance = objects.ApplicationAppearanceManager(self)
"""See :class:`~gitlab.v4.objects.ApplicationAppearanceManager`"""
self.sidekiq = objects.SidekiqManager(self)
"""See :class:`~gitlab.v4.objects.SidekiqManager`"""
self.snippets = objects.SnippetManager(self)
"""See :class:`~gitlab.v4.objects.SnippetManager`"""
self.users = objects.UserManager(self)
"""See :class:`~gitlab.v4.objects.UserManager`"""
self.todos = objects.TodoManager(self)
"""See :class:`~gitlab.v4.objects.TodoManager`"""
self.dockerfiles = objects.DockerfileManager(self)
"""See :class:`~gitlab.v4.objects.DockerfileManager`"""
self.events = objects.EventManager(self)
"""See :class:`~gitlab.v4.objects.EventManager`"""
self.audit_events = objects.AuditEventManager(self)
"""See :class:`~gitlab.v4.objects.AuditEventManager`"""
self.features = objects.FeatureManager(self)
"""See :class:`~gitlab.v4.objects.FeatureManager`"""
self.pagesdomains = objects.PagesDomainManager(self)
"""See :class:`~gitlab.v4.objects.PagesDomainManager`"""
self.user_activities = objects.UserActivitiesManager(self)
"""See :class:`~gitlab.v4.objects.UserActivitiesManager`"""
self.applications = objects.ApplicationManager(self)
"""See :class:`~gitlab.v4.objects.ApplicationManager`"""
self.variables = objects.VariableManager(self)
"""See :class:`~gitlab.v4.objects.VariableManager`"""
self.personal_access_tokens = objects.PersonalAccessTokenManager(self)
"""See :class:`~gitlab.v4.objects.PersonalAccessTokenManager`"""
self.topics = objects.TopicManager(self)
"""See :class:`~gitlab.v4.objects.TopicManager`"""
self.statistics = objects.ApplicationStatisticsManager(self)
"""See :class:`~gitlab.v4.objects.ApplicationStatisticsManager`"""
def __enter__(self) -> "Gitlab":
return self
def __exit__(self, *args: Any) -> None:
self.session.close()
def __getstate__(self) -> Dict[str, Any]:
state = self.__dict__.copy()
state.pop("_objects")
return state
def __setstate__(self, state: Dict[str, Any]) -> None:
self.__dict__.update(state)
# We only support v4 API at this time
if self._api_version not in ("4",):
raise ModuleNotFoundError(
f"gitlab.v{self._api_version}.objects"
) # pragma: no cover, dead code currently
# NOTE: We must delay import of gitlab.v4.objects until now or
# otherwise it will cause circular import errors
from gitlab.v4 import objects
self._objects = objects
@property
def url(self) -> str:
"""The user-provided server URL."""
return self._base_url
@property
def api_url(self) -> str:
"""The computed API base URL."""
return self._url
@property
def api_version(self) -> str:
"""The API version used (4 only)."""
return self._api_version
@classmethod
def from_config(
cls,
gitlab_id: Optional[str] = None,
config_files: Optional[List[str]] = None,
**kwargs: Any,
) -> "Gitlab":
"""Create a Gitlab connection from configuration files.
Args:
gitlab_id: ID of the configuration section.
config_files list[str]: List of paths to configuration files.
kwargs:
session requests.Session: Custom requests Session
Returns:
A Gitlab connection.
Raises:
gitlab.config.GitlabDataError: If the configuration is not correct.
"""
config = gitlab.config.GitlabConfigParser(
gitlab_id=gitlab_id, config_files=config_files
)
return cls(
config.url,
private_token=config.private_token,
oauth_token=config.oauth_token,
job_token=config.job_token,
ssl_verify=config.ssl_verify,
timeout=config.timeout,
http_username=config.http_username,
http_password=config.http_password,
api_version=config.api_version,
per_page=config.per_page,
pagination=config.pagination,
order_by=config.order_by,
user_agent=config.user_agent,
retry_transient_errors=config.retry_transient_errors,
keep_base_url=config.keep_base_url,
**kwargs,
)
@classmethod
def merge_config(
cls,
options: Dict[str, Any],
gitlab_id: Optional[str] = None,
config_files: Optional[List[str]] = None,
) -> "Gitlab":
"""Create a Gitlab connection by merging configuration with
the following precedence:
1. Explicitly provided CLI arguments,
2. Environment variables,
3. Configuration files:
a. explicitly defined config files:
i. via the `--config-file` CLI argument,
ii. via the `PYTHON_GITLAB_CFG` environment variable,
b. user-specific config file,
c. system-level config file,
4. Environment variables always present in CI (CI_SERVER_URL, CI_JOB_TOKEN).
Args:
options: A dictionary of explicitly provided key-value options.
gitlab_id: ID of the configuration section.
config_files: List of paths to configuration files.
Returns:
(gitlab.Gitlab): A Gitlab connection.
Raises:
gitlab.config.GitlabDataError: If the configuration is not correct.
"""
config = gitlab.config.GitlabConfigParser(
gitlab_id=gitlab_id, config_files=config_files
)
url = (
options.get("server_url")
or config.url
or os.getenv("CI_SERVER_URL")
or gitlab.const.DEFAULT_URL
)
private_token, oauth_token, job_token = cls._merge_auth(options, config)
return cls(
url=url,
private_token=private_token,
oauth_token=oauth_token,
job_token=job_token,
ssl_verify=options.get("ssl_verify") or config.ssl_verify,
timeout=options.get("timeout") or config.timeout,
api_version=options.get("api_version") or config.api_version,
per_page=options.get("per_page") or config.per_page,
pagination=options.get("pagination") or config.pagination,
order_by=options.get("order_by") or config.order_by,
user_agent=options.get("user_agent") or config.user_agent,
)
@staticmethod
def _merge_auth(
options: Dict[str, Any], config: gitlab.config.GitlabConfigParser
) -> Tuple[Optional[str], Optional[str], Optional[str]]:
"""
Return a tuple where at most one of 3 token types ever has a value.
Since multiple types of tokens may be present in the environment,
options, or config files, this precedence ensures we don't
inadvertently cause errors when initializing the client.
This is especially relevant when executed in CI where user and
CI-provided values are both available.
"""
private_token = options.get("private_token") or config.private_token
oauth_token = options.get("oauth_token") or config.oauth_token
job_token = (
options.get("job_token") or config.job_token or os.getenv("CI_JOB_TOKEN")
)
if private_token:
return (private_token, None, None)
if oauth_token:
return (None, oauth_token, None)
if job_token:
return (None, None, job_token)
return (None, None, None)
def auth(self) -> None:
"""Performs an authentication using private token. Warns the user if a
potentially misconfigured URL is detected on the client or server side.
The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
success.
"""
self.user = self._objects.CurrentUserManager(self).get()
if hasattr(self.user, "web_url") and hasattr(self.user, "username"):
self._check_url(self.user.web_url, path=self.user.username)
def version(self) -> Tuple[str, str]:
"""Returns the version and revision of the gitlab server.
Note that self.version and self.revision will be set on the gitlab
object.
Returns:
The server version and server revision.
('unknown', 'unknown') if the server doesn't perform as expected.
"""
if self._server_version is None:
try:
data = self.http_get("/version")
if isinstance(data, dict):
self._server_version = data["version"]
self._server_revision = data["revision"]
else:
self._server_version = "unknown"
self._server_revision = "unknown"
except Exception:
self._server_version = "unknown"
self._server_revision = "unknown"
return cast(str, self._server_version), cast(str, self._server_revision)
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabMarkdownError)
def markdown(
self, text: str, gfm: bool = False, project: Optional[str] = None, **kwargs: Any
) -> str:
"""Render an arbitrary Markdown document.
Args:
text: The markdown text to render
gfm: Render text using GitLab Flavored Markdown. Default is False
project: Full path of a project used a context when `gfm` is True
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabMarkdownError: If the server cannot perform the request
Returns:
The HTML rendering of the markdown text.
"""
post_data = {"text": text, "gfm": gfm}
if project is not None:
post_data["project"] = project
data = self.http_post("/markdown", post_data=post_data, **kwargs)
if TYPE_CHECKING:
assert not isinstance(data, requests.Response)
assert isinstance(data["html"], str)
return data["html"]
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError)
def get_license(self, **kwargs: Any) -> Dict[str, Union[str, Dict[str, str]]]:
"""Retrieve information about the current license.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabGetError: If the server cannot perform the request
Returns:
The current license information
"""
result = self.http_get("/license", **kwargs)
if isinstance(result, dict):
return result
return {}
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError)
def set_license(self, license: str, **kwargs: Any) -> Dict[str, Any]:
"""Add a new license.
Args:
license: The license string
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabPostError: If the server cannot perform the request
Returns:
The new license information
"""
data = {"license": license}
result = self.http_post("/license", post_data=data, **kwargs)
if TYPE_CHECKING:
assert not isinstance(result, requests.Response)
return result
def _set_auth_info(self) -> None:
tokens = [
token
for token in [self.private_token, self.oauth_token, self.job_token]
if token
]
if len(tokens) > 1:
raise ValueError(
"Only one of private_token, oauth_token or job_token should "
"be defined"
)
if (self.http_username and not self.http_password) or (
not self.http_username and self.http_password
):
raise ValueError("Both http_username and http_password should be defined")
if tokens and self.http_username:
raise ValueError(
"Only one of token authentications or http "
"authentication should be defined"
)
self._auth: Optional[requests.auth.AuthBase] = None
if self.private_token:
self._auth = _backends.PrivateTokenAuth(self.private_token)
if self.oauth_token:
self._auth = _backends.OAuthTokenAuth(self.oauth_token)
if self.job_token:
self._auth = _backends.JobTokenAuth(self.job_token)
if self.http_username and self.http_password:
self._auth = requests.auth.HTTPBasicAuth(
self.http_username, self.http_password
)
def enable_debug(self, mask_credentials: bool = True) -> None:
import logging
from http import client
client.HTTPConnection.debuglevel = 1
logging.basicConfig()
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
httpclient_log = logging.getLogger("http.client")
httpclient_log.propagate = True
httpclient_log.setLevel(logging.DEBUG)
requests_log = logging.getLogger("requests.packages.urllib3")
requests_log.setLevel(logging.DEBUG)
requests_log.propagate = True
# shadow http.client prints to log()
# https://stackoverflow.com/a/16337639
def print_as_log(*args: Any) -> None:
httpclient_log.log(logging.DEBUG, " ".join(args))
setattr(client, "print", print_as_log)
if not mask_credentials:
return
token = self.private_token or self.oauth_token or self.job_token
handler = logging.StreamHandler()
handler.setFormatter(utils.MaskingFormatter(masked=token))
logger.handlers.clear()
logger.addHandler(handler)
def _get_session_opts(self) -> Dict[str, Any]:
return {
"headers": self.headers.copy(),
"auth": self._auth,
"timeout": self.timeout,
"verify": self.ssl_verify,
}
def _build_url(self, path: str) -> str:
"""Returns the full url from path.
If path is already a url, return it unchanged. If it's a path, append
it to the stored url.
Returns:
The full URL
"""
if path.startswith("http://") or path.startswith("https://"):
return path
return f"{self._url}{path}"
def _check_url(self, url: Optional[str], *, path: str = "api") -> Optional[str]:
"""
Checks if ``url`` starts with a different base URL from the user-provided base
URL and warns the user before returning it. If ``keep_base_url`` is set to
``True``, instead returns the URL massaged to match the user-provided base URL.
"""
if not url or url.startswith(self.url):
return url
match = re.match(rf"(^.*?)/{path}", url)
if not match:
return url
base_url = match.group(1)
if self.keep_base_url:
return url.replace(base_url, f"{self._base_url}")
utils.warn(
message=(
f"The base URL in the server response differs from the user-provided "
f"base URL ({self.url} -> {base_url}).\nThis is usually caused by a "
f"misconfigured base URL on your side or a misconfigured external_url "
f"on the server side, and can lead to broken pagination and unexpected "
f"behavior. If this is intentional, use `keep_base_url=True` when "
f"initializing the Gitlab instance to keep the user-provided base URL."
),
category=UserWarning,
)
return url
@staticmethod
def _check_redirects(result: requests.Response) -> None:
# Check the requests history to detect 301/302 redirections.
# If the initial verb is POST or PUT, the redirected request will use a
# GET request, leading to unwanted behaviour.
# If we detect a redirection with a POST or a PUT request, we
# raise an exception with a useful error message.
if not result.history:
return
for item in result.history:
if item.status_code not in (301, 302):
continue
# GET and HEAD methods can be redirected without issue
if item.request.method in ("GET", "HEAD"):
continue
target = item.headers.get("location")
raise gitlab.exceptions.RedirectError(
REDIRECT_MSG.format(
status_code=item.status_code,
reason=item.reason,
source=item.url,
target=target,
)
)
def http_request(
self,
verb: str,
path: str,
query_data: Optional[Dict[str, Any]] = None,
post_data: Optional[Union[Dict[str, Any], bytes, BinaryIO]] = None,
raw: bool = False,
streamed: bool = False,
files: Optional[Dict[str, Any]] = None,
timeout: Optional[float] = None,
obey_rate_limit: bool = True,
retry_transient_errors: Optional[bool] = None,
max_retries: int = 10,
extra_headers: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> requests.Response:
"""Make an HTTP request to the Gitlab server.
Args:
verb: The HTTP method to call ('get', 'post', 'put', 'delete')
path: Path or full URL to query ('/projects' or
'http://whatever/v4/api/projecs')
query_data: Data to send as query parameters
post_data: Data to send in the body (will be converted to
json by default)
raw: If True, do not convert post_data to json
streamed: Whether the data should be streamed
files: The files to send to the server
timeout: The timeout, in seconds, for the request
obey_rate_limit: Whether to obey 429 Too Many Request
responses. Defaults to True.
retry_transient_errors: Whether to retry after 500, 502, 503, 504
or 52x responses. Defaults to False.
max_retries: Max retries after 429 or transient errors,
set to -1 to retry forever. Defaults to 10.
extra_headers: Add and override HTTP headers for the request.
**kwargs: Extra options to send to the server (e.g. sudo)
Returns:
A requests result object.
Raises:
GitlabHttpError: When the return code is not 2xx
"""
query_data = query_data or {}
raw_url = self._build_url(path)
# parse user-provided URL params to ensure we don't add our own duplicates
parsed = parse.urlparse(raw_url)
params = parse.parse_qs(parsed.query)
utils.copy_dict(src=query_data, dest=params)
url = parse.urlunparse(parsed._replace(query=""))
# Deal with kwargs: by default a user uses kwargs to send data to the
# gitlab server, but this generates problems (python keyword conflicts
# and python-gitlab/gitlab conflicts).
# So we provide a `query_parameters` key: if it's there we use its dict
# value as arguments for the gitlab server, and ignore the other
# arguments, except pagination ones (per_page and page)
if "query_parameters" in kwargs:
utils.copy_dict(src=kwargs["query_parameters"], dest=params)
for arg in ("per_page", "page"):
if arg in kwargs:
params[arg] = kwargs[arg]
else:
utils.copy_dict(src=kwargs, dest=params)
opts = self._get_session_opts()
verify = opts.pop("verify")
opts_timeout = opts.pop("timeout")
# If timeout was passed into kwargs, allow it to override the default
if timeout is None:
timeout = opts_timeout
if retry_transient_errors is None:
retry_transient_errors = self.retry_transient_errors
# We need to deal with json vs. data when uploading files
send_data = self._backend.prepare_send_data(files, post_data, raw)
opts["headers"]["Content-type"] = send_data.content_type
if extra_headers is not None:
opts["headers"].update(extra_headers)
retry = utils.Retry(
max_retries=max_retries,
obey_rate_limit=obey_rate_limit,
retry_transient_errors=retry_transient_errors,
)
while True:
try:
result = self._backend.http_request(
method=verb,
url=url,
json=send_data.json,
data=send_data.data,
params=params,
timeout=timeout,
verify=verify,
stream=streamed,
**opts,
)
except (requests.ConnectionError, requests.exceptions.ChunkedEncodingError):
if retry.handle_retry():
continue
raise
self._check_redirects(result.response)
if 200 <= result.status_code < 300:
return result.response
if retry.handle_retry_on_status(
result.status_code, result.headers, result.reason
):
continue
error_message = result.content
try:
error_json = result.json()
for k in ("message", "error"):
if k in error_json:
error_message = error_json[k]
except (KeyError, ValueError, TypeError):
pass
if result.status_code == 401:
raise gitlab.exceptions.GitlabAuthenticationError(
response_code=result.status_code,
error_message=error_message,
response_body=result.content,
)
raise gitlab.exceptions.GitlabHttpError(
response_code=result.status_code,
error_message=error_message,
response_body=result.content,
)
def http_get(
self,
path: str,
query_data: Optional[Dict[str, Any]] = None,
streamed: bool = False,
raw: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], requests.Response]:
"""Make a GET request to the Gitlab server.
Args:
path: Path or full URL to query ('/projects' or
'http://whatever/v4/api/projecs')
query_data: Data to send as query parameters
streamed: Whether the data should be streamed
raw: If True do not try to parse the output as json
**kwargs: Extra options to send to the server (e.g. sudo)
Returns:
A requests result object is streamed is True or the content type is
not json.
The parsed json data otherwise.
Raises:
GitlabHttpError: When the return code is not 2xx
GitlabParsingError: If the json data could not be parsed
"""
query_data = query_data or {}
result = self.http_request(
"get", path, query_data=query_data, streamed=streamed, **kwargs
)
content_type = utils.get_content_type(result.headers.get("Content-Type"))
if content_type == "application/json" and not streamed and not raw:
try:
json_result = result.json()
if TYPE_CHECKING:
assert isinstance(json_result, dict)
return json_result
except Exception as e:
raise gitlab.exceptions.GitlabParsingError(
error_message="Failed to parse the server message"
) from e
else:
return result
def http_head(
self, path: str, query_data: Optional[Dict[str, Any]] = None, **kwargs: Any
) -> "requests.structures.CaseInsensitiveDict[Any]":
"""Make a HEAD request to the Gitlab server.
Args:
path: Path or full URL to query ('/projects' or
'http://whatever/v4/api/projecs')
query_data: Data to send as query parameters
**kwargs: Extra options to send to the server (e.g. sudo, page,
per_page)
Returns:
A requests.header object
Raises:
GitlabHttpError: When the return code is not 2xx
"""
query_data = query_data or {}
result = self.http_request("head", path, query_data=query_data, **kwargs)
return result.headers
def http_list(
self,
path: str,
query_data: Optional[Dict[str, Any]] = None,
*,
iterator: Optional[bool] = None,
message_details: Optional[utils.WarnMessageData] = None,
**kwargs: Any,
) -> Union["GitlabList", List[Dict[str, Any]]]:
"""Make a GET request to the Gitlab server for list-oriented queries.
Args:
path: Path or full URL to query ('/projects' or
'http://whatever/v4/api/projects')
query_data: Data to send as query parameters
iterator: Indicate if should return a generator (True)
**kwargs: Extra options to send to the server (e.g. sudo, page,
per_page)
Returns:
A list of the objects returned by the server. If `iterator` is
True and no pagination-related arguments (`page`, `per_page`,
`get_all`) are defined then a GitlabList object (generator) is returned
instead. This object will make API calls when needed to fetch the
next items from the server.
Raises:
GitlabHttpError: When the return code is not 2xx
GitlabParsingError: If the json data could not be parsed
"""
query_data = query_data or {}
# Provide a `get_all`` param to avoid clashes with `all` API attributes.
get_all = kwargs.pop("get_all", None)
if get_all is None:
# For now, keep `all` without deprecation.
get_all = kwargs.pop("all", None)
url = self._build_url(path)
page = kwargs.get("page")
if iterator and page is not None:
arg_used_message = f"iterator={iterator}"
utils.warn(
message=(
f"`{arg_used_message}` and `page={page}` were both specified. "
f"`{arg_used_message}` will be ignored and a `list` will be "
f"returned."
),
category=UserWarning,
)
if iterator and page is None:
# Generator requested
return GitlabList(self, url, query_data, **kwargs)
if get_all is True:
return list(GitlabList(self, url, query_data, **kwargs))
# pagination requested, we return a list
gl_list = GitlabList(self, url, query_data, get_next=False, **kwargs)
items = list(gl_list)
def should_emit_warning() -> bool:
# No warning is emitted if any of the following conditions apply:
# * `get_all=False` was set in the `list()` call.
# * `page` was set in the `list()` call.
# * GitLab did not return the `x-per-page` header.
# * Number of items received is less than per-page value.
# * Number of items received is >= total available.
if get_all is False:
return False
if page is not None:
return False
if gl_list.per_page is None:
return False
if len(items) < gl_list.per_page:
return False
if gl_list.total is not None and len(items) >= gl_list.total:
return False
return True
if not should_emit_warning():
return items
# Warn the user that they are only going to retrieve `per_page`
# maximum items. This is a common cause of issues filed.
total_items = "many" if gl_list.total is None else gl_list.total
if message_details is not None:
message = message_details.message.format_map(
{
"len_items": len(items),
"per_page": gl_list.per_page,
"total_items": total_items,
}
)
show_caller = message_details.show_caller
else:
message = (
f"Calling a `list()` method without specifying `get_all=True` or "
f"`iterator=True` will return a maximum of {gl_list.per_page} items. "
f"Your query returned {len(items)} of {total_items} items. See "
f"{_PAGINATION_URL} for more details. If this was done intentionally, "
f"then this warning can be supressed by adding the argument "
f"`get_all=False` to the `list()` call."
)
show_caller = True
utils.warn(
message=message,
category=UserWarning,
show_caller=show_caller,
)
return items
def http_post(
self,
path: str,
query_data: Optional[Dict[str, Any]] = None,
post_data: Optional[Dict[str, Any]] = None,
raw: bool = False,
files: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> Union[Dict[str, Any], requests.Response]:
"""Make a POST request to the Gitlab server.
Args:
path: Path or full URL to query ('/projects' or
'http://whatever/v4/api/projecs')
query_data: Data to send as query parameters
post_data: Data to send in the body (will be converted to
json by default)
raw: If True, do not convert post_data to json
files: The files to send to the server
**kwargs: Extra options to send to the server (e.g. sudo)
Returns:
The parsed json returned by the server if json is return, else the
raw content
Raises:
GitlabHttpError: When the return code is not 2xx
GitlabParsingError: If the json data could not be parsed
"""
query_data = query_data or {}
post_data = post_data or {}
result = self.http_request(