annotate libervia/tui/config.py @ 4260:57ff857bf96e

doc (components/AP Gateway): document new `http_sign_get` configuration option.
author Goffi <goffi@goffi.org>
date Wed, 05 Jun 2024 22:34:43 +0200
parents b0c36f3d3e04
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
1 #!/usr/bin/env python3
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
3
4076
b620a8e882e1 refactoring: rename `libervia.frontends.primitivus` to `libervia.tui`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
4 # Libervia TUI
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
16
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
19
4076
b620a8e882e1 refactoring: rename `libervia.frontends.primitivus` to `libervia.tui`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
20 """This module manage configuration specific to LiberviaTUI"""
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
21
4076
b620a8e882e1 refactoring: rename `libervia.frontends.primitivus` to `libervia.tui`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
22 from libervia.tui.constants import Const as C
b620a8e882e1 refactoring: rename `libervia.frontends.primitivus` to `libervia.tui`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
23 from libervia.tui.keys import action_key_map
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
24 import configparser
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
25
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
26
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
27 def apply_config(host):
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 """Parse configuration and apply found change
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 raise: can raise various Exceptions if configuration is not good
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 """
4238
b0c36f3d3e04 core: update `pygobject` version and replace deprecated `configparser.SafeConfigParser`
Goffi <goffi@goffi.org>
parents: 4076
diff changeset
32 config = configparser.ConfigParser()
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
33 config.read(C.CONFIG_FILES)
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 try:
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 options = config.items(C.CONFIG_SECTION)
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
36 except configparser.NoSectionError:
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 options = []
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 shortcuts = {}
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 for name, value in options:
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 if name.startswith(C.CONFIG_OPT_KEY_PREFIX.lower()):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
41 action = name[len(C.CONFIG_OPT_KEY_PREFIX) :].upper()
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 shortcut = value
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
43 if not action or not shortcut:
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 raise ValueError("Bad option: {} = {}".format(name, value))
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 shortcuts[action] = shortcut
1165
ca15fb1abbc4 primitivus: added disable_mouse config option /!\ minimal Urwid version is now 1.2.0
Goffi <goffi@goffi.org>
parents: 1159
diff changeset
46 if name == "disable_mouse":
ca15fb1abbc4 primitivus: added disable_mouse config option /!\ minimal Urwid version is now 1.2.0
Goffi <goffi@goffi.org>
parents: 1159
diff changeset
47 host.loop.screen.set_mouse_tracking(False)
1159
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
48
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 action_key_map.replace(shortcuts)
85fd02356dba primitivus: key can be changed in config:
Goffi <goffi@goffi.org>
parents:
diff changeset
50 action_key_map.check_namespaces()