Visual Studio Code で Hello Python3!

ようやく Visual Studio Code の 準備ができました! さっそく Python の コーディングに入りたいと思います. まずは基本の Hello World から!

作業環境

  • Windows 10 64bit
  • Python 3.6 64bit
  • Visual Studio Code

Python サポート の 拡張機能を追加

Visual Studio Code で Python の コード補完や、Lint、デバッグ を 行うには、Pyhton サポート の 拡張機能を追加します.
Python サポート の 拡張機能は かなりの数 登録されています. その中から、今回は Don Jayamanne さん の 拡張機能 を 使わせていただくことにしました.
レーティングが高く、インストール数も多く、また Visual Studio Code の 公式ドキュメントで紹介されていること、「ようこそ」画面で推薦されていることなどからの選定となります. Thank you for the great extension!, Don Jayamanne-san!!

Visual Studio Code を 起動し「ようこそ」画面から、[カスタマイズする] - [ツールと言語] - [Python] を クリックします.
※ 「ようこそ」 が 表示されない場合は、メニュー の [ヘルプ] - [ようこそ] を 選択します

「Python に追加サポートをインストールしたあと、ウィンドウが再読み込みされます.」 が 表示されるので [OK] を クリックします.

Visual Studio Code が 再起動し、「ようこそ」の Python の 色が変わり Python サポートがインストールされました.

また、Ctrl + Shift + X で 拡張機能を表示するとインストール済みに Python が 追加されていることからも確認できます.

プロジェクト・フォルダー の 作成 と 展開

さっそくプロジェクト用のフォルダーを作成し開きます. Ctrl + K Ctrl + O から フォルダー選択ダイアログを表示してもよいのですが、今回はフォルダーを作成する必要があるので “Being able to keep your hands on the keyboard when writing code is crucial for high productivity. VS Code has a rich set of default keyboard shortcuts as well as allowing you to customize them. - Basic Editing in Visual Studio Code - Keyboard shortcuts“ にならい、統合コンソールから開くことにします.

Ctrl + @ で 統合コンソールを表示. 下記コマンドを実行しフォルダーの作成 と Visual Studio Code で フォルダーを開きます. 今回は C:\Develop\workspace\hello-python3 に フォルダーを作成しました.

1
2
PS C:\Users\username> mkdir C:\Develop\workspace\hello-python3
PS C:\Users\username> code C:\Develop\workspace\hello-python3\

Python の 仮想環境 を 作成

Hello World なので、仮想環境を作成するほどでは無いのですが、Visual Studio Code の 設定確認もかねて.
Ctrl + @ で 統合コンソールを表示し、 venv を 実行します. フォルダーを開いているので、カレント・フォルダーが自動的にプロジェクト用のフォルダになっています.

1
PS C:\Develop\workspace\hello-python3> python -m venv venv

Visual Studio Code で 仮想環境を使うように設定します.
Ctrl + Shift + P で コマンドパレット、interp と 入力して、[Python: Select Workspace Interpreter] を 選択します.
続いて利用可能な python.exe の 候補が出るので、 venv - python.exe を 選択します.

続いて新しいファイルを作成します. Ctrl + N でもよいのですが、Visual Studio Code っぽく Ctrl + Shift + P で コマンドパレット、new file を 入力して、Visual Studio Code の エクスプローラーに直接ファイルを追加します. ファイル名は hello.py としました.

ファイル名を確定すると「Linter pylint is not installed」の エラーが表示されます. [Install pylint] を クリックしてインストールします.

新しい統合ターミナルが起動し Pylint が インストールされます. 先ほど仮想環境を選択しているので実行する python.exevenv の ものになっています. インストールできたら、統合ターミナルは不要なので Ctrl + @ で 閉じておきます.

Python コーディング

単純な Hello World ならぬ Hello Python3! なので print('Hello Python3!') 以上、なのですが Visual Studio Code を 使うからには入力補完を使うようなコードにしたいところです. ちょっと回りくどいですが main() から hello() を 呼ぶような構造にしました.

1
2
3
4
5
6
7
8
def hello(name):
print('Hello ' + name)

def main():
hello('Python3!')

if __name__ == '__main__':
main()

では早速. d と タイプすると入力補完が即時立ち上がりました! (間違えて消えてしまったら Ctrl + Space )
いくつかの候補があり迷いますが、コード・スニペット の def を 選択します.

ファンクション定義のスニペットが展開されました. funcname に フォーカスが当たっているので、ファンクション名 hello を 入力し、 Tab キーを押下します.

parameter_list へ フォーカスが移るので、今回のパラメーター name を 入力し、 Tab キーを押下します.

ファンクションのボディに展開されていた pass へ フォーカスが当たるので、 print文 を 入力します.

printprint の 文字列の入力補完が効きますが括弧はつかないようです. また、 name は パラメーター定義があるのを見てくれて入力補完のリストが表示されます.

print 文のパラメーター 'Hello ' + name まで入力し、 Ctrl + Enter すると行の途中(今回は閉じ括弧のが残っている状態)でも、残りを改行せずにカーソルだけ次行へ改行してくれます. Ctrl + S で ファイルを保存します.
def に 警告が表示されています. 「[pylint] C0111:Missing module docstring」と「[pylint] C0111:Missing function docstring」ですね…
マウス・カーソルを警告が出ている波線にのせるほか、 Ctrl + Shift + M で 問題ビューを表示できます.

とりあえず先に進んで、 main() を 実装します.
main() は、そのあとの if __name__ == '__main__': と ペアになります. そのため if 文の入力補完を期待して if から入力し、 if(main) の 入力補完を選択します.

期待通りの main()if __name__ == '__main__': を 補完してくれました! pass に フォーカスが当たっているので hello('Python3!') を 入力します.

実装できたので Ctrl + S で 保存します. 警告 を すべて無くしてから完成ですが、今回は Visual Studio Code で Python を 実行することが目的で、コードは残さないので、このまま進めます.

Python プログラム の 実行

まずは Python 拡張機能 の [Python: Run Python File in Terminal] から実行してみます. Ctrl + Shift + P で コマンドパレットを表示、 Python run と 入力して絞り込みます.

[Python: Run Python File in Terminal] を 選択し、実行します.

その他 - venv 仮想環境 の python.exe の パス

venv の 仮想環境 python.exe の パスは .vscode\settings.json"python.pythonPath" に フル・パスで記述されています. .vscode\settings.json を Git などへコミットし共有する場合は、絶対パスか"${workspaceRoot}/venv/scripts/python.exe" のように、プロジェクトのディレクトリをさす ${workspaceRoot} に 置き換えておきます. 詳細は こちら Relative Paths to Python Interpreter - Python Path and Version · DonJayamanne/pythonVSCode Wiki
.

その他 - 統合ターミナルから venv 仮想環境 の 実行

Ctrl + @ で 統合ターミナルを起動し、そこから Python および 関連コマンド(e.g. pip)を実行する場合、 venv を 有効化する必要があります. この場合は [Python: Select Workspace Interpreter] が 効いていないので注意が必要です.

1
2
3
PS C:\Develop\workspace\hello-python3> Set-ExecutionPolicy RemoteSigned -Scope Process
PS C:\Develop\workspace\hello-python3> .\venv\Scripts\Activate.ps1
(venv) PS C:\Develop\workspace\hello-python3>


主にクロール系の処理になるので、こちらで勉強しています.
最初の言語として勉強するための本には向いていませんが、Python の 言語使用の話もあるので他の言語を知ってる場合には、これ1冊でも十分ではないでしょうか.
またクローラーを作るという観点では、Python の 基本機能だけではなく Shell や Python の 外部ライブラリを使ったりと、バリエーションを持たせて解説があるので とても分かりやすいほか、法律に関する話などもあるのが素晴らしいです!


Visual Studio Code で Hello World が できました!
これで Python プログラミングが始められます. 何を作ろうかなぁ~