FilesExpand file tree

master

/

api.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

214 lines (164 loc) · 4.67 KB

master

/

api.py

Copy path

Top

File metadata and controls

• Code
• Blame

214 lines (164 loc) · 4.67 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

import inspect

from sentry_sdk.hub import Hub

from sentry_sdk.scope import Scope

from sentry_sdk._types import MYPY

if MYPY:

from typing import Any

from typing import Dict

from typing import Optional

from typing import overload

from typing import Callable

from typing import TypeVar

from typing import ContextManager

from typing import Union

from sentry_sdk._types import Event, Hint, Breadcrumb, BreadcrumbHint, ExcInfo

from sentry_sdk.tracing import Span, Transaction

T = TypeVar("T")

F = TypeVar("F", bound=Callable[..., Any])

else:

def overload(x):

# type: (T) -> T

return x

# When changing this, update __all__ in __init__.py too

__all__ = [

"capture_event",

"capture_message",

"capture_exception",

"add_breadcrumb",

"configure_scope",

"push_scope",

"flush",

"last_event_id",

"start_span",

"start_transaction",

"set_tag",

"set_context",

"set_extra",

"set_user",

"set_level",

]

def hubmethod(f):

# type: (F) -> F

f.__doc__ = "%s\n\n%s" % (

"Alias for :py:meth:`sentry_sdk.Hub.%s`" % f.__name__,

inspect.getdoc(getattr(Hub, f.__name__)),

)

return f

def scopemethod(f):

# type: (F) -> F

f.__doc__ = "%s\n\n%s" % (

"Alias for :py:meth:`sentry_sdk.Scope.%s`" % f.__name__,

inspect.getdoc(getattr(Scope, f.__name__)),

)

return f

@hubmethod

def capture_event(

event, # type: Event

hint=None, # type: Optional[Hint]

scope=None, # type: Optional[Any]

**scope_args # type: Any

):

# type: (...) -> Optional[str]

return Hub.current.capture_event(event, hint, scope=scope, **scope_args)

@hubmethod

def capture_message(

message, # type: str

level=None, # type: Optional[str]

scope=None, # type: Optional[Any]

**scope_args # type: Any

):

# type: (...) -> Optional[str]

return Hub.current.capture_message(message, level, scope=scope, **scope_args)

@hubmethod

def capture_exception(

error=None, # type: Optional[Union[BaseException, ExcInfo]]

scope=None, # type: Optional[Any]

**scope_args # type: Any

):

# type: (...) -> Optional[str]

return Hub.current.capture_exception(error, scope=scope, **scope_args)

@hubmethod

def add_breadcrumb(

crumb=None, # type: Optional[Breadcrumb]

hint=None, # type: Optional[BreadcrumbHint]

**kwargs # type: Any

):

# type: (...) -> None

return Hub.current.add_breadcrumb(crumb, hint, **kwargs)

@overload

def configure_scope(): # noqa: F811

# type: () -> ContextManager[Scope]

pass

@overload

def configure_scope( # noqa: F811

callback, # type: Callable[[Scope], None]

):

# type: (...) -> None

pass

@hubmethod

def configure_scope( # noqa: F811

callback=None, # type: Optional[Callable[[Scope], None]]

):

# type: (...) -> Optional[ContextManager[Scope]]

return Hub.current.configure_scope(callback)

@overload

def push_scope(): # noqa: F811

# type: () -> ContextManager[Scope]

pass

@overload

def push_scope( # noqa: F811

callback, # type: Callable[[Scope], None]

):

# type: (...) -> None

pass

@hubmethod

def push_scope( # noqa: F811

callback=None, # type: Optional[Callable[[Scope], None]]

):

# type: (...) -> Optional[ContextManager[Scope]]

return Hub.current.push_scope(callback)

@scopemethod # noqa

def set_tag(key, value):

# type: (str, Any) -> None

return Hub.current.scope.set_tag(key, value)

@scopemethod # noqa

def set_context(key, value):

# type: (str, Dict[str, Any]) -> None

return Hub.current.scope.set_context(key, value)

@scopemethod # noqa

def set_extra(key, value):

# type: (str, Any) -> None

return Hub.current.scope.set_extra(key, value)

@scopemethod # noqa

def set_user(value):

# type: (Optional[Dict[str, Any]]) -> None

return Hub.current.scope.set_user(value)

@scopemethod # noqa

def set_level(value):

# type: (str) -> None

return Hub.current.scope.set_level(value)

@hubmethod

def flush(

timeout=None, # type: Optional[float]

callback=None, # type: Optional[Callable[[int, float], None]]

):

# type: (...) -> None

return Hub.current.flush(timeout=timeout, callback=callback)

@hubmethod

def last_event_id():

# type: () -> Optional[str]

return Hub.current.last_event_id()

@hubmethod

def start_span(

span=None, # type: Optional[Span]

**kwargs # type: Any

):

# type: (...) -> Span

return Hub.current.start_span(span=span, **kwargs)

@hubmethod

def start_transaction(

transaction=None, # type: Optional[Transaction]

**kwargs # type: Any

):

# type: (...) -> Transaction

return Hub.current.start_transaction(transaction, **kwargs)