fb-tools 3.1.0__tar.gz → 3.2.0__tar.gz

{fb_tools-3.1.0 → fb_tools-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fb_tools
-Version: 3.1.0
+Version: 3.2.0
 Summary: @summary: A module for common used objects, error classes and functions.
 Author-email: Frank Brehm <frank@brehm-online.com>
 Requires-Python: >=3.8

{fb_tools-3.1.0 → fb_tools-3.2.0}/src/fb_tools/__init__.py

@@ -32,6 +32,6 @@ MAX_INDENT = 12
 from .mailaddress import MailAddress, MailAddressList, QualifiedMailAddress  # noqa: F401
 from .multi_config import BaseMultiConfig  # noqa: F401
 
-__version__ = "3.1.0"
+__version__ = "3.2.0"
 
 # vim: ts=4 et list

{fb_tools-3.1.0 → fb_tools-3.2.0}/src/fb_tools/socket_obj/__init__.py

@@ -34,7 +34,7 @@ from ..errors import GenericSocketError
 from ..handling_obj import HandlingObject
 from ..xlate import XLATOR
 
-__version__ = "0.7.2"
+__version__ = "0.8.0"
 
 LOG = logging.getLogger(__name__)
 
@@ -71,6 +71,7 @@ class GenericSocket(HandlingObject):
     * initialized        (bool         - rw) (inherited from FbBaseObject)
     * interrupted        (bool         - rw) (inherited from HandlingObject)
     * is_venv            (bool         - ro) (inherited from HandlingObject)
+    * name               (str          - ro)
     * polling_interval   (float        - rw)
     * prompt_timeout     (int          - rw) (inherited from HandlingObject)
     * quiet              (bool         - rw) (inherited from HandlingObject)
@@ -365,6 +366,12 @@ class GenericSocket(HandlingObject):
 
         self._polling_interval = v
 
+    # -----------------------------------------------------------
+    @property
+    def name(self):
+        """Return a descriptive name of this socket."""
+        return self._name()
+
     # -------------------------------------------------------------------------
     @abstractmethod
     def connect(self):
@@ -377,6 +384,17 @@ class GenericSocket(HandlingObject):
         """Create the socket and listen on it."""
         raise FunctionNotImplementedError("bind", self.__class__.__name__)
 
+    # -------------------------------------------------------------------------
+    @abstractmethod
+    def _name(self):
+        """
+        Return a descriptive name of this socket.
+
+        It might be unique on the system as possible.
+        This methos ha to be overridden in descendent classes.
+        """
+        raise FunctionNotImplementedError("_name", self.__class__.__name__)
+
     # -------------------------------------------------------------------------
     def as_dict(self, short=False):
         """
@@ -395,6 +413,7 @@ class GenericSocket(HandlingObject):
         res["connected"] = self.connected
         res["encoding"] = self.encoding
         res["fileno"] = self.fileno
+        res["name"] = self.name
         res["polling_interval"] = self.polling_interval
         res["request_queue_size"] = self.request_queue_size
         res["timeout"] = self.timeout
@@ -666,6 +685,22 @@ class GenericSocket(HandlingObject):
 
         return result
 
+    # -------------------------------------------------------------------------
+    def __enter__(self):
+        """Execute this action, when this socket will be opened by the with-block."""
+        LOG.debug(
+            _("Opened the {cls} {name!r} ...").format(cls=self.__class__.__name__, name=self.name)
+        )
+
+    # -------------------------------------------------------------------------
+    def __exit__(self, exc_type, exc_val, exc_traceback):
+        """Exit action at the end of the with-block - closing socket."""
+        LOG.debug(
+            _("Closing the {cls} {name!r} ...").format(cls=self.__class__.__name__, name=self.name)
+        )
+
+        self.close()
+
 
 # =============================================================================
 

{fb_tools-3.1.0 → fb_tools-3.2.0}/src/fb_tools/socket_obj/tcp.py

@@ -24,7 +24,7 @@ from ..common import pp
 from ..errors import GenericSocketError
 from ..xlate import XLATOR
 
-__version__ = "0.4.2"
+__version__ = "0.5.0"
 
 LOG = logging.getLogger(__name__)
 
@@ -67,6 +67,7 @@ class TcpSocket(GenericSocket):
     * initialized        (bool              - rw) (inherited from FbBaseObject)
     * interrupted        (bool              - rw) (inherited from HandlingObject)
     * is_venv            (bool              - ro) (inherited from HandlingObject)
+    * name               (str               - ro) (inherited from GenericSocket)
     * own_address        (ipaddress         - ro)
     * polling_interval   (float             - rw) (inherited from GenericSocket)
     * port               (int               - rw)
@@ -111,10 +112,11 @@ class TcpSocket(GenericSocket):
         @raise TcpSocketError: on a uncoverable error.
 
         @param address: the hostname or IP address, where to connect to or on which listening to.
-                        If it can be converted to a IPy.IP object, an IP address is assumed.
+                        If it can be converted to a ipaddress._BaseAddress object,
+                        an IP address is assumed.
                         If None is given, then the socket will listen on all local IP addresses -
                         not usable for client sockets.  Else a hostname is assumed.
-        @type address: str or IPy.IP or None
+        @type address: str or ipaddress.IPv4Address or ipaddress.IPv6Address or None
         @param port: the TCP port number, where to connect to or on which should be listened.
         @type port: int
         @param address_family: the IP address family, may be socket.AF_INET or socket.AF_INET6 or
@@ -177,7 +179,7 @@ class TcpSocket(GenericSocket):
         """
         @ivar: The resolved IP address, where to connect to or on which listening to.
                If self.address is '*', the self.resolved_address stays to None.
-        @type: IPy.IP or None
+        @type: ipaddress.IPv4Address or ipaddress.IPv6Address or None
         """
 
         self.port = port
@@ -401,6 +403,8 @@ class TcpSocket(GenericSocket):
         self._resolved_address = ip_addr
         self._own_address = self.sock.getsockname()
 
+        return self
+
     # -------------------------------------------------------------------------
     def bind(self):
         """Create a TCP socket and listen on it."""
@@ -500,6 +504,25 @@ class TcpSocket(GenericSocket):
         self._resolved_address = socketaddr[0]
         self._own_address = self.sock.getsockname()
 
+        return self
+
+    # -------------------------------------------------------------------------
+    def _name(self):
+        """Return a descriptive name of this socket."""
+        if self.address is None:
+            return f"*:{self.port}"
+
+        addr = str(self.address)
+        try:
+            ip_addr = ipaddress.ip_address(self.address)
+        except ValueError:
+            return f"{addr}:{self.port}"
+
+        if ip_addr.version == 4:
+            return f"{ip_addr}:{self.port}"
+
+        return f"[{ip_addr}]:{self.port}"
+
 
 # =============================================================================
 

{fb_tools-3.1.0 → fb_tools-3.2.0}/src/fb_tools/socket_obj/unix.py

@@ -29,7 +29,7 @@ from . import GenericSocket
 from ..errors import GenericSocketError
 from ..xlate import XLATOR
 
-__version__ = "0.5.2"
+__version__ = "0.6.0"
 
 LOG = logging.getLogger(__name__)
 
@@ -468,6 +468,8 @@ class UnixSocket(GenericSocket):
         self._connected = True
         self.fileno = self.sock.fileno()
 
+        return self
+
     # -------------------------------------------------------------------------
     def _set_socket_permissions(self):
         """Set file mode, owner and group to the socket file."""
@@ -540,6 +542,13 @@ class UnixSocket(GenericSocket):
             )
         self.sock.listen(self.request_queue_size)
 
+        return self
+
+    # -------------------------------------------------------------------------
+    def _name(self):
+        """Return a descriptive name of this socket."""
+        return str(self.filename)
+
 
 # =============================================================================