xref: /aosp_15_r20/external/pigweed/pw_cli/py/pw_cli/aliases.py (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1# Copyright 2024 The Pigweed Authors
2#
3# Licensed under the Apache License, Version 2.0 (the "License"); you may not
4# use this file except in compliance with the License. You may obtain a copy of
5# the License at
6#
7#     https://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12# License for the specific language governing permissions and limitations under
13# the License.
14"""Provides utilities for registering custom command alias."""
15
16import subprocess
17import sys
18
19from typing import Callable
20
21
22def alias(*command) -> Callable[[], int]:
23    """Creates a *command alias, conctenated with CLI arguments in runtime."""
24    # Exclude the first argv: `subcmd arg1 arg2` --> `arg1 arg2`.
25    return lambda: subprocess.run([*command, *sys.argv[1:]]).returncode
26