summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libgetpass.tex
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2006-03-31 18:42:16 (GMT)
committerGeorg Brandl <georg@python.org>2006-03-31 18:42:16 (GMT)
commit338ef7d2bd3c2ef507d7ef1edce42492dae28db0 (patch)
tree04479e4ab621b0ad192b1436cc3f7a8b94584c93 /Doc/lib/libgetpass.tex
parent22ec80bc4f3e66990981ca57b66b38873e2711df (diff)
downloadcpython-338ef7d2bd3c2ef507d7ef1edce42492dae28db0.zip
cpython-338ef7d2bd3c2ef507d7ef1edce42492dae28db0.tar.gz
cpython-338ef7d2bd3c2ef507d7ef1edce42492dae28db0.tar.bz2
Bug #1445068: getpass.getpass() can now be given an explicit stream
argument to specify where to write the prompt.
Diffstat (limited to 'Doc/lib/libgetpass.tex')
-rw-r--r--Doc/lib/libgetpass.tex8
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/lib/libgetpass.tex b/Doc/lib/libgetpass.tex
index 28bfe8f..1d177d3 100644
--- a/Doc/lib/libgetpass.tex
+++ b/Doc/lib/libgetpass.tex
@@ -11,11 +11,15 @@
The \module{getpass} module provides two functions:
-\begin{funcdesc}{getpass}{\optional{prompt}}
+\begin{funcdesc}{getpass}{\optional{prompt\optional{, stream}}}
Prompt the user for a password without echoing. The user is
prompted using the string \var{prompt}, which defaults to
- \code{'Password: '}.
+ \code{'Password: '}. On \UNIX, the prompt is written to the
+ file-like object \var{stream}, which defaults to
+ \code{sys.stdout} (this argument is ignored on Windows).
+
Availability: Macintosh, \UNIX, Windows.
+ \versionadded[The \var{stream} parameter]{2.5}
\end{funcdesc}