@autorest/python 6.18.0 → 6.20.0

package/generator/pygen/codegen/templates/model_base.py.jinja2

@@ -454,6 +454,10 @@ def _serialize(o, format: typing.Optional[str] = None):  # pylint: disable=too-m
         return float(o)
     if isinstance(o, enum.Enum):
         return o.value
+    if isinstance(o, int):
+        if format == "str":
+            return str(o)
+        return o
     try:
         # First try datetime.datetime
         return _serialize_datetime(o, format)
@@ -489,6 +493,9 @@ def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typin
 
 class Model(_MyMutableMapping):
     _is_model = True
+    # label whether current class's _attr_to_rest_field has been calculated
+    # could not see _attr_to_rest_field directly because subclass inherits it from parent class
+    _calculated: typing.Set[str] = set()
 
     def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
         class_name = self.__class__.__name__
@@ -521,24 +528,27 @@ class Model(_MyMutableMapping):
         return Model(self.__dict__)
 
     def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: disable=unused-argument
-        # we know the last three classes in mro are going to be 'Model', 'dict', and 'object'
-        mros = cls.__mro__[:-3][::-1]  # ignore model, dict, and object parents, and reverse the mro order
-        attr_to_rest_field: typing.Dict[str, _RestField] = {  # map attribute name to rest_field property
-            k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type")
-        }
-        annotations = {
-            k: v
-            for mro_class in mros
-            if hasattr(mro_class, "__annotations__")  # pylint: disable=no-member
-            for k, v in mro_class.__annotations__.items()  # pylint: disable=no-member
-        }
-        for attr, rf in attr_to_rest_field.items():
-            rf._module = cls.__module__
-            if not rf._type:
-                rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None))
-            if not rf._rest_name_input:
-                rf._rest_name_input = attr
-        cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items())
+        if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated:
+            # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', 
+            # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object'
+            mros = cls.__mro__[:-9][::-1]  # ignore parents, and reverse the mro order
+            attr_to_rest_field: typing.Dict[str, _RestField] = {  # map attribute name to rest_field property
+                k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type")
+            }
+            annotations = {
+                k: v
+                for mro_class in mros
+                if hasattr(mro_class, "__annotations__")  # pylint: disable=no-member
+                for k, v in mro_class.__annotations__.items()  # pylint: disable=no-member
+            }
+            for attr, rf in attr_to_rest_field.items():
+                rf._module = cls.__module__
+                if not rf._type:
+                    rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None))
+                if not rf._rest_name_input:
+                    rf._rest_name_input = attr
+            cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items())
+            cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}")
 
         return super().__new__(cls)  # pylint: disable=no-value-for-parameter
 
@@ -669,6 +679,8 @@ def _get_deserialize_callable_from_annotation(  # pylint: disable=R0911, R0915,
     rf: typing.Optional["_RestField"] = None,
 ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]:
     if not annotation or annotation in [int, float]:
+        if annotation is int and rf and rf._format == "str":
+            return int
         return None
 
     # is it a type alias?

package/generator/pygen/codegen/templates/vendor.py.jinja2

@@ -70,8 +70,6 @@ FileType = Union[
     Tuple[Optional[str], FileContent, Optional[str]],
 ]
 
-FilesType = Union[Mapping[str, FileType], Sequence[Tuple[str, FileType]]]
-
 def serialize_multipart_data_entry(data_entry: Any) -> Any:
     if isinstance(data_entry, (list, tuple, dict, Model)):
         return json.dumps(data_entry, cls=SdkJSONEncoder, exclude_readonly=True)

package/generator/pygen/m2r.py

@@ -27,7 +27,7 @@ class GeneratorRenderer(m2r2.RestRenderer):
         return f":code:`{html}`"
 
 
-class M2R(YamlUpdatePlugin):  # pylint: disable=abstract-method
+class M2R(YamlUpdatePlugin):
     """A plugin to convert any description and summary from MD to RST."""
 
     def update_yaml(self, yaml_data: Dict[str, Any]) -> None:

package/generator/pygen/postprocess/__init__.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import Tuple, Any, Dict
+from typing import Tuple, Any
 from pathlib import Path
 import os
 import shutil
@@ -28,7 +28,7 @@ def format_file(file: Path, file_content: str) -> str:
     return file_content
 
 
-class PostProcessPlugin(Plugin):  # pylint: disable=abstract-method
+class PostProcessPlugin(Plugin):
     def __init__(self, **kwargs: Any):
         super().__init__(**kwargs)
         output_folder_uri = self.options["outputFolderUri"]

package/generator/pygen/postprocess/venvtools.py

@@ -52,9 +52,7 @@ def create(
     return builder.context
 
 
-def python_run(  # pylint: disable=inconsistent-return-statements
-    venv_context, module, command, directory=_ROOT_DIR
-) -> Optional[str]:
+def python_run(venv_context, module, command, directory=_ROOT_DIR) -> Optional[str]:
     try:
         cmd_line = [
             venv_context.env_exe,

package/generator/pygen/preprocess/__init__.py

@@ -163,7 +163,7 @@ def has_multi_part_content_type(yaml_data: Dict[str, Any]) -> bool:
     return any(ct for ct in yaml_data.get("contentTypes", []) if ct == "multipart/form-data")
 
 
-class PreProcessPlugin(YamlUpdatePlugin):  # pylint: disable=abstract-method
+class PreProcessPlugin(YamlUpdatePlugin):
     """Add Python naming information."""
 
     @property

package/generator/pygen/utils.py

@@ -82,9 +82,7 @@ def parse_args(
         return value
 
     unknown_args_ret = {
-        ua.strip("--").split("=", maxsplit=1)[0]: _get_value(  # pylint: disable=bad-str-strip-call
-            ua.strip("--").split("=", maxsplit=1)[1]  # pylint: disable=bad-str-strip-call
-        )
+        ua.strip("--").split("=", maxsplit=1)[0]: _get_value(ua.strip("--").split("=", maxsplit=1)[1])
         for ua in unknown_args
     }
     return args, unknown_args_ret

package/generator/setup.py

@@ -15,7 +15,7 @@ from setuptools import setup, find_packages
 
 # Version extraction inspired from 'requests'
 with open(os.path.join("pygen", "_version.py"), "r") as fd:
-    version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1)
+    version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1)  # type: ignore
 
 if not version:
     raise RuntimeError("Cannot find version information")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autorest/python",
-  "version": "6.18.0",
+  "version": "6.20.0",
   "description": "The Python extension for generators in AutoRest.",
   "main": "index.js",
   "repository": {
@@ -20,12 +20,14 @@
   "homepage": "https://github.com/Azure/autorest.python/blob/main/README.md",
   "dependencies": {
     "@autorest/system-requirements": "~1.0.2",
-    "fs-extra": "~11.2.0"
+    "fs-extra": "~11.2.0",
+    "tsx": "4.17.0"
   },
   "devDependencies": {
     "@microsoft.azure/autorest.testserver": "^3.3.46",
     "typescript": "~5.1.3",
-    "@azure-tools/typespec-python": "^0.28.0"
+    "chalk": "5.3.0",
+    "@azure-tools/typespec-python": "^0.30.0"
   },
   "files": [
     "autorest/**/*.py",
@@ -37,8 +39,11 @@
   ],
   "scripts": {
     "start": "node ./scripts/run-python3.js ./scripts/start.py",
-    "build": "node ./scripts/copy-generator.js --force",
-    "install": "node ./scripts/copy-generator.js && node ./scripts/run-python3.js ./scripts/install.py",
-    "debug": "node ./scripts/run-python3.js ./scripts/start.py --debug"
+    "build": "tsx ./scripts/copy-generator.ts --force",
+    "install": "tsx ./scripts/copy-generator.ts && node ./scripts/run-python3.js ./scripts/install.py",
+    "debug": "node ./scripts/run-python3.js ./scripts/start.py --debug",
+    "test": "tsx ./scripts/eng/run-tests.ts --validFolders azure/legacy azure/version-tolerant vanilla/legacy vanilla/version-tolerant dpg/version-tolerant",
+    "lint": "tsx ./scripts/eng/lint.ts --folderName autorest --skipEslint true",
+    "format": "tsx ./scripts/eng/format.ts"
   }
 }

package/scripts/copy-generator.ts

@@ -0,0 +1,24 @@
+import { copyFileSync, readdirSync } from "fs";
+import { existsSync, removeSync, copySync } from "fs-extra";
+import { join } from "path";
+
+const force: boolean = process.argv[2] === "--force";
+
+function copyAndCreateDir(sourceDir: string, destDir: string) {
+    // Delete the destination directory if it exists
+    if (existsSync(destDir)) {
+        if (force) removeSync(destDir);
+        else process.exit(0);
+    }
+
+    // Copy the source directory to the destination directory
+    copySync(sourceDir, destDir);
+}
+
+const typespecModulePath: string = join(__dirname, "..", "node_modules", "@azure-tools", "typespec-python");
+
+// Copy the generator directory
+copyAndCreateDir(join(typespecModulePath, "generator"), join(__dirname, "..", "generator"));
+
+// Copy the scripts directory
+copyAndCreateDir(join(typespecModulePath, "scripts", "eng"), join(__dirname, "..", "scripts", "eng"));

package/scripts/eng/format.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-console */
+
+import { runCommand } from "./utils.js";
+
+runCommand("black .", "black");

package/scripts/eng/lint.ts

@@ -0,0 +1,75 @@
+/* eslint-disable no-console */
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { runCommand, executeCommand } from "./utils.js";
+
+interface Arguments {
+    folderName: string;
+    command?: "pylint" | "mypy" | "pyright" | "eslint";
+    skipWarning?: boolean;
+    skipEslint?: boolean;
+}
+
+const validCommands = ["pylint", "mypy", "pyright", "eslint"];
+
+// PARSE INPUT ARGUMENTS
+const argv = yargs(hideBin(process.argv))
+    .option("folderName", {
+        type: "string",
+        choices: ["generator", "autorest"],
+        description: "Specify the flavor",
+        default: "generator",
+    })
+    .option("command", {
+        alias: "c",
+        type: "string",
+        choices: validCommands,
+        description: "Specify the command to run",
+    })
+    .option("skipWarning", {
+        alias: "s",
+        type: "boolean",
+        description: "Skip to check warnings",
+    })
+    .option("skipEslint", {
+        alias: "e",
+        type: "boolean",
+        description: "Skip to check eslint",
+    }).argv as Arguments;
+
+export function pylint() {
+    runCommand(`pylint ${argv.folderName}/ --rcfile ./scripts/eng/pylintrc`, "pylint");
+}
+
+export function mypy() {
+    runCommand(`mypy ${argv.folderName}/ --config-file ./scripts/eng/mypy.ini`, "mypy");
+}
+
+export function pyright() {
+    runCommand(`pyright ${argv.folderName}/ -p ./scripts/eng/pyrightconfig.json`, "pyright");
+}
+
+export function eslint() {
+    // const checkWarning = argv.skipWarning ? "" : "--max-warnings=0";
+    const checkWarning = "";
+    executeCommand(`npx eslint . --ext .ts ${checkWarning} `, "eslint");
+}
+
+if (argv.command === "pylint") {
+    pylint();
+} else if (argv.command === "mypy") {
+    mypy();
+} else if (argv.command === "pyright") {
+    pyright();
+} else if (argv.command === "eslint") {
+    if (!argv.skipEslint) {
+        eslint();
+    }
+} else {
+    pylint();
+    mypy();
+    pyright();
+    if (!argv.skipEslint) {
+        eslint();
+    }
+}

package/scripts/eng/mypy.ini

@@ -0,0 +1,38 @@
+# global configurations
+[mypy]
+python_version = 3.8
+
+
+# module level configuratiohns
+[mypy-jsonrpc.*]
+ignore_missing_imports = True
+
+[mypy-ptvsd.*]
+ignore_missing_imports = True
+
+[mypy-debugpy.*]
+ignore_missing_imports = True
+
+[mypy-m2r2.*]
+ignore_missing_imports = True
+
+[mypy-autorest.common.utils.*]
+ignore_missing_imports = True
+
+[mypy-autorest.common.python_mappings.*]
+ignore_missing_imports = True
+
+[mypy-pygen.codegen.models.*]
+ignore_missing_imports = True
+
+[mypy-setuptools]
+ignore_missing_imports = True
+
+[mypy-*._patch]
+ignore_missing_imports = True
+
+[mypy-pygen.*]
+ignore_missing_imports = True
+
+[mypy-yaml.*]
+ignore_missing_imports = True

package/scripts/eng/pylintrc

@@ -0,0 +1,58 @@
+[MASTER]
+py-version=3.8
+ignore-patterns=test_*,conftest,setup
+reports=no
+
+# PYLINT DIRECTORY BLACKLIST.
+ignore=_generated,samples,examples,test,tests,doc,.tox,generated_samples
+
+[MESSAGES CONTROL]
+
+# Add enable for useless disables
+enable=useless-suppression
+
+# For all codes, run 'pylint --list-msgs' or go to 'https://pylint.readthedocs.io/en/latest/reference_guide/features.html'
+# locally-disabled: Warning locally suppressed using disable-msg
+# cyclic-import: because of https://github.com/PyCQA/pylint/issues/850
+# too-many-arguments: Due to the nature of the CLI many commands have large arguments set which reflect in large arguments set in corresponding methods.
+# Let's black deal with bad-continuation
+disable=useless-object-inheritance,missing-docstring,locally-disabled,fixme,cyclic-import,too-many-arguments,invalid-name,duplicate-code,too-few-public-methods,consider-using-f-string,super-with-arguments,redefined-builtin,import-outside-toplevel,client-suffix-needed,unnecessary-dunder-call,unnecessary-ellipsis,disallowed-name,consider-using-max-builtin
+
+[FORMAT]
+max-line-length=120
+
+[VARIABLES]
+# Tells whether we should check for unused import in __init__ files.
+init-import=yes
+
+[DESIGN]
+# Maximum number of locals for function / method body
+max-locals=25
+# Maximum number of branch for function / method body
+max-branches=20
+# Maximum number of instance attributes for class
+max-attributes=10
+# Maximum number of ancestors
+max-parents=15
+
+[SIMILARITIES]
+min-similarity-lines=10
+
+[BASIC]
+# Naming hints based on PEP 8 (https://www.python.org/dev/peps/pep-0008/#naming-conventions).
+# Consider these guidelines and not hard rules. Read PEP 8 for more details.
+
+# The invalid-name checker must be **enabled** for these hints to be used.
+include-naming-hint=yes
+
+# keep short; underscores are discouraged
+module-naming-style=snake_case
+const-naming-style=UPPER_CASE
+class-naming-style=PascalCase
+class-attribute-naming-style=snake_case
+attr-naming-style=snake_case
+method-naming-style=snake_case
+function-naming-style=snake_case
+argument-naming-style=snake_case
+variable-naming-style=snake_case
+inlinevar-naming-style=snake_case

package/scripts/eng/pyrightconfig.json

@@ -0,0 +1,6 @@
+{
+    "reportUnnecessaryCast": "warning",
+    "reportTypeCommentUsage": true,
+    "reportMissingImports": false,
+    "pythonVersion": "3.8"
+}