Mappingproxy (#1)

Adds in the MappingProxy type.
KLMatlock · Oct 22, 2024 · b2c4d76 · b2c4d76
1 parent 7909eb6
commit b2c4d76
Show file tree

Hide file tree

Showing 7 changed files with 667 additions and 10 deletions.
diff --git a/pyo3-ffi/src/descrobject.rs b/pyo3-ffi/src/descrobject.rs
@@ -1,6 +1,6 @@
 use crate::methodobject::PyMethodDef;
 use crate::object::{PyObject, PyTypeObject};
-use crate::Py_ssize_t;
+use crate::{PyObject_TypeCheck, Py_ssize_t};
 use std::os::raw::{c_char, c_int, c_void};
 use std::ptr;
 
@@ -68,6 +68,11 @@ extern "C" {
     pub fn PyWrapper_New(arg1: *mut PyObject, arg2: *mut PyObject) -> *mut PyObject;
 }
 
+#[inline]
+pub unsafe fn PyDictProxy_Check(op: *mut PyObject) -> c_int {
+    PyObject_TypeCheck(op, std::ptr::addr_of_mut!(PyDictProxy_Type))
+}
+
 /// Represents the [PyMemberDef](https://docs.python.org/3/c-api/structures.html#c.PyMemberDef)
 /// structure.
 ///

diff --git a/src/conversions/std/map.rs b/src/conversions/std/map.rs
@@ -7,7 +7,7 @@ use crate::ToPyObject;
 use crate::{
     conversion::IntoPyObject,
     instance::Bound,
-    types::{any::PyAnyMethods, dict::PyDictMethods, PyDict},
+    types::{any::PyAnyMethods, dict::PyDictMethods, PyDict, PyMappingProxy},
     FromPyObject, IntoPy, PyAny, PyErr, PyObject, Python,
 };
 
@@ -162,9 +162,19 @@ where
     S: hash::BuildHasher + Default,
 {
     fn extract_bound(ob: &Bound<'py, PyAny>) -> Result<Self, PyErr> {
-        let dict = ob.downcast::<PyDict>()?;
-        let mut ret = collections::HashMap::with_capacity_and_hasher(dict.len(), S::default());
-        for (k, v) in dict {
+        if let Ok(dict) = ob.downcast::<PyDict>() {
+            let mut ret = collections::HashMap::with_capacity_and_hasher(dict.len(), S::default());
+            for (k, v) in dict {
+                ret.insert(k.extract()?, v.extract()?);
+            }
+            return Ok(ret);
+        }
+
+        let mappingproxy = ob.downcast::<PyMappingProxy>()?;
+        let mut ret =
+            collections::HashMap::with_capacity_and_hasher(mappingproxy.len()?, S::default());
+        for res in mappingproxy.clone() {
+            let (k, v) = res?;
             ret.insert(k.extract()?, v.extract()?);
         }
         Ok(ret)
@@ -182,9 +192,18 @@ where
     V: FromPyObject<'py>,
 {
     fn extract_bound(ob: &Bound<'py, PyAny>) -> Result<Self, PyErr> {
-        let dict = ob.downcast::<PyDict>()?;
+        if let Ok(dict) = ob.downcast::<PyDict>() {
+            let mut ret = collections::BTreeMap::new();
+            for (k, v) in dict {
+                ret.insert(k.extract()?, v.extract()?);
+            }
+            return Ok(ret);
+        }
+
+        let mappingproxy = ob.downcast::<PyMappingProxy>()?;
         let mut ret = collections::BTreeMap::new();
-        for (k, v) in dict {
+        for res in mappingproxy.clone() {
+            let (k, v) = res?;
             ret.insert(k.extract()?, v.extract()?);
         }
         Ok(ret)

diff --git a/src/prelude.rs b/src/prelude.rs
@@ -38,6 +38,7 @@ pub use crate::types::float::PyFloatMethods;
 pub use crate::types::frozenset::PyFrozenSetMethods;
 pub use crate::types::list::PyListMethods;
 pub use crate::types::mapping::PyMappingMethods;
+pub use crate::types::mappingproxy::PyMappingProxyMethods;
 pub use crate::types::module::PyModuleMethods;
 pub use crate::types::sequence::PySequenceMethods;
 pub use crate::types::set::PySetMethods;

diff --git a/src/sealed.rs b/src/sealed.rs
@@ -1,7 +1,7 @@
 use crate::types::{
     PyBool, PyByteArray, PyBytes, PyCapsule, PyComplex, PyDict, PyFloat, PyFrozenSet, PyList,
-    PyMapping, PyModule, PySequence, PySet, PySlice, PyString, PyTraceback, PyTuple, PyType,
-    PyWeakref, PyWeakrefProxy, PyWeakrefReference,
+    PyMapping, PyMappingProxy, PyModule, PySequence, PySet, PySlice, PyString, PyTraceback,
+    PyTuple, PyType, PyWeakref, PyWeakrefProxy, PyWeakrefReference,
 };
 use crate::{ffi, Bound, PyAny, PyResult};
 
@@ -33,6 +33,7 @@ impl Sealed for Bound<'_, PyFloat> {}
 impl Sealed for Bound<'_, PyFrozenSet> {}
 impl Sealed for Bound<'_, PyList> {}
 impl Sealed for Bound<'_, PyMapping> {}
+impl Sealed for Bound<'_, PyMappingProxy> {}
 impl Sealed for Bound<'_, PyModule> {}
 impl Sealed for Bound<'_, PySequence> {}
 impl Sealed for Bound<'_, PySet> {}

diff --git a/src/types/dict.rs b/src/types/dict.rs
@@ -591,7 +591,7 @@ where
 }
 
 /// Represents a tuple which can be used as a PyDict item.
-trait PyDictItem<'py> {
+pub trait PyDictItem<'py> {
     type K: IntoPyObject<'py>;
     type V: IntoPyObject<'py>;
     fn unpack(self) -> (Self::K, Self::V);