Skip to content

dp3.bin.shcmd.control

Control commands for the shell-oriented DP3 CLI.

handle_make_snapshots 

handle_make_snapshots(client, _args) -> int

Trigger an out-of-order snapshot run.

Source code in dp3/bin/shcmd/control.py 
7
8
9
def handle_make_snapshots(client, _args) -> int:
    """Trigger an out-of-order snapshot run."""
    return print_response_json(client.request("GET", "/control/make_snapshots"))

handle_refresh_on_entity_creation 

handle_refresh_on_entity_creation(client, args) -> int

Re-run entity-creation callbacks for an entity type.

Source code in dp3/bin/shcmd/control.py 
12
13
14
15
16
17
18
19
20
def handle_refresh_on_entity_creation(client, args) -> int:
    """Re-run entity-creation callbacks for an entity type."""
    return print_response_json(
        client.request(
            "GET",
            "/control/refresh_on_entity_creation",
            params={"etype": args.etype},
        )
    )

handle_refresh_module_config 

handle_refresh_module_config(client, args) -> int

Reload configuration for one module.

Source code in dp3/bin/shcmd/control.py 
23
24
25
26
27
28
29
30
31
def handle_refresh_module_config(client, args) -> int:
    """Reload configuration for one module."""
    return print_response_json(
        client.request(
            "GET",
            "/control/refresh_module_config",
            params={"module": args.module},
        )
    )

register_parser 

register_parser(commands) -> None

Register control commands on the root parser.

Source code in dp3/bin/shcmd/control.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def register_parser(commands) -> None:
    """Register control commands on the root parser."""
    control_parser = commands.add_parser("control", help="Execute control actions.")
    control_commands = control_parser.add_subparsers(dest="control_command", required=True)

    make_snapshots_parser = control_commands.add_parser(
        "make-snapshots", help="Trigger an out-of-order snapshot run."
    )
    make_snapshots_parser.set_defaults(handler=handle_make_snapshots)

    refresh_entity_creation_parser = control_commands.add_parser(
        "refresh-on-entity-creation",
        help="Re-run entity creation callbacks for an entity type.",
    )
    etype_action = refresh_entity_creation_parser.add_argument("etype")
    etype_action.completer = complete_entity_type_names
    refresh_entity_creation_parser.set_defaults(handler=handle_refresh_on_entity_creation)

    refresh_module_config_parser = control_commands.add_parser(
        "refresh-module-config",
        help="Reload module configuration.",
    )
    refresh_module_config_parser.add_argument("module")
    refresh_module_config_parser.set_defaults(handler=handle_refresh_module_config)