Possible issue with 3.1.0 and sqlacodegen[geoalchemy2]

[benbenz]

Things to check first

• I have searched the existing issues and didn't find my bug already reported there

• I have checked that my bug is still present in the latest release

Sqlacodegen version

3.1.0

SQLAlchemy version

2.0.41

RDBMS vendor

PostgreSQL

What happened?

I have (unknowingly) upgraded to the latest version of sqlacodegen after a pip re-install and suddenly my export script was not working anymore.
Doing a little bit of debugging it seems sqlalchemy was throwing from type_api.py line 643.

    @property
    def python_type(self) -> Type[Any]:
        """Return the Python type object expected to be returned
        by instances of this type, if known.

        Basically, for those types which enforce a return type,
        or are known across the board to do such for all common
        DBAPIs (like ``int`` for example), will return that type.

        If a return type is not defined, raises
        ``NotImplementedError``.

        Note that any type also accommodates NULL in SQL which
        means you can also get back ``None`` from any type
        in practice.

        """
        raise NotImplementedError()

After checking further, it seems it is a POINT type that is throwing off sqlacodegen.

After rollback to 3.0.0, everything goes back to normal.

Let me know if you need more info.

Database schema for reproducing the bug

CREATE TABLE public.geo_table (
	id serial4 NOT NULL,
	point public.geometry(point, 4326) NULL,
	polygon public.geometry(polygon, 4326) NULL,
	CONSTRAINT geo_table_pkey PRIMARY KEY (_id)
);

[sheinbergon]

@benbenz thank you for reporting this issue.

Can you share the exact error you're receiving?

[sheinbergon]

@benbenz so yes, there has been a shift in the codebase to lean heavier on python_type, which is oddly enough not defined for Geometry / Geography types. Could you provide an example of the generated model class should like for the table in question? Would really help me make sure I'm fixing thigs properly

[amacfie-tc]

Same issue with INET

[benbenz]

Hello,

The error stack is as follow:

Traceback (most recent call last):
  File "/myproject/.venv/bin/sqlacodegen", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/cli.py", line 150, in main
    outfile.write(generator.generate())
                  ^^^^^^^^^^^^^^^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/generators.py", line 187, in generate
    rendered_models = self.render_models(models)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/generators.py", line 1122, in render_models
    rendered.append(self.render_class(model))
                    ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/generators.py", line 1142, in render_class
    self.render_column_attribute(column_attr)
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/generators.py", line 1267, in render_column_attribute
    rendered_column_python_type = self.render_column_python_type(column)
                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/generators.py", line 1261, in render_column_python_type
    column_python_type = f"{pre}{render_python_type(col_type)}{post}"
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlacodegen/generators.py", line 1246, in render_python_type
    python_type = column_type.python_type
                  ^^^^^^^^^^^^^^^^^^^^^^^
  File "/myproject/.venv/lib/python3.12/site-packages/sqlalchemy/sql/type_api.py", line 643, in python_type
    raise NotImplementedError()
NotImplementedError

Let me know if you need a more in-depth analysis.

[agronholm]

Seems clear to me that we need to catch this exception and use maybe Any as the type annotation then.

[benbenz]

This is the generated Model class, when successfull:

class GeoTable(Base):
    __tablename__ = 'geo_table'
    __table_args__ = (
        PrimaryKeyConstraint('id', name='geo_table_pkey')
    )

    id: Mapped[int] = mapped_column(Integer, primary_key=True)
    point: Mapped[Optional[Any]] = mapped_column(Geometry('POINT', 4326, 2, False, from_text='ST_GeomFromEWKT', name='geometry'))
    polygon: Mapped[Optional[Any]] = mapped_column(Geometry('POLYGON', 4326, 2, False, from_text='ST_GeomFromEWKT', name='geometry'))

[agronholm]

Out of curiosity, what actual Python types do you get out when you query with this class?

[sheinbergon]

Same issue with INET

Please provide a reference table schema, as well as the expected resulting class

[amacfie-tc]

Same issue with INET

Please provide a reference table schema, as well as the expected resulting class

Well any column with type INET in Postgres, e.g. create table test_table (ip_address INET);

asyncpg seems to use Union[ipaddress.IPv4Interface, ipaddress.IPv6Interface, ipaddress.IPv4Address, ipaddress.IPv6Address] for INET types.

[agronholm]

What some particular driver returns is not really relevant here. We rely on the python_type attribute of a column type, and if it isn't provided, we can only use Any as the type annotation. We can't possibly host our own mappings for every imaginable column type.

[benbenz]

Out of curiosity, what actual Python types do you get out when you query with this class?

I assume you're getting a class ... ?