Skip to content

marks.md

Latest commit

 

History

History
80 lines (59 loc) · 1.59 KB

marks.md

File metadata and controls

80 lines (59 loc) · 1.59 KB

Marks

Built-in marks are exposed dynamically via pytask.mark, so their API is documented manually here.

Built-In Marks

pytask.mark.persist

@pytask.mark.persist

Prevent execution of a task when all neighboring nodes exist, even if something changed. See making tasks persist.

pytask.mark.skip

@pytask.mark.skip

Skip a task and all downstream tasks. See skipping tasks.

pytask.mark.skipif

@pytask.mark.skipif(condition: bool, *, reason: str)

Skip a task and all downstream tasks when condition is True. See skipping tasks.

pytask.mark.try_first

@pytask.mark.try_first

Prefer running a task as early as possible in the DAG. See how to influence build order.

pytask.mark.try_last

@pytask.mark.try_last

Prefer running a task as late as possible in the DAG. See how to influence build order.

Mark Classes

::: pytask.Mark options: filters: - "!^[^_]." - "!^__.__$" show_root_heading: true show_signature: true ::: pytask.mark ::: pytask.MarkDecorator options: filters: - "!^[^_]." - "!^__.$" ::: pytask.MarkGenerator options: filters: - "!^_[^_].*" - "!^.*__$"

Mark Utilities

::: pytask.get_all_marks ::: pytask.get_marks ::: pytask.has_mark ::: pytask.remove_marks ::: pytask.set_marks