Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerCoverageInterface.html
src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerCoverageInterface.html
- branch
- eric7
- changeset 10784
- 521fd465b048
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.RemoteServerInterface.EricServerCoverageInterface</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.RemoteServerInterface.EricServerCoverageInterface</h1> | |
| 10 <p> | |
| 11 Module implementing the code coverage interface to the eric-ide server. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#EricServerCoverageError">EricServerCoverageError</a></td> | |
| 23 <td>Class defining a substitute exception for coverage errors of the server.</td> | |
| 24 </tr> | |
| 25 <tr> | |
| 26 <td><a href="#EricServerCoverageInterface">EricServerCoverageInterface</a></td> | |
| 27 <td>Class implementing the code coverage interface to the eric-ide server.</td> | |
| 28 </tr> | |
| 29 </table> | |
| 30 | |
| 31 <h3>Functions</h3> | |
| 32 <table> | |
| 33 <tr><td>None</td></tr> | |
| 34 </table> | |
| 35 | |
| 36 <hr /> | |
| 37 <hr /> | |
| 38 <a NAME="EricServerCoverageError" ID="EricServerCoverageError"></a> | |
| 39 <h2>EricServerCoverageError</h2> | |
| 40 <p> | |
| 41 Class defining a substitute exception for coverage errors of the server. | |
| 42 </p> | |
| 43 | |
| 44 <h3>Derived from</h3> | |
| 45 Exception | |
| 46 <h3>Class Attributes</h3> | |
| 47 <table> | |
| 48 <tr><td>None</td></tr> | |
| 49 </table> | |
| 50 | |
| 51 <h3>Class Methods</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 | |
| 56 <h3>Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 | |
| 61 <h3>Static Methods</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 | |
| 66 | |
| 67 <div align="right"><a href="#top">Up</a></div> | |
| 68 <hr /> | |
| 69 <hr /> | |
| 70 <a NAME="EricServerCoverageInterface" ID="EricServerCoverageInterface"></a> | |
| 71 <h2>EricServerCoverageInterface</h2> | |
| 72 <p> | |
| 73 Class implementing the code coverage interface to the eric-ide server. | |
| 74 </p> | |
| 75 | |
| 76 <h3>Derived from</h3> | |
| 77 QObject | |
| 78 <h3>Class Attributes</h3> | |
| 79 <table> | |
| 80 <tr><td>None</td></tr> | |
| 81 </table> | |
| 82 | |
| 83 <h3>Class Methods</h3> | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 | |
| 88 <h3>Methods</h3> | |
| 89 <table> | |
| 90 <tr> | |
| 91 <td><a href="#EricServerCoverageInterface.__init__">EricServerCoverageInterface</a></td> | |
| 92 <td>Constructor</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#EricServerCoverageInterface.analyzeDirectory">analyzeDirectory</a></td> | |
| 96 <td>Public method to analyze the code coverage of a directory.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#EricServerCoverageInterface.analyzeFile">analyzeFile</a></td> | |
| 100 <td>Public method to analyze the code coverage of one file.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#EricServerCoverageInterface.analyzeFiles">analyzeFiles</a></td> | |
| 104 <td>Public method to analyze the code coverage of a list of files.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#EricServerCoverageInterface.callback">callback</a></td> | |
| 108 <td>Function to handle the server reply</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#EricServerCoverageInterface.loadCoverageData">loadCoverageData</a></td> | |
| 112 <td>Public method to tell the server to load the coverage data for a later analysis.</td> | |
| 113 </tr> | |
| 114 </table> | |
| 115 | |
| 116 <h3>Static Methods</h3> | |
| 117 <table> | |
| 118 <tr><td>None</td></tr> | |
| 119 </table> | |
| 120 | |
| 121 | |
| 122 <a NAME="EricServerCoverageInterface.__init__" ID="EricServerCoverageInterface.__init__"></a> | |
| 123 <h4>EricServerCoverageInterface (Constructor)</h4> | |
| 124 <b>EricServerCoverageInterface</b>(<i>serverInterface</i>) | |
| 125 <p> | |
| 126 Constructor | |
| 127 </p> | |
| 128 | |
| 129 <dl> | |
| 130 | |
| 131 <dt><i>serverInterface</i> (EricServerInterface)</dt> | |
| 132 <dd> | |
| 133 reference to the eric-ide server interface | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="EricServerCoverageInterface.analyzeDirectory" ID="EricServerCoverageInterface.analyzeDirectory"></a> | |
| 137 <h4>EricServerCoverageInterface.analyzeDirectory</h4> | |
| 138 <b>analyzeDirectory</b>(<i>directory</i>) | |
| 139 <p> | |
| 140 Public method to analyze the code coverage of a directory. | |
| 141 </p> | |
| 142 | |
| 143 <dl> | |
| 144 | |
| 145 <dt><i>directory</i> (str)</dt> | |
| 146 <dd> | |
| 147 directory name to be analyzed | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return:</dt> | |
| 152 <dd> | |
| 153 lists containing coverage results as reported by Coverage.analysis2() | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <dl> | |
| 157 <dt>Return Type:</dt> | |
| 158 <dd> | |
| 159 list of [list of [str, list of int, list of int, list of int, str]] | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 | |
| 164 <dt>Raises <b>EricServerCoverageError</b>:</dt> | |
| 165 <dd> | |
| 166 raised to indicate a coverage exception | |
| 167 </dd> | |
| 168 <dt>Raises <b>OSError</b>:</dt> | |
| 169 <dd> | |
| 170 raised to indicate that server is not connected | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="EricServerCoverageInterface.analyzeFile" ID="EricServerCoverageInterface.analyzeFile"></a> | |
| 174 <h4>EricServerCoverageInterface.analyzeFile</h4> | |
| 175 <b>analyzeFile</b>(<i>filename</i>) | |
| 176 <p> | |
| 177 Public method to analyze the code coverage of one file. | |
| 178 </p> | |
| 179 | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>filename</i> (str)</dt> | |
| 183 <dd> | |
| 184 name of the file to be analyzed | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <dl> | |
| 188 <dt>Return:</dt> | |
| 189 <dd> | |
| 190 list containing coverage result as reported by Coverage.analysis2() | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <dl> | |
| 194 <dt>Return Type:</dt> | |
| 195 <dd> | |
| 196 list of [str, list of int, list of int, list of int, str] | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <dl> | |
| 200 | |
| 201 <dt>Raises <b>EricServerCoverageError</b>:</dt> | |
| 202 <dd> | |
| 203 raised to indicate a coverage exception | |
| 204 </dd> | |
| 205 <dt>Raises <b>OSError</b>:</dt> | |
| 206 <dd> | |
| 207 raised to indicate that server is not connected | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="EricServerCoverageInterface.analyzeFiles" ID="EricServerCoverageInterface.analyzeFiles"></a> | |
| 211 <h4>EricServerCoverageInterface.analyzeFiles</h4> | |
| 212 <b>analyzeFiles</b>(<i>filenames</i>) | |
| 213 <p> | |
| 214 Public method to analyze the code coverage of a list of files. | |
| 215 </p> | |
| 216 | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>filenames</i> (str)</dt> | |
| 220 <dd> | |
| 221 list of file names to be analyzed | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <dl> | |
| 225 <dt>Return:</dt> | |
| 226 <dd> | |
| 227 lists containing coverage results as reported by Coverage.analysis2() | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <dl> | |
| 231 <dt>Return Type:</dt> | |
| 232 <dd> | |
| 233 list of [list of [str, list of int, list of int, list of int, str]] | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <dl> | |
| 237 | |
| 238 <dt>Raises <b>EricServerCoverageError</b>:</dt> | |
| 239 <dd> | |
| 240 raised to indicate a coverage exception | |
| 241 </dd> | |
| 242 <dt>Raises <b>OSError</b>:</dt> | |
| 243 <dd> | |
| 244 raised to indicate that server is not connected | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <a NAME="EricServerCoverageInterface.callback" ID="EricServerCoverageInterface.callback"></a> | |
| 248 <h4>EricServerCoverageInterface.callback</h4> | |
| 249 <b>callback</b>(<i>params</i>) | |
| 250 <p> | |
| 251 Function to handle the server reply | |
| 252 </p> | |
| 253 | |
| 254 <dl> | |
| 255 | |
| 256 <dt><i>reply</i> (str)</dt> | |
| 257 <dd> | |
| 258 name of the server reply | |
| 259 </dd> | |
| 260 <dt><i>params</i> (dict)</dt> | |
| 261 <dd> | |
| 262 dictionary containing the reply data | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="EricServerCoverageInterface.loadCoverageData" ID="EricServerCoverageInterface.loadCoverageData"></a> | |
| 266 <h4>EricServerCoverageInterface.loadCoverageData</h4> | |
| 267 <b>loadCoverageData</b>(<i>dataFile, excludePattern=""</i>) | |
| 268 <p> | |
| 269 Public method to tell the server to load the coverage data for a later analysis. | |
| 270 </p> | |
| 271 | |
| 272 <dl> | |
| 273 | |
| 274 <dt><i>dataFile</i> (str)</dt> | |
| 275 <dd> | |
| 276 name of the data file to be loaded | |
| 277 </dd> | |
| 278 <dt><i>excludePattern</i> (str (optional))</dt> | |
| 279 <dd> | |
| 280 regular expression determining files to be excluded | |
| 281 (defaults to "") | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <dl> | |
| 285 <dt>Return:</dt> | |
| 286 <dd> | |
| 287 tuple containing a success flag and an error message | |
| 288 </dd> | |
| 289 </dl> | |
| 290 <dl> | |
| 291 <dt>Return Type:</dt> | |
| 292 <dd> | |
| 293 tuple of (bool, str) | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /> | |
| 298 </body></html> |
