Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

slightly better CLI help

Browse Source 
svn: r21749
This commit is contained in:
Paul Franklin 2013-03-26 17:50:18 +00:00
parent c73cb0e70a
commit 7d90a49fba
2 changed files with 44 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gramps/cli/grampscli.py
View File

@ -77,14 +77,14 @@ class CLIDbLoader(object):
""" """
Issue a warning message. Inherit for GUI action Issue a warning message. Inherit for GUI action
""" """
print(_('WARNING: %s') % warnmessage) print(_('WARNING: %s') % warnmessage, file=sys.stderr)
def _errordialog(self, title, errormessage): def _errordialog(self, title, errormessage):
""" """
Show the error. A title for the error and an errormessage Show the error. A title for the error and an errormessage
Inherit for GUI action Inherit for GUI action
""" """
print(_('ERROR: %s') % errormessage) print(_('ERROR: %s') % errormessage, file=sys.stderr)
sys.exit(1) sys.exit(1)
def _dberrordialog(self, msg): def _dberrordialog(self, msg):
@ -208,7 +208,7 @@ class CLIManager(object):
""" """
Show the error. A title for the error and an errormessage Show the error. A title for the error and an errormessage
""" """
print(_('ERROR: %s') % errormessage) print(_('ERROR: %s') % errormessage, file=sys.stderr)
sys.exit(1) sys.exit(1)
def _read_recent_file(self, filename): def _read_recent_file(self, filename):
@ -296,17 +296,17 @@ def startcli(errors, argparser):
if errors: if errors:
#already errors encountered. Show first one on terminal and exit #already errors encountered. Show first one on terminal and exit
errmsg = _('Error encountered: %s') % errors[0][0] errmsg = _('Error encountered: %s') % errors[0][0]
print(errmsg) print(errmsg, file=sys.stderr)
errmsg = _(' Details: %s') % errors[0][1] errmsg = _(' Details: %s') % errors[0][1]
print(errmsg) print(errmsg, file=sys.stderr)
sys.exit(1) sys.exit(1)
if argparser.errors: if argparser.errors:
errmsg = _('Error encountered in argument parsing: %s') \ errmsg = _('Error encountered in argument parsing: %s') \
% argparser.errors[0][0] % argparser.errors[0][0]
print(errmsg) print(errmsg, file=sys.stderr)
errmsg = _(' Details: %s') % argparser.errors[0][1] errmsg = _(' Details: %s') % argparser.errors[0][1]
print(errmsg) print(errmsg, file=sys.stderr)
sys.exit(1) sys.exit(1)
#we need to keep track of the db state #we need to keep track of the db state

64
gramps/cli/plug/__init__.py
View File

@ -168,7 +168,8 @@ def _validate_options(options, dbase):
phandle = None phandle = None
person = dbase.get_person_from_handle(phandle) person = dbase.get_person_from_handle(phandle)
if not person: if not person:
print(_("ERROR: Please specify a person")) print(_("ERROR: Please specify a person"),
file=sys.stderr)
if person: if person:
option.set_value(person.get_gramps_id()) option.set_value(person.get_gramps_id())
@ -192,7 +193,7 @@ def _validate_options(options, dbase):
family = dbase.get_family_from_handle(family_handle) family = dbase.get_family_from_handle(family_handle)
option.set_value(family.get_gramps_id()) option.set_value(family.get_gramps_id())
else: else:
print(_("ERROR: Please specify a family")) print(_("ERROR: Please specify a family"), file=sys.stderr)
#------------------------------------------------------------------------ #------------------------------------------------------------------------
# #
@ -264,17 +265,21 @@ class CommandLineReport(object):
} }
self.options_help = { self.options_help = {
'of' : ["=filename", "Output file name. MANDATORY", ""], 'of' : [_("=filename"), _("Output file name. MANDATORY"),""],
'off' : ["=format", "Output file format.", []], 'off' : [_("=format"), _("Output file format."), []],
'style' : ["=name", "Style name.", ""], 'style' : [_("=name"), _("Style name."), ""],
'papers' : ["=name", "Paper size name.", ""], 'papers' : [_("=name"), _("Paper size name."), ""],
'papero' : ["=num", "Paper orientation number.", ""], 'papero' : [_("=number"), _("Paper orientation number."), ""],
'paperml' : ["=num", "Left paper margin", "Size in cm"], 'paperml' : [_("=number"), _("Left paper margin"),
'papermr' : ["=num", "Right paper margin", "Size in cm"], _("Size in cm")],
'papermt' : ["=num", "Top paper margin", "Size in cm"], 'papermr' : [_("=number"), _("Right paper margin"),
'papermb' : ["=num", "Bottom paper margin", "Size in cm"], _("Size in cm")],
'css' : ["=css filename", "CSS filename to use, html format" 'papermt' : [_("=number"), _("Top paper margin"),
" only", ""], _("Size in cm")],
'papermb' : [_("=number"), _("Bottom paper margin"),
_("Size in cm")],
'css' : [_("=css filename"), _("CSS filename to use, "
"html format only"), ""],
} }
if noopt: if noopt:
@ -416,12 +421,14 @@ class CommandLineReport(object):
elif isinstance(option, Option): elif isinstance(option, Option):
self.options_help[name].append(option.get_help()) self.options_help[name].append(option.get_help())
else: else:
print(_("Unknown option: %s") % option) print(_("Unknown option: %s") % option, file=sys.stderr)
print(_(" Valid options are:"), print(_(" Valid options are:"),
", ".join(list(self.options_dict.keys()))) ", ".join(list(self.options_dict.keys())),
file=sys.stderr)
print(_(" Use '%(donottranslate)s' to see description " print(_(" Use '%(donottranslate)s' to see description "
"and acceptable values") "and acceptable values")
% {'donottranslate' : "show=option"}) % {'donottranslate' : "show=option"},
file=sys.stderr)
def parse_options(self): def parse_options(self):
""" """
@ -475,9 +482,10 @@ class CommandLineReport(object):
"and using '%(notranslate1)s=%(notranslate3)s'.") "and using '%(notranslate1)s=%(notranslate3)s'.")
% {'notranslate1' : "off", % {'notranslate1' : "off",
'notranslate2' : self.options_dict['off'], 'notranslate2' : self.options_dict['off'],
'notranslate3' : _chosen_format}) 'notranslate3' : _chosen_format},
file=sys.stderr)
print(_("Use '%(notranslate)s' to see valid values.") print(_("Use '%(notranslate)s' to see valid values.")
% {'notranslate' : "show=off"}) % {'notranslate' : "show=off"}, file=sys.stderr)
self.do_doc_options() self.do_doc_options()
@ -495,12 +503,13 @@ class CommandLineReport(object):
option.set_value(self.options_dict[opt]) option.set_value(self.options_dict[opt])
else: else:
print(_("Ignoring unknown option: %s") % opt ) print(_("Ignoring unknown option: %s") % opt, file=sys.stderr)
print(_(" Valid options are:"), print(_(" Valid options are:"),
", ".join(list(self.options_dict.keys()))) ", ".join(list(self.options_dict.keys())),
file=sys.stderr)
print(_(" Use '%(donottranslate)s' to see description " print(_(" Use '%(donottranslate)s' to see description "
"and acceptable values") % "and acceptable values") %
{'donottranslate' : "show=option"}) {'donottranslate' : "show=option"}, file=sys.stderr)
self.option_class.handler.output = self.options_dict['of'] self.option_class.handler.output = self.options_dict['of']
@ -594,7 +603,8 @@ class CommandLineReport(object):
print(_("option '%(optionname)s' not valid. " print(_("option '%(optionname)s' not valid. "
"Use '%(donottranslate)s' to see all valid options.") "Use '%(donottranslate)s' to see all valid options.")
% {'optionname' : self.show, % {'optionname' : self.show,
'donottranslate' : "show=all"}) 'donottranslate' : "show=all"},
file=sys.stderr)
#------------------------------------------------------------------------ #------------------------------------------------------------------------
# #
@ -642,10 +652,10 @@ def cl_report(database, name, category, report_class, options_class,
return clr return clr
except ReportError as msg: except ReportError as msg:
(m1, m2) = msg.messages() (m1, m2) = msg.messages()
print(err_msg) print(err_msg, file=sys.stderr)
print(m1) print(m1, file=sys.stderr)
if m2: if m2:
print(m2) print(m2, file=sys.stderr)
except: except:
if len(log.handlers) > 0: if len(log.handlers) > 0:
log.error(err_msg, exc_info=True) log.error(err_msg, exc_info=True)
@ -768,10 +778,10 @@ def write_book_item(database, report_class, options, user):
return report_class(database, options, user) return report_class(database, options, user)
except ReportError as msg: except ReportError as msg:
(m1, m2) = msg.messages() (m1, m2) = msg.messages()
print("ReportError", m1, m2) print("ReportError", m1, m2, file=sys.stderr)
except FilterError as msg: except FilterError as msg:
(m1, m2) = msg.messages() (m1, m2) = msg.messages()
print("FilterError", m1, m2) print("FilterError", m1, m2, file=sys.stderr)
except: except:
log.error("Failed to write book item.", exc_info=True) log.error("Failed to write book item.", exc_info=True)
return None return None