filters
xsdata.formats.dataclass.filters
Filters
Jinja filters for code generation.
Source code in xsdata/formats/dataclass/filters.py
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 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 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 |
|
__init__(config)
Initialize the filters.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
register(env)
Register the template filters to the jinja environment.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
build_class_annotation(fmt)
classmethod
Build the class annotations.
Source code in xsdata/formats/dataclass/filters.py
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
|
class_params(obj)
Yield the class variables with their docstring text.
Source code in xsdata/formats/dataclass/filters.py
169 170 171 172 173 174 175 176 177 178 |
|
class_name(name)
Class name filter.
Steps
- Apply substitutions before naming conventions
- Apply naming convention
- Apply substitutions after naming conventions
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | The original class name | required |
Returns:
Type | Description |
---|---|
str | The final class name |
Source code in xsdata/formats/dataclass/filters.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
class_bases(obj, class_name)
Return a list of base class names.
Source code in xsdata/formats/dataclass/filters.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
|
class_annotations(obj, class_name)
Return a list of decorator names.
Source code in xsdata/formats/dataclass/filters.py
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
|
apply_substitutions(name, obj_type)
Apply name substitutions by obj type.
Source code in xsdata/formats/dataclass/filters.py
230 231 232 233 234 235 |
|
field_definition(obj, attr, parent_namespace)
Return the field definition with any extra metadata.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
field_name(name, class_name)
Field name filter.
Steps
- Apply substitutions before naming conventions
- Apply naming convention
- Apply substitutions after naming conventions
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | The original field name | required |
class_name | str | The class name, some naming conventions require it | required |
Returns:
Type | Description |
---|---|
str | The final field name |
Source code in xsdata/formats/dataclass/filters.py
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
|
constant_name(name, class_name)
Constant name filter.
Steps
- Apply substitutions before naming conventions
- Apply naming convention
- Apply substitutions after naming conventions
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | The original constant name | required |
class_name | str | The class name, some naming conventions require it | required |
Returns:
Type | Description |
---|---|
str | The final constant name |
Source code in xsdata/formats/dataclass/filters.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
|
module_name(name)
Module name filter.
Steps
- Apply substitutions before naming conventions
- Apply naming convention
- Apply substitutions after naming conventions
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | The original module name | required |
Returns:
Type | Description |
---|---|
str | The final module name |
Source code in xsdata/formats/dataclass/filters.py
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
|
package_name(name)
Package name filter.
Steps
- Apply substitutions before naming conventions
- Apply naming convention
- Apply substitutions after naming conventions
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | The original package name | required |
Returns:
Type | Description |
---|---|
str | The final package name |
Source code in xsdata/formats/dataclass/filters.py
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 |
|
type_name(attr_type)
Field type filter.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
attr_type | AttrType | The attr type instance. | required |
Returns:
Type | Description |
---|---|
str | The python type name or the user type final name |
Source code in xsdata/formats/dataclass/filters.py
351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
safe_name(name, prefix, name_case, **kwargs)
Sanitize names for safe generation.
Source code in xsdata/formats/dataclass/filters.py
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
import_module(module, from_module)
Convert import module to relative path if config is enabled.
Source code in xsdata/formats/dataclass/filters.py
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
|
import_class(name, alias)
Convert import class name with alias support.
Source code in xsdata/formats/dataclass/filters.py
407 408 409 410 411 412 |
|
post_meta_hook(obj)
Plugin hook to render additional information after the xsdata meta class.
Source code in xsdata/formats/dataclass/filters.py
414 415 416 |
|
field_metadata(obj, attr, parent_namespace)
Return a metadata dictionary for the given attribute.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
field_choices(obj, attr, parent_namespace)
Return a tuple of field metadata if the attr has choices.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
filter_metadata(data)
classmethod
Filter out false,none keys from the given dict.
Source code in xsdata/formats/dataclass/filters.py
495 496 497 498 499 500 501 502 |
|
format_arguments(data, indent=0)
Return a pretty keyword arguments representation.
Source code in xsdata/formats/dataclass/filters.py
504 505 506 507 508 509 510 511 512 513 |
|
format_metadata(data, indent=0, key='')
Prettify field metadata for code generation.
Source code in xsdata/formats/dataclass/filters.py
515 516 517 518 519 520 521 522 523 524 525 526 |
|
format_dict(data, indent)
Return a pretty string representation of a dict.
Source code in xsdata/formats/dataclass/filters.py
528 529 530 531 532 533 534 535 536 537 |
|
format_iterable(data, indent)
Return a pretty string representation of an iterable.
Source code in xsdata/formats/dataclass/filters.py
539 540 541 542 543 544 545 546 547 |
|
format_string(data, indent, key='', pad=0)
Return a pretty string representation of a string.
If the total length of the input string plus indent plus the key length and the additional pad is more than the max line length, wrap the text into multiple lines, avoiding breaking long words
Source code in xsdata/formats/dataclass/filters.py
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 |
|
text_wrap(string, offset=0, subsequent_indent=' ')
Wrap text in respect to the max line length and the given offset.
Source code in xsdata/formats/dataclass/filters.py
595 596 597 598 599 600 601 602 603 604 605 606 607 608 |
|
clean_docstring(string, escape=True)
classmethod
Prepare string for docstring generation.
- Strip whitespace from each line
- Replace triple double quotes with single quotes
- Escape backslashes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
string | Optional[str] | input value | required |
escape | bool | skip backslashes escape, if string is going to pass through formatting. | True |
Returns:
Type | Description |
---|---|
str | The cleaned docstring text. |
Source code in xsdata/formats/dataclass/filters.py
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 |
|
format_docstring(doc_string, level)
Format doc strings.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
field_default_value(attr, ns_map=None)
Generate the field default value/factory for the given attribute.
Source code in xsdata/formats/dataclass/filters.py
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 |
|
field_default_enum(attr)
Generate the default value for enum fields.
Source code in xsdata/formats/dataclass/filters.py
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 |
|
field_default_tokens(attr, types, ns_map)
Generate the default value for tokens fields.
Source code in xsdata/formats/dataclass/filters.py
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 |
|
field_type(obj, attr)
Generate type hints for the given attr.
Source code in xsdata/formats/dataclass/filters.py
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 |
|
compound_field_types(obj, attr)
Generate type hint for a compound field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Class | The parent class instance | required |
attr | Attr | The compound attr instance | required |
Returns:
Type | Description |
---|---|
str | The string representation of the type hint. |
Source code in xsdata/formats/dataclass/filters.py
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 |
|
choice_type(obj, choice)
Generate type hints for the given choice.
Choices support a subset of features from normal attributes. First of all we don't have a proper type hint but a type metadata key. That's why we always need to wrap as Type[xxx]. The second big difference is that our choice belongs to a compound field that might be a list, that's why list restriction is also ignored.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Class | The parent class instance | required |
choice | Attr | The choice instance | required |
Returns:
Type | Description |
---|---|
str | The string representation of the type hint. |
Source code in xsdata/formats/dataclass/filters.py
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 |
|
constant_value(attr)
Return the attr default value or type as constant value.
Source code in xsdata/formats/dataclass/filters.py
862 863 864 865 866 867 868 869 870 871 |
|
default_imports(output)
Generate the default imports for the given package output.
Source code in xsdata/formats/dataclass/filters.py
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 |
|
build_import_patterns()
classmethod
Build import search patterns.
Source code in xsdata/formats/dataclass/filters.py
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 |
|
build_type_patterns(x)
classmethod
Return all possible type occurrences in the generated code.
Source code in xsdata/formats/dataclass/filters.py
927 928 929 930 931 932 933 934 935 936 937 938 939 |
|