file_utils.py

Overview

file_utils.py is a utility module designed to facilitate the creation of various common file formats with sample or test content. It provides a set of standalone functions, each dedicated to generating a specific file type—ranging from document formats like DOCX, Excel, PowerPoint, PDF, and Markdown, to data formats such as JSON and EML, as well as image and plain text files.

The primary purpose of this file is to enable quick and easy generation of sample files for testing, demonstration, or placeholder purposes within the InfiniFlow project or any other system that requires automated file creation.

Detailed Function Documentation

Each function follows a similar pattern:

• Accepts a single parameter path which is a string representing the file path to create.

• Creates the specified file type with some preset content (mostly in Chinese as test/demo content).

• Saves the file at the given path.

• Returns the same path string for convenience.

1. create_docx_file(path)

Creates a Microsoft Word document (.docx) with one paragraph of Chinese test text.

• Parameters:

  • path (str): The output file path for the .docx file.

• Returns: path (str)

• Usage Example:

  file_path = create_docx_file("test.docx")
  print(f"DOCX file created at: {file_path}")
  

• Implementation Notes:

  • Uses the python-docx library.

  • Adds a single paragraph with text: "这是一个测试 DOCX 文件。"

2. create_excel_file(path)

Creates an Excel workbook (.xlsx) with one worksheet and populates cell A1 with test text.

• Parameters:

  • path (str): The output file path for the .xlsx file.

• Returns: path (str)

• Usage Example:

  file_path = create_excel_file("test.xlsx")
  print(f"Excel file created at: {file_path}")
  

• Implementation Notes:

  • Uses the openpyxl library.

  • Writes "测试 Excel 文件" into cell A1.

3. create_ppt_file(path)

Creates a PowerPoint presentation (.pptx) with a single slide containing a title.

• Parameters:

  • path (str): The output file path for the .pptx file.

• Returns: path (str)

• Usage Example:

  file_path = create_ppt_file("test.pptx")
  print(f"PPT file created at: {file_path}")
  

• Implementation Notes:

  • Uses the python-pptx library.

  • Adds a title slide with the text "测试 PPT 文件".

4. create_image_file(path)

Creates a simple RGB image (.png or .jpg) with blue background and white text "Test".

• Parameters:

  • path (str): The output file path for the image file.

• Returns: path (str)

• Usage Example:

  file_path = create_image_file("test.png")
  print(f"Image file created at: {file_path}")
  

• Implementation Notes:

  • Uses the Pillow library.

  • Creates a 100x100 blue image.

  • Draws white text "Test" at position (10, 40).

5. create_pdf_file(path)

Creates a PDF file with a single line of Chinese test text.

• Parameters:

  • path (str or Path-like): The output file path for the .pdf file.

• Returns: path (str)

• Usage Example:

  file_path = create_pdf_file("test.pdf")
  print(f"PDF file created at: {file_path}")
  

• Implementation Notes:

  • Uses the reportlab library.

  • Converts the path to string if it is not already.

  • Draws the string "测试 PDF 文件" at position (100, 750).

6. create_txt_file(path)

Creates a plain text file with Chinese test content.

• Parameters:

  • path (str): The output file path for the .txt file.

• Returns: path (str)

• Usage Example:

  file_path = create_txt_file("test.txt")
  print(f"TXT file created at: {file_path}")
  

• Implementation Notes:

  • Writes "这是测试 TXT 文件的内容。" with UTF-8 encoding.

7. create_md_file(path)

Creates a Markdown (.md) file containing a heading and paragraph in Chinese.

• Parameters:

  • path (str): The output file path for the .md file.

• Returns: path (str)

• Usage Example:

  file_path = create_md_file("test.md")
  print(f"MD file created at: {file_path}")
  

• Implementation Notes:

  • Writes Markdown formatted text:

    # 测试 MD 文件
    
    这是一份 Markdown 格式的测试文件。
    

8. create_json_file(path)

Creates a JSON file with a simple dictionary containing a message and numeric value.

• Parameters:

  • path (str): The output file path for the .json file.

• Returns: path (str)

• Usage Example:

  file_path = create_json_file("test.json")
  print(f"JSON file created at: {file_path}")
  

• Implementation Notes:

  • Writes JSON data:

    {
      "message": "这是测试 JSON 文件",
      "value": 123
    }
    

  • Uses json.dump with indentation for readability.

9. create_eml_file(path)

Creates a simple EML (email) file with headers and body text.

• Parameters:

  • path (str): The output file path for the .eml file.

• Returns: path (str)

• Usage Example:

  file_path = create_eml_file("test.eml")
  print(f"EML file created at: {file_path}")
  

• Implementation Notes:

  • Writes standard email headers: From, To, Subject.

  • Body: "这是一封测试邮件的内容。"

10. create_html_file(path)

Creates a simple HTML file with a title and heading in Chinese.

• Parameters:

  • path (str): The output file path for the .html file.

• Returns: path (str)

• Usage Example:

  file_path = create_html_file("test.html")
  print(f"HTML file created at: {file_path}")
  

• Implementation Notes:

  • Writes basic HTML structure with:

    • <title>测试 HTML 文件</title>

    • <h1>这是一个测试 HTML 文件</h1>

Implementation Details and Algorithms

• The file leverages well-known third-party Python libraries specialized in handling different file formats:

  • python-docx for Word documents.

  • openpyxl for Excel files.

  • python-pptx for PowerPoint presentations.

  • Pillow for image creation.

  • reportlab for PDF generation.

• Text content is mostly in Chinese, consistent across all file types, which suggests localization or testing for multibyte character support.

• File writing is synchronous and straightforward, with no asynchronous or multithreading complexity.

• The functions do not perform path validation or error handling internally, expecting the caller to provide valid writable paths.

Interaction with Other Parts of the System

• This module acts as a standalone utility and does not import or export any internal classes or functions beyond what is necessary for file creation.

• Other components within the InfiniFlow system can invoke these functions to generate sample files for:

  • Testing file import/export features.

  • Placeholder content generation.

  • Demonstrations or UI previews.

• By returning the path, it allows seamless chaining or logging in calling code.

• Dependencies on external libraries mean the runtime environment must have these installed for proper operation.

Visual Diagram

Below is a flowchart illustrating the relationship between the main functions in file_utils.py. Each function is independent and focused on creating a specific file type with test content.

flowchart TD
    A[create_docx_file(path)] --> Z[Returns path]
    B[create_excel_file(path)] --> Z
    C[create_ppt_file(path)] --> Z
    D[create_image_file(path)] --> Z
    E[create_pdf_file(path)] --> Z
    F[create_txt_file(path)] --> Z
    G[create_md_file(path)] --> Z
    H[create_json_file(path)] --> Z
    I[create_eml_file(path)] --> Z
    J[create_html_file(path)] --> Z

Summary

The file_utils.py module provides a robust and simple interface to generate a variety of file formats populated with basic test content. It is particularly useful for automated testing scenarios and serves as a foundational utility within the InfiniFlow project ecosystem. The use of popular libraries and consistent function signatures makes it straightforward to extend or integrate into larger workflows.