diff options
author | Nick Coghlan <ncoghlan@gmail.com> | 2013-07-28 12:25:25 (GMT) |
---|---|---|
committer | Nick Coghlan <ncoghlan@gmail.com> | 2013-07-28 12:25:25 (GMT) |
commit | cf67b2a8916df3a696050b3ba36ac8049c9961f9 (patch) | |
tree | 750b0c3d2de058b15644cd25d111112ab8f94f84 /Doc | |
parent | b8de598305428608fad9d95e890293dee4938faf (diff) | |
parent | 5517596c0428ee3620c28fd68ba5a0b1627d59b6 (diff) | |
download | cpython-cf67b2a8916df3a696050b3ba36ac8049c9961f9.zip cpython-cf67b2a8916df3a696050b3ba36ac8049c9961f9.tar.gz cpython-cf67b2a8916df3a696050b3ba36ac8049c9961f9.tar.bz2 |
Merge #15415 from 3.3
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/test.rst | 38 |
1 files changed, 30 insertions, 8 deletions
diff --git a/Doc/library/test.rst b/Doc/library/test.rst index bf78b4d..3f2980f 100644 --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -387,18 +387,40 @@ The :mod:`test.support` module defines the following functions: self.assertEqual(captured, "hello") -.. function:: temp_cwd(name='tempcwd', quiet=False, path=None) +.. function:: temp_dir(path=None, quiet=False) + + A context manager that creates a temporary directory at *path* and + yields the directory. + + If *path* is None, the temporary directory is created using + :func:`tempfile.mkdtemp`. If *quiet* is ``False``, the context manager + raises an exception on error. Otherwise, if *path* is specified and + cannot be created, only a warning is issued. + + +.. function:: change_cwd(path, quiet=False) A context manager that temporarily changes the current working - directory (CWD). + directory to *path* and yields the directory. + + If *quiet* is ``False``, the context manager raises an exception + on error. Otherwise, it issues only a warning and keeps the current + working directory the same. + + +.. function:: temp_cwd(name='tempcwd', quiet=False) + + A context manager that temporarily creates a new directory and + changes the current working directory (CWD). - An existing path may be provided as *path*, in which case this function - makes no changes to the file system. + The context manager creates a temporary directory in the current + directory with name *name* before temporarily changing the current + working directory. If *name* is None, the temporary directory is + created using :func:`tempfile.mkdtemp`. - Otherwise, the new CWD is created in the current directory and it's named - *name*. If *quiet* is ``False`` and it's not possible to create or - change the CWD, an error is raised. If it's ``True``, only a warning - is raised and the original CWD is used. + If *quiet* is ``False`` and it is not possible to create or change + the CWD, an error is raised. Otherwise, only a warning is raised + and the original CWD is used. .. function:: temp_umask(umask) |