mixins
xsdata.formats.dataclass.serializers.mixins
XmlWriterEvent
Event names.
Source code in xsdata/formats/dataclass/serializers/mixins.py
35 36 37 38 39 40 41 |
|
XmlWriter
Bases: ABC
A consistency wrapper for sax content handlers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config | SerializerConfig | The serializer config instance | required |
output | TextIO | The output stream to write the result | required |
ns_map | Dict | A user defined namespace prefix-URI map | required |
Attributes:
Name | Type | Description |
---|---|---|
handler | The content handler instance | |
in_tail | Specifies whether the text content has been written | |
tail | Optional[str] | The current element tail content |
attrs | Dict | The current element attributes |
ns_context | List[Dict] | The namespace context queue |
pending_tag | Optional[Tuple] | The pending element namespace, name tuple |
pending_prefixes | List[List] | The pending element namespace prefixes |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
build_handler()
abstractmethod
Build the content handler instance.
Returns:
Type | Description |
---|---|
ContentHandler | A content handler instance. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
102 103 104 105 106 107 108 |
|
write(events)
Feed the sax content handler with events.
The receiver will also add additional root attributes like xsi or no namespace location.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
events | EventIterator | An iterator of sax events | required |
Raises:
Type | Description |
---|---|
XmlWriterError | On unknown events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
start_document()
Start document notification receiver.
Write the xml version and encoding, if the configuration is enabled.
Source code in xsdata/formats/dataclass/serializers/mixins.py
152 153 154 155 156 157 158 159 160 |
|
start_tag(qname)
Start tag notification receiver.
The receiver will flush the start of any pending element, create new namespaces context and queue the current tag for generation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The qualified name of the starting element | required |
Source code in xsdata/formats/dataclass/serializers/mixins.py
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|
add_attribute(qname, value, root=False)
Add attribute notification receiver.
The receiver will convert the key to a namespace, name tuple and convert the value to string. Internally the converter will also generate any missing namespace prefixes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The qualified name of the attribute | required |
value | Any | The value of the attribute | required |
root | bool | Specifies if attribute is for the root element | False |
Raises:
Type | Description |
---|---|
XmlWriterError | If it's not a root element attribute and not no element is pending to start. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
|
add_namespace(uri)
Add the given uri to the current namespace context.
If the uri empty or a prefix already exists, skip silently.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uri | Optional[str] | The namespace URI | required |
Source code in xsdata/formats/dataclass/serializers/mixins.py
204 205 206 207 208 209 210 211 212 213 |
|
set_data(data)
Set data notification receiver.
The receiver will convert the data to string, flush any previous pending start element and send it to the handler for generation.
If the text content of the tag has already been generated then treat the current data as element tail content and queue it to be generated when the tag ends.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | Any | The element text or tail content | required |
Source code in xsdata/formats/dataclass/serializers/mixins.py
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
|
end_tag(qname)
End tag notification receiver.
The receiver will flush if pending the start of the element, end the element, its tail content and its namespaces prefix mapping and current context.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The qualified name of the element | required |
Source code in xsdata/formats/dataclass/serializers/mixins.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
|
flush_start(is_nil=True)
Flush start notification receiver.
The receiver will pop the xsi:nil attribute if the element is not empty, prepare and send the namespace prefix-URI map and the element with its attributes to the content handler for generation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
is_nil | bool | Specify if the element requires | True |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
start_namespaces()
Send the current namespace prefix-URI map to the content handler.
Save the list of prefixes to be removed at the end of the current pending tag.
Source code in xsdata/formats/dataclass/serializers/mixins.py
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
|
reset_default_namespace()
Reset the default namespace if the pending element is not qualified.
Source code in xsdata/formats/dataclass/serializers/mixins.py
312 313 314 315 |
|
is_xsi_type(qname, value)
classmethod
Return whether the value is a xsi:type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The attribute qualified name | required |
value | Any | The attribute value | required |
Returns:
Type | Description |
---|---|
bool | The bool result. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
|
encode_data(data)
Encode data for xml rendering.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | Any | The content to encode/serialize | required |
Returns:
Type | Description |
---|---|
Optional[str] | The xml encoded data |
Source code in xsdata/formats/dataclass/serializers/mixins.py
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
|
EventGenerator
dataclass
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 |
|
generate(obj)
Convert a user model, or derived element instance to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Any | A user model, or derived element instance | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
|
convert_dataclass(obj, namespace=None, qname=None, nillable=False, xsi_type=None)
Convert a model instance to sax events.
Optionally override the qualified name and the xsi attributes type and nil.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Any | A model instance | required |
namespace | Optional[str] | The field namespace URI | None |
qname | Optional[str] | Override the field qualified name | None |
nillable | bool | Specifies whether the field is nillable | False |
xsi_type | Optional[str] | Override the field xsi type | None |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
convert_xsi_type(value, var, namespace)
Convert a xsi:type value to sax events.
The value can be assigned to wildcard, element or compound fields
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A model instance | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The field namespace URI | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
convert_value(value, var, namespace)
Convert any value to sax events according to the var instance.
The order of the checks is important as more than one condition can be true.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | The input value | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace URI | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
convert_list(values, var, namespace)
Convert an array of values to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
values | Iterable | A list, set, tuple instance | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 |
|
convert_tokens(value, var, namespace)
Convert an array of token values to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list, set, tuple instance | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
|
convert_mixed_content(values, var, namespace)
Convert mixed content values to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
values | List | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
|
convert_any_type(value, var, namespace)
Convert a value assigned to a xs:anyType field to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 |
|
convert_derived_element(value, namespace)
Convert a derived element instance to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
convert_any_element(value, var, namespace)
Convert a generic any element instance to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
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 |
|
xsi_type(var, value, namespace)
Return the xsi:type for the given value and field metadata instance.
If the value type is either a child or parent for one of the var types, we need to declare it as n xsi:type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Raises:
Type | Description |
---|---|
SerializerError | If the value type is completely unrelated to the field types. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 |
|
convert_elements(value, var, namespace)
Convert the value assigned to a compound field to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 |
|
convert_choice(value, var, namespace)
Convert a single value assigned to a compound field to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Raises:
Type | Description |
---|---|
SerializerError | If the value doesn't match any choice field. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
|
convert_element(value, var, namespace)
Convert a value assigned to an element field to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
namespace | Optional[str] | The class namespace (unused) | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 |
|
convert_data(value, var)
classmethod
Convert a value assigned to a text field to sax events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | A list instance of mixed type values | required |
var | XmlVar | The field metadata instance | required |
Yields:
Type | Description |
---|---|
EventIterator | An iterator of sax events. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
755 756 757 758 759 760 761 762 763 764 765 766 |
|
next_value(obj, meta)
classmethod
Produce the next non attribute value of a model instance to convert.
The generator will produce the values in the order the fields are defined in the model or by their sequence number.
Sequential fields need to be rendered together in parallel order eg:
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Any | The input model instance | required |
meta | XmlMeta | The model metadata instance | required |
Yields:
Type | Description |
---|---|
XmlVar | An iterator of field metadata instance and value tuples. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
|
next_attribute(obj, meta, nillable, xsi_type, ignore_optionals)
classmethod
Produce the next attribute value to convert.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Any | The input model instance | required |
meta | XmlMeta | The model metadata instance | required |
nillable | bool | Specifies if the current element supports nillable content | required |
xsi_type | Optional[str] | The real xsi:type of the object | required |
ignore_optionals | bool | Specifies if optional attributes with default values should be ignored. | required |
Yields:
Type | Description |
---|---|
str | An iterator of attribute name-value pairs. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 |
|
encode_primitive(value, var)
classmethod
Encode a value for xml serialization.
Converts values to strings. QName instances is an exception, those values need to wait until the XmlWriter assigns prefixes to namespaces per element node. Enums and Tokens may contain QName(s) so they also get a special treatment.
We can't do all the conversions in the writer because we would need to carry the xml vars inside the writer. Instead of that we do the easy encoding here and leave the qualified names for later.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | Any | The simple type vale to encode | required |
var | XmlVar | The field metadata instance | required |
Returns:
Type | Description |
---|---|
Any | The encoded value. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
|
real_xsi_type(qname, target_qname)
classmethod
Compare the qname with the target qname and return the real xsi:type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The field type qualified name | required |
target_qname | Optional[str] | The value type qualified name | required |
Returns:
Type | Description |
---|---|
Optional[str] | None if the qname and target qname match, otherwise |
Optional[str] | return the target qname. |
Source code in xsdata/formats/dataclass/serializers/mixins.py
898 899 900 901 902 903 904 905 906 907 908 909 910 |
|