Config.register_option(key, subkey, default, _type, definition, values=None, locked=False)

Create a new option.

  • key (str) – First identifier of the option.
  • subkey (str) – Second identifier of the option.
  • default – Default value of the option. Type varies and it is described by _type.
  • _type (str) – Type of the value of the option. Available options are: [int, float, bool, text, string, path_in, path_out].
  • definition (str) – Brief explanation of the option.
  • values (list() of accepted _type) – Available values for the option.
  • locked (bool) – If True, option cannot be altered.
 If key or subkey already define an option.