src/eric7/Documentation/Source/eric7.DebugClients.Python.getpass.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8951
996bb6fea7dd
child 9236
db53a9efe7ef
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.getpass.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.DebugClients.Python.getpass</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.DebugClients.Python.getpass</h1>
+
+<p>
+Module implementing utilities to get a password and/or the current user name.
+</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>
+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>fallback_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>
+<td><a href="#getuser">getuser</a></td>
+<td>Function to get the username from the environment or password database.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="getpass" ID="getpass"></a>
+<h2>getpass</h2>
+<b>getpass</b>(<i>prompt='Password: ', stream=None</i>)
+
+<p>
+    Function to prompt for a password, with echo turned off.
+</p>
+<dl>
+
+<dt><i>prompt</i> (str)</dt>
+<dd>
+Prompt to be shown to the user
+</dd>
+<dt><i>stream</i> (file)</dt>
+<dd>
+input stream to read from (ignored)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+Password entered by the user
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<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>
+    First try various environment variables, then the password
+    database.  This works on Windows as long as USERNAME is set.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+username
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial