dict
xsdata.formats.dataclass.parsers.dict
DictDecoder
dataclass
Bind a dictionary or a list of dictionaries to data models.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config | ParserConfig | Parser configuration | ParserConfig() |
context | XmlContext | The models context instance | XmlContext() |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
decode(data, clazz=None)
Parse the input stream into the target class type.
If no clazz is provided, the binding context will try to locate it from imported dataclasses.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | Union[list, dict] | A dictionary or list of dictionaries | required |
clazz | Optional[type[T]] | The target class type to decode the input data | None |
Returns:
Type | Description |
---|---|
T | An instance of the specified class representing the decoded content. |
Source code in xsdata/formats/dataclass/parsers/dict.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
|
verify_type(clazz, data)
Verify the given data matches the given clazz.
If no clazz is provided, the binding context will try to locate it from imported dataclasses.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
clazz | Optional[type[T]] | The target class type to parse object | required |
data | Union[dict, list] | The loaded dictionary or list of dictionaries | required |
Returns:
Type | Description |
---|---|
type[T] | The clazz type to bind the loaded data. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
detect_type(data)
Locate the target clazz type from the data keys.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | Union[dict, list] | The loaded dictionary or list of dictionaries | required |
Returns:
Type | Description |
---|---|
type[T] | The clazz type to bind the loaded data. |
Source code in xsdata/formats/dataclass/parsers/dict.py
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
bind_dataclass(data, clazz)
Create a new instance of the given class type with the given data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | dict | The loaded data | required |
clazz | type[T] | The target class type to bind the input data | required |
Returns:
Type | Description |
---|---|
T | An instance of the class type representing the parsed content. |
Source code in xsdata/formats/dataclass/parsers/dict.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 |
|
bind_derived_dataclass(data, clazz)
Bind the input data to the given class type.
Examples:
{ "qname": "foo", "type": "my:type", "value": {"prop": "value"} }
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | dict | The derived element dictionary | required |
clazz | type[T] | The target class type to bind the input data | required |
Returns:
Type | Description |
---|---|
Any | An instance of the class type representing the parsed content. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
bind_best_dataclass(data, classes)
Bind the input data to all the given classes and return best match.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | dict | The derived element dictionary | required |
classes | Iterable[type[T]] | The target class types to try | required |
Returns:
Type | Description |
---|---|
T | An instance of one of the class types representing the parsed content. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
bind_value(meta, var, value, recursive=False)
Main entry point for binding values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meta | XmlMeta | The parent xml meta instance | required |
var | XmlVar | The xml var descriptor for the field | required |
value | Any | The data value | required |
recursive | bool | Whether this is a recursive call | False |
Returns:
Type | Description |
---|---|
Any | The parsed object |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
bind_text(meta, var, value)
Bind text/tokens value entrypoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meta | XmlMeta | The parent xml meta instance | required |
var | XmlVar | The xml var descriptor for the field | required |
value | Any | The data value | required |
Returns:
Type | Description |
---|---|
Any | The parsed tokens or text value. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
bind_complex_type(meta, var, data)
Bind complex values entrypoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meta | XmlMeta | The parent xml meta instance | required |
var | XmlVar | The xml var descriptor for the field | required |
data | dict | The complex data value | required |
Returns:
Type | Description |
---|---|
Any | The parsed dataclass instance. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
bind_derived_value(meta, var, data)
Bind derived data entrypoint.
The data is representation of a derived element, e.g. { "qname": "foo", "type": "my:type" "value": Any }
The data value can be a primitive value or a complex value.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meta | XmlMeta | The parent xml meta instance | required |
var | XmlVar | The xml var descriptor for the field | required |
data | dict | The derived element data | required |
Returns:
Type | Description |
---|---|
Any | The parsed object. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|
find_var(xml_vars, key, value)
classmethod
Match the name to a xml variable.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
xml_vars | list[XmlVar] | A list of xml vars | required |
key | str | A key from the loaded data | required |
value | Any | The data assigned to the key | required |
Returns:
Type | Description |
---|---|
Optional[XmlVar] | One of the xml vars, if all search attributes match, None otherwise. |
Source code in xsdata/formats/dataclass/parsers/dict.py
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 |
|