Pythonは汎用性が高く、様々なアプリケーションに使用できます。特にCLI（コマンドラインインターフェース）ツールを作る際にはPythonがよく利用されます。本記事ではPythonを用いたCLIツールとインターフェースの作成方法を紹介します。具体的なコード例とその解説、さらには応用例まで詳しく説明します。
目次
PythonでCLIツールを作る理由
Pythonはその可読性と汎用性から、CLIツールを作成するには最適な言語です。また、豊富なライブラリが用意されており、開発がスムーズに進められます。
基本的なCLIツールの作成
コマンドライン引数の取得
PythonでCLIツールを作る際の基本となるのは、コマンドライン引数を取得することです。
import sys
# コマンドライン引数を取得
args = sys.argv
# 第一引数を表示（プログラム名は除く）
print("第一引数：", args[1])
このコードでは、Pythonの標準ライブラリ`sys`を使用してコマンドライン引数を取得しています。
argparseの使用
Python標準ライブラリには`argparse`という、より高度なコマンドライン引数パーサが存在します。
import argparse
# パーサーの作成
parser = argparse.ArgumentParser(description='このプログラムの説明')
# 引数の追加
parser.add_argument('integers', metavar='N', type=int, nargs='+', help='整数を入力してください')
# 引数を解析
args = parser.parse_args()
# 結果を表示
print("入力された整数：", args.integers)
高度なCLIツールの作成
サブコマンドの実装
CLIツールが複雑になると、サブコマンドが必要になる場合があります。
import argparse
# パーサーの作成
parser = argparse.ArgumentParser()
# サブコマンドの設定
subparsers = parser.add_subparsers(dest='command')
# 'show'コマンド
show_parser = subparsers.add_parser('show', help='show help')
show_parser.add_argument('name', type=str, help='名前を入力')
# 'tell'コマンド
tell_parser = subparsers.add_parser('tell', help='tell help')
tell_parser.add_argument('message', type=str, help='メッセージを入力')
# 引数を解析
args = parser.parse_args()
# コマンドに応じた処理
if args.command == 'show':
print(f'Hello, {args.name}!')
elif args.command == 'tell':
print(f'Your message: {args.message}')
応用例
ファイル操作のCLIツール
ファイルを読み込んで何らかの操作を行うCLIツールを作る例です。
import argparse
import os
# パーサーの設定
parser = argparse.ArgumentParser()
parser.add_argument('file', type=str, help='操作するファイル名')
# 引数を解析
args = parser.parse_args()
# ファイルが存在するかチェック
if not os.path.exists(args.file):
print(f'{args.file} は存在しません')
else:
with open(args.file, 'r') as f:
print(f.read())
WebスクレイピングのCLIツール
Webページからデータを取得するCLIツールの例です。
import argparse
import requests
from bs4 import BeautifulSoup
# パーサーの設定
parser = argparse.ArgumentParser()
parser.add_argument('url', type=str, help='スクレイピングするURL')
# 引数を解析
args = parser.parse_args()
# Webページの取得
response = requests.get(args.url)
# スクレイピング
soup = BeautifulSoup(response.text, 'html.parser')
title = soup.title.string
print(f'ページタイトル: {title}')
まとめ
PythonはCLIツール作成において非常に優れた言語です。基本的な引数の取得から高度なサブコマンドの実装まで、Pythonの標準ライブラリだけで多くのことが可能です。この記事で紹介したテクニックを活用して、ぜひ自分自身のCLIツールを作成してみてください。
コメント