153 lines
19 KiB
HTML
153 lines
19 KiB
HTML
<!doctype html>
|
|
<html lang="en"><head><script src="/livereload.js?mindelay=10&v=2&port=1313&path=livereload" data-no-instant defer></script>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<link rel="shortcut icon" href="http://localhost:1313/favicon.ico">
|
|
<link id="stylesheet" rel="stylesheet" href="/css/light.css">
|
|
|
|
<link rel="canonical" href="http://localhost:1313/learning-about-qtile-widgets-with-cricket/" />
|
|
<title>Learning about qtile widgets with cricket</title>
|
|
</head>
|
|
<body><header id="banner">
|
|
<nav class="navbar">
|
|
<div class="nav-left">
|
|
|
|
<a href="http://localhost:1313/" class="home">~ 🏠</a>
|
|
|
|
<a
|
|
href="/info/"
|
|
title="--help"
|
|
>--help</a
|
|
>
|
|
</div>
|
|
<div class="nav-right">
|
|
|
|
<button id="toggle-button" class="toggle-button" onclick="toggleTheme()">🌚</button>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
<main id="content">
|
|
<article>
|
|
<header id="post-header">
|
|
<h3>Learning about qtile widgets with cricket</h3>
|
|
<div>
|
|
<time>April 3, 2023</time>
|
|
</div>
|
|
</header><p>I’m a person who has spent an unreasonable amount of time making minute changes to the appearance of my bar in qtile. Despite the very nice selection of widgets availabe by default with qtile, it was only a matter of time before I decided I wanted to experiment with making my own custom widget. Fortunately, if you can do a bit of python this is quite an approachable undertaking.</p>
|
|
<p>The dream widget I was lacking was a little live crikcet score ticker type thing; something which would scroll along on my bar showing me the score in live cricket matches. I’m sure this will interest very few people but I learnt some good stuff along the way.</p>
|
|
<h3 id="hello-world">Hello World?!</h3>
|
|
<p>As far as I can tell from looking at the code for some of the <a href="https://github.com/qtile/qtile/tree/master/libqtile/widget">built-in widgets</a> and <a href="https://docs.qtile.org/en/latest/manual/howto/widget.html">this very helpful guide</a>, a basic hello world widget would look something like this.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">libqtile.widget</span> <span class="kn">import</span> <span class="n">base</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="k">class</span> <span class="nc">HelloWorld</span><span class="p">(</span><span class="n">base</span><span class="o">.</span><span class="n">_TextBox</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">config</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="o">**</span><span class="n">config</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="bp">self</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="s1">'Hello world!'</span>
|
|
</span></span></code></pre></div><p>Qtile provides a selection of base widget classes to do various useful things. This example uses the simple <code>_TextBox</code> which displays the content of the <code>self.text</code> property.</p>
|
|
<h3 id="hello-world-version-2">Hello World Version 2</h3>
|
|
<p>Very nice, but for the cricket widget we’ll need something which lets us update the text. The answer is <code>ThreadPoolText</code>. This class lets you periodically update the text by overridding its <code>poll</code> method with a function that returns the updated text.</p>
|
|
<p>This example updates itself with hello world in a different language every five seconds.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">random</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="k">class</span> <span class="nc">HolaMundo</span><span class="p">(</span><span class="n">base</span><span class="o">.</span><span class="n">ThreadPoolText</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="n">defaults</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="s2">"update_interval"</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="s2">"Update interval for the widget"</span><span class="p">),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">config</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="o">**</span><span class="n">config</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="bp">self</span><span class="o">.</span><span class="n">add_defaults</span><span class="p">(</span><span class="n">HolaMundo</span><span class="o">.</span><span class="n">defaults</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="k">def</span> <span class="nf">poll</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">messages</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s1">'Hola mundo'</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s1">'Ciao mondo'</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s1">'مرحبا بالعالم'</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s1">'Saluton Mondo'</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s1">'Sawubona Mhlaba'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">messages</span><span class="p">)</span>
|
|
</span></span></code></pre></div><p>Along with the whole poll thing, this example also introduces <code>defaults</code>. This is a list of tuples which define parameters that the user can configure. Here we’ve added <code>update_interval</code> which defines how often the widget is updated.</p>
|
|
<h3 id="cricket-scores">Cricket Scores</h3>
|
|
<p>For getting the cricket scores we’ll be using a handy rss feed from cricinfo so no brute force scraping will be required, just my beloved <a href="https://pypi.org/project/feedparser/">feedparser</a>. This doesn’t involve anything directly widget related, just massaging the rss feed into something that would look useful on your bar. Anyway, this is what the finished item looked like.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">libqtile.widget</span> <span class="kn">import</span> <span class="n">base</span>
|
|
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">feedparser</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="k">class</span> <span class="nc">CricketScores</span><span class="p">(</span><span class="n">base</span><span class="o">.</span><span class="n">ThreadPoolText</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="n">defaults</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="s2">"update_interval"</span><span class="p">,</span> <span class="mi">60</span><span class="p">,</span> <span class="s2">"Update interval for the cricket scores widget"</span><span class="p">),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="s2">"teams"</span><span class="p">,[],</span><span class="s2">"Teams to display scores for"</span><span class="p">),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="s2">"separator"</span><span class="p">,</span><span class="s2">" </span><span class="se">\U0001F3CF</span><span class="s2"> "</span><span class="p">,</span><span class="s2">"Text to place between scores"</span><span class="p">),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="s2">"no_scores_string"</span><span class="p">,</span><span class="s2">""</span><span class="p">,</span><span class="s2">"Text to show when there are no scores to show"</span><span class="p">),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">config</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="o">**</span><span class="n">config</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="bp">self</span><span class="o">.</span><span class="n">add_defaults</span><span class="p">(</span><span class="n">CricketScores</span><span class="o">.</span><span class="n">defaults</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="k">def</span> <span class="nf">get_scores</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="c1"># parse rss feed and get </span>
|
|
</span></span><span class="line"><span class="cl"> <span class="c1"># live matches from title field</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">feed</span> <span class="o">=</span> <span class="n">feedparser</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s2">"http://static.cricinfo.com/rss/livescores.xml"</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">scores</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="k">match</span> <span class="ow">in</span> <span class="n">feed</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="c1"># filter live matches</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="s2">"*"</span> <span class="ow">in</span> <span class="k">match</span><span class="o">.</span><span class="n">title</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">scores</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="k">match</span><span class="o">.</span><span class="n">title</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="c1"># remove scores not involving chosen teams</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">filtered_scores</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">score</span> <span class="ow">in</span> <span class="n">scores</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">team</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">teams</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="n">team</span> <span class="ow">in</span> <span class="n">score</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">filtered_scores</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">score</span><span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="c1"># if no scores, show no_scores_string</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">filtered_scores</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">no_scores_string</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">else</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="c1"># form pretty string with separators</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">final_scores</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">score</span> <span class="ow">in</span> <span class="n">filtered_scores</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="n">score</span> <span class="o">!=</span> <span class="n">filtered_scores</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">final_scores</span> <span class="o">+=</span> <span class="n">score</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">else</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">final_scores</span> <span class="o">+=</span> <span class="n">score</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">final_scores</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> <span class="k">def</span> <span class="nf">poll</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">get_scores</span><span class="p">()</span>
|
|
</span></span></code></pre></div><h3 id="actaully-using-it-in-your-config">Actaully Using It In Your Config</h3>
|
|
<p>Assuming you have a <code>my_widget.py</code> file in the same directory as your <code>config.py</code>, you simply have to import it and add it your list of widgets.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">my_widget</span> <span class="kn">import</span> <span class="n">LovelyWidget</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="n">screens</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">Screen</span><span class="p">(</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">top</span> <span class="o">=</span> <span class="n">bar</span><span class="o">.</span><span class="n">Bar</span><span class="p">(</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">widgets</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">LovelyWidget</span><span class="p">(),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="n">widget</span><span class="o">.</span><span class="n">GroupBox</span><span class="p">(),</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">]</span>
|
|
</span></span></code></pre></div><p>Happy widget writing.</p>
|
|
</article>
|
|
</main>
|
|
|
|
<footer id="footer">
|
|
<p>-----------------</p>
|
|
<small>
|
|
made with <a href="https://gohugo.io">hugo</a> and my bastardised version of
|
|
<a href="https://github.com/LukasJoswiak/etch">this nice theme</a>
|
|
</small>
|
|
|
|
<script src="/js/search.js"></script>
|
|
<script src="/js/toggle.js"></script>
|
|
</footer>
|
|
|
|
</body>
|
|
</html>
|