PyFrame: basic methods to get started

Signed-off-by: daniel sonbolian <[email protected]>
PyO3 · Jan 29, 2025 · 8ac36cf · 8ac36cf
1 parent 0a97d53
commit 8ac36cf
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 3 deletions.
diff --git a/pyo3-ffi/src/pyframe.rs b/pyo3-ffi/src/pyframe.rs
@@ -27,7 +27,6 @@ extern "C" {
     #[cfg(Py_3_11)]
     pub fn PyFrame_GetBuiltins(frame: *mut PyFrameObject) -> *mut PyObject;
 
-    #[cfg(Py_3_11)]
     pub fn PyFrame_GetLocals(frame: *mut PyFrameObject) -> *mut PyObject;
 
     #[cfg(Py_3_11)]

diff --git a/src/prelude.rs b/src/prelude.rs
@@ -50,3 +50,4 @@ pub use crate::types::traceback::PyTracebackMethods;
 pub use crate::types::tuple::PyTupleMethods;
 pub use crate::types::typeobject::PyTypeMethods;
 pub use crate::types::weakref::PyWeakrefMethods;
+pub use crate::types::frame::PyFrameMethods;
diff --git a/src/types/frame.rs b/src/types/frame.rs
@@ -1,5 +1,7 @@
 use crate::ffi;
+use crate::ffi_ptr_ext::FfiPtrExt;
 use crate::PyAny;
+use crate::{Bound, PyObject, PyResult};
 
 /// Represents a Python frame.
 ///
@@ -13,3 +15,21 @@ pyobject_native_type_core!(
     pyobject_native_static_type_object!(ffi::PyFrame_Type),
     #checkfunction=ffi::PyFrame_Check
 );
+
+pub trait PyFrameMethods<'py> {
+    fn get_line(&self) -> usize;
+
+    fn get_locals(&self) -> PyResult<Bound<'py, PyAny>>;
+}
+
+impl<'py> PyFrameMethods<'py> for Bound<'py, PyFrame> {
+    fn get_line(&self) -> usize {
+        (unsafe { ffi::PyFrame_GetLineNumber(self.as_ptr() as *mut ffi::PyFrameObject) }) as usize
+    }
+
+    fn get_locals(&self) -> PyResult<Bound<'py, PyAny>> {
+        unsafe {
+            ffi::PyFrame_GetLocals(self.as_ptr() as *mut ffi::PyFrameObject).assume_owned_or_err(self.py())
+        }
+    }
+}
diff --git a/src/types/mod.rs b/src/types/mod.rs
@@ -20,7 +20,7 @@ pub use self::dict::{PyDictItems, PyDictKeys, PyDictValues};
 pub use self::ellipsis::PyEllipsis;
 pub use self::float::{PyFloat, PyFloatMethods};
 #[cfg(all(not(Py_LIMITED_API), not(PyPy), not(GraalPy)))]
-pub use self::frame::PyFrame;
+pub use self::frame::{PyFrame, PyFrameMethods};
 pub use self::frozenset::{PyFrozenSet, PyFrozenSetBuilder, PyFrozenSetMethods};
 pub use self::function::PyCFunction;
 #[cfg(all(not(Py_LIMITED_API), not(all(PyPy, not(Py_3_8)))))]
@@ -245,7 +245,7 @@ pub(crate) mod dict;
 mod ellipsis;
 pub(crate) mod float;
 #[cfg(all(not(Py_LIMITED_API), not(PyPy), not(GraalPy)))]
-mod frame;
+pub mod frame;
 pub(crate) mod frozenset;
 mod function;
 pub(crate) mod iterator;