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

comparison roundup/admin.py @ 6585:d4371b131c9c

flake 8 improvements Renamed some variables from l to something (I hope) more descriptive. Left a number of long lines and unindented quoted ''' string blocks. The blocks are often inside a _() translation function call. Adding white space to indent them would mess up the translation tables and require reformatting as they are output. I might be able to reformat: _( ''' message for the user here on multiple lines''' ) as separate concatenated lines and preserve the translation key but...

author	John Rouillard <rouilj@ieee.org>
date	Sun, 16 Jan 2022 12:54:26 -0500
parents	8687c096a945
children	408fd477761f

comparison

equal deleted inserted replaced

-:770503bd211e
+:d4371b131c9c
 """
 from __future__ import print_function
 __docformat__ = 'restructuredtext'
-import csv, getopt, getpass, os, re, shutil, sys, operator
+import csv, getopt, getpass, operator, os, re, shutil, sys
 from roundup import date, hyperdb, init, password, token
 from roundup import __version__ as roundup_version
 import roundup.instance
 from roundup.configuration import (CoreConfig, NoConfigError,
 def get(self, key, default=_marker):
 if key in self.data:
 return [(key, self.data[key])]
 keylist = sorted(self.data)
-l = []
+matching_keys = []
 for ki in keylist:
 if ki.startswith(key):
-l.append((ki, self.data[ki]))
+matching_keys.append((ki, self.data[ki]))
-if not l and default is self._marker:
+if not matching_keys and default is self._marker:
 raise KeyError(key)
-return l
+# FIXME: what happens if default is not self._marker but
+# there are no matching keys? Should (default, self.data[default])
+# be returned???
+return matching_keys
 class AdminTool:
 """ A collection of methods used in maintaining Roundup trackers.
 The args list is specified as ``prop=value prop=value ...``.
 """
 props = {}
 for arg in args:
-l = arg.split('=', 1)
+key_val = arg.split('=', 1)
 # if = not in string, will return one element
-if len(l) < 2:
+if len(key_val) < 2:
 raise UsageError(_('argument "%(arg)s" not propname=value') %
 locals())
-key, value = l
+key, value = key_val
 if value:
 props[key] = value
 else:
 props[key] = None
 return props
 def usage(self, message=''):
 """ Display a simple usage message.
 """
 if message:
-message = _('Problem: %(message)s\n\n')% locals()
+message = _('Problem: %(message)s\n\n') % locals()
 sys.stdout.write(_("""%(message)sUsage: roundup-admin [options] [<command> <arguments>]
 Options:
 -i instance home  -- specify the issue tracker "home directory" to administer
 -u                -- the user[:password] to use for commands (default admin)
 self.help[topic]()
 return 0
 # try command docstrings
 try:
-l = self.commands.get(topic)
+cmd_docs = self.commands.get(topic)
 except KeyError:
 print(_('Sorry, no help for "%(topic)s"') % locals())
 return 1
 # display the help for each match, removing the docstring indent
-for _name, help in l:
+for _name, help in cmd_docs:
 lines = nl_re.split(_(help.__doc__))
 print(lines[0])
 indent = indent_re.match(lines[1])
 if indent: indent = len(indent.group(1))
 for line in lines[1:]:
 # __file__ should be something like:
 #    /usr/local/lib/python3.10/site-packages/roundup/admin.py
 # os.prefix should be /usr, /usr/local or root of virtualenv
 #    strip leading / to make os.path.join work right.
 path = __file__
-for N in 1, 2:
+for _N in 1, 2:
 path = os.path.dirname(path)
 # path is /usr/local/lib/python3.10/site-packages
 tdir = os.path.join(path, sys.prefix[1:], 'share',
 'roundup', 'templates')
 if os.path.isdir(tdir):
 templates.update(init.listTemplates(tdir))
 # OK, now try as if we're in the roundup source distribution
 # directory, so this module will be in .../roundup-*/roundup/admin.py
 # and we're interested in the .../roundup-*/ part.
 path = __file__
 for _i in range(2):
 # load config_ini.ini from template if it exists.
 # it sets parameters like template_engine that are
 # template specific.
 template_config = UserConfig(templates[template]['path'] +
 "/config_ini.ini")
 for k in template_config.keys():
 if k == 'HOME':  # ignore home. It is a default param.
 continue
 defns[k] = template_config[k]
 """
 if len(args) < 2:
 raise UsageError(_('Not enough arguments supplied'))
 propname = args[0]
 designators = args[1].split(',')
-l = []
+linked_props = []
 for designator in designators:
 # decode the node designator
 try:
 classname, nodeid = hyperdb.splitDesignator(designator)
 except hyperdb.DesignatorError as message:
 ' Multilink or Link so -d flag does not '
 'apply.') % propname)
 propclassname = self.db.getclass(property.classname).classname
 id = cl.get(nodeid, propname)
 for i in id:
-l.append(propclassname + i)
+linked_props.append(propclassname + i)
 else:
 id = cl.get(nodeid, propname)
 for i in id:
-l.append(i)
+linked_props.append(i)
 else:
 if self.print_designator:
 properties = cl.getprops()
 property = properties[propname]
 if not (isinstance(property, hyperdb.Multilink) or
 '"%(nodeid)s"') % locals())
 except KeyError:
 raise UsageError(_('no such %(classname)s property '
 '"%(propname)s"') % locals())
 if self.separator:
-print(self.separator.join(l))
+print(self.separator.join(linked_props))
 return 0
 def do_set(self, args):
 ''"""Usage: set items property=value property=value ...
 # multiple , separated values become a list
 for propname, value in props.items():
 if ',' in value:
 values = value.split(',')
 else:
-values = [ value ]
+values = [value]
 props[propname] = []
 # start handling transitive props
 # given filter issue assignedto.roles=Admin
 # start at issue
 curclass = cl
-lastprop = propname # handle case 'issue assignedto=admin'
+lastprop = propname  # handle case 'issue assignedto=admin'
 if '.' in propname:
 # start splitting transitive prop into components
 # we end when we have no more links
 for pn in propname.split('.'):
 try:
-lastprop=pn # get current component
+lastprop = pn  # get current component
 # get classname for this link
 try:
 curclassname = curclass.getprops()[pn].classname
 except KeyError:
 raise UsageError(_("Class %(curclassname)s has "
 # now do the filter
 try:
 id = []
 designator = []
-props = { "filterspec": props }
+props = {"filterspec": props}
 if self.separator:
 if self.print_designator:
 id = cl.filter(None, **props)
 for i in id:
 # convert types
 for propname in props:
 try:
 props[propname] = hyperdb.rawToHyperdb(self.db, cl, None,
 propname, props[propname])
 except hyperdb.HyperdbValueError as message:
 raise UsageError(message)
 # check for the key property
 propname = cl.getkey()
 if propname and propname not in props:
 raise UsageError(_('you must provide the "%(propname)s" '
 'property.') % locals())
 # do the actual create
 try:
 sys.stdout.write(cl.create(**props) + '\n')
 except (TypeError, IndexError, ValueError) as message:
 props = []
 for spec in prop_names:
 if ':' in spec:
 name, width = spec.split(':')
 if width == '':
 # spec includes trailing :, use label/name width
 props.append((name, len(name)))
 else:
 try:
 props.append((name, int(width)))
 except ValueError:
 print(' '.join([name.capitalize().ljust(width)
 for name, width in props]))
 # and the table data
 for nodeid in cl.list():
-l = []
+table_columns = []
 for name, width in props:
 if name != 'id':
 try:
 value = str(cl.get(nodeid, name))
 except KeyError:
 # value for it
 value = ''
 else:
 value = str(nodeid)
 f = '%%-%ds' % width
-l.append(f % value[:width])
+table_columns.append(f % value[:width])
-print(' '.join(l))
+print(' '.join(table_columns))
 return 0
 def do_history(self, args):
 ''"""Usage: history designator [skipquiet]
 Show the history entries of a designator.
 dbclass.restore(nodeid)
 except KeyError as e:
 raise UsageError(e.args[0])
 except IndexError:
 raise UsageError(_('no such %(classname)s node '
-'" % (nodeid)s"')%locals())
+'" % (nodeid)s"') % locals())
 self.db_uncommitted = True
 return 0
 def do_export(self, args, export_files=True):
 ''"""Usage: export [[-]class[,class]] export_dir
 # get the list of classes to export
 if len(args) == 2:
 if args[0].startswith('-'):
 classes = [c for c in self.db.classes
 if c not in args[0][1:].split(',')]
 else:
 classes = args[0].split(',')
 else:
 classes = self.db.classes
 for classname in classes:
 cl = self.get_class(classname)
 if not export_files and hasattr(cl, 'export_files'):
 sys.stdout.write('Exporting %s WITHOUT the files\r\n' %
 classname)
 with open(os.path.join(dir, classname+'.csv'), 'w') as f:
 writer = csv.writer(f, colon_separated)
-properties = cl.getprops()
 propnames = cl.export_propnames()
 fields = propnames[:]
 fields.append('is retired')
 writer.writerow(fields)
 #     _class.__retired__, _<class>._<keyname>
 # on imports to rdbms.
 all_nodes = cl.getnodeids()
 classkey = cl.getkey()
-if classkey: # False sorts before True, so negate is_retired
+if classkey:  # False sorts before True, so negate is_retired
 keysort = lambda i: (cl.get(i, classkey),
 not cl.is_retired(i))
 all_nodes.sort(key=keysort)
 # if there is no classkey no need to sort
 for nodeid in all_nodes:
 if self.verbose:
 sys.stdout.write('\rExporting %s - %s' %
 (classname, nodeid))
 sys.stdout.flush()
 node = cl.getnode(nodeid)
 exp = cl.export_list(propnames, nodeid)
-lensum = sum([len(repr_export(node[p])) for p in propnames])
+lensum = sum([len(repr_export(node[p])) for
+p in propnames])
 # for a safe upper bound of field length we add
 # difference between CSV len and sum of all field lengths
 d = sum([len(x) for x in exp]) - lensum
 if not d > 0:
 raise AssertionError("Bad assertion d > 0")
 cl.export_files(dir, nodeid)
 # export the journals
 with open(os.path.join(dir, classname+'-journals.csv'), 'w') as jf:
 if self.verbose:
-sys.stdout.write("\nExporting Journal for %s\n" % classname)
+sys.stdout.write("\nExporting Journal for %s\n" %
+classname)
 sys.stdout.flush()
 journals = csv.writer(jf, colon_separated)
 for row in cl.export_journals():
 journals.writerow(row)
 if max_len > self.db.config.CSV_FIELD_SIZE:
 try:
 functions = self.commands.get(command)
 except KeyError:
 # not a valid command
 print(_('Unknown command "%(command)s" ("help commands" for a '
 'list)') % locals())
 return 1
 # check for multiple matches
 if len(functions) > 1:
-print(_('Multiple commands match "%(command)s": %(list)s') % \
+print(_('Multiple commands match "%(command)s": %(list)s') %
 {'command': command,
 'list': ', '.join([i[0] for i in functions])})
 return 1
 command, function = functions[0]
 return 1
 except NoConfigError as message:  # noqa: F841
 self.tracker_home = ''
 print(_("Error: Couldn't open tracker: %(message)s") % locals())
 return 1
-except ParsingOptionError as message:
+except ParsingOptionError as message: # message used via locals
 print("%(message)s" % locals())
 return 1
 # only open the database once!
 if not self.db:
 # handle command-line args
 self.tracker_home = os.environ.get('TRACKER_HOME', '')
 self.name = 'admin'
 self.password = ''  # unused
 if 'ROUNDUP_LOGIN' in os.environ:
-l = os.environ['ROUNDUP_LOGIN'].split(':')
+login_env = os.environ['ROUNDUP_LOGIN'].split(':')
-self.name = l[0]
+self.name = login_env[0]
-if len(l) > 1:
+if len(login_env) > 1:
-self.password = l[1]
+self.password = login_env[1]
 self.separator = None
 self.print_designator = 0
 self.verbose = 0
 for opt, arg in opts:
 if opt == '-h':
 return 1
 self.separator = ' '
 elif opt == '-d':
 self.print_designator = 1
 elif opt == '-u':
-l = arg.split(':')
+login_opt = arg.split(':')
-self.name = l[0]
+self.name = login_opt[0]
-if len(l) > 1:
+if len(login_opt) > 1:
-self.password = l[1]
+self.password = login_opt[1]
 # if no command - go interactive
 # wrap in a try/finally so we always close off the db
 ret = 0
 try:

Mercurial > p > roundup > code

comparison roundup/admin.py @ 6585:d4371b131c9c