Module state 

Interaction with attachment of the current thread to the Python interpreter.

Structs

ForbidAttaching 🔒

Used to lock safe access to the interpreter

ReferencePool 🔒 Non-pyo3_disable_reference_pool

Thread-safe storage for objects which were dec_ref while not attached.

SuspendAttach 🔒

A guard which can be used to temporarily detach from the interpreter and restore on Drop.

Enums

AttachError 🔒

Possible error when calling try_attach()

AttachGuard 🔒

RAII type that represents thread attachment to the interpreter.

Constants

ATTACH_COUNT 🔒

This is an internal counter in pyo3 monitoring whether this thread is attached to the interpreter.

ATTACH_FORBIDDEN_DURING_TRAVERSE 🔒

Statics

POOL 🔒 Non-pyo3_disable_reference_pool

Functions

decrement_attach_count 🔒

Decrements pyo3’s internal attach count - to be called whenever AttachGuard is dropped.

drop_deferred_references 🔒

get_pool 🔒 Non-pyo3_disable_reference_pool

increment_attach_count 🔒

Increments pyo3’s internal attach count - to be called whenever an AttachGuard is created.

is_in_gc_traversal 🔒 Non-Py_LIMITED_API or Py_3_11

Private helper function to check if we are currently in a GC traversal (as detected by PyO3).

register_decref^⚠

Registers a Python object pointer inside the release pool, to have its reference count decreased the next time the thread is attached in pyo3.

thread_is_attached 🔒

Checks whether the thread is attached to the Python interpreter.

Type Aliases

PyObjVec 🔒 Non-pyo3_disable_reference_pool