You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
341 lines
16 KiB
341 lines
16 KiB
<!doctype html> |
|
<html lang="en"> |
|
<head> |
|
<meta charset="utf-8"> |
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" /> |
|
<meta name="generator" content="pdoc 0.9.2" /> |
|
<title>TermTk.TTkCore.timer API documentation</title> |
|
<meta name="description" content="" /> |
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin> |
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin> |
|
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin> |
|
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style> |
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style> |
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style> |
|
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> |
|
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script> |
|
</head> |
|
<body> |
|
<main> |
|
<article id="content"> |
|
<header> |
|
<h1 class="title">Module <code>TermTk.TTkCore.timer</code></h1> |
|
</header> |
|
<section id="section-intro"> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">#!/usr/bin/env python3 |
|
|
|
# MIT License |
|
# |
|
# Copyright (c) 2021 Eugenio Parodi <ceccopierangiolieugenio AT googlemail DOT com> |
|
# |
|
# Permission is hereby granted, free of charge, to any person obtaining a copy |
|
# of this software and associated documentation files (the "Software"), to deal |
|
# in the Software without restriction, including without limitation the rights |
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
# copies of the Software, and to permit persons to whom the Software is |
|
# furnished to do so, subject to the following conditions: |
|
# |
|
# The above copyright notice and this permission notice shall be included in all |
|
# copies or substantial portions of the Software. |
|
# |
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
# SOFTWARE. |
|
|
|
import threading, time |
|
|
|
from TermTk.TTkCore.constant import TTkK |
|
from TermTk.TTkCore.log import TTkLog |
|
from TermTk.TTkCore.signal import pyTTkSlot, pyTTkSignal |
|
|
|
|
|
class TTkTimer(threading.Thread): |
|
_timers = [] |
|
__slots__ = ( |
|
'timeout', '_timerEvent', |
|
'_delay', '_delayLock', '_quit', |
|
'_stopTime') |
|
def __init__(self): |
|
# Define Signals |
|
self.timeout = pyTTkSignal() |
|
|
|
self._timerEvent = threading.Event() |
|
self._quit = threading.Event() |
|
self._stopTime = 0 |
|
self._delay=0 |
|
self._delayLock = threading.Lock() |
|
threading.Thread.__init__(self) |
|
TTkTimer._timers.append(self) |
|
threading.Thread.start(self) |
|
|
|
@staticmethod |
|
def quitAll(): |
|
for timer in TTkTimer._timers: |
|
timer.quit() |
|
|
|
def quit(self): |
|
self._quit.set() |
|
self._timerEvent.set() |
|
|
|
def run(self): |
|
while self._timerEvent.wait(): |
|
self._timerEvent.clear() |
|
while self._delay > 0: |
|
# self._delayLock.acquire() |
|
delay = self._delay |
|
self._delay = 0 |
|
# self._delayLock.release() |
|
if self._quit.wait(delay): |
|
return |
|
self.timeout.emit() |
|
|
|
@pyTTkSlot(int) |
|
def start(self, sec=0): |
|
self._lastTime = time.time() |
|
self._delay = sec |
|
self._timerEvent.set() |
|
|
|
@pyTTkSlot() |
|
def stop(self): |
|
# TODO: Timer.stop() |
|
self._stopTime = time.time()</code></pre> |
|
</details> |
|
</section> |
|
<section> |
|
</section> |
|
<section> |
|
</section> |
|
<section> |
|
</section> |
|
<section> |
|
<h2 class="section-title" id="header-classes">Classes</h2> |
|
<dl> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer"><code class="flex name class"> |
|
<span>class <span class="ident">TTkTimer</span></span> |
|
</code></dt> |
|
<dd> |
|
<div class="desc"><p>A class that represents a thread of control.</p> |
|
<p>This class can be safely subclassed in a limited fashion. There are two ways |
|
to specify the activity: by passing a callable object to the constructor, or |
|
by overriding the run() method in a subclass.</p> |
|
<p>This constructor should always be called with keyword arguments. Arguments are:</p> |
|
<p><em>group</em> should be None; reserved for future extension when a ThreadGroup |
|
class is implemented.</p> |
|
<p><em>target</em> is the callable object to be invoked by the run() |
|
method. Defaults to None, meaning nothing is called.</p> |
|
<p><em>name</em> is the thread name. By default, a unique name is constructed of |
|
the form "Thread-N" where N is a small decimal number.</p> |
|
<p><em>args</em> is the argument tuple for the target invocation. Defaults to ().</p> |
|
<p><em>kwargs</em> is a dictionary of keyword arguments for the target |
|
invocation. Defaults to {}.</p> |
|
<p>If a subclass overrides the constructor, it must make sure to invoke |
|
the base class constructor (Thread.<strong>init</strong>()) before doing anything |
|
else to the thread.</p></div> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">class TTkTimer(threading.Thread): |
|
_timers = [] |
|
__slots__ = ( |
|
'timeout', '_timerEvent', |
|
'_delay', '_delayLock', '_quit', |
|
'_stopTime') |
|
def __init__(self): |
|
# Define Signals |
|
self.timeout = pyTTkSignal() |
|
|
|
self._timerEvent = threading.Event() |
|
self._quit = threading.Event() |
|
self._stopTime = 0 |
|
self._delay=0 |
|
self._delayLock = threading.Lock() |
|
threading.Thread.__init__(self) |
|
TTkTimer._timers.append(self) |
|
threading.Thread.start(self) |
|
|
|
@staticmethod |
|
def quitAll(): |
|
for timer in TTkTimer._timers: |
|
timer.quit() |
|
|
|
def quit(self): |
|
self._quit.set() |
|
self._timerEvent.set() |
|
|
|
def run(self): |
|
while self._timerEvent.wait(): |
|
self._timerEvent.clear() |
|
while self._delay > 0: |
|
# self._delayLock.acquire() |
|
delay = self._delay |
|
self._delay = 0 |
|
# self._delayLock.release() |
|
if self._quit.wait(delay): |
|
return |
|
self.timeout.emit() |
|
|
|
@pyTTkSlot(int) |
|
def start(self, sec=0): |
|
self._lastTime = time.time() |
|
self._delay = sec |
|
self._timerEvent.set() |
|
|
|
@pyTTkSlot() |
|
def stop(self): |
|
# TODO: Timer.stop() |
|
self._stopTime = time.time()</code></pre> |
|
</details> |
|
<h3>Ancestors</h3> |
|
<ul class="hlist"> |
|
<li>threading.Thread</li> |
|
</ul> |
|
<h3>Static methods</h3> |
|
<dl> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer.quitAll"><code class="name flex"> |
|
<span>def <span class="ident">quitAll</span></span>(<span>)</span> |
|
</code></dt> |
|
<dd> |
|
<div class="desc"></div> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">@staticmethod |
|
def quitAll(): |
|
for timer in TTkTimer._timers: |
|
timer.quit()</code></pre> |
|
</details> |
|
</dd> |
|
</dl> |
|
<h3>Instance variables</h3> |
|
<dl> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer.timeout"><code class="name">var <span class="ident">timeout</span></code></dt> |
|
<dd> |
|
<div class="desc"><p>Return an attribute of instance, which is of type owner.</p></div> |
|
</dd> |
|
</dl> |
|
<h3>Methods</h3> |
|
<dl> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer.quit"><code class="name flex"> |
|
<span>def <span class="ident">quit</span></span>(<span>self)</span> |
|
</code></dt> |
|
<dd> |
|
<div class="desc"></div> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">def quit(self): |
|
self._quit.set() |
|
self._timerEvent.set()</code></pre> |
|
</details> |
|
</dd> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer.run"><code class="name flex"> |
|
<span>def <span class="ident">run</span></span>(<span>self)</span> |
|
</code></dt> |
|
<dd> |
|
<div class="desc"><p>Method representing the thread's activity.</p> |
|
<p>You may override this method in a subclass. The standard run() method |
|
invokes the callable object passed to the object's constructor as the |
|
target argument, if any, with sequential and keyword arguments taken |
|
from the args and kwargs arguments, respectively.</p></div> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">def run(self): |
|
while self._timerEvent.wait(): |
|
self._timerEvent.clear() |
|
while self._delay > 0: |
|
# self._delayLock.acquire() |
|
delay = self._delay |
|
self._delay = 0 |
|
# self._delayLock.release() |
|
if self._quit.wait(delay): |
|
return |
|
self.timeout.emit()</code></pre> |
|
</details> |
|
</dd> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer.start"><code class="name flex"> |
|
<span>def <span class="ident">start</span></span>(<span>self, sec=0)</span> |
|
</code></dt> |
|
<dd> |
|
<div class="desc"><p>Start the thread's activity.</p> |
|
<p>It must be called at most once per thread object. It arranges for the |
|
object's run() method to be invoked in a separate thread of control.</p> |
|
<p>This method will raise a RuntimeError if called more than once on the |
|
same thread object.</p></div> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">@pyTTkSlot(int) |
|
def start(self, sec=0): |
|
self._lastTime = time.time() |
|
self._delay = sec |
|
self._timerEvent.set()</code></pre> |
|
</details> |
|
</dd> |
|
<dt id="TermTk.TTkCore.timer.TTkTimer.stop"><code class="name flex"> |
|
<span>def <span class="ident">stop</span></span>(<span>self)</span> |
|
</code></dt> |
|
<dd> |
|
<div class="desc"></div> |
|
<details class="source"> |
|
<summary> |
|
<span>Expand source code</span> |
|
</summary> |
|
<pre><code class="python">@pyTTkSlot() |
|
def stop(self): |
|
# TODO: Timer.stop() |
|
self._stopTime = time.time()</code></pre> |
|
</details> |
|
</dd> |
|
</dl> |
|
</dd> |
|
</dl> |
|
</section> |
|
</article> |
|
<nav id="sidebar"> |
|
<h1>Index</h1> |
|
<div class="toc"> |
|
<ul></ul> |
|
</div> |
|
<ul id="index"> |
|
<li><h3>Super-module</h3> |
|
<ul> |
|
<li><code><a title="TermTk.TTkCore" href="index.html">TermTk.TTkCore</a></code></li> |
|
</ul> |
|
</li> |
|
<li><h3><a href="#header-classes">Classes</a></h3> |
|
<ul> |
|
<li> |
|
<h4><code><a title="TermTk.TTkCore.timer.TTkTimer" href="#TermTk.TTkCore.timer.TTkTimer">TTkTimer</a></code></h4> |
|
<ul class="two-column"> |
|
<li><code><a title="TermTk.TTkCore.timer.TTkTimer.quit" href="#TermTk.TTkCore.timer.TTkTimer.quit">quit</a></code></li> |
|
<li><code><a title="TermTk.TTkCore.timer.TTkTimer.quitAll" href="#TermTk.TTkCore.timer.TTkTimer.quitAll">quitAll</a></code></li> |
|
<li><code><a title="TermTk.TTkCore.timer.TTkTimer.run" href="#TermTk.TTkCore.timer.TTkTimer.run">run</a></code></li> |
|
<li><code><a title="TermTk.TTkCore.timer.TTkTimer.start" href="#TermTk.TTkCore.timer.TTkTimer.start">start</a></code></li> |
|
<li><code><a title="TermTk.TTkCore.timer.TTkTimer.stop" href="#TermTk.TTkCore.timer.TTkTimer.stop">stop</a></code></li> |
|
<li><code><a title="TermTk.TTkCore.timer.TTkTimer.timeout" href="#TermTk.TTkCore.timer.TTkTimer.timeout">timeout</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</nav> |
|
</main> |
|
<footer id="footer"> |
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p> |
|
</footer> |
|
</body> |
|
</html> |