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

Enhance Type Hints in lakeFS Python SDK to Improve Usability #8720

Open
nopcoder opened this issue Feb 26, 2025 · 0 comments
Open

Enhance Type Hints in lakeFS Python SDK to Improve Usability #8720

nopcoder opened this issue Feb 26, 2025 · 0 comments

Comments

@nopcoder
Copy link
Contributor

The lakefs.Client implementation currently uses keyword arguments (kwargs) without providing clear type hints for its methods and parameters. This lack of static typing makes it difficult for developers to understand the expected input types, leading to potential errors and confusion when interacting with the API.

Missing types can also cause misunderstandings about the intended functionality of the API, making it harder for developers to effectively utilize lakeFS Python SDK.

Proposed Solution:

Refactor the lakefs.Client classes to include comprehensive type hints for all methods and parameters. This will provide several benefits:

  • Improved Code Readability: Type hints clearly document the expected input and output types, making the code easier to understand.
  • Reduced Errors: Static type checking can catch potential errors during development, preventing runtime issues.
  • Enhanced Developer Experience: IDEs can leverage type hints for auto-completion and other helpful features, improving the overall development experience.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant