str_methods.py File Reference

Add str methods to financial objects so that. More...

Go to the source code of this file.

Data Structures
class	str_methods.ClassWithCutting__format__

Functions
	str_methods.setflag (self, name, value)
	str_methods.getflag (self, name)
	str_methods.register_optionflag (self, name)
	str_methods.ya_add_method (_class, function, method_name=None, clsmethod=False, noinstance=False)
	str_methods.infect (_class, function, method_name)
	str_methods.all_as_classwithcutting__format__ (*args)
	str_methods.all_as_classwithcutting__format__keys (encoding=None, error=None, **keys)
	str_methods.__split__str__ (self, encoding=None, error=None)
	str_methods.__transaction__str__ (self)
	str_methods.__invoice__str__ (self)
	str_methods.__entry__str__ (self)

Variables
str	str_methods.DEFAULT_ENCODING = "UTF-8"
str	str_methods.DEFAULT_ERROR = "ignore"
	str_methods.OPTIONFLAGS_BY_NAME

Detailed Description

Add str methods to financial objects so that.

print object 

leads to human readable results

Definition in file str_methods.py.

Function Documentation

__entry__str__()

str_methods.__entry__str__

(

self

)

__str__ method for Entry

Definition at line 324 of file str_methods.py.

def __entry__str__(self):
    """__str__ method for Entry"""
 
    from gnucash.gnucash_business import Entry
    self=Entry(instance=self)
 
    # This dict and the return statement can be changed according to individual needs
    fmt_dict={
        "date_name":"Date:",
        "date_value":str(self.GetDate()),
        "description_name":"Description:",
        "description_value":self.GetDescription(),
        "notes_name":"Notes:",
        "notes_value":self.GetNotes(),
        "quant_name":"Quantity:",
        "quant_value":str(self.GetQuantity()),
        "invprice_name":"InvPrice:",
        "invprice_value":str(self.GetInvPrice())}
 
    return ("{date_name:6}{date_value:15} {description_name:13}{description_value:20} {notes_name:7}{notes_value:20}"+
            "{quant_name:12}{quant_value:7} {invprice_name:10}{invprice_value:7}").\
                format(**all_as_classwithcutting__format__keys(**fmt_dict))
 

__invoice__str__()

str_methods.__invoice__str__

(

self

)

__str__ method for Invoice

Definition at line 284 of file str_methods.py.

def __invoice__str__(self):
    """__str__ method for Invoice"""
 
    from gnucash.gnucash_business import Invoice
    self=Invoice(instance=self)
 
 
    # This dict and the return statement can be changed according to individual needs
    fmt_dict={
        "id_name":"ID:",
        "id_value":self.GetID(),
        "notes_name":"Notes:",
        "notes_value":self.GetNotes(),
        "active_name":"Active:",
        "active_value":str(self.GetActive()),
        "owner_name":"Owner Name:",
        "owner_value":self.GetOwner().GetName(),
        "total_name":"Total:",
        "total_value":str(self.GetTotal()),
        "currency_mnemonic":self.GetCurrency().get_mnemonic()}
 
    ret_invoice= ("{id_name:4}{id_value:10} {notes_name:7}{notes_value:20} {active_name:8}{active_value:7} {owner_name:12}{owner_value:20}"+
                  "{total_name:8}{total_value:10}{currency_mnemonic:3}").\
                    format(**all_as_classwithcutting__format__keys(**fmt_dict))
 
    ret_entries=""
    entry_list = self.GetEntries()
    for entry in entry_list: # Type of entry has to be checked
      if not(type(entry)==Entry):
        entry=Entry(instance=entry)
      ret_entries += "  "+str(entry)+"\n"
 
    return ret_invoice+"\n"+ret_entries
 
 

__split__str__()

str_methods.__split__str__	(		self,
			encoding = None,
			error = None
	)

__str__(self, encoding=None, error=None) -> object

Serialize the Split object and return as a new Unicode object.

Keyword arguments:
encoding -- defaults to str_methods.default_encoding
error -- defaults to str_methods.default_error
See help(unicode) for more details or http://docs.python.org/howto/unicode.html.

Definition at line 199 of file str_methods.py.

def __split__str__(self, encoding=None, error=None):
    """__str__(self, encoding=None, error=None) -> object
 
    Serialize the Split object and return as a new Unicode object.
 
    Keyword arguments:
    encoding -- defaults to str_methods.default_encoding
    error -- defaults to str_methods.default_error
    See help(unicode) for more details or http://docs.python.org/howto/unicode.html.
 
    """
 
    from gnucash import Split
    import time
    #self=Split(instance=self)
 
    lot=self.GetLot()
    if lot:
        lot_str=lot.get_title()
    else:
        lot_str='---'
 
    transaction=self.GetParent()
 
    # This dict and the return statement can be changed according to individual needs
    fmt_dict={
        "account":self.GetAccount().name,
        "value":self.GetValue(),
        "memo":self.GetMemo(),
        "lot":lot_str}
 
    fmt_str= ("Account: {account:20} "+
            "Value: {value:>10} "+
            "Memo: {memo:30} ")
 
    if self.optionflags & self.OPTIONFLAGS_BY_NAME["PRINT_TRANSACTION"]:
        fmt_t_dict={
            "transaction_time":time.ctime(transaction.GetDate()),
            "transaction2":transaction.GetDescription()}
        fmt_t_str=(
            "Transaction: {transaction_time:30} "+
            "- {transaction2:30} "+
            "Lot: {lot:10}")
        fmt_dict.update(fmt_t_dict)
        fmt_str += fmt_t_str
 
    return fmt_str.format(**all_as_classwithcutting__format__keys(encoding,error,**fmt_dict))
 
# This could be something like an __init__. Maybe we could call it virus because it infects the Split object which
# thereafter mutates to have better capabilities.

__transaction__str__()

str_methods.__transaction__str__

(

self

)

__str__ method for Transaction class

Definition at line 253 of file str_methods.py.

def __transaction__str__(self):
    """__str__ method for Transaction class"""
    from gnucash import Transaction
    import time
    self=Transaction(instance=self)
 
    fmt_tuple=('Date:',time.ctime(self.GetDate()),
          'Description:',self.GetDescription(),
          'Notes:',self.GetNotes())
 
    transaction_str = "{0:6}{1:25} {2:14}{3:40} {4:7}{5:40}".format(
          *all_as_classwithcutting__format__(*fmt_tuple))
    transaction_str += "\n"
 
    splits_str=""
    for n,split in enumerate(self.GetSplitList()):
        if not (type(split)==gnucash.Split):
            split=gnucash.Split(instance=split)
 
        transaction_flag = split.getflag("PRINT_TRANSACTION")
        split.setflag("PRINT_TRANSACTION",False)
        splits_str += "[{0:>2}] ".format(str(n))
        splits_str += str(split)
        splits_str += "\n"
        split.setflag("PRINT_TRANSACTION",transaction_flag)
 
    return transaction_str + splits_str
 

all_as_classwithcutting__format__()

str_methods.all_as_classwithcutting__format__

(

*

args

)

Converts every argument to instance of ClassWithCutting__format__

Definition at line 168 of file str_methods.py.

def all_as_classwithcutting__format__(*args):
    """Converts every argument to instance of ClassWithCutting__format__"""
 
    #import types
    l=[]
    for a in args:
        #if type(a) in [types.StringType, types.UnicodeType]:
        #  a=a.decode("UTF-8")
        l.append(ClassWithCutting__format__(a))
 
    return l
 

all_as_classwithcutting__format__keys()

str_methods.all_as_classwithcutting__format__keys	(		encoding = None,
			error = None,
		**	keys
	)

Converts every argument to instance of ClassWithCutting__format__

Definition at line 180 of file str_methods.py.

def all_as_classwithcutting__format__keys(encoding=None, error=None, **keys):
    """Converts every argument to instance of ClassWithCutting__format__"""
 
    #import types
    d={}
    if encoding==None:
      encoding=DEFAULT_ENCODING
    if error==None:
      error=DEFAULT_ERROR
    for a in keys:
        #if isinstance(keys[a], str):
        #  keys[a]=keys[a].decode(encoding,error)
        d[a]=ClassWithCutting__format__(keys[a])
 
    return d
 
 
 
# Split

getflag()

str_methods.getflag	(		self,
			name
	)

Definition at line 48 of file str_methods.py.

def getflag(self, name):
    if not(name in self.OPTIONFLAGS_BY_NAME):
      raise KeyError(str(name)+" is not a registered key.")
    return ((self.optionflags & self.OPTIONFLAGS_BY_NAME[name]) != 0)
 

infect()

str_methods.infect	(		_class,
			function,
			method_name
	)

Definition at line 76 of file str_methods.py.

def infect(_class, function, method_name):
    if not getattr(_class, "OPTIONFLAGS_BY_NAME", None):
      _class.OPTIONFLAGS_BY_NAME={}
      _class.optionflags=0
      ya_add_method(_class,register_optionflag,clsmethod=True)
      ya_add_method(_class,setflag,clsmethod=True)
      ya_add_method(_class,getflag,clsmethod=True)
    ya_add_method(_class, function, method_name)
 

register_optionflag()

str_methods.register_optionflag	(		self,
			name
	)

Taken from doctest.py

Definition at line 53 of file str_methods.py.

def register_optionflag(self,name):
    """Taken from doctest.py"""
    # Create a new flag unless `name` is already known.
    return self.OPTIONFLAGS_BY_NAME.setdefault(name, 1 << len(self.OPTIONFLAGS_BY_NAME))
 

setflag()

str_methods.setflag	(		self,
			name,
			value
	)

Definition at line 40 of file str_methods.py.

def setflag(self, name, value):
    if not(name in self.OPTIONFLAGS_BY_NAME):
      self.register_optionflag(name)
    if value == True:
      self.optionflags |= self.OPTIONFLAGS_BY_NAME[name]
    else:
      self.optionflags &= ~self.OPTIONFLAGS_BY_NAME[name]
 

ya_add_method()

str_methods.ya_add_method	(		_class,
			function,
			method_name = None,
			clsmethod = False,
			noinstance = False
	)

Calls add_method from function_methods.py but makes it
possible to use functions in this module. Also keeps the
docstring

Definition at line 58 of file str_methods.py.

def ya_add_method(_class, function, method_name=None, clsmethod=False, noinstance=False):
    """Calls add_method from function_methods.py but makes it
    possible to use functions in this module. Also keeps the
    docstring"""
 
    if method_name == None:
      method_name = function.__name__
 
    setattr(gnucash.gnucash_core_c,function.__name__,function)
    if clsmethod:
      mf=_class.ya_add_classmethod(function.__name__,method_name)
    elif noinstance:
      mf=_class.add_method(function.__name__,method_name)
    else:
      mf=_class.ya_add_method(function.__name__,method_name)
    if function.__doc__ != None:
      setattr(mf, "__doc__", function.__doc__)
 

Variable Documentation

DEFAULT_ENCODING

str str_methods.DEFAULT_ENCODING = "UTF-8"

Definition at line 37 of file str_methods.py.

DEFAULT_ERROR

str str_methods.DEFAULT_ERROR = "ignore"

Definition at line 38 of file str_methods.py.

OPTIONFLAGS_BY_NAME

str_methods.OPTIONFLAGS_BY_NAME

Definition at line 41 of file str_methods.py.