✨ mypy support

[chassing]

Change summary

Add a py.typed file and a mypy plugin to fully support mypy checks.

Skipping analyzing "clientele": module is installed, but missing library stubs or py.typed marker

The mypy plugin is needed to cover the clientele decorator behavior, e.g. the result and the response parameters or the pydantic model handling.

To activate the plugin, please refer to the official mypy documentation.

For example in pyproject.toml

[tool.mypy]
plugins = ["clientele.mypy"]

or in mypy.ini

[mypy]
plugins = clientele.mypy

Pull request tasks

The following have been completed for this task:

• Code changes
• Tests written
• Documentation changes for new or changed features
• Pre-review preparation
  • make test
  • make format
  • make ty
  • make generate-test-clients
    • Test clients have changed because a new feature was introduced
    • Test clients remain the same
• Changelog updated
• Contributors updated

Other information

Distributing type information

[phalt]

@chassing great contribution, thank you! Do we need to do anything else to ensure it is bundled when running the build? We use uv, which I believe uses hatch.

[phalt]

@chassing please also add your name to CONTRIBUTORS.md

[chassing]

Do we need to do anything else to ensure it is bundled when running the build? We use uv, which I believe uses hatch.

I've tested it locally via [tool.uv.sources] (UV - Managing dependencies), and it worked without any additional configs in pyproject.toml

[phalt]

Amazing, I'll try get this shipped today or tomorrow. Thank you :)

[chassing]

Amazing, I'll try get this shipped today or tomorrow. Thank you :)

Please hold. 😢

With mypy enabled, on the usage side, the missing result parameter must be ignored by mypy. Maybe this needs a mypy plugin 🤷

Missing positional argument "result" in call to "user_repos" of "GitHubConsumer"

[phalt]

@chassing yes good point. Perhaps it does. This needs to be the same for both result and response - we should continue working on it in this branch.

[phalt]

I have been doing some digging and I think this is solvable without a mypy plugin. It'll need some decorator magic. Leave it with me for a while.

[chassing]

I have been doing some digging and I think this is solvable without a mypy plugin. It'll need some decorator magic. Leave it with me for a while.

I've got the mypy plugin ready, let me know if I should push it.

[phalt]

I have worked out a way to do it without the plugin but feel free to push the code changes - I'll have a look over. Currently on the day care drop off so I'll work on it later!

[phalt]

@chassing please push your mypy plugin. I am struggling to get it work a smart way - I can hide it at runtime but mypy checks the static files and doesn't work the same way, so I'm reverting my work.

[phalt]

Just a heads up - I am changing this to merge into the 1.6.0 feature branch that I am working on.

[chassing]

@chassing please push your mypy plugin. I am struggling to get it work a smart way - I can hide it at runtime but mypy checks the static files and doesn't work the same way, so I'm reverting my work.

I'll push it soon; the tests are still missing.

[chassing]

@phalt, everything is pushed. PTAL

[phalt]

I'm gonna merge this in - it makes sense to me and I've tested your branch locally. I want to extend it to support the new streaming decorators that I have been building as well. Thank you so much for this contribution :)

[phalt]

Shipped in version 1.6.0 - let me know how it works! I've added a small docs page about configuring it.