Source code for diffpy.srfit.util.inpututils

#!/usr/bin/env python
##############################################################################
#
# diffpy.srfit      by DANSE Diffraction group
#                   Simon J. L. Billinge
#                   (c) 2010 The Trustees of Columbia University
#                   in the City of New York.  All rights reserved.
#
# File coded by:    Chris Farrow
#
# See AUTHORS.txt for a list of people who contributed.
# See LICENSE_DANSE.txt for license information.
#
##############################################################################
"""Input utilities."""

__all__ = ["convert_input_to_string", "inputToString"]

import os.path
from pathlib import Path

from diffpy.utils._deprecator import build_deprecation_message, deprecated

inputToString_dep_msg = build_deprecation_message(
    "diffpy.srfit.util.inpututils",
    "inputToString",
    "convert_input_to_string",
    "4.0.0",
)




def convert_input_to_string(input):
    """Return the contents of an open file, a file name, or a string.

    This lets a method accept its input in any of those forms. A string
    that is an existing file, or that is a single line shorter than 80
    characters, is treated as a file name. Any other string is returned
    unchanged.

    Parameters
    ----------
    input : file-like or str
        The open file-like object, the name of a file, or the text itself.

    Returns
    -------
    str
        The contents of the input as a string.

    Raises
    ------
    FileNotFoundError
        If ``input`` looks like a file name but the file does not exist.
    """
    # Get the input into a string
    inptstr = ""
    if hasattr(input, "read"):
        inptstr = input.read()
    # TODO remove handling of string input accept only file or filename
    # FIXME check for typos in the file name
    elif os.path.exists(input) or (len(input) < 80 and input.count("\n") == 0):
        with open(input, "r") as infile:
            inptstr = infile.read()
    else:
        inptstr = input

    return inptstr



@deprecated(inputToString_dep_msg)
def inputToString(input):
    """This function has been deprecated and will be removed in version
    4.0.0.

    Please use diffpy.srfit.util.inpututils.convert_input_to_string
    instead.
    """
    return convert_input_to_string(input)


def get_dict_from_results_file(
    results_filepath: Path | str,
) -> dict[str, float]:
    """Get a dictionary of parameter names and values from a results
    file.

    The file should have lines in the format:
    "parameter_name value +/- uncertainty". Lines that do not match this
    format will be ignored.

    Parameters
    ----------
    results_filepath : pathlib.Path or str
        The path to the results file.

    Returns
    -------
    parsed_results_dict : dict
        The dictionary where keys are parameter names and values are the
        corresponding parameter values as floats.
    """
    with open(results_filepath, "r") as f:
        results_string = f.read()
    parsed_results_dict = {}
    for raw_line in results_string.splitlines():
        line = raw_line.strip()
        # skip blank lines and lines that are just dashes
        if not line or set(line) == {"-"}:
            continue
        line_items = line.split()
        if len(line_items) < 2:
            continue
        if len(line_items) >= 4 and line_items[2] == "+/-":
            try:
                parsed_results_dict[line_items[0]] = float(line_items[1])
            except ValueError:
                pass
    return parsed_results_dict


# End of file