Typing errors when running mypy on code that uses clickhouse-connect

[chriswithers-fuse]

Describe the bug

Steps to reproduce

$ uv run mypy --version
mypy 1.15.0 (compiled: yes)

Any code which imports Client will complain with:

$ uv run mypy .
...: error: Module "clickhouse_connect.driver" does not explicitly export attribute "Client"  [attr-defined]

Expected behaviour

No mypy complaint

Configuration

$ uv run mypy --version
mypy 1.15.0 (compiled: yes)
$ uv tree | grep connect
Resolved 200 packages in 5ms
├── clickhouse-connect v0.9.2
$ uv run python --version
Python 3.12.11

[chriswithers-fuse]

Also:

import clickhouse_connect
client = clickhouse_connect.get_client(..)
client.close()

...gives:

error: Call to untyped function "close" of "Client" in typed context  [no-untyped-call]

It feels like the py.typed included in this package's distributions might be a little premature?

[joe-clickhouse]

Hi @chriswithers-fuse thanks! Yeah, taking a look I think py.typed was added with good intention in #243 and appears to have worked for the specific use case tested at the time. We currently don't run any mypy testing in CI (once we officially support mypy type checking this will need to change) and it looks like the original validation didn't cover the full public API surface. I'll have to take a survey of what it'd take to get everything fully and correctly type-hinted or decide to just remove that file in the meantime.

[chriswithers-fuse]

Hi @joe-clickhouse - yep, I've played this game before with one of my own projects. Best way forward is to remove the py.typed file and cut a quick release - the work to "make py.typed work" ends up being very non-trivial in my experience :-(