162 from enum
import IntEnum
163 from urllib.parse
import urlparse
165 from gnucash
import gnucash_core_c
166 from gnucash
import _sw_core_utils
168 from gnucash.function_class
import \
169 ClassFromFunctions, extract_attributes_with_prefix, \
170 default_arguments_decorator, method_function_returns_instance, \
171 methods_return_instance, process_list_convert_to_instance, \
172 method_function_returns_instance_list, methods_return_instance_lists
174 from gnucash.gnucash_core_c
import gncInvoiceLookup, gncInvoiceGetInvoiceFromTxn, \
175 gncInvoiceGetInvoiceFromLot, gncEntryLookup, gncInvoiceLookup, \
176 gncCustomerLookup, gncVendorLookup, gncJobLookup, gncEmployeeLookup, \
177 gncTaxTableLookup, gncTaxTableLookupByName, gnc_search_invoice_on_id, \
178 gnc_search_customer_on_id, gnc_search_bill_on_id , \
179 gnc_search_vendor_on_id, gncInvoiceNextID, gncCustomerNextID, \
180 gncVendorNextID, gncTaxTableGetTables, gnc_numeric_zero, \
181 gnc_numeric_create, double_to_gnc_numeric, gnc_numeric_from_string, \
182 gnc_numeric_to_string, gnc_numeric_check
184 from gnucash.deprecation
import (
185 deprecated_args_session,
186 deprecated_args_session_init,
187 deprecated_args_session_begin,
194 _localedir = _sw_core_utils.gnc_path_get_localedir()
195 gettext.install(_sw_core_utils.GETTEXT_PACKAGE, _localedir)
198 print(
"Problem importing gettext!")
201 exc_type, exc_value, exc_traceback = sys.exc_info()
202 traceback.print_exception(exc_type, exc_value, exc_traceback)
206 """Null translator function, gettext not available""" 210 builtins.__dict__[
'_'] = _
213 _module = gnucash_core_c
215 def do_lookup_create_oo_instance(self, lookup_function, cls, *args):
216 thing = lookup_function(self.get_instance(), *args)
218 thing = cls(instance=thing)
223 def __init__(self, msg, errors):
224 Exception.__init__(self, msg)
229 """Mode for opening sessions. 231 This replaces three booleans that were passed in order: ignore_lock, create, 232 and force. It's structured so that one can use it as a bit field with the 233 values in the same order, i.e. ignore_lock = 1 << 2, create_new = 1 << 1, and 239 SESSION_NORMAL_OPEN = 0 (All False) 240 Open will fail if the URI doesn't exist or is locked. 242 SESSION_NEW_STORE = 2 (False, True, False (create)) 243 Create a new store at the URI. It will fail if the store already exists and is found to contain data that would be overwritten. 245 SESSION_NEW_OVERWRITE = 3 (False, True, True (create | force)) 246 Create a new store at the URI even if a store already exists there. 248 SESSION_READ_ONLY = 4, (True, False, False (ignore_lock)) 249 Open the session read-only, ignoring any existing lock and not creating one if the URI isn't locked. 251 SESSION_BREAK_LOCK = 5 (True, False, True (ignore_lock | force)) 252 Open the session, taking over any existing lock. 254 source: lignucash/engine/qofsession.h 257 SESSION_NORMAL_OPEN = gnucash_core_c.SESSION_NORMAL_OPEN
259 Open will fail if the URI doesn't exist or is locked.""" 261 SESSION_NEW_STORE = gnucash_core_c.SESSION_NEW_STORE
262 """False, True, False (create) 263 Create a new store at the URI. It will fail if the store already exists and is found to contain data that would be overwritten.""" 265 SESSION_NEW_OVERWRITE = gnucash_core_c.SESSION_NEW_OVERWRITE
266 """False, True, True (create | force) 267 Create a new store at the URI even if a store already exists there.""" 269 SESSION_READ_ONLY = gnucash_core_c.SESSION_READ_ONLY
270 """True, False, False (ignore_lock) 271 Open the session read-only, ignoring any existing lock and not creating one if the URI isn't locked.""" 273 SESSION_BREAK_LOCK = gnucash_core_c.SESSION_BREAK_LOCK
274 """True, False, True (ignore_lock | force) 275 Open the session, taking over any existing lock.""" 279 """A GnuCash book editing session 281 To commit changes to the session you may need to call save, 282 (this is always the case with the file backend). 284 When you're down with a session you may need to call end() 286 Every Session has a Book in the book attribute, which you'll definitely 287 be interested in, as every GnuCash entity (Transaction, Split, Vendor, 288 Invoice..) is associated with a particular book where it is stored. 291 @deprecated_args_session_init
292 def __init__(self, book_uri=None, mode=None, instance=None, book=None):
294 A convenient constructor that allows you to specify a book URI, 295 begin the session, and load the book. 297 This can give you the power of calling 298 qof_session_new, qof_session_begin, and qof_session_load all in one! 300 qof_session_load is only called if url scheme is "xml" and 301 mode is SESSION_NEW_STORE or SESSION_NEW_OVERWRITE 303 @param book_uri must be a string in the form of a URI/URL. The access 304 method specified depends on the loaded backends. Paths may be relative 305 or absolute. If the path is relative, that is if the argument is 306 "file://somefile.xml", then the current working directory is 307 assumed. Customized backends can choose to search other 308 application-specific directories or URI schemes as well. 309 It be None to skip the calls to qof_session_begin and 312 @param instance argument can be passed if new Session is used as a 313 wrapper for an existing session instance 315 @param mode The SessionOpenMode. 316 @note SessionOpenMode replaces deprecated ignore_lock, is_new and force_new. 319 `SESSION_NORMAL_OPEN`: Find an existing file or database at the provided uri and 320 open it if it is unlocked. If it is locked post a QOF_BACKEND_LOCKED error. 322 `SESSION_NEW_STORE`: Check for an existing file or database at the provided 323 uri and if none is found, create it. If the file or database exists post a 324 QOF_BACKED_STORE_EXISTS and return. 326 `SESSION_NEW_OVERWRITE`: Create a new file or database at the provided uri, 327 deleting any existing file or database. 329 `SESSION_READ_ONLY`: Find an existing file or database and open it without 330 disturbing the lock if it exists or setting one if not. This will also set a 331 flag on the book that will prevent many elements from being edited and will 332 prevent the backend from saving any edits. 334 `SESSION_BREAK_LOCK`: Find an existing file or database, lock it, and open 335 it. If there is already a lock replace it with a new one for this session. 338 qof_session_begin() signals failure by queuing errors. After it completes use 339 qof_session_get_error() and test that the value is `ERROR_BACKEND_NONE` to 340 determine that the session began successfully. 342 @exception as begin() and load() are wrapped with raise_backend_errors_after_call() 343 this function can raise a GnuCashBackendException. If it does, 344 you don't need to cleanup and call end() and destroy(), that is handled 345 for you, and the exception is raised. 347 if instance
is not None:
348 GnuCashCoreClass.__init__(self, instance=instance)
352 GnuCashCoreClass.__init__(self, book)
354 if book_uri
is not None:
357 mode = SessionOpenMode.SESSION_NORMAL_OPEN
358 self.begin(book_uri, mode)
364 is_new = mode
in (SessionOpenMode.SESSION_NEW_STORE, SessionOpenMode.SESSION_NEW_OVERWRITE)
365 scheme = urlparse(book_uri).scheme
366 if not (is_new
and scheme ==
'xml'):
368 except GnuCashBackendException
as backend_exception:
376 def __exit__(self, exc_type, exc_value, traceback):
383 """Raises a GnuCashBackendException if there are outstanding 386 set called_function to name the function that was last called 391 "call to %s resulted in the " 392 "following errors, %s" % (called_function, backend_error_dict[errors[0]]),
396 """A generator that yields any outstanding QofBackend errors 398 while self.get_error()
is not ERR_BACKEND_NO_ERR:
399 error = self.pop_error()
403 """Returns any accumulated qof backend errors as a tuple 410 """A function decorator that results in a call to 411 raise_backend_errors after execution. 413 def new_function(self, *args, **kwargs):
414 return_value = function(self, *args, **kwargs)
420 """A Book encapsulates all of the GnuCash data, it is the place where 421 all GnuCash entities (Transaction, Split, Vendor, Invoice...), are 422 stored. You'll notice that all of the constructors for those entities 423 need a book to be associated with. 425 The most common way to get a book is through the book property in the 426 Session class, that is, create a session that connects to some storage, 427 such as through 'my_session = Session('file:my_books.xac')', and access 428 the book via the book property, 'my_session.book' 430 If you would like to create a Book without any backing storage, call the 431 Book constructor without any parameters, 'Book()'. You can later merge 432 such a book into a book with actual store by using merge_init. 435 get_root_account -- Returns the root level Account 436 get_table -- Returns a commodity lookup table, of type GncCommodityTable 438 def InvoiceLookup(self, guid):
439 from gnucash.gnucash_business
import Invoice
441 gncInvoiceLookup, Invoice, guid.get_instance() )
443 def EntryLookup(self, guid):
444 from gnucash.gnucash_business
import Entry
446 gncEntryLookup, Entry, guid.get_instance() )
448 def CustomerLookup(self, guid):
449 from gnucash.gnucash_business
import Customer
451 gncCustomerLookup, Customer, guid.get_instance())
453 def JobLookup(self, guid):
454 from gnucash.gnucash_business
import Job
456 gncJobLookup, Job, guid.get_instance() )
458 def VendorLookup(self, guid):
459 from gnucash.gnucash_business
import Vendor
461 gncVendorLookup, Vendor, guid.get_instance() )
463 def EmployeeLookup(self, guid):
464 from gnucash.gnucash_business
import Employee
466 gncEmployeeLookup, Employee, guid.get_instance() )
468 def TaxTableLookup(self, guid):
469 from gnucash.gnucash_business
import TaxTable
471 gncTaxTableLookup, TaxTable, guid.get_instance() )
473 def TaxTableLookupByName(self, name):
474 from gnucash.gnucash_business
import TaxTable
476 gncTaxTableLookupByName, TaxTable, name)
478 def TaxTableGetTables(self):
479 from gnucash.gnucash_business
import TaxTable
480 return [ TaxTable(instance=item)
for item
in gncTaxTableGetTables(self.instance) ]
482 def BillLookupByID(self, id):
483 from gnucash.gnucash_business
import Bill
485 gnc_search_bill_on_id, Bill, id)
487 def InvoiceLookupByID(self, id):
488 from gnucash.gnucash_business
import Invoice
490 gnc_search_invoice_on_id, Invoice, id)
492 def CustomerLookupByID(self, id):
493 from gnucash.gnucash_business
import Customer
495 gnc_search_customer_on_id, Customer, id)
497 def VendorLookupByID(self, id):
498 from gnucash.gnucash_business
import Vendor
500 gnc_search_vendor_on_id, Vendor, id)
503 ''' Return the next invoice ID. 505 from gnucash.gnucash_core_c
import gncInvoiceNextID
506 return gncInvoiceNextID(self.get_instance(),customer.GetEndOwner().get_instance()[1])
509 ''' Return the next Bill ID. ''' 510 from gnucash.gnucash_core_c
import gncInvoiceNextID
511 return gncInvoiceNextID(self.get_instance(),vendor.GetEndOwner().get_instance()[1])
514 ''' Return the next Customer ID. ''' 515 from gnucash.gnucash_core_c
import gncCustomerNextID
516 return gncCustomerNextID(self.get_instance())
519 ''' Return the next Vendor ID. ''' 520 from gnucash.gnucash_core_c
import gncVendorNextID
521 return gncVendorNextID(self.get_instance())
524 """Object used by GnuCash to store all numbers. Always consists of a 525 numerator and denominator. 527 The constants GNC_DENOM_AUTO, 528 GNC_HOW_RND_FLOOR, GNC_HOW_RND_CEIL, GNC_HOW_RND_TRUNC, 529 GNC_HOW_RND_PROMOTE, GNC_HOW_RND_ROUND_HALF_DOWN, 530 GNC_HOW_RND_ROUND_HALF_UP, GNC_HOW_RND_ROUND, GNC_HOW_RND_NEVER, 531 GNC_HOW_DENOM_EXACT, GNC_HOW_DENOM_REDUCE, GNC_HOW_DENOM_LCD, 532 and GNC_HOW_DENOM_FIXED are available for arithmetic 533 functions like GncNumeric.add 535 Look at gnc-numeric.h to see how to use these 539 """Constructor that supports the following formats: 540 * No arguments defaulting to zero: eg. GncNumeric() == 0/1 541 * A integer: e.g. GncNumeric(1) == 1/1 542 * Numerator and denominator intager pair: eg. GncNumeric(1, 2) == 1/2 543 * A floating point number: e.g. GncNumeric(0.5) == 1/2 544 * A floating point number with defined conversion: e.g. 545 GncNumeric(0.5, GNC_DENOM_AUTO, 546 GNC_HOW_DENOM_FIXED | GNC_HOW_RND_NEVER) == 1/2 547 * A string: e.g. GncNumeric("1/2") == 1/2 549 if 'instance' not in kargs:
550 kargs[
'instance'] = GncNumeric.__args_to_instance(args)
551 GnuCashCoreClass.__init__(self, [], **kargs)
554 def __args_to_instance(args):
556 return gnc_numeric_zero()
559 if isinstance(arg, int):
560 return gnc_numeric_create(arg, 1)
561 elif isinstance(arg, float):
563 elif isinstance(arg, str):
566 raise TypeError(
'Failed to convert to GncNumeric: ' + str(args))
568 elif isinstance(arg, GncNumeric):
571 raise TypeError(
'Only single int/float/str/GncNumeric allowed: ' + str(args))
573 if isinstance(args[0], int)
and isinstance(args[1], int):
574 return gnc_numeric_create(*args)
576 raise TypeError(
'Only two ints allowed: ' + str(args))
578 if isinstance(args[0], float) \
579 and isinstance(args[1], int) \
580 and type(args[2]) == type(GNC_HOW_DENOM_FIXED):
583 raise TypeError(
'Only (float, int, GNC_HOW_RND_*) allowed: ' + str(args))
585 raise TypeError(
'Required single int/float/str or two ints: ' + str(args))
590 def _operator_fallbacks(monomorphic_operator, fallback_operator):
591 """fallbacks are not needed except for method name, 592 keep for possible later use""" 594 if isinstance(b, GncNumeric):
595 return monomorphic_operator(a, b)
596 if isinstance(b, (int, float)):
599 return NotImplemented
600 forward.__name__ =
'__' + fallback_operator.__name__ +
'__' 601 forward.__doc__ = monomorphic_operator.__doc__
604 if isinstance(a, (GncNumeric, int, float)):
607 return NotImplemented
608 reverse.__name__ =
'__r' + fallback_operator.__name__ +
'__' 609 reverse.__doc__ = monomorphic_operator.__doc__
611 return forward, reverse
614 return a.add(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
617 return a.sub(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
620 return a.mul(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
623 return a.div(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
626 return a.div(b, 1, GNC_HOW_RND_TRUNC)
628 __add__, __radd__ = _operator_fallbacks(_add, operator.add)
630 __sub__, __rsub__ = _operator_fallbacks(_sub, operator.sub)
632 __mul__, __rmul__ = _operator_fallbacks(_mul, operator.mul)
634 __truediv__, __rtruediv__ = _operator_fallbacks(_div, operator.truediv)
635 __itruediv__ = __truediv__
636 __floordiv__, __rfloordiv__ = _operator_fallbacks(_floordiv, operator.floordiv)
637 __ifloordiv__ = __floordiv__
641 return a.compare(b) == -1
644 return a.compare(b) == 1
647 return a.compare(b)
in (0,-1)
650 return a.compare(b)
in (0,1)
653 return a.compare(b) == 0
655 def _richcmp(self, other, op):
656 """Helper for comparison operators, for internal use only. 657 Implement comparison between a GncNumeric instance `self`, 658 and either another GncNumeric instance, an int or a float 659 `other`. If `other` is not an instance of that kind, return 660 NotImplemented. `op` should be one of the six standard 661 comparison operators. The comparisons are based on 662 GncNumeric.compare(). 665 if isinstance(other, GncNumeric):
667 elif isinstance(other, (int, float)):
670 return NotImplemented
674 return a._richcmp(b, a._lt)
678 return a._richcmp(b, a._gt)
682 return a._richcmp(b, a._le)
686 return a._richcmp(b, a._ge)
690 return a._richcmp(b, a._eq)
697 return self.to_double()
700 return int(self.to_double())
714 def to_fraction(self):
715 from fractions
import Fraction
716 return Fraction(self.num(), self.denom())
719 """Returns a human readable numeric value string as UTF8.""" 724 Each priceEach price in the database represents an "instantaneous" 725 quote for a given commodity with respect to another commodity. 726 For example, a given price might represent the value of LNUX in USD on 2001-02-03. 729 * commodity: the item being priced. 730 * currency: the denomination of the value of the item being priced. 731 * value: the value of the item being priced. 732 * time: the time the price was valid. 733 * source: a string describing the source of the quote. These strings will be something like this: 734 "Finance::Quote", "user:misc", "user:foo", etc. If the quote came from a user, as a matter of policy, 735 you *must* prefix the string you give with "user:". For now, the only other reserved values are 736 "Finance::Quote" and "old-file-import". Any string used must be added to the source_list array in 737 dialog-price-edit-db.c so that it can be properly translated. (There are unfortunately many strings 738 in users' databases, so this string must be translated on output instead of always being used in untranslated form). 739 * type: the type of quote - types possible right now are bid, ask, last, nav, and 740 unknown.Each price in the database represents an "instantaneous" quote for a given 741 commodity with respect to another commodity. 742 For example, a given price might represent the value of LNUX in USD on 2001-02-03. 744 See also https://code.gnucash.org/docs/head/group__Price.html 746 _new_instance =
'gnc_price_create' 747 GncPrice.add_methods_with_prefix(
'gnc_price_')
752 a simple price database for gnucash. 753 The PriceDB is intended to be a database of price quotes, or more specifically, 754 a database of GNCPrices. For the time being, it is still a fairly simple 755 database supporting only fairly simple queries. It is expected that new 756 queries will be added as needed, and that there is some advantage to delaying 757 complex queries for now in the hope that we get a real DB implementation 758 before they're really needed. 760 Every QofBook contains a GNCPriceDB, accessible via gnc_pricedb_get_db. 762 Definition in file gnc-pricedb.h. 763 See also https://code.gnucash.org/docs/head/gnc-pricedb_8h.html 766 @deprecated(
"Use gnc_pricedb_latest_before_t64")
767 def gnc_pricedb_lookup_latest_before_t64(self, commodity, currency, date):
768 return self.lookup_nearest_before_t64(commodity, currency, date)
770 GncPriceDB.add_method(
'gnc_pricedb_lookup_latest_before_t64',
'lookup_latest_before_t64')
772 GncPriceDB.lookup_latest_before_t64 = method_function_returns_instance(GncPriceDB.lookup_latest_before_t64, GncPrice)
774 GncPriceDB.add_methods_with_prefix(
'gnc_pricedb_')
776 'lookup_latest' : GncPrice,
777 'lookup_nearest_in_time64' : GncPrice,
778 'lookup_nearest_before_t64' : GncPrice,
779 'convert_balance_latest_price' : GncNumeric,
780 'convert_balance_nearest_price_t64' : GncNumeric,
782 methods_return_instance(GncPriceDB,PriceDB_dict)
783 GncPriceDB.get_prices = method_function_returns_instance_list(
784 GncPriceDB.get_prices, GncPrice )
789 """A CommodityTable provides a way to store and lookup commodities. 790 Commodities are primarily currencies, but other tradable things such as 791 stocks, mutual funds, and material substances are possible. 793 Users of this library should not create their own CommodityTable, instead 794 the get_table method from the Book class should be used. 796 This table is automatically populated with the GnuCash default commodity's 797 which includes most of the world's currencies. 800 def _get_namespaces_py(self):
801 return [ns.get_name()
for ns
in self.get_namespaces_list()]
806 class GncLot(GnuCashCoreClass):
807 def GetInvoiceFromLot(self):
808 from gnucash.gnucash_business
import Invoice
809 return self.do_lookup_create_oo_instance(
810 gncInvoiceGetInvoiceFromLot, Invoice )
813 """A GnuCash Transaction 815 Consists of at least one (generally two) splits to represent a transaction 816 between two accounts. 819 Has a GetImbalance() method that returns a list of all the imbalanced 820 currencies. Each list item is a two element tuple, the first element is 821 the imbalanced commodity, the second element is the value. 823 Warning, the commodity.get_instance() value can be None when there 824 is no currency set for the transaction. 826 _new_instance =
'xaccMallocTransaction' 827 def GetNthSplit(self, n):
828 return self.GetSplitList().pop(n)
830 def GetInvoiceFromTxn(self):
831 from gnucash.gnucash_business
import Transaction
833 gncInvoiceGetInvoiceFromTxn, Transaction )
835 def __eq__(self, other):
836 return self.Equal(other,
True,
False,
False,
False)
838 def decorate_monetary_list_returning_function(orig_function):
839 def new_function(self, *args):
840 """decorate function that returns list of gnc_monetary to return tuples of GncCommodity and GncNumeric 843 *args: Variable length argument list. Will get passed to orig_function 846 array of tuples: (GncCommodity, GncNumeric) 849 Maybe this function should better reside in module function_class (?)""" 854 for item
in orig_function(self, *args) ]
860 The most basic representation of a movement of currency from one account to 863 _new_instance =
'xaccMallocSplit' 865 def __eq__(self, other):
866 return self.Equal(other,
True,
False,
False)
869 """A GnuCash Account. 871 A fundamental entity in accounting, an Account provides representation 872 for a financial object, such as a ACCT_TYPE_BANK account, an 873 ACCT_TYPE_ASSET (like a building), 874 a ACCT_TYPE_LIABILITY (such as a bank loan), a summary of some type of 875 ACCT_TYPE_EXPENSE, or a summary of some source of ACCT_TYPE_INCOME . 877 The words in upper case are the constants that GnuCash and this library uses 878 to describe account type. Here is the full list: 879 ACCT_TYPE_ASSET, ACCT_TYPE_BANK, ACCT_TYPE_CASH, ACCT_TYPE_CHECKING, \ 880 ACCT_TYPE_CREDIT, ACCT_TYPE_EQUITY, ACCT_TYPE_EXPENSE, ACCT_TYPE_INCOME, \ 881 ACCT_TYPE_LIABILITY, ACCT_TYPE_MUTUAL, ACCT_TYPE_PAYABLE, \ 882 ACCT_TYPE_RECEIVABLE, ACCT_TYPE_STOCK, ACCT_TYPE_ROOT, ACCT_TYPE_TRADING 884 These are not strings, they are attributes you can import from this 887 _new_instance =
'xaccMallocAccount' 890 _new_instance =
'guid_new_return' 893 Session.add_constructor_and_methods_with_prefix(
'qof_session_',
'new')
895 def one_arg_default_none(function):
896 return default_arguments_decorator(function,
None,
None)
897 Session.decorate_functions(one_arg_default_none,
"load",
"save")
899 Session.decorate_functions( Session.raise_backend_errors_after_call,
900 "begin",
"load",
"save",
"end")
901 Session.decorate_method(default_arguments_decorator,
"begin",
None, mode=SessionOpenMode.SESSION_NORMAL_OPEN)
902 Session.decorate_functions(deprecated_args_session_begin,
"begin")
904 Session.get_book = method_function_returns_instance(
905 Session.get_book, Book )
907 Session.book = property( Session.get_book )
910 this_module_dict = globals()
911 for error_name, error_value, error_name_after_prefix
in \
912 extract_attributes_with_prefix(gnucash_core_c,
'ERR_'):
913 this_module_dict[ error_name ] = error_value
916 backend_error_dict = {}
917 for error_name, error_value, error_name_after_prefix
in \
918 extract_attributes_with_prefix(gnucash_core_c,
'ERR_'):
919 backend_error_dict[ error_value ] = error_name
923 from gnucash.gnucash_core_c
import GNC_DENOM_AUTO
927 from gnucash.gnucash_core_c
import \
928 GNC_HOW_RND_FLOOR, GNC_HOW_RND_CEIL, GNC_HOW_RND_TRUNC, \
929 GNC_HOW_RND_PROMOTE, GNC_HOW_RND_ROUND_HALF_DOWN, \
930 GNC_HOW_RND_ROUND_HALF_UP, GNC_HOW_RND_ROUND, GNC_HOW_RND_NEVER
934 from gnucash.gnucash_core_c
import \
935 GNC_HOW_DENOM_EXACT, GNC_HOW_DENOM_REDUCE, GNC_HOW_DENOM_LCD, \
936 GNC_HOW_DENOM_FIXED, GNC_HOW_DENOM_SIGFIG
939 from gnucash.gnucash_core_c
import \
940 ACCT_TYPE_ASSET, ACCT_TYPE_BANK, ACCT_TYPE_CASH, ACCT_TYPE_CHECKING, \
941 ACCT_TYPE_CREDIT, ACCT_TYPE_EQUITY, ACCT_TYPE_EXPENSE, ACCT_TYPE_INCOME, \
942 ACCT_TYPE_LIABILITY, ACCT_TYPE_MUTUAL, ACCT_TYPE_PAYABLE, \
943 ACCT_TYPE_RECEIVABLE, ACCT_TYPE_STOCK, ACCT_TYPE_ROOT, ACCT_TYPE_TRADING
946 Book.add_constructor_and_methods_with_prefix(
'qof_book_',
'new')
947 Book.add_method(
'gnc_book_get_root_account',
'get_root_account')
948 Book.add_method(
'gnc_book_set_root_account',
'set_root_account')
949 Book.add_method(
'gnc_commodity_table_get_table',
'get_table')
950 Book.add_method(
'gnc_pricedb_get_db',
'get_price_db')
951 Book.add_method(
'qof_book_increment_and_format_counter',
'increment_and_format_counter')
954 Book.get_root_account = method_function_returns_instance(
955 Book.get_root_account, Account )
957 Book.get_table = method_function_returns_instance(
958 Book.get_table, GncCommodityTable )
960 Book.get_price_db = method_function_returns_instance(
961 Book.get_price_db, GncPriceDB)
964 GncNumeric.add_constructor_and_methods_with_prefix(
'gnc_numeric_',
'create')
974 'add_fixed' : GncNumeric,
975 'sub_fixed' : GncNumeric,
976 'convert' : GncNumeric,
977 'reduce' : GncNumeric,
978 'invert' : GncNumeric
980 methods_return_instance(GncNumeric, gncnumeric_dict)
983 GncCommodity.add_constructor_and_methods_with_prefix(
'gnc_commodity_',
'new')
985 GncCommodity.clone = method_function_returns_instance(
986 GncCommodity.clone, GncCommodity )
989 GncCommodityTable.add_methods_with_prefix(
'gnc_commodity_table_')
990 commoditytable_dict = {
991 'lookup' : GncCommodity,
992 'lookup_unique' : GncCommodity,
993 'find_full' : GncCommodity,
994 'insert' : GncCommodity,
995 'add_namespace': GncCommodityNamespace,
996 'find_namespace': GncCommodityNamespace,
998 methods_return_instance(GncCommodityTable, commoditytable_dict)
1000 methods_return_instance_lists(
1001 GncCommodityTable, {
'get_namespaces_list': GncCommodityNamespace,
1002 'get_commodities': GncCommodity,
1003 'get_quotable_commodities': GncCommodity,
1006 setattr(GncCommodityTable,
'get_namespaces', getattr(GncCommodityTable,
'_get_namespaces_py'))
1009 GncCommodityNamespace.add_methods_with_prefix(
'gnc_commodity_namespace_')
1010 GncCommodityNamespace.get_commodity_list = \
1011 method_function_returns_instance_list(
1012 GncCommodityNamespace.get_commodity_list, GncCommodity )
1015 GncLot.add_constructor_and_methods_with_prefix(
'gnc_lot_',
'new')
1018 'get_account' : Account,
1020 'get_earliest_split' : Split,
1021 'get_latest_split' : Split,
1022 'get_balance' : GncNumeric,
1024 'make_default' : GncLot
1026 methods_return_instance(GncLot, gnclot_dict)
1029 Transaction.add_methods_with_prefix(
'xaccTrans')
1030 Transaction.add_method(
'gncTransGetGUID',
'GetGUID')
1032 Transaction.add_method(
'xaccTransGetDescription',
'GetDescription')
1033 Transaction.add_method(
'xaccTransDestroy',
'Destroy')
1037 'FindSplitByAccount': Split,
1038 'Clone': Transaction,
1039 'Reverse': Transaction,
1040 'GetReversedBy': Transaction,
1041 'GetImbalanceValue': GncNumeric,
1042 'GetAccountValue': GncNumeric,
1043 'GetAccountAmount': GncNumeric,
1044 'GetAccountConvRate': GncNumeric,
1045 'GetAccountBalance': GncNumeric,
1046 'GetCurrency': GncCommodity,
1050 methods_return_instance(Transaction, trans_dict)
1051 methods_return_instance_lists(
1052 Transaction, {
'GetSplitList': Split,
1054 Transaction.decorate_functions(
1055 decorate_monetary_list_returning_function,
'GetImbalance')
1058 Split.add_methods_with_prefix(
'xaccSplit')
1059 Split.add_method(
'gncSplitGetGUID',
'GetGUID')
1060 Split.add_method(
'xaccSplitDestroy',
'Destroy')
1064 'GetAccount': Account,
1065 'GetParent': Transaction,
1067 'GetOtherSplit': Split,
1068 'GetAmount': GncNumeric,
1069 'GetValue': GncNumeric,
1070 'GetSharePrice': GncNumeric,
1071 'ConvertAmount': GncNumeric,
1072 'GetBaseValue': GncNumeric,
1073 'GetBalance': GncNumeric,
1074 'GetClearedBalance': GncNumeric,
1075 'GetReconciledBalance': GncNumeric,
1076 'VoidFormerAmount': GncNumeric,
1077 'VoidFormerValue': GncNumeric,
1080 methods_return_instance(Split, split_dict)
1082 Split.account = property( Split.GetAccount, Split.SetAccount )
1083 Split.parent = property( Split.GetParent, Split.SetParent )
1086 Account.add_methods_with_prefix(
'xaccAccount')
1087 Account.add_methods_with_prefix(
'gnc_account_')
1088 Account.add_method(
'gncAccountGetGUID',
'GetGUID')
1089 Account.add_method(
'xaccAccountGetPlaceholder',
'GetPlaceholder')
1094 'get_parent' : Account,
1095 'get_root' : Account,
1096 'nth_child' : Account,
1097 'lookup_by_code' : Account,
1098 'lookup_by_name' : Account,
1099 'lookup_by_full_name' : Account,
1100 'FindTransByDesc' : Transaction,
1101 'FindSplitByDesc' : Split,
1102 'GetBalance' : GncNumeric,
1103 'GetClearedBalance' : GncNumeric,
1104 'GetReconciledBalance' : GncNumeric,
1105 'GetPresentBalance' : GncNumeric,
1106 'GetProjectedMinimumBalance' : GncNumeric,
1107 'GetBalanceAsOfDate' : GncNumeric,
1108 'ConvertBalanceToCurrency' : GncNumeric,
1109 'ConvertBalanceToCurrencyAsOfDate' : GncNumeric,
1110 'GetBalanceInCurrency' : GncNumeric,
1111 'GetClearedBalanceInCurrency' : GncNumeric,
1112 'GetReconciledBalanceInCurrency' : GncNumeric,
1113 'GetPresentBalanceInCurrency' : GncNumeric,
1114 'GetProjectedMinimumBalanceInCurrency' : GncNumeric,
1115 'GetBalanceAsOfDateInCurrency' : GncNumeric,
1116 'GetBalanceChangeForPeriod' : GncNumeric,
1117 'GetCommodity' : GncCommodity,
1120 methods_return_instance(Account, account_dict)
1121 methods_return_instance_lists(
1122 Account, {
'GetSplitList': Split,
1123 'get_children': Account,
1124 'get_children_sorted': Account,
1125 'get_descendants': Account,
1126 'get_descendants_sorted': Account
1128 Account.name = property( Account.GetName, Account.SetName )
1131 GUID.add_methods_with_prefix(
'guid_')
1132 GUID.add_method(
'xaccAccountLookup',
'AccountLookup')
1133 GUID.add_method(
'xaccTransLookup',
'TransLookup')
1134 GUID.add_method(
'xaccSplitLookup',
'SplitLookup')
1137 GUID.add_method(
'guid_to_string',
'to_string')
1142 'TransLookup': Transaction,
1143 'AccountLookup': Account,
1144 'SplitLookup': Split
1146 methods_return_instance(GUID, guid_dict)
1152 GUIDString.add_constructor_and_methods_with_prefix(
'string_',
'to_guid')
1155 from gnucash.gnucash_core_c
import \
1162 from gnucash.gnucash_core_c
import \
1163 QOF_STRING_MATCH_NORMAL, \
1164 QOF_STRING_MATCH_CASEINSENSITIVE
1166 from gnucash.gnucash_core_c
import \
1169 QOF_COMPARE_EQUAL, \
1173 QOF_COMPARE_CONTAINS, \
1174 QOF_COMPARE_NCONTAINS
1176 from gnucash.gnucash_core_c
import \
1177 QOF_DATE_MATCH_NORMAL, \
1180 from gnucash.gnucash_core_c
import \
1181 QOF_NUMERIC_MATCH_DEBIT, \
1182 QOF_NUMERIC_MATCH_CREDIT, \
1183 QOF_NUMERIC_MATCH_ANY
1185 from gnucash.gnucash_core_c
import \
1186 QOF_GUID_MATCH_ANY, \
1187 QOF_GUID_MATCH_NONE, \
1188 QOF_GUID_MATCH_NULL, \
1189 QOF_GUID_MATCH_ALL, \
1190 QOF_GUID_MATCH_LIST_ANY
1192 from gnucash.gnucash_core_c
import \
1193 QOF_CHAR_MATCH_ANY, \
1196 from gnucash.gnucash_core_c
import \
1199 from gnucash.gnucash_core_c
import \
1205 """Set search_for to obj_type 1207 calls qof_query_search_for. Buffers search string for queries lifetime. 1208 @see https://bugs.gnucash.org/show_bug.cgi?id=796137""" 1212 Query.add_constructor_and_methods_with_prefix(
'qof_query_',
'create', exclude=[
"qof_query_search_for"])
1214 Query.add_method(
'qof_query_set_book',
'set_book')
1215 Query.add_method(
'qof_query_search_for',
'_search_for')
1216 Query.add_method(
'qof_query_run',
'run')
1217 Query.add_method(
'qof_query_add_term',
'add_term')
1218 Query.add_method(
'qof_query_add_boolean_match',
'add_boolean_match')
1219 Query.add_method(
'qof_query_add_guid_list_match',
'add_guid_list_match')
1220 Query.add_method(
'qof_query_add_guid_match',
'add_guid_match')
1221 Query.add_method(
'qof_query_destroy',
'destroy')
1226 QueryStringPredicate.add_constructor_and_methods_with_prefix(
1227 'qof_query_',
'string_predicate')
1232 QueryBooleanPredicate.add_constructor_and_methods_with_prefix(
1233 'qof_query_',
'boolean_predicate')
1238 QueryInt32Predicate.add_constructor_and_methods_with_prefix(
1239 'qof_query_',
'int32_predicate')
1244 QueryDatePredicate.add_constructor_and_methods_with_prefix(
1245 'qof_query_',
'date_predicate', exclude=[
"qof_query_date_predicate_get_date"])
1246 QueryDatePredicate.add_method(
'qof_query_date_predicate_get_date',
'get_date')
1251 QueryGuidPredicate.add_constructor_and_methods_with_prefix(
1252 'qof_query_',
'guid_predicate')
1257 QueryNumericPredicate.add_constructor_and_methods_with_prefix(
1258 'qof_query_',
'numeric_predicate')
gnc_numeric double_to_gnc_numeric(double in, gint64 denom, gint how)
Convert a floating-point number to a gnc_numeric.
def search_for(self, obj_type)
def raise_backend_errors_after_call(function, args, kwargs)
gchar * gnc_numeric_to_string(gnc_numeric n)
Convert to string.
def BillNextID(self, vendor)
def raise_backend_errors(self, called_function="qof_session function")
def do_lookup_create_oo_instance(self, lookup_function, cls, args)
def InvoiceNextID(self, customer)
def generate_errors(self)
def __init__(self, args, kargs)
gnc_numeric gnc_numeric_from_string(const gchar *str)
Read a gnc_numeric from str, skipping any leading whitespace.
def __init__(self, book_uri=None, mode=None, instance=None, book=None)
A convenient constructor that allows you to specify a book URI, begin the session, and load the book.
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.