aboutsummaryrefslogtreecommitdiffstats
path: root/grc/blocks/variable_config.block.yml
blob: 04a60e43f1e57bd0d245e81011a40ba31f07b969 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
id: variable_config
label: Variable Config
flags: [ show_id, python ]

parameters:
-   id: value
    label: Default Value
    dtype: ${ type }
    default: '0'
-   id: type
    label: Type
    dtype: enum
    default: real
    options: [real, int, bool, string]
    option_labels: [Float, Int, Bool, String]
    option_attributes:
        get: [getfloat, getint, getboolean, get]
-   id: config_file
    label: Config File
    dtype: file_open
    default: default
-   id: section
    label: Section
    dtype: string
    default: main
-   id: option
    label: Option
    dtype: string
    default: key
-   id: writeback
    label: WriteBack
    dtype: raw
    default: None
value: ${ value }

templates:
    imports: import configparser
    var_make: 'self._${id}_config = configparser.ConfigParser()

        self._${id}_config.read(${config_file})

        try: ${id} = self._${id}_config.${type.get}(${section}, ${option})

        except: ${id} = ${value}

        self.${id} = ${id}'
    callbacks:
    - self.set_${id}(${value})
    - "self._${id}_config = configparser.ConfigParser()\nself._${id}_config.read(${config_file})\n\
        if not self._${id}_config.has_section(${section}):\n\tself._${id}_config.add_section(${section})\n\
        self._${id}_config.set(${section}, ${option}, str(${writeback}))\nself._${id}_config.write(open(${config_file},\
        \ 'w'))"

documentation: |-
    This block represents a variable that can be read from a config file.

    To save the value back into the config file: enter the name of another variable into the writeback param. When the other variable is changed at runtime, the config file will be re-written.

file_format: 1