Improve SyntaxError message for inconsistent name binding in OR-patterns
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 35.9k
- PR 合併指標
- PR 指標待擷取
描述
Feature or enhancement
Proposal:
Title
compiler: improve SyntaxError message for inconsistent name binding in OR-patterns
Summary
When using structural pattern matching (PEP 634), all alternatives of an OR-pattern (|) are required to bind the same set of names.
Currently, if this rule is violated, CPython raises a SyntaxError with the message:
SyntaxError: alternative patterns bind different names
While technically correct, this message does not indicate which names differ or how the bindings are inconsistent.
This issue proposes enhancing the diagnostic to explicitly report the mismatched bindings.
Reproducer
match value:
case 1 | x:
pass
Output:
SyntaxError: alternative patterns bind different names
The message does not clarify:
- Which variable(s) are inconsistently bound
- Which alternative introduces additional bindings
- What the required constraint is
Expected Behavior
The error message should clearly indicate the binding mismatch. For example:
SyntaxError: OR-pattern alternatives must bind the same names;
left alternative binds no names, right alternative binds {'x'}
or:
SyntaxError: inconsistent variable binding in OR-pattern: 'x' is not bound in all alternatives
The exact wording can be adjusted, but the diagnostic should identify the differing name(s).
Rationale
PEP 634 specifies that all OR-pattern alternatives must bind identical sets of names.
Providing more detailed diagnostics would:
- Improve developer experience
- Make the rule easier to understand
- Align with recent improvements in CPython error reporting
- Maintain consistency with Python’s philosophy of helpful error messages
Scope
- No syntax changes
- No semantic changes
- No AST changes
- Diagnostic enhancement only
Implementation Notes
The relevant validation logic appears to occur during semantic analysis of pattern matching (likely in Python/ast.c or related compiler validation code).
The change would involve augmenting the existing name-set comparison logic to include information about the differing bindings in the raised SyntaxError.
Backward Compatibility
This change affects only the wording of an error message and does not alter runtime behavior.
Tests
Regression tests can be added to Lib/test/test_patma.py to assert that the improved diagnostic includes information about mismatched variable names.
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
No response
Linked PRs
- gh-145939
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先檢視已連結的 PR #145939,接著檢查 Python/ast.c 中的 OR-patterns 驗證邏輯和相關的編譯器程式碼。執行 Lib/test/test_patma.py 中相關的 pattern-matching 測試。完成的標準是回歸測試涵蓋能驗證不一致的 bindings 會識別出不相符的名稱,同時不改變語法或執行期行為。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- compilers
- Issue 類型
- 功能
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100