VS Code上でPythonを実行する方法|デバッグや単体テストについても解説

Python
Visual Studio
プログラミング言語

公開日時: 2021-09-14 　更新日時: 2022-06-01

VS Code上でPythonを実行する方法|デバッグや単体テストについても解説

この記事でわかること

システム エンジニア: VSCode上でもPythonを実行できるのですか。

プロジェクト マネージャー: できますよ。それでは、VSCode上でPythonの実行やデバッグ、単体テスト、カバレッジの取得方法について解説いたしましょう。

VS CodeでPythonの開発をしてみよう

今回は、VS Code上でPythonの開発環境を構築する方法について説明します。
Pythonの実行、デバッグ、単体テスト、カバレッジの取得方法について紹介します。

ここでは、Pythonはインストール済みである前提とします。
興味のある方はぜひご覧ください。

実行

VS Code上でPythonを実行する方法を紹介します。
まず、VS Codeの拡張機能「Python extension for Visual Studio Code」をインストールします。

次に「File」 → 「Open Folder」を選択し、作業フォルダを指定します。
「New File」を選択し、main.pyファイルを作成します。ファイル名は何でも構いません。
以下のように内容を編集します。

print('Hello World.')

1	print('Hello World.')

ソースコード上で右クリックし、「Run Python File in Terminal」を選択します。
VS Code画面下のターミナルに、実行結果が表示されます。

PS C:\Python> & C:/Users/user/Anaconda3/python.exe c:/Python/main.py
Hello World.
PS C:\Python>

PS C:\Python> & C:/Users/user/Anaconda3/python.exe c:/Python/main.py

Hello World.

PS C:\Python>

これでVS Codeを使ったPython開発環境が整いました。

デバッグ

VS Code上でPythonをデバッグする方法を紹介します。
VS Codeの画面左にあるデバッグアイコンをクリックし、「create a launch.json file」を選択します。
次に、Debug configurationで「Python File」を選択します。

以下のようなlaunch.jsonが生成されます。

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: Current File",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal"
    }
  ]
}

{

// Use IntelliSense to learn about possible attributes.

// Hover to view descriptions of existing attributes.

// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387

"version": "0.2.0",

"configurations": [

{

"name": "Python: Current File",

"type": "python",

"request": "launch",

"program": "${file}",

"console": "integratedTerminal"

}

]

}

ソースコード上でブレイクポイントを設定します。
デバッグ画面上部にある三角の実行ボタンをクリックするとデバッグができます。
ステップオーバー、ステップイン、ステップアウトなどを駆使して、デバッグしてみてください。

unittest

VS Code上でPythonの単体テストを実行する方法を紹介します。
Ctrl-Shift-P のコマンドパレットから、「Python: Configure Tests」を選択します。
今回は、以下の順に入力・選択します。

unittest
.
test*.py

unittest

test*.py

以下のようなsettings.jsonが生成されます。

{
  "python.testing.unittestArgs": [
    "-v",
    "-s",
    ".",
    "-p",
    "test*.py"
  ],
  "python.testing.pytestEnabled": false,
  "python.testing.nosetestsEnabled": false,
  "python.testing.unittestEnabled": true
}

{

"python.testing.unittestArgs": [

"-v",

"-s",

".",

"-p",

"test*.py"

"python.testing.pytestEnabled": false,

"python.testing.nosetestsEnabled": false,

"python.testing.unittestEnabled": true

}

main.pyを以下のように編集します。

def add(x, y): return x + y

def sub(x, y): return x - y

def multi(x, y): return x * y

def add(x, y): return x + y

def sub(x, y): return x - y

def multi(x, y): return x * y

test.pyを新規作成し、以下のように記述します。

import main
import unittest

class TestCase(unittest.TestCase):
        def test_1(self):
                self.assertEqual(main.add(1, 2), 3)

        def test_2(self):
                self.assertEqual(main.sub(3, 2), 1)

        def test_3(self):
                self.assertEqual(main.multi(2, 3), 6)

if __name__ == '__main__':
        unittest.main()

import main

import unittest

class TestCase(unittest.TestCase):

def test_1(self):

self.assertEqual(main.add(1, 2), 3)

def test_2(self):

self.assertEqual(main.sub(3, 2), 1)

def test_3(self):

self.assertEqual(main.multi(2, 3), 6)

if __name__ == '__main__':

unittest.main()

VS Code左側のテストアイコンをクリックすると、以下のような階層構造が表示されます。

test.py
  TestCase
    test_1
    test_2
    test_3

test.py

TestCase

test_1

test_2

test_3

上部の三角ボタン「Run All Tests」をクリックすると、unittestが実行されます。

カバレッジ

unittestの結果をカバレッジで見る方法を紹介します。まず、coverageをインストールします。

pip install coverage

1	pip install coverage

以下のコマンドで、カバレッジを取得します。

coverage run test.py

1	coverage run test.py

カレントフォルダに「.coverage」ファイルが生成されます。

次に、カバレッジを標準出力するコマンドを実行します。

$ coverage report
Name      Stmts   Miss  Cover
-----------------------------
main.py       3      0   100%
test.py      11      0   100%
-----------------------------
TOTAL        14      0   100%

$ coverage report

Name Stmts Miss Cover

-----------------------------

main.py 3 0 100%

test.py 11 0 100%

-----------------------------

TOTAL 14 0 100%

カバレッジが表示されることが分かります。

以下のコマンドを実行すると、カバレッジ結果をHTMLで出力します。

coverage html

1	coverage html

htmlcovフォルダが生成されます。htmlcov配下に以下のようなindex.htmlが生成されます。カバレッジの結果を確認してみてください。

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>Coverage report</title>
    <link rel="icon" sizes="32x32" href="favicon_32.png">
    <link rel="stylesheet" href="style.css" type="text/css">
    <script type="text/javascript" src="jquery.min.js"></script>
    <script type="text/javascript" src="jquery.ba-throttle-debounce.min.js"></script>
    <script type="text/javascript" src="jquery.tablesorter.min.js"></script>
    <script type="text/javascript" src="jquery.hotkeys.js"></script>
    <script type="text/javascript" src="coverage_html.js"></script>
    <script type="text/javascript">
        jQuery(document).ready(coverage.index_ready);
    </script>
</head>
<body class="indexfile">
<div id="header">
    <div class="content">
        <h1>Coverage report:
            <span class="pc_cov">100%</span>
        </h1>
        <img id="keyboard_icon" src="keybd_closed.png" alt="Show keyboard shortcuts" />
        <form id="filter_container">
            <input id="filter" type="text" value="" placeholder="filter..." />
        </form>
    </div>
</div>
<div class="help_panel">
    <img id="panel_icon" src="keybd_open.png" alt="Hide keyboard shortcuts" />
    <p class="legend">Hot-keys on this page</p>
    <div>
    <p class="keyhelp">
        <span class="key">n</span>
        <span class="key">s</span>
        <span class="key">m</span>
        <span class="key">x</span>
        <span class="key">c</span>   change column sorting
    </p>
    </div>
</div>
<div id="index">
    <table class="index">
        <thead>
            <tr class="tablehead" title="Click to sort">
                <th class="name left headerSortDown shortkey_n">Module</th>
                <th class="shortkey_s">statements</th>
                <th class="shortkey_m">missing</th>
                <th class="shortkey_x">excluded</th>
                <th class="right shortkey_c">coverage</th>
            </tr>
        </thead>
        <tfoot>
            <tr class="total">
                <td class="name left">Total</td>
                <td>14</td>
                <td>0</td>
                <td>0</td>
                <td class="right" data-ratio="14 14">100%</td>
            </tr>
        </tfoot>
        <tbody>
            <tr class="file">
                <td class="name left"><a href="main_py.html">main.py</a></td>
                <td>3</td>
                <td>0</td>
                <td>0</td>
                <td class="right" data-ratio="3 3">100%</td>
            </tr>
            <tr class="file">
                <td class="name left"><a href="test_py.html">test.py</a></td>
                <td>11</td>
                <td>0</td>
                <td>0</td>
                <td class="right" data-ratio="11 11">100%</td>
            </tr>
        </tbody>
    </table>
    <p id="no_rows">
        No items found using the specified filter.
    </p>
</div>
<div id="footer">
    <div class="content">
        <p>
            <a class="nav" href="https://coverage.readthedocs.io">coverage.py v5.4</a>,
            created at 2021-02-11 10:29 +0000
        </p>
    </div>
</div>
</body>
</html>

<!DOCTYPE html>

<html>

<head>

<title>Coverage report</title>

jQuery(document).ready(coverage.index_ready);

</script>

</head>

<h1>Coverage report:

</h1>

</form>

</div>

<div>

<span class="key">c</span> change column sorting

</p>

</div>

<thead>

<th class="name left headerSortDown shortkey_n">Module</th>

<th class="shortkey_s">statements</th>

<th class="shortkey_m">missing</th>

<th class="shortkey_x">excluded</th>

<th class="right shortkey_c">coverage</th>

</tr>

</thead>

<tfoot>

<td class="name left">Total</td>

</tr>

</tfoot>

<tbody>

</tr>

</tr>

</tbody>

</table>

No items found using the specified filter.

</p>

</div>

<p>

<a class="nav" href="https://coverage.readthedocs.io">coverage.py v5.4</a>,

created at 2021-02-11 10:29 +0000

</p>

</div>

</body>

</html>

システム エンジニア: 教えていただいた方法でVS Code上でPythonを使って開発環境を構築してみます。

プロジェクト マネージャー: そうですね。ぜひ一度試してみてください。

まとめ

いかがでしたでしょうか。VS Code上でPythonの開発環境を構築する方法について説明しました。
Pythonの実行、デバッグ、単体テスト、カバレッジの取得方法について紹介しました。

ぜひご自身でソースコードを書いて、理解を深めてください。

FEnet.NETナビ・.NETコラムは株式会社オープンアップシステムが運営しています。

株式会社オープンアップシステムはこんな会社です

秋葉原オフィスには株式会社オープンアップシステムをはじめグループのIT企業が集結！
数多くのエンジニアが集まります。

スマホアプリから業務系システムまで

スマホアプリから業務系システムまで開発案件多数。システムエンジニア・プログラマーとしての多彩なキャリアパスがあります。
充実した研修制度

毎年、IT技術のトレンドや社員の要望に合わせて、カリキュラムを刷新し展開しています。社内講師の丁寧なサポートを受けながら、自分のペースで学ぶことができます。
資格取得を応援

スキルアップしたい社員を応援するために資格取得一時金制度を設けています。受験料(実費)と合わせて資格レベルに合わせた最大10万円の一時金も支給しています。
東証プライム上場企業グループ

オープンアップシステムは東証プライム上場「株式会社オープンアップグループ」のグループ企業です。

安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。

株式会社オープンアップシステムに興味を持った方へ

株式会社オープンアップシステムでは、開発系エンジニア・プログラマを募集しています。

年収をアップしたい！スキルアップしたい！大手の上流案件にチャレンジしたい！
まずは話だけでも聞いてみたい場合もOK。お気軽にご登録ください。

株式会社オープンアップシステムへ応募する
会員登録不要! カンタン45秒!

VS Code上でPythonを実行する方法|デバッグや単体テストについても解説

VS CodeでPythonの開発をしてみよう

実行

デバッグ

unittest

カバレッジ

まとめ

株式会社オープンアップシステムはこんな会社です

スマホアプリから業務系システムまで

充実した研修制度

資格取得を応援

東証プライム上場企業グループ

株式会社オープンアップシステムに興味を持った方へ

Python新着案件New Job

マルチロガーソフト開発/東京都豊島区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務

マルチロガーソフト開発/東京都豊島区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務

商品化予定の振動センサーの運用保守/Python/東京都都内/【WEB面談可】

商品化予定の振動センサーの可視化UI開発のテスター/Python/東京都都内/【WEB面談可】

商品化予定の振動センサーの運用保守/Python/東京都都内/【WEB面談可】

商品化予定の振動センサーの可視化UI開発のテスター/Python/東京都都内/【WEB面談可】

VS Code上でPythonを実行する方法|デバッグや単体テストについても解説

VS CodeでPythonの開発をしてみよう

実行

デバッグ

unittest

カバレッジ

まとめ

株式会社オープンアップシステムはこんな会社です

スマホアプリから業務系システムまで

充実した研修制度

資格取得を応援

東証プライム上場企業グループ

株式会社オープンアップシステムに興味を持った方へ

Python新着案件New Job

マルチロガーソフト開発/東京都豊島区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務

マルチロガーソフト開発/東京都豊島区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務

商品化予定の振動センサーの運用保守/Python/東京都都内/【WEB面談可】

商品化予定の振動センサーの可視化UI開発のテスター/Python/東京都都内/【WEB面談可】

商品化予定の振動センサーの運用保守/Python/東京都都内/【WEB面談可】

商品化予定の振動センサーの可視化UI開発のテスター/Python/東京都都内/【WEB面談可】

関連記事Related Posts

VS Code上でPythonを実行する方法|デバッグや単体テストについても解説

Pythonでの辞書の操作方法とは？基本的な使い方やソートの方法まで解説！

Pythonでのwithの使い方とは？withの基本的な使い方やクラスの作成方法について紹介！

Pythonのupdate方法とは？pipコマンドを使用したupdateやuninstallについて

人気プログラミング言語「Python」をWindowsにインストールしよう