Skip to content

Commit 9a6df42

Browse files
docs(python-sdk): add more granularity to types (#12620)
1 parent 786f13e commit 9a6df42

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/platforms/python/configuration/options.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -141,23 +141,23 @@ The `project_root` is used to mark frames in a stack trace either as being in yo
141141

142142
</SdkOption>
143143

144-
<SdkOption name="in_app_include" type='list' defaultValue='[]'>
144+
<SdkOption name="in_app_include" type='list[str]' defaultValue='[]'>
145145

146146
A list of string prefixes of module names that belong to the app. This option takes precedence over `in_app_exclude`.
147147

148148
Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default.
149149

150150
</SdkOption>
151151

152-
<SdkOption name="in_app_exclude" type='list' defaultValue='[]'>
152+
<SdkOption name="in_app_exclude" type='list[str]' defaultValue='[]'>
153153

154154
A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.
155155

156156
This option can be overridden using <PlatformIdentifier name="in_app_include" />.
157157

158158
</SdkOption>
159159

160-
<SdkOption name="max_request_body_size" type='string' defaultValue='medium'>
160+
<SdkOption name="max_request_body_size" type='str' defaultValue='medium'>
161161

162162
This parameter controls whether integrations should capture HTTP request bodies. It can be set to one of the following values:
163163

@@ -195,13 +195,13 @@ Set this boolean to `False` to disable sending of client reports. Client reports
195195

196196
## Integration Configuration
197197

198-
<SdkOption name="integrations" defaultValue='[]'>
198+
<SdkOption name="integrations" type='list[sentry_sdk.integrations.Integration]' defaultValue='[]'>
199199

200200
List of integrations to enable in addition to [auto-enabling integrations](/platforms/python/integrations). This setting can be used to override the default config options for a specific auto-enabling integration or to add an integration that is not auto-enabled.
201201

202202
</SdkOption>
203203

204-
<SdkOption name="disabled_integrations" defaultValue='None'>
204+
<SdkOption name="disabled_integrations" type='list[sentry_sdk.integrations.Integration]' defaultValue='[]'>
205205

206206
List of integrations that will be disabled. This setting can be used to explicitly turn off specific [auto-enabling](/platforms/python/integrations/#available-integrations) or [default](/platforms/python/integrations/default-integrations/) integrations.
207207
</SdkOption>
@@ -250,7 +250,7 @@ The callback typically gets a second argument (called a "hint") which contains t
250250

251251
Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.
252252

253-
<SdkOption name="transport" defaultValue='None'>
253+
<SdkOption name="transport" type='sentry_sdk.transport.Transport' defaultValue='None'>
254254

255255
Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.
256256

@@ -272,7 +272,7 @@ Configures a separate proxy for outgoing HTTPS requests. This value might not be
272272

273273
</SdkOption>
274274

275-
<SdkOption name="proxy_headers" type='dict' defaultValue='None'>
275+
<SdkOption name="proxy_headers" type='dict[str, str]' defaultValue='None'>
276276

277277
A dict containing additional proxy headers (usually for authentication) to be forwarded to `urllib3`'s [`ProxyManager`](https://urllib3.readthedocs.io/en/1.24.3/reference/index.html#urllib3.poolmanager.ProxyManager).
278278

@@ -349,7 +349,7 @@ If <PlatformIdentifier name="trace_propagation_targets" /> is not provided, trac
349349

350350
</SdkOption>
351351

352-
<SdkOption name="functions_to_trace" type='list' defaultValue='[]'>
352+
<SdkOption name="functions_to_trace" type='list[str]' defaultValue='[]'>
353353

354354
An optional list of functions that should be set up for tracing. For each function in the list, a span will be created when the function is executed.
355355
Functions in the list are represented as strings containing the fully qualified name of the function.

0 commit comments

Comments
 (0)