High level python wrapper classes for the core parts of GnuCash. More...

Data Structures
class	python.gnucash_core.GnuCashCoreClass

class	python.gnucash_core.GnuCashBackendException

class	python.gnucash_core.SessionOpenMode

class	python.gnucash_core.PriceSource

class	python.gnucash_core.Session

class	python.gnucash_core.Book

class	python.gnucash_core.GncNumeric

class	python.gnucash_core.GncPrice

class	python.gnucash_core.GncPriceDB

class	python.gnucash_core.GncCommodity

class	python.gnucash_core.GncCommodityTable

class	python.gnucash_core.GncCommodityNamespace

class	python.gnucash_core.GncLot

class	python.gnucash_core.Transaction

class	python.gnucash_core.Split

class	python.gnucash_core.Account

class	python.gnucash_core.GUID

class	python.gnucash_core.GUIDString

class	python.gnucash_core.Query

class	python.gnucash_core.QueryStringPredicate

class	python.gnucash_core.QueryBooleanPredicate

class	python.gnucash_core.QueryInt32Predicate

class	python.gnucash_core.QueryDatePredicate

class	python.gnucash_core.QueryGuidPredicate

class	python.gnucash_core.QueryNumericPredicate

Functions
	python.gnucash_core._ (s)

	python.gnucash_core._deprecated_set_source_string (self, source)

	python.gnucash_core.gnc_pricedb_lookup_latest_before_t64 (self, commodity, currency, date)

	python.gnucash_core.decorate_monetary_list_returning_function (orig_function)

	python.gnucash_core.one_arg_default_none (function)

Variables
	python.gnucash_core._localedir = _sw_core_utils.gnc_path_get_localedir()

	python.gnucash_core.exc_type

	python.gnucash_core.exc_value

	python.gnucash_core.exc_traceback

	python.gnucash_core._gnc_price_set_source_string = GncPrice.set_source_string

	python.gnucash_core.set_source_string

	python.gnucash_core.lookup_latest_before_t64

dict	python.gnucash_core.PriceDB_dict

	python.gnucash_core.None

	python.gnucash_core.mode

	python.gnucash_core.get_book

	python.gnucash_core.book

	python.gnucash_core.this_module_dict = globals()

dict	python.gnucash_core.backend_error_dict = {}

	python.gnucash_core.get_root_account

	python.gnucash_core.get_table

	python.gnucash_core.get_price_db

dict	python.gnucash_core.gncnumeric_dict

dict	python.gnucash_core.gnc_commodity_dict

dict	python.gnucash_core.gnc_price_dict

dict	python.gnucash_core.commoditytable_dict

	python.gnucash_core.get_commodity_list

dict	python.gnucash_core.gnclot_dict

dict	python.gnucash_core.trans_dict

dict	python.gnucash_core.split_dict

	python.gnucash_core.account

	python.gnucash_core.parent

dict	python.gnucash_core.account_dict

	python.gnucash_core.name

dict	python.gnucash_core.guid_dict
	define addition methods for GUID object - do we need these

Detailed Description

High level python wrapper classes for the core parts of GnuCash.

Author: Mark Jenkins, ParIT Worker Co-operative mark@.nosp@m.pari.nosp@m.t.ca; Jeff Green, ParIT Worker Co-operative jeff@.nosp@m.pari.nosp@m.t.ca

Definition in file gnucash_core.py.

Function Documentation

◆ _()

python.gnucash_core._ ( s )

protected

Null translator function, gettext not available

Definition at line 205 of file gnucash_core.py.

    def _(s):
        """Null translator function, gettext not available"""
        return s
 

◆ _deprecated_set_source_string()

python.gnucash_core._deprecated_set_source_string	(	self,
		source
	)

protected

Deprecated: use set_source() with a PriceSource member.

Still raises ValueError if `source` is not a recognized PriceSource string
(the underlying C setter would otherwise leave the source unchanged).

Definition at line 776 of file gnucash_core.py.

def _deprecated_set_source_string(self, source):
    """Deprecated: use set_source() with a PriceSource member.
 
    Still raises ValueError if `source` is not a recognized PriceSource string
    (the underlying C setter would otherwise leave the source unchanged)."""
    _gnc_price_set_source_string(self, source)
    if self.get_source_string() != source:
        raise ValueError(
            "%r is not a recognized price source string, so set_source_string() "
            "left the source unchanged. Use set_source() with a PriceSource "
            "member, e.g. set_source(PriceSource.FINANCE_QUOTE)." % (source,))
# Report the deprecation under the public method name, not the wrapper's.

◆ decorate_monetary_list_returning_function()

python.gnucash_core.decorate_monetary_list_returning_function ( orig_function )

Definition at line 893 of file gnucash_core.py.

def decorate_monetary_list_returning_function(orig_function):
    def new_function(self, *args):
        """decorate function that returns list of gnc_monetary to return tuples of GncCommodity and GncNumeric
 
        Args:
            *args: Variable length argument list. Will get passed to orig_function
 
        Returns:
            array of tuples: (GncCommodity, GncNumeric)
 
        ToDo:
            Maybe this function should better reside in module function_class (?)"""
        # warning, item.commodity has been shown to be None
        # when the transaction doesn't have a currency
        return [(GncCommodity(instance=item.commodity),
                 GncNumeric(instance=item.value))
                for item in orig_function(self, *args) ]
    return new_function
 

◆ gnc_pricedb_lookup_latest_before_t64()

python.gnucash_core.gnc_pricedb_lookup_latest_before_t64	(	self,
		commodity,
		currency,
		date
	)

Definition at line 812 of file gnucash_core.py.

def gnc_pricedb_lookup_latest_before_t64(self, commodity, currency, date):
    return self.lookup_nearest_before_t64(commodity, currency, date)
 

◆ one_arg_default_none()

python.gnucash_core.one_arg_default_none ( function )

Definition at line 950 of file gnucash_core.py.

950def one_arg_default_none(function):

951 return default_arguments_decorator(function, None, None)

Variable Documentation

◆ _gnc_price_set_source_string

python.gnucash_core._gnc_price_set_source_string = GncPrice.set_source_string

protected

Definition at line 775 of file gnucash_core.py.

◆ _localedir

python.gnucash_core._localedir = _sw_core_utils.gnc_path_get_localedir()

protected

Definition at line 194 of file gnucash_core.py.

◆ account

python.gnucash_core.account

Definition at line 1154 of file gnucash_core.py.

◆ account_dict

dict python.gnucash_core.account_dict

Initial value:

=   {
                    'get_book' : Book,
                    'Lookup' : Account,
                    'get_parent' : Account,
                    'get_root' : Account,
                    'nth_child' : Account,
                    'lookup_by_code' : Account,
                    'lookup_by_name' : Account,
                    'lookup_by_full_name' : Account,
                    'FindTransByDesc' : Transaction,
                    'FindSplitByDesc' : Split,
                    'GetBalance' : GncNumeric,
                    'GetClearedBalance' : GncNumeric,
                    'GetReconciledBalance' : GncNumeric,
                    'GetPresentBalance' : GncNumeric,
                    'GetProjectedMinimumBalance' : GncNumeric,
                    'GetBalanceAsOfDate' : GncNumeric,
                    'ConvertBalanceToCurrency' : GncNumeric,
                    'ConvertBalanceToCurrencyAsOfDate' : GncNumeric,
                    'GetBalanceInCurrency' : GncNumeric,
                    'GetClearedBalanceInCurrency' : GncNumeric,
                    'GetReconciledBalanceInCurrency' : GncNumeric,
                    'GetPresentBalanceInCurrency' : GncNumeric,
                    'GetProjectedMinimumBalanceInCurrency' : GncNumeric,
                    'GetBalanceAsOfDateInCurrency' : GncNumeric,
                    'GetBalanceChangeForPeriod' : GncNumeric,
                    'GetCommodity' : GncCommodity,
                    'get_currency_or_parent' : GncCommodity,
                    'GetGUID': GUID
                }

Definition at line 1163 of file gnucash_core.py.

◆ backend_error_dict

dict python.gnucash_core.backend_error_dict = {}

Definition at line 971 of file gnucash_core.py.

◆ book

python.gnucash_core.book

Definition at line 962 of file gnucash_core.py.

◆ commoditytable_dict

dict python.gnucash_core.commoditytable_dict

Initial value:

=    {
                            'lookup' : GncCommodity,
                            'lookup_unique' : GncCommodity,
                            'find_full' : GncCommodity,
                            'insert' : GncCommodity,
                            'add_namespace': GncCommodityNamespace,
                            'find_namespace': GncCommodityNamespace,
                        }

Definition at line 1057 of file gnucash_core.py.

◆ exc_traceback

python.gnucash_core.exc_traceback

Definition at line 201 of file gnucash_core.py.

◆ exc_type

python.gnucash_core.exc_type

Definition at line 201 of file gnucash_core.py.

◆ exc_value

python.gnucash_core.exc_value

Definition at line 201 of file gnucash_core.py.

◆ get_book

python.gnucash_core.get_book

Definition at line 959 of file gnucash_core.py.

◆ get_commodity_list

python.gnucash_core.get_commodity_list

Definition at line 1077 of file gnucash_core.py.

◆ get_price_db

python.gnucash_core.get_price_db

Definition at line 1015 of file gnucash_core.py.

◆ get_root_account

python.gnucash_core.get_root_account

Definition at line 1009 of file gnucash_core.py.

◆ get_table

python.gnucash_core.get_table

Definition at line 1012 of file gnucash_core.py.

◆ gnc_commodity_dict

dict python.gnucash_core.gnc_commodity_dict

Initial value:

=  {
                        'clone': GncCommodity,
                        'obtain_twin': GncCommodity,
                        'get_namespace_ds': GncCommodityNamespace,
                     }

Definition at line 1039 of file gnucash_core.py.

◆ gnc_price_dict

dict python.gnucash_core.gnc_price_dict

Initial value:

=  {
                    'get_commodity': GncCommodity,
                    'get_currency': GncCommodity,
                    'clone': GncPrice,
                    'get_value': GncNumeric,
                 }

Definition at line 1047 of file gnucash_core.py.

◆ gnclot_dict

dict python.gnucash_core.gnclot_dict

Initial value:

=    {
                    'get_account' : Account,
                    'get_book' : Book,
                    'get_earliest_split' : Split,
                    'get_latest_split' : Split,
                    'get_balance' : GncNumeric,
                    'lookup' : GncLot,
                    'make_default' : GncLot
                }

Definition at line 1084 of file gnucash_core.py.

◆ gncnumeric_dict

dict python.gnucash_core.gncnumeric_dict

Initial value:

=    {
                        'same' : GncNumeric,
                        'add' : GncNumeric,
                        'sub' : GncNumeric,
                        'mul' : GncNumeric,
                        'div' : GncNumeric,
                        'neg' : GncNumeric,
                        'abs' : GncNumeric,
                        'add_fixed' : GncNumeric,
                        'sub_fixed' : GncNumeric,
                        'convert' : GncNumeric,
                        'reduce' : GncNumeric,
                        'invert' : GncNumeric
                    }

Definition at line 1021 of file gnucash_core.py.

◆ guid_dict

dict python.gnucash_core.guid_dict

Initial value:

=  {
                'copy' : GUID,
                'TransLookup': Transaction,
                'AccountLookup': Account,
                'SplitLookup': Split
            }

define addition methods for GUID object - do we need these

Definition at line 1214 of file gnucash_core.py.

◆ lookup_latest_before_t64

python.gnucash_core.lookup_latest_before_t64

Definition at line 817 of file gnucash_core.py.

◆ mode

python.gnucash_core.mode

Definition at line 956 of file gnucash_core.py.

◆ name

python.gnucash_core.name

Definition at line 1202 of file gnucash_core.py.

◆ None

python.gnucash_core.None

Definition at line 956 of file gnucash_core.py.

◆ parent

python.gnucash_core.parent

Definition at line 1155 of file gnucash_core.py.

◆ PriceDB_dict

dict python.gnucash_core.PriceDB_dict

Initial value:

=   {
                'lookup_latest' : GncPrice,
                'lookup_nearest_in_time64' : GncPrice,
                'lookup_nearest_before_t64' : GncPrice,
                'nth_price' : GncPrice,
                'lookup_day_t64' : GncPrice,
                'convert_balance_latest_price' : GncNumeric,
                'convert_balance_nearest_price_t64' : GncNumeric,
                'convert_balance_nearest_before_price_t64' : GncNumeric,
                'get_latest_price' : GncNumeric,
                'get_nearest_price' : GncNumeric,
                'get_nearest_before_price' : GncNumeric,
                }

Definition at line 820 of file gnucash_core.py.

◆ set_source_string

python.gnucash_core.set_source_string

Definition at line 790 of file gnucash_core.py.

◆ split_dict

dict python.gnucash_core.split_dict

Initial value:

=     {
                    'GetBook': Book,
                    'GetAccount': Account,
                    'GetParent': Transaction,
                    'Lookup': Split,
                    'GetOtherSplit': Split,
                    'GetAmount': GncNumeric,
                    'GetValue': GncNumeric,
                    'GetSharePrice': GncNumeric,
                    'ConvertAmount': GncNumeric,
                    'GetBaseValue': GncNumeric,
                    'GetBalance': GncNumeric,
                    'GetClearedBalance': GncNumeric,
                    'GetReconciledBalance': GncNumeric,
                    'VoidFormerAmount': GncNumeric,
                    'VoidFormerValue': GncNumeric,
                    'GetNoclosingBalance': GncNumeric,
                    'GetCapGains': GncNumeric,
                    'GetGUID': GUID
                }

Definition at line 1132 of file gnucash_core.py.

◆ this_module_dict

python.gnucash_core.this_module_dict = globals()

Definition at line 965 of file gnucash_core.py.

◆ trans_dict

dict python.gnucash_core.trans_dict

Initial value:

=     {
                    'GetSplit': Split,
                    'FindSplitByAccount': Split,
                    'Clone': Transaction,
                    'Reverse': Transaction,
                    'GetReversedBy': Transaction,
                    'GetImbalanceValue': GncNumeric,
                    'GetAccountValue': GncNumeric,
                    'GetAccountAmount': GncNumeric,
                    'GetAccountConvRate': GncNumeric,
                    'GetAccountBalance': GncNumeric,
                    'GetCurrency': GncCommodity,
                    'GetGUID': GUID
                }

Definition at line 1105 of file gnucash_core.py.

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ _()

◆ _deprecated_set_source_string()

◆ decorate_monetary_list_returning_function()

◆ gnc_pricedb_lookup_latest_before_t64()

◆ one_arg_default_none()

Variable Documentation

◆ _gnc_price_set_source_string

◆ _localedir

◆ account

◆ account_dict

◆ backend_error_dict

◆ book

◆ commoditytable_dict

◆ exc_traceback

◆ exc_type

◆ exc_value

◆ get_book

◆ get_commodity_list

◆ get_price_db

◆ get_root_account

◆ get_table

◆ gnc_commodity_dict

◆ gnc_price_dict

◆ gnclot_dict

◆ gncnumeric_dict

◆ guid_dict

◆ lookup_latest_before_t64

◆ mode

◆ name

◆ None

◆ parent

◆ PriceDB_dict

◆ set_source_string

◆ split_dict

◆ this_module_dict

◆ trans_dict