Improve error messages for invalid `shelve` datum
オープン
まだ誰も着手していません。
extension-modules
type-feature
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Feature or enhancement
Proposal:
In https://github.com/python/cpython/issues/137829, I got confused because of the following:
import shelve
import dbm.gnu
db = dbm.gnu.open("myshelf", "c")
db.close()
def serializer(obj, protocol=None):
pass
def deserializer(data):
return data.decode("utf-8")
with shelve.open("myshelf", serializer=serializer, deserializer=deserializer) as s:
s["foo"] = "bar"
The traceback is
Traceback (most recent call last):
File "/home/arf/Desktop/source-codes/cpython/repro.py", line 17, in <module>
s["foo"] = "bar"
~^^^^^^^
File "/home/arf/Desktop/source-codes/cpython/Lib/shelve.py", line 138, in __setitem__
self.dict[key.encode(self.keyencoding)] = serialized_value
~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: gdbm mappings have bytes or string indices only
I got confused because I thought that the issue stemmed from the key (because of the word "indices") but the error is raised due to the serialized_value type as serializer returns None. IOW, s["foo"] = "bar" above is equivalent to s["foo"] = None. I suggest:
- changing the error message when the value type is incorrect (namely, don't talk about "indices"). Ideally, we should use "key" and "value" to distinguish the messages.
- add some "must be [...], not [...]" with the input type.
cc @furkanonder
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-138768
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Lib/shelve.py の138行目から始め、提供された shelve/dbm.gnu の例を再現して、無効なシリアライズ済み値がなぜ誤解を招くエラーを生成するのかを追跡します。報告される文言を更新してキーと値を区別し、受け取った型を含めます。例が無効な値を明確に特定できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- databases
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 25/100