luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ensure `#[getter]` doc is exposed as the `__doc__` of the descriptor

This commit is contained in:
Martin Larralde 2019-04-14 00:23:59 +02:00
parent 569a7e9e95
commit 3f4f068c7f
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/class/methods.rs
View File

@ -97,6 +97,9 @@ impl PyGetterDef {
.expect("Method name must not contain NULL byte") .expect("Method name must not contain NULL byte")
.into_raw(); .into_raw();
} }
if dst.doc.is_null() {
dst.doc = self.doc.as_ptr() as *mut libc::c_char;
}
dst.get = Some(self.meth); dst.get = Some(self.meth);
} }
} }

5
tests/test_getter_setter.rs
View File

@ -1,4 +1,5 @@
use pyo3::prelude::*; use pyo3::prelude::*;
use pyo3::types::IntoPyDict;
use std::isize; use std::isize;
#[macro_use] #[macro_use]
@ -16,6 +17,7 @@ impl ClassWithProperties {
} }
#[getter(DATA)] #[getter(DATA)]
/// a getter for data
fn get_data(&self) -> PyResult<i32> { fn get_data(&self) -> PyResult<i32> {
Ok(self.num) Ok(self.num)
} }
@ -38,6 +40,9 @@ fn class_with_properties() {
py_run!(py, inst, "inst.DATA = 20"); py_run!(py, inst, "inst.DATA = 20");
py_run!(py, inst, "assert inst.get_num() == 20"); py_run!(py, inst, "assert inst.get_num() == 20");
py_run!(py, inst, "assert inst.get_num() == inst.DATA"); py_run!(py, inst, "assert inst.get_num() == inst.DATA");
let d = [("C", py.get_type::<ClassWithProperties>())].into_py_dict(py);
py.run("assert C.DATA.__doc__ == 'a getter for data'", None, Some(d)).unwrap();
} }
#[pyclass] #[pyclass]