Add GraphQL.enable_debug

timmy61109 · timmy61109 · commit 63b2d9100b16 · 2025-04-23T16:53:53.000+08:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -1540,6 +1540,39 @@ def _set_auth_info(self) -> None:
                 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)
+
 
 class AsyncGraphQL(_BaseGraphQL):
     def __init__(
