/
geographies_result.py
42 lines (29 loc) · 1.19 KB
/
geographies_result.py
1
2
3
4
5
6
7
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
from typing import List
import pandas as pd
from vortexasdk.api import Geography
from vortexasdk.api.search_result import Result
from vortexasdk.logger import get_logger
from vortexasdk.result_conversions import create_dataframe, create_list
logger = get_logger(__name__)
class GeographyResult(Result):
"""Container class that holds the result obtained from calling the `Geography` endpoint."""
def to_list(self) -> List[Geography]:
"""Represent geographies as a list."""
# noinspection PyTypeChecker
return create_list(super().to_list(), Geography)
def to_df(self, columns=None) -> pd.DataFrame:
"""
Represent geographies as a `pd.DataFrame`.
# Arguments
columns: The geography features we want in the dataframe. Enter `columns='all'` to include all features.
Defaults to `columns = ['id', 'name', 'layer']`.
# Returns
`pd.DataFrame` of geographies.
"""
return create_dataframe(
data=super().to_list(),
columns=columns,
default_columns=DEFAULT_COLUMNS,
logger_description="Geographies",
)
DEFAULT_COLUMNS = ["id", "name", "layer"]