Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html

changeset 7452
32b5c4a9fb17
parent 7273
391d6b7b1eff
child 7986
2971d5d19951
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html	Tue Mar 10 19:32:25 2020 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html	Tue Mar 10 19:32:39 2020 +0100
@@ -148,21 +148,21 @@
 </p>
 <dl>
 
-<dt><i>repoPath</i></dt>
+<dt><i>repoPath</i> (str)</dt>
 <dd>
-root directory of the repository (string)
+root directory of the repository
 </dd>
-<dt><i>encoding</i></dt>
+<dt><i>encoding</i> (str)</dt>
 <dd>
-encoding to be used by the command server (string)
+encoding to be used by the command server
 </dd>
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Hg)</dt>
 <dd>
-reference to the VCS object (Hg)
+reference to the VCS object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="HgClient.__prompt" ID="HgClient.__prompt"></a>
@@ -174,19 +174,26 @@
 </p>
 <dl>
 
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-maximum length of the requested input (integer)
+maximum length of the requested input
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message sent by the server (string)
+message sent by the server
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-data entered by the user (string)
+tuple containing data entered by the user and
+            a flag indicating a password input
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, bool)
 </dd>
 </dl>
 <a NAME="HgClient.__readChannel" ID="HgClient.__readChannel"></a>
@@ -200,7 +207,12 @@
 <dt>Returns:</dt>
 <dd>
 tuple of channel designator and channel data
-            (string, integer or string or bytes)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int or str or bytes)
 </dd>
 </dl>
 <a NAME="HgClient.__readHello" ID="HgClient.__readHello"></a>
@@ -213,8 +225,14 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating success (boolean) and an error message
-            in case of failure (string)
+tuple of flag indicating success and an error message in case
+            of failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="HgClient.__runcommand" ID="HgClient.__runcommand"></a>
@@ -226,17 +244,17 @@
 </p>
 <dl>
 
-<dt><i>args</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-list of arguments for the command (list of string)
+list of arguments for the command
 </dd>
-<dt><i>inputChannels</i></dt>
+<dt><i>inputChannels</i> (dict)</dt>
 <dd>
 dictionary of input channels. The dictionary must
             have the keys 'I' and 'L' and each entry must be a function
             receiving the number of bytes to write.
 </dd>
-<dt><i>outputChannels</i></dt>
+<dt><i>outputChannels</i> (dict)</dt>
 <dd>
 dictionary of output channels. The dictionary
             must have the keys 'o' and 'e' and each entry must be a function
@@ -247,7 +265,13 @@
 <dt>Returns:</dt>
 <dd>
 result code of the command, -1 if the command server wasn't
-            started or -10, if the command was canceled (integer)
+            started or -10, if the command was canceled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <dl>
@@ -267,13 +291,13 @@
 </p>
 <dl>
 
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
 <dd>
-exit code of the process (integer)
+exit code of the process
 </dd>
-<dt><i>exitStatus</i></dt>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
 <dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
 </dd>
 </dl>
 <a NAME="HgClient.__writeDataBlock" ID="HgClient.__writeDataBlock"></a>
@@ -285,9 +309,9 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (str)</dt>
 <dd>
-data to be sent (string)
+data to be sent
 </dd>
 </dl>
 <a NAME="HgClient.cancel" ID="HgClient.cancel"></a>
@@ -311,7 +335,13 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating the execution of a command (boolean)
+flag indicating the execution of a command
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="HgClient.myprompt" ID="HgClient.myprompt"></a>
@@ -328,8 +358,14 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating a successful start (boolean) and
-            an error message (string) in case of failure
+tuple of flag indicating a successful start and an error
+            message in case of failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="HgClient.runcommand" ID="HgClient.runcommand"></a>
@@ -341,40 +377,49 @@
 </p>
 <dl>
 
-<dt><i>args</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-list of arguments for the command (list of string)
+list of arguments for the command
 </dd>
-<dt><i>prompt=</i></dt>
+<dt><i>prompt</i> (func(int, str) -> (str, bool))</dt>
 <dd>
 function to reply to prompts by the server. It
             receives the max number of bytes to return and the contents
-            of the output channel received so far.
+            of the output channel received so far. If an output function is
+            given as well, the prompt data is passed through the output
+            function. The function must return the input data and a flag
+            indicating a password input.
 </dd>
-<dt><i>inputData=</i></dt>
+<dt><i>inputData</i> (func(int) -> bytes)</dt>
 <dd>
 function to reply to bulk data requests by the
             server. It receives the max number of bytes to return.
 </dd>
-<dt><i>output=</i></dt>
+<dt><i>output</i> (func(str))</dt>
 <dd>
-function receiving the data from the server (string).
-            If a prompt function is given, this parameter will be ignored.
+function receiving the data from the server. If a
+            prompt function is given, it is assumed, that the prompt output
+            is passed via this function.
 </dd>
-<dt><i>error=</i></dt>
+<dt><i>error</i> (func(str))</dt>
 <dd>
 function receiving error messages from the server
-            (string)
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-output and errors of the command server (string). In case
+tuple of output and errors of the command server. In case
             output and/or error functions were given, the respective return
             value will be an empty string.
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
 <a NAME="HgClient.startServer" ID="HgClient.startServer"></a>
 <h4>HgClient.startServer</h4>
 <b>startServer</b>(<i></i>)
@@ -385,8 +430,14 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating a successful start (boolean) and
-            an error message (string) in case of failure
+tuple of flag indicating a successful start and an error
+            message in case of failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="HgClient.stopServer" ID="HgClient.stopServer"></a>
@@ -406,7 +457,13 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating the cancel state (boolean)
+flag indicating the cancel state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial