Skip to content

PythonQt.QtCore.QProcessEnvironment

QProcessEnvironment

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

A process's environment is composed of a set of key\=value pairs known as environment variables. The QProcessEnvironment class wraps that concept and allows easy manipulation of those variables. It's meant to be used along with QProcess, to set the environment for child processes. It cannot be used to change the current process's environment.

The environment of the calling process can be obtained using QProcessEnvironment::systemEnvironment().

On Unix systems, the variable names are case-sensitive. Note that the Unix environment allows both variable names and contents to contain arbitrary binary data (except for the NUL character). QProcessEnvironment will preserve such variables, but does not support manipulating variables whose names or values cannot be encoded by the current locale settings (see QTextCodec::codecForLocale).

On Windows, the variable names are case-insensitive, but case-preserving. QProcessEnvironment behaves accordingly.

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
clear function (self) -> None Removes all key\=value pairs from this [QProcessEnvironment](https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html) object, making it empty.
contains function (self, name: str) -> bool X.contains(name) -> bool
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
insert function (self, name: Any, value: Any) -> None X.insert(name, value)
isEmpty function (self) -> bool X.isEmpty() -> bool
keys function (self) -> tuple X.keys() -> tuple
operator_assign function (self, other: Any) -> Any X.operator_assign(other) -> PythonQt.QtCore.QProcessEnvironment
remove function (self, name: str) -> None Removes the environment variable identified by name from this [QProcessEnvironment](https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html) object.
swap function (self, other: Any) -> None Swaps this process environment instance with other.
systemEnvironment function (self) -> Any X.systemEnvironment() -> PythonQt.QtCore.QProcessEnvironment
toStringList function (self) -> tuple X.toStringList() -> tuple
value function (self, name: str, defaultValue: str) -> str X.value(name, defaultValue) -> str