GLib.Dir

Fields

None

Methods

class	make_tmp (tmpl)
class	open (path, flags)
	close ()
	read_name ()
	ref ()
	rewind ()
	unref ()

Details

class GLib.Dir

An opaque structure representing an opened directory.

classmethod make_tmp(tmpl)

Parameters:

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

Raises:

GLib.Error

Returns:

The actual name used. This string should be freed with GLib.free() when not needed any longer and is is in the GLib file name encoding. In case of errors, None is returned and error will be set.

Return type:

str

Creates a subdirectory in the preferred directory for temporary files (as returned by GLib.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.

New in version 2.30.

classmethod open(path, flags)

Parameters:

• path (str) – the path to the directory you are interested in. On Unix in the on-disk encoding. On Windows in UTF-8

• flags (int) – Currently must be set to 0. Reserved for future use.

Raises:

GLib.Error

Returns:

a newly allocated GLib.Dir on success, None on failure. If non-None, you must free the result with GLib.Dir.close() when you are finished with it.

Return type:

GLib.Dir

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

close()

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 [method`GLib`.Dir.ref] and [method`GLib`.Dir.unref] on a GDir after calling [method`GLib`.Dir.close] on it.

read_name()

Returns:

The entry’s name or None if there are no more entries. The return value is owned by GLib and must not be modified or freed.

Return type:

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()

Returns:

the same pointer as dir

Return type:

GLib.Dir

Increment the reference count of dir.

New in version 2.80.

rewind()

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

unref()

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 [method`GLib`.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 [method`GLib`.Dir.ref] and [method`GLib`.Dir.unref] on a GDir after calling [method`GLib`.Dir.close] on it.

New in version 2.80.