Feature: allow integer app id #23
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
Since GitHub application IDs are always integers, it would be nice if the `AppInstallationAuthStrategy` (and similar) classes allowed for `int` types in addition to `str`. We could just replace `str` with `int`, but that wouldn't be backwards compatible, so I decided to just keep both. I can update that though if using `int` only is preferred.
yanyongyu
requested changes
Mar 23, 2023
githubkit/auth/app.py
Outdated
| @@ -33,7 +33,7 @@ class AppAuth(httpx.Auth): | |||
| """GitHub App or Installation Authentication Hook""" | |||
|
|
|||
| github: "GitHubCore" | |||
| app_id: str | |||
| app_id: str | int | |||
There was a problem hiding this comment.
Suggested change
| app_id: str | int | |
| app_id: Union[str, int] |
githubkit/auth/app.py
Outdated
| @@ -219,7 +219,7 @@ async def async_auth_flow( | |||
| class AppAuthStrategy(BaseAuthStrategy): | |||
| """GitHub App Authentication""" | |||
|
|
|||
| app_id: str | |||
| app_id: str | int | |||
There was a problem hiding this comment.
Suggested change
| app_id: str | int | |
| app_id: Union[str, int] |
githubkit/auth/app.py
Outdated
| @@ -266,7 +266,7 @@ def get_auth_flow(self, github: "GitHubCore") -> httpx.Auth: | |||
| class AppInstallationAuthStrategy(BaseAuthStrategy): | |||
| """GitHub App Installation Authentication""" | |||
|
|
|||
| app_id: str | |||
| app_id: str | int | |||
There was a problem hiding this comment.
Suggested change
| app_id: str | int | |
| app_id: Union[str, int] |
|
Thanks for catching that, I write mostly Python 3.10+ code so I'm used to using type unions |
|
Python 3.10+ typing is so convenient 👍🏻 |
yanyongyu
approved these changes
Mar 23, 2023
yanyongyu
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since GitHub application IDs are always integers, it would be nice if the
AppInstallationAuthStrategy(and similar) classes allowed forinttypes in addition tostr. We could just replacestrwithint, but that wouldn't be backwards compatible, so I decided to just keep both. I can update that though if only usingintis preferred.