[issue19723] Argument Clinic should add markers for humans

Roundup Robot added the comment: New changeset e634b377d5cc by Larry Hastings in branch 'default': Issue #19723: Missed one conversion to the new Argument Clinic syntax. http://hg.python.org/cpython/rev/e634b377d5cc -- ___ Python tracker

[issue19723] Argument Clinic should add markers for humans

Roundup Robot added the comment: New changeset aa153113d273 by Zachary Ware in branch 'default': Issue #19723: Fix issue number typo in Misc/NEWS http://hg.python.org/cpython/rev/aa153113d273 -- nosy: +python-dev ___ Python tracker

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: I'm assuming this is sufficient. If further bikeshedding is needed please reopen the issue. -- resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed ___ Python tracker

[issue19723] Argument Clinic should add markers for humans

Guido van Rossum added the comment: The new syntax is fine; I was only giving an example. -- ___ Python tracker ___ ___ Python-bugs-li

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: Patch attached. I tweaked the punctuation in the last line, from this: /*[clinic end generated code; checksum: {checksum}]*/ ^ ^ to this: | | v v /*[cli

[issue19723] Argument Clinic should add markers for humans

Stefan Krah added the comment: > I think maybe I only showed it to Stefan Krah, who said it wouldn't help his > use case so I dropped it. I think we were talking about _decimal, where any tool will interfere with the 100% code coverage patches. But that's a special case. --

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: Antoine just suggested that, if we used this "accumulator" thing, we'd want a convention for where the generated text should go. I actually have an answer for that: near the end, below the implementations of the module / class methods, but above the methoddef

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: If it's source code, programmers will need to examine it from time to time. A more important distinction imo: stringlib is type-parameterized like some sort of prehistoric C++ template specialization. Thankfully the gunk generated by Argument Clinic is free

[issue19723] Argument Clinic should add markers for humans

Guido van Rossum added the comment: Then the separate file version looks much worse to me. -- ___ Python tracker ___ ___ Python-bugs-l

[issue19723] Argument Clinic should add markers for humans

Serhiy Storchaka added the comment: In contrast to stringlib programmers should not look in these generated files. -- ___ Python tracker ___ _

[issue19723] Argument Clinic should add markers for humans

Serhiy Storchaka added the comment: > I use Emacs, so I have no idea what would help for Kate. I suppose Kate is > programmable? Maybe you can add some kind of filter for this purpose? In comparision with Emacs it is not programmable. > If e.g. binascii_a2b_uu_impl were moved to a different

[issue19723] Argument Clinic should add markers for humans

Guido van Rossum added the comment: And the stringlib situation confuses the hell out of me already. -- ___ Python tracker ___ ___ Pyt

[issue19723] Argument Clinic should add markers for humans

Guido van Rossum added the comment: I use Emacs, so I have no idea what would help for Kate. I suppose Kate is programmable? Maybe you can add some kind of filter for this purpose? If e.g. binascii_a2b_uu_impl were moved to a different file, how would binascii_a2b_uu call it without exposing

[issue19723] Argument Clinic should add markers for humans

Antoine Pitrou added the comment: > If e.g. binascii_a2b_uu_impl were moved to a different file, how would > binascii_a2b_uu call it without exposing the symbol externally? I think "stitching it with #include" is the only workable solution. We already do this for e.g. stringlib. -- ___

[issue19723] Argument Clinic should add markers for humans

Serhiy Storchaka added the comment: Why not just move most (except implementation function headers) generated code out to separate file? Right now the list of symbols in the Kate editor contains three names for every function: BINASCII_A2B_UU_METHODDEF, binascii_a2b_uu and binascii_a2b_uu_impl

[issue19723] Argument Clinic should add markers for humans

Guido van Rossum added the comment: Yes. Then I suggest working on a patch before people get too deep into the conversion project. -- ___ Python tracker ___

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: And for Python blocks would you suggest /*[python input] ... [python start generated code]*/ ... /*[python end generated code; checksum: da39a3ee5e6b4b0d3255bfef95601890afd80709]*/ To answer your question: no, it wouldn't be hard. -- _

[issue19723] Argument Clinic should add markers for humans

Guido van Rossum added the comment: I grepped for clinic in the source code and I have a hunch why this confusing: each clinic-generated block has *three* marker comments, each containing [clinic] or [clinic checksum: ...]. TBH I can't always tell on which side of the comment the generated cod

[issue19723] Argument Clinic should add markers for humans

Nick Coghlan added the comment: On 23 Nov 2013 08:05, "Larry Hastings" wrote: > > > Larry Hastings added the comment: > > > However, to bikeshed a little, I would prefer > > "preprocessor" instead of "clinic", since jokes > > tend to wear off if one sees then too often. > > "Argument Clinic" is

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: > However, to bikeshed a little, I would prefer > "preprocessor" instead of "clinic", since jokes > tend to wear off if one sees then too often. "Argument Clinic" is the name of the tool. The marker /*[clinic]*/ was chosen deliberately: * If someone says "what

[issue19723] Argument Clinic should add markers for humans

Stefan Krah added the comment: I think it's possible to get used to the markers. However, to bikeshed a little, I would prefer "preprocessor" instead of "clinic", since jokes tend to wear off if one sees then too often. -- nosy: +skrah ___ Python tra

[issue19723] Argument Clinic should add markers for humans

Antoine Pitrou added the comment: > You find the big > /*[clinic checksum: b6ded2204fd0aab263564feb5aae6bac840b5b94]*/ > marker insufficient? Well, it doesn't say anything except "checksum", and it doesn't seem geared at humans (except perhaps those with a hex calculator in their head :-)). Cli

[issue19723] Argument Clinic should add markers for humans

Larry Hastings added the comment: You find the big /*[clinic checksum: b6ded2204fd0aab263564feb5aae6bac840b5b94]*/ marker insufficient? Perhaps this is simply something we will quickly get used to. How about we let this sit for a while and see what other people think. p.s. I accept your criti

[issue19723] Argument Clinic should add markers for humans

New submission from Antoine Pitrou: I was reviewing a patch by Larry and I started commenting on some rather tasteless code, until I realized it was generated by Argument Clinic. It would be nice if Argument Clinic added some markers, such as: /* Start of code generated by Argument Clinic */