datacomshell 0.1.0__tar.gz → 0.1.2__tar.gz

{datacomshell-0.1.0 → datacomshell-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: datacomshell
-Version: 0.1.0
+Version: 0.1.2
 Summary: Add your description here
 Author: Saven
 Author-email: Saven <2416844857@qq.com>

{datacomshell-0.1.0 → datacomshell-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datacomshell"
-version = "0.1.0"
+version = "0.1.2"
 description = "Add your description here"
 authors = [
     { name = "Saven", email = "2416844857@qq.com" },

datacomshell-0.1.0/src/datacomshell/datacom_shell.py → datacomshell-0.1.2/src/datacomshell/AsyncTelnetUtil.py

@@ -17,11 +17,15 @@ class LoginError(RuntimeError):
     pass
 
 
-__const_command_runned_pattern = re.compile(
+_CONST_COMMAND_RUNNED_PATTERN = re.compile(
     r'<.*>|\[.*\]|<~.*>|\[~.*\]|<\*.*>|\[\*.*\]')
+_CONST_COMMAND_RUNNED_PATTERN_LIST = [_CONST_COMMAND_RUNNED_PATTERN]
 
+_CONST_COMMAND_ERROR_PATTERN = re.compile(r'%.*')
+_CONST_COMMAND_ERROR_PATTERN_LIST = [_CONST_COMMAND_ERROR_PATTERN]
 
-class DatacomShell(object):
+
+class AsyncTelnetUtil(object):
     def __init__(self,
                  host: str,
                  username: str,
@@ -29,6 +33,7 @@ class DatacomShell(object):
                  port: int = 23,
                  connect_timeout: Optional[float] = None
                  ) -> None:
+        # 连接基本信息
         self.__host = host
         self.__port = port
         self.__connect_timeout = connect_timeout
@@ -40,11 +45,41 @@ class DatacomShell(object):
         self.__reader: TelnetReader | TelnetReaderUnicode | None = None
         self.__writer: TelnetWriter | TelnetWriterUnicode | None = None
 
-        self.__const_command_runned_pattern = __const_command_runned_pattern
+        # 默认命令执行匹配
+        self.__DEFAULT_CONST_COMMAND_RUNNED_PATTERN_LIST = [
+            _CONST_COMMAND_RUNNED_PATTERN]
+
+        self.__DEFAULT_CONST_COMMAND_ERROR_PATTERN_LIST = [
+            _CONST_COMMAND_ERROR_PATTERN]
+
+    def __successfulMatch(self, pattern_list: Optional[list[re.Pattern]] = None, buffer: str = '') -> bool:
+        if pattern_list is not None:
+            for pattern in pattern_list:
+                if re.search(pattern=pattern, string=buffer) is not None:
+                    return True
+        else:
+            for pattern in self.__DEFAULT_CONST_COMMAND_RUNNED_PATTERN_LIST:
+                if re.search(pattern=pattern, string=buffer) is not None:
+                    return True
+
+        return False
+
+    def __errorMatch(self, error_pattern_list: Optional[list[re.Pattern]] = None, buffer: str = '') -> bool:
+        if error_pattern_list is not None:
+            for pattern in error_pattern_list:
+                if re.search(pattern=pattern, string=buffer) is not None:
+                    return True
+        else:
+            for pattern in self.__DEFAULT_CONST_COMMAND_ERROR_PATTERN_LIST:
+                if re.search(pattern=pattern, string=buffer) is not None:
+                    return True
 
+        return False
+
+    # 读取命令返回数据
     async def __read(self,
-                     pattern: Optional[re.Pattern] = __const_command_runned_pattern,
-                     error_pattern: Optional[re.Pattern] = None,
+                     pattern_list: Optional[list[re.Pattern]] = None,
+                     error_pattern_list: Optional[list[re.Pattern]] = None,
                      timeout: Optional[float] = 10.0,
                      size: int = 1024
                      ) -> str | None:
@@ -54,7 +89,7 @@ class DatacomShell(object):
         if self.__reader is None or self.__writer is None:
             raise ConnectError("Not connected to device")
 
-        while True:
+        while runStatus:
             try:
                 res = await asyncio.wait_for(self.__reader.read(size), timeout)
             except asyncio.TimeoutError:
@@ -68,15 +103,21 @@ class DatacomShell(object):
             elif res is str:
                 buffer += res
 
-            if pattern is not None and re.search(pattern=pattern, string=buffer, flags=0) is not None:
-                break
+            __temp_match_status = False
+            if not __temp_match_status:
+                __temp_match_status = self.__successfulMatch(
+                    pattern_list=pattern_list, buffer=buffer)
+
+            if not __temp_match_status:
+                __temp_match_status = self.__errorMatch(
+                    error_pattern_list=error_pattern_list, buffer=buffer)
 
-            if error_pattern is not None and re.search(pattern=error_pattern, string=buffer, flags=0) is not None:
+            if __temp_match_status:
                 runStatus = False
-                break
 
         return buffer if runStatus else None
 
+    # 写入命令
     def __write(self, command: str) -> None:
         if self.__writer is None:
             raise ConnectError("Not connected to device")
@@ -89,6 +130,7 @@ class DatacomShell(object):
         else:
             self.__writer.write(in_command.encode('utf-8'))
 
+    # 建立连接
     async def connect(self) -> None:
         try:
             self.__reader, self.__writer = await telnetlib3.open_connection(
@@ -102,21 +144,22 @@ class DatacomShell(object):
 
         return
 
+    # 建立登录
     async def login(self) -> None:
         if self.__login_status:
             return
 
-        if self.__read(pattern=re.compile(r"Username:")) is not None:
+        if await self.__read(pattern_list=[re.compile(r"Username:")]) is not None:
             self.__write(self.__username)
         else:
             raise LoginError("Failed to connect to device")
 
-        if self.__read(pattern=re.compile(r"Password:")) is not None:
+        if await self.__read(pattern_list=[re.compile(r"Password:")]) is not None:
             self.__write(self.__password)
         else:
             raise LoginError("Failed to connect to device")
 
-        if self.__read(pattern=self.__const_command_runned_pattern) is not None:
+        if await self.__read(pattern_list=self.__DEFAULT_CONST_COMMAND_RUNNED_PATTERN_LIST) is not None:
             self.__login_status = True
             return
 
@@ -124,6 +167,9 @@ class DatacomShell(object):
         self.__write(command)
         return await self.__read()
 
+    def only_send_command(self, command: str) -> None:
+        self.__write(command)
+
     async def build(self) -> None:
         await self.connect()
         await self.login()

datacomshell-0.1.2/src/datacomshell/TelnetShellClient.py

@@ -0,0 +1,3 @@
+
+class TelnetShellClient(object):
+    pass

datacomshell-0.1.2/src/datacomshell/TelnetShellServer.py

@@ -0,0 +1,39 @@
+import uuid
+
+__EMPTY_SYNC_PIPELINE_INDEX = -1
+
+
+class Command(object):
+    def __init__(self, command_str: str) -> None:
+        self.__command_id = None
+        self.__command_str = command_str
+        self.__command_has_result = True
+        self.__command_result = None
+
+
+class TelnetShellServer(object):
+    """
+    Telnet shell server.
+    """
+
+    def __init__(self) -> None:
+
+        self.__sync_command_pipeline = []
+        self.__async_command_pipeline = []
+        self.__command_runned_result_dict = {}
+
+        self.__sync_current_command_index = __EMPTY_SYNC_PIPELINE_INDEX
+
+        self.__connect_pool = []
+
+    def __check_reset_result_dict_count(self) -> bool:
+        if self.__command_runned_result_dict.__len__() > 1000:
+            self.__command_runned_result_dict.clear()
+            return True
+        return False
+
+    def gen_command_process_id(self) -> uuid.UUID:
+        return uuid.uuid4()
+
+    def sync_push(self, command: Command) -> None:
+        self.__sync_command_pipeline.insert(0, command)