datacomshell 0.26.1__tar.gz → 0.26.6__tar.gz

{datacomshell-0.26.1 → datacomshell-0.26.6}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.3
 Name: datacomshell
-Version: 0.26.1
+Version: 0.26.6
 Summary: Add your description here
 Author: Saven
 Author-email: Saven <2416844857@qq.com>
+Requires-Dist: aiofiles>=25.1.0
 Requires-Dist: telnetlib3>=4.0.2
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown

{datacomshell-0.26.1 → datacomshell-0.26.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datacomshell"
-version = "0.26.1"
+version = "0.26.6"
 description = "Add your description here"
 authors = [
     { name = "Saven", email = "2416844857@qq.com" },
@@ -8,6 +8,7 @@ authors = [
 readme = "README.md"
 requires-python = ">=3.14"
 dependencies = [
+    "aiofiles>=25.1.0",
     "telnetlib3>=4.0.2",
 ]
 

{datacomshell-0.26.1 → datacomshell-0.26.6}/src/datacomshell/AsyncTelnetClientUtil.py

@@ -1,7 +1,12 @@
 from typing import Optional, Union, Tuple, cast
 from datacomshell.Auth import Auth, AuthState, UsernamePasswordAuth
 from telnetlib3 import TelnetReader, TelnetReaderUnicode, TelnetWriter, TelnetWriterUnicode, open_connection
+from datetime import datetime
 import asyncio
+import aiofiles
+from aiofiles.threadpool.text import AsyncTextIOWrapper
+import pathlib
+
 import re
 
 _DEFAULT_ENDING = '[saven-process-end]'
@@ -51,6 +56,8 @@ class AsyncTelnetClientUtil(object):
                  connect_timeout: float = 10.0,
                  login_timeout: float = 10.0,
                  exc_command_timeout: float = 10.0,
+                 log_folder_path: Optional[str] = None,
+                 log_new_second: float = 1800,
                  wait_input_tag_partten_list: list[re.Pattern] = _DEFAULT_WAIT_INPUT_TAG_PARTTEN_LIST,
                  ) -> None:
         self.__host: str = host
@@ -65,6 +72,17 @@ class AsyncTelnetClientUtil(object):
         self.__reader: _READER_TYPE | None = None
         self.__writer: _WRITER_TYPE | None = None
 
+        self.__log_folder_path: str | None = log_folder_path
+        self.__log_new_second: float = log_new_second
+        self.__timestemp: float = datetime.now().timestamp()
+        self.__log_file: AsyncTextIOWrapper | None = None
+
+        self.__is_log = True if log_folder_path != None else False
+
+        if self.__is_log and self.__log_folder_path != None:
+            pathlib.Path(self.__log_folder_path).mkdir(
+                parents=True, exist_ok=True)
+
     async def __initConnect(self) -> None:
         if self.__auth_type == AuthState.NONE_AUTH:
             res = await self.__none_auth()
@@ -85,6 +103,8 @@ class AsyncTelnetClientUtil(object):
                      connect_timeout: float = 10.0,
                      login_timeout: float = 10.0,
                      exc_command_timeout: float = 10.0,
+                     log_folder_path: Optional[str] = None,
+                     log_new_second: float = 1800,
                      wait_input_tag_partten_list: list[re.Pattern] = _DEFAULT_WAIT_INPUT_TAG_PARTTEN_LIST,) -> 'AsyncTelnetClientUtil':
 
         instance: AsyncTelnetClientUtil = cls(
@@ -94,10 +114,16 @@ class AsyncTelnetClientUtil(object):
             connect_timeout=connect_timeout,
             login_timeout=login_timeout,
             exc_command_timeout=exc_command_timeout,
+            log_folder_path=log_folder_path,
+            log_new_second=log_new_second,
             wait_input_tag_partten_list=wait_input_tag_partten_list,
         )
 
         await instance.__initConnect()
+
+        if instance.__is_log:
+            await instance.__create_log_file()
+
         print(f"""
               [I] connect success: {instance.__host}:{instance.__port}
               [I] login type: {instance.__auth.get_auth_type().name}
@@ -130,16 +156,26 @@ class AsyncTelnetClientUtil(object):
         _writer = cast(TelnetWriterUnicode, writer)
         _auth = cast(UsernamePasswordAuth, self.__auth)
 
+        buffer = ''
         try:
-            await self.__read_login_wait_wrapper(_reader.readuntil(b'Username:'))
+            res: bytes = b''
+            res: bytes = await self.__read_login_wait_wrapper(_reader.readuntil(b'Username:'))
+            buffer = buffer + res.decode()
             _writer.write(self.__command_wrapper(_auth.get_username()))
             await _writer.drain()
 
-            await self.__read_login_wait_wrapper(_reader.readuntil(b'Password:'))
+            res: bytes = b''
+            res: bytes = await self.__read_login_wait_wrapper(_reader.readuntil(b'Password:'))
+            buffer = buffer + res.decode()
             _writer.write(self.__command_wrapper(_auth.get_password()))
             await _writer.drain()
 
-            await self.__read_login_wait_wrapper(_reader.readuntil(b'>'))
+            res: bytes = b''
+            res: bytes = await self.__read_login_wait_wrapper(_reader.readuntil(b'>'))
+            buffer = buffer + res.decode()
+
+            # Log
+            await self.__log(buffer)
         except asyncio.TimeoutError:
             raise LoginTimoutError('Login timeout')
 
@@ -150,6 +186,40 @@ class AsyncTelnetClientUtil(object):
         await self.__login_of_username_password(reader, writer)
         return reader, writer
 
+    async def __close_log_file(self):
+        if self.__log_file != None:
+            await self.__log_file.close()
+
+    async def __create_log_file(self):
+        await self.__close_log_file()
+        filename = datetime.now().strftime('%Y-%m-%d_%H-%M-%S-%f') + '.log'
+
+        if self.__log_folder_path == None:
+            raise RuntimeError('[IE] log_folder_path error')
+
+        self.__timestemp = datetime.now().timestamp()
+        en_path = self.__log_folder_path + '/' + filename
+        self.__log_file = await aiofiles.open(en_path, 'a', encoding='utf-8')
+
+        await self.__log_file.write(f'================ {filename} ================')
+
+    async def __log(self, message: str):
+        if self.__is_log != True:
+            return
+
+        curren_timestemp: float = datetime.now().timestamp()
+        diff = curren_timestemp - self.__timestemp
+
+        # 新建
+        if diff > self.__log_new_second:
+            await self.__create_log_file()
+
+        # 记录
+        if self.__log_file == None:
+            raise RuntimeError('[IE] log_file is None')
+        else:
+            await self.__log_file.write(message)
+
     async def execute(self, command: str) -> bytes:
         if self.__reader == None and self.__writer == None:
             raise OperationObjNullError("[IE]: __reader and __writer is None")
@@ -166,6 +236,7 @@ class AsyncTelnetClientUtil(object):
         res = b'null'
         try:
             res = await self.__read_wait_wrapper(_reader.readuntil(_DEFAULT_ENDING.encode('utf-8')))
+            await self.__log(res.decode())
         except asyncio.TimeoutError as e:
             print("[I] reader buffer empty")
 
@@ -182,6 +253,9 @@ class AsyncTelnetClientUtil(object):
         _reader = cast(_READER_TYPE, self.__reader)
         _writer = cast(TelnetWriterUnicode, self.__writer)
 
+        if self.__log_file != None:
+            await self.__log_file.close()
+
         _reader.close()
         _writer.close()