Skip to content

Update mmif.serialize.annotation.Annotation:id to always use "long" form  #296

@keighrim

Description

@keighrim

Because

As inspected and proposed in clamsproject/mmif#228, current specification that allows "scoped" short annotation ID's not only makes writing code to identify annotations using identifiers, but also has a serious flaw. To mitigate the problem, we decided to first update existing getters and setters of annotation ID's in serialize package to use "long" form all the time.

Done when

@property
def id(self) -> str:
return self.properties.id
@id.setter
def id(self, aid: str) -> None:
self.properties.id = aid

is updated to match long_id property, and all other parts of code that uses id or long_id property are updated accordingly.

Additional context

This proposed change will vastly break compatibility of the SDK to existing CLAMS app code, so we need a version marker that can mark this breakage. (#293 )

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions