@typespec/http-client-python 0.8.1 → 0.8.3-dev.1

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

@@ -1,6 +1,8 @@
 {% import 'operation_tools.jinja2' as op_tools %}
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 {% if serializer.global_pylint_disables() %}
 {{ serializer.global_pylint_disables() }}
 {% endif %}

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

@@ -1,6 +1,8 @@
 {% import 'keywords.jinja2' as keywords %}
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 {{ keywords.path_type_checking_imports() }}
 {% if schemas %}
 

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

@@ -2,7 +2,9 @@
 {% set operations_description = "async operations" if async_mode else "operations" %}
 {% set return_none_type_annotation = " -> None" if async_mode else "" %}
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 {{ imports }}
 {{ unset }}
 {% if code_model.options["builders_visibility"] == "embedded" and not async_mode %}

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

@@ -2,7 +2,9 @@
 {% import 'keywords.jinja2' as keywords %}
 {# actual template starts here #}
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 {{ keywords.path_type_checking_imports() }}
 {{ op_tools.serialize(operation_group_imports()) }}
 {{ keywords.patch_imports() }}

package/generator/pygen/codegen/templates/packaging_templates/LICENSE.jinja2

@@ -1,21 +1 @@
-Copyright (c) {{ code_model.options["company_name"] }} Corporation.
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+{{ code_model.license_description }}

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

@@ -1,8 +1,12 @@
 include *.md
 include LICENSE
+{% if code_model.is_tsp %}
+include {{ code_model.namespace.replace('.', '/') }}/py.typed
+{% else %}
 include {{ package_name.replace('-', '/') }}/py.typed
+{% endif %}
 recursive-include tests *.py
 recursive-include samples *.py *.md
-{%- for init_name in init_names %}
+{% for init_name in init_names %}
 include {{ init_name }}
-{%- endfor %}
+{% endfor %}

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

@@ -1,5 +1,5 @@
 {% if code_model.is_azure_flavor %}
-{% if package_mode == "mgmtplane" -%}
+{% if package_mode == "mgmtplane" %}
 # Microsoft Azure SDK for Python
 
 This is the Microsoft {{package_pprint_name}} Client Library.
@@ -40,7 +40,7 @@ python -m pip install {{ package_name }}
 - You need an [Azure subscription][azure_sub] to use this package.
 - An existing {{ package_pprint_name }} instance.
 
-{%- if token_credential %}
+{% if token_credential %}
 #### Create with an Azure Active Directory Credential
 To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
 provide an instance of the desired credential type obtained from the
@@ -57,7 +57,7 @@ Set the values of the client ID, tenant ID, and client secret of the AAD applica
 Use the returned token credential to authenticate the client:
 
 ```python
->>> from {{ namespace }} import {{ client_name }}
+>>> from {{ code_model.namespace }} import {{ client_name }}
 >>> from azure.identity import DefaultAzureCredential
 >>> client = {{ client_name }}(endpoint='<endpoint>', credential=DefaultAzureCredential())
 ```
@@ -65,7 +65,7 @@ Use the returned token credential to authenticate the client:
 ## Examples
 
 ```python
->>> from {{ namespace }} import {{ client_name }}
+>>> from {{ code_model.namespace }} import {{ client_name }}
 >>> from azure.identity import DefaultAzureCredential
 >>> from {{ code_model.core_library }}.exceptions import HttpResponseError
 
@@ -76,7 +76,7 @@ Use the returned token credential to authenticate the client:
         print('service responds error: {}'.format(e.response.json()))
 
 ```
-{%- endif %}
+{% endif %}
 
 ## Contributing
 

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

@@ -1,9 +1,9 @@
 -e ../../../tools/azure-sdk-tools
 ../../core/azure-core
-{% if token_credential -%}
+{% if token_credential %}
 ../../identity/azure-identity
 {% endif -%}
-{% if azure_arm -%}
+{% if azure_arm %}
 ../../core/azure-mgmt-core
-{% endif -%}
+{% endif %}
 aiohttp

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

@@ -1,20 +1,30 @@
 # coding=utf-8
-{{ license_header }}
-# coding: utf-8
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
+
 {% if package_mode %}
+
 import os
 import re
-{% endif -%}
+{% 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 -%}
+{% if package_mode %}
 PACKAGE_PPRINT_NAME = "{{ package_pprint_name }}"
+{% if code_model.is_tsp %}
+PACKAGE_NAMESPACE = "{{ code_model.namespace|lower }}"
+
+# a.b.c => a/b/c
+package_folder_path = PACKAGE_NAMESPACE.replace(".", "/")
+{% else %}
 
 # a-b-c => a/b/c
 package_folder_path = PACKAGE_NAME.replace("-", "/")
+{% endif %}
 
 # Version extraction inspired from 'requests'
 with open(os.path.join(package_folder_path, "_version.py"), "r") as fd:
@@ -24,7 +34,7 @@ with open(os.path.join(package_folder_path, "_version.py"), "r") as fd:
 
 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 description = "\"" + code_model.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 %}
@@ -33,7 +43,8 @@ version = "{{ package_version }}"
 {% set long_description = code_model.description %}
 {% set author_email = "" %}
 {% set url = "" %}
-{% endif -%}
+{% endif %}
+
 
 setup(
     name=PACKAGE_NAME,
@@ -43,7 +54,7 @@ setup(
     long_description=open("README.md", "r").read(),
     long_description_content_type="text/markdown",
     license="MIT License",
-    author="{{ code_model.options["company_name"] }} Corporation",
+    author="{{ code_model.company_name }}",
     {% endif %}
     {% if code_model.is_azure_flavor %}
     author_email="{{ author_email }}",
@@ -70,9 +81,9 @@ setup(
             {% if pkgutil_names %}
             # Exclude packages that will be covered by PEP420 or nspkg
             {% endif %}
-            {%- for pkgutil_name in pkgutil_names %}
+            {% for pkgutil_name in pkgutil_names %}
             "{{ pkgutil_name }}",
-            {%- endfor %}
+            {% endfor %}
         ]
     ),
     include_package_data=True,

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

@@ -1,7 +1,12 @@
-# ------------------------------------
-# Copyright (c) {{ code_model.options["company_name"] }} Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
+# coding=utf-8
+{% if not code_model.is_azure_flavor %}
+{{ code_model.license_header }}
+{% else %}
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------
+{% endif %}
 """Customize generated code here.
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize

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

@@ -1,6 +1,8 @@
 {% import 'operation_tools.jinja2' as op_tools %}
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 {{ imports }}
 
 {{ op_tools.declare_serializer(code_model) }}

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

@@ -1,5 +1,7 @@
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 
 {% for request_builder in request_builders %}
 from ._request_builders import {{ request_builder.name }}

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

@@ -1,7 +1,9 @@
 # coding=utf-8
 {% set aad_token = "DefaultAzureCredential" %}
 {% set azure_key = "AzureKeyCredential" %}
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 
 {{ imports }}
 """

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

@@ -1,28 +1,7 @@
-# --------------------------------------------------------------------------
-#
-# Copyright (c) {{ code_model.options["company_name"] }} Corporation. All rights reserved.
-#
-# The MIT License (MIT)
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the ""Software""), to
-# deal in the Software without restriction, including without limitation the
-# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-# sell copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-#
-# --------------------------------------------------------------------------
+# coding=utf-8
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 
 # pyright: reportUnnecessaryTypeIgnoreComment=false
 

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

@@ -3,7 +3,9 @@
 {% 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'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 import pytest
 {{ imports }}
 

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

@@ -1,5 +1,7 @@
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 {{ imports }}
 
 {% for test_name in test_names %}

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

@@ -1,5 +1,7 @@
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 
 {{ imports }}
 {% for nu in code_model.named_unions %}

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

@@ -1,4 +1,6 @@
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 import functools
 
 def api_version_validation(**kwargs):

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

@@ -1,5 +1,7 @@
 {% import 'keywords.jinja2' as keywords with context %}
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 
 {{ imports }}
 

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

@@ -1,4 +1,6 @@
 # coding=utf-8
-{{ code_model.options['license_header'] }}
+{% if code_model.license_header %}
+{{ code_model.license_header }}
+{% endif %}
 
 VERSION = "{{ code_model.options['package_version'] }}"

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

@@ -19,9 +19,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: black==24.8.0
 Requires-Dist: docutils>=0.20.1
-Requires-Dist: Jinja2==3.1.3
+Requires-Dist: Jinja2==3.1.6
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: tomli==2.0.1
-Requires-Dist: setuptools==69.5.1
+Requires-Dist: setuptools==70.0.0
 
 # Core Library for Python Generation

package/generator/pygen.egg-info/requires.txt

@@ -1,6 +1,6 @@
 black==24.8.0
 docutils>=0.20.1
-Jinja2==3.1.3
+Jinja2==3.1.6
 PyYAML==6.0.1
 tomli==2.0.1
-setuptools==69.5.1
+setuptools==70.0.0

package/generator/setup.py

@@ -50,9 +50,9 @@ setup(
     install_requires=[
         "black==24.8.0",
         "docutils>=0.20.1",
-        "Jinja2==3.1.3",
+        "Jinja2==3.1.6",
         "PyYAML==6.0.1",
         "tomli==2.0.1",
-        "setuptools==69.5.1",
+        "setuptools==70.0.0",
     ],
 )

package/generator/test/azure/mock_api_tests/asynctests/test_azure_core_lro_rpc_async.py

@@ -4,8 +4,8 @@
 # license information.
 # --------------------------------------------------------------------------
 import pytest
-from azurecore.lro.rpc.aio import RpcClient
-from azurecore.lro.rpc import models
+from specs.azure.core.lro.rpc.aio import RpcClient
+from specs.azure.core.lro.rpc import models
 
 
 @pytest.fixture

package/generator/test/azure/mock_api_tests/test_azure_core_lro_rpc.py

@@ -4,7 +4,7 @@
 # license information.
 # --------------------------------------------------------------------------
 import pytest
-from azurecore.lro.rpc import RpcClient, models
+from specs.azure.core.lro.rpc import RpcClient, models
 
 
 @pytest.fixture

package/generator/test/azure/requirements.txt

@@ -9,7 +9,7 @@ azure-mgmt-core==1.3.2
 -e ./generated/azure-client-generator-core-flatten-property
 -e ./generated/azure-core-basic
 -e ./generated/azure-core-scalar
--e ./generated/azurecore-lro-rpc
+-e ./generated/azure-core-lro-rpc
 -e ./generated/azure-core-lro-standard
 -e ./generated/azure-core-model
 -e ./generated/azure-core-traits
@@ -46,6 +46,7 @@ azure-mgmt-core==1.3.2
 -e ./generated/server-versions-versioned
 -e ./generated/server-versions-not-versioned
 -e ./generated/special-words
+-e ./generated/streaming-jsonl
 -e ./generated/typetest-array
 -e ./generated/typetest-dictionary
 -e ./generated/typetest-enum-extensible

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

@@ -0,0 +1,27 @@
+# -------------------------------------------------------------------------
+# 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 streaming.jsonl.aio import JsonlClient
+
+
+@pytest.fixture
+async def client():
+    async with JsonlClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+JSONL = b'{"desc": "one"}\n{"desc": "two"}\n{"desc": "three"}'
+
+
+@pytest.mark.asyncio
+async def test_basic_send(client: JsonlClient):
+    await client.basic.send(JSONL)
+
+
+@pytest.mark.asyncio
+async def test_basic_recv(client: JsonlClient):
+    assert b"".join([d async for d in (await client.basic.receive())]) == JSONL

package/generator/test/generic_mock_api_tests/test_streaming_jsonl.py

@@ -0,0 +1,25 @@
+# -------------------------------------------------------------------------
+# 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 streaming.jsonl import JsonlClient
+
+
+@pytest.fixture
+def client():
+    with JsonlClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+JSONL = b'{"desc": "one"}\n{"desc": "two"}\n{"desc": "three"}'
+
+
+def test_basic_send(client: JsonlClient):
+    client.basic.send(JSONL)
+
+
+def test_basic_recv(client: JsonlClient):
+    assert b"".join(client.basic.receive()) == JSONL

package/generator/test/unbranded/requirements.txt

@@ -18,6 +18,7 @@
 -e ./generated/server-versions-versioned
 -e ./generated/server-versions-not-versioned
 -e ./generated/special-words
+-e ./generated/streaming-jsonl
 -e ./generated/typetest-array
 -e ./generated/typetest-dictionary
 -e ./generated/typetest-enum-extensible

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.8.1",
+  "version": "0.8.3-dev.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -26,7 +26,7 @@
     }
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "clean": "rimraf ./dist ./temp ./emitter/temp ./generator/test/azure/generated ./generator/test/unbranded/generated ./venv",
@@ -43,7 +43,8 @@
     "test:generator": "tsx ./eng/scripts/ci/run-ci.ts --command=test",
     "test:emitter": "vitest run -c ./emitter/vitest.config.ts",
     "change:version": "pnpm chronus version --ignore-policies --only @typespec/http-client-python",
-    "change:add": "pnpm chronus add"
+    "change:add": "pnpm chronus add",
+    "regen-docs": "node ../../packages/tspd/cmd/tspd.js doc . --enable-experimental --output-dir ../../website/src/content/docs/docs/emitters/clients/http-client-python/reference --skip-js"
   },
   "files": [
     "dist/**",
@@ -57,12 +58,15 @@
     "@azure-tools/typespec-azure-core": ">=0.53.0 <1.0.0",
     "@azure-tools/typespec-azure-resource-manager": ">=0.53.0 <1.0.0",
     "@azure-tools/typespec-azure-rulesets": ">=0.53.0 <3.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.53.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.53.1 <1.0.0",
     "@typespec/compiler": ">=0.67.0 <1.0.0",
     "@typespec/http": ">=0.67.0 <1.0.0",
     "@typespec/openapi": ">=0.67.0 <1.0.0",
     "@typespec/rest": ">=0.67.0 <1.0.0",
-    "@typespec/versioning": ">=0.67.0 <1.0.0"
+    "@typespec/versioning": ">=0.67.0 <1.0.0",
+    "@typespec/events": ">=0.67.0 <1.0.0",
+    "@typespec/sse": ">=0.67.0 <1.0.0",
+    "@typespec/streams": ">=0.67.0 <1.0.0"
   },
   "dependencies": {
     "js-yaml": "~4.1.0",
@@ -77,7 +81,7 @@
     "@azure-tools/typespec-azure-core": "~0.53.0",
     "@azure-tools/typespec-azure-resource-manager": "~0.53.0",
     "@azure-tools/typespec-azure-rulesets": "~0.53.0",
-    "@azure-tools/typespec-client-generator-core": "~0.53.0",
+    "@azure-tools/typespec-client-generator-core": "~0.53.1",
     "@types/js-yaml": "~4.0.5",
     "@types/node": "~22.5.4",
     "@types/semver": "7.5.8",
@@ -87,6 +91,9 @@
     "@typespec/openapi": "~0.67.0",
     "@typespec/rest": "~0.67.0",
     "@typespec/versioning": "~0.67.0",
+    "@typespec/events": "~0.67.0",
+    "@typespec/sse": "~0.67.0",
+    "@typespec/streams": "~0.67.0",
     "c8": "^10.1.3",
     "chalk": "5.3.0",
     "rimraf": "~6.0.1",