@typespec/http-client-python 0.22.0 → 0.23.0

package/eng/scripts/ci/regenerate.ts

@@ -22,7 +22,7 @@ const argv = parseArgs({
 });
 
 // Add this near the top with other constants
-const SKIP_SPECS = ["type/union/discriminated", "documentation"];
+const SKIP_SPECS = ["type/union/discriminated"];
 
 // Get the directory of the current file
 const PLUGIN_DIR = argv.values.pluginDir
@@ -272,6 +272,10 @@ const EMITTER_OPTIONS: Record<string, Record<string, string> | Record<string, st
     "package-name": "typetest-union",
     namespace: "typetest.union",
   },
+  documentation: {
+    "package-name": "specs-documentation",
+    namespace: "specs.documentation",
+  },
 };
 
 function toPosix(dir: string): string {

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

@@ -40,6 +40,7 @@ class Property(BaseModel):  # pylint: disable=too-many-instance-attributes
         self.is_multipart_file_input: bool = yaml_data.get("isMultipartFileInput", False)
         self.flatten = self.yaml_data.get("flatten", False) and not getattr(self.type, "flattened_property", False)
         self.original_tsp_name: Optional[str] = self.yaml_data.get("originalTspName")
+        self.encode: Optional[str] = self.yaml_data.get("encode")
 
     def pylint_disable(self) -> str:
         retval: str = ""

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

@@ -329,6 +329,8 @@ class DpgModelSerializer(_ModelSerializer):
             args.append("is_multipart_file_input=True")
         elif hasattr(prop.type, "encode") and prop.type.encode:  # type: ignore
             args.append(f'format="{prop.type.encode}"')  # type: ignore
+        elif prop.encode:
+            args.append(f'format="{prop.encode}"')
 
         if prop.xml_metadata:
             args.append(f"xml={prop.xml_metadata}")

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

@@ -5,21 +5,28 @@
 {% set enable_custom_handling = "\n* " in doc_string or doc_string.startswith("* ") %}
 {%- if enable_custom_handling -%}
     {%- set lines = doc_string.split('\n') -%}
+    {%- set base_indent = wrap_string.lstrip('\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) -%}
+            {%- set line_indent = '' if line.strip().startswith(':') or loop.index == 1 else (base_indent + ' ') -%}
+            {%- set wrapped = (line_indent + line) | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) -%}
+            {%- for line in wrapped.split('\n') -%}
+            {%- set prefix = "" if loop.index == 1 else " " -%}
+            {%- set _ = result_lines.append(prefix + line) -%}
+            {%- endfor -%}
         {%- else -%}
-            {%- set _ = result_lines.append('') -%}
+            {# Do not add continuous blank lines #}
+            {%- if (result_lines and result_lines[-1] != '') or not result_lines -%}
+              {%- set _ = result_lines.append('') -%}
+            {%- endif -%}
         {%- endif -%}
     {%- endfor -%}
     {%- set original_result = result_lines | join('\n') -%}
@@ -37,4 +44,4 @@
     {% set suffix = suffix_string if list_result | length == loop.index %}
 {{ prefix }}{{ line }}{{ suffix }}
 {% endfor %}
-{% endmacro %}
+{% endmacro %}

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

@@ -179,6 +179,19 @@ _VALID_RFC7231 = re.compile(
     r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT"
 )
 
+_ARRAY_ENCODE_MAPPING = {
+    "pipeDelimited": "|",
+    "spaceDelimited": " ",
+    "commaDelimited": ",",
+    "newlineDelimited": "\n",
+}
+
+def _deserialize_array_encoded(delimit: str, attr):
+    if isinstance(attr, str):
+        if attr == "":
+            return []
+        return attr.split(delimit)
+    return attr
 
 def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime:
     """Deserialize ISO-8601 formatted string into Datetime object.
@@ -323,6 +336,8 @@ _DESERIALIZE_MAPPING_WITHFORMAT = {
 def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None):
     if annotation is int and rf and rf._format == "str":
         return _deserialize_int_as_str
+    if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING:
+        return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format])
     if rf and rf._format:
         return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format)
     {% if code_model.has_external_type %}
@@ -497,6 +512,8 @@ def _is_model(obj: typing.Any) -> bool:
 
 def _serialize(o, format: typing.Optional[str] = None):  # pylint: disable=too-many-return-statements
     if isinstance(o, list):
+        if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o):
+            return _ARRAY_ENCODE_MAPPING[format].join(o)
         return [_serialize(x, format) for x in o]
     if isinstance(o, dict):
         return {k: _serialize(v, format) for k, v in o.items()}
@@ -809,6 +826,17 @@ def _deserialize_sequence(
         return obj
     if isinstance(obj, ET.Element):
         obj = list(obj)
+    try:
+        if (
+            isinstance(obj, str)
+            and isinstance(deserializer, functools.partial)
+            and isinstance(deserializer.args[0], functools.partial)
+            and deserializer.args[0].func == _deserialize_array_encoded  # pylint: disable=comparison-with-callable
+        ):
+            # encoded string may be deserialized to sequence
+            return deserializer(obj)
+    except:  # pylint: disable=bare-except
+        pass
     return type(obj)(_deserialize(deserializer, entry, module) for entry in obj)
 
 

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

@@ -40,6 +40,7 @@ class Property(BaseModel):  # pylint: disable=too-many-instance-attributes
         self.is_multipart_file_input: bool = yaml_data.get("isMultipartFileInput", False)
         self.flatten = self.yaml_data.get("flatten", False) and not getattr(self.type, "flattened_property", False)
         self.original_tsp_name: Optional[str] = self.yaml_data.get("originalTspName")
+        self.encode: Optional[str] = self.yaml_data.get("encode")
 
     def pylint_disable(self) -> str:
         retval: str = ""

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

@@ -329,6 +329,8 @@ class DpgModelSerializer(_ModelSerializer):
             args.append("is_multipart_file_input=True")
         elif hasattr(prop.type, "encode") and prop.type.encode:  # type: ignore
             args.append(f'format="{prop.type.encode}"')  # type: ignore
+        elif prop.encode:
+            args.append(f'format="{prop.encode}"')
 
         if prop.xml_metadata:
             args.append(f"xml={prop.xml_metadata}")

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

@@ -5,21 +5,28 @@
 {% set enable_custom_handling = "\n* " in doc_string or doc_string.startswith("* ") %}
 {%- if enable_custom_handling -%}
     {%- set lines = doc_string.split('\n') -%}
+    {%- set base_indent = wrap_string.lstrip('\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) -%}
+            {%- set line_indent = '' if line.strip().startswith(':') or loop.index == 1 else (base_indent + ' ') -%}
+            {%- set wrapped = (line_indent + line) | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) -%}
+            {%- for line in wrapped.split('\n') -%}
+            {%- set prefix = "" if loop.index == 1 else " " -%}
+            {%- set _ = result_lines.append(prefix + line) -%}
+            {%- endfor -%}
         {%- else -%}
-            {%- set _ = result_lines.append('') -%}
+            {# Do not add continuous blank lines #}
+            {%- if (result_lines and result_lines[-1] != '') or not result_lines -%}
+              {%- set _ = result_lines.append('') -%}
+            {%- endif -%}
         {%- endif -%}
     {%- endfor -%}
     {%- set original_result = result_lines | join('\n') -%}
@@ -37,4 +44,4 @@
     {% set suffix = suffix_string if list_result | length == loop.index %}
 {{ prefix }}{{ line }}{{ suffix }}
 {% endfor %}
-{% endmacro %}
+{% endmacro %}

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

@@ -179,6 +179,19 @@ _VALID_RFC7231 = re.compile(
     r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT"
 )
 
+_ARRAY_ENCODE_MAPPING = {
+    "pipeDelimited": "|",
+    "spaceDelimited": " ",
+    "commaDelimited": ",",
+    "newlineDelimited": "\n",
+}
+
+def _deserialize_array_encoded(delimit: str, attr):
+    if isinstance(attr, str):
+        if attr == "":
+            return []
+        return attr.split(delimit)
+    return attr
 
 def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime:
     """Deserialize ISO-8601 formatted string into Datetime object.
@@ -323,6 +336,8 @@ _DESERIALIZE_MAPPING_WITHFORMAT = {
 def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None):
     if annotation is int and rf and rf._format == "str":
         return _deserialize_int_as_str
+    if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING:
+        return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format])
     if rf and rf._format:
         return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format)
     {% if code_model.has_external_type %}
@@ -497,6 +512,8 @@ def _is_model(obj: typing.Any) -> bool:
 
 def _serialize(o, format: typing.Optional[str] = None):  # pylint: disable=too-many-return-statements
     if isinstance(o, list):
+        if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o):
+            return _ARRAY_ENCODE_MAPPING[format].join(o)
         return [_serialize(x, format) for x in o]
     if isinstance(o, dict):
         return {k: _serialize(v, format) for k, v in o.items()}
@@ -809,6 +826,17 @@ def _deserialize_sequence(
         return obj
     if isinstance(obj, ET.Element):
         obj = list(obj)
+    try:
+        if (
+            isinstance(obj, str)
+            and isinstance(deserializer, functools.partial)
+            and isinstance(deserializer.args[0], functools.partial)
+            and deserializer.args[0].func == _deserialize_array_encoded  # pylint: disable=comparison-with-callable
+        ):
+            # encoded string may be deserialized to sequence
+            return deserializer(obj)
+    except:  # pylint: disable=bare-except
+        pass
     return type(obj)(_deserialize(deserializer, entry, module) for entry in obj)
 
 

package/generator/test/azure/requirements.txt

@@ -52,6 +52,7 @@ azure-mgmt-core==1.6.0
 -e ./generated/authentication-oauth2
 -e ./generated/authentication-union
 -e ./generated/setuppy-authentication-union
+-e ./generated/specs-documentation
 -e ./generated/encode-duration
 -e ./generated/encode-numeric
 -e ./generated/encode-array

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

@@ -0,0 +1,43 @@
+# -------------------------------------------------------------------------
+# 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 encode.array.aio import ArrayClient
+from encode.array import models
+
+
+@pytest.fixture
+async def client():
+    async with ArrayClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_comma_delimited(client: ArrayClient):
+    body = models.CommaDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = await client.property.comma_delimited(body)
+    assert result.value == ["blue", "red", "green"]
+
+
+@pytest.mark.asyncio
+async def test_space_delimited(client: ArrayClient):
+    body = models.SpaceDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = await client.property.space_delimited(body)
+    assert result.value == ["blue", "red", "green"]
+
+
+@pytest.mark.asyncio
+async def test_pipe_delimited(client: ArrayClient):
+    body = models.PipeDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = await client.property.pipe_delimited(body)
+    assert result.value == ["blue", "red", "green"]
+
+
+@pytest.mark.asyncio
+async def test_newline_delimited(client: ArrayClient):
+    body = models.NewlineDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = await client.property.newline_delimited(body)
+    assert result.value == ["blue", "red", "green"]

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

@@ -0,0 +1,60 @@
+# -------------------------------------------------------------------------
+# 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.documentation.aio import DocumentationClient
+from specs.documentation import models
+
+
+@pytest.fixture
+async def client():
+    async with DocumentationClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+class TestLists:
+    @pytest.mark.asyncio
+    async def test_bullet_points_op(self, client: DocumentationClient):
+        # GET /documentation/lists/bullet-points/op
+        # Expected: 204 No Content
+        await client.lists.bullet_points_op()
+
+    @pytest.mark.skip(reason="https://github.com/microsoft/typespec/issues/9173")
+    @pytest.mark.asyncio
+    async def test_bullet_points_model(self, client: DocumentationClient):
+        # POST /documentation/lists/bullet-points/model
+        # Expected request body: {"prop": "Simple"}
+        # Expected: 200 OK
+        await client.lists.bullet_points_model(input=models.BulletPointsModel(prop="Simple"))
+
+        # Also test with JSON
+        await client.lists.bullet_points_model(body={"input": {"prop": "Simple"}})
+
+    @pytest.mark.asyncio
+    async def test_numbered(self, client: DocumentationClient):
+        # GET /documentation/lists/numbered
+        # Expected: 204 No Content
+        await client.lists.numbered()
+
+
+class TestTextFormatting:
+    @pytest.mark.asyncio
+    async def test_bold_text(self, client: DocumentationClient):
+        # GET /documentation/text-formatting/bold
+        # Expected: 204 No Content
+        await client.text_formatting.bold_text()
+
+    @pytest.mark.asyncio
+    async def test_italic_text(self, client: DocumentationClient):
+        # GET /documentation/text-formatting/italic
+        # Expected: 204 No Content
+        await client.text_formatting.italic_text()
+
+    @pytest.mark.asyncio
+    async def test_combined_formatting(self, client: DocumentationClient):
+        # GET /documentation/text-formatting/combined
+        # Expected: 204 No Content
+        await client.text_formatting.combined_formatting()

package/generator/test/generic_mock_api_tests/test_encode_array.py

@@ -0,0 +1,38 @@
+# -------------------------------------------------------------------------
+# 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 encode.array import ArrayClient, models
+
+
+@pytest.fixture
+def client():
+    with ArrayClient() as client:
+        yield client
+
+
+def test_comma_delimited(client: ArrayClient):
+    body = models.CommaDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = client.property.comma_delimited(body)
+    assert result.value == ["blue", "red", "green"]
+
+
+def test_space_delimited(client: ArrayClient):
+    body = models.SpaceDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = client.property.space_delimited(body)
+    assert result.value == ["blue", "red", "green"]
+
+
+def test_pipe_delimited(client: ArrayClient):
+    body = models.PipeDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = client.property.pipe_delimited(body)
+    assert result.value == ["blue", "red", "green"]
+
+
+def test_newline_delimited(client: ArrayClient):
+    body = models.NewlineDelimitedArrayProperty(value=["blue", "red", "green"])
+    result = client.property.newline_delimited(body)
+    assert result.value == ["blue", "red", "green"]

package/generator/test/generic_mock_api_tests/test_specs_documentation.py

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------
+# 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.documentation import DocumentationClient, models
+
+
+@pytest.fixture
+def client():
+    with DocumentationClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+class TestLists:
+    def test_bullet_points_op(self, client: DocumentationClient):
+        # GET /documentation/lists/bullet-points/op
+        # Expected: 204 No Content
+        client.lists.bullet_points_op()
+
+    @pytest.mark.skip(reason="https://github.com/microsoft/typespec/issues/9173")
+    def test_bullet_points_model(self, client: DocumentationClient):
+        # POST /documentation/lists/bullet-points/model
+        # Expected: 200 OK
+        client.lists.bullet_points_model(input=models.BulletPointsModel(prop="Simple"))
+
+        # Also test with JSON
+        client.lists.bullet_points_model(body={"input": {"prop": "Simple"}})
+
+    def test_numbered(self, client: DocumentationClient):
+        # GET /documentation/lists/numbered
+        # Expected: 204 No Content
+        client.lists.numbered()
+
+
+class TestTextFormatting:
+    def test_bold_text(self, client: DocumentationClient):
+        # GET /documentation/text-formatting/bold
+        # Expected: 204 No Content
+        client.text_formatting.bold_text()
+
+    def test_italic_text(self, client: DocumentationClient):
+        # GET /documentation/text-formatting/italic
+        # Expected: 204 No Content
+        client.text_formatting.italic_text()
+
+    def test_combined_formatting(self, client: DocumentationClient):
+        # GET /documentation/text-formatting/combined
+        # Expected: 204 No Content
+        client.text_formatting.combined_formatting()

package/generator/test/unbranded/requirements.txt

@@ -7,6 +7,7 @@
 -e ./generated/authentication-oauth2
 -e ./generated/authentication-union
 -e ./generated/setuppy-authentication-union
+-e ./generated/specs-documentation
 -e ./generated/encode-duration
 -e ./generated/encode-numeric
 -e ./generated/encode-array