Pythonでコマンドライン引数を利用するargparseの利用方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonでコマンドライン引数を利用するargparseの利用方法について現役エンジニアが解説しています。argparseモジュールは、コマンドとその引数をプログラムに取り込んで、処理することが出来ます。実際にコマンドラインから引数を受け取って表示してみます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonでコマンドライン引数を利用するargparseの利用方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

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

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonでコマンドライン引数を利用するargparseの利用方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

argparseとは?

コマンドラインを使ってPCを操作する時、コマンドと一緒にファイル名や、幾つかの引数を使用します。ファイル名も引数として定義されますね。

例: python  my_prog.py   arg1  arg2

arg1とarg2が例では引数です。コマンドとその引数をプログラムに取り込んで、実装する機能がargparseモジュールです。

argparseの使い方

それでは早速使ってみましょう。

①argprseモジュールをimportします

>>> import argparse

②パーサーを定義します。

>>> parser = argparse.ArgumentParser()

③引数の定義を行います。

2つ引数を定義しましょう。

 >>> parser.add_argument('arg1', help='this is example arg1')
 >>> parser.add_argument('arg2', help='this is arg2')

 

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

argparseを利用してコマンドライン引数を処理してみよう

上記で指定した引数をprint文で出力してみましょう。ソースを以下に示します。p.pyというファイル名で保存します。

import argparse
p = argparse.ArgumentParser()
p.add_argument('arg1', help='thi is example arg1')
p.add_argument('arg2', help='this is arg2')
args = p.parse_args()    # 解析する引数をargに代入しました。
print('arg1='+args.arg1)

実行結果を以下に示します。

C:\sakawork>python p.py arg1 arg2
arg1=arg1

 

監修してくれたメンター

坂下雄一(さかしたゆういち)

外資系のEDAベンダで、エンジニアとして働いた後、東南アジアにて起業しました。
PythonはEDAのコマンド自動化、テスト環境構築の時に初めて使用し、素晴らしいと思い、今に至ります。

EDAの環境構築、手順の自動化は、tcl/tkというコマンド言語がメインですが、Pythonで置き換える作業も最近は盛んになってきています。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

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

大石ゆかり

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

 

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

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