"tempfile" — 一時ファイルやディレクトリの作成
*********************************************

**ソースコード:** Lib/tempfile.py

======================================================================

This module generates temporary files and directories.  It works on
all supported platforms.

In version 2.3 of Python, this module was overhauled for enhanced
security.  It now provides three new functions,
"NamedTemporaryFile()", "mkstemp()", and "mkdtemp()", which should
eliminate all remaining need to use the insecure "mktemp()" function.
Temporary file names created by this module no longer contain the
process ID; instead a string of six random characters is used.

Also, all the user-callable functions now take additional arguments
which allow direct control over the location and name of temporary
files.  It is no longer necessary to use the global *tempdir* and
*template* variables. To maintain backward compatibility, the argument
order is somewhat odd; it is recommended to use keyword arguments for
clarity.

The module defines the following user-callable functions:

tempfile.TemporaryFile([mode='w+b'[, bufsize=-1[, suffix=''[, prefix='tmp'[, dir=None]]]]])

   Return a file-like object that can be used as a temporary storage
   area. The file is created using "mkstemp()". It will be destroyed
   as soon as it is closed (including an implicit close when the
   object is garbage collected).  Under Unix, the directory entry for
   the file is removed immediately after the file is created.  Other
   platforms do not support this; your code should not rely on a
   temporary file created using this function having or not having a
   visible name in the file system.

   The *mode* parameter defaults to "'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.  *bufsize* defaults to "-1", meaning that
   the operating system default is used.

   The *dir*, *prefix* and *suffix* parameters are passed to
   "mkstemp()".

   The returned object is a true file object on POSIX platforms.  On
   other platforms, it is a file-like object whose "file" attribute is
   the underlying true file object. This file-like object can be used
   in a "with" statement, just like a normal file.

tempfile.NamedTemporaryFile([mode='w+b'[, bufsize=-1[, suffix=''[, prefix='tmp'[, dir=None[, delete=True]]]]]])

   This function operates exactly as "TemporaryFile()" does, except
   that the file is guaranteed to have a visible name in the file
   system (on Unix, the directory entry is not unlinked).  That name
   can be retrieved from the "name" attribute of the returned file-
   like object.  Whether the name can be used to open the file a
   second time, while the named temporary file is still open, varies
   across platforms (it can be so used on Unix; it cannot on Windows
   NT or later).  If *delete* is true (the default), the file is
   deleted as soon as it is closed.

   The returned object is always a file-like object whose "file"
   attribute is the underlying true file object. This file-like object
   can be used in a "with" statement, just like a normal file.

   バージョン 2.3 で追加.

   バージョン 2.6 で追加: The *delete* parameter.

tempfile.SpooledTemporaryFile([max_size=0[, mode='w+b'[, bufsize=-1[, suffix=''[, prefix='tmp'[, dir=None]]]]]])

   This function operates exactly as "TemporaryFile()" does, except
   that data is spooled in memory until the file size exceeds
   *max_size*, or until the file’s "fileno()" method is called, at
   which point the contents are written to disk and operation proceeds
   as with "TemporaryFile()".  Also, it’s "truncate" method does not
   accept a "size" argument.

   この関数が返すファイルは、追加で1つのメソッド "rollover()" を持って
   います。このメソッドが呼ばれると、(サイズに関係なく)メモリからディ
   スクへのロールオーバーが実行されます。

   The returned object is a file-like object whose "_file" attribute
   is either a "StringIO" object or a true file object, depending on
   whether "rollover()" has been called. This file-like object can be
   used in a "with" statement, just like a normal file.

   バージョン 2.6 で追加.

tempfile.mkstemp([suffix=''[, prefix='tmp'[, dir=None[, text=False]]]])

   可能な限り最も安全な手段で一時ファイルを生成します。 プラットフォー
   ムが "os.open()" の "os.O_EXCL" フラグを正しく実装している限り、フ
   ァイルの作成で競合が起こることはありません。 作成したユーザのユーザ
   ID からのみファイルを読み書き出来ます。 プラットフォームがファイル
   が実行可能かどうかを示す許可ビットを使用している場合、ファイルは誰
   からも実行不可です。 このファイルのファイル記述子は子プロセスに継承
   されません。

   "TemporaryFile()" と違って、 "mkstemp()" のユーザは用済みになった時
   に一時ファイルを削除しなければなりません。

   If *suffix* is specified, the file name will end with that suffix,
   otherwise there will be no suffix.  "mkstemp()" does not put a dot
   between the file name and the suffix; if you need one, put it at
   the beginning of *suffix*.

   If *prefix* is specified, the file name will begin with that
   prefix; otherwise, a default prefix is used.

   If *dir* is specified, the file will be created in that directory;
   otherwise, a default directory is used.  The default directory is
   chosen from a platform-dependent list, but the user of the
   application can control the directory location by setting the
   *TMPDIR*, *TEMP* or *TMP* environment variables.  There is thus no
   guarantee that the generated filename will have any nice
   properties, such as not requiring quoting when passed to external
   commands via "os.popen()".

   *text* が指定された場合、ファイルをバイナリモード (デフォルト)  か
   テキストモードで開くかを示します。 プラットフォームによってはこの値
   を設定しても変化はありません。

   "mkstemp()" は開かれたファイルを扱うための OS レベルのハンドル
   ("os.open()" が返すものと同じ) とファイルの絶対パス名が順番に並んだ
   タプルを返します。

   バージョン 2.3 で追加.

tempfile.mkdtemp([suffix=''[, prefix='tmp'[, dir=None]]])

   可能な限り安全な方法で一時ディレクトリを作成します。 ディレクトリの
   生成で競合は発生しません。 ディレクトリを作成したユーザ ID だけが、
   このディレクトリに対して内容を読み出したり、書き込んだり、検索した
   りすることができます。

   "mkdtemp()" のユーザは用済みになった時に一時ディレクトリとその中身
   を削除しなければなりません。

   *prefix*, *suffix*, *dir* 引数は "mkstemp()" 関数のものと同じです。

   "mkdtemp()" は新たに生成されたディレクトリの絶対パス名を返します。

   バージョン 2.3 で追加.

tempfile.mktemp([suffix=''[, prefix='tmp'[, dir=None]]])

   バージョン 2.3 で撤廃: 代わりに "mkstemp()" を使って下さい。

   Return an absolute pathname of a file that did not exist at the
   time the call is made.  The *prefix*, *suffix*, and *dir* arguments
   are the same as for "mkstemp()".

   警告: この関数を使うとプログラムのセキュリティホールになる可能性
     があり ます。この関数がファイル名を返した後、あなたがそのファイル
     名を使 って次に何かをしようとする段階に至る前に、誰か他の人間があ
     なたを 出し抜くことができてしまいます。 "mktemp()" の利用は、
     "NamedTemporaryFile()" に "delete=False" 引数を渡すことで、簡単に
     置き換えることができます:

        >>> f = NamedTemporaryFile(delete=False)
        >>> f
        <open file '<fdopen>', mode 'w+b' at 0x384698>
        >>> f.name
        '/var/folders/5q/5qTPn6xq2RaWqk+1Ytw3-U+++TI/-Tmp-/tmpG7V1Y0'
        >>> f.write("Hello World!\n")
        >>> f.close()
        >>> os.unlink(f.name)
        >>> os.path.exists(f.name)
        False

The module uses a global variable that tell it how to construct a
temporary name.  They are initialized at the first call to any of the
functions above.  The caller may change them, but this is discouraged;
use the appropriate function arguments, instead.

tempfile.tempdir

   When set to a value other than "None", this variable defines the
   default value for the *dir* argument to all the functions defined
   in this module.

   If "tempdir" is unset or "None" at any call to any of the above
   functions, Python searches a standard list of directories and sets
   *tempdir* to the first one which the calling user can create files
   in. The list is:

   1. 環境変数 "TMPDIR" で与えられているディレクトリ名。

   2. 環境変数 "TEMP" で与えられているディレクトリ名。

   3. 環境変数 "TMP" で与えられているディレクトリ名。

   4. プラットフォーム依存の場所:

      * On RiscOS, the directory named by the "Wimp$ScrapDir"
        environment variable.

      * Windows ではディレクトリ "C:\TEMP" 、 "C:\TMP" 、 "\TEMP" 、
        お よび "\TMP" の順。

      * その他の全てのプラットフォームでは、 "/tmp" 、 "/var/tmp" 、
        お よび "/usr/tmp" の順。

   5. 最後の手段として、現在の作業ディレクトリ。

tempfile.gettempdir()

   Return the directory currently selected to create temporary files
   in. If "tempdir" is not "None", this simply returns its contents;
   otherwise, the search described above is performed, and the result
   returned.

   バージョン 2.3 で追加.

tempfile.template

   バージョン 2.0 で撤廃: Use "gettempprefix()" instead.

   When set to a value other than "None", this variable defines the
   prefix of the final component of the filenames returned by
   "mktemp()".  A string of six random letters and digits is appended
   to the prefix to make the filename unique. The default prefix is
   "tmp".

   Older versions of this module used to require that "template" be
   set to "None" after a call to "os.fork()"; this has not been
   necessary since version 1.5.2.

tempfile.gettempprefix()

   Return the filename prefix used to create temporary files.  This
   does not contain the directory component.  Using this function is
   preferred over reading the *template* variable directly.

   バージョン 1.5.2 で追加.
