Pre-commit Hooks

[SagiPolaczek]

Hello Fusers!

Recently we (thanks @ishita1805 ) added the support of pre-commit hooks to ease the use of black, flake8 and mypy.
The pre-commit hook scripts are useful for identifying and fix simple issues format before submission to code review. So next time you won't be needed to remember to black the code before pushing that commit.

Installation:

First make sure you have the pre-commit module:

pip install pre-commit

Now Install the git hook scripts:

pre-commit install

Usage:

The hook script will run automatically when running a commit.

Example for a successful commit:

check for case conflicts.................................................Passed
fix end of files.........................................................Passed
mixed line ending........................................................Passed
trim trailing whitespace.................................................Passed
black....................................................................Passed
flake8...................................................................Passed
mypy.....................................................................Passed

Example for a failure:

check for case conflicts.................................................Passed
fix end of files.........................................................Passed
mixed line ending........................................................Passed
trim trailing whitespace.................................................Passed
black....................................................................Failed
- hook id: black
- files were modified by this hook

reformatted examples/fuse_examples/imaging/classification/isic/isic_runner.py

All done! ✨ 🍰 ✨
1 file reformatted, 1 file left unchanged.

flake8...................................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

fuseimg/datasets/isic.py:394:5: error: Function is missing a return type annotation
fuseimg/datasets/isic.py:419:5: error: Function is missing a return type annotation
fuseimg/datasets/isic.py:450:5: error: Function is missing a return type annotation
fuseimg/datasets/isic.py:464:5: error: Function is missing a return type annotation
Found 4 errors in 1 file (checked 2 source files)

Happy Researching 🔬