mmgen-wallet/mmgen/share/Opts.py

#!/usr/bin/env python3
#
# Opts.py, an options parsing library for Python.
# Copyright (C)2013-2018 The MMGen Project <mmgen@tuta.io>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""
Opts.py:  Generic options parsing
"""

import sys,getopt
import collections

def usage(opts_data):
	print('USAGE: {} {}'.format(opts_data['prog_name'], opts_data['usage']))
	sys.exit(2)

def print_help_and_exit(opts_data,longhelp=False):
	pn = opts_data['prog_name']
	pn_len = str(len(pn)+2)
	out  = '  {:<{p}} {}\n'.format(pn.upper()+':',opts_data['desc'].strip(),p=pn_len)
	out += '  {:<{p}} {} {}\n'.format('USAGE:',pn,opts_data['usage'].strip(),p=pn_len)
	o = opts_data[('options','long_options')[longhelp]].strip()
	if 'options_fmt_args' in opts_data:
		o = o.format(**opts_data['options_fmt_args']())
	hdr = ('OPTIONS:','  LONG OPTIONS:')[longhelp]
	ls = ('  ','')[longhelp]
	es = ('','    ')[longhelp]
	out += '{ls}{}\n{ls}{es}{}'.format(hdr,('\n'+ls).join(o.splitlines()),ls=ls,es=es)
	if 'notes' in opts_data and not longhelp:
		n = opts_data['notes']
		if isinstance(n, collections.Callable): n = n()
		out += '\n  ' + '\n  '.join(n.rstrip().splitlines())
	print(out)
	sys.exit(0)

def process_opts(argv,opts_data,short_opts,long_opts,skip_help=False):

	import os
	opts_data['prog_name'] = os.path.basename(sys.argv[0])
	long_opts  = [i.replace('_','-') for i in long_opts]

	so_str = short_opts.replace('-:','').replace('-','')
	try: cl_opts,args = getopt.getopt(argv[1:], so_str, long_opts)
	except getopt.GetoptError as err:
		print(str(err))
		sys.exit(2)

	sopts_list = ':_'.join(['_'.join(list(i)) for i in short_opts.split(':')]).split('_')
	opts,skipped_help = {},False

	for opt,arg in cl_opts:
		if opt in ('-h','--help'):
			if not skip_help: print_help_and_exit(opts_data)
			skipped_help = True
		elif opt == '--longhelp':
			if not skip_help: print_help_and_exit(opts_data,longhelp=True)
			skipped_help = True
		elif opt[:2] == '--' and opt[2:] in long_opts:
			opts[opt[2:].replace('-','_')] = True
		elif opt[:2] == '--' and opt[2:]+'=' in long_opts:
			opts[opt[2:].replace('-','_')] = arg
		elif opt[1] != '-' and opt[1] in sopts_list:
			opts[long_opts[sopts_list.index(opt[1:])].replace('-','_')] = True
		elif opt[1] != '-' and opt[1:]+':' in sopts_list:
			opts[long_opts[sopts_list.index(
					opt[1:]+':')][:-1].replace('-','_')] = arg
		else: assert False, 'Invalid option'

	if 'sets' in opts_data:
		for o_in,v_in,o_out,v_out in opts_data['sets']:
			if o_in in opts:
				v = opts[o_in]
				if (v and v_in == bool) or v == v_in:
					if o_out in opts and opts[o_out] != v_out:
						sys.stderr.write(
							'Option conflict:\n  --{}={}, with\n  --{}={}\n'.format(
								o_out.replace('_','-'),opts[o_out],
								o_in.replace('_','-'),opts[o_in]))
						sys.exit(1)
					else:
						opts[o_out] = v_out

	return opts,args,skipped_help

def parse_opts(argv,opts_data,opt_filter=None,skip_help=False):

	import re
	pat = r'^-([a-zA-Z0-9-]), --([a-zA-Z0-9-]{2,64})(=| )(.+)'
	od_all = []

	for k in ['options'] + ([],['long_options'])['long_options' in opts_data]:
		od,skip = [],True
		for l in opts_data[k].strip().splitlines():
			m = re.match(pat,l)
			if m:
				skip = (False,True)[bool(opt_filter) and m.group(1) not in opt_filter]
				app = (['',''],[':','='])[m.group(3) == '=']
				od.append(list(m.groups()) + app + [skip])
			else:
				if not skip: od[-1][3] += '\n' + l

		opts_data[k] = '\n'.join(
			['{:<3} --{} {}'.format(
				('-'+d[0]+',','')[d[0]=='-'],d[1],d[3]) for d in od if d[6] == False]
		)
		od_all += od
	short_opts    = ''.join([d[0]+d[4] for d in od_all if d[6] == False])
	long_opts     = [d[1].replace('-','_')+d[5] for d in od_all if d[6] == False]
	skipped_opts  = [d[1].replace('-','_') for d in od_all if d[6] == True]

	opts,args,skipped_help = process_opts(argv,opts_data,short_opts,long_opts,skip_help=skip_help)

	return opts,args,short_opts,long_opts,skipped_opts,skipped_help