Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7452
32b5c4a9fb17
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgClient</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgClient</h1>
24
23 <p> 25 <p>
24 Module implementing an interface to the Mercurial command server. 26 Module implementing an interface to the Mercurial command server.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#HgClient">HgClient</a></td> 38 <td><a href="#HgClient">HgClient</a></td>
34 <td>Class implementing the Mercurial command server interface.</td> 39 <td>Class implementing the Mercurial command server interface.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="HgClient" ID="HgClient"></a> 49 <a NAME="HgClient" ID="HgClient"></a>
43 <h2>HgClient</h2> 50 <h2>HgClient</h2>
51
44 <p> 52 <p>
45 Class implementing the Mercurial command server interface. 53 Class implementing the Mercurial command server interface.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>Channels</td></tr><tr><td>InputFormat</td></tr><tr><td>OutputFormat</td></tr><tr><td>OutputFormatSize</td></tr><tr><td>ReturnFormat</td></tr> 60 <tr><td>Channels</td></tr><tr><td>InputFormat</td></tr><tr><td>OutputFormat</td></tr><tr><td>OutputFormatSize</td></tr><tr><td>ReturnFormat</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#HgClient.__init__">HgClient</a></td> 72 <td><a href="#HgClient.__init__">HgClient</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#HgClient.__prompt">__prompt</a></td> 76 <td><a href="#HgClient.__prompt">__prompt</a></td>
64 <td>Private method to prompt the user for some input.</td> 77 <td>Private method to prompt the user for some input.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#HgClient.__readChannel">__readChannel</a></td> 80 <td><a href="#HgClient.__readChannel">__readChannel</a></td>
67 <td>Private method to read data from the command server.</td> 81 <td>Private method to read data from the command server.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#HgClient.__readHello">__readHello</a></td> 84 <td><a href="#HgClient.__readHello">__readHello</a></td>
70 <td>Private method to read the hello message sent by the command server.</td> 85 <td>Private method to read the hello message sent by the command server.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#HgClient.__runcommand">__runcommand</a></td> 88 <td><a href="#HgClient.__runcommand">__runcommand</a></td>
73 <td>Private method to run a command in the server (low level).</td> 89 <td>Private method to run a command in the server (low level).</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#HgClient.__serverFinished">__serverFinished</a></td> 92 <td><a href="#HgClient.__serverFinished">__serverFinished</a></td>
76 <td>Private slot connected to the finished signal.</td> 93 <td>Private slot connected to the finished signal.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#HgClient.__writeDataBlock">__writeDataBlock</a></td> 96 <td><a href="#HgClient.__writeDataBlock">__writeDataBlock</a></td>
79 <td>Private slot to write some data to the command server.</td> 97 <td>Private slot to write some data to the command server.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#HgClient.cancel">cancel</a></td> 100 <td><a href="#HgClient.cancel">cancel</a></td>
82 <td>Public method to cancel the running command.</td> 101 <td>Public method to cancel the running command.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#HgClient.func">func</a></td> 104 <td><a href="#HgClient.func">func</a></td>
85 <td></td> 105 <td></td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#HgClient.isExecuting">isExecuting</a></td> 108 <td><a href="#HgClient.isExecuting">isExecuting</a></td>
88 <td>Public method to check, if the server is executing a command.</td> 109 <td>Public method to check, if the server is executing a command.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#HgClient.myprompt">myprompt</a></td> 112 <td><a href="#HgClient.myprompt">myprompt</a></td>
91 <td></td> 113 <td></td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#HgClient.restartServer">restartServer</a></td> 116 <td><a href="#HgClient.restartServer">restartServer</a></td>
94 <td>Public method to restart the command server.</td> 117 <td>Public method to restart the command server.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#HgClient.runcommand">runcommand</a></td> 120 <td><a href="#HgClient.runcommand">runcommand</a></td>
97 <td>Public method to execute a command via the command server.</td> 121 <td>Public method to execute a command via the command server.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#HgClient.startServer">startServer</a></td> 124 <td><a href="#HgClient.startServer">startServer</a></td>
100 <td>Public method to start the command server.</td> 125 <td>Public method to start the command server.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#HgClient.stopServer">stopServer</a></td> 128 <td><a href="#HgClient.stopServer">stopServer</a></td>
103 <td>Public method to stop the command server.</td> 129 <td>Public method to stop the command server.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#HgClient.wasCanceled">wasCanceled</a></td> 132 <td><a href="#HgClient.wasCanceled">wasCanceled</a></td>
106 <td>Public method to check, if the last command was canceled.</td> 133 <td>Public method to check, if the last command was canceled.</td>
107 </tr> 134 </tr>
108 </table> 135 </table>
109 <h3>Static Methods</h3> 136 <h3>Static Methods</h3>
137
110 <table> 138 <table>
111 <tr><td>None</td></tr> 139 <tr><td>None</td></tr>
112 </table> 140 </table>
141
113 <a NAME="HgClient.__init__" ID="HgClient.__init__"></a> 142 <a NAME="HgClient.__init__" ID="HgClient.__init__"></a>
114 <h4>HgClient (Constructor)</h4> 143 <h4>HgClient (Constructor)</h4>
115 <b>HgClient</b>(<i>repoPath, encoding, vcs, parent=None</i>) 144 <b>HgClient</b>(<i>repoPath, encoding, vcs, parent=None</i>)
145
116 <p> 146 <p>
117 Constructor 147 Constructor
118 </p><dl> 148 </p>
149 <dl>
150
119 <dt><i>repoPath</i></dt> 151 <dt><i>repoPath</i></dt>
120 <dd> 152 <dd>
121 root directory of the repository (string) 153 root directory of the repository (string)
122 </dd><dt><i>encoding</i></dt> 154 </dd>
155 <dt><i>encoding</i></dt>
123 <dd> 156 <dd>
124 encoding to be used by the command server (string) 157 encoding to be used by the command server (string)
125 </dd><dt><i>vcs</i></dt> 158 </dd>
159 <dt><i>vcs</i></dt>
126 <dd> 160 <dd>
127 reference to the VCS object (Hg) 161 reference to the VCS object (Hg)
128 </dd><dt><i>parent</i></dt> 162 </dd>
163 <dt><i>parent</i></dt>
129 <dd> 164 <dd>
130 reference to the parent object (QObject) 165 reference to the parent object (QObject)
131 </dd> 166 </dd>
132 </dl><a NAME="HgClient.__prompt" ID="HgClient.__prompt"></a> 167 </dl>
168 <a NAME="HgClient.__prompt" ID="HgClient.__prompt"></a>
133 <h4>HgClient.__prompt</h4> 169 <h4>HgClient.__prompt</h4>
134 <b>__prompt</b>(<i>size, message</i>) 170 <b>__prompt</b>(<i>size, message</i>)
171
135 <p> 172 <p>
136 Private method to prompt the user for some input. 173 Private method to prompt the user for some input.
137 </p><dl> 174 </p>
175 <dl>
176
138 <dt><i>size</i></dt> 177 <dt><i>size</i></dt>
139 <dd> 178 <dd>
140 maximum length of the requested input (integer) 179 maximum length of the requested input (integer)
141 </dd><dt><i>message</i></dt> 180 </dd>
181 <dt><i>message</i></dt>
142 <dd> 182 <dd>
143 message sent by the server (string) 183 message sent by the server (string)
144 </dd> 184 </dd>
145 </dl><dl> 185 </dl>
186 <dl>
146 <dt>Returns:</dt> 187 <dt>Returns:</dt>
147 <dd> 188 <dd>
148 data entered by the user (string) 189 data entered by the user (string)
149 </dd> 190 </dd>
150 </dl><a NAME="HgClient.__readChannel" ID="HgClient.__readChannel"></a> 191 </dl>
192 <a NAME="HgClient.__readChannel" ID="HgClient.__readChannel"></a>
151 <h4>HgClient.__readChannel</h4> 193 <h4>HgClient.__readChannel</h4>
152 <b>__readChannel</b>(<i></i>) 194 <b>__readChannel</b>(<i></i>)
195
153 <p> 196 <p>
154 Private method to read data from the command server. 197 Private method to read data from the command server.
155 </p><dl> 198 </p>
199 <dl>
156 <dt>Returns:</dt> 200 <dt>Returns:</dt>
157 <dd> 201 <dd>
158 tuple of channel designator and channel data 202 tuple of channel designator and channel data
159 (string, integer or string or bytes) 203 (string, integer or string or bytes)
160 </dd> 204 </dd>
161 </dl><a NAME="HgClient.__readHello" ID="HgClient.__readHello"></a> 205 </dl>
206 <a NAME="HgClient.__readHello" ID="HgClient.__readHello"></a>
162 <h4>HgClient.__readHello</h4> 207 <h4>HgClient.__readHello</h4>
163 <b>__readHello</b>(<i></i>) 208 <b>__readHello</b>(<i></i>)
209
164 <p> 210 <p>
165 Private method to read the hello message sent by the command server. 211 Private method to read the hello message sent by the command server.
166 </p><dl> 212 </p>
213 <dl>
167 <dt>Returns:</dt> 214 <dt>Returns:</dt>
168 <dd> 215 <dd>
169 tuple of flag indicating success (boolean) and an error message 216 tuple of flag indicating success (boolean) and an error message
170 in case of failure (string) 217 in case of failure (string)
171 </dd> 218 </dd>
172 </dl><a NAME="HgClient.__runcommand" ID="HgClient.__runcommand"></a> 219 </dl>
220 <a NAME="HgClient.__runcommand" ID="HgClient.__runcommand"></a>
173 <h4>HgClient.__runcommand</h4> 221 <h4>HgClient.__runcommand</h4>
174 <b>__runcommand</b>(<i>args, inputChannels, outputChannels</i>) 222 <b>__runcommand</b>(<i>args, inputChannels, outputChannels</i>)
223
175 <p> 224 <p>
176 Private method to run a command in the server (low level). 225 Private method to run a command in the server (low level).
177 </p><dl> 226 </p>
227 <dl>
228
178 <dt><i>args</i></dt> 229 <dt><i>args</i></dt>
179 <dd> 230 <dd>
180 list of arguments for the command (list of string) 231 list of arguments for the command (list of string)
181 </dd><dt><i>inputChannels</i></dt> 232 </dd>
233 <dt><i>inputChannels</i></dt>
182 <dd> 234 <dd>
183 dictionary of input channels. The dictionary must 235 dictionary of input channels. The dictionary must
184 have the keys 'I' and 'L' and each entry must be a function 236 have the keys 'I' and 'L' and each entry must be a function
185 receiving the number of bytes to write. 237 receiving the number of bytes to write.
186 </dd><dt><i>outputChannels</i></dt> 238 </dd>
239 <dt><i>outputChannels</i></dt>
187 <dd> 240 <dd>
188 dictionary of output channels. The dictionary 241 dictionary of output channels. The dictionary
189 must have the keys 'o' and 'e' and each entry must be a function 242 must have the keys 'o' and 'e' and each entry must be a function
190 receiving the data. 243 receiving the data.
191 </dd> 244 </dd>
192 </dl><dl> 245 </dl>
246 <dl>
193 <dt>Returns:</dt> 247 <dt>Returns:</dt>
194 <dd> 248 <dd>
195 result code of the command, -1 if the command server wasn't 249 result code of the command, -1 if the command server wasn't
196 started or -10, if the command was canceled (integer) 250 started or -10, if the command was canceled (integer)
197 </dd> 251 </dd>
198 </dl><dl> 252 </dl>
253 <dl>
254
199 <dt>Raises <b>RuntimeError</b>:</dt> 255 <dt>Raises <b>RuntimeError</b>:</dt>
200 <dd> 256 <dd>
201 raised to indicate an unexpected command 257 raised to indicate an unexpected command
202 channel 258 channel
203 </dd> 259 </dd>
204 </dl><a NAME="HgClient.__serverFinished" ID="HgClient.__serverFinished"></a> 260 </dl>
261 <a NAME="HgClient.__serverFinished" ID="HgClient.__serverFinished"></a>
205 <h4>HgClient.__serverFinished</h4> 262 <h4>HgClient.__serverFinished</h4>
206 <b>__serverFinished</b>(<i>exitCode, exitStatus</i>) 263 <b>__serverFinished</b>(<i>exitCode, exitStatus</i>)
264
207 <p> 265 <p>
208 Private slot connected to the finished signal. 266 Private slot connected to the finished signal.
209 </p><dl> 267 </p>
268 <dl>
269
210 <dt><i>exitCode</i></dt> 270 <dt><i>exitCode</i></dt>
211 <dd> 271 <dd>
212 exit code of the process (integer) 272 exit code of the process (integer)
213 </dd><dt><i>exitStatus</i></dt> 273 </dd>
274 <dt><i>exitStatus</i></dt>
214 <dd> 275 <dd>
215 exit status of the process (QProcess.ExitStatus) 276 exit status of the process (QProcess.ExitStatus)
216 </dd> 277 </dd>
217 </dl><a NAME="HgClient.__writeDataBlock" ID="HgClient.__writeDataBlock"></a> 278 </dl>
279 <a NAME="HgClient.__writeDataBlock" ID="HgClient.__writeDataBlock"></a>
218 <h4>HgClient.__writeDataBlock</h4> 280 <h4>HgClient.__writeDataBlock</h4>
219 <b>__writeDataBlock</b>(<i>data</i>) 281 <b>__writeDataBlock</b>(<i>data</i>)
282
220 <p> 283 <p>
221 Private slot to write some data to the command server. 284 Private slot to write some data to the command server.
222 </p><dl> 285 </p>
286 <dl>
287
223 <dt><i>data</i></dt> 288 <dt><i>data</i></dt>
224 <dd> 289 <dd>
225 data to be sent (string) 290 data to be sent (string)
226 </dd> 291 </dd>
227 </dl><a NAME="HgClient.cancel" ID="HgClient.cancel"></a> 292 </dl>
293 <a NAME="HgClient.cancel" ID="HgClient.cancel"></a>
228 <h4>HgClient.cancel</h4> 294 <h4>HgClient.cancel</h4>
229 <b>cancel</b>(<i></i>) 295 <b>cancel</b>(<i></i>)
296
230 <p> 297 <p>
231 Public method to cancel the running command. 298 Public method to cancel the running command.
232 </p><a NAME="HgClient.func" ID="HgClient.func"></a> 299 </p>
300 <a NAME="HgClient.func" ID="HgClient.func"></a>
233 <h4>HgClient.func</h4> 301 <h4>HgClient.func</h4>
234 <b>func</b>(<i></i>) 302 <b>func</b>(<i></i>)
303
235 <a NAME="HgClient.isExecuting" ID="HgClient.isExecuting"></a> 304 <a NAME="HgClient.isExecuting" ID="HgClient.isExecuting"></a>
236 <h4>HgClient.isExecuting</h4> 305 <h4>HgClient.isExecuting</h4>
237 <b>isExecuting</b>(<i></i>) 306 <b>isExecuting</b>(<i></i>)
307
238 <p> 308 <p>
239 Public method to check, if the server is executing a command. 309 Public method to check, if the server is executing a command.
240 </p><dl> 310 </p>
311 <dl>
241 <dt>Returns:</dt> 312 <dt>Returns:</dt>
242 <dd> 313 <dd>
243 flag indicating the execution of a command (boolean) 314 flag indicating the execution of a command (boolean)
244 </dd> 315 </dd>
245 </dl><a NAME="HgClient.myprompt" ID="HgClient.myprompt"></a> 316 </dl>
317 <a NAME="HgClient.myprompt" ID="HgClient.myprompt"></a>
246 <h4>HgClient.myprompt</h4> 318 <h4>HgClient.myprompt</h4>
247 <b>myprompt</b>(<i></i>) 319 <b>myprompt</b>(<i></i>)
320
248 <a NAME="HgClient.restartServer" ID="HgClient.restartServer"></a> 321 <a NAME="HgClient.restartServer" ID="HgClient.restartServer"></a>
249 <h4>HgClient.restartServer</h4> 322 <h4>HgClient.restartServer</h4>
250 <b>restartServer</b>(<i></i>) 323 <b>restartServer</b>(<i></i>)
324
251 <p> 325 <p>
252 Public method to restart the command server. 326 Public method to restart the command server.
253 </p><dl> 327 </p>
328 <dl>
254 <dt>Returns:</dt> 329 <dt>Returns:</dt>
255 <dd> 330 <dd>
256 tuple of flag indicating a successful start (boolean) and 331 tuple of flag indicating a successful start (boolean) and
257 an error message (string) in case of failure 332 an error message (string) in case of failure
258 </dd> 333 </dd>
259 </dl><a NAME="HgClient.runcommand" ID="HgClient.runcommand"></a> 334 </dl>
335 <a NAME="HgClient.runcommand" ID="HgClient.runcommand"></a>
260 <h4>HgClient.runcommand</h4> 336 <h4>HgClient.runcommand</h4>
261 <b>runcommand</b>(<i>args, prompt=None, inputData=None, output=None, error=None</i>) 337 <b>runcommand</b>(<i>args, prompt=None, inputData=None, output=None, error=None</i>)
338
262 <p> 339 <p>
263 Public method to execute a command via the command server. 340 Public method to execute a command via the command server.
264 </p><dl> 341 </p>
342 <dl>
343
265 <dt><i>args</i></dt> 344 <dt><i>args</i></dt>
266 <dd> 345 <dd>
267 list of arguments for the command (list of string) 346 list of arguments for the command (list of string)
268 </dd><dt><i>prompt=</i></dt> 347 </dd>
348 <dt><i>prompt=</i></dt>
269 <dd> 349 <dd>
270 function to reply to prompts by the server. It 350 function to reply to prompts by the server. It
271 receives the max number of bytes to return and the contents 351 receives the max number of bytes to return and the contents
272 of the output channel received so far. 352 of the output channel received so far.
273 </dd><dt><i>inputData=</i></dt> 353 </dd>
354 <dt><i>inputData=</i></dt>
274 <dd> 355 <dd>
275 function to reply to bulk data requests by the 356 function to reply to bulk data requests by the
276 server. It receives the max number of bytes to return. 357 server. It receives the max number of bytes to return.
277 </dd><dt><i>output=</i></dt> 358 </dd>
359 <dt><i>output=</i></dt>
278 <dd> 360 <dd>
279 function receiving the data from the server (string). 361 function receiving the data from the server (string).
280 If a prompt function is given, this parameter will be ignored. 362 If a prompt function is given, this parameter will be ignored.
281 </dd><dt><i>error=</i></dt> 363 </dd>
364 <dt><i>error=</i></dt>
282 <dd> 365 <dd>
283 function receiving error messages from the server 366 function receiving error messages from the server
284 (string) 367 (string)
285 </dd> 368 </dd>
286 </dl><dl> 369 </dl>
370 <dl>
287 <dt>Returns:</dt> 371 <dt>Returns:</dt>
288 <dd> 372 <dd>
289 output and errors of the command server (string). In case 373 output and errors of the command server (string). In case
290 output and/or error functions were given, the respective return 374 output and/or error functions were given, the respective return
291 value will be an empty string. 375 value will be an empty string.
292 </dd> 376 </dd>
293 </dl><a NAME="HgClient.startServer" ID="HgClient.startServer"></a> 377 </dl>
378 <a NAME="HgClient.startServer" ID="HgClient.startServer"></a>
294 <h4>HgClient.startServer</h4> 379 <h4>HgClient.startServer</h4>
295 <b>startServer</b>(<i></i>) 380 <b>startServer</b>(<i></i>)
381
296 <p> 382 <p>
297 Public method to start the command server. 383 Public method to start the command server.
298 </p><dl> 384 </p>
385 <dl>
299 <dt>Returns:</dt> 386 <dt>Returns:</dt>
300 <dd> 387 <dd>
301 tuple of flag indicating a successful start (boolean) and 388 tuple of flag indicating a successful start (boolean) and
302 an error message (string) in case of failure 389 an error message (string) in case of failure
303 </dd> 390 </dd>
304 </dl><a NAME="HgClient.stopServer" ID="HgClient.stopServer"></a> 391 </dl>
392 <a NAME="HgClient.stopServer" ID="HgClient.stopServer"></a>
305 <h4>HgClient.stopServer</h4> 393 <h4>HgClient.stopServer</h4>
306 <b>stopServer</b>(<i></i>) 394 <b>stopServer</b>(<i></i>)
395
307 <p> 396 <p>
308 Public method to stop the command server. 397 Public method to stop the command server.
309 </p><a NAME="HgClient.wasCanceled" ID="HgClient.wasCanceled"></a> 398 </p>
399 <a NAME="HgClient.wasCanceled" ID="HgClient.wasCanceled"></a>
310 <h4>HgClient.wasCanceled</h4> 400 <h4>HgClient.wasCanceled</h4>
311 <b>wasCanceled</b>(<i></i>) 401 <b>wasCanceled</b>(<i></i>)
402
312 <p> 403 <p>
313 Public method to check, if the last command was canceled. 404 Public method to check, if the last command was canceled.
314 </p><dl> 405 </p>
406 <dl>
315 <dt>Returns:</dt> 407 <dt>Returns:</dt>
316 <dd> 408 <dd>
317 flag indicating the cancel state (boolean) 409 flag indicating the cancel state (boolean)
318 </dd> 410 </dd>
319 </dl> 411 </dl>

Mercurial Repository: eric

eric ide

mercurial