annotate scripts/add-issue @ 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 c75defc1c2f0
children 9c3ec0a5c7fc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1626
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 #! /usr/bin/env python
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 '''
1627
e029d625c8f1 minor usage doc tweak
Richard Jones <richard@users.sourceforge.net>
parents: 1626
diff changeset
3 Usage: %s <tracker home> <priority> <issue title>
1626
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 Create a new issue in the given tracker. Input is taken from STDIN to
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 create the initial issue message (which may be empty). Issues will be
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 created as the current user (%s) if they exist as a Roundup
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 user, or "admin" otherwise.
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 '''
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
5412
c75defc1c2f0 Python 3 preparation: miscellaneous Python scripts not named *.py.
Joseph Myers <jsm@polyomino.org.uk>
parents: 4781
diff changeset
11 from __future__ import print_function
1626
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 import sys, os, pwd
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 from roundup import instance, mailgw, date
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 # open the instance
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 username = pwd.getpwuid(os.getuid())[0]
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 if len(sys.argv) < 3:
5412
c75defc1c2f0 Python 3 preparation: miscellaneous Python scripts not named *.py.
Joseph Myers <jsm@polyomino.org.uk>
parents: 4781
diff changeset
19 print("Error: Not enough arguments")
c75defc1c2f0 Python 3 preparation: miscellaneous Python scripts not named *.py.
Joseph Myers <jsm@polyomino.org.uk>
parents: 4781
diff changeset
20 print(__doc__.strip()%(sys.argv[0], username))
1626
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 sys.exit(1)
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 tracker_home = sys.argv[1]
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 issue_priority = sys.argv[2]
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 issue_title = ' '.join(sys.argv[3:])
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 # get the message, if any
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 message_text = sys.stdin.read().strip()
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 # open the tracker
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 tracker = instance.open(tracker_home)
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 db = tracker.open('admin')
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4570
diff changeset
32 db.tx_Source = "cli"
1626
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 uid = db.user.lookup('admin')
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 try:
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 # try to open the tracker as the current user
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 uid = db.user.lookup(username)
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 db.close()
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 db = tracker.open(username)
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 except KeyError:
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 pass
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 try:
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 # handle the message
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 messages = []
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 if message_text:
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 summary, x = mailgw.parseContent(message_text, 0, 0)
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 msg = db.msg.create(content=message_text, summary=summary, author=uid,
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 date=date.Date())
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 messages = [msg]
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 # now create the issue
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 db.issue.create(title=issue_title, priority=issue_priority,
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 messages=messages)
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 db.commit()
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 finally:
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 db.close()
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
581aa1853a2f adding a simple add-issue script
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 # vim: set filetype=python ts=4 sw=4 et si

Roundup Issue Tracker: http://roundup-tracker.org/