src/eric7/Documentation/Source/eric7.CodeFormatting.BlackUtilities.html

<!DOCTYPE html>
<html><head>
<title>eric7.CodeFormatting.BlackUtilities</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CodeFormatting.BlackUtilities</h1>

<p>
Module implementing some utility functions for the Black based code formatting.
</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="#aboutBlack">aboutBlack</a></td>
<td>Slot to show an 'About Black' dialog.</td>
</tr>
<tr>
<td><a href="#compileRegExp">compileRegExp</a></td>
<td>Function to compile a given regular expression.</td>
</tr>
<tr>
<td><a href="#getDefaultConfiguration">getDefaultConfiguration</a></td>
<td>Function to generate a default set of configuration parameters.</td>
</tr>
<tr>
<td><a href="#validateRegExp">validateRegExp</a></td>
<td>Function to validate a given regular expression.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="aboutBlack" ID="aboutBlack"></a>
<h2>aboutBlack</h2>
<b>aboutBlack</b>(<i></i>)

<p>
    Slot to show an 'About Black' dialog.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="compileRegExp" ID="compileRegExp"></a>
<h2>compileRegExp</h2>
<b>compileRegExp</b>(<i>regexp</i>)

<p>
    Function to compile a given regular expression.
</p>
<dl>

<dt><i>regexp</i> (str)</dt>
<dd>
regular expression to be compiled
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
compiled regular expression object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
re.Pattern
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getDefaultConfiguration" ID="getDefaultConfiguration"></a>
<h2>getDefaultConfiguration</h2>
<b>getDefaultConfiguration</b>(<i></i>)

<p>
    Function to generate a default set of configuration parameters.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing the default parameters
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="validateRegExp" ID="validateRegExp"></a>
<h2>validateRegExp</h2>
<b>validateRegExp</b>(<i>regexp</i>)

<p>
    Function to validate a given regular expression.
</p>
<dl>

<dt><i>regexp</i> (str)</dt>
<dd>
regular expression to be validated
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple containing a flag indicating validity and an error message
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>