eric: comparison eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html

-:f04328aef87a
+:32b5c4a9fb17
 <p>
 Constructor
 </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>
 <h4>HgClient.__prompt</h4>
 <b>__prompt</b>(<i>size, message</i>)
 <p>
 Private method to prompt the user for some input.
 </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>
 <h4>HgClient.__readChannel</h4>
 <b>__readChannel</b>(<i></i>)
 </p>
 <dl>
 <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>
 <h4>HgClient.__readHello</h4>
 <b>__readHello</b>(<i></i>)
 Private method to read the hello message sent by the command server.
 </p>
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating success (boolean) and an error message
+tuple of flag indicating success and an error message in case
-in case of failure (string)
+of failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="HgClient.__runcommand" ID="HgClient.__runcommand"></a>
 <h4>HgClient.__runcommand</h4>
 <b>__runcommand</b>(<i>args, inputChannels, outputChannels</i>)
 <p>
 Private method to run a command in the server (low level).
 </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
 receiving the data.
 </dd>
 </dl>
 <dl>
 <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>
 <dt>Raises <b>RuntimeError</b>:</dt>
 <p>
 Private slot connected to the finished signal.
 </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>
 <h4>HgClient.__writeDataBlock</h4>
 <b>__writeDataBlock</b>(<i>data</i>)
 <p>
 Private slot to write some data to the command server.
 </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>
 <h4>HgClient.cancel</h4>
 <b>cancel</b>(<i></i>)
 Public method to check, if the server is executing a command.
 </p>
 <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>
 <h4>HgClient.myprompt</h4>
 <b>myprompt</b>(<i></i>)
 Public method to restart the command server.
 </p>
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating a successful start (boolean) and
+tuple of flag indicating a successful start and an error
-an error message (string) in case of failure
+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>
 <h4>HgClient.runcommand</h4>
 <b>runcommand</b>(<i>args, prompt=None, inputData=None, output=None, error=None</i>)
 <p>
 Public method to execute a command via the command server.
 </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
-</dd>
+given as well, the prompt data is passed through the output
-<dt><i>inputData=</i></dt>
+function. The function must return the input data and a flag
+indicating a password input.
+</dd>
+<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).
+function receiving the data from the server. If a
-If a prompt function is given, this parameter will be ignored.
+prompt function is given, it is assumed, that the prompt output
-</dd>
+is passed via this function.
-<dt><i>error=</i></dt>
+</dd>
+<dt><i>error</i> (func(str))</dt>
 <dd>
 function receiving error messages from the server
-(string)
+</dd>
-</dd>
+</dl>
-</dl>
+<dl>
-<dl>
+<dt>Returns:</dt>
-<dt>Returns:</dt>
+<dd>
-<dd>
+tuple of output and errors of the command server. In case
-output and errors of the command server (string). 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>)
 Public method to start the command server.
 </p>
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating a successful start (boolean) and
+tuple of flag indicating a successful start and an error
-an error message (string) in case of failure
+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>
 <h4>HgClient.stopServer</h4>
 <b>stopServer</b>(<i></i>)
 Public method to check, if the last command was canceled.
 </p>
 <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>
 <hr />
 </body></html>

Mercurial Repositories > eric / file comparison

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

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