@typespec/http-client-python 0.28.3 → 0.29.0

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

@@ -19,17 +19,22 @@ from datetime import datetime, date, time, timedelta, timezone
 from json import JSONEncoder
 import xml.etree.ElementTree as ET
 from collections.abc import MutableMapping
-from typing_extensions import Self
 import isodate
 from {{ code_model.core_library }}.exceptions import DeserializationError
 from {{ code_model.core_library }}{{ "" if code_model.is_azure_flavor else ".utils" }} import CaseInsensitiveEnumMeta
 from {{ code_model.core_library }}.{{ "" if code_model.is_azure_flavor else "runtime." }}pipeline import PipelineResponse
 from {{ code_model.core_library }}.serialization import _Null
+
 {% if code_model.has_external_type %}
 from {{ code_model.core_library }}.serialization import TypeHandlerRegistry
 {% endif %}
 from {{ code_model.core_library }}.rest import HttpResponse
 
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
 _LOGGER = logging.getLogger(__name__)
 
 __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"]
@@ -617,11 +622,7 @@ class Model(_MyMutableMapping):
         class_name = self.__class__.__name__
         if len(args) > 1:
             raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given")
-        dict_to_pass = {
-            rest_field._rest_name: rest_field._default
-            for rest_field in self._attr_to_rest_field.values()
-            if rest_field._default is not _UNSET
-        }
+        dict_to_pass: dict[str, typing.Any] = {}
         if args:
             if isinstance(args[0], ET.Element):
                 dict_to_pass.update(self._init_from_xml(args[0]))
@@ -641,6 +642,14 @@ class Model(_MyMutableMapping):
                     if v is not None
                 }
             )
+        # Apply client default values for fields the caller didn't set so that
+        # defaults are part of `_data` and therefore included during serialization.
+        for rf in self._attr_to_rest_field.values():
+            if rf._default is _UNSET:
+                continue
+            if rf._rest_name in dict_to_pass:
+                continue
+            dict_to_pass[rf._rest_name] = _create_value(rf, rf._default)
         super().__init__(dict_to_pass)
 
     def _init_from_xml(self, element: ET.Element) -> dict[str, typing.Any]:
@@ -1160,7 +1169,10 @@ class _RestField:
         # by this point, type and rest_name will have a value bc we default
         # them in __new__ of the Model class
         # Use _data.get() directly to avoid triggering __getitem__ which clears the cache
-        item = obj._data.get(self._rest_name)
+        item = obj._data.get(self._rest_name, _UNSET)
+        if item is _UNSET:
+            # Field not set by user; return the client default if one exists, otherwise None
+            return self._default if self._default is not _UNSET else None
         if item is None:
             return item
         if self._is_model:

package/generator/pygen/codegen/templates/packaging_templates/README.md.jinja2

@@ -3,7 +3,7 @@
 # Microsoft Azure SDK for Python
 
 This is the Microsoft {{options["package-pprint-name"]}} Client Library.
-This package has been tested with Python 3.9+.
+This package has been tested with Python 3.10+.
 For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
 
 # Usage
@@ -14,6 +14,10 @@ For docs and references, see [Python SDK References](https://docs.microsoft.com/
 Code samples for this package can be found at [{{options["package-pprint-name"]}}](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
 Additional code samples for different Azure services are available at [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
 
+# Use with AI tools
+
+AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Python with AI tools](https://aka.ms/azsdk/python/ai) for available integrations.
+
 # Provide Feedback
 
 If you encounter any bugs or have suggestions, please file an issue in the
@@ -36,10 +40,14 @@ python -m pip install {{ options["package-name"] }}
 
 #### Prequisites
 
-- Python 3.9 or later is required to use this package.
+- Python 3.10 or later is required to use this package.
 - You need an [Azure subscription][azure_sub] to use this package.
 - An existing {{ options["package-pprint-name"] }} instance.
 
+### Use with AI tools
+
+AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Python with AI tools](https://aka.ms/azsdk/python/ai) for available integrations.
+
 {% if token_credential and client_name %}
 #### Create with an Azure Active Directory Credential
 To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
@@ -113,7 +121,7 @@ This package is generated by `@typespec/http-client-python` with Typespec.
 
 ### Prequisites
 
-- Python 3.9 or later is required to use this package.
+- Python 3.10 or later is required to use this package.
 
 ### Install the package
 

package/generator/pygen/codegen/templates/packaging_templates/pyproject.toml.jinja2

@@ -57,7 +57,7 @@ dependencies = [
     {% endfor %}
     {% endif %}
     {% for dep in ADDITIONAL_DEPENDENCIES %}
-    "{{ dep }}",
+    {{ dep }},
     {% endfor %}
 ]
 dynamic = [

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

@@ -35,11 +35,15 @@ except ImportError:
 import xml.etree.ElementTree as ET
 
 import isodate  # type: ignore
-from typing_extensions import Self
 
 from {{ code_model.core_library }}.exceptions import DeserializationError, SerializationError
 from {{ code_model.core_library }}.serialization import NULL as CoreNull
 
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
 _BOM = codecs.BOM_UTF8.decode(encoding="utf-8")
 
 JSON = MutableMapping[str, Any]

package/generator/pygen/preprocess/__init__.py

@@ -132,20 +132,18 @@ HEADERS_HIDE_IN_METHOD = (
     "client-request-id",
     "return-client-request-id",
 )
-HEADERS_CONVERT_IN_METHOD = {
-    "if-match": {
-        "clientName": "etag",
-        "wireName": "etag",
-        "description": "check if resource is changed. Set None to skip checking etag.",
-    },
-    "if-none-match": {
-        "clientName": "match_condition",
-        "wireName": "match-condition",
-        "description": "The match condition to use upon the etag.",
-        "type": {
-            "type": "sdkcore",
-            "name": "MatchConditions",
-        },
+ETAG_MATCH_DATA = {
+    "clientName": "etag",
+    "etagRole": "ifMatch",
+    "description": "check if resource is changed. Set None to skip checking etag.",
+}
+ETAG_NONE_MATCH_DATA = {
+    "clientName": "match_condition",
+    "etagRole": "ifNoneMatch",
+    "description": "The match condition to use upon the etag.",
+    "type": {
+        "type": "sdkcore",
+        "name": "MatchConditions",
     },
 }
 CLOUD_SETTING = {
@@ -166,6 +164,11 @@ def get_wire_name_lower(parameter: dict[str, Any]) -> str:
     return (parameter.get("wireName") or "").lower()
 
 
+def _get_etag_role(parameter: dict[str, Any]) -> Optional[str]:
+    """Return 'ifMatch', 'ifNoneMatch', or None for this header parameter."""
+    return parameter.get("etagRole")
+
+
 def headers_convert(yaml_data: dict[str, Any], replace_data: Any) -> None:
     if isinstance(replace_data, dict):
         for k, v in replace_data.items():
@@ -281,9 +284,8 @@ class PreProcessPlugin(YamlUpdatePlugin):
                         value["name"] = upper_name
 
         # add type for reference
-        for v in HEADERS_CONVERT_IN_METHOD.values():
-            if isinstance(v, dict) and "type" in v:
-                yaml_data.append(v["type"])
+        if "type" in ETAG_NONE_MATCH_DATA:
+            yaml_data.append(ETAG_NONE_MATCH_DATA["type"])
         yaml_data.append(CLOUD_SETTING["type"])  # type: ignore
 
     def update_client(self, yaml_data: dict[str, Any]) -> None:
@@ -317,9 +319,10 @@ class PreProcessPlugin(YamlUpdatePlugin):
                     if p["location"] == "header" and wire_name_lower == "client-request-id":
                         yaml_data["requestIdHeaderName"] = wire_name_lower
                     if self.version_tolerant and p["location"] == "header":
-                        if wire_name_lower == "if-match":
+                        role = _get_etag_role(p)
+                        if role == "ifMatch" and not property_if_match:
                             property_if_match = p
-                        elif wire_name_lower == "if-none-match":
+                        elif role == "ifNoneMatch" and not property_if_none_match:
                             property_if_none_match = p
                 # pylint: disable=line-too-long
                 # some service(e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json)
@@ -327,17 +330,19 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 if not property_if_match and property_if_none_match:
                     property_if_match = property_if_none_match.copy()
                     property_if_match["wireName"] = "if-match"
+                    property_if_match["etagRole"] = "ifMatch"
                 if not property_if_none_match and property_if_match:
                     property_if_none_match = property_if_match.copy()
                     property_if_none_match["wireName"] = "if-none-match"
+                    property_if_none_match["etagRole"] = "ifNoneMatch"
 
                 if property_if_match and property_if_none_match:
                     # arrange if-match and if-none-match to the end of parameters
-                    o["parameters"] = [
-                        item
-                        for item in o["parameters"]
-                        if get_wire_name_lower(item) not in ("if-match", "if-none-match")
-                    ] + [property_if_match, property_if_none_match]
+                    etag_params = {id(property_if_match), id(property_if_none_match)}
+                    o["parameters"] = [item for item in o["parameters"] if id(item) not in etag_params] + [
+                        property_if_match,
+                        property_if_none_match,
+                    ]
 
                     o["hasEtag"] = True
                     yaml_data["hasEtag"] = True
@@ -362,11 +367,9 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 yaml_data["clientName"].lower(), PadType.PARAMETER, yaml_data
             )
         if yaml_data.get("propertyToParameterName"):
-            # need to create a new one with padded keys and values
+            # need to create a new one with padded values (but NOT keys, since keys are wire names)
             yaml_data["propertyToParameterName"] = {
-                self.pad_reserved_words(prop, PadType.PROPERTY, yaml_data): self.pad_reserved_words(
-                    param_name, PadType.PARAMETER, yaml_data
-                ).lower()
+                prop: self.pad_reserved_words(param_name, PadType.PARAMETER, yaml_data).lower()
                 for prop, param_name in yaml_data["propertyToParameterName"].items()
             }
         wire_name_lower = (yaml_data.get("wireName") or "").lower()
@@ -374,8 +377,12 @@ class PreProcessPlugin(YamlUpdatePlugin):
             wire_name_lower in HEADERS_HIDE_IN_METHOD or yaml_data.get("clientDefaultValue") == "multipart/form-data"
         ):
             yaml_data["hideInMethod"] = True
-        if self.version_tolerant and yaml_data["location"] == "header" and wire_name_lower in HEADERS_CONVERT_IN_METHOD:
-            headers_convert(yaml_data, HEADERS_CONVERT_IN_METHOD[wire_name_lower])
+        if self.version_tolerant and yaml_data["location"] == "header":
+            role = _get_etag_role(yaml_data)
+            if role == "ifMatch":
+                headers_convert(yaml_data, ETAG_MATCH_DATA)
+            elif role == "ifNoneMatch":
+                headers_convert(yaml_data, ETAG_NONE_MATCH_DATA)
         if wire_name_lower in ["$host", "content-type", "accept"] and yaml_data["type"]["type"] == "constant":
             yaml_data["clientDefaultValue"] = yaml_data["type"]["value"]
 

package/generator/pygen.egg-info/PKG-INFO

@@ -9,14 +9,13 @@ License: MIT License
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: black==24.8.0
+Requires-Dist: black==26.3.1
 Requires-Dist: docutils>=0.20.1
 Requires-Dist: Jinja2==3.1.6
 Requires-Dist: PyYAML==6.0.1

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

@@ -1,4 +1,4 @@
-black==24.8.0
+black==26.3.1
 docutils>=0.20.1
 Jinja2==3.1.6
 PyYAML==6.0.1

package/generator/setup.py

@@ -35,7 +35,6 @@ setup(
         "Development Status :: 4 - Beta",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
@@ -47,7 +46,7 @@ setup(
         ]
     ),
     install_requires=[
-        "black==24.8.0",
+        "black==26.3.1",
         "docutils>=0.20.1",
         "Jinja2==3.1.6",
         "PyYAML==6.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.28.3",
+  "version": "0.29.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -46,7 +46,7 @@
     "typecheck": "tsx ./eng/scripts/ci/typecheck.ts",
     "typecheck:generated": "tsx ./eng/scripts/ci/typecheck.ts --generated",
     "regenerate": "tsx ./eng/scripts/ci/regenerate.ts",
-    "ci": "npm run test && npm run lint && npm run typecheck",
+    "ci": "npm run test:emitter && npm run ci:generated",
     "ci:generated": "tsx ./eng/scripts/ci/run-tests.ts --generator --env=ci",
     "change:version": "pnpm chronus version --ignore-policies --only @typespec/http-client-python",
     "change:add": "pnpm chronus add",
@@ -61,10 +61,10 @@
   ],
   "peerDependencies": {
     "@azure-tools/typespec-autorest": ">=0.67.0 <1.0.0",
-    "@azure-tools/typespec-azure-core": ">=0.67.0 <1.0.0",
-    "@azure-tools/typespec-azure-resource-manager": ">=0.67.0 <1.0.0",
+    "@azure-tools/typespec-azure-core": ">=0.67.1 <1.0.0",
+    "@azure-tools/typespec-azure-resource-manager": ">=0.67.1 <1.0.0",
     "@azure-tools/typespec-azure-rulesets": ">=0.67.0 <1.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.67.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.67.4 <1.0.0",
     "@typespec/compiler": "^1.11.0",
     "@typespec/http": "^1.11.0",
     "@typespec/openapi": "^1.11.0",
@@ -75,6 +75,21 @@
     "@typespec/streams": ">=0.81.0 <1.0.0",
     "@typespec/xml": ">=0.81.0 <1.0.0"
   },
+  "playgroundConfig": {
+    "assets": [
+      {
+        "path": "generator/dist/pygen-*.whl",
+        "contentType": "application/zip"
+      }
+    ],
+    "bundlePeerDependencies": [
+      "@azure-tools/typespec-client-generator-core",
+      "@azure-tools/typespec-azure-core",
+      "@azure-tools/typespec-autorest",
+      "@azure-tools/typespec-azure-resource-manager",
+      "@azure-tools/typespec-azure-rulesets"
+    ]
+  },
   "dependencies": {
     "js-yaml": "~4.1.0",
     "marked": "^15.0.6",
@@ -84,11 +99,11 @@
   },
   "devDependencies": {
     "@azure-tools/typespec-autorest": "~0.67.0",
-    "@azure-tools/typespec-azure-core": "~0.67.0",
-    "@azure-tools/typespec-azure-resource-manager": "~0.67.0",
+    "@azure-tools/typespec-azure-core": "~0.67.1",
+    "@azure-tools/typespec-azure-resource-manager": "~0.67.1",
     "@azure-tools/typespec-azure-rulesets": "~0.67.0",
-    "@azure-tools/typespec-client-generator-core": "~0.67.0",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.39",
+    "@azure-tools/typespec-client-generator-core": "~0.67.4",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.40-dev.12",
     "@typespec/compiler": "^1.11.0",
     "@typespec/http": "^1.11.0",
     "@typespec/openapi": "^1.11.0",