python获取未占用端口

原创

mob64ca12e8d855 2023-10-07 13:31:46 ©著作权

文章标签 示例代码 Python sed 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e8d855的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python获取未占用端口

介绍

在进行网络编程或者服务器部署时，我们经常需要获取未占用的端口。在Python中，有多种方法可以实现这一功能。本文将介绍一些常用的方法，并提供相应的代码示例。

方法一：使用socket模块

首先，我们可以使用Python的socket模块来获取未占用的端口。以下是一个使用socket模块的示例代码：

import socket

def get_free_port():
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
        s.bind(('', 0))
        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        _, port = s.getsockname()
    return port

port = get_free_port()
print(f"Free port: {port}")

在上述代码中，我们创建了一个socket对象，并将其绑定到一个空的地址和端口0上。然后，我们可以使用getsockname()方法来获取实际使用的端口号。

方法二：使用psutil模块

另一种常用的方法是使用psutil模块。psutil是一个跨平台的库，用于获取系统信息和进程管理。以下是一个使用psutil模块的示例代码：

import psutil

def get_free_port():
    used_ports = set()
    for conn in psutil.net_connections():
        if conn.status == 'LISTEN':
            _, port = conn.laddr
            used_ports.add(port)

    for port in range(1024, 65535):
        if port not in used_ports:
            return port

port = get_free_port()
print(f"Free port: {port}")

在上述代码中，我们首先通过psutil.net_connections()获取所有处于监听状态的连接。然后，我们将已占用的端口添加到一个集合中。接下来，我们从1024到65535的范围内遍历所有端口，并检查是否存在未占用端口。

方法三：使用socketserver模块

除了上述方法，我们还可以使用Python的socketserver模块来获取未占用的端口。以下是一个使用socketserver模块的示例代码：

import socketserver

class FreePortHandler(socketserver.BaseRequestHandler):
    def handle(self):
        self.request.sendall(b'')
        self.request.close()

def get_free_port():
    with socketserver.TCPServer(('localhost', 0), FreePortHandler) as server:
        host, port = server.server_address
    return port

port = get_free_port()
print(f"Free port: {port}")

在上述代码中，我们创建了一个自定义的RequestHandler，并重写了handle()方法。在handle()方法中，我们向客户端发送一个空的字节串，并关闭连接。然后，我们使用TCPServer创建一个服务器，并获取其使用的端口号。

总结

本文介绍了三种常用的方法来获取未占用的端口。通过使用socket模块、psutil模块或者socketserver模块，我们可以轻松地获取一个可用的端口号。根据实际需求，选择合适的方法即可。

甘特图

使用mermaid语法的甘特图如下所示：

gantt
    dateFormat  YYYY-MM-DD
    title       Python获取未占用端口

    section 获取端口
    使用socket模块       :2022-12-01, 1d
    使用psutil模块       :2022-12-02, 1d
    使用socketserver模块  :2022-12-03, 1d

    section 编写示例代码
    编写socket示例代码       :2022-12-01, 1d
    编写psutil示例代码       :2022-12-02, 1d
    编写socketserver示例代码  :2022-12-03, 1d

    section 测试和优化
    测试代码              :2022-12-04, 2d
    优化性能              :2022-12-06, 1d

以上是一个简单的甘特图示例，展示了编写代码和测试优化的时间安排。