xsdata.models.config module¶
-
class
xsdata.models.config.
OutputFormat
(value)[source]¶ Bases:
enum.Enum
Available output formats: pydata (dataclasses), PlantUML class diagram.
-
DATACLASS
= 'pydata'¶
-
PLANTUML
= 'plantuml'¶
-
-
class
xsdata.models.config.
OutputStructure
(value)[source]¶ Bases:
enum.Enum
Available output structure strategies, based on filenames or the target namespaces.
-
FILENAMES
= 'filenames'¶
-
NAMESPACES
= 'namespaces'¶
-
-
class
xsdata.models.config.
NameCase
(value)[source]¶ Bases:
enum.Enum
Available naming schemes, pascal, snake, camel, mixed and mixed underscore.
-
PASCAL
= 'pascalCase'¶
-
CAMEL
= 'camelCase'¶
-
SNAKE
= 'snakeCase'¶
-
MIXED
= 'mixedCase'¶
-
MIXED_SNAKE
= 'mixedSnakeCase'¶
-
-
class
xsdata.models.config.
GeneratorOutput
(wsdl=False, package='generated', format=<OutputFormat.DATACLASS: 'pydata'>, structure=<OutputStructure.FILENAMES: 'filenames'>, compound_fields=False)[source]¶ Bases:
object
Main generator output options.
- Parameters
wsdl (
bool
) – Enable wsdl modepackage (
str
) – Package name eg foo.bar.modelsformat (
OutputFormat
) – Select an output formatstructure (
OutputStructure
) – Select an output structurecompound_fields (
bool
) – Use compound fields for repeating choices. Enable if elements ordering matters for your case.
-
format
: xsdata.models.config.OutputFormat = 'pydata'¶
-
structure
: xsdata.models.config.OutputStructure = 'filenames'¶
-
class
xsdata.models.config.
NameConvention
(case, safe_prefix)[source]¶ Bases:
object
Name convention model.
- Parameters
-
class
xsdata.models.config.
GeneratorConventions
(class_name=<factory>, field_name=<factory>, module_name=<factory>, package_name=<factory>)[source]¶ Bases:
object
Generator global naming conventions.
- Parameters
class_name (
NameConvention
) – Class naming conventions.field_name (
NameConvention
) – Field naming conventions.module_name (
NameConvention
) – Module naming conventions.package_name (
NameConvention
) – Package naming conventions.
-
class_name
: xsdata.models.config.NameConvention¶
-
field_name
: xsdata.models.config.NameConvention¶
-
module_name
: xsdata.models.config.NameConvention¶
-
package_name
: xsdata.models.config.NameConvention¶
-
class
xsdata.models.config.
GeneratorAlias
(source=None, target=None)[source]¶ Bases:
object
Alias definition model.
- Parameters
-
class
xsdata.models.config.
GeneratorAliases
(class_name=<factory>, field_name=<factory>, package_name=<factory>, module_name=<factory>)[source]¶ Bases:
object
Generator aliases for classes, fields, packages and modules that bypass the global naming conventions.
- Parameters
class_name (
List
[GeneratorAlias
]) – list of class name aliasesfield_name (
List
[GeneratorAlias
]) – list of field name aliasespackage_name (
List
[GeneratorAlias
]) – list of package name aliasesmodule_name (
List
[GeneratorAlias
]) – list of module name aliases
-
class_name
: List[xsdata.models.config.GeneratorAlias]¶
-
field_name
: List[xsdata.models.config.GeneratorAlias]¶
-
package_name
: List[xsdata.models.config.GeneratorAlias]¶
-
module_name
: List[xsdata.models.config.GeneratorAlias]¶
-
class
xsdata.models.config.
GeneratorConfig
(output=<factory>, conventions=<factory>, aliases=<factory>)[source]¶ Bases:
object
Generator configuration binding model.
- Parameters
version – xsdata version number the config was created/updated
output (
GeneratorOutput
) – output optionsconventions (
GeneratorConventions
) – generator conventionsaliases (
GeneratorAliases
) – generator aliases
-
conventions
: xsdata.models.config.GeneratorConventions¶
-
classmethod
write
(output, obj)[source]¶ - Parameters
output (
TextIO
) –obj (
GeneratorConfig
) –