xsdata.formats.dataclass.filters module

class xsdata.formats.dataclass.filters.Filters(class_aliases=<factory>, field_aliases=<factory>, package_aliases=<factory>, module_aliases=<factory>, class_case=<function pascal_case>, field_case=<function snake_case>, package_case=<function snake_case>, module_case=<function snake_case>, class_safe_prefix='type', field_safe_prefix='value', package_safe_prefix='pkg', module_safe_prefix='mod')

Bases: object

Parameters

• class_aliases (Dict) –

• field_aliases (Dict) –

• package_aliases (Dict) –

• module_aliases (Dict) –

• class_case (Callable) –

• field_case (Callable) –

• package_case (Callable) –

• module_case (Callable) –

• class_safe_prefix (str) –

• field_safe_prefix (str) –

• package_safe_prefix (str) –

• module_safe_prefix (str) –

class_aliases: Dict

field_aliases: Dict

package_aliases: Dict

module_aliases: Dict

class_case()

Convert the given string to pascal case.

Parameters

string (str) –

Return type

str

field_case()

Convert the given string to snake case.

Parameters

string (str) –

Return type

str

package_case()

Convert the given string to snake case.

Parameters

string (str) –

Return type

str

module_case()

Convert the given string to snake case.

Parameters

string (str) –

Return type

str

class_safe_prefix: str = 'type'

field_safe_prefix: str = 'value'

package_safe_prefix: str = 'pkg'

module_safe_prefix: str = 'mod'

cache: Dict

register(env)

Parameters

env (Environment) –

class_name(name)

Convert the given string to a class name according to the selected conventions or use an existing alias.

Parameters

name (str) –

Return type

str

field_name(name)

Convert the given string to a field name according to the selected conventions or use an existing alias.

Parameters

name (str) –

Return type

str

constant_name(name)

Apply python conventions for constant names.

Parameters

name (str) –

Return type

str

module_name(name)

Convert the given string to a module name according to the selected conventions or use an existing alias.

Parameters

name (str) –

Return type

str

package_name(name)

Convert the given string to a package name according to the selected conventions or use an existing alias.

Parameters

name (str) –

Return type

str

type_name(attr_type)

Return native python type name or apply class name conventions.

Parameters

attr_type (AttrType) –

Return type

str

field_metadata(attr, parent_namespace, parents)

Return a metadata dictionary for the given attribute.

Parameters

• attr (Attr) –

• parent_namespace (Optional[str]) –

• parents (List[str]) –

Return type

Dict

field_choices(attr, parent_namespace, parents)

Return a list of metadata dictionaries for the choices of the given attribute.

Return None if attribute has no choices.

Parameters

• attr (Attr) –

• parent_namespace (Optional[str]) –

• parents (List[str]) –

Return type

Optional[List]

classmethod filter_metadata(data)

Parameters

data (Dict) –

Return type

Dict

classmethod format_metadata(data, level=0, pattern=False)

Prettify field metadata for code generation.

Parameters

• data (Any) –

• level (int) –

• pattern (bool) –

Return type

str

class_docstring(obj, enum=False)

Generate docstring for the given class and the constructor arguments.

Parameters

• obj (Class) –

• enum (bool) –

Return type

str

field_default_value(attr, ns_map=None)

Generate the field default value/factory for the given attribute.

Parameters

• attr (Attr) –

• ns_map (Optional[Dict]) –

Return type

Any

field_default_enum(attr)

Parameters

attr (Attr) –

Return type

str

field_default_tokens(attr, types)

Parameters

• attr (Attr) –

• types (List[Type]) –

Return type

str

field_type(attr, parents)

Generate type hints for the given attribute.

Parameters

• attr (Attr) –

• parents (List[str]) –

Return type

str

choice_type(choice, parents)

Generate type hints for the given choice.

Choices support a subset of features from normal attributes. First of all we don’t have a proper type hint but a type metadata key. That’s why we always need to wrap as Type[xxx]. The second big difference is that our choice belongs to a compound field that might be a list, that’s why list restriction is also ignored.

Parameters

• choice (AttrChoice) –

• parents (List[str]) –

Return type

str

field_type_name(attr_type, parents)

Parameters

• attr_type (AttrType) –

• parents (List[str]) –

Return type

str

constant_value(attr)

Return the attr default value or type as constant value.

Parameters

attr (Attr) –

Return type

str

classmethod prepare_default_value(value)

Parameters

value (Any) –

Return type

Any

classmethod type_is_included(output, type_name)

Parameters

• output (str) –

• type_name (str) –

Return type

bool

classmethod default_imports(output)

Generate the default imports for the given package output.

Parameters

output (str) –

Return type

str

classmethod from_config(config)

Parameters

config (GeneratorConfig) –

Return type

Filters