block share connection logic, it is not ready for release

Author: marian-code

docs/source/usage_multi.rst

@@ -30,8 +30,7 @@ Instantiating class provides a simple interface similar to factory
 .. code-block:: python
 
     >>> from ssh_utilities import MultiConnection
-    >>> MultiConnection(<server_names_list>, local=False, thread_safe=True,
-    >>>                 share_connection=False)
+    >>> MultiConnection(<server_names_list>, local=False, thread_safe=True)
     >>> <ssh_utilities.ssh_utilities.MultiConnection at 0x7efedff4fb38>
 
 ``MultiConnection`` class can also be used as a contextmanager.
@@ -40,13 +39,13 @@ Instantiating class provides a simple interface similar to factory
 
     >>> from ssh_utilities import MultiConnection
     >>> with MultiConnection(<server_names_list>, local=False,
-                             thread_safe=True, share_connection=False) as mc:
+                             thread_safe=True) as mc:
     >>>     mc.<some_attribute>
     >>>     ...
 
 .. note::
 
-    ``local``, ``thread_safe`` and ``share_connection`` arguments can also be
+    ``local`` and ``thread_safe`` arguments can also be
     lists with length corresponding to ``server_names`` each element in these
     lists will be used with corresponding connection otherwise the arguments
     will be same for all connections.
@@ -78,6 +77,10 @@ without parameters and than add individual connections one by one.
     >>> mc2 = mc + mc1  # you can also join MultiConnection instances
     >>> mc2.update(mc1)  # or use dict interface
 
+.. warning::
+
+    You cannot add more connections under same key!
+
 
 Fully aupported dictionary interface also allows you to easilly access and
 manipulate individual connections in container.

ssh_utilities/multi_connection/_dict_interface.py

@@ -1,9 +1,10 @@
-"""module providing dictionary interface for multi_connection."""
+"""Module providing dictionary interface for multi_connection."""
 
 import logging
 from copy import copy
 from typing import (TYPE_CHECKING, Dict, ItemsView, KeysView, Optional, Tuple,
                     Union, ValuesView, TypeVar)
+from collections.abc import MutableMapping
 
 if TYPE_CHECKING:
     from ..local import LocalConnection
@@ -16,7 +17,7 @@
 log = logging.getLogger(__name__)
 
 
-class DictInterface:
+class DictInterface(MutableMapping):
     """Class providing dictionary interface methods to MultiConnection.
 
     See also

ssh_utilities/multi_connection/_persistence.py

@@ -60,8 +60,8 @@ def __setstate__(self, state: dict):
         )
 
         self.__init__(ssh_servers, local, quiet=True,  # type: ignore
-                      thread_safe=thread_safe,
-                      share_connection=share_connection)
+                      thread_safe=thread_safe)
+                      # share_connection=share_connection)
 
     def to_dict(self) -> Dict[int, Dict[str, Optional[Union[str, bool,
                                                             int, None]]]]:
@@ -139,8 +139,8 @@ def from_dict(cls, json: dict, quiet: bool = False
         )
 
         return cls(ssh_servers, local, quiet=quiet,  # type: ignore
-                   thread_safe=thread_safe,
-                   share_connection=share_connection)
+                   thread_safe=thread_safe)
+                   # share_connection=share_connection)
 
     @classmethod
     def from_str(cls, string: str, quiet: bool = False

ssh_utilities/multi_connection/multi_connection.py

@@ -40,15 +40,18 @@ class MultiConnection(DictInterface, Pesistence, ConnectionABC):
     Parameters
     ----------
     ssh_servers : Union[List[str], str]
-        [description]
+        list od ssh srevers to connect to
     local : Union[List[bool], bool], optional
-        [description], by default False
+        bool or list of bools specifying if the respective connection(s),
+        should be local or remote by default False
     quiet : bool, optional
-        [description], by default False
+        bool or a list of bools specifing if login messages should be printed,
+        on individula connections initialization by default False
     thread_safe : Union[List[bool], bool], optional
-        [description], by default False
+        bool or a list of bools specifying if respective connection(s) should,
+        be made thead safe or not by default False
     share_connection : Union[List[int], int], optional
-        [description], by default 1
+        Not implemented, by default 1
     """
 
     _builtins: "_BUILTINS_MULTI"
@@ -61,9 +64,9 @@ class MultiConnection(DictInterface, Pesistence, ConnectionABC):
     def __init__(self, ssh_servers: Union[List[str], str],
                  local: Union[List[bool], bool] = False, quiet: bool = False,
                  thread_safe: Union[List[bool], bool] = False) -> None:
-
-        # TODO implement share connection
         # share_connection: Union[List[int], int] = 1) -> None:
+
+        # TODO finish implementation
         share_connection: Union[List[int], int] = 1
 
         # TODO somehow adjust number of workers if connection are deleted or
@@ -98,39 +101,39 @@ def __init__(self, ssh_servers: Union[List[str], str],
     def builtins(self) -> "_BUILTINS_MULTI":
         """Inner class providing access to substitutions for python builtins.
 
-        :type: .remote.Builtins
+        :type: .abc.Builtins
         """
         return self._builtins
 
     @property
     def os(self) -> "_OS_MULTI":
         """Inner class providing access to substitutions for python os module.
 
-        :type: .remote.Os
+        :type: .abc.Os
         """
         return self._os
 
     @property
     def pathlib(self) -> "_PATHLIB_MULTI":
         """Inner class providing access to substitutions for pathlib module.
 
-        :type: .remote.Pathlib
+        :type: .abc.Pathlib
         """
         return self._pathlib
 
     @property
     def shutil(self) -> "_SHUTIL_MULTI":
         """Inner class providing access to substitutions for shutil module.
 
-        :type: .remote.Shutil
+        :type: .abc.Shutil
         """
         return self._shutil
 
     @property
     def subprocess(self) -> "_SUBPROCESS_MULTI":
         """Inner class providing access to substitutions for subprocess module.
 
-        :type: .remote.Subprocess
+        :type: .abc.Subprocess
         """
         return self._subprocess