@@ -1242,7 +1242,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
1242
1242
1243
1243
< div class ="item ">
1244
1244
< div class ="name def " id ="sentry_sdk.add_breadcrumb ">
1245
- < p > def < span class ="ident "> add_breadcrumb</ span > (</ p > < p > *args , **kwargs)</ p >
1245
+ < p > def < span class ="ident "> add_breadcrumb</ span > (</ p > < p > crumb=None, hint=None , **kwargs)</ p >
1246
1246
</ div >
1247
1247
1248
1248
@@ -1257,10 +1257,11 @@ <h2 class="section-title" id="header-functions">Functions</h2>
1257
1257
< p class ="source_link "> < a href ="javascript:void(0); " onclick ="toggle('source-sentry_sdk.add_breadcrumb', this); "> Show source ≡</ a > </ p >
1258
1258
< div id ="source-sentry_sdk.add_breadcrumb " class ="source ">
1259
1259
< div class ="codehilite "> < pre > < span > </ span > < span class ="nd "> @hubmethod</ span >
1260
- < span class ="k "> def</ span > < span class ="nf "> add_breadcrumb</ span > < span class ="p "> (</ span > < span class ="o "> *</ span > < span class ="n "> args</ span > < span class ="p "> ,</ span > < span class ="o "> **</ span > < span class ="n "> kwargs</ span > < span class ="p "> ):</ span >
1260
+ < span class ="k "> def</ span > < span class ="nf "> add_breadcrumb</ span > < span class ="p "> (</ span > < span class ="n "> crumb</ span > < span class ="o "> =</ span > < span class ="bp "> None</ span > < span class ="p "> ,</ span > < span class ="n "> hint</ span > < span class ="o "> =</ span > < span class ="bp "> None</ span > < span class ="p "> ,</ span > < span class ="o "> **</ span > < span class ="n "> kwargs</ span > < span class ="p "> ):</ span >
1261
+ < span class ="c1 "> # type: (Dict[str, Any], Dict[str, Any], **Any) -> None</ span >
1261
1262
< span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
1262
1263
< span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
1263
- < span class ="k "> return</ span > < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> add_breadcrumb</ span > < span class ="p "> (</ span > < span class ="o " > * </ span > < span class ="n "> args </ span > < span class ="p "> ,</ span > < span class ="o "> **</ span > < span class ="n "> kwargs</ span > < span class ="p "> )</ span >
1264
+ < span class ="k "> return</ span > < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> add_breadcrumb</ span > < span class ="p "> (</ span > < span class ="n " > crumb </ span > < span class ="p " > , </ span > < span class =" n "> hint </ span > < span class ="p "> ,</ span > < span class ="o "> **</ span > < span class ="n "> kwargs</ span > < span class ="p "> )</ span >
1264
1265
</ pre > </ div >
1265
1266
1266
1267
</ div >
@@ -1288,9 +1289,11 @@ <h2 class="section-title" id="header-functions">Functions</h2>
1288
1289
< div id ="source-sentry_sdk.capture_event " class ="source ">
1289
1290
< div class ="codehilite "> < pre > < span > </ span > < span class ="nd "> @hubmethod</ span >
1290
1291
< span class ="k "> def</ span > < span class ="nf "> capture_event</ span > < span class ="p "> (</ span > < span class ="n "> event</ span > < span class ="p "> ,</ span > < span class ="n "> hint</ span > < span class ="o "> =</ span > < span class ="bp "> None</ span > < span class ="p "> ):</ span >
1292
+ < span class ="c1 "> # type: (Dict[str, Any], Dict[str, Any]) -> Optional[str]</ span >
1291
1293
< span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
1292
1294
< span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
1293
1295
< span class ="k "> return</ span > < span class ="n "> hub</ 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 >
1296
+ < span class ="k "> return</ span > < span class ="bp "> None</ span >
1294
1297
</ pre > </ div >
1295
1298
1296
1299
</ div >
@@ -1317,7 +1320,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
1317
1320
< div id ="source-sentry_sdk.capture_exception " class ="source ">
1318
1321
< div class ="codehilite "> < pre > < span > </ span > < span class ="nd "> @hubmethod</ span >
1319
1322
< span class ="k "> def</ span > < span class ="nf "> capture_exception</ span > < span class ="p "> (</ span > < span class ="n "> error</ span > < span class ="o "> =</ span > < span class ="bp "> None</ span > < span class ="p "> ):</ span >
1320
- < span class ="c1 "> # type: (ValueError ) -> Optional[str]</ span >
1323
+ < span class ="c1 "> # type: (Optional[BaseException] ) -> Optional[str]</ span >
1321
1324
< span class ="n "> hub</ span > < span class ="o "> =</ span > < span class ="n "> Hub</ span > < span class ="o "> .</ span > < span class ="n "> current</ span >
1322
1325
< span class ="k "> if</ span > < span class ="n "> hub</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
1323
1326
< span class ="k "> return</ span > < span class ="n "> hub</ span > < span class ="o "> .</ span > < span class ="n "> capture_exception</ span > < span class ="p "> (</ span > < span class ="n "> error</ span > < span class ="p "> )</ span >
@@ -1615,9 +1618,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
1615
1618
< span class ="c1 "> # Postprocess the event here so that annotated types do</ span >
1616
1619
< span class ="c1 "> # generally not surface in before_send</ span >
1617
1620
< span class ="k "> if</ span > < span class ="n "> event</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
1621
+ < span class ="n "> event</ span > < span class ="o "> =</ span > < span class ="n "> convert_types</ span > < span class ="p "> (</ span > < span class ="n "> event</ span > < span class ="p "> )</ span >
1618
1622
< span class ="n "> strip_event_mut</ span > < span class ="p "> (</ span > < span class ="n "> event</ span > < span class ="p "> )</ span >
1619
1623
< span class ="n "> event</ span > < span class ="o "> =</ span > < span class ="n "> flatten_metadata</ span > < span class ="p "> (</ span > < span class ="n "> event</ span > < span class ="p "> )</ span >
1620
- < span class ="n "> event</ span > < span class ="o "> =</ span > < span class ="n "> convert_types</ span > < span class ="p "> (</ span > < span class ="n "> event</ span > < span class ="p "> )</ span >
1621
1624
1622
1625
< span class ="n "> before_send</ 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 "> "before_send"</ span > < span class ="p "> ]</ span >
1623
1626
< span class ="k "> if</ span > < span class ="n "> before_send</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
@@ -1980,7 +1983,11 @@ <h3>Methods</h3>
1980
1983
< span class ="k "> return</ span >
1981
1984
1982
1985
< span class ="k "> elif</ span > < span class ="n "> response</ span > < span class ="o "> .</ span > < span class ="n "> status</ span > < span class ="o "> >=</ span > < span class ="mi "> 300</ span > < span class ="ow "> or</ span > < span class ="n "> response</ span > < span class ="o "> .</ span > < span class ="n "> status</ span > < span class ="o "> <</ span > < span class ="mi "> 200</ span > < span class ="p "> :</ span >
1983
- < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "Unexpected status code: </ span > < span class ="si "> %s</ span > < span class ="s2 "> "</ span > < span class ="o "> %</ span > < span class ="n "> response</ span > < span class ="o "> .</ span > < span class ="n "> status</ span > < span class ="p "> )</ span >
1986
+ < span class ="n "> logger</ span > < span class ="o "> .</ span > < span class ="n "> error</ span > < span class ="p "> (</ span >
1987
+ < span class ="s2 "> "Unexpected status code: </ span > < span class ="si "> %s</ span > < span class ="s2 "> (body: </ span > < span class ="si "> %s</ span > < span class ="s2 "> )"</ span > < span class ="p "> ,</ span >
1988
+ < span class ="n "> response</ span > < span class ="o "> .</ span > < span class ="n "> status</ span > < span class ="p "> ,</ span >
1989
+ < span class ="n "> response</ span > < span class ="o "> .</ span > < span class ="n "> data</ span > < span class ="p "> ,</ span >
1990
+ < span class ="p "> )</ span >
1984
1991
< span class ="k "> finally</ span > < span class ="p "> :</ span >
1985
1992
< span class ="n "> response</ span > < span class ="o "> .</ span > < span class ="n "> close</ span > < span class ="p "> ()</ span >
1986
1993
@@ -2331,6 +2338,7 @@ <h3>Methods</h3>
2331
2338
< span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stack</ span > < span class ="p "> [</ span > < span class ="o "> -</ span > < span class ="mi "> 1</ span > < span class ="p "> ][</ span > < span class ="mi "> 0</ span > < span class ="p "> ]</ span >
2332
2339
2333
2340
< span class ="k "> def</ span > < span class ="nf "> last_event_id</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
2341
+ < span class ="c1 "> # type: () -> Optional[str]</ span >
2334
2342
< span class ="sd "> """Returns the last event ID."""</ span >
2335
2343
< span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _last_event_id</ span >
2336
2344
@@ -2368,6 +2376,7 @@ <h3>Methods</h3>
2368
2376
< span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> capture_event</ span > < span class ="p "> ({</ span > < span class ="s2 "> "message"</ span > < span class ="p "> :</ span > < span class ="n "> message</ span > < span class ="p "> ,</ span > < span class ="s2 "> "level"</ span > < span class ="p "> :</ span > < span class ="n "> level</ span > < span class ="p "> })</ span >
2369
2377
2370
2378
< span class ="k "> def</ span > < span class ="nf "> capture_exception</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> error</ span > < span class ="o "> =</ span > < span class ="bp "> None</ span > < span class ="p "> ):</ span >
2379
+ < span class ="c1 "> # type: (Optional[BaseException]) -> Optional[str]</ span >
2371
2380
< span class ="sd "> """Captures an exception.</ span >
2372
2381
2373
2382
< span class ="sd "> The argument passed can be `None` in which case the last exception</ span >
@@ -2376,7 +2385,7 @@ <h3>Methods</h3>
2376
2385
< span class ="sd "> """</ span >
2377
2386
< span class ="n "> client</ span > < span class ="o "> =</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> client</ span >
2378
2387
< span class ="k "> if</ span > < span class ="n "> client</ span > < span class ="ow "> is</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
2379
- < span class ="k "> return</ span >
2388
+ < span class ="k "> return</ span > < span class =" bp " > None </ span >
2380
2389
< span class ="k "> if</ span > < span class ="n "> error</ span > < span class ="ow "> is</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
2381
2390
< span class ="n "> exc_info</ span > < span class ="o "> =</ span > < span class ="n "> sys</ span > < span class ="o "> .</ span > < span class ="n "> exc_info</ span > < span class ="p "> ()</ span >
2382
2391
< span class ="k "> else</ span > < span class ="p "> :</ span >
@@ -2388,6 +2397,8 @@ <h3>Methods</h3>
2388
2397
< span class ="k "> except</ span > < span class ="ne "> Exception</ span > < span class ="p "> :</ span >
2389
2398
< span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _capture_internal_exception</ span > < span class ="p "> (</ span > < span class ="n "> sys</ span > < span class ="o "> .</ span > < span class ="n "> exc_info</ span > < span class ="p "> ())</ span >
2390
2399
2400
+ < span class ="k "> return</ span > < span class ="bp "> None</ span >
2401
+
2391
2402
< span class ="k "> def</ span > < span class ="nf "> _capture_internal_exception</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> exc_info</ span > < span class ="p "> ):</ span >
2392
2403
< span class ="sd "> """Capture an exception that is likely caused by a bug in the SDK</ span >
2393
2404
< span class ="sd "> itself."""</ span >
@@ -2691,14 +2702,15 @@ <h3>Methods</h3>
2691
2702
< p class ="source_link "> < a href ="javascript:void(0); " onclick ="toggle('source-sentry_sdk.Hub.capture_exception', this); "> Show source ≡</ a > </ p >
2692
2703
< div id ="source-sentry_sdk.Hub.capture_exception " class ="source ">
2693
2704
< div class ="codehilite "> < pre > < span > </ span > < span class ="k "> def</ span > < span class ="nf "> capture_exception</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> error</ span > < span class ="o "> =</ span > < span class ="bp "> None</ span > < span class ="p "> ):</ span >
2705
+ < span class ="c1 "> # type: (Optional[BaseException]) -> Optional[str]</ span >
2694
2706
< span class ="sd "> """Captures an exception.</ span >
2695
2707
< span class ="sd "> The argument passed can be `None` in which case the last exception</ span >
2696
2708
< span class ="sd "> will be reported, otherwise an exception object or an `exc_info`</ span >
2697
2709
< span class ="sd "> tuple.</ span >
2698
2710
< span class ="sd "> """</ span >
2699
2711
< span class ="n "> client</ span > < span class ="o "> =</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> client</ span >
2700
2712
< span class ="k "> if</ span > < span class ="n "> client</ span > < span class ="ow "> is</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
2701
- < span class ="k "> return</ span >
2713
+ < span class ="k "> return</ span > < span class =" bp " > None </ span >
2702
2714
< span class ="k "> if</ span > < span class ="n "> error</ span > < span class ="ow "> is</ span > < span class ="bp "> None</ span > < span class ="p "> :</ span >
2703
2715
< span class ="n "> exc_info</ span > < span class ="o "> =</ span > < span class ="n "> sys</ span > < span class ="o "> .</ span > < span class ="n "> exc_info</ span > < span class ="p "> ()</ span >
2704
2716
< span class ="k "> else</ span > < span class ="p "> :</ span >
@@ -2708,6 +2720,7 @@ <h3>Methods</h3>
2708
2720
< span class ="k "> return</ span > < span class ="bp "> self</ 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 ="o "> =</ span > < span class ="n "> hint</ span > < span class ="p "> )</ span >
2709
2721
< span class ="k "> except</ span > < span class ="ne "> Exception</ span > < span class ="p "> :</ span >
2710
2722
< span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _capture_internal_exception</ span > < span class ="p "> (</ span > < span class ="n "> sys</ span > < span class ="o "> .</ span > < span class ="n "> exc_info</ span > < span class ="p "> ())</ span >
2723
+ < span class ="k "> return</ span > < span class ="bp "> None</ span >
2711
2724
</ pre > </ div >
2712
2725
2713
2726
</ div >
@@ -2879,6 +2892,7 @@ <h3>Methods</h3>
2879
2892
< p class ="source_link "> < a href ="javascript:void(0); " onclick ="toggle('source-sentry_sdk.Hub.last_event_id', this); "> Show source ≡</ a > </ p >
2880
2893
< div id ="source-sentry_sdk.Hub.last_event_id " class ="source ">
2881
2894
< div class ="codehilite "> < pre > < span > </ span > < span class ="k "> def</ span > < span class ="nf "> last_event_id</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
2895
+ < span class ="c1 "> # type: () -> Optional[str]</ span >
2882
2896
< span class ="sd "> """Returns the last event ID."""</ span >
2883
2897
< span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _last_event_id</ span >
2884
2898
</ pre > </ div >
0 commit comments