Module sync 

Synchronization mechanisms which are aware of the existence of the Python interpreter.

The Python interpreter has multiple “stop the world” situations which may block threads, such as

• The Python global interpreter lock (GIL), on GIL-enabled builds of Python, or
• The Python garbage collector (GC), which pauses attached threads during collection.

To avoid deadlocks in these cases, threads should take care to be detached from the Python interpreter before performing operations which might block waiting for other threads attached to the Python interpreter.

This module provides synchronization primitives which are able to synchronize under these conditions.

Re-exports

pub use self::once_lock::PyOnceLock;

Modules

critical_section

Wrappers for the Python critical section API

once_lock 🔒

once_lock_ext_sealed 🔒

rwlock_ext_sealed 🔒

Structs

GILOnceCell 🔒 Deprecated

Interned 👻

Implementation detail for intern! macro.

Traits

MutexExt

Extension trait for std::sync::Mutex which helps avoid deadlocks between the Python interpreter and acquiring the Mutex.

OnceExt

Extension trait for Once to help avoid deadlocking when using a Once when attached to a Python thread.

OnceLockExt

Extension trait for std::sync::OnceLock which helps avoid deadlocks between the Python interpreter and initialization with the OnceLock.

RwLockExt

Extension trait for std::sync::RwLock which helps avoid deadlocks between the Python interpreter and acquiring the RwLock.

Functions

init_once_force_py_attached 🔒

init_once_lock_py_attached 🔒

init_once_py_attached 🔒

with_critical_sectionDeprecated

Deprecated alias for pyo3::sync::critical_section::with_critical_section

with_critical_section2Deprecated

Deprecated alias for pyo3::sync::critical_section::with_critical_section2