python / python/cpython

Clarify the diffrence between object.__sizeof__() and sys.getsizeof() in short documentation/help output

未关闭
#146,086 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Documentation
Problem

The short documentation shown by help()/pydoc makes object.__sizeof__() and sys.getsizeof() look almost equivalent, even though they may return different values in practice.

For example, their short descriptions currently read very similarly:

  • sys.getsizeof():

    Return the size of object in bytes.

  • object.__sizeof__():

    "Size of object in memory, in bytes."

From these short descriptions, a user can reasonably assume that both functions report the same value.

Why this is confusing

In practice, they can differ.

sys.getsizeof() may return a larger value than obj.__sizeof__(), because it is not just a direct alias for __sizeof__(). The full documentation for sys.getsizeof() explains the extra behavior, but that distinction is not obvious from the short help output.

This makes the following kind of session surprising:

import sys

class A:
    pass

obj = A()

print(obj.__sizeof__())
print(sys.getsizeof(obj))

A user who relies on help() or short docstrings may expect the first two values to match, but they may not.

Suggestion

It may be helpful to clarify this distinction in the short documentation, so that it is visible without referring to the full documentation.

In particular, it could clarify that:

  • sys.getsizeof() may include additional overhead beyond the value returned by __sizeof__()
Linked PRs
  • gh-146087

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先比较 sys.getsizeof() 和 object.sizeof() 的简短帮助或 pydoc 输出,然后查看相关的 PR gh-146087,了解已经在进行的工作。当简短描述明确区分 sys.getsizeof() 和 sizeof(),并说明可能包含额外开销时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。