Mercurial Repository: p/roundup/code: roundup-admin comparison

comparison roundup-admin @ 377:93dc08528ad9

roundup-admin now handles all hyperdb exceptions

author	Richard Jones <richard@users.sourceforge.net>
date	Fri, 09 Nov 2001 10:11:08 +0000
parents	c6d6ea15068b
children	c7b5b1aa6b4a

comparison

equal deleted inserted replaced

-:c6d6ea15068b
+:93dc08528ad9
 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-# $Id: roundup-admin,v 1.41 2001-11-09 01:25:40 richard Exp $
+# $Id: roundup-admin,v 1.42 2001-11-09 10:11:08 richard Exp $
 import sys
 if int(sys.version[0]) < 2:
 print 'Roundup requires python 2.0 or later.'
 sys.exit(1)
 l.append((ki, self.data[ki]))
 if not l and default is self._marker:
 raise KeyError, key
 return l
+class UsageError(ValueError):
+pass
 class AdminTool:
 def __init__(self):
 self.commands = CommandDict()
 for k in AdminTool.__dict__.keys():
 topic = args[0]
 # try help_ methods
 if self.help.has_key(topic):
 self.help[topic]()
-return
+return 0
 # try command docstrings
 try:
 l = self.commands.get(topic)
 except KeyError:
 print 'Sorry, no help for "%s"'%topic
-return
+return 1
 # display the help for each match, removing the docsring indent
 for name, help in l:
 lines = nl_re.split(help.__doc__)
 print lines[0]
 for line in lines[1:]:
 if indent:
 print line[indent:]
 else:
 print line
+return 0
 def help_initopts(self):
 import roundup.templates
 templates = roundup.templates.listTemplates()
 print 'Templates:', ', '.join(templates)
 '''
 propname = args[0]
 designators = string.split(args[1], ',')
 l = []
 for designator in designators:
+# decode the node designator
 try:
 classname, nodeid = roundupdb.splitDesignator(designator)
 except roundupdb.DesignatorError, message:
-print 'Error: %s'%message
+raise UsageError, message
-return 1
-if self.comma_sep:
+# get the class
-l.append(self.db.getclass(classname).get(nodeid, propname))
+try:
-else:
+cl = self.db.getclass(classname)
-print self.db.getclass(classname).get(nodeid, propname)
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
+try:
+if self.comma_sep:
+l.append(cl.get(nodeid, propname))
+else:
+print cl.get(nodeid, propname)
+except IndexError:
+raise UsageError, 'no such %s node "%s"'%(classname, nodeid)
+except KeyError:
+raise UsageError, 'no such %s property "%s"'%(classname,
+propname)
 if self.comma_sep:
 print ','.join(l)
 return 0
 from roundup import hyperdb
 designators = string.split(args[0], ',')
 props = {}
 for prop in args[1:]:
-key, value = prop.split('=')
+if prop.find('=') == -1:
+raise UsageError, 'argument "%s" not propname=value'%prop
+try:
+key, value = prop.split('=')
+except (TypeError, ValueError):
+raise UsageError, 'argument "%s" not propname=value'%prop
 props[key] = value
 for designator in designators:
+# decode the node designator
 try:
 classname, nodeid = roundupdb.splitDesignator(designator)
 except roundupdb.DesignatorError, message:
-print 'Error: %s'%message
+raise UsageError, message
-return 1
-cl = self.db.getclass(classname)
+# get the class
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
 properties = cl.getprops()
 for key, value in props.items():
 type =  properties[key]
 if isinstance(type, hyperdb.String):
 continue
 elif isinstance(type, hyperdb.Password):
 props[key] = password.Password(value)
 elif isinstance(type, hyperdb.Date):
-props[key] = date.Date(value)
+try:
+props[key] = date.Date(value)
+except ValueError, message:
+raise UsageError, '"%s": %s'%(value, message)
 elif isinstance(type, hyperdb.Interval):
-props[key] = date.Interval(value)
+try:
+props[key] = date.Interval(value)
+except ValueError, message:
+raise UsageError, '"%s": %s'%(value, message)
 elif isinstance(type, hyperdb.Link):
 props[key] = value
 elif isinstance(type, hyperdb.Multilink):
 props[key] = value.split(',')
-apply(cl.set, (nodeid, ), props)
+# try the set
+try:
+apply(cl.set, (nodeid, ), props)
+except (TypeError, IndexError, ValueError), message:
+raise UsageError, message
 return 0
 def do_find(self, args):
 '''Usage: find classname propname=value ...
 Find the nodes of the given class with a given link property value.
 Find the nodes of the given class with a given link property value. The
 value may be either the nodeid of the linked node, or its key value.
 '''
 classname = args[0]
-cl = self.db.getclass(classname)
+# get the class
+try:
-# look up the linked-to class and get the nodeid that has the value
+cl = self.db.getclass(classname)
-propname, value = args[1].split('=')
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
+# TODO: handle > 1 argument
+# handle the propname=value argument
+if prop.find('=') == -1:
+raise UsageError, 'argument "%s" not propname=value'%prop
+try:
+propname, value = args[1].split('=')
+except (TypeError, ValueError):
+raise UsageError, 'argument "%s" not propname=value'%prop
+# if the value isn't a number, look up the linked class to get the
+# number
 num_re = re.compile('^\d+$')
 if not num_re.match(value):
-propcl = cl.properties[propname]
+# get the property
-if (not isinstance(propcl, hyperdb.Link) and not
+try:
+property = cl.properties[propname]
+except KeyError:
+raise UsageError, '%s has no property "%s"'%(classname,
+propname)
+# make sure it's a link
+if (not isinstance(property, hyperdb.Link) and not
 isinstance(type, hyperdb.Multilink)):
-print 'You may only "find" link properties'
+raise UsageError, 'You may only "find" link properties'
-return 1
-propcl = self.db.getclass(propcl.classname)
+# get the linked-to class and look up the key property
-value = propcl.lookup(value)
+link_class = self.db.getclass(property.classname)
+try:
-# now do the find
+value = link_class.lookup(value)
-if self.comma_sep:
+except TypeError:
-print ','.join(apply(cl.find, (), {propname: value}))
+raise UsageError, '%s has no key property"'%link_class.classname
-else:
+except KeyError:
-print apply(cl.find, (), {propname: value})
+raise UsageError, '%s has no entry "%s"'%(link_class.classname,
+propname)
+# now do the find
+try:
+if self.comma_sep:
+print ','.join(apply(cl.find, (), {propname: value}))
+else:
+print apply(cl.find, (), {propname: value})
+except KeyError:
+raise UsageError, '%s has no property "%s"'%(classname,
+propname)
+except (ValueError, TypeError), message:
+raise UsageError, message
 return 0
 def do_specification(self, args):
 '''Usage: specification classname
 Show the properties for a classname.
 This lists the properties for a given class.
 '''
 classname = args[0]
-cl = self.db.getclass(classname)
+# get the class
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
+# get the key property
 keyprop = cl.getkey()
 for key, value in cl.properties.items():
 if keyprop == key:
 print '%s: %s (key property)'%(key, value)
 else:
 command.
 '''
 from roundup import hyperdb
 classname = args[0]
-cl = self.db.getclass(classname)
+# get the class
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
+# now do a create
 props = {}
 properties = cl.getprops(protected = 0)
 if len(args) == 1:
 # ask for the properties
 for key, value in properties.items():
 if value:
 props[key] = value
 else:
 # use the args
 for prop in args[1:]:
-key, value = prop.split('=')
+if prop.find('=') == -1:
+raise UsageError, 'argument "%s" not propname=value'%prop
+try:
+key, value = prop.split('=')
+except (TypeError, ValueError):
+raise UsageError, 'argument "%s" not propname=value'%prop
 props[key] = value
 # convert types
 for key in props.keys():
-type =  properties[key]
+# get the property
+try:
+type = properties[key]
+except KeyError:
+raise UsageError, '%s has no property "%s"'%(classname, key)
 if isinstance(type, hyperdb.Date):
-props[key] = date.Date(value)
+try:
+props[key] = date.Date(value)
+except ValueError, message:
+raise UsageError, '"%s": %s'%(value, message)
 elif isinstance(type, hyperdb.Interval):
-props[key] = date.Interval(value)
+try:
+props[key] = date.Interval(value)
+except ValueError, message:
+raise UsageError, '"%s": %s'%(value, message)
 elif isinstance(type, hyperdb.Password):
 props[key] = password.Password(value)
 elif isinstance(type, hyperdb.Multilink):
 props[key] = value.split(',')
+# check for the key property
 if cl.getkey() and not props.has_key(cl.getkey()):
-print "You must provide the '%s' property."%cl.getkey()
+raise UsageError, "you must provide the '%s' property."%cl.getkey()
-else:
+# do the actual create
+try:
 print apply(cl.create, (), props)
+except (TypeError, IndexError, ValueError), message:
+raise UsageError, message
 return 0
 def do_list(self, args):
 '''Usage: list classname [property]
 List the instances of a class.
 specified, the  "label" property is used. The label property is tried
 in order: the key, "name", "title" and then the first property,
 alphabetically.
 '''
 classname = args[0]
-cl = self.db.getclass(classname)
+# get the class
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
+# figure the property
 if len(args) > 1:
 key = args[1]
 else:
 key = cl.labelprop()
 if self.comma_sep:
 print ','.join(cl.list())
 else:
 for nodeid in cl.list():
-value = cl.get(nodeid, key)
+try:
+value = cl.get(nodeid, key)
+except KeyError:
+raise UsageError, '%s has no property "%s"'%(classname, key)
 print "%4s: %s"%(nodeid, value)
 return 0
 def do_table(self, args):
 '''Usage: table classname [property[,property]*]
 2  bug
 3  usability
 4  feature
 '''
 classname = args[0]
-cl = self.db.getclass(classname)
+# get the class
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'invalid class "%s"'%classname
+# figure the property names to display
 if len(args) > 1:
 prop_names = args[1].split(',')
 else:
 prop_names = cl.getprops().keys()
+# now figure column widths
 props = []
-for name in prop_names:
+for spec in prop_names:
-if ':' in name:
+if ':' in spec:
-name, width = name.split(':')
+try:
-props.append((name, int(width)))
+name, width = spec.split(':')
+except (ValueError, TypeError):
+raise UsageError, '"%s" not name:width'%spec
+props.append((spec, int(width)))
 else:
-props.append((name, len(name)))
+props.append((spec, len(spec)))
+# now display the heading
 print ' '.join([string.capitalize(name) for name, width in props])
+# and the table data
 for nodeid in cl.list():
 l = []
 for name, width in props:
 if name != 'id':
-value = str(cl.get(nodeid, name))
+try:
+value = str(cl.get(nodeid, name))
+except KeyError:
+raise UsageError, '%s has no property "%s"'%(classname,
+name)
 else:
 value = str(nodeid)
 f = '%%-%ds'%width
 l.append(f%value[:width])
 print ' '.join(l)
 Lists the journal entries for the node identified by the designator.
 '''
 try:
 classname, nodeid = roundupdb.splitDesignator(args[0])
 except roundupdb.DesignatorError, message:
-print 'Error: %s'%message
+raise UsageError, message
-return 1
 # TODO: handle the -c option?
-print self.db.getclass(classname).history(nodeid)
+try:
+print self.db.getclass(classname).history(nodeid)
+except KeyError:
+raise UsageError, 'no such class "%s"'%classname
+except IndexError:
+raise UsageError, 'no such %s node "%s"'%(classname, nodeid)
 return 0
 def do_retire(self, args):
 '''Usage: retire designator[,designator]*
 Retire the node specified by designator.
 designators = string.split(args[0], ',')
 for designator in designators:
 try:
 classname, nodeid = roundupdb.splitDesignator(designator)
 except roundupdb.DesignatorError, message:
-print 'Error: %s'%message
+raise UsageError, message
-return 1
+try:
 self.db.getclass(classname).retire(nodeid)
+except KeyError:
+raise UsageError, 'no such class "%s"'%classname
+except IndexError:
+raise UsageError, 'no such %s node "%s"'%(classname, nodeid)
 return 0
 def do_export(self, args):
 '''Usage: export class[,class] destination_dir
 Export the database to tab-separated-value files.
 if csv is not None:
 p = csv.parser(field_sep=':')
 # do all the classes specified
 for classname in classes:
-cl = self.db.getclass(classname)
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'no such class "%s"'%classname
 f = open(os.path.join(dir, classname+'.csv'), 'w')
 f.write(string.join(cl.properties.keys(), ':') + '\n')
 # all nodes for this class
 properties = cl.properties.items()
 the existing database - if you want to create a new database using the
 imported data, then create a new database (or, tediously, retire all
 the old data.)
 '''
 if len(args) < 2:
-print do_import.__doc__
+raise UsageError, 'Not enough arguments supplied'
-return 1
 if csv is None:
-print 'Sorry, you need the csv module to use this function.'
+raise UsageError, \
-print 'Get it from: http://www.object-craft.com.au/projects/csv/'
+'Sorry, you need the csv module to use this function.\n'\
-return 1
+'Get it from: http://www.object-craft.com.au/projects/csv/'
 from roundup import hyperdb
 # ensure that the properties and the CSV file headings match
-cl = self.db.getclass(args[0])
+try:
+cl = self.db.getclass(classname)
+except KeyError:
+raise UsageError, 'no such class "%s"'%classname
 f = open(args[1])
 p = csv.parser(field_sep=':')
 file_props = p.parse(f.readline())
 props = cl.properties.keys()
 m = file_props[:]
 m.sort()
 props.sort()
 if m != props:
-print 'Import file doesn\'t define the same properties as "%s".'%args[0]
+raise UsageError, 'Import file doesn\'t define the same '\
-return 1
+'properties as "%s".'%args[0]
 # loop through the file and create a node for each entry
 n = range(len(props))
 while 1:
 line = f.readline()
 if len(args) < 2:
 print function.__doc__
 return 1
 # do the command
-try:
+ret = 0
-return function(args[1:])
+try:
-finally:
+ret = function(args[1:])
-self.db.close()
+except UsageError, message:
+print 'Error: %s'%message
-return 1
+print function.__doc__
+ret = 1
+except:
+import traceback
+traceback.print_exc()
+ret = 1
+return ret
 def interactive(self, ws_re=re.compile(r'\s+')):
 '''Run in an interactive mode
 '''
 print 'Roundup {version} ready for input.'
 self.instance_home = arg
 if opt == '-c':
 self.comma_sep = 1
 # if no command - go interactive
+ret = 0
 if not args:
-return self.interactive()
+self.interactive()
+else:
-self.run_command(args)
+ret = self.run_command(args)
+self.db.close()
+return ret
 if __name__ == '__main__':
 tool = AdminTool()
 sys.exit(tool.main())
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.41  2001/11/09 01:25:40  richard
+# Should parse with python 1.5.2 now.
+#
 # Revision 1.40  2001/11/08 04:42:00  richard
 # Expanded the already-abbreviated "initialise" and "specification" commands,
 # and added a comment to the command help about the abbreviation.
 #
 # Revision 1.39  2001/11/08 04:29:59  richard

Mercurial > p > roundup > code

comparison roundup-admin @ 377:93dc08528ad9