Skip to content

[python] Use wire names in TypedDict docstrings - #11371

Merged
l0lawrence merged 6 commits into
mainfrom
copilot/fix-typeddict-camelcase-docstrings
Jul 27, 2026
Merged

[python] Use wire names in TypedDict docstrings#11371
l0lawrence merged 6 commits into
mainfrom
copilot/fix-typeddict-camelcase-docstrings

Conversation

Copilot AI commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

TypedDict docstrings in generated types.py were documenting the snake_case client property name even when the emitted TypedDict key uses the camelCase wire name. This updates the generated docstrings to match the actual on-the-wire field names.

  • Generator change

    • Update TypedDict docstring generation to use prop.wire_name for types.py Sphinx entries (:ivar: / :vartype:).
    • Preserve existing behavior outside the types-file path, where model/client-facing docstrings still use prop.client_name.

  • Regression coverage

    • Add a focused unit test covering a property with:
      • wire name: paramName
      • client name: param_name
    • Assert that generated TypedDict docstrings reference paramName, matching the declared TypedDict field.

  • Example

    class Foo(TypedDict, total=False):
    """
    :ivar paramName:
    :vartype paramName: str
    """

    paramName: str

@azure-pipelines

azure-pipelines Bot commented Jul 23, 2026

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
1 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI linked an issue Jul 23, 2026 that may be closed by this pull request
[python] typeddict camelcase docstrings like on the wire instead of snakecase #11355
Closed
@l0lawrence
fix: use wire names in python TypedDict docstrings
b8388d7 
Co-authored-by: l0lawrence <100643745+l0lawrence@users.noreply.github.com>
@microsoft-github-policy-service microsoft-github-policy-service Bot added the emitter:client:python Issue for the Python client emitter: @typespec/http-client-python label Jul 23, 2026
@l0lawrence
chore: drop unrelated python lockfile diff
efd3546 
Co-authored-by: l0lawrence <100643745+l0lawrence@users.noreply.github.com>
Copilot AI changed the title [WIP] Update docstring to match camelCase in typeddict [python] Use wire names in TypedDict docstrings Jul 23, 2026
Copilot AI requested a review from l0lawrence July 23, 2026 15:55
@pkg-pr-new

pkg-pr-new Bot commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown

Open in StackBlitz

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

commit: 0adfc0f

@github-actions

github-actions Bot commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Python emitter diff

Baseline gh:4da8bc856581babb8cb705ed9a0199141dff296b vs this PR.

Diff summary: 61 file(s), +752 / -752

Rendered diff: inline on the run summary, or the emitter-diff-html artifact.

Informational check (eng/emitter-diff); does not block the PR.

@github-actions

github-actions Bot commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

All changed packages have been documented.

  • ✅ @typespec/http-client-python
Show changes

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

Use wire names in TypedDict docstrings

@l0lawrence
chore: add changelog entry for TypedDict wire names fix
e51d591 
Co-authored-by: l0lawrence <100643745+l0lawrence@users.noreply.github.com>
@l0lawrence
l0lawrence marked this pull request as ready for review July 24, 2026 20:12
@azure-sdk-automation

azure-sdk-automation Bot commented Jul 24, 2026

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@l0lawrence
l0lawrence added this pull request to the merge queue Jul 27, 2026
Merged via the queue into main with commit 229470f Jul 27, 2026
42 checks passed
@l0lawrence
l0lawrence deleted the copilot/fix-typeddict-camelcase-docstrings branch July 27, 2026 17:12
@l0lawrence l0lawrence mentioned this pull request Jul 30, 2026
Merged
timotheeguerin pushed a commit to timotheeguerin/typespec that referenced this pull request Jul 30, 2026
@l0lawrence
release of python emitter 0.35.1 (microsoft#11482)
db646c9 
Routine release of the `@typespec/http-client-python` emitter.

## Version bump

`0.35.0` → `0.35.1` (patch)

## Changelog entries being released

### Bug Fixes
- [microsoft#11371](microsoft#11371) Use wire
names in TypedDict docstrings
- [microsoft#11392](microsoft#11392) Fix the
generated `_validation.py` `@api_version_validation` decorator so it
reads the correct client config attribute for the API version (derived
from the API-version parameter's `client_name`) instead of hardcoding
`client._config.api_version`.
- [microsoft#11272](microsoft#11272) Fix
generated request builders serializing a `None` `content-type` header
for an operation with an optional body whose content-type is
required/constant. The `content-type` kwarg is now `Optional[str]` and
the header is omitted when `None`.

### Internal (no changelog entry)
- Track only hand-authored test fixture files instead of whole generated
packages, and clean generated test code with `git clean` during
regeneration.

Generated via `chronus version --only "@typespec/http-client-python"`;
only the http-client-python package is modified.

Copilot-Session: caac437e-a2b9-40bf-b219-0454afb02bbf
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@msyyc msyyc msyyc approved these changes
@l0lawrence l0lawrence Awaiting requested review from l0lawrence l0lawrence is a code owner
@iscai-msft iscai-msft Awaiting requested review from iscai-msft iscai-msft is a code owner
@tadelesh tadelesh Awaiting requested review from tadelesh tadelesh is a code owner
@timotheeguerin timotheeguerin Awaiting requested review from timotheeguerin timotheeguerin is a code owner
@lmazuel lmazuel Awaiting requested review from lmazuel lmazuel is a code owner
@catalinaperalta catalinaperalta Awaiting requested review from catalinaperalta catalinaperalta is a code owner
@ChenxiJiang333 ChenxiJiang333 Awaiting requested review from ChenxiJiang333 ChenxiJiang333 is a code owner
@kashifkhan kashifkhan Awaiting requested review from kashifkhan kashifkhan is a code owner

Assignees

@l0lawrence l0lawrence

Copilot code review Copilot

Labels

emitter:client:python Issue for the Python client emitter: @typespec/http-client-python

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[python] typeddict camelcase docstrings like on the wire instead of snakecase

3 participants

@msyyc @l0lawrence