Azure / Azure/azure-sdk-tools

[Python APIView] Constructor parameter 'type' is not rendered with its Literal type annotation

Open
#14,328 0 comments 0 reactions 0 assignees View on GitHub
APIView customer-reported Python question
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

**Bad code snippet:**
```python
def __init__(
```
The APIView parser fails to render the 'type' parameter with its declared Literal type annotation in the SASCredentials constructor. This misrepresents the intended type safety and usage.

**Expected behavior:**
The 'type' parameter should be rendered as:
```python
def __init__(self, *, type: Literal[CredentialType.SAS]) -> None
```
This ensures the correct type annotation is visible and accurately reflects the code's intent.

Contributor guide

Open the contributing guide

Research direction

Start by locating the Python APIView parser handling the SASCredentials constructor and its `type` parameter. Compare the rendered signature with the declared `Literal[CredentialType.SAS]` annotation; done means the output shows `def __init__(self, *, type: Literal[CredentialType.SAS]) -> None`.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.