python.gnucash_core.GncNumeric Class Reference

Inheritance diagram for python.gnucash_core.GncNumeric:

Public Member Functions
	__init__ (self, *args, **kargs)
	__lt__ (a, b)
	__gt__ (a, b)
	__le__ (a, b)
	__ge__ (a, b)
	__eq__ (a, b)
	__bool__ (a)
	__float__ (self)
	__int__ (self)
	__pos__ (a)
	__neg__ (a)
	__abs__ (a)
	to_fraction (self)
	__str__ (self)
Public Member Functions inherited from python.gnucash_core.GnuCashCoreClass
	do_lookup_create_oo_instance (self, lookup_function, cls, *args)

Data Fields
	instance

Protected Member Functions
	_operator_fallbacks (monomorphic_operator, fallback_operator)
	_add (a, b)
	_sub (a, b)
	_mul (a, b)
	_div (a, b)
	_floordiv (a, b)
	_lt (a, b)
	_gt (a, b)
	_le (a, b)
	_ge (a, b)
	_eq (a, b)
	_richcmp (self, other, op)

Additional Inherited Members
Static Protected Attributes inherited from python.gnucash_core.GnuCashCoreClass
	_module = gnucash_core_c

Detailed Description

Object used by GnuCash to store all numbers. Always consists of a
numerator and denominator.

The constants GNC_DENOM_AUTO,
GNC_HOW_RND_FLOOR, GNC_HOW_RND_CEIL, GNC_HOW_RND_TRUNC,
GNC_HOW_RND_PROMOTE, GNC_HOW_RND_ROUND_HALF_DOWN,
GNC_HOW_RND_ROUND_HALF_UP, GNC_HOW_RND_ROUND, GNC_HOW_RND_NEVER,
GNC_HOW_DENOM_EXACT, GNC_HOW_DENOM_REDUCE, GNC_HOW_DENOM_LCD,
and GNC_HOW_DENOM_FIXED are available for arithmetic
functions like GncNumeric.add

Look at gnc-numeric.h to see how to use these

Definition at line 518 of file gnucash_core.py.

Constructor & Destructor Documentation

__init__()

python.gnucash_core.GncNumeric.__init__	(		self,
		*	args,
		**	kargs
	)

Constructor that supports the following formats:
* No arguments defaulting to zero: eg. GncNumeric() == 0/1
* A integer: e.g. GncNumeric(1) == 1/1
* Numerator and denominator intager pair: eg. GncNumeric(1, 2) == 1/2
* A floating point number: e.g. GncNumeric(0.5) == 1/2
* A floating point number with defined conversion: e.g.
  GncNumeric(0.5, GNC_DENOM_AUTO,
            GNC_HOW_DENOM_FIXED | GNC_HOW_RND_NEVER) == 1/2
* A string: e.g. GncNumeric("1/2") == 1/2

Definition at line 533 of file gnucash_core.py.

    def __init__(self, *args, **kargs):
        """Constructor that supports the following formats:
        * No arguments defaulting to zero: eg. GncNumeric() == 0/1
        * A integer: e.g. GncNumeric(1) == 1/1
        * Numerator and denominator intager pair: eg. GncNumeric(1, 2) == 1/2
        * A floating point number: e.g. GncNumeric(0.5) == 1/2
        * A floating point number with defined conversion: e.g.
          GncNumeric(0.5, GNC_DENOM_AUTO,
                    GNC_HOW_DENOM_FIXED | GNC_HOW_RND_NEVER) == 1/2
        * A string: e.g. GncNumeric("1/2") == 1/2
        """
        if 'instance' not in kargs:
            kargs['instance'] = GncNumeric.__args_to_instance(args)
        GnuCashCoreClass.__init__(self, [], **kargs)
 

Member Function Documentation

__abs__()

python.gnucash_core.GncNumeric.__abs__

(

a

)

abs(a)

Definition at line 705 of file gnucash_core.py.

    def __abs__(a):
        """abs(a)"""
        return a.abs()
 

__bool__()

python.gnucash_core.GncNumeric.__bool__

(

a

)

a != 0

Definition at line 687 of file gnucash_core.py.

    def __bool__(a):
        """a != 0"""
        return bool(a.num())
 

__eq__()

python.gnucash_core.GncNumeric.__eq__	(		a,
			b
	)

a == b

Definition at line 683 of file gnucash_core.py.

    def __eq__(a, b):
        """a == b"""
        return a._richcmp(b, a._eq)
 

__float__()

python.gnucash_core.GncNumeric.__float__

(

self

)

Definition at line 691 of file gnucash_core.py.

    def __float__(self):
        return self.to_double()
 

__ge__()

python.gnucash_core.GncNumeric.__ge__	(		a,
			b
	)

a >= b

Definition at line 679 of file gnucash_core.py.

    def __ge__(a, b):
        """a >= b"""
        return a._richcmp(b, a._ge)
 

__gt__()

python.gnucash_core.GncNumeric.__gt__	(		a,
			b
	)

a > b

Definition at line 671 of file gnucash_core.py.

    def __gt__(a, b):
        """a > b"""
        return a._richcmp(b, a._gt)
 

__int__()

python.gnucash_core.GncNumeric.__int__

(

self

)

Definition at line 694 of file gnucash_core.py.

    def __int__(self):
        return int(self.to_double())
 

__le__()

python.gnucash_core.GncNumeric.__le__	(		a,
			b
	)

a <= b

Definition at line 675 of file gnucash_core.py.

    def __le__(a, b):
        """a <= b"""
        return a._richcmp(b, a._le)
 

__lt__()

python.gnucash_core.GncNumeric.__lt__	(		a,
			b
	)

a < b

Definition at line 667 of file gnucash_core.py.

    def __lt__(a, b):
        """a < b"""
        return a._richcmp(b, a._lt)
 

__neg__()

python.gnucash_core.GncNumeric.__neg__

(

a

)

-a

Definition at line 701 of file gnucash_core.py.

    def __neg__(a):
        """-a"""
        return a.neg()
 

__pos__()

python.gnucash_core.GncNumeric.__pos__

(

a

)

+a

Definition at line 697 of file gnucash_core.py.

    def __pos__(a):
        """+a"""
        return GncNumeric(a.num(), a.denom())
 

__str__()

python.gnucash_core.GncNumeric.__str__

(

self

)

Returns a human readable numeric value string as UTF8.

Definition at line 713 of file gnucash_core.py.

    def __str__(self):
        """Returns a human readable numeric value string as UTF8."""
        return gnc_numeric_to_string(self.instance)
 

_add()

python.gnucash_core.GncNumeric._add (   a,   b  )

protected

Definition at line 608 of file gnucash_core.py.

    def _add(a, b):
        return a.add(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
 

_div()

python.gnucash_core.GncNumeric._div (   a,   b  )

protected

Definition at line 617 of file gnucash_core.py.

    def _div(a, b):
        return a.div(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
 

_eq()

python.gnucash_core.GncNumeric._eq (   a,   b  )

protected

Definition at line 647 of file gnucash_core.py.

    def _eq(a, b):
        return a.compare(b) == 0
 

_floordiv()

python.gnucash_core.GncNumeric._floordiv (   a,   b  )

protected

Definition at line 620 of file gnucash_core.py.

    def _floordiv(a, b):
        return a.div(b, 1, GNC_HOW_RND_TRUNC)
 

_ge()

python.gnucash_core.GncNumeric._ge (   a,   b  )

protected

Definition at line 644 of file gnucash_core.py.

    def _ge(a, b):
        return a.compare(b) in (0,1)
 

_gt()

python.gnucash_core.GncNumeric._gt (   a,   b  )

protected

Definition at line 638 of file gnucash_core.py.

    def _gt(a, b):
        return a.compare(b) == 1
 

_le()

python.gnucash_core.GncNumeric._le (   a,   b  )

protected

Definition at line 641 of file gnucash_core.py.

    def _le(a, b):
        return a.compare(b) in (0,-1)
 

_lt()

python.gnucash_core.GncNumeric._lt (   a,   b  )

protected

Definition at line 635 of file gnucash_core.py.

    def _lt(a, b):
        return a.compare(b) == -1
 

_mul()

python.gnucash_core.GncNumeric._mul (   a,   b  )

protected

Definition at line 614 of file gnucash_core.py.

    def _mul(a, b):
        return a.mul(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
 

_operator_fallbacks()

python.gnucash_core.GncNumeric._operator_fallbacks (   monomorphic_operator,   fallback_operator  )

protected

fallbacks are not needed except for method name,
keep for possible later use

Definition at line 585 of file gnucash_core.py.

    def _operator_fallbacks(monomorphic_operator, fallback_operator):
        """fallbacks are not needed except for method name,
        keep for possible later use"""
        def forward(a, b):
            if isinstance(b, GncNumeric):
                return monomorphic_operator(a, b)
            if isinstance(b, (int, float)):
                return monomorphic_operator(a, GncNumeric(b))
            else:
                return NotImplemented
        forward.__name__ = '__' + fallback_operator.__name__ + '__'
        forward.__doc__ = monomorphic_operator.__doc__
 
        def reverse(b, a):
            if isinstance(a, (GncNumeric, int, float)):
                return forward(b, a)
            else:
                return NotImplemented
        reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
        reverse.__doc__ = monomorphic_operator.__doc__
 
        return forward, reverse
 

_richcmp()

python.gnucash_core.GncNumeric._richcmp (   self,   other,   op  )

protected

Helper for comparison operators, for internal use only.
Implement comparison between a GncNumeric instance `self`,
and either another GncNumeric instance, an int or a float
`other`.  If `other` is not an instance of that kind, return
NotImplemented. `op` should be one of the six standard
comparison operators. The comparisons are based on
GncNumeric.compare().

Definition at line 650 of file gnucash_core.py.

    def _richcmp(self, other, op):
        """Helper for comparison operators, for internal use only.
        Implement comparison between a GncNumeric instance `self`,
        and either another GncNumeric instance, an int or a float
        `other`.  If `other` is not an instance of that kind, return
        NotImplemented. `op` should be one of the six standard
        comparison operators. The comparisons are based on
        GncNumeric.compare().
        """
        import math
        if isinstance(other, GncNumeric):
            return op(other)
        elif isinstance(other, (int, float)):
            return op(GncNumeric(other))
        else:
            return NotImplemented
 

_sub()

python.gnucash_core.GncNumeric._sub (   a,   b  )

protected

Definition at line 611 of file gnucash_core.py.

    def _sub(a, b):
        return a.sub(b, GNC_DENOM_AUTO, GNC_HOW_RND_ROUND)
 

to_fraction()

python.gnucash_core.GncNumeric.to_fraction

(

self

)

Definition at line 709 of file gnucash_core.py.

    def to_fraction(self):
        from fractions import Fraction
        return Fraction(self.num(), self.denom())
 

Field Documentation

instance

python.gnucash_core.GncNumeric.instance

Definition at line 715 of file gnucash_core.py.

---

The documentation for this class was generated from the following file:

• gnucash_core.py