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 摘要。