sanic-org / sanic

Accelerate your web app development | Build fast. Run fast.
https://sanic.dev
MIT License
18.02k stars 1.55k forks source link

mypy error type for async get function in HTTPMethodView #2916

Open FirePanda169 opened 7 months ago

FirePanda169 commented 7 months ago

Is there an existing issue for this?

Describe the bug

Mypy throws an error overriding the signature of the get method, as it is described only for synchronous execution.

error: Signature of "get" incompatible with supertype "HTTPMethodView"  [override]
note:      Superclass:
note:          Callable[..., Any] | None
note:      Subclass:
note:          def get(self, request: Request[Any, Any]) -> Coroutine[Any, Any, HTTPResponse]

I suggest changing the description of the get method /sanic/views.py to:

get: Union[Callable[..., Any], Coroutine[..., Any], None]

Code snippet

No response

Expected Behavior

No response

How do you run Sanic?

As a script (app.run or Sanic.serve)

Operating System

Linux

Sanic Version

23.12.0

Additional context

No response

ahopkins commented 6 months ago

PR welcome :wink:

decarv commented 5 months ago

That did not solve the problem for me. mypy still complains and I have no idea why.

It works if None is removed from the type definition.

 get: Union[Callable[..., Any], Coroutine[..., Any]]

I cannot explain this behavior.

swtnk commented 2 months ago

@ahopkins The problem is here when we are using mypy and try to implement get method https://github.com/sanic-org/sanic/blob/da1c6465852c8fc0b77ee2618d845665292045e0/sanic/views.py#L118

If there is no handler defined then server is having Attribute error anyways. Example:

AttributeError: type object 'MyView' has no attribute 'get'

Proposed solution:

- get: Optional[Callable[..., Any]] +get: Callable[..., Any]