✨ Make field's description interpret as column's comment

[eumiro]

I have fields with description attributes I'd like to use as comments on columns in Postgresql tables.

All tests in sqlmodel use sqlite that does not support column comments. So my test in this PR does not work. What would be the best way to test it for Postgres (and other RDBMs supporting column comments)?

When I locally replace the sqlite:// with a proper Postgresql connect string to my local database, the test passes.

There's #1293, but also without working test.

[iloveitaly]

Great minds think alike :)

#1293

[eumiro]

So in the meantime I patched the current version of SQLModel and it works for Postgres as expected:

def patch_get_column_from_field():
    original_get_column_from_field = sqlmodel.main.get_column_from_field

    def patched_get_column_from_field(field: typing.Any) -> sqlmodel.Column:
        column = original_get_column_from_field(field)
        if hasattr(field, "description"):
            column.comment = field.description
        return column

    sqlmodel.main.get_column_from_field = patched_get_column_from_field

[iloveitaly]

Yeah, I have a similar patch implemented in this project: https://github.com/iloveitaly/activemodel

Supports table-level comments as well.

[svlandeg]

Hi, thanks for the contribution! I'll put this PR in draft as long as the test suite is failing 🙏

[eumiro]

@svlandeg The test suite will be falling until we find a way how to add postgresql functionality to the test suite.

[tm-michael]

Suggested change

	kwargs["comment"] = description
	kwargs["postgresql_comment"] = description

It might be worth trying with this to make the tests work to take advantage of dialect specific arguments. Then the tests should pass when using SQLite (after updating them as they currently only check for the comment kwarg).