[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

Change by Irit Katriel :


--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

Irit Katriel  added the comment:


New changeset 0b58e863df9970b290a4de90c67f9ac30c443817 by Irit Katriel in 
branch 'main':
bpo-45075: distinguish between frame and FrameSummary in traceback mo… 
(GH-28112)
https://github.com/python/cpython/commit/0b58e863df9970b290a4de90c67f9ac30c443817


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

Irit Katriel  added the comment:

Yes, frame_info is good.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Chris Jerdonek]

Chris Jerdonek  added the comment:

Or frame_info (more readable), since FrameSummary is proposed to be 
"Information about a single frame from a traceback."

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Chris Jerdonek]

Chris Jerdonek  added the comment:

I was suggesting keeping more similarity between FrameSummary and StackSummary 
in addition to differentiating frame from FrameSummary. Since stack is used for 
StackSummary, frame_sum is more similar than f_summary while still providing 
the differentiation.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

Irit Katriel  added the comment:

I'm not sure I follow. We don't have a similar issue with StackSummary - there 
is no interpreter type for "stack" that you can confuse it with.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Chris Jerdonek]

Chris Jerdonek  added the comment:

It might be good to have consistency with what will be used for StackSummary so 
two different approaches to naming aren't used.

By the way, frame_sum is another possibility since I see frame_gen being used.

--
nosy: +chris.jerdonek

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

Change by Irit Katriel :


--
keywords: +patch
pull_requests: +26553
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/28112

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

Irit Katriel  added the comment:

There are places where f is used for an arg or local variable which is a frame, 
so I'll try f_summary when it's a FrameSummary.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45075] confusion between frame and frame_summary in traceback module

[Irit Katriel]

New submission from Irit Katriel :

def format_frame(frame) should be renamed to 
format_frame_summary(frame_summary) because it takes a FrameSummary obejct and 
not a frame. 

This is a new API in 3.11 so it can be changed now.

There are also local variables in traceback.py which are called frame but 
actually represent FrameSummary. This can be confusing and should be fixed at 
the same time where it doesn't break API.

--
messages: 400825
nosy: iritkatriel
priority: normal
severity: normal
status: open
title: confusion between frame and frame_summary in traceback module

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com