Add W0311 to pylint ignore list for CEP-8 consistency

[coderabbitai]

Summary

Add pylint's W0311 (bad indentation) warning to the project's ignore list to maintain consistency with CEP-8 coding standards.

Background

Our project follows CEP-8 coding standards which allow tab indentation. We already ignore flake8's W191 (indentation contains tabs) in our .flake8.ini configuration. For consistency, we should also ignore pylint's W0311 warning which flags indentation that doesn't match its expected spaces-only convention.

Tasks

• Add W0311 to pylint ignore configuration
• Update CEP-8 documentation to clearly mention that W0311 should be ignored
• Verify configuration changes work as expected

References

• PR: Patch test coverage chore 441 #448
• Comment: Patch test coverage chore 441 #448 (comment)
• CEP-8: https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161

Requested by: @reactive-firewall

[reactive-firewall]

@coderabbitai plan

[coderabbitai]

Coding Plan

Summary

• Create both a new .pylintrc configuration file AND a [tool.pylint] section in pyproject.toml for maximum compatibility, disabling W0311 (bad-indentation) and setting indent-string=\t to support CEP-8's tab indentation allowance
• Update existing CEP-8 documentation comments in .flake8.ini and pyproject.toml to cross-reference the pylint W0311 suppression alongside the flake8 W191 ignore
• Mirror the detailed comment style from .flake8.ini to maintain documentation consistency across all linting configurations

Design Choices

Design Choice 1: Configuration file format for pylint settings

Options Considered:

1. Create a standalone .pylintrc file following the existing .flake8.ini pattern
2. Add a [tool.pylint] section to pyproject.toml following the existing [tool.flake8] pattern
3. Both approaches for maximum compatibility

Chosen Option: 3

Rationale: Both approaches for maximum compatibility. This ensures the W0311 suppression is recognized by all pylint integrations—standalone .pylintrc is universally supported by tools like DeepSource, while [tool.pylint] in pyproject.toml follows modern Python packaging conventions and provides configuration co-location with other tool settings. Having both provides redundancy and discoverability.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Create Pylint Configuration

This phase establishes the pylint configuration with W0311 disabled in both .pylintrc and pyproject.toml, following the project's established patterns for linter configuration.

Task 1: Create pylint configuration file

Create a new .pylintrc file at the project root that disables W0311 (bad-indentation) to align with CEP-8 standards.

• Create .pylintrc in the project root directory
• Add a [MESSAGES CONTROL] section with disable=W0311 (or bad-indentation)
• Include header comments explaining that this configuration follows CEP-8 style conventions
• Add inline comments documenting why W0311 is disabled (tab indentation is permitted per CEP-8)
• Mirror the comment style used in .flake8.ini for consistency (reference CEP-8, explain each disabled code)

Task 2: Configure pylint indentation settings in .pylintrc

Set the indent-string option to support tab-based indentation as allowed by CEP-8.

• Add an [FORMAT] section to .pylintrc
• Set indent-string=\t to explicitly configure pylint to expect tab indentation
• Add max-line-length=100 to match the project's existing line length standard from flake8
• Include comments explaining these settings align with CEP-8 conventions

Task 3: Add pylint configuration to pyproject.toml

Add a [tool.pylint] section to pyproject.toml with equivalent W0311 suppression and indentation settings.

• Add [tool.pylint."messages control"] section with disable = ["W0311", "bad-indentation"]
• Add [tool.pylint.format] section with indent-string = "\t" and max-line-length = 100
• Include comments explaining these settings follow CEP-8 style conventions, mirroring the comment style used in the existing [tool.flake8] section
• Place the new sections near the existing [tool.flake8] section for discoverability

🤖 Prompt for AI agents

Establish pylint configuration with W0311 disabled in both `.pylintrc` and
`pyproject.toml` to align with CEP-8 standards. The goal is to suppress
bad-indentation warnings and configure pylint to accept tab indentation across
both configuration locations.

**File: `.pylintrc`**

Configuration Structure:
- Add header comments explaining this configuration follows CEP-8 style
conventions
- Mirror the detailed comment style from `.flake8.ini` for consistency

[MESSAGES CONTROL] Section:
- Disable W0311 (bad-indentation) warning
- Include inline comments documenting why W0311 is disabled (tab indentation is
permitted per CEP-8)
- Reference CEP-8 in the comments similar to how `.flake8.ini` documents ignored
codes

[FORMAT] Section:
- Set `indent-string=\t` to explicitly configure pylint to expect tab
indentation
- Set `max-line-length=100` to match the project's existing line length standard
from flake8
- Add comments explaining these settings align with CEP-8 conventions

**File: `pyproject.toml`**

Add new sections near the existing `[tool.flake8]` section:

[tool.pylint."messages control"] Section:
- Set `disable = ["W0311", "bad-indentation"]`
- Include comments explaining these settings follow CEP-8 style conventions,
mirroring the comment style used in the existing `[tool.flake8]` section

[tool.pylint.format] Section:
- Set `indent-string = "\t"` to configure tab indentation
- Set `max-line-length = 100` to match flake8 settings
- Add comments explaining CEP-8 alignment

Phase 2: Update CEP-8 Documentation

This phase ensures the CEP-8 documentation within the project consistently references the W0311 ignore alongside the existing W191 ignore, making it clear that both warnings are intentionally suppressed.

Task 1: Update flake8 configuration comments

Add W0311 reference to the CEP-8 documentation comments in .flake8.ini for cross-reference purposes.

• Update .flake8.ini lines 3-11 (the CEP-8 Custom Exceptions comment block)
• Add a comment noting that pylint's W0311 (bad-indentation) is the equivalent warning to W191 and is also ignored
• Reference that W0311 is configured in both .pylintrc and pyproject.toml
• Keep the comment clearly labeled as pylint-specific since it's not a flake8 code
• Maintain the existing comment formatting style

Task 2: Update pyproject.toml flake8 documentation

Update the existing CEP-8 comments in the [tool.flake8] section to cross-reference the new [tool.pylint] section.

• Update pyproject.toml lines 33-49 (the [tool.flake8] section with CEP-8 comments)
• Add a comment noting that pylint W0311 is also ignored (now configured in the [tool.pylint] section above)
• Ensure consistency between the flake8 and pylint comment documentation within the same file

🤖 Prompt for AI agents

Update CEP-8 documentation comments across configuration files to reference the
W0311 ignore alongside the existing W191 ignore. The goal is to maintain
consistent documentation that makes it clear both warnings are intentionally
suppressed for CEP-8 compliance, with cross-references between all configuration
locations.

**File: `.flake8.ini`**
- Update lines 3-11 (the CEP-8 Custom Exceptions comment block)
- Add a comment noting that pylint's W0311 (bad-indentation) is the equivalent
warning to W191 and is also ignored
- Reference that W0311 is configured in both `.pylintrc` and `pyproject.toml`
- Keep the comment clearly labeled as pylint-specific since it's not a flake8
code
- Maintain the existing comment formatting style

**File: `pyproject.toml`**
- Update lines 33-49 (the `[tool.flake8]` section with CEP-8 comments)
- Add a comment noting that pylint W0311 is also ignored (now configured in the
`[tool.pylint]` section above)
- Ensure consistency between the flake8 and pylint comment documentation within
the same file

Phase 3: Verification

This phase ensures the configuration changes are properly recognized and function as expected across both configuration locations.

Task 1: Verify pylint configuration

Confirm both .pylintrc and [tool.pylint] in pyproject.toml are valid and correctly disable W0311.

• Run pylint locally (if available) against a Python file with tab indentation to confirm W0311 is suppressed
• Verify the .pylintrc configuration file syntax is correct and pylint parses it without errors
• Verify the [tool.pylint] section in pyproject.toml uses correct TOML syntax
• Check that the indent-string=\t setting properly accepts tab-indented code in both configurations
• Test that pylint picks up configuration from either file when invoked

Task 2: Documentation consistency check

Ensure all CEP-8 references are consistent across configuration files.

• Verify .flake8.ini, pyproject.toml (both [tool.flake8] and [tool.pylint] sections), and .pylintrc all reference the same CEP-8 rationale
• Confirm comment style and formatting is consistent across all configuration files
• Ensure the W0311 disable is documented in multiple locations for discoverability

🤖 Prompt for AI agents

Verify that the pylint configuration changes are properly recognized and
function as expected across both `.pylintrc` and `pyproject.toml`. The goal is
to confirm W0311 is correctly suppressed in both configuration locations and
documentation is consistent across all files.

**Pylint Configuration Verification:**
- Run pylint locally (if available) against a Python file with tab indentation
to confirm W0311 is suppressed
- Verify the `.pylintrc` configuration file syntax is correct and pylint parses
it without errors
- Verify the `[tool.pylint]` section in `pyproject.toml` uses correct TOML
syntax
- Check that the `indent-string=\t` setting properly accepts tab-indented code
in both configurations
- Test that pylint picks up configuration from either file when invoked

**Documentation Consistency Check:**
- Verify `.flake8.ini`, `pyproject.toml` (both `[tool.flake8]` and
`[tool.pylint]` sections), and `.pylintrc` all reference the same CEP-8
rationale
- Confirm comment style and formatting is consistent across all configuration
files
- Ensure the W0311 disable is documented in multiple locations for
discoverability

Research

This project uses Flake8 as its primary linting tool, configured in .flake8.ini with detailed CEP-8 style documentation comments. There is no existing pylint configuration file (.pylintrc or [tool.pylint] in pyproject.toml). Pylint warnings appear through DeepSource's Python analyzer, which is configured in .deepsource.toml. The codebase contains inline # skipcq: PYL-* suppressions for specific DeepSource/pylint warnings but has no global W0311 suppression. CEP-8 documentation explaining ignored codes is primarily maintained in the comment sections of .flake8.ini (lines 3-11) and secondarily in pyproject.toml (lines 33-49).

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

Establish pylint configuration with W0311 disabled in both `.pylintrc` and
`pyproject.toml` to align with CEP-8 standards. The goal is to suppress
bad-indentation warnings and configure pylint to accept tab indentation across
both configuration locations.

**File: `.pylintrc`**

Configuration Structure:
- Add header comments explaining this configuration follows CEP-8 style
conventions
- Mirror the detailed comment style from `.flake8.ini` for consistency

[MESSAGES CONTROL] Section:
- Disable W0311 (bad-indentation) warning
- Include inline comments documenting why W0311 is disabled (tab indentation is
permitted per CEP-8)
- Reference CEP-8 in the comments similar to how `.flake8.ini` documents ignored
codes

[FORMAT] Section:
- Set `indent-string=\t` to explicitly configure pylint to expect tab
indentation
- Set `max-line-length=100` to match the project's existing line length standard
from flake8
- Add comments explaining these settings align with CEP-8 conventions

**File: `pyproject.toml`**

Add new sections near the existing `[tool.flake8]` section:

[tool.pylint."messages control"] Section:
- Set `disable = ["W0311", "bad-indentation"]`
- Include comments explaining these settings follow CEP-8 style conventions,
mirroring the comment style used in the existing `[tool.flake8]` section

[tool.pylint.format] Section:
- Set `indent-string = "\t"` to configure tab indentation
- Set `max-line-length = 100` to match flake8 settings
- Add comments explaining CEP-8 alignment
===============================================================================

Task: 2

Update CEP-8 documentation comments across configuration files to reference the
W0311 ignore alongside the existing W191 ignore. The goal is to maintain
consistent documentation that makes it clear both warnings are intentionally
suppressed for CEP-8 compliance, with cross-references between all configuration
locations.

**File: `.flake8.ini`**
- Update lines 3-11 (the CEP-8 Custom Exceptions comment block)
- Add a comment noting that pylint's W0311 (bad-indentation) is the equivalent
warning to W191 and is also ignored
- Reference that W0311 is configured in both `.pylintrc` and `pyproject.toml`
- Keep the comment clearly labeled as pylint-specific since it's not a flake8
code
- Maintain the existing comment formatting style

**File: `pyproject.toml`**
- Update lines 33-49 (the `[tool.flake8]` section with CEP-8 comments)
- Add a comment noting that pylint W0311 is also ignored (now configured in the
`[tool.pylint]` section above)
- Ensure consistency between the flake8 and pylint comment documentation within
the same file
===============================================================================

Task: 3

Verify that the pylint configuration changes are properly recognized and
function as expected across both `.pylintrc` and `pyproject.toml`. The goal is
to confirm W0311 is correctly suppressed in both configuration locations and
documentation is consistent across all files.

**Pylint Configuration Verification:**
- Run pylint locally (if available) against a Python file with tab indentation
to confirm W0311 is suppressed
- Verify the `.pylintrc` configuration file syntax is correct and pylint parses
it without errors
- Verify the `[tool.pylint]` section in `pyproject.toml` uses correct TOML
syntax
- Check that the `indent-string=\t` setting properly accepts tab-indented code
in both configurations
- Test that pylint picks up configuration from either file when invoked

**Documentation Consistency Check:**
- Verify `.flake8.ini`, `pyproject.toml` (both `[tool.flake8]` and
`[tool.pylint]` sections), and `.pylintrc` all reference the same CEP-8
rationale
- Confirm comment style and formatting is consistent across all configuration
files
- Ensure the W0311 disable is documented in multiple locations for
discoverability

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- @coderabbitai You can skip phase 3. Add a simple unit test case for phase 2.
- @coderabbitai For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[reactive-firewall]

@coderabbitai regarding design choice 1: regenerate the plan with option 3 (e.g., both for max compatibility)

[coderabbitai]

I've updated the plan above based on your feedback. Ready to proceed when you are!