qof.py File Reference

Some examples for qof queries. More...

Go to the source code of this file.

Functions
	qof.createAccounts (book)
	qof.createRandomTransactions (book, accountA, accountB)
	qof.query_transactions (book, terms=[])
	qof.query_splits (book, terms=[])

Variables
str	qof.uri = "xml:///tmp/qof.gnucash"
	qof.book = ses.get_book()
	qof.accountA
	qof.accountB
	qof.transactions_all = query_transactions(book)
	qof.threshold = datetime.datetime(1950,1,1)
int	qof.QOF_DATE_MATCH_NORMAL = 2
list	qof.terms = [(['date-posted'], gnucash_core.QueryDatePredicate(QOF_COMPARE_GTE, QOF_DATE_MATCH_NORMAL, threshold), QOF_QUERY_AND)]
	qof.transactions_2 = query_transactions(book, terms)
bool	qof.isRegex = False
	qof.transactions_3 = query_transactions(book, terms)
	qof.splits_1 = query_splits(book, terms)
	qof.splits_2 = query_splits(book, terms)
	qof.splits_4 = query_splits(book, terms)
	qof.splits_3 = query_splits(book, terms)

Detailed Description

Some examples for qof queries.

Author

Christoph Holtermann

Date

2022-03-06

Note

incomplete set of qof examples, to be extended

Definition in file qof.py.

Function Documentation

createAccounts()

qof.createAccounts

(

book

)

Definition at line 23 of file qof.py.

def createAccounts(book):
    root_account = book.get_root_account()
    commodtable = book.get_table()
    currency = commodtable.lookup("CURRENCY", "EUR")
    ses.save()
 
    print('Create two accounts ("Account A", "Account B")')
    accountA = Account(book)
    accountA.SetCommodity(currency)
    accountA.SetName("Account A")
    root_account.append_child(accountA)
 
    accountB = Account(book)
    accountB.SetCommodity(currency)
    accountB.SetName("Account B")
    root_account.append_child(accountB)
 
    #ses.save()
 
    return accountA, accountB
 

createRandomTransactions()

qof.createRandomTransactions	(		book,
			accountA,
			accountB
	)

Definition at line 44 of file qof.py.

def createRandomTransactions(book, accountA, accountB):
    split = Split(book)
 
    currency = book.get_table().lookup("CURRENCY", "EUR")
 
    print("Create 100 random transactions")
    for i in range(100):
 
        trans = Transaction(book)
        trans.BeginEdit()
        trans.SetCurrency(currency) 
        trans.SetDate(randint(1,28), randint(1,12), randint(1900,2000))
        trans.SetDescription("Transaction "+str(i))
 
        value = randint(0,10000)
 
        value1 = GncNumeric(value, 100)
        value2 = GncNumeric(-value, 100)
 
        split1 = Split(book)
        split1.SetValue(value1)
        split1.SetAccount(accountA)
        split1.SetMemo("A" + str(i))
        split1.SetParent(trans)
       
        split2 = Split(book)
        split2.SetValue(value2)
        split2.SetAccount(accountB)
        split2.SetMemo("B" + str(i))
        split2.SetParent(trans)
 
        trans.CommitEdit()
 

query_splits()

qof.query_splits	(		book,
			terms = []
	)

Definition at line 96 of file qof.py.

def query_splits(book, terms=[]):
 
    query = Query()
    query.search_for('Split')
    query.set_book(book)
 
    if terms:
        for term in terms:
            query.add_term(*term)
 
    splits = []
 
    for split in query.run():
        split = Split(instance=split) # ToDo: query.run() should return objects
        splits.append(split)    
 
    query.destroy()
    return splits
 

query_transactions()

qof.query_transactions	(		book,
			terms = []
	)

Definition at line 77 of file qof.py.

def query_transactions(book, terms=[]):
 
    query = Query()
    query.search_for('Trans')
    query.set_book(book)
 
    if terms:
        for term in terms:
            query.add_term(*term)
 
    transactions = []
 
    for transaction in query.run():
        transaction = Transaction(instance=transaction) # ToDo: query.run() should return objects
        transactions.append(transaction)    
 
    query.destroy()
    return transactions
 

Variable Documentation

accountA

qof.accountA

Definition at line 118 of file qof.py.

accountB

qof.accountB

Definition at line 118 of file qof.py.

book

qof.book = ses.get_book()

Definition at line 117 of file qof.py.

isRegex

bool qof.isRegex = False

Definition at line 135 of file qof.py.

QOF_DATE_MATCH_NORMAL

int qof.QOF_DATE_MATCH_NORMAL = 2

Definition at line 129 of file qof.py.

splits_1

qof.splits_1 = query_splits(book, terms)

Definition at line 145 of file qof.py.

splits_2

qof.splits_2 = query_splits(book, terms)

Definition at line 151 of file qof.py.

splits_3

qof.splits_3 = query_splits(book, terms)

Definition at line 164 of file qof.py.

splits_4

qof.splits_4 = query_splits(book, terms)

Definition at line 158 of file qof.py.

terms

list qof.terms = [(['date-posted'], gnucash_core.QueryDatePredicate(QOF_COMPARE_GTE, QOF_DATE_MATCH_NORMAL, threshold), QOF_QUERY_AND)]

Definition at line 130 of file qof.py.

threshold

qof.threshold = datetime.datetime(1950,1,1)

Definition at line 128 of file qof.py.

transactions_2

qof.transactions_2 = query_transactions(book, terms)

Definition at line 131 of file qof.py.

transactions_3

qof.transactions_3 = query_transactions(book, terms)

Definition at line 137 of file qof.py.

transactions_all

qof.transactions_all = query_transactions(book)

Definition at line 124 of file qof.py.

uri

str qof.uri = "xml:///tmp/qof.gnucash"

Definition at line 21 of file qof.py.