Skip to content

Commit

Permalink
Add global and nonlocal formatting (#6170)
Browse files Browse the repository at this point in the history
## Summary

Adds `global` and `nonlocal` formatting, without the "deviation from
black" outlined in the linked issue, which I'll do separately.

See: #4798.

## Test Plan

Added a fixture in the Ruff-specific directory since the Black fixtures
don't seem to cover this.
  • Loading branch information
charliermarsh committed Jul 29, 2023
1 parent 5d9814d commit 76741ca
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
def f():
global x, y, z


def f():
# leading comment
global x, y, z # end-of-line comment
# trailing comment


def f():
global analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
def f():
nonlocal x, y, z


def f():
# leading comment
nonlocal x, y, z # end-of-line comment
# trailing comment


def f():
nonlocal analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model
12 changes: 9 additions & 3 deletions crates/ruff_python_formatter/src/statement/stmt_global.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
use crate::{not_yet_implemented, FormatNodeRule, PyFormatter};
use ruff_formatter::{write, Buffer, FormatResult};
use ruff_formatter::{format_args, write};
use ruff_python_ast::StmtGlobal;

use crate::prelude::*;
use crate::FormatNodeRule;

#[derive(Default)]
pub struct FormatStmtGlobal;

impl FormatNodeRule<StmtGlobal> for FormatStmtGlobal {
fn fmt_fields(&self, item: &StmtGlobal, f: &mut PyFormatter) -> FormatResult<()> {
write!(f, [not_yet_implemented(item)])
write!(f, [text("global"), space()])?;

f.join_with(format_args![text(","), space()])
.entries(item.names.iter().formatted())
.finish()
}
}
12 changes: 9 additions & 3 deletions crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
use crate::{not_yet_implemented, FormatNodeRule, PyFormatter};
use ruff_formatter::{write, Buffer, FormatResult};
use ruff_formatter::{format_args, write};
use ruff_python_ast::StmtNonlocal;

use crate::prelude::*;
use crate::FormatNodeRule;

#[derive(Default)]
pub struct FormatStmtNonlocal;

impl FormatNodeRule<StmtNonlocal> for FormatStmtNonlocal {
fn fmt_fields(&self, item: &StmtNonlocal, f: &mut PyFormatter) -> FormatResult<()> {
write!(f, [not_yet_implemented(item)])
write!(f, [text("nonlocal"), space()])?;

f.join_with(format_args![text(","), space()])
.entries(item.names.iter().formatted())
.finish()
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/global.py
---
## Input
```py
def f():
global x, y, z
def f():
# leading comment
global x, y, z # end-of-line comment
# trailing comment
def f():
global analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model
```

## Output
```py
def f():
global x, y, z
def f():
# leading comment
global x, y, z # end-of-line comment
# trailing comment
def f():
global analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model
```



Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/nonlocal.py
---
## Input
```py
def f():
nonlocal x, y, z
def f():
# leading comment
nonlocal x, y, z # end-of-line comment
# trailing comment
def f():
nonlocal analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model
```

## Output
```py
def f():
nonlocal x, y, z
def f():
# leading comment
nonlocal x, y, z # end-of-line comment
# trailing comment
def f():
nonlocal analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model
```



0 comments on commit 76741ca

Please sign in to comment.