Documents

Contents

Run

モジュール概要

Run Nexom projects with gunicorn.

チュートリアル

最初に以下の最小例でモジュール利用方法を確認し、その後 API リファレンスを参照してください。

from pathlib import Path
from nexom.buildTools.run import run_project

run_project(Path('.'), app_names=['app'])

運用チェックリスト

  • 本番では例外処理を必ず実装し、戻り値の型を固定してください。
  • 引数のデフォルト値と必須/任意を仕様書としてチーム内で固定してください。
  • ログと監視を追加し、エラー時の復旧手順を運用Runbookに記載してください。

API リファレンス（全関数・全メソッド）

モジュール関数

_is_windows

分類: internal function

シグネチャ

_is_windows() -> bool

使い方と仕様

実装コード由来のAPIです。

引数

  • 引数なし

戻り値

bool

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.run import _is_windows

result = _is_windows()
print(result)

_detect_apps

分類: internal function

シグネチャ

_detect_apps(project_root: Path) -> list[DetectedApp]

使い方と仕様

Scan project_root for runnable apps.

引数

  • project_root / kind=positional-or-keyword / type=Path / 必須 / default=なし

戻り値

list[DetectedApp]

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.run import _detect_apps

result = _detect_apps(project_root="/path/to/value")
print(result)

_require_gunicorn

分類: internal function

シグネチャ

_require_gunicorn() -> str

使い方と仕様

実装コード由来のAPIです。

引数

  • 引数なし

戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.run import _require_gunicorn

result = _require_gunicorn()
print(result)

_build_cmd

分類: internal function

シグネチャ

_build_cmd(gunicorn_bin: str, app: DetectedApp) -> list[str]

使い方と仕様

実装コード由来のAPIです。

引数

  • gunicorn_bin / kind=positional-or-keyword / type=str / 必須 / default=なし
  • app / kind=positional-or-keyword / type=DetectedApp / 必須 / default=なし

戻り値

list[str]

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.run import _build_cmd

result = _build_cmd(gunicorn_bin="sample", app=...)
print(result)

run_project

分類: public function

シグネチャ

run_project(project_root: Path, app_names: list[str] | None = None, *, dry_run: bool = False) -> None

使い方と仕様

Run WSGI apps in a Nexom project directory. - Detect apps: directories that contain both wsgi.py and gunicorn.conf.py. - If app_names is empty -> run all detected apps. - Else -> run only the specified ones. Notes: - Uses subprocess to start gunicorn (stable + predictable). - On Windows: gunicorn isn't supported (POSIX only) -> raise clear error.

引数

  • project_root / kind=positional-or-keyword / type=Path / 必須 / default=なし
  • app_names / kind=positional-or-keyword / type=list[str] | None / 任意 / default=None
  • dry_run / kind=keyword-only / type=bool / 任意 / default=False

戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.run import run_project

result = run_project(project_root="/path/to/value", app_names=None, dry_run=False)
print(result)

クラス

DetectedApp

分類: public class

Detected app directory with wsgi and gunicorn config.

このクラスにメソッド定義はありません。

RunError

分類: public class

Raised when naxom run fails.

このクラスにメソッド定義はありません。

ソース情報

  • module: nexom.buildTools.run
  • source file: services/venv/lib/python3.10/site-packages/nexom/buildTools/run.py
  • generated date: 2026-03-14

©2026 Nexom MIT-License