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

chore: avoid implicit optional in type annotations of method #8727

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

bowenliang123
Copy link
Contributor

@bowenliang123 bowenliang123 commented Sep 24, 2024

Checklist:

Important

Please review the checklist below before submitting your pull request.

  • Please open an issue before creating a PR or link to an existing issue
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Description

  • to improve readability for misunderstanding the argument types, avoid implicit optional in type annotations of method, by applying RUF013 linting rule (https://docs.astral.sh/ruff/rules/implicit-optional/) , which is only altered when a non-optional method argument with a default value of None.
  • All the changes are applied to the type annotation only.
  • no behaviour changed

Type of Change

  • 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

Testing Instructions

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. 🐍 python 💪 enhancement New feature or request labels Sep 24, 2024
@bowenliang123 bowenliang123 marked this pull request as draft September 25, 2024 01:54
@bowenliang123 bowenliang123 marked this pull request as ready for review September 25, 2024 02:06
@bowenliang123
Copy link
Contributor Author

All the changes are applied and have been checked manually, including the imports and annotations. cc @laipz8200

@laipz8200 laipz8200 self-requested a review September 25, 2024 02:11
@bowenliang123
Copy link
Contributor Author

Hi @laipz8200 , may I raise a separate PR after this PR being merged , to resolve the comments you suggested which are not detected by the RUF013 rule and which of suggestions also indicates possible behaviour changes (e.g. removing unused parameters)?

Copy link
Collaborator

@laipz8200 laipz8200 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your hard work.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 9, 2024
@laipz8200 laipz8200 merged commit 240b66d into langgenius:main Oct 9, 2024
6 checks passed
@bowenliang123 bowenliang123 deleted the ruf013 branch October 9, 2024 06:42
@bowenliang123
Copy link
Contributor Author

Thanks for the detailed review. Will follow your comments later.

lau-td pushed a commit to heydevs-io/dify that referenced this pull request Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💪 enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants