Django – DTL – 変数展開

概要

Djangoのテンプレート内での変数展開は{{ 変数 }}と記述。

  • 単純変数はそのまま内容が展開される
  • コレクションはリスト、タプル、辞書に応じた表現になる
  • コレクションの要素は[]ではなくドット(.)で添字やキーを指定
  • オブジェクトの属性やメソッドもドット(.)で指定

単純変数

単純変数の展開の例を以下に示す。まずview関数。

テンプレートの変数展開部分。

ブラウザーの表示。

単純変数

  • 実数値:3.1415
  • 文字列:ABCDいろはに

 

コレクション

コレクションを参照する変数を展開すると、変数をprint文でコンソール出力した時の形式で展開される。

テンプレートの変数展開部分。

ブラウザーの表示。

コレクション

  • リスト:[‘one’, 2, [3, ‘three’]]
  • タプル:(‘one’, 2, (3, ‘three’))
  • 辞 書:{‘one’: 1, ‘two’: 2, ‘three’: 3}

 

コレクションの要素を展開する場合、Pythonの[]と違ってドット(.)に続けて添字の数値やキーの文字列をそのまま書く。

多次元の場合には、次数に対応して連ねていく。

コレクション全体と同じ例で要素を表示したいときのテンプレートの例。

ブラウザーの表示。

コレクションの要素

  • リストの要素:one, 2, 3, three
  • タプルの要素:one, 2, 3, three
  • 辞書の要素 :1, 2, 3

オブジェクト

クラスのインスタンスを参照する変数も展開できる。以下はviews.pyで単純なクラスを定義して、そのインスタンスをテンプレートに渡している。

 

テンプレートでのオブジェクトの展開は、以下の3種類となる。

  • オブジェクト全体を展開すると、オブジェクトが文字列にキャストされた表現となる
  • オブジェクトの属性は、変数と属性名をドット(.)で繋いで得られる
  • オブジェクトとメソッド名をドット(.)で繋ぐと、メソッドの実行結果が得られる

ブラウザーでの表示。

オブジェクト

  • オブジェクト全体:<dtldemo.views.BinaryOperation object at 0x7fdf2835ec50>
  • オブジェクトの属性:2, 3
  • オブジェクトのメソッド:5

フィルター

基本形

フィルターはテンプレート中の変数を加工するもので、Djangoによる組み込みフィルターが多数用意されている。フィルターの基本形は以下のとおり。

{{ 変数|フィルター }}

わかりやすい例としては、変数の文字列の文字数を返すlengthがある。以下のテンプレートでは、var_stringに格納されている文字列とその文字数を表示している。

変数の内容が'abcd'の場合、表示は以下のようになる。

引数

フィルターには引数を持つものもある。引数はリテラルとする必要がある。

{{ 変数|フィルター:引数 }}

以下の例はaddフィルターで、元の変数の内容に引数の内容を加える。

var_two=2var_string='abcde'の場合、表示は以下のようになる。

チェーン

フィルターのチェーンによって、複数のフィルターを作用させることができる。

{{ 変数|フィルター[:引数]|フィルター[:引数] ... }}

以下の例では変数の文字列に文字列定数を連結した上で文字数を得ている。

var_string='abcde'の場合、結果は’8'となる。

スペースとエラー

'|'':'の前後にスペースを入れても問題ないが、タグ({% ... %})でフィルターを使う場合にはエラーとなる場合がある

紛らわしいので、「フィルターを使うときは間のスペースなし」と決めておく方がよい。

 

Django – テンプレートの基礎

概要

HTMLや埋め込まれたデータを含むテンプレートを使ったアプリケーションの基本。流れは以下の通り。

  • テンプレートを表示させるアプリケーションの作成と登録
  • テンプレートを保存するディレクトリーとテンプレートファイルの作成
  • テンプレートを呼び出すビュー関数の作成
  • ルーティング設定

ここでは以下のことを整理している。

  • テンプレートの配置場所
  • テンプレートの参照方法
  • テンプレート言語(DTL)の概要

関連記事

プロジェクトの準備

プロジェクトディレクトリーをtemplatebasicsとし、settings.pyなどを含むサブディレクトリーをconfigとする。

初期設定とサーバー起動で動作確認しておく。

アプリケーションの作成・登録

テンプレートを表示させるアプリケーションtemplatedemoを作成する。

そしてアプリケーションをsettings.pyINSTALLED_APPSに追加登録する。

テンプレート配置

初期設定

テンプレートの配置場所settings.pyTEMPLATESで設定する。

DIRSは任意の場所・ディレクトリー名のパスを設定する。またAPP_DIRTrueに設定すると、各アプリケーションディレクトリー下のtemplatesディレクトリーが探索される。

複数のテンプレートディレクトリーは一括して同列に扱われ、各ディレクトリーのサブディレクトリーも再帰的に探索される。

デフォルトの設定では、各アプリケーションディレクトリー下のtemplatesディレクトリーのみが対象となっている。

配置場所

ここでは、以下の場所にテンプレートディレクトリーを置いて設定していく。

  • 2か所にテンプレートディレクトリーを配置し、いずれのファイル名ともindex.htmlとしている
  • プロジェクト直下のディレクトリー名は任意だが、簡明のためtemplatesとする
  • 2つのテンプレートディレクトリーは併せて参照されるので、アプリケーション下の方は区別のためにサブディレクトリーを設けている

アプリケーション下

テンプレートディレクトリー作成

作成したアプリケーションディレクトリーtemplatedemoの下にtemplatesディレクトリーを作成し、その下に更にサブディレクトリーtemplatedemoを作成する。

テンプレートファイル作成

作成したサブディレクトリー下にindex.htmlファイルを作成して以下を記述。

プロジェクト直下

settings.py編集

TEMPLATESDIRSにプロジェクト直下のtemplatesディレクトリーを探索するよう追加。

os.pathを使う方法もありその場合はimport osが必要になるが、上記の記述でも同じ効果。

テンプレートディレクトリー作成

プロジェクトディレクトリー直下にtemplatesディレクトリーを作成する。サブディレクトリーは作成しない。

テンプレートファイル作成

作成したtemplatesディレクトリー下にindex.htmlファイルを作成して以下を記述。

view関数の作成とルーティング

view関数の作成

アプリケーションディレクトリーtemplatedemoviews.pyを編集して、view関数を定義する。

view関数でレンダリングするテンプレートを指定するため、プロジェクト直下とアプリケーションディレクトリー下2か所のテンプレートに対応する関数を記述している。要点は以下のとおり。

  • def 関数名(request):で定義
  • テンプレートを呼ぶ戻り値はrender関数
    • 第1引数は受け取ったrequest
    • 第2引数はテンプレートファイルのパス
  • テンプレートファイルのパスについて
    • TEMPLATESで設定したすべてのテンプレートディレクトリー下が一括して扱われる
    • テンプレートディレクトリー以下の相対パスとする

複数テンプレートディレクトリーが一括して扱われ、テンプレートの指定がテンプレートディレクトリーからの相対パスとなるため、サブディレクトリーを設定した意義が確認できる。

view関数のルーティング登録

これらのview関数をURLから呼び出すためurls.pyに記述を追加する。

確認

ここで開発用Webサーバーを起動して、ブラウザーで以下の入力に対応したページが表示されるのが確認できる。

  • localhost:8000/project
  • localhost:8000/application

DTL~テンプレート言語

概要

テンプレートにはHTMLのほかに、view関数から受け取った変数を埋め込んだり、繰り返しや条件分岐による出力の変更といった制御をさせることができる。そのための言語をDTL (Django Template Language)と言う。

  • {{ 変数 }}:変数の内容を展開してHTMLに埋め込む
  • {% 文 %}forendforによるループやifelifendifによる条件分岐で出力を制御する

変数の展開

たとえばtemplatedemoアプリケーションのviews.pyで、index_application関数を以下のように変更する。

ここでは、変数textを定義して、これを'text'をキーとする辞書の値としてrender関数の第3引数に渡している。

次に、templatedemoアプリケーション下のindex.htmlテンプレートを以下のように変更する。

表示結果は、ブラウザーの上部またはタブと見出しに同じ「アプリケーション下」が表示される。

このように、ビュー側で処理した結果を変数としてテンプレートに渡し、HTMLとして表示させることができる。

制御構造

先のindex_application関数を以下のように変更する。

ここでは第3引数をcontextとし、この変数に2つの要素を持つ辞書を入れている。1つ目の要素はタイトル、2つ目の要素は物語のシーンを収めた配列としている。

これを受け取るindex.htmlを以下のように変更する。

scenesで渡された配列の要素を、DTLのforendforでループしながら取り出し、li要素として並べている。この結果、出力されたHTMLでは5つのシーンがリストとして表示される。

同じテンプレートを使って、タイトルとシーンを桃太郎やかぐや姫などと変化させることができる。

 

Django – テンプレートの場所

概要

  • Djangoのテンプレートファイルは、テンプレートディレクトリーやそのサブディレクトリーに置かれることを想定している
  • 複数場所に配置されたテンプレートディレクトリー以下が一括して探索される
  • 探索場所と順序はsettings.pyファイルのTEMPLATESの設定に従う
    • DIRSでは任意の場所・名前でテンプレートディレクトリーを追加できる
    • APP_DIRSTrueに設定されている場合、各アプリケーションディレクトリー下のtemplatesディレクトリーが探索される
  • 探索されたテンプレートを参照する場合、テンプレートディレクトリーからの相対パスで指定する
  • テンプレートディレクトリーを分散配置しても一括して検索されるため、各テンプレートディレクトリーに適切なサブディレクトリーを置いて、その下にテンプレートファイルを置くのが一般的

確認用プロジェクト

確認のためtemplatetestプロジェクトを準備し、app1app2の2つのアプリケーションを作成する。templatesディレクトリーとそのサブディレクトリーを以下のように作成し、4つの場所に即した内容のindex.htmlファイルを置く。

各場所のindex.htmlは、title要素/bodyp要素で以下を表示させるようにした。

  • App1/Under the app1 directory
  • App2/Under the app2 directory
  • Subirectory/Under the subdirectory
  • Base Directory/Under the base directory

そしてapp1のビューファイルで指定するテンプレート名のディレクトリー名を変更しながら、各場所のindex.htmlが読み込まれたかどうか確認する。

プロジェクトの完成後、template変数に設定した文字列を以下のように変更して、それぞれに対応したページが表示されるかどうかを確認する。

  • 'base/index.html'
  • 'subdirectory/index.html'
  • 'app1/index.html'
  • 'app2/index.html'

TEMPLATESの初期設定

初期状態でのTEMPLATESは以下の通り。

このうちテンプレートの探索場所は'DIRS''APP_DIRS'で設定される。

なおディレクトリーの探索場所が設定されていれば、そのサブディレクトリー下も再帰的に探索される。

DIRSでの設定

プロジェクトディレクトリー直下

'DIRS'にはプロジェクト内任意の場所の、任意の名前のディレクトリーを設定できる。たとえばプロジェクトディレクトリー直下に置いたtemplatesを探索させるなら以下のように記述する。

または

後者の場合、settings.pyではimport osがないので追加が必要。

この設定により、'templatetest/templates/base/index.html'のレンダリングが可能になる。

サブディレクトリー下

プロジェクトの設定ファイル群があるサブディレクトリー下(この場合configディレクトリー)にあるディレクトリーを探索させるときは以下のように相対パスで設定する。

または

この場合もsettings.pyimport osが必要。

この設定により、templatetest/config/subdirectory/templates/index.htmlのレンダリングが可能になる。

APP_DIRSの設定

また、'APP_DIRS'Trueに設定されている場合は、各アプリケーションディレクトリー下にあるtemplatesディレクトリーが探索される。

デフォルトでTrueがセットされているので、アプリケーションディレクトリー下にtempratesディレクトリーがあれば全て探索される。

この例の場合、app1/templatesapp2/templatesは、デフォルトの設定)のままでそれぞれのサブディレクトリーも含めて探索される。

この結果templatetest/app1/templates/app1/index.htmltemplatetest/app2/templates/app2/index.htmlのレンダリングが可能になる。

全てを探索させるTEMPLATESの設定

これまでの4つの場所のすべてを探索対象とするには、settings.pyTEMPLATESを以下のように設定する。

この結果、以下の4つが探索可能になる。

  • templatetest/templates/base/index.html
  • templatetest/config/templates/subdirectory/index.html
  • templatetest/app1/templates/app1/index.html
  • templatetest/app2/templates/app2/index.html

templatesのサブディレクトリー

特にアプリケーションディレクトリー下にテンプレートを置く場合に、(index.htmlのように)同じ名前のファイルが重複しないよう、サブディレクトリーを設けるのが一般的。

通常、サブディレクトリー名はアプリケーションディレクトリー名と同じとする。冗長だが重複が防止され、可読性も保たれる。

 

 

Django – Hello! – 単純なアプリケーション

概要

特定のURLにアクセスするとブラウザーに”Hello!”とだけ表示させるプロジェクトを作成する。要点は以下の通り。

  • Djangoのプロジェクトは複数のアプリケーションを含むことができる
  • アプリケーション作成はmanage.pystartappオプションで実行
  • リクエストに対応した処理を行うview関数をviews.pyに定義
  • 特定のURLへのアクセスが対応するview関数にルーティングされるよう、urls.pyに設定

仕様

動作は以下の通り。

  • URLにhttp://localhost:8000/helloを指定してリクエスト
  • 文字列"Hello!"を返す(ブラウザーに表示される)

構造は以下の通り。

  • Hello表示のアプリケーションをhelloとする
  • リクエストに対応するview関数をsay_hello()とする
  • say_hello()はリクエストに対して文字列"Hello!"をレスポンスで返す

プロジェクトのスタート

まずgreetingsという名前でディレクトリーを作成し、そのディレクトリー下にプロジェクト作成。ここではサブディレクトリー名をconfigとしている。

プロジェクトの構成は以下の通り。

settings.py編集後にサーバーを起動してDjangoのwelcomeページが表示されることを確認しておく。

ここでのsettings.pyの編集内容は以下の通り。

  • ALLOWED_HOSTSへの追加
  • DATABASESのコメントアウト
  • 言語とタイムゾーンの設定

サーバー起動はVagrantのプライベート環境下なので以下の通り。

ブラウザーからのアクセスはhttp://localhost:8000で。

アプリケーションの作成

アプリケーション作成は、プロジェクトディレクトリー直下(manage.pyのある場所)で以下を実行。

ここでは、ブラウザーに”Hello!”を表示するためのhelloアプリケーションを作成する。greetingsディレクトリー下で以下を実行。

ディレクトリー構成は以下のようになる。新たにhelloディレクトリーが追加されている。

settings.pyにアプリケーションを追加

プロジェクトでhelloアプリケーションを認識するため、settings.pyINSTALLED_APPSにアプリケーション名'hello'を追加。

viewの作成~views.py

リクエストに対応した処理を、helloアプリケーションディレクトリー内のviews.pyファイルに記述。

  • 単純にHTTPレスポンスで文字列を返すため、HttpResponseをインポート
  • view関数としてsay_hello()を定義し、文字列を返すよう記述

ルーティング~urls.py

想定しているURLに対して定義したview関数が呼ばれるようにルーティング。プロジェクトサブディレクトリーのurls.pyファイルに記述を追加する。

  • say_hello()を使うためインポートが必要
  • urlpatterns/helloからsay_hello()へのルーティングを定義

ブラウザーから接続

以下のURLでブラウザーに”Hello!”と表示される。

なお、これ以降localhost:8000のルートに接続すると404エラーとなる。

ルーティングを記述したurls.pyにホストのルートへのルーティングを追加すると、http://localhost:8000のURLに対しても”Hello!”が表示されるようになる。

 

Django – プロジェクトの作成

概要

Djangoのプロジェクト作成はdjango-admin startprojectで行う。新規にプロジェクトディレクトリーを作成する方法と、既存のディレクトリーに作成する方法がある。

新規にプロジェクトディレクトリーを作成する方法では、プロジェクト名のみを指定する。

この場合プロジェクト名と同じディレクトリーが作成され、その下に同じ名前のサブディレクトリーとmanage.pyファイルが作成される。

既存のディレクトリーに作成する方法では、第1引数にサブディレクトリー、第2引数に既存のプロジェクトディレクトリーを指定する。

この場合、既存のプロジェクトディレクトリーの下にサブディレクトリーとmanage.pyファイルが作成される。

何れの場合もサブディレクトリーの内容は同じで、プロジェクト全体に関する設定ファイルなどが作成される。

manage.pyはコマンドラインで管理レベルの操作を行うためのファイル。

プロジェクト名だけを指定する場合

プロジェクト名だけを指定した場合は、その名前でディレクトリーが作成され、その下に同じ名前のサブディレクトリーとmanage.pyファイルが作成される。

もし同じ名前のディレクトリーが既に存在していた場合はエラーとなる。

以下は新規作成されたプロジェクトディレクトリーの内容

サブディレクトリーの下には、プロジェクト全体に関する設定ファイルが作成される。たとえばsettings.pyファイルは、プロジェクトの言語やタイムゾーン、データベースなどに関する設定を記述する。

既存のディレクトリーに作成する場合

空のプロジェクトディレクトリーを作成し、第1引数にサブディレクトリー、第2引数にプロジェクトディレクトリーを指定して実行する。

もし指定したプロジェクトディレクトリーが存在しない場合はエラーになる。

なお、以後の作業をプロジェクトディレクトリー内で行うことを想定して以下のように実行してもよい。

この場合のディレクトリー構成は以下のようになる。

 

 

Django – 初期設定とサーバー起動

概要

主な留意点は以下の通り。

  • DjangoのデフォルトDBMSはSQLite
  • 言語・タイムゾーン・DB設定などはsettings.pyで記述(Laravelの.envに相当)
  • Vagrantなどの仮想環境の場合はサーバー起動のIPに注意
    →ゲスト側でALLOW_HOSTSの設定も必要

当初に発生したエラーと対応についてはこちら

データベースクライアントのインストール

DjangoのデフォルトではSQLiteとなっている。SQLiteの場合は一定以上のバージョンが要求される模様。

他のDBMSを使う場合、クライアントをインストールしておく必要がある。以下はMySQLを使う場合にmysqlclientをインストールした例。

settings.py~各種設定

言語とタイムゾーン

言語を日本語に、タイムゾーンを日本のものに設定。

データベース設定

デフォルトのSQLiteではなくMySQLを使う例

ホスト許可

Vagrantなど仮想環境のプライベートネットワークで接続する場合、ここに設定が必要。

Vagrantの場合

Vagrantfileの設定

ポートマッピング設定。プライベートネットワークはデフォルト。

ゲスト側IP確認

ゲスト側の仮想環境でサーバーを起動する場合のIPを確認。ホスト側では127.0.0.1にセットされている。

開発用Webサーバー起動

ifconfigで確認したゲスト側のIPでサーバーを起動する。

ブラウザーで接続

ホスト側のブラウザーで、http://localhost:8000かhttp://127.0.0.1:8000で接続。

 

Vagrant – Django – サーバーエラー

概要

以下のような流れでエラー発生・解決した記録。データベース接続なしでとにかくDjangoのサーバー起動とアクセスを確認。

  • Vagrant上のCentOS7にPython3やvertualenvをインストール
  • 仮想環境上でDjango開発用サーバーを起動
  • Exception発生
  • ひとまずデータベースを切ってサーバー起動
  • ブラウザーから接続できず
  • Vagrantfileを編集してIPアドレス変更
  • DisallowedHostで接続できず
  • settings.pyのALLOWED_HOSTを編集
  • 無事接続

データベースを繋がずにとにかくDjangoの応答までを確認する場合、Vagrant環境では以下のように設定。

  • Vagrantfileでポートマッピングを設定
  • VMでifconfig→eth0のIPアドレスを確認
  • settings.pyのALLOWED_HOSTSにブラウザーでアクセスしたいホスト名、IPアドレスを追加
  • 開発用Webサーバーをeth0のIPアドレスとマップしたポートで起動
  • ALLOWED_HOSTSで許可したホスト/IPアドレスとマップしたポートでアクセス

サーバー起動時エラー発生

Vagrant/CentOS7環境上にPython3virtualenvをインストールして、仮想環境を作成。その環境下でDjangoをインストール

とりあえずテスト用のプロジェクトを作成。

プロジェクトで開発用Webサーバーを起動しようとしたところ、エラー発生。SQLiteのバージョンが低いと言っているらしい。

SQLiteを確認したところ、3.7と必要なバージョンより確かに低い。

データベース無効化で再挑戦

そもそもデータベースにはSQLiteではなくMySQLを使っている。またとりあえずの動作確認なので、データベースを設定せずにサーバーを起動してみようと考える。

Laravelでいえば.envファイルにあたる設定ファイルは、Djangoではsettings.pyらしい。その場所を探してみるとプロジェクトディレクトリーと同名のサブディレクトリーにあった。

settings.pyの中のデータベース関係を探して、そこをすべてコメントアウトしてみる。

再度サーバーを起動すると、エラー無く実行された。

ブラウザーで接続不可

サーバーは起動されたが、ブラウザーでhttp://127.0.0.1:8000とするとアクセスできない。

Vagrantのプライベートネットワークに沿った設定とサーバー起動が必要なことを忘れていた。

プライベートネットワーク設定

Vagrantfileの内容を確認・編集

vagrant reloadで再起動し、vagrant sshでCentOS7に入り、ポート設定を見る。

ゲスト側のVMからは10.0.20.15でサーバーを立ち上げ、ホスト側では127.0.0.1で接続する。ポートフォワーディングはホスト・ゲストとも8000

開発用Webサーバーを10.0.20.15:8000で起動。

Djangoで許可されない

ブラウザーでhttp://127.0.0.1:8000http://localhost:8000とするが接続できない。ただしDjangoによって許可されていないらしく、ALLOWED_HOSTSを加えるよう示されている。

ALLOW_HOSTSを編集して接続

settings.pyALLOWED_HOSTSを編集。

ブラウザーからhttp://127.0.0.1:8000あるいはhttp://localhost:8000でアクセスでき、以下のページが表示された。

 

 

 

CwntOS7 – Djangoのインストール

概要

Vagrant上のCentOS7にDjangoをインストール。

virtualenvの仮想環境でインストールした場合、元のシステムには影響を与えない。

手順

Python3インストール済みの環境でDjangoをインストール。特に問題なくインストール完了。

バージョンチェック。

Python3からもチェック。

 

Linux – bash – シェルプロンプトの変更

プロンプトの書式の確認

Vagrant上のCentOS7でシェルはbash。プロンプトは以下のようになっている。

この書式はPS1変数で設定されている。

それぞれの意味は以下の通り。

  • \u:ユーザー名
  • \h:ホスト名
  • \W:カレントディレクトリー

プロンプトの変更例

$#だけにする

プロンプトの後にスペースを入れておく。

ユーザー名と時刻にする

一部に色を付ける

以下はユーザー名と時刻を表示して、ユーザー名を青にしている(ターミナルではvagrantが青で表示される)。

常時設定する

~/.bashrcexport文を加える。

プロンプト書式に使える記号

以下の記号が使える。

  • \d:日付
  • \h:ホスト名の最初のブロック
  • \H:ドメイン名まで含めたホスト名
  • \s:シェルの名前
  • \t:時間~24時間制
  • \T:時間~12時間制
  • \@:時間~AM/PM形式
  • \u:ユーザー名
  • \w:カレントディレクトリー
  • \W:カレントディレクトリーのベース名
  • \!:コマンドの履歴番号
  • \$:一般ユーザーは$、rootなら#
  • \\:バックスラッシュ

色の設定

色設定はエスケープシーケンスで行う。

  • 設定開始:[ESC]+'['+[色コード]+'m'
  • 設定解除:[ESC]+'['+'39'+'m'

色コードには前景色と背景色がある。

  • 前景色:30~37、90~97
    • 90~97は明るめの色
  • 背景色:40~47
    • 100~107は明るめの色
  • 拡張指定:38
    • 256カラーレベル:38;5;n、48 ;5;n
    • RGB指定:38;2;r;g;b、48;2;r;g;b
  • 色設定解除:39
前景色 背景色
Black 30 40
Red 31 41
Green 32 42
Yellow 33 43
Blue 34 44
Magenta 35 45
Cyan 36 46
White 37 47

 

Vagrant – CentOS7 – Python3 – virtualenv

概要

Vagrant上のCentOS7で、virtualenvをインストールしてPython3の仮想環境をつくった手順の記録。

  • pipvirtualenvwrapperをインストールする
  • sudoでインストールすると警告が出てグローバルにインストールされる

許可がなくインストールできない

pip3virtualenvwrapperをインストールしようとしたところ、許可がないとエラーになった。

ディレクトリーに書き込み権限がない。

sudoで警告が出るがインストール

以下のような警告が出るが、インストールは実行される。

WARNING: Running pip install with root privileges is generally not a good idea. Try `pip3 install –user` instead.

グローバルインストールするのに対して、--userオプションでユーザーディレクトリーへのインストールを促している。

確認

virtualenvのバージョン確認。

仮想環境構築の確認。

ディレクトリー確認。

仮想環境の有効化。

仮想環境の無効化と削除。

操作

基本操作

ディレクトリーを作成して仮想環境を作成。絶対パスでなければ現在のディレクトリー下に作成される。

$ virtualenv directory

仮想環境の有効化。

$ source directory/bin/activate
または
$ . directory/bin/activate

仮想環境の無効化。

(directory) $ deactivate

仮想環境の削除

$ rm -rf directory

応用

Pythonのバージョン指定

$ virtualenv -p python3.6 directory

システムのPythonパッケージ群を仮想環境からも参照

$ virtualenv --system-site-packages directory

virtualenvwrapperの利用

.bashrcの編集と再読み込み

virtualenvだけでも基本的な操作はできるが、virtualenvwrapperを利用すると便利なコマンドが使えるようになる。そのために~/.bashrcに以下の3行を加える。

.bashrcを実行して反映させる。

1行目のWORKON_HOMEで指定したディレクトリーが作成され、ここに仮想環境ごとのディレクトリーが作成される。

2行目を設定しないと以下のエラーが出る。エラーが出てもvirtualenvwrapperは利用できたが入れておく。

3行目はvirtualenvwrapper.shを実行させる。

.bashrcの実行後、~/.virtualenvsディレクトリーと必要なファイルが作成される。

確認

仮想環境を作ってみる。

python3の場所が仮想環境内になっていて、元のシステムの場所とは違う。

もう一つ仮想環境を作って、workonコマンドで見てみる。lsvirtualenvコマンドもあるが、workonコマンドとの違いがよくわからない。

仮想環境にモジュールをインストールしてもシステムに影響がないことを確認する。まずシステムにはNumpyモジュールがインストールされていないことを確認。

仮想環境でもNumpyはインストールされていない。

Python3をexit()で抜けて、仮想環境のコマンドラインでNumpyをインストール。

Python3でNumpyが使えるようになった。

Python3をexit()で抜けて、仮想環境からも抜ける。元の環境ではNumpyはインストールされていないことがわかる。

virtualenvwrapperのコマンド

仮想環境の作成・有効化。WORKON_HOMEで設定したディレクトリーに作成される。

$ mkvirtualenv envname

仮想環境の無効化。

(envname) $ deactivate

仮想環境の一覧。

$ workon
または
$ lsvirtyalenv -b/-l

仮想環境の有効化。

$ workon envname

仮想環境ディレクトリーへの移動。

$ cdvirtualenv envname

仮想環境の削除。

$ rmvirtualenvname envname