[Python] fix bad indent in docstring

.chronus/changes/auto-microsoft-python-fix-docstring-2025-10-4-17-37-33.md

@@ -0,0 +1,8 @@
+---
+changeKind: fix
+packages:
+  - "@autorest/python"
+  - "@azure-tools/typespec-python"
+---
+
+Fix bad indent

packages/autorest.python/package.json

@@ -29,7 +29,7 @@
   },
   "homepage": "https://github.com/Azure/autorest.python/blob/main/README.md",
   "dependencies": {
-    "@typespec/http-client-python": "~0.20.2",
+    "@typespec/http-client-python": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNTUzMTYyOS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX3B5dGhvbg2/content?format=file&subPath=%2Fpackages%2Ftypespec-http-client-python-0.20.2.tgz",
     "@autorest/system-requirements": "~1.0.2",
     "fs-extra": "~11.2.0",
     "tsx": "~4.19.1"
@@ -47,4 +47,4 @@
     "requirements.txt",
     "generator/"
   ]
-}
+}

packages/typespec-python/package.json

@@ -67,7 +67,7 @@
     "js-yaml": "~4.1.0",
     "semver": "~7.6.2",
     "tsx": "~4.19.1",
-    "@typespec/http-client-python": "~0.20.2",
+    "@typespec/http-client-python": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNTUzMTYyOS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX3B5dGhvbg2/content?format=file&subPath=%2Fpackages%2Ftypespec-http-client-python-0.20.2.tgz",
     "fs-extra": "~11.2.0"
   },
   "devDependencies": {
@@ -103,4 +103,4 @@
     "chalk": "5.3.0",
     "@types/fs-extra": "11.0.4"
   }
-}
+}

packages/typespec-python/scripts/eng/regenerate.ts

@@ -14,6 +14,8 @@ const exec = promisify(execCallback);
 const PLUGIN_DIR = resolve(fileURLToPath(import.meta.url), "../../../");
 const AZURE_HTTP_SPECS = resolve(PLUGIN_DIR, "node_modules/@azure-tools/azure-http-specs/specs");
 const HTTP_SPECS = resolve(PLUGIN_DIR, "node_modules/@typespec/http-specs/specs");
+// Local azure specs (used for testing scenarios that aren't in the published specs yet)
+const LOCAL_AZURE_SPECS = resolve(PLUGIN_DIR, "test/azure/specs");
 interface TspCommand {
     outputDir: string;
     command: string;
@@ -279,8 +281,25 @@ function toPosix(dir: string): string {
     return dir.replace(/\\/g, "/");
 }
 
+// Classify a spec path to determine its root directory (so relative() calculations stay stable)
+function classifySpec(spec: string): { specDir: string; isAzure: boolean } {
+    const posixSpec = toPosix(spec);
+    if (posixSpec.startsWith(toPosix(AZURE_HTTP_SPECS) + "/")) {
+        return { specDir: AZURE_HTTP_SPECS, isAzure: true };
+    }
+    if (posixSpec.startsWith(toPosix(LOCAL_AZURE_SPECS) + "/")) {
+        // Treat local azure specs the same as remote azure specs for options & naming.
+        return { specDir: LOCAL_AZURE_SPECS, isAzure: true };
+    }
+    if (posixSpec.startsWith(toPosix(HTTP_SPECS) + "/")) {
+        return { specDir: HTTP_SPECS, isAzure: false };
+    }
+    // Fallback: treat as non-azure and use HTTP_SPECS for relative calculations to avoid '..'
+    return { specDir: HTTP_SPECS, isAzure: false };
+}
+
 function getEmitterOption(spec: string, flavor: string): Record<string, string>[] {
-    const specDir = spec.includes("azure") ? AZURE_HTTP_SPECS : HTTP_SPECS;
+    const { specDir } = classifySpec(spec);
     const relativeSpec = toPosix(relative(specDir, spec));
     const key = relativeSpec.includes("resiliency/srv-driven/old.tsp") ? relativeSpec : dirname(relativeSpec);
     const emitter_options = EMITTER_OPTIONS[key] || (flavor === "azure" ? AZURE_EMITTER_OPTIONS[key] : [{}]) || [{}];
@@ -371,7 +390,7 @@ async function getSubdirectories(baseDir: string, flags: RegenerateFlags): Promi
 }
 
 function defaultPackageName(spec: string): string {
-    const specDir = spec.includes("azure") ? AZURE_HTTP_SPECS : HTTP_SPECS;
+    const { specDir } = classifySpec(spec);
     return toPosix(relative(specDir, dirname(spec)))
         .replace(/\//g, "-")
         .toLowerCase();
@@ -475,11 +494,12 @@ async function regenerate(flags: RegenerateFlagsInput): Promise<void> {
     } else {
         await preprocess(flags);
         const flagsResolved = { debug: false, flavor: flags.flavor, ...flags };
+        const subdirectoriesForLocalAzure = await getSubdirectories(LOCAL_AZURE_SPECS, flagsResolved).catch(() => []);
         const subdirectoriesForAzure = await getSubdirectories(AZURE_HTTP_SPECS, flagsResolved);
         const subdirectoriesForNonAzure = await getSubdirectories(HTTP_SPECS, flagsResolved);
         const subdirectories =
             flags.flavor === "azure"
-                ? [...subdirectoriesForAzure, ...subdirectoriesForNonAzure]
+                ? [...subdirectoriesForLocalAzure, ...subdirectoriesForAzure, ...subdirectoriesForNonAzure]
                 : subdirectoriesForNonAzure;
         const cmdList: TspCommand[] = subdirectories.flatMap((subdirectory) =>
             _getCmdList(subdirectory, flagsResolved),

packages/typespec-python/test/azure/generated/docstring/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release History
+
+## 1.0.0b1 (1970-01-01)
+
+### Other Changes
+
+  - Initial version

packages/typespec-python/test/azure/generated/docstring/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft 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.

packages/typespec-python/test/azure/generated/docstring/MANIFEST.in

@@ -0,0 +1,6 @@
+include *.md
+include LICENSE
+include azure/docstring/py.typed
+recursive-include tests *.py
+recursive-include samples *.py *.md
+include azure/__init__.py

packages/typespec-python/test/azure/generated/docstring/README.md

@@ -0,0 +1,43 @@
+# Azure Docstring client library for Python
+<!-- write necessary description of service -->
+
+## Getting started
+
+### Install the package
+
+```bash
+python -m pip install azure-docstring
+```
+
+#### 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 Azure Docstring instance.
+
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require
+you to agree to a Contributor License Agreement (CLA) declaring that you have
+the right to, and actually do, grant us the rights to use your contribution.
+For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether
+you need to provide a CLA and decorate the PR appropriately (e.g., label,
+comment). Simply follow the instructions provided by the bot. You will only
+need to do this once across all repos using our CLA.
+
+This project has adopted the
+[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
+see the Code of Conduct FAQ or contact opencode@microsoft.com with any
+additional questions or comments.
+
+<!-- LINKS -->
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
+[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
+[azure_identity_pip]: https://pypi.org/project/azure-identity/
+[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
+[pip]: https://pypi.org/project/pip/
+[azure_sub]: https://azure.microsoft.com/free/

packages/typespec-python/test/azure/generated/docstring/apiview-properties.json

@@ -0,0 +1,8 @@
+{
+    "CrossLanguagePackageId": "Azure.DocString",
+    "CrossLanguageDefinitionId": {
+        "azure.docstring.models.DocModel": "Azure.DocString.DocModel",
+        "azure.docstring.operations.DocStringOperations.get": "Azure.DocString.DocString.get",
+        "azure.docstring.aio.operations.DocStringOperations.get": "Azure.DocString.DocString.get"
+    }
+}

packages/typespec-python/test/azure/generated/docstring/azure/__init__.py

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

packages/typespec-python/test/azure/generated/docstring/azure/docstring/__init__.py

@@ -0,0 +1,32 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import DocStringClient  # type: ignore
+from ._version import VERSION
+
+__version__ = VERSION
+
+try:
+    from ._patch import __all__ as _patch_all
+    from ._patch import *
+except ImportError:
+    _patch_all = []
+from ._patch import patch_sdk as _patch_sdk
+
+__all__ = [
+    "DocStringClient",
+]
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
+
+_patch_sdk()

packages/typespec-python/test/azure/generated/docstring/azure/docstring/_client.py

@@ -0,0 +1,95 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from copy import deepcopy
+from typing import Any
+from typing_extensions import Self
+
+from azure.core import PipelineClient
+from azure.core.pipeline import policies
+from azure.core.rest import HttpRequest, HttpResponse
+
+from ._configuration import DocStringClientConfiguration
+from ._utils.serialization import Deserializer, Serializer
+from .operations import DocStringOperations
+
+
+class DocStringClient:  # pylint: disable=client-accepts-api-version-keyword
+    """DocStringClient.
+
+    :ivar doc_string: DocStringOperations operations
+    :vartype doc_string: azure.docstring.operations.DocStringOperations
+    :param endpoint: Service host. Required.
+    :type endpoint: str
+    """
+
+    def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
+        self, endpoint: str, **kwargs: Any
+    ) -> None:
+        _endpoint = "{endpoint}"
+        self._config = DocStringClientConfiguration(endpoint=endpoint, **kwargs)
+
+        _policies = kwargs.pop("policies", None)
+        if _policies is None:
+            _policies = [
+                policies.RequestIdPolicy(**kwargs),
+                self._config.headers_policy,
+                self._config.user_agent_policy,
+                self._config.proxy_policy,
+                policies.ContentDecodePolicy(**kwargs),
+                self._config.redirect_policy,
+                self._config.retry_policy,
+                self._config.authentication_policy,
+                self._config.custom_hook_policy,
+                self._config.logging_policy,
+                policies.DistributedTracingPolicy(**kwargs),
+                policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
+                self._config.http_logging_policy,
+            ]
+        self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
+
+        self._serialize = Serializer()
+        self._deserialize = Deserializer()
+        self._serialize.client_side_validation = False
+        self.doc_string = DocStringOperations(self._client, self._config, self._serialize, self._deserialize)
+
+    def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
+        """Runs the network request through the client's chained policies.
+
+        >>> from azure.core.rest import HttpRequest
+        >>> request = HttpRequest("GET", "https://www.example.org/")
+        <HttpRequest [GET], url: 'https://www.example.org/'>
+        >>> response = client.send_request(request)
+        <HttpResponse: 200 OK>
+
+        For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
+
+        :param request: The network request you want to make. Required.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.HttpResponse
+        """
+
+        request_copy = deepcopy(request)
+        path_format_arguments = {
+            "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
+        }
+
+        request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
+        return self._client.send_request(request_copy, stream=stream, **kwargs)  # type: ignore
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> Self:
+        self._client.__enter__()
+        return self
+
+    def __exit__(self, *exc_details: Any) -> None:
+        self._client.__exit__(*exc_details)

packages/typespec-python/test/azure/generated/docstring/azure/docstring/_configuration.py

@@ -0,0 +1,44 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from typing import Any
+
+from azure.core.pipeline import policies
+
+from ._version import VERSION
+
+
+class DocStringClientConfiguration:  # pylint: disable=too-many-instance-attributes
+    """Configuration for DocStringClient.
+
+    Note that all parameters used to create this instance are saved as instance
+    attributes.
+
+    :param endpoint: Service host. Required.
+    :type endpoint: str
+    """
+
+    def __init__(self, endpoint: str, **kwargs: Any) -> None:
+        if endpoint is None:
+            raise ValueError("Parameter 'endpoint' must not be None.")
+
+        self.endpoint = endpoint
+        kwargs.setdefault("sdk_moniker", "docstring/{}".format(VERSION))
+        self.polling_interval = kwargs.get("polling_interval", 30)
+        self._configure(**kwargs)
+
+    def _configure(self, **kwargs: Any) -> None:
+        self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
+        self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
+        self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
+        self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
+        self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs)
+        self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
+        self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
+        self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
+        self.authentication_policy = kwargs.get("authentication_policy")

packages/typespec-python/test/azure/generated/docstring/azure/docstring/_patch.py

@@ -0,0 +1,21 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------
+"""Customize generated code here.
+
+Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
+"""
+
+
+__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
+    """

packages/typespec-python/test/azure/generated/docstring/azure/docstring/_utils/__init__.py

@@ -0,0 +1,6 @@
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------