Make the capability of getting the source of interactive code public
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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:
- 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
getlinesand_getline_from_code, making code an optional argument togetlines- take the path when the optional code object is passed in.
- How public do we want it to be
- Make it public to all users.
- Make it public internally so at least
inspectandpdbcan use it. (we don't document it, but we keepinspect.getsourcelineswork)
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:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with PR #117500 and review the existing mechanism for registering and retrieving interactive source code. Compare the proposed getlines/_getline_from_code interfaces and consider how inspect and pdb would use them. Done means choosing the interface and publicness policy, documenting the feature if appropriate, and defining the expected pdb.run() or debug behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100