/
vessels_result.py
42 lines (29 loc) · 1.18 KB
/
vessels_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.logger import get_logger
from vortexasdk.api import Vessel
from vortexasdk.api.search_result import Result
from vortexasdk.result_conversions import create_dataframe, create_list
logger = get_logger(__name__)
class VesselsResult(Result):
"""Container class that holds the result obtained from calling the `Vessels` endpoint."""
def to_list(self) -> List[Vessel]:
"""Represent vessels as a list."""
# noinspection PyTypeChecker
return create_list(super().to_list(), Vessel)
def to_df(self, columns=None) -> pd.DataFrame:
"""
Represent vessels as a `pd.DataFrame`.
# Arguments
columns: The vessel features we want in the dataframe. Enter `columns='all'` to include all features.
Defaults to `columns = ['id', 'name', 'imo', 'vessel_class']`.
# Returns
`pd.DataFrame` of vessels.
"""
return create_dataframe(
columns=columns,
default_columns=DEFAULT_COLUMNS,
data=super().to_list(),
logger_description="Vessels",
)
DEFAULT_COLUMNS = ["id", "name", "imo", "vessel_class"]