https://github.com/junnyyy/python-unit-tests
Python Unit Test Example
https://github.com/junnyyy/python-unit-tests
python testing unit-testing unittest
Last synced: 9 months ago
JSON representation
Python Unit Test Example
- Host: GitHub
- URL: https://github.com/junnyyy/python-unit-tests
- Owner: Junnyyy
- Created: 2024-02-13T00:15:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-16T03:52:43.000Z (over 2 years ago)
- Last Synced: 2025-09-11T13:32:10.654Z (10 months ago)
- Topics: python, testing, unit-testing, unittest
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Python Unit Testing Example
This is a simple example of how to use Python's built-in `unittest` module to write and run unit tests.
Interleave string solution is from my own Leetcode [submission](https://leetcode.com/problems/interleaving-string/submissions/856314608).
## Quick Start
- To run the tests and downloaded required packages:
```bash
sh build.sh
```
- Example of Canary and regular tests are in `./tests/interleave_tests.py`
- Expected result is
```bash
Ran 5 tests in 0.000s
OK
```
## Structure
- `build.sh`: This script installs required pip packages and runs the tests using "python3."
- `requirements.txt`: This file is used by pip to install packages. If you require any packages, you can add them here.
- `src`: This directory contains your source files, i.e., your code.
- `tests`: All your tests are located here.
## Testing
`unittest` is the preinstalled Python testing library. There are alternatives you may consider, such as Pytest. Running the test is as simple as:
```bash
python -m unittest [directory]
```
If you prefer a more verbose output, add `-v`:
```bash
python -m unittest -v [directory]
```
## Packages
For most, pip is your go-to for packages. For those coming from JavaScript, there isn't a `package.json`; the alternative is `requirements.txt`. You can include any required packages in this file, and anyone using pip can install them simply.
Example `requirements.txt`:
```makefile
pip==22.3.1
wheel==0.38.4
Pillow==9.5.0
setuptools==65.5.1
packaging==23.1
numpy==1.26.0
```
To install the packages, it is as simple as:
```bash
pip install -r requirements.txt
```
---
Have fun! If you find a mistake or an improvement, please drop a pull request and let me know!