summaryrefslogtreecommitdiff
path: root/qutebrowser/api/config.py
blob: c156c9c58cc70a94c0037a54f8e9f455b47a14ab (plain)
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
# Copyright 2018-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# This file is part of qutebrowser.
#
# qutebrowser is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# qutebrowser is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with qutebrowser.  If not, see <https://www.gnu.org/licenses/>.

"""Access to the qutebrowser configuration."""

from typing import cast, Any

from qutebrowser.qt.core import QUrl

from qutebrowser.config import config

#: Simplified access to config values using attribute access.
#: For example, to access the ``content.javascript.enabled`` setting,
#: you can do::
#:
#:   if config.val.content.javascript.enabled:
#:       ...
#:
#: This also supports setting configuration values::
#:
#:   config.val.content.javascript.enabled = False
val = cast('config.ConfigContainer', None)


def get(name: str, url: QUrl = None) -> Any:
    """Get a value from the config based on a string name."""
    return config.instance.get(name, url)