flytekit.exceptions.scopes

Directory

Errors

Methods

Methods

system_entry_point()

def system_entry_point(
    wrapped,
    args,
    kwargs,
)

The reason these two (see the user one below) decorators exist is to categorize non-Flyte exceptions at arbitrary locations. For example, while there is a separate ecosystem of Flyte-defined user and system exceptions (see the FlyteException hierarchy), and we can easily understand and categorize those, if flytekit comes upon a random ValueError or other non-flytekit defined error, how would we know if it was a bug in flytekit versus an error with user code or something the user called? The purpose of these decorators is to categorize those (see the last case in the nested try/catch below.

Decorator for wrapping functions that enter a system context. This should decorate every method that may invoke some user code later on down the line. This will allow us to add differentiation between what is a user error and what is a system failure. Furthermore, we will clean the exception trace so as to make more sense to the user – allowing them to know if they should take action themselves or pass on to the platform owners. We will dispatch metrics and such appropriately.

user_entry_point()

def user_entry_point(
    wrapped,
    args,
    kwargs,
)

See the comment for the system_entry_point above as well.

Decorator for wrapping functions that enter into a user context. This will help us differentiate user-created failures even when it is re-entrant into system code.

Note: a user_entry_point can ONLY ever be called from within a @system_entry_point wrapped function, therefore, we can always ensure we will hit a system_entry_point to correctly reformat our exceptions. Also, any exception we create here will only be handled within our system code so we don’t need to worry about leaking weird exceptions to the user.

flytekit.exceptions.scopes.FlyteScopedException

class FlyteScopedException(
    context,
    exc_type,
    exc_value,
    exc_tb,
    top_trim,
    bottom_trim,
    kind,
)

Properties

flytekit.exceptions.scopes.FlyteScopedSystemException

class FlyteScopedSystemException(
    exc_type,
    exc_value,
    exc_tb,
    kwargs,
)

Properties

flytekit.exceptions.scopes.FlyteScopedUserException

class FlyteScopedUserException(
    exc_type,
    exc_value,
    exc_tb,
    kwargs,
)

Properties