pyproject-flake8

Warnings

• breaking This library functions by monkey-patching `flake8` and Python's `configparser` module. Significant internal changes in `flake8` or Python itself (especially `configparser`) can lead to unexpected breakage or incompatibility between `pyproject-flake8` versions and its dependencies.
  Fix: Ensure `pyproject-flake8` is explicitly pinned in your dependencies (e.g., `pyproject-flake8==7.0.0`) to avoid automatic updates that might introduce breaking changes with your `flake8` or Python version. Monitor releases for compatibility notes.
• breaking Starting with version 5.0.4, `pyproject-flake8` explicitly pins its dependency to a specific `flake8` version. For version 7.0.0, it requires `flake8==7.0.0`. This means users using different `flake8` versions might encounter dependency conflicts or require `pyproject-flake8` versions compatible with their `flake8`.
  Fix: When installing, ensure the `flake8` version installed matches the one pinned by `pyproject-flake8`. If you need a different `flake8` version, you may need to find a compatible `pyproject-flake8` version or consider alternative solutions like `flake8-pyproject`.
• gotcha To use `pyproject-flake8`, you must invoke the `pflake8` command-line executable, not the standard `flake8` command. Running `flake8` directly will not pick up the `pyproject.toml` configuration provided by this wrapper.
  Fix: Always substitute `flake8` with `pflake8` in your CI/CD pipelines, pre-commit hooks, and local development workflows where `pyproject.toml` configuration is desired.
• gotcha Flake8 configuration in `pyproject.toml` must be placed under the `[tool.flake8]` section. Placing it directly under `[flake8]` or in other sections will cause it to be ignored by `pflake8`.
  Fix: Structure your `pyproject.toml` with `[tool.flake8]` for all Flake8-related settings. Example: `[tool.flake8] max-line-length = 88`
• gotcha There are other packages, such as `flake8-pyproject`, which also aim to provide `pyproject.toml` support for Flake8 but use a different implementation (as a Flake8 plugin). `flake8-pyproject` typically allows running `flake8` directly, whereas `pyproject-flake8` requires `pflake8`. Understand the distinction to choose the correct tool for your needs.
  Fix: Carefully review the documentation for each package to understand its usage. If you prefer to keep using the `flake8` command directly and have it pick up `pyproject.toml` config via a plugin, `flake8-pyproject` might be a better fit. If you prefer `pflake8` as a wrapper, stick with `pyproject-flake8`.

Install

• pip install pyproject-flake8 Install stable version

Imports

• pflake8

  This library is primarily used as a command-line executable named `pflake8`, not typically imported as a Python module for direct use, as it monkey-patches `flake8` internally.

  Avoid direct Python imports for typical use cases; run `pflake8` from the command line.

Quickstart

After installation, create a `pyproject.toml` file in your project's root directory and define your Flake8 configuration under the `[tool.flake8]` section. Then, simply execute `pflake8` instead of `flake8` from your command line to lint your code using the specified `pyproject.toml` settings.

# 1. Install pyproject-flake8
pip install pyproject-flake8

# 2. Create a pyproject.toml file in your project root
#    (Example content below)
# [tool.flake8]
# max-line-length = 88
# extend-ignore = ["E203", "W503"]
# exclude = ["venv", ".git", "__pycache__"]

# 3. Run pflake8 instead of flake8
pflake8 your_module.py your_package/