__config__.py.in

# This file is generated by SciPy's build process
# It contains system_info results at the time of building this package.
from enum import Enum

__all__ = ["show"]
_built_with_meson = True


class DisplayModes(Enum):
    stdout = "stdout"
    dicts = "dicts"


def _cleanup(d):
    """
    Removes empty values in a `dict` recursively
    This ensures we remove values that Meson could not provide to CONFIG
    """
    if isinstance(d, dict):
        return { k: _cleanup(v) for k, v in d.items() if v != '' and _cleanup(v) != '' }
    else:
        return d


CONFIG = _cleanup(
    {
        "Compilers": {
            "c": {
                "name": "@C_COMP@",
                "linker": "@C_COMP_LINKER_ID@",
                "version": "@C_COMP_VERSION@",
                "commands": "@C_COMP_CMD_ARRAY@",
            },
            "cython": {
                "name": "@CYTHON_COMP@",
                "linker": "@CYTHON_COMP_LINKER_ID@",
                "version": "@CYTHON_COMP_VERSION@",
                "commands": "@CYTHON_COMP_CMD_ARRAY@",
            },
            "c++": {
                "name": "@CPP_COMP@",
                "linker": "@CPP_COMP_LINKER_ID@",
                "version": "@CPP_COMP_VERSION@",
                "commands": "@CPP_COMP_CMD_ARRAY@",
            },
            "fortran": {
                "name": "@FORTRAN_COMP@",
                "linker": "@FORTRAN_COMP_LINKER_ID@",
                "version": "@FORTRAN_COMP_VERSION@",
                "commands": "@FORTRAN_COMP_CMD_ARRAY@",
            },
            "pythran": {
                "version": "@PYTHRAN_VERSION@",
                "include directory": r"@PYTHRAN_INCDIR@"
            },
        },
        "Machine Information": {
            "host": {
                "cpu": "@HOST_CPU@",
                "family": "@HOST_CPU_FAMILY@",
                "endian": "@HOST_CPU_ENDIAN@",
                "system": "@HOST_CPU_SYSTEM@",
            },
            "build": {
                "cpu": "@BUILD_CPU@",
                "family": "@BUILD_CPU_FAMILY@",
                "endian": "@BUILD_CPU_ENDIAN@",
                "system": "@BUILD_CPU_SYSTEM@",
            },
            "cross-compiled": bool("@CROSS_COMPILED@".lower().replace('false', '')),
        },
        "Build Dependencies": {
            "blas": {
                "name": "@BLAS_NAME@",
                "found": bool("@BLAS_FOUND@".lower().replace('false', '')),
                "version": "@BLAS_VERSION@",
                "detection method": "@BLAS_TYPE_NAME@",
                "include directory": r"@BLAS_INCLUDEDIR@",
                "lib directory": r"@BLAS_LIBDIR@",
                "openblas configuration": "@BLAS_OPENBLAS_CONFIG@",
                "pc file directory": r"@BLAS_PCFILEDIR@",
            },
            "lapack": {
                "name": "@LAPACK_NAME@",
                "found": bool("@LAPACK_FOUND@".lower().replace('false', '')),
                "version": "@LAPACK_VERSION@",
                "detection method": "@LAPACK_TYPE_NAME@",
                "include directory": r"@LAPACK_INCLUDEDIR@",
                "lib directory": r"@LAPACK_LIBDIR@",
                "openblas configuration": "@LAPACK_OPENBLAS_CONFIG@",
                "pc file directory": r"@LAPACK_PCFILEDIR@",
            },
        },
        "Python Information": {
            "path": r"@PYTHON_PATH@",
            "version": "@PYTHON_VERSION@",
        },
    }
)


def _check_pyyaml():
    import yaml

    return yaml


def show(mode=DisplayModes.stdout.value):
    """
    Show libraries and system information on which SciPy was built
    and is being used

    Parameters
    ----------
    mode : {`'stdout'`, `'dicts'`}, optional.
        Indicates how to display the config information.
        `'stdout'` prints to console, `'dicts'` returns a dictionary
        of the configuration.

    Returns
    -------
    out : {`dict`, `None`}
        If mode is `'dicts'`, a dict is returned, else None

    Notes
    -----
    1. The `'stdout'` mode will give more readable
       output if ``pyyaml`` is installed

    """
    if mode == DisplayModes.stdout.value:
        try:  # Non-standard library, check import
            yaml = _check_pyyaml()

            print(yaml.dump(CONFIG))
        except ModuleNotFoundError:
            import warnings
            import json

            warnings.warn("Install `pyyaml` for better output", stacklevel=1)
            print(json.dumps(CONFIG, indent=2))
    elif mode == DisplayModes.dicts.value:
        return CONFIG
    else:
        raise AttributeError(
            f"Invalid `mode`, use one of: {', '.join([e.value for e in DisplayModes])}"
        )