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 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
|
# Copyright 2017-2020 Palantir Technologies, Inc.
# Copyright 2021- Python Language Server Contributors.
import configparser
import logging
import os
import sys
log = logging.getLogger(__name__)
class ConfigSource:
"""Base class for implementing a config source."""
def __init__(self, root_path) -> None:
self.root_path = root_path
self.is_windows = sys.platform == "win32"
self.xdg_home = os.environ.get(
"XDG_CONFIG_HOME", os.path.expanduser("~/.config")
)
def user_config(self) -> None:
"""Return user-level (i.e. home directory) configuration."""
raise NotImplementedError()
def project_config(self, document_path) -> None:
"""Return project-level (i.e. workspace directory) configuration."""
raise NotImplementedError()
@classmethod
def read_config_from_files(cls, files):
config = configparser.RawConfigParser()
for filename in files:
if os.path.exists(filename) and not os.path.isdir(filename):
config.read(filename)
return config
@classmethod
def parse_config(cls, config, key, options):
"""Parse the config with the given options."""
conf = {}
for source, destination, opt_type in options:
opt_value = cls._get_opt(config, key, source, opt_type)
if opt_value is not None:
cls._set_opt(conf, destination, opt_value)
return conf
@classmethod
def _get_opt(cls, config, key, option, opt_type):
"""Get an option from a configparser with the given type."""
for opt_key in [option, option.replace("-", "_")]:
if not config.has_option(key, opt_key):
continue
if opt_type is bool:
return config.getboolean(key, opt_key)
if opt_type is int:
return config.getint(key, opt_key)
if opt_type is str:
return config.get(key, opt_key)
if opt_type is list:
return cls._parse_list_opt(config.get(key, opt_key))
raise ValueError("Unknown option type: %s" % opt_type)
@classmethod
def _parse_list_opt(cls, string):
return [s.strip() for s in string.split(",") if s.strip()]
@classmethod
def _set_opt(cls, config_dict, path, value):
"""Set the value in the dictionary at the given path if the value is not None."""
if value is None:
return
if "." not in path:
config_dict[path] = value
return
key, rest = path.split(".", 1)
if key not in config_dict:
config_dict[key] = {}
cls._set_opt(config_dict[key], rest, value)
|