Having trouble getting black config file to take e...
# generall
lively-garden-66504
12/01/2023, 9:11 PMHaving trouble getting black config file to take effect when using Pants. Running black directly using the config file correctly excludes paths, but using Pants doesn't.
✅ 1
✅ 1
lively-garden-66504
12/01/2023, 9:11 PMMy pyproject.toml file (located at repo root) is as follows:
Copy code
[tool.black]
line-length = 100
target-version = ['py37']
# exclude autogenerated Protocol Buffer files anywhere in the project
extend-exclude = '.*' # exclude all for debugging
[tool.isort]
extend_skip_glob = [
# exclude autogenerated Protocol Buffer files anywhere in the project
"**/*_pb2.py",
"**/*_pb2.pyi",
"**/*_pb2_grpc.py",
"**/*_pb2_grpc.pyi"
] Copy code
[source]
root_patterns = [
"/e2e_testing"
]
[tailor]
build_file_name = "BUILD.pants"
[python]
enable_resolves = true
default_resolve = "default_resolve"
interpreter_constraints = ["==3.11.*"]
[python.resolves]
default_resolve = "pants/pythondeps.lock"
[pytest]
install_from_resolve = "default_resolve"
[black]
config = "pyproject.toml"
[isort]
config = ["pyproject.toml"]lively-garden-66504
12/01/2023, 9:14 PMOh I see, this is actually just due to this nuance of how black's excludes work.
lively-garden-66504
12/01/2023, 9:49 PMThis has fixed black, but somehow isort has this issue.
Copy code
❯ isort --settings-path=pants/pyproject.toml e2e_testing/**
Skipped 180 files
❯ pants fmt --only=isort e2e_testing::
// many files
+ isort made changes.lively-garden-66504
12/01/2023, 9:50 PMpants.toml
Copy code
[source]
root_patterns = [
"/e2e_testing"
]
[tailor]
build_file_name = "BUILD.pants"
[python]
enable_resolves = true
default_resolve = "default_resolve"
interpreter_constraints = ["==3.11.*"]
[python.resolves]
default_resolve = "pants/pythondeps.lock"
[pytest]
install_from_resolve = "default_resolve"
[black]
install_from_resolve = "default_resolve"
config = "pants/pyproject.toml"
[isort]
install_from_resolve = "default_resolve"
config = ["pants/pyproject.toml"] Copy code
[tool.black]
line-length = 100
target-version = ['py37']
# exclude autogenerated Protocol Buffer files anywhere in the project
force-exclude = '''
^(
.*_pb2(_grpc)?\.py(i)? # exclude autogenerated Protocol Buffer files anywhere in the project
)$
'''
[tool.isort]
profile = "black"
line_length = 100
extend_skip_glob = [
# exclude autogenerated Protocol Buffer files anywhere in the project
"**/*_pb2.py",
"**/*_pb2.pyi",
"**/*_pb2_grpc.py",
"**/*_pb2_grpc.pyi"
]lively-garden-66504
12/01/2023, 9:52 PMSystem isort version is 5.12.0
lively-garden-66504
12/01/2023, 9:52 PMAnd so is pants isort version
h
happy-kitchen-89482
12/02/2023, 1:11 AMDoes this work around the isort issue? https://www.pantsbuild.org/docs/python-linters-and-formatters#isort-possible-issues-with-its-import-classifier-algorithm
l
lively-garden-66504
12/04/2023, 4:17 PMIt doesn't seem related. It's a question of whether isort should target a file at all, not how it sorts the imports on modified files. We don't have a common org name to use for sorting imports anyway.
lively-garden-66504
12/04/2023, 4:20 PMEven after adding those lines pants isort does modify those files, whereas system isort doesn't
lively-garden-66504
12/04/2023, 4:23 PMAh but this seems to have fixed it.
filter_files = trueskip_globextend_skip_globlively-garden-66504
12/04/2023, 8:40 PMMight be worth documenting this somewhere in the Pants docs. I imagine this is a common use case for dealing with generated files.
h
happy-kitchen-89482
12/04/2023, 8:47 PMThe docs are generated from sources in the repo, so feel free to send a PR!
⛹️ 1
l
lively-garden-66504
12/04/2023, 9:26 PM3 Views