@typespec/http-client-python 0.14.2 → 0.14.3-dev.1

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

@@ -4,7 +4,10 @@
 # license information.
 # --------------------------------------------------------------------------
 import json
-from typing import Any, List
+from typing import Any, List, TYPE_CHECKING
+import re
+import tomli as tomllib
+from packaging.version import parse as parse_version
 from .import_serializer import FileImportSerializer, TypingSection
 from ..models.imports import MsrestImportType, FileImport
 from ..models import (
@@ -16,6 +19,9 @@ from ..models.utils import NamespaceType
 from .client_serializer import ClientSerializer, ConfigSerializer
 from .base_serializer import BaseSerializer
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
 VERSION_MAP = {
     "msrest": "0.7.1",
     "isodate": "0.6.1",
@@ -42,8 +48,73 @@ class GeneralSerializer(BaseSerializer):
         params.update({"options": self.code_model.options})
         return template.render(code_model=self.code_model, **params)
 
-    def serialize_package_file(self, template_name: str, **kwargs: Any) -> str:
+    def _extract_min_dependency(self, s):
+        # Extract the minimum version from a dependency string.
+        #
+        # Handles formats like:
+        # - >=1.2.3
+        # - >=0.1.0b1 (beta versions)
+        # - >=1.2.3rc2 (release candidates)
+        #
+        # Returns the parsed version if found, otherwise version "0".
+        m = re.search(r"[>=]=?([\d.]+(?:[a-z]+\d+)?)", s)
+        return parse_version(m.group(1)) if m else parse_version("0")
+
+    def _keep_pyproject_fields(self, file_path: "Path") -> dict:
+        # Load the pyproject.toml file if it exists and extract fields to keep.
+        result: dict = {"KEEP_FIELDS": {}}
+        try:
+            with open(file_path, "rb") as f:
+                loaded_pyproject_toml = tomllib.load(f)
+        except Exception:  # pylint: disable=broad-except
+            # If parsing the pyproject.toml fails, we assume the it does not exist or is incorrectly formatted.
+            return result
+
+        # Keep azure-sdk-build 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"]
+
+        # Process dependencies
+        if "project" in loaded_pyproject_toml:
+            # Handle main dependencies
+            if "dependencies" in loaded_pyproject_toml["project"]:
+                kept_deps = []
+                for dep in loaded_pyproject_toml["project"]["dependencies"]:
+                    dep_name = re.split(r"[<>=\[]", dep)[0].strip()
+
+                    # Check if dependency is one we track in VERSION_MAP
+                    if dep_name in VERSION_MAP:
+                        # For tracked dependencies, check if the version is higher than our default
+                        default_version = parse_version(VERSION_MAP[dep_name])
+                        dep_version = self._extract_min_dependency(dep)
+                        # If the version is higher than the default, update VERSION_MAP
+                        # with higher min dependency version
+                        if dep_version > default_version:
+                            VERSION_MAP[dep_name] = str(dep_version)
+                    else:
+                        # Keep non-default dependencies
+                        kept_deps.append(dep)
+
+                if kept_deps:
+                    result["KEEP_FIELDS"]["project.dependencies"] = kept_deps
+
+            # Keep optional dependencies
+            if "optional-dependencies" in loaded_pyproject_toml["project"]:
+                result["KEEP_FIELDS"]["project.optional-dependencies"] = loaded_pyproject_toml["project"][
+                    "optional-dependencies"
+                ]
+
+        return result
+
+    def serialize_package_file(self, template_name: str, file_path: "Path", **kwargs: Any) -> str:
         template = self.env.get_template(template_name)
+
+        # Add fields to keep from an existing pyproject.toml
+        if template_name == "pyproject.toml.jinja2":
+            params = self._keep_pyproject_fields(file_path)
+        else:
+            params = {}
+
         package_parts = (
             self.code_model.namespace.split(".")[:-1]
             if self.code_model.is_tsp
@@ -57,17 +128,19 @@ class GeneralSerializer(BaseSerializer):
             dev_status = "4 - Beta"
         else:
             dev_status = "5 - Production/Stable"
-        params = {
-            "code_model": self.code_model,
-            "dev_status": dev_status,
-            "token_credential": token_credential,
-            "pkgutil_names": [".".join(package_parts[: i + 1]) for i in range(len(package_parts))],
-            "init_names": ["/".join(package_parts[: i + 1]) + "/__init__.py" for i in range(len(package_parts))],
-            "client_name": self.code_model.clients[0].name if self.code_model.clients else "",
-            "VERSION_MAP": VERSION_MAP,
-            "MIN_PYTHON_VERSION": MIN_PYTHON_VERSION,
-            "MAX_PYTHON_VERSION": MAX_PYTHON_VERSION,
-        }
+        params.update(
+            {
+                "code_model": self.code_model,
+                "dev_status": dev_status,
+                "token_credential": token_credential,
+                "pkgutil_names": [".".join(package_parts[: i + 1]) for i in range(len(package_parts))],
+                "init_names": ["/".join(package_parts[: i + 1]) + "/__init__.py" for i in range(len(package_parts))],
+                "client_name": self.code_model.clients[0].name if self.code_model.clients else "",
+                "VERSION_MAP": VERSION_MAP,
+                "MIN_PYTHON_VERSION": MIN_PYTHON_VERSION,
+                "MAX_PYTHON_VERSION": MAX_PYTHON_VERSION,
+            }
+        )
         params.update({"options": self.code_model.options})
         params.update(kwargs)
         return template.render(file_import=FileImport(self.code_model), **params)

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

@@ -0,0 +1,109 @@
+{% set min_version = MIN_PYTHON_VERSION.split('.')[1] | int %}
+{% set max_version = MAX_PYTHON_VERSION.split('.')[1] | int %}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
+
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]  # Requires 61.0.0 for dynamic version
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{ options.get('package-name')|lower }}"
+{% if options.get('package-mode') %}
+authors = [
+  { name = "{{ code_model.company_name }}"{% if code_model.is_azure_flavor %}, email = "azpysdkhelp@microsoft.com"{% endif %} },
+]
+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"
+license = {text = "MIT License"}
+classifiers = [
+    "Development Status :: {{ dev_status }}",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    {% for version in range(min_version, max_version + 1) %}
+    "Programming Language :: Python :: 3.{{ version }}",
+    {% endfor %}
+    "License :: OSI Approved :: MIT License",
+]
+requires-python = ">={{ MIN_PYTHON_VERSION }}"
+{% else %}
+description = "{{ options.get('package-name') }}"
+{% endif %}
+{% if code_model.is_azure_flavor %}
+keywords = ["azure", "azure sdk"]
+{% endif %}
+
+dependencies = [
+    {% if code_model.is_legacy %}
+    "msrest>={{ VERSION_MAP['msrest'] }}",
+    {% else %}
+    "isodate>={{ VERSION_MAP['isodate'] }}",
+    {% endif %}
+    {% if options.get('azure_arm') %}
+    "azure-mgmt-core>={{ VERSION_MAP['azure-mgmt-core'] }}",
+    {% elif code_model.is_azure_flavor %}
+    "azure-core>={{ VERSION_MAP['azure-core'] }}",
+    {% else %}
+    "corehttp[requests]>={{ VERSION_MAP['corehttp'] }}",
+    {% endif %}
+    "typing-extensions>={{ VERSION_MAP['typing-extensions'] }}",
+    {% if KEEP_FIELDS and KEEP_FIELDS.get('project.dependencies') %}
+    {% for dep in KEEP_FIELDS.get('project.dependencies') %}
+    "{{ dep }}",
+    {% endfor %}
+    {% endif %}
+]
+dynamic = [
+    {% if options.get('package-mode') %}"version", {% endif %}"readme"
+]
+{% if not options.get('package-mode') %}
+version = "{{ options.get("package-version", "unknown") }}"
+{% endif %}
+{% if KEEP_FIELDS and KEEP_FIELDS.get('project.optional-dependencies') %}
+
+[project.optional-dependencies]
+{% for key, val in KEEP_FIELDS.get('project.optional-dependencies').items() %}
+{{ key }} = [
+  {% for dep in val %}
+  "{{ dep }}",
+  {% endfor %}
+]
+{% endfor %}
+{% endif %}
+{% if code_model.is_azure_flavor %}
+
+[project.urls]
+repository = "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk"
+{% endif %}
+
+[tool.setuptools.dynamic]
+{% if options.get('package-mode') %}
+    {% if code_model.is_tsp %}
+version = {attr = "{{ code_model.namespace|lower }}._version.VERSION"}
+    {% else %}
+version = {attr = "{{ options.get('package-name')|lower|replace('-', '.') }}._version.VERSION"}
+    {% endif %}
+{% endif %}
+readme = {file = ["README.md"], content-type = "text/markdown"}
+{% if options.get('package-mode') %}
+
+[tool.setuptools.packages.find]
+exclude = [
+    "tests*",
+    "samples*",
+    {% for pkgutil_name in pkgutil_names %}
+    "{{ pkgutil_name }}",
+    {% endfor %}
+]
+
+[tool.setuptools.package-data]
+pytyped = ["py.typed"]
+{% endif %}
+{% if KEEP_FIELDS and KEEP_FIELDS.get('tool.azure-sdk-build') %}
+
+[tool.azure-sdk-build]
+{% for key, val in KEEP_FIELDS.get('tool.azure-sdk-build').items() %}
+{{ key }} = {{ val|tojson }}
+{% endfor %}
+{% endif %}

package/generator/pygen/__init__.py

@@ -25,10 +25,10 @@ class OptionsDict(MutableMapping):
         "azure-arm": False,
         "basic-setup-py": False,
         "client-side-validation": False,
-        "emit-cross-language-definition-file": False,
         "flavor": "azure",  # need to default to azure in shared code so we don't break swagger generation
         "from-typespec": False,
         "generate-sample": False,
+        "keep-setup-py": False,
         "generate-test": False,
         "head-as-boolean": True,
         "keep-version-file": False,
@@ -39,6 +39,7 @@ class OptionsDict(MutableMapping):
         "polymorphic-examples": 5,
         "validate-versioning": True,
         "version-tolerant": True,
+        "generation-subdir": None,  # subdirectory to generate the code in
     }
 
     def __init__(self, options: Optional[Dict[str, Any]] = None) -> None:
@@ -106,6 +107,8 @@ class OptionsDict(MutableMapping):
                 models_mode_default = "dpg"
             # switch to falsy value for easier code writing
             return models_mode_default
+        if key == "emit-cross-language-definition-file":
+            return self.get("flavor") == "azure"
         return self.DEFAULTS[key]
 
     def _validate_combinations(self) -> None:
@@ -134,6 +137,10 @@ class OptionsDict(MutableMapping):
                 "We are working on creating a new multiapi SDK for version tolerant and it is not available yet."
             )
 
+        # If multiapi, do not generate default pyproject.toml
+        if self.get("multiapi"):
+            self["keep-setup-py"] = True
+
         if self.get("client-side-validation") and self.get("version-tolerant"):
             raise ValueError("Can not generate version tolerant with --client-side-validation. ")
 
@@ -210,6 +217,9 @@ class ReaderAndWriter:
             _LOGGER.warning("Loading python.json file. This behavior will be depreacted")
         self.options.update(python_json)
 
+    def get_output_folder(self) -> Path:
+        return self.output_folder
+
     def read_file(self, path: Union[str, Path]) -> str:
         """Directly reading from disk"""
         # make path relative to output folder
@@ -227,6 +237,14 @@ class ReaderAndWriter:
         with open(self.output_folder / Path(filename), "w", encoding="utf-8") as fd:
             fd.write(file_content)
 
+    def remove_file(self, filename: Union[str, Path]) -> None:
+        try:
+            file_path = self.output_folder / Path(filename)
+            if file_path.is_file():
+                file_path.unlink()
+        except FileNotFoundError:
+            pass
+
     def list_file(self) -> List[str]:
         return [str(f.relative_to(self.output_folder)) for f in self.output_folder.glob("**/*") if f.is_file()]
 

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

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+from pathlib import Path
 from typing import List, Dict, Any, Set, Union, Literal, Optional, cast
 
 from .base import BaseType
@@ -452,3 +453,34 @@ class CodeModel:  # pylint: disable=too-many-public-methods, disable=too-many-in
             return self.yaml_data.get("licenseInfo", {}).get("company", "")
         # typespec azure case without custom license and swagger case
         return "Microsoft Corporation"
+
+    def get_root_dir(self) -> Path:
+        if self.options["no-namespace-folders"]:
+            # when output folder contains parts different from the namespace, we fall back to current folder directly.
+            return Path(".")
+        return Path(*self.namespace.split("."))
+
+    def get_generation_dir(self, namespace: str) -> Path:
+        """The directory to generate the code in.
+
+        If 'generation-subdir' is specified, it will be used as a subdirectory.
+        """
+        root_dir = self.get_root_dir()
+        retval = self._get_relative_generation_dir(root_dir, namespace)
+        return retval
+
+    def _get_relative_generation_dir(self, root_dir: Path, namespace: str) -> Path:
+        if self.options["no-namespace-folders"]:
+            return Path(".")
+        if self.options.get("generation-subdir"):
+            # For the main namespace, return root_dir + generation-subdir
+            if namespace in ("", self.namespace):
+                return root_dir / self.options["generation-subdir"]
+
+            # For subnamespaces, extract the subnamespace part and append it to generation-subdir
+            if namespace.startswith(self.namespace + "."):
+                subnamespace_parts = namespace[len(self.namespace) + 1 :].split(".")
+                return root_dir / self.options["generation-subdir"] / Path(*subnamespace_parts)
+
+        # No generation-subdir specified, use the namespace path directly
+        return Path(*namespace.split("."))

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

@@ -194,14 +194,13 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
     def any_response_has_headers(self) -> bool:
         return any(response.headers for response in self.responses)
 
-    @property
-    def default_error_deserialization(self) -> Optional[str]:
+    def default_error_deserialization(self, serialize_namespace: str) -> Optional[str]:
         default_exceptions = [e for e in self.exceptions if "default" in e.status_codes and e.type]
         if not default_exceptions:
             return None
         exception_schema = default_exceptions[0].type
         if isinstance(exception_schema, ModelType):
-            return exception_schema.type_annotation(skip_quote=True)
+            return exception_schema.type_annotation(skip_quote=True, serialize_namespace=serialize_namespace)
         return None if self.code_model.options["models-mode"] == "dpg" else "'object'"
 
     @property
@@ -469,7 +468,7 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
                 file_import.add_submodule_import(relative_path, "_deserialize_xml", ImportType.LOCAL)
             elif self.need_deserialize:
                 file_import.add_submodule_import(relative_path, "_deserialize", ImportType.LOCAL)
-            if self.default_error_deserialization or self.non_default_errors:
+            if self.default_error_deserialization(serialize_namespace) or self.non_default_errors:
                 file_import.add_submodule_import(relative_path, "_failsafe_deserialize", ImportType.LOCAL)
         return file_import
 

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

@@ -173,7 +173,7 @@ class PagingOperationBase(OperationBase[PagingResponseType]):
                 serialize_namespace, module_name="_utils.model_base"
             )
             file_import.merge(self.item_type.imports(**kwargs))
-            if self.default_error_deserialization or self.need_deserialize:
+            if self.default_error_deserialization(serialize_namespace) or self.need_deserialize:
                 file_import.add_submodule_import(relative_path, "_deserialize", ImportType.LOCAL)
         return file_import