fb-tools 2.5.1__tar.gz → 2.5.2__tar.gz

{fb_tools-2.5.1/lib/fb_tools.egg-info → fb_tools-2.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.5.1
+Version: 2.5.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.5.1 → fb_tools-2.5.2}/lib/fb_tools/__init__.py

@@ -15,7 +15,7 @@ DEFAULT_ENCODING = UTF8_ENCODING
 DEFAULT_TERMINAL_WIDTH = 99
 DEFAULT_TERMINAL_HEIGHT = 40
 
-__version__ = '2.5.1'
+__version__ = '2.5.2'
 
 from .mailaddress import MailAddress, QualifiedMailAddress, MailAddressList     # noqa
 from .multi_config import BaseMultiConfig                                       # noqa

{fb_tools-2.5.1 → fb_tools-2.5.2}/lib/fb_tools/handling_obj.py

@@ -56,7 +56,7 @@ from .errors import InterruptError, IoTimeoutError, ReadTimeoutError, WriteTimeo
 from .obj import FbBaseObject
 from .xlate import XLATOR, format_list
 
-__version__ = '2.2.3'
+__version__ = '2.2.4'
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
@@ -171,8 +171,9 @@ class HandlingObject(FbBaseObject):
     pattern_yes_no = r'^\s*(' + '|'.join(yes_list) + '|' + '|'.join(no_list) + r')?\s*$'
     re_yes_no = re.compile(pattern_yes_no, re.IGNORECASE)
 
-    valid_address_families = ('any', socket.AF_INET, 'ipv4', socket.AF_INET6, 'ipv6')
-    valid_address_families_out = ("'any'", 'socket.AF_INET', "'IPv4'", 'socket.AF_INET6', "'IPv6'")
+    valid_address_families = ('any', 0, socket.AF_INET, 'ipv4', 4, socket.AF_INET6, 'ipv6', 6)
+    valid_address_families_out = (
+        "'any'", '0', 'socket.AF_INET', "'IPv4'", '4', 'socket.AF_INET6', "'IPv6'", '6')
 
     # -------------------------------------------------------------------------
     def __init__(
@@ -330,6 +331,12 @@ class HandlingObject(FbBaseObject):
             family = socket.AF_INET
         elif family == 'ipv6':
             family = socket.AF_INET6
+        elif family == 0:
+            family = 'any'
+        elif family == 4:
+            family = socket.AF_INET
+        elif family == 6:
+            family = socket.AF_INET6
         self._address_family = family
 
     # -------------------------------------------------------------------------
@@ -366,7 +373,7 @@ class HandlingObject(FbBaseObject):
         @rtype:  dict
         """
         res = super(HandlingObject, self).as_dict(short=short)
-        res['address_family'] = self.assumed_answer
+        res['address_family'] = self.address_family
         res['assumed_answer'] = self.assumed_answer
         res['fileio_timeout'] = self.fileio_timeout
         res['force'] = self.force
@@ -414,7 +421,9 @@ class HandlingObject(FbBaseObject):
         if isinstance(address_family, str):
             family = address_family.lower()
 
-        if family is not None and family not in self.valid_address_families:
+        if family is None:
+            family = self.address_family
+        elif family not in self.valid_address_families:
             msg = _('Wrong address family {!r} given. Valid values are:').format(address_family)
             msg += ' ' + format_list(['None'] + list(self.valid_address_families_out))
             raise ValueError(msg)
@@ -424,12 +433,18 @@ class HandlingObject(FbBaseObject):
 
         if family == 'any':
             return 0
+        elif family == 0:
+            return 0
         elif family == 'ipv4':
             return socket.AF_INET
+        elif family == 4:
+            return socket.AF_INET
         elif family == 'ipv6':
             return socket.AF_INET6
+        elif family == 6:
+            return socket.AF_INET6
 
-        return address_family
+        return family
 
     # -------------------------------------------------------------------------
     def get_address(self, host, address_family=None):
@@ -440,6 +455,8 @@ class HandlingObject(FbBaseObject):
         @param address_family: Limit the result to the addresses of the given address family.
         """
         af = self.get_address_famlily_int(address_family)
+        if self.verbose > 3:
+            LOG.debug(f'Got the integer address family {af!r} for {address_family!r}.')
 
         try:
             address = ipaddress.ip_address(host)

{fb_tools-2.5.1 → fb_tools-2.5.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.5.1'
+__version__ = '2.5.2'
 __license__ = 'LGPL3+'
 
 # vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

{fb_tools-2.5.1 → fb_tools-2.5.2/lib/fb_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.5.1
+Version: 2.5.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.5.1 → fb_tools-2.5.2}/test/test_20_handling_object.py

@@ -84,7 +84,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_import(self):
         """Test instantiating fb_tools.handling_obj."""
-        LOG.info('Testing import of fb_tools.handling_obj ...')
+        LOG.info(self.get_method_doc())
         import fb_tools.handling_obj
         LOG.debug('Version of fb_tools.handling_obj: {!r}.'.format(
             fb_tools.handling_obj.__version__))
@@ -112,7 +112,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_called_process_error(self):
         """Test raising a CalledProcessError exception."""
-        LOG.info('Testing raising a CalledProcessError exception ...')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.handling_obj import CalledProcessError
 
@@ -150,7 +150,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_timeout_expired_error(self):
         """Test raising a TimeoutExpiredError exception."""
-        LOG.info('Testing raising a TimeoutExpiredError exception ...')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.handling_obj import TimeoutExpiredError
 
@@ -189,7 +189,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_generic_handling_object(self):
         """Test init of a generic handling object."""
-        LOG.info('Testing init of a generic handling object.')
+        LOG.info(self.get_method_doc())
 
         import fb_tools.handling_obj
         from fb_tools.handling_obj import HandlingObject
@@ -223,7 +223,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_completed_process(self):
         """Test class CompletedProcess."""
-        LOG.info('Testing class CompletedProcess.')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.handling_obj import CompletedProcess
         from fb_tools.handling_obj import CalledProcessError
@@ -258,7 +258,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     @unittest.skipUnless(EXEC_LONG_TESTS, 'Long terming tests are not executed.')
     def test_run_simple(self):
         """Test execution of a shell script."""
-        LOG.info('Testing execution of a shell script.')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.common import pp
         from fb_tools.handling_obj import HandlingObject, CompletedProcess
@@ -293,7 +293,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     @unittest.skipUnless(EXEC_LONG_TESTS, 'Long terming tests are not executed.')
     def test_run_timeout(self):
         """Test timing out the run() method."""
-        LOG.info('Testing timing out the run() method.')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.handling_obj import HandlingObject
         from fb_tools.handling_obj import TimeoutExpiredError
@@ -325,7 +325,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_read_file(self):
         """Test method read_file() of class HandlingObject."""
-        LOG.info('Testing method read_file() of class HandlingObject.')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.common import to_unicode, to_str, encode_or_bust
 
@@ -394,7 +394,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_write_file(self):
         """Test method write_file() of class HandlingObject."""
-        LOG.info('Testing method write_file() of class HandlingObject.')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.common import to_unicode, encode_or_bust
 
@@ -429,7 +429,7 @@ class TestFbHandlingObject(FbToolsTestcase):
     # -------------------------------------------------------------------------
     def test_get_command(self):
         """Test method get_command() of class HandlingObject."""
-        LOG.info('Testing method get_command() of class HandlingObject.')
+        LOG.info(self.get_method_doc())
 
         from fb_tools.handling_obj import HandlingObject
 
@@ -504,12 +504,89 @@ class TestFbHandlingObject(FbToolsTestcase):
         self.assertIsInstance(p, Path)
         self.assertEqual(p.name, cmd)
 
+    # -------------------------------------------------------------------------
+    def test_get_int_addressfamily(self):
+        """Test property address_famlily and method get_address_famlily_int()."""
+        LOG.info(self.get_method_doc())
+
+        import socket
+
+        from fb_tools.handling_obj import HandlingObject
+
+        hdlr = HandlingObject(
+            appname=self.appname,
+            verbose=self.verbose,
+        )
+
+        af = hdlr.address_family
+        LOG.debug(f'Default value of property address_famlily is {af!r}.')
+        self.assertEqual(hdlr.address_family, 'any')
+
+        test_data = (
+            (socket.AF_INET, socket.AF_INET),
+            ('ipv4', socket.AF_INET),
+            (4, socket.AF_INET),
+            (socket.AF_INET6, socket.AF_INET6),
+            ('ipv6', socket.AF_INET6),
+            (6, socket.AF_INET6),
+            ('any', 'any'),
+            (0, 'any'),
+        )
+
+        for pair in test_data:
+            test_val = pair[0]
+            exp_val = pair[1]
+            LOG.debug(f'Testing {test_val!r} for property address_family, expecting {exp_val!r}.')
+            hdlr.address_family = test_val
+            af = hdlr.address_family
+            LOG.debug(f'Value of property address_famlily is {af!r}.')
+            self.assertEqual(af, exp_val)
+
+        test_data = (None, '0', 3, '4', 'bla')
+        for test_val in test_data:
+            LOG.debug(f'Testing {test_val!r} for property address_family.')
+            with self.assertRaises(ValueError) as cm:
+                hdlr.address_family = test_val
+            e = cm.exception
+            LOG.debug('{} raised: {}'.format(e.__class__.__name__, e))
+
+        hdlr.address_family = 0
+
+        test_data = (
+            (None, 0),
+            (0, 0),
+            ('any', 0),
+            (socket.AF_INET, socket.AF_INET),
+            ('ipv4', socket.AF_INET),
+            (4, socket.AF_INET),
+            (socket.AF_INET6, socket.AF_INET6),
+            ('ipv6', socket.AF_INET6),
+            (6, socket.AF_INET6),
+        )
+
+        for pair in test_data:
+            test_val = pair[0]
+            exp_val = pair[1]
+            LOG.debug(
+                f'Testing {test_val!r} for get_address_famlily_int(), expecting {exp_val!r}.')
+            af = hdlr.get_address_famlily_int(test_val)
+            LOG.debug(f'Return value of get_address_famlily_int() is {af!r}.')
+            self.assertEqual(af, exp_val)
+
+        test_data = ('0', 3, '4', 'bla', object())
+        for test_val in test_data:
+            LOG.debug(f'Testing get_address_famlily_int({test_val!r}) ...')
+            with self.assertRaises(ValueError) as cm:
+                af = hdlr.get_address_famlily_int(test_val)
+            e = cm.exception
+            LOG.debug('{} raised: {}'.format(e.__class__.__name__, e))
+
     # -------------------------------------------------------------------------
     @unittest.skipUnless(
         EXEC_DNS_DEPENDING_TESTS, 'Tests depending on external DNS are not executed.')
     def test_get_address(self):
         """Test method get_address() of class HandlingObject."""
-        LOG.info('Testing method get_address() of class HandlingObject.')
+        LOG.info(self.get_method_doc())
 
         import ipaddress
         import socket
@@ -574,6 +651,7 @@ if __name__ == '__main__':
     suite.addTest(TestFbHandlingObject('test_read_file', verbose))
     suite.addTest(TestFbHandlingObject('test_write_file', verbose))
     suite.addTest(TestFbHandlingObject('test_get_command', verbose))
+    suite.addTest(TestFbHandlingObject('test_get_int_addressfamily', verbose))
     suite.addTest(TestFbHandlingObject('test_get_address', verbose))
 
     runner = unittest.TextTestRunner(verbosity=verbose)