@typespec/http-client-python 0.15.1 → 0.15.2

package/eng/scripts/ci/regenerate.ts

@@ -25,7 +25,6 @@ const argv = parseArgs({
 const SKIP_SPECS = [
   "type/union/discriminated",
   "client-operation-group",
-  "azure/client-generator-core/api-version",
   "azure/client-generator-core/hierarchy-building",
 ];
 
@@ -117,6 +116,9 @@ const AZURE_EMITTER_OPTIONS: Record<string, Record<string, string> | Record<stri
   "client/naming": {
     namespace: "client.naming",
   },
+  "client/overload": {
+    namespace: "client.overload",
+  },
   "encode/duration": {
     namespace: "encode.duration",
   },

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

@@ -46,7 +46,7 @@ class OptionsDict(MutableMapping):
         self._data = options.copy() if options else {}
         self._validate_combinations()
 
-    def __getitem__(self, key: str) -> Any: # pylint: disable=too-many-return-statements
+    def __getitem__(self, key: str) -> Any:  # pylint: disable=too-many-return-statements
         if key == "head-as-boolean" and self.get("azure-arm"):
             # override to always true if azure-arm is set
             return True
@@ -109,7 +109,12 @@ class OptionsDict(MutableMapping):
         if key == "combine-operation-files":
             return self.get("version-tolerant")
         if key == "package-pprint-name":
-            return " ".join([i.capitalize() for i in str(self.get("package-name", "")).split("-")])
+            package_names = self.get("package-name", "").split("-")
+            return (
+                (package_names[-1].capitalize() + " Management")
+                if self.get("azure-arm")
+                else " ".join([i.capitalize() for i in package_names])
+            )
         if key == "builders-visibility":
             # Default to public if low-level client is not set, otherwise embedded
             return "embedded" if not self.get("low-level-client") else "public"

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

@@ -149,9 +149,12 @@ class JinjaSerializer(ReaderAndWriter):
                     self._serialize_and_write_package_files()
 
                 # write apiview-properties.json
-                if self.code_model.options.get("emit-cross-language-definition-file"):
+                if (
+                    self.code_model.options.get("emit-cross-language-definition-file")
+                    and not self.code_model.options["multiapi"]
+                ):
                     self.write_file(
-                        generation_path / Path("apiview-properties.json"),
+                        self._root_of_sdk / Path("apiview-properties.json"),
                         general_serializer.serialize_cross_language_definition_file(),
                     )
 
@@ -165,7 +168,7 @@ class JinjaSerializer(ReaderAndWriter):
                 # add _metadata.json
                 if self.code_model.metadata:
                     self.write_file(
-                        Path("./_metadata.json"),
+                        self._root_of_sdk / "_metadata.json",
                         json.dumps(self.code_model.metadata, indent=2),
                     )
             elif client_namespace_type.clients:
@@ -216,11 +219,17 @@ class JinjaSerializer(ReaderAndWriter):
                     general_serializer.serialize_pkgutil_init_file(),
                 )
 
-    def _serialize_and_write_package_files(self) -> None:
+    # path where README.md is
+    @property
+    def _root_of_sdk(self) -> Path:
         root_of_sdk = Path(".")
         if self.code_model.options["no-namespace-folders"]:
             compensation = Path("../" * (self.code_model.namespace.count(".") + 1))
             root_of_sdk = root_of_sdk / compensation
+        return root_of_sdk
+
+    def _serialize_and_write_package_files(self) -> None:
+        root_of_sdk = self._root_of_sdk
         if self.code_model.options["package-mode"] in VALID_PACKAGE_MODE:
             env = Environment(
                 loader=PackageLoader("pygen.codegen", "templates/packaging_templates"),
@@ -520,14 +529,14 @@ class JinjaSerializer(ReaderAndWriter):
         namespace_config = get_namespace_config(self.code_model.namespace, self.code_model.options["multiapi"])
         num_of_namespace = namespace_config.count(".") + 1
         num_of_package_namespace = (
-            get_namespace_from_package_name(self.code_model.options.get("namespace", "")).count(".") + 1
+            get_namespace_from_package_name(self.code_model.options.get("package-name", "")).count(".") + 1
         )
         if num_of_namespace > num_of_package_namespace:
             return Path("/".join(namespace_config.split(".")[num_of_package_namespace:]))
         return Path("")
 
     def _serialize_and_write_sample(self, env: Environment):
-        out_path = Path("./generated_samples")
+        out_path = self._root_of_sdk / "generated_samples"
         for client in self.code_model.clients:
             for op_group in client.operation_groups:
                 for operation in op_group.operations:
@@ -561,7 +570,7 @@ class JinjaSerializer(ReaderAndWriter):
 
     def _serialize_and_write_test(self, env: Environment):
         self.code_model.for_test = True
-        out_path = Path("./generated_tests")
+        out_path = self._root_of_sdk / "generated_tests"
         general_serializer = TestGeneralSerializer(code_model=self.code_model, env=env)
         self.write_file(out_path / "conftest.py", general_serializer.serialize_conftest())
         if not self.code_model.options["azure-arm"]:

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

@@ -1067,9 +1067,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                     )
                     if self.code_model.options["models-mode"] == "dpg":
                         if xml_serializable(str(e.default_content_type)):
-                            retval.append(
-                                f"        error = _failsafe_deserialize_xml({type_annotation}, response)"
-                            )
+                            retval.append(f"        error = _failsafe_deserialize_xml({type_annotation}, response)")
                         else:
                             retval.append(f"        error = _failsafe_deserialize({type_annotation}, response)")
                     else:
@@ -1086,9 +1084,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
             if builder.non_default_errors:
                 retval.append("    else:")
             if self.code_model.options["models-mode"] == "dpg":
-                retval.append(
-                    f"{indent}error = _failsafe_deserialize({default_error_deserialization}, response)"
-                )
+                retval.append(f"{indent}error = _failsafe_deserialize({default_error_deserialization}, response)")
             else:
                 retval.append(
                     f"{indent}error = self._deserialize.failsafe_deserialize({default_error_deserialization}, "

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

@@ -70,9 +70,11 @@ class GeneralSerializer(BaseSerializer):
             # If parsing the pyproject.toml fails, we assume the it does not exist or is incorrectly formatted.
             return result
 
-        # Keep azure-sdk-build configuration
+        # Keep "azure-sdk-build" and "packaging" configuration
         if "tool" in loaded_pyproject_toml and "azure-sdk-build" in loaded_pyproject_toml["tool"]:
             result["KEEP_FIELDS"]["tool.azure-sdk-build"] = loaded_pyproject_toml["tool"]["azure-sdk-build"]
+        if "packaging" in loaded_pyproject_toml:
+            result["KEEP_FIELDS"]["packaging"] = loaded_pyproject_toml["packaging"]
 
         # Process dependencies
         if "project" in loaded_pyproject_toml:

package/generator/build/lib/pygen/codegen/templates/packaging_templates/CHANGELOG.md.jinja2

@@ -2,5 +2,6 @@
 
 ## 1.0.0b1 (1970-01-01)
 
-- Initial version
+### Other Changes
 
+  - Initial version

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

@@ -14,7 +14,11 @@ name = "{{ options.get('package-name')|lower }}"
 authors = [
   { name = "{{ code_model.company_name }}"{% if code_model.is_azure_flavor %}, email = "azpysdkhelp@microsoft.com"{% endif %} },
 ]
+{% if options.get("azure-arm") %}
+description = "Microsoft Azure {{ options.get('package-pprint-name') }} Client Library for Python"
+{% else %}
 description = "{{ code_model.company_name }} {% if code_model.is_azure_flavor and not options.get('package-pprint-name').startswith('Azure ') %}Azure {% endif %}{{ options.get('package-pprint-name') }} Client Library for Python"
+{% endif %}
 license = "MIT"
 classifiers = [
     "Development Status :: {{ dev_status }}",
@@ -73,7 +77,7 @@ version = "{{ options.get("package-version", "unknown") }}"
 {% if code_model.is_azure_flavor %}
 
 [project.urls]
-repository = "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk"
+repository = "https://github.com/Azure/azure-sdk-for-python"
 {% endif %}
 
 [tool.setuptools.dynamic]
@@ -84,7 +88,7 @@ version = {attr = "{{ code_model.namespace|lower }}._version.VERSION"}
 version = {attr = "{{ options.get('package-name')|lower|replace('-', '.') }}._version.VERSION"}
     {% endif %}
 {% endif %}
-readme = {file = ["README.md"], content-type = "text/markdown"}
+readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"}
 {% if options.get('package-mode') %}
 
 [tool.setuptools.packages.find]

package/generator/pygen/__init__.py

@@ -46,7 +46,7 @@ class OptionsDict(MutableMapping):
         self._data = options.copy() if options else {}
         self._validate_combinations()
 
-    def __getitem__(self, key: str) -> Any: # pylint: disable=too-many-return-statements
+    def __getitem__(self, key: str) -> Any:  # pylint: disable=too-many-return-statements
         if key == "head-as-boolean" and self.get("azure-arm"):
             # override to always true if azure-arm is set
             return True
@@ -109,7 +109,12 @@ class OptionsDict(MutableMapping):
         if key == "combine-operation-files":
             return self.get("version-tolerant")
         if key == "package-pprint-name":
-            return " ".join([i.capitalize() for i in str(self.get("package-name", "")).split("-")])
+            package_names = self.get("package-name", "").split("-")
+            return (
+                (package_names[-1].capitalize() + " Management")
+                if self.get("azure-arm")
+                else " ".join([i.capitalize() for i in package_names])
+            )
         if key == "builders-visibility":
             # Default to public if low-level client is not set, otherwise embedded
             return "embedded" if not self.get("low-level-client") else "public"

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

@@ -149,9 +149,12 @@ class JinjaSerializer(ReaderAndWriter):
                     self._serialize_and_write_package_files()
 
                 # write apiview-properties.json
-                if self.code_model.options.get("emit-cross-language-definition-file"):
+                if (
+                    self.code_model.options.get("emit-cross-language-definition-file")
+                    and not self.code_model.options["multiapi"]
+                ):
                     self.write_file(
-                        generation_path / Path("apiview-properties.json"),
+                        self._root_of_sdk / Path("apiview-properties.json"),
                         general_serializer.serialize_cross_language_definition_file(),
                     )
 
@@ -165,7 +168,7 @@ class JinjaSerializer(ReaderAndWriter):
                 # add _metadata.json
                 if self.code_model.metadata:
                     self.write_file(
-                        Path("./_metadata.json"),
+                        self._root_of_sdk / "_metadata.json",
                         json.dumps(self.code_model.metadata, indent=2),
                     )
             elif client_namespace_type.clients:
@@ -216,11 +219,17 @@ class JinjaSerializer(ReaderAndWriter):
                     general_serializer.serialize_pkgutil_init_file(),
                 )
 
-    def _serialize_and_write_package_files(self) -> None:
+    # path where README.md is
+    @property
+    def _root_of_sdk(self) -> Path:
         root_of_sdk = Path(".")
         if self.code_model.options["no-namespace-folders"]:
             compensation = Path("../" * (self.code_model.namespace.count(".") + 1))
             root_of_sdk = root_of_sdk / compensation
+        return root_of_sdk
+
+    def _serialize_and_write_package_files(self) -> None:
+        root_of_sdk = self._root_of_sdk
         if self.code_model.options["package-mode"] in VALID_PACKAGE_MODE:
             env = Environment(
                 loader=PackageLoader("pygen.codegen", "templates/packaging_templates"),
@@ -520,14 +529,14 @@ class JinjaSerializer(ReaderAndWriter):
         namespace_config = get_namespace_config(self.code_model.namespace, self.code_model.options["multiapi"])
         num_of_namespace = namespace_config.count(".") + 1
         num_of_package_namespace = (
-            get_namespace_from_package_name(self.code_model.options.get("namespace", "")).count(".") + 1
+            get_namespace_from_package_name(self.code_model.options.get("package-name", "")).count(".") + 1
         )
         if num_of_namespace > num_of_package_namespace:
             return Path("/".join(namespace_config.split(".")[num_of_package_namespace:]))
         return Path("")
 
     def _serialize_and_write_sample(self, env: Environment):
-        out_path = Path("./generated_samples")
+        out_path = self._root_of_sdk / "generated_samples"
         for client in self.code_model.clients:
             for op_group in client.operation_groups:
                 for operation in op_group.operations:
@@ -561,7 +570,7 @@ class JinjaSerializer(ReaderAndWriter):
 
     def _serialize_and_write_test(self, env: Environment):
         self.code_model.for_test = True
-        out_path = Path("./generated_tests")
+        out_path = self._root_of_sdk / "generated_tests"
         general_serializer = TestGeneralSerializer(code_model=self.code_model, env=env)
         self.write_file(out_path / "conftest.py", general_serializer.serialize_conftest())
         if not self.code_model.options["azure-arm"]:

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

@@ -1067,9 +1067,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                     )
                     if self.code_model.options["models-mode"] == "dpg":
                         if xml_serializable(str(e.default_content_type)):
-                            retval.append(
-                                f"        error = _failsafe_deserialize_xml({type_annotation}, response)"
-                            )
+                            retval.append(f"        error = _failsafe_deserialize_xml({type_annotation}, response)")
                         else:
                             retval.append(f"        error = _failsafe_deserialize({type_annotation}, response)")
                     else:
@@ -1086,9 +1084,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
             if builder.non_default_errors:
                 retval.append("    else:")
             if self.code_model.options["models-mode"] == "dpg":
-                retval.append(
-                    f"{indent}error = _failsafe_deserialize({default_error_deserialization}, response)"
-                )
+                retval.append(f"{indent}error = _failsafe_deserialize({default_error_deserialization}, response)")
             else:
                 retval.append(
                     f"{indent}error = self._deserialize.failsafe_deserialize({default_error_deserialization}, "

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

@@ -70,9 +70,11 @@ class GeneralSerializer(BaseSerializer):
             # If parsing the pyproject.toml fails, we assume the it does not exist or is incorrectly formatted.
             return result
 
-        # Keep azure-sdk-build configuration
+        # Keep "azure-sdk-build" and "packaging" configuration
         if "tool" in loaded_pyproject_toml and "azure-sdk-build" in loaded_pyproject_toml["tool"]:
             result["KEEP_FIELDS"]["tool.azure-sdk-build"] = loaded_pyproject_toml["tool"]["azure-sdk-build"]
+        if "packaging" in loaded_pyproject_toml:
+            result["KEEP_FIELDS"]["packaging"] = loaded_pyproject_toml["packaging"]
 
         # Process dependencies
         if "project" in loaded_pyproject_toml:

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

@@ -2,5 +2,6 @@
 
 ## 1.0.0b1 (1970-01-01)
 
-- Initial version
+### Other Changes
 
+  - Initial version

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

@@ -14,7 +14,11 @@ name = "{{ options.get('package-name')|lower }}"
 authors = [
   { name = "{{ code_model.company_name }}"{% if code_model.is_azure_flavor %}, email = "azpysdkhelp@microsoft.com"{% endif %} },
 ]
+{% if options.get("azure-arm") %}
+description = "Microsoft Azure {{ options.get('package-pprint-name') }} Client Library for Python"
+{% else %}
 description = "{{ code_model.company_name }} {% if code_model.is_azure_flavor and not options.get('package-pprint-name').startswith('Azure ') %}Azure {% endif %}{{ options.get('package-pprint-name') }} Client Library for Python"
+{% endif %}
 license = "MIT"
 classifiers = [
     "Development Status :: {{ dev_status }}",
@@ -73,7 +77,7 @@ version = "{{ options.get("package-version", "unknown") }}"
 {% if code_model.is_azure_flavor %}
 
 [project.urls]
-repository = "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk"
+repository = "https://github.com/Azure/azure-sdk-for-python"
 {% endif %}
 
 [tool.setuptools.dynamic]
@@ -84,7 +88,7 @@ version = {attr = "{{ code_model.namespace|lower }}._version.VERSION"}
 version = {attr = "{{ options.get('package-name')|lower|replace('-', '.') }}._version.VERSION"}
     {% endif %}
 {% endif %}
-readme = {file = ["README.md"], content-type = "text/markdown"}
+readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"}
 {% if options.get('package-mode') %}
 
 [tool.setuptools.packages.find]

package/generator/test/azure/mock_api_tests/asynctests/test_azure_client_generator_core_api_version_header_async.py

@@ -0,0 +1,18 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from client.alternateapiversion.service.header.aio import HeaderClient
+
+
+@pytest.fixture
+async def client():
+    async with HeaderClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_header_api_version(client: HeaderClient):
+    await client.header_api_version()

package/generator/test/azure/mock_api_tests/asynctests/test_azure_client_generator_core_api_version_path_async.py

@@ -0,0 +1,18 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from client.alternateapiversion.service.path.aio import PathClient
+
+
+@pytest.fixture
+async def client():
+    async with PathClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_path_api_version(client: PathClient):
+    await client.path_api_version()

package/generator/test/azure/mock_api_tests/asynctests/test_azure_client_generator_core_api_version_query_async.py

@@ -0,0 +1,18 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from client.alternateapiversion.service.query.aio import QueryClient
+
+
+@pytest.fixture
+async def client():
+    async with QueryClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_query_api_version(client: QueryClient):
+    await client.query_api_version()

package/generator/test/azure/mock_api_tests/asynctests/test_client_overload_async.py

@@ -0,0 +1,27 @@
+import pytest
+from client.overload.aio import OverloadClient
+
+
+class TestClientOverloadAsync:
+    @pytest.fixture
+    def client(self):
+        return OverloadClient(endpoint="http://localhost:3000")
+
+    @pytest.mark.asyncio
+    async def test_list(self, client: OverloadClient):
+        result = await client.list()
+        assert len(result) == 2
+        assert result[0]["id"] == "1"
+        assert result[0]["name"] == "foo"
+        assert result[0]["scope"] == "car"
+        assert result[1]["id"] == "2"
+        assert result[1]["name"] == "bar"
+        assert result[1]["scope"] == "bike"
+
+    @pytest.mark.asyncio
+    async def test_list_by_scope(self, client: OverloadClient):
+        result = await client.list_by_scope("car")
+        assert len(result) == 1
+        assert result[0]["id"] == "1"
+        assert result[0]["name"] == "foo"
+        assert result[0]["scope"] == "car"

package/generator/test/azure/mock_api_tests/test_azure_client_generator_core_api_version_header.py

@@ -0,0 +1,17 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from client.alternateapiversion.service.header import HeaderClient
+
+
+@pytest.fixture
+def client():
+    with HeaderClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_header_api_version(client: HeaderClient):
+    client.header_api_version()

package/generator/test/azure/mock_api_tests/test_azure_client_generator_core_api_version_path.py

@@ -0,0 +1,17 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from client.alternateapiversion.service.path import PathClient
+
+
+@pytest.fixture
+def client():
+    with PathClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_path_api_version(client: PathClient):
+    client.path_api_version()

package/generator/test/azure/mock_api_tests/test_azure_client_generator_core_api_version_query.py

@@ -0,0 +1,17 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import pytest
+from client.alternateapiversion.service.query import QueryClient
+
+
+@pytest.fixture
+def client():
+    with QueryClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def test_query_api_version(client: QueryClient):
+    client.query_api_version()

package/generator/test/azure/mock_api_tests/test_client_overload.py

@@ -0,0 +1,25 @@
+import pytest
+from client.overload import OverloadClient
+
+
+class TestClientOverload:
+    @pytest.fixture
+    def client(self):
+        return OverloadClient(endpoint="http://localhost:3000")
+
+    def test_list(self, client: OverloadClient):
+        result = client.list()
+        assert len(result) == 2
+        assert result[0]["id"] == "1"
+        assert result[0]["name"] == "foo"
+        assert result[0]["scope"] == "car"
+        assert result[1]["id"] == "2"
+        assert result[1]["name"] == "bar"
+        assert result[1]["scope"] == "bike"
+
+    def test_list_by_scope(self, client: OverloadClient):
+        result = client.list_by_scope("car")
+        assert len(result) == 1
+        assert result[0]["id"] == "1"
+        assert result[0]["name"] == "foo"
+        assert result[0]["scope"] == "car"

package/generator/test/azure/requirements.txt

@@ -4,6 +4,9 @@ azure-mgmt-core==1.6.0
 
 # only for azure
 -e ./generated/azure-client-generator-core-access
+-e ./generated/azure-client-generator-core-api-version-header
+-e ./generated/azure-client-generator-core-api-version-path
+-e ./generated/azure-client-generator-core-api-version-query
 -e ./generated/azure-client-generator-core-client-initialization
 -e ./generated/azure-client-generator-core-deserialize-empty-string-as-null
 -e ./generated/azure-client-generator-core-flatten-property
@@ -28,6 +31,7 @@ azure-mgmt-core==1.6.0
 -e ./generated/client-namespace
 -e ./generated/azure-payload-pageable
 -e ./generated/client-naming
+-e ./generated/client-overload
 -e ./generated/client-structure-default
 -e ./generated/client-structure-multiclient
 -e ./generated/client-structure-renamedoperation

package/package.json

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