Make the capability of getting the source of interactive code public
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 36k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
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:
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với PR #117500 và xem xét cơ chế hiện có để đăng ký và truy xuất mã nguồn tương tác. So sánh các interface getlines/_getline_from_code được đề xuất và xem xét cách inspect và pdb sẽ sử dụng chúng. Công việc được xem là hoàn tất khi đã chọn interface và chính sách về tính công khai, ghi chép tài liệu cho tính năng nếu phù hợp, đồng thời xác định hành vi dự kiến của pdb.run() hoặc hành vi debug.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- devtools
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100