基于Python实现一个WindowsTree命令工具

目录

• 引言
• 实现代码
• 使用说明
• 可用选项
• 示例用法
• 功能特点
• 添加到环境变量
• 方法一：创建批处理文件并添加到PATH
• 1. 创建批处理文件
• 2. 将批处理文件放入系统目录
• 3. 或者添加到PATH环境变量
• 方法二：直接创建可执行文件（推荐）
• 1. 使用PyInstaller打包成exe
• 2. 将exe文件放入PATH目录
• 方法三：创建Python包并安装（高级）
• 1. 添加shebang和设置可执行权限
• 2. 或者创建setup.py安装为Python包
• 验证安装
• 注意事项
• Tree for Windows

今天想要在Windows平台的CMD命令终端窗口中使用像Linux下的tree命令，打印一下目录结构层级树。然而还真有tree命令，但是发现似乎并不好用，支持的参数很少，比如基本的-l 指定打印层级的参数也不支持。

tree 命令格式和参数：

tree[drive:][path] [/F] [/A]

• /F 显示每个文件夹中文件的名称。（带扩展名）
• /A 使用 ASCII 字符，而不使用扩展字符。(如果要显示中文，例如 tree /f /A >tree.txt)

于是就想着使用Python简单实现一个。

import os
import argparse
from collections import deque

def tree(directory, max_level=None, show_files=True, skip_names=None, current_level=0, prefix=''):
    """
    递归生成目录树结构
    
    :param directory: 要显示的目录路径
    :param max_level: 最大显示层级，None表示不限制
    :param show_files: 是否显示文件
    :param skip_names: 要跳过的目录或文件名列表
    :param current_level: 当前层级(内部递归使用)
    :param prefix: 前缀字符串(内部递归使用)
    :return: None
    """
    if max_level is not None and current_level > max_level:
        return
    
    # 获取目录下的所有条目并排序
    try:
        entries = os.listdir(directory)
    except PermissionError:
        print(prefix + "└── [Permission Denied]")
        return
    
    entries = sorted(entries, key=lambda x: x.lower())
    
    # 过滤出目录和文件，并跳过指定名称
    dirs = []
    files = []
    
    for entry in entries:
        if skip_names and entry in skip_names:
            continue
        entry_path = os.path.join(directory, entry)
        if os.path.isdir(entry_path):
            dirs.append(entry)
        elif show_files:
            files.append(entry)
    
    all_entries = dirs + files
    entries_count = len(all_entries)
    
    for i, entry in enumerate(all_entries):
        is_last = i == entries_count - 1
        entry_path = os.path.join(directory, entry)
        
        # 当前条目的前缀
        if is_last:
            connector = "└── "
            new_prefix = prefix + "    "
        else:
            connector = "├── "
            new_prefix = prefix + "│   "
        
        print(prefix + connector + entry)
        
        # 如果是目录，递归显示
        if os.path.isdir(entry_path):
            tree(entry_path, max_level, show_files, skip_names, current_level + 1, new_prefix)

def main():
    # 设置命令行参数解析
    parser = argparse.ArgumentParser(description='显示目录树结构，类似Linux的tree命令')
    parser.add_argument('directory', nargs='?', default='.', help='要显示的目录(默认为当前目录)')
    parser.add_argument('-l', '--level', type=int, help='限制显示的目录层级深度')
    parser.add_argument('-f', '--files', action='store_true', help='同时显示文件')
    parser.add_argument('-s', '--skip', action='append', help='要跳过的目录或文件名(可多次使用)')
    
    args = parser.parse_args()
    
    # 检查目录是否存在
    if not os.path.isdir(args.directory):
        print(f"错误: 目录 '{args.directory}' 不存在")
        return
    
    # 显示目录树
    print(args.directory)
    tree(args.directory, args.level, args.files, args.skip)

if __name__ == '__main__':
    main()

• 将上述代码保存为 tree.py
• 通过命令行运行：

python tree.py [目录路径] [选项]

:warning: 需要注意的是，前提是你的电脑环境需要安装Python解释器。

• -l LEVEL 或 --level LEVEL: 限制显示的目录层级深度
• -f 或 --files: 同时显示文件(默认只显示目录)
• -s 或 --skip 参数，可以指定要跳过的目录或文件名
  • 该参数可以多次使用，跳过多个名称
  • 跳过规则同时适用于目录和文件(如果 -f 参数启用)

显示当前目录树结构(只显示目录):

python tree.py

显示指定目录的树结构(显示文件和目录):

python tree.py C:Users -f

显示当前目录的2层深度:

python tree.py -l 2

显示指定目录的3层深度并包含文件:

python tree.py C:Projects -l 3 -f

跳过 node_modules 目录:

python tree.py -s node_modules

跳过多个目录/文件:

python tree.py -s node_modules -s .git -s .DS_Store

组合使用多个参数:

python tree.py C:Projects -l 3 -f -s bin -s obj -s test

• 支持类似Linux的tree命令输出格式
• 支持限制显示层级深度(-l参数)
• 可选择是否显示文件(-f参数)
• 正确处理权限问题(遇到无权限访问的目录会标注)
• 输出结果按字母顺序排序
• 美观的树形结构显示

这个工具在Windows平台上提供了类似Linux tree命令的功能，可以根据需要显示目录结构，并且通过-l参数可以限制显示的层级深度等。

通过以上代码我们就可以实现了一个基本的tree命令工具，但是在Windows平台上的cmd控制台中使用时，每次都需要python tree.py这样使用也太麻烦了吧，可不可以像在Linux那样直接就可以使用tree命令呢？当然！

要将Python tree脚本添加到环境变量中，使其可以在任何目录下直接通过tree命令调用，需要完成以下几个步骤：

• 创建一个新的文本文件，命名为tree.bat
• 编辑内容如下（根据你的Python安装路径调整）：

@echo off
python "C:pathtoyourtree.py" %*

或者如果你想要确保使用特定的Python解释器：

@echo off
"C:Python39python.exe" "C:pathtoyourtree.py" %*

%*表示传递所有参数给Python脚本

将tree.bat文件放入以下任一目录：

• C:WindowsSystem32 (需要管理员权限)
• C:Windows (需要管理员权限)
• 或者任何已在PATH环境变量中的目录

如果你不想放入系统目录，可以：

• 创建一个专用目录存放你的自定义脚本（如C:MyScripts）
• 将此目录添加到PATH环境变量中：
  • 右键"此电脑" → 属性 → 高级系统设置 → 环境变量
  • 在"系统变量"部分找到"Path"，点击编辑
  • 点击"新建"，添加你的目录路径（如C:MyScripts）
  • 点击确定保存所有对话框

安装PyInstaller：

pip install pyinstaller

打包你的脚本：

pyinstaller --onefile --name mtree.exe tree.py

打包完成后，在dist目录下会生成mtree.exe文件

将生成的mtree.exe文件放入：

• C:WindowsSystem32
• 或任何已在PATH环境变量中的目录

• 在tree.py文件开头添加shebang行：

#!/usr/bin/env python

• 将文件重命名为tree（无扩展名）
• 将文件放入PATH目录中

创建setup.py文件：

from setuptools import setup

setup(
    name='tree-cmd',
    version='1.0',
    scripts=['tree.py'],
)

安装：

pip install --editable .

:tipping_hand_man: 需要说明的是，我仅尝试使用了方法二直接创建可执行文件的方式，并且测试可行,其它方式有兴趣的你可以试试。

• 打开新的命令提示符窗口（重要，使环境变量生效）
• 在任何目录下输入：

tree

• 或测试带参数的命令：

tree -l 2 -f -s node_modules

• 如果使用Python方法，确保Python已添加到PATH环境变量
• 修改环境变量后需要重启命令提示符才能生效
• 如果遇到权限问题，可能需要以管理员身份运行命令提示符
• 方法二（打包成exe）是最独立的方式，不依赖Python环境

这样设置后，你就可以像使用系统命令一样在任何位置使用你的tree脚本了。

补充一下，先是在网络找了一下可能有的成熟工具或者解决方案，这里看的了这个工具，但是我没用。因为上面的脚本满足了我的需求并且可以自行扩展。

安装Tree for Windows工具：

• 打开进入 Tree for Windows 页面，选择下载 Binaries zip 文件。
• 解压压缩包，找到压缩包内的 bin 目录，将 bin 目录下的 tree.exe 复制
• 找到 C:\Program FilesGitusrbin 目录，将 tree.exe 粘贴到该目录下，安装即完成

tree命令行参数：

• -a 显示所有文件和目录。
• -A 使用ASNI绘图字符显示树状图而非以ASCII字符组合。
• -C 在文件和目录清单加上色彩，便于区分各种类型。
• -d 显示目录名称而非内容。
• -D 列出文件或目录的更改时间。
• -f 在每个文件或目录之前，显示完整的相对路径名称。
• -F 在执行文件，目录，Socket，符号连接，管道名称名称，各自加上"*","/","=","@","|“号。
• -g 列出文件或目录的所属群组名称，没有对应的名称时，则显示群组识别码。
• -i 不以阶梯状列出文件或目录名称。
• -I 不显示符合范本样式的文件或目录名称。
• -l 如遇到性质为符号连接的目录，直接列出该连接所指向的原始目录。
• -n 不在文件和目录清单加上色彩。
• -N 直接列出文件和目录名称，包括控制字符。
• -p 列出权限标示。
• -P 只显示符合范本样式的文件或目录名称。
• -q 用”?"号取代控制字符，列出文件和目录名称。
• -s 列出文件或目录大小。
• -t 用文件和目录的更改时间排序。
• -u 列出文件或目录的拥有者名称，没有对应的名称时，则显示用户识别码。
• -x 将范围局限在现行的文件系统中，若指定目录下的某些子目录，其存放于另一个文件系统上，则将该子目录予以排除在寻找范围外。

以上就是基于Python实现一个Windows Tree命令工具的详细内容，更多关于Python Windows Tree命令工具的资料请关注风君子博客其它相关文章！

您可能感兴趣的文章:

• 基于Python编写一个Windows串口通信工具
• windows端python版本管理工具pyenv-win安装使用
• Python制作Windows凭据添加工具
• 如何在windows下安装配置python工具Ulipad
• python版本的仿windows计划任务工具