Mercurial Repository: p/roundup/code: roundup/admin.py comparison

comparison roundup/admin.py @ 4073:145b32238093

Revert docstring markup for use with gettext tool.

author	Stefan Seefeld <stefan@seefeld.name>
date	Mon, 23 Feb 2009 20:12:23 +0000
parents	7309ac3b6e24
children	eddb82d0964c

comparison

equal deleted inserted replaced

-:d5e2767d4e91
+:145b32238093
 print _('%s:')%name
 print '   ', _(command.__doc__)
 def do_help(self, args, nl_re=re.compile('[\r\n]'),
 indent_re=re.compile(r'^(\s+)\S+')):
-"""Usage: help topic
+''"""Usage: help topic
 Give help about topic.
 commands  -- list commands
 <command> -- help specific to a command
 initopts  -- init command options
 import roundup.backends
 backends = roundup.backends.list_backends()
 print _('Back ends:'), ', '.join(backends)
 def do_install(self, tracker_home, args):
-"""Usage: install [template [backend [key=val[,key=val]]]]
+''"""Usage: install [template [backend [key=val[,key=val]]]]
 Install a new Roundup tracker.
 The command will prompt for the tracker home directory
 (if not supplied through TRACKER_HOME or the -i option).
 The template and backend may be specified on the command-line
 'database_init_file': os.path.join(tracker_home, 'initial_data.py'),
 }
 return 0
 def do_genconfig(self, args):
-"""Usage: genconfig <filename>
+''"""Usage: genconfig <filename>
 Generate a new tracker config file (ini style) with default values
 in <filename>.
 """
 if len(args) < 1:
 raise UsageError, _('Not enough arguments supplied')
 config = CoreConfig()
 config.save(args[0])
 def do_initialise(self, tracker_home, args):
-"""Usage: initialise [adminpw]
+''"""Usage: initialise [adminpw]
 Initialise a new Roundup tracker.
 The administrator details will be set at this step.
 Execute the tracker's initialisation function dbinit.init()
 return 0
 def do_get(self, args):
-"""Usage: get property designator[,designator]*
+''"""Usage: get property designator[,designator]*
 Get the given property of one or more designator(s).
 Retrieves the property value of the nodes specified
 by the designators.
 """
 return 0
 def do_set(self, args):
-"""Usage: set items property=value property=value ...
+''"""Usage: set items property=value property=value ...
 Set the given properties of one or more items(s).
 The items are specified as a class or as a comma-separated
 list of item designators (ie "designator[,designator,...]").
 raise UsageError, message
 self.db_uncommitted = True
 return 0
 def do_find(self, args):
-"""Usage: find classname propname=value ...
+''"""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.
 except (ValueError, TypeError), message:
 raise UsageError, message
 return 0
 def do_specification(self, args):
-"""Usage: specification classname
+''"""Usage: specification classname
 Show the properties for a classname.
 This lists the properties for a given class.
 """
 if len(args) < 1:
 for key in keys:
 value = cl.get(nodeid, key)
 print _('%(key)s: %(value)s')%locals()
 def do_create(self, args):
-"""Usage: create classname property=value ...
+''"""Usage: create classname property=value ...
 Create a new entry of a given class.
 This creates a new entry of the given class using the property
 name=value arguments provided on the command line after the "create"
 command.
 raise UsageError, message
 self.db_uncommitted = True
 return 0
 def do_list(self, args):
-"""Usage: list classname [property]
+''"""Usage: list classname [property]
 List the instances of a class.
 Lists all instances of the given class. If the property is not
 specified, the  "label" property is used. The label property is
 tried in order: the key, "name", "title" and then the first
 if len(args) > 2:
 raise UsageError, _('Too many arguments supplied')
 if len(args) < 1:
 raise UsageError, _('Not enough arguments supplied')
 classname = args[0]
 # get the class
 cl = self.get_class(classname)
 # figure the property
 if len(args) > 1:
 else:
 propname = cl.labelprop()
 if self.separator:
 if len(args) == 2:
 # create a list of propnames since user specified propname
 proplist=[]
 for nodeid in cl.list():
 try:
 proplist.append(cl.get(nodeid, propname))
 except KeyError:
 '"%(propname)s"')%locals()
 print _('%(nodeid)4s: %(value)s')%locals()
 return 0
 def do_table(self, args):
-"""Usage: table classname [property[,property]*]
+''"""Usage: table classname [property[,property]*]
 List the instances of a class in tabular form.
 Lists all instances of the given class. If the properties are not
 specified, all properties are displayed. By default, the column
 widths are the width of the largest value. The width may be
 l.append(f%value[:width])
 print ' '.join(l)
 return 0
 def do_history(self, args):
-"""Usage: history designator
+''"""Usage: history designator
 Show the history entries of a designator.
 Lists the journal entries for the node identified by the designator.
 """
 if len(args) < 1:
 except IndexError:
 raise UsageError, _('no such %(classname)s node "%(nodeid)s"')%locals()
 return 0
 def do_commit(self, args):
-"""Usage: commit
+''"""Usage: commit
 Commit changes made to the database during an interactive session.
 The changes made during an interactive session are not
 automatically written to the database - they must be committed
 using this command.
 self.db.commit()
 self.db_uncommitted = False
 return 0
 def do_rollback(self, args):
-"""Usage: rollback
+''"""Usage: rollback
 Undo all changes that are pending commit to the database.
 The changes made during an interactive session are not
 automatically written to the database - they must be committed
 manually. This command undoes all those changes, so a commit
 self.db.rollback()
 self.db_uncommitted = False
 return 0
 def do_retire(self, args):
-"""Usage: retire designator[,designator]*
+''"""Usage: retire designator[,designator]*
 Retire the node specified by designator.
 This action indicates that a particular node is not to be retrieved
 by the list or find commands, and its key value may be re-used.
 """
 raise UsageError, _('no such %(classname)s node "%(nodeid)s"')%locals()
 self.db_uncommitted = True
 return 0
 def do_restore(self, args):
-"""Usage: restore designator[,designator]*
+''"""Usage: restore designator[,designator]*
 Restore the retired node specified by designator.
 The given nodes will become available for users again.
 """
 if len(args) < 1:
 raise UsageError, _('no such %(classname)s node "%(nodeid)s"')%locals()
 self.db_uncommitted = True
 return 0
 def do_export(self, args, export_files=True):
-"""Usage: export [[-]class[,class]] export_dir
+''"""Usage: export [[-]class[,class]] export_dir
 Export the database to colon-separated-value files.
 To exclude the files (e.g. for the msg or file class),
 use the exporttables command.
 Optionally limit the export to just the named classes
 map(journals.writerow, cl.export_journals())
 jf.close()
 return 0
 def do_exporttables(self, args):
-"""Usage: exporttables [[-]class[,class]] export_dir
+''"""Usage: exporttables [[-]class[,class]] export_dir
 Export the database to colon-separated-value files, excluding the
 files below $TRACKER_HOME/db/files/ (which can be archived separately).
 To include the files, use the export command.
 Optionally limit the export to just the named classes
 destination directory.
 """
 return self.do_export(args, export_files=False)
 def do_import(self, args):
-"""Usage: import import_dir
+''"""Usage: import import_dir
 Import a database from the directory containing CSV files,
 two per class to import.
 The files used in the import are:
 self.db_uncommitted = True
 return 0
 def do_pack(self, args):
-"""Usage: pack period | date
+''"""Usage: pack period | date
 Remove journal entries older than a period of time specified or
 before a certain date.
 A period is specified using the suffixes "y", "m", and "d". The
 self.db.pack(pack_before)
 self.db_uncommitted = True
 return 0
 def do_reindex(self, args, desre=re.compile('([A-Za-z]+)([0-9]+)')):
-"""Usage: reindex [classname|designator]*
+''"""Usage: reindex [classname|designator]*
 Re-generate a tracker's search indexes.
 This will re-generate the search indexes for a tracker.
 This will typically happen automatically.
 """
 else:
 self.db.reindex(show_progress=True)
 return 0
 def do_security(self, args):
-"""Usage: security [Role name]
+''"""Usage: security [Role name]
 Display the Permissions available to one or all Roles.
 """
 if len(args) == 1:
 role = args[0]
 try:
 print _(' %(description)s (%(name)s)')%d
 return 0
 def do_migrate(self, args):
-"""Usage: migrate
+''"""Usage: migrate
 Update a tracker's database to be compatible with the Roundup
 codebase.
 You should run the "migrate" command for your tracker once you've
 installed the latest codebase.

Mercurial > p > roundup > code

comparison roundup/admin.py @ 4073:145b32238093