Start and Stop Timer#
Timer(thread=None, decimals=2)
#
Main class to create a Timer instance. If not using the class with a with
statement as context manager, remember that a timer.start()
should always be followed by timer.stop()
later in the code.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
thread | str | None | Option to start new thread. | None |
decimals | int | None | Option to define decimals for output. Minimum | 2 |
Example
Basic usage:
Python | |
---|---|
1 2 3 4 5 6 7 8 |
|
Or with a with
statement as context manager:
Python | |
---|---|
1 2 3 4 |
|
In both cases, the terminal output example is the same:
Elapsed time: 12.34 seconds
With custom thread name and decimals:
Python | |
---|---|
1 2 3 4 5 6 7 8 |
|
Or with a with
statement as context manager:
Python | |
---|---|
1 2 3 4 |
|
As before, the terminal will output the same result in both cases:
% Elapsed time: 0.12345 seconds for thread CUSTOM
start(thread=None, decimals=None)
#
Starts the Timer. Should always be followed by timer.stop()
later in the code.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
thread | str | None | Option to start new thread. | None |
decimals | int | None | Option to define decimals for output. Minimum | None |
Example
Basic usage:
Python | |
---|---|
1 2 3 4 5 6 7 8 |
|
How it appears in the terminal:
Elapsed time: 12.34 seconds
With custom thread name and decimals:
Python | |
---|---|
1 2 3 4 5 6 7 8 |
|
How it appears in the terminal:
% Elapsed time: 0.12345 seconds for thread CUSTOM
stop(thread=None)
#
Stops the Timer. Should always be called after timer.start()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
thread | str | None | Option to stop specific thread. | None |
Example
Basic usage:
Python | |
---|---|
1 2 3 4 5 6 7 8 |
|
How it appears in the terminal:
Elapsed time: 12.34 seconds
With custom thread name and decimals:
Python | |
---|---|
1 2 3 4 5 6 7 8 |
|
How it appears in the terminal:
% Elapsed time: 0.12345 seconds for thread CUSTOM