/
attributes.py
98 lines (71 loc) · 5.22 KB
/
attributes.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
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fattributes.ipynb)
"""
from typing import List, Union
from vortexasdk.endpoints.endpoints import ATTRIBUTES_REFERENCE
from vortexasdk.endpoints.attributes_result import AttributeResult
from vortexasdk.operations import Reference, Search
from vortexasdk.utils import convert_to_list
class Attributes(Reference, Search):
"""
Attributes endpoint.
An Attribute is a reference value that corresponds to an ID associated with other entities.
For example, a vessel object from the Vessel reference endpoint may have the following keys:
```json
{
"ice_class": "b09ed4e2bd6904dd",
"propulsion": "3ace0e050724707b"
}
```
These IDs represent attributes which can be found via the Attributes reference endpoint.
When the attributes endpoint is searched with those ids as parameters:
```python
>>> from vortexasdk import Attributes
>>> df = Attributes().search(ids=["b09ed4e2bd6904dd", "3ace0e050724707b"]).to_df()
```
Returns
| | id | type | label |
|---:|:-----------------|:-----------|:---------|
| 0 | b09ed4e2bd6904dd | ice_class | UNKNOWN |
| 1 | 3ace0e050724707b | propulsion | DFDE |
"""
def __init__(self):
Reference.__init__(self, ATTRIBUTES_REFERENCE)
Search.__init__(self, ATTRIBUTES_REFERENCE)
def load_all(self) -> AttributeResult:
"""
Load all attributes.
"""
return self.search()
# noinspection PyShadowingBuiltins
def search(
self,
type: str = None,
term: Union[str, List[str]] = None,
ids: Union[str, List[str]] = None,
) -> AttributeResult:
"""
Find all attributes matching given type.
# Arguments
type: The type of attribute we're filtering on. Type can be: `ice_class`, `propulsion`, `scrubber`
# Returns
List of attributes matching `type`
# Examples
Find all attributes with a type of `ice_class`.
```python
>>> from vortexasdk import Attributes
>>> df = Attributes().search(type="scrubber").to_df()
```
returns
| | id | name | type |
|---:|:-----------------|:-----------|:------------|
| 0 | 14c7b073809eb565 | Open Loop | scrubber |
| 1 | 478fca39000c49d6 | Unknown | scrubber |
"""
search_params = {
"term": [str(e) for e in convert_to_list(term)],
"ids": convert_to_list(ids),
"type": type,
}
return AttributeResult(super().search(**search_params))