Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 3.98 KB

README.ru.md

File metadata and controls

47 lines (38 loc) · 3.98 KB

measurer

Measurer - простой в использовании пакет для изучения и сравнения компонентов программ.

Установка

Пакет устанавливается через через pip с командой: pip install function_measurer

Быстрый старт

Давайте посмотрим на пример использования этого пакета:

from measurer import SetTesting

@SetTesting(2, 2)
def summ(a: int, b: int): 
    return a + b

У нас есть функция, которую мы хотим протестировать. Для этого мы используем декоратор SetTesting. Аргументы, которые передаются декоратору при тестировании передаются функции summ. Сохраним файл с названием sample.py. Открываем консоль и вводим: python -m measurer sample.py 3 memory И получаем:

┏━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Tests.  ┃ Functions. ┃ Iteration 1.                ┃ Iteration 2.               ┃ Iteration 3.               ┃ Average.                   ┃
┡━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ runtime │ summ       │ 1.4030001693754457e-06, sec │ 9.129998943535611e-07, sec │ 7.439994078595191e-07, sec │ 1.019999823862842e-06, sec │
│ memory  │ summ       │ 208, b                      │ 208, b                     │ 208, b                     │ 208.0, b                   │
└─────────┴────────────┴─────────────────────────────┴────────────────────────────┴────────────────────────────┴────────────────────────────┘

Подробное описание использования

В нашем примере пакету передаётся три аргумента: первый (sample.py) - путь к тестируемому файлу, второй (3) - количество раз, которое тест должен быть проведён, третий (memory) тип теста, проводимый компонентами программы. Можно указывать несколько типов тестов. Существующие виды тестов:

Тест. Описание.
runtime Измеряет время исполнения.
memory Измеряет объём занимаемой памяти.

Если лень каждый раз писать аргументы при вызове можно записать их в файл и передать путь к нему после символа @. Если вы что-то не поняли попытайтесь использовать аргумент -h.