Source code for pharmpy.tools.context

from pathlib import Path
from typing import Union

from pharmpy.internals.fs.path import normalize_user_given_path
from pharmpy.workflows import ModelfitResults
from pharmpy.workflows.contexts import Context, LocalDirectoryContext
from pharmpy.workflows.contexts.broadcasters.terminal import broadcast_message


def _open_context(source):
    if isinstance(source, Path) or isinstance(source, str):
        path = Path(source)
        context = LocalDirectoryContext(path)
    elif isinstance(source, Context):
        context = source
    else:
        raise NotImplementedError(f'Not implemented for type \'{type(source)}\'')
    return context




def create_context(name: str, path: Union[str, Path, None] = None):
    """Create a new context

    Currently a local filesystem context (i.e. a directory)

    Parameters
    ----------
    name : str
        Name of the context
    path : str or Path
        Path to where to put the context

    Examples
    --------
    >>> from pharmpy.tools import create_context
    >>> ctx = create_context("myproject")  # doctest: +SKIP

    """
    ref = str(normalize_user_given_path(path)) if path is not None else None
    ctx = LocalDirectoryContext(name=name, ref=ref)
    return ctx





def print_log(context: Context):
    """Print the log of a context

    Parameters
    ----------
    context : Context
        Print the log of this context

    """
    df = context.retrieve_log()
    for _, row in df.iterrows():
        broadcast_message(row['severity'], row['path'], row['time'], row['message'])





def retrieve_modelfit_results(
    source: Union[str, Path, Context],
    name: str,
) -> ModelfitResults:
    """Retrieve the modelfit results of a model

    Parameters
    ----------
    source : str, Path, Context
        Source where to find models. Can be a path (as str or Path), or a
        Context
    name : str
        Name of the model

    Return
    ------
    ModelfitResults
        The results object

    Examples
    --------
    >>> from pharmpy.tools import create_context, retrieve_modelfit_results
    >>> tooldir_path = 'path/to/tool/directory'
    >>> context = create_context("iivsearch1")   # doctest: +SKIP
    >>> results = retrieve_modelfit_results(context, 'input')      # doctest: +SKIP

    """
    context = _open_context(source)
    return context.retrieve_model_entry(name).modelfit_results