Extend ignore list in flake8 config - #279
Merged
Merged
Conversation
flake8 disables a number of checks by default, e.g. W503 [1] and W504 [2], which are conflicting checks and are both not violations of the PEP8 standard. In the flake8 config, the `ignore` key overrides the default ignore list, leading to these issues being raised in CI. The `extend-ignore` key extends the default ignore list instead, allowing these issues to correctly remain suppressed. [1]: https://www.flake8rules.com/rules/W503.html [2]: https://www.flake8rules.com/rules/W504.html
FranzBusch
approved these changes
Jun 22, 2026
Member
|
Thanks! This makes sense to me |
snprajwal
added a commit
to snprajwal/swift-docc
that referenced
this pull request
Jun 29, 2026
GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch removes the configuration value that disabled the check, and formats `build-script-helper.py` as per the flake8 configuration in swiftlang/github-workflows [2]. [1]: swiftlang/github-workflows#279 [2]: https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/configs/.flake8
snprajwal
added a commit
to snprajwal/swift-docc
that referenced
this pull request
Jul 27, 2026
GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch removes the configuration value that disabled the check, and formats `build-script-helper.py` as per the flake8 configuration in swiftlang/github-workflows [2]. [1]: swiftlang/github-workflows#279 [2]: https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/configs/.flake8
snprajwal
added a commit
to snprajwal/swift-docc
that referenced
this pull request
Jul 29, 2026
GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch formats `build-script-helper.py` as per the flake8 configuration in swiftlang/github-workflows [2]. This commit is isolated to the formatting check to allow adding it to `.git-blame-ignore-revs`. The check will be enabled in a separate commit. [1]: swiftlang/github-workflows#279 [2]: https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/configs/.flake8
snprajwal
added a commit
to swiftlang/swift-docc
that referenced
this pull request
Jul 29, 2026
GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch removes the configuration value that disabled the check, and formats `build-script-helper.py` as per the flake8 configuration in swiftlang/github-workflows [2]. [1]: swiftlang/github-workflows#279 [2]: https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/configs/.flake8
Teemperor
pushed a commit
to Teemperor/swift-mono
that referenced
this pull request
Jul 29, 2026
GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch removes the configuration value that disabled the check, and formats `build-script-helper.py` as per the flake8 configuration in swiftlang/github-workflows [2]. [1]: swiftlang/github-workflows#279 [2]: https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/configs/.flake8
snprajwal
added a commit
to swiftlang/swift-docc
that referenced
this pull request
Jul 29, 2026
GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch removes the configuration value that disabled the check. It also adds the commit that reformatted the Python file to `.git-blame-ignore-revs`, to allow git blame to correctly show meaningful changes to the file from prior to the reformat. Most tools recognise this file by default, and exclude the commits listed in it when using git blame. However, git itself does not use this file by default. To use this with raw git commands, it can be configured with: ``` git config --global blame.ignoreRevsFile .git-blame-ignore-revs ``` [1]: swiftlang/github-workflows#279
Teemperor
pushed a commit
to Teemperor/swift-mono
that referenced
this pull request
Jul 29, 2026
…ue/PR 1607) GitHub CI runs a Python formatting check with flake8 as part of the soundness check suite. The check was buggy due to flake8's default ignore list being overridden by the config in the workflow definition. This has been fixed in v0.0.12 [1], and the check can now be enabled. This patch removes the configuration value that disabled the check. It also adds the commit that reformatted the Python file to `.git-blame-ignore-revs`, to allow git blame to correctly show meaningful changes to the file from prior to the reformat. Most tools recognise this file by default, and exclude the commits listed in it when using git blame. However, git itself does not use this file by default. To use this with raw git commands, it can be configured with: ``` git config --global blame.ignoreRevsFile .git-blame-ignore-revs ``` [1]: swiftlang/github-workflows#279
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
flake8 disables a number of checks by default, e.g. W503 1 and W504 2, which are conflicting checks and are both not violations of the PEP8 standard. In the flake8 config, the
ignorekey overrides the default ignore list, leading to these issues being raised in CI. Theextend-ignorekey extends the default ignore list instead, allowing these issues to correctly remain suppressed.