bug: MyPy compatibility

[judahrand]

Describe the bug

BentoML doesn't play nice with mypy due to this issue: python/mypy#12299

The issue is that a lot of # type: ignore comments in the codebase have additional comments after them (ie. # type: ignore (reason for ignore)). This results in packages that use BentoML and mypy throwing error: Invalid "type: ignore" comment [syntax] for mypy.

To reproduce

No response

Expected behavior

BentoML should work with mypy

Environment

Doesn't really matter.

[aarnphm]

We made a conscious decision to use pyright instead of mypy. https://github.com/bentoml/BentoML/blob/main/DEVELOPMENT.md#style-check-auto-formatting-type-checking

We don't currently have intention on supporting two different types of type checker.

[judahrand]

@aarnphm I don't think you're understanding. This isn't about the development of BentoML... It's about using it elsewhere. Any project which uses BentoML can't currently use mypy. You're forcing the choice for others.

[judahrand]

I have BentoML installed in a venv and I import and use it in a service.py file which will be included in my Bento, right? What if I want to lint that service.py file with mypy because it is a standard tool in my organization? Currently, it throws errors.

[aarnphm]

This is not necessarily a bug. When we decide to use pyright, we have heard about this issue with mypy.

For what its worth, you can always disable mypy rules for bentoml for now:

[mypy-bentoml]
ignore = true

[sauyon]

While I think this is a mypy bug that should be resolved, since the resolution is just to change the comment style on our type ignores and it would be a relatively easy change I don't see why we shouldn't do this.