Skip to content

errors

Error translation facilities to map lakeFS API errors to Python-native OS errors in the lakeFS file system.

This is important to honor the fsspec API contract, where users only need to expect builtin Python exceptions to avoid complicated error handling setups.

translate_lakefs_error 

translate_lakefs_error(
    error: ServerException,
    rpath: str | None = None,
    message: str | None = None,
    set_cause: bool = True,
) -> OSError

Convert a lakeFS server exception to a Python builtin exception.

For some subclasses of lakefs.exceptions.ServerException, a direct Python builtin equivalent exists. In these cases, the suitable equivalent is returned. All other classes are converted to a standard IOError.

PARAMETER DESCRIPTION
error

The exception returned by the lakeFS SDK wrapper.

TYPE: ServerException

rpath

The remote resource path involved in the error.

TYPE: str | None DEFAULT: None

message

An error message to use for the returned exception. If not given, the error message returned by the lakeFS server is used instead.

TYPE: str | None DEFAULT: None

set_cause

Whether to set the __cause__ attribute to the previous exception if the exception is translated.

TYPE: bool DEFAULT: True

RETURNS DESCRIPTION
OSError

A builtin Python exception ready to be thrown.
Source code in src/lakefs_spec/errors.py 
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
def translate_lakefs_error(
    error: ServerException,
    rpath: str | None = None,
    message: str | None = None,
    set_cause: bool = True,
) -> OSError:
    """
    Convert a lakeFS server exception to a Python builtin exception.

    For some subclasses of ``lakefs.exceptions.ServerException``, a direct Python builtin equivalent exists.
    In these cases, the suitable equivalent is returned. All other classes are converted to a standard ``IOError``.

    Parameters
    ----------
    error: ServerException
        The exception returned by the lakeFS SDK wrapper.
    rpath: str | None
        The remote resource path involved in the error.
    message: str | None
        An error message to use for the returned exception.
         If not given, the error message returned by the lakeFS server is used instead.
    set_cause: bool
        Whether to set the ``__cause__`` attribute to the previous exception if the exception is translated.

    Returns
    -------
    OSError
        A builtin Python exception ready to be thrown.
    """
    status = error.status_code

    if hasattr(error, "body"):
        # error has a JSON response body attached
        reason = error.body.get("message", "")
    else:
        reason = error.reason

    emsg = f"{status} {reason}".rstrip()
    if rpath:
        emsg += f": {rpath!r}"

    constructor = HTTP_CODE_TO_ERROR.get(status, partial(IOError, errno.EIO))
    custom_exc = constructor(message or emsg)

    if set_cause:
        custom_exc.__cause__ = error
    return custom_exc