Module refinery.lib.exceptions

This module exposes exceptions used by refinery.

"""
This module exposes exceptions used by refinery.
"""
from __future__ import annotations

from refinery.lib.types import Collection, ByteStr


class RefineryPartialResult(ValueError):
    """
    This exception indicates that a partial result is available.
    """
    def __init__(self, message: str, partial: ByteStr, rest: ByteStr | None = None):
        super().__init__(message)
        self.message = message
        self.partial = partial
        self.rest = rest

    def __str__(self):
        return self.message


class RefineryImportMissing(ModuleNotFoundError):
    """
    A special variant of the `ModuleNotFoundError` exception which is raised when a dependency of a
    refinery unit is not installed in the current environment. The exception also provides hints
    about what package has to be installed in order to make that module available.
    """
    def __init__(self, missing: str, dependencies: Collection[str] = (), more: str | None = None):
        super().__init__()
        import shlex
        self.missing = missing
        self.install = ' '.join(shlex.quote(dist) for dist in dependencies)
        self.more = more
        self.dependencies = dependencies or (missing,)

    def __repr__(self):
        return F'{self.__class__.__name__}({self.missing!r})'


class RefineryCriticalException(RuntimeError):
    """
    If this exception is thrown, processing of the entire input stream
    is aborted instead of just aborting the processing of the current
    chunk.
    """
    pass


class RefineryPotentialUserError(RuntimeError):
    """
    This exception can be raised by a unit to inform the user about a
    suspected input error.
    """
    pass


class RefineryException(RuntimeError):
    """
    This is an exception that was not generated by an external library.
    """
    pass

Classes

class RefineryPartialResult (message, partial, rest=None)

This exception indicates that a partial result is available.

Expand source code Browse git

class RefineryPartialResult(ValueError):
    """
    This exception indicates that a partial result is available.
    """
    def __init__(self, message: str, partial: ByteStr, rest: ByteStr | None = None):
        super().__init__(message)
        self.message = message
        self.partial = partial
        self.rest = rest

    def __str__(self):
        return self.message

Ancestors

• builtins.ValueError
• builtins.Exception
• builtins.BaseException

Subclasses

• refinery.units.obfuscation.AutoDeobfuscationTimeout

class RefineryImportMissing (missing, dependencies=(), more=None)

A special variant of the ModuleNotFoundError exception which is raised when a dependency of a refinery unit is not installed in the current environment. The exception also provides hints about what package has to be installed in order to make that module available.

Expand source code Browse git

class RefineryImportMissing(ModuleNotFoundError):
    """
    A special variant of the `ModuleNotFoundError` exception which is raised when a dependency of a
    refinery unit is not installed in the current environment. The exception also provides hints
    about what package has to be installed in order to make that module available.
    """
    def __init__(self, missing: str, dependencies: Collection[str] = (), more: str | None = None):
        super().__init__()
        import shlex
        self.missing = missing
        self.install = ' '.join(shlex.quote(dist) for dist in dependencies)
        self.more = more
        self.dependencies = dependencies or (missing,)

    def __repr__(self):
        return F'{self.__class__.__name__}({self.missing!r})'

Ancestors

• builtins.ModuleNotFoundError
• builtins.ImportError
• builtins.Exception
• builtins.BaseException

class RefineryCriticalException (*args, **kwargs)

If this exception is thrown, processing of the entire input stream is aborted instead of just aborting the processing of the current chunk.

Expand source code Browse git

class RefineryCriticalException(RuntimeError):
    """
    If this exception is thrown, processing of the entire input stream
    is aborted instead of just aborting the processing of the current
    chunk.
    """
    pass

Ancestors

• builtins.RuntimeError
• builtins.Exception
• builtins.BaseException

class RefineryPotentialUserError (*args, **kwargs)

This exception can be raised by a unit to inform the user about a suspected input error.

Expand source code Browse git

class RefineryPotentialUserError(RuntimeError):
    """
    This exception can be raised by a unit to inform the user about a
    suspected input error.
    """
    pass

Ancestors

• builtins.RuntimeError
• builtins.Exception
• builtins.BaseException

class RefineryException (*args, **kwargs)

This is an exception that was not generated by an external library.

Expand source code Browse git

class RefineryException(RuntimeError):
    """
    This is an exception that was not generated by an external library.
    """
    pass

Ancestors

• builtins.RuntimeError
• builtins.Exception
• builtins.BaseException