Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Update return type annotations on WorkspaceClient API properties #898

Open
themattmorris opened this issue Feb 24, 2025 · 1 comment
Labels
Feature Request The issue is a request for enhancement or new functionality rather than a bug.

Comments

@themattmorris
Copy link

Problem Statement
Type-hinting for return statements on API properties of WorkspaceClient no longer helpful beginning with version 0.42.0.

Though the imports exist at the top of the file for the API names, the return types specify the full path to these objects, which does not play nicely with editor help:

Previous

This sample uses 0.41.0.

Image

Since 0.42.0

Image

(it thinks that w.tables returns Any).

Proposed Solution
Updating the return type hints in the api properties to be as they were before, i.e. specifying the object type they are returning (which are imported in the module) as opposed to the full path to the object.

@tanmay-db tanmay-db added the Feature Request The issue is a request for enhancement or new functionality rather than a bug. label Mar 3, 2025
@NodeJSmith
Copy link
Contributor

@tanmay-db Should the Regression label be added here? This was working well previously, it's only the last few versions where this has become an issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request The issue is a request for enhancement or new functionality rather than a bug.
Projects
None yet
Development

No branches or pull requests

3 participants