@typespec/http-client-python 0.4.4 → 0.5.0

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

@@ -0,0 +1,108 @@
+# coding=utf-8
+{{ license_header }}
+# coding: utf-8
+{% if package_mode %}
+import os
+import re
+{% endif -%}
+from setuptools import setup, find_packages
+
+{% set package_name = package_name or code_model.clients[0].name %}
+
+PACKAGE_NAME = "{{ package_name|lower }}"
+{% if package_mode -%}
+PACKAGE_PPRINT_NAME = "{{ package_pprint_name }}"
+
+# a-b-c => a/b/c
+package_folder_path = PACKAGE_NAME.replace("-", "/")
+
+# Version extraction inspired from 'requests'
+with open(os.path.join(package_folder_path, "_version.py"), "r") as fd:
+    version = re.search(
+        r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE
+    ).group(1)
+
+if not version:
+    raise RuntimeError("Cannot find version information")
+{% set description = "\"" + code_model.options["company_name"] + " {} Client Library for Python\".format(PACKAGE_PPRINT_NAME)" %}
+{% set author_email = "azpysdkhelp@microsoft.com" %}
+{% set url = "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk" %}
+{% else %}
+version = "{{ package_version }}"
+{% set description = "\"%s\""|format(package_name) %}
+{% set long_description = code_model.description %}
+{% set author_email = "" %}
+{% set url = "" %}
+{% endif -%}
+
+setup(
+    name=PACKAGE_NAME,
+    version=version,
+    description={{ description }},
+    {% if package_mode %}
+    long_description=open("README.md", "r").read(),
+    long_description_content_type="text/markdown",
+    license="MIT License",
+    author="{{ code_model.options["company_name"] }} Corporation",
+    {% endif %}
+    {% if code_model.is_azure_flavor %}
+    author_email="{{ author_email }}",
+    url="{{ url }}",
+    keywords="azure, azure sdk",
+    {% endif %}
+    {% if package_mode %}
+    classifiers=[
+        "Development Status :: {{ dev_status }}",
+        "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",
+        "Programming Language :: Python :: 3.12",
+        "License :: OSI Approved :: MIT License",
+    ],
+    zip_safe=False,
+    packages=find_packages(
+        exclude=[
+            "tests",
+            {% if pkgutil_names %}
+            # Exclude packages that will be covered by PEP420 or nspkg
+            {% endif %}
+            {%- for pkgutil_name in pkgutil_names %}
+            "{{ pkgutil_name }}",
+            {%- endfor %}
+        ]
+    ),
+    include_package_data=True,
+    package_data={
+        '{{ code_model.namespace }}': ['py.typed'],
+    },
+    {% else %}
+    packages=find_packages(),
+    include_package_data=True,
+    {% endif %}
+    install_requires=[
+        {% if code_model.is_legacy %}
+        "msrest>=0.7.1",
+        {% else %}
+        "isodate>=0.6.1",
+        {% endif %}
+        {% if azure_arm %}
+        "azure-mgmt-core>=1.3.2",
+        {% elif code_model.is_azure_flavor %}
+        "azure-core>=1.30.0",
+        {% else %}
+        "corehttp[requests]",
+        {% endif %}
+        "typing-extensions>=4.6.0",
+    ],
+    {% if package_mode %}
+    python_requires=">=3.8",
+    {% else %}
+    long_description="""\
+    {{ code_model.description }}
+    """
+    {% endif %}
+)

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

@@ -0,0 +1,21 @@
+{% import 'operation_tools.jinja2' as op_tools with context %}
+{# actual template starts here #}
+{% if operation.overloads and operation.include_documentation %}
+{{ op_tools.generate_overloads(operation_serializer, operation) }}
+{% endif %}
+{{ operation_serializer.method_signature_and_response_type_annotation(operation) }}
+{% if operation.include_documentation %}
+    {{ op_tools.description(operation, operation_serializer) | indent }}{% endif %}
+    {% if not operation.abstract %}
+        {% if operation.deprecated %}
+    warnings.warn('Method {{operation.name}} is deprecated', DeprecationWarning)
+        {% endif %}
+        {% if operation_serializer.pop_kwargs_from_signature(operation) %}
+    {{ op_tools.serialize(operation_serializer.pop_kwargs_from_signature(operation)) | indent }}
+        {% endif %}
+    {{ op_tools.serialize(operation_serializer.set_up_params_for_pager(operation)) | indent }}
+
+    return {{ operation.get_pager(async_mode) }}(
+        get_next, extract_data
+    )
+    {% endif %}

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

@@ -0,0 +1,19 @@
+# ------------------------------------
+# Copyright (c) {{ code_model.options["company_name"] }} Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""Customize generated code here.
+
+Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
+"""
+{{ imports }}
+
+__all__: List[str] = []  # Add all objects you want publicly available to users at this package level
+
+def patch_sdk():
+    """Do not remove from this file.
+
+    `patch_sdk` is a last resort escape hatch that allows you to do customizations
+    you can't accomplish using the techniques described in
+    https://aka.ms/azsdk/python/dpcodegen/python/customize
+    """

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

@@ -0,0 +1 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore

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

@@ -0,0 +1,28 @@
+{% 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" %}
+    {{ op_tools.description(request_builder, request_builder_serializer) | indent }}
+{% endif %}
+{% if not request_builder.is_overload %}
+        {% if request_builder_serializer.pop_kwargs_from_signature(request_builder) %}
+    {{ op_tools.serialize(request_builder_serializer.pop_kwargs_from_signature(request_builder)) | indent }}
+        {%- endif -%}
+    {% if request_builder_serializer.declare_non_inputtable_headers_queries(request_builder) %}
+    {{ op_tools.serialize(request_builder_serializer.declare_non_inputtable_headers_queries(request_builder)) | indent }}
+        {% endif %}
+    # Construct URL
+    {{ request_builder_serializer.construct_url(request_builder) }}
+    {% if request_builder.parameters.path %}
+    {{ op_tools.serialize(request_builder_serializer.serialize_path(request_builder)) | indent }}
+    _url: str = _url.format(**path_format_arguments)  # type: ignore
+        {% endif %}
+
+        {% if request_builder.parameters.query %}
+    {{ op_tools.serialize(request_builder_serializer.serialize_query(request_builder)) | indent }}
+        {% endif %}
+        {% if request_builder.parameters.headers %}
+    {{ op_tools.serialize(request_builder_serializer.serialize_headers(request_builder)) | indent }}
+        {% endif %}
+    {{ op_tools.serialize(request_builder_serializer.create_http_request(request_builder)) | indent }}
+{% endif %}

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

@@ -0,0 +1,10 @@
+{% import 'operation_tools.jinja2' as op_tools %}
+# coding=utf-8
+{{ code_model.options['license_header'] }}
+{{ imports }}
+
+{{ op_tools.declare_serializer(code_model) }}
+{% for request_builder in request_builders %}
+
+{% include "request_builder.py.jinja2" %}
+{% endfor %}

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

@@ -0,0 +1,12 @@
+# coding=utf-8
+{{ code_model.options['license_header'] }}
+
+{% for request_builder in request_builders %}
+from ._request_builders import {{ request_builder.name }}
+{% endfor %}
+
+__all__ = [
+    {% for request_builder in request_builders %}
+    '{{ request_builder.name }}',
+    {% endfor %}
+]

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

@@ -0,0 +1,44 @@
+# coding=utf-8
+{% set aad_token = "DefaultAzureCredential" %}
+{% set azure_key = "AzureKeyCredential" %}
+{{ code_model.options['license_header'] }}
+
+{{ imports }}
+"""
+# PREREQUISITES
+{% 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 }}
+# USAGE
+    python {{ file_name }}
+    {% if "credential" in client_params and aad_token in client_params["credential"] %}
+
+    Before run the sample, please set the values of the client ID, tenant ID and client secret
+    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
+    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
+    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
+    {% elif "credential" in client_params and azure_key in client_params["credential"] %}
+
+    Before run the sample, please set environment variables AZURE_KEY with real value
+    which can access your service
+    {% endif %}
+"""
+def main():
+    client = {{ code_model.clients[0].name }}(
+        {% for key,value in client_params.items() %}
+        {{ key }}={{ value }},
+        {% endfor %}
+    )
+
+    {{ return_var }}client{{ operation_group_name }}{{ operation_name }}(
+        {% for key, value in operation_params.items() %}
+        {{ key }}={{ value|indent(8) }},
+        {% endfor %}
+    ){{ operation_result }}
+
+{% if origin_file %}
+# x-ms-original-file: {{ origin_file }}
+{% endif %}
+if __name__ == "__main__":
+    main()