QFileInfo#

The QFileInfo class provides system-independent file information. More

Synopsis#

Functions#

Static functions#

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.

QFileInfo provides information about a file’s name and position (path) in the file system, its access rights and whether it is a directory or symbolic link, etc. The file’s size and last modified/read times are also available. QFileInfo can also be used to obtain information about a Qt resource .

A QFileInfo can point to a file with either a relative or an absolute file path. Absolute file paths begin with the directory separator “/” (or with a drive specification on Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current working directory. An example of an absolute path is the string “/tmp/quartz”. A relative path might look like “src/fatlib”. You can use the function isRelative() to check whether a QFileInfo is using a relative or an absolute file path. You can call the function makeAbsolute() to convert a relative QFileInfo ‘s path to an absolute path.

Note

Paths starting with a colon (:) are always considered absolute, as they denote a QResource .

The file that the QFileInfo works on is set in the constructor or later with setFile() . Use exists() to see if the file exists and size() to get its size.

The file’s type is obtained with isFile() , isDir() and isSymLink() . The symLinkTarget() function provides the name of the file the symlink points to.

Elements of the file’s name can be extracted with path() and fileName() . The fileName() ‘s parts can be extracted with baseName() , suffix() or completeSuffix() . QFileInfo objects to directories created by Qt classes will not have a trailing file separator. If you wish to use trailing separators in your own file info objects, just append one to the file name given to the constructors or setFile() .

Date and time related information are returned by birthTime() , fileTime() , lastModified() , lastRead() , and metadataChangeTime() . Information about access permissions can be obtained with isReadable() , isWritable() , and isExecutable() . Ownership information can be obtained with owner() , ownerId() , group() , and groupId() . You can also examine permissions and ownership in a single statement using the permission() function.

NTFS permissions#

On NTFS file systems, ownership and permissions checking is disabled by default for performance reasons. To enable it, include the following line:

Q_CORE_EXPORT = extern()

Permission checking is then turned on and off by incrementing and decrementing qt_ntfs_permission_lookup by 1.

qt_ntfs_permission_lookup++ # turn checking on
qt_ntfs_permission_lookup-- # turn it off again

Note

Since this is a non-atomic global variable, it is only safe to increment or decrement qt_ntfs_permission_lookup before any threads other than the main thread have started or after every thread other than the main thread has ended.

Note

From Qt 6.6 the variable qt_ntfs_permission_lookup is deprecated. Please use the following alternatives.

The safe and easy way to manage permission checks is to use the RAII class QNtfsPermissionCheckGuard.

def complexFunction():

    QNtfsPermissionCheckGuard permissionGuard # check is enabled
    # do complex things here that need permission check enabled
} // as the guard goes out of scope the check is disabled

If you need more fine-grained control, it is possible to manage the permission with the following functions instead:

qAreNtfsPermissionChecksEnabled() # check status
qEnableNtfsPermissionChecks() # turn checking on
qDisableNtfsPermissionChecks() # turn it off again

Performance Considerations#

Some of QFileInfo ‘s functions query the file system, but for performance reasons, some functions only operate on the file name itself. For example: To return the absolute path of a relative file name, absolutePath() has to query the file system. The path() function, however, can work on the file name directly, and so it is faster.

To speed up performance, QFileInfo also caches information about the file. Because files can be changed by other users or programs, or even by other parts of the same program, there is a function that refreshes the file information: refresh() . If you want to switch off a QFileInfo ‘s caching and force it to access the file system every time you request information from it call setCaching (false). If you want to make sure that all information is read from the file system, use stat() .

birthTime() , fileTime() , lastModified() , lastRead() , and metadataChangeTime() return times in local time by default. Since native file system API typically uses UTC, this requires a conversion. If you don’t actually need the local time, you can avoid this by requesting the time in UTC directly.

Platform Specific Issues#

On Android, some limitations apply when dealing with content URIs :

  • Access permissions might be needed by prompting the user through the QFileDialog which implements Android’s native file picker .

  • Aim to follow the Scoped storage guidelines, such as using app specific directories instead of other public external directories. For more information, also see storage best practices .

  • Due to the design of Qt APIs (e.g. QFile ), it’s not possible to fully integrate the latter APIs with Android’s MediaStore APIs.

See also

QDir QFile

class PySide6.QtCore.QFileInfo#

PySide6.QtCore.QFileInfo(dir, file)

PySide6.QtCore.QFileInfo(file)

PySide6.QtCore.QFileInfo(fileinfo)

PySide6.QtCore.QFileInfo(file)

Parameters:

Constructs an empty QFileInfo object.

Note that an empty QFileInfo object contain no file reference.

See also

setFile()

Constructs a new QFileInfo that gives information about the given file relative to the directory dir.

If dir has a relative path, the QFileInfo will also have a relative path.

If file is an absolute path, then the directory specified by dir will be disregarded.

See also

isRelative()

Constructs a new QFileInfo that gives information about file file.

If the file has a relative path, the QFileInfo will also have a relative path.

See also

isRelative()

Constructs a new QFileInfo that is a copy of the given fileinfo.

Constructs a new QFileInfo that gives information about the given file. The file can also include an absolute or relative path.

PySide6.QtCore.QFileInfo.__reduce__()#
Return type:

object

PySide6.QtCore.QFileInfo.absoluteDir()#
Return type:

PySide6.QtCore.QDir

Returns the file’s absolute path as a QDir object.

PySide6.QtCore.QFileInfo.absoluteFilePath()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns an absolute path including the file name.

The absolute path name consists of the full path and the file name. On Unix this will always begin with the root, ‘/’, directory. On Windows this will always begin ‘D:/’ where D is a drive letter, except for network shares that are not mapped to a drive letter, in which case the path will begin ‘//sharename/’. QFileInfo will uppercase drive letters. Note that QDir does not do this. The code snippet below shows this.

QFileInfo fi("c:/temp/foo"); => fi.absoluteFilePath() => "C:/temp/foo"

This function returns the same as filePath() , unless isRelative() is true. In contrast to canonicalFilePath() , symbolic links or redundant “.” or “..” elements are not necessarily removed.

Warning

If filePath() is empty the behavior of this function is undefined.

PySide6.QtCore.QFileInfo.absolutePath()#
Return type:

str

Returns a file’s path absolute path. This doesn’t include the file name.

On Unix the absolute path will always begin with the root, ‘/’, directory. On Windows this will always begin ‘D:/’ where D is a drive letter, except for network shares that are not mapped to a drive letter, in which case the path will begin ‘//sharename/’.

In contrast to canonicalPath() symbolic links or redundant “.” or “..” elements are not necessarily removed.

Warning

If filePath() is empty the behavior of this function is undefined.

PySide6.QtCore.QFileInfo.baseName()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the base name of the file without the path.

The base name consists of all characters in the file up to (but not including) the first ‘.’ character.

Example:

fi = QFileInfo("/tmp/archive.tar.gz")
base = fi.baseName() # base = "archive"

The base name of a file is computed equally on all platforms, independent of file naming conventions (e.g., “.bashrc” on Unix has an empty base name, and the suffix is “bashrc”).

PySide6.QtCore.QFileInfo.birthTime()#
Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file was created (born), in local time.

If the file birth time is not available, this function returns an invalid QDateTime .

If the file is a symlink, the time of the target file is returned (not the symlink).

This function overloads QFileInfo::birthTime(const QTimeZone &tz), and returns the same as birthTime(QTimeZone::LocalTime).

PySide6.QtCore.QFileInfo.birthTime(tz)
Parameters:

tzPySide6.QtCore.QTimeZone

Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file was created (born).

The returned time is in the time zone specified by tz. For example, you can use LocalTime or UTC to get the time in the Local time zone or UTC, respectively. Since native file system API typically uses UTC, using UTC is often faster, as it does not require any conversions.

If the file birth time is not available, this function returns an invalid QDateTime .

If the file is a symlink, the time of the target file is returned (not the symlink).

See also

lastModified(const QTimeZone &) lastRead(const QTimeZone &) metadataChangeTime(const QTimeZone &) FileTime, const QTimeZone &)

PySide6.QtCore.QFileInfo.bundleName()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the name of the bundle.

On macOS and iOS this returns the proper localized name for a bundle if the path isBundle() . On all other platforms an empty QString is returned.

Example:

fi = QFileInfo("/Applications/Safari.app")
bundle = fi.bundleName() # name = "Safari"
PySide6.QtCore.QFileInfo.caching()#
Return type:

bool

Returns true if caching is enabled; otherwise returns false.

PySide6.QtCore.QFileInfo.canonicalFilePath()#
Return type:

str

Returns the canonical path including the file name, i.e. an absolute path without symbolic links or redundant “.” or “..” elements.

If the file does not exist, canonicalFilePath() returns an empty string.

PySide6.QtCore.QFileInfo.canonicalPath()#
Return type:

str

Returns the file’s path canonical path (excluding the file name), i.e. an absolute path without symbolic links or redundant “.” or “..” elements.

If the file does not exist, canonicalPath() returns an empty string.

PySide6.QtCore.QFileInfo.completeBaseName()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the complete base name of the file without the path.

The complete base name consists of all characters in the file up to (but not including) the last ‘.’ character.

Example:

fi = QFileInfo("/tmp/archive.tar.gz")
base = fi.completeBaseName() # base = "archive.tar"
PySide6.QtCore.QFileInfo.completeSuffix()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the complete suffix (extension) of the file.

The complete suffix consists of all characters in the file after (but not including) the first ‘.’.

Example:

fi = QFileInfo("/tmp/archive.tar.gz")
ext = fi.completeSuffix() # ext = "tar.gz"
PySide6.QtCore.QFileInfo.dir()#
Return type:

PySide6.QtCore.QDir

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the path of the object’s parent directory as a QDir object.

Note

The QDir returned always corresponds to the object’s parent directory, even if the QFileInfo represents a directory.

For each of the following, dir() returns the QDir "~/examples/191697".

fileInfo1 = QFileInfo("~/examples/191697/.")
fileInfo2 = QFileInfo("~/examples/191697/..")
fileInfo3 = QFileInfo("~/examples/191697/main.cpp")

For each of the following, dir() returns the QDir ".".

fileInfo4 = QFileInfo(".")
fileInfo5 = QFileInfo("..")
fileInfo6 = QFileInfo("main.cpp")
PySide6.QtCore.QFileInfo.exists()#
Return type:

bool

Returns true if the file exists; otherwise returns false.

Note

If the file is a symlink that points to a non-existing file, false is returned.

static PySide6.QtCore.QFileInfo.exists(file)
Parameters:

file – str

Return type:

bool

Returns true if the file exists; otherwise returns false.

Note

If file is a symlink that points to a non-existing file, false is returned.

Note

Using this function is faster than using QFileInfo(file).exists() for file system access.

PySide6.QtCore.QFileInfo.fileName()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the name of the file, excluding the path.

Example:

fi = QFileInfo("/tmp/archive.tar.gz")
name = fi.fileName() # name = "archive.tar.gz"

Note that, if this QFileInfo object is given a path ending in a slash, the name of the file is considered empty.

PySide6.QtCore.QFileInfo.filePath()#
Return type:

str

Returns the file name, including the path (which may be absolute or relative).

PySide6.QtCore.QFileInfo.fileTime(time)#
Parameters:

timeFileTime

Return type:

PySide6.QtCore.QDateTime

Returns the file time specified by time.

If the time cannot be determined, an invalid date time is returned.

If the file is a symlink, the time of the target file is returned (not the symlink).

This function overloads FileTime, const QTimeZone &) , and returns the same as fileTime(time, QTimeZone::LocalTime).

PySide6.QtCore.QFileInfo.fileTime(time, tz)
Parameters:
Return type:

PySide6.QtCore.QDateTime

Returns the file time specified by time.

The returned time is in the time zone specified by tz. For example, you can use LocalTime or UTC to get the time in the Local time zone or UTC, respectively. Since native file system API typically uses UTC, using UTC is often faster, as it does not require any conversions.

If the time cannot be determined, an invalid date time is returned.

If the file is a symlink, the time of the target file is returned (not the symlink).

See also

birthTime(const QTimeZone &) lastModified(const QTimeZone &) lastRead(const QTimeZone &) metadataChangeTime(const QTimeZone &) isValid()

PySide6.QtCore.QFileInfo.group()#
Return type:

str

Returns the group of the file. On Windows, on systems where files do not have groups, or if an error occurs, an empty string is returned.

This function can be time consuming under Unix (in the order of milliseconds).

If the file is a symlink, this function returns the owning group of the target (not the symlink).

PySide6.QtCore.QFileInfo.groupId()#
Return type:

int

Returns the id of the group the file belongs to.

On Windows and on systems where files do not have groups this function always returns (uint) -2.

If the file is a symlink, this function returns the id of the group owning the target (not the symlink).

PySide6.QtCore.QFileInfo.isAbsolute()#
Return type:

bool

Returns true if the file path is absolute, otherwise returns false (i.e. the path is relative).

Note

Paths starting with a colon (:) are always considered absolute, as they denote a QResource .

See also

isRelative()

PySide6.QtCore.QFileInfo.isAlias()#
Return type:

bool

Returns true if this object points to an alias; otherwise returns false.

Aliases only exist on macOS. They are treated as regular files, so opening an alias will open the file itself. In order to open the file or directory an alias references use symLinkTarget() .

Note

Even if an alias points to a non existing file, isAlias() returns true.

PySide6.QtCore.QFileInfo.isBundle()#
Return type:

bool

Returns true if this object points to a bundle or to a symbolic link to a bundle on macOS and iOS; otherwise returns false.

If the file is a symlink, this function returns true if the target is a bundle (not the symlink).

PySide6.QtCore.QFileInfo.isDir()#
Return type:

bool

Returns true if this object points to a directory or to a symbolic link to a directory. Returns false if the object points to something that is not a directory (such as a file) or that does not exist.

If the file is a symlink, this function returns true if the target is a directory (not the symlink).

PySide6.QtCore.QFileInfo.isExecutable()#
Return type:

bool

Returns true if the file is executable; otherwise returns false.

If the file is a symlink, this function returns true if the target is executable (not the symlink).

PySide6.QtCore.QFileInfo.isFile()#
Return type:

bool

Returns true if this object points to a file or to a symbolic link to a file. Returns false if the object points to something that is not a file (such as a directory) or that does not exist.

If the file is a symlink, this function returns true if the target is a regular file (not the symlink).

PySide6.QtCore.QFileInfo.isHidden()#
Return type:

bool

Returns true if this is a `hidden’ file; otherwise returns false.

Note

This function returns true for the special entries “.” and “..” on Unix, even though entryList threats them as shown. And note that, since this function inspects the file name, on Unix it will inspect the name of the symlink, if this file is a symlink, not the target’s name.

On Windows, this function returns true if the target file is hidden (not the symlink).

PySide6.QtCore.QFileInfo.isJunction()#
Return type:

bool

Returns true if the object points to a junction; otherwise returns false.

Junctions only exist on Windows’ NTFS file system, and are typically created by the mklink command. They can be thought of as symlinks for directories, and can only be created for absolute paths on the local volume.

PySide6.QtCore.QFileInfo.isNativePath()#
Return type:

bool

Returns true if the file path can be used directly with native APIs. Returns false if the file is otherwise supported by a virtual file system inside Qt, such as the Qt Resource System .

Note

Native paths may still require conversion of path separators and character encoding, depending on platform and input requirements of the native API.

PySide6.QtCore.QFileInfo.isReadable()#
Return type:

bool

Returns true if the user can read the file; otherwise returns false.

If the file is a symlink, this function returns true if the target is readable (not the symlink).

Note

If the NTFS permissions check has not been enabled, the result on Windows will merely reflect whether the file exists.

PySide6.QtCore.QFileInfo.isRelative()#
Return type:

bool

Returns true if the file path is relative, otherwise returns false (i.e. the path is absolute). (E.g. under Unix a path is absolute if it begins with a “/”).

Note

Paths starting with a colon (:) are always considered absolute, as they denote a QResource .

See also

isAbsolute()

PySide6.QtCore.QFileInfo.isRoot()#
Return type:

bool

Returns true if the object points to a directory or to a symbolic link to a directory, and that directory is the root directory; otherwise returns false.

PySide6.QtCore.QFileInfo.isShortcut()#
Return type:

bool

Returns true if this object points to a shortcut; otherwise returns false.

Shortcuts only exist on Windows and are typically .lnk files. For instance, true will be returned for shortcuts (*.lnk files) on Windows, but false will be returned on Unix (including macOS and iOS).

The shortcut (.lnk) files are treated as regular files. Opening those will open the .lnk file itself. In order to open the file a shortcut references to, it must uses symLinkTarget() on a shortcut.

Note

Even if a shortcut (broken shortcut) points to a non existing file, isShortcut() returns true.

Return type:

bool

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns true if this object points to a symbolic link, shortcut, or alias; otherwise returns false.

Symbolic links exist on Unix (including macOS and iOS) and Windows and are typically created by the ln -s or mklink commands, respectively. Opening a symbolic link effectively opens the link's target .

In addition, true will be returned for shortcuts (*.lnk files) on Windows, and aliases on macOS. This behavior is deprecated and will likely change in a future version of Qt. Opening a shortcut or alias will open the .lnk or alias file itself.

Example:

info = QFileInfo(fileName)
if info.isSymLink():
    fileName = info.symLinkTarget()

Note

If the symlink points to a non existing file, exists() returns false.

Return type:

bool

Returns true if this object points to a symbolic link; otherwise returns false.

Symbolic links exist on Unix (including macOS and iOS) and Windows (NTFS-symlink) and are typically created by the ln -s or mklink commands, respectively.

Unix handles symlinks transparently. Opening a symbolic link effectively opens the link's target .

In contrast to isSymLink() , false will be returned for shortcuts (*.lnk files) on Windows and aliases on macOS. Use isShortcut() and isAlias() instead.

Note

If the symlink points to a non existing file, exists() returns false.

PySide6.QtCore.QFileInfo.isWritable()#
Return type:

bool

Returns true if the user can write to the file; otherwise returns false.

If the file is a symlink, this function returns true if the target is writeable (not the symlink).

Note

If the NTFS permissions check has not been enabled, the result on Windows will merely reflect whether the file is marked as Read Only.

PySide6.QtCore.QFileInfo.junctionTarget()#
Return type:

str

Resolves an NTFS junction to the path it references.

Returns the absolute path to the directory an NTFS junction points to, or an empty string if the object is not an NTFS junction.

There is no guarantee that the directory named by the NTFS junction actually exists.

PySide6.QtCore.QFileInfo.lastModified()#
Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file was last modified.

If the file is a symlink, the time of the target file is returned (not the symlink).

This function overloads lastModified(const QTimeZone &) , and returns the same as lastModified(QTimeZone::LocalTime).

PySide6.QtCore.QFileInfo.lastModified(tz)
Parameters:

tzPySide6.QtCore.QTimeZone

Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file was last modified.

The returned time is in the time zone specified by tz. For example, you can use LocalTime or UTC to get the time in the Local time zone or UTC, respectively. Since native file system API typically uses UTC, using UTC is often faster, as it does not require any conversions.

If the file is a symlink, the time of the target file is returned (not the symlink).

See also

birthTime(const QTimeZone &) lastRead(const QTimeZone &) metadataChangeTime(const QTimeZone &) FileTime, const QTimeZone &)

PySide6.QtCore.QFileInfo.lastRead()#
Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file was last read (accessed).

On platforms where this information is not available, returns the same time as lastModified() .

If the file is a symlink, the time of the target file is returned (not the symlink).

This function overloads lastRead(const QTimeZone &) , and returns the same as lastRead(QTimeZone::LocalTime).

PySide6.QtCore.QFileInfo.lastRead(tz)
Parameters:

tzPySide6.QtCore.QTimeZone

Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file was last read (accessed).

The returned time is in the time zone specified by tz. For example, you can use LocalTime or UTC to get the time in the Local time zone or UTC, respectively. Since native file system API typically uses UTC, using UTC is often faster, as it does not require any conversions.

On platforms where this information is not available, returns the same time as lastModified() .

If the file is a symlink, the time of the target file is returned (not the symlink).

See also

birthTime(const QTimeZone &) lastModified(const QTimeZone &) metadataChangeTime(const QTimeZone &) FileTime, const QTimeZone &)

PySide6.QtCore.QFileInfo.makeAbsolute()#
Return type:

bool

Converts the file’s path to an absolute path if it is not already in that form. Returns true to indicate that the path was converted; otherwise returns false to indicate that the path was already absolute.

PySide6.QtCore.QFileInfo.metadataChangeTime()#
Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file’s metadata was last changed, in local time.

A metadata change occurs when the file is first created, but it also occurs whenever the user writes or sets inode information (for example, changing the file permissions).

If the file is a symlink, the time of the target file is returned (not the symlink).

This function overloads QFileInfo::metadataChangeTime(const QTimeZone &tz), and returns the same as metadataChangeTime(QTimeZone::LocalTime).

PySide6.QtCore.QFileInfo.metadataChangeTime(tz)
Parameters:

tzPySide6.QtCore.QTimeZone

Return type:

PySide6.QtCore.QDateTime

Returns the date and time when the file’s metadata was last changed. A metadata change occurs when the file is first created, but it also occurs whenever the user writes or sets inode information (for example, changing the file permissions).

The returned time is in the time zone specified by tz. For example, you can use LocalTime or UTC to get the time in the Local time zone or UTC, respectively. Since native file system API typically uses UTC, using UTC is often faster, as it does not require any conversions.

If the file is a symlink, the time of the target file is returned (not the symlink).

See also

birthTime(const QTimeZone &) lastModified(const QTimeZone &) lastRead(const QTimeZone &) FileTime time, const QTimeZone &)

PySide6.QtCore.QFileInfo.__ne__(fileinfo)#
Parameters:

fileinfoPySide6.QtCore.QFileInfo

Return type:

bool

Returns true if this QFileInfo object refers to a different file than the one specified by fileinfo; otherwise returns false.

See also

operator==()

PySide6.QtCore.QFileInfo.__eq__(fileinfo)#
Parameters:

fileinfoPySide6.QtCore.QFileInfo

Return type:

bool

Returns true if this QFileInfo object refers to a file in the same location as fileinfo; otherwise returns false.

Note that the result of comparing two empty QFileInfo objects, containing no file references (file paths that do not exist or are empty), is undefined.

Warning

This will not compare two different symbolic links pointing to the same file.

Warning

Long and short file names that refer to the same file on Windows are treated as if they referred to different files.

See also

operator!=()

PySide6.QtCore.QFileInfo.owner()#
Return type:

str

Returns the owner of the file. On systems where files do not have owners, or if an error occurs, an empty string is returned.

This function can be time consuming under Unix (in the order of milliseconds). On Windows, it will return an empty string unless the NTFS permissions check has been enabled.

If the file is a symlink, this function returns the owner of the target (not the symlink).

PySide6.QtCore.QFileInfo.ownerId()#
Return type:

int

Returns the id of the owner of the file.

On Windows and on systems where files do not have owners this function returns ((uint) -2).

If the file is a symlink, this function returns the id of the owner of the target (not the symlink).

PySide6.QtCore.QFileInfo.path()#
Return type:

str

Returns the file’s path. This doesn’t include the file name.

Note that, if this QFileInfo object is given a path ending in a slash, the name of the file is considered empty and this function will return the entire path.

PySide6.QtCore.QFileInfo.permission(permissions)#
Parameters:

permissions – Combination of QFileDevice.Permission

Return type:

bool

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Tests for file permissions. The permissions argument can be several flags of type QFile::Permissions OR-ed together to check for permission combinations.

On systems where files do not have permissions this function always returns true.

Note

The result might be inaccurate on Windows if the NTFS permissions check has not been enabled.

Example:

fi = QFileInfo("/tmp/archive.tar.gz")
if fi.permission(QFile.WriteUser | QFile.ReadGroup):
    qWarning("I can change the file; my group can read the file")
if fi.permission(QFile.WriteGroup | QFile.WriteOther):
    qWarning("The group or others can change the file")

If the file is a symlink, this function checks the permissions of the target (not the symlink).

PySide6.QtCore.QFileInfo.permissions()#
Return type:

Combination of QFileDevice.Permission

Returns the complete OR-ed together combination of QFile::Permissions for the file.

Note

The result might be inaccurate on Windows if the NTFS permissions check has not been enabled.

If the file is a symlink, this function returns the permissions of the target (not the symlink).

Return type:

str

Read the path the symlink references.

Returns the raw path referenced by the symbolic link, without resolving a relative path relative to the directory containing the symbolic link. The returned string will only be an absolute path if the symbolic link actually references it as such. Returns an empty string if the object is not a symbolic link.

PySide6.QtCore.QFileInfo.refresh()#

Refreshes the information about the file, i.e. reads in information from the file system the next time a cached property is fetched.

PySide6.QtCore.QFileInfo.setCaching(on)#
Parameters:

on – bool

If enable is true, enables caching of file information. If enable is false caching is disabled.

When caching is enabled, QFileInfo reads the file information from the file system the first time it’s needed, but generally not later.

Caching is enabled by default.

See also

refresh() caching()

PySide6.QtCore.QFileInfo.setFile(dir, file)#
Parameters:

This is an overloaded function.

Sets the file that the QFileInfo provides information about to file in directory dir.

If file includes a relative path, the QFileInfo will also have a relative path.

See also

isRelative()

PySide6.QtCore.QFileInfo.setFile(file)
Parameters:

filePySide6.QtCore.QFileDevice

This is an overloaded function.

Sets the file that the QFileInfo provides information about to file.

If file includes a relative path, the QFileInfo will also have a relative path.

See also

isRelative()

PySide6.QtCore.QFileInfo.setFile(file)
Parameters:

file – str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Sets the file that the QFileInfo provides information about to file.

The file can also include an absolute or relative file path. Absolute paths begin with the directory separator (e.g. “/” under Unix) or a drive specification (under Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current directory.

Example:

info = QFileInfo("/usr/bin/env")
path = info.absolutePath() # path = /usr/bin
base = info.baseName() # base = env
info.setFile("/etc/hosts")
path = info.absolutePath() # path = /etc
base = info.baseName() # base = hosts
PySide6.QtCore.QFileInfo.size()#
Return type:

int

Returns the file size in bytes. If the file does not exist or cannot be fetched, 0 is returned.

If the file is a symlink, the size of the target file is returned (not the symlink).

See also

exists()

PySide6.QtCore.QFileInfo.stat()#

Reads all attributes from the file system.

This is useful when information about the file system is collected in a worker thread, and then passed to the UI in the form of caching QFileInfo instances.

PySide6.QtCore.QFileInfo.suffix()#
Return type:

str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the suffix (extension) of the file.

The suffix consists of all characters in the file after (but not including) the last ‘.’.

Example:

fi = QFileInfo("/tmp/archive.tar.gz")
ext = fi.suffix() # ext = "gz"

The suffix of a file is computed equally on all platforms, independent of file naming conventions (e.g., “.bashrc” on Unix has an empty base name, and the suffix is “bashrc”).

PySide6.QtCore.QFileInfo.swap(other)#
Parameters:

otherPySide6.QtCore.QFileInfo

Swaps this file info with other. This function is very fast and never fails.

PySide6.QtCore.QFileInfo.symLinkTarget()#
Return type:

str

Returns the absolute path to the file or directory a symbolic link points to, or an empty string if the object isn’t a symbolic link.

This name may not represent an existing file; it is only a string. exists() returns true if the symlink points to an existing file.