/
vessel_movements_result.py
515 lines (494 loc) · 20.8 KB
/
vessel_movements_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
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
import functools
import os
from multiprocessing.pool import Pool
from typing import List
import pandas as pd
from vortexasdk.api import VesselMovement
from vortexasdk.api.entity_flattening import (
convert_vessel_movement_to_flat_dict,
)
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__)
class VesselMovementsResult(Result):
"""
Container class holdings search results returns from the vessel movements endpoint.
This class has two methods, `to_list()`, and `to_df()`, allowing search results to be represented as a list of `VesselMovement`s,
or as a `pd.DataFrame` , respectively.
"""
def to_list(self) -> List[VesselMovement]:
"""Represent vessel movements as a list of `VesselMovementEntity`s."""
# noinspection PyTypeChecker
return create_list(super().to_list(), VesselMovement)
def to_df(self, columns=None) -> pd.DataFrame:
"""
Represent vessel movements as a `pd.DataFrame`.
# Arguments
columns: Output columns present in the `pd.DataFrame`.
Enter `columns='all'` to return all available columns.
Enter `columns=None` to use `vessel_movements.DEFAULT_COLUMNS`.
# Returns
`pd.DataFrame`, one row per `VesselMovement`.
## Notes
By default, the columns returned are something along the lines of.
```python
DEFAULT_COLUMNS = [
'vessel.imo',
'vessel.name',
'vessel.vessel_class',
'origin.event_type',
'origin.location.port.label',
'origin.location.country.label',
'destination.event_type',
'destination.location.port.label',
'destination.location.country.label',
'cargoes.0.product.group_product.label,'
'cargoes.0.product.category.label',
'cargoes.0.product.grade.label',
'cargoes.0.quantity',
'start_timestamp',
'end_timestamp',
]
```
The exact default columns used can be found at `vessel_movements.DEFAULT_COLUMNS`
A near complete list of columns is given below
```
[
cargoes.0.cargo_movement_id
cargoes.0.product.category.id
cargoes.0.product.category.label
cargoes.0.product.category.layer
cargoes.0.product.category.probability
cargoes.0.product.category.source
cargoes.0.product.grade.id
cargoes.0.product.grade.label
cargoes.0.product.grade.layer
cargoes.0.product.grade.probability
cargoes.0.product.grade.source
cargoes.0.product.group.id
cargoes.0.product.group.label
cargoes.0.product.group.layer
cargoes.0.product.group.probability
cargoes.0.product.group.source
cargoes.0.product.group_product.id
cargoes.0.product.group_product.label
cargoes.0.product.group_product.layer
cargoes.0.product.group_product.probability
cargoes.0.product.group_product.source
cargoes.0.quantity
cargoes.1.cargo_movement_id
cargoes.1.product.category.id
cargoes.1.product.category.label
cargoes.1.product.category.layer
cargoes.1.product.category.probability
cargoes.1.product.category.source
cargoes.1.product.grade.id
cargoes.1.product.grade.label
cargoes.1.product.grade.layer
cargoes.1.product.grade.probability
cargoes.1.product.grade.source
cargoes.1.product.group.id
cargoes.1.product.group.label
cargoes.1.product.group.layer
cargoes.1.product.group.probability
cargoes.1.product.group.source
cargoes.1.product.group_product.id
cargoes.1.product.group_product.label
cargoes.1.product.group_product.layer
cargoes.1.product.group_product.probability
cargoes.1.product.group_product.source
cargoes.1.quantity
cargoes.2.cargo_movement_id
cargoes.2.product.category.id
cargoes.2.product.category.label
cargoes.2.product.category.layer
cargoes.2.product.category.probability
cargoes.2.product.category.source
cargoes.2.product.grade.id
cargoes.2.product.grade.label
cargoes.2.product.grade.layer
cargoes.2.product.grade.probability
cargoes.2.product.grade.source
cargoes.2.product.group.id
cargoes.2.product.group.label
cargoes.2.product.group.layer
cargoes.2.product.group.probability
cargoes.2.product.group.source
cargoes.2.product.group_product.id
cargoes.2.product.group_product.label
cargoes.2.product.group_product.layer
cargoes.2.product.group_product.probability
cargoes.2.product.group_product.source
cargoes.2.quantity
cargoes.3.cargo_movement_id
cargoes.3.product.category.id
cargoes.3.product.category.label
cargoes.3.product.category.layer
cargoes.3.product.category.probability
cargoes.3.product.category.source
cargoes.3.product.grade.id
cargoes.3.product.grade.label
cargoes.3.product.grade.layer
cargoes.3.product.grade.probability
cargoes.3.product.grade.source
cargoes.3.product.group.id
cargoes.3.product.group.label
cargoes.3.product.group.layer
cargoes.3.product.group.probability
cargoes.3.product.group.source
cargoes.3.product.group_product.id
cargoes.3.product.group_product.label
cargoes.3.product.group_product.layer
cargoes.3.product.group_product.probability
cargoes.3.product.group_product.source
cargoes.3.quantity
cargoes.4.cargo_movement_id
cargoes.4.product.category.id
cargoes.4.product.category.label
cargoes.4.product.category.layer
cargoes.4.product.category.probability
cargoes.4.product.category.source
cargoes.4.product.grade.id
cargoes.4.product.grade.label
cargoes.4.product.grade.layer
cargoes.4.product.grade.probability
cargoes.4.product.grade.source
cargoes.4.product.group.id
cargoes.4.product.group.label
cargoes.4.product.group.layer
cargoes.4.product.group.probability
cargoes.4.product.group.source
cargoes.4.product.group_product.id
cargoes.4.product.group_product.label
cargoes.4.product.group_product.layer
cargoes.4.product.group_product.probability
cargoes.4.product.group_product.source
cargoes.4.quantity
cargoes.5.cargo_movement_id
cargoes.5.product.category.id
cargoes.5.product.category.label
cargoes.5.product.category.layer
cargoes.5.product.category.probability
cargoes.5.product.category.source
cargoes.5.product.grade.id
cargoes.5.product.grade.label
cargoes.5.product.grade.layer
cargoes.5.product.grade.probability
cargoes.5.product.grade.source
cargoes.5.product.group.id
cargoes.5.product.group.label
cargoes.5.product.group.layer
cargoes.5.product.group.probability
cargoes.5.product.group.source
cargoes.5.product.group_product.id
cargoes.5.product.group_product.label
cargoes.5.product.group_product.layer
cargoes.5.product.group_product.probability
cargoes.5.product.group_product.source
cargoes.5.quantity
cargoes.6.cargo_movement_id
cargoes.6.product.category.id
cargoes.6.product.category.label
cargoes.6.product.category.layer
cargoes.6.product.category.probability
cargoes.6.product.category.source
cargoes.6.product.grade.id
cargoes.6.product.grade.label
cargoes.6.product.grade.layer
cargoes.6.product.grade.probability
cargoes.6.product.grade.source
cargoes.6.product.group.id
cargoes.6.product.group.label
cargoes.6.product.group.layer
cargoes.6.product.group.probability
cargoes.6.product.group.source
cargoes.6.product.group_product.id
cargoes.6.product.group_product.label
cargoes.6.product.group_product.layer
cargoes.6.product.group_product.probability
cargoes.6.product.group_product.source
cargoes.6.quantity
cargoes.7.cargo_movement_id
cargoes.7.product.category.id
cargoes.7.product.category.label
cargoes.7.product.category.layer
cargoes.7.product.category.probability
cargoes.7.product.category.source
cargoes.7.product.grade.id
cargoes.7.product.grade.label
cargoes.7.product.grade.layer
cargoes.7.product.grade.probability
cargoes.7.product.grade.source
cargoes.7.product.group.id
cargoes.7.product.group.label
cargoes.7.product.group.layer
cargoes.7.product.group.probability
cargoes.7.product.group.source
cargoes.7.product.group_product.id
cargoes.7.product.group_product.label
cargoes.7.product.group_product.layer
cargoes.7.product.group_product.probability
cargoes.7.product.group_product.source
cargoes.7.quantity
cargoes.8.cargo_movement_id
cargoes.8.product.category.id
cargoes.8.product.category.label
cargoes.8.product.category.layer
cargoes.8.product.category.probability
cargoes.8.product.category.source
cargoes.8.product.grade.id
cargoes.8.product.grade.label
cargoes.8.product.grade.layer
cargoes.8.product.grade.probability
cargoes.8.product.grade.source
cargoes.8.product.group.id
cargoes.8.product.group.label
cargoes.8.product.group.layer
cargoes.8.product.group.probability
cargoes.8.product.group.source
cargoes.8.product.group_product.id
cargoes.8.product.group_product.label
cargoes.8.product.group_product.layer
cargoes.8.product.group_product.probability
cargoes.8.product.group_product.source
cargoes.8.quantity
cargoes.9.cargo_movement_id
cargoes.9.product.category.id
cargoes.9.product.category.label
cargoes.9.product.category.layer
cargoes.9.product.category.probability
cargoes.9.product.category.source
cargoes.9.product.grade.id
cargoes.9.product.grade.label
cargoes.9.product.grade.layer
cargoes.9.product.grade.probability
cargoes.9.product.grade.source
cargoes.9.product.group.id
cargoes.9.product.group.label
cargoes.9.product.group.layer
cargoes.9.product.group.probability
cargoes.9.product.group.source
cargoes.9.product.group_product.id
cargoes.9.product.group_product.label
cargoes.9.product.group_product.layer
cargoes.9.product.group_product.probability
cargoes.9.product.group_product.source
cargoes.9.quantity
destination.end_timestamp
destination.event_id
destination.event_type
destination.from_vessel.id
destination.from_vessel.label
destination.from_vessel.tags.0
destination.from_vessel.tags.1
destination.location.country.id
destination.location.country.label
destination.location.country.layer
destination.location.country.probability
destination.location.country.source
destination.location.port.id
destination.location.port.label
destination.location.port.layer
destination.location.port.probability
destination.location.port.source
destination.location.region.id
destination.location.region.label
destination.location.region.layer
destination.location.region.probability
destination.location.region.source
destination.location.shipping_region.id
destination.location.shipping_region.label
destination.location.shipping_region.layer
destination.location.shipping_region.probability
destination.location.shipping_region.source
destination.location.sts_zone.id
destination.location.sts_zone.label
destination.location.sts_zone.layer
destination.location.sts_zone.probability
destination.location.sts_zone.source
destination.location.terminal.id
destination.location.terminal.label
destination.location.terminal.layer
destination.location.terminal.probability
destination.location.terminal.source
destination.location.trading_block.id
destination.location.trading_block.label
destination.location.trading_block.layer
destination.location.trading_block.probability
destination.location.trading_block.source
destination.location.trading_region.id
destination.location.trading_region.label
destination.location.trading_region.layer
destination.location.trading_region.probability
destination.location.trading_region.source
destination.location.trading_subregion.id
destination.location.trading_subregion.label
destination.location.trading_subregion.layer
destination.location.trading_subregion.probability
destination.location.trading_subregion.source
destination.pos.0
destination.pos.1
destination.start_timestamp
destination.to_vessel.id
destination.to_vessel.label
destination.to_vessel.tags.0
destination.to_vessel.tags.1
destination.to_vessel.tags.2
destination.to_vessel.tags.3
destination.to_vessel.tags.4
destination.to_vessel.tags.5
destination.to_vessel.tags.6
destination.to_vessel.tags.7
destination.to_vessel.tags.8
destination.to_vessel.tags.9
end_timestamp
origin.end_timestamp
origin.event_id
origin.event_type
origin.from_vessel.id
origin.from_vessel.label
origin.from_vessel.tags.0
origin.from_vessel.tags.1
origin.from_vessel.tags.2
origin.from_vessel.tags.3
origin.from_vessel.tags.4
origin.from_vessel.tags.5
origin.location.country.id
origin.location.country.label
origin.location.country.layer
origin.location.country.probability
origin.location.country.source
origin.location.port.id
origin.location.port.label
origin.location.port.layer
origin.location.port.probability
origin.location.port.source
origin.location.region.id
origin.location.region.label
origin.location.region.layer
origin.location.region.probability
origin.location.region.source
origin.location.shipping_region.id
origin.location.shipping_region.label
origin.location.shipping_region.layer
origin.location.shipping_region.probability
origin.location.shipping_region.source
origin.location.sts_zone.id
origin.location.sts_zone.label
origin.location.sts_zone.layer
origin.location.sts_zone.probability
origin.location.sts_zone.source
origin.location.terminal.id
origin.location.terminal.label
origin.location.terminal.layer
origin.location.terminal.probability
origin.location.terminal.source
origin.location.trading_block.id
origin.location.trading_block.label
origin.location.trading_block.layer
origin.location.trading_block.probability
origin.location.trading_block.source
origin.location.trading_region.id
origin.location.trading_region.label
origin.location.trading_region.layer
origin.location.trading_region.probability
origin.location.trading_region.source
origin.location.trading_subregion.id
origin.location.trading_subregion.label
origin.location.trading_subregion.layer
origin.location.trading_subregion.probability
origin.location.trading_subregion.source
origin.pos.0
origin.pos.1
origin.start_timestamp
origin.to_vessel.id
origin.to_vessel.label
origin.to_vessel.tags.0
origin.to_vessel.tags.1
origin.to_vessel.tags.2
origin.to_vessel.tags.3
start_timestamp
vessel.corporate_entities.charterer.id
vessel.corporate_entities.charterer.label
vessel.corporate_entities.charterer.layer
vessel.corporate_entities.charterer.probability
vessel.corporate_entities.charterer.source
vessel.corporate_entities.commercial_owner.id
vessel.corporate_entities.commercial_owner.label
vessel.corporate_entities.commercial_owner.layer
vessel.corporate_entities.commercial_owner.probability
vessel.corporate_entities.commercial_owner.source
vessel.corporate_entities.time_charterer.end_timestamp
vessel.corporate_entities.time_charterer.id
vessel.corporate_entities.time_charterer.label
vessel.corporate_entities.time_charterer.layer
vessel.corporate_entities.time_charterer.probability
vessel.corporate_entities.time_charterer.source
vessel.corporate_entities.time_charterer.start_timestamp
vessel.cubic_capacity
vessel.dwt
vessel.id
vessel.imo
vessel.mmsi
vessel.name
vessel.status
vessel.tags.0.end_timestamp
vessel.tags.0.start_timestamp
vessel.tags.0.tag
vessel.tags.1.end_timestamp
vessel.tags.1.start_timestamp
vessel.tags.1.tag
vessel.tags.2.end_timestamp
vessel.tags.2.start_timestamp
vessel.tags.2.tag
vessel.tags.3.end_timestamp
vessel.tags.3.start_timestamp
vessel.tags.3.tag
vessel.tags.4.end_timestamp
vessel.tags.4.start_timestamp
vessel.tags.4.tag
vessel.vessel_class
vessel_movement_id
voyage_id
]
```
"""
if columns is None:
columns = DEFAULT_COLUMNS
logger.debug("Converting each VesselMovement to a flat dictionary")
flatten = functools.partial(
convert_vessel_movement_to_flat_dict, cols=columns
)
with Pool(os.cpu_count()) as pool:
records = pool.map(flatten, super().to_list())
return create_dataframe(
columns=columns,
default_columns=DEFAULT_COLUMNS,
data=records,
logger_description="VesselMovements",
)
DEFAULT_COLUMNS = [
"vessel.name",
"vessel.imo",
"vessel.mmsi",
"vessel.cubic_capacity",
"vessel.dwt",
"vessel.vessel_class",
"origin.location.port.label",
"origin.location.sts_zone.label",
"origin.from_vessel.label",
"origin.to_vessel.label",
"destination.location.port.label",
"destination.location.sts_zone.label",
"destination.from_vessel.label",
"destination.to_vessel.label",
"origin.start_timestamp",
"destination.end_timestamp",
"cargoes.0.product.group.label",
"cargoes.0.product.grade.label",
"cargoes.0.product.grade.probability",
"vessel.corporate_entities.charterer.label",
"vessel.corporate_entities.time_charterer.label",
"vessel.corporate_entities.commercial_owner.label",
]