element
xsdata.formats.dataclass.parsers.nodes.element
ElementNode
Bases: XmlNode
XmlNode for complex elements.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meta | XmlMeta | The class binding metadata instance | required |
attrs | dict | The element attributes | required |
ns_map | dict | The element namespace prefix-URI map | required |
config | ParserConfig | The parser config instance | required |
context | XmlContext | The models context instance | required |
position | int | The current objects length, everything after this position are considered children of this node. | required |
mixed | bool | Specifies whether this node supports mixed content. | False |
derived_factory | Optional[type] | Derived element factory | None |
xsi_type | Optional[str] | The xml type substitution | None |
xsi_nil | Optional[bool] | Specifies whether element has the xsi:nil attribute | None |
Attributes:
Name | Type | Description |
---|---|---|
assigned | set[int] | A set to store the processed sub-nodes |
tail_processed | bool | Whether the tail process is consumed |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
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 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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
|
bind(qname, text, tail, objects)
Bind the parsed data into an object for the ending element.
This entry point is called when a xml element ends and is responsible to parse the current element attributes/text, bind any children objects and initialize new object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The element qualified name | required |
text | Optional[str] | The element text content | required |
tail | Optional[str] | The element tail content | required |
objects | list[Any] | The list of intermediate parsed objects | required |
Returns:
Type | Description |
---|---|
bool | Whether the binding process was successful or not. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.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 108 109 110 111 112 113 114 115 116 117 118 |
|
bind_content(params, text, tail, objects)
Parse the text and tail content.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
text | Optional[str] | The element text content | required |
tail | Optional[str] | The element tail content | required |
objects | list[Any] | The list of intermediate parsed objects | required |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
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 |
|
bind_attrs(params)
Parse the element attributes.
Scenarios
- Each attribute matches a class field
- Class has a wildcard field that sucks everything else
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict[str, Any] | The class parameters | required |
Raises:
Type | Description |
---|---|
ParserError | If the document contains an unknown attribute and the configuration is strict. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.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 183 |
|
bind_attr(params, var, value)
Parse an element attribute.
Ignores fields with init==false!
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
var | XmlVar | The xml var instance | required |
value | Any | The attribute value | required |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
|
bind_any_attr(params, var, qname, value)
Parse an element attribute to a wildcard field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
var | XmlVar | The xml var instance | required |
qname | str | The attribute namespace qualified name | required |
value | Any | The attribute value | required |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
208 209 210 211 212 213 214 215 216 217 218 219 220 |
|
bind_objects(params, objects)
Bind children objects.
Emit a warning if an object doesn't fit in any class parameters.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
objects | list | The list of intermediate parsed objects | required |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
|
bind_object(params, qname, value)
Bind a child object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
qname | str | The qualified name of the element | required |
value | Any | The parsed object | required |
Returns:
Type | Description |
---|---|
bool | Whether the parsed object can fit in one of class |
bool | parameters or not. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
|
bind_var(params, var, value)
classmethod
Bind a child object to an element field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
var | XmlVar | The matched xml var instance | required |
value | Any | The parsed object | required |
Returns:
Type | Description |
---|---|
bool | Whether the parsed object can fit in one of class |
bool | parameters or not. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
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 |
|
bind_wild_var(params, var, qname, value)
Bind a child object to a wildcard field.
The wildcard might support one or more values. If it supports only one the values are nested under a parent generic element instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
var | XmlVar | The wildcard var instance | required |
qname | str | The qualified name of the element | required |
value | Any | The parsed value | required |
Returns:
Type | Description |
---|---|
bool | Always true, since wildcard fields can absorb any value. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
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 |
|
bind_mixed_objects(params, var, objects)
Bind children objects to a mixed content wildcard field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
var | XmlVar | The wildcard var instance | required |
objects | list | The list of intermediate parsed objects | required |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
324 325 326 327 328 329 330 331 332 333 334 |
|
prepare_generic_value(qname, value)
Wrap primitive text nodes in a generic element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | Optional[str] | The qualified name of the element | required |
value | Any | The parsed object | required |
Returns:
Type | Description |
---|---|
Any | The original parsed value if it's a data class, or |
Any | the wrapped primitive value in a generic element. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
|
bind_text(params, text)
Bind the element text content.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
text | Optional[str] | The element text content | required |
Returns:
Type | Description |
---|---|
bool | Whether the text content can fit in one of class |
bool | parameters or not. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
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 |
|
bind_wild_text(params, var, text, tail)
Bind the element text and tail content to a wildcard field.
If the field is a list, prepend the text and append the tail content. Otherwise, build a generic element with the text/tail content and any attributes. If the field is already occupied, then this means the current node is a child, and we need to nested them.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params | dict | The class parameters | required |
var | XmlVar | The wildcard var instance | required |
text | Optional[str] | The element text content | required |
tail | Optional[str] | The element text content | required |
Returns:
Type | Description |
---|---|
bool | Whether the text content can fit in one of class |
bool | parameters or not. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
|
child(qname, attrs, ns_map, position)
Initialize the next child node to be queued, when an element starts.
This entry point is responsible to create the next node type with all the necessary information on how to bind the incoming input data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The element qualified name | required |
attrs | dict | The element attributes | required |
ns_map | dict | The element namespace prefix-URI map | required |
position | int | The current length of the intermediate objects | required |
Raises:
Type | Description |
---|---|
ParserError | If the child element is unknown |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
|
build_node(qname, var, attrs, ns_map, position)
Build the next child node based on the xml var instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The element qualified name | required |
var | XmlVar | The xml var instance | required |
attrs | dict | The element attributes | required |
ns_map | dict | The element namespace prefix-URI map | required |
position | int | The current length of the intermediate objects | required |
Returns:
Type | Description |
---|---|
Optional[XmlNode] | The next child node instance, or None if nothing matched |
Optional[XmlNode] | the starting element. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 |
|
build_element_node(clazz, derived, nillable, attrs, ns_map, position, derived_factory, xsi_type=None, xsi_nil=None)
Build the next element child node.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
clazz | type | The target class | required |
derived | bool | Whether derived elements should wrap the parsed object | required |
nillable | bool | Specifies whether nil content is allowed | required |
attrs | dict | The element attributes | required |
ns_map | dict | The element namespace prefix-URI map | required |
position | int | The current length of the intermediate objects | required |
derived_factory | type | The derived factory | required |
xsi_type | Optional[str] | The xml type substitution | None |
xsi_nil | Optional[bool] | Specifies whether the node supports nillable content | None |
Returns:
Type | Description |
---|---|
Optional[ElementNode] | The next child element node instance, or None if the |
Optional[ElementNode] | clazz doesn't match the starting element. |
Source code in xsdata/formats/dataclass/parsers/nodes/element.py
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
|