# dash-console-filter-plugin

**Repository Path**: cnfeffery/dash-console-filter-plugin

## Basic Information

- **Project Name**: dash-console-filter-plugin
- **Description**: 同步Github dash-console-filter-plugin仓库
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://github.com/CNFeffery/dash-console-filter-plugin
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-22
- **Last Updated**: 2025-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dash-console-filter-plugin

[![GitHub](https://shields.io/badge/license-MIT-informational)](https://github.com/CNFeffery/dash-console-filter-plugin/blob/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/dash-console-filter-plugin.svg?color=dark-green)](https://pypi.org/project/dash-console-filter-plugin/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

简体中文 | [English](./README.md)

适用于[Dash](https://github.com/plotly/dash)应用的控制台消息过滤插件，基于`Dash Hooks`实现，用于过滤浏览器控制台中包含特定关键词的报错信息，以避免控制台中出现不必要的信息输出。

## 安装

```bash
pip install dash-console-filter-plugin
```

## 使用

```python
import dash

# 导入插件启用函数
from dash_console_filter_plugin import setup_console_filter_plugin

# 为当前应用启用插件
setup_console_filter_plugin(keywords=["test warning message"])

app = dash.Dash(__name__)

# 其他应用代码...
```

## 示例

执行示例应用：

```bash
python example.py
```

<center><img src="./images/demo.gif" /></center>

## 参数说明

### `setup_console_filter_plugin()`

用于为当前`Dash`应用启用控制台消息过滤功能。

| 参数       | 类型      | 默认值 | 描述                                                     |
| ---------- | --------- | ------ | -------------------------------------------------------- |
| `keywords` | List[str] | None   | 关键词列表，控制台中包含任何关键词的报错信息将不会输出。 |