/
storage_terminals.py
107 lines (79 loc) · 5.52 KB
/
storage_terminals.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
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fstorage_terminals.ipynb)
"""
from typing import List, Union
from vortexasdk.endpoints.endpoints import STORAGE_TERMINALS_REFERENCE
from vortexasdk.endpoints.storage_terminals_result import StorageTerminalResult
from vortexasdk.operations import Reference, Search
from vortexasdk.utils import convert_to_list
class StorageTerminals(Reference, Search):
"""
Storage Terminals endpoint.
A Storage Terminal is a reference value that corresponds to an ID associated with other entities.
For example, a storage terminal object may have the following keys:
```json
{
"name": "Military Oil Depot",
"parent": {
"name": "Bandar Khomeini, Bandar Mahshahr [IR]"
}
...
}
```
These IDs represent storage terminals which can be found via the Storage Terminal reference endpoint.
When the storage terminals endpoint is searched with those ids as parameters:
```python
>>> from vortexasdk import StorageTerminals
>>> df = StorageTerminals().search(ids=["08bbaf7a67ab30036d73b9604b932352a73905e16b8342b27f02ae34941b7db5"]).to_df()
```
Returns
| | id | name | lat | lon |
|---:|:------------------------|:-------------------|-----|-----|
| 0 | 08bbaf7a67ab30036d73... | Military Oil Depot | 90 | 180 |
"""
def __init__(self):
Reference.__init__(self, STORAGE_TERMINALS_REFERENCE)
Search.__init__(self, STORAGE_TERMINALS_REFERENCE)
def load_all(self) -> StorageTerminalResult:
"""
Load all storage terminals.
"""
return self.search()
# noinspection PyShadowingBuiltins
def search(
self,
ids: Union[str, List[str]] = None,
term: Union[str, List[str]] = None,
) -> StorageTerminalResult:
"""
Find all storage terminals matching given term.
# Arguments
ids: List of storage terminal ids to filter by.
term: List of terms to filter on.
# Returns
List of storage terminals matching the `ids` or `term` specified.
# Examples
Find a storage terminal by term, for example the name of the storage terminal.
```python
>>> from vortexasdk import StorageTerminals
>>> df = StorageTerminals().search(term=["Military"]).to_df()
```
Returns
| | id | name | lat | lon |
|---:|:------------------------|:-------------------|-----|-----|
| 0 | 08bbaf7a67ab30036d73... | Military Oil Depot | 90 | 180 |
"""
search_params = {
"term": convert_to_list(term),
"ids": convert_to_list(ids),
}
response = super().search_with_client(
exact_term_match=None,
response_type=None,
headers=None,
**search_params
)
return StorageTerminalResult(
records=response["data"], reference=response["reference"]
)