This repository has been archived by the owner on Mar 16, 2024. It is now read-only.
Fix the type hint of get_current_user #59
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FastAPIs `Depends` function expects a callable. get_current_user is returning a callable but its type hint did not reflect this It's just a small change but PyCharm annoyed me...
JonasScholl
approved these changes
Jul 13, 2022
fastapi_keycloak/api.py
Outdated
| @@ -221,7 +221,7 @@ def user_auth_scheme(self) -> OAuth2PasswordBearer: | |||
| """ | |||
| return OAuth2PasswordBearer(tokenUrl=self.token_uri) | |||
|
|
|||
| def get_current_user(self, required_roles: List[str] = None, extra_fields: List[str] = None) -> OIDCUser: | |||
| def get_current_user(self, required_roles: List[str] = None, extra_fields: List[str] = None) -> Callable[..., OIDCUser]: | |||
There was a problem hiding this comment.
The type hint can be even more specific :D
Suggested change
| def get_current_user(self, required_roles: List[str] = None, extra_fields: List[str] = None) -> Callable[..., OIDCUser]: | |
| def get_current_user(self, required_roles: List[str] = None, extra_fields: List[str] = None) -> Callable[[OAuth2PasswordBearer], OIDCUser]: |
fastapi_keycloak/api.py
Outdated
| @@ -230,7 +230,7 @@ def get_current_user(self, required_roles: List[str] = None, extra_fields: List[ | |||
| extra_fields List[str]: The names of the additional fields you need that are encoded in JWT | |||
|
|
|||
| Returns: | |||
| OIDCUser: Decoded JWT content | |||
| Callable[..., OIDCUser]: Dependency method which returns the decoded JWT content | |||
There was a problem hiding this comment.
Suggested change
| Callable[..., OIDCUser]: Dependency method which returns the decoded JWT content | |
| Callable[[OAuth2PasswordBearer], OIDCUser]: Dependency method which returns the decoded JWT content |
|
Right now we are only allowing |
We can think of supporting this, then we would need to somehow make the |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
FastAPIs
Dependsfunction expects a callable.get_current_useris returning a callable but its type hint did not reflect this.It's just a small change but PyCharms type checker annoyed me...