Module: sarpyx.processor.utils.mem

File: sarpyx/processor/utils/mem.py

No module docstring available; module purpose is inferred from implementation.

Exported Symbols (__all__)

No explicit __all__ list. Public symbols inferred from implementation.

Public Functions (1)

cleanup_memory function

Clean up memory by deleting large variables and running garbage collection.

File location: sarpyx/processor/utils/mem.py:6

Signature

cleanup_memory(caller_globals: Dict[str, Any]=None) -> int

Parameters

ParameterTypeRequiredDefaultDescription
caller_globalsDict[str, Any]noNoneDictionary of caller's global variables. If None, gets caller's globals.

Return Type

int

Number of variables deleted.

Exceptions

None explicitly documented; inferred from implementation.

Side Effects

  • inferred from implementation

Example Usage

from sarpyx.processor.utils.mem import cleanup_memory

result = cleanup_memory()

Edge Cases

Includes optional parameters with implementation-defined fallback behavior. Documented return may be None for some execution paths.

Public Classes (0)

No public classes detected.