marcogorelli/madforhooks

Random assorted pre-commit hooks

MadForHooks

Random assorted pre-commit hooks.

Usage

Put this in the repos section of your .pre-commit-config.yaml file:

-   repo: https://github.com/MarcoGorelli/madforhooks
    rev: 0.4.1
    hooks:
    -   id: conda-env-sorter
    -   id: no-print-statements
    -   id: check-execution-order
    -   id: check-test-naming

Or, from the commandline:

pip install madforhooks
python -m madforhooks.check_execution_order file1.ipynb file2.ipynb file3.ipynb

Example of how to run check-test-naming on your test directory:

git ls-files | xargs python -m madforhooks.check_test_naming

Hooks available

conda-env-sorter

Sort the dependencies in your conda environment file(s).

no-print-statements

Raise if print statements are found (unless they have file=).

check-execution-order

Raise if notebook cells were executed out-of-order. Use --strict to ensure strict monotonicity.

check-test-naming

Check that test names start with test. This is useful for finding tests which are meant to be running in CI, but which don't because they are misnamed.

If there are any false positives, you prevent this tool from flagging them by adding a # not a test comment one the line where the function/class is defined.

madforhooks's Issues

Not working when the yml file contains a "pip" term.

Without the "pip" term, it works like a charm!
However, when the yml file contains a "pip" term in it, it raises an error.

Example:

# environment.yml

name: xx
channels:
- defaults
dependencies:
- python=3.8
- pip:
    - transformers

raise an error:
TypeError: '<' not supported between instances of 'CommentedMap' and 'str'

Conda env sorter creates newline on Windows

hi, @MarcoGorelli,
every time I run the pre-commit run --all for PyMC on my Windows machine, the conda env sorter modifies these three environment yamls:

Interestingly it doesn't do that for the other environment yamls. The comments in those is different, but more importantly the ones being modified contain a pip: section and the others don't.
Since the pre-commit runs fine in CI I guess it has to do with how line endings are treated in the handling of these pip: sections.