iterative/dvc

View on GitHub
dvc/repo/metrics/modify.py

Summary

Maintainability
A
1 hr
Test Coverage
from __future__ import unicode_literals

from dvc.exceptions import DvcException


def modify(repo, path, typ=None, xpath=None, delete=False):
    supported_types = ["raw", "json", "csv", "tsv", "hcsv", "htsv"]
    outs = repo.find_outs_by_path(path)
    assert len(outs) == 1
    out = outs[0]

    if out.scheme != "local":
        msg = "output '{}' scheme '{}' is not supported for metrics"
        raise DvcException(msg.format(out.path, out.path_info["scheme"]))

    if typ is not None:
        typ = typ.lower().strip()
        if typ not in ["raw", "json", "csv", "tsv", "hcsv", "htsv"]:
            msg = (
                "metric type '{typ}' is not supported, "
                "must be one of [{types}]"
            )
            raise DvcException(
                msg.format(typ=typ, types=", ".join(supported_types))
            )
        if not isinstance(out.metric, dict):
            out.metric = {}
        out.metric[out.PARAM_METRIC_TYPE] = typ

    if xpath is not None:
        if not isinstance(out.metric, dict):
            out.metric = {}
        out.metric[out.PARAM_METRIC_XPATH] = xpath

    if delete:
        out.metric = None

    out.verify_metric()

    out.stage.dump()