aboutsummaryrefslogtreecommitdiffstats
path: root/becommands/show.py
diff options
context:
space:
mode:
Diffstat (limited to 'becommands/show.py')
-rw-r--r--becommands/show.py158
1 files changed, 112 insertions, 46 deletions
diff --git a/becommands/show.py b/becommands/show.py
index 94e16bf..557c63a 100644
--- a/becommands/show.py
+++ b/becommands/show.py
@@ -17,12 +17,12 @@
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-"""Show a particular bug"""
+"""Show a particular bug, comment, or combination of both."""
import sys
-from libbe import cmdutil, bugdir
+from libbe import cmdutil, bugdir, comment, version, _version
__desc__ = __doc__
-def execute(args, manipulate_encodings=True):
+def execute(args, manipulate_encodings=True, restrict_file_access=False):
"""
>>> import os
>>> bd = bugdir.SimpleBugDir()
@@ -41,15 +41,23 @@ def execute(args, manipulate_encodings=True):
<BLANKLINE>
>>> execute (["--xml", "a"], manipulate_encodings=False) # doctest: +ELLIPSIS
<?xml version="1.0" encoding="..." ?>
- <bug>
- <uuid>a</uuid>
- <short-name>a</short-name>
- <severity>minor</severity>
- <status>open</status>
- <creator>John Doe &lt;jdoe@example.com&gt;</creator>
- <created>...</created>
- <summary>Bug A</summary>
- </bug>
+ <be-xml>
+ <version>
+ <tag>...</tag>
+ <branch-nick>...</branch-nick>
+ <revno>...</revno>
+ <revision-id>...</revision-id>
+ </version>
+ <bug>
+ <uuid>a</uuid>
+ <short-name>a</short-name>
+ <severity>minor</severity>
+ <status>open</status>
+ <creator>John Doe &lt;jdoe@example.com&gt;</creator>
+ <created>Thu, 01 Jan 1970 00:00:00 +0000</created>
+ <summary>Bug A</summary>
+ </bug>
+ </be-xml>
>>> bd.cleanup()
"""
parser = get_parser()
@@ -60,38 +68,18 @@ def execute(args, manipulate_encodings=True):
raise cmdutil.UsageError
bd = bugdir.BugDir(from_disk=True,
manipulate_encodings=manipulate_encodings)
- if options.XML:
- print '<?xml version="1.0" encoding="%s" ?>' % bd.encoding
- for shortname in args:
- if shortname.count(':') > 1:
- raise cmdutil.UserError("Invalid id '%s'." % shortname)
- elif shortname.count(':') == 1:
- # Split shortname generated by Comment.comment_shortnames()
- bugname = shortname.split(':')[0]
- is_comment = True
- else:
- bugname = shortname
- is_comment = False
- if is_comment == True and options.comments == False:
- continue
- bug = cmdutil.bug_from_shortname(bd, bugname)
- if is_comment == False:
- if options.XML:
- print bug.xml(show_comments=options.comments)
- else:
- print bug.string(show_comments=options.comments)
- else:
- comment = bug.comment_root.comment_from_shortname(
- shortname, bug_shortname=bugname)
- if options.XML:
- print comment.xml(shortname=shortname)
- else:
- if len(args) == 1 and options.only_raw_body == True:
- sys.__stdout__.write(comment.body)
- else:
- print comment.string(shortname=shortname)
- if shortname != args[-1] and options.XML == False:
- print "" # add a blank line between bugs/comments
+
+ if options.only_raw_body == True:
+ if len(args) != 1:
+ raise cmdutil.UsageError(
+ 'only one ID accepted with --only-raw-body')
+ bug,comment = cmdutil.bug_comment_from_id(bd, args[0])
+ if comment == bug.comment_root:
+ raise cmdutil.UsageError(
+ "--only-raw-body requires a comment ID, not '%s'" % args[0])
+ sys.__stdout__.write(comment.body)
+ sys.exit(0)
+ print output(args, bd, as_xml=options.XML, with_comments=options.comments)
def get_parser():
parser = cmdutil.CmdOptionParser("be show [options] ID [ID ...]")
@@ -108,9 +96,87 @@ def get_parser():
longhelp="""
Show all information about the bugs or comments whose IDs are given.
-It's probably not a good idea to mix bug and comment IDs in a single
-call, but you're free to do so if you like.
+Without the --xml flag set, it's probably not a good idea to mix bug
+and comment IDs in a single call, but you're free to do so if you
+like. With the --xml flag set, there will never be any root comments,
+so mix and match away (the bug listings for directly requested
+comments will be restricted to the bug uuid and the requested
+comment(s)).
+
+Directly requested comments will be grouped by their parent bug and
+placed at the end of the output, so the ordering may not match the
+order of the listed IDs.
"""
def help():
return get_parser().help_str() + longhelp
+
+def _sort_ids(ids, with_comments=True):
+ bugs = []
+ root_comments = {}
+ for id in ids:
+ bugname,commname = cmdutil.parse_id(id)
+ if commname == None:
+ bugs.append(bugname)
+ elif with_comments == True:
+ if bugname not in root_comments:
+ root_comments[bugname] = [commname]
+ else:
+ root_comments[bugname].append(commname)
+ for bugname in root_comments.keys():
+ assert bugname not in bugs, \
+ "specifically requested both '%s%s' and '%s'" \
+ % (bugname, root_comments[bugname][0], bugname)
+ return (bugs, root_comments)
+
+def _xml_header(encoding):
+ lines = ['<?xml version="1.0" encoding="%s" ?>' % encoding,
+ '<be-xml>',
+ ' <version>',
+ ' <tag>%s</tag>' % version.version()]
+ for tag in ['branch-nick', 'revno', 'revision-id']:
+ value = _version.version_info[tag.replace('-', '_')]
+ lines.append(' <%s>%s</%s>' % (tag, value, tag))
+ lines.append(' </version>')
+ return lines
+
+def _xml_footer():
+ return ['</be-xml>']
+
+def output(ids, bd, as_xml=True, with_comments=True):
+ bugs,root_comments = _sort_ids(ids, with_comments)
+ lines = []
+ if as_xml:
+ lines.extend(_xml_header(bd.encoding))
+ else:
+ spaces_left = len(ids) - 1
+ for bugname in bugs:
+ bug = cmdutil.bug_from_id(bd, bugname)
+ if as_xml:
+ lines.append(bug.xml(indent=2, show_comments=with_comments))
+ else:
+ lines.append(bug.string(show_comments=with_comments))
+ if spaces_left > 0:
+ spaces_left -= 1
+ lines.append('') # add a blank line between bugs/comments
+ for bugname,comments in root_comments.items():
+ bug = cmdutil.bug_from_id(bd, bugname)
+ if as_xml:
+ lines.extend([' <bug>', ' <uuid>%s</uuid>' % bug.uuid])
+ for commname in comments:
+ try:
+ comment = bug.comment_root.comment_from_shortname(commname)
+ except comment.InvalidShortname, e:
+ raise UserError(e.message)
+ if as_xml:
+ lines.append(comment.xml(indent=4, shortname=bugname))
+ else:
+ lines.append(comment.string(shortname=shortname))
+ if spaces_left > 0:
+ spaces_left -= 1
+ lines.append('') # add a blank line between bugs/comments
+ if as_xml:
+ lines.append('</bug>')
+ if as_xml:
+ lines.extend(_xml_footer())
+ return '\n'.join(lines)