use pyo3::prelude::*; use pyo3::{types::PyType, wrap_pyfunction, wrap_pymodule, PyCell}; mod common; #[test] fn class_without_docs_or_signature() { #[pyclass] struct MyClass {} let gil = Python::acquire_gil(); let py = gil.python(); let typeobj = py.get_type::(); py_assert!(py, typeobj, "typeobj.__doc__ is None"); py_assert!(py, typeobj, "typeobj.__text_signature__ is None"); } #[test] fn class_with_docs() { /// docs line1 #[pyclass] /// docs line2 struct MyClass {} let gil = Python::acquire_gil(); let py = gil.python(); let typeobj = py.get_type::(); py_assert!(py, typeobj, "typeobj.__doc__ == 'docs line1\\ndocs line2'"); py_assert!(py, typeobj, "typeobj.__text_signature__ is None"); } // Ignored because heap types don't have working __text_signature__: // https://github.com/python/cpython/blob/master/Objects/typeobject.c#L864-L870 #[test] #[ignore] fn class_with_docs_and_signature() { /// docs line1 #[pyclass] /// docs line2 #[text_signature = "(a, b=None, *, c=42)"] /// docs line3 struct MyClass {} #[pymethods] impl MyClass { #[new] #[args(a, b = "None", "*", c = 42)] fn __new__(a: i32, b: Option, c: i32) -> Self { let _ = (a, b, c); Self {} } } let gil = Python::acquire_gil(); let py = gil.python(); let typeobj = py.get_type::(); py_assert!( py, typeobj, "typeobj.__doc__ == 'docs line1\\ndocs line2\\ndocs line3'" ); py_assert!( py, typeobj, "typeobj.__text_signature__ == '(a, b=None, *, c=42)'" ); } // Ignored because heap types don't have working __text_signature__: // https://github.com/python/cpython/blob/master/Objects/typeobject.c#L864-L870 #[test] #[ignore] fn class_with_signature() { #[pyclass] #[text_signature = "(a, b=None, *, c=42)"] struct MyClass {} #[pymethods] impl MyClass { #[new] #[args(a, b = "None", "*", c = 42)] fn __new__(a: i32, b: Option, c: i32) -> Self { let _ = (a, b, c); Self {} } } let gil = Python::acquire_gil(); let py = gil.python(); let typeobj = py.get_type::(); py_assert!(py, typeobj, "typeobj.__doc__ is None"); py_assert!( py, typeobj, "typeobj.__text_signature__ == '(a, b=None, *, c=42)'" ); } #[test] fn test_function() { #[pyfunction(a, b = "None", "*", c = 42)] #[text_signature = "(a, b=None, *, c=42)"] fn my_function(a: i32, b: Option, c: i32) { let _ = (a, b, c); } let gil = Python::acquire_gil(); let py = gil.python(); let f = wrap_pyfunction!(my_function)(py).unwrap(); py_assert!(py, f, "f.__text_signature__ == '(a, b=None, *, c=42)'"); } #[test] fn test_pyfn() { #[pymodule] fn my_module(_py: Python, m: &PyModule) -> PyResult<()> { #[pyfn(m, "my_function", a, b = "None", "*", c = 42)] #[text_signature = "(a, b=None, *, c=42)"] fn my_function(a: i32, b: Option, c: i32) { let _ = (a, b, c); } Ok(()) } let gil = Python::acquire_gil(); let py = gil.python(); let m = wrap_pymodule!(my_module)(py); py_assert!( py, m, "m.my_function.__text_signature__ == '(a, b=None, *, c=42)'" ); } #[test] fn test_methods() { #[pyclass] struct MyClass {} #[pymethods] impl MyClass { #[text_signature = "($self, a)"] fn method(&self, a: i32) { let _ = a; } #[text_signature = "($self, b)"] fn pyself_method(_this: &PyCell, b: i32) { let _ = b; } #[classmethod] #[text_signature = "($cls, c)"] fn class_method(_cls: &PyType, c: i32) { let _ = c; } #[staticmethod] #[text_signature = "(d)"] fn static_method(d: i32) { let _ = d; } } let gil = Python::acquire_gil(); let py = gil.python(); let typeobj = py.get_type::(); py_assert!( py, typeobj, "typeobj.method.__text_signature__ == '($self, a)'" ); py_assert!( py, typeobj, "typeobj.pyself_method.__text_signature__ == '($self, b)'" ); py_assert!( py, typeobj, "typeobj.class_method.__text_signature__ == '($cls, c)'" ); py_assert!( py, typeobj, "typeobj.static_method.__text_signature__ == '(d)'" ); }