Global scope setters (getsentry#540)

a-d-collins · untitaker · commit 68ddcf459078 · 2019-10-23T09:08:53.000+02:00
* master: (sentry_sdk/utils.py) add push_scope_decorator

* master: (sentry_sdk/utils.py) fix iteritems incompatibility

* master: (sentry_sdk/utils.py) reformat push_scope_decorator() to fit linter specs

* push-scope-decorator: (utils.py) remove push_scope_decorator, (hub.py) update Hub.push_scope() to allow it to act as both a contentmanager and a decorator, (api.py, utils.py) add new scopemethod api methods {set_tag, set_extra, set_user, set_level} that allow for updating of the current scope

* push-scope-decorator: (sentry_sdk/hub.py) have _PushScopeContextDecorator inherit from contextlib.ContextDecorator

* push-scope-decorator: (sentry_sdk/hub.py) combine _PushScopeContextDecorator with _ScopeManager

* push-scope-decorator: (hub.py) fix push_scope() typing

* master: (sentry_sdk/_compat.py, sentry_sdk/hub.py) resolve py2 ContextDecorator compat issue, (sentry_sdk/api.py) update typing to match that of Hub.push_scope()

* master: (sentry_sdk/scope.py) remove improper uses of @_attr_setter, (tests/test_basics.py) remove unneeded test_scope_leaks_cleaned_up()

* master: (tests/test_basics.py) add test for push_scope as decorator, (sentry_sdk/_compat.py) satisfy linters

* global-scope-setters: keep global scope setters and remove push_scope() 'as a decorator' code

* global-scope-setters: (api.py) change 'current_scope' property to 'scope'

* global-scope-setters: (hub.py) add new lines in docstring to match style in rest of file

* global-scope-setters: (api.py) add global for set_context
diff --git a/sentry_sdk/api.py b/sentry_sdk/api.py
@@ -8,6 +8,7 @@
 
 if MYPY:
     from typing import Any
+    from typing import Dict
     from typing import Optional
     from typing import overload
     from typing import Callable
@@ -36,6 +37,11 @@ def overload(x):
     "flush",
     "last_event_id",
     "start_span",
+    "set_tag",
+    "set_context",
+    "set_extra",
+    "set_user",
+    "set_level",
 ]
 
 
@@ -48,6 +54,15 @@ def hubmethod(f):
     return f
 
 
+def scopemethod(f):
+    # type: (F) -> F
+    f.__doc__ = "%s\n\n%s" % (
+        "Alias for :py:meth:`sentry_sdk.Scope.%s`" % f.__name__,
+        inspect.getdoc(getattr(Scope, f.__name__)),
+    )
+    return f
+
+
 @hubmethod
 def capture_event(
     event,  # type: Event
@@ -163,6 +178,46 @@ def inner():
         return None
 
 
+@scopemethod  # noqa
+def set_tag(key, value):
+    # type: (str, Any) -> None
+    hub = Hub.current
+    if hub is not None:
+        hub.scope.set_tag(key, value)
+
+
+@scopemethod  # noqa
+def set_context(key, value):
+    # type: (str, Any) -> None
+    hub = Hub.current
+    if hub is not None:
+        hub.scope.set_context(key, value)
+
+
+@scopemethod  # noqa
+def set_extra(key, value):
+    # type: (str, Any) -> None
+    hub = Hub.current
+    if hub is not None:
+        hub.scope.set_extra(key, value)
+
+
+@scopemethod  # noqa
+def set_user(value):
+    # type: (Dict[str, Any]) -> None
+    hub = Hub.current
+    if hub is not None:
+        hub.scope.set_user(value)
+
+
+@scopemethod  # noqa
+def set_level(value):
+    # type: (str) -> None
+    hub = Hub.current
+    if hub is not None:
+        hub.scope.set_level(value)
+
+
 @hubmethod
 def flush(
     timeout=None,  # type: Optional[float]
diff --git a/sentry_sdk/hub.py b/sentry_sdk/hub.py
@@ -263,6 +263,12 @@ def client(self):
         """Returns the current client on the hub."""
         return self._stack[-1][0]
 
+    @property
+    def scope(self):
+        # type: () -> Scope
+        """Returns the current scope on the hub."""
+        return self._stack[-1][1]
+
     def last_event_id(self):
         # type: () -> Optional[str]
         """Returns the last event ID."""
@@ -483,8 +489,6 @@ def push_scope(  # noqa
 
         return _ScopeManager(self)
 
-    scope = push_scope
-
     def pop_scope_unsafe(self):
         # type: () -> Tuple[Optional[Client], Scope]
         """
diff --git a/sentry_sdk/scope.py b/sentry_sdk/scope.py
@@ -120,7 +120,12 @@ def clear(self):
     @_attr_setter
     def level(self, value):
         # type: (Optional[str]) -> None
-        """When set this overrides the level."""
+        """When set this overrides the level. Deprecated in favor of set_level."""
+        self._level = value
+
+    def set_level(self, value):
+        # type: (Optional[str]) -> None
+        """Sets the level for the scope."""
         self._level = value
 
     @_attr_setter
@@ -141,7 +146,12 @@ def transaction(self, value):
     @_attr_setter
     def user(self, value):
         # type: (Dict[str, Any]) -> None
-        """When set a specific user is bound to the scope."""
+        """When set a specific user is bound to the scope. Deprecated in favor of set_user."""
+        self._user = value
+
+    def set_user(self, value):
+        # type: (Dict[str, Any]) -> None
+        """Sets a user for the scope."""
         self._user = value
 
     @property
