Skip to content

dp3.bin.shcmd.entity

Entity commands for the shell-oriented DP3 CLI.

parse_entity_command 

parse_entity_command(args) -> tuple[Optional[argparse.Namespace], Optional[int]]

Parse the path-like entity command grammar.

Source code in dp3/bin/shcmd/entity/__init__.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def parse_entity_command(args) -> tuple[Optional[argparse.Namespace], Optional[int]]:
    """Parse the path-like entity command grammar."""
    overview_parser = _build_overview_parser()
    if args.selector is None:
        overview_parser.print_help()
        return None, 2

    entity_type = args.selector
    if not args.rest:
        etype.build_parser(entity_type).print_help()
        return None, 2

    parsed = etype.build_parser(entity_type).parse_args(args.rest)
    return parsed, None

handle_entity_command 

handle_entity_command(_client, _args) -> int

Placeholder for the top-level entity parser before nested parsing runs.

Source code in dp3/bin/shcmd/entity/__init__.py 
44
45
46
def handle_entity_command(_client, _args) -> int:
    """Placeholder for the top-level entity parser before nested parsing runs."""
    raise RuntimeError("Entity commands must be parsed before execution.")

register_parser 

register_parser(commands) -> None

Register entity commands on the root parser.

Source code in dp3/bin/shcmd/entity/__init__.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def register_parser(commands) -> None:
    """Register entity commands on the root parser."""
    overview_parser = _build_overview_parser()
    entity_parser = commands.add_parser(
        "entity",
        help="Inspect and modify entity data.",
        description=overview_parser.description,
    )
    selector_action = entity_parser.add_argument(
        "selector", nargs="?", metavar="ENTITY_TYPE", help="Entity type."
    )
    selector_action.completer = complete_entity_selector
    rest_action = entity_parser.add_argument("rest", nargs=argparse.REMAINDER, metavar="...")
    rest_action.completer = complete_entity_rest
    entity_parser.set_defaults(handler=handle_entity_command, prepare_args=parse_entity_command)