TechAcademy（テックアカデミー） プログラミング Python PythonでSourcetrailを使用する方法を現役エンジニアが解説【初心者向け】
Python

PythonでSourcetrailを使用する方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonでSourcetrailを使用する方法について現役エンジニアが解説しています。Sourcetrailは他人の書いたソースコードを理解し、生産的にコーディングを行えるよう支援するツールで、各種エディタやPythonなどの言語に対応しています。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

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のクラスの依存関係を調べることで、他人の書いたソースコードの書き直しやアップデートを行いやすくなるというメリットがあります。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

実際に使ってみよう

それでは、実際にインストールして使ってみましょう。

こちらからインストールページを開き、使用しているOSに合わせてインストーラをダウンロードします。

Sourcetrailをインストールする公式サイト
インストーラを起動しインストールを完了されたらSourcetrailを起動しましょう。

インストールしたSourcetrailの初期起動画面

スタート画面右側にtictactoe.pyがあるので、このコードの中身をみていきます。

Sourcetrailのスタート画面右側のtictactoe.pyコード内容

Overview画面にファイル、モジュール、クラス、関数を解析するメニューが表示されます。

次に、modulesを開き使われているモジュールをみてみましょう。

開くとoverviewでファイル名がモジュール名として表示されるため、もう一度ファイル名をクリックして、ソースコード内で使われているモジュール名を確認できます。

SourcetrailのOverview画面でファイル、モジュール、クラス、関数を解析するメニューが表示された画面

アルファベット順にモジュールの一覧が表示されています。

更に右側には、ソースコード内の該当箇所が表示されてマウスカーソルを合わせると、モジュールがハイライトされて、ハイライトされた箇所の解析も行われます。

Pythonの場合、黄色が関数、灰色がクラスということが確認できるでしょう。

それではこの中からmain関数を開きます。

Sourcetrailのtictactoe.pyのmain関数の画面

この図からmain関数を実行すると、TicTacToeモジュールが呼び出されています。

それではこのTicTacToeを開いていきましょう。

Sourcetrailのtictactoe.pyのmain関数で使われているTicTacToeモジュールの画面
ここで青色で表示されているモジュールはクラス内で定義されている変数を示しています。

クラス内のモジュールをクリックすることで、モジュールの依存関係を選択したモジュールを中心に図示してくれるでしょう。

 

まとめ

今回はオープンソースになったソースコード解析ソフトのSourcetrailを試したものを解説します。

簡単なソースコードなら自分で処理の流れを追いかけることができるものの、複雑になってくるほど流れが分からなくなり、読んでいく中で混乱しやすくなります。

Sourcetrailなら処理の流れを順を追って確認することができるため、モジュールの依存関係を知ることができて、コードレビューをしやすくなったり、バグ取りに役立つツールです。

 

執筆してくれたメンター

メンター三浦

モバイルゲームを運用している会社のエンジニアをしています。趣味でWEB開発やクラウドコンピューティングもやっており、ソフトもハードもなんでもやります。

TechAcademyジュニアではPythonロボティクスコースを担当しています。好きな言語はPython, Node.js。

 

大石ゆかり

PythonでSourcetrailを使用する方法がよくわかったので良かったです！

田島悠介

ゆかりちゃん、これからも分からないことがあったら質問してね！

大石ゆかり

分かりました。ありがとうございます！

 

TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。

記事を検索

関連するキーワード

関連する記事

Pythonのforemanライブラリの使い方を現役エンジニアが解説【初心者向け】

Pythonのforemanライブラリの使い方について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。 ...
Python

Pythonのfromやimportの基礎を現役エンジニアが解説【初心者向け】

Pythonのfromやimportの基礎について解説します。 そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事...
Python

Pythonのelif文の使い方を現役エンジニアが解説【初心者向け】

Pythonのelif文の使い方について解説します。 そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさ...
Python

Pythonでソケット通信を行う方法【初心者向け】

Pythonでソケット通信を行う方法について解説します。 そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読む...
Python

Pythonの形態素解析ライブラリ「Janome」の基本の使い方を現役エンジニアが解説【初心者向け】

Pythonの形態素解析ライブラリ「Janome」の基本の使い方について解説します。 そもそもPythonについてよく分からないという方は、Pythonと...
Python

Pythonで複数のバージョンを使い分ける方法【初心者向け】

Pythonで複数のバージョンを使い分ける方法について解説します。 そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した...
Python

あわせてよく読まれている記事

Pythonにおけるnetaddrモジュールの利用方法を現役エンジニアが解説【初心者向け】

Pythonにおけるnetaddrモジュールの利用方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。   Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。   なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。   田島悠介 今回は、Pythonに関する内容だね！ 大石ゆかり どういう内容でしょうか？ 田島悠介 Pythonにおけるnetaddrモジュールの利用方法について詳しく説明していくね！ 大石ゆかり お願いします！   netaddrモジュールとは？ netaddrモジュールは、PythonでIPアドレスを操作するためのモジュールです。 Pythonにはipaddressという標準モジュールがありますが、netaddrモジュールはさらに豊富な機能を持ち、L2(Ethernet等)アドレスも扱えます。   netaddrモジュールの使い方 netaddrモジュールは標準モジュールではないので、追加インストールが必要です。 pip install netaddr Pythonインタプリタで以下のコードを入力します。 特にエラーが発生しなければ、インストールは成功しています。 import netaddr netaddrモジュールを用いたソースコードの例です。 192.0.2.0/29サブネットのIPアドレスを羅列します。 import netaddr ipset = netaddr.IPSet(['192.0.2.0/29']) for ip in ipset: print(ip) 実行結果は以下の通りです。 192.0.2.0 192.0.2.1 192.0.2.2 192.0.2.3 192.0.2.4 192.0.2.5 192.0.2.6 192.0.2.7   [PR] Pythonで挫折しない学習方法を動画で公開中netaddrモジュールを利用してIPv4をIPv6に変換してみよう ソースコード import netaddr ip = netaddr.IPAddress('192.0.2.1') print(ip.ipv6())   実行結果 ::ffff:192.0.2.1   解説 IPv4アドレスとして192.0.2.1を設定しました。 ipv6メソッドを呼び出し、IPv4 mapped addressを得ました。   監修してくれたメンター 橋本紘希（はしもとひろき） システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。   大石ゆかり 内容分かりやすくて良かったです！ 田島悠介 ゆかりちゃんも分からないことがあったら質問してね！ 大石ゆかり 分かりました。ありがとうございます！   TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。 また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
Python

Pythonでモジュールを作成する方法を現役エンジニアが解説【初心者向け】

Pythonでモジュールを作成する方法について解説します。 そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。   なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。   田島悠介 今回は、Pythonに関する内容だね！ 大石ゆかり どういう内容でしょうか？ 田島悠介 Pythonでモジュールを作成する方法について詳しく説明していくね！ 大石ゆかり お願いします！   モジュールとは モジュールとは、メソッドや変数をまとめた単位です。モジュールの実体は通常のPythonスクリプトファイルです。 あるPythonプログラムが、別のモジュールをインポート(import)すると、モジュールで定義されたメソッドや変数を参照できるようになります。 Pythonをインストールすると、公式モジュールもあわせて利用できるようになります。PyPIでは、サードパーティ製のモジュールが多数公開されています。 モジュールを作成する 前述の通り、モジュールの実体は通常のPythonスクリプトファイルです。モジュールの作成にあたり、特別な措置や記法は不要です。 [PR] Pythonで挫折しない学習方法を動画で公開中作成したモジュールをimportする モジュールをインポートするには、importキーワードを用います。インポート後は、 <module>.<method>, <module>.<variable>といった記法で、モジュール中のメソッドや変数を参照できます。 import <module>   実際に実行してみよう ソースコード 以下内容のファイルamod.pyを作成しました。 amod.pyはモジュールで、インポート「される」側のファイルです。 def add(x, y): return x + y ZERO = 0 与えられた引数を加算するメソッドaddを定義しました。変数ZEROを定義しました。 以下内容のファイルbprog.pyを作成しました。bprog.pyはインポート「する」側のファイルです。 import amod print(amod.add(1, 2)) print(amod.ZERO) 1行目でamodモジュールをインポートしました。 3行目でamodモジュールのaddメソッドを呼び出しました。 4行目でamodモジュールのZERO変数を参照しました。   実行結果 bprog.pyを実行すると、以下の出力を得られました。 3 0 監修してくれたメンター 橋本紘希 システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。   大石ゆかり 内容分かりやすくて良かったです！ 田島悠介 ゆかりちゃんも分からないことがあったら質問してね！ 大石ゆかり 分かりました。ありがとうございます！   TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。 挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。
Python

Pythonのdatetimeモジュールを利用して曜日を調べる方法を現役エンジニアが解説【初心者向け】

Pythonのdatetimeモジュールを利用して曜日を調べる方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。 Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。   なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。   田島悠介 今回は、Pythonに関する内容だね！ 大石ゆかり どういう内容でしょうか？ 田島悠介 Pythonのdatetimeモジュールを利用して曜日を調べる方法について詳しく説明していくね！ 大石ゆかり お願いします！   datetimeモジュールとは datetimeはPythonで日付や時刻を扱うのに便利なモジュールです。 datetimeモジュールで曜日を調べる方法 曜日を求めるには、weekdayメソッドを使います。戻り値は0以上6以下の整数で、0が月曜日、6が日曜日を示します。 [PR] Pythonで挫折しない学習方法を動画で公開中実際に書いてみよう ソースコード1 はじめに今日(2020/3/19)の曜日を計算してみます。 import datetime t = datetime.date.today() print(t.weekday())   実行結果1 3   解説1 todayメソッドで今日の日付を得ました。weekdayメソッドの戻り値が3なので、木曜日とわかりました。 ソースコード2 同様に来年の同月日(2021/3/19)の曜日を計算してみます。 import datetime d = datetime.date(2021, 3, 19) print(d.weekday())   実行結果2 4   解説2 dateメソッドで日付オブジェクトを得ました。weekdayメソッドの戻り値が4なので、金曜日とわかりました。 まとめ この記事ではdatetimeモジュールを用いて、曜日を求める方法を紹介しました。 監修してくれたメンター 橋本紘希（はしもとひろき） システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。   大石ゆかり 内容分かりやすくて良かったです！ 田島悠介 ゆかりちゃんも分からないことがあったら質問してね！ 大石ゆかり 分かりました。ありがとうございます！   TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。 また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
Python

Pythonのcommandsモジュールについて現役エンジニアが解説【初心者向け】

Pythonのcommandsモジュールについて、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。   そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まるでしょう。   なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。   田島悠介 今回は、Pythonに関する内容だね！ 大石ゆかり どういう内容でしょうか？ 田島悠介 commandsモジュールについて詳しく説明していくね！ 大石ゆかり お願いします！   目次 commandsモジュールとは commandsモジュールの代替 subprocessモジュールの使い方 実際に書いてみよう まとめ   commandsモジュールとは commandsモジュールとは、Python 2系でOSコマンドを実行するためのモジュールです。 commandsモジュールはos.popenのラッパーとして機能し、引数で指定したコマンドを実行しましょう。 コマンドの出力や終了コードを得られます。   [PR] Pythonで挫折しない学習方法を動画で公開中commandsモジュールの代替 commandsモジュールはPython 2系におけるOSコマンド実行手段でした。 Python 2系は2020/1/1をもってサポート終了になりました。 Deprecated since version 2.6: The commands module has been removed in Python 3. Use the subprocess module instead. (※)https://docs.python.org/2/library/commands.html#module-commands より抜粋 Python 3系でOSコマンドを実行するには、代わりにsubprocessモジュールを使用します。   subprocessモジュールの使い方 subprocessモジュールでOSコマンドを実行するには、runメソッドを使いましょう。 引数でコマンドそのものや、コマンド引数を指定します。 また、オプション引数で挙動を切り替えられ、コマンド実行結果をそのまま出力するか、戻り値に含めるかといった点を選択可能です。   実際に書いてみよう 以下、ソースコード、実行結果です。 インタプリタで実行しました。 >>> import subprocess >>> result = subprocess.run(['hostname'], capture_output=True) >>> result CompletedProcess(args=['hostname'], returncode=0, stdout=b'DESKTOP-xxxxrn', stderr=b'') >>> result.args ['hostname'] >>> result.stdout b'DESKTOP-xxxxrn' >>> result.returncode 0 解説 subprocess.runでhostnameコマンドを実行しました。 戻り値を変数resultに代入し、resultはCompletedProcessというデータ型になりました。 メンバ変数args, stdout, returncodeを参照すると、引数、標準出力、終了コードを取得しています。   まとめ この記事ではcommandsとその代替となるsubprocessモジュールを紹介しました。 今後はPython 3系が主流になるので、OSコマンドの実行にはsubprocessモジュールを使用してください。   執筆してくれたメンター 橋本紘希（はしもとひろき） システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。   大石ゆかり Pythonのcommandsモジュールの内容がよく分かったので良かったです！ 田島悠介 ゆかりちゃん、これからも分からないことがあったら質問してね！ 大石ゆかり 分かりました。ありがとうございます！   TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。 挫折しない学習方法を知れる説明動画や現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。
Python

Pythonのtimeitモジュールについて現役エンジニアが解説【初心者向け】

Pythonのtimeitモジュールについて、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。   Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。   なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。   田島悠介 今回は、Pythonに関する内容だね！ 大石ゆかり どういう内容でしょうか？ 田島悠介 Pythonのtimeitモジュールについて詳しく説明していくね！ 大石ゆかり お願いします！   この記事ではPythonのtimeitモジュールについて解説します。   目次 timeitモジュールとは timeitモジュールの使い方 実際に書いてみよう まとめ   timeitモジュールとは timeitモジュールは関数の実行速度を測ることのできるモジュールとなります。 timeitモジュールはコマンドプロントなどコンソール上からも実行可能ですが関数で呼び出すこともできます。   [PR] Pythonで挫折しない学習方法を動画で公開中timeitモジュールの使い方 timeitモジュールは以下のように使います import timeit; timeit.timeit(測定したい処理[,globals=None, setup=最初に実行したい処理, number=1000000]) numberには関数を実行させる数を指定することができます。デフォルトが100万回なので処理が大きいものだと終了まで時間がかかってしまうのでnumberの数を減らすなど対応が必要です。 setupには測定前に実行する処理を記述できます。 測定したい処理は関数に求めていなくても直接書くこともできます。その際は文字列のようにシングルコーテーションもしくはダブルコーテーションで囲んで書くことができます。 準備された関数を指定することもできます。その時に引数を設定する時はglobalsにglobals()を設定することで引数を設定できます。   実際に書いてみよう では実際にtimeitモジュールを使って処理スピードを測ってみましょう。   プログラムソースコード import timeit i = 1 def add01(): global i i = i + 1 j = i def add02(n): global j j = j + n print(timeit.timeit("print('テスト')", number=5)) print(timeit.timeit("add01()", globals = globals(), setup="print('こんにちは')")) print(i) print(timeit.timeit("add02(2)", globals = globals(), number=100)) print(j)   実行結果 テスト テスト テスト テスト テスト 5.3550999999998905e-05 こんにちは 0.134880481 1000001 1.8751999999983004e-05 201   まとめ この記事ではPythonのtimeitモジュールを使って処理スピードを測定する方法について解説しました。   監修してくれたメンター メンターSさん システムエンジニアとしてこれまで行政システムや医療用システムの保守、開発に携わりました。 JavaやPython、PHP、Kotlinなど様々な言語での開発経験があります。 TechAcademyではJavaコース、Pythonコース、AIコースなど7コースを担当しています。   大石ゆかり 内容分かりやすくて良かったです！ 田島悠介 ゆかりちゃんも分からないことがあったら質問してね！ 大石ゆかり 分かりました。ありがとうございます！   TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。 また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
Python

Pythonのdatetimeモジュールのtoordinal関数について現役エンジニアが解説【初心者向け】

Pythonのdatetimeモジュールのtoordinal関数について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。   Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。   なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。   田島悠介 今回は、Pythonに関する内容だね！ 大石ゆかり どういう内容でしょうか？ 田島悠介 Pythonのdatetimeモジュールのtoordinal関数について詳しく説明していくね！ 大石ゆかり お願いします！   目次 datetimeモジュールとは toordinal関数の使い方 実際に書いてみよう まとめ   datetimeモジュールとは datetimeはPythonで日付を扱うためのモジュールです。 日付データを出力したり、逆に日付を示す文字列をパースしたりできます。   [PR] Pythonで挫折しない学習方法を動画で公開中toordinal関数の使い方 dateインスタンスについて、toordinal関数を呼び出すと、西暦1年1月1日からの経過日数を得られます。引数はなし、戻り値は整数です。 使い方は以下の通りです。 # dateクラスのインスタンスdがあるとして d.toordinal()   実際に書いてみよう ソースコードと実行結果 Pythonインタプリタで実行しました。 >>> d = datetime.datetime.now() >>> d.toordinal() 737516   解説 now関数で今日の日付(2020/4/1)を得ました。 toordinal関数を呼び出すと、西暦1/1/1からの経過日数である、737516を得ました。   まとめ この記事では、datetimeモジュールのtoordinal関数の使い方を紹介しました。   監修してくれたメンター 橋本紘希（はしもとひろき） システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。   大石ゆかり 内容分かりやすくて良かったです！ 田島悠介 ゆかりちゃんも分からないことがあったら質問してね！ 大石ゆかり 分かりました。ありがとうございます！   TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。 また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
Python

TechAcademyから
現役エンジニアの方へ
お知らせ

藤門千明
TechAcademy（テックアカデミー） プログラミング Python PythonでSourcetrailを使用する方法を現役エンジニアが解説【初心者向け】