ローカル開発サーバーの使用

Cloud SDK と App Engine SDK for Python 2 には、本番環境の App Engine で実行するアプリケーションをローカルで実行してシミュレートできるローカル開発用サーバー（dev_appserver.py）が付属しています。シミュレートされた環境ではサンドボックスに制限があります。たとえば、システム関数や Python 2 モジュールによるインポート機能が制限されています。また、リクエストのタイムアウトや割り当ても設定されています。

App Engine 用 SDK のライブラリによって提供される Datastore、Memcache、タスクキューなどのサービスを、ローカル開発用サーバーでローカルに実行してシミュレートすることもできます。アプリケーションが開発用サーバーで動作している場合でも、Google API の HTTP エンドポイントを使用して、本番環境のインフラストラクチャに対するリモート API 呼び出しを実行できます。

ローカル開発サーバーの実行

アプリの app.yaml 構成ファイルを作成した後、dev_appserver.py コマンドを使用してローカル開発用サーバーを起動し、アプリをローカルで実行できます。

ローカル開発用サーバーを起動するには:

ローカル開発用サーバーの実行（`dev_appserver.py`）

ローカル開発用サーバーを実行するには、dev_appserver.py完全なディレクトリパスを指定するか、dev_appserver.py を PATH 環境変数に追加します。

App Engine SDK をインストールした場合、ツールは [PATH_TO_APP_ENGINE_SDK]/dev_appserver.py に配置されています。
Google Cloud SDK をインストールした場合、ツールは次の場所に配置されています。[PATH_TO_CLOUD_SDK]/google-cloud-sdk/bin/dev_appserver.py

ヒント: Google Cloud SDK ツールを PATH に追加し、bash シェルでコマンド補完を有効にするには、次のコマンドを実行します。
```
[PATH_TO_CLOUD_SDK]/google-cloud-sdk/install.sh
```

アプリの app.yaml 構成ファイルを含むディレクトリから、次のように dev_appserver.py コマンドを実行します。
アプリへのディレクトリパスを指定します。たとえば次のようにします。
```
dev_appserver.py [PATH_TO_YOUR_APP]
```
また、特定のサービスの構成ファイルを指定することもできます。たとえば次のようにします。
```
dev_appserver.py app.yaml
```
ポートを変更する場合は、--port オプションを含めます。
```
dev_appserver.py --port=9999 [PATH_TO_YOUR_APP]
```
dev_appserver.py が機能しない場合

dev_appserver.py コマンドオプションについて詳しくは、ローカル開発用サーバーのオプションをご覧ください。
ローカル開発用サーバーが起動し、リクエストを待機します。ウェブブラウザで http://localhost:8080/ にアクセスすると、アプリの動作を確認できます。
--port オプションでカスタムポートを指定した場合は、そのポートでブラウザを開くようにしてください。

ローカルサーバーをコマンドラインから停止するには、次のキーを押します。

macOS または Linux: Control-C
Windows: Ctrl-Break

アプリケーション ID の指定

メールアドレスのなりすましなどのために、ローカルサーバーでアプリ ID を使用する必要がある場合は、get_application_id() 関数を使用します。実行中のアプリのホスト名を取得するには、get_default_version_hostname() 関数を使用します。

アプリケーションのランタイム環境の検出

コードが本番環境で実行されているか、ローカル開発用サーバーで実行されているかを確認するには、SERVER_SOFTWARE 環境変数を確認します。

if os.getenv('SERVER_SOFTWARE', '').startswith('Google App Engine/'):
  # Production
else:
  # Local development server

ローカル Datastore の使用

ローカル開発用サーバーは、ローカルサーバーの呼び出し間で持続するローカルファイルを使用して App Engine データストアをシミュレートします。

インデックスと index.yaml の詳細については、Datastore インデックスページと Datastore インデックスの構成ページをご覧ください。

ローカル Datastore の参照

ローカル開発用サーバーを使用してアプリがローカル Datastore にデータを書き込んでいる場合は、ローカル開発コンソールでそのデータを参照できます。

ローカル Datastore を参照するには、次の手順を行います。

開発用サーバーを起動します。
ローカル開発コンソールで Datastore Viewer にアクセスします。URL: http://localhost:8000/datastore
ローカル Datastore のコンテンツを参照します。

ID 割り当てポリシーの指定

本番環境の App Engine の場合、エンティティ ID を自動的に生成するように Datastore を設定できます。

本番環境用サーバーの自動 ID 割り当てポリシーは、開発用サーバーで使用されるポリシーとは完全に異なりますが、ローカルサーバー用に自動 ID 割り当てポリシーを設定することもできます。

自動 ID 割り当てポリシーを指定するには、--auto_id_policy オプションを使用します。

dev_appserver.py --auto_id_policy=sequential

ここで、--auto_id_policy には次のいずれか 1 つを指定できます。

scattered: （デフォルト）ID は、ほぼ均一に分布する整数の繰り返しのないシーケンスから割り当てられます。
sequential: ID は、連続する整数のシーケンスから割り当てられます。

ローカル Datastore のクリア

アプリケーション用のローカルデータストアをクリアするには、ローカル開発用サーバーを次のように呼び出します。

dev_appserver.py --clear_datastore=yes app.yaml

ローカル Datastore の場所変更

データストアファイルの場所を変更するには、--datastore_path オプションを使用します。

dev_appserver.py --datastore_path=/tmp/myapp_datastore app.yaml

Users サービスの使用

App Engine には、アプリケーションの認証と認可を簡素化するためのユーザーサービスが用意されています。ローカル開発用サーバーは、独自のログインページとログアウトページで Google アカウントの動作をシミュレートします。ローカル開発用サーバーでの実行中、users.create_login_url 関数と users.create_logout_url 関数は、ローカルサーバー上の /_ah/login と /_ah/logout の URL を返します。

メールの使用

ローカル開発用サーバーは、SMTP サーバーまたはローカルにインストールされた Sendmail を使用して、呼び出しのメールを App Engine のメールサービスに送信できます。

SMTP の使用

SMTP サーバーを使用してメールサポートを有効にするには、次のように dev_appserver.py を呼び出します。

dev_appserver.py --smtp_host=smtp.example.com --smtp_port=25 \
    --smtp_user=ajohnson --smtp_password=k1tt3ns [PATH_TO_YOUR_APP]

ここで、--smtp_host、--smtp_port、--smtp_user、--smtp_password の各オプションに実際の値を設定します。

Sendmail の使用

Sendmail でメールサポートを有効にするには、次のように dev_appserver.py を呼び出します。

dev_appserver.py --enable_sendmail=yes [PATH_TO_YOUR_APP]

ローカルサーバーは sendmail コマンドを使用し、インストールのデフォルト構成に従ってメールのメッセージを送信します。

URL 取得の使用

アプリケーションが URL 取得 API を使用して HTTP リクエストを送信する場合、ローカル開発用サーバーはデベロッパーのコンピュータからリクエストを直接送信します。プロキシサーバーを使用してウェブサイトにアクセスしている場合、ローカルサーバーでの URL 取得の動作は本番環境の App Engine と異なることがあります。

インタラクティブコンソールの使用

インタラクティブコンソールを使用すると、デベロッパーはウェブフォームに任意の Python コードを入力し、アプリの環境内で実行できます。これは、アプリ自体の内部にある .py ファイルと同様に、アプリケーションの環境とサービスに対するアクセスを提供します。

インタラクティブコンソールを使用するには:

開発用サーバーを起動します。
ローカル開発コンソールでインタラクティブコンソールにアクセスします。URL: http://localhost:8000/console
テキストボックスに実行する必要のある任意の Python コードを入力し、フォームを送信して実行します。たとえば、次のコードは、Hello のテキストコンテンツを含む Greeting というデータストアエンティティを追加します。
```
  from google.appengine.ext import ndb
  class Greeting(ndb.Model):
    content = ndb.TextProperty()

  e = Greeting(content="Hello")
  e.put()
```

PDB を使用したデバッグ

Python PDB デバッガを使用するには:

コードに次の行を追加します。
```
import pdb; pdb.set_trace();
```
dev_appserver はこの時点で中断し、PDB REPL にドロップされます。これにより、コマンドラインからコードをデバッグできます。
アプリケーションが pdb.set_trace() を呼び出す複数のリクエストを同時に送信すると、複数のデバッグセッションが同時に開始され、それぞれが STDOUT に対して出力を送信します。これを防ぐには、次のように dev_appserver のマルチスレッドとマルチ処理のサポートを無効にして、リクエストをシリアル化します。
1. 次のマルチスレッドを無効にします。
  - --threadsafe_override=false フラグを使用するすべてのサービス。
  - --threadsafe_override=<SERVICENAME>:false フラグを使用する 1 つのサービス。
  - --threadsafe_override=<SERVICE1NAME>:false,<SERVICE2NAME>:false フラグを使用する複数のサービス。
  1. 次のマルチ処理を無効にします。
    - --max_module_instances=1 フラグを使用するすべてのサービス。
    - --max_module_instances=<SERVICENAME>:1 フラグを使用する 1 つのサービス。
    - --max_module_instances=<SERVICE1NAME>:1,<SERVICE2NAME>:1 フラグを使用する複数のサービス。