@typespec/http-client-python 0.9.0 → 0.9.2-dev.1

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

@@ -18,6 +18,7 @@ import email.utils
 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
@@ -25,11 +26,6 @@ from {{ code_model.core_library }}{{ "" if code_model.is_azure_flavor else ".uti
 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 sys.version_info >= (3, 9):
-    from collections.abc import MutableMapping
-else:
-    from typing import MutableMapping
-
 _LOGGER = logging.getLogger(__name__)
 
 __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"]
@@ -344,7 +340,7 @@ def _get_model(module_name: str, model_name: str):
 _UNSET = object()
 
 
-class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=unsubscriptable-object
+class _MyMutableMapping(MutableMapping[str, typing.Any]):
     def __init__(self, data: typing.Dict[str, typing.Any]) -> None:
         self._data = data
 
@@ -404,13 +400,13 @@ class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=uns
             return default
 
     @typing.overload
-    def pop(self, key: str) -> typing.Any: ...
+    def pop(self, key: str) -> typing.Any: ...  # pylint: disable=arguments-differ
 
     @typing.overload
-    def pop(self, key: str, default: _T) -> _T: ...
+    def pop(self, key: str, default: _T) -> _T: ...  # pylint: disable=signature-differs
 
     @typing.overload
-    def pop(self, key: str, default: typing.Any) -> typing.Any: ...
+    def pop(self, key: str, default: typing.Any) -> typing.Any: ...  # pylint: disable=signature-differs
 
     def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
         """
@@ -440,7 +436,7 @@ class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=uns
         """
         self._data.clear()
 
-    def update(self, *args: typing.Any, **kwargs: typing.Any) -> None:
+    def update(self, *args: typing.Any, **kwargs: typing.Any) -> None:  # pylint: disable=arguments-differ
         """
         Updates D from mapping/iterable E and F.
         :param any args: Either a mapping object or an iterable of key-value pairs.
@@ -451,7 +447,7 @@ class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=uns
     def setdefault(self, key: str, default: None = None) -> None: ...
 
     @typing.overload
-    def setdefault(self, key: str, default: typing.Any) -> typing.Any: ...
+    def setdefault(self, key: str, default: typing.Any) -> typing.Any: ...  # pylint: disable=signature-differs
 
     def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
         """
@@ -641,7 +637,7 @@ class Model(_MyMutableMapping):
             cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items())
             cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}")
 
-        return super().__new__(cls)  # pylint: disable=no-value-for-parameter
+        return super().__new__(cls)
 
     def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None:
         for base in cls.__bases__:
@@ -677,7 +673,7 @@ class Model(_MyMutableMapping):
                 discriminator_value = data.find(xml_name).text  # pyright: ignore
         else:
             discriminator_value = data.get(discriminator._rest_name)
-        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore
+        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore # pylint: disable=no-member
         return mapped_cls._deserialize(data, exist_discriminators)
 
     def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]:

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

@@ -3,7 +3,7 @@
 # Microsoft Azure SDK for Python
 
 This is the Microsoft {{package_pprint_name}} Client Library.
-This package has been tested with Python 3.8+.
+This package has been tested with Python 3.9+.
 For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
 
 # Usage
@@ -36,7 +36,7 @@ python -m pip install {{ package_name }}
 
 #### Prequisites
 
-- Python 3.8 or later is required to use this package.
+- Python 3.9 or later is required to use this package.
 - You need an [Azure subscription][azure_sub] to use this package.
 - An existing {{ package_pprint_name }} instance.
 

package/generator/pygen/codegen/templates/packaging_templates/setup.py.jinja2

@@ -67,7 +67,6 @@ setup(
         "Programming Language :: Python",
         "Programming Language :: Python :: 3 :: Only",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
@@ -110,7 +109,7 @@ setup(
         "typing-extensions>=4.6.0",
     ],
     {% if package_mode %}
-    python_requires=">=3.8",
+    python_requires=">=3.9",
     {% else %}
     long_description="""\
     {{ code_model.description }}

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

@@ -1,4 +1,4 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pygen
 Version: 0.1.0
 Summary: Core Library for Python Generation
@@ -9,7 +9,6 @@ License: MIT License
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -23,5 +22,15 @@ Requires-Dist: Jinja2==3.1.6
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: tomli==2.0.1
 Requires-Dist: setuptools==70.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # Core Library for Python Generation

package/generator/setup.py

@@ -35,7 +35,6 @@ setup(
         "Development Status :: 4 - Beta",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",

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

@@ -97,13 +97,6 @@ async def test_header(client: BytesClient):
         ],
     )
 
-
-@pytest.fixture
-def png_data() -> bytes:
-    with open(str(FILE_FOLDER / "data/image.png"), "rb") as file_in:
-        return file_in.read()
-
-
 @pytest.mark.asyncio
 async def test_request_body(client: BytesClient, png_data: bytes):
     await client.request_body.default(

package/generator/test/generic_mock_api_tests/conftest.py

@@ -10,7 +10,7 @@ import pytest
 import importlib
 from pathlib import Path
 
-FILE_FOLDER = Path(__file__).parent
+DATA_FOLDER = Path(__file__).parent.parent
 
 
 def start_server_process():
@@ -65,11 +65,11 @@ def key_credential(core_library):
 
 @pytest.fixture
 def png_data() -> bytes:
-    with open(str(FILE_FOLDER / "data/image.png"), "rb") as file_in:
+    with open(str(DATA_FOLDER / "data/image.png"), "rb") as file_in:
         return file_in.read()
 
 
 @pytest.fixture
 def jpg_data() -> bytes:
-    with open(str(FILE_FOLDER / "data/image.jpg"), "rb") as file_in:
+    with open(str(DATA_FOLDER / "data/image.jpg"), "rb") as file_in:
         return file_in.read()

package/generator/test/generic_mock_api_tests/test_encode_bytes.py

@@ -94,13 +94,6 @@ def test_header(client: BytesClient):
         ],
     )
 
-
-@pytest.fixture
-def png_data() -> bytes:
-    with open(str(FILE_FOLDER / "data/image.png"), "rb") as file_in:
-        return file_in.read()
-
-
 def test_request_body(client: BytesClient, png_data: bytes):
     client.request_body.default(
         value=png_data,

package/generator/test/unittests/conftest.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.
+# --------------------------------------------------------------------------
+import importlib
+import pytest
+
+@pytest.fixture
+def core_library():
+    try:
+        return importlib.import_module("azure.core")
+    except ModuleNotFoundError:
+        return importlib.import_module("corehttp")

package/generator/test/unittests/requirements.txt

@@ -0,0 +1,3 @@
+-r ../dev_requirements.txt
+-e ../../../generator
+-e ../unbranded/generated/special-words

package/generator/test/unittests/test_enums.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.
+# --------------------------------------------------------------------------
+from enum import Enum, EnumMeta
+
+
+class _CaseInsensitiveEnumMeta(EnumMeta):
+    def __getitem__(self, name):
+        return super().__getitem__(name.upper())
+
+    def __getattr__(cls, name):
+        """Return the enum member matching `name`
+        We use __getattr__ instead of descriptors or inserting into the enum
+        class' __dict__ in order to support `name` and `value` being both
+        properties for enum members (which live in the class' __dict__) and
+        enum members themselves.
+        """
+        try:
+            return cls._member_map_[name.upper()]
+        except KeyError:
+            raise AttributeError(name)
+
+
+class EnumsWithCallableNames(str, Enum, metaclass=_CaseInsensitiveEnumMeta):
+    """Gets the unit of measurement."""
+
+    COUNT = "count"
+    ENCODE = "encode"
+    FIND = "find"
+    JOIN = "join"
+
+
+def test_count():
+    assert EnumsWithCallableNames.COUNT == "count"
+    assert callable(EnumsWithCallableNames.count)
+
+
+def test_encode():
+    assert EnumsWithCallableNames.ENCODE == "encode"
+    assert callable(EnumsWithCallableNames.encode)
+
+
+def test_find():
+    assert EnumsWithCallableNames.FIND == "find"
+    assert callable(EnumsWithCallableNames.find)
+
+
+def test_join():
+    assert EnumsWithCallableNames.JOIN == "join"
+    assert callable(EnumsWithCallableNames.join)

package/generator/test/unittests/test_name_converter.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.
+# --------------------------------------------------------------------------
+from pygen.preprocess import PreProcessPlugin
+from pygen.preprocess.python_mappings import PadType
+
+
+def pad_reserved_words(name: str, pad_type: PadType) -> str:
+    return PreProcessPlugin(output_folder="").pad_reserved_words(name, pad_type)
+
+
+def test_escaped_reserved_words():
+    expected_conversion_model = {"Self": "Self", "And": "AndModel"}
+    for name in expected_conversion_model:
+        assert pad_reserved_words(name, pad_type=PadType.MODEL) == expected_conversion_model[name]
+
+    expected_conversion_method = {
+        "self": "self",
+        "and": "and_method",
+        "content_type": "content_type",
+    }
+    for name in expected_conversion_method:
+        assert pad_reserved_words(name, pad_type=PadType.METHOD) == expected_conversion_method[name]
+
+    expected_conversion_parameter = {
+        "content_type": "content_type_parameter",
+        "request_id": "request_id_parameter",
+        "elif": "elif_parameter",
+        "self": "self_parameter",
+        "continuation_token": "continuation_token_parameter",
+    }
+    for name in expected_conversion_parameter:
+        assert pad_reserved_words(name, pad_type=PadType.PARAMETER) == expected_conversion_parameter[name]
+
+    expected_conversion_enum = {
+        "self": "self",
+        "mro": "mro_enum",
+        "continuation_token": "continuation_token",
+    }
+    for name in expected_conversion_enum:
+        assert pad_reserved_words(name, pad_type=PadType.ENUM_VALUE) == expected_conversion_enum[name]

package/generator/test/unittests/test_optional_return_type.py

@@ -0,0 +1,268 @@
+# -------------------------------------------------------------------------
+# 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 pygen.codegen.models import (
+    Operation,
+    LROOperation,
+    PagingOperation,
+    Response,
+    ParameterList,
+    CodeModel,
+    RequestBuilder,
+    Client,
+)
+from pygen.codegen.models.parameter_list import RequestBuilderParameterList
+from pygen.codegen.models.primitive_types import StringType
+
+
+@pytest.fixture
+def code_model():
+    return CodeModel(
+        {
+            "clients": [
+                {
+                    "name": "client",
+                    "namespace": "blah",
+                    "moduleName": "blah",
+                    "parameters": [],
+                    "url": "",
+                    "operationGroups": [],
+                }
+            ],
+            "namespace": "namespace",
+        },
+        options={
+            "show_send_request": True,
+            "builders_visibility": "public",
+            "show_operations": True,
+            "models_mode": "dpg",
+            "version_tolerant": True,
+        },
+    )
+
+
+@pytest.fixture
+def client(code_model):
+    return Client(
+        {
+            "name": "client",
+            "namespace": "blah",
+            "moduleName": "blah",
+            "parameters": [],
+            "url": "",
+            "operationGroups": [],
+        },
+        code_model,
+        parameters=[],
+    )
+
+
+@pytest.fixture
+def request_builder(code_model, client):
+    return RequestBuilder(
+        yaml_data={
+            "url": "http://fake.com",
+            "method": "GET",
+            "groupName": "blah",
+            "isOverload": False,
+            "apiVersions": [],
+        },
+        client=client,
+        code_model=code_model,
+        name="optional_return_type_test",
+        parameters=RequestBuilderParameterList({}, code_model, parameters=[]),
+    )
+
+
+@pytest.fixture
+def operation(code_model, request_builder, client):
+    return Operation(
+        yaml_data={
+            "url": "http://fake.com",
+            "method": "GET",
+            "groupName": "blah",
+            "isOverload": False,
+            "apiVersions": [],
+        },
+        client=client,
+        code_model=code_model,
+        request_builder=request_builder,
+        name="optional_return_type_test",
+        parameters=ParameterList({}, code_model, []),
+        responses=[],
+        exceptions=[],
+    )
+
+
+@pytest.fixture
+def lro_operation(code_model, request_builder, client):
+    return LROOperation(
+        yaml_data={
+            "url": "http://fake.com",
+            "method": "GET",
+            "groupName": "blah",
+            "isOverload": False,
+            "apiVersions": [],
+        },
+        client=client,
+        code_model=code_model,
+        request_builder=request_builder,
+        name="lro_optional_return_type_test",
+        parameters=ParameterList({}, code_model, []),
+        responses=[],
+        exceptions=[],
+    )
+
+
+@pytest.fixture
+def paging_operation(code_model, request_builder, client):
+    return PagingOperation(
+        yaml_data={
+            "url": "http://fake.com",
+            "method": "GET",
+            "groupName": "blah",
+            "isOverload": False,
+            "apiVersions": [],
+            "pagerSync": "blah",
+            "pagerAsync": "blah",
+        },
+        client=client,
+        code_model=code_model,
+        request_builder=request_builder,
+        name="paging_optional_return_type_test",
+        parameters=ParameterList({}, code_model, []),
+        responses=[],
+        exceptions=[],
+    )
+
+
+@pytest.fixture
+def base_type(code_model):
+    return StringType({"type": "string"}, code_model)
+
+
+def test_success_with_body_and_fail_no_body(code_model, operation, base_type):
+    operation.responses = [
+        Response(
+            yaml_data={"statusCodes": [200]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+        Response(
+            yaml_data={"statusCodes": [202]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+    ]
+    operation.exceptions = [
+        Response(
+            yaml_data={"statusCodes": ["default"]},
+            code_model=code_model,
+            headers=[],
+            type=None,
+        )
+    ]
+
+    assert operation.has_optional_return_type is False
+
+
+def test_success_no_body_fail_with_body(code_model, operation, base_type):
+    operation.responses = [
+        Response(
+            yaml_data={"statusCodes": [200]},
+            code_model=code_model,
+            headers=[],
+            type=None,
+        )
+    ]
+    operation.exceptions = [
+        Response(
+            yaml_data={"statusCodes": ["default"]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        )
+    ]
+
+    assert operation.has_optional_return_type is False
+
+
+def test_optional_return_type_operation(code_model, operation, base_type):
+    operation.responses = [
+        Response(
+            yaml_data={"statusCodes": [200]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+        Response(
+            yaml_data={"statusCodes": [202]},
+            code_model=code_model,
+            headers=[],
+            type=None,
+        ),
+        Response(
+            yaml_data={"statusCodes": ["default"]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+    ]
+
+    assert operation.has_optional_return_type is True
+
+
+def test_lro_operation(code_model, lro_operation, base_type):
+    lro_operation.responses = [
+        Response(
+            yaml_data={"statusCodes": [200]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+        Response(
+            yaml_data={"statusCodes": [202]},
+            code_model=code_model,
+            headers=[],
+            type=None,
+        ),
+        Response(
+            yaml_data={"statusCodes": ["default"]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+    ]
+
+    assert lro_operation.has_optional_return_type is False
+
+
+def test_paging_operation(code_model, paging_operation, base_type):
+    paging_operation.responses = [
+        Response(
+            yaml_data={"statusCodes": [200]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+        Response(
+            yaml_data={"statusCodes": [202]},
+            code_model=code_model,
+            headers=[],
+            type=None,
+        ),
+        Response(
+            yaml_data={"statusCodes": ["default"]},
+            code_model=code_model,
+            headers=[],
+            type=base_type,
+        ),
+    ]
+
+    assert paging_operation.has_optional_return_type is False