Method parse_command_only

cmd2/parsing.py:557–614

Identify the command and arguments from raw input. Partially parse input into a [cmd2.PartialStatement][] object. The command is identified, and shortcuts and aliases are expanded. Multiline commands are identified, but terminators and output redirection are not par

(self, rawinput: str)

        )

    def parse_command_only(self, rawinput: str) -> PartialStatement:
        """Identify the command and arguments from raw input.

        Partially parse input into a [cmd2.PartialStatement][] object.

        The command is identified, and shortcuts and aliases are expanded.
        Multiline commands are identified, but terminators and output
        redirection are not parsed.

        This method is optimized for completion code and gracefully handles
        unclosed quotes without raising exceptions.

        [cmd2.parsing.PartialStatement.args][] will include all output redirection
        clauses and command terminators.

        Note:
            Unlike [cmd2.parsing.StatementParser.parse][], this method
            preserves internal whitespace within the args. It ensures
            args has no leading whitespace, and it strips trailing
            whitespace only if all quotes are closed.

        :param rawinput: the command line as entered by the user
        :return: a [cmd2.PartialStatement][] object representing the split input

        """
        # Expand shortcuts and aliases
        line = self._expand(rawinput)

        command = ""
        args = ""
        match = self._command_pattern.search(line)

        if match:
            # Extract the resolved command
            command = match.group(1)

            # If the command is empty, the input was either empty or started with
            # something like a redirector ('>') or terminator (';').
            if command:
                # args is everything after the command match
                args = line[match.end(1) :].lstrip()

                try:
                    # Check for closed quotes
                    shlex_split(args)
                except ValueError:
                    # Unclosed quote: preserve trailing whitespace for completion context.
                    pass
                else:
                    # Quotes are closed: strip trailing whitespace
                    args = args.rstrip()

        return PartialStatement(
            command=command,
            args=args,
            raw=rawinput,
            multiline_command=command in self.multiline_commands,
        )