> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# iac/black

Black CircleCi task for python code formatting


## Commands

### check

Check if files would be formatted by Black


| Parameter | Type | Default | Description |
|---|---|---|---|
| `diff` | boolean | false | Show diff |
| `path` | string | . | Path to file[s] |
| `quiet` | boolean | false | Don't emit non-error messages to stderr. Errors are still emitted. |
| `verbose` | boolean | false | Also emit messages to stderr about files that were not changed |

### format

Formatting files with Black


| Parameter | Type | Default | Description |
|---|---|---|---|
| `path` | string | . | Path to file[s] |
| `quiet` | boolean | false | Don't emit non-error messages to stderr. Errors are still emitted. |
| `verbose` | boolean | false | Also emit messages to stderr about files that were not changed |

## Jobs

### check

Check if python files are formatted


| Parameter | Type | Default | Description |
|---|---|---|---|
| `diff` | boolean | false | Show diff |
| `path` | string | . | Path to file[s] |
| `quiet` | boolean | false | Don't emit non-error messages to stderr. Errors are still emitted. |
| `verbose` | boolean | false | Also emit messages to stderr about files that were not changed |

### format

Format python files


| Parameter | Type | Default | Description |
|---|---|---|---|
| `path` | string | . | Path to file[s] |
| `quiet` | boolean | false | Don't emit non-error messages to stderr. Errors are still emitted. |
| `verbose` | boolean | false | Also emit messages to stderr about files that were not changed |

## Executors

### default

## Examples

### example

Simple check if python files are already formatted.


```yaml
version: '2.1'
orbs:
  black: iac/black@1.2.3
workflows:
  use-my-orb:
    jobs:
      - black/check
```