accounting.storage package

Subpackages

• accounting.storage.sql package
  • Submodules
  • accounting.storage.sql.models module
  • Module contents

Submodules

accounting.storage.ledgercli module

class accounting.storage.ledgercli.Ledger(app=None, ledger_file=None, ledger_bin=None)

Bases: accounting.storage.Storage

add_transaction(transaction)

Writes a transaction to the ledger file by opening it in ‘ab’ mode and writing a ledger transaction based on the Transaction instance in transaction.

assemble_arguments()

Returns a list of arguments suitable for subprocess.Popen based on self.ledger_bin and self.ledger_file.

bal()

delete_transaction(transaction_id)

Delete a transaction from the ledger file.

This method opens the ledger file, loads all lines into memory and looks for the transaction_id, then looks for the bounds of that transaction in the ledger file, removes all lines within the bounds of the transaction and removes them, then writes the lines back to the ledger file.

Exceptions:

• RuntimeError: If all boundaries to the transaction are not found
• TransactionNotFound: If no such transaction_id can be found in self.ledger_file

get_process()

Returns self.ledger_process if it evaluates to True. If self.ledger_process is not set the result of self.init_process() is returned.

get_transaction(transaction_id)

get_transactions()

init_process()

Creates a new (presumably) ledger subprocess based on the args from Ledger.assemble_arguments() and then runs Ledger.read_until_prompt() once (which should return the banner text) and discards the output.

locked_process()

Context manager that checks that the ledger process is not already locked, then “locks” the process and yields the process handle and unlocks the process when execution is returned.

Since this decorated as a contextlib.contextmanager() the recommended use is with the with-statement.

with self.locked_process() as p:
    p.stdin.write(b'bal\n')

    output = self.read_until_prompt(p)

read_until_prompt(process)

Reads from the subprocess instance process until it finds a combination of \n]\x20 (the prompt), then returns the output without the prompt.

reg()

send_command(command)

update_transaction(transaction)

Update a transaction in the ledger file.

Takes a Transaction object and removes the old transaction using transaction.id from the passed Transaction instance and adds transaction to the database.

accounting.storage.ledgercli.main(argv=None)

Module contents

class accounting.storage.Storage(*args, **kw)

Bases: builtins.object

ABC for accounting storage

add_transaction(transaction)

delete_transaction(transaction_id)

get_account(*args, **kw)

get_accounts(*args, **kw)

get_transaction(*args, **kw)

get_transactions(*args, **kw)

reverse_transaction(transaction_id)

update_transaction(transaction)

exception accounting.storage.TransactionNotFound

Bases: accounting.exceptions.AccountingException