PortfolioException.py

Go to the documentation of this file.

## @package serverportfolio.PortfolioException
#
# Define custom and specific exceptions for the complete package
#
# Last Changed $Id: PortfolioException.py 12 2015-04-09 08:26:44Z michael $


# needed if raise Error, None, sys.info[2]
import sys, traceback

# doc python, base class is empty
# https://docs.python.org/2/reference/simple_stmts.html#grammar-token-raise_stmt

# more evolved trick
# http://www.pydanny.com/attaching-custom-exceptions-to-functions-and-classes.html

## @class PortfolioError
# @brief Base class of the custom exceptions.
#
# Exception expects one argument *args (tuple) \n
# Can access with e.args, e.message works only with one argument.
class PortfolioError(Exception):
    # want to raise exception with a message formatted
    # want to create an PortfolioError from a more defined one (like C++) ?

    ## @brief Constructor.
    # @param message main string to report the error
    # @param extra_message additional, will be append to message by a call to get_format_string
    def __init__(self, message, extra_message = None) :
        Exception.__init__(self, message)
        #print "PortfolioError::init message= ", message
        #print "extra_message ", extra_message

        self.extra_message = None
        self.traceback = None

        if extra_message:
            self.extra_message = message + extra_message

        #self.traceback = traceback.format_exc(3)
        self.traceback = ''.join( traceback.format_tb( sys.exc_info()[2], 3 ) )
        #print "self.traceback ", self.traceback

    def get_format_string(self):
        #print "PortfolioError get_format_string() "
        #string = 'PortfolioError: ' + self.message #+ '\n'
        string = self.message + '\n'
        if self.extra_message:
            string += self.extra_message
        if self.traceback:
            string += "\n"+self.traceback
        return string
            
    # method to overwrite to get nice printing 
    #def __str__(self):
    #    return repr(self.message)

## @class ParserError
# @brief Derived class specific to the parsers.\n
# Include specific information: stock, url, action
class ParserError(PortfolioError):

    # here fixe the number of arguments, using *args will get a tuple(StockOverflow)
    # or using a dictionary... **kargs
    
    ## @brief Constructor
    # @param message simple string to describe the error
    # @param stock specify the stock symbols treated
    # @param action EAction name performed
    # @param the url used by WebQuery 
    def __init__(self, message, stock, action, url ):
        
        #print "ParserError::init message= ", message
        # try to modify the message saved, cannot do this message not a string ? 
        # ok with str(message)
        #message = 'original message ' + str(message)
        message = str(message)
        # extra argument easier for traceback
        PortfolioError.__init__(self, message) # None,  sys.exc_info()[2]
        
        # in principle should test if None here and in get_format_string
        self.stock = stock
        self.action = action
        self.url = url
        
        #print "*** print_tb:"
        #traceback.print_tb( tr_back, limit=4, file=sys.stdout)
        #self.traceback2 = traceback.extract_tb( tr_back )
        
        # function call sys.exc_info(), moved to base class 
        # self.traceback = traceback.format_exc( 3 )
        #print "self.traceback with ex\n", self.traceback
        #print "End Constructor ParserError"

    ## @brief Produce more informative error message, including traceback
    def get_format_string(self):
        
        string = 'ParserError: ' + self.message + '\n'
        # problem with list of stocks
        if self.stock:
            string += 'stock: %s' % self.stock + '\n'
        if self.action:
            string += 'action: ' + self.action + '\n'
        if self.url:
            string += 'url: ' + self.url + '\n'
        if self.traceback:
            string += 'traceback:\n ' + self.traceback
        return string

# used ? tested ?
## @class QueryError
# @brief Specific exception related to the web query (Utils.WebQuery)
class QueryError(PortfolioError):

    def __init__(self, message, url): #, e_action):
        #print "QueryError::init"
        #message = message + "\nurl :" + url #+ "\naction : " + e_action.name
        message = str(message)
        PortfolioError.__init__(self, message)
        
        # moved to base class, always available
        #self.traceback = traceback.format_exc(3)
        self.url = url
        
    # could write same, correclty called if a PortfolioError appear
    def get_format_string(self):
        #print "get_format_string QueryError"
        #string = 'ParserError: ' + self.message + '\n'
        string = self.message + '\n'
        # problem with list of stocks
        #if self.stock:
        #    string += 'stock: %s' % self.stock + '\n'
        #if self.action:
        #    string += 'action: ' + self.action + '\n'
        if self.url:
            string += 'url: ' + self.url + '\n'
        if self.traceback:
            string += 'traceback:\n ' + self.traceback
        return string
    
# general FileError, XMLError
# class FileError
        
##########################################
if __name__ == "__main__":

    # see usage of
    #print "exec_info ", sys.exc_info()
    #print "exec_info[2] ", sys.exc_info()[2]
    # with
    # http://stackoverflow.com/questions/1350671/inner-exception-with-traceback-in-python
    # http://stackoverflow.com/questions/4825234/exception-traceback-is-hidden-if-not-re-raised-immediately
    print "Test PortfolioError 1 argument "
    try:
        raise PortfolioError( "A clear error message" )
    except PortfolioError as e:
        print "Got a PortfolioError"
        print "e.args ", e.args
        print "e ", e
        print "e.message ", e.message # here works, defined in BaseException(deprecated??)

    print "\nTest PortfolioError 2 argument "
    try:
        raise PortfolioError( "A clear error message","An other" )
    except PortfolioError as e:
        print "Got a PortfolioError"
        print "e.args ", e.args
        print "e ", e
        print "e.message ", e.message # here empty

    print "\n== Test ParserError"
    try:
        raise ParserError("An error from Parser", "An other error")
    except ParserError, e:
        print "\nGot a ParserError"
        print "e ", e
        print "e.args ", e.args
        print "e.errors ", e.errors
        print "e.message ", e.message

    print "\n== Test ParserError catched as PortfolioExcpetion"
    try:
        raise ParserError("An error from Parser", "An other error")
    except PortfolioError, e:
        print "\nGot a PortfolioError"
        print "e ", e
        print "e.args ", e.args
        print "e.errors ", e.errors
        print "e.message ", e.message