Utils.py

Go to the documentation of this file.

## @package serverportfolio.Utils
# Utility functions
#
# Last Changed $Id: Utils.py 27 2015-04-25 16:16:47Z michael $

import sys, types
import urllib2
import datetime, time

from serverportfolio import GlobalDicts
from serverportfolio.PortfolioException import *

## @brief Always return a list of strings.
#
# Assure the list format expected by Parsers::create_url
# @param stock a string ("CAC40") or a list of string ( ["CAC40","GSZ"] )
# @return list of strings
def to_list(stock):
    # already a list is input
    if type(stock) == types.ListType :
        return stock
    # if one element, make a list 
    elif  type(stock) == types.StringType :
        #print "it is a string"
        list_stock = []
        list_stock.append( stock )
        return list_stock
    # if a dictionary    
    elif type(stock) == types.DictType :
        list_stock = []
        list_stock.append( stock )
        return list_stock
    # error
    return None

## @brief Always return a valid EAction from an Eaction or an EAction.name
# @param action EAction type or EAction.name
# @return valid EAction
# @throw PortfolioError
def stringToEAction( action ):

    # if already an EAction just return the object      
    if isinstance(action, GlobalDicts.EAction):
        e_action = action

    elif type(action) == types.StringType:

        # do not want a try-catch each time this Utils.function is called... 
        try:
            e_action = GlobalDicts.EAction[action]

        except KeyError, ex:
        #except:
            #print "sys.exc_info()[2] ", sys.exc_info()[2]
            #print "traceback ", traceback.format_exc(3)
            #print "KeyError ex:", ex

            # better sys.exc[], no good to extract into local variables if an other error, no GC'ed
            raise PortfolioError( "Error in action, not a valid EAction\nOriginal error, %s : %s" % (sys.exc_info()[0].__name__, ex) )

        except:
            self.logger.critical("General Exception in stringToEAction, SHOULD NOT HAPPEN !!")
            raise

    else:
        #print "sys.exc_info()[2] ", sys.exc_info()[2]
        raise PortfolioError( "Cannot convert %s, type: %s, to a valid EAction" % (action, type(action)) )
        # no improvment, miss the traceback
        #raise PortfolioError( "Cannot convert %s to a valid EAction" % action ), None, sys.exc_info()[2]

    #print "return result"
    return e_action


## @brief Time function
# @code 
# timestamp_to_string(1424991600) \n
# '2015-02-27 00:00:00'
# @endcode
def timestamp_to_string( ts ):
    return datetime.datetime.fromtimestamp( ts ).strftime('%Y-%m-%d %H:%M:%S')

## @brief opposite
# all seems to be in local time, like the rest of the application (1970-01-01 00:00:00 = -3600)
# http://stackoverflow.com/questions/9637838/convert-string-date-to-timestamp-in-python
def string_to_timestamp( str_date ):
    
    t1 = time.mktime(datetime.datetime.strptime(str_date, "%Y-%m-%d %H:%M:%S").timetuple())
    # limited to local time ? timestamp()python > 3.3
    # t2 = datetime.datetime.strptime(str_date,"%Y-%m-%d %H:%M:%S").timestamp()
    # round stay float, round 1, 2 decimal ?
    #t1 = round(t1)
    t1 = int(t1)
    return t1

## @brief  Nice string output of python dictionary or list of dictionaries.
# The function is called recursively and deal with dictionary, list and simple values.
#
# Deal with a list of dict_data_stock, ok to improve, option multi-column...
# @param dict input can be a dictionary or a list of dictionaries
# @param out_str used only for recursive calls
# @param shift_nb only used for recursive calls
# @return a string containing the formatted output 
# def pretty_dict_origin( dict, out_str = str(), shift_nb = 0 ):
# 
#     #print "\nPretty Dict:"
#     #print "type(dict) ", type(dict)
#     #print "out_str:", out_str,"!!!"
#     #print dict
# 
#     shift_str='     '
#     shift_str=shift_str * shift_nb
#     #print "shift_str %d:%s!!!" % (shift_nb,shift_str)
#     
#     if (type(dict) == types.DictType): #| (type(dict) == types.ListType ):
# 
#         # if dictionary, for sure will call again 
#         #if (type(dict) == types.DictType) :
#         # print key, check value. If List for value in dict: (and same logic)
#         for key,value in dict.iteritems():
# 
#             #print "key::"+key+"!!"
#             #specific entry
#             #if key == 'list_dict':
#             #    out_str +='\n======= ' + value
#             #    pass
#             
#             # do not want to print key for symbol or list_dict
#             #out_str += shift_str + key +' : '
# 
#             # recursive call
#             if ( type(value) == types.DictType ) | ( type(value) == types.ListType ):
# 
#                 # specific value, do not want to print
#                 if key == 'list_dict':
#                     pass
#             
#                 else:
#                     out_str += shift_str + key +' : '
#                     out_str += '\n'
#                     # do not want to increase for each entry, maybe each stock
#                     shift_nb += 1
#                     #shift_nb = 1 #ok with one stock
#                     # append the new dictionary or list
#                     out_str = pretty_dict( value, out_str, shift_nb )    
#             # else simple value
#             else :
# 
#                 #specific entry
#                 if key == 'symbol':
#                     out_str +='\n======= ' + value + '\n'
#                     pass
#                 # not place to check
#                 #elif key == 'list_dict':
#                 #    pass
#                 #out_str += shift_str + str(value)
#                 else :
#                     out_str += shift_str + key +' : '
#                     out_str += str(value)
#                     out_str += '\n'
# 
#     # works if values are a list,
#     # need more test if elements are dictionary/an other List 
#     elif type(dict) == types.ListType :
# 
#         # check type of the first element, only for list
#         if len(dict) > 0:
#             type_elem = type( dict[0] )
#         else:
#             print "Empty dictionary in Utils.pretty_dict"
#             return out_str
#         #print "type_elem ", type_elem
# 
#         # case of list of dictionary, to add list of list ??
#         if type_elem == types.DictType :
#             #out_str += '\n'
#             #shift_nb += 1
#             for value in dict:
#                 out_str = pretty_dict( value, out_str, shift_nb )
#             #shift_nb -= 1
#         # simple value to print
#         else :
#             # need to loop
#             out_str += shift_str + ', '.join(str(x) for x in dict)
#             out_str += '\n'
#         #shift_nb -= 1
# 
#     return out_str
    
def pretty_dict( dict, out_str = str(), shift_nb = 0 ):

    shift_str='     '
    shift_str=shift_str * shift_nb
    
    if (type(dict) == types.DictType): #| (type(dict) == types.ListType ):

        # if dictionary, for sure will call again
        # print key, check value. If List for value in dict: (and same logic)
        for key,value in dict.iteritems():

            # recursive call
            if ( type(value) == types.DictType ) | ( type(value) == types.ListType ):

                # specific value, do not want to print
                if key == 'list_dict':
                    pass
            
                else:
                    out_str += shift_str + key +' : '
                    out_str += '\n'
                    # do not want to increase for each entry, maybe each stock
                    shift_nb += 1
                    #shift_nb = 1 #ok with one stock
                    # append the new dictionary or list
                    out_str = pretty_dict( value, out_str, shift_nb )
                    shift_nb -= 1    
            # else simple value
            else :

                #specific entry
                if key == 'symbol':
                    out_str +='\n======= ' + value + '\n'
                    pass
                
                else :
                    out_str += shift_str + key +' : '
                    out_str += str(value)
                    out_str += '\n'

    # works if values are a list,
    # need more test if elements are dictionary/an other List 
    elif type(dict) == types.ListType :

        # check type of the first element, only for list
        if len(dict) > 0:
            type_elem = type( dict[0] )
        else:
            #print "Empty dictionary in Utils.pretty_dict"
            return out_str
        #print "type_elem ", type_elem

        # case of list of dictionary, to add list of list ??
        if type_elem == types.DictType :
            #out_str += '\n'
            #shift_nb += 1
            for value in dict:
                out_str = pretty_dict( value, out_str, shift_nb )
        # simple value to print
        else :
            # need to loop
            out_str += shift_str + ', '.join(str(x) for x in dict)
            out_str += '\n'
        
    return out_str
    


# Main for testing functions
if __name__ == "__main__":

    dict1 ={'key1' : 1,
            'key2' : [2,"toto"], #"2" acepted with join, not 2
            'key3' : 3 }

    dict2 = {'symbol': 'CAC40', 'InstValue ': {'volume': 898.0, 'plusbas': 4224.34, 'state': 'OPEN', 'ouverture': 4294.05, 'variation': -0.22, 'plushaut': 4311.0, 'time': '14:36:00', 'date': '2015-01-02', 'value': 4263.39}}
    # from Fundamental, only 1 stock
    dict3 = [{'symbol': '"GSZ.PA"', 'list_dict': ['Fundamental'], 'Fundamental': {'other': {}, 'MarketCapitalization': '45.753B', 'BVPS': 21.442, 'SharesOwned': '-', 'PriceBook': 0.9, 'PEG': 'N/A\r', 'DividendYield': 1.67, 'PER': 'N/A'}}]

    # from Fundamental, only 1 stock
    dict4 = [{'symbol': '"GSZ.PA"', 'list_dict': ['Fundamental'], 'Fundamental': {'other': {}, 'MarketCapitalization': '45.753B', 'BVPS': 21.442, 'SharesOwned': '-', 'PriceBook': 0.9, 'PEG': 'N/A\r', 'DividendYield': 1.67, 'PER': 'N/A'}},{'symbol': '"GSZ2.PA"', 'list_dict': ['Fundamental'], 'Fundamental': {'other': {'subother':'toto', 'subother2':'toto2'}, 'MarketCapitalization': '45.753B', 'BVPS': 21.442, 'SharesOwned': '-', 'PriceBook': 0.9, 'PEG': 'N/A\r', 'DividendYield': 1.67, 'PER': 'N/A'}}]

    print "\n== dict 1"
    print pretty_dict( dict1 )
    
    print "\n== dict 2"
    print pretty_dict( dict2 )
    
    #pretty_dict_test( dict2 )
    str_pretty = pretty_dict( dict4 )
    print "\n nice formatting"
    print str_pretty