transformer
xsdata.codegen.transformer
SupportedType
Bases: NamedTuple
A supported resource model representation.
Attributes:
Name | Type | Description |
---|---|---|
id | int | The integer identifier |
name | str | The name of the resource type |
match_uri | Callable | A callable to match against URI strings |
match_content | Callable | A callable to match against the raw file content |
Source code in xsdata/codegen/transformer.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
|
ResourceTransformer
Orchestrate the code generation from a list of sources.
Supports xsd, wsdl, dtd, xml and json documents.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config | GeneratorConfig | Generator configuration | required |
Attributes:
Name | Type | Description |
---|---|---|
classes | list[Class] | A list of class instances |
processed | list[str] | A list of processed uris |
preloaded | dict | A uri/content map used as cache |
Source code in xsdata/codegen/transformer.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 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 |
|
__init__(config)
Initialize the transformer.
Source code in xsdata/codegen/transformer.py
113 114 115 116 117 118 |
|
process(uris, cache=False)
Process a list of resolved URI strings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of absolute URI strings to process | required |
cache | bool | Specifies whether to catch the initial parsed classes | False |
Source code in xsdata/codegen/transformer.py
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 |
|
process_sources(uris)
Process a list of resolved URI strings.
Load the source URI strings and map them to codegen classes for further processing.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of absolute URI strings to process | required |
Source code in xsdata/codegen/transformer.py
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
|
process_definitions(uris)
Process a list of wsdl resources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of wsdl URI strings to process | required |
Source code in xsdata/codegen/transformer.py
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
process_schemas(uris)
Process a list of xsd resources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of xsd URI strings to process | required |
Source code in xsdata/codegen/transformer.py
190 191 192 193 194 195 196 197 |
|
process_dtds(uris)
Process a list of dtd resources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of dtd URI strings to process | required |
Source code in xsdata/codegen/transformer.py
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
|
process_schema(uri, namespace=None)
Parse and convert schema to codegen models.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uri | str | The schema URI location | required |
namespace | Optional[str] | The target namespace, if the URI is from an inline import | None |
Source code in xsdata/codegen/transformer.py
217 218 219 220 221 222 223 224 225 226 227 |
|
process_xml_documents(uris)
Process a list of xml resources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of xml URI strings to process | required |
Source code in xsdata/codegen/transformer.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
|
process_json_documents(uris)
Process a list of json resources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of json URI strings to process | required |
Source code in xsdata/codegen/transformer.py
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 |
|
process_classes()
Process the generated classes and write or print the output.
Source code in xsdata/codegen/transformer.py
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
|
convert_schema(schema)
Convert a schema instance to codegen classes.
Process recursively any schema imports.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
schema | Schema | The xsd schema instance | required |
Source code in xsdata/codegen/transformer.py
291 292 293 294 295 296 297 298 299 300 301 302 303 |
|
convert_definitions(definitions)
Convert a definitions instance to codegen classes.
Source code in xsdata/codegen/transformer.py
305 306 307 |
|
generate_classes(schema)
Convert the given schema instance to a list of classes.
Source code in xsdata/codegen/transformer.py
309 310 311 312 313 314 315 316 317 318 319 |
|
parse_schema(uri, namespace)
Parse the given URI and return the schema instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uri | str | The resource URI | required |
namespace | Optional[str] | The target namespace | required |
Source code in xsdata/codegen/transformer.py
321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
|
parse_definitions(uri, namespace)
Parse recursively the given URI and return the definitions instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uri | str | The resource URI | required |
namespace | Optional[str] | The target namespace | required |
Source code in xsdata/codegen/transformer.py
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 |
|
load_resource(uri)
Read and return the contents of the given URI.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uri | str | The resource URI | required |
Returns:
Type | Description |
---|---|
Optional[bytes] | The raw bytes content or None if the resource could not be read |
Source code in xsdata/codegen/transformer.py
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
|
classify_resource(uri)
Detect the resource type by the URI extension or the contents.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uri | str | The resource URI | required |
Returns:
Type | Description |
---|---|
int | The resource integer identifier. |
Source code in xsdata/codegen/transformer.py
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
|
analyze_classes(classes)
Analyzer the given class list and return the final list of classes.
Source code in xsdata/codegen/transformer.py
413 414 415 416 417 418 |
|
count_classes(classes)
Return a tuple of counters for the main and inner classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
classes | list[Class] | A list of class instances | required |
Returns:
Type | Description |
---|---|
tuple[int, int] | A tuple of root, inner counters, e.g. (100, 5) |
Source code in xsdata/codegen/transformer.py
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
|
get_cache_file(uris)
classmethod
Return the cache path for the raw mapped classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uris | list[str] | A list of URI strings | required |
Returns:
Type | Description |
---|---|
Path | A temporary file path instance |
Source code in xsdata/codegen/transformer.py
436 437 438 439 440 441 442 443 444 445 446 447 448 |
|