1278247 - Enforce consistent naming for Telemetry gen-* python scripts

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P3)

Description

[Alessio Placitelli [:Dexter]]

(In reply to Alessio Placitelli [:Dexter] from bug 1276190 comment #9)
> Given PEP0008 [1], we should probably rename the "gen-scalar*.py" to
> "generate_scalar_*.py".
> 
> > Modules should have short, all-lowercase names. Underscores can be used in the module name
> > if it improves readability. Python packages should also have short, all-lowercase names,
> > although the use of underscores is discouraged. 
> 
> [1] - https://www.python.org/dev/peps/pep-0008/#package-and-module-names

Comment 1

[Ryan Leake]

Hi Alessio, I'd like to take this on if still required.

Comment 2

[Alessio Placitelli [:Dexter]]

(In reply to Ryan Leake from comment #1)
> Hi Alessio, I'd like to take this on if still required.

Hey Ryan! Thanks for reaching out. Yes, this bug is still useful. I've assigned it to you. Please let me know if you have any question :)

Comment 3

[Ryan Leake]

Attachment: Bug 1278247 - Enforce consistent naming for Telemetry gen-* python scripts.

Review commit: https://reviewboard.mozilla.org/r/201968/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/201968/

Comment 4

[Alessio Placitelli [:Dexter]]

Comment on attachment 8930870 [details]
Bug 1278247 - Enforce consistent naming for Telemetry gen-* python scripts.

https://reviewboard.mozilla.org/r/201968/#review207408

Hey Ryan, thank you for your patch. The changes for the scalar scripts look ok, can we do the same for the other generator scripts too?

::: toolkit/components/telemetry/moz.build:153
(Diff revision 1)
>  # Generate event files.
>  event_files = [
>      'Events.yaml',
>  ]
>  
>  event_data = GENERATED_FILES['TelemetryEventData.h']

Would you mind doing the same for the histograms (e.g. `gen-histogram-*.py`) and events (`gen-event-*.py`) generator files?

Comment 5

[Ryan Leake]

(In reply to Alessio Placitelli [:Dexter] from comment #4)
> Comment on attachment 8930870 [details]
> Bug 1278247 - Enforce consistent naming for Telemetry gen-* python scripts.
> 
> https://reviewboard.mozilla.org/r/201968/#review207408
> 
> Hey Ryan, thank you for your patch. The changes for the scalar scripts look
> ok, can we do the same for the other generator scripts too?
> 
> ::: toolkit/components/telemetry/moz.build:153
> (Diff revision 1)
> >  # Generate event files.
> >  event_files = [
> >      'Events.yaml',
> >  ]
> >  
> >  event_data = GENERATED_FILES['TelemetryEventData.h']
> 
> Would you mind doing the same for the histograms (e.g. `gen-histogram-*.py`)
> and events (`gen-event-*.py`) generator files?

Sure, no problem.

Comment 6

[Ryan Leake]

Comment on attachment 8930870 [details]
Bug 1278247 - Enforce consistent naming for Telemetry gen-* python scripts.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/201968/diff/1-2/

Comment 7

[Alessio Placitelli [:Dexter]]

Comment on attachment 8930870 [details]
Bug 1278247 - Enforce consistent naming for Telemetry gen-* python scripts.

https://reviewboard.mozilla.org/r/201968/#review207758

This looks good, thanks Ryan!

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/85d8bab6cc6f
Enforce consistent naming for Telemetry gen-* python scripts. r=Dexter

Comment 9

[Tiberius Oros[:tiberius_oros]]

https://hg.mozilla.org/mozilla-central/rev/85d8bab6cc6f