QTemporaryDir¶
The QTemporaryDir
class creates a unique directory for temporary use. More…
Synopsis¶
Functions¶
def
autoRemove
()def
errorString
()def
filePath
(fileName)def
isValid
()def
path
()def
remove
()def
setAutoRemove
(b)
Detailed Description¶
QTemporaryDir
is used to create unique temporary directories safely. The directory itself is created by the constructor. The name of the temporary directory is guaranteed to be unique (i.e., you are guaranteed to not overwrite an existing directory), and the directory will subsequently be removed upon destruction of the QTemporaryDir
object. The directory name is either auto-generated, or created based on a template, which is passed to QTemporaryDir
‘s constructor.
Example:
# Within a function/method... dir = QTemporaryDir() if (dir.isValid()) { # dir.path() returns the unique directory path # The QTemporaryDir destructor removes the temporary directory # as it goes out of scope.
It is very important to test that the temporary directory could be created, using isValid()
. Do not use exists()
, since a default-constructed QDir
represents the current directory, which exists.
The path to the temporary directory can be found by calling path()
.
A temporary directory will have some static part of the name and some part that is calculated to be unique. The default path will be determined from applicationName()
(otherwise qt_temp
) and will be placed into the temporary path as returned by tempPath()
. If you specify your own path, a relative path will not be placed in the temporary directory by default, but be relative to the current working directory. In all cases, a random string will be appended to the path in order to make it unique.
See also
- class PySide6.QtCore.QTemporaryDir¶
PySide6.QtCore.QTemporaryDir(templateName)
- Parameters
templateName – str
Constructs a QTemporaryDir
using as template the application name returned by applicationName()
(otherwise qt_temp
). The directory is stored in the system’s temporary directory, tempPath()
.
See also
Constructs a QTemporaryDir
with a template of templatePath
.
If templatePath
is a relative path, the path will be relative to the current working directory. You can use tempPath()
to construct templatePath
if you want use the system’s temporary directory.
If the templatePath
ends with XXXXXX it will be used as the dynamic portion of the directory name, otherwise it will be appended. Unlike QTemporaryFile
, XXXXXX in the middle of the template string is not supported.
See also
- PySide6.QtCore.QTemporaryDir.autoRemove()¶
- Return type
bool
Returns true
if the QTemporaryDir
is in auto remove mode. Auto-remove mode will automatically delete the directory from disk upon destruction. This makes it very easy to create your QTemporaryDir
object on the stack, fill it with files, do something with the files, and finally on function return it will automatically clean up after itself.
Auto-remove is on by default.
See also
- PySide6.QtCore.QTemporaryDir.errorString()¶
- Return type
str
If isValid()
returns false
, this function returns the error string that explains why the creation of the temporary directory failed. Otherwise, this function return an empty string.
- PySide6.QtCore.QTemporaryDir.filePath(fileName)¶
- Parameters
fileName – str
- Return type
str
Returns the path name of a file in the temporary directory. Does not check if the file actually exists in the directory. Redundant multiple separators or “.” and “..” directories in fileName
are not removed (see cleanPath()
). Absolute paths are not allowed.
- PySide6.QtCore.QTemporaryDir.isValid()¶
- Return type
bool
Returns true
if the QTemporaryDir
was created successfully.
- PySide6.QtCore.QTemporaryDir.path()¶
- Return type
str
Returns the path to the temporary directory. Empty if the QTemporaryDir
could not be created.
- PySide6.QtCore.QTemporaryDir.remove()¶
- Return type
bool
Removes the temporary directory, including all its contents.
Returns true
if removing was successful.
- PySide6.QtCore.QTemporaryDir.setAutoRemove(b)¶
- Parameters
b – bool
Sets the QTemporaryDir
into auto-remove mode if b
is true.
Auto-remove is on by default.
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.