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

branch
eric7
changeset 11084
adbb5d1944ea
parent 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html	Wed Dec 04 11:29:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html	Wed Dec 04 11:30:17 2024 +0100
@@ -13,7 +13,8 @@
 
 <h3>Global Attributes</h3>
 <table>
-<tr><td>None</td></tr>
+<tr><td>progressRe</td></tr>
+<tr><td>versionRe</td></tr>
 </table>
 
 <h3>Classes</h3>
@@ -36,6 +37,14 @@
 <td>Public method to determine the Mercurial version.</td>
 </tr>
 <tr>
+<td><a href="#isProgressInfo">isProgressInfo</a></td>
+<td>Function to check, if the given line contains progress information.</td>
+</tr>
+<tr>
+<td><a href="#parseProgressInfo">parseProgressInfo</a></td>
+<td>Function to parse an output line containing progress information.</td>
+</tr>
+<tr>
 <td><a href="#prepareProcess">prepareProcess</a></td>
 <td>Function to prepare the given process.</td>
 </tr>
@@ -117,6 +126,65 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="isProgressInfo" ID="isProgressInfo"></a>
+<h2>isProgressInfo</h2>
+<b>isProgressInfo</b>(<i>line</i>)
+<p>
+    Function to check, if the given line contains progress information.
+</p>
+
+<dl>
+
+<dt><i>line</i> (str)</dt>
+<dd>
+output line to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a line containing progress information
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="parseProgressInfo" ID="parseProgressInfo"></a>
+<h2>parseProgressInfo</h2>
+<b>parseProgressInfo</b>(<i>progressLine</i>)
+<p>
+    Function to parse an output line containing progress information.
+</p>
+
+<dl>
+
+<dt><i>progressLine</i> (str)</dt>
+<dd>
+progress information line to be parsed
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the progress topic, current value, maximum value and
+        the completion estimate
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int, int, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="prepareProcess" ID="prepareProcess"></a>
 <h2>prepareProcess</h2>
 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>)

eric ide

mercurial