Type Hints for Supabase-py

[J0]

It would be nice if we could get type hints on the library so that we can allow users to sanity check their code.

Thank you @dreinon for proposing this!

[SwarajBaral]

Hey @J0 can I work on this ?

[dreinon]

@SwarajBaral Sure 😄

[SwarajBaral]

Thank you @dreinon ,I will give it a go. Just a question before I begin. Should I add type hinting to a single file and create a PR first ? Just to check if I am going on the right path or not ?

[J0]

@dreinon beat me to it and yes, go for it!

If you'd like, you can add hints to a single file and then request a review before moving on to the rest of the files.

[SwarajBaral]

Thank you for the reply @J0. I am on it.

[anand2312]

I can help with this as well; @SwarajBaral wanna split work? 😄

[aantn]

This is just a recommendation, but Pydantic supports autogenerating Python models from OpenAPI specs: https://pydantic-docs.helpmanual.io/datamodel_code_generator/

Might help with this.

[aantn]

On second thought, I think I'm misinterpreting this issue :)

The pydantic code generation is useful if you want to add type hints for the user's tables in Supabase, not to add typehints to the Supabase codebase itself.

[dreinon]

Right @aantn.

Nevertheless, it's a good point what you are saying, since it would help in the job of keeping updated the code if there is any change in the database.

For instance, we could have the models generated from the OpenAPI of the db and use them when we do an insert, first instancing the Pydantic model to validate the format is okay, and then passing to the insert method instance_of_model.dict().

Do we have OpenAPI specs ready from postgrest?

Maybe we can open a discussion for this 😊

[aantn]

@dreinon exactly. Yes, there are already OpenAPI specs from Postgrest. You can use them to generate types for the typescript bindings in a similar manner: https://supabase.io/docs/reference/javascript/generating-types

[dreinon]

@aantn @J0 It would be nice to open an issue for a tutorial on how to create pydantic models from OpenAPI specs, which could also be referenced in the FastAPI tutorial since it uses pydantic models to validate and parse bodies of requests.

[dreinon]

Ping @SwarajBaral. How are you doing with this issue? Maybe you can split the work with @anand2312 or even let him go forth with the issue in case you didn't have time to do much. Thanks! 😊