Skip to content

Extracts tree

OpenStreetMap extracts tree.

This module contains function for displaying available extracts in the tree form.

get_available_extracts_as_rich_tree(
    source_enum,
    osm_extract_source_index_functions,
    use_full_names=False,
)

Transform available OSM extracts into a tree from the Rich library.

Source code in quackosm/osm_extracts/extracts_tree.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def get_available_extracts_as_rich_tree(
    source_enum: OsmExtractSource,
    osm_extract_source_index_functions: dict[OsmExtractSource, Callable[[], pd.DataFrame]],
    use_full_names: bool = False,
) -> Tree:
    """Transform available OSM extracts into a tree from the Rich library."""
    if source_enum == OsmExtractSource.any:
        root = Tree("All extracts")
        for other_source_enum, get_index_function in osm_extract_source_index_functions.items():
            branch_id = other_source_enum.value
            branch = root.add(branch_id)
            create_rich_tree_branch(branch_id, branch, get_index_function(), use_full_names)
    else:
        root_id = source_enum.value
        root = Tree(root_id)
        create_rich_tree_branch(
            root_id, root, osm_extract_source_index_functions[source_enum](), use_full_names
        )

    return root


create_rich_tree_branch(
    parent_id, tree, index, use_full_names, depth=0
)

Iterate OSM extracts recursively and create tree branches.

PARAMETER DESCRIPTION
parent_id

Current id of the extract used to find children.

TYPE: str

tree

Tree object from Rich library.

TYPE: Tree

index

List of available OSM extracts.

TYPE: DataFrame

use_full_names

Whether to display full name, or short name of the extract. Full name contains all parents of the extract.

TYPE: bool

depth

Depth of the recursion. Defaults to 0.

TYPE: int DEFAULT: 0

Source code in quackosm/osm_extracts/extracts_tree.py 
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
def create_rich_tree_branch(
    parent_id: str, tree: Tree, index: pd.DataFrame, use_full_names: bool, depth: int = 0
) -> None:
    """
    Iterate OSM extracts recursively and create tree branches.

    Args:
        parent_id (str): Current id of the extract used to find children.
        tree (Tree): Tree object from Rich library.
        index (pd.DataFrame): List of available OSM extracts.
        use_full_names (bool): Whether to display full name, or short name of the extract.
            Full name contains all parents of the extract.
        depth (int, optional): Depth of the recursion. Defaults to 0.
    """
    matching_children = index[index.parent == parent_id].sort_values(by="name")
    for matching_child in matching_children.to_dict(orient="records"):
        name = matching_child["file_name"] if use_full_names else matching_child["name"]
        url = matching_child["url"]
        area = human_format(matching_child["area"])
        branch = tree.add(f":globe_with_meridians: [link={url}]{name}[/link] ({area} km\u00b2)")

        create_rich_tree_branch(matching_child["id"], branch, index, use_full_names, depth + 1)

    if depth == 0:
        loose_parents = sorted(set(index["parent"]).difference(index["id"]).difference([parent_id]))
        for loose_parent in loose_parents:
            branch = tree.add(loose_parent)
            create_rich_tree_branch(loose_parent, branch, index, use_full_names, depth + 1)


human_format(num)

Change big number into a human readable format.

Source code in quackosm/osm_extracts/extracts_tree.py 
67
68
69
70
71
72
73
74
75
76
77
def human_format(num: float) -> str:
    """Change big number into a human readable format."""
    num = float(f"{num:.3g}")
    magnitude = 0
    while abs(num) >= 1000:
        magnitude += 1
        num /= 1000.0
    return "{}{}".format(
        f"{num:f}".rstrip(".0"),
        ["", "K", "M", "B"][magnitude],
    )