traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

SF bugs 996748: os.environ documentation should indicate unreliability 

Clarifed that os.environ is captured once; emphasized that it's better
to assign to os.environ than to call putenv() directly (the putenv()
docs said so, but the environ docs didn't).
This commit is contained in:
Tim Peters 2004-07-26 00:42:41 +00:00
parent d945f4e17d
commit d6ef19309d
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/lib/libos.tex
View File

@ -90,12 +90,21 @@ A mapping object representing the string environment. For example,
\code{environ['HOME']} is the pathname of your home directory (on some
platforms), and is equivalent to \code{getenv("HOME")} in C.
This mapping is captured the first time the \module{os} module is
imported, typically during Python startup as part of processing
\file{site.py}. Changes to the environment made after this time are
not reflected in \code{os.environ}, except for changes made by modifying
\code{os.environ} directly.
If the platform supports the \function{putenv()} function, this
mapping may be used to modify the environment as well as query the
environment. \function{putenv()} will be called automatically when
the mapping is modified. \note{On some platforms, including
FreeBSD and Mac OS X, setting \code{environ} may cause memory leaks.
Refer to the system documentation for putenv.}
the mapping is modified.
\note{Calling \function{putenv()} directly does not change
\code{os.environ}, so it's better to modify \code{os.environ}.}
\note{On some platforms, including FreeBSD and Mac OS X, setting
\code{environ} may cause memory leaks. Refer to the system documentation
for \cfunction{putenv()}.}
If \function{putenv()} is not provided, this mapping may be passed to
the appropriate process-creation functions to cause child processes to