Skip to content

cmd_turtle_canon

Command line interface (CLI) for running turtle-canon.

CLIArgs dataclass

CLI parsed arguments

Source code in turtle_canon/cli/cmd_turtle_canon.py 
14
15
16
17
18
19
20
21
@dataclass
class CLIArgs:
    """CLI parsed arguments"""

    version: str
    log_level: str
    fail_fast: bool
    turtle_files: list[Path]

main(args=None)

Turtle Canon - It's turtles all the way down.

Source code in turtle_canon/cli/cmd_turtle_canon.py 
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def main(args: list[str] | None = None) -> None:
    """Turtle Canon - It's turtles all the way down."""
    from turtle_canon import __version__
    from turtle_canon.canon import canonize
    from turtle_canon.cli import utils
    from turtle_canon.utils.exceptions import TurtleCanonException
    from turtle_canon.utils.warnings import TurtleCanonWarning

    parser = argparse.ArgumentParser(
        description=main.__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
    )
    parser.add_argument(
        "--version",
        action="version",
        help="Show the version and exit.",
        version=f"Turtle Canon version {__version__}",
    )
    parser.add_argument(
        "--log-level",
        type=str,
        help="Set the logging output level.",
        choices=LOGGING_LEVELS,
        default="info",
    )
    parser.add_argument(
        "--fail-fast",
        action="store_true",
        help=(
            "Exit the canonization immediately if an error occurs. E.g., if multiple "
            "files are given, Turtle Canon will exit immediately if an error occurs "
            "when canonization a single file. Otherwise, all files will be attempted "
            "to be canonized, and a summary will be printed at the end."
        ),
    )
    parser.add_argument(
        "turtle_files",
        action="extend",
        nargs="+",
        type=Path,
        help=(
            "Path to the Turtle file. Can be relative or absolute. Example: "
            "'../my_ontology.ttl'."
        ),
        metavar="TURTLE_FILE",
    )

    args: CLIArgs = parser.parse_args(args)  # type: ignore[assignment]

    cache = utils.Cache()

    number_of_turtle_files = len(args.turtle_files)

    while args.turtle_files:
        turtle_file = args.turtle_files.pop()
        changed_file = None
        try:
            changed_file = canonize(turtle_file)
            if changed_file:
                cache.add_file(changed_file)
        except TurtleCanonException as exception:
            if args.fail_fast:
                utils.print_error(exception)
            else:
                cache.add_error(exception)
        except TurtleCanonWarning as warning:
            if number_of_turtle_files == 1:
                utils.print_warning(warning)
            cache.add_warning(warning)
            if changed_file:
                cache.add_file(changed_file)

    if number_of_turtle_files == 1 and cache.warnings:
        pass
    else:
        utils.print_summary(errors=cache.errors, warnings=cache.warnings)

    utils.print_changed_files(cache.files, exit_after=bool(cache.errors))

    sys.exit()