Source code for asv.config

# Licensed under a 3-clause BSD style license - see LICENSE.rst

import sys
from pathlib import Path

from . import util
from .console import log

# TODO: Some verification of the config values



[docs]
def _get_config_path():
    """
    Check the default config file path for all valid extensions.
    Raise if no file is found, or if multiple are found for the valid extensions.
    Return the path of the config file if exactly one is found.
    """
    extensions = ['.json', '.jsonc']
    path = Path('asv.conf.json')

    num_matches = 0
    for e in extensions:
        p = path.with_suffix(e)
        if p.exists():
            num_matches += 1
            path = p

    if num_matches == 0:
        raise util.UserError(f"No `asv.conf` file found for valid extensions: {extensions}.")
    elif num_matches > 1:
        raise util.UserError(
            f"Multiple `asv.conf` files found for valid extensions: {extensions}. "
            f"Please specify which file to use with `--config=FILEPATH`."
        )
    else:
        # exactly one valid config file found
        return str(path)




[docs]
class Config:
    """
    Manages the configuration for a benchmark project.
    """


[docs]
    api_version = 1


    def __init__(self):

[docs]
        self.project = "project"


[docs]
        self.project_url = "#"


[docs]
        self.repo = None


[docs]
        self.repo_subdir = ""


[docs]
        self.branches = [None]


[docs]
        self.pythons = [f"{sys.version_info[0]}.{sys.version_info[1]}"]


[docs]
        self.matrix = {}


[docs]
        self.exclude = []


[docs]
        self.include = []


[docs]
        self.env_dir = "env"


[docs]
        self.benchmark_dir = "benchmarks"


[docs]
        self.results_dir = "results"


[docs]
        self.html_dir = "html"


[docs]
        self.show_commit_url = "#"


[docs]
        self.hash_length = 8


[docs]
        self.environment_type = None


[docs]
        self.install_timeout = 600.0


[docs]
        self.default_benchmark_timeout = 60.0


[docs]
        self.dvcs = None


[docs]
        self.regressions_first_commits = {}


[docs]
        self.regressions_thresholds = {}


[docs]
        self.plugins = []


[docs]
        self.conda_channels = []


[docs]
        self.conda_environment_file = None


[docs]
        self.build_command = None


[docs]
        self.install_command = None


[docs]
        self.uninstall_command = None


[docs]
        self.launch_method = None


    @classmethod

[docs]
    def load(cls, path=None):
        """
        Load a configuration from a file.  If no file is provided,
        defaults to `asv.conf` with valid extensions `['.json', '.jsonc']`.
        """
        if path:
            if not Path(path).exists():
                raise util.UserError(f"Config file {path} not found.")
        else:
            path = _get_config_path()

        d = util.load_json(path, cls.api_version, js_comments=True)
        try:
            return cls.from_json(d)
        except ValueError:
            raise util.UserError(f"No repo specified in {path} config file.")


    @classmethod

[docs]
    def from_json(cls, d):
        if 'wheel_cache_size' in d:
            log.warning(
                "`wheel_cache_size` has been renamed to `build_cache_size`."
                " Update your `asv.conf.json` accordingly."
            )
            d.setdefault('build_cache_size', d['wheel_cache_size'])

        conf = cls()
        conf.__dict__.update(d)

        if not getattr(conf, "repo", None):
            raise util.UserError("No repo specified in config file.")

        if not getattr(conf, "branches", [None]):
            # If 'branches' attribute is present, at least some must
            # be listed.
            raise util.UserError("No branches specified in config file.")

        return conf