Metadata-Version: 2.4
Name: rattle-blank-lines
Version: 0.1.5
Summary: Reusable Rattle rules for blank-line and statement cuddling policies.
Project-URL: Repository, https://github.com/zigai/rattle-blank-lines
Project-URL: Issues, https://github.com/zigai/rattle-blank-lines/issues
Project-URL: Homepage, https://github.com/zigai/rattle-blank-lines
Author-email: zigai <ziga.ivansek@gmail.com>
License: MIT License
        
        Copyright (c) 2026 zigai
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: autofix,blank-lines,lint,rattle
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: rattle-lint>=1.0.2
Provides-Extra: dev
Requires-Dist: codespell; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: rattle-lint; extra == 'dev'
Requires-Dist: ruff==0.15.8; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: rattle-lint; extra == 'test'
Description-Content-Type: text/markdown

# rattle-blank-lines

[Rattle](https://github.com/zigai/rattle) rules for blank-line and statement-cuddling policy checks in Python.
The distribution and repository name are `rattle-blank-lines`.
The project keeps the historical `fixit_blank_lines` package path for compatibility.

## Installation

```sh
pip install rattle-blank-lines
```

```sh
uv add rattle-blank-lines
```

## Quick Start

Add the rule pack to your project configuration:

```toml
[tool.rattle]
root = true
enable = ["fixit_blank_lines.rules"]
```

This enables the default rule pack. Rattle keeps its built-in `rattle.rules` enabled by default; add `disable = ["rattle.rules"]` if you want to run only this rule pack.

Run linting and autofix:

```sh
rattle lint <path>
rattle lint --diff <path>
rattle fix --automatic <path>
```

For in-file suppressions, use Rattle comments:
- `# lint-ignore: RuleName`
- `# lint-fixme: RuleName`

## Configurable Rules

Rattle supports per-rule settings under `[tool.rattle.options]`. This package exposes short rule selectors via codes and class-name aliases.

```toml
[tool.rattle.options]
BL200 = { max_suite_non_empty_lines = 2 }
BL210 = { short_control_flow_max_statements = 3 }
BL400 = { max_case_non_empty_lines = 2 }
```

These values match the default behavior, so you only need to set them when you want to override the defaults.

## Rules

### NoSuiteLeadingTrailingBlankLines (BL100, BL101)
Removes leading and trailing blank lines at suite boundaries.

Before:
```python
def f() -> int:

    value = 1
    return value
```

After:
```python
def f() -> int:
    value = 1
    return value
```


### BlankLineBeforeBranchInLargeSuite (BL200)
In suites larger than `max_suite_non_empty_lines` non-empty lines, requires a blank line before `return`/`raise`/`break`/`continue`. The default is `2`.

Before:
```python
def f(value: int) -> int:
    x = value + 1
    y = x + 1
    z = y + 1
    return z
```

After:
```python
def f(value: int) -> int:
    x = value + 1
    y = x + 1
    z = y + 1

    return z
```

### BlockHeaderCuddleRelaxed (BL300)
Allows assignment-before-block cuddling only when the immediately previous assignment feeds the block header or first body statement.
The first statement after a suite docstring is exempt (Ruff `D202` compatibility).

Before:
```python
def f(value: int) -> int:
    prepared = value + 1
    if value > 0:
        return value

    return 0
```

After:
```python
def f(value: int) -> int:
    prepared = value + 1

    if value > 0:
        return value

    return 0
```

### BlockHeaderCuddleStrict (BL301)
Stricter cuddle mode. Like BL300, the first statement after a suite docstring is exempt.

Opt in with `fixit_blank_lines.rules.block_header_cuddle_strict`, and disable `BL300` if you want BL301 instead of BL300.

```toml
[tool.rattle]
root = true
enable = [
  "fixit_blank_lines.rules",
  "fixit_blank_lines.rules.block_header_cuddle_strict",
]
disable = [
  "BL300",
]
```

Before:
```python
def f(value: int) -> int:
    header_value = value + 1
    trailing = value + 2
    if header_value > 0:
        return header_value

    return 0
```

After:
```python
def f(value: int) -> int:
    header_value = value + 1
    trailing = value + 2

    if header_value > 0:
        return header_value

    return 0
```

### BlankLineAfterControlBlock (BL350)
Requires a separator after multiline control-flow blocks.
Consecutive simple `if` blocks without `else` stay together when they test the same subject expression, so compact dispatch ladders are preserved.

Before:
```python
def f(value: int) -> int:
    if value > 0:
        value += 1
    return value
```

After:
```python
def f(value: int) -> int:
    if value > 0:
        value += 1

    return value
```

### BlankLineBeforeAssignment (BL210)
Requires a separator before an assignment when it follows a non-assignment statement,
except when the assignment directly follows a suite docstring.
Short control-flow suites (`if`/`for`/`while`/`with`/`try`/`match`) with at most `short_control_flow_max_statements` statements are exempt. The default is `3`.

Before:
```python
def f() -> int:
    log_start()
    value = compute()
    return value
```

After:
```python
def f() -> int:
    log_start()

    value = compute()
    return value
```

### MatchCaseSeparation (BL400)
Requires a separator before the next `case` when a `case` body is larger than `max_case_non_empty_lines` non-empty lines. The default is `2`.

This rule is opt-in and is not included by `enable = ["fixit_blank_lines.rules"]`.
You can enable it with `enable = ["fixit_blank_lines.rules.match_case_separation"]`.

Before:
```python
def f(value: int) -> int:
    match value:
        case 1:
            a = 1
            b = 2
            c = 3
        case _:
            return 0
```

After:
```python
def f(value: int) -> int:
    match value:
        case 1:
            a = 1
            b = 2
            c = 3

        case _:
            return 0
```


## License
[MIT](https://github.com/zigai/rattle-blank-lines/LICENSE)
