Home Backend Development Python Tutorial Setting Up Tools for Code Quality

Setting Up Tools for Code Quality

Nov 01, 2024 am 05:47 AM

Setting Up Tools for Code Quality

When developing ReadmeGenie, I aimed to ensure consistent code quality with an automated setup for linting and formatting. After considering several tools, I selected Ruff as the linter and Black as the code formatter. Although Ruff can also handle both linting and formatting, I decided to set up Black as a separate formatter to gain experience with the configuration of both tools. Below, I’ll share why I chose these tools, how I configured them for my project, the challenges I faced, and the lessons I learned along the way.


1. Tool Selection

Why Ruff?

Ruff is a fast linter for Python that supports various linting rules from other linters (like Flake8 and Pyflakes) and offers significant performance improvements. It’s highly customizable, which allowed me to specify a mix of rules while ensuring compatibility with Black for formatting. Ruff’s design for speed and extensibility is ideal for projects that prioritize efficiency without sacrificing quality.

  • Ruff Documentation: https://github.com/charliermarsh/ruff

Why Black?

Black is a Python formatter that strictly enforces one formatting style, helping reduce discussions and inconsistencies over code styling. While Ruff offers basic formatting capabilities, Black’s dedicated approach provides a few advantages:

  • Consistency: Black enforces a strict, standard style that minimizes debates over code formatting.
  • Broad Adoption: Black is widely used, making it easier to integrate into most development workflows, especially in collaborative projects.

  • Black Documentation: https://github.com/psf/black

2. Project Setup

To ensure that Ruff and Black worked seamlessly in ReadmeGenie, I configured them in both pyproject.toml and
.pre-commit-config.yaml, allowing developers to automatically format and lint code when making commits.

Configuration for Ruff and Black in pyproject.toml

This setup ensures Ruff is used solely for linting and Black for formatting:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

# pyproject.toml

# Set up black as formatter

[tool.black]

line-length = 88

target-version = ["py311"]

 

# Set up ruff as linter only

[tool.ruff]

# Exclude directories that don’t need linting (e.g., virtual environments)

exclude = [

    "venv/",

    "__pycache__/"

]

fix = true

 

 

# Enable specific linting rules

select = ["F", "E", "W", "B", "I", "S"]  # Example codes: F=flake8, E=errors, W=warnings, B=bugbear, I=import, S=safety

# Exclude Black-compatible rules to avoid conflicts with Black's formatting.

ignore = ["E501", "E203", "E231"]  # Exclude Black-incompatible style issues

Copy after login
Copy after login
  • ignore: Black handles specific styling, so we excluded these rules in Ruff.
  • fix: Enables Ruff to fix issues where possible, leaving formatting to Black.

Adding Pre-commit Hook for Ruff and Black

Using pre-commit hooks, I configured .pre-commit-config.yaml to enforce linting and formatting on every commit:

1

2

3

4

5

6

7

8

9

10

# .pre-commit-config.yaml

repos:

  - repo: https://github.com/psf/black

    rev: 23.1.0

    hooks:

      - id: black

  - repo: https://github.com/charliermarsh/ruff-pre-commit

    rev: v0.7.1

    hooks:

      - id: ruff

Copy after login
Copy after login

3. Running Ruff and Black from the Command Line

With the above setup, you can use the following commands:

  • Run Ruff:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

# pyproject.toml

# Set up black as formatter

[tool.black]

line-length = 88

target-version = ["py311"]

 

# Set up ruff as linter only

[tool.ruff]

# Exclude directories that don’t need linting (e.g., virtual environments)

exclude = [

    "venv/",

    "__pycache__/"

]

fix = true

 

 

# Enable specific linting rules

select = ["F", "E", "W", "B", "I", "S"]  # Example codes: F=flake8, E=errors, W=warnings, B=bugbear, I=import, S=safety

# Exclude Black-compatible rules to avoid conflicts with Black's formatting.

ignore = ["E501", "E203", "E231"]  # Exclude Black-incompatible style issues

Copy after login
Copy after login
  • Run Black:

1

2

3

4

5

6

7

8

9

10

# .pre-commit-config.yaml

repos:

  - repo: https://github.com/psf/black

    rev: 23.1.0

    hooks:

      - id: black

  - repo: https://github.com/charliermarsh/ruff-pre-commit

    rev: v0.7.1

    hooks:

      - id: ruff

Copy after login
Copy after login

These commands apply fixes to all Python files, ensuring consistent styling and quality checks.

4. VS Code Integration

To automate Ruff and Black on save, I added the following configuration in .vscode/settings.json:

1

ruff check . --fix

Copy after login

This setup makes Black the default formatter and Ruff the only active linter in VS Code, allowing both to run
automatically upon saving.

5. Findings and Fixes

Once configured, Ruff and Black identified several issues:

  • Line Length (E501): Ruff initially flagged long lines, which Black auto-formatted.
  • Unused Imports and Variables: Ruff caught several unused imports and variables.
  • Indentation and Styling Consistency: Black applied consistent spacing and indentation, enhancing readability.

6. Challenges

One notable challenge was understanding that some styles are incompatible between Ruff and Black. For example:

  • Line Length (E501): Ruff initially flagged long lines exceeding 88 characters, which Black handles by wrapping lines. To prevent conflicts, I added E501 to Ruff’s ignore list. Despite this, Ruff sometimes flagged E501 errors if Black didn’t apply the expected breakpoints. These discrepancies underscored the importance of adjusting each tool’s configuration and understanding where they may overlap.

7. Lessons Learned

Using Ruff and Black together has been a great way to improve code quality. Here’s what I learned:

  • Consistency: Black’s opinionated style reduces ambiguity in code styling.
  • Automation: Pre-commit hooks save time and ensure consistent formatting.
  • Editor Integration: Configuring Ruff and Black to run on save within VS Code streamlined development.
  • Compatibility: Learning how to resolve conflicts like E501 taught me about tool configurations and helped fine-tune project workflows.

The above is the detailed content of Setting Up Tools for Code Quality. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Hot Topics

Java Tutorial
1655
14
PHP Tutorial
1252
29
C# Tutorial
1226
24
Python vs. C  : Applications and Use Cases Compared Python vs. C : Applications and Use Cases Compared Apr 12, 2025 am 12:01 AM

Python is suitable for data science, web development and automation tasks, while C is suitable for system programming, game development and embedded systems. Python is known for its simplicity and powerful ecosystem, while C is known for its high performance and underlying control capabilities.

Python: Games, GUIs, and More Python: Games, GUIs, and More Apr 13, 2025 am 12:14 AM

Python excels in gaming and GUI development. 1) Game development uses Pygame, providing drawing, audio and other functions, which are suitable for creating 2D games. 2) GUI development can choose Tkinter or PyQt. Tkinter is simple and easy to use, PyQt has rich functions and is suitable for professional development.

How Much Python Can You Learn in 2 Hours? How Much Python Can You Learn in 2 Hours? Apr 09, 2025 pm 04:33 PM

You can learn the basics of Python within two hours. 1. Learn variables and data types, 2. Master control structures such as if statements and loops, 3. Understand the definition and use of functions. These will help you start writing simple Python programs.

The 2-Hour Python Plan: A Realistic Approach The 2-Hour Python Plan: A Realistic Approach Apr 11, 2025 am 12:04 AM

You can learn basic programming concepts and skills of Python within 2 hours. 1. Learn variables and data types, 2. Master control flow (conditional statements and loops), 3. Understand the definition and use of functions, 4. Quickly get started with Python programming through simple examples and code snippets.

Python vs. C  : Learning Curves and Ease of Use Python vs. C : Learning Curves and Ease of Use Apr 19, 2025 am 12:20 AM

Python is easier to learn and use, while C is more powerful but complex. 1. Python syntax is concise and suitable for beginners. Dynamic typing and automatic memory management make it easy to use, but may cause runtime errors. 2.C provides low-level control and advanced features, suitable for high-performance applications, but has a high learning threshold and requires manual memory and type safety management.

Python and Time: Making the Most of Your Study Time Python and Time: Making the Most of Your Study Time Apr 14, 2025 am 12:02 AM

To maximize the efficiency of learning Python in a limited time, you can use Python's datetime, time, and schedule modules. 1. The datetime module is used to record and plan learning time. 2. The time module helps to set study and rest time. 3. The schedule module automatically arranges weekly learning tasks.

Python: Exploring Its Primary Applications Python: Exploring Its Primary Applications Apr 10, 2025 am 09:41 AM

Python is widely used in the fields of web development, data science, machine learning, automation and scripting. 1) In web development, Django and Flask frameworks simplify the development process. 2) In the fields of data science and machine learning, NumPy, Pandas, Scikit-learn and TensorFlow libraries provide strong support. 3) In terms of automation and scripting, Python is suitable for tasks such as automated testing and system management.

Python: Automation, Scripting, and Task Management Python: Automation, Scripting, and Task Management Apr 16, 2025 am 12:14 AM

Python excels in automation, scripting, and task management. 1) Automation: File backup is realized through standard libraries such as os and shutil. 2) Script writing: Use the psutil library to monitor system resources. 3) Task management: Use the schedule library to schedule tasks. Python's ease of use and rich library support makes it the preferred tool in these areas.

See all articles