datacomshell 0.1.0__tar.gz

datacomshell-0.1.0/PKG-INFO

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

datacomshell-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "datacomshell"
+version = "0.1.0"
+description = "Add your description here"
+authors = [
+    { name = "Saven", email = "2416844857@qq.com" },
+]
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "telnetlib3>=4.0.2",
+]
+
+[project.scripts]
+datacomshell = "datacomshell:main"
+
+[build-system]
+requires = ["uv_build>=0.11.14,<0.12.0"]
+build-backend = "uv_build"

datacomshell-0.1.0/src/datacomshell/__init__.py

@@ -0,0 +1 @@
+

datacomshell-0.1.0/src/datacomshell/datacom_shell.py

@@ -0,0 +1,129 @@
+import asyncio
+import re
+from typing import Optional
+import telnetlib3
+from telnetlib3 import TelnetWriter, TelnetReader, TelnetWriterUnicode, TelnetReaderUnicode
+
+
+class ConnectError(RuntimeError):
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+    pass
+
+
+class LoginError(RuntimeError):
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+    pass
+
+
+__const_command_runned_pattern = re.compile(
+    r'<.*>|\[.*\]|<~.*>|\[~.*\]|<\*.*>|\[\*.*\]')
+
+
+class DatacomShell(object):
+    def __init__(self,
+                 host: str,
+                 username: str,
+                 password: str,
+                 port: int = 23,
+                 connect_timeout: Optional[float] = None
+                 ) -> None:
+        self.__host = host
+        self.__port = port
+        self.__connect_timeout = connect_timeout
+
+        self.__username = username
+        self.__password = password
+
+        self.__login_status = False
+        self.__reader: TelnetReader | TelnetReaderUnicode | None = None
+        self.__writer: TelnetWriter | TelnetWriterUnicode | None = None
+
+        self.__const_command_runned_pattern = __const_command_runned_pattern
+
+    async def __read(self,
+                     pattern: Optional[re.Pattern] = __const_command_runned_pattern,
+                     error_pattern: Optional[re.Pattern] = None,
+                     timeout: Optional[float] = 10.0,
+                     size: int = 1024
+                     ) -> str | None:
+        buffer = ''
+        runStatus = True
+
+        if self.__reader is None or self.__writer is None:
+            raise ConnectError("Not connected to device")
+
+        while True:
+            try:
+                res = await asyncio.wait_for(self.__reader.read(size), timeout)
+            except asyncio.TimeoutError:
+                break
+
+            if not res:
+                break
+
+            if res is bytes:
+                buffer += res.decode('utf-8')
+            elif res is str:
+                buffer += res
+
+            if pattern is not None and re.search(pattern=pattern, string=buffer, flags=0) is not None:
+                break
+
+            if error_pattern is not None and re.search(pattern=error_pattern, string=buffer, flags=0) is not None:
+                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")
+
+        in_command = command + "\r\n"
+
+        # 根据 writer 类型决定使用字符串还是字节
+        if isinstance(self.__writer, TelnetWriterUnicode):
+            self.__writer.write(in_command)
+        else:
+            self.__writer.write(in_command.encode('utf-8'))
+
+    async def connect(self) -> None:
+        try:
+            self.__reader, self.__writer = await telnetlib3.open_connection(
+                host=self.__host, port=self.__port, connect_timeout=self.__connect_timeout)
+        except asyncio.TimeoutError:
+            raise TimeoutError(
+                f"Connection to {self.__host}:{self.__port} timed out after {self.__connect_timeout} seconds")
+
+        if self.__reader is None or self.__writer is None:
+            raise ConnectionError("Failed to connect to device")
+
+        return
+
+    async def login(self) -> None:
+        if self.__login_status:
+            return
+
+        if self.__read(pattern=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:
+            self.__write(self.__password)
+        else:
+            raise LoginError("Failed to connect to device")
+
+        if self.__read(pattern=self.__const_command_runned_pattern) is not None:
+            self.__login_status = True
+            return
+
+    async def send_command(self, command: str):
+        self.__write(command)
+        return await self.__read()
+
+    async def build(self) -> None:
+        await self.connect()
+        await self.login()