@typespec/http-client-python 0.3.2 → 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/keywords.jinja2

@@ -11,7 +11,7 @@
 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 = []

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/package.json

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