flatcam/tclCommands/TclCommandOpenProject.py

57 lines
2.1 KiB
Python

from tclCommands.TclCommand import TclCommandSignaled
import collections
class TclCommandOpenProject(TclCommandSignaled):
"""
Tcl shell command to open a FlatCAM project.
"""
# array of all command aliases, to be able use old names for backward compatibility (add_poly, add_polygon)
aliases = ['open_project']
description = '%s %s' % ("--", "Opens an FlatCAm project file, parse it and recreate all the objects.")
# 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([
])
# 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 an FlatCAm project file, parse it and recreate all the objects.",
'args': collections.OrderedDict([
('filename', 'Absolute path to file to open. Required.\n'
'WARNING: no spaces are allowed. If unsure enclose the entire path with quotes.'),
]),
'examples': ['open_project D:\\my_project_file.FlatPrj',
'open_project "D:\\my_project_file with spaces in the name.FlatPrj"']
}
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
"""
filename = args['filename']
# if ' ' in filename:
# return "The absolute path to the project file contain spaces which is not allowed.\n" \
# "Please enclose the path within quotes."
self.app.f_handlers.open_project(filename, cli=True, plot=False, from_tcl=True)