File tree Expand file tree Collapse file tree 1 file changed +21
-0
lines changed Expand file tree Collapse file tree 1 file changed +21
-0
lines changed Original file line number Diff line number Diff line change @@ -95,6 +95,8 @@ for the I/O buffer escapes completely the Python memory manager.
9595Allocator Domains
9696=================
9797
98+ .. _allocator-domains :
99+
98100All allocating functions belong to one of three different "domains" (see also
99101:c:type: `PyMemAllocatorDomain `). These domains represent different allocation
100102strategies and are optimized for different purposes. The specific details on
@@ -479,6 +481,25 @@ Customize Memory Allocators
479481 See also :c:member:`PyPreConfig.allocator` and :ref:`Preinitialize Python
480482 with PyPreConfig <c-preinit>`.
481483
484+ .. warning::
485+
486+ :c:func:`PyMem_SetAllocator` does have the following contract:
487+
488+ * It can be called after :c:func:`Py_PreInitialize` and before
489+ :c:func:`Py_InitializeFromConfig` to install a custom memory
490+ allocator. There are no restrictions over the installed allocator
491+ other than the ones imposed by the domain (for instance, the Raw
492+ Domain allows the allocator to be called without the GIL held). See
493+ :ref:`the section on allocator domains <allocator-domains>` for more
494+ information.
495+
496+ * If called after Python has finish initializing (after
497+ :c:func: `Py_InitializeFromConfig ` has been called) the allocator
498+ **must** wrap the existing allocator. Substituting the current
499+ allocator for some other arbitrary one is **not supported**.
500+
501+
502+
482503.. c:function:: void PyMem_SetupDebugHooks(void)
483504
484505 Setup :ref:`debug hooks in the Python memory allocators <pymem-debug-hooks>`
You can’t perform that action at this time.
0 commit comments