Struct pyo3::Python
[−]
[src]
pub struct Python<'p>(_);
Marker type that indicates that the GIL is currently held.
The 'Python' struct is a zero-size marker struct that is required for most Python operations.
This is used to indicate that the operation accesses/modifies the Python interpreter state,
and thus can only be called if the Python interpreter is initialized and the
Python global interpreter lock (GIL) is acquired.
The lifetime 'p
represents the lifetime of the Python interpreter.
You can imagine the GIL to be a giant Mutex<PythonInterpreterState>
.
The type Python<'p>
then acts like a reference &'p PythonInterpreterState
.
Methods
impl<'p> Python<'p>
[src]
unsafe fn assume_gil_acquired() -> Python<'p>
[src]
Retrieve Python instance under the assumption that the GIL is already acquired at this point,
and stays acquired for the lifetime 'p
.
Because the output lifetime 'p
is not connected to any input parameter,
care must be taken that the compiler infers an appropriate lifetime for 'p
when calling this function.
fn acquire_gil() -> GILGuard
[src]
Acquires the global interpreter lock, which allows access to the Python runtime.
If the Python runtime is not already initialized, this function will initialize it. See prepare_freethreaded_python() for details.
fn allow_threads<T, F>(self, f: F) -> T where
F: Send + FnOnce() -> T,
[src]
F: Send + FnOnce() -> T,
Temporarily releases the GIL
, thus allowing other Python threads to run.
fn eval(
self,
code: &str,
globals: Option<&PyDict>,
locals: Option<&PyDict>
) -> PyResult<&'p PyObjectRef>
[src]
self,
code: &str,
globals: Option<&PyDict>,
locals: Option<&PyDict>
) -> PyResult<&'p PyObjectRef>
Evaluates a Python expression in the given context and returns the result.
If globals
is None
, it defaults to Python module __main__
.
If locals
is None
, it defaults to the value of globals
.
fn run(
self,
code: &str,
globals: Option<&PyDict>,
locals: Option<&PyDict>
) -> PyResult<()>
[src]
self,
code: &str,
globals: Option<&PyDict>,
locals: Option<&PyDict>
) -> PyResult<()>
Executes one or more Python statements in the given context.
If globals
is None
, it defaults to Python module __main__
.
If locals
is None
, it defaults to the value of globals
.
fn get_type<T>(self) -> &'p PyType where
T: PyTypeObject,
[src]
T: PyTypeObject,
Gets the Python type object for type T
.
fn import(self, name: &str) -> PyResult<&'p PyModule>
[src]
Import the Python module with the specified name.
fn is_instance<T: PyTypeObject, V: ToPyPointer>(self, obj: &V) -> PyResult<bool>
[src]
Check whether obj
is an instance of type T
like Python isinstance
function
fn is_subclass<T, U>(self) -> PyResult<bool> where
T: PyTypeObject,
U: PyTypeObject,
[src]
T: PyTypeObject,
U: PyTypeObject,
Check whether type T
is subclass of type U
like Python issubclass
function
fn None(self) -> PyObject
[src]
Gets the Python builtin value None
.
fn NotImplemented(self) -> PyObject
[src]
Gets the Python builtin value NotImplemented
.
impl<'p> Python<'p>
[src]
fn init<T, F>(self, f: F) -> PyResult<Py<T>> where
F: FnOnce(PyToken) -> T,
T: PyTypeInfo + PyObjectAlloc<T>,
[src]
F: FnOnce(PyToken) -> T,
T: PyTypeInfo + PyObjectAlloc<T>,
Create new instance of T
and move it under python management.
Returns Py<T>
.
fn init_ref<T, F>(self, f: F) -> PyResult<&'p T> where
F: FnOnce(PyToken) -> T,
T: PyTypeInfo + PyObjectAlloc<T>,
[src]
F: FnOnce(PyToken) -> T,
T: PyTypeInfo + PyObjectAlloc<T>,
Create new instance of T
and move it under python management.
Created object get registered in release pool. Returns references to T
fn init_mut<T, F>(self, f: F) -> PyResult<&'p mut T> where
F: FnOnce(PyToken) -> T,
T: PyTypeInfo + PyObjectAlloc<T>,
[src]
F: FnOnce(PyToken) -> T,
T: PyTypeInfo + PyObjectAlloc<T>,
Create new instance of T
and move it under python management.
Created object get registered in release pool. Returns mutable references to T
impl<'p> Python<'p>
[src]
fn checked_cast_as<T>(self, obj: PyObject) -> Result<&'p T, PyDowncastError> where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register object in release pool, and try to downcast to specific type.
unsafe fn cast_as<T>(self, obj: PyObject) -> &'p T where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register object in release pool, and do unchecked downcast to specific type.
unsafe fn from_borrowed_ptr_to_obj(self, ptr: *mut PyObject) -> &'p PyObjectRef
[src]
Register ffi::PyObject
pointer in release pool
unsafe fn from_owned_ptr<T>(self, ptr: *mut PyObject) -> &'p T where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register ffi::PyObject
pointer in release pool,
and do unchecked downcast to specific type.
unsafe fn mut_from_owned_ptr<T>(self, ptr: *mut PyObject) -> &'p mut T where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register ffi::PyObject
pointer in release pool,
Do unchecked downcast to specific type. Returns mutable reference.
unsafe fn from_owned_ptr_or_err<T>(self, ptr: *mut PyObject) -> PyResult<&'p T> where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register owned ffi::PyObject
pointer in release pool.
Returns Err(PyErr)
if the pointer is null
.
do unchecked downcast to specific type.
unsafe fn from_owned_ptr_or_opt<T>(self, ptr: *mut PyObject) -> Option<&'p T> where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register owned ffi::PyObject
pointer in release pool.
Returns None
if the pointer is null
.
do unchecked downcast to specific type.
unsafe fn from_borrowed_ptr<T>(self, ptr: *mut PyObject) -> &'p T where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register borrowed ffi::PyObject
pointer in release pool.
Panics if the pointer is null
.
do unchecked downcast to specific type.
unsafe fn mut_from_borrowed_ptr<T>(self, ptr: *mut PyObject) -> &'p mut T where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register borrowed ffi::PyObject
pointer in release pool.
Panics if the pointer is null
.
do unchecked downcast to specific type.
unsafe fn from_borrowed_ptr_or_err<T>(
self,
ptr: *mut PyObject
) -> PyResult<&'p T> where
T: PyTypeInfo,
[src]
self,
ptr: *mut PyObject
) -> PyResult<&'p T> where
T: PyTypeInfo,
Register borrowed ffi::PyObject
pointer in release pool.
Returns Err(PyErr)
if the pointer is null
.
do unchecked downcast to specific type.
unsafe fn from_borrowed_ptr_or_opt<T>(self, ptr: *mut PyObject) -> Option<&'p T> where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
Register borrowed ffi::PyObject
pointer in release pool.
Returns None
if the pointer is null
.
do unchecked downcast to specific T
.
fn release<T>(self, ob: T) where
T: IntoPyPointer,
[src]
T: IntoPyPointer,
Release PyObject reference.
fn xdecref(self, ptr: *mut PyObject)
[src]
Release ffi::PyObject
pointer.
Undefined behavior if the pointer is invalid.