1790890 - Port bug 1492495: Enable 'flake8-isort' plugin in flake8 mozlinter

Status: RESOLVED FIXED

(Thunderbird :: Build Config, task)

Description

[Rob Lemley [:rjl]]

Bug 1492495 adds the 'flake8-isort' plugin to the flake8 Python linter.

The short version is that it will enforce a standard order for imported libraries and modules.

Initially, it will only produce warnings which will not fail mozlint tests in CI.

A new config file will need to be added: comm/tools/lint/flake8.yml. This will enable comm-central file exclusions and not run flake8 on *.configure files. Not sure why m-c is including configure files in its mozlint config, they're all excluded in the .flake8 file.

---
flake8:
    description: Python linter
    # Excludes should be added to topsrcdir/.flake8.
    exclude: []
    # The configure option is used by the build system
    extensions: ['py']
    support-files:
        - '**/.flake8'
        - 'tools/lint/python/flake8*'
    # Rules that should result in warnings rather than errors.
    warning-rules: ['I001', 'I003', 'I004', 'I005']
    type: external
    payload: commlint:lint_wrapper
    wraps: python.flake8:lint
    setup: python.flake8:setup

Then with bug 1492495 in m-c, this works:

./mach commlint -l flake8 --warnings comm

Should be able to pass --fix to mach commlint and take care of most of the isort problems.

Comment 1

[Rob Lemley [:rjl]]

Attachment: Bug 1790890 - port Bug 1492495: Make flake8-isort failures a warning instead of hard fail. r=dandarnell

isort is an "import" statement ordering check. For now, only issue warnings for
those checks.

Comment 2

[Rob Lemley [:rjl]]

Attachment: Bug 1790890 - Fix flake8-isort error messages. r=#thunderbird-reviewers

Depends on D161279

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/050b94a49569
port Bug 1492495: Make flake8-isort failures a warning instead of hard fail. r=dandarnell
https://hg.mozilla.org/comm-central/rev/ec849410c436
Fix flake8-isort error messages. r=dandarnell

Comment 4

[Intermittent Failures Robot]

2 failures in 3626 pushes (0.001 failures/push) were associated with this bug in the last 7 days.

Repository breakdown:

• comm-central: 2

Platform and build breakdown:

• lint: 2
  • opt: 2

For more details, see:
https://treeherder.mozilla.org/intermittent-failures/bugdetails?bug=1790890&startday=2022-10-31&endday=2022-11-06&tree=all