1344718 - Enable flake8 rule E302: "expected 2 blank lines, found 1"

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P3)

Description

[Alessio Placitelli [:Dexter]]

In bug 1332651 we landed flake8 initial support to lint Python files in the Telemetry directory, by disabling all the detected problems.

This bug is about enabling the E302 rule: "expected 2 blank lines, found 1":

1) Remove the E302 rule from the .flake8 file in https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry

2) Run "./mach lint -l flake8 toolkit/components/telemetry".

3) Fix the reported problems

Comment 1

[Deepjyoti Mondal]

@Alessio I would like to work on this, would please assign me to this ?

Comment 2

[Alessio Placitelli [:Dexter]]

(In reply to Deepjyoti Mondal from comment #1)
> @Alessio I would like to work on this, would please assign me to this ?

Before this bug becomes actionable, we need the dependency (Enabling flake8) to land! :)
Once it does, if no problem arises and you have some spare time, I'll gladly do!

Comment 3

[Deepjyoti Mondal]

okay :)

Comment 4

[Deepjyoti Mondal]

Attachment: bug1344718.patch

Enabled flake8 rule E302

Comment 5

[Alessio Placitelli [:Dexter]]

Comment on attachment 8844346 [details] [diff] [review]
bug1344718.patch

Review of attachment 8844346 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks for the patch, this looks good overall. However, if you apply it on the most recent version of mozilla-central, you will get:

> shared_telemetry_utils.py
>  24:1  error  expected 2 blank lines, found 1  E302 (flake8)
>  27:1  error  expected 2 blank lines, found 1  E302 (flake8)
> ? 2 problems (2 errors, 0 warnings)

Please fix both histogram_tools.py and shared_telemetry_utils.py.

::: toolkit/components/telemetry/histogram_tools.py
@@ +431,4 @@
>  # just Histograms.json.  For each file's basename, we have a specific
>  # routine to parse that file, and return a dictionary mapping histogram
>  # names to histogram parameters.
> +

Instead of adding the newlines after the comment block, could you add them before?

Comment 6

[Deepjyoti Mondal]

Attachment: bug1344718.patch

I have updated my mozilla-central repo and have made the changes. Its not showing any error.

Comment 7

[Alessio Placitelli [:Dexter]]

Comment on attachment 8844985 [details] [diff] [review]
bug1344718.patch

Review of attachment 8844985 [details] [diff] [review]:
-----------------------------------------------------------------

This looks good now, thanks!

For the next time, could you please append the name of the reviewer at the end of the patch? For example, the current commit message would become:

"Bug 1344718 - Enabled flake8 rule E302: "expected 2 blank lines, found 1". r?dexter"

See https://developer.mozilla.org/en-US/docs/Mercurial/Using_Mercurial#Commit_Message_Conventions

Comment 8

[Alessio Placitelli [:Dexter]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=32140aa21035

Comment 9

[Deepjyoti Mondal]

Sure, I wont miss it next time :)

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/50a0ca4800c1
Enable flake8 rule E302: "expected 2 blank lines, found 1" for Telemetry code. r=Dexter

Comment 11

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/50a0ca4800c1