|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.DebugClients.Python.getpass</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.DebugClients.Python.getpass</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing utilities to get a password and/or the current user name. |
|
27 </p> |
|
28 <p> |
|
29 getpass(prompt) - prompt for a password, with echo turned off |
|
30 getuser() - get the user name from the environment or password database |
|
31 </p> |
|
32 <p> |
|
33 This module is a replacement for the one found in the Python distribution. It |
|
34 is to provide a debugger compatible variant of the a.m. functions. |
|
35 </p> |
|
36 <h3>Global Attributes</h3> |
|
37 |
|
38 <table> |
|
39 <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> |
|
40 </table> |
|
41 <h3>Classes</h3> |
|
42 |
|
43 <table> |
|
44 <tr><td>None</td></tr> |
|
45 </table> |
|
46 <h3>Functions</h3> |
|
47 |
|
48 <table> |
|
49 |
|
50 <tr> |
|
51 <td><a href="#getpass">getpass</a></td> |
|
52 <td>Function to prompt for a password, with echo turned off.</td> |
|
53 </tr> |
|
54 <tr> |
|
55 <td><a href="#getuser">getuser</a></td> |
|
56 <td>Function to get the username from the environment or password database.</td> |
|
57 </tr> |
|
58 </table> |
|
59 <hr /> |
|
60 <hr /> |
|
61 <a NAME="getpass" ID="getpass"></a> |
|
62 <h2>getpass</h2> |
|
63 <b>getpass</b>(<i>prompt='Password: '</i>) |
|
64 |
|
65 <p> |
|
66 Function to prompt for a password, with echo turned off. |
|
67 </p> |
|
68 <dl> |
|
69 |
|
70 <dt><i>prompt</i> (str)</dt> |
|
71 <dd> |
|
72 Prompt to be shown to the user |
|
73 </dd> |
|
74 </dl> |
|
75 <dl> |
|
76 <dt>Return:</dt> |
|
77 <dd> |
|
78 Password entered by the user |
|
79 </dd> |
|
80 </dl> |
|
81 <dl> |
|
82 <dt>Return Type:</dt> |
|
83 <dd> |
|
84 str |
|
85 </dd> |
|
86 </dl> |
|
87 <div align="right"><a href="#top">Up</a></div> |
|
88 <hr /> |
|
89 <hr /> |
|
90 <a NAME="getuser" ID="getuser"></a> |
|
91 <h2>getuser</h2> |
|
92 <b>getuser</b>(<i></i>) |
|
93 |
|
94 <p> |
|
95 Function to get the username from the environment or password database. |
|
96 </p> |
|
97 <p> |
|
98 First try various environment variables, then the password |
|
99 database. This works on Windows as long as USERNAME is set. |
|
100 </p> |
|
101 <dl> |
|
102 <dt>Return:</dt> |
|
103 <dd> |
|
104 username |
|
105 </dd> |
|
106 </dl> |
|
107 <dl> |
|
108 <dt>Return Type:</dt> |
|
109 <dd> |
|
110 str |
|
111 </dd> |
|
112 </dl> |
|
113 <div align="right"><a href="#top">Up</a></div> |
|
114 <hr /> |
|
115 </body></html> |