Struct PyCFunction

#[repr(transparent)]
pub struct PyCFunction(PyAny);

Represents a builtin Python function object.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyCFunction> or Bound<'py, PyCFunction>.

Tuple Fields

0: PyAny

Implementations

impl PyCFunction

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyCFunction

pub fn new_with_keywords<'py>( py: Python<'py>, fun: PyCFunctionWithKeywords, name: &'static CStr, doc: &'static CStr, module: Option<&Bound<'py, PyModule>>, ) -> PyResult<Bound<'py, Self>>

Create a new built-in function with keywords (*args and/or **kwargs).

To create name and doc static strings on Rust versions older than 1.77 (which added c““ literals), use the c_str! macro.

pub fn new_with_keywords_bound<'py>( py: Python<'py>, fun: PyCFunctionWithKeywords, name: &'static CStr, doc: &'static CStr, module: Option<&Bound<'py, PyModule>>, ) -> PyResult<Bound<'py, Self>>

👎Deprecated since 0.23.0: renamed to PyCFunction::new_with_keywords

Deprecated name for PyCFunction::new_with_keywords.

pub fn new<'py>( py: Python<'py>, fun: PyCFunction, name: &'static CStr, doc: &'static CStr, module: Option<&Bound<'py, PyModule>>, ) -> PyResult<Bound<'py, Self>>

Create a new built-in function which takes no arguments.

To create name and doc static strings on Rust versions older than 1.77 (which added c““ literals), use the c_str! macro.

pub fn new_bound<'py>( py: Python<'py>, fun: PyCFunction, name: &'static CStr, doc: &'static CStr, module: Option<&Bound<'py, PyModule>>, ) -> PyResult<Bound<'py, Self>>

👎Deprecated since 0.23.0: renamed to PyCFunction::new

Deprecated name for PyCFunction::new.

pub fn new_closure<'py, F, R>( py: Python<'py>, name: Option<&'static CStr>, doc: Option<&'static CStr>, closure: F, ) -> PyResult<Bound<'py, Self>>

where F: Fn(&Bound<'_, PyTuple>, Option<&Bound<'_, PyDict>>) -> R + Send + 'static, for<'p> R: IntoPyCallbackOutput<'p, *mut PyObject>,

Create a new function from a closure.

Examples

Python::with_gil(|py| {
    let add_one = |args: &Bound<'_, PyTuple>, _kwargs: Option<&Bound<'_, PyDict>>| -> PyResult<_> {
        let i = args.extract::<(i64,)>()?.0;
        Ok(i+1)
    };
    let add_one = PyCFunction::new_closure(py, None, None, add_one).unwrap();
    py_run!(py, add_one, "assert add_one(42) == 43");
});

pub fn new_closure_bound<'py, F, R>( py: Python<'py>, name: Option<&'static CStr>, doc: Option<&'static CStr>, closure: F, ) -> PyResult<Bound<'py, Self>>

where F: Fn(&Bound<'_, PyTuple>, Option<&Bound<'_, PyDict>>) -> R + Send + 'static, for<'p> R: IntoPyCallbackOutput<'p, *mut PyObject>,

👎Deprecated since 0.23.0: renamed to PyCFunction::new_closure

Deprecated name for PyCFunction::new_closure.

#[doc(hidden)] pub fn internal_new<'py>( py: Python<'py>, method_def: &PyMethodDef, module: Option<&Bound<'py, PyModule>>, ) -> PyResult<Bound<'py, Self>>

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsRef<PyAny> for PyCFunction

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyCFunction

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyCFunction

const NAME: &'static str = "PyCFunction"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyCFunction