polars_python/
error.rs

1use std::fmt::{Debug, Formatter};
2use std::io::{Error, ErrorKind};
3
4use polars::prelude::PolarsError;
5use polars_error::PolarsWarning;
6use pyo3::exceptions::{
7    PyFileExistsError, PyFileNotFoundError, PyIOError, PyPermissionError, PyRuntimeError,
8    PyUserWarning,
9};
10use pyo3::prelude::*;
11use pyo3::PyTypeInfo;
12use thiserror::Error;
13
14use crate::exceptions::{
15    CategoricalRemappingWarning, ColumnNotFoundError, ComputeError, DuplicateError,
16    InvalidOperationError, MapWithoutReturnDtypeWarning, NoDataError, OutOfBoundsError,
17    SQLInterfaceError, SQLSyntaxError, SchemaError, SchemaFieldNotFoundError, ShapeError,
18    StringCacheMismatchError, StructFieldNotFoundError,
19};
20use crate::Wrap;
21
22#[derive(Error)]
23pub enum PyPolarsErr {
24    #[error(transparent)]
25    Polars(#[from] PolarsError),
26    #[error("{0}")]
27    Other(String),
28}
29
30impl std::convert::From<std::io::Error> for PyPolarsErr {
31    fn from(value: Error) -> Self {
32        PyPolarsErr::Other(format!("{value:?}"))
33    }
34}
35
36impl std::convert::From<PyPolarsErr> for PyErr {
37    fn from(err: PyPolarsErr) -> PyErr {
38        let default = || PyRuntimeError::new_err(format!("{:?}", &err));
39
40        use PyPolarsErr::*;
41        match err {
42            Polars(err) => match err {
43                PolarsError::ColumnNotFound(name) => ColumnNotFoundError::new_err(name.to_string()),
44                PolarsError::ComputeError(err) => ComputeError::new_err(err.to_string()),
45                PolarsError::Duplicate(err) => DuplicateError::new_err(err.to_string()),
46                PolarsError::InvalidOperation(err) => {
47                    InvalidOperationError::new_err(err.to_string())
48                },
49                PolarsError::IO { error, msg } => {
50                    let msg = if let Some(msg) = msg {
51                        msg.to_string()
52                    } else {
53                        error.to_string()
54                    };
55                    match error.kind() {
56                        ErrorKind::NotFound => PyFileNotFoundError::new_err(msg),
57                        ErrorKind::PermissionDenied => PyPermissionError::new_err(msg),
58                        ErrorKind::AlreadyExists => PyFileExistsError::new_err(msg),
59                        _ => PyIOError::new_err(msg),
60                    }
61                },
62                PolarsError::NoData(err) => NoDataError::new_err(err.to_string()),
63                PolarsError::OutOfBounds(err) => OutOfBoundsError::new_err(err.to_string()),
64                PolarsError::SQLInterface(name) => SQLInterfaceError::new_err(name.to_string()),
65                PolarsError::SQLSyntax(name) => SQLSyntaxError::new_err(name.to_string()),
66                PolarsError::SchemaFieldNotFound(name) => {
67                    SchemaFieldNotFoundError::new_err(name.to_string())
68                },
69                PolarsError::SchemaMismatch(err) => SchemaError::new_err(err.to_string()),
70                PolarsError::ShapeMismatch(err) => ShapeError::new_err(err.to_string()),
71                PolarsError::StringCacheMismatch(err) => {
72                    StringCacheMismatchError::new_err(err.to_string())
73                },
74                PolarsError::StructFieldNotFound(name) => {
75                    StructFieldNotFoundError::new_err(name.to_string())
76                },
77                PolarsError::Context { .. } => {
78                    let tmp = PyPolarsErr::Polars(err.context_trace());
79                    PyErr::from(tmp)
80                },
81            },
82            _ => default(),
83        }
84    }
85}
86
87impl Debug for PyPolarsErr {
88    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
89        use PyPolarsErr::*;
90        match self {
91            Polars(err) => write!(f, "{err:?}"),
92            Other(err) => write!(f, "BindingsError: {err:?}"),
93        }
94    }
95}
96
97#[macro_export]
98macro_rules! raise_err(
99    ($msg:expr, $err:ident) => {{
100        Err(PolarsError::$err($msg.into())).map_err(PyPolarsErr::from)?;
101        unreachable!()
102    }}
103);
104
105impl<'py> IntoPyObject<'py> for Wrap<PolarsWarning> {
106    type Target = PyAny;
107    type Output = Bound<'py, Self::Target>;
108    type Error = std::convert::Infallible;
109
110    fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {
111        match self.0 {
112            PolarsWarning::CategoricalRemappingWarning => {
113                Ok(CategoricalRemappingWarning::type_object(py).into_any())
114            },
115            PolarsWarning::MapWithoutReturnDtypeWarning => {
116                Ok(MapWithoutReturnDtypeWarning::type_object(py).into_any())
117            },
118            PolarsWarning::UserWarning => Ok(PyUserWarning::type_object(py).into_any()),
119        }
120    }
121}