Add utility function to run 'meson format'

Author: bgilbert

tools/format.py

@@ -20,6 +20,8 @@
 from pathlib import Path
 import subprocess
 
+from utils import format_meson
+
 FORMAT_FILES = {'meson.build', 'meson_options.txt', 'meson.options'}
 
 def main() -> None:
@@ -38,9 +40,7 @@ def main() -> None:
                 patch_dir = Path('subprojects', 'packagefiles', patch_dir_name)
                 files += [f for f in patch_dir.rglob('*') if f.name in FORMAT_FILES]
 
-    if files:
-        cmd = ['meson', 'format', '--configuration', './meson.format', '--inplace']
-        subprocess.run(cmd + files, check=True)
+    format_meson(files)
 
 
 if __name__ == '__main__':

tools/sanity_checks.py

@@ -29,7 +29,7 @@
 import shutil
 
 from pathlib import Path
-from utils import Version, ci_group, is_ci, is_alpinelike, is_debianlike, is_macos, is_windows, is_msys
+from utils import Version, ci_group, is_ci, is_alpinelike, is_debianlike, is_macos, is_windows, is_msys, FormattingError, format_meson
 
 PERMITTED_FILES = {'generator.sh', 'meson.build', 'meson_options.txt', 'meson.options', 'LICENSE.build'}
 PER_PROJECT_PERMITTED_FILES: dict[str, set[str]] = {
@@ -606,19 +606,6 @@ def is_permitted_file(self, subproject: str, filename: str) -> bool:
             return True
         return False
 
-    def is_formatted_correctly(self, file: Path) -> bool:
-        res = subprocess.run(
-            [
-                "meson",
-                "format",
-                "--check-only",
-                "--configuration",
-                "./meson.format",
-                file.absolute(),
-            ]
-        )
-        return res.returncode == 0
-
     def check_project_args(self, name: str, dir: Path) -> None:
         if not dir.exists():
             # build has not run and unpacked the source; do that
@@ -684,8 +671,11 @@ def check_files(self, subproject: str, patch_path: Path) -> None:
         for f in patch_path.rglob('*'):
             if f.is_dir():
                 continue
-            if f.name in FORMAT_CHECK_FILES and not self.is_formatted_correctly(f):
-                unformatted.append(f)
+            if f.name in FORMAT_CHECK_FILES:
+                try:
+                    format_meson([f], check=True)
+                except FormattingError:
+                    unformatted.append(f)
             if not self.is_permitted_file(subproject, f.name):
                 not_permitted.append(f)
             elif f.name in NO_TABS_FILES and '\t' in f.read_text(encoding='utf-8'):

tools/utils.py

@@ -12,13 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
 from contextlib import contextmanager
 import operator
 import re
 import os
 import sys
 import typing as T
+from pathlib import Path
 import platform
+import subprocess
 
 # a helper class which implements the same version ordering as RPM
 class Version:
@@ -125,3 +128,20 @@ def is_msys() -> bool:
 
 def is_macos():
     return any(platform.mac_ver()[0])
+
+class FormattingError(Exception):
+    pass
+
+def format_meson(files: T.Iterable[Path], *, check: bool = False) -> None:
+    if not files:
+        return
+    cmd: list[str | Path] = ['meson', 'format', '--configuration', './meson.format']
+    if check:
+        cmd.append('--check-only')
+    else:
+        cmd.append('--inplace')
+    cmd.extend(files)
+    try:
+        subprocess.run(cmd, check=True)
+    except subprocess.CalledProcessError as ex:
+        raise FormattingError from ex