Skip to content

exceptions

ObjectNotPublishedError

Bases: PyOpenMLError

Indicates an object has not been published yet.

Source code in openml/exceptions.py 
66
67
class ObjectNotPublishedError(PyOpenMLError):
    """Indicates an object has not been published yet."""

OpenMLCacheException

Bases: PyOpenMLError

Dataset / task etc not found in cache

Source code in openml/exceptions.py 
40
41
class OpenMLCacheException(PyOpenMLError):  # noqa: N818
    """Dataset / task etc not found in cache"""

OpenMLHashException

Bases: PyOpenMLError

Locally computed hash is different than hash announced by the server.

Source code in openml/exceptions.py 
44
45
class OpenMLHashException(PyOpenMLError):  # noqa: N818
    """Locally computed hash is different than hash announced by the server."""

OpenMLNotAuthorizedError

Bases: OpenMLServerError

Indicates an authenticated user is not authorized to execute the requested action.

Source code in openml/exceptions.py 
62
63
class OpenMLNotAuthorizedError(OpenMLServerError):
    """Indicates an authenticated user is not authorized to execute the requested action."""

OpenMLPrivateDatasetError

Bases: PyOpenMLError

Exception thrown when the user has no rights to access the dataset.

Source code in openml/exceptions.py 
48
49
class OpenMLPrivateDatasetError(PyOpenMLError):
    """Exception thrown when the user has no rights to access the dataset."""

OpenMLRunsExistError

Bases: PyOpenMLError

Indicates run(s) already exists on the server when they should not be duplicated.

Source code in openml/exceptions.py 
52
53
54
55
56
57
58
59
class OpenMLRunsExistError(PyOpenMLError):
    """Indicates run(s) already exists on the server when they should not be duplicated."""

    def __init__(self, run_ids: set[int], message: str) -> None:
        if len(run_ids) < 1:
            raise ValueError("Set of run ids must be non-empty.")
        self.run_ids = run_ids
        super().__init__(message)

OpenMLServerError

Bases: PyOpenMLError

class for when something is really wrong on the server (result did not parse to dict), contains unparsed error.

Source code in openml/exceptions.py 
13
14
15
16
class OpenMLServerError(PyOpenMLError):
    """class for when something is really wrong on the server
    (result did not parse to dict), contains unparsed error.
    """

OpenMLServerException

Bases: OpenMLServerError

exception for when the result of the server was not 200 (e.g., listing call w/o results).

Source code in openml/exceptions.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class OpenMLServerException(OpenMLServerError):  # noqa: N818
    """exception for when the result of the server was
    not 200 (e.g., listing call w/o results).
    """

    # Code needs to be optional to allow the exception to be picklable:
    # https://stackoverflow.com/questions/16244923/how-to-make-a-custom-exception-class-with-multiple-init-args-pickleable  # noqa: E501
    def __init__(self, message: str, code: int | None = None, url: str | None = None):
        self.message = message
        self.code = code
        self.url = url
        super().__init__(message)

    def __str__(self) -> str:
        return f"{self.url} returned code {self.code}: {self.message}"

OpenMLServerNoResult

Bases: OpenMLServerException

Exception for when the result of the server is empty.

Source code in openml/exceptions.py 
36
37
class OpenMLServerNoResult(OpenMLServerException):
    """Exception for when the result of the server is empty."""

PyOpenMLError

Bases: Exception

Base class for all exceptions in OpenML-Python.

Source code in openml/exceptions.py 
 5
 6
 7
 8
 9
10
class PyOpenMLError(Exception):
    """Base class for all exceptions in OpenML-Python."""

    def __init__(self, message: str):
        self.message = message
        super().__init__(message)