@typespec/http-client-python 0.1.0

package/eng/scripts/ci/run_apiview.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# This script is used to execute apiview generation within a tox environment. Depending on which package is being executed against,
+# a failure may be suppressed.
+
+from subprocess import check_call, CalledProcessError
+import logging
+from util import run_check
+
+logging.getLogger().setLevel(logging.INFO)
+
+
+def _single_dir_apiview(mod):
+    loop = 0
+    while True:
+        try:
+            check_call(
+                [
+                    "apistubgen",
+                    "--pkg-path",
+                    str(mod.absolute()),
+                ]
+            )
+        except CalledProcessError as e:
+            if loop >= 2:  # retry for maximum 3 times because sometimes the apistubgen has transient failure.
+                logging.error("{} exited with apiview generation error {}".format(mod.stem, e.returncode))
+                return False
+            else:
+                loop += 1
+                continue
+        return True
+
+
+if __name__ == "__main__":
+    run_check("apiview", _single_dir_apiview, "APIView")

package/eng/scripts/ci/run_mypy.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# This script is used to execute mypy within a tox environment. Depending on which package is being executed against,
+# a failure may be suppressed.
+
+from subprocess import check_call, CalledProcessError
+import os
+import logging
+import sys
+from util import run_check
+
+logging.getLogger().setLevel(logging.INFO)
+
+
+def get_config_file_location():
+    mypy_ini_path = os.path.join(os.getcwd(), "../../eng/scripts/ci/mypy.ini")
+    if os.path.exists(mypy_ini_path):
+        return mypy_ini_path
+    else:
+        return os.path.join(os.getcwd(), "../../../eng/scripts/ci/mypy.ini")
+
+
+def _single_dir_mypy(mod):
+    inner_class = next(d for d in mod.iterdir() if d.is_dir() and not str(d).endswith("egg-info"))
+    try:
+        check_call(
+            [
+                sys.executable,
+                "-m",
+                "mypy",
+                "--config-file",
+                get_config_file_location(),
+                "--ignore-missing",
+                str(inner_class.absolute()),
+            ]
+        )
+        return True
+    except CalledProcessError as e:
+        logging.error("{} exited with mypy error {}".format(inner_class.stem, e.returncode))
+        return False
+
+
+if __name__ == "__main__":
+    run_check("mypy", _single_dir_mypy, "MyPy")

package/eng/scripts/ci/run_pylint.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# This script is used to execute pylint within a tox environment. Depending on which package is being executed against,
+# a failure may be suppressed.
+
+from subprocess import check_call, CalledProcessError
+import os
+import logging
+import sys
+from util import run_check
+
+logging.getLogger().setLevel(logging.INFO)
+
+
+def get_rfc_file_location():
+    rfc_file_location = os.path.join(os.getcwd(), "../../../eng/scripts/ci/pylintrc")
+    if os.path.exists(rfc_file_location):
+        return rfc_file_location
+    else:
+        return os.path.join(os.getcwd(), "../../../../eng/scripts/ci/pylintrc")
+
+
+def _single_dir_pylint(mod):
+    inner_class = next(d for d in mod.iterdir() if d.is_dir() and not str(d).endswith("egg-info"))
+    try:
+        check_call(
+            [
+                sys.executable,
+                "-m",
+                "pylint",
+                "--rcfile={}".format(get_rfc_file_location()),
+                "--evaluation=(max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention + info)/ statement) * 10)))",
+                "--load-plugins=pylint_guidelines_checker",
+                "--output-format=parseable",
+                str(inner_class.absolute()),
+            ]
+        )
+        return True
+    except CalledProcessError as e:
+        logging.error("{} exited with linting error {}".format(str(inner_class.absolute()), e.returncode))
+        return False
+
+
+if __name__ == "__main__":
+    run_check("pylint", _single_dir_pylint, "Pylint")

package/eng/scripts/ci/run_pyright.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# This script is used to execute pyright within a tox environment. Depending on which package is being executed against,
+# a failure may be suppressed.
+
+import os
+from subprocess import check_output, CalledProcessError
+import logging
+import sys
+import time
+from util import run_check
+
+logging.getLogger().setLevel(logging.INFO)
+
+
+def get_pyright_config_file_location():
+    pyright_config = os.path.join(os.getcwd(), "../../eng/scripts/ci/pyrightconfig.json")
+    if os.path.exists(pyright_config):
+        return pyright_config
+    else:
+        return os.path.join(os.getcwd(), "../../../eng/scripts/ci/pyrightconfig.json")
+
+
+def _single_dir_pyright(mod):
+    inner_class = next(d for d in mod.iterdir() if d.is_dir() and not str(d).endswith("egg-info"))
+    retries = 3
+    while retries:
+        try:
+            check_output(
+                [
+                    sys.executable,
+                    "-m",
+                    "pyright",
+                    "-p",
+                    get_pyright_config_file_location(),
+                    str(inner_class.absolute()),
+                ],
+                text=True,
+            )
+            return True
+        except CalledProcessError as e:
+            logging.exception("{} exited with pyright error {}".format(inner_class.stem, e.returncode))
+            logging.error(f"PyRight stdout:\n{e.stdout}\n===========")
+            logging.error(f"PyRight stderr:\n{e.stderr}\n===========")
+            # PyRight has shown to randomly failed with a 217, retry the same folder 3 times should help
+            retries -= 1
+            time.sleep(5)
+
+    return False
+
+
+if __name__ == "__main__":
+    run_check("pyright", _single_dir_pyright, "PyRight")

package/eng/scripts/ci/util.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import os
+import logging
+from pathlib import Path
+import argparse
+from multiprocessing import Pool
+
+logging.getLogger().setLevel(logging.INFO)
+
+ROOT_FOLDER = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "..", "..", "..", "generator"))
+
+IGNORE_FOLDER = []
+
+
+def run_check(name, call_back, log_info):
+    parser = argparse.ArgumentParser(
+        description=f"Run {name} against target folder. Add a local custom plugin to the path prior to execution. "
+    )
+    parser.add_argument(
+        "-t",
+        "--test-folder",
+        dest="test_folder",
+        help="The test folder we're in. Can be 'azure', 'multiapi', or 'vanilla'",
+        required=True,
+    )
+    parser.add_argument(
+        "-g",
+        "--generator",
+        dest="generator",
+        help="The generator we're using. Can be 'legacy', 'version-tolerant'.",
+        required=False,
+    )
+    parser.add_argument(
+        "-f",
+        "--file-name",
+        dest="file_name",
+        help="The specific file name if you only want to run one file. Optional.",
+        required=False,
+    )
+    parser.add_argument(
+        "-s",
+        "--subfolder",
+        dest="subfolder",
+        help="The specific sub folder to validate, default to Expected/AcceptanceTests. Optional.",
+        required=False,
+        default="Expected/AcceptanceTests",
+    )
+
+    args = parser.parse_args()
+
+    pkg_dir = Path(ROOT_FOLDER) / Path("test") / Path(args.test_folder)
+    if args.generator:
+        pkg_dir /= Path(args.generator)
+    if args.subfolder:
+        pkg_dir /= Path(args.subfolder)
+    dirs = [d for d in pkg_dir.iterdir() if d.is_dir() and not d.stem.startswith("_") and d.stem not in IGNORE_FOLDER]
+    if args.file_name:
+        dirs = [d for d in dirs if args.file_name.lower() in d.stem.lower()]
+    if len(dirs) > 1:
+        with Pool() as pool:
+            result = pool.map(call_back, dirs)
+        response = all(result)
+    else:
+        response = call_back(dirs[0])
+    if not response:
+        logging.error("%s fails", log_info)
+        exit(0)

package/eng/scripts/ci/utils.ts

@@ -0,0 +1,48 @@
+/* eslint-disable no-console */
+import chalk from "chalk";
+import { exec } from "child_process";
+import { existsSync } from "fs";
+import { dirname, join, resolve } from "path";
+import process from "process";
+import { fileURLToPath } from "url";
+import { parseArgs } from "util";
+
+const argv = parseArgs({
+  args: process.argv.slice(2),
+  options: {
+    pythonPath: { type: "string" },
+  },
+});
+
+// execute the command
+export function executeCommand(command: string, prettyName: string) {
+  exec(command, (error, stdout, stderr) => {
+    if (error) {
+      console.error(chalk.red(`Error executing ${command}(stdout): ${stdout}`));
+      console.error(chalk.red(`Error executing ${command}{stderr}: ${stderr}`));
+      process.exit(1);
+    }
+    if (stderr) {
+      // Process stderr output
+      console.log(chalk.yellow(`${command}:\n${stderr}`));
+      return;
+    }
+    console.log(chalk.green(`${prettyName} passed`));
+  });
+}
+
+// Function to run a command and log the output
+export function runCommand(command: string, prettyName: string) {
+  let pythonPath = argv.values.pythonPath
+    ? resolve(argv.values.pythonPath)
+    : join(dirname(fileURLToPath(import.meta.url)), "..", "..", "..", "venv/");
+  if (existsSync(join(pythonPath, "bin"))) {
+    pythonPath = join(pythonPath, "bin", "python");
+  } else if (existsSync(join(pythonPath, "Scripts"))) {
+    pythonPath = join(pythonPath, "Scripts", "python");
+  } else {
+    throw new Error(pythonPath);
+  }
+  command = `${pythonPath} -m ${command}`;
+  executeCommand(command, prettyName);
+}

package/eng/scripts/setup/install.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import sys
+
+if not sys.version_info >= (3, 8, 0):
+    raise Exception("Autorest for Python extension requires Python 3.8 at least")
+
+try:
+    import pip
+except ImportError:
+    raise Exception("Your Python installation doesn't have pip available")
+
+try:
+    import venv
+except ImportError:
+    raise Exception("Your Python installation doesn't have venv available")
+
+
+# Now we have pip and Py >= 3.8, go to work
+
+from pathlib import Path
+
+from venvtools import ExtendedEnvBuilder, python_run
+
+_ROOT_DIR = Path(__file__).parent.parent.parent.parent
+
+
+def main():
+    venv_path = _ROOT_DIR / "venv"
+    if venv_path.exists():
+        env_builder = venv.EnvBuilder(with_pip=True)
+        venv_context = env_builder.ensure_directories(venv_path)
+    else:
+        env_builder = ExtendedEnvBuilder(with_pip=True, upgrade_deps=True)
+        env_builder.create(venv_path)
+        venv_context = env_builder.context
+
+        python_run(venv_context, "pip", ["install", "-U", "pip"])
+        python_run(
+            venv_context,
+            "pip",
+            ["install", "-r", f"{_ROOT_DIR}/generator/requirements.txt"],
+        )
+        python_run(venv_context, "pip", ["install", "-e", f"{_ROOT_DIR}/generator"])
+
+
+if __name__ == "__main__":
+    main()

package/eng/scripts/setup/prepare.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import sys
+import os
+import argparse
+
+if not sys.version_info >= (3, 8, 0):
+    raise Exception("Autorest for Python extension requires Python 3.8 at least")
+
+from pathlib import Path
+import venv
+
+from venvtools import python_run
+
+_ROOT_DIR = Path(__file__).parent.parent.parent.parent
+
+
+def main():
+    venv_path = _ROOT_DIR / "venv"
+    venv_preexists = venv_path.exists()
+
+    assert venv_preexists  # Otherwise install was not done
+
+    env_builder = venv.EnvBuilder(with_pip=True)
+    venv_context = env_builder.ensure_directories(venv_path)
+    try:
+        python_run(
+            venv_context,
+            "pip",
+            ["install", "-r", f"{_ROOT_DIR}/generator/dev_requirements.txt"],
+        )
+    except FileNotFoundError as e:
+        raise ValueError(e.filename)
+
+
+if __name__ == "__main__":
+    main()

package/eng/scripts/setup/run-python3.ts

@@ -0,0 +1,25 @@
+// This script wraps logic in @azure-tools/extension to resolve
+// the path to Python 3 so that a Python script file can be run
+// from an npm script in package.json.  It uses the same Python 3
+// path resolution algorithm as AutoRest so that the behavior
+// is fully consistent (and also supports AUTOREST_PYTHON_EXE).
+//
+// Invoke it like so: "tsx run-python3.ts script.py"
+
+import cp from "child_process";
+import { patchPythonPath } from "./system-requirements.js";
+
+async function runPython3(...args: string[]) {
+  const command = await patchPythonPath(["python", ...args], {
+    version: ">=3.8",
+    environmentVariable: "AUTOREST_PYTHON_EXE",
+  });
+  cp.execSync(command.join(" "), {
+    stdio: [0, 1, 2],
+  });
+}
+
+runPython3(...process.argv.slice(2)).catch((err) => {
+  console.error(err.toString()); // eslint-disable-line no-console
+  process.exit(1);
+});

package/eng/scripts/setup/run_tsp.py

@@ -0,0 +1,42 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import sys
+import venv
+import logging
+from pathlib import Path
+from pygen import m2r, preprocess, codegen, black
+from pygen.utils import parse_args
+
+_ROOT_DIR = Path(__file__).parent.parent.parent.parent
+
+_LOGGER = logging.getLogger(__name__)
+
+if __name__ == "__main__":
+    venv_path = _ROOT_DIR / "venv"
+    venv_preexists = venv_path.exists()
+
+    assert venv_preexists  # Otherwise install was not done
+
+    env_builder = venv.EnvBuilder(with_pip=True)
+    venv_context = env_builder.ensure_directories(venv_path)
+
+    if "--debug" in sys.argv or "--debug=true" in sys.argv:
+        try:
+            import debugpy  # pylint: disable=import-outside-toplevel
+        except ImportError:
+            raise SystemExit("Please pip install ptvsd in order to use VSCode debugging")
+
+        # 5678 is the default attach port in the VS Code debug configurations
+        debugpy.listen(("localhost", 5678))
+        debugpy.wait_for_client()
+        breakpoint()  # pylint: disable=undefined-variable
+
+    # run m2r
+    args, unknown_args = parse_args()
+    m2r.M2R(output_folder=args.output_folder, cadl_file=args.cadl_file, **unknown_args).process()
+    preprocess.PreProcessPlugin(output_folder=args.output_folder, cadl_file=args.cadl_file, **unknown_args).process()
+    codegen.CodeGenerator(output_folder=args.output_folder, cadl_file=args.cadl_file, **unknown_args).process()
+    black.BlackScriptPlugin(output_folder=args.output_folder, **unknown_args).process()