Skip to content

fix: get_client() client_configuration #2371

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

Merged
merged 1 commit into from
Apr 3, 2025

Conversation

sarahbx
Copy link
Contributor

@sarahbx sarahbx commented Apr 1, 2025

Support client_configuration provided via kwargs

Currently, without this change, providing client_configuration to get_client() will pass client_configuration twice to the lower level kubernetes functions. Once through client_configuration= and a second time through kwargs. This results in a TypeError.
eg:

TypeError: "func()" got multiple values for keyword argument 'client_configuration'

This fix ensures client_configuration is only passed through once.

Short description:
More details:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Special notes for reviewer:
Bug:

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor
    • Enhanced the management of configuration parameters during client setup, allowing for more flexible handling of additional parameters.

Copy link

coderabbitai bot commented Apr 1, 2025

Walkthrough

The pull request modifies the get_client function in ocp_resources/resource.py by changing how the client_configuration is passed to the kubernetes.config.new_client_from_config method. The client_configuration is now included in the kwargs dictionary instead of being passed directly as an argument. This allows for more flexibility in handling additional parameters while keeping the function signature intact.

Changes

File Change Summary
ocp_resources/resource.py Updated the get_client function to assign client_configuration to the kwargs dictionary before passing it to new_client_from_config, removing the direct argument passing.

Possibly related PRs

Suggested labels

size/M, verified, can-be-merged, approved-myakove, commented-myakove

Suggested reviewers

  • rnetser
  • myakove
  • EdDev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b55fd09 and 4e6c687.

📒 Files selected for processing (1)
  • ocp_resources/resource.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • ocp_resources/resource.py
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: tox
  • GitHub Check: python-module-install
  • GitHub Check: conventional-title

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@redhat-qe-bot
Copy link
Contributor

Report bugs in Issues

The following are automatically added:

  • Add reviewers from OWNER file (in the root of the repository) under reviewers section.
  • Set PR size label.
  • New issue is created for the PR. (Closed when PR is merged/closed)
  • Run pre-commit if .pre-commit-config.yaml exists in the repo.

Available user actions:

  • To mark PR as WIP comment /wip to the PR, To remove it from the PR comment /wip cancel to the PR.
  • To block merging of PR comment /hold, To un-block merging of PR comment /hold cancel.
  • To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
    verified label removed on each new commit push.
  • To cherry pick a merged PR comment /cherry-pick <target branch to cherry-pick to> in the PR.
    • Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2)
    • Cherry-pick will be started when PR is merged
  • To build and push container image command /build-and-push-container in the PR (tag will be the PR number).
    • You can add extra args to the Podman build command
      • Example: /build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT=<commit_hash>
  • To add a label by comment use /<label name>, to remove, use /<label name> cancel
  • To assign reviewers based on OWNERS file use /assign-reviewers
  • To check if PR can be merged use /check-can-merge
  • to assign reviewer to PR use /assign-reviewer @<reviewer>
Supported /retest check runs
  • /retest tox: Retest tox
  • /retest python-module-install: Retest python-module-install
  • /retest conventional-title: Retest conventional-title
  • /retest all: Retest all
Supported labels
  • hold
  • verified
  • wip
  • lgtm

@myakove
Copy link
Collaborator

myakove commented Apr 1, 2025

@sarahbx
Please add in the pr description what problem this fix

@sarahbx
Copy link
Contributor Author

sarahbx commented Apr 1, 2025

@sarahbx Please add in the pr description what problem this fix

np, updated.

Support client_configuration
provided via kwargs
@sarahbx sarahbx force-pushed the client_configuration branch from 898c1f9 to 4e6c687 Compare April 1, 2025 14:39
@myakove myakove enabled auto-merge (squash) April 2, 2025 08:07
@sarahbx
Copy link
Contributor Author

sarahbx commented Apr 3, 2025

/verified

@myakove myakove merged commit 0fd8972 into RedHatQE:main Apr 3, 2025
7 checks passed
@sarahbx sarahbx deleted the client_configuration branch April 3, 2025 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants