@typespec/http-client-python 0.19.1 → 0.20.0

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

@@ -1053,10 +1053,13 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                                 f"        error = _failsafe_deserialize({type_annotation},{pylint_disable}\n  response)"
                             )
                         else:
-                            retval.append(
-                                "        error = self._deserialize.failsafe_deserialize("
-                                f"{type_annotation},{pylint_disable}\n "
-                                "pipeline_response)"
+                            retval.extend(
+                                [
+                                    "        error = self._deserialize.failsafe_deserialize(",
+                                    f"            {type_annotation},{pylint_disable}",
+                                    "            pipeline_response,",
+                                    "        )",
+                                ]
                             )
                         # add build-in error type
                         # TODO: we should decide whether need to this wrapper for customized error type
@@ -1097,10 +1100,13 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                                 f"{type_annotation},{pylint_disable}\n  response)"
                             )
                     else:
-                        retval.append(
-                            "        error = self._deserialize.failsafe_deserialize("
-                            f"{type_annotation},{pylint_disable}\n  "
-                            "pipeline_response)"
+                        retval.extend(
+                            [
+                                "        error = self._deserialize.failsafe_deserialize(",
+                                f"            {type_annotation},{pylint_disable}",
+                                "            pipeline_response,",
+                                "        )",
+                            ]
                         )
                     condition = "elif"
         # default error handling
@@ -1111,11 +1117,22 @@ 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.extend(
+                    [
+                        f"{indent}error = _failsafe_deserialize(",
+                        f"{indent}    {default_error_deserialization}",
+                        f"{indent}    response,",
+                        f"{indent})",
+                    ]
+                )
             else:
-                retval.append(
-                    f"{indent}error = self._deserialize.failsafe_deserialize({default_error_deserialization}, "
-                    "pipeline_response)"
+                retval.extend(
+                    [
+                        f"{indent}error = self._deserialize.failsafe_deserialize(",
+                        f"{indent}    {default_error_deserialization}",
+                        f"{indent}    pipeline_response,",
+                        f"{indent})",
+                    ]
                 )
         retval.append(
             "    raise HttpResponseError(response=response{}{})".format(

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

@@ -202,9 +202,11 @@ class ParameterSerializer:
                 if is_content_type_optional and not type_annotation.startswith("Optional[")
                 else type_annotation
             )
-            if kwarg.client_default_value is not None or kwarg.optional:
+            if kwarg.client_default_value is not None or kwarg.optional or kwarg.constant:
                 if check_client_input and kwarg.check_client_input:
                     default_value = f"self._config.{kwarg.client_name}"
+                elif kwarg.constant:
+                    default_value = kwarg.type.get_declaration(None)
                 else:
                     default_value = kwarg.client_default_value_declaration
                 if check_kwarg_dict and (kwarg.location in [ParameterLocation.HEADER, ParameterLocation.QUERY]):

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

@@ -1,21 +1,39 @@
 {% macro wrap_model_string(doc_string, wrap_string, suffix_string="") %}
-{%- set lines = doc_string.split('\n') -%}
-{%- set processed_lines = [] -%}
-{%- for line in lines -%}
-    {%- set stripped = line.strip() -%}
-    {%- if stripped.startswith('* ') -%}
-        {%- set bullet_with_indent = '    ' + stripped -%}
-        {%- set wrapped = bullet_with_indent | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string + '  ') -%}
-        {%- set _ = processed_lines.append(wrapped) -%}
-    {%- elif stripped -%}
-        {%- set wrapped = line | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) -%}
-        {%- set _ = processed_lines.append(wrapped) -%}
-    {%- endif -%}
-{%- endfor -%}
-{%- set original_result = processed_lines | join('\n') -%}
+{# Check if this is a sphinx documentation line that should not have extra prefix spacing #}
+{%- set is_sphinx_doc = doc_string.strip().startswith(':ivar') or doc_string.strip().startswith(':vartype') or doc_string.strip().startswith(':param') or doc_string.strip().startswith(':type') -%}
+{# Custom handling for bullet points - normalization is now done in preprocessing #}
+{% set enable_custom_handling = "\n* " in doc_string or doc_string.startswith("* ") %}
+{%- if enable_custom_handling -%}
+    {%- set lines = doc_string.split('\n') -%}
+    {%- set result_lines = [] -%}
+    {%- for line in lines -%}
+        {%- if line.startswith('* ') -%}
+            {# Handle bullet points with proper continuation alignment #}
+            {%- set bullet_content = line[2:] -%}
+            {%- set base_indent = wrap_string.lstrip('\n') -%}
+            {%- set bullet_line = base_indent + ' * ' + bullet_content -%}
+            {%- set continuation_spaces = base_indent + '   ' -%}
+            {%- set wrapped = bullet_line | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring='\n' + continuation_spaces) -%}
+            {%- set _ = result_lines.append(wrapped) -%}
+        {%- elif line.strip() -%}
+            {%- set wrapped = line.strip() | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) -%}
+            {%- set _ = result_lines.append(wrapped) -%}
+        {%- else -%}
+            {%- set _ = result_lines.append('') -%}
+        {%- endif -%}
+    {%- endfor -%}
+    {%- set original_result = result_lines | join('\n') -%}
+{%- else -%}
+    {# Regular text handling #}
+    {%- set original_result = doc_string | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) -%}
+{%- endif -%}
 {% set list_result = original_result.split('\n') %}
 {% for line in list_result %}
-    {% set prefix = "" if loop.index == 1 else " " %}
+    {%- if is_sphinx_doc and enable_custom_handling -%}
+        {%- set prefix = "" -%}
+    {%- else -%}
+        {%- set prefix = "" if loop.index == 1 else " " -%}
+    {%- endif -%}
     {% set suffix = suffix_string if list_result | length == loop.index %}
 {{ prefix }}{{ line }}{{ suffix }}
 {% endfor %}

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

@@ -78,7 +78,7 @@
         if key in self.__flattened_items:
             if self.{{ flattened_property_attr }} is None:
                 self.{{ flattened_property_attr }} = self._attr_to_rest_field["{{ flattened_property_attr }}"]._class_type()
-            setattr(self.properties, key, value)
+            setattr(self.{{ flattened_property_attr }}, key, value)
         else:
             super().__setattr__(key, value)
         {% endif %}

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

@@ -1,18 +1,4 @@
-{% macro wrap_string(string, wrapstring, width=95) %}
-{%- set lines = string.split('\n') -%}
-{%- set processed_lines = [] -%}
-{%- for line in lines -%}
-    {%- set stripped = line.strip() -%}
-    {%- if stripped.startswith('* ') -%}
-        {%- set bullet_with_indent = stripped -%}
-        {%- set wrapped = bullet_with_indent | wordwrap(width=width, break_long_words=False, break_on_hyphens=False, wrapstring=wrapstring + '  ') -%}
-        {%- set _ = processed_lines.append(wrapped) -%}
-    {%- elif stripped -%}
-        {%- set wrapped = line | wordwrap(width=width, break_long_words=False, break_on_hyphens=False, wrapstring=wrapstring) -%}
-        {%- set _ = processed_lines.append(wrapped) -%}
-    {%- endif -%}
-{%- endfor -%}
-{{ processed_lines | join('\n') | replace("\\", "\\\\") }}{%- endmacro %}
+{% macro wrap_string(string, wrapstring, width=95) %}{{ string | replace("\\", "\\\\") | wordwrap(width=width, break_long_words=False, break_on_hyphens=False, wrapstring=wrapstring)}}{% endmacro %}
 
 {% macro description(builder, serializer) %}
 {% set example_template = serializer.example_template(builder) %}

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

@@ -0,0 +1,53 @@
+# -------------------------------------------------------------------------
+# 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 specs.azure.versioning.previewversion.aio import PreviewVersionClient
+from specs.azure.versioning.previewversion.models import UpdateWidgetColorRequest
+
+
+@pytest.fixture
+async def client():
+    async with PreviewVersionClient() as client:
+        yield client
+
+
+@pytest.fixture
+async def stable_client():
+    async with PreviewVersionClient(api_version="2024-06-01") as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_get_widget(client: PreviewVersionClient):
+    result = await client.get_widget(id="widget-123")
+    assert result.id == "widget-123"
+    assert result.name == "Sample Widget"
+    assert result.color == "blue"
+
+
+@pytest.mark.asyncio
+async def test_update_widget_color(client: PreviewVersionClient):
+    color_update = UpdateWidgetColorRequest(color="red")
+    result = await client.update_widget_color(id="widget-123", color_update=color_update)
+    assert result.id == "widget-123"
+    assert result.name == "Sample Widget"
+    assert result.color == "red"
+
+    with pytest.raises(ValueError):
+        async with PreviewVersionClient(api_version="2024-06-01") as stable_client:
+            await stable_client.update_widget_color(id="widget-123", color_update=color_update)
+
+
+@pytest.mark.asyncio
+async def test_list_widgets(stable_client: PreviewVersionClient):
+    result = await stable_client.list_widgets(name="test")
+    assert len(result.widgets) == 1
+    assert result.widgets[0].id == "widget-1"
+    assert result.widgets[0].name == "test"
+
+    with pytest.raises(ValueError):
+        async with PreviewVersionClient(api_version="2024-06-01") as client:
+            await client.list_widgets(name="test", color="test")

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

@@ -0,0 +1,50 @@
+# -------------------------------------------------------------------------
+# 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 specs.azure.versioning.previewversion import PreviewVersionClient
+from specs.azure.versioning.previewversion.models import UpdateWidgetColorRequest
+
+
+@pytest.fixture
+def client():
+    with PreviewVersionClient() as client:
+        yield client
+
+
+@pytest.fixture
+def stable_client():
+    with PreviewVersionClient(api_version="2024-06-01") as client:
+        yield client
+
+
+def test_get_widget(client: PreviewVersionClient):
+    result = client.get_widget(id="widget-123")
+    assert result.id == "widget-123"
+    assert result.name == "Sample Widget"
+    assert result.color == "blue"
+
+
+def test_update_widget_color(client: PreviewVersionClient):
+    color_update = UpdateWidgetColorRequest(color="red")
+    result = client.update_widget_color(id="widget-123", color_update=color_update)
+    assert result.id == "widget-123"
+    assert result.name == "Sample Widget"
+    assert result.color == "red"
+
+    with pytest.raises(ValueError):
+        with PreviewVersionClient(api_version="2024-06-01") as stable_client:
+            stable_client.update_widget_color(id="widget-123", color_update=color_update)
+
+
+def test_list_widgets(stable_client: PreviewVersionClient):
+    result = stable_client.list_widgets(name="test")
+    assert len(result.widgets) == 1
+    assert result.widgets[0].id == "widget-1"
+    assert result.widgets[0].name == "test"
+
+    with pytest.raises(ValueError):
+        with PreviewVersionClient(api_version="2024-06-01") as client:
+            client.list_widgets(name="test", color="test")

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

@@ -0,0 +1,14 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from pathlib import Path
+
+GENERATED_PATH = Path(__file__).parent.parent.resolve() / "generated"
+
+
+def test_clear_output_folder():
+    folder = GENERATED_PATH / "authentication-api-key/authentication/apikey/_operations"
+    assert folder.exists(), "Operations folder should exist"
+    assert not (folder / "to_be_deleted.py").exists(), "File to_be_deleted.py should be deleted after regeneration"

package/generator/test/azure/requirements.txt

@@ -30,6 +30,7 @@ azure-mgmt-core==1.6.0
 -e ./generated/azure-resource-manager-operation-templates
 -e ./generated/azure-resource-manager-resources
 -e ./generated/azure-resource-manager-method-subscription-id
+-e ./generated/azure-versioning-previewversion
 -e ./generated/client-namespace
 -e ./generated/azure-payload-pageable
 -e ./generated/client-naming

package/generator/test/azure/tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist=base, lint, mypy, pyright, apiview
+envlist=base, lint, mypy, pyright, apiview, sphinx
 skipsdist=True
 
 [testenv:ci]
@@ -7,21 +7,22 @@ deps=
     -r requirements.txt
 commands =
     # pytest
-    pytest mock_api_tests ../generic_mock_api_tests
+    {[testenv:test]commands}
 
     # pylint
-    pip install azure-pylint-guidelines-checker==0.5.2 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
-    python ../../../eng/scripts/ci/run_pylint.py -t azure -s "generated" {posargs}
+    {[testenv:lint]commands}
 
     # mypy
-    python ../../../eng/scripts/ci/run_mypy.py -t azure -s "generated" {posargs}
+    {[testenv:mypy]commands}
 
     # pyright
-    python ../../../eng/scripts/ci/run_pyright.py -t azure -s "generated" {posargs}
+    {[testenv:pyright]commands}
 
     # apiview
-    pip install apiview-stub-generator==0.3.19 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
-    python ../../../eng/scripts/ci/run_apiview.py -t azure -s "generated" {posargs}
+    {[testenv:apiview]commands}
+
+    # sphinx docstring validation
+    {[testenv:sphinx]commands}
 
 [testenv:test]
 deps=
@@ -54,3 +55,10 @@ deps=
 commands =
     pip install apiview-stub-generator==0.3.19 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
     python ../../../eng/scripts/ci/run_apiview.py -t azure -s "generated" {posargs}
+
+[testenv:sphinx]
+basepython = python3.10
+deps=
+    -r requirements.txt
+commands =
+    python ../../../eng/scripts/ci/run_sphinx_build.py -t azure -s "generated" {posargs}

package/generator/test/dev_requirements.txt

@@ -2,3 +2,7 @@
 aiohttp
 pytest-asyncio==0.14.0
 requests==2.32.2
+sphinx==8.2.0
+sphinx_rtd_theme==3.0.2
+myst_parser==4.0.1
+sphinxcontrib-jquery==4.1

package/generator/test/generic_mock_api_tests/asynctests/test_encode_bytes_async.py

@@ -124,5 +124,4 @@ async def test_response_body(client: BytesClient, png_data: bytes):
     assert expected == await client.response_body.base64()
     assert b"".join([d async for d in (await client.response_body.octet_stream())]) == png_data
     assert b"".join([d async for d in (await client.response_body.custom_content_type())]) == png_data
-    # will reopen after TCGC release a fix version for https://github.com/Azure/typespec-azure/pull/2411
-    # assert expected == await client.response_body.base64_url()
+    assert expected == await client.response_body.base64_url()

package/generator/test/generic_mock_api_tests/asynctests/test_versioning_removed_async.py

@@ -5,7 +5,7 @@
 # --------------------------------------------------------------------------
 import pytest
 from versioning.removed.aio import RemovedClient
-from versioning.removed.models import ModelV2, EnumV2
+from versioning.removed.models import ModelV2, EnumV2, ModelV3, EnumV3
 
 
 @pytest.fixture
@@ -22,7 +22,18 @@ async def test_v2(client: RemovedClient):
 
 
 @pytest.mark.asyncio
-async def test_model_v3(client: RemovedClient):
-    result = await client.model_v3({"id": "123", "enumProp": "enumMemberV1"})
-    assert result.id == "123"
-    assert result.enum_prop == "enumMemberV1"
+async def test_model_v3():
+    async with RemovedClient(endpoint="http://localhost:3000", version="v1") as client1:
+        model1 = ModelV3(id="123", enum_prop=EnumV3.ENUM_MEMBER_V1)
+        result = await client1.model_v3(model1)
+        assert result == model1
+
+    async with RemovedClient(endpoint="http://localhost:3000", version="v2preview") as client2:
+        model2 = ModelV3(id="123")
+        result = await client2.model_v3(model2)
+        assert result == model2
+
+    async with RemovedClient(endpoint="http://localhost:3000", version="v2") as client3:
+        model3 = ModelV3(id="123", enum_prop=EnumV3.ENUM_MEMBER_V1)
+        result = await client3.model_v3(model3)
+        assert result == model3

package/generator/test/generic_mock_api_tests/test_encode_bytes.py

@@ -119,5 +119,4 @@ def test_response_body(client: BytesClient, png_data: bytes):
     assert expected == client.response_body.base64()
     assert b"".join(client.response_body.octet_stream()) == png_data
     assert b"".join(client.response_body.custom_content_type()) == png_data
-    # will reopen after TCGC release a fix version for https://github.com/Azure/typespec-azure/pull/2411
-    # assert expected == client.response_body.base64_url()
+    assert expected == client.response_body.base64_url()

package/generator/test/generic_mock_api_tests/test_typetest_scalar.py

@@ -51,3 +51,8 @@ def test_decimal128_verify(client: ScalarClient):
 def test_decimal_verify(client: ScalarClient):
     prepare = client.decimal_verify.prepare_verify()
     client.decimal_verify.verify(reduce(lambda x, y: x + y, prepare))
+
+
+# open this test case after adopt new version of http-specs for https://github.com/microsoft/typespec/pull/8807
+# def test_constant_query(client: ScalarClient):
+#     client.constant_query.post()

package/generator/test/generic_mock_api_tests/test_versioning_removed.py

@@ -5,7 +5,7 @@
 # --------------------------------------------------------------------------
 import pytest
 from versioning.removed import RemovedClient
-from versioning.removed.models import ModelV2, EnumV2
+from versioning.removed.models import ModelV2, EnumV2, ModelV3, EnumV3
 
 
 @pytest.fixture
@@ -20,7 +20,18 @@ def test_v2(client: RemovedClient):
     )
 
 
-def test_model_v3(client: RemovedClient):
-    result = client.model_v3({"id": "123", "enumProp": "enumMemberV1"})
-    assert result.id == "123"
-    assert result.enum_prop == "enumMemberV1"
+def test_model_v3():
+    client1 = RemovedClient(endpoint="http://localhost:3000", version="v1")
+    model1 = ModelV3(id="123", enum_prop=EnumV3.ENUM_MEMBER_V1)
+    result = client1.model_v3(model1)
+    assert result == model1
+
+    client2 = RemovedClient(endpoint="http://localhost:3000", version="v2preview")
+    model2 = ModelV3(id="123")
+    result = client2.model_v3(model2)
+    assert result == model2
+
+    client3 = RemovedClient(endpoint="http://localhost:3000", version="v2")
+    model3 = ModelV3(id="123", enum_prop=EnumV3.ENUM_MEMBER_V1)
+    result = client3.model_v3(model3)
+    assert result == model3

package/generator/test/unbranded/tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist=base, lint, mypy, pyright, apiview
+envlist=base, lint, mypy, pyright, apiview, sphinx
 skipsdist=True
 
 [testenv:ci]
@@ -7,21 +7,22 @@ deps=
     -r requirements.txt
 commands =
     # pytest
-    pytest mock_api_tests ../generic_mock_api_tests
+    {[testenv:test]commands}
 
     # pylint
-    pip install azure-pylint-guidelines-checker==0.5.2 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
-    python ../../../eng/scripts/ci/run_pylint.py -t unbranded -s "generated" {posargs}
+    {[testenv:lint]commands}
 
     # mypy
-    python ../../../eng/scripts/ci/run_mypy.py -t unbranded -s "generated" {posargs}
+    {[testenv:mypy]commands}
 
     # pyright
-    python ../../../eng/scripts/ci/run_pyright.py -t unbranded -s "generated" {posargs}
+    {[testenv:pyright]commands}
 
     # apiview
-    pip install apiview-stub-generator==0.3.19 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
-    python ../../../eng/scripts/ci/run_apiview.py -t unbranded -s "generated" {posargs}
+    {[testenv:apiview]commands}
+
+    # sphinx docstring validation
+    {[testenv:sphinx]commands}
 
 [testenv:test]
 deps=
@@ -54,3 +55,10 @@ deps=
 commands =
     pip install apiview-stub-generator==0.3.19 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
     python ../../../eng/scripts/ci/run_apiview.py -t unbranded -s "generated" {posargs}
+
+[testenv:sphinx]
+basepython = python3.10
+deps=
+    -r requirements.txt
+commands =
+    python ../../../eng/scripts/ci/run_sphinx_build.py -t unbranded -s "generated" {posargs}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -82,7 +82,7 @@
     "@azure-tools/typespec-azure-resource-manager": "~0.61.0",
     "@azure-tools/typespec-azure-rulesets": "~0.61.0",
     "@azure-tools/typespec-client-generator-core": "~0.61.0",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.30",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.31",
     "@typespec/compiler": "^1.5.0",
     "@typespec/http": "^1.5.0",
     "@typespec/openapi": "^1.5.0",