sp

define all module/package contrib deprecations in one place

Author: mabdinur

ddtrace/contrib/__init__.py

@@ -19,35 +19,49 @@ def __getattr__(name):
         "pyramid",
         "requests",
         "sqlalchemy",
-        "tornado",
         "wsgi",
         "trace_utils",
         "internal",
     ):
-        # following attributes are not deprecated
-        pass
-    elif name in ("flask_login", "trace_utils_async", "redis_utils", "trace_utils_redis"):
-        # folowing integrations/utils have unique deprecation messages
+        # following packages/modules are not deprecated and will not be removed in 3.0
         pass
     elif name in ("trace_handlers", "func_name", "module_name", "require_modules"):
+        # the following attributes are exposed in ddtrace.contrib.__init__ and should be
+        # removed in v3.0
         deprecate(
-            ("%s.%s is deprecated" % (__name__, name)),
+            ("ddtrace.contrib.%s is deprecated" % name),
             category=DDTraceDeprecationWarning,
             removal_version="3.0.0",
         )
     elif name in ("aiobotocore", "httplib", "kombu", "snowflake", "sqlalchemy", "tornado", "urllib3"):
-        # following integrations are not enabled by default and require a unique message
+        # following integrations are not enabled by default and require a unique deprecation message
         deprecate(
-            f"{name} is deprecated",
+            f"ddtrace.contrib.{name} is deprecated",
             message="Avoid using this package directly. "
             f"Set DD_TRACE_{name.upper()}_ENABLED=true and use ``ddtrace.auto`` or the "
             "``ddtrace-run`` command to enable and configure this integration.",
             category=DDTraceDeprecationWarning,
             removal_version="3.0.0",
         )
+    elif name in ("redis_utils", "trace_utils_redis", "trace_utils_async"):
+        deprecate(
+            f"The ddtrace.contrib.{name} module is deprecated",
+            message="Import from ``ddtrace.contrib.trace_utils`` instead.",
+            category=DDTraceDeprecationWarning,
+            removal_version="3.0.0",
+        )
+    elif name == "flask_login":
+        deprecate(
+            """The flask_login integration is deprecated and will be deleted.
+        We recommend customers to switch to manual instrumentation.
+        https://docs.datadoghq.com/security/application_security/threats/add-user-info/?tab=loginsuccess&code-lang=python#adding-business-logic-information-login-success-login-failure-any-business-logic-to-traces
+        """,
+            message="",
+            category=DDTraceDeprecationWarning,
+        )
     else:
         deprecate(
-            f"{name} is deprecated",
+            f"ddtrace.contrib.{name} is deprecated",
             message="Avoid using this package directly. "
             f"Use ``import ddtrace.auto`` or the ``ddtrace-run`` command to enable and configure {name}.",
             category=DDTraceDeprecationWarning,

ddtrace/contrib/flask_login/__init__.py

@@ -1,17 +1,3 @@
-from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
-from ddtrace.vendor.debtcollector import deprecate
-
-
-deprecate(
-    """The flask_login module is deprecated and will be deleted.
-We recommend customers to switch to manual instrumentation.
-https://docs.datadoghq.com/security/application_security/threats/add-user-info/?tab=loginsuccess&code-lang=python#adding-business-logic-information-login-success-login-failure-any-business-logic-to-traces
-""",
-    message="",
-    category=DDTraceDeprecationWarning,
-)
-
-
 def get_version() -> str:
     return ""
 

ddtrace/contrib/redis_utils.py

@@ -1,11 +1 @@
 from ddtrace.contrib.internal.redis_utils import *  # noqa: F403
-from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
-from ddtrace.vendor.debtcollector import deprecate
-
-
-deprecate(
-    "The ddtrace.contrib.redis_utils module is deprecated",
-    message="Import from ``ddtrace.contrib.internal.trace_utils`` instead.",
-    category=DDTraceDeprecationWarning,
-    removal_version="3.0.0",
-)

ddtrace/contrib/trace_utils_async.py

@@ -1,11 +1 @@
 from ddtrace.contrib.internal.trace_utils_async import *  # noqa: F403
-from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
-from ddtrace.vendor.debtcollector import deprecate
-
-
-deprecate(
-    "The ddtrace.contrib.internal.trace_utils_async module is deprecated",
-    message="Import from ``ddtrace.contrib.internal.trace_utils`` instead.",
-    category=DDTraceDeprecationWarning,
-    removal_version="3.0.0",
-)

ddtrace/contrib/trace_utils_redis.py

@@ -1,15 +1,5 @@
 from ddtrace.contrib.internal.redis_utils import determine_row_count
 from ddtrace.contrib.internal.redis_utils import stringify_cache_args
-from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
-from ddtrace.vendor.debtcollector import deprecate
-
-
-deprecate(
-    "The ddtrace.contrib.internal.trace_utils_redis module is deprecated",
-    message="Import from ``ddtrace.contrib.internal.trace_utils`` instead.",
-    category=DDTraceDeprecationWarning,
-    removal_version="3.0.0",
-)
 
 
 format_command_args = stringify_cache_args