Struct Py 

pub struct Py<T> { /* private fields */ }

This is an actual python object. It consists of a typ which is the python class, and carries some rust payload optionally. This rust payload can be a rust float or rust int in case of float and int objects.

Implementations

impl Py<PyByteArray>

pub fn resize(&self, size: isize, vm: &VirtualMachine) -> PyResult<()>

impl Py<PyBytes>

pub fn as_bytes(&self) -> &[u8]

impl Py<PyCode>

pub fn co_cellvars(&self, vm: &VirtualMachine) -> PyTupleRef

pub fn co_varnames(&self, vm: &VirtualMachine) -> PyTupleRef

pub fn co_code(&self, vm: &VirtualMachine) -> PyBytesRef

pub fn _co_code_adaptive(&self, vm: &VirtualMachine) -> PyBytesRef

pub fn co_freevars(&self, vm: &VirtualMachine) -> PyTupleRef

pub fn co_linetable(&self, vm: &VirtualMachine) -> PyBytesRef

pub fn co_exceptiontable(&self, vm: &VirtualMachine) -> PyBytesRef

pub fn co_lines(&self, vm: &VirtualMachine) -> PyResult<PyObjectRef>

pub fn co_positions(&self, vm: &VirtualMachine) -> PyResult<PyObjectRef>

pub fn co_branches(&self, vm: &VirtualMachine) -> PyResult<PyObjectRef>

pub fn __replace__( &self, args: ReplaceArgs, vm: &VirtualMachine, ) -> PyResult<PyCode>

pub fn replace( &self, args: ReplaceArgs, vm: &VirtualMachine, ) -> PyResult<PyCode>

impl Py<PyComplex>

pub const fn as_complex(&self) -> Complex64

impl Py<PyDict>

pub fn clear(&self)

pub fn copy(&self) -> PyDict

impl Py<PyDict>

pub fn to_attributes( &self, vm: &VirtualMachine, on_non_string: impl FnOnce(&VirtualMachine) -> PyResult<()>, ) -> PyResult<IndexMap<&'static PyStrInterned, PyObjectRef, RandomState>>

Take a python dictionary and convert it to attributes.

PyAttributes is keyed by interned strings, so a key that is not a string has nowhere to go. Those keys are left out, and on_non_string is called once, the first time one turns up, so the caller can decide whether that deserves an error or a warning.

pub fn get_item_opt<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

pub fn get_item<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult

pub fn set_item<K: DictKey + ?Sized>( &self, key: &K, value: PyObjectRef, vm: &VirtualMachine, ) -> PyResult<()>

pub fn del_item<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult<()>

pub fn pop_item<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

pub fn get_chain<K: DictKey + ?Sized>( &self, other: &Self, key: &K, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

impl Py<PyFloat>

pub const fn to_f64(&self) -> f64

impl Py<FrameObject>

pub fn f_locals(&self, vm: &VirtualMachine) -> PyResult

pub fn f_back(&self, vm: &VirtualMachine) -> Option<PyRef<FrameObject>>

pub fn f_globals(&self) -> PyDictRef

pub fn f_builtins(&self) -> PyObjectRef

pub fn f_code(&self) -> PyRef<PyCode>

impl Py<PyFunction>

pub fn invoke_with_locals( &self, func_args: FuncArgs, locals: Option<ArgMapping>, vm: &VirtualMachine, ) -> PyResult

pub fn invoke(&self, func_args: FuncArgs, vm: &VirtualMachine) -> PyResult

pub fn func_version(&self) -> u32

Returns the function version, or 0 if invalidated.

pub fn get_version_for_current_state(&self) -> u32

Returns the current version, assigning a fresh one if previously invalidated. Returns 0 if the version counter has overflowed. _PyFunction_GetVersionForCurrentState

pub fn invoke_exact_args( &self, args: Vec<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult

Fast path for calling a simple function with exact positional args. Skips FuncArgs allocation, prepend_arg, and fill_locals_from_args. Only valid when: CO_OPTIMIZED, no VARARGS, no VARKEYWORDS, no kwonlyargs, and nargs == co_argcount.

impl Py<PyInt>

pub const fn as_bigint(&self) -> &BigInt

pub fn to_str_radix_10(&self) -> String

Fast decimal string conversion, using i64 path when possible.

pub fn as_u32_mask(&self) -> u32

pub fn as_u64_mask(&self) -> u64

pub fn try_to_primitive<I>(&self, vm: &VirtualMachine) -> PyResult<I>

where I: PrimInt + for<'a> TryFrom<&'a BigInt>,

pub fn try_to_primitive_in_range<I>(&self, vm: &VirtualMachine) -> PyResult<I>

where I: PrimInt + for<'a> TryFrom<&'a BigInt>,

impl Py<PyList>

pub fn borrow_vec(&self) -> PyMappedRwLockReadGuard<'_, [PyObjectRef]>

pub fn borrow_vec_mut(&self) -> PyRwLockWriteGuard<'_, Vec<PyObjectRef>>

impl Py<PyMappingProxy>

pub fn items(&self, vm: &VirtualMachine) -> PyResult

pub fn keys(&self, vm: &VirtualMachine) -> PyResult

pub fn values(&self, vm: &VirtualMachine) -> PyResult

pub fn copy(&self, vm: &VirtualMachine) -> PyResult

impl Py<PyModule>

pub fn __init_methods(&self, vm: &VirtualMachine) -> PyResult<()>

pub fn dict(&self) -> PyDictRef

pub fn get_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult

pub fn set_attr<'a>( &self, attr_name: impl AsPyStr<'a>, attr_value: impl Into<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<()>

impl Py<PyStr>

pub fn as_wtf8(&self) -> &Wtf8

pub fn as_bytes(&self) -> &[u8]

pub fn as_utf8(&self) -> Option<&Py<PyUtf8Str>>

pub fn try_as_utf8<'a>( &'a self, vm: &VirtualMachine, ) -> PyResult<&'a Py<PyUtf8Str>>

impl Py<PyStr>

pub fn isascii(&self) -> bool

pub fn partition(&self, sep: PyStrRef, vm: &VirtualMachine) -> PyResult

pub fn rpartition(&self, sep: PyStrRef, vm: &VirtualMachine) -> PyResult

pub fn isidentifier(&self) -> bool

pub fn translate( &self, table: PyObjectRef, vm: &VirtualMachine, ) -> PyResult<Wtf8Buf>

impl Py<PyUtf8Str>

pub const fn as_pystr(&self) -> &Py<PyStr>

Upcast to PyStr.

pub fn as_str(&self) -> &str

Returns the underlying &str.

impl Py<PyType>

pub fn slots(&self) -> &PyTypeSlots

pub fn attributes(&self) -> &TypeNamespace

pub fn tp_version_tag(&self) -> &AtomicU32

pub fn heaptype_ext(&self) -> Option<&HeapTypeExt>

pub fn is_subtype(&self, other: &Self) -> bool

pub fn check_exact<'a>( obj: &'a PyObject, vm: &VirtualMachine, ) -> Option<&'a Self>

Equivalent to CPython’s PyType_CheckExact macro Checks if obj is exactly a type (not a subclass)

pub fn fast_issubclass(&self, cls: &impl Borrow<PyObject>) -> bool

Determines if subclass is actually a subclass of cls, this doesn’t call subclasscheck, so only use this if cls is known to have not overridden the base subclasscheck magic method.

pub fn mro_map_collect<F, R>(&self, f: F) -> Vec<R>

where F: Fn(&Self) -> R,

pub fn mro_collect(&self) -> Vec<PyRef<PyType>>

pub fn iter_base_chain(&self) -> impl Iterator<Item = &Self>

pub fn extend_methods( &'static self, method_defs: &'static [PyMethodDef], ctx: &Context, )

impl Py<PyType>

pub fn __name__(&self, vm: &VirtualMachine) -> PyStrRef

pub fn __qualname__(&self, vm: &VirtualMachine) -> PyObjectRef

pub fn __module__(&self, vm: &VirtualMachine) -> PyResult<PyObjectRef>

impl Py<PySet>

pub fn add(&self, object: PyObjectRef, vm: &VirtualMachine) -> PyResult<()>

pub fn discard(&self, object: PyObjectRef, vm: &VirtualMachine) -> PyResult<()>

pub fn clear(&self)

pub fn pop(&self, vm: &VirtualMachine) -> PyResult

impl Py<PySlice>

pub fn to_saturated(&self, vm: &VirtualMachine) -> PyResult<SaturatedSlice>

impl<R> Py<PyTuple<R>>

pub fn as_slice(&self) -> &[R]

impl Py<PyTuple>

pub fn extract_tuple<'a, T: FromPyTuple<'a>>( &'a self, vm: &VirtualMachine, ) -> PyResult<T>

impl<T: PyPayload> Py<PyTuple<PyRef<T>>>

pub fn as_untyped(&self) -> &Py<PyTuple>

impl Py<PyBaseException>

pub fn traceback(&self) -> Option<PyRef<PyTraceback>>

pub fn add_note(&self, note: PyStrRef, vm: &VirtualMachine) -> PyResult<()>

pub fn args(&self) -> PyTupleRef

pub fn __traceback__(&self) -> Option<PyRef<PyTraceback>>

pub fn __cause__(&self) -> Option<PyRef<PyBaseException>>

pub fn __context__(&self) -> Option<PyRef<PyBaseException>>

impl Py<FrameObject>

pub fn run(&self, vm: &VirtualMachine) -> PyResult<ExecutionResult>

pub fn yield_from_target(&self) -> Option<PyObjectRef>

pub fn is_internal_frame(&self) -> bool

pub fn next_external_frame(&self, vm: &VirtualMachine) -> Option<FrameObjectRef>

impl Py<HeapMethodDef>

pub fn build_function( &self, vm: &VirtualMachine, zelf: Option<PyObjectRef>, ) -> PyRef<PyNativeFunction>

pub fn build_method( &self, class: &'static Py<PyType>, vm: &VirtualMachine, ) -> PyRef<PyMethodDescriptor>

impl Py<PyWeak>

pub fn upgrade(&self) -> Option<PyObjectRef>

impl<T: PyPayload> Py<T>

pub fn downgrade( &self, callback: Option<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<PyWeakRef<T>>

pub fn payload(&self) -> &T

impl<T: PySubclass> Py<T>

pub fn to_base(&self) -> &Py<T::Base>

Converts &Py<T> to &Py<T::Base>.

pub fn upcast_ref<U: PyPayload + StaticType>(&self) -> &Py<U>

where T: StaticType,

Converts &Py<T> to &Py<U> where U is an ancestor type.

Trait Implementations

impl AsRef<Py<PyInt>> for ArgIndex

fn as_ref(&self) -> &Py<PyInt>

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

impl<T> AsRef<Py<T>> for PyRef<T>

fn as_ref(&self) -> &Py<T>

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

impl<T: PyPayload> AsRef<Py<T>> for PyExact<T>

fn as_ref(&self) -> &Py<T>

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

impl<T: PyPayload> AsRef<Py<T>> for PyRefExact<T>

fn as_ref(&self) -> &Py<T>

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

impl<T> AsRef<PyObject> for Py<T>

where T: PyPayload,

fn as_ref(&self) -> &PyObject

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

impl AsRef<Wtf8> for Py<PyStr>

fn as_ref(&self) -> &Wtf8

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

impl AsRef<str> for Py<PyStr>

fn as_ref(&self) -> &str

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

impl<T> Borrow<Py<T>> for PyRef<T>

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value.

impl<T: PyPayload> Borrow<Py<T>> for PyExact<T>

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value.

impl<T: PyPayload> Borrow<Py<T>> for PyRefExact<T>

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value.

impl<T: PyPayload> Borrow<PyObject> for Py<T>

fn borrow(&self) -> &PyObject

Immutably borrows from an owned value.

impl<T: PyPayload + Debug> Debug for Py<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for Py<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: PyPayload + Display> Display for Py<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Eq for Py<T>

where T: Eq + PyPayload,

impl<'a, T: PyPayload> From<&'a Py<T>> for &'a PyObject

fn from(py_ref: &'a Py<T>) -> Self

Converts to this type from the input type.

impl<T> Hash for Py<T>

where T: Hash + PyPayload,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Py<PyDict>

type Item = (PyObjectRef, PyObjectRef)

The type of the elements being iterated over.

type IntoIter = DictIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, R> IntoIterator for &'a Py<PyTuple<R>>

type Item = &'a R

The type of the elements being iterated over.

type IntoIter = Iter<'a, R>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> PartialEq for Py<T>

where T: PartialEq + PyPayload,

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> ToOwned for Py<T>

type Owned = PyRef<T>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Traverse for Py<Erased>

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

Because PyObject hold a Py<Erased>, so we need to trace it

fn clear(&mut self, _out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.

impl<T: MaybeTraverse> Traverse for Py<T>

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

DO notice that call trace on Py<T> means apply tracer_fn on Py<T>’s children, not like call trace on PyRef<T> which apply tracer_fn on PyRef<T> itself

Type is known, so we can call try_trace directly instead of using erased type vtable

fn clear(&mut self, _out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.

impl<'a, T: PyPayload> TryFromBorrowedObject<'a> for &'a Py<T>

fn try_from_borrowed_object( vm: &VirtualMachine, obj: &'a PyObject, ) -> PyResult<Self>

Attempt to convert a Python object to a value of this type.

impl Wtf8Concat for Py<PyStr>

fn fmt_wtf8(&self, buf: &mut Wtf8Buf)