How does wemake-python-styleguide compare to pylint?

wemake-python-styleguide is more opinionated and strict, enforcing a single coding style and detecting complex code, while pylint offers broader but less rigid checks. It's designed to work with ruff for a full linting and formatting solution.

How to disable specific rules in wemake-python-styleguide?

You can disable rules by configuring the setup.cfg file or using inline comments with error codes. The README links to documentation on ignoring violations for detailed control over which checks are active.

Does wemake-python-styleguide work with pre-commit hooks?

Yes, it can be integrated into pre-commit by adding it as a flake8 plugin. The documentation includes examples for GitHub Actions and other CI tools to streamline enforcement in development workflows.

What are the most common errors flagged by wemake-python-styleguide?

Common violations include complexity issues like high cyclomatic complexity, naming convention deviations, and potential bugs such as unused variables. The docs provide a full list of error codes with explanations.

How to set up wemake-python-styleguide with ruff in a CI pipeline?

Install both packages, configure ruff in pyproject.toml for formatting and basic linting, then run flake8 with the WPS select for additional strict checks. The README shows an example configuration for seamless integration.

Is wemake-python-styleguide suitable for data science code?

It can be used, but its strict rules might flag common data science patterns like long variable names or complex list comprehensions. Teams may need to disable certain rules to align with domain-specific practices.

Open-Awesome

wemake-python-styleguide

MITPython1.6.2

The strictest and most opinionated Python linter, a flake8 plugin designed to enforce consistent, maintainable, and bug-resistant code.

Visit Website GitHub

2.9k stars423 forks0 contributors

What is wemake-python-styleguide?

wemake-python-styleguide is a flake8 plugin that acts as an extremely strict and opinionated linter for Python code. It enforces a comprehensive set of rules to ensure code consistency, reduce complexity, and prevent potential bugs, aiming to make all Python code look identical. It is designed to work alongside tools like ruff to provide a complete code quality solution.

Target Audience

Python developers and teams who prioritize code consistency, maintainability, and strict adherence to best practices, especially those already using flake8 and ruff in their workflow.

Value Proposition

Developers choose wemake-python-styleguide for its unparalleled strictness and opinionated approach, which enforces a single, obvious way to write Python. It reduces code reviews, eliminates redundancy, and catches complex issues that other linters might miss, making it the ultimate tool for uniform codebases.

Overview

The strictest and most opinionated python linter ever!

Use Cases

Best For

Enforcing absolute code consistency across large Python teams
Reducing code complexity and improving long-term maintainability
Catching subtle bugs and anti-patterns that standard linters overlook
Integrating with ruff to create a comprehensive linting and formatting pipeline
Legacy codebase refactoring with tools like ondivi for gradual adoption
Projects requiring strict, opinionated style guides with configurable rules

Not Ideal For

Projects that prioritize developer autonomy and stylistic flexibility over uniform code
Legacy codebases without a dedicated refactoring phase for gradual linting adoption
Rapid prototyping or experimental coding where strict enforcement might hinder iteration

Pros & Cons

Pros

Comprehensive Rule Enforcement

Implements hundreds of opinionated checks to ensure code consistency and reduce complexity, as emphasized in the README's benefits for efficient reviews and fewer revisions.

Advanced Bug Detection

Identifies potential bugs and complex code patterns beyond basic style issues, positioning it as a tool that finds subtle errors other linters might miss.

Seamless ruff Integration

Works fully with ruff for formatting and linting, complementing its capabilities to provide a complete code quality pipeline, as shown in the example configuration.

Configurable Rule Set

Allows disabling any rules that don't fit project needs while maintaining strict defaults, offering flexibility within its opinionated framework, per the README's setup instructions.

Cons

No Built-in Formatting

Relies entirely on external tools like ruff for code formatting, as the README explicitly states it does not format code or produce stylistic errors.

Steep Adoption Curve

The strict default rules can be overwhelming for teams new to rigorous linting, and integrating into legacy code requires additional tools like ondivi, adding setup complexity.

Dependence on flake8 Ecosystem

As a flake8 plugin, it ties into an older toolchain that might be less performant or preferred compared to using ruff alone for some modern Python workflows.

Frequently Asked Questions

Related Projects

PyTorch - Tensors and Dynamic neural networks in Python with strong GPU acceleration

Tensors and Dynamic neural networks in Python with strong GPU acceleration

Stars101,899

Forks28,473

Last commit17 hours ago

FastAPI

FastAPI framework, high performance, easy to learn, fast to code, ready for production

Stars100,813

Forks9,675

Last commit22 hours ago

ansible

Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. https://docs.ansible.com.

scikit-learn: machine learning in Python

Stars66,766

Forks27,210