Timer objects in Python

In Python, Timer is a subclass of Thread class. Calling the start() method, the timer starts. Timer objects are used to create some actions which are bounded by the time period. Using timer object create some threads that carries out some actions. The Timer is stopped using the cancel() method.

How to create a Timer object

Following is how you can create a Timer object in Python ?

<span class="pln">threading</span><span class="pun">.</span><span class="typ">Timer</span><span class="pun">(</span><span class="pln">interval</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pun">,</span><span class="pln"> args </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">None</span><span class="pun">,</span><span class="pln"> kwargs </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">None</span><span class="pun">)</span>

Starting a Timer

The timer.start() is used for start the timer. Here?s an example ?

Example

<div class="execute"></div><div class="code-mirror  language-python" contenteditable="plaintext-only" spellcheck="false" style="outline: none; overflow-wrap: break-word; overflow-y: auto; white-space: pre-wrap;"><span class="token keyword">import</span> threading

<span class="token comment"># All the text displays after 3 seconds</span>
<span class="token keyword">def</span> <span class="token function">mytimer</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
	<span class="token keyword">print</span><span class="token punctuation">(</span><span class="token string">"Demo Python Program\n"</span><span class="token punctuation">)</span>

my_timer <span class="token operator">=</span> threading<span class="token punctuation">.</span>Timer<span class="token punctuation">(</span><span class="token number">3.0</span><span class="token punctuation">,</span> mytimer<span class="token punctuation">)</span>
my_timer<span class="token punctuation">.</span>start<span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token keyword">print</span><span class="token punctuation">(</span><span class="token string">"Bye\n"</span><span class="token punctuation">)</span>
</div><div class="output-wrapper"><div class="console-close"></div><div class="code-output"></div></div>

Output

Bye

Demo Python Program

Cancelling a Timer

The timer.cancel() is used for cancelling the timer. Here?s an example ?

Example

<div class="execute"></div><div class="code-mirror  language-python" contenteditable="plaintext-only" spellcheck="false" style="outline: none; overflow-wrap: break-word; overflow-y: auto; white-space: pre-wrap;"><span class="token keyword">import</span> threading

<span class="token keyword">def</span> <span class="token function">mytimer</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
	<span class="token keyword">print</span><span class="token punctuation">(</span><span class="token string">"Demo Python Program\n"</span><span class="token punctuation">)</span>

my_timer <span class="token operator">=</span> threading<span class="token punctuation">.</span>Timer<span class="token punctuation">(</span><span class="token number">3.0</span><span class="token punctuation">,</span> mytimer<span class="token punctuation">)</span>
my_timer<span class="token punctuation">.</span>start<span class="token punctuation">(</span><span class="token punctuation">)</span>

<span class="token keyword">print</span><span class="token punctuation">(</span><span class="token string">"Cancelling timer\n"</span><span class="token punctuation">)</span>
my_timer<span class="token punctuation">.</span>cancel<span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token keyword">print</span><span class="token punctuation">(</span><span class="token string">"Bye\n"</span><span class="token punctuation">)</span>
</div><div class="output-wrapper"><div class="console-close"></div><div class="code-output"></div></div>

Output

Cancelling timer

Bye