@typespec/http-client-python 0.13.0-dev.2 → 0.13.0-dev.3

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

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

package/generator/build/lib/pygen/codegen/templates/metadata.json.jinja2

@@ -9,9 +9,9 @@
         "description": {{ client.description | tojson }},
         "host_value": {{ (client.parameters.host.client_default_value_declaration if not client.has_parameterized_host else None) | tojson }},
         "parameterized_host_template": {{ (keywords.escape_str(client.url) if client.has_parameterized_host else None) | tojson }},
-        "azure_arm": {{ client.code_model.options["azure_arm"]  | tojson }},
+        "azure_arm": {{ client.code_model.options["azure-arm"]  | tojson }},
         "has_public_lro_operations": {{ client.has_public_lro_operations | tojson }},
-        "client_side_validation": {{ client.code_model.options["client_side_validation"] | tojson }},
+        "client-side-validation": {{ client.code_model.options["client-side-validation"] | tojson }},
         "sync_imports": {{ sync_client_imports | tojson }},
         "async_imports": {{ async_client_imports | tojson }}
     },

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

@@ -29,7 +29,7 @@
         {% endif %}
     {% endfor %}
 
-    {% if code_model.options["models_mode"] == "dpg" and model.flattened_property %}
+    {% if code_model.options["models-mode"] == "dpg" and model.flattened_property %}
     __flattened_items = ["{{ model.flattened_items|join('\", \"') }}"]
     {% endif %}
 
@@ -65,7 +65,7 @@
         {% for initialize_property in initialize_properties %}
         {{ initialize_property }}
         {% endfor %}
-        {% if code_model.options["models_mode"] == "dpg" and model.flattened_property %}
+        {% if code_model.options["models-mode"] == "dpg" and model.flattened_property %}
         {% set flattened_property_attr = model.flattened_property.client_name %}
 
     def __getattr__(self, name: str) -> Any:

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

@@ -25,7 +25,7 @@ class {{ operation_group.class_name }}: {{ operation_group.pylint_disable() }}
         :attr:`{{ operation_group.property_name }}` attribute.
     """
 
-{% if code_model.public_model_types and code_model.options["models_mode"] == "msrest" %}
+{% if code_model.public_model_types and code_model.options["models-mode"] == "msrest" %}
     models = _models
 
 {% endif %}

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

@@ -6,7 +6,7 @@
 {% endif %}
 {{ imports }}
 {{ unset }}
-{% if code_model.options["builders_visibility"] == "embedded" and not async_mode %}
+{% if code_model.options["builders-visibility"] == "embedded" and not async_mode %}
   {% if need_declare_serializer %}
 {{ op_tools.declare_serializer(code_model) }}
   {% endif %}

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

@@ -61,7 +61,7 @@ Example:
 {% macro declare_serializer(code_model) %}
 {% if code_model.has_non_abstract_operations %}
 _SERIALIZER = Serializer()
-    {% if not code_model.options["client_side_validation"] %}
+    {% if not code_model.options["client-side-validation"] %}
 _SERIALIZER.client_side_validation = False
     {% endif %}
 {% endif %}

package/generator/build/lib/pygen/codegen/templates/packaging_templates/MANIFEST.in.jinja2

@@ -3,7 +3,7 @@ include LICENSE
 {% if code_model.is_tsp %}
 include {{ code_model.namespace.replace('.', '/') }}/py.typed
 {% else %}
-include {{ package_name.replace('-', '/') }}/py.typed
+include {{ options.get("package-name", "").replace('-', '/') }}/py.typed
 {% endif %}
 recursive-include tests *.py
 recursive-include samples *.py *.md

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

@@ -1,8 +1,8 @@
 {% if code_model.is_azure_flavor %}
-{% if package_mode == "mgmtplane" %}
+{% if options["package-mode"] == "mgmtplane" %}
 # Microsoft Azure SDK for Python
 
-This is the Microsoft {{package_pprint_name}} Client Library.
+This is the Microsoft {{options["package-pprint-name"]}} Client Library.
 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).
 
@@ -11,7 +11,7 @@ For a more complete view of Azure libraries, see the [azure sdk python release](
 To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)
 
 For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure)
-Code samples for this package can be found at [{{package_pprint_name}}](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
+Code samples for this package can be found at [{{options["package-pprint-name"]}}](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
 Additional code samples for different Azure services are available at [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
 
 # Provide Feedback
@@ -21,9 +21,9 @@ If you encounter any bugs or have suggestions, please file an issue in the
 section of the project.
 
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2F{{package_name}}%2FREADME.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2F{{options["package-name"]}}%2FREADME.png)
 {% else %}
-# {{ package_pprint_name }} client library for Python
+# {{ options["package-pprint-name"] }} client library for Python
 <!-- write necessary description of service -->
 
 ## Getting started
@@ -31,14 +31,14 @@ section of the project.
 ### Install the package
 
 ```bash
-python -m pip install {{ package_name }}
+python -m pip install {{ options["package-name"] }}
 ```
 
 #### Prequisites
 
 - 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.
+- An existing {{ options["package-pprint-name"] }} instance.
 
 {% if token_credential and client_name %}
 #### Create with an Azure Active Directory Credential
@@ -104,4 +104,35 @@ additional questions or comments.
 [pip]: https://pypi.org/project/pip/
 [azure_sub]: https://azure.microsoft.com/free/
 {% endif %}
+{% else %}
+# Overview
+
+This package is generated by `@typespec/http-client-python` with Typespec.
+
+## Getting started
+
+### Prequisites
+
+- Python 3.9 or later is required to use this package.
+
+### Install the package
+
+Step into folder where setup.py is then run:
+
+```bash
+pip install -e .
+```
+
+### Examples
+
+```python
+>>> from {{ code_model.namespace }} import {{ client_name }}
+>>> from {{ code_model.core_library }}.exceptions import HttpResponseError
+
+>>> client = {{ client_name }}(endpoint='<endpoint>')
+>>> try:
+        <!-- write code here -->
+    except HttpResponseError as e:
+        print('service responds error: {}'.format(e.response.json()))
+```
 {% endif %}

package/generator/build/lib/pygen/codegen/templates/packaging_templates/dev_requirements.txt.jinja2

@@ -3,7 +3,7 @@
 {% if token_credential %}
 ../../identity/azure-identity
 {% endif -%}
-{% if azure_arm %}
+{% if options["azure-arm"] %}
 ../../core/azure-mgmt-core
 {% endif %}
 aiohttp

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

@@ -5,18 +5,18 @@
 {{ code_model.license_header }}
 {% endif %}
 
-{% if package_mode %}
+{% if options["package-mode"] %}
 
 import os
 import re
 {% endif %}
 from setuptools import setup, find_packages
 
-{% set package_name = package_name or code_model.clients[0].name %}
+{% set package_name = options["package-name"] or code_model.clients[0].name %}
 
 PACKAGE_NAME = "{{ package_name|lower }}"
-{% if package_mode %}
-PACKAGE_PPRINT_NAME = "{{ package_pprint_name }}"
+{% if options["package-mode"] %}
+PACKAGE_PPRINT_NAME = "{{ options["package-pprint-name"] }}"
 {% if code_model.is_tsp %}
 PACKAGE_NAMESPACE = "{{ code_model.namespace|lower }}"
 
@@ -40,7 +40,7 @@ if not version:
 {% set author_email = "azpysdkhelp@microsoft.com" %}
 {% set url = "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk" %}
 {% else %}
-version = "{{ package_version }}"
+version = "{{ options.get("package-version", "unknown") }}"
 {% set description = "\"%s\""|format(package_name) %}
 {% set long_description = code_model.description %}
 {% set author_email = "" %}
@@ -52,7 +52,7 @@ setup(
     name=PACKAGE_NAME,
     version=version,
     description={{ description }},
-    {% if package_mode %}
+    {% if options["package-mode"] %}
     long_description=open("README.md", "r").read(),
     long_description_content_type="text/markdown",
     license="MIT License",
@@ -63,7 +63,7 @@ setup(
     url="{{ url }}",
     keywords="azure, azure sdk",
     {% endif %}
-    {% if package_mode %}
+    {% if options["package-mode"] %}
     classifiers=[
         "Development Status :: {{ dev_status }}",
         "Programming Language :: Python",
@@ -100,7 +100,7 @@ setup(
         {% else %}
         "isodate>={{ VERSION_MAP["isodate"] }}",
         {% endif %}
-        {% if azure_arm %}
+        {% if code_model.options["azure-arm"] %}
         "azure-mgmt-core>={{ VERSION_MAP["azure-mgmt-core"] }}",
         {% elif code_model.is_azure_flavor %}
         "azure-core>={{ VERSION_MAP["azure-core"] }}",
@@ -109,7 +109,7 @@ setup(
         {% endif %}
         "typing-extensions>={{ VERSION_MAP['typing-extensions'] }}",
     ],
-    {% if package_mode %}
+    {% if options["package-mode"] %}
     python_requires=">={{  MIN_PYTHON_VERSION }}",
     {% else %}
     long_description="""\

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

@@ -1,7 +1,7 @@
 {% import 'keywords.jinja2' as keywords with context %}
 {% import 'operation_tools.jinja2' as op_tools with context %}
 {{ request_builder_serializer.method_signature_and_response_type_annotation(request_builder) }}
-{% if code_model.options["builders_visibility"] == "public" %}
+{% if code_model.options["builders-visibility"] == "public" %}
     {{ op_tools.description(request_builder, request_builder_serializer) | indent }}
 {% endif %}
 {% if not request_builder.is_overload %}

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

@@ -11,7 +11,7 @@
 {% if "credential" in client_params and aad_token in client_params["credential"] %}
     pip install azure-identity
 {% endif %}
-    pip install {{ (code_model.options["package_name"] or code_model.clients[0].name)|lower }}
+    pip install {{ (code_model.options.get("package-name") or code_model.clients[0].name)|lower }}
 # USAGE
     python {{ file_name }}
     {% if "credential" in client_params and aad_token in client_params["credential"] %}

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

@@ -1,5 +1,5 @@
 {% set prefix_lower = test.prefix|lower %}
-{% set client_var = "self.client" if code_model.options["azure_arm"] else "client" %}
+{% set client_var = "self.client" if code_model.options["azure-arm"] else "client" %}
 {% set async = "async " if test.async_mode else "" %}
 {% set async_suffix = "_async" if test.async_mode else "" %}
 # coding=utf-8
@@ -9,13 +9,13 @@
 import pytest
 {{ imports }}
 
-{% if code_model.options["azure_arm"] %}
+{% if code_model.options["azure-arm"] %}
 AZURE_LOCATION = "eastus"
 {% endif %}
 
 @pytest.mark.skip("you may need to update the auto-generated test case before run it")
 class {{ test.test_class_name }}({{ test.base_test_class_name }}):
-{% if code_model.options["azure_arm"] %}
+{% if code_model.options["azure-arm"] %}
     def setup_method(self, method):
         {% if test.async_mode %}
         self.client = self.create_mgmt_client({{ test.client_name }}, is_async=True)
@@ -24,13 +24,13 @@ class {{ test.test_class_name }}({{ test.base_test_class_name }}):
         {% endif %}
 {% endif %}
 {% for testcase in test.testcases %}
-    {% if code_model.options["azure_arm"] %}
+    {% if code_model.options["azure-arm"] %}
     @{{ test.preparer_name }}(location=AZURE_LOCATION)
     {% else %}
     @{{ test.preparer_name }}()
     {% endif %}
     @recorded_by_proxy{{ async_suffix }}
-    {% if code_model.options["azure_arm"] %}
+    {% if code_model.options["azure-arm"] %}
     {{ async }}def test_{{ testcase.name }}(self, resource_group):
     {% else %}
     {{ async }}def test_{{ testcase.name }}(self, {{ prefix_lower }}_endpoint):
@@ -38,7 +38,7 @@ class {{ test.test_class_name }}({{ test.base_test_class_name }}):
     {% endif %}
         {{testcase.response }}{{ client_var }}{{ testcase.operation_group_prefix }}.{{ testcase.operation.name }}(
             {% for key, value in testcase.params.items() %}
-            {% if code_model.options["azure_arm"] and key == "resource_group_name" %}
+            {% if code_model.options["azure-arm"] and key == "resource_group_name" %}
             {{ key }}=resource_group.name,
             {% else %}
             {{ key }}={{ value|indent(12) }},

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

@@ -3,4 +3,4 @@
 {{ code_model.license_header }}
 {% endif %}
 
-VERSION = "{{ code_model.options['package_version'] }}"
+VERSION = "{{ code_model.options.get("package-version") }}"

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

@@ -210,7 +210,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
             if not (self.is_tsp and has_multi_part_content_type(body_parameter)):
                 body_parameter["type"]["types"].append(KNOWN_TYPES["binary"])
 
-            if origin_type == "model" and is_dpg_model and self.models_mode == "dpg":
+            if origin_type == "model" and is_dpg_model and self.options["models-mode"] == "dpg":
                 body_parameter["type"]["types"].insert(1, KNOWN_TYPES["any-object"])
             code_model["types"].append(body_parameter["type"])
 

package/generator/build/lib/pygen/utils.py

@@ -7,6 +7,10 @@ from typing import Any, Dict, Tuple, List
 import re
 import argparse
 
+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
+
 
 def update_enum_value(name: str, value: Any, description: str, enum_type: Dict[str, Any]) -> Dict[str, Any]:
     return {

package/generator/pygen/__init__.py

@@ -3,13 +3,15 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+from collections.abc import ItemsView, KeysView, MutableMapping, ValuesView
 import logging
 from pathlib import Path
 import json
 from abc import ABC, abstractmethod
-from typing import Any, Dict, Union, List
+from typing import Any, Dict, Iterator, Optional, Union, List
 
 import yaml
+from .utils import TYPESPEC_PACKAGE_MODE, VALID_PACKAGE_MODE
 
 from ._version import VERSION
 
@@ -18,6 +20,177 @@ __version__ = VERSION
 _LOGGER = logging.getLogger(__name__)
 
 
+class OptionsDict(MutableMapping):
+    DEFAULTS = {
+        "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,
+        "generate-test": False,
+        "head-as-boolean": True,
+        "keep-version-file": False,
+        "low-level-client": False,
+        "multiapi": False,
+        "no-async": False,
+        "no-namespace-folders": False,
+        "polymorphic-examples": 5,
+        "validate-versioning": True,
+        "version-tolerant": True,
+    }
+
+    def __init__(self, options: Optional[Dict[str, Any]] = None) -> None:
+        self._data = options.copy() if options else {}
+        self._validate_combinations()
+
+    def __getitem__(self, key: str) -> Any:
+        if key == "head-as-boolean" and self.get("azure-arm"):
+            # override to always true if azure-arm is set
+            return True
+        if key in self._data:
+            retval = self._data[key]
+            if key == "package-files-config":
+                try:
+                    return {k.strip(): v.strip() for k, v in [i.split(":") for i in retval.split("|")]}
+                except AttributeError:
+                    return retval
+            return retval
+        if key == "package-mode" and self._data.get("packaging-files-dir"):
+            # if packaging-files-dir is set, use it as package-mode
+            return self._data["packaging-files-dir"]
+        return self._get_default(key)
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        validated_value = self._validate_and_transform(key, value)
+        self._data[key] = validated_value
+
+    def __delitem__(self, key: str) -> None:
+        if key in self._data:
+            del self._data[key]
+        else:
+            raise KeyError(f"Option '{key}' not found")
+
+    def __iter__(self) -> Iterator[str]:
+        # Return both explicitly set keys and all possible default keys
+        return iter(set(self.keys()))
+
+    def __len__(self) -> int:
+        return len(set(self._data.keys()).union(self.DEFAULTS.keys()))
+
+    def __contains__(self, key: str) -> bool:  # type: ignore
+        return key in self._data or key in self.DEFAULTS
+
+    def __repr__(self) -> str:
+        """String representation."""
+        return f"OptionsDict({dict(self.items())})"
+
+    def _get_default(self, key: str) -> Any:  # pylint: disable=too-many-return-statements
+        if key == "show-operations":
+            return not self.get("low-level-client")
+        if key == "tracing":
+            return self.get("show-operations") and self.get("flavor") == "azure"
+        if key in ["show-send-request", "only-path-and-body-params-positional", "default-optional-constants-to-none"]:
+            return self.get("low-level-client") or self.get("version-tolerant")
+        if key == "combine-operation-files":
+            return self.get("version-tolerant")
+        if key == "package-pprint-name":
+            return " ".join([i.capitalize() for i in str(self.get("package-name", "")).split("-")])
+        if key == "builders-visibility":
+            # Default to public if low-level client is not set, otherwise embedded
+            return "embedded" if not self.get("low-level-client") else "public"
+        if key == "models-mode":
+            models_mode_default = False if self.get("low-level-client") or self.get("version-tolerant") else "msrest"
+            if self.get("tsp_file") is not None:
+                models_mode_default = "dpg"
+            # switch to falsy value for easier code writing
+            return models_mode_default
+        return self.DEFAULTS[key]
+
+    def _validate_combinations(self) -> None:
+        if not self.get("show-operations") and self.get("builders-visibility") == "embedded":
+            raise ValueError(
+                "Can not embed builders without operations. "
+                "Either set --show-operations to True, or change the value of --builders-visibility "
+                "to 'public' or 'hidden'."
+            )
+
+        if self.get("basic-setup-py") and not self.get("package-version"):
+            raise ValueError("--basic-setup-py must be used with --package-version")
+
+        if self.get("package-mode") and not self.get("package-version"):
+            raise ValueError("--package-mode must be used with --package-version")
+
+        if not self.get("show-operations") and self.get("combine-operation-files"):
+            raise ValueError(
+                "Can not combine operation files if you are not showing operations. "
+                "If you want operation files, pass in flag --show-operations"
+            )
+
+        if self.get("multiapi") and self.get("version-tolerant"):
+            raise ValueError(
+                "Can not currently generate version tolerant multiapi SDKs. "
+                "We are working on creating a new multiapi SDK for version tolerant and it is not available yet."
+            )
+
+        if self.get("client-side-validation") and self.get("version-tolerant"):
+            raise ValueError("Can not generate version tolerant with --client-side-validation. ")
+
+        if not (self.get("azure-arm") or self.get("version-tolerant")):
+            _LOGGER.warning(
+                "You are generating with options that would not allow the SDK to be shipped as an official Azure SDK. "
+                "Please read https://aka.ms/azsdk/dpcodegen for more details."
+            )
+
+        if self.get("flavor") != "azure" and self.get("tracing"):
+            raise ValueError("Can only have tracing turned on for Azure SDKs.")
+
+    def _validate_and_transform(self, key: str, value: Any) -> Any:
+        if key == "builders-visibility" and value not in ["public", "hidden", "embedded"]:
+            raise ValueError("The value of --builders-visibility must be either 'public', 'hidden', or 'embedded'")
+
+        if key == "models-mode" and value == "none":
+            value = False  # switch to falsy value for easier code writing
+
+        if key == "models-mode" and value not in ["msrest", "dpg", False]:
+            raise ValueError(
+                "--models-mode can only be 'msrest', 'dpg' or 'none'. "
+                "Pass in 'msrest' if you want msrest models, or "
+                "'none' if you don't want any."
+            )
+        if key == "package-mode":
+            if (
+                (value not in TYPESPEC_PACKAGE_MODE and self.get("from-typespec"))
+                or (value not in VALID_PACKAGE_MODE and not self.get("from-typespec"))
+            ) and not Path(value).exists():
+                raise ValueError(
+                    f"--package-mode can only be {' or '.join(TYPESPEC_PACKAGE_MODE)} or directory which contains template files"  # pylint: disable=line-too-long
+                )
+        return value
+
+    def setdefault(self, key: str, default: Any, /) -> Any:  # type: ignore # pylint: disable=arguments-differ
+        """Set a default value for a key if it does not exist."""
+        if key not in self._data:
+            self[key] = default
+        return self[key]
+
+    def keys(self) -> KeysView[str]:
+        """Return all keys, including defaults."""
+        all_keys = set(self._data.keys())
+        for key in self.DEFAULTS:
+            if key not in all_keys:
+                all_keys.add(key)
+        all_keys.update(self.DEFAULTS.keys())
+        return KeysView({key: None for key in all_keys})
+
+    def values(self) -> ValuesView[Any]:
+        return {key: self[key] for key in self.keys()}.values()  # pylint: disable=consider-using-dict-items
+
+    def items(self) -> ItemsView[str, Any]:
+        return {key: self[key] for key in self.keys()}.items()  # pylint: disable=consider-using-dict-items
+
+
 class ReaderAndWriter:
     def __init__(self, *, output_folder: Union[str, Path], **kwargs: Any) -> None:
         self.output_folder = Path(output_folder)
@@ -31,7 +204,8 @@ class ReaderAndWriter:
                 python_json = json.load(fd)
         except Exception:  # pylint: disable=broad-except
             python_json = {}
-        self.options = kwargs
+        kwargs["output-folder"] = str(self.output_folder)
+        self.options = OptionsDict(kwargs)
         if python_json:
             _LOGGER.warning("Loading python.json file. This behavior will be depreacted")
         self.options.update(python_json)

package/generator/pygen/black.py

@@ -21,7 +21,7 @@ _BLACK_MODE.line_length = 120
 class BlackScriptPlugin(Plugin):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        output_folder = self.options.get("output_folder", str(self.output_folder))
+        output_folder = self.options.get("output-folder", str(self.output_folder))
         if output_folder.startswith("file:"):
             output_folder = output_folder[5:]
         if os.name == "nt" and output_folder.startswith("///"):