ENH: Improve sql io api

[bashtage]

• Tests added: Please use assert_type() to assert the type of any return value

[bashtage]

Testing this might not be worth it.

[bashtage]

I included some classes and their attributes as these are required for some of the modes. These classes are used in the docs as examples.

[Dr-Irv]

For tests, you could test the types by surrounding the tests with if TYPE_CHECKING. So then pytest won't execute them, but the type checking will still happen.

[Dr-Irv]

One other idea. Some of the methods have types that depend on sqlalchemy. I'm pretty sure that the type checkers assume that typeshed is installed, which has sqlalchemy types defined, so it might be worth using sqlalchemy types where they are documented (e.g., the connection arguments).

[Dr-Irv]

One other idea. Some of the methods have types that depend on sqlalchemy. I'm pretty sure that the type checkers assume that typeshed is installed, which has sqlalchemy types defined, so it might be worth using sqlalchemy types where they are documented (e.g., the connection arguments).

Or maybe easier than worrying about typeshed, make an installation dependency on sqlalchemy-stubs

[bashtage]

Or maybe easier than worrying about typeshed, make an installation dependency on sqlalchemy-stubs

I went with types_SQLAlchemy which seems to be actively maintained. sqlalchemy-stubs hasn't updated in a year.

[Dr-Irv]

Only issue is to add a typing test. You can do

def test_sql_types() -> None:
    df = # Some dataframe
    if TYPE_CHECKING:
        df.to_sql(# arguments)

        # additional tests

[bashtage]

Close/reopen to force CI and see if loguru happens here too.

[bashtage]

Still would like a comment in the code as to why TYPE_CHECKING is used here
Comment added.

[Dr-Irv]

thanks @bastage