python / python/cpython

Need more info regarding cells and closures.

未關閉
#98,176 1 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
36k
PR 合併指標
PR 指標待擷取

描述

Cell variable

Since "free variable" is defined in 4.2.1. Binding of names, I suggest also defining a "cell variable", as any local variable whose name is resolved to that scope in some enclosed scope.
Also, the term "free variable" is used elsewhere in the docs, where it means that the variable is resolved in an enclosing function scope, and does not include if the variable is resolved in the module scope.

exec(..., closure=...)

The closure argument specifies a closure–a tuple of cellvars. It’s only valid when the object is a code object containing free variables. The length of the tuple must exactly match the number of free variables referenced by the code object.

  1. Use the name 'func' to refer to the function involved. func.__code__ is the object given to exec().
  2. Instead of 'cellvars', say 'bindings for free variables in 'func'.' Refer to new 'Cell objects' section of the Type Hierarchy.
  3. The bindings are in the same order as the names of the free variables found in code.co_freevars.
  4. The bindings can be found in func.__closure.
  5. func.__closure__ reflects values of the free variables at the time exec is called, which may have changed since func was created.
  6. Bindings in closure can be modified by the code if the variable names are declared nonlocal in func. If 'closure' is func.__closure__, then the 'func' free variables will have changed.
  7. Refer to new 'Cell Objects' section in the Type Hierarchy for details.

Type Hierarchy

Add a section for 'Cell Objects' under 'Internal types'.

  • The name of the class is 'cell', and the class is available in types.CellType.
  • It represents the binding of a free or cell variable.
  • It may have a current value (any Python object), or it may be empty.
  • cell() is an empty cell. cell(obj) is a cell with obj as its current value.
  • cell.cell_contents is a writable attribute returning the current value, if any, or raising ValueError if empty. It may be assigned a new value or deleted (without raising an exception if already empty).
  • Cells may be compared by their values. Empty cells compare < non-empty cells.

Mention that Frame objects have class 'frame', which is types.FrameType. There is no explicit constructor.

User-defined functions section:

  • Add an id=user-defined-functions tag to the HTML so that it can be linked to as a fragment.
  • Under closure, refer to the new 'Cell objects' section, instead of the later paragraph about cells.

inspect.getmembers

Add entry for 'closure' under 'function'. Use same text as above in the user-defined functions section.

Entry for 'co_cellvars' under 'code', should read 'contained scopes' instead of 'containing scopes'. And it is only for names in 'co_varnames'.

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

從連結的 exec(closure=...)、Type Hierarchy、使用者自訂函式和 inspect.getmembers 文件章節開始。在更新所要求的術語和交叉參照之前,檢查自由變數、單元變數、閉包和框架的現有定義;當受影響的章節一致地描述所要求的單元和閉包行為時,即表示完成。

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

評估

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

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

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