pydoc terminal suboptimal rendering of complex annotations

[dw]

BPO	43451
Nosy	@dw
PRs	bpo-43451: Render inspect function arguments one-per-line when they exceed a maximum length #24802

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-03-09.19:12:29.560>
labels = ['library', '3.10']
title = 'pydoc terminal suboptimal rendering of complex annotations'
updated_at = <Date 2021-03-09.19:16:59.049>
user = 'https://github.com/dw'

bugs.python.org fields:

activity = <Date 2021-03-09.19:16:59.049>
actor = 'dw'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2021-03-09.19:12:29.560>
creator = 'dw'
dependencies = []
files = []
hgrepos = []
issue_num = 43451
keywords = ['patch']
message_count = 1.0
messages = ['388373']
nosy_count = 1.0
nosy_names = ['dw']
pr_nums = ['24802']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue43451'
versions = ['Python 3.10']

[dw]

When viewing docs for classes that use annotations, pydoc's rendering of argument lists is regularly truncated at the terminal edge (if using less -S), or wrapped in a manner where quickly scanning the output is next to impossible.

My 'classic' example is 'pydoc aiohttp.client.ClientSession', where the __init__ argument list wraps to 24 lines.

The pull request attached to this issue works around the problem by formatting arguments one-per-line if the sum of the arguments would exceed a hard-coded width of 150 characters. It is more of an RFC than a suggested fix. It produces acceptable formatting, but I'm not sure where the correct fix should be made -- in the inspect module, or somehow in the pydoc module, or even what the correct fix shuld be.

I will include a before/after screenshot in the pull request

I will attach before/after screenshot