|
2 | 2 | <html lang="en" data-accent-color="violet" data-content_root="../../"> |
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8"> |
5 | | - <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>sentry_sdk.api - sentry-python 2.58.0a1 documentation</title><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><script> |
| 5 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>sentry_sdk.api - sentry-python 2.59.0 documentation</title><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><script> |
6 | 6 | function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))} |
7 | 7 | setColorMode(localStorage._theme||"auto"); |
8 | 8 | </script><link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=e1a1ceaf" /> |
@@ -114,7 +114,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre> |
114 | 114 | </span><span data-line="6"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk._init_implementation</span><span class="w"> </span><span class="kn">import</span> <span class="n">init</span> |
115 | 115 | </span><span data-line="7"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk.consts</span><span class="w"> </span><span class="kn">import</span> <span class="n">INSTRUMENTER</span> |
116 | 116 | </span><span data-line="8"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk.scope</span><span class="w"> </span><span class="kn">import</span> <span class="n">Scope</span><span class="p">,</span> <span class="n">_ScopeManager</span><span class="p">,</span> <span class="n">new_scope</span><span class="p">,</span> <span class="n">isolation_scope</span> |
117 | | -</span><span data-line="9"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk.traces</span><span class="w"> </span><span class="kn">import</span> <span class="n">StreamedSpan</span> |
| 117 | +</span><span data-line="9"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk.traces</span><span class="w"> </span><span class="kn">import</span> <span class="n">StreamedSpan</span><span class="p">,</span> <span class="n">_get_current_streamed_span</span> |
118 | 118 | </span><span data-line="10"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk.tracing</span><span class="w"> </span><span class="kn">import</span> <span class="n">NoOpSpan</span><span class="p">,</span> <span class="n">Transaction</span><span class="p">,</span> <span class="n">trace</span> |
119 | 119 | </span><span data-line="11"><span class="kn">from</span><span class="w"> </span><span class="nn">sentry_sdk.crons</span><span class="w"> </span><span class="kn">import</span> <span class="n">monitor</span> |
120 | 120 | </span><span data-line="12"> |
@@ -580,7 +580,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre> |
580 | 580 | <a class="viewcode-back" href="../../api.html#sentry_sdk.api.get_current_span">[docs]</a> |
581 | 581 | </span><span data-line="423"><span class="k">def</span><span class="w"> </span><span class="nf">get_current_span</span><span class="p">(</span> |
582 | 582 | </span><span data-line="424"> <span class="n">scope</span><span class="p">:</span> <span class="s2">"Optional[Scope]"</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
583 | | -</span><span data-line="425"><span class="p">)</span> <span class="o">-></span> <span class="s2">"Optional[Union[Span, StreamedSpan]]"</span><span class="p">:</span> |
| 583 | +</span><span data-line="425"><span class="p">)</span> <span class="o">-></span> <span class="s2">"Optional[Span]"</span><span class="p">:</span> |
584 | 584 | </span><span data-line="426"><span class="w"> </span><span class="sd">"""</span> |
585 | 585 | </span><span data-line="427"><span class="sd"> Returns the currently active span if there is one running, otherwise `None`</span> |
586 | 586 | </span><span data-line="428"><span class="sd"> """</span> |
@@ -703,19 +703,19 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre> |
703 | 703 | </span><span data-line="533"><span class="sd"> attributes={"user_id": 123, "batch_size": 50}</span> |
704 | 704 | </span><span data-line="534"><span class="sd"> )</span> |
705 | 705 | </span><span data-line="535"><span class="sd"> """</span> |
706 | | -</span><span data-line="536"> <span class="n">current_span</span> <span class="o">=</span> <span class="n">get_current_span</span><span class="p">()</span> |
707 | | -</span><span data-line="537"> |
708 | | -</span><span data-line="538"> <span class="k">if</span> <span class="n">current_span</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
709 | | -</span><span data-line="539"> <span class="k">return</span> |
710 | | -</span><span data-line="540"> |
711 | | -</span><span data-line="541"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">current_span</span><span class="p">,</span> <span class="n">StreamedSpan</span><span class="p">):</span> |
712 | | -</span><span data-line="542"> <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span> |
713 | | -</span><span data-line="543"> <span class="s2">"The `update_current_span` API isn't available in streaming mode. "</span> |
714 | | -</span><span data-line="544"> <span class="s2">"Retrieve the current span with get_current_span() and use its API "</span> |
715 | | -</span><span data-line="545"> <span class="s2">"directly."</span><span class="p">,</span> |
716 | | -</span><span data-line="546"> <span class="ne">DeprecationWarning</span><span class="p">,</span> |
717 | | -</span><span data-line="547"> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> |
718 | | -</span><span data-line="548"> <span class="p">)</span> |
| 706 | +</span><span data-line="536"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">_get_current_streamed_span</span><span class="p">(),</span> <span class="n">StreamedSpan</span><span class="p">):</span> |
| 707 | +</span><span data-line="537"> <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span> |
| 708 | +</span><span data-line="538"> <span class="s2">"The `update_current_span` API isn't available in streaming mode. "</span> |
| 709 | +</span><span data-line="539"> <span class="s2">"Retrieve the current span with get_current_span() and use its API "</span> |
| 710 | +</span><span data-line="540"> <span class="s2">"directly."</span><span class="p">,</span> |
| 711 | +</span><span data-line="541"> <span class="ne">DeprecationWarning</span><span class="p">,</span> |
| 712 | +</span><span data-line="542"> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> |
| 713 | +</span><span data-line="543"> <span class="p">)</span> |
| 714 | +</span><span data-line="544"> <span class="k">return</span> |
| 715 | +</span><span data-line="545"> |
| 716 | +</span><span data-line="546"> <span class="n">current_span</span> <span class="o">=</span> <span class="n">get_current_span</span><span class="p">()</span> |
| 717 | +</span><span data-line="547"> |
| 718 | +</span><span data-line="548"> <span class="k">if</span> <span class="n">current_span</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
719 | 719 | </span><span data-line="549"> <span class="k">return</span> |
720 | 720 | </span><span data-line="550"> |
721 | 721 | </span><span data-line="551"> <span class="k">if</span> <span class="n">op</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
@@ -771,7 +771,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre> |
771 | 771 | </div> |
772 | 772 | </div> |
773 | 773 | </footer> |
774 | | - <script src="../../_static/documentation_options.js?v=f4b7d0f4"></script> |
| 774 | + <script src="../../_static/documentation_options.js?v=6517ee4d"></script> |
775 | 775 | <script src="../../_static/doctools.js?v=9bcbadda"></script> |
776 | 776 | <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> |
777 | 777 | <script src="../../_static/shibuya.js?v=cac61aee"></script></body> |
|
0 commit comments