aboutsummaryrefslogblamecommitdiffstats
path: root/becommands/show.py
blob: a4208c3565a174e533b14522dc113a3b28c5c4d8 (plain) (tree)
1
2
3
4
5




                                                             













                                                                              
                           
          
                                 
                  
 
                              



                                    
                                                        





                        
                   
                                              
                      

               
                                                                




                                
                                                          
                            

                              
       

                                           
                                                   
                                                                            
                      

                                                                     






                                                                           
             













                                                              



                                                                    

                                                              

                 
                                                                     

                                                         

                                                                                                                                                                 


                 



                                                                    



                                             
# Copyright (C) 2005-2009 Aaron Bentley and Panometrics, Inc.
#                         Chris Ball <cjb@laptop.org>
#                         Thomas Gerigk <tgerigk@gmx.de>
#                         Thomas Habets <thomas@habets.pp.se>
#                         W. Trevor King <wking@drexel.edu>
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
"""Show a particular bug"""
import sys
from libbe import cmdutil, bugdir
__desc__ = __doc__

def execute(args, test=False):
    """
    >>> import os
    >>> bd = bugdir.simple_bug_dir()
    >>> os.chdir(bd.root)
    >>> execute (["a",], test=True) # doctest: +ELLIPSIS
              ID : a
      Short name : a
        Severity : minor
          Status : open
        Assigned : 
          Target : 
        Reporter : 
         Creator : John Doe <jdoe@example.com>
         Created : ...
    Bug A
    <BLANKLINE>
    >>> execute (["--xml", "a"], test=True) # doctest: +ELLIPSIS
    <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>
    """
    parser = get_parser()
    options, args = parser.parse_args(args)
    cmdutil.default_complete(options, args, parser,
                             bugid_args={-1: lambda bug : bug.active==True})
    if len(args) == 0:
        raise cmdutil.UsageError
    bd = bugdir.BugDir(from_disk=True, manipulate_encodings=not test)
    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
        bug = bd.bug_from_shortname(bugname)
        if is_comment == False:
            if options.dumpXML:
                print bug.xml(show_comments=True)
            else:
                print bug.string(show_comments=True)
        else:
            comment = bug.comment_root.comment_from_shortname(
                shortname, bug_shortname=bugname)
            if options.dumpXML:
                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.dumpXML == False:
            print "" # add a blank line between bugs/comments

def get_parser():
    parser = cmdutil.CmdOptionParser("be show [options] ID [ID ...]")
    parser.add_option("-x", "--xml", action="store_true",
                      dest='dumpXML', help="Dump as XML")
    parser.add_option("--only-raw-body", action="store_true",
                      dest='only_raw_body', help="When printing only a single comment, just print it's body.  This allows extraction of non-text content types.")
    return 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.
"""

def help():
    return get_parser().help_str() + longhelp