generator
xsdata.formats.dataclass.generator
DataclassGenerator
Bases: AbstractGenerator
Python dataclasses code generator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config | GeneratorConfig | The generator config instance | required |
Attributes:
Name | Type | Description |
---|---|---|
env | The jinja2 environment instance | |
filters | The template filters instance |
Source code in xsdata/formats/dataclass/generator.py
13 14 15 16 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 |
|
get_template_paths()
classmethod
Return a list of template paths to feed the jinja2 loader.
Source code in xsdata/formats/dataclass/generator.py
40 41 42 43 |
|
render(classes)
Render the given classes to python packages and modules.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
classes | List[Class] | A list of class instances | required |
Yields:
Type | Description |
---|---|
GeneratorResult | An iterator of generator result instances. |
Source code in xsdata/formats/dataclass/generator.py
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 |
|
render_package(classes, module)
Render the package for the given classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
classes | List[Class] | A list of class instances | required |
module | str | The target dot notation path | required |
Returns:
Type | Description |
---|---|
str | The rendered package output. |
Source code in xsdata/formats/dataclass/generator.py
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
render_module(resolver, classes)
Render the module for the given classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
resolver | DependenciesResolver | The dependencies resolver | required |
classes | List[Class] | A list of class instances | required |
Returns:
Type | Description |
---|---|
str | The rendered module output. |
Source code in xsdata/formats/dataclass/generator.py
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 |
|
render_classes(classes, module_namespace)
Render the classes source code in a module.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
classes | List[Class] | A list of class instances | required |
module_namespace | Optional[str] | The module namespace URI | required |
Returns:
Type | Description |
---|---|
str | The rendered classes source code output. |
Source code in xsdata/formats/dataclass/generator.py
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 |
|
module_name(name)
Convert the given module name to safe snake case.
Source code in xsdata/formats/dataclass/generator.py
165 166 167 |
|
package_name(name)
Convert the given package name to safe snake case.
Source code in xsdata/formats/dataclass/generator.py
169 170 171 |
|
ensure_packages(package)
classmethod
Ensure init.py files exists recursively in the package.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
package | Path | The package file path | required |
Yields:
Type | Description |
---|---|
GeneratorResult | An iterator of generator result instances. |
Source code in xsdata/formats/dataclass/generator.py
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
|
init_filters(config)
classmethod
Initialize the filters instance by the generator configuration.
Source code in xsdata/formats/dataclass/generator.py
192 193 194 195 |
|