Table Of Contents
Configuration object¶
The Config object is an instance of a modified Python ConfigParser. See the ConfigParser documentation for more information.
Kivy has a configuration file which determines the default settings. In order to change these settings, you can alter this file manually or use the Config object. Please see the Configure Kivy section for more information.
Note: To avoid instances where the config settings do not work or they are not applied before window creation (like setting an initial window size), Config.set should be used before importing any modules that affect the application window (ie. importing Window). Ideally, these settings should be declared right at the start of your main.py script.
Usage of the Config object¶
To read a configuration token from a particular section:
>>> from kivy.config import Config
>>> Config.getint('kivy', 'show_fps')
0
Change the configuration and save it:
>>> Config.set('postproc', 'retain_time', '50')
>>> Config.write()
Changed in version 1.7.1: The ConfigParser should work correctly with utf-8 now. The values are converted from ascii to unicode only when needed. The method get() returns utf-8 strings.
Available configuration tokens¶
kivy: |
|
---|---|
postproc: |
|
graphics: |
|
input: | You can create new input devices using this syntax: # example of input provider instance
yourid = providerid,parameters
# example for tuio provider
default = tuio,127.0.0.1:3333
mytable = tuio,192.168.0.1:3334
See also Check the providers in kivy.input.providers for the syntax to use inside the configuration file. |
widgets: |
|
modules: | You can activate modules with this syntax: modulename =
Anything after the = will be passed to the module as arguments. Check the specific module’s documentation for a list of accepted arguments. |
Note
These options control only the initalization of the app and a restart is required for value changes to take effect.
Changed in version 1.9.0: borderless has been added to the graphics section. The fake option of fullscreen in the graphics section has been deprecated, use the borderless option instead. pause_on_minimize has been added to the kivy section.
Changed in version 1.8.0: systemanddock and systemandmulti has been added as possible values for keyboard_mode in the kivy section. exit_on_escape has been added to the kivy section.
Changed in version 1.2.0: resizable has been added to graphics section.
Changed in version 1.1.0: tuio no longer listens by default. Window icons are not copied to user directory anymore. You can still set a new window icon by using the window_icon config setting.
Changed in version 1.0.8: scroll_timeout, scroll_distance and scroll_friction have been added. list_friction, list_trigger_distance and list_friction_bound have been removed. keyboard_type and keyboard_layout have been removed from the widget. keyboard_mode and keyboard_layout have been added to the kivy section.
- class kivy.config.ConfigParser(name='')[source]¶
Bases: ConfigParser.ConfigParser, object
Enhanced ConfigParser class that supports the addition of default sections and default values.
By default, the kivy ConfigParser instance, Config, is given the name ‘kivy’ and the ConfigParser instance used by App, build_settings(), is given the name ‘app’.
Parameters : - name: string
The name of the instance. See name. Defaults to ‘’.
- ..versionchanged:: 1.9.0
- Each ConfigParser can now be named, name. You can get the ConfigParser associated with a name using get_configparser(). In addition, you can now control the config values with ConfigParserProperty.
New in version 1.0.7.
- add_callback(callback, section=None, key=None)[source]¶
Add a callback to be called when a specific section/key changed. If you don’t specify a section or a key, it will call the callback for all section/keys changes.
Callbacks will receive 3 arguments: the section, key and value.
New in version 1.4.1.
- static get_configparser(name)[source]¶
Returns the ConfigParser instance whose name is name, or None if not found.
Parameters : - name: string
The name of the ConfigParser instance to return.
- getdefault(section, option, defaultvalue)[source]¶
Get an option. If not found, it will return the default value.
- getdefaultint(section, option, defaultvalue)[source]¶
Get an option. If not found, it will return the default value. The return value will be always converted as an integer.
New in version 1.6.0.
- name[source]¶
The name associated with this ConfigParser instance, if not ‘’. Defaults to ‘’. It can be safely dynamically changed or set to ‘’.
When a ConfigParser is given a name, that config object can be retrieved using get_configparser(). In addition, that config instance can also be used with a ConfigParserProperty instance that set its config value to this name.
Setting more than one ConfigParser with the same name will raise a ValueError.
- read(filename)[source]¶
Read only one filename. In contrast to the original ConfigParser of Python, this one is able to read only one file at a time. The last read file will be used for the write() method.
Changed in version 1.9.0: read() now calls the callbacks if read changed any values.
- remove_callback(callback, section=None, key=None)[source]¶
Removes a callback added with add_callback(). remove_callback() must be called with the same parameters as add_callback().
Raises a ValueError if not found.
New in version 1.9.0.
- set(section, option, value)[source]¶
Functions similarly to PythonConfigParser’s set method, except that the value is implicitly converted to a string.
- setdefaults(section, keyvalues)[source]¶
Set a lot of keys/value defaults in one section at the same time.