This stops addingNullHandler instances to GitPython's loggers. As noted in#1806, when they were added in#300 this prevented errors when GitPython logged messages and logging was not enabled, but since Python 3.2 there is a logger of last resort providing a nicer default behavior of showing the messages. (They are still shown with better formatting if logging is configured, even if just done withlogging.basicConfig(), so applications should still typically configure logging.)

This also makes a few more minor related changes, detailed in the commit messages. This includes changing variable names fromlog to_logger, as mentioned in#1806 (comment), as well as consistently passing__name__ tologging.getLogger instead of hard-coding names in a few places, as mentioned in#1808 (comment).

The major effect of the changes here is that messages of levelWARNING or higher are not suppressed by default anymore, even when logging is not configured. So I could have included a change here to take care of#1808 as well, such asdc62096. But I plan to introduce that in a future pull request instead, because it would be best to add tests for it, which I think should build on the tests proposed in#1812. If both#1812 and this PR are merged, I can add tests followed by the changes fromdc62096 that would make them pass. (If they are not merged, or they are merged with major changes, then that will also clarify how to move forward with making a warning from the initial refresh use the logging framework.)

This shows as resolving several CodeQL alerts and also adding new alerts that correspond exactly to them. This happens as a result of renaminglog to_logger; CodeQL considers the alert resolved because there are no more calls tolog, and issues new equivalent alerts for the same situations with_logger. The new alerts produce a failingCode scanning results check for the PR.

EliahKagan added4 commits

January 25, 2024 21:19

Use consistent style for passing logger name

987dbf4

This has each module use `__name__` for the path to its own logger.Previously, most modules did this several hard-coded their names incalls to logging.getLogger.

Rename logger globals from log to _logger

7bbccb4

These globals were nonpublic, because even though they were namedwithout leading underscores, they all appeared in modules in which__all__ was defined and did not list them. (They remain nonpublic.)This renaming is to avoid confusion between those log attributesang logging features of Git itself ("git log", "git reflog"), andmore importantly, with the related git.refs.log module, referred toby the log attribute of the git.refs module, and the log attributeof the git module (git/__init__.py has a * import from git.refs).

Don't access logger in tests by nonpublic attribute

78a82b3

This changes a couple tests that access specific loggers to use thelogger name instead, as code outside GitPython should do.

Don't addNullHandlers

bc42ee5

This stops adding `NullHandler` instances to GitPython's loggers.As noted ingitpython-developers#1806, when they were added ingitpython-developers#300 this preventederrors when GitPython logged messages and logging was not enabled,but since Python 3.2 there is a logger of last resort providing anicer default behavior of showing the messages. (They are stillshown with better formatting if logging is configured, even ifjust done with logging.basicConfig(), so applications should stilltypically configure logging.)

github-advanced-securitybot found potential problems

Jan 26, 2024

View reviewed changes

git/repo/base.py

		@@ -1298,7 +1298,7 @@
		cmdline = getattr(proc, "args", "")
		cmdline = remove_password_if_present(cmdline)

		log.debug("Cmd(%s)'s unused stdout: %s", cmdline, stdout)
		_logger.debug("Cmd(%s)'s unused stdout: %s", cmdline, stdout)