@typespec/http-client-python 0.3.1 → 0.3.3

package/eng/scripts/ci/pylintrc

@@ -17,7 +17,7 @@ enable=useless-suppression
 # 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.
 # too-many-lines: Due to code generation many files end up with too many lines.
 # 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,too-many-lines,parse-error,useless-suppression,unknown-option-value
+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

package/eng/scripts/ci/run_pylint.py

@@ -37,6 +37,8 @@ def _single_dir_pylint(mod):
                 "--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",
+                "--recursive=y",
+                "--py-version=3.8",
                 str(inner_class.absolute()),
             ]
         )
@@ -47,4 +49,8 @@ def _single_dir_pylint(mod):
 
 
 if __name__ == "__main__":
+    if os.name == "nt":
+        # Before https://github.com/microsoft/typespec/issues/4759 fixed, skip running Pylint for now on Windows
+        logging.info("Skip running Pylint on Windows for now")
+        sys.exit(0)
     run_check("pylint", _single_dir_pylint, "Pylint")

package/generator/pygen/black.py

@@ -59,10 +59,9 @@ class BlackScriptPlugin(Plugin):
         except:
             _LOGGER.error("Error: failed to format %s", file)
             raise
-        else:
-            if len(file_content.splitlines()) > 1000:
-                file_content = "# pylint: disable=too-many-lines\n" + file_content
-            self.write_file(file, file_content)
+        if len(file_content.splitlines()) > 1000:
+            file_content = "# pylint: disable=too-many-lines\n" + file_content
+        self.write_file(file, file_content)
 
 
 if __name__ == "__main__":

package/generator/pygen/codegen/models/client.py

@@ -354,7 +354,7 @@ class Config(_ClientConfigBase[ConfigGlobalParameterList]):
     """Model representing our Config type."""
 
     def pylint_disable(self) -> str:
-        retval = add_to_pylint_disable("", "too-many-instance-attributes")
+        retval = add_to_pylint_disable("", "too-many-instance-attributes") if self.code_model.is_azure_flavor else ""
         if len(self.name) > NAME_LENGTH_LIMIT:
             retval = add_to_pylint_disable(retval, "name-too-long")
         return retval

package/generator/pygen/codegen/models/model_type.py

@@ -236,8 +236,6 @@ class ModelType(BaseType):  # pylint: disable=too-many-instance-attributes, too-
 
     def pylint_disable(self) -> str:
         retval: str = ""
-        if len(self.properties) > 10:
-            retval = add_to_pylint_disable(retval, "too-many-instance-attributes")
         if len(self.name) > NAME_LENGTH_LIMIT:
             retval = add_to_pylint_disable(retval, "name-too-long")
         return retval

package/generator/pygen/codegen/models/operation.py

@@ -142,11 +142,6 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
         if not async_mode and not self.is_overload and self.response_type_annotation(async_mode=False) == "None":
             # doesn't matter if it's async or not
             retval = add_to_pylint_disable(retval, "inconsistent-return-statements")
-        try:
-            if any(is_internal(r.type) for r in self.responses) or is_internal(self.parameters.body_parameter.type):
-                retval = add_to_pylint_disable(retval, "protected-access")
-        except ValueError:
-            pass
         if len(self.name) > NAME_LENGTH_LIMIT:
             retval = add_to_pylint_disable(retval, "name-too-long")
         return retval

package/generator/pygen/codegen/serializers/builder_serializer.py

@@ -553,11 +553,12 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
         type_ignore = self.async_mode and builder.group_name == ""  # is in a mixin
         if builder.stream_value is True and not self.code_model.options["version_tolerant"]:
             retval.append("_decompress = kwargs.pop('decompress', True)")
+        pylint_disable = " # pylint: disable=protected-access" if self.code_model.is_azure_flavor else ""
         retval.extend(
             [
                 f"_stream = {builder.stream_value}",
                 f"pipeline_response: PipelineResponse = {self._call_method}self._client.{self.pipeline_name}.run(  "
-                + f"{'# type: ignore' if type_ignore else ''} # pylint: disable=protected-access",
+                + f"{'# type: ignore' if type_ignore else ''}{pylint_disable}",
                 "    _request,",
                 "    stream=_stream,",
                 "    **kwargs",
@@ -599,7 +600,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
             retval.append(f"    params_added_on={dict(params_added_on)},")
         if retval:
             retval_str = "\n".join(retval)
-            return f"@api_version_validation(\n{retval_str}\n){builder.pylint_disable(self.async_mode)}"
+            return f"@api_version_validation(\n{retval_str}\n)"
         return ""
 
     def pop_kwargs_from_signature(self, builder: OperationType) -> List[str]:

package/generator/pygen/codegen/serializers/model_serializer.py

@@ -110,16 +110,22 @@ class _ModelSerializer(BaseSerializer, ABC):
     def need_init(self, model: ModelType) -> bool:
         return (not model.internal) and bool(self.init_line(model) or model.discriminator)
 
-    def pylint_disable(self, model: ModelType) -> str:
+    def pylint_disable_items(self, model: ModelType) -> List[str]:
         if model.flattened_property or self.initialize_properties(model):
-            return ""
+            return [""]
         if any(p for p in model.properties if p.is_discriminator and model.discriminator_value):
-            return ""
+            return [""]
         if model.parents and any(
             "=" in prop for parent in model.parents for prop in self.init_line(parent) if self.need_init(parent)
         ):
-            return ""
-        return "  # pylint: disable=useless-super-delegation"
+            return [""]
+        return ["useless-super-delegation"]
+
+    def pylint_disable(self, model: ModelType) -> str:
+        return "  # pylint: disable=" + ", ".join(self.pylint_disable_items(model))
+
+    def global_pylint_disables(self) -> str:
+        return ""
 
 
 class MsrestModelSerializer(_ModelSerializer):
@@ -315,3 +321,15 @@ class DpgModelSerializer(_ModelSerializer):
                     properties_to_pass_to_super.append(f"{prop.client_name}={prop.get_declaration()}")
         properties_to_pass_to_super.append("**kwargs")
         return ", ".join(properties_to_pass_to_super)
+
+    def global_pylint_disables(self) -> str:
+        result = []
+        for model in self.code_model.model_types:
+            if self.need_init(model):
+                for item in self.pylint_disable_items(model):
+                    if item:
+                        result.append(item)
+        final_result = set(result)
+        if final_result:
+            return "# pylint: disable=" + ", ".join(final_result)
+        return ""

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

@@ -1,7 +1,7 @@
 {% import 'keywords.jinja2' as keywords %}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
-
+{{ keywords.path_type_checking_imports() }}
 {% if clients %}
     {% for client in clients %}
 from .{{ client.filename }} import {{ client.name }}

package/generator/pygen/codegen/templates/keywords.jinja2

@@ -11,9 +11,17 @@
 try:
 {% endif %}
 {{ indentation }}from ._patch import __all__ as _patch_all
-{{ indentation }}from ._patch import *  # pylint: disable=unused-wildcard-import
+{{ indentation }}from ._patch import *
 {% if try_except %}
 except ImportError:
     _patch_all = []
 {% endif %}
 from ._patch import patch_sdk as _patch_sdk{% endmacro %}
+{% macro path_type_checking_imports() %}
+# pylint: disable=wrong-import-position
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+{% endmacro %}

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

@@ -4,7 +4,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except, too-many-lines
+# pylint: disable=protected-access, broad-except
 
 import copy
 import calendar
@@ -573,7 +573,7 @@ class Model(_MyMutableMapping):
     def copy(self) -> "Model":
         return Model(self.__dict__)
 
-    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: disable=unused-argument
+    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:
         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'
@@ -584,8 +584,8 @@ class Model(_MyMutableMapping):
             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
+                if hasattr(mro_class, "__annotations__")
+                for k, v in mro_class.__annotations__.items()
             }
             for attr, rf in attr_to_rest_field.items():
                 rf._module = cls.__module__
@@ -600,8 +600,8 @@ class Model(_MyMutableMapping):
 
     def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None:
         for base in cls.__bases__:
-            if hasattr(base, "__mapping__"):  # pylint: disable=no-member
-                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore  # pylint: disable=no-member
+            if hasattr(base, "__mapping__"):
+                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore
 
     @classmethod
     def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]:
@@ -612,7 +612,7 @@ class Model(_MyMutableMapping):
 
     @classmethod
     def _deserialize(cls, data, exist_discriminators):
-        if not hasattr(cls, "__mapping__"):  # pylint: disable=no-member
+        if not hasattr(cls, "__mapping__"):
             return cls(data)
         discriminator = cls._get_discriminator(exist_discriminators)
         if discriminator is None:
@@ -632,7 +632,7 @@ class Model(_MyMutableMapping):
                 discriminator_value = data.find(xml_name).text  # pyright: ignore
         else:
             discriminator_value = data.get(discriminator._rest_name)
-        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore # pylint: disable=no-member
+        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore
         return mapped_cls._deserialize(data, exist_discriminators)
 
     def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]:

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

@@ -1,6 +1,9 @@
 {% import 'operation_tools.jinja2' as op_tools %}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
+{% if serializer.global_pylint_disables() %}
+{{ serializer.global_pylint_disables() }}
+{% endif %}
 
 {{ imports }}
 {% for model in code_model.model_types %}

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

@@ -70,7 +70,7 @@
     {% endif %}
     {% set initialize_properties = serializer.initialize_properties(model) %}
     {% if serializer.need_init(model) or initialize_properties %}
-    def __init__(self, *args: Any, **kwargs: Any) -> None:{{ '# pylint: disable=useless-super-delegation' if not initialize_properties else '' }}
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         {% for line in serializer.super_call(model) %}
         {{ line }}
         {% endfor %}

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

@@ -1,6 +1,7 @@
 {% import 'keywords.jinja2' as keywords %}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
+{{ keywords.path_type_checking_imports() }}
 {% if schemas %}
 
     {% for schema in schemas %}

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

@@ -3,7 +3,7 @@
 {# actual template starts here #}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
-
+{{ keywords.path_type_checking_imports() }}
 {{ op_tools.serialize(operation_group_imports()) }}
 {{ keywords.patch_imports() }}
 __all__ = [

package/generator/pygen.egg-info/SOURCES.txt

@@ -102,9 +102,6 @@ pygen/codegen/templates/packaging_templates/MANIFEST.in.jinja2
 pygen/codegen/templates/packaging_templates/README.md.jinja2
 pygen/codegen/templates/packaging_templates/dev_requirements.txt.jinja2
 pygen/codegen/templates/packaging_templates/setup.py.jinja2
-pygen/postprocess/__init__.py
-pygen/postprocess/get_all.py
-pygen/postprocess/venvtools.py
 pygen/preprocess/__init__.py
 pygen/preprocess/helpers.py
 pygen/preprocess/python_mappings.py

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",

package/generator/pygen/postprocess/__init__.py

@@ -1,183 +0,0 @@
-# -------------------------------------------------------------------------
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for
-# license information.
-# --------------------------------------------------------------------------
-from typing import Tuple, Any
-from pathlib import Path
-import os
-import shutil
-from venv import EnvBuilder
-import black
-from black.report import NothingChanged
-from .venvtools import ExtendedEnvBuilder, python_run
-
-from .. import Plugin
-
-_BLACK_MODE = black.Mode()  # pyright: ignore [reportPrivateImportUsage]
-_BLACK_MODE.line_length = 120
-
-
-def format_file(file: Path, file_content: str) -> str:
-    if not file.suffix == ".py":
-        return file_content
-    try:
-        file_content = black.format_file_contents(file_content, fast=True, mode=_BLACK_MODE)
-    except NothingChanged:
-        pass
-    return file_content
-
-
-class PostProcessPlugin(Plugin):
-    def __init__(self, **kwargs: Any):
-        super().__init__(**kwargs)
-        output_folder_uri = self.options["outputFolderUri"]
-        if output_folder_uri.startswith("file:"):
-            output_folder_uri = output_folder_uri[5:]
-        if os.name == "nt" and output_folder_uri.startswith("///"):
-            output_folder_uri = output_folder_uri[3:]
-        self.output_folder = Path(output_folder_uri)  # path to where the setup.py is
-        self.setup_venv()
-
-        # set up the venv
-        # base folder is where the code starts, i.e. where we
-        self.base_folder, self.namespace = self.get_namespace(self.output_folder, "")
-
-    def setup_venv(self):
-        venv_path = self.output_folder / Path(".temp_folder") / Path("temp_venv")
-
-        if venv_path.exists():
-            env_builder = EnvBuilder(with_pip=True)
-            self.venv_context = env_builder.ensure_directories(venv_path)
-        else:
-            env_builder = ExtendedEnvBuilder(with_pip=True, upgrade_deps=True)
-            env_builder.create(venv_path)
-            self.venv_context = env_builder.context
-            python_run(
-                self.venv_context,
-                "pip",
-                ["install", "-e", str(self.output_folder)],
-                directory=self.output_folder,
-            )
-
-    def get_namespace(self, dir: Path, namespace: str) -> Tuple[Path, str]:
-        try:
-            init_file = next(d for d in dir.iterdir() if d.name == "__init__.py")
-            # we don't care about pkgutil inits, we skip over them
-            file_content = self.read_file(init_file.relative_to(self.output_folder))
-            if "pkgutil" not in file_content:
-                return dir, namespace
-        except StopIteration:
-            pass
-
-        try:
-            # first, see if we can get a folder that has the same name as the current output folder
-            start = self.output_folder.stem.split("-")[0]
-            next_dir = next(d for d in dir.iterdir() if d.is_dir() and d.name == start)
-        except StopIteration:
-            invalid_start_chars = [".", "_"]
-            invalid_dirs = [
-                "swagger",
-                "out",
-                "tests",
-                "samples",
-            ]
-
-            next_dir = next(
-                d
-                for d in dir.iterdir()
-                if d.is_dir()
-                and not str(d).endswith("egg-info")
-                and d.name[0] not in invalid_start_chars
-                and d.name not in invalid_dirs
-            )
-
-        namespace = f"{namespace}.{next_dir.name}" if namespace else next_dir.name
-        return self.get_namespace(next_dir, namespace)
-
-    def process(self) -> bool:
-        folders = [f for f in self.base_folder.glob("**/*") if f.is_dir() and not f.stem.startswith("__")]
-        # will always have the root
-        self.fix_imports_in_init(
-            generated_file_name="_client",
-            folder_path=self.base_folder,
-            namespace=self.namespace,
-        )
-        try:
-            aio_folder = next(f for f in folders if f.stem == "aio")
-            self.fix_imports_in_init(
-                generated_file_name="_client",
-                folder_path=aio_folder,
-                namespace=f"{self.namespace}.aio",
-            )
-        except StopIteration:
-            pass
-
-        try:
-            models_folder = next(f for f in folders if f.stem == "models")
-            self.fix_imports_in_init(
-                generated_file_name="_models",
-                folder_path=models_folder,
-                namespace=f"{self.namespace}.models",
-            )
-        except StopIteration:
-            pass
-        operations_folders = [f for f in folders if f.stem in ["operations", "_operations"]]
-        for operations_folder in operations_folders:
-            sub_namespace = ".".join(str(operations_folder.relative_to(self.base_folder)).split(os.sep))
-            self.fix_imports_in_init(
-                generated_file_name="_operations",
-                folder_path=operations_folder,
-                namespace=f"{self.namespace}.{sub_namespace}",
-            )
-        shutil.rmtree(f"{str(self.output_folder)}/.temp_folder")
-        return True
-
-    def fix_imports_in_init(self, generated_file_name: str, folder_path: Path, namespace: str) -> None:
-        customized_objects_str = python_run(
-            self.venv_context,
-            command=[namespace, str(self.output_folder)],
-            module="get_all",
-        )
-
-        if not customized_objects_str:
-            return
-        customized_objects = {k: None for k in customized_objects_str.split(",")}.keys()  # filter out duplicates
-        file = (folder_path / "__init__.py").relative_to(self.output_folder)
-        file_content = self.read_file(file).replace("\r\n", "\n")
-        added_objs = []
-        for obj in customized_objects:
-            if f" import {obj}\n" in file_content:
-                # means we're overriding a generated model
-                file_content = file_content.replace(
-                    f"from .{generated_file_name} import {obj}\n",
-                    f"from ._patch import {obj}\n",
-                )
-            else:
-                added_objs.append(obj)
-        file_content = file_content.replace(
-            "try:\n    from ._patch import __all__ as _patch_all\n    "
-            "from ._patch import *  # pylint: disable=unused-wildcard-import"
-            "\nexcept ImportError:\n    _patch_all = []",
-            "",
-        )
-        file_content = file_content.replace("from ._patch import __all__ as _patch_all", "")
-        file_content = file_content.replace(
-            "from ._patch import *  # pylint: disable=unused-wildcard-import\n",
-            "",
-        )
-        file_content = file_content.replace("__all__.extend([p for p in _patch_all if p not in __all__])", "")
-        if added_objs:
-            # add import
-            patch_sdk_import = "from ._patch import patch_sdk as _patch_sdk"
-            imports = "\n".join([f"from ._patch import {obj}" for obj in added_objs])
-            if imports:
-                replacement = f"{imports}\n{patch_sdk_import}"
-            else:
-                replacement = patch_sdk_import
-            file_content = file_content.replace(patch_sdk_import, replacement)
-            # add to __all__
-            added_objs_all = "\n".join([f'    "{obj}",' for obj in added_objs]) + "\n"
-            file_content = file_content.replace("__all__ = [", f"__all__ = [\n{added_objs_all}", 1)
-        formatted_file = format_file(file, file_content)
-        self.write_file(file, formatted_file)

package/generator/pygen/postprocess/get_all.py

@@ -1,19 +0,0 @@
-# -------------------------------------------------------------------------
-# 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 importlib
-
-
-def main(namespace):
-    sdk = importlib.import_module(namespace)
-    return sdk._patch.__all__  # pylint: disable=protected-access
-
-
-if __name__ == "__main__":
-    patched = ",".join(main(sys.argv[1]))
-    output_folder = sys.argv[2]
-    with open(f"{output_folder}/.temp_folder/patched.txt", "w", encoding="utf-8-sig") as f:
-        f.write(patched)

package/generator/pygen/postprocess/venvtools.py

@@ -1,75 +0,0 @@
-# -------------------------------------------------------------------------
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for
-# license information.
-# --------------------------------------------------------------------------
-from typing import Optional
-import subprocess
-import venv
-import sys
-from pathlib import Path
-
-
-_ROOT_DIR = Path(__file__).parent
-
-
-class ExtendedEnvBuilder(venv.EnvBuilder):
-    """An extended env builder which saves the context, to have access
-    easily to bin path and such.
-    """
-
-    def __init__(self, *args, **kwargs):
-        self.context = None
-        if sys.version_info < (3, 9, 0):
-            # Not supported on Python 3.8, and we don't need it
-            kwargs.pop("upgrade_deps", None)
-        super().__init__(*args, **kwargs)
-
-    def ensure_directories(self, env_dir):
-        self.context = super(ExtendedEnvBuilder, self).ensure_directories(env_dir)
-        return self.context
-
-
-def create(
-    env_dir,
-    system_site_packages=False,
-    clear=False,
-    symlinks=False,
-    with_pip=False,
-    prompt=None,
-    upgrade_deps=False,
-):
-    """Create a virtual environment in a directory."""
-    builder = ExtendedEnvBuilder(
-        system_site_packages=system_site_packages,
-        clear=clear,
-        symlinks=symlinks,
-        with_pip=with_pip,
-        prompt=prompt,
-        upgrade_deps=upgrade_deps,
-    )
-    builder.create(env_dir)
-    return builder.context
-
-
-def python_run(venv_context, module, command, directory=_ROOT_DIR) -> Optional[str]:
-    try:
-        cmd_line = [
-            venv_context.env_exe,
-            "-m",
-            module,
-        ] + command
-        print("Executing: {}".format(" ".join(cmd_line)))
-        subprocess.run(
-            cmd_line,
-            cwd=directory,
-            check=True,
-            stdout=False,
-        )
-        if module == "get_all":
-            with open(f"{command[1]}/.temp_folder/patched.txt", "r", encoding="utf-8-sig") as f:
-                return f.read()
-    except subprocess.CalledProcessError as err:
-        print(err)
-        sys.exit(1)
-    return None