Issue 20273: Argument Clinic: unhelpful crashes

Sometimes when Argument Clinic see something wrong, it raises exception and exit with printed traceback, instead of output helpful error message which points on line with illegal syntax.

I open this issue to report about such problems.

$ ./python Tools/clinic/clinic.py -f Modules/zlibmodule.c
Traceback (most recent call last):
  File "Tools/clinic/clinic.py", line 3032, in <module>
    sys.exit(main(sys.argv[1:]))
  File "Tools/clinic/clinic.py", line 3028, in main
    parse_file(filename, output=ns.output, verify=not ns.force)
  File "Tools/clinic/clinic.py", line 1135, in parse_file
    cooked = clinic.parse(raw)
  File "Tools/clinic/clinic.py", line 1085, in parse
    parser.parse(block)
  File "Tools/clinic/clinic.py", line 2262, in parse
    self.state(line)
  File "Tools/clinic/clinic.py", line 2582, in state_parameter
    value = eval(py_default)
  File "<string>", line 1, in <module>
NameError: name 'zlib' is not defined

zlibmodule.c is almost same as after applying patch from issue20193 (with several clinic bugs already fixed).

I suppose this crash is caused by this code:

/*[clinic input]
zlib.Compress.flush

    self: self(type="compobject *")
    mode: int(c_default="Z_FINISH") = zlib.Z_FINISH
        One of the constants Z_SYNC_FLUSH, Z_FULL_FLUSH, Z_FINISH.
        If mode == Z_FINISH, the compressor object can no longer be used after
        calling the flush() method.  Otherwise, more data can still be compressed.
    /

Return a bytes object containing any remaining compressed data.
[clinic start generated code]*/

It was valid several days ago.

Therefore here are two bugs:

1. Argument Clinic should output a line number where it has encountered illegal expression.

2. It should accept zlib.Z_FINISH (Z_FINISH is exported constant in the zlib module).

I'm marking this as a duplicate of #20226, the "add general-purpose expressions" issue, because that will fix the behavior you're seeing.  As for "in general Argument Clinic should have better error reporting", this is too general for an issue right now.  In the future feel free to file issues for specific badly-phrased errors.

Georg already opened an issue with a patch about providing a little more information in unexpected exceptions, see issue20235.

Thank you Zachary.

messages: + msg208194
nosy: + zach.ware

assignee: larry
resolution: duplicate
stage: resolved