Updating the update_model decorator

[bcdurak]

Describe changes

I implemented small changes to the update_model decorator. The fields workspace and user are not allowed anymore and you can not provide additional values.

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• If my change requires a change to docs, I have updated the documentation accordingly.
• If I have added an integration, I have updated the integrations table and the corresponding website section.
• I have added tests to cover my changes.
• I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

Summary by CodeRabbit

• Refactor
  • Simplified stack update process by removing unnecessary user and workspace attributes from update functions.
  • Adjusted update model configurations to enhance flexibility in handling optional fields.
  • Streamlined the registration of built-in flavors in the system.

[schustmi]

This allows us to get rid of some now unnecessary checks/exlusions of these fields in our update methods, e.g. StackSchema.update(...). Not sure where else this was checked, but probably best if we remove those?

[github-actions]

E2E template updates in examples/e2e have been pushed.

[github-actions]

E2E template updates in examples/e2e have been pushed.

[coderabbitai]

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.

Walkthrough

The recent updates across various functions in the ZenML codebase involve removing workspace and user attributes from the update_model objects. The update_model function now allows fields to be None and forbids extra fields. These changes suggest a simplification of the update process, possibly making it more user-independent and streamlined.

Changes

File Path	Change Summary
src/zenml/client.py	Removed workspace and user attributes from update_model in update_stack, update_stack_component, and update_service_connector functions.
src/zenml/.../base/update.py	Removed workspace and user fields, set fields to non-required and nullable, and set extra to forbid in update_model.
src/zenml/stack/flavor_registry.py	Modified register_builtin_flavors method logic for creating flavor_update_model.

Poem

🐇
In the realm of code, changes sweep,
No more 'user', 'workspace' to keep.
A rabbit hops through fields anew,
ZenML's updates, simple and true.
🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[htahir1]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 31cc9cb and 3ce7da9.

Files selected for processing (3)

• src/zenml/client.py (3 hunks)
• src/zenml/models/v2/base/update.py (2 hunks)
• src/zenml/stack/flavor_registry.py (1 hunks)

Additional comments: 4

src/zenml/client.py (2)

• 1136-1140: The removal of workspace and user from the StackUpdate model is consistent with the PR's objective. However, ensure that this change is reflected across all usages of StackUpdate in the codebase to prevent runtime errors.

• 1631-1635: The removal of workspace and user from the ComponentUpdate model aligns with the PR's objective. Similar to the StackUpdate model, verify that all usages of ComponentUpdate have been updated accordingly.

src/zenml/models/v2/base/update.py (1)

• 38-50: The update_model decorator function correctly removes the workspace and user fields and sets the extra attribute to Extra.forbid, which enforces the restriction that no additional fields are allowed. This change should be cross-verified with all models that use this decorator to ensure they comply with the new constraints.

src/zenml/stack/flavor_registry.py (1)

• 127-134: The update to the register_builtin_flavors method to remove workspace and user before creating the FlavorUpdate object is in line with the PR's objective. Ensure that the FlavorUpdate model and any related logic are compatible with this change.

[github-actions]

E2E template updates in examples/e2e have been pushed.