84 lines
2.8 KiB
Python
84 lines
2.8 KiB
Python
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
|
|
|
|
# Copyright 2014-2017 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 <http://www.gnu.org/licenses/>.
|
|
|
|
"""Custom astroid checker for config calls."""
|
|
|
|
import sys
|
|
import pathlib
|
|
import yaml
|
|
import astroid
|
|
from pylint import interfaces, checkers
|
|
from pylint.checkers import utils
|
|
|
|
|
|
OPTIONS = None
|
|
FAILED_LOAD = False
|
|
|
|
|
|
class ConfigChecker(checkers.BaseChecker):
|
|
|
|
"""Custom astroid checker for config calls."""
|
|
|
|
__implements__ = interfaces.IAstroidChecker
|
|
name = 'config'
|
|
msgs = {
|
|
'E9998': ('%s is no valid config option.', # flake8: disable=S001
|
|
'bad-config-option',
|
|
None),
|
|
}
|
|
priority = -1
|
|
printed_warning = False
|
|
|
|
@utils.check_messages('bad-config-option')
|
|
def visit_attribute(self, node):
|
|
"""Visit a getattr node."""
|
|
# At the end of a config.val.foo.bar chain
|
|
if not isinstance(node.parent, astroid.Attribute):
|
|
# FIXME:conf do some proper check for this...
|
|
node_str = node.as_string()
|
|
prefix = 'config.val.'
|
|
if node_str.startswith(prefix):
|
|
self._check_config(node, node_str[len(prefix):])
|
|
|
|
def _check_config(self, node, name):
|
|
"""Check that we're accessing proper config options."""
|
|
if FAILED_LOAD:
|
|
if not ConfigChecker.printed_warning:
|
|
print("[WARN] Could not find configdata.yml. Please run "
|
|
"pylint from qutebrowser root.", file=sys.stderr)
|
|
print("Skipping some checks...", file=sys.stderr)
|
|
ConfigChecker.printed_warning = True
|
|
return
|
|
if name not in OPTIONS:
|
|
self.add_message('bad-config-option', node=node, args=name)
|
|
|
|
|
|
def register(linter):
|
|
"""Register this checker."""
|
|
linter.register_checker(ConfigChecker(linter))
|
|
global OPTIONS
|
|
global FAILED_LOAD
|
|
yaml_file = pathlib.Path('qutebrowser') / 'config' / 'configdata.yml'
|
|
if not yaml_file.exists():
|
|
OPTIONS = None
|
|
FAILED_LOAD = True
|
|
return
|
|
with yaml_file.open(mode='r', encoding='utf-8') as f:
|
|
OPTIONS = list(yaml.load(f))
|