adapter¶
Structure
¶
Bases: EntryAdapter
Lazy structure resource converter.
Go to EntryAdapter
to see the full list of methods
and properties.
Attributes:
Name | Type | Description |
---|---|---|
ENTRY_RESOURCE |
type[StructureResource]
|
This adapter stores entry resources as
|
_type_converters |
dict[str, Callable]
|
Dictionary of valid conversion types for entry. Currently available types:
|
_type_ingesters |
dict[str, Callable]
|
Dictionary of valid ingesters. |
as_<_type_converters> |
dict[str, Callable]
|
Convert entry to a type listed in |
from_<_type_converters> |
dict[str, Callable]
|
Convert an external type to an OPTIMADE
|
Source code in optimade/adapters/structures/adapter.py
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 |
|
entry: EntryResource
property
¶
__getattr__(name)
¶
Get converted entry or attribute from OPTIMADE entry.
Support any level of "."-nested OPTIMADE ENTRY_RESOURCE
attributes, e.g.,
attributes.species
for StuctureResource
.
Note
All nested attributes must individually be subclasses of pydantic.BaseModel
,
i.e., one can not access nested attributes in lists by passing a "."-nested name
to this method,
e.g., attributes.species.name
or attributes.species[0].name
will not work for variable name
.
Order:
- Try to return converted entry if using
as_<_type_converters key>
. - Try to return OPTIMADE
ENTRY_RESOURCE
(nested) attribute. - Try to return OPTIMADE
ENTRY_RESOURCE.attributes
(nested) attribute. - Raise
AttributeError
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Requested attribute. |
required |
Raises:
Type | Description |
---|---|
AttributeError
|
If the requested attribute is not recognized. See above for the description of the order in which an attribute is tested for validity. |
Source code in optimade/adapters/base.py
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 |
|
__init__(entry)
¶
Parameters:
Name | Type | Description | Default |
---|---|---|---|
entry
|
dict
|
A JSON OPTIMADE single resource entry. |
required |
Source code in optimade/adapters/base.py
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
convert(format)
¶
Convert OPTIMADE entry to desired format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
format
|
str
|
Type or format to which the entry should be converted. |
required |
Raises:
Type | Description |
---|---|
AttributeError
|
If |
Returns:
Type | Description |
---|---|
Any
|
The converted entry according to the desired format or type. |
Source code in optimade/adapters/base.py
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 |
|
from_url(url)
classmethod
¶
Convert OPTIMADE URL into the target entry type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url
|
str
|
The OPTIMADE URL to convert. |
required |
Returns:
Type | Description |
---|---|
Any
|
The converted URL. |
Source code in optimade/adapters/base.py
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 |
|
ingest_from(data, format=None)
classmethod
¶
Convert desired format to OPTIMADE format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
Any
|
The data to convert. |
required |
format
|
str
|
Type or format to which the entry should be converted. |
None
|
Raises:
Type | Description |
---|---|
AttributeError
|
If |
Returns:
Type | Description |
---|---|
Any
|
The ingested Structure. |
Source code in optimade/adapters/base.py
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 |
|