@typespec/http-client-python 0.12.2 → 0.12.3

package/generator/build/lib/pygen/codegen/models/parameter.py

@@ -81,6 +81,7 @@ class _ParameterBase(BaseModel, abc.ABC):  # pylint: disable=too-many-instance-a
         self.grouper: bool = self.yaml_data.get("grouper", False)
         self.check_client_input: bool = self.yaml_data.get("checkClientInput", False)
         self.added_on: Optional[str] = self.yaml_data.get("addedOn")
+        self.api_versions: Optional[List[str]] = self.yaml_data.get("apiVersions", [])
         self.is_api_version: bool = self.yaml_data.get("isApiVersion", False)
         self.in_overload: bool = self.yaml_data.get("inOverload", False)
         self.default_to_unset_sentinel: bool = self.yaml_data.get("defaultToUnsetSentinel", False)

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

@@ -607,6 +607,8 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
         if params_added_on:
             retval.append(f"    params_added_on={dict(params_added_on)},")
         if retval:
+            if builder.api_versions:
+                retval.append(f"   api_versions_list={builder.api_versions},")
             retval_str = "\n".join(retval)
             return f"@api_version_validation(\n{retval_str}\n)"
         return ""

package/generator/build/lib/pygen/codegen/serializers/metadata_serializer.py

@@ -48,7 +48,7 @@ def _json_serialize_imports(
                 ],
             ],
         ],
-    ]
+    ],
 ) -> str:
     if not imports:
         return ""

package/generator/build/lib/pygen/codegen/templates/validation.py.jinja2

@@ -6,6 +6,22 @@ import functools
 def api_version_validation(**kwargs):
     params_added_on = kwargs.pop("params_added_on", {})
     method_added_on = kwargs.pop("method_added_on", "")
+    api_versions_list = kwargs.pop("api_versions_list", [])
+
+    def _index_with_default(value: str, default: int = -1) -> int:
+        """Get the index of value in lst, or return default if not found.
+        
+        :param value: The value to search for in the api_versions_list.
+        :type value: str
+        :param default: The default value to return if the value is not found.
+        :type default: int
+        :return: The index of the value in the list, or the default value if not found.
+        :rtype: int
+        """
+        try:
+            return api_versions_list.index(value)
+        except ValueError:
+            return default
 
     def decorator(func):
         @functools.wraps(func)
@@ -17,7 +33,7 @@ def api_version_validation(**kwargs):
             except AttributeError:
                 return func(*args, **kwargs)
 
-            if method_added_on > client_api_version:
+            if _index_with_default(method_added_on) > _index_with_default(client_api_version):
                 raise ValueError(
                     f"'{func.__name__}' is not available in API version "
                     f"{client_api_version}. Pass service API version {method_added_on} or newer to your client."
@@ -27,7 +43,7 @@ def api_version_validation(**kwargs):
                 parameter: api_version
                 for api_version, parameters in params_added_on.items()
                 for parameter in parameters
-                if parameter in kwargs and api_version > client_api_version
+                if parameter in kwargs and _index_with_default(api_version) > _index_with_default(client_api_version)
             }
             if unsupported:
                 raise ValueError("".join([

package/generator/build/lib/pygen/preprocess/__init__.py

@@ -3,8 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-"""The preprocessing autorest plugin.
-"""
+"""The preprocessing autorest plugin."""
 import copy
 from typing import Callable, Dict, Any, List, Optional
 

package/generator/pygen/codegen/__init__.py

@@ -109,6 +109,10 @@ class OptionsRetriever:
     def package_pprint_name(self) -> str:
         return self.options.get("package-pprint-name") or _default_pprint(str(self.package_name))
 
+    @property
+    def validate_versioning(self) -> bool:
+        return self.options.get("validate-versioning", True)
+
     @property
     def default_optional_constants_to_none(self) -> bool:
         return self.options.get(
@@ -301,6 +305,7 @@ class CodeGenerator(Plugin):
             "from_typespec",
             "flavor",
             "emit_cross_language_definition_file",
+            "validate_versioning",
         ]
         return {f: getattr(self.options_retriever, f) for f in flags}
 

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

@@ -275,7 +275,9 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
     @property
     def need_validation(self) -> bool:
         """Whether we need parameter / operation validation. For API version."""
-        return bool(self.added_on) or any(p for p in self.parameters if p.added_on)
+        return self.code_model.options["validate_versioning"] and (
+            bool(self.added_on) or any(p for p in self.parameters if p.added_on)
+        )
 
     def get_request_builder_import(
         self,

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

@@ -81,6 +81,7 @@ class _ParameterBase(BaseModel, abc.ABC):  # pylint: disable=too-many-instance-a
         self.grouper: bool = self.yaml_data.get("grouper", False)
         self.check_client_input: bool = self.yaml_data.get("checkClientInput", False)
         self.added_on: Optional[str] = self.yaml_data.get("addedOn")
+        self.api_versions: Optional[List[str]] = self.yaml_data.get("apiVersions", [])
         self.is_api_version: bool = self.yaml_data.get("isApiVersion", False)
         self.in_overload: bool = self.yaml_data.get("inOverload", False)
         self.default_to_unset_sentinel: bool = self.yaml_data.get("defaultToUnsetSentinel", False)

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

@@ -607,6 +607,8 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
         if params_added_on:
             retval.append(f"    params_added_on={dict(params_added_on)},")
         if retval:
+            if builder.api_versions:
+                retval.append(f"   api_versions_list={builder.api_versions},")
             retval_str = "\n".join(retval)
             return f"@api_version_validation(\n{retval_str}\n)"
         return ""

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

@@ -48,7 +48,7 @@ def _json_serialize_imports(
                 ],
             ],
         ],
-    ]
+    ],
 ) -> str:
     if not imports:
         return ""

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

@@ -6,6 +6,22 @@ import functools
 def api_version_validation(**kwargs):
     params_added_on = kwargs.pop("params_added_on", {})
     method_added_on = kwargs.pop("method_added_on", "")
+    api_versions_list = kwargs.pop("api_versions_list", [])
+
+    def _index_with_default(value: str, default: int = -1) -> int:
+        """Get the index of value in lst, or return default if not found.
+        
+        :param value: The value to search for in the api_versions_list.
+        :type value: str
+        :param default: The default value to return if the value is not found.
+        :type default: int
+        :return: The index of the value in the list, or the default value if not found.
+        :rtype: int
+        """
+        try:
+            return api_versions_list.index(value)
+        except ValueError:
+            return default
 
     def decorator(func):
         @functools.wraps(func)
@@ -17,7 +33,7 @@ def api_version_validation(**kwargs):
             except AttributeError:
                 return func(*args, **kwargs)
 
-            if method_added_on > client_api_version:
+            if _index_with_default(method_added_on) > _index_with_default(client_api_version):
                 raise ValueError(
                     f"'{func.__name__}' is not available in API version "
                     f"{client_api_version}. Pass service API version {method_added_on} or newer to your client."
@@ -27,7 +43,7 @@ def api_version_validation(**kwargs):
                 parameter: api_version
                 for api_version, parameters in params_added_on.items()
                 for parameter in parameters
-                if parameter in kwargs and api_version > client_api_version
+                if parameter in kwargs and _index_with_default(api_version) > _index_with_default(client_api_version)
             }
             if unsupported:
                 raise ValueError("".join([

package/generator/pygen/preprocess/__init__.py

@@ -3,8 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-"""The preprocessing autorest plugin.
-"""
+"""The preprocessing autorest plugin."""
 import copy
 from typing import Callable, Dict, Any, List, Optional
 

package/package.json

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