diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html --- a/eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,63 +18,81 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.DebugClients.Python.getpass</h1> + <p> Module implementing utilities to get a password and/or the current user name. -</p><p> +</p> +<p> getpass(prompt) - prompt for a password, with echo turned off getuser() - get the user name from the environment or password database -</p><p> +</p> +<p> This module is a replacement for the one found in the Python distribution. It is to provide a debugger compatible variant of the a.m. functions. </p> <h3>Global Attributes</h3> + <table> <tr><td>__all__</td></tr><tr><td>default_getpass</td></tr><tr><td>unix_getpass</td></tr><tr><td>win_getpass</td></tr> </table> <h3>Classes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#getpass">getpass</a></td> <td>Function to prompt for a password, with echo turned off.</td> -</tr><tr> +</tr> +<tr> <td><a href="#getuser">getuser</a></td> <td>Function to get the username from the environment or password database.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="getpass" ID="getpass"></a> <h2>getpass</h2> <b>getpass</b>(<i>prompt='Password: '</i>) + <p> Function to prompt for a password, with echo turned off. -</p><dl> +</p> +<dl> + <dt><i>prompt</i></dt> <dd> Prompt to be shown to the user (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> Password entered by the user (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="getuser" ID="getuser"></a> <h2>getuser</h2> <b>getuser</b>(<i></i>) + <p> Function to get the username from the environment or password database. -</p><p> +</p> +<p> First try various environment variables, then the password database. This works on Windows as long as USERNAME is set. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> username (string)