Skip to content

Reference for hub_sdk/helpers/exceptions.py

Improvements

This page is sourced from https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/helpers/exceptions.py. Have an improvement or example to add? Open a Pull Request — thank you! 🙏


Summary

function hub_sdk.helpers.exceptions.suppress_exceptions

def suppress_exceptions() -> None

Suppress exceptions locally based on the global HUB_EXCEPTIONS flag.

If the HUB_EXCEPTIONS flag is set to False, this function raises the caught exception, allowing it to propagate and be handled elsewhere. If the flag is set to True, the function suppresses the exception, effectively handling it locally.

Examples

# Set the HUB_EXCEPTIONS constant to control exception handling globally
>>> HUB_EXCEPTIONS = False

>>> try:
...     # Your code that may raise an exception
...     pass
... except ValueError as e:
...     # The exception will be suppressed if HUB_EXCEPTIONS is True
...     suppress_exceptions()
...     # Exception handling continues here if HUB_EXCEPTIONS is False

Notes

This function is designed to be used in conjunction with the global HUB_EXCEPTIONS constant to control exception handling behavior across multiple parts of the codebase.

Source code in hub_sdk/helpers/exceptions.pyView on GitHub
def suppress_exceptions() -> None:
    """Suppress exceptions locally based on the global HUB_EXCEPTIONS flag.

    If the HUB_EXCEPTIONS flag is set to False, this function raises the caught exception, allowing it to propagate and
    be handled elsewhere. If the flag is set to True, the function suppresses the exception, effectively handling it
    locally.

    Examples:
        # Set the HUB_EXCEPTIONS constant to control exception handling globally
        >>> HUB_EXCEPTIONS = False

        >>> try:
        ...     # Your code that may raise an exception
        ...     pass
        ... except ValueError as e:
        ...     # The exception will be suppressed if HUB_EXCEPTIONS is True
        ...     suppress_exceptions()
        ...     # Exception handling continues here if HUB_EXCEPTIONS is False

    Notes:
        This function is designed to be used in conjunction with the global HUB_EXCEPTIONS constant
        to control exception handling behavior across multiple parts of the codebase.
    """
    if not HUB_EXCEPTIONS:
        raise