# [Python-checkins] CVS: python/dist/src/Doc/lib libtempfile.tex,1.12,1.13

Fred L. Drake python-dev@python.org
Fri, 26 May 2000 12:05:18 -0700

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv23740/lib

Modified Files:
libtempfile.tex
Log Message:

Added documentation for TemporaryFile() and the siffix parameter to mktemp().
files.
Removed obsolete comment about users needing to set template to None after
calling os.fork().

Index: libtempfile.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libtempfile.tex,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** libtempfile.tex	1999/04/21 17:01:15	1.12
--- libtempfile.tex	2000/05/26 19:05:16	1.13
***************
*** 12,24 ****
but it may require some help on non-\UNIX{} systems.

! Note: the modules does not create temporary files, nor does it
! automatically remove them when the current process exits or dies.

! The module defines a single user-callable function:
!
! \begin{funcdesc}{mktemp}{}
Return a unique temporary filename.  This is an absolute pathname of a
file that does not exist at the time the call is made.  No two calls
! will return the same filename.
\end{funcdesc}

--- 12,44 ----
but it may require some help on non-\UNIX{} systems.

! The module defines the following user-callable functions:

! \begin{funcdesc}{mktemp}{\optional{suffix}}
Return a unique temporary filename.  This is an absolute pathname of a
file that does not exist at the time the call is made.  No two calls
! will return the same filename.  \var{suffix}, if provided, is used as
! the last part of the generated file name.  This can be used to provide
! a filename extension or other identifying information that may be
! useful on some platforms.
! \end{funcdesc}
!
! \begin{funcdesc}{TemporaryFile}{\optional{mode\optional{,
!                                 bufsize\optional{, suffix}}}}
! Return a file (or file-like) object that can be used as a temporary
! storage area.  The file is created in the most secure manner available
! in the appporpriate temporary directory for the host platform.  Under
! \UNIX, the directory entry to the file is removed so that it is secure
! against attacks which involve creating symbolic links to the file or
! replacing the file with a symbolic link to some other file.  For other
! platforms, which don't allow removing the directory entry while the
! file is in use, the file is automatically deleted as soon as it is
! closed (including an implicit close when it is garbage-collected).
!
! The \var{mode} parameter defaults to \code{'w+b'} so that the file
! created can be read and written without being closed.  Binary mode is
! used so that it behaves consistently on all platforms without regard
! for the data that is stored.  \var{bufsize} defaults to \code{-1},
! meaning that the operating system default is used.  \var{suffix} is
! passed to \function{mktemp()}.
\end{funcdesc}

***************
*** 44,52 ****
other systems).