Skip to content

dp3.bin.shcmd.entity.etype

Entity type-scope commands for the shell-oriented DP3 CLI.

handle_list 

handle_list(client, args) -> int

List latest entity snapshots for one type.

Source code in dp3/bin/shcmd/entity/etype.py 
21
22
23
24
25
26
27
28
def handle_list(client, args) -> int:
    """List latest entity snapshots for one type."""
    path = f"/entity/{args.etype}/get"
    params = build_type_query_params(client, args, include_paging=True)
    if args.format == "ndjson":
        base_params = {key: value for key, value in params.items() if key not in {"skip", "limit"}}
        return stream_json_pages(client, path, base_params, args.skip, args.limit)
    return print_response_json(client.request("GET", path, params=params))

handle_count 

handle_count(client, args) -> int

Count latest entity snapshots for one type.

Source code in dp3/bin/shcmd/entity/etype.py 
31
32
33
34
def handle_count(client, args) -> int:
    """Count latest entity snapshots for one type."""
    params = build_type_query_params(client, args, include_paging=False)
    return print_response_json(client.request("GET", f"/entity/{args.etype}/count", params=params))

handle_distinct 

handle_distinct(client, args) -> int

Get distinct values for one attribute across an entity type.

Source code in dp3/bin/shcmd/entity/etype.py 
37
38
39
40
41
def handle_distinct(client, args) -> int:
    """Get distinct values for one attribute across an entity type."""
    return print_response_json(
        client.request("GET", f"/entity/{args.etype}/_/distinct/{args.attr}")
    )

build_parser 

build_parser(etype: str) -> argparse.ArgumentParser

Build the parser for entity type-scope commands.

Source code in dp3/bin/shcmd/entity/etype.py 
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
def build_parser(etype: str) -> argparse.ArgumentParser:
    """Build the parser for entity type-scope commands."""
    parser = argparse.ArgumentParser(
        prog=f"dp3 sh entity {etype}",
        description=(f"Query entities of type '{etype}' or use 'id' to inspect one entity by id."),
    )
    parser.set_defaults(etype=etype)
    commands = parser.add_subparsers(dest="entity_type_command", required=True)

    list_parser = commands.add_parser("list", help="List latest entity snapshots.")
    add_type_filter_args(list_parser, include_paging=True)
    add_ndjson_format_arg(list_parser)
    list_parser.set_defaults(handler=handle_list, etype=etype)

    count_parser = commands.add_parser("count", help="Count latest entity snapshots.")
    add_type_filter_args(count_parser, include_paging=False)
    count_parser.set_defaults(handler=handle_count, etype=etype)

    raw_parser = commands.add_parser("raw", help=RAW_HELP)
    add_raw_filter_args(raw_parser)
    add_page_args(raw_parser, default_limit=20, subject="raw datapoints")
    add_ndjson_format_arg(raw_parser)
    raw_parser.set_defaults(handler=handle_raw, etype=etype, eid=None)

    attr_values_parser = commands.add_parser(
        "attr-values",
        help="Get distinct latest values of one attribute across the entity type.",
        description="Get distinct latest values of one attribute across the entity type.",
    )
    attr_action = attr_values_parser.add_argument(
        "attr", metavar="ATTR", help="Attribute to query across the entity type."
    )
    attr_action.completer = complete_entity_attr_names
    attr_values_parser.set_defaults(handler=handle_distinct, etype=etype)

    instance.add_id_parser(commands, etype)

    return parser