Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html
eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7555
- 24f1bb4c78a3
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.DebugClients.Python.getpass</h1> | 23 <h1>eric6.DebugClients.Python.getpass</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing utilities to get a password and/or the current user name. | 26 Module implementing utilities to get a password and/or the current user name. |
| 25 </p><p> | 27 </p> |
| 28 <p> | |
| 26 getpass(prompt) - prompt for a password, with echo turned off | 29 getpass(prompt) - prompt for a password, with echo turned off |
| 27 getuser() - get the user name from the environment or password database | 30 getuser() - get the user name from the environment or password database |
| 28 </p><p> | 31 </p> |
| 32 <p> | |
| 29 This module is a replacement for the one found in the Python distribution. It | 33 This module is a replacement for the one found in the Python distribution. It |
| 30 is to provide a debugger compatible variant of the a.m. functions. | 34 is to provide a debugger compatible variant of the a.m. functions. |
| 31 </p> | 35 </p> |
| 32 <h3>Global Attributes</h3> | 36 <h3>Global Attributes</h3> |
| 37 | |
| 33 <table> | 38 <table> |
| 34 <tr><td>__all__</td></tr><tr><td>default_getpass</td></tr><tr><td>unix_getpass</td></tr><tr><td>win_getpass</td></tr> | 39 <tr><td>__all__</td></tr><tr><td>default_getpass</td></tr><tr><td>unix_getpass</td></tr><tr><td>win_getpass</td></tr> |
| 35 </table> | 40 </table> |
| 36 <h3>Classes</h3> | 41 <h3>Classes</h3> |
| 42 | |
| 37 <table> | 43 <table> |
| 38 <tr><td>None</td></tr> | 44 <tr><td>None</td></tr> |
| 39 </table> | 45 </table> |
| 40 <h3>Functions</h3> | 46 <h3>Functions</h3> |
| 47 | |
| 41 <table> | 48 <table> |
| 49 | |
| 42 <tr> | 50 <tr> |
| 43 <td><a href="#getpass">getpass</a></td> | 51 <td><a href="#getpass">getpass</a></td> |
| 44 <td>Function to prompt for a password, with echo turned off.</td> | 52 <td>Function to prompt for a password, with echo turned off.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#getuser">getuser</a></td> | 55 <td><a href="#getuser">getuser</a></td> |
| 47 <td>Function to get the username from the environment or password database.</td> | 56 <td>Function to get the username from the environment or password database.</td> |
| 48 </tr> | 57 </tr> |
| 49 </table> | 58 </table> |
| 50 <hr /><hr /> | 59 <hr /> |
| 60 <hr /> | |
| 51 <a NAME="getpass" ID="getpass"></a> | 61 <a NAME="getpass" ID="getpass"></a> |
| 52 <h2>getpass</h2> | 62 <h2>getpass</h2> |
| 53 <b>getpass</b>(<i>prompt='Password: '</i>) | 63 <b>getpass</b>(<i>prompt='Password: '</i>) |
| 64 | |
| 54 <p> | 65 <p> |
| 55 Function to prompt for a password, with echo turned off. | 66 Function to prompt for a password, with echo turned off. |
| 56 </p><dl> | 67 </p> |
| 68 <dl> | |
| 69 | |
| 57 <dt><i>prompt</i></dt> | 70 <dt><i>prompt</i></dt> |
| 58 <dd> | 71 <dd> |
| 59 Prompt to be shown to the user (string) | 72 Prompt to be shown to the user (string) |
| 60 </dd> | 73 </dd> |
| 61 </dl><dl> | 74 </dl> |
| 75 <dl> | |
| 62 <dt>Returns:</dt> | 76 <dt>Returns:</dt> |
| 63 <dd> | 77 <dd> |
| 64 Password entered by the user (string) | 78 Password entered by the user (string) |
| 65 </dd> | 79 </dd> |
| 66 </dl> | 80 </dl> |
| 67 <div align="right"><a href="#top">Up</a></div> | 81 <div align="right"><a href="#top">Up</a></div> |
| 68 <hr /><hr /> | 82 <hr /> |
| 83 <hr /> | |
| 69 <a NAME="getuser" ID="getuser"></a> | 84 <a NAME="getuser" ID="getuser"></a> |
| 70 <h2>getuser</h2> | 85 <h2>getuser</h2> |
| 71 <b>getuser</b>(<i></i>) | 86 <b>getuser</b>(<i></i>) |
| 87 | |
| 72 <p> | 88 <p> |
| 73 Function to get the username from the environment or password database. | 89 Function to get the username from the environment or password database. |
| 74 </p><p> | 90 </p> |
| 91 <p> | |
| 75 First try various environment variables, then the password | 92 First try various environment variables, then the password |
| 76 database. This works on Windows as long as USERNAME is set. | 93 database. This works on Windows as long as USERNAME is set. |
| 77 </p><dl> | 94 </p> |
| 95 <dl> | |
| 78 <dt>Returns:</dt> | 96 <dt>Returns:</dt> |
| 79 <dd> | 97 <dd> |
| 80 username (string) | 98 username (string) |
| 81 </dd> | 99 </dd> |
| 82 </dl> | 100 </dl> |
