Black formats Python code consistently, while Ruff can provide fast linting and formatting.
Understanding the Concept
Black formats Python code consistently, while Ruff can provide fast linting and formatting. Teams should choose one formatting policy to avoid unnecessary changes and conflicts.
Install tools in a virtual environment and use python -m black . or ruff format . as configured.
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 summarize_items(item_counts: list[int]) -> int:
return sum(item_counts)
print(summarize_items([1, 3, 4]))Walkthrough: What Each Part Does
- The definition summarize_items 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
Running two different formatters with incompatible settings on every save.
Install tools in a virtual environment and use python -m black . or ruff format . as configured.
Practice Exercise
Format a small project and inspect the resulting diff before committing.
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
- Running two different formatters with incompatible settings on every save.
- Writing assertions that check implementation details but fail to validate the behavior that matters to the caller.
Key Takeaways
- Black formats Python code consistently, while Ruff can provide fast linting and formatting.
- Install tools in a virtual environment and use python -m black . or ruff format . as configured.
- Practice: Format a small project and inspect the resulting diff before committing.