Minor changes in code and documentation, preparations for unit tests

pydgets/cowsay.py

-#https://github.com/piuccio/cowsay
+# TODO: Implement library similar to the https://github.com/piuccio/cowsay

pydgets/tests/test_widgets.py

+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+#-------------------------------------------------------------------------------
+# Copyright (C) since 2016 Jan Mach <honza.mach.ml@gmail.com>
+# Use of this source is governed by the MIT license, see LICENSE file.
+#-------------------------------------------------------------------------------
+
+import unittest
+from unittest.mock import Mock, MagicMock, call
+from pprint import pformat, pprint
+
+import os
+import sys
+import shutil
+
+# Generate the path to custom 'lib' directory
+#lib = os.path.abspath(os.path.join(os.path.dirname(__file__), '../../'))
+#sys.path.insert(0, lib)
+
+import pydgets.widgets
+
+class TestWidgets(unittest.TestCase):
+
+    def setUp(self):
+        pass
+    def tearDown(self):
+        pass
+
+    def test_01_basic(self):
+        """
+        Perform the basic operativity tests.
+        """
+        self.assertTrue(True)
+        self.assertEqual(0, 0)
+
+if __name__ == "__main__":
+    unittest.main()

pydgets/widgets.py

 #!/usr/bin/python3
 # -*- coding: utf-8 -*-
 #-------------------------------------------------------------------------------
-# Copyright (C) 2015-2016 Jan Mach <honza.mach.ml@gmail.com>
+# Copyright (C) since 2016 Jan Mach <honza.mach.ml@gmail.com>
 # Use of this source is governed by the MIT license, see LICENSE file.
 #-------------------------------------------------------------------------------
 
 """
-Console widget library.
+Console widget library for Python3.
+
+This library is intended to help in data presentation from various console scripts.
+It provides tools for easy formating and rendering of many usefull 'widgets' like
+lists, tree strutures, tables, etc.
+
+.. note::
+
+    Although production code is based on this library, it should still be considered
+    work in progress.
+
 """
 
 import os
@@ -18,6 +28,8 @@ import time
 import pprint
 
 DFLT_TABLE_STYLE = 'utf8.b'
+
+# Detected terminal width and height
 TERMINAL_WIDTH   = 0
 TERMINAL_HEIGHT  = 0
 
@@ -71,6 +83,7 @@ TEXT_FORMATING = {
     'rst': '\033[0m',
 }
 
+# Text alignment index
 TEXT_ALIGNMENT = {
     '<': '<', 'l': '<', 'left':   '<', 'L': '<', 'LEFT':   '<',
     '>': '>', 'r': '>', 'right':  '>', 'R': '>', 'RIGHT':  '>',
@@ -115,7 +128,7 @@ BORDER_STYLES = {
         'bh': '#', 'bv': '#', 'bl': '#', 'bm': '#', 'br': '#'
     },
     'utf8.a': {
-        # Alternativelly define the characters with unicode codes
+        # Alternativelly it is possible to define the characters with unicode codes
         #'th': '\u2500', 'tv': '\u2502', 'tl': '\u250c', 'tm': '\u252c', 'tr': '\u2510',
         #'mh': '\u2500', 'mv': '\u2502', 'ml': '\u251c', 'mm': '\u253c', 'mr': '\u2524',
         #'bh': '\u2500', 'bv': '\u2502', 'bl': '\u2514', 'bm': '\u2534', 'br': '\u2518'
@@ -277,7 +290,7 @@ TREE_STYLES = {
 
 def terminal_size():
     """
-    Detect the size of terminal window in rows and columns.
+    Detect the current size of terminal window as a numer of rows and columns.
     """
     try:
         (rows, columns) = os.popen('stty size', 'r').read().split()
@@ -286,17 +299,20 @@ def terminal_size():
         return (columns, rows)
 
     # Currently ignore any errors and return some reasonable default values.
+    # Errors may occur, when the library is used in non-terminal application
+    # like daemon.
     except:
         pass
     return (80, 24)
 
+# Detect the terminal size automatically after library initialization
 (TERMINAL_WIDTH, TERMINAL_HEIGHT) = terminal_size()
 
 #-------------------------------------------------------------------------------
 
 class ConsoleWidget:
     """
-    Base class for all console widgets.
+    Base class for all console widgets implemented by this library.
 
     This class provides basic common methods for widget setup and rendering.
     """
@@ -354,7 +370,7 @@ class ConsoleWidget:
         """
         Get list of all appropriate settings and their default values.
 
-        The returned list is then used setup() and get_setup() methods to setup
+        The returned list is then used in setup() and get_setup() methods to setup
         the widget internal settings.
         """
         return [
@@ -387,7 +403,7 @@ class ConsoleWidget:
 
     def get_setup(self, content = None, **kwargs):
         """
-        Get current setup by combining internal settings with the one given.
+        Get current setup by combining internal settings with the ones given.
         """
         if content is None:
             content = self.content
@@ -1373,21 +1389,51 @@ class BarChartWidget(MultiLineWidget):
 
 if __name__ == "__main__":
     """
-    Perform the demonstration.
+    Perform the library demonstration.
     """
+
+    widget_groups = ['all', 'data', 'text', 'line', 'box', 'list', 'tree', 'table', 'progress', 'barchart']
+    section_separator = "\n                  --------------------------------------------\n"
     argparser = argparse.ArgumentParser(description = "pydgets - Console widget library for Python 3")
-    argparser.add_argument('--group', help = 'pick a group of widgets', choices = ['all', 'data', 'text', 'line', 'box', 'list', 'tree', 'table', 'progress', 'barchart'], default='all')
+    argparser.add_argument('--group', help = 'pick a group of widgets', choices = widget_groups, default='all')
     args = argparser.parse_args()
 
+    print("""
+                  ==============================================
+                    _____             _               _
+                   |  __ \           | |             | |
+                   | |__) |_   _   __| |  __ _   ___ | |_  ___
+                   |  ___/| | | | / _` | / _` | / _ \| __|/ __|
+                   | |    | |_| || (_| || (_| ||  __/| |_ \__ \\
+                   |_|     \__, | \__,_| \__, | \___| \__||___/
+                            __/ |         __/ |
+                           |___/         |___/
+
+                  ==============================================
+                  ıllıllı PYTHON3 CONSOLE WIDGET LIBRARY ıllıllı
+                  ==============================================
+
+""")
+
+    argparser.print_help()
+    print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     (columns, rows) = terminal_size()
     print("Detected terminal size {} x {} (WxH)".format(columns, rows))
+    print(section_separator)
+
+    #---------------------------------------------------------------------------
 
     if args.group in ('all', 'data'):
         print("")
-        labelptrn = " {:<60s} "
-        textw = TextWidget()
         print("Demonstrations of TextWidget data formating capabilities...")
         print("")
+
+        labelptrn = " {:<60s} "
+        textw = TextWidget()
+
         for conv in (
             [523689,        'int'],
             [123523.689111, 'float'],
@@ -1401,6 +1447,7 @@ if __name__ == "__main__":
             label = labelptrn.format(label)
             print(label, textw.render(conv[0], data_type = conv[1]))
 
+        print("")
         print("Demonstrations of TextWidget data highlighting capabilities...")
         print("")
 
@@ -1412,8 +1459,13 @@ if __name__ == "__main__":
 
         for val in ('50', '150'):
             label = " Data decoration '{}'".format(val)
+            label = labelptrn.format(label)
             print(label, textw.render(val, text_highlight = deco))
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'text'):
         print("")
         labelptrn = " {:<60s} "
@@ -1456,6 +1508,10 @@ if __name__ == "__main__":
                     label = labelptrn.format(label)
                     print(labelptrn.format(label), textw.render(label, text_formating = {"fg": fg, "bg": bg, "attr": attr}))
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'line'):
         print("")
         print("Demonstrations of StatusLineWidget...")
@@ -1466,6 +1522,10 @@ if __name__ == "__main__":
         print(linew.render('Test status line text, right align, right padding with custom character', padding_right = 5, padding_char = '#', align = '>', text_formating = {"bg": "on_blue"}))
         print(linew.render('Test status line text, margin', margin = 5, text_formating = {"bg": "on_yellow"}))
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'list'):
         print("")
         print("Demonstrations of ListWidget...")
@@ -1498,6 +1558,10 @@ if __name__ == "__main__":
         listw = ListWidget()
         listw.display(data)
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'tree'):
         print("")
         print("Demonstrations of TreeWidget...")
@@ -1532,6 +1596,10 @@ if __name__ == "__main__":
             treew = TreeWidget()
             treew.display(data, tree_style = s)
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'box'):
         print("")
         print("Demonstrations of BoxWidget...")
@@ -1542,6 +1610,10 @@ if __name__ == "__main__":
             print("")
             boxw.display(text, header_content = h, width = 150, padding = 1, border_style = s, header_formating = {"bg": "on_red"})
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'table'):
         print("")
         print("Demonstrations of TableWidget...")
@@ -1560,6 +1632,10 @@ if __name__ == "__main__":
             ]
         tablew.display(tbody, columns = tcols)
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'progress'):
         print("")
         print("Demonstrations of ProgressBarWidget...")
@@ -1569,6 +1645,10 @@ if __name__ == "__main__":
             progw.display(i/100)
             time.sleep(1)
 
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
     if args.group in ('all', 'barchart'):
         print("")
         print("Demonstrations of BarChartWidget...")
@@ -1592,4 +1672,10 @@ if __name__ == "__main__":
                 324,
                 12,
             ]
-        barch.display(chbody, bars = chbars)
+        barch.display(chbody, bars = chbars, bar_formating = {"fg": "blue", "bg": "on_blue"})
+
+        print(section_separator)
+
+    #---------------------------------------------------------------------------
+
+    argparser.print_help()