expose Event type in package api

[fraser-langton]

Problem Statement

Was wondering by the Event type was hidden in a private module _types, I am writing my before_send function and because I am a good pythonista I wanted to type it :)

The type was added in #2753 but maybe it didn't occur to them to add it then?

The same would probably apply to a lot of other types the user might need (hint etc...)

Here is how I currently do it, which is fine, but it doesn't encourage typing

import sentry_sdk
from sentry_sdk._types import Event, Hint


def before_send(event: Event, hint: Hint) -> Event:
    # do some stuff
    ...
    return event


sentry_sdk.init(
    dsn="***",
    before_send=before_send
)

Solution Brainstorm

Add to init? change submodule to public, typing or types?

[alex-goswag]

Would like to add my support for this, we ended up using the Event from types but just as an easier way to browser the types.

Proper type hinting would have been nice at the time or for those unfamiliar with Sentry.

from sentry_sdk.types import Event

def _filter_transactions(event, hint) -> Optional[Event]:
    url_string = event["request"]["url"]
    parsed_url = urlparse(url_string)

    if parsed_url.path == "/health":
        # We don't send transactions for health checks, to avoid spamming Sentry
        return None

    return event

def sentry_initialization():
    sentry_sdk.init(
        dsn="***",    
        before_send_transaction=_filter_transactions,

[sentrivana]

Hey folks, thanks for raising this.

Add to init? change submodule to public, typing or types?

Event is also accessible via the public sentry_sdk.types (see here). We can definitely think about exporting it under just sentry_sdk, too, to make it easier for folks to work with Events in the callbacks we provide. (Same goes for Hint.)

[fraser-langton]

Ok, seems I just missed it then.

Perhaps more just a comment on how little the docs encourage usage of the types, I did look around the docs quite a lot and couldn't find examples.

(also it seems my IDE couldn't find the imports when recommending imports, but that's unrelated)

[sentrivana]

We can definitely make it more discoverable. I imagine if we moved the definition to types directly (instead of just re-exporting it there from _types), IDE completion would probably also work better. I'll see if we can improve this with the next major release. Created an issue to keep track.

A mention in the docs is also a great idea, we can do that for sure. Thanks for the great feedback!

[fraser-langton]

I think just more mentions in the docs would suffice :)

[antonpirker]

Hey @fraser-langton we updated our docs to include the types. Thanks again for raising this. We also have a PR merged that makes more types public which will be released soon: #4315