Skip to content

add rule for strenum - #25445

Merged
crazywoola merged 1 commit into
langgenius:mainfrom
asukaminato0721:strenum-rule
Sep 10, 2025
Merged

add rule for strenum#25445
crazywoola merged 1 commit into
langgenius:mainfrom
asukaminato0721:strenum-rule

Conversation

@asukaminato0721

Copy link
Copy Markdown
Contributor

Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

part of #24876

Summary

ref astral-sh/ruff#3867
ref astral-sh/ruff#10713

Screenshots

Before After
... ...

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Copilot AI review requested due to automatic review settings September 9, 2025 16:02
@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Sep 9, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a new Ruff linting rule (UP042) to enforce the use of StrEnum instead of traditional Enum for string-based enumerations, following Python modernization best practices.

  • Adds UP042 rule to enforce StrEnum usage in the codebase

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Summary of Changes

Hello @asukaminato0721, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the project's code quality standards by integrating a new linting rule. The primary goal is to ensure consistent and correct usage of string enumerations within the API module, leading to more robust and readable code.

Highlights

  • New Linting Rule: Introduced the UP042 rule (use StrEnum) to the api/.ruff.toml configuration, ensuring that string-based enums are properly utilized throughout the API codebase.
  • Code Consistency: This change promotes better code consistency and type safety by enforcing the use of StrEnum where applicable, aligning with modern Python best practices.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@dosubot dosubot Bot added the 💪 enhancement New feature or request label Sep 9, 2025

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request enables the UP042 ruff rule to enforce using StrEnum where applicable. My review points out that this rule might already be enabled by an existing configuration, making this addition redundant. For improved maintainability of the configuration file, I've suggested either removing the redundant rule or, if it's explicitly required (e.g., as a preview rule), relocating it and adding a comment for clarity.

Comment thread api/.ruff.toml
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Sep 10, 2025
@crazywoola
crazywoola merged commit cce1375 into langgenius:main Sep 10, 2025
11 checks passed
@asukaminato0721
asukaminato0721 deleted the strenum-rule branch July 13, 2026 06:34
Ssazurov pushed a commit to Ssazurov/dify that referenced this pull request Aug 8, 2026
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:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants