1555263 - Make raptor code black compatible

Status: RESOLVED WORKSFORME

(Testing :: Raptor, task, P4)

Description

[Florin Strugariu [:Bebe]]

Review and update all raptor code base and make it black code style compatible

https://github.com/python/black

Comment 1

[Florin Strugariu [:Bebe]]

:rwood :davehunt would this be ok?

Comment 2

[Robert Wood [:rwood]]

(In reply to Florin Strugariu [:Bebe] from comment #1)

:rwood :davehunt would this be ok?

No. We need to keep the same Mozilla wide coding style. Also I don't wish to introduce more complexity at this time, we have several Raptor issues (i.e. intermittent failures) that we need to focus on. :)

https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style

Comment 3

[Dave Hunt [:davehunt] [he/him] ⌚BST]

I would love to see us adopting black or something like it, but rwood has a good point regarding consistency with the rest of mozilla-central. We should also include a solution to block patches that don't comply, or reformat them in a pre-commit hook. For now, let's block this on bug 1540641, which is experimenting with using black throughout the tree.

Comment 5

[Florin Strugariu [:Bebe]]

As of https://wiki.mozilla.org/TestEngineering/Performance/Raptor#Code_formatting_on_Raptor
let's make raptor black compatible

Comment 6

[Florin Strugariu [:Bebe]]

https://firefox-source-docs.mozilla.org/code-quality/coding-style/coding_style_python.html

Comment 7

[Florin Strugariu [:Bebe]]

Attachment: Bug 1555263 - Make raptor code black compatible

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

(In reply to Florin Strugariu [:Bebe] (needinfo me) from comment #5)

As of https://wiki.mozilla.org/TestEngineering/Performance/Raptor#Code_formatting_on_Raptor
let's make raptor black compatible

How are you going to enforce that? This question from comment 3 is still open, and it doesn't make that much sense to land those changes without having such enforcement in place. Also what is different to the internal linter? No other code in mozilla-central (AFAIK) wants to be black formatted.

Comment 9

[Florin Strugariu [:Bebe]]

As black is the recomanded tool I just wanted to make sure we are compatible. No enforcement in mind.

https://firefox-source-docs.mozilla.org/code-quality/coding-style/coding_style_python.html

Comment 10

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Enforcement would be taken care of in bug 1540641. I think it's okay to update our code to be compatible, but accept that it may diverge without enforcement.

Comment 11

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

Oh, good to know that they added black on that page. In that case I assume our linter takes care of it, even if it's only partial (it might ignore " vs ').

Comment 12

[Florin Strugariu [:Bebe]]

:ahal can you share your feedback on https://phabricator.services.mozilla.com/D62574

Comment 13

[Andrew Halberstadt [:ahal]]

Looks fine to me, but my feedback isn't needed for formatting changes in modules I'm not involved with :)

Comment 14

[Florin Strugariu [:Bebe]]

:Dave :Henrik can you recommend a resolution on this bug?

Should we continue/make raptor black compatible? or end this effort and resolve with won't fix

Comment 15

[Dave Hunt [:davehunt] [he/him] ⌚BST]

This bug depends on bug 1540641, which is assigned to Sylvestre. I am not against reformatting Raptor to make it black compatible, but if this is done without also enabling some sort of automated linter of formatter then it will quickly become inconsistent again. :Sylvestre do you have any plans to work on bug 1540641? Is there anything we can do to help?

Comment 16

[Sylvestre Ledru [:Sylvestre]]

Yeah, I will have a look to black on the code base

Comment 17

[Dave Hunt [:davehunt] [he/him] ⌚BST]

I believe all our Python code is now black (or ruff). @ahal do you know if there's anything left to do here? I wonder if bug 1540641 and its dependencies can be resolved.

Comment 18

[Andrew Halberstadt [:ahal]]

We don't use ruff's formatter yet, it's still black. And I don't see this dir listed in https://searchfox.org/mozilla-central/source/tools/lint/black.yml so it should be running.