[webkit-dev] Formatting style for inline comments in Python code

[Aakash Jain]

> On Nov 3, 2017, at 9:20 AM, Maciej Stachowiak <mjs at apple.com> wrote:
> 
> 
> 
>> On Nov 3, 2017, at 8:59 AM, Aakash Jain <aakash_jain at apple.com <mailto:aakash_jain at apple.com>> wrote:
>> 
>> 
>> 
>>> On Nov 2, 2017, at 8:45 PM, Maciej Stachowiak <mjs at apple.com <mailto:mjs at apple.com>> wrote:
>>> 
>>> 
>>> 
>>>> On Nov 2, 2017, at 5:41 PM, Aakash Jain <aakash_jain at apple.com <mailto:aakash_jain at apple.com>> wrote:
>>>> 
>>>> 
>>>> 
>>>>> On Oct 26, 2017, at 10:21 AM, Maciej Stachowiak <mjs at apple.com <mailto:mjs at apple.com>> wrote:
>>>>> 
>>>>> 
>>>>> 
>>>>>> On Oct 26, 2017, at 10:20 AM, Eric Carlson <eric.carlson at apple.com <mailto:eric.carlson at apple.com>> wrote:
>>>>>> 
>>>>>> 
>>>>>> 
>>>>>>> On Oct 26, 2017, at 9:50 AM, Brian Burg <bburg at apple.com <mailto:bburg at apple.com>> wrote:
>>>>>>> 
>>>>>>> 
>>>>>>> 
>>>>>>>> 2017/10/26 午前9:21、Alexey Proskuryakov <ap at webkit.org <mailto:ap at webkit.org>>のメール:
>>>>>>>> 
>>>>>>>> 
>>>>>>>> 
>>>>>>>>> 25 окт. 2017 г., в 18:21, Michael Catanzaro <mcatanzaro at igalia.com <mailto:mcatanzaro at igalia.com>> написал(а):
>>>>>>>>> 
>>>>>>>>> On Wed, Oct 25, 2017 at 4:58 PM, Aakash Jain <aakash_jain at apple.com <mailto:aakash_jain at apple.com>> wrote:
>>>>>>>>>> Does anyone else has any opinion/preference for this?
>>>>>>>>> 
>>>>>>>>> The number of spaces before a comment really does not matter, but my $0.02: PEP8 is an extremely common style for Python programs that all Python developers are familiar with. I would follow that, and forget about trying to adapt WebKit C++ style to an unrelated language. Trying to adapt the style checker to ignore particular PEP8 rules seems like wasted effort.
>>>>>>>> 
>>>>>>>> 
>>>>>>>> There is definitely a number of PEP8 rules that we want to follow. But I don't think that there is anything about the two space before comment rule that makes it particularly fitting for Python.
>>>>>>> 
>>>>>>> This is entirely subjective, so: why differ from the vast majority of all other Python code in existence, just to be different? What's the point? PEP8 adherence is nearly universal among projects on PyPi, at least among those that run style linters.
>>>>>>> 
>>>>>>>> I think that we should target WebKit developers with the coding style as much as possible, not Python developers. As we all agree on the one space rule elsewhere, why make a part of the code base uncomfortably different for most WebKit developers?
>>>>>>> 
>>>>>>> I don't understand the distinction between WebKit developers and Python developers. Am I not a C++ developer and web developer as well?
>>>>>>> 
>>>>>>> If "WebKit developers" want to write Python code, perhaps they should learn the Pythonic idioms of the language, just as they would use idioms of Perl, JavaScript, and C++. For better or worse, PEP8 encodes many of these idioms.
>>>>>>> 
>>>>>>> If someone already knows Python, they will be tripped up by this divergence and waste some minutes trying to satisfy the style checker, or just ignore it. If they don't know Python well, then they are being conditioned to follow some variant that has no benefit and is different from what they would see in any other Python code.
>>>>>>> 
>>>>>>> I see no value in adding arbitrary barriers to new contributions in Python code. The code has enough problems as-is, we don't need to make up our own for some pretense of consistency. We import other Python projects into the tree, and they follow PEP8, so what was proposed is to make the Python code in the tree *less* internally consistent.
>>>>>>> 
>>>>>> 
>>>>>> +1
>>>>> 
>>>> 
>>>> 
>>>>> I'm very used to WebKit style for C++, and I agree that we should use PEP8 style for Python even where it differs from our C++ style.
>>>> 
>>>> I personally prefer following PEP8 while writing python.
>>>> 
>>>> Since people have opinions for both C++ style as well as PEP8 style (and comment spacing is anyways a minor thing), I am going to go with Maciej and use PEP8 style for Python (which is the style we have already been following in webkitpy).
>>> 
>>> I mean, I agree with this approach, but don't do it just because I said it. :-) These days, I code less C++ and less Python in WebKit than most people on this thread.
>> 
>> I am not doing it only because you said this. I discussed it with Alexey yesterday, and he was fine either way. I personally prefer PEP8. Brian Burg, Michael Catanzaro and Eric Carlson also supported this. That makes most of us (who expressed their opinion) favor this approach.
> 
> Sounds good. Do we need to update our style guidelines at all? Maybe just state somewhere that for Python our style is PEP8?

Yeah, I think we should update this webpage with a small section about following PEP8 for Python https://webkit.org/code-style-guidelines/ <https://webkit.org/code-style-guidelines/>. I will update that.

style-ews (and check-webkit-style script) already enforce PEP8 for Python, so we won't need any change there.

-Aakash

> 
>  - Maciej
> 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20171103/091e341e/attachment.html>