rattail.upgrades

Upgrade handlers

class rattail.upgrades.UpgradeHandler(config, **kwargs)

Base class and default implementation for upgrade handlers.

delete_files(upgrade)

Delete all data files for the given upgrade.

do_execute(upgrade, user, **kwargs)

Perform all steps needed to fully execute the given upgrade.

Callers should use this method; you can override execute() to customize execution logic.

executable(upgrade)

This method should return a boolean indicating whether or not execution should be allowed for the upgrade, given its current condition. The default simply returns True unless the upgrade has already been executed.

execute(upgrade, user, progress=None, **kwargs)

Execute the given upgrade, as the given user.

get_all_systems(**kwargs)

Returns a list of all “systems” available for upgrade.

get_system(key, require=False, **kwargs)

Returns the “system” record for the given key.

rattail.upgrades.get_upgrade_handler(config, default=None)

Returns an upgrade handler object.