Class MacroArg

cmd2/parsing.py:48–74

Information used to resolve or unescape macro arguments.

@dataclass(frozen=True, slots=True)
class MacroArg:
    """Information used to resolve or unescape macro arguments."""

    # The starting index of this argument in the macro value
    start_index: int

    # The number string that appears between the braces
    # This is a string instead of an int because we support unicode digits and must be able
    # to reproduce this string later
    number_str: str

    # Tells if this argument is escaped and therefore needs to be unescaped
    is_escaped: bool

    # Matches normal args like {5}
    # Uses lookarounds to ensure exactly one brace.
    # (?<!{){ -> Match '{' not preceded by '{'
    # \d+     -> Match digits
    # }(?!})  -> Match '}' not followed by '}'
    macro_normal_arg_pattern: ClassVar[re.Pattern[str]] = re.compile(r"(?<!{){\d+}|{\d+}(?!})")

    # Matches escaped args like {{5}}
    # Specifically looking for exactly two braces on each side.
    macro_escaped_arg_pattern: ClassVar[re.Pattern[str]] = re.compile(r"{{2}\d+}{2}")

    # Finds a string of digits
    digit_pattern: ClassVar[re.Pattern[str]] = re.compile(r"\d+")


@dataclass(frozen=True, slots=True)