src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupCfgUtilities.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9201
2f1ccadee231
child 9211
99eb1cb030a5
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.WizardPlugins.SetupWizard.SetupCfgUtilities</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.WizardPlugins.SetupWizard.SetupCfgUtilities</h1>
10
11 <p>
12 Module implementing some utility functions for setup.cfg creation.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22 <tr><td>None</td></tr>
23 </table>
24 <h3>Functions</h3>
25
26 <table>
27
28 <tr>
29 <td><a href="#_bool2string">_bool2string</a></td>
30 <td>Function to convert a bool value to a setup.cfg string.</td>
31 </tr>
32 <tr>
33 <td><a href="#_dict2list">_dict2list</a></td>
34 <td>Function to convert a dict value to a setup.cfg list string.</td>
35 </tr>
36 <tr>
37 <td><a href="#_dict2string">_dict2string</a></td>
38 <td>Function to convert a dict value to a setup.cfg string.</td>
39 </tr>
40 <tr>
41 <td><a href="#_list2string">_list2string</a></td>
42 <td>Function to convert a list value to a setup.cfg string.</td>
43 </tr>
44 <tr>
45 <td><a href="#toString">toString</a></td>
46 <td>Function to convert a value to a setup.cfg string</td>
47 </tr>
48 </table>
49 <hr />
50 <hr />
51 <a NAME="_bool2string" ID="_bool2string"></a>
52 <h2>_bool2string</h2>
53 <b>_bool2string</b>(<i>value</i>)
54
55 <p>
56 Function to convert a bool value to a setup.cfg string.
57 </p>
58 <dl>
59
60 <dt><i>value</i> (bool)</dt>
61 <dd>
62 bool value to be converted
63 </dd>
64 </dl>
65 <dl>
66 <dt>Return:</dt>
67 <dd>
68 setup.cfg string
69 </dd>
70 </dl>
71 <dl>
72 <dt>Return Type:</dt>
73 <dd>
74 str
75 </dd>
76 </dl>
77 <div align="right"><a href="#top">Up</a></div>
78 <hr />
79 <hr />
80 <a NAME="_dict2list" ID="_dict2list"></a>
81 <h2>_dict2list</h2>
82 <b>_dict2list</b>(<i>value</i>)
83
84 <p>
85 Function to convert a dict value to a setup.cfg list string.
86 </p>
87 <dl>
88
89 <dt><i>value</i> (dict)</dt>
90 <dd>
91 dict value to be converted
92 </dd>
93 </dl>
94 <dl>
95 <dt>Yield:</dt>
96 <dd>
97 setup.cfg string
98 </dd>
99 </dl>
100 <dl>
101 <dt>Yield Type:</dt>
102 <dd>
103 str
104 </dd>
105 </dl>
106 <div align="right"><a href="#top">Up</a></div>
107 <hr />
108 <hr />
109 <a NAME="_dict2string" ID="_dict2string"></a>
110 <h2>_dict2string</h2>
111 <b>_dict2string</b>(<i>value</i>)
112
113 <p>
114 Function to convert a dict value to a setup.cfg string.
115 </p>
116 <dl>
117
118 <dt><i>value</i> (dict)</dt>
119 <dd>
120 dict value to be converted
121 </dd>
122 </dl>
123 <dl>
124 <dt>Return:</dt>
125 <dd>
126 setup.cfg string
127 </dd>
128 </dl>
129 <dl>
130 <dt>Return Type:</dt>
131 <dd>
132 str
133 </dd>
134 </dl>
135 <div align="right"><a href="#top">Up</a></div>
136 <hr />
137 <hr />
138 <a NAME="_list2string" ID="_list2string"></a>
139 <h2>_list2string</h2>
140 <b>_list2string</b>(<i>value</i>)
141
142 <p>
143 Function to convert a list value to a setup.cfg string.
144 </p>
145 <dl>
146
147 <dt><i>value</i> (list)</dt>
148 <dd>
149 list value to be converted
150 </dd>
151 </dl>
152 <dl>
153 <dt>Return:</dt>
154 <dd>
155 setup.cfg string
156 </dd>
157 </dl>
158 <dl>
159 <dt>Return Type:</dt>
160 <dd>
161 str
162 </dd>
163 </dl>
164 <div align="right"><a href="#top">Up</a></div>
165 <hr />
166 <hr />
167 <a NAME="toString" ID="toString"></a>
168 <h2>toString</h2>
169 <b>toString</b>(<i>value</i>)
170
171 <p>
172 Function to convert a value to a setup.cfg string
173 </p>
174 <dl>
175
176 <dt><i>value</i> (bool, list, set, tuple or dict)</dt>
177 <dd>
178 value to be converted
179 </dd>
180 </dl>
181 <dl>
182 <dt>Return:</dt>
183 <dd>
184 setup.cfg string
185 </dd>
186 </dl>
187 <dl>
188 <dt>Return Type:</dt>
189 <dd>
190 str
191 </dd>
192 </dl>
193 <div align="right"><a href="#top">Up</a></div>
194 <hr />
195 </body></html>

eric ide

mercurial