3
0
Fork 0

feat: add basic batch feature, data model and partial handler

hopefully data model is complete enough for now, but handler does not
yet have all methods, e.g. execute()
This commit is contained in:
Lance Edgar 2024-12-13 20:38:00 -06:00
parent 51accc5a93
commit a514d9cfba
9 changed files with 813 additions and 1 deletions

View file

@ -0,0 +1,6 @@
``wuttjamaican.batch``
======================
.. automodule:: wuttjamaican.batch
:members:

View file

@ -0,0 +1,6 @@
``wuttjamaican.db.model.batch``
===============================
.. automodule:: wuttjamaican.db.model.batch
:members:

View file

@ -76,6 +76,42 @@ Glossary
See also :class:`~wuttjamaican.auth.AuthHandler`.
batch
This refers to a process whereby bulk data operations may be
performed, with preview and other tools to allow the user to
refine as needed before "executing" the batch.
The term "batch" may refer to such a feature overall, or the
:term:`data model` used, or the specific data for a single batch,
etc.
See also :term:`batch handler` and :term:`batch row`, and the
:class:`~wuttjamaican.db.model.batch.BatchMixin` base class.
batch handler
This refers to a :term:`handler` meant to process a given type of
:term:`batch`.
There may be multiple handlers registered for a given
:term:`batch type`, but (usually) only one will be configured for
use.
batch row
A row of data within a :term:`batch`.
May also refer to the :term:`data model` class used for such a row.
See also the :class:`~wuttjamaican.db.model.batch.BatchRowMixin`
base class.
batch type
This term is used to distinguish :term:`batches <batch>` according
to which underlying table is used to store their data, essentially.
For instance a "pricing batch" would use one table, whereas an
"inventory batch" would use another. And each "type" would be
managed by its own :term:`batch handler`.
command
A top-level command line interface for the app. Note that
top-level commands don't usually "do" anything per se, and are

View file

@ -64,6 +64,7 @@ Contents
api/wuttjamaican.app
api/wuttjamaican.auth
api/wuttjamaican.batch
api/wuttjamaican.cli
api/wuttjamaican.cli.base
api/wuttjamaican.cli.make_appdir
@ -75,6 +76,7 @@ Contents
api/wuttjamaican.db.model
api/wuttjamaican.db.model.auth
api/wuttjamaican.db.model.base
api/wuttjamaican.db.model.batch
api/wuttjamaican.db.model.upgrades
api/wuttjamaican.db.sess
api/wuttjamaican.db.util