第1回 | CLIで開発するとはどういうことか | 確認、修正、再実行の流れをつかむ｜UNIX Cafe

CLIで開発する | 第1回

今回から「CLIで開発する」シリーズを始めます。CLIは、コマンドを入力してコンピューターを操作するための画面です。このシリーズでは、Python製の小さなアプリを題材に、ターミナル中心で開発作業を進める流れを見ていきます。

大切なのは、難しいコマンドを一度に覚えることではありません。今いる場所を確認する。ファイルを見る。プログラムを動かす。必要なら直す。もう一度動かす。最後に差分を見る。この短い流れを落ち着いて繰り返せるようになることが目標です。

この記事で学べること

• CLIで開発するときの基本的な流れ
• vi で練習用のPythonファイルを作る方法
• pwd と ls で作業場所を確認する方法
• python3 src/app.py でPythonアプリを実行する方法
• 修正後に再実行と差分確認をする理由

CLIで開発する流れ

CLIでの開発は、特別な操作の連続ではありません。小さな確認を順番に積み重ねます。

1. 今いる場所を確認する
2. ファイル構成を見る
3. アプリを動かす
4. 必要な場所を探す
5. vi で小さく直す
6. 同じコマンドでもう一度動かす
7. git diff で変更を見る

練習用のPythonファイルを作る

YouTubeからこの記事に来た方も同じ流れを試せるように、まずは練習用のファイルを手元に作ります。今回は、3件の注文金額を足して、合計を表示する小さなアプリです。

ターミナルを開いたら、次のコマンドを1行ずつ実行してください。mkdir はディレクトリを作るコマンド、cd は作業する場所を移動するコマンドです。

mkdir unix_cafe_order
cd unix_cafe_order
mkdir src

mkdir unix_cafe_order
cd unix_cafe_order
mkdir src

次に、表示する文章を作る src/message.py を vi で新しく作ります。

vi src/message.py

vi src/message.py

vi が開いたら、i を押して入力モードにします。次の2行を入力してください。

def format_total(total):
    return f"Order total: {total} yen"

def format_total(total):
    return f"Order total: {total} yen"

入力できたら、Esc キーを押し、:wq と入力して Enter キーを押します。:wq は、保存して vi を終了する操作です。

続けて、アプリの入口になる src/app.py を作ります。

vi src/app.py

vi src/app.py

同じように i を押し、次の内容を入力します。

from message import format_total

orders = [500, 600, 700]
total = sum(orders)

print(format_total(total))

from message import format_total

orders = [500, 600, 700]
total = sum(orders)

print(format_total(total))

入力できたら、Esc、:wq、Enter の順に操作して保存します。

最後に、あとで変更前と変更後を比べられるように、現在のファイルをGitに登録しておきます。git init は、このディレクトリでGitによる変更管理を始めるコマンドです。git add src で、いま作ったファイルを比較の基準として登録します。

git init
git add src

git init
git add src

まず現在地とファイルを見る

最初に、どこで作業しているかを確認します。場所を曖昧にしたまま進めると、別のファイルを開いたり、意図しない場所でコマンドを実行したりしやすくなります。

pwd
ls

pwd
ls

pwd は現在地、ls は今いる場所の中身を見るコマンドです。地味ですが、開発作業でも繰り返し使います。

Pythonアプリを動かしてみる

今回使うサンプルは、注文データの合計金額を表示する小さなCLIアプリです。次のコマンドで実行します。

python3 src/app.py

python3 src/app.py

正常に動くと、次のように合計金額が表示されます。

Order total: 1800 yen

Order total: 1800 yen

修正を始める前に、まず現在の状態を自分で確認しておくことが大切です。変更前の結果が分かっていれば、修正後に何が変わったかを比べられます。

直したら、もう一度動かす

今度は、表示される文章を小さく変更してみます。vi で src/message.py を開き、Order total を Cafe order total に書き換えて保存してください。

vi src/message.py

vi src/message.py

修正後は、同じコマンドでもう一度実行します。表示が変わったことを確認したら、Gitで差分を見ます。

python3 src/app.py

python3 src/app.py

再実行すると、次のように表示されます。

Cafe order total: 1800 yen

Cafe order total: 1800 yen

git diff を実行します。

git diff

git diff

実行すると、次のような表示になります。

-    return f"Order total: {total} yen"
+    return f"Cafe order total: {total} yen"

-    return f"Order total: {total} yen"
+    return f"Cafe order total: {total} yen"

git diff では、変更前の行には -、変更後の行には + が付きます。

ここで行った操作をまとめると、次の3つです。

vi src/message.py
python3 src/app.py
git diff

vi src/message.py
python3 src/app.py
git diff

このシリーズでは、Pythonの文法を詳しく学ぶことよりも、確認、修正、再実行、差分確認という順番を身につけることを優先します。

初心者が意識したいこと

最初から素早く操作する必要はありません。むしろ、何を確認するためにコマンドを打つのかを言葉にできる方が大切です。入力を間違えたときも、落ち着いて現在地とファイル名を確認すれば整理しやすくなります。

手を動かすミニ練習

1. pwd を実行し、今いる場所を確認する
2. ls を実行し、src ディレクトリがあることを確認する
3. python3 src/app.py を実行し、表示された合計金額を見る
4. vi src/message.py で表示する文章を変更する
5. もう一度アプリを実行し、表示が変わったことを確認する
6. git diff で変更前と変更後を見比べる

次回予告

次回は、いきなりコードを読む前に、プロジェクトのファイル構成を見て入口を見つける流れを整理します。