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

branch
eric7
changeset 9201
2f1ccadee231
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupCfgUtilities.html	Sat Jul 02 18:53:56 2022 +0200
@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.WizardPlugins.SetupWizard.SetupCfgUtilities</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.WizardPlugins.SetupWizard.SetupCfgUtilities</h1>
+
+<p>
+Module implementing some utility functions for setup.cfg creation.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#_bool2string">_bool2string</a></td>
+<td>Function to convert a bool value to a setup.cfg string.</td>
+</tr>
+<tr>
+<td><a href="#_dict2list">_dict2list</a></td>
+<td>Function to convert a dict value to a setup.cfg list string.</td>
+</tr>
+<tr>
+<td><a href="#_dict2string">_dict2string</a></td>
+<td>Function to convert a dict value to a setup.cfg string.</td>
+</tr>
+<tr>
+<td><a href="#_list2string">_list2string</a></td>
+<td>Function to convert a list value to a setup.cfg string.</td>
+</tr>
+<tr>
+<td><a href="#toString">toString</a></td>
+<td>Function to convert a value to a setup.cfg string</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="_bool2string" ID="_bool2string"></a>
+<h2>_bool2string</h2>
+<b>_bool2string</b>(<i>value</i>)
+
+<p>
+    Function to convert a bool value to a setup.cfg string.
+</p>
+<dl>
+
+<dt><i>value</i> (bool)</dt>
+<dd>
+bool value to be converted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+setup.cfg string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_dict2list" ID="_dict2list"></a>
+<h2>_dict2list</h2>
+<b>_dict2list</b>(<i>value</i>)
+
+<p>
+    Function to convert a dict value to a setup.cfg list string.
+</p>
+<dl>
+
+<dt><i>value</i> (dict)</dt>
+<dd>
+dict value to be converted
+</dd>
+</dl>
+<dl>
+<dt>Yield:</dt>
+<dd>
+setup.cfg string
+</dd>
+</dl>
+<dl>
+<dt>Yield Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_dict2string" ID="_dict2string"></a>
+<h2>_dict2string</h2>
+<b>_dict2string</b>(<i>value</i>)
+
+<p>
+    Function to convert a dict value to a setup.cfg string.
+</p>
+<dl>
+
+<dt><i>value</i> (dict)</dt>
+<dd>
+dict value to be converted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+setup.cfg string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_list2string" ID="_list2string"></a>
+<h2>_list2string</h2>
+<b>_list2string</b>(<i>value</i>)
+
+<p>
+    Function to convert a list value to a setup.cfg string.
+</p>
+<dl>
+
+<dt><i>value</i> (list)</dt>
+<dd>
+list value to be converted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+setup.cfg string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="toString" ID="toString"></a>
+<h2>toString</h2>
+<b>toString</b>(<i>value</i>)
+
+<p>
+    Function to convert a value to a setup.cfg string
+</p>
+<dl>
+
+<dt><i>value</i> (bool, list, set, tuple or dict)</dt>
+<dd>
+value to be converted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+setup.cfg string
+</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