Add missing type hints to websock 8000 et_api #50915
Conversation
|
Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with an integration ( |
| """Initialize the websocket API.""" | ||
| hass.http.register_view(http.WebsocketAPIView) | ||
| hass.http.register_view(http.WebsocketAPIView()) |
There was a problem hiding this comment.
It'll be instantiated in register_view anyway. I think it's better to do this here to have cleaner register_view interface.
| else: | ||
| self.refresh_token_id = None | ||
|
|
||
| self.refresh_token_id = refresh_token.id |
There was a problem hiding this comment.
ActiveConnection is created only in websocket_api/api.py where it's explicitly checked that refresh_token is not None.
| """Output error message.""" | ||
| connection.send_message( | ||
| messages.error_message(msg["id"], message_id, message) | ||
| ) | ||
|
|
||
| if connection.user is None: |
There was a problem hiding this comment.
connection.user is set from RefreshToken.user. I checked both places where RefreshToken is created in homeassistant/auth/auth_store.py and they both look to me as not None.
And RefreshToken.user is typed accordingly as not optional.
There was a problem hiding this comment.
@balloob can you verify this?
There was a problem hiding this comment.
Correct. All refresh tokens are bound to a user (which can be "system generated").
There was a problem hiding this comment.
Just rememebred. This is a relic of the past. We used to have api_password logins which were not bound to a user.
Proposed change
websocket_apiis added to.strict-typingand many integrations depend on it but it was missing type annotation for significant part of its methods.Remove all
# mypy:comments.There're few non typing changes:
ActiveConnection.usercan't beNoneActiveConnection.refresh_token_idcan't beNoneTo confirm this I checked not just typing but also how
ActiveConnectionandRefreshTokenare created.Type of change
Additional information
Checklist
black --fast homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.The integration reached or maintains the following Integration Quality Scale:
To help with the load of incoming pull requests: