feat(api): Remove sentry_sdk.configure_scope

Also, remove any tests for `sentry_sdk.configure_scope`.

BREAKING CHANGE: Remove `sentry_sdk.configure_scope`.

Closes: #3402

Author: szokeasaurusrex

sentry_sdk/__init__.py

@@ -19,7 +19,6 @@
     "capture_event",
     "capture_exception",
     "capture_message",
-    "configure_scope",
     "continue_trace",
     "flush",
     "get_baggage",

sentry_sdk/api.py

@@ -1,6 +1,5 @@
 import inspect
 import warnings
-from contextlib import contextmanager
 
 from sentry_sdk import tracing_utils, Client
 from sentry_sdk._init_implementation import init
@@ -16,7 +15,6 @@
 
     from typing import Any
     from typing import Dict
-    from typing import Generator
     from typing import Optional
     from typing import overload
     from typing import Callable
@@ -55,7 +53,6 @@ def overload(x):
     "capture_event",
     "capture_exception",
     "capture_message",
-    "configure_scope",
     "continue_trace",
     "flush",
     "get_baggage",
@@ -194,56 +191,6 @@ def add_breadcrumb(
     return get_isolation_scope().add_breadcrumb(crumb, hint, **kwargs)
 
 
-@overload
-def configure_scope():
-    # type: () -> ContextManager[Scope]
-    pass
-
-
-@overload
-def configure_scope(  # noqa: F811
-    callback,  # type: Callable[[Scope], None]
-):
-    # type: (...) -> None
-    pass
-
-
-def configure_scope(  # noqa: F811
-    callback=None,  # type: Optional[Callable[[Scope], None]]
-):
-    # type: (...) -> Optional[ContextManager[Scope]]
-    """
-    Reconfigures the scope.
-
-    :param callback: If provided, call the callback with the current scope.
-
-    :returns: If no callback is provided, returns a context manager that returns the scope.
-    """
-    warnings.warn(
-        "sentry_sdk.configure_scope is deprecated and will be removed in the next major version. "
-        "Please consult our migration guide to learn how to migrate to the new API: "
-        "https://docs.sentry.io/platforms/python/migration/1.x-to-2.x#scope-configuring",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-
-    scope = get_isolation_scope()
-    scope.generate_propagation_context()
-
-    if callback is not None:
-        # TODO: used to return None when client is None. Check if this changes behavior.
-        callback(scope)
-
-        return None
-
-    @contextmanager
-    def inner():
-        # type: () -> Generator[Scope, None, None]
-        yield scope
-
-    return inner()
-
-
 @overload
 def push_scope():
     # type: () -> ContextManager[Scope]

tests/new_scopes_compat/test_new_scopes_compat.py

@@ -11,35 +11,6 @@
 """
 
 
-def test_configure_scope_sdk1(sentry_init, capture_events):
-    """
-    Mutate data in a `with configure_scope` block.
-
-    Checks the results of SDK 2.x against the results the same code returned in SDK 1.x.
-    """
-    sentry_init()
-
-    events = capture_events()
-
-    sentry_sdk.set_tag("A", 1)
-    sentry_sdk.capture_message("Event A")
-
-    with sentry_sdk.configure_scope() as scope:  # configure scope
-        sentry_sdk.set_tag("B1", 1)
-        scope.set_tag("B2", 1)
-        sentry_sdk.capture_message("Event B")
-
-    sentry_sdk.set_tag("Z", 1)
-    sentry_sdk.capture_message("Event Z")
-
-    (event_a, event_b, event_z) = events
-
-    # Check against the results the same code returned in SDK 1.x
-    assert event_a["tags"] == {"A": 1}
-    assert event_b["tags"] == {"A": 1, "B1": 1, "B2": 1}
-    assert event_z["tags"] == {"A": 1, "B1": 1, "B2": 1, "Z": 1}
-
-
 def test_push_scope_sdk1(sentry_init, capture_events):
     """
     Mutate data in a `with push_scope` block

tests/new_scopes_compat/test_new_scopes_compat_event.py

@@ -335,71 +335,6 @@ def test_event(sentry_init, capture_envelopes, expected_error, expected_transact
 
     envelopes = capture_envelopes()
 
-    with sentry_sdk.start_transaction(
-        name="test_transaction", op="test_transaction_op"
-    ) as trx:
-        with sentry_sdk.start_span(op="test_span") as span:
-            with sentry_sdk.configure_scope() as scope:  # configure scope
-                _generate_event_data(scope)
-                _faulty_function()
-
-    (error_envelope, transaction_envelope) = envelopes
-
-    error = error_envelope.get_event()
-    transaction = transaction_envelope.get_transaction_event()
-    attachment = error_envelope.items[-1]
-
-    assert error == expected_error(trx, span)
-    assert transaction == expected_transaction(trx, span)
-    assert attachment.headers == {
-        "filename": "hello.txt",
-        "type": "attachment",
-        "content_type": "text/plain",
-    }
-    assert attachment.payload.bytes == b"Hello World"
-
-
-def test_event2(sentry_init, capture_envelopes, expected_error, expected_transaction):
-    _init_sentry_sdk(sentry_init)
-
-    envelopes = capture_envelopes()
-
-    with Hub(Hub.current):
-        sentry_sdk.set_tag("A", 1)  # will not be added
-
-    with Hub.current:  # with hub
-        with sentry_sdk.push_scope() as scope:
-            scope.set_tag("B", 1)  # will not be added
-
-        with sentry_sdk.start_transaction(
-            name="test_transaction", op="test_transaction_op"
-        ) as trx:
-            with sentry_sdk.start_span(op="test_span") as span:
-                with sentry_sdk.configure_scope() as scope:  # configure scope
-                    _generate_event_data(scope)
-                    _faulty_function()
-
-    (error_envelope, transaction_envelope) = envelopes
-
-    error = error_envelope.get_event()
-    transaction = transaction_envelope.get_transaction_event()
-    attachment = error_envelope.items[-1]
-
-    assert error == expected_error(trx, span)
-    assert transaction == expected_transaction(trx, span)
-    assert attachment.headers == {
-        "filename": "hello.txt",
-        "type": "attachment",
-        "content_type": "text/plain",
-    }
-    assert attachment.payload.bytes == b"Hello World"
-
-
-def test_event3(sentry_init, capture_envelopes, expected_error, expected_transaction):
-    _init_sentry_sdk(sentry_init)
-
-    envelopes = capture_envelopes()
-
     with Hub(Hub.current):
         sentry_sdk.set_tag("A", 1)  # will not be added
 
@@ -431,43 +366,7 @@ def test_event3(sentry_init, capture_envelopes, expected_error, expected_transac
     assert attachment.payload.bytes == b"Hello World"
 
 
-def test_event4(sentry_init, capture_envelopes, expected_error, expected_transaction):
-    _init_sentry_sdk(sentry_init)
-
-    envelopes = capture_envelopes()
-
-    with Hub(Hub.current):
-        sentry_sdk.set_tag("A", 1)  # will not be added
-
-    with Hub(Hub.current):  # with hub clone
-        with sentry_sdk.push_scope() as scope:
-            scope.set_tag("B", 1)  # will not be added
-
-        with sentry_sdk.start_transaction(
-            name="test_transaction", op="test_transaction_op"
-        ) as trx:
-            with sentry_sdk.start_span(op="test_span") as span:
-                with sentry_sdk.configure_scope() as scope:  # configure scope
-                    _generate_event_data(scope)
-                    _faulty_function()
-
-    (error_envelope, transaction_envelope) = envelopes
-
-    error = error_envelope.get_event()
-    transaction = transaction_envelope.get_transaction_event()
-    attachment = error_envelope.items[-1]
-
-    assert error == expected_error(trx, span)
-    assert transaction == expected_transaction(trx, span)
-    assert attachment.headers == {
-        "filename": "hello.txt",
-        "type": "attachment",
-        "content_type": "text/plain",
-    }
-    assert attachment.payload.bytes == b"Hello World"
-
-
-def test_event5(sentry_init, capture_envelopes, expected_error, expected_transaction):
+def test_event2(sentry_init, capture_envelopes, expected_error, expected_transaction):
     _init_sentry_sdk(sentry_init)
 
     envelopes = capture_envelopes()

tests/test_api.py

@@ -11,7 +11,6 @@
     is_initialized,
     start_transaction,
     set_tags,
-    configure_scope,
     push_scope,
     get_global_scope,
     get_current_scope,
@@ -185,12 +184,6 @@ def test_set_tags(sentry_init, capture_events):
     }, "Updating tags with empty dict changed tags"
 
 
-def test_configure_scope_deprecation():
-    with pytest.warns(DeprecationWarning):
-        with configure_scope():
-            ...
-
-
 def test_push_scope_deprecation():
     with pytest.warns(DeprecationWarning):
         with push_scope():

tests/test_client.py

@@ -12,10 +12,8 @@
 
 import sentry_sdk
 from sentry_sdk import (
-    Hub,
     Client,
     add_breadcrumb,
-    configure_scope,
     capture_message,
     capture_exception,
     capture_event,
@@ -557,39 +555,12 @@ def capture_envelope(self, envelope):
     )
 
     start = time.time()
-    output = subprocess.check_output([sys.executable, str(app)])
+    subprocess.check_output([sys.executable, str(app)])
     end = time.time()
 
     # Each message takes at least 0.1 seconds to process
     assert int(end - start) >= num_messages / 10
 
-    assert output.count(b"HI") == num_messages
-
-
-def test_configure_scope_available(
-    sentry_init, request, monkeypatch, suppress_deprecation_warnings
-):
-    """
-    Test that scope is configured if client is configured
-
-    This test can be removed once configure_scope and the Hub are removed.
-    """
-    sentry_init()
-
-    with configure_scope() as scope:
-        assert scope is Hub.current.scope
-        scope.set_tag("foo", "bar")
-
-    calls = []
-
-    def callback(scope):
-        calls.append(scope)
-        scope.set_tag("foo", "bar")
-
-    assert configure_scope(callback) is None
-    assert len(calls) == 1
-    assert calls[0] is Hub.current.scope
-
 
 @pytest.mark.tests_internal_exceptions
 def test_client_debug_option_enabled(sentry_init, caplog):
@@ -609,27 +580,6 @@ def test_client_debug_option_disabled(with_client, sentry_init, caplog):
     assert "OK" not in caplog.text
 
 
-@pytest.mark.skip(
-    reason="New behavior in SDK 2.0: You have a scope before init and add data to it."
-)
-def test_scope_initialized_before_client(sentry_init, capture_events):
-    """
-    This is a consequence of how configure_scope() works. We must
-    make `configure_scope()` a noop if no client is configured. Even
-    if the user later configures a client: We don't know that.
-    """
-    with configure_scope() as scope:
-        scope.set_tag("foo", 42)
-
-    sentry_init()
-
-    events = capture_events()
-    capture_message("hi")
-    (event,) = events
-
-    assert "tags" not in event
-
-
 def test_weird_chars(sentry_init, capture_events):
     sentry_init()
     events = capture_events()