rattail.commands.batch

Batch-related commands

class rattail.commands.batch.AutoReceiveBatch(*args, **kwargs)

Auto-receive all items in a receiving batch

class rattail.commands.batch.BatchAction(*args, **kwargs)

Base class for commands which invoke a handler to act on a single batch.

do_stuff(args, handler, session, user)

This will invoke some action on the batch.

class rattail.commands.batch.BatchHandlerCommand(*args, **kwargs)

Base class for commands which invoke a batch handler.

Note that if such a command fails to run its action, the error will be written to STDOUT as a simple message string. If the full traceback is needed, logs must be consulted. This is done for sake of letting the caller capture output for display to the user when something goes wrong.

get_handler(args)

Must return the batch handler to use, per the given args object.

Default logic assumes that args has a batch_type attribute, which determines which batch handler should be used. That is figured out by calling get_batch_handler() on the app handler.

Parameters:

args – Reference to the argparse.Namespace instance, which was the result of parsing the command line args.

Returns:

Must return the batch handler. This will be an instance of some class which derives from BatchHandler.

run(args)

Run the subcommand logic. Subclass should override this.

Parameters:

args – Reference to the argparse.Namespace object, as returned by the subcommand arg parser.

The args should have values for everything setup in add_args(). For example if you added the --foo arg then here in run() you can do:

print("foo value is:", args.foo)

Usually of course this method is invoked by way of command line. But if you need to run it programmatically, you should not try to invoke this method directly. Instead create the Command object and invoke its run() method.

For a command line like bin/poser hello --foo=baz then, you might do this:

from poser.commands import PoserCommand

cmd = PoserCommand()
assert cmd.name == 'poser'
cmd.run('hello', '--foo=baz')

class rattail.commands.batch.ExecuteBatch(*args, **kwargs)

Execute a batch

class rattail.commands.batch.MakeBatch(*args, **kwargs)

Make a new batch, from a data file

do_stuff(args, handler, session, user)

This will create a new batch of the specified type, then populate it with the given data file.

class rattail.commands.batch.PopulateBatch(*args, **kwargs)

Populate initial data for a batch

class rattail.commands.batch.PurgeBatches(*args, **kwargs)

Purge old batches from the database

run(args)

Run the subcommand logic. Subclass should override this.

Parameters:

args – Reference to the argparse.Namespace object, as returned by the subcommand arg parser.

The args should have values for everything setup in add_args(). For example if you added the --foo arg then here in run() you can do:

print("foo value is:", args.foo)

Usually of course this method is invoked by way of command line. But if you need to run it programmatically, you should not try to invoke this method directly. Instead create the Command object and invoke its run() method.

For a command line like bin/poser hello --foo=baz then, you might do this:

from poser.commands import PoserCommand

cmd = PoserCommand()
assert cmd.name == 'poser'
cmd.run('hello', '--foo=baz')

class rattail.commands.batch.RefreshBatch(*args, **kwargs)

Refresh data for a batch