doFolder.cli.compare module¶

Define the CLI for doFolder.

Added in version 2.3.0.

class doFolder.cli.compare.DiffPlan(*values)¶

Bases: Enum

Enum to represent the plan for handling differences.

A2B = 'A2B'¶

A2B_OVERWRITE = 'A2B(Overwrite)'¶

B2A = 'B2A'¶

B2A_OVERWRITE = 'B2A(Overwrite)'¶

IGNORE = 'Ignore'¶

PENDING = 'Pending'¶

PENDING_OVERWRITE = 'Pending(Overwrite)'¶

static isOverwrite(plan: DiffPlan) → bool¶: Check if the plan is overwrite or overwrite variant.

static isPending(plan: DiffPlan) → bool¶: Check if the plan is pending or pending overwrite.

static toNonOverwrite(plan: DiffPlan) → DiffPlan¶: Convert a DiffPlan to its non-overwrite variant.

static toOverwrite(plan: DiffPlan) → DiffPlan¶: Convert a DiffPlan to its overwrite variant.

doFolder.cli.compare.compareCli(arguments: Sequence[str] | None = None, prog='buildDoc.py') → int¶: The implementation of the command-line tool do-compare You can also use it as do-folder compare or python3 -m doFolder compare.