IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

make Session a context manager

Browse Source
This commit is contained in:
andygoblins
2020-02-09 14:53:17 -06:00
parent 4502afad4f
commit f1f450cedc
2 changed files with 67 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
bindings/python/example_scripts/simple_test.py
View File

@@ -7,81 +7,77 @@ from gnucash import Session, Account, Transaction, Split, GncNumeric
FILE_1 = "/tmp/example.gnucash" FILE_1 = "/tmp/example.gnucash"
session = Session("xml://%s" % FILE_1, is_new=True) with Session("xml://%s" % FILE_1, is_new=True) as session:
book = session.book book = session.book
root_acct = Account(book) root_acct = Account(book)
expenses_acct = Account(book) expenses_acct = Account(book)
savings_acct = Account(book) savings_acct = Account(book)
opening_acct = Account(book) opening_acct = Account(book)
trans1 = Transaction(book) trans1 = Transaction(book)
trans1.BeginEdit() trans1.BeginEdit()
trans2 = Transaction(book) trans2 = Transaction(book)
trans2.BeginEdit() trans2.BeginEdit()
split1 = Split(book) split1 = Split(book)
split3 = Split(book) split3 = Split(book)
comm_table = book.get_table() comm_table = book.get_table()
cad = comm_table.lookup("CURRENCY", "CAD") cad = comm_table.lookup("CURRENCY", "CAD")
num1 = GncNumeric(4, 1) num1 = GncNumeric(4, 1)
num2 = GncNumeric(100, 1) num2 = GncNumeric(100, 1)
#Set new root account #Set new root account
book.set_root_account(root_acct) book.set_root_account(root_acct)
#Set up root account and add sub-accounts #Set up root account and add sub-accounts
root_acct.SetName("Root") root_acct.SetName("Root")
root_acct.SetType(13) #ACCT_TYPE_ROOT = 13 root_acct.SetType(13) #ACCT_TYPE_ROOT = 13
root_acct.append_child(expenses_acct) root_acct.append_child(expenses_acct)
root_acct.append_child(savings_acct) root_acct.append_child(savings_acct)
root_acct.append_child(opening_acct) root_acct.append_child(opening_acct)
#Set up Expenses account #Set up Expenses account
expenses_acct.SetCommodity(cad) expenses_acct.SetCommodity(cad)
expenses_acct.SetName("Expenses") expenses_acct.SetName("Expenses")
expenses_acct.SetType(9) #ACCT_TYPE_EXPENSE = 9 expenses_acct.SetType(9) #ACCT_TYPE_EXPENSE = 9
#Set up Savings account #Set up Savings account
savings_acct.SetCommodity(cad) savings_acct.SetCommodity(cad)
savings_acct.SetName("Savings") savings_acct.SetName("Savings")
savings_acct.SetType(0) #ACCT_TYPE_BANK = 0 savings_acct.SetType(0) #ACCT_TYPE_BANK = 0
#Set up Opening Balance account #Set up Opening Balance account
opening_acct.SetCommodity(cad) opening_acct.SetCommodity(cad)
opening_acct.SetName("Opening Balance") opening_acct.SetName("Opening Balance")
opening_acct.SetType(10) #ACCT_TYPE_EQUITY = 10 opening_acct.SetType(10) #ACCT_TYPE_EQUITY = 10
split1.SetValue(num1) split1.SetValue(num1)
split1.SetAccount(expenses_acct) split1.SetAccount(expenses_acct)
split1.SetParent(trans1) split1.SetParent(trans1)
split3.SetValue(num2) split3.SetValue(num2)
split3.SetAccount(savings_acct) split3.SetAccount(savings_acct)
split3.SetParent(trans2) split3.SetParent(trans2)
trans1.SetCurrency(cad) trans1.SetCurrency(cad)
trans1.SetDate(14, 3, 2006) trans1.SetDate(14, 3, 2006)
trans1.SetDescription("Groceries") trans1.SetDescription("Groceries")
trans2.SetCurrency(cad) trans2.SetCurrency(cad)
trans2.SetDate(7, 11, 1995) trans2.SetDate(7, 11, 1995)
trans2.SetDescription("Opening Savings Balance") trans2.SetDescription("Opening Savings Balance")
split2 = Split(book) split2 = Split(book)
split2.SetAccount(savings_acct) split2.SetAccount(savings_acct)
split2.SetParent(trans1) split2.SetParent(trans1)
split2.SetValue(num1.neg()) split2.SetValue(num1.neg())
split4 = Split(book) split4 = Split(book)
split4.SetAccount(opening_acct) split4.SetAccount(opening_acct)
split4.SetParent(trans2) split4.SetParent(trans2)
split4.SetValue(num2.neg()) split4.SetValue(num2.neg())
trans1.CommitEdit() trans1.CommitEdit()
trans2.CommitEdit() trans2.CommitEdit()
session.save()
session.end()
session.destroy()

9
bindings/python/gnucash_core.py
View File

@@ -117,6 +117,15 @@ class Session(GnuCashCoreClass):
self.destroy() self.destroy()
raise raise
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
# Roll back changes on exception by not calling save. Only works for XMl backend.
if not exc_type:
self.save()
self.end()
def raise_backend_errors(self, called_function="qof_session function"): def raise_backend_errors(self, called_function="qof_session function"):
"""Raises a GnuCashBackendException if there are outstanding """Raises a GnuCashBackendException if there are outstanding
QOF_BACKEND errors. QOF_BACKEND errors.