account_analysis.py File Reference

Output all the credits and debits on an account. More...

Go to the source code of this file.

Functions
	account_analysis.gnc_numeric_to_python_Decimal (numeric)
	account_analysis.next_period_start (start_year, start_month, period_type)
	account_analysis.period_end (start_year, start_month, period_type)
	account_analysis.generate_period_boundaries (start_year, start_month, period_type, periods)
	account_analysis.account_from_path (top_account, account_path, original_path=None)
	account_analysis.main ()

Variables
dict	account_analysis.PERIODS
int	account_analysis.NUM_MONTHS = 12
	account_analysis.ONE_DAY = timedelta(days=1)
	account_analysis.DEBITS_SHOW
	account_analysis.CREDITS_SHOW
	account_analysis.ZERO = Decimal(0)

Detailed Description

Output all the credits and debits on an account.

Author

Mark Jenkins, ParIT Worker Co-operative mark@.nosp@m.pari.nosp@m.t.ca

Definition in file account_analysis.py.

Function Documentation

account_from_path()

account_analysis.account_from_path	(		top_account,
			account_path,
			original_path = None
	)

Definition at line 138 of file account_analysis.py.

def account_from_path(top_account, account_path, original_path=None):
    if original_path==None: original_path = account_path
    account, account_path = account_path[0], account_path[1:]
 
    account = top_account.lookup_by_name(account)
    if account == None:
        raise Exception(
            "path " + ''.join(original_path) + " could not be found")
    if len(account_path) > 0 :
        return account_from_path(account, account_path, original_path)
    else:
        return account
 
 

generate_period_boundaries()

account_analysis.generate_period_boundaries	(		start_year,
			start_month,
			period_type,
			periods
	)

Definition at line 131 of file account_analysis.py.

def generate_period_boundaries(start_year, start_month, period_type, periods):
    for i in range(periods):
        yield ( date(start_year, start_month, 1),
                period_end(start_year, start_month, period_type) )
        start_year, start_month = next_period_start(start_year, start_month,
                                                    period_type)
 

gnc_numeric_to_python_Decimal()

account_analysis.gnc_numeric_to_python_Decimal

(

numeric

)

Definition at line 77 of file account_analysis.py.

def gnc_numeric_to_python_Decimal(numeric):
    negative = numeric.negative_p()
    if negative:
        sign = 1
    else:
        sign = 0
    copy = GncNumeric(numeric.num(), numeric.denom())
    result = copy.to_decimal(None)
    if not result:
        raise Exception("gnc numeric value %s can't be converted to decimal" %
                        copy.to_string() )
    digit_tuple = tuple( int(char)
                         for char in str(copy.num())
                         if char != '-' )
    denominator = copy.denom()
    exponent = int(log10(denominator))
    assert( (10 ** exponent) == denominator )
    return Decimal( (sign, digit_tuple, -exponent) )
 
 

main()

account_analysis.main

(

)

Definition at line 152 of file account_analysis.py.

def main():
 
    if len(argv) < 10:
        print('not enough parameters')
        print('usage: account_analysis.py {book url} {start year} {start month, numeric} {period type: monthly, quarterly, or yearly} {number of periods to show, from start year and month} {whether to show debits: debits-show for true, all other values false} {whether to show credits: credits-show for true, all other values false} {space separated account path, as many nested levels as desired} ')
        print('examples:\n')
        print("The following example analyzes 12 months of 'Assets:Test Account' from /home/username/test.gnucash, starting in January of 2010, and shows both credits and debits")
        print("python3 account_analysis.py '/home/username/test.gnucash' 2010 1 monthly 12 debits-show credits-show Assets 'Test Account'\n")
        print("The following example analyzes 2 quarters of 'Liabilities:First Level:Second Level' from /home/username/test.gnucash, starting March 2011, and shows credits but not debits")
        print("python3 account_analysis.py '/home/username/test.gnucash' 2011 3 quarterly 2 debits-noshow credits-show Liabilities 'First Level' 'Second Level")
        return
 
    try:
        (gnucash_file, start_year, start_month, period_type, periods,
         debits_show, credits_show) = argv[1:8]
        start_year, start_month, periods = [int(blah)
                                            for blah in (start_year, start_month,
                                                         periods) ]
 
        debits_show = debits_show == DEBITS_SHOW
        credits_show = credits_show == CREDITS_SHOW
 
        account_path = argv[8:]
 
        gnucash_session = Session(gnucash_file, SessionOpenMode.SESSION_NORMAL_OPEN)
        root_account = gnucash_session.book.get_root_account()
        account_of_interest = account_from_path(root_account, account_path)
 
        # a list of all the periods of interest, for each period
        # keep the start date, end date, a list to store debits and credits,
        # and sums for tracking the sum of all debits and sum of all credits
        period_list = [
            [start_date, end_date,
             [], # debits
             [], # credits
             ZERO, # debits sum
             ZERO, # credits sum
             ]
            for start_date, end_date in generate_period_boundaries(
                start_year, start_month, period_type, periods)
            ]
        # a copy of the above list with just the period start dates
        period_starts = [e[0] for e in period_list ]
 
        # insert and add all splits in the periods of interest
        for split in account_of_interest.GetSplitList():
            trans = split.parent
            trans_date = date.fromtimestamp(trans.GetDate())
 
            # use binary search to find the period that starts before or on
            # the transaction date
            period_index = bisect_right( period_starts, trans_date ) - 1
 
            # ignore transactions with a date before the matching period start
            # (after subtracting 1 above start_index would be -1)
            # and after the last period_end
            if period_index >= 0 and \
                    trans_date <= period_list[len(period_list)-1][1]:
 
                # get the period bucket appropriate for the split in question
                period = period_list[period_index]
 
                # more specifically, we'd expect the transaction date
                # to be on or after the period start, and  before or on the
                # period end, assuming the binary search (bisect_right)
                # assumptions from above are are right..
                #
                # in other words, we assert our use of binary search
                # and the filtered results from the above if provide all the
                # protection we need
                assert( trans_date>= period[0] and trans_date <= period[1] )
 
                split_amount = gnc_numeric_to_python_Decimal(split.GetAmount())
 
                # if the amount is negative, this is a credit
                if split_amount < ZERO:
                    debit_credit_offset = 1
                # else a debit
                else:
                    debit_credit_offset = 0
 
                # store the debit or credit Split with its transaction, using the
                # above offset to get in the right bucket
                #
                # if we wanted to be really cool we'd keep the transactions
                period[2+debit_credit_offset].append( (trans, split) )
 
                # add the debit or credit to the sum, using the above offset
                # to get in the right bucket
                period[4+debit_credit_offset] += split_amount
 
        csv_writer = csv.writer(stdout)
        csv_writer.writerow( ('period start', 'period end', 'debits', 'credits') )
 
        def generate_detail_rows(values):
            return (
                ('', '', '', '', trans.GetDescription(),
                 gnc_numeric_to_python_Decimal(split.GetAmount()))
                for trans, split in values )
 
 
        for start_date, end_date, debits, credits, debit_sum, credit_sum in \
                period_list:
            csv_writer.writerow( (start_date, end_date, debit_sum, credit_sum) )
 
            if debits_show and len(debits) > 0:
                csv_writer.writerow(
                    ('DEBITS', '', '', '', 'description', 'value') )
                csv_writer.writerows( generate_detail_rows(debits) )
                csv_writer.writerow( () )
            if credits_show and len(credits) > 0:
                csv_writer.writerow(
                    ('CREDITS', '', '', '', 'description', 'value') )
                csv_writer.writerows( generate_detail_rows(credits) )
                csv_writer.writerow( () )
 
        # no save needed, we're just reading..
        gnucash_session.end()
    except:
        if "gnucash_session" in locals():
            gnucash_session.end()
 
        raise
 

next_period_start()

account_analysis.next_period_start	(		start_year,
			start_month,
			period_type
	)

Definition at line 97 of file account_analysis.py.

def next_period_start(start_year, start_month, period_type):
    # add numbers of months for the period length
    end_month = start_month + PERIODS[period_type]
    # use integer division to find out if the new end month is in a different
    # year, what year it is, and what the end month number should be changed
    # to.
    # Because this depends on modular arithmetic, we have to curvert the month
    # values from 1-12 to 0-11 by subtracting 1 and putting it back after
    #
    # the really cool part is that this whole thing is implemented without
    # any branching; if end_month > NUM_MONTHS
    #
    # A the super nice thing is that you can add all kinds of period lengths
    # to PERIODS
    end_year = start_year + ( (end_month-1) / NUM_MONTHS )
    end_month = ( (end_month-1) % NUM_MONTHS ) + 1
 
    return end_year, end_month
 
 

period_end()

account_analysis.period_end	(		start_year,
			start_month,
			period_type
	)

Definition at line 117 of file account_analysis.py.

def period_end(start_year, start_month, period_type):
    if period_type not in PERIODS:
        raise Exception("%s is not a valid period, should be %s" % (
                period_type, str(list(PERIODS.keys())) ) )
 
    end_year, end_month = next_period_start(start_year, start_month,
                                            period_type)
 
    # last step, the end date is day back from the start of the next period
    # so we get a period end like
    # 2010-03-31 for period starting 2010-01 instead of 2010-04-01
    return date(end_year, end_month, 1) - ONE_DAY
 
 

Variable Documentation

CREDITS_SHOW

account_analysis.CREDITS_SHOW

Definition at line 73 of file account_analysis.py.

DEBITS_SHOW

account_analysis.DEBITS_SHOW

Definition at line 73 of file account_analysis.py.

NUM_MONTHS

int account_analysis.NUM_MONTHS = 12

Definition at line 69 of file account_analysis.py.

ONE_DAY

account_analysis.ONE_DAY = timedelta(days=1)

Definition at line 71 of file account_analysis.py.

PERIODS

dict account_analysis.PERIODS

Initial value:

=  {"monthly": 1,
           "quarterly": 3,
           "yearly": 12 }

Definition at line 65 of file account_analysis.py.

ZERO

account_analysis.ZERO = Decimal(0)

Definition at line 75 of file account_analysis.py.