FlatCAM/tclCommands/TclCommandExportGerber.py

from tclCommands.TclCommand import TclCommand

import collections


class TclCommandExportGerber(TclCommand):
    """
    Tcl shell command to export a Gerber Object as an Gerber File.

    example:
        export_exc path/my_excellon filename
    """

    # List of all command aliases, to be able use old names for backward compatibility (add_poly, add_polygon)
    aliases = ['export_grb', 'egr', 'export_gerber']

    description = '%s %s' % ("--", "Export a Gerber object as a Gerber File.")

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

    # Dictionary of types from Tcl command, needs to be ordered , this  is  for options  like -optionname value
    option_types = collections.OrderedDict([
    ])

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

    # structured help for current command, args needs to be ordered
    help = {
        'main': "Export a Gerber Object as a Gerber File.",
        'args': collections.OrderedDict([
            ('name', 'Name of the object to export. Required.'),
            ('filename', 'Absolute path to file to export.\n'
                         'WARNING: no spaces are allowed. If unsure enclose the entire path with quotes.'),
        ]),
        'examples': ['export_gerber my_gerber path/my_file.gbr']
    }

    def execute(self, args, unnamed_args):
        """

        :param args:
        :param unnamed_args:
        :return:
        """
        if 'filename' not in args:
            args['filename'] = self.app.defaults["global_last_save_folder"] + '/' + args['name']
        self.app.export_gerber(use_thread=False,**args)