QStandardPaths#

The QStandardPaths class provides methods for accessing standard paths. More…

Synopsis#

Static functions#

def displayName (type)
def findExecutable (executableName[, paths=list()])
def isTestModeEnabled ()
def locate (type, fileName[, options=QStandardPaths.LocateOption.LocateFile])
def locateAll (type, fileName[, options=QStandardPaths.LocateOption.LocateFile])
def setTestModeEnabled (testMode)
def standardLocations (type)
def writableLocation (type)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

This class contains functions to query standard locations on the local filesystem, for common tasks such as user-specific directories or system-wide configuration directories.

class PySide6.QtCore.QStandardPaths#

PySide6.QtCore.QStandardPaths.StandardLocation#

This enum describes the different locations that can be queried using methods such as writableLocation , standardLocations , and displayName .

Some of the values in this enum represent a user configuration. Such enum values will return the same paths in different applications, so they could be used to share data with other applications. Other values are specific to this application. Each enum value in the table below describes whether it’s application-specific or generic.

Application-specific directories should be assumed to be unreachable by other applications. Therefore, files placed there might not be readable by other applications, even if run by the same user. On the other hand, generic directories should be assumed to be accessible by all applications run by this user, but should still be assumed to be unreachable by applications by other users.

Data interchange with other users is out of the scope of QStandardPaths .

Constant

Description

QStandardPaths.DesktopLocation

Returns the user’s desktop directory. This is a generic value. On systems with no concept of a desktop, this is the same as QStandardPaths::HomeLocation.

QStandardPaths.DocumentsLocation

Returns the directory containing user document files. This is a generic value. The returned path is never empty.

QStandardPaths.FontsLocation

Returns the directory containing user’s fonts. This is a generic value. Note that installing fonts may require additional, platform-specific operations.

QStandardPaths.ApplicationsLocation

Returns the directory containing the user applications (either executables, application bundles, or shortcuts to them). This is a generic value. Note that installing applications may require additional, platform-specific operations. Files, folders or shortcuts in this directory are platform-specific.

QStandardPaths.MusicLocation

Returns the directory containing the user’s music or other audio files. This is a generic value. If no directory specific for music files exists, a sensible fallback for storing user documents is returned.

QStandardPaths.MoviesLocation

Returns the directory containing the user’s movies and videos. This is a generic value. If no directory specific for movie files exists, a sensible fallback for storing user documents is returned.

QStandardPaths.PicturesLocation

Returns the directory containing the user’s pictures or photos. This is a generic value. If no directory specific for picture files exists, a sensible fallback for storing user documents is returned.

QStandardPaths.TempLocation

Returns a directory where temporary files can be stored. The returned value might be application-specific, shared among other applications for this user, or even system-wide. The returned path is never empty.

QStandardPaths.HomeLocation

Returns the user’s home directory (the same as homePath() ). On Unix systems, this is equal to the HOME environment variable. This value might be generic or application-specific, but the returned path is never empty.

QStandardPaths.AppLocalDataLocation

Returns the local settings path on the Windows operating system. On all other platforms, it returns the same value as AppDataLocation. This enum value was added in Qt 5.4.

QStandardPaths.CacheLocation

Returns a directory location where user-specific non-essential (cached) data should be written. This is an application-specific directory. The returned path is never empty.

QStandardPaths.GenericCacheLocation

Returns a directory location where user-specific non-essential (cached) data, shared across applications, should be written. This is a generic value. Note that the returned path may be empty if the system has no concept of shared cache.

QStandardPaths.GenericDataLocation

Returns a directory location where persistent data shared across applications can be stored. This is a generic value. The returned path is never empty.

QStandardPaths.RuntimeLocation

Returns a directory location where runtime communication files should be written, like Unix local sockets. This is a generic value. The returned path may be empty on some systems.

QStandardPaths.ConfigLocation

Returns a directory location where user-specific configuration files should be written. This may be either a generic value or application-specific, and the returned path is never empty.

QStandardPaths.DownloadLocation

Returns a directory for user’s downloaded files. This is a generic value. If no directory specific for downloads exists, a sensible fallback for storing user documents is returned.

QStandardPaths.GenericConfigLocation

Returns a directory location where user-specific configuration files shared between multiple applications should be written. This is a generic value and the returned path is never empty.

QStandardPaths.AppDataLocation

Returns a directory location where persistent application data can be stored. This is an application-specific directory. To obtain a path to store data to be shared with other applications, use QStandardPaths::GenericDataLocation. The returned path is never empty. On the Windows operating system, this returns the roaming path. This enum value was added in Qt 5.4.

QStandardPaths.AppConfigLocation

Returns a directory location where user-specific configuration files should be written. This is an application-specific directory, and the returned path is never empty. This enum value was added in Qt 5.5.

QStandardPaths.PublicShareLocation

Returns a directory location where user-specific publicly shared files and directories can be stored. This is a generic value. Note that the returned path may be empty if the system has no concept of a publicly shared location. This enum value was added in Qt 6.4.

QStandardPaths.TemplatesLocation

Returns a directory location where user-specific template files can be stored. This is a generic value. Note that the returned path may be empty if the system has no concept of a templates location. This enum value was added in Qt 6.4.

Constant	Description
QStandardPaths.DesktopLocation	Returns the user’s desktop directory. This is a generic value. On systems with no concept of a desktop, this is the same as QStandardPaths::HomeLocation.
QStandardPaths.DocumentsLocation	Returns the directory containing user document files. This is a generic value. The returned path is never empty.
QStandardPaths.FontsLocation	Returns the directory containing user’s fonts. This is a generic value. Note that installing fonts may require additional, platform-specific operations.
QStandardPaths.ApplicationsLocation	Returns the directory containing the user applications (either executables, application bundles, or shortcuts to them). This is a generic value. Note that installing applications may require additional, platform-specific operations. Files, folders or shortcuts in this directory are platform-specific.
QStandardPaths.MusicLocation	Returns the directory containing the user’s music or other audio files. This is a generic value. If no directory specific for music files exists, a sensible fallback for storing user documents is returned.
QStandardPaths.MoviesLocation	Returns the directory containing the user’s movies and videos. This is a generic value. If no directory specific for movie files exists, a sensible fallback for storing user documents is returned.
QStandardPaths.PicturesLocation	Returns the directory containing the user’s pictures or photos. This is a generic value. If no directory specific for picture files exists, a sensible fallback for storing user documents is returned.
QStandardPaths.TempLocation	Returns a directory where temporary files can be stored. The returned value might be application-specific, shared among other applications for this user, or even system-wide. The returned path is never empty.
QStandardPaths.HomeLocation	Returns the user’s home directory (the same as `homePath()` ). On Unix systems, this is equal to the HOME environment variable. This value might be generic or application-specific, but the returned path is never empty.
QStandardPaths.AppLocalDataLocation	Returns the local settings path on the Windows operating system. On all other platforms, it returns the same value as AppDataLocation. This enum value was added in Qt 5.4.
QStandardPaths.CacheLocation	Returns a directory location where user-specific non-essential (cached) data should be written. This is an application-specific directory. The returned path is never empty.
QStandardPaths.GenericCacheLocation	Returns a directory location where user-specific non-essential (cached) data, shared across applications, should be written. This is a generic value. Note that the returned path may be empty if the system has no concept of shared cache.
QStandardPaths.GenericDataLocation	Returns a directory location where persistent data shared across applications can be stored. This is a generic value. The returned path is never empty.
QStandardPaths.RuntimeLocation	Returns a directory location where runtime communication files should be written, like Unix local sockets. This is a generic value. The returned path may be empty on some systems.
QStandardPaths.ConfigLocation	Returns a directory location where user-specific configuration files should be written. This may be either a generic value or application-specific, and the returned path is never empty.
QStandardPaths.DownloadLocation	Returns a directory for user’s downloaded files. This is a generic value. If no directory specific for downloads exists, a sensible fallback for storing user documents is returned.
QStandardPaths.GenericConfigLocation	Returns a directory location where user-specific configuration files shared between multiple applications should be written. This is a generic value and the returned path is never empty.
QStandardPaths.AppDataLocation	Returns a directory location where persistent application data can be stored. This is an application-specific directory. To obtain a path to store data to be shared with other applications, use QStandardPaths::GenericDataLocation. The returned path is never empty. On the Windows operating system, this returns the roaming path. This enum value was added in Qt 5.4.
QStandardPaths.AppConfigLocation	Returns a directory location where user-specific configuration files should be written. This is an application-specific directory, and the returned path is never empty. This enum value was added in Qt 5.5.
QStandardPaths.PublicShareLocation	Returns a directory location where user-specific publicly shared files and directories can be stored. This is a generic value. Note that the returned path may be empty if the system has no concept of a publicly shared location. This enum value was added in Qt 6.4.
QStandardPaths.TemplatesLocation	Returns a directory location where user-specific template files can be stored. This is a generic value. Note that the returned path may be empty if the system has no concept of a templates location. This enum value was added in Qt 6.4.

The following table gives examples of paths on different operating systems. The first path is the writable path (unless noted). Other, additional paths, if any, represent non-writable locations.

Path type

macOS

Windows

DesktopLocation

“~/Desktop”

“C:/Users/<USER>/Desktop”

DocumentsLocation

“~/Documents”

“C:/Users/<USER>/Documents”

FontsLocation

“/System/Library/Fonts” (not writable)

“C:/Windows/Fonts” (not writable)

ApplicationsLocation

“/Applications” (not writable)

“C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Start Menu/Programs”

MusicLocation

“~/Music”

“C:/Users/<USER>/Music”

MoviesLocation

“~/Movies”

“C:/Users/<USER>/Videos”

PicturesLocation

“~/Pictures”

“C:/Users/<USER>/Pictures”

TempLocation

randomly generated by the OS

“C:/Users/<USER>/AppData/Local/Temp”

HomeLocation

“~”

“C:/Users/<USER>”

AppLocalDataLocation

“~/Library/Application Support/<APPNAME>”, “/Library/Application Support/<APPNAME>”. “<APPDIR>/../Resources”

“C:/Users/<USER>/AppData/Local/<APPNAME>”, “C:/ProgramData/<APPNAME>”, “<APPDIR>”, “<APPDIR>/data”, “<APPDIR>/data/<APPNAME>”

CacheLocation

“~/Library/Caches/<APPNAME>”, “/Library/Caches/<APPNAME>”

“C:/Users/<USER>/AppData/Local/<APPNAME>/cache”

GenericDataLocation

“~/Library/Application Support”, “/Library/Application Support”

“C:/Users/<USER>/AppData/Local”, “C:/ProgramData”, “<APPDIR>”, “<APPDIR>/data”

RuntimeLocation

“~/Library/Application Support”

“C:/Users/<USER>”

ConfigLocation

“~/Library/Preferences”

“C:/Users/<USER>/AppData/Local/<APPNAME>”, “C:/ProgramData/<APPNAME>”

GenericConfigLocation

“~/Library/Preferences”

“C:/Users/<USER>/AppData/Local”, “C:/ProgramData”

DownloadLocation

“~/Downloads”

“C:/Users/<USER>/Downloads”

GenericCacheLocation

“~/Library/Caches”, “/Library/Caches”

“C:/Users/<USER>/AppData/Local/cache”

AppDataLocation

“~/Library/Application Support/<APPNAME>”, “/Library/Application Support/<APPNAME>”. “<APPDIR>/../Resources”

“C:/Users/<USER>/AppData/Roaming/<APPNAME>”, “C:/ProgramData/<APPNAME>”, “<APPDIR>”, “<APPDIR>/data”, “<APPDIR>/data/<APPNAME>”

AppConfigLocation

“~/Library/Preferences/<APPNAME>”

“C:/Users/<USER>/AppData/Local/<APPNAME>”, “C:/ProgramData/<APPNAME>”

PublicShareLocation

“~/Public”

“C:/Users/Public”

TemplatesLocation

“~/Templates”

“C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Templates”

Path type

Linux and other UNIX operating systems

DesktopLocation

“~/Desktop”

DocumentsLocation

“~/Documents”

FontsLocation

“~/.fonts”, “~/.local/share/fonts”, “/usr/local/share/fonts”, “/usr/share/fonts”

ApplicationsLocation

“~/.local/share/applications”, “/usr/local/share/applications”, “/usr/share/applications”

MusicLocation

“~/Music”

MoviesLocation

“~/Videos”

PicturesLocation

“~/Pictures”

TempLocation

“/tmp”

HomeLocation

“~”

AppLocalDataLocation

“~/.local/share/<APPNAME>”, “/usr/local/share/<APPNAME>”, “/usr/share/<APPNAME>”

CacheLocation

“~/.cache/<APPNAME>”

GenericDataLocation

“~/.local/share”, “/usr/local/share”, “/usr/share”

RuntimeLocation

“/run/user/<USER>”

ConfigLocation

“~/.config”, “/etc/xdg”

GenericConfigLocation

“~/.config”, “/etc/xdg”

DownloadLocation

“~/Downloads”

GenericCacheLocation

“~/.cache”

AppDataLocation

“~/.local/share/<APPNAME>”, “/usr/local/share/<APPNAME>”, “/usr/share/<APPNAME>”

AppConfigLocation

“~/.config/<APPNAME>”, “/etc/xdg/<APPNAME>”

PublicShareLocation

“~/Public”

TemplatesLocation

“~/Templates”

Path type

Android

iOS

DesktopLocation

“<APPROOT>/files”

“<APPROOT>/Documents/Desktop”

DocumentsLocation

“<USER>/Documents” [*], “<USER>/<APPNAME>/Documents”

“<APPROOT>/Documents”

FontsLocation

“/system/fonts” (not writable)

“<APPROOT>/Library/Fonts”

ApplicationsLocation

not supported (directory not readable)

not supported

MusicLocation

“<USER>/Music” [*], “<USER>/<APPNAME>/Music”

“<APPROOT>/Documents/Music”

MoviesLocation

“<USER>/Movies” [*], “<USER>/<APPNAME>/Movies”

“<APPROOT>/Documents/Movies”

PicturesLocation

“<USER>/Pictures” [*], “<USER>/<APPNAME>/Pictures”

“<APPROOT>/Documents/Pictures”, “assets-library://”

TempLocation

“<APPROOT>/cache”

“<APPROOT>/tmp”

HomeLocation

“<APPROOT>/files”

system defined

AppLocalDataLocation

“<APPROOT>/files”, “<USER>/<APPNAME>/files”

“<APPROOT>/Library/Application Support”

CacheLocation

“<APPROOT>/cache”, “<USER>/<APPNAME>/cache”

“<APPROOT>/Library/Caches”

GenericDataLocation

“<USER>” [*] or “<USER>/<APPNAME>/files”

“<APPROOT>/Library/Application Support”

RuntimeLocation

“<APPROOT>/cache”

not supported

ConfigLocation

“<APPROOT>/files/settings”

“<APPROOT>/Library/Preferences”

GenericConfigLocation

“<APPROOT>/files/settings” (there is no shared settings)

“<APPROOT>/Library/Preferences”

DownloadLocation

“<USER>/Downloads” [*], “<USER>/<APPNAME>/Downloads”

“<APPROOT>/Documents/Downloads”

GenericCacheLocation

“<APPROOT>/cache” (there is no shared cache)

“<APPROOT>/Library/Caches”

AppDataLocation

“<APPROOT>/files”, “<USER>/<APPNAME>/files”

“<APPROOT>/Library/Application Support”

AppConfigLocation

“<APPROOT>/files/settings”

“<APPROOT>/Library/Preferences/<APPNAME>”

PublicShareLocation

not supported

not supported

TemplatesLocation

not supported

not supported

Path type	macOS	Windows
DesktopLocation	“~/Desktop”	“C:/Users/<USER>/Desktop”
DocumentsLocation	“~/Documents”	“C:/Users/<USER>/Documents”
FontsLocation	“/System/Library/Fonts” (not writable)	“C:/Windows/Fonts” (not writable)
ApplicationsLocation	“/Applications” (not writable)	“C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Start Menu/Programs”
MusicLocation	“~/Music”	“C:/Users/<USER>/Music”
MoviesLocation	“~/Movies”	“C:/Users/<USER>/Videos”
PicturesLocation	“~/Pictures”	“C:/Users/<USER>/Pictures”
TempLocation	randomly generated by the OS	“C:/Users/<USER>/AppData/Local/Temp”
HomeLocation	“~”	“C:/Users/<USER>”
AppLocalDataLocation	“~/Library/Application Support/<APPNAME>”, “/Library/Application Support/<APPNAME>”. “<APPDIR>/../Resources”	“C:/Users/<USER>/AppData/Local/<APPNAME>”, “C:/ProgramData/<APPNAME>”, “<APPDIR>”, “<APPDIR>/data”, “<APPDIR>/data/<APPNAME>”
CacheLocation	“~/Library/Caches/<APPNAME>”, “/Library/Caches/<APPNAME>”	“C:/Users/<USER>/AppData/Local/<APPNAME>/cache”
GenericDataLocation	“~/Library/Application Support”, “/Library/Application Support”	“C:/Users/<USER>/AppData/Local”, “C:/ProgramData”, “<APPDIR>”, “<APPDIR>/data”
RuntimeLocation	“~/Library/Application Support”	“C:/Users/<USER>”
ConfigLocation	“~/Library/Preferences”	“C:/Users/<USER>/AppData/Local/<APPNAME>”, “C:/ProgramData/<APPNAME>”
GenericConfigLocation	“~/Library/Preferences”	“C:/Users/<USER>/AppData/Local”, “C:/ProgramData”
DownloadLocation	“~/Downloads”	“C:/Users/<USER>/Downloads”
GenericCacheLocation	“~/Library/Caches”, “/Library/Caches”	“C:/Users/<USER>/AppData/Local/cache”
AppDataLocation	“~/Library/Application Support/<APPNAME>”, “/Library/Application Support/<APPNAME>”. “<APPDIR>/../Resources”	“C:/Users/<USER>/AppData/Roaming/<APPNAME>”, “C:/ProgramData/<APPNAME>”, “<APPDIR>”, “<APPDIR>/data”, “<APPDIR>/data/<APPNAME>”
AppConfigLocation	“~/Library/Preferences/<APPNAME>”	“C:/Users/<USER>/AppData/Local/<APPNAME>”, “C:/ProgramData/<APPNAME>”
PublicShareLocation	“~/Public”	“C:/Users/Public”
TemplatesLocation	“~/Templates”	“C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Templates”

Path type	Linux and other UNIX operating systems
DesktopLocation	“~/Desktop”
DocumentsLocation	“~/Documents”
FontsLocation	“~/.fonts”, “~/.local/share/fonts”, “/usr/local/share/fonts”, “/usr/share/fonts”
ApplicationsLocation	“~/.local/share/applications”, “/usr/local/share/applications”, “/usr/share/applications”
MusicLocation	“~/Music”
MoviesLocation	“~/Videos”
PicturesLocation	“~/Pictures”
TempLocation	“/tmp”
HomeLocation	“~”
AppLocalDataLocation	“~/.local/share/<APPNAME>”, “/usr/local/share/<APPNAME>”, “/usr/share/<APPNAME>”
CacheLocation	“~/.cache/<APPNAME>”
GenericDataLocation	“~/.local/share”, “/usr/local/share”, “/usr/share”
RuntimeLocation	“/run/user/<USER>”
ConfigLocation	“~/.config”, “/etc/xdg”
GenericConfigLocation	“~/.config”, “/etc/xdg”
DownloadLocation	“~/Downloads”
GenericCacheLocation	“~/.cache”
AppDataLocation	“~/.local/share/<APPNAME>”, “/usr/local/share/<APPNAME>”, “/usr/share/<APPNAME>”
AppConfigLocation	“~/.config/<APPNAME>”, “/etc/xdg/<APPNAME>”
PublicShareLocation	“~/Public”
TemplatesLocation	“~/Templates”

Path type	Android	iOS
DesktopLocation	“<APPROOT>/files”	“<APPROOT>/Documents/Desktop”
DocumentsLocation	“<USER>/Documents” [*], “<USER>/<APPNAME>/Documents”	“<APPROOT>/Documents”
FontsLocation	“/system/fonts” (not writable)	“<APPROOT>/Library/Fonts”
ApplicationsLocation	not supported (directory not readable)	not supported
MusicLocation	“<USER>/Music” [*], “<USER>/<APPNAME>/Music”	“<APPROOT>/Documents/Music”
MoviesLocation	“<USER>/Movies” [*], “<USER>/<APPNAME>/Movies”	“<APPROOT>/Documents/Movies”
PicturesLocation	“<USER>/Pictures” [*], “<USER>/<APPNAME>/Pictures”	“<APPROOT>/Documents/Pictures”, “assets-library://”
TempLocation	“<APPROOT>/cache”	“<APPROOT>/tmp”
HomeLocation	“<APPROOT>/files”	system defined
AppLocalDataLocation	“<APPROOT>/files”, “<USER>/<APPNAME>/files”	“<APPROOT>/Library/Application Support”
CacheLocation	“<APPROOT>/cache”, “<USER>/<APPNAME>/cache”	“<APPROOT>/Library/Caches”
GenericDataLocation	“<USER>” [*] or “<USER>/<APPNAME>/files”	“<APPROOT>/Library/Application Support”
RuntimeLocation	“<APPROOT>/cache”	not supported
ConfigLocation	“<APPROOT>/files/settings”	“<APPROOT>/Library/Preferences”
GenericConfigLocation	“<APPROOT>/files/settings” (there is no shared settings)	“<APPROOT>/Library/Preferences”
DownloadLocation	“<USER>/Downloads” [*], “<USER>/<APPNAME>/Downloads”	“<APPROOT>/Documents/Downloads”
GenericCacheLocation	“<APPROOT>/cache” (there is no shared cache)	“<APPROOT>/Library/Caches”
AppDataLocation	“<APPROOT>/files”, “<USER>/<APPNAME>/files”	“<APPROOT>/Library/Application Support”
AppConfigLocation	“<APPROOT>/files/settings”	“<APPROOT>/Library/Preferences/<APPNAME>”
PublicShareLocation	not supported	not supported
TemplatesLocation	not supported	not supported

In the table above, <APPNAME> is usually the organization name, the application name, or both, or a unique name generated at packaging. Similarly, <APPROOT> is the location where this application is installed (often a sandbox). <APPDIR> is the directory containing the application executable.

The paths above should not be relied upon, as they may change according to OS configuration, locale, or they may change in future Qt versions.

Note

On Android, applications with open files on the external storage (<USER> locations), will be killed if the external storage is unmounted.

Note

On Android 6.0 (API 23) or higher, the “WRITE_EXTERNAL_STORAGE” permission must be requested at runtime when using writableLocation or standardLocations .

Note

On Android, reading/writing to GenericDataLocation needs the READ_EXTERNAL_STORAGE/WRITE_EXTERNAL_STORAGE permission granted.

Note

[*] On Android 11 and above, public directories are no longer directly accessible in scoped storage mode. Thus, paths of the form "<USER>/DirName" are not returned. Instead, you can use QFileDialog which uses the Storage Access Framework (SAF) to access such directories.

Note

On iOS, if you do pass QStandardPaths::standardLocations(QStandardPaths::PicturesLocation).last() as argument to setDirectory() , a native image picker dialog will be used for accessing the user’s photo album. The filename returned can be loaded using QFile and related APIs. This feature was added in Qt 5.5.

Constant	Description
QStandardPaths.LocateFile	return only files
QStandardPaths.LocateDirectory	return only directories