fb-tools 2.6.0__tar.gz → 2.6.2__tar.gz

{fb_tools-2.6.0/lib/fb_tools.egg-info → fb_tools-2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.6.0
+Version: 2.6.2
 Summary: Modules for common used objects, error classes and methods.
 Home-page: https://github.com/fbrehm/python_fb_tools
 Author: Frank Brehm

{fb_tools-2.6.0 → fb_tools-2.6.2}/lib/fb_tools/__init__.py

@@ -22,6 +22,6 @@ DEFAULT_TERMINAL_HEIGHT = 40
 from .mailaddress import MailAddress, MailAddressList, QualifiedMailAddress     # noqa: F401
 from .multi_config import BaseMultiConfig                                       # noqa: F401
 
-__version__ = '2.6.0'
+__version__ = '2.6.2'
 
 # vim: ts=4 et list

{fb_tools-2.6.0 → fb_tools-2.6.2}/lib/fb_tools/local_version.py

@@ -11,7 +11,7 @@
 __author__ = 'Frank Brehm <frank@brehm-online.com>'
 __copyright__ = '(C) 2024 by Frank Brehm, Berlin'
 __contact__ = 'frank@brehm-online.com'
-__version__ = '2.6.0'
+__version__ = '2.6.2'
 __license__ = 'LGPL3+'
 
 # vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

fb_tools-2.6.2/lib/fb_tools/spinner.py

@@ -0,0 +1,587 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@summary: Module for for a Spinner class.
+
+          A Spinner object is displaying on console a rotating or somehow
+          other animated character during its existence.
+
+          This class was taken from https://github.com/Tagar/stuff
+
+          Example usage:
+
+                from fb_tools.spinner import Spinner
+
+                with Spinner("just waiting a bit.. "):
+                    time.sleep(3)
+
+@author: Frank Brehm
+@contact: frank@brehm-online.com
+@copyright: © 2024 by Frank Brehm, Berlin
+"""
+
+import itertools
+import logging
+import sys
+import threading
+import time
+# from collections import namedtuple
+
+# Own modules
+# from .common import to_bytes
+from .xlate import XLATOR
+
+__version__ = '2.1.0'
+
+_ = XLATOR.gettext
+
+LOG = logging.getLogger(__name__)
+
+CycleList = {
+    'dots': {'delay': 80, 'frames': '⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏'},
+    'dots2': {'delay': 80, 'frames': '⣾⣽⣻⢿⡿⣟⣯⣷'},
+    'dots3': {'delay': 80, 'frames': '⠋⠙⠚⠞⠖⠦⠴⠲⠳⠓'},
+    'dots4': {'delay': 80, 'frames': '⠄⠆⠇⠋⠙⠸⠰⠠⠰⠸⠙⠋⠇⠆'},
+    'dots5': {'delay': 80, 'frames': '⠋⠙⠚⠒⠂⠂⠒⠲⠴⠦⠖⠒⠐⠐⠒⠓⠋'},
+    'dots6': {'delay': 80, 'frames': '⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠴⠲⠒⠂⠂⠒⠚⠙⠉⠁'},
+    'dots7': {'delay': 80, 'frames': '⠈⠉⠋⠓⠒⠐⠐⠒⠖⠦⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈'},
+    'dots8': {'delay': 80, 'frames': '⠁⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈⠈'},
+    'dots9': {'delay': 80, 'frames': '⢹⢺⢼⣸⣇⡧⡗⡏'},
+    'dots10': {'delay': 80, 'frames': '⢄⢂⢁⡁⡈⡐⡠'},
+    'dots11': {'delay': 100, 'frames': '⠁⠂⠄⡀⢀⠠⠐⠈'},
+    'dots12': {
+        'delay': 80,
+        'frames': [
+            '⢀⠀',
+            '⡀⠀',
+            '⠄⠀',
+            '⢂⠀',
+            '⡂⠀',
+            '⠅⠀',
+            '⢃⠀',
+            '⡃⠀',
+            '⠍⠀',
+            '⢋⠀',
+            '⡋⠀',
+            '⠍⠁',
+            '⢋⠁',
+            '⡋⠁',
+            '⠍⠉',
+            '⠋⠉',
+            '⠋⠉',
+            '⠉⠙',
+            '⠉⠙',
+            '⠉⠩',
+            '⠈⢙',
+            '⠈⡙',
+            '⢈⠩',
+            '⡀⢙',
+            '⠄⡙',
+            '⢂⠩',
+            '⡂⢘',
+            '⠅⡘',
+            '⢃⠨',
+            '⡃⢐',
+            '⠍⡐',
+            '⢋⠠',
+            '⡋⢀',
+            '⠍⡁',
+            '⢋⠁',
+            '⡋⠁',
+            '⠍⠉',
+            '⠋⠉',
+            '⠋⠉',
+            '⠉⠙',
+            '⠉⠙',
+            '⠉⠩',
+            '⠈⢙',
+            '⠈⡙',
+            '⠈⠩',
+            '⠀⢙',
+            '⠀⡙',
+            '⠀⠩',
+            '⠀⢘',
+            '⠀⡘',
+            '⠀⠨',
+            '⠀⢐',
+            '⠀⡐',
+            '⠀⠠',
+            '⠀⢀',
+            '⠀⡀',
+        ],
+    },
+    'dots8Bit': {
+        'delay': 80,
+        'frames': '⠀⠁⠂⠃⠄⠅⠆⠇⡀⡁⡂⡃⡄⡅⡆⡇⠈⠉⠊⠋⠌⠍⠎⠏⡈⡉⡊⡋⡌⡍⡎⡏⠐⠑⠒⠓⠔⠕⠖⠗⡐⡑⡒⡓⡔⡕⡖⡗⠘⠙⠚⠛⠜⠝⠞⠟⡘⡙'
+        '⡚⡛⡜⡝⡞⡟⠠⠡⠢⠣⠤⠥⠦⠧⡠⡡⡢⡣⡤⡥⡦⡧⠨⠩⠪⠫⠬⠭⠮⠯⡨⡩⡪⡫⡬⡭⡮⡯⠰⠱⠲⠳⠴⠵⠶⠷⡰⡱⡲⡳⡴⡵⡶⡷⠸⠹⠺⠻'
+        '⠼⠽⠾⠿⡸⡹⡺⡻⡼⡽⡾⡿⢀⢁⢂⢃⢄⢅⢆⢇⣀⣁⣂⣃⣄⣅⣆⣇⢈⢉⢊⢋⢌⢍⢎⢏⣈⣉⣊⣋⣌⣍⣎⣏⢐⢑⢒⢓⢔⢕⢖⢗⣐⣑⣒⣓⣔⣕'
+        '⣖⣗⢘⢙⢚⢛⢜⢝⢞⢟⣘⣙⣚⣛⣜⣝⣞⣟⢠⢡⢢⢣⢤⢥⢦⢧⣠⣡⣢⣣⣤⣥⣦⣧⢨⢩⢪⢫⢬⢭⢮⢯⣨⣩⣪⣫⣬⣭⣮⣯⢰⢱⢲⢳⢴⢵⢶⢷'
+        '⣰⣱⣲⣳⣴⣵⣶⣷⢸⢹⢺⢻⢼⢽⢾⢿⣸⣹⣺⣻⣼⣽⣾⣿',
+    },
+    'line': {'delay': 130, 'frames': ['-', '\\', '|', '/']},
+    'line1': {'delay': 100, 'frames': ['-', '/', '|', '\\']},
+    'line2': {'delay': 100, 'frames': '⠂-–—–-'},
+    'pipe': {'delay': 100, 'frames': '┤┘┴└├┌┬┐'},
+    'simpleDots': {'delay': 400, 'frames': ['.  ', '.. ', '...', '   ']},
+    'simpleDotsScrolling': {'delay': 200, 'frames': ['.  ', '.. ', '...', ' ..', '  .', '   ']},
+    'star': {'delay': 70, 'frames': '✶✸✹✺✹✷'},
+    'star2': {'delay': 80, 'frames': '+x*'},
+    'flip': {'delay': 70, 'frames': "___-``'´-___"},
+    'hamburger': {'delay': 100, 'frames': '☱☲☴'},
+    'growVertical': {'delay': 120, 'frames': '▁▃▄▅▆▇▆▅▄▃'},
+    'growHorizontal': {'delay': 120, 'frames': '▏▎▍▌▋▊▉▊▋▌▍▎'},
+    'balloon': {'delay': 140, 'frames': ' .oO@* '},
+    'balloon2': {'delay': 120, 'frames': '.oO°Oo.'},
+    'noise': {'delay': 100, 'frames': '▓▒░'},
+    'bounce': {'delay': 120, 'frames': '⠁⠂⠄⠂'},
+    'boxBounce': {'delay': 120, 'frames': '▖▘▝▗'},
+    'boxBounce2': {'delay': 100, 'frames': '▌▀▐▄'},
+    'triangle': {'delay': 50, 'frames': '◢◣◤◥'},
+    'arc': {'delay': 100, 'frames': '◜◠◝◞◡◟'},
+    'circle': {'delay': 120, 'frames': '◡⊙◠'},
+    'squareCorners': {'delay': 180, 'frames': '◰◳◲◱'},
+    'circleQuarters': {'delay': 120, 'frames': '◴◷◶◵'},
+    'circleHalves': {'delay': 50, 'frames': '◐◓◑◒'},
+    'squish': {'delay': 100, 'frames': '╫╪'},
+    'toggle': {'delay': 250, 'frames': '⊶⊷'},
+    'toggle2': {'delay': 80, 'frames': '▫▪'},
+    'toggle3': {'delay': 120, 'frames': '□■'},
+    'toggle4': {'delay': 100, 'frames': '■□▪▫'},
+    'toggle5': {'delay': 100, 'frames': '▮▯'},
+    'toggle7': {'delay': 80, 'frames': '⦾⦿'},
+    'toggle8': {'delay': 100, 'frames': '◍◌'},
+    'toggle9': {'delay': 100, 'frames': '◉◎'},
+    'toggle10': {'delay': 100, 'length': 2, 'frames': '㊂㊀㊁'},
+    'toggle12': {'delay': 120, 'frames': '☗☖'},
+    'toggle13': {'delay': 80, 'frames': '=*-'},
+    'arrow': {'delay': 100, 'frames': '←↖↑↗→↘↓↙'},
+    'arrow2': {
+        'delay': 80,
+        'length': 2,
+        'frames': ['⬆️ ', '↗️ ', '➡️ ', '↘️ ', '⬇️ ', '↙️ ', '⬅️ ', '↖️ '],
+    },
+    'arrow3': {
+        'delay': 120,
+        'frames': ['▹▹▹▹▹', '▸▹▹▹▹', '▹▸▹▹▹', '▹▹▸▹▹', '▹▹▹▸▹', '▹▹▹▹▸'],
+    },
+    'bouncingBar': {
+        'delay': 80,
+        'frames': [
+            '[    ]',
+            '[=   ]',
+            '[==  ]',
+            '[=== ]',
+            '[ ===]',
+            '[  ==]',
+            '[   =]',
+            '[    ]',
+            '[   =]',
+            '[  ==]',
+            '[ ===]',
+            '[====]',
+            '[=== ]',
+            '[==  ]',
+            '[=   ]',
+        ],
+    },
+    'bouncingBall': {
+        'delay': 80,
+        'frames': [
+            '( ●    )',
+            '(  ●   )',
+            '(   ●  )',
+            '(    ● )',
+            '(     ●)',
+            '(    ● )',
+            '(   ●  )',
+            '(  ●   )',
+            '( ●    )',
+            '(●     )',
+        ],
+    },
+    'smiley': {'delay': 200, 'length': 2, 'frames': ['😄', '😝']},
+    'monkey': {'delay': 300, 'length': 2, 'frames': ['🙈', '🙈', '🙉', '🙊']},
+    'hearts': {'delay': 100, 'length': 2, 'frames': ['💛', '💙', '💜', '💚', '❤️ ']},
+    'clock': {
+        'delay': 100,
+        'length': 2,
+        'frames': [
+            '🕛',
+            '🕐',
+            '🕑',
+            '🕒',
+            '🕓',
+            '🕔',
+            '🕕',
+            '🕖',
+            '🕗',
+            '🕘',
+            '🕙',
+            '🕚',
+        ],
+    },
+    'earth': {'delay': 180, 'length': 2, 'frames': ['🌍', '🌎', '🌏']},
+    'material': {
+        'delay': 17,
+        'frames': [
+            '█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '██▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '███▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '████▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '██████▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '██████▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '███████▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '████████▁▁▁▁▁▁▁▁▁▁▁▁',
+            '█████████▁▁▁▁▁▁▁▁▁▁▁',
+            '█████████▁▁▁▁▁▁▁▁▁▁▁',
+            '██████████▁▁▁▁▁▁▁▁▁▁',
+            '███████████▁▁▁▁▁▁▁▁▁',
+            '█████████████▁▁▁▁▁▁▁',
+            '██████████████▁▁▁▁▁▁',
+            '██████████████▁▁▁▁▁▁',
+            '▁██████████████▁▁▁▁▁',
+            '▁██████████████▁▁▁▁▁',
+            '▁██████████████▁▁▁▁▁',
+            '▁▁██████████████▁▁▁▁',
+            '▁▁▁██████████████▁▁▁',
+            '▁▁▁▁█████████████▁▁▁',
+            '▁▁▁▁██████████████▁▁',
+            '▁▁▁▁██████████████▁▁',
+            '▁▁▁▁▁██████████████▁',
+            '▁▁▁▁▁██████████████▁',
+            '▁▁▁▁▁██████████████▁',
+            '▁▁▁▁▁▁██████████████',
+            '▁▁▁▁▁▁██████████████',
+            '▁▁▁▁▁▁▁█████████████',
+            '▁▁▁▁▁▁▁█████████████',
+            '▁▁▁▁▁▁▁▁████████████',
+            '▁▁▁▁▁▁▁▁████████████',
+            '▁▁▁▁▁▁▁▁▁███████████',
+            '▁▁▁▁▁▁▁▁▁███████████',
+            '▁▁▁▁▁▁▁▁▁▁██████████',
+            '▁▁▁▁▁▁▁▁▁▁██████████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁████████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁███████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁██████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█████',
+            '█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████',
+            '██▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███',
+            '██▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███',
+            '███▁▁▁▁▁▁▁▁▁▁▁▁▁▁███',
+            '████▁▁▁▁▁▁▁▁▁▁▁▁▁▁██',
+            '█████▁▁▁▁▁▁▁▁▁▁▁▁▁▁█',
+            '█████▁▁▁▁▁▁▁▁▁▁▁▁▁▁█',
+            '██████▁▁▁▁▁▁▁▁▁▁▁▁▁█',
+            '████████▁▁▁▁▁▁▁▁▁▁▁▁',
+            '█████████▁▁▁▁▁▁▁▁▁▁▁',
+            '█████████▁▁▁▁▁▁▁▁▁▁▁',
+            '█████████▁▁▁▁▁▁▁▁▁▁▁',
+            '█████████▁▁▁▁▁▁▁▁▁▁▁',
+            '███████████▁▁▁▁▁▁▁▁▁',
+            '████████████▁▁▁▁▁▁▁▁',
+            '████████████▁▁▁▁▁▁▁▁',
+            '██████████████▁▁▁▁▁▁',
+            '██████████████▁▁▁▁▁▁',
+            '▁██████████████▁▁▁▁▁',
+            '▁██████████████▁▁▁▁▁',
+            '▁▁▁█████████████▁▁▁▁',
+            '▁▁▁▁▁████████████▁▁▁',
+            '▁▁▁▁▁████████████▁▁▁',
+            '▁▁▁▁▁▁███████████▁▁▁',
+            '▁▁▁▁▁▁▁▁█████████▁▁▁',
+            '▁▁▁▁▁▁▁▁█████████▁▁▁',
+            '▁▁▁▁▁▁▁▁▁█████████▁▁',
+            '▁▁▁▁▁▁▁▁▁█████████▁▁',
+            '▁▁▁▁▁▁▁▁▁▁█████████▁',
+            '▁▁▁▁▁▁▁▁▁▁▁████████▁',
+            '▁▁▁▁▁▁▁▁▁▁▁████████▁',
+            '▁▁▁▁▁▁▁▁▁▁▁▁███████▁',
+            '▁▁▁▁▁▁▁▁▁▁▁▁███████▁',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁███████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁███████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁██',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁██',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁██',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+            '▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁',
+        ],
+    },
+    'moon': {
+        'delay': 80,
+        'length': 2,
+        'frames': ['🌑', '🌒', '🌓', '🌔', '🌕', '🌖', '🌗', '🌘'],
+    },
+    'runner': {'delay': 140, 'length': 2, 'frames': ['🚶', '🏃']},
+    'pong': {
+        'delay': 80,
+        'frames': [
+            '▐⠂       ▌',
+            '▐⠈       ▌',
+            '▐ ⠂      ▌',
+            '▐ ⠠      ▌',
+            '▐  ⡀     ▌',
+            '▐  ⠠     ▌',
+            '▐   ⠂    ▌',
+            '▐   ⠈    ▌',
+            '▐    ⠂   ▌',
+            '▐    ⠠   ▌',
+            '▐     ⡀  ▌',
+            '▐     ⠠  ▌',
+            '▐      ⠂ ▌',
+            '▐      ⠈ ▌',
+            '▐       ⠂▌',
+            '▐       ⠠▌',
+            '▐       ⡀▌',
+            '▐      ⠠ ▌',
+            '▐      ⠂ ▌',
+            '▐     ⠈  ▌',
+            '▐     ⠂  ▌',
+            '▐    ⠠   ▌',
+            '▐    ⡀   ▌',
+            '▐   ⠠    ▌',
+            '▐   ⠂    ▌',
+            '▐  ⠈     ▌',
+            '▐  ⠂     ▌',
+            '▐ ⠠      ▌',
+            '▐ ⡀      ▌',
+            '▐⠠       ▌',
+        ],
+    },
+    'shark': {
+        'delay': 120,
+        'frames': [
+            '▐|\\____________▌',
+            '▐_|\\___________▌',
+            '▐__|\\__________▌',
+            '▐___|\\_________▌',
+            '▐____|\\________▌',
+            '▐_____|\\_______▌',
+            '▐______|\\______▌',
+            '▐_______|\\_____▌',
+            '▐________|\\____▌',
+            '▐_________|\\___▌',
+            '▐__________|\\__▌',
+            '▐___________|\\_▌',
+            '▐____________|\\▌',
+            '▐____________/|▌',
+            '▐___________/|_▌',
+            '▐__________/|__▌',
+            '▐_________/|___▌',
+            '▐________/|____▌',
+            '▐_______/|_____▌',
+            '▐______/|______▌',
+            '▐_____/|_______▌',
+            '▐____/|________▌',
+            '▐___/|_________▌',
+            '▐__/|__________▌',
+            '▐_/|___________▌',
+            '▐/|____________▌',
+        ],
+    },
+    'dqpb': {'delay': 100, 'frames': 'dqpb'},
+    'weather': {
+        'delay': 100,
+        'length': 2,
+        'frames': [
+            '☀️ ',
+            '☀️ ',
+            '☀️ ',
+            '🌤 ',
+            '⛅️',
+            '🌥 ',
+            '☁️ ',
+            '🌧 ',
+            '🌨 ',
+            '🌧 ',
+            '🌨 ',
+            '🌧 ',
+            '🌨 ',
+            '⛈ ',
+            '🌨 ',
+            '🌧 ',
+            '🌨 ',
+            '☁️ ',
+            '🌥 ',
+            '⛅️',
+            '🌤 ',
+            '☀️ ',
+            '☀️ ',
+        ],
+    },
+    'christmas': {'delay': 400, 'length': 2, 'frames': '🌲🎄'},
+    'grenade': {
+        'delay': 80,
+        'length': 3,
+        'frames': [
+            '،  ',
+            '′  ',
+            ' ´ ',
+            ' ‾ ',
+            '  ⸌',
+            '  ⸊',
+            '  |',
+            '  ⁎',
+            '  ⁕',
+            ' ෴ ',
+            '  ⁓',
+            '   ',
+            '   ',
+            '   ',
+        ],
+    },
+    'point': {'delay': 125, 'frames': ['∙∙∙', '●∙∙', '∙●∙', '∙∙●', '∙∙∙']},
+    'layer': {'delay': 150, 'frames': '-=≡'},
+    'betaWave': {
+        'delay': 80,
+        'frames': [
+            'ρββββββ',
+            'βρβββββ',
+            'ββρββββ',
+            'βββρβββ',
+            'ββββρββ',
+            'βββββρβ',
+            'ββββββρ',
+        ],
+    },
+    'aesthetic': {
+        'delay': 80,
+        'frames': [
+            '▰▱▱▱▱▱▱',
+            '▰▰▱▱▱▱▱',
+            '▰▰▰▱▱▱▱',
+            '▰▰▰▰▱▱▱',
+            '▰▰▰▰▰▱▱',
+            '▰▰▰▰▰▰▱',
+            '▰▰▰▰▰▰▰',
+            '▰▱▱▱▱▱▱',
+        ],
+    },
+}
+
+# =============================================================================
+class Spinner(object):
+    """Displaying on console a rotating or somehow other animated character."""
+
+    default_cycle_name = 'line1'
+    default_delay = 100
+
+    # -------------------------------------------------------------------------
+    def __init__(self, message, cycle_name=None, frames=None, delay=None):
+        """Initialize a Spinner object."""
+        self.cycle_name = cycle_name
+        if not self.cycle_name:
+            self.cycle_name = self.default_cycle_name
+
+        self.frames = None
+        self.delay = self.default_delay
+        self.characters = 1
+        length = None
+
+        if frames:
+            self.frames = frames
+        else:
+            if self.cycle_name not in CycleList:
+                msg = _('Spinner {!r} not found.').format(self.cycle_name)
+                raise KeyError(msg)
+
+            self.frames = CycleList[self.cycle_name]['frames']
+            self.delay = CycleList[self.cycle_name]['delay']
+            if 'length' in CycleList[self.cycle_name]:
+                length = CycleList[self.cycle_name]['length']
+
+        self.spinner = itertools.cycle(self.frames)
+
+        if length:
+            self.characters = length
+        else:
+            self.characters = len(self.frames[0])
+        if delay:
+            self.delay = delay
+
+        # LOG.debug('First frame is of type {!r}.'.format(self.frames[0].__class__.__name__))
+        # LOG.debug('Frames has {c} characters, delay is {d} milliseconds.'.format(
+        #     c=self.characters, d=self.delay))
+        # len_in_codeunits = len(self.frames[0].encode('utf-16-le')) // 2
+        # LOG.debug('len_in_codeunits: {}'.format(len_in_codeunits))
+        # LOG.debug('len: {}'.format(len(self.frames[0].encode('utf-8'))))
+        # LOG.debug('str: {}'.format(self.frames[0]))
+        # LOG.debug('bytes: {}'.format(to_bytes(self.frames[0])))
+
+        self.busy = False
+        self.spinner_visible = False
+        sys.stdout.write(message)
+
+    # -------------------------------------------------------------------------
+    def write_next(self):
+        """Write the next character from the cycle array on the current screen position."""
+        with self._screen_lock:
+            if not self.spinner_visible:
+                sys.stdout.write(next(self.spinner) + ' ')
+                self.spinner_visible = True
+                sys.stdout.flush()
+
+    # -------------------------------------------------------------------------
+    def remove_spinner(self, cleanup=False):
+        """
+        Remove the last visible cycle character from screen.
+
+        If the parameter cleanup is true, then the screen cursor will be mnoved to the next line.
+        """
+        with self._screen_lock:
+            if self.spinner_visible:
+                sys.stdout.write('\b' * (self.characters + 1))
+                self.spinner_visible = False
+                if cleanup:
+                    sys.stdout.write(' ' * self.characters)       # overwrite spinner with blank
+                    sys.stdout.write('\r')                        # move to next line
+                sys.stdout.flush()
+
+    # -------------------------------------------------------------------------
+    def spinner_task(self):
+        """Entry point of the Thread. It is an infinite loop."""
+        delay = float(self.delay) / 1000.0
+
+        while self.busy:
+            self.write_next()
+            time.sleep(delay)
+            self.remove_spinner()
+
+    # -------------------------------------------------------------------------
+    def __enter__(self):
+        """Execute this ction, when this object will be created for the with-block."""
+        if sys.stdout.isatty():
+            self._screen_lock = threading.Lock()
+            self.busy = True
+            self.thread = threading.Thread(target=self.spinner_task)
+            self.thread.start()
+
+    # -------------------------------------------------------------------------
+    def __exit__(self, exc_type, exc_val, exc_traceback):
+        """Exit action at the end of the with-block."""
+        if sys.stdout.isatty():
+            self.busy = False
+            self.remove_spinner(cleanup=True)
+        else:
+            sys.stdout.write('\r')
+
+
+# =============================================================================
+if __name__ == '__main__':
+
+    pass
+
+# =============================================================================
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 list

{fb_tools-2.6.0 → fb_tools-2.6.2/lib/fb_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.6.0
+Version: 2.6.2
 Summary: Modules for common used objects, error classes and methods.
 Home-page: https://github.com/fbrehm/python_fb_tools
 Author: Frank Brehm

{fb_tools-2.6.0 → fb_tools-2.6.2}/lib/fb_tools.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ lib/fb_tools/mailaddress.py
 lib/fb_tools/merge.py
 lib/fb_tools/obj.py
 lib/fb_tools/pidfile.py
+lib/fb_tools/spinner.py
 lib/fb_tools/xlate.py
 lib/fb_tools.egg-info/PKG-INFO
 lib/fb_tools.egg-info/SOURCES.txt
@@ -59,4 +60,5 @@ test/test_20_handling_object.py
 test/test_25_ddns_update_status.py
 test/test_30_base_handler.py
 test/test_33_lock.py
-test/test_40_app_modules.py
+test/test_40_app_modules.py
+test/test_50_spinner.py

fb_tools-2.6.2/test/test_50_spinner.py

@@ -0,0 +1,126 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@summary: Test script (and module) for unit tests on spinner module and Spinner objects.
+
+@author: Frank Brehm
+@contact: frank@brehm-online.com
+@license: GPL3
+"""
+
+import logging
+import os
+import sys
+import time
+
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+libdir = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '..', 'lib'))
+sys.path.insert(0, libdir)
+
+from fb_tools.common import to_bool
+
+from general import FbToolsTestcase, get_arg_verbose, init_root_logger
+
+
+APPNAME = 'test_spinner'
+
+LOG = logging.getLogger(APPNAME)
+
+EXEC_LONG_TESTS = False
+if 'EXEC_LONG_TESTS' in os.environ and os.environ['EXEC_LONG_TESTS'] != '':
+    EXEC_LONG_TESTS = to_bool(os.environ['EXEC_LONG_TESTS'])
+
+SPINNER_TO_TEST = 'line'
+if 'SPINNER_TO_TEST' in os.environ:
+    SPINNER_TO_TEST = os.environ['SPINNER_TO_TEST'].strip()
+    if not SPINNER_TO_TEST:
+        SPINNER_TO_TEST = None
+
+# =============================================================================
+class TestSpinner(FbToolsTestcase):
+    """Testcase for unit tests on module fb_tools.spinner."""
+
+    # -------------------------------------------------------------------------
+    def setUp(self):
+        """Execute this on setting up before calling each particular test method."""
+        if self.verbose >= 1:
+            print()
+
+    # -------------------------------------------------------------------------
+    def tearDown(self):
+        """Tear down routine for calling each particular test method."""
+        pass
+
+    # -------------------------------------------------------------------------
+    def test_import(self):
+        """Test import of pp_admintools.spinner."""
+        LOG.info(self.get_method_doc())
+
+        import fb_tools.spinner
+        LOG.debug('Version of module fb_tools.spinner: {!r}.'.format(
+            fb_tools.spinner.__version__))
+
+    # -------------------------------------------------------------------------
+    @unittest.skipUnless(SPINNER_TO_TEST, 'No spinner to test selected.')
+    def test_particular_spinner(self):
+        """Test execution of a particular spinner."""
+        LOG.info(self.get_method_doc())
+
+        from fb_tools.spinner import Spinner
+
+        seconds_per_spinner = 10
+
+        msg = 'Testing spinner {!r}: '.format(SPINNER_TO_TEST)
+        with Spinner(msg, SPINNER_TO_TEST):
+            time.sleep(seconds_per_spinner)
+        print()
+        print('Continue ...')
+
+    # -------------------------------------------------------------------------
+    @unittest.skipUnless(EXEC_LONG_TESTS, 'Long terming tests are not executed.')
+    def test_all_spinners(self):
+        """Test execution of all spinners."""
+        LOG.info(self.get_method_doc())
+
+        import fb_tools.spinner
+        from fb_tools.spinner import Spinner
+
+        seconds_per_spinner = 6
+
+        for cycle_name in fb_tools.spinner.CycleList.keys():
+
+            msg = 'Testing spinner {!r}: '.format(cycle_name)
+            with Spinner(msg, cycle_name):
+                time.sleep(seconds_per_spinner)
+            print()
+
+
+# =============================================================================
+if __name__ == '__main__':
+
+    verbose = get_arg_verbose()
+    if verbose is None:
+        verbose = 0
+    init_root_logger(verbose)
+
+    LOG.info('Starting tests ...')
+
+    loader = unittest.TestLoader()
+    suite = unittest.TestSuite()
+
+    suite.addTest(TestSpinner('test_import', verbose))
+    suite.addTest(TestSpinner('test_particular_spinner', verbose))
+    suite.addTest(TestSpinner('test_all_spinners', verbose))
+
+    runner = unittest.TextTestRunner(verbosity=verbose)
+
+    result = runner.run(suite)
+
+
+# =============================================================================
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 list