ganesh 0.26.0

Minimization and sampling in Rust, simplified
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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

//! Python error integration for downstream wrapper crates.
#![allow(missing_docs)]
#![allow(clippy::missing_errors_doc)]

use pyo3::{
    create_exception,
    exceptions::PyException,
    types::{PyModule, PyModuleMethods},
    Bound, PyErr, PyResult,
};

use crate::error::GaneshError;

// Base Python exception for `ganesh` wrapper-facing errors.
create_exception!(ganesh, GaneshPyError, PyException);

// Python exception for wrapper-facing configuration errors.
create_exception!(ganesh, GaneshConfigError, GaneshPyError);

// Python exception for wrapper-facing numerical errors.
create_exception!(ganesh, GaneshNumericalError, GaneshPyError);

/// Register the `ganesh` Python exception hierarchy in a downstream `pyo3` module.
pub fn register_exceptions(module: &Bound<'_, PyModule>) -> PyResult<()> {
    module.add("GaneshError", module.py().get_type::<GaneshPyError>())?;
    module.add(
        "GaneshConfigError",
        module.py().get_type::<GaneshConfigError>(),
    )?;
    module.add(
        "GaneshNumericalError",
        module.py().get_type::<GaneshNumericalError>(),
    )?;
    Ok(())
}

/// Convert a [`GaneshError`] into a typed Python exception.
impl From<GaneshError> for PyErr {
    fn from(err: GaneshError) -> Self {
        match err {
            GaneshError::ConfigError(message) => GaneshConfigError::new_err(message),
            GaneshError::NumericalError(message) => GaneshNumericalError::new_err(message),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::error::GaneshError;

    #[test]
    fn config_error_maps_to_python_config_exception() {
        crate::python::attach_for_tests(|py| {
            let err: PyErr = GaneshError::ConfigError("bad config".into()).into();
            assert!(err.is_instance_of::<GaneshConfigError>(py));
            assert!(err.is_instance_of::<GaneshPyError>(py));
        });
    }

    #[test]
    fn numerical_error_maps_to_python_numerical_exception() {
        crate::python::attach_for_tests(|py| {
            let err: PyErr = GaneshError::NumericalError("bad conditioning".into()).into();
            assert!(err.is_instance_of::<GaneshNumericalError>(py));
            assert!(err.is_instance_of::<GaneshPyError>(py));
        });
    }
}