fb-tools 2.6.3__tar.gz → 2.7.0__tar.gz

{fb_tools-2.6.3/lib/fb_tools.egg-info → fb_tools-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.6.3
+Version: 2.7.0
 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.7.0/bin/show-spinner

@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+@summary: Print a newline separated list of files generated from file globbing patterns.
+
+@author: Frank Brehm
+@contact: frank.brehm@pixelpark.com
+@copyright: © 2024 by Frank Brehm, Berlin
+"""
+from __future__ import print_function
+
+# Standard modules
+import locale
+import sys
+
+try:
+    from pathlib import Path
+except ImportError:
+    from pathlib2 import Path
+
+__exp_py_version_major__ = 3
+__min_py_version_minor__ = 6
+
+if sys.version_info[0] != __exp_py_version_major__:
+    print('This script is intended to use with Python {}.'.format(
+        __exp_py_version_major__), file=sys.stderr)
+    print('You are using Python: {0}.{1}.{2}-{3}-{4}.'.format(
+        *sys.version_info) + '\n', file=sys.stderr)
+    sys.exit(1)
+
+if sys.version_info[1] < __min_py_version_minor__:
+    print('A minimal Python version of {maj}.{min} is necessary to execute this script.'.format(
+        maj=__exp_py_version_major__, min=__min_py_version_minor__), file=sys.stderr)
+    print('You are using Python: {0}.{1}.{2}-{3}-{4}.'.format(
+        *sys.version_info) + '\n', file=sys.stderr)
+    sys.exit(1)
+
+my_path = Path(__file__)
+my_real_path = my_path.resolve()
+bin_path = my_real_path.parent
+base_dir = bin_path.parent
+lib_dir = base_dir.joinpath('lib')
+module_dir = lib_dir.joinpath('fb_tools')
+
+# print("My path:      {!r}".format(str(my_path)))
+# print("My real path: {!r}".format(str(my_real_path)))
+# print("Bin path:     {!r}".format(str(bin_path)))
+# print("Base dir:     {!r}".format(str(base_dir)))
+# print("Lib dir:      {!r}".format(str(lib_dir)))
+# print("Module dir:   {!r}".format(str(module_dir)))
+
+if module_dir.exists():
+    sys.path.insert(0, str(lib_dir))
+
+# own modules:
+from fb_tools.show_spinner_app import ShowSpinnerApplication
+from fb_tools.xlate import XLATOR
+
+_ = XLATOR.gettext
+
+__author__ = 'Frank Brehm <frank.brehm@pixelpark.com>'
+__copyright__ = '(C) 2024 by Frank Brehm, Pixelpark GmbH, Berlin'
+
+appname = my_path.name
+
+locale.setlocale(locale.LC_ALL, '')
+
+app = ShowSpinnerApplication(appname=appname, base_dir=base_dir)
+app.initialized = True
+
+if app.verbose > 2:
+    print(_('{c}-Object:\n{a}').format(c=app.__class__.__name__, a=app), file=sys.stderr)
+
+app()
+
+sys.exit(0)
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

{fb_tools-2.6.3 → fb_tools-2.7.0}/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.3'
+__version__ = '2.7.0'
 
 # vim: ts=4 et list

{fb_tools-2.6.3 → fb_tools-2.7.0}/lib/fb_tools/ddns/__init__.py

@@ -46,10 +46,11 @@ from .. import __version__ as GLOBAL_VERSION
 from ..argparse_actions import DirectoryOptionAction
 from ..cfg_app import FbConfigApplication
 from ..common import pp
+from ..common import to_bool
 from ..errors import IoTimeoutError
 from ..xlate import XLATOR, format_list
 
-__version__ = '2.2.3'
+__version__ = '2.3.0'
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
@@ -65,6 +66,8 @@ class BaseDdnsApplication(FbConfigApplication):
     work_directory_must_exists = False
     work_directory_must_be_writeable = False
 
+    default_verify_server_cert = True
+
     # -------------------------------------------------------------------------
     def __init__(
         self, appname=None, verbose=0, version=GLOBAL_VERSION, base_dir=None,
@@ -76,6 +79,7 @@ class BaseDdnsApplication(FbConfigApplication):
             description = _('This is a base DDNS related application.')
 
         self._user_agent = '{}/{}'.format(self.library_name, GLOBAL_VERSION)
+        self._verify_server_cert = self.default_verify_server_cert
 
         super(BaseDdnsApplication, self).__init__(
             appname=appname, verbose=verbose, version=version, base_dir=base_dir,
@@ -99,6 +103,19 @@ class BaseDdnsApplication(FbConfigApplication):
             raise DdnsAppError(_('Invalid user agent {!r} given.').format(value))
         self._user_agent = str(value).strip()
 
+    # -----------------------------------------------------------
+    @property
+    def verify_server_cert(self):
+        """Return whether to verify the SSL certificate of the requested server."""
+        return self._verify_server_cert
+
+    @verify_server_cert.setter
+    def verify_server_cert(self, value):
+        if value is None:
+            self._verify_server_cert = self.default_verify_server_cert
+            return
+        self._verify_server_cert = to_bool(value)
+
     # -------------------------------------------------------------------------
     @property
     def has_dns_module(self):
@@ -119,6 +136,7 @@ class BaseDdnsApplication(FbConfigApplication):
         res = super(BaseDdnsApplication, self).as_dict(short=short)
         res['has_dns_module'] = self.has_dns_module
         res['user_agent'] = self.user_agent
+        res['verify_server_cert'] = self.verify_server_cert
 
         return res
 
@@ -176,6 +194,14 @@ class BaseDdnsApplication(FbConfigApplication):
                 DdnsConfiguration.default_timeout),
         )
 
+        ddns_group.add_argument(
+            '-k', '--insecure', dest='insecure', action='store_true',
+            help=_(
+                'By default, every secure connection {app} makes is verified to be secure before '
+                'the request takes place. This option makes {app} skip the verification step and '
+                'proceed without checking.').format(app=self.appname),
+        )
+
         super(BaseDdnsApplication, self).init_arg_parser()
 
     # -------------------------------------------------------------------------
@@ -225,6 +251,9 @@ class BaseDdnsApplication(FbConfigApplication):
             logging.getLogger('requests').setLevel(logging.WARNING)
             self.loglevel_requests_set = True
 
+        if self.args.insecure:
+            self.verify_server_cert = False
+
         self.initialized = True
 
     # -------------------------------------------------------------------------
@@ -251,6 +280,15 @@ class BaseDdnsApplication(FbConfigApplication):
             self, url, method='GET', data=None, headers=None, may_simulate=False,
             return_json=True):
         """Perform the underlying Web request."""
+        verify = None
+        if url.startswith('https://'):
+            if self.verify_server_cert:
+                verify = True
+            else:
+                verify = False
+                urllib3.disable_warnings()
+            LOG.debug(f'Verifying remote server certificate: {verify!r}.')
+
         if headers is None:
             headers = {}
 
@@ -282,7 +320,7 @@ class BaseDdnsApplication(FbConfigApplication):
 
             session = requests.Session()
             response = session.request(
-                method, url, data=data, headers=headers, timeout=self.cfg.timeout)
+                method, url, data=data, headers=headers, timeout=self.cfg.timeout, verify=verify)
 
         except (
                 socket.timeout, urllib3.exceptions.ConnectTimeoutError,

{fb_tools-2.6.3 → fb_tools-2.7.0}/lib/fb_tools/errors.py

@@ -14,7 +14,7 @@ import signal
 # Own modules
 from .xlate import XLATOR
 
-__version__ = '2.3.1'
+__version__ = '2.4.0'
 
 _ = XLATOR.gettext
 ngettext = XLATOR.ngettext
@@ -150,6 +150,13 @@ class AbortAppError(FbAppError):
     pass
 
 
+# =============================================================================
+class ExitAppError(FbAppError):
+    """Special exception class exiting the application."""
+
+    pass
+
+
 # =============================================================================
 class FbCfgAppError(FbAppError):
     """Generic exception class for all configured application classes."""

{fb_tools-2.6.3 → fb_tools-2.7.0}/lib/fb_tools/handling_obj.py

@@ -51,12 +51,17 @@ import six
 from . import DEFAULT_TERMINAL_HEIGHT, DEFAULT_TERMINAL_WIDTH
 from .common import caller_search_path, encode_or_bust, pp, to_bool, to_str
 from .common import indent, is_sequence
-from .errors import AbortAppError, TimeoutOnPromptError
-from .errors import InterruptError, IoTimeoutError, ReadTimeoutError, WriteTimeoutError
+from .errors import AbortAppError
+from .errors import ExitAppError
+from .errors import InterruptError
+from .errors import IoTimeoutError
+from .errors import ReadTimeoutError
+from .errors import TimeoutOnPromptError
+from .errors import WriteTimeoutError
 from .obj import FbBaseObject
 from .xlate import XLATOR, format_list
 
-__version__ = '2.2.5'
+__version__ = '2.3.0'
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
@@ -941,7 +946,9 @@ class HandlingObject(FbBaseObject):
         return
 
     # -------------------------------------------------------------------------
-    def get_password(self, first_prompt=None, second_prompt=None, may_empty=True, repeat=True):
+    def get_password(
+            self, first_prompt=None, second_prompt=None, may_empty=True, repeat=True,
+            raise_on_exit=False):
         """
         Ask the user for a password on the console.
 
@@ -959,6 +966,9 @@ class HandlingObject(FbBaseObject):
         @param repeat: Asking for the password a second time, which must be equal
                        to the first given password.
         @type repeat: bool
+        @param raise_on_exit: raising an ExitAppError instead of exiting the application
+                              in different situations
+        @type raise_on_exit: bool
 
         @return: The entered password
         @rtype: str
@@ -977,10 +987,11 @@ class HandlingObject(FbBaseObject):
 
             if not self.quiet:
                 print()
-            ret_passwd = self._get_password(first_prompt, may_empty)
+            ret_passwd = self._get_password(first_prompt, may_empty, raise_on_exit=raise_on_exit)
             if ret_passwd:
                 if repeat:
-                    second_passwd = self._get_password(second_prompt, may_empty=False)
+                    second_passwd = self._get_password(
+                        second_prompt, may_empty=False, raise_on_exit=raise_on_exit)
                     if ret_passwd != second_passwd:
                         msg = _('The entered passwords does not match.')
                         LOG.error(msg)
@@ -990,7 +1001,7 @@ class HandlingObject(FbBaseObject):
         return ret_passwd
 
     # -------------------------------------------------------------------------
-    def _get_password(self, prompt, may_empty=True):
+    def _get_password(self, prompt, may_empty=True, raise_on_exit=False):
 
         def passwd_alarm_caller(signum, sigframe):
             raise TimeoutOnPromptError(self.prompt_timeout)
@@ -1021,13 +1032,19 @@ class HandlingObject(FbBaseObject):
 
         except (TimeoutOnPromptError, AbortAppError) as e:
             msg = _('Got a {}:').format(e.__class__.__name__) + ' ' + str(e)
-            LOG.error(msg)
-            sys.exit(10)
+            if raise_on_exit:
+                raise ExitAppError(msg)
+            else:
+                LOG.error(msg)
+                sys.exit(10)
 
         except KeyboardInterrupt:
             msg = _('Got a {}:').format('KeyboardInterrupt') + ' ' + msg_intr
-            LOG.error(msg)
-            sys.exit(10)
+            if raise_on_exit:
+                raise ExitAppError(msg)
+            else:
+                LOG.error(msg)
+                sys.exit(10)
 
         finally:
             signal.alarm(0)

{fb_tools-2.6.3 → fb_tools-2.7.0}/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.3'
+__version__ = '2.7.0'
 __license__ = 'LGPL3+'
 
 # vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

fb_tools-2.7.0/lib/fb_tools/show_spinner_app.py

@@ -0,0 +1,300 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@summary: The module for the show-spinner application class.
+
+@author: Frank Brehm
+@contact: frank.brehm@pixelpark.com
+@copyright: © 2024 by Frank Brehm, Berlin
+"""
+from __future__ import absolute_import
+
+# Standard modules
+import copy
+import logging
+import random
+import signal
+import sys
+import time
+
+# Third party modules
+
+# Own modules
+from . import __version__ as __global_version__
+from .app import BaseApplication
+from .app import SIGNAL_NAMES
+from .spinner import CycleList
+from .spinner import Spinner
+from .xlate import XLATOR
+
+__version__ = '0.2.0'
+LOG = logging.getLogger(__name__)
+
+_ = XLATOR.gettext
+ngettext = XLATOR.ngettext
+
+# =============================================================================
+class ShowSpinnerApplication(BaseApplication):
+    """Class for the show-spinner application object."""
+
+    default_show_time = 6
+    default_spinner = 'random'
+    default_prompt = _('Waiting ... ')
+
+    # -------------------------------------------------------------------------
+    def __init__(
+            self, verbose=0, version=__global_version__, *arg, **kwargs):
+        """Initialise of the show-spinnerapplication object."""
+        desc = _(
+            'Shows one or more spinners, and their names, if multiple spinners should be shown. '
+            'If no spinner is given, a random spinner will be displayed.')
+
+        self._show_time = None
+        self._prompt = self.default_prompt
+
+        self.spinners = []
+        self.all_spinners = sorted(CycleList.keys(), key=str.lower)
+
+        super(ShowSpinnerApplication, self).__init__(
+            description=desc,
+            verbose=verbose,
+            version=version,
+            *arg, **kwargs
+        )
+
+        self.initialized = True
+
+    # -----------------------------------------------------------
+    @property
+    def show_time(self):
+        """Give the number of seconds for displaying each spinner."""
+        return self._show_time
+
+    @show_time.setter
+    def show_time(self, value):
+        if value is None:
+            self._show_time = None
+            return
+
+        v = float(value)
+        if v < 0:
+            msg = _(
+                'A negative time for showing the spinner {v!r} is not allowed.').format(
+                value)
+            raise ValueError(msg)
+
+        if v == 0:
+            self._show_time = None
+        else:
+            self._show_time = v
+
+    # -----------------------------------------------------------
+    @property
+    def prompt(self):
+        """Give the prompt displayed before the spinner."""
+        return self._prompt
+
+    @prompt.setter
+    def prompt(self, value):
+        if value is None:
+            self._prompt = ''
+            return
+
+        self._prompt = str(value)
+
+    # -------------------------------------------------------------------------
+    def as_dict(self, short=True):
+        """
+        Transform the elements of the object into a dict.
+
+        @param short: don't include local properties in resulting dict.
+        @type short: bool
+
+        @return: structure as dict
+        @rtype:  dict
+        """
+        res = super(ShowSpinnerApplication, self).as_dict(short=short)
+
+        res['prompt'] = self.prompt
+        res['show_time'] = self.show_time
+
+        return res
+
+    # -------------------------------------------------------------------------
+    def init_arg_parser(self):
+        """Initialise the argument parser."""
+        super(ShowSpinnerApplication, self).init_arg_parser()
+
+        app_group = self.arg_parser.add_argument_group(_('Options for {}').format(self.appname))
+
+        app_group.add_argument(
+            '-P', '--prompt', dest='prompt',
+            help=_(
+                'The prompt displayed before the spinner, if only one spinner should be shown. '
+                'Default: {!r}.').format(self.default_prompt),
+        )
+
+        app_group.add_argument(
+            '-t', '--time', dest='time', metavar=_('SECONDS'), type=float,
+            help=_(
+                'The time in seconds for displaying each spinner.').format(
+                self.default_show_time),
+        )
+
+        app_group.add_argument(
+            'spinnerei', metavar=_('SPINNER'), type=str, nargs='*',
+            help=_(
+                'The spinners, which should be displayed. If not given, a random spinner will be '
+                'displayed, which is the same as giving {rand!r} as the name of the spinner. '
+                'If giving {list!r}, a simple list of all available spinners will be shown, '
+                'without displaying them. If giving {all!r}, all available spinners will be '
+                'shown.').format(rand='random', list='list', all='all'),
+        )
+
+    # -------------------------------------------------------------------------
+    def perform_arg_parser(self):
+        """Parse the command line options."""
+        if self.args.prompt is not None:
+            self.prompt = self.args.prompt
+
+        if self.args.time is not None:
+            try:
+                self.show_time = self.args.time
+            except (ValueError, TypeError) as e:
+                LOG.error(str(e))
+                self.arg_parser.print_usage(sys.stdout)
+                self.exit(1)
+
+        all_spinners = ['random'] + self.all_spinners
+
+        if self.args.spinnerei:
+            for spinner in self.args.spinnerei:
+                if spinner == 'all':
+                    if len(self.spinners):
+                        msg = _('You may give {!r} only as the only spinner.').format('all')
+                        LOG.error(msg)
+                        self.arg_parser.print_usage(sys.stdout)
+                        self.exit(1)
+                    self.spinners.append(spinner)
+                    if not self.show_time:
+                        self.show_time = self.default_show_time
+                    continue
+
+                if spinner == 'list':
+                    if len(self.spinners):
+                        msg = _('You may give {!r} only as the only spinner.').format('list')
+                        LOG.error(msg)
+                        self.arg_parser.print_usage(sys.stdout)
+                        self.exit(1)
+                    self.spinners.append(spinner)
+                    continue
+
+                if spinner not in all_spinners:
+                    msg = _('Invalid spinner {!r} given.').format(spinner)
+                    LOG.error(msg)
+                    self.arg_parser.print_usage(sys.stdout)
+                    self.exit(1)
+
+                self.spinners.append(spinner)
+        else:
+            self.spinners.append(self.default_spinner)
+
+    # -------------------------------------------------------------------------
+    def _run(self):
+        """Run the application."""
+        prompt = self.prompt
+
+        show_time = 1
+        if self.show_time:
+            show_time = self.show_time
+
+        if 'list' in self.spinners:
+            self.list_spinners()
+            self.exit(0)
+
+        if 'all' in self.spinners:
+            self.spinners = copy.copy(self.all_spinners)
+
+        if len(self.spinners) > 1 or ('random' in self.spinners and self.args.prompt is None):
+            prompt = _('Spinner {!r}: ')
+
+        # ---------------------
+        def _signal_handler(signum, frame):
+
+            signame = '{}'.format(signum)
+            msg = _('Got a signal {}.').format(signum)
+            if signum in SIGNAL_NAMES:
+                signame = SIGNAL_NAMES[signum]
+                msg = _('Got a signal {n!r} ({s}).').format(
+                    n=signame, s=signum)
+            LOG.debug(msg)
+
+            if signum in (
+                    signal.SIGHUP, signal.SIGINT, signal.SIGABRT,
+                    signal.SIGTERM, signal.SIGKILL, signal.SIGQUIT):
+                print()
+                if self.verbose > 1:
+                    LOG.info(_('Exit on signal {n!r} ({s}).').format(n=signame, s=signum))
+                self.exit(0)
+
+        # ------------------------
+        old_handlers = {}
+
+        if self.verbose > 2:
+            LOG.debug(_('Tweaking signal handlers.'))
+        for signum in (
+                signal.SIGHUP, signal.SIGINT, signal.SIGABRT,
+                signal.SIGTERM, signal.SIGQUIT):
+            if self.verbose > 3:
+                signame = SIGNAL_NAMES[signum]
+                LOG.debug(_('Setting signal handler for {n!r} ({s}).').format(
+                    n=signame, s=signum))
+            old_handlers[signum] = signal.signal(signum, _signal_handler)
+
+        try:
+            for spinner_name in self.spinners:
+                if spinner_name == 'random':
+                    spinner_name = self._get_random_spinner_name()
+                print(prompt.format(spinner_name), end='', flush=True)
+
+                with Spinner('', spinner_name):
+                    if self.show_time:
+                        time.sleep(show_time)
+                    else:
+                        while True:
+                            time.sleep(show_time)
+                print()
+        finally:
+            if self.verbose > 2:
+                LOG.debug(_('Restoring original signal handlers.'))
+            for signum in old_handlers.keys():
+                signal.signal(signum, old_handlers[signum])
+
+        self.exit(0)
+
+    # -------------------------------------------------------------------------
+    def _get_random_spinner_name(self):
+
+        randomizer = random.SystemRandom()
+        return randomizer.choice(list(CycleList.keys()))
+
+    # -------------------------------------------------------------------------
+    def list_spinners(self):
+        """Print out a list of all available spinners."""
+        if self.verbose:
+            title = _('All available spinners:')
+            print(title)
+            print('-' * len(title))
+
+        for spinner_name in self.all_spinners:
+            print(spinner_name)
+
+
+# =============================================================================
+if __name__ == '__main__':
+
+    pass
+
+# =============================================================================
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

{fb_tools-2.6.3 → fb_tools-2.7.0/lib/fb_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.6.3
+Version: 2.7.0
 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.3 → fb_tools-2.7.0}/lib/fb_tools.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ setup.cfg
 setup.py
 bin/get-file-to-remove
 bin/myip
+bin/show-spinner
 bin/update-ddns
 lib/fb_tools/__init__.py
 lib/fb_tools/app.py
@@ -22,6 +23,7 @@ lib/fb_tools/mailaddress.py
 lib/fb_tools/merge.py
 lib/fb_tools/obj.py
 lib/fb_tools/pidfile.py
+lib/fb_tools/show_spinner_app.py
 lib/fb_tools/spinner.py
 lib/fb_tools/xlate.py
 lib/fb_tools.egg-info/PKG-INFO