Toplevel package

This is the documentation for the toplevel ignis package.

Important

The toplevel package doesn't export the version. To get Ignis version use the ignis._version module instead, which contains __version__ and __version_tuple__ variables.

ignis.is_sphinx_build: bool = True

Whether Ignis is imported during the Sphinx documentation build.

ignis.is_editable_install: bool = False

Whether Ignis is installed in editable mode.

ignis.TEMP_DIR = '/tmp/ignis-deprecated-temp'

The random temporary directory for this Ignis instance.

Deprecated since version 0.6: Use get_temp_dir() instead.

ignis.CACHE_DIR = '$XDG_CACHE_HOME/ignis'

The cache directory, equals $XDG_CACHE_HOME/ignis.

ignis.DATA_DIR = '$XDG_DATA_HOME/ignis'

The data directory, equals $XDG_DATA_HOME/ignis.

ignis.is_girepository_2_0: bool = False

Whether libgirepository-2.0 is being used (True for PyGObject 3.51.0 and higher). Always equals False during the Sphinx doc build.

ignis.get_temp_dir() → str

Get the temporary directory for this Ignis instance. Create if it doesn't exist, otherwise return the existing one.

Return type:

str

Returns:

The temporary directory for this Ignis instance.