Add pre-commit hooks for flake8 #465
Merged
Conversation
This file contains 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
jonasdn
force-pushed
the
jonasdn/pre-commit-flake8
branch
from
0b53e93 to
7a73bc5
Compare
Using the pre-commit framework we can have automatic flake8 checks upon
commit. The pre-requsite is that the developer has run:
$ pre-commit install
To install the hooks found in .pre-commit-config.yaml. This could be
automated through setup.py later if wanted.
This commit adds a pre-commit hook that runs flake8 on the proposed
change.
An example session:
$ git diff src/
diff --git a/src/cfclient/ui/dialogs/about.py
b/src/cfclient/ui/dialogs/about.py
index 904b590..ffa5e75 100644
--- a/src/cfclient/ui/dialogs/about.py
+++ b/src/cfclient/ui/dialogs/about.py
@@ -172,8 +172,7 @@ class AboutDialog(QtWidgets.QWidget,
about_widget_class):
self._input_readers_text = ""
# readers =
self._helper.inputDeviceReader.getAvailableDevices()
for reader in
cfclient.utils.input.inputreaders.initialized_readers:
- self._input_readers_text += INPUT_READER_FORMAT.format(
- reader.name, len(reader.devices()))
+ self._input_readers_text +=
INPUT_READER_FORMAT.format(reader.name,
len(reader.devices()))
if len(self._input_readers_text) == 0:
self._input_readers_text = "None<br>"
$ git add src/cfclient/ui/dialogs/about.py
$ git commit
[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to
/home/jonas/.cache/pre-commit/patch1610697747.
flake8...................................................................Failed
- hook id: flake8
- exit code: 1
src/cfclient/ui/dialogs/about.py:175:80: E501 line too long (102 > 79
characters)
[INFO] Restored changes from
/home/jonas/.cache/pre-commit/patch1610697747.
jonasdn
force-pushed
the
jonasdn/pre-commit-flake8
branch
from
7a73bc5 to
baf7f0e
Compare
The library uses pre-commit hooks and a verify script to do the flak8 linting. Let's to the same here.
jonasdn
force-pushed
the
jonasdn/pre-commit-flake8
branch
from
baf7f0e to
ac4ca47
Compare
|
Looks good to me and is a very handy feature to have! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Using the pre-commit framework we can have automatic flake8 checks upon commit. The prerequisite is that the developer has run:
To install the hooks found in
.pre-commit-config.yaml. This could be automated through setup.py later if wanted. This commit adds a pre-commit hook that runs flake8 on the proposed change.An example session: