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.

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

improve: extract method for safe loading yaml file and avoid using PyYaml's FullLoader #4031

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bowenliang123
Copy link
Contributor

@bowenliang123 bowenliang123 commented Apr 30, 2024

Description

  • extract a general method for loading YAML file into object, in following step
    • check the file path existence and properly open / close the IO stream in place
    • use yaml's safe_load method
  • enable ruff's S506 rule (https://docs.astral.sh/ruff/rules/unsafe-yaml-load/) to avoid possible unsafe yaml loading
  • benefits:

Type of Change

Please delete options that are not relevant.

  • 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 not work as expected)
  • This change requires a documentation update, included: Dify Document
  • Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
  • Dependency upgrade

How Has This Been Tested?

  • add unit tests

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
  • optional I have made corresponding changes to the documentation
  • optional I have added tests that prove my fix is effective or that my feature works
  • optional New and existing unit tests pass locally with my changes

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Apr 30, 2024
@bowenliang123 bowenliang123 marked this pull request as draft April 30, 2024 14:39
@dosubot dosubot bot added the 🔨 feat:tools Tools for agent, function call related stuff. label Apr 30, 2024
@bowenliang123 bowenliang123 marked this pull request as ready for review April 30, 2024 15:09
@dosubot dosubot bot added the 💪 enhancement New feature or request label Apr 30, 2024
@bowenliang123 bowenliang123 changed the title improve: extract method for safe loading yaml file and avoid using yaml FullLoader improve: extract method for safe loading yaml file and avoid using PyYaml's FullLoader Apr 30, 2024
@bowenliang123 bowenliang123 force-pushed the load-yaml branch 2 times, most recently from 536bc52 to 396e40c Compare April 30, 2024 16:58
@bowenliang123
Copy link
Contributor Author

This PR is ready for review. Please have a check. cc @takatost

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💪 enhancement New feature or request 🔨 feat:tools Tools for agent, function call related stuff. size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant