Skip to content

Naming of attribute Parameter.data-type leads to issues in Python #605

@PaulVanSchayck

Description

@PaulVanSchayck

The attribute data-type of Parameter is written with a - (sometimes referred to as kebab-case). This is inconsistent with the writing of other attributes in Parameter, which are written as camelCase. In Python, this leads to issues as you cannot write an attribute or variable name as with a dash (-) in the name. Specifically, this is a problem with the implementation of this attribute in our edr-pydantic package.

Obviously, this is a problem with Python, and even more with Pydantic. The issue is recognised within Pydantic and maybe some progress will be made there in the near future.

However, could it be considered to rename data-type within the EDR spec as well? Because even with fixes within Pydantic, there will continue to be workarounds in Python to make this attribute work. As far as I can tell, it's the only attribute in the spec written in kebab-case. In the rest of the spec I can see camelCase and snake_case. So I realise that the spec is already somewhat inconsistent anyway.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions