Skip to content

PythonQt.QtCore.QProcess · declarations 001

Back to PythonQt.QtCore.QProcess

CrashExit instance-attribute

CrashExit: Any

Crashed instance-attribute

Crashed: Any

ExitStatus instance-attribute

ExitStatus: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

FailedToStart instance-attribute

FailedToStart: Any

ForwardedChannels instance-attribute

ForwardedChannels: Any

ForwardedErrorChannel instance-attribute

ForwardedErrorChannel: Any

ForwardedInputChannel instance-attribute

ForwardedInputChannel: Any

ForwardedOutputChannel instance-attribute

ForwardedOutputChannel: Any

InputChannelMode instance-attribute

InputChannelMode: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ManagedInputChannel instance-attribute

ManagedInputChannel: Any

MergedChannels instance-attribute

MergedChannels: Any

NormalExit instance-attribute

NormalExit: Any

NotRunning instance-attribute

NotRunning: Any

ProcessChannel instance-attribute

ProcessChannel: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ProcessChannelMode instance-attribute

ProcessChannelMode: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ProcessError instance-attribute

ProcessError: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ProcessState instance-attribute

ProcessState: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

SeparateChannels instance-attribute

SeparateChannels: Any

StandardError instance-attribute

StandardError: Any

StandardOutput instance-attribute

StandardOutput: Any

Starting instance-attribute

Starting: Any

Timedout instance-attribute

Timedout: Any

aboutToClose

aboutToClose(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QProcess.aboutToClose; argument details are not documented.

arguments

arguments() -> tuple

X.arguments() -> tuple

Supplemental documentation: Qt 5 reference:

QStringList QProcess::arguments() const

Returns the command line arguments the process was last started with.

This function was introduced in Qt 5.0.

See also setArguments() and start().

Upstream PySide2 reference signatures (binding differences may apply):

arguments(self) -> typing.List[str]

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#arguments

atEnd

atEnd() -> bool

X.atEnd() -> bool

Supplemental documentation: Qt 5 reference:

[override virtual] bool QProcess::atEnd() const

Reimplements: QIODevice::atEnd() const.

Returns true if the process is not running, and no more data is available for reading; otherwise returns false.

Upstream PySide2 reference signatures (binding differences may apply):

atEnd(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#atEnd

bytesAvailable

bytesAvailable() -> int

X.bytesAvailable() -> int

Supplemental documentation: Qt 5 reference:

[override virtual] qint64 QProcess::bytesAvailable() const

Reimplements: QIODevice::bytesAvailable() const.

Upstream PySide2 reference signatures (binding differences may apply):

bytesAvailable(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#bytesAvailable

bytesToWrite

bytesToWrite() -> int

X.bytesToWrite() -> int

Supplemental documentation: Qt 5 reference:

[override virtual] qint64 QProcess::bytesToWrite() const

Reimplements: QIODevice::bytesToWrite() const.

Upstream PySide2 reference signatures (binding differences may apply):

bytesToWrite(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#bytesToWrite

bytesWritten

bytesWritten(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QProcess.bytesWritten; argument details are not documented.

canReadLine

canReadLine() -> bool

X.canReadLine() -> bool

Supplemental documentation: Qt 5 reference:

[override virtual] bool QProcess::canReadLine() const

Reimplements: QIODevice::canReadLine() const.

This function operates on the current read channel.

See also readChannel() and setReadChannel().

Upstream PySide2 reference signatures (binding differences may apply):

canReadLine(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#canReadLine

channelBytesWritten

channelBytesWritten(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QProcess.channelBytesWritten; argument details are not documented.

channelReadyRead

channelReadyRead(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QProcess.channelReadyRead; argument details are not documented.

close

close() -> None

X.close()

Supplemental documentation: Qt 5 reference:

[override virtual] void QProcess::close()

Reimplements: 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.

Upstream PySide2 reference signatures (binding differences may apply):

close(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#close

closeReadChannel

closeReadChannel(channel: Any) -> None

X.closeReadChannel(channel)

Supplemental documentation: Qt 5 reference:

void QProcess::closeReadChannel(QProcess::ProcessChannel channel)

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().

Upstream PySide2 reference signatures (binding differences may apply):

closeReadChannel(self, channel: PySide2.QtCore.QProcess.ProcessChannel) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#closeReadChannel

closeWriteChannel

closeWriteChannel() -> None

X.closeWriteChannel()

Supplemental documentation: Qt 5 reference:

void QProcess::closeWriteChannel()

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().

Upstream PySide2 reference signatures (binding differences may apply):

closeWriteChannel(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#closeWriteChannel

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QProcess.destroyed; argument details are not documented.

environment

environment() -> tuple

X.environment() -> tuple

Upstream PySide2 reference signatures (binding differences may apply):

environment(self) -> typing.List[str]

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#environment

error

error() -> Any

X.error()

Supplemental documentation: Qt 5 reference:

QProcess::ProcessError QProcess::error() const

Returns the type of error that occurred last.

See also state().

Upstream PySide2 reference signatures (binding differences may apply):

error(self) -> PySide2.QtCore.QProcess.ProcessError

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#error

errorOccurred

errorOccurred(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QProcess.errorOccurred; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QProcess::errorOccurred(QProcess::ProcessError error)

This signal is emitted when an error occurs with the process. The specified error describes the type of error that occurred.

This function was introduced in Qt 5.6.

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#errorOccurred

execute

execute(program: Any, arguments: Any) -> int

X.execute(program, arguments) -> int

Supplemental documentation: Qt 5 reference:

[static] int QProcess::execute(const QString \&program, const QStringList \&arguments)

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.

Argument handling is identical to the respective start() overload.

If the process cannot be started, -2 is returned. If the process crashes, -1 is returned. Otherwise, the process' exit code is returned.

See also start().

Upstream PySide2 reference signatures (binding differences may apply):

execute(command: str) -> int
execute(program: str, arguments: typing.Sequence[str]) -> int

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#execute

exitCode

exitCode() -> int

X.exitCode() -> int

Supplemental documentation: Qt 5 reference:

int QProcess::exitCode() const

Returns the exit code of the last process that finished.

This value is not valid unless exitStatus() returns NormalExit.

Upstream PySide2 reference signatures (binding differences may apply):

exitCode(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qprocess.html#exitCode