schema
xsdata.codegen.parsers.schema
SchemaParser
dataclass
Bases: UserXmlParser
Xml schema definition parser.
Apply implied rules, set indexes, resolve location paths...
Parameters:
Name | Type | Description | Default |
---|---|---|---|
location | Optional[str] | The schema location uri | None |
target_namespace | Optional[str] | The schema target namespace | None |
Attributes:
Name | Type | Description |
---|---|---|
index | int | The current element index |
indices | List[int] | The child element indices |
element_form | Optional[str] | The schema element form |
attribute_form | Optional[str] | The schema attribute form |
default_attributes | Optional[str] | The schema default attributes |
default_open_content | Optional[DefaultOpenContent] | The schema default open content |
Source code in xsdata/codegen/parsers/schema.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 |
|
start(clazz, queue, objects, qname, attrs, ns_map)
Build and queue the XmlNode for the starting element.
Override to set the current element index and append it in child element indices.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
clazz | Optional[Type[T]] | The target class type, auto locate if omitted | required |
queue | List[XmlNode] | The XmlNode queue list | required |
objects | List[Parsed] | The list of all intermediate parsed objects | required |
qname | str | The element qualified name | required |
attrs | Dict | The element attributes | required |
ns_map | Dict | The element namespace prefix-URI map | required |
Source code in xsdata/codegen/parsers/schema.py
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 |
|
end(queue, objects, qname, text, tail)
Parse the last xml node and bind any intermediate objects.
Override to set the xsd model index and ns map.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
queue | List[XmlNode] | The XmlNode queue list | required |
objects | List[Parsed] | The list of all intermediate parsed objects | required |
qname | str | The element qualified name | required |
text | Optional[str] | The element text content | required |
tail | Optional[str] | The element tail content | required |
Returns:
Type | Description |
---|---|
Any | Whether the binding process was successful. |
Source code in xsdata/codegen/parsers/schema.py
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 |
|
start_schema(attrs)
Start schema element entrypoint.
Store the element/attribute default forms and the default attributes, for later processing.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
attrs | Dict[str, str] | The element attributes | required |
Source code in xsdata/codegen/parsers/schema.py
105 106 107 108 109 110 111 112 113 114 115 116 117 |
|
end_schema(obj)
End schema element entrypoint.
Normalize various properties for the schema and it's children.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd schema instance. | required |
Source code in xsdata/codegen/parsers/schema.py
119 120 121 122 123 124 125 126 127 128 129 130 131 |
|
end_attribute(obj)
End attribute element entrypoint.
Assign the schema's default form in the attribute instance, if it doesn't define its own.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd attribute instance | required |
Source code in xsdata/codegen/parsers/schema.py
133 134 135 136 137 138 139 140 141 142 143 144 |
|
end_complex_type(obj)
End complex type element entrypoint.
Post parsing processor to apply default open content and attributes if applicable.
Default open content doesn't apply if the current complex type has one of complex content, simple content or has its own open content.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd complex type instance | required |
Source code in xsdata/codegen/parsers/schema.py
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 |
|
end_default_open_content(obj)
End default open content element entrypoint.
If the open content element mode is suffix, adjust the index to trick later processors into putting attrs derived from this open content last in the generated classes.
Store the obj for later processing.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd default open content instance | required |
.
Source code in xsdata/codegen/parsers/schema.py
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
end_element(obj)
End element entrypoint.
Assign the schema's default form in the element instance, if it doesn't define its own.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd element instance | required |
Source code in xsdata/codegen/parsers/schema.py
196 197 198 199 200 201 202 203 204 205 206 |
|
end_extension(obj)
End extension element entrypoint.
Assign the schema's default open content in the extension instance, if it doesn't define its own.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd extension instance | required |
Source code in xsdata/codegen/parsers/schema.py
208 209 210 211 212 213 214 215 216 217 218 |
|
end_open_content(obj)
classmethod
End open content element entrypoint.
If the open content element mode is suffix, adjust the index to trick later processors into putting attrs derived from this open content last in the generated classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd open content instance | required |
Source code in xsdata/codegen/parsers/schema.py
220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
|
end_restriction(obj)
End restriction element entrypoint.
Assign the schema's default open content in the restriction instance, if it doesn't define its own.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | T | The xsd restriction instance | required |
Source code in xsdata/codegen/parsers/schema.py
235 236 237 238 239 240 241 242 243 244 245 |
|
set_schema_forms(obj)
Cascade schema forms to elements and attributes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Schema | The xsd schema instance | required |
Source code in xsdata/codegen/parsers/schema.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
|
set_schema_namespaces(obj)
Set the schema target namespace.
If the schema was imported and doesn't have a target namespace, it automatically inherits the parent schema target namespace.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Schema | The xsd schema instance | required |
Source code in xsdata/codegen/parsers/schema.py
264 265 266 267 268 269 270 271 272 273 |
|
resolve_schemas_locations(obj)
Resolve the location attributes of the schema.
This method covers relative paths and implied schema locations to common namespaces like xsi, xlink.
Schema elements with location attribute
- override
- redefines
- include
- import
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Schema | The xsd schema instance | required |
Source code in xsdata/codegen/parsers/schema.py
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 |
|
resolve_path(location)
Resolve the given location string.
Use the parser location attribute as the base uri.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
location | Optional[str] | The location uri | required |
Returns:
Type | Description |
---|---|
Optional[str] | The resolved location or None if it was not resolved |
Source code in xsdata/codegen/parsers/schema.py
306 307 308 309 310 311 312 313 314 315 316 317 |
|
resolve_local_path(location, namespace)
Resolve the given namespace to one of the local standard schemas.
w3.org protects against fetching common schemas not from a browser, instead we use the local xsdata copies.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
location | Optional[str] | The schema location | required |
namespace | Optional[str] | The schema namespace | required |
Returns:
Type | Description |
---|---|
Optional[str] | The local path or the absolute remote uri. |
Source code in xsdata/codegen/parsers/schema.py
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
|
has_elements(obj)
classmethod
Helper function to check if instance has children.
Valid children: xs:element, xs:any, xs:group.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | ElementBase | The element base instance | required |
Returns:
Type | Description |
---|---|
bool | The bool result. |
Source code in xsdata/codegen/parsers/schema.py
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
|
set_namespace_map(obj, ns_map)
classmethod
Add common namespaces like xml, xsi, xlink if they are missing.
These prefixes are implied and we need to support them.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Any | A xsd model instance | required |
ns_map | Optional[Dict] | The namespace prefix-URI map | required |
Source code in xsdata/codegen/parsers/schema.py
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
|
set_index(obj, index)
classmethod
Helper method to set an object's index.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Any | A xsd model instance | required |
index | int | The index number | required |
Source code in xsdata/codegen/parsers/schema.py
388 389 390 391 392 393 394 395 396 397 |
|
add_default_imports(obj)
classmethod
Add missing imports to the standard schemas.
We might need to generate the classes from these common schemas, so add these implied imports.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj | Schema | The xsd schema instance | required |
Source code in xsdata/codegen/parsers/schema.py
399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
|