FFpy 1.6.2

Background 🚀

As an undergraduate software engineer with Python as my weapon of choice for coding, I often found myself curious about the execution time of my scripts. While solutions like timeit module exist, I wanted a seamless way to measure execution time without adding another line of code to my programs. This led to the creation of FFpy.

In my coding journey, especially while tackling Data Structures and Algorithms problems and optimizing code, understanding the execution time can provide valuable insights.

FFpy aims to be a simple yet powerful tool for easily benchmarking performance without the need to modify your existing codebase. I believe in keeping things straightforward. FFpy is designed to be a minimalistic, no-nonsense module that integrates seamlessly into your workflow, allowing you to focus on coding while effortlessly obtaining execution time metrics.

Installation 🛠️

Install FFpy using pip:

pip install ffpy

Alternatively, you can clone this repository:

git clone https://github.com/anxkhn/FFpy.git
cd FFpy
pip install .

Usage 🚨

After installation, you can use FFpy to measure the execution time of your Python scripts. Here’s the basic syntax:

ffpy <filename.py/folder> <filename2.py> [-u <unit>] [-n <num_runs>] [-s] [-m <mode>] [-v] [-h]

• <filename.py/folder>: Replace with the actual filename or folder of your Python script(s) in the current directory.

• <filename2.py>: Optional second script for comparison.

• -u, --unit: Optional flag to specify the time unit (ms or s, default is ms).

• -n, --number: Optional flag to specify the number of runs (default is 1).

• -s, --silent: Optional flag to run the script silently (suppress output).

• -m, --mode: Optional flag to specify the threads (single or multi, default is single).

• -v, --version: Display script version.

• -h, --help: Display help message.

ffpy script.py

ffpy script.py -u s

ffpy script.py -n 10

ffpy script.py -s

ffpy script.py -m multi

Types of Operation:

• Single File: Measure the execution time of a single script.

ffpy script1.py -s

Output:

Execution time: 30.1924 ms

• Double File (Comparison): Compare the execution times of two scripts and determine the percentage difference.

2. Compare the execution times of two scripts:

ffpy script1.py script2.py -s

Output:

script1.py
Execution time: 29.2735 ms
script2.py
Execution time: 533.9346 ms
script1.py is 1723.95% faster than script2.py

• More Than Two Files (Detailed Table): Compare execution times of multiple scripts and display a detailed table with filenames and average execution times.

3. Compare execution times of multiple scripts and display a detailed table:

ffpy script1.py script2.py script3.py -s

or

ffpy path/to/scripts

Output:

script1.py
Execution time: 30.0028 ms
script2.py
Execution time: 533.4799 ms
script3.py
Execution time: 1035.9304 ms
╒════════════╤═══════════════════════════════╕
│ Filename   │   Average Execution Time (ms) │
╞════════════╪═══════════════════════════════╡
│ script1.py │                       30.0028 │
├────────────┼───────────────────────────────┤
│ script2.py │                      533.48   │
├────────────┼───────────────────────────────┤
│ script3.py │                     1035.93   │
╘════════════╧═══════════════════════════════╛

print("Hello, FFpy!")

ffpy hello.py

Hello, FFpy!
Execution time: XX.XX ms

ffpy merge_sort.py bubble_sort.py --silent

merge_sort.py
Execution time: 33.2839 ms
bubble_sort.py
Execution time: 65.3996 ms
merge_sort.py is 96.49% faster than bubble_sort.py.

Contributing 🤝

If you’d like to contribute to FFpy, feel free to fork the repository and submit a pull request.

License 📜

This project is licensed under the GPLv3 License - check out this website for more information.