Method check_ambiguity

invoke/parser/parser.py:381–404

Guard against ambiguity when current flag takes an optional value. .. versionadded:: 1.0

(self, value: Any)

            self.flag.set_value(True, cast=False)

    def check_ambiguity(self, value: Any) -> bool:
        """
        Guard against ambiguity when current flag takes an optional value.

        .. versionadded:: 1.0
        """
        # No flag is currently being examined, or one is but it doesn't take an
        # optional value? Ambiguity isn't possible.
        if not (self.flag and self.flag.optional):
            return False
        # We *are* dealing with an optional-value flag, but it's already
        # received a value? There can't be ambiguity here either.
        if self.flag.raw_value is not None:
            return False
        # Otherwise, there *may* be ambiguity if 1 or more of the below tests
        # fail.
        tests = []
        # Unfilled posargs still exist?
        tests.append(self.context and self.context.missing_positional_args)
        # Value matches another valid task/context name?
        tests.append(value in self.contexts)
        if any(tests):
            msg = "{!r} is ambiguous when given after an optional-value flag"
            raise ParseError(msg.format(value))

    def switch_to_flag(self, flag: str, inverse: bool = False) -> None:
        # Sanity check for ambiguity w/ prior optional-value flag