[python] Add test for client-doc spector scenario (Azure typespec-azure #4268)

[Copilot]

Adds python SDK mock_api coverage for the spector cases introduced in Azure/typespec-azure#4268. Of the two new scenarios under azure/client-generator-core/, only client-doc is generatable by the python emitter (response-as-bool is already in SKIP_SPECS).

Changes

• Tests — sync + async tests for the @clientDoc scenario:
  • harvest POST round-trip against the mock server.
  • @clientDoc append mode: Plant model docstring retains base doc and appends client-specific text.
  • @clientDoc replace mode: harvest operation docstring fully overrides the base doc.
  • Docstring assertions compare only the method/model description (extracted via split(":ivar")[0].strip() for the model and split(":param")[0].strip() for the operation), excluding the parameter docstrings.
• Changelog — internal chronus entry for @typespec/http-client-python.

response-as-bool is intentionally skipped in the emitter regeneration config, so no client is generated and no test is added for it.

def test_harvest(client: ClientDocClient):
    body = models.Plant(name="Rose", species="Rosa")
    assert client.documentation.harvest(body) == body

def test_model_doc_appended():
    # @clientDoc in append mode keeps the base @doc and appends the client-specific text.
    doc = models.Plant.__doc__.split(":ivar")[0].strip()
    assert doc == "A plant in the garden. This model is used to represent a plant in the client SDK."

def test_operation_doc_replaced(client: ClientDocClient):
    # @clientDoc in replace mode overrides the base @doc completely.
    doc = client.documentation.harvest.__doc__.split(":param")[0].strip()
    assert doc == "Retrieves a plant from the garden by submitting its name."

[msyyc]

@copilot resolve the merge conflicts in this pull request

[Copilot]

@copilot resolve the merge conflicts in this pull request

Resolved the merge conflicts with main. The only conflict was the version bump in packages/http-client-python/package-lock.json, which I aligned to 0.31.0 to match package.json. Merged in commit 3e6e6b8.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-python@10888

commit: af1b1fd

[github-actions]

All changed packages have been documented.

• ✅ @typespec/http-client-python

Show changes

@typespec/http-client-python - internal ✏️

Add test for the @clientDoc decorator spector case (azure/client-generator-core/client-doc).

[azure-sdk-automation]

You can try these changes here

🛝 Playground	🌐 Website	🛝 VSCode Extension