PythonでSourcetrailを使用する方法を現役エンジニアが解説【初心者向け】
初心者向けにPythonでSourcetrailを使用する方法について現役エンジニアが解説しています。Sourcetrailは他人の書いたソースコードを理解し、生産的にコーディングを行えるよう支援するツールで、各種エディタやPythonなどの言語に対応しています。
TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。
PythonでSourcetrailを使用する方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。
Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まるでしょう。
なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。
今回は、Pythonに関する内容だね！
どういう内容でしょうか？
PythonでSourcetrailを使用する方法について詳しく説明していくね！
お願いします！
Sourcetrailとは
Sourcetrailとは、オーストリアのCoati Softwareによって開発されているツールで、元々は商用ライセンスで採用されていました。
しかし、2019年11月18日にオープンソース化され、無償で利用可能となりました。
Sourcetrailは、開発者が他人の書いたソースコードを理解し、生産的にコーディングを行えるよう支援するものです。
例えば、VS Codeなどのテキストエディタで開発を行う場合、コードの文法をチェックするものの、既存のソースコードを理解する機能は持ち合わせておらず、理解に多大な時間がかかります。
対して、Sourcetrailであれば、
- インタラクティブな依存関係グラフ
- 簡潔なコードビュー
- 効率的なコード検索
といった機能を組み合わせ、ソースコードの概要と詳細情報まで提供しています。
そして、これらの機能は様々なテキストエディタと接続することが可能です。
動作環境はWindows、Mac、Linuxに対応しており、「C」「C++」「Java」「Python」に対応しており様々な場面で使用できるでしょう。
Pythonで使える機能とメリット
Sourcetrailはソースコードを解析するツールであり、Pythonにおいて具体的に何ができるのか、みていきます。。
まずは「構成要素の確認」です。
コード内で使われているモジュール、クラス、変数、関数を確認することができます。
次は「ソースコードの解析」です。
構成要素を確認できたら、この機能を使うことでコードの依存関係やモジュールを確認することが可能です。
これらの機能を使用してPythonのクラスの依存関係を調べることで、他人の書いたソースコードの書き直しやアップデートを行いやすくなるというメリットがあります。
実際に使ってみよう
それでは、実際にインストールして使ってみましょう。
こちらからインストールページを開き、使用しているOSに合わせてインストーラをダウンロードします。
インストーラを起動しインストールを完了されたらSourcetrailを起動しましょう。
スタート画面右側にtictactoe.pyがあるので、このコードの中身をみていきます。
Overview画面にファイル、モジュール、クラス、関数を解析するメニューが表示されます。
次に、modulesを開き使われているモジュールをみてみましょう。
開くとoverviewでファイル名がモジュール名として表示されるため、もう一度ファイル名をクリックして、ソースコード内で使われているモジュール名を確認できます。
アルファベット順にモジュールの一覧が表示されています。
更に右側には、ソースコード内の該当箇所が表示されてマウスカーソルを合わせると、モジュールがハイライトされて、ハイライトされた箇所の解析も行われます。
Pythonの場合、黄色が関数、灰色がクラスということが確認できるでしょう。
それではこの中からmain関数を開きます。
この図からmain関数を実行すると、TicTacToeモジュールが呼び出されています。
それではこのTicTacToeを開いていきましょう。
ここで青色で表示されているモジュールはクラス内で定義されている変数を示しています。
クラス内のモジュールをクリックすることで、モジュールの依存関係を選択したモジュールを中心に図示してくれるでしょう。
まとめ
今回はオープンソースになったソースコード解析ソフトのSourcetrailを試したものを解説します。
簡単なソースコードなら自分で処理の流れを追いかけることができるものの、複雑になってくるほど流れが分からなくなり、読んでいく中で混乱しやすくなります。
Sourcetrailなら処理の流れを順を追って確認することができるため、モジュールの依存関係を知ることができて、コードレビューをしやすくなったり、バグ取りに役立つツールです。
執筆してくれたメンター
| メンター三浦
モバイルゲームを運用している会社のエンジニアをしています。趣味でWEB開発やクラウドコンピューティングもやっており、ソフトもハードもなんでもやります。 TechAcademyジュニアではPythonロボティクスコースを担当しています。好きな言語はPython, Node.js。 |
PythonでSourcetrailを使用する方法がよくわかったので良かったです！
ゆかりちゃん、これからも分からないことがあったら質問してね！
分かりました。ありがとうございます！
TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。
また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
