@typespec/http-client-python 0.1.0

package/generator/test/unbranded/mock_api_tests/asynctests/test_unbranded_async.py

@@ -0,0 +1,24 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+import traceback
+import pytest
+from typetest.scalar.aio import ScalarClient
+from corehttp.exceptions import HttpResponseError
+
+
+@pytest.fixture
+async def client():
+    async with ScalarClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_track_back(client: ScalarClient):
+    try:
+        await client.string.put("to raise exception")
+    except HttpResponseError:
+        track_back = traceback.format_exc().lower()
+        assert "azure" not in track_back
+        assert "microsoft" not in track_back

package/generator/test/unbranded/mock_api_tests/cadl-ranch-config.yaml

@@ -0,0 +1,27 @@
+unsupportedScenarios: Azure_ClientGenerator_Core_Access_InternalOperation
+  Azure_ClientGenerator_Core_Access_PublicOperation
+  Azure_ClientGenerator_Core_Access_RelativeModelInOperation
+  Azure_ClientGenerator_Core_Access_SharedModelInOperation
+  Azure_ClientGenerator_Core_Usage_ModelInOperation
+  Azure_Core_Basic_createOrReplace
+  Azure_Core_Basic_createOrUpdate
+  Azure_Core_Basic_delete
+  Azure_Core_Basic_export
+  Azure_Core_Basic_get
+  Azure_Core_Basic_list
+  Azure_Core_Basic_listWithCustomPageModel
+  Azure_Core_Basic_listWithPage
+  Azure_Core_Basic_listWithParameters
+  Azure_Core_Basic_TwoModelsAsPageItem
+  Azure_Core_Lro_Rpc_longRunningRpc
+  Azure_Core_Lro_Standard_createOrReplace
+  Azure_Core_Lro_Standard_delete
+  Azure_Core_Lro_Standard_export
+  Azure_Core_Scalar_AzureLocationScalar_get
+  Azure_Core_Scalar_AzureLocationScalar_header
+  Azure_Core_Scalar_AzureLocationScalar_post
+  Azure_Core_Scalar_AzureLocationScalar_put
+  Azure_Core_Scalar_AzureLocationScalar_query
+  Azure_Core_Traits_repeatableAction
+  Azure_Core_Traits_smokeTest
+  Azure_SpecialHeaders_XmsClientRequestId

package/generator/test/unbranded/mock_api_tests/conftest.py

@@ -0,0 +1,35 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import os
+import subprocess
+import signal
+import pytest
+import re
+from pathlib import Path
+
+
+def start_server_process():
+    path = Path(os.path.dirname(__file__)) / Path("../../../../node_modules/@azure-tools/cadl-ranch-specs")
+    os.chdir(path.resolve())
+    cmd = "cadl-ranch serve ./http"
+    if os.name == "nt":
+        return subprocess.Popen(cmd, shell=True)
+    return subprocess.Popen(cmd, shell=True, preexec_fn=os.setsid)
+
+
+def terminate_server_process(process):
+    if os.name == "nt":
+        process.kill()
+    else:
+        os.killpg(os.getpgid(process.pid), signal.SIGTERM)  # Send the signal to all the process groups
+
+
+@pytest.fixture(scope="session", autouse=True)
+def testserver():
+    """Start cadl ranch mock api tests"""
+    server = start_server_process()
+    yield
+    terminate_server_process(server)

package/generator/test/unbranded/mock_api_tests/test_unbranded.py

@@ -0,0 +1,57 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+import os
+import re
+from subprocess import getoutput
+from pathlib import Path
+import traceback
+from importlib import import_module
+import pytest
+from typetest.scalar import ScalarClient
+from corehttp.exceptions import HttpResponseError
+
+
+@pytest.fixture
+def client():
+    with ScalarClient() as client:
+        yield client
+
+
+def test_module():
+    with pytest.raises(ModuleNotFoundError):
+        import_module("azure")
+
+
+def test_track_back(client: ScalarClient):
+    try:
+        client.string.put("to raise exception")
+    except HttpResponseError:
+        track_back = traceback.format_exc().lower()
+        assert "azure" not in track_back
+        assert "microsoft" not in track_back
+
+
+def check_sensitive_word(folder: Path, word: str) -> str:
+    special_folders = ["__pycache__", "pytest_cache"]
+    if os.name == "nt":
+        skip_folders = "|".join(special_folders)
+        output = getoutput(
+            f"powershell \"ls -r -Path {folder} | where fullname -notmatch '{skip_folders}' | Select-String -Pattern '{word}'\""
+        ).replace("\\", "/")
+    else:
+        skip_folders = "{" + ",".join(special_folders) + "}"
+        output = getoutput(f"grep -ri --exclude-dir={skip_folders} {word} {folder}")
+
+    result = set()
+    for item in re.findall(f"{folder.as_posix()}[^:]+", output.replace("\n", "")):
+        result.add(Path(item).relative_to(folder).parts[0])
+    return sorted(list(result))
+
+
+def test_sensitive_word():
+    check_folder = (Path(os.path.dirname(__file__)) / "../generated").resolve()
+    assert [] == check_sensitive_word(check_folder, "azure")
+    # after update cadl-ranch, it shall also equal to []
+    assert ["authentication-oauth2", "authentication-union"] == check_sensitive_word(check_folder, "microsoft")

package/generator/test/unbranded/requirements.txt

@@ -0,0 +1,72 @@
+aiohttp;python_full_version>="3.5.2"
+requests==2.32.2
+pytest
+pytest-asyncio==0.14.0;python_full_version>="3.5.2"
+pyright==1.1.379
+pylint==3.2.7
+tox==4.18.1
+mypy==1.10.1
+
+
+# common test case
+-e ./generated/authentication-api-key
+-e ./generated/authentication-http-custom
+-e ./generated/authentication-oauth2
+-e ./generated/authentication-union
+-e ./generated/client-naming
+-e ./generated/encode-duration
+-e ./generated/encode-numeric
+-e ./generated/parameters-basic
+-e ./generated/parameters-collection-format
+-e ./generated/parameters-spread
+-e ./generated/resiliency-srv-driven1
+-e ./generated/resiliency-srv-driven2
+-e ./generated/serialization-encoded-name-json
+-e ./generated/server-endpoint-not-defined
+-e ./generated/server-path-multiple
+-e ./generated/server-path-single
+-e ./generated/server-versions-versioned
+-e ./generated/server-versions-not-versioned
+-e ./generated/special-words
+-e ./generated/typetest-array
+-e ./generated/typetest-dictionary
+-e ./generated/typetest-enum-extensible
+-e ./generated/typetest-enum-fixed
+-e ./generated/typetest-model-enumdiscriminator
+-e ./generated/typetest-model-nesteddiscriminator
+-e ./generated/typetest-model-notdiscriminated
+-e ./generated/typetest-model-singlediscriminator
+-e ./generated/typetest-model-recursive
+-e ./generated/typetest-model-usage
+-e ./generated/typetest-model-visibility
+-e ./generated/typetest-property-nullable
+-e ./generated/typetest-property-optional
+-e ./generated/typetest-property-valuetypes
+-e ./generated/typetest-property-additionalproperties
+-e ./generated/typetest-scalar
+-e ./generated/typetest-union
+-e ./generated/typetest-model-empty
+-e ./generated/headasbooleantrue
+-e ./generated/headasbooleanfalse
+-e ./generated/parameters-body-optionality
+-e ./generated/special-headers-repeatability
+-e ./generated/special-headers-conditional-request
+-e ./generated/encode-datetime
+-e ./generated/encode-bytes
+-e ./generated/client-structure-default
+-e ./generated/client-structure-multiclient
+-e ./generated/client-structure-renamedoperation
+-e ./generated/client-structure-twooperationgroup
+-e ./generated/payload-content-negotiation
+-e ./generated/payload-json-merge-patch
+-e ./generated/payload-pageable
+-e ./generated/payload-multipart
+-e ./generated/payload-media-type
+-e ./generated/payload-xml
+-e ./generated/routes
+-e ./generated/versioning-added
+-e ./generated/versioning-madeoptional
+-e ./generated/versioning-removed
+-e ./generated/versioning-renamedfrom
+-e ./generated/versioning-returntypechangedfrom
+-e ./generated/versioning-typechangedfrom

package/generator/test/unbranded/tox.ini

@@ -0,0 +1,56 @@
+[tox]
+envlist=base, lint, mypy, pyright, apiview
+skipsdist=True
+
+[testenv:ci]
+deps=
+    -r requirements.txt
+commands =
+    # pytest
+    pytest mock_api_tests ../generic_mock_api_tests
+
+    # pylint
+    pip install azure-pylint-guidelines-checker==0.4.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    python ../../../eng/scripts/ci/run_pylint.py -t unbranded -s "generated" {posargs}
+
+    # mypy
+    python ../../../eng/scripts/ci/run_mypy.py -t unbranded -s "generated" {posargs}
+
+    # pyright
+    python ../../../eng/scripts/ci/run_pyright.py -t unbranded -s "generated" {posargs}
+
+    # apiview
+    ; pip install apiview-stub-generator==0.3.12 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    ; python ../../../eng/scripts/ci/run_apiview.py -t unbranded -s "generated" {posargs}
+
+[testenv:test]
+deps=
+    -r requirements.txt
+commands =
+    pytest mock_api_tests ../generic_mock_api_tests
+
+[testenv:lint]
+deps=
+    -r requirements.txt
+commands =
+    pip install azure-pylint-guidelines-checker==0.4.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    python ../../../eng/scripts/ci/run_pylint.py -t unbranded -s "generated" {posargs}
+
+[testenv:mypy]
+deps=
+    -r requirements.txt
+commands =
+    python ../../../eng/scripts/ci/run_mypy.py -t unbranded -s "generated" {posargs}
+
+[testenv:pyright]
+deps=
+    -r requirements.txt
+commands =
+    python ../../../eng/scripts/ci/run_pyright.py -t unbranded -s "generated" {posargs}
+
+[testenv:apiview]
+deps=
+    -r requirements.txt
+commands =
+    pip install apiview-stub-generator==0.3.12 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    python ../../../eng/scripts/ci/run_apiview.py -t unbranded -s "generated" {posargs}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@typespec/http-client-python",
+  "version": "0.1.0",
+  "author": "Microsoft Corporation",
+  "description": "TypeSpec emitter for Python SDKs",
+  "homepage": "https://typespec.io",
+  "readme": "https://github.com/microsoft/typespec/blob/main/packages/http-client-python/README.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/typespec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/microsoft/typespec/issues"
+  },
+  "keywords": [
+    "typespec",
+    "python"
+  ],
+  "type": "module",
+  "main": "dist/emitter/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/emitter/index.d.ts",
+      "default": "./dist/emitter/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist ./temp ./**/test/**/generated/ ./venv",
+    "build": "tsc -p ./emitter/tsconfig.build.json",
+    "watch": "tsc -p ./emitter/tsconfig.build.json --watch",
+    "lint": "eslint . --max-warnings=0",
+    "lint:py": "tsx ./eng/scripts/ci/lint.ts --folderName generator",
+    "format": "pnpm -w format:dir packages/http-client-python && tsx ./eng/scripts/ci/format.ts",
+    "install": "tsx ./eng/scripts/setup/run-python3.ts ./eng/scripts/setup/install.py",
+    "prepare": "tsx ./eng/scripts/setup/run-python3.ts ./eng/scripts/setup/prepare.py",
+    "regenerate": "tsx ./eng/scripts/ci/regenerate.ts",
+    "ci": "npm run test:emitter && npm run ci:generator --",
+    "ci:generator": "tsx ./eng/scripts/ci/run-ci.ts",
+    "test:generator": "tsx ./eng/scripts/ci/run-ci.ts --command=test",
+    "test:emitter": "vitest run -c ./emitter/vitest.config.ts"
+  },
+  "files": [
+    "dist/**",
+    "!dist/test/**",
+    "generator/**",
+    "eng/scripts/**",
+    "emitter"
+  ],
+  "peerDependencies": {
+    "@azure-tools/typespec-azure-core": ">=0.46.0 <1.0.0",
+    "@azure-tools/typespec-azure-resource-manager": ">=0.46.0 <1.0.0",
+    "@azure-tools/typespec-autorest": ">=0.46.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.46.1 <1.0.0",
+    "@azure-tools/typespec-azure-rulesets": ">=0.46.0 <3.0.0",
+    "@typespec/compiler": ">=0.60.0 <1.0.0",
+    "@typespec/http": ">=0.60.0 <1.0.0",
+    "@typespec/rest": ">=0.60.0 <1.0.0",
+    "@typespec/versioning": ">=0.60.0 <1.0.0",
+    "@typespec/openapi": ">=0.60.0 <1.0.0"
+  },
+  "dependencies": {
+    "js-yaml": "~4.1.0",
+    "semver": "~7.6.2"
+  },
+  "devDependencies": {
+    "@azure-tools/typespec-azure-resource-manager": "~0.46.0",
+    "@azure-tools/typespec-autorest": "~0.46.0",
+    "@azure-tools/cadl-ranch-expect": "0.15.4",
+    "@azure-tools/cadl-ranch-specs": "0.37.2",
+    "@types/js-yaml": "~4.0.5",
+    "@types/node": "~22.5.4",
+    "@types/semver": "7.5.8",
+    "@typespec/openapi": "~0.60.0",
+    "c8": "^10.1.2",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.6.2",
+    "typescript-eslint": "^8.5.0",
+    "@azure-tools/typespec-azure-core": "~0.46.0",
+    "@azure-tools/typespec-client-generator-core": "0.46.1",
+    "@typespec/compiler": "~0.60.0",
+    "@typespec/http": "~0.60.0",
+    "@typespec/rest": "~0.60.0",
+    "@typespec/versioning": "~0.60.0",
+    "@azure-tools/typespec-azure-rulesets": "0.46.0",
+    "chalk": "5.3.0",
+    "vitest": "^2.1.0",
+    "tsx": "4.17.0"
+  }
+}