tools: add utility functions to read/write wrap files

Author: bgilbert

tools/create_release.py

@@ -17,7 +17,6 @@
 from __future__ import annotations
 import io
 import sys
-import configparser
 import shutil
 import hashlib
 import requests
@@ -27,7 +26,7 @@
 import json
 
 from pathlib import Path
-from utils import is_ci, is_debianlike
+from utils import is_ci, is_debianlike, read_wrap, write_wrap
 
 class CreateRelease:
     def __init__(self, repo: T.Optional[str], token: T.Optional[str], tag: str):
@@ -45,9 +44,7 @@ def __init__(self, repo: T.Optional[str], token: T.Optional[str], tag: str):
             self.create_wrap_file()
 
     def read_wrap(self) -> None:
-        filename = Path('subprojects', f'{self.name}.wrap')
-        self.wrap = configparser.ConfigParser(interpolation=None)
-        self.wrap.read(filename)
+        self.wrap = read_wrap(self.name)
         self.wrap_section = self.wrap[self.wrap.sections()[0]]
 
     def create_patch_zip(self) -> None:
@@ -104,15 +101,7 @@ def create_wrap_file(self) -> None:
         self.wrap_section['wrapdb_version'] = self.version
 
         filename = Path(self.tempdir, f'{self.name}.wrap')
-
-        # configparser write() adds multiple trailing newlines, collapse them
-        buf = io.StringIO()
-        self.wrap.write(buf)
-        buf.seek(0)
-        newbuf = buf.read().rstrip('\n') + '\n'
-
-        with open(filename, 'w') as f:
-            f.write(newbuf)
+        write_wrap(filename, self.wrap)
 
         print('Generated wrap file:')
         print(filename.read_text())

tools/format.py

@@ -15,12 +15,11 @@
 # limitations under the License.
 
 from __future__ import annotations
-from configparser import ConfigParser
 import json
 from pathlib import Path
 import subprocess
 
-from utils import format_meson
+from utils import format_meson, read_wrap
 
 FORMAT_FILES = {'meson.build', 'meson_options.txt', 'meson.options'}
 
@@ -33,8 +32,7 @@ def main() -> None:
     files = []
     for name, info in releases.items():
         if f'{name}_{info["versions"][0]}' not in tags:
-            config = ConfigParser(interpolation=None)
-            config.read(f'subprojects/{name}.wrap', encoding='utf-8')
+            config = read_wrap(name)
             patch_dir_name = config['wrap-file'].get('patch_directory')
             if patch_dir_name:
                 patch_dir = Path('subprojects', 'packagefiles', patch_dir_name)

tools/internalize_sources.py

@@ -16,22 +16,12 @@
 
 from __future__ import annotations
 from argparse import ArgumentParser
-import configparser
 from hashlib import sha256
-from io import StringIO
 import json
 from pathlib import Path
 import subprocess
 
-def wrap_path(name: str) -> Path:
-    return Path('subprojects', f'{name}.wrap')
-
-
-def read_wrap(name: str) -> configparser.ConfigParser:
-    wrap = configparser.ConfigParser(interpolation=None)
-    wrap.read(wrap_path(name), encoding='utf-8')
-    return wrap
-
+from utils import read_wrap, write_wrap, wrap_path
 
 class Internalizer:
     def __init__(self, all=False):
@@ -81,10 +71,7 @@ def rewrite_wraps(self) -> None:
             wf = wrap['wrap-file']
             wf['source_fallback_url'] = wf['source_url']
             wf['source_url'] = f'https://github.com/mesonbuild/wrapdb/releases/download/{tag}/{wf["source_filename"]}'
-            buf = StringIO()
-            wrap.write(buf)
-            with wrap_path(name).open('w') as fh:
-                fh.write(buf.getvalue().strip() + '\n')
+            write_wrap(wrap_path(name), wrap)
         print(f'Rewrote source_url for {len(self.rewrite)} projects.')
 
 

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, FormattingError, format_meson
+from utils import Version, ci_group, is_ci, is_alpinelike, is_debianlike, is_macos, is_windows, is_msys, read_wrap, FormattingError, format_meson
 
 PERMITTED_FILES = {'generator.sh', 'meson.build', 'meson_options.txt', 'meson.options', 'LICENSE.build'}
 PER_PROJECT_PERMITTED_FILES: dict[str, set[str]] = {
@@ -279,8 +279,7 @@ def test_releases(self) -> None:
                 extra_checks = latest_tag not in self.tags
 
                 # Make sure we can load wrap file
-                config = configparser.ConfigParser(interpolation=None)
-                config.read(f'subprojects/{name}.wrap', encoding='utf-8')
+                config = read_wrap(name)
 
                 # Basic checks
                 with self.subTest(step='basic'):
@@ -692,8 +691,7 @@ def test_meson_version_deps(self) -> None:
                     self.report_meson_version_deps(name)
 
     def report_meson_version_deps(self, name: str, builddir: str = '_build') -> None:
-        wrap = configparser.ConfigParser(interpolation=None)
-        wrap.read(f'subprojects/{name}.wrap', encoding='utf-8')
+        wrap = read_wrap(name)
         patch_dir = self.get_patch_path(wrap['wrap-file'])
         if not patch_dir:
             # only check projects maintained downstream

tools/update-packagefiles.py

@@ -20,10 +20,7 @@
 import shutil
 from pathlib import Path
 
-def read_wrap(filename: Path) -> configparser.SectionProxy:
-    wrap = configparser.ConfigParser(interpolation=None)
-    wrap.read(filename)
-    return wrap[wrap.sections()[0]]
+from utils import read_wrap
 
 def read_archive_files(path: Path, base_path: Path) -> set[Path]:
     if path.suffix == '.zip':
@@ -36,7 +33,8 @@ def read_archive_files(path: Path, base_path: Path) -> set[Path]:
 
 if __name__ == '__main__':
     for f in Path('subprojects').glob('*.wrap'):
-        wrap_section = read_wrap(f)
+        wrap = read_wrap(f.stem)
+        wrap_section = wrap[wrap.sections()[0]]
         patch_directory = wrap_section.get('patch_directory')
         if not patch_directory:
             continue

tools/utils.py

@@ -13,8 +13,10 @@
 # limitations under the License.
 
 from __future__ import annotations
+import configparser
 from contextlib import contextmanager
 import functools
+import io
 import operator
 import os
 from pathlib import Path
@@ -104,6 +106,21 @@ def __cmp(self, other: 'Version', comparator: T.Callable[[T.Any, T.Any], bool])
         # versions are equal, so compare revisions
         return comparator(self._r, other._r)
 
+def wrap_path(name: str) -> Path:
+    return Path('subprojects', f'{name}.wrap')
+
+def read_wrap(name: str) -> configparser.ConfigParser:
+    config = configparser.ConfigParser(interpolation=None)
+    config.read(wrap_path(name), encoding='utf-8')
+    return config
+
+def write_wrap(path: Path, config: configparser.ConfigParser) -> None:
+    # configparser write() adds multiple trailing newlines, collapse them
+    buf = io.StringIO()
+    config.write(buf)
+    with path.open('w', encoding='utf-8') as f:
+        f.write(buf.getvalue().rstrip('\n') + '\n')
+
 @contextmanager
 def ci_group(title):
     if is_ci() or sys.stdout.isatty():

tools/versions.py

@@ -16,12 +16,12 @@
 
 from __future__ import annotations
 from argparse import ArgumentParser, Namespace
-from configparser import ConfigParser
 from functools import cache
 from hashlib import sha256
 from itertools import count
 import json
 import os
+from pathlib import Path
 import re
 import subprocess
 import sys
@@ -30,6 +30,8 @@
 
 import requests
 
+from utils import read_wrap, wrap_path
+
 WRAP_URL_TEMPLATE = (
     'https://github.com/mesonbuild/wrapdb/blob/master/subprojects/{0}.wrap'
 )
@@ -127,18 +129,11 @@ def get_wrap_versions() -> dict[str, str]:
     }
 
 
-def get_wrap_contents(name: str) -> ConfigParser:
-    '''Return a ConfigParser loaded with the specified wrap.'''
-    wrap = ConfigParser(interpolation=None)
-    wrap.read(f'subprojects/{name}.wrap', encoding='utf-8')
-    return wrap
-
-
 def get_port_wraps() -> set[str]:
     '''Return the names of wraps that have a patch directory.'''
     ports = set()
     for name, info in get_releases().items():
-        wrap = get_wrap_contents(name)
+        wrap = read_wrap(name)
         if wrap.has_option('wrap-file', 'patch_directory'):
             ports.add(name)
     return ports
@@ -148,8 +143,8 @@ def update_wrap(name: str, old_ver: str, new_ver: str) -> None:
     '''Try to update the specified wrap file from old_ver to new_ver.'''
 
     # read wrap file
-    filename = f'subprojects/{name}.wrap'
-    with open(filename) as f:
+    path = wrap_path(name)
+    with path.open(encoding='utf-8') as f:
         lines = f.readlines()
 
     # update versions
@@ -191,7 +186,7 @@ def update_wrap(name: str, old_ver: str, new_ver: str) -> None:
                 break
 
     # write
-    with open(filename, 'w') as f:
+    with path.open('w', encoding='utf-8') as f:
         f.write(''.join(lines))
 
 
@@ -298,20 +293,21 @@ def do_commit(args: Namespace) -> None:
         else:
             raise ValueError("Can't autogenerate commit message; specify -m")
 
-    commit_files = [
-        'ci_config.json', 'releases.json', f'subprojects/{name}.wrap'
+    commit_files: list[str | Path] = [
+        'ci_config.json', 'releases.json', wrap_path(name)
     ]
-    patch_dir = get_wrap_contents(name).get(
+    patch_dir = read_wrap(name).get(
         'wrap-file', 'patch_directory', fallback=None
     )
     if patch_dir:
         commit_files.append(f'subprojects/packagefiles/{patch_dir}')
 
     # suppress Git summary output and recreate it ourselves so we can also
     # show the diffstat, to confirm we've committed the right files
-    subprocess.check_call(
-        ['git', 'commit', '-m', f'{name}: {args.message}', '-q'] + commit_files
-    )
+    cmd: list[str | Path] = [
+        'git', 'commit', '-m', f'{name}: {args.message}', '-q'
+    ]
+    subprocess.check_call(cmd + commit_files)
     subprocess.check_call(['git', 'log', '-1', '--format=[%h] %s'])
     subprocess.check_call(['git', 'diff', '--stat', 'HEAD^..HEAD'])
 
@@ -381,7 +377,7 @@ def do_list(args: Namespace) -> None:
                     'wrapdb': cur_vers[name],
                     'upstream': upstream_vers.get(name),
                     'port': name in ports,
-                    'source': get_wrap_contents(name).get(
+                    'source': read_wrap(name).get(
                         'wrap-file', 'source_url'
                     )
                 } for name in wraps