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.
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('kivy', '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. |
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 is not listening by default anymore. 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.
- kivy.config.Config = None¶
Kivy configuration object
- class kivy.config.ConfigParser[source]¶
Bases: ConfigParser.ConfigParser
Enhanced ConfigParser class that supports the addition of default sections and default values.
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.
- 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.
- 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.