Pythonプロジェクト

Pythonプロジェクトジェネレータは、ベストプラクティスで構成されたモダンなPythonライブラリまたはアプリケーションを作成するために使用できます。これにはUVによる依存関係管理、単一のロックファイルとUVワークスペース内の仮想環境、テスト実行用のpytest、静的解析用のRuffが設定されています。

使用方法

Pythonプロジェクトの生成

新しいPythonプロジェクトを2つの方法で生成できます:

VSCode

1. インストール Nx Console VSCode Plugin まだインストールしていない場合
2. VSCodeでNxコンソールを開く
3. クリック Generate (UI) "Common Nx Commands"セクションで
4. 検索 @aws/nx-plugin - py#project
5. 必須パラメータを入力
6. クリック Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:py#project

yarn

yarn nx g @aws/nx-plugin:py#project

npm

npx nx g @aws/nx-plugin:py#project

bun

bunx nx g @aws/nx-plugin:py#project

変更されるファイルを確認するためにドライランを実行することもできます

pnpm

pnpm nx g @aws/nx-plugin:py#project --dry-run

yarn

yarn nx g @aws/nx-plugin:py#project --dry-run

npm

npx nx g @aws/nx-plugin:py#project --dry-run

bun

bunx nx g @aws/nx-plugin:py#project --dry-run

オプション

パラメータ	型	デフォルト	説明
name 必須	string	-	The name of the Python project
directory	string	packages	Parent directory where the project is placed.
projectType 必須	string	application	Project type
moduleName	string	-	Python module name

ジェネレータの出力

ジェネレータは<directory>/<name>ディレクトリに以下のプロジェクト構造を作成します:

• Directory<module-name>

  • __init__.py モジュール初期化
  • hello.py Pythonソースファイルの例
• Directorytests

  • __init__.py モジュール初期化
  • conftest.py テスト設定
  • test_hello.py テストの例
• project.json プロジェクト設定とビルドターゲット
• pyproject.toml UVが使用するパッケージ設定ファイル
• .python-version プロジェクトのPythonバージョン

ワークスペースのルートにも以下のファイルが作成/更新されます:

• pyproject.toml UV用ワークスペースレベルのパッケージ設定
• .python-version ワークスペースのPythonバージョン
• uv.lock Python依存関係のロックファイル

Pythonソースコードの記述

Pythonソースコードは<module-name>ディレクトリに追加します。

他のプロジェクトでのライブラリコードのインポート

UVワークスペースが設定されているため、ワークスペース内の他のPythonプロジェクトからプロジェクトを参照できます:

packages/my_other_project/my_other_project/main.py

from "my_library.hello" import say_hello

上記の例では、my_libraryがモジュール名、helloはPythonソースファイルhello.pyに対応し、say_helloはhello.pyで定義されたメソッドです

依存関係

プロジェクトに依存関係を追加するには、Pythonプロジェクトでaddターゲットを実行します:

pnpm

pnpm nx run my_scope.my_library:add some-pip-package

yarn

yarn nx run my_scope.my_library:add some-pip-package

npm

npx nx run my_scope.my_library:add some-pip-package

bun

bunx nx run my_scope.my_library:add some-pip-package

これにより依存関係がプロジェクトのpyproject.tomlファイルに追加され、ルートのuv.lockが更新されます。

ランタイムコード

Pythonプロジェクトをランタイムコード（例: AWS Lambda関数のハンドラ）として使用する場合、ソースコードとすべての依存関係のバンドルを作成する必要があります。project.jsonファイルに以下のようなターゲットを追加することで実現できます:

project.json

{
  ...
  "targets": {
    ...
    "bundle": {
      "cache": true,
      "executor": "nx:run-commands",
      "outputs": ["{workspaceRoot}/dist/packages/my_library/bundle"],
      "options": {
        "commands": [
          "uv export --frozen --no-dev --no-editable --project packages/my_library -o dist/packages/my_library/bundle/requirements.txt",
          "uv pip install -n --no-installer-metadata --no-compile-bytecode --python-platform x86_64-manylinux2014 --python `uv python pin` --target dist/packages/my_library/bundle -r dist/packages/my_library/bundle/requirements.txt"
        ],
        "parallel": false
      },
      "dependsOn": ["compile"]
    },
  },
}

ビルド

Pythonプロジェクトにはbuildターゲット（project.jsonで定義）が設定されており、以下のコマンドで実行できます:

pnpm

pnpm nx run <project-name>:build

yarn

yarn nx run <project-name>:build

npm

npx nx run <project-name>:build

bun

bunx nx run <project-name>:build

<project-name>はプロジェクトの完全修飾名です。

buildターゲットはプロジェクトのコンパイル、リント、テストを実行します。

ビルド出力はワークスペースのルートdistフォルダ内のパッケージとターゲットに対応するディレクトリ（例: dist/packages/<my-library>/build）に生成されます。

テスト

pytestがプロジェクトのテスト用に設定されています。

テストの記述

テストはプロジェクト内のtestディレクトリにtest_で始まるPythonファイルとして記述します:

• Directorymy_library

  • hello.py
• Directorytest

  • test_hello.py hello.pyのテスト

テストはtest_で始まるメソッドとして記述し、アサーションを使用して期待値を検証します:

test/test_hello.py

from my_library.hello import say_hello

def test_say_hello():
  assert say_hello("Darth Vader") == "Hello, Darth Vader!"

テストの記述方法の詳細についてはpytestドキュメントを参照してください。

テストの実行

テストはプロジェクトのbuildターゲットの一部として実行されますが、testターゲットを個別に実行することもできます:

pnpm

pnpm nx run <project-name>:test

yarn

yarn nx run <project-name>:test

npm

npx nx run <project-name>:test

bun

bunx nx run <project-name>:test

-kフラグを使用して特定のテストファイルまたはメソッドを指定して実行できます:

pnpm

pnpm nx run <project-name>:test -k 'test_say_hello'

yarn

yarn nx run <project-name>:test -k 'test_say_hello'

npm

npx nx run <project-name>:test -k 'test_say_hello'

bun

bunx nx run <project-name>:test -k 'test_say_hello'

リント

PythonプロジェクトではRUFFを使用してリントを行います。

リントの実行

プロジェクトのリントチェックを実行するにはlintターゲットを実行します:

pnpm

pnpm nx run <project-name>:lint

yarn

yarn nx run <project-name>:lint

npm

npx nx run <project-name>:lint

bun

bunx nx run <project-name>:lint

リント問題の修正

ほとんどのリントやフォーマットの問題は自動修正可能です。--configuration=fix引数を付けて実行することで修正できます:

pnpm

pnpm nx run <project-name>:lint --configuration=fix

yarn

yarn nx run <project-name>:lint --configuration=fix

npm

npx nx run <project-name>:lint --configuration=fix

bun

bunx nx run <project-name>:lint --configuration=fix

ワークスペース内の全パッケージのリント問題を修正するには以下を実行します:

pnpm

pnpm nx run-many --target lint --all --configuration=fix

yarn

yarn nx run-many --target lint --all --configuration=fix

npm

npx nx run-many --target lint --all --configuration=fix

bun

bunx nx run-many --target lint --all --configuration=fix