Mercurial > libervia-backend
view frontends/src/jp/cmd_input.py @ 2278:489efbda377c
jp (input): input command first draft:
this is an experimental command to use external data as input arguments.
A series of data is used (only CSV is implemented so far), and it is used to fill argument of a command according to a sequence.
The sequence is given using input arguments, with types corresponding to the data found (short option, long option, stdin).
e.g. if a CSV file has row with 3 columns, we can say that column 1 is subject (long option), column 2 is body (stdin), and column 3 is language (short option -l).
A filter can be used after each option type, to transform read value.
Finally a static part is used to have the main command and non dynamic arguments to use.
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 28 Jun 2017 01:28:41 +0200 |
parents | |
children | d8e48c850ad2 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # jp: a SàT command line tool # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero 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 Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. import base from sat.core.i18n import _ from sat_frontends.jp.constants import Const as C from sat.tools.common.ansi import ANSI as A import subprocess import argparse import os import sys __commands__ = ["Input"] OPT_STDIN = 'stdin' OPT_SHORT = 'short' OPT_LONG = 'long' OPT_POS = 'positional' OPT_IGNORE = 'ignore' OPT_TYPES = (OPT_STDIN, OPT_SHORT, OPT_LONG, OPT_POS, OPT_IGNORE) class InputCommon(base.CommandBase): def __init__(self, host, name, help): base.CommandBase.__init__(self, host, name, use_verbose=True, use_profile=False, help=help) self.idx = 0 self.reset() def reset(self): self.args_idx = 0 self._stdin = [] self._opts = [] self._pos = [] def add_parser_options(self): self.parser.add_argument("--encoding", default='utf-8', help=_(u"encoding of the input data")) self.parser.add_argument("-i", "--stdin", action='append_const', const=(OPT_STDIN, None), dest='arguments', help=_(u"standard input")) self.parser.add_argument("-s", "--short", type=self.opt(OPT_SHORT), action='append', dest='arguments', help=_(u"short option")) self.parser.add_argument("-l", "--long", type=self.opt(OPT_LONG), action='append', dest='arguments', help=_(u"long option")) self.parser.add_argument("-p", "--positional", type=self.opt(OPT_POS), action='append', dest='arguments', help=_(u"positional argument")) self.parser.add_argument("-x", "--ignore", action='append_const', const=(OPT_IGNORE, None), dest='arguments', help=_(u"ignore value")) self.parser.add_argument("-D", "--debug", action='store_true', help=_(u"don't actually run commands but echo what would be launched")) self.parser.add_argument("command", nargs=argparse.REMAINDER) def opt(self, type_): return lambda s: (type_, s) def addValue(self, value): """add a parsed value according to arguments sequence""" arguments = self.args.arguments try: arg_type, arg_name = arguments[self.args_idx] except IndexError: self.disp(_(u"arguments in input data and in arguments sequence don't match"), error=True) self.host.quit(C.EXIT_DATA_ERROR) self.args_idx += 1 while self.args_idx < len(arguments): next_arg = arguments[self.args_idx] if next_arg[0] not in OPT_TYPES: # we have a filter filter_type, filter_arg = arguments[self.args_idx] value = self.filter(filter_type, filter_arg, value) else: break self.args_idx += 1 if not isinstance(value, list): value = [value] for v in value: if arg_type == OPT_STDIN: self._stdin.append(v.encode('utf-8')) elif arg_type == OPT_SHORT: self._opts.append('-{}'.format(arg_name)) self._opts.append(v.encode('utf-8')) elif arg_type == OPT_LONG: self._opts.append('--{}'.format(arg_name)) self._opts.append(v.encode('utf-8')) elif arg_type == OPT_POS: self._pos.append(v.encode('utf-8')) elif arg_type == OPT_IGNORE: pass else: self.parser.error(_(u"Invalid argument, an option type is expected, got {type_}:{name}").format( type_=arg_type, name=arg_name)) def runCommand(self): """run requested command with parsed arguments""" if self.args_idx != len(self.args.arguments): self.disp(_(u"arguments in input data and in arguments sequence don't match"), error=True) self.host.quit(C.EXIT_DATA_ERROR) stdin = ''.join(self._stdin) if self.args.debug: self.disp(_(u'command {idx}').format(idx=self.idx)) if stdin: self.disp(u'--- STDIN ---') self.disp(stdin.decode('utf-8')) self.disp(u'-------------') self.disp(u'{indent}{prog} {static} {options} {positionals}'.format( indent = 4*u' ', prog=sys.argv[0], static = ' '.join(self.args.command).encode('utf-8'), options = u' '.join([o.encode('utf-8') for o in self._opts]), positionals = u' '.join([p.encode('utf-8') for p in self._pos]) )) self.disp(u'') else: self.disp(_(u'command {idx}').format(idx=self.idx), no_lf=True) with open(os.devnull, 'wb') as DEVNULL: p = subprocess.Popen([sys.argv[0]] + self.args.command + self._opts + self._pos, stdin=subprocess.PIPE, stdout=DEVNULL, stderr=DEVNULL) p.communicate(stdin) ret = p.wait() if ret == 0: self.disp(A.color(C.A_SUCCESS, _(u'OK'))) else: self.disp(A.color(C.A_FAILURE, _(u'FAILED'))) self.reset() self.idx += 1 def filter(self, filter_type, filter_arg, value): raise NotImplementedError class Csv(InputCommon): def __init__(self, host): super(Csv, self).__init__(host, 'csv', _(u'comma-separated values')) def add_parser_options(self): InputCommon.add_parser_options(self) self.parser.add_argument("-r", "--row", type=int, default=0, help=_(u"starting row (previous ones will be ignored)")) self.parser.add_argument("-S", "--split", action='append_const', const=('split', None), dest='arguments', help=_(u"split value in several options")) def filter(self, arg_type, filter_type, filter_arg, value): if filter_type == 'split': return value.split() super(Csv, self).filter(filter_type, filter_arg, value) def start(self): import csv reader = csv.reader(sys.stdin) for idx, row in enumerate(reader): if idx < self.args.row: continue for value in row: self.addValue(value.decode(self.args.encoding)) self.runCommand() class Input(base.CommandBase): subcommands = (Csv,) def __init__(self, host): super(Input, self).__init__(host, 'input', use_profile=False, help=_(u'launch command with external input'))