Pyright complains about parameters for UUID field

[kirberich]

Describe the bug
When using UUID fields and pyright for type checking, pyright complains that the uuid field's parameters don't exist:

From having a quick look, I think this is caused by the fact that the fields inherit from their contained types, but unlike all the other types, uuid.UUID has an __init__ function, and the type checker cannot see that BaseField is added as a base during runtime

I think the solution might be as simple as adding an init to the uuid field, but I'm not sure if this breaks somewhere else:

    def __init__(self, *, uuid_format: str = "hex", **kwargs: Any):
        return super().__init__(**kwargs)

To Reproduce
Steps to reproduce the behavior:

1. Use vscode with pyright and basic type checking enabled
2. Create a model with a uuid field, pass along any ormar field parameter, like default
3. Pyright complains

Here's a simple reconstruction of the problem: https://gist.github.com/kirberich/7879b577d391f424951056af7cb91757

Expected behavior
Pyright should see the expected field parameters for ormar fields, not uuid.UUID

Versions (please complete the following information):

• Database backend used: postgres 13
• Python version: 3.10.7
• ormar version: 0.12.0
• pydantic version: 1.10.2
• if applicable fastapi version: 0.85.2

[ponytailer]

It's in ModelFieldFactory

[kirberich]

@ponytailer can you elaborate? ModelFieldFactory doesn't have an __init__, if that's what you mean, just a __new__

But either way the underlying problem appears to be that ormar's fields try to be two things at once - the field, and the contained value of the field. The typing errors on the UUID field are just the most obvious consequence of that issue.

The same problem on other fields expresses itself with the opposite problem - the field constructor works, but the field type doesn't match:

[collerek]

This is now resolved on master.
PR #1491 shipped a stub at ormar/fields/model_fields.pyi with @overload definitions for every field factory.

Tested with pyright 1.1.409 in both basic and strict modes — 0 errors on:

  id: uuid.UUID = ormar.UUID(primary_key=True, default=uuid.uuid4)
  name: str = ormar.String(max_length=100)
  age: int = ormar.Integer()
  flag: bool = ormar.Boolean()
  note: Optional[str] = ormar.String(max_length=50, nullable=True)
  maybe_uuid: Optional[uuid.UUID] = ormar.UUID(nullable=True)