◐ Shell clean mode source ↗

PyObjectRef in rustpython_vm::object - Rust

Struct PyObjectRef

pub struct PyObjectRef { /* private fields */ }

Expand description

The PyObjectRef is one of the most used types. It is a reference to a python object. A single python object can have multiple references, and this reference counting is accounted for by this type. Use the .clone() method to create a new reference and increment the amount of references to the python object by 1.

Tries converting a python object into a complex, returns an option of whether the complex and whether the object was a complex originally or coerced into one

Convert Python bool into Rust bool.

§Safety

The raw pointer must have been previously returned from a call to PyObjectRef::into_raw. The user is responsible for ensuring that the inner data is not dropped more than once due to mishandling the reference count by calling this function too many times.

Attempt to downcast this reference to a subclass.

If the downcast fails, the original ref is returned in as Err so another downcast can be attempted without unnecessary cloning.

Force to downcast this reference to a subclass.

§Safety

T must be the exact payload type

Attempt to downcast this reference to the specific class that is associated T.

If the downcast fails, the original ref is returned in as Err so another downcast can be attempted without unnecessary cloning.

Atomically try to create a strong reference. Returns None if the strong count is already 0 (object being destroyed). Uses CAS to prevent the TOCTOU race between checking strong_count and incrementing it.

👎Deprecated:

use downcastable instead

👎Deprecated:

use downcast_unchecked_ref instead

Force to return payload as T.

§Safety

The actual payload type must be T.

👎Deprecated:

use downcast_ref instead

👎Deprecated:

use downcast_ref_if_exact instead

Set the dict field. Returns Err(dict) if this object does not have a dict field in the first place.

👎Deprecated:

use downcast_ref instead

Check if this object can be downcast to T.

Attempt to downcast this reference to a subclass.

Attempt to downcast this reference to a subclass.

§Safety

T must be the exact payload type

_PyObject_GC_IS_TRACKED

Get the referents (objects directly referenced) of this object. Uses the full traverse including dict and slots.

Call del if present, without triggering object deallocation. Used by GC to call finalizers before breaking cycles. This allows proper resurrection detection. PyObject_CallFinalizerFromDealloc

Clear weakrefs but collect callbacks instead of calling them. This is used by GC to ensure ALL weakrefs are cleared BEFORE any callbacks run. Returns collected callbacks as (PyRef, callback) pairs.

Get raw pointers to referents without incrementing reference counts. This is used during GC to avoid reference count manipulation. tp_traverse visits objects without incref

§Safety

The returned pointers are only valid as long as the object is alive and its contents haven’t been modified.

Clear this object for cycle breaking (tp_clear). This version takes &self but should only be called during GC when exclusive access is guaranteed.

§Safety

The caller must guarantee exclusive access (no other references exist)
This is only safe during GC when the object is unreachable

Check if this object has clear capability (tp_clear)

PyObject_CallArg series

PyObject_Call

Vectorcall: call with owned positional args + optional kwnames. Falls back to FuncArgs-based call if no vectorcall slot.

Takes an object and returns an iterator for it. This is typically a new iterator but if the argument is an iterator, this returns itself.

Get an attribute by name. attr_name can be a &str, String, or PyStrRef.

CPython _PyObject_GenericGetAttrWithDict

Real issubclass check without going through subclasscheck This is equivalent to CPython’s _PyObject_RealIsSubclass which just calls recursive_issubclass

Determines if self is a subclass of cls, either directly, indirectly or virtually via the subclasscheck magic method. PyObject_IsSubclass/object_issubclass

Determines if self is an instance of cls, either directly, indirectly or virtually via the instancecheck magic method.

Equivalent to CPython’s _PyObject_LookupSpecial Looks up a special method in the type’s MRO without checking instance dict. Returns None if not found (masking AttributeError like CPython).

Determines if obj actually an instance of cls, this doesn’t call instancecheck, so only use this if cls is known to have not overridden the base instancecheck magic method.

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Returns the argument unchanged.

The range of positional arguments permitted by the function signature. Read more

Extracts this item from the next argument(s).

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

Returns the String produced by Ts Debug implementation.

§Examples

use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.