doc: Ensure docstring never goes out of date again

untitaker · untitaker · commit 92ca9db7a4ff · 2019-02-21T09:06:29.000+01:00
diff --git a/sentry_sdk/integrations/__init__.py b/sentry_sdk/integrations/__init__.py
@@ -12,36 +12,33 @@
 _installed_integrations = set()
 
 
-def iter_default_integrations():
-    """Returns an iterator of default integration classes.
-
-    This returns the following default integration:
-
-    - `LoggingIntegration`
-    - `StdlibIntegration`
-    - `ExcepthookIntegration`
-    - `DedupeIntegration`
-    - `AtexitIntegration`
-    - `ModulesIntegration`
-    - `ArgvIntegration`
-    """
-    from sentry_sdk.integrations.logging import LoggingIntegration
-    from sentry_sdk.integrations.stdlib import StdlibIntegration
-    from sentry_sdk.integrations.excepthook import ExcepthookIntegration
-    from sentry_sdk.integrations.dedupe import DedupeIntegration
-    from sentry_sdk.integrations.atexit import AtexitIntegration
-    from sentry_sdk.integrations.modules import ModulesIntegration
-    from sentry_sdk.integrations.argv import ArgvIntegration
-    from sentry_sdk.integrations.threading import ThreadingIntegration
-
-    yield LoggingIntegration
-    yield StdlibIntegration
-    yield ExcepthookIntegration
-    yield DedupeIntegration
-    yield AtexitIntegration
-    yield ModulesIntegration
-    yield ArgvIntegration
-    yield ThreadingIntegration
+def _generate_default_integrations_iterator(*import_strings):
+    def iter_default_integrations():
+        # type: () -> Iterator[Type[Integration]]
+        """Returns an iterator of the default integration classes:
+        """
+        for import_string in import_strings:
+            module, cls = import_strings.rsplit(".", 1)
+            yield getattr(__import__(module), cls)
+
+    for import_string in import_strings:
+        iter_default_integrations.__doc__ += "\n- `{}`".format(import_string)
+
+    return iter_default_integrations
+
+
+iter_default_integrations = _generate_default_integrations_iterator(
+    "sentry_sdk.integrations.logging.LoggingIntegration",
+    "sentry_sdk.integrations.stdlib.StdlibIntegration",
+    "sentry_sdk.integrations.excepthook.ExcepthookIntegration",
+    "sentry_sdk.integrations.dedupe.DedupeIntegration",
+    "sentry_sdk.integrations.atexit.AtexitIntegration",
+    "sentry_sdk.integrations.modules.ModulesIntegration",
+    "sentry_sdk.integrations.argv.ArgvIntegration",
+    "sentry_sdk.integrations.threading.ThreadingIntegration",
+)
+
+del _generate_default_integrations_iterator
 
 
 def setup_integrations(integrations, with_defaults=True):
