hololinked.metadata.td.tm.ThingModel
Bases: WoTSchema, Metadata
Thing Model as per W3C WoT Thing Description v1.1.
Source code in repo/hololinked/hololinked/metadata/td/tm.py
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 | |
Attributes
skip_actions
class-attribute
List of default action names to skip when generating the metadata. Different from skip_names as
this list is supposed to be used as a builtin blacklist.
skip_events
class-attribute
List of default event names to skip when generating the metadata. Different from skip_names as
this list is supposed to be used as a builtin blacklist.
skip_properties
class-attribute
List of default property names to skip when generating the metadata. Different from skip_names as
this list is supposed to be used as a builtin blacklist.
Functions
add_interaction_affordances
Add interaction affordances to the thing model.
Raises:
| Type | Description |
|---|---|
ValueError
|
If the thing instance is not attached to the thing model. Usually, when API first approach is used, the thing instance could not yet be instantiated. This method is not to be used at that time. |
Source code in repo/hololinked/hololinked/metadata/td/tm.py
from_file
classmethod
from_file(path: str | PathLike, strict: bool = True, format: Literal['json', 'yaml'] | None = None) -> ThingModel
Load a Thing Description or a plain Thing Model from a JSON or a YAML file.
A YAML file must hold only JSON types: unquoted dates stay strings, only true and false are booleans and
numbers follow the JSON grammar. Loading YAML needs the yaml extra (pip install hololinked[yaml]).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str | PathLike
|
path of the file |
required |
|
bool
|
Unknown keys will raise an error if strict is True. |
True
|
|
Literal['json', 'yaml'] | None
|
format of the file, by default YAML if the file ends with |
None
|
Returns:
| Type | Description |
|---|---|
ThingModel
|
the model with its properties, actions and events, not attached to a Thing instance |
Source code in repo/hololinked/hololinked/metadata/td/tm.py
from_metadata
classmethod
Convert a JSON specification of a Thing Description or a Thing Model into a ThingModel instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
dict[str, Any]
|
the Thing Description or Thing Model JSON |
required |
|
bool
|
Unknown keys will raise an error if True, default True |
True
|
Returns:
| Type | Description |
|---|---|
ThingModel
|
the model with its properties, actions and events, not attached to a Thing instance |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
if the Thing Model uses |
Source code in repo/hololinked/hololinked/metadata/td/tm.py
generate
Populate the thing model.
Returns:
| Type | Description |
|---|---|
ThingModel
|
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If the thing instance is not attached to the thing model. Usually, when API first approach is used, the thing instance could not yet be instantiated. This method is not to be used at that time. |
Source code in repo/hololinked/hololinked/metadata/td/tm.py
model_dump
Return the JSON representation.
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
JSON representation |
Source code in repo/hololinked/hololinked/metadata/td/tm.py
produce
Create a Thing instance based on the Thing Model, possibly binding with an existing implementation object impl.
Members of the impl must implement the interactions by name:
- a method must implement an action
- a property must be implemented as a plain attribute or a python property descriptor
Events do not have a mapping and are created based on the Thing Model definition, accessible at runtime.
If custom objects implement properties and actions, use the property_impl and action_impl keyword arguments
to provide the corresponding implementation objects.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
Any
|
the object implementing the Thing Model, can be |
required |
|
str
|
id of the |
required |
|
str
|
validator type for payloads, usually pydantic for pydantic models |
'pydantic'
|
|
Any
|
Additional keyword arguments:
|
{}
|
Returns:
| Type | Description |
|---|---|
Thing
|
the created |
Raises:
| Type | Description |
|---|---|
ConformanceError
|
listing every member that does not match the Thing Model |
Source code in repo/hololinked/hololinked/metadata/td/tm.py
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 | |