feat: allow resource.get to accept Namespace instance instead of just str

[sheltoncyril]

Short description:

This feature allows Namespace objects to be passed into the get function of NamespacedResources. Pod.get is an example which can directly accept a namespace avoiding confusion of where Namespace exists as a string.

More details:

It's annoying to juggle between namespaces as strings and namespace objects. If the Namespace is passed into a function such as Pod.get it results in the field resolving to repr which is the default behavior.

What this PR does / why we need it:

I think this fixes two things but the implementation is mostly a suggestion.

• When str, format or print is called on a Namespace instance, it resolves to a human-readable string.
• When a namespace is passed into a getter function, the name is used rather than the repr.

Special notes for reviewer:

I'm quite new to the team so I hope you can give me more detailed guidance and steps to improve.
I really appreciate detailed, honest feedback!

Summary by CodeRabbit

• New Features

  • Improved display of Namespace objects to show their name when printed or converted to a string.

• Bug Fixes

  • Ensured the namespace field is always treated as a string when retrieving namespaced resources, improving consistency and reliability.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a custom string representation for the Namespace class by adding a __str__ method that returns the object's name attribute if available. Additionally, the internal logic of the NamespacedResource.get class method is updated to ensure that the namespace attribute from resource metadata is explicitly converted to a string before being used. These updates affect how Namespace objects are displayed as strings and how namespace values are handled internally within resource retrieval operations.

Changes

File(s)	Change Summary
ocp_resources/namespace.py	Added a __str__ method to the Namespace class to return the name attribute as its string representation.
ocp_resources/resource.py	Updated the internal _get generator in NamespacedResource.get to convert the namespace attribute to a string before use.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[sheltoncyril]

pre-commit.ci autofix

[dbasunag]

This issue seems like an user error situation. namespace here is namespace name. This is true for all wrapper objects, if I recall correctly. Just like an oc command does not work with kinds as params, wrapper expects namespace strings when you are providing a namespace.