Source code for univention.debhelper

# SPDX-FileCopyrightText: 2010-2025 Univention GmbH
# SPDX-License-Identifier: AGPL-3.0-only
"""Debhelper compatible routines."""

from __future__ import annotations

import os
import subprocess
from argparse import ArgumentParser, Namespace  # noqa: TC003
from typing import TYPE_CHECKING


if TYPE_CHECKING:
    from collections.abc import Sequence




def doIt(*argv: str) -> int:
    """
    Execute argv and wait.

    :param argv: List of command and arguments.

    >>> doIt('true')
    0
    """
    if os.environ.get('DH_VERBOSE'):
        print('\t%s' % ' '.join(argv))
    return subprocess.check_call(argv)





def binary_packages() -> list[str]:
    """
    Get list of binary packages from debian/control file.

    >>> binary_packages() #doctest: +ELLIPSIS
    [...]
    """
    _prefix = 'Package: '
    packages = []
    with open('debian/control') as f:
        for line in f:
            if not line.startswith(_prefix):
                continue
            packages.append(line[len(_prefix): -1])

    return packages





def parseRfc822(f: str) -> list[dict[str, list[str]]]:
    r"""
    Parses string `f` as a :rfc:`822` conforming file and returns list of sections, each a dict mapping keys to lists of values.
    Splits file into multiple sections separated by blank line.

    :param f: The messate to parse.
    :returns: A list of dictionaries.

    .. note::
        For real Debian files, use the :py:mod:`debian.deb822` module from the `python-debian` package.

    >>> res = parseRfc822('Type: file\nFile: /etc/fstab\n\nType: Script\nScript: /bin/false\n')
    >>> res == [{'Type': ['file'], 'File': ['/etc/fstab']}, {'Type': ['Script'], 'Script': ['/bin/false']}]
    True
    >>> parseRfc822('')
    []
    >>> parseRfc822('\n')
    []
    >>> parseRfc822('\n\n')
    []
    """
    res: list[dict[str, list[str]]] = []
    ent: dict[str, list[str]] = {}
    for line in f.splitlines():
        if line:
            try:
                key, value = line.split(': ', 1)
            except ValueError:
                pass
            else:
                ent.setdefault(key, []).append(value)
        elif ent:
            res.append(ent)
            ent = {}

    if ent:
        res.append(ent)

    return res





def parser_dh_sequence(parser: ArgumentParser, argv: Sequence[str] | None = None) -> Namespace:
    """
    Add common argument for Debian helper sequence.

    :param parser: argument parser
    :returns: parsed arguments

    >>> parser = ArgumentParser()
    >>> args = parser_dh_sequence(parser, ["-v"])
    >>> args.verbose
    True
    """
    parser.add_argument(
        '--verbose', '-v',
        action='store_true',
        help='Verbose mode: show all commands that modify the package build directory.')
    group = parser.add_argument_group("debhelper", "Common debhelper options")
    group.add_argument("--arch", "-a", action="store_true", help="Act on all architecture dependent packages.")
    group.add_argument("--indep", "-i", action="store_true", help="Act on all architecture independent packages.")
    group.add_argument("--option", "-O", action="append", help="Additional debhelper options.")

    args = parser.parse_args(argv)

    if args.verbose:
        os.environ['DH_VERBOSE'] = '1'

    return args



if __name__ == '__main__':
    import doctest
    doctest.testmod()