FlatCAM/tclCommands/TclCommandOpenGCode.py

from tclCommands.TclCommand import *


class TclCommandOpenGCode(TclCommandSignaled):
    """
    Tcl shell command to open a G-Code file.
    """

    # array of all command aliases, to be able use  old names for
    # backward compatibility (add_poly, add_polygon)
    aliases = ['open_gcode']

    # Dictionary of types from Tcl command, needs to be ordered.
    # For positional arguments
    arg_names = collections.OrderedDict([
        ('filename', str)
    ])

    # Dictionary of types from Tcl command, needs to be ordered.
    # For options like -optionname value
    option_types = collections.OrderedDict([
        ('outname', str)
    ])

    # array of mandatory options for current Tcl command: required = {'name','outname'}
    required = ['filename']

    # structured help for current command, args needs to be ordered
    help = {
        'main': "Opens a G-Code file.",
        'args': collections.OrderedDict([
            ('filename', 'Path to file to open.'),
            ('outname', 'Name of the resulting CNCJob object.')
        ]),
        'examples': []
    }

    def execute(self, args, unnamed_args):
        """
        execute current TCL shell command

        :param args: array of known named arguments and options
        :param unnamed_args: array of other values which were passed into command
            without -somename and  we do not have them in known arg_names
        :return: None or exception
        """

        self.app.open_gcode(args['filename'], **args)