Skip to content

Add Ruff formatter to pre-commit for Python#1852

Open
franzpoeschel wants to merge 2 commits intoopenPMD:devfrom
franzpoeschel:pre-commit-python
Open

Add Ruff formatter to pre-commit for Python#1852
franzpoeschel wants to merge 2 commits intoopenPMD:devfrom
franzpoeschel:pre-commit-python

Conversation

@franzpoeschel
Copy link
Contributor

@franzpoeschel franzpoeschel commented Feb 19, 2026 •
edited
Loading

TODO:

  • Remove old checks that conflict with ruff
  • Either enforce line length 79 in ruff, or be fine with its default of 88
  • Revert my changes on APITest.py, let the bot do the commit

@franzpoeschel franzpoeschel requested a review from ax3l February 19, 2026 18:22
github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 19, 2026
View reviewed changes
test/python/unittest/API/APITest.py
if file_ending not in ["bp", "bp4", "bp5"]:
self.assertTrue(
dc256.dtype == np.dtype('clongdouble'))
self.assertTrue(dc256.dtype == np.dtype("clongdouble"))

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
self.assertTrue(dc64.dtype == np.dtype('complex64'))
self.assertTrue(dc128.dtype == np.dtype('complex128'))
self.assertTrue(dc64.dtype == np.dtype("complex64"))
self.assertTrue(dc128.dtype == np.dtype("complex128"))

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +781 to +783
self.assertTrue(
ms["int64"][SCALAR].load_chunk(o, e).dtype == np.dtype("int64")
)

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +778 to +780
self.assertTrue(
ms["int32"][SCALAR].load_chunk(o, e).dtype == np.dtype("int32")
)

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +775 to +777
self.assertTrue(
ms["int16"][SCALAR].load_chunk(o, e).dtype == np.dtype("int16")
)

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
src/binding/python/openpmd_api/pipe/__main__.py
Comment on lines +92 to +98
print(
"""
openPMD-api was built with support for MPI,
but mpi4py Python package was not found.
Will continue in serial mode.""",
file=sys.stderr)
file=sys.stderr,
)

Check notice

Code scanning / CodeQL

Use of a print statement at module level Note

Print statement may execute during import.
examples/2a_read_thetaMode_serial.py
E_z_m0 = E_z_modes[0:1, 0:shape[1], 0:shape[2]]
E_z_m0 = E_z_modes[0:1, 0 : shape[1], 0 : shape[2]]
# read E_z in mode_1 (two fields; skip mode_0 with one scalar field)
E_z_m1 = E_z_modes[1:3, 0:shape[1], 0:shape[2]]

Check notice

Code scanning / CodeQL

Unused global variable Note

The global variable 'E_z_m1' is not used.
@franzpoeschel franzpoeschel force-pushed the pre-commit-python branch 2 times, most recently from 4819566 to 0f90c55 Compare February 20, 2026 10:04
github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 20, 2026
View reviewed changes
test/python/unittest/API/APITest.py
Comment on lines +877 to -710
== np.dtype("complex128")
)
if file_ending not in ["bp", "bp4", "bp5"]:
self.assertTrue(ms["clongdouble"][SCALAR].load_chunk(o, e)

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +869 to +872
== np.dtype("longdouble")
)
self.assertTrue(
ms["complex64"][SCALAR].load_chunk(o, e).dtype

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +865 to +868
== np.dtype("double")
)
self.assertTrue(
ms["longdouble"][SCALAR].load_chunk(o, e).dtype

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +861 to +864
== np.dtype("single")
)
self.assertTrue(
ms["double"][SCALAR].load_chunk(o, e).dtype

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +857 to +860
== np.dtype("uint64")
)
self.assertTrue(
ms["single"][SCALAR].load_chunk(o, e).dtype

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
test/python/unittest/API/APITest.py
Comment on lines +853 to +856
== np.dtype("uint32")
)
self.assertTrue(
ms["uint64"][SCALAR].load_chunk(o, e).dtype

Check notice

Code scanning / CodeQL

Imprecise assert Note test

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.
ax3l
ax3l reviewed Feb 20, 2026
View reviewed changes
.pre-commit-config.yaml
Comment on lines +96 to +101
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.1
hooks:
- id: isort
name: isort (python)
- id: ruff-check
args: [ --line-length, "79", --fix ]
- id: ruff-format
Copy link
Member

@ax3l ax3l Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add a few more flags for the linter:
https://github.com/AMReX-Codes/pyamrex/blob/789dc8c4f1bca202219072e6a9801f060fc4ba3a/.pre-commit-config.yaml#L74-L83

Then move options like --line-length 79 to a toml config file
https://github.com/AMReX-Codes/pyamrex/blob/development/pyproject.toml

That way, local runs of ruff linter (outside of pre-commit) will have the same configs.

Copy link
Contributor Author

@franzpoeschel franzpoeschel Feb 23, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ruff apparently also looks for configuration directly inside pyproject.yaml, so that would keep things simple. I moved the line length flags there for now.
EDIT: Ah, I just saw that this is the style you linked to. Then let's go with that, yeah. Should we just copy the config from there or should we adapt some things?

ax3l
ax3l reviewed Feb 20, 2026
View reviewed changes
.pre-commit-config.yaml
# - repo: https://github.com/pycqa/isort
# rev: 7.0.0
# hooks:
# - id: isort
Copy link
Member

@ax3l ax3l Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this one we remove, replaced by ruff

@franzpoeschel
Add ruff formatter
c851a9e 
Ruff line length

Remove Python isort

conflicts with ruff

Try fixing the line length

nicer ruff syntax in pyproject.toml

Remove E203 from checking

Remove explicit cmd line args from pre-commit config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ax3l ax3l ax3l left review comments

Assignees

@ax3l ax3l

Labels

continuous integration

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@franzpoeschel @ax3l