4
4
< html xmlns ="http://www.w3.org/1999/xhtml ">
5
5
< head >
6
6
< meta charset ="utf-8 " />
7
- < title > sentry_sdk.api — sentry-python 0.13.0 documentation</ title >
7
+ < title > sentry_sdk.api — sentry-python 0.13.1 documentation</ title >
8
8
< link rel ="stylesheet " href ="../../_static/alabaster.css " type ="text/css " />
9
9
< link rel ="stylesheet " href ="../../_static/pygments.css " type ="text/css " />
10
10
< script type ="text/javascript " id ="documentation_options " data-url_root ="../../ " src ="../../_static/documentation_options.js "> </ script >
@@ -41,6 +41,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
41
41
42
42
< span class ="k "> if</ span > < span class ="n "> MYPY</ span > < span class ="p "> :</ span >
43
43
< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="k "> import</ span > < span class ="n "> Any</ span >
44
+ < span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="k "> import</ span > < span class ="n "> Dict</ span >
44
45
< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="k "> import</ span > < span class ="n "> Optional</ span >
45
46
< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="k "> import</ span > < span class ="n "> overload</ span >
46
47
< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="k "> import</ span > < span class ="n "> Callable</ span >
@@ -69,6 +70,11 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
69
70
< span class ="s2 "> "flush"</ span > < span class ="p "> ,</ span >
70
71
< span class ="s2 "> "last_event_id"</ span > < span class ="p "> ,</ span >
71
72
< span class ="s2 "> "start_span"</ span > < span class ="p "> ,</ span >
73
+ < span class ="s2 "> "set_tag"</ span > < span class ="p "> ,</ span >
74
+ < span class ="s2 "> "set_context"</ span > < span class ="p "> ,</ span >
75
+ < span class ="s2 "> "set_extra"</ span > < span class ="p "> ,</ span >
76
+ < span class ="s2 "> "set_user"</ span > < span class ="p "> ,</ span >
77
+ < span class ="s2 "> "set_level"</ span > < span class ="p "> ,</ span >
72
78
< span class ="p "> ]</ span >
73
79
74
80
@@ -81,6 +87,15 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
81
87
< span class ="k "> return</ span > < span class ="n "> f</ span >
82
88
83
89
90
+ < span class ="k "> def</ span > < span class ="nf "> scopemethod</ span > < span class ="p "> (</ span > < span class ="n "> f</ span > < span class ="p "> ):</ span >
91
+ < span class ="c1 "> # type: (F) -> F</ span >
92
+ < span class ="n "> f</ span > < span class ="o "> .</ span > < span class ="vm "> __doc__</ span > < span class ="o "> =</ span > < span class ="s2 "> "</ span > < span class ="si "> %s</ span > < span class ="se "> \n\n</ span > < span class ="si "> %s</ span > < span class ="s2 "> "</ span > < span class ="o "> %</ span > < span class ="p "> (</ span >
93
+ < span class ="s2 "> "Alias for :py:meth:`sentry_sdk.Scope.</ span > < span class ="si "> %s</ span > < span class ="s2 "> `"</ span > < span class ="o "> %</ span > < span class ="n "> f</ span > < span class ="o "> .</ span > < span class ="vm "> __name__</ span > < span class ="p "> ,</ span >
94
+ < span class ="n "> inspect</ span > < span class ="o "> .</ span > < span class ="n "> getdoc</ span > < span class ="p "> (</ span > < span class ="nb "> getattr</ span > < span class ="p "> (</ span > < span class ="n "> Scope</ span > < span class ="p "> ,</ span > < span class ="n "> f</ span > < span class ="o "> .</ span > < span class ="vm "> __name__</ span > < span class ="p "> )),</ span >
95
+ < span class ="p "> )</ span >
96
+ < span class ="k "> return</ span > < span class ="n "> f</ span >
97
+
98
+
84
99
< div class ="viewcode-block " id ="capture_event "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.capture_event "> [docs]</ a > < span class ="nd "> @hubmethod</ span >
85
100
< span class ="k "> def</ span > < span class ="nf "> capture_event</ span > < span class ="p "> (</ span >
86
101
< span class ="n "> event</ span > < span class ="p "> ,</ span > < span class ="c1 "> # type: Event</ span >
@@ -196,6 +211,46 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
196
211
< span class ="k "> return</ span > < span class ="kc "> None</ span > </ div >
197
212
198
213
214
+ < div class ="viewcode-block " id ="set_tag "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.set_tag "> [docs]</ a > < span class ="nd "> @scopemethod</ span > < span class ="c1 "> # noqa</ span >
215
+ < span class ="k "> def</ span > < span class ="nf "> set_tag</ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="p "> ,</ span > < span class ="n "> value</ span > < span class ="p "> ):</ span >
216
+ < span class ="c1 "> # type: (str, Any) -> None</ span >
217
+ < span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
218
+ < span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
219
+ < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> scope</ span > < span class ="o "> .</ span > < span class ="n "> set_tag</ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="p "> ,</ span > < span class ="n "> value</ span > < span class ="p "> )</ span > </ div >
220
+
221
+
222
+ < div class ="viewcode-block " id ="set_context "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.set_context "> [docs]</ a > < span class ="nd "> @scopemethod</ span > < span class ="c1 "> # noqa</ span >
223
+ < span class ="k "> def</ span > < span class ="nf "> set_context</ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="p "> ,</ span > < span class ="n "> value</ span > < span class ="p "> ):</ span >
224
+ < span class ="c1 "> # type: (str, Any) -> None</ span >
225
+ < span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
226
+ < span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
227
+ < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> scope</ span > < span class ="o "> .</ span > < span class ="n "> set_context</ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="p "> ,</ span > < span class ="n "> value</ span > < span class ="p "> )</ span > </ div >
228
+
229
+
230
+ < div class ="viewcode-block " id ="set_extra "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.set_extra "> [docs]</ a > < span class ="nd "> @scopemethod</ span > < span class ="c1 "> # noqa</ span >
231
+ < span class ="k "> def</ span > < span class ="nf "> set_extra</ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="p "> ,</ span > < span class ="n "> value</ span > < span class ="p "> ):</ span >
232
+ < span class ="c1 "> # type: (str, Any) -> None</ span >
233
+ < span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
234
+ < span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
235
+ < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> scope</ span > < span class ="o "> .</ span > < span class ="n "> set_extra</ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="p "> ,</ span > < span class ="n "> value</ span > < span class ="p "> )</ span > </ div >
236
+
237
+
238
+ < div class ="viewcode-block " id ="set_user "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.set_user "> [docs]</ a > < span class ="nd "> @scopemethod</ span > < span class ="c1 "> # noqa</ span >
239
+ < span class ="k "> def</ span > < span class ="nf "> set_user</ span > < span class ="p "> (</ span > < span class ="n "> value</ span > < span class ="p "> ):</ span >
240
+ < span class ="c1 "> # type: (Dict[str, Any]) -> None</ span >
241
+ < span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
242
+ < span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
243
+ < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> scope</ span > < span class ="o "> .</ span > < span class ="n "> set_user</ span > < span class ="p "> (</ span > < span class ="n "> value</ span > < span class ="p "> )</ span > </ div >
244
+
245
+
246
+ < div class ="viewcode-block " id ="set_level "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.set_level "> [docs]</ a > < span class ="nd "> @scopemethod</ span > < span class ="c1 "> # noqa</ span >
247
+ < span class ="k "> def</ span > < span class ="nf "> set_level</ span > < span class ="p "> (</ span > < span class ="n "> value</ span > < span class ="p "> ):</ span >
248
+ < span class ="c1 "> # type: (str) -> None</ span >
249
+ < span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
250
+ < span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
251
+ < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> scope</ span > < span class ="o "> .</ span > < span class ="n "> set_level</ span > < span class ="p "> (</ span > < span class ="n "> value</ span > < span class ="p "> )</ span > </ div >
252
+
253
+
199
254
< div class ="viewcode-block " id ="flush "> < a class ="viewcode-back " href ="../../api.html#sentry_sdk.flush "> [docs]</ a > < span class ="nd "> @hubmethod</ span >
200
255
< span class ="k "> def</ span > < span class ="nf "> flush</ span > < span class ="p "> (</ span >
201
256
< span class ="n "> timeout</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="c1 "> # type: Optional[float]</ span >
0 commit comments