CLI reference¶

from footman import task, group, pre_tasks

@task                       # bare
def build(): ...

@task(name="ci-build")      # override the command name
def build(): ...

@task(pre=[fmt], post=[notify])   # dependencies (run before / after)
def check(): ...

@task(keep_going=True)      # surface every failure in the subtree, don't stop at the first
def check(): ...

@task(atomic=True)          # never kill this task's subprocesses mid-flight on a sibling failure
def format(): ...

@task(confirm="Deploy to prod?")  # a confirm gate before the task and its prereqs run
def deploy(): ...

@task(interactive=True)     # owns the real terminal; the run goes fully sequential
def scaffold(): ...

@task(progress=False)       # duration has no pattern: never timed, only pulses
def repl(): ...

@task(infinite=True)        # runs until Ctrl-C: hinted at start, never timed
def serve(): ...

@task(shared=False)         # never shared: every request for it runs
def notify(): ...

@task(hidden=True)          # out of the listings, callable and completed as ever
def ci_entry(): ...

@task(expose="project_only")  # outside a project: unlisted, uncompleted, refused
def deploy(): ...

fmt.opts(atomic=True)       # override a task's policy for one use (pre=/post=/body call)

release = group("release", help="Cut a release")
ci = group("ci", expose="project_only")   # the whole subtree needs a project

@release.task
def wheel(): ...

@pre_tasks                  # once per invocation, before anything runs
def gate(inv):              # (see Composing tasks)
    for t in inv.tasks:
        t.add_pre(inv.tasks["audit"])

@pre_bind                   # before binding: task.env reaches env() fallbacks
def creds(inv, task): ...

@pre_task                   # around every execution, on its worker thread
def opened(inv, task): ...  # post-bind: task.args, task.state, task.env

@post_task
def closed(inv, task, result): ...  # sealed, read-only; veto via fail()

@post_tasks                 # once per invocation, after the run
def digest(inv): ...        # inv.results / inv.skipped / inv.total_ms

@wrap_task                  # the pair as one generator
def span(inv, task):
    result = yield          # (wrap_bind: two yields, enters at bind)