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

Remove CompareOp::Other, change to __richcmp__, and add tests

Browse source
This commit is contained in:
Samuel Cormier-Iijima 2016-06-06 20:43:16 -04:00
parent 305bc4324d
commit 291e08e29a
7 changed files with 139 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/py_class/mod.rs
View file

@ -39,22 +39,7 @@ pub enum CompareOp {
Eq = ffi::Py_EQ as isize,
Ne = ffi::Py_NE as isize,
Gt = ffi::Py_GT as isize,
Ge = ffi::Py_GE as isize,
Other
}
impl<T: Into<isize>> From<T> for CompareOp {
fn from(val: T) -> Self {
match val.into() as libc::c_int {
ffi::Py_LT => CompareOp::Lt,
ffi::Py_LE => CompareOp::Le,
ffi::Py_EQ => CompareOp::Eq,
ffi::Py_NE => CompareOp::Ne,
ffi::Py_GT => CompareOp::Gt,
ffi::Py_GE => CompareOp::Ge,
_ => CompareOp::Other
}
}
Ge = ffi::Py_GE as isize
}
/// Trait implemented by the types produced by the `py_class!()` macro.

4
src/py_class/py_class.rs
View file

@ -278,9 +278,7 @@ py_class!(class MyIterator |py| {
## Comparison operators
TODO: implement support for `__cmp__`
* `def __richcompare__(&self, other: impl ToPyObject, op: CompareOp) -> PyResult<impl ToPyObject>`
* `def __richcmp__(&self, other: impl ToPyObject, op: CompareOp) -> PyResult<impl ToPyObject>`
Overloads Python comparison operations (`==`, `!=`, `<`, `<=`, `>`, and `>=`). The `op`
argument indicates the comparison operation being performed.

16
src/py_class/py_class_impl.py
View file

@ -597,14 +597,14 @@ special_names = {
'__bytes__': normal_method(),
'__format__': normal_method(),
# Comparison Operators
'__lt__': error('__lt__ is not supported by py_class! use __richcompare__ instead.'),
'__le__': error('__le__ is not supported by py_class! use __richcompare__ instead.'),
'__gt__': error('__gt__ is not supported by py_class! use __richcompare__ instead.'),
'__ge__': error('__ge__ is not supported by py_class! use __richcompare__ instead.'),
'__eq__': error('__eq__ is not supported by py_class! use __richcompare__ instead.'),
'__ne__': error('__ne__ is not supported by py_class! use __richcompare__ instead.'),
'__cmp__': unimplemented(),
'__richcompare__': operator('tp_richcompare',
'__lt__': error('__lt__ is not supported by py_class! use __richcmp__ instead.'),
'__le__': error('__le__ is not supported by py_class! use __richcmp__ instead.'),
'__gt__': error('__gt__ is not supported by py_class! use __richcmp__ instead.'),
'__ge__': error('__ge__ is not supported by py_class! use __richcmp__ instead.'),
'__eq__': error('__eq__ is not supported by py_class! use __richcmp__ instead.'),
'__ne__': error('__ne__ is not supported by py_class! use __richcmp__ instead.'),
'__cmp__': error('__cmp__ is not supported by py_class! use __richcmp__ instead.'),
'__richcmp__': operator('tp_richcompare',
res_type='PyObject',
args=[Argument('other'), Argument('op')]),
'__hash__': operator('tp_hash',

24
src/py_class/py_class_impl2.rs
View file

@ -483,7 +483,7 @@ macro_rules! py_class_impl {
}};
{ { def __cmp__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__cmp__ is not supported by py_class! yet." }
py_error! { "__cmp__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __coerce__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -580,7 +580,7 @@ macro_rules! py_class_impl {
};
{ { def __eq__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__eq__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__eq__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __float__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -592,7 +592,7 @@ macro_rules! py_class_impl {
};
{ { def __ge__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__ge__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__ge__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __get__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -643,7 +643,7 @@ macro_rules! py_class_impl {
};
{ { def __gt__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__gt__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__gt__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __hash__(&$slf:ident) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
@ -809,7 +809,7 @@ macro_rules! py_class_impl {
};
{ { def __le__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__le__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__le__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __len__(&$slf:ident) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
@ -882,7 +882,7 @@ macro_rules! py_class_impl {
};
{ { def __lt__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__lt__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__lt__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __matmul__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -924,7 +924,7 @@ macro_rules! py_class_impl {
};
{ { def __ne__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__ne__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__ne__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __neg__(&$slf:ident) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
@ -1151,7 +1151,7 @@ macro_rules! py_class_impl {
{ { def __rfloordiv__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "Reflected numeric operator __rfloordiv__ is not supported by py_class! Use __floordiv__ instead!" }
};
{ { def __richcompare__(&$slf:ident, $other:ident : $other_type:ty, $op:ident : $op_type:ty) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
{ { def __richcmp__(&$slf:ident, $other:ident : $other_type:ty, $op:ident : $op_type:ty) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
/* slots: */ {
/* type_slots */ [ $( $tp_slot_name:ident : $tp_slot_value:expr, )* ]
@ -1165,19 +1165,19 @@ macro_rules! py_class_impl {
/* slots: */ {
/* type_slots */ [
$( $tp_slot_name : $tp_slot_value, )*
tp_richcompare: py_class_richcompare_slot!($class::__richcompare__, $other_type, *mut $crate::_detail::ffi::PyObject, $crate::_detail::PyObjectCallbackConverter),
tp_richcompare: py_class_richcompare_slot!($class::__richcmp__, $other_type, *mut $crate::_detail::ffi::PyObject, $crate::_detail::PyObjectCallbackConverter),
]
$as_number $as_sequence $as_mapping $setdelitem
}
/* impl: */ {
$($imp)*
py_class_impl_item! { $class, $py, __richcompare__(&$slf,) $res_type; { $($body)* } [{ $other : $other_type = {} } { $op : $op_type = {} }] }
py_class_impl_item! { $class, $py, __richcmp__(&$slf,) $res_type; { $($body)* } [{ $other : $other_type = {} } { $op : $op_type = {} }] }
}
$members
}};
{ { def __richcompare__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "Invalid signature for operator __richcompare__" }
{ { def __richcmp__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "Invalid signature for operator __richcmp__" }
};
{ { def __rlshift__ $($tail:tt)* } $( $stuff:tt )* } => {

24
src/py_class/py_class_impl3.rs
View file

@ -483,7 +483,7 @@ macro_rules! py_class_impl {
}};
{ { def __cmp__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__cmp__ is not supported by py_class! yet." }
py_error! { "__cmp__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __coerce__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -580,7 +580,7 @@ macro_rules! py_class_impl {
};
{ { def __eq__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__eq__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__eq__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __float__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -592,7 +592,7 @@ macro_rules! py_class_impl {
};
{ { def __ge__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__ge__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__ge__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __get__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -643,7 +643,7 @@ macro_rules! py_class_impl {
};
{ { def __gt__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__gt__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__gt__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __hash__(&$slf:ident) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
@ -809,7 +809,7 @@ macro_rules! py_class_impl {
};
{ { def __le__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__le__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__le__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __len__(&$slf:ident) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
@ -882,7 +882,7 @@ macro_rules! py_class_impl {
};
{ { def __lt__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__lt__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__lt__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __matmul__ $($tail:tt)* } $( $stuff:tt )* } => {
@ -924,7 +924,7 @@ macro_rules! py_class_impl {
};
{ { def __ne__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "__ne__ is not supported by py_class! use __richcompare__ instead." }
py_error! { "__ne__ is not supported by py_class! use __richcmp__ instead." }
};
{ { def __neg__(&$slf:ident) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
@ -1151,7 +1151,7 @@ macro_rules! py_class_impl {
{ { def __rfloordiv__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "Reflected numeric operator __rfloordiv__ is not supported by py_class! Use __floordiv__ instead!" }
};
{ { def __richcompare__(&$slf:ident, $other:ident : $other_type:ty, $op:ident : $op_type:ty) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
{ { def __richcmp__(&$slf:ident, $other:ident : $other_type:ty, $op:ident : $op_type:ty) -> $res_type:ty { $($body:tt)* } $($tail:tt)* }
$class:ident $py:ident $info:tt
/* slots: */ {
/* type_slots */ [ $( $tp_slot_name:ident : $tp_slot_value:expr, )* ]
@ -1165,19 +1165,19 @@ macro_rules! py_class_impl {
/* slots: */ {
/* type_slots */ [
$( $tp_slot_name : $tp_slot_value, )*
tp_richcompare: py_class_richcompare_slot!($class::__richcompare__, $other_type, *mut $crate::_detail::ffi::PyObject, $crate::_detail::PyObjectCallbackConverter),
tp_richcompare: py_class_richcompare_slot!($class::__richcmp__, $other_type, *mut $crate::_detail::ffi::PyObject, $crate::_detail::PyObjectCallbackConverter),
]
$as_number $as_sequence $as_mapping $setdelitem
}
/* impl: */ {
$($imp)*
py_class_impl_item! { $class, $py, __richcompare__(&$slf,) $res_type; { $($body)* } [{ $other : $other_type = {} } { $op : $op_type = {} }] }
py_class_impl_item! { $class, $py, __richcmp__(&$slf,) $res_type; { $($body)* } [{ $other : $other_type = {} } { $op : $op_type = {} }] }
}
$members
}};
{ { def __richcompare__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "Invalid signature for operator __richcompare__" }
{ { def __richcmp__ $($tail:tt)* } $( $stuff:tt )* } => {
py_error! { "Invalid signature for operator __richcmp__" }
};
{ { def __rlshift__ $($tail:tt)* } $( $stuff:tt )* } => {

25
src/py_class/slots.rs
View file

@ -24,6 +24,7 @@ use conversion::ToPyObject;
use objects::PyObject;
use function::CallbackConverter;
use err::{PyErr, PyResult};
use py_class::{CompareOp};
use exc;
use Py_hash_t;
@ -320,6 +321,20 @@ macro_rules! py_class_ternary_slot {
}}
}
pub fn extract_op(py: Python, op: c_int) -> PyResult<CompareOp> {
match op {
ffi::Py_LT => Ok(CompareOp::Lt),
ffi::Py_LE => Ok(CompareOp::Le),
ffi::Py_EQ => Ok(CompareOp::Eq),
ffi::Py_NE => Ok(CompareOp::Ne),
ffi::Py_GT => Ok(CompareOp::Gt),
ffi::Py_GE => Ok(CompareOp::Ge),
_ => Err(PyErr::new_lazy_init(
py.get_type::<exc::ValueError>(),
Some("tp_richcompare called with invalid comparison operator".to_py_object(py).into_object())))
}
}
// sq_richcompare is special-cased slot
#[macro_export]
#[doc(hidden)]
@ -337,10 +352,12 @@ macro_rules! py_class_richcompare_slot {
|py| {
let slf = $crate::PyObject::from_borrowed_ptr(py, slf).unchecked_cast_into::<$class>();
let arg = $crate::PyObject::from_borrowed_ptr(py, arg);
let op = $crate::py_class::CompareOp::from(op as isize);
let ret = match <$arg_type as $crate::FromPyObject>::extract(py, &arg) {
Ok(arg) => slf.$f(py, arg, op),
Err(e) => Err(e)
let ret = match $crate::py_class::slots::extract_op(py, op) {
Ok(op) => match <$arg_type as $crate::FromPyObject>::extract(py, &arg) {
Ok(arg) => slf.$f(py, arg, op).map(|res| { res.into_py_object(py).into_object() }),
Err(_) => Ok(py.NotImplemented())
},
Err(_) => Ok(py.NotImplemented())
};
$crate::PyDrop::release_ref(arg, py);
$crate::PyDrop::release_ref(slf, py);

84
tests/test_class.rs
View file

@ -665,6 +665,90 @@ fn binary_arithmetic() {
py_run!(py, c, "assert 1 | c == '1 | BA'");
}
py_class!(class RichComparisons |py| {
def __repr__(&self) -> PyResult<&'static str> {
Ok("RC")
}
def __richcmp__(&self, other: &PyObject, op: CompareOp) -> PyResult<String> {
match op {
CompareOp::Lt => Ok(format!("{:?} < {:?}", self.as_object(), other)),
CompareOp::Le => Ok(format!("{:?} <= {:?}", self.as_object(), other)),
CompareOp::Eq => Ok(format!("{:?} == {:?}", self.as_object(), other)),
CompareOp::Ne => Ok(format!("{:?} != {:?}", self.as_object(), other)),
CompareOp::Gt => Ok(format!("{:?} > {:?}", self.as_object(), other)),
CompareOp::Ge => Ok(format!("{:?} >= {:?}", self.as_object(), other))
}
}
});
py_class!(class RichComparisons2 |py| {
def __repr__(&self) -> PyResult<&'static str> {
Ok("RC2")
}
def __richcmp__(&self, other: &PyObject, op: CompareOp) -> PyResult<PyObject> {
match op {
CompareOp::Eq => Ok(true.to_py_object(py).into_object()),
CompareOp::Ne => Ok(false.to_py_object(py).into_object()),
_ => Ok(py.NotImplemented())
}
}
});
#[test]
fn rich_comparisons() {
let gil = Python::acquire_gil();
let py = gil.python();
let c = RichComparisons::create_instance(py).unwrap();
py_run!(py, c, "assert (c < c) == 'RC < RC'");
py_run!(py, c, "assert (c < 1) == 'RC < 1'");
py_run!(py, c, "assert (1 < c) == 'RC > 1'");
py_run!(py, c, "assert (c <= c) == 'RC <= RC'");
py_run!(py, c, "assert (c <= 1) == 'RC <= 1'");
py_run!(py, c, "assert (1 <= c) == 'RC >= 1'");
py_run!(py, c, "assert (c == c) == 'RC == RC'");
py_run!(py, c, "assert (c == 1) == 'RC == 1'");
py_run!(py, c, "assert (1 == c) == 'RC == 1'");
py_run!(py, c, "assert (c != c) == 'RC != RC'");
py_run!(py, c, "assert (c != 1) == 'RC != 1'");
py_run!(py, c, "assert (1 != c) == 'RC != 1'");
py_run!(py, c, "assert (c > c) == 'RC > RC'");
py_run!(py, c, "assert (c > 1) == 'RC > 1'");
py_run!(py, c, "assert (1 > c) == 'RC < 1'");
py_run!(py, c, "assert (c >= c) == 'RC >= RC'");
py_run!(py, c, "assert (c >= 1) == 'RC >= 1'");
py_run!(py, c, "assert (1 >= c) == 'RC <= 1'");
}
#[test]
#[cfg(feature="python3-sys")]
fn rich_comparisons_python_3_type_error() {
let gil = Python::acquire_gil();
let py = gil.python();
let c2 = RichComparisons2::create_instance(py).unwrap();
py_expect_exception!(py, c2, "c2 < c2", TypeError);
py_expect_exception!(py, c2, "c2 < 1", TypeError);
py_expect_exception!(py, c2, "1 < c2", TypeError);
py_expect_exception!(py, c2, "c2 <= c2", TypeError);
py_expect_exception!(py, c2, "c2 <= 1", TypeError);
py_expect_exception!(py, c2, "1 <= c2", TypeError);
py_run!(py, c2, "assert (c2 == c2) == True");
py_run!(py, c2, "assert (c2 == 1) == True");
py_run!(py, c2, "assert (1 == c2) == True");
py_run!(py, c2, "assert (c2 != c2) == False");
py_run!(py, c2, "assert (c2 != 1) == False");
py_run!(py, c2, "assert (1 != c2) == False");
py_expect_exception!(py, c2, "c2 > c2", TypeError);
py_expect_exception!(py, c2, "c2 > 1", TypeError);
py_expect_exception!(py, c2, "1 > c2", TypeError);
py_expect_exception!(py, c2, "c2 >= c2", TypeError);
py_expect_exception!(py, c2, "c2 >= 1", TypeError);
py_expect_exception!(py, c2, "1 >= c2", TypeError);
}
py_class!(class ContextManager |py| {
data exit_called : Cell<bool>;