- class QFileSelector#
QFileSelector
provides a convenient way of selecting file variants. More…Synopsis#
Methods#
def
__init__()
def
allSelectors()
def
extraSelectors()
def
select()
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#
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
QFileSelector
is a convenience for selecting file variants based on platform or device characteristics. This allows you to develop and deploy one codebase containing all the different variants more easily in some circumstances, such as when the correct variant cannot be determined during the deploy step.Using QFileSelector#
If you always use the same file you do not need to use
QFileSelector
.Consider the following example usage, where you want to use different settings files on different locales. You might select code between locales like this:
defaultsBasePath = "data/" defaultsPath = defaultsBasePath + "defaults.conf" localizedPath = defaultsBasePath + QString("%1/defaults.conf").arg(QLocale().name()) if QFile.exists(localizedPath): defaultsPath = localizedPath defaults = QFile(defaultsPath)
Similarly, if you want to pick a different data file based on target platform, your code might look something like this:
defaultsPath = "data/defaults.conf" #if defined(Q_OS_ANDROID) defaultsPath = "data/android/defaults.conf" #elif defined(Q_OS_IOS) defaultsPath = "data/ios/defaults.conf" #endif defaults = QFile(defaultsPath)
QFileSelector
provides a convenient alternative to writing such boilerplate code, and in the latter case it allows you to start using an platform-specific configuration without a recompile.QFileSelector
also allows for chaining of multiple selectors in a convenient way, for example selecting a different file only on certain combinations of platform and locale. For example, to select based on platform and/or locale, the code is as follows:selector = QFileSelector() defaultsFile = QFile(selector.select("data/defaults.conf"))
The files to be selected are placed in directories named with a
'+'
and a selector name. In the above example you could have the platform configurations selected by placing them in the following locations:data/defaults.conf data/+android/defaults.conf data/+ios/+en_GB/defaults.conf
To find selected files,
QFileSelector
looks in the same directory as the base file. If there are any directories of the form +<selector> with an active selector,QFileSelector
will prefer a file with the same file name from that directory over the base file. These directories can be nested to check against multiple selectors, for example:images/background.png images/+android/+en_GB/background.png
With those files available, you would select a different file on the android platform, but only if the locale was en_GB.
For error handling in the case no valid selectors are present, it is recommended to have a default or error-handling file in the base file location even if you expect selectors to be present for all deployments.
In a future version, some may be marked as deploy-time static and be moved during the deployment step as an optimization. As selectors come with a performance cost, it is recommended to avoid their use in circumstances involving performance-critical code.
Adding Selectors#
Selectors normally available are
platform, any of the following strings which match the platform the application is running on (list not exhaustive): android, ios, osx, darwin, mac, macos, linux, qnx, unix, windows. On Linux, if it can be determined, the name of the distribution too, like debian, fedora or opensuse.
locale, same as QLocale().name().
Further selectors will be added from the
QT_FILE_SELECTORS
environment variable, which when set should be a set of comma separated selectors. Note that this variable will only be read once; selectors may not update if the variable changes while the application is running. The initial set of selectors are evaluated only once, on first use.You can also add extra selectors at runtime for custom behavior. These will be used in any future calls to
select()
. If the extra selectors list has been changed, calls toselect()
will use the new list and may return differently.Conflict Resolution when Multiple Selectors Apply#
When multiple selectors could be applied to the same file, the first matching selector is chosen. The order selectors are checked in are:
Selectors set via
setExtraSelectors()
, in the order they are in the listSelectors in the
QT_FILE_SELECTORS
environment variable, from left to rightLocale
Platform
Here is an example involving multiple selectors matching at the same time. It uses platform selectors, plus an extra selector named “admin” is set by the application based on user credentials. The example is sorted so that the lowest matching file would be chosen if all selectors were present:
images/background.png images/+linux/background.png images/+windows/background.png images/+admin/background.png images/+admin/+linux/background.png
Because extra selectors are checked before platform the
+admin/background.png
will be chosen on Windows when the admin selector is set, and+windows/background.png
will be chosen on Windows when the admin selector is not set. On Linux, the+admin/+linux/background.png
will be chosen when admin is set, and the+linux/background.png
when it is not.Create a
QFileSelector
instance. This instance will have the same static selectors as otherQFileSelector
instances, but its own set of extra selectors.If supplied, it will have the given
QObject
parent
.- allSelectors()#
- Return type:
list of strings
Returns the complete, ordered list of selectors used by this instance
- extraSelectors()#
- Return type:
list of strings
Returns the list of extra selectors which have been added programmatically to this instance.
See also
- select(filePath)#
- Parameters:
filePath – str
- Return type:
str
This function returns the selected version of the path, based on the conditions at runtime. If no selectable files are present, returns the original
filePath
.If the original file does not exist, the original
filePath
is returned. This means that you must have a base file to fall back on, you cannot have only files in selectable sub-directories.See the class overview for the selection algorithm.
This is a convenience version of select operating on
QUrl
objects. If the scheme is not file or qrc,filePath
is returned immediately. Otherwise selection is applied to the path offilePath
and aQUrl
is returned with the selected path and otherQUrl
parts the same asfilePath
.See the class overview for the selection algorithm.
- setExtraSelectors(list)#
- Parameters:
list – list of strings
Sets the
list
of extra selectors which have been added programmatically to this instance.These selectors have priority over any which have been automatically picked up.
See also