ref: should_send_default_pii shortcut (#2844)

Currently, with the new scope API, calls to hub._should_send_default_pii need to be replaced with calls to sentry_sdk.get_client().should_send_default_pii.

This PR introduces scope.should_send_default_pii as a drop-in replacement for hub._should_send_default_pii, so we don't need to type out sentry_sdk.get_client().should_send_default_pii everywhere we need to check should_send_default_pii.

Author: szokeasaurusrex

sentry_sdk/hub.py

@@ -60,7 +60,7 @@ def overload(x):
 
 def _should_send_default_pii():
     # type: () -> bool
-    # TODO: Migrate existing code to client.should_send_default_pii() and remove this function.
+    # TODO: Migrate existing code to `scope.should_send_default_pii()` and remove this function.
     # New code should not use this function!
     client = Hub.current.client
     if not client:

sentry_sdk/scope.py

@@ -1658,5 +1658,11 @@ def use_isolation_scope(isolation_scope):
         _isolation_scope.reset(isolation_token)
 
 
+def should_send_default_pii():
+    # type: () -> bool
+    """Shortcut for `Scope.get_client().should_send_default_pii()`."""
+    return Scope.get_client().should_send_default_pii()
+
+
 # Circular imports
 from sentry_sdk.client import NonRecordingClient

tests/test_scope.py

@@ -10,7 +10,13 @@
     new_scope,
 )
 from sentry_sdk.client import Client, NonRecordingClient
-from sentry_sdk.scope import Scope, ScopeType, use_isolation_scope, use_scope
+from sentry_sdk.scope import (
+    Scope,
+    ScopeType,
+    use_isolation_scope,
+    use_scope,
+    should_send_default_pii,
+)
 
 
 def test_copying():
@@ -778,3 +784,15 @@ def test_nested_scopes_with_tags(sentry_init, capture_envelopes):
     assert transaction["tags"] == {"isolation_scope1": 1, "current_scope2": 1, "trx": 1}
     assert transaction["spans"][0]["tags"] == {"a": 1}
     assert transaction["spans"][1]["tags"] == {"b": 1}
+
+
+def test_should_send_default_pii_true(sentry_init):
+    sentry_init(send_default_pii=True)
+
+    assert should_send_default_pii() is True
+
+
+def test_should_send_default_pii_false(sentry_init):
+    sentry_init(send_default_pii=False)
+
+    assert should_send_default_pii() is False