Repository navigation
Add extension attribute to logging helpers - #14731
Open
stephenfin wants to merge 1 commit into
Open
stephenfin wants to merge 1 commit into
stephenfin wants to merge 1 commit into
Conversation
Although getLogger(__name__) already records the Python module name, Sphinx does not display it. There's good reason for this: a module name is not necessarily an extension name, and an extension may span several modules and should be able to use a consistent, user-facing label for all of them. Add an explicit 'extension' attribute that provides a "blessed" way to prefix logs, allowing extensions to identify themselves in log output without manually hardcoding prefixes such as `[foo-extension]` in their messages. This can be done during 'getLogger()' or on a per message basis. Docs are updated to reflect this change. An LLM was used to author/extend test coverage. Signed-off-by: Stephen Finucane <stephen@that.guru> Assisted-by: OpenAI gpt-6.1-sol (via pi)
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Although
getLogger(__name__)already records the Python module name, Sphinx does not display it. There's good reason for this: a module name is not necessarily an extension name, and an extension may span several modules and should be able to use a consistent, user-facing label for all of them.Add an explicit 'extension' attribute that provides a "blessed" way to prefix logs, allowing extensions to identify themselves in log output without manually hardcoding prefixes such as
[foo-extension]in their messages. This can be done duringgetLogger()or on a per message basis.Docs are updated to reflect this change. An LLM was used to author/extend test coverage.
References
AI Disclosure
An LLM was used to author/extend test coverage. The
Assisted-bytrailer is included to reflect this.