socket_pro 1.0.0__py3-none-any.whl

socket_pro/example/client_example.py

@@ -0,0 +1,11 @@
+from socket_pro.socket_client import SocketClient
+
+if __name__ == "__main__":
+
+    client = SocketClient("192.168.6.6", 9102)
+    if client.connect():
+        try:
+            result = client.send_data(b"TRIGGER")
+            print(result)
+        finally:
+            client.disconnect()

socket_pro/socket_client.py

@@ -0,0 +1,95 @@
+# pylint: skip-file
+import socket
+import logging
+
+
+class SocketClient:
+    """用于持续与服务器通信的 TCP Socket 客户端."""
+
+    def __init__(self, host: str, port: int, buffer_size: int = 1024, time_out: int = 3):
+        """初始化 Socket 客户端.
+
+        Args:
+            host: 要连接的服务器主机名或 IP 地址.
+            port: 服务器端口号.
+            buffer_size: 接收缓冲区大小（字节）,默认为 1024.
+            time_out: 等待回复超时时间, 默认 3 秒.
+        """
+        self.host = host
+        self.port = port
+        self.buffer_size = buffer_size
+        self.time_out = time_out
+        self.socket = None
+        self.is_connected = False
+        self.receive_thread = None
+        self.logger = logging.getLogger(self.__class__.__name__)
+
+    def connect(self) -> tuple[bool, str]:
+        """建立与服务器的连接, 连接成功后会自动启动后台线程持续接收数据.
+
+        Args:
+
+        Returns:
+            tuple[bool, str]: 连接成功返回 (True, 描述信息), 否则返回 (False, 错误信息).
+        """
+        try:
+            if self.is_connected:
+                return True, "连接成功"
+            self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            self.socket.connect((self.host, self.port))
+            self.socket.settimeout(self.time_out)
+            self.is_connected = True
+            self.logger.info("已连接到服务器 %s: %s", self.host, self.port)
+            return True, "连接成功"
+        except Exception as e:
+            self.logger.warning("连接失败, %s", str(e))
+            self.is_connected = False
+            return False, str(e)
+
+    def disconnect(self):
+        """断开与服务器的连接并释放资源."""
+        if self.is_connected:
+            self.is_connected = False
+            try:
+                if self.socket:
+                    self.socket.close()
+                if self.receive_thread and self.receive_thread.is_alive():
+                    self.receive_thread.join(timeout=1)
+            except Exception as e:
+                self.logger.warning("断开连接时出错: %s", str(e))
+            finally:
+                self.logger.info("已断开与服务器的连接")
+
+    def send_data(self, data: bytes, wait_response: bool = True) -> tuple[bool, str]:
+        """向服务器发送数据.
+
+        Args:
+            data: 要发送的字节数据.
+            wait_response: 是否需要回复, 默认需要回复.
+
+        Returns:
+            tuple[bool, str]: 发送成功返回 (True, 成功信息), 失败返回 (False, 失败信息).
+        """
+        if not self.is_connected:
+            self.logger.warning("未连接到服务器")
+            return False, "未连接服务端"
+
+        try:
+            self.socket.sendall(data)
+            if wait_response:
+                response = self.socket.recv(self.buffer_size)
+                return True, response.decode("UTF-8")
+            return True, "发送成功, 不需要等待回复"
+        except Exception as e:
+            self.logger.warning("发送数据出错: %s", str(e))
+            self.disconnect()
+            return False, str(e)
+
+    def __enter__(self):
+        """实现上下文管理协议,进入时自动连接."""
+        self.connect()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """实现上下文管理协议,退出时自动断开连接."""
+        self.disconnect()

socket_pro/socket_server_asyncio.py

@@ -0,0 +1,88 @@
+# pylint: skip-file
+"""异步socket."""
+import asyncio
+import logging
+import socket
+from asyncio import AbstractEventLoop
+
+
+class SocketServerAsyncio:
+    """异步 socket class."""
+    loop: AbstractEventLoop = None
+
+    def __init__(self, address: str = "127.0.0.1", port: int = 1830, save_log: bool = False):
+        """SocketServerAsyncio 构造方法.
+
+        Args:
+            address: 服务端 ip address.
+            port: 服务端端口.
+            save_log: 是否保存日志, 默认不保存.
+        """
+        self.clients = {}  # 保存已连接的client
+        self.tasks = {}
+        self.save_log = save_log
+        self._address = address
+        self._port = port
+        self.logger = logging.getLogger(__name__)
+
+    async def operations_return_data(self, data: bytes):
+        """操作返回数据."""
+        data = data.decode("UTF-8")
+        self.logger.warning("没有重写 operations_return_data 函数, 默认是回显.")
+        return data
+
+    async def socket_send(self, client_connection, data: bytes):
+        """发送数据给客户端."""
+        if client_connection:
+            client_ip = client_connection.getpeername()
+            await self.loop.sock_sendall(client_connection, data)
+            self.logger.info("%s 发送成功, %s", client_ip, data)
+        else:
+            self.logger.info("发送数据 % 失败", data)
+
+    async def receive_send(self, client_connection: socket.socket):
+        """接收后发送数据."""
+        client_ip = client_connection.getpeername()[0]  # 获取连接客户端的ip
+        try:
+            while data := await self.loop.sock_recv(client_connection, 1024 * 1024):
+                self.logger.info("%s", "-" * 60)
+                self.logger.info("接收到客户端 %s 的数据: %s", client_ip, data.decode("UTF-8"))
+                send_data = await self.operations_return_data(data)  # 这个方法实现具体业务, 需要重写, 不重写回显
+                send_data_byte = send_data.encode("UTF-8")
+                await self.loop.sock_sendall(client_connection, send_data_byte)
+                self.logger.info("回复客户端 %s 的数据是: %s", client_ip, send_data)
+                self.logger.info("%s", "-" * 60)
+        except Exception as e:  # pylint: disable=W0718
+            self.logger.warning("通讯出现异常, 异常信息是: %s", str(e))
+        finally:
+            self.clients.pop(client_ip)
+            self.tasks.get(client_ip).cancel()
+            self.logger.warning("客户端 %s 断开了", client_ip)
+            client_connection.close()
+
+    async def listen_for_connection(self, socket_server: socket.socket):
+        """异步监听连接.
+
+        Args:
+            socket_server: socket.socket 实例.
+        """
+        self.logger.info("服务端 %s 已启动,等待客户端连接", socket_server.getsockname())
+
+        while True:
+            self.loop = asyncio.get_running_loop()
+            client_connection, address = await self.loop.sock_accept(socket_server)
+            client_connection.setblocking(False)
+            self.clients.update({address[0]: client_connection})
+            self.tasks.update({
+                address[0]: self.loop.create_task(self.receive_send(client_connection))
+            })
+            self.logger.warning("客户端 %s 连接了", address)
+
+    async def run_socket_server(self):
+        """运行socket服务, 并监听客户端连接."""
+        socket_server = socket.socket()
+        socket_server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        socket_server.setblocking(False)
+        socket_server.bind((self._address, self._port))
+        socket_server.listen()
+        await self.listen_for_connection(socket_server)

socket_pro-1.0.0.dist-info/METADATA

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: socket_pro
+Version: 1.0.0
+Summary: socket 封装
+Author: LiuWei
+Author-email: 183074632@qq.com
+Requires-Python: >=3.8,<=3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Description-Content-Type: text/markdown
+
+# socket_pro
+异步socket
+

socket_pro-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+socket_pro/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+socket_pro/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+socket_pro/example/client_example.py,sha256=Lb6_y39TbWjkH3ZPoCRqHIFMN24knZWT72gQkOk4y_w,298
+socket_pro/socket_client.py,sha256=Cx6gJfiJrFbFIoh8haXxxxeI6oaBviGjOvKp2HRuC18,3601
+socket_pro/socket_server_asyncio.py,sha256=vRWQzMBqlVIS3VofFWWq1hN7REjP8pQmRjYveFNHhXU,3832
+socket_pro-1.0.0.dist-info/METADATA,sha256=joKNbeNNsPP8elQoXmdGwvhyQBDQw8OrRMeDbvnEni0,573
+socket_pro-1.0.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+socket_pro-1.0.0.dist-info/RECORD,,

socket_pro-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any