Skip to content

Commit 7b0c2bf

Browse files
iker-barriocanaliker-barriocanal
committed
Update documentation
1 parent 6a262e7 commit 7b0c2bf

22 files changed

+409
-323
lines changed

‎.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 6dc910e3204d4768a5f2ea3a80f93ff1
3+
config: 21fef46218a88aeb5ad3736c3ec4eb80
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎.doctrees/api.doctree

361 Bytes
Binary file not shown.

‎.doctrees/environment.pickle

1.24 KB
Binary file not shown.

‎.doctrees/index.doctree

-13 Bytes
Binary file not shown.

‎.doctrees/integrations.doctree

-78 Bytes
Binary file not shown.

‎_modules/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<html>
55
<head>
66
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
78
<title>Overview: module code &#8212; sentry-python 0.19.5 documentation</title>
8-
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
1011
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
1112
<script src="../_static/jquery.js"></script>
1213
<script src="../_static/underscore.js"></script>
1314
<script src="../_static/doctools.js"></script>
14-
<script src="../_static/language_data.js"></script>
1515
<link rel="index" title="Index" href="../genindex.html" />
1616
<link rel="search" title="Search" href="../search.html" />
1717

@@ -93,7 +93,7 @@ <h3 id="searchlabel">Quick search</h3>
9393
&copy;2019, Sentry Team and Contributors.
9494

9595
|
96-
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.4</a>
96+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.0</a>
9797
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
9898

9999
</div>

‎_modules/sentry_sdk/api.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<html>
55
<head>
66
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
78
<title>sentry_sdk.api &#8212; sentry-python 0.19.5 documentation</title>
8-
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
1011
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
1112
<script src="../../_static/jquery.js"></script>
1213
<script src="../../_static/underscore.js"></script>
1314
<script src="../../_static/doctools.js"></script>
14-
<script src="../../_static/language_data.js"></script>
1515
<link rel="index" title="Index" href="../../genindex.html" />
1616
<link rel="search" title="Search" href="../../search.html" />
1717

@@ -103,7 +103,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
103103
<span class="n">event</span><span class="p">,</span> <span class="c1"># type: Event</span>
104104
<span class="n">hint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Hint]</span>
105105
<span class="n">scope</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Any]</span>
106-
<span class="o">**</span><span class="n">scope_args</span> <span class="c1"># type: Dict[str, Any]</span>
106+
<span class="o">**</span><span class="n">scope_args</span> <span class="c1"># type: Any</span>
107107
<span class="p">):</span>
108108
<span class="c1"># type: (...) -&gt; Optional[str]</span>
109109
<span class="k">return</span> <span class="n">Hub</span><span class="o">.</span><span class="n">current</span><span class="o">.</span><span class="n">capture_event</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">hint</span><span class="p">,</span> <span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">,</span> <span class="o">**</span><span class="n">scope_args</span><span class="p">)</span></div>
@@ -114,7 +114,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
114114
<span class="n">message</span><span class="p">,</span> <span class="c1"># type: str</span>
115115
<span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[str]</span>
116116
<span class="n">scope</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Any]</span>
117-
<span class="o">**</span><span class="n">scope_args</span> <span class="c1"># type: Dict[str, Any]</span>
117+
<span class="o">**</span><span class="n">scope_args</span> <span class="c1"># type: Any</span>
118118
<span class="p">):</span>
119119
<span class="c1"># type: (...) -&gt; Optional[str]</span>
120120
<span class="k">return</span> <span class="n">Hub</span><span class="o">.</span><span class="n">current</span><span class="o">.</span><span class="n">capture_message</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">,</span> <span class="o">**</span><span class="n">scope_args</span><span class="p">)</span></div>
@@ -124,7 +124,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
124124
<span class="k">def</span> <span class="nf">capture_exception</span><span class="p">(</span>
125125
<span class="n">error</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Union[BaseException, ExcInfo]]</span>
126126
<span class="n">scope</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Any]</span>
127-
<span class="o">**</span><span class="n">scope_args</span> <span class="c1"># type: Dict[str, Any]</span>
127+
<span class="o">**</span><span class="n">scope_args</span> <span class="c1"># type: Any</span>
128128
<span class="p">):</span>
129129
<span class="c1"># type: (...) -&gt; Optional[str]</span>
130130
<span class="k">return</span> <span class="n">Hub</span><span class="o">.</span><span class="n">current</span><span class="o">.</span><span class="n">capture_exception</span><span class="p">(</span><span class="n">error</span><span class="p">,</span> <span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">,</span> <span class="o">**</span><span class="n">scope_args</span><span class="p">)</span></div>
@@ -303,7 +303,7 @@ <h3 id="searchlabel">Quick search</h3>
303303
&copy;2019, Sentry Team and Contributors.
304304

305305
|
306-
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.4</a>
306+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.0</a>
307307
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
308308

309309
</div>

‎_modules/sentry_sdk/client.html

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<html>
55
<head>
66
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
78
<title>sentry_sdk.client &#8212; sentry-python 0.19.5 documentation</title>
8-
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
1011
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
1112
<script src="../../_static/jquery.js"></script>
1213
<script src="../../_static/underscore.js"></script>
1314
<script src="../../_static/doctools.js"></script>
14-
<script src="../../_static/language_data.js"></script>
1515
<link rel="index" title="Index" href="../../genindex.html" />
1616
<link rel="search" title="Search" href="../../search.html" />
1717

@@ -35,7 +35,6 @@ <h1>Source code for sentry_sdk.client</h1><div class="highlight"><pre>
3535
<span class="kn">import</span> <span class="nn">uuid</span>
3636
<span class="kn">import</span> <span class="nn">random</span>
3737
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
38-
<span class="kn">from</span> <span class="nn">itertools</span> <span class="kn">import</span> <span class="n">islice</span>
3938
<span class="kn">import</span> <span class="nn">socket</span>
4039

4140
<span class="kn">from</span> <span class="nn">sentry_sdk._compat</span> <span class="kn">import</span> <span class="n">string_types</span><span class="p">,</span> <span class="n">text_type</span><span class="p">,</span> <span class="n">iteritems</span>
@@ -46,7 +45,6 @@ <h1>Source code for sentry_sdk.client</h1><div class="highlight"><pre>
4645
<span class="n">format_timestamp</span><span class="p">,</span>
4746
<span class="n">get_type_name</span><span class="p">,</span>
4847
<span class="n">get_default_release</span><span class="p">,</span>
49-
<span class="n">get_default_environment</span><span class="p">,</span>
5048
<span class="n">handle_in_app</span><span class="p">,</span>
5149
<span class="n">logger</span><span class="p">,</span>
5250
<span class="p">)</span>
@@ -64,12 +62,11 @@ <h1>Source code for sentry_sdk.client</h1><div class="highlight"><pre>
6462
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
6563
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span>
6664
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
67-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
6865
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
6966

7067
<span class="kn">from</span> <span class="nn">sentry_sdk.scope</span> <span class="kn">import</span> <span class="n">Scope</span>
7168
<span class="kn">from</span> <span class="nn">sentry_sdk._types</span> <span class="kn">import</span> <span class="n">Event</span><span class="p">,</span> <span class="n">Hint</span>
72-
<span class="kn">from</span> <span class="nn">sentry_sdk.sessions</span> <span class="kn">import</span> <span class="n">Session</span>
69+
<span class="kn">from</span> <span class="nn">sentry_sdk.session</span> <span class="kn">import</span> <span class="n">Session</span>
7370

7471

7572
<span class="n">_client_init_debug</span> <span class="o">=</span> <span class="n">ContextVar</span><span class="p">(</span><span class="s2">&quot;client_init_debug&quot;</span><span class="p">)</span>
@@ -100,7 +97,7 @@ <h1>Source code for sentry_sdk.client</h1><div class="highlight"><pre>
10097
<span class="n">rv</span><span class="p">[</span><span class="s2">&quot;release&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">get_default_release</span><span class="p">()</span>
10198

10299
<span class="k">if</span> <span class="n">rv</span><span class="p">[</span><span class="s2">&quot;environment&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
103-
<span class="n">rv</span><span class="p">[</span><span class="s2">&quot;environment&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">get_default_environment</span><span class="p">(</span><span class="n">rv</span><span class="p">[</span><span class="s2">&quot;release&quot;</span><span class="p">])</span>
100+
<span class="n">rv</span><span class="p">[</span><span class="s2">&quot;environment&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;SENTRY_ENVIRONMENT&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">&quot;production&quot;</span>
104101

105102
<span class="k">if</span> <span class="n">rv</span><span class="p">[</span><span class="s2">&quot;server_name&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">socket</span><span class="p">,</span> <span class="s2">&quot;gethostname&quot;</span><span class="p">):</span>
106103
<span class="n">rv</span><span class="p">[</span><span class="s2">&quot;server_name&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostname</span><span class="p">()</span>
@@ -133,24 +130,20 @@ <h1>Source code for sentry_sdk.client</h1><div class="highlight"><pre>
133130
<span class="c1"># type: () -&gt; None</span>
134131
<span class="n">old_debug</span> <span class="o">=</span> <span class="n">_client_init_debug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
135132

136-
<span class="k">def</span> <span class="nf">_send_sessions</span><span class="p">(</span><span class="n">sessions</span><span class="p">):</span>
137-
<span class="c1"># type: (List[Any]) -&gt; None</span>
138-
<span class="n">transport</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transport</span>
139-
<span class="k">if</span> <span class="ow">not</span> <span class="n">transport</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">sessions</span><span class="p">:</span>
140-
<span class="k">return</span>
141-
<span class="n">sessions_iter</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">sessions</span><span class="p">)</span>
142-
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
143-
<span class="n">envelope</span> <span class="o">=</span> <span class="n">Envelope</span><span class="p">()</span>
144-
<span class="k">for</span> <span class="n">session</span> <span class="ow">in</span> <span class="n">islice</span><span class="p">(</span><span class="n">sessions_iter</span><span class="p">,</span> <span class="mi">100</span><span class="p">):</span>
145-
<span class="n">envelope</span><span class="o">.</span><span class="n">add_session</span><span class="p">(</span><span class="n">session</span><span class="p">)</span>
146-
<span class="k">if</span> <span class="ow">not</span> <span class="n">envelope</span><span class="o">.</span><span class="n">items</span><span class="p">:</span>
147-
<span class="k">break</span>
148-
<span class="n">transport</span><span class="o">.</span><span class="n">capture_envelope</span><span class="p">(</span><span class="n">envelope</span><span class="p">)</span>
133+
<span class="k">def</span> <span class="nf">_capture_envelope</span><span class="p">(</span><span class="n">envelope</span><span class="p">):</span>
134+
<span class="c1"># type: (Envelope) -&gt; None</span>
135+
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">transport</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
136+
<span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">capture_envelope</span><span class="p">(</span><span class="n">envelope</span><span class="p">)</span>
149137

150138
<span class="k">try</span><span class="p">:</span>
151139
<span class="n">_client_init_debug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">[</span><span class="s2">&quot;debug&quot;</span><span class="p">])</span>
152140
<span class="bp">self</span><span class="o">.</span><span class="n">transport</span> <span class="o">=</span> <span class="n">make_transport</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">)</span>
153-
<span class="bp">self</span><span class="o">.</span><span class="n">session_flusher</span> <span class="o">=</span> <span class="n">SessionFlusher</span><span class="p">(</span><span class="n">flush_func</span><span class="o">=</span><span class="n">_send_sessions</span><span class="p">)</span>
141+
<span class="n">session_mode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">[</span><span class="s2">&quot;_experiments&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
142+
<span class="s2">&quot;session_mode&quot;</span><span class="p">,</span> <span class="s2">&quot;application&quot;</span>
143+
<span class="p">)</span>
144+
<span class="bp">self</span><span class="o">.</span><span class="n">session_flusher</span> <span class="o">=</span> <span class="n">SessionFlusher</span><span class="p">(</span>
145+
<span class="n">capture_func</span><span class="o">=</span><span class="n">_capture_envelope</span><span class="p">,</span> <span class="n">session_mode</span><span class="o">=</span><span class="n">session_mode</span>
146+
<span class="p">)</span>
154147

155148
<span class="n">request_bodies</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;always&quot;</span><span class="p">,</span> <span class="s2">&quot;never&quot;</span><span class="p">,</span> <span class="s2">&quot;small&quot;</span><span class="p">,</span> <span class="s2">&quot;medium&quot;</span><span class="p">)</span>
156149
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">[</span><span class="s2">&quot;request_bodies&quot;</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">request_bodies</span><span class="p">:</span>
@@ -531,7 +524,7 @@ <h3 id="searchlabel">Quick search</h3>
531524
&copy;2019, Sentry Team and Contributors.
532525

533526
|
534-
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.4</a>
527+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.0</a>
535528
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
536529

537530
</div>

0 commit comments

Comments
 (0)