Documentation/Source/eric5.DebugClients.Python.getpass.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.DebugClients.Python.getpass.html
--- a/Documentation/Source/eric5.DebugClients.Python.getpass.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.DebugClients.Python.getpass.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,13 +22,13 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.DebugClients.Python.getpass</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#117;&#116;&#105;&#108;&#105;&#116;&#105;&#101;&#115; &#116;&#111; &#103;&#101;&#116; &#97; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#97;&#110;&#100;/&#111;&#114; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#117;&#115;&#101;&#114; &#110;&#97;&#109;&#101;.
+Module implementing utilities to get a password and/or the current user name.
 </p><p>
-&#103;&#101;&#116;&#112;&#97;&#115;&#115;(&#112;&#114;&#111;&#109;&#112;&#116;) - &#112;&#114;&#111;&#109;&#112;&#116; &#102;&#111;&#114; &#97; &#112;&#97;&#115;&#115;w&#111;&#114;&#100;, w&#105;&#116;&#104; &#101;&#99;&#104;&#111; &#116;&#117;&#114;&#110;&#101;&#100; &#111;&#102;&#102;
-&#103;&#101;&#116;&#117;&#115;&#101;&#114;() - &#103;&#101;&#116; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#110;&#97;&#109;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#101;&#110;v&#105;&#114;&#111;&#110;&#109;&#101;&#110;&#116; &#111;&#114; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;
+getpass(prompt) - prompt for a password, with echo turned off
+getuser() - get the user name from the environment or password database
 </p><p>
-&#84;&#104;&#105;&#115; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#115; &#97; &#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#102;&#111;&#114; &#116;&#104;&#101; &#111;&#110;&#101; &#102;&#111;&#117;&#110;&#100; &#105;&#110; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#100;&#105;&#115;&#116;&#114;&#105;&#98;&#117;&#116;&#105;&#111;&#110;. &#73;&#116;
-&#105;&#115; &#116;&#111; &#112;&#114;&#111;v&#105;&#100;&#101; &#97; &#100;&#101;&#98;&#117;&#103;&#103;&#101;&#114; &#99;&#111;&#109;&#112;&#97;&#116;&#105;&#98;&#108;&#101; v&#97;&#114;&#105;&#97;&#110;&#116; &#111;&#102; &#116;&#104;&#101; &#97;.&#109;. &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;.
+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>
@@ -42,10 +42,10 @@
 <table>
 <tr>
 <td><a href="#getpass">getpass</a></td>
-<td>&#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#111;&#109;&#112;&#116; &#102;&#111;&#114; &#97; &#112;&#97;&#115;&#115;w&#111;&#114;&#100;, w&#105;&#116;&#104; &#101;&#99;&#104;&#111; &#116;&#117;&#114;&#110;&#101;&#100; &#111;&#102;&#102;.</td>
+<td>Function to prompt for a password, with echo turned off.</td>
 </tr><tr>
 <td><a href="#getuser">getuser</a></td>
-<td>&#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#101;&#110;v&#105;&#114;&#111;&#110;&#109;&#101;&#110;&#116; &#111;&#114; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td>
+<td>Function to get the username from the environment or password database.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -53,16 +53,16 @@
 <h2>getpass</h2>
 <b>getpass</b>(<i>prompt='Password: '</i>)
 <p>
-    &#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#111;&#109;&#112;&#116; &#102;&#111;&#114; &#97; &#112;&#97;&#115;&#115;w&#111;&#114;&#100;, w&#105;&#116;&#104; &#101;&#99;&#104;&#111; &#116;&#117;&#114;&#110;&#101;&#100; &#111;&#102;&#102;.
+    Function to prompt for a password, with echo turned off.
 </p><dl>
 <dt><i>prompt</i></dt>
 <dd>
-&#80;&#114;&#111;&#109;&#112;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+Prompt to be shown to the user (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#80;&#97;&#115;&#115;w&#111;&#114;&#100; &#101;&#110;&#116;&#101;&#114;&#101;&#100; &#98;y &#116;&#104;&#101; &#117;&#115;&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+Password entered by the user (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -71,14 +71,14 @@
 <h2>getuser</h2>
 <b>getuser</b>(<i></i>)
 <p>
-    &#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#101;&#110;v&#105;&#114;&#111;&#110;&#109;&#101;&#110;&#116; &#111;&#114; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.
+    Function to get the username from the environment or password database.
 </p><p>
-    &#70;&#105;&#114;&#115;&#116; &#116;&#114;y v&#97;&#114;&#105;&#111;&#117;&#115; &#101;&#110;v&#105;&#114;&#111;&#110;&#109;&#101;&#110;&#116; v&#97;&#114;&#105;&#97;&#98;&#108;&#101;&#115;, &#116;&#104;&#101;&#110; &#116;&#104;&#101; &#112;&#97;&#115;&#115;w&#111;&#114;&#100;
-    &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.  &#84;&#104;&#105;&#115; w&#111;&#114;&#107;&#115; &#111;&#110; &#87;&#105;&#110;&#100;&#111;w&#115; &#97;&#115; &#108;&#111;&#110;&#103; &#97;&#115; &#85;&#83;&#69;&#82;&#78;&#65;&#77;&#69; &#105;&#115; &#115;&#101;&#116;.
+    First try various environment variables, then the password
+    database.  This works on Windows as long as USERNAME is set.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+username (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial