python-bindings::gnucash_core::Session Class Reference

Inheritance diagram for python-bindings::gnucash_core::Session:

Public Member Functions
def	__init__
def	raise_backend_errors
def	generate_errors
def	pop_all_errors
def	raise_backend_errors_after_call

---

Detailed Description

A GnuCash book editing session

To commit changes to the session you may need to call save,
(this is always the case with the file backend).

When you're down with a session you may need to call end()

Every Session has a Book in the book attribute, which you'll definitely
be interested in, as every GnuCash entity (Transaction, Split, Vendor,
Invoice..) is associated with a particular book where it is stored.

Definition at line 60 of file gnucash_core.py.

---

Constructor & Destructor Documentation

def python-bindings::gnucash_core::Session::__init__	(		self,
			book_uri = None,
			ignore_lock = False,
			is_new = False,
			force_new = False
	)

A convenient constructor that allows you to specify a book URI,
begin the session, and load the book.

This can give you the power of calling
qof_session_new, qof_session_begin, and qof_session_load all in one!

book_uri can be None to skip the calls to qof_session_begin and
qof_session_load, or it can be a string like "file:/test.xac"

qof_session_load is only called if is_new is set to False

is_new is passed to qof_session_begin as the argument create,
and force_new as the argument force. Is_new will create a new
database or file; force will force creation even if it will
destroy an existing dataset.

ignore_lock is passed to qof_session_begin's argument of the
same name and is used to break an existing lock on a dataset.



This function can raise a GnuCashBackendException. If it does,
you don't need to cleanup and call end() and destroy(), that is handled
for you, and the exception is raised.

Definition at line 73 of file gnucash_core.py.

                                  :
        """A convenient constructor that allows you to specify a book URI,
        begin the session, and load the book.

        This can give you the power of calling
        qof_session_new, qof_session_begin, and qof_session_load all in one!

        book_uri can be None to skip the calls to qof_session_begin and
        qof_session_load, or it can be a string like "file:/test.xac"

        qof_session_load is only called if is_new is set to False

        is_new is passed to qof_session_begin as the argument create,
        and force_new as the argument force. Is_new will create a new
        database or file; force will force creation even if it will
        destroy an existing dataset.

        ignore_lock is passed to qof_session_begin's argument of the
        same name and is used to break an existing lock on a dataset.



        This function can raise a GnuCashBackendException. If it does,
        you don't need to cleanup and call end() and destroy(), that is handled
        for you, and the exception is raised.
        """
        GnuCashCoreClass.__init__(self)
        if book_uri is not None:
            try:
                self.begin(book_uri, ignore_lock, is_new, force_new)
                if not is_new:
                    self.load()
            except GnuCashBackendException, backend_exception:
                self.end()
                self.destroy()
                raise

---

Member Function Documentation

def python-bindings::gnucash_core::Session::generate_errors

(

self

)

A generator that yields any outstanding QofBackend errors

Definition at line 124 of file gnucash_core.py.

                             :
        """A generator that yields any outstanding QofBackend errors
        """
        while self.get_error() is not ERR_BACKEND_NO_ERR:
            error = self.pop_error()
            yield error

def python-bindings::gnucash_core::Session::pop_all_errors

(

self

)

Returns any accumulated qof backend errors as a tuple

Definition at line 131 of file gnucash_core.py.

                            :
        """Returns any accumulated qof backend errors as a tuple
        """
        return tuple( self.generate_errors() )

def python-bindings::gnucash_core::Session::raise_backend_errors	(		self,
			called_function = "qof_session function"
	)

Raises a GnuCashBackendException if there are outstanding
QOF_BACKEND errors.

set called_function to name the function that was last called

Definition at line 111 of file gnucash_core.py.

                                                                          :
        """Raises a GnuCashBackendException if there are outstanding
        QOF_BACKEND errors.

        set called_function to name the function that was last called
        """
        errors = self.pop_all_errors()
        if errors != ():
            raise GnuCashBackendException(
                "call to %s resulted in the "
                "following errors, %s" % (called_function, backend_error_dict[errors[0]]),
                errors )

def python-bindings::gnucash_core::Session::raise_backend_errors_after_call

(

function

)

A function decorator that results in a call to
raise_backend_errors after execution.

Definition at line 138 of file gnucash_core.py.

                                                 :
        """A function decorator that results in a call to
        raise_backend_errors after execution.
        """
        def new_function(self, *args):
            return_value = function(self, *args)
            self.raise_backend_errors(function.__name__)
            return return_value
        return new_function

---

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

• gnucash_core.py