SettingsSchemaSource

Added in version 2.32.

class SettingsSchemaSource(*args, **kwargs)

This is an opaque structure type. You may not access it directly.

Constructors

class SettingsSchemaSource
classmethod new_from_directory(directory: str, parent: SettingsSchemaSource | None, trusted: bool) → SettingsSchemaSource

Attempts to create a new schema source corresponding to the contents of the given directory.

This function is not required for normal uses of Settings but it may be useful to authors of plugin management systems.

The directory should contain a file called gschemas.compiled as produced by the [glib-compile-schemas][glib-compile-schemas] tool.

If trusted is True then gschemas.compiled is trusted not to be corrupted. This assumption has a performance advantage, but can result in crashes or inconsistent behaviour in the case of a corrupted file. Generally, you should set trusted to True for files installed by the system and to False for files in the home directory.

In either case, an empty file or some types of corruption in the file will result in %G_FILE_ERROR_INVAL being returned.

If parent is non-None then there are two effects.

First, if lookup() is called with the recursive flag set to True and the schema can not be found in the source, the lookup will recurse to the parent.

Second, any references to other schemas specified within this source (ie: child or extends) references may be resolved from the parent.

For this second reason, except in very unusual situations, the parent should probably be given as the default schema source, as returned by get_default().

Added in version 2.32.

Parameters:

  • directory – the filename of a directory

  • parent – a SettingsSchemaSource, or None

  • trusted – True, if the directory is trusted

Methods

class SettingsSchemaSource
get_default() → SettingsSchemaSource | None

Gets the default system schema source.

This function is not required for normal uses of Settings but it may be useful to authors of plugin management systems or to those who want to introspect the content of schemas.

If no schemas are installed, None will be returned.

The returned source may actually consist of multiple schema sources from different directories, depending on which directories were given in XDG_DATA_DIRS and GSETTINGS_SCHEMA_DIR. For this reason, all lookups performed against the default source should probably be done recursively.

Added in version 2.32.

list_schemas(recursive: bool) → tuple[list[str], list[str]]

Lists the schemas in a given source.

If recursive is True then include parent sources. If False then only include the schemas from one source (ie: one directory). You probably want True.

Non-relocatable schemas are those for which you can call new(). Relocatable schemas are those for which you must use new_with_path().

Do not call this function from normal programs. This is designed for use by database editors, commandline tools, etc.

Added in version 2.40.

Parameters:

recursive – if we should recurse

lookup(schema_id: str, recursive: bool) → SettingsSchema | None

Looks up a schema with the identifier schema_id in source.

This function is not required for normal uses of Settings but it may be useful to authors of plugin management systems or to those who want to introspect the content of schemas.

If the schema isn’t found directly in source and recursive is True then the parent sources will also be checked.

If the schema isn’t found, None is returned.

Added in version 2.32.

Parameters:

  • schema_id – a schema ID

  • recursive – True if the lookup should be recursive