Bug 179387 – Update code style guidelines for Python

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKit Website

[Aakash Jain]

For Python code inside WebKit, we use PEP8 style. Recently, we had a discussion about it on webkit-dev and we decided to stick to PEP8. We should update the code style guidelines to reflect the same.

[Aakash Jain]

Created attachment 326238 [details]
Proposed patch

[Alexey Proskuryakov]

Comment on attachment 326238 [details]
Proposed patch

Is it worth mentioning that we don't respect the line length limit?

[Build Bot]

Comment on attachment 326238 [details]
Proposed patch

Attachment 326238 [details] did not pass mac-wk2-ews (mac-wk2):
Output: http://webkit-queues.webkit.org/results/5138434

New failing tests:
imported/w3c/web-platform-tests/service-workers/service-worker/register-wait-forever-in-install-worker.https.html

[Build Bot]

Created attachment 326259 [details]
Archive of layout-test-results from ews106 for mac-elcapitan-wk2

The attached test failures were seen while running run-webkit-tests on the mac-wk2-ews.
Bot: ews106  Port: mac-elcapitan-wk2  Platform: Mac OS X 10.11.6

[Aakash Jain]

> Is it worth mentioning that we don't respect the line length limit?

I don't think we should mention it as a guideline. We don't want to encourage people to dis-respect line length. It's ok if they don't follow it, style checking script wouldn't complaint.

[Alexey Proskuryakov]

Comment on attachment 326238 [details]
Proposed patch

rs=me based on webkit-dev discussion

[Aakash Jain]

Committed r227576: <https://trac.webkit.org/changeset/227576>

[Radar WebKit Bug Importer]

<rdar://problem/36840858>

[Daniel Bates]

(In reply to Aakash Jain from comment #5)
> > Is it worth mentioning that we don't respect the line length limit?
> 
> I don't think we should mention it as a guideline. We don't want to
> encourage people to dis-respect line length. 

I do not recall that we (the WebKit OpenSource Project) ever agreed to PEP-8's maximum line length rule. I certainly do not agree to it. It is archaic and hurts readability. These sentiments are echoed in the thread that includes <https://lists.webkit.org/pipermail/webkit-dev/2010-April/012486.html>.

[Daniel Bates]

(In reply to Daniel Bates from comment #9)
> (In reply to Aakash Jain from comment #5)
> > > Is it worth mentioning that we don't respect the line length limit?
> > 
> > I don't think we should mention it as a guideline. We don't want to
> > encourage people to dis-respect line length. 
> 
> I do not recall that we (the WebKit OpenSource Project) ever agreed to
> PEP-8's maximum line length rule. I certainly do not agree to it. It is
> archaic and hurts readability. These sentiments are echoed in the thread
> that includes
> <https://lists.webkit.org/pipermail/webkit-dev/2010-April/012486.html>.

I forgot to mention that following PEP8's maximum line length rule came up in bug 184039, comment 14.

[Aakash Jain]

> I do not recall that we (the WebKit OpenSource Project) ever agreed to
> PEP-8's maximum line length rule. I certainly do not agree to it. It is
> archaic and hurts readability. These sentiments are echoed in the thread
> that includes
> <https://lists.webkit.org/pipermail/webkit-dev/2010-April/012486.html>.

You are right, we do not follow PEP8 maximum line length rule. Our style checking script explicitly ignore this check.  https://trac.webkit.org/browser/webkit/trunk/Tools/Scripts/webkitpy/style/checker.py#L118

I felt it was ok to not document it in our Style guideline as following this rule doesn't hurt. However, if this missing documentation is creating any real problems, I would be ok if you want to document this.

[Ryosuke Niwa]

Yeah, we certainly shouldn't adopt maximum line length.