programs: Add a couple more useful aliases

These are useful for the many cases of creating lists of commands that
are mixtures of strings and programs

Author: dcbaker

mesonbuild/modules/_qt.py

@@ -28,7 +28,7 @@
     from ..interpreter import Interpreter
     from ..interpreter import kwargs
     from ..mesonlib import FileOrString
-    from ..programs import Program
+    from ..programs import CommandList, Program
     from typing_extensions import Literal
 
     QtDependencyType = T.Union[QtPkgConfigDependency, QmakeQtDependency]
@@ -441,7 +441,7 @@ def _compile_resources_impl(self, state: 'ModuleState', kwargs: 'ResourceCompile
 
         # If a name was set generate a single .cpp file from all of the qrc
         # files, otherwise generate one .cpp file per qrc file.
-        cmd: T.List[T.Union[Program, str]]
+        cmd: CommandList
         if name:
             qrc_deps: T.List[File] = []
             for s in sources:
@@ -729,7 +729,7 @@ def compile_translations(self, state: ModuleState, args: T.Tuple, kwargs: Compil
                 ts = os.path.basename(ts)
             else:
                 outdir = state.subdir
-            cmd: T.List[T.Union[Program, str]] = [self.tools['lrelease'], '@INPUT@', '-qm', '@OUTPUT@']
+            cmd: CommandList = [self.tools['lrelease'], '@INPUT@', '-qm', '@OUTPUT@']
             lrelease_target = build.CustomTarget(
                 f'qt{self.qt_version}-compile-{ts}',
                 outdir,
@@ -869,8 +869,7 @@ def _moc_json_collect(self, state: ModuleState, kwargs: MocJsonCollectKwArgs) ->
                     input_args.append(f'@INPUT{input_counter}@')
                 input_counter += 1
 
-        cmd: T.List[T.Union[Program, str]] = \
-            [self.tools['moc'], '--collect-json', '-o', '@OUTPUT@', *input_args]
+        cmd: CommandList = [self.tools['moc'], '--collect-json', '-o', '@OUTPUT@', *input_args]
         return build.CustomTarget(
             f'moc_collect_json_{target_name}',
             state.subdir,
@@ -916,7 +915,7 @@ def _gen_qml_cachegen(self, state: ModuleState, kwargs: GenQmlCachegenKwArgs) ->
             ressource_path = os.path.join('/', kwargs['module_prefix'], source_basename)
             cachegen_inputs.append(ressource_path)
 
-        cmd: T.List[T.Union[Program, str]] = \
+        cmd: CommandList = \
             [self.tools['qmlcachegen'], '-o', '@OUTPUT@', '--resource-name', f'qmlcache_{target_name}',
              *kwargs['extra_args'], '--resource=@INPUT@', *cachegen_inputs]
         cacheloader_target = build.CustomTarget(
@@ -952,7 +951,7 @@ def _qml_type_registrar(self, state: ModuleState, kwargs: GenQmlTypeRegistrarKwA
         install_dir: T.List[T.Union[str, Literal[False]]] = [False]
         install_tag: T.List[T.Union[str, None]] = [None]
 
-        cmd: T.List[T.Union[Program, str]] = [
+        cmd: CommandList = [
             self.tools['qmltyperegistrar'],
             '--import-name', import_name,
             '--major-version', major_version,

mesonbuild/modules/codegen.py

@@ -29,6 +29,7 @@
     from ..interpreter.kwargs import ExtractRequired
     from ..interpreterbase import TYPE_var, TYPE_kwargs
     from ..mesonlib import MachineChoice
+    from ..programs import CommandList
 
     LexImpls = Literal['lex', 'flex', 'reflex', 'win_flex']
     YaccImpls = Literal['yacc', 'byacc', 'bison', 'win_bison']
@@ -87,9 +88,8 @@ class _CodeGenerator(HoldableObject):
     program: Program
     arguments: ImmutableListProtocol[str] = dataclasses.field(default_factory=list)
 
-    def command(self) -> T.List[T.Union[Program, str]]:
-        return (T.cast('T.List[T.Union[Program, str]]', [self.program]) +
-                T.cast('T.List[T.Union[Program, str]]', self.arguments))
+    def command(self) -> CommandList:
+        return T.cast('CommandList', [self.program]) + T.cast('CommandList', self.arguments)
 
     def found(self) -> bool:
         return self.program.found()

mesonbuild/modules/gnome.py

@@ -44,7 +44,7 @@
     from ..interpreter import Interpreter
     from ..interpreterbase import TYPE_var, TYPE_kwargs
     from ..mesonlib import FileOrString
-    from ..programs import Program
+    from ..programs import Program, CommandList, CommandListEntry
 
     class PostInstall(TypedDict):
         glib_compile_schemas: bool
@@ -395,7 +395,7 @@ def compile_resources(self, state: 'ModuleState', args: T.Tuple[str, 'FileOrStri
         glib_version = self._get_native_glib_version(state)
 
         glib_compile_resources = self._find_tool(state, 'glib-compile-resources')
-        cmd: T.List[T.Union[Program, str]] = [glib_compile_resources, '@INPUT@']
+        cmd: CommandList = [glib_compile_resources, '@INPUT@']
 
         source_dirs = kwargs['source_dir']
         dependencies = kwargs['dependencies']
@@ -493,7 +493,7 @@ def compile_resources(self, state: 'ModuleState', args: T.Tuple[str, 'FileOrStri
             raise MesonException('GResource header is installed yet export is not enabled')
 
         depfile: T.Optional[str] = None
-        target_cmd: T.List[T.Union[Program, str]]
+        target_cmd: CommandList
         if not mesonlib.version_compare(glib_version, gresource_dep_needed_version):
             # This will eventually go out of sync if dependencies are added
             target_cmd = cmd
@@ -1190,7 +1190,8 @@ def generate_gir(self, state: 'ModuleState', args: T.Tuple[T.List[T.Union[Execut
 
         gir_inc_dirs: T.List[str] = []
 
-        scan_command: T.List[T.Union[str, Program, Executable]] = [giscanner]
+        # Executables are passed as indexes other than 0 in this List
+        scan_command: T.List[T.Union[CommandListEntry, Executable]] = [giscanner]
         scan_command += ['--quiet']
         scan_command += ['--no-libtool']
         scan_command += ['--namespace=' + ns, '--nsversion=' + nsversion]
@@ -1264,7 +1265,7 @@ def compile_schemas(self, state: 'ModuleState', args: T.List['TYPE_var'], kwargs
         srcdir = os.path.join(state.build_to_src, state.subdir)
         outdir = state.subdir
 
-        cmd: T.List[T.Union[Program, str]] = [self._find_tool(state, 'glib-compile-schemas'), '--targetdir', outdir, srcdir]
+        cmd: CommandList = [self._find_tool(state, 'glib-compile-schemas'), '--targetdir', outdir, srcdir]
         if state.subdir == '':
             targetname = 'gsettings-compile'
         else:
@@ -1344,7 +1345,7 @@ def yelp(self, state: 'ModuleState', args: T.Tuple[str, T.List[str]], kwargs: 'Y
 
         pot_file = os.path.join('@SOURCE_ROOT@', state.subdir, 'C', project_id + '.pot')
         pot_sources = [os.path.join('@SOURCE_ROOT@', state.subdir, 'C', s) for s in sources]
-        pot_args: T.List[T.Union[Program, str]] = [itstool, '-o', pot_file]
+        pot_args: CommandList = [itstool, '-o', pot_file]
         pot_args.extend(pot_sources)
         pottarget = build.RunTarget(f'help-{project_id}-pot', pot_args, [],
                                     os.path.join(state.subdir, 'C'), state.subproject,
@@ -1376,7 +1377,7 @@ def yelp(self, state: 'ModuleState', args: T.Tuple[str, T.List[str]], kwargs: 'Y
                 targets.append(l_data)
 
             po_file = l + '.po'
-            po_args: T.List[T.Union[Program, str]] = [
+            po_args: CommandList = [
                 msgmerge, '-q', '-o',
                 os.path.join('@SOURCE_ROOT@', l_subdir, po_file),
                 os.path.join('@SOURCE_ROOT@', l_subdir, po_file), pot_file]
@@ -1641,7 +1642,7 @@ def gdbus_codegen(self, state: 'ModuleState', args: T.Tuple[str, T.Optional[T.Un
                       kwargs: 'GdbusCodegen') -> ModuleReturnValue:
         namebase = args[0]
         xml_files: T.List[T.Union['FileOrString', build.GeneratedTypes]] = [args[1]] if args[1] else []
-        cmd: T.List[T.Union[Program, str]] = [self._find_tool(state, 'gdbus-codegen')]
+        cmd: CommandList = [self._find_tool(state, 'gdbus-codegen')]
         cmd.extend(kwargs['extra_args'])
 
         # Autocleanup supported?
@@ -2046,7 +2047,7 @@ def _make_mkenum_impl(
             install_dir: T.Optional[T.Sequence[T.Union[str, bool]]] = None,
             depends: T.Optional[T.Sequence[build.BuildTargetTypes]] = None
             ) -> build.CustomTarget:
-        real_cmd: T.List[T.Union[str, Program]] = [self._find_tool(state, 'glib-mkenums')]
+        real_cmd: CommandList = [self._find_tool(state, 'glib-mkenums')]
         real_cmd.extend(cmd)
         _install_dir = install_dir or state.environment.coredata.optstore.get_value_for(OptionKey('includedir'))
         assert isinstance(_install_dir, str), 'for mypy'
@@ -2092,7 +2093,7 @@ def genmarshal(self, state: 'ModuleState', args: T.Tuple[str], kwargs: 'GenMarsh
 
         new_genmarshal = mesonlib.version_compare(self._get_native_glib_version(state), '>= 2.53.3')
 
-        cmd: T.List[T.Union[Program, str]] = [self._find_tool(state, 'glib-genmarshal'), '--quiet']
+        cmd: CommandList = [self._find_tool(state, 'glib-genmarshal'), '--quiet']
         if kwargs['prefix']:
             cmd.extend(['--prefix', kwargs['prefix']])
         if kwargs['extra_args']:
@@ -2239,8 +2240,7 @@ def generate_vapi(self, state: 'ModuleState', args: T.Tuple[str], kwargs: 'Gener
         build_dir = os.path.join(state.environment.get_build_dir(), state.subdir)
         source_dir = os.path.join(state.environment.get_source_dir(), state.subdir)
         pkg_cmd, vapi_depends, vapi_packages, vapi_includes, packages = self._extract_vapi_packages(state, kwargs['packages'])
-        cmd: T.List[T.Union[Program, str]]
-        cmd = [state.find_program('vapigen'), '--quiet', f'--library={library}', f'--directory={build_dir}']
+        cmd: CommandList = [state.find_program('vapigen'), '--quiet', f'--library={library}', f'--directory={build_dir}']
         cmd.extend([f'--vapidir={d}' for d in kwargs['vapi_dirs']])
         cmd.extend([f'--metadatadir={d}' for d in kwargs['metadata_dirs']])
         cmd.extend([f'--girdir={d}' for d in kwargs['gir_dirs']])

mesonbuild/modules/wayland.py

@@ -17,7 +17,7 @@
     from . import ModuleState
     from ..dependencies import Dependency
     from ..interpreter import Interpreter
-    from ..programs import Program
+    from ..programs import CommandList, Program
     from ..mesonlib import FileOrString
 
     class ScanXML(TypedDict):
@@ -88,7 +88,7 @@ def scan_xml(self, state: ModuleState, args: T.Tuple[T.List[FileOrString]], kwar
             targets.append(code)
 
             for side in sides:
-                command: T.List[T.Union[Program, str]] = [self.scanner_bin, f'{side}-header', '@INPUT@', '@OUTPUT@']
+                command: CommandList = [self.scanner_bin, f'{side}-header', '@INPUT@', '@OUTPUT@']
                 if kwargs['include_core_only']:
                     command.append('--include-core-only')
 

mesonbuild/modules/windows.py

@@ -23,6 +23,7 @@
     from ..compilers import Compiler
     from ..interpreter import Interpreter
     from ..interpreter.interpreter import SourceOutputs
+    from ..programs import CommandList
 
     from typing_extensions import TypedDict
 
@@ -201,7 +202,7 @@ def get_names() -> T.Iterable[T.Tuple[str, str, T.Union[str, mesonlib.File, buil
             name = name.replace('/', '_').replace('\\', '_').replace(':', '_')
             name_formatted = name_formatted.replace('/', '_').replace('\\', '_').replace(':', '_')
             output = f'{name}_@BASENAME@.{suffix}'
-            command: T.List[T.Union[str, ExternalProgram]] = []
+            command: CommandList = []
             command.append(rescomp)
             command.extend(res_args)
             depfile: T.Optional[str] = None

mesonbuild/programs.py

@@ -20,9 +20,13 @@
 from .mesonlib import MachineChoice, OrderedSet
 
 if T.TYPE_CHECKING:
+    from typing_extensions import TypeAlias
     from .environment import Environment
     from .interpreter import Interpreter
 
+    CommandListEntry: TypeAlias = T.Union[str, 'Program']
+    CommandList: TypeAlias = T.List[CommandListEntry]
+
 
 class Program(mesonlib.HoldableObject, metaclass=ABCMeta):
     ''' A base class for LocalProgram and ExternalProgram.'''