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

{fb_tools-2.7.0 → fb_tools-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.7.0
+Version: 2.8.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 → fb_tools-2.8.0}/bin/get-file-to-remove

@@ -4,7 +4,7 @@
 @summary: Print a newline separated list of files generated from file globbing patterns.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import print_function
@@ -58,8 +58,8 @@ from fb_tools.xlate import XLATOR
 
 _ = XLATOR.gettext
 
-__author__ = 'Frank Brehm <frank.brehm@pixelpark.com>'
-__copyright__ = '(C) 2024 by Frank Brehm, Pixelpark GmbH, Berlin'
+__author__ = 'Frank Brehm <frank@brehm-online.com>'
+__copyright__ = '(C) 2024 by Frank Brehm, Berlin'
 
 appname = my_path.name
 

{fb_tools-2.7.0 → fb_tools-2.8.0}/bin/myip

@@ -4,7 +4,7 @@
 @summary: Prints the public NAT IPv4 address and/or the automatic assigned IPv6 address.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import print_function

{fb_tools-2.7.0 → fb_tools-2.8.0}/bin/show-spinner

@@ -4,7 +4,7 @@
 @summary: Print a newline separated list of files generated from file globbing patterns.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import print_function
@@ -58,8 +58,8 @@ from fb_tools.xlate import XLATOR
 
 _ = XLATOR.gettext
 
-__author__ = 'Frank Brehm <frank.brehm@pixelpark.com>'
-__copyright__ = '(C) 2024 by Frank Brehm, Pixelpark GmbH, Berlin'
+__author__ = 'Frank Brehm <frank@brehm-online.com>'
+__copyright__ = '(C) 2024 by Frank Brehm, Berlin'
 
 appname = my_path.name
 

{fb_tools-2.7.0 → fb_tools-2.8.0}/bin/update-ddns

@@ -4,7 +4,7 @@
 @summary: Update the A and/or AAAA record at ddns.de with the current IP address.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import print_function

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/__init__.py

@@ -13,6 +13,7 @@ UTF8_ENCODING = 'utf-8'
 
 DDNS_CFG_BASENAME = 'ddns.ini'
 MAX_TIMEOUT = 3600
+MAX_PORT_NUMBER = (2 ** 16) - 1
 DEFAULT_ENCODING = UTF8_ENCODING
 DEFAULT_TERMINAL_WIDTH = 99
 DEFAULT_TERMINAL_HEIGHT = 40
@@ -22,6 +23,6 @@ DEFAULT_TERMINAL_HEIGHT = 40
 from .mailaddress import MailAddress, MailAddressList, QualifiedMailAddress     # noqa: F401
 from .multi_config import BaseMultiConfig                                       # noqa: F401
 
-__version__ = '2.7.0'
+__version__ = '2.8.0'
 
 # vim: ts=4 et list

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/app.py

@@ -38,7 +38,7 @@ from .xlate import __lib_dir__ as __xlate_lib_dir__
 from .xlate import __mo_file__ as __xlate_mo_file__
 from .xlate import __module_dir__ as __xlate_module_dir__
 
-__version__ = '2.2.2'
+__version__ = '2.3.0'
 LOG = logging.getLogger(__name__)
 
 SIGNAL_NAMES = {
@@ -57,7 +57,40 @@ _ = XLATOR.gettext
 
 # =============================================================================
 class BaseApplication(HandlingObject):
-    """Class for the base application objects."""
+    """
+    Class for the base application objects.
+
+    Properties:
+    * address_family        (str or int   - rw) (inherited from HandlingObject)
+    * appname               (str          - rw) (inherited from FbBaseObject)
+    * argparse_epilog       (None or str  - ro)
+    * argparse_prefix_chars (str          - ro)
+    * assumed_answer        (None or bool - rw) (inherited from HandlingObject)
+    * base_dir              (pathlib.Path - rw) (inherited from FbBaseObject)
+    * description           (str          - ro)
+    * exit_value            (int          - rw)
+    * exitvalue             (int          - rw)
+    * force                 (bool         - rw) (inherited from HandlingObject)
+    * force_desc_msg        (None or str  - ro)
+    * initialized           (bool         - rw) (inherited from FbBaseObject)
+    * interrupted           (bool         - rw) (inherited from HandlingObject)
+    * is_venv               (bool         - ro) (inherited from HandlingObject)
+    * prompt_timeout        (int          - rw) (inherited from HandlingObject)
+    * quiet                 (bool         - rw) (inherited from HandlingObject)
+    * simulate              (bool         - rw) (inherited from HandlingObject)
+    * testing_args          (array od str - ro)
+    * usage                 (str          - ro)
+    * usage_term            None or int   - ro)
+    * verbose               (int          - rw) (inherited from FbBaseObject)
+    * version               (str          - ro) (inherited from FbBaseObject)
+
+    Public attributes:
+    * add_search_paths       Array of pathlib.Path   (inherited from HandlingObject)
+    * arg_parser             argparse.ArgumentParser
+    * args                   Namespace
+    * env                    Dict
+    * signals_dont_interrupt Array of int            (inherited from HandlingObject)
+    """
 
     re_prefix = re.compile(r'^[a-z0-9][a-z0-9_]*$', re.IGNORECASE)
     re_anum = re.compile(r'[^A-Z0-9_]+', re.IGNORECASE)
@@ -77,72 +110,77 @@ class BaseApplication(HandlingObject):
         self, version=__pkg_version__, usage=None, description=None, testing_args=None,
             argparse_epilog=None, argparse_prefix_chars='-', env_prefix=None,
             initialized=None, *args, **kwargs):
-        """Initialise a BaseApplication object."""
-        self.arg_parser = None
-        """
-        @ivar: argparser object to parse commandline parameters
-        @type: argparse.ArgumentParser
-        """
-
-        self.args = None
-        """
-        @ivar: an object containing all commandline parameters
-               after parsing them
-        @type: Namespace
         """
+        Initialise a BaseApplication object.
 
-        self._exit_value = 0
-        """
-        @ivar: return value of the application for exiting with sys.exit().
+        @param appname: name of the current running application
+        @type: str
+        @param argparse_epilog: an epilog displayed at the end of the argparse help screen
+        @type: str
+        @param argparse_prefix_chars: The set of characters that prefix optional arguments.
+        @type: str
+        @param assumed_answer: The assumed answer to all yes/no questions
+        @type: bool or None
+        @param base_dir: base directory used for different purposes
+        @type: str or pathlib.Path
+        @param description: a short text describing the application
+        @type: str
+        @param env_prefix: a prefix for environment variables to detect them and to assign
+        @type: None or str
+        @param force: Forced execution of something
+        @type: bool
+        @param initialized: initialisation of this object is complete after init
+        @type: bool
+        @param quiet: Quiet execution
+        @type: bool
+        @param simulate: actions with changing a state are not executed
+        @type: bool
+        @param terminal_has_colors: has the current terminal colored output
+        @type: bool
+        @param testing_args: Command line arguments to use for testing purposes.
+        @type: None or list of strings
+        @param verbose: verbosity level (0 - 9)
         @type: int
-        """
-
-        self._usage = usage
-        """
-        @ivar: usage text used on argparse
+        @type: usage: usage text used on argparse
         @type: str
-        """
-
-        self._description = description
-        """
-        @ivar: a short text describing the application
+        @param version: version string of the current object or application
         @type: str
         """
-
+        self._usage = usage
+        self._description = description
         self._testing_args = testing_args
+        self._argparse_epilog = argparse_epilog
+        self._argparse_prefix_chars = argparse_prefix_chars
+        self._env_prefix = None
+
+        self._exit_value = 0
         """
-        @ivar: Command line arguments to use for testing purposes.
-        @type: None or list of strings
+        @ivar: return value of the application for exiting with sys.exit().
+        @type: int
         """
 
-        self._argparse_epilog = argparse_epilog
+        self.arg_parser = None
         """
-        @ivar: an epilog displayed at the end of the argparse help screen
-        @type: str
+        @ivar: argparser object to parse commandline parameters
+        @type: argparse.ArgumentParser
         """
 
-        self._argparse_prefix_chars = argparse_prefix_chars
+        self.args = None
         """
-        @ivar: The set of characters that prefix optional arguments.
-        @type: str
+        @ivar: an object containing all commandline parameters
+               after parsing them
+        @type: Namespace
         """
 
         self.env = {}
         """
-        @ivar: a dictionary with all application specifiv environment variables,
+        @ivar: a dictionary with all application specific environment variables,
                they will detected by the env_prefix property of this object,
                and their names will transformed before saving their values in
                self.env by removing the env_prefix from the variable name.
         @type: dict
         """
 
-        self._env_prefix = None
-        """
-        @ivar: a prefix for environment variables to detect them and to assign
-               their transformed names and their values in self.env
-        @type: str
-        """
-
         super(BaseApplication, self).__init__(
             version=version,
             initialized=False,

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/cfg_app.py

@@ -4,7 +4,7 @@
 @summary: The module for the application object with support for configuration files.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/colcts.py

@@ -6,7 +6,7 @@
 They are providing alternatives to Python's general purpose built-in frozen_set, set and dict.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/collections.py

@@ -6,7 +6,7 @@
 They are providing alternatives to Python's general purpose built-in frozen_set, set and dict.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/common.py

@@ -4,7 +4,7 @@
 @summary: The module for common used functions.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 
@@ -37,7 +37,7 @@ import six
 from .errors import InvalidTimeIntervalError
 from .xlate import XLATOR
 
-__version__ = '2.1.0'
+__version__ = '2.1.1'
 
 _ = XLATOR.gettext
 
@@ -64,6 +64,8 @@ RE_FQDN = re.compile(
     r'(?=^.{4,253}$)(^((?!-)[a-z0-9-]{1,63}(?<!-)\.)+[a-z]{2,63}\.?$)',
     re.IGNORECASE)
 
+RE_FIRST_LINE = re.compile(r'^([^\n]*)(\r?\n)')
+
 CUR_RADIX = locale.nl_langinfo(locale.RADIXCHAR)
 CUR_THOUSEP = locale.nl_langinfo(locale.THOUSEP)
 H2MB_PAT = r'^\s*\+?(\d+(?:' + re.escape(CUR_THOUSEP) + r'\d+)*(?:'

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/config.py

@@ -4,7 +4,7 @@
 @summary: A module for providing a configuration.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import

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

@@ -4,7 +4,7 @@
 @summary: The base module for all DDNS related classes.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import, print_function

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/ddns/myip_app.py

@@ -4,7 +4,7 @@
 @summary: The module for the classes of the myip application.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import, print_function

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/ddns/update_app.py

@@ -4,7 +4,7 @@
 @summary: The module for the classes of the update-ddns application.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import, print_function

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

@@ -14,7 +14,7 @@ import signal
 # Own modules
 from .xlate import XLATOR
 
-__version__ = '2.4.0'
+__version__ = '2.5.1'
 
 _ = XLATOR.gettext
 ngettext = XLATOR.ngettext
@@ -579,6 +579,55 @@ class FileAccessError(CommonFileError, PermissionError):
         return msg
 
 
+# =============================================================================
+class GenericSocketError(FbError):
+    """Base error class for all special exceptions raised in a socket module."""
+
+    pass
+
+
+# =============================================================================
+class SocketReadTimeoutError(IoTimeoutError, GenericSocketError):
+    """Special error class indicating a timout error on a read operation on a socket."""
+
+    # -------------------------------------------------------------------------
+    def __init__(self, timeout, filename=None):
+        """
+        Initialise an SocketReadTimeoutError exception.
+
+        @param timeout: the timout in seconds leading to the error
+        @type timeout: float
+        @param filename: the filename of the socket leading to the error
+        @type filename: str
+        """
+        strerror = _('Timeout error on reading from socket')
+        fn = None
+        if filename is not None:
+            fn = str(filename)
+        super(SocketReadTimeoutError, self).__init__(strerror, timeout, fn)
+
+
+# =============================================================================
+class SocketWriteTimeoutError(IoTimeoutError, GenericSocketError):
+    """Special error class indicating a timout error on a write operation on a socket."""
+
+    # -------------------------------------------------------------------------
+    def __init__(self, timeout, filename=None):
+        """
+        Initialise an SocketWriteTimeoutError exception.
+
+        @param timeout: the timout in seconds leading to the error
+        @type timeout: float
+        @param filename: the filename of the socket leading to the error
+        @type filename: str
+        """
+        strerror = _('Timeout error on writing to socket')
+        fn = None
+        if filename is not None:
+            fn = str(filename)
+        super(SocketWriteTimeoutError, self).__init__(strerror, timeout, fn)
+
+
 # =============================================================================
 
 if __name__ == '__main__':

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/get_file_rm_app.py

@@ -4,7 +4,7 @@
 @summary: The module for the get-file-to-remove application object.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/handler/__init__.py

@@ -4,7 +4,7 @@
 @summary: A base handler module for underlaying actions.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 
 """

{fb_tools-2.7.0 → fb_tools-2.8.0}/lib/fb_tools/handler/lock.py

@@ -4,7 +4,7 @@
 @summary: Module for a extended handler module, which has additional methods for locking.
 
 @author: Frank Brehm
-@contact: frank.brehm@pixelpark.com
+@contact: frank@brehm-online.com
 @copyright: © 2024 by Frank Brehm, Berlin
 """
 from __future__ import absolute_import