Add __all__ symbol to the packaget __init__ file #6
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.
Hi YNAB team!
I know this change is not something you might want to add since this SDK is automatically generated by the OpenApiGenerator but this is an open issue on the generator (see this issue) and it has been there fore 2 years and does not seem to get any tracktion.
The issue here is that while we are importing all packages to be importable by anyone using the SDK, type checkers will fail to understand these exist because the package is marked with the
py.typed
file. The pyright typechecker has a good description of the behavior in their documentation.The issue here is that if we import these modules as
Type checkers would mark ApiClient as private and raise an error unless:
For example:
I would open a PR on the generator itself but their PR backlog is quite big and it might take me a while to setup a java project. Since it is unlikely you will be regenerating this soon (in 3 years I think the API spec in YNAB has been stable) I leave the PR here in case you want to consider adding it.
Thanks!