DB-API: db.statement inclusion of sqlcomment as opt-in #3115
+479
−45
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.
Description
Supports new, optional kwarg
enable_attribute_commenter
at DB-API integration to opt intodb.statement
span attribute inclusion of sqlcomment.Partially addresses #3107
Is required to update driver-level instrumentors like psycopg2, mysqlclient, etc in this PR: #3121
Type of change
Breaking because
db.statement
span attribute inclusion of sqlcomment currently always happens if sqlcommenter enabled. It'll be opt-in with this update, so might break for those users relying on the feature introduced in 0.50b0, for instrumentation of any of psycopg2, psycopg, mysqlclient, PyMySQL. Those instrumentors will be updated in this PR: #3121How Has This Been Tested?
tox -e py312-test-instrumentation-dbapi
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.