gc
index
(built-in)
Module Docs

This module provides access to the garbage collector for reference cycles.
 
enable() -- Enable automatic garbage collection.
disable() -- Disable automatic garbage collection.
isenabled() -- Returns true if automatic collection is enabled.
collect() -- Do a full collection right now.
set_debug() -- Set debugging flags.
get_debug() -- Get debugging flags.
set_threshold() -- Set the collection thresholds.
get_threshold() -- Return the current the collection thresholds.
get_objects() -- Return a list of all objects tracked by the collector.
get_referrers() -- Return the list of objects that refer to an object.
get_referents() -- Return the list of objects that an object refers to.

 
Functions
       
collect(...)
collect() -> n
 
Run a full collection.  The number of unreachable objects is returned.
disable(...)
disable() -> None
 
Disable automatic garbage collection.
enable(...)
enable() -> None
 
Enable automatic garbage collection.
get_debug(...)
get_debug() -> flags
 
Get the garbage collection debugging flags.
get_objects(...)
get_objects() -> [...]
 
Return a list of objects tracked by the collector (excluding the list
returned).
get_referents(...)
get_referents(*objs) -> list
Return the list of objects that are directly referred to by objs.
get_referrers(...)
get_referrers(*objs) -> list
Return the list of objects that directly refer to any of objs.
get_threshold(...)
get_threshold() -> (threshold0, threshold1, threshold2)
 
Return the current collection thresholds
isenabled(...)
isenabled() -> status
 
Returns true if automatic garbage collection is enabled.
set_debug(...)
set_debug(flags) -> None
 
Set the garbage collection debugging flags. Debugging information is
written to sys.stderr.
 
flags is an integer and can have the following bits turned on:
 
  DEBUG_STATS - Print statistics during collection.
  DEBUG_COLLECTABLE - Print collectable objects found.
  DEBUG_UNCOLLECTABLE - Print unreachable but uncollectable objects found.
  DEBUG_INSTANCES - Print instance objects.
  DEBUG_OBJECTS - Print objects other than instances.
  DEBUG_SAVEALL - Save objects to gc.garbage rather than freeing them.
  DEBUG_LEAK - Debug leaking programs (everything but STATS).
set_threshold(...)
set_threshold(threshold0, [threshold1, threshold2]) -> None
 
Sets the collection thresholds.  Setting threshold0 to zero disables
collection.

 
Data
        DEBUG_COLLECTABLE = 2
DEBUG_INSTANCES = 8
DEBUG_LEAK = 62
DEBUG_OBJECTS = 16
DEBUG_SAVEALL = 32
DEBUG_STATS = 1
DEBUG_UNCOLLECTABLE = 4
garbage = []