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

comparison roundup/admin.py @ 7752:b2dbab2b34bc

fix(refactor): multiple fixups using ruff linter; more testing. Converting to using the ruff linter and its rulesets. Fixed a number of issues. admin.py: sort imports use immutable tuples as default value markers for parameters where a None value is valid. reduced some loops to list comprehensions for performance used ternary to simplify some if statements named some variables to make them less magic (e.g. _default_savepoint_setting = 1000) fixed some tests for argument counts < 2 becomes != 2 so 3 is an error. moved exception handlers outside of loops for performance where exception handler will abort loop anyway. renamed variables called 'id' or 'dir' as they shadow builtin commands. fix translations of form _("string %s" % value) -> _("string %s") % value so translation will be looked up with the key before substitution. end dicts, tuples with a trailing comma to reduce missing comma errors if modified simplified sorted(list(self.setting.keys())) to sorted(self.setting.keys()) as sorted consumes whole list. in if conditions put compared variable on left and threshold condition on right. (no yoda conditions) multiple noqa: suppression removed unneeded noqa as lint rulesets are a bit different do_get - refactor output printing logic: Use fast return if not special formatting is requested; use isinstance with a tuple rather than two isinstance calls; cleaned up flow and removed comments on algorithm as it can be easily read from the code. do_filter, do_find - refactor output printing logic. Reduce duplicate code. do_find - renamed variable 'value' that was set inside a loop. The loop index variable was also named 'value'. do_pragma - added hint to use list subcommand if setting was not found. Replaced condition 'type(x) is bool' with 'isinstance(x, bool)' for various types. test_admin.py added testing for do_list better test coverage for do_get includes: -S and -d for multilinks, error case for -d with non-link. better testing for do_find including all output modes better testing for do_filter including all output modes fixed expected output for do_pragma that now includes hint to use pragma list if setting not found.

author	John Rouillard <rouilj@ieee.org>
date	Fri, 01 Mar 2024 14:53:18 -0500
parents	4dda4a9dfe0b
children	09b216591db5

comparison

equal deleted inserted replaced

-:bd013590d8d6
+:b2dbab2b34bc
 import os
 import re
 import shutil
 import sys
+import roundup.instance
+from roundup import __version__ as roundup_version
 from roundup import date, hyperdb, init, password, token_r
-from roundup import __version__ as roundup_version
-import roundup.instance
-from roundup.configuration import (CoreConfig, NoConfigError, Option,
-OptionUnsetError, OptionValueError,
-ParsingOptionError, UserConfig)
-from roundup.i18n import _, get_translation
-from roundup.exceptions import UsageError
 from roundup.anypy.my_input import my_input
 from roundup.anypy.strings import repr_export
+from roundup.configuration import (
+CoreConfig,
+NoConfigError,
+Option,
+OptionUnsetError,
+OptionValueError,
+ParsingOptionError,
+UserConfig,
+)
+from roundup.exceptions import UsageError
+from roundup.i18n import _, get_translation
 try:
 from UserDict import UserDict
 except ImportError:
 from collections import UserDict
 class CommandDict(UserDict):
 """Simple dictionary that lets us do lookups using partial keys.
 Original code submitted by Engelbert Gruber.
 """
-_marker = []
+_marker = ('CommandDictMarker')
 def get(self, key, default=_marker):
 if key in self.data:
 return [(key, self.data[key])]
 keylist = sorted(self.data)
-matching_keys = []
-for ki in keylist:
+matching_keys = [(ki, self.data[ki]) for ki in keylist
-if ki.startswith(key):
+if ki.startswith(key)]
-matching_keys.append((ki, self.data[ki]))
 if not matching_keys and default is self._marker:
 raise KeyError(key)
 # FIXME: what happens if default is not self._marker but
 # there are no matching keys? Should (default, self.data[default])
 # be returned???
 self.help[k[5:]] = getattr(self, k)
 self.tracker = None
 self.tracker_home = ''
 self.db = None
 self.db_uncommitted = False
+self._default_savepoint_setting = 10000
 self.force = None
 self.settings = {
 'display_header': False,
 'display_protected': False,
 'indexer_backend': "as set in config.ini",
 '_reopen_tracker': False,
-'savepoint_limit': 10000,
+'savepoint_limit': self._default_savepoint_setting,
 'show_retired': "no",
 '_retired_val': False,
 'verbose': False,
 '_inttest': 3,
 '_floattest': 3.5,
 def props_from_args(self, args):
 """ Produce a dictionary of prop: value from the args list.
 The args list is specified as ``prop=value prop=value ...``.
+A missing value is recorded as None.
 """
 props = {}
 for arg in args:
 key_val = arg.split('=', 1)
 # if = not in string, will return one element
-if len(key_val) < 2:
+if len(key_val) != 2:
 raise UsageError(_('argument "%(arg)s" not propname=value') %
 locals())
 key, value = key_val
 if value:
 props[key] = value
 h = _(command.__doc__).split('\n')[0]
 commands.append(' '+h[7:])
 commands.sort()
 commands.append(_(
 """Commands may be abbreviated as long as the abbreviation
-matches only one command, e.g. l == li == lis == list."""))  # noqa: E122
+matches only one command, e.g. l == li == lis == list."""))
 sys.stdout.write('\n'.join(commands) + '\n\n')
 indent_re = re.compile(r'^(\s+)\S+')
 def help_commands_html(self, indent_re=indent_re):
 argument = self.my_input('%s [%s]: ' % (prompt, default))
 if not argument:
 return default
 return argument
-def do_commit(self, args):
+def do_commit(self, args):  # noqa: ARG002
 ''"""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
 props[key] = value
 else:
 props = self.props_from_args(args[1:])
 # convert types
-for propname in props:
+try:
-try:
+for propname in props:
 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" '
 # get the class
 cl = self.get_class(classname)
 # display the values
 normal_props = sorted(cl.properties)
-if display_protected:
-keys = sorted(cl.getprops())
+keys = sorted(cl.getprops()) if display_protected else normal_props
-else:
-keys = normal_props
 if display_header:
 status = "retired" if cl.is_retired(nodeid) else "active"
 print('\n[%s (%s)]' % (designator, status))
 for key in keys:
 value = cl.get(nodeid, key)
 # prepend * for protected properties else just indent
 # with space.
-if display_protected or display_header:
+if display_protected or display_header:  # noqa: SIM108
 protected = "*" if key not in normal_props else ' '
 else:
 protected = ""
 print(_('%(protected)s%(key)s: %(value)s') % locals())
 """
 # grab the directory to export to
 if len(args) < 1:
 raise UsageError(_('Not enough arguments supplied'))
-dir = args[-1]
+export_dir = args[-1]
 # get the list of classes to export
 if len(args) == 2:
 if args[0].startswith('-'):
 classes = [c for c in self.db.classes
 class colon_separated(csv.excel):
 delimiter = ':'
 # make sure target dir exists
-if not os.path.exists(dir):
+if not os.path.exists(export_dir):
-os.makedirs(dir)
+os.makedirs(export_dir)
 # maximum csv field length exceeding configured size?
 max_len = self.db.config.CSV_FIELD_SIZE
 # do all the classes specified
 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:
+with open(os.path.join(export_dir, classname+'.csv'), 'w') as f:
 writer = csv.writer(f, colon_separated)
 propnames = cl.export_propnames()
 fields = propnames[:]
 fields.append('is retired')
 # on imports to rdbms.
 all_nodes = cl.getnodeids()
 classkey = cl.getkey()
 if classkey:  # False sorts before True, so negate is_retired
-keysort = lambda i: (cl.get(i, classkey),  # noqa: E731
+keysort = lambda i: (      # noqa: E731
-not cl.is_retired(i))
+cl.get(i, classkey),   # noqa: B023 cl is not loop var
+not cl.is_retired(i),  # noqa: B023 cl is not loop var
+)
 all_nodes.sort(key=keysort)
 # if there is no classkey no need to sort
 for nodeid in all_nodes:
 if self.verbose:
 ll = len(repr_export(node[p])) + d
 if ll > max_len:
 max_len = ll
 writer.writerow(exp)
 if export_files and hasattr(cl, 'export_files'):
-cl.export_files(dir, nodeid)
+cl.export_files(export_dir, nodeid)
 # export the journals
-with open(os.path.join(dir, classname+'-journals.csv'), 'w') as jf:
+with open(os.path.join(export_dir, classname+'-journals.csv'), 'w') as jf:
 if self.verbose:
 sys.stdout.write("\nExporting Journal for %s\n" %
 classname)
 sys.stdout.flush()
 journals = csv.writer(jf, colon_separated)
 # handle the propname=value argument
 props = self.props_from_args(args[1:])
 # convert the user-input value to a value used for filter
 # multiple , separated values become a list
-for propname, value in props.items():
+for propname, prop_value in props.items():
-if ',' in value:
+values = prop_value.split(',') if ',' in prop_value \
-values = value.split(',')
+else [prop_value]
-else:
-values = [value]
 props[propname] = []
 # start handling transitive props
 # given filter issue assignedto.roles=Admin
 # start at issue
 try:
 curclassname = curclass.getprops()[pn].classname
 except KeyError:
 raise UsageError(_(
 "Class %(curclassname)s has "
-"no property %(pn)s in %(propname)s." %
+"no property %(pn)s in %(propname)s.") %
-locals()))
+locals())
 # get class object
 curclass = self.get_class(curclassname)
 except AttributeError:
 # curclass.getprops()[pn].classname raises this
 # when we are at a non link/multilink property
 val = hyperdb.rawToHyperdb(self.db, curclass, None,
 lastprop, value)
 props[propname].append(val)
 # now do the filter
+props = {"filterspec": props}
 try:
-id = []
+output_items = cl.filter(None, **props)
-designator = []
+if self.print_designator:
-props = {"filterspec": props}
+output_items = [ classname + i for i in output_items ]
 if self.separator:
-if self.print_designator:
+print(self.separator.join(output_items))
-id = cl.filter(None, **props)
-for i in id:
-designator.append(classname + i)
-print(self.separator.join(designator))
-else:
-print(self.separator.join(cl.filter(None, **props)))
 else:
-if self.print_designator:
+print(output_items)
-id = cl.filter(None, **props)
-for i in id:
-designator.append(classname + i)
-print(designator)
-else:
-print(cl.filter(None, **props))
 except KeyError:
 raise UsageError(_('%(classname)s has no property '
 '"%(propname)s"') % locals())
 except (ValueError, TypeError) as message:
 raise UsageError(message)
 # handle the propname=value argument
 props = self.props_from_args(args[1:])
 # convert the user-input value to a value used for find()
-for propname, value in props.items():
+for propname, prop_value in props.items():
-if ',' in value:
+values = prop_value.split(',') if ',' in prop_value \
-values = value.split(',')
+else [prop_value]
-else:
-values = [value]
 d = props[propname] = {}
 for value in values:
-value = hyperdb.rawToHyperdb(self.db, cl, None,
+val = hyperdb.rawToHyperdb(self.db, cl, None,
 propname, value)
-if isinstance(value, list):
+if isinstance(val, list):
-for entry in value:
+for entry in val:
 d[entry] = 1
 else:
-d[value] = 1
+d[val] = 1
 # now do the find
 try:
-id = []
+output_items = cl.find(**props)
-designator = []
+if self.print_designator:
+output_items = [ classname + i for i in output_items ]
 if self.separator:
-if self.print_designator:
+print(self.separator.join(output_items))
-id = cl.find(**props)
-for i in id:
-designator.append(classname + i)
-print(self.separator.join(designator))
-else:
-print(self.separator.join(cl.find(**props)))
 else:
-if self.print_designator:
+print(output_items)
-id = cl.find(**props)
-for i in id:
-designator.append(classname + i)
-print(designator)
-else:
-print(cl.find(**props))
 except KeyError:
 raise UsageError(_('%(classname)s has no property '
 '"%(propname)s"') % locals())
 except (ValueError, TypeError) as message:
 raise UsageError(message)
 "   'password_pbkdf2_default_rounds'\n"
 "from old default of %(old_number)s to new "
 "default of %(new_number)s.") % {
 "old_number":
 config.PASSWORD_PBKDF2_DEFAULT_ROUNDS,
-"new_number": default_ppdr
+"new_number": default_ppdr,
 })
 config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = default_ppdr
-if config.PASSWORD_PBKDF2_DEFAULT_ROUNDS < default_ppdr:
+if default_ppdr > config.PASSWORD_PBKDF2_DEFAULT_ROUNDS:
 print(_("Update "
 "'password_pbkdf2_default_rounds' "
 "to a number equal to or larger\nthan %s.") %
 default_ppdr)
 else:
 raise UsageError(message)
 # get the class
 cl = self.get_class(classname)
 try:
-id = []
+if not (self.separator or self.print_designator):
+print(cl.get(nodeid, propname))
+continue
+if not (isinstance(prop_obj,
+(hyperdb.Link, hyperdb.Multilink))):
+raise UsageError(_(
+'property %s is not of type'
+' Multilink or Link so -d flag does not '
+'apply.') % propname)
+propclassname = self.db.getclass(
+prop_obj.classname).classname
+output_items = cl.get(nodeid, propname)
+if self.print_designator:
+output_items = [propclassname + i for i in output_items]
 if self.separator:
-if self.print_designator:
+print(self.separator.join(output_items))
-# see if property is a link or multilink for
-# which getting a desginator make sense.
-# Algorithm: Get the properties of the
-#     current designator's class. (cl.getprops)
-# get the property object for the property the
-#     user requested (properties[propname])
-# verify its type (isinstance...)
-# raise error if not link/multilink
-# get class name for link/multilink property
-# do the get on the designators
-# append the new designators
-# print
-properties = cl.getprops()
-property = properties[propname]
-if not (isinstance(property, hyperdb.Multilink) or
-isinstance(property, hyperdb.Link)):
-raise UsageError(_(
-'property %s is not of type'
-' 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:
-linked_props.append(propclassname + i)
-else:
-id = cl.get(nodeid, propname)
-for i in id:
-linked_props.append(i)
 else:
-if self.print_designator:
+# default is to list each on a line
-properties = cl.getprops()
+print('\n'.join(output_items))
-property = properties[propname]
-if not (isinstance(property, hyperdb.Multilink) or
-isinstance(property, hyperdb.Link)):
-raise UsageError(_(
-'property %s is not of type'
-' 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:
-print(propclassname + i)
-else:
-print(cl.get(nodeid, propname))
 except IndexError:
 raise UsageError(_('no such %(classname)s node '
 '"%(nodeid)s"') % locals())
 except KeyError:
 raise UsageError(_('no such %(classname)s property '
 '"%(propname)s"') % locals())
-if self.separator:
-print(self.separator.join(linked_props))
 return 0
 def do_help(self, args, nl_re=nl_re, indent_re=indent_re):
 ''"""Usage: help topic
 Give help about topic.
 commands  -- list commands
 <command> -- help specific to a command
 initopts  -- init command options
 all       -- all available help
 """
-if len(args) > 0:
+topic = args[0] if len(args) > 0 else 'help'
-topic = args[0]
-else:
-topic = 'help'
 # try help_ methods
 if topic in self.help:
 self.help[topic]()
 return 0
 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 cmd_docs:
+for _name, do_function in cmd_docs:
-lines = nl_re.split(_(help.__doc__))
+lines = nl_re.split(_(do_function.__doc__))
 print(lines[0])
 indent = indent_re.match(lines[1])
 if indent: indent = len(indent.group(1))  # noqa: E701
 for line in lines[1:]:
 if indent:
 if hasattr(csv, 'field_size_limit'):
 csv.field_size_limit(self.db.config.CSV_FIELD_SIZE)
 # default value is 10000, only go through this if default
 # is different.
-if self.settings['savepoint_limit'] != 10000:
+if self.settings['savepoint_limit'] != self._default_savepoint_setting:
 # create a new option on the fly in the config under the
 # rdbms section. It is used by the postgresql backend's
 # checkpoint_data method.
 self.db.config.add_option(Option(self.db.config,
 "rdbms", "savepoint_limit"))
 self.db.config.options["RDBMS_SAVEPOINT_LIMIT"].set(
 self.settings['savepoint_limit'])
 # directory to import from
-dir = args[0]
+import_dir = args[0]
 class colon_separated(csv.excel):
 delimiter = ':'
 # import all the files
-for file in os.listdir(dir):
+for file in os.listdir(import_dir):
 classname, ext = os.path.splitext(file)
 # we only care about CSV files
 if ext != '.csv' or classname.endswith('-journals'):
 continue
 cl = self.get_class(classname)
 # ensure that the properties and the CSV file headings match
-with open(os.path.join(dir, file), 'r') as f:
+with open(os.path.join(import_dir, file), 'r') as f:
 reader = csv.reader(f, colon_separated)
 file_props = None
 maxid = 1
 # loop through the file and create a node for each entry
 for n, r in enumerate(reader):
 sys.stdout.flush()
 # do the import and figure the current highest nodeid
 nodeid = cl.import_list(file_props, r)
 if hasattr(cl, 'import_files') and import_files:
-cl.import_files(dir, nodeid)
+cl.import_files(import_dir, nodeid)
 maxid = max(maxid, int(nodeid))
 # (print to sys.stdout here to allow tests to squash it .. ugh)
 print(file=sys.stdout)
 # import the journals
-with open(os.path.join(args[0], classname + '-journals.csv'), 'r') as f:
+with open(os.path.join(import_dir, classname + '-journals.csv'), 'r') as f:
 reader = csv.reader(f, colon_separated)
 cl.import_journals(reader)
 # (print to sys.stdout here to allow tests to squash it .. ugh)
 print('setting', classname, maxid+1, file=sys.stdout)
 if tracker.exists():
 if not self.force:
 ok = self.my_input(_(
 """WARNING: The database is already initialised!
 If you re-initialise it, you will lose all the data!
-Erase it? Y/N: """))  # noqa: E122
+Erase it? Y/N: """))
 if ok.strip().lower() != 'y':
 return 0
 # nuke it
 tracker.nuke()
 os.path.join(tracker_home, 'config.py')])):
 if not self.force:
 ok = self.my_input(_(
 """WARNING: There appears to be a tracker in "%(tracker_home)s"!
 If you re-install it, you will lose all the data!
-Erase it? Y/N: """) % locals())  # noqa: E122
+Erase it? Y/N: """) % locals())
 if ok.strip().lower() != 'y':
 return 0
 # clear it out so the install isn't confused
 shutil.rmtree(tracker_home)
 # 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():
+# .keys() is required. UserConfig has no __iter__ or __next__
+for k in template_config.keys():  # noqa: SIM118
 if k == 'HOME':  # ignore home. It is a default param.
 continue
 defns[k] = template_config[k]
 # install!
 You MUST run the "roundup-admin initialise" command once you've performed
 the above steps.
 ---------------------------------------------------------------------------
 """) % {'database_config_file': os.path.join(tracker_home, 'schema.py'),
-'database_init_file': os.path.join(tracker_home, 'initial_data.py')}) \
+'database_init_file': os.path.join(tracker_home, 'initial_data.py')})
-# noqa: E122
 return 0
 def do_list(self, args):
 ''"""Usage: list classname [property]
 List the instances of a class.
 # get the class
 cl = self.get_class(classname)
 # figure the property
-if len(args) > 1:
+propname = args[1] if len(args) > 1 else cl.labelprop()
-propname = 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.getnodeids(retired=retired):
+try:
-try:
+proplist = [ cl.get(nodeid, propname) for nodeid in
-proplist.append(cl.get(nodeid, propname))
+cl.getnodeids(retired=retired)]
 except KeyError:
 raise UsageError(_('%(classname)s has no property '
 '"%(propname)s"') % locals())
 print(self.separator.join(proplist))
 else:
 # create a list of index id's since user didn't specify
 # otherwise
 print(self.separator.join(cl.getnodeids(retired=retired)))
 else:
-for nodeid in cl.getnodeids(retired=retired):
+try:
-try:
+for nodeid in cl.getnodeids(retired=retired):
 value = cl.get(nodeid, propname)
-except KeyError:
+print(_('%(nodeid)4s: %(value)s') % locals())
-raise UsageError(_('%(classname)s has no property '
+except KeyError:
-'"%(propname)s"') % locals())
+raise UsageError(_('%(classname)s has no property '
-print(_('%(nodeid)4s: %(value)s') % locals())
+'"%(propname)s"') % locals())
 return 0
-def do_migrate(self, args):
+def do_migrate(self, args):  # noqa: ARG002  - args unused
 ''"""Usage: migrate
 Update a tracker's database to be compatible with the Roundup
 codebase.
 tic = perf_counter()
 pw_hash = password.encodePassword(
 "this is a long password to hash",
 props['scheme'],
 None,
-config=self.db.config
+config=self.db.config,
 )
 toc = perf_counter()
 except password.PasswordValueError as e:
 print(e)
 print_supported_schemes()
 args[0])
 else:
 print(_("Current settings and values "
 "(NYI - not yet implemented):"))
 is_verbose = self.settings['verbose']
-for key in sorted(list(self.settings.keys())):
+for key in sorted(self.settings.keys()):
 if key.startswith('_') and not is_verbose:
 continue
 print("   %s=%s" % (key, self.settings[key]))
 if is_verbose:
 print("      %s" % self.settings_help[key])
 return
 if setting not in self.settings:
-raise UsageError(_('Unknown setting %s.') % setting)
+raise UsageError(_('Unknown setting %s. Try "pragma list".')
-if type(self.settings[setting]) is bool:
+% setting)
+if isinstance(self.settings[setting], bool):
 value = value.lower()
 if value in ("yes", "true", "on", "1"):
 value = True
 elif value in ("no", "false", "off", "0"):
 value = False
 else:
 raise UsageError(_(
 'Incorrect value for boolean setting %(setting)s: '
 '%(value)s.') % {"setting": setting, "value": value})
-elif type(self.settings[setting]) is int:
+elif isinstance(self.settings[setting], int):
 try:
 _val = int(value)
 except ValueError:
 raise UsageError(_(
 'Incorrect value for integer setting %(setting)s: '
 '%(value)s.') % {"setting": setting, "value": value})
 value = _val
-elif type(self.settings[setting]) is str:
+elif isinstance(self.settings[setting], str):
 if setting == "show_retired":
 if value not in ["no", "only", "both"]:
 raise UsageError(_(
 'Incorrect value for setting %(setting)s: '
 '%(value)s. Should be no, both, or only.') % {
 raise UsageError(_('no such %(classname)s node '
 '"%(nodeid)s"') % locals())
 self.db_uncommitted = True
 return 0
-def do_rollback(self, args):
+def do_rollback(self, args):  # noqa: ARG002 - args unused
 ''"""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
 # now do the set for all the nodes
 for classname, itemid in designators:
 props = copy.copy(propset)  # make a new copy for every designator
 cl = self.get_class(classname)
-for key, value in list(props.items()):
+try:
-try:
+for key, value in list(props.items()):
 # You must reinitialize the props every time though.
 # if props['nosy'] = '+admin' initally, it gets
 # set to 'demo,admin' (assuming it was set to demo
 # in the db) after rawToHyperdb returns.
 # This  new value is used for all the rest of the
 # designators if not reinitalized.
 props[key] = hyperdb.rawToHyperdb(self.db, cl, itemid,
 key, value)
 except hyperdb.HyperdbValueError as message:
 raise UsageError(message)
 # try the set
 try:
 cl.set(itemid, **props)
 except (TypeError, IndexError, ValueError) as message:
 # get the class
 cl = self.get_class(classname)
 # get the key property
 keyprop = cl.getkey()
-if self.settings['display_protected']:
+properties = cl.getprops() if self.settings['display_protected'] \
-properties = cl.getprops()
+else cl.properties
-else:
-properties = cl.properties
 for key in properties:
 value = properties[key]
 if keyprop == key:
 sys.stdout.write(_('%(key)s: %(value)s (key property)\n') %
 locals())
 if args and args[0] == "trace_search":
 trace_search = True
 templates = self.listTemplates(trace_search=trace_search)
-for name in sorted(list(templates.keys())):
+for name in sorted(templates.keys()):
 templates[name]['description'] = textwrap.fill(
 "\n".join([line.lstrip() for line in
 templates[name]['description'].split("\n")]),
 70,
-subsequent_indent="      "
+subsequent_indent="      ",
 )
 print("""
 Name: %(name)s
 Path: %(path)s
 Desc: %(description)s
 # handle help now
 if command == 'help':
 if len(args) > 1:
 self.do_help(args[1:])
-return 0
+else:
 self.do_help(['help'])
 return 0
 if command == 'morehelp':
 self.do_help(['help'])
 self.help_commands()
 self.help_all()
 if command in ['genconfig', 'templates']:
 try:
 ret = function(args[1:])
 return ret
-except UsageError as message:  # noqa F841
+except UsageError as message:
 return self.usageError_feedback(message, function)
 # make sure we have a tracker_home
 while not self.tracker_home:
 if not self.force:
 # before we open the db, we may be doing an install or init
 if command == 'initialise':
 try:
 return self.do_initialise(self.tracker_home, args)
-except UsageError as message:  # noqa: F841
+except UsageError as message:
 return self.usageError_feedback(message, function)
 elif command == 'install':
 try:
 return self.do_install(self.tracker_home, args)
-except UsageError as message:  # noqa: F841
+except UsageError as message:
 return self.usageError_feedback(message, function)
 # get the tracker
 try:
 if self.tracker and not self.settings['_reopen_tracker']:
 print("Reopening tracker")
 tracker = roundup.instance.open(self.tracker_home)
 self.tracker = tracker
 self.settings['indexer_backend'] = self.tracker.config['INDEXER']
-except ValueError as message:  # noqa: F841
+except ValueError as message:  # noqa: F841  -- used from locals
 self.tracker_home = ''
 print(_("Error: Couldn't open tracker: %(message)s") % locals())
 return 1
-except NoConfigError as message:  # noqa: F841
+except NoConfigError as message:  # noqa: F841  -- used from locals
 self.tracker_home = ''
 print(_("Error: Couldn't open tracker: %(message)s") % locals())
 return 1
 # message used via locals
-except ParsingOptionError as message:  # noqa: F841
+except ParsingOptionError as message:  # noqa: F841 -- used from locals
 print("%(message)s" % locals())
 return 1
 # only open the database once!
 if not self.db:
 # do the command
 ret = 0
 try:
 ret = function(args[1:])
-except UsageError as message:  # noqa: F841
+except UsageError as message:
 ret = self.usageError_feedback(message, function)
 except Exception:
 import traceback
 traceback.print_exc()
 ret = 1
 return ret
 def interactive(self):
 """Run in an interactive mode
 """
-print(_('Roundup %s ready for input.\nType "help" for help.'
+print(_('Roundup %s ready for input.\nType "help" for help.')
-% roundup_version))
+% roundup_version)
 try:
 import readline  # noqa: F401
 except ImportError:
 print(_('Note: command history and editing not available'))
 commit = self.my_input(_('There are unsaved changes. Commit them (y/N)? '))
 if commit and commit[0].lower() == 'y':
 self.db.commit()
 return 0
-def main(self):
+def main(self):  # noqa: PLR0912, PLR0911
 try:
 opts, args = getopt.getopt(sys.argv[1:], 'i:u:hcdP:sS:vV')
 except getopt.GetoptError as e:
 self.usage(str(e))
 return 1

Mercurial > p > roundup > code

comparison roundup/admin.py @ 7752:b2dbab2b34bc