Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.CodeFormatting.BlackUtilities.html
src/eric7/Documentation/Source/eric7.CodeFormatting.BlackUtilities.html
- branch
- eric7
- changeset 9215
- 30d7f7fd2b4a
- child 9436
- 731d146193e2
equal
deleted
inserted
replaced
| 9214:bd28e56047d7 | 9215:30d7f7fd2b4a |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.CodeFormatting.BlackUtilities</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.CodeFormatting.BlackUtilities</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing some utility functions for the Black based code formatting. | |
| 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="#compileRegExp">compileRegExp</a></td> | |
| 30 <td>Function to compile a given regular expression.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#getDefaultConfiguration">getDefaultConfiguration</a></td> | |
| 34 <td>Function to generate a default set of configuration parameters.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#validateRegExp">validateRegExp</a></td> | |
| 38 <td>Function to validate a given regular expression.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="compileRegExp" ID="compileRegExp"></a> | |
| 44 <h2>compileRegExp</h2> | |
| 45 <b>compileRegExp</b>(<i>regexp</i>) | |
| 46 | |
| 47 <p> | |
| 48 Function to compile a given regular expression. | |
| 49 </p> | |
| 50 <dl> | |
| 51 | |
| 52 <dt><i>regexp</i> (str)</dt> | |
| 53 <dd> | |
| 54 regular expression to be compiled | |
| 55 </dd> | |
| 56 </dl> | |
| 57 <dl> | |
| 58 <dt>Return:</dt> | |
| 59 <dd> | |
| 60 compiled regular expression object | |
| 61 </dd> | |
| 62 </dl> | |
| 63 <dl> | |
| 64 <dt>Return Type:</dt> | |
| 65 <dd> | |
| 66 re.Pattern | |
| 67 </dd> | |
| 68 </dl> | |
| 69 <div align="right"><a href="#top">Up</a></div> | |
| 70 <hr /> | |
| 71 <hr /> | |
| 72 <a NAME="getDefaultConfiguration" ID="getDefaultConfiguration"></a> | |
| 73 <h2>getDefaultConfiguration</h2> | |
| 74 <b>getDefaultConfiguration</b>(<i></i>) | |
| 75 | |
| 76 <p> | |
| 77 Function to generate a default set of configuration parameters. | |
| 78 </p> | |
| 79 <dl> | |
| 80 <dt>Return:</dt> | |
| 81 <dd> | |
| 82 dictionary containing the default parameters | |
| 83 </dd> | |
| 84 </dl> | |
| 85 <dl> | |
| 86 <dt>Return Type:</dt> | |
| 87 <dd> | |
| 88 dict | |
| 89 </dd> | |
| 90 </dl> | |
| 91 <div align="right"><a href="#top">Up</a></div> | |
| 92 <hr /> | |
| 93 <hr /> | |
| 94 <a NAME="validateRegExp" ID="validateRegExp"></a> | |
| 95 <h2>validateRegExp</h2> | |
| 96 <b>validateRegExp</b>(<i>regexp</i>) | |
| 97 | |
| 98 <p> | |
| 99 Function to validate a given regular expression. | |
| 100 </p> | |
| 101 <dl> | |
| 102 | |
| 103 <dt><i>regexp</i> (str)</dt> | |
| 104 <dd> | |
| 105 regular expression to be validated | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <dl> | |
| 109 <dt>Return:</dt> | |
| 110 <dd> | |
| 111 tuple containing a flag indicating validity and an error message | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <dl> | |
| 115 <dt>Return Type:</dt> | |
| 116 <dd> | |
| 117 tuple of (bool, str) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <div align="right"><a href="#top">Up</a></div> | |
| 121 <hr /> | |
| 122 </body></html> |
