<reponame>JohnnyPeng18/cauldron<gh_stars>10-100
from cauldron import environ as _environ
from cauldron import plotting  # noqa
from cauldron import session as _session
from cauldron.session import display as _display
from cauldron.session import spark as _spark
from cauldron.session.caching import SharedCache as _SharedCache
from cauldron.session.definitions import ExecutionResult
from cauldron.session.reloading import refresh as _refresh

# Version Information in commonly viewed formats
__version__ = _environ.version  # type: str
version = _environ.version  # type: str
version_info = _environ.version_info  # type: _environ.VersionInfo

project = _session.project  # type: _session.ExposedProject
step = _session.step  # type: _session.ExposedStep
shared = _session.project.shared  # type: _SharedCache

display = _display
refresh = _refresh
mode = _environ.modes.ExposedModes
spark = _spark


def get_environment_info() -> dict:
    """
    Information about Cauldron and its Python interpreter.

    :return:
        A dictionary containing information about the Cauldron and its
        Python environment. This information is useful when providing feedback
        and bug reports.
    """
    data = _environ.systems.get_system_data()
    data['cauldron'] = _environ.package_settings.copy()
    return data


def run_shell():
    """ Starts the cauldron shell environment for console based interaction."""
    from cauldron.cli.shell import CauldronShell
    CauldronShell().cmdloop()


def run_server(port=5010, debug=False, **kwargs):
    """
    Run the cauldron http server used to interact with cauldron from a remote
    host.

    :param port:
        The port on which to bind the cauldron server.
    :param debug:
        Whether or not the server should be run in debug mode. If true, the
        server will echo debugging information during operation.
    :param kwargs:
        Custom properties to alter the way the server runs.
    """
    from cauldron.cli.server import run
    run.execute(port=port, debug=debug, **kwargs)


def run_project(
        project_directory: str,
        output_directory: str = None,
        logging_path: str = None,
        reader_path: str = None,
        reload_project_libraries: bool = False,
        forget_project: bool = False,
        **kwargs
) -> ExecutionResult:
    """
    Runs a project as a single command directly within the current Python
    interpreter.

    :param project_directory:
        The fully-qualified path to the directory where the Cauldron project is
        located
    :param output_directory:
        The fully-qualified path to the directory where the results will be
        written. All of the results files will be written within this
        directory. If the directory does not exist, it will be created.
    :param logging_path:
        The fully-qualified path to a file that will be used for logging. If a
        directory is specified instead of a file, a file will be created using
        the default filename of cauldron_run.log. If a file already exists at
        that location it will be removed and a new file created in its place.
    :param reader_path:
        Specifies a path where a reader file will be saved after the project
        has finished running. If no path is specified, no reader file will be
        saved. If the path is a directory, a reader file will be saved in that
        directory with the project name as the file name.
    :param reload_project_libraries:
        Whether or not to reload all project libraries prior to execution of
        the project. By default this is False, but can be enabled in cases
        where refreshing the project libraries before execution is needed.
    :param kwargs:
        Any variables to be available in the cauldron.shared object during
        execution of the project can be specified here as keyword arguments.
    :return:
        A response object that contains information about the run process
        and the shared data from the final state of the project.
    """
    from cauldron.cli import batcher
    return batcher.run_project(
        project_directory=project_directory,
        output_directory=output_directory,
        log_path=logging_path,
        reader_path=reader_path,
        reload_project_libraries=reload_project_libraries,
        forget_project=forget_project,
        shared_data=kwargs
    )

from cauldron import environ as _environ
from cauldron import plotting  # noqa
from cauldron import session as _session
from cauldron.session import display as _display
from cauldron.session import spark as _spark
from cauldron.session.caching import SharedCache as _SharedCache
from cauldron.session.definitions import ExecutionResult
from cauldron.session.reloading import refresh as _refresh

# Version Information in commonly viewed formats
__version__ = _environ.version  # type: str
version = _environ.version  # type: str
version_info = _environ.version_info  # type: _environ.VersionInfo

project = _session.project  # type: _session.ExposedProject
step = _session.step  # type: _session.ExposedStep
shared = _session.project.shared  # type: _SharedCache

display = _display
refresh = _refresh
mode = _environ.modes.ExposedModes
spark = _spark


def get_environment_info() -> dict:
    """
    Information about Cauldron and its Python interpreter.

    :return:
        A dictionary containing information about the Cauldron and its
        Python environment. This information is useful when providing feedback
        and bug reports.
    """
    data = _environ.systems.get_system_data()
    data['cauldron'] = _environ.package_settings.copy()
    return data


def run_shell():
    """ Starts the cauldron shell environment for console based interaction."""
    from cauldron.cli.shell import CauldronShell
    CauldronShell().cmdloop()


def run_server(port=5010, debug=False, **kwargs):
    """
    Run the cauldron http server used to interact with cauldron from a remote
    host.

    :param port:
        The port on which to bind the cauldron server.
    :param debug:
        Whether or not the server should be run in debug mode. If true, the
        server will echo debugging information during operation.
    :param kwargs:
        Custom properties to alter the way the server runs.
    """
    from cauldron.cli.server import run
    run.execute(port=port, debug=debug, **kwargs)


def run_project(
        project_directory: str,
        output_directory: str = None,
        logging_path: str = None,
        reader_path: str = None,
        reload_project_libraries: bool = False,
        forget_project: bool = False,
        **kwargs
) -> ExecutionResult:
    """
    Runs a project as a single command directly within the current Python
    interpreter.

    :param project_directory:
        The fully-qualified path to the directory where the Cauldron project is
        located
    :param output_directory:
        The fully-qualified path to the directory where the results will be
        written. All of the results files will be written within this
        directory. If the directory does not exist, it will be created.
    :param logging_path:
        The fully-qualified path to a file that will be used for logging. If a
        directory is specified instead of a file, a file will be created using
        the default filename of cauldron_run.log. If a file already exists at
        that location it will be removed and a new file created in its place.
    :param reader_path:
        Specifies a path where a reader file will be saved after the project
        has finished running. If no path is specified, no reader file will be
        saved. If the path is a directory, a reader file will be saved in that
        directory with the project name as the file name.
    :param reload_project_libraries:
        Whether or not to reload all project libraries prior to execution of
        the project. By default this is False, but can be enabled in cases
        where refreshing the project libraries before execution is needed.
    :param kwargs:
        Any variables to be available in the cauldron.shared object during
        execution of the project can be specified here as keyword arguments.
    :return:
        A response object that contains information about the run process
        and the shared data from the final state of the project.
    """
    from cauldron.cli import batcher
    return batcher.run_project(
        project_directory=project_directory,
        output_directory=output_directory,
        log_path=logging_path,
        reader_path=reader_path,
        reload_project_libraries=reload_project_libraries,
        forget_project=forget_project,
        shared_data=kwargs
    )
# noqa # Version Information in commonly viewed formats # type: str # type: str # type: _environ.VersionInfo # type: _session.ExposedProject # type: _session.ExposedStep # type: _SharedCache Information about Cauldron and its Python interpreter.      :return:         A dictionary containing information about the Cauldron and its         Python environment. This information is useful when providing feedback         and bug reports. Starts the cauldron shell environment for console based interaction. Run the cauldron http server used to interact with cauldron from a remote     host.      :param port:         The port on which to bind the cauldron server.     :param debug:         Whether or not the server should be run in debug mode. If true, the         server will echo debugging information during operation.     :param kwargs:         Custom properties to alter the way the server runs. Runs a project as a single command directly within the current Python     interpreter.      :param project_directory:         The fully-qualified path to the directory where the Cauldron project is         located     :param output_directory:         The fully-qualified path to the directory where the results will be         written. All of the results files will be written within this         directory. If the directory does not exist, it will be created.     :param logging_path:         The fully-qualified path to a file that will be used for logging. If a         directory is specified instead of a file, a file will be created using         the default filename of cauldron_run.log. If a file already exists at         that location it will be removed and a new file created in its place.     :param reader_path:         Specifies a path where a reader file will be saved after the project         has finished running. If no path is specified, no reader file will be         saved. If the path is a directory, a reader file will be saved in that         directory with the project name as the file name.     :param reload_project_libraries:         Whether or not to reload all project libraries prior to execution of         the project. By default this is False, but can be enabled in cases         where refreshing the project libraries before execution is needed.     :param kwargs:         Any variables to be available in the cauldron.shared object during         execution of the project can be specified here as keyword arguments.     :return:         A response object that contains information about the run process         and the shared data from the final state of the project.