Add type hinting - Githubissues

kvesteri / sqlalchemy-continuum

Versioning extension for SQLAlchemy.

BSD 3-Clause "New" or "Revised" License

575 stars 127 forks source link

Add type hinting #267

Open marksteward opened 2 years ago

marksteward commented 2 years ago

SQLAlchemy 1.4 has pretty good hinting, so we should too.

jkklapp commented 2 years ago

I added a list of tasks so we can easily track the WIP in each of the files

[ ] sqlalchemy_continuum/init.py
[ ] sqlalchemy_continuum/builder.py
[ ] sqlalchemy_continuum/dialects
[ ] sqlalchemy_continuum/dialects/init.py
[ ] sqlalchemy_continuum/dialects/postgresql.py
[ ] sqlalchemy_continuum/exc.py
[ ] sqlalchemy_continuum/expression_reflector.py
[ ] sqlalchemy_continuum/factory.py
[ ] sqlalchemy_continuum/fetcher.py
[ ] sqlalchemy_continuum/manager.py
[ ] sqlalchemy_continuum/model_builder.py
[ ] sqlalchemy_continuum/operation.py
[ ] sqlalchemy_continuum/plugins
[ ] sqlalchemy_continuum/plugins/init.py
[ ] sqlalchemy_continuum/plugins/activity.py
[ ] sqlalchemy_continuum/plugins/base.py
[ ] sqlalchemy_continuum/plugins/flask.py
[ ] sqlalchemy_continuum/plugins/null_delete.py
[ ] sqlalchemy_continuum/plugins/property_mod_tracker.py
[ ] sqlalchemy_continuum/plugins/transaction_changes.py
[ ] sqlalchemy_continuum/plugins/transaction_meta.py
[ ] sqlalchemy_continuum/relationship_builder.py
[ ] sqlalchemy_continuum/reverter.py
[ ] sqlalchemy_continuum/schema.py
[ ] sqlalchemy_continuum/table_builder.py
[ ] sqlalchemy_continuum/transaction.py
[ ] sqlalchemy_continuum/unit_of_work.py
[ ] sqlalchemy_continuum/utils.py
[ ] sqlalchemy_continuum/version.py

AbdealiLoKo commented 2 years ago

I could get someone to help on this one if we would like to move ahead on it

What would be the preferred approach?

typing within the .py code itself
typing with a separate .pyi file
typing in a separate repo like sqlalchemy-continuum-stubs ?

I generally prefer adding types within the .py code itself