From 4b64ffcb4c6accfad7e1e5a25c6a6d1c8de56663 Mon Sep 17 00:00:00 2001 From: data-science <> Date: Thu, 4 Dec 2025 02:29:19 +0900 Subject: [PATCH] Initial commit --- .github/workflows/pytest.yml | 68 ++++++++++++++ .gitignore | 171 +++++++++++++++++++++++++++++++++++ .python-version | 1 + .vscode/extensions.json | 6 ++ .vscode/settings.json | 7 ++ AGENT.md | 44 +++++++++ LICENSE | 9 ++ README.md | 53 +++++++++++ examples/example.py | 17 ++++ pyproject.toml | 7 ++ readme/python_init.md | 54 +++++++++++ requirements-dev.txt | 7 ++ requirements.txt | 0 ruff.toml | 6 ++ src/main.py | 12 +++ src/utils/custom_logger.py | 57 ++++++++++++ src/utils/singleton.py | 22 +++++ tests/conftest.py | 6 ++ tests/test_main.py | 27 ++++++ 19 files changed, 574 insertions(+) create mode 100644 .github/workflows/pytest.yml create mode 100644 .gitignore create mode 100644 .python-version create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json create mode 100644 AGENT.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 examples/example.py create mode 100644 pyproject.toml create mode 100644 readme/python_init.md create mode 100644 requirements-dev.txt create mode 100644 requirements.txt create mode 100644 ruff.toml create mode 100644 src/main.py create mode 100644 src/utils/custom_logger.py create mode 100644 src/utils/singleton.py create mode 100644 tests/conftest.py create mode 100644 tests/test_main.py diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml new file mode 100644 index 0000000..a3ad82c --- /dev/null +++ b/.github/workflows/pytest.yml @@ -0,0 +1,68 @@ +name: Python Test + +on: + workflow_dispatch: + push: + branches: + - main + - develop + paths: + - 'src/**' + - 'tests/**' + - '.github/workflows/pytest.yml' + - 'requirements.txt' + - 'requirements-dev.txt' +jobs: + python-test: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.12" + + - name: Install dependencies + id: installDependencies + run: | + pip install -r requirements.txt + pip install -r requirements-dev.txt + + - name: Run Python Test + id: runPyTest + run: | + pytest --junitxml=pytest.xml --cov-report term-missing --cov=src tests/ | tee pytest-coverage.txt + + - name: Coverage Report + id: CoverageReport + run: | + coverage-badge -o coverage.svg + python - < README.md + echo "" >> README.md + echo "![test](coverage.svg)" >> README.md + echo "" >> README.md + cat tests/table.md >> README.md + cat README.md + + - name: Check files before upload + run: ls -l README.md coverage.svg + + - name: Upload artifact + uses: actions/upload-artifact@v3 + with: + name: ret-artifact + path: | + README.md + coverage.svg + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c324259 --- /dev/null +++ b/.gitignore @@ -0,0 +1,171 @@ +# ---> Python +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +.ruff_cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..e4fba21 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.12 diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..2c9db07 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "charliermarsh.ruff", + "littlefoxteam.vscode-python-test-adapter" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9b38853 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,7 @@ +{ + "python.testing.pytestArgs": [ + "tests" + ], + "python.testing.unittestEnabled": false, + "python.testing.pytestEnabled": true +} \ No newline at end of file diff --git a/AGENT.md b/AGENT.md new file mode 100644 index 0000000..d4d1000 --- /dev/null +++ b/AGENT.md @@ -0,0 +1,44 @@ +# AGENT ガイドライン + +このドキュメントは、本リポジトリで動作する **AIエージェント（Cursor, ChatGPT など）向けの指示書**です。 +コード提案・自動修正・ドキュメント生成を行う際は、必ずこの内容に従ってください。 + +--- + +## 1. プロジェクト概要 + +- プロジェクト名: `TODO: プロジェクト名を書いてください` +- 主な用途: `TODO: このプロジェクトの目的を1〜3行で書く` +- 想定する利用者: + - `例: 自分用のテンプレ / 小規模API / バッチスクリプト など` + + +## 2. 技術スタック & 環境 + +- 言語: Python 3.x（`TODO: 具体バージョンを書く: 例: 3.12`） +- 仮想環境: `.venv`（`python -m venv .venv`） +- パッケージ管理: `pip`（`requirements.txt` を利用） +- Linter / Formatter: + - **Ruff**（Lint & Format 両方に使用） +- テスト: `pytest`（予定または導入済みなら） + +### 環境のセットアップ + +```bash +python -m venv .venv +source .venv/bin/activate # Windows: .venv\Scripts\activate +pip install -r requirements.txt +``` + + +### フォルダ構成 + +. +├── src/ # メインのアプリケーションコード +├── tests/ # テストコード +├── requirements.txt +├── ruff.toml +└── AGENT.md # このファイル + +エージェントは 原則として src/ 以下にコードを追加・修正してください。 +設定ファイルやCI/CDは、既存の構成に従ってください。 \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..419c22a --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2025 templates + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..057d74a --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# python-template + +Python Template + +## Tool + +### Test + +テスト用のライブラリをインストールしてください。 + +```sh +pip install -r requirements-dev.txt +``` + +テストを実行する + +```sh +pytest tests/ +# ログを出力する場合 +# pytest -s tests/ +``` + +### Lint + + +```sh +pip install -r requirements-dev.txt +``` + +**lintを実行する方法** + +```sh +ruff check . +``` + +例えば使われていない変数が存在する場合はなどは以下のように表示される + +```log +F841 Local variable `x` is assigned to but never used + --> src/main.py:7:5 + | +6 | def func_wrong(): +7 | x = 1 + | ^ + | +help: Remove assignment to unused variable `x` +``` + +**自動生成も実行する場合** + +```sh +ruff check . --fix +``` \ No newline at end of file diff --git a/examples/example.py b/examples/example.py new file mode 100644 index 0000000..0976ae4 --- /dev/null +++ b/examples/example.py @@ -0,0 +1,17 @@ +import sys +import os + +sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "src"))) + + +from utils.custom_logger import get_logger + +logger = get_logger(__name__) + + +def example(): + logger.info("Application started") + print("Hello, World!") + + +example() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..748c0fa --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,7 @@ +[project] +name = "プロジェクト名を設定してください" +version = "0.1.0" +description = "プロジェクトの説明" +readme = "README.md" +requires-python = ">=3.12" +dependencies = [] diff --git a/readme/python_init.md b/readme/python_init.md new file mode 100644 index 0000000..243aa6b --- /dev/null +++ b/readme/python_init.md @@ -0,0 +1,54 @@ +# Python Project + +## 仮想環境を構築する + +### venvで構築する + +```sh +python3 -m venv .venv +# Linux +source .venv/bin/activate +# Windows +# .venv/Scripts/activate + +pip install -r requirements.txt +# For Develop(Tests,Docs) +pip install -r requirements-dev.txt +``` + +### uvで構築する + +プロジェクトを生成する場合 + +```bash +uv init +# --pythonまたは-pにバージョンを指定できます +# uv init -p 3.10とすると">=3.10,<3.11"となる +``` + + +```sh +uv sync +``` + +## Linter + +### ruffライブラリの場合 + +RuffFlake8 のルールを多数サポートしています。 +ruff.tomlで設定できます + + +```toml +select = ["E", "W"] +line-length = 88 +``` + + +| 分類 | コード | 内容 | +| ---- | ------ | ----------------------------------- | +| W | W291 | 末尾スペース（trailing whitespace） | +| | W293 | ファイル末尾の空行の空白 | +| E | E303 | 空行が多すぎる | +| | E501 | 行が長すぎる | + diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..6fe2354 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,7 @@ +# testing tools +pytest +pytest-cov +coverage-badge + +# Linting tool +ruff diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..d2b3aac --- /dev/null +++ b/ruff.toml @@ -0,0 +1,6 @@ +line-length = 88 + +# 末尾スペース・空行まわりをチェックするのは E と W系のルール +[lint] +select = ["E", "W"] +ignore = [] \ No newline at end of file diff --git a/src/main.py b/src/main.py new file mode 100644 index 0000000..790d938 --- /dev/null +++ b/src/main.py @@ -0,0 +1,12 @@ +from utils.custom_logger import get_logger + +logger = get_logger(__name__) + + +def main(): + logger.info("Application started") + print("Hello, World!") + + +if __name__ == "__main__": + main() diff --git a/src/utils/custom_logger.py b/src/utils/custom_logger.py new file mode 100644 index 0000000..9a25dca --- /dev/null +++ b/src/utils/custom_logger.py @@ -0,0 +1,57 @@ +import os +import logging +import functools +from .singleton import Singleton + + +class CustomLogger(Singleton): + """ + Singleton logger class that initializes a logger with a specified name and log file. + It provides a method to log entry and exit of functions. + + """ + + def __init__(self, name="main", log_file=None, level=logging.INFO): + if hasattr(self, "_initialized") and self._initialized: + return # すでに初期化済みなら何もしない + # self.logger.setLevel(level) + + if os.getenv("ENV", "local"): + self.logger = logging.getLogger(name) + self.logger.setLevel(level) + self.logger.propagate = False + + formatter = logging.Formatter( + "%(asctime)s %(levelname)s [%(filename)s:%(lineno)3d]: %(message)s" + ) + + # Console handler + ch = logging.StreamHandler() + ch.setFormatter(formatter) + self.logger.addHandler(ch) + + # File handler + if log_file: + fh = logging.FileHandler(log_file, encoding="utf-8") + fh.setFormatter(formatter) + self.logger.addHandler(fh) + + self._initialized = True + + def get_logger(self): + return self.logger + + def log_entry_exit(self, func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + self.logger.info(f"Enter: {func.__qualname__}") + result = func(*args, **kwargs) + self.logger.info(f"Exit: {func.__qualname__}") + return result + + return wrapper + + +def get_logger(name="main", log_file=None, level=logging.INFO): + custom_logger = CustomLogger(name, log_file, level) + return custom_logger.get_logger() diff --git a/src/utils/singleton.py b/src/utils/singleton.py new file mode 100644 index 0000000..8ac3278 --- /dev/null +++ b/src/utils/singleton.py @@ -0,0 +1,22 @@ +"""Singleton pattern implementation in Python. +This implementation is thread-safe and +ensures that only one instance of the class is created. + +Singleton が提供するのは「同じインスタンスを返す仕組み」 +* __init__() は毎回呼ばれる(多くの人が意図しない動作) +* __init__の2回目は_initialized というフラグは 使う側で管理する必要がある。 +""" + +import threading + + +class Singleton(object): + _instances = {} + _lock = threading.Lock() + + def __new__(cls, *args, **kwargs): + if cls not in cls._instances: + with cls._lock: + if cls not in cls._instances: # ダブルチェック + cls._instances[cls] = super(Singleton, cls).__new__(cls) + return cls._instances[cls] diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..63f0695 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,6 @@ +import sys +from pathlib import Path + +# srcディレクトリをパスに追加 +src_path = Path(__file__).parent.parent / "src" +sys.path.insert(0, str(src_path)) diff --git a/tests/test_main.py b/tests/test_main.py new file mode 100644 index 0000000..be37277 --- /dev/null +++ b/tests/test_main.py @@ -0,0 +1,27 @@ +import pytest +from utils.custom_logger import get_logger + +from main import main + + +def test_main(capsys): + """mainが正しく実行されることを確認""" + main() + captured = capsys.readouterr() + assert "Hello, World!" in captured.out + + +def test_main_no_exception(): + """mainが例外を発生させないことを確認""" + try: + main() + except Exception as e: + pytest.fail(f"main() raised an exception: {e}") + + +def test_logger_initialization(): + """ロガーが正しく初期化されることを確認""" + logger = get_logger() + logger.info("This is a test log message.") + assert logger is not None + assert logger.name == "main"