mermaid-trace 0.4.1__tar.gz → 0.5.3.post0__tar.gz

{mermaid_trace-0.4.1 → mermaid_trace-0.5.3.post0}/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v4

{mermaid_trace-0.4.1 → mermaid_trace-0.5.3.post0}/.github/workflows/release.yml

@@ -9,6 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        fetch-tags: true
     - name: Set up Python
       uses: actions/setup-python@v5
       with:

{mermaid_trace-0.4.1 → mermaid_trace-0.5.3.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mermaid-trace
-Version: 0.4.1
+Version: 0.5.3.post0
 Summary: Visualize your Python code execution flow as Mermaid Sequence Diagrams.
 Project-URL: Documentation, https://github.com/xt765/mermaid-trace#readme
 Project-URL: Changelog, https://github.com/xt765/mermaid-trace/blob/main/docs/en/CHANGELOG.md
@@ -39,7 +39,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Software Development :: Debuggers
@@ -83,18 +82,35 @@ MermaidTrace is a specialized logging tool that automatically generates [Mermaid
 
 ## 📚 Documentation
 
+### Core Documentation
+
 [User Guide](docs/en/USER_GUIDE.md) · [API Reference](docs/en/API.md) · [Contributing Guidelines](docs/en/CONTRIBUTING.md) · [Changelog](docs/en/CHANGELOG.md) · [License](docs/en/LICENSE)
 
+### Code Comment Documents (Chinese)
+
+| Category | Links |
+| :--- | :--- |
+| **Core Modules** | [Context](docs/zh/code_comments/src/mermaid_trace/core/context.md) · [Decorators](docs/zh/code_comments/src/mermaid_trace/core/decorators.md) · [Events](docs/zh/code_comments/src/mermaid_trace/core/events.md) · [Formatter](docs/zh/code_comments/src/mermaid_trace/core/formatter.md) |
+| **Handlers** | [Async Handler](docs/zh/code_comments/src/mermaid_trace/handlers/async_handler.md) · [Mermaid Handler](docs/zh/code_comments/src/mermaid_trace/handlers/mermaid_handler.md) |
+| **Integrations** | [FastAPI](docs/zh/code_comments/src/mermaid_trace/integrations/fastapi.md) |
+| **Others** | [init](docs/zh/code_comments/src/mermaid_trace/__init__.md) · [CLI](docs/zh/code_comments/src/mermaid_trace/cli.md) |
+
 ---
 
 ## ✨ Key Features
 
 - **Decorator-Driven**: Just add `@trace` or `@trace_interaction` to your functions.
+- **Auto-Instrumentation**: Use `@trace_class` to trace a whole class at once.
+- **Third-Party Patching**: Use `patch_object` to trace calls inside external libraries.
 - **Auto-Diagramming**: Generates `.mmd` files that can be viewed in VS Code, GitHub, or Mermaid Live Editor.
 - **Async Support**: Works seamlessly with `asyncio` coroutines.
 - **Context Inference**: Automatically tracks nested calls and infers `source` participants using `contextvars`.
-- **FastAPI Integration**: Includes middleware for zero-config HTTP request tracing.
-- **CLI Tool**: Built-in viewer to preview diagrams in your browser.
+- **Intelligent Collapsing**: Prevents diagram explosion by collapsing repetitive high-frequency calls and identifying recurring patterns (e.g., loops).
+- **Detailed Exceptions**: Captures full stack traces for errors, displayed in interactive notes.
+- **Simplified Objects**: Automatically cleans up memory addresses (e.g., `<__main__.Obj at 0x...>` -> `<Obj>`) and **groups consecutive identical items** in lists/tuples (e.g., `[<Obj> x 5]`) for cleaner diagrams.
+- **Log Rotation**: Supports `RotatingMermaidFileHandler` for handling long-running systems by splitting logs based on size or time.
+- **FastAPI Integration**: Includes middleware for zero-config HTTP request tracing, supporting distributed tracing via `X-Trace-ID` and `X-Source` headers.
+- **CLI Tool**: Built-in viewer with live-reload to preview diagrams in your browser.
 
 ---
 
@@ -113,7 +129,8 @@ from mermaid_trace import trace, configure_flow
 import time
 
 # 1. Configure output
-configure_flow("my_flow.mmd")
+# Recommendation: Store diagrams in a dedicated directory (e.g., mermaid_diagrams/)
+configure_flow("mermaid_diagrams/my_flow.mmd", async_mode=True)
 
 # 2. Add decorators
 @trace(source="Client", target="PaymentService", action="Process Payment")
@@ -130,6 +147,29 @@ def check_balance(amount):
 process_payment(100)
 ```
 
+### Configuration
+
+You can configure global settings via `configure_flow` or environment variables to control performance and behavior.
+
+```python
+configure_flow(
+    "flow.mmd", 
+    overwrite=True,    # Overwrite the file on each restart (default: True)
+    level=logging.DEBUG, 
+    queue_size=5000,  # Increase buffer for high-throughput
+    config_overrides={
+        "capture_args": False,       # Disable arg capturing for max performance
+        "max_string_length": 100     # Increase string truncation limit
+    }
+)
+```
+
+**Environment Variables:**
+- `MERMAID_TRACE_CAPTURE_ARGS` (true/false)
+- `MERMAID_TRACE_MAX_STRING_LENGTH` (int)
+- `MERMAID_TRACE_MAX_ARG_DEPTH` (int)
+- `MERMAID_TRACE_QUEUE_SIZE` (int)
+
 ### Nested Calls (Context Inference)
 
 You don't need to specify `source` every time. MermaidTrace infers it from the current context.
@@ -167,6 +207,18 @@ Visualize your generated `.mmd` files instantly:
 mermaid-trace serve my_flow.mmd
 ```
 
+### Examples
+
+Check out the [examples/](examples/) directory for a complete set of demos covering all features:
+- **[Basic Usage](examples/01_basic_usage.py)**: Decorators and class methods.
+- **[Advanced Instrumentation](examples/02_advanced_instrumentation.py)**: `@trace_class` and `patch_object` for third-party libraries.
+- **[Async & Concurrency](examples/03_async_concurrency.py)**: Tracing `asyncio` and concurrent tasks.
+- **[Error Handling](examples/04_error_handling.py)**: Stack trace capture and error rendering.
+- **[Intelligent Collapsing](examples/05_intelligent_collapsing.py)**: Keeping diagrams clean in loops.
+- **[FastAPI Integration](examples/06_fastapi_integration.py)**: Middleware for web apps.
+- **[Full Stack App](examples/07_full_stack_app.py)**: Comprehensive example with FastAPI, SQLAlchemy, and Pydantic.
+- **[Log Rotation](examples/08-log-rotation.py)**: Handling long-running processes with file rotation.
+
 ---
 
 ## 🤝 Contributing

mermaid_trace-0.5.3.post0/README.md

@@ -0,0 +1,170 @@
+# MermaidTrace: The Python Logger That Draws Diagrams
+
+🌐 **Language**: [English](README.md) | [中文](README_CN.md)
+
+[![PyPI version](https://img.shields.io/pypi/v/mermaid-trace.svg?style=flat-square&color=blue)](https://pypi.org/project/mermaid-trace/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/mermaid-trace.svg?style=flat-square&color=blue)](https://pypi.org/project/mermaid-trace/)
+[![License](https://img.shields.io/github/license/xt765/mermaid-trace?style=flat-square)](LICENSE)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/xt765/mermaid-trace/ci.yml?style=flat-square&label=CI)](https://github.com/xt765/mermaid-trace/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/xt765/mermaid-trace?style=flat-square&logo=codecov)](https://codecov.io/gh/xt765/mermaid-trace)
+
+---
+
+## 📋 Overview
+
+**Stop reading logs. Start watching them.**
+
+MermaidTrace is a specialized logging tool that automatically generates [Mermaid JS](https://mermaid.js.org/) sequence diagrams from your code execution. It's perfect for visualizing complex business logic, microservice interactions, or asynchronous flows.
+
+---
+
+## 📚 Documentation
+
+### Core Documentation
+
+[User Guide](docs/en/USER_GUIDE.md) · [API Reference](docs/en/API.md) · [Contributing Guidelines](docs/en/CONTRIBUTING.md) · [Changelog](docs/en/CHANGELOG.md) · [License](docs/en/LICENSE)
+
+### Code Comment Documents (Chinese)
+
+| Category | Links |
+| :--- | :--- |
+| **Core Modules** | [Context](docs/zh/code_comments/src/mermaid_trace/core/context.md) · [Decorators](docs/zh/code_comments/src/mermaid_trace/core/decorators.md) · [Events](docs/zh/code_comments/src/mermaid_trace/core/events.md) · [Formatter](docs/zh/code_comments/src/mermaid_trace/core/formatter.md) |
+| **Handlers** | [Async Handler](docs/zh/code_comments/src/mermaid_trace/handlers/async_handler.md) · [Mermaid Handler](docs/zh/code_comments/src/mermaid_trace/handlers/mermaid_handler.md) |
+| **Integrations** | [FastAPI](docs/zh/code_comments/src/mermaid_trace/integrations/fastapi.md) |
+| **Others** | [init](docs/zh/code_comments/src/mermaid_trace/__init__.md) · [CLI](docs/zh/code_comments/src/mermaid_trace/cli.md) |
+
+---
+
+## ✨ Key Features
+
+- **Decorator-Driven**: Just add `@trace` or `@trace_interaction` to your functions.
+- **Auto-Instrumentation**: Use `@trace_class` to trace a whole class at once.
+- **Third-Party Patching**: Use `patch_object` to trace calls inside external libraries.
+- **Auto-Diagramming**: Generates `.mmd` files that can be viewed in VS Code, GitHub, or Mermaid Live Editor.
+- **Async Support**: Works seamlessly with `asyncio` coroutines.
+- **Context Inference**: Automatically tracks nested calls and infers `source` participants using `contextvars`.
+- **Intelligent Collapsing**: Prevents diagram explosion by collapsing repetitive high-frequency calls and identifying recurring patterns (e.g., loops).
+- **Detailed Exceptions**: Captures full stack traces for errors, displayed in interactive notes.
+- **Simplified Objects**: Automatically cleans up memory addresses (e.g., `<__main__.Obj at 0x...>` -> `<Obj>`) and **groups consecutive identical items** in lists/tuples (e.g., `[<Obj> x 5]`) for cleaner diagrams.
+- **Log Rotation**: Supports `RotatingMermaidFileHandler` for handling long-running systems by splitting logs based on size or time.
+- **FastAPI Integration**: Includes middleware for zero-config HTTP request tracing, supporting distributed tracing via `X-Trace-ID` and `X-Source` headers.
+- **CLI Tool**: Built-in viewer with live-reload to preview diagrams in your browser.
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install mermaid-trace
+```
+
+### Basic Usage
+
+```python
+from mermaid_trace import trace, configure_flow
+import time
+
+# 1. Configure output
+# Recommendation: Store diagrams in a dedicated directory (e.g., mermaid_diagrams/)
+configure_flow("mermaid_diagrams/my_flow.mmd", async_mode=True)
+
+# 2. Add decorators
+@trace(source="Client", target="PaymentService", action="Process Payment")
+def process_payment(amount):
+    if check_balance(amount):
+        return "Success"
+    return "Failed"
+
+@trace(source="PaymentService", target="Database", action="Check Balance")
+def check_balance(amount):
+    return True
+
+# 3. Run your code
+process_payment(100)
+```
+
+### Configuration
+
+You can configure global settings via `configure_flow` or environment variables to control performance and behavior.
+
+```python
+configure_flow(
+    "flow.mmd", 
+    overwrite=True,    # Overwrite the file on each restart (default: True)
+    level=logging.DEBUG, 
+    queue_size=5000,  # Increase buffer for high-throughput
+    config_overrides={
+        "capture_args": False,       # Disable arg capturing for max performance
+        "max_string_length": 100     # Increase string truncation limit
+    }
+)
+```
+
+**Environment Variables:**
+- `MERMAID_TRACE_CAPTURE_ARGS` (true/false)
+- `MERMAID_TRACE_MAX_STRING_LENGTH` (int)
+- `MERMAID_TRACE_MAX_ARG_DEPTH` (int)
+- `MERMAID_TRACE_QUEUE_SIZE` (int)
+
+### Nested Calls (Context Inference)
+
+You don't need to specify `source` every time. MermaidTrace infers it from the current context.
+
+```python
+@trace(source="Client", target="API")
+def main():
+    # Inside here, current participant is "API"
+    service_call()
+
+@trace(target="Service") # source inferred as "API"
+def service_call():
+    pass
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from mermaid_trace.integrations.fastapi import MermaidTraceMiddleware
+
+app = FastAPI()
+app.add_middleware(MermaidTraceMiddleware, app_name="MyAPI")
+
+@app.get("/")
+async def root():
+    return {"message": "Hello World"}
+```
+
+### CLI Viewer
+
+Visualize your generated `.mmd` files instantly:
+
+```bash
+mermaid-trace serve my_flow.mmd
+```
+
+### Examples
+
+Check out the [examples/](examples/) directory for a complete set of demos covering all features:
+- **[Basic Usage](examples/01_basic_usage.py)**: Decorators and class methods.
+- **[Advanced Instrumentation](examples/02_advanced_instrumentation.py)**: `@trace_class` and `patch_object` for third-party libraries.
+- **[Async & Concurrency](examples/03_async_concurrency.py)**: Tracing `asyncio` and concurrent tasks.
+- **[Error Handling](examples/04_error_handling.py)**: Stack trace capture and error rendering.
+- **[Intelligent Collapsing](examples/05_intelligent_collapsing.py)**: Keeping diagrams clean in loops.
+- **[FastAPI Integration](examples/06_fastapi_integration.py)**: Middleware for web apps.
+- **[Full Stack App](examples/07_full_stack_app.py)**: Comprehensive example with FastAPI, SQLAlchemy, and Pydantic.
+- **[Log Rotation](examples/08-log-rotation.py)**: Handling long-running processes with file rotation.
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](docs/en/CONTRIBUTING.md) for details.
+
+---
+
+## 📄 License
+
+MIT

{mermaid_trace-0.4.1 → mermaid_trace-0.5.3.post0}/README_CN.md

@@ -20,29 +20,35 @@ MermaidTrace 是一个专业的日志工具，能从你的代码执行中自动
 
 ## 📚 文档
 
-### 主要文档
+### 核心文档
 
 [用户指南](docs/zh/USER_GUIDE.md) · [API 参考](docs/zh/API.md) · [贡献指南](docs/zh/CONTRIBUTING.md) · [更新日志](docs/zh/CHANGELOG.md) · [许可证](docs/zh/LICENSE)
 
-### 代码注释文档
+### 代码注释文档 (中文)
 
-| 类别               | 链接                                                                                                                                                                                                                                                                             |
-| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 类别 | 链接 |
+| :--- | :--- |
 | **核心模块** | [Context](docs/zh/code_comments/src/mermaid_trace/core/context.md) · [Decorators](docs/zh/code_comments/src/mermaid_trace/core/decorators.md) · [Events](docs/zh/code_comments/src/mermaid_trace/core/events.md) · [Formatter](docs/zh/code_comments/src/mermaid_trace/core/formatter.md) |
-| **处理器**   | [Async Handler](docs/zh/code_comments/src/mermaid_trace/handlers/async_handler.md) · [Mermaid Handler](docs/zh/code_comments/src/mermaid_trace/handlers/mermaid_handler.md)                                                                                                           |
-| **集成**     | [FastAPI](docs/zh/code_comments/src/mermaid_trace/integrations/fastapi.md)                                                                                                                                                                                                          |
-| **其他**     | [init](docs/zh/code_comments/src/mermaid_trace/__init__.md) · [CLI](docs/zh/code_comments/src/mermaid_trace/cli.md)                                                                                                                                                         |
+| **处理器** | [Async Handler](docs/zh/code_comments/src/mermaid_trace/handlers/async_handler.md) · [Mermaid Handler](docs/zh/code_comments/src/mermaid_trace/handlers/mermaid_handler.md) |
+| **集成** | [FastAPI](docs/zh/code_comments/src/mermaid_trace/integrations/fastapi.md) |
+| **其他** | [init](docs/zh/code_comments/src/mermaid_trace/__init__.md) · [CLI](docs/zh/code_comments/src/mermaid_trace/cli.md) |
 
 ---
 
 ## ✨ 核心特性
 
 - **装饰器驱动**：只需在函数上添加 `@trace` 或 `@trace_interaction` 即可。
+- **批量追踪**：使用 `@trace_class` 一次性追踪整个类的方法。
+- **第三方库追踪**：使用 `patch_object` 对外部库方法做 patch 并加入追踪。
 - **自动绘图**：生成 `.mmd` 文件，可在 VS Code、GitHub 或 Mermaid Live Editor 中查看。
-- **异步支持**：无缝支持 `asyncio` 协程。
+- **异步支持**：无缝支持 `asyncio`协程。
 - **上下文推断**：利用 `contextvars` 自动追踪嵌套调用并推断 `source`（调用方）参与者。
-- **FastAPI 集成**：内置中间件，实现零配置的 HTTP 请求追踪。
-- **CLI 工具**：内置查看器，可在浏览器中即时预览图表。
+- **智能折叠**：通过折叠重复的高频调用和识别循环模式（如循环调用），防止时序图过载。
+- **详细异常堆栈**：自动捕获完整的错误堆栈追踪，并在图表中通过 Note 显示。
+- **对象显示优化**：自动清理内存地址（例如 `<__main__.Obj at 0x...>` -> `<Obj>`），并**自动合并列表/元组中连续的相同项**（例如 `[<Obj> x 5]`），使图表更整洁。
+- **日志轮转**：支持 `RotatingMermaidFileHandler`，通过按大小或时间切割日志文件，轻松应对长运行系统的日志膨胀问题。
+- **FastAPI 集成**：内置中间件，实现零配置的 HTTP 请求追踪，支持通过 `X-Trace-ID` 和 `X-Source` 请求头进行分布式追踪。
+- **CLI 工具**：内置带热重载功能的查看器，可在浏览器中即时预览图表。
 
 ---
 
@@ -61,7 +67,8 @@ from mermaid_trace import trace, configure_flow
 import time
 
 # 1. 配置输出文件
-configure_flow("my_flow.mmd")
+# 建议将图表存放在专门的目录中（如 mermaid_diagrams/）以保持项目整洁。
+configure_flow("mermaid_diagrams/my_flow.mmd", async_mode=True)
 
 # 2. 添加装饰器
 @trace(source="Client", target="PaymentService", action="Process Payment")
@@ -78,6 +85,30 @@ def check_balance(amount):
 process_payment(100)
 ```
 
+### 全局配置
+
+你可以通过 `configure_flow` 或环境变量来配置全局设置，以控制性能和行为。
+
+```python
+configure_flow(
+    "flow.mmd", 
+    overwrite=True,    # 每次运行是否覆盖原文件（默认为 True）
+    level=logging.DEBUG, 
+    queue_size=5000,  # 增加队列缓冲区以应对高并发
+    config_overrides={
+        "capture_args": False,       # 关闭参数捕获以获得最高性能
+        "max_string_length": 100     # 增加字符串截断长度
+    }
+)
+```
+
+**环境变量支持：**
+
+- `MERMAID_TRACE_CAPTURE_ARGS` (true/false)
+- `MERMAID_TRACE_MAX_STRING_LENGTH` (int)
+- `MERMAID_TRACE_MAX_ARG_DEPTH` (int)
+- `MERMAID_TRACE_QUEUE_SIZE` (int)
+
 ### 嵌套调用（上下文推断）
 
 你不需要每次都指定 `source`（调用方）。MermaidTrace 会根据当前上下文自动推断。
@@ -115,6 +146,19 @@ async def root():
 mermaid-trace serve my_flow.mmd
 ```
 
+### 示例教程
+
+请查看 [examples/](examples/) 目录，了解涵盖所有功能的完整示例集：
+
+- **[基础用法](examples/01_basic_usage.py)**：装饰器与类方法追踪。
+- **[高级插桩](examples/02_advanced_instrumentation.py)**：`@trace_class` 与 `patch_object`（针对第三方库）。
+- **[异步与并发](examples/03_async_concurrency.py)**：`asyncio` 追踪与并发上下文隔离。
+- **[错误处理](examples/04_error_handling.py)**：堆栈捕获与错误箭头渲染。
+- **[智能折叠](examples/05_intelligent_collapsing.py)**：在循环中保持图表整洁。
+- **[FastAPI 集成](examples/06_fastapi_integration.py)**：Web 应用中间件集成。
+- **[全栈综合应用](examples/07_full_stack_app.py)**：结合 FastAPI、SQLAlchemy 和 Pydantic 的全链路追踪示例。
+- **[日志轮转](examples/08-log-rotation.py)**：演示如何使用日志轮转处理长运行进程。
+
 ---
 
 ## 🤝 贡献

{mermaid_trace-0.4.1 → mermaid_trace-0.5.3.post0}/docs/en/API.md

@@ -4,6 +4,8 @@
 
 - [Core](#core)
   - [trace / trace_interaction](#trace--trace_interaction)
+  - [trace_class](#trace_class)
+  - [patch_object](#patch_object)
   - [configure_flow](#configure_flow)
   - [LogContext](#logcontext)
   - [Event (Abstract Base Class)](#event-abstract-base-class)
@@ -40,6 +42,40 @@ def login(username): ...
 - `max_arg_length` (int): Maximum length of string representation for arguments. Defaults to 50.
 - `max_arg_depth` (int): Maximum depth for nested structures in argument representation. Defaults to 1.
 
+### `trace_class`
+
+Class decorator to automatically apply `@trace` to methods of a class.
+
+```python
+from mermaid_trace import trace_class
+
+@trace_class
+class MyService:
+    def method_a(self) -> None:
+        ...
+```
+
+**Arguments:**
+- `include_private` (bool): If True, traces methods starting with `_`. Defaults to False.
+- `exclude` (Optional[List[str]]): Method names to skip.
+- `**trace_kwargs`: Passed through to `@trace` (e.g., `capture_args=False`).
+
+### `patch_object`
+
+Monkey-patches a method on an object/class/module with tracing.
+
+```python
+import requests
+from mermaid_trace import patch_object
+
+patch_object(requests, "get", action="HTTP GET", target="requests")
+```
+
+**Arguments:**
+- `target` (Any): Object/class/module that owns the attribute.
+- `method_name` (str): Attribute name to wrap.
+- `**trace_kwargs`: Passed through to `@trace`.
+
 ### `configure_flow`
 
 Configures the global logger to output to a Mermaid file. This should be called once at application startup.
@@ -49,7 +85,11 @@ def configure_flow(
     output_file: str = "flow.mmd",
     handlers: Optional[List[logging.Handler]] = None,
     append: bool = False,
-    async_mode: bool = False
+    overwrite: bool = True,
+    async_mode: bool = False,
+    level: int = logging.INFO,
+    config_overrides: Optional[Dict[str, Any]] = None,
+    queue_size: Optional[int] = None,
 ) -> logging.Logger
 ```
 
@@ -57,7 +97,11 @@ def configure_flow(
 - `output_file` (str): Path to the `.mmd` output file. Defaults to "flow.mmd".
 - `handlers` (List[logging.Handler]): Optional list of custom logging handlers. If provided, `output_file` is ignored unless you include `MermaidFileHandler` manually.
 - `append` (bool): If `True`, adds new handlers without removing existing ones. Defaults to `False`.
+- `overwrite` (bool): If `True` (default), overwrites the output file on each restart. If `False`, appends to the existing file.
 - `async_mode` (bool): If `True`, uses a non-blocking background thread for logging (QueueHandler). Recommended for production. Defaults to `False`.
+- `level` (int): Logger level. Defaults to `logging.INFO`.
+- `config_overrides` (Optional[Dict[str, Any]]): Overrides for global config keys (MermaidConfig fields).
+- `queue_size` (Optional[int]): Queue size for async mode; overrides config.
 
 ### `LogContext`
 
@@ -73,13 +117,13 @@ Manages execution context (like thread-local storage) to track caller/callee rel
 
 Abstract base class for all event types, providing a common interface for different types of events.
 
-**Methods:**
-- `get_source() -> str`: Get the source of the event.
-- `get_target() -> str`: Get the target of the event.
-- `get_action() -> str`: Get the action name of the event.
-- `get_message() -> str`: Get the message text of the event.
-- `get_timestamp() -> float`: Get the timestamp of the event.
-- `get_trace_id() -> str`: Get the trace ID of the event.
+**Attributes:**
+- `source` (str): Name of the participant that generated the event.
+- `target` (str): Name of the participant that received the event.
+- `action` (str): Short name describing the action performed.
+- `message` (str): Detailed message describing the event.
+- `timestamp` (float): Unix timestamp (seconds) when the event occurred.
+- `trace_id` (str): Unique identifier for the trace session.
 
 ### `FlowEvent`
 
@@ -95,8 +139,10 @@ Represents a single interaction or step in the execution flow, inheriting from `
 - `is_return` (bool): Flag indicating if this is a response arrow.
 - `is_error` (bool): Flag indicating if an exception occurred.
 - `error_message` (Optional[str]): Detailed error text if `is_error` is True.
+- `stack_trace` (Optional[str]): Full stack trace text if available.
 - `params` (Optional[str]): Stringified representation of function arguments.
 - `result` (Optional[str]): Stringified representation of the return value.
+- `collapsed` (bool): Flag indicating this interaction should be visually collapsed.
 
 ### `BaseFormatter` (Abstract Base Class)
 
@@ -104,6 +150,7 @@ Abstract base class for all event formatters, providing a common interface for d
 
 **Methods:**
 - `format_event(event: Event) -> str`: Format an Event into the desired output string.
+- `get_header(title: str) -> str`: Get the file header for the diagram format.
 - `format(record: logging.LogRecord) -> str`: Format a logging record containing an event.
 
 ### `MermaidFormatter`
@@ -112,6 +159,7 @@ Custom formatter to convert Events into Mermaid sequence diagram syntax, inherit
 
 **Methods:**
 - `format_event(event: Event) -> str`: Converts an Event into a Mermaid syntax string.
+- `get_header(title: str) -> str`: Returns the Mermaid sequence diagram header.
 
 ### `MermaidFileHandler`
 

{mermaid_trace-0.4.1 → mermaid_trace-0.5.3.post0}/docs/en/CHANGELOG.md

@@ -5,6 +5,53 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.3] - 2026-01-27
+
+### Added
+- **Log Rotation**: Introduced `RotatingMermaidFileHandler` and `TimedRotatingMermaidFileHandler` to handle long-running systems by automatically splitting `.mmd` files based on size or time.
+- **Overwrite Support**: Added `overwrite` parameter to `configure_flow` to allow clearing the diagram file on application restart.
+
+### Improved
+- **Documentation**: Comprehensive update of English and Chinese documentation, including User Guide, API Reference, and detailed source code annotations.
+- **Examples**: Added a new example `08-log-rotation.py` demonstrating production-ready log rotation configurations.
+
+## [0.5.2] - 2026-01-27
+
+### Added
+- **List/Tuple Item Grouping**: Consecutive identical items in lists and tuples are now automatically grouped (e.g., `['a', 'a', 'a']` -> `['a' x 3]`), significantly reducing visual noise in diagrams when dealing with large collections of similar objects.
+
+### Improved
+- **Test Coverage**: Increased test coverage to **96.22%** by adding comprehensive test cases for edge cases in CLI, decorators, and handlers.
+- **Robustness**: Improved CLI error handling and live reload stability by fixing mock handling and ensuring proper cleanup.
+- **Documentation**: Synchronized all documentation across languages and updated comprehensive Chinese source code annotations for all modules.
+
+## [0.5.0] - 2026-01-27
+
+### Added
+- **Intelligent Collapsing**: Repetitive high-frequency calls are now automatically collapsed into a single arrow with a counter (e.g., `func (x10)`), preventing diagram bloat.
+- **Auto-Instrumentation**: Added `@trace_class` decorator to automatically trace all public methods in a class.
+- **Third-Party Patching**: Added `patch_object` utility to trace methods in external libraries (e.g., `requests.get`) without modifying their source.
+- **Global Configuration**: Introduced `MermaidConfig` system allowing global control over parameter capture, string limits, and recursion depth via code or environment variables.
+- **Full Stack Trace Capture**: Exceptions now capture the complete Python traceback, displayed as a Note in the Mermaid diagram for easier debugging.
+
+### Changed
+- **`configure_flow` API**: Updated to support `level`, `config_overrides`, and `queue_size` for more flexible initialization.
+- **Enhanced FastAPI Integration**: The middleware now captures and logs full stack traces for unhandled exceptions.
+
+### Improved
+- **Documentation**: Added comprehensive Chinese source code annotations for all modules.
+- **Test Coverage**: Maintained >93% coverage with new tests for collapsing and configuration logic.
+
+## [0.4.2] - 2026-01-27
+
+### Fixed
+- **Lazy Loading**: Fixed `MermaidFileHandler` to respect `delay=True`. File is now only created when the first log event is emitted, preventing empty files from being created unnecessarily.
+- **Naming Collisions**: Fixed `MermaidFormatter._sanitize` to handle naming collisions robustly (e.g., `User A` vs `User-A`) by ensuring unique Mermaid IDs.
+
+### Improved
+- **Code Cleanup**: Removed redundant getter methods in `Event` and `FlowEvent` in favor of Pythonic attribute access.
+- **Handler SRP**: Decoupled Mermaid header generation from `MermaidFileHandler` by moving logic to `MermaidFormatter.get_header()`.
+
 ## [0.4.1] - 2026-01-26
 
 ### Added