QDirIterator¶

PyQt5.QtCore.QDirIterator

Description¶

The QDirIterator class provides an iterator for directory entrylists.

You can use QDirIterator to navigate entries of a directory one at a time. It is similar to entryList() and entryInfoList(), but because it lists entries one at a time instead of all at once, it scales better and is more suitable for large directories. It also supports listing directory contents recursively, and following symbolic links. Unlike entryList(), QDirIterator does not support sorting.

The QDirIterator constructor takes a QDir or a directory as argument. After construction, the iterator is located before the first directory entry. Here’s how to iterate over all the entries sequentially:

# QDirIterator it("/etc", QDirIterator::Subdirectories);
# while (it.hasNext()) {
#     qDebug() << it.next();

#     // /etc/.
#     // /etc/..
#     // /etc/X11
#     // /etc/X11/fs
#     // ...
# }

Here’s how to find and read all files filtered by name, recursively:

# QDirIterator it("/sys", QStringList() << "scaling_cur_freq", QDir::NoFilter, QDirIterator::Subdirectories);
# while (it.hasNext()) {
#     QFile f(it.next());
#     f.open(QIODevice::ReadOnly);
#     qDebug() << f.fileName() << f.readAll().trimmed().toDouble() / 1000 << "MHz";
# }

The next() function returns the path to the next directory entry and advances the iterator. You can also call filePath() to get the current file path without advancing the iterator. The fileName() function returns only the name of the file, similar to how entryList() works. You can also call fileInfo() to get a QFileInfo for the current entry.

Unlike Qt’s container iterators, QDirIterator is uni-directional (i.e., you cannot iterate directories in reverse order) and does not allow random access.

See also

QDir, entryList().

Classes¶

IteratorFlags

Enums¶

IteratorFlag

This enum describes flags that you can combine to configure the behavior of QDirIterator.

Member	Value	Description
FollowSymlinks	0x1	When combined with Subdirectories, this flag enables iterating through all subdirectories of the assigned path, following all symbolic links. Symbolic link loops (e.g., “link” => “.” or “link” => “..”) are automatically detected and ignored.
NoIteratorFlags	0x0	The default value, representing no flags. The iterator will return entries for the assigned path.
Subdirectories	0x2	List entries inside all subdirectories as well.

Methods¶

__init__(QDir, flags: IteratorFlags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over dir’s entrylist, using dir’s name filters and regular filters. You can pass options via flags to decide how the directory should be iterated.

By default, flags is NoIteratorFlags, which provides the same behavior as in entryList().

The sorting in dir is ignored.

Note: To list symlinks that point to non existing files, System must be passed to the flags.

See also

hasNext(), next(), IteratorFlags.

__init__(str, flags: IteratorFlags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over path. You can pass options via flags to decide how the directory should be iterated.

By default, flags is NoIteratorFlags, which provides the same behavior as in entryList().

Note: To list symlinks that point to non existing files, System must be passed to the flags.

See also

hasNext(), next(), IteratorFlags.

__init__(str, Filters, flags: IteratorFlags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over path, with no name filtering and filters for entry filtering. You can pass options via flags to decide how the directory should be iterated.

By default, filters is NoFilter, and flags is NoIteratorFlags, which provides the same behavior as in entryList().

Note: To list symlinks that point to non existing files, System must be passed to the flags.

See also

hasNext(), next(), IteratorFlags.

__init__(str, Iterable[str], filters: Filters = NoFilter, flags: IteratorFlags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over path, using nameFilters and filters. You can pass options via flags to decide how the directory should be iterated.

By default, flags is NoIteratorFlags, which provides the same behavior as entryList().

Note: To list symlinks that point to non existing files, System must be passed to the flags.

See also

hasNext(), next(), IteratorFlags.

fileInfo() → QFileInfo: Returns a QFileInfo for the current directory entry.

See also

filePath(), fileName().

fileName() → str

Returns the file name for the current directory entry, without the path prepended.

This function is convenient when iterating a single directory. When using the Subdirectories flag, you can use filePath() to get the full path.

See also

filePath(), fileInfo().

filePath() → str: Returns the full file path for the current directory entry.

See also

fileInfo(), fileName().

hasNext() → bool: Returns true if there is at least one more entry in the directory; otherwise, false is returned.

See also

next(), fileName(), filePath(), fileInfo().

next() → str

Advances the iterator to the next entry, and returns the file path of this new entry. If hasNext() returns false, this function does nothing, and returns an empty QString.

You can call fileName() or filePath() to get the current entry file name or path, or fileInfo() to get a QFileInfo for the current entry.

path() → str: Returns the base directory of the iterator.