src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html

branch
eric7
changeset 11084
adbb5d1944ea
parent 10479
856476537696
equal deleted inserted replaced
11083:0ecbf7ebfc49 11084:adbb5d1944ea
11 Module implementing some common utility functions for the Mercurial package. 11 Module implementing some common utility functions for the Mercurial package.
12 </p> 12 </p>
13 13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 <table> 15 <table>
16 <tr><td>None</td></tr> 16 <tr><td>progressRe</td></tr>
17 <tr><td>versionRe</td></tr>
17 </table> 18 </table>
18 19
19 <h3>Classes</h3> 20 <h3>Classes</h3>
20 <table> 21 <table>
21 <tr><td>None</td></tr> 22 <tr><td>None</td></tr>
34 <tr> 35 <tr>
35 <td><a href="#hgVersion">hgVersion</a></td> 36 <td><a href="#hgVersion">hgVersion</a></td>
36 <td>Public method to determine the Mercurial version.</td> 37 <td>Public method to determine the Mercurial version.</td>
37 </tr> 38 </tr>
38 <tr> 39 <tr>
40 <td><a href="#isProgressInfo">isProgressInfo</a></td>
41 <td>Function to check, if the given line contains progress information.</td>
42 </tr>
43 <tr>
44 <td><a href="#parseProgressInfo">parseProgressInfo</a></td>
45 <td>Function to parse an output line containing progress information.</td>
46 </tr>
47 <tr>
39 <td><a href="#prepareProcess">prepareProcess</a></td> 48 <td><a href="#prepareProcess">prepareProcess</a></td>
40 <td>Function to prepare the given process.</td> 49 <td>Function to prepare the given process.</td>
41 </tr> 50 </tr>
42 </table> 51 </table>
43 52
115 </dd> 124 </dd>
116 </dl> 125 </dl>
117 <div align="right"><a href="#top">Up</a></div> 126 <div align="right"><a href="#top">Up</a></div>
118 <hr /> 127 <hr />
119 <hr /> 128 <hr />
129 <a NAME="isProgressInfo" ID="isProgressInfo"></a>
130 <h2>isProgressInfo</h2>
131 <b>isProgressInfo</b>(<i>line</i>)
132 <p>
133 Function to check, if the given line contains progress information.
134 </p>
135
136 <dl>
137
138 <dt><i>line</i> (str)</dt>
139 <dd>
140 output line to be checked
141 </dd>
142 </dl>
143 <dl>
144 <dt>Return:</dt>
145 <dd>
146 flag indicating a line containing progress information
147 </dd>
148 </dl>
149 <dl>
150 <dt>Return Type:</dt>
151 <dd>
152 bool
153 </dd>
154 </dl>
155 <div align="right"><a href="#top">Up</a></div>
156 <hr />
157 <hr />
158 <a NAME="parseProgressInfo" ID="parseProgressInfo"></a>
159 <h2>parseProgressInfo</h2>
160 <b>parseProgressInfo</b>(<i>progressLine</i>)
161 <p>
162 Function to parse an output line containing progress information.
163 </p>
164
165 <dl>
166
167 <dt><i>progressLine</i> (str)</dt>
168 <dd>
169 progress information line to be parsed
170 </dd>
171 </dl>
172 <dl>
173 <dt>Return:</dt>
174 <dd>
175 tuple containing the progress topic, current value, maximum value and
176 the completion estimate
177 </dd>
178 </dl>
179 <dl>
180 <dt>Return Type:</dt>
181 <dd>
182 tuple of (str, int, int, str)
183 </dd>
184 </dl>
185 <div align="right"><a href="#top">Up</a></div>
186 <hr />
187 <hr />
120 <a NAME="prepareProcess" ID="prepareProcess"></a> 188 <a NAME="prepareProcess" ID="prepareProcess"></a>
121 <h2>prepareProcess</h2> 189 <h2>prepareProcess</h2>
122 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) 190 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>)
123 <p> 191 <p>
124 Function to prepare the given process. 192 Function to prepare the given process.

eric ide

mercurial