Python 開発環境の設定

このチュートリアルでは、 Google Cloudで動作する Python アプリの開発など、Python 開発用のローカルマシンを準備する方法を説明します。

開発環境がすでに設定されている場合は、Python と Google Cloud を参照して、 Google Cloudで Python アプリを実行する方法の概要を確認してください。

ヒント: すぐに始める場合は、Cloud Shell Editor が Google Kubernetes Engine と Cloud Run アプリケーションの開発サイクル全体をサポートします。Cloud Shell エディタは Code OSS に基づいており、Google Cloud CLI と Cloud Code のツールがプリインストールされています。

目標

  • Google Cloudと互換性のあるサポートされているバージョンの Python をインストールします。
  • venv を使用して依存関係を隔離します。
  • エディタのインストール(省略可)
  • Google Cloud CLI をインストールします(省略可)。
  • Python 用の Cloud クライアント ライブラリのインストール(省略可)
  • その他の便利なツールをインストールします。
  • 認証を設定します(省略可)。

Python をインストールする

Python のインストール手順は、オペレーティング システムによって異なります。開発環境で実行しているオペレーティング システム(macOS、Windows、Linux)のガイドに従ってください。

macOS

macOS にはデフォルトで Python のバージョンが含まれており、独自の目的に使用されています。macOS との干渉を避けるために、別の開発環境を作り、 Google Cloud用のサポートされているバージョンの Python をインストールすることをおすすめします。Python をインストールするには、Homebrew を使用します。

  1. Homebrew を使用して Python パッケージをインストールするには、Xcode のコマンドライン ツールをインストールしてコンパイラを入手する必要があります。

    xcode-select --install
    
  2. Homebrew のホームページの手順に従って Homebrew をインストールし、Homebrew を使用して以下のとおり Python をインストールします。

    brew install pyenv
    pyenv install PYTHON_VERSION
    

    Python のバージョン番号は x.y の形式にする必要があります。次に例を示します。

    pyenv install 3.12
    
  3. インストールが完了したら、Python 3 が python および python3 として使用可能であること、pip もインストールされていることを確認します。

    Python が利用可能であることを確認するには、次のコマンドを実行します。

    python3 --version
    

    バージョンが出力されます。 Homebrew Python Formula のページで Python homebrew について確認し、バージョンを確認します。

    pip3 が利用可能であることを確認するには、次のコマンドを実行します。

    pip3 --version
    

    インストールされている場合は、pip3 のバージョンが出力に表示されます。pip3 の最新バージョンについて詳しくは、pip リリースノートをご覧ください。

    上記のコマンドで pip3 バージョンが表示されない場合は、pip3 が正しくインストールされていることを確認してください。pip3 がインストールされているが機能しない場合は、次のコマンドを使用して最新バージョンにアップグレードします。

    python -m pip install --upgrade pip
    

    Homebrew は、お使いのプラットフォームで最新の Python をインストールします。出力内のバージョン番号は、Python の最新公式リリースとは異なる場合があります。

Windows

  1. Windows 環境に Python をインストールするには、Python のウェブサイトから必要なバージョンの Python のインストーラをダウンロードします。詳細については、 Google Cloudのサポートされている Python のバージョンをご覧ください。

  2. お使いのバージョンの Python にアクセスするには、Windows 用 Python ランチャーを使用します。

    インストールしたバージョンの Python を起動するには、次のコマンドを実行します。

    py
    

    インストールしたバージョンの Python 3 を起動するには、次のコマンドを実行します。

    py -3
    

    利用可能な pip のバージョンを確認するには、次のコマンドを実行します。

    py -m pip --version
    

    出力に C:\users\[USERNAME]\appdata\local\programs\python\python38-32\lib\site-packages からのバージョンが表示されます。

    最新版の pip については、pip のリリースノートをご覧ください。

Linux

ほとんどの Linux ディストリビューションには、最新バージョンの Python が含まれています。

  1. Python を Linux 環境にインストールするには、ご使用のディストリビューションに適したパッケージをインストールしてください。Debian と Ubuntu の場合、パッケージは、python3python3-devpython3-venvpython3-pip です。

    次のコマンドを使用してこれらのパッケージをインストールします。

    sudo apt update
    sudo apt install python3 python3-dev python3-venv python3-pip
    
  2. インストールが完了したら、pip がインストールされていることを確認します。

    pip3 --version
    

    最新版の pip については、pip のリリースノートをご覧ください。

venv を使用して依存関係を隔離する

venv は隔離された Python 環境を作成するツールです。これらの隔離環境では、異なるバージョンの Python パッケージを使用して、あるプロジェクトの依存関係を他のプロジェクトの依存関係から分離できます。Python を使用してローカルに開発する場合は、常にプロジェクトごとに仮想環境を使用することをおすすめします。

  1. venv コマンドを使用して、Python インストール全体の仮想コピーを作成します。このチュートリアルでは、env という名前のフォルダに仮想コピーを作成しますが、フォルダには任意の名前を指定できます。

    macOS

    cd your-project
    python -m venv env
    

    Windows

    cd your-project
    py -m venv env
    

    Linux

    cd your-project
    python3 -m venv env
    
  2. 仮想環境を有効化して、Python の venv パスを使用するようシェルを設定します。

    macOS

    source env/bin/activate
    

    Windows

    .\env\Scripts\activate
    

    Linux

    source env/bin/activate
    
  3. これにより、他のプロジェクトやグローバルの Python インストールに影響を与えずにパッケージをインストールできます。

    pip install google-cloud-storage
    

    仮想環境の使用をやめてグローバル Python に戻る場合は、無効化できます。

    deactivate
    

venv の詳細については、venv のドキュメントをご覧ください。

エディタのインストール

Python アプリの開発にはエディタが必要です。よく使用されるエディタには次のものがあります(順不同)。

Python 用 Cloud クライアント ライブラリをインストールする

Python 用 Cloud クライアント ライブラリは、Python デベロッパーが Datastore や Cloud Storage などの Google Cloud サービスと統合する方法を示します。Cloud Storage などの個々の API のパッケージをインストールするには、次のようなコマンドを使用します。

pip install --upgrade google-cloud-storage

gcloud CLI のインストール

gcloud CLI は、 Google Cloud用のコマンドライン ツールのセットです。このセットには gcloudbq が含まれており、Compute Engine、Cloud Storage、BigQuery などのプロダクトやサービスにコマンドラインからアクセスできます。これらのツールはインタラクティブに実行することも、自動スクリプトで実行することもできます。

認証を設定する

クライアント ライブラリを使用するには、まず認証を設定する必要があります。

If you're using a local shell, then create local authentication credentials for your user account:

gcloud auth application-default login

You don't need to do this if you're using Cloud Shell.

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

詳細については、クライアント ライブラリを使用して認証するをご覧ください。

次のステップ