pyo3/tests/test_getter_setter.rs

319 lines
6.9 KiB
Rust
Raw Permalink Normal View History

2021-12-03 00:03:32 +00:00
#![cfg(feature = "macros")]
2023-03-05 18:44:45 +00:00
use std::cell::Cell;
use pyo3::prelude::*;
2019-06-13 09:09:17 +00:00
use pyo3::py_run;
use pyo3::types::{IntoPyDict, PyList};
2023-09-24 12:34:53 +00:00
#[path = "../src/tests/common.rs"]
mod common;
#[pyclass]
struct ClassWithProperties {
num: i32,
}
#[pymethods]
impl ClassWithProperties {
2021-02-11 21:37:38 +00:00
fn get_num(&self) -> i32 {
self.num
}
#[getter(DATA)]
/// a getter for data
2021-02-11 21:37:38 +00:00
fn get_data(&self) -> i32 {
self.num
}
#[setter(DATA)]
2021-02-11 21:37:38 +00:00
fn set_data(&mut self, value: i32) {
self.num = value;
}
#[getter]
/// a getter with a type un-wrapped by PyResult
fn get_unwrapped(&self) -> i32 {
self.num
}
#[setter]
fn set_unwrapped(&mut self, value: i32) {
self.num = value;
}
#[setter]
fn set_from_len(&mut self, #[pyo3(from_py_with = "extract_len")] value: i32) {
self.num = value;
}
#[setter]
fn set_from_any(&mut self, value: &Bound<'_, PyAny>) -> PyResult<()> {
self.num = value.extract()?;
Ok(())
}
#[getter]
2024-01-23 08:39:19 +00:00
fn get_data_list<'py>(&self, py: Python<'py>) -> Bound<'py, PyList> {
PyList::new_bound(py, [self.num])
}
}
fn extract_len(any: &Bound<'_, PyAny>) -> PyResult<i32> {
any.len().map(|len| len as i32)
}
#[test]
fn class_with_properties() {
2022-07-19 17:34:23 +00:00
Python::with_gil(|py| {
let inst = Py::new(py, ClassWithProperties { num: 10 }).unwrap();
2022-07-19 17:34:23 +00:00
py_run!(py, inst, "assert inst.get_num() == 10");
py_run!(py, inst, "assert inst.get_num() == inst.DATA");
py_run!(py, inst, "inst.DATA = 20");
py_run!(py, inst, "assert inst.get_num() == 20 == inst.DATA");
2022-07-19 17:34:23 +00:00
py_expect_exception!(py, inst, "del inst.DATA", PyAttributeError);
2022-07-19 17:34:23 +00:00
py_run!(py, inst, "assert inst.get_num() == inst.unwrapped == 20");
py_run!(py, inst, "inst.unwrapped = 42");
py_run!(py, inst, "assert inst.get_num() == inst.unwrapped == 42");
py_run!(py, inst, "assert inst.data_list == [42]");
py_run!(py, inst, "inst.from_len = [0, 0, 0]");
py_run!(py, inst, "assert inst.get_num() == 3");
py_run!(py, inst, "inst.from_any = 15");
py_run!(py, inst, "assert inst.get_num() == 15");
let d = [("C", py.get_type_bound::<ClassWithProperties>())].into_py_dict_bound(py);
2022-07-19 17:34:23 +00:00
py_assert!(py, *d, "C.DATA.__doc__ == 'a getter for data'");
});
}
#[pyclass]
struct GetterSetter {
#[pyo3(get, set)]
num: i32,
#[pyo3(get, set)]
text: String,
}
#[pymethods]
impl GetterSetter {
2021-02-11 21:37:38 +00:00
fn get_num2(&self) -> i32 {
self.num
}
}
#[test]
fn getter_setter_autogen() {
2022-07-19 17:34:23 +00:00
Python::with_gil(|py| {
let inst = Py::new(
py,
GetterSetter {
num: 10,
text: "Hello".to_string(),
},
)
.unwrap();
py_run!(py, inst, "assert inst.num == 10");
py_run!(py, inst, "inst.num = 20; assert inst.num == 20");
py_run!(
py,
inst,
"assert inst.text == 'Hello'; inst.text = 'There'; assert inst.text == 'There'"
);
});
}
#[pyclass]
struct RefGetterSetter {
num: i32,
}
#[pymethods]
impl RefGetterSetter {
#[getter]
2022-03-23 07:07:28 +00:00
fn get_num(slf: PyRef<'_, Self>) -> i32 {
slf.num
}
#[setter]
2022-03-23 07:07:28 +00:00
fn set_num(mut slf: PyRefMut<'_, Self>, value: i32) {
slf.num = value;
}
}
#[test]
fn ref_getter_setter() {
// Regression test for #837
2022-07-19 17:34:23 +00:00
Python::with_gil(|py| {
let inst = Py::new(py, RefGetterSetter { num: 10 }).unwrap();
2022-07-19 17:34:23 +00:00
py_run!(py, inst, "assert inst.num == 10");
py_run!(py, inst, "inst.num = 20; assert inst.num == 20");
});
}
#[pyclass]
struct TupleClassGetterSetter(i32);
#[pymethods]
impl TupleClassGetterSetter {
#[getter(num)]
fn get_num(&self) -> i32 {
self.0
}
#[setter(num)]
fn set_num(&mut self, value: i32) {
self.0 = value;
}
}
#[test]
fn tuple_struct_getter_setter() {
2022-07-19 17:34:23 +00:00
Python::with_gil(|py| {
let inst = Py::new(py, TupleClassGetterSetter(10)).unwrap();
2022-07-19 17:34:23 +00:00
py_assert!(py, inst, "inst.num == 10");
py_run!(py, inst, "inst.num = 20");
py_assert!(py, inst, "inst.num == 20");
});
}
2022-10-17 00:37:43 +00:00
#[pyclass(get_all, set_all)]
struct All {
num: i32,
}
#[test]
fn get_set_all() {
Python::with_gil(|py| {
let inst = Py::new(py, All { num: 10 }).unwrap();
py_run!(py, inst, "assert inst.num == 10");
py_run!(py, inst, "inst.num = 20; assert inst.num == 20");
});
}
#[pyclass(get_all)]
struct All2 {
#[pyo3(set)]
num: i32,
}
#[test]
fn get_all_and_set() {
Python::with_gil(|py| {
let inst = Py::new(py, All2 { num: 10 }).unwrap();
py_run!(py, inst, "assert inst.num == 10");
py_run!(py, inst, "inst.num = 20; assert inst.num == 20");
});
}
2023-03-05 18:44:45 +00:00
#[pyclass]
struct CellGetterSetter {
#[pyo3(get, set)]
cell_inner: Cell<i32>,
}
#[test]
fn cell_getter_setter() {
let c = CellGetterSetter {
cell_inner: Cell::new(10),
};
Python::with_gil(|py| {
let inst = Py::new(py, c).unwrap().to_object(py);
let cell = Cell::new(20).to_object(py);
py_run!(py, cell, "assert cell == 20");
py_run!(py, inst, "assert inst.cell_inner == 10");
py_run!(
py,
inst,
"inst.cell_inner = 20; assert inst.cell_inner == 20"
);
});
}
#[test]
fn borrowed_value_with_lifetime_of_self() {
#[pyclass]
struct BorrowedValue {}
#[pymethods]
impl BorrowedValue {
#[getter]
fn value(&self) -> &str {
"value"
}
}
Python::with_gil(|py| {
let inst = Py::new(py, BorrowedValue {}).unwrap().to_object(py);
py_run!(py, inst, "assert inst.value == 'value'");
});
}
#[test]
fn frozen_py_field_get() {
#[pyclass(frozen)]
struct FrozenPyField {
#[pyo3(get)]
value: Py<PyAny>,
}
Python::with_gil(|py| {
let inst = Py::new(
py,
FrozenPyField {
value: "value".into_py(py),
},
)
.unwrap()
.to_object(py);
py_run!(py, inst, "assert inst.value == 'value'");
});
}
#[test]
fn test_optional_setter() {
#[pyclass]
struct SimpleClass {
field: Option<u32>,
}
#[pymethods]
impl SimpleClass {
#[getter]
fn get_field(&self) -> Option<u32> {
self.field
}
#[setter]
fn set_field(&mut self, field: Option<u32>) {
self.field = field;
}
}
Python::with_gil(|py| {
let instance = Py::new(py, SimpleClass { field: None }).unwrap();
py_run!(py, instance, "assert instance.field is None");
py_run!(
py,
instance,
"instance.field = 42; assert instance.field == 42"
);
py_run!(
py,
instance,
"instance.field = None; assert instance.field is None"
);
})
}