feat: add MaaSModelRef resource and deprecate MaaSModel for backward compatibility#2669
Merged
myakove merged 1 commit intoRedHatQE:mainfrom Mar 6, 2026
Merged
Conversation
WalkthroughTwo changes modernize MAAS model handling: a deprecation warning is added to MaaSModel directing users to MaaSModelRef, and a new NamespacedResource subclass MaaSModelRef is introduced with initialization and dictionary conversion logic including validation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Report bugs in Issues Welcome! 🎉This pull request will be automatically processed with the following features: 🔄 Automatic Actions
📋 Available CommandsPR Status Management
Review & Approval
Testing & Validation
Cherry-pick Operations
Label Management
✅ Merge RequirementsThis PR will be automatically approved when the following conditions are met:
📊 Review ProcessApprovers and ReviewersApprovers:
Reviewers:
Available Labels
💡 Tips
For more information, please refer to the project documentation or contact the maintainers. |
Collaborator
|
/lgtm |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
ocp_resources/maa_s_model.py (1)
10-15: Module-level deprecation warning fires on every import, even if class is never used.This warning triggers at import time, which can be noisy in codebases that import this module transitively. Consider moving the deprecation warning into
__init__so it only fires when someone actually instantiatesMaaSModel.Additionally, this modification appears to be within the generated code region (between lines 1 and 52). Per coding guidelines, changes to generated code should be made via the generator tool instead.
♻️ Suggested: Move warning to __init__ for targeted deprecation
-from warnings import warn - from ocp_resources.exceptions import MissingRequiredArgumentError from ocp_resources.resource import NamespacedResource -warn( - "MaaSModel is deprecated and will be removed in a future release. " - "Please use `MaaSModelRef` from maas_model_ref.py instead.", - DeprecationWarning, - stacklevel=2, -) - class MaaSModel(NamespacedResource): """ MaaSModel is the Schema for the maasmodels API """ api_group: str = NamespacedResource.ApiGroup.MAAS_OPENDATAHUB_IO def __init__( self, model_ref: dict[str, Any] | None = None, **kwargs: Any, ) -> None: r""" Args: model_ref (dict[str, Any]): ModelRef references the actual model endpoint """ + from warnings import warn + warn( + "MaaSModel is deprecated and will be removed in a future release. " + "Please use `MaaSModelRef` from maas_model_ref.py instead.", + DeprecationWarning, + stacklevel=2, + ) super().__init__(**kwargs)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@ocp_resources/maa_s_model.py` around lines 10 - 15, The module-level DeprecationWarning call (warn(...)) fires on every import; move that warning into the MaaSModel.__init__ method so the deprecation only logs when an instance is created (reference symbols: warn, DeprecationWarning, MaaSModel, __init__). Do not directly modify the generated-code region (the existing warn call sits inside the generated block); instead update the generator/template that produces this file so the warn invocation is emitted inside the MaaSModel.__init__ body (or add a check in __init__ to call warn once), ensuring the warning is not triggered at import time.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@ocp_resources/maa_s_model.py`:
- Around line 10-15: The module-level DeprecationWarning call (warn(...)) fires
on every import; move that warning into the MaaSModel.__init__ method so the
deprecation only logs when an instance is created (reference symbols: warn,
DeprecationWarning, MaaSModel, __init__). Do not directly modify the
generated-code region (the existing warn call sits inside the generated block);
instead update the generator/template that produces this file so the warn
invocation is emitted inside the MaaSModel.__init__ body (or add a check in
__init__ to call warn once), ensuring the warning is not triggered at import
time.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: de10666f-9bec-4916-8b0b-1914ed586281
⛔ Files ignored due to path filters (2)
class_generator/schema/__resources-mappings.json.gzis excluded by!**/*.gz,!class_generator/schema/**class_generator/schema/_definitions.jsonis excluded by!class_generator/schema/**
📒 Files selected for processing (2)
ocp_resources/maa_s_model.pyocp_resources/maas_model_ref.py
Contributor
Author
|
/verified |
Collaborator
|
/check-can-merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…compatibility
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
New Features
Deprecations