Fastmcp Proper

🚀 Python ベストプラクティスガイド

このガイドは、Python プロジェクトの開発におけるベストプラクティスを提供します。これにより、コードの品質向上や開発効率化を実現できます。

🚀 クイックスタート

プロジェクトの初期化

コードの記述を開始する前に、新しい Python プロジェクトを初期化するには、以下のコマンドを実行してください。

python -m venv venv && source venv/bin/activate
pip install --upgrade pip setuptools wheel

これにより、仮想環境が作成され、必要なビルドツールがインストールされます。

✨ 主な機能

コードスタイルガイド

基本原則

1. PEP8 標準に従ってください。
2. コードの可読性と簡潔性を確保してください。
3. from module import * 文の使用を避けてください。

コード例

# 正しい例：
import os

def greet(name: str) -> str:
    return f"Hello, {name}!"

if __name__ == "__main__":
    name = input("あなたの名前を入力してください：")
    print(greet(name))

プロジェクト構造

推奨されるプロジェクトディレクトリ構造は次の通りです。

project/
├── src/
│   ├── __init__.py
│   └── main.py
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── setup.py
└── pyproject.toml

テストガイド

単体テスト

unittest フレームワークを使用して単体テストを行います。tests ディレクトリを作成し、その中にテストケースを記述します。

import unittest
from src.main import greet

class TestGreet(unittest.TestCase):
    def test_greet_with_name(self):
        self.assertEqual(greet("Alice"), "Hello, Alice!")

if __name__ == "__main__":
    unittest.main()

テストカバレッジ

coverage ツールを使用してテストカバレッジを測定します。

coverage run -m unittest tests/
coverage report

ドキュメント作成

Sphinx を使用したドキュメント作成

1. Sphinx と関連ツールをインストールします。

pip install sphinx setuptools-sphinx

2. プロジェクトのルートディレクトリでドキュメントを作成します。

cd project
sphinx-apidoc -o docs/ src/

3. docs/index.html を開いて生成されたドキュメントを確認します。

依存関係管理

requirements ファイルの使用

プロジェクトのルートディレクトリに requirements.txt ファイルを作成し、すべての依存関係をリストアップします。

setuptools>=60.0.0
wheel>=0.37.1

パッケージのビルドと公開

環境の準備

以下のツールがインストールされていることを確認してください。

pip install build twine

パッケージング手順

1. ソース配布物と wheel パッケージを作成します。

python -m build

2. 生成されたファイルが dist/ ディレクトリにあることを確認します。

TestPyPI と PyPI への公開

Twine を使用したアップロード

1. PyPI の認証情報を設定し、~/.pypirc ファイルを編集します。

[distutils]
index-servers = pypi testpypi

[pypi]
username = your_username
password = your_password

[testpypi]
username = your_test_username
password = your_test_password

2. TestPyPI にアップロードします。

twine upload --repository testpypi dist/*

3. PyPI にアップロードします。

twine upload dist/*

GitHub Actions を使用した自動公開

GitHub Actions ワークフローファイル .github/workflows/publish.yml を作成します。

name: 发布到 PyPI

on:
  release:
    types: [created]

jobs:
  部署:
    runs-on: ubuntu-latest
    steps:
    - name: 检出代码库
      uses: actions/checkout@v2
      
    - name: 设置虚拟环境并安装依赖
      run: |
        python -m venv venv && source venv/bin/activate
        pip install --upgrade pip setuptools wheel
        
    - name: 打包项目
      run: python -m build

    - name: 上传到 PyPI
      uses: twinebot/twine-action@v1
      with:
        twineUserName: ${{ secrets.PYPI_USERNAME }}
        twinePassword: ${{ secrets.PYPI_PASSWORD }}

リポジトリのシークレットを作成します。

GitHub Actions で以下のシークレットを設定します。

• PYPI_USERNAME：PyPI のユーザー名
• PYPI_PASSWORD：PyPI のパスワード

セマンティックバージョニング (Semantic Versioning)

SemVer 標準に従い、MAJOR.MINOR.PATCH 形式でバージョンを管理します。

バージョン番号の例：

• 1.0.0: 初回リリース
• 2.3.1: 機能改善とバグ修正
• 2.4.0: 新機能の追加
• 3.0.0: 重大な更新または下位互換性のない変更

依存関係のインストール

以下のコマンドを使用して、プロジェクトの依存関係をインストールします。

pip install -r requirements.txt

ベストプラクティスのまとめ

1. PEP8 コーディング規約に従います。
2. 仮想環境を使用して依存関係を管理します。
3. コードを簡潔で保守可能な状態に保ちます。
4. 十分なテストケースを記述します。
5. ドキュメントツールを使用してプロジェクトを記録します。
6. 依存関係管理を正しく設定します。
7. 定期的にプロジェクトのバージョンを更新します。
8. CI/CD を通じて自動公開を実現します。

詳細については、Python 公式ドキュメント を参照するか、Python 開発者コミュニティに参加してください。