Logging

To enable debug logging from the underlying ``requests`` and ``http.client`` calls,

you can use ``enable_debug()`` on your ``Gitlab`` instance. For example:

..code-block::python

By default, python-gitlab will mask the token used for authentication in logging output.

If you'd like to debug credentials sent to the API, you can disable masking explicitly:

..code-block::python

.. _object_attributes:

Attributes in updated objects

self.http_username,self.http_password

)

defenable_debug()->None:

defenable_debug(self,mask_credentials:bool=True)->None:

HTTPConnection.debuglevel=1

client.HTTPConnection.debuglevel=1

logging.basicConfig()

logging.getLogger().setLevel(logging.DEBUG)

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

defprint_as_log(*args:Any)->None:

httpclient_log.log(logging.DEBUG," ".join(args))

setattr(client,"print",print_as_log)

ifnotmask_credentials:

token=self.private_tokenorself.oauth_tokenorself.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(),

importemail.message

importurllib.parse

fromtypingimportAny,Callable,Dict,Iterator,Optional,Tuple,Type,Union

fromtypingimportAny,Callable,Dict,Iterator,Literal,Optional,Tuple,Type,Union

returnmessage.get_content_type()

classMaskingFormatter(logging.Formatter):

def__init__(

self,

fmt:Optional[str]=logging.BASIC_FORMAT,

datefmt:Optional[str]=None,

style:Literal["%","{","$"]="%",

validate:bool=True,

masked:Optional[str]=None,

)->None:

super().__init__(fmt,datefmt,style,validate)

self.masked=masked

def_filter(self,entry:str)->str:

ifnotself.masked:

returnentry.replace(self.masked,"[MASKED]")

defformat(self,record:logging.LogRecord)->str:

original=logging.Formatter.format(self,record)

returnself._filter(original)

defresponse_content(

response:requests.Response,

streamed:bool,