Not compatible with Black

[zheyuanWang]

According to official link,
I am using the following pre-commit-config:

repos:
  - repo: https://github.com/PyCQA/isort
    rev: 5.10.1
    hooks:
      - id: isort
        args: ["--profile", "black", "--filter-files"]
  - repo: https://github.com/psf/black
    rev: 22.6.0
    hooks:
    -   id: black

However, for this file, isort's output is

from ..builder import (DETECTORS, build_backbone, build_head, build_map_to_bev,
                       build_neck, build_segmentor, build_voxel_encoder,)

while Black's output is:

from ..builder import (
    DETECTORS,
    build_backbone,
    build_head,
    build_map_to_bev,
    build_neck,
    build_segmentor,
    build_voxel_encoder,
)

Different output, so the pre-commit check would never pass.

[RickLucassen]

Hey, would like to point out that the following fixes this for me: #1876
Adding the "split_on_trailing_comma" configuration solves this, since this has not been released yet it means you would have to install isort from github.

[asears]

Another option, can use the isort skip, off/on action comments, if you prefer black. Or # fmt: off / # fmt: on if you prefer isort.

https://pycqa.github.io/isort/docs/configuration/action_comments.html

[andersk]

You must not be invoking isort correctly. With your .pre-commit-config.yaml I get

$ cat test.py
from ..builder import (DETECTORS, build_backbone, build_head, build_map_to_bev,
                       build_neck, build_segmentor, build_voxel_encoder,)

$ pre-commit run --all
isort....................................................................Failed
- hook id: isort
- files were modified by this hook

Fixing /tmp/test/test.py

black....................................................................Passed

$ cat test.py
from ..builder import (
    DETECTORS,
    build_backbone,
    build_head,
    build_map_to_bev,
    build_neck,
    build_segmentor,
    build_voxel_encoder,
)

as expected.

If you’d also like to be able to invoke isort test.py directly (not via pre-commit), then you need to configure it in .isort.cfg or pyproject.toml (documentation) rather than .pre-commit-config.yaml.

[staticdev]

@zheyuanWang should be fixed in 5.11.0, can you check?

[zheyuanWang]

@zheyuanWang should be fixed in 5.11.0, can you check?

Yes it worked!

changing the version of isort solved conflicts.

repos:
  - repo: https://github.com/PyCQA/isort
    rev: 5.11.0
    hooks:
      - id: isort
        args: ["--profile", "black", "--filter-files"]
  - repo: https://github.com/psf/black
    rev: 22.6.0
    hooks:
    -   id: black

[zheyuanWang]

well, same problem reoccured for isort 5.12.0

[zheyuanWang]

well, same problem reoccured for isort 5.12.0

args: ['--profile=black'] alone does not work, you need to use both args:

args: ['--profile=black', '--filter-files']

[timothycrosley]

@zheyuanWang, what's the problem exactly? The first looks like a line length mismatch, the second (needing both args) is not an incompatibility with black just a specific to how pre-commit works

[zheyuanWang]

sorry, false alarm;

5.12.0 is still compatible with Black.