Source code for mlinsights.helpers.parameters

"""
Functions about parameters.


:githublink:`%|py|5`
"""
import textwrap


def format_value(v):
    """
    Formats a value to be included in a string.

    :param      v:           a string
    :return:                 a string


    :githublink:`%|py|14`
    """
    return ("'{0}'".format(v.replace("'", "\\'"))
            if isinstance(v, str) else "{0}".format(v))


def format_parameters(pdict):
    """
    Formats a list of parameters.

    :param      pdict:       dictionary
    :return:                 string

    .. runpython::
        :showcode:

        from mlinsights.helpers.parameters import format_parameters

        d = dict(i=2, x=6.7, s="r")
        print(format_parameters(d))


    :githublink:`%|py|33`
    """
    res = []
    for k, v in sorted(pdict.items()):
        res.append('{0}={1}'.format(k, format_value(v)))
    return ", ".join(res)


def format_function_call(name, pdict):
    """
    Formats a function call with named parameters.

    :param      pdict:       dictionary
    :return:                 string

    .. runpython::
        :showcode:

        from mlinsights.helpers.parameters import format_function_call

        d = dict(i=2, x=6.7, s="r")
        print(format_function_call("fct", d))


    :githublink:`%|py|54`
    """
    res = '{0}({1})'.format(name, format_parameters(pdict))
    return "\n".join(textwrap.wrap(res, width=70, subsequent_indent='    '))