container
xsdata.codegen.container
Steps
Process steps.
Source code in xsdata/codegen/container.py
41 42 43 44 45 46 47 48 49 |
|
ClassContainer
Bases: ContainerInterface
A class list wrapper with an easy access api.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config | GeneratorConfig | The generator configuration instance | required |
Attributes:
Name | Type | Description |
---|---|---|
processors | dict[int, list] | A step-processors mapping |
data | dict[str, list[Class]] | The class qname map |
step | int | The current process step |
Source code in xsdata/codegen/container.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 |
|
__init__(config)
Initialize the container and all the class processors.
The order of the steps and the processors is the secret recipe of the xsdata code generator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config | GeneratorConfig | The generator configuration instance | required |
Source code in xsdata/codegen/container.py
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 |
|
__iter__()
Yield an iterator for the class map values.
Source code in xsdata/codegen/container.py
112 113 114 115 |
|
find(qname, condition=return_true)
Find class that matches the given qualified name and condition callable.
Classes are allowed to have the same qualified name, e.g. xsd:Element extending xsd:ComplexType with the same name, you can provide and additional callback to filter the classes like the tag.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The qualified name of the class | required |
condition | Callable | A user callable to filter further | return_true |
Returns:
Type | Description |
---|---|
Optional[Class] | A class instance or None if no match found. |
Source code in xsdata/codegen/container.py
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
|
find_inner(source, qname)
Search by qualified name for a specific inner class or fail.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
source | Class | The source class to search for the inner class | required |
qname | str | The qualified name of the inner class to look up | required |
Returns:
Type | Description |
---|---|
Class | The inner class instance |
Raises:
Type | Description |
---|---|
CodeGenerationError | If the inner class is not found. |
Source code in xsdata/codegen/container.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
|
first(qname)
Return the first class that matches the qualified name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
qname | str | The qualified name of the class | required |
Returns:
Type | Description |
---|---|
Class | The first matching class |
Raises:
Type | Description |
---|---|
KeyError | If no class matches the qualified name |
Source code in xsdata/codegen/container.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
|
process()
Run the processor and filter steps.
Source code in xsdata/codegen/container.py
177 178 179 180 181 182 183 184 185 186 187 188 |
|
validate_classes()
Merge redefined classes.
Source code in xsdata/codegen/container.py
190 191 192 193 |
|
process_classes(step)
Run the given step processors for all classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
step | int | The step reference number | required |
Source code in xsdata/codegen/container.py
195 196 197 198 199 200 201 202 203 204 |
|
process_class(target, step)
Run the step processors for the given class.
Process recursively any inner classes as well.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
target | Class | The target class to process | required |
step | int | The step reference number | required |
Source code in xsdata/codegen/container.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
|
designate_classes()
Designate the final class names, packages and modules.
Source code in xsdata/codegen/container.py
226 227 228 229 230 231 232 233 234 235 236 237 |
|
filter_classes()
Filter the classes to be generated.
Source code in xsdata/codegen/container.py
239 240 241 242 |
|
remove_groups()
Remove xs:groups and xs:attributeGroups from the container.
Source code in xsdata/codegen/container.py
244 245 246 |
|
add(item)
Add class item to the container.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
item | Class | The class instance to add | required |
Source code in xsdata/codegen/container.py
248 249 250 251 252 253 254 |
|
remove(*items)
Safely remove classes from the container.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
items | Class | The classes to remove | () |
Source code in xsdata/codegen/container.py
256 257 258 259 260 261 262 263 264 265 |
|
reset(item, qname)
Update the given class qualified name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
item | Class | The target class instance to update | required |
qname | str | The new qualified name of the class | required |
Source code in xsdata/codegen/container.py
267 268 269 270 271 272 273 274 275 |
|
set(items)
Set the list of classes to the container.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
items | list[Class] | The list of classes | required |
Source code in xsdata/codegen/container.py
277 278 279 280 281 282 283 284 |
|
extend(items)
Add a list of classes to the container.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
items | list[Class] | The list of class instances to add | required |
Source code in xsdata/codegen/container.py
286 287 288 289 290 291 292 |
|