技術ブログ｜Python開発を加速させる！Visual Studio Code活用法まとめ

先日初めてVisual Studio Codeをインストールし、必須といわれる拡張機能も導入してPythonの開発環境を整えました。
ただ調べていくと、実はもっともっと便利にできそう……？ということがわかりましたので、今回は初心者なりに「これは便利なのでは？」と思われる拡張機能について解説していきたいと思います。

①indent-rainbow（インデントの色付け）

Visual Studio Code標準機能で異なるインデントレベルがわかるようにはなっていますが、この拡張機能を入れることでインデントごとに色付けがされ、更に見やすくなります。

インストール前

インストール後

些細な変化に見えるかもしれませんが、実際にコードを書いていると、この些細な色の変化が大変便利に感じました。（個人差があるかもしれません）
入れておいて損はない機能だと思います。

②autopep8（PEP8に合わせて、フォーマットしてくれる）

Pythonのことを調べていく中で「PEP8」という見知らぬ単語を目にしたため、よく調べてみました。
★PEP8（Python Enhancement Proposal 8）
Pythonのコードの一貫性を保つためのスタイルガイド（コーディング時のルール）。
Pythonのコア開発者を含む複数の開発者によって提案され、公式ドキュメントの一部として公開されており、コードを書きやすく、読みやすくするための一連のガイドラインとして機能している。
PEP8の採用により、チーム開発におけるコードの一貫性が保たれ、バグの発生を防ぐことができる。
つまりPython開発で守るべきルールとして制定されており、このルールが守られることで、複数開発者で実施される開発の際、他の開発者がコードを理解しやすくなり、保守性が向上するとのことです。

推奨されているガイドラインついては以下の通りです。
・インデント
→4つのスペースを使用することを推奨
・行の長さ
→理想的には行を79文字に制限することを提案してるが、同意すれば最大99文字まで許可
・空白行
→使用する位置と使用しない位置のルール提供
・コメントアウト
→コメントアウトについてのルール提供
・命名規則
→変数、メソッド、関数、クラス、モジュール、その他の要素の命名規則についてのルール提供

※PEP8はガイドラインなので、一般的にPEP8に従う方が良いとされているようですが、無条件に従うよりチームで合意してプロジェクトに合わせる方を推奨しているようです。

autopep8の機能では、PEP 8スタイルガイドに準拠するように自動的にフォーマットしてくれるとのことです。
複数人での開発では勿論ですが、個人的な開発においても、ガイドラインを準拠することで変な癖がつかず、Githubなどのソースコード管理を複数人で行う際も、無駄な工数を使わずに済むことになります。
自分ではガイドラインを守っているつもりでも、無意識に破っていることもありますので、autopep8を入れておくことでその危険性を防いでおきましょう。
※flake8という拡張機能も同時に導入することで、ガイドラインに準拠しているかチェックをすることもできるようになります。

③Todo Tree

皆さんは開発を途中で中断して翌日に作業を再開した際、「あれ、次はどこを修正するんだっけ……」という状況に陥ったことはありませんか？（私はあります）そんなときに入れておくと便利な拡張機能が「Todo Tree」です。

この拡張機能はソースコード内のTODOコメントを検出し、それらを一覧表示するツリービューを作成してくれます。
※インストール後はVisual Studio Codeの再起動が必要です。

インストール後、アプリ画面左に木のようなマーク（Todo Treeのアイコン）が追加されます。
それを押下すると「TODES:TREE」という画面が開かれ、「#TODO～」でコメントアウトしたコメントのリストが確認できます。
それぞれのリストをクリックすると、そのコメントが記載されたコードにジャンプすることができるので、大変便利です。
自分のような忘れっぽい人間にも優しい、素敵なツールだと思いました。（個人の感想です）

最後に

Visual Studio Code、ひいてはPythonの開発についても初心者ではありますが、Visual Studio Codeには開発初心者に優しいさまざまな拡張機能が揃っていることがわかりました。
初心者にも優しいVisual Studio Codeを利用してPython開発を勉強し、開発力UPを目指していきたいと思います。

安心安全のホワイト高還元SESに転職を考えている方へ

新しい挑戦に踏み出すことは、人生において重要な一歩です。
転職活動は自分自身を知り、成長する貴重な機会でもあり、夢や成長を追求するためには必要な要素の一つになるかと思います。
どんな選択をされるにせよ、その決断があなたに取って素晴らしい未来を切り開くことを願っています！
グラディートと一緒に誇れるエンジニアを目指しましょう！

■『株式会社グラディート』では受託開発・SES・ブランディングデザイン・事業コンサルティングなどを事業として行う都内のIT企業です。現在、不遇な待遇で困っているエンジニアさんは、ぜひ一度グラディートに相談してみてね！（年収査定・SESへの転職相談も承っております！）

株式会社グラディート採用情報はこちら▼
https://en-gage.net/gradito/

株式会社グラディート公式サイトはこちら▼
https://www.gradito.co.jp/