Pylint Celery Plugin

0.3 · maintenance · verified Wed Apr 15

pylint-celery is a Pylint plugin designed to enhance Pylint's ability to recognize and understand common patterns and potential errors when analyzing code that uses the Celery distributed task queue library. It aims to reduce false positives and provide more accurate linting for Celery-specific constructs. The current version is 0.3, with the last PyPI release dating back to 2014, suggesting a low-cadence, maintenance-focused development cycle, though the GitHub repository under pylint-dev sees ongoing issue tracking.

Warnings

gotcha The project lacks a `pyproject.toml` file, leading to a `DEPRECATION` warning when installed using newer `pip` versions, as it defaults to the legacy `setup.py install` method.
Fix: While `pylint-celery` itself would need an update to add `pyproject.toml`, users can ensure the `wheel` package is installed to mitigate some pip warnings, or be aware of the legacy installation method.
gotcha Pylint-celery's compatibility with newer Pylint versions is uncertain. An old issue (2017) indicated test failures with Pylint 1.7+. Users may encounter unexpected warnings or errors if using `pylint-celery` with significantly newer Pylint versions without official updates.
Fix: Refer to the `pylint-celery` GitHub issues for recent compatibility reports or consider pinning Pylint to an older, compatible version if issues arise.
gotcha Pylint (even with the plugin) can sometimes fail to resolve Celery imports (e.g., `E0401: Unable to import 'celery'`) if the Python environment or `PYTHONPATH` is not correctly configured or the virtual environment is not properly activated when running Pylint.
Fix: Ensure Pylint is run within the activated virtual environment containing Celery. If issues persist, configure Pylint's `init-hook` or `sys-path` in `.pylintrc` or `pyproject.toml` to include necessary paths.
gotcha The plugin's primary role is to fix 'celery.task is not callable' warnings. However, Pylint might still issue `E1120: No value for argument 'self'` for `bind=True` Celery tasks if the plugin doesn't fully cover specific class-based task definitions or complex scenarios, requiring manual disables.
Fix: If `E1120` or similar warnings persist for valid `bind=True` tasks, consider explicitly disabling the `no-value-for-parameter` message for the affected lines or files using `# pylint: disable=no-value-for-parameter`.

Install

pip install pylint-celery Install stable version

Imports

pylint_celery
```
pylint --load-plugins pylint_celery
```
This is a Pylint plugin and is loaded via the Pylint command-line argument, not imported directly in Python code.

Quickstart

After installing the plugin, you enable it by passing `--load-plugins pylint_celery` to your Pylint command. This integrates its checks into the linting process for your Celery-based code.

# 1. Install pylint-celery
pip install pylint-celery

# 2. Create a dummy Celery task file (e.g., myapp/tasks.py)
# Ensure Celery and Pylint are in your environment
# Example: myapp/tasks.py
# from celery import Celery
#
# app = Celery('myapp', broker='redis://localhost:6379/0')
#
# @app.task
# def add(x, y):
#     return x + y

# 3. Run Pylint with the plugin loaded
# Navigate to your project root or where your code resides
pylint --load-plugins pylint_celery myapp/tasks.py

view raw JSON →