RustPython/vm/src/exceptions.rs

use self::types::{PyBaseException, PyBaseExceptionRef};
use crate::common::lock::PyRwLock;
use crate::{
    builtins::{
        traceback::PyTracebackRef, PyNone, PyStr, PyStrRef, PyTuple, PyTupleRef, PyType, PyTypeRef,
    },
    function::{ArgIterable, FuncArgs, IntoPyException, IntoPyObject},
    py_io::{self, Write},
    pyclass::{PyClassImpl, StaticType},
    stdlib::sys,
    suggestion::offer_suggestions,
    AsPyObject, PyContext, PyObjectRef, PyRef, PyResult, PyValue, TryFromObject, TypeProtocol,
    VirtualMachine,
};
use crossbeam_utils::atomic::AtomicCell;
use itertools::Itertools;
use std::{
    collections::HashSet,
    io::{self, BufRead, BufReader},
    ops::Deref,
};

impl std::fmt::Debug for PyBaseException {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        // TODO: implement more detailed, non-recursive Debug formatter
        f.write_str("PyBaseException")
    }
}

impl PyValue for PyBaseException {
    fn class(vm: &VirtualMachine) -> &PyTypeRef {
        &vm.ctx.exceptions.base_exception_type
    }
}

impl VirtualMachine {
    // Why `impl VirtualMachine?
    // These functions are natively free function in CPython - not methods of PyException

    /// Print exception chain by calling sys.excepthook
    pub fn print_exception(&self, exc: PyBaseExceptionRef) {
        let vm = self;
        let write_fallback = |exc, errstr| {
            if let Ok(stderr) = sys::get_stderr(vm) {
                let mut stderr = py_io::PyWriter(stderr, vm);
                // if this fails stderr might be closed -- ignore it
                let _ = writeln!(stderr, "{}", errstr);
                let _ = self.write_exception(&mut stderr, exc);
            } else {
                eprintln!("{}\nlost sys.stderr", errstr);
                let _ = self.write_exception(&mut py_io::IoWriter(io::stderr()), exc);
            }
        };
        if let Ok(excepthook) = vm.sys_module.clone().get_attr("excepthook", vm) {
            let (exc_type, exc_val, exc_tb) = vm.split_exception(exc.clone());
            if let Err(eh_exc) = vm.invoke(&excepthook, (exc_type, exc_val, exc_tb)) {
                write_fallback(&eh_exc, "Error in sys.excepthook:");
                write_fallback(&exc, "Original exception was:");
            }
        } else {
            write_fallback(&exc, "missing sys.excepthook");
        }
    }

    pub fn write_exception<W: Write>(
        &self,
        output: &mut W,
        exc: &PyBaseExceptionRef,
    ) -> Result<(), W::Error> {
        let seen = &mut HashSet::<usize>::new();
        self.write_exception_recursive(output, exc, seen)
    }

    fn write_exception_recursive<W: Write>(
        &self,
        output: &mut W,
        exc: &PyBaseExceptionRef,
        seen: &mut HashSet<usize>,
    ) -> Result<(), W::Error> {
        // This function should not be called directly,
        // use `wite_exception` as a public interface.
        // It is similar to `print_exception_recursive` from `CPython`.
        seen.insert(exc.as_object().get_id());

        #[allow(clippy::manual_map)]
        if let Some((cause_or_context, msg)) = if let Some(cause) = exc.cause() {
            // This can be a special case: `raise e from e`,
            // we just ignore it and treat like `raise e` without any extra steps.
            Some((
                cause,
                "\nThe above exception was the direct cause of the following exception:\n",
            ))
        } else if let Some(context) = exc.context() {
            // This can be a special case:
            //   e = ValueError('e')
            //   e.__context__ = e
            // In this case, we just ignore
            // `__context__` part from going into recursion.
            Some((
                context,
                "\nDuring handling of the above exception, another exception occurred:\n",
            ))
        } else {
            None
        } {
            if !seen.contains(&cause_or_context.as_object().get_id()) {
                self.write_exception_recursive(output, &cause_or_context, seen)?;
                writeln!(output, "{}", msg)?;
            } else {
                seen.insert(cause_or_context.as_object().get_id());
            }
        }

        self.write_exception_inner(output, exc)
    }

    /// Print exception with traceback
    pub fn write_exception_inner<W: Write>(
        &self,
        output: &mut W,
        exc: &PyBaseExceptionRef,
    ) -> Result<(), W::Error> {
        let vm = self;
        if let Some(tb) = exc.traceback.read().clone() {
            writeln!(output, "Traceback (most recent call last):")?;
            for tb in tb.iter() {
                write_traceback_entry(output, &tb)?;
            }
        }

        let varargs = exc.args();
        let args_repr = vm.exception_args_as_string(varargs, true);

        let exc_class = exc.class();
        let exc_name = exc_class.name();
        match args_repr.len() {
            0 => write!(output, "{}", exc_name),
            1 => write!(output, "{}: {}", exc_name, args_repr[0]),
            _ => write!(
                output,
                "{}: ({})",
                exc_name,
                args_repr.into_iter().format(", ")
            ),
        }?;

        match offer_suggestions(exc, vm) {
            Some(suggestions) => writeln!(output, ". Did you mean: '{suggestions}'?"),
            None => writeln!(output),
        }
    }

    fn exception_args_as_string(&self, varargs: PyTupleRef, str_single: bool) -> Vec<PyStrRef> {
        let vm = self;
        let varargs = varargs.as_slice();
        match varargs.len() {
            0 => vec![],
            1 => {
                let args0_repr = if str_single {
                    varargs[0]
                        .str(vm)
                        .unwrap_or_else(|_| PyStr::from("<element str() failed>").into_ref(vm))
                } else {
                    varargs[0]
                        .repr(vm)
                        .unwrap_or_else(|_| PyStr::from("<element repr() failed>").into_ref(vm))
                };
                vec![args0_repr]
            }
            _ => varargs
                .iter()
                .map(|vararg| {
                    vararg
                        .repr(vm)
                        .unwrap_or_else(|_| PyStr::from("<element repr() failed>").into_ref(vm))
                })
                .collect(),
        }
    }

    pub fn split_exception(
        &self,
        exc: PyBaseExceptionRef,
    ) -> (PyObjectRef, PyObjectRef, PyObjectRef) {
        let tb = exc.traceback().into_pyobject(self);
        (exc.clone_class().into(), exc.into(), tb)
    }

    /// Similar to PyErr_NormalizeException in CPython
    pub fn normalize_exception(
        &self,
        exc_type: PyObjectRef,
        exc_val: PyObjectRef,
        exc_tb: PyObjectRef,
    ) -> PyResult<PyBaseExceptionRef> {
        let ctor = ExceptionCtor::try_from_object(self, exc_type)?;
        let exc = ctor.instantiate_value(exc_val, self)?;
        if let Some(tb) = Option::<PyTracebackRef>::try_from_object(self, exc_tb)? {
            exc.set_traceback(Some(tb));
        }
        Ok(exc)
    }

    pub fn invoke_exception(
        &self,
        cls: PyTypeRef,
        args: Vec<PyObjectRef>,
    ) -> PyResult<PyBaseExceptionRef> {
        // TODO: fast-path built-in exceptions by directly instantiating them? Is that really worth it?
        let res = self.invoke(cls.as_object(), args)?;
        PyBaseExceptionRef::try_from_object(self, res)
    }
}

fn print_source_line<W: Write>(
    output: &mut W,
    filename: &str,
    lineno: usize,
) -> Result<(), W::Error> {
    // TODO: use io.open() method instead, when available, according to https://github.com/python/cpython/blob/main/Python/traceback.c#L393
    // TODO: support different encodings
    let file = match std::fs::File::open(filename) {
        Ok(file) => file,
        Err(_) => return Ok(()),
    };
    let file = BufReader::new(file);

    for (i, line) in file.lines().enumerate() {
        if i + 1 == lineno {
            if let Ok(line) = line {
                // Indented with 4 spaces
                writeln!(output, "    {}", line.trim_start())?;
            }
            return Ok(());
        }
    }

    Ok(())
}

/// Print exception occurrence location from traceback element
fn write_traceback_entry<W: Write>(
    output: &mut W,
    tb_entry: &PyTracebackRef,
) -> Result<(), W::Error> {
    let filename = tb_entry.frame.code.source_path.as_str();
    writeln!(
        output,
        r##"  File "{}", line {}, in {}"##,
        filename, tb_entry.lineno, tb_entry.frame.code.obj_name
    )?;
    print_source_line(output, filename, tb_entry.lineno)?;

    Ok(())
}

#[derive(Clone)]
pub enum ExceptionCtor {
    Class(PyTypeRef),
    Instance(PyBaseExceptionRef),
}

impl TryFromObject for ExceptionCtor {
    fn try_from_object(vm: &VirtualMachine, obj: PyObjectRef) -> PyResult<Self> {
        obj.downcast::<PyType>()
            .and_then(|cls| {
                if cls.issubclass(&vm.ctx.exceptions.base_exception_type) {
                    Ok(Self::Class(cls))
                } else {
                    Err(cls.into())
                }
            })
            .or_else(|obj| obj.downcast::<PyBaseException>().map(Self::Instance))
            .map_err(|obj| {
                vm.new_type_error(format!(
                    "exceptions must be classes or instances deriving from BaseException, not {}",
                    obj.class().name()
                ))
            })
    }
}

impl ExceptionCtor {
    pub fn instantiate(self, vm: &VirtualMachine) -> PyResult<PyBaseExceptionRef> {
        match self {
            Self::Class(cls) => vm.invoke_exception(cls, vec![]),
            Self::Instance(exc) => Ok(exc),
        }
    }

    pub fn instantiate_value(
        self,
        value: PyObjectRef,
        vm: &VirtualMachine,
    ) -> PyResult<PyBaseExceptionRef> {
        let exc_inst = value.clone().downcast::<PyBaseException>().ok();
        match (self, exc_inst) {
            // both are instances; which would we choose?
            (Self::Instance(_exc_a), Some(_exc_b)) => {
                Err(vm
                    .new_type_error("instance exception may not have a separate value".to_owned()))
            }
            // if the "type" is an instance and the value isn't, use the "type"
            (Self::Instance(exc), None) => Ok(exc),
            // if the value is an instance of the type, use the instance value
            (Self::Class(cls), Some(exc)) if exc.isinstance(&cls) => Ok(exc),
            // otherwise; construct an exception of the type using the value as args
            (Self::Class(cls), _) => {
                let args = match_class!(match value {
                    PyNone => vec![],
                    tup @ PyTuple => tup.as_slice().to_vec(),
                    exc @ PyBaseException => exc.args().as_slice().to_vec(),
                    obj => vec![obj],
                });
                vm.invoke_exception(cls, args)
            }
        }
    }
}

#[derive(Debug, Clone)]
pub struct ExceptionZoo {
    pub base_exception_type: PyTypeRef,
    pub system_exit: PyTypeRef,
    pub keyboard_interrupt: PyTypeRef,
    pub generator_exit: PyTypeRef,
    pub exception_type: PyTypeRef,
    pub stop_iteration: PyTypeRef,
    pub stop_async_iteration: PyTypeRef,
    pub arithmetic_error: PyTypeRef,
    pub floating_point_error: PyTypeRef,
    pub overflow_error: PyTypeRef,
    pub zero_division_error: PyTypeRef,
    pub assertion_error: PyTypeRef,
    pub attribute_error: PyTypeRef,
    pub buffer_error: PyTypeRef,
    pub eof_error: PyTypeRef,
    pub import_error: PyTypeRef,
    pub module_not_found_error: PyTypeRef,
    pub lookup_error: PyTypeRef,
    pub index_error: PyTypeRef,
    pub key_error: PyTypeRef,
    pub memory_error: PyTypeRef,
    pub name_error: PyTypeRef,
    pub unbound_local_error: PyTypeRef,
    pub os_error: PyTypeRef,
    pub blocking_io_error: PyTypeRef,
    pub child_process_error: PyTypeRef,
    pub connection_error: PyTypeRef,
    pub broken_pipe_error: PyTypeRef,
    pub connection_aborted_error: PyTypeRef,
    pub connection_refused_error: PyTypeRef,
    pub connection_reset_error: PyTypeRef,
    pub file_exists_error: PyTypeRef,
    pub file_not_found_error: PyTypeRef,
    pub interrupted_error: PyTypeRef,
    pub is_a_directory_error: PyTypeRef,
    pub not_a_directory_error: PyTypeRef,
    pub permission_error: PyTypeRef,
    pub process_lookup_error: PyTypeRef,
    pub timeout_error: PyTypeRef,
    pub reference_error: PyTypeRef,
    pub runtime_error: PyTypeRef,
    pub not_implemented_error: PyTypeRef,
    pub recursion_error: PyTypeRef,
    pub syntax_error: PyTypeRef,
    pub indentation_error: PyTypeRef,
    pub tab_error: PyTypeRef,
    pub system_error: PyTypeRef,
    pub type_error: PyTypeRef,
    pub value_error: PyTypeRef,
    pub unicode_error: PyTypeRef,
    pub unicode_decode_error: PyTypeRef,
    pub unicode_encode_error: PyTypeRef,
    pub unicode_translate_error: PyTypeRef,

    #[cfg(feature = "jit")]
    pub jit_error: PyTypeRef,

    pub warning: PyTypeRef,
    pub deprecation_warning: PyTypeRef,
    pub pending_deprecation_warning: PyTypeRef,
    pub runtime_warning: PyTypeRef,
    pub syntax_warning: PyTypeRef,
    pub user_warning: PyTypeRef,
    pub future_warning: PyTypeRef,
    pub import_warning: PyTypeRef,
    pub unicode_warning: PyTypeRef,
    pub bytes_warning: PyTypeRef,
    pub resource_warning: PyTypeRef,
    pub encoding_warning: PyTypeRef,
}

macro_rules! extend_exception {
    (
        $exc_struct:ident,
        $ctx:expr,
        $class:expr
    ) => {
        extend_exception!($exc_struct, $ctx, $class, {});
    };
    (
        $exc_struct:ident,
        $ctx:expr,
        $class:expr,
        { $($name:expr => $value:expr),* $(,)* }
    ) => {
        $exc_struct::extend_class($ctx, $class);
        extend_class!($ctx, $class, {
            $($name => $value,)*
        });
    };
}

#[pyimpl(flags(BASETYPE, HAS_DICT))]
impl PyBaseException {
    pub(crate) fn new(args: Vec<PyObjectRef>, vm: &VirtualMachine) -> PyBaseException {
        PyBaseException {
            traceback: PyRwLock::new(None),
            cause: PyRwLock::new(None),
            context: PyRwLock::new(None),
            suppress_context: AtomicCell::new(false),
            args: PyRwLock::new(PyTuple::new_ref(args, &vm.ctx)),
        }
    }

    #[pyslot]
    pub(crate) fn slot_new(cls: PyTypeRef, args: FuncArgs, vm: &VirtualMachine) -> PyResult {
        PyBaseException::new(args.args, vm).into_pyresult_with_type(vm, cls)
    }

    #[pymethod(magic)]
    pub(crate) fn init(zelf: PyRef<Self>, args: FuncArgs, vm: &VirtualMachine) -> PyResult<()> {
        *zelf.args.write() = PyTuple::new_ref(args.args, &vm.ctx);
        Ok(())
    }

    pub fn get_arg(&self, idx: usize) -> Option<PyObjectRef> {
        self.args.read().as_slice().get(idx).cloned()
    }

    #[pyproperty]
    pub fn args(&self) -> PyTupleRef {
        self.args.read().clone()
    }

    #[pyproperty(setter)]
    fn set_args(&self, args: ArgIterable, vm: &VirtualMachine) -> PyResult<()> {
        let args = args.iter(vm)?.collect::<PyResult<Vec<_>>>()?;
        *self.args.write() = PyTuple::new_ref(args, &vm.ctx);
        Ok(())
    }

    #[pyproperty(magic)]
    pub fn traceback(&self) -> Option<PyTracebackRef> {
        self.traceback.read().clone()
    }

    #[pyproperty(magic, setter)]
    pub fn set_traceback(&self, traceback: Option<PyTracebackRef>) {
        *self.traceback.write() = traceback;
    }

    #[pyproperty(magic)]
    pub fn cause(&self) -> Option<PyRef<Self>> {
        self.cause.read().clone()
    }

    #[pyproperty(magic, setter)]
    pub fn set_cause(&self, cause: Option<PyRef<Self>>) {
        let mut c = self.cause.write();
        self.set_suppress_context(true);
        *c = cause;
    }

    #[pyproperty(magic)]
    pub fn context(&self) -> Option<PyRef<Self>> {
        self.context.read().clone()
    }

    #[pyproperty(magic, setter)]
    pub fn set_context(&self, context: Option<PyRef<Self>>) {
        *self.context.write() = context;
    }

    #[pyproperty(name = "__suppress_context__")]
    pub(super) fn get_suppress_context(&self) -> bool {
        self.suppress_context.load()
    }

    #[pyproperty(name = "__suppress_context__", setter)]
    fn set_suppress_context(&self, suppress_context: bool) {
        self.suppress_context.store(suppress_context);
    }

    #[pymethod]
    fn with_traceback(zelf: PyRef<Self>, tb: Option<PyTracebackRef>) -> PyResult {
        *zelf.traceback.write() = tb;
        Ok(zelf.as_object().to_owned())
    }

    #[pymethod(magic)]
    pub(super) fn str(&self, vm: &VirtualMachine) -> PyStrRef {
        let str_args = vm.exception_args_as_string(self.args(), true);
        match str_args.into_iter().exactly_one() {
            Err(i) if i.len() == 0 => PyStr::from("").into_ref(vm),
            Ok(s) => s,
            Err(i) => PyStr::from(format!("({})", i.format(", "))).into_ref(vm),
        }
    }

    #[pymethod(magic)]
    fn repr(zelf: PyRef<Self>, vm: &VirtualMachine) -> String {
        let repr_args = vm.exception_args_as_string(zelf.args(), false);
        let cls = zelf.class();
        format!("{}({})", cls.name(), repr_args.iter().format(", "))
    }
}

impl ExceptionZoo {
    pub(crate) fn init() -> Self {
        use self::types::*;

        let base_exception_type = PyBaseException::init_bare_type().clone();

        // Sorted By Hierarchy then alphabetized.
        let system_exit = PySystemExit::init_bare_type().clone();
        let keyboard_interrupt = PyKeyboardInterrupt::init_bare_type().clone();
        let generator_exit = PyGeneratorExit::init_bare_type().clone();

        let exception_type = PyException::init_bare_type().clone();
        let stop_iteration = PyStopIteration::init_bare_type().clone();
        let stop_async_iteration = PyStopAsyncIteration::init_bare_type().clone();
        let arithmetic_error = PyArithmeticError::init_bare_type().clone();
        let floating_point_error = PyFloatingPointError::init_bare_type().clone();
        let overflow_error = PyOverflowError::init_bare_type().clone();
        let zero_division_error = PyZeroDivisionError::init_bare_type().clone();

        let assertion_error = PyAssertionError::init_bare_type().clone();
        let attribute_error = PyAttributeError::init_bare_type().clone();
        let buffer_error = PyBufferError::init_bare_type().clone();
        let eof_error = PyEOFError::init_bare_type().clone();

        let import_error = PyImportError::init_bare_type().clone();
        let module_not_found_error = PyModuleNotFoundError::init_bare_type().clone();

        let lookup_error = PyLookupError::init_bare_type().clone();
        let index_error = PyIndexError::init_bare_type().clone();
        let key_error = PyKeyError::init_bare_type().clone();

        let memory_error = PyMemoryError::init_bare_type().clone();

        let name_error = PyNameError::init_bare_type().clone();
        let unbound_local_error = PyUnboundLocalError::init_bare_type().clone();

        // os errors
        let os_error = PyOSError::init_bare_type().clone();
        let blocking_io_error = PyBlockingIOError::init_bare_type().clone();
        let child_process_error = PyChildProcessError::init_bare_type().clone();

        let connection_error = PyConnectionError::init_bare_type().clone();
        let broken_pipe_error = PyBrokenPipeError::init_bare_type().clone();
        let connection_aborted_error = PyConnectionAbortedError::init_bare_type().clone();
        let connection_refused_error = PyConnectionRefusedError::init_bare_type().clone();
        let connection_reset_error = PyConnectionResetError::init_bare_type().clone();

        let file_exists_error = PyFileExistsError::init_bare_type().clone();
        let file_not_found_error = PyFileNotFoundError::init_bare_type().clone();
        let interrupted_error = PyInterruptedError::init_bare_type().clone();
        let is_a_directory_error = PyIsADirectoryError::init_bare_type().clone();
        let not_a_directory_error = PyNotADirectoryError::init_bare_type().clone();
        let permission_error = PyPermissionError::init_bare_type().clone();
        let process_lookup_error = PyProcessLookupError::init_bare_type().clone();
        let timeout_error = PyTimeoutError::init_bare_type().clone();

        let reference_error = PyReferenceError::init_bare_type().clone();

        let runtime_error = PyRuntimeError::init_bare_type().clone();
        let not_implemented_error = PyNotImplementedError::init_bare_type().clone();
        let recursion_error = PyRecursionError::init_bare_type().clone();

        let syntax_error = PySyntaxError::init_bare_type().clone();
        let indentation_error = PyIndentationError::init_bare_type().clone();
        let tab_error = PyTabError::init_bare_type().clone();

        let system_error = PySystemError::init_bare_type().clone();
        let type_error = PyTypeError::init_bare_type().clone();
        let value_error = PyValueError::init_bare_type().clone();
        let unicode_error = PyUnicodeError::init_bare_type().clone();
        let unicode_decode_error = PyUnicodeDecodeError::init_bare_type().clone();
        let unicode_encode_error = PyUnicodeEncodeError::init_bare_type().clone();
        let unicode_translate_error = PyUnicodeTranslateError::init_bare_type().clone();

        #[cfg(feature = "jit")]
        let jit_error = PyJitError::init_bare_type().clone();

        let warning = PyWarning::init_bare_type().clone();
        let deprecation_warning = PyDeprecationWarning::init_bare_type().clone();
        let pending_deprecation_warning = PyPendingDeprecationWarning::init_bare_type().clone();
        let runtime_warning = PyRuntimeWarning::init_bare_type().clone();
        let syntax_warning = PySyntaxWarning::init_bare_type().clone();
        let user_warning = PyUserWarning::init_bare_type().clone();
        let future_warning = PyFutureWarning::init_bare_type().clone();
        let import_warning = PyImportWarning::init_bare_type().clone();
        let unicode_warning = PyUnicodeWarning::init_bare_type().clone();
        let bytes_warning = PyBytesWarning::init_bare_type().clone();
        let resource_warning = PyResourceWarning::init_bare_type().clone();
        let encoding_warning = PyEncodingWarning::init_bare_type().clone();

        Self {
            base_exception_type,
            system_exit,
            keyboard_interrupt,
            generator_exit,
            exception_type,
            stop_iteration,
            stop_async_iteration,
            arithmetic_error,
            floating_point_error,
            overflow_error,
            zero_division_error,
            assertion_error,
            attribute_error,
            buffer_error,
            eof_error,
            import_error,
            module_not_found_error,
            lookup_error,
            index_error,
            key_error,
            memory_error,
            name_error,
            unbound_local_error,
            os_error,
            blocking_io_error,
            child_process_error,
            connection_error,
            broken_pipe_error,
            connection_aborted_error,
            connection_refused_error,
            connection_reset_error,
            file_exists_error,
            file_not_found_error,
            interrupted_error,
            is_a_directory_error,
            not_a_directory_error,
            permission_error,
            process_lookup_error,
            timeout_error,
            reference_error,
            runtime_error,
            not_implemented_error,
            recursion_error,
            syntax_error,
            indentation_error,
            tab_error,
            system_error,
            type_error,
            value_error,
            unicode_error,
            unicode_decode_error,
            unicode_encode_error,
            unicode_translate_error,

            #[cfg(feature = "jit")]
            jit_error,

            warning,
            deprecation_warning,
            pending_deprecation_warning,
            runtime_warning,
            syntax_warning,
            user_warning,
            future_warning,
            import_warning,
            unicode_warning,
            bytes_warning,
            resource_warning,
            encoding_warning,
        }
    }

    // TODO: remove it after fixing `errno` / `winerror` problem
    #[allow(clippy::redundant_clone)]
    pub fn extend(ctx: &PyContext) {
        use self::types::*;

        let excs = &ctx.exceptions;

        PyBaseException::extend_class(ctx, &excs.base_exception_type);

        // Sorted By Hierarchy then alphabetized.
        extend_exception!(PySystemExit, ctx, &excs.system_exit, {
            "code" => ctx.new_readonly_getset("code", excs.system_exit.clone(), system_exit_code),
        });
        extend_exception!(PyKeyboardInterrupt, ctx, &excs.keyboard_interrupt);
        extend_exception!(PyGeneratorExit, ctx, &excs.generator_exit);

        extend_exception!(PyException, ctx, &excs.exception_type);

        extend_exception!(PyStopIteration, ctx, &excs.stop_iteration, {
            "value" => ctx.new_readonly_getset("value", excs.stop_iteration.clone(), make_arg_getter(0)),
        });
        extend_exception!(PyStopAsyncIteration, ctx, &excs.stop_async_iteration);

        extend_exception!(PyArithmeticError, ctx, &excs.arithmetic_error);
        extend_exception!(PyFloatingPointError, ctx, &excs.floating_point_error);
        extend_exception!(PyOverflowError, ctx, &excs.overflow_error);
        extend_exception!(PyZeroDivisionError, ctx, &excs.zero_division_error);

        extend_exception!(PyAssertionError, ctx, &excs.assertion_error);
        extend_exception!(PyAttributeError, ctx, &excs.attribute_error, {
            "name" => ctx.none(),
            "obj" => ctx.none(),
        });
        extend_exception!(PyBufferError, ctx, &excs.buffer_error);
        extend_exception!(PyEOFError, ctx, &excs.eof_error);

        extend_exception!(PyImportError, ctx, &excs.import_error, {
            "msg" => ctx.new_readonly_getset("msg", excs.import_error.clone(), make_arg_getter(0)),
        });
        extend_exception!(PyModuleNotFoundError, ctx, &excs.module_not_found_error);

        extend_exception!(PyLookupError, ctx, &excs.lookup_error);
        extend_exception!(PyIndexError, ctx, &excs.index_error);
        extend_exception!(PyKeyError, ctx, &excs.key_error, {
            "__str__" => ctx.new_method("__str__", excs.key_error.clone(), key_error_str),
        });

        extend_exception!(PyMemoryError, ctx, &excs.memory_error);
        extend_exception!(PyNameError, ctx, &excs.name_error, {
            "name" => ctx.none(),
        });
        extend_exception!(PyUnboundLocalError, ctx, &excs.unbound_local_error);

        // os errors:
        let errno_getter =
            ctx.new_readonly_getset("errno", excs.os_error.clone(), |exc: PyBaseExceptionRef| {
                let args = exc.args();
                let args = args.as_slice();
                args.get(0).filter(|_| args.len() > 1).cloned()
            });
        extend_exception!(PyOSError, ctx, &excs.os_error, {
            // POSIX exception code
            "errno" => errno_getter.clone(),
            // exception strerror
            "strerror" => ctx.new_readonly_getset("strerror", excs.os_error.clone(), make_arg_getter(1)),
            // exception filename
            "filename" => ctx.none(),
            // second exception filename
            "filename2" => ctx.none(),
            "__str__" => ctx.new_method("__str__", excs.os_error.clone(), os_error_str),
        });
        // TODO: this isn't really accurate
        #[cfg(windows)]
        excs.os_error.set_str_attr("winerror", errno_getter.clone());

        extend_exception!(PyBlockingIOError, ctx, &excs.blocking_io_error);
        extend_exception!(PyChildProcessError, ctx, &excs.child_process_error);

        extend_exception!(PyConnectionError, ctx, &excs.connection_error);
        extend_exception!(PyBrokenPipeError, ctx, &excs.broken_pipe_error);
        extend_exception!(
            PyConnectionAbortedError,
            ctx,
            &excs.connection_aborted_error
        );
        extend_exception!(
            PyConnectionRefusedError,
            ctx,
            &excs.connection_refused_error
        );
        extend_exception!(PyConnectionResetError, ctx, &excs.connection_reset_error);

        extend_exception!(PyFileExistsError, ctx, &excs.file_exists_error);
        extend_exception!(PyFileNotFoundError, ctx, &excs.file_not_found_error);
        extend_exception!(PyInterruptedError, ctx, &excs.interrupted_error);
        extend_exception!(PyIsADirectoryError, ctx, &excs.is_a_directory_error);
        extend_exception!(PyNotADirectoryError, ctx, &excs.not_a_directory_error);
        extend_exception!(PyPermissionError, ctx, &excs.permission_error);
        extend_exception!(PyProcessLookupError, ctx, &excs.process_lookup_error);
        extend_exception!(PyTimeoutError, ctx, &excs.timeout_error);

        extend_exception!(PyReferenceError, ctx, &excs.reference_error);
        extend_exception!(PyRuntimeError, ctx, &excs.runtime_error);
        extend_exception!(PyNotImplementedError, ctx, &excs.not_implemented_error);
        extend_exception!(PyRecursionError, ctx, &excs.recursion_error);

        extend_exception!(PySyntaxError, ctx, &excs.syntax_error, {
            "msg" => ctx.new_readonly_getset("msg", excs.syntax_error.clone(), make_arg_getter(0)),
            // TODO: members
            "filename" => ctx.none(),
            "lineno" => ctx.none(),
            "offset" => ctx.none(),
            "text" => ctx.none(),
        });
        extend_exception!(PyIndentationError, ctx, &excs.indentation_error);
        extend_exception!(PyTabError, ctx, &excs.tab_error);

        extend_exception!(PySystemError, ctx, &excs.system_error);
        extend_exception!(PyTypeError, ctx, &excs.type_error);
        extend_exception!(PyValueError, ctx, &excs.value_error);
        extend_exception!(PyUnicodeError, ctx, &excs.unicode_error);
        extend_exception!(PyUnicodeDecodeError, ctx, &excs.unicode_decode_error, {
            "encoding" => ctx.new_readonly_getset("encoding", excs.unicode_decode_error.clone(), make_arg_getter(0)),
            "object" => ctx.new_readonly_getset("object", excs.unicode_decode_error.clone(), make_arg_getter(1)),
            "start" => ctx.new_readonly_getset("start", excs.unicode_decode_error.clone(), make_arg_getter(2)),
            "end" => ctx.new_readonly_getset("end", excs.unicode_decode_error.clone(), make_arg_getter(3)),
            "reason" => ctx.new_readonly_getset("reason", excs.unicode_decode_error.clone(), make_arg_getter(4)),
        });
        extend_exception!(PyUnicodeEncodeError, ctx, &excs.unicode_encode_error, {
            "encoding" => ctx.new_readonly_getset("encoding", excs.unicode_encode_error.clone(), make_arg_getter(0)),
            "object" => ctx.new_readonly_getset("object", excs.unicode_encode_error.clone(), make_arg_getter(1)),
            "start" => ctx.new_readonly_getset("start", excs.unicode_encode_error.clone(), make_arg_getter(2), ),
            "end" => ctx.new_readonly_getset("end", excs.unicode_encode_error.clone(), make_arg_getter(3)),
            "reason" => ctx.new_readonly_getset("reason", excs.unicode_encode_error.clone(), make_arg_getter(4)),
        });
        extend_exception!(PyUnicodeTranslateError, ctx, &excs.unicode_translate_error, {
            "encoding" => ctx.new_readonly_getset("encoding", excs.unicode_translate_error.clone(), none_getter),
            "object" => ctx.new_readonly_getset("object", excs.unicode_translate_error.clone(), make_arg_getter(0)),
            "start" => ctx.new_readonly_getset("start", excs.unicode_translate_error.clone(), make_arg_getter(1)),
            "end" => ctx.new_readonly_getset("end", excs.unicode_translate_error.clone(), make_arg_getter(2)),
            "reason" => ctx.new_readonly_getset("reason", excs.unicode_translate_error.clone(), make_arg_getter(3)),
        });

        #[cfg(feature = "jit")]
        extend_exception!(PyJitError, ctx, &excs.jit_error);

        extend_exception!(PyWarning, ctx, &excs.warning);
        extend_exception!(PyDeprecationWarning, ctx, &excs.deprecation_warning);
        extend_exception!(
            PyPendingDeprecationWarning,
            ctx,
            &excs.pending_deprecation_warning
        );
        extend_exception!(PyRuntimeWarning, ctx, &excs.runtime_warning);
        extend_exception!(PySyntaxWarning, ctx, &excs.syntax_warning);
        extend_exception!(PyUserWarning, ctx, &excs.user_warning);
        extend_exception!(PyFutureWarning, ctx, &excs.future_warning);
        extend_exception!(PyImportWarning, ctx, &excs.import_warning);
        extend_exception!(PyUnicodeWarning, ctx, &excs.unicode_warning);
        extend_exception!(PyBytesWarning, ctx, &excs.bytes_warning);
        extend_exception!(PyResourceWarning, ctx, &excs.resource_warning);
        extend_exception!(PyEncodingWarning, ctx, &excs.encoding_warning);
    }
}

fn none_getter(_obj: PyObjectRef, vm: &VirtualMachine) -> PyRef<PyNone> {
    vm.ctx.none.clone()
}

fn make_arg_getter(idx: usize) -> impl Fn(PyBaseExceptionRef) -> Option<PyObjectRef> {
    move |exc| exc.get_arg(idx)
}

fn key_error_str(exc: PyBaseExceptionRef, vm: &VirtualMachine) -> PyStrRef {
    let args = exc.args();
    if args.as_slice().len() == 1 {
        vm.exception_args_as_string(args, false)
            .into_iter()
            .exactly_one()
            .unwrap()
    } else {
        exc.str(vm)
    }
}

fn os_error_str(exc: PyBaseExceptionRef, vm: &VirtualMachine) -> PyResult<PyStrRef> {
    let args = exc.args();
    let obj = exc.as_object().to_owned();

    if args.as_slice().len() == 2 {
        // SAFETY: len() == 2 is checked so get_arg 1 or 2 won't panic
        let errno = exc.get_arg(0).unwrap().str(vm)?;
        let msg = exc.get_arg(1).unwrap().str(vm)?;

        let s = match obj.clone().get_attr("filename", vm) {
            Ok(filename) => match obj.get_attr("filename2", vm) {
                Ok(filename2) => format!(
                    "[Errno {}] {}: '{}' -> '{}'",
                    errno,
                    msg,
                    filename.str(vm)?,
                    filename2.str(vm)?
                ),
                Err(_) => format!("[Errno {}] {}: '{}'", errno, msg, filename.str(vm)?),
            },
            Err(_) => {
                format!("[Errno {}] {}", errno, msg)
            }
        };
        Ok(vm.ctx.new_str(s))
    } else {
        Ok(exc.str(vm))
    }
}

fn system_exit_code(exc: PyBaseExceptionRef) -> Option<PyObjectRef> {
    exc.args.read().as_slice().first().map(|code| {
        match_class!(match code {
            ref tup @ PyTuple => match tup.as_slice() {
                [x] => x.clone(),
                _ => code.clone(),
            },
            other => other.clone(),
        })
    })
}

pub struct SerializeException<'s> {
    vm: &'s VirtualMachine,
    exc: &'s PyBaseExceptionRef,
}

impl<'s> SerializeException<'s> {
    pub fn new(vm: &'s VirtualMachine, exc: &'s PyBaseExceptionRef) -> Self {
        SerializeException { vm, exc }
    }
}

impl serde::Serialize for SerializeException<'_> {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        use serde::ser::*;

        let mut struc = s.serialize_struct("PyBaseException", 7)?;
        struc.serialize_field("exc_type", self.exc.class().name().deref())?;
        let tbs = {
            struct Tracebacks(PyTracebackRef);
            impl serde::Serialize for Tracebacks {
                fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
                    let mut s = s.serialize_seq(None)?;
                    for tb in self.0.iter() {
                        s.serialize_element(&**tb)?;
                    }
                    s.end()
                }
            }
            self.exc.traceback().map(Tracebacks)
        };
        struc.serialize_field("traceback", &tbs)?;
        struc.serialize_field(
            "cause",
            &self.exc.cause().as_ref().map(|e| Self::new(self.vm, e)),
        )?;
        struc.serialize_field(
            "context",
            &self.exc.context().as_ref().map(|e| Self::new(self.vm, e)),
        )?;
        struc.serialize_field("suppress_context", &self.exc.get_suppress_context())?;

        let args = {
            struct Args<'vm>(&'vm VirtualMachine, PyTupleRef);
            impl serde::Serialize for Args<'_> {
                fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
                    s.collect_seq(
                        self.1
                            .as_slice()
                            .iter()
                            .map(|arg| crate::py_serde::PyObjectSerializer::new(self.0, arg)),
                    )
                }
            }
            Args(self.vm, self.exc.args())
        };
        struc.serialize_field("args", &args)?;

        let rendered = {
            let mut rendered = String::new();
            self.vm
                .write_exception(&mut rendered, self.exc)
                .map_err(S::Error::custom)?;
            rendered
        };
        struc.serialize_field("rendered", &rendered)?;

        struc.end()
    }
}

pub fn cstring_error(vm: &VirtualMachine) -> PyBaseExceptionRef {
    vm.new_value_error("embedded null character".to_owned())
}

impl IntoPyException for std::ffi::NulError {
    fn into_pyexception(self, vm: &VirtualMachine) -> PyBaseExceptionRef {
        cstring_error(vm)
    }
}

#[cfg(windows)]
impl<C: widestring::UChar> IntoPyException for widestring::NulError<C> {
    fn into_pyexception(self, vm: &VirtualMachine) -> PyBaseExceptionRef {
        cstring_error(vm)
    }
}

#[cfg(any(unix, windows, target_os = "wasi"))]
pub(crate) fn raw_os_error_to_exc_type(errno: i32, vm: &VirtualMachine) -> Option<PyTypeRef> {
    use crate::stdlib::errno::errors;
    let excs = &vm.ctx.exceptions;
    match errno {
        errors::EWOULDBLOCK => Some(excs.blocking_io_error.clone()),
        errors::EALREADY => Some(excs.blocking_io_error.clone()),
        errors::EINPROGRESS => Some(excs.blocking_io_error.clone()),
        errors::EPIPE => Some(excs.broken_pipe_error.clone()),
        #[cfg(not(target_os = "wasi"))]
        errors::ESHUTDOWN => Some(excs.broken_pipe_error.clone()),
        errors::ECHILD => Some(excs.child_process_error.clone()),
        errors::ECONNABORTED => Some(excs.connection_aborted_error.clone()),
        errors::ECONNREFUSED => Some(excs.connection_refused_error.clone()),
        errors::ECONNRESET => Some(excs.connection_reset_error.clone()),
        errors::EEXIST => Some(excs.file_exists_error.clone()),
        errors::ENOENT => Some(excs.file_not_found_error.clone()),
        errors::EISDIR => Some(excs.is_a_directory_error.clone()),
        errors::ENOTDIR => Some(excs.not_a_directory_error.clone()),
        errors::EINTR => Some(excs.interrupted_error.clone()),
        errors::EACCES => Some(excs.permission_error.clone()),
        errors::EPERM => Some(excs.permission_error.clone()),
        errors::ESRCH => Some(excs.process_lookup_error.clone()),
        errors::ETIMEDOUT => Some(excs.timeout_error.clone()),
        _ => None,
    }
}

pub(super) mod types {
    use crate::common::lock::PyRwLock;
    #[cfg_attr(target_os = "wasi", allow(unused_imports))]
    use crate::{
        builtins::{traceback::PyTracebackRef, PyInt, PyTupleRef, PyTypeRef},
        function::{FuncArgs, IntoPyResult},
        PyObjectRef, PyRef, PyResult, VirtualMachine,
    };
    use crossbeam_utils::atomic::AtomicCell;
    #[cfg_attr(target_os = "wasi", allow(unused_imports))]
    use std::ops::Deref;

    // This module is designed to be used as `use builtins::*;`.
    // Do not add any pub symbols not included in builtins module.
    // `PyBaseExceptionRef` is the only exception.

    pub type PyBaseExceptionRef = PyRef<PyBaseException>;

    // Sorted By Hierarchy then alphabetized.

    #[pyclass(module = false, name = "BaseException")]
    pub struct PyBaseException {
        pub(super) traceback: PyRwLock<Option<PyTracebackRef>>,
        pub(super) cause: PyRwLock<Option<PyRef<Self>>>,
        pub(super) context: PyRwLock<Option<PyRef<Self>>>,
        pub(super) suppress_context: AtomicCell<bool>,
        pub(super) args: PyRwLock<PyTupleRef>,
    }

    define_exception! {
        PySystemExit,
        PyBaseException,
        system_exit,
        "Request to exit from the interpreter."
    }
    define_exception! {
        PyGeneratorExit,
        PyBaseException,
        generator_exit,
        "Request that a generator exit."
    }
    define_exception! {
        PyKeyboardInterrupt,
        PyBaseException,
        keyboard_interrupt,
        "Program interrupted by user."
    }

    // Base `Exception` type
    define_exception! {
        PyException,
        PyBaseException,
        exception_type,
        "Common base class for all non-exit exceptions."
    }

    define_exception! {
        PyStopIteration,
        PyException,
        stop_iteration,
        "Signal the end from iterator.__next__()."
    }
    define_exception! {
        PyStopAsyncIteration,
        PyException,
        stop_async_iteration,
        "Signal the end from iterator.__anext__()."
    }

    define_exception! {
        PyArithmeticError,
        PyException,
        arithmetic_error,
        "Base class for arithmetic errors."
    }
    define_exception! {
        PyFloatingPointError,
        PyArithmeticError,
        floating_point_error,
        "Floating point operation failed."
    }
    define_exception! {
        PyOverflowError,
        PyArithmeticError,
        overflow_error,
        "Result too large to be represented."
    }
    define_exception! {
        PyZeroDivisionError,
        PyArithmeticError,
        zero_division_error,
        "Second argument to a division or modulo operation was zero."
    }

    define_exception! {
        PyAssertionError,
        PyException,
        assertion_error,
        "Assertion failed."
    }
    define_exception! {
        PyAttributeError,
        PyException,
        attribute_error,
        "Attribute not found."
    }
    define_exception! {
        PyBufferError,
        PyException,
        buffer_error,
        "Buffer error."
    }
    define_exception! {
        PyEOFError,
        PyException,
        eof_error,
        "Read beyond end of file."
    }

    define_exception! {
        PyImportError,
        PyException,
        import_error,
        "Import can't find module, or can't find name in module.",
        base_exception_new,
        import_error_init,
    }

    fn base_exception_new(cls: PyTypeRef, args: FuncArgs, vm: &VirtualMachine) -> PyResult {
        PyBaseException::slot_new(cls, args, vm)
    }

    fn import_error_init(
        zelf: PyRef<PyBaseException>,
        args: FuncArgs,
        vm: &VirtualMachine,
    ) -> PyResult<()> {
        let zelf: PyObjectRef = zelf.into();
        zelf.set_attr(
            "name",
            vm.unwrap_or_none(args.kwargs.get("name").cloned()),
            vm,
        )?;
        zelf.set_attr(
            "path",
            vm.unwrap_or_none(args.kwargs.get("path").cloned()),
            vm,
        )?;
        Ok(())
    }

    define_exception! {
        PyModuleNotFoundError,
        PyImportError,
        module_not_found_error,
        "Module not found."
    }

    define_exception! {
        PyLookupError,
        PyException,
        lookup_error,
        "Base class for lookup errors."
    }
    define_exception! {
        PyIndexError,
        PyLookupError,
        index_error,
        "Sequence index out of range."
    }
    define_exception! {
        PyKeyError,
        PyLookupError,
        key_error,
        "Mapping key not found."
    }

    define_exception! {
        PyMemoryError,
        PyException,
        memory_error,
        "Out of memory."
    }

    define_exception! {
        PyNameError,
        PyException,
        name_error,
        "Name not found globally."
    }
    define_exception! {
        PyUnboundLocalError,
        PyNameError,
        unbound_local_error,
        "Local name referenced but not bound to a value."
    }

    // OS Errors:
    define_exception! {
        PyOSError,
        PyException,
        os_error,
        "Base class for I/O related errors.",
        os_error_new,
        base_exception_init,
    }
    #[cfg(not(target_arch = "wasm32"))]
    fn os_error_optional_new(
        args: Vec<PyObjectRef>,
        vm: &VirtualMachine,
    ) -> Option<PyBaseExceptionRef> {
        let len = args.len();
        if len >= 2 {
            let args = args.as_slice();
            let errno = &args[0];
            errno
                .payload_if_subclass::<PyInt>(vm)
                .and_then(|errno| errno.try_to_primitive::<i32>(vm).ok())
                .and_then(|errno| super::raw_os_error_to_exc_type(errno, vm))
                .and_then(|typ| vm.invoke_exception(typ, args.to_vec()).ok())
        } else {
            None
        }
    }
    #[cfg(not(target_arch = "wasm32"))]
    fn os_error_new(cls: PyTypeRef, args: FuncArgs, vm: &VirtualMachine) -> PyResult {
        // We need this method, because of how `CPython` copies `init`
        // from `BaseException` in `SimpleExtendsException` macro.
        // See: `BaseException_new`
        if cls.name().deref() == vm.ctx.exceptions.os_error.name().deref() {
            match os_error_optional_new(args.args.to_vec(), vm) {
                Some(error) => error.into_pyresult(vm),
                None => PyBaseException::slot_new(cls, args, vm),
            }
        } else {
            PyBaseException::slot_new(cls, args, vm)
        }
    }
    #[cfg(target_arch = "wasm32")]
    fn os_error_new(cls: PyTypeRef, args: FuncArgs, vm: &VirtualMachine) -> PyResult {
        PyBaseException::slot_new(cls, args, vm)
    }

    fn base_exception_init(
        zelf: PyRef<PyBaseException>,
        args: FuncArgs,
        vm: &VirtualMachine,
    ) -> PyResult<()> {
        PyBaseException::init(zelf, args, vm)
    }

    define_exception! {
        PyBlockingIOError,
        PyOSError,
        blocking_io_error,
        "I/O operation would block."
    }
    define_exception! {
        PyChildProcessError,
        PyOSError,
        child_process_error,
        "Child process error."
    }
    define_exception! {
        PyConnectionError,
        PyOSError,
        connection_error,
        "Connection error."
    }
    define_exception! {
        PyBrokenPipeError,
        PyConnectionError,
        broken_pipe_error,
        "Broken pipe."
    }
    define_exception! {
        PyConnectionAbortedError,
        PyConnectionError,
        connection_aborted_error,
        "Connection aborted."
    }
    define_exception! {
        PyConnectionRefusedError,
        PyConnectionError,
        connection_refused_error,
        "Connection refused."
    }
    define_exception! {
        PyConnectionResetError,
        PyConnectionError,
        connection_reset_error,
        "Connection reset."
    }
    define_exception! {
        PyFileExistsError,
        PyOSError,
        file_exists_error,
        "File already exists."
    }
    define_exception! {
        PyFileNotFoundError,
        PyOSError,
        file_not_found_error,
        "File not found."
    }
    define_exception! {
        PyInterruptedError,
        PyOSError,
        interrupted_error,
        "Interrupted by signal."
    }
    define_exception! {
        PyIsADirectoryError,
        PyOSError,
        is_a_directory_error,
        "Operation doesn't work on directories."
    }
    define_exception! {
        PyNotADirectoryError,
        PyOSError,
        not_a_directory_error,
        "Operation only works on directories."
    }
    define_exception! {
        PyPermissionError,
        PyOSError,
        permission_error,
        "Not enough permissions."
    }
    define_exception! {
        PyProcessLookupError,
        PyOSError,
        process_lookup_error,
        "Process not found."
    }
    define_exception! {
        PyTimeoutError,
        PyOSError,
        timeout_error,
        "Timeout expired."
    }

    define_exception! {
        PyReferenceError,
        PyException,
        reference_error,
        "Weak ref proxy used after referent went away."
    }

    define_exception! {
        PyRuntimeError,
        PyException,
        runtime_error,
        "Unspecified run-time error."
    }
    define_exception! {
        PyNotImplementedError,
        PyRuntimeError,
        not_implemented_error,
        "Method or function hasn't been implemented yet."
    }
    define_exception! {
        PyRecursionError,
        PyRuntimeError,
        recursion_error,
        "Recursion limit exceeded."
    }

    define_exception! {
        PySyntaxError,
        PyException,
        syntax_error,
        "Invalid syntax."
    }
    define_exception! {
        PyIndentationError,
        PySyntaxError,
        indentation_error,
        "Improper indentation."
    }
    define_exception! {
        PyTabError,
        PyIndentationError,
        tab_error,
        "Improper mixture of spaces and tabs."
    }

    define_exception! {
        PySystemError,
        PyException,
        system_error,
        "Internal error in the Python interpreter.\n\nPlease report this to the Python maintainer, along with the traceback,\nthe Python version, and the hardware/OS platform and version."
    }

    define_exception! {
        PyTypeError,
        PyException,
        type_error,
        "Inappropriate argument type."
    }

    define_exception! {
        PyValueError,
        PyException,
        value_error,
        "Inappropriate argument value (of correct type)."
    }
    define_exception! {
        PyUnicodeError,
        PyValueError,
        unicode_error,
        "Unicode related error."
    }
    define_exception! {
        PyUnicodeDecodeError,
        PyUnicodeError,
        unicode_decode_error,
        "Unicode decoding error."
    }
    define_exception! {
        PyUnicodeEncodeError,
        PyUnicodeError,
        unicode_encode_error,
        "Unicode encoding error."
    }
    define_exception! {
        PyUnicodeTranslateError,
        PyUnicodeError,
        unicode_translate_error,
        "Unicode translation error."
    }

    #[cfg(feature = "jit")]
    define_exception! {
        PyJitError,
        PyException,
        jit_error,
        "JIT error."
    }

    // Warnings
    define_exception! {
        PyWarning,
        PyException,
        warning,
        "Base class for warning categories."
    }
    define_exception! {
        PyDeprecationWarning,
        PyWarning,
        deprecation_warning,
        "Base class for warnings about deprecated features."
    }
    define_exception! {
        PyPendingDeprecationWarning,
        PyWarning,
        pending_deprecation_warning,
        "Base class for warnings about features which will be deprecated\nin the future."
    }
    define_exception! {
        PyRuntimeWarning,
        PyWarning,
        runtime_warning,
        "Base class for warnings about dubious runtime behavior."
    }
    define_exception! {
        PySyntaxWarning,
        PyWarning,
        syntax_warning,
        "Base class for warnings about dubious syntax."
    }
    define_exception! {
        PyUserWarning,
        PyWarning,
        user_warning,
        "Base class for warnings generated by user code."
    }
    define_exception! {
        PyFutureWarning,
        PyWarning,
        future_warning,
        "Base class for warnings about constructs that will change semantically\nin the future."
    }
    define_exception! {
        PyImportWarning,
        PyWarning,
        import_warning,
        "Base class for warnings about probable mistakes in module imports."
    }
    define_exception! {
        PyUnicodeWarning,
        PyWarning,
        unicode_warning,
        "Base class for warnings about Unicode related problems, mostly\nrelated to conversion problems."
    }
    define_exception! {
        PyBytesWarning,
        PyWarning,
        bytes_warning,
        "Base class for warnings about bytes and buffer related problems, mostly\nrelated to conversion from str or comparing to str."
    }
    define_exception! {
        PyResourceWarning,
        PyWarning,
        resource_warning,
        "Base class for warnings about resource usage."
    }
    define_exception! {
        PyEncodingWarning,
        PyWarning,
        encoding_warning,
        "Base class for warnings about encodings."
    }
}