Source code for expandobjects.main

import os
import sys
from pyiddidf.idf.processor import IDFProcessor
from pyiddidf.idd.processor import IDDProcessor

from expandobjects.exceptions import InvalidCommandLineArguments, FileIOProblem, ExitCodes
from expandobjects.expander import ExpansionManager


def usage(binary_name):
    """Provides a usage string that can be printed to terminal or otherwise"""
    return """ \
Expand template objects in EnergyPlus.  Usage:
$ %s /path/to/Energy+.idd /path/to/my.idf ["/path/to/expanded_file_name.idf"]
    """ % binary_name


def sub_worker(these_argv, raise_exceptions=False, print_error_messages=True):
    """This does the heavy lifting of processing command line args and preparing for an actual expansion"""

    # there should always be one command line argument, the binary name
    # if there's not, then in that weird situation I'm OK having an unhandled exception
    # as I wouldn't know what to handle about it anyway
    binary_name = these_argv[0]

    # first check command line arguments
    if len(these_argv) < 3:
        if print_error_messages:  # pragma no cover
            print("Invalid command line arguments; needs at least two arguments for the input file to expand")
            print(usage(binary_name))
        if raise_exceptions:
            raise InvalidCommandLineArguments()
        else:
            return ExitCodes[InvalidCommandLineArguments]
    elif len(these_argv) > 4:
        if print_error_messages:  # pragma no cover
            print("Invalid command line arguments; needs at most three arguments: idd, input file and output file")
            print(usage(binary_name))
        if raise_exceptions:
            raise InvalidCommandLineArguments()
        else:
            return ExitCodes[InvalidCommandLineArguments]

    # *** this point on, it's only possibly for exactly 3 or 4 total command line arguments (including the binary name)

    # validate and process the first command line argument: the idd file
    idd_file_path = these_argv[1]
    if not os.path.exists(idd_file_path):
        if print_error_messages:  # pragma no cover
            print("Invalid command line arguments; idd file does not exist at: \"%s\"" % idd_file_path)
            print(usage(binary_name))
        if raise_exceptions:
            raise InvalidCommandLineArguments()
        else:
            return ExitCodes[InvalidCommandLineArguments]

    # validate and process the second command line argument: the input file
    input_file_path = these_argv[2]
    if not os.path.exists(input_file_path):
        if print_error_messages:  # pragma no cover
            print("Invalid command line arguments; input file does not exist: \"%s\"" % input_file_path)
            print(usage(binary_name))
        if raise_exceptions:
            raise InvalidCommandLineArguments()
        else:
            return ExitCodes[InvalidCommandLineArguments]

    # validate and process the optional second command line argument: the output file
    if len(these_argv) == 3:
        # we need to get the directory from the input file command line argument
        input_file_base_dir = os.path.dirname(input_file_path)
        output_file_path = os.path.join(input_file_base_dir, 'expanded.idf')
    else:  # 3, so the output file path is included
        output_file_path = these_argv[3]
    # try deleting it; if it doesn't exist this will quietly pass
    try:
        os.remove(output_file_path)
    except OSError:
        pass
    # if it didn't get deleted, it will still be there!
    if os.path.exists(output_file_path):  # pragma no cover
        if print_error_messages:
            print("Previous output file could not be deleted, cannot continue; file at: \"%s\"" % output_file_path)
        if raise_exceptions:
            raise FileIOProblem()
        else:
            return ExitCodes[FileIOProblem]

    # now create file-like objects for the input and output and pass them to the main expansion engine
    idd_structure = IDDProcessor().process_file_given_file_path(idd_file_path)
    idf_structure = IDFProcessor().process_file_given_file_path(input_file_path)
    expander = ExpansionManager()
    expander.expand(idd_structure, idf_structure)
    return ExitCodes[None]


def main():  # pragma no cover
    """This is the main command line entry point to this library.
    After a pip install, a binary will be available on the Python bin path called \"expand_objects\", which provides
    an entry point into this function.

    Currently this function accepts two positional arguments:
    1. The name of the file to be expanded
    2. An optional output name.  If not provided, the output file will be expanded.idf (in the input file directory)

    Example usage:
    $ expand_objects /path/to/my.idf /path/to/expanded_file_name.idf
    """
    sys.exit(sub_worker(sys.argv))


if __name__ == "__main__":  # pragma no cover
    main()