Skip to content

Conversation

@choieastsea
Copy link
Collaborator

Overview

This pull request introduces and configures Ruff (Python linter and formatter) for the project. The primary goal is to automate code styling and linting to improve overall code quality, consistency, and developer productivity.

You can check your codes by uv run ruff check, or fix with --fix option.

Key Changes

The Ruff configuration has been added to pyproject.toml with the following key settings:

1. Formatter Configuration ([tool.ruff.format])

  • Line Length: A maximum line length of 79 characters is enforced.
  • Quote Style: Standardizes string literals to use double quotes (").
  • Indentation: Enforces the use of spaces for indentation.
  • Docstring Formatting: Code examples within docstrings will now be automatically formatted.

2. Linter Configuration ([tool.ruff.lint])

  • Enabled Rules (select): The linter is configured to check for:
    • C: Code complexity (from flake8-comprehensions, mccabe)
    • E: Style guide violations (from pycodestyle)
    • F: Logical errors (from Pyflakes)
    • S: Potential security issues (from flake8-bandit)
    • U: Modern Python syntax suggestions (from pyupgrade)
    • I: Import sorting issues (from isort)
  • Ignored Rules (ignore):
    • C901: Ignores "function too complex" warnings, which can be addressed in future refactoring.
    • E501: Ignores "line too long" warnings, as this is handled automatically by the formatter.
  • isort Configuration:
    • Adds 2 blank lines after the main import block for better separation.
  • pydocstyle Configuration:
    • Enforces the Google style convention for all docstrings.

@choieastsea choieastsea requested a review from halucinor July 27, 2025 13:05
@choieastsea choieastsea self-assigned this Jul 27, 2025
Copy link
Collaborator

@paikend paikend left a comment

Choose a reason for hiding this comment

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

포매팅 ruff 사용하는 것에 다른 의견 없습니다. 👍

@choieastsea choieastsea merged commit 63449ea into develop Jul 29, 2025
1 check passed
@choieastsea choieastsea deleted the feat/add-ruff branch July 30, 2025 05:13
halucinor pushed a commit that referenced this pull request Aug 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants