| Home · All Classes · Modules |
The QProcess class is used to start external programs and to communicate with them. More...
Inherits QIODevice.
The QProcess class is used to start external programs and to communicate with them.
To start a process, pass the name and command line arguments of the program you want to run as arguments to start(). Arguments are supplied as individual strings in a QStringList.
For example, the following code snippet runs the analog clock example in the Motif style on X11 platforms by passing strings containing "-style" and "motif" as two items in the list of arguments:
QObject *parent;
...
QString program = "./path/to/Qt/examples/widgets/analogclock";
QStringList arguments;
arguments << "-style" << "motif";
QProcess *myProcess = new QProcess(parent);
myProcess->start(program, arguments);
QProcess then enters the Starting state, and when the program has started, QProcess enters the Running state and emits started().
QProcess allows you to treat a process as a sequential I/O device. You can write to and read from the process just as you would access a network connection using QTcpSocket. You can then write to the process's standard input by calling write(), and read the standard output by calling read(), readLine(), and getChar(). Because it inherits QIODevice, QProcess can also be used as an input source for QXmlReader, or for generating data to be uploaded using QFtp.
Note: On Windows CE and Symbian, reading and writing to a process is not supported.
When the process exits, QProcess reenters the NotRunning state (the initial state), and emits finished().
The finished() signal provides the exit code and exit status of the process as arguments, and you can also call exitCode() to obtain the exit code of the last process that finished, and exitStatus() to obtain its exit status. If an error occurs at any point in time, QProcess will emit the error() signal. You can also call error() to find the type of error that occurred last, and state() to find the current process state.
Processes have two predefined output channels: The standard output channel (stdout) supplies regular console output, and the standard error channel (stderr) usually supplies the errors that are printed by the process. These channels represent two separate streams of data. You can toggle between them by calling setReadChannel(). QProcess emits readyRead() when data is available on the current read channel. It also emits readyReadStandardOutput() when new standard output data is available, and when new standard error data is available, readyReadStandardError() is emitted. Instead of calling read(), readLine(), or getChar(), you can explicitly read all data from either of the two channels by calling readAllStandardOutput() or readAllStandardError().
The terminology for the channels can be misleading. Be aware that the process's output channels correspond to QProcess's read channels, whereas the process's input channels correspond to QProcess's write channels. This is because what we read using QProcess is the process's output, and what we write becomes the process's input.
QProcess can merge the two output channels, so that standard output and standard error data from the running process both use the standard output channel. Call setProcessChannelMode() with MergedChannels before starting the process to activative this feature. You also have the option of forwarding the output of the running process to the calling, main process, by passing ForwardedChannels as the argument.
Certain processes need special environment settings in order to operate. You can set environment variables for your process by calling setEnvironment(). To set a working directory, call setWorkingDirectory(). By default, processes are run in the current working directory of the calling process.
Note: On Symbian, setting environment or working directory is not supported. The working directory will always be the private directory of the running process.
Note: On QNX, setting the working directory may cause all application threads, with the exception of the QProcess caller thread, to temporarily freeze, owing to a limitation in the operating system.
QProcess provides a set of functions which allow it to be used without an event loop, by suspending the calling thread until certain signals are emitted:
Calling these functions from the main thread (the thread that calls QApplication.exec()) may cause your user interface to freeze.
The following example runs gzip to compress the string "Qt rocks!", without an event loop:
QProcess gzip;
gzip.start("gzip", QStringList() << "-c");
if (!gzip.waitForStarted())
return false;
gzip.write("Qt rocks!");
gzip.closeWriteChannel();
if (!gzip.waitForFinished())
return false;
QByteArray result = gzip.readAll();
Some Windows commands (for example, dir) are not provided by separate applications, but by the command interpreter itself. If you attempt to use QProcess to execute these commands directly, it won't work. One possible solution is to execute the command interpreter itself (cmd.exe on some Windows systems), and ask the interpreter to execute the desired command.
On Symbian, processes which use the functions kill() or terminate() must have the PowerMgmt platform security capability. If the client process lacks this capability, these functions will fail.
Platform security capabilities are added via the TARGET.CAPABILITY qmake variable.
This enum describes the different exit statuses of QProcess.
| Constant | Value | Description |
|---|---|---|
| QProcess.NormalExit | 0 | The process exited normally. |
| QProcess.CrashExit | 1 | The process crashed. |
See also exitStatus().
This enum describes the process channels used by the running process. Pass one of these values to setReadChannel() to set the current read channel of QProcess.
| Constant | Value | Description |
|---|---|---|
| QProcess.StandardOutput | 0 | The standard output (stdout) of the running process. |
| QProcess.StandardError | 1 | The standard error (stderr) of the running process. |
See also setReadChannel().
This enum describes the process channel modes of QProcess. Pass one of these values to setProcessChannelMode() to set the current read channel mode.
| Constant | Value | Description |
|---|---|---|
| QProcess.SeparateChannels | 0 | QProcess manages the output of the running process, keeping standard output and standard error data in separate internal buffers. You can select the QProcess's current read channel by calling setReadChannel(). This is the default channel mode of QProcess. |
| QProcess.MergedChannels | 1 | QProcess merges the output of the running process into the standard output channel (stdout). The standard error channel (stderr) will not receive any data. The standard output and standard error data of the running process are interleaved. |
| QProcess.ForwardedChannels | 2 | QProcess forwards the output of the running process onto the main process. Anything the child process writes to its standard output and standard error will be written to the standard output and standard error of the main process. |
See also setProcessChannelMode().
This enum describes the different types of errors that are reported by QProcess.
| Constant | Value | Description |
|---|---|---|
| QProcess.FailedToStart | 0 | The process failed to start. Either the invoked program is missing, or you may have insufficient permissions to invoke the program. |
| QProcess.Crashed | 1 | The process crashed some time after starting successfully. |
| QProcess.Timedout | 2 | The last waitFor...() function timed out. The state of QProcess is unchanged, and you can try calling waitFor...() again. |
| QProcess.WriteError | 4 | An error occurred when attempting to write to the process. For example, the process may not be running, or it may have closed its input channel. |
| QProcess.ReadError | 3 | An error occurred when attempting to read from the process. For example, the process may not be running. |
| QProcess.UnknownError | 5 | An unknown error occurred. This is the default return value of error(). |
See also error().
This enum describes the different states of QProcess.
| Constant | Value | Description |
|---|---|---|
| QProcess.NotRunning | 0 | The process is not running. |
| QProcess.Starting | 1 | The process is starting, but the program has not yet been invoked. |
| QProcess.Running | 2 | The process is running and is ready for reading and writing. |
See also state().
The parent argument, if not None, causes self to be owned by Qt instead of PyQt.
Constructs a QProcess object with the given parent.
Reimplemented from QIODevice.atEnd().
Returns true if the process is not running, and no more data is available for reading; otherwise returns false.
Reimplemented from QIODevice.bytesAvailable().
Reimplemented from QIODevice.bytesToWrite().
Reimplemented from QIODevice.canReadLine().
This function operates on the current read channel.
See also readChannel() and setReadChannel().
Reimplemented from QIODevice.close().
Closes all communication with the process and kills it. After calling this function, QProcess will no longer emit readyRead(), and data can no longer be read or written.
Closes the read channel channel. After calling this function, QProcess will no longer receive data on the channel. Any data that has already been received is still available for reading.
Call this function to save memory, if you are not interested in the output of the process.
See also closeWriteChannel() and setReadChannel().
Schedules the write channel of QProcess to be closed. The channel will close once all data has been written to the process. After calling this function, any attempts to write to the process will fail.
Closing the write channel is necessary for programs that read input data until the channel has been closed. For example, the program "more" is used to display text data in a console on both Unix and Windows. But it will not display the text data until QProcess's write channel has been closed. Example:
QProcess more; more.start("more"); more.write("Text to display"); more.closeWriteChannel(); // QProcess will emit readyRead() once "more" starts printing
The write channel is implicitly opened when start() is called.
See also closeReadChannel().
This function is deprecated.
Returns the environment that QProcess will use when starting a process, or an empty QStringList if no environment has been set using setEnvironment() or setEnvironmentHash(). If no environment has been set, the environment of the calling process will be used.
Note: The environment settings are ignored on Windows CE and Symbian, as there is no concept of an environment.
See also processEnvironment(), setEnvironment(), and systemEnvironment().
Returns the type of error that occurred last.
See also state().
Starts the program program with the arguments arguments in a new process, waits for it to finish, and then returns the exit code of the process. Any data the new process writes to the console is forwarded to the calling process.
The environment and working directory are inherited from the calling process.
On Windows, arguments that contain spaces are wrapped in quotes.
If the process cannot be started, -2 is returned. If the process crashes, -1 is returned. Otherwise, the process' exit code is returned.
This is an overloaded function.
Starts the program program in a new process. program is a single string of text containing both the program name and its arguments. The arguments are separated by one or more spaces.
Returns the exit code of the last process that finished.
Returns the exit status of the last process that finished.
On Windows, if the process was terminated with TerminateProcess() from another application this function will still return NormalExit unless the exit code is less than 0.
This function was introduced in Qt 4.1.
Reimplemented from QIODevice.isSequential().
This method is also a Qt slot with the C++ signature void kill().
Kills the current process, causing it to exit immediately.
On Windows, kill() uses TerminateProcess, and on Unix and Mac OS X, the SIGKILL signal is sent to the process.
On Symbian, this function requires platform security capability PowerMgmt. If absent, the process will panic with KERN-EXEC 46.
Note: Killing running processes from other processes will typically cause a panic in Symbian due to platform security.
See also Symbian Platform Security Requirements and terminate().
Returns the native process identifier for the running process, if available. If no process is currently running, 0 is returned.
Returns the channel mode of the QProcess standard output and standard error channels.
This function was introduced in Qt 4.2.
See also setProcessChannelMode(), ProcessChannelMode, and setReadChannel().
Returns the environment that QProcess will use when starting a process, or an empty object if no environment has been set using setEnvironment() or setProcessEnvironment(). If no environment has been set, the environment of the calling process will be used.
Note: The environment settings are ignored on Windows CE, as there is no concept of an environment.
This function was introduced in Qt 4.6.
See also setProcessEnvironment(), setEnvironment(), and QProcessEnvironment.isEmpty().
Regardless of the current read channel, this function returns all data available from the standard error of the process as a QByteArray.
See also readyReadStandardError(), readAllStandardOutput(), readChannel(), and setReadChannel().
Regardless of the current read channel, this function returns all data available from the standard output of the process as a QByteArray.
See also readyReadStandardOutput(), readAllStandardError(), readChannel(), and setReadChannel().
Returns the current read channel of the QProcess.
See also setReadChannel().
Reimplemented from QIODevice.readData().
This function is deprecated.
Sets the environment that QProcess will use when starting a process to the environment specified which consists of a list of key=value pairs.
For example, the following code adds the C:\\BIN directory to the list of executable paths (PATHS) on Windows:
QProcess process; QStringList env = QProcess.systemEnvironment(); env << "TMPDIR=C:\\MyApp\\temp"; // Add an environment variable env.replaceInStrings(QRegExp("^PATH=(.*)", Qt.CaseInsensitive), "PATH=\\1;C:\\Bin"); process.setEnvironment(env); process.start("myapp");
Note: This function is less efficient than the setProcessEnvironment() function.
See also environment(), setProcessEnvironment(), and systemEnvironment().
Sets the channel mode of the QProcess standard output and standard error channels to the mode specified. This mode will be used the next time start() is called. For example:
QProcess builder; builder.setProcessChannelMode(QProcess.MergedChannels); builder.start("make", QStringList() << "-j2"); if (!builder.waitForFinished()) qDebug() << "Make failed:" << builder.errorString(); else qDebug() << "Make output:" << builder.readAll();
This function was introduced in Qt 4.2.
See also processChannelMode(), ProcessChannelMode, and setReadChannel().
Sets the environment that QProcess will use when starting a process to the environment object.
For example, the following code adds the C:\\BIN directory to the list of executable paths (PATHS) on Windows and sets TMPDIR:
QProcess process; QProcessEnvironment env = QProcessEnvironment.systemEnvironment(); env.insert("TMPDIR", "C:\\MyApp\\temp"); // Add an environment variable env.insert("PATH", env.value("Path") + ";C:\\Bin"); process.setProcessEnvironment(env); process.start("myapp");
Note how, on Windows, environment variable names are case-insensitive.
This function was introduced in Qt 4.6.
See also processEnvironment(), QProcessEnvironment.systemEnvironment(), and setEnvironment().
Sets the current state of the QProcess to the state specified.
See also state().
Sets the current read channel of the QProcess to the given channel. The current input channel is used by the functions read(), readAll(), readLine(), and getChar(). It also determines which channel triggers QProcess to emit readyRead().
See also readChannel().
Redirects the process' standard error to the file fileName. When the redirection is in place, the standard error read channel is closed: reading from it using read() will always fail, as will readAllStandardError(). The file will be appended to if mode is Append, otherwise, it will be truncated.
See setStandardOutputFile() for more information on how the file is opened.
Note: if setProcessChannelMode() was called with an argument of QProcess.MergedChannels, this function has no effect.
This function was introduced in Qt 4.2.
See also setStandardInputFile(), setStandardOutputFile(), and setStandardOutputProcess().
Redirects the process' standard input to the file indicated by fileName. When an input redirection is in place, the QProcess object will be in read-only mode (calling write() will result in error).
If the file fileName does not exist at the moment start() is called or is not readable, starting the process will fail.
Calling setStandardInputFile() after the process has started has no effect.
This function was introduced in Qt 4.2.
See also setStandardOutputFile(), setStandardErrorFile(), and setStandardOutputProcess().
Redirects the process' standard output to the file fileName. When the redirection is in place, the standard output read channel is closed: reading from it using read() will always fail, as will readAllStandardOutput().
If the file fileName doesn't exist at the moment start() is called, it will be created. If it cannot be created, the starting will fail.
If the file exists and mode is QIODevice.Truncate, the file will be truncated. Otherwise (if mode is QIODevice.Append), the file will be appended to.
Calling setStandardOutputFile() after the process has started has no effect.
This function was introduced in Qt 4.2.
See also setStandardInputFile(), setStandardErrorFile(), and setStandardOutputProcess().
Pipes the standard output stream of this process to the destination process' standard input.
The following shell command:
command1 | command2
Can be accomplished with QProcesses with the following code:
QProcess process1; QProcess process2; process1.setStandardOutputProcess(&process2); process1.start("command1"); process2.start("command2");
This function was introduced in Qt 4.2.
This function is called in the child process context just before the program is executed on Unix or Mac OS X (i.e., after fork(), but before execve()). Reimplement this function to do last minute initialization of the child process. Example:
class SandboxProcess : public QProcess { ... protected: void setupChildProcess(); ... }; void SandboxProcess.setupChildProcess() { // Drop all privileges in the child process, and enter // a chroot jail. #if defined Q_OS_UNIX .setgroups(0, 0); .chroot("/etc/safe"); .chdir("/"); .setgid(safeGid); .setuid(safeUid); .umask(0); #endif }
You cannot exit the process (by calling exit(), for instance) from this function. If you need to stop the program before it starts execution, your workaround is to emit finished() and then call exit().
Warning: This function is called by QProcess on Unix and Mac OS X only. On Windows and QNX, it is not called.
Sets the working directory to dir. QProcess will start the process in this directory. The default behavior is to start the process in the working directory of the calling process.
Note: The working directory setting is ignored on Symbian; the private directory of the process is considered its working directory.
Note: On QNX, this may cause all application threads to temporarily freeze.
See also workingDirectory() and start().
Starts the given program in a new process, if none is already running, passing the command line arguments in arguments. The OpenMode is set to mode.
The QProcess object will immediately enter the Starting state. If the process starts successfully, QProcess will emit started(); otherwise, error() will be emitted. If the QProcess object is already running a process, a warning may be printed at the console, and the existing process will continue running.
Note: Processes are started asynchronously, which means the started() and error() signals may be delayed. Call waitForStarted() to make sure the process has started (or has failed to start) and those signals have been emitted.
Note: No further splitting of the arguments is performed.
Windows: Arguments that contain spaces are wrapped in quotes.
See also pid(), started(), and waitForStarted().
This is an overloaded function.
Starts the program program in a new process, if one is not already running. program is a single string of text containing both the program name and its arguments. The arguments are separated by one or more spaces. For example:
QProcess process; process.start("del /s *.txt"); // same as process.start("del", QStringList() << "/s" << "*.txt"); ...
The program string can also contain quotes, to ensure that arguments containing spaces are correctly supplied to the new process. For example:
QProcess process; process.start("dir \"My Documents\"");
If the QProcess object is already running a process, a warning may be printed at the console, and the existing process will continue running.
Note that, on Windows, quotes need to be both escaped and quoted. For example, the above code would be specified in the following way to ensure that "My Documents" is used as the argument to the dir executable:
QProcess process; process.start("dir \"\"\"My Documents\"\"\"");
The OpenMode is set to mode.
Starts the program program with the arguments arguments in a new process, and detaches from it. Returns true on success; otherwise returns false. If the calling process exits, the detached process will continue to live.
Note that arguments that contain spaces are not passed to the process as separate arguments.
Unix: The started process will run in its own session and act like a daemon.
Windows: Arguments that contain spaces are wrapped in quotes. The started process will run as a regular standalone process.
The process will be started in the directory workingDirectory.
Note: On QNX, this may cause all application threads to temporarily freeze.
If the function is successful then *pid is set to the process identifier of the started process.
Starts the program program with the given arguments in a new process, and detaches from it. Returns true on success; otherwise returns false. If the calling process exits, the detached process will continue to live.
Note: Arguments that contain spaces are not passed to the process as separate arguments.
Unix: The started process will run in its own session and act like a daemon.
Windows: Arguments that contain spaces are wrapped in quotes. The started process will run as a regular standalone process.
This is an overloaded function.
Starts the program program in a new process. program is a single string of text containing both the program name and its arguments. The arguments are separated by one or more spaces.
The program string can also contain quotes, to ensure that arguments containing spaces are correctly supplied to the new process.
Returns the current state of the process.
See also stateChanged() and error().
Returns the environment of the calling process as a list of key=value pairs. Example:
QStringList environment = QProcess.systemEnvironment(); // environment = {"PATH=/usr/bin:/usr/local/bin", // "USER=greg", "HOME=/home/greg"}
This function does not cache the system environment. Therefore, it's possible to obtain an updated version of the environment if low-level C library functions like setenv ot putenv have been called.
However, note that repeated calls to this function will recreate the list of environment variables, which is a non-trivial operation.
Note: For new code, it is recommended to use QProcessEnvironment.systemEnvironment()
This function was introduced in Qt 4.1.
See also QProcessEnvironment.systemEnvironment(), environment(), and setEnvironment().
This method is also a Qt slot with the C++ signature void terminate().
Attempts to terminate the process.
The process may not exit as a result of calling this function (it is given the chance to prompt the user for any unsaved files, etc).
On Windows, terminate() posts a WM_CLOSE message to all toplevel windows of the process and then to the main thread of the process itself. On Unix and Mac OS X the SIGTERM signal is sent.
Console applications on Windows that do not run an event loop, or whose event loop does not handle the WM_CLOSE message, can only be terminated by calling kill().
On Symbian, this function requires platform security capability PowerMgmt. If absent, the process will panic with KERN-EXEC 46.
Note: Terminating running processes from other processes will typically cause a panic in Symbian due to platform security.
See also Symbian Platform Security Requirements and kill().
Reimplemented from QIODevice.waitForBytesWritten().
Blocks until the process has finished and the finished() signal has been emitted, or until msecs milliseconds have passed.
Returns true if the process finished; otherwise returns false (if the operation timed out, if an error occurred, or if this QProcess is already finished).
This function can operate without an event loop. It is useful when writing non-GUI applications and when performing I/O operations in a non-GUI thread.
Warning: Calling this function from the main (GUI) thread might cause your user interface to freeze.
If msecs is -1, this function will not time out.
See also finished(), waitForStarted(), waitForReadyRead(), and waitForBytesWritten().
Reimplemented from QIODevice.waitForReadyRead().
Blocks until the process has started and the started() signal has been emitted, or until msecs milliseconds have passed.
Returns true if the process was started successfully; otherwise returns false (if the operation timed out or if an error occurred).
This function can operate without an event loop. It is useful when writing non-GUI applications and when performing I/O operations in a non-GUI thread.
Warning: Calling this function from the main (GUI) thread might cause your user interface to freeze.
If msecs is -1, this function will not time out.
See also started(), waitForReadyRead(), waitForBytesWritten(), and waitForFinished().
If QProcess has been assigned a working directory, this function returns the working directory that the QProcess will enter before the program has started. Otherwise, (i.e., no directory has been assigned,) an empty string is returned, and QProcess will use the application's current working directory instead.
See also setWorkingDirectory().
Reimplemented from QIODevice.writeData().
This is the default overload of this signal.
This signal is emitted when an error occurs with the process. The specified error describes the type of error that occurred.
This is the default overload of this signal.
This signal is emitted when the process finishes. exitCode is the exit code of the process, and exitStatus is the exit status. After the process has finished, the buffers in QProcess are still intact. You can still read any data that the process may have written before it finished.
See also exitStatus().
This is the default overload of this signal.
This signal is emitted when the process has made new data available through its standard error channel (stderr). It is emitted regardless of the current read channel.
See also readAllStandardError() and readChannel().
This is the default overload of this signal.
This signal is emitted when the process has made new data available through its standard output channel (stdout). It is emitted regardless of the current read channel.
See also readAllStandardOutput() and readChannel().
This is the default overload of this signal.
This signal is emitted by QProcess when the process has started, and state() returns Running.
This is the default overload of this signal.
This signal is emitted whenever the state of QProcess changes. The newState argument is the state QProcess changed to.
| PyQt 4.10.1 for MacOS | Copyright © Riverbank Computing Ltd and Nokia 2012 | Qt 4.8.4 |