PySide6.QtCore.QStorageInfo¶

class QStorageInfo¶

Provides information about currently mounted storage and drives. More…

Synopsis¶

Methods¶

def __init__()
def blockSize()
def bytesAvailable()
def bytesFree()
def bytesTotal()
def device()
def displayName()
def fileSystemType()
def isReadOnly()
def isReady()
def isRoot()
def isValid()
def name()
def __ne__()
def __eq__()
def refresh()
def rootPath()
def setPath()
def subvolume()
def swap()

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.

Allows retrieving information about the volume’s space, its mount point, label, and filesystem name.

You can create an instance of QStorageInfo by passing the path to the volume’s mount point as a constructor parameter, or you can set it using the setPath() method. The static mountedVolumes() method can be used to get the list of all mounted filesystems.

QStorageInfo always caches the retrieved information, but you can call refresh() to invalidate the cache.

The following example retrieves the most common information about the root volume of the system, and prints information about it.

storage = QStorageInfo.root()
print(storage.rootPath())
if storage.isReadOnly():
    print("isReadOnly:", storage.isReadOnly())
print("name:", storage.name())
print("fileSystemType:", storage.fileSystemType())
print("size:", storage.bytesTotal()/1000/1000, "MB")
print("availableSize:", storage.bytesAvailable()/1000/1000, "MB")

__init__()¶

Constructs an empty QStorageInfo object.

Objects created with the default constructor will be invalid and therefore not ready for use.

See also

setPath() isReady() isValid()

__init__(dir)

Parameters:: dir – QDir

Constructs a new QStorageInfo object that gives information about the volume containing the dir folder.

__init__(other)

Parameters:: other – QStorageInfo

Constructs a new QStorageInfo object that is a copy of the other QStorageInfo object.

__init__(path)

Parameters:: path – str

Warning

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

Constructs a new QStorageInfo object that gives information about the volume mounted at path.

If you pass a directory or file, the QStorageInfo object will refer to the volume where this directory or file is located. You can check if the created object is correct using the isValid() method.

The following example shows how to get the volume on which the application is located. It is recommended to always check that the volume is ready and valid.

storage = QStorageInfo(qApp.applicationDirPath())
if storage.isValid() and storage.isReady():
    # ...

See also

setPath()

blockSize()¶

Return type:: int

Returns the optimal transfer block size for this filesystem.

Returns -1 if QStorageInfo could not determine the size or if the QStorageInfo object is not valid.

bytesAvailable()¶

Return type:: int

Returns the size (in bytes) available for the current user. It returns the total size available if the user is the root user or a system administrator.

This size can be less than or equal to the free size returned by bytesFree() function.

Returns -1 if QStorageInfo object is not valid.

See also

bytesTotal() bytesFree()

bytesFree()¶

Return type:: int

Returns the number of free bytes in a volume. Note that if there are quotas on the filesystem, this value can be larger than the value returned by bytesAvailable() .

Returns -1 if QStorageInfo object is not valid.

See also

bytesTotal() bytesAvailable()

bytesTotal()¶

Return type:: int

Returns the total volume size in bytes.

Returns -1 if QStorageInfo object is not valid.

See also

bytesFree() bytesAvailable()

device()¶

Return type:: QByteArray

Returns the device for this volume.

For example, on Unix filesystems (including macOS), this returns the devpath like /dev/sda0 for local storages. On Windows, it returns the UNC path starting with \\\\?\\ for local storages (in other words, the volume GUID).

See also

rootPath() subvolume()

displayName()¶

Return type:: str

Returns the volume’s name, if available, or the root path if not.

fileSystemType()¶

Return type:: QByteArray

Returns the type name of the filesystem.

This is a platform-dependent function, and filesystem names can vary between different operating systems. For example, on Windows filesystems they can be named NTFS, and on Linux they can be named ntfs-3g or fuseblk.

See also

name()

isReadOnly()¶

Return type:: bool

Returns true if the current filesystem is protected from writing; false otherwise.

isReady()¶

Return type:: bool

Returns true if the current filesystem is ready to work; false otherwise. For example, false is returned if the CD volume is not inserted.

Note that fileSystemType() , name() , bytesTotal() , bytesFree() , and bytesAvailable() will return invalid data until the volume is ready.

See also

isValid()

isRoot()¶

Return type:: bool

Returns true if this QStorageInfo represents the system root volume; false otherwise.

On Unix filesystems, the root volume is a volume mounted on /. On Windows, the root volume is the volume where the OS is installed.

See also

root()

isValid()¶

Return type:: bool

Returns true if the QStorageInfo specified by rootPath exists and is mounted correctly.

See also

isReady()

static mountedVolumes()¶

Return type:: .list of QStorageInfo

Warning

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

Returns the list of QStorageInfo objects that corresponds to the list of currently mounted filesystems.

On Windows, this returns the drives visible in the My Computer folder. On Unix operating systems, it returns the list of all mounted filesystems (except for pseudo filesystems).

Returns all currently mounted filesystems by default.

The example shows how to retrieve all available filesystems, skipping read-only ones.

for storage in QStorageInfo.mountedVolumes():
    if storage.isValid() and storage.isReady():
        if not storage.isReadOnly():
            # ...