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.

Sign up for GitHub

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

Jump to bottom

Allow non ASCII in JSON dump with env var #3257

Merged
merged 14 commits into from
Jan 20, 2025
Merged

Allow non ASCII in JSON dump with env var #3257

merged 14 commits into from
Jan 20, 2025

Conversation

Frank995
Copy link
Contributor

Describe changes

Implementation for allowing non ASCII characters in JSON dumps. This has been done to have human readable output for languages with many non ASCII characters (such as any non english language :P)

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • 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.
  • IMPORTANT: I made sure that my changes are reflected properly in the following resources:
    • ZenML Docs
    • Dashboard: Needs to be communicated to the frontend team.
    • Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
    • Projects: Depending on the version dependencies, different projects might get affected.

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)

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 10, 2024 •
edited
Loading

Important

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.

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

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
🪧 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. (Beta)
  • @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.

@strickvl strickvl requested a review from schustmi December 10, 2024 14:48
schustmi
schustmi requested changes Dec 11, 2024
View reviewed changes
src/zenml/utils/yaml_utils.py Outdated Show resolved Hide resolved
src/zenml/utils/yaml_utils.py Outdated Show resolved Hide resolved
@strickvl strickvl requested a review from schustmi December 30, 2024 14:23
schustmi
schustmi requested changes Jan 2, 2025
View reviewed changes
src/zenml/constants.py Outdated Show resolved Hide resolved
@Frank995
Fixed typo and edit env var name
aaf8d28
@Frank995
Merge remote-tracking branch 'refs/remotes/origin/feature/allow-non-a…
eb3c1ea 
…scii-chars-builtin-materializer' into feature/allow-non-ascii-chars-builtin-materializer
schustmi
schustmi requested changes Jan 20, 2025
View reviewed changes
src/zenml/materializers/built_in_materializer.py Outdated Show resolved Hide resolved
src/zenml/constants.py Outdated Show resolved Hide resolved
@schustmi
Copy link
Contributor

@Frank995 The linting is still failing (see https://github.com/zenml-io/zenml/actions/runs/12869859317/job/35879915275?pr=3257), otherwise this looks good to me!

@Frank995
Copy link
Contributor Author

Frank995 commented Jan 20, 2025 •
edited
Loading

@schustmi It raises a different linting error now. Missing type error for the kwargs. Since it's a kwargs argumeng what should I write? I'm not an expert of best practices. Would 'Any' or 'str' be fine there?

@schustmi
Copy link
Contributor

@Frank995 I added the type annotation and also formatted the whole branch, let's hope it passes the CI now :)

@schustmi schustmi merged commit f7eb7f9 into zenml-io:develop Jan 20, 2025
35 of 39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@schustmi schustmi schustmi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Frank995 @schustmi @strickvl