<div dir="ltr">fwiw, we're going to need the tool name in any pragma anyways so the existing thing that should be common is:<div><br></div><div># tool-name: meaningfultoken</div><div><br></div><div>It seems like the only convention that makes sense to me.</div><div><br></div><div>When I saw your flake8 example of "# noqa: F401" I wanted to rip my eyes out. Because it didn't mention the tool name *and* it used a numeric code.  Tool authors: use descriptive names!  Otherwise it is meaningless to anyone reading it.  ex:</div><div><br></div><div>import rlcompleter  # pylint: disable=unused-import</div><div><br></div><div>Nobody will ever question _what_ that means.</div><div><br></div><div>-gps</div></div><br><div class="gmail_quote"><div dir="ltr">On Mon, Nov 13, 2017 at 2:19 PM Brett Cannon <<a href="mailto:brett@python.org">brett@python.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br><br><div class="gmail_quote"><div dir="ltr">On Mon, Nov 13, 2017, 13:59 Paul Moore, <<a href="mailto:p.f.moore@gmail.com" target="_blank">p.f.moore@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On 13 November 2017 at 20:43, MRAB <<a href="mailto:python@mrabarnett.plus.com" target="_blank">python@mrabarnett.plus.com</a>> wrote:<br>
> On 2017-11-13 19:10, Barry Warsaw wrote:<br>
>> The specifics aren't as important as the general use case: multiple<br>
>> tools competing for the same valuable real-estate.<br>
>><br>
>> I have no ideas how to improve the situation, and of course any solution<br>
>> would involve some coordination between all of these tools, but it's<br>
>> beginning to feel like a losing battle.  Is there a better way?<br>
>><br>
> I suppose that you could have suggest to them that they follow a convention<br>
> such as:<br>
><br>
> 1. There can be multiple pragmas in a comment, separated by semicolons: if<br>
> you don't recognise it, skip past the semicolon.<br>
><br>
> 2. A pragma can be prefixed with the name of the tool, e.g. "# flake8.noqa:<br>
> F401": if there's a prefix, but it's not yours, skip past the semicolon.<br>
<br>
An informational PEP defining a common convention for pragma-style<br>
comments could standardise things. I'd suggest starting a discussion<br>
(somewhere?) with the development teams for the relevant projects<br>
(flake8, mypy, coverage...) with the intention of developing such a<br>
PEP that they could all support.<br></blockquote></div><div><br></div><div>And possibly the easiest way to reach them is on the pyqa-dev mailing list.</div><div><br></div><div>-brett</div><div><br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Paul<br>
_______________________________________________<br>
Python-ideas mailing list<br>
<a href="mailto:Python-ideas@python.org" target="_blank">Python-ideas@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/python-ideas" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/python-ideas</a><br>
Code of Conduct: <a href="http://python.org/psf/codeofconduct/" rel="noreferrer" target="_blank">http://python.org/psf/codeofconduct/</a><br>
</blockquote></div>
_______________________________________________<br>
Python-ideas mailing list<br>
<a href="mailto:Python-ideas@python.org" target="_blank">Python-ideas@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/python-ideas" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/python-ideas</a><br>
Code of Conduct: <a href="http://python.org/psf/codeofconduct/" rel="noreferrer" target="_blank">http://python.org/psf/codeofconduct/</a><br>
</blockquote></div>