/
storage_terminals_result.py
40 lines (28 loc) · 1.23 KB
/
storage_terminals_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
from typing import List
import pandas as pd
from vortexasdk.api import StorageTerminal
from vortexasdk.api.search_result import Result
from vortexasdk.result_conversions import create_dataframe, create_list
from vortexasdk.logger import get_logger
logger = get_logger(__name__)
DEFAULT_COLUMNS = ["id", "name", "lat", "lon"]
class StorageTerminalResult(Result):
"""Container class that holds the result obtained from calling the `Storage Terminals` endpoint."""
def to_list(self) -> List[StorageTerminal]:
"""Represent storage terminals as a list."""
# noinspection PyTypeChecker
return create_list(super().to_list(), StorageTerminal)
def to_df(self, columns=DEFAULT_COLUMNS) -> pd.DataFrame:
"""
Represent storage terminals as a `pd.DataFrame`.
# Arguments
columns: The storage terminals features we want in the dataframe. Enter `columns='all'` to include all features.
Defaults to `columns = ['id', 'name', 'lat', 'lon']`.
# Returns
`pd.DataFrame` of storage terminals.
"""
return create_dataframe(
columns=columns,
data=super().to_list(),
logger_description="StorageTerminals",
)