python / python/cpython

Document dataclass field should not be reused

未關閉
#145,369 8 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs pending topic-dataclasses
主要語言
Python
星號
77.2k
分支
35.9k
PR 合併指標
PR 指標待擷取

描述

Documentation

The current implementation of dataclass modifies a field in place. Thereby, the following code will modify f:

from dataclasses import dataclass, field

f = field(kw_only=True)

@dataclass
class A:
    x: int = f
    y: int = f

print(f) # now f.name is filled
# furthermore, A is broken (or does not behave if we used two different field instance)

It can create issues when we have multiple fields that have the same spec and we reuse the same Field instance to set the same metadata to all of them. A class is created but it's garbage.

IMHO, in the docs, we should warn the user to NOT share any Field instance.

Linked PRs
  • gh-145373
  • gh-145387

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先查閱 dataclass 和 Field 文件以及連結的 PR gh-145373 和 gh-145387。新增明確警告,不要在 dataclass 欄位之間重複使用同一個 Field 實例;當文件中的指引處理了由此產生的變異和異常的類別行為時,將 issue 中的範例視為完整。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
1/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。