@typespec/http-client-python 0.5.0 → 0.6.0

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

@@ -5,6 +5,6 @@
 from enum import Enum
 from {{ code_model.core_library }}{{ "" if code_model.is_azure_flavor else ".utils" }} import CaseInsensitiveEnumMeta
 
-{% for enum in code_model.enums | sort %}
+{% for enum in enums | sort %}
 {% include "enum.py.jinja2" %}
 {% endfor %}

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

@@ -8,7 +8,7 @@ from .{{ client.filename }} import {{ client.name }}  # type: ignore
     {% endfor %}
 {% endif %}
 {% if not async_mode and code_model.options['package_version']%}
-from ._version import VERSION
+from {{ code_model.get_relative_import_path(serialize_namespace, module_name="_version") }} import VERSION
 
 __version__ = VERSION
 {% endif %}

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

@@ -6,7 +6,7 @@
 {% endif %}
 
 {{ imports }}
-{% for model in code_model.model_types %}
+{% for model in models %}
 {% if model.base == "dpg" %}
 {% include "model_dpg.py.jinja2" %}
 {% elif model.base == "msrest" %}

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

@@ -7,11 +7,9 @@
 {{ op_tools.serialize(operation_group_imports()) }}
 {{ keywords.patch_imports() }}
 __all__ = [
-    {% for client in clients %}
-        {% for operation_group in client.operation_groups %}
+      {% for operation_group in operation_groups %}
     '{{ operation_group.class_name }}',
-        {% endfor %}
-    {% endfor %}
+      {% endfor %}
 ]
 {{ keywords.extend_all }}
 _patch_sdk()

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

@@ -1,7 +1,7 @@
 {% set prefix_lower = test.prefix|lower %}
 {% set client_var = "self.client" if code_model.options["azure_arm"] else "client" %}
-{% set async = "async " if test.is_async else "" %}
-{% set async_suffix = "_async" if test.is_async else "" %}
+{% set async = "async " if test.async_mode else "" %}
+{% set async_suffix = "_async" if test.async_mode else "" %}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
 import pytest
@@ -15,7 +15,7 @@ AZURE_LOCATION = "eastus"
 class {{ test.test_class_name }}({{ test.base_test_class_name }}):
 {% if code_model.options["azure_arm"] %}
     def setup_method(self, method):
-        {% if test.is_async %}
+        {% if test.async_mode %}
         self.client = self.create_mgmt_client({{ test.client_name }}, is_async=True)
         {% else %}
         self.client = self.create_mgmt_client({{ test.client_name }})

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

@@ -3,7 +3,7 @@
 {{ imports }}
 
 {% for test_name in test_names %}
-{% set extra_async = ", is_async=True" if test_name.is_async else ""%}
+{% set extra_async = ", is_async=True" if test_name.async_mode else ""%}
 {% set prefix_lower = test_name.prefix|lower %}
 class {{ test_name.base_test_class_name }}(AzureRecordedTestCase):
 
@@ -15,7 +15,7 @@ class {{ test_name.base_test_class_name }}(AzureRecordedTestCase):
             endpoint=endpoint,
         )
 
-{% if not test_name.is_async %}
+{% if not test_name.async_mode %}
 {{ test_name.preparer_name }} = functools.partial(
     PowerShellPreparer,
     "{{ prefix_lower }}",

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

@@ -3,7 +3,7 @@
 
 {{ imports }}
 
-{% if code_model.need_mixin_abc %}
+{% if code_model.need_vendored_mixin(client_namespace) %}
     {% for client in clients | selectattr("has_mixin") %}
 {% set pylint_disable = "# pylint: disable=name-too-long" if (client.name | length) + ("MixinABC" | length) > 40 else "" %}
 class {{ client.name }}MixinABC(  {{ pylint_disable }}
@@ -16,7 +16,7 @@ class {{ client.name }}MixinABC(  {{ pylint_disable }}
     _deserialize: "Deserializer"
     {% endfor %}
 {% endif %}
-{% if code_model.has_abstract_operations %}
+{% if code_model.need_vendored_abstract(client_namespace) %}
 
 def raise_if_not_implemented(cls, abstract_methods):
     not_implemented = [f for f in abstract_methods if not callable(getattr(cls, f, None))]
@@ -27,7 +27,7 @@ def raise_if_not_implemented(cls, abstract_methods):
         )
 {% endif %}
 
-{% if code_model.has_etag %}
+{% if code_model.need_vendored_etag(client_namespace) %}
 def quote_etag(etag: Optional[str]) -> Optional[str]:
     if not etag or etag == "*":
         return etag
@@ -57,7 +57,7 @@ def prep_if_none_match(etag: Optional[str], match_condition: Optional[MatchCondi
         return "*"
     return None
 {% endif %}
-{% if code_model.has_form_data and code_model.options["models_mode"] == "dpg" and not async_mode  %}
+{% if code_model.need_vendored_form_data(async_mode, client_namespace)  %}
 # file-like tuple could be `(filename, IO (or bytes))` or `(filename, IO (or bytes), content_type)`
 FileContent = Union[str, bytes, IO[str], IO[bytes]]
 

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

@@ -501,10 +501,6 @@ class PreProcessPlugin(YamlUpdatePlugin):
         for client in yaml_data["clients"]:
             self.update_client(client)
             self.update_operation_groups(yaml_data, client)
-        for clients in yaml_data["subnamespaceToClients"].values():
-            for client in clients:
-                self.update_client(client)
-                self.update_operation_groups(yaml_data, client)
         if yaml_data.get("namespace"):
             yaml_data["namespace"] = pad_builtin_namespaces(yaml_data["namespace"])
 

package/generator/dev_requirements.txt

@@ -1,8 +1,8 @@
 -e ./generator
-pyright==1.1.389
+pyright==1.1.391
 pylint==3.2.7
 tox==4.16.0
-mypy==1.13.0
+mypy==1.14.1
 colorama==0.4.6
 debugpy==1.8.2
 pytest==8.3.2

package/generator/pygen/black.py

@@ -43,8 +43,8 @@ class BlackScriptPlugin(Plugin):
                         "venv",
                         "env",
                     )
-                    and not Path(f).parts[0].startswith(".")
-                    and Path(f).suffix == ".py"
+                    # we shall also format generated files like "../../../generated_tests/test_xxx.py"
+                    and (not Path(f).parts[0].startswith(".") or Path(f).parts[0] == "..") and Path(f).suffix == ".py"
                 ],
             )
         )

package/generator/pygen/codegen/__init__.py

@@ -40,6 +40,7 @@ class OptionsRetriever:
         "generate-test": False,
         "from-typespec": False,
         "emit-cross-language-definition-file": False,
+        "enable-typespec-namespace": False,
     }
 
     @property
@@ -244,8 +245,8 @@ class CodeGenerator(Plugin):
     @staticmethod
     def sort_exceptions(yaml_data: Dict[str, Any]) -> None:
         for client in yaml_data["clients"]:
-            for group in client["operationGroups"]:
-                for operation in group["operations"]:
+            for group in client.get("operationGroups", []):
+                for operation in group.get("operations", []):
                     if not operation.get("exceptions"):
                         continue
                     # sort exceptions by status code, first single status code, then range, then default
@@ -261,8 +262,8 @@ class CodeGenerator(Plugin):
     @staticmethod
     def remove_cloud_errors(yaml_data: Dict[str, Any]) -> None:
         for client in yaml_data["clients"]:
-            for group in client["operationGroups"]:
-                for operation in group["operations"]:
+            for group in client.get("operationGroups", []):
+                for operation in group.get("operations", []):
                     if not operation.get("exceptions"):
                         continue
                     i = 0
@@ -316,6 +317,7 @@ class CodeGenerator(Plugin):
             "flavor",
             "company_name",
             "emit_cross_language_definition_file",
+            "enable_typespec_namespace",
         ]
         return {f: getattr(self.options_retriever, f) for f in flags}
 

package/generator/pygen/codegen/_utils.py

@@ -15,3 +15,7 @@ SWAGGER_PACKAGE_MODE = ["mgmtplane", "dataplane"]  # for backward compatibility
 TYPESPEC_PACKAGE_MODE = ["azure-mgmt", "azure-dataplane", "generic"]
 VALID_PACKAGE_MODE = SWAGGER_PACKAGE_MODE + TYPESPEC_PACKAGE_MODE
 NAME_LENGTH_LIMIT = 40
+
+
+def get_parent_namespace(namespace: str) -> str:
+    return namespace.rsplit(".", 1)[0]

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

@@ -87,8 +87,7 @@ class BaseType(BaseModel, ABC):  # pylint: disable=too-many-public-methods
             attrs_list.append("'text': True")
         return ", ".join(attrs_list)
 
-    @property
-    def serialization_type(self) -> str:
+    def serialization_type(self, **kwargs: Any) -> str:
         """The tag recognized by 'msrest' as a serialization/deserialization.
 
         'str', 'int', 'float', 'bool' or
@@ -103,7 +102,7 @@ class BaseType(BaseModel, ABC):  # pylint: disable=too-many-public-methods
 
     @property
     def msrest_deserialization_key(self) -> str:
-        return self.serialization_type
+        return self.serialization_type()
 
     @property
     def client_default_value(self) -> Any:

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

@@ -14,6 +14,7 @@ from typing import (
     Union,
     TYPE_CHECKING,
     cast,
+    Sequence,
 )
 from abc import abstractmethod
 
@@ -39,7 +40,7 @@ if TYPE_CHECKING:
     from .request_builder import RequestBuilder
 
 
-OverloadListType = TypeVar("OverloadListType", bound=Union[List["Operation"], List["RequestBuilder"]])
+OverloadListType = TypeVar("OverloadListType", bound=Union[Sequence["Operation"], Sequence["RequestBuilder"]])
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -72,6 +73,7 @@ class BaseBuilder(
         self.api_versions: List[str] = yaml_data["apiVersions"]
         self.added_on: Optional[str] = yaml_data.get("addedOn")
         self.external_docs: Optional[Dict[str, Any]] = yaml_data.get("externalDocs")
+        self.client_namespace: str = yaml_data.get("clientNamespace", code_model.namespace)
 
         if code_model.options["version_tolerant"] and yaml_data.get("abstract"):
             _LOGGER.warning(
@@ -112,7 +114,7 @@ class BaseBuilder(
             )
         return self._description or self.name
 
-    def method_signature(self, async_mode: bool) -> List[str]:
+    def method_signature(self, async_mode: bool, **kwargs: Any) -> List[str]:
         if self.abstract:
             return ["*args,", "**kwargs"]
-        return self.parameters.method_signature(async_mode)
+        return self.parameters.method_signature(async_mode, **kwargs)

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

@@ -43,6 +43,7 @@ class _ClientConfigBase(Generic[ParameterListType], BaseModel):
         self.parameters = parameters
         self.url: str = self.yaml_data["url"]  # the base endpoint of the client. Can be parameterized or not
         self.legacy_filename: str = self.yaml_data.get("legacyFilename", "client")
+        self.client_namespace: str = self.yaml_data.get("clientNamespace", code_model.namespace)
 
     @property
     def description(self) -> str:
@@ -188,7 +189,7 @@ class Client(_ClientConfigBase[ClientGlobalParameterList]):
         except StopIteration as exc:
             raise KeyError(f"No operation with id {operation_id} found.") from exc
 
-    def _imports_shared(self, async_mode: bool) -> FileImport:
+    def _imports_shared(self, async_mode: bool, **kwargs) -> FileImport:
         file_import = FileImport(self.code_model)
         file_import.add_submodule_import("typing", "Any", ImportType.STDLIB, TypingSection.CONDITIONAL)
         if self.code_model.options["azure_arm"]:
@@ -206,8 +207,8 @@ class Client(_ClientConfigBase[ClientGlobalParameterList]):
             file_import.merge(
                 gp.imports(
                     async_mode,
-                    relative_path=".." if async_mode else ".",
-                    operation=True,
+                    is_operation_file=True,
+                    **kwargs,
                 )
             )
         file_import.add_submodule_import(
@@ -215,8 +216,9 @@ class Client(_ClientConfigBase[ClientGlobalParameterList]):
             f"{self.name}Configuration",
             ImportType.LOCAL,
         )
+        serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace)
         file_import.add_msrest_import(
-            relative_path=".." if async_mode else ".",
+            serialize_namespace=serialize_namespace,
             msrest_import_type=MsrestImportType.SerializerDeserializer,
             typing_section=TypingSection.REGULAR,
         )
@@ -277,8 +279,8 @@ class Client(_ClientConfigBase[ClientGlobalParameterList]):
         """Whether there is non-abstract operation in any operation group."""
         return any(og.has_non_abstract_operations for og in self.operation_groups)
 
-    def imports(self, async_mode: bool) -> FileImport:
-        file_import = self._imports_shared(async_mode)
+    def imports(self, async_mode: bool, **kwargs) -> FileImport:
+        file_import = self._imports_shared(async_mode, **kwargs)
         if async_mode:
             file_import.add_submodule_import("typing", "Awaitable", ImportType.STDLIB)
             file_import.add_submodule_import(
@@ -300,9 +302,13 @@ class Client(_ClientConfigBase[ClientGlobalParameterList]):
             ImportType.SDKCORE,
             TypingSection.CONDITIONAL,
         )
+        serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace)
         for og in self.operation_groups:
             file_import.add_submodule_import(
-                f".{self.code_model.operations_folder_name}",
+                self.code_model.get_relative_import_path(
+                    serialize_namespace,
+                    self.code_model.get_imported_namespace_for_operation(og.client_namespace, async_mode),
+                ),
                 og.class_name,
                 ImportType.LOCAL,
             )
@@ -317,8 +323,8 @@ class Client(_ClientConfigBase[ClientGlobalParameterList]):
         file_import.add_submodule_import("copy", "deepcopy", ImportType.STDLIB)
         return file_import
 
-    def imports_for_multiapi(self, async_mode: bool) -> FileImport:
-        file_import = self._imports_shared(async_mode)
+    def imports_for_multiapi(self, async_mode: bool, **kwargs) -> FileImport:
+        file_import = self._imports_shared(async_mode, **kwargs)
         file_import.add_submodule_import("typing", "Optional", ImportType.STDLIB, TypingSection.CONDITIONAL)
         try:
             mixin_operation = next(og for og in self.operation_groups if og.is_mixin)
@@ -377,7 +383,7 @@ class Config(_ClientConfigBase[ConfigGlobalParameterList]):
     def name(self) -> str:
         return f"{super().name}Configuration"
 
-    def _imports_shared(self, async_mode: bool) -> FileImport:
+    def _imports_shared(self, async_mode: bool, **kwargs: Any) -> FileImport:
         file_import = FileImport(self.code_model)
         file_import.add_submodule_import(
             "pipeline" if self.code_model.is_azure_flavor else "runtime",
@@ -386,7 +392,12 @@ class Config(_ClientConfigBase[ConfigGlobalParameterList]):
         )
         file_import.add_submodule_import("typing", "Any", ImportType.STDLIB, TypingSection.CONDITIONAL)
         if self.code_model.options["package_version"]:
-            file_import.add_submodule_import(".._version" if async_mode else "._version", "VERSION", ImportType.LOCAL)
+            serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace)
+            file_import.add_submodule_import(
+                self.code_model.get_relative_import_path(serialize_namespace, module_name="_version"),
+                "VERSION",
+                ImportType.LOCAL,
+            )
         if self.code_model.options["azure_arm"]:
             policy = "AsyncARMChallengeAuthenticationPolicy" if async_mode else "ARMChallengeAuthenticationPolicy"
             file_import.add_submodule_import("azure.mgmt.core.policies", "ARMHttpLoggingPolicy", ImportType.SDKCORE)
@@ -394,22 +405,21 @@ class Config(_ClientConfigBase[ConfigGlobalParameterList]):
 
         return file_import
 
-    def imports(self, async_mode: bool) -> FileImport:
-        file_import = self._imports_shared(async_mode)
+    def imports(self, async_mode: bool, **kwargs) -> FileImport:
+        file_import = self._imports_shared(async_mode, **kwargs)
         for gp in self.parameters:
             if gp.method_location == ParameterMethodLocation.KWARG and gp not in self.parameters.kwargs_to_pop:
                 continue
             file_import.merge(
                 gp.imports(
                     async_mode=async_mode,
-                    relative_path=".." if async_mode else ".",
-                    operation=True,
+                    **kwargs,
                 )
             )
         return file_import
 
-    def imports_for_multiapi(self, async_mode: bool) -> FileImport:
-        file_import = self._imports_shared(async_mode)
+    def imports_for_multiapi(self, async_mode: bool, **kwargs: Any) -> FileImport:
+        file_import = self._imports_shared(async_mode, **kwargs)
         for gp in self.parameters:
             if (
                 gp.method_location == ParameterMethodLocation.KWARG
@@ -420,8 +430,7 @@ class Config(_ClientConfigBase[ConfigGlobalParameterList]):
             file_import.merge(
                 gp.imports_for_multiapi(
                     async_mode=async_mode,
-                    relative_path=".." if async_mode else ".",
-                    operation=True,
+                    **kwargs,
                 )
             )
         return file_import