xsdata.models.config module

class xsdata.models.config.OutputFormat(value)

Bases: enum.Enum

Available output formats: pydata (dataclasses), PlantUML class diagram.

DATACLASS = 'pydata'

PLANTUML = 'plantuml'

class xsdata.models.config.OutputStructure(value)

Bases: enum.Enum

Available output structure strategies, based on filenames or the target namespaces.

FILENAMES = 'filenames'

NAMESPACES = 'namespaces'

class xsdata.models.config.NameCase(value)

Bases: enum.Enum

Available naming schemes, pascal, snake, camel, mixed and mixed underscore.

PASCAL = 'pascalCase'

CAMEL = 'camelCase'

SNAKE = 'snakeCase'

MIXED = 'mixedCase'

MIXED_SNAKE = 'mixedSnakeCase'

property func

Return the actual callable of the scheme.

Return type

Callable

class xsdata.models.config.DocstringStyle(value)

Bases: enum.Enum

An enumeration.

RST = 'reStructuredText'

NUMPY = 'NumPy'

GOOGLE = 'Google'

ACCESSIBLE = 'Accessible'

class xsdata.models.config.GeneratorOutput(wsdl=False, max_line_length=79, package='generated', format=<OutputFormat.DATACLASS: 'pydata'>, structure=<OutputStructure.FILENAMES: 'filenames'>, docstring_style=<DocstringStyle.RST: 'reStructuredText'>, compound_fields=False)

Bases: object

Main generator output options.

Parameters

• wsdl (bool) – Enable wsdl mode

• max_line_length (int) – Maximum line length

• package (str) – Package name eg foo.bar.models

• format (OutputFormat) – Select an output format

• structure (OutputStructure) – Select an output structure

• docstring_style (DocstringStyle) – Select a docstring style

• compound_fields (bool) – Use compound fields for repeating choices. Enable if elements ordering matters for your case.

wsdl: bool = False

max_line_length: int = 79

package: str = 'generated'

format: xsdata.models.config.OutputFormat = 'pydata'

structure: xsdata.models.config.OutputStructure = 'filenames'

docstring_style: xsdata.models.config.DocstringStyle = 'reStructuredText'

compound_fields: bool = False

class xsdata.models.config.NameConvention(case, safe_prefix)

Bases: object

Name convention model.

Parameters

• case (NameCase) – Naming scheme, eg camelCase, snakeCase

• safe_prefix (str) – A prefix to be prepended into names that match reserved words.

case: xsdata.models.config.NameCase

safe_prefix: str

class xsdata.models.config.GeneratorConventions(class_name=<factory>, field_name=<factory>, module_name=<factory>, package_name=<factory>)

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)

Bases: object

Alias definition model.

Parameters

• source (Optional[str]) – The source name from schema definition

• target (Optional[str]) – The target name of the object.

source: str = None

target: str = None

class xsdata.models.config.GeneratorAliases(class_name=<factory>, field_name=<factory>, package_name=<factory>, module_name=<factory>)

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 aliases

• field_name (List[GeneratorAlias]) – list of field name aliases

• package_name (List[GeneratorAlias]) – list of package name aliases

• module_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>)

Bases: object

Generator configuration binding model.

Parameters

• version – xsdata version number the config was created/updated

• output (GeneratorOutput) – output options

• conventions (GeneratorConventions) – generator conventions

• aliases (GeneratorAliases) – generator aliases

class Meta

Bases: object

name = 'Config'

namespace = 'http://pypi.org/project/xsdata'

version: str = '20.12'

output: xsdata.models.config.GeneratorOutput

conventions: xsdata.models.config.GeneratorConventions

aliases: xsdata.models.config.GeneratorAliases

classmethod create()

Return type

GeneratorConfig

classmethod read(path)

Parameters

path (Path) –

Return type

GeneratorConfig

classmethod write(output, obj)

Parameters

• output (TextIO) –

• obj (GeneratorConfig) –