Added a warning about reference cycles and memory consumption to the

section on functions which return stack frames.

This closes SF bug #449258.
This commit is contained in:
Fred Drake 2001-08-10 17:37:33 +00:00
parent 9b9c972abe
commit d635e3c468
1 changed files with 10 additions and 0 deletions

View File

@ -264,6 +264,16 @@ line within that list.
The optional \var{context} argument specifies the number of lines of The optional \var{context} argument specifies the number of lines of
context to return, which are centered around the current line. context to return, which are centered around the current line.
\strong{Warning:} Keeping references to frame objects, as found in
the first element of the frame records these functions return, can
cause your program to create reference cycles. Once a reference cycle
has been created, the lifespan of all objects which can be accessed
from the objects which form the cycle can become much longer even if
Python's optional cycle detector is enabled. If such cycles must be
created, it is important to ensure they are explicitly broken to avoid
the delayed destruction of objects and increased memory consumption
which occurs.
\begin{funcdesc}{getouterframes}{frame\optional{, context}} \begin{funcdesc}{getouterframes}{frame\optional{, context}}
Get a list of frame records for a frame and all higher (calling) Get a list of frame records for a frame and all higher (calling)
frames. frames.