GLib.Dir¶

record (struct)

An opaque structure representing an opened directory.

Constructors¶

open¶

@classmethod
def open(cls, path: str, flags: int) -> Dir

Opens a directory for reading. The names of the files in the directory can then be retrieved using Dir.read_name. Note that the ordering is not defined.

Parameters:

path — the path to the directory you are interested in. On Unix in the on-disk encoding. On Windows in UTF-8
flags — Currently must be set to 0. Reserved for future use.

Methods¶

close¶

def close(self) -> None

Closes the directory immediately and decrements the reference count.

Once the reference count reaches zero, the GDir structure itself will be freed. Prior to GLib 2.80, GDir was not reference counted.

It is an error to call any of the GDir methods other than Dir.ref and Dir.unref on a GDir after calling Dir.close on it.

read_name¶

def read_name(self) -> str

Retrieves the name of another entry in the directory, or None. The order of entries returned from this function is not defined, and may vary by file system or other operating-system dependent factors.

None may also be returned in case of errors. On Unix, you can check errno to find out if None was returned because of an error.

On Unix, the '.' and '..' entries are omitted, and the returned name is in the on-disk encoding.

On Windows, as is true of all GLib functions which operate on filenames, the returned name is in UTF-8.

ref¶

def ref(self) -> Dir

Increment the reference count of dir.

rewind¶

def rewind(self) -> None

Resets the given directory. The next call to Dir.read_name will return the first entry again.

unref¶

def unref(self) -> None

Decrements the reference count of dir.

Once the reference count reaches zero, the directory will be closed and all resources associated with it will be freed. If Dir.close is called when the reference count is greater than zero, the directory is closed but the GDir structure will not be freed until its reference count reaches zero.

It is an error to call any of the GDir methods other than Dir.ref and Dir.unref on a GDir after calling Dir.close on it.

Static functions¶

make_tmp¶

@staticmethod
def make_tmp(tmpl: str | bytes | os.PathLike[str] | os.PathLike[bytes] | None = ...) -> str

Creates a subdirectory in the preferred directory for temporary files (as returned by get_tmp_dir).

tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, as the parameter to g_mkstemp(). However, unlike these functions, the template should only be a basename, no directory components are allowed. If template is None, a default template is used.

Note that in contrast to g_mkdtemp() (and mkdtemp()) tmpl is not modified, and might thus be a read-only literal string.

Parameters:

tmpl — Template for directory name, as in g_mkdtemp(), basename only, or None for a default template