- Home
- Documentation Generators
- unittest
unittest
What it is
unittest is Python’s free unit-testing framework for test automation, shared setup and cleanup, test collection, and reporting independent of the reporting framework. Its building blocks include fixtures, TestCase, TestSuite, and test runners. TestCase provides assertions such as assertEqual, assertTrue, assertFalse, and assertRaises for recording outcomes. Tests can run from the command line by module, class, method, or file path; running without arguments starts discovery. Discovery can be configured with a start directory, filename pattern, and project top-level directory. The framework supports conditional or unconditional skipping, expected failures, and subtests that report parameters when an iteration fails. unittest.mock can replace parts of the system under test with mock objects and check their use. Production tests can be driven through Buildbot, Jenkins, GitHub Actions, or AppVeyor. It supports Python on Linux, macOS, and Windows. Python is distributed under an OSI-approved open-source license and may be used commercially. Discovery requires test files to be importable modules or packages from the project top level.
For and against
For
- Free for commercial use
- Built-in fixtures and test runners
- Command-line discovery and execution
- Mock support through unittest.mock
- Subtests and expected failures
Against
- Discovery requires importable test modules
- Supports Python only
The verdict
unittest provides Python projects with a standard framework for organizing, running, and checking tests. Its discovery importability requirement is the main setup constraint described here.
Who it suits
unittest suits Python developers who need built-in test organization, assertions, discovery, mocks, and command-line execution. It works across Linux, macOS, and Windows and can feed continuous-integration systems.
Plans and prices
Free
Python standard library unit testing framework · no separate unittest price stated
Read 9 Oct 2026 · python.org
On the record
- Assertions
- TestCase includes assertion methods such as assertEqual, assertTrue, assertFalse, and assertRaises to record test outcomes.docs.python.org · read 9 Oct 2026
- Command line
- Tests can be run from the command line by module, class, method, or file path, and running without arguments starts test discovery.docs.python.org · read 9 Oct 2026
- Compatibility limitation
- Test discovery requires test files to be importable modules or packages from the project top-level directory.docs.python.org · read 9 Oct 2026
- Integrations
- The documentation recommends driving production tests with continuous integration systems such as Buildbot, Jenkins, GitHub Actions, or AppVeyor.docs.python.org · read 9 Oct 2026
- Maintainer organization
- The Python Software Foundation says it supports and maintains Python documentation, python.org, PyPI, and other services used by the Python community.python.org · read 9 Oct 2026
- Mock support
- The documentation points to unittest.mock as a library for replacing parts of a system under test with mock objects and making assertions about their use.docs.python.org · read 9 Oct 2026
- Purpose
- unittest is a unit testing framework that supports test automation, setup and cleanup sharing, test collection, and independence from the reporting framework.docs.python.org · read 9 Oct 2026
- Security and license
- Python is developed under an OSI-approved open source license and is freely usable and distributable, including commercially.python.org · read 9 Oct 2026
- Skipping and expected failures
- Tests and classes can be skipped conditionally or unconditionally, and tests can be marked as expected failures.docs.python.org · read 9 Oct 2026
- Subtests
- The subTest context manager distinguishes iterations within a test method and reports parameters when a subtest fails.docs.python.org · read 9 Oct 2026
- Test building blocks
- It provides fixtures, TestCase, TestSuite, and test runners for organizing and executing tests.docs.python.org · read 9 Oct 2026
- Test discovery
- The framework supports discovery from a project directory and provides options to set the start directory, filename pattern, and project top-level directory.docs.python.org · read 9 Oct 2026
