chore(integrations): remove required_modules from integrations #11719
Conversation
This file contains 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
|
|
mabdinur
force-pushed
the
munir/get-rid-of-require-modules-integrations
branch
2 times, most recently
from
2634736 to
2a29668
Compare
mabdinur
changed the title
BenchmarksBenchmark execution time: 2024-12-27 20:30:33 Comparing candidate commit a523807 in PR branch Found 5 performance improvements and 0 performance regressions! Performance is the same for 389 metrics, 2 unstable metrics. scenario:iast_aspects-ospathdirname_aspect
scenario:iast_aspects-ospathsplit_aspect
scenario:iast_aspects-ospathsplitdrive_aspect
scenario:iast_aspects-ospathsplitext_aspect
scenario:iast_aspects-replace_aspect
|
mabdinur
force-pushed
the
munir/get-rid-of-require-modules-integrations
branch
from
2a29668 to
7e13140
Compare
Datadog ReportBranch report: ✅ 0 Failed, 55 Passed, 1413 Skipped, 1m 17.72s Total duration (32m 37.73s time saved) |
sanchda
approved these changes
Dec 19, 2024
Yun-Kim
approved these changes
Dec 20, 2024
mabdinur
added
the
changelog/no-changelog
mabdinur
changed the title
tabgok
approved these changes
Dec 24, 2024
erikayasuda
approved these changes
Dec 27, 2024
| from ddtrace.contrib.internal.coverage.patch import get_version | ||
| from ddtrace.contrib.internal.coverage.patch import patch | ||
| from ddtrace.contrib.internal.coverage.patch import unpatch | ||
| log = get_logger(__name__) |
There was a problem hiding this comment.
NB: Just curious, do you know why we have this here?
There was a problem hiding this comment.
Probably some copy-pasta. It seems to have been there since the beginning of this file's history, and was already unused back then. 😛 We can probably remove it.
| from ddtrace.contrib.internal.django.patch import unpatch | ||
|
|
||
| __all__ = ["patch", "unpatch", "_patch", "get_version"] | ||
| __all__ = ["patch", "unpatch", "_patch", "get_version"] |
There was a problem hiding this comment.
Should we prepare to exclude _patch while we're doing this clean up, and deprecate it for 3.x?
There was a problem hiding this comment.
Honestly I think we could make patch, unpatch and get_version functions internal for all integrations. There's no good reason to make these operations public.
If we really need to expose an api for unpatching an integration (which I don't think we should) we could introduce one unpatch/unpatch_all method in _monkey.py. This is something we could discuss in the next guild meeting.
vitor-de-araujo
approved these changes
Dec 27, 2024
mabdinur
commented
Dec 27, 2024
avara1986
approved these changes
Dec 29, 2024
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.
Since ddtrace v1.9.0 modules are only patched after import. There is no need to check whether a module exists in
ddtrace.contrib.integration_name.__init__. If a library is not installed, it won't be patched.require_modulesshould only be used when a ddtrace integration requires additional libraries (for example the web3 integration can only be enabled if web3_driver is also installed). Right now there is no integrations that have such a dependency.With this change objects exposed in
ddtrace.contrib.<integration_name>.__all__will always be available. Accessing these objects will not raise an AttributeError and crash an application: ex.Checklist
Reviewer Checklist