python / python/cpython

Make the capability of getting the source of interactive code public

オープン
#133,853 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

stdlib type-feature
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

Feature or enhancement

Proposal:

In #117500, we create a nice mechanism to register and retrieve the source code of an arbitrary code object. It was a bug fix so we want to keep it as private as possible - it was for PyREPL usage only. However, we did put effort into the design so it can be used in a wider range in the future, and now is the future!

We just passed beta freeze so we have enough time to make it a new feature. The code and mechanism is really simple, it's just about documentation (and whether we want to merge some interfaces).

There are two orthogonal areas I want to bring into discussion, for each I have two proposals:

  1. How do we want the interface
    • Keep it as it is, meaning the user needs to explicitly register and retrieve source code from a complete separate pair of interfaces.
    • Combine getlines and _getline_from_code, making code an optional argument to getlines - take the path when the optional code object is passed in.
  2. How public do we want it to be
    • Make it public to all users.
    • Make it public internally so at least inspect and pdb can use it. (we don't document it, but we keep inspect.getsourcelines work)

In either combination, we have the full backwards compatibility - nothing will be broken. It's more about how much maintenance effort we want to put in and how easy we want the user to use the feature.

An obvious example usage is that, if you want to debug some interactive code, either through pdb.run(), or debug command in pdb. You don't have the source code symbols now, even though it's fully available. With this capability, we can make pdb.run() work nicely with string source code.

cc: @pablogsal

Has this already been discussed elsewhere?

No response given

Links to previous discussion of this feature:

https://github.com/python/cpython/pull/117500

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

PR #117500 から始め、対話的なソースコードを登録・取得する既存の仕組みを確認してください。提案されている getlines/_getline_from_code インターフェースを比較し、inspect と pdb がそれらをどのように利用するかを検討してください。インターフェースと公開範囲の方針を決定し、必要に応じて機能を文書化し、pdb.run() またはデバッグ時の期待される動作を定義できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
devtools
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。