summaryrefslogtreecommitdiffstats
path: root/test/lib/ansible_test/_internal/cli/epilog.py
blob: 3800ff1c0c0ba17ca9c3a2f0606c4e364c38f19f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
"""Argument parsing epilog generation."""
from __future__ import annotations

from .argparsing import (
    CompositeActionCompletionFinder,
)

from ..data import (
    data_context,
)


def get_epilog(completer: CompositeActionCompletionFinder) -> str:
    """Generate and return the epilog to use for help output."""
    if completer.enabled:
        epilog = 'Tab completion available using the "argcomplete" python package.'
    else:
        epilog = 'Install the "argcomplete" python package to enable tab completion.'

    if data_context().content.unsupported:
        epilog += '\n\n' + data_context().explain_working_directory()

    return epilog