Source code for ladybug_vtk.cli

"""ladybug-vtk commands."""
import click
import sys
import os
import logging
import base64
import tempfile
import uuid

from ladybug_display.visualization import VisualizationSet
from ladybug.cli import main

_logger = logging.getLogger(__name__)


# command group for all vtk extension commands.
@click.group(help='ladybug VTK commands.')
@click.version_option()
def vtk():
    pass


@vtk.command('vis-to-vtk')
@click.argument('vis-file', type=click.Path(
    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
@click.option(
    '--output-format', '-of', help='Text for the output format of the resulting '
    'file. Choose from: vtkjs, html. Note that the html format refers to a web page '
    'with the vtkjs file embedded within it.',
    type=str, default='vtkjs', show_default=True)
@click.option(
    '--output-file', help='Optional file to output the JSON string of '
    'the config object. By default, it will be printed out to stdout.',
    type=click.File('w'), default='-', show_default=True)
def vis_set_to_vtk_cli(vis_file, output_format, output_file):
    """Translate a VisualizationSet file (.vsf) to VTK formats.

    \b
    Args:
        vis_file: Full path to a Ladybug Display Visualization Set (VSF) file.
    """
    try:
        vis_set_to_vtk(vis_file, output_format, output_file)
    except Exception as e:
        _logger.exception('Failed to translate VisualizationSet to VTK.\n{}'.format(e))
        sys.exit(1)
    else:
        sys.exit(0)




def vis_set_to_vtk(vis_file, output_format='vtkjs', output_file=None):
    """Translate a VisualizationSet file (.vsf) to VTK formats.

    Args:
        vis_file: Full path to a Ladybug Display Visualization Set (VSF) file.
        output_format: Text for the output format of the resulting file.
            Choose from: vtkjs, html. Note that the html format refers to a
            web page with the vtkjs file embedded within it.
        output_file: Optional file to output the string of the visualization
            file contents. If None, the string will simply be returned from
            this method.
    """
    # load the visualization set from the file
    vis_set = VisualizationSet.from_file(vis_file)
    output_format = output_format.lower()
    if output_format not in ('vtkjs', 'html'):
        raise ValueError('Unrecognized output-format "{}".'.format(output_format))

    # setup the working directory
    if output_file is None or (not isinstance(output_file, str)
                               and output_file.name == '<stdout>'):
        # get a temporary file
        out_file = str(uuid.uuid4())[:6]
        out_folder = tempfile.gettempdir()
    else:
        f_path = output_file if isinstance(output_file, str) else output_file.name
        out_folder, out_file = os.path.split(f_path)
        if out_file.endswith('.vtkjs'):
            out_file = out_file[:-6]
        elif out_file.endswith('.html'):
            out_file = out_file[:-5]

    # create the output file
    if output_format == 'vtkjs':
        vis_set.to_vtkjs(output_folder=out_folder, file_name=out_file)
    if output_format == 'html':
        vis_set.to_html(output_folder=out_folder, file_name=out_file)

    # load file contents if need be
    if output_file is None or (not isinstance(output_file, str)
                               and output_file.name == '<stdout>'):
        # load file contents
        out_file_ext = out_file + '.' + output_format
        out_file_path = os.path.join(out_folder, out_file_ext)
        if output_format == 'html':
            with open(out_file_path, encoding='utf-8') as of:
                f_contents = of.read()
        else:  # vtkjs can only be read as binary
            with open(out_file_path, 'rb') as of:
                f_contents = of.read()
            b = base64.b64encode(f_contents)
            f_contents = b.decode('utf-8')
        if output_file is None:
            return f_contents
        output_file.write(f_contents)



# add vtk sub-group to ladybug CLI
main.add_command(vtk)