Skip to content

cmd.search

cmd.search¤

HerbTable ¤

Format a herb object as a table.

For example, a flora search result can be formatted as a table for the user to read easily.

Parameters:

Name Type Description Default
herb Herb

an Herb object

 required
Source code in dataherb/cmd/search.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
class HerbTable:
    """Format a herb object as a table.

    For example, a flora search result can be formatted
    as a table for the user to read easily.

    :param herb: an Herb object
    """

    def __init__(self, herb: Herb):
        self.herb = herb

    def panel(self) -> Dict[str, Panel]:
        """Create a panel with all the information"""

        return {
            "table": self.table(),
            "tree": self.resource_tree(),
        }

    def table(self) -> Panel:
        """Summary Table"""
        table = Table(title=f"DataHerb: {self.herb.name}", show_lines=True)

        table.add_column("key", justify="right", style="cyan", no_wrap=False)
        table.add_column("value", style="magenta", no_wrap=False)

        table.add_row(f"ID", f"{self.herb.id}")
        table.add_row(f"Name", f"{self.herb.name}")
        table.add_row(f"Source", f"{self.herb.source}")
        table.add_row(f"Description", f"{self.herb.description}")
        table.add_row(f"URI", f"{self.herb.uri}")
        table.add_row(f"Metadata", f"{self.herb.metadata_uri}")

        pl = Panel(table, title=f"Summary of {self.herb.id}")

        return pl

    def resource_tree(self) -> Panel:
        """Show list of resources"""

        tree = Tree(f"{self.herb.id}")
        for r in self.herb.resources:
            tree.add(f'{r.descriptor.get("path")}')

        pl = Panel(tree, title=f"Resources of {self.herb.id}")

        return pl

panel() ¤

Create a panel with all the information

Source code in dataherb/cmd/search.py 
20
21
22
23
24
25
26
def panel(self) -> Dict[str, Panel]:
    """Create a panel with all the information"""

    return {
        "table": self.table(),
        "tree": self.resource_tree(),
    }

resource_tree() ¤

Show list of resources

Source code in dataherb/cmd/search.py 
46
47
48
49
50
51
52
53
54
55
def resource_tree(self) -> Panel:
    """Show list of resources"""

    tree = Tree(f"{self.herb.id}")
    for r in self.herb.resources:
        tree.add(f'{r.descriptor.get("path")}')

    pl = Panel(tree, title=f"Resources of {self.herb.id}")

    return pl

table() ¤

Summary Table

Source code in dataherb/cmd/search.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def table(self) -> Panel:
    """Summary Table"""
    table = Table(title=f"DataHerb: {self.herb.name}", show_lines=True)

    table.add_column("key", justify="right", style="cyan", no_wrap=False)
    table.add_column("value", style="magenta", no_wrap=False)

    table.add_row(f"ID", f"{self.herb.id}")
    table.add_row(f"Name", f"{self.herb.name}")
    table.add_row(f"Source", f"{self.herb.source}")
    table.add_row(f"Description", f"{self.herb.description}")
    table.add_row(f"URI", f"{self.herb.uri}")
    table.add_row(f"Metadata", f"{self.herb.metadata_uri}")

    pl = Panel(table, title=f"Summary of {self.herb.id}")

    return pl