Merge pull request #8 from umyuu/feature/0.0.7

.github/workflows/deploy.yml

@@ -1,18 +1,21 @@
-# このGit Actionのワークフローは、git pushコマンドを使用し、HuggingFaceのSpaceにデプロイを行います。
-# 公式資料 https://huggingface.co/docs/hub/spaces-github-actions
-## ワークフロー構成
-# [GitHub]のリポジトリ → ワークフローによるgit push → [HuggingFace]のSpaceのリポジトリ
-## ワークフローの初期設定
-# 1, 認証情報を環境変数に設定
-# Settingsタブの「Secrets and variables」 > 「Actions」 > 「Repository secrets」に変数を設定してください。
-# HF_TOKEN…アクセストークン、アクセストークンの発行は、https://huggingface.co/settings/tokens よりTypeを「Write」で発行します。
-# HF_USER_NAME…ユーザー名
-# HF_SPACE_URL…HuggingFaceのSpaceのアドレス
-# 2, デプロイ時の環境保護ルールを適用します。
-# Settingsタブの「Environments」 > 「new Environment」 > Name に「production」で作成します。
-# Deployment protection rulesを設定します。
+# このGitHub Actionsのワークフローは、HuggingFaceのSpace(以下、Space)にデプロイを行うためのものです。
+# 具体的には、GitHubのリポジトリをチェックアウトし、その内容をSpaceにgit pushします。
+# 詳細な手順はHuggingFaceの公式ドキュメントを参照してください: https://huggingface.co/docs/hub/spaces-github-actions
+## ワークフローの設定手順
+# 1, HuggingFaceで「Write」タイプのアクセストークンを生成します。このトークンは認証に使用します。
+#    生成はこちらから: https://huggingface.co/settings/tokens
+# 2, GitHubのリポジトリの設定で、生成したアクセストークンと他の情報を環境変数として設定します。
+# 設定は「Settings」タブの「Secrets and variables」 > 「Actions」 > 「Repository secrets」から行います。
+#    設定する変数は以下の通りです:
+#    HF_TOKEN: HuggingFaceで生成したアクセストークン
+#    HF_USER_NAME: HuggingFaceのユーザー名
+#    HF_SPACE_URL: SpaceのURL
+# 3, デプロイ時の環境保護ルールを適用します。
+#     「Settings」タブの「Environments」 > 「new Environment」 > Name に「production」を入力して新しい環境設定を作成します。
+#     その後、Deployment protection rulesを設定します。
 name: "Deploy"
 on:
+  # mainブランチへのpushをトリガーにします。
   push:
     branches: [ "main" ]
   # Actionsタブからワークフローの手動実行を許可します。
@@ -21,13 +24,14 @@ on:
 jobs:
   sync-to-hub:
     runs-on: ubuntu-latest
-    # productionの設定情報を使用します。
+    # productionの設定情報を使用します。これにより、デプロイ時の環境保護ルールを適用できます。
     environment: production
     steps:
+      # GitHubのリポジトリをチェックアウトします。
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           lfs: true
-
+      # チェックアウトしたコードをSpaceにgit pushします。
       - name: Push to hub
         run: git push https://${{ secrets.HF_USER_NAME }}:${{ secrets.HF_TOKEN }}@${{ secrets.HF_SPACE_URL }} main

.vscode/extensions.json

@@ -1,5 +1,6 @@
 {
   "recommendations": [
-    "ms-python.flake8"
+    "ms-python.flake8",
+    "ms-python.vscode-pylance"
   ]
 }

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // IntelliSense を使用して利用可能な属性を学べます。
+    // 既存の属性の説明をホバーして表示します。
+    // 詳細情報は次を確認してください: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python デバッガー: 引数を含む現在のファイル",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "app.py",
+            "console": "integratedTerminal",
+            "args": "${command:pickArgs}"
+        }
+    ]
+}

.vscode/settings.json

@@ -2,10 +2,13 @@
   "cSpell.words": [
     "asctime",
     "astype",
+    "codeql",
+    "Colab",
     "dtype",
     "fromarray",
     "Gradio",
     "inbrowser",
+    "msecs",
     "ndarray"
   ],
   "python.analysis.typeCheckingMode": "basic",

CONTRIBUTING.md

@@ -1,5 +0,0 @@
-## プルリクエストについて  
-- プルリクエストの派生元ブランチ  
-  main ブランチから派生させてプルリクエストを作成してください。  
-- プルリクエストのライセンス：  
-  プルリクエストを送信することで、あなたの貢献がリポジトリと同じMITライセンスに従うこと、そしてあなたの貢献が将来的にプロジェクトのライセンス変更に含まれる可能性があることに**ご理解とご協力**をお願いします。  

README.md

@@ -7,33 +7,33 @@ colorFrom: yellow
 colorTo: yellow
 pinned: false
 ---
-# SaliencyMap — in Python
-![Python version](https://img.shields.io/badge/python-3.8+-important)
-<a href="https://colab.research.google.com/github/umyuu/SaliencyMapDemo/blob/main/launch_app.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
+# 📖 SaliencyMap — in Python
+![Python version](https://img.shields.io/badge/python-3.9+-important)
+<a href="https://colab.research.google.com/github/umyuu/SaliencyMapDemo/blob/main/scripts/launch_app.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 
-## 概要  
+## 📝 概要  
 画像における注目すべき領域を可視化する「顕著性マップ」を表示するデモアプリです。  
 私は画像処理についてはまだ初心者ですが、この技術に興味があります。  
 本アプリは、opencv-contribパッケージの`cv2.saliency.StaticSaliencySpectralResidual`を関数を実行するラッパーアプリです。  
 
-## 使い方  
+## 🚀 使い方  
 ### a. Google Colabで実行  
-<a href="https://colab.research.google.com/github/umyuu/SaliencyMapDemo/blob/main/launch_app.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>をクリックして、簡単に実行できます。  
+<a href="https://colab.research.google.com/github/umyuu/SaliencyMapDemo/blob/main/scripts/launch_app.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>をクリックして、簡単に実行できます。  
 
 ### b. アプリをダウンロードして実行  
-#### システム要件  
+#### 💻 システム要件  
 - 必要ディスク容量：500MB(Pythonを含みません)  
 - Python のダウンロード:https://www.python.org/downloads/  
 
-#### 導入方法  
+#### 📥 導入方法  
 ##### 1. セットアップ  
-1. [Releases](https://github.com/umyuu/SaliencyMapDemo/releases)ページを開き、一番上の `Assets` 欄にある `Source code (zip)` をダウンロードして展開します。  
+1. [Releases](/releases)ページを開き、一番上の `Assets` 欄にある `Source code (zip)` をダウンロードして展開します。  
 2. `01-installation.bat`ファイルをダブルクリックします。  
 ##### 2. 実行  
 `run.bat`ファイルをダブルクリックします。  
 ブラウザが自動起動し、http://127.0.0.1:9999 にアクセスできます。  
 
-**トラブルシューティング**  
+**🔧 トラブルシューティング**  
 - アプリが起動しない場合  
 	既定のポート番号 (9999) が使用されている可能性があります。  
 	メモ帳で `run.bat` ファイルを開き、以下の行の `9999` を別の数字 (例: 8888) に変更して上書き保存します。  
@@ -44,10 +44,10 @@ pinned: false
 	~~~
 	python app.py --server_port 8888  
 	~~~
-##### 補足事項  
+##### 💡 補足事項  
 - アプリをダウンロードして実行の場合は、画像処理はローカル環境で行われます。画像は外部に送信されません。  
 
-##### アンインストール  
+##### 🗑️ アンインストール  
 以下の手順でアンインストールできます。  
 1. アプリのフォルダを丸ごと削除します。  
 2. アプリで処理した画像は一時フォルダに残ります。不要な場合は削除してください。  
@@ -57,5 +57,8 @@ pinned: false
 	C:\Users\%USERNAME%\AppData\Local\Temp\gradio
 	~~~
 
-## Source code License.  
+## 🤝 コントリビューターガイドライン  
+[CONTRIBUTING](docs/CONTRIBUTING.md)  
+
+## 📜 Source code License.  
 [MIT License](LICENSE)  

app.py

@@ -3,18 +3,26 @@
     SaliencyMapDemo
 """
 from argparse import ArgumentParser, BooleanOptionalAction
+#from datetime import datetime
+import sys
+from typing import Literal
+
+import gradio as gr
+import numpy as np
 
 from src import PROGRAM_NAME, get_package_version
-from src.myapp import run_app
+from src.reporter import log
+from src.saliency import SaliencyMap, convert_colormap
+from src.utils import Stopwatch
 
 __version__ = get_package_version()
+log.info("#アプリ起動中")
+watch = Stopwatch.start_new()
 
 
-def main():
+def parse_args():
     """
-        エントリーポイント
-        1, コマンドライン引数の解析を行います
-        2, アプリを起動します。
+    コマンドライン引数の解析を行います
     """
     parser = ArgumentParser(prog=PROGRAM_NAME, description=PROGRAM_NAME)
     parser.add_argument('--inbrowser',
@@ -25,11 +33,144 @@ def main():
                         type=int, default=7860, help="Gradio server port")
     parser.add_argument('--max_file_size',
                         type=str, default="20MB", help="Gradio max file size")
-    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
+    parser.add_argument('--version', 
+                        action='version', version=f'%(prog)s {__version__}')
+
+    return parser.parse_args()
+
+
+def jet_tab_selected(image: np.ndarray):
+    """
+    JETタブを選択時
+    """
+    sw = Stopwatch.start_new()
+    log.info(f"#jet_tab_selected({sw.elapsed:.3f}s)")
+    saliency = SaliencyMap("SpectralResidual")
+    success, saliency_map = saliency.compute(image)
+    if not success:
+        return image  # エラーが発生した場合は入力画像を返します。
+    retval = convert_colormap(image, saliency_map, "jet")
+    log.info(f"#jet_tab_selected({sw.elapsed:.3f}s)")
+    return retval
+
+
+def hot_tab_selected(image: np.ndarray):
+    """
+    HOTタブを選択時
+    """
+    sw = Stopwatch.start_new()
+    log.info(f"#hot_tab_selected({sw.elapsed:.3f}s)")
+    saliency = SaliencyMap("SpectralResidual")
+    success, saliency_map = saliency.compute(image)
+    if not success:
+        return image  # エラーが発生した場合は入力画像を返します。
+    retval = convert_colormap(image, saliency_map, "turbo")
+    log.info(f"#hot_tab_selected({sw.elapsed:.3f}s)")
+    return retval
+
+
+def submit_clicked(image: np.ndarray, algorithm: Literal["SpectralResidual", "FineGrained"]):
+    """
+    入力画像を元に顕著マップを計算します。
+
+    Parameters:
+        image: 入力画像
+        str: 顕著性マップのアルゴリズム
+    Returns:
+        np.ndarray: JET画像
+        np.ndarray: HOT画像
+    """
+    sw = Stopwatch.start_new()
+    log.info(f"#submit_clicked({sw.elapsed:.3f}s)")
+    #
+    saliency = SaliencyMap(algorithm)
+    log.debug(f"#SaliencyMap({sw.elapsed:.3f}s)")
+    success, saliency_map = saliency.compute(image)
+    log.debug(f"#compute({sw.elapsed:.3f}s)")
+
+    if not success:
+        return image, image  # エラーが発生した場合は入力画像を返します。
+
+    log.debug(f"#jet({sw.elapsed:.3f}s)")
+    jet = convert_colormap(image, saliency_map, "jet")
+    # jet = None
+    log.debug(f"#hot({sw.elapsed:.3f}s)")
+    hot = convert_colormap(image, saliency_map, "hot")
+    saliency = None
+    log.info(f"#submit_clicked({sw.elapsed:.3f}s)")
+    return jet, hot
+
+
+args = parse_args()
+"""
+アプリの画面を作成し、Gradioサービスを起動します。
+    analytics_enabled=False
+    https://github.com/gradio-app/gradio/issues/4226
+    ホットリロード対応として、topレベルのインデントに。
+    https://www.gradio.app/guides/developing-faster-with-reload-mode
+"""
+with gr.Blocks(
+    analytics_enabled=False,
+    title=f"{PROGRAM_NAME} {get_package_version()}",
+    head="""
+    <meta name="format-detection" content="telephone=no">
+    <meta name="robots" content="noindex, nofollow, noarchive">
+    <meta name="referrer" content="no-referrer" />
+    """
+) as demo:
+    gr.Markdown("""
+        # Saliency Map demo.
+        """)
+    with gr.Accordion("取り扱い説明書", open=False):
+        gr.Markdown("""
+            1. inputタブで画像を選択します。
+            2. Submitボタンを押します。
+            3. 結果は、JETタブとHOTタブに表示します。  
+        """)
+    algorithm_type = gr.Radio(
+        ["SpectralResidual", "FineGrained"],
+        label="Saliency",
+        value="SpectralResidual",
+        interactive=True
+    )
+
+    submit_button = gr.Button("submit", variant="primary")
+
+    with gr.Row():
+        with gr.Tab("input", id="input"):
+            image_input = gr.Image(sources=["upload", "clipboard"], interactive=True)
+        with gr.Tab("overlay(JET)"):
+            image_overlay_jet = gr.Image(interactive=False)
+            # tab_jet.select(jet_tab_selected,
+            # inputs=[image_input],
+            # outputs=image_overlay_jet)
+        with gr.Tab("overlay(HOT)"):
+            image_overlay_hot = gr.Image(interactive=False)
+            # tab_hot.select(hot_tab_selected,
+            # inputs=[image_input],
+            # outputs=image_overlay_hot, api_name=False)
+    #
+    submit_button.click(
+        submit_clicked,
+        inputs=[image_input, algorithm_type],
+        outputs=[image_overlay_jet, image_overlay_hot]
+    )
+    gr.Markdown(f"""
+        Python {sys.version}  
+        App {get_package_version()}  
+    """)
+
+    demo.queue(default_concurrency_limit=1)
 
-    args = parser.parse_args()
-    run_app(args)
+    log.info(f"#アプリ起動完了({watch.elapsed:.3f}s)アプリを終了するにはCtrl+Cキーを入力してください。")
 
 
 if __name__ == "__main__":
-    main()
+    # アプリを起動します。
+    # https://www.gradio.app/docs/gradio/blocks#blocks-launch
+    demo.launch(
+        inbrowser=args.inbrowser,
+        share=args.share,
+        server_port=args.server_port,
+        max_file_size=args.max_file_size,
+    )

config.json

@@ -26,7 +26,7 @@
     "handlers": {
         "console1": {
             "class": "logging.StreamHandler",
-            "level": "DEBUG",
+            "level": "INFO",
             "formatter": "jst"
         }
     },

docs/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# 📖 Contributing Guide  
+## 🎉 ようこそ！  
+このプロジェクトへの関心と貢献に感謝します！あなたの貢献は、このプロジェクトを改善し、コミュニティを成長させるのに大いに役立ちます。このガイドは、プロジェクトへの貢献をスムーズに進めるためのものです。  
+
+## 📚 概要
+このガイドでは、リポジトリの構成、プルリクエストの作成方法、バグ報告の方法、およびコーディング規約について説明します。これらのガイドラインを理解し、遵守することで、あなたの貢献がプロジェクトにとって最大の価値を持つことができます。  
+
+## 🏗️ リポジトリ構成  
+- 📂`/src`: Pythonソースコード。  
+     主要な機能のコードが含まれています。  
+- 🧪`/test`: Pythonの単体テストコード。  
+    各機能の正確さを確認するためのテストスクリプトが含まれています。  
+- 📜`/scripts`: 実行用スクリプト。  
+    Jupyter NotebookとGradioの自動再読み込みスクリプトが含まれており、これらはアプリの実行とデバッグを容易にします。  
+- 🎨`/assets`: サンプル画像。  
+    視覚的な要素を提供します。  
+- 📚`/docs`: ドキュメンテーション。  
+    - `./CONTRIBUTING.md`： これは現在ご覧になっているドキュメントで、プロジェクトへの貢献方法について詳しく説明しています。新しいコントリビューターはここから始めることをお勧めします。  
+    - `./ThirdPartyNotices.txt`：参考情報としてこのプロジェクトで使用している外部ライブラリのライセンス情報が記載されています。  
+- 📚`/.github`: GitHubの設定ファイルが格納されています。  
+  - `/.github\ISSUE_TEMPLATE`: issueを作成する際のテンプレートが含まれています。これらのテンプレートは、issueを作成する際のフォーマットを提供し、必要な情報を整理するのに役立ちます。  
+  - `/.github\workflows`: GitHub Actionsのワークフロー設定。  
+    - `./codeql.yml`：コードのセキュリティ問題を自動的に検出します。  
+    - `./deploy.yml`：プロジェクトのデプロイを自動化します。  
+    - `./python-app.yml`：アプリケーションのコンパイルとflake8のコードチェックとテストコードを実行します。  
+- 📚`/.vscode`: vscodeの設定  
+    アプリケーションの開発に適したVSCodeの設定情報が含まれています。これには、推奨される拡張機能、コードフォーマットの設定などが含まれています。  
+
+## 🔀 プルリクエストについて  
+- プルリクエストの派生元ブランチ  
+  main ブランチから派生させてプルリクエストを作成してください。  
+- プルリクエストのライセンス：  
+  プルリクエストを送信することで、あなたの貢献がリポジトリと同じMITライセンスに従うこと、そしてあなたの貢献が将来的にプロジェクトのライセンス変更に含まれる可能性があることに**ご理解とご協力**をお願いします。  
+
+## 🐛 バグ報告  
+バグを見つけた場合は、まず[既存のissue](../issues)を確認してください。  
+同じバグについてのissueが存在しない場合は、[新しいバグ報告](../issues/new?assignees=&labels=bug&projects=&template=10-problem.yaml)を作成してください。  
+
+## 📝 コーディング規約  
+- コードスタイル： このプロジェクトではPEP8に準拠し、コードチェックツールとしてflake8を採用しています。VSCodeを使用し開発すると拡張機能がレコメンドされます。拡張機能を導入して確認してください。  
+- 変数名： 変数名は明確で意味のある名前を使用してください。ローカル変数以外では一文字の変数名は避け、名前から変数の目的が理解できるようにしてください。  
+- ドキュメンテーション： 公開されるすべての関数やクラス、メソッドにはDocstringを追加してください。これにより、他の開発者がコードの目的と動作を理解しやすくなります。  

launch_app.ipynb → scripts/launch_app.ipynb

@@ -1,33 +1,22 @@
 {
-  "nbformat": 4,
-  "nbformat_minor": 0,
-  "metadata": {
-    "colab": {
-      "provenance": []
-    },
-    "kernelspec": {
-      "name": "python3",
-      "display_name": "Python 3"
-    },
-    "language_info": {
-      "name": "python"
-    }
-  },
   "cells": [
     {
       "cell_type": "markdown",
-      "source": [
-        "# アプリのインストール"
-      ],
       "metadata": {
         "id": "QBBnZWaddxv4"
-      }
+      },
+      "source": [
+        "### アプリの起動  \n",
+        "アプリを起動するには、以下の手順を実行してください：  \n",
+        "1. 画面上部のメニューバーの「ランタイム」をクリックしてください。  \n",
+        "2. ドロップダウンメニューが表示されます、「すべてのセルを実行」をクリックしてください。または、キーボードショートカットの「Ctrl+F9」を使用することもできます。  \n",
+        "\n",
+        "これにより、ノートブック内のすべてのセルが順番に実行され、アプリが起動します。  "
+      ]
     },
     {
       "cell_type": "code",
-      "source": [
-        "%cd /content"
-      ],
+      "execution_count": 1,
       "metadata": {
         "colab": {
           "base_uri": "https://localhost:8080/"
@@ -35,15 +24,17 @@
         "id": "7a5Rf_Qee3N1",
         "outputId": "c3890145-930e-4889-e57e-22321250461f"
       },
-      "execution_count": 1,
       "outputs": [
         {
-          "output_type": "stream",
           "name": "stdout",
+          "output_type": "stream",
           "text": [
             "/content\n"
           ]
         }
+      ],
+      "source": [
+        "%cd /content"
       ]
     },
     {
@@ -58,8 +49,8 @@
       },
       "outputs": [
         {
-          "output_type": "stream",
           "name": "stdout",
+          "output_type": "stream",
           "text": [
             "Cloning into 'SaliencyMapDemo'...\n",
             "remote: Enumerating objects: 84, done.\u001b[K\n",
@@ -77,9 +68,7 @@
     },
     {
       "cell_type": "code",
-      "source": [
-        "%cd SaliencyMapDemo"
-      ],
+      "execution_count": 3,
       "metadata": {
         "colab": {
           "base_uri": "https://localhost:8080/"
@@ -87,15 +76,17 @@
         "id": "H0HI3iKRenJB",
         "outputId": "770d3024-43a2-4282-f59d-bc496cba9cf6"
       },
-      "execution_count": 3,
       "outputs": [
         {
-          "output_type": "stream",
           "name": "stdout",
+          "output_type": "stream",
           "text": [
             "/content/SaliencyMapDemo\n"
           ]
         }
+      ],
+      "source": [
+        "%cd SaliencyMapDemo"
       ]
     },
     {
@@ -110,8 +101,8 @@
       },
       "outputs": [
         {
-          "output_type": "stream",
           "name": "stdout",
+          "output_type": "stream",
           "text": [
             "Collecting gradio==4.28.3 (from -r requirements.txt (line 1))\n",
             "  Downloading gradio-4.28.3-py3-none-any.whl (12.2 MB)\n",
@@ -269,18 +260,21 @@
     },
     {
       "cell_type": "markdown",
-      "source": [
-        "# 実行"
-      ],
       "metadata": {
         "id": "LUcp4xt2fJU9"
-      }
+      },
+      "source": [
+        "### 🚀 実行  \n",
+        "1, 「Running on public URL:」の横のリンクをクリックします。  \n",
+        "2, リンクをクリックすると、新しいブラウザのタブが開きアプリを自由に操作できます。  \n",
+        "### アプリの停止  \n",
+        "1,「!python app.py --share」の行の左側にある■ボタン（停止ボタン）をクリックします。  \n",
+        "2, アプリが停止します。  "
+      ]
     },
     {
       "cell_type": "code",
-      "source": [
-        "!python app.py --share"
-      ],
+      "execution_count": 5,
       "metadata": {
         "colab": {
           "base_uri": "https://localhost:8080/"
@@ -288,11 +282,10 @@
         "id": "J3kKmi6Rd95n",
         "outputId": "d06135be-5c00-4b68-abba-6606f415ccce"
       },
-      "execution_count": 5,
       "outputs": [
         {
-          "output_type": "stream",
           "name": "stdout",
+          "output_type": "stream",
           "text": [
             "2024-05-11 12:13:31,862#アプリ起動中\n",
             "2024-05-11 12:13:36,775#アプリ起動完了(4.912s)\n",
@@ -304,7 +297,24 @@
             "Killing tunnel 127.0.0.1:9999 <> https://90361c40461e1540a1.gradio.live\n"
           ]
         }
+      ],
+      "source": [
+        "!python app.py --share"
       ]
     }
-  ]
-}
+  ],
+  "metadata": {
+    "colab": {
+      "provenance": []
+    },
+    "kernelspec": {
+      "display_name": "Python 3",
+      "name": "python3"
+    },
+    "language_info": {
+      "name": "python"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

scripts/run_hot_reload.bat

@@ -0,0 +1,9 @@
+REM Gradioのオートリロード用のスクリプトです。
+@echo on
+
+cd %~dp0
+cd ..
+call venv\Scripts\activate
+gradio app.py
+
+TIMEOUT /T 10

src/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """src Module"""
 from datetime import datetime
-import logging.config
+import logging
 import re
 from zoneinfo import ZoneInfo
 
@@ -35,7 +35,7 @@ class LocalTimeFormatter(logging.Formatter):
 
         t = dt.strftime(re.sub(self.pattern, "", datefmt))
         match = re.search(self.pattern, datefmt)
-        if not match:
+        if match is None:
             return t
 
         groups = match.groups()

src/myapp.py

@@ -1,153 +0,0 @@
-# -*- coding: utf-8 -*-
-"""myapp Widget"""
-import argparse
-#from datetime import datetime
-import sys
-from typing import Literal
-
-import gradio as gr
-import numpy as np
-
-from . import PROGRAM_NAME
-from src.reporter import log
-from src.saliency import SaliencyMap, convert_colormap
-from src.utils import Stopwatch, get_package_version
-
-log.info("#アプリ起動中")
-watch = Stopwatch.start_new()
-
-
-def jet_tab_selected(image: np.ndarray):
-    """
-    JETタブを選択時
-    """
-    #print(f"{datetime.now()}#jet")
-    saliency = SaliencyMap("SpectralResidual")
-    success, saliency_map = saliency.compute(image)
-    if not success:
-        return image  # エラーが発生した場合は入力画像を返します。
-    retval = convert_colormap(image, saliency_map, "jet")
-    #print(f"{datetime.now()}#jet")
-    return retval
-
-
-def hot_tab_selected(image: np.ndarray):
-    """
-    HOTタブを選択時
-    """
-    #print(f"{datetime.now()}#hot")
-    saliency = SaliencyMap("SpectralResidual")
-    success, saliency_map = saliency.compute(image)
-    if not success:
-        return image  # エラーが発生した場合は入力画像を返します。
-    retval = convert_colormap(image, saliency_map, "turbo")
-    #print(f"{datetime.now()}#hot")
-    return retval
-
-
-def submit_clicked(image: np.ndarray, algorithm: Literal["SpectralResidual", "FineGrained"]):
-    """
-    入力画像を元に顕著マップを計算します。
-
-    Parameters:
-        image: 入力画像
-        str: 顕著性マップのアルゴリズム
-    Returns:
-        np.ndarray: JET画像
-        np.ndarray: HOT画像
-    """
-    log.info("#submit_Clicked")
-    watch = Stopwatch.start_new()
-    #
-    saliency = SaliencyMap(algorithm)
-    success, saliency_map = saliency.compute(image)
-    #log.info("#SaliencyMap compute()")
-
-    if not success:
-        return image, image  # エラーが発生した場合は入力画像を返します。
-
-    #log.info("#jet")
-    jet = convert_colormap(image, saliency_map, "jet")
-    # jet = None
-    #log.info("#hot")
-    hot = convert_colormap(image, saliency_map, "hot")
-    saliency = None
-    log.info(f"#submit_Clicked End{watch.stop():.3f}")
-    return jet, hot
-
-
-def run_app(args: argparse.Namespace) -> None:
-    """
-    アプリの画面を作成し、Gradioサービスを起動します。
-
-    Parameters:
-        args: コマンドライン引数
-        watch: 起動したスタート時間
-    """
-    # analytics_enabled=False
-    # https://github.com/gradio-app/gradio/issues/4226
-    with gr.Blocks(
-        analytics_enabled=False,
-        title=f"{PROGRAM_NAME} {get_package_version()}",
-        head="""
-        <meta name="format-detection" content="telephone=no">
-        <meta name="robots" content="noindex, nofollow, noarchive">
-        <meta name="referrer" content="no-referrer" />
-        """
-    ) as demo:
-
-        gr.Markdown("""
-            # Saliency Map demo.
-            """)
-        with gr.Accordion("取り扱い説明書", open=False):
-            gr.Markdown("""
-                1. inputタブで画像を選択します。
-                2. Submitボタンを押します。
-                3. 結果は、JETタブとHOTタブに表示します。  
-            """)
-        algorithm_type = gr.Radio(
-            ["SpectralResidual", "FineGrained"],
-            label="Saliency",
-            value="SpectralResidual",
-            interactive=True
-        )
-
-        submit_button = gr.Button("submit", variant="primary")
-
-        with gr.Row():
-            with gr.Tab("input", id="input"):
-                image_input = gr.Image(sources=["upload", "clipboard"],
-                                       interactive=True)
-            with gr.Tab("overlay(JET)"):
-                image_overlay_jet = gr.Image(interactive=False)
-                # tab_jet.select(jet_tab_selected,
-                # inputs=[image_input],
-                # outputs=image_overlay_jet)
-            with gr.Tab("overlay(HOT)"):
-                image_overlay_hot = gr.Image(interactive=False)
-                # tab_hot.select(hot_tab_selected,
-                # inputs=[image_input],
-                # outputs=image_overlay_hot, api_name=False)
-        #
-        submit_button.click(
-            submit_clicked,
-            inputs=[image_input, algorithm_type],
-            outputs=[image_overlay_jet,
-                     image_overlay_hot]
-        )
-
-        gr.Markdown(f"""
-            Python {sys.version}  
-            App {get_package_version()}  
-        """)
-
-        demo.queue(default_concurrency_limit=5)
-
-        log.info(f"#アプリ起動完了({watch.stop():.3f}s)")
-        # https://www.gradio.app/docs/gradio/blocks#blocks-launch
-        demo.launch(
-            inbrowser=args.inbrowser,
-            share=args.share,
-            server_port=args.server_port,
-            max_file_size=args.max_file_size,
-        )

src/reporter.py

@@ -11,6 +11,7 @@
 import json
 from logging import Logger, getLogger
 import logging.config
+
 from typing import Optional
 
 from . import PROGRAM_NAME

src/saliency.py

@@ -10,7 +10,7 @@ class SaliencyMap:
     """
     顕著性マップを計算するクラス。
     Example:
-        from lib.saliency import SaliencyMap
+        from src.saliency import SaliencyMap
 
         saliency = SaliencyMap("SpectralResidual")
         success, saliencyMap = saliency.compute(image)

src/utils.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 """ユーティリティ"""
+from dataclasses import dataclass
 import time
 
 
@@ -7,37 +8,49 @@ def get_package_version() -> str:
     """
     バージョン情報
     """
-    return '0.0.6'
+    return '0.0.7'
 
 
+@dataclass
 class Stopwatch:
     """
-    Stopwatch 経過時間を計測するためのクラス。
+    経過時間を計測するためのクラス。
     Example:
         from src.utils import Stopwatch
 
         watch = Stopwatch.start_new()
-        # 計測する処理
-        print(f"{watch.stop():.3f}")
+        ### 計測する処理
+        print(f"{watch.elapsed:.3f}")
     """
-
-    def __init__(self):
-        self._start_time = 0
-        self._elapsed = 0
+    _start_time: float = 0
+    _elapsed: float = 0
+    _is_running: bool = False
 
     @property
-    def elapsed(self):
+    def elapsed(self) -> float:
         """
-        経過時間
+        経過時間を取得します。
         """
+        if self._is_running:
+            end_time = time.perf_counter()
+            self._elapsed = end_time - self._start_time
+
         return self._elapsed
 
+    @property
+    def is_running(self) -> bool:
+        """
+        実行中かどうかを取得します。
+        """
+        return self._is_running
+
     def start(self) -> None:
         """
         計測を開始します。
         """
         self._start_time = time.perf_counter()
         self._elapsed = 0
+        self._is_running = True
 
     @classmethod
     def start_new(cls):
@@ -48,10 +61,12 @@ class Stopwatch:
         stopwatch.start()
         return stopwatch
 
-    def stop(self):
+    def stop(self) -> float:
         """
         計測を終了します。
         """
-        end_time = time.perf_counter()
-        self._elapsed = end_time - self._start_time
+        if self._is_running:
+            end_time = time.perf_counter()
+            self._elapsed = end_time - self._start_time
+            self._is_running = False
         return self._elapsed