diff options
| author | Georg Brandl <georg@python.org> | 2010-05-21 21:12:07 +0000 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-05-21 21:12:07 +0000 |
| commit | 14dfede13bf552c07970b20c8ef97dbd3410e2b8 (patch) | |
| tree | 7492248854bcd2aa5cdf1b9517fba284ac866057 | |
| parent | e3285d00f80663eb338fa5dead45ca7893c7858e (diff) | |
| download | cpython-git-14dfede13bf552c07970b20c8ef97dbd3410e2b8.tar.gz | |
Fix signatures for the various TemporaryFile class^Wfunctions.
| -rw-r--r-- | Doc/library/tempfile.rst | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst index 014d673ea8..cde1b72ec2 100644 --- a/Doc/library/tempfile.rst +++ b/Doc/library/tempfile.rst @@ -27,8 +27,7 @@ is recommended to use keyword arguments for clarity. The module defines the following user-callable functions: - -.. function:: TemporaryFile(mode='w+b', bufsize=-1, suffix='', prefix='tmp', dir=None) +.. function:: TemporaryFile(mode='w+b', buffering=None, encoding=None, newline=None, suffix='', prefix='tmp', dir=None) Return a file-like object that can be used as a temporary storage area. The file is created using :func:`mkstemp`. It will be destroyed as soon @@ -41,8 +40,8 @@ The module defines the following user-callable functions: 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. + stored. *buffering*, *encoding* and *newline* are interpreted as for + :func:`open`. The *dir*, *prefix* and *suffix* parameters are passed to :func:`mkstemp`. @@ -52,7 +51,7 @@ The module defines the following user-callable functions: :keyword:`with` statement, just like a normal file. -.. function:: NamedTemporaryFile(mode='w+b', bufsize=-1, suffix='', prefix='tmp', dir=None, delete=True) +.. function:: NamedTemporaryFile(mode='w+b', buffering=None, encoding=None, newline=None, suffix='', prefix='tmp', dir=None, delete=True) This function operates exactly as :func:`TemporaryFile` does, except that the file is guaranteed to have a visible name in the file system (on @@ -67,7 +66,7 @@ The module defines the following user-callable functions: be used in a :keyword:`with` statement, just like a normal file. -.. function:: SpooledTemporaryFile(max_size=0, mode='w+b', bufsize=-1, suffix='', prefix='tmp', dir=None) +.. function:: SpooledTemporaryFile(max_size=0, mode='w+b', buffering=None, encoding=None, newline=None, suffix='', prefix='tmp', dir=None) This function operates exactly as :func:`TemporaryFile` does, except that data is spooled in memory until the file size exceeds *max_size*, or |