Scope refactoring (merge Hubs and Scopes) (#2610)

This refactors the SDK to move away from the Hub and have all the functionality in the Scope. Introducing different types of scopes. This aligns the SDK with how Opentelementry (OTel) handles data bringing us closer to be 100% OTel compatible.

This change was discussed in this RFC: 
getsentry/rfcs#122

There is also a small FAQ: 
https://gist.github.com/mitsuhiko/1bc78d04ea7d08e5b50d27e42676db80

And a Miro board showing how the new scopes manage data: 
https://miro.com/app/board/uXjVNtPiOfI=/?share_link_id=216270218892

### This RP contains
- Introduction of global, isolation, and current scope
- Deprecation of the Hub
- All existing Hub based API still works and is still used by most of our integrations. Under the hood the new Scopes are used.
- (this PR now includes all the changes made in the [first PR](#2609) introducing the new API)

### Breaking changes
- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.

Author: antonpirker

.github/workflows/test-integrations-web-frameworks-1.yml

@@ -67,10 +67,6 @@ jobs:
         run: |
           set -x # print commands that are executed
           ./scripts/runtox.sh "py${{ matrix.python-version }}-django-latest" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
-      - name: Test fastapi latest
-        run: |
-          set -x # print commands that are executed
-          ./scripts/runtox.sh "py${{ matrix.python-version }}-fastapi-latest" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
       - name: Test flask latest
         run: |
           set -x # print commands that are executed
@@ -79,6 +75,10 @@ jobs:
         run: |
           set -x # print commands that are executed
           ./scripts/runtox.sh "py${{ matrix.python-version }}-starlette-latest" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+      - name: Test fastapi latest
+        run: |
+          set -x # print commands that are executed
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-fastapi-latest" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
       - name: Generate coverage XML
         run: |
           coverage combine .coverage*
@@ -136,10 +136,6 @@ jobs:
         run: |
           set -x # print commands that are executed
           ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-django" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
-      - name: Test fastapi pinned
-        run: |
-          set -x # print commands that are executed
-          ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-fastapi" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
       - name: Test flask pinned
         run: |
           set -x # print commands that are executed
@@ -148,6 +144,10 @@ jobs:
         run: |
           set -x # print commands that are executed
           ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-starlette" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+      - name: Test fastapi pinned
+        run: |
+          set -x # print commands that are executed
+          ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-fastapi" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
       - name: Generate coverage XML
         run: |
           coverage combine .coverage*

docs/api.rst

@@ -41,13 +41,18 @@ Distributed Tracing
 .. autofunction:: sentry_sdk.api.get_traceparent
 
 
+Client Management
+=================
+
+.. autofunction:: sentry_sdk.api.is_initialized
+.. autofunction:: sentry_sdk.api.get_client
+
+
 Managing Scope (advanced)
 =========================
 
 .. autofunction:: sentry_sdk.api.configure_scope
 .. autofunction:: sentry_sdk.api.push_scope
 
+.. autofunction:: sentry_sdk.api.new_scope
 
-.. Not documented (On purpose. Not sure if anyone should use those)
-.. last_event_id()
-.. flush()

docs/apidocs.rst

@@ -11,6 +11,12 @@ API Docs
 .. autoclass:: sentry_sdk.Client
     :members:
 
+.. autoclass:: sentry_sdk.client.BaseClient
+    :members:
+
+.. autoclass:: sentry_sdk.client.NonRecordingClient
+    :members:
+
 .. autoclass:: sentry_sdk.client._Client
     :members:
 

scripts/split-tox-gh-actions/split-tox-gh-actions.py

@@ -94,9 +94,9 @@
     ],
     "Web Frameworks 1": [
         "django",
-        "fastapi",
         "flask",
         "starlette",
+        "fastapi",
     ],
     "Web Frameworks 2": [
         "aiohttp",

sentry_sdk/__init__.py

@@ -18,28 +18,31 @@
     "HttpTransport",
     "init",
     "integrations",
+    "trace",
     # From sentry_sdk.api
+    "add_breadcrumb",
     "capture_event",
-    "capture_message",
     "capture_exception",
-    "add_breadcrumb",
+    "capture_message",
     "configure_scope",
-    "push_scope",
+    "continue_trace",
     "flush",
-    "last_event_id",
-    "start_span",
-    "start_transaction",
-    "set_tag",
+    "get_baggage",
+    "get_client",
+    "get_current_span",
+    "get_traceparent",
+    "is_initialized",
+    "isolation_scope",
+    "new_scope",
+    "push_scope",
     "set_context",
     "set_extra",
-    "set_user",
     "set_level",
     "set_measurement",
-    "get_current_span",
-    "get_traceparent",
-    "get_baggage",
-    "continue_trace",
-    "trace",
+    "set_tag",
+    "set_user",
+    "start_span",
+    "start_transaction",
 ]
 
 # Initialize the debug support after everything is loaded