def parse_opts(doc=__doc__,
vcp_name='NotSpecified',
vcp_cmd='notspecified',
vcp_version=None):
# LinuxCNC passes the INI file as `-ini=inifile` which docopt sees as a
# short argument which does not support an equals sign, so we loop thru
# and add another dash to the ini argument if needed.
for index, item in enumerate(sys.argv):
if item.startswith('-ini'):
sys.argv[index] = '-' + item
break
version_str = 'QtPyVCP {}'.format(QTPYVCP_VERSION)
if vcp_version is not None:
version_str += ', {} v{}'.format(vcp_name, vcp_version)
doc = doc.format(vcp_name=vcp_name, vcp_cmd=vcp_cmd)
raw_args = docopt(doc, version=version_str)
def convType(val):
if isinstance(val, basestring):
if val.lower() in ['true', 'on', 'yes', 'false', 'off', 'no']:
return val.lower() in ['true', 'on', 'yes']
try:
return int(val)
except ValueError:
pass
try:
return float(val)
except ValueError:
pass
return val
# convert raw argument dict keys to valid python attribute names
opts = DotDict({
arg.strip('-<>').replace('-', '_'): convType(value)
for arg, value in raw_args.items()
})
# read options from INI file and merge with cmd line options
ini_file = ini(
normalizePath(opts.ini, os.path.expanduser('~/linuxcnc/configs')))
for k, v in opts.iteritems():
ini_val = ini_file.find('DISPLAY', k.upper().replace('-', '_'))
if ini_val is None:
continue
# convert str values to bool
if type(v) == bool:
# TODO: Find a way to prefer cmd line values over INI values
ini_val = ini_val.lower() in ['true', 'on', 'yes', '1']
# if its a non bool value and it was specified on the cmd line
# then prefer the cmd line value
elif v is not None:
continue
opts[k] = convType(ini_val)
# Check if LinuxCNC is running
if not os.path.isfile('/tmp/linuxcnc.lock'):
# LinuxCNC is not running.
# TODO: maybe launch LinuxCNC using subprocess?
print 'LinuxCNC must be running to launch a VCP'
sys.exit()
# setup the environment variables
ini_file = os.environ.get('INI_FILE_NAME') or opts.ini
if ini_file is None:
print 'LinuxCNC is running, but you must specify the INI file'
sys.exit()
if not os.getenv('INI_FILE_NAME'):
base_path = os.path.expanduser('~/linuxcnc/configs')
ini_file = os.path.realpath(normalizePath(ini_file, base_path))
if not os.path.isfile(ini_file):
print 'Specified INI file does not exist: {}'.format(ini_file)
sys.exit()
os.environ['INI_FILE_NAME'] = ini_file
os.environ['CONFIG_DIR'] = os.path.dirname(ini_file)
if opts.qt_api:
os.environ['QT_API'] = opts.qt_api
if opts.config_file is not None:
# cmd line config file should be relative to INI file
config_dir = os.getenv('CONFIG_DIR', '')
config_file_path = normalizePath(opts.config_file, config_dir)
if not os.path.isfile(config_file_path):
print 'Specified YAML file does not exist: {}'.format(
config_file_path)
sys.exit()
opts.config_file = config_file_path
# show the chooser if the --chooser flag was specified
if opts.chooser or not opts.get('vcp', True):
from qtpyvcp.vcp_chooser import VCPChooser
from qtpy.QtWidgets import QApplication, qApp
app = QApplication([])
result = VCPChooser(opts).exec_()
if result == VCPChooser.Rejected:
sys.exit()
# destroy the evidence
qApp.deleteLater()
del app
# normalize log file path
log_file = normalizePath(opts.log_file,
os.getenv('CONFIG_DIR') or os.getenv('HOME'))
if log_file is None or os.path.isdir(log_file):
log_file = os.path.expanduser('~/qtpyvcp.log')
opts.log_file = log_file
# init the logger
from qtpyvcp.utilities import logger
LOG = logger.initBaseLogger('qtpyvcp',
log_file=opts.log_file,
log_level=opts.log_level or "INFO")
LOG.info("QtPyVCP Version: %s", QTPYVCP_VERSION)
if LOG.getEffectiveLevel() == logger.LOG_LEVEL_MAPPING['DEBUG']:
import qtpy
LOG.debug("Qt Version: %s", qtpy.QT_VERSION)
LOG.debug("Qt API: %s", qtpy.QT_API)
LOG.debug("QtPy Version: %s", qtpy.__version__)
LOG.debug("Command line options:\n%s",
json.dumps(opts, sort_keys=True, indent=4))
return opts
def apply_opts(opts):
# read options from INI file and merge with cmd line options
ini_file = normalizePath(opts.ini, os.path.expanduser('~/linuxcnc/configs'))
ini_obj = ini(ini_file)
for k, v in opts.iteritems():
ini_val = ini_obj.find('DISPLAY', k.upper().replace('-', '_'))
if ini_val is None:
continue
# convert str values to bool
if type(v) == bool:
# TODO: Find a way to prefer cmd line values over INI values
ini_val = ini_val.lower() in ['true', 'on', 'yes', '1']
# if its a non bool value and it was specified on the cmd line
# then prefer the cmd line value
elif v is not None:
continue
# If a VCP is specified in the INI as a .ui or .yaml file the path
# should be relative to the config dir rather then the $PWD.
if k.lower() == 'vcp' and ini_val.lower().split('.')[-1] in ['ui', 'yml', 'yaml']:
ini_val = normalizePath(ini_val, os.path.dirname(ini_file))
opts[k] = convType(ini_val)
# Check if LinuxCNC is running
if not os.path.isfile('/tmp/linuxcnc.lock'):
# LinuxCNC is not running.
# TODO: maybe launch LinuxCNC using subprocess?
print 'LinuxCNC must be running to launch a VCP'
sys.exit()
# setup the environment variables
ini_file = os.environ.get('INI_FILE_NAME') or opts.ini
if ini_file is None:
print 'LinuxCNC is running, but you must specify the INI file'
sys.exit()
if not os.getenv('INI_FILE_NAME'):
base_path = os.path.expanduser('~/linuxcnc/configs')
ini_file = os.path.realpath(normalizePath(ini_file, base_path))
if not os.path.isfile(ini_file):
print 'Specified INI file does not exist: {}'.format(ini_file)
sys.exit()
os.environ['INI_FILE_NAME'] = ini_file
os.environ['CONFIG_DIR'] = os.path.dirname(ini_file)
if opts.qt_api:
os.environ['QT_API'] = opts.qt_api
if opts.config_file is not None:
# cmd line config file should be relative to INI file
config_dir = os.getenv('CONFIG_DIR', '')
config_file_path = normalizePath(opts.config_file, config_dir)
if not os.path.isfile(config_file_path):
print 'Specified YAML file does not exist: {}'.format(config_file_path)
sys.exit()
opts.config_file = config_file_path
# show the chooser if the --chooser flag was specified
if opts.chooser or not opts.get('vcp', True):
from qtpyvcp.vcp_chooser import VCPChooser
from qtpy.QtWidgets import QApplication, qApp
app = QApplication([])
result = VCPChooser(opts).exec_()
if result == VCPChooser.Rejected:
sys.exit()
# destroy the evidence
qApp.deleteLater()
del app
# normalize log file path
log_file = normalizePath(opts.log_file,
os.getenv('CONFIG_DIR') or
os.getenv('HOME'))
if log_file is None or os.path.isdir(log_file):
log_file = os.path.expanduser('~/qtpyvcp.log')
opts.log_file = log_file
# init the logger
from qtpyvcp.utilities import logger
LOG = logger.initBaseLogger('qtpyvcp',
log_file=opts.log_file,
log_level=opts.log_level or "INFO")
LOG.info("QtPyVCP Version: %s", QTPYVCP_VERSION)
if LOG.getEffectiveLevel() == logger.logLevelFromName("DEBUG"):
import qtpy
LOG.debug("Qt Version: %s", qtpy.QT_VERSION)
LOG.debug("Qt API: %s", qtpy.QT_API)
LOG.debug("QtPy Version: %s", qtpy.__version__)
LOG.debug("Command line options:\n%s",
json.dumps(opts, sort_keys=True, indent=4))
return opts