Revisit custom id field types and type: ignore[assignment]

[felddy]

💡 Summary

We've added # type: ignore[assignment] directives to the id fields of our models that use types other than ObjectId. In the case of Beanie the type is actually PydanticObjectId.

This directive is used in the following models:

• CVEDoc
• HostDoc
• KEVDoc
• PlaceDoc
• RequestDoc
• TallyDoc

Motivation and context

The following code, when used in a beanie Document will generate the type error below:

class TallyDoc(Document):
    counts: Counts = Field(default_factory=Counts)
    id: str  # owner_id
    last_change: datetime = Field(default_factory=utcnow)

➤ mypy src/
src/cyhy_db/models/tally_doc.py:42: error: Incompatible types in assignment (expression has type "str", base class "Document" defined the type as "PydanticObjectId | None")  [assignment]

The guidance in BeanieODM/beanie#12 does not work. I expect this is due to the current state of typing in Beanie. There is an ongoing effort to remedy this: BeanieODM/beanie#1050

The work-around is to ignore the assignment:

class TallyDoc(Document):
    counts: Counts = Field(default_factory=Counts)
    id: str  # type: ignore[assignment]  # owner_id
    last_change: datetime = Field(default_factory=utcnow)

Once BeanieODM/beanie#1050 is resolved we should be able to remove the # type: ignore[assignment] directives. 🤞

See:

• Not possible to use custom type for _id field BeanieODM/beanie#12
• Beanie is fully type annotated BeanieODM/beanie#1050
• MyPy: Redefinitions with incompatible types