summaryrefslogtreecommitdiff
path: root/qutebrowser/api/config.py
blob: 34899dcbc9718c069a12aadf56a95bd9e5b10f48 (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
# Copyright 2018-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

"""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)