# notspam
一定時間内に同一ログを出さない超軽量ログラッパー
## 概要
`notspam`は、スパムログ防止・モニタリング用の超軽量ログラッパーです。同じログメッセージが一定時間内に繰り返し出力されることを防ぎ、ログの可読性を向上させます。
## 特徴
- **超軽量**: 標準ライブラリのみ使用、外部依存なし
- **ワンライナー設置**: 簡単な設定で即座に使用可能
- **全ログレベル対応**: DEBUG, INFO, WARNING, ERROR, CRITICAL全てに対応
- **スレッドセーフ**: マルチスレッド環境でも安全に使用可能
- **メモリ効率**: 自動的に古いログ履歴をクリーンアップ
- **カスタマイズ可能**: 抑制時間やロガー名を自由に設定
## インストール
```bash
pip install notspam
```
## 使用方法
### 基本的な使用法
```python
import notspam
# デフォルト設定（60秒間抑制）
logger = notspam.get_logger()
# 最初のログは出力される
logger.info("This is a test message")
# 60秒以内の同じメッセージは抑制される
logger.info("This is a test message") # 抑制される
# 異なるメッセージは出力される
logger.info("This is a different message") # 出力される
```
### カスタム設定
```python
import notspam
# 30秒間抑制、カスタムロガー名
logger = notspam.get_logger(suppress_seconds=30, name="my_app")
logger.warning("Warning message")
logger.error("Error message")
```
### 複数のロガーを使用
```python
import notspam
# 異なる設定の複数のロガー
api_logger = notspam.create_logger(suppress_seconds=120, name="api")
db_logger = notspam.create_logger(suppress_seconds=60, name="database")
api_logger.info("API request received")
db_logger.error("Database connection failed")
```
### 全てのログレベルを使用
```python
import notspam
import logging
logger = notspam.get_logger(level=logging.DEBUG)
logger.debug("Debug message")
logger.info("Info message")
logger.warning("Warning message")
logger.error("Error message")
logger.critical("Critical message")
```
## API リファレンス
### `get_logger(suppress_seconds=60, name=None, level=logging.INFO)`
グローバルロガーインスタンスを取得します。
**パラメータ:**
- `suppress_seconds` (int): 同じログを抑制する秒数（デフォルト: 60）
- `name` (str): ロガー名（デフォルト: "notspam"）
- `level` (int): ログレベル（デフォルト: logging.INFO）
**戻り値:**
- `NotSpamLogger`: ロガーインスタンス
### `create_logger(suppress_seconds=60, name=None, level=logging.INFO)`
新しいロガーインスタンスを作成します。
**パラメータ:**
- `suppress_seconds` (int): 同じログを抑制する秒数（デフォルト: 60）
- `name` (str): ロガー名（デフォルト: "notspam"）
- `level` (int): ログレベル（デフォルト: logging.INFO）
**戻り値:**
- `NotSpamLogger`: 新しいロガーインスタンス
### NotSpamLogger クラス
#### メソッド
- `debug(message, *args, **kwargs)`: DEBUGレベルのログ
- `info(message, *args, **kwargs)`: INFOレベルのログ
- `warning(message, *args, **kwargs)`: WARNINGレベルのログ
- `error(message, *args, **kwargs)`: ERRORレベルのログ
- `critical(message, *args, **kwargs)`: CRITICALレベルのログ
- `set_level(level)`: ログレベルを設定
- `get_suppressed_count()`: 現在抑制中のメッセージ数を取得
- `clear_history()`: ログ履歴をクリア
## 使用例
### Webアプリケーションでの使用
```python
import notspam
from flask import Flask
app = Flask(__name__)
logger = notspam.get_logger(suppress_seconds=300, name="webapp")
@app.route("/api/data")
def get_data():
try:
# データベースアクセス
data = fetch_data()
logger.info("Data fetched successfully")
return data
except Exception as e:
# エラーログの重複を防ぐ
logger.error(f"Failed to fetch data: {e}")
return {"error": "Internal server error"}, 500
```
### 定期実行スクリプトでの使用
```python
import notspam
import schedule
import time
logger = notspam.get_logger(suppress_seconds=60, name="scheduler")
def job():
try:
# 何らかの処理
result = process_data()
logger.info("Job completed successfully")
except Exception as e:
# 1分間同じエラーログを抑制
logger.error(f"Job failed: {e}")
schedule.every(10).seconds.do(job)
while True:
schedule.run_pending()
time.sleep(1)
```
## ライセンス
MIT License
## 作者
tikipiya
Raw data
{
"_id": null,
"home_page": "https://github.com/tikipiya/notspam",
"name": "notspam",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "logging, spam, duplicate, suppression, wrapper, lightweight",
"author": "tikipiya",
"author_email": "s2501082@sendai-nct.jp",
"download_url": "https://files.pythonhosted.org/packages/17/d3/d31429502887d6777d84bff8cb8aec84c4e9b538ebd8fec8e0591d1b8445/notspam-1.0.0.tar.gz",
"platform": null,
"description": "# notspam\r\n\r\n\u4e00\u5b9a\u6642\u9593\u5185\u306b\u540c\u4e00\u30ed\u30b0\u3092\u51fa\u3055\u306a\u3044\u8d85\u8efd\u91cf\u30ed\u30b0\u30e9\u30c3\u30d1\u30fc\r\n\r\n## \u6982\u8981\r\n\r\n`notspam`\u306f\u3001\u30b9\u30d1\u30e0\u30ed\u30b0\u9632\u6b62\u30fb\u30e2\u30cb\u30bf\u30ea\u30f3\u30b0\u7528\u306e\u8d85\u8efd\u91cf\u30ed\u30b0\u30e9\u30c3\u30d1\u30fc\u3067\u3059\u3002\u540c\u3058\u30ed\u30b0\u30e1\u30c3\u30bb\u30fc\u30b8\u304c\u4e00\u5b9a\u6642\u9593\u5185\u306b\u7e70\u308a\u8fd4\u3057\u51fa\u529b\u3055\u308c\u308b\u3053\u3068\u3092\u9632\u304e\u3001\u30ed\u30b0\u306e\u53ef\u8aad\u6027\u3092\u5411\u4e0a\u3055\u305b\u307e\u3059\u3002\r\n\r\n## \u7279\u5fb4\r\n\r\n- **\u8d85\u8efd\u91cf**: \u6a19\u6e96\u30e9\u30a4\u30d6\u30e9\u30ea\u306e\u307f\u4f7f\u7528\u3001\u5916\u90e8\u4f9d\u5b58\u306a\u3057\r\n- **\u30ef\u30f3\u30e9\u30a4\u30ca\u30fc\u8a2d\u7f6e**: \u7c21\u5358\u306a\u8a2d\u5b9a\u3067\u5373\u5ea7\u306b\u4f7f\u7528\u53ef\u80fd\r\n- **\u5168\u30ed\u30b0\u30ec\u30d9\u30eb\u5bfe\u5fdc**: DEBUG, INFO, WARNING, ERROR, CRITICAL\u5168\u3066\u306b\u5bfe\u5fdc\r\n- **\u30b9\u30ec\u30c3\u30c9\u30bb\u30fc\u30d5**: \u30de\u30eb\u30c1\u30b9\u30ec\u30c3\u30c9\u74b0\u5883\u3067\u3082\u5b89\u5168\u306b\u4f7f\u7528\u53ef\u80fd\r\n- **\u30e1\u30e2\u30ea\u52b9\u7387**: \u81ea\u52d5\u7684\u306b\u53e4\u3044\u30ed\u30b0\u5c65\u6b74\u3092\u30af\u30ea\u30fc\u30f3\u30a2\u30c3\u30d7\r\n- **\u30ab\u30b9\u30bf\u30de\u30a4\u30ba\u53ef\u80fd**: \u6291\u5236\u6642\u9593\u3084\u30ed\u30ac\u30fc\u540d\u3092\u81ea\u7531\u306b\u8a2d\u5b9a\r\n\r\n## \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\r\n\r\n```bash\r\npip install notspam\r\n```\r\n\r\n## \u4f7f\u7528\u65b9\u6cd5\r\n\r\n### \u57fa\u672c\u7684\u306a\u4f7f\u7528\u6cd5\r\n\r\n```python\r\nimport notspam\r\n\r\n# \u30c7\u30d5\u30a9\u30eb\u30c8\u8a2d\u5b9a\uff0860\u79d2\u9593\u6291\u5236\uff09\r\nlogger = notspam.get_logger()\r\n\r\n# \u6700\u521d\u306e\u30ed\u30b0\u306f\u51fa\u529b\u3055\u308c\u308b\r\nlogger.info(\"This is a test message\")\r\n\r\n# 60\u79d2\u4ee5\u5185\u306e\u540c\u3058\u30e1\u30c3\u30bb\u30fc\u30b8\u306f\u6291\u5236\u3055\u308c\u308b\r\nlogger.info(\"This is a test message\") # \u6291\u5236\u3055\u308c\u308b\r\n\r\n# \u7570\u306a\u308b\u30e1\u30c3\u30bb\u30fc\u30b8\u306f\u51fa\u529b\u3055\u308c\u308b\r\nlogger.info(\"This is a different message\") # \u51fa\u529b\u3055\u308c\u308b\r\n```\r\n\r\n### \u30ab\u30b9\u30bf\u30e0\u8a2d\u5b9a\r\n\r\n```python\r\nimport notspam\r\n\r\n# 30\u79d2\u9593\u6291\u5236\u3001\u30ab\u30b9\u30bf\u30e0\u30ed\u30ac\u30fc\u540d\r\nlogger = notspam.get_logger(suppress_seconds=30, name=\"my_app\")\r\n\r\nlogger.warning(\"Warning message\")\r\nlogger.error(\"Error message\")\r\n```\r\n\r\n### \u8907\u6570\u306e\u30ed\u30ac\u30fc\u3092\u4f7f\u7528\r\n\r\n```python\r\nimport notspam\r\n\r\n# \u7570\u306a\u308b\u8a2d\u5b9a\u306e\u8907\u6570\u306e\u30ed\u30ac\u30fc\r\napi_logger = notspam.create_logger(suppress_seconds=120, name=\"api\")\r\ndb_logger = notspam.create_logger(suppress_seconds=60, name=\"database\")\r\n\r\napi_logger.info(\"API request received\")\r\ndb_logger.error(\"Database connection failed\")\r\n```\r\n\r\n### \u5168\u3066\u306e\u30ed\u30b0\u30ec\u30d9\u30eb\u3092\u4f7f\u7528\r\n\r\n```python\r\nimport notspam\r\nimport logging\r\n\r\nlogger = notspam.get_logger(level=logging.DEBUG)\r\n\r\nlogger.debug(\"Debug message\")\r\nlogger.info(\"Info message\")\r\nlogger.warning(\"Warning message\")\r\nlogger.error(\"Error message\")\r\nlogger.critical(\"Critical message\")\r\n```\r\n\r\n## API \u30ea\u30d5\u30a1\u30ec\u30f3\u30b9\r\n\r\n### `get_logger(suppress_seconds=60, name=None, level=logging.INFO)`\r\n\r\n\u30b0\u30ed\u30fc\u30d0\u30eb\u30ed\u30ac\u30fc\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u3092\u53d6\u5f97\u3057\u307e\u3059\u3002\r\n\r\n**\u30d1\u30e9\u30e1\u30fc\u30bf:**\r\n- `suppress_seconds` (int): \u540c\u3058\u30ed\u30b0\u3092\u6291\u5236\u3059\u308b\u79d2\u6570\uff08\u30c7\u30d5\u30a9\u30eb\u30c8: 60\uff09\r\n- `name` (str): \u30ed\u30ac\u30fc\u540d\uff08\u30c7\u30d5\u30a9\u30eb\u30c8: \"notspam\"\uff09\r\n- `level` (int): \u30ed\u30b0\u30ec\u30d9\u30eb\uff08\u30c7\u30d5\u30a9\u30eb\u30c8: logging.INFO\uff09\r\n\r\n**\u623b\u308a\u5024:**\r\n- `NotSpamLogger`: \u30ed\u30ac\u30fc\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\r\n\r\n### `create_logger(suppress_seconds=60, name=None, level=logging.INFO)`\r\n\r\n\u65b0\u3057\u3044\u30ed\u30ac\u30fc\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u3092\u4f5c\u6210\u3057\u307e\u3059\u3002\r\n\r\n**\u30d1\u30e9\u30e1\u30fc\u30bf:**\r\n- `suppress_seconds` (int): \u540c\u3058\u30ed\u30b0\u3092\u6291\u5236\u3059\u308b\u79d2\u6570\uff08\u30c7\u30d5\u30a9\u30eb\u30c8: 60\uff09\r\n- `name` (str): \u30ed\u30ac\u30fc\u540d\uff08\u30c7\u30d5\u30a9\u30eb\u30c8: \"notspam\"\uff09\r\n- `level` (int): \u30ed\u30b0\u30ec\u30d9\u30eb\uff08\u30c7\u30d5\u30a9\u30eb\u30c8: logging.INFO\uff09\r\n\r\n**\u623b\u308a\u5024:**\r\n- `NotSpamLogger`: \u65b0\u3057\u3044\u30ed\u30ac\u30fc\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\r\n\r\n### NotSpamLogger \u30af\u30e9\u30b9\r\n\r\n#### \u30e1\u30bd\u30c3\u30c9\r\n\r\n- `debug(message, *args, **kwargs)`: DEBUG\u30ec\u30d9\u30eb\u306e\u30ed\u30b0\r\n- `info(message, *args, **kwargs)`: INFO\u30ec\u30d9\u30eb\u306e\u30ed\u30b0\r\n- `warning(message, *args, **kwargs)`: WARNING\u30ec\u30d9\u30eb\u306e\u30ed\u30b0\r\n- `error(message, *args, **kwargs)`: ERROR\u30ec\u30d9\u30eb\u306e\u30ed\u30b0\r\n- `critical(message, *args, **kwargs)`: CRITICAL\u30ec\u30d9\u30eb\u306e\u30ed\u30b0\r\n- `set_level(level)`: \u30ed\u30b0\u30ec\u30d9\u30eb\u3092\u8a2d\u5b9a\r\n- `get_suppressed_count()`: \u73fe\u5728\u6291\u5236\u4e2d\u306e\u30e1\u30c3\u30bb\u30fc\u30b8\u6570\u3092\u53d6\u5f97\r\n- `clear_history()`: \u30ed\u30b0\u5c65\u6b74\u3092\u30af\u30ea\u30a2\r\n\r\n## \u4f7f\u7528\u4f8b\r\n\r\n### Web\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u3067\u306e\u4f7f\u7528\r\n\r\n```python\r\nimport notspam\r\nfrom flask import Flask\r\n\r\napp = Flask(__name__)\r\nlogger = notspam.get_logger(suppress_seconds=300, name=\"webapp\")\r\n\r\n@app.route(\"/api/data\")\r\ndef get_data():\r\n try:\r\n # \u30c7\u30fc\u30bf\u30d9\u30fc\u30b9\u30a2\u30af\u30bb\u30b9\r\n data = fetch_data()\r\n logger.info(\"Data fetched successfully\")\r\n return data\r\n except Exception as e:\r\n # \u30a8\u30e9\u30fc\u30ed\u30b0\u306e\u91cd\u8907\u3092\u9632\u3050\r\n logger.error(f\"Failed to fetch data: {e}\")\r\n return {\"error\": \"Internal server error\"}, 500\r\n```\r\n\r\n### \u5b9a\u671f\u5b9f\u884c\u30b9\u30af\u30ea\u30d7\u30c8\u3067\u306e\u4f7f\u7528\r\n\r\n```python\r\nimport notspam\r\nimport schedule\r\nimport time\r\n\r\nlogger = notspam.get_logger(suppress_seconds=60, name=\"scheduler\")\r\n\r\ndef job():\r\n try:\r\n # \u4f55\u3089\u304b\u306e\u51e6\u7406\r\n result = process_data()\r\n logger.info(\"Job completed successfully\")\r\n except Exception as e:\r\n # 1\u5206\u9593\u540c\u3058\u30a8\u30e9\u30fc\u30ed\u30b0\u3092\u6291\u5236\r\n logger.error(f\"Job failed: {e}\")\r\n\r\nschedule.every(10).seconds.do(job)\r\n\r\nwhile True:\r\n schedule.run_pending()\r\n time.sleep(1)\r\n```\r\n\r\n## \u30e9\u30a4\u30bb\u30f3\u30b9\r\n\r\nMIT License\r\n\r\n## \u4f5c\u8005\r\n\r\ntikipiya\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Ultra-lightweight log wrapper that prevents duplicate logs within a specified time window",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/tikipiya/notspam/issues",
"Homepage": "https://github.com/tikipiya/notspam",
"Source": "https://github.com/tikipiya/notspam"
},
"split_keywords": [
"logging",
" spam",
" duplicate",
" suppression",
" wrapper",
" lightweight"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "229cce41f4d8fa53941e2c7a628eec34f7e40f9dfb1a5d7b3012d042c853dc44",
"md5": "4150d4b1c61f49307cc6bb758bfc9e34",
"sha256": "c5c76992c137afa43e2012fa83b1f5ad2de69178f4a9784e93bccda99d606661"
},
"downloads": -1,
"filename": "notspam-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4150d4b1c61f49307cc6bb758bfc9e34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8263,
"upload_time": "2025-07-11T13:53:06",
"upload_time_iso_8601": "2025-07-11T13:53:06.301225Z",
"url": "https://files.pythonhosted.org/packages/22/9c/ce41f4d8fa53941e2c7a628eec34f7e40f9dfb1a5d7b3012d042c853dc44/notspam-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "17d3d31429502887d6777d84bff8cb8aec84c4e9b538ebd8fec8e0591d1b8445",
"md5": "b9c688a918d86ab42a21a05d8fdd8b26",
"sha256": "d568696aac7846f038c0944b0e73b2142e4cd59e03d0de25ad4dda7f04cc8f23"
},
"downloads": -1,
"filename": "notspam-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b9c688a918d86ab42a21a05d8fdd8b26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11477,
"upload_time": "2025-07-11T13:53:07",
"upload_time_iso_8601": "2025-07-11T13:53:07.607094Z",
"url": "https://files.pythonhosted.org/packages/17/d3/d31429502887d6777d84bff8cb8aec84c4e9b538ebd8fec8e0591d1b8445/notspam-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 13:53:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tikipiya",
"github_project": "notspam",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "notspam"
}
JSON
