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

Properly annotate functions #2267

Open
Bladieblah opened this issue Aug 20, 2024 · 3 comments
Open

Properly annotate functions #2267

Bladieblah opened this issue Aug 20, 2024 · 3 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@Bladieblah
Copy link

Bladieblah commented Aug 20, 2024

What is the feature and why do you need it:
The client is very unfriendly to use in its current state. Many function arguments are only specified in the docstrings, with the function signature simply containing **kwargs. The function bodies often use "locals()" instead of the params themselves which is very poor practice in general. most egregiously, the client makes no distinction whatsoever between required and optional attributes. This means that any codebase needs to implement this logic itself.

Describe the solution you'd like to see:

  • Use proper typehints and fully qualify function signatures where possible.
  • Do not use locals() unless it's actually necessary.
  • Validate that required attributes are present in a response and explicitly annotate optional attributes as Optional
@Bladieblah Bladieblah added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 20, 2024
@roycaihw
Copy link
Member

The majority of this client is generated based on openapi-generator (https://github.com/OpenAPITools/openapi-generator). Could you file feature request to the upstream generator?

@haskjold
Copy link

haskjold commented Sep 3, 2024

The majority of this client is generated based on openapi-generator (https://github.com/OpenAPITools/openapi-generator). Could you file feature request to the upstream generator?

How does that help when this client seems to be stuck on an ancient version of the upstream generator?

Ref: https://github.com/kubernetes-client/python/blob/master/scripts/update-client.sh#L25

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

5 participants