Pre-commit hooks run automated checks before changes are committed, such as formatting, linting and whitespace validation.
Understanding the Concept
Pre-commit hooks run automated checks before changes are committed, such as formatting, linting and whitespace validation. The pre-commit framework uses a .pre-commit-config.yaml file and must be installed separately.
Example setup: install pre-commit; create a reviewed .pre-commit-config.yaml; run pre-commit install and pre-commit run --all-files.
How this fits into a real test suite
A reliable test starts with a specific expected behavior. Keep the fixture small, arrange the input, call the real code, and assert a result the reader can verify. Add one boundary or failure case so the test does not pass only for a convenient example. In a larger project, run the same test automatically after each change.
Tests are repeatable experiments. Use temporary resources and injected dependencies where possible; when the environment is part of the requirement, add a separate integration test rather than weakening the unit test.
Worked Example
Read the code from the first line to the last. Identify which values are inputs, which operation is being demonstrated and what should happen before running it.
def normalized_label(label: str) -> str:
return label.strip().lower()
print(normalized_label(' OPEN '))Walkthrough: What Each Part Does
- The definition normalized_label creates reusable behavior. Its body runs when called, awaited or instantiated; defining it alone does not run the body of an ordinary function.
- The final check compares actual behavior with an explicit expectation. A successful test tells you that this particular case passed, not that every possible input works.
This demonstration focuses on one practical behavior. Before changing several lines, vary one input or one configuration choice and check whether the result changes for the reason you expected.
The example uses terminal, platform, external tool or process behavior that was not exercised automatically. Run it only in a suitable environment after reviewing the shown permissions and paths.
Important Behavior and Edge Cases
Treating pre-commit as a replacement for CI or trusting a hook configuration from an unknown source without review.
Example setup: install pre-commit; create a reviewed .pre-commit-config.yaml; run pre-commit install and pre-commit run --all-files.
Practice Exercise
Create a small Python example and describe how to apply a formatter hook to it.
Write down the result you expect before running your changed code. Check at least one normal case and one boundary or failure case. If your example starts workers or opens resources, verify how they are cleaned up.
Further reading: official documentation and API reference.
Common Beginner Mistakes
- Treating pre-commit as a replacement for CI or trusting a hook configuration from an unknown source without review.
- Writing assertions that check implementation details but fail to validate the behavior that matters to the caller.
Key Takeaways
- Pre-commit hooks run automated checks before changes are committed, such as formatting, linting and whitespace validation.
- Example setup: install pre-commit; create a reviewed .pre-commit-config.yaml; run pre-commit install and pre-commit run --all-files.
- Practice: Create a small Python example and describe how to apply a formatter hook to it.