chainqueue

Blockchain transaction queue control
Log | Files | Refs | LICENSE

commit 70cbbcc7deedc40efe443b429ffa3238d3931d57
parent 1dd403b4a2839ca3a1647a19e2665689fdd96b01
Author: nolash <dev@holbrook.no>
Date:   Fri, 27 Aug 2021 11:10:21 +0200

Add docstring to cli outputter, register summary on individual tx adds

Diffstat:
Mchainqueue/cli.py | 42+++++++++++++++++++++++++++++++++++++++---
Mchainqueue/db/models/otx.py | 1+
Mscripts/migrate.py | 2+-
3 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/chainqueue/cli.py b/chainqueue/cli.py @@ -1,3 +1,6 @@ +# standard imports +import logging + # external imports from hexathon import add_0x @@ -10,8 +13,23 @@ from chainqueue.enum import ( status_str, ) +logg = logging.getLogger(__name__) + class Outputter: + """Output helper for chainqueue cli listings tools. + + :param chain_spec: Chain spec to use as getter context + :type chain_spec: chainlib.chain.ChainSpec + :param writer: Writer to write output to. Will automatically flush. + :type writer: Writer + :param getter: Transaction getter + :type getter: See chainqueue.sql.backend.get_otx + :param session_method: Backend session generator method + :type session_method: varies + :param decode_status: Print status bit details + :type decode_status: bool + """ def __init__(self, chain_spec, writer, getter, session_method=None, decode_status=True): self.decode_status = decode_status @@ -36,7 +54,15 @@ class Outputter: def add(self, tx_hash): - tx = tx_getter(self.chain_spec, tx_hash, session=self.session) + """Retrieve a transaction by hash and add it for summary output generation. + + :param tx_hash: Transaction hash + :type tx_hash: str + """ + tx = self.getter(self.chain_spec, tx_hash, session=self.session) + self.__add(tx) + + def __add(self, tx): category = None if is_alive(tx['status_code']): category = 'pending' @@ -44,20 +70,30 @@ class Outputter: category = 'final' self.results[category] += 1 if is_error_status(tx['status_code']): - logg.debug('registered {} as {} with error'.format(tx_hash, category)) + logg.debug('registered {} as {} with error'.format(tx['tx_hash'], category)) self.results[category + '_error'] += 1 else: - logg.debug('registered {} as {}'.format(tx_hash, category)) + logg.debug('registered {} as {}'.format(tx['tx_hash'], category)) def decode_summary(self): + """Writes summary to the registered writer. + """ self.writer.write('pending\t{}\t{}\n'.format(self.results['pending'], self.results['pending_error'])) self.writer.write('final\t{}\t{}\n'.format(self.results['final'], self.results['final_error'])) self.writer.write('total\t{}\t{}\n'.format(self.results['final'] + self.results['pending'], self.results['final_error'] + self.results['pending_error'])) def decode_single(self, tx_hash): + """Retrieves the transaction with the given hash and writes the details to the underlying writer. + + Registers the transaction with the summary generator. + + :param tx_hash: Transaction hash + :type tx_hash: str + """ tx = self.getter(self.chain_spec, tx_hash, session=self.session) + self.__add(tx) status = tx['status'] if self.decode_status: status = status_str(tx['status_code'], bits_only=True) diff --git a/chainqueue/db/models/otx.py b/chainqueue/db/models/otx.py @@ -175,6 +175,7 @@ class Otx(SessionBase): self.__set_status(StatusBits.UNKNOWN_ERROR | StatusBits.FINAL, session) + self.__reset_status(StatusBits.QUEUED | StatusBits.RESERVED, session) if self.tracing: self.__state_log(session=session) diff --git a/scripts/migrate.py b/scripts/migrate.py @@ -26,7 +26,7 @@ default_data_dir = os.path.join(xdg_data_dirs[0], 'chainqueue') default_config_dir = load_first_config('chainqueue') config_dir = os.environ.get('CONFINI_DIR', default_config_dir) -argparser = argparse.ArgumentParser() +argparser = argparse.ArgumentParser("Database migration tool for chainqueue") argparser.add_argument('-c', type=str, default=config_dir, help='config file') argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration') argparser.add_argument('--data-dir', dest='data_dir', type=str, default=default_data_dir, help='data directory')