gh-133653: Fix subclassing HelpFormatter

[hugovk]

The problem was with this code:

ifisinstance(self.formatter_class, type) andissubclass(
self.formatter_class, HelpFormatter
):
returnself.formatter_class(
prog=self.prog,
prefix_chars=self.prefix_chars,
color=self.color,
)
else:
returnself.formatter_class(prog=self.prog)

We want to set the extra arguments for HelpFormatter and argparse's own subclasses, which don't have their own __init__s.

But many third-party subclasses do have an __init__ and don't pass on kwargs. So we can't just check for a subclass of HelpFormatter, so let's try/except instead.

• Issue: argparse.HelpFormatter subclasses may be broken by 3.14 changes #133653

[iritkatriel]

TypeError seems a bit generic (you're calling user code).

What do you think about this?

len([v.kind for (k, v) in inspect.signature(self.formatter_class).parameters.items() if k in ('y', 'z') and v.kind in (inspect._ParameterKind.POSITIONAL_OR_KEYWORD, inspect._ParameterKind.KEYWORD_ONLY)]) == 2

[hugovk]

That doesn't work: FAILED (failures=2, errors=156)

[hugovk]

Wait, it does, obviously need to replace y and z :)

[serhiy-storchaka]

I would not like to use inspect.signature() here. It is not reliable. If it fails (or return incorrect result), you cannot do anything with this. It can only be used in interactive introspection, when errors can be ignored.

[hugovk]

Would you prefer the try/except or another approach?

[serhiy-storchaka]

No, I think the user code should be changed. They use undocumented feature.

[iritkatriel]

We can do my original suggestion - make __init__ accept **kwargs and extract the new args with this.

Already two external libraries were broken by this in the first alpha testing. Leaving this as it is will break user code for sure.

[serhiy-storchaka]

This would not help. The problem is that the user code does not accept any arguments besides prog. And they do this because they use undocumented feature.

[iritkatriel]

What's the concern with inspect? That it won't work for some weird function? In that case we can just use the default values for these arguments.

[iritkatriel]

Another option is to set these fields through a setter method and not via __init__.

[serhiy-storchaka]

See alternative PR #133813.