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
Public Member Functions inherited from python-bindings.gnucash_core.GnuCashCoreClass
def	do_lookup_create_oo_instance

Static Public Member Functions
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 62 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 76 of file gnucash_core.py.

                 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.
        """
        GnuCashCoreClass.__init__(self)
        if book_uri is not None:
            try:
                self.begin(book_uri, ignore_lock, is_new, force_new)
                # Take care of backend inconsistency
                # New xml file can't be loaded, new sql store
                # has to be loaded before it can be altered
                # Any existing store obviously has to be loaded
                # More background: https://bugzilla.gnome.org/show_bug.cgi?id=726891
                if book_uri[:3] != "xml" or not is_new:
                    self.load()
            except GnuCashBackendException, backend_exception:
                self.end()
                self.destroy()
                raise