/
canal_transit_timeseries.py
238 lines (184 loc) · 12.8 KB
/
canal_transit_timeseries.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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fcanal_transit_timeseries.ipynb)
"""
from datetime import datetime, timedelta
from typing import Any, Dict, List, Optional, Union
from vortexasdk.api import ID
from vortexasdk.api.shared_types import to_ISODate
from vortexasdk.endpoints.endpoints import CANAL_TRANSIT_TIME_SERIES
from vortexasdk.endpoints.timeseries_result import TimeSeriesResult
from vortexasdk.logger import get_logger
from vortexasdk.utils import convert_to_list
from vortexasdk.operations import Search
logger = get_logger(__name__)
class CanalTransitTimeseries(Search):
def __init__(self):
Search.__init__(self, CANAL_TRANSIT_TIME_SERIES)
def search(
self,
filter_vessel_cubic_capacity_min: Optional[int] = None,
filter_vessel_cubic_capacity_max: Optional[int] = None,
filter_vessel_dead_weight_min: Optional[int] = None,
filter_vessel_dead_weight_max: Optional[int] = None,
filter_vessel_classes: Optional[Union[ID, List[ID]]] = None,
filter_vessels: Optional[Union[ID, List[ID]]] = None,
filter_products: Optional[Union[ID, List[ID]]] = None,
filter_origin: Optional[Union[ID, List[ID]]] = None,
filter_destination: Optional[Union[ID, List[ID]]] = None,
filter_charterer: Optional[Union[ID, List[ID]]] = None,
filter_effective_controller: Optional[Union[ID, List[ID]]] = None,
filter_queue_arrival_time_min: Optional[datetime] = None,
filter_queue_arrival_time_max: Optional[datetime] = None,
filter_canal_entry_time_min: Optional[datetime] = None,
filter_canal_entry_time_max: Optional[datetime] = None,
filter_canal_exit_time_min: Optional[datetime] = None,
filter_canal_exit_time_max: Optional[datetime] = None,
filter_booked_time_min: Optional[datetime] = None,
filter_booked_time_max: Optional[datetime] = None,
filter_booked_status: Optional[bool] = None,
filter_voyage_status: Optional[str] = None,
updated_since: Optional[datetime] = None,
filter_canal: Optional[str] = None,
filter_direction: Optional[str] = None,
filter_lock: Optional[str] = None,
time_min: datetime = datetime.now() - timedelta(days=2),
time_max: datetime = datetime.now() + timedelta(days=2),
timeseries_activity: str = "started_waiting",
metric: str = "count_of_vessels",
timeseries_frequency: str = "day",
exclude_filter_vessels: Optional[Union[ID, List[ID]]] = None,
exclude_filter_vessel_classes: Optional[Union[ID, List[ID]]] = None,
exclude_filter_products: Optional[Union[ID, List[ID]]] = None,
exclude_filter_origin: Optional[Union[ID, List[ID]]] = None,
exclude_filter_destination: Optional[Union[ID, List[ID]]] = None,
exclude_filter_charterer: Optional[Union[ID, List[ID]]] = None,
exclude_filter_effective_controller: Optional[
Union[ID, List[ID]]
] = None,
) -> TimeSeriesResult:
"""
Aggregate Canal Transit records for various activities and frequencies.
# Arguments
filter_vessel_cubic_capacity_min: Minimum cubic capacity of the vessel,
filter_vessel_cubic_capacity_max: Maximum cubic capacity of the vessel,
filter_vessel_dead_weight_min: Minimum DWT of the vessel,
filter_vessel_dead_weight_max: Maximum DWT of the vessel,
filter_vessel_classes: A vessel class, or list of vessel classes to filter on.
filter_vessels: A vessel ID, or list of vessel IDs to filter on.
filter_products: A product ID, or list of product IDs to filter on.
filter_origin: A geography ID, or list of geography IDs to filter on.
filter_destination: A geography ID, or list of geography IDs to filter on.
filter_charterer: An charterer ID, or list of charterer IDs to filter on.
filter_effective_controllers: An effective controller ID, or list of effective controller IDs to filter on.
filter_queue_arrival_time_min: The UTC date of when vessel arrived to the queue,
filter_queue_arrival_time_max: The UTC date of when vessel arrived to the queue,
filter_canal_entry_time_min: The UTC date of when vessel entered the canal,
filter_canal_entry_time_max: The UTC date of when vessel entered the canal,
filter_canal_exit_time_min: The UTC date of when vessel left the canal,
filter_canal_exit_time_max: The UTC date of when vessel left the canal,
filter_booked_time_min: The UTC date of planned time to enter the canal,
filter_booked_time_max: The UTC date of planned time to enter the canal,
filter_booked_status: Boolean to filter vessels that booked their slots before arrival. Can be `'true'` or `'false'`,
filter_voyage_status: A voyage status, or list of voyage statuses to filter on. Can be one of: `'ballast'`, `'laden'`,
updated_since: The UTC date of last update time of the record,
filter_canal: Canal the vessel is queuing for. Must be one of [`'suez_canal'`, `'panama_canal'`],
filter_direction: Direction that vessel is heading. Must be one of [`'northbound'`, `'southbound'`],
filter_lock: Route taken through the canal. For the Panama canal, it must be one of [`'panamax'`, `'neopanamax'`],
time_min: The UTC date when `timeseries_activity` starts,
time_max: The UTC date when `timeseries_activity` ends,
timeseries_activity: Activity of the vessel we want to aggregate on. Must be one of [`'started_waiting'`, `'waiting'`, `'started_transiting'`, `'transiting'`, `'transited'`]
metric: Aggregation metric. Must be one of [`'count_of_vessels'`, `'minimum_waiting_time'`, `'maximum_waiting_time'`, `'average_waiting_time'`]
timeseries_frequency: Frequency denoting the granularity of the time series. Must be one of [`'day'`, `'week'`]
exclude_filter_vessels: A vessel ID, or list of vessel IDs to exclude,
exclude_filter_vessel_classes: A vessel class, or list of vessel classes to exclude,
exclude_filter_products: A product ID, or list of product IDs to exclude,
exclude_filter_origin: A geography ID, or list of geography IDs to exclude,
exclude_filter_destination: A geography ID, or list of geography IDs to exclude,
exclude_filter_charterer: A charterer ID, or list of charterer IDs to exclude,
exclude_filter_effective_controller: A effective controller ID, or list of IDs to exclude,
# Returns
`CanalTransitTimeseries`
"""
exclude_params: Dict[str, Any] = {
"filter_origin": convert_to_list(exclude_filter_origin),
"filter_destination": convert_to_list(exclude_filter_destination),
"filter_products": convert_to_list(exclude_filter_products),
"filter_vessels": convert_to_list(exclude_filter_vessels),
"filter_vessel_classes": convert_to_list(
exclude_filter_vessel_classes
),
"filter_charterers": convert_to_list(exclude_filter_charterer),
"filter_effective_controllers": convert_to_list(
exclude_filter_effective_controller
),
}
api_params: Dict[str, Any] = {
"time_min": to_ISODate(time_min),
"time_max": to_ISODate(time_max),
"timeseries_activity": timeseries_activity,
"metric": metric,
"timeseries_frequency": timeseries_frequency,
"filter_booked_time_max": to_ISODate(filter_booked_time_max)
if filter_booked_time_max
else None,
"filter_booked_time_min": to_ISODate(filter_booked_time_min)
if filter_booked_time_min
else None,
"filter_canal_entry_time_max": to_ISODate(
filter_canal_entry_time_max
)
if filter_canal_entry_time_max
else None,
"filter_canal_entry_time_min": to_ISODate(
filter_canal_entry_time_min
)
if filter_canal_entry_time_min
else None,
"filter_canal_exit_time_max": to_ISODate(
filter_canal_exit_time_max
)
if filter_canal_exit_time_max
else None,
"filter_canal_exit_time_min": to_ISODate(
filter_canal_exit_time_min
)
if filter_canal_exit_time_min
else None,
"filter_queue_arrival_time_max": to_ISODate(
filter_queue_arrival_time_max
)
if filter_queue_arrival_time_max
else None,
"filter_queue_arrival_time_min": to_ISODate(
filter_queue_arrival_time_min
)
if filter_queue_arrival_time_min
else None,
"filter_vessel_cubic_capacity_max": filter_vessel_cubic_capacity_max,
"filter_vessel_cubic_capacity_min": filter_vessel_cubic_capacity_min,
"filter_vessel_dead_weight_max": filter_vessel_dead_weight_max,
"filter_vessel_dead_weight_min": filter_vessel_dead_weight_min,
"filter_vessel_classes": convert_to_list(filter_vessel_classes),
"filter_vessels": convert_to_list(filter_vessels),
"filter_products": convert_to_list(filter_products),
"filter_origin": convert_to_list(filter_origin),
"filter_destination": convert_to_list(filter_destination),
"filter_charterer": convert_to_list(filter_charterer),
"filter_effective_controller": convert_to_list(
filter_effective_controller
),
"filter_canal": filter_canal,
"filter_direction": filter_direction,
"filter_lock": filter_lock,
"filter_booked_status": filter_booked_status,
"filter_voyage_status": filter_voyage_status,
"updated_since": to_ISODate(updated_since)
if updated_since
else None,
"exclude": exclude_params,
}
response = super().search_with_client(**api_params)
return TimeSeriesResult(
records=response["data"], reference=response["reference"]
)