Adds import sentry comment

TeskaLabs · Oct 2, 2023 · 91300ca · 91300ca
1 parent 5851fb3
commit 91300ca
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/reference/sentry.md b/docs/reference/sentry.md
@@ -44,6 +44,17 @@ class MyApplication(asab.Application):
 			self.SentryService = asab.sentry.SentryService(self)
 ```
 
+To avoid overshadowing the parent `asab` module in the local scope of the `__init__`, use the following approach when importing the `sentry` module. This way the `sentry` submodule will be recognized as a sepate local entity and won't affect global `asab`:
+
+```python
+class MyApplication(asab.Application):
+	def __init__(self):
+		super().__init__()
+		if "sentry" in asab.Config.sections():
+			from asab import sentry
+			self.SentryService = sentry.SentryService(self)
+```
+
 After the service is initialized:
 
 - all uncaught exceptions are sent as events