rattail/rattail
2
0
Fork 0
Code Issues 7 Pull requests Actions Packages Projects Releases Wiki Activity

In batch handlers, let cognize_row() return False to skip the row.

Browse source
This commit is contained in:
Lance Edgar 2015-07-09 14:35:10 -05:00
parent 98caabe44d
commit 6894414d04
1 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
rattail/db/batch/handler.py
View file

@ -88,10 +88,10 @@ class BatchHandler(object):
cancel = False cancel = False
for i, row in enumerate(data, 1): for i, row in enumerate(data, 1):
row.sequence = i row.sequence = i
self.cognize_row(session, row) if self.cognize_row(session, row) is not False:
batch.data_rows.append(row) batch.data_rows.append(row)
if i % 250 == 0: # seems to help progres UI if i % 250 == 0: # seems to help progres UI
session.flush() session.flush()
if prog and not prog.update(i): if prog and not prog.update(i):
cancel = True cancel = True
break break
@ -101,6 +101,19 @@ class BatchHandler(object):
return not cancel return not cancel
def cognize_row(self, session, row): def cognize_row(self, session, row):
"""
This method should further populate the row's fields, using database
lookups and business rules etc. as needed. Each handler class must
define this method.
:param session: SQLAlchemy database session object.
:param row: A batch row instance, whose fields reflect the initial
source data only, e.g. that which was parsed from a file.
:returns: Typically this method needn't return anything. However if it
returns ``False`` then the row will *not* be added to the batch.
"""
raise NotImplementedError raise NotImplementedError
def executable(self, batch): def executable(self, batch):