Page MenuHomePhorge

Fix signature of `Logger.debug()`
ClosedPublic

Authored by sicherha on Nov 6 2022, 6:21 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Nov 15, 7:16 AM
Unknown Object (File)
Mon, Nov 6, 11:33 PM
Unknown Object (File)
Mon, Nov 6, 11:32 PM
Unknown Object (File)
Mon, Nov 6, 9:24 PM
Unknown Object (File)
Sat, Nov 4, 10:06 PM
Unknown Object (File)
Oct 23 2023, 6:17 PM
Unknown Object (File)
Oct 18 2023, 10:51 AM
Unknown Object (File)
Oct 1 2023, 5:57 AM
Subscribers

Details

Summary

The default argument level=1 must not come before any positional
arguments; it must be accepted as a keyword argument.
As signified by the pylint comments, the signature previously did not
conform to the specification given in
https://docs.python.org/3/library/logging.html#logging.Logger.debug.

This commit fixes a longstanding problem with crashes occurring in
certain scenarios when the debug level is set to 9. One such crash could
be observed from within SQLAlchemy, which calls debug() in the
following way:
pool.logger.debug("Created new connection %r", connection)
That call caused pykolab's Logger.debug() method to interpret its
second argument as a numeric level, which resulted in a TypeError
because it was actually an sqlite3.Connection.

By accepting level as a keyword argument, all arguments are now
interpreted in the correct order.

Diff Detail

Repository
rP pykolab
Lint
Lint Not Applicable
Unit
Tests Not Applicable