Function cli

tests/debugpy/server/test_cli.py:19–86

(pyfile)

@pytest.fixture
def cli(pyfile):
    @pyfile
    def cli_parser():
        import os
        import pickle
        import sys
        from debugpy.server import cli

        try:
            cli.parse_args()
        except Exception as exc:
            os.write(1, pickle.dumps(exc))
            sys.exit(1)

        # Check that sys.argv has the correct type after parsing - there should be no bytes.
        assert all(isinstance(s, str) for s in sys.argv)

        # We only care about options that correspond to public switches.
        options = {
            name: getattr(cli.options, name)
            for name in [
                "address",
                "config",
                "log_to",
                "log_to_stderr",
                "mode",
                "target",
                "target_kind",
                "wait_for_client",
                "parent_session_pid",
            ]
        }

        # Serialize the command line args and the options to stdout
        serialized_data = pickle.dumps([sys.argv[1:], options])
        os.write(1, serialized_data)
        # Ensure all data is written before process exits
        sys.stdout.flush()

    def parse(args):
        log.debug("Parsing argv: {0!r}", args)
        try:
            try:
                # Run the CLI parser in a subprocess, and capture its output.
                output = subprocess.check_output(
                    [sys.executable, "-u", cli_parser.strpath] + args,
                    stderr=subprocess.PIPE  # Capture stderr to help with debugging
                )

                # Deserialize the output and return the parsed argv and options.
                try:
                    argv, options = pickle.loads(output)
                except Exception as e:
                    log.debug("Failed to deserialize output: {0}, Output was: {1!r}", e, output)
                    raise
            except subprocess.CalledProcessError as exc:
                log.debug("Process exited with code {0}. Output: {1!r}, Error: {2!r}",
                         exc.returncode, exc.output, exc.stderr)