Skip to content

sort

frequenz.repo.config.cli.version.mike.sort ¤

Sort mike's version.json file with a custom order.

Functions¤

frequenz.repo.config.cli.version.mike.sort._dump_versions_to ¤

_dump_versions_to(
    versions: dict[str, dict[str, Any]], stream: TextIO
) -> None

Dump the versions to the given stream.

PARAMETER DESCRIPTION
versions

The versions to dump.

TYPE: dict[str, dict[str, Any]]

stream

The stream to write the versions to.

TYPE: TextIO

Source code in frequenz/repo/config/cli/version/mike/sort.py 
28
29
30
31
32
33
34
35
def _dump_versions_to(versions: dict[str, dict[str, Any]], stream: TextIO) -> None:
    """Dump the versions to the given stream.

    Args:
        versions: The versions to dump.
        stream: The stream to write the versions to.
    """
    json.dump(list(versions.values()), stream, separators=(",", ":"))

frequenz.repo.config.cli.version.mike.sort._load_and_sort_versions_from ¤

_load_and_sort_versions_from(
    stream: TextIO,
) -> dict[str, dict[str, Any]]

Load the versions from the given stream and sort them.

PARAMETER DESCRIPTION
stream

The stream to read the versions from.

TYPE: TextIO

RETURNS DESCRIPTION
dict[str, dict[str, Any]]

The sorted loaded versions.
Source code in frequenz/repo/config/cli/version/mike/sort.py 
15
16
17
18
19
20
21
22
23
24
25
def _load_and_sort_versions_from(stream: TextIO) -> dict[str, dict[str, Any]]:
    """Load the versions from the given stream and sort them.

    Args:
        stream: The stream to read the versions from.

    Returns:
        The sorted loaded versions.
    """
    versions = {v["version"]: v for v in json.load(stream)}
    return {v: versions[v] for v in sort_mike_versions(list(versions.keys()))}

frequenz.repo.config.cli.version.mike.sort.main ¤

main() -> None

Sort mike's version.json file with a custom order.

The versions are sorted using sort_versions().

If no arguments are given, then the contents are read from stdin and the sorted versions are printed to stdout.

If one argument is given, then the contents of the file are replaced with the sorted versions.

If more than one argument is given, then an error is printed to stderr and the program exits with a non-zero exit code.

Source code in frequenz/repo/config/cli/version/mike/sort.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def main() -> None:
    """Sort `mike`'s `version.json` file with a custom order.

    The versions are sorted using `sort_versions()`.

    If no arguments are given, then the contents are read from stdin and the sorted
    versions are printed to stdout.

    If one argument is given, then the contents of the file are replaced with the sorted
    versions.

    If more than one argument is given, then an error is printed to stderr and the
    program exits with a non-zero exit code.
    """
    github.configure_logging()

    match len(sys.argv):
        case 1:
            _dump_versions_to(_load_and_sort_versions_from(sys.stdin), sys.stdout)
        case 2:
            with open(sys.argv[1], "r", encoding="utf8") as stream_in:
                versions = _load_and_sort_versions_from(stream_in)
            with open(sys.argv[1], "w", encoding="utf8") as stream_out:
                _dump_versions_to(versions, stream_out)

        case _:
            print(
                f"""\
Usage: {sys.argv[0]} [<versions.json>]

If <versions.json> is given, the contents will be replaced with the sorted versions.
Otherwise, the contents are read from stdin and the sorted versions are printed to stdout.
""",
                file=sys.stderr,
            )
            sys.exit(2)