vispy.util.config module

Vispy configuration functions.

class vispy.util.config.Config(**kwargs)

Bases: object

Container for global settings used application-wide in vispy.

Events:

  • Config.events.changed - Emits ConfigEvent whenever the configuration changes.

update(**kwargs)
class vispy.util.config.ConfigEvent(changes)

Bases: vispy.util.event.Event

Event indicating a configuration change.

This class has a ‘changes’ attribute which is a dict of all name:value pairs that have changed in the configuration.

vispy.util.config.get_config_keys()

The config keys known by vispy and their allowed data types.

Returns
keysdict

Dict of {key: (types,)} pairs.

vispy.util.config.save_config(**kwargs)

Save configuration keys to vispy config file

Parameters
**kwargskeyword arguments

Key/value pairs to save to the config file.

vispy.util.config.set_data_dir(directory=None, create=False, save=False)

Set vispy data download directory

Parameters
directorystr | None

The directory to use.

createbool

If True, create directory if it doesn’t exist.

savebool

If True, save the configuration to the vispy config.

vispy.util.config.sys_info(fname=None, overwrite=False)

Get relevant system and debugging information

Parameters
fnamestr | None

Filename to dump info to. Use None to simply print.

overwritebool

If True, overwrite file (if it exists).

Returns
outstr

The system information as a string.