Don't use the global default logging instance when logging #988
Conversation
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
# Conflicts: # databricks/sdk/credentials_provider.py
mgyucht
changed the title
mgyucht
commented
Jun 11, 2025
| @@ -3,7 +3,7 @@ | |||
| import logging | |||
| from typing import Dict, Optional, Union, cast | |||
|
|
|||
| logger = logging.getLogger("databricks.sdk") | |||
There was a problem hiding this comment.
This existed before, but wasn't consistently used. I've renamed it to _LOG as it is not meant to be exposed publicly and it is consistent with other places within the SDK.
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes are proposed in this pull request?
The Python SDK sometimes uses the global logging instance to log rather than a per-module logger instance, e.g.
databricks-sdk-py/databricks/sdk/runtime/__init__.py
Line 116 in a393602
Using logging.debug configures a root logger and is considered a bad practice when using the logging library in Python. This can lead to several issues including duplicated logs.
This PR makes this change for the few places where the default logger instance is used in the SDK.
How is this tested?
Describe any tests you have done; especially if test tests are not part of
the unit tests (e.g. local tests).
ALWAYS ANSWER THIS QUESTION: Answer with "N/A" if tests are not applicable
to your PR (e.g. if the PR only modifies comments). Do not be afraid of
answering "Not tested" if the PR has not been tested. Being clear about what
has been done and not done provides important context to the reviewers.