feat: add gui and fix bugs

Recogerous · Recogerous · commit 74b86d2cc6d5 · 2024-05-02T22:32:30.000+08:00
diff --git a/README.md b/README.md
@@ -0,0 +1,123 @@
+# Modtime Pecker - 文件夹最新修改时间检查工具
+
+## Description
+
+Modtime Pecker is a Python script designed to check the latest modification time of all folders and files in a specified folder. It recursively searches all subfolders to find the latest modification time of direct subfolders.
+
+Modtime Pecker 是一个Python脚本，旨在帮助用户高效地查看指定文件夹下所有直接子文件夹和文件的最后修改时间。
+
+In general, when using a file explorer to view the modification time of all files and folders in a folder, there is a problem that the modification time of the folder will not be updated with the modification of the files in the folder. This leads to the inability to intuitively view the latest modification time of the folder. This tool aims to solve this problem.
+
+在通常情况下，使用文件资源管理器查看某一文件夹下的所有文件和文件夹的修改时间时，会出现一个问题，即文件夹修改时间不会随着文件夹内文件的修改而更新。这就导致了无法直观地查看文件夹的最新修改时间。本工具旨在解决这一问题。
+
+## Features
+
+- Recursively search all subfolders to find the latest modification time of direct subfolders.
+  递归搜索所有子文件夹，找到直接子文件夹的最新修改时间。
+- Support multiple target folders.
+  支持一次性查看多个目标文件夹。
+- Support custom output format including JSON and TXT.
+  支持自定义输出格式，包括JSON和TXT。
+- 支持将结果复制到剪切板中。 
+  Support copying the result to the clipboard.
+
+## Environment
+
+- Only support Windows currently. 目前仅支持Windows。
+- Python 3.6 or higher
+- pyperclip~=1.8.2
+- tqdm~=4.66.2
+
+## Usage
+
+```bash
+python modtime_pecker.py [-h] [-p PATH [PATH ...]] [-i IMPORT_TXT [IMPORT_TXT ...]] [-c] [-g] [-sc] [-st] [-sj]
+```
+### Arguments
+
+- `-p, --path`: Path(s) of the folder(s) to be checked. 
+  指定要检查的文件夹路径，可指定多个。
+- `-i, --import_txt`: Read path from the specified txt file(s).
+  从TXT文件导入路径列表。
+- `-c, --current`: Check the modification time of the current folder.
+  检查脚本所在当前文件夹。
+- `-g, --gui`: Use GUI interface (not available in modtime_pecker_nogui.py).
+  启动图形用户界面（modtime_pecker_nogui.py中无此功能）。
+- `-sc, --save_clipboard`: Save (copy) the result to the clipboard.
+  将结果复制到剪贴板。
+- `-st, --save_txt`: Save the result as a txt file.
+  将结果保存为TXT文件。
+- `-sj, --save_json`: Save the result as a json file.
+  将结果保存为JSON文件。
+
+In `modtime_pecker_nogui.py`: 
+
+Default behavior: If no arguments are specified, the script will check the current folder and save the result as a TXT file.
+默认行为：如果未指定任何参数，脚本将检查当前文件夹并保存结果为TXT文件。
+
+In `modtime_pecker.py`: 
+
+Default behavior: If no arguments are specified, the script will start the GUI.
+默认行为：如果未指定任何参数，脚本将启动图形用户界面。
+
+### Examples
+
+1. Check the modification time of the current folder and save the result as a text file:
+
+```bash
+python modtime_pecker.py -c -st
+```
+
+2. Check the modification time of specified folders and save the result as a json file:
+
+```bash
+python modtime_pecker.py -p /path/to/folder1 /path/to/folder2 -sj
+```
+
+3. Check the modification time of folders listed in a text file and copy the result to clipboard:
+
+```bash
+python modtime_pecker.py -i folders.txt -sc
+```
+
+### Output
+
+The script will output the latest modification time of each folder and file in the specified folder(s) in the following format:
+
+```
+In /path/to/folder1:
+2023-12-31 18:30:00 - file1.txt
+2023-12-30 12:00:00 - subdir1
+
+In /path/to/folder2:
+2024-01-01 08:00:00 - file2.txt
+2023-12-28 09:45:00 - subdir2
+
+```
+
+JSON output example:
+
+```json
+{
+    "/path/to/folder1": [
+        {
+            "2023-12-31 18:30:00": "file1.txt"
+        },
+        {
+            "2023-12-30 12:00:00": "subdir1"
+        }
+    ],
+    "/path/to/folder2": [
+        {
+            "2024-01-01 08:00:00": "file2.txt"
+        },
+        {
+            "2023-12-28 09:45:00": "subdir2"
+        }
+    ]
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
diff --git a/modtime_pecker.py b/modtime_pecker.py
@@ -9,7 +9,7 @@
 import sys
 import tkinter as tk
 from datetime import datetime
-from tkinter import messagebox
+from tkinter import ttk, filedialog, messagebox
 
 import pyperclip
 from tqdm import tqdm
@@ -26,7 +26,7 @@ def get_latest_modification_time(path):
     # print(rst_path, end="")
     rst = rst_path
 
-    time_path_dict = {}
+    time_path_list = []
     # 遍历目标文件夹下的所有直接的文件和文件夹
     for entry in os.scandir(path):
         modtime = get_timestamp(entry)
@@ -42,18 +42,19 @@ def get_latest_modification_time(path):
                 # 比较子文件夹中最新的一个条目的修改时间和子文件夹的修改时间
                 if top_latest_modtime_in_subdir > modtime:
                     modtime = top_latest_modtime_in_subdir
-        time_path_dict[modtime] = entry_name
+        time_path_list.append((modtime, entry_name))
 
     # 递归结束后，获取到目标文件夹下直接的文件和文件夹的修改时间
-    if time_path_dict:
-        # 将字典按修改时间排序，得到最终所需结果
-        time_path_dict = dict(sorted(time_path_dict.items(), reverse=True))
-        for modtime, entry_name in time_path_dict.items():
+    if time_path_list:
+        # 将列表按修改时间（列表每一项元组中的第一个元素）排序，得到最终所需结果
+        time_path_list.sort(key=lambda x: x[0], reverse=True)
+        # print(time_path_list)
+        for modtime, entry_name in time_path_list:
             rst_entry = f"{modtime} - {entry_name}{os.linesep}"
             # print(rst_entry, end="")
             rst += rst_entry
         # 获取子文件夹中最新修改的一个条目的修改时间，用于返回给上一级文件夹
-        top_latest_modtime = list(time_path_dict.keys())[0]
+        top_latest_modtime = time_path_list[0][0]
         # print(f"{top_latest_modtime}")
     else:
         # 空文件夹，返回空字符串
@@ -79,7 +80,10 @@ def multi_check(path_list):
     for target_path in pbar:
         if not isinstance(pbar, list):
             desc = f"Checking the latest modification time in {target_path}"
-            pbar.set_description(desc)
+            try:
+                pbar.set_description(desc)
+            except AttributeError:
+                pass
         rsts += get_latest_modification_time(target_path)[0]
         rsts += os.linesep
     return rsts
@@ -115,11 +119,11 @@ def save2json(rst):
     json_dict = {}
     for paragraph in paragraphs:
         lines = paragraph.split(os.linesep)
-        target_path = lines[0][3:-1]
-        json_dict[target_path] = {}
+        target_path = lines[0][3:-2]
+        json_dict[target_path] = []
         for line in lines[1:]:
             mtime, entry_name = line.split(' - ')
-            json_dict[target_path][mtime] = entry_name
+            json_dict[target_path].append({mtime: entry_name})
     # 保存为json文件
     with open(filename, 'w', encoding='utf-8') as f:
         json.dump(json_dict, f, ensure_ascii=False, indent=4)
@@ -129,10 +133,156 @@ def save2json(rst):
     return msg
 
 def gui():
+    def browse_folder():
+        folder_path = filedialog.askdirectory()
+        if folder_path:
+            path_entry.delete(0, tk.END)
+            path_entry.insert(0, folder_path)
+
+    def check_modification_time():
+        target_path = path_entry.get()
+        if not target_path:
+            messagebox.showerror("Error", "Please select a folder.")
+            return
+
+        try:
+            rst = get_latest_modification_time(target_path)[0]
+            result_text.delete("1.0", tk.END)
+            result_text.insert(tk.END, rst)
+            status_label.config(text="Status: Check completed.")
+        except Exception as e:
+            messagebox.showerror("Error", str(e))
+            status_label.config(text="Status: Error occurred.")
+
+    def check_script_folder_time():
+        script_path = os.path.dirname(os.path.realpath(sys.executable))
+        try:
+            rst = get_latest_modification_time(script_path)[0]
+            result_text.delete("1.0", tk.END)
+            result_text.insert(tk.END, rst)
+            status_label.config(text="Status: Check completed.")
+        except Exception as e:
+            messagebox.showerror("Error", str(e))
+            status_label.config(text="Status: Error occurred.")
+
+    def copy_to_clipboard():
+        result = result_text.get("1.0", tk.END)
+        if result.strip():
+            pyperclip.copy(result)
+            messagebox.showinfo("Info", "Result copied to clipboard.")
+        else:
+            messagebox.showwarning("Warning", "Nothing to copy.")
+
+    def save_as_txt():
+        result = result_text.get("1.0", tk.END)
+        if result.strip():
+            filename = filedialog.asksaveasfilename(
+                defaultextension=".txt",
+                filetypes=[("Text files", "*.txt")]
+            )
+            if filename:
+                with open(filename, 'w', encoding='utf-8') as f:
+                    f.write(result)
+                messagebox.showinfo("Info", f"Result saved as {filename}.")
+        else:
+            messagebox.showwarning("Warning", "Nothing to save.")
+
+    def save_as_json():
+        result = result_text.get("1.0", tk.END)
+        if result.strip():
+            filename = filedialog.asksaveasfilename(
+                defaultextension=".json",
+                filetypes=[("JSON files", "*.json")]
+            )
+            if filename:
+                paragraphs = result.split('\n\n')
+                # 去除空段落
+                for paragraph in paragraphs:
+                    if not paragraph:
+                        paragraphs.remove(paragraph)
+                json_dict = {}
+                for paragraph in paragraphs:
+                    lines = paragraph.split('\n')
+                    target_path = lines[0][3:-3]
+                    json_dict[target_path] = []
+                    for line in lines[1:]:
+                        try:
+                            mtime, entry_name = line.strip().split(' - ')
+                        except ValueError:
+                            # 提醒用户尽量避免修改结果文本之后再保存
+                            error_msg = (f"Invalid text: \n'{line}'\n"
+                                         f"Please avoid modifying the "
+                                         f"result text before saving.")
+                            messagebox.showerror("Error", error_msg)
+                            return
+                        json_dict[target_path].append({mtime: entry_name})
+                with open(filename, 'w', encoding='utf-8') as f:
+                    json.dump(json_dict, f, ensure_ascii=False, indent=4)
+                messagebox.showinfo("Info", f"Result saved as {filename}.")
+        else:
+            messagebox.showwarning("Warning", "Nothing to save.")
+
     root = tk.Tk()
-    root.title("Modtime Pecker - Latest Modification Time Checke")
+    root.title("Modtime Pecker - Latest Modification Time Checker")
     root.geometry('800x600')
 
+    # 文件夹路径
+    folder_frame = ttk.Frame(root)
+    folder_frame.pack(pady=10)
+
+    ttk.Label(folder_frame, text="Folder Path:").grid(
+        row=0, column=0, padx=5, pady=5)
+    path_entry = ttk.Entry(folder_frame, width=50)
+    path_entry.grid(row=0, column=1, padx=5, pady=5)
+
+    browse_button = ttk.Button(folder_frame,
+                               text="Browse",
+                               command=browse_folder)
+    browse_button.grid(row=0, column=2, padx=5, pady=5)
+
+    # 功能按钮
+    action_frame = ttk.Frame(root)
+    action_frame.pack(pady=10)
+
+    check_button = ttk.Button(action_frame,
+                              text="Check Modification Time",
+                              command=check_modification_time)
+    check_button.grid(row=0, column=0, padx=5, pady=5)
+
+    check_script_button = ttk.Button(action_frame,
+                                     text="Check Script Folder Time",
+                                     command=check_script_folder_time)
+    check_script_button.grid(row=0, column=1, padx=5, pady=5)
+
+    copy_button = ttk.Button(action_frame,
+                             text="Copy Result",
+                             command=copy_to_clipboard)
+    copy_button.grid(row=0, column=2, padx=5, pady=5)
+
+    save_txt_button = ttk.Button(action_frame,
+                                 text="Save as TXT",
+                                 command=save_as_txt)
+    save_txt_button.grid(row=0, column=3, padx=5, pady=5)
+
+    save_json_button = ttk.Button(action_frame,
+                                  text="Save as JSON",
+                                  command=save_as_json)
+    save_json_button.grid(row=0, column=4, padx=5, pady=5)
+
+    # 结果显示框
+    result_frame = ttk.Frame(root)
+    result_frame.pack(fill=tk.BOTH, expand=True, padx=10, pady=10)
+
+    ttk.Label(result_frame, text="Result:").pack(anchor=tk.W, padx=5, pady=5)
+    result_text = tk.Text(result_frame, wrap=tk.WORD, width=80, height=20)
+    result_text.pack(fill=tk.BOTH, expand=True, padx=5, pady=5)
+
+    # 状态栏
+    status_label = ttk.Label(root, text="Status: Ready")
+    status_label.pack(side=tk.BOTTOM, padx=10, pady=5)
+
+    root.mainloop()
+
 def argparser():
     parser = argparse.ArgumentParser(
         description='Check the latest modification time of all '
@@ -207,5 +357,6 @@ def cli():
 
 if __name__ == '__main__':
     if len(sys.argv) == 1:
-        sys.argv.extend(['-c', '-st'])
-    cli()
+        gui()
+    else:
+        cli()
diff --git a/modtime_pecker_nogui.py b/modtime_pecker_nogui.py
