Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding pre-commit configuration #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding pre-commit configuration #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.1.0
hooks:
- id: check-ast
- id: check-case-conflict
- id: check-merge-conflict
- id: mixed-line-ending
args: [--fix, lf]
- id: name-tests-test
args: [--django]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

args: [--django] looks like a copy and paste error, since all the test files are named *Test.py and not test*.py as --django assumes.

Anyhow, the default option would not work as well. See https://github.com/pre-commit/pre-commit-hooks#name-tests-test

Copy link
Contributor Author

@icezyclon icezyclon Jan 26, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically, as long as the naming convention of test files is fixed, the testrunner can then find them using the -p PATTERN argument during unit test discovery. The default is test*.py and the --django option also matches test*.py. That was why I chose this. But the default name-tests-test can also be used by just providing the -p *_test.py argument to the unit test command.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We would have to potentially rename the tests once this decision is made.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

I believe that before enabling precommit test themself should be changed.
As majority of tests encompass the whole learning procedure, few dozen times. And that can be quite time consuming, especially for stochastic learning. That is on a TODO list for some time now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can keep the procedure tests, those can be useful, but separate them from the fast unit tests.
Then you can have both: quick checks on commit and extensive functionality tests when you feel like it or when you make a big change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea.
It will be like that then. Now "only" thing left to do is to write unit tests 👯

- repo: local
hooks:
- id: unittest
name: unittest
entry: python -m unittest discover
language: python
types: [python]
pass_filenames: false
stages: [commit]
additional_dependencies: [pydot]
always_run: true
Empty file added tests/__init__.py
View file
Open in desktop
Empty file.